blob: c440962fe522c173dd29de644c51b2a31c7a16d8 [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 Schuchardtf0959db2018-01-11 08:16:02 +0100263/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
264extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100265/* event group ExitBootServices() invoked */
266extern const efi_guid_t efi_guid_event_group_exit_boot_services;
267/* event group SetVirtualAddressMap() invoked */
268extern const efi_guid_t efi_guid_event_group_virtual_address_change;
269/* event group memory map changed */
270extern const efi_guid_t efi_guid_event_group_memory_map_change;
271/* event group boot manager about to boot */
272extern const efi_guid_t efi_guid_event_group_ready_to_boot;
273/* event group ResetSystem() invoked (before ExitBootServices) */
274extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100275/* GUID of the device tree table */
276extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100277extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900278extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200279extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400280extern const efi_guid_t efi_simple_file_system_protocol_guid;
281extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200282/* GUID for file system information */
283extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100284extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200285/* GUID of the deprecated Unicode collation protocol */
286extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardtb6f11092020-12-04 03:33:41 +0100287/* GUIDs of the Load File and Load File2 protocol */
288extern const efi_guid_t efi_guid_load_file_protocol;
289extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200290/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200291extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900292extern const efi_guid_t efi_guid_hii_config_routing_protocol;
293extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900294extern const efi_guid_t efi_guid_hii_database_protocol;
295extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900296/* GUIDs for authentication */
297extern const efi_guid_t efi_guid_image_security_database;
298extern const efi_guid_t efi_guid_sha256;
299extern const efi_guid_t efi_guid_cert_x509;
300extern const efi_guid_t efi_guid_cert_x509_sha256;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900301extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100302
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530303/* GUID of RNG protocol */
304extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900305/* GUID of capsule update result */
306extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900307/* GUID of firmware management protocol */
308extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinho64a8aae2021-03-02 17:26:38 +0000309/* GUID for the ESRT */
310extern const efi_guid_t efi_esrt_guid;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530311
Marek Behún2bdc6f52021-05-20 13:23:56 +0200312extern char __efi_runtime_start[], __efi_runtime_stop[];
313extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf50149ea2016-03-04 01:10:01 +0100314
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200315/**
316 * struct efi_open_protocol_info_item - open protocol info item
317 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100318 * When a protocol is opened a open protocol info entry is created.
319 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200320 *
321 * @link: link to the list of open protocol info entries of a protocol
322 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100323 */
324struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100325 struct list_head link;
326 struct efi_open_protocol_info_entry info;
327};
328
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200329/**
330 * struct efi_handler - single protocol interface of a handle
331 *
Alexander Grafbee91162016-03-04 01:09:59 +0100332 * When the UEFI payload wants to open a protocol on an object to get its
333 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100334 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200335 *
336 * @link: link to the list of protocols of a handle
337 * @guid: GUID of the protocol
338 * @protocol_interface: protocol interface
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100339 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100340 */
Alexander Grafbee91162016-03-04 01:09:59 +0100341struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100342 struct list_head link;
Alexander Grafbee91162016-03-04 01:09:59 +0100343 const efi_guid_t *guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200344 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100345 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100346};
347
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200348/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200349 * enum efi_object_type - type of EFI object
350 *
351 * In UnloadImage we must be able to identify if the handle relates to a
352 * started image.
353 */
354enum efi_object_type {
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100355 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200356 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100357 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200358 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100359 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200360 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100361 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200362 EFI_OBJECT_TYPE_STARTED_IMAGE,
363};
364
365/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200366 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100367 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200368 * @link: pointers to put the handle into a linked list
369 * @protocols: linked list with the protocol interfaces installed on this
370 * handle
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100371 * @type: image type if the handle relates to an image
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200372 *
373 * UEFI offers a flexible and expandable object model. The objects in the UEFI
374 * API are devices, drivers, and loaded images. struct efi_object is our storage
375 * structure for these objects.
376 *
377 * When including this structure into a larger structure always put it first so
378 * that when deleting a handle the whole encompassing structure can be freed.
379 *
380 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
381 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100382 */
383struct efi_object {
384 /* Every UEFI object is part of a global object list */
385 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100386 /* The list of protocols */
387 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200388 enum efi_object_type type;
Alexander Grafbee91162016-03-04 01:09:59 +0100389};
390
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900391enum efi_image_auth_status {
392 EFI_IMAGE_AUTH_FAILED = 0,
393 EFI_IMAGE_AUTH_PASSED,
394};
395
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200396/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200397 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200398 *
399 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200400 * @exit_status: exit status passed to Exit()
401 * @exit_data_size: exit data size passed to Exit()
402 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100403 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200404 * @entry: entry address of the relocated image
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100405 * @image_type: indicates if the image is an applicition or a driver
406 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200407 */
408struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200409 struct efi_object header;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100410 efi_status_t *exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200411 efi_uintn_t *exit_data_size;
412 u16 **exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100413 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200414 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
415 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200416 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900417 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200418};
419
420/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200421 * struct efi_event
422 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100423 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200424 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200425 * @type: Type of event, see efi_create_event
426 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100427 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200428 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100429 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100430 * @trigger_time: Period of the timer
431 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200432 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100433 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200434 */
435struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100436 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200437 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200438 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100439 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200440 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
441 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100442 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200443 u64 trigger_next;
444 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200445 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200446 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200447};
448
Alexander Grafbee91162016-03-04 01:09:59 +0100449/* This list contains all UEFI objects we know of */
450extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100451/* List of all events */
452extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100453
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200454/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200455 * struct efi_protocol_notification - handle for notified protocol
456 *
457 * When a protocol interface is installed for which an event was registered with
458 * the RegisterProtocolNotify() service this structure is used to hold the
459 * handle on which the protocol interface was installed.
460 *
461 * @link: link to list of all handles notified for this event
462 * @handle: handle on which the notified protocol interface was installed
463 */
464struct efi_protocol_notification {
465 struct list_head link;
466 efi_handle_t handle;
467};
468
469/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100470 * struct efi_register_notify_event - event registered by
471 * RegisterProtocolNotify()
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200472 *
473 * The address of this structure serves as registration value.
474 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200475 * @link: link to list of all registered events
476 * @event: registered event. The same event may registered for multiple
477 * GUIDs.
478 * @protocol: protocol for which the event is registered
479 * @handles: linked list of all handles on which the notified protocol was
480 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200481 */
482struct efi_register_notify_event {
483 struct list_head link;
484 struct efi_event *event;
485 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200486 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200487};
488
489/* List of all events registered by RegisterProtocolNotify() */
490extern struct list_head efi_register_notify_events;
491
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100492/* Initialize efi execution environment */
493efi_status_t efi_init_obj_list(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100494/* Install device tree */
495efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100496/* Run loaded UEFI image */
497efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200498/* Initialize variable services */
499efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200500/* Notify ExitBootServices() is called */
501void efi_variables_boot_exit_notify(void);
Masahisa Kojimafdff03e2021-08-13 16:12:41 +0900502efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8fc4e0b2021-08-13 16:12:40 +0900503/* Measure efi application invocation */
504efi_status_t efi_tcg2_measure_efi_app_invocation(void);
505/* Measure efi application exit */
506efi_status_t efi_tcg2_measure_efi_app_exit(void);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200507/* Called by bootefi to initialize root node */
508efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200509/* Called by bootefi to initialize runtime */
510efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200511/* efi_runtime_detach() - detach unimplemented runtime functions */
512void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100513/* efi_convert_pointer() - convert pointer to virtual address */
514efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
515 void **address);
Heinrich Schuchardt94686f62020-12-13 10:30:24 +0100516/* Carve out DT reserved memory ranges */
517void efi_carve_out_dt_rsv(void *fdt);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200518/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200519efi_status_t efi_console_register(void);
Alexander Graf2a22d052016-03-04 01:10:02 +0100520/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtdf9cf562018-02-09 20:55:47 +0100521efi_status_t efi_disk_register(void);
Heinrich Schuchardtb59c13d2020-09-25 12:50:19 +0200522/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
523efi_status_t efi_rng_register(void);
Ilias Apalodimasc1c02102020-11-11 11:18:11 +0200524/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
525efi_status_t efi_tcg2_register(void);
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900526/* measure the pe-coff image, extend PCR and add Event Log */
527efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
528 struct efi_loaded_image_obj *handle,
529 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100530/* Create handles and protocols for the partitions of a block device */
531int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
532 const char *if_typename, int diskid,
533 const char *pdevname);
AKASHI Takahiro41fd5062020-04-27 18:48:20 +0900534/* Check if it is EFI system partition */
535bool efi_disk_is_system_part(efi_handle_t handle);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100536/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100537efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200538/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100539efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200540/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100541efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200542efi_status_t efi_initrd_register(void);
Ilias Apalodimas53f6a5a2021-03-17 21:55:00 +0200543void efi_initrd_deregister(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200544/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600545/**
Bin Meng86df34d2018-06-27 20:38:03 -0700546 * efi_acpi_register() - write out ACPI tables
547 *
548 * Called by bootefi to make ACPI tables available
549 *
550 * @return 0 if OK, -ENOMEM if no memory is available for the tables
551 */
552efi_status_t efi_acpi_register(void);
553/**
Simon Glass0864c562018-05-16 09:42:19 -0600554 * efi_smbios_register() - write out SMBIOS tables
555 *
556 * Called by bootefi to make SMBIOS tables available
557 *
558 * @return 0 if OK, -ENOMEM if no memory is available for the tables
559 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100560efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200561
Rob Clark2a920802017-09-13 18:05:34 -0400562struct efi_simple_file_system_protocol *
563efi_fs_from_path(struct efi_device_path *fp);
564
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200565/* Called by efi_set_watchdog_timer to reset the timer */
566efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200567
Alexander Grafbee91162016-03-04 01:09:59 +0100568/* Called from places to check whether a timer expired */
569void efi_timer_check(void);
Heinrich Schuchardt5dad05a2021-01-12 12:40:32 +0100570/* Check if a buffer contains a PE-COFF image */
571efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafbee91162016-03-04 01:09:59 +0100572/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900573efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
574 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100575 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100576/* Called once to store the pristine gd pointer */
577void efi_save_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100578/* Call this to relocate the runtime section to an address space */
579void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100580/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200581void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200582/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100583efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100584/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200585void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100586/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100587struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900588/* Load image */
589efi_status_t EFIAPI efi_load_image(bool boot_policy,
590 efi_handle_t parent_image,
591 struct efi_device_path *file_path,
592 void *source_buffer,
593 efi_uintn_t source_size,
594 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100595/* Start image */
596efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
597 efi_uintn_t *exit_data_size,
598 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900599/* Unload image */
600efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200601/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100602efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200603 const efi_guid_t *protocol_guid,
604 struct efi_handler **handler);
605/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100606efi_status_t efi_add_protocol(const efi_handle_t handle,
607 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200608 void *protocol_interface);
Heinrich Schuchardtf9ad2402020-01-10 12:33:59 +0100609/* Open protocol */
610efi_status_t efi_protocol_open(struct efi_handler *handler,
611 void **protocol_interface, void *agent_handle,
612 void *controller_handle, uint32_t attributes);
613
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200614/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100615efi_status_t efi_remove_protocol(const efi_handle_t handle,
616 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200617 void *protocol_interface);
618/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100619efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200620/* Install multiple protocol interfaces */
621efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
622 (efi_handle_t *handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900623/* Get handles that support a given protocol */
624efi_status_t EFIAPI efi_locate_handle_buffer(
625 enum efi_locate_search_type search_type,
626 const efi_guid_t *protocol, void *search_key,
627 efi_uintn_t *no_handles, efi_handle_t **buffer);
628/* Close an previously opened protocol interface */
629efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
630 const efi_guid_t *protocol,
631 efi_handle_t agent_handle,
632 efi_handle_t controller_handle);
633/* Open a protocol interface */
634efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
635 const efi_guid_t *protocol,
636 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200637/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100638efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200639 void (EFIAPI *notify_function) (
640 struct efi_event *event,
641 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100642 void *notify_context, efi_guid_t *group,
643 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200644/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200645efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200646 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200647/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200648void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100649
Rob Clark2a920802017-09-13 18:05:34 -0400650/* open file system: */
651struct efi_simple_file_system_protocol *efi_simple_file_system(
652 struct blk_desc *desc, int part, struct efi_device_path *dp);
653
654/* open file from device-path: */
655struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
656
Jose Marinho64a8aae2021-03-02 17:26:38 +0000657/* Registers a callback function for a notification event. */
658efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
659 struct efi_event *event,
660 void **registration);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200661efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
662
663/* get a device path from a Boot#### option */
664struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
665
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100666/**
667 * efi_size_in_pages() - convert size in bytes to size in pages
668 *
669 * This macro returns the number of EFI memory pages required to hold 'size'
670 * bytes.
671 *
672 * @size: size in bytes
673 * Return: size in pages
674 */
Heinrich Schuchardt0a7e5162021-01-17 07:52:09 +0100675#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100676/* Generic EFI memory allocator, call this to get memory */
677void *efi_alloc(uint64_t len, int memory_type);
678/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200679efi_status_t efi_allocate_pages(enum efi_allocate_type type,
680 enum efi_memory_type memory_type,
681 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200682/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100683efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200684/* EFI memory allocator for small allocations */
Heinrich Schuchardt49d225e2021-08-17 15:05:31 +0200685efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
686 efi_uintn_t size, void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200687/* EFI pool memory free function. */
688efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100689/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100690efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100691 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100692 efi_uintn_t *map_key,
693 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100694 uint32_t *descriptor_version);
695/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200696efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000697/* Adds a conventional range into the EFI memory map */
698efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
699 u64 ram_top);
700
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100701/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100702efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100703/* Called by board init to initialize the EFI memory map */
704int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200705/* Adds new or overrides configuration table entry to the system table */
706efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100707/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200708efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
709 struct efi_device_path *file_path,
710 struct efi_loaded_image_obj **handle_ptr,
711 struct efi_loaded_image **info_ptr);
Alexander Graf5d009952016-03-04 01:10:04 +0100712
Alexander Graf51735ae2016-05-11 18:25:48 +0200713#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
714extern void *efi_bounce_buffer;
715#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
716#endif
717
Rob Clarkb66c60d2017-09-13 18:05:28 -0400718
719struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200720int efi_dp_match(const struct efi_device_path *a,
721 const struct efi_device_path *b);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400722struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
723 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200724/* get size of the first device path instance excluding end node */
725efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
726/* size of multi-instance device path excluding end node */
727efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400728struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
729struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
730 const struct efi_device_path *dp2);
731struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
732 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200733/* Create a device path node of given type, sub-type, length */
734struct efi_device_path *efi_dp_create_device_node(const u8 type,
735 const u8 sub_type,
736 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200737/* Append device path instance */
738struct efi_device_path *efi_dp_append_instance(
739 const struct efi_device_path *dp,
740 const struct efi_device_path *dpi);
741/* Get next device path instance */
742struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
743 efi_uintn_t *size);
744/* Check if a device path contains muliple instances */
745bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400746
Rob Clarkb66c60d2017-09-13 18:05:28 -0400747struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100748/* Create a device node for a block device partition. */
749struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400750struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
751 const char *path);
752struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400753struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
754 uint64_t start_address,
755 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100756/* Determine the last device path node that is not the end node. */
757const struct efi_device_path *efi_dp_last_node(
758 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100759efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
760 struct efi_device_path **device_path,
761 struct efi_device_path **file_path);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900762efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
763 const char *path,
764 struct efi_device_path **device,
765 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200766ssize_t efi_dp_check_length(const struct efi_device_path *dp,
767 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400768
769#define EFI_DP_TYPE(_dp, _type, _subtype) \
770 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
771 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
772
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900773/* Indicate supported runtime services */
774efi_status_t efi_init_runtime_supported(void);
775
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200776/* Update CRC32 in table header */
777void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
778
Alexander Graf80a48002016-08-16 21:08:45 +0200779/* Boards may provide the functions below to implement RTS functionality */
780
Alexander Graf3c63db92016-10-14 13:45:30 +0200781void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200782 enum efi_reset_type reset_type,
783 efi_status_t reset_status,
784 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100785
786/* Architecture specific initialization of the EFI subsystem */
787efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200788
Alexander Graf3c63db92016-10-14 13:45:30 +0200789efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200790 struct efi_time *time,
791 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200792
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200793efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
794
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200795#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
796/*
797 * Entry point for the tests of the EFI API.
798 * It is called by 'bootefi selftest'
799 */
800efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
801 struct efi_system_table *systab);
802#endif
803
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100804efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
805 const efi_guid_t *vendor, u32 *attributes,
806 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200807efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
808 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100809 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100810efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
811 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100812 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400813
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200814efi_status_t EFIAPI efi_query_variable_info(
815 u32 attributes, u64 *maximum_variable_storage_size,
816 u64 *remaining_variable_storage_size,
817 u64 *maximum_variable_size);
818
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200819void *efi_get_var(u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
820
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900821/*
822 * See section 3.1.3 in the v2.7 UEFI spec for more details on
823 * the layout of EFI_LOAD_OPTION. In short it is:
824 *
825 * typedef struct _EFI_LOAD_OPTION {
826 * UINT32 Attributes;
827 * UINT16 FilePathListLength;
828 * // CHAR16 Description[]; <-- variable length, NULL terminated
829 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
830 * <-- FilePathListLength bytes
831 * // UINT8 OptionalData[];
832 * } EFI_LOAD_OPTION;
833 */
834struct efi_load_option {
835 u32 attributes;
836 u16 file_path_length;
837 u16 *label;
838 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200839 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900840};
841
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200842struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
843 efi_uintn_t *size, efi_guid_t guid);
844struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
845 const struct efi_device_path *dp2);
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200846efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
847 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900848unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200849efi_status_t efi_set_load_options(efi_handle_t handle,
850 efi_uintn_t load_options_size,
851 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200852efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400853
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900854/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100855 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900856 *
857 * @max: Maximum number of regions
858 * @num: Number of regions
859 * @reg: array of regions
860 */
861struct efi_image_regions {
862 int max;
863 int num;
864 struct image_region reg[];
865};
866
867/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100868 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900869 *
870 * This structure represents an internal form of signature in
871 * signature database. A listed list may represent a signature list.
872 *
873 * @next: Pointer to next entry
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100874 * @owner: Signature owner
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900875 * @data: Pointer to signature data
876 * @size: Size of signature data
877 */
878struct efi_sig_data {
879 struct efi_sig_data *next;
880 efi_guid_t owner;
881 void *data;
882 size_t size;
883};
884
885/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100886 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900887 *
888 * This structure represents an internal form of signature database.
889 *
890 * @next: Pointer to next entry
891 * @sig_type: Signature type
892 * @sig_data_list: Pointer to signature list
893 */
894struct efi_signature_store {
895 struct efi_signature_store *next;
896 efi_guid_t sig_type;
897 struct efi_sig_data *sig_data_list;
898};
899
900struct x509_certificate;
901struct pkcs7_message;
902
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900903bool efi_signature_lookup_digest(struct efi_image_regions *regs,
904 struct efi_signature_store *db);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +0900905bool efi_signature_verify(struct efi_image_regions *regs,
906 struct pkcs7_message *msg,
907 struct efi_signature_store *db,
908 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +0900909static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
910 struct pkcs7_message *msg,
911 struct efi_signature_store *db)
912{
913 return efi_signature_verify(regs, msg, db, NULL);
914}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +0900915bool efi_signature_check_signers(struct pkcs7_message *msg,
916 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900917
918efi_status_t efi_image_region_add(struct efi_image_regions *regs,
919 const void *start, const void *end,
920 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900921
922void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganub4f20a52020-12-30 19:27:08 +0530923struct efi_signature_store *efi_build_signature_store(void *sig_list,
924 efi_uintn_t size);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900925struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900926
927bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900928
Sughosh Ganu04be98b2020-12-30 19:27:09 +0530929bool efi_capsule_auth_enabled(void);
930
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900931void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
932
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900933bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
934 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900935
Sughosh Ganu201b8062020-12-30 19:27:07 +0530936struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
937 size_t buflen,
938 u8 **tmpbuf);
939
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +0200940/* runtime implementation of memcpy() */
941void efi_memcpy_runtime(void *dest, const void *src, size_t n);
942
AKASHI Takahiro077153e2020-10-29 13:47:46 +0900943/* commonly used helper function */
Ilias Apalodimasfe179d72020-12-31 12:26:46 +0200944u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
945 unsigned int index);
AKASHI Takahiro077153e2020-10-29 13:47:46 +0900946
AKASHI Takahirof27c2012020-11-30 18:12:12 +0900947extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +0900948extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof27c2012020-11-30 18:12:12 +0900949
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900950/* Capsule update */
951efi_status_t EFIAPI efi_update_capsule(
952 struct efi_capsule_header **capsule_header_array,
953 efi_uintn_t capsule_count,
954 u64 scatter_gather_list);
955efi_status_t EFIAPI efi_query_capsule_caps(
956 struct efi_capsule_header **capsule_header_array,
957 efi_uintn_t capsule_count,
958 u64 *maximum_capsule_size,
959 u32 *reset_type);
960
Sughosh Ganu04be98b2020-12-30 19:27:09 +0530961efi_status_t efi_capsule_authenticate(const void *capsule,
962 efi_uintn_t capsule_size,
963 void **image, efi_uintn_t *image_size);
964
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +0900965#define EFI_CAPSULE_DIR L"\\EFI\\UpdateCapsule\\"
966
Jose Marinho64a8aae2021-03-02 17:26:38 +0000967/**
968 * Install the ESRT system table.
969 *
970 * @return status code
971 */
972efi_status_t efi_esrt_register(void);
973
974/**
975 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
976 * present in the system.
977 * If an ESRT already exists, the old ESRT is replaced in the system table.
978 * The memory of the old ESRT is deallocated.
979 *
980 * Return:
981 * - EFI_SUCCESS if the ESRT is correctly created
982 * - error code otherwise.
983 */
984efi_status_t efi_esrt_populate(void);
Ilias Apalodimas6e0184b2021-06-22 17:38:53 +0300985efi_status_t efi_load_capsule_drivers(void);
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200986#endif /* _EFI_LOADER_H */