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 #include <common.h>
  10 #include <part_efi.h>
  11 #include <efi_api.h>
  12
  13 /* No need for efi loader support in SPL */
  14 #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
  15
  16 #include <linux/list.h>
  17
  18 int __efi_entry_check(void);
  19 int __efi_exit_check(void);
  20 const char *__efi_nesting(void);
  21 const char *__efi_nesting_inc(void);
  22 const char *__efi_nesting_dec(void);
  23
  24 /*
  25  * Enter the u-boot world from UEFI:
  26  */
  27 #define EFI_ENTRY(format, ...) do { \
  28         assert(__efi_entry_check()); \
  29         debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
  30                 __func__, ##__VA_ARGS__); \
  31         } while(0)
  32
  33 /*
  34  * Exit the u-boot world back to UEFI:
  35  */
  36 #define EFI_EXIT(ret) ({ \
  37         typeof(ret) _r = ret; \
  38         debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
  39                 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
  40         assert(__efi_exit_check()); \
  41         _r; \
  42         })
  43
  44 /*
  45  * Call non-void UEFI function from u-boot and retrieve return value:
  46  */
  47 #define EFI_CALL(exp) ({ \
  48         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  49         assert(__efi_exit_check()); \
  50         typeof(exp) _r = exp; \
  51         assert(__efi_entry_check()); \
  52         debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
  53               (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
  54         _r; \
  55 })
  56
  57 /*
  58  * Call void UEFI function from u-boot:
  59  */
  60 #define EFI_CALL_VOID(exp) do { \
  61         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  62         assert(__efi_exit_check()); \
  63         exp; \
  64         assert(__efi_entry_check()); \
  65         debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
  66         } while(0)
  67
  68 /*
  69  * Write GUID
  70  */
  71 #define EFI_PRINT_GUID(txt, guid) ({ \
  72         debug("%sEFI: %s %pUl\n", __efi_nesting(), txt, guid); \
  73         })
  74
  75 extern struct efi_runtime_services efi_runtime_services;
  76 extern struct efi_system_table systab;
  77
  78 extern const struct efi_simple_text_output_protocol efi_con_out;
  79 extern struct efi_simple_input_interface efi_con_in;
  80 extern const struct efi_console_control_protocol efi_console_control;
  81 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
  82
  83 extern const efi_guid_t efi_guid_console_control;
  84 extern const efi_guid_t efi_guid_device_path;
  85 extern const efi_guid_t efi_guid_loaded_image;
  86 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
  87
  88 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
  89 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
  90
  91 /*
  92  * When the UEFI payload wants to open a protocol on an object to get its
  93  * interface (usually a struct with callback functions), this struct maps the
  94  * protocol GUID to the respective protocol interface */
  95 struct efi_handler {
  96         const efi_guid_t *guid;
  97         void *protocol_interface;
  98 };
  99
 100 /*
 101  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
 102  * multiple different protocols (classes) attached to it.
 103  *
 104  * This struct is the parent struct for all of our actual implementation objects
 105  * that can include it to make themselves an EFI object
 106  */
 107 struct efi_object {
 108         /* Every UEFI object is part of a global object list */
 109         struct list_head link;
 110         /* We support up to 8 "protocols" an object can be accessed through */
 111         struct efi_handler protocols[8];
 112         /* The object spawner can either use this for data or as identifier */
 113         void *handle;
 114 };
 115
 116 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){      \
 117         .protocols = {{                                                 \
 118                 .guid = &(_guid),                                       \
 119                 .protocol_interface = (void *)(_protocol),              \
 120         }},                                                             \
 121         .handle = (void *)(_protocol),                                  \
 122 }
 123
 124 /**
 125  * struct efi_event
 126  *
 127  * @type:               Type of event, see efi_create_event
 128  * @notify_tpl:         Task priority level of notifications
 129  * @trigger_time:       Period of the timer
 130  * @trigger_next:       Next time to trigger the timer
 131  * @nofify_function:    Function to call when the event is triggered
 132  * @notify_context:     Data to be passed to the notify function
 133  * @trigger_type:       Type of timer, see efi_set_timer
 134  * @queued:             The notification functionis queued
 135  * @signaled:           The event occured
 136  */
 137 struct efi_event {
 138         uint32_t type;
 139         UINTN notify_tpl;
 140         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
 141         void *notify_context;
 142         u64 trigger_next;
 143         u64 trigger_time;
 144         enum efi_timer_delay trigger_type;
 145         int queued;
 146         int signaled;
 147 };
 148
 149
 150 /* This list contains all UEFI objects we know of */
 151 extern struct list_head efi_obj_list;
 152
 153 /* Called by bootefi to make console interface available */
 154 int efi_console_register(void);
 155 /* Called by bootefi to make all disk storage accessible as EFI objects */
 156 int efi_disk_register(void);
 157 /* Called by bootefi to make GOP (graphical) interface available */
 158 int efi_gop_register(void);
 159 /* Called by bootefi to make the network interface available */
 160 int efi_net_register(void **handle);
 161 /* Called by bootefi to make SMBIOS tables available */
 162 void efi_smbios_register(void);
 163
 164 /* Called by networking code to memorize the dhcp ack package */
 165 void efi_net_set_dhcp_ack(void *pkt, int len);
 166
 167 /* Called from places to check whether a timer expired */
 168 void efi_timer_check(void);
 169 /* PE loader implementation */
 170 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
 171 /* Called once to store the pristine gd pointer */
 172 void efi_save_gd(void);
 173 /* Special case handler for error/abort that just tries to dtrt to get
 174  * back to u-boot world */
 175 void efi_restore_gd(void);
 176 /* Call this to relocate the runtime section to an address space */
 177 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
 178 /* Call this to set the current device name */
 179 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
 180 /* Call this to create an event */
 181 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
 182                               void (EFIAPI *notify_function) (
 183                                         struct efi_event *event,
 184                                         void *context),
 185                               void *notify_context, struct efi_event **event);
 186 /* Call this to set a timer */
 187 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 188                            uint64_t trigger_time);
 189 /* Call this to signal an event */
 190 void efi_signal_event(struct efi_event *event);
 191
 192 /* Generic EFI memory allocator, call this to get memory */
 193 void *efi_alloc(uint64_t len, int memory_type);
 194 /* More specific EFI memory allocator, called by EFI payloads */
 195 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
 196                                 uint64_t *memory);
 197 /* EFI memory free function. */
 198 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
 199 /* EFI memory allocator for small allocations */
 200 efi_status_t efi_allocate_pool(int pool_type, unsigned long size,
 201                                void **buffer);
 202 /* EFI pool memory free function. */
 203 efi_status_t efi_free_pool(void *buffer);
 204 /* Returns the EFI memory map */
 205 efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
 206                                 struct efi_mem_desc *memory_map,
 207                                 unsigned long *map_key,
 208                                 unsigned long *descriptor_size,
 209                                 uint32_t *descriptor_version);
 210 /* Adds a range into the EFI memory map */
 211 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
 212                             bool overlap_only_ram);
 213 /* Called by board init to initialize the EFI memory map */
 214 int efi_memory_init(void);
 215 /* Adds new or overrides configuration table entry to the system table */
 216 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
 217
 218 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 219 extern void *efi_bounce_buffer;
 220 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
 221 #endif
 222
 223
 224 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
 225 int efi_dp_match(struct efi_device_path *a, struct efi_device_path *b);
 226 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
 227                                    struct efi_device_path **rem);
 228 unsigned efi_dp_size(const struct efi_device_path *dp);
 229 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
 230 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
 231                                       const struct efi_device_path *dp2);
 232 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
 233                                            const struct efi_device_path *node);
 234
 235
 236 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
 237 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
 238 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
 239                                          const char *path);
 240 struct efi_device_path *efi_dp_from_eth(void);
 241 void efi_dp_split_file_path(struct efi_device_path *full_path,
 242                             struct efi_device_path **device_path,
 243                             struct efi_device_path **file_path);
 244
 245 #define EFI_DP_TYPE(_dp, _type, _subtype) \
 246         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
 247          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
 248
 249 /* Convert strings from normal C strings to uEFI strings */
 250 static inline void ascii2unicode(u16 *unicode, const char *ascii)
 251 {
 252         while (*ascii)
 253                 *(unicode++) = *(ascii++);
 254 }
 255
 256 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
 257 {
 258         return memcmp(g1, g2, sizeof(efi_guid_t));
 259 }
 260
 261 /*
 262  * Use these to indicate that your code / data should go into the EFI runtime
 263  * section and thus still be available when the OS is running
 264  */
 265 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
 266 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
 267
 268 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
 269  * to make it available at runtime */
 270 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
 271
 272 /* Boards may provide the functions below to implement RTS functionality */
 273
 274 void __efi_runtime EFIAPI efi_reset_system(
 275                         enum efi_reset_type reset_type,
 276                         efi_status_t reset_status,
 277                         unsigned long data_size, void *reset_data);
 278 void efi_reset_system_init(void);
 279
 280 efi_status_t __efi_runtime EFIAPI efi_get_time(
 281                         struct efi_time *time,
 282                         struct efi_time_cap *capabilities);
 283 void efi_get_time_init(void);
 284
 285 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 286 /*
 287  * Entry point for the tests of the EFI API.
 288  * It is called by 'bootefi selftest'
 289  */
 290 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
 291                                  struct efi_system_table *systab);
 292 #endif
 293
 294 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
 295
 296 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
 297 #define __efi_runtime_data
 298 #define __efi_runtime
 299 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
 300
 301 /* No loader configured, stub out EFI_ENTRY */
 302 static inline void efi_restore_gd(void) { }
 303 static inline void efi_set_bootdev(const char *dev, const char *devnr,
 304                                    const char *path) { }
 305 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
 306
 307 #endif