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