include/efi_loader.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  *  EFI application loader
   4  *
   5  *  Copyright (c) 2016 Alexander Graf
   6  */
   7
   8 #ifndef _EFI_LOADER_H
   9 #define _EFI_LOADER_H 1
  10
  11 #include <common.h>
  12 #include <part_efi.h>
  13 #include <efi_api.h>
  14
  15 /* No need for efi loader support in SPL */
  16 #if CONFIG_IS_ENABLED(EFI_LOADER)
  17
  18 #include <linux/list.h>
  19
  20 /* Maximum number of configuration tables */
  21 #define EFI_MAX_CONFIGURATION_TABLES 16
  22
  23 /* GUID used by the root node */
  24 #define U_BOOT_GUID \
  25         EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
  26                  0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
  27
  28 int __efi_entry_check(void);
  29 int __efi_exit_check(void);
  30 const char *__efi_nesting(void);
  31 const char *__efi_nesting_inc(void);
  32 const char *__efi_nesting_dec(void);
  33
  34 /*
  35  * Enter the u-boot world from UEFI:
  36  */
  37 #define EFI_ENTRY(format, ...) do { \
  38         assert(__efi_entry_check()); \
  39         debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
  40                 __func__, ##__VA_ARGS__); \
  41         } while(0)
  42
  43 /*
  44  * Exit the u-boot world back to UEFI:
  45  */
  46 #define EFI_EXIT(ret) ({ \
  47         typeof(ret) _r = ret; \
  48         debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
  49                 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
  50         assert(__efi_exit_check()); \
  51         _r; \
  52         })
  53
  54 /*
  55  * Call non-void UEFI function from u-boot and retrieve return value:
  56  */
  57 #define EFI_CALL(exp) ({ \
  58         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  59         assert(__efi_exit_check()); \
  60         typeof(exp) _r = exp; \
  61         assert(__efi_entry_check()); \
  62         debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
  63               (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
  64         _r; \
  65 })
  66
  67 /*
  68  * Call void UEFI function from u-boot:
  69  */
  70 #define EFI_CALL_VOID(exp) do { \
  71         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  72         assert(__efi_exit_check()); \
  73         exp; \
  74         assert(__efi_entry_check()); \
  75         debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
  76         } while(0)
  77
  78 /*
  79  * Write an indented message with EFI prefix
  80  */
  81 #define EFI_PRINT(format, ...) ({ \
  82         debug("%sEFI: " format, __efi_nesting(), \
  83                 ##__VA_ARGS__); \
  84         })
  85
  86 #ifdef CONFIG_SYS_CACHELINE_SIZE
  87 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
  88 #else
  89 /* Just use the greatest cache flush alignment requirement I'm aware of */
  90 #define EFI_CACHELINE_SIZE 128
  91 #endif
  92
  93 /* Key identifying current memory map */
  94 extern efi_uintn_t efi_memory_map_key;
  95
  96 extern struct efi_runtime_services efi_runtime_services;
  97 extern struct efi_system_table systab;
  98
  99 extern struct efi_simple_text_output_protocol efi_con_out;
 100 extern struct efi_simple_text_input_protocol efi_con_in;
 101 extern struct efi_console_control_protocol efi_console_control;
 102 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
 103 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
 104 extern const struct efi_device_path_utilities_protocol
 105                                         efi_device_path_utilities;
 106 /* Implementation of the EFI_UNICODE_COLLATION_PROTOCOL */
 107 extern const struct efi_unicode_collation_protocol
 108                                         efi_unicode_collation_protocol;
 109
 110 uint16_t *efi_dp_str(struct efi_device_path *dp);
 111
 112 /* GUID of the U-Boot root node */
 113 extern const efi_guid_t efi_u_boot_guid;
 114 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
 115 extern const efi_guid_t efi_block_io_guid;
 116 extern const efi_guid_t efi_global_variable_guid;
 117 extern const efi_guid_t efi_guid_console_control;
 118 extern const efi_guid_t efi_guid_device_path;
 119 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
 120 extern const efi_guid_t efi_guid_driver_binding_protocol;
 121 /* event group ExitBootServices() invoked */
 122 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
 123 /* event group SetVirtualAddressMap() invoked */
 124 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
 125 /* event group memory map changed */
 126 extern const efi_guid_t efi_guid_event_group_memory_map_change;
 127 /* event group boot manager about to boot */
 128 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
 129 /* event group ResetSystem() invoked (before ExitBootServices) */
 130 extern const efi_guid_t efi_guid_event_group_reset_system;
 131 /* GUID of the device tree table */
 132 extern const efi_guid_t efi_guid_fdt;
 133 extern const efi_guid_t efi_guid_loaded_image;
 134 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
 135 extern const efi_guid_t efi_simple_file_system_protocol_guid;
 136 extern const efi_guid_t efi_file_info_guid;
 137 /* GUID for file system information */
 138 extern const efi_guid_t efi_file_system_info_guid;
 139 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
 140 /* GUID of the Unicode collation protocol */
 141 extern const efi_guid_t efi_guid_unicode_collation_protocol;
 142
 143 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
 144 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
 145
 146 /*
 147  * When a protocol is opened a open protocol info entry is created.
 148  * These are maintained in a list.
 149  */
 150 struct efi_open_protocol_info_item {
 151         /* Link to the list of open protocol info entries of a protocol */
 152         struct list_head link;
 153         struct efi_open_protocol_info_entry info;
 154 };
 155
 156 /*
 157  * When the UEFI payload wants to open a protocol on an object to get its
 158  * interface (usually a struct with callback functions), this struct maps the
 159  * protocol GUID to the respective protocol interface
 160  */
 161 struct efi_handler {
 162         /* Link to the list of protocols of a handle */
 163         struct list_head link;
 164         const efi_guid_t *guid;
 165         void *protocol_interface;
 166         /* Link to the list of open protocol info items */
 167         struct list_head open_infos;
 168 };
 169
 170 /*
 171  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
 172  * multiple different protocols (classes) attached to it.
 173  *
 174  * This struct is the parent struct for all of our actual implementation objects
 175  * that can include it to make themselves an EFI object
 176  */
 177 struct efi_object {
 178         /* Every UEFI object is part of a global object list */
 179         struct list_head link;
 180         /* The list of protocols */
 181         struct list_head protocols;
 182         /* The object spawner can either use this for data or as identifier */
 183         void *handle;
 184 };
 185
 186 /**
 187  * struct efi_event
 188  *
 189  * @link:               Link to list of all events
 190  * @type:               Type of event, see efi_create_event
 191  * @notify_tpl:         Task priority level of notifications
 192  * @nofify_function:    Function to call when the event is triggered
 193  * @notify_context:     Data to be passed to the notify function
 194  * @group:              Event group
 195  * @trigger_time:       Period of the timer
 196  * @trigger_next:       Next time to trigger the timer
 197  * @trigger_type:       Type of timer, see efi_set_timer
 198  * @is_queued:          The notification function is queued
 199  * @is_signaled:        The event occurred. The event is in the signaled state.
 200  */
 201 struct efi_event {
 202         struct list_head link;
 203         uint32_t type;
 204         efi_uintn_t notify_tpl;
 205         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
 206         void *notify_context;
 207         const efi_guid_t *group;
 208         u64 trigger_next;
 209         u64 trigger_time;
 210         enum efi_timer_delay trigger_type;
 211         bool is_queued;
 212         bool is_signaled;
 213 };
 214
 215 /* This list contains all UEFI objects we know of */
 216 extern struct list_head efi_obj_list;
 217 /* List of all events */
 218 extern struct list_head efi_events;
 219
 220 /* Called by bootefi to initialize root node */
 221 efi_status_t efi_root_node_register(void);
 222 /* Called by bootefi to initialize runtime */
 223 efi_status_t efi_initialize_system_table(void);
 224 /* Called by bootefi to make console interface available */
 225 int efi_console_register(void);
 226 /* Called by bootefi to make all disk storage accessible as EFI objects */
 227 efi_status_t efi_disk_register(void);
 228 /* Create handles and protocols for the partitions of a block device */
 229 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
 230                                const char *if_typename, int diskid,
 231                                const char *pdevname);
 232 /* Called by bootefi to make GOP (graphical) interface available */
 233 efi_status_t efi_gop_register(void);
 234 /* Called by bootefi to make the network interface available */
 235 efi_status_t efi_net_register(void);
 236 /* Called by bootefi to make the watchdog available */
 237 efi_status_t efi_watchdog_register(void);
 238 /* Called by bootefi to make SMBIOS tables available */
 239 /**
 240  * efi_acpi_register() - write out ACPI tables
 241  *
 242  * Called by bootefi to make ACPI tables available
 243  *
 244  * @return 0 if OK, -ENOMEM if no memory is available for the tables
 245  */
 246 efi_status_t efi_acpi_register(void);
 247 /**
 248  * efi_smbios_register() - write out SMBIOS tables
 249  *
 250  * Called by bootefi to make SMBIOS tables available
 251  *
 252  * @return 0 if OK, -ENOMEM if no memory is available for the tables
 253  */
 254 efi_status_t efi_smbios_register(void);
 255
 256 struct efi_simple_file_system_protocol *
 257 efi_fs_from_path(struct efi_device_path *fp);
 258
 259 /* Called by networking code to memorize the dhcp ack package */
 260 void efi_net_set_dhcp_ack(void *pkt, int len);
 261 /* Called by efi_set_watchdog_timer to reset the timer */
 262 efi_status_t efi_set_watchdog(unsigned long timeout);
 263
 264 /* Called from places to check whether a timer expired */
 265 void efi_timer_check(void);
 266 /* PE loader implementation */
 267 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
 268 /* Called once to store the pristine gd pointer */
 269 void efi_save_gd(void);
 270 /* Special case handler for error/abort that just tries to dtrt to get
 271  * back to u-boot world */
 272 void efi_restore_gd(void);
 273 /* Call this to relocate the runtime section to an address space */
 274 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
 275 /* Call this to set the current device name */
 276 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
 277 /* Add a new object to the object list. */
 278 void efi_add_handle(struct efi_object *obj);
 279 /* Create handle */
 280 efi_status_t efi_create_handle(efi_handle_t *handle);
 281 /* Delete handle */
 282 void efi_delete_handle(struct efi_object *obj);
 283 /* Call this to validate a handle and find the EFI object for it */
 284 struct efi_object *efi_search_obj(const efi_handle_t handle);
 285 /* Find a protocol on a handle */
 286 efi_status_t efi_search_protocol(const efi_handle_t handle,
 287                                  const efi_guid_t *protocol_guid,
 288                                  struct efi_handler **handler);
 289 /* Install new protocol on a handle */
 290 efi_status_t efi_add_protocol(const efi_handle_t handle,
 291                               const efi_guid_t *protocol,
 292                               void *protocol_interface);
 293 /* Delete protocol from a handle */
 294 efi_status_t efi_remove_protocol(const efi_handle_t handle,
 295                                  const efi_guid_t *protocol,
 296                                  void *protocol_interface);
 297 /* Delete all protocols from a handle */
 298 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
 299 /* Call this to create an event */
 300 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
 301                               void (EFIAPI *notify_function) (
 302                                         struct efi_event *event,
 303                                         void *context),
 304                               void *notify_context, efi_guid_t *group,
 305                               struct efi_event **event);
 306 /* Call this to set a timer */
 307 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 308                            uint64_t trigger_time);
 309 /* Call this to signal an event */
 310 void efi_signal_event(struct efi_event *event, bool check_tpl);
 311
 312 /* open file system: */
 313 struct efi_simple_file_system_protocol *efi_simple_file_system(
 314                 struct blk_desc *desc, int part, struct efi_device_path *dp);
 315
 316 /* open file from device-path: */
 317 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
 318
 319
 320 /* Generic EFI memory allocator, call this to get memory */
 321 void *efi_alloc(uint64_t len, int memory_type);
 322 /* More specific EFI memory allocator, called by EFI payloads */
 323 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
 324                                 uint64_t *memory);
 325 /* EFI memory free function. */
 326 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
 327 /* EFI memory allocator for small allocations */
 328 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
 329                                void **buffer);
 330 /* EFI pool memory free function. */
 331 efi_status_t efi_free_pool(void *buffer);
 332 /* Returns the EFI memory map */
 333 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
 334                                 struct efi_mem_desc *memory_map,
 335                                 efi_uintn_t *map_key,
 336                                 efi_uintn_t *descriptor_size,
 337                                 uint32_t *descriptor_version);
 338 /* Adds a range into the EFI memory map */
 339 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
 340                             bool overlap_only_ram);
 341 /* Called by board init to initialize the EFI drivers */
 342 efi_status_t efi_driver_init(void);
 343 /* Called by board init to initialize the EFI memory map */
 344 int efi_memory_init(void);
 345 /* Adds new or overrides configuration table entry to the system table */
 346 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
 347 /* Sets up a loaded image */
 348 efi_status_t efi_setup_loaded_image(
 349                         struct efi_loaded_image *info, struct efi_object *obj,
 350                         struct efi_device_path *device_path,
 351                         struct efi_device_path *file_path);
 352 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
 353                                       void **buffer);
 354 /* Print information about a loaded image */
 355 efi_status_t efi_print_image_info(struct efi_loaded_image *image, void *pc);
 356 /* Print information about all loaded images */
 357 void efi_print_image_infos(void *pc);
 358
 359 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 360 extern void *efi_bounce_buffer;
 361 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
 362 #endif
 363
 364
 365 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
 366 int efi_dp_match(const struct efi_device_path *a,
 367                  const struct efi_device_path *b);
 368 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
 369                                    struct efi_device_path **rem);
 370 /* get size of the first device path instance excluding end node */
 371 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
 372 /* size of multi-instance device path excluding end node */
 373 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
 374 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
 375 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
 376                                       const struct efi_device_path *dp2);
 377 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
 378                                            const struct efi_device_path *node);
 379 /* Create a device path node of given type, sub-type, length */
 380 struct efi_device_path *efi_dp_create_device_node(const u8 type,
 381                                                   const u8 sub_type,
 382                                                   const u16 length);
 383 /* Append device path instance */
 384 struct efi_device_path *efi_dp_append_instance(
 385                 const struct efi_device_path *dp,
 386                 const struct efi_device_path *dpi);
 387 /* Get next device path instance */
 388 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
 389                                                  efi_uintn_t *size);
 390 /* Check if a device path contains muliple instances */
 391 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
 392
 393 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
 394 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
 395 /* Create a device node for a block device partition. */
 396 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
 397 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
 398                                          const char *path);
 399 struct efi_device_path *efi_dp_from_eth(void);
 400 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
 401                                         uint64_t start_address,
 402                                         uint64_t end_address);
 403 /* Determine the last device path node that is not the end node. */
 404 const struct efi_device_path *efi_dp_last_node(
 405                         const struct efi_device_path *dp);
 406 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
 407                                     struct efi_device_path **device_path,
 408                                     struct efi_device_path **file_path);
 409
 410 #define EFI_DP_TYPE(_dp, _type, _subtype) \
 411         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
 412          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
 413
 414 /**
 415  * ascii2unicode() - convert ASCII string to UTF-16 string
 416  *
 417  * A zero terminated ASCII string is converted to a zero terminated UTF-16
 418  * string. The output buffer must be preassigned.
 419  *
 420  * @unicode:    preassigned output buffer for UTF-16 string
 421  * @ascii:      ASCII string to be converted
 422  */
 423 static inline void ascii2unicode(u16 *unicode, const char *ascii)
 424 {
 425         while (*ascii)
 426                 *(unicode++) = *(ascii++);
 427         *unicode = 0;
 428 }
 429
 430 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
 431 {
 432         return memcmp(g1, g2, sizeof(efi_guid_t));
 433 }
 434
 435 /*
 436  * Use these to indicate that your code / data should go into the EFI runtime
 437  * section and thus still be available when the OS is running
 438  */
 439 #define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
 440 #define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
 441
 442 /* Update CRC32 in table header */
 443 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
 444
 445 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
 446  * to make it available at runtime */
 447 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
 448
 449 /* Boards may provide the functions below to implement RTS functionality */
 450
 451 void __efi_runtime EFIAPI efi_reset_system(
 452                         enum efi_reset_type reset_type,
 453                         efi_status_t reset_status,
 454                         unsigned long data_size, void *reset_data);
 455
 456 /* Architecture specific initialization of the EFI subsystem */
 457 efi_status_t efi_reset_system_init(void);
 458
 459 efi_status_t __efi_runtime EFIAPI efi_get_time(
 460                         struct efi_time *time,
 461                         struct efi_time_cap *capabilities);
 462
 463 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 464 /*
 465  * Entry point for the tests of the EFI API.
 466  * It is called by 'bootefi selftest'
 467  */
 468 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
 469                                  struct efi_system_table *systab);
 470 #endif
 471
 472 efi_status_t EFIAPI efi_get_variable(u16 *variable_name, efi_guid_t *vendor,
 473                                      u32 *attributes, efi_uintn_t *data_size,
 474                                      void *data);
 475 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
 476                                                u16 *variable_name,
 477                                                efi_guid_t *vendor);
 478 efi_status_t EFIAPI efi_set_variable(u16 *variable_name, efi_guid_t *vendor,
 479                                      u32 attributes, efi_uintn_t data_size,
 480                                      void *data);
 481
 482 void *efi_bootmgr_load(struct efi_device_path **device_path,
 483                        struct efi_device_path **file_path);
 484
 485 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
 486
 487 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
 488 #define __efi_runtime_data
 489 #define __efi_runtime
 490 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
 491 {
 492         return EFI_SUCCESS;
 493 }
 494
 495 /* No loader configured, stub out EFI_ENTRY */
 496 static inline void efi_restore_gd(void) { }
 497 static inline void efi_set_bootdev(const char *dev, const char *devnr,
 498                                    const char *path) { }
 499 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
 500 static inline void efi_print_image_infos(void *pc) { }
 501
 502 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
 503
 504 #endif /* _EFI_LOADER_H */