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