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