efi_loader.h 31 KB

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