blob: 1542b4b625ca911b74e02621444a95caba4b945e [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Grafcb149c62016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafcb149c62016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafbee91162016-03-04 01:09:59 +010011#include <common.h>
Simon Glasse6f6f9e2020-05-10 11:39:58 -060012#include <blk.h>
Heinrich Schuchardtf05911a2022-10-06 07:29:41 +020013#include <event.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060014#include <log.h>
Alexander Grafcb149c62016-03-04 01:09:58 +010015#include <part_efi.h>
16#include <efi_api.h>
AKASHI Takahirod9f33072020-04-21 09:38:38 +090017#include <image.h>
AKASHI Takahiro4540dab2020-04-14 11:51:44 +090018#include <pe.h>
Simon Glass6e3c6542021-07-02 12:36:16 -060019#include <linux/list.h>
20#include <linux/oid_registry.h>
Alexander Grafbee91162016-03-04 01:09:59 +010021
Simon Glasse6f6f9e2020-05-10 11:39:58 -060022struct blk_desc;
AKASHI Takahiro86a3d432021-07-20 14:57:02 +090023struct jmp_buf_data;
Simon Glasse6f6f9e2020-05-10 11:39:58 -060024
Simon Glassfdeb6f72019-09-25 08:11:32 -060025static inline int guidcmp(const void *g1, const void *g2)
26{
27 return memcmp(g1, g2, sizeof(efi_guid_t));
28}
29
Sughosh Ganu61e42d92019-12-29 00:01:04 +053030static inline void *guidcpy(void *dst, const void *src)
31{
32 return memcpy(dst, src, sizeof(efi_guid_t));
33}
34
Stephen Warren9b5e6392018-08-30 15:43:43 -060035#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafbee91162016-03-04 01:09:59 +010036
Simon Glass6e3c6542021-07-02 12:36:16 -060037/**
38 * __efi_runtime_data - declares a non-const variable for EFI runtime section
39 *
40 * This macro indicates that a variable is non-const and should go into the
41 * EFI runtime section, and thus still be available when the OS is running.
42 *
43 * Only use on variables not declared const.
44 *
45 * Example:
46 *
47 * ::
48 *
49 * static __efi_runtime_data my_computed_table[256];
50 */
51#define __efi_runtime_data __section(".data.efi_runtime")
52
53/**
54 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
55 *
56 * This macro indicates that a variable is read-only (const) and should go into
57 * the EFI runtime section, and thus still be available when the OS is running.
58 *
59 * Only use on variables also declared const.
60 *
61 * Example:
62 *
63 * ::
64 *
65 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
66 */
67#define __efi_runtime_rodata __section(".rodata.efi_runtime")
68
69/**
70 * __efi_runtime - declares a function for EFI runtime section
71 *
72 * This macro indicates that a function should go into the EFI runtime section,
73 * and thus still be available when the OS is running.
74 *
75 * Example:
76 *
77 * ::
78 *
79 * static __efi_runtime compute_my_table(void);
80 */
81#define __efi_runtime __section(".text.efi_runtime")
82
83/*
84 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
85 * to make it available at runtime
86 */
87efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
88
89/*
90 * Special case handler for error/abort that just tries to dtrt to get
91 * back to u-boot world
92 */
93void efi_restore_gd(void);
94/* Call this to set the current device name */
95void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
96 void *buffer, size_t buffer_size);
97/* Called by networking code to memorize the dhcp ack package */
98void efi_net_set_dhcp_ack(void *pkt, int len);
99/* Print information about all loaded images */
100void efi_print_image_infos(void *pc);
101
102/* Hook at initialization */
103efi_status_t efi_launch_capsules(void);
104
105#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
106
107/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
108#define __efi_runtime_data
109#define __efi_runtime_rodata
110#define __efi_runtime
111static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
112{
113 return EFI_SUCCESS;
114}
115
116/* No loader configured, stub out EFI_ENTRY */
117static inline void efi_restore_gd(void) { }
118static inline void efi_set_bootdev(const char *dev, const char *devnr,
119 const char *path, void *buffer,
120 size_t buffer_size) { }
121static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
122static inline void efi_print_image_infos(void *pc) { }
123static inline efi_status_t efi_launch_capsules(void)
124{
125 return EFI_SUCCESS;
126}
127
128#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafcb149c62016-03-04 01:09:58 +0100129
Heinrich Schuchardt4182a122018-06-28 12:45:32 +0200130/* Maximum number of configuration tables */
131#define EFI_MAX_CONFIGURATION_TABLES 16
132
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200133/* GUID used by the root node */
134#define U_BOOT_GUID \
135 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
136 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900137/* GUID used as host device on sandbox */
138#define U_BOOT_HOST_DEV_GUID \
139 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
140 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardt19ecced2020-05-20 22:39:35 +0200141/* GUID used as root for virtio devices */
142#define U_BOOT_VIRTIO_DEV_GUID \
143 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
144 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200145
Masahisa Kojima87d79142022-09-12 17:33:50 +0900146/* GUID for the auto generated boot menu entry */
147#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
148 EFI_GUID(0x38c1acc1, 0x9fc0, 0x41f0, \
149 0xb9, 0x01, 0xfa, 0x74, 0xd6, 0xd6, 0xe4, 0xde)
150
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100151/* Use internal device tree when starting UEFI application */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100152#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100153
AKASHI Takahiroa2a4bc32019-04-16 13:24:20 +0900154/* Root node */
155extern efi_handle_t efi_root;
156
Heinrich Schuchardt15b1bf12020-03-19 18:21:58 +0000157/* Set to EFI_SUCCESS when initialized */
158extern efi_status_t efi_obj_list_initialized;
159
Heinrich Schuchardtfccd3d92020-11-12 21:26:28 +0100160/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
161extern bool efi_st_keep_devices;
162
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +0100163/* EFI system partition */
164extern struct efi_system_partition {
Simon Glass8149b152022-09-17 09:00:09 -0600165 enum uclass_id uclass_id;
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +0100166 int devnum;
167 u8 part;
168} efi_system_partition;
169
Rob Clarkc160d2f2017-07-27 08:04:18 -0400170int __efi_entry_check(void);
171int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200172const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -0400173const char *__efi_nesting_inc(void);
174const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400175
Rob Clarka095aad2017-07-27 08:04:17 -0400176/*
177 * Enter the u-boot world from UEFI:
178 */
Alexander Grafbee91162016-03-04 01:09:59 +0100179#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400180 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400181 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
182 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +0100183 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +0100184
Rob Clarka095aad2017-07-27 08:04:17 -0400185/*
186 * Exit the u-boot world back to UEFI:
187 */
Rob Clark804b1d72017-07-24 10:31:52 -0400188#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200189 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -0400190 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200191 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400192 assert(__efi_exit_check()); \
193 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -0400194 })
Alexander Grafbee91162016-03-04 01:09:59 +0100195
Rob Clarka095aad2017-07-27 08:04:17 -0400196/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200197 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -0400198 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200199#define EFI_CALL(exp) ({ \
200 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
201 assert(__efi_exit_check()); \
202 typeof(exp) _r = exp; \
203 assert(__efi_entry_check()); \
204 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
205 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
206 _r; \
207})
208
209/*
210 * Call void UEFI function from u-boot:
211 */
212#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -0400213 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400214 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -0400215 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400216 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400217 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -0400218 } while(0)
219
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200220/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100221 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200222 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100223#define EFI_PRINT(format, ...) ({ \
224 debug("%sEFI: " format, __efi_nesting(), \
225 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200226 })
227
Alexander Graf89aea432018-04-23 07:59:47 +0200228#ifdef CONFIG_SYS_CACHELINE_SIZE
229#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
230#else
231/* Just use the greatest cache flush alignment requirement I'm aware of */
232#define EFI_CACHELINE_SIZE 128
233#endif
234
Masahisa Kojima87d79142022-09-12 17:33:50 +0900235/* max bootmenu title size for volume selection */
236#define BOOTMENU_DEVICE_NAME_MAX 16
237
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +0200238/* Key identifying current memory map */
239extern efi_uintn_t efi_memory_map_key;
240
Alexander Graf50149ea2016-03-04 01:10:01 +0100241extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100242extern struct efi_system_table systab;
243
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200244extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200245extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200246extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200247extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100248/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
249extern const struct efi_device_path_utilities_protocol
250 efi_device_path_utilities;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200251/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200252extern const struct efi_unicode_collation_protocol
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200253 efi_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900254extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
255extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900256extern const struct efi_hii_database_protocol efi_hii_database;
257extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100258
Rob Clarkadae4312017-09-13 18:05:30 -0400259uint16_t *efi_dp_str(struct efi_device_path *dp);
260
Masahisa Kojima87d79142022-09-12 17:33:50 +0900261/* GUID for the auto generated boot menu entry */
262extern const efi_guid_t efi_guid_bootmenu_auto_generated;
263
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200264/* GUID of the U-Boot root node */
265extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900266#ifdef CONFIG_SANDBOX
267/* GUID of U-Boot host device on sandbox */
268extern const efi_guid_t efi_guid_host_dev;
269#endif
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +0100270/* GUID of the EFI_BLOCK_IO_PROTOCOL */
271extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400272extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100273extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100274extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt90dcd9b2022-03-19 07:04:03 +0100275/* GUID of the EFI system partition */
276extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100277/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
278extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100279/* event group ExitBootServices() invoked */
280extern const efi_guid_t efi_guid_event_group_exit_boot_services;
281/* event group SetVirtualAddressMap() invoked */
282extern const efi_guid_t efi_guid_event_group_virtual_address_change;
283/* event group memory map changed */
284extern const efi_guid_t efi_guid_event_group_memory_map_change;
285/* event group boot manager about to boot */
286extern const efi_guid_t efi_guid_event_group_ready_to_boot;
287/* event group ResetSystem() invoked (before ExitBootServices) */
288extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100289/* GUID of the device tree table */
290extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100291extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900292extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200293extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400294extern const efi_guid_t efi_simple_file_system_protocol_guid;
295extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200296/* GUID for file system information */
297extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100298extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200299/* GUID of the deprecated Unicode collation protocol */
300extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardtb6f11092020-12-04 03:33:41 +0100301/* GUIDs of the Load File and Load File2 protocol */
302extern const efi_guid_t efi_guid_load_file_protocol;
303extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200304/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200305extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900306extern const efi_guid_t efi_guid_hii_config_routing_protocol;
307extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900308extern const efi_guid_t efi_guid_hii_database_protocol;
309extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900310/* GUIDs for authentication */
311extern const efi_guid_t efi_guid_image_security_database;
312extern const efi_guid_t efi_guid_sha256;
313extern const efi_guid_t efi_guid_cert_x509;
314extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300315extern const efi_guid_t efi_guid_cert_x509_sha384;
316extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900317extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100318
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530319/* GUID of RNG protocol */
320extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900321/* GUID of capsule update result */
322extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900323/* GUID of firmware management protocol */
324extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinho64a8aae2021-03-02 17:26:38 +0000325/* GUID for the ESRT */
326extern const efi_guid_t efi_esrt_guid;
Masahisa Kojima3d49ee82021-10-26 17:27:24 +0900327/* GUID of the SMBIOS table */
328extern const efi_guid_t smbios_guid;
Masahisa Kojima87d79142022-09-12 17:33:50 +0900329/*GUID of console */
330extern const efi_guid_t efi_guid_text_input_protocol;
Masahisa Kojima8dbd0a02023-01-24 15:56:15 +0900331extern const efi_guid_t efi_guid_text_output_protocol;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530332
Marek Behún2bdc6f52021-05-20 13:23:56 +0200333extern char __efi_runtime_start[], __efi_runtime_stop[];
334extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf50149ea2016-03-04 01:10:01 +0100335
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200336/**
337 * struct efi_open_protocol_info_item - open protocol info item
338 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100339 * When a protocol is opened a open protocol info entry is created.
340 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200341 *
342 * @link: link to the list of open protocol info entries of a protocol
343 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100344 */
345struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100346 struct list_head link;
347 struct efi_open_protocol_info_entry info;
348};
349
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200350/**
351 * struct efi_handler - single protocol interface of a handle
352 *
Alexander Grafbee91162016-03-04 01:09:59 +0100353 * When the UEFI payload wants to open a protocol on an object to get its
354 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100355 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200356 *
357 * @link: link to the list of protocols of a handle
358 * @guid: GUID of the protocol
359 * @protocol_interface: protocol interface
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100360 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100361 */
Alexander Grafbee91162016-03-04 01:09:59 +0100362struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100363 struct list_head link;
Heinrich Schuchardt66028932022-03-09 19:56:23 +0100364 const efi_guid_t guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200365 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100366 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100367};
368
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200369/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200370 * enum efi_object_type - type of EFI object
371 *
372 * In UnloadImage we must be able to identify if the handle relates to a
373 * started image.
374 */
375enum efi_object_type {
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100376 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200377 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100378 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200379 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100380 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200381 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100382 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200383 EFI_OBJECT_TYPE_STARTED_IMAGE,
384};
385
386/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200387 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100388 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200389 * @link: pointers to put the handle into a linked list
390 * @protocols: linked list with the protocol interfaces installed on this
391 * handle
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100392 * @type: image type if the handle relates to an image
Masahisa Kojimaee576662022-07-22 11:39:10 +0900393 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200394 *
395 * UEFI offers a flexible and expandable object model. The objects in the UEFI
396 * API are devices, drivers, and loaded images. struct efi_object is our storage
397 * structure for these objects.
398 *
399 * When including this structure into a larger structure always put it first so
400 * that when deleting a handle the whole encompassing structure can be freed.
401 *
402 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
403 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100404 */
405struct efi_object {
406 /* Every UEFI object is part of a global object list */
407 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100408 /* The list of protocols */
409 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200410 enum efi_object_type type;
Masahisa Kojimaee576662022-07-22 11:39:10 +0900411 struct udevice *dev;
Alexander Grafbee91162016-03-04 01:09:59 +0100412};
413
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900414enum efi_image_auth_status {
415 EFI_IMAGE_AUTH_FAILED = 0,
416 EFI_IMAGE_AUTH_PASSED,
417};
418
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200419/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200420 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200421 *
422 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200423 * @exit_status: exit status passed to Exit()
424 * @exit_data_size: exit data size passed to Exit()
425 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100426 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200427 * @entry: entry address of the relocated image
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100428 * @image_type: indicates if the image is an applicition or a driver
429 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200430 */
431struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200432 struct efi_object header;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100433 efi_status_t *exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200434 efi_uintn_t *exit_data_size;
435 u16 **exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100436 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200437 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
438 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200439 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900440 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200441};
442
443/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200444 * struct efi_event
445 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100446 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200447 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200448 * @type: Type of event, see efi_create_event
449 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100450 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200451 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100452 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100453 * @trigger_time: Period of the timer
454 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200455 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100456 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200457 */
458struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100459 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200460 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200461 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100462 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200463 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
464 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100465 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200466 u64 trigger_next;
467 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200468 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200469 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200470};
471
Alexander Grafbee91162016-03-04 01:09:59 +0100472/* This list contains all UEFI objects we know of */
473extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100474/* List of all events */
475extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100476
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200477/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200478 * struct efi_protocol_notification - handle for notified protocol
479 *
480 * When a protocol interface is installed for which an event was registered with
481 * the RegisterProtocolNotify() service this structure is used to hold the
482 * handle on which the protocol interface was installed.
483 *
484 * @link: link to list of all handles notified for this event
485 * @handle: handle on which the notified protocol interface was installed
486 */
487struct efi_protocol_notification {
488 struct list_head link;
489 efi_handle_t handle;
490};
491
492/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100493 * struct efi_register_notify_event - event registered by
494 * RegisterProtocolNotify()
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200495 *
496 * The address of this structure serves as registration value.
497 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200498 * @link: link to list of all registered events
499 * @event: registered event. The same event may registered for multiple
500 * GUIDs.
501 * @protocol: protocol for which the event is registered
502 * @handles: linked list of all handles on which the notified protocol was
503 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200504 */
505struct efi_register_notify_event {
506 struct list_head link;
507 struct efi_event *event;
508 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200509 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200510};
511
512/* List of all events registered by RegisterProtocolNotify() */
513extern struct list_head efi_register_notify_events;
514
AKASHI Takahiroa57ad202022-04-19 10:05:11 +0900515/* called at pre-initialization */
516int efi_init_early(void);
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100517/* Initialize efi execution environment */
518efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt68edbed2022-06-14 08:02:03 +0200519/* Set up console modes */
520void efi_setup_console_size(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100521/* Install device tree */
522efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100523/* Run loaded UEFI image */
524efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200525/* Initialize variable services */
526efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200527/* Notify ExitBootServices() is called */
528void efi_variables_boot_exit_notify(void);
Masahisa Kojimafdff03e2021-08-13 16:12:41 +0900529efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900530/* Measure efi application invocation */
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900531efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900532/* Measure efi application exit */
533efi_status_t efi_tcg2_measure_efi_app_exit(void);
Etienne Carriereaa2d3942023-02-16 17:29:48 +0100534/* Measure DTB */
535efi_status_t efi_tcg2_measure_dtb(void *dtb);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200536/* Called by bootefi to initialize root node */
537efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200538/* Called by bootefi to initialize runtime */
539efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200540/* efi_runtime_detach() - detach unimplemented runtime functions */
541void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100542/* efi_convert_pointer() - convert pointer to virtual address */
543efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
544 void **address);
Heinrich Schuchardt94686f62020-12-13 10:30:24 +0100545/* Carve out DT reserved memory ranges */
546void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimasa2f14822022-01-03 14:07:37 +0200547/* Purge unused kaslr-seed */
548void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200549/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200550efi_status_t efi_console_register(void);
Heinrich Schuchardtd5391bf2022-08-31 16:37:35 +0200551/* Called by efi_init_obj_list() to proble all block devices */
552efi_status_t efi_disks_register(void);
Heinrich Schuchardtb59c13d2020-09-25 12:50:19 +0200553/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
554efi_status_t efi_rng_register(void);
Ilias Apalodimasc1c02102020-11-11 11:18:11 +0200555/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
556efi_status_t efi_tcg2_register(void);
Sunil V L1ccf8712022-01-28 20:48:44 +0530557/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
558efi_status_t efi_riscv_register(void);
Masahisa Kojima54bec172021-12-07 14:15:31 +0900559/* Called by efi_init_obj_list() to do initial measurement */
560efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900561/* measure the pe-coff image, extend PCR and add Event Log */
562efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
563 struct efi_loaded_image_obj *handle,
564 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100565/* Create handles and protocols for the partitions of a block device */
566int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
Simon Glass8149b152022-09-17 09:00:09 -0600567 const char *uclass_idname, int diskid,
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100568 const char *pdevname);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100569/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100570efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200571/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100572efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200573/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100574efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200575efi_status_t efi_initrd_register(void);
Ilias Apalodimas70089c12022-10-16 11:36:32 +0300576efi_status_t efi_initrd_deregister(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200577/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600578/**
Bin Meng86df34d2018-06-27 20:38:03 -0700579 * efi_acpi_register() - write out ACPI tables
580 *
581 * Called by bootefi to make ACPI tables available
582 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100583 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng86df34d2018-06-27 20:38:03 -0700584 */
585efi_status_t efi_acpi_register(void);
586/**
Simon Glass0864c562018-05-16 09:42:19 -0600587 * efi_smbios_register() - write out SMBIOS tables
588 *
589 * Called by bootefi to make SMBIOS tables available
590 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100591 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass0864c562018-05-16 09:42:19 -0600592 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100593efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200594
Rob Clark2a920802017-09-13 18:05:34 -0400595struct efi_simple_file_system_protocol *
596efi_fs_from_path(struct efi_device_path *fp);
597
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200598/* Called by efi_set_watchdog_timer to reset the timer */
599efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200600
Alexander Grafbee91162016-03-04 01:09:59 +0100601/* Called from places to check whether a timer expired */
602void efi_timer_check(void);
Heinrich Schuchardt5dad05a2021-01-12 12:40:32 +0100603/* Check if a buffer contains a PE-COFF image */
604efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafbee91162016-03-04 01:09:59 +0100605/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900606efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
607 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100608 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100609/* Called once to store the pristine gd pointer */
610void efi_save_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100611/* Call this to relocate the runtime section to an address space */
612void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silvabfef72e2022-05-11 10:55:40 +0100613/* Call this to get image parameters */
614void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100615/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200616void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200617/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100618efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100619/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200620void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100621/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100622struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod8465ff2022-04-28 17:09:38 +0900623/* Locate device_path handle */
624efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
625 struct efi_device_path **device_path,
626 efi_handle_t *device);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900627/* Load image */
628efi_status_t EFIAPI efi_load_image(bool boot_policy,
629 efi_handle_t parent_image,
630 struct efi_device_path *file_path,
631 void *source_buffer,
632 efi_uintn_t source_size,
633 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100634/* Start image */
635efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
636 efi_uintn_t *exit_data_size,
637 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900638/* Unload image */
639efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200640/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100641efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200642 const efi_guid_t *protocol_guid,
643 struct efi_handler **handler);
644/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100645efi_status_t efi_add_protocol(const efi_handle_t handle,
646 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200647 void *protocol_interface);
Heinrich Schuchardtf9ad2402020-01-10 12:33:59 +0100648/* Open protocol */
649efi_status_t efi_protocol_open(struct efi_handler *handler,
650 void **protocol_interface, void *agent_handle,
651 void *controller_handle, uint32_t attributes);
652
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200653/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100654efi_status_t efi_remove_protocol(const efi_handle_t handle,
655 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200656 void *protocol_interface);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200657/* Install multiple protocol interfaces */
Ilias Apalodimas05c4c9e2022-10-06 16:08:46 +0300658efi_status_t EFIAPI
659efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
660efi_status_t EFIAPI
661efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900662/* Get handles that support a given protocol */
663efi_status_t EFIAPI efi_locate_handle_buffer(
664 enum efi_locate_search_type search_type,
665 const efi_guid_t *protocol, void *search_key,
666 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardtef185762022-10-07 15:18:15 +0200667/* Close a previously opened protocol interface */
668efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
669 efi_handle_t agent_handle,
670 efi_handle_t controller_handle);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900671/* Open a protocol interface */
672efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
673 const efi_guid_t *protocol,
674 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200675/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100676efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200677 void (EFIAPI *notify_function) (
678 struct efi_event *event,
679 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100680 void *notify_context, efi_guid_t *group,
681 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200682/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200683efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200684 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200685/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200686void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100687
AKASHI Takahiro05f391e2022-05-12 11:29:01 +0900688/* return true if the device is removable */
689bool efi_disk_is_removable(efi_handle_t handle);
690
Rob Clark2a920802017-09-13 18:05:34 -0400691/* open file system: */
692struct efi_simple_file_system_protocol *efi_simple_file_system(
693 struct blk_desc *desc, int part, struct efi_device_path *dp);
694
695/* open file from device-path: */
696struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
697
Jose Marinho64a8aae2021-03-02 17:26:38 +0000698/* Registers a callback function for a notification event. */
699efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
700 struct efi_event *event,
701 void **registration);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200702efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
703
704/* get a device path from a Boot#### option */
705struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
706
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300707/* get len, string (used in u-boot crypto from a guid */
708const char *guid_to_sha_str(const efi_guid_t *guid);
709int algo_to_len(const char *algo);
710
Masahisa Kojimaee576662022-07-22 11:39:10 +0900711int efi_link_dev(efi_handle_t handle, struct udevice *dev);
Heinrich Schuchardt16b27b62022-10-03 09:47:51 +0200712int efi_unlink_dev(efi_handle_t handle);
Masahisa Kojima3ac026a2022-12-02 13:59:35 +0900713bool efi_varname_is_load_option(u16 *var_name16, int *index);
Masahisa Kojimace327082022-12-19 11:33:12 +0900714efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
715 efi_guid_t *guid);
Masahisa Kojimaee576662022-07-22 11:39:10 +0900716
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100717/**
718 * efi_size_in_pages() - convert size in bytes to size in pages
719 *
720 * This macro returns the number of EFI memory pages required to hold 'size'
721 * bytes.
722 *
723 * @size: size in bytes
724 * Return: size in pages
725 */
Heinrich Schuchardt0a7e5162021-01-17 07:52:09 +0100726#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100727/* Generic EFI memory allocator, call this to get memory */
728void *efi_alloc(uint64_t len, int memory_type);
Ilias Apalodimasebdea882021-10-11 15:10:23 +0300729/* Allocate pages on the specified alignment */
730void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf5d009952016-03-04 01:10:04 +0100731/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200732efi_status_t efi_allocate_pages(enum efi_allocate_type type,
733 enum efi_memory_type memory_type,
734 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200735/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100736efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200737/* EFI memory allocator for small allocations */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200738efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
739 efi_uintn_t size, void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200740/* EFI pool memory free function. */
741efi_status_t efi_free_pool(void *buffer);
Heinrich Schuchardteff44402023-01-05 18:26:01 +0100742/* Allocate and retrieve EFI memory map */
743efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
744 struct efi_mem_desc **memory_map);
Alexander Graf5d009952016-03-04 01:10:04 +0100745/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100746efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100747 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100748 efi_uintn_t *map_key,
749 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100750 uint32_t *descriptor_version);
751/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200752efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000753/* Adds a conventional range into the EFI memory map */
754efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
755 u64 ram_top);
756
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100757/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100758efi_status_t efi_driver_init(void);
Heinrich Schuchardtf05911a2022-10-06 07:29:41 +0200759/* Called when a block device is added */
760int efi_disk_probe(void *ctx, struct event *event);
761/* Called when a block device is removed */
762int efi_disk_remove(void *ctx, struct event *event);
Alexander Graf5d009952016-03-04 01:10:04 +0100763/* Called by board init to initialize the EFI memory map */
764int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200765/* Adds new or overrides configuration table entry to the system table */
766efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100767/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200768efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
769 struct efi_device_path *file_path,
770 struct efi_loaded_image_obj **handle_ptr,
771 struct efi_loaded_image **info_ptr);
Alexander Graf5d009952016-03-04 01:10:04 +0100772
Alexander Graf51735ae2016-05-11 18:25:48 +0200773#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
774extern void *efi_bounce_buffer;
775#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
776#endif
777
Heinrich Schuchardt83994882022-02-26 12:10:10 +0100778/* shorten device path */
779struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400780struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200781int efi_dp_match(const struct efi_device_path *a,
782 const struct efi_device_path *b);
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100783efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardte46ef1d2022-03-19 06:35:43 +0100784 const efi_guid_t *guid,
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100785 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200786/* get size of the first device path instance excluding end node */
787efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
788/* size of multi-instance device path excluding end node */
789efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400790struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
791struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
792 const struct efi_device_path *dp2);
793struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
794 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200795/* Create a device path node of given type, sub-type, length */
796struct efi_device_path *efi_dp_create_device_node(const u8 type,
797 const u8 sub_type,
798 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200799/* Append device path instance */
800struct efi_device_path *efi_dp_append_instance(
801 const struct efi_device_path *dp,
802 const struct efi_device_path *dpi);
803/* Get next device path instance */
804struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
805 efi_uintn_t *size);
806/* Check if a device path contains muliple instances */
807bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400808
Rob Clarkb66c60d2017-09-13 18:05:28 -0400809struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100810/* Create a device node for a block device partition. */
811struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400812struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
813 const char *path);
814struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400815struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
816 uint64_t start_address,
817 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100818/* Determine the last device path node that is not the end node. */
819const struct efi_device_path *efi_dp_last_node(
820 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100821efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
822 struct efi_device_path **device_path,
823 struct efi_device_path **file_path);
Heinrich Schuchardt3c95b322022-02-04 20:47:09 +0100824struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900825efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
826 const char *path,
827 struct efi_device_path **device,
828 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200829ssize_t efi_dp_check_length(const struct efi_device_path *dp,
830 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400831
832#define EFI_DP_TYPE(_dp, _type, _subtype) \
833 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
834 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
835
Masahisa Kojima98973502022-06-19 13:55:59 +0900836/* template END node: */
837extern const struct efi_device_path END;
838
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900839/* Indicate supported runtime services */
840efi_status_t efi_init_runtime_supported(void);
841
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200842/* Update CRC32 in table header */
843void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
844
Alexander Graf80a48002016-08-16 21:08:45 +0200845/* Boards may provide the functions below to implement RTS functionality */
846
Alexander Graf3c63db92016-10-14 13:45:30 +0200847void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200848 enum efi_reset_type reset_type,
849 efi_status_t reset_status,
850 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100851
852/* Architecture specific initialization of the EFI subsystem */
853efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200854
Alexander Graf3c63db92016-10-14 13:45:30 +0200855efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200856 struct efi_time *time,
857 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200858
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200859efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
860
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200861#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
862/*
863 * Entry point for the tests of the EFI API.
864 * It is called by 'bootefi selftest'
865 */
866efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
867 struct efi_system_table *systab);
868#endif
869
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100870efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
871 const efi_guid_t *vendor, u32 *attributes,
872 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200873efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
874 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100875 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100876efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
877 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100878 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400879
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200880efi_status_t EFIAPI efi_query_variable_info(
881 u32 attributes, u64 *maximum_variable_storage_size,
882 u64 *remaining_variable_storage_size,
883 u64 *maximum_variable_size);
884
Heinrich Schuchardtd47671c2021-09-09 07:12:14 +0200885void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200886
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900887/*
888 * See section 3.1.3 in the v2.7 UEFI spec for more details on
889 * the layout of EFI_LOAD_OPTION. In short it is:
890 *
891 * typedef struct _EFI_LOAD_OPTION {
892 * UINT32 Attributes;
893 * UINT16 FilePathListLength;
894 * // CHAR16 Description[]; <-- variable length, NULL terminated
895 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
896 * <-- FilePathListLength bytes
897 * // UINT8 OptionalData[];
898 * } EFI_LOAD_OPTION;
899 */
900struct efi_load_option {
901 u32 attributes;
902 u16 file_path_length;
903 u16 *label;
904 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200905 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900906};
907
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200908struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt04217352021-10-15 01:31:02 +0200909 const efi_guid_t *guid);
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200910struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
911 const struct efi_device_path *dp2);
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900912struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200913efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
914 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900915unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200916efi_status_t efi_set_load_options(efi_handle_t handle,
917 efi_uintn_t load_options_size,
918 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200919efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400920
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900921/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100922 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900923 *
924 * @max: Maximum number of regions
925 * @num: Number of regions
926 * @reg: array of regions
927 */
928struct efi_image_regions {
929 int max;
930 int num;
931 struct image_region reg[];
932};
933
934/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100935 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900936 *
937 * This structure represents an internal form of signature in
938 * signature database. A listed list may represent a signature list.
939 *
940 * @next: Pointer to next entry
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100941 * @owner: Signature owner
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900942 * @data: Pointer to signature data
943 * @size: Size of signature data
944 */
945struct efi_sig_data {
946 struct efi_sig_data *next;
947 efi_guid_t owner;
948 void *data;
949 size_t size;
950};
951
952/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100953 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900954 *
955 * This structure represents an internal form of signature database.
956 *
957 * @next: Pointer to next entry
958 * @sig_type: Signature type
959 * @sig_data_list: Pointer to signature list
960 */
961struct efi_signature_store {
962 struct efi_signature_store *next;
963 efi_guid_t sig_type;
964 struct efi_sig_data *sig_data_list;
965};
966
967struct x509_certificate;
968struct pkcs7_message;
969
Masahisa Kojimac416f1c2022-09-12 17:33:54 +0900970/**
971 * struct eficonfig_media_boot_option - boot option for (removable) media device
972 *
973 * This structure is used to enumerate possible boot option
974 *
975 * @lo: Serialized load option data
976 * @size: Size of serialized load option data
977 * @exist: Flag to indicate the load option already exists
978 * in Non-volatile load option
979 */
980struct eficonfig_media_boot_option {
981 void *lo;
982 efi_uintn_t size;
983 bool exist;
984};
985
AKASHI Takahirob3301402022-07-05 14:48:12 +0900986bool efi_hash_regions(struct image_region *regs, int count,
987 void **hash, const char *hash_algo, int *len);
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900988bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas4b634312022-01-29 00:20:31 +0200989 struct efi_signature_store *db,
990 bool dbx);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +0900991bool efi_signature_verify(struct efi_image_regions *regs,
992 struct pkcs7_message *msg,
993 struct efi_signature_store *db,
994 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +0900995static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
996 struct pkcs7_message *msg,
997 struct efi_signature_store *db)
998{
999 return efi_signature_verify(regs, msg, db, NULL);
1000}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +09001001bool efi_signature_check_signers(struct pkcs7_message *msg,
1002 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001003
1004efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1005 const void *start, const void *end,
1006 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +09001007
1008void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganub4f20a52020-12-30 19:27:08 +05301009struct efi_signature_store *efi_build_signature_store(void *sig_list,
1010 efi_uintn_t size);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +09001011struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +09001012
1013bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09001014
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301015bool efi_capsule_auth_enabled(void);
1016
Masahisa Kojima163a0d72021-05-26 12:09:58 +09001017void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1018
AKASHI Takahiro4540dab2020-04-14 11:51:44 +09001019bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1020 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001021
Sughosh Ganu201b8062020-12-30 19:27:07 +05301022struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1023 size_t buflen,
1024 u8 **tmpbuf);
1025
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +02001026/* runtime implementation of memcpy() */
1027void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1028
Paul Barker39434a92022-10-05 13:18:35 +01001029/* commonly used helper functions */
Ilias Apalodimasfe179d72020-12-31 12:26:46 +02001030u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1031 unsigned int index);
Paul Barker39434a92022-10-05 13:18:35 +01001032efi_string_t efi_convert_string(const char *str);
AKASHI Takahiro077153e2020-10-29 13:47:46 +09001033
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001034extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +09001035extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001036
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +09001037/* Capsule update */
1038efi_status_t EFIAPI efi_update_capsule(
1039 struct efi_capsule_header **capsule_header_array,
1040 efi_uintn_t capsule_count,
1041 u64 scatter_gather_list);
1042efi_status_t EFIAPI efi_query_capsule_caps(
1043 struct efi_capsule_header **capsule_header_array,
1044 efi_uintn_t capsule_count,
1045 u64 *maximum_capsule_size,
1046 u32 *reset_type);
1047
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301048efi_status_t efi_capsule_authenticate(const void *capsule,
1049 efi_uintn_t capsule_size,
1050 void **image, efi_uintn_t *image_size);
1051
Simon Glass156ccbc2022-01-23 12:55:12 -07001052#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +09001053
Jose Marinho64a8aae2021-03-02 17:26:38 +00001054/**
Sughosh Ganu741ef862022-04-15 11:29:34 +05301055 * struct efi_fw_image - Information on firmware images updatable through
1056 * capsule update
1057 *
1058 * This structure gives information about the firmware images on the platform
1059 * which can be updated through the capsule update mechanism
1060 *
1061 * @image_type_id: Image GUID. Same value is to be used in the capsule
1062 * @fw_name: Name of the firmware image
1063 * @image_index: Image Index, same as value passed to SetImage FMP
1064 * function
1065 */
1066struct efi_fw_image {
1067 efi_guid_t image_type_id;
1068 u16 *fw_name;
1069 u8 image_index;
1070};
1071
1072/**
1073 * struct efi_capsule_update_info - Information needed for capsule updates
1074 *
1075 * This structure provides information needed for performing firmware
1076 * updates. The structure needs to be initialised per platform, for all
1077 * platforms which enable capsule updates
1078 *
1079 * @dfu_string: String used to populate dfu_alt_info
1080 * @images: Pointer to an array of updatable images
1081 */
1082struct efi_capsule_update_info {
1083 const char *dfu_string;
1084 struct efi_fw_image *images;
1085};
1086
1087extern struct efi_capsule_update_info update_info;
1088extern u8 num_image_type_guids;
1089
1090/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001091 * Install the ESRT system table.
1092 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001093 * Return: status code
Jose Marinho64a8aae2021-03-02 17:26:38 +00001094 */
1095efi_status_t efi_esrt_register(void);
1096
1097/**
Jose Marinho6b92c172021-12-23 14:51:07 +00001098 * efi_ecpt_register() - Install the ECPT system table.
1099 *
1100 * Return: status code
1101 */
1102efi_status_t efi_ecpt_register(void);
1103
1104/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001105 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1106 * present in the system.
1107 * If an ESRT already exists, the old ESRT is replaced in the system table.
1108 * The memory of the old ESRT is deallocated.
1109 *
1110 * Return:
1111 * - EFI_SUCCESS if the ESRT is correctly created
1112 * - error code otherwise.
1113 */
1114efi_status_t efi_esrt_populate(void);
Ilias Apalodimas6e0184b2021-06-22 17:38:53 +03001115efi_status_t efi_load_capsule_drivers(void);
Ruchika Gupta34287ef2021-11-29 13:09:44 +05301116
1117efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojima87d79142022-09-12 17:33:50 +09001118
1119efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1120 const efi_guid_t *protocol, void *search_key,
1121 efi_uintn_t *no_handles, efi_handle_t **buffer);
1122
1123efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1124 struct efi_file_handle **root);
1125efi_status_t efi_file_open_int(struct efi_file_handle *this,
1126 struct efi_file_handle **new_handle,
1127 u16 *file_name, u64 open_mode,
1128 u64 attributes);
1129efi_status_t efi_file_close_int(struct efi_file_handle *file);
1130efi_status_t efi_file_read_int(struct efi_file_handle *this,
1131 efi_uintn_t *buffer_size, void *buffer);
1132efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1133
1134typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1135efi_status_t efi_console_get_u16_string
1136 (struct efi_simple_text_input_protocol *cin,
1137 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1138 int row, int col);
1139
1140efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1141
Heinrich Schuchardta9f20ef2023-02-10 09:01:13 +01001142/**
1143 * efi_add_known_memory() - add memory banks to EFI memory map
1144 *
1145 * This weak function may be overridden for specific architectures.
1146 */
1147void efi_add_known_memory(void);
1148
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02001149#endif /* _EFI_LOADER_H */