blob: 733ee03cd77a8f69e60e57fdd70da753004ca42f [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Graf4e0c1c12016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf4e0c1c12016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafc15d9212016-03-04 01:09:59 +010011#include <common.h>
Simon Glass655306c2020-05-10 11:39:58 -060012#include <blk.h>
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>
19#include <linux/oid_registry.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010020
Simon Glass655306c2020-05-10 11:39:58 -060021struct blk_desc;
AKASHI Takahiro4cbba2b2021-07-20 14:57:02 +090022struct jmp_buf_data;
Simon Glass655306c2020-05-10 11:39:58 -060023
Simon Glass16fc74a2019-09-25 08:11:32 -060024static inline int guidcmp(const void *g1, const void *g2)
25{
26 return memcmp(g1, g2, sizeof(efi_guid_t));
27}
28
Sughosh Ganu196f66d2019-12-29 00:01:04 +053029static inline void *guidcpy(void *dst, const void *src)
30{
31 return memcpy(dst, src, sizeof(efi_guid_t));
32}
33
Stephen Warrend0de8062018-08-30 15:43:43 -060034#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010035
Simon Glass97f9bd42021-07-02 12:36:16 -060036/**
37 * __efi_runtime_data - declares a non-const variable for EFI runtime section
38 *
39 * This macro indicates that a variable is non-const and should go into the
40 * EFI runtime section, and thus still be available when the OS is running.
41 *
42 * Only use on variables not declared const.
43 *
44 * Example:
45 *
46 * ::
47 *
48 * static __efi_runtime_data my_computed_table[256];
49 */
50#define __efi_runtime_data __section(".data.efi_runtime")
51
52/**
53 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
54 *
55 * This macro indicates that a variable is read-only (const) and should go into
56 * the EFI runtime section, and thus still be available when the OS is running.
57 *
58 * Only use on variables also declared const.
59 *
60 * Example:
61 *
62 * ::
63 *
64 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
65 */
66#define __efi_runtime_rodata __section(".rodata.efi_runtime")
67
68/**
69 * __efi_runtime - declares a function for EFI runtime section
70 *
71 * This macro indicates that a function should go into the EFI runtime section,
72 * and thus still be available when the OS is running.
73 *
74 * Example:
75 *
76 * ::
77 *
78 * static __efi_runtime compute_my_table(void);
79 */
80#define __efi_runtime __section(".text.efi_runtime")
81
82/*
83 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
84 * to make it available at runtime
85 */
86efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
87
88/*
89 * Special case handler for error/abort that just tries to dtrt to get
90 * back to u-boot world
91 */
92void efi_restore_gd(void);
93/* Call this to set the current device name */
94void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
95 void *buffer, size_t buffer_size);
96/* Called by networking code to memorize the dhcp ack package */
97void efi_net_set_dhcp_ack(void *pkt, int len);
98/* Print information about all loaded images */
99void efi_print_image_infos(void *pc);
100
101/* Hook at initialization */
102efi_status_t efi_launch_capsules(void);
103
104#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
105
106/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
107#define __efi_runtime_data
108#define __efi_runtime_rodata
109#define __efi_runtime
110static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
111{
112 return EFI_SUCCESS;
113}
114
115/* No loader configured, stub out EFI_ENTRY */
116static inline void efi_restore_gd(void) { }
117static inline void efi_set_bootdev(const char *dev, const char *devnr,
118 const char *path, void *buffer,
119 size_t buffer_size) { }
120static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
121static inline void efi_print_image_infos(void *pc) { }
122static inline efi_status_t efi_launch_capsules(void)
123{
124 return EFI_SUCCESS;
125}
126
127#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100128
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +0200129/* Maximum number of configuration tables */
130#define EFI_MAX_CONFIGURATION_TABLES 16
131
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200132/* GUID used by the root node */
133#define U_BOOT_GUID \
134 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
135 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900136/* GUID used as host device on sandbox */
137#define U_BOOT_HOST_DEV_GUID \
138 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
139 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardtc770aaa2020-05-20 22:39:35 +0200140/* GUID used as root for virtio devices */
141#define U_BOOT_VIRTIO_DEV_GUID \
142 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
143 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200144
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100145/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100146#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100147
AKASHI Takahiro0b275752019-04-16 13:24:20 +0900148/* Root node */
149extern efi_handle_t efi_root;
150
Heinrich Schuchardtde9bdc62020-03-19 18:21:58 +0000151/* Set to EFI_SUCCESS when initialized */
152extern efi_status_t efi_obj_list_initialized;
153
Heinrich Schuchardt628dbd72020-11-12 21:26:28 +0100154/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
155extern bool efi_st_keep_devices;
156
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100157/* EFI system partition */
158extern struct efi_system_partition {
159 enum if_type if_type;
160 int devnum;
161 u8 part;
162} efi_system_partition;
163
Rob Clark86789d52017-07-27 08:04:18 -0400164int __efi_entry_check(void);
165int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200166const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -0400167const char *__efi_nesting_inc(void);
168const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -0400169
Rob Clark63ea77a2017-07-27 08:04:17 -0400170/*
171 * Enter the u-boot world from UEFI:
172 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100173#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -0400174 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400175 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
176 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +0100177 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +0100178
Rob Clark63ea77a2017-07-27 08:04:17 -0400179/*
180 * Exit the u-boot world back to UEFI:
181 */
Rob Clark84a19a02017-07-24 10:31:52 -0400182#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200183 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -0400184 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200185 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -0400186 assert(__efi_exit_check()); \
187 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -0400188 })
Alexander Grafc15d9212016-03-04 01:09:59 +0100189
Rob Clark63ea77a2017-07-27 08:04:17 -0400190/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200191 * Call non-void UEFI function from u-boot and retrieve return value:
192 */
193#define EFI_CALL(exp) ({ \
194 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
195 assert(__efi_exit_check()); \
196 typeof(exp) _r = exp; \
197 assert(__efi_entry_check()); \
198 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
199 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
200 _r; \
201})
202
203/*
204 * Call void UEFI function from u-boot:
Rob Clark63ea77a2017-07-27 08:04:17 -0400205 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200206#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400207 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400208 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400209 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400210 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400211 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400212 } while(0)
213
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200214/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100215 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200216 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100217#define EFI_PRINT(format, ...) ({ \
218 debug("%sEFI: " format, __efi_nesting(), \
219 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200220 })
221
Alexander Graf59254d62018-04-23 07:59:47 +0200222#ifdef CONFIG_SYS_CACHELINE_SIZE
223#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
224#else
225/* Just use the greatest cache flush alignment requirement I'm aware of */
226#define EFI_CACHELINE_SIZE 128
227#endif
228
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200229/* Key identifying current memory map */
230extern efi_uintn_t efi_memory_map_key;
231
Alexander Graf0bd425a2016-03-04 01:10:01 +0100232extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100233extern struct efi_system_table systab;
234
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200235extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200236extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200237extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200238extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100239/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
240extern const struct efi_device_path_utilities_protocol
241 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200242/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200243extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200244 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900245extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
246extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900247extern const struct efi_hii_database_protocol efi_hii_database;
248extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100249
Rob Clark85dd7212017-09-13 18:05:30 -0400250uint16_t *efi_dp_str(struct efi_device_path *dp);
251
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200252/* GUID of the U-Boot root node */
253extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900254#ifdef CONFIG_SANDBOX
255/* GUID of U-Boot host device on sandbox */
256extern const efi_guid_t efi_guid_host_dev;
257#endif
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100258/* GUID of the EFI_BLOCK_IO_PROTOCOL */
259extern const efi_guid_t efi_block_io_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400260extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100261extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100262extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardte840b9c2022-03-19 07:04:03 +0100263/* GUID of the EFI system partition */
264extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100265/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
266extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +0100267/* event group ExitBootServices() invoked */
268extern const efi_guid_t efi_guid_event_group_exit_boot_services;
269/* event group SetVirtualAddressMap() invoked */
270extern const efi_guid_t efi_guid_event_group_virtual_address_change;
271/* event group memory map changed */
272extern const efi_guid_t efi_guid_event_group_memory_map_change;
273/* event group boot manager about to boot */
274extern const efi_guid_t efi_guid_event_group_ready_to_boot;
275/* event group ResetSystem() invoked (before ExitBootServices) */
276extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +0100277/* GUID of the device tree table */
278extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100279extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900280extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200281extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-09-13 18:05:34 -0400282extern const efi_guid_t efi_simple_file_system_protocol_guid;
283extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt37fb4b92018-04-04 15:42:11 +0200284/* GUID for file system information */
285extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100286extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200287/* GUID of the deprecated Unicode collation protocol */
288extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt485956d2020-12-04 03:33:41 +0100289/* GUIDs of the Load File and Load File2 protocol */
290extern const efi_guid_t efi_guid_load_file_protocol;
291extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200292/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200293extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900294extern const efi_guid_t efi_guid_hii_config_routing_protocol;
295extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900296extern const efi_guid_t efi_guid_hii_database_protocol;
297extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900298/* GUIDs for authentication */
299extern const efi_guid_t efi_guid_image_security_database;
300extern const efi_guid_t efi_guid_sha256;
301extern const efi_guid_t efi_guid_cert_x509;
302extern const efi_guid_t efi_guid_cert_x509_sha256;
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300303extern const efi_guid_t efi_guid_cert_x509_sha384;
304extern const efi_guid_t efi_guid_cert_x509_sha512;
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900305extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100306
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530307/* GUID of RNG protocol */
308extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900309/* GUID of capsule update result */
310extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro0d963782020-11-30 18:12:11 +0900311/* GUID of firmware management protocol */
312extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000313/* GUID for the ESRT */
314extern const efi_guid_t efi_esrt_guid;
Masahisa Kojimacd1fe7d2021-10-26 17:27:24 +0900315/* GUID of the SMBIOS table */
316extern const efi_guid_t smbios_guid;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530317
Marek Behún69504502021-05-20 13:23:56 +0200318extern char __efi_runtime_start[], __efi_runtime_stop[];
319extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf0bd425a2016-03-04 01:10:01 +0100320
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200321/**
322 * struct efi_open_protocol_info_item - open protocol info item
323 *
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100324 * When a protocol is opened a open protocol info entry is created.
325 * These are maintained in a list.
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200326 *
327 * @link: link to the list of open protocol info entries of a protocol
328 * @info: information about the opening of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100329 */
330struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100331 struct list_head link;
332 struct efi_open_protocol_info_entry info;
333};
334
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200335/**
336 * struct efi_handler - single protocol interface of a handle
337 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100338 * When the UEFI payload wants to open a protocol on an object to get its
339 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100340 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200341 *
342 * @link: link to the list of protocols of a handle
343 * @guid: GUID of the protocol
344 * @protocol_interface: protocol interface
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100345 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100346 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100347struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100348 struct list_head link;
Heinrich Schuchardt2a22db92022-03-09 19:56:23 +0100349 const efi_guid_t guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200350 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100351 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100352};
353
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200354/**
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200355 * enum efi_object_type - type of EFI object
356 *
357 * In UnloadImage we must be able to identify if the handle relates to a
358 * started image.
359 */
360enum efi_object_type {
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100361 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200362 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100363 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200364 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100365 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200366 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100367 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200368 EFI_OBJECT_TYPE_STARTED_IMAGE,
369};
370
371/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200372 * struct efi_object - dereferenced EFI handle
373 *
374 * @link: pointers to put the handle into a linked list
375 * @protocols: linked list with the protocol interfaces installed on this
376 * handle
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100377 * @type: image type if the handle relates to an image
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200378 *
379 * UEFI offers a flexible and expandable object model. The objects in the UEFI
380 * API are devices, drivers, and loaded images. struct efi_object is our storage
381 * structure for these objects.
382 *
383 * When including this structure into a larger structure always put it first so
384 * that when deleting a handle the whole encompassing structure can be freed.
Alexander Grafc15d9212016-03-04 01:09:59 +0100385 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200386 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
387 * has been created for such pointers.
Alexander Grafc15d9212016-03-04 01:09:59 +0100388 */
389struct efi_object {
390 /* Every UEFI object is part of a global object list */
391 struct list_head link;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100392 /* The list of protocols */
393 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200394 enum efi_object_type type;
Alexander Grafc15d9212016-03-04 01:09:59 +0100395};
396
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900397enum efi_image_auth_status {
398 EFI_IMAGE_AUTH_FAILED = 0,
399 EFI_IMAGE_AUTH_PASSED,
400};
401
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200402/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200403 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200404 *
405 * @header: EFI object header
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200406 * @exit_status: exit status passed to Exit()
407 * @exit_data_size: exit data size passed to Exit()
408 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100409 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200410 * @entry: entry address of the relocated image
Heinrich Schuchardt93b40d62020-12-28 22:42:51 +0100411 * @image_type: indicates if the image is an applicition or a driver
412 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200413 */
414struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200415 struct efi_object header;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100416 efi_status_t *exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200417 efi_uintn_t *exit_data_size;
418 u16 **exit_data;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100419 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200420 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
421 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200422 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900423 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200424};
425
426/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200427 * struct efi_event
428 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100429 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200430 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200431 * @type: Type of event, see efi_create_event
432 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100433 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200434 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100435 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100436 * @trigger_time: Period of the timer
437 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200438 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100439 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200440 */
441struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100442 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200443 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200444 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100445 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200446 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
447 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100448 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200449 u64 trigger_next;
450 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200451 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200452 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200453};
454
Alexander Grafc15d9212016-03-04 01:09:59 +0100455/* This list contains all UEFI objects we know of */
456extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100457/* List of all events */
458extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100459
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200460/**
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200461 * struct efi_protocol_notification - handle for notified protocol
462 *
463 * When a protocol interface is installed for which an event was registered with
464 * the RegisterProtocolNotify() service this structure is used to hold the
465 * handle on which the protocol interface was installed.
466 *
467 * @link: link to list of all handles notified for this event
468 * @handle: handle on which the notified protocol interface was installed
469 */
470struct efi_protocol_notification {
471 struct list_head link;
472 efi_handle_t handle;
473};
474
475/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100476 * struct efi_register_notify_event - event registered by
477 * RegisterProtocolNotify()
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200478 *
479 * The address of this structure serves as registration value.
480 *
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200481 * @link: link to list of all registered events
482 * @event: registered event. The same event may registered for multiple
483 * GUIDs.
484 * @protocol: protocol for which the event is registered
485 * @handles: linked list of all handles on which the notified protocol was
486 * installed
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200487 */
488struct efi_register_notify_event {
489 struct list_head link;
490 struct efi_event *event;
491 efi_guid_t protocol;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200492 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200493};
494
495/* List of all events registered by RegisterProtocolNotify() */
496extern struct list_head efi_register_notify_events;
497
AKASHI Takahiroa36dc252022-04-19 10:05:11 +0900498/* called at pre-initialization */
499int efi_init_early(void);
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100500/* Initialize efi execution environment */
501efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100502/* Install device tree */
503efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtffb90592019-12-07 20:51:06 +0100504/* Run loaded UEFI image */
505efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardtcf3b1182019-06-20 13:52:16 +0200506/* Initialize variable services */
507efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200508/* Notify ExitBootServices() is called */
509void efi_variables_boot_exit_notify(void);
Masahisa Kojima1ac19bb2021-08-13 16:12:41 +0900510efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900511/* Measure efi application invocation */
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900512efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8173cd42021-08-13 16:12:40 +0900513/* Measure efi application exit */
514efi_status_t efi_tcg2_measure_efi_app_exit(void);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200515/* Called by bootefi to initialize root node */
516efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200517/* Called by bootefi to initialize runtime */
518efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200519/* efi_runtime_detach() - detach unimplemented runtime functions */
520void efi_runtime_detach(void);
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100521/* efi_convert_pointer() - convert pointer to virtual address */
522efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
523 void **address);
Heinrich Schuchardt2c1e2242020-12-13 10:30:24 +0100524/* Carve out DT reserved memory ranges */
525void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimase4e56602022-01-03 14:07:37 +0200526/* Purge unused kaslr-seed */
527void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200528/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200529efi_status_t efi_console_register(void);
AKASHI Takahiro2381f2e2022-04-19 10:05:12 +0900530/* Called by efi_init_obj_list() to initialize efi_disks */
531efi_status_t efi_disk_init(void);
Heinrich Schuchardtc63f68f2020-09-25 12:50:19 +0200532/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
533efi_status_t efi_rng_register(void);
Ilias Apalodimas590fef62020-11-11 11:18:11 +0200534/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
535efi_status_t efi_tcg2_register(void);
Sunil V L279d1c82022-01-28 20:48:44 +0530536/* Called by efi_init_obj_list() to install RISCV_EFI_BOOT_PROTOCOL */
537efi_status_t efi_riscv_register(void);
Masahisa Kojima0fd43792021-12-07 14:15:31 +0900538/* Called by efi_init_obj_list() to do initial measurement */
539efi_status_t efi_tcg2_do_initial_measurement(void);
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900540/* measure the pe-coff image, extend PCR and add Event Log */
541efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
542 struct efi_loaded_image_obj *handle,
543 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100544/* Create handles and protocols for the partitions of a block device */
545int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
546 const char *if_typename, int diskid,
547 const char *pdevname);
Alexander Grafd65783d2016-03-15 18:38:21 +0100548/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100549efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200550/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100551efi_status_t efi_net_register(void);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200552/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100553efi_status_t efi_watchdog_register(void);
Ilias Apalodimas3510ba72020-02-21 09:55:45 +0200554efi_status_t efi_initrd_register(void);
Ilias Apalodimasb307e3d2021-03-17 21:55:00 +0200555void efi_initrd_deregister(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200556/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600557/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700558 * efi_acpi_register() - write out ACPI tables
559 *
560 * Called by bootefi to make ACPI tables available
561 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100562 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng2cfbdae2018-06-27 20:38:03 -0700563 */
564efi_status_t efi_acpi_register(void);
565/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600566 * efi_smbios_register() - write out SMBIOS tables
567 *
568 * Called by bootefi to make SMBIOS tables available
569 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100570 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass2e2858f2018-05-16 09:42:19 -0600571 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100572efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200573
Rob Clark53142032017-09-13 18:05:34 -0400574struct efi_simple_file_system_protocol *
575efi_fs_from_path(struct efi_device_path *fp);
576
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200577/* Called by efi_set_watchdog_timer to reset the timer */
578efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200579
Alexander Grafc15d9212016-03-04 01:09:59 +0100580/* Called from places to check whether a timer expired */
581void efi_timer_check(void);
Heinrich Schuchardtad6e0f72021-01-12 12:40:32 +0100582/* Check if a buffer contains a PE-COFF image */
583efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafc15d9212016-03-04 01:09:59 +0100584/* PE loader implementation */
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900585efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
586 void *efi, size_t efi_size,
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100587 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100588/* Called once to store the pristine gd pointer */
589void efi_save_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100590/* Call this to relocate the runtime section to an address space */
591void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100592/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200593void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200594/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100595efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100596/* Delete handle */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200597void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100598/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100599struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahiro537a6932022-04-28 17:09:38 +0900600/* Locate device_path handle */
601efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
602 struct efi_device_path **device_path,
603 efi_handle_t *device);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900604/* Load image */
605efi_status_t EFIAPI efi_load_image(bool boot_policy,
606 efi_handle_t parent_image,
607 struct efi_device_path *file_path,
608 void *source_buffer,
609 efi_uintn_t source_size,
610 efi_handle_t *image_handle);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100611/* Start image */
612efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
613 efi_uintn_t *exit_data_size,
614 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900615/* Unload image */
616efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200617/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100618efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200619 const efi_guid_t *protocol_guid,
620 struct efi_handler **handler);
621/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100622efi_status_t efi_add_protocol(const efi_handle_t handle,
623 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200624 void *protocol_interface);
Heinrich Schuchardt9c89d142020-01-10 12:33:59 +0100625/* Open protocol */
626efi_status_t efi_protocol_open(struct efi_handler *handler,
627 void **protocol_interface, void *agent_handle,
628 void *controller_handle, uint32_t attributes);
629
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200630/* Delete protocol from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100631efi_status_t efi_remove_protocol(const efi_handle_t handle,
632 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200633 void *protocol_interface);
634/* Delete all protocols from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100635efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200636/* Install multiple protocol interfaces */
637efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
638 (efi_handle_t *handle, ...);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900639/* Get handles that support a given protocol */
640efi_status_t EFIAPI efi_locate_handle_buffer(
641 enum efi_locate_search_type search_type,
642 const efi_guid_t *protocol, void *search_key,
643 efi_uintn_t *no_handles, efi_handle_t **buffer);
644/* Close an previously opened protocol interface */
645efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
646 const efi_guid_t *protocol,
647 efi_handle_t agent_handle,
648 efi_handle_t controller_handle);
649/* Open a protocol interface */
650efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
651 const efi_guid_t *protocol,
652 void **protocol_interface);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200653/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100654efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200655 void (EFIAPI *notify_function) (
656 struct efi_event *event,
657 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100658 void *notify_context, efi_guid_t *group,
659 struct efi_event **event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200660/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200661efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200662 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200663/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200664void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100665
Rob Clark53142032017-09-13 18:05:34 -0400666/* open file system: */
667struct efi_simple_file_system_protocol *efi_simple_file_system(
668 struct blk_desc *desc, int part, struct efi_device_path *dp);
669
670/* open file from device-path: */
671struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
672
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000673/* Registers a callback function for a notification event. */
674efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
675 struct efi_event *event,
676 void **registration);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200677efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
678
679/* get a device path from a Boot#### option */
680struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
681
Ilias Apalodimas34db9b12022-05-06 15:36:00 +0300682/* get len, string (used in u-boot crypto from a guid */
683const char *guid_to_sha_str(const efi_guid_t *guid);
684int algo_to_len(const char *algo);
685
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100686/**
687 * efi_size_in_pages() - convert size in bytes to size in pages
688 *
689 * This macro returns the number of EFI memory pages required to hold 'size'
690 * bytes.
691 *
692 * @size: size in bytes
693 * Return: size in pages
694 */
Heinrich Schuchardtaefb0c42021-01-17 07:52:09 +0100695#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf8623f922016-03-04 01:10:04 +0100696/* Generic EFI memory allocator, call this to get memory */
697void *efi_alloc(uint64_t len, int memory_type);
Ilias Apalodimas6e01c232021-10-11 15:10:23 +0300698/* Allocate pages on the specified alignment */
699void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf8623f922016-03-04 01:10:04 +0100700/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200701efi_status_t efi_allocate_pages(enum efi_allocate_type type,
702 enum efi_memory_type memory_type,
703 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200704/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100705efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200706/* EFI memory allocator for small allocations */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200707efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
708 efi_uintn_t size, void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200709/* EFI pool memory free function. */
710efi_status_t efi_free_pool(void *buffer);
Alexander Graf8623f922016-03-04 01:10:04 +0100711/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100712efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100713 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100714 efi_uintn_t *map_key,
715 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100716 uint32_t *descriptor_version);
717/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200718efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidene009e7a2019-09-03 17:43:43 +0000719/* Adds a conventional range into the EFI memory map */
720efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
721 u64 ram_top);
722
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100723/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100724efi_status_t efi_driver_init(void);
Alexander Graf8623f922016-03-04 01:10:04 +0100725/* Called by board init to initialize the EFI memory map */
726int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200727/* Adds new or overrides configuration table entry to the system table */
728efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100729/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200730efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
731 struct efi_device_path *file_path,
732 struct efi_loaded_image_obj **handle_ptr,
733 struct efi_loaded_image **info_ptr);
Alexander Graf8623f922016-03-04 01:10:04 +0100734
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200735#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
736extern void *efi_bounce_buffer;
737#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
738#endif
739
Heinrich Schuchardt24f0e6a2022-02-26 12:10:10 +0100740/* shorten device path */
741struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400742struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200743int efi_dp_match(const struct efi_device_path *a,
744 const struct efi_device_path *b);
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100745efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardt0a04a412022-03-19 06:35:43 +0100746 const efi_guid_t *guid,
Heinrich Schuchardtad6d5a42022-03-04 08:20:00 +0100747 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200748/* get size of the first device path instance excluding end node */
749efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
750/* size of multi-instance device path excluding end node */
751efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400752struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
753struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
754 const struct efi_device_path *dp2);
755struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
756 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200757/* Create a device path node of given type, sub-type, length */
758struct efi_device_path *efi_dp_create_device_node(const u8 type,
759 const u8 sub_type,
760 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200761/* Append device path instance */
762struct efi_device_path *efi_dp_append_instance(
763 const struct efi_device_path *dp,
764 const struct efi_device_path *dpi);
765/* Get next device path instance */
766struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
767 efi_uintn_t *size);
768/* Check if a device path contains muliple instances */
769bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400770
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400771struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100772/* Create a device node for a block device partition. */
773struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400774struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
775 const char *path);
776struct efi_device_path *efi_dp_from_eth(void);
Rob Clark18ceba72017-10-10 08:23:06 -0400777struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
778 uint64_t start_address,
779 uint64_t end_address);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100780/* Determine the last device path node that is not the end node. */
781const struct efi_device_path *efi_dp_last_node(
782 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100783efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
784 struct efi_device_path **device_path,
785 struct efi_device_path **file_path);
Heinrich Schuchardt81244ea2022-02-04 20:47:09 +0100786struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900787efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
788 const char *path,
789 struct efi_device_path **device,
790 struct efi_device_path **file);
Heinrich Schuchardt22c8e082020-08-23 10:49:46 +0200791ssize_t efi_dp_check_length(const struct efi_device_path *dp,
792 const size_t maxlen);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400793
794#define EFI_DP_TYPE(_dp, _type, _subtype) \
795 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
796 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
797
AKASHI Takahiro32401842019-06-05 13:21:38 +0900798/* Indicate supported runtime services */
799efi_status_t efi_init_runtime_supported(void);
800
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200801/* Update CRC32 in table header */
802void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
803
Alexander Graf77256092016-08-16 21:08:45 +0200804/* Boards may provide the functions below to implement RTS functionality */
805
Alexander Graf393dd912016-10-14 13:45:30 +0200806void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200807 enum efi_reset_type reset_type,
808 efi_status_t reset_status,
809 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100810
811/* Architecture specific initialization of the EFI subsystem */
812efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200813
Alexander Graf393dd912016-10-14 13:45:30 +0200814efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200815 struct efi_time *time,
816 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200817
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200818efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
819
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200820#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
821/*
822 * Entry point for the tests of the EFI API.
823 * It is called by 'bootefi selftest'
824 */
825efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
826 struct efi_system_table *systab);
827#endif
828
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100829efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
830 const efi_guid_t *vendor, u32 *attributes,
831 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200832efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
833 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100834 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100835efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
836 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100837 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400838
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200839efi_status_t EFIAPI efi_query_variable_info(
840 u32 attributes, u64 *maximum_variable_storage_size,
841 u64 *remaining_variable_storage_size,
842 u64 *maximum_variable_size);
843
Heinrich Schuchardt1ad2f0d2021-09-09 07:12:14 +0200844void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200845
AKASHI Takahirobd237742018-11-05 18:06:41 +0900846/*
847 * See section 3.1.3 in the v2.7 UEFI spec for more details on
848 * the layout of EFI_LOAD_OPTION. In short it is:
849 *
850 * typedef struct _EFI_LOAD_OPTION {
851 * UINT32 Attributes;
852 * UINT16 FilePathListLength;
853 * // CHAR16 Description[]; <-- variable length, NULL terminated
854 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
855 * <-- FilePathListLength bytes
856 * // UINT8 OptionalData[];
857 * } EFI_LOAD_OPTION;
858 */
859struct efi_load_option {
860 u32 attributes;
861 u16 file_path_length;
862 u16 *label;
863 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +0200864 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +0900865};
866
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200867struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt9979cff2021-10-15 01:31:02 +0200868 const efi_guid_t *guid);
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200869struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
870 const struct efi_device_path *dp2);
Masahisa Kojima6460c3e2021-10-26 17:27:25 +0900871struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt7ca84f82020-05-31 22:46:09 +0200872efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
873 efi_uintn_t *size);
AKASHI Takahirobd237742018-11-05 18:06:41 +0900874unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt25c6be52020-08-07 17:47:13 +0200875efi_status_t efi_set_load_options(efi_handle_t handle,
876 efi_uintn_t load_options_size,
877 void *load_options);
Heinrich Schuchardta7647a72020-08-07 17:49:39 +0200878efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clarkc84c1102017-09-13 18:05:38 -0400879
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900880/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100881 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900882 *
883 * @max: Maximum number of regions
884 * @num: Number of regions
885 * @reg: array of regions
886 */
887struct efi_image_regions {
888 int max;
889 int num;
890 struct image_region reg[];
891};
892
893/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100894 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900895 *
896 * This structure represents an internal form of signature in
897 * signature database. A listed list may represent a signature list.
898 *
899 * @next: Pointer to next entry
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100900 * @owner: Signature owner
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900901 * @data: Pointer to signature data
902 * @size: Size of signature data
903 */
904struct efi_sig_data {
905 struct efi_sig_data *next;
906 efi_guid_t owner;
907 void *data;
908 size_t size;
909};
910
911/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100912 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900913 *
914 * This structure represents an internal form of signature database.
915 *
916 * @next: Pointer to next entry
917 * @sig_type: Signature type
918 * @sig_data_list: Pointer to signature list
919 */
920struct efi_signature_store {
921 struct efi_signature_store *next;
922 efi_guid_t sig_type;
923 struct efi_sig_data *sig_data_list;
924};
925
926struct x509_certificate;
927struct pkcs7_message;
928
AKASHI Takahirode924072020-07-08 14:01:57 +0900929bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas71eae982022-01-29 00:20:31 +0200930 struct efi_signature_store *db,
931 bool dbx);
AKASHI Takahiro14afd062020-07-21 19:35:22 +0900932bool efi_signature_verify(struct efi_image_regions *regs,
933 struct pkcs7_message *msg,
934 struct efi_signature_store *db,
935 struct efi_signature_store *dbx);
AKASHI Takahiro16411802020-08-14 14:39:23 +0900936static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
937 struct pkcs7_message *msg,
938 struct efi_signature_store *db)
939{
940 return efi_signature_verify(regs, msg, db, NULL);
941}
AKASHI Takahiro4154b642020-07-08 14:01:56 +0900942bool efi_signature_check_signers(struct pkcs7_message *msg,
943 struct efi_signature_store *dbx);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900944
945efi_status_t efi_image_region_add(struct efi_image_regions *regs,
946 const void *start, const void *end,
947 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900948
949void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganufa0faa62020-12-30 19:27:08 +0530950struct efi_signature_store *efi_build_signature_store(void *sig_list,
951 efi_uintn_t size);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900952struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900953
954bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900955
Sughosh Ganu586bb982020-12-30 19:27:09 +0530956bool efi_capsule_auth_enabled(void);
957
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900958void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
959
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900960bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
961 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900962
Sughosh Ganuea350082020-12-30 19:27:07 +0530963struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
964 size_t buflen,
965 u8 **tmpbuf);
966
Heinrich Schuchardt8cd99752020-06-28 16:30:29 +0200967/* runtime implementation of memcpy() */
968void efi_memcpy_runtime(void *dest, const void *src, size_t n);
969
AKASHI Takahiro94074682020-10-29 13:47:46 +0900970/* commonly used helper function */
Ilias Apalodimas21575292020-12-31 12:26:46 +0200971u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
972 unsigned int index);
AKASHI Takahiro94074682020-10-29 13:47:46 +0900973
AKASHI Takahirof4818e62020-11-30 18:12:12 +0900974extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahiro7ff3f3c2020-11-17 09:28:00 +0900975extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof4818e62020-11-30 18:12:12 +0900976
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900977/* Capsule update */
978efi_status_t EFIAPI efi_update_capsule(
979 struct efi_capsule_header **capsule_header_array,
980 efi_uintn_t capsule_count,
981 u64 scatter_gather_list);
982efi_status_t EFIAPI efi_query_capsule_caps(
983 struct efi_capsule_header **capsule_header_array,
984 efi_uintn_t capsule_count,
985 u64 *maximum_capsule_size,
986 u32 *reset_type);
987
Sughosh Ganu586bb982020-12-30 19:27:09 +0530988efi_status_t efi_capsule_authenticate(const void *capsule,
989 efi_uintn_t capsule_size,
990 void **image, efi_uintn_t *image_size);
991
Simon Glass90975372022-01-23 12:55:12 -0700992#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiro45b819542020-11-17 09:27:56 +0900993
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000994/**
Sughosh Ganuccb36462022-04-15 11:29:34 +0530995 * struct efi_fw_image - Information on firmware images updatable through
996 * capsule update
997 *
998 * This structure gives information about the firmware images on the platform
999 * which can be updated through the capsule update mechanism
1000 *
1001 * @image_type_id: Image GUID. Same value is to be used in the capsule
1002 * @fw_name: Name of the firmware image
1003 * @image_index: Image Index, same as value passed to SetImage FMP
1004 * function
1005 */
1006struct efi_fw_image {
1007 efi_guid_t image_type_id;
1008 u16 *fw_name;
1009 u8 image_index;
1010};
1011
1012/**
1013 * struct efi_capsule_update_info - Information needed for capsule updates
1014 *
1015 * This structure provides information needed for performing firmware
1016 * updates. The structure needs to be initialised per platform, for all
1017 * platforms which enable capsule updates
1018 *
1019 * @dfu_string: String used to populate dfu_alt_info
1020 * @images: Pointer to an array of updatable images
1021 */
1022struct efi_capsule_update_info {
1023 const char *dfu_string;
1024 struct efi_fw_image *images;
1025};
1026
1027extern struct efi_capsule_update_info update_info;
1028extern u8 num_image_type_guids;
1029
1030/**
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001031 * Install the ESRT system table.
1032 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +01001033 * Return: status code
Jose Marinhoebb61ee2021-03-02 17:26:38 +00001034 */
1035efi_status_t efi_esrt_register(void);
1036
1037/**
1038 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1039 * present in the system.
1040 * If an ESRT already exists, the old ESRT is replaced in the system table.
1041 * The memory of the old ESRT is deallocated.
1042 *
1043 * Return:
1044 * - EFI_SUCCESS if the ESRT is correctly created
1045 * - error code otherwise.
1046 */
1047efi_status_t efi_esrt_populate(void);
Ilias Apalodimasfac773e2021-06-22 17:38:53 +03001048efi_status_t efi_load_capsule_drivers(void);
Ruchika Guptabc9495c2021-11-29 13:09:44 +05301049
1050efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02001051#endif /* _EFI_LOADER_H */