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