efi_loader.h 28 KB

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