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 system partition */
 264 extern const efi_guid_t efi_system_partition_guid;
 265 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
 266 extern const efi_guid_t efi_guid_driver_binding_protocol;
 267 /* event group ExitBootServices() invoked */
 268 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
 269 /* event group SetVirtualAddressMap() invoked */
 270 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
 271 /* event group memory map changed */
 272 extern const efi_guid_t efi_guid_event_group_memory_map_change;
 273 /* event group boot manager about to boot */
 274 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
 275 /* event group ResetSystem() invoked (before ExitBootServices) */
 276 extern const efi_guid_t efi_guid_event_group_reset_system;
 277 /* GUID of the device tree table */
 278 extern const efi_guid_t efi_guid_fdt;
 279 extern const efi_guid_t efi_guid_loaded_image;
 280 extern const efi_guid_t efi_guid_loaded_image_device_path;
 281 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
 282 extern const efi_guid_t efi_simple_file_system_protocol_guid;
 283 extern const efi_guid_t efi_file_info_guid;
 284 /* GUID for file system information */
 285 extern const efi_guid_t efi_file_system_info_guid;
 286 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
 287 /* GUID of the deprecated Unicode collation protocol */
 288 extern const efi_guid_t efi_guid_unicode_collation_protocol;
 289 /* GUIDs of the Load File and Load File2 protocol */
 290 extern const efi_guid_t efi_guid_load_file_protocol;
 291 extern const efi_guid_t efi_guid_load_file2_protocol;
 292 /* GUID of the Unicode collation protocol */
 293 extern const efi_guid_t efi_guid_unicode_collation_protocol2;
 294 extern const efi_guid_t efi_guid_hii_config_routing_protocol;
 295 extern const efi_guid_t efi_guid_hii_config_access_protocol;
 296 extern const efi_guid_t efi_guid_hii_database_protocol;
 297 extern const efi_guid_t efi_guid_hii_string_protocol;
 298 /* GUIDs for authentication */
 299 extern const efi_guid_t efi_guid_image_security_database;
 300 extern const efi_guid_t efi_guid_sha256;
 301 extern const efi_guid_t efi_guid_cert_x509;
 302 extern const efi_guid_t efi_guid_cert_x509_sha256;
 303 extern const efi_guid_t efi_guid_cert_type_pkcs7;
 304
 305 /* GUID of RNG protocol */
 306 extern const efi_guid_t efi_guid_rng_protocol;
 307 /* GUID of capsule update result */
 308 extern const efi_guid_t efi_guid_capsule_report;
 309 /* GUID of firmware management protocol */
 310 extern const efi_guid_t efi_guid_firmware_management_protocol;
 311 /* GUID for the ESRT */
 312 extern const efi_guid_t efi_esrt_guid;
 313 /* GUID of the SMBIOS table */
 314 extern const efi_guid_t smbios_guid;
 315
 316 extern char __efi_runtime_start[], __efi_runtime_stop[];
 317 extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
 318
 319 /**
 320  * struct efi_open_protocol_info_item - open protocol info item
 321  *
 322  * When a protocol is opened a open protocol info entry is created.
 323  * These are maintained in a list.
 324  *
 325  * @link:       link to the list of open protocol info entries of a protocol
 326  * @info:       information about the opening of a protocol
 327  */
 328 struct efi_open_protocol_info_item {
 329         struct list_head link;
 330         struct efi_open_protocol_info_entry info;
 331 };
 332
 333 /**
 334  * struct efi_handler - single protocol interface of a handle
 335  *
 336  * When the UEFI payload wants to open a protocol on an object to get its
 337  * interface (usually a struct with callback functions), this struct maps the
 338  * protocol GUID to the respective protocol interface
 339  *
 340  * @link:               link to the list of protocols of a handle
 341  * @guid:               GUID of the protocol
 342  * @protocol_interface: protocol interface
 343  * @open_infos:         link to the list of open protocol info items
 344  */
 345 struct efi_handler {
 346         struct list_head link;
 347         const efi_guid_t guid;
 348         void *protocol_interface;
 349         struct list_head open_infos;
 350 };
 351
 352 /**
 353  * enum efi_object_type - type of EFI object
 354  *
 355  * In UnloadImage we must be able to identify if the handle relates to a
 356  * started image.
 357  */
 358 enum efi_object_type {
 359         /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
 360         EFI_OBJECT_TYPE_UNDEFINED = 0,
 361         /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
 362         EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
 363         /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
 364         EFI_OBJECT_TYPE_LOADED_IMAGE,
 365         /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
 366         EFI_OBJECT_TYPE_STARTED_IMAGE,
 367 };
 368
 369 /**
 370  * struct efi_object - dereferenced EFI handle
 371  *
 372  * @link:       pointers to put the handle into a linked list
 373  * @protocols:  linked list with the protocol interfaces installed on this
 374  *              handle
 375  * @type:       image type if the handle relates to an image
 376  *
 377  * UEFI offers a flexible and expandable object model. The objects in the UEFI
 378  * API are devices, drivers, and loaded images. struct efi_object is our storage
 379  * structure for these objects.
 380  *
 381  * When including this structure into a larger structure always put it first so
 382  * that when deleting a handle the whole encompassing structure can be freed.
 383  *
 384  * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
 385  * has been created for such pointers.
 386  */
 387 struct efi_object {
 388         /* Every UEFI object is part of a global object list */
 389         struct list_head link;
 390         /* The list of protocols */
 391         struct list_head protocols;
 392         enum efi_object_type type;
 393 };
 394
 395 enum efi_image_auth_status {
 396         EFI_IMAGE_AUTH_FAILED = 0,
 397         EFI_IMAGE_AUTH_PASSED,
 398 };
 399
 400 /**
 401  * struct efi_loaded_image_obj - handle of a loaded image
 402  *
 403  * @header:             EFI object header
 404  * @exit_status:        exit status passed to Exit()
 405  * @exit_data_size:     exit data size passed to Exit()
 406  * @exit_data:          exit data passed to Exit()
 407  * @exit_jmp:           long jump buffer for returning from started image
 408  * @entry:              entry address of the relocated image
 409  * @image_type:         indicates if the image is an applicition or a driver
 410  * @auth_status:        indicates if the image is authenticated
 411  */
 412 struct efi_loaded_image_obj {
 413         struct efi_object header;
 414         efi_status_t *exit_status;
 415         efi_uintn_t *exit_data_size;
 416         u16 **exit_data;
 417         struct jmp_buf_data *exit_jmp;
 418         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
 419                                      struct efi_system_table *st);
 420         u16 image_type;
 421         enum efi_image_auth_status auth_status;
 422 };
 423
 424 /**
 425  * struct efi_event
 426  *
 427  * @link:               Link to list of all events
 428  * @queue_link:         Link to the list of queued events
 429  * @type:               Type of event, see efi_create_event
 430  * @notify_tpl:         Task priority level of notifications
 431  * @notify_function:    Function to call when the event is triggered
 432  * @notify_context:     Data to be passed to the notify function
 433  * @group:              Event group
 434  * @trigger_time:       Period of the timer
 435  * @trigger_next:       Next time to trigger the timer
 436  * @trigger_type:       Type of timer, see efi_set_timer
 437  * @is_signaled:        The event occurred. The event is in the signaled state.
 438  */
 439 struct efi_event {
 440         struct list_head link;
 441         struct list_head queue_link;
 442         uint32_t type;
 443         efi_uintn_t notify_tpl;
 444         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
 445         void *notify_context;
 446         const efi_guid_t *group;
 447         u64 trigger_next;
 448         u64 trigger_time;
 449         enum efi_timer_delay trigger_type;
 450         bool is_signaled;
 451 };
 452
 453 /* This list contains all UEFI objects we know of */
 454 extern struct list_head efi_obj_list;
 455 /* List of all events */
 456 extern struct list_head efi_events;
 457
 458 /**
 459  * struct efi_protocol_notification - handle for notified protocol
 460  *
 461  * When a protocol interface is installed for which an event was registered with
 462  * the RegisterProtocolNotify() service this structure is used to hold the
 463  * handle on which the protocol interface was installed.
 464  *
 465  * @link:       link to list of all handles notified for this event
 466  * @handle:     handle on which the notified protocol interface was installed
 467  */
 468 struct efi_protocol_notification {
 469         struct list_head link;
 470         efi_handle_t handle;
 471 };
 472
 473 /**
 474  * struct efi_register_notify_event - event registered by
 475  *                                    RegisterProtocolNotify()
 476  *
 477  * The address of this structure serves as registration value.
 478  *
 479  * @link:       link to list of all registered events
 480  * @event:      registered event. The same event may registered for multiple
 481  *              GUIDs.
 482  * @protocol:   protocol for which the event is registered
 483  * @handles:    linked list of all handles on which the notified protocol was
 484  *              installed
 485  */
 486 struct efi_register_notify_event {
 487         struct list_head link;
 488         struct efi_event *event;
 489         efi_guid_t protocol;
 490         struct list_head handles;
 491 };
 492
 493 /* List of all events registered by RegisterProtocolNotify() */
 494 extern struct list_head efi_register_notify_events;
 495
 496 /* called at pre-initialization */
 497 int efi_init_early(void);
 498 /* Initialize efi execution environment */
 499 efi_status_t efi_init_obj_list(void);
 500 /* Install device tree */
 501 efi_status_t efi_install_fdt(void *fdt);
 502 /* Run loaded UEFI image */
 503 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
 504 /* Initialize variable services */
 505 efi_status_t efi_init_variables(void);
 506 /* Notify ExitBootServices() is called */
 507 void efi_variables_boot_exit_notify(void);
 508 efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
 509 /* Measure efi application invocation */
 510 efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
 511 /* Measure efi application exit */
 512 efi_status_t efi_tcg2_measure_efi_app_exit(void);
 513 /* Called by bootefi to initialize root node */
 514 efi_status_t efi_root_node_register(void);
 515 /* Called by bootefi to initialize runtime */
 516 efi_status_t efi_initialize_system_table(void);
 517 /* efi_runtime_detach() - detach unimplemented runtime functions */
 518 void efi_runtime_detach(void);
 519 /* efi_convert_pointer() - convert pointer to virtual address */
 520 efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
 521                                         void **address);
 522 /* Carve out DT reserved memory ranges */
 523 void efi_carve_out_dt_rsv(void *fdt);
 524 /* Purge unused kaslr-seed */
 525 void efi_try_purge_kaslr_seed(void *fdt);
 526 /* Called by bootefi to make console interface available */
 527 efi_status_t efi_console_register(void);
 528 /* Called by efi_init_obj_list() to initialize efi_disks */
 529 efi_status_t efi_disk_init(void);
 530 /* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
 531 efi_status_t efi_rng_register(void);
 532 /* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
 533 efi_status_t efi_tcg2_register(void);
 534 /* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
 535 efi_status_t efi_riscv_register(void);
 536 /* Called by efi_init_obj_list() to do initial measurement */
 537 efi_status_t efi_tcg2_do_initial_measurement(void);
 538 /* measure the pe-coff image, extend PCR and add Event Log */
 539 efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
 540                                    struct efi_loaded_image_obj *handle,
 541                                    struct efi_loaded_image *loaded_image_info);
 542 /* Create handles and protocols for the partitions of a block device */
 543 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
 544                                const char *if_typename, int diskid,
 545                                const char *pdevname);
 546 /* Called by bootefi to make GOP (graphical) interface available */
 547 efi_status_t efi_gop_register(void);
 548 /* Called by bootefi to make the network interface available */
 549 efi_status_t efi_net_register(void);
 550 /* Called by bootefi to make the watchdog available */
 551 efi_status_t efi_watchdog_register(void);
 552 efi_status_t efi_initrd_register(void);
 553 void efi_initrd_deregister(void);
 554 /* Called by bootefi to make SMBIOS tables available */
 555 /**
 556  * efi_acpi_register() - write out ACPI tables
 557  *
 558  * Called by bootefi to make ACPI tables available
 559  *
 560  * Return: 0 if OK, -ENOMEM if no memory is available for the tables
 561  */
 562 efi_status_t efi_acpi_register(void);
 563 /**
 564  * efi_smbios_register() - write out SMBIOS tables
 565  *
 566  * Called by bootefi to make SMBIOS tables available
 567  *
 568  * Return: 0 if OK, -ENOMEM if no memory is available for the tables
 569  */
 570 efi_status_t efi_smbios_register(void);
 571
 572 struct efi_simple_file_system_protocol *
 573 efi_fs_from_path(struct efi_device_path *fp);
 574
 575 /* Called by efi_set_watchdog_timer to reset the timer */
 576 efi_status_t efi_set_watchdog(unsigned long timeout);
 577
 578 /* Called from places to check whether a timer expired */
 579 void efi_timer_check(void);
 580 /* Check if a buffer contains a PE-COFF image */
 581 efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
 582 /* PE loader implementation */
 583 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
 584                          void *efi, size_t efi_size,
 585                          struct efi_loaded_image *loaded_image_info);
 586 /* Called once to store the pristine gd pointer */
 587 void efi_save_gd(void);
 588 /* Call this to relocate the runtime section to an address space */
 589 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
 590 /* Add a new object to the object list. */
 591 void efi_add_handle(efi_handle_t obj);
 592 /* Create handle */
 593 efi_status_t efi_create_handle(efi_handle_t *handle);
 594 /* Delete handle */
 595 void efi_delete_handle(efi_handle_t obj);
 596 /* Call this to validate a handle and find the EFI object for it */
 597 struct efi_object *efi_search_obj(const efi_handle_t handle);
 598 /* Load image */
 599 efi_status_t EFIAPI efi_load_image(bool boot_policy,
 600                                    efi_handle_t parent_image,
 601                                    struct efi_device_path *file_path,
 602                                    void *source_buffer,
 603                                    efi_uintn_t source_size,
 604                                    efi_handle_t *image_handle);
 605 /* Start image */
 606 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
 607                                     efi_uintn_t *exit_data_size,
 608                                     u16 **exit_data);
 609 /* Unload image */
 610 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
 611 /* Find a protocol on a handle */
 612 efi_status_t efi_search_protocol(const efi_handle_t handle,
 613                                  const efi_guid_t *protocol_guid,
 614                                  struct efi_handler **handler);
 615 /* Install new protocol on a handle */
 616 efi_status_t efi_add_protocol(const efi_handle_t handle,
 617                               const efi_guid_t *protocol,
 618                               void *protocol_interface);
 619 /* Open protocol */
 620 efi_status_t efi_protocol_open(struct efi_handler *handler,
 621                                void **protocol_interface, void *agent_handle,
 622                                void *controller_handle, uint32_t attributes);
 623
 624 /* Delete protocol from a handle */
 625 efi_status_t efi_remove_protocol(const efi_handle_t handle,
 626                                  const efi_guid_t *protocol,
 627                                  void *protocol_interface);
 628 /* Delete all protocols from a handle */
 629 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
 630 /* Install multiple protocol interfaces */
 631 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
 632                                 (efi_handle_t *handle, ...);
 633 /* Get handles that support a given protocol */
 634 efi_status_t EFIAPI efi_locate_handle_buffer(
 635                         enum efi_locate_search_type search_type,
 636                         const efi_guid_t *protocol, void *search_key,
 637                         efi_uintn_t *no_handles, efi_handle_t **buffer);
 638 /* Close an previously opened protocol interface */
 639 efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
 640                                        const efi_guid_t *protocol,
 641                                        efi_handle_t agent_handle,
 642                                        efi_handle_t controller_handle);
 643 /* Open a protocol interface */
 644 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
 645                                         const efi_guid_t *protocol,
 646                                         void **protocol_interface);
 647 /* Call this to create an event */
 648 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
 649                               void (EFIAPI *notify_function) (
 650                                         struct efi_event *event,
 651                                         void *context),
 652                               void *notify_context, efi_guid_t *group,
 653                               struct efi_event **event);
 654 /* Call this to set a timer */
 655 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 656                            uint64_t trigger_time);
 657 /* Call this to signal an event */
 658 void efi_signal_event(struct efi_event *event);
 659
 660 /* open file system: */
 661 struct efi_simple_file_system_protocol *efi_simple_file_system(
 662                 struct blk_desc *desc, int part, struct efi_device_path *dp);
 663
 664 /* open file from device-path: */
 665 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
 666
 667 /* Registers a callback function for a notification event. */
 668 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
 669                                                  struct efi_event *event,
 670                                                  void **registration);
 671 efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
 672
 673 /* get a device path from a Boot#### option */
 674 struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
 675
 676 /**
 677  * efi_size_in_pages() - convert size in bytes to size in pages
 678  *
 679  * This macro returns the number of EFI memory pages required to hold 'size'
 680  * bytes.
 681  *
 682  * @size:       size in bytes
 683  * Return:      size in pages
 684  */
 685 #define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
 686 /* Generic EFI memory allocator, call this to get memory */
 687 void *efi_alloc(uint64_t len, int memory_type);
 688 /* Allocate pages on the specified alignment */
 689 void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
 690 /* More specific EFI memory allocator, called by EFI payloads */
 691 efi_status_t efi_allocate_pages(enum efi_allocate_type type,
 692                                 enum efi_memory_type memory_type,
 693                                 efi_uintn_t pages, uint64_t *memory);
 694 /* EFI memory free function. */
 695 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
 696 /* EFI memory allocator for small allocations */
 697 efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
 698                                efi_uintn_t size, void **buffer);
 699 /* EFI pool memory free function. */
 700 efi_status_t efi_free_pool(void *buffer);
 701 /* Returns the EFI memory map */
 702 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
 703                                 struct efi_mem_desc *memory_map,
 704                                 efi_uintn_t *map_key,
 705                                 efi_uintn_t *descriptor_size,
 706                                 uint32_t *descriptor_version);
 707 /* Adds a range into the EFI memory map */
 708 efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
 709 /* Adds a conventional range into the EFI memory map */
 710 efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
 711                                              u64 ram_top);
 712
 713 /* Called by board init to initialize the EFI drivers */
 714 efi_status_t efi_driver_init(void);
 715 /* Called by board init to initialize the EFI memory map */
 716 int efi_memory_init(void);
 717 /* Adds new or overrides configuration table entry to the system table */
 718 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
 719 /* Sets up a loaded image */
 720 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
 721                                     struct efi_device_path *file_path,
 722                                     struct efi_loaded_image_obj **handle_ptr,
 723                                     struct efi_loaded_image **info_ptr);
 724
 725 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 726 extern void *efi_bounce_buffer;
 727 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
 728 #endif
 729
 730 /* shorten device path */
 731 struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
 732 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
 733 int efi_dp_match(const struct efi_device_path *a,
 734                  const struct efi_device_path *b);
 735 efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
 736                              const efi_guid_t *guid,
 737                              struct efi_device_path **rem);
 738 /* get size of the first device path instance excluding end node */
 739 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
 740 /* size of multi-instance device path excluding end node */
 741 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
 742 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
 743 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
 744                                       const struct efi_device_path *dp2);
 745 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
 746                                            const struct efi_device_path *node);
 747 /* Create a device path node of given type, sub-type, length */
 748 struct efi_device_path *efi_dp_create_device_node(const u8 type,
 749                                                   const u8 sub_type,
 750                                                   const u16 length);
 751 /* Append device path instance */
 752 struct efi_device_path *efi_dp_append_instance(
 753                 const struct efi_device_path *dp,
 754                 const struct efi_device_path *dpi);
 755 /* Get next device path instance */
 756 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
 757                                                  efi_uintn_t *size);
 758 /* Check if a device path contains muliple instances */
 759 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
 760
 761 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
 762 /* Create a device node for a block device partition. */
 763 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
 764 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
 765                                          const char *path);
 766 struct efi_device_path *efi_dp_from_eth(void);
 767 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
 768                                         uint64_t start_address,
 769                                         uint64_t end_address);
 770 /* Determine the last device path node that is not the end node. */
 771 const struct efi_device_path *efi_dp_last_node(
 772                         const struct efi_device_path *dp);
 773 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
 774                                     struct efi_device_path **device_path,
 775                                     struct efi_device_path **file_path);
 776 struct efi_device_path *efi_dp_from_uart(void);
 777 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
 778                               const char *path,
 779                               struct efi_device_path **device,
 780                               struct efi_device_path **file);
 781 ssize_t efi_dp_check_length(const struct efi_device_path *dp,
 782                             const size_t maxlen);
 783
 784 #define EFI_DP_TYPE(_dp, _type, _subtype) \
 785         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
 786          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
 787
 788 /* Indicate supported runtime services */
 789 efi_status_t efi_init_runtime_supported(void);
 790
 791 /* Update CRC32 in table header */
 792 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
 793
 794 /* Boards may provide the functions below to implement RTS functionality */
 795
 796 void __efi_runtime EFIAPI efi_reset_system(
 797                         enum efi_reset_type reset_type,
 798                         efi_status_t reset_status,
 799                         unsigned long data_size, void *reset_data);
 800
 801 /* Architecture specific initialization of the EFI subsystem */
 802 efi_status_t efi_reset_system_init(void);
 803
 804 efi_status_t __efi_runtime EFIAPI efi_get_time(
 805                         struct efi_time *time,
 806                         struct efi_time_cap *capabilities);
 807
 808 efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
 809
 810 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 811 /*
 812  * Entry point for the tests of the EFI API.
 813  * It is called by 'bootefi selftest'
 814  */
 815 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
 816                                  struct efi_system_table *systab);
 817 #endif
 818
 819 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
 820                                      const efi_guid_t *vendor, u32 *attributes,
 821                                      efi_uintn_t *data_size, void *data);
 822 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
 823                                                u16 *variable_name,
 824                                                efi_guid_t *vendor);
 825 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
 826                                      const efi_guid_t *vendor, u32 attributes,
 827                                      efi_uintn_t data_size, const void *data);
 828
 829 efi_status_t EFIAPI efi_query_variable_info(
 830                         u32 attributes, u64 *maximum_variable_storage_size,
 831                         u64 *remaining_variable_storage_size,
 832                         u64 *maximum_variable_size);
 833
 834 void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
 835
 836 /*
 837  * See section 3.1.3 in the v2.7 UEFI spec for more details on
 838  * the layout of EFI_LOAD_OPTION.  In short it is:
 839  *
 840  *    typedef struct _EFI_LOAD_OPTION {
 841  *        UINT32 Attributes;
 842  *        UINT16 FilePathListLength;
 843  *        // CHAR16 Description[];   <-- variable length, NULL terminated
 844  *        // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
 845  *                                               <-- FilePathListLength bytes
 846  *        // UINT8 OptionalData[];
 847  *    } EFI_LOAD_OPTION;
 848  */
 849 struct efi_load_option {
 850         u32 attributes;
 851         u16 file_path_length;
 852         u16 *label;
 853         struct efi_device_path *file_path;
 854         const u8 *optional_data;
 855 };
 856
 857 struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
 858                                        const efi_guid_t *guid);
 859 struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
 860                                       const struct efi_device_path *dp2);
 861 struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
 862 efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
 863                                          efi_uintn_t *size);
 864 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
 865 efi_status_t efi_set_load_options(efi_handle_t handle,
 866                                   efi_uintn_t load_options_size,
 867                                   void *load_options);
 868 efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
 869
 870 /**
 871  * struct efi_image_regions - A list of memory regions
 872  *
 873  * @max:        Maximum number of regions
 874  * @num:        Number of regions
 875  * @reg:        array of regions
 876  */
 877 struct efi_image_regions {
 878         int                     max;
 879         int                     num;
 880         struct image_region     reg[];
 881 };
 882
 883 /**
 884  * struct efi_sig_data - A decoded data of struct efi_signature_data
 885  *
 886  * This structure represents an internal form of signature in
 887  * signature database. A listed list may represent a signature list.
 888  *
 889  * @next:       Pointer to next entry
 890  * @owner:      Signature owner
 891  * @data:       Pointer to signature data
 892  * @size:       Size of signature data
 893  */
 894 struct efi_sig_data {
 895         struct efi_sig_data *next;
 896         efi_guid_t owner;
 897         void *data;
 898         size_t size;
 899 };
 900
 901 /**
 902  * struct efi_signature_store - A decoded data of signature database
 903  *
 904  * This structure represents an internal form of signature database.
 905  *
 906  * @next:               Pointer to next entry
 907  * @sig_type:           Signature type
 908  * @sig_data_list:      Pointer to signature list
 909  */
 910 struct efi_signature_store {
 911         struct efi_signature_store *next;
 912         efi_guid_t sig_type;
 913         struct efi_sig_data *sig_data_list;
 914 };
 915
 916 struct x509_certificate;
 917 struct pkcs7_message;
 918
 919 bool efi_signature_lookup_digest(struct efi_image_regions *regs,
 920                                  struct efi_signature_store *db,
 921                                  bool dbx);
 922 bool efi_signature_verify(struct efi_image_regions *regs,
 923                           struct pkcs7_message *msg,
 924                           struct efi_signature_store *db,
 925                           struct efi_signature_store *dbx);
 926 static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
 927                                             struct pkcs7_message *msg,
 928                                             struct efi_signature_store *db)
 929 {
 930         return efi_signature_verify(regs, msg, db, NULL);
 931 }
 932 bool efi_signature_check_signers(struct pkcs7_message *msg,
 933                                  struct efi_signature_store *dbx);
 934
 935 efi_status_t efi_image_region_add(struct efi_image_regions *regs,
 936                                   const void *start, const void *end,
 937                                   int nocheck);
 938
 939 void efi_sigstore_free(struct efi_signature_store *sigstore);
 940 struct efi_signature_store *efi_build_signature_store(void *sig_list,
 941                                                       efi_uintn_t size);
 942 struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
 943
 944 bool efi_secure_boot_enabled(void);
 945
 946 bool efi_capsule_auth_enabled(void);
 947
 948 void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
 949
 950 bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
 951                      WIN_CERTIFICATE **auth, size_t *auth_len);
 952
 953 struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
 954                                              size_t buflen,
 955                                              u8 **tmpbuf);
 956
 957 /* runtime implementation of memcpy() */
 958 void efi_memcpy_runtime(void *dest, const void *src, size_t n);
 959
 960 /* commonly used helper function */
 961 u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
 962                              unsigned int index);
 963
 964 extern const struct efi_firmware_management_protocol efi_fmp_fit;
 965 extern const struct efi_firmware_management_protocol efi_fmp_raw;
 966
 967 /* Capsule update */
 968 efi_status_t EFIAPI efi_update_capsule(
 969                 struct efi_capsule_header **capsule_header_array,
 970                 efi_uintn_t capsule_count,
 971                 u64 scatter_gather_list);
 972 efi_status_t EFIAPI efi_query_capsule_caps(
 973                 struct efi_capsule_header **capsule_header_array,
 974                 efi_uintn_t capsule_count,
 975                 u64 *maximum_capsule_size,
 976                 u32 *reset_type);
 977
 978 efi_status_t efi_capsule_authenticate(const void *capsule,
 979                                       efi_uintn_t capsule_size,
 980                                       void **image, efi_uintn_t *image_size);
 981
 982 #define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
 983
 984 /**
 985  * struct efi_fw_image -  Information on firmware images updatable through
 986  *                        capsule update
 987  *
 988  * This structure gives information about the firmware images on the platform
 989  * which can be updated through the capsule update mechanism
 990  *
 991  * @image_type_id:      Image GUID. Same value is to be used in the capsule
 992  * @fw_name:            Name of the firmware image
 993  * @image_index:        Image Index, same as value passed to SetImage FMP
 994  *                      function
 995  */
 996 struct efi_fw_image {
 997         efi_guid_t image_type_id;
 998         u16 *fw_name;
 999         u8 image_index;
1000 };
1001
1002 /**
1003  * struct efi_capsule_update_info - Information needed for capsule updates
1004  *
1005  * This structure provides information needed for performing firmware
1006  * updates. The structure needs to be initialised per platform, for all
1007  * platforms which enable capsule updates
1008  *
1009  * @dfu_string:         String used to populate dfu_alt_info
1010  * @images:             Pointer to an array of updatable images
1011  */
1012 struct efi_capsule_update_info {
1013         const char *dfu_string;
1014         struct efi_fw_image *images;
1015 };
1016
1017 extern struct efi_capsule_update_info update_info;
1018 extern u8 num_image_type_guids;
1019
1020 /**
1021  * Install the ESRT system table.
1022  *
1023  * Return:      status code
1024  */
1025 efi_status_t efi_esrt_register(void);
1026
1027 /**
1028  * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1029  * present in the system.
1030  * If an ESRT already exists, the old ESRT is replaced in the system table.
1031  * The memory of the old ESRT is deallocated.
1032  *
1033  * Return:
1034  * - EFI_SUCCESS if the ESRT is correctly created
1035  * - error code otherwise.
1036  */
1037 efi_status_t efi_esrt_populate(void);
1038 efi_status_t efi_load_capsule_drivers(void);
1039
1040 efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
1041 #endif /* _EFI_LOADER_H */