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