blob: 3e5ac3804249b859449e4f428b112cadef48aae1 [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Graf4e0c1c12016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf4e0c1c12016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafc15d9212016-03-04 01:09:59 +010011#include <common.h>
Simon Glass655306c2020-05-10 11:39:58 -060012#include <blk.h>
Simon Glass0f2af882020-05-10 11:40:05 -060013#include <log.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010014#include <part_efi.h>
15#include <efi_api.h>
AKASHI Takahiro2c0f9f72020-04-21 09:38:38 +090016#include <image.h>
AKASHI Takahiro0e104e32020-04-14 11:51:44 +090017#include <pe.h>
Simon Glass97f9bd42021-07-02 12:36:16 -060018#include <linux/list.h>
19#include <linux/oid_registry.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010020
Simon Glass655306c2020-05-10 11:39:58 -060021struct blk_desc;
AKASHI Takahiro4cbba2b2021-07-20 14:57:02 +090022struct jmp_buf_data;
Simon Glass655306c2020-05-10 11:39:58 -060023
Simon Glass16fc74a2019-09-25 08:11:32 -060024static inline int guidcmp(const void *g1, const void *g2)
25{
26 return memcmp(g1, g2, sizeof(efi_guid_t));
27}
28
Sughosh Ganu196f66d2019-12-29 00:01:04 +053029static inline void *guidcpy(void *dst, const void *src)
30{
31 return memcpy(dst, src, sizeof(efi_guid_t));
32}
33
Stephen Warrend0de8062018-08-30 15:43:43 -060034#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010035
Simon Glass97f9bd42021-07-02 12:36:16 -060036/**
37 * __efi_runtime_data - declares a non-const variable for EFI runtime section
38 *
39 * This macro indicates that a variable is non-const and should go into the
40 * EFI runtime section, and thus still be available when the OS is running.
41 *
42 * Only use on variables not declared const.
43 *
44 * Example:
45 *
46 * ::
47 *
48 * static __efi_runtime_data my_computed_table[256];
49 */
50#define __efi_runtime_data __section(".data.efi_runtime")
51
52/**
53 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
54 *
55 * This macro indicates that a variable is read-only (const) and should go into
56 * the EFI runtime section, and thus still be available when the OS is running.
57 *
58 * Only use on variables also declared const.
59 *
60 * Example:
61 *
62 * ::
63 *
64 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
65 */
66#define __efi_runtime_rodata __section(".rodata.efi_runtime")
67
68/**
69 * __efi_runtime - declares a function for EFI runtime section
70 *
71 * This macro indicates that a function should go into the EFI runtime section,
72 * and thus still be available when the OS is running.
73 *
74 * Example:
75 *
76 * ::
77 *
78 * static __efi_runtime compute_my_table(void);
79 */
80#define __efi_runtime __section(".text.efi_runtime")
81
82/*
83 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
84 * to make it available at runtime
85 */
86efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
87
88/*
89 * Special case handler for error/abort that just tries to dtrt to get
90 * back to u-boot world
91 */
92void efi_restore_gd(void);
93/* Call this to set the current device name */
94void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
95 void *buffer, size_t buffer_size);
96/* Called by networking code to memorize the dhcp ack package */
97void efi_net_set_dhcp_ack(void *pkt, int len);
98/* Print information about all loaded images */
99void efi_print_image_infos(void *pc);
100
101/* Hook at initialization */
102efi_status_t efi_launch_capsules(void);
103
104#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
105
106/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
107#define __efi_runtime_data
108#define __efi_runtime_rodata
109#define __efi_runtime
110static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
111{
112 return EFI_SUCCESS;
113}
114
115/* No loader configured, stub out EFI_ENTRY */
116static inline void efi_restore_gd(void) { }
117static inline void efi_set_bootdev(const char *dev, const char *devnr,
118 const char *path, void *buffer,
119 size_t buffer_size) { }
120static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
121static inline void efi_print_image_infos(void *pc) { }
122static inline efi_status_t efi_launch_capsules(void)
123{
124 return EFI_SUCCESS;
125}
126
127#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100128
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +0200129/* Maximum number of configuration tables */
130#define EFI_MAX_CONFIGURATION_TABLES 16
131
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200132/* GUID used by the root node */
133#define U_BOOT_GUID \
134 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
135 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900136/* GUID used as host device on sandbox */
137#define U_BOOT_HOST_DEV_GUID \
138 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
139 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardtc770aaa2020-05-20 22:39:35 +0200140/* GUID used as root for virtio devices */
141#define U_BOOT_VIRTIO_DEV_GUID \
142 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
143 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200144
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100145/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100146#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +0100147
AKASHI Takahiro0b275752019-04-16 13:24:20 +0900148/* Root node */
149extern efi_handle_t efi_root;
150
Heinrich Schuchardtde9bdc62020-03-19 18:21:58 +0000151/* Set to EFI_SUCCESS when initialized */
152extern efi_status_t efi_obj_list_initialized;
153
Heinrich Schuchardt628dbd72020-11-12 21:26:28 +0100154/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
155extern bool efi_st_keep_devices;
156
Heinrich Schuchardta9931732020-03-19 15:16:31 +0100157/* EFI system partition */
158extern struct efi_system_partition {
159 enum if_type if_type;
160 int devnum;
161 u8 part;
162} efi_system_partition;
163
Rob Clark86789d52017-07-27 08:04:18 -0400164int __efi_entry_check(void);
165int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200166const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -0400167const char *__efi_nesting_inc(void);
168const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -0400169
Rob Clark63ea77a2017-07-27 08:04:17 -0400170/*
171 * Enter the u-boot world from UEFI:
172 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100173#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -0400174 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400175 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
176 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +0100177 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +0100178
Rob Clark63ea77a2017-07-27 08:04:17 -0400179/*
180 * Exit the u-boot world back to UEFI:
181 */
Rob Clark84a19a02017-07-24 10:31:52 -0400182#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200183 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -0400184 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +0200185 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -0400186 assert(__efi_exit_check()); \
187 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -0400188 })
Alexander Grafc15d9212016-03-04 01:09:59 +0100189
Rob Clark63ea77a2017-07-27 08:04:17 -0400190/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200191 * Call non-void UEFI function from u-boot and retrieve return value:
192 */
193#define EFI_CALL(exp) ({ \
194 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
195 assert(__efi_exit_check()); \
196 typeof(exp) _r = exp; \
197 assert(__efi_entry_check()); \
198 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
199 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
200 _r; \
201})
202
203/*
204 * Call void UEFI function from u-boot:
Rob Clark63ea77a2017-07-27 08:04:17 -0400205 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200206#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400207 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400208 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400209 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400210 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400211 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400212 } while(0)
213
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200214/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100215 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200216 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100217#define EFI_PRINT(format, ...) ({ \
218 debug("%sEFI: " format, __efi_nesting(), \
219 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200220 })
221
Alexander Graf59254d62018-04-23 07:59:47 +0200222#ifdef CONFIG_SYS_CACHELINE_SIZE
223#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
224#else
225/* Just use the greatest cache flush alignment requirement I'm aware of */
226#define EFI_CACHELINE_SIZE 128
227#endif
228
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200229/* Key identifying current memory map */
230extern efi_uintn_t efi_memory_map_key;
231
Alexander Graf0bd425a2016-03-04 01:10:01 +0100232extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100233extern struct efi_system_table systab;
234
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200235extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200236extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200237extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200238extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100239/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
240extern const struct efi_device_path_utilities_protocol
241 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200242/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200243extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200244 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900245extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
246extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900247extern const struct efi_hii_database_protocol efi_hii_database;
248extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100249
Rob Clark85dd7212017-09-13 18:05:30 -0400250uint16_t *efi_dp_str(struct efi_device_path *dp);
251
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200252/* GUID of the U-Boot root node */
253extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900254#ifdef CONFIG_SANDBOX
255/* GUID of U-Boot host device on sandbox */
256extern const efi_guid_t efi_guid_host_dev;
257#endif
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100258/* GUID of the EFI_BLOCK_IO_PROTOCOL */
259extern const efi_guid_t efi_block_io_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400260extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100261extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100262extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100263/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
264extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-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 Schuchardt44ab21b2018-03-03 15:29:03 +0100275/* GUID of the device tree table */
276extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100277extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900278extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200279extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-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 Schuchardt37fb4b92018-04-04 15:42:11 +0200282/* GUID for file system information */
283extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100284extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200285/* GUID of the deprecated Unicode collation protocol */
286extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt485956d2020-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 Schuchardte59072a2018-09-04 19:34:58 +0200290/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200291extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-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 Lindholm5aab1b82019-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 Takahiro1faaca42020-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 Takahirob0f49ee2020-04-14 11:51:41 +0900301extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100302
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530303/* GUID of RNG protocol */
304extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900305/* GUID of capsule update result */
306extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro0d963782020-11-30 18:12:11 +0900307/* GUID of firmware management protocol */
308extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000309/* GUID for the ESRT */
310extern const efi_guid_t efi_esrt_guid;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530311
Marek Behún69504502021-05-20 13:23:56 +0200312extern char __efi_runtime_start[], __efi_runtime_stop[];
313extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf0bd425a2016-03-04 01:10:01 +0100314
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200315/**
316 * struct efi_open_protocol_info_item - open protocol info item
317 *
Heinrich Schuchardta277d3a2018-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 Schuchardt2e4b41f2019-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 Schuchardta277d3a2018-01-11 08:15:57 +0100323 */
324struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100325 struct list_head link;
326 struct efi_open_protocol_info_entry info;
327};
328
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200329/**
330 * struct efi_handler - single protocol interface of a handle
331 *
Alexander Grafc15d9212016-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 Schuchardta277d3a2018-01-11 08:15:57 +0100334 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-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 Schuchardt6eb30c12021-02-25 08:02:37 +0100339 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100340 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100341struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100342 struct list_head link;
Alexander Grafc15d9212016-03-04 01:09:59 +0100343 const efi_guid_t *guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200344 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100345 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100346};
347
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200348/**
Heinrich Schuchardtb27ced42019-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 Schuchardt6eb30c12021-02-25 08:02:37 +0100355 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200356 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100357 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200358 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100359 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200360 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100361 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200362 EFI_OBJECT_TYPE_STARTED_IMAGE,
363};
364
365/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200366 * struct efi_object - dereferenced EFI handle
367 *
368 * @link: pointers to put the handle into a linked list
369 * @protocols: linked list with the protocol interfaces installed on this
370 * handle
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100371 * @type: image type if the handle relates to an image
Heinrich Schuchardtadb50d02018-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.
Alexander Grafc15d9212016-03-04 01:09:59 +0100379 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200380 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
381 * has been created for such pointers.
Alexander Grafc15d9212016-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 Schuchardt99ce2062017-11-26 14:05:17 +0100386 /* The list of protocols */
387 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200388 enum efi_object_type type;
Alexander Grafc15d9212016-03-04 01:09:59 +0100389};
390
AKASHI Takahiro0e104e32020-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.de30708232017-07-18 20:17:18 +0200396/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200397 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200398 *
399 * @header: EFI object header
Heinrich Schuchardt3d445122019-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 Schuchardt93b40d62020-12-28 22:42:51 +0100403 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200404 * @entry: entry address of the relocated image
Heinrich Schuchardt93b40d62020-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 Schuchardt3c3a7352018-09-23 17:21:51 +0200407 */
408struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200409 struct efi_object header;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100410 efi_status_t *exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200411 efi_uintn_t *exit_data_size;
412 u16 **exit_data;
Heinrich Schuchardt026c7ec2020-12-28 23:24:40 +0100413 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200414 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
415 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200416 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900417 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200418};
419
420/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200421 * struct efi_event
422 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100423 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200424 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200425 * @type: Type of event, see efi_create_event
426 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100427 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200428 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100429 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100430 * @trigger_time: Period of the timer
431 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200432 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100433 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200434 */
435struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100436 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200437 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200438 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100439 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200440 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
441 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100442 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200443 u64 trigger_next;
444 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200445 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200446 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200447};
448
Alexander Grafc15d9212016-03-04 01:09:59 +0100449/* This list contains all UEFI objects we know of */
450extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100451/* List of all events */
452extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100453
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200454/**
Heinrich Schuchardtd375e752019-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 Schuchardt6eb30c12021-02-25 08:02:37 +0100470 * struct efi_register_notify_event - event registered by
471 * RegisterProtocolNotify()
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200472 *
473 * The address of this structure serves as registration value.
474 *
Heinrich Schuchardtd375e752019-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 Schuchardt6eec42d2019-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 Schuchardtd375e752019-05-21 18:19:01 +0200486 struct list_head handles;
Heinrich Schuchardt6eec42d2019-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 Takahiro7e0badb2018-12-30 15:16:55 +0100492/* Initialize efi execution environment */
493efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100494/* Install device tree */
495efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtffb90592019-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 Schuchardtcf3b1182019-06-20 13:52:16 +0200498/* Initialize variable services */
499efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200500/* Notify ExitBootServices() is called */
501void efi_variables_boot_exit_notify(void);
Masahisa Kojima1ac19bb2021-08-13 16:12:41 +0900502efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
Masahisa Kojima8173cd42021-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 Schuchardt79d72022018-09-20 21:58:23 +0200507/* Called by bootefi to initialize root node */
508efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200509/* Called by bootefi to initialize runtime */
510efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200511/* efi_runtime_detach() - detach unimplemented runtime functions */
512void efi_runtime_detach(void);
Heinrich Schuchardt699b7c62020-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 Schuchardt2c1e2242020-12-13 10:30:24 +0100516/* Carve out DT reserved memory ranges */
517void efi_carve_out_dt_rsv(void *fdt);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200518/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200519efi_status_t efi_console_register(void);
Alexander Grafe83be452016-03-04 01:10:02 +0100520/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtcde7a362018-02-09 20:55:47 +0100521efi_status_t efi_disk_register(void);
Heinrich Schuchardtc63f68f2020-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 Apalodimas590fef62020-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 Kojima70be5a62021-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 Schuchardt6f3de6b2018-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 Takahiro911df642020-04-27 18:48:20 +0900534/* Check if it is EFI system partition */
535bool efi_disk_is_system_part(efi_handle_t handle);
Alexander Grafd65783d2016-03-15 18:38:21 +0100536/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100537efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200538/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100539efi_status_t efi_net_register(void);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200540/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100541efi_status_t efi_watchdog_register(void);
Ilias Apalodimas3510ba72020-02-21 09:55:45 +0200542efi_status_t efi_initrd_register(void);
Ilias Apalodimasb307e3d2021-03-17 21:55:00 +0200543void efi_initrd_deregister(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200544/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600545/**
Bin Meng2cfbdae2018-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 Glass2e2858f2018-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 Schuchardt7a369c42018-03-03 15:28:54 +0100560efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200561
Rob Clark53142032017-09-13 18:05:34 -0400562struct efi_simple_file_system_protocol *
563efi_fs_from_path(struct efi_device_path *fp);
564
Heinrich Schuchardt18081d42017-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 Graf94c4b992016-05-06 21:01:01 +0200567
Alexander Grafc15d9212016-03-04 01:09:59 +0100568/* Called from places to check whether a timer expired */
569void efi_timer_check(void);
Heinrich Schuchardtad6e0f72021-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 Grafc15d9212016-03-04 01:09:59 +0100572/* PE loader implementation */
AKASHI Takahiro0e104e32020-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 Schuchardt408fbcc2018-12-26 12:49:09 +0100575 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100576/* Called once to store the pristine gd pointer */
577void efi_save_gd(void);
Alexander Graf0bd425a2016-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 Schuchardt967d7de2017-11-26 14:05:23 +0100580/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200581void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200582/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100583efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100584/* Delete handle */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200585void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100586/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100587struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirob0ad9052019-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 Schuchardt2f8eb082018-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 Takahirob0ad9052019-03-05 14:53:31 +0900599/* Unload image */
600efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200601/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100602efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-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 Schuchardtb7cb8b42018-01-11 08:16:09 +0100606efi_status_t efi_add_protocol(const efi_handle_t handle,
607 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200608 void *protocol_interface);
Heinrich Schuchardt9c89d142020-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 Schuchardt5aef61d2017-10-26 19:25:53 +0200614/* Delete protocol from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100615efi_status_t efi_remove_protocol(const efi_handle_t handle,
616 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200617 void *protocol_interface);
618/* Delete all protocols from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100619efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt744d83e2019-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 Takahirod99b1b32020-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.de852a0e1772017-07-18 20:17:20 +0200637/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100638efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200639 void (EFIAPI *notify_function) (
640 struct efi_event *event,
641 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100642 void *notify_context, efi_guid_t *group,
643 struct efi_event **event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200644/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200645efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200646 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200647/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200648void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100649
Rob Clark53142032017-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 Marinhoebb61ee2021-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 Apalodimasaa0f7552021-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 Schuchardtdcdca292018-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 Schuchardtaefb0c42021-01-17 07:52:09 +0100675#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf8623f922016-03-04 01:10:04 +0100676/* Generic EFI memory allocator, call this to get memory */
677void *efi_alloc(uint64_t len, int memory_type);
Ilias Apalodimas6e01c232021-10-11 15:10:23 +0300678/* Allocate pages on the specified alignment */
679void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
Alexander Graf8623f922016-03-04 01:10:04 +0100680/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200681efi_status_t efi_allocate_pages(enum efi_allocate_type type,
682 enum efi_memory_type memory_type,
683 efi_uintn_t pages, uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200684/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100685efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200686/* EFI memory allocator for small allocations */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200687efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
688 efi_uintn_t size, void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200689/* EFI pool memory free function. */
690efi_status_t efi_free_pool(void *buffer);
Alexander Graf8623f922016-03-04 01:10:04 +0100691/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100692efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100693 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100694 efi_uintn_t *map_key,
695 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100696 uint32_t *descriptor_version);
697/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200698efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidene009e7a2019-09-03 17:43:43 +0000699/* Adds a conventional range into the EFI memory map */
700efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
701 u64 ram_top);
702
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100703/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100704efi_status_t efi_driver_init(void);
Alexander Graf8623f922016-03-04 01:10:04 +0100705/* Called by board init to initialize the EFI memory map */
706int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200707/* Adds new or overrides configuration table entry to the system table */
708efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100709/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200710efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
711 struct efi_device_path *file_path,
712 struct efi_loaded_image_obj **handle_ptr,
713 struct efi_loaded_image **info_ptr);
Alexander Graf8623f922016-03-04 01:10:04 +0100714
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200715#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
716extern void *efi_bounce_buffer;
717#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
718#endif
719
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400720
721struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200722int efi_dp_match(const struct efi_device_path *a,
723 const struct efi_device_path *b);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400724struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
725 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200726/* get size of the first device path instance excluding end node */
727efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
728/* size of multi-instance device path excluding end node */
729efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400730struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
731struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
732 const struct efi_device_path *dp2);
733struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
734 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200735/* Create a device path node of given type, sub-type, length */
736struct efi_device_path *efi_dp_create_device_node(const u8 type,
737 const u8 sub_type,
738 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200739/* Append device path instance */
740struct efi_device_path *efi_dp_append_instance(
741 const struct efi_device_path *dp,
742 const struct efi_device_path *dpi);
743/* Get next device path instance */
744struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
745 efi_uintn_t *size);
746/* Check if a device path contains muliple instances */
747bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400748
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400749struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100750/* Create a device node for a block device partition. */
751struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400752struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
753 const char *path);
754struct efi_device_path *efi_dp_from_eth(void);
Rob Clark18ceba72017-10-10 08:23:06 -0400755struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
756 uint64_t start_address,
757 uint64_t end_address);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100758/* Determine the last device path node that is not the end node. */
759const struct efi_device_path *efi_dp_last_node(
760 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100761efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
762 struct efi_device_path **device_path,
763 struct efi_device_path **file_path);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900764efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
765 const char *path,
766 struct efi_device_path **device,
767 struct efi_device_path **file);
Heinrich Schuchardt22c8e082020-08-23 10:49:46 +0200768ssize_t efi_dp_check_length(const struct efi_device_path *dp,
769 const size_t maxlen);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400770
771#define EFI_DP_TYPE(_dp, _type, _subtype) \
772 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
773 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
774
AKASHI Takahiro32401842019-06-05 13:21:38 +0900775/* Indicate supported runtime services */
776efi_status_t efi_init_runtime_supported(void);
777
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200778/* Update CRC32 in table header */
779void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
780
Alexander Graf77256092016-08-16 21:08:45 +0200781/* Boards may provide the functions below to implement RTS functionality */
782
Alexander Graf393dd912016-10-14 13:45:30 +0200783void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200784 enum efi_reset_type reset_type,
785 efi_status_t reset_status,
786 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100787
788/* Architecture specific initialization of the EFI subsystem */
789efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200790
Alexander Graf393dd912016-10-14 13:45:30 +0200791efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200792 struct efi_time *time,
793 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200794
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200795efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
796
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200797#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
798/*
799 * Entry point for the tests of the EFI API.
800 * It is called by 'bootefi selftest'
801 */
802efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
803 struct efi_system_table *systab);
804#endif
805
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100806efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
807 const efi_guid_t *vendor, u32 *attributes,
808 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200809efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
810 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100811 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100812efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
813 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100814 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400815
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200816efi_status_t EFIAPI efi_query_variable_info(
817 u32 attributes, u64 *maximum_variable_storage_size,
818 u64 *remaining_variable_storage_size,
819 u64 *maximum_variable_size);
820
Ilias Apalodimasaa0f7552021-03-17 21:54:59 +0200821void *efi_get_var(u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
822
AKASHI Takahirobd237742018-11-05 18:06:41 +0900823/*
824 * See section 3.1.3 in the v2.7 UEFI spec for more details on
825 * the layout of EFI_LOAD_OPTION. In short it is:
826 *
827 * typedef struct _EFI_LOAD_OPTION {
828 * UINT32 Attributes;
829 * UINT16 FilePathListLength;
830 * // CHAR16 Description[]; <-- variable length, NULL terminated
831 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
832 * <-- FilePathListLength bytes
833 * // UINT8 OptionalData[];
834 * } EFI_LOAD_OPTION;
835 */
836struct efi_load_option {
837 u32 attributes;
838 u16 file_path_length;
839 u16 *label;
840 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +0200841 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +0900842};
843
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200844struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
Heinrich Schuchardt9979cff2021-10-15 01:31:02 +0200845 const efi_guid_t *guid);
Ilias Apalodimas483d28e2021-03-17 21:54:58 +0200846struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
847 const struct efi_device_path *dp2);
Heinrich Schuchardt7ca84f82020-05-31 22:46:09 +0200848efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
849 efi_uintn_t *size);
AKASHI Takahirobd237742018-11-05 18:06:41 +0900850unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt25c6be52020-08-07 17:47:13 +0200851efi_status_t efi_set_load_options(efi_handle_t handle,
852 efi_uintn_t load_options_size,
853 void *load_options);
Heinrich Schuchardta7647a72020-08-07 17:49:39 +0200854efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clarkc84c1102017-09-13 18:05:38 -0400855
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900856/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100857 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900858 *
859 * @max: Maximum number of regions
860 * @num: Number of regions
861 * @reg: array of regions
862 */
863struct efi_image_regions {
864 int max;
865 int num;
866 struct image_region reg[];
867};
868
869/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100870 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900871 *
872 * This structure represents an internal form of signature in
873 * signature database. A listed list may represent a signature list.
874 *
875 * @next: Pointer to next entry
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100876 * @owner: Signature owner
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900877 * @data: Pointer to signature data
878 * @size: Size of signature data
879 */
880struct efi_sig_data {
881 struct efi_sig_data *next;
882 efi_guid_t owner;
883 void *data;
884 size_t size;
885};
886
887/**
Heinrich Schuchardt6eb30c12021-02-25 08:02:37 +0100888 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900889 *
890 * This structure represents an internal form of signature database.
891 *
892 * @next: Pointer to next entry
893 * @sig_type: Signature type
894 * @sig_data_list: Pointer to signature list
895 */
896struct efi_signature_store {
897 struct efi_signature_store *next;
898 efi_guid_t sig_type;
899 struct efi_sig_data *sig_data_list;
900};
901
902struct x509_certificate;
903struct pkcs7_message;
904
AKASHI Takahirode924072020-07-08 14:01:57 +0900905bool efi_signature_lookup_digest(struct efi_image_regions *regs,
906 struct efi_signature_store *db);
AKASHI Takahiro14afd062020-07-21 19:35:22 +0900907bool efi_signature_verify(struct efi_image_regions *regs,
908 struct pkcs7_message *msg,
909 struct efi_signature_store *db,
910 struct efi_signature_store *dbx);
AKASHI Takahiro16411802020-08-14 14:39:23 +0900911static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
912 struct pkcs7_message *msg,
913 struct efi_signature_store *db)
914{
915 return efi_signature_verify(regs, msg, db, NULL);
916}
AKASHI Takahiro4154b642020-07-08 14:01:56 +0900917bool efi_signature_check_signers(struct pkcs7_message *msg,
918 struct efi_signature_store *dbx);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900919
920efi_status_t efi_image_region_add(struct efi_image_regions *regs,
921 const void *start, const void *end,
922 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900923
924void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganufa0faa62020-12-30 19:27:08 +0530925struct efi_signature_store *efi_build_signature_store(void *sig_list,
926 efi_uintn_t size);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900927struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900928
929bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900930
Sughosh Ganu586bb982020-12-30 19:27:09 +0530931bool efi_capsule_auth_enabled(void);
932
Masahisa Kojima70be5a62021-05-26 12:09:58 +0900933void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
934
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900935bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
936 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900937
Sughosh Ganuea350082020-12-30 19:27:07 +0530938struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
939 size_t buflen,
940 u8 **tmpbuf);
941
Heinrich Schuchardt8cd99752020-06-28 16:30:29 +0200942/* runtime implementation of memcpy() */
943void efi_memcpy_runtime(void *dest, const void *src, size_t n);
944
AKASHI Takahiro94074682020-10-29 13:47:46 +0900945/* commonly used helper function */
Ilias Apalodimas21575292020-12-31 12:26:46 +0200946u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
947 unsigned int index);
AKASHI Takahiro94074682020-10-29 13:47:46 +0900948
AKASHI Takahirof4818e62020-11-30 18:12:12 +0900949extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahiro7ff3f3c2020-11-17 09:28:00 +0900950extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof4818e62020-11-30 18:12:12 +0900951
AKASHI Takahiro473d9b32020-11-17 09:27:55 +0900952/* Capsule update */
953efi_status_t EFIAPI efi_update_capsule(
954 struct efi_capsule_header **capsule_header_array,
955 efi_uintn_t capsule_count,
956 u64 scatter_gather_list);
957efi_status_t EFIAPI efi_query_capsule_caps(
958 struct efi_capsule_header **capsule_header_array,
959 efi_uintn_t capsule_count,
960 u64 *maximum_capsule_size,
961 u32 *reset_type);
962
Sughosh Ganu586bb982020-12-30 19:27:09 +0530963efi_status_t efi_capsule_authenticate(const void *capsule,
964 efi_uintn_t capsule_size,
965 void **image, efi_uintn_t *image_size);
966
AKASHI Takahiro45b819542020-11-17 09:27:56 +0900967#define EFI_CAPSULE_DIR L"\\EFI\\UpdateCapsule\\"
968
Jose Marinhoebb61ee2021-03-02 17:26:38 +0000969/**
970 * Install the ESRT system table.
971 *
972 * @return status code
973 */
974efi_status_t efi_esrt_register(void);
975
976/**
977 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
978 * present in the system.
979 * If an ESRT already exists, the old ESRT is replaced in the system table.
980 * The memory of the old ESRT is deallocated.
981 *
982 * Return:
983 * - EFI_SUCCESS if the ESRT is correctly created
984 * - error code otherwise.
985 */
986efi_status_t efi_esrt_populate(void);
Ilias Apalodimasfac773e2021-06-22 17:38:53 +0300987efi_status_t efi_load_capsule_drivers(void);
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +0200988#endif /* _EFI_LOADER_H */