blob: f6651e2c6040506226496dac242bcc162ee0d07d [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Grafcb149c62016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Grafcb149c62016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafbee91162016-03-04 01:09:59 +010011#include <common.h>
Simon Glasse6f6f9e2020-05-10 11:39:58 -060012#include <blk.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060013#include <log.h>
Alexander Grafcb149c62016-03-04 01:09:58 +010014#include <part_efi.h>
15#include <efi_api.h>
AKASHI Takahirod9f33072020-04-21 09:38:38 +090016#include <image.h>
AKASHI Takahiro4540dab2020-04-14 11:51:44 +090017#include <pe.h>
Simon Glass6e3c6542021-07-02 12:36:16 -060018#include <linux/list.h>
19#include <linux/oid_registry.h>
Alexander Grafbee91162016-03-04 01:09:59 +010020
Simon Glasse6f6f9e2020-05-10 11:39:58 -060021struct blk_desc;
AKASHI Takahiro86a3d432021-07-20 14:57:02 +090022struct jmp_buf_data;
Simon Glasse6f6f9e2020-05-10 11:39:58 -060023
Simon Glassfdeb6f72019-09-25 08:11:32 -060024static inline int guidcmp(const void *g1, const void *g2)
25{
26 return memcmp(g1, g2, sizeof(efi_guid_t));
27}
28
Sughosh Ganu61e42d92019-12-29 00:01:04 +053029static inline void *guidcpy(void *dst, const void *src)
30{
31 return memcpy(dst, src, sizeof(efi_guid_t));
32}
33
Stephen Warren9b5e6392018-08-30 15:43:43 -060034#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafbee91162016-03-04 01:09:59 +010035
Simon Glass6e3c6542021-07-02 12:36:16 -060036/**
37 * __efi_runtime_data - declares a non-const variable for EFI runtime section
38 *
39 * This macro indicates that a variable is non-const and should go into the
40 * EFI runtime section, and thus still be available when the OS is running.
41 *
42 * Only use on variables not declared const.
43 *
44 * Example:
45 *
46 * ::
47 *
48 * static __efi_runtime_data my_computed_table[256];
49 */
50#define __efi_runtime_data __section(".data.efi_runtime")
51
52/**
53 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
54 *
55 * This macro indicates that a variable is read-only (const) and should go into
56 * the EFI runtime section, and thus still be available when the OS is running.
57 *
58 * Only use on variables also declared const.
59 *
60 * Example:
61 *
62 * ::
63 *
64 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
65 */
66#define __efi_runtime_rodata __section(".rodata.efi_runtime")
67
68/**
69 * __efi_runtime - declares a function for EFI runtime section
70 *
71 * This macro indicates that a function should go into the EFI runtime section,
72 * and thus still be available when the OS is running.
73 *
74 * Example:
75 *
76 * ::
77 *
78 * static __efi_runtime compute_my_table(void);
79 */
80#define __efi_runtime __section(".text.efi_runtime")
81
82/*
83 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
84 * to make it available at runtime
85 */
86efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
87
88/*
89 * Special case handler for error/abort that just tries to dtrt to get
90 * back to u-boot world
91 */
92void efi_restore_gd(void);
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 Grafcb149c62016-03-04 01:09:58 +0100128
Heinrich Schuchardt4182a122018-06-28 12:45:32 +0200129/* Maximum number of configuration tables */
130#define EFI_MAX_CONFIGURATION_TABLES 16
131
Heinrich Schuchardt4e6b5d62018-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 Takahiro23ad52f2019-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 Schuchardt19ecced2020-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 Schuchardt4e6b5d62018-09-20 21:58:23 +0200144
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100145/* Use internal device tree when starting UEFI application */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100146#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt7a597252019-11-28 06:46:09 +0100147
AKASHI Takahiroa2a4bc32019-04-16 13:24:20 +0900148/* Root node */
149extern efi_handle_t efi_root;
150
Heinrich Schuchardt15b1bf12020-03-19 18:21:58 +0000151/* Set to EFI_SUCCESS when initialized */
152extern efi_status_t efi_obj_list_initialized;
153
Heinrich Schuchardtfccd3d92020-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 Schuchardt11078bb2020-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 Clarkc160d2f2017-07-27 08:04:18 -0400164int __efi_entry_check(void);
165int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200166const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -0400167const char *__efi_nesting_inc(void);
168const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400169
Rob Clarka095aad2017-07-27 08:04:17 -0400170/*
171 * Enter the u-boot world from UEFI:
172 */
Alexander Grafbee91162016-03-04 01:09:59 +0100173#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400174 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400175 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
176 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +0100177 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +0100178
Rob Clarka095aad2017-07-27 08:04:17 -0400179/*
180 * Exit the u-boot world back to UEFI:
181 */
Rob Clark804b1d72017-07-24 10:31:52 -0400182#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200183 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -0400184 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +0200185 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400186 assert(__efi_exit_check()); \
187 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -0400188 })
Alexander Grafbee91162016-03-04 01:09:59 +0100189
Rob Clarka095aad2017-07-27 08:04:17 -0400190/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200191 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -0400192 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200193#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:
205 */
206#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -0400207 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400208 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -0400209 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400210 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400211 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -0400212 } while(0)
213
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200214/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100215 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200216 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100217#define EFI_PRINT(format, ...) ({ \
218 debug("%sEFI: " format, __efi_nesting(), \
219 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200220 })
221
Alexander Graf89aea432018-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 Schuchardt1fcb7ea2018-07-02 12:53:55 +0200229/* Key identifying current memory map */
230extern efi_uintn_t efi_memory_map_key;
231
Alexander Graf50149ea2016-03-04 01:10:01 +0100232extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100233extern struct efi_system_table systab;
234
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200235extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200236extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200237extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200238extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-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 Schuchardtb1b782d2019-05-16 18:19:00 +0200242/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200243extern const struct efi_unicode_collation_protocol
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200244 efi_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-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 Lindholmc9bfb222019-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 Grafc1311ad2016-03-04 01:10:00 +0100249
Rob Clarkadae4312017-09-13 18:05:30 -0400250uint16_t *efi_dp_str(struct efi_device_path *dp);
251
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200252/* GUID of the U-Boot root node */
253extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro23ad52f2019-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 Schuchardtb3dd14b2018-01-19 20:24:45 +0100258/* GUID of the EFI_BLOCK_IO_PROTOCOL */
259extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400260extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100261extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100262extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt90dcd9b2022-03-19 07:04:03 +0100263/* GUID of the EFI system partition */
264extern const efi_guid_t efi_system_partition_guid;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100265/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
266extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-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 Schuchardtbc4f9132018-03-03 15:29:03 +0100277/* GUID of the device tree table */
278extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100279extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900280extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200281extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-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 Schuchardt9e6835e2018-04-04 15:42:11 +0200284/* GUID for file system information */
285extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100286extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200287/* GUID of the deprecated Unicode collation protocol */
288extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardtb6f11092020-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 Schuchardt0bc4b0d2018-09-04 19:34:58 +0200292/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200293extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-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 Lindholmc9bfb222019-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 Takahiro593e17d2020-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 Apalodimasb436cc62022-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 Takahiro767f6ee2020-04-14 11:51:41 +0900305extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100306
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530307/* GUID of RNG protocol */
308extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900309/* GUID of capsule update result */
310extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900311/* GUID of firmware management protocol */
312extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinho64a8aae2021-03-02 17:26:38 +0000313/* GUID for the ESRT */
314extern const efi_guid_t efi_esrt_guid;
Masahisa Kojima3d49ee82021-10-26 17:27:24 +0900315/* GUID of the SMBIOS table */
316extern const efi_guid_t smbios_guid;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530317
Marek Behún2bdc6f52021-05-20 13:23:56 +0200318extern char __efi_runtime_start[], __efi_runtime_stop[];
319extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf50149ea2016-03-04 01:10:01 +0100320
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200321/**
322 * struct efi_open_protocol_info_item - open protocol info item
323 *
Heinrich Schuchardtfe1599d2018-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 Schuchardt1f1075c2019-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 Schuchardtfe1599d2018-01-11 08:15:57 +0100329 */
330struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100331 struct list_head link;
332 struct efi_open_protocol_info_entry info;
333};
334
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200335/**
336 * struct efi_handler - single protocol interface of a handle
337 *
Alexander Grafbee91162016-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 Schuchardtfe1599d2018-01-11 08:15:57 +0100340 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-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 Schuchardtc6f077a2021-02-25 08:02:37 +0100345 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100346 */
Alexander Grafbee91162016-03-04 01:09:59 +0100347struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100348 struct list_head link;
Heinrich Schuchardt66028932022-03-09 19:56:23 +0100349 const efi_guid_t guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200350 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100351 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100352};
353
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200354/**
Heinrich Schuchardtcd73aba2019-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 Schuchardtc6f077a2021-02-25 08:02:37 +0100361 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200362 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100363 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200364 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100365 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200366 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100367 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200368 EFI_OBJECT_TYPE_STARTED_IMAGE,
369};
370
371/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200372 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100373 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200374 * @link: pointers to put the handle into a linked list
375 * @protocols: linked list with the protocol interfaces installed on this
376 * handle
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100377 * @type: image type if the handle relates to an image
Heinrich Schuchardtfae01182018-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.
385 *
386 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
387 * has been created for such pointers.
Alexander Grafbee91162016-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 Schuchardt69fb6b12017-11-26 14:05:17 +0100392 /* The list of protocols */
393 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200394 enum efi_object_type type;
Alexander Grafbee91162016-03-04 01:09:59 +0100395};
396
AKASHI Takahiro4540dab2020-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.dec6841592017-07-18 20:17:18 +0200402/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200403 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200404 *
405 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-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 Schuchardt0ce3fb52020-12-28 22:42:51 +0100409 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200410 * @entry: entry address of the relocated image
Heinrich Schuchardt0ce3fb52020-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 Schuchardtc9828742018-09-23 17:21:51 +0200413 */
414struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200415 struct efi_object header;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100416 efi_status_t *exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200417 efi_uintn_t *exit_data_size;
418 u16 **exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100419 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200420 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
421 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200422 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900423 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200424};
425
426/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200427 * struct efi_event
428 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100429 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200430 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200431 * @type: Type of event, see efi_create_event
432 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100433 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200434 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100435 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100436 * @trigger_time: Period of the timer
437 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200438 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100439 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200440 */
441struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100442 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200443 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200444 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100445 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200446 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
447 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100448 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200449 u64 trigger_next;
450 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200451 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200452 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200453};
454
Alexander Grafbee91162016-03-04 01:09:59 +0100455/* This list contains all UEFI objects we know of */
456extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100457/* List of all events */
458extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100459
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200460/**
Heinrich Schuchardtf09cea32019-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 Schuchardtc6f077a2021-02-25 08:02:37 +0100476 * struct efi_register_notify_event - event registered by
477 * RegisterProtocolNotify()
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200478 *
479 * The address of this structure serves as registration value.
480 *
Heinrich Schuchardtf09cea32019-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 Schuchardtab15d412019-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 Schuchardtf09cea32019-05-21 18:19:01 +0200492 struct list_head handles;
Heinrich Schuchardtab15d412019-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 Takahiroa57ad202022-04-19 10:05:11 +0900498/* called at pre-initialization */
499int efi_init_early(void);
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100500/* Initialize efi execution environment */
501efi_status_t efi_init_obj_list(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100502/* Install device tree */
503efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-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 Schuchardt88192092019-06-20 13:52:16 +0200506/* Initialize variable services */
507efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200508/* Notify ExitBootServices() is called */
509void efi_variables_boot_exit_notify(void);
Masahisa Kojimafdff03e2021-08-13 16:12:41 +0900510efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900511/* Measure efi application invocation */
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900512efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900513/* Measure efi application exit */
514efi_status_t efi_tcg2_measure_efi_app_exit(void);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200515/* Called by bootefi to initialize root node */
516efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200517/* Called by bootefi to initialize runtime */
518efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200519/* efi_runtime_detach() - detach unimplemented runtime functions */
520void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-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 Schuchardt94686f62020-12-13 10:30:24 +0100524/* Carve out DT reserved memory ranges */
525void efi_carve_out_dt_rsv(void *fdt);
Ilias Apalodimasa2f14822022-01-03 14:07:37 +0200526/* Purge unused kaslr-seed */
527void efi_try_purge_kaslr_seed(void *fdt);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200528/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200529efi_status_t efi_console_register(void);
AKASHI Takahiroa9bf0242022-04-19 10:05:12 +0900530/* Called by efi_init_obj_list() to initialize efi_disks */
531efi_status_t efi_disk_init(void);
Heinrich Schuchardtb59c13d2020-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 Apalodimasc1c02102020-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 L1ccf8712022-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 Kojima54bec172021-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 Kojima163a0d72021-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 Schuchardt64e4db02018-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 Grafbe8d3242016-03-15 18:38:21 +0100548/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100549efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200550/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100551efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200552/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100553efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200554efi_status_t efi_initrd_register(void);
Ilias Apalodimas53f6a5a2021-03-17 21:55:00 +0200555void efi_initrd_deregister(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200556/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600557/**
Bin Meng86df34d2018-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 Schuchardt185f8122022-01-19 18:05:50 +0100562 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Bin Meng86df34d2018-06-27 20:38:03 -0700563 */
564efi_status_t efi_acpi_register(void);
565/**
Simon Glass0864c562018-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 Schuchardt185f8122022-01-19 18:05:50 +0100570 * Return: 0 if OK, -ENOMEM if no memory is available for the tables
Simon Glass0864c562018-05-16 09:42:19 -0600571 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100572efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200573
Rob Clark2a920802017-09-13 18:05:34 -0400574struct efi_simple_file_system_protocol *
575efi_fs_from_path(struct efi_device_path *fp);
576
Heinrich Schuchardtb3d60902017-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 Graf0efe1bc2016-05-06 21:01:01 +0200579
Alexander Grafbee91162016-03-04 01:09:59 +0100580/* Called from places to check whether a timer expired */
581void efi_timer_check(void);
Heinrich Schuchardt5dad05a2021-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 Grafbee91162016-03-04 01:09:59 +0100584/* PE loader implementation */
AKASHI Takahiro4540dab2020-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 Schuchardt8f7e2b22018-12-26 12:49:09 +0100587 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100588/* Called once to store the pristine gd pointer */
589void efi_save_gd(void);
Alexander Graf50149ea2016-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 Schuchardt44549d62017-11-26 14:05:23 +0100592/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200593void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200594/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100595efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100596/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200597void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100598/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100599struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod8465ff2022-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 Takahirod7e0b012019-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 Schuchardtf69d63f2018-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 Takahirod7e0b012019-03-05 14:53:31 +0900615/* Unload image */
616efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200617/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100618efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-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 Schuchardt2074f702018-01-11 08:16:09 +0100622efi_status_t efi_add_protocol(const efi_handle_t handle,
623 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200624 void *protocol_interface);
Heinrich Schuchardtf9ad2402020-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 Schuchardt3f79a2b2017-10-26 19:25:53 +0200630/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100631efi_status_t efi_remove_protocol(const efi_handle_t handle,
632 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200633 void *protocol_interface);
634/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100635efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt7657ae12019-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 Takahirob51ec632020-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.de49deb452017-07-18 20:17:20 +0200653/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100654efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200655 void (EFIAPI *notify_function) (
656 struct efi_event *event,
657 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100658 void *notify_context, efi_guid_t *group,
659 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200660/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200661efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200662 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200663/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200664void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100665
AKASHI Takahiro05f391e2022-05-12 11:29:01 +0900666/* return true if the device is removable */
667bool efi_disk_is_removable(efi_handle_t handle);
668
Rob Clark2a920802017-09-13 18:05:34 -0400669/* open file system: */
670struct efi_simple_file_system_protocol *efi_simple_file_system(
671 struct blk_desc *desc, int part, struct efi_device_path *dp);
672
673/* open file from device-path: */
674struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
675
Jose Marinho64a8aae2021-03-02 17:26:38 +0000676/* Registers a callback function for a notification event. */
677efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
678 struct efi_event *event,
679 void **registration);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200680efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
681
682/* get a device path from a Boot#### option */
683struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
684
Ilias Apalodimasb436cc62022-05-06 15:36:00 +0300685/* get len, string (used in u-boot crypto from a guid */
686const char *guid_to_sha_str(const efi_guid_t *guid);
687int algo_to_len(const char *algo);
688
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100689/**
690 * efi_size_in_pages() - convert size in bytes to size in pages
691 *
692 * This macro returns the number of EFI memory pages required to hold 'size'
693 * bytes.
694 *
695 * @size: size in bytes
696 * Return: size in pages
697 */
Heinrich Schuchardt0a7e5162021-01-17 07:52:09 +0100698#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100699/* Generic EFI memory allocator, call this to get memory */
700void *efi_alloc(uint64_t len, int memory_type);
Ilias Apalodimasebdea882021-10-11 15:10:23 +0300701/* Allocate pages on the specified alignment */
702void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf5d009952016-03-04 01:10:04 +0100703/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200704efi_status_t efi_allocate_pages(enum efi_allocate_type type,
705 enum efi_memory_type memory_type,
706 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200707/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100708efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200709/* EFI memory allocator for small allocations */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200710efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
711 efi_uintn_t size, void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200712/* EFI pool memory free function. */
713efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100714/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100715efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100716 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100717 efi_uintn_t *map_key,
718 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100719 uint32_t *descriptor_version);
720/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200721efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000722/* Adds a conventional range into the EFI memory map */
723efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
724 u64 ram_top);
725
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100726/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100727efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100728/* Called by board init to initialize the EFI memory map */
729int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200730/* Adds new or overrides configuration table entry to the system table */
731efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100732/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200733efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
734 struct efi_device_path *file_path,
735 struct efi_loaded_image_obj **handle_ptr,
736 struct efi_loaded_image **info_ptr);
Alexander Graf5d009952016-03-04 01:10:04 +0100737
Alexander Graf51735ae2016-05-11 18:25:48 +0200738#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
739extern void *efi_bounce_buffer;
740#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
741#endif
742
Heinrich Schuchardt83994882022-02-26 12:10:10 +0100743/* shorten device path */
744struct efi_device_path *efi_dp_shorten(struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400745struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200746int efi_dp_match(const struct efi_device_path *a,
747 const struct efi_device_path *b);
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100748efi_handle_t efi_dp_find_obj(struct efi_device_path *dp,
Heinrich Schuchardte46ef1d2022-03-19 06:35:43 +0100749 const efi_guid_t *guid,
Heinrich Schuchardtc4095932022-03-04 08:20:00 +0100750 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200751/* get size of the first device path instance excluding end node */
752efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
753/* size of multi-instance device path excluding end node */
754efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400755struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
756struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
757 const struct efi_device_path *dp2);
758struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
759 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200760/* Create a device path node of given type, sub-type, length */
761struct efi_device_path *efi_dp_create_device_node(const u8 type,
762 const u8 sub_type,
763 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200764/* Append device path instance */
765struct efi_device_path *efi_dp_append_instance(
766 const struct efi_device_path *dp,
767 const struct efi_device_path *dpi);
768/* Get next device path instance */
769struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
770 efi_uintn_t *size);
771/* Check if a device path contains muliple instances */
772bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400773
Rob Clarkb66c60d2017-09-13 18:05:28 -0400774struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100775/* Create a device node for a block device partition. */
776struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400777struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
778 const char *path);
779struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400780struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
781 uint64_t start_address,
782 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100783/* Determine the last device path node that is not the end node. */
784const struct efi_device_path *efi_dp_last_node(
785 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100786efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
787 struct efi_device_path **device_path,
788 struct efi_device_path **file_path);
Heinrich Schuchardt3c95b322022-02-04 20:47:09 +0100789struct efi_device_path *efi_dp_from_uart(void);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900790efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
791 const char *path,
792 struct efi_device_path **device,
793 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200794ssize_t efi_dp_check_length(const struct efi_device_path *dp,
795 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400796
797#define EFI_DP_TYPE(_dp, _type, _subtype) \
798 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
799 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
800
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900801/* Indicate supported runtime services */
802efi_status_t efi_init_runtime_supported(void);
803
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200804/* Update CRC32 in table header */
805void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
806
Alexander Graf80a48002016-08-16 21:08:45 +0200807/* Boards may provide the functions below to implement RTS functionality */
808
Alexander Graf3c63db92016-10-14 13:45:30 +0200809void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200810 enum efi_reset_type reset_type,
811 efi_status_t reset_status,
812 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100813
814/* Architecture specific initialization of the EFI subsystem */
815efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200816
Alexander Graf3c63db92016-10-14 13:45:30 +0200817efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200818 struct efi_time *time,
819 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200820
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200821efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
822
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200823#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
824/*
825 * Entry point for the tests of the EFI API.
826 * It is called by 'bootefi selftest'
827 */
828efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
829 struct efi_system_table *systab);
830#endif
831
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100832efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
833 const efi_guid_t *vendor, u32 *attributes,
834 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200835efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
836 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100837 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100838efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
839 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100840 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400841
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200842efi_status_t EFIAPI efi_query_variable_info(
843 u32 attributes, u64 *maximum_variable_storage_size,
844 u64 *remaining_variable_storage_size,
845 u64 *maximum_variable_size);
846
Heinrich Schuchardtd47671c2021-09-09 07:12:14 +0200847void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200848
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900849/*
850 * See section 3.1.3 in the v2.7 UEFI spec for more details on
851 * the layout of EFI_LOAD_OPTION. In short it is:
852 *
853 * typedef struct _EFI_LOAD_OPTION {
854 * UINT32 Attributes;
855 * UINT16 FilePathListLength;
856 * // CHAR16 Description[]; <-- variable length, NULL terminated
857 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
858 * <-- FilePathListLength bytes
859 * // UINT8 OptionalData[];
860 * } EFI_LOAD_OPTION;
861 */
862struct efi_load_option {
863 u32 attributes;
864 u16 file_path_length;
865 u16 *label;
866 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200867 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900868};
869
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200870struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt04217352021-10-15 01:31:02 +0200871 const efi_guid_t *guid);
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200872struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
873 const struct efi_device_path *dp2);
Masahisa Kojimace3dbc52021-10-26 17:27:25 +0900874struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200875efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
876 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900877unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200878efi_status_t efi_set_load_options(efi_handle_t handle,
879 efi_uintn_t load_options_size,
880 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200881efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400882
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900883/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100884 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900885 *
886 * @max: Maximum number of regions
887 * @num: Number of regions
888 * @reg: array of regions
889 */
890struct efi_image_regions {
891 int max;
892 int num;
893 struct image_region reg[];
894};
895
896/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100897 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900898 *
899 * This structure represents an internal form of signature in
900 * signature database. A listed list may represent a signature list.
901 *
902 * @next: Pointer to next entry
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100903 * @owner: Signature owner
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900904 * @data: Pointer to signature data
905 * @size: Size of signature data
906 */
907struct efi_sig_data {
908 struct efi_sig_data *next;
909 efi_guid_t owner;
910 void *data;
911 size_t size;
912};
913
914/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100915 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900916 *
917 * This structure represents an internal form of signature database.
918 *
919 * @next: Pointer to next entry
920 * @sig_type: Signature type
921 * @sig_data_list: Pointer to signature list
922 */
923struct efi_signature_store {
924 struct efi_signature_store *next;
925 efi_guid_t sig_type;
926 struct efi_sig_data *sig_data_list;
927};
928
929struct x509_certificate;
930struct pkcs7_message;
931
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900932bool efi_signature_lookup_digest(struct efi_image_regions *regs,
Ilias Apalodimas4b634312022-01-29 00:20:31 +0200933 struct efi_signature_store *db,
934 bool dbx);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +0900935bool efi_signature_verify(struct efi_image_regions *regs,
936 struct pkcs7_message *msg,
937 struct efi_signature_store *db,
938 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +0900939static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
940 struct pkcs7_message *msg,
941 struct efi_signature_store *db)
942{
943 return efi_signature_verify(regs, msg, db, NULL);
944}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +0900945bool efi_signature_check_signers(struct pkcs7_message *msg,
946 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900947
948efi_status_t efi_image_region_add(struct efi_image_regions *regs,
949 const void *start, const void *end,
950 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900951
952void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganub4f20a52020-12-30 19:27:08 +0530953struct efi_signature_store *efi_build_signature_store(void *sig_list,
954 efi_uintn_t size);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900955struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900956
957bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900958
Sughosh Ganu04be98b2020-12-30 19:27:09 +0530959bool efi_capsule_auth_enabled(void);
960
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900961void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
962
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900963bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
964 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900965
Sughosh Ganu201b8062020-12-30 19:27:07 +0530966struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
967 size_t buflen,
968 u8 **tmpbuf);
969
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +0200970/* runtime implementation of memcpy() */
971void efi_memcpy_runtime(void *dest, const void *src, size_t n);
972
AKASHI Takahiro077153e2020-10-29 13:47:46 +0900973/* commonly used helper function */
Ilias Apalodimasfe179d72020-12-31 12:26:46 +0200974u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
975 unsigned int index);
AKASHI Takahiro077153e2020-10-29 13:47:46 +0900976
AKASHI Takahirof27c2012020-11-30 18:12:12 +0900977extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +0900978extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof27c2012020-11-30 18:12:12 +0900979
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900980/* Capsule update */
981efi_status_t EFIAPI efi_update_capsule(
982 struct efi_capsule_header **capsule_header_array,
983 efi_uintn_t capsule_count,
984 u64 scatter_gather_list);
985efi_status_t EFIAPI efi_query_capsule_caps(
986 struct efi_capsule_header **capsule_header_array,
987 efi_uintn_t capsule_count,
988 u64 *maximum_capsule_size,
989 u32 *reset_type);
990
Sughosh Ganu04be98b2020-12-30 19:27:09 +0530991efi_status_t efi_capsule_authenticate(const void *capsule,
992 efi_uintn_t capsule_size,
993 void **image, efi_uintn_t *image_size);
994
Simon Glass156ccbc2022-01-23 12:55:12 -0700995#define EFI_CAPSULE_DIR u"\\EFI\\UpdateCapsule\\"
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +0900996
Jose Marinho64a8aae2021-03-02 17:26:38 +0000997/**
Sughosh Ganu741ef862022-04-15 11:29:34 +0530998 * struct efi_fw_image - Information on firmware images updatable through
999 * capsule update
1000 *
1001 * This structure gives information about the firmware images on the platform
1002 * which can be updated through the capsule update mechanism
1003 *
1004 * @image_type_id: Image GUID. Same value is to be used in the capsule
1005 * @fw_name: Name of the firmware image
1006 * @image_index: Image Index, same as value passed to SetImage FMP
1007 * function
1008 */
1009struct efi_fw_image {
1010 efi_guid_t image_type_id;
1011 u16 *fw_name;
1012 u8 image_index;
1013};
1014
1015/**
1016 * struct efi_capsule_update_info - Information needed for capsule updates
1017 *
1018 * This structure provides information needed for performing firmware
1019 * updates. The structure needs to be initialised per platform, for all
1020 * platforms which enable capsule updates
1021 *
1022 * @dfu_string: String used to populate dfu_alt_info
1023 * @images: Pointer to an array of updatable images
1024 */
1025struct efi_capsule_update_info {
1026 const char *dfu_string;
1027 struct efi_fw_image *images;
1028};
1029
1030extern struct efi_capsule_update_info update_info;
1031extern u8 num_image_type_guids;
1032
1033/**
Jose Marinho64a8aae2021-03-02 17:26:38 +00001034 * Install the ESRT system table.
1035 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +01001036 * Return: status code
Jose Marinho64a8aae2021-03-02 17:26:38 +00001037 */
1038efi_status_t efi_esrt_register(void);
1039
1040/**
1041 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
1042 * present in the system.
1043 * If an ESRT already exists, the old ESRT is replaced in the system table.
1044 * The memory of the old ESRT is deallocated.
1045 *
1046 * Return:
1047 * - EFI_SUCCESS if the ESRT is correctly created
1048 * - error code otherwise.
1049 */
1050efi_status_t efi_esrt_populate(void);
Ilias Apalodimas6e0184b2021-06-22 17:38:53 +03001051efi_status_t efi_load_capsule_drivers(void);
Ruchika Gupta34287ef2021-11-29 13:09:44 +05301052
1053efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr, u32 *sz);
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +02001054#endif /* _EFI_LOADER_H */