include/efi_loader.h

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