1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
9 #define _EFI_LOADER_H 1
19 #include <linux/list.h>
20 #include <linux/oid_registry.h>
25 static inline int guidcmp(const void *g1, const void *g2)
27 return memcmp(g1, g2, sizeof(efi_guid_t));
30 static inline void *guidcpy(void *dst, const void *src)
32 return memcpy(dst, src, sizeof(efi_guid_t));
35 #if CONFIG_IS_ENABLED(EFI_LOADER)
38 * __efi_runtime_data - declares a non-const variable for EFI runtime section
40 * This macro indicates that a variable is non-const and should go into the
41 * EFI runtime section, and thus still be available when the OS is running.
43 * Only use on variables not declared const.
49 * static __efi_runtime_data my_computed_table[256];
51 #define __efi_runtime_data __section(".data.efi_runtime")
54 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
56 * This macro indicates that a variable is read-only (const) and should go into
57 * the EFI runtime section, and thus still be available when the OS is running.
59 * Only use on variables also declared const.
65 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
67 #define __efi_runtime_rodata __section(".rodata.efi_runtime")
70 * __efi_runtime - declares a function for EFI runtime section
72 * This macro indicates that a function should go into the EFI runtime section,
73 * and thus still be available when the OS is running.
79 * static __efi_runtime compute_my_table(void);
81 #define __efi_runtime __section(".text.efi_runtime")
84 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
85 * to make it available at runtime
87 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
90 * Special case handler for error/abort that just tries to dtrt to get
91 * back to u-boot world
93 void efi_restore_gd(void);
94 /* Call this to set the current device name */
95 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
96 void *buffer, size_t buffer_size);
97 /* Called by networking code to memorize the dhcp ack package */
98 void efi_net_set_dhcp_ack(void *pkt, int len);
99 /* Print information about all loaded images */
100 void efi_print_image_infos(void *pc);
102 /* Hook at initialization */
103 efi_status_t efi_launch_capsules(void);
105 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
107 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
108 #define __efi_runtime_data
109 #define __efi_runtime_rodata
110 #define __efi_runtime
111 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
116 /* No loader configured, stub out EFI_ENTRY */
117 static inline void efi_restore_gd(void) { }
118 static inline void efi_set_bootdev(const char *dev, const char *devnr,
119 const char *path, void *buffer,
120 size_t buffer_size) { }
121 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
122 static inline void efi_print_image_infos(void *pc) { }
123 static inline efi_status_t efi_launch_capsules(void)
128 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
130 /* Maximum number of configuration tables */
131 #define EFI_MAX_CONFIGURATION_TABLES 16
133 /* GUID used by the root node */
134 #define U_BOOT_GUID \
135 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
136 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
137 /* GUID used as host device on sandbox */
138 #define U_BOOT_HOST_DEV_GUID \
139 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
140 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
141 /* GUID used as root for virtio devices */
142 #define U_BOOT_VIRTIO_DEV_GUID \
143 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
144 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
146 /* GUID for the auto generated boot menu entry */
147 #define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
148 EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \
149 0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde)
151 /* Use internal device tree when starting UEFI application */
152 #define EFI_FDT_USE_INTERNAL NULL
155 extern efi_handle_t efi_root;
157 /* Set to EFI_SUCCESS when initialized */
158 extern efi_status_t efi_obj_list_initialized;
160 /* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
161 extern bool efi_st_keep_devices;
163 /* EFI system partition */
164 extern struct efi_system_partition {
165 enum uclass_id uclass_id;
168 } efi_system_partition;
170 int __efi_entry_check(void);
171 int __efi_exit_check(void);
172 const char *__efi_nesting(void);
173 const char *__efi_nesting_inc(void);
174 const char *__efi_nesting_dec(void);
177 * Enter the u-boot world from UEFI:
179 #define EFI_ENTRY(format, ...) do { \
180 assert(__efi_entry_check()); \
181 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
182 __func__, ##__VA_ARGS__); \
186 * Exit the u-boot world back to UEFI:
188 #define EFI_EXIT(ret) ({ \
189 typeof(ret) _r = ret; \
190 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
191 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
192 assert(__efi_exit_check()); \
197 * Call non-void UEFI function from u-boot and retrieve return value:
199 #define EFI_CALL(exp) ({ \
200 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
201 assert(__efi_exit_check()); \
202 typeof(exp) _r = exp; \
203 assert(__efi_entry_check()); \
204 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
205 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
210 * Call void UEFI function from u-boot:
212 #define EFI_CALL_VOID(exp) do { \
213 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
214 assert(__efi_exit_check()); \
216 assert(__efi_entry_check()); \
217 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
221 * Write an indented message with EFI prefix
223 #define EFI_PRINT(format, ...) ({ \
224 debug("%sEFI: " format, __efi_nesting(), \
228 #ifdef CONFIG_SYS_CACHELINE_SIZE
229 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
231 /* Just use the greatest cache flush alignment requirement I'm aware of */
232 #define EFI_CACHELINE_SIZE 128
235 /* max bootmenu title size for volume selection */
236 #define BOOTMENU_DEVICE_NAME_MAX 16
238 /* Key identifying current memory map */
239 extern efi_uintn_t efi_memory_map_key;
241 extern struct efi_runtime_services efi_runtime_services;
242 extern struct efi_system_table systab;
244 extern struct efi_simple_text_output_protocol efi_con_out;
245 extern struct efi_simple_text_input_protocol efi_con_in;
246 extern struct efi_console_control_protocol efi_console_control;
247 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
248 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
249 extern const struct efi_device_path_utilities_protocol
250 efi_device_path_utilities;
251 /* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
252 extern const struct efi_unicode_collation_protocol
253 efi_unicode_collation_protocol2;
254 extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
255 extern const struct efi_hii_config_access_protocol efi_hii_config_access;
256 extern const struct efi_hii_database_protocol efi_hii_database;
257 extern const struct efi_hii_string_protocol efi_hii_string;
259 uint16_t *efi_dp_str(struct efi_device_path *dp);
261 /* GUID for the auto generated boot menu entry */
262 extern const efi_guid_t efi_guid_bootmenu_auto_generated;
264 /* GUID of the U-Boot root node */
265 extern const efi_guid_t efi_u_boot_guid;
266 #ifdef CONFIG_SANDBOX
267 /* GUID of U-Boot host device on sandbox */
268 extern const efi_guid_t efi_guid_host_dev;
270 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
271 extern const efi_guid_t efi_block_io_guid;
272 extern const efi_guid_t efi_global_variable_guid;
273 extern const efi_guid_t efi_guid_console_control;
274 extern const efi_guid_t efi_guid_device_path;
275 /* GUID of the EFI system partition */
276 extern const efi_guid_t efi_system_partition_guid;
277 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
278 extern const efi_guid_t efi_guid_driver_binding_protocol;
279 /* event group ExitBootServices() invoked */
280 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
281 /* event group SetVirtualAddressMap() invoked */
282 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
283 /* event group memory map changed */
284 extern const efi_guid_t efi_guid_event_group_memory_map_change;
285 /* event group boot manager about to boot */
286 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
287 /* event group ResetSystem() invoked (before ExitBootServices) */
288 extern const efi_guid_t efi_guid_event_group_reset_system;
289 /* GUID of the device tree table */
290 extern const efi_guid_t efi_guid_fdt;
291 extern const efi_guid_t efi_guid_loaded_image;
292 extern const efi_guid_t efi_guid_loaded_image_device_path;
293 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
294 extern const efi_guid_t efi_simple_file_system_protocol_guid;
295 extern const efi_guid_t efi_file_info_guid;
296 /* GUID for file system information */
297 extern const efi_guid_t efi_file_system_info_guid;
298 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
299 /* GUID of the deprecated Unicode collation protocol */
300 extern const efi_guid_t efi_guid_unicode_collation_protocol;
301 /* GUIDs of the Load File and Load File2 protocol */
302 extern const efi_guid_t efi_guid_load_file_protocol;
303 extern const efi_guid_t efi_guid_load_file2_protocol;
304 /* GUID of the Unicode collation protocol */
305 extern const efi_guid_t efi_guid_unicode_collation_protocol2;
306 extern const efi_guid_t efi_guid_hii_config_routing_protocol;
307 extern const efi_guid_t efi_guid_hii_config_access_protocol;
308 extern const efi_guid_t efi_guid_hii_database_protocol;
309 extern const efi_guid_t efi_guid_hii_string_protocol;
310 /* GUIDs for authentication */
311 extern const efi_guid_t efi_guid_image_security_database;
312 extern const efi_guid_t efi_guid_sha256;
313 extern const efi_guid_t efi_guid_cert_x509;
314 extern const efi_guid_t efi_guid_cert_x509_sha256;
315 extern const efi_guid_t efi_guid_cert_x509_sha384;
316 extern const efi_guid_t efi_guid_cert_x509_sha512;
317 extern const efi_guid_t efi_guid_cert_type_pkcs7;
319 /* GUID of RNG protocol */
320 extern const efi_guid_t efi_guid_rng_protocol;
321 /* GUID of capsule update result */
322 extern const efi_guid_t efi_guid_capsule_report;
323 /* GUID of firmware management protocol */
324 extern const efi_guid_t efi_guid_firmware_management_protocol;
325 /* GUID for the ESRT */
326 extern const efi_guid_t efi_esrt_guid;
327 /* GUID of the SMBIOS table */
328 extern const efi_guid_t smbios_guid;
330 extern const efi_guid_t efi_guid_text_input_protocol;
331 extern const efi_guid_t efi_guid_text_output_protocol;
333 extern char __efi_runtime_start[], __efi_runtime_stop[];
334 extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
337 * struct efi_open_protocol_info_item - open protocol info item
339 * When a protocol is opened a open protocol info entry is created.
340 * These are maintained in a list.
342 * @link: link to the list of open protocol info entries of a protocol
343 * @info: information about the opening of a protocol
345 struct efi_open_protocol_info_item {
346 struct list_head link;
347 struct efi_open_protocol_info_entry info;
351 * struct efi_handler - single protocol interface of a handle
353 * When the UEFI payload wants to open a protocol on an object to get its
354 * interface (usually a struct with callback functions), this struct maps the
355 * protocol GUID to the respective protocol interface
357 * @link: link to the list of protocols of a handle
358 * @guid: GUID of the protocol
359 * @protocol_interface: protocol interface
360 * @open_infos: link to the list of open protocol info items
363 struct list_head link;
364 const efi_guid_t guid;
365 void *protocol_interface;
366 struct list_head open_infos;
370 * enum efi_object_type - type of EFI object
372 * In UnloadImage we must be able to identify if the handle relates to a
375 enum efi_object_type {
376 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
377 EFI_OBJECT_TYPE_UNDEFINED = 0,
378 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
379 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
380 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
381 EFI_OBJECT_TYPE_LOADED_IMAGE,
382 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
383 EFI_OBJECT_TYPE_STARTED_IMAGE,
387 * struct efi_object - dereferenced EFI handle
389 * @link: pointers to put the handle into a linked list
390 * @protocols: linked list with the protocol interfaces installed on this
392 * @type: image type if the handle relates to an image
393 * @dev: pointer to the DM device which is associated with this EFI handle
395 * UEFI offers a flexible and expandable object model. The objects in the UEFI
396 * API are devices, drivers, and loaded images. struct efi_object is our storage
397 * structure for these objects.
399 * When including this structure into a larger structure always put it first so
400 * that when deleting a handle the whole encompassing structure can be freed.
402 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
403 * has been created for such pointers.
406 /* Every UEFI object is part of a global object list */
407 struct list_head link;
408 /* The list of protocols */
409 struct list_head protocols;
410 enum efi_object_type type;
414 enum efi_image_auth_status {
415 EFI_IMAGE_AUTH_FAILED = 0,
416 EFI_IMAGE_AUTH_PASSED,
420 * struct efi_loaded_image_obj - handle of a loaded image
422 * @header: EFI object header
423 * @exit_status: exit status passed to Exit()
424 * @exit_data_size: exit data size passed to Exit()
425 * @exit_data: exit data passed to Exit()
426 * @exit_jmp: long jump buffer for returning from started image
427 * @entry: entry address of the relocated image
428 * @image_type: indicates if the image is an applicition or a driver
429 * @auth_status: indicates if the image is authenticated
431 struct efi_loaded_image_obj {
432 struct efi_object header;
433 efi_status_t *exit_status;
434 efi_uintn_t *exit_data_size;
436 struct jmp_buf_data *exit_jmp;
437 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
438 struct efi_system_table *st);
440 enum efi_image_auth_status auth_status;
446 * @link: Link to list of all events
447 * @queue_link: Link to the list of queued events
448 * @type: Type of event, see efi_create_event
449 * @notify_tpl: Task priority level of notifications
450 * @notify_function: Function to call when the event is triggered
451 * @notify_context: Data to be passed to the notify function
452 * @group: Event group
453 * @trigger_time: Period of the timer
454 * @trigger_next: Next time to trigger the timer
455 * @trigger_type: Type of timer, see efi_set_timer
456 * @is_signaled: The event occurred. The event is in the signaled state.
459 struct list_head link;
460 struct list_head queue_link;
462 efi_uintn_t notify_tpl;
463 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
464 void *notify_context;
465 const efi_guid_t *group;
468 enum efi_timer_delay trigger_type;
472 /* This list contains all UEFI objects we know of */
473 extern struct list_head efi_obj_list;
474 /* List of all events */
475 extern struct list_head efi_events;
478 * struct efi_protocol_notification - handle for notified protocol
480 * When a protocol interface is installed for which an event was registered with
481 * the RegisterProtocolNotify() service this structure is used to hold the
482 * handle on which the protocol interface was installed.
484 * @link: link to list of all handles notified for this event
485 * @handle: handle on which the notified protocol interface was installed
487 struct efi_protocol_notification {
488 struct list_head link;
493 * struct efi_register_notify_event - event registered by
494 * RegisterProtocolNotify()
496 * The address of this structure serves as registration value.
498 * @link: link to list of all registered events
499 * @event: registered event. The same event may registered for multiple
501 * @protocol: protocol for which the event is registered
502 * @handles: linked list of all handles on which the notified protocol was
505 struct efi_register_notify_event {
506 struct list_head link;
507 struct efi_event *event;
509 struct list_head handles;
512 /* List of all events registered by RegisterProtocolNotify() */
513 extern struct list_head efi_register_notify_events;
515 /* called at pre-initialization */
516 int efi_init_early(void);
517 /* Initialize efi execution environment */
518 efi_status_t efi_init_obj_list(void);
519 /* Set up console modes */
520 void efi_setup_console_size(void);
521 /* Install device tree */
522 efi_status_t efi_install_fdt(void *fdt);
523 /* Run loaded UEFI image */
524 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
525 /* Initialize variable services */
526 efi_status_t efi_init_variables(void);
527 /* Notify ExitBootServices() is called */
528 void efi_variables_boot_exit_notify(void);
529 efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
530 /* Measure efi application invocation */
531 efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
532 /* Measure efi application exit */
533 efi_status_t efi_tcg2_measure_efi_app_exit(void);
535 efi_status_t efi_tcg2_measure_dtb(void *dtb);
536 /* Called by bootefi to initialize root node */
537 efi_status_t efi_root_node_register(void);
538 /* Called by bootefi to initialize runtime */
539 efi_status_t efi_initialize_system_table(void);
540 /* efi_runtime_detach() - detach unimplemented runtime functions */
541 void efi_runtime_detach(void);
542 /* efi_convert_pointer() - convert pointer to virtual address */
543 efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
545 /* Carve out DT reserved memory ranges */
546 void efi_carve_out_dt_rsv(void *fdt);
547 /* Purge unused kaslr-seed */
548 void efi_try_purge_kaslr_seed(void *fdt);
549 /* Called by bootefi to make console interface available */
550 efi_status_t efi_console_register(void);
551 /* Called by efi_init_obj_list() to proble all block devices */
552 efi_status_t efi_disks_register(void);
553 /* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
554 efi_status_t efi_rng_register(void);
555 /* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
556 efi_status_t efi_tcg2_register(void);
557 /* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
558 efi_status_t efi_riscv_register(void);
559 /* Called by efi_init_obj_list() to do initial measurement */
560 efi_status_t efi_tcg2_do_initial_measurement(void);
561 /* measure the pe-coff image, extend PCR and add Event Log */
562 efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
563 struct efi_loaded_image_obj *handle,
564 struct efi_loaded_image *loaded_image_info);
565 /* Create handles and protocols for the partitions of a block device */
566 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
567 const char *uclass_idname, int diskid,
568 const char *pdevname);
569 /* Called by bootefi to make GOP (graphical) interface available */
570 efi_status_t efi_gop_register(void);
571 /* Called by bootefi to make the network interface available */
572 efi_status_t efi_net_register(void);
573 /* Called by bootefi to make the watchdog available */
574 efi_status_t efi_watchdog_register(void);
575 efi_status_t efi_initrd_register(void);
576 efi_status_t efi_initrd_deregister(void);
577 /* Called by bootefi to make SMBIOS tables available */
579 * efi_acpi_register() - write out ACPI tables
581 * Called by bootefi to make ACPI tables available
583 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
585 efi_status_t efi_acpi_register(void);
587 * efi_smbios_register() - write out SMBIOS tables
589 * Called by bootefi to make SMBIOS tables available
591 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
593 efi_status_t efi_smbios_register(void);
595 struct efi_simple_file_system_protocol *
596 efi_fs_from_path(struct efi_device_path *fp);
598 /* Called by efi_set_watchdog_timer to reset the timer */
599 efi_status_t efi_set_watchdog(unsigned long timeout);
601 /* Called from places to check whether a timer expired */
602 void efi_timer_check(void);
603 /* Check if a buffer contains a PE-COFF image */
604 efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
605 /* PE loader implementation */
606 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
607 void *efi, size_t efi_size,
608 struct efi_loaded_image *loaded_image_info);
609 /* Called once to store the pristine gd pointer */
610 void efi_save_gd(void);
611 /* Call this to relocate the runtime section to an address space */
612 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
613 /* Call this to get image parameters */
614 void efi_get_image_parameters(void **img_addr, size_t *img_size);
615 /* Add a new object to the object list. */
616 void efi_add_handle(efi_handle_t obj);
618 efi_status_t efi_create_handle(efi_handle_t *handle);
620 void efi_delete_handle(efi_handle_t obj);
621 /* Call this to validate a handle and find the EFI object for it */
622 struct efi_object *efi_search_obj(const efi_handle_t handle);
623 /* Locate device_path handle */
624 efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
625 struct efi_device_path **device_path,
626 efi_handle_t *device);
628 efi_status_t EFIAPI efi_load_image(bool boot_policy,
629 efi_handle_t parent_image,
630 struct efi_device_path *file_path,
632 efi_uintn_t source_size,
633 efi_handle_t *image_handle);
635 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
636 efi_uintn_t *exit_data_size,
639 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
640 /* Find a protocol on a handle */
641 efi_status_t efi_search_protocol(const efi_handle_t handle,
642 const efi_guid_t *protocol_guid,
643 struct efi_handler **handler);
644 /* Install new protocol on a handle */
645 efi_status_t efi_add_protocol(const efi_handle_t handle,
646 const efi_guid_t *protocol,
647 void *protocol_interface);
649 efi_status_t efi_protocol_open(struct efi_handler *handler,
650 void **protocol_interface, void *agent_handle,
651 void *controller_handle, uint32_t attributes);
653 /* Delete protocol from a handle */
654 efi_status_t efi_remove_protocol(const efi_handle_t handle,
655 const efi_guid_t *protocol,
656 void *protocol_interface);
657 /* Install multiple protocol interfaces */
659 efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
661 efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
662 /* Get handles that support a given protocol */
663 efi_status_t EFIAPI efi_locate_handle_buffer(
664 enum efi_locate_search_type search_type,
665 const efi_guid_t *protocol, void *search_key,
666 efi_uintn_t *no_handles, efi_handle_t **buffer);
667 /* Close a previously opened protocol interface */
668 efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
669 efi_handle_t agent_handle,
670 efi_handle_t controller_handle);
671 /* Open a protocol interface */
672 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
673 const efi_guid_t *protocol,
674 void **protocol_interface);
675 /* Call this to create an event */
676 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
677 void (EFIAPI *notify_function) (
678 struct efi_event *event,
680 void *notify_context, efi_guid_t *group,
681 struct efi_event **event);
682 /* Call this to set a timer */
683 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
684 uint64_t trigger_time);
685 /* Call this to signal an event */
686 void efi_signal_event(struct efi_event *event);
688 /* return true if the device is removable */
689 bool efi_disk_is_removable(efi_handle_t handle);
691 /* open file system: */
692 struct efi_simple_file_system_protocol *efi_simple_file_system(
693 struct blk_desc *desc, int part, struct efi_device_path *dp);
695 /* open file from device-path: */
696 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
698 /* Registers a callback function for a notification event. */
699 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
700 struct efi_event *event,
701 void **registration);
702 efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
704 /* get a device path from a Boot#### option */
705 struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
707 /* get len, string (used in u-boot crypto from a guid */
708 const char *guid_to_sha_str(const efi_guid_t *guid);
709 int algo_to_len(const char *algo);
711 int efi_link_dev(efi_handle_t handle, struct udevice *dev);
712 int efi_unlink_dev(efi_handle_t handle);
713 bool efi_varname_is_load_option(u16 *var_name16, int *index);
714 efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
718 * efi_size_in_pages() - convert size in bytes to size in pages
720 * This macro returns the number of EFI memory pages required to hold 'size'
723 * @size: size in bytes
724 * Return: size in pages
726 #define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
727 /* Allocate boot service data pool memory */
728 void *efi_alloc(size_t len);
729 /* Allocate pages on the specified alignment */
730 void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
731 /* More specific EFI memory allocator, called by EFI payloads */
732 efi_status_t efi_allocate_pages(enum efi_allocate_type type,
733 enum efi_memory_type memory_type,
734 efi_uintn_t pages, uint64_t *memory);
735 /* EFI memory free function. */
736 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
737 /* EFI memory allocator for small allocations */
738 efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
739 efi_uintn_t size, void **buffer);
740 /* EFI pool memory free function. */
741 efi_status_t efi_free_pool(void *buffer);
742 /* Allocate and retrieve EFI memory map */
743 efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
744 struct efi_mem_desc **memory_map);
745 /* Returns the EFI memory map */
746 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
747 struct efi_mem_desc *memory_map,
748 efi_uintn_t *map_key,
749 efi_uintn_t *descriptor_size,
750 uint32_t *descriptor_version);
751 /* Adds a range into the EFI memory map */
752 efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
753 /* Adds a conventional range into the EFI memory map */
754 efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
757 /* Called by board init to initialize the EFI drivers */
758 efi_status_t efi_driver_init(void);
759 /* Called when a block device is added */
760 int efi_disk_probe(void *ctx, struct event *event);
761 /* Called when a block device is removed */
762 int efi_disk_remove(void *ctx, struct event *event);
763 /* Called by board init to initialize the EFI memory map */
764 int efi_memory_init(void);
765 /* Adds new or overrides configuration table entry to the system table */
766 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
767 /* Sets up a loaded image */
768 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
769 struct efi_device_path *file_path,
770 struct efi_loaded_image_obj **handle_ptr,
771 struct efi_loaded_image **info_ptr);
773 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
774 extern void *efi_bounce_buffer;
775 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
778 /* shorten device path */
779 struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
780 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
781 int efi_dp_match(const struct efi_device_path *a,
782 const struct efi_device_path *b);
783 efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
784 const efi_guid_t *guid,
785 struct efi_device_path **rem);
786 /* get size of the first device path instance excluding end node */
787 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
788 /* size of multi-instance device path excluding end node */
789 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
790 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
791 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
792 const struct efi_device_path *dp2);
793 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
794 const struct efi_device_path *node);
795 /* Create a device path node of given type, sub-type, length */
796 struct efi_device_path *efi_dp_create_device_node(const u8 type,
799 /* Append device path instance */
800 struct efi_device_path *efi_dp_append_instance(
801 const struct efi_device_path *dp,
802 const struct efi_device_path *dpi);
803 /* Get next device path instance */
804 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
806 /* Check if a device path contains muliple instances */
807 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
809 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
810 /* Create a device node for a block device partition. */
811 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
812 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
814 struct efi_device_path *efi_dp_from_eth(void);
815 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
816 uint64_t start_address,
817 uint64_t end_address);
818 /* Determine the last device path node that is not the end node. */
819 const struct efi_device_path *efi_dp_last_node(
820 const struct efi_device_path *dp);
821 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
822 struct efi_device_path **device_path,
823 struct efi_device_path **file_path);
824 struct efi_device_path *efi_dp_from_uart(void);
825 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
827 struct efi_device_path **device,
828 struct efi_device_path **file);
829 ssize_t efi_dp_check_length(const struct efi_device_path *dp,
830 const size_t maxlen);
832 #define EFI_DP_TYPE(_dp, _type, _subtype) \
833 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
834 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
836 /* template END node: */
837 extern const struct efi_device_path END;
839 /* Indicate supported runtime services */
840 efi_status_t efi_init_runtime_supported(void);
842 /* Update CRC32 in table header */
843 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
845 /* Boards may provide the functions below to implement RTS functionality */
847 void __efi_runtime EFIAPI efi_reset_system(
848 enum efi_reset_type reset_type,
849 efi_status_t reset_status,
850 unsigned long data_size, void *reset_data);
852 /* Architecture specific initialization of the EFI subsystem */
853 efi_status_t efi_reset_system_init(void);
855 efi_status_t __efi_runtime EFIAPI efi_get_time(
856 struct efi_time *time,
857 struct efi_time_cap *capabilities);
859 efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
861 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
863 * Entry point for the tests of the EFI API.
864 * It is called by 'bootefi selftest'
866 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
867 struct efi_system_table *systab);
870 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
871 const efi_guid_t *vendor, u32 *attributes,
872 efi_uintn_t *data_size, void *data);
873 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
876 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
877 const efi_guid_t *vendor, u32 attributes,
878 efi_uintn_t data_size, const void *data);
880 efi_status_t EFIAPI efi_query_variable_info(
881 u32 attributes, u64 *maximum_variable_storage_size,
882 u64 *remaining_variable_storage_size,
883 u64 *maximum_variable_size);
885 void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
888 * See section 3.1.3 in the v2.7 UEFI spec for more details on
889 * the layout of EFI_LOAD_OPTION. In short it is:
891 * typedef struct _EFI_LOAD_OPTION {
893 * UINT16 FilePathListLength;
894 * // CHAR16 Description[]; <-- variable length, NULL terminated
895 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
896 * <-- FilePathListLength bytes
897 * // UINT8 OptionalData[];
900 struct efi_load_option {
902 u16 file_path_length;
904 struct efi_device_path *file_path;
905 const u8 *optional_data;
908 struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
909 const efi_guid_t *guid);
910 struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
911 const struct efi_device_path *dp2);
912 struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
913 efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
915 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
916 efi_status_t efi_set_load_options(efi_handle_t handle,
917 efi_uintn_t load_options_size,
919 efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
922 * struct efi_image_regions - A list of memory regions
924 * @max: Maximum number of regions
925 * @num: Number of regions
926 * @reg: array of regions
928 struct efi_image_regions {
931 struct image_region reg[];
935 * struct efi_sig_data - A decoded data of struct efi_signature_data
937 * This structure represents an internal form of signature in
938 * signature database. A listed list may represent a signature list.
940 * @next: Pointer to next entry
941 * @owner: Signature owner
942 * @data: Pointer to signature data
943 * @size: Size of signature data
945 struct efi_sig_data {
946 struct efi_sig_data *next;
953 * struct efi_signature_store - A decoded data of signature database
955 * This structure represents an internal form of signature database.
957 * @next: Pointer to next entry
958 * @sig_type: Signature type
959 * @sig_data_list: Pointer to signature list
961 struct efi_signature_store {
962 struct efi_signature_store *next;
964 struct efi_sig_data *sig_data_list;
967 struct x509_certificate;
968 struct pkcs7_message;
971 * struct eficonfig_media_boot_option - boot option for (removable) media device
973 * This structure is used to enumerate possible boot option
975 * @lo: Serialized load option data
976 * @size: Size of serialized load option data
977 * @exist: Flag to indicate the load option already exists
978 * in Non-volatile load option
980 struct eficonfig_media_boot_option {
986 bool efi_hash_regions(struct image_region *regs, int count,
987 void **hash, const char *hash_algo, int *len);
988 bool efi_signature_lookup_digest(struct efi_image_regions *regs,
989 struct efi_signature_store *db,
991 bool efi_signature_verify(struct efi_image_regions *regs,
992 struct pkcs7_message *msg,
993 struct efi_signature_store *db,
994 struct efi_signature_store *dbx);
995 static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
996 struct pkcs7_message *msg,
997 struct efi_signature_store *db)
999 return efi_signature_verify(regs, msg, db, NULL);
1001 bool efi_signature_check_signers(struct pkcs7_message *msg,
1002 struct efi_signature_store *dbx);
1004 efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1005 const void *start, const void *end,
1008 void efi_sigstore_free(struct efi_signature_store *sigstore);
1009 struct efi_signature_store *efi_build_signature_store(void *sig_list,
1011 struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
1013 bool efi_secure_boot_enabled(void);
1015 bool efi_capsule_auth_enabled(void);
1017 void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1019 bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1020 WIN_CERTIFICATE **auth, size_t *auth_len);
1022 struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1026 /* runtime implementation of memcpy() */
1027 void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1029 /* commonly used helper functions */
1030 u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1031 unsigned int index);
1032 efi_string_t efi_convert_string(const char *str);
1034 extern const struct efi_firmware_management_protocol efi_fmp_fit;
1035 extern const struct efi_firmware_management_protocol efi_fmp_raw;
1037 /* Capsule update */
1038 efi_status_t EFIAPI efi_update_capsule(
1039 struct efi_capsule_header **capsule_header_array,
1040 efi_uintn_t capsule_count,
1041 u64 scatter_gather_list);
1042 efi_status_t EFIAPI efi_query_capsule_caps(
1043 struct efi_capsule_header **capsule_header_array,
1044 efi_uintn_t capsule_count,
1045 u64 *maximum_capsule_size,
1048 efi_status_t efi_capsule_authenticate(const void *capsule,
1049 efi_uintn_t capsule_size,
1050 void **image, efi_uintn_t *image_size);
1052 #define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
1055 * struct efi_fw_image - Information on firmware images updatable through
1058 * This structure gives information about the firmware images on the platform
1059 * which can be updated through the capsule update mechanism
1061 * @image_type_id: Image GUID. Same value is to be used in the capsule
1062 * @fw_name: Name of the firmware image
1063 * @image_index: Image Index, same as value passed to SetImage FMP
1066 struct efi_fw_image {
1067 efi_guid_t image_type_id;
1073 * struct efi_capsule_update_info - Information needed for capsule updates
1075 * This structure provides information needed for performing firmware
1076 * updates. The structure needs to be initialised per platform, for all
1077 * platforms which enable capsule updates
1079 * @dfu_string: String used to populate dfu_alt_info
1080 * @images: Pointer to an array of updatable images
1082 struct efi_capsule_update_info {
1083 const char *dfu_string;
1084 struct efi_fw_image *images;
1087 extern struct efi_capsule_update_info update_info;
1088 extern u8 num_image_type_guids;
1091 * Install the ESRT system table.
1093 * Return: status code
1095 efi_status_t efi_esrt_register(void);
1098 * efi_ecpt_register() - Install the ECPT system table.
1100 * Return: status code
1102 efi_status_t efi_ecpt_register(void);
1105 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1106 * present in the system.
1107 * If an ESRT already exists, the old ESRT is replaced in the system table.
1108 * The memory of the old ESRT is deallocated.
1111 * - EFI_SUCCESS if the ESRT is correctly created
1112 * - error code otherwise.
1114 efi_status_t efi_esrt_populate(void);
1115 efi_status_t efi_load_capsule_drivers(void);
1117 efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
1119 efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1120 const efi_guid_t *protocol, void *search_key,
1121 efi_uintn_t *no_handles, efi_handle_t **buffer);
1123 efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1124 struct efi_file_handle **root);
1125 efi_status_t efi_file_open_int(struct efi_file_handle *this,
1126 struct efi_file_handle **new_handle,
1127 u16 *file_name, u64 open_mode,
1129 efi_status_t efi_file_close_int(struct efi_file_handle *file);
1130 efi_status_t efi_file_read_int(struct efi_file_handle *this,
1131 efi_uintn_t *buffer_size, void *buffer);
1132 efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1134 typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1135 efi_status_t efi_console_get_u16_string
1136 (struct efi_simple_text_input_protocol *cin,
1137 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1140 efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1143 * efi_add_known_memory() - add memory banks to EFI memory map
1145 * This weak function may be overridden for specific architectures.
1147 void efi_add_known_memory(void);
1149 #endif /* _EFI_LOADER_H */