efi_loader.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  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. static inline int guidcmp(const void *g1, const void *g2)
  13. {
  14. return memcmp(g1, g2, sizeof(efi_guid_t));
  15. }
  16. /* No need for efi loader support in SPL */
  17. #if CONFIG_IS_ENABLED(EFI_LOADER)
  18. #include <linux/list.h>
  19. /* Maximum number of configuration tables */
  20. #define EFI_MAX_CONFIGURATION_TABLES 16
  21. /* GUID used by the root node */
  22. #define U_BOOT_GUID \
  23. EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
  24. 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
  25. /* GUID used as host device on sandbox */
  26. #define U_BOOT_HOST_DEV_GUID \
  27. EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
  28. 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
  29. /* Root node */
  30. extern efi_handle_t efi_root;
  31. int __efi_entry_check(void);
  32. int __efi_exit_check(void);
  33. const char *__efi_nesting(void);
  34. const char *__efi_nesting_inc(void);
  35. const char *__efi_nesting_dec(void);
  36. /*
  37. * Enter the u-boot world from UEFI:
  38. */
  39. #define EFI_ENTRY(format, ...) do { \
  40. assert(__efi_entry_check()); \
  41. debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
  42. __func__, ##__VA_ARGS__); \
  43. } while(0)
  44. /*
  45. * Exit the u-boot world back to UEFI:
  46. */
  47. #define EFI_EXIT(ret) ({ \
  48. typeof(ret) _r = ret; \
  49. debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
  50. __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
  51. assert(__efi_exit_check()); \
  52. _r; \
  53. })
  54. /*
  55. * Call non-void UEFI function from u-boot and retrieve return value:
  56. */
  57. #define EFI_CALL(exp) ({ \
  58. debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  59. assert(__efi_exit_check()); \
  60. typeof(exp) _r = exp; \
  61. assert(__efi_entry_check()); \
  62. debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
  63. (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
  64. _r; \
  65. })
  66. /*
  67. * Call void UEFI function from u-boot:
  68. */
  69. #define EFI_CALL_VOID(exp) do { \
  70. debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  71. assert(__efi_exit_check()); \
  72. exp; \
  73. assert(__efi_entry_check()); \
  74. debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
  75. } while(0)
  76. /*
  77. * Write an indented message with EFI prefix
  78. */
  79. #define EFI_PRINT(format, ...) ({ \
  80. debug("%sEFI: " format, __efi_nesting(), \
  81. ##__VA_ARGS__); \
  82. })
  83. #ifdef CONFIG_SYS_CACHELINE_SIZE
  84. #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
  85. #else
  86. /* Just use the greatest cache flush alignment requirement I'm aware of */
  87. #define EFI_CACHELINE_SIZE 128
  88. #endif
  89. /* Key identifying current memory map */
  90. extern efi_uintn_t efi_memory_map_key;
  91. extern struct efi_runtime_services efi_runtime_services;
  92. extern struct efi_system_table systab;
  93. extern struct efi_simple_text_output_protocol efi_con_out;
  94. extern struct efi_simple_text_input_protocol efi_con_in;
  95. extern struct efi_console_control_protocol efi_console_control;
  96. extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
  97. /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
  98. extern const struct efi_device_path_utilities_protocol
  99. efi_device_path_utilities;
  100. /* deprecated version of the EFI_UNICODE_COLLATION_PROTOCOL */
  101. extern const struct efi_unicode_collation_protocol
  102. efi_unicode_collation_protocol;
  103. /* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
  104. extern const struct efi_unicode_collation_protocol
  105. efi_unicode_collation_protocol2;
  106. extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
  107. extern const struct efi_hii_config_access_protocol efi_hii_config_access;
  108. extern const struct efi_hii_database_protocol efi_hii_database;
  109. extern const struct efi_hii_string_protocol efi_hii_string;
  110. uint16_t *efi_dp_str(struct efi_device_path *dp);
  111. /* GUID of the U-Boot root node */
  112. extern const efi_guid_t efi_u_boot_guid;
  113. #ifdef CONFIG_SANDBOX
  114. /* GUID of U-Boot host device on sandbox */
  115. extern const efi_guid_t efi_guid_host_dev;
  116. #endif
  117. /* GUID of the EFI_BLOCK_IO_PROTOCOL */
  118. extern const efi_guid_t efi_block_io_guid;
  119. extern const efi_guid_t efi_global_variable_guid;
  120. extern const efi_guid_t efi_guid_console_control;
  121. extern const efi_guid_t efi_guid_device_path;
  122. /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
  123. extern const efi_guid_t efi_guid_driver_binding_protocol;
  124. /* event group ExitBootServices() invoked */
  125. extern const efi_guid_t efi_guid_event_group_exit_boot_services;
  126. /* event group SetVirtualAddressMap() invoked */
  127. extern const efi_guid_t efi_guid_event_group_virtual_address_change;
  128. /* event group memory map changed */
  129. extern const efi_guid_t efi_guid_event_group_memory_map_change;
  130. /* event group boot manager about to boot */
  131. extern const efi_guid_t efi_guid_event_group_ready_to_boot;
  132. /* event group ResetSystem() invoked (before ExitBootServices) */
  133. extern const efi_guid_t efi_guid_event_group_reset_system;
  134. /* GUID of the device tree table */
  135. extern const efi_guid_t efi_guid_fdt;
  136. extern const efi_guid_t efi_guid_loaded_image;
  137. extern const efi_guid_t efi_guid_loaded_image_device_path;
  138. extern const efi_guid_t efi_guid_device_path_to_text_protocol;
  139. extern const efi_guid_t efi_simple_file_system_protocol_guid;
  140. extern const efi_guid_t efi_file_info_guid;
  141. /* GUID for file system information */
  142. extern const efi_guid_t efi_file_system_info_guid;
  143. extern const efi_guid_t efi_guid_device_path_utilities_protocol;
  144. /* GUID of the deprecated Unicode collation protocol */
  145. extern const efi_guid_t efi_guid_unicode_collation_protocol;
  146. /* GUID of the Unicode collation protocol */
  147. extern const efi_guid_t efi_guid_unicode_collation_protocol2;
  148. extern const efi_guid_t efi_guid_hii_config_routing_protocol;
  149. extern const efi_guid_t efi_guid_hii_config_access_protocol;
  150. extern const efi_guid_t efi_guid_hii_database_protocol;
  151. extern const efi_guid_t efi_guid_hii_string_protocol;
  152. extern unsigned int __efi_runtime_start, __efi_runtime_stop;
  153. extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
  154. /**
  155. * struct efi_open_protocol_info_item - open protocol info item
  156. *
  157. * When a protocol is opened a open protocol info entry is created.
  158. * These are maintained in a list.
  159. *
  160. * @link: link to the list of open protocol info entries of a protocol
  161. * @info: information about the opening of a protocol
  162. */
  163. struct efi_open_protocol_info_item {
  164. struct list_head link;
  165. struct efi_open_protocol_info_entry info;
  166. };
  167. /**
  168. * struct efi_handler - single protocol interface of a handle
  169. *
  170. * When the UEFI payload wants to open a protocol on an object to get its
  171. * interface (usually a struct with callback functions), this struct maps the
  172. * protocol GUID to the respective protocol interface
  173. *
  174. * @link: link to the list of protocols of a handle
  175. * @guid: GUID of the protocol
  176. * @protocol_interface: protocol interface
  177. * @open_infos link to the list of open protocol info items
  178. */
  179. struct efi_handler {
  180. struct list_head link;
  181. const efi_guid_t *guid;
  182. void *protocol_interface;
  183. struct list_head open_infos;
  184. };
  185. /**
  186. * enum efi_object_type - type of EFI object
  187. *
  188. * In UnloadImage we must be able to identify if the handle relates to a
  189. * started image.
  190. */
  191. enum efi_object_type {
  192. EFI_OBJECT_TYPE_UNDEFINED = 0,
  193. EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
  194. EFI_OBJECT_TYPE_LOADED_IMAGE,
  195. EFI_OBJECT_TYPE_STARTED_IMAGE,
  196. };
  197. /**
  198. * struct efi_object - dereferenced EFI handle
  199. *
  200. * @link: pointers to put the handle into a linked list
  201. * @protocols: linked list with the protocol interfaces installed on this
  202. * handle
  203. *
  204. * UEFI offers a flexible and expandable object model. The objects in the UEFI
  205. * API are devices, drivers, and loaded images. struct efi_object is our storage
  206. * structure for these objects.
  207. *
  208. * When including this structure into a larger structure always put it first so
  209. * that when deleting a handle the whole encompassing structure can be freed.
  210. *
  211. * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
  212. * has been created for such pointers.
  213. */
  214. struct efi_object {
  215. /* Every UEFI object is part of a global object list */
  216. struct list_head link;
  217. /* The list of protocols */
  218. struct list_head protocols;
  219. enum efi_object_type type;
  220. };
  221. /**
  222. * struct efi_loaded_image_obj - handle of a loaded image
  223. *
  224. * @header: EFI object header
  225. * @exit_status: exit status passed to Exit()
  226. * @exit_data_size: exit data size passed to Exit()
  227. * @exit_data: exit data passed to Exit()
  228. * @exit_jmp: long jump buffer for returning form started image
  229. * @entry: entry address of the relocated image
  230. */
  231. struct efi_loaded_image_obj {
  232. struct efi_object header;
  233. efi_status_t exit_status;
  234. efi_uintn_t *exit_data_size;
  235. u16 **exit_data;
  236. struct jmp_buf_data exit_jmp;
  237. EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
  238. struct efi_system_table *st);
  239. u16 image_type;
  240. };
  241. /**
  242. * struct efi_event
  243. *
  244. * @link: Link to list of all events
  245. * @queue_link: Link to the list of queued events
  246. * @type: Type of event, see efi_create_event
  247. * @notify_tpl: Task priority level of notifications
  248. * @nofify_function: Function to call when the event is triggered
  249. * @notify_context: Data to be passed to the notify function
  250. * @group: Event group
  251. * @trigger_time: Period of the timer
  252. * @trigger_next: Next time to trigger the timer
  253. * @trigger_type: Type of timer, see efi_set_timer
  254. * @is_signaled: The event occurred. The event is in the signaled state.
  255. */
  256. struct efi_event {
  257. struct list_head link;
  258. struct list_head queue_link;
  259. uint32_t type;
  260. efi_uintn_t notify_tpl;
  261. void (EFIAPI *notify_function)(struct efi_event *event, void *context);
  262. void *notify_context;
  263. const efi_guid_t *group;
  264. u64 trigger_next;
  265. u64 trigger_time;
  266. enum efi_timer_delay trigger_type;
  267. bool is_signaled;
  268. };
  269. /* This list contains all UEFI objects we know of */
  270. extern struct list_head efi_obj_list;
  271. /* List of all events */
  272. extern struct list_head efi_events;
  273. /**
  274. * struct efi_protocol_notification - handle for notified protocol
  275. *
  276. * When a protocol interface is installed for which an event was registered with
  277. * the RegisterProtocolNotify() service this structure is used to hold the
  278. * handle on which the protocol interface was installed.
  279. *
  280. * @link: link to list of all handles notified for this event
  281. * @handle: handle on which the notified protocol interface was installed
  282. */
  283. struct efi_protocol_notification {
  284. struct list_head link;
  285. efi_handle_t handle;
  286. };
  287. /**
  288. * efi_register_notify_event - event registered by RegisterProtocolNotify()
  289. *
  290. * The address of this structure serves as registration value.
  291. *
  292. * @link: link to list of all registered events
  293. * @event: registered event. The same event may registered for multiple
  294. * GUIDs.
  295. * @protocol: protocol for which the event is registered
  296. * @handles: linked list of all handles on which the notified protocol was
  297. * installed
  298. */
  299. struct efi_register_notify_event {
  300. struct list_head link;
  301. struct efi_event *event;
  302. efi_guid_t protocol;
  303. struct list_head handles;
  304. };
  305. /* List of all events registered by RegisterProtocolNotify() */
  306. extern struct list_head efi_register_notify_events;
  307. /* Initialize efi execution environment */
  308. efi_status_t efi_init_obj_list(void);
  309. /* Initialize variable services */
  310. efi_status_t efi_init_variables(void);
  311. /* Notify ExitBootServices() is called */
  312. void efi_variables_boot_exit_notify(void);
  313. /* Called by bootefi to initialize root node */
  314. efi_status_t efi_root_node_register(void);
  315. /* Called by bootefi to initialize runtime */
  316. efi_status_t efi_initialize_system_table(void);
  317. /* efi_runtime_detach() - detach unimplemented runtime functions */
  318. void efi_runtime_detach(void);
  319. /* Called by bootefi to make console interface available */
  320. efi_status_t efi_console_register(void);
  321. /* Called by bootefi to make all disk storage accessible as EFI objects */
  322. efi_status_t efi_disk_register(void);
  323. /* Create handles and protocols for the partitions of a block device */
  324. int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
  325. const char *if_typename, int diskid,
  326. const char *pdevname);
  327. /* Called by bootefi to make GOP (graphical) interface available */
  328. efi_status_t efi_gop_register(void);
  329. /* Called by bootefi to make the network interface available */
  330. efi_status_t efi_net_register(void);
  331. /* Called by bootefi to make the watchdog available */
  332. efi_status_t efi_watchdog_register(void);
  333. /* Called by bootefi to make SMBIOS tables available */
  334. /**
  335. * efi_acpi_register() - write out ACPI tables
  336. *
  337. * Called by bootefi to make ACPI tables available
  338. *
  339. * @return 0 if OK, -ENOMEM if no memory is available for the tables
  340. */
  341. efi_status_t efi_acpi_register(void);
  342. /**
  343. * efi_smbios_register() - write out SMBIOS tables
  344. *
  345. * Called by bootefi to make SMBIOS tables available
  346. *
  347. * @return 0 if OK, -ENOMEM if no memory is available for the tables
  348. */
  349. efi_status_t efi_smbios_register(void);
  350. struct efi_simple_file_system_protocol *
  351. efi_fs_from_path(struct efi_device_path *fp);
  352. /* Called by networking code to memorize the dhcp ack package */
  353. void efi_net_set_dhcp_ack(void *pkt, int len);
  354. /* Called by efi_set_watchdog_timer to reset the timer */
  355. efi_status_t efi_set_watchdog(unsigned long timeout);
  356. /* Called from places to check whether a timer expired */
  357. void efi_timer_check(void);
  358. /* PE loader implementation */
  359. efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle, void *efi,
  360. struct efi_loaded_image *loaded_image_info);
  361. /* Called once to store the pristine gd pointer */
  362. void efi_save_gd(void);
  363. /* Special case handler for error/abort that just tries to dtrt to get
  364. * back to u-boot world */
  365. void efi_restore_gd(void);
  366. /* Call this to relocate the runtime section to an address space */
  367. void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
  368. /* Call this to set the current device name */
  369. void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
  370. /* Add a new object to the object list. */
  371. void efi_add_handle(efi_handle_t obj);
  372. /* Create handle */
  373. efi_status_t efi_create_handle(efi_handle_t *handle);
  374. /* Delete handle */
  375. void efi_delete_handle(efi_handle_t obj);
  376. /* Call this to validate a handle and find the EFI object for it */
  377. struct efi_object *efi_search_obj(const efi_handle_t handle);
  378. /* Load image */
  379. efi_status_t EFIAPI efi_load_image(bool boot_policy,
  380. efi_handle_t parent_image,
  381. struct efi_device_path *file_path,
  382. void *source_buffer,
  383. efi_uintn_t source_size,
  384. efi_handle_t *image_handle);
  385. /* Start image */
  386. efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
  387. efi_uintn_t *exit_data_size,
  388. u16 **exit_data);
  389. /* Unload image */
  390. efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
  391. /* Find a protocol on a handle */
  392. efi_status_t efi_search_protocol(const efi_handle_t handle,
  393. const efi_guid_t *protocol_guid,
  394. struct efi_handler **handler);
  395. /* Install new protocol on a handle */
  396. efi_status_t efi_add_protocol(const efi_handle_t handle,
  397. const efi_guid_t *protocol,
  398. void *protocol_interface);
  399. /* Delete protocol from a handle */
  400. efi_status_t efi_remove_protocol(const efi_handle_t handle,
  401. const efi_guid_t *protocol,
  402. void *protocol_interface);
  403. /* Delete all protocols from a handle */
  404. efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
  405. /* Install multiple protocol interfaces */
  406. efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
  407. (efi_handle_t *handle, ...);
  408. /* Call this to create an event */
  409. efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
  410. void (EFIAPI *notify_function) (
  411. struct efi_event *event,
  412. void *context),
  413. void *notify_context, efi_guid_t *group,
  414. struct efi_event **event);
  415. /* Call this to set a timer */
  416. efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
  417. uint64_t trigger_time);
  418. /* Call this to signal an event */
  419. void efi_signal_event(struct efi_event *event);
  420. /* open file system: */
  421. struct efi_simple_file_system_protocol *efi_simple_file_system(
  422. struct blk_desc *desc, int part, struct efi_device_path *dp);
  423. /* open file from device-path: */
  424. struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
  425. /**
  426. * efi_size_in_pages() - convert size in bytes to size in pages
  427. *
  428. * This macro returns the number of EFI memory pages required to hold 'size'
  429. * bytes.
  430. *
  431. * @size: size in bytes
  432. * Return: size in pages
  433. */
  434. #define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
  435. /* Generic EFI memory allocator, call this to get memory */
  436. void *efi_alloc(uint64_t len, int memory_type);
  437. /* More specific EFI memory allocator, called by EFI payloads */
  438. efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
  439. uint64_t *memory);
  440. /* EFI memory free function. */
  441. efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
  442. /* EFI memory allocator for small allocations */
  443. efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
  444. void **buffer);
  445. /* EFI pool memory free function. */
  446. efi_status_t efi_free_pool(void *buffer);
  447. /* Returns the EFI memory map */
  448. efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
  449. struct efi_mem_desc *memory_map,
  450. efi_uintn_t *map_key,
  451. efi_uintn_t *descriptor_size,
  452. uint32_t *descriptor_version);
  453. /* Adds a range into the EFI memory map */
  454. efi_status_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
  455. bool overlap_only_ram);
  456. /* Adds a conventional range into the EFI memory map */
  457. efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
  458. u64 ram_top);
  459. /* Called by board init to initialize the EFI drivers */
  460. efi_status_t efi_driver_init(void);
  461. /* Called by board init to initialize the EFI memory map */
  462. int efi_memory_init(void);
  463. /* Adds new or overrides configuration table entry to the system table */
  464. efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
  465. /* Sets up a loaded image */
  466. efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
  467. struct efi_device_path *file_path,
  468. struct efi_loaded_image_obj **handle_ptr,
  469. struct efi_loaded_image **info_ptr);
  470. /* Print information about all loaded images */
  471. void efi_print_image_infos(void *pc);
  472. #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
  473. extern void *efi_bounce_buffer;
  474. #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
  475. #endif
  476. struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
  477. int efi_dp_match(const struct efi_device_path *a,
  478. const struct efi_device_path *b);
  479. struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
  480. struct efi_device_path **rem);
  481. /* get size of the first device path instance excluding end node */
  482. efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
  483. /* size of multi-instance device path excluding end node */
  484. efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
  485. struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
  486. struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
  487. const struct efi_device_path *dp2);
  488. struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
  489. const struct efi_device_path *node);
  490. /* Create a device path node of given type, sub-type, length */
  491. struct efi_device_path *efi_dp_create_device_node(const u8 type,
  492. const u8 sub_type,
  493. const u16 length);
  494. /* Append device path instance */
  495. struct efi_device_path *efi_dp_append_instance(
  496. const struct efi_device_path *dp,
  497. const struct efi_device_path *dpi);
  498. /* Get next device path instance */
  499. struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
  500. efi_uintn_t *size);
  501. /* Check if a device path contains muliple instances */
  502. bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
  503. struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
  504. /* Create a device node for a block device partition. */
  505. struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
  506. struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
  507. const char *path);
  508. struct efi_device_path *efi_dp_from_eth(void);
  509. struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
  510. uint64_t start_address,
  511. uint64_t end_address);
  512. /* Determine the last device path node that is not the end node. */
  513. const struct efi_device_path *efi_dp_last_node(
  514. const struct efi_device_path *dp);
  515. efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
  516. struct efi_device_path **device_path,
  517. struct efi_device_path **file_path);
  518. efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
  519. const char *path,
  520. struct efi_device_path **device,
  521. struct efi_device_path **file);
  522. #define EFI_DP_TYPE(_dp, _type, _subtype) \
  523. (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
  524. ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
  525. /*
  526. * Use these to indicate that your code / data should go into the EFI runtime
  527. * section and thus still be available when the OS is running
  528. */
  529. #define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
  530. #define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
  531. /* Indicate supported runtime services */
  532. efi_status_t efi_init_runtime_supported(void);
  533. /* Update CRC32 in table header */
  534. void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
  535. /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
  536. * to make it available at runtime */
  537. efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
  538. /* Boards may provide the functions below to implement RTS functionality */
  539. void __efi_runtime EFIAPI efi_reset_system(
  540. enum efi_reset_type reset_type,
  541. efi_status_t reset_status,
  542. unsigned long data_size, void *reset_data);
  543. /* Architecture specific initialization of the EFI subsystem */
  544. efi_status_t efi_reset_system_init(void);
  545. efi_status_t __efi_runtime EFIAPI efi_get_time(
  546. struct efi_time *time,
  547. struct efi_time_cap *capabilities);
  548. efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
  549. #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
  550. /*
  551. * Entry point for the tests of the EFI API.
  552. * It is called by 'bootefi selftest'
  553. */
  554. efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
  555. struct efi_system_table *systab);
  556. #endif
  557. efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
  558. const efi_guid_t *vendor, u32 *attributes,
  559. efi_uintn_t *data_size, void *data);
  560. efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
  561. u16 *variable_name,
  562. const efi_guid_t *vendor);
  563. efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
  564. const efi_guid_t *vendor, u32 attributes,
  565. efi_uintn_t data_size, const void *data);
  566. efi_status_t EFIAPI efi_query_variable_info(
  567. u32 attributes, u64 *maximum_variable_storage_size,
  568. u64 *remaining_variable_storage_size,
  569. u64 *maximum_variable_size);
  570. /*
  571. * See section 3.1.3 in the v2.7 UEFI spec for more details on
  572. * the layout of EFI_LOAD_OPTION. In short it is:
  573. *
  574. * typedef struct _EFI_LOAD_OPTION {
  575. * UINT32 Attributes;
  576. * UINT16 FilePathListLength;
  577. * // CHAR16 Description[]; <-- variable length, NULL terminated
  578. * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
  579. * <-- FilePathListLength bytes
  580. * // UINT8 OptionalData[];
  581. * } EFI_LOAD_OPTION;
  582. */
  583. struct efi_load_option {
  584. u32 attributes;
  585. u16 file_path_length;
  586. u16 *label;
  587. struct efi_device_path *file_path;
  588. const u8 *optional_data;
  589. };
  590. void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
  591. unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
  592. efi_status_t efi_bootmgr_load(efi_handle_t *handle);
  593. #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
  594. /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
  595. #define __efi_runtime_data
  596. #define __efi_runtime
  597. static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
  598. {
  599. return EFI_SUCCESS;
  600. }
  601. /* No loader configured, stub out EFI_ENTRY */
  602. static inline void efi_restore_gd(void) { }
  603. static inline void efi_set_bootdev(const char *dev, const char *devnr,
  604. const char *path) { }
  605. static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
  606. static inline void efi_print_image_infos(void *pc) { }
  607. #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
  608. #endif /* _EFI_LOADER_H */