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