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