linux-efi.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. #pragma once
  2. #include <efidef.h>
  3. #include "compiler_attributes.h"
  4. #include "types.h"
  5. #include "linux/pfn.h"
  6. #if defined(CONFIG_riscv64)
  7. #include "riscv64.h"
  8. #endif
  9. #define efi_guid_t EFI_GUID
  10. #define MAKE_EFI_GUID(a, b, c, d...) \
  11. (efi_guid_t) \
  12. { \
  13. a, b & 0xffff, c & 0xffff, \
  14. { \
  15. d \
  16. } \
  17. }
  18. /*
  19. * EFI Configuration Table and GUID definitions
  20. *
  21. * These are all defined in a single line to make them easier to
  22. * grep for and to see them at a glance - while still having a
  23. * similar structure to the definitions in the spec.
  24. *
  25. * Here's how they are structured:
  26. *
  27. * GUID: 12345678-1234-1234-1234-123456789012
  28. * Spec:
  29. * #define EFI_SOME_PROTOCOL_GUID \
  30. * {0x12345678,0x1234,0x1234,\
  31. * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
  32. * Here:
  33. * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
  34. * ^ tabs ^extra space
  35. *
  36. * Note that the 'extra space' separates the values at the same place
  37. * where the UEFI SPEC breaks the line.
  38. */
  39. #define NULL_GUID \
  40. MAKE_EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, \
  41. 0x00, 0x00, 0x00, 0x00)
  42. #ifndef MPS_TABLE_GUID
  43. #define MPS_TABLE_GUID \
  44. MAKE_EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, \
  45. 0x27, 0x3f, 0xc1, 0x4d)
  46. #endif
  47. #ifndef ACPI_TABLE_GUID
  48. #define ACPI_TABLE_GUID \
  49. MAKE_EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, \
  50. 0x27, 0x3f, 0xc1, 0x4d)
  51. #endif
  52. #ifndef ACPI_20_TABLE_GUID
  53. #define ACPI_20_TABLE_GUID \
  54. MAKE_EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, \
  55. 0xc7, 0x3c, 0x88, 0x81)
  56. #endif
  57. #ifndef SMBIOS_TABLE_GUID
  58. #define SMBIOS_TABLE_GUID \
  59. MAKE_EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, \
  60. 0x27, 0x3f, 0xc1, 0x4d)
  61. #endif
  62. #ifndef SMBIOS3_TABLE_GUID
  63. #define SMBIOS3_TABLE_GUID \
  64. MAKE_EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, \
  65. 0xcf, 0x20, 0xe3, 0x94)
  66. #endif
  67. #ifndef SAL_SYSTEM_TABLE_GUID
  68. #define SAL_SYSTEM_TABLE_GUID \
  69. MAKE_EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, \
  70. 0x27, 0x3f, 0xc1, 0x4d)
  71. #endif
  72. #define HCDP_TABLE_GUID \
  73. MAKE_EFI_GUID(0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, \
  74. 0x79, 0x61, 0x78, 0x98)
  75. #define UGA_IO_PROTOCOL_GUID \
  76. MAKE_EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, \
  77. 0xed, 0x0b, 0x07, 0xa2)
  78. #define EFI_GLOBAL_VARIABLE_GUID \
  79. MAKE_EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, \
  80. 0x98, 0x03, 0x2b, 0x8c)
  81. #define UV_SYSTEM_TABLE_GUID \
  82. MAKE_EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, \
  83. 0x56, 0xd8, 0x95, 0x93)
  84. #define LINUX_EFI_CRASH_GUID \
  85. MAKE_EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, \
  86. 0xbf, 0xe2, 0x98, 0xa0)
  87. #define LOADED_IMAGE_PROTOCOL_GUID \
  88. MAKE_EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, \
  89. 0xc9, 0x69, 0x72, 0x3b)
  90. #define LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
  91. MAKE_EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, 0x99, 0x20, 0x2d, 0x3b, \
  92. 0x36, 0xd7, 0x50, 0xdf)
  93. #ifndef EFI_DEVICE_PATH_PROTOCOL_GUID
  94. #define EFI_DEVICE_PATH_PROTOCOL_GUID \
  95. MAKE_EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, \
  96. 0xc9, 0x69, 0x72, 0x3b)
  97. #endif
  98. #ifndef EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID
  99. #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
  100. MAKE_EFI_GUID(0x8b843e20, 0x8132, 0x4852, 0x90, 0xcc, 0x55, 0x1a, \
  101. 0x4e, 0x4a, 0x7f, 0x1c)
  102. #endif
  103. #ifndef EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID
  104. #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \
  105. MAKE_EFI_GUID(0x05c99a21, 0xc70f, 0x4ad2, 0x8a, 0x5f, 0x35, 0xdf, \
  106. 0x33, 0x43, 0xf5, 0x1e)
  107. #endif
  108. #ifndef EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
  109. #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
  110. MAKE_EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, \
  111. 0xd0, 0x80, 0x51, 0x6a)
  112. #endif
  113. #define EFI_UGA_PROTOCOL_GUID \
  114. MAKE_EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, \
  115. 0x68, 0x8f, 0xb8, 0x39)
  116. #ifndef EFI_PCI_IO_PROTOCOL_GUID
  117. #define EFI_PCI_IO_PROTOCOL_GUID \
  118. MAKE_EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, \
  119. 0x3f, 0x50, 0x02, 0x9a)
  120. #endif
  121. #ifndef EFI_FILE_INFO_ID
  122. #define EFI_FILE_INFO_ID \
  123. MAKE_EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, \
  124. 0xc9, 0x69, 0x72, 0x3b)
  125. #endif
  126. #define EFI_SYSTEM_RESOURCE_TABLE_GUID \
  127. MAKE_EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, \
  128. 0xb0, 0xd6, 0x21, 0x80)
  129. #define EFI_FILE_SYSTEM_GUID \
  130. MAKE_EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, \
  131. 0xc9, 0x69, 0x72, 0x3b)
  132. #define DEVICE_TREE_GUID \
  133. MAKE_EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, \
  134. 0x2c, 0x69, 0xaa, 0xe0)
  135. #define EFI_PROPERTIES_TABLE_GUID \
  136. MAKE_EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, \
  137. 0x34, 0x08, 0x25, 0xe5)
  138. #ifndef EFI_RNG_PROTOCOL_GUID
  139. #define EFI_RNG_PROTOCOL_GUID \
  140. MAKE_EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, \
  141. 0xdc, 0x29, 0x1f, 0x44)
  142. #endif
  143. #ifndef EFI_RNG_ALGORITHM_RAW
  144. #define EFI_RNG_ALGORITHM_RAW \
  145. MAKE_EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, \
  146. 0xc4, 0xb6, 0x85, 0x61)
  147. #endif
  148. #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID \
  149. MAKE_EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, \
  150. 0xdc, 0x46, 0x12, 0x20)
  151. #define EFI_CONSOLE_OUT_DEVICE_GUID \
  152. MAKE_EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, \
  153. 0x27, 0x3f, 0xc1, 0x4d)
  154. #define APPLE_PROPERTIES_PROTOCOL_GUID \
  155. MAKE_EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, \
  156. 0xab, 0x30, 0x3a, 0xe0)
  157. #define EFI_TCG2_PROTOCOL_GUID \
  158. MAKE_EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, \
  159. 0x6d, 0xb2, 0x72, 0x0f)
  160. #ifndef EFI_LOAD_FILE_PROTOCOL_GUID
  161. #define EFI_LOAD_FILE_PROTOCOL_GUID \
  162. MAKE_EFI_GUID(0x56ec3091, 0x954c, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, \
  163. 0xc9, 0x69, 0x72, 0x3b)
  164. #endif
  165. #define EFI_LOAD_FILE2_PROTOCOL_GUID \
  166. MAKE_EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, 0x99, 0x6d, 0x4a, 0x6c, \
  167. 0x87, 0x24, 0xe0, 0x6d)
  168. #define EFI_RT_PROPERTIES_TABLE_GUID \
  169. MAKE_EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, 0x93, 0x1d, \
  170. 0x21, 0xc3, 0x8a, 0xe9)
  171. #define EFI_DXE_SERVICES_TABLE_GUID \
  172. MAKE_EFI_GUID(0x05ad34ba, 0x6f02, 0x4214, 0x95, 0x2e, 0x4d, 0xa0, \
  173. 0x39, 0x8e, 0x2b, 0xb9)
  174. #define EFI_SMBIOS_PROTOCOL_GUID \
  175. MAKE_EFI_GUID(0x03583ff6, 0xcb36, 0x4940, 0x94, 0x7e, 0xb9, 0xb3, \
  176. 0x9f, 0x4a, 0xfa, 0xf7)
  177. #define EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID \
  178. MAKE_EFI_GUID(0xf4560cf6, 0x40ec, 0x4b4a, 0xa1, 0x92, 0xbf, 0x1d, \
  179. 0x57, 0xd0, 0xb1, 0x89)
  180. #define EFI_IMAGE_SECURITY_DATABASE_GUID \
  181. MAKE_EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, \
  182. 0x0e, 0x67, 0x65, 0x6f)
  183. #define EFI_SHIM_LOCK_GUID \
  184. MAKE_EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, \
  185. 0x10, 0xdd, 0x8b, 0x23)
  186. #define EFI_CERT_SHA256_GUID \
  187. MAKE_EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, \
  188. 0x36, 0x93, 0x43, 0x28)
  189. #define EFI_CERT_X509_GUID \
  190. MAKE_EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, \
  191. 0x5c, 0x2b, 0xf0, 0x72)
  192. #define EFI_CERT_X509_SHA256_GUID \
  193. MAKE_EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, \
  194. 0x8e, 0xf1, 0x03, 0xed)
  195. #define EFI_CC_BLOB_GUID \
  196. MAKE_EFI_GUID(0x067b1f5f, 0xcf26, 0x44c5, 0x85, 0x54, 0x93, 0xd7, \
  197. 0x77, 0x91, 0x2d, 0x42)
  198. #if defined(CONFIG_X86_64)
  199. #define __efiapi __attribute__((ms_abi))
  200. #elif defined(CONFIG_X86_32)
  201. #define __efiapi __attribute__((regparm(0)))
  202. #elif defined(CONFIG_riscv64)
  203. #define __efiapi
  204. #elif defined(CONFIG_aarch64)
  205. #define __efiapi
  206. #else
  207. #error "Unsupported architecture"
  208. #endif
  209. /*
  210. * EFI Device Path information
  211. */
  212. #define EFI_DEV_HW 0x01
  213. #define EFI_DEV_PCI 1
  214. #define EFI_DEV_PCCARD 2
  215. #define EFI_DEV_MEM_MAPPED 3
  216. #define EFI_DEV_VENDOR 4
  217. #define EFI_DEV_CONTROLLER 5
  218. #define EFI_DEV_ACPI 0x02
  219. #define EFI_DEV_BASIC_ACPI 1
  220. #define EFI_DEV_EXPANDED_ACPI 2
  221. #define EFI_DEV_MSG 0x03
  222. #define EFI_DEV_MSG_ATAPI 1
  223. #define EFI_DEV_MSG_SCSI 2
  224. #define EFI_DEV_MSG_FC 3
  225. #define EFI_DEV_MSG_1394 4
  226. #define EFI_DEV_MSG_USB 5
  227. #define EFI_DEV_MSG_USB_CLASS 15
  228. #define EFI_DEV_MSG_I20 6
  229. #define EFI_DEV_MSG_MAC 11
  230. #define EFI_DEV_MSG_IPV4 12
  231. #define EFI_DEV_MSG_IPV6 13
  232. #define EFI_DEV_MSG_INFINIBAND 9
  233. #define EFI_DEV_MSG_UART 14
  234. #define EFI_DEV_MSG_VENDOR 10
  235. #define EFI_DEV_MEDIA 0x04
  236. #define EFI_DEV_MEDIA_HARD_DRIVE 1
  237. #define EFI_DEV_MEDIA_CDROM 2
  238. #define EFI_DEV_MEDIA_VENDOR 3
  239. #define EFI_DEV_MEDIA_FILE 4
  240. #define EFI_DEV_MEDIA_PROTOCOL 5
  241. #define EFI_DEV_MEDIA_REL_OFFSET 8
  242. #define EFI_DEV_BIOS_BOOT 0x05
  243. #define EFI_DEV_END_PATH 0x7F
  244. #define EFI_DEV_END_PATH2 0xFF
  245. #define EFI_DEV_END_INSTANCE 0x01
  246. #define EFI_DEV_END_ENTIRE 0xFF
  247. struct efi_generic_dev_path {
  248. u8 type;
  249. u8 sub_type;
  250. u16 length;
  251. } __packed;
  252. struct efi_acpi_dev_path {
  253. struct efi_generic_dev_path header;
  254. u32 hid;
  255. u32 uid;
  256. } __packed;
  257. struct efi_pci_dev_path {
  258. struct efi_generic_dev_path header;
  259. u8 fn;
  260. u8 dev;
  261. } __packed;
  262. struct efi_vendor_dev_path {
  263. struct efi_generic_dev_path header;
  264. efi_guid_t vendorguid;
  265. u8 vendordata[];
  266. } __packed;
  267. struct efi_rel_offset_dev_path {
  268. struct efi_generic_dev_path header;
  269. u32 reserved;
  270. u64 starting_offset;
  271. u64 ending_offset;
  272. } __packed;
  273. struct efi_mem_mapped_dev_path {
  274. struct efi_generic_dev_path header;
  275. u32 memory_type;
  276. u64 starting_addr;
  277. u64 ending_addr;
  278. } __packed;
  279. struct efi_file_path_dev_path {
  280. struct efi_generic_dev_path header;
  281. efi_char16_t filename[];
  282. } __packed;
  283. struct efi_dev_path {
  284. union {
  285. struct efi_generic_dev_path header;
  286. struct efi_acpi_dev_path acpi;
  287. struct efi_pci_dev_path pci;
  288. struct efi_vendor_dev_path vendor;
  289. struct efi_rel_offset_dev_path rel_offset;
  290. };
  291. } __packed;
  292. // struct device *efi_get_device_by_path(const struct efi_dev_path **node,
  293. // size_t *len);
  294. static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
  295. {
  296. *npages = PFN_UP(*addr + (*npages << EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
  297. *addr &= PAGE_MASK;
  298. }