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