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