blob: 8fd09aad2d0fe766b17a2b15c60a12906bbc59c1 [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Graf4e0c1c12016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf4e0c1c12016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Simon Glass655306c2020-05-10 11:39:58 -060011#include <blk.h>
Simon Glass37972f42025-05-24 11:28:21 -060012#include <efi_device_path.h>
Heinrich Schuchardtda620cf2022-10-06 07:29:41 +020013#include <event.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010014#include <efi_api.h>
AKASHI Takahiro2c0f9f72020-04-21 09:38:38 +090015#include <image.h>
Yao Zi11c9cee2025-03-02 15:21:20 +010016#include <setjmp.h>
Simon Glass97f9bd42021-07-02 12:36:16 -060017#include <linux/list.h>
Adriano Cordova0d1f5092024-12-04 00:05:24 -030018#include <linux/sizes.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010019
Simon Glass655306c2020-05-10 11:39:58 -060020struct blk_desc;
Simon Glassfce57772025-01-23 15:07:23 -070021struct bootflow;
Simon Glass655306c2020-05-10 11:39:58 -060022
Stephen Warrend0de8062018-08-30 15:43:43 -060023#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010024
Simon Glass97f9bd42021-07-02 12:36:16 -060025/**
26 * __efi_runtime_data - declares a non-const variable for EFI runtime section
27 *
28 * This macro indicates that a variable is non-const and should go into the
29 * EFI runtime section, and thus still be available when the OS is running.
30 *
31 * Only use on variables not declared const.
32 *
33 * Example:
34 *
35 * ::
36 *
37 * static __efi_runtime_data my_computed_table[256];
38 */
39#define __efi_runtime_data __section(".data.efi_runtime")
40
41/**
42 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
43 *
44 * This macro indicates that a variable is read-only (const) and should go into
45 * the EFI runtime section, and thus still be available when the OS is running.
46 *
47 * Only use on variables also declared const.
48 *
49 * Example:
50 *
51 * ::
52 *
53 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
54 */
55#define __efi_runtime_rodata __section(".rodata.efi_runtime")
56
57/**
58 * __efi_runtime - declares a function for EFI runtime section
59 *
60 * This macro indicates that a function should go into the EFI runtime section,
61 * and thus still be available when the OS is running.
62 *
63 * Example:
64 *
65 * ::
66 *
67 * static __efi_runtime compute_my_table(void);
68 */
69#define __efi_runtime __section(".text.efi_runtime")
70
71/*
72 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
73 * to make it available at runtime
74 */
75efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
76
77/*
78 * Special case handler for error/abort that just tries to dtrt to get
79 * back to u-boot world
80 */
81void efi_restore_gd(void);
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +090082
Simon Glass97f9bd42021-07-02 12:36:16 -060083/* Called by networking code to memorize the dhcp ack package */
84void efi_net_set_dhcp_ack(void *pkt, int len);
85/* Print information about all loaded images */
86void efi_print_image_infos(void *pc);
87
88/* Hook at initialization */
89efi_status_t efi_launch_capsules(void);
90
91#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
92
93/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
94#define __efi_runtime_data
95#define __efi_runtime_rodata
96#define __efi_runtime
97static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
98{
99 return EFI_SUCCESS;
100}
101
102/* No loader configured, stub out EFI_ENTRY */
103static inline void efi_restore_gd(void) { }
Simon Glass97f9bd42021-07-02 12:36:16 -0600104static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
105static inline void efi_print_image_infos(void *pc) { }
106static inline efi_status_t efi_launch_capsules(void)
107{
108 return EFI_SUCCESS;
109}
110
111#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100112
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900113#if CONFIG_IS_ENABLED(EFI_BINARY_EXEC)
114/* Call this to unset the current device name */
115void efi_clear_bootdev(void);
116/* Call this to set the current device name */
117void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
118 void *buffer, size_t buffer_size);
119#else
120static inline void efi_clear_bootdev(void) { }
121
122static inline void efi_set_bootdev(const char *dev, const char *devnr,
123 const char *path, void *buffer,
124 size_t buffer_size) { }
125#endif
126
Adriano Cordova3c951362024-12-04 00:05:21 -0300127#if CONFIG_IS_ENABLED(NETDEVICES) && CONFIG_IS_ENABLED(EFI_LOADER)
Adriano Cordova93cba0f2024-12-04 00:05:23 -0300128/* Call this to update the current device path of the efi net device */
Adriano Cordova54674692025-03-03 11:13:15 -0300129efi_status_t efi_net_new_dp(const char *dev, const char *server, struct udevice *udev);
Adriano Cordova93cba0f2024-12-04 00:05:23 -0300130/* Call this to get the current device path of the efi net device */
Adriano Cordova54674692025-03-03 11:13:15 -0300131void efi_net_dp_from_dev(struct efi_device_path **dp, struct udevice *udev, bool cache_only);
Adriano Cordova3c951362024-12-04 00:05:21 -0300132void efi_net_get_addr(struct efi_ipv4_address *ip,
133 struct efi_ipv4_address *mask,
Adriano Cordova54674692025-03-03 11:13:15 -0300134 struct efi_ipv4_address *gw,
135 struct udevice *dev);
Adriano Cordova3c951362024-12-04 00:05:21 -0300136void efi_net_set_addr(struct efi_ipv4_address *ip,
137 struct efi_ipv4_address *mask,
Adriano Cordova54674692025-03-03 11:13:15 -0300138 struct efi_ipv4_address *gw,
139 struct udevice *dev);
Adriano Cordova28d67772025-03-03 11:13:17 -0300140#if IS_ENABLED(CONFIG_EFI_HTTP_PROTOCOL)
Adriano Cordova0d1f5092024-12-04 00:05:24 -0300141efi_status_t efi_net_do_request(u8 *url, enum efi_http_method method, void **buffer,
Adriano Cordova28d67772025-03-03 11:13:17 -0300142 u32 *status_code, ulong *file_size, char *headers_buffer,
143 struct efi_service_binding_protocol *parent);
144#endif
Adriano Cordova0d1f5092024-12-04 00:05:24 -0300145#define MAX_HTTP_HEADERS_SIZE SZ_64K
146#define MAX_HTTP_HEADERS 100
147#define MAX_HTTP_HEADER_NAME 128
148#define MAX_HTTP_HEADER_VALUE 512
149struct http_header {
150 uchar name[MAX_HTTP_HEADER_NAME];
151 uchar value[MAX_HTTP_HEADER_VALUE];
152};
153
154void efi_net_parse_headers(ulong *num_headers, struct http_header *headers);
Adriano Cordova3c951362024-12-04 00:05:21 -0300155#else
Adriano Cordova54674692025-03-03 11:13:15 -0300156static inline void efi_net_dp_from_dev(struct efi_device_path **dp,
157 struct udevice *udev, bool cache_only) { }
Adriano Cordova3c951362024-12-04 00:05:21 -0300158static inline void efi_net_get_addr(struct efi_ipv4_address *ip,
159 struct efi_ipv4_address *mask,
Adriano Cordova54674692025-03-03 11:13:15 -0300160 struct efi_ipv4_address *gw,
161 struct udevice *dev) { }
Adriano Cordova3c951362024-12-04 00:05:21 -0300162static inline void efi_net_set_addr(struct efi_ipv4_address *ip,
163 struct efi_ipv4_address *mask,
Adriano Cordova54674692025-03-03 11:13:15 -0300164 struct efi_ipv4_address *gw,
165 struct udevice *dev) { }
Adriano Cordova3c951362024-12-04 00:05:21 -0300166#endif
167
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +0200168/* Maximum number of configuration tables */
169#define EFI_MAX_CONFIGURATION_TABLES 16
170
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200171/* GUID used by the root node */
172#define U_BOOT_GUID \
173 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
174 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
Tobias Waldekranz32152682023-02-16 16:33:55 +0100175/* GUID used as root for blkmap devices */
176#define U_BOOT_BLKMAP_DEV_GUID \
177 EFI_GUID(0x4cad859d, 0xd644, 0x42ff, \
178 0x87, 0x0b, 0xc0, 0x2e, 0xac, 0x05, 0x58, 0x63)
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900179/* GUID used as host device on sandbox */
180#define U_BOOT_HOST_DEV_GUID \
181 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
182 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardtc770aaa2020-05-20 22:39:35 +0200183/* GUID used as root for virtio devices */
184#define U_BOOT_VIRTIO_DEV_GUID \
185 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
186 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200187
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900188/* GUID for the auto generated boot menu entry */
189#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
Masahisa Kojimaa28cce52023-10-12 14:31:59 +0900190 EFI_GUID(0x8108ac4e, 0x9f11, 0x4d59, \
191 0x85, 0x0e, 0xe2, 0x1a, 0x52, 0x2c, 0x59, 0xb2)
Ilias Apalodimas465cb7e2024-04-18 15:54:51 +0300192#define U_BOOT_EFI_RT_VAR_FILE_GUID \
193 EFI_GUID(0xb2ac5fc9, 0x92b7, 0x4acd, \
194 0xae, 0xac, 0x11, 0xe8, 0x18, 0xc3, 0x13, 0x0c)
195
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100196/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100197#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100198
AKASHI Takahiro0b275752019-04-16 13:24:20 +0900199/* Root node */
200extern efi_handle_t efi_root;
201
Heinrich Schuchardtde9bdc62020-03-19 18:21:58 +0000202/* Set to EFI_SUCCESS when initialized */
203extern efi_status_t efi_obj_list_initialized;
204
Heinrich Schuchardt628dbd72020-11-12 21:26:28 +0100205/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
206extern bool efi_st_keep_devices;
207
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100208/* EFI system partition */
209extern struct efi_system_partition {
Simon Glassfada3f92022-09-17 09:00:09 -0600210 enum uclass_id uclass_id;
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100211 int devnum;
212 u8 part;
213} efi_system_partition;
214
Rob Clark86789d52017-07-27 08:04:18 -0400215int __efi_entry_check(void);
216int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200217const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -0400218const char *__efi_nesting_inc(void);
219const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -0400220
Rob Clark63ea77a2017-07-27 08:04:17 -0400221/*
222 * Enter the u-boot world from UEFI:
223 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100224#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -0400225 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400226 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
227 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +0100228 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +0100229
Rob Clark63ea77a2017-07-27 08:04:17 -0400230/*
231 * Exit the u-boot world back to UEFI:
232 */
Rob Clark84a19a02017-07-24 10:31:52 -0400233#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200234 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -0400235 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200236 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -0400237 assert(__efi_exit_check()); \
238 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -0400239 })
Alexander Grafc15d9212016-03-04 01:09:59 +0100240
Rob Clark63ea77a2017-07-27 08:04:17 -0400241/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200242 * Call non-void UEFI function from u-boot and retrieve return value:
243 */
244#define EFI_CALL(exp) ({ \
245 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
246 assert(__efi_exit_check()); \
247 typeof(exp) _r = exp; \
248 assert(__efi_entry_check()); \
249 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
250 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
251 _r; \
252})
253
Heinrich Schuchardt0ad71bc2025-01-17 01:09:51 +0100254/**
255 * define EFI_RETURN() - return from EFI_CALL in efi_start_image()
256 *
257 * @ret: status code
258 */
259#define EFI_RETURN(ret) ({ \
260 typeof(ret) _r = ret; \
261 assert(__efi_entry_check()); \
262 debug("%sEFI: %lu returned by started image", __efi_nesting_dec(), \
263 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK)); \
264})
265
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200266/*
267 * Call void UEFI function from u-boot:
Rob Clark63ea77a2017-07-27 08:04:17 -0400268 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200269#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400270 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400271 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400272 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400273 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400274 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400275 } while(0)
276
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200277/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100278 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200279 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100280#define EFI_PRINT(format, ...) ({ \
281 debug("%sEFI: " format, __efi_nesting(), \
282 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200283 })
284
Alexander Graf59254d62018-04-23 07:59:47 +0200285#ifdef CONFIG_SYS_CACHELINE_SIZE
286#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
287#else
288/* Just use the greatest cache flush alignment requirement I'm aware of */
289#define EFI_CACHELINE_SIZE 128
290#endif
291
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900292/* max bootmenu title size for volume selection */
293#define BOOTMENU_DEVICE_NAME_MAX 16
294
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200295/* Key identifying current memory map */
296extern efi_uintn_t efi_memory_map_key;
297
Alexander Graf0bd425a2016-03-04 01:10:01 +0100298extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100299extern struct efi_system_table systab;
300
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200301extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200302extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200303extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200304extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100305/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
306extern const struct efi_device_path_utilities_protocol
307 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200308/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200309extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200310 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900311extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
312extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900313extern const struct efi_hii_database_protocol efi_hii_database;
314extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100315
Rob Clark85dd7212017-09-13 18:05:30 -0400316uint16_t *efi_dp_str(struct efi_device_path *dp);
317
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900318/* GUID for the auto generated boot menu entry */
319extern const efi_guid_t efi_guid_bootmenu_auto_generated;
320
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200321/* GUID of the U-Boot root node */
322extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900323#ifdef CONFIG_SANDBOX
324/* GUID of U-Boot host device on sandbox */
325extern const efi_guid_t efi_guid_host_dev;
326#endif
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100327/* GUID of the EFI_BLOCK_IO_PROTOCOL */
328extern const efi_guid_t efi_block_io_guid;
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300329/* GUID of the EFI_SIMPLE_NETWORK_PROTOCOL */
330extern const efi_guid_t efi_net_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400331extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100332extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100333extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardte840b9c2022-03-19 07:04:03 +0100334/* GUID of the EFI system partition */
335extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100336/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
337extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +0100338/* event group ExitBootServices() invoked */
339extern const efi_guid_t efi_guid_event_group_exit_boot_services;
340/* event group SetVirtualAddressMap() invoked */
341extern const efi_guid_t efi_guid_event_group_virtual_address_change;
342/* event group memory map changed */
343extern const efi_guid_t efi_guid_event_group_memory_map_change;
344/* event group boot manager about to boot */
345extern const efi_guid_t efi_guid_event_group_ready_to_boot;
346/* event group ResetSystem() invoked (before ExitBootServices) */
347extern const efi_guid_t efi_guid_event_group_reset_system;
Masahisa Kojima1923f362023-11-10 13:25:39 +0900348/* event group return to efibootmgr */
349extern const efi_guid_t efi_guid_event_group_return_to_efibootmgr;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +0100350/* GUID of the device tree table */
351extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100352extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900353extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200354extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-09-13 18:05:34 -0400355extern const efi_guid_t efi_simple_file_system_protocol_guid;
356extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt37fb4b92018-04-04 15:42:11 +0200357/* GUID for file system information */
358extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100359extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200360/* GUID of the deprecated Unicode collation protocol */
361extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt485956d2020-12-04 03:33:41 +0100362/* GUIDs of the Load File and Load File2 protocol */
363extern const efi_guid_t efi_guid_load_file_protocol;
364extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200365/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200366extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900367extern const efi_guid_t efi_guid_hii_config_routing_protocol;
368extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900369extern const efi_guid_t efi_guid_hii_database_protocol;
370extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900371/* GUIDs for authentication */
372extern const efi_guid_t efi_guid_image_security_database;
373extern const efi_guid_t efi_guid_sha256;
374extern const efi_guid_t efi_guid_cert_x509;
375extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300376extern const efi_guid_t efi_guid_cert_x509_sha384;
377extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900378extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100379
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530380/* GUID of RNG protocol */
381extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900382/* GUID of capsule update result */
383extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro0d963782020-11-30 18:12:11 +0900384/* GUID of firmware management protocol */
385extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000386/* GUID for the ESRT */
387extern const efi_guid_t efi_esrt_guid;
Masahisa Kojimacd1fe7d2021-10-26 17:27:24 +0900388/* GUID of the SMBIOS table */
389extern const efi_guid_t smbios_guid;
Masahisa Kojimad8733f32024-01-26 09:53:42 +0900390extern const efi_guid_t smbios3_guid;
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900391/*GUID of console */
392extern const efi_guid_t efi_guid_text_input_protocol;
Masahisa Kojimaa93282c2023-01-24 15:56:15 +0900393extern const efi_guid_t efi_guid_text_output_protocol;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530394
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200395/**
396 * struct efi_open_protocol_info_item - open protocol info item
397 *
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100398 * When a protocol is opened a open protocol info entry is created.
399 * These are maintained in a list.
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200400 *
401 * @link: link to the list of open protocol info entries of a protocol
402 * @info: information about the opening of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100403 */
404struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100405 struct list_head link;
406 struct efi_open_protocol_info_entry info;
407};
408
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200409/**
410 * struct efi_handler - single protocol interface of a handle
411 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100412 * When the UEFI payload wants to open a protocol on an object to get its
413 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100414 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200415 *
416 * @link: link to the list of protocols of a handle
417 * @guid: GUID of the protocol
418 * @protocol_interface: protocol interface
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100419 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100420 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100421struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100422 struct list_head link;
Heinrich Schuchardt2a22db92022-03-09 19:56:23 +0100423 const efi_guid_t guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200424 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100425 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100426};
427
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200428/**
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200429 * enum efi_object_type - type of EFI object
430 *
431 * In UnloadImage we must be able to identify if the handle relates to a
432 * started image.
433 */
434enum efi_object_type {
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100435 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200436 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100437 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200438 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100439 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200440 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100441 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200442 EFI_OBJECT_TYPE_STARTED_IMAGE,
443};
444
445/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200446 * struct efi_object - dereferenced EFI handle
447 *
448 * @link: pointers to put the handle into a linked list
449 * @protocols: linked list with the protocol interfaces installed on this
450 * handle
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100451 * @type: image type if the handle relates to an image
Masahisa Kojimac9611082022-07-22 11:39:10 +0900452 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200453 *
454 * UEFI offers a flexible and expandable object model. The objects in the UEFI
455 * API are devices, drivers, and loaded images. struct efi_object is our storage
456 * structure for these objects.
457 *
458 * When including this structure into a larger structure always put it first so
459 * that when deleting a handle the whole encompassing structure can be freed.
Alexander Grafc15d9212016-03-04 01:09:59 +0100460 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200461 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
462 * has been created for such pointers.
Alexander Grafc15d9212016-03-04 01:09:59 +0100463 */
464struct efi_object {
465 /* Every UEFI object is part of a global object list */
466 struct list_head link;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100467 /* The list of protocols */
468 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200469 enum efi_object_type type;
Masahisa Kojimac9611082022-07-22 11:39:10 +0900470 struct udevice *dev;
Alexander Grafc15d9212016-03-04 01:09:59 +0100471};
472
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900473enum efi_image_auth_status {
474 EFI_IMAGE_AUTH_FAILED = 0,
475 EFI_IMAGE_AUTH_PASSED,
476};
477
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200478/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200479 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200480 *
481 * @header: EFI object header
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200482 * @exit_status: exit status passed to Exit()
483 * @exit_data_size: exit data size passed to Exit()
484 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100485 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200486 * @entry: entry address of the relocated image
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100487 * @image_type: indicates if the image is an applicition or a driver
488 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200489 */
490struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200491 struct efi_object header;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100492 efi_status_t *exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200493 efi_uintn_t *exit_data_size;
494 u16 **exit_data;
Yao Zi11c9cee2025-03-02 15:21:20 +0100495 jmp_buf *exit_jmp;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200496 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
497 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200498 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900499 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200500};
501
502/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200503 * struct efi_event
504 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100505 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200506 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200507 * @type: Type of event, see efi_create_event
508 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100509 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200510 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100511 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100512 * @trigger_time: Period of the timer
513 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200514 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100515 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200516 */
517struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100518 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200519 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200520 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100521 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200522 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
523 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100524 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200525 u64 trigger_next;
526 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200527 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200528 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200529};
530
Alexander Grafc15d9212016-03-04 01:09:59 +0100531/* This list contains all UEFI objects we know of */
532extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100533/* List of all events */
534extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100535
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200536/**
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200537 * struct efi_protocol_notification - handle for notified protocol
538 *
539 * When a protocol interface is installed for which an event was registered with
540 * the RegisterProtocolNotify() service this structure is used to hold the
541 * handle on which the protocol interface was installed.
542 *
543 * @link: link to list of all handles notified for this event
544 * @handle: handle on which the notified protocol interface was installed
545 */
546struct efi_protocol_notification {
547 struct list_head link;
548 efi_handle_t handle;
549};
550
551/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100552 * struct efi_register_notify_event - event registered by
553 * RegisterProtocolNotify()
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200554 *
555 * The address of this structure serves as registration value.
556 *
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200557 * @link: link to list of all registered events
558 * @event: registered event. The same event may registered for multiple
559 * GUIDs.
560 * @protocol: protocol for which the event is registered
561 * @handles: linked list of all handles on which the notified protocol was
562 * installed
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200563 */
564struct efi_register_notify_event {
565 struct list_head link;
566 struct efi_event *event;
567 efi_guid_t protocol;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200568 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200569};
570
AKASHI Takahiroa36dc252022-04-19 10:05:11 +0900571/* called at pre-initialization */
572int efi_init_early(void);
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100573/* Initialize efi execution environment */
574efi_status_t efi_init_obj_list(void);
Raymond Mao70a76c52023-06-19 14:22:58 -0700575/* Append new boot option in BootOrder variable */
576efi_status_t efi_bootmgr_append_bootorder(u16 index);
577/* Get unused "Boot####" index */
578efi_status_t efi_bootmgr_get_unused_bootoption(u16 *buf,
579 efi_uintn_t buf_size, u32 *index);
580/* Generate the media device boot option */
581efi_status_t efi_bootmgr_update_media_device_boot_option(void);
582/* Delete selected boot option */
583efi_status_t efi_bootmgr_delete_boot_option(u16 boot_index);
AKASHI Takahiro7b061922023-11-21 10:29:44 +0900584/* Invoke EFI boot manager */
585efi_status_t efi_bootmgr_run(void *fdt);
Raymond Mao70a76c52023-06-19 14:22:58 -0700586/* search the boot option index in BootOrder */
587bool efi_search_bootorder(u16 *bootorder, efi_uintn_t num, u32 target, u32 *index);
Simon Glassab312512025-05-10 14:54:38 +0200588
589/**
590 * efi_setup_console_size() - update the mode table.
591 *
592 * By default the only mode available is 80x25. If the console has at least 50
593 * lines, enable mode 80x50. If we can query the console size and it is neither
594 * 80x25 nor 80x50, set it as an additional mode.
595 */
Heinrich Schuchardt761908e2022-06-14 08:02:03 +0200596void efi_setup_console_size(void);
Simon Glassab312512025-05-10 14:54:38 +0200597
598/**
599 * efi_console_set_ansi() - Set whether ANSI escape-characters should be emitted
600 *
601 * These characters mess up tests which use ut_assert_nextline(). Call this
602 * function to tell efi_loader not to emit these characters when starting up the
603 * terminal
604 *
605 * @allow_ansi: Allow emitting ANSI escape-characters
606 */
607void efi_console_set_ansi(bool allow_ansi);
608
AKASHI Takahiro7b061922023-11-21 10:29:44 +0900609/* Set up load options from environment variable */
610efi_status_t efi_env_set_load_options(efi_handle_t handle, const char *env_var,
611 u16 **load_options);
Heinrich Schuchardt0a4a2f32024-01-26 08:54:30 +0100612/* Get EFI configuration table */
613void *efi_get_configuration_table(const efi_guid_t *guid);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100614/* Install device tree */
615efi_status_t efi_install_fdt(void *fdt);
Adriano Cordova395f7f22025-04-29 09:27:55 -0400616/* Install initrd */
617efi_status_t efi_install_initrd(void *initrd, size_t initd_sz);
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900618/* Execute loaded UEFI image */
619efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options);
AKASHI Takahiro7b061922023-11-21 10:29:44 +0900620/* Run loaded UEFI image with given fdt */
Adriano Cordovacea09ba2025-03-19 11:45:00 -0300621efi_status_t efi_binary_run(void *image, size_t size, void *fdt, void *initrd, size_t initrd_sz);
Simon Glassfce57772025-01-23 15:07:23 -0700622
623/**
624 * efi_bootflow_run() - Run a bootflow containing an EFI application
625 *
626 * @bootflow: Bootflow to run
627 * Return: Status code, something went wrong
628 */
629efi_status_t efi_bootflow_run(struct bootflow *bootflow);
630
Heinrich Schuchardtcf3b1182019-06-20 13:52:16 +0200631/* Initialize variable services */
632efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200633/* Notify ExitBootServices() is called */
634void efi_variables_boot_exit_notify(void);
Masahisa Kojima1ac19bb2021-08-13 16:12:41 +0900635efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900636/* Measure efi application invocation */
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900637efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900638/* Measure efi application exit */
639efi_status_t efi_tcg2_measure_efi_app_exit(void);
Etienne Carriereb9064352023-02-16 17:29:48 +0100640/* Measure DTB */
641efi_status_t efi_tcg2_measure_dtb(void *dtb);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200642/* Called by bootefi to initialize root node */
643efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200644/* Called by bootefi to initialize runtime */
645efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200646/* efi_runtime_detach() - detach unimplemented runtime functions */
647void efi_runtime_detach(void);
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100648/* efi_convert_pointer() - convert pointer to virtual address */
649efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
650 void **address);
Heinrich Schuchardt2c1e2242020-12-13 10:30:24 +0100651/* Carve out DT reserved memory ranges */
652void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimase4e56602022-01-03 14:07:37 +0200653/* Purge unused kaslr-seed */
Heinrich Schuchardt069079c2024-09-17 10:49:29 +0200654void efi_try_purge_rng_seed(void *fdt);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200655/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200656efi_status_t efi_console_register(void);
Heinrich Schuchardta02228f2022-08-31 16:37:35 +0200657/* Called by efi_init_obj_list() to proble all block devices */
658efi_status_t efi_disks_register(void);
Heinrich Schuchardtc63f68f2020-09-25 12:50:19 +0200659/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
660efi_status_t efi_rng_register(void);
Ilias Apalodimas590fef62020-11-11 11:18:11 +0200661/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
662efi_status_t efi_tcg2_register(void);
Sunil V L279d1c82022-01-28 20:48:44 +0530663/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
664efi_status_t efi_riscv_register(void);
Masahisa Kojima0fd43792021-12-07 14:15:31 +0900665/* Called by efi_init_obj_list() to do initial measurement */
666efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900667/* measure the pe-coff image, extend PCR and add Event Log */
668efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
669 struct efi_loaded_image_obj *handle,
670 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100671/* Create handles and protocols for the partitions of a block device */
672int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
Simon Glassfada3f92022-09-17 09:00:09 -0600673 const char *uclass_idname, int diskid,
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100674 const char *pdevname);
Alexander Grafd65783d2016-03-15 18:38:21 +0100675/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100676efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200677/* Called by bootefi to make the network interface available */
Adriano Cordova54674692025-03-03 11:13:15 -0300678efi_status_t efi_net_register(struct udevice *dev);
679efi_status_t efi_net_do_start(struct udevice *dev);
Adriano Cordova9debc902024-12-04 00:05:25 -0300680/* Called by efi_net_register to make the ip4 config2 protocol available */
681efi_status_t efi_ipconfig_register(const efi_handle_t handle,
682 struct efi_ip4_config2_protocol *ip4config);
Adriano Cordovae9b19eb2024-12-04 00:05:26 -0300683/* Called by efi_net_register to make the http protocol available */
684efi_status_t efi_http_register(const efi_handle_t handle,
685 struct efi_service_binding_protocol *http_service_binding);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200686/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100687efi_status_t efi_watchdog_register(void);
Adriano Cordova02d049d2025-03-19 11:44:59 -0300688efi_status_t efi_initrd_register(struct efi_device_path *dp_initrd);
Ilias Apalodimas7e052792022-10-16 11:36:32 +0300689efi_status_t efi_initrd_deregister(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200690/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600691/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700692 * efi_acpi_register() - write out ACPI tables
693 *
694 * Called by bootefi to make ACPI tables available
695 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100696 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng2cfbdae2018-06-27 20:38:03 -0700697 */
698efi_status_t efi_acpi_register(void);
699/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600700 * efi_smbios_register() - write out SMBIOS tables
701 *
702 * Called by bootefi to make SMBIOS tables available
703 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100704 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass2e2858f2018-05-16 09:42:19 -0600705 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100706efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200707
Rob Clark53142032017-09-13 18:05:34 -0400708struct efi_simple_file_system_protocol *
709efi_fs_from_path(struct efi_device_path *fp);
710
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200711/* Called by efi_set_watchdog_timer to reset the timer */
712efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200713
Alexander Grafc15d9212016-03-04 01:09:59 +0100714/* Called from places to check whether a timer expired */
715void efi_timer_check(void);
Heinrich Schuchardtad6e0f72021-01-12 12:40:32 +0100716/* Check if a buffer contains a PE-COFF image */
717efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafc15d9212016-03-04 01:09:59 +0100718/* PE loader implementation */
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900719efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
720 void *efi, size_t efi_size,
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100721 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100722/* Called once to store the pristine gd pointer */
723void efi_save_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100724/* Call this to relocate the runtime section to an address space */
725void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silva433f15a2022-05-11 10:55:40 +0100726/* Call this to get image parameters */
727void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100728/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200729void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200730/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100731efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100732/* Delete handle */
Ilias Apalodimasb09ecf12023-07-24 13:17:36 +0300733efi_status_t efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100734/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100735struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahiro537a6932022-04-28 17:09:38 +0900736/* Locate device_path handle */
737efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
738 struct efi_device_path **device_path,
739 efi_handle_t *device);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900740/* Load image */
741efi_status_t EFIAPI efi_load_image(bool boot_policy,
742 efi_handle_t parent_image,
743 struct efi_device_path *file_path,
744 void *source_buffer,
745 efi_uintn_t source_size,
746 efi_handle_t *image_handle);
Heinrich Schuchardte5aa9fa2024-04-26 16:13:20 +0200747/* Load image from path */
748efi_status_t efi_load_image_from_path(bool boot_policy,
749 struct efi_device_path *file_path,
750 void **buffer, efi_uintn_t *size);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100751/* Start image */
752efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
753 efi_uintn_t *exit_data_size,
754 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900755/* Unload image */
756efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200757/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100758efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200759 const efi_guid_t *protocol_guid,
760 struct efi_handler **handler);
761/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100762efi_status_t efi_add_protocol(const efi_handle_t handle,
763 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200764 void *protocol_interface);
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300765/* Uninstall new protocol on a handle */
766efi_status_t efi_uninstall_protocol
767 (efi_handle_t handle, const efi_guid_t *protocol,
768 void *protocol_interface, bool preserve);
Adriano Cordova3d4b09a2024-12-06 14:18:34 -0300769/* Reinstall a protocol on a handle */
770efi_status_t EFIAPI efi_reinstall_protocol_interface(
771 efi_handle_t handle,
772 const efi_guid_t *protocol,
773 void *old_interface, void *new_interface);
Heinrich Schuchardt9c89d142020-01-10 12:33:59 +0100774/* Open protocol */
775efi_status_t efi_protocol_open(struct efi_handler *handler,
776 void **protocol_interface, void *agent_handle,
777 void *controller_handle, uint32_t attributes);
778
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200779/* Install multiple protocol interfaces */
Ilias Apalodimas8ac0ebe2022-10-06 16:08:46 +0300780efi_status_t EFIAPI
781efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
782efi_status_t EFIAPI
783efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300784/* Connect and disconnect controller */
785efi_status_t EFIAPI efi_connect_controller(efi_handle_t controller_handle,
786 efi_handle_t *driver_image_handle,
787 struct efi_device_path *remain_device_path,
788 bool recursive);
789efi_status_t EFIAPI efi_disconnect_controller(
790 efi_handle_t controller_handle,
791 efi_handle_t driver_image_handle,
792 efi_handle_t child_handle);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900793/* Get handles that support a given protocol */
794efi_status_t EFIAPI efi_locate_handle_buffer(
795 enum efi_locate_search_type search_type,
796 const efi_guid_t *protocol, void *search_key,
797 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardt5e394332022-10-07 15:18:15 +0200798/* Close a previously opened protocol interface */
799efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
800 efi_handle_t agent_handle,
801 efi_handle_t controller_handle);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900802/* Open a protocol interface */
803efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
804 const efi_guid_t *protocol,
805 void **protocol_interface);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200806/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100807efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200808 void (EFIAPI *notify_function) (
809 struct efi_event *event,
810 void *context),
Masahisa Kojima787774a2023-11-10 13:25:38 +0900811 void *notify_context, const efi_guid_t *group,
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100812 struct efi_event **event);
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300813/* Call this to close an event */
814efi_status_t EFIAPI efi_close_event(struct efi_event *event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200815/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200816efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200817 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200818/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200819void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100820
AKASHI Takahiroba647af2022-05-12 11:29:01 +0900821/* return true if the device is removable */
822bool efi_disk_is_removable(efi_handle_t handle);
823
Heinrich Schuchardtf9e8ada2023-07-30 14:03:53 +0200824/**
825 * efi_create_simple_file_system() - create simple file system protocol
826 *
827 * Create a simple file system protocol for a partition.
828 *
829 * @desc: block device descriptor
830 * @part: partition number
831 * @dp: device path
832 * @fsp: simple file system protocol
833 * Return: status code
834 */
835efi_status_t
836efi_create_simple_file_system(struct blk_desc *desc, int part,
837 struct efi_device_path *dp,
838 struct efi_simple_file_system_protocol **fsp);
Rob Clark53142032017-09-13 18:05:34 -0400839
840/* open file from device-path: */
841struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
842
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000843/* Registers a callback function for a notification event. */
844efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
845 struct efi_event *event,
846 void **registration);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200847efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
848
849/* get a device path from a Boot#### option */
Heinrich Schuchardtefd90d72024-04-26 16:13:08 +0200850struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t *guid);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200851
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300852/* get len, string (used in u-boot crypto from a guid */
853const char *guid_to_sha_str(const efi_guid_t *guid);
854int algo_to_len(const char *algo);
855
Masahisa Kojimac9611082022-07-22 11:39:10 +0900856int efi_link_dev(efi_handle_t handle, struct udevice *dev);
Heinrich Schuchardt34f34622022-10-03 09:47:51 +0200857int efi_unlink_dev(efi_handle_t handle);
Masahisa Kojima2f407f02022-12-02 13:59:35 +0900858bool efi_varname_is_load_option(u16 *var_name16, int *index);
Masahisa Kojima7ec3c6f2022-12-19 11:33:12 +0900859efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
860 efi_guid_t *guid);
Masahisa Kojimac9611082022-07-22 11:39:10 +0900861
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100862/**
863 * efi_size_in_pages() - convert size in bytes to size in pages
864 *
865 * This macro returns the number of EFI memory pages required to hold 'size'
866 * bytes.
867 *
868 * @size: size in bytes
869 * Return: size in pages
870 */
Heinrich Schuchardtaefb0c42021-01-17 07:52:09 +0100871#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Heinrich Schuchardt45640252023-03-19 09:20:22 +0100872/* Allocate boot service data pool memory */
873void *efi_alloc(size_t len);
Ilias Apalodimas6e01c232021-10-11 15:10:23 +0300874/* Allocate pages on the specified alignment */
875void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf8623f922016-03-04 01:10:04 +0100876/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200877efi_status_t efi_allocate_pages(enum efi_allocate_type type,
878 enum efi_memory_type memory_type,
879 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200880/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100881efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200882/* EFI memory allocator for small allocations */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200883efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
884 efi_uintn_t size, void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200885/* EFI pool memory free function. */
886efi_status_t efi_free_pool(void *buffer);
Heinrich Schuchardt13ce2d92023-01-05 18:26:01 +0100887/* Allocate and retrieve EFI memory map */
888efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
889 struct efi_mem_desc **memory_map);
Alexander Graf8623f922016-03-04 01:10:04 +0100890/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100891efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100892 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100893 efi_uintn_t *map_key,
894 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100895 uint32_t *descriptor_version);
896/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200897efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Sughosh Ganua3af5ba2024-10-15 21:07:07 +0530898
Ilias Apalodimas9e0db622025-03-17 14:03:58 +0530899/**
900 * efi_update_memory_map() - update the memory map by adding/removing pages
901 *
902 * @start: start address, must be a multiple of
903 * EFI_PAGE_SIZE
904 * @pages: number of pages to add
905 * @memory_type: type of memory added
906 * @overlap_conventional: region may only overlap free(conventional)
907 * memory
908 * @remove: remove memory map
909 * Return: status code
910 */
911efi_status_t efi_update_memory_map(u64 start, u64 pages, int memory_type,
912 bool overlap_conventional, bool remove);
913
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100914/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100915efi_status_t efi_driver_init(void);
Heinrich Schuchardtda620cf2022-10-06 07:29:41 +0200916/* Called when a block device is added */
917int efi_disk_probe(void *ctx, struct event *event);
918/* Called when a block device is removed */
919int efi_disk_remove(void *ctx, struct event *event);
Alexander Graf8623f922016-03-04 01:10:04 +0100920/* Called by board init to initialize the EFI memory map */
921int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200922/* Adds new or overrides configuration table entry to the system table */
923efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100924/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200925efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
926 struct efi_device_path *file_path,
927 struct efi_loaded_image_obj **handle_ptr,
928 struct efi_loaded_image **info_ptr);
Alexander Graf8623f922016-03-04 01:10:04 +0100929
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200930#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
931extern void *efi_bounce_buffer;
932#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
933#endif
934
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400935#define EFI_DP_TYPE(_dp, _type, _subtype) \
936 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
937 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
938
AKASHI Takahiro32401842019-06-05 13:21:38 +0900939/* Indicate supported runtime services */
940efi_status_t efi_init_runtime_supported(void);
941
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200942/* Update CRC32 in table header */
943void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
944
Alexander Graf77256092016-08-16 21:08:45 +0200945/* Boards may provide the functions below to implement RTS functionality */
946
Alexander Graf393dd912016-10-14 13:45:30 +0200947void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200948 enum efi_reset_type reset_type,
949 efi_status_t reset_status,
950 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100951
952/* Architecture specific initialization of the EFI subsystem */
953efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200954
Alexander Graf393dd912016-10-14 13:45:30 +0200955efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200956 struct efi_time *time,
957 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200958
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200959efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
960
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200961/*
962 * Entry point for the tests of the EFI API.
963 * It is called by 'bootefi selftest'
964 */
965efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
966 struct efi_system_table *systab);
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200967
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100968efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
969 const efi_guid_t *vendor, u32 *attributes,
970 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200971efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
972 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100973 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100974efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
975 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100976 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400977
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200978efi_status_t EFIAPI efi_query_variable_info(
979 u32 attributes, u64 *maximum_variable_storage_size,
980 u64 *remaining_variable_storage_size,
981 u64 *maximum_variable_size);
982
Heinrich Schuchardt1ad2f0d2021-09-09 07:12:14 +0200983void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200984
AKASHI Takahirobd237742018-11-05 18:06:41 +0900985/*
986 * See section 3.1.3 in the v2.7 UEFI spec for more details on
987 * the layout of EFI_LOAD_OPTION. In short it is:
988 *
989 * typedef struct _EFI_LOAD_OPTION {
990 * UINT32 Attributes;
991 * UINT16 FilePathListLength;
992 * // CHAR16 Description[]; <-- variable length, NULL terminated
993 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
994 * <-- FilePathListLength bytes
995 * // UINT8 OptionalData[];
996 * } EFI_LOAD_OPTION;
997 */
998struct efi_load_option {
999 u32 attributes;
1000 u16 file_path_length;
1001 u16 *label;
1002 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +02001003 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +09001004};
1005
Ilias Apalodimas483d28e2021-03-17 21:54:58 +02001006struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt9979cff2021-10-15 01:31:02 +02001007 const efi_guid_t *guid);
Ilias Apalodimas483d28e2021-03-17 21:54:58 +02001008struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
Ilias Apalodimas5dcefa72024-01-08 10:55:33 +02001009 const struct efi_device_path *dp2,
Heinrich Schuchardtf8de0092024-05-24 14:54:26 +02001010 size_t split_end_node);
Masahisa Kojima6460c3e2021-10-26 17:27:25 +09001011struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt7ca84f82020-05-31 22:46:09 +02001012efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
1013 efi_uintn_t *size);
AKASHI Takahirobd237742018-11-05 18:06:41 +09001014unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt25c6be52020-08-07 17:47:13 +02001015efi_status_t efi_set_load_options(efi_handle_t handle,
1016 efi_uintn_t load_options_size,
1017 void *load_options);
Heinrich Schuchardta7647a72020-08-07 17:49:39 +02001018efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clarkc84c1102017-09-13 18:05:38 -04001019
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001020/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001021 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001022 *
1023 * @max: Maximum number of regions
1024 * @num: Number of regions
1025 * @reg: array of regions
1026 */
1027struct efi_image_regions {
1028 int max;
1029 int num;
1030 struct image_region reg[];
1031};
1032
1033/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001034 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001035 *
1036 * This structure represents an internal form of signature in
1037 * signature database. A listed list may represent a signature list.
1038 *
1039 * @next: Pointer to next entry
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001040 * @owner: Signature owner
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001041 * @data: Pointer to signature data
1042 * @size: Size of signature data
1043 */
1044struct efi_sig_data {
1045 struct efi_sig_data *next;
1046 efi_guid_t owner;
1047 void *data;
1048 size_t size;
1049};
1050
1051/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001052 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001053 *
1054 * This structure represents an internal form of signature database.
1055 *
1056 * @next: Pointer to next entry
1057 * @sig_type: Signature type
1058 * @sig_data_list: Pointer to signature list
1059 */
1060struct efi_signature_store {
1061 struct efi_signature_store *next;
1062 efi_guid_t sig_type;
1063 struct efi_sig_data *sig_data_list;
1064};
1065
1066struct x509_certificate;
1067struct pkcs7_message;
1068
Masahisa Kojima767a9e62022-09-12 17:33:54 +09001069/**
1070 * struct eficonfig_media_boot_option - boot option for (removable) media device
1071 *
1072 * This structure is used to enumerate possible boot option
1073 *
1074 * @lo: Serialized load option data
1075 * @size: Size of serialized load option data
1076 * @exist: Flag to indicate the load option already exists
1077 * in Non-volatile load option
1078 */
1079struct eficonfig_media_boot_option {
1080 void *lo;
1081 efi_uintn_t size;
1082 bool exist;
1083};
1084
AKASHI Takahirof47b9b32022-07-05 14:48:12 +09001085bool efi_hash_regions(struct image_region *regs, int count,
1086 void **hash, const char *hash_algo, int *len);
AKASHI Takahirode924072020-07-08 14:01:57 +09001087bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas71eae982022-01-29 00:20:31 +02001088 struct efi_signature_store *db,
1089 bool dbx);
AKASHI Takahiro14afd062020-07-21 19:35:22 +09001090bool efi_signature_verify(struct efi_image_regions *regs,
1091 struct pkcs7_message *msg,
1092 struct efi_signature_store *db,
1093 struct efi_signature_store *dbx);
AKASHI Takahiro16411802020-08-14 14:39:23 +09001094static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
1095 struct pkcs7_message *msg,
1096 struct efi_signature_store *db)
1097{
1098 return efi_signature_verify(regs, msg, db, NULL);
1099}
AKASHI Takahiro4154b642020-07-08 14:01:56 +09001100bool efi_signature_check_signers(struct pkcs7_message *msg,
1101 struct efi_signature_store *dbx);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001102
1103efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1104 const void *start, const void *end,
1105 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +09001106
1107void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganufa0faa62020-12-30 19:27:08 +05301108struct efi_signature_store *efi_build_signature_store(void *sig_list,
1109 efi_uintn_t size);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +09001110struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +09001111
1112bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001113
Sughosh Ganu586bb982020-12-30 19:27:09 +05301114bool efi_capsule_auth_enabled(void);
1115
Masahisa Kojima70be5a62021-05-26 12:09:58 +09001116void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1117
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001118bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1119 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001120
Sughosh Ganuea350082020-12-30 19:27:07 +05301121struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1122 size_t buflen,
1123 u8 **tmpbuf);
1124
Heinrich Schuchardt8cd99752020-06-28 16:30:29 +02001125/* runtime implementation of memcpy() */
1126void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1127
Paul Barker8acc3d92022-10-05 13:18:35 +01001128/* commonly used helper functions */
Ilias Apalodimas21575292020-12-31 12:26:46 +02001129u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1130 unsigned int index);
Paul Barker8acc3d92022-10-05 13:18:35 +01001131efi_string_t efi_convert_string(const char *str);
AKASHI Takahiro94074682020-10-29 13:47:46 +09001132
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001133extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahiro7ff3f3c2020-11-17 09:28:00 +09001134extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001135
AKASHI Takahiro473d9b32020-11-17 09:27:55 +09001136/* Capsule update */
1137efi_status_t EFIAPI efi_update_capsule(
1138 struct efi_capsule_header **capsule_header_array,
1139 efi_uintn_t capsule_count,
1140 u64 scatter_gather_list);
1141efi_status_t EFIAPI efi_query_capsule_caps(
1142 struct efi_capsule_header **capsule_header_array,
1143 efi_uintn_t capsule_count,
1144 u64 *maximum_capsule_size,
1145 u32 *reset_type);
1146
Sughosh Ganu586bb982020-12-30 19:27:09 +05301147efi_status_t efi_capsule_authenticate(const void *capsule,
1148 efi_uintn_t capsule_size,
1149 void **image, efi_uintn_t *image_size);
1150
Simon Glass90975372022-01-23 12:55:12 -07001151#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiro45b819542020-11-17 09:27:56 +09001152
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001153/**
Sughosh Ganuccb36462022-04-15 11:29:34 +05301154 * struct efi_fw_image - Information on firmware images updatable through
1155 * capsule update
1156 *
1157 * This structure gives information about the firmware images on the platform
1158 * which can be updated through the capsule update mechanism
1159 *
1160 * @image_type_id: Image GUID. Same value is to be used in the capsule
1161 * @fw_name: Name of the firmware image
1162 * @image_index: Image Index, same as value passed to SetImage FMP
1163 * function
1164 */
1165struct efi_fw_image {
1166 efi_guid_t image_type_id;
1167 u16 *fw_name;
1168 u8 image_index;
1169};
1170
1171/**
1172 * struct efi_capsule_update_info - Information needed for capsule updates
1173 *
1174 * This structure provides information needed for performing firmware
1175 * updates. The structure needs to be initialised per platform, for all
1176 * platforms which enable capsule updates
1177 *
1178 * @dfu_string: String used to populate dfu_alt_info
Masahisa Kojima5d2438b2023-06-07 14:41:51 +09001179 * @num_images: The number of images array entries
Sughosh Ganuccb36462022-04-15 11:29:34 +05301180 * @images: Pointer to an array of updatable images
1181 */
1182struct efi_capsule_update_info {
1183 const char *dfu_string;
Masahisa Kojima5d2438b2023-06-07 14:41:51 +09001184 int num_images;
Sughosh Ganuccb36462022-04-15 11:29:34 +05301185 struct efi_fw_image *images;
1186};
1187
1188extern struct efi_capsule_update_info update_info;
Sughosh Ganuccb36462022-04-15 11:29:34 +05301189
1190/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001191 * Install the ESRT system table.
1192 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001193 * Return: status code
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001194 */
1195efi_status_t efi_esrt_register(void);
1196
1197/**
Jose Marinhoff72cb32021-12-23 14:51:07 +00001198 * efi_ecpt_register() - Install the ECPT system table.
1199 *
1200 * Return: status code
1201 */
1202efi_status_t efi_ecpt_register(void);
1203
1204/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001205 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1206 * present in the system.
1207 * If an ESRT already exists, the old ESRT is replaced in the system table.
1208 * The memory of the old ESRT is deallocated.
1209 *
1210 * Return:
1211 * - EFI_SUCCESS if the ESRT is correctly created
1212 * - error code otherwise.
1213 */
1214efi_status_t efi_esrt_populate(void);
Ilias Apalodimasfac773e2021-06-22 17:38:53 +03001215efi_status_t efi_load_capsule_drivers(void);
Ruchika Guptabc9495c2021-11-29 13:09:44 +05301216
1217efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +09001218
1219efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1220 const efi_guid_t *protocol, void *search_key,
1221 efi_uintn_t *no_handles, efi_handle_t **buffer);
1222
1223efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1224 struct efi_file_handle **root);
1225efi_status_t efi_file_open_int(struct efi_file_handle *this,
1226 struct efi_file_handle **new_handle,
1227 u16 *file_name, u64 open_mode,
1228 u64 attributes);
1229efi_status_t efi_file_close_int(struct efi_file_handle *file);
1230efi_status_t efi_file_read_int(struct efi_file_handle *this,
1231 efi_uintn_t *buffer_size, void *buffer);
1232efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1233
1234typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1235efi_status_t efi_console_get_u16_string
1236 (struct efi_simple_text_input_protocol *cin,
1237 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1238 int row, int col);
1239
1240efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1241
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001242/**
Sughosh Ganufbb00c22024-10-15 21:07:14 +05301243 * efi_add_known_memory() - add memory types to the EFI memory map
1244 *
1245 * This function is to be used to add different memory types other
1246 * than EFI_CONVENTIONAL_MEMORY to the EFI memory map. The conventional
1247 * memory is handled by the LMB module and gets added to the memory
1248 * map through the LMB module.
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001249 *
Sughosh Ganufbb00c22024-10-15 21:07:14 +05301250 * This function may be overridden for architectures specific purposes.
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001251 */
1252void efi_add_known_memory(void);
1253
Heinrich Schuchardtf7529f72024-04-26 16:13:11 +02001254/**
Heinrich Schuchardtfabdb732025-02-16 12:12:40 +01001255 * efi_map_update_notify() - notify EFI of memory map changes
1256 *
1257 * @addr: start of memory area
1258 * @size: size of memory area
1259 * @op: type of change
1260 * Return: 0 if change could be processed
1261 */
1262#ifdef CONFIG_EFI_LOADER
1263int efi_map_update_notify(phys_addr_t addr, phys_size_t size,
1264 enum lmb_map_op op);
1265#else
1266#define efi_map_update_notify(addr, size, op) (0)
1267#endif
1268
1269/**
Heinrich Schuchardtf7529f72024-04-26 16:13:11 +02001270 * efi_load_option_dp_join() - join device-paths for load option
1271 *
1272 * @dp: in: binary device-path, out: joined device-path
1273 * @dp_size: size of joined device-path
1274 * @initrd_dp: initrd device-path or NULL
1275 * @fdt_dp: device-tree device-path or NULL
1276 * Return: status_code
1277 */
1278efi_status_t efi_load_option_dp_join(struct efi_device_path **dp,
1279 size_t *dp_size,
1280 struct efi_device_path *initrd_dp,
1281 struct efi_device_path *fdt_dp);
1282
Heinrich Schuchardt1a41ca42024-04-26 16:13:18 +02001283int efi_get_distro_fdt_name(char *fname, int size, int seq);
1284
Heinrich Schuchardt8257f162024-07-13 13:30:29 +02001285void efi_load_distro_fdt(efi_handle_t handle, void **fdt, efi_uintn_t *fdt_size);
Heinrich Schuchardtd9b23632024-04-26 16:13:21 +02001286
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02001287#endif /* _EFI_LOADER_H */