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