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