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