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