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