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