1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright 2021 Linaro Limited 4 * Author: AKASHI Takahiro 5 * 6 * derived from efi.h and efi_api.h to make the file POSIX-compliant 7 */ 8 9 #ifndef _EFI_CAPSULE_H 10 #define _EFI_CAPSULE_H 11 12 #include <stdint.h> 13 14 /* 15 * Gcc's predefined attributes are not recognized by clang. 16 */ 17 #ifndef __packed 18 #define __packed __attribute__((__packed__)) 19 #endif 20 21 #ifndef __aligned 22 #define __aligned(x) __attribute__((__aligned__(x))) 23 #endif 24 25 typedef struct { 26 uint8_t b[16]; 27 } efi_guid_t __aligned(8); 28 29 #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 30 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \ 31 ((a) >> 24) & 0xff, \ 32 (b) & 0xff, ((b) >> 8) & 0xff, \ 33 (c) & 0xff, ((c) >> 8) & 0xff, \ 34 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } } 35 36 #define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \ 37 EFI_GUID(0x6dcbd5ed, 0xe82d, 0x4c44, 0xbd, 0xa1, \ 38 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a) 39 40 #define EFI_CERT_TYPE_PKCS7_GUID \ 41 EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \ 42 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7) 43 44 #define FW_ACCEPT_OS_GUID \ 45 EFI_GUID(0x0c996046, 0xbcc0, 0x4d04, 0x85, 0xec, \ 46 0xe1, 0xfc, 0xed, 0xf1, 0xc6, 0xf8) 47 48 #define FW_REVERT_OS_GUID \ 49 EFI_GUID(0xacd58b4b, 0xc0e8, 0x475f, 0x99, 0xb5, \ 50 0x6b, 0x3f, 0x7e, 0x07, 0xaa, 0xf0) 51 52 /* flags */ 53 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000 54 55 struct efi_capsule_header { 56 efi_guid_t capsule_guid; 57 uint32_t header_size; 58 uint32_t flags; 59 uint32_t capsule_image_size; 60 } __packed; 61 62 struct efi_firmware_management_capsule_header { 63 uint32_t version; 64 uint16_t embedded_driver_count; 65 uint16_t payload_item_count; 66 uint32_t item_offset_list[]; 67 } __packed; 68 69 /* image_capsule_support */ 70 #define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001 71 72 struct efi_firmware_management_capsule_image_header { 73 uint32_t version; 74 efi_guid_t update_image_type_id; 75 uint8_t update_image_index; 76 uint8_t reserved[3]; 77 uint32_t update_image_size; 78 uint32_t update_vendor_code_size; 79 uint64_t update_hardware_instance; 80 uint64_t image_capsule_support; 81 } __packed; 82 83 /** 84 * win_certificate_uefi_guid - A certificate that encapsulates 85 * a GUID-specific signature 86 * 87 * @hdr: Windows certificate header, cf. WIN_CERTIFICATE 88 * @cert_type: Certificate type 89 */ 90 struct win_certificate_uefi_guid { 91 struct { 92 uint32_t dwLength; 93 uint16_t wRevision; 94 uint16_t wCertificateType; 95 } hdr; 96 efi_guid_t cert_type; 97 } __packed; 98 99 /** 100 * efi_firmware_image_authentication - Capsule authentication method 101 * descriptor 102 * 103 * This structure describes an authentication information for 104 * a capsule with IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED set 105 * and should be included as part of the capsule. 106 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted. 107 * 108 * @monotonic_count: Count to prevent replay 109 * @auth_info: Authentication info 110 */ 111 struct efi_firmware_image_authentication { 112 uint64_t monotonic_count; 113 struct win_certificate_uefi_guid auth_info; 114 } __packed; 115 116 #endif /* _EFI_CAPSULE_H */ 117