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 GUID
  73  */
  74 #define EFI_PRINT_GUID(txt, guid) ({ \
  75         debug("%sEFI: %s %pUl\n", __efi_nesting(), txt, guid); \
  76         })
  77
  78 extern struct efi_runtime_services efi_runtime_services;
  79 extern struct efi_system_table systab;
  80
  81 extern const struct efi_simple_text_output_protocol efi_con_out;
  82 extern struct efi_simple_input_interface efi_con_in;
  83 extern const struct efi_console_control_protocol efi_console_control;
  84 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
  85
  86 uint16_t *efi_dp_str(struct efi_device_path *dp);
  87
  88 extern const efi_guid_t efi_global_variable_guid;
  89 extern const efi_guid_t efi_guid_console_control;
  90 extern const efi_guid_t efi_guid_device_path;
  91 extern const efi_guid_t efi_guid_loaded_image;
  92 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
  93 extern const efi_guid_t efi_simple_file_system_protocol_guid;
  94 extern const efi_guid_t efi_file_info_guid;
  95
  96 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
  97 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
  98
  99 /*
 100  * When the UEFI payload wants to open a protocol on an object to get its
 101  * interface (usually a struct with callback functions), this struct maps the
 102  * protocol GUID to the respective protocol interface */
 103 struct efi_handler {
 104         const efi_guid_t *guid;
 105         void *protocol_interface;
 106 };
 107
 108 /*
 109  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
 110  * multiple different protocols (classes) attached to it.
 111  *
 112  * This struct is the parent struct for all of our actual implementation objects
 113  * that can include it to make themselves an EFI object
 114  */
 115 struct efi_object {
 116         /* Every UEFI object is part of a global object list */
 117         struct list_head link;
 118         /* We support up to 16 "protocols" an object can be accessed through */
 119         struct efi_handler protocols[16];
 120         /* The object spawner can either use this for data or as identifier */
 121         void *handle;
 122 };
 123
 124 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){      \
 125         .protocols = {{                                                 \
 126                 .guid = &(_guid),                                       \
 127                 .protocol_interface = (void *)(_protocol),              \
 128         }},                                                             \
 129         .handle = (void *)(_protocol),                                  \
 130 }
 131
 132 /**
 133  * struct efi_event
 134  *
 135  * @type:               Type of event, see efi_create_event
 136  * @notify_tpl:         Task priority level of notifications
 137  * @trigger_time:       Period of the timer
 138  * @trigger_next:       Next time to trigger the timer
 139  * @nofify_function:    Function to call when the event is triggered
 140  * @notify_context:     Data to be passed to the notify function
 141  * @trigger_type:       Type of timer, see efi_set_timer
 142  * @queued:             The notification function is queued
 143  * @signaled:           The event occurred. The event is in the signaled state.
 144  */
 145 struct efi_event {
 146         uint32_t type;
 147         efi_uintn_t notify_tpl;
 148         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
 149         void *notify_context;
 150         u64 trigger_next;
 151         u64 trigger_time;
 152         enum efi_timer_delay trigger_type;
 153         bool is_queued;
 154         bool is_signaled;
 155 };
 156
 157
 158 /* This list contains all UEFI objects we know of */
 159 extern struct list_head efi_obj_list;
 160
 161 /* Called by bootefi to make console interface available */
 162 int efi_console_register(void);
 163 /* Called by bootefi to make all disk storage accessible as EFI objects */
 164 int efi_disk_register(void);
 165 /* Called by bootefi to make GOP (graphical) interface available */
 166 int efi_gop_register(void);
 167 /* Called by bootefi to make the network interface available */
 168 int efi_net_register(void);
 169 /* Called by bootefi to make the watchdog available */
 170 int efi_watchdog_register(void);
 171 /* Called by bootefi to make SMBIOS tables available */
 172 void efi_smbios_register(void);
 173
 174 struct efi_simple_file_system_protocol *
 175 efi_fs_from_path(struct efi_device_path *fp);
 176
 177 /* Called by networking code to memorize the dhcp ack package */
 178 void efi_net_set_dhcp_ack(void *pkt, int len);
 179 /* Called by efi_set_watchdog_timer to reset the timer */
 180 efi_status_t efi_set_watchdog(unsigned long timeout);
 181
 182 /* Called from places to check whether a timer expired */
 183 void efi_timer_check(void);
 184 /* PE loader implementation */
 185 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
 186 /* Called once to store the pristine gd pointer */
 187 void efi_save_gd(void);
 188 /* Special case handler for error/abort that just tries to dtrt to get
 189  * back to u-boot world */
 190 void efi_restore_gd(void);
 191 /* Call this to relocate the runtime section to an address space */
 192 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
 193 /* Call this to set the current device name */
 194 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
 195 /* Create handle */
 196 efi_status_t efi_create_handle(void **handle);
 197 /* Call this to validate a handle and find the EFI object for it */
 198 struct efi_object *efi_search_obj(const void *handle);
 199 /* Call this to create an event */
 200 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
 201                               void (EFIAPI *notify_function) (
 202                                         struct efi_event *event,
 203                                         void *context),
 204                               void *notify_context, struct efi_event **event);
 205 /* Call this to set a timer */
 206 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 207                            uint64_t trigger_time);
 208 /* Call this to signal an event */
 209 void efi_signal_event(struct efi_event *event);
 210
 211 /* open file system: */
 212 struct efi_simple_file_system_protocol *efi_simple_file_system(
 213                 struct blk_desc *desc, int part, struct efi_device_path *dp);
 214
 215 /* open file from device-path: */
 216 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
 217
 218
 219 /* Generic EFI memory allocator, call this to get memory */
 220 void *efi_alloc(uint64_t len, int memory_type);
 221 /* More specific EFI memory allocator, called by EFI payloads */
 222 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
 223                                 uint64_t *memory);
 224 /* EFI memory free function. */
 225 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
 226 /* EFI memory allocator for small allocations */
 227 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
 228                                void **buffer);
 229 /* EFI pool memory free function. */
 230 efi_status_t efi_free_pool(void *buffer);
 231 /* Returns the EFI memory map */
 232 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
 233                                 struct efi_mem_desc *memory_map,
 234                                 efi_uintn_t *map_key,
 235                                 efi_uintn_t *descriptor_size,
 236                                 uint32_t *descriptor_version);
 237 /* Adds a range into the EFI memory map */
 238 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
 239                             bool overlap_only_ram);
 240 /* Called by board init to initialize the EFI memory map */
 241 int efi_memory_init(void);
 242 /* Adds new or overrides configuration table entry to the system table */
 243 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
 244 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
 245                             struct efi_device_path *device_path,
 246                             struct efi_device_path *file_path);
 247 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
 248                                       void **buffer);
 249
 250 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 251 extern void *efi_bounce_buffer;
 252 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
 253 #endif
 254
 255
 256 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
 257 int efi_dp_match(const struct efi_device_path *a,
 258                  const struct efi_device_path *b);
 259 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
 260                                    struct efi_device_path **rem);
 261 unsigned efi_dp_size(const struct efi_device_path *dp);
 262 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
 263 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
 264                                       const struct efi_device_path *dp2);
 265 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
 266                                            const struct efi_device_path *node);
 267
 268
 269 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
 270 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
 271 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
 272                                          const char *path);
 273 struct efi_device_path *efi_dp_from_eth(void);
 274 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
 275                                         uint64_t start_address,
 276                                         uint64_t end_address);
 277 void efi_dp_split_file_path(struct efi_device_path *full_path,
 278                             struct efi_device_path **device_path,
 279                             struct efi_device_path **file_path);
 280
 281 #define EFI_DP_TYPE(_dp, _type, _subtype) \
 282         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
 283          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
 284
 285 /* Convert strings from normal C strings to uEFI strings */
 286 static inline void ascii2unicode(u16 *unicode, const char *ascii)
 287 {
 288         while (*ascii)
 289                 *(unicode++) = *(ascii++);
 290 }
 291
 292 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
 293 {
 294         return memcmp(g1, g2, sizeof(efi_guid_t));
 295 }
 296
 297 /*
 298  * Use these to indicate that your code / data should go into the EFI runtime
 299  * section and thus still be available when the OS is running
 300  */
 301 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
 302 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
 303
 304 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
 305  * to make it available at runtime */
 306 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
 307
 308 /* Boards may provide the functions below to implement RTS functionality */
 309
 310 void __efi_runtime EFIAPI efi_reset_system(
 311                         enum efi_reset_type reset_type,
 312                         efi_status_t reset_status,
 313                         unsigned long data_size, void *reset_data);
 314 void efi_reset_system_init(void);
 315
 316 efi_status_t __efi_runtime EFIAPI efi_get_time(
 317                         struct efi_time *time,
 318                         struct efi_time_cap *capabilities);
 319 void efi_get_time_init(void);
 320
 321 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 322 /*
 323  * Entry point for the tests of the EFI API.
 324  * It is called by 'bootefi selftest'
 325  */
 326 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
 327                                  struct efi_system_table *systab);
 328 #endif
 329
 330 efi_status_t EFIAPI efi_get_variable(s16 *variable_name,
 331                 efi_guid_t *vendor, u32 *attributes,
 332                 unsigned long *data_size, void *data);
 333 efi_status_t EFIAPI efi_get_next_variable(
 334                 unsigned long *variable_name_size,
 335                 s16 *variable_name, efi_guid_t *vendor);
 336 efi_status_t EFIAPI efi_set_variable(s16 *variable_name,
 337                 efi_guid_t *vendor, u32 attributes,
 338                 unsigned long data_size, void *data);
 339
 340 void *efi_bootmgr_load(struct efi_device_path **device_path,
 341                        struct efi_device_path **file_path);
 342
 343 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
 344
 345 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
 346 #define __efi_runtime_data
 347 #define __efi_runtime
 348 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
 349
 350 /* No loader configured, stub out EFI_ENTRY */
 351 static inline void efi_restore_gd(void) { }
 352 static inline void efi_set_bootdev(const char *dev, const char *devnr,
 353                                    const char *path) { }
 354 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
 355
 356 #endif /* CONFIG_EFI_LOADER && !CONFIG_SPL_BUILD */
 357
 358 #endif /* _EFI_LOADER_H */