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