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