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 /* Called by bootefi to make SMBIOS tables available */
 441 /**
 442  * efi_acpi_register() - write out ACPI tables
 443  *
 444  * Called by bootefi to make ACPI tables available
 445  *
 446  * @return 0 if OK, -ENOMEM if no memory is available for the tables
 447  */
 448 efi_status_t efi_acpi_register(void);
 449 /**
 450  * efi_smbios_register() - write out SMBIOS tables
 451  *
 452  * Called by bootefi to make SMBIOS tables available
 453  *
 454  * @return 0 if OK, -ENOMEM if no memory is available for the tables
 455  */
 456 efi_status_t efi_smbios_register(void);
 457
 458 struct efi_simple_file_system_protocol *
 459 efi_fs_from_path(struct efi_device_path *fp);
 460
 461 /* Called by networking code to memorize the dhcp ack package */
 462 void efi_net_set_dhcp_ack(void *pkt, int len);
 463 /* Called by efi_set_watchdog_timer to reset the timer */
 464 efi_status_t efi_set_watchdog(unsigned long timeout);
 465
 466 /* Called from places to check whether a timer expired */
 467 void efi_timer_check(void);
 468 /* Check if a buffer contains a PE-COFF image */
 469 efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
 470 /* PE loader implementation */
 471 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
 472                          void *efi, size_t efi_size,
 473                          struct efi_loaded_image *loaded_image_info);
 474 /* Called once to store the pristine gd pointer */
 475 void efi_save_gd(void);
 476 /* Special case handler for error/abort that just tries to dtrt to get
 477  * back to u-boot world */
 478 void efi_restore_gd(void);
 479 /* Call this to relocate the runtime section to an address space */
 480 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
 481 /* Call this to set the current device name */
 482 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
 483                      void *buffer, size_t buffer_size);
 484 /* Add a new object to the object list. */
 485 void efi_add_handle(efi_handle_t obj);
 486 /* Create handle */
 487 efi_status_t efi_create_handle(efi_handle_t *handle);
 488 /* Delete handle */
 489 void efi_delete_handle(efi_handle_t obj);
 490 /* Call this to validate a handle and find the EFI object for it */
 491 struct efi_object *efi_search_obj(const efi_handle_t handle);
 492 /* Load image */
 493 efi_status_t EFIAPI efi_load_image(bool boot_policy,
 494                                    efi_handle_t parent_image,
 495                                    struct efi_device_path *file_path,
 496                                    void *source_buffer,
 497                                    efi_uintn_t source_size,
 498                                    efi_handle_t *image_handle);
 499 /* Start image */
 500 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
 501                                     efi_uintn_t *exit_data_size,
 502                                     u16 **exit_data);
 503 /* Unload image */
 504 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
 505 /* Find a protocol on a handle */
 506 efi_status_t efi_search_protocol(const efi_handle_t handle,
 507                                  const efi_guid_t *protocol_guid,
 508                                  struct efi_handler **handler);
 509 /* Install new protocol on a handle */
 510 efi_status_t efi_add_protocol(const efi_handle_t handle,
 511                               const efi_guid_t *protocol,
 512                               void *protocol_interface);
 513 /* Open protocol */
 514 efi_status_t efi_protocol_open(struct efi_handler *handler,
 515                                void **protocol_interface, void *agent_handle,
 516                                void *controller_handle, uint32_t attributes);
 517
 518 /* Delete protocol from a handle */
 519 efi_status_t efi_remove_protocol(const efi_handle_t handle,
 520                                  const efi_guid_t *protocol,
 521                                  void *protocol_interface);
 522 /* Delete all protocols from a handle */
 523 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
 524 /* Install multiple protocol interfaces */
 525 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
 526                                 (efi_handle_t *handle, ...);
 527 /* Get handles that support a given protocol */
 528 efi_status_t EFIAPI efi_locate_handle_buffer(
 529                         enum efi_locate_search_type search_type,
 530                         const efi_guid_t *protocol, void *search_key,
 531                         efi_uintn_t *no_handles, efi_handle_t **buffer);
 532 /* Close an previously opened protocol interface */
 533 efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
 534                                        const efi_guid_t *protocol,
 535                                        efi_handle_t agent_handle,
 536                                        efi_handle_t controller_handle);
 537 /* Open a protocol interface */
 538 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
 539                                         const efi_guid_t *protocol,
 540                                         void **protocol_interface);
 541 /* Call this to create an event */
 542 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
 543                               void (EFIAPI *notify_function) (
 544                                         struct efi_event *event,
 545                                         void *context),
 546                               void *notify_context, efi_guid_t *group,
 547                               struct efi_event **event);
 548 /* Call this to set a timer */
 549 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 550                            uint64_t trigger_time);
 551 /* Call this to signal an event */
 552 void efi_signal_event(struct efi_event *event);
 553
 554 /* open file system: */
 555 struct efi_simple_file_system_protocol *efi_simple_file_system(
 556                 struct blk_desc *desc, int part, struct efi_device_path *dp);
 557
 558 /* open file from device-path: */
 559 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
 560
 561 /**
 562  * efi_size_in_pages() - convert size in bytes to size in pages
 563  *
 564  * This macro returns the number of EFI memory pages required to hold 'size'
 565  * bytes.
 566  *
 567  * @size:       size in bytes
 568  * Return:      size in pages
 569  */
 570 #define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
 571 /* Generic EFI memory allocator, call this to get memory */
 572 void *efi_alloc(uint64_t len, int memory_type);
 573 /* More specific EFI memory allocator, called by EFI payloads */
 574 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
 575                                 uint64_t *memory);
 576 /* EFI memory free function. */
 577 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
 578 /* EFI memory allocator for small allocations */
 579 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
 580                                void **buffer);
 581 /* EFI pool memory free function. */
 582 efi_status_t efi_free_pool(void *buffer);
 583 /* Returns the EFI memory map */
 584 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
 585                                 struct efi_mem_desc *memory_map,
 586                                 efi_uintn_t *map_key,
 587                                 efi_uintn_t *descriptor_size,
 588                                 uint32_t *descriptor_version);
 589 /* Adds a range into the EFI memory map */
 590 efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
 591 /* Adds a conventional range into the EFI memory map */
 592 efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
 593                                              u64 ram_top);
 594
 595 /* Called by board init to initialize the EFI drivers */
 596 efi_status_t efi_driver_init(void);
 597 /* Called by board init to initialize the EFI memory map */
 598 int efi_memory_init(void);
 599 /* Adds new or overrides configuration table entry to the system table */
 600 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
 601 /* Sets up a loaded image */
 602 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
 603                                     struct efi_device_path *file_path,
 604                                     struct efi_loaded_image_obj **handle_ptr,
 605                                     struct efi_loaded_image **info_ptr);
 606 /* Print information about all loaded images */
 607 void efi_print_image_infos(void *pc);
 608
 609 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 610 extern void *efi_bounce_buffer;
 611 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
 612 #endif
 613
 614
 615 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
 616 int efi_dp_match(const struct efi_device_path *a,
 617                  const struct efi_device_path *b);
 618 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
 619                                    struct efi_device_path **rem);
 620 /* get size of the first device path instance excluding end node */
 621 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
 622 /* size of multi-instance device path excluding end node */
 623 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
 624 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
 625 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
 626                                       const struct efi_device_path *dp2);
 627 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
 628                                            const struct efi_device_path *node);
 629 /* Create a device path node of given type, sub-type, length */
 630 struct efi_device_path *efi_dp_create_device_node(const u8 type,
 631                                                   const u8 sub_type,
 632                                                   const u16 length);
 633 /* Append device path instance */
 634 struct efi_device_path *efi_dp_append_instance(
 635                 const struct efi_device_path *dp,
 636                 const struct efi_device_path *dpi);
 637 /* Get next device path instance */
 638 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
 639                                                  efi_uintn_t *size);
 640 /* Check if a device path contains muliple instances */
 641 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
 642
 643 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
 644 /* Create a device node for a block device partition. */
 645 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
 646 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
 647                                          const char *path);
 648 struct efi_device_path *efi_dp_from_eth(void);
 649 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
 650                                         uint64_t start_address,
 651                                         uint64_t end_address);
 652 /* Determine the last device path node that is not the end node. */
 653 const struct efi_device_path *efi_dp_last_node(
 654                         const struct efi_device_path *dp);
 655 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
 656                                     struct efi_device_path **device_path,
 657                                     struct efi_device_path **file_path);
 658 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
 659                               const char *path,
 660                               struct efi_device_path **device,
 661                               struct efi_device_path **file);
 662 ssize_t efi_dp_check_length(const struct efi_device_path *dp,
 663                             const size_t maxlen);
 664
 665 #define EFI_DP_TYPE(_dp, _type, _subtype) \
 666         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
 667          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
 668
 669 /*
 670  * Use these to indicate that your code / data should go into the EFI runtime
 671  * section and thus still be available when the OS is running
 672  */
 673 #define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
 674 #define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
 675
 676 /* Indicate supported runtime services */
 677 efi_status_t efi_init_runtime_supported(void);
 678
 679 /* Update CRC32 in table header */
 680 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
 681
 682 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
 683  * to make it available at runtime */
 684 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
 685
 686 /* Boards may provide the functions below to implement RTS functionality */
 687
 688 void __efi_runtime EFIAPI efi_reset_system(
 689                         enum efi_reset_type reset_type,
 690                         efi_status_t reset_status,
 691                         unsigned long data_size, void *reset_data);
 692
 693 /* Architecture specific initialization of the EFI subsystem */
 694 efi_status_t efi_reset_system_init(void);
 695
 696 efi_status_t __efi_runtime EFIAPI efi_get_time(
 697                         struct efi_time *time,
 698                         struct efi_time_cap *capabilities);
 699
 700 efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
 701
 702 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 703 /*
 704  * Entry point for the tests of the EFI API.
 705  * It is called by 'bootefi selftest'
 706  */
 707 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
 708                                  struct efi_system_table *systab);
 709 #endif
 710
 711 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
 712                                      const efi_guid_t *vendor, u32 *attributes,
 713                                      efi_uintn_t *data_size, void *data);
 714 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
 715                                                u16 *variable_name,
 716                                                efi_guid_t *vendor);
 717 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
 718                                      const efi_guid_t *vendor, u32 attributes,
 719                                      efi_uintn_t data_size, const void *data);
 720
 721 efi_status_t EFIAPI efi_query_variable_info(
 722                         u32 attributes, u64 *maximum_variable_storage_size,
 723                         u64 *remaining_variable_storage_size,
 724                         u64 *maximum_variable_size);
 725
 726 /*
 727  * See section 3.1.3 in the v2.7 UEFI spec for more details on
 728  * the layout of EFI_LOAD_OPTION.  In short it is:
 729  *
 730  *    typedef struct _EFI_LOAD_OPTION {
 731  *        UINT32 Attributes;
 732  *        UINT16 FilePathListLength;
 733  *        // CHAR16 Description[];   <-- variable length, NULL terminated
 734  *        // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
 735  *                                               <-- FilePathListLength bytes
 736  *        // UINT8 OptionalData[];
 737  *    } EFI_LOAD_OPTION;
 738  */
 739 struct efi_load_option {
 740         u32 attributes;
 741         u16 file_path_length;
 742         u16 *label;
 743         struct efi_device_path *file_path;
 744         const u8 *optional_data;
 745 };
 746
 747 efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
 748                                          efi_uintn_t *size);
 749 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
 750 efi_status_t efi_set_load_options(efi_handle_t handle,
 751                                   efi_uintn_t load_options_size,
 752                                   void *load_options);
 753 efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
 754
 755 /**
 756  * struct efi_image_regions - A list of memory regions
 757  *
 758  * @max:        Maximum number of regions
 759  * @num:        Number of regions
 760  * @reg:        array of regions
 761  */
 762 struct efi_image_regions {
 763         int                     max;
 764         int                     num;
 765         struct image_region     reg[];
 766 };
 767
 768 /**
 769  * struct efi_sig_data - A decoded data of struct efi_signature_data
 770  *
 771  * This structure represents an internal form of signature in
 772  * signature database. A listed list may represent a signature list.
 773  *
 774  * @next:       Pointer to next entry
 775  * @owner:      Signature owner
 776  * @data:       Pointer to signature data
 777  * @size:       Size of signature data
 778  */
 779 struct efi_sig_data {
 780         struct efi_sig_data *next;
 781         efi_guid_t owner;
 782         void *data;
 783         size_t size;
 784 };
 785
 786 /**
 787  * struct efi_signature_store - A decoded data of signature database
 788  *
 789  * This structure represents an internal form of signature database.
 790  *
 791  * @next:               Pointer to next entry
 792  * @sig_type:           Signature type
 793  * @sig_data_list:      Pointer to signature list
 794  */
 795 struct efi_signature_store {
 796         struct efi_signature_store *next;
 797         efi_guid_t sig_type;
 798         struct efi_sig_data *sig_data_list;
 799 };
 800
 801 struct x509_certificate;
 802 struct pkcs7_message;
 803
 804 bool efi_signature_lookup_digest(struct efi_image_regions *regs,
 805                                  struct efi_signature_store *db);
 806 bool efi_signature_verify(struct efi_image_regions *regs,
 807                           struct pkcs7_message *msg,
 808                           struct efi_signature_store *db,
 809                           struct efi_signature_store *dbx);
 810 static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
 811                                             struct pkcs7_message *msg,
 812                                             struct efi_signature_store *db)
 813 {
 814         return efi_signature_verify(regs, msg, db, NULL);
 815 }
 816 bool efi_signature_check_signers(struct pkcs7_message *msg,
 817                                  struct efi_signature_store *dbx);
 818
 819 efi_status_t efi_image_region_add(struct efi_image_regions *regs,
 820                                   const void *start, const void *end,
 821                                   int nocheck);
 822
 823 void efi_sigstore_free(struct efi_signature_store *sigstore);
 824 struct efi_signature_store *efi_build_signature_store(void *sig_list,
 825                                                       efi_uintn_t size);
 826 struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
 827
 828 bool efi_secure_boot_enabled(void);
 829
 830 bool efi_capsule_auth_enabled(void);
 831
 832 bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
 833                      WIN_CERTIFICATE **auth, size_t *auth_len);
 834
 835 struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
 836                                              size_t buflen,
 837                                              u8 **tmpbuf);
 838
 839 /* runtime implementation of memcpy() */
 840 void efi_memcpy_runtime(void *dest, const void *src, size_t n);
 841
 842 /* commonly used helper function */
 843 u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
 844                              unsigned int index);
 845
 846 extern const struct efi_firmware_management_protocol efi_fmp_fit;
 847 extern const struct efi_firmware_management_protocol efi_fmp_raw;
 848
 849 /* Capsule update */
 850 efi_status_t EFIAPI efi_update_capsule(
 851                 struct efi_capsule_header **capsule_header_array,
 852                 efi_uintn_t capsule_count,
 853                 u64 scatter_gather_list);
 854 efi_status_t EFIAPI efi_query_capsule_caps(
 855                 struct efi_capsule_header **capsule_header_array,
 856                 efi_uintn_t capsule_count,
 857                 u64 *maximum_capsule_size,
 858                 u32 *reset_type);
 859
 860 efi_status_t efi_capsule_authenticate(const void *capsule,
 861                                       efi_uintn_t capsule_size,
 862                                       void **image, efi_uintn_t *image_size);
 863
 864 #define EFI_CAPSULE_DIR L"\\EFI\\UpdateCapsule\\"
 865
 866 /* Hook at initialization */
 867 efi_status_t efi_launch_capsules(void);
 868
 869 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
 870
 871 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
 872 #define __efi_runtime_data
 873 #define __efi_runtime
 874 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
 875 {
 876         return EFI_SUCCESS;
 877 }
 878
 879 /* No loader configured, stub out EFI_ENTRY */
 880 static inline void efi_restore_gd(void) { }
 881 static inline void efi_set_bootdev(const char *dev, const char *devnr,
 882                                    const char *path, void *buffer,
 883                                    size_t buffer_size) { }
 884 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
 885 static inline void efi_print_image_infos(void *pc) { }
 886 static inline efi_status_t efi_launch_capsules(void)
 887 {
 888         return EFI_SUCCESS;
 889 }
 890
 891 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
 892
 893 #endif /* _EFI_LOADER_H */