1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
9 #define _EFI_LOADER_H 1
18 #include <linux/list.h>
19 #include <linux/oid_registry.h>
24 static inline int guidcmp(const void *g1
, const void *g2
)
26 return memcmp(g1
, g2
, sizeof(efi_guid_t
));
29 static inline void *guidcpy(void *dst
, const void *src
)
31 return memcpy(dst
, src
, sizeof(efi_guid_t
));
34 #if CONFIG_IS_ENABLED(EFI_LOADER)
37 * __efi_runtime_data - declares a non-const variable for EFI runtime section
39 * This macro indicates that a variable is non-const and should go into the
40 * EFI runtime section, and thus still be available when the OS is running.
42 * Only use on variables not declared const.
48 * static __efi_runtime_data my_computed_table[256];
50 #define __efi_runtime_data __section(".data.efi_runtime")
53 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
55 * This macro indicates that a variable is read-only (const) and should go into
56 * the EFI runtime section, and thus still be available when the OS is running.
58 * Only use on variables also declared const.
64 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
66 #define __efi_runtime_rodata __section(".rodata.efi_runtime")
69 * __efi_runtime - declares a function for EFI runtime section
71 * This macro indicates that a function should go into the EFI runtime section,
72 * and thus still be available when the OS is running.
78 * static __efi_runtime compute_my_table(void);
80 #define __efi_runtime __section(".text.efi_runtime")
83 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
84 * to make it available at runtime
86 efi_status_t
efi_add_runtime_mmio(void *mmio_ptr
, u64 len
);
89 * Special case handler for error/abort that just tries to dtrt to get
90 * back to u-boot world
92 void efi_restore_gd(void);
94 /* Called by networking code to memorize the dhcp ack package */
95 void efi_net_set_dhcp_ack(void *pkt
, int len
);
96 /* Print information about all loaded images */
97 void efi_print_image_infos(void *pc
);
99 /* Hook at initialization */
100 efi_status_t
efi_launch_capsules(void);
102 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
104 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
105 #define __efi_runtime_data
106 #define __efi_runtime_rodata
107 #define __efi_runtime
108 static inline efi_status_t
efi_add_runtime_mmio(void *mmio_ptr
, u64 len
)
113 /* No loader configured, stub out EFI_ENTRY */
114 static inline void efi_restore_gd(void) { }
115 static inline void efi_net_set_dhcp_ack(void *pkt
, int len
) { }
116 static inline void efi_print_image_infos(void *pc
) { }
117 static inline efi_status_t
efi_launch_capsules(void)
122 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
124 #if CONFIG_IS_ENABLED(EFI_BINARY_EXEC)
125 /* Call this to unset the current device name */
126 void efi_clear_bootdev(void);
127 /* Call this to set the current device name */
128 void efi_set_bootdev(const char *dev
, const char *devnr
, const char *path
,
129 void *buffer
, size_t buffer_size
);
131 static inline void efi_clear_bootdev(void) { }
133 static inline void efi_set_bootdev(const char *dev
, const char *devnr
,
134 const char *path
, void *buffer
,
135 size_t buffer_size
) { }
138 /* Maximum number of configuration tables */
139 #define EFI_MAX_CONFIGURATION_TABLES 16
141 /* GUID used by the root node */
142 #define U_BOOT_GUID \
143 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
144 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
145 /* GUID used as root for blkmap devices */
146 #define U_BOOT_BLKMAP_DEV_GUID \
147 EFI_GUID(0x4cad859d, 0xd644, 0x42ff, \
148 0x87, 0x0b, 0xc0, 0x2e, 0xac, 0x05, 0x58, 0x63)
149 /* GUID used as host device on sandbox */
150 #define U_BOOT_HOST_DEV_GUID \
151 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
152 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
153 /* GUID used as root for virtio devices */
154 #define U_BOOT_VIRTIO_DEV_GUID \
155 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
156 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
158 /* GUID for the auto generated boot menu entry */
159 #define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
160 EFI_GUID(0x8108ac4e, 0x9f11, 0x4d59, \
161 0x85, 0x0e, 0xe2, 0x1a, 0x52, 0x2c, 0x59, 0xb2)
163 /* Use internal device tree when starting UEFI application */
164 #define EFI_FDT_USE_INTERNAL NULL
167 extern efi_handle_t efi_root
;
169 /* Set to EFI_SUCCESS when initialized */
170 extern efi_status_t efi_obj_list_initialized
;
172 /* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
173 extern bool efi_st_keep_devices
;
175 /* EFI system partition */
176 extern struct efi_system_partition
{
177 enum uclass_id uclass_id
;
180 } efi_system_partition
;
182 int __efi_entry_check(void);
183 int __efi_exit_check(void);
184 const char *__efi_nesting(void);
185 const char *__efi_nesting_inc(void);
186 const char *__efi_nesting_dec(void);
189 * Enter the u-boot world from UEFI:
191 #define EFI_ENTRY(format, ...) do { \
192 assert(__efi_entry_check()); \
193 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
194 __func__, ##__VA_ARGS__); \
198 * Exit the u-boot world back to UEFI:
200 #define EFI_EXIT(ret) ({ \
201 typeof(ret) _r = ret; \
202 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
203 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
204 assert(__efi_exit_check()); \
209 * Call non-void UEFI function from u-boot and retrieve return value:
211 #define EFI_CALL(exp) ({ \
212 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
213 assert(__efi_exit_check()); \
214 typeof(exp) _r = exp; \
215 assert(__efi_entry_check()); \
216 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
217 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
222 * Call void UEFI function from u-boot:
224 #define EFI_CALL_VOID(exp) do { \
225 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
226 assert(__efi_exit_check()); \
228 assert(__efi_entry_check()); \
229 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
233 * Write an indented message with EFI prefix
235 #define EFI_PRINT(format, ...) ({ \
236 debug("%sEFI: " format, __efi_nesting(), \
240 #ifdef CONFIG_SYS_CACHELINE_SIZE
241 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
243 /* Just use the greatest cache flush alignment requirement I'm aware of */
244 #define EFI_CACHELINE_SIZE 128
247 /* max bootmenu title size for volume selection */
248 #define BOOTMENU_DEVICE_NAME_MAX 16
250 /* Key identifying current memory map */
251 extern efi_uintn_t efi_memory_map_key
;
253 extern struct efi_runtime_services efi_runtime_services
;
254 extern struct efi_system_table systab
;
256 extern struct efi_simple_text_output_protocol efi_con_out
;
257 extern struct efi_simple_text_input_protocol efi_con_in
;
258 extern struct efi_console_control_protocol efi_console_control
;
259 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text
;
260 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
261 extern const struct efi_device_path_utilities_protocol
262 efi_device_path_utilities
;
263 /* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
264 extern const struct efi_unicode_collation_protocol
265 efi_unicode_collation_protocol2
;
266 extern const struct efi_hii_config_routing_protocol efi_hii_config_routing
;
267 extern const struct efi_hii_config_access_protocol efi_hii_config_access
;
268 extern const struct efi_hii_database_protocol efi_hii_database
;
269 extern const struct efi_hii_string_protocol efi_hii_string
;
271 uint16_t *efi_dp_str(struct efi_device_path
*dp
);
273 /* GUID for the auto generated boot menu entry */
274 extern const efi_guid_t efi_guid_bootmenu_auto_generated
;
276 /* GUID of the U-Boot root node */
277 extern const efi_guid_t efi_u_boot_guid
;
278 #ifdef CONFIG_SANDBOX
279 /* GUID of U-Boot host device on sandbox */
280 extern const efi_guid_t efi_guid_host_dev
;
282 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
283 extern const efi_guid_t efi_block_io_guid
;
284 extern const efi_guid_t efi_global_variable_guid
;
285 extern const efi_guid_t efi_guid_console_control
;
286 extern const efi_guid_t efi_guid_device_path
;
287 /* GUID of the EFI system partition */
288 extern const efi_guid_t efi_system_partition_guid
;
289 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
290 extern const efi_guid_t efi_guid_driver_binding_protocol
;
291 /* event group ExitBootServices() invoked */
292 extern const efi_guid_t efi_guid_event_group_exit_boot_services
;
293 /* event group SetVirtualAddressMap() invoked */
294 extern const efi_guid_t efi_guid_event_group_virtual_address_change
;
295 /* event group memory map changed */
296 extern const efi_guid_t efi_guid_event_group_memory_map_change
;
297 /* event group boot manager about to boot */
298 extern const efi_guid_t efi_guid_event_group_ready_to_boot
;
299 /* event group ResetSystem() invoked (before ExitBootServices) */
300 extern const efi_guid_t efi_guid_event_group_reset_system
;
301 /* event group return to efibootmgr */
302 extern const efi_guid_t efi_guid_event_group_return_to_efibootmgr
;
303 /* GUID of the device tree table */
304 extern const efi_guid_t efi_guid_fdt
;
305 extern const efi_guid_t efi_guid_loaded_image
;
306 extern const efi_guid_t efi_guid_loaded_image_device_path
;
307 extern const efi_guid_t efi_guid_device_path_to_text_protocol
;
308 extern const efi_guid_t efi_simple_file_system_protocol_guid
;
309 extern const efi_guid_t efi_file_info_guid
;
310 /* GUID for file system information */
311 extern const efi_guid_t efi_file_system_info_guid
;
312 extern const efi_guid_t efi_guid_device_path_utilities_protocol
;
313 /* GUID of the deprecated Unicode collation protocol */
314 extern const efi_guid_t efi_guid_unicode_collation_protocol
;
315 /* GUIDs of the Load File and Load File2 protocol */
316 extern const efi_guid_t efi_guid_load_file_protocol
;
317 extern const efi_guid_t efi_guid_load_file2_protocol
;
318 /* GUID of the Unicode collation protocol */
319 extern const efi_guid_t efi_guid_unicode_collation_protocol2
;
320 extern const efi_guid_t efi_guid_hii_config_routing_protocol
;
321 extern const efi_guid_t efi_guid_hii_config_access_protocol
;
322 extern const efi_guid_t efi_guid_hii_database_protocol
;
323 extern const efi_guid_t efi_guid_hii_string_protocol
;
324 /* GUIDs for authentication */
325 extern const efi_guid_t efi_guid_image_security_database
;
326 extern const efi_guid_t efi_guid_sha256
;
327 extern const efi_guid_t efi_guid_cert_x509
;
328 extern const efi_guid_t efi_guid_cert_x509_sha256
;
329 extern const efi_guid_t efi_guid_cert_x509_sha384
;
330 extern const efi_guid_t efi_guid_cert_x509_sha512
;
331 extern const efi_guid_t efi_guid_cert_type_pkcs7
;
333 /* GUID of RNG protocol */
334 extern const efi_guid_t efi_guid_rng_protocol
;
335 /* GUID of capsule update result */
336 extern const efi_guid_t efi_guid_capsule_report
;
337 /* GUID of firmware management protocol */
338 extern const efi_guid_t efi_guid_firmware_management_protocol
;
339 /* GUID for the ESRT */
340 extern const efi_guid_t efi_esrt_guid
;
341 /* GUID of the SMBIOS table */
342 extern const efi_guid_t smbios_guid
;
343 extern const efi_guid_t smbios3_guid
;
345 extern const efi_guid_t efi_guid_text_input_protocol
;
346 extern const efi_guid_t efi_guid_text_output_protocol
;
348 extern char __efi_runtime_start
[], __efi_runtime_stop
[];
349 extern char __efi_runtime_rel_start
[], __efi_runtime_rel_stop
[];
352 * struct efi_open_protocol_info_item - open protocol info item
354 * When a protocol is opened a open protocol info entry is created.
355 * These are maintained in a list.
357 * @link: link to the list of open protocol info entries of a protocol
358 * @info: information about the opening of a protocol
360 struct efi_open_protocol_info_item
{
361 struct list_head link
;
362 struct efi_open_protocol_info_entry info
;
366 * struct efi_handler - single protocol interface of a handle
368 * When the UEFI payload wants to open a protocol on an object to get its
369 * interface (usually a struct with callback functions), this struct maps the
370 * protocol GUID to the respective protocol interface
372 * @link: link to the list of protocols of a handle
373 * @guid: GUID of the protocol
374 * @protocol_interface: protocol interface
375 * @open_infos: link to the list of open protocol info items
378 struct list_head link
;
379 const efi_guid_t guid
;
380 void *protocol_interface
;
381 struct list_head open_infos
;
385 * enum efi_object_type - type of EFI object
387 * In UnloadImage we must be able to identify if the handle relates to a
390 enum efi_object_type
{
391 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
392 EFI_OBJECT_TYPE_UNDEFINED
= 0,
393 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
394 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE
,
395 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
396 EFI_OBJECT_TYPE_LOADED_IMAGE
,
397 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
398 EFI_OBJECT_TYPE_STARTED_IMAGE
,
402 * struct efi_object - dereferenced EFI handle
404 * @link: pointers to put the handle into a linked list
405 * @protocols: linked list with the protocol interfaces installed on this
407 * @type: image type if the handle relates to an image
408 * @dev: pointer to the DM device which is associated with this EFI handle
410 * UEFI offers a flexible and expandable object model. The objects in the UEFI
411 * API are devices, drivers, and loaded images. struct efi_object is our storage
412 * structure for these objects.
414 * When including this structure into a larger structure always put it first so
415 * that when deleting a handle the whole encompassing structure can be freed.
417 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
418 * has been created for such pointers.
421 /* Every UEFI object is part of a global object list */
422 struct list_head link
;
423 /* The list of protocols */
424 struct list_head protocols
;
425 enum efi_object_type type
;
429 enum efi_image_auth_status
{
430 EFI_IMAGE_AUTH_FAILED
= 0,
431 EFI_IMAGE_AUTH_PASSED
,
435 * struct efi_loaded_image_obj - handle of a loaded image
437 * @header: EFI object header
438 * @exit_status: exit status passed to Exit()
439 * @exit_data_size: exit data size passed to Exit()
440 * @exit_data: exit data passed to Exit()
441 * @exit_jmp: long jump buffer for returning from started image
442 * @entry: entry address of the relocated image
443 * @image_type: indicates if the image is an applicition or a driver
444 * @auth_status: indicates if the image is authenticated
446 struct efi_loaded_image_obj
{
447 struct efi_object header
;
448 efi_status_t
*exit_status
;
449 efi_uintn_t
*exit_data_size
;
451 struct jmp_buf_data
*exit_jmp
;
452 EFIAPI
efi_status_t (*entry
)(efi_handle_t image_handle
,
453 struct efi_system_table
*st
);
455 enum efi_image_auth_status auth_status
;
461 * @link: Link to list of all events
462 * @queue_link: Link to the list of queued events
463 * @type: Type of event, see efi_create_event
464 * @notify_tpl: Task priority level of notifications
465 * @notify_function: Function to call when the event is triggered
466 * @notify_context: Data to be passed to the notify function
467 * @group: Event group
468 * @trigger_time: Period of the timer
469 * @trigger_next: Next time to trigger the timer
470 * @trigger_type: Type of timer, see efi_set_timer
471 * @is_signaled: The event occurred. The event is in the signaled state.
474 struct list_head link
;
475 struct list_head queue_link
;
477 efi_uintn_t notify_tpl
;
478 void (EFIAPI
*notify_function
)(struct efi_event
*event
, void *context
);
479 void *notify_context
;
480 const efi_guid_t
*group
;
483 enum efi_timer_delay trigger_type
;
487 /* This list contains all UEFI objects we know of */
488 extern struct list_head efi_obj_list
;
489 /* List of all events */
490 extern struct list_head efi_events
;
493 * struct efi_protocol_notification - handle for notified protocol
495 * When a protocol interface is installed for which an event was registered with
496 * the RegisterProtocolNotify() service this structure is used to hold the
497 * handle on which the protocol interface was installed.
499 * @link: link to list of all handles notified for this event
500 * @handle: handle on which the notified protocol interface was installed
502 struct efi_protocol_notification
{
503 struct list_head link
;
508 * struct efi_register_notify_event - event registered by
509 * RegisterProtocolNotify()
511 * The address of this structure serves as registration value.
513 * @link: link to list of all registered events
514 * @event: registered event. The same event may registered for multiple
516 * @protocol: protocol for which the event is registered
517 * @handles: linked list of all handles on which the notified protocol was
520 struct efi_register_notify_event
{
521 struct list_head link
;
522 struct efi_event
*event
;
524 struct list_head handles
;
527 /* called at pre-initialization */
528 int efi_init_early(void);
529 /* Initialize efi execution environment */
530 efi_status_t
efi_init_obj_list(void);
531 /* Append new boot option in BootOrder variable */
532 efi_status_t
efi_bootmgr_append_bootorder(u16 index
);
533 /* Get unused "Boot####" index */
534 efi_status_t
efi_bootmgr_get_unused_bootoption(u16
*buf
,
535 efi_uintn_t buf_size
, u32
*index
);
536 /* Generate the media device boot option */
537 efi_status_t
efi_bootmgr_update_media_device_boot_option(void);
538 /* Delete selected boot option */
539 efi_status_t
efi_bootmgr_delete_boot_option(u16 boot_index
);
540 /* Invoke EFI boot manager */
541 efi_status_t
efi_bootmgr_run(void *fdt
);
542 /* search the boot option index in BootOrder */
543 bool efi_search_bootorder(u16
*bootorder
, efi_uintn_t num
, u32 target
, u32
*index
);
544 /* Set up console modes */
545 void efi_setup_console_size(void);
546 /* Set up load options from environment variable */
547 efi_status_t
efi_env_set_load_options(efi_handle_t handle
, const char *env_var
,
549 /* Get EFI configuration table */
550 void *efi_get_configuration_table(const efi_guid_t
*guid
);
551 /* Install device tree */
552 efi_status_t
efi_install_fdt(void *fdt
);
553 /* Execute loaded UEFI image */
554 efi_status_t
do_bootefi_exec(efi_handle_t handle
, void *load_options
);
555 /* Run loaded UEFI image with given fdt */
556 efi_status_t
efi_binary_run(void *image
, size_t size
, void *fdt
);
557 /* Initialize variable services */
558 efi_status_t
efi_init_variables(void);
559 /* Notify ExitBootServices() is called */
560 void efi_variables_boot_exit_notify(void);
561 efi_status_t
efi_tcg2_notify_exit_boot_services_failed(void);
562 /* Measure efi application invocation */
563 efi_status_t
efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj
*handle
);
564 /* Measure efi application exit */
565 efi_status_t
efi_tcg2_measure_efi_app_exit(void);
567 efi_status_t
efi_tcg2_measure_dtb(void *dtb
);
568 /* Called by bootefi to initialize root node */
569 efi_status_t
efi_root_node_register(void);
570 /* Called by bootefi to initialize runtime */
571 efi_status_t
efi_initialize_system_table(void);
572 /* efi_runtime_detach() - detach unimplemented runtime functions */
573 void efi_runtime_detach(void);
574 /* efi_convert_pointer() - convert pointer to virtual address */
575 efi_status_t EFIAPI
efi_convert_pointer(efi_uintn_t debug_disposition
,
577 /* Carve out DT reserved memory ranges */
578 void efi_carve_out_dt_rsv(void *fdt
);
579 /* Purge unused kaslr-seed */
580 void efi_try_purge_kaslr_seed(void *fdt
);
581 /* Called by bootefi to make console interface available */
582 efi_status_t
efi_console_register(void);
583 /* Called by efi_init_obj_list() to proble all block devices */
584 efi_status_t
efi_disks_register(void);
585 /* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
586 efi_status_t
efi_rng_register(void);
587 /* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
588 efi_status_t
efi_tcg2_register(void);
589 /* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
590 efi_status_t
efi_riscv_register(void);
591 /* Called by efi_init_obj_list() to do initial measurement */
592 efi_status_t
efi_tcg2_do_initial_measurement(void);
593 /* measure the pe-coff image, extend PCR and add Event Log */
594 efi_status_t
tcg2_measure_pe_image(void *efi
, u64 efi_size
,
595 struct efi_loaded_image_obj
*handle
,
596 struct efi_loaded_image
*loaded_image_info
);
597 /* Create handles and protocols for the partitions of a block device */
598 int efi_disk_create_partitions(efi_handle_t parent
, struct blk_desc
*desc
,
599 const char *uclass_idname
, int diskid
,
600 const char *pdevname
);
601 /* Called by bootefi to make GOP (graphical) interface available */
602 efi_status_t
efi_gop_register(void);
603 /* Called by bootefi to make the network interface available */
604 efi_status_t
efi_net_register(void);
605 /* Called by bootefi to make the watchdog available */
606 efi_status_t
efi_watchdog_register(void);
607 efi_status_t
efi_initrd_register(void);
608 efi_status_t
efi_initrd_deregister(void);
609 /* Called by bootefi to make SMBIOS tables available */
611 * efi_acpi_register() - write out ACPI tables
613 * Called by bootefi to make ACPI tables available
615 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
617 efi_status_t
efi_acpi_register(void);
619 * efi_smbios_register() - write out SMBIOS tables
621 * Called by bootefi to make SMBIOS tables available
623 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
625 efi_status_t
efi_smbios_register(void);
627 struct efi_simple_file_system_protocol
*
628 efi_fs_from_path(struct efi_device_path
*fp
);
630 /* Called by efi_set_watchdog_timer to reset the timer */
631 efi_status_t
efi_set_watchdog(unsigned long timeout
);
633 /* Called from places to check whether a timer expired */
634 void efi_timer_check(void);
635 /* Check if a buffer contains a PE-COFF image */
636 efi_status_t
efi_check_pe(void *buffer
, size_t size
, void **nt_header
);
637 /* PE loader implementation */
638 efi_status_t
efi_load_pe(struct efi_loaded_image_obj
*handle
,
639 void *efi
, size_t efi_size
,
640 struct efi_loaded_image
*loaded_image_info
);
641 /* Called once to store the pristine gd pointer */
642 void efi_save_gd(void);
643 /* Call this to relocate the runtime section to an address space */
644 void efi_runtime_relocate(ulong offset
, struct efi_mem_desc
*map
);
645 /* Call this to get image parameters */
646 void efi_get_image_parameters(void **img_addr
, size_t *img_size
);
647 /* Add a new object to the object list. */
648 void efi_add_handle(efi_handle_t obj
);
650 efi_status_t
efi_create_handle(efi_handle_t
*handle
);
652 efi_status_t
efi_delete_handle(efi_handle_t obj
);
653 /* Call this to validate a handle and find the EFI object for it */
654 struct efi_object
*efi_search_obj(const efi_handle_t handle
);
655 /* Locate device_path handle */
656 efi_status_t EFIAPI
efi_locate_device_path(const efi_guid_t
*protocol
,
657 struct efi_device_path
**device_path
,
658 efi_handle_t
*device
);
660 efi_status_t EFIAPI
efi_load_image(bool boot_policy
,
661 efi_handle_t parent_image
,
662 struct efi_device_path
*file_path
,
664 efi_uintn_t source_size
,
665 efi_handle_t
*image_handle
);
667 efi_status_t EFIAPI
efi_start_image(efi_handle_t image_handle
,
668 efi_uintn_t
*exit_data_size
,
671 efi_status_t EFIAPI
efi_unload_image(efi_handle_t image_handle
);
672 /* Find a protocol on a handle */
673 efi_status_t
efi_search_protocol(const efi_handle_t handle
,
674 const efi_guid_t
*protocol_guid
,
675 struct efi_handler
**handler
);
676 /* Install new protocol on a handle */
677 efi_status_t
efi_add_protocol(const efi_handle_t handle
,
678 const efi_guid_t
*protocol
,
679 void *protocol_interface
);
681 efi_status_t
efi_protocol_open(struct efi_handler
*handler
,
682 void **protocol_interface
, void *agent_handle
,
683 void *controller_handle
, uint32_t attributes
);
685 /* Install multiple protocol interfaces */
687 efi_install_multiple_protocol_interfaces(efi_handle_t
*handle
, ...);
689 efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle
, ...);
690 /* Get handles that support a given protocol */
691 efi_status_t EFIAPI
efi_locate_handle_buffer(
692 enum efi_locate_search_type search_type
,
693 const efi_guid_t
*protocol
, void *search_key
,
694 efi_uintn_t
*no_handles
, efi_handle_t
**buffer
);
695 /* Close a previously opened protocol interface */
696 efi_status_t
efi_close_protocol(efi_handle_t handle
, const efi_guid_t
*protocol
,
697 efi_handle_t agent_handle
,
698 efi_handle_t controller_handle
);
699 /* Open a protocol interface */
700 efi_status_t EFIAPI
efi_handle_protocol(efi_handle_t handle
,
701 const efi_guid_t
*protocol
,
702 void **protocol_interface
);
703 /* Call this to create an event */
704 efi_status_t
efi_create_event(uint32_t type
, efi_uintn_t notify_tpl
,
705 void (EFIAPI
*notify_function
) (
706 struct efi_event
*event
,
708 void *notify_context
, const efi_guid_t
*group
,
709 struct efi_event
**event
);
710 /* Call this to set a timer */
711 efi_status_t
efi_set_timer(struct efi_event
*event
, enum efi_timer_delay type
,
712 uint64_t trigger_time
);
713 /* Call this to signal an event */
714 void efi_signal_event(struct efi_event
*event
);
716 /* return true if the device is removable */
717 bool efi_disk_is_removable(efi_handle_t handle
);
720 * efi_create_simple_file_system() - create simple file system protocol
722 * Create a simple file system protocol for a partition.
724 * @desc: block device descriptor
725 * @part: partition number
727 * @fsp: simple file system protocol
728 * Return: status code
731 efi_create_simple_file_system(struct blk_desc
*desc
, int part
,
732 struct efi_device_path
*dp
,
733 struct efi_simple_file_system_protocol
**fsp
);
735 /* open file from device-path: */
736 struct efi_file_handle
*efi_file_from_path(struct efi_device_path
*fp
);
738 /* Registers a callback function for a notification event. */
739 efi_status_t EFIAPI
efi_register_protocol_notify(const efi_guid_t
*protocol
,
740 struct efi_event
*event
,
741 void **registration
);
742 efi_status_t
efi_file_size(struct efi_file_handle
*fh
, efi_uintn_t
*size
);
744 /* get a device path from a Boot#### option */
745 struct efi_device_path
*efi_get_dp_from_boot(const efi_guid_t guid
);
747 /* get len, string (used in u-boot crypto from a guid */
748 const char *guid_to_sha_str(const efi_guid_t
*guid
);
749 int algo_to_len(const char *algo
);
751 int efi_link_dev(efi_handle_t handle
, struct udevice
*dev
);
752 int efi_unlink_dev(efi_handle_t handle
);
753 bool efi_varname_is_load_option(u16
*var_name16
, int *index
);
754 efi_status_t
efi_next_variable_name(efi_uintn_t
*size
, u16
**buf
,
758 * efi_size_in_pages() - convert size in bytes to size in pages
760 * This macro returns the number of EFI memory pages required to hold 'size'
763 * @size: size in bytes
764 * Return: size in pages
766 #define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
767 /* Allocate boot service data pool memory */
768 void *efi_alloc(size_t len
);
769 /* Allocate pages on the specified alignment */
770 void *efi_alloc_aligned_pages(u64 len
, int memory_type
, size_t align
);
771 /* More specific EFI memory allocator, called by EFI payloads */
772 efi_status_t
efi_allocate_pages(enum efi_allocate_type type
,
773 enum efi_memory_type memory_type
,
774 efi_uintn_t pages
, uint64_t *memory
);
775 /* EFI memory free function. */
776 efi_status_t
efi_free_pages(uint64_t memory
, efi_uintn_t pages
);
777 /* EFI memory allocator for small allocations */
778 efi_status_t
efi_allocate_pool(enum efi_memory_type pool_type
,
779 efi_uintn_t size
, void **buffer
);
780 /* EFI pool memory free function. */
781 efi_status_t
efi_free_pool(void *buffer
);
782 /* Allocate and retrieve EFI memory map */
783 efi_status_t
efi_get_memory_map_alloc(efi_uintn_t
*map_size
,
784 struct efi_mem_desc
**memory_map
);
785 /* Returns the EFI memory map */
786 efi_status_t
efi_get_memory_map(efi_uintn_t
*memory_map_size
,
787 struct efi_mem_desc
*memory_map
,
788 efi_uintn_t
*map_key
,
789 efi_uintn_t
*descriptor_size
,
790 uint32_t *descriptor_version
);
791 /* Adds a range into the EFI memory map */
792 efi_status_t
efi_add_memory_map(u64 start
, u64 size
, int memory_type
);
793 /* Adds a conventional range into the EFI memory map */
794 efi_status_t
efi_add_conventional_memory_map(u64 ram_start
, u64 ram_end
,
797 /* Called by board init to initialize the EFI drivers */
798 efi_status_t
efi_driver_init(void);
799 /* Called when a block device is added */
800 int efi_disk_probe(void *ctx
, struct event
*event
);
801 /* Called when a block device is removed */
802 int efi_disk_remove(void *ctx
, struct event
*event
);
803 /* Called by board init to initialize the EFI memory map */
804 int efi_memory_init(void);
805 /* Adds new or overrides configuration table entry to the system table */
806 efi_status_t
efi_install_configuration_table(const efi_guid_t
*guid
, void *table
);
807 /* Sets up a loaded image */
808 efi_status_t
efi_setup_loaded_image(struct efi_device_path
*device_path
,
809 struct efi_device_path
*file_path
,
810 struct efi_loaded_image_obj
**handle_ptr
,
811 struct efi_loaded_image
**info_ptr
);
813 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
814 extern void *efi_bounce_buffer
;
815 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
818 /* shorten device path */
819 struct efi_device_path
*efi_dp_shorten(struct efi_device_path
*dp
);
820 struct efi_device_path
*efi_dp_next(const struct efi_device_path
*dp
);
821 int efi_dp_match(const struct efi_device_path
*a
,
822 const struct efi_device_path
*b
);
823 efi_handle_t
efi_dp_find_obj(struct efi_device_path
*dp
,
824 const efi_guid_t
*guid
,
825 struct efi_device_path
**rem
);
826 /* get size of the first device path instance excluding end node */
827 efi_uintn_t
efi_dp_instance_size(const struct efi_device_path
*dp
);
828 /* size of multi-instance device path excluding end node */
829 efi_uintn_t
efi_dp_size(const struct efi_device_path
*dp
);
830 struct efi_device_path
*efi_dp_dup(const struct efi_device_path
*dp
);
831 struct efi_device_path
*efi_dp_append_node(const struct efi_device_path
*dp
,
832 const struct efi_device_path
*node
);
833 /* Create a device path node of given type, sub-type, length */
834 struct efi_device_path
*efi_dp_create_device_node(const u8 type
,
837 /* Append device path instance */
838 struct efi_device_path
*efi_dp_append_instance(
839 const struct efi_device_path
*dp
,
840 const struct efi_device_path
*dpi
);
841 /* Get next device path instance */
842 struct efi_device_path
*efi_dp_get_next_instance(struct efi_device_path
**dp
,
844 /* Check if a device path contains muliple instances */
845 bool efi_dp_is_multi_instance(const struct efi_device_path
*dp
);
847 struct efi_device_path
*efi_dp_from_part(struct blk_desc
*desc
, int part
);
848 /* Create a device node for a block device partition. */
849 struct efi_device_path
*efi_dp_part_node(struct blk_desc
*desc
, int part
);
850 struct efi_device_path
*efi_dp_from_file(const struct efi_device_path
*dp
,
852 struct efi_device_path
*efi_dp_from_eth(void);
853 struct efi_device_path
*efi_dp_from_mem(uint32_t mem_type
,
854 uint64_t start_address
,
855 uint64_t end_address
);
856 /* Determine the last device path node that is not the end node. */
857 const struct efi_device_path
*efi_dp_last_node(
858 const struct efi_device_path
*dp
);
859 efi_status_t
efi_dp_split_file_path(struct efi_device_path
*full_path
,
860 struct efi_device_path
**device_path
,
861 struct efi_device_path
**file_path
);
862 struct efi_device_path
*efi_dp_from_uart(void);
863 efi_status_t
efi_dp_from_name(const char *dev
, const char *devnr
,
865 struct efi_device_path
**device
,
866 struct efi_device_path
**file
);
867 ssize_t
efi_dp_check_length(const struct efi_device_path
*dp
,
868 const size_t maxlen
);
870 #define EFI_DP_TYPE(_dp, _type, _subtype) \
871 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
872 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
874 /* template END node: */
875 extern const struct efi_device_path END
;
877 /* Indicate supported runtime services */
878 efi_status_t
efi_init_runtime_supported(void);
880 /* Update CRC32 in table header */
881 void __efi_runtime
efi_update_table_header_crc32(struct efi_table_hdr
*table
);
883 /* Boards may provide the functions below to implement RTS functionality */
885 void __efi_runtime EFIAPI
efi_reset_system(
886 enum efi_reset_type reset_type
,
887 efi_status_t reset_status
,
888 unsigned long data_size
, void *reset_data
);
890 /* Architecture specific initialization of the EFI subsystem */
891 efi_status_t
efi_reset_system_init(void);
893 efi_status_t __efi_runtime EFIAPI
efi_get_time(
894 struct efi_time
*time
,
895 struct efi_time_cap
*capabilities
);
897 efi_status_t __efi_runtime EFIAPI
efi_set_time(struct efi_time
*time
);
900 * Entry point for the tests of the EFI API.
901 * It is called by 'bootefi selftest'
903 efi_status_t EFIAPI
efi_selftest(efi_handle_t image_handle
,
904 struct efi_system_table
*systab
);
906 efi_status_t EFIAPI
efi_get_variable(u16
*variable_name
,
907 const efi_guid_t
*vendor
, u32
*attributes
,
908 efi_uintn_t
*data_size
, void *data
);
909 efi_status_t EFIAPI
efi_get_next_variable_name(efi_uintn_t
*variable_name_size
,
912 efi_status_t EFIAPI
efi_set_variable(u16
*variable_name
,
913 const efi_guid_t
*vendor
, u32 attributes
,
914 efi_uintn_t data_size
, const void *data
);
916 efi_status_t EFIAPI
efi_query_variable_info(
917 u32 attributes
, u64
*maximum_variable_storage_size
,
918 u64
*remaining_variable_storage_size
,
919 u64
*maximum_variable_size
);
921 void *efi_get_var(const u16
*name
, const efi_guid_t
*vendor
, efi_uintn_t
*size
);
924 * See section 3.1.3 in the v2.7 UEFI spec for more details on
925 * the layout of EFI_LOAD_OPTION. In short it is:
927 * typedef struct _EFI_LOAD_OPTION {
929 * UINT16 FilePathListLength;
930 * // CHAR16 Description[]; <-- variable length, NULL terminated
931 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
932 * <-- FilePathListLength bytes
933 * // UINT8 OptionalData[];
936 struct efi_load_option
{
938 u16 file_path_length
;
940 struct efi_device_path
*file_path
;
941 const u8
*optional_data
;
944 struct efi_device_path
*efi_dp_from_lo(struct efi_load_option
*lo
,
945 const efi_guid_t
*guid
);
946 struct efi_device_path
*efi_dp_concat(const struct efi_device_path
*dp1
,
947 const struct efi_device_path
*dp2
,
948 bool split_end_node
);
949 struct efi_device_path
*search_gpt_dp_node(struct efi_device_path
*device_path
);
950 efi_status_t
efi_deserialize_load_option(struct efi_load_option
*lo
, u8
*data
,
952 unsigned long efi_serialize_load_option(struct efi_load_option
*lo
, u8
**data
);
953 efi_status_t
efi_set_load_options(efi_handle_t handle
,
954 efi_uintn_t load_options_size
,
956 efi_status_t
efi_bootmgr_load(efi_handle_t
*handle
, void **load_options
);
959 * struct efi_image_regions - A list of memory regions
961 * @max: Maximum number of regions
962 * @num: Number of regions
963 * @reg: array of regions
965 struct efi_image_regions
{
968 struct image_region reg
[];
972 * struct efi_sig_data - A decoded data of struct efi_signature_data
974 * This structure represents an internal form of signature in
975 * signature database. A listed list may represent a signature list.
977 * @next: Pointer to next entry
978 * @owner: Signature owner
979 * @data: Pointer to signature data
980 * @size: Size of signature data
982 struct efi_sig_data
{
983 struct efi_sig_data
*next
;
990 * struct efi_signature_store - A decoded data of signature database
992 * This structure represents an internal form of signature database.
994 * @next: Pointer to next entry
995 * @sig_type: Signature type
996 * @sig_data_list: Pointer to signature list
998 struct efi_signature_store
{
999 struct efi_signature_store
*next
;
1000 efi_guid_t sig_type
;
1001 struct efi_sig_data
*sig_data_list
;
1004 struct x509_certificate
;
1005 struct pkcs7_message
;
1008 * struct eficonfig_media_boot_option - boot option for (removable) media device
1010 * This structure is used to enumerate possible boot option
1012 * @lo: Serialized load option data
1013 * @size: Size of serialized load option data
1014 * @exist: Flag to indicate the load option already exists
1015 * in Non-volatile load option
1017 struct eficonfig_media_boot_option
{
1023 bool efi_hash_regions(struct image_region
*regs
, int count
,
1024 void **hash
, const char *hash_algo
, int *len
);
1025 bool efi_signature_lookup_digest(struct efi_image_regions
*regs
,
1026 struct efi_signature_store
*db
,
1028 bool efi_signature_verify(struct efi_image_regions
*regs
,
1029 struct pkcs7_message
*msg
,
1030 struct efi_signature_store
*db
,
1031 struct efi_signature_store
*dbx
);
1032 static inline bool efi_signature_verify_one(struct efi_image_regions
*regs
,
1033 struct pkcs7_message
*msg
,
1034 struct efi_signature_store
*db
)
1036 return efi_signature_verify(regs
, msg
, db
, NULL
);
1038 bool efi_signature_check_signers(struct pkcs7_message
*msg
,
1039 struct efi_signature_store
*dbx
);
1041 efi_status_t
efi_image_region_add(struct efi_image_regions
*regs
,
1042 const void *start
, const void *end
,
1045 void efi_sigstore_free(struct efi_signature_store
*sigstore
);
1046 struct efi_signature_store
*efi_build_signature_store(void *sig_list
,
1048 struct efi_signature_store
*efi_sigstore_parse_sigdb(u16
*name
);
1050 bool efi_secure_boot_enabled(void);
1052 bool efi_capsule_auth_enabled(void);
1054 void *efi_prepare_aligned_image(void *efi
, u64
*efi_size
);
1056 bool efi_image_parse(void *efi
, size_t len
, struct efi_image_regions
**regp
,
1057 WIN_CERTIFICATE
**auth
, size_t *auth_len
);
1059 struct pkcs7_message
*efi_parse_pkcs7_header(const void *buf
,
1063 /* runtime implementation of memcpy() */
1064 void efi_memcpy_runtime(void *dest
, const void *src
, size_t n
);
1066 /* commonly used helper functions */
1067 u16
*efi_create_indexed_name(u16
*buffer
, size_t buffer_size
, const char *name
,
1068 unsigned int index
);
1069 efi_string_t
efi_convert_string(const char *str
);
1071 extern const struct efi_firmware_management_protocol efi_fmp_fit
;
1072 extern const struct efi_firmware_management_protocol efi_fmp_raw
;
1074 /* Capsule update */
1075 efi_status_t EFIAPI
efi_update_capsule(
1076 struct efi_capsule_header
**capsule_header_array
,
1077 efi_uintn_t capsule_count
,
1078 u64 scatter_gather_list
);
1079 efi_status_t EFIAPI
efi_query_capsule_caps(
1080 struct efi_capsule_header
**capsule_header_array
,
1081 efi_uintn_t capsule_count
,
1082 u64
*maximum_capsule_size
,
1085 efi_status_t
efi_capsule_authenticate(const void *capsule
,
1086 efi_uintn_t capsule_size
,
1087 void **image
, efi_uintn_t
*image_size
);
1089 #define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
1092 * struct efi_fw_image - Information on firmware images updatable through
1095 * This structure gives information about the firmware images on the platform
1096 * which can be updated through the capsule update mechanism
1098 * @image_type_id: Image GUID. Same value is to be used in the capsule
1099 * @fw_name: Name of the firmware image
1100 * @image_index: Image Index, same as value passed to SetImage FMP
1103 struct efi_fw_image
{
1104 efi_guid_t image_type_id
;
1110 * struct efi_capsule_update_info - Information needed for capsule updates
1112 * This structure provides information needed for performing firmware
1113 * updates. The structure needs to be initialised per platform, for all
1114 * platforms which enable capsule updates
1116 * @dfu_string: String used to populate dfu_alt_info
1117 * @num_images: The number of images array entries
1118 * @images: Pointer to an array of updatable images
1120 struct efi_capsule_update_info
{
1121 const char *dfu_string
;
1123 struct efi_fw_image
*images
;
1126 extern struct efi_capsule_update_info update_info
;
1129 * Install the ESRT system table.
1131 * Return: status code
1133 efi_status_t
efi_esrt_register(void);
1136 * efi_ecpt_register() - Install the ECPT system table.
1138 * Return: status code
1140 efi_status_t
efi_ecpt_register(void);
1143 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1144 * present in the system.
1145 * If an ESRT already exists, the old ESRT is replaced in the system table.
1146 * The memory of the old ESRT is deallocated.
1149 * - EFI_SUCCESS if the ESRT is correctly created
1150 * - error code otherwise.
1152 efi_status_t
efi_esrt_populate(void);
1153 efi_status_t
efi_load_capsule_drivers(void);
1155 efi_status_t
platform_get_eventlog(struct udevice
*dev
, u64
*addr
, u32
*sz
);
1157 efi_status_t
efi_locate_handle_buffer_int(enum efi_locate_search_type search_type
,
1158 const efi_guid_t
*protocol
, void *search_key
,
1159 efi_uintn_t
*no_handles
, efi_handle_t
**buffer
);
1161 efi_status_t
efi_open_volume_int(struct efi_simple_file_system_protocol
*this,
1162 struct efi_file_handle
**root
);
1163 efi_status_t
efi_file_open_int(struct efi_file_handle
*this,
1164 struct efi_file_handle
**new_handle
,
1165 u16
*file_name
, u64 open_mode
,
1167 efi_status_t
efi_file_close_int(struct efi_file_handle
*file
);
1168 efi_status_t
efi_file_read_int(struct efi_file_handle
*this,
1169 efi_uintn_t
*buffer_size
, void *buffer
);
1170 efi_status_t
efi_file_setpos_int(struct efi_file_handle
*file
, u64 pos
);
1172 typedef efi_status_t (*efi_console_filter_func
)(struct efi_input_key
*key
);
1173 efi_status_t efi_console_get_u16_string
1174 (struct efi_simple_text_input_protocol
*cin
,
1175 u16
*buf
, efi_uintn_t count
, efi_console_filter_func filer_func
,
1178 efi_status_t
efi_disk_get_device_name(const efi_handle_t handle
, char *buf
, int size
);
1181 * efi_add_known_memory() - add memory banks to EFI memory map
1183 * This weak function may be overridden for specific architectures.
1185 void efi_add_known_memory(void);
1187 #endif /* _EFI_LOADER_H */