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