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