efi_loader.h 28 KB

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