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