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