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