blob: 7eea5566fdc974fd5b9b58b6841ccfee076559af [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;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100157
Rob Clarkadae4312017-09-13 18:05:30 -0400158uint16_t *efi_dp_str(struct efi_device_path *dp);
159
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200160/* GUID of the U-Boot root node */
161extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro23ad52f2019-09-12 13:52:35 +0900162#ifdef CONFIG_SANDBOX
163/* GUID of U-Boot host device on sandbox */
164extern const efi_guid_t efi_guid_host_dev;
165#endif
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +0100166/* GUID of the EFI_BLOCK_IO_PROTOCOL */
167extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400168extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100169extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100170extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100171/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
172extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100173/* event group ExitBootServices() invoked */
174extern const efi_guid_t efi_guid_event_group_exit_boot_services;
175/* event group SetVirtualAddressMap() invoked */
176extern const efi_guid_t efi_guid_event_group_virtual_address_change;
177/* event group memory map changed */
178extern const efi_guid_t efi_guid_event_group_memory_map_change;
179/* event group boot manager about to boot */
180extern const efi_guid_t efi_guid_event_group_ready_to_boot;
181/* event group ResetSystem() invoked (before ExitBootServices) */
182extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100183/* GUID of the device tree table */
184extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100185extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900186extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200187extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400188extern const efi_guid_t efi_simple_file_system_protocol_guid;
189extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200190/* GUID for file system information */
191extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100192extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200193/* GUID of the deprecated Unicode collation protocol */
194extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200195/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200196extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900197extern const efi_guid_t efi_guid_hii_config_routing_protocol;
198extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900199extern const efi_guid_t efi_guid_hii_database_protocol;
200extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900201/* GUIDs for authentication */
202extern const efi_guid_t efi_guid_image_security_database;
203extern const efi_guid_t efi_guid_sha256;
204extern const efi_guid_t efi_guid_cert_x509;
205extern const efi_guid_t efi_guid_cert_x509_sha256;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900206extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100207
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530208/* GUID of RNG protocol */
209extern const efi_guid_t efi_guid_rng_protocol;
210
Alexander Graf50149ea2016-03-04 01:10:01 +0100211extern unsigned int __efi_runtime_start, __efi_runtime_stop;
212extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
213
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200214/**
215 * struct efi_open_protocol_info_item - open protocol info item
216 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100217 * When a protocol is opened a open protocol info entry is created.
218 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200219 *
220 * @link: link to the list of open protocol info entries of a protocol
221 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100222 */
223struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100224 struct list_head link;
225 struct efi_open_protocol_info_entry info;
226};
227
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200228/**
229 * struct efi_handler - single protocol interface of a handle
230 *
Alexander Grafbee91162016-03-04 01:09:59 +0100231 * When the UEFI payload wants to open a protocol on an object to get its
232 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100233 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200234 *
235 * @link: link to the list of protocols of a handle
236 * @guid: GUID of the protocol
237 * @protocol_interface: protocol interface
238 * @open_infos link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100239 */
Alexander Grafbee91162016-03-04 01:09:59 +0100240struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100241 struct list_head link;
Alexander Grafbee91162016-03-04 01:09:59 +0100242 const efi_guid_t *guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200243 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100244 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100245};
246
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200247/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200248 * enum efi_object_type - type of EFI object
249 *
250 * In UnloadImage we must be able to identify if the handle relates to a
251 * started image.
252 */
253enum efi_object_type {
254 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200255 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200256 EFI_OBJECT_TYPE_LOADED_IMAGE,
257 EFI_OBJECT_TYPE_STARTED_IMAGE,
258};
259
260/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200261 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100262 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200263 * @link: pointers to put the handle into a linked list
264 * @protocols: linked list with the protocol interfaces installed on this
265 * handle
266 *
267 * UEFI offers a flexible and expandable object model. The objects in the UEFI
268 * API are devices, drivers, and loaded images. struct efi_object is our storage
269 * structure for these objects.
270 *
271 * When including this structure into a larger structure always put it first so
272 * that when deleting a handle the whole encompassing structure can be freed.
273 *
274 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
275 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100276 */
277struct efi_object {
278 /* Every UEFI object is part of a global object list */
279 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100280 /* The list of protocols */
281 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200282 enum efi_object_type type;
Alexander Grafbee91162016-03-04 01:09:59 +0100283};
284
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900285enum efi_image_auth_status {
286 EFI_IMAGE_AUTH_FAILED = 0,
287 EFI_IMAGE_AUTH_PASSED,
288};
289
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200290/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200291 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200292 *
293 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200294 * @exit_status: exit status passed to Exit()
295 * @exit_data_size: exit data size passed to Exit()
296 * @exit_data: exit data passed to Exit()
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200297 * @exit_jmp: long jump buffer for returning form started image
298 * @entry: entry address of the relocated image
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200299 */
300struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200301 struct efi_object header;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200302 efi_status_t exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200303 efi_uintn_t *exit_data_size;
304 u16 **exit_data;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200305 struct jmp_buf_data exit_jmp;
306 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
307 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200308 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900309 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200310};
311
312/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200313 * struct efi_event
314 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100315 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200316 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200317 * @type: Type of event, see efi_create_event
318 * @notify_tpl: Task priority level of notifications
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200319 * @nofify_function: Function to call when the event is triggered
320 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100321 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100322 * @trigger_time: Period of the timer
323 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200324 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100325 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200326 */
327struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100328 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200329 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200330 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100331 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200332 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
333 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100334 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200335 u64 trigger_next;
336 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200337 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200338 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200339};
340
Alexander Grafbee91162016-03-04 01:09:59 +0100341/* This list contains all UEFI objects we know of */
342extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100343/* List of all events */
344extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100345
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200346/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200347 * struct efi_protocol_notification - handle for notified protocol
348 *
349 * When a protocol interface is installed for which an event was registered with
350 * the RegisterProtocolNotify() service this structure is used to hold the
351 * handle on which the protocol interface was installed.
352 *
353 * @link: link to list of all handles notified for this event
354 * @handle: handle on which the notified protocol interface was installed
355 */
356struct efi_protocol_notification {
357 struct list_head link;
358 efi_handle_t handle;
359};
360
361/**
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200362 * efi_register_notify_event - event registered by RegisterProtocolNotify()
363 *
364 * The address of this structure serves as registration value.
365 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200366 * @link: link to list of all registered events
367 * @event: registered event. The same event may registered for multiple
368 * GUIDs.
369 * @protocol: protocol for which the event is registered
370 * @handles: linked list of all handles on which the notified protocol was
371 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200372 */
373struct efi_register_notify_event {
374 struct list_head link;
375 struct efi_event *event;
376 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200377 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200378};
379
380/* List of all events registered by RegisterProtocolNotify() */
381extern struct list_head efi_register_notify_events;
382
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100383/* Initialize efi execution environment */
384efi_status_t efi_init_obj_list(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100385/* Install device tree */
386efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100387/* Run loaded UEFI image */
388efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200389/* Initialize variable services */
390efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200391/* Notify ExitBootServices() is called */
392void efi_variables_boot_exit_notify(void);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200393/* Called by bootefi to initialize root node */
394efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200395/* Called by bootefi to initialize runtime */
396efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200397/* efi_runtime_detach() - detach unimplemented runtime functions */
398void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100399/* efi_convert_pointer() - convert pointer to virtual address */
400efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
401 void **address);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200402/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200403efi_status_t efi_console_register(void);
Alexander Graf2a22d052016-03-04 01:10:02 +0100404/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtdf9cf562018-02-09 20:55:47 +0100405efi_status_t efi_disk_register(void);
Heinrich Schuchardtb59c13d2020-09-25 12:50:19 +0200406/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
407efi_status_t efi_rng_register(void);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100408/* Create handles and protocols for the partitions of a block device */
409int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
410 const char *if_typename, int diskid,
411 const char *pdevname);
AKASHI Takahiro41fd5062020-04-27 18:48:20 +0900412/* Check if it is EFI system partition */
413bool efi_disk_is_system_part(efi_handle_t handle);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100414/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100415efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200416/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100417efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200418/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100419efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200420efi_status_t efi_initrd_register(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200421/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600422/**
Bin Meng86df34d2018-06-27 20:38:03 -0700423 * efi_acpi_register() - write out ACPI tables
424 *
425 * Called by bootefi to make ACPI tables available
426 *
427 * @return 0 if OK, -ENOMEM if no memory is available for the tables
428 */
429efi_status_t efi_acpi_register(void);
430/**
Simon Glass0864c562018-05-16 09:42:19 -0600431 * efi_smbios_register() - write out SMBIOS tables
432 *
433 * Called by bootefi to make SMBIOS tables available
434 *
435 * @return 0 if OK, -ENOMEM if no memory is available for the tables
436 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100437efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200438
Rob Clark2a920802017-09-13 18:05:34 -0400439struct efi_simple_file_system_protocol *
440efi_fs_from_path(struct efi_device_path *fp);
441
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200442/* Called by networking code to memorize the dhcp ack package */
443void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200444/* Called by efi_set_watchdog_timer to reset the timer */
445efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200446
Alexander Grafbee91162016-03-04 01:09:59 +0100447/* Called from places to check whether a timer expired */
448void efi_timer_check(void);
449/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900450efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
451 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100452 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100453/* Called once to store the pristine gd pointer */
454void efi_save_gd(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400455/* Special case handler for error/abort that just tries to dtrt to get
456 * back to u-boot world */
Alexander Grafbee91162016-03-04 01:09:59 +0100457void efi_restore_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100458/* Call this to relocate the runtime section to an address space */
459void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100460/* Call this to set the current device name */
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200461void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100462/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200463void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200464/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100465efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100466/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200467void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100468/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100469struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900470/* Load image */
471efi_status_t EFIAPI efi_load_image(bool boot_policy,
472 efi_handle_t parent_image,
473 struct efi_device_path *file_path,
474 void *source_buffer,
475 efi_uintn_t source_size,
476 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100477/* Start image */
478efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
479 efi_uintn_t *exit_data_size,
480 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900481/* Unload image */
482efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200483/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100484efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200485 const efi_guid_t *protocol_guid,
486 struct efi_handler **handler);
487/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100488efi_status_t efi_add_protocol(const efi_handle_t handle,
489 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200490 void *protocol_interface);
491/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100492efi_status_t efi_remove_protocol(const efi_handle_t handle,
493 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200494 void *protocol_interface);
495/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100496efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200497/* Install multiple protocol interfaces */
498efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
499 (efi_handle_t *handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900500/* Get handles that support a given protocol */
501efi_status_t EFIAPI efi_locate_handle_buffer(
502 enum efi_locate_search_type search_type,
503 const efi_guid_t *protocol, void *search_key,
504 efi_uintn_t *no_handles, efi_handle_t **buffer);
505/* Close an previously opened protocol interface */
506efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
507 const efi_guid_t *protocol,
508 efi_handle_t agent_handle,
509 efi_handle_t controller_handle);
510/* Open a protocol interface */
511efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
512 const efi_guid_t *protocol,
513 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200514/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100515efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200516 void (EFIAPI *notify_function) (
517 struct efi_event *event,
518 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100519 void *notify_context, efi_guid_t *group,
520 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200521/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200522efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200523 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200524/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200525void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100526
Rob Clark2a920802017-09-13 18:05:34 -0400527/* open file system: */
528struct efi_simple_file_system_protocol *efi_simple_file_system(
529 struct blk_desc *desc, int part, struct efi_device_path *dp);
530
531/* open file from device-path: */
532struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
533
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100534/**
535 * efi_size_in_pages() - convert size in bytes to size in pages
536 *
537 * This macro returns the number of EFI memory pages required to hold 'size'
538 * bytes.
539 *
540 * @size: size in bytes
541 * Return: size in pages
542 */
543#define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100544/* Generic EFI memory allocator, call this to get memory */
545void *efi_alloc(uint64_t len, int memory_type);
546/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100547efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf5d009952016-03-04 01:10:04 +0100548 uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200549/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100550efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200551/* EFI memory allocator for small allocations */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100552efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200553 void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200554/* EFI pool memory free function. */
555efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100556/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100557efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100558 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100559 efi_uintn_t *map_key,
560 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100561 uint32_t *descriptor_version);
562/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200563efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000564/* Adds a conventional range into the EFI memory map */
565efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
566 u64 ram_top);
567
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100568/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100569efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100570/* Called by board init to initialize the EFI memory map */
571int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200572/* Adds new or overrides configuration table entry to the system table */
573efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100574/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200575efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
576 struct efi_device_path *file_path,
577 struct efi_loaded_image_obj **handle_ptr,
578 struct efi_loaded_image **info_ptr);
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200579/* Print information about all loaded images */
580void efi_print_image_infos(void *pc);
Alexander Graf5d009952016-03-04 01:10:04 +0100581
Alexander Graf51735ae2016-05-11 18:25:48 +0200582#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
583extern void *efi_bounce_buffer;
584#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
585#endif
586
Rob Clarkb66c60d2017-09-13 18:05:28 -0400587
588struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200589int efi_dp_match(const struct efi_device_path *a,
590 const struct efi_device_path *b);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400591struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
592 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200593/* get size of the first device path instance excluding end node */
594efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
595/* size of multi-instance device path excluding end node */
596efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400597struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
598struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
599 const struct efi_device_path *dp2);
600struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
601 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200602/* Create a device path node of given type, sub-type, length */
603struct efi_device_path *efi_dp_create_device_node(const u8 type,
604 const u8 sub_type,
605 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200606/* Append device path instance */
607struct efi_device_path *efi_dp_append_instance(
608 const struct efi_device_path *dp,
609 const struct efi_device_path *dpi);
610/* Get next device path instance */
611struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
612 efi_uintn_t *size);
613/* Check if a device path contains muliple instances */
614bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400615
Rob Clarkb66c60d2017-09-13 18:05:28 -0400616struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100617/* Create a device node for a block device partition. */
618struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400619struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
620 const char *path);
621struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400622struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
623 uint64_t start_address,
624 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100625/* Determine the last device path node that is not the end node. */
626const struct efi_device_path *efi_dp_last_node(
627 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100628efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
629 struct efi_device_path **device_path,
630 struct efi_device_path **file_path);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900631efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
632 const char *path,
633 struct efi_device_path **device,
634 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200635ssize_t efi_dp_check_length(const struct efi_device_path *dp,
636 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400637
638#define EFI_DP_TYPE(_dp, _type, _subtype) \
639 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
640 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
641
Alexander Graf50149ea2016-03-04 01:10:01 +0100642/*
643 * Use these to indicate that your code / data should go into the EFI runtime
644 * section and thus still be available when the OS is running
645 */
Alexander Graf7e21fbc2018-06-12 07:48:37 +0200646#define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
647#define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
Alexander Grafbee91162016-03-04 01:09:59 +0100648
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900649/* Indicate supported runtime services */
650efi_status_t efi_init_runtime_supported(void);
651
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200652/* Update CRC32 in table header */
653void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
654
Alexander Graf80a48002016-08-16 21:08:45 +0200655/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
656 * to make it available at runtime */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100657efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf80a48002016-08-16 21:08:45 +0200658
659/* Boards may provide the functions below to implement RTS functionality */
660
Alexander Graf3c63db92016-10-14 13:45:30 +0200661void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200662 enum efi_reset_type reset_type,
663 efi_status_t reset_status,
664 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100665
666/* Architecture specific initialization of the EFI subsystem */
667efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200668
Alexander Graf3c63db92016-10-14 13:45:30 +0200669efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200670 struct efi_time *time,
671 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200672
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200673efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
674
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200675#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
676/*
677 * Entry point for the tests of the EFI API.
678 * It is called by 'bootefi selftest'
679 */
680efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
681 struct efi_system_table *systab);
682#endif
683
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100684efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
685 const efi_guid_t *vendor, u32 *attributes,
686 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200687efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
688 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100689 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100690efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
691 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100692 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400693
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200694efi_status_t EFIAPI efi_query_variable_info(
695 u32 attributes, u64 *maximum_variable_storage_size,
696 u64 *remaining_variable_storage_size,
697 u64 *maximum_variable_size);
698
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900699/*
700 * See section 3.1.3 in the v2.7 UEFI spec for more details on
701 * the layout of EFI_LOAD_OPTION. In short it is:
702 *
703 * typedef struct _EFI_LOAD_OPTION {
704 * UINT32 Attributes;
705 * UINT16 FilePathListLength;
706 * // CHAR16 Description[]; <-- variable length, NULL terminated
707 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
708 * <-- FilePathListLength bytes
709 * // UINT8 OptionalData[];
710 * } EFI_LOAD_OPTION;
711 */
712struct efi_load_option {
713 u32 attributes;
714 u16 file_path_length;
715 u16 *label;
716 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200717 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900718};
719
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200720efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
721 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900722unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200723efi_status_t efi_set_load_options(efi_handle_t handle,
724 efi_uintn_t load_options_size,
725 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200726efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400727
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900728/**
729 * efi_image_regions - A list of memory regions
730 *
731 * @max: Maximum number of regions
732 * @num: Number of regions
733 * @reg: array of regions
734 */
735struct efi_image_regions {
736 int max;
737 int num;
738 struct image_region reg[];
739};
740
741/**
742 * efi_sig_data - A decoded data of struct efi_signature_data
743 *
744 * This structure represents an internal form of signature in
745 * signature database. A listed list may represent a signature list.
746 *
747 * @next: Pointer to next entry
748 * @onwer: Signature owner
749 * @data: Pointer to signature data
750 * @size: Size of signature data
751 */
752struct efi_sig_data {
753 struct efi_sig_data *next;
754 efi_guid_t owner;
755 void *data;
756 size_t size;
757};
758
759/**
760 * efi_signature_store - A decoded data of signature database
761 *
762 * This structure represents an internal form of signature database.
763 *
764 * @next: Pointer to next entry
765 * @sig_type: Signature type
766 * @sig_data_list: Pointer to signature list
767 */
768struct efi_signature_store {
769 struct efi_signature_store *next;
770 efi_guid_t sig_type;
771 struct efi_sig_data *sig_data_list;
772};
773
774struct x509_certificate;
775struct pkcs7_message;
776
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900777bool efi_signature_lookup_digest(struct efi_image_regions *regs,
778 struct efi_signature_store *db);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +0900779bool efi_signature_verify(struct efi_image_regions *regs,
780 struct pkcs7_message *msg,
781 struct efi_signature_store *db,
782 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +0900783static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
784 struct pkcs7_message *msg,
785 struct efi_signature_store *db)
786{
787 return efi_signature_verify(regs, msg, db, NULL);
788}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +0900789bool efi_signature_check_signers(struct pkcs7_message *msg,
790 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900791
792efi_status_t efi_image_region_add(struct efi_image_regions *regs,
793 const void *start, const void *end,
794 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900795
796void efi_sigstore_free(struct efi_signature_store *sigstore);
797struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900798
799bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900800
801bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
802 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900803
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +0200804/* runtime implementation of memcpy() */
805void efi_memcpy_runtime(void *dest, const void *src, size_t n);
806
Stephen Warren9b5e6392018-08-30 15:43:43 -0600807#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafbee91162016-03-04 01:09:59 +0100808
Alexander Graf50149ea2016-03-04 01:10:01 +0100809/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf3c63db92016-10-14 13:45:30 +0200810#define __efi_runtime_data
811#define __efi_runtime
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100812static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
813{
814 return EFI_SUCCESS;
815}
Alexander Graf50149ea2016-03-04 01:10:01 +0100816
Alexander Grafbee91162016-03-04 01:09:59 +0100817/* No loader configured, stub out EFI_ENTRY */
818static inline void efi_restore_gd(void) { }
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200819static inline void efi_set_bootdev(const char *dev, const char *devnr,
820 const char *path) { }
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200821static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200822static inline void efi_print_image_infos(void *pc) { }
Alexander Grafbee91162016-03-04 01:09:59 +0100823
Stephen Warren9b5e6392018-08-30 15:43:43 -0600824#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200825
826#endif /* _EFI_LOADER_H */