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 * Call non-void UEFI function from u-boot and retrieve return value: 46 */ 47 #define EFI_CALL(exp) ({ \ 48 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \ 49 assert(__efi_exit_check()); \ 50 typeof(exp) _r = exp; \ 51 assert(__efi_entry_check()); \ 52 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \ 53 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \ 54 _r; \ 55 }) 56 57 /* 58 * Call void UEFI function from u-boot: 59 */ 60 #define EFI_CALL_VOID(exp) do { \ 61 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \ 62 assert(__efi_exit_check()); \ 63 exp; \ 64 assert(__efi_entry_check()); \ 65 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \ 66 } while(0) 67 68 /* 69 * Write GUID 70 */ 71 #define EFI_PRINT_GUID(txt, guid) ({ \ 72 debug("%sEFI: %s %pUl\n", __efi_nesting(), txt, guid); \ 73 }) 74 75 extern struct efi_runtime_services efi_runtime_services; 76 extern struct efi_system_table systab; 77 78 extern const struct efi_simple_text_output_protocol efi_con_out; 79 extern struct efi_simple_input_interface efi_con_in; 80 extern const struct efi_console_control_protocol efi_console_control; 81 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text; 82 83 uint16_t *efi_dp_str(struct efi_device_path *dp); 84 85 extern const efi_guid_t efi_global_variable_guid; 86 extern const efi_guid_t efi_guid_console_control; 87 extern const efi_guid_t efi_guid_device_path; 88 extern const efi_guid_t efi_guid_loaded_image; 89 extern const efi_guid_t efi_guid_device_path_to_text_protocol; 90 extern const efi_guid_t efi_simple_file_system_protocol_guid; 91 extern const efi_guid_t efi_file_info_guid; 92 93 extern unsigned int __efi_runtime_start, __efi_runtime_stop; 94 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop; 95 96 /* 97 * When the UEFI payload wants to open a protocol on an object to get its 98 * interface (usually a struct with callback functions), this struct maps the 99 * protocol GUID to the respective protocol interface */ 100 struct efi_handler { 101 const efi_guid_t *guid; 102 void *protocol_interface; 103 }; 104 105 /* 106 * UEFI has a poor man's OO model where one "object" can be polymorphic and have 107 * multiple different protocols (classes) attached to it. 108 * 109 * This struct is the parent struct for all of our actual implementation objects 110 * that can include it to make themselves an EFI object 111 */ 112 struct efi_object { 113 /* Every UEFI object is part of a global object list */ 114 struct list_head link; 115 /* We support up to 16 "protocols" an object can be accessed through */ 116 struct efi_handler protocols[16]; 117 /* The object spawner can either use this for data or as identifier */ 118 void *handle; 119 }; 120 121 #define EFI_PROTOCOL_OBJECT(_guid, _protocol) (struct efi_object){ \ 122 .protocols = {{ \ 123 .guid = &(_guid), \ 124 .protocol_interface = (void *)(_protocol), \ 125 }}, \ 126 .handle = (void *)(_protocol), \ 127 } 128 129 /** 130 * struct efi_event 131 * 132 * @type: Type of event, see efi_create_event 133 * @notify_tpl: Task priority level of notifications 134 * @trigger_time: Period of the timer 135 * @trigger_next: Next time to trigger the timer 136 * @nofify_function: Function to call when the event is triggered 137 * @notify_context: Data to be passed to the notify function 138 * @trigger_type: Type of timer, see efi_set_timer 139 * @queued: The notification function is queued 140 * @signaled: The event occurred. The event is in the signaled state. 141 */ 142 struct efi_event { 143 uint32_t type; 144 UINTN notify_tpl; 145 void (EFIAPI *notify_function)(struct efi_event *event, void *context); 146 void *notify_context; 147 u64 trigger_next; 148 u64 trigger_time; 149 enum efi_timer_delay trigger_type; 150 bool is_queued; 151 bool is_signaled; 152 }; 153 154 155 /* This list contains all UEFI objects we know of */ 156 extern struct list_head efi_obj_list; 157 158 /* Called by bootefi to make console interface available */ 159 int efi_console_register(void); 160 /* Called by bootefi to make all disk storage accessible as EFI objects */ 161 int efi_disk_register(void); 162 /* Called by bootefi to make GOP (graphical) interface available */ 163 int efi_gop_register(void); 164 /* Called by bootefi to make the network interface available */ 165 int efi_net_register(void); 166 /* Called by bootefi to make SMBIOS tables available */ 167 void efi_smbios_register(void); 168 169 struct efi_simple_file_system_protocol * 170 efi_fs_from_path(struct efi_device_path *fp); 171 172 /* Called by networking code to memorize the dhcp ack package */ 173 void efi_net_set_dhcp_ack(void *pkt, int len); 174 175 /* Called from places to check whether a timer expired */ 176 void efi_timer_check(void); 177 /* PE loader implementation */ 178 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info); 179 /* Called once to store the pristine gd pointer */ 180 void efi_save_gd(void); 181 /* Special case handler for error/abort that just tries to dtrt to get 182 * back to u-boot world */ 183 void efi_restore_gd(void); 184 /* Call this to relocate the runtime section to an address space */ 185 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map); 186 /* Call this to set the current device name */ 187 void efi_set_bootdev(const char *dev, const char *devnr, const char *path); 188 /* Call this to create an event */ 189 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl, 190 void (EFIAPI *notify_function) ( 191 struct efi_event *event, 192 void *context), 193 void *notify_context, struct efi_event **event); 194 /* Call this to set a timer */ 195 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type, 196 uint64_t trigger_time); 197 /* Call this to signal an event */ 198 void efi_signal_event(struct efi_event *event); 199 200 /* open file system: */ 201 struct efi_simple_file_system_protocol *efi_simple_file_system( 202 struct blk_desc *desc, int part, struct efi_device_path *dp); 203 204 /* open file from device-path: */ 205 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp); 206 207 208 /* Generic EFI memory allocator, call this to get memory */ 209 void *efi_alloc(uint64_t len, int memory_type); 210 /* More specific EFI memory allocator, called by EFI payloads */ 211 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages, 212 uint64_t *memory); 213 /* EFI memory free function. */ 214 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages); 215 /* EFI memory allocator for small allocations */ 216 efi_status_t efi_allocate_pool(int pool_type, unsigned long size, 217 void **buffer); 218 /* EFI pool memory free function. */ 219 efi_status_t efi_free_pool(void *buffer); 220 /* Returns the EFI memory map */ 221 efi_status_t efi_get_memory_map(unsigned long *memory_map_size, 222 struct efi_mem_desc *memory_map, 223 unsigned long *map_key, 224 unsigned long *descriptor_size, 225 uint32_t *descriptor_version); 226 /* Adds a range into the EFI memory map */ 227 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type, 228 bool overlap_only_ram); 229 /* Called by board init to initialize the EFI memory map */ 230 int efi_memory_init(void); 231 /* Adds new or overrides configuration table entry to the system table */ 232 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table); 233 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj, 234 struct efi_device_path *device_path, 235 struct efi_device_path *file_path); 236 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path, 237 void **buffer); 238 239 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER 240 extern void *efi_bounce_buffer; 241 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024) 242 #endif 243 244 245 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp); 246 int efi_dp_match(struct efi_device_path *a, struct efi_device_path *b); 247 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp, 248 struct efi_device_path **rem); 249 unsigned efi_dp_size(const struct efi_device_path *dp); 250 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp); 251 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1, 252 const struct efi_device_path *dp2); 253 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp, 254 const struct efi_device_path *node); 255 256 257 struct efi_device_path *efi_dp_from_dev(struct udevice *dev); 258 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part); 259 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part, 260 const char *path); 261 struct efi_device_path *efi_dp_from_eth(void); 262 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type, 263 uint64_t start_address, 264 uint64_t end_address); 265 void efi_dp_split_file_path(struct efi_device_path *full_path, 266 struct efi_device_path **device_path, 267 struct efi_device_path **file_path); 268 269 #define EFI_DP_TYPE(_dp, _type, _subtype) \ 270 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \ 271 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype)) 272 273 /* Convert strings from normal C strings to uEFI strings */ 274 static inline void ascii2unicode(u16 *unicode, const char *ascii) 275 { 276 while (*ascii) 277 *(unicode++) = *(ascii++); 278 } 279 280 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2) 281 { 282 return memcmp(g1, g2, sizeof(efi_guid_t)); 283 } 284 285 /* 286 * Use these to indicate that your code / data should go into the EFI runtime 287 * section and thus still be available when the OS is running 288 */ 289 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data"))) 290 #define __efi_runtime __attribute__ ((section ("efi_runtime_text"))) 291 292 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region 293 * to make it available at runtime */ 294 void efi_add_runtime_mmio(void *mmio_ptr, u64 len); 295 296 /* Boards may provide the functions below to implement RTS functionality */ 297 298 void __efi_runtime EFIAPI efi_reset_system( 299 enum efi_reset_type reset_type, 300 efi_status_t reset_status, 301 unsigned long data_size, void *reset_data); 302 void efi_reset_system_init(void); 303 304 efi_status_t __efi_runtime EFIAPI efi_get_time( 305 struct efi_time *time, 306 struct efi_time_cap *capabilities); 307 void efi_get_time_init(void); 308 309 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST 310 /* 311 * Entry point for the tests of the EFI API. 312 * It is called by 'bootefi selftest' 313 */ 314 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle, 315 struct efi_system_table *systab); 316 #endif 317 318 efi_status_t EFIAPI efi_get_variable(s16 *variable_name, 319 efi_guid_t *vendor, u32 *attributes, 320 unsigned long *data_size, void *data); 321 efi_status_t EFIAPI efi_get_next_variable( 322 unsigned long *variable_name_size, 323 s16 *variable_name, efi_guid_t *vendor); 324 efi_status_t EFIAPI efi_set_variable(s16 *variable_name, 325 efi_guid_t *vendor, u32 attributes, 326 unsigned long data_size, void *data); 327 328 void *efi_bootmgr_load(struct efi_device_path **device_path, 329 struct efi_device_path **file_path); 330 331 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */ 332 333 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */ 334 #define __efi_runtime_data 335 #define __efi_runtime 336 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { } 337 338 /* No loader configured, stub out EFI_ENTRY */ 339 static inline void efi_restore_gd(void) { } 340 static inline void efi_set_bootdev(const char *dev, const char *devnr, 341 const char *path) { } 342 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { } 343 344 #endif 345