blob: 98944640bee7d1c81336cc637107b17289108ae2 [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>
Alexander Grafbee91162016-03-04 01:09:59 +010018
Simon Glasse6f6f9e2020-05-10 11:39:58 -060019struct blk_desc;
20
Simon Glassfdeb6f72019-09-25 08:11:32 -060021static inline int guidcmp(const void *g1, const void *g2)
22{
23 return memcmp(g1, g2, sizeof(efi_guid_t));
24}
25
Sughosh Ganu61e42d92019-12-29 00:01:04 +053026static inline void *guidcpy(void *dst, const void *src)
27{
28 return memcpy(dst, src, sizeof(efi_guid_t));
29}
30
Alexander Grafbee91162016-03-04 01:09:59 +010031/* No need for efi loader support in SPL */
Stephen Warren9b5e6392018-08-30 15:43:43 -060032#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafbee91162016-03-04 01:09:59 +010033
Alexander Grafcb149c62016-03-04 01:09:58 +010034#include <linux/list.h>
AKASHI Takahiro593e17d2020-04-14 11:51:39 +090035#include <linux/oid_registry.h>
Alexander Grafcb149c62016-03-04 01:09:58 +010036
Heinrich Schuchardt4182a122018-06-28 12:45:32 +020037/* Maximum number of configuration tables */
38#define EFI_MAX_CONFIGURATION_TABLES 16
39
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +020040/* GUID used by the root node */
41#define U_BOOT_GUID \
42 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
43 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +090044/* GUID used as host device on sandbox */
45#define U_BOOT_HOST_DEV_GUID \
46 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
47 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
Heinrich Schuchardt19ecced2020-05-20 22:39:35 +020048/* GUID used as root for virtio devices */
49#define U_BOOT_VIRTIO_DEV_GUID \
50 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
51 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +020052
Heinrich Schuchardt7a597252019-11-28 06:46:09 +010053/* Use internal device tree when starting UEFI application */
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +010054#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt7a597252019-11-28 06:46:09 +010055
AKASHI Takahiroa2a4bc32019-04-16 13:24:20 +090056/* Root node */
57extern efi_handle_t efi_root;
58
Heinrich Schuchardt15b1bf12020-03-19 18:21:58 +000059/* Set to EFI_SUCCESS when initialized */
60extern efi_status_t efi_obj_list_initialized;
61
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +010062/* EFI system partition */
63extern struct efi_system_partition {
64 enum if_type if_type;
65 int devnum;
66 u8 part;
67} efi_system_partition;
68
Rob Clarkc160d2f2017-07-27 08:04:18 -040069int __efi_entry_check(void);
70int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020071const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -040072const char *__efi_nesting_inc(void);
73const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -040074
Rob Clarka095aad2017-07-27 08:04:17 -040075/*
76 * Enter the u-boot world from UEFI:
77 */
Alexander Grafbee91162016-03-04 01:09:59 +010078#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -040079 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -040080 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
81 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +010082 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +010083
Rob Clarka095aad2017-07-27 08:04:17 -040084/*
85 * Exit the u-boot world back to UEFI:
86 */
Rob Clark804b1d72017-07-24 10:31:52 -040087#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020088 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -040089 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020090 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -040091 assert(__efi_exit_check()); \
92 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -040093 })
Alexander Grafbee91162016-03-04 01:09:59 +010094
Rob Clarka095aad2017-07-27 08:04:17 -040095/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020096 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -040097 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020098#define EFI_CALL(exp) ({ \
99 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
100 assert(__efi_exit_check()); \
101 typeof(exp) _r = exp; \
102 assert(__efi_entry_check()); \
103 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
104 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
105 _r; \
106})
107
108/*
109 * Call void UEFI function from u-boot:
110 */
111#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -0400112 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400113 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -0400114 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400115 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400116 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -0400117 } while(0)
118
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200119/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100120 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200121 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100122#define EFI_PRINT(format, ...) ({ \
123 debug("%sEFI: " format, __efi_nesting(), \
124 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200125 })
126
Alexander Graf89aea432018-04-23 07:59:47 +0200127#ifdef CONFIG_SYS_CACHELINE_SIZE
128#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
129#else
130/* Just use the greatest cache flush alignment requirement I'm aware of */
131#define EFI_CACHELINE_SIZE 128
132#endif
133
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +0200134/* Key identifying current memory map */
135extern efi_uintn_t efi_memory_map_key;
136
Alexander Graf50149ea2016-03-04 01:10:01 +0100137extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100138extern struct efi_system_table systab;
139
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200140extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200141extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200142extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200143extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100144/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
145extern const struct efi_device_path_utilities_protocol
146 efi_device_path_utilities;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200147/* deprecated version of the EFI_UNICODE_COLLATION_PROTOCOL */
148extern const struct efi_unicode_collation_protocol
149 efi_unicode_collation_protocol;
150/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200151extern const struct efi_unicode_collation_protocol
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200152 efi_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900153extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
154extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900155extern const struct efi_hii_database_protocol efi_hii_database;
156extern const struct efi_hii_string_protocol efi_hii_string;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530157extern const struct efi_rng_protocol efi_rng_protocol;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100158
Rob Clarkadae4312017-09-13 18:05:30 -0400159uint16_t *efi_dp_str(struct efi_device_path *dp);
160
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200161/* GUID of the U-Boot root node */
162extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900163#ifdef CONFIG_SANDBOX
164/* GUID of U-Boot host device on sandbox */
165extern const efi_guid_t efi_guid_host_dev;
166#endif
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +0100167/* GUID of the EFI_BLOCK_IO_PROTOCOL */
168extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400169extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100170extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100171extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100172/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
173extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100174/* event group ExitBootServices() invoked */
175extern const efi_guid_t efi_guid_event_group_exit_boot_services;
176/* event group SetVirtualAddressMap() invoked */
177extern const efi_guid_t efi_guid_event_group_virtual_address_change;
178/* event group memory map changed */
179extern const efi_guid_t efi_guid_event_group_memory_map_change;
180/* event group boot manager about to boot */
181extern const efi_guid_t efi_guid_event_group_ready_to_boot;
182/* event group ResetSystem() invoked (before ExitBootServices) */
183extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100184/* GUID of the device tree table */
185extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100186extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900187extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200188extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400189extern const efi_guid_t efi_simple_file_system_protocol_guid;
190extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200191/* GUID for file system information */
192extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100193extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200194/* GUID of the deprecated Unicode collation protocol */
195extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200196/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200197extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900198extern const efi_guid_t efi_guid_hii_config_routing_protocol;
199extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900200extern const efi_guid_t efi_guid_hii_database_protocol;
201extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900202/* GUIDs for authentication */
203extern const efi_guid_t efi_guid_image_security_database;
204extern const efi_guid_t efi_guid_sha256;
205extern const efi_guid_t efi_guid_cert_x509;
206extern const efi_guid_t efi_guid_cert_x509_sha256;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900207extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100208
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530209/* GUID of RNG protocol */
210extern const efi_guid_t efi_guid_rng_protocol;
211
Alexander Graf50149ea2016-03-04 01:10:01 +0100212extern unsigned int __efi_runtime_start, __efi_runtime_stop;
213extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
214
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200215/**
216 * struct efi_open_protocol_info_item - open protocol info item
217 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100218 * When a protocol is opened a open protocol info entry is created.
219 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200220 *
221 * @link: link to the list of open protocol info entries of a protocol
222 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100223 */
224struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100225 struct list_head link;
226 struct efi_open_protocol_info_entry info;
227};
228
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200229/**
230 * struct efi_handler - single protocol interface of a handle
231 *
Alexander Grafbee91162016-03-04 01:09:59 +0100232 * When the UEFI payload wants to open a protocol on an object to get its
233 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100234 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200235 *
236 * @link: link to the list of protocols of a handle
237 * @guid: GUID of the protocol
238 * @protocol_interface: protocol interface
239 * @open_infos link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100240 */
Alexander Grafbee91162016-03-04 01:09:59 +0100241struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100242 struct list_head link;
Alexander Grafbee91162016-03-04 01:09:59 +0100243 const efi_guid_t *guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200244 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100245 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100246};
247
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200248/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200249 * enum efi_object_type - type of EFI object
250 *
251 * In UnloadImage we must be able to identify if the handle relates to a
252 * started image.
253 */
254enum efi_object_type {
255 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200256 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200257 EFI_OBJECT_TYPE_LOADED_IMAGE,
258 EFI_OBJECT_TYPE_STARTED_IMAGE,
259};
260
261/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200262 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100263 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200264 * @link: pointers to put the handle into a linked list
265 * @protocols: linked list with the protocol interfaces installed on this
266 * handle
267 *
268 * UEFI offers a flexible and expandable object model. The objects in the UEFI
269 * API are devices, drivers, and loaded images. struct efi_object is our storage
270 * structure for these objects.
271 *
272 * When including this structure into a larger structure always put it first so
273 * that when deleting a handle the whole encompassing structure can be freed.
274 *
275 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
276 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100277 */
278struct efi_object {
279 /* Every UEFI object is part of a global object list */
280 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100281 /* The list of protocols */
282 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200283 enum efi_object_type type;
Alexander Grafbee91162016-03-04 01:09:59 +0100284};
285
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900286enum efi_image_auth_status {
287 EFI_IMAGE_AUTH_FAILED = 0,
288 EFI_IMAGE_AUTH_PASSED,
289};
290
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200291/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200292 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200293 *
294 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200295 * @exit_status: exit status passed to Exit()
296 * @exit_data_size: exit data size passed to Exit()
297 * @exit_data: exit data passed to Exit()
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200298 * @exit_jmp: long jump buffer for returning form started image
299 * @entry: entry address of the relocated image
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200300 */
301struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200302 struct efi_object header;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200303 efi_status_t exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200304 efi_uintn_t *exit_data_size;
305 u16 **exit_data;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200306 struct jmp_buf_data exit_jmp;
307 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
308 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200309 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900310 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200311};
312
313/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200314 * struct efi_event
315 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100316 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200317 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200318 * @type: Type of event, see efi_create_event
319 * @notify_tpl: Task priority level of notifications
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200320 * @nofify_function: Function to call when the event is triggered
321 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100322 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100323 * @trigger_time: Period of the timer
324 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200325 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100326 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200327 */
328struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100329 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200330 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200331 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100332 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200333 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
334 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100335 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200336 u64 trigger_next;
337 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200338 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200339 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200340};
341
Alexander Grafbee91162016-03-04 01:09:59 +0100342/* This list contains all UEFI objects we know of */
343extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100344/* List of all events */
345extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100346
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200347/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200348 * struct efi_protocol_notification - handle for notified protocol
349 *
350 * When a protocol interface is installed for which an event was registered with
351 * the RegisterProtocolNotify() service this structure is used to hold the
352 * handle on which the protocol interface was installed.
353 *
354 * @link: link to list of all handles notified for this event
355 * @handle: handle on which the notified protocol interface was installed
356 */
357struct efi_protocol_notification {
358 struct list_head link;
359 efi_handle_t handle;
360};
361
362/**
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200363 * efi_register_notify_event - event registered by RegisterProtocolNotify()
364 *
365 * The address of this structure serves as registration value.
366 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200367 * @link: link to list of all registered events
368 * @event: registered event. The same event may registered for multiple
369 * GUIDs.
370 * @protocol: protocol for which the event is registered
371 * @handles: linked list of all handles on which the notified protocol was
372 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200373 */
374struct efi_register_notify_event {
375 struct list_head link;
376 struct efi_event *event;
377 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200378 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200379};
380
381/* List of all events registered by RegisterProtocolNotify() */
382extern struct list_head efi_register_notify_events;
383
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100384/* Initialize efi execution environment */
385efi_status_t efi_init_obj_list(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100386/* Install device tree */
387efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100388/* Run loaded UEFI image */
389efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200390/* Initialize variable services */
391efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200392/* Notify ExitBootServices() is called */
393void efi_variables_boot_exit_notify(void);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200394/* Called by bootefi to initialize root node */
395efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200396/* Called by bootefi to initialize runtime */
397efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200398/* efi_runtime_detach() - detach unimplemented runtime functions */
399void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100400/* efi_convert_pointer() - convert pointer to virtual address */
401efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
402 void **address);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200403/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200404efi_status_t efi_console_register(void);
Alexander Graf2a22d052016-03-04 01:10:02 +0100405/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtdf9cf562018-02-09 20:55:47 +0100406efi_status_t efi_disk_register(void);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100407/* Create handles and protocols for the partitions of a block device */
408int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
409 const char *if_typename, int diskid,
410 const char *pdevname);
AKASHI Takahiro41fd5062020-04-27 18:48:20 +0900411/* Check if it is EFI system partition */
412bool efi_disk_is_system_part(efi_handle_t handle);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100413/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100414efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200415/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100416efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200417/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100418efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200419efi_status_t efi_initrd_register(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200420/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600421/**
Bin Meng86df34d2018-06-27 20:38:03 -0700422 * efi_acpi_register() - write out ACPI tables
423 *
424 * Called by bootefi to make ACPI tables available
425 *
426 * @return 0 if OK, -ENOMEM if no memory is available for the tables
427 */
428efi_status_t efi_acpi_register(void);
429/**
Simon Glass0864c562018-05-16 09:42:19 -0600430 * efi_smbios_register() - write out SMBIOS tables
431 *
432 * Called by bootefi to make SMBIOS tables available
433 *
434 * @return 0 if OK, -ENOMEM if no memory is available for the tables
435 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100436efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200437
Rob Clark2a920802017-09-13 18:05:34 -0400438struct efi_simple_file_system_protocol *
439efi_fs_from_path(struct efi_device_path *fp);
440
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200441/* Called by networking code to memorize the dhcp ack package */
442void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200443/* Called by efi_set_watchdog_timer to reset the timer */
444efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200445
Alexander Grafbee91162016-03-04 01:09:59 +0100446/* Called from places to check whether a timer expired */
447void efi_timer_check(void);
448/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900449efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
450 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100451 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100452/* Called once to store the pristine gd pointer */
453void efi_save_gd(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400454/* Special case handler for error/abort that just tries to dtrt to get
455 * back to u-boot world */
Alexander Grafbee91162016-03-04 01:09:59 +0100456void efi_restore_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100457/* Call this to relocate the runtime section to an address space */
458void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100459/* Call this to set the current device name */
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200460void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100461/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200462void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200463/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100464efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100465/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200466void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100467/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100468struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900469/* Load image */
470efi_status_t EFIAPI efi_load_image(bool boot_policy,
471 efi_handle_t parent_image,
472 struct efi_device_path *file_path,
473 void *source_buffer,
474 efi_uintn_t source_size,
475 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100476/* Start image */
477efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
478 efi_uintn_t *exit_data_size,
479 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900480/* Unload image */
481efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200482/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100483efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200484 const efi_guid_t *protocol_guid,
485 struct efi_handler **handler);
486/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100487efi_status_t efi_add_protocol(const efi_handle_t handle,
488 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200489 void *protocol_interface);
490/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100491efi_status_t efi_remove_protocol(const efi_handle_t handle,
492 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200493 void *protocol_interface);
494/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100495efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200496/* Install multiple protocol interfaces */
497efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
498 (efi_handle_t *handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900499/* Get handles that support a given protocol */
500efi_status_t EFIAPI efi_locate_handle_buffer(
501 enum efi_locate_search_type search_type,
502 const efi_guid_t *protocol, void *search_key,
503 efi_uintn_t *no_handles, efi_handle_t **buffer);
504/* Close an previously opened protocol interface */
505efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
506 const efi_guid_t *protocol,
507 efi_handle_t agent_handle,
508 efi_handle_t controller_handle);
509/* Open a protocol interface */
510efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
511 const efi_guid_t *protocol,
512 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200513/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100514efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200515 void (EFIAPI *notify_function) (
516 struct efi_event *event,
517 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100518 void *notify_context, efi_guid_t *group,
519 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200520/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200521efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200522 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200523/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200524void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100525
Rob Clark2a920802017-09-13 18:05:34 -0400526/* open file system: */
527struct efi_simple_file_system_protocol *efi_simple_file_system(
528 struct blk_desc *desc, int part, struct efi_device_path *dp);
529
530/* open file from device-path: */
531struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
532
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100533/**
534 * efi_size_in_pages() - convert size in bytes to size in pages
535 *
536 * This macro returns the number of EFI memory pages required to hold 'size'
537 * bytes.
538 *
539 * @size: size in bytes
540 * Return: size in pages
541 */
542#define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100543/* Generic EFI memory allocator, call this to get memory */
544void *efi_alloc(uint64_t len, int memory_type);
545/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100546efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf5d009952016-03-04 01:10:04 +0100547 uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200548/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100549efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200550/* EFI memory allocator for small allocations */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100551efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200552 void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200553/* EFI pool memory free function. */
554efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100555/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100556efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100557 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100558 efi_uintn_t *map_key,
559 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100560 uint32_t *descriptor_version);
561/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200562efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000563/* Adds a conventional range into the EFI memory map */
564efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
565 u64 ram_top);
566
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100567/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100568efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100569/* Called by board init to initialize the EFI memory map */
570int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200571/* Adds new or overrides configuration table entry to the system table */
572efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100573/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200574efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
575 struct efi_device_path *file_path,
576 struct efi_loaded_image_obj **handle_ptr,
577 struct efi_loaded_image **info_ptr);
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200578/* Print information about all loaded images */
579void efi_print_image_infos(void *pc);
Alexander Graf5d009952016-03-04 01:10:04 +0100580
Alexander Graf51735ae2016-05-11 18:25:48 +0200581#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
582extern void *efi_bounce_buffer;
583#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
584#endif
585
Rob Clarkb66c60d2017-09-13 18:05:28 -0400586
587struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200588int efi_dp_match(const struct efi_device_path *a,
589 const struct efi_device_path *b);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400590struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
591 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200592/* get size of the first device path instance excluding end node */
593efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
594/* size of multi-instance device path excluding end node */
595efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400596struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
597struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
598 const struct efi_device_path *dp2);
599struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
600 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200601/* Create a device path node of given type, sub-type, length */
602struct efi_device_path *efi_dp_create_device_node(const u8 type,
603 const u8 sub_type,
604 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200605/* Append device path instance */
606struct efi_device_path *efi_dp_append_instance(
607 const struct efi_device_path *dp,
608 const struct efi_device_path *dpi);
609/* Get next device path instance */
610struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
611 efi_uintn_t *size);
612/* Check if a device path contains muliple instances */
613bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400614
Rob Clarkb66c60d2017-09-13 18:05:28 -0400615struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100616/* Create a device node for a block device partition. */
617struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400618struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
619 const char *path);
620struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400621struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
622 uint64_t start_address,
623 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100624/* Determine the last device path node that is not the end node. */
625const struct efi_device_path *efi_dp_last_node(
626 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100627efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
628 struct efi_device_path **device_path,
629 struct efi_device_path **file_path);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900630efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
631 const char *path,
632 struct efi_device_path **device,
633 struct efi_device_path **file);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400634
635#define EFI_DP_TYPE(_dp, _type, _subtype) \
636 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
637 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
638
Alexander Graf50149ea2016-03-04 01:10:01 +0100639/*
640 * Use these to indicate that your code / data should go into the EFI runtime
641 * section and thus still be available when the OS is running
642 */
Alexander Graf7e21fbc2018-06-12 07:48:37 +0200643#define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
644#define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
Alexander Grafbee91162016-03-04 01:09:59 +0100645
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900646/* Indicate supported runtime services */
647efi_status_t efi_init_runtime_supported(void);
648
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200649/* Update CRC32 in table header */
650void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
651
Alexander Graf80a48002016-08-16 21:08:45 +0200652/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
653 * to make it available at runtime */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100654efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf80a48002016-08-16 21:08:45 +0200655
656/* Boards may provide the functions below to implement RTS functionality */
657
Alexander Graf3c63db92016-10-14 13:45:30 +0200658void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200659 enum efi_reset_type reset_type,
660 efi_status_t reset_status,
661 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100662
663/* Architecture specific initialization of the EFI subsystem */
664efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200665
Alexander Graf3c63db92016-10-14 13:45:30 +0200666efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200667 struct efi_time *time,
668 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200669
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200670efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
671
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200672#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
673/*
674 * Entry point for the tests of the EFI API.
675 * It is called by 'bootefi selftest'
676 */
677efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
678 struct efi_system_table *systab);
679#endif
680
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100681efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
682 const efi_guid_t *vendor, u32 *attributes,
683 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200684efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
685 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100686 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100687efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
688 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100689 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400690
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200691efi_status_t EFIAPI efi_query_variable_info(
692 u32 attributes, u64 *maximum_variable_storage_size,
693 u64 *remaining_variable_storage_size,
694 u64 *maximum_variable_size);
695
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900696/*
697 * See section 3.1.3 in the v2.7 UEFI spec for more details on
698 * the layout of EFI_LOAD_OPTION. In short it is:
699 *
700 * typedef struct _EFI_LOAD_OPTION {
701 * UINT32 Attributes;
702 * UINT16 FilePathListLength;
703 * // CHAR16 Description[]; <-- variable length, NULL terminated
704 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
705 * <-- FilePathListLength bytes
706 * // UINT8 OptionalData[];
707 * } EFI_LOAD_OPTION;
708 */
709struct efi_load_option {
710 u32 attributes;
711 u16 file_path_length;
712 u16 *label;
713 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200714 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900715};
716
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200717efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
718 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900719unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900720efi_status_t efi_bootmgr_load(efi_handle_t *handle);
Rob Clark9975fe92017-09-13 18:05:38 -0400721
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900722/**
723 * efi_image_regions - A list of memory regions
724 *
725 * @max: Maximum number of regions
726 * @num: Number of regions
727 * @reg: array of regions
728 */
729struct efi_image_regions {
730 int max;
731 int num;
732 struct image_region reg[];
733};
734
735/**
736 * efi_sig_data - A decoded data of struct efi_signature_data
737 *
738 * This structure represents an internal form of signature in
739 * signature database. A listed list may represent a signature list.
740 *
741 * @next: Pointer to next entry
742 * @onwer: Signature owner
743 * @data: Pointer to signature data
744 * @size: Size of signature data
745 */
746struct efi_sig_data {
747 struct efi_sig_data *next;
748 efi_guid_t owner;
749 void *data;
750 size_t size;
751};
752
753/**
754 * efi_signature_store - A decoded data of signature database
755 *
756 * This structure represents an internal form of signature database.
757 *
758 * @next: Pointer to next entry
759 * @sig_type: Signature type
760 * @sig_data_list: Pointer to signature list
761 */
762struct efi_signature_store {
763 struct efi_signature_store *next;
764 efi_guid_t sig_type;
765 struct efi_sig_data *sig_data_list;
766};
767
768struct x509_certificate;
769struct pkcs7_message;
770
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900771bool efi_signature_lookup_digest(struct efi_image_regions *regs,
772 struct efi_signature_store *db);
AKASHI Takahiro11bafb22020-07-08 14:01:56 +0900773bool efi_signature_verify_one(struct efi_image_regions *regs,
774 struct pkcs7_message *msg,
775 struct efi_signature_store *db);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900776bool efi_signature_verify_with_sigdb(struct efi_image_regions *regs,
777 struct pkcs7_message *msg,
AKASHI Takahiro11bafb22020-07-08 14:01:56 +0900778 struct efi_signature_store *db,
779 struct efi_signature_store *dbx);
780bool efi_signature_check_signers(struct pkcs7_message *msg,
781 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900782
783efi_status_t efi_image_region_add(struct efi_image_regions *regs,
784 const void *start, const void *end,
785 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900786
787void efi_sigstore_free(struct efi_signature_store *sigstore);
788struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900789
790bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900791
792bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
793 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900794
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +0200795/* runtime implementation of memcpy() */
796void efi_memcpy_runtime(void *dest, const void *src, size_t n);
797
Stephen Warren9b5e6392018-08-30 15:43:43 -0600798#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafbee91162016-03-04 01:09:59 +0100799
Alexander Graf50149ea2016-03-04 01:10:01 +0100800/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf3c63db92016-10-14 13:45:30 +0200801#define __efi_runtime_data
802#define __efi_runtime
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100803static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
804{
805 return EFI_SUCCESS;
806}
Alexander Graf50149ea2016-03-04 01:10:01 +0100807
Alexander Grafbee91162016-03-04 01:09:59 +0100808/* No loader configured, stub out EFI_ENTRY */
809static inline void efi_restore_gd(void) { }
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200810static inline void efi_set_bootdev(const char *dev, const char *devnr,
811 const char *path) { }
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200812static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200813static inline void efi_print_image_infos(void *pc) { }
Alexander Grafbee91162016-03-04 01:09:59 +0100814
Stephen Warren9b5e6392018-08-30 15:43:43 -0600815#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200816
817#endif /* _EFI_LOADER_H */