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