1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
9 #define _EFI_LOADER_H 1
15 /* No need for efi loader support in SPL */
16 #if CONFIG_IS_ENABLED(EFI_LOADER)
18 #include <linux/list.h>
20 /* Maximum number of configuration tables */
21 #define EFI_MAX_CONFIGURATION_TABLES 16
23 /* GUID used by the root node */
25 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
26 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
29 extern efi_handle_t efi_root;
31 int __efi_entry_check(void);
32 int __efi_exit_check(void);
33 const char *__efi_nesting(void);
34 const char *__efi_nesting_inc(void);
35 const char *__efi_nesting_dec(void);
38 * Enter the u-boot world from UEFI:
40 #define EFI_ENTRY(format, ...) do { \
41 assert(__efi_entry_check()); \
42 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
43 __func__, ##__VA_ARGS__); \
47 * Exit the u-boot world back to UEFI:
49 #define EFI_EXIT(ret) ({ \
50 typeof(ret) _r = ret; \
51 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
52 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
53 assert(__efi_exit_check()); \
58 * Call non-void UEFI function from u-boot and retrieve return value:
60 #define EFI_CALL(exp) ({ \
61 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
62 assert(__efi_exit_check()); \
63 typeof(exp) _r = exp; \
64 assert(__efi_entry_check()); \
65 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
66 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
71 * Call void UEFI function from u-boot:
73 #define EFI_CALL_VOID(exp) do { \
74 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
75 assert(__efi_exit_check()); \
77 assert(__efi_entry_check()); \
78 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
82 * Write an indented message with EFI prefix
84 #define EFI_PRINT(format, ...) ({ \
85 debug("%sEFI: " format, __efi_nesting(), \
89 #ifdef CONFIG_SYS_CACHELINE_SIZE
90 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
92 /* Just use the greatest cache flush alignment requirement I'm aware of */
93 #define EFI_CACHELINE_SIZE 128
96 /* Key identifying current memory map */
97 extern efi_uintn_t efi_memory_map_key;
99 extern struct efi_runtime_services efi_runtime_services;
100 extern struct efi_system_table systab;
102 extern struct efi_simple_text_output_protocol efi_con_out;
103 extern struct efi_simple_text_input_protocol efi_con_in;
104 extern struct efi_console_control_protocol efi_console_control;
105 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
106 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
107 extern const struct efi_device_path_utilities_protocol
108 efi_device_path_utilities;
109 /* Implementation of the EFI_UNICODE_COLLATION_PROTOCOL */
110 extern const struct efi_unicode_collation_protocol
111 efi_unicode_collation_protocol;
112 extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
113 extern const struct efi_hii_config_access_protocol efi_hii_config_access;
114 extern const struct efi_hii_database_protocol efi_hii_database;
115 extern const struct efi_hii_string_protocol efi_hii_string;
117 uint16_t *efi_dp_str(struct efi_device_path *dp);
119 /* GUID of the U-Boot root node */
120 extern const efi_guid_t efi_u_boot_guid;
121 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
122 extern const efi_guid_t efi_block_io_guid;
123 extern const efi_guid_t efi_global_variable_guid;
124 extern const efi_guid_t efi_guid_console_control;
125 extern const efi_guid_t efi_guid_device_path;
126 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
127 extern const efi_guid_t efi_guid_driver_binding_protocol;
128 /* event group ExitBootServices() invoked */
129 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
130 /* event group SetVirtualAddressMap() invoked */
131 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
132 /* event group memory map changed */
133 extern const efi_guid_t efi_guid_event_group_memory_map_change;
134 /* event group boot manager about to boot */
135 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
136 /* event group ResetSystem() invoked (before ExitBootServices) */
137 extern const efi_guid_t efi_guid_event_group_reset_system;
138 /* GUID of the device tree table */
139 extern const efi_guid_t efi_guid_fdt;
140 extern const efi_guid_t efi_guid_loaded_image;
141 extern const efi_guid_t efi_guid_loaded_image_device_path;
142 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
143 extern const efi_guid_t efi_simple_file_system_protocol_guid;
144 extern const efi_guid_t efi_file_info_guid;
145 /* GUID for file system information */
146 extern const efi_guid_t efi_file_system_info_guid;
147 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
148 /* GUID of the Unicode collation protocol */
149 extern const efi_guid_t efi_guid_unicode_collation_protocol;
150 extern const efi_guid_t efi_guid_hii_config_routing_protocol;
151 extern const efi_guid_t efi_guid_hii_config_access_protocol;
152 extern const efi_guid_t efi_guid_hii_database_protocol;
153 extern const efi_guid_t efi_guid_hii_string_protocol;
155 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
156 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
159 * When a protocol is opened a open protocol info entry is created.
160 * These are maintained in a list.
162 struct efi_open_protocol_info_item {
163 /* Link to the list of open protocol info entries of a protocol */
164 struct list_head link;
165 struct efi_open_protocol_info_entry info;
169 * When the UEFI payload wants to open a protocol on an object to get its
170 * interface (usually a struct with callback functions), this struct maps the
171 * protocol GUID to the respective protocol interface
174 /* Link to the list of protocols of a handle */
175 struct list_head link;
176 const efi_guid_t *guid;
177 void *protocol_interface;
178 /* Link to the list of open protocol info items */
179 struct list_head open_infos;
183 * enum efi_object_type - type of EFI object
185 * In UnloadImage we must be able to identify if the handle relates to a
188 enum efi_object_type {
189 EFI_OBJECT_TYPE_UNDEFINED = 0,
190 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
191 EFI_OBJECT_TYPE_LOADED_IMAGE,
192 EFI_OBJECT_TYPE_STARTED_IMAGE,
196 * struct efi_object - dereferenced EFI handle
198 * @link: pointers to put the handle into a linked list
199 * @protocols: linked list with the protocol interfaces installed on this
202 * UEFI offers a flexible and expandable object model. The objects in the UEFI
203 * API are devices, drivers, and loaded images. struct efi_object is our storage
204 * structure for these objects.
206 * When including this structure into a larger structure always put it first so
207 * that when deleting a handle the whole encompassing structure can be freed.
209 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
210 * has been created for such pointers.
213 /* Every UEFI object is part of a global object list */
214 struct list_head link;
215 /* The list of protocols */
216 struct list_head protocols;
217 enum efi_object_type type;
221 * struct efi_loaded_image_obj - handle of a loaded image
223 * @header: EFI object header
224 * @exit_status: exit status passed to Exit()
225 * @exit_data_size: exit data size passed to Exit()
226 * @exit_data: exit data passed to Exit()
227 * @exit_jmp: long jump buffer for returning form started image
228 * @entry: entry address of the relocated image
230 struct efi_loaded_image_obj {
231 struct efi_object header;
232 efi_status_t exit_status;
233 efi_uintn_t *exit_data_size;
235 struct jmp_buf_data exit_jmp;
236 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
237 struct efi_system_table *st);
244 * @link: Link to list of all events
245 * @type: Type of event, see efi_create_event
246 * @notify_tpl: Task priority level of notifications
247 * @nofify_function: Function to call when the event is triggered
248 * @notify_context: Data to be passed to the notify function
249 * @group: Event group
250 * @trigger_time: Period of the timer
251 * @trigger_next: Next time to trigger the timer
252 * @trigger_type: Type of timer, see efi_set_timer
253 * @is_queued: The notification function is queued
254 * @is_signaled: The event occurred. The event is in the signaled state.
257 struct list_head link;
259 efi_uintn_t notify_tpl;
260 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
261 void *notify_context;
262 const efi_guid_t *group;
265 enum efi_timer_delay trigger_type;
270 /* This list contains all UEFI objects we know of */
271 extern struct list_head efi_obj_list;
272 /* List of all events */
273 extern struct list_head efi_events;
276 * efi_register_notify_event - event registered by RegisterProtocolNotify()
278 * The address of this structure serves as registration value.
280 * @link: link to list of all registered events
281 * @event: registered event. The same event may registered for
283 * @protocol: protocol for which the event is registered
285 struct efi_register_notify_event {
286 struct list_head link;
287 struct efi_event *event;
291 /* List of all events registered by RegisterProtocolNotify() */
292 extern struct list_head efi_register_notify_events;
294 /* Initialize efi execution environment */
295 efi_status_t efi_init_obj_list(void);
296 /* Called by bootefi to initialize root node */
297 efi_status_t efi_root_node_register(void);
298 /* Called by bootefi to initialize runtime */
299 efi_status_t efi_initialize_system_table(void);
300 /* Called by bootefi to make console interface available */
301 efi_status_t efi_console_register(void);
302 /* Called by bootefi to make all disk storage accessible as EFI objects */
303 efi_status_t efi_disk_register(void);
304 /* Create handles and protocols for the partitions of a block device */
305 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
306 const char *if_typename, int diskid,
307 const char *pdevname);
308 /* Called by bootefi to make GOP (graphical) interface available */
309 efi_status_t efi_gop_register(void);
310 /* Called by bootefi to make the network interface available */
311 efi_status_t efi_net_register(void);
312 /* Called by bootefi to make the watchdog available */
313 efi_status_t efi_watchdog_register(void);
314 /* Called by bootefi to make SMBIOS tables available */
316 * efi_acpi_register() - write out ACPI tables
318 * Called by bootefi to make ACPI tables available
320 * @return 0 if OK, -ENOMEM if no memory is available for the tables
322 efi_status_t efi_acpi_register(void);
324 * efi_smbios_register() - write out SMBIOS tables
326 * Called by bootefi to make SMBIOS tables available
328 * @return 0 if OK, -ENOMEM if no memory is available for the tables
330 efi_status_t efi_smbios_register(void);
332 struct efi_simple_file_system_protocol *
333 efi_fs_from_path(struct efi_device_path *fp);
335 /* Called by networking code to memorize the dhcp ack package */
336 void efi_net_set_dhcp_ack(void *pkt, int len);
337 /* Called by efi_set_watchdog_timer to reset the timer */
338 efi_status_t efi_set_watchdog(unsigned long timeout);
340 /* Called from places to check whether a timer expired */
341 void efi_timer_check(void);
342 /* PE loader implementation */
343 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle, void *efi,
344 struct efi_loaded_image *loaded_image_info);
345 /* Called once to store the pristine gd pointer */
346 void efi_save_gd(void);
347 /* Special case handler for error/abort that just tries to dtrt to get
348 * back to u-boot world */
349 void efi_restore_gd(void);
350 /* Call this to relocate the runtime section to an address space */
351 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
352 /* Call this to set the current device name */
353 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
354 /* Add a new object to the object list. */
355 void efi_add_handle(efi_handle_t obj);
357 efi_status_t efi_create_handle(efi_handle_t *handle);
359 void efi_delete_handle(efi_handle_t obj);
360 /* Call this to validate a handle and find the EFI object for it */
361 struct efi_object *efi_search_obj(const efi_handle_t handle);
363 efi_status_t EFIAPI efi_load_image(bool boot_policy,
364 efi_handle_t parent_image,
365 struct efi_device_path *file_path,
367 efi_uintn_t source_size,
368 efi_handle_t *image_handle);
370 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
371 efi_uintn_t *exit_data_size,
374 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
375 /* Find a protocol on a handle */
376 efi_status_t efi_search_protocol(const efi_handle_t handle,
377 const efi_guid_t *protocol_guid,
378 struct efi_handler **handler);
379 /* Install new protocol on a handle */
380 efi_status_t efi_add_protocol(const efi_handle_t handle,
381 const efi_guid_t *protocol,
382 void *protocol_interface);
383 /* Delete protocol from a handle */
384 efi_status_t efi_remove_protocol(const efi_handle_t handle,
385 const efi_guid_t *protocol,
386 void *protocol_interface);
387 /* Delete all protocols from a handle */
388 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
389 /* Install multiple protocol interfaces */
390 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
391 (efi_handle_t *handle, ...);
392 /* Call this to create an event */
393 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
394 void (EFIAPI *notify_function) (
395 struct efi_event *event,
397 void *notify_context, efi_guid_t *group,
398 struct efi_event **event);
399 /* Call this to set a timer */
400 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
401 uint64_t trigger_time);
402 /* Call this to signal an event */
403 void efi_signal_event(struct efi_event *event, bool check_tpl);
405 /* open file system: */
406 struct efi_simple_file_system_protocol *efi_simple_file_system(
407 struct blk_desc *desc, int part, struct efi_device_path *dp);
409 /* open file from device-path: */
410 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
413 * efi_size_in_pages() - convert size in bytes to size in pages
415 * This macro returns the number of EFI memory pages required to hold 'size'
418 * @size: size in bytes
419 * Return: size in pages
421 #define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
422 /* Generic EFI memory allocator, call this to get memory */
423 void *efi_alloc(uint64_t len, int memory_type);
424 /* More specific EFI memory allocator, called by EFI payloads */
425 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
427 /* EFI memory free function. */
428 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
429 /* EFI memory allocator for small allocations */
430 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
432 /* EFI pool memory free function. */
433 efi_status_t efi_free_pool(void *buffer);
434 /* Returns the EFI memory map */
435 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
436 struct efi_mem_desc *memory_map,
437 efi_uintn_t *map_key,
438 efi_uintn_t *descriptor_size,
439 uint32_t *descriptor_version);
440 /* Adds a range into the EFI memory map */
441 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
442 bool overlap_only_ram);
443 /* Called by board init to initialize the EFI drivers */
444 efi_status_t efi_driver_init(void);
445 /* Called by board init to initialize the EFI memory map */
446 int efi_memory_init(void);
447 /* Adds new or overrides configuration table entry to the system table */
448 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
449 /* Sets up a loaded image */
450 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
451 struct efi_device_path *file_path,
452 struct efi_loaded_image_obj **handle_ptr,
453 struct efi_loaded_image **info_ptr);
454 /* Print information about all loaded images */
455 void efi_print_image_infos(void *pc);
457 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
458 extern void *efi_bounce_buffer;
459 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
463 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
464 int efi_dp_match(const struct efi_device_path *a,
465 const struct efi_device_path *b);
466 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
467 struct efi_device_path **rem);
468 /* get size of the first device path instance excluding end node */
469 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
470 /* size of multi-instance device path excluding end node */
471 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
472 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
473 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
474 const struct efi_device_path *dp2);
475 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
476 const struct efi_device_path *node);
477 /* Create a device path node of given type, sub-type, length */
478 struct efi_device_path *efi_dp_create_device_node(const u8 type,
481 /* Append device path instance */
482 struct efi_device_path *efi_dp_append_instance(
483 const struct efi_device_path *dp,
484 const struct efi_device_path *dpi);
485 /* Get next device path instance */
486 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
488 /* Check if a device path contains muliple instances */
489 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
491 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
492 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
493 /* Create a device node for a block device partition. */
494 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
495 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
497 struct efi_device_path *efi_dp_from_eth(void);
498 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
499 uint64_t start_address,
500 uint64_t end_address);
501 /* Determine the last device path node that is not the end node. */
502 const struct efi_device_path *efi_dp_last_node(
503 const struct efi_device_path *dp);
504 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
505 struct efi_device_path **device_path,
506 struct efi_device_path **file_path);
507 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
509 struct efi_device_path **device,
510 struct efi_device_path **file);
512 #define EFI_DP_TYPE(_dp, _type, _subtype) \
513 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
514 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
517 * ascii2unicode() - convert ASCII string to UTF-16 string
519 * A zero terminated ASCII string is converted to a zero terminated UTF-16
520 * string. The output buffer must be preassigned.
522 * @unicode: preassigned output buffer for UTF-16 string
523 * @ascii: ASCII string to be converted
525 static inline void ascii2unicode(u16 *unicode, const char *ascii)
528 *(unicode++) = *(ascii++);
532 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
534 return memcmp(g1, g2, sizeof(efi_guid_t));
538 * Use these to indicate that your code / data should go into the EFI runtime
539 * section and thus still be available when the OS is running
541 #define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
542 #define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
544 /* Update CRC32 in table header */
545 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
547 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
548 * to make it available at runtime */
549 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
551 /* Boards may provide the functions below to implement RTS functionality */
553 void __efi_runtime EFIAPI efi_reset_system(
554 enum efi_reset_type reset_type,
555 efi_status_t reset_status,
556 unsigned long data_size, void *reset_data);
558 /* Architecture specific initialization of the EFI subsystem */
559 efi_status_t efi_reset_system_init(void);
561 efi_status_t __efi_runtime EFIAPI efi_get_time(
562 struct efi_time *time,
563 struct efi_time_cap *capabilities);
565 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
567 * Entry point for the tests of the EFI API.
568 * It is called by 'bootefi selftest'
570 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
571 struct efi_system_table *systab);
574 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
575 const efi_guid_t *vendor, u32 *attributes,
576 efi_uintn_t *data_size, void *data);
577 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
579 const efi_guid_t *vendor);
580 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
581 const efi_guid_t *vendor, u32 attributes,
582 efi_uintn_t data_size, const void *data);
585 * See section 3.1.3 in the v2.7 UEFI spec for more details on
586 * the layout of EFI_LOAD_OPTION. In short it is:
588 * typedef struct _EFI_LOAD_OPTION {
590 * UINT16 FilePathListLength;
591 * // CHAR16 Description[]; <-- variable length, NULL terminated
592 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
593 * <-- FilePathListLength bytes
594 * // UINT8 OptionalData[];
597 struct efi_load_option {
599 u16 file_path_length;
601 struct efi_device_path *file_path;
602 const u8 *optional_data;
605 void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
606 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
607 efi_status_t efi_bootmgr_load(efi_handle_t *handle);
609 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
611 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
612 #define __efi_runtime_data
613 #define __efi_runtime
614 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
619 /* No loader configured, stub out EFI_ENTRY */
620 static inline void efi_restore_gd(void) { }
621 static inline void efi_set_bootdev(const char *dev, const char *devnr,
622 const char *path) { }
623 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
624 static inline void efi_print_image_infos(void *pc) { }
626 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
628 #endif /* _EFI_LOADER_H */