include/efi_loader.h

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