blob: b5fa0fe01dedfdcdcd9ff7c947ead83c552ad4d6 [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>
Heinrich Schuchardtda620cf2022-10-06 07:29:41 +020013#include <event.h>
Simon Glass0f2af882020-05-10 11:40:05 -060014#include <log.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010015#include <part_efi.h>
16#include <efi_api.h>
AKASHI Takahiro2c0f9f72020-04-21 09:38:38 +090017#include <image.h>
AKASHI Takahiro0e104e32020-04-14 11:51:44 +090018#include <pe.h>
Simon Glass97f9bd42021-07-02 12:36:16 -060019#include <linux/list.h>
20#include <linux/oid_registry.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010021
Simon Glass655306c2020-05-10 11:39:58 -060022struct blk_desc;
AKASHI Takahiro4cbba2b2021-07-20 14:57:02 +090023struct jmp_buf_data;
Simon Glass655306c2020-05-10 11:39:58 -060024
Simon Glass16fc74a2019-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 Ganu196f66d2019-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 Warrend0de8062018-08-30 15:43:43 -060035#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010036
Simon Glass97f9bd42021-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 Graf4e0c1c12016-03-04 01:09:58 +0100129
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +0200130/* Maximum number of configuration tables */
131#define EFI_MAX_CONFIGURATION_TABLES 16
132
Heinrich Schuchardt79d72022018-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 Waldekranz32152682023-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 Takahiro659a6262019-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 Schuchardtc770aaa2020-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 Schuchardt79d72022018-09-20 21:58:23 +0200149
Masahisa Kojimac5ff0a02022-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 Schuchardt6fbb8ac2019-11-28 06:46:09 +0100155/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100156#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100157
AKASHI Takahiro0b275752019-04-16 13:24:20 +0900158/* Root node */
159extern efi_handle_t efi_root;
160
Heinrich Schuchardtde9bdc62020-03-19 18:21:58 +0000161/* Set to EFI_SUCCESS when initialized */
162extern efi_status_t efi_obj_list_initialized;
163
Heinrich Schuchardt628dbd72020-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 Schuchardta9931732020-03-19 15:16:31 +0100167/* EFI system partition */
168extern struct efi_system_partition {
Simon Glassfada3f92022-09-17 09:00:09 -0600169 enum uclass_id uclass_id;
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100170 int devnum;
171 u8 part;
172} efi_system_partition;
173
Rob Clark86789d52017-07-27 08:04:18 -0400174int __efi_entry_check(void);
175int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200176const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -0400177const char *__efi_nesting_inc(void);
178const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -0400179
Rob Clark63ea77a2017-07-27 08:04:17 -0400180/*
181 * Enter the u-boot world from UEFI:
182 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100183#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -0400184 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400185 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
186 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +0100187 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +0100188
Rob Clark63ea77a2017-07-27 08:04:17 -0400189/*
190 * Exit the u-boot world back to UEFI:
191 */
Rob Clark84a19a02017-07-24 10:31:52 -0400192#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200193 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -0400194 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200195 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -0400196 assert(__efi_exit_check()); \
197 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -0400198 })
Alexander Grafc15d9212016-03-04 01:09:59 +0100199
Rob Clark63ea77a2017-07-27 08:04:17 -0400200/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200201 * Call non-void UEFI function from u-boot and retrieve return value:
202 */
203#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:
Rob Clark63ea77a2017-07-27 08:04:17 -0400215 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200216#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400217 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400218 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400219 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400220 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400221 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400222 } while(0)
223
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200224/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100225 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200226 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100227#define EFI_PRINT(format, ...) ({ \
228 debug("%sEFI: " format, __efi_nesting(), \
229 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200230 })
231
Alexander Graf59254d62018-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 Kojimac5ff0a02022-09-12 17:33:50 +0900239/* max bootmenu title size for volume selection */
240#define BOOTMENU_DEVICE_NAME_MAX 16
241
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200242/* Key identifying current memory map */
243extern efi_uintn_t efi_memory_map_key;
244
Alexander Graf0bd425a2016-03-04 01:10:01 +0100245extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100246extern struct efi_system_table systab;
247
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200248extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200249extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200250extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200251extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-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 Schuchardt18ed8cf2019-05-16 18:19:00 +0200255/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200256extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200257 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-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 Lindholm5aab1b82019-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 Graf4aacacc2016-03-04 01:10:00 +0100262
Rob Clark85dd7212017-09-13 18:05:30 -0400263uint16_t *efi_dp_str(struct efi_device_path *dp);
264
Masahisa Kojimac5ff0a02022-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 Schuchardt79d72022018-09-20 21:58:23 +0200268/* GUID of the U-Boot root node */
269extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-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 Schuchardt405afb52018-01-19 20:24:45 +0100274/* GUID of the EFI_BLOCK_IO_PROTOCOL */
275extern const efi_guid_t efi_block_io_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400276extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100277extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100278extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardte840b9c2022-03-19 07:04:03 +0100279/* GUID of the EFI system partition */
280extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100281/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
282extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-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 Schuchardt44ab21b2018-03-03 15:29:03 +0100293/* GUID of the device tree table */
294extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100295extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900296extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200297extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-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 Schuchardt37fb4b92018-04-04 15:42:11 +0200300/* GUID for file system information */
301extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100302extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200303/* GUID of the deprecated Unicode collation protocol */
304extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt485956d2020-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 Schuchardte59072a2018-09-04 19:34:58 +0200308/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200309extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-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 Lindholm5aab1b82019-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 Takahiro1faaca42020-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 Apalodimas34db9b12022-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 Takahirob0f49ee2020-04-14 11:51:41 +0900321extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100322
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530323/* GUID of RNG protocol */
324extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900325/* GUID of capsule update result */
326extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro0d963782020-11-30 18:12:11 +0900327/* GUID of firmware management protocol */
328extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000329/* GUID for the ESRT */
330extern const efi_guid_t efi_esrt_guid;
Masahisa Kojimacd1fe7d2021-10-26 17:27:24 +0900331/* GUID of the SMBIOS table */
332extern const efi_guid_t smbios_guid;
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900333/*GUID of console */
334extern const efi_guid_t efi_guid_text_input_protocol;
Masahisa Kojimaa93282c2023-01-24 15:56:15 +0900335extern const efi_guid_t efi_guid_text_output_protocol;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530336
Marek Behún69504502021-05-20 13:23:56 +0200337extern char __efi_runtime_start[], __efi_runtime_stop[];
338extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf0bd425a2016-03-04 01:10:01 +0100339
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200340/**
341 * struct efi_open_protocol_info_item - open protocol info item
342 *
Heinrich Schuchardta277d3a2018-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 Schuchardt2e4b41f2019-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 Schuchardta277d3a2018-01-11 08:15:57 +0100348 */
349struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100350 struct list_head link;
351 struct efi_open_protocol_info_entry info;
352};
353
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200354/**
355 * struct efi_handler - single protocol interface of a handle
356 *
Alexander Grafc15d9212016-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 Schuchardta277d3a2018-01-11 08:15:57 +0100359 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-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 Schuchardt6eb30c12021-02-25 08:02:37 +0100364 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100365 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100366struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100367 struct list_head link;
Heinrich Schuchardt2a22db92022-03-09 19:56:23 +0100368 const efi_guid_t guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200369 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100370 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100371};
372
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200373/**
Heinrich Schuchardtb27ced42019-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 Schuchardt6eb30c12021-02-25 08:02:37 +0100380 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200381 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100382 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200383 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100384 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200385 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100386 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200387 EFI_OBJECT_TYPE_STARTED_IMAGE,
388};
389
390/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200391 * struct efi_object - dereferenced EFI handle
392 *
393 * @link: pointers to put the handle into a linked list
394 * @protocols: linked list with the protocol interfaces installed on this
395 * handle
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100396 * @type: image type if the handle relates to an image
Masahisa Kojimac9611082022-07-22 11:39:10 +0900397 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtadb50d02018-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.
Alexander Grafc15d9212016-03-04 01:09:59 +0100405 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200406 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
407 * has been created for such pointers.
Alexander Grafc15d9212016-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 Schuchardt99ce2062017-11-26 14:05:17 +0100412 /* The list of protocols */
413 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200414 enum efi_object_type type;
Masahisa Kojimac9611082022-07-22 11:39:10 +0900415 struct udevice *dev;
Alexander Grafc15d9212016-03-04 01:09:59 +0100416};
417
AKASHI Takahiro0e104e32020-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.de30708232017-07-18 20:17:18 +0200423/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200424 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200425 *
426 * @header: EFI object header
Heinrich Schuchardt3d445122019-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 Schuchardt93b40d62020-12-28 22:42:51 +0100430 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200431 * @entry: entry address of the relocated image
Heinrich Schuchardt93b40d62020-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 Schuchardt3c3a7352018-09-23 17:21:51 +0200434 */
435struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200436 struct efi_object header;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100437 efi_status_t *exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200438 efi_uintn_t *exit_data_size;
439 u16 **exit_data;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100440 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200441 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
442 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200443 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900444 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200445};
446
447/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200448 * struct efi_event
449 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100450 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200451 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200452 * @type: Type of event, see efi_create_event
453 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100454 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200455 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100456 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100457 * @trigger_time: Period of the timer
458 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200459 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100460 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200461 */
462struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100463 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200464 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200465 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100466 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200467 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
468 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100469 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200470 u64 trigger_next;
471 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200472 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200473 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200474};
475
Alexander Grafc15d9212016-03-04 01:09:59 +0100476/* This list contains all UEFI objects we know of */
477extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100478/* List of all events */
479extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100480
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200481/**
Heinrich Schuchardtd375e752019-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 Schuchardt6eb30c12021-02-25 08:02:37 +0100497 * struct efi_register_notify_event - event registered by
498 * RegisterProtocolNotify()
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200499 *
500 * The address of this structure serves as registration value.
501 *
Heinrich Schuchardtd375e752019-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 Schuchardt6eec42d2019-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 Schuchardtd375e752019-05-21 18:19:01 +0200513 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200514};
515
AKASHI Takahiroa36dc252022-04-19 10:05:11 +0900516/* called at pre-initialization */
517int efi_init_early(void);
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100518/* Initialize efi execution environment */
519efi_status_t efi_init_obj_list(void);
Raymond Mao70a76c52023-06-19 14:22:58 -0700520/* Append new boot option in BootOrder variable */
521efi_status_t efi_bootmgr_append_bootorder(u16 index);
522/* Get unused "Boot####" index */
523efi_status_t efi_bootmgr_get_unused_bootoption(u16 *buf,
524 efi_uintn_t buf_size, u32 *index);
525/* Generate the media device boot option */
526efi_status_t efi_bootmgr_update_media_device_boot_option(void);
527/* Delete selected boot option */
528efi_status_t efi_bootmgr_delete_boot_option(u16 boot_index);
529/* search the boot option index in BootOrder */
530bool efi_search_bootorder(u16 *bootorder, efi_uintn_t num, u32 target, u32 *index);
Heinrich Schuchardt761908e2022-06-14 08:02:03 +0200531/* Set up console modes */
532void efi_setup_console_size(void);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100533/* Install device tree */
534efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtffb90592019-12-07 20:51:06 +0100535/* Run loaded UEFI image */
536efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardtcf3b1182019-06-20 13:52:16 +0200537/* Initialize variable services */
538efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200539/* Notify ExitBootServices() is called */
540void efi_variables_boot_exit_notify(void);
Masahisa Kojima1ac19bb2021-08-13 16:12:41 +0900541efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900542/* Measure efi application invocation */
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900543efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900544/* Measure efi application exit */
545efi_status_t efi_tcg2_measure_efi_app_exit(void);
Etienne Carriereb9064352023-02-16 17:29:48 +0100546/* Measure DTB */
547efi_status_t efi_tcg2_measure_dtb(void *dtb);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200548/* Called by bootefi to initialize root node */
549efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200550/* Called by bootefi to initialize runtime */
551efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200552/* efi_runtime_detach() - detach unimplemented runtime functions */
553void efi_runtime_detach(void);
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100554/* efi_convert_pointer() - convert pointer to virtual address */
555efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
556 void **address);
Heinrich Schuchardt2c1e2242020-12-13 10:30:24 +0100557/* Carve out DT reserved memory ranges */
558void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimase4e56602022-01-03 14:07:37 +0200559/* Purge unused kaslr-seed */
560void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200561/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200562efi_status_t efi_console_register(void);
Heinrich Schuchardta02228f2022-08-31 16:37:35 +0200563/* Called by efi_init_obj_list() to proble all block devices */
564efi_status_t efi_disks_register(void);
Heinrich Schuchardtc63f68f2020-09-25 12:50:19 +0200565/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
566efi_status_t efi_rng_register(void);
Ilias Apalodimas590fef62020-11-11 11:18:11 +0200567/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
568efi_status_t efi_tcg2_register(void);
Sunil V L279d1c82022-01-28 20:48:44 +0530569/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
570efi_status_t efi_riscv_register(void);
Masahisa Kojima0fd43792021-12-07 14:15:31 +0900571/* Called by efi_init_obj_list() to do initial measurement */
572efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900573/* measure the pe-coff image, extend PCR and add Event Log */
574efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
575 struct efi_loaded_image_obj *handle,
576 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100577/* Create handles and protocols for the partitions of a block device */
578int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
Simon Glassfada3f92022-09-17 09:00:09 -0600579 const char *uclass_idname, int diskid,
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100580 const char *pdevname);
Alexander Grafd65783d2016-03-15 18:38:21 +0100581/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100582efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200583/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100584efi_status_t efi_net_register(void);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200585/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100586efi_status_t efi_watchdog_register(void);
Ilias Apalodimas3510ba72020-02-21 09:55:45 +0200587efi_status_t efi_initrd_register(void);
Ilias Apalodimas7e052792022-10-16 11:36:32 +0300588efi_status_t efi_initrd_deregister(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200589/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600590/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700591 * efi_acpi_register() - write out ACPI tables
592 *
593 * Called by bootefi to make ACPI tables available
594 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100595 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng2cfbdae2018-06-27 20:38:03 -0700596 */
597efi_status_t efi_acpi_register(void);
598/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600599 * efi_smbios_register() - write out SMBIOS tables
600 *
601 * Called by bootefi to make SMBIOS tables available
602 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100603 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass2e2858f2018-05-16 09:42:19 -0600604 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100605efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200606
Rob Clark53142032017-09-13 18:05:34 -0400607struct efi_simple_file_system_protocol *
608efi_fs_from_path(struct efi_device_path *fp);
609
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200610/* Called by efi_set_watchdog_timer to reset the timer */
611efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200612
Alexander Grafc15d9212016-03-04 01:09:59 +0100613/* Called from places to check whether a timer expired */
614void efi_timer_check(void);
Heinrich Schuchardtad6e0f72021-01-12 12:40:32 +0100615/* Check if a buffer contains a PE-COFF image */
616efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafc15d9212016-03-04 01:09:59 +0100617/* PE loader implementation */
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900618efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
619 void *efi, size_t efi_size,
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100620 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100621/* Called once to store the pristine gd pointer */
622void efi_save_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100623/* Call this to relocate the runtime section to an address space */
624void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silva433f15a2022-05-11 10:55:40 +0100625/* Call this to get image parameters */
626void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100627/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200628void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200629/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100630efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100631/* Delete handle */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200632void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100633/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100634struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahiro537a6932022-04-28 17:09:38 +0900635/* Locate device_path handle */
636efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
637 struct efi_device_path **device_path,
638 efi_handle_t *device);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900639/* Load image */
640efi_status_t EFIAPI efi_load_image(bool boot_policy,
641 efi_handle_t parent_image,
642 struct efi_device_path *file_path,
643 void *source_buffer,
644 efi_uintn_t source_size,
645 efi_handle_t *image_handle);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100646/* Start image */
647efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
648 efi_uintn_t *exit_data_size,
649 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900650/* Unload image */
651efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200652/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100653efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200654 const efi_guid_t *protocol_guid,
655 struct efi_handler **handler);
656/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100657efi_status_t efi_add_protocol(const efi_handle_t handle,
658 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200659 void *protocol_interface);
Heinrich Schuchardt9c89d142020-01-10 12:33:59 +0100660/* Open protocol */
661efi_status_t efi_protocol_open(struct efi_handler *handler,
662 void **protocol_interface, void *agent_handle,
663 void *controller_handle, uint32_t attributes);
664
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200665/* Install multiple protocol interfaces */
Ilias Apalodimas8ac0ebe2022-10-06 16:08:46 +0300666efi_status_t EFIAPI
667efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
668efi_status_t EFIAPI
669efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900670/* Get handles that support a given protocol */
671efi_status_t EFIAPI efi_locate_handle_buffer(
672 enum efi_locate_search_type search_type,
673 const efi_guid_t *protocol, void *search_key,
674 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardt5e394332022-10-07 15:18:15 +0200675/* Close a previously opened protocol interface */
676efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
677 efi_handle_t agent_handle,
678 efi_handle_t controller_handle);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900679/* Open a protocol interface */
680efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
681 const efi_guid_t *protocol,
682 void **protocol_interface);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200683/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100684efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200685 void (EFIAPI *notify_function) (
686 struct efi_event *event,
687 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100688 void *notify_context, efi_guid_t *group,
689 struct efi_event **event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200690/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200691efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200692 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200693/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200694void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100695
AKASHI Takahiroba647af2022-05-12 11:29:01 +0900696/* return true if the device is removable */
697bool efi_disk_is_removable(efi_handle_t handle);
698
Rob Clark53142032017-09-13 18:05:34 -0400699/* open file system: */
700struct efi_simple_file_system_protocol *efi_simple_file_system(
701 struct blk_desc *desc, int part, struct efi_device_path *dp);
702
703/* open file from device-path: */
704struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
705
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000706/* Registers a callback function for a notification event. */
707efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
708 struct efi_event *event,
709 void **registration);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200710efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
711
712/* get a device path from a Boot#### option */
713struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
714
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300715/* get len, string (used in u-boot crypto from a guid */
716const char *guid_to_sha_str(const efi_guid_t *guid);
717int algo_to_len(const char *algo);
718
Masahisa Kojimac9611082022-07-22 11:39:10 +0900719int efi_link_dev(efi_handle_t handle, struct udevice *dev);
Heinrich Schuchardt34f34622022-10-03 09:47:51 +0200720int efi_unlink_dev(efi_handle_t handle);
Masahisa Kojima2f407f02022-12-02 13:59:35 +0900721bool efi_varname_is_load_option(u16 *var_name16, int *index);
Masahisa Kojima7ec3c6f2022-12-19 11:33:12 +0900722efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
723 efi_guid_t *guid);
Masahisa Kojimac9611082022-07-22 11:39:10 +0900724
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100725/**
726 * efi_size_in_pages() - convert size in bytes to size in pages
727 *
728 * This macro returns the number of EFI memory pages required to hold 'size'
729 * bytes.
730 *
731 * @size: size in bytes
732 * Return: size in pages
733 */
Heinrich Schuchardtaefb0c42021-01-17 07:52:09 +0100734#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Heinrich Schuchardt45640252023-03-19 09:20:22 +0100735/* Allocate boot service data pool memory */
736void *efi_alloc(size_t len);
Ilias Apalodimas6e01c232021-10-11 15:10:23 +0300737/* Allocate pages on the specified alignment */
738void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf8623f922016-03-04 01:10:04 +0100739/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200740efi_status_t efi_allocate_pages(enum efi_allocate_type type,
741 enum efi_memory_type memory_type,
742 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200743/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100744efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200745/* EFI memory allocator for small allocations */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200746efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
747 efi_uintn_t size, void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200748/* EFI pool memory free function. */
749efi_status_t efi_free_pool(void *buffer);
Heinrich Schuchardt13ce2d92023-01-05 18:26:01 +0100750/* Allocate and retrieve EFI memory map */
751efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
752 struct efi_mem_desc **memory_map);
Alexander Graf8623f922016-03-04 01:10:04 +0100753/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100754efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100755 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100756 efi_uintn_t *map_key,
757 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100758 uint32_t *descriptor_version);
759/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200760efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidene009e7a2019-09-03 17:43:43 +0000761/* Adds a conventional range into the EFI memory map */
762efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
763 u64 ram_top);
764
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100765/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100766efi_status_t efi_driver_init(void);
Heinrich Schuchardtda620cf2022-10-06 07:29:41 +0200767/* Called when a block device is added */
768int efi_disk_probe(void *ctx, struct event *event);
769/* Called when a block device is removed */
770int efi_disk_remove(void *ctx, struct event *event);
Alexander Graf8623f922016-03-04 01:10:04 +0100771/* Called by board init to initialize the EFI memory map */
772int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200773/* Adds new or overrides configuration table entry to the system table */
774efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100775/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200776efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
777 struct efi_device_path *file_path,
778 struct efi_loaded_image_obj **handle_ptr,
779 struct efi_loaded_image **info_ptr);
Alexander Graf8623f922016-03-04 01:10:04 +0100780
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200781#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
782extern void *efi_bounce_buffer;
783#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
784#endif
785
Heinrich Schuchardt24f0e6a2022-02-26 12:10:10 +0100786/* shorten device path */
787struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400788struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200789int efi_dp_match(const struct efi_device_path *a,
790 const struct efi_device_path *b);
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100791efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardt0a04a412022-03-19 06:35:43 +0100792 const efi_guid_t *guid,
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100793 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200794/* get size of the first device path instance excluding end node */
795efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
796/* size of multi-instance device path excluding end node */
797efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400798struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
799struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
800 const struct efi_device_path *dp2);
801struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
802 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200803/* Create a device path node of given type, sub-type, length */
804struct efi_device_path *efi_dp_create_device_node(const u8 type,
805 const u8 sub_type,
806 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200807/* Append device path instance */
808struct efi_device_path *efi_dp_append_instance(
809 const struct efi_device_path *dp,
810 const struct efi_device_path *dpi);
811/* Get next device path instance */
812struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
813 efi_uintn_t *size);
814/* Check if a device path contains muliple instances */
815bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400816
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400817struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100818/* Create a device node for a block device partition. */
819struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Heinrich Schuchardtff08eac2023-05-13 10:36:21 +0200820struct efi_device_path *efi_dp_from_file(const struct efi_device_path *dp,
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400821 const char *path);
822struct efi_device_path *efi_dp_from_eth(void);
Rob Clark18ceba72017-10-10 08:23:06 -0400823struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
824 uint64_t start_address,
825 uint64_t end_address);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100826/* Determine the last device path node that is not the end node. */
827const struct efi_device_path *efi_dp_last_node(
828 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100829efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
830 struct efi_device_path **device_path,
831 struct efi_device_path **file_path);
Heinrich Schuchardt81244ea2022-02-04 20:47:09 +0100832struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900833efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
834 const char *path,
835 struct efi_device_path **device,
836 struct efi_device_path **file);
Heinrich Schuchardt22c8e082020-08-23 10:49:46 +0200837ssize_t efi_dp_check_length(const struct efi_device_path *dp,
838 const size_t maxlen);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400839
840#define EFI_DP_TYPE(_dp, _type, _subtype) \
841 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
842 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
843
Masahisa Kojima97bd9da2022-06-19 13:55:59 +0900844/* template END node: */
845extern const struct efi_device_path END;
846
AKASHI Takahiro32401842019-06-05 13:21:38 +0900847/* Indicate supported runtime services */
848efi_status_t efi_init_runtime_supported(void);
849
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200850/* Update CRC32 in table header */
851void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
852
Alexander Graf77256092016-08-16 21:08:45 +0200853/* Boards may provide the functions below to implement RTS functionality */
854
Alexander Graf393dd912016-10-14 13:45:30 +0200855void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200856 enum efi_reset_type reset_type,
857 efi_status_t reset_status,
858 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100859
860/* Architecture specific initialization of the EFI subsystem */
861efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200862
Alexander Graf393dd912016-10-14 13:45:30 +0200863efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200864 struct efi_time *time,
865 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200866
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200867efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
868
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200869#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
870/*
871 * Entry point for the tests of the EFI API.
872 * It is called by 'bootefi selftest'
873 */
874efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
875 struct efi_system_table *systab);
876#endif
877
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100878efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
879 const efi_guid_t *vendor, u32 *attributes,
880 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200881efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
882 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100883 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100884efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
885 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100886 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400887
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200888efi_status_t EFIAPI efi_query_variable_info(
889 u32 attributes, u64 *maximum_variable_storage_size,
890 u64 *remaining_variable_storage_size,
891 u64 *maximum_variable_size);
892
Heinrich Schuchardt1ad2f0d2021-09-09 07:12:14 +0200893void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200894
AKASHI Takahirobd237742018-11-05 18:06:41 +0900895/*
896 * See section 3.1.3 in the v2.7 UEFI spec for more details on
897 * the layout of EFI_LOAD_OPTION. In short it is:
898 *
899 * typedef struct _EFI_LOAD_OPTION {
900 * UINT32 Attributes;
901 * UINT16 FilePathListLength;
902 * // CHAR16 Description[]; <-- variable length, NULL terminated
903 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
904 * <-- FilePathListLength bytes
905 * // UINT8 OptionalData[];
906 * } EFI_LOAD_OPTION;
907 */
908struct efi_load_option {
909 u32 attributes;
910 u16 file_path_length;
911 u16 *label;
912 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +0200913 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +0900914};
915
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200916struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt9979cff2021-10-15 01:31:02 +0200917 const efi_guid_t *guid);
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200918struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
919 const struct efi_device_path *dp2);
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900920struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt7ca84f82020-05-31 22:46:09 +0200921efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
922 efi_uintn_t *size);
AKASHI Takahirobd237742018-11-05 18:06:41 +0900923unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt25c6be52020-08-07 17:47:13 +0200924efi_status_t efi_set_load_options(efi_handle_t handle,
925 efi_uintn_t load_options_size,
926 void *load_options);
Heinrich Schuchardta7647a72020-08-07 17:49:39 +0200927efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clarkc84c1102017-09-13 18:05:38 -0400928
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900929/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100930 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900931 *
932 * @max: Maximum number of regions
933 * @num: Number of regions
934 * @reg: array of regions
935 */
936struct efi_image_regions {
937 int max;
938 int num;
939 struct image_region reg[];
940};
941
942/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100943 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900944 *
945 * This structure represents an internal form of signature in
946 * signature database. A listed list may represent a signature list.
947 *
948 * @next: Pointer to next entry
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100949 * @owner: Signature owner
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900950 * @data: Pointer to signature data
951 * @size: Size of signature data
952 */
953struct efi_sig_data {
954 struct efi_sig_data *next;
955 efi_guid_t owner;
956 void *data;
957 size_t size;
958};
959
960/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100961 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900962 *
963 * This structure represents an internal form of signature database.
964 *
965 * @next: Pointer to next entry
966 * @sig_type: Signature type
967 * @sig_data_list: Pointer to signature list
968 */
969struct efi_signature_store {
970 struct efi_signature_store *next;
971 efi_guid_t sig_type;
972 struct efi_sig_data *sig_data_list;
973};
974
975struct x509_certificate;
976struct pkcs7_message;
977
Masahisa Kojima767a9e62022-09-12 17:33:54 +0900978/**
979 * struct eficonfig_media_boot_option - boot option for (removable) media device
980 *
981 * This structure is used to enumerate possible boot option
982 *
983 * @lo: Serialized load option data
984 * @size: Size of serialized load option data
985 * @exist: Flag to indicate the load option already exists
986 * in Non-volatile load option
987 */
988struct eficonfig_media_boot_option {
989 void *lo;
990 efi_uintn_t size;
991 bool exist;
992};
993
AKASHI Takahirof47b9b32022-07-05 14:48:12 +0900994bool efi_hash_regions(struct image_region *regs, int count,
995 void **hash, const char *hash_algo, int *len);
AKASHI Takahirode924072020-07-08 14:01:57 +0900996bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas71eae982022-01-29 00:20:31 +0200997 struct efi_signature_store *db,
998 bool dbx);
AKASHI Takahiro14afd062020-07-21 19:35:22 +0900999bool efi_signature_verify(struct efi_image_regions *regs,
1000 struct pkcs7_message *msg,
1001 struct efi_signature_store *db,
1002 struct efi_signature_store *dbx);
AKASHI Takahiro16411802020-08-14 14:39:23 +09001003static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
1004 struct pkcs7_message *msg,
1005 struct efi_signature_store *db)
1006{
1007 return efi_signature_verify(regs, msg, db, NULL);
1008}
AKASHI Takahiro4154b642020-07-08 14:01:56 +09001009bool efi_signature_check_signers(struct pkcs7_message *msg,
1010 struct efi_signature_store *dbx);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001011
1012efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1013 const void *start, const void *end,
1014 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +09001015
1016void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganufa0faa62020-12-30 19:27:08 +05301017struct efi_signature_store *efi_build_signature_store(void *sig_list,
1018 efi_uintn_t size);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +09001019struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +09001020
1021bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001022
Sughosh Ganu586bb982020-12-30 19:27:09 +05301023bool efi_capsule_auth_enabled(void);
1024
Masahisa Kojima70be5a62021-05-26 12:09:58 +09001025void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1026
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001027bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1028 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001029
Sughosh Ganuea350082020-12-30 19:27:07 +05301030struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1031 size_t buflen,
1032 u8 **tmpbuf);
1033
Heinrich Schuchardt8cd99752020-06-28 16:30:29 +02001034/* runtime implementation of memcpy() */
1035void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1036
Paul Barker8acc3d92022-10-05 13:18:35 +01001037/* commonly used helper functions */
Ilias Apalodimas21575292020-12-31 12:26:46 +02001038u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1039 unsigned int index);
Paul Barker8acc3d92022-10-05 13:18:35 +01001040efi_string_t efi_convert_string(const char *str);
AKASHI Takahiro94074682020-10-29 13:47:46 +09001041
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001042extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahiro7ff3f3c2020-11-17 09:28:00 +09001043extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001044
AKASHI Takahiro473d9b32020-11-17 09:27:55 +09001045/* Capsule update */
1046efi_status_t EFIAPI efi_update_capsule(
1047 struct efi_capsule_header **capsule_header_array,
1048 efi_uintn_t capsule_count,
1049 u64 scatter_gather_list);
1050efi_status_t EFIAPI efi_query_capsule_caps(
1051 struct efi_capsule_header **capsule_header_array,
1052 efi_uintn_t capsule_count,
1053 u64 *maximum_capsule_size,
1054 u32 *reset_type);
1055
Sughosh Ganu586bb982020-12-30 19:27:09 +05301056efi_status_t efi_capsule_authenticate(const void *capsule,
1057 efi_uintn_t capsule_size,
1058 void **image, efi_uintn_t *image_size);
1059
Simon Glass90975372022-01-23 12:55:12 -07001060#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiro45b819542020-11-17 09:27:56 +09001061
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001062/**
Sughosh Ganuccb36462022-04-15 11:29:34 +05301063 * struct efi_fw_image - Information on firmware images updatable through
1064 * capsule update
1065 *
1066 * This structure gives information about the firmware images on the platform
1067 * which can be updated through the capsule update mechanism
1068 *
1069 * @image_type_id: Image GUID. Same value is to be used in the capsule
1070 * @fw_name: Name of the firmware image
1071 * @image_index: Image Index, same as value passed to SetImage FMP
1072 * function
1073 */
1074struct efi_fw_image {
1075 efi_guid_t image_type_id;
1076 u16 *fw_name;
1077 u8 image_index;
1078};
1079
1080/**
1081 * struct efi_capsule_update_info - Information needed for capsule updates
1082 *
1083 * This structure provides information needed for performing firmware
1084 * updates. The structure needs to be initialised per platform, for all
1085 * platforms which enable capsule updates
1086 *
1087 * @dfu_string: String used to populate dfu_alt_info
Masahisa Kojima5d2438b2023-06-07 14:41:51 +09001088 * @num_images: The number of images array entries
Sughosh Ganuccb36462022-04-15 11:29:34 +05301089 * @images: Pointer to an array of updatable images
1090 */
1091struct efi_capsule_update_info {
1092 const char *dfu_string;
Masahisa Kojima5d2438b2023-06-07 14:41:51 +09001093 int num_images;
Sughosh Ganuccb36462022-04-15 11:29:34 +05301094 struct efi_fw_image *images;
1095};
1096
1097extern struct efi_capsule_update_info update_info;
Sughosh Ganuccb36462022-04-15 11:29:34 +05301098
1099/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001100 * Install the ESRT system table.
1101 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001102 * Return: status code
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001103 */
1104efi_status_t efi_esrt_register(void);
1105
1106/**
Jose Marinhoff72cb32021-12-23 14:51:07 +00001107 * efi_ecpt_register() - Install the ECPT system table.
1108 *
1109 * Return: status code
1110 */
1111efi_status_t efi_ecpt_register(void);
1112
1113/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001114 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1115 * present in the system.
1116 * If an ESRT already exists, the old ESRT is replaced in the system table.
1117 * The memory of the old ESRT is deallocated.
1118 *
1119 * Return:
1120 * - EFI_SUCCESS if the ESRT is correctly created
1121 * - error code otherwise.
1122 */
1123efi_status_t efi_esrt_populate(void);
Ilias Apalodimasfac773e2021-06-22 17:38:53 +03001124efi_status_t efi_load_capsule_drivers(void);
Ruchika Guptabc9495c2021-11-29 13:09:44 +05301125
1126efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +09001127
1128efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1129 const efi_guid_t *protocol, void *search_key,
1130 efi_uintn_t *no_handles, efi_handle_t **buffer);
1131
1132efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1133 struct efi_file_handle **root);
1134efi_status_t efi_file_open_int(struct efi_file_handle *this,
1135 struct efi_file_handle **new_handle,
1136 u16 *file_name, u64 open_mode,
1137 u64 attributes);
1138efi_status_t efi_file_close_int(struct efi_file_handle *file);
1139efi_status_t efi_file_read_int(struct efi_file_handle *this,
1140 efi_uintn_t *buffer_size, void *buffer);
1141efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1142
1143typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1144efi_status_t efi_console_get_u16_string
1145 (struct efi_simple_text_input_protocol *cin,
1146 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1147 int row, int col);
1148
1149efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1150
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001151/**
1152 * efi_add_known_memory() - add memory banks to EFI memory map
1153 *
1154 * This weak function may be overridden for specific architectures.
1155 */
1156void efi_add_known_memory(void);
1157
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02001158#endif /* _EFI_LOADER_H */