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