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  * Callback into UEFI world from u-boot:
  46  */
  47 #define EFI_CALL(exp) do { \
  48         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  49         assert(__efi_exit_check()); \
  50         exp; \
  51         assert(__efi_entry_check()); \
  52         debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
  53         } while(0)
  54
  55 /*
  56  * Write GUID
  57  */
  58 #define EFI_PRINT_GUID(txt, guid) ({ \
  59         debug("%sEFI: %s %pUl\n", __efi_nesting(), txt, guid); \
  60         })
  61
  62 extern struct efi_runtime_services efi_runtime_services;
  63 extern struct efi_system_table systab;
  64
  65 extern const struct efi_simple_text_output_protocol efi_con_out;
  66 extern struct efi_simple_input_interface efi_con_in;
  67 extern const struct efi_console_control_protocol efi_console_control;
  68 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
  69
  70 extern const efi_guid_t efi_guid_console_control;
  71 extern const efi_guid_t efi_guid_device_path;
  72 extern const efi_guid_t efi_guid_loaded_image;
  73 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
  74
  75 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
  76 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
  77
  78 /*
  79  * When the UEFI payload wants to open a protocol on an object to get its
  80  * interface (usually a struct with callback functions), this struct maps the
  81  * protocol GUID to the respective protocol interface */
  82 struct efi_handler {
  83         const efi_guid_t *guid;
  84         void *protocol_interface;
  85 };
  86
  87 /*
  88  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
  89  * multiple different protocols (classes) attached to it.
  90  *
  91  * This struct is the parent struct for all of our actual implementation objects
  92  * that can include it to make themselves an EFI object
  93  */
  94 struct efi_object {
  95         /* Every UEFI object is part of a global object list */
  96         struct list_head link;
  97         /* We support up to 8 "protocols" an object can be accessed through */
  98         struct efi_handler protocols[8];
  99         /* The object spawner can either use this for data or as identifier */
 100         void *handle;
 101 };
 102
 103 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){      \
 104         .protocols = {{                                                 \
 105                 .guid = &(_guid),                                       \
 106                 .protocol_interface = (void *)(_protocol),              \
 107         }},                                                             \
 108         .handle = (void *)(_protocol),                                  \
 109 }
 110
 111 /**
 112  * struct efi_event
 113  *
 114  * @type:               Type of event, see efi_create_event
 115  * @notify_tpl:         Task priority level of notifications
 116  * @trigger_time:       Period of the timer
 117  * @trigger_next:       Next time to trigger the timer
 118  * @nofify_function:    Function to call when the event is triggered
 119  * @notify_context:     Data to be passed to the notify function
 120  * @trigger_type:       Type of timer, see efi_set_timer
 121  * @signaled:           The notify function was already called
 122  */
 123 struct efi_event {
 124         uint32_t type;
 125         UINTN notify_tpl;
 126         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
 127         void *notify_context;
 128         u64 trigger_next;
 129         u64 trigger_time;
 130         enum efi_timer_delay trigger_type;
 131         int signaled;
 132 };
 133
 134
 135 /* This list contains all UEFI objects we know of */
 136 extern struct list_head efi_obj_list;
 137
 138 /* Called by bootefi to make console interface available */
 139 int efi_console_register(void);
 140 /* Called by bootefi to make all disk storage accessible as EFI objects */
 141 int efi_disk_register(void);
 142 /* Called by bootefi to make GOP (graphical) interface available */
 143 int efi_gop_register(void);
 144 /* Called by bootefi to make the network interface available */
 145 int efi_net_register(void **handle);
 146 /* Called by bootefi to make SMBIOS tables available */
 147 void efi_smbios_register(void);
 148
 149 /* Called by networking code to memorize the dhcp ack package */
 150 void efi_net_set_dhcp_ack(void *pkt, int len);
 151
 152 /* Called from places to check whether a timer expired */
 153 void efi_timer_check(void);
 154 /* PE loader implementation */
 155 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
 156 /* Called once to store the pristine gd pointer */
 157 void efi_save_gd(void);
 158 /* Special case handler for error/abort that just tries to dtrt to get
 159  * back to u-boot world */
 160 void efi_restore_gd(void);
 161 /* Call this to relocate the runtime section to an address space */
 162 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
 163 /* Call this to set the current device name */
 164 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
 165 /* Call this to create an event */
 166 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
 167                               void (EFIAPI *notify_function) (
 168                                         struct efi_event *event,
 169                                         void *context),
 170                               void *notify_context, struct efi_event **event);
 171 /* Call this to set a timer */
 172 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
 173                            uint64_t trigger_time);
 174 /* Call this to signal an event */
 175 void efi_signal_event(struct efi_event *event);
 176
 177 /* Generic EFI memory allocator, call this to get memory */
 178 void *efi_alloc(uint64_t len, int memory_type);
 179 /* More specific EFI memory allocator, called by EFI payloads */
 180 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
 181                                 uint64_t *memory);
 182 /* EFI memory free function. */
 183 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
 184 /* EFI memory allocator for small allocations */
 185 efi_status_t efi_allocate_pool(int pool_type, unsigned long size,
 186                                void **buffer);
 187 /* EFI pool memory free function. */
 188 efi_status_t efi_free_pool(void *buffer);
 189 /* Returns the EFI memory map */
 190 efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
 191                                 struct efi_mem_desc *memory_map,
 192                                 unsigned long *map_key,
 193                                 unsigned long *descriptor_size,
 194                                 uint32_t *descriptor_version);
 195 /* Adds a range into the EFI memory map */
 196 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
 197                             bool overlap_only_ram);
 198 /* Called by board init to initialize the EFI memory map */
 199 int efi_memory_init(void);
 200 /* Adds new or overrides configuration table entry to the system table */
 201 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
 202
 203 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 204 extern void *efi_bounce_buffer;
 205 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
 206 #endif
 207
 208 /* Convert strings from normal C strings to uEFI strings */
 209 static inline void ascii2unicode(u16 *unicode, const char *ascii)
 210 {
 211         while (*ascii)
 212                 *(unicode++) = *(ascii++);
 213 }
 214
 215 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
 216 {
 217         return memcmp(g1, g2, sizeof(efi_guid_t));
 218 }
 219
 220 /*
 221  * Use these to indicate that your code / data should go into the EFI runtime
 222  * section and thus still be available when the OS is running
 223  */
 224 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
 225 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
 226
 227 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
 228  * to make it available at runtime */
 229 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
 230
 231 /* Boards may provide the functions below to implement RTS functionality */
 232
 233 void __efi_runtime EFIAPI efi_reset_system(
 234                         enum efi_reset_type reset_type,
 235                         efi_status_t reset_status,
 236                         unsigned long data_size, void *reset_data);
 237 void efi_reset_system_init(void);
 238
 239 efi_status_t __efi_runtime EFIAPI efi_get_time(
 240                         struct efi_time *time,
 241                         struct efi_time_cap *capabilities);
 242 void efi_get_time_init(void);
 243
 244 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
 245
 246 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
 247 #define __efi_runtime_data
 248 #define __efi_runtime
 249 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
 250
 251 /* No loader configured, stub out EFI_ENTRY */
 252 static inline void efi_restore_gd(void) { }
 253 static inline void efi_set_bootdev(const char *dev, const char *devnr,
 254                                    const char *path) { }
 255 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
 256
 257 #endif