efi.h 14 KB

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