efi_loader.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * EFI application loader
  4. *
  5. * Copyright (c) 2016 Alexander Graf
  6. */
  7. #ifndef _EFI_LOADER_H
  8. #define _EFI_LOADER_H 1
  9. #include <common.h>
  10. #include <part_efi.h>
  11. #include <efi_api.h>
  12. /* No need for efi loader support in SPL */
  13. #if CONFIG_IS_ENABLED(EFI_LOADER)
  14. #include <linux/list.h>
  15. /* Maximum number of configuration tables */
  16. #define EFI_MAX_CONFIGURATION_TABLES 16
  17. int __efi_entry_check(void);
  18. int __efi_exit_check(void);
  19. const char *__efi_nesting(void);
  20. const char *__efi_nesting_inc(void);
  21. const char *__efi_nesting_dec(void);
  22. /*
  23. * Enter the u-boot world from UEFI:
  24. */
  25. #define EFI_ENTRY(format, ...) do { \
  26. assert(__efi_entry_check()); \
  27. debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
  28. __func__, ##__VA_ARGS__); \
  29. } while(0)
  30. /*
  31. * Exit the u-boot world back to UEFI:
  32. */
  33. #define EFI_EXIT(ret) ({ \
  34. typeof(ret) _r = ret; \
  35. debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
  36. __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
  37. assert(__efi_exit_check()); \
  38. _r; \
  39. })
  40. /*
  41. * Call non-void UEFI function from u-boot and retrieve return value:
  42. */
  43. #define EFI_CALL(exp) ({ \
  44. debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  45. assert(__efi_exit_check()); \
  46. typeof(exp) _r = exp; \
  47. assert(__efi_entry_check()); \
  48. debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
  49. (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
  50. _r; \
  51. })
  52. /*
  53. * Call void UEFI function from u-boot:
  54. */
  55. #define EFI_CALL_VOID(exp) do { \
  56. debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  57. assert(__efi_exit_check()); \
  58. exp; \
  59. assert(__efi_entry_check()); \
  60. debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
  61. } while(0)
  62. /*
  63. * Write an indented message with EFI prefix
  64. */
  65. #define EFI_PRINT(format, ...) ({ \
  66. debug("%sEFI: " format, __efi_nesting(), \
  67. ##__VA_ARGS__); \
  68. })
  69. #ifdef CONFIG_SYS_CACHELINE_SIZE
  70. #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
  71. #else
  72. /* Just use the greatest cache flush alignment requirement I'm aware of */
  73. #define EFI_CACHELINE_SIZE 128
  74. #endif
  75. /* Key identifying current memory map */
  76. extern efi_uintn_t efi_memory_map_key;
  77. extern struct efi_runtime_services efi_runtime_services;
  78. extern struct efi_system_table systab;
  79. extern struct efi_simple_text_output_protocol efi_con_out;
  80. extern struct efi_simple_input_interface efi_con_in;
  81. extern struct efi_console_control_protocol efi_console_control;
  82. extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
  83. /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
  84. extern const struct efi_device_path_utilities_protocol
  85. efi_device_path_utilities;
  86. /* Implementation of the EFI_UNICODE_COLLATION_PROTOCOL */
  87. extern const struct efi_unicode_collation_protocol
  88. efi_unicode_collation_protocol;
  89. uint16_t *efi_dp_str(struct efi_device_path *dp);
  90. /* GUID of the EFI_BLOCK_IO_PROTOCOL */
  91. extern const efi_guid_t efi_block_io_guid;
  92. extern const efi_guid_t efi_global_variable_guid;
  93. extern const efi_guid_t efi_guid_console_control;
  94. extern const efi_guid_t efi_guid_device_path;
  95. /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
  96. extern const efi_guid_t efi_guid_driver_binding_protocol;
  97. /* event group ExitBootServices() invoked */
  98. extern const efi_guid_t efi_guid_event_group_exit_boot_services;
  99. /* event group SetVirtualAddressMap() invoked */
  100. extern const efi_guid_t efi_guid_event_group_virtual_address_change;
  101. /* event group memory map changed */
  102. extern const efi_guid_t efi_guid_event_group_memory_map_change;
  103. /* event group boot manager about to boot */
  104. extern const efi_guid_t efi_guid_event_group_ready_to_boot;
  105. /* event group ResetSystem() invoked (before ExitBootServices) */
  106. extern const efi_guid_t efi_guid_event_group_reset_system;
  107. /* GUID of the device tree table */
  108. extern const efi_guid_t efi_guid_fdt;
  109. extern const efi_guid_t efi_guid_loaded_image;
  110. extern const efi_guid_t efi_guid_device_path_to_text_protocol;
  111. extern const efi_guid_t efi_simple_file_system_protocol_guid;
  112. extern const efi_guid_t efi_file_info_guid;
  113. /* GUID for file system information */
  114. extern const efi_guid_t efi_file_system_info_guid;
  115. extern const efi_guid_t efi_guid_device_path_utilities_protocol;
  116. /* GUID of the Unicode collation protocol */
  117. extern const efi_guid_t efi_guid_unicode_collation_protocol;
  118. extern unsigned int __efi_runtime_start, __efi_runtime_stop;
  119. extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
  120. /*
  121. * When a protocol is opened a open protocol info entry is created.
  122. * These are maintained in a list.
  123. */
  124. struct efi_open_protocol_info_item {
  125. /* Link to the list of open protocol info entries of a protocol */
  126. struct list_head link;
  127. struct efi_open_protocol_info_entry info;
  128. };
  129. /*
  130. * When the UEFI payload wants to open a protocol on an object to get its
  131. * interface (usually a struct with callback functions), this struct maps the
  132. * protocol GUID to the respective protocol interface
  133. */
  134. struct efi_handler {
  135. /* Link to the list of protocols of a handle */
  136. struct list_head link;
  137. const efi_guid_t *guid;
  138. void *protocol_interface;
  139. /* Link to the list of open protocol info items */
  140. struct list_head open_infos;
  141. };
  142. /*
  143. * UEFI has a poor man's OO model where one "object" can be polymorphic and have
  144. * multiple different protocols (classes) attached to it.
  145. *
  146. * This struct is the parent struct for all of our actual implementation objects
  147. * that can include it to make themselves an EFI object
  148. */
  149. struct efi_object {
  150. /* Every UEFI object is part of a global object list */
  151. struct list_head link;
  152. /* The list of protocols */
  153. struct list_head protocols;
  154. /* The object spawner can either use this for data or as identifier */
  155. void *handle;
  156. };
  157. /**
  158. * struct efi_event
  159. *
  160. * @link: Link to list of all events
  161. * @type: Type of event, see efi_create_event
  162. * @notify_tpl: Task priority level of notifications
  163. * @nofify_function: Function to call when the event is triggered
  164. * @notify_context: Data to be passed to the notify function
  165. * @group: Event group
  166. * @trigger_time: Period of the timer
  167. * @trigger_next: Next time to trigger the timer
  168. * @trigger_type: Type of timer, see efi_set_timer
  169. * @is_queued: The notification function is queued
  170. * @is_signaled: The event occurred. The event is in the signaled state.
  171. */
  172. struct efi_event {
  173. struct list_head link;
  174. uint32_t type;
  175. efi_uintn_t notify_tpl;
  176. void (EFIAPI *notify_function)(struct efi_event *event, void *context);
  177. void *notify_context;
  178. const efi_guid_t *group;
  179. u64 trigger_next;
  180. u64 trigger_time;
  181. enum efi_timer_delay trigger_type;
  182. bool is_queued;
  183. bool is_signaled;
  184. };
  185. /* This list contains all UEFI objects we know of */
  186. extern struct list_head efi_obj_list;
  187. /* List of all events */
  188. extern struct list_head efi_events;
  189. /* Called by bootefi to initialize runtime */
  190. efi_status_t efi_initialize_system_table(void);
  191. /* Called by bootefi to make console interface available */
  192. int efi_console_register(void);
  193. /* Called by bootefi to make all disk storage accessible as EFI objects */
  194. efi_status_t efi_disk_register(void);
  195. /* Create handles and protocols for the partitions of a block device */
  196. int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
  197. const char *if_typename, int diskid,
  198. const char *pdevname);
  199. /* Called by bootefi to make GOP (graphical) interface available */
  200. efi_status_t efi_gop_register(void);
  201. /* Called by bootefi to make the network interface available */
  202. efi_status_t efi_net_register(void);
  203. /* Called by bootefi to make the watchdog available */
  204. efi_status_t efi_watchdog_register(void);
  205. /* Called by bootefi to make SMBIOS tables available */
  206. /**
  207. * efi_acpi_register() - write out ACPI tables
  208. *
  209. * Called by bootefi to make ACPI tables available
  210. *
  211. * @return 0 if OK, -ENOMEM if no memory is available for the tables
  212. */
  213. efi_status_t efi_acpi_register(void);
  214. /**
  215. * efi_smbios_register() - write out SMBIOS tables
  216. *
  217. * Called by bootefi to make SMBIOS tables available
  218. *
  219. * @return 0 if OK, -ENOMEM if no memory is available for the tables
  220. */
  221. efi_status_t efi_smbios_register(void);
  222. struct efi_simple_file_system_protocol *
  223. efi_fs_from_path(struct efi_device_path *fp);
  224. /* Called by networking code to memorize the dhcp ack package */
  225. void efi_net_set_dhcp_ack(void *pkt, int len);
  226. /* Called by efi_set_watchdog_timer to reset the timer */
  227. efi_status_t efi_set_watchdog(unsigned long timeout);
  228. /* Called from places to check whether a timer expired */
  229. void efi_timer_check(void);
  230. /* PE loader implementation */
  231. void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
  232. /* Called once to store the pristine gd pointer */
  233. void efi_save_gd(void);
  234. /* Special case handler for error/abort that just tries to dtrt to get
  235. * back to u-boot world */
  236. void efi_restore_gd(void);
  237. /* Call this to relocate the runtime section to an address space */
  238. void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
  239. /* Call this to set the current device name */
  240. void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
  241. /* Add a new object to the object list. */
  242. void efi_add_handle(struct efi_object *obj);
  243. /* Create handle */
  244. efi_status_t efi_create_handle(efi_handle_t *handle);
  245. /* Delete handle */
  246. void efi_delete_handle(struct efi_object *obj);
  247. /* Call this to validate a handle and find the EFI object for it */
  248. struct efi_object *efi_search_obj(const efi_handle_t handle);
  249. /* Find a protocol on a handle */
  250. efi_status_t efi_search_protocol(const efi_handle_t handle,
  251. const efi_guid_t *protocol_guid,
  252. struct efi_handler **handler);
  253. /* Install new protocol on a handle */
  254. efi_status_t efi_add_protocol(const efi_handle_t handle,
  255. const efi_guid_t *protocol,
  256. void *protocol_interface);
  257. /* Delete protocol from a handle */
  258. efi_status_t efi_remove_protocol(const efi_handle_t handle,
  259. const efi_guid_t *protocol,
  260. void *protocol_interface);
  261. /* Delete all protocols from a handle */
  262. efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
  263. /* Call this to create an event */
  264. efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
  265. void (EFIAPI *notify_function) (
  266. struct efi_event *event,
  267. void *context),
  268. void *notify_context, efi_guid_t *group,
  269. struct efi_event **event);
  270. /* Call this to set a timer */
  271. efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
  272. uint64_t trigger_time);
  273. /* Call this to signal an event */
  274. void efi_signal_event(struct efi_event *event, bool check_tpl);
  275. /* open file system: */
  276. struct efi_simple_file_system_protocol *efi_simple_file_system(
  277. struct blk_desc *desc, int part, struct efi_device_path *dp);
  278. /* open file from device-path: */
  279. struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
  280. /* Generic EFI memory allocator, call this to get memory */
  281. void *efi_alloc(uint64_t len, int memory_type);
  282. /* More specific EFI memory allocator, called by EFI payloads */
  283. efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
  284. uint64_t *memory);
  285. /* EFI memory free function. */
  286. efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
  287. /* EFI memory allocator for small allocations */
  288. efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
  289. void **buffer);
  290. /* EFI pool memory free function. */
  291. efi_status_t efi_free_pool(void *buffer);
  292. /* Returns the EFI memory map */
  293. efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
  294. struct efi_mem_desc *memory_map,
  295. efi_uintn_t *map_key,
  296. efi_uintn_t *descriptor_size,
  297. uint32_t *descriptor_version);
  298. /* Adds a range into the EFI memory map */
  299. uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
  300. bool overlap_only_ram);
  301. /* Called by board init to initialize the EFI drivers */
  302. efi_status_t efi_driver_init(void);
  303. /* Called by board init to initialize the EFI memory map */
  304. int efi_memory_init(void);
  305. /* Adds new or overrides configuration table entry to the system table */
  306. efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
  307. /* Sets up a loaded image */
  308. efi_status_t efi_setup_loaded_image(
  309. struct efi_loaded_image *info, struct efi_object *obj,
  310. struct efi_device_path *device_path,
  311. struct efi_device_path *file_path);
  312. efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
  313. void **buffer);
  314. /* Print information about a loaded image */
  315. efi_status_t efi_print_image_info(struct efi_loaded_image *image, void *pc);
  316. /* Print information about all loaded images */
  317. void efi_print_image_infos(void *pc);
  318. #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
  319. extern void *efi_bounce_buffer;
  320. #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
  321. #endif
  322. struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
  323. int efi_dp_match(const struct efi_device_path *a,
  324. const struct efi_device_path *b);
  325. struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
  326. struct efi_device_path **rem);
  327. /* get size of the first device path instance excluding end node */
  328. efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
  329. /* size of multi-instance device path excluding end node */
  330. efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
  331. struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
  332. struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
  333. const struct efi_device_path *dp2);
  334. struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
  335. const struct efi_device_path *node);
  336. /* Create a device path node of given type, sub-type, length */
  337. struct efi_device_path *efi_dp_create_device_node(const u8 type,
  338. const u8 sub_type,
  339. const u16 length);
  340. /* Append device path instance */
  341. struct efi_device_path *efi_dp_append_instance(
  342. const struct efi_device_path *dp,
  343. const struct efi_device_path *dpi);
  344. /* Get next device path instance */
  345. struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
  346. efi_uintn_t *size);
  347. /* Check if a device path contains muliple instances */
  348. bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
  349. struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
  350. struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
  351. /* Create a device node for a block device partition. */
  352. struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
  353. struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
  354. const char *path);
  355. struct efi_device_path *efi_dp_from_eth(void);
  356. struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
  357. uint64_t start_address,
  358. uint64_t end_address);
  359. /* Determine the last device path node that is not the end node. */
  360. const struct efi_device_path *efi_dp_last_node(
  361. const struct efi_device_path *dp);
  362. efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
  363. struct efi_device_path **device_path,
  364. struct efi_device_path **file_path);
  365. #define EFI_DP_TYPE(_dp, _type, _subtype) \
  366. (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
  367. ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
  368. /* Convert strings from normal C strings to uEFI strings */
  369. static inline void ascii2unicode(u16 *unicode, const char *ascii)
  370. {
  371. while (*ascii)
  372. *(unicode++) = *(ascii++);
  373. *unicode = 0;
  374. }
  375. static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
  376. {
  377. return memcmp(g1, g2, sizeof(efi_guid_t));
  378. }
  379. /*
  380. * Use these to indicate that your code / data should go into the EFI runtime
  381. * section and thus still be available when the OS is running
  382. */
  383. #define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
  384. #define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
  385. /* Update CRC32 in table header */
  386. void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
  387. /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
  388. * to make it available at runtime */
  389. efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
  390. /* Boards may provide the functions below to implement RTS functionality */
  391. void __efi_runtime EFIAPI efi_reset_system(
  392. enum efi_reset_type reset_type,
  393. efi_status_t reset_status,
  394. unsigned long data_size, void *reset_data);
  395. /* Architecture specific initialization of the EFI subsystem */
  396. efi_status_t efi_reset_system_init(void);
  397. efi_status_t __efi_runtime EFIAPI efi_get_time(
  398. struct efi_time *time,
  399. struct efi_time_cap *capabilities);
  400. #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
  401. /*
  402. * Entry point for the tests of the EFI API.
  403. * It is called by 'bootefi selftest'
  404. */
  405. efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
  406. struct efi_system_table *systab);
  407. #endif
  408. efi_status_t EFIAPI efi_get_variable(u16 *variable_name, efi_guid_t *vendor,
  409. u32 *attributes, efi_uintn_t *data_size,
  410. void *data);
  411. efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
  412. u16 *variable_name,
  413. efi_guid_t *vendor);
  414. efi_status_t EFIAPI efi_set_variable(u16 *variable_name, efi_guid_t *vendor,
  415. u32 attributes, efi_uintn_t data_size,
  416. void *data);
  417. void *efi_bootmgr_load(struct efi_device_path **device_path,
  418. struct efi_device_path **file_path);
  419. #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
  420. /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
  421. #define __efi_runtime_data
  422. #define __efi_runtime
  423. static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
  424. {
  425. return EFI_SUCCESS;
  426. }
  427. /* No loader configured, stub out EFI_ENTRY */
  428. static inline void efi_restore_gd(void) { }
  429. static inline void efi_set_bootdev(const char *dev, const char *devnr,
  430. const char *path) { }
  431. static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
  432. static inline void efi_print_image_infos(void *pc) { }
  433. #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
  434. #endif /* _EFI_LOADER_H */