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