eficapsule.h 3.7 KB

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