git.sur5r.net Git - u-boot/blob - include/efi_loader.h

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