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