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