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