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