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