efi_loader.h 27 KB

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