blob: 11e08a804f7f428057778263730905407306caff [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Grafcb149c62016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafcb149c62016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafbee91162016-03-04 01:09:59 +010011#include <common.h>
Simon Glasse6f6f9e2020-05-10 11:39:58 -060012#include <blk.h>
Heinrich Schuchardtf05911a2022-10-06 07:29:41 +020013#include <event.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060014#include <log.h>
Alexander Grafcb149c62016-03-04 01:09:58 +010015#include <part_efi.h>
16#include <efi_api.h>
AKASHI Takahirod9f33072020-04-21 09:38:38 +090017#include <image.h>
AKASHI Takahiro4540dab2020-04-14 11:51:44 +090018#include <pe.h>
Simon Glass6e3c6542021-07-02 12:36:16 -060019#include <linux/list.h>
20#include <linux/oid_registry.h>
Alexander Grafbee91162016-03-04 01:09:59 +010021
Simon Glasse6f6f9e2020-05-10 11:39:58 -060022struct blk_desc;
AKASHI Takahiro86a3d432021-07-20 14:57:02 +090023struct jmp_buf_data;
Simon Glasse6f6f9e2020-05-10 11:39:58 -060024
Simon Glassfdeb6f72019-09-25 08:11:32 -060025static inline int guidcmp(const void *g1, const void *g2)
26{
27 return memcmp(g1, g2, sizeof(efi_guid_t));
28}
29
Sughosh Ganu61e42d92019-12-29 00:01:04 +053030static inline void *guidcpy(void *dst, const void *src)
31{
32 return memcpy(dst, src, sizeof(efi_guid_t));
33}
34
Stephen Warren9b5e6392018-08-30 15:43:43 -060035#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafbee91162016-03-04 01:09:59 +010036
Simon Glass6e3c6542021-07-02 12:36:16 -060037/**
38 * __efi_runtime_data - declares a non-const variable for EFI runtime section
39 *
40 * This macro indicates that a variable is non-const and should go into the
41 * EFI runtime section, and thus still be available when the OS is running.
42 *
43 * Only use on variables not declared const.
44 *
45 * Example:
46 *
47 * ::
48 *
49 * static __efi_runtime_data my_computed_table[256];
50 */
51#define __efi_runtime_data __section(".data.efi_runtime")
52
53/**
54 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
55 *
56 * This macro indicates that a variable is read-only (const) and should go into
57 * the EFI runtime section, and thus still be available when the OS is running.
58 *
59 * Only use on variables also declared const.
60 *
61 * Example:
62 *
63 * ::
64 *
65 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
66 */
67#define __efi_runtime_rodata __section(".rodata.efi_runtime")
68
69/**
70 * __efi_runtime - declares a function for EFI runtime section
71 *
72 * This macro indicates that a function should go into the EFI runtime section,
73 * and thus still be available when the OS is running.
74 *
75 * Example:
76 *
77 * ::
78 *
79 * static __efi_runtime compute_my_table(void);
80 */
81#define __efi_runtime __section(".text.efi_runtime")
82
83/*
84 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
85 * to make it available at runtime
86 */
87efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
88
89/*
90 * Special case handler for error/abort that just tries to dtrt to get
91 * back to u-boot world
92 */
93void efi_restore_gd(void);
94/* Call this to set the current device name */
95void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
96 void *buffer, size_t buffer_size);
97/* Called by networking code to memorize the dhcp ack package */
98void efi_net_set_dhcp_ack(void *pkt, int len);
99/* Print information about all loaded images */
100void efi_print_image_infos(void *pc);
101
102/* Hook at initialization */
103efi_status_t efi_launch_capsules(void);
104
105#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
106
107/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
108#define __efi_runtime_data
109#define __efi_runtime_rodata
110#define __efi_runtime
111static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
112{
113 return EFI_SUCCESS;
114}
115
116/* No loader configured, stub out EFI_ENTRY */
117static inline void efi_restore_gd(void) { }
118static inline void efi_set_bootdev(const char *dev, const char *devnr,
119 const char *path, void *buffer,
120 size_t buffer_size) { }
121static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
122static inline void efi_print_image_infos(void *pc) { }
123static inline efi_status_t efi_launch_capsules(void)
124{
125 return EFI_SUCCESS;
126}
127
128#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafcb149c62016-03-04 01:09:58 +0100129
Heinrich Schuchardt4182a122018-06-28 12:45:32 +0200130/* Maximum number of configuration tables */
131#define EFI_MAX_CONFIGURATION_TABLES 16
132
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200133/* GUID used by the root node */
134#define U_BOOT_GUID \
135 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
136 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
Tobias Waldekranz272ec6b2023-02-16 16:33:55 +0100137/* GUID used as root for blkmap devices */
138#define U_BOOT_BLKMAP_DEV_GUID \
139 EFI_GUID(0x4cad859d, 0xd644, 0x42ff, \
140 0x87, 0x0b, 0xc0, 0x2e, 0xac, 0x05, 0x58, 0x63)
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900141/* GUID used as host device on sandbox */
142#define U_BOOT_HOST_DEV_GUID \
143 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
144 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardt19ecced2020-05-20 22:39:35 +0200145/* GUID used as root for virtio devices */
146#define U_BOOT_VIRTIO_DEV_GUID \
147 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
148 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200149
Masahisa Kojima87d79142022-09-12 17:33:50 +0900150/* GUID for the auto generated boot menu entry */
151#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
152 EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \
153 0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde)
154
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100155/* Use internal device tree when starting UEFI application */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100156#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100157
AKASHI Takahiroa2a4bc32019-04-16 13:24:20 +0900158/* Root node */
159extern efi_handle_t efi_root;
160
Heinrich Schuchardt15b1bf12020-03-19 18:21:58 +0000161/* Set to EFI_SUCCESS when initialized */
162extern efi_status_t efi_obj_list_initialized;
163
Heinrich Schuchardtfccd3d92020-11-12 21:26:28 +0100164/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
165extern bool efi_st_keep_devices;
166
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +0100167/* EFI system partition */
168extern struct efi_system_partition {
Simon Glass8149b152022-09-17 09:00:09 -0600169 enum uclass_id uclass_id;
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +0100170 int devnum;
171 u8 part;
172} efi_system_partition;
173
Rob Clarkc160d2f2017-07-27 08:04:18 -0400174int __efi_entry_check(void);
175int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200176const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -0400177const char *__efi_nesting_inc(void);
178const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400179
Rob Clarka095aad2017-07-27 08:04:17 -0400180/*
181 * Enter the u-boot world from UEFI:
182 */
Alexander Grafbee91162016-03-04 01:09:59 +0100183#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400184 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400185 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
186 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +0100187 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +0100188
Rob Clarka095aad2017-07-27 08:04:17 -0400189/*
190 * Exit the u-boot world back to UEFI:
191 */
Rob Clark804b1d72017-07-24 10:31:52 -0400192#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200193 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -0400194 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200195 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400196 assert(__efi_exit_check()); \
197 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -0400198 })
Alexander Grafbee91162016-03-04 01:09:59 +0100199
Rob Clarka095aad2017-07-27 08:04:17 -0400200/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200201 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -0400202 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200203#define EFI_CALL(exp) ({ \
204 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
205 assert(__efi_exit_check()); \
206 typeof(exp) _r = exp; \
207 assert(__efi_entry_check()); \
208 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
209 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
210 _r; \
211})
212
213/*
214 * Call void UEFI function from u-boot:
215 */
216#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -0400217 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400218 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -0400219 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400220 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400221 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -0400222 } while(0)
223
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200224/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100225 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200226 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100227#define EFI_PRINT(format, ...) ({ \
228 debug("%sEFI: " format, __efi_nesting(), \
229 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200230 })
231
Alexander Graf89aea432018-04-23 07:59:47 +0200232#ifdef CONFIG_SYS_CACHELINE_SIZE
233#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
234#else
235/* Just use the greatest cache flush alignment requirement I'm aware of */
236#define EFI_CACHELINE_SIZE 128
237#endif
238
Masahisa Kojima87d79142022-09-12 17:33:50 +0900239/* max bootmenu title size for volume selection */
240#define BOOTMENU_DEVICE_NAME_MAX 16
241
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +0200242/* Key identifying current memory map */
243extern efi_uintn_t efi_memory_map_key;
244
Alexander Graf50149ea2016-03-04 01:10:01 +0100245extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100246extern struct efi_system_table systab;
247
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200248extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200249extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200250extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200251extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100252/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
253extern const struct efi_device_path_utilities_protocol
254 efi_device_path_utilities;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200255/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200256extern const struct efi_unicode_collation_protocol
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200257 efi_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900258extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
259extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900260extern const struct efi_hii_database_protocol efi_hii_database;
261extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100262
Rob Clarkadae4312017-09-13 18:05:30 -0400263uint16_t *efi_dp_str(struct efi_device_path *dp);
264
Masahisa Kojima87d79142022-09-12 17:33:50 +0900265/* GUID for the auto generated boot menu entry */
266extern const efi_guid_t efi_guid_bootmenu_auto_generated;
267
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200268/* GUID of the U-Boot root node */
269extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900270#ifdef CONFIG_SANDBOX
271/* GUID of U-Boot host device on sandbox */
272extern const efi_guid_t efi_guid_host_dev;
273#endif
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +0100274/* GUID of the EFI_BLOCK_IO_PROTOCOL */
275extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400276extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100277extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100278extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt90dcd9b2022-03-19 07:04:03 +0100279/* GUID of the EFI system partition */
280extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100281/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
282extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100283/* event group ExitBootServices() invoked */
284extern const efi_guid_t efi_guid_event_group_exit_boot_services;
285/* event group SetVirtualAddressMap() invoked */
286extern const efi_guid_t efi_guid_event_group_virtual_address_change;
287/* event group memory map changed */
288extern const efi_guid_t efi_guid_event_group_memory_map_change;
289/* event group boot manager about to boot */
290extern const efi_guid_t efi_guid_event_group_ready_to_boot;
291/* event group ResetSystem() invoked (before ExitBootServices) */
292extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100293/* GUID of the device tree table */
294extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100295extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900296extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200297extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400298extern const efi_guid_t efi_simple_file_system_protocol_guid;
299extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200300/* GUID for file system information */
301extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100302extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200303/* GUID of the deprecated Unicode collation protocol */
304extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardtb6f11092020-12-04 03:33:41 +0100305/* GUIDs of the Load File and Load File2 protocol */
306extern const efi_guid_t efi_guid_load_file_protocol;
307extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200308/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200309extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900310extern const efi_guid_t efi_guid_hii_config_routing_protocol;
311extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900312extern const efi_guid_t efi_guid_hii_database_protocol;
313extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900314/* GUIDs for authentication */
315extern const efi_guid_t efi_guid_image_security_database;
316extern const efi_guid_t efi_guid_sha256;
317extern const efi_guid_t efi_guid_cert_x509;
318extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300319extern const efi_guid_t efi_guid_cert_x509_sha384;
320extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900321extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100322
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530323/* GUID of RNG protocol */
324extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900325/* GUID of capsule update result */
326extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900327/* GUID of firmware management protocol */
328extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinho64a8aae2021-03-02 17:26:38 +0000329/* GUID for the ESRT */
330extern const efi_guid_t efi_esrt_guid;
Masahisa Kojima3d49ee82021-10-26 17:27:24 +0900331/* GUID of the SMBIOS table */
332extern const efi_guid_t smbios_guid;
Masahisa Kojima87d79142022-09-12 17:33:50 +0900333/*GUID of console */
334extern const efi_guid_t efi_guid_text_input_protocol;
Masahisa Kojima8dbd0a02023-01-24 15:56:15 +0900335extern const efi_guid_t efi_guid_text_output_protocol;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530336
Marek Behún2bdc6f52021-05-20 13:23:56 +0200337extern char __efi_runtime_start[], __efi_runtime_stop[];
338extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf50149ea2016-03-04 01:10:01 +0100339
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200340/**
341 * struct efi_open_protocol_info_item - open protocol info item
342 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100343 * When a protocol is opened a open protocol info entry is created.
344 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200345 *
346 * @link: link to the list of open protocol info entries of a protocol
347 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100348 */
349struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100350 struct list_head link;
351 struct efi_open_protocol_info_entry info;
352};
353
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200354/**
355 * struct efi_handler - single protocol interface of a handle
356 *
Alexander Grafbee91162016-03-04 01:09:59 +0100357 * When the UEFI payload wants to open a protocol on an object to get its
358 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100359 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200360 *
361 * @link: link to the list of protocols of a handle
362 * @guid: GUID of the protocol
363 * @protocol_interface: protocol interface
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100364 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100365 */
Alexander Grafbee91162016-03-04 01:09:59 +0100366struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100367 struct list_head link;
Heinrich Schuchardt66028932022-03-09 19:56:23 +0100368 const efi_guid_t guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200369 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100370 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100371};
372
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200373/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200374 * enum efi_object_type - type of EFI object
375 *
376 * In UnloadImage we must be able to identify if the handle relates to a
377 * started image.
378 */
379enum efi_object_type {
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100380 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200381 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100382 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200383 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100384 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200385 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100386 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200387 EFI_OBJECT_TYPE_STARTED_IMAGE,
388};
389
390/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200391 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100392 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200393 * @link: pointers to put the handle into a linked list
394 * @protocols: linked list with the protocol interfaces installed on this
395 * handle
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100396 * @type: image type if the handle relates to an image
Masahisa Kojimaee576662022-07-22 11:39:10 +0900397 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200398 *
399 * UEFI offers a flexible and expandable object model. The objects in the UEFI
400 * API are devices, drivers, and loaded images. struct efi_object is our storage
401 * structure for these objects.
402 *
403 * When including this structure into a larger structure always put it first so
404 * that when deleting a handle the whole encompassing structure can be freed.
405 *
406 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
407 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100408 */
409struct efi_object {
410 /* Every UEFI object is part of a global object list */
411 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100412 /* The list of protocols */
413 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200414 enum efi_object_type type;
Masahisa Kojimaee576662022-07-22 11:39:10 +0900415 struct udevice *dev;
Alexander Grafbee91162016-03-04 01:09:59 +0100416};
417
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900418enum efi_image_auth_status {
419 EFI_IMAGE_AUTH_FAILED = 0,
420 EFI_IMAGE_AUTH_PASSED,
421};
422
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200423/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200424 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200425 *
426 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200427 * @exit_status: exit status passed to Exit()
428 * @exit_data_size: exit data size passed to Exit()
429 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100430 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200431 * @entry: entry address of the relocated image
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100432 * @image_type: indicates if the image is an applicition or a driver
433 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200434 */
435struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200436 struct efi_object header;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100437 efi_status_t *exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200438 efi_uintn_t *exit_data_size;
439 u16 **exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100440 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200441 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
442 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200443 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900444 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200445};
446
447/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200448 * struct efi_event
449 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100450 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200451 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200452 * @type: Type of event, see efi_create_event
453 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100454 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200455 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100456 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100457 * @trigger_time: Period of the timer
458 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200459 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100460 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200461 */
462struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100463 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200464 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200465 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100466 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200467 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
468 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100469 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200470 u64 trigger_next;
471 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200472 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200473 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200474};
475
Alexander Grafbee91162016-03-04 01:09:59 +0100476/* This list contains all UEFI objects we know of */
477extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100478/* List of all events */
479extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100480
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200481/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200482 * struct efi_protocol_notification - handle for notified protocol
483 *
484 * When a protocol interface is installed for which an event was registered with
485 * the RegisterProtocolNotify() service this structure is used to hold the
486 * handle on which the protocol interface was installed.
487 *
488 * @link: link to list of all handles notified for this event
489 * @handle: handle on which the notified protocol interface was installed
490 */
491struct efi_protocol_notification {
492 struct list_head link;
493 efi_handle_t handle;
494};
495
496/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100497 * struct efi_register_notify_event - event registered by
498 * RegisterProtocolNotify()
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200499 *
500 * The address of this structure serves as registration value.
501 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200502 * @link: link to list of all registered events
503 * @event: registered event. The same event may registered for multiple
504 * GUIDs.
505 * @protocol: protocol for which the event is registered
506 * @handles: linked list of all handles on which the notified protocol was
507 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200508 */
509struct efi_register_notify_event {
510 struct list_head link;
511 struct efi_event *event;
512 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200513 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200514};
515
AKASHI Takahiroa57ad202022-04-19 10:05:11 +0900516/* called at pre-initialization */
517int efi_init_early(void);
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100518/* Initialize efi execution environment */
519efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt68edbed2022-06-14 08:02:03 +0200520/* Set up console modes */
521void efi_setup_console_size(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100522/* Install device tree */
523efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100524/* Run loaded UEFI image */
525efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200526/* Initialize variable services */
527efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200528/* Notify ExitBootServices() is called */
529void efi_variables_boot_exit_notify(void);
Masahisa Kojimafdff03e2021-08-13 16:12:41 +0900530efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900531/* Measure efi application invocation */
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900532efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900533/* Measure efi application exit */
534efi_status_t efi_tcg2_measure_efi_app_exit(void);
Etienne Carriereaa2d3942023-02-16 17:29:48 +0100535/* Measure DTB */
536efi_status_t efi_tcg2_measure_dtb(void *dtb);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200537/* Called by bootefi to initialize root node */
538efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200539/* Called by bootefi to initialize runtime */
540efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200541/* efi_runtime_detach() - detach unimplemented runtime functions */
542void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100543/* efi_convert_pointer() - convert pointer to virtual address */
544efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
545 void **address);
Heinrich Schuchardt94686f62020-12-13 10:30:24 +0100546/* Carve out DT reserved memory ranges */
547void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimasa2f14822022-01-03 14:07:37 +0200548/* Purge unused kaslr-seed */
549void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200550/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200551efi_status_t efi_console_register(void);
Heinrich Schuchardtd5391bf2022-08-31 16:37:35 +0200552/* Called by efi_init_obj_list() to proble all block devices */
553efi_status_t efi_disks_register(void);
Heinrich Schuchardtb59c13d2020-09-25 12:50:19 +0200554/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
555efi_status_t efi_rng_register(void);
Ilias Apalodimasc1c02102020-11-11 11:18:11 +0200556/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
557efi_status_t efi_tcg2_register(void);
Sunil V L1ccf8712022-01-28 20:48:44 +0530558/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
559efi_status_t efi_riscv_register(void);
Masahisa Kojima54bec172021-12-07 14:15:31 +0900560/* Called by efi_init_obj_list() to do initial measurement */
561efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900562/* measure the pe-coff image, extend PCR and add Event Log */
563efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
564 struct efi_loaded_image_obj *handle,
565 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100566/* Create handles and protocols for the partitions of a block device */
567int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
Simon Glass8149b152022-09-17 09:00:09 -0600568 const char *uclass_idname, int diskid,
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100569 const char *pdevname);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100570/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100571efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200572/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100573efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200574/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100575efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200576efi_status_t efi_initrd_register(void);
Ilias Apalodimas70089c12022-10-16 11:36:32 +0300577efi_status_t efi_initrd_deregister(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200578/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600579/**
Bin Meng86df34d2018-06-27 20:38:03 -0700580 * efi_acpi_register() - write out ACPI tables
581 *
582 * Called by bootefi to make ACPI tables available
583 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100584 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng86df34d2018-06-27 20:38:03 -0700585 */
586efi_status_t efi_acpi_register(void);
587/**
Simon Glass0864c562018-05-16 09:42:19 -0600588 * efi_smbios_register() - write out SMBIOS tables
589 *
590 * Called by bootefi to make SMBIOS tables available
591 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100592 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass0864c562018-05-16 09:42:19 -0600593 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100594efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200595
Rob Clark2a920802017-09-13 18:05:34 -0400596struct efi_simple_file_system_protocol *
597efi_fs_from_path(struct efi_device_path *fp);
598
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200599/* Called by efi_set_watchdog_timer to reset the timer */
600efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200601
Alexander Grafbee91162016-03-04 01:09:59 +0100602/* Called from places to check whether a timer expired */
603void efi_timer_check(void);
Heinrich Schuchardt5dad05a2021-01-12 12:40:32 +0100604/* Check if a buffer contains a PE-COFF image */
605efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafbee91162016-03-04 01:09:59 +0100606/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900607efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
608 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100609 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100610/* Called once to store the pristine gd pointer */
611void efi_save_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100612/* Call this to relocate the runtime section to an address space */
613void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silvabfef72e2022-05-11 10:55:40 +0100614/* Call this to get image parameters */
615void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100616/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200617void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200618/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100619efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100620/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200621void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100622/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100623struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod8465ff2022-04-28 17:09:38 +0900624/* Locate device_path handle */
625efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
626 struct efi_device_path **device_path,
627 efi_handle_t *device);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900628/* Load image */
629efi_status_t EFIAPI efi_load_image(bool boot_policy,
630 efi_handle_t parent_image,
631 struct efi_device_path *file_path,
632 void *source_buffer,
633 efi_uintn_t source_size,
634 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100635/* Start image */
636efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
637 efi_uintn_t *exit_data_size,
638 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900639/* Unload image */
640efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200641/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100642efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200643 const efi_guid_t *protocol_guid,
644 struct efi_handler **handler);
645/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100646efi_status_t efi_add_protocol(const efi_handle_t handle,
647 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200648 void *protocol_interface);
Heinrich Schuchardtf9ad2402020-01-10 12:33:59 +0100649/* Open protocol */
650efi_status_t efi_protocol_open(struct efi_handler *handler,
651 void **protocol_interface, void *agent_handle,
652 void *controller_handle, uint32_t attributes);
653
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200654/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100655efi_status_t efi_remove_protocol(const efi_handle_t handle,
656 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200657 void *protocol_interface);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200658/* Install multiple protocol interfaces */
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +0300659efi_status_t EFIAPI
660efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
661efi_status_t EFIAPI
662efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900663/* Get handles that support a given protocol */
664efi_status_t EFIAPI efi_locate_handle_buffer(
665 enum efi_locate_search_type search_type,
666 const efi_guid_t *protocol, void *search_key,
667 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardtef185762022-10-07 15:18:15 +0200668/* Close a previously opened protocol interface */
669efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
670 efi_handle_t agent_handle,
671 efi_handle_t controller_handle);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900672/* Open a protocol interface */
673efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
674 const efi_guid_t *protocol,
675 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200676/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100677efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200678 void (EFIAPI *notify_function) (
679 struct efi_event *event,
680 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100681 void *notify_context, efi_guid_t *group,
682 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200683/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200684efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200685 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200686/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200687void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100688
AKASHI Takahiro05f391e2022-05-12 11:29:01 +0900689/* return true if the device is removable */
690bool efi_disk_is_removable(efi_handle_t handle);
691
Rob Clark2a920802017-09-13 18:05:34 -0400692/* open file system: */
693struct efi_simple_file_system_protocol *efi_simple_file_system(
694 struct blk_desc *desc, int part, struct efi_device_path *dp);
695
696/* open file from device-path: */
697struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
698
Jose Marinho64a8aae2021-03-02 17:26:38 +0000699/* Registers a callback function for a notification event. */
700efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
701 struct efi_event *event,
702 void **registration);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200703efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
704
705/* get a device path from a Boot#### option */
706struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
707
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300708/* get len, string (used in u-boot crypto from a guid */
709const char *guid_to_sha_str(const efi_guid_t *guid);
710int algo_to_len(const char *algo);
711
Masahisa Kojimaee576662022-07-22 11:39:10 +0900712int efi_link_dev(efi_handle_t handle, struct udevice *dev);
Heinrich Schuchardt16b27b62022-10-03 09:47:51 +0200713int efi_unlink_dev(efi_handle_t handle);
Masahisa Kojima3ac026a2022-12-02 13:59:35 +0900714bool efi_varname_is_load_option(u16 *var_name16, int *index);
Masahisa Kojimace327082022-12-19 11:33:12 +0900715efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
716 efi_guid_t *guid);
Masahisa Kojimaee576662022-07-22 11:39:10 +0900717
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100718/**
719 * efi_size_in_pages() - convert size in bytes to size in pages
720 *
721 * This macro returns the number of EFI memory pages required to hold 'size'
722 * bytes.
723 *
724 * @size: size in bytes
725 * Return: size in pages
726 */
Heinrich Schuchardt0a7e5162021-01-17 07:52:09 +0100727#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Heinrich Schuchardtf606fab2023-03-19 09:20:22 +0100728/* Allocate boot service data pool memory */
729void *efi_alloc(size_t len);
Ilias Apalodimasebdea882021-10-11 15:10:23 +0300730/* Allocate pages on the specified alignment */
731void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf5d009952016-03-04 01:10:04 +0100732/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200733efi_status_t efi_allocate_pages(enum efi_allocate_type type,
734 enum efi_memory_type memory_type,
735 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200736/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100737efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200738/* EFI memory allocator for small allocations */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200739efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
740 efi_uintn_t size, void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200741/* EFI pool memory free function. */
742efi_status_t efi_free_pool(void *buffer);
Heinrich Schuchardteff44402023-01-05 18:26:01 +0100743/* Allocate and retrieve EFI memory map */
744efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
745 struct efi_mem_desc **memory_map);
Alexander Graf5d009952016-03-04 01:10:04 +0100746/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100747efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100748 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100749 efi_uintn_t *map_key,
750 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100751 uint32_t *descriptor_version);
752/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200753efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000754/* Adds a conventional range into the EFI memory map */
755efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
756 u64 ram_top);
757
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100758/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100759efi_status_t efi_driver_init(void);
Heinrich Schuchardtf05911a2022-10-06 07:29:41 +0200760/* Called when a block device is added */
761int efi_disk_probe(void *ctx, struct event *event);
762/* Called when a block device is removed */
763int efi_disk_remove(void *ctx, struct event *event);
Alexander Graf5d009952016-03-04 01:10:04 +0100764/* Called by board init to initialize the EFI memory map */
765int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200766/* Adds new or overrides configuration table entry to the system table */
767efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100768/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200769efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
770 struct efi_device_path *file_path,
771 struct efi_loaded_image_obj **handle_ptr,
772 struct efi_loaded_image **info_ptr);
Alexander Graf5d009952016-03-04 01:10:04 +0100773
Alexander Graf51735ae2016-05-11 18:25:48 +0200774#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
775extern void *efi_bounce_buffer;
776#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
777#endif
778
Heinrich Schuchardt83994882022-02-26 12:10:10 +0100779/* shorten device path */
780struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400781struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200782int efi_dp_match(const struct efi_device_path *a,
783 const struct efi_device_path *b);
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100784efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardte46ef1d2022-03-19 06:35:43 +0100785 const efi_guid_t *guid,
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100786 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200787/* get size of the first device path instance excluding end node */
788efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
789/* size of multi-instance device path excluding end node */
790efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400791struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
792struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
793 const struct efi_device_path *dp2);
794struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
795 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200796/* Create a device path node of given type, sub-type, length */
797struct efi_device_path *efi_dp_create_device_node(const u8 type,
798 const u8 sub_type,
799 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200800/* Append device path instance */
801struct efi_device_path *efi_dp_append_instance(
802 const struct efi_device_path *dp,
803 const struct efi_device_path *dpi);
804/* Get next device path instance */
805struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
806 efi_uintn_t *size);
807/* Check if a device path contains muliple instances */
808bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400809
Rob Clarkb66c60d2017-09-13 18:05:28 -0400810struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100811/* Create a device node for a block device partition. */
812struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Heinrich Schuchardtc7c0ca32023-05-13 10:36:21 +0200813struct efi_device_path *efi_dp_from_file(const struct efi_device_path *dp,
Rob Clarkb66c60d2017-09-13 18:05:28 -0400814 const char *path);
815struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400816struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
817 uint64_t start_address,
818 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100819/* Determine the last device path node that is not the end node. */
820const struct efi_device_path *efi_dp_last_node(
821 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100822efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
823 struct efi_device_path **device_path,
824 struct efi_device_path **file_path);
Heinrich Schuchardt3c95b322022-02-04 20:47:09 +0100825struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900826efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
827 const char *path,
828 struct efi_device_path **device,
829 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200830ssize_t efi_dp_check_length(const struct efi_device_path *dp,
831 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400832
833#define EFI_DP_TYPE(_dp, _type, _subtype) \
834 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
835 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
836
Masahisa Kojima98973502022-06-19 13:55:59 +0900837/* template END node: */
838extern const struct efi_device_path END;
839
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900840/* Indicate supported runtime services */
841efi_status_t efi_init_runtime_supported(void);
842
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200843/* Update CRC32 in table header */
844void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
845
Alexander Graf80a48002016-08-16 21:08:45 +0200846/* Boards may provide the functions below to implement RTS functionality */
847
Alexander Graf3c63db92016-10-14 13:45:30 +0200848void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200849 enum efi_reset_type reset_type,
850 efi_status_t reset_status,
851 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100852
853/* Architecture specific initialization of the EFI subsystem */
854efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200855
Alexander Graf3c63db92016-10-14 13:45:30 +0200856efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200857 struct efi_time *time,
858 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200859
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200860efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
861
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200862#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
863/*
864 * Entry point for the tests of the EFI API.
865 * It is called by 'bootefi selftest'
866 */
867efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
868 struct efi_system_table *systab);
869#endif
870
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100871efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
872 const efi_guid_t *vendor, u32 *attributes,
873 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200874efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
875 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100876 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100877efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
878 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100879 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400880
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200881efi_status_t EFIAPI efi_query_variable_info(
882 u32 attributes, u64 *maximum_variable_storage_size,
883 u64 *remaining_variable_storage_size,
884 u64 *maximum_variable_size);
885
Heinrich Schuchardtd47671c2021-09-09 07:12:14 +0200886void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200887
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900888/*
889 * See section 3.1.3 in the v2.7 UEFI spec for more details on
890 * the layout of EFI_LOAD_OPTION. In short it is:
891 *
892 * typedef struct _EFI_LOAD_OPTION {
893 * UINT32 Attributes;
894 * UINT16 FilePathListLength;
895 * // CHAR16 Description[]; <-- variable length, NULL terminated
896 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
897 * <-- FilePathListLength bytes
898 * // UINT8 OptionalData[];
899 * } EFI_LOAD_OPTION;
900 */
901struct efi_load_option {
902 u32 attributes;
903 u16 file_path_length;
904 u16 *label;
905 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200906 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900907};
908
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200909struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt04217352021-10-15 01:31:02 +0200910 const efi_guid_t *guid);
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200911struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
912 const struct efi_device_path *dp2);
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900913struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200914efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
915 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900916unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200917efi_status_t efi_set_load_options(efi_handle_t handle,
918 efi_uintn_t load_options_size,
919 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200920efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400921
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900922/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100923 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900924 *
925 * @max: Maximum number of regions
926 * @num: Number of regions
927 * @reg: array of regions
928 */
929struct efi_image_regions {
930 int max;
931 int num;
932 struct image_region reg[];
933};
934
935/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100936 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900937 *
938 * This structure represents an internal form of signature in
939 * signature database. A listed list may represent a signature list.
940 *
941 * @next: Pointer to next entry
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100942 * @owner: Signature owner
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900943 * @data: Pointer to signature data
944 * @size: Size of signature data
945 */
946struct efi_sig_data {
947 struct efi_sig_data *next;
948 efi_guid_t owner;
949 void *data;
950 size_t size;
951};
952
953/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100954 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900955 *
956 * This structure represents an internal form of signature database.
957 *
958 * @next: Pointer to next entry
959 * @sig_type: Signature type
960 * @sig_data_list: Pointer to signature list
961 */
962struct efi_signature_store {
963 struct efi_signature_store *next;
964 efi_guid_t sig_type;
965 struct efi_sig_data *sig_data_list;
966};
967
968struct x509_certificate;
969struct pkcs7_message;
970
Masahisa Kojimac416f1c2022-09-12 17:33:54 +0900971/**
972 * struct eficonfig_media_boot_option - boot option for (removable) media device
973 *
974 * This structure is used to enumerate possible boot option
975 *
976 * @lo: Serialized load option data
977 * @size: Size of serialized load option data
978 * @exist: Flag to indicate the load option already exists
979 * in Non-volatile load option
980 */
981struct eficonfig_media_boot_option {
982 void *lo;
983 efi_uintn_t size;
984 bool exist;
985};
986
AKASHI Takahirob3301402022-07-05 14:48:12 +0900987bool efi_hash_regions(struct image_region *regs, int count,
988 void **hash, const char *hash_algo, int *len);
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900989bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas4b634312022-01-29 00:20:31 +0200990 struct efi_signature_store *db,
991 bool dbx);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +0900992bool efi_signature_verify(struct efi_image_regions *regs,
993 struct pkcs7_message *msg,
994 struct efi_signature_store *db,
995 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +0900996static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
997 struct pkcs7_message *msg,
998 struct efi_signature_store *db)
999{
1000 return efi_signature_verify(regs, msg, db, NULL);
1001}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +09001002bool efi_signature_check_signers(struct pkcs7_message *msg,
1003 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001004
1005efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1006 const void *start, const void *end,
1007 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +09001008
1009void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganub4f20a52020-12-30 19:27:08 +05301010struct efi_signature_store *efi_build_signature_store(void *sig_list,
1011 efi_uintn_t size);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +09001012struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +09001013
1014bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09001015
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301016bool efi_capsule_auth_enabled(void);
1017
Masahisa Kojima163a0d72021-05-26 12:09:58 +09001018void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1019
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09001020bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1021 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001022
Sughosh Ganu201b8062020-12-30 19:27:07 +05301023struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1024 size_t buflen,
1025 u8 **tmpbuf);
1026
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +02001027/* runtime implementation of memcpy() */
1028void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1029
Paul Barker39434a92022-10-05 13:18:35 +01001030/* commonly used helper functions */
Ilias Apalodimasfe179d72020-12-31 12:26:46 +02001031u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1032 unsigned int index);
Paul Barker39434a92022-10-05 13:18:35 +01001033efi_string_t efi_convert_string(const char *str);
AKASHI Takahiro077153e2020-10-29 13:47:46 +09001034
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001035extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +09001036extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001037
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +09001038/* Capsule update */
1039efi_status_t EFIAPI efi_update_capsule(
1040 struct efi_capsule_header **capsule_header_array,
1041 efi_uintn_t capsule_count,
1042 u64 scatter_gather_list);
1043efi_status_t EFIAPI efi_query_capsule_caps(
1044 struct efi_capsule_header **capsule_header_array,
1045 efi_uintn_t capsule_count,
1046 u64 *maximum_capsule_size,
1047 u32 *reset_type);
1048
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301049efi_status_t efi_capsule_authenticate(const void *capsule,
1050 efi_uintn_t capsule_size,
1051 void **image, efi_uintn_t *image_size);
1052
Simon Glass156ccbc2022-01-23 12:55:12 -07001053#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +09001054
Jose Marinho64a8aae2021-03-02 17:26:38 +00001055/**
Sughosh Ganu741ef862022-04-15 11:29:34 +05301056 * struct efi_fw_image - Information on firmware images updatable through
1057 * capsule update
1058 *
1059 * This structure gives information about the firmware images on the platform
1060 * which can be updated through the capsule update mechanism
1061 *
1062 * @image_type_id: Image GUID. Same value is to be used in the capsule
1063 * @fw_name: Name of the firmware image
1064 * @image_index: Image Index, same as value passed to SetImage FMP
1065 * function
1066 */
1067struct efi_fw_image {
1068 efi_guid_t image_type_id;
1069 u16 *fw_name;
1070 u8 image_index;
1071};
1072
1073/**
1074 * struct efi_capsule_update_info - Information needed for capsule updates
1075 *
1076 * This structure provides information needed for performing firmware
1077 * updates. The structure needs to be initialised per platform, for all
1078 * platforms which enable capsule updates
1079 *
1080 * @dfu_string: String used to populate dfu_alt_info
Masahisa Kojimacccea182023-06-07 14:41:51 +09001081 * @num_images: The number of images array entries
Sughosh Ganu741ef862022-04-15 11:29:34 +05301082 * @images: Pointer to an array of updatable images
1083 */
1084struct efi_capsule_update_info {
1085 const char *dfu_string;
Masahisa Kojimacccea182023-06-07 14:41:51 +09001086 int num_images;
Sughosh Ganu741ef862022-04-15 11:29:34 +05301087 struct efi_fw_image *images;
1088};
1089
1090extern struct efi_capsule_update_info update_info;
Sughosh Ganu741ef862022-04-15 11:29:34 +05301091
1092/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001093 * Install the ESRT system table.
1094 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001095 * Return: status code
Jose Marinho64a8aae2021-03-02 17:26:38 +00001096 */
1097efi_status_t efi_esrt_register(void);
1098
1099/**
Jose Marinho6b92c172021-12-23 14:51:07 +00001100 * efi_ecpt_register() - Install the ECPT system table.
1101 *
1102 * Return: status code
1103 */
1104efi_status_t efi_ecpt_register(void);
1105
1106/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001107 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1108 * present in the system.
1109 * If an ESRT already exists, the old ESRT is replaced in the system table.
1110 * The memory of the old ESRT is deallocated.
1111 *
1112 * Return:
1113 * - EFI_SUCCESS if the ESRT is correctly created
1114 * - error code otherwise.
1115 */
1116efi_status_t efi_esrt_populate(void);
Ilias Apalodimas6e0184b2021-06-22 17:38:53 +03001117efi_status_t efi_load_capsule_drivers(void);
Ruchika Gupta34287ef2021-11-29 13:09:44 +05301118
1119efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojima87d79142022-09-12 17:33:50 +09001120
1121efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1122 const efi_guid_t *protocol, void *search_key,
1123 efi_uintn_t *no_handles, efi_handle_t **buffer);
1124
1125efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1126 struct efi_file_handle **root);
1127efi_status_t efi_file_open_int(struct efi_file_handle *this,
1128 struct efi_file_handle **new_handle,
1129 u16 *file_name, u64 open_mode,
1130 u64 attributes);
1131efi_status_t efi_file_close_int(struct efi_file_handle *file);
1132efi_status_t efi_file_read_int(struct efi_file_handle *this,
1133 efi_uintn_t *buffer_size, void *buffer);
1134efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1135
1136typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1137efi_status_t efi_console_get_u16_string
1138 (struct efi_simple_text_input_protocol *cin,
1139 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1140 int row, int col);
1141
1142efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1143
Heinrich Schuchardta9f20ef2023-02-10 09:01:13 +01001144/**
1145 * efi_add_known_memory() - add memory banks to EFI memory map
1146 *
1147 * This weak function may be overridden for specific architectures.
1148 */
1149void efi_add_known_memory(void);
1150
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02001151#endif /* _EFI_LOADER_H */