efi.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Extensible Firmware Interface
  4. * Based on 'Extensible Firmware Interface Specification' version 0.9,
  5. * April 30, 1999
  6. *
  7. * Copyright (C) 1999 VA Linux Systems
  8. * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
  9. * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
  10. * David Mosberger-Tang <davidm@hpl.hp.com>
  11. * Stephane Eranian <eranian@hpl.hp.com>
  12. *
  13. * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
  14. */
  15. #ifndef _EFI_H
  16. #define _EFI_H
  17. #include <linux/linkage.h>
  18. #include <linux/string.h>
  19. #include <linux/types.h>
  20. /* Type INTN in UEFI specification */
  21. #define efi_intn_t ssize_t
  22. /* Type UINTN in UEFI specification*/
  23. #define efi_uintn_t size_t
  24. /*
  25. * EFI on x86_64 uses the Microsoft ABI which is not the default for GCC.
  26. *
  27. * There are two scenarios for EFI on x86_64: building a 64-bit EFI stub
  28. * codes (CONFIG_EFI_STUB_64BIT) and building a 64-bit U-Boot (CONFIG_X86_64).
  29. * Either needs to be properly built with the '-m64' compiler flag, and hence
  30. * it is enough to only check the compiler provided define __x86_64__ here.
  31. */
  32. #ifdef __x86_64__
  33. #define EFIAPI __attribute__((ms_abi))
  34. #define efi_va_list __builtin_ms_va_list
  35. #define efi_va_start __builtin_ms_va_start
  36. #define efi_va_arg __builtin_va_arg
  37. #define efi_va_end __builtin_ms_va_end
  38. #else
  39. #define EFIAPI asmlinkage
  40. #define efi_va_list va_list
  41. #define efi_va_start va_start
  42. #define efi_va_arg va_arg
  43. #define efi_va_end va_end
  44. #endif /* __x86_64__ */
  45. #define EFI32_LOADER_SIGNATURE "EL32"
  46. #define EFI64_LOADER_SIGNATURE "EL64"
  47. struct efi_device_path;
  48. typedef struct {
  49. u8 b[16];
  50. } efi_guid_t __attribute__((aligned(8)));
  51. #define EFI_BITS_PER_LONG (sizeof(long) * 8)
  52. /* Bit mask for EFI status code with error */
  53. #define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
  54. /* Status codes returned by EFI protocols */
  55. #define EFI_SUCCESS 0
  56. #define EFI_LOAD_ERROR (EFI_ERROR_MASK | 1)
  57. #define EFI_INVALID_PARAMETER (EFI_ERROR_MASK | 2)
  58. #define EFI_UNSUPPORTED (EFI_ERROR_MASK | 3)
  59. #define EFI_BAD_BUFFER_SIZE (EFI_ERROR_MASK | 4)
  60. #define EFI_BUFFER_TOO_SMALL (EFI_ERROR_MASK | 5)
  61. #define EFI_NOT_READY (EFI_ERROR_MASK | 6)
  62. #define EFI_DEVICE_ERROR (EFI_ERROR_MASK | 7)
  63. #define EFI_WRITE_PROTECTED (EFI_ERROR_MASK | 8)
  64. #define EFI_OUT_OF_RESOURCES (EFI_ERROR_MASK | 9)
  65. #define EFI_VOLUME_CORRUPTED (EFI_ERROR_MASK | 10)
  66. #define EFI_VOLUME_FULL (EFI_ERROR_MASK | 11)
  67. #define EFI_NO_MEDIA (EFI_ERROR_MASK | 12)
  68. #define EFI_MEDIA_CHANGED (EFI_ERROR_MASK | 13)
  69. #define EFI_NOT_FOUND (EFI_ERROR_MASK | 14)
  70. #define EFI_ACCESS_DENIED (EFI_ERROR_MASK | 15)
  71. #define EFI_NO_RESPONSE (EFI_ERROR_MASK | 16)
  72. #define EFI_NO_MAPPING (EFI_ERROR_MASK | 17)
  73. #define EFI_TIMEOUT (EFI_ERROR_MASK | 18)
  74. #define EFI_NOT_STARTED (EFI_ERROR_MASK | 19)
  75. #define EFI_ALREADY_STARTED (EFI_ERROR_MASK | 20)
  76. #define EFI_ABORTED (EFI_ERROR_MASK | 21)
  77. #define EFI_ICMP_ERROR (EFI_ERROR_MASK | 22)
  78. #define EFI_TFTP_ERROR (EFI_ERROR_MASK | 23)
  79. #define EFI_PROTOCOL_ERROR (EFI_ERROR_MASK | 24)
  80. #define EFI_INCOMPATIBLE_VERSION (EFI_ERROR_MASK | 25)
  81. #define EFI_SECURITY_VIOLATION (EFI_ERROR_MASK | 26)
  82. #define EFI_CRC_ERROR (EFI_ERROR_MASK | 27)
  83. #define EFI_END_OF_MEDIA (EFI_ERROR_MASK | 28)
  84. #define EFI_END_OF_FILE (EFI_ERROR_MASK | 31)
  85. #define EFI_INVALID_LANGUAGE (EFI_ERROR_MASK | 32)
  86. #define EFI_COMPROMISED_DATA (EFI_ERROR_MASK | 33)
  87. #define EFI_IP_ADDRESS_CONFLICT (EFI_ERROR_MASK | 34)
  88. #define EFI_HTTP_ERROR (EFI_ERROR_MASK | 35)
  89. #define EFI_WARN_UNKNOWN_GLYPH 1
  90. #define EFI_WARN_DELETE_FAILURE 2
  91. #define EFI_WARN_WRITE_FAILURE 3
  92. #define EFI_WARN_BUFFER_TOO_SMALL 4
  93. #define EFI_WARN_STALE_DATA 5
  94. #define EFI_WARN_FILE_SYSTEM 6
  95. #define EFI_WARN_RESET_REQUIRED 7
  96. typedef unsigned long efi_status_t;
  97. typedef u64 efi_physical_addr_t;
  98. typedef u64 efi_virtual_addr_t;
  99. typedef struct efi_object *efi_handle_t;
  100. #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
  101. {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
  102. ((a) >> 24) & 0xff, \
  103. (b) & 0xff, ((b) >> 8) & 0xff, \
  104. (c) & 0xff, ((c) >> 8) & 0xff, \
  105. (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } }
  106. /* Generic EFI table header */
  107. struct efi_table_hdr {
  108. u64 signature;
  109. u32 revision;
  110. u32 headersize;
  111. u32 crc32;
  112. u32 reserved;
  113. };
  114. /* Enumeration of memory types introduced in UEFI */
  115. enum efi_mem_type {
  116. EFI_RESERVED_MEMORY_TYPE,
  117. /*
  118. * The code portions of a loaded application.
  119. * (Note that UEFI OS loaders are UEFI applications.)
  120. */
  121. EFI_LOADER_CODE,
  122. /*
  123. * The data portions of a loaded application and
  124. * the default data allocation type used by an application
  125. * to allocate pool memory.
  126. */
  127. EFI_LOADER_DATA,
  128. /* The code portions of a loaded Boot Services Driver */
  129. EFI_BOOT_SERVICES_CODE,
  130. /*
  131. * The data portions of a loaded Boot Services Driver and
  132. * the default data allocation type used by a Boot Services
  133. * Driver to allocate pool memory.
  134. */
  135. EFI_BOOT_SERVICES_DATA,
  136. /* The code portions of a loaded Runtime Services Driver */
  137. EFI_RUNTIME_SERVICES_CODE,
  138. /*
  139. * The data portions of a loaded Runtime Services Driver and
  140. * the default data allocation type used by a Runtime Services
  141. * Driver to allocate pool memory.
  142. */
  143. EFI_RUNTIME_SERVICES_DATA,
  144. /* Free (unallocated) memory */
  145. EFI_CONVENTIONAL_MEMORY,
  146. /* Memory in which errors have been detected */
  147. EFI_UNUSABLE_MEMORY,
  148. /* Memory that holds the ACPI tables */
  149. EFI_ACPI_RECLAIM_MEMORY,
  150. /* Address space reserved for use by the firmware */
  151. EFI_ACPI_MEMORY_NVS,
  152. /*
  153. * Used by system firmware to request that a memory-mapped IO region
  154. * be mapped by the OS to a virtual address so it can be accessed by
  155. * EFI runtime services.
  156. */
  157. EFI_MMAP_IO,
  158. /*
  159. * System memory-mapped IO region that is used to translate
  160. * memory cycles to IO cycles by the processor.
  161. */
  162. EFI_MMAP_IO_PORT,
  163. /*
  164. * Address space reserved by the firmware for code that is
  165. * part of the processor.
  166. */
  167. EFI_PAL_CODE,
  168. /*
  169. * Non-volatile memory.
  170. */
  171. EFI_PERSISTENT_MEMORY_TYPE,
  172. EFI_MAX_MEMORY_TYPE,
  173. };
  174. /* Attribute values */
  175. #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
  176. #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
  177. #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
  178. #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
  179. #define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
  180. #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
  181. #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
  182. #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
  183. #define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
  184. #define EFI_MEMORY_MORE_RELIABLE \
  185. ((u64)0x0000000000010000ULL) /* higher reliability */
  186. #define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
  187. #define EFI_MEMORY_SP ((u64)0x0000000000040000ULL) /* specific-purpose memory (SPM) */
  188. #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
  189. #define EFI_MEM_DESC_VERSION 1
  190. #define EFI_PAGE_SHIFT 12
  191. #define EFI_PAGE_SIZE (1ULL << EFI_PAGE_SHIFT)
  192. #define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1)
  193. struct efi_mem_desc {
  194. u32 type;
  195. u32 reserved;
  196. efi_physical_addr_t physical_start;
  197. efi_virtual_addr_t virtual_start;
  198. u64 num_pages;
  199. u64 attribute;
  200. };
  201. #define EFI_MEMORY_DESCRIPTOR_VERSION 1
  202. /* Allocation types for calls to boottime->allocate_pages*/
  203. #define EFI_ALLOCATE_ANY_PAGES 0
  204. #define EFI_ALLOCATE_MAX_ADDRESS 1
  205. #define EFI_ALLOCATE_ADDRESS 2
  206. #define EFI_MAX_ALLOCATE_TYPE 3
  207. /* Types and defines for Time Services */
  208. #define EFI_TIME_ADJUST_DAYLIGHT 0x1
  209. #define EFI_TIME_IN_DAYLIGHT 0x2
  210. #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
  211. struct efi_time {
  212. u16 year;
  213. u8 month;
  214. u8 day;
  215. u8 hour;
  216. u8 minute;
  217. u8 second;
  218. u8 pad1;
  219. u32 nanosecond;
  220. s16 timezone;
  221. u8 daylight;
  222. u8 pad2;
  223. };
  224. struct efi_time_cap {
  225. u32 resolution;
  226. u32 accuracy;
  227. u8 sets_to_zero;
  228. };
  229. enum efi_locate_search_type {
  230. ALL_HANDLES,
  231. BY_REGISTER_NOTIFY,
  232. BY_PROTOCOL
  233. };
  234. struct efi_open_protocol_info_entry {
  235. efi_handle_t agent_handle;
  236. efi_handle_t controller_handle;
  237. u32 attributes;
  238. u32 open_count;
  239. };
  240. enum efi_entry_t {
  241. EFIET_END, /* Signals this is the last (empty) entry */
  242. EFIET_MEMORY_MAP,
  243. EFIET_GOP_MODE,
  244. EFIET_SYS_TABLE,
  245. /* Number of entries */
  246. EFIET_MEMORY_COUNT,
  247. };
  248. #define EFI_TABLE_VERSION 1
  249. /**
  250. * struct efi_info_hdr - Header for the EFI info table
  251. *
  252. * @version: EFI_TABLE_VERSION
  253. * @hdr_size: Size of this struct in bytes
  254. * @total_size: Total size of this header plus following data
  255. * @spare: Spare space for expansion
  256. */
  257. struct efi_info_hdr {
  258. u32 version;
  259. u32 hdr_size;
  260. u32 total_size;
  261. u32 spare[5];
  262. };
  263. /**
  264. * struct efi_entry_hdr - Header for a table entry
  265. *
  266. * @type: enum eft_entry_t
  267. * @size size of entry bytes excluding header and padding
  268. * @addr: address of this entry (0 if it follows the header )
  269. * @link: size of entry including header and padding
  270. * @spare1: Spare space for expansion
  271. * @spare2: Spare space for expansion
  272. */
  273. struct efi_entry_hdr {
  274. u32 type;
  275. u32 size;
  276. u64 addr;
  277. u32 link;
  278. u32 spare1;
  279. u64 spare2;
  280. };
  281. /**
  282. * struct efi_entry_memmap - a memory map table passed to U-Boot
  283. *
  284. * @version: EFI's memory map table version
  285. * @desc_size: EFI's size of each memory descriptor
  286. * @spare: Spare space for expansion
  287. * @desc: An array of descriptors, each @desc_size bytes apart
  288. */
  289. struct efi_entry_memmap {
  290. u32 version;
  291. u32 desc_size;
  292. u64 spare;
  293. struct efi_mem_desc desc[];
  294. };
  295. /**
  296. * struct efi_entry_gopmode - a GOP mode table passed to U-Boot
  297. *
  298. * @fb_base: EFI's framebuffer base address
  299. * @fb_size: EFI's framebuffer size
  300. * @info_size: GOP mode info structure size
  301. * @info: Start address of the GOP mode info structure
  302. */
  303. struct efi_entry_gopmode {
  304. efi_physical_addr_t fb_base;
  305. /*
  306. * Not like the ones in 'struct efi_gop_mode' which are 'unsigned
  307. * long', @fb_size and @info_size have to be 'u64' here. As the EFI
  308. * stub codes may have different bit size from the U-Boot payload,
  309. * using 'long' will cause mismatch between the producer (stub) and
  310. * the consumer (payload).
  311. */
  312. u64 fb_size;
  313. u64 info_size;
  314. /*
  315. * We cannot directly use 'struct efi_gop_mode_info info[]' here as
  316. * it causes compiler to complain: array type has incomplete element
  317. * type 'struct efi_gop_mode_info'.
  318. */
  319. struct /* efi_gop_mode_info */ {
  320. u32 version;
  321. u32 width;
  322. u32 height;
  323. u32 pixel_format;
  324. u32 pixel_bitmask[4];
  325. u32 pixels_per_scanline;
  326. } info[];
  327. };
  328. /**
  329. * struct efi_entry_systable - system table passed to U-Boot
  330. *
  331. * @sys_table: EFI system table address
  332. */
  333. struct efi_entry_systable {
  334. efi_physical_addr_t sys_table;
  335. };
  336. static inline struct efi_mem_desc *efi_get_next_mem_desc(
  337. struct efi_entry_memmap *map, struct efi_mem_desc *desc)
  338. {
  339. return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
  340. }
  341. struct efi_priv {
  342. efi_handle_t parent_image;
  343. struct efi_device_path *device_path;
  344. struct efi_system_table *sys_table;
  345. struct efi_boot_services *boot;
  346. struct efi_runtime_services *run;
  347. bool use_pool_for_malloc;
  348. unsigned long ram_base;
  349. unsigned int image_data_type;
  350. struct efi_info_hdr *info;
  351. unsigned int info_size;
  352. void *next_hdr;
  353. };
  354. /* Base address of the EFI image */
  355. extern char image_base[];
  356. /* Start and end of U-Boot image (for payload) */
  357. extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
  358. /*
  359. * Variable Attributes
  360. */
  361. #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
  362. #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
  363. #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
  364. #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
  365. #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
  366. #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
  367. #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
  368. #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
  369. EFI_VARIABLE_BOOTSERVICE_ACCESS | \
  370. EFI_VARIABLE_RUNTIME_ACCESS | \
  371. EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
  372. EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
  373. EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
  374. EFI_VARIABLE_APPEND_WRITE)
  375. /**
  376. * efi_get_sys_table() - Get access to the main EFI system table
  377. *
  378. * @return pointer to EFI system table
  379. */
  380. struct efi_system_table *efi_get_sys_table(void);
  381. /**
  382. * efi_get_ram_base() - Find the base of RAM
  383. *
  384. * This is used when U-Boot is built as an EFI application.
  385. *
  386. * @return the base of RAM as known to U-Boot
  387. */
  388. unsigned long efi_get_ram_base(void);
  389. /**
  390. * efi_init() - Set up ready for use of EFI boot services
  391. *
  392. * @priv: Pointer to our private EFI structure to fill in
  393. * @banner: Banner to display when starting
  394. * @image: The image handle passed to efi_main()
  395. * @sys_table: The EFI system table pointer passed to efi_main()
  396. */
  397. int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
  398. struct efi_system_table *sys_table);
  399. /**
  400. * efi_malloc() - Allocate some memory from EFI
  401. *
  402. * @priv: Pointer to private EFI structure
  403. * @size: Number of bytes to allocate
  404. * @retp: Return EFI status result
  405. * @return pointer to memory allocated, or NULL on error
  406. */
  407. void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);
  408. /**
  409. * efi_free() - Free memory allocated from EFI
  410. *
  411. * @priv: Pointer to private EFI structure
  412. * @ptr: Pointer to memory to free
  413. */
  414. void efi_free(struct efi_priv *priv, void *ptr);
  415. /**
  416. * efi_puts() - Write out a string to the EFI console
  417. *
  418. * @priv: Pointer to private EFI structure
  419. * @str: String to write (note this is a ASCII, not unicode)
  420. */
  421. void efi_puts(struct efi_priv *priv, const char *str);
  422. /**
  423. * efi_putc() - Write out a character to the EFI console
  424. *
  425. * @priv: Pointer to private EFI structure
  426. * @ch: Character to write (note this is not unicode)
  427. */
  428. void efi_putc(struct efi_priv *priv, const char ch);
  429. /**
  430. * efi_info_get() - get an entry from an EFI table
  431. *
  432. * @type: Entry type to search for
  433. * @datap: Returns pointer to entry data
  434. * @sizep: Returns pointer to entry size
  435. * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
  436. * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
  437. */
  438. int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
  439. #endif /* _LINUX_EFI_H */