efi.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  1. /*
  2. * Extensible Firmware Interface
  3. * Based on 'Extensible Firmware Interface Specification' version 0.9,
  4. * April 30, 1999
  5. *
  6. * Copyright (C) 1999 VA Linux Systems
  7. * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
  8. * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
  9. * David Mosberger-Tang <davidm@hpl.hp.com>
  10. * Stephane Eranian <eranian@hpl.hp.com>
  11. *
  12. * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
  13. */
  14. #ifndef _EFI_H
  15. #define _EFI_H
  16. #include <linux/linkage.h>
  17. #include <linux/string.h>
  18. #include <linux/types.h>
  19. #if CONFIG_EFI_STUB_64BIT || (!defined(CONFIG_EFI_STUB) && defined(__x86_64__))
  20. /* EFI uses the Microsoft ABI which is not the default for GCC */
  21. #define EFIAPI __attribute__((ms_abi))
  22. #else
  23. #define EFIAPI asmlinkage
  24. #endif
  25. struct efi_device_path;
  26. typedef struct {
  27. u8 b[16];
  28. } efi_guid_t;
  29. #define EFI_BITS_PER_LONG BITS_PER_LONG
  30. /*
  31. * With 64-bit EFI stub, EFI_BITS_PER_LONG has to be 64. EFI_STUB is set
  32. * in lib/efi/Makefile, when building the stub.
  33. */
  34. #if defined(CONFIG_EFI_STUB_64BIT) && defined(EFI_STUB)
  35. #undef EFI_BITS_PER_LONG
  36. #define EFI_BITS_PER_LONG 64
  37. #endif
  38. /* Bit mask for EFI status code with error */
  39. #define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
  40. /* Status codes returned by EFI protocols */
  41. #define EFI_SUCCESS 0
  42. #define EFI_LOAD_ERROR (EFI_ERROR_MASK | 1)
  43. #define EFI_INVALID_PARAMETER (EFI_ERROR_MASK | 2)
  44. #define EFI_UNSUPPORTED (EFI_ERROR_MASK | 3)
  45. #define EFI_BAD_BUFFER_SIZE (EFI_ERROR_MASK | 4)
  46. #define EFI_BUFFER_TOO_SMALL (EFI_ERROR_MASK | 5)
  47. #define EFI_NOT_READY (EFI_ERROR_MASK | 6)
  48. #define EFI_DEVICE_ERROR (EFI_ERROR_MASK | 7)
  49. #define EFI_WRITE_PROTECTED (EFI_ERROR_MASK | 8)
  50. #define EFI_OUT_OF_RESOURCES (EFI_ERROR_MASK | 9)
  51. #define EFI_VOLUME_CORRUPTED (EFI_ERROR_MASK | 10)
  52. #define EFI_VOLUME_FULL (EFI_ERROR_MASK | 11)
  53. #define EFI_NO_MEDIA (EFI_ERROR_MASK | 12)
  54. #define EFI_MEDIA_CHANGED (EFI_ERROR_MASK | 13)
  55. #define EFI_NOT_FOUND (EFI_ERROR_MASK | 14)
  56. #define EFI_ACCESS_DENIED (EFI_ERROR_MASK | 15)
  57. #define EFI_NO_RESPONSE (EFI_ERROR_MASK | 16)
  58. #define EFI_NO_MAPPING (EFI_ERROR_MASK | 17)
  59. #define EFI_TIMEOUT (EFI_ERROR_MASK | 18)
  60. #define EFI_NOT_STARTED (EFI_ERROR_MASK | 19)
  61. #define EFI_ALREADY_STARTED (EFI_ERROR_MASK | 20)
  62. #define EFI_ABORTED (EFI_ERROR_MASK | 21)
  63. #define EFI_ICMP_ERROR (EFI_ERROR_MASK | 22)
  64. #define EFI_TFTP_ERROR (EFI_ERROR_MASK | 23)
  65. #define EFI_PROTOCOL_ERROR (EFI_ERROR_MASK | 24)
  66. #define EFI_INCOMPATIBLE_VERSION (EFI_ERROR_MASK | 25)
  67. #define EFI_SECURITY_VIOLATION (EFI_ERROR_MASK | 26)
  68. #define EFI_CRC_ERROR (EFI_ERROR_MASK | 27)
  69. #define EFI_END_OF_MEDIA (EFI_ERROR_MASK | 28)
  70. #define EFI_END_OF_FILE (EFI_ERROR_MASK | 31)
  71. #define EFI_INVALID_LANGUAGE (EFI_ERROR_MASK | 32)
  72. #define EFI_COMPROMISED_DATA (EFI_ERROR_MASK | 33)
  73. #define EFI_IP_ADDRESS_CONFLICT (EFI_ERROR_MASK | 34)
  74. #define EFI_HTTP_ERROR (EFI_ERROR_MASK | 35)
  75. #define EFI_WARN_DELETE_FAILURE 2
  76. typedef unsigned long efi_status_t;
  77. typedef u64 efi_physical_addr_t;
  78. typedef u64 efi_virtual_addr_t;
  79. typedef void *efi_handle_t;
  80. #define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
  81. ((efi_guid_t) \
  82. {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
  83. ((a) >> 24) & 0xff, \
  84. (b) & 0xff, ((b) >> 8) & 0xff, \
  85. (c) & 0xff, ((c) >> 8) & 0xff, \
  86. (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } })
  87. /* Generic EFI table header */
  88. struct efi_table_hdr {
  89. u64 signature;
  90. u32 revision;
  91. u32 headersize;
  92. u32 crc32;
  93. u32 reserved;
  94. };
  95. /* Enumeration of memory types introduced in UEFI */
  96. enum efi_mem_type {
  97. EFI_RESERVED_MEMORY_TYPE,
  98. /*
  99. * The code portions of a loaded application.
  100. * (Note that UEFI OS loaders are UEFI applications.)
  101. */
  102. EFI_LOADER_CODE,
  103. /*
  104. * The data portions of a loaded application and
  105. * the default data allocation type used by an application
  106. * to allocate pool memory.
  107. */
  108. EFI_LOADER_DATA,
  109. /* The code portions of a loaded Boot Services Driver */
  110. EFI_BOOT_SERVICES_CODE,
  111. /*
  112. * The data portions of a loaded Boot Services Driver and
  113. * the default data allocation type used by a Boot Services
  114. * Driver to allocate pool memory.
  115. */
  116. EFI_BOOT_SERVICES_DATA,
  117. /* The code portions of a loaded Runtime Services Driver */
  118. EFI_RUNTIME_SERVICES_CODE,
  119. /*
  120. * The data portions of a loaded Runtime Services Driver and
  121. * the default data allocation type used by a Runtime Services
  122. * Driver to allocate pool memory.
  123. */
  124. EFI_RUNTIME_SERVICES_DATA,
  125. /* Free (unallocated) memory */
  126. EFI_CONVENTIONAL_MEMORY,
  127. /* Memory in which errors have been detected */
  128. EFI_UNUSABLE_MEMORY,
  129. /* Memory that holds the ACPI tables */
  130. EFI_ACPI_RECLAIM_MEMORY,
  131. /* Address space reserved for use by the firmware */
  132. EFI_ACPI_MEMORY_NVS,
  133. /*
  134. * Used by system firmware to request that a memory-mapped IO region
  135. * be mapped by the OS to a virtual address so it can be accessed by
  136. * EFI runtime services.
  137. */
  138. EFI_MMAP_IO,
  139. /*
  140. * System memory-mapped IO region that is used to translate
  141. * memory cycles to IO cycles by the processor.
  142. */
  143. EFI_MMAP_IO_PORT,
  144. /*
  145. * Address space reserved by the firmware for code that is
  146. * part of the processor.
  147. */
  148. EFI_PAL_CODE,
  149. EFI_MAX_MEMORY_TYPE,
  150. EFI_TABLE_END, /* For efi_build_mem_table() */
  151. };
  152. /* Attribute values */
  153. enum {
  154. EFI_MEMORY_UC_SHIFT = 0, /* uncached */
  155. EFI_MEMORY_WC_SHIFT = 1, /* write-coalescing */
  156. EFI_MEMORY_WT_SHIFT = 2, /* write-through */
  157. EFI_MEMORY_WB_SHIFT = 3, /* write-back */
  158. EFI_MEMORY_UCE_SHIFT = 4, /* uncached, exported */
  159. EFI_MEMORY_WP_SHIFT = 12, /* write-protect */
  160. EFI_MEMORY_RP_SHIFT = 13, /* read-protect */
  161. EFI_MEMORY_XP_SHIFT = 14, /* execute-protect */
  162. EFI_MEMORY_RUNTIME_SHIFT = 63, /* range requires runtime mapping */
  163. EFI_MEMORY_RUNTIME = 1ULL << EFI_MEMORY_RUNTIME_SHIFT,
  164. EFI_MEM_DESC_VERSION = 1,
  165. };
  166. #define EFI_PAGE_SHIFT 12
  167. #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
  168. #define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1)
  169. struct efi_mem_desc {
  170. u32 type;
  171. u32 reserved;
  172. efi_physical_addr_t physical_start;
  173. efi_virtual_addr_t virtual_start;
  174. u64 num_pages;
  175. u64 attribute;
  176. };
  177. #define EFI_MEMORY_DESCRIPTOR_VERSION 1
  178. /* Allocation types for calls to boottime->allocate_pages*/
  179. #define EFI_ALLOCATE_ANY_PAGES 0
  180. #define EFI_ALLOCATE_MAX_ADDRESS 1
  181. #define EFI_ALLOCATE_ADDRESS 2
  182. #define EFI_MAX_ALLOCATE_TYPE 3
  183. /* Types and defines for Time Services */
  184. #define EFI_TIME_ADJUST_DAYLIGHT 0x1
  185. #define EFI_TIME_IN_DAYLIGHT 0x2
  186. #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
  187. struct efi_time {
  188. u16 year;
  189. u8 month;
  190. u8 day;
  191. u8 hour;
  192. u8 minute;
  193. u8 second;
  194. u8 pad1;
  195. u32 nanosecond;
  196. s16 timezone;
  197. u8 daylight;
  198. u8 pad2;
  199. };
  200. struct efi_time_cap {
  201. u32 resolution;
  202. u32 accuracy;
  203. u8 sets_to_zero;
  204. };
  205. enum efi_locate_search_type {
  206. ALL_HANDLES,
  207. BY_REGISTER_NOTIFY,
  208. BY_PROTOCOL
  209. };
  210. struct efi_open_protocol_info_entry {
  211. efi_handle_t agent_handle;
  212. efi_handle_t controller_handle;
  213. u32 attributes;
  214. u32 open_count;
  215. };
  216. enum efi_entry_t {
  217. EFIET_END, /* Signals this is the last (empty) entry */
  218. EFIET_MEMORY_MAP,
  219. /* Number of entries */
  220. EFIET_MEMORY_COUNT,
  221. };
  222. #define EFI_TABLE_VERSION 1
  223. /**
  224. * struct efi_info_hdr - Header for the EFI info table
  225. *
  226. * @version: EFI_TABLE_VERSION
  227. * @hdr_size: Size of this struct in bytes
  228. * @total_size: Total size of this header plus following data
  229. * @spare: Spare space for expansion
  230. */
  231. struct efi_info_hdr {
  232. u32 version;
  233. u32 hdr_size;
  234. u32 total_size;
  235. u32 spare[5];
  236. };
  237. /**
  238. * struct efi_entry_hdr - Header for a table entry
  239. *
  240. * @type: enum eft_entry_t
  241. * @size size of entry bytes excluding header and padding
  242. * @addr: address of this entry (0 if it follows the header )
  243. * @link: size of entry including header and padding
  244. * @spare1: Spare space for expansion
  245. * @spare2: Spare space for expansion
  246. */
  247. struct efi_entry_hdr {
  248. u32 type;
  249. u32 size;
  250. u64 addr;
  251. u32 link;
  252. u32 spare1;
  253. u64 spare2;
  254. };
  255. /**
  256. * struct efi_entry_memmap - a memory map table passed to U-Boot
  257. *
  258. * @version: EFI's memory map table version
  259. * @desc_size: EFI's size of each memory descriptor
  260. * @spare: Spare space for expansion
  261. * @desc: An array of descriptors, each @desc_size bytes apart
  262. */
  263. struct efi_entry_memmap {
  264. u32 version;
  265. u32 desc_size;
  266. u64 spare;
  267. struct efi_mem_desc desc[];
  268. };
  269. static inline struct efi_mem_desc *efi_get_next_mem_desc(
  270. struct efi_entry_memmap *map, struct efi_mem_desc *desc)
  271. {
  272. return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
  273. }
  274. struct efi_priv {
  275. efi_handle_t parent_image;
  276. struct efi_device_path *device_path;
  277. struct efi_system_table *sys_table;
  278. struct efi_boot_services *boot;
  279. struct efi_runtime_services *run;
  280. bool use_pool_for_malloc;
  281. unsigned long ram_base;
  282. unsigned int image_data_type;
  283. struct efi_info_hdr *info;
  284. unsigned int info_size;
  285. void *next_hdr;
  286. };
  287. /* Base address of the EFI image */
  288. extern char image_base[];
  289. /* Start and end of U-Boot image (for payload) */
  290. extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
  291. /*
  292. * Variable Attributes
  293. */
  294. #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
  295. #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
  296. #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
  297. #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
  298. #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
  299. #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
  300. #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
  301. #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
  302. EFI_VARIABLE_BOOTSERVICE_ACCESS | \
  303. EFI_VARIABLE_RUNTIME_ACCESS | \
  304. EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
  305. EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
  306. EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
  307. EFI_VARIABLE_APPEND_WRITE)
  308. /**
  309. * efi_get_sys_table() - Get access to the main EFI system table
  310. *
  311. * @return pointer to EFI system table
  312. */
  313. struct efi_system_table *efi_get_sys_table(void);
  314. /**
  315. * efi_get_ram_base() - Find the base of RAM
  316. *
  317. * This is used when U-Boot is built as an EFI application.
  318. *
  319. * @return the base of RAM as known to U-Boot
  320. */
  321. unsigned long efi_get_ram_base(void);
  322. /**
  323. * efi_init() - Set up ready for use of EFI boot services
  324. *
  325. * @priv: Pointer to our private EFI structure to fill in
  326. * @banner: Banner to display when starting
  327. * @image: The image handle passed to efi_main()
  328. * @sys_table: The EFI system table pointer passed to efi_main()
  329. */
  330. int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
  331. struct efi_system_table *sys_table);
  332. /**
  333. * efi_malloc() - Allocate some memory from EFI
  334. *
  335. * @priv: Pointer to private EFI structure
  336. * @size: Number of bytes to allocate
  337. * @retp: Return EFI status result
  338. * @return pointer to memory allocated, or NULL on error
  339. */
  340. void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);
  341. /**
  342. * efi_free() - Free memory allocated from EFI
  343. *
  344. * @priv: Pointer to private EFI structure
  345. * @ptr: Pointer to memory to free
  346. */
  347. void efi_free(struct efi_priv *priv, void *ptr);
  348. /**
  349. * efi_puts() - Write out a string to the EFI console
  350. *
  351. * @priv: Pointer to private EFI structure
  352. * @str: String to write (note this is a ASCII, not unicode)
  353. */
  354. void efi_puts(struct efi_priv *priv, const char *str);
  355. /**
  356. * efi_putc() - Write out a character to the EFI console
  357. *
  358. * @priv: Pointer to private EFI structure
  359. * @ch: Character to write (note this is not unicode)
  360. */
  361. void efi_putc(struct efi_priv *priv, const char ch);
  362. /**
  363. * efi_info_get() - get an entry from an EFI table
  364. *
  365. * @type: Entry type to search for
  366. * @datap: Returns pointer to entry data
  367. * @sizep: Returns pointer to entry size
  368. * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
  369. * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
  370. */
  371. int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);
  372. /**
  373. * efi_build_mem_table() - make a sorted copy of the memory table
  374. *
  375. * @map: Pointer to EFI memory map table
  376. * @size: Size of table in bytes
  377. * @skip_bs: True to skip boot-time memory and merge it with conventional
  378. * memory. This will significantly reduce the number of table
  379. * entries.
  380. * @return pointer to the new table. It should be freed with free() by the
  381. * caller
  382. */
  383. void *efi_build_mem_table(struct efi_entry_memmap *map, int size, bool skip_bs);
  384. #endif /* _LINUX_EFI_H */