blob: 6a17a41dbad8ff4edfcbae0ecbb015b4d3adc7c1 [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>
Heinrich Schuchardtda620cf2022-10-06 07:29:41 +020012#include <event.h>
Simon Glass0f2af882020-05-10 11:40:05 -060013#include <log.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010014#include <part_efi.h>
15#include <efi_api.h>
AKASHI Takahiro2c0f9f72020-04-21 09:38:38 +090016#include <image.h>
AKASHI Takahiro0e104e32020-04-14 11:51:44 +090017#include <pe.h>
Simon Glass97f9bd42021-07-02 12:36:16 -060018#include <linux/list.h>
Adriano Cordova0d1f5092024-12-04 00:05:24 -030019#include <linux/sizes.h>
Simon Glass97f9bd42021-07-02 12:36:16 -060020#include <linux/oid_registry.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010021
Simon Glass655306c2020-05-10 11:39:58 -060022struct blk_desc;
Simon Glassfce57772025-01-23 15:07:23 -070023struct bootflow;
AKASHI Takahiro4cbba2b2021-07-20 14:57:02 +090024struct jmp_buf_data;
Simon Glass655306c2020-05-10 11:39:58 -060025
Stephen Warrend0de8062018-08-30 15:43:43 -060026#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010027
Simon Glass97f9bd42021-07-02 12:36:16 -060028/**
29 * __efi_runtime_data - declares a non-const variable for EFI runtime section
30 *
31 * This macro indicates that a variable is non-const and should go into the
32 * EFI runtime section, and thus still be available when the OS is running.
33 *
34 * Only use on variables not declared const.
35 *
36 * Example:
37 *
38 * ::
39 *
40 * static __efi_runtime_data my_computed_table[256];
41 */
42#define __efi_runtime_data __section(".data.efi_runtime")
43
44/**
45 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
46 *
47 * This macro indicates that a variable is read-only (const) and should go into
48 * the EFI runtime section, and thus still be available when the OS is running.
49 *
50 * Only use on variables also declared const.
51 *
52 * Example:
53 *
54 * ::
55 *
56 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
57 */
58#define __efi_runtime_rodata __section(".rodata.efi_runtime")
59
60/**
61 * __efi_runtime - declares a function for EFI runtime section
62 *
63 * This macro indicates that a function should go into the EFI runtime section,
64 * and thus still be available when the OS is running.
65 *
66 * Example:
67 *
68 * ::
69 *
70 * static __efi_runtime compute_my_table(void);
71 */
72#define __efi_runtime __section(".text.efi_runtime")
73
74/*
75 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
76 * to make it available at runtime
77 */
78efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
79
80/*
81 * Special case handler for error/abort that just tries to dtrt to get
82 * back to u-boot world
83 */
84void efi_restore_gd(void);
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +090085
Simon Glass97f9bd42021-07-02 12:36:16 -060086/* Called by networking code to memorize the dhcp ack package */
87void efi_net_set_dhcp_ack(void *pkt, int len);
88/* Print information about all loaded images */
89void efi_print_image_infos(void *pc);
90
91/* Hook at initialization */
92efi_status_t efi_launch_capsules(void);
93
94#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
95
96/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
97#define __efi_runtime_data
98#define __efi_runtime_rodata
99#define __efi_runtime
100static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
101{
102 return EFI_SUCCESS;
103}
104
105/* No loader configured, stub out EFI_ENTRY */
106static inline void efi_restore_gd(void) { }
Simon Glass97f9bd42021-07-02 12:36:16 -0600107static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
108static inline void efi_print_image_infos(void *pc) { }
109static inline efi_status_t efi_launch_capsules(void)
110{
111 return EFI_SUCCESS;
112}
113
114#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100115
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900116#if CONFIG_IS_ENABLED(EFI_BINARY_EXEC)
117/* Call this to unset the current device name */
118void efi_clear_bootdev(void);
119/* Call this to set the current device name */
120void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
121 void *buffer, size_t buffer_size);
122#else
123static inline void efi_clear_bootdev(void) { }
124
125static inline void efi_set_bootdev(const char *dev, const char *devnr,
126 const char *path, void *buffer,
127 size_t buffer_size) { }
128#endif
129
Adriano Cordova3c951362024-12-04 00:05:21 -0300130#if CONFIG_IS_ENABLED(NETDEVICES) && CONFIG_IS_ENABLED(EFI_LOADER)
Adriano Cordova93cba0f2024-12-04 00:05:23 -0300131/* Call this to update the current device path of the efi net device */
132efi_status_t efi_net_set_dp(const char *dev, const char *server);
133/* Call this to get the current device path of the efi net device */
134void efi_net_get_dp(struct efi_device_path **dp);
Adriano Cordova3c951362024-12-04 00:05:21 -0300135void efi_net_get_addr(struct efi_ipv4_address *ip,
136 struct efi_ipv4_address *mask,
137 struct efi_ipv4_address *gw);
138void efi_net_set_addr(struct efi_ipv4_address *ip,
139 struct efi_ipv4_address *mask,
140 struct efi_ipv4_address *gw);
Adriano Cordova0d1f5092024-12-04 00:05:24 -0300141efi_status_t efi_net_do_request(u8 *url, enum efi_http_method method, void **buffer,
142 u32 *status_code, ulong *file_size, char *headers_buffer);
143#define MAX_HTTP_HEADERS_SIZE SZ_64K
144#define MAX_HTTP_HEADERS 100
145#define MAX_HTTP_HEADER_NAME 128
146#define MAX_HTTP_HEADER_VALUE 512
147struct http_header {
148 uchar name[MAX_HTTP_HEADER_NAME];
149 uchar value[MAX_HTTP_HEADER_VALUE];
150};
151
152void efi_net_parse_headers(ulong *num_headers, struct http_header *headers);
Adriano Cordova3c951362024-12-04 00:05:21 -0300153#else
Adriano Cordova93cba0f2024-12-04 00:05:23 -0300154static inline void efi_net_get_dp(struct efi_device_path **dp) { }
Adriano Cordova3c951362024-12-04 00:05:21 -0300155static inline void efi_net_get_addr(struct efi_ipv4_address *ip,
156 struct efi_ipv4_address *mask,
157 struct efi_ipv4_address *gw) { }
158static inline void efi_net_set_addr(struct efi_ipv4_address *ip,
159 struct efi_ipv4_address *mask,
160 struct efi_ipv4_address *gw) { }
161#endif
162
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +0200163/* Maximum number of configuration tables */
164#define EFI_MAX_CONFIGURATION_TABLES 16
165
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200166/* GUID used by the root node */
167#define U_BOOT_GUID \
168 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
169 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
Tobias Waldekranz32152682023-02-16 16:33:55 +0100170/* GUID used as root for blkmap devices */
171#define U_BOOT_BLKMAP_DEV_GUID \
172 EFI_GUID(0x4cad859d, 0xd644, 0x42ff, \
173 0x87, 0x0b, 0xc0, 0x2e, 0xac, 0x05, 0x58, 0x63)
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900174/* GUID used as host device on sandbox */
175#define U_BOOT_HOST_DEV_GUID \
176 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
177 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardtc770aaa2020-05-20 22:39:35 +0200178/* GUID used as root for virtio devices */
179#define U_BOOT_VIRTIO_DEV_GUID \
180 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
181 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200182
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900183/* GUID for the auto generated boot menu entry */
184#define EFICONFIG_AUTO_GENERATED_ENTRY_GUID \
Masahisa Kojimaa28cce52023-10-12 14:31:59 +0900185 EFI_GUID(0x8108ac4e, 0x9f11, 0x4d59, \
186 0x85, 0x0e, 0xe2, 0x1a, 0x52, 0x2c, 0x59, 0xb2)
Ilias Apalodimas465cb7e2024-04-18 15:54:51 +0300187#define U_BOOT_EFI_RT_VAR_FILE_GUID \
188 EFI_GUID(0xb2ac5fc9, 0x92b7, 0x4acd, \
189 0xae, 0xac, 0x11, 0xe8, 0x18, 0xc3, 0x13, 0x0c)
190
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100191/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100192#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100193
AKASHI Takahiro0b275752019-04-16 13:24:20 +0900194/* Root node */
195extern efi_handle_t efi_root;
196
Heinrich Schuchardtde9bdc62020-03-19 18:21:58 +0000197/* Set to EFI_SUCCESS when initialized */
198extern efi_status_t efi_obj_list_initialized;
199
Heinrich Schuchardt628dbd72020-11-12 21:26:28 +0100200/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
201extern bool efi_st_keep_devices;
202
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100203/* EFI system partition */
204extern struct efi_system_partition {
Simon Glassfada3f92022-09-17 09:00:09 -0600205 enum uclass_id uclass_id;
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100206 int devnum;
207 u8 part;
208} efi_system_partition;
209
Rob Clark86789d52017-07-27 08:04:18 -0400210int __efi_entry_check(void);
211int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200212const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -0400213const char *__efi_nesting_inc(void);
214const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -0400215
Rob Clark63ea77a2017-07-27 08:04:17 -0400216/*
217 * Enter the u-boot world from UEFI:
218 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100219#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -0400220 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400221 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
222 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +0100223 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +0100224
Rob Clark63ea77a2017-07-27 08:04:17 -0400225/*
226 * Exit the u-boot world back to UEFI:
227 */
Rob Clark84a19a02017-07-24 10:31:52 -0400228#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200229 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -0400230 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200231 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -0400232 assert(__efi_exit_check()); \
233 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -0400234 })
Alexander Grafc15d9212016-03-04 01:09:59 +0100235
Rob Clark63ea77a2017-07-27 08:04:17 -0400236/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200237 * Call non-void UEFI function from u-boot and retrieve return value:
238 */
239#define EFI_CALL(exp) ({ \
240 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
241 assert(__efi_exit_check()); \
242 typeof(exp) _r = exp; \
243 assert(__efi_entry_check()); \
244 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
245 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
246 _r; \
247})
248
Heinrich Schuchardt0ad71bc2025-01-17 01:09:51 +0100249/**
250 * define EFI_RETURN() - return from EFI_CALL in efi_start_image()
251 *
252 * @ret: status code
253 */
254#define EFI_RETURN(ret) ({ \
255 typeof(ret) _r = ret; \
256 assert(__efi_entry_check()); \
257 debug("%sEFI: %lu returned by started image", __efi_nesting_dec(), \
258 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK)); \
259})
260
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200261/*
262 * Call void UEFI function from u-boot:
Rob Clark63ea77a2017-07-27 08:04:17 -0400263 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200264#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400265 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400266 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400267 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400268 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400269 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400270 } while(0)
271
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200272/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100273 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200274 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100275#define EFI_PRINT(format, ...) ({ \
276 debug("%sEFI: " format, __efi_nesting(), \
277 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200278 })
279
Alexander Graf59254d62018-04-23 07:59:47 +0200280#ifdef CONFIG_SYS_CACHELINE_SIZE
281#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
282#else
283/* Just use the greatest cache flush alignment requirement I'm aware of */
284#define EFI_CACHELINE_SIZE 128
285#endif
286
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900287/* max bootmenu title size for volume selection */
288#define BOOTMENU_DEVICE_NAME_MAX 16
289
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200290/* Key identifying current memory map */
291extern efi_uintn_t efi_memory_map_key;
292
Alexander Graf0bd425a2016-03-04 01:10:01 +0100293extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100294extern struct efi_system_table systab;
295
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200296extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200297extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200298extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200299extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100300/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
301extern const struct efi_device_path_utilities_protocol
302 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200303/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200304extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200305 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900306extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
307extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900308extern const struct efi_hii_database_protocol efi_hii_database;
309extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100310
Rob Clark85dd7212017-09-13 18:05:30 -0400311uint16_t *efi_dp_str(struct efi_device_path *dp);
312
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900313/* GUID for the auto generated boot menu entry */
314extern const efi_guid_t efi_guid_bootmenu_auto_generated;
315
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200316/* GUID of the U-Boot root node */
317extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900318#ifdef CONFIG_SANDBOX
319/* GUID of U-Boot host device on sandbox */
320extern const efi_guid_t efi_guid_host_dev;
321#endif
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100322/* GUID of the EFI_BLOCK_IO_PROTOCOL */
323extern const efi_guid_t efi_block_io_guid;
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300324/* GUID of the EFI_SIMPLE_NETWORK_PROTOCOL */
325extern const efi_guid_t efi_net_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400326extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100327extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100328extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardte840b9c2022-03-19 07:04:03 +0100329/* GUID of the EFI system partition */
330extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100331/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
332extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +0100333/* event group ExitBootServices() invoked */
334extern const efi_guid_t efi_guid_event_group_exit_boot_services;
335/* event group SetVirtualAddressMap() invoked */
336extern const efi_guid_t efi_guid_event_group_virtual_address_change;
337/* event group memory map changed */
338extern const efi_guid_t efi_guid_event_group_memory_map_change;
339/* event group boot manager about to boot */
340extern const efi_guid_t efi_guid_event_group_ready_to_boot;
341/* event group ResetSystem() invoked (before ExitBootServices) */
342extern const efi_guid_t efi_guid_event_group_reset_system;
Masahisa Kojima1923f362023-11-10 13:25:39 +0900343/* event group return to efibootmgr */
344extern const efi_guid_t efi_guid_event_group_return_to_efibootmgr;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +0100345/* GUID of the device tree table */
346extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100347extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900348extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200349extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-09-13 18:05:34 -0400350extern const efi_guid_t efi_simple_file_system_protocol_guid;
351extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt37fb4b92018-04-04 15:42:11 +0200352/* GUID for file system information */
353extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100354extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200355/* GUID of the deprecated Unicode collation protocol */
356extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt485956d2020-12-04 03:33:41 +0100357/* GUIDs of the Load File and Load File2 protocol */
358extern const efi_guid_t efi_guid_load_file_protocol;
359extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200360/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200361extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900362extern const efi_guid_t efi_guid_hii_config_routing_protocol;
363extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900364extern const efi_guid_t efi_guid_hii_database_protocol;
365extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900366/* GUIDs for authentication */
367extern const efi_guid_t efi_guid_image_security_database;
368extern const efi_guid_t efi_guid_sha256;
369extern const efi_guid_t efi_guid_cert_x509;
370extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300371extern const efi_guid_t efi_guid_cert_x509_sha384;
372extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900373extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100374
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530375/* GUID of RNG protocol */
376extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900377/* GUID of capsule update result */
378extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro0d963782020-11-30 18:12:11 +0900379/* GUID of firmware management protocol */
380extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000381/* GUID for the ESRT */
382extern const efi_guid_t efi_esrt_guid;
Masahisa Kojimacd1fe7d2021-10-26 17:27:24 +0900383/* GUID of the SMBIOS table */
384extern const efi_guid_t smbios_guid;
Masahisa Kojimad8733f32024-01-26 09:53:42 +0900385extern const efi_guid_t smbios3_guid;
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +0900386/*GUID of console */
387extern const efi_guid_t efi_guid_text_input_protocol;
Masahisa Kojimaa93282c2023-01-24 15:56:15 +0900388extern const efi_guid_t efi_guid_text_output_protocol;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530389
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200390/**
391 * struct efi_open_protocol_info_item - open protocol info item
392 *
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100393 * When a protocol is opened a open protocol info entry is created.
394 * These are maintained in a list.
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200395 *
396 * @link: link to the list of open protocol info entries of a protocol
397 * @info: information about the opening of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100398 */
399struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100400 struct list_head link;
401 struct efi_open_protocol_info_entry info;
402};
403
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200404/**
405 * struct efi_handler - single protocol interface of a handle
406 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100407 * When the UEFI payload wants to open a protocol on an object to get its
408 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100409 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200410 *
411 * @link: link to the list of protocols of a handle
412 * @guid: GUID of the protocol
413 * @protocol_interface: protocol interface
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100414 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100415 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100416struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100417 struct list_head link;
Heinrich Schuchardt2a22db92022-03-09 19:56:23 +0100418 const efi_guid_t guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200419 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100420 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100421};
422
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200423/**
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200424 * enum efi_object_type - type of EFI object
425 *
426 * In UnloadImage we must be able to identify if the handle relates to a
427 * started image.
428 */
429enum efi_object_type {
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100430 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200431 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100432 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200433 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100434 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200435 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100436 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200437 EFI_OBJECT_TYPE_STARTED_IMAGE,
438};
439
440/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200441 * struct efi_object - dereferenced EFI handle
442 *
443 * @link: pointers to put the handle into a linked list
444 * @protocols: linked list with the protocol interfaces installed on this
445 * handle
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100446 * @type: image type if the handle relates to an image
Masahisa Kojimac9611082022-07-22 11:39:10 +0900447 * @dev: pointer to the DM device which is associated with this EFI handle
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200448 *
449 * UEFI offers a flexible and expandable object model. The objects in the UEFI
450 * API are devices, drivers, and loaded images. struct efi_object is our storage
451 * structure for these objects.
452 *
453 * When including this structure into a larger structure always put it first so
454 * that when deleting a handle the whole encompassing structure can be freed.
Alexander Grafc15d9212016-03-04 01:09:59 +0100455 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200456 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
457 * has been created for such pointers.
Alexander Grafc15d9212016-03-04 01:09:59 +0100458 */
459struct efi_object {
460 /* Every UEFI object is part of a global object list */
461 struct list_head link;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100462 /* The list of protocols */
463 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200464 enum efi_object_type type;
Masahisa Kojimac9611082022-07-22 11:39:10 +0900465 struct udevice *dev;
Alexander Grafc15d9212016-03-04 01:09:59 +0100466};
467
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900468enum efi_image_auth_status {
469 EFI_IMAGE_AUTH_FAILED = 0,
470 EFI_IMAGE_AUTH_PASSED,
471};
472
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200473/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200474 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200475 *
476 * @header: EFI object header
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200477 * @exit_status: exit status passed to Exit()
478 * @exit_data_size: exit data size passed to Exit()
479 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100480 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200481 * @entry: entry address of the relocated image
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100482 * @image_type: indicates if the image is an applicition or a driver
483 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200484 */
485struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200486 struct efi_object header;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100487 efi_status_t *exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200488 efi_uintn_t *exit_data_size;
489 u16 **exit_data;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100490 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200491 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
492 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200493 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900494 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200495};
496
497/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200498 * struct efi_event
499 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100500 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200501 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200502 * @type: Type of event, see efi_create_event
503 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100504 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200505 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100506 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100507 * @trigger_time: Period of the timer
508 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200509 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100510 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200511 */
512struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100513 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200514 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200515 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100516 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200517 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
518 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100519 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200520 u64 trigger_next;
521 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200522 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200523 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200524};
525
Alexander Grafc15d9212016-03-04 01:09:59 +0100526/* This list contains all UEFI objects we know of */
527extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100528/* List of all events */
529extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100530
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200531/**
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200532 * struct efi_protocol_notification - handle for notified protocol
533 *
534 * When a protocol interface is installed for which an event was registered with
535 * the RegisterProtocolNotify() service this structure is used to hold the
536 * handle on which the protocol interface was installed.
537 *
538 * @link: link to list of all handles notified for this event
539 * @handle: handle on which the notified protocol interface was installed
540 */
541struct efi_protocol_notification {
542 struct list_head link;
543 efi_handle_t handle;
544};
545
546/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100547 * struct efi_register_notify_event - event registered by
548 * RegisterProtocolNotify()
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200549 *
550 * The address of this structure serves as registration value.
551 *
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200552 * @link: link to list of all registered events
553 * @event: registered event. The same event may registered for multiple
554 * GUIDs.
555 * @protocol: protocol for which the event is registered
556 * @handles: linked list of all handles on which the notified protocol was
557 * installed
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200558 */
559struct efi_register_notify_event {
560 struct list_head link;
561 struct efi_event *event;
562 efi_guid_t protocol;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200563 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200564};
565
AKASHI Takahiroa36dc252022-04-19 10:05:11 +0900566/* called at pre-initialization */
567int efi_init_early(void);
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100568/* Initialize efi execution environment */
569efi_status_t efi_init_obj_list(void);
Raymond Mao70a76c52023-06-19 14:22:58 -0700570/* Append new boot option in BootOrder variable */
571efi_status_t efi_bootmgr_append_bootorder(u16 index);
572/* Get unused "Boot####" index */
573efi_status_t efi_bootmgr_get_unused_bootoption(u16 *buf,
574 efi_uintn_t buf_size, u32 *index);
575/* Generate the media device boot option */
576efi_status_t efi_bootmgr_update_media_device_boot_option(void);
577/* Delete selected boot option */
578efi_status_t efi_bootmgr_delete_boot_option(u16 boot_index);
AKASHI Takahiro7b061922023-11-21 10:29:44 +0900579/* Invoke EFI boot manager */
580efi_status_t efi_bootmgr_run(void *fdt);
Raymond Mao70a76c52023-06-19 14:22:58 -0700581/* search the boot option index in BootOrder */
582bool efi_search_bootorder(u16 *bootorder, efi_uintn_t num, u32 target, u32 *index);
Heinrich Schuchardt761908e2022-06-14 08:02:03 +0200583/* Set up console modes */
584void efi_setup_console_size(void);
AKASHI Takahiro7b061922023-11-21 10:29:44 +0900585/* Set up load options from environment variable */
586efi_status_t efi_env_set_load_options(efi_handle_t handle, const char *env_var,
587 u16 **load_options);
Heinrich Schuchardt0a4a2f32024-01-26 08:54:30 +0100588/* Get EFI configuration table */
589void *efi_get_configuration_table(const efi_guid_t *guid);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100590/* Install device tree */
591efi_status_t efi_install_fdt(void *fdt);
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900592/* Execute loaded UEFI image */
593efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options);
AKASHI Takahiro7b061922023-11-21 10:29:44 +0900594/* Run loaded UEFI image with given fdt */
595efi_status_t efi_binary_run(void *image, size_t size, void *fdt);
Simon Glassfce57772025-01-23 15:07:23 -0700596
597/**
598 * efi_bootflow_run() - Run a bootflow containing an EFI application
599 *
600 * @bootflow: Bootflow to run
601 * Return: Status code, something went wrong
602 */
603efi_status_t efi_bootflow_run(struct bootflow *bootflow);
604
Heinrich Schuchardtcf3b1182019-06-20 13:52:16 +0200605/* Initialize variable services */
606efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200607/* Notify ExitBootServices() is called */
608void efi_variables_boot_exit_notify(void);
Masahisa Kojima1ac19bb2021-08-13 16:12:41 +0900609efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900610/* Measure efi application invocation */
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900611efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900612/* Measure efi application exit */
613efi_status_t efi_tcg2_measure_efi_app_exit(void);
Etienne Carriereb9064352023-02-16 17:29:48 +0100614/* Measure DTB */
615efi_status_t efi_tcg2_measure_dtb(void *dtb);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200616/* Called by bootefi to initialize root node */
617efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200618/* Called by bootefi to initialize runtime */
619efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200620/* efi_runtime_detach() - detach unimplemented runtime functions */
621void efi_runtime_detach(void);
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100622/* efi_convert_pointer() - convert pointer to virtual address */
623efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
624 void **address);
Heinrich Schuchardt2c1e2242020-12-13 10:30:24 +0100625/* Carve out DT reserved memory ranges */
626void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimase4e56602022-01-03 14:07:37 +0200627/* Purge unused kaslr-seed */
Heinrich Schuchardt069079c2024-09-17 10:49:29 +0200628void efi_try_purge_rng_seed(void *fdt);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200629/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200630efi_status_t efi_console_register(void);
Heinrich Schuchardta02228f2022-08-31 16:37:35 +0200631/* Called by efi_init_obj_list() to proble all block devices */
632efi_status_t efi_disks_register(void);
Heinrich Schuchardtc63f68f2020-09-25 12:50:19 +0200633/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
634efi_status_t efi_rng_register(void);
Ilias Apalodimas590fef62020-11-11 11:18:11 +0200635/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
636efi_status_t efi_tcg2_register(void);
Sunil V L279d1c82022-01-28 20:48:44 +0530637/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
638efi_status_t efi_riscv_register(void);
Masahisa Kojima0fd43792021-12-07 14:15:31 +0900639/* Called by efi_init_obj_list() to do initial measurement */
640efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900641/* measure the pe-coff image, extend PCR and add Event Log */
642efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
643 struct efi_loaded_image_obj *handle,
644 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100645/* Create handles and protocols for the partitions of a block device */
646int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
Simon Glassfada3f92022-09-17 09:00:09 -0600647 const char *uclass_idname, int diskid,
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100648 const char *pdevname);
Alexander Grafd65783d2016-03-15 18:38:21 +0100649/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100650efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200651/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100652efi_status_t efi_net_register(void);
Adriano Cordova9debc902024-12-04 00:05:25 -0300653/* Called by efi_net_register to make the ip4 config2 protocol available */
654efi_status_t efi_ipconfig_register(const efi_handle_t handle,
655 struct efi_ip4_config2_protocol *ip4config);
Adriano Cordovae9b19eb2024-12-04 00:05:26 -0300656/* Called by efi_net_register to make the http protocol available */
657efi_status_t efi_http_register(const efi_handle_t handle,
658 struct efi_service_binding_protocol *http_service_binding);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200659/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100660efi_status_t efi_watchdog_register(void);
Ilias Apalodimas3510ba72020-02-21 09:55:45 +0200661efi_status_t efi_initrd_register(void);
Ilias Apalodimas7e052792022-10-16 11:36:32 +0300662efi_status_t efi_initrd_deregister(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200663/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600664/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700665 * efi_acpi_register() - write out ACPI tables
666 *
667 * Called by bootefi to make ACPI tables available
668 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100669 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng2cfbdae2018-06-27 20:38:03 -0700670 */
671efi_status_t efi_acpi_register(void);
672/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600673 * efi_smbios_register() - write out SMBIOS tables
674 *
675 * Called by bootefi to make SMBIOS tables available
676 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100677 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass2e2858f2018-05-16 09:42:19 -0600678 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100679efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200680
Rob Clark53142032017-09-13 18:05:34 -0400681struct efi_simple_file_system_protocol *
682efi_fs_from_path(struct efi_device_path *fp);
683
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200684/* Called by efi_set_watchdog_timer to reset the timer */
685efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200686
Alexander Grafc15d9212016-03-04 01:09:59 +0100687/* Called from places to check whether a timer expired */
688void efi_timer_check(void);
Heinrich Schuchardtad6e0f72021-01-12 12:40:32 +0100689/* Check if a buffer contains a PE-COFF image */
690efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafc15d9212016-03-04 01:09:59 +0100691/* PE loader implementation */
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900692efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
693 void *efi, size_t efi_size,
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100694 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100695/* Called once to store the pristine gd pointer */
696void efi_save_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100697/* Call this to relocate the runtime section to an address space */
698void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Rui Miguel Silva433f15a2022-05-11 10:55:40 +0100699/* Call this to get image parameters */
700void efi_get_image_parameters(void **img_addr, size_t *img_size);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100701/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200702void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200703/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100704efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100705/* Delete handle */
Ilias Apalodimasb09ecf12023-07-24 13:17:36 +0300706efi_status_t efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100707/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100708struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahiro537a6932022-04-28 17:09:38 +0900709/* Locate device_path handle */
710efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
711 struct efi_device_path **device_path,
712 efi_handle_t *device);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900713/* Load image */
714efi_status_t EFIAPI efi_load_image(bool boot_policy,
715 efi_handle_t parent_image,
716 struct efi_device_path *file_path,
717 void *source_buffer,
718 efi_uintn_t source_size,
719 efi_handle_t *image_handle);
Heinrich Schuchardte5aa9fa2024-04-26 16:13:20 +0200720/* Load image from path */
721efi_status_t efi_load_image_from_path(bool boot_policy,
722 struct efi_device_path *file_path,
723 void **buffer, efi_uintn_t *size);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100724/* Start image */
725efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
726 efi_uintn_t *exit_data_size,
727 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900728/* Unload image */
729efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200730/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100731efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200732 const efi_guid_t *protocol_guid,
733 struct efi_handler **handler);
734/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100735efi_status_t efi_add_protocol(const efi_handle_t handle,
736 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200737 void *protocol_interface);
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300738/* Uninstall new protocol on a handle */
739efi_status_t efi_uninstall_protocol
740 (efi_handle_t handle, const efi_guid_t *protocol,
741 void *protocol_interface, bool preserve);
Adriano Cordova3d4b09a2024-12-06 14:18:34 -0300742/* Reinstall a protocol on a handle */
743efi_status_t EFIAPI efi_reinstall_protocol_interface(
744 efi_handle_t handle,
745 const efi_guid_t *protocol,
746 void *old_interface, void *new_interface);
Heinrich Schuchardt9c89d142020-01-10 12:33:59 +0100747/* Open protocol */
748efi_status_t efi_protocol_open(struct efi_handler *handler,
749 void **protocol_interface, void *agent_handle,
750 void *controller_handle, uint32_t attributes);
751
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200752/* Install multiple protocol interfaces */
Ilias Apalodimas8ac0ebe2022-10-06 16:08:46 +0300753efi_status_t EFIAPI
754efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...);
755efi_status_t EFIAPI
756efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...);
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300757/* Connect and disconnect controller */
758efi_status_t EFIAPI efi_connect_controller(efi_handle_t controller_handle,
759 efi_handle_t *driver_image_handle,
760 struct efi_device_path *remain_device_path,
761 bool recursive);
762efi_status_t EFIAPI efi_disconnect_controller(
763 efi_handle_t controller_handle,
764 efi_handle_t driver_image_handle,
765 efi_handle_t child_handle);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900766/* Get handles that support a given protocol */
767efi_status_t EFIAPI efi_locate_handle_buffer(
768 enum efi_locate_search_type search_type,
769 const efi_guid_t *protocol, void *search_key,
770 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardt5e394332022-10-07 15:18:15 +0200771/* Close a previously opened protocol interface */
772efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
773 efi_handle_t agent_handle,
774 efi_handle_t controller_handle);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900775/* Open a protocol interface */
776efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
777 const efi_guid_t *protocol,
778 void **protocol_interface);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200779/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100780efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200781 void (EFIAPI *notify_function) (
782 struct efi_event *event,
783 void *context),
Masahisa Kojima787774a2023-11-10 13:25:38 +0900784 void *notify_context, const efi_guid_t *group,
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100785 struct efi_event **event);
Adriano Cordova7f2bcd42025-03-03 11:13:11 -0300786/* Call this to close an event */
787efi_status_t EFIAPI efi_close_event(struct efi_event *event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200788/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200789efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200790 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200791/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200792void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100793
AKASHI Takahiroba647af2022-05-12 11:29:01 +0900794/* return true if the device is removable */
795bool efi_disk_is_removable(efi_handle_t handle);
796
Heinrich Schuchardtf9e8ada2023-07-30 14:03:53 +0200797/**
798 * efi_create_simple_file_system() - create simple file system protocol
799 *
800 * Create a simple file system protocol for a partition.
801 *
802 * @desc: block device descriptor
803 * @part: partition number
804 * @dp: device path
805 * @fsp: simple file system protocol
806 * Return: status code
807 */
808efi_status_t
809efi_create_simple_file_system(struct blk_desc *desc, int part,
810 struct efi_device_path *dp,
811 struct efi_simple_file_system_protocol **fsp);
Rob Clark53142032017-09-13 18:05:34 -0400812
813/* open file from device-path: */
814struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
815
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000816/* Registers a callback function for a notification event. */
817efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
818 struct efi_event *event,
819 void **registration);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200820efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
821
822/* get a device path from a Boot#### option */
Heinrich Schuchardtefd90d72024-04-26 16:13:08 +0200823struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t *guid);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200824
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300825/* get len, string (used in u-boot crypto from a guid */
826const char *guid_to_sha_str(const efi_guid_t *guid);
827int algo_to_len(const char *algo);
828
Masahisa Kojimac9611082022-07-22 11:39:10 +0900829int efi_link_dev(efi_handle_t handle, struct udevice *dev);
Heinrich Schuchardt34f34622022-10-03 09:47:51 +0200830int efi_unlink_dev(efi_handle_t handle);
Masahisa Kojima2f407f02022-12-02 13:59:35 +0900831bool efi_varname_is_load_option(u16 *var_name16, int *index);
Masahisa Kojima7ec3c6f2022-12-19 11:33:12 +0900832efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
833 efi_guid_t *guid);
Masahisa Kojimac9611082022-07-22 11:39:10 +0900834
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100835/**
836 * efi_size_in_pages() - convert size in bytes to size in pages
837 *
838 * This macro returns the number of EFI memory pages required to hold 'size'
839 * bytes.
840 *
841 * @size: size in bytes
842 * Return: size in pages
843 */
Heinrich Schuchardtaefb0c42021-01-17 07:52:09 +0100844#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Heinrich Schuchardt45640252023-03-19 09:20:22 +0100845/* Allocate boot service data pool memory */
846void *efi_alloc(size_t len);
Ilias Apalodimas6e01c232021-10-11 15:10:23 +0300847/* Allocate pages on the specified alignment */
848void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf8623f922016-03-04 01:10:04 +0100849/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200850efi_status_t efi_allocate_pages(enum efi_allocate_type type,
851 enum efi_memory_type memory_type,
852 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200853/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100854efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200855/* EFI memory allocator for small allocations */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200856efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
857 efi_uintn_t size, void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200858/* EFI pool memory free function. */
859efi_status_t efi_free_pool(void *buffer);
Heinrich Schuchardt13ce2d92023-01-05 18:26:01 +0100860/* Allocate and retrieve EFI memory map */
861efi_status_t efi_get_memory_map_alloc(efi_uintn_t *map_size,
862 struct efi_mem_desc **memory_map);
Alexander Graf8623f922016-03-04 01:10:04 +0100863/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100864efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100865 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100866 efi_uintn_t *map_key,
867 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100868 uint32_t *descriptor_version);
869/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200870efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Sughosh Ganua3af5ba2024-10-15 21:07:07 +0530871
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100872/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100873efi_status_t efi_driver_init(void);
Heinrich Schuchardtda620cf2022-10-06 07:29:41 +0200874/* Called when a block device is added */
875int efi_disk_probe(void *ctx, struct event *event);
876/* Called when a block device is removed */
877int efi_disk_remove(void *ctx, struct event *event);
Alexander Graf8623f922016-03-04 01:10:04 +0100878/* Called by board init to initialize the EFI memory map */
879int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200880/* Adds new or overrides configuration table entry to the system table */
881efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100882/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200883efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
884 struct efi_device_path *file_path,
885 struct efi_loaded_image_obj **handle_ptr,
886 struct efi_loaded_image **info_ptr);
Alexander Graf8623f922016-03-04 01:10:04 +0100887
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200888#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
889extern void *efi_bounce_buffer;
890#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
891#endif
892
Heinrich Schuchardt24f0e6a2022-02-26 12:10:10 +0100893/* shorten device path */
894struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400895struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200896int efi_dp_match(const struct efi_device_path *a,
897 const struct efi_device_path *b);
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100898efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardt0a04a412022-03-19 06:35:43 +0100899 const efi_guid_t *guid,
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100900 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200901/* get size of the first device path instance excluding end node */
902efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
903/* size of multi-instance device path excluding end node */
904efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400905struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400906struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
907 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200908/* Create a device path node of given type, sub-type, length */
909struct efi_device_path *efi_dp_create_device_node(const u8 type,
910 const u8 sub_type,
911 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200912/* Append device path instance */
913struct efi_device_path *efi_dp_append_instance(
914 const struct efi_device_path *dp,
915 const struct efi_device_path *dpi);
916/* Get next device path instance */
917struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
918 efi_uintn_t *size);
919/* Check if a device path contains muliple instances */
920bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400921
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400922struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100923/* Create a device node for a block device partition. */
924struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Heinrich Schuchardtff08eac2023-05-13 10:36:21 +0200925struct efi_device_path *efi_dp_from_file(const struct efi_device_path *dp,
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400926 const char *path);
927struct efi_device_path *efi_dp_from_eth(void);
Adriano Cordova4bd5eca2024-12-04 00:05:22 -0300928struct efi_device_path *efi_dp_from_http(const char *server);
Rob Clark18ceba72017-10-10 08:23:06 -0400929struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
930 uint64_t start_address,
Moritz Fischerfe61a8b2024-11-04 01:49:34 +0000931 size_t size);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100932/* Determine the last device path node that is not the end node. */
933const struct efi_device_path *efi_dp_last_node(
934 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100935efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
936 struct efi_device_path **device_path,
937 struct efi_device_path **file_path);
Heinrich Schuchardt81244ea2022-02-04 20:47:09 +0100938struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900939efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
940 const char *path,
941 struct efi_device_path **device,
942 struct efi_device_path **file);
Heinrich Schuchardt22c8e082020-08-23 10:49:46 +0200943ssize_t efi_dp_check_length(const struct efi_device_path *dp,
944 const size_t maxlen);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400945
946#define EFI_DP_TYPE(_dp, _type, _subtype) \
947 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
948 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
949
Masahisa Kojima97bd9da2022-06-19 13:55:59 +0900950/* template END node: */
951extern const struct efi_device_path END;
952
AKASHI Takahiro32401842019-06-05 13:21:38 +0900953/* Indicate supported runtime services */
954efi_status_t efi_init_runtime_supported(void);
955
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200956/* Update CRC32 in table header */
957void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
958
Alexander Graf77256092016-08-16 21:08:45 +0200959/* Boards may provide the functions below to implement RTS functionality */
960
Alexander Graf393dd912016-10-14 13:45:30 +0200961void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200962 enum efi_reset_type reset_type,
963 efi_status_t reset_status,
964 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100965
966/* Architecture specific initialization of the EFI subsystem */
967efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200968
Alexander Graf393dd912016-10-14 13:45:30 +0200969efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200970 struct efi_time *time,
971 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200972
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200973efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
974
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200975/*
976 * Entry point for the tests of the EFI API.
977 * It is called by 'bootefi selftest'
978 */
979efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
980 struct efi_system_table *systab);
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200981
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100982efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
983 const efi_guid_t *vendor, u32 *attributes,
984 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200985efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
986 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100987 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100988efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
989 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100990 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400991
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200992efi_status_t EFIAPI efi_query_variable_info(
993 u32 attributes, u64 *maximum_variable_storage_size,
994 u64 *remaining_variable_storage_size,
995 u64 *maximum_variable_size);
996
Heinrich Schuchardt1ad2f0d2021-09-09 07:12:14 +0200997void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200998
AKASHI Takahirobd237742018-11-05 18:06:41 +0900999/*
1000 * See section 3.1.3 in the v2.7 UEFI spec for more details on
1001 * the layout of EFI_LOAD_OPTION. In short it is:
1002 *
1003 * typedef struct _EFI_LOAD_OPTION {
1004 * UINT32 Attributes;
1005 * UINT16 FilePathListLength;
1006 * // CHAR16 Description[]; <-- variable length, NULL terminated
1007 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
1008 * <-- FilePathListLength bytes
1009 * // UINT8 OptionalData[];
1010 * } EFI_LOAD_OPTION;
1011 */
1012struct efi_load_option {
1013 u32 attributes;
1014 u16 file_path_length;
1015 u16 *label;
1016 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +02001017 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +09001018};
1019
Ilias Apalodimas483d28e2021-03-17 21:54:58 +02001020struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt9979cff2021-10-15 01:31:02 +02001021 const efi_guid_t *guid);
Ilias Apalodimas483d28e2021-03-17 21:54:58 +02001022struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
Ilias Apalodimas5dcefa72024-01-08 10:55:33 +02001023 const struct efi_device_path *dp2,
Heinrich Schuchardtf8de0092024-05-24 14:54:26 +02001024 size_t split_end_node);
Masahisa Kojima6460c3e2021-10-26 17:27:25 +09001025struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt7ca84f82020-05-31 22:46:09 +02001026efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
1027 efi_uintn_t *size);
AKASHI Takahirobd237742018-11-05 18:06:41 +09001028unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt25c6be52020-08-07 17:47:13 +02001029efi_status_t efi_set_load_options(efi_handle_t handle,
1030 efi_uintn_t load_options_size,
1031 void *load_options);
Heinrich Schuchardta7647a72020-08-07 17:49:39 +02001032efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clarkc84c1102017-09-13 18:05:38 -04001033
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001034/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001035 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001036 *
1037 * @max: Maximum number of regions
1038 * @num: Number of regions
1039 * @reg: array of regions
1040 */
1041struct efi_image_regions {
1042 int max;
1043 int num;
1044 struct image_region reg[];
1045};
1046
1047/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001048 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001049 *
1050 * This structure represents an internal form of signature in
1051 * signature database. A listed list may represent a signature list.
1052 *
1053 * @next: Pointer to next entry
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001054 * @owner: Signature owner
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001055 * @data: Pointer to signature data
1056 * @size: Size of signature data
1057 */
1058struct efi_sig_data {
1059 struct efi_sig_data *next;
1060 efi_guid_t owner;
1061 void *data;
1062 size_t size;
1063};
1064
1065/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +01001066 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001067 *
1068 * This structure represents an internal form of signature database.
1069 *
1070 * @next: Pointer to next entry
1071 * @sig_type: Signature type
1072 * @sig_data_list: Pointer to signature list
1073 */
1074struct efi_signature_store {
1075 struct efi_signature_store *next;
1076 efi_guid_t sig_type;
1077 struct efi_sig_data *sig_data_list;
1078};
1079
1080struct x509_certificate;
1081struct pkcs7_message;
1082
Masahisa Kojima767a9e62022-09-12 17:33:54 +09001083/**
1084 * struct eficonfig_media_boot_option - boot option for (removable) media device
1085 *
1086 * This structure is used to enumerate possible boot option
1087 *
1088 * @lo: Serialized load option data
1089 * @size: Size of serialized load option data
1090 * @exist: Flag to indicate the load option already exists
1091 * in Non-volatile load option
1092 */
1093struct eficonfig_media_boot_option {
1094 void *lo;
1095 efi_uintn_t size;
1096 bool exist;
1097};
1098
AKASHI Takahirof47b9b32022-07-05 14:48:12 +09001099bool efi_hash_regions(struct image_region *regs, int count,
1100 void **hash, const char *hash_algo, int *len);
AKASHI Takahirode924072020-07-08 14:01:57 +09001101bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas71eae982022-01-29 00:20:31 +02001102 struct efi_signature_store *db,
1103 bool dbx);
AKASHI Takahiro14afd062020-07-21 19:35:22 +09001104bool efi_signature_verify(struct efi_image_regions *regs,
1105 struct pkcs7_message *msg,
1106 struct efi_signature_store *db,
1107 struct efi_signature_store *dbx);
AKASHI Takahiro16411802020-08-14 14:39:23 +09001108static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
1109 struct pkcs7_message *msg,
1110 struct efi_signature_store *db)
1111{
1112 return efi_signature_verify(regs, msg, db, NULL);
1113}
AKASHI Takahiro4154b642020-07-08 14:01:56 +09001114bool efi_signature_check_signers(struct pkcs7_message *msg,
1115 struct efi_signature_store *dbx);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001116
1117efi_status_t efi_image_region_add(struct efi_image_regions *regs,
1118 const void *start, const void *end,
1119 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +09001120
1121void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganufa0faa62020-12-30 19:27:08 +05301122struct efi_signature_store *efi_build_signature_store(void *sig_list,
1123 efi_uintn_t size);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +09001124struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +09001125
1126bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001127
Sughosh Ganu586bb982020-12-30 19:27:09 +05301128bool efi_capsule_auth_enabled(void);
1129
Masahisa Kojima70be5a62021-05-26 12:09:58 +09001130void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
1131
AKASHI Takahiro0e104e32020-04-14 11:51:44 +09001132bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
1133 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +09001134
Sughosh Ganuea350082020-12-30 19:27:07 +05301135struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
1136 size_t buflen,
1137 u8 **tmpbuf);
1138
Heinrich Schuchardt8cd99752020-06-28 16:30:29 +02001139/* runtime implementation of memcpy() */
1140void efi_memcpy_runtime(void *dest, const void *src, size_t n);
1141
Paul Barker8acc3d92022-10-05 13:18:35 +01001142/* commonly used helper functions */
Ilias Apalodimas21575292020-12-31 12:26:46 +02001143u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
1144 unsigned int index);
Paul Barker8acc3d92022-10-05 13:18:35 +01001145efi_string_t efi_convert_string(const char *str);
AKASHI Takahiro94074682020-10-29 13:47:46 +09001146
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001147extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahiro7ff3f3c2020-11-17 09:28:00 +09001148extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof4818e62020-11-30 18:12:12 +09001149
AKASHI Takahiro473d9b32020-11-17 09:27:55 +09001150/* Capsule update */
1151efi_status_t EFIAPI efi_update_capsule(
1152 struct efi_capsule_header **capsule_header_array,
1153 efi_uintn_t capsule_count,
1154 u64 scatter_gather_list);
1155efi_status_t EFIAPI efi_query_capsule_caps(
1156 struct efi_capsule_header **capsule_header_array,
1157 efi_uintn_t capsule_count,
1158 u64 *maximum_capsule_size,
1159 u32 *reset_type);
1160
Sughosh Ganu586bb982020-12-30 19:27:09 +05301161efi_status_t efi_capsule_authenticate(const void *capsule,
1162 efi_uintn_t capsule_size,
1163 void **image, efi_uintn_t *image_size);
1164
Simon Glass90975372022-01-23 12:55:12 -07001165#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiro45b819542020-11-17 09:27:56 +09001166
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001167/**
Sughosh Ganuccb36462022-04-15 11:29:34 +05301168 * struct efi_fw_image - Information on firmware images updatable through
1169 * capsule update
1170 *
1171 * This structure gives information about the firmware images on the platform
1172 * which can be updated through the capsule update mechanism
1173 *
1174 * @image_type_id: Image GUID. Same value is to be used in the capsule
1175 * @fw_name: Name of the firmware image
1176 * @image_index: Image Index, same as value passed to SetImage FMP
1177 * function
1178 */
1179struct efi_fw_image {
1180 efi_guid_t image_type_id;
1181 u16 *fw_name;
1182 u8 image_index;
1183};
1184
1185/**
1186 * struct efi_capsule_update_info - Information needed for capsule updates
1187 *
1188 * This structure provides information needed for performing firmware
1189 * updates. The structure needs to be initialised per platform, for all
1190 * platforms which enable capsule updates
1191 *
1192 * @dfu_string: String used to populate dfu_alt_info
Masahisa Kojima5d2438b2023-06-07 14:41:51 +09001193 * @num_images: The number of images array entries
Sughosh Ganuccb36462022-04-15 11:29:34 +05301194 * @images: Pointer to an array of updatable images
1195 */
1196struct efi_capsule_update_info {
1197 const char *dfu_string;
Masahisa Kojima5d2438b2023-06-07 14:41:51 +09001198 int num_images;
Sughosh Ganuccb36462022-04-15 11:29:34 +05301199 struct efi_fw_image *images;
1200};
1201
1202extern struct efi_capsule_update_info update_info;
Sughosh Ganuccb36462022-04-15 11:29:34 +05301203
1204/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001205 * Install the ESRT system table.
1206 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001207 * Return: status code
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001208 */
1209efi_status_t efi_esrt_register(void);
1210
1211/**
Jose Marinhoff72cb32021-12-23 14:51:07 +00001212 * efi_ecpt_register() - Install the ECPT system table.
1213 *
1214 * Return: status code
1215 */
1216efi_status_t efi_ecpt_register(void);
1217
1218/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001219 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1220 * present in the system.
1221 * If an ESRT already exists, the old ESRT is replaced in the system table.
1222 * The memory of the old ESRT is deallocated.
1223 *
1224 * Return:
1225 * - EFI_SUCCESS if the ESRT is correctly created
1226 * - error code otherwise.
1227 */
1228efi_status_t efi_esrt_populate(void);
Ilias Apalodimasfac773e2021-06-22 17:38:53 +03001229efi_status_t efi_load_capsule_drivers(void);
Ruchika Guptabc9495c2021-11-29 13:09:44 +05301230
1231efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Masahisa Kojimac5ff0a02022-09-12 17:33:50 +09001232
1233efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
1234 const efi_guid_t *protocol, void *search_key,
1235 efi_uintn_t *no_handles, efi_handle_t **buffer);
1236
1237efi_status_t efi_open_volume_int(struct efi_simple_file_system_protocol *this,
1238 struct efi_file_handle **root);
1239efi_status_t efi_file_open_int(struct efi_file_handle *this,
1240 struct efi_file_handle **new_handle,
1241 u16 *file_name, u64 open_mode,
1242 u64 attributes);
1243efi_status_t efi_file_close_int(struct efi_file_handle *file);
1244efi_status_t efi_file_read_int(struct efi_file_handle *this,
1245 efi_uintn_t *buffer_size, void *buffer);
1246efi_status_t efi_file_setpos_int(struct efi_file_handle *file, u64 pos);
1247
1248typedef efi_status_t (*efi_console_filter_func)(struct efi_input_key *key);
1249efi_status_t efi_console_get_u16_string
1250 (struct efi_simple_text_input_protocol *cin,
1251 u16 *buf, efi_uintn_t count, efi_console_filter_func filer_func,
1252 int row, int col);
1253
1254efi_status_t efi_disk_get_device_name(const efi_handle_t handle, char *buf, int size);
1255
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001256/**
Sughosh Ganufbb00c22024-10-15 21:07:14 +05301257 * efi_add_known_memory() - add memory types to the EFI memory map
1258 *
1259 * This function is to be used to add different memory types other
1260 * than EFI_CONVENTIONAL_MEMORY to the EFI memory map. The conventional
1261 * memory is handled by the LMB module and gets added to the memory
1262 * map through the LMB module.
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001263 *
Sughosh Ganufbb00c22024-10-15 21:07:14 +05301264 * This function may be overridden for architectures specific purposes.
Heinrich Schuchardt8600f992023-02-10 09:01:13 +01001265 */
1266void efi_add_known_memory(void);
1267
Heinrich Schuchardtf7529f72024-04-26 16:13:11 +02001268/**
Heinrich Schuchardtfabdb732025-02-16 12:12:40 +01001269 * efi_map_update_notify() - notify EFI of memory map changes
1270 *
1271 * @addr: start of memory area
1272 * @size: size of memory area
1273 * @op: type of change
1274 * Return: 0 if change could be processed
1275 */
1276#ifdef CONFIG_EFI_LOADER
1277int efi_map_update_notify(phys_addr_t addr, phys_size_t size,
1278 enum lmb_map_op op);
1279#else
1280#define efi_map_update_notify(addr, size, op) (0)
1281#endif
1282
1283/**
Heinrich Schuchardtf7529f72024-04-26 16:13:11 +02001284 * efi_load_option_dp_join() - join device-paths for load option
1285 *
1286 * @dp: in: binary device-path, out: joined device-path
1287 * @dp_size: size of joined device-path
1288 * @initrd_dp: initrd device-path or NULL
1289 * @fdt_dp: device-tree device-path or NULL
1290 * Return: status_code
1291 */
1292efi_status_t efi_load_option_dp_join(struct efi_device_path **dp,
1293 size_t *dp_size,
1294 struct efi_device_path *initrd_dp,
1295 struct efi_device_path *fdt_dp);
1296
Heinrich Schuchardt1a41ca42024-04-26 16:13:18 +02001297int efi_get_distro_fdt_name(char *fname, int size, int seq);
1298
Heinrich Schuchardt8257f162024-07-13 13:30:29 +02001299void efi_load_distro_fdt(efi_handle_t handle, void **fdt, efi_uintn_t *fdt_size);
Heinrich Schuchardtd9b23632024-04-26 16:13:21 +02001300
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02001301#endif /* _EFI_LOADER_H */