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