blob: 7554f3b7dbc1c32aff102f9e3acb68852a683af6 [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Graf4e0c1c12016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf4e0c1c12016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafc15d9212016-03-04 01:09:59 +010011#include <common.h>
Simon Glass655306c2020-05-10 11:39:58 -060012#include <blk.h>
Simon Glass0f2af882020-05-10 11:40:05 -060013#include <log.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010014#include <part_efi.h>
15#include <efi_api.h>
AKASHI Takahiro2c0f9f72020-04-21 09:38:38 +090016#include <image.h>
AKASHI Takahiro0e104e32020-04-14 11:51:44 +090017#include <pe.h>
Simon Glass97f9bd42021-07-02 12:36:16 -060018#include <linux/list.h>
19#include <linux/oid_registry.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010020
Simon Glass655306c2020-05-10 11:39:58 -060021struct blk_desc;
AKASHI Takahiro4cbba2b2021-07-20 14:57:02 +090022struct jmp_buf_data;
Simon Glass655306c2020-05-10 11:39:58 -060023
Simon Glass16fc74a2019-09-25 08:11:32 -060024static inline int guidcmp(const void *g1, const void *g2)
25{
26 return memcmp(g1, g2, sizeof(efi_guid_t));
27}
28
Sughosh Ganu196f66d2019-12-29 00:01:04 +053029static inline void *guidcpy(void *dst, const void *src)
30{
31 return memcpy(dst, src, sizeof(efi_guid_t));
32}
33
Stephen Warrend0de8062018-08-30 15:43:43 -060034#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010035
Simon Glass97f9bd42021-07-02 12:36:16 -060036/**
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 */
86efi_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 */
92void efi_restore_gd(void);
93/* Call this to set the current device name */
94void 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 */
97void efi_net_set_dhcp_ack(void *pkt, int len);
98/* Print information about all loaded images */
99void efi_print_image_infos(void *pc);
100
101/* Hook at initialization */
102efi_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
110static 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 */
116static inline void efi_restore_gd(void) { }
117static inline void efi_set_bootdev(const char *dev, const char *devnr,
118 const char *path, void *buffer,
119 size_t buffer_size) { }
120static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
121static inline void efi_print_image_infos(void *pc) { }
122static inline efi_status_t efi_launch_capsules(void)
123{
124 return EFI_SUCCESS;
125}
126
127#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100128
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +0200129/* Maximum number of configuration tables */
130#define EFI_MAX_CONFIGURATION_TABLES 16
131
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200132/* 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)
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900136/* 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)
Heinrich Schuchardtc770aaa2020-05-20 22:39:35 +0200140/* 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)
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200144
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900145/* 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
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100150/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100151#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100152
AKASHI Takahiro0b275752019-04-16 13:24:20 +0900153/* Root node */
154extern efi_handle_t efi_root;
155
Heinrich Schuchardtde9bdc62020-03-19 18:21:58 +0000156/* Set to EFI_SUCCESS when initialized */
157extern efi_status_t efi_obj_list_initialized;
158
Heinrich Schuchardt628dbd72020-11-12 21:26:28 +0100159/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
160extern bool efi_st_keep_devices;
161
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100162/* EFI system partition */
163extern struct efi_system_partition {
Simon Glass57b3d2e2022-08-11 19:35:01 -0600164 enum uclass_id if_type;
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100165 int devnum;
166 u8 part;
167} efi_system_partition;
168
Rob Clark86789d52017-07-27 08:04:18 -0400169int __efi_entry_check(void);
170int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200171const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -0400172const char *__efi_nesting_inc(void);
173const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -0400174
Rob Clark63ea77a2017-07-27 08:04:17 -0400175/*
176 * Enter the u-boot world from UEFI:
177 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100178#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -0400179 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400180 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
181 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +0100182 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +0100183
Rob Clark63ea77a2017-07-27 08:04:17 -0400184/*
185 * Exit the u-boot world back to UEFI:
186 */
Rob Clark84a19a02017-07-24 10:31:52 -0400187#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200188 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -0400189 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200190 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -0400191 assert(__efi_exit_check()); \
192 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -0400193 })
Alexander Grafc15d9212016-03-04 01:09:59 +0100194
Rob Clark63ea77a2017-07-27 08:04:17 -0400195/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200196 * 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:
Rob Clark63ea77a2017-07-27 08:04:17 -0400210 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200211#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400212 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400213 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400214 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400215 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400216 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400217 } while(0)
218
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200219/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100220 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200221 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100222#define EFI_PRINT(format, ...) ({ \
223 debug("%sEFI: " format, __efi_nesting(), \
224 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200225 })
226
Alexander Graf59254d62018-04-23 07:59:47 +0200227#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
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900234/* max bootmenu title size for volume selection */
235#define BOOTMENU_DEVICE_NAME_MAX 16
236
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200237/* Key identifying current memory map */
238extern efi_uintn_t efi_memory_map_key;
239
Alexander Graf0bd425a2016-03-04 01:10:01 +0100240extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100241extern struct efi_system_table systab;
242
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200243extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200244extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200245extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200246extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100247/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
248extern const struct efi_device_path_utilities_protocol
249 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200250/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200251extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200252 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900253extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
254extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900255extern const struct efi_hii_database_protocol efi_hii_database;
256extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100257
Rob Clark85dd7212017-09-13 18:05:30 -0400258uint16_t *efi_dp_str(struct efi_device_path *dp);
259
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900260/* GUID for the auto generated boot menu entry */
261extern const efi_guid_t efi_guid_bootmenu_auto_generated;
262
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200263/* GUID of the U-Boot root node */
264extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900265#ifdef CONFIG_SANDBOX
266/* GUID of U-Boot host device on sandbox */
267extern const efi_guid_t efi_guid_host_dev;
268#endif
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100269/* GUID of the EFI_BLOCK_IO_PROTOCOL */
270extern const efi_guid_t efi_block_io_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400271extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100272extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100273extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardte840b9c2022-03-19 07:04:03 +0100274/* GUID of the EFI system partition */
275extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100276/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
277extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +0100278/* event group ExitBootServices() invoked */
279extern const efi_guid_t efi_guid_event_group_exit_boot_services;
280/* event group SetVirtualAddressMap() invoked */
281extern const efi_guid_t efi_guid_event_group_virtual_address_change;
282/* event group memory map changed */
283extern const efi_guid_t efi_guid_event_group_memory_map_change;
284/* event group boot manager about to boot */
285extern const efi_guid_t efi_guid_event_group_ready_to_boot;
286/* event group ResetSystem() invoked (before ExitBootServices) */
287extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +0100288/* GUID of the device tree table */
289extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100290extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900291extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200292extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-09-13 18:05:34 -0400293extern const efi_guid_t efi_simple_file_system_protocol_guid;
294extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt37fb4b92018-04-04 15:42:11 +0200295/* GUID for file system information */
296extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100297extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200298/* GUID of the deprecated Unicode collation protocol */
299extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt485956d2020-12-04 03:33:41 +0100300/* GUIDs of the Load File and Load File2 protocol */
301extern const efi_guid_t efi_guid_load_file_protocol;
302extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200303/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200304extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900305extern const efi_guid_t efi_guid_hii_config_routing_protocol;
306extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900307extern const efi_guid_t efi_guid_hii_database_protocol;
308extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900309/* GUIDs for authentication */
310extern const efi_guid_t efi_guid_image_security_database;
311extern const efi_guid_t efi_guid_sha256;
312extern const efi_guid_t efi_guid_cert_x509;
313extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300314extern const efi_guid_t efi_guid_cert_x509_sha384;
315extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900316extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100317
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530318/* GUID of RNG protocol */
319extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900320/* GUID of capsule update result */
321extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro0d963782020-11-30 18:12:11 +0900322/* GUID of firmware management protocol */
323extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000324/* GUID for the ESRT */
325extern const efi_guid_t efi_esrt_guid;
Masahisa Kojimacd1fe7d2021-10-26 17:27:24 +0900326/* GUID of the SMBIOS table */
327extern const efi_guid_t smbios_guid;
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900328/*GUID of console */
329extern const efi_guid_t efi_guid_text_input_protocol;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530330
Marek Behún69504502021-05-20 13:23:56 +0200331extern char __efi_runtime_start[], __efi_runtime_stop[];
332extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf0bd425a2016-03-04 01:10:01 +0100333
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200334/**
335 * struct efi_open_protocol_info_item - open protocol info item
336 *
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100337 * When a protocol is opened a open protocol info entry is created.
338 * These are maintained in a list.
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200339 *
340 * @link: link to the list of open protocol info entries of a protocol
341 * @info: information about the opening of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100342 */
343struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100344 struct list_head link;
345 struct efi_open_protocol_info_entry info;
346};
347
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200348/**
349 * struct efi_handler - single protocol interface of a handle
350 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100351 * 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
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100353 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200354 *
355 * @link: link to the list of protocols of a handle
356 * @guid: GUID of the protocol
357 * @protocol_interface: protocol interface
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100358 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100359 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100360struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100361 struct list_head link;
Heinrich Schuchardt2a22db92022-03-09 19:56:23 +0100362 const efi_guid_t guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200363 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100364 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100365};
366
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200367/**
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200368 * 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 */
373enum efi_object_type {
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100374 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200375 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100376 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200377 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100378 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200379 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100380 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200381 EFI_OBJECT_TYPE_STARTED_IMAGE,
382};
383
384/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200385 * 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
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100390 * @type: image type if the handle relates to an image
Masahisa Kojimac9611082022-07-22 11:39:10 +0900391 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200392 *
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.
Alexander Grafc15d9212016-03-04 01:09:59 +0100399 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200400 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
401 * has been created for such pointers.
Alexander Grafc15d9212016-03-04 01:09:59 +0100402 */
403struct efi_object {
404 /* Every UEFI object is part of a global object list */
405 struct list_head link;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100406 /* The list of protocols */
407 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200408 enum efi_object_type type;
Masahisa Kojimac9611082022-07-22 11:39:10 +0900409 struct udevice *dev;
Alexander Grafc15d9212016-03-04 01:09:59 +0100410};
411
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900412enum efi_image_auth_status {
413 EFI_IMAGE_AUTH_FAILED = 0,
414 EFI_IMAGE_AUTH_PASSED,
415};
416
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200417/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200418 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200419 *
420 * @header: EFI object header
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200421 * @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()
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100424 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200425 * @entry: entry address of the relocated image
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100426 * @image_type: indicates if the image is an applicition or a driver
427 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200428 */
429struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200430 struct efi_object header;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100431 efi_status_t *exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200432 efi_uintn_t *exit_data_size;
433 u16 **exit_data;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100434 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200435 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
436 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200437 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900438 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200439};
440
441/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200442 * struct efi_event
443 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100444 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200445 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200446 * @type: Type of event, see efi_create_event
447 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100448 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200449 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100450 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100451 * @trigger_time: Period of the timer
452 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200453 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100454 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200455 */
456struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100457 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200458 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200459 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100460 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200461 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
462 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100463 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200464 u64 trigger_next;
465 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200466 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200467 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200468};
469
Alexander Grafc15d9212016-03-04 01:09:59 +0100470/* This list contains all UEFI objects we know of */
471extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100472/* List of all events */
473extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100474
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200475/**
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200476 * 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 */
485struct efi_protocol_notification {
486 struct list_head link;
487 efi_handle_t handle;
488};
489
490/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100491 * struct efi_register_notify_event - event registered by
492 * RegisterProtocolNotify()
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200493 *
494 * The address of this structure serves as registration value.
495 *
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200496 * @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
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200502 */
503struct efi_register_notify_event {
504 struct list_head link;
505 struct efi_event *event;
506 efi_guid_t protocol;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200507 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200508};
509
510/* List of all events registered by RegisterProtocolNotify() */
511extern struct list_head efi_register_notify_events;
512
AKASHI Takahiroa36dc252022-04-19 10:05:11 +0900513/* called at pre-initialization */
514int efi_init_early(void);
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100515/* Initialize efi execution environment */
516efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt761908e2022-06-14 08:02:03 +0200517/* Set up console modes */
518void efi_setup_console_size(void);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100519/* Install device tree */
520efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtffb90592019-12-07 20:51:06 +0100521/* Run loaded UEFI image */
522efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardtcf3b1182019-06-20 13:52:16 +0200523/* Initialize variable services */
524efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200525/* Notify ExitBootServices() is called */
526void efi_variables_boot_exit_notify(void);
Masahisa Kojima1ac19bb2021-08-13 16:12:41 +0900527efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900528/* Measure efi application invocation */
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900529efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900530/* Measure efi application exit */
531efi_status_t efi_tcg2_measure_efi_app_exit(void);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200532/* Called by bootefi to initialize root node */
533efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200534/* Called by bootefi to initialize runtime */
535efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200536/* efi_runtime_detach() - detach unimplemented runtime functions */
537void efi_runtime_detach(void);
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100538/* efi_convert_pointer() - convert pointer to virtual address */
539efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
540 void **address);
Heinrich Schuchardt2c1e2242020-12-13 10:30:24 +0100541/* Carve out DT reserved memory ranges */
542void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimase4e56602022-01-03 14:07:37 +0200543/* Purge unused kaslr-seed */
544void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200545/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200546efi_status_t efi_console_register(void);
Heinrich Schuchardta02228f2022-08-31 16:37:35 +0200547/* Called by efi_init_early() to add block devices when probed */
AKASHI Takahiro2381f2e2022-04-19 10:05:12 +0900548efi_status_t efi_disk_init(void);
Heinrich Schuchardta02228f2022-08-31 16:37:35 +0200549/* Called by efi_init_obj_list() to proble all block devices */
550efi_status_t efi_disks_register(void);
Heinrich Schuchardtc63f68f2020-09-25 12:50:19 +0200551/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
552efi_status_t efi_rng_register(void);
Ilias Apalodimas590fef62020-11-11 11:18:11 +0200553/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
554efi_status_t efi_tcg2_register(void);
Sunil V L279d1c82022-01-28 20:48:44 +0530555/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
556efi_status_t efi_riscv_register(void);
Masahisa Kojima0fd43792021-12-07 14:15:31 +0900557/* Called by efi_init_obj_list() to do initial measurement */
558efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900559/* measure the pe-coff image, extend PCR and add Event Log */
560efi_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);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100563/* Create handles and protocols for the partitions of a block device */
564int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
565 const char *if_typename, int diskid,
566 const char *pdevname);
Alexander Grafd65783d2016-03-15 18:38:21 +0100567/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100568efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200569/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100570efi_status_t efi_net_register(void);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200571/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100572efi_status_t efi_watchdog_register(void);
Ilias Apalodimas3510ba72020-02-21 09:55:45 +0200573efi_status_t efi_initrd_register(void);
Ilias Apalodimasb307e3d2021-03-17 21:55:00 +0200574void efi_initrd_deregister(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200575/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600576/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700577 * efi_acpi_register() - write out ACPI tables
578 *
579 * Called by bootefi to make ACPI tables available
580 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100581 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng2cfbdae2018-06-27 20:38:03 -0700582 */
583efi_status_t efi_acpi_register(void);
584/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600585 * efi_smbios_register() - write out SMBIOS tables
586 *
587 * Called by bootefi to make SMBIOS tables available
588 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100589 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass2e2858f2018-05-16 09:42:19 -0600590 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100591efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200592
Rob Clark53142032017-09-13 18:05:34 -0400593struct efi_simple_file_system_protocol *
594efi_fs_from_path(struct efi_device_path *fp);
595
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200596/* Called by efi_set_watchdog_timer to reset the timer */
597efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200598
Alexander Grafc15d9212016-03-04 01:09:59 +0100599/* Called from places to check whether a timer expired */
600void efi_timer_check(void);
Heinrich Schuchardtad6e0f72021-01-12 12:40:32 +0100601/* Check if a buffer contains a PE-COFF image */
602efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafc15d9212016-03-04 01:09:59 +0100603/* PE loader implementation */
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900604efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
605 void *efi, size_t efi_size,
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100606 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100607/* Called once to store the pristine gd pointer */
608void efi_save_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100609/* Call this to relocate the runtime section to an address space */
610void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silva433f15a2022-05-11 10:55:40 +0100611/* Call this to get image parameters */
612void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100613/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200614void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200615/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100616efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100617/* Delete handle */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200618void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100619/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100620struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahiro537a6932022-04-28 17:09:38 +0900621/* Locate device_path handle */
622efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
623 struct efi_device_path **device_path,
624 efi_handle_t *device);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900625/* Load image */
626efi_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);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100632/* Start image */
633efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
634 efi_uintn_t *exit_data_size,
635 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900636/* Unload image */
637efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200638/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100639efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200640 const efi_guid_t *protocol_guid,
641 struct efi_handler **handler);
642/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100643efi_status_t efi_add_protocol(const efi_handle_t handle,
644 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200645 void *protocol_interface);
Heinrich Schuchardt9c89d142020-01-10 12:33:59 +0100646/* Open protocol */
647efi_status_t efi_protocol_open(struct efi_handler *handler,
648 void **protocol_interface, void *agent_handle,
649 void *controller_handle, uint32_t attributes);
650
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200651/* Delete protocol from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100652efi_status_t efi_remove_protocol(const efi_handle_t handle,
653 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200654 void *protocol_interface);
655/* Delete all protocols from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100656efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200657/* Install multiple protocol interfaces */
658efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
659 (efi_handle_t *handle, ...);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900660/* Get handles that support a given protocol */
661efi_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 */
666efi_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 */
671efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
672 const efi_guid_t *protocol,
673 void **protocol_interface);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200674/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100675efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200676 void (EFIAPI *notify_function) (
677 struct efi_event *event,
678 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100679 void *notify_context, efi_guid_t *group,
680 struct efi_event **event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200681/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200682efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200683 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200684/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200685void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100686
AKASHI Takahiroba647af2022-05-12 11:29:01 +0900687/* return true if the device is removable */
688bool efi_disk_is_removable(efi_handle_t handle);
689
Rob Clark53142032017-09-13 18:05:34 -0400690/* open file system: */
691struct 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: */
695struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
696
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000697/* Registers a callback function for a notification event. */
698efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
699 struct efi_event *event,
700 void **registration);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200701efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
702
703/* get a device path from a Boot#### option */
704struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
705
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300706/* get len, string (used in u-boot crypto from a guid */
707const char *guid_to_sha_str(const efi_guid_t *guid);
708int algo_to_len(const char *algo);
709
Masahisa Kojimac9611082022-07-22 11:39:10 +0900710int efi_link_dev(efi_handle_t handle, struct udevice *dev);
711
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100712/**
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 */
Heinrich Schuchardtaefb0c42021-01-17 07:52:09 +0100721#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf8623f922016-03-04 01:10:04 +0100722/* Generic EFI memory allocator, call this to get memory */
723void *efi_alloc(uint64_t len, int memory_type);
Ilias Apalodimas6e01c232021-10-11 15:10:23 +0300724/* Allocate pages on the specified alignment */
725void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf8623f922016-03-04 01:10:04 +0100726/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200727efi_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);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200730/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100731efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200732/* EFI memory allocator for small allocations */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200733efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
734 efi_uintn_t size, void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200735/* EFI pool memory free function. */
736efi_status_t efi_free_pool(void *buffer);
Alexander Graf8623f922016-03-04 01:10:04 +0100737/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100738efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100739 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100740 efi_uintn_t *map_key,
741 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100742 uint32_t *descriptor_version);
743/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200744efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidene009e7a2019-09-03 17:43:43 +0000745/* Adds a conventional range into the EFI memory map */
746efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
747 u64 ram_top);
748
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100749/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100750efi_status_t efi_driver_init(void);
Alexander Graf8623f922016-03-04 01:10:04 +0100751/* Called by board init to initialize the EFI memory map */
752int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200753/* Adds new or overrides configuration table entry to the system table */
754efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100755/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200756efi_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);
Alexander Graf8623f922016-03-04 01:10:04 +0100760
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200761#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
762extern void *efi_bounce_buffer;
763#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
764#endif
765
Heinrich Schuchardt24f0e6a2022-02-26 12:10:10 +0100766/* shorten device path */
767struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400768struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200769int efi_dp_match(const struct efi_device_path *a,
770 const struct efi_device_path *b);
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100771efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardt0a04a412022-03-19 06:35:43 +0100772 const efi_guid_t *guid,
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100773 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200774/* get size of the first device path instance excluding end node */
775efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
776/* size of multi-instance device path excluding end node */
777efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400778struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
779struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
780 const struct efi_device_path *dp2);
781struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
782 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200783/* Create a device path node of given type, sub-type, length */
784struct efi_device_path *efi_dp_create_device_node(const u8 type,
785 const u8 sub_type,
786 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200787/* Append device path instance */
788struct 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 */
792struct 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 */
795bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400796
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400797struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100798/* Create a device node for a block device partition. */
799struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400800struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
801 const char *path);
802struct efi_device_path *efi_dp_from_eth(void);
Rob Clark18ceba72017-10-10 08:23:06 -0400803struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
804 uint64_t start_address,
805 uint64_t end_address);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100806/* Determine the last device path node that is not the end node. */
807const struct efi_device_path *efi_dp_last_node(
808 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100809efi_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);
Heinrich Schuchardt81244ea2022-02-04 20:47:09 +0100812struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900813efi_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);
Heinrich Schuchardt22c8e082020-08-23 10:49:46 +0200817ssize_t efi_dp_check_length(const struct efi_device_path *dp,
818 const size_t maxlen);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400819
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
Masahisa Kojima97bd9da2022-06-19 13:55:59 +0900824/* template END node: */
825extern const struct efi_device_path END;
826
AKASHI Takahiro32401842019-06-05 13:21:38 +0900827/* Indicate supported runtime services */
828efi_status_t efi_init_runtime_supported(void);
829
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200830/* Update CRC32 in table header */
831void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
832
Alexander Graf77256092016-08-16 21:08:45 +0200833/* Boards may provide the functions below to implement RTS functionality */
834
Alexander Graf393dd912016-10-14 13:45:30 +0200835void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200836 enum efi_reset_type reset_type,
837 efi_status_t reset_status,
838 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100839
840/* Architecture specific initialization of the EFI subsystem */
841efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200842
Alexander Graf393dd912016-10-14 13:45:30 +0200843efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200844 struct efi_time *time,
845 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200846
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200847efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
848
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200849#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
850/*
851 * Entry point for the tests of the EFI API.
852 * It is called by 'bootefi selftest'
853 */
854efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
855 struct efi_system_table *systab);
856#endif
857
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100858efi_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);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200861efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
862 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100863 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100864efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
865 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100866 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400867
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200868efi_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
Heinrich Schuchardt1ad2f0d2021-09-09 07:12:14 +0200873void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200874
AKASHI Takahirobd237742018-11-05 18:06:41 +0900875/*
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 */
888struct efi_load_option {
889 u32 attributes;
890 u16 file_path_length;
891 u16 *label;
892 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +0200893 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +0900894};
895
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200896struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt9979cff2021-10-15 01:31:02 +0200897 const efi_guid_t *guid);
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200898struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
899 const struct efi_device_path *dp2);
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900900struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt7ca84f82020-05-31 22:46:09 +0200901efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
902 efi_uintn_t *size);
AKASHI Takahirobd237742018-11-05 18:06:41 +0900903unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt25c6be52020-08-07 17:47:13 +0200904efi_status_t efi_set_load_options(efi_handle_t handle,
905 efi_uintn_t load_options_size,
906 void *load_options);
Heinrich Schuchardta7647a72020-08-07 17:49:39 +0200907efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clarkc84c1102017-09-13 18:05:38 -0400908
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900909/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100910 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900911 *
912 * @max: Maximum number of regions
913 * @num: Number of regions
914 * @reg: array of regions
915 */
916struct efi_image_regions {
917 int max;
918 int num;
919 struct image_region reg[];
920};
921
922/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100923 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900924 *
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
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100929 * @owner: Signature owner
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900930 * @data: Pointer to signature data
931 * @size: Size of signature data
932 */
933struct efi_sig_data {
934 struct efi_sig_data *next;
935 efi_guid_t owner;
936 void *data;
937 size_t size;
938};
939
940/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100941 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900942 *
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 */
949struct 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
955struct x509_certificate;
956struct pkcs7_message;
957
Masahisa Kojima767a9e62022-09-12 17:33:54 +0900958/**
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 */
968struct eficonfig_media_boot_option {
969 void *lo;
970 efi_uintn_t size;
971 bool exist;
972};
973
AKASHI Takahirof47b9b32022-07-05 14:48:12 +0900974bool efi_hash_regions(struct image_region *regs, int count,
975 void **hash, const char *hash_algo, int *len);
AKASHI Takahirode924072020-07-08 14:01:57 +0900976bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas71eae982022-01-29 00:20:31 +0200977 struct efi_signature_store *db,
978 bool dbx);
AKASHI Takahiro14afd062020-07-21 19:35:22 +0900979bool 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);
AKASHI Takahiro16411802020-08-14 14:39:23 +0900983static 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}
AKASHI Takahiro4154b642020-07-08 14:01:56 +0900989bool efi_signature_check_signers(struct pkcs7_message *msg,
990 struct efi_signature_store *dbx);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900991
992efi_status_t efi_image_region_add(struct efi_image_regions *regs,
993 const void *start, const void *end,
994 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900995
996void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganufa0faa62020-12-30 19:27:08 +0530997struct efi_signature_store *efi_build_signature_store(void *sig_list,
998 efi_uintn_t size);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900999struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +09001000
1001bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001002
Sughosh Ganu586bb982020-12-30 19:27:09 +05301003bool efi_capsule_auth_enabled(void);
1004
Masahisa Kojima70be5a62021-05-26 12:09:58 +09001005void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1006
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001007bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1008 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001009
Sughosh Ganuea350082020-12-30 19:27:07 +05301010struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1011 size_t buflen,
1012 u8 **tmpbuf);
1013
Heinrich Schuchardt8cd99752020-06-28 16:30:29 +02001014/* runtime implementation of memcpy() */
1015void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1016
AKASHI Takahiro94074682020-10-29 13:47:46 +09001017/* commonly used helper function */
Ilias Apalodimas21575292020-12-31 12:26:46 +02001018u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1019 unsigned int index);
AKASHI Takahiro94074682020-10-29 13:47:46 +09001020
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001021extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahiro7ff3f3c2020-11-17 09:28:00 +09001022extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001023
AKASHI Takahiro473d9b32020-11-17 09:27:55 +09001024/* Capsule update */
1025efi_status_t EFIAPI efi_update_capsule(
1026 struct efi_capsule_header **capsule_header_array,
1027 efi_uintn_t capsule_count,
1028 u64 scatter_gather_list);
1029efi_status_t EFIAPI efi_query_capsule_caps(
1030 struct efi_capsule_header **capsule_header_array,
1031 efi_uintn_t capsule_count,
1032 u64 *maximum_capsule_size,
1033 u32 *reset_type);
1034
Sughosh Ganu586bb982020-12-30 19:27:09 +05301035efi_status_t efi_capsule_authenticate(const void *capsule,
1036 efi_uintn_t capsule_size,
1037 void **image, efi_uintn_t *image_size);
1038
Simon Glass90975372022-01-23 12:55:12 -07001039#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiro45b819542020-11-17 09:27:56 +09001040
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001041/**
Sughosh Ganuccb36462022-04-15 11:29:34 +05301042 * struct efi_fw_image - Information on firmware images updatable through
1043 * capsule update
1044 *
1045 * This structure gives information about the firmware images on the platform
1046 * which can be updated through the capsule update mechanism
1047 *
1048 * @image_type_id: Image GUID. Same value is to be used in the capsule
1049 * @fw_name: Name of the firmware image
1050 * @image_index: Image Index, same as value passed to SetImage FMP
1051 * function
1052 */
1053struct efi_fw_image {
1054 efi_guid_t image_type_id;
1055 u16 *fw_name;
1056 u8 image_index;
1057};
1058
1059/**
1060 * struct efi_capsule_update_info - Information needed for capsule updates
1061 *
1062 * This structure provides information needed for performing firmware
1063 * updates. The structure needs to be initialised per platform, for all
1064 * platforms which enable capsule updates
1065 *
1066 * @dfu_string: String used to populate dfu_alt_info
1067 * @images: Pointer to an array of updatable images
1068 */
1069struct efi_capsule_update_info {
1070 const char *dfu_string;
1071 struct efi_fw_image *images;
1072};
1073
1074extern struct efi_capsule_update_info update_info;
1075extern u8 num_image_type_guids;
1076
1077/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001078 * Install the ESRT system table.
1079 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001080 * Return: status code
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001081 */
1082efi_status_t efi_esrt_register(void);
1083
1084/**
Jose Marinhoff72cb32021-12-23 14:51:07 +00001085 * efi_ecpt_register() - Install the ECPT system table.
1086 *
1087 * Return: status code
1088 */
1089efi_status_t efi_ecpt_register(void);
1090
1091/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001092 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1093 * present in the system.
1094 * If an ESRT already exists, the old ESRT is replaced in the system table.
1095 * The memory of the old ESRT is deallocated.
1096 *
1097 * Return:
1098 * - EFI_SUCCESS if the ESRT is correctly created
1099 * - error code otherwise.
1100 */
1101efi_status_t efi_esrt_populate(void);
Ilias Apalodimasfac773e2021-06-22 17:38:53 +03001102efi_status_t efi_load_capsule_drivers(void);
Ruchika Guptabc9495c2021-11-29 13:09:44 +05301103
1104efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +09001105
1106efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1107 const efi_guid_t *protocol, void *search_key,
1108 efi_uintn_t *no_handles, efi_handle_t **buffer);
1109
1110efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1111 struct efi_file_handle **root);
1112efi_status_t efi_file_open_int(struct efi_file_handle *this,
1113 struct efi_file_handle **new_handle,
1114 u16 *file_name, u64 open_mode,
1115 u64 attributes);
1116efi_status_t efi_file_close_int(struct efi_file_handle *file);
1117efi_status_t efi_file_read_int(struct efi_file_handle *this,
1118 efi_uintn_t *buffer_size, void *buffer);
1119efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1120
1121typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1122efi_status_t efi_console_get_u16_string
1123 (struct efi_simple_text_input_protocol *cin,
1124 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1125 int row, int col);
1126
1127efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1128
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02001129#endif /* _EFI_LOADER_H */