0899e293e51b51a7940d27f2d49493d7f4522f8a
[platform/kernel/u-boot.git] / include / efi_loader.h
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 <blk.h>
13 #include <event.h>
14 #include <log.h>
15 #include <part_efi.h>
16 #include <efi_api.h>
17 #include <image.h>
18 #include <pe.h>
19 #include <linux/list.h>
20 #include <linux/oid_registry.h>
21
22 struct blk_desc;
23 struct jmp_buf_data;
24
25 static inline int guidcmp(const void *g1, const void *g2)
26 {
27         return memcmp(g1, g2, sizeof(efi_guid_t));
28 }
29
30 static inline void *guidcpy(void *dst, const void *src)
31 {
32         return memcpy(dst, src, sizeof(efi_guid_t));
33 }
34
35 #if CONFIG_IS_ENABLED(EFI_LOADER)
36
37 /**
38  * __efi_runtime_data - declares a non-const variable for EFI runtime section
39  *
40  * This macro indicates that a variable is non-const and should go into the
41  * EFI runtime section, and thus still be available when the OS is running.
42  *
43  * Only use on variables not declared const.
44  *
45  * Example:
46  *
47  * ::
48  *
49  *   static __efi_runtime_data my_computed_table[256];
50  */
51 #define __efi_runtime_data __section(".data.efi_runtime")
52
53 /**
54  * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
55  *
56  * This macro indicates that a variable is read-only (const) and should go into
57  * the EFI runtime section, and thus still be available when the OS is running.
58  *
59  * Only use on variables also declared const.
60  *
61  * Example:
62  *
63  * ::
64  *
65  *   static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
66  */
67 #define __efi_runtime_rodata __section(".rodata.efi_runtime")
68
69 /**
70  * __efi_runtime - declares a function for EFI runtime section
71  *
72  * This macro indicates that a function should go into the EFI runtime section,
73  * and thus still be available when the OS is running.
74  *
75  * Example:
76  *
77  * ::
78  *
79  *   static __efi_runtime compute_my_table(void);
80  */
81 #define __efi_runtime __section(".text.efi_runtime")
82
83 /*
84  * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
85  * to make it available at runtime
86  */
87 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
88
89 /*
90  * Special case handler for error/abort that just tries to dtrt to get
91  * back to u-boot world
92  */
93 void efi_restore_gd(void);
94 /* Call this to set the current device name */
95 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
96                      void *buffer, size_t buffer_size);
97 /* Called by networking code to memorize the dhcp ack package */
98 void efi_net_set_dhcp_ack(void *pkt, int len);
99 /* Print information about all loaded images */
100 void efi_print_image_infos(void *pc);
101
102 /* Hook at initialization */
103 efi_status_t efi_launch_capsules(void);
104
105 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
106
107 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
108 #define __efi_runtime_data
109 #define __efi_runtime_rodata
110 #define __efi_runtime
111 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
112 {
113         return EFI_SUCCESS;
114 }
115
116 /* No loader configured, stub out EFI_ENTRY */
117 static inline void efi_restore_gd(void) { }
118 static inline void efi_set_bootdev(const char *dev, const char *devnr,
119                                    const char *path, void *buffer,
120                                    size_t buffer_size) { }
121 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
122 static inline void efi_print_image_infos(void *pc) { }
123 static inline efi_status_t efi_launch_capsules(void)
124 {
125         return EFI_SUCCESS;
126 }
127
128 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
129
130 /* Maximum number of configuration tables */
131 #define EFI_MAX_CONFIGURATION_TABLES 16
132
133 /* GUID used by the root node */
134 #define U_BOOT_GUID \
135         EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
136                  0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
137 /* GUID used as host device on sandbox */
138 #define U_BOOT_HOST_DEV_GUID \
139         EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
140                  0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
141 /* GUID used as root for virtio devices */
142 #define U_BOOT_VIRTIO_DEV_GUID \
143         EFI_GUID(0x63293792, 0xadf5, 0x9325, \
144                  0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
145
146 /* GUID for the auto generated boot menu entry */
147 #define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
148         EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \
149                  0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde)
150
151 /* Use internal device tree when starting UEFI application */
152 #define EFI_FDT_USE_INTERNAL NULL
153
154 /* Root node */
155 extern efi_handle_t efi_root;
156
157 /* Set to EFI_SUCCESS when initialized */
158 extern efi_status_t efi_obj_list_initialized;
159
160 /* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
161 extern bool efi_st_keep_devices;
162
163 /* EFI system partition */
164 extern struct efi_system_partition {
165         enum uclass_id uclass_id;
166         int devnum;
167         u8 part;
168 } efi_system_partition;
169
170 int __efi_entry_check(void);
171 int __efi_exit_check(void);
172 const char *__efi_nesting(void);
173 const char *__efi_nesting_inc(void);
174 const char *__efi_nesting_dec(void);
175
176 /*
177  * Enter the u-boot world from UEFI:
178  */
179 #define EFI_ENTRY(format, ...) do { \
180         assert(__efi_entry_check()); \
181         debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
182                 __func__, ##__VA_ARGS__); \
183         } while(0)
184
185 /*
186  * Exit the u-boot world back to UEFI:
187  */
188 #define EFI_EXIT(ret) ({ \
189         typeof(ret) _r = ret; \
190         debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
191                 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
192         assert(__efi_exit_check()); \
193         _r; \
194         })
195
196 /*
197  * Call non-void UEFI function from u-boot and retrieve return value:
198  */
199 #define EFI_CALL(exp) ({ \
200         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
201         assert(__efi_exit_check()); \
202         typeof(exp) _r = exp; \
203         assert(__efi_entry_check()); \
204         debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
205               (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
206         _r; \
207 })
208
209 /*
210  * Call void UEFI function from u-boot:
211  */
212 #define EFI_CALL_VOID(exp) do { \
213         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
214         assert(__efi_exit_check()); \
215         exp; \
216         assert(__efi_entry_check()); \
217         debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
218         } while(0)
219
220 /*
221  * Write an indented message with EFI prefix
222  */
223 #define EFI_PRINT(format, ...) ({ \
224         debug("%sEFI: " format, __efi_nesting(), \
225                 ##__VA_ARGS__); \
226         })
227
228 #ifdef CONFIG_SYS_CACHELINE_SIZE
229 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
230 #else
231 /* Just use the greatest cache flush alignment requirement I'm aware of */
232 #define EFI_CACHELINE_SIZE 128
233 #endif
234
235 /* max bootmenu title size for volume selection */
236 #define BOOTMENU_DEVICE_NAME_MAX 16
237
238 /* Key identifying current memory map */
239 extern efi_uintn_t efi_memory_map_key;
240
241 extern struct efi_runtime_services efi_runtime_services;
242 extern struct efi_system_table systab;
243
244 extern struct efi_simple_text_output_protocol efi_con_out;
245 extern struct efi_simple_text_input_protocol efi_con_in;
246 extern struct efi_console_control_protocol efi_console_control;
247 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
248 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
249 extern const struct efi_device_path_utilities_protocol
250                                         efi_device_path_utilities;
251 /* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
252 extern const struct efi_unicode_collation_protocol
253                                         efi_unicode_collation_protocol2;
254 extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
255 extern const struct efi_hii_config_access_protocol efi_hii_config_access;
256 extern const struct efi_hii_database_protocol efi_hii_database;
257 extern const struct efi_hii_string_protocol efi_hii_string;
258
259 uint16_t *efi_dp_str(struct efi_device_path *dp);
260
261 /* GUID for the auto generated boot menu entry */
262 extern const efi_guid_t efi_guid_bootmenu_auto_generated;
263
264 /* GUID of the U-Boot root node */
265 extern const efi_guid_t efi_u_boot_guid;
266 #ifdef CONFIG_SANDBOX
267 /* GUID of U-Boot host device on sandbox */
268 extern const efi_guid_t efi_guid_host_dev;
269 #endif
270 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
271 extern const efi_guid_t efi_block_io_guid;
272 extern const efi_guid_t efi_global_variable_guid;
273 extern const efi_guid_t efi_guid_console_control;
274 extern const efi_guid_t efi_guid_device_path;
275 /* GUID of the EFI system partition */
276 extern const efi_guid_t efi_system_partition_guid;
277 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
278 extern const efi_guid_t efi_guid_driver_binding_protocol;
279 /* event group ExitBootServices() invoked */
280 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
281 /* event group SetVirtualAddressMap() invoked */
282 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
283 /* event group memory map changed */
284 extern const efi_guid_t efi_guid_event_group_memory_map_change;
285 /* event group boot manager about to boot */
286 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
287 /* event group ResetSystem() invoked (before ExitBootServices) */
288 extern const efi_guid_t efi_guid_event_group_reset_system;
289 /* GUID of the device tree table */
290 extern const efi_guid_t efi_guid_fdt;
291 extern const efi_guid_t efi_guid_loaded_image;
292 extern const efi_guid_t efi_guid_loaded_image_device_path;
293 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
294 extern const efi_guid_t efi_simple_file_system_protocol_guid;
295 extern const efi_guid_t efi_file_info_guid;
296 /* GUID for file system information */
297 extern const efi_guid_t efi_file_system_info_guid;
298 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
299 /* GUID of the deprecated Unicode collation protocol */
300 extern const efi_guid_t efi_guid_unicode_collation_protocol;
301 /* GUIDs of the Load File and Load File2 protocol */
302 extern const efi_guid_t efi_guid_load_file_protocol;
303 extern const efi_guid_t efi_guid_load_file2_protocol;
304 /* GUID of the Unicode collation protocol */
305 extern const efi_guid_t efi_guid_unicode_collation_protocol2;
306 extern const efi_guid_t efi_guid_hii_config_routing_protocol;
307 extern const efi_guid_t efi_guid_hii_config_access_protocol;
308 extern const efi_guid_t efi_guid_hii_database_protocol;
309 extern const efi_guid_t efi_guid_hii_string_protocol;
310 /* GUIDs for authentication */
311 extern const efi_guid_t efi_guid_image_security_database;
312 extern const efi_guid_t efi_guid_sha256;
313 extern const efi_guid_t efi_guid_cert_x509;
314 extern const efi_guid_t efi_guid_cert_x509_sha256;
315 extern const efi_guid_t efi_guid_cert_x509_sha384;
316 extern const efi_guid_t efi_guid_cert_x509_sha512;
317 extern const efi_guid_t efi_guid_cert_type_pkcs7;
318
319 /* GUID of RNG protocol */
320 extern const efi_guid_t efi_guid_rng_protocol;
321 /* GUID of capsule update result */
322 extern const efi_guid_t efi_guid_capsule_report;
323 /* GUID of firmware management protocol */
324 extern const efi_guid_t efi_guid_firmware_management_protocol;
325 /* GUID for the ESRT */
326 extern const efi_guid_t efi_esrt_guid;
327 /* GUID of the SMBIOS table */
328 extern const efi_guid_t smbios_guid;
329 /*GUID of console */
330 extern const efi_guid_t efi_guid_text_input_protocol;
331
332 extern char __efi_runtime_start[], __efi_runtime_stop[];
333 extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
334
335 /**
336  * struct efi_open_protocol_info_item - open protocol info item
337  *
338  * When a protocol is opened a open protocol info entry is created.
339  * These are maintained in a list.
340  *
341  * @link:       link to the list of open protocol info entries of a protocol
342  * @info:       information about the opening of a protocol
343  */
344 struct efi_open_protocol_info_item {
345         struct list_head link;
346         struct efi_open_protocol_info_entry info;
347 };
348
349 /**
350  * struct efi_handler - single protocol interface of a handle
351  *
352  * When the UEFI payload wants to open a protocol on an object to get its
353  * interface (usually a struct with callback functions), this struct maps the
354  * protocol GUID to the respective protocol interface
355  *
356  * @link:               link to the list of protocols of a handle
357  * @guid:               GUID of the protocol
358  * @protocol_interface: protocol interface
359  * @open_infos:         link to the list of open protocol info items
360  */
361 struct efi_handler {
362         struct list_head link;
363         const efi_guid_t guid;
364         void *protocol_interface;
365         struct list_head open_infos;
366 };
367
368 /**
369  * enum efi_object_type - type of EFI object
370  *
371  * In UnloadImage we must be able to identify if the handle relates to a
372  * started image.
373  */
374 enum efi_object_type {
375         /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
376         EFI_OBJECT_TYPE_UNDEFINED = 0,
377         /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
378         EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
379         /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
380         EFI_OBJECT_TYPE_LOADED_IMAGE,
381         /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
382         EFI_OBJECT_TYPE_STARTED_IMAGE,
383 };
384
385 /**
386  * struct efi_object - dereferenced EFI handle
387  *
388  * @link:       pointers to put the handle into a linked list
389  * @protocols:  linked list with the protocol interfaces installed on this
390  *              handle
391  * @type:       image type if the handle relates to an image
392  * @dev:        pointer to the DM device which is associated with this EFI handle
393  *
394  * UEFI offers a flexible and expandable object model. The objects in the UEFI
395  * API are devices, drivers, and loaded images. struct efi_object is our storage
396  * structure for these objects.
397  *
398  * When including this structure into a larger structure always put it first so
399  * that when deleting a handle the whole encompassing structure can be freed.
400  *
401  * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
402  * has been created for such pointers.
403  */
404 struct efi_object {
405         /* Every UEFI object is part of a global object list */
406         struct list_head link;
407         /* The list of protocols */
408         struct list_head protocols;
409         enum efi_object_type type;
410         struct udevice *dev;
411 };
412
413 enum efi_image_auth_status {
414         EFI_IMAGE_AUTH_FAILED = 0,
415         EFI_IMAGE_AUTH_PASSED,
416 };
417
418 /**
419  * struct efi_loaded_image_obj - handle of a loaded image
420  *
421  * @header:             EFI object header
422  * @exit_status:        exit status passed to Exit()
423  * @exit_data_size:     exit data size passed to Exit()
424  * @exit_data:          exit data passed to Exit()
425  * @exit_jmp:           long jump buffer for returning from started image
426  * @entry:              entry address of the relocated image
427  * @image_type:         indicates if the image is an applicition or a driver
428  * @auth_status:        indicates if the image is authenticated
429  */
430 struct efi_loaded_image_obj {
431         struct efi_object header;
432         efi_status_t *exit_status;
433         efi_uintn_t *exit_data_size;
434         u16 **exit_data;
435         struct jmp_buf_data *exit_jmp;
436         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
437                                      struct efi_system_table *st);
438         u16 image_type;
439         enum efi_image_auth_status auth_status;
440 };
441
442 /**
443  * struct efi_event
444  *
445  * @link:               Link to list of all events
446  * @queue_link:         Link to the list of queued events
447  * @type:               Type of event, see efi_create_event
448  * @notify_tpl:         Task priority level of notifications
449  * @notify_function:    Function to call when the event is triggered
450  * @notify_context:     Data to be passed to the notify function
451  * @group:              Event group
452  * @trigger_time:       Period of the timer
453  * @trigger_next:       Next time to trigger the timer
454  * @trigger_type:       Type of timer, see efi_set_timer
455  * @is_signaled:        The event occurred. The event is in the signaled state.
456  */
457 struct efi_event {
458         struct list_head link;
459         struct list_head queue_link;
460         uint32_t type;
461         efi_uintn_t notify_tpl;
462         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
463         void *notify_context;
464         const efi_guid_t *group;
465         u64 trigger_next;
466         u64 trigger_time;
467         enum efi_timer_delay trigger_type;
468         bool is_signaled;
469 };
470
471 /* This list contains all UEFI objects we know of */
472 extern struct list_head efi_obj_list;
473 /* List of all events */
474 extern struct list_head efi_events;
475
476 /**
477  * struct efi_protocol_notification - handle for notified protocol
478  *
479  * When a protocol interface is installed for which an event was registered with
480  * the RegisterProtocolNotify() service this structure is used to hold the
481  * handle on which the protocol interface was installed.
482  *
483  * @link:       link to list of all handles notified for this event
484  * @handle:     handle on which the notified protocol interface was installed
485  */
486 struct efi_protocol_notification {
487         struct list_head link;
488         efi_handle_t handle;
489 };
490
491 /**
492  * struct efi_register_notify_event - event registered by
493  *                                    RegisterProtocolNotify()
494  *
495  * The address of this structure serves as registration value.
496  *
497  * @link:       link to list of all registered events
498  * @event:      registered event. The same event may registered for multiple
499  *              GUIDs.
500  * @protocol:   protocol for which the event is registered
501  * @handles:    linked list of all handles on which the notified protocol was
502  *              installed
503  */
504 struct efi_register_notify_event {
505         struct list_head link;
506         struct efi_event *event;
507         efi_guid_t protocol;
508         struct list_head handles;
509 };
510
511 /* List of all events registered by RegisterProtocolNotify() */
512 extern struct list_head efi_register_notify_events;
513
514 /* called at pre-initialization */
515 int efi_init_early(void);
516 /* Initialize efi execution environment */
517 efi_status_t efi_init_obj_list(void);
518 /* Set up console modes */
519 void efi_setup_console_size(void);
520 /* Install device tree */
521 efi_status_t efi_install_fdt(void *fdt);
522 /* Run loaded UEFI image */
523 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
524 /* Initialize variable services */
525 efi_status_t efi_init_variables(void);
526 /* Notify ExitBootServices() is called */
527 void efi_variables_boot_exit_notify(void);
528 efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
529 /* Measure efi application invocation */
530 efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
531 /* Measure efi application exit */
532 efi_status_t efi_tcg2_measure_efi_app_exit(void);
533 /* Called by bootefi to initialize root node */
534 efi_status_t efi_root_node_register(void);
535 /* Called by bootefi to initialize runtime */
536 efi_status_t efi_initialize_system_table(void);
537 /* efi_runtime_detach() - detach unimplemented runtime functions */
538 void efi_runtime_detach(void);
539 /* efi_convert_pointer() - convert pointer to virtual address */
540 efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
541                                         void **address);
542 /* Carve out DT reserved memory ranges */
543 void efi_carve_out_dt_rsv(void *fdt);
544 /* Purge unused kaslr-seed */
545 void efi_try_purge_kaslr_seed(void *fdt);
546 /* Called by bootefi to make console interface available */
547 efi_status_t efi_console_register(void);
548 /* Called by efi_init_obj_list() to proble all block devices */
549 efi_status_t efi_disks_register(void);
550 /* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
551 efi_status_t efi_rng_register(void);
552 /* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
553 efi_status_t efi_tcg2_register(void);
554 /* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
555 efi_status_t efi_riscv_register(void);
556 /* Called by efi_init_obj_list() to do initial measurement */
557 efi_status_t efi_tcg2_do_initial_measurement(void);
558 /* measure the pe-coff image, extend PCR and add Event Log */
559 efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
560                                    struct efi_loaded_image_obj *handle,
561                                    struct efi_loaded_image *loaded_image_info);
562 /* Create handles and protocols for the partitions of a block device */
563 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
564                                const char *uclass_idname, int diskid,
565                                const char *pdevname);
566 /* Called by bootefi to make GOP (graphical) interface available */
567 efi_status_t efi_gop_register(void);
568 /* Called by bootefi to make the network interface available */
569 efi_status_t efi_net_register(void);
570 /* Called by bootefi to make the watchdog available */
571 efi_status_t efi_watchdog_register(void);
572 efi_status_t efi_initrd_register(void);
573 efi_status_t efi_initrd_deregister(void);
574 /* Called by bootefi to make SMBIOS tables available */
575 /**
576  * efi_acpi_register() - write out ACPI tables
577  *
578  * Called by bootefi to make ACPI tables available
579  *
580  * Return: 0 if OK, -ENOMEM if no memory is available for the tables
581  */
582 efi_status_t efi_acpi_register(void);
583 /**
584  * efi_smbios_register() - write out SMBIOS tables
585  *
586  * Called by bootefi to make SMBIOS tables available
587  *
588  * Return: 0 if OK, -ENOMEM if no memory is available for the tables
589  */
590 efi_status_t efi_smbios_register(void);
591
592 struct efi_simple_file_system_protocol *
593 efi_fs_from_path(struct efi_device_path *fp);
594
595 /* Called by efi_set_watchdog_timer to reset the timer */
596 efi_status_t efi_set_watchdog(unsigned long timeout);
597
598 /* Called from places to check whether a timer expired */
599 void efi_timer_check(void);
600 /* Check if a buffer contains a PE-COFF image */
601 efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
602 /* PE loader implementation */
603 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
604                          void *efi, size_t efi_size,
605                          struct efi_loaded_image *loaded_image_info);
606 /* Called once to store the pristine gd pointer */
607 void efi_save_gd(void);
608 /* Call this to relocate the runtime section to an address space */
609 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
610 /* Call this to get image parameters */
611 void efi_get_image_parameters(void **img_addr, size_t *img_size);
612 /* Add a new object to the object list. */
613 void efi_add_handle(efi_handle_t obj);
614 /* Create handle */
615 efi_status_t efi_create_handle(efi_handle_t *handle);
616 /* Delete handle */
617 void efi_delete_handle(efi_handle_t obj);
618 /* Call this to validate a handle and find the EFI object for it */
619 struct efi_object *efi_search_obj(const efi_handle_t handle);
620 /* Locate device_path handle */
621 efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
622                                            struct efi_device_path **device_path,
623                                            efi_handle_t *device);
624 /* Load image */
625 efi_status_t EFIAPI efi_load_image(bool boot_policy,
626                                    efi_handle_t parent_image,
627                                    struct efi_device_path *file_path,
628                                    void *source_buffer,
629                                    efi_uintn_t source_size,
630                                    efi_handle_t *image_handle);
631 /* Start image */
632 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
633                                     efi_uintn_t *exit_data_size,
634                                     u16 **exit_data);
635 /* Unload image */
636 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
637 /* Find a protocol on a handle */
638 efi_status_t efi_search_protocol(const efi_handle_t handle,
639                                  const efi_guid_t *protocol_guid,
640                                  struct efi_handler **handler);
641 /* Install new protocol on a handle */
642 efi_status_t efi_add_protocol(const efi_handle_t handle,
643                               const efi_guid_t *protocol,
644                               void *protocol_interface);
645 /* Open protocol */
646 efi_status_t efi_protocol_open(struct efi_handler *handler,
647                                void **protocol_interface, void *agent_handle,
648                                void *controller_handle, uint32_t attributes);
649
650 /* Delete protocol from a handle */
651 efi_status_t efi_remove_protocol(const efi_handle_t handle,
652                                  const efi_guid_t *protocol,
653                                  void *protocol_interface);
654 /* Install multiple protocol interfaces */
655 efi_status_t EFIAPI
656 efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
657 efi_status_t EFIAPI
658 efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
659 /* Get handles that support a given protocol */
660 efi_status_t EFIAPI efi_locate_handle_buffer(
661                         enum efi_locate_search_type search_type,
662                         const efi_guid_t *protocol, void *search_key,
663                         efi_uintn_t *no_handles, efi_handle_t **buffer);
664 /* Close a previously opened protocol interface */
665 efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
666                                 efi_handle_t agent_handle,
667                                 efi_handle_t controller_handle);
668 /* Open a protocol interface */
669 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
670                                         const efi_guid_t *protocol,
671                                         void **protocol_interface);
672 /* Call this to create an event */
673 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
674                               void (EFIAPI *notify_function) (
675                                         struct efi_event *event,
676                                         void *context),
677                               void *notify_context, efi_guid_t *group,
678                               struct efi_event **event);
679 /* Call this to set a timer */
680 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
681                            uint64_t trigger_time);
682 /* Call this to signal an event */
683 void efi_signal_event(struct efi_event *event);
684
685 /* return true if the device is removable */
686 bool efi_disk_is_removable(efi_handle_t handle);
687
688 /* open file system: */
689 struct efi_simple_file_system_protocol *efi_simple_file_system(
690                 struct blk_desc *desc, int part, struct efi_device_path *dp);
691
692 /* open file from device-path: */
693 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
694
695 /* Registers a callback function for a notification event. */
696 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
697                                                  struct efi_event *event,
698                                                  void **registration);
699 efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
700
701 /* get a device path from a Boot#### option */
702 struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
703
704 /* get len, string (used in u-boot crypto from a guid */
705 const char *guid_to_sha_str(const efi_guid_t *guid);
706 int algo_to_len(const char *algo);
707
708 int efi_link_dev(efi_handle_t handle, struct udevice *dev);
709 int efi_unlink_dev(efi_handle_t handle);
710 bool efi_varname_is_load_option(u16 *var_name16, int *index);
711
712 /**
713  * efi_size_in_pages() - convert size in bytes to size in pages
714  *
715  * This macro returns the number of EFI memory pages required to hold 'size'
716  * bytes.
717  *
718  * @size:       size in bytes
719  * Return:      size in pages
720  */
721 #define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
722 /* Generic EFI memory allocator, call this to get memory */
723 void *efi_alloc(uint64_t len, int memory_type);
724 /* Allocate pages on the specified alignment */
725 void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
726 /* More specific EFI memory allocator, called by EFI payloads */
727 efi_status_t efi_allocate_pages(enum efi_allocate_type type,
728                                 enum efi_memory_type memory_type,
729                                 efi_uintn_t pages, uint64_t *memory);
730 /* EFI memory free function. */
731 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
732 /* EFI memory allocator for small allocations */
733 efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
734                                efi_uintn_t size, void **buffer);
735 /* EFI pool memory free function. */
736 efi_status_t efi_free_pool(void *buffer);
737 /* Returns the EFI memory map */
738 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
739                                 struct efi_mem_desc *memory_map,
740                                 efi_uintn_t *map_key,
741                                 efi_uintn_t *descriptor_size,
742                                 uint32_t *descriptor_version);
743 /* Adds a range into the EFI memory map */
744 efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
745 /* Adds a conventional range into the EFI memory map */
746 efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
747                                              u64 ram_top);
748
749 /* Called by board init to initialize the EFI drivers */
750 efi_status_t efi_driver_init(void);
751 /* Called when a block device is added */
752 int efi_disk_probe(void *ctx, struct event *event);
753 /* Called when a block device is removed */
754 int efi_disk_remove(void *ctx, struct event *event);
755 /* Called by board init to initialize the EFI memory map */
756 int efi_memory_init(void);
757 /* Adds new or overrides configuration table entry to the system table */
758 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
759 /* Sets up a loaded image */
760 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
761                                     struct efi_device_path *file_path,
762                                     struct efi_loaded_image_obj **handle_ptr,
763                                     struct efi_loaded_image **info_ptr);
764
765 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
766 extern void *efi_bounce_buffer;
767 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
768 #endif
769
770 /* shorten device path */
771 struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
772 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
773 int efi_dp_match(const struct efi_device_path *a,
774                  const struct efi_device_path *b);
775 efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
776                              const efi_guid_t *guid,
777                              struct efi_device_path **rem);
778 /* get size of the first device path instance excluding end node */
779 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
780 /* size of multi-instance device path excluding end node */
781 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
782 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
783 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
784                                       const struct efi_device_path *dp2);
785 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
786                                            const struct efi_device_path *node);
787 /* Create a device path node of given type, sub-type, length */
788 struct efi_device_path *efi_dp_create_device_node(const u8 type,
789                                                   const u8 sub_type,
790                                                   const u16 length);
791 /* Append device path instance */
792 struct efi_device_path *efi_dp_append_instance(
793                 const struct efi_device_path *dp,
794                 const struct efi_device_path *dpi);
795 /* Get next device path instance */
796 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
797                                                  efi_uintn_t *size);
798 /* Check if a device path contains muliple instances */
799 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
800
801 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
802 /* Create a device node for a block device partition. */
803 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
804 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
805                                          const char *path);
806 struct efi_device_path *efi_dp_from_eth(void);
807 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
808                                         uint64_t start_address,
809                                         uint64_t end_address);
810 /* Determine the last device path node that is not the end node. */
811 const struct efi_device_path *efi_dp_last_node(
812                         const struct efi_device_path *dp);
813 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
814                                     struct efi_device_path **device_path,
815                                     struct efi_device_path **file_path);
816 struct efi_device_path *efi_dp_from_uart(void);
817 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
818                               const char *path,
819                               struct efi_device_path **device,
820                               struct efi_device_path **file);
821 ssize_t efi_dp_check_length(const struct efi_device_path *dp,
822                             const size_t maxlen);
823
824 #define EFI_DP_TYPE(_dp, _type, _subtype) \
825         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
826          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
827
828 /* template END node: */
829 extern const struct efi_device_path END;
830
831 /* Indicate supported runtime services */
832 efi_status_t efi_init_runtime_supported(void);
833
834 /* Update CRC32 in table header */
835 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
836
837 /* Boards may provide the functions below to implement RTS functionality */
838
839 void __efi_runtime EFIAPI efi_reset_system(
840                         enum efi_reset_type reset_type,
841                         efi_status_t reset_status,
842                         unsigned long data_size, void *reset_data);
843
844 /* Architecture specific initialization of the EFI subsystem */
845 efi_status_t efi_reset_system_init(void);
846
847 efi_status_t __efi_runtime EFIAPI efi_get_time(
848                         struct efi_time *time,
849                         struct efi_time_cap *capabilities);
850
851 efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
852
853 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
854 /*
855  * Entry point for the tests of the EFI API.
856  * It is called by 'bootefi selftest'
857  */
858 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
859                                  struct efi_system_table *systab);
860 #endif
861
862 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
863                                      const efi_guid_t *vendor, u32 *attributes,
864                                      efi_uintn_t *data_size, void *data);
865 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
866                                                u16 *variable_name,
867                                                efi_guid_t *vendor);
868 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
869                                      const efi_guid_t *vendor, u32 attributes,
870                                      efi_uintn_t data_size, const void *data);
871
872 efi_status_t EFIAPI efi_query_variable_info(
873                         u32 attributes, u64 *maximum_variable_storage_size,
874                         u64 *remaining_variable_storage_size,
875                         u64 *maximum_variable_size);
876
877 void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
878
879 /*
880  * See section 3.1.3 in the v2.7 UEFI spec for more details on
881  * the layout of EFI_LOAD_OPTION.  In short it is:
882  *
883  *    typedef struct _EFI_LOAD_OPTION {
884  *        UINT32 Attributes;
885  *        UINT16 FilePathListLength;
886  *        // CHAR16 Description[];   <-- variable length, NULL terminated
887  *        // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
888  *                                               <-- FilePathListLength bytes
889  *        // UINT8 OptionalData[];
890  *    } EFI_LOAD_OPTION;
891  */
892 struct efi_load_option {
893         u32 attributes;
894         u16 file_path_length;
895         u16 *label;
896         struct efi_device_path *file_path;
897         const u8 *optional_data;
898 };
899
900 struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
901                                        const efi_guid_t *guid);
902 struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
903                                       const struct efi_device_path *dp2);
904 struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
905 efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
906                                          efi_uintn_t *size);
907 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
908 efi_status_t efi_set_load_options(efi_handle_t handle,
909                                   efi_uintn_t load_options_size,
910                                   void *load_options);
911 efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
912
913 /**
914  * struct efi_image_regions - A list of memory regions
915  *
916  * @max:        Maximum number of regions
917  * @num:        Number of regions
918  * @reg:        array of regions
919  */
920 struct efi_image_regions {
921         int                     max;
922         int                     num;
923         struct image_region     reg[];
924 };
925
926 /**
927  * struct efi_sig_data - A decoded data of struct efi_signature_data
928  *
929  * This structure represents an internal form of signature in
930  * signature database. A listed list may represent a signature list.
931  *
932  * @next:       Pointer to next entry
933  * @owner:      Signature owner
934  * @data:       Pointer to signature data
935  * @size:       Size of signature data
936  */
937 struct efi_sig_data {
938         struct efi_sig_data *next;
939         efi_guid_t owner;
940         void *data;
941         size_t size;
942 };
943
944 /**
945  * struct efi_signature_store - A decoded data of signature database
946  *
947  * This structure represents an internal form of signature database.
948  *
949  * @next:               Pointer to next entry
950  * @sig_type:           Signature type
951  * @sig_data_list:      Pointer to signature list
952  */
953 struct efi_signature_store {
954         struct efi_signature_store *next;
955         efi_guid_t sig_type;
956         struct efi_sig_data *sig_data_list;
957 };
958
959 struct x509_certificate;
960 struct pkcs7_message;
961
962 /**
963  * struct eficonfig_media_boot_option - boot option for (removable) media device
964  *
965  * This structure is used to enumerate possible boot option
966  *
967  * @lo:         Serialized load option data
968  * @size:       Size of serialized load option data
969  * @exist:      Flag to indicate the load option already exists
970  *              in Non-volatile load option
971  */
972 struct eficonfig_media_boot_option {
973         void *lo;
974         efi_uintn_t size;
975         bool exist;
976 };
977
978 bool efi_hash_regions(struct image_region *regs, int count,
979                       void **hash, const char *hash_algo, int *len);
980 bool efi_signature_lookup_digest(struct efi_image_regions *regs,
981                                  struct efi_signature_store *db,
982                                  bool dbx);
983 bool efi_signature_verify(struct efi_image_regions *regs,
984                           struct pkcs7_message *msg,
985                           struct efi_signature_store *db,
986                           struct efi_signature_store *dbx);
987 static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
988                                             struct pkcs7_message *msg,
989                                             struct efi_signature_store *db)
990 {
991         return efi_signature_verify(regs, msg, db, NULL);
992 }
993 bool efi_signature_check_signers(struct pkcs7_message *msg,
994                                  struct efi_signature_store *dbx);
995
996 efi_status_t efi_image_region_add(struct efi_image_regions *regs,
997                                   const void *start, const void *end,
998                                   int nocheck);
999
1000 void efi_sigstore_free(struct efi_signature_store *sigstore);
1001 struct efi_signature_store *efi_build_signature_store(void *sig_list,
1002                                                       efi_uintn_t size);
1003 struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
1004
1005 bool efi_secure_boot_enabled(void);
1006
1007 bool efi_capsule_auth_enabled(void);
1008
1009 void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1010
1011 bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1012                      WIN_CERTIFICATE **auth, size_t *auth_len);
1013
1014 struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1015                                              size_t buflen,
1016                                              u8 **tmpbuf);
1017
1018 /* runtime implementation of memcpy() */
1019 void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1020
1021 /* commonly used helper functions */
1022 u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1023                              unsigned int index);
1024 efi_string_t efi_convert_string(const char *str);
1025
1026 extern const struct efi_firmware_management_protocol efi_fmp_fit;
1027 extern const struct efi_firmware_management_protocol efi_fmp_raw;
1028
1029 /* Capsule update */
1030 efi_status_t EFIAPI efi_update_capsule(
1031                 struct efi_capsule_header **capsule_header_array,
1032                 efi_uintn_t capsule_count,
1033                 u64 scatter_gather_list);
1034 efi_status_t EFIAPI efi_query_capsule_caps(
1035                 struct efi_capsule_header **capsule_header_array,
1036                 efi_uintn_t capsule_count,
1037                 u64 *maximum_capsule_size,
1038                 u32 *reset_type);
1039
1040 efi_status_t efi_capsule_authenticate(const void *capsule,
1041                                       efi_uintn_t capsule_size,
1042                                       void **image, efi_uintn_t *image_size);
1043
1044 #define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
1045
1046 /**
1047  * struct efi_fw_image -  Information on firmware images updatable through
1048  *                        capsule update
1049  *
1050  * This structure gives information about the firmware images on the platform
1051  * which can be updated through the capsule update mechanism
1052  *
1053  * @image_type_id:      Image GUID. Same value is to be used in the capsule
1054  * @fw_name:            Name of the firmware image
1055  * @image_index:        Image Index, same as value passed to SetImage FMP
1056  *                      function
1057  */
1058 struct efi_fw_image {
1059         efi_guid_t image_type_id;
1060         u16 *fw_name;
1061         u8 image_index;
1062 };
1063
1064 /**
1065  * struct efi_capsule_update_info - Information needed for capsule updates
1066  *
1067  * This structure provides information needed for performing firmware
1068  * updates. The structure needs to be initialised per platform, for all
1069  * platforms which enable capsule updates
1070  *
1071  * @dfu_string:         String used to populate dfu_alt_info
1072  * @images:             Pointer to an array of updatable images
1073  */
1074 struct efi_capsule_update_info {
1075         const char *dfu_string;
1076         struct efi_fw_image *images;
1077 };
1078
1079 extern struct efi_capsule_update_info update_info;
1080 extern u8 num_image_type_guids;
1081
1082 /**
1083  * Install the ESRT system table.
1084  *
1085  * Return:      status code
1086  */
1087 efi_status_t efi_esrt_register(void);
1088
1089 /**
1090  * efi_ecpt_register() - Install the ECPT system table.
1091  *
1092  * Return: status code
1093  */
1094 efi_status_t efi_ecpt_register(void);
1095
1096 /**
1097  * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1098  * present in the system.
1099  * If an ESRT already exists, the old ESRT is replaced in the system table.
1100  * The memory of the old ESRT is deallocated.
1101  *
1102  * Return:
1103  * - EFI_SUCCESS if the ESRT is correctly created
1104  * - error code otherwise.
1105  */
1106 efi_status_t efi_esrt_populate(void);
1107 efi_status_t efi_load_capsule_drivers(void);
1108
1109 efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
1110
1111 efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1112                                           const efi_guid_t *protocol, void *search_key,
1113                                           efi_uintn_t *no_handles, efi_handle_t **buffer);
1114
1115 efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1116                                  struct efi_file_handle **root);
1117 efi_status_t efi_file_open_int(struct efi_file_handle *this,
1118                                struct efi_file_handle **new_handle,
1119                                u16 *file_name, u64 open_mode,
1120                                u64 attributes);
1121 efi_status_t efi_file_close_int(struct efi_file_handle *file);
1122 efi_status_t efi_file_read_int(struct efi_file_handle *this,
1123                                efi_uintn_t *buffer_size, void *buffer);
1124 efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1125
1126 typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1127 efi_status_t efi_console_get_u16_string
1128                 (struct efi_simple_text_input_protocol *cin,
1129                  u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1130                  int row, int col);
1131
1132 efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1133
1134 #endif /* _EFI_LOADER_H */