blob: 7daca0afba2b9b69044c1d25dea0ce3dbc6cd403 [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
Simon Glasse6f6f9e2020-05-10 11:39:58 -060011#include <blk.h>
Heinrich Schuchardtf05911a2022-10-06 07:29:41 +020012#include <event.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060013#include <log.h>
Alexander Grafcb149c62016-03-04 01:09:58 +010014#include <part_efi.h>
15#include <efi_api.h>
AKASHI Takahirod9f33072020-04-21 09:38:38 +090016#include <image.h>
AKASHI Takahiro4540dab2020-04-14 11:51:44 +090017#include <pe.h>
Simon Glass6e3c6542021-07-02 12:36:16 -060018#include <linux/list.h>
19#include <linux/oid_registry.h>
Alexander Grafbee91162016-03-04 01:09:59 +010020
Simon Glasse6f6f9e2020-05-10 11:39:58 -060021struct blk_desc;
AKASHI Takahiro86a3d432021-07-20 14:57:02 +090022struct jmp_buf_data;
Simon Glasse6f6f9e2020-05-10 11:39:58 -060023
Simon Glassfdeb6f72019-09-25 08:11:32 -060024static inline int guidcmp(const void *g1, const void *g2)
25{
26 return memcmp(g1, g2, sizeof(efi_guid_t));
27}
28
Sughosh Ganu61e42d92019-12-29 00:01:04 +053029static inline void *guidcpy(void *dst, const void *src)
30{
31 return memcpy(dst, src, sizeof(efi_guid_t));
32}
33
Stephen Warren9b5e6392018-08-30 15:43:43 -060034#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafbee91162016-03-04 01:09:59 +010035
Simon Glass6e3c6542021-07-02 12:36:16 -060036/**
37 * __efi_runtime_data - declares a non-const variable for EFI runtime section
38 *
39 * This macro indicates that a variable is non-const and should go into the
40 * EFI runtime section, and thus still be available when the OS is running.
41 *
42 * Only use on variables not declared const.
43 *
44 * Example:
45 *
46 * ::
47 *
48 * static __efi_runtime_data my_computed_table[256];
49 */
50#define __efi_runtime_data __section(".data.efi_runtime")
51
52/**
53 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
54 *
55 * This macro indicates that a variable is read-only (const) and should go into
56 * the EFI runtime section, and thus still be available when the OS is running.
57 *
58 * Only use on variables also declared const.
59 *
60 * Example:
61 *
62 * ::
63 *
64 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
65 */
66#define __efi_runtime_rodata __section(".rodata.efi_runtime")
67
68/**
69 * __efi_runtime - declares a function for EFI runtime section
70 *
71 * This macro indicates that a function should go into the EFI runtime section,
72 * and thus still be available when the OS is running.
73 *
74 * Example:
75 *
76 * ::
77 *
78 * static __efi_runtime compute_my_table(void);
79 */
80#define __efi_runtime __section(".text.efi_runtime")
81
82/*
83 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
84 * to make it available at runtime
85 */
86efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
87
88/*
89 * Special case handler for error/abort that just tries to dtrt to get
90 * back to u-boot world
91 */
92void efi_restore_gd(void);
AKASHI Takahiro64228202024-01-17 13:39:41 +090093
Simon Glass6e3c6542021-07-02 12:36:16 -060094/* Called by networking code to memorize the dhcp ack package */
95void efi_net_set_dhcp_ack(void *pkt, int len);
96/* Print information about all loaded images */
97void efi_print_image_infos(void *pc);
98
99/* Hook at initialization */
100efi_status_t efi_launch_capsules(void);
101
102#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
103
104/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
105#define __efi_runtime_data
106#define __efi_runtime_rodata
107#define __efi_runtime
108static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
109{
110 return EFI_SUCCESS;
111}
112
113/* No loader configured, stub out EFI_ENTRY */
114static inline void efi_restore_gd(void) { }
Simon Glass6e3c6542021-07-02 12:36:16 -0600115static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
116static inline void efi_print_image_infos(void *pc) { }
117static inline efi_status_t efi_launch_capsules(void)
118{
119 return EFI_SUCCESS;
120}
121
122#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafcb149c62016-03-04 01:09:58 +0100123
AKASHI Takahiro64228202024-01-17 13:39:41 +0900124#if CONFIG_IS_ENABLED(EFI_BINARY_EXEC)
125/* Call this to unset the current device name */
126void efi_clear_bootdev(void);
127/* Call this to set the current device name */
128void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
129 void *buffer, size_t buffer_size);
130#else
131static inline void efi_clear_bootdev(void) { }
132
133static inline void efi_set_bootdev(const char *dev, const char *devnr,
134 const char *path, void *buffer,
135 size_t buffer_size) { }
136#endif
137
Heinrich Schuchardt4182a122018-06-28 12:45:32 +0200138/* Maximum number of configuration tables */
139#define EFI_MAX_CONFIGURATION_TABLES 16
140
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200141/* GUID used by the root node */
142#define U_BOOT_GUID \
143 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
144 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
Tobias Waldekranz272ec6b2023-02-16 16:33:55 +0100145/* GUID used as root for blkmap devices */
146#define U_BOOT_BLKMAP_DEV_GUID \
147 EFI_GUID(0x4cad859d, 0xd644, 0x42ff, \
148 0x87, 0x0b, 0xc0, 0x2e, 0xac, 0x05, 0x58, 0x63)
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900149/* GUID used as host device on sandbox */
150#define U_BOOT_HOST_DEV_GUID \
151 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
152 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardt19ecced2020-05-20 22:39:35 +0200153/* GUID used as root for virtio devices */
154#define U_BOOT_VIRTIO_DEV_GUID \
155 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
156 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200157
Masahisa Kojima87d79142022-09-12 17:33:50 +0900158/* GUID for the auto generated boot menu entry */
159#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
Masahisa Kojimac1ab0462023-10-12 14:31:59 +0900160 EFI_GUID(0x8108ac4e, 0x9f11, 0x4d59, \
161 0x85, 0x0e, 0xe2, 0x1a, 0x52, 0x2c, 0x59, 0xb2)
Masahisa Kojima87d79142022-09-12 17:33:50 +0900162
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100163/* Use internal device tree when starting UEFI application */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100164#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100165
AKASHI Takahiroa2a4bc32019-04-16 13:24:20 +0900166/* Root node */
167extern efi_handle_t efi_root;
168
Heinrich Schuchardt15b1bf12020-03-19 18:21:58 +0000169/* Set to EFI_SUCCESS when initialized */
170extern efi_status_t efi_obj_list_initialized;
171
Heinrich Schuchardtfccd3d92020-11-12 21:26:28 +0100172/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
173extern bool efi_st_keep_devices;
174
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +0100175/* EFI system partition */
176extern struct efi_system_partition {
Simon Glass8149b152022-09-17 09:00:09 -0600177 enum uclass_id uclass_id;
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +0100178 int devnum;
179 u8 part;
180} efi_system_partition;
181
Rob Clarkc160d2f2017-07-27 08:04:18 -0400182int __efi_entry_check(void);
183int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200184const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -0400185const char *__efi_nesting_inc(void);
186const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400187
Rob Clarka095aad2017-07-27 08:04:17 -0400188/*
189 * Enter the u-boot world from UEFI:
190 */
Alexander Grafbee91162016-03-04 01:09:59 +0100191#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400192 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400193 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
194 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +0100195 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +0100196
Rob Clarka095aad2017-07-27 08:04:17 -0400197/*
198 * Exit the u-boot world back to UEFI:
199 */
Rob Clark804b1d72017-07-24 10:31:52 -0400200#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200201 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -0400202 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200203 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400204 assert(__efi_exit_check()); \
205 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -0400206 })
Alexander Grafbee91162016-03-04 01:09:59 +0100207
Rob Clarka095aad2017-07-27 08:04:17 -0400208/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200209 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -0400210 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200211#define EFI_CALL(exp) ({ \
212 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
213 assert(__efi_exit_check()); \
214 typeof(exp) _r = exp; \
215 assert(__efi_entry_check()); \
216 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
217 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
218 _r; \
219})
220
221/*
222 * Call void UEFI function from u-boot:
223 */
224#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -0400225 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400226 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -0400227 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400228 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400229 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -0400230 } while(0)
231
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200232/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100233 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200234 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100235#define EFI_PRINT(format, ...) ({ \
236 debug("%sEFI: " format, __efi_nesting(), \
237 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200238 })
239
Alexander Graf89aea432018-04-23 07:59:47 +0200240#ifdef CONFIG_SYS_CACHELINE_SIZE
241#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
242#else
243/* Just use the greatest cache flush alignment requirement I'm aware of */
244#define EFI_CACHELINE_SIZE 128
245#endif
246
Masahisa Kojima87d79142022-09-12 17:33:50 +0900247/* max bootmenu title size for volume selection */
248#define BOOTMENU_DEVICE_NAME_MAX 16
249
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +0200250/* Key identifying current memory map */
251extern efi_uintn_t efi_memory_map_key;
252
Alexander Graf50149ea2016-03-04 01:10:01 +0100253extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100254extern struct efi_system_table systab;
255
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200256extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200257extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200258extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200259extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100260/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
261extern const struct efi_device_path_utilities_protocol
262 efi_device_path_utilities;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200263/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200264extern const struct efi_unicode_collation_protocol
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200265 efi_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900266extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
267extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900268extern const struct efi_hii_database_protocol efi_hii_database;
269extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100270
Rob Clarkadae4312017-09-13 18:05:30 -0400271uint16_t *efi_dp_str(struct efi_device_path *dp);
272
Masahisa Kojima87d79142022-09-12 17:33:50 +0900273/* GUID for the auto generated boot menu entry */
274extern const efi_guid_t efi_guid_bootmenu_auto_generated;
275
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200276/* GUID of the U-Boot root node */
277extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900278#ifdef CONFIG_SANDBOX
279/* GUID of U-Boot host device on sandbox */
280extern const efi_guid_t efi_guid_host_dev;
281#endif
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +0100282/* GUID of the EFI_BLOCK_IO_PROTOCOL */
283extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400284extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100285extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100286extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt90dcd9b2022-03-19 07:04:03 +0100287/* GUID of the EFI system partition */
288extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100289/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
290extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100291/* event group ExitBootServices() invoked */
292extern const efi_guid_t efi_guid_event_group_exit_boot_services;
293/* event group SetVirtualAddressMap() invoked */
294extern const efi_guid_t efi_guid_event_group_virtual_address_change;
295/* event group memory map changed */
296extern const efi_guid_t efi_guid_event_group_memory_map_change;
297/* event group boot manager about to boot */
298extern const efi_guid_t efi_guid_event_group_ready_to_boot;
299/* event group ResetSystem() invoked (before ExitBootServices) */
300extern const efi_guid_t efi_guid_event_group_reset_system;
Masahisa Kojimae0d1a1e2023-11-10 13:25:39 +0900301/* event group return to efibootmgr */
302extern const efi_guid_t efi_guid_event_group_return_to_efibootmgr;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100303/* GUID of the device tree table */
304extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100305extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900306extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200307extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400308extern const efi_guid_t efi_simple_file_system_protocol_guid;
309extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200310/* GUID for file system information */
311extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100312extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200313/* GUID of the deprecated Unicode collation protocol */
314extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardtb6f11092020-12-04 03:33:41 +0100315/* GUIDs of the Load File and Load File2 protocol */
316extern const efi_guid_t efi_guid_load_file_protocol;
317extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200318/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200319extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900320extern const efi_guid_t efi_guid_hii_config_routing_protocol;
321extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900322extern const efi_guid_t efi_guid_hii_database_protocol;
323extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900324/* GUIDs for authentication */
325extern const efi_guid_t efi_guid_image_security_database;
326extern const efi_guid_t efi_guid_sha256;
327extern const efi_guid_t efi_guid_cert_x509;
328extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300329extern const efi_guid_t efi_guid_cert_x509_sha384;
330extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900331extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100332
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530333/* GUID of RNG protocol */
334extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900335/* GUID of capsule update result */
336extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900337/* GUID of firmware management protocol */
338extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinho64a8aae2021-03-02 17:26:38 +0000339/* GUID for the ESRT */
340extern const efi_guid_t efi_esrt_guid;
Masahisa Kojima3d49ee82021-10-26 17:27:24 +0900341/* GUID of the SMBIOS table */
342extern const efi_guid_t smbios_guid;
Masahisa Kojima2497f6a2024-01-26 09:53:42 +0900343extern const efi_guid_t smbios3_guid;
Masahisa Kojima87d79142022-09-12 17:33:50 +0900344/*GUID of console */
345extern const efi_guid_t efi_guid_text_input_protocol;
Masahisa Kojima8dbd0a02023-01-24 15:56:15 +0900346extern const efi_guid_t efi_guid_text_output_protocol;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530347
Marek Behún2bdc6f52021-05-20 13:23:56 +0200348extern char __efi_runtime_start[], __efi_runtime_stop[];
349extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf50149ea2016-03-04 01:10:01 +0100350
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200351/**
352 * struct efi_open_protocol_info_item - open protocol info item
353 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100354 * When a protocol is opened a open protocol info entry is created.
355 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200356 *
357 * @link: link to the list of open protocol info entries of a protocol
358 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100359 */
360struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100361 struct list_head link;
362 struct efi_open_protocol_info_entry info;
363};
364
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200365/**
366 * struct efi_handler - single protocol interface of a handle
367 *
Alexander Grafbee91162016-03-04 01:09:59 +0100368 * When the UEFI payload wants to open a protocol on an object to get its
369 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100370 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200371 *
372 * @link: link to the list of protocols of a handle
373 * @guid: GUID of the protocol
374 * @protocol_interface: protocol interface
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100375 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100376 */
Alexander Grafbee91162016-03-04 01:09:59 +0100377struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100378 struct list_head link;
Heinrich Schuchardt66028932022-03-09 19:56:23 +0100379 const efi_guid_t guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200380 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100381 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100382};
383
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200384/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200385 * enum efi_object_type - type of EFI object
386 *
387 * In UnloadImage we must be able to identify if the handle relates to a
388 * started image.
389 */
390enum efi_object_type {
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100391 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200392 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100393 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200394 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100395 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200396 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100397 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200398 EFI_OBJECT_TYPE_STARTED_IMAGE,
399};
400
401/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200402 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100403 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200404 * @link: pointers to put the handle into a linked list
405 * @protocols: linked list with the protocol interfaces installed on this
406 * handle
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100407 * @type: image type if the handle relates to an image
Masahisa Kojimaee576662022-07-22 11:39:10 +0900408 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200409 *
410 * UEFI offers a flexible and expandable object model. The objects in the UEFI
411 * API are devices, drivers, and loaded images. struct efi_object is our storage
412 * structure for these objects.
413 *
414 * When including this structure into a larger structure always put it first so
415 * that when deleting a handle the whole encompassing structure can be freed.
416 *
417 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
418 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100419 */
420struct efi_object {
421 /* Every UEFI object is part of a global object list */
422 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100423 /* The list of protocols */
424 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200425 enum efi_object_type type;
Masahisa Kojimaee576662022-07-22 11:39:10 +0900426 struct udevice *dev;
Alexander Grafbee91162016-03-04 01:09:59 +0100427};
428
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900429enum efi_image_auth_status {
430 EFI_IMAGE_AUTH_FAILED = 0,
431 EFI_IMAGE_AUTH_PASSED,
432};
433
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200434/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200435 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200436 *
437 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200438 * @exit_status: exit status passed to Exit()
439 * @exit_data_size: exit data size passed to Exit()
440 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100441 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200442 * @entry: entry address of the relocated image
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100443 * @image_type: indicates if the image is an applicition or a driver
444 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200445 */
446struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200447 struct efi_object header;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100448 efi_status_t *exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200449 efi_uintn_t *exit_data_size;
450 u16 **exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100451 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200452 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
453 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200454 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900455 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200456};
457
458/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200459 * struct efi_event
460 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100461 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200462 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200463 * @type: Type of event, see efi_create_event
464 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100465 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200466 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100467 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100468 * @trigger_time: Period of the timer
469 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200470 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100471 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200472 */
473struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100474 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200475 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200476 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100477 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200478 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
479 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100480 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200481 u64 trigger_next;
482 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200483 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200484 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200485};
486
Alexander Grafbee91162016-03-04 01:09:59 +0100487/* This list contains all UEFI objects we know of */
488extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100489/* List of all events */
490extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100491
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200492/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200493 * struct efi_protocol_notification - handle for notified protocol
494 *
495 * When a protocol interface is installed for which an event was registered with
496 * the RegisterProtocolNotify() service this structure is used to hold the
497 * handle on which the protocol interface was installed.
498 *
499 * @link: link to list of all handles notified for this event
500 * @handle: handle on which the notified protocol interface was installed
501 */
502struct efi_protocol_notification {
503 struct list_head link;
504 efi_handle_t handle;
505};
506
507/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100508 * struct efi_register_notify_event - event registered by
509 * RegisterProtocolNotify()
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200510 *
511 * The address of this structure serves as registration value.
512 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200513 * @link: link to list of all registered events
514 * @event: registered event. The same event may registered for multiple
515 * GUIDs.
516 * @protocol: protocol for which the event is registered
517 * @handles: linked list of all handles on which the notified protocol was
518 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200519 */
520struct efi_register_notify_event {
521 struct list_head link;
522 struct efi_event *event;
523 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200524 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200525};
526
AKASHI Takahiroa57ad202022-04-19 10:05:11 +0900527/* called at pre-initialization */
528int efi_init_early(void);
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100529/* Initialize efi execution environment */
530efi_status_t efi_init_obj_list(void);
Raymond Mao339b5272023-06-19 14:22:58 -0700531/* Append new boot option in BootOrder variable */
532efi_status_t efi_bootmgr_append_bootorder(u16 index);
533/* Get unused "Boot####" index */
534efi_status_t efi_bootmgr_get_unused_bootoption(u16 *buf,
535 efi_uintn_t buf_size, u32 *index);
536/* Generate the media device boot option */
537efi_status_t efi_bootmgr_update_media_device_boot_option(void);
538/* Delete selected boot option */
539efi_status_t efi_bootmgr_delete_boot_option(u16 boot_index);
AKASHI Takahiro0bef4b02023-11-21 10:29:44 +0900540/* Invoke EFI boot manager */
541efi_status_t efi_bootmgr_run(void *fdt);
Raymond Mao339b5272023-06-19 14:22:58 -0700542/* search the boot option index in BootOrder */
543bool efi_search_bootorder(u16 *bootorder, efi_uintn_t num, u32 target, u32 *index);
Heinrich Schuchardt68edbed2022-06-14 08:02:03 +0200544/* Set up console modes */
545void efi_setup_console_size(void);
AKASHI Takahiro0bef4b02023-11-21 10:29:44 +0900546/* Set up load options from environment variable */
547efi_status_t efi_env_set_load_options(efi_handle_t handle, const char *env_var,
548 u16 **load_options);
Heinrich Schuchardtfa077212024-01-26 08:54:30 +0100549/* Get EFI configuration table */
550void *efi_get_configuration_table(const efi_guid_t *guid);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100551/* Install device tree */
552efi_status_t efi_install_fdt(void *fdt);
AKASHI Takahiro64228202024-01-17 13:39:41 +0900553/* Execute loaded UEFI image */
554efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options);
AKASHI Takahiro0bef4b02023-11-21 10:29:44 +0900555/* Run loaded UEFI image with given fdt */
556efi_status_t efi_binary_run(void *image, size_t size, void *fdt);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200557/* Initialize variable services */
558efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200559/* Notify ExitBootServices() is called */
560void efi_variables_boot_exit_notify(void);
Masahisa Kojimafdff03e2021-08-13 16:12:41 +0900561efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900562/* Measure efi application invocation */
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900563efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900564/* Measure efi application exit */
565efi_status_t efi_tcg2_measure_efi_app_exit(void);
Etienne Carriereaa2d3942023-02-16 17:29:48 +0100566/* Measure DTB */
567efi_status_t efi_tcg2_measure_dtb(void *dtb);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200568/* Called by bootefi to initialize root node */
569efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200570/* Called by bootefi to initialize runtime */
571efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200572/* efi_runtime_detach() - detach unimplemented runtime functions */
573void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100574/* efi_convert_pointer() - convert pointer to virtual address */
575efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
576 void **address);
Heinrich Schuchardt94686f62020-12-13 10:30:24 +0100577/* Carve out DT reserved memory ranges */
578void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimasa2f14822022-01-03 14:07:37 +0200579/* Purge unused kaslr-seed */
580void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200581/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200582efi_status_t efi_console_register(void);
Heinrich Schuchardtd5391bf2022-08-31 16:37:35 +0200583/* Called by efi_init_obj_list() to proble all block devices */
584efi_status_t efi_disks_register(void);
Heinrich Schuchardtb59c13d2020-09-25 12:50:19 +0200585/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
586efi_status_t efi_rng_register(void);
Ilias Apalodimasc1c02102020-11-11 11:18:11 +0200587/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
588efi_status_t efi_tcg2_register(void);
Sunil V L1ccf8712022-01-28 20:48:44 +0530589/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
590efi_status_t efi_riscv_register(void);
Masahisa Kojima54bec172021-12-07 14:15:31 +0900591/* Called by efi_init_obj_list() to do initial measurement */
592efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900593/* measure the pe-coff image, extend PCR and add Event Log */
594efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
595 struct efi_loaded_image_obj *handle,
596 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100597/* Create handles and protocols for the partitions of a block device */
598int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
Simon Glass8149b152022-09-17 09:00:09 -0600599 const char *uclass_idname, int diskid,
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100600 const char *pdevname);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100601/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100602efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200603/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100604efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200605/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100606efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200607efi_status_t efi_initrd_register(void);
Ilias Apalodimas70089c12022-10-16 11:36:32 +0300608efi_status_t efi_initrd_deregister(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200609/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600610/**
Bin Meng86df34d2018-06-27 20:38:03 -0700611 * efi_acpi_register() - write out ACPI tables
612 *
613 * Called by bootefi to make ACPI tables available
614 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100615 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng86df34d2018-06-27 20:38:03 -0700616 */
617efi_status_t efi_acpi_register(void);
618/**
Simon Glass0864c562018-05-16 09:42:19 -0600619 * efi_smbios_register() - write out SMBIOS tables
620 *
621 * Called by bootefi to make SMBIOS tables available
622 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100623 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass0864c562018-05-16 09:42:19 -0600624 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100625efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200626
Rob Clark2a920802017-09-13 18:05:34 -0400627struct efi_simple_file_system_protocol *
628efi_fs_from_path(struct efi_device_path *fp);
629
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200630/* Called by efi_set_watchdog_timer to reset the timer */
631efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200632
Alexander Grafbee91162016-03-04 01:09:59 +0100633/* Called from places to check whether a timer expired */
634void efi_timer_check(void);
Heinrich Schuchardt5dad05a2021-01-12 12:40:32 +0100635/* Check if a buffer contains a PE-COFF image */
636efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafbee91162016-03-04 01:09:59 +0100637/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900638efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
639 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100640 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100641/* Called once to store the pristine gd pointer */
642void efi_save_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100643/* Call this to relocate the runtime section to an address space */
644void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silvabfef72e2022-05-11 10:55:40 +0100645/* Call this to get image parameters */
646void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100647/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200648void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200649/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100650efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100651/* Delete handle */
Ilias Apalodimas54edc372023-07-24 13:17:36 +0300652efi_status_t efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100653/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100654struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod8465ff2022-04-28 17:09:38 +0900655/* Locate device_path handle */
656efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
657 struct efi_device_path **device_path,
658 efi_handle_t *device);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900659/* Load image */
660efi_status_t EFIAPI efi_load_image(bool boot_policy,
661 efi_handle_t parent_image,
662 struct efi_device_path *file_path,
663 void *source_buffer,
664 efi_uintn_t source_size,
665 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100666/* Start image */
667efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
668 efi_uintn_t *exit_data_size,
669 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900670/* Unload image */
671efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200672/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100673efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200674 const efi_guid_t *protocol_guid,
675 struct efi_handler **handler);
676/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100677efi_status_t efi_add_protocol(const efi_handle_t handle,
678 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200679 void *protocol_interface);
Heinrich Schuchardtf9ad2402020-01-10 12:33:59 +0100680/* Open protocol */
681efi_status_t efi_protocol_open(struct efi_handler *handler,
682 void **protocol_interface, void *agent_handle,
683 void *controller_handle, uint32_t attributes);
684
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200685/* Install multiple protocol interfaces */
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +0300686efi_status_t EFIAPI
687efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
688efi_status_t EFIAPI
689efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900690/* Get handles that support a given protocol */
691efi_status_t EFIAPI efi_locate_handle_buffer(
692 enum efi_locate_search_type search_type,
693 const efi_guid_t *protocol, void *search_key,
694 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardtef185762022-10-07 15:18:15 +0200695/* Close a previously opened protocol interface */
696efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
697 efi_handle_t agent_handle,
698 efi_handle_t controller_handle);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900699/* Open a protocol interface */
700efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
701 const efi_guid_t *protocol,
702 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200703/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100704efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200705 void (EFIAPI *notify_function) (
706 struct efi_event *event,
707 void *context),
Masahisa Kojimae23c8e82023-11-10 13:25:38 +0900708 void *notify_context, const efi_guid_t *group,
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100709 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200710/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200711efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200712 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200713/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200714void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100715
AKASHI Takahiro05f391e2022-05-12 11:29:01 +0900716/* return true if the device is removable */
717bool efi_disk_is_removable(efi_handle_t handle);
718
Heinrich Schuchardtcff77002023-07-30 14:03:53 +0200719/**
720 * efi_create_simple_file_system() - create simple file system protocol
721 *
722 * Create a simple file system protocol for a partition.
723 *
724 * @desc: block device descriptor
725 * @part: partition number
726 * @dp: device path
727 * @fsp: simple file system protocol
728 * Return: status code
729 */
730efi_status_t
731efi_create_simple_file_system(struct blk_desc *desc, int part,
732 struct efi_device_path *dp,
733 struct efi_simple_file_system_protocol **fsp);
Rob Clark2a920802017-09-13 18:05:34 -0400734
735/* open file from device-path: */
736struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
737
Jose Marinho64a8aae2021-03-02 17:26:38 +0000738/* Registers a callback function for a notification event. */
739efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
740 struct efi_event *event,
741 void **registration);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200742efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
743
744/* get a device path from a Boot#### option */
745struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
746
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300747/* get len, string (used in u-boot crypto from a guid */
748const char *guid_to_sha_str(const efi_guid_t *guid);
749int algo_to_len(const char *algo);
750
Masahisa Kojimaee576662022-07-22 11:39:10 +0900751int efi_link_dev(efi_handle_t handle, struct udevice *dev);
Heinrich Schuchardt16b27b62022-10-03 09:47:51 +0200752int efi_unlink_dev(efi_handle_t handle);
Masahisa Kojima3ac026a2022-12-02 13:59:35 +0900753bool efi_varname_is_load_option(u16 *var_name16, int *index);
Masahisa Kojimace327082022-12-19 11:33:12 +0900754efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
755 efi_guid_t *guid);
Masahisa Kojimaee576662022-07-22 11:39:10 +0900756
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100757/**
758 * efi_size_in_pages() - convert size in bytes to size in pages
759 *
760 * This macro returns the number of EFI memory pages required to hold 'size'
761 * bytes.
762 *
763 * @size: size in bytes
764 * Return: size in pages
765 */
Heinrich Schuchardt0a7e5162021-01-17 07:52:09 +0100766#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Heinrich Schuchardtf606fab2023-03-19 09:20:22 +0100767/* Allocate boot service data pool memory */
768void *efi_alloc(size_t len);
Ilias Apalodimasebdea882021-10-11 15:10:23 +0300769/* Allocate pages on the specified alignment */
770void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf5d009952016-03-04 01:10:04 +0100771/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200772efi_status_t efi_allocate_pages(enum efi_allocate_type type,
773 enum efi_memory_type memory_type,
774 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200775/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100776efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200777/* EFI memory allocator for small allocations */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200778efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
779 efi_uintn_t size, void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200780/* EFI pool memory free function. */
781efi_status_t efi_free_pool(void *buffer);
Heinrich Schuchardteff44402023-01-05 18:26:01 +0100782/* Allocate and retrieve EFI memory map */
783efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
784 struct efi_mem_desc **memory_map);
Alexander Graf5d009952016-03-04 01:10:04 +0100785/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100786efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100787 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100788 efi_uintn_t *map_key,
789 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100790 uint32_t *descriptor_version);
791/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200792efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000793/* Adds a conventional range into the EFI memory map */
794efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
795 u64 ram_top);
796
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100797/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100798efi_status_t efi_driver_init(void);
Heinrich Schuchardtf05911a2022-10-06 07:29:41 +0200799/* Called when a block device is added */
800int efi_disk_probe(void *ctx, struct event *event);
801/* Called when a block device is removed */
802int efi_disk_remove(void *ctx, struct event *event);
Alexander Graf5d009952016-03-04 01:10:04 +0100803/* Called by board init to initialize the EFI memory map */
804int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200805/* Adds new or overrides configuration table entry to the system table */
806efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100807/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200808efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
809 struct efi_device_path *file_path,
810 struct efi_loaded_image_obj **handle_ptr,
811 struct efi_loaded_image **info_ptr);
Alexander Graf5d009952016-03-04 01:10:04 +0100812
Alexander Graf51735ae2016-05-11 18:25:48 +0200813#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
814extern void *efi_bounce_buffer;
815#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
816#endif
817
Heinrich Schuchardt83994882022-02-26 12:10:10 +0100818/* shorten device path */
819struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400820struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200821int efi_dp_match(const struct efi_device_path *a,
822 const struct efi_device_path *b);
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100823efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardte46ef1d2022-03-19 06:35:43 +0100824 const efi_guid_t *guid,
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100825 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200826/* get size of the first device path instance excluding end node */
827efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
828/* size of multi-instance device path excluding end node */
829efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400830struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400831struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
832 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200833/* Create a device path node of given type, sub-type, length */
834struct efi_device_path *efi_dp_create_device_node(const u8 type,
835 const u8 sub_type,
836 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200837/* Append device path instance */
838struct efi_device_path *efi_dp_append_instance(
839 const struct efi_device_path *dp,
840 const struct efi_device_path *dpi);
841/* Get next device path instance */
842struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
843 efi_uintn_t *size);
844/* Check if a device path contains muliple instances */
845bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400846
Rob Clarkb66c60d2017-09-13 18:05:28 -0400847struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100848/* Create a device node for a block device partition. */
849struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Heinrich Schuchardtc7c0ca32023-05-13 10:36:21 +0200850struct efi_device_path *efi_dp_from_file(const struct efi_device_path *dp,
Rob Clarkb66c60d2017-09-13 18:05:28 -0400851 const char *path);
852struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400853struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
854 uint64_t start_address,
855 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100856/* Determine the last device path node that is not the end node. */
857const struct efi_device_path *efi_dp_last_node(
858 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100859efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
860 struct efi_device_path **device_path,
861 struct efi_device_path **file_path);
Heinrich Schuchardt3c95b322022-02-04 20:47:09 +0100862struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900863efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
864 const char *path,
865 struct efi_device_path **device,
866 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200867ssize_t efi_dp_check_length(const struct efi_device_path *dp,
868 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400869
870#define EFI_DP_TYPE(_dp, _type, _subtype) \
871 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
872 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
873
Masahisa Kojima98973502022-06-19 13:55:59 +0900874/* template END node: */
875extern const struct efi_device_path END;
876
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900877/* Indicate supported runtime services */
878efi_status_t efi_init_runtime_supported(void);
879
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200880/* Update CRC32 in table header */
881void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
882
Alexander Graf80a48002016-08-16 21:08:45 +0200883/* Boards may provide the functions below to implement RTS functionality */
884
Alexander Graf3c63db92016-10-14 13:45:30 +0200885void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200886 enum efi_reset_type reset_type,
887 efi_status_t reset_status,
888 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100889
890/* Architecture specific initialization of the EFI subsystem */
891efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200892
Alexander Graf3c63db92016-10-14 13:45:30 +0200893efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200894 struct efi_time *time,
895 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200896
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200897efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
898
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200899/*
900 * Entry point for the tests of the EFI API.
901 * It is called by 'bootefi selftest'
902 */
903efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
904 struct efi_system_table *systab);
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200905
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100906efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
907 const efi_guid_t *vendor, u32 *attributes,
908 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200909efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
910 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100911 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100912efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
913 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100914 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400915
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200916efi_status_t EFIAPI efi_query_variable_info(
917 u32 attributes, u64 *maximum_variable_storage_size,
918 u64 *remaining_variable_storage_size,
919 u64 *maximum_variable_size);
920
Heinrich Schuchardtd47671c2021-09-09 07:12:14 +0200921void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200922
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900923/*
924 * See section 3.1.3 in the v2.7 UEFI spec for more details on
925 * the layout of EFI_LOAD_OPTION. In short it is:
926 *
927 * typedef struct _EFI_LOAD_OPTION {
928 * UINT32 Attributes;
929 * UINT16 FilePathListLength;
930 * // CHAR16 Description[]; <-- variable length, NULL terminated
931 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
932 * <-- FilePathListLength bytes
933 * // UINT8 OptionalData[];
934 * } EFI_LOAD_OPTION;
935 */
936struct efi_load_option {
937 u32 attributes;
938 u16 file_path_length;
939 u16 *label;
940 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200941 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900942};
943
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200944struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt04217352021-10-15 01:31:02 +0200945 const efi_guid_t *guid);
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200946struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
Ilias Apalodimasf19171c2024-01-08 10:55:33 +0200947 const struct efi_device_path *dp2,
948 bool split_end_node);
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900949struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200950efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
951 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900952unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200953efi_status_t efi_set_load_options(efi_handle_t handle,
954 efi_uintn_t load_options_size,
955 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200956efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400957
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900958/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100959 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900960 *
961 * @max: Maximum number of regions
962 * @num: Number of regions
963 * @reg: array of regions
964 */
965struct efi_image_regions {
966 int max;
967 int num;
968 struct image_region reg[];
969};
970
971/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100972 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900973 *
974 * This structure represents an internal form of signature in
975 * signature database. A listed list may represent a signature list.
976 *
977 * @next: Pointer to next entry
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100978 * @owner: Signature owner
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900979 * @data: Pointer to signature data
980 * @size: Size of signature data
981 */
982struct efi_sig_data {
983 struct efi_sig_data *next;
984 efi_guid_t owner;
985 void *data;
986 size_t size;
987};
988
989/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100990 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900991 *
992 * This structure represents an internal form of signature database.
993 *
994 * @next: Pointer to next entry
995 * @sig_type: Signature type
996 * @sig_data_list: Pointer to signature list
997 */
998struct efi_signature_store {
999 struct efi_signature_store *next;
1000 efi_guid_t sig_type;
1001 struct efi_sig_data *sig_data_list;
1002};
1003
1004struct x509_certificate;
1005struct pkcs7_message;
1006
Masahisa Kojimac416f1c2022-09-12 17:33:54 +09001007/**
1008 * struct eficonfig_media_boot_option - boot option for (removable) media device
1009 *
1010 * This structure is used to enumerate possible boot option
1011 *
1012 * @lo: Serialized load option data
1013 * @size: Size of serialized load option data
1014 * @exist: Flag to indicate the load option already exists
1015 * in Non-volatile load option
1016 */
1017struct eficonfig_media_boot_option {
1018 void *lo;
1019 efi_uintn_t size;
1020 bool exist;
1021};
1022
AKASHI Takahirob3301402022-07-05 14:48:12 +09001023bool efi_hash_regions(struct image_region *regs, int count,
1024 void **hash, const char *hash_algo, int *len);
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +09001025bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas4b634312022-01-29 00:20:31 +02001026 struct efi_signature_store *db,
1027 bool dbx);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +09001028bool efi_signature_verify(struct efi_image_regions *regs,
1029 struct pkcs7_message *msg,
1030 struct efi_signature_store *db,
1031 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +09001032static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
1033 struct pkcs7_message *msg,
1034 struct efi_signature_store *db)
1035{
1036 return efi_signature_verify(regs, msg, db, NULL);
1037}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +09001038bool efi_signature_check_signers(struct pkcs7_message *msg,
1039 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001040
1041efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1042 const void *start, const void *end,
1043 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +09001044
1045void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganub4f20a52020-12-30 19:27:08 +05301046struct efi_signature_store *efi_build_signature_store(void *sig_list,
1047 efi_uintn_t size);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +09001048struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +09001049
1050bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09001051
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301052bool efi_capsule_auth_enabled(void);
1053
Masahisa Kojima163a0d72021-05-26 12:09:58 +09001054void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1055
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09001056bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1057 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001058
Sughosh Ganu201b8062020-12-30 19:27:07 +05301059struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1060 size_t buflen,
1061 u8 **tmpbuf);
1062
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +02001063/* runtime implementation of memcpy() */
1064void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1065
Paul Barker39434a92022-10-05 13:18:35 +01001066/* commonly used helper functions */
Ilias Apalodimasfe179d72020-12-31 12:26:46 +02001067u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1068 unsigned int index);
Paul Barker39434a92022-10-05 13:18:35 +01001069efi_string_t efi_convert_string(const char *str);
AKASHI Takahiro077153e2020-10-29 13:47:46 +09001070
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001071extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +09001072extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001073
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +09001074/* Capsule update */
1075efi_status_t EFIAPI efi_update_capsule(
1076 struct efi_capsule_header **capsule_header_array,
1077 efi_uintn_t capsule_count,
1078 u64 scatter_gather_list);
1079efi_status_t EFIAPI efi_query_capsule_caps(
1080 struct efi_capsule_header **capsule_header_array,
1081 efi_uintn_t capsule_count,
1082 u64 *maximum_capsule_size,
1083 u32 *reset_type);
1084
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301085efi_status_t efi_capsule_authenticate(const void *capsule,
1086 efi_uintn_t capsule_size,
1087 void **image, efi_uintn_t *image_size);
1088
Simon Glass156ccbc2022-01-23 12:55:12 -07001089#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +09001090
Jose Marinho64a8aae2021-03-02 17:26:38 +00001091/**
Sughosh Ganu741ef862022-04-15 11:29:34 +05301092 * struct efi_fw_image - Information on firmware images updatable through
1093 * capsule update
1094 *
1095 * This structure gives information about the firmware images on the platform
1096 * which can be updated through the capsule update mechanism
1097 *
1098 * @image_type_id: Image GUID. Same value is to be used in the capsule
1099 * @fw_name: Name of the firmware image
1100 * @image_index: Image Index, same as value passed to SetImage FMP
1101 * function
1102 */
1103struct efi_fw_image {
1104 efi_guid_t image_type_id;
1105 u16 *fw_name;
1106 u8 image_index;
1107};
1108
1109/**
1110 * struct efi_capsule_update_info - Information needed for capsule updates
1111 *
1112 * This structure provides information needed for performing firmware
1113 * updates. The structure needs to be initialised per platform, for all
1114 * platforms which enable capsule updates
1115 *
1116 * @dfu_string: String used to populate dfu_alt_info
Masahisa Kojimacccea182023-06-07 14:41:51 +09001117 * @num_images: The number of images array entries
Sughosh Ganu741ef862022-04-15 11:29:34 +05301118 * @images: Pointer to an array of updatable images
1119 */
1120struct efi_capsule_update_info {
1121 const char *dfu_string;
Masahisa Kojimacccea182023-06-07 14:41:51 +09001122 int num_images;
Sughosh Ganu741ef862022-04-15 11:29:34 +05301123 struct efi_fw_image *images;
1124};
1125
1126extern struct efi_capsule_update_info update_info;
Sughosh Ganu741ef862022-04-15 11:29:34 +05301127
1128/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001129 * Install the ESRT system table.
1130 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001131 * Return: status code
Jose Marinho64a8aae2021-03-02 17:26:38 +00001132 */
1133efi_status_t efi_esrt_register(void);
1134
1135/**
Jose Marinho6b92c172021-12-23 14:51:07 +00001136 * efi_ecpt_register() - Install the ECPT system table.
1137 *
1138 * Return: status code
1139 */
1140efi_status_t efi_ecpt_register(void);
1141
1142/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001143 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1144 * present in the system.
1145 * If an ESRT already exists, the old ESRT is replaced in the system table.
1146 * The memory of the old ESRT is deallocated.
1147 *
1148 * Return:
1149 * - EFI_SUCCESS if the ESRT is correctly created
1150 * - error code otherwise.
1151 */
1152efi_status_t efi_esrt_populate(void);
Ilias Apalodimas6e0184b2021-06-22 17:38:53 +03001153efi_status_t efi_load_capsule_drivers(void);
Ruchika Gupta34287ef2021-11-29 13:09:44 +05301154
1155efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojima87d79142022-09-12 17:33:50 +09001156
1157efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1158 const efi_guid_t *protocol, void *search_key,
1159 efi_uintn_t *no_handles, efi_handle_t **buffer);
1160
1161efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1162 struct efi_file_handle **root);
1163efi_status_t efi_file_open_int(struct efi_file_handle *this,
1164 struct efi_file_handle **new_handle,
1165 u16 *file_name, u64 open_mode,
1166 u64 attributes);
1167efi_status_t efi_file_close_int(struct efi_file_handle *file);
1168efi_status_t efi_file_read_int(struct efi_file_handle *this,
1169 efi_uintn_t *buffer_size, void *buffer);
1170efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1171
1172typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1173efi_status_t efi_console_get_u16_string
1174 (struct efi_simple_text_input_protocol *cin,
1175 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1176 int row, int col);
1177
1178efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1179
Heinrich Schuchardta9f20ef2023-02-10 09:01:13 +01001180/**
1181 * efi_add_known_memory() - add memory banks to EFI memory map
1182 *
1183 * This weak function may be overridden for specific architectures.
1184 */
1185void efi_add_known_memory(void);
1186
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02001187#endif /* _EFI_LOADER_H */