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