blob: 9533df26dc9e60bad72f0c21f47fa2ef1cd61439 [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Alexander Graf4e0c1c12016-03-04 01:09:58 +01002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf4e0c1c12016-03-04 01:09:58 +01006 */
7
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +02008#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
Alexander Grafc15d9212016-03-04 01:09:59 +010011#include <common.h>
Simon Glass655306c2020-05-10 11:39:58 -060012#include <blk.h>
Simon Glass0f2af882020-05-10 11:40:05 -060013#include <log.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010014#include <part_efi.h>
15#include <efi_api.h>
AKASHI Takahiro2c0f9f72020-04-21 09:38:38 +090016#include <image.h>
AKASHI Takahiro0e104e32020-04-14 11:51:44 +090017#include <pe.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010018
Simon Glass655306c2020-05-10 11:39:58 -060019struct blk_desc;
20
Simon Glass16fc74a2019-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 Ganu196f66d2019-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 Grafc15d9212016-03-04 01:09:59 +010031/* No need for efi loader support in SPL */
Stephen Warrend0de8062018-08-30 15:43:43 -060032#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010033
Alexander Graf4e0c1c12016-03-04 01:09:58 +010034#include <linux/list.h>
AKASHI Takahiro1faaca42020-04-14 11:51:39 +090035#include <linux/oid_registry.h>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010036
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +020037/* Maximum number of configuration tables */
38#define EFI_MAX_CONFIGURATION_TABLES 16
39
Heinrich Schuchardt79d72022018-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 Takahiro659a6262019-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 Schuchardtc770aaa2020-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 Schuchardt79d72022018-09-20 21:58:23 +020052
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +010053/* Use internal device tree when starting UEFI application */
Heinrich Schuchardt62467412019-12-08 01:07:01 +010054#define EFI_FDT_USE_INTERNAL NULL
Heinrich Schuchardt6fbb8ac2019-11-28 06:46:09 +010055
AKASHI Takahiro0b275752019-04-16 13:24:20 +090056/* Root node */
57extern efi_handle_t efi_root;
58
Heinrich Schuchardta9931732020-03-19 15:16:31 +010059/* EFI system partition */
60extern struct efi_system_partition {
61 enum if_type if_type;
62 int devnum;
63 u8 part;
64} efi_system_partition;
65
Rob Clark86789d52017-07-27 08:04:18 -040066int __efi_entry_check(void);
67int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +020068const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -040069const char *__efi_nesting_inc(void);
70const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -040071
Rob Clark63ea77a2017-07-27 08:04:17 -040072/*
73 * Enter the u-boot world from UEFI:
74 */
Alexander Grafc15d9212016-03-04 01:09:59 +010075#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -040076 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -040077 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
78 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +010079 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +010080
Rob Clark63ea77a2017-07-27 08:04:17 -040081/*
82 * Exit the u-boot world back to UEFI:
83 */
Rob Clark84a19a02017-07-24 10:31:52 -040084#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +020085 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -040086 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +020087 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -040088 assert(__efi_exit_check()); \
89 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -040090 })
Alexander Grafc15d9212016-03-04 01:09:59 +010091
Rob Clark63ea77a2017-07-27 08:04:17 -040092/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +020093 * Call non-void UEFI function from u-boot and retrieve return value:
94 */
95#define EFI_CALL(exp) ({ \
96 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
97 assert(__efi_exit_check()); \
98 typeof(exp) _r = exp; \
99 assert(__efi_entry_check()); \
100 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
101 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
102 _r; \
103})
104
105/*
106 * Call void UEFI function from u-boot:
Rob Clark63ea77a2017-07-27 08:04:17 -0400107 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +0200108#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -0400109 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -0400110 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400111 exp; \
Rob Clark86789d52017-07-27 08:04:18 -0400112 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -0400113 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -0400114 } while(0)
115
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200116/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100117 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200118 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +0100119#define EFI_PRINT(format, ...) ({ \
120 debug("%sEFI: " format, __efi_nesting(), \
121 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +0200122 })
123
Alexander Graf59254d62018-04-23 07:59:47 +0200124#ifdef CONFIG_SYS_CACHELINE_SIZE
125#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
126#else
127/* Just use the greatest cache flush alignment requirement I'm aware of */
128#define EFI_CACHELINE_SIZE 128
129#endif
130
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200131/* Key identifying current memory map */
132extern efi_uintn_t efi_memory_map_key;
133
Alexander Graf0bd425a2016-03-04 01:10:01 +0100134extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100135extern struct efi_system_table systab;
136
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200137extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200138extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200139extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200140extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100141/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
142extern const struct efi_device_path_utilities_protocol
143 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200144/* deprecated version of the EFI_UNICODE_COLLATION_PROTOCOL */
145extern const struct efi_unicode_collation_protocol
146 efi_unicode_collation_protocol;
147/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200148extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200149 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900150extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
151extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900152extern const struct efi_hii_database_protocol efi_hii_database;
153extern const struct efi_hii_string_protocol efi_hii_string;
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530154extern const struct efi_rng_protocol efi_rng_protocol;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100155
Rob Clark85dd7212017-09-13 18:05:30 -0400156uint16_t *efi_dp_str(struct efi_device_path *dp);
157
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200158/* GUID of the U-Boot root node */
159extern const efi_guid_t efi_u_boot_guid;
AKASHI Takahiro659a6262019-09-12 13:52:35 +0900160#ifdef CONFIG_SANDBOX
161/* GUID of U-Boot host device on sandbox */
162extern const efi_guid_t efi_guid_host_dev;
163#endif
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100164/* GUID of the EFI_BLOCK_IO_PROTOCOL */
165extern const efi_guid_t efi_block_io_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400166extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100167extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100168extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100169/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
170extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +0100171/* event group ExitBootServices() invoked */
172extern const efi_guid_t efi_guid_event_group_exit_boot_services;
173/* event group SetVirtualAddressMap() invoked */
174extern const efi_guid_t efi_guid_event_group_virtual_address_change;
175/* event group memory map changed */
176extern const efi_guid_t efi_guid_event_group_memory_map_change;
177/* event group boot manager about to boot */
178extern const efi_guid_t efi_guid_event_group_ready_to_boot;
179/* event group ResetSystem() invoked (before ExitBootServices) */
180extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +0100181/* GUID of the device tree table */
182extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100183extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900184extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200185extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-09-13 18:05:34 -0400186extern const efi_guid_t efi_simple_file_system_protocol_guid;
187extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt37fb4b92018-04-04 15:42:11 +0200188/* GUID for file system information */
189extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100190extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200191/* GUID of the deprecated Unicode collation protocol */
192extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200193/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200194extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900195extern const efi_guid_t efi_guid_hii_config_routing_protocol;
196extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900197extern const efi_guid_t efi_guid_hii_database_protocol;
198extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900199/* GUIDs for authentication */
200extern const efi_guid_t efi_guid_image_security_database;
201extern const efi_guid_t efi_guid_sha256;
202extern const efi_guid_t efi_guid_cert_x509;
203extern const efi_guid_t efi_guid_cert_x509_sha256;
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900204extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100205
Sughosh Ganu693a4f42019-12-29 00:01:06 +0530206/* GUID of RNG protocol */
207extern const efi_guid_t efi_guid_rng_protocol;
208
Alexander Graf0bd425a2016-03-04 01:10:01 +0100209extern unsigned int __efi_runtime_start, __efi_runtime_stop;
210extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
211
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200212/**
213 * struct efi_open_protocol_info_item - open protocol info item
214 *
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100215 * When a protocol is opened a open protocol info entry is created.
216 * These are maintained in a list.
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200217 *
218 * @link: link to the list of open protocol info entries of a protocol
219 * @info: information about the opening of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100220 */
221struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100222 struct list_head link;
223 struct efi_open_protocol_info_entry info;
224};
225
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200226/**
227 * struct efi_handler - single protocol interface of a handle
228 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100229 * When the UEFI payload wants to open a protocol on an object to get its
230 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100231 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200232 *
233 * @link: link to the list of protocols of a handle
234 * @guid: GUID of the protocol
235 * @protocol_interface: protocol interface
236 * @open_infos link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100237 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100238struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100239 struct list_head link;
Alexander Grafc15d9212016-03-04 01:09:59 +0100240 const efi_guid_t *guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200241 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100242 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100243};
244
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200245/**
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200246 * enum efi_object_type - type of EFI object
247 *
248 * In UnloadImage we must be able to identify if the handle relates to a
249 * started image.
250 */
251enum efi_object_type {
252 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200253 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200254 EFI_OBJECT_TYPE_LOADED_IMAGE,
255 EFI_OBJECT_TYPE_STARTED_IMAGE,
256};
257
258/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200259 * struct efi_object - dereferenced EFI handle
260 *
261 * @link: pointers to put the handle into a linked list
262 * @protocols: linked list with the protocol interfaces installed on this
263 * handle
264 *
265 * UEFI offers a flexible and expandable object model. The objects in the UEFI
266 * API are devices, drivers, and loaded images. struct efi_object is our storage
267 * structure for these objects.
268 *
269 * When including this structure into a larger structure always put it first so
270 * that when deleting a handle the whole encompassing structure can be freed.
Alexander Grafc15d9212016-03-04 01:09:59 +0100271 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200272 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
273 * has been created for such pointers.
Alexander Grafc15d9212016-03-04 01:09:59 +0100274 */
275struct efi_object {
276 /* Every UEFI object is part of a global object list */
277 struct list_head link;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100278 /* The list of protocols */
279 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200280 enum efi_object_type type;
Alexander Grafc15d9212016-03-04 01:09:59 +0100281};
282
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900283enum efi_image_auth_status {
284 EFI_IMAGE_AUTH_FAILED = 0,
285 EFI_IMAGE_AUTH_PASSED,
286};
287
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200288/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200289 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200290 *
291 * @header: EFI object header
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200292 * @exit_status: exit status passed to Exit()
293 * @exit_data_size: exit data size passed to Exit()
294 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200295 * @exit_jmp: long jump buffer for returning form started image
296 * @entry: entry address of the relocated image
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200297 */
298struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200299 struct efi_object header;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200300 efi_status_t exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200301 efi_uintn_t *exit_data_size;
302 u16 **exit_data;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200303 struct jmp_buf_data exit_jmp;
304 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
305 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200306 u16 image_type;
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900307 enum efi_image_auth_status auth_status;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200308};
309
310/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200311 * struct efi_event
312 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100313 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200314 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200315 * @type: Type of event, see efi_create_event
316 * @notify_tpl: Task priority level of notifications
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200317 * @nofify_function: Function to call when the event is triggered
318 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100319 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100320 * @trigger_time: Period of the timer
321 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200322 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100323 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200324 */
325struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100326 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200327 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200328 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100329 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200330 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
331 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100332 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200333 u64 trigger_next;
334 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200335 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200336 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200337};
338
Alexander Grafc15d9212016-03-04 01:09:59 +0100339/* This list contains all UEFI objects we know of */
340extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100341/* List of all events */
342extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100343
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200344/**
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200345 * struct efi_protocol_notification - handle for notified protocol
346 *
347 * When a protocol interface is installed for which an event was registered with
348 * the RegisterProtocolNotify() service this structure is used to hold the
349 * handle on which the protocol interface was installed.
350 *
351 * @link: link to list of all handles notified for this event
352 * @handle: handle on which the notified protocol interface was installed
353 */
354struct efi_protocol_notification {
355 struct list_head link;
356 efi_handle_t handle;
357};
358
359/**
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200360 * efi_register_notify_event - event registered by RegisterProtocolNotify()
361 *
362 * The address of this structure serves as registration value.
363 *
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200364 * @link: link to list of all registered events
365 * @event: registered event. The same event may registered for multiple
366 * GUIDs.
367 * @protocol: protocol for which the event is registered
368 * @handles: linked list of all handles on which the notified protocol was
369 * installed
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200370 */
371struct efi_register_notify_event {
372 struct list_head link;
373 struct efi_event *event;
374 efi_guid_t protocol;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200375 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200376};
377
378/* List of all events registered by RegisterProtocolNotify() */
379extern struct list_head efi_register_notify_events;
380
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100381/* Initialize efi execution environment */
382efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt62467412019-12-08 01:07:01 +0100383/* Install device tree */
384efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtffb90592019-12-07 20:51:06 +0100385/* Run loaded UEFI image */
386efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardtcf3b1182019-06-20 13:52:16 +0200387/* Initialize variable services */
388efi_status_t efi_init_variables(void);
Heinrich Schuchardt2ac62582019-06-20 15:25:48 +0200389/* Notify ExitBootServices() is called */
390void efi_variables_boot_exit_notify(void);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200391/* Called by bootefi to initialize root node */
392efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200393/* Called by bootefi to initialize runtime */
394efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200395/* efi_runtime_detach() - detach unimplemented runtime functions */
396void efi_runtime_detach(void);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200397/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200398efi_status_t efi_console_register(void);
Alexander Grafe83be452016-03-04 01:10:02 +0100399/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtcde7a362018-02-09 20:55:47 +0100400efi_status_t efi_disk_register(void);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100401/* Create handles and protocols for the partitions of a block device */
402int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
403 const char *if_typename, int diskid,
404 const char *pdevname);
AKASHI Takahiro911df642020-04-27 18:48:20 +0900405/* Check if it is EFI system partition */
406bool efi_disk_is_system_part(efi_handle_t handle);
Alexander Grafd65783d2016-03-15 18:38:21 +0100407/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100408efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200409/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100410efi_status_t efi_net_register(void);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200411/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100412efi_status_t efi_watchdog_register(void);
Ilias Apalodimas3510ba72020-02-21 09:55:45 +0200413efi_status_t efi_initrd_register(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200414/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600415/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700416 * efi_acpi_register() - write out ACPI tables
417 *
418 * Called by bootefi to make ACPI tables available
419 *
420 * @return 0 if OK, -ENOMEM if no memory is available for the tables
421 */
422efi_status_t efi_acpi_register(void);
423/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600424 * efi_smbios_register() - write out SMBIOS tables
425 *
426 * Called by bootefi to make SMBIOS tables available
427 *
428 * @return 0 if OK, -ENOMEM if no memory is available for the tables
429 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100430efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200431
Rob Clark53142032017-09-13 18:05:34 -0400432struct efi_simple_file_system_protocol *
433efi_fs_from_path(struct efi_device_path *fp);
434
Alexander Graf94c4b992016-05-06 21:01:01 +0200435/* Called by networking code to memorize the dhcp ack package */
436void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200437/* Called by efi_set_watchdog_timer to reset the timer */
438efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200439
Alexander Grafc15d9212016-03-04 01:09:59 +0100440/* Called from places to check whether a timer expired */
441void efi_timer_check(void);
442/* PE loader implementation */
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900443efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
444 void *efi, size_t efi_size,
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100445 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100446/* Called once to store the pristine gd pointer */
447void efi_save_gd(void);
Rob Clark86789d52017-07-27 08:04:18 -0400448/* Special case handler for error/abort that just tries to dtrt to get
449 * back to u-boot world */
Alexander Grafc15d9212016-03-04 01:09:59 +0100450void efi_restore_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100451/* Call this to relocate the runtime section to an address space */
452void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf8f19f262016-03-04 01:10:14 +0100453/* Call this to set the current device name */
Alexander Grafc49a1b82016-04-11 16:16:19 +0200454void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100455/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200456void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200457/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100458efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100459/* Delete handle */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200460void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100461/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100462struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900463/* Load image */
464efi_status_t EFIAPI efi_load_image(bool boot_policy,
465 efi_handle_t parent_image,
466 struct efi_device_path *file_path,
467 void *source_buffer,
468 efi_uintn_t source_size,
469 efi_handle_t *image_handle);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100470/* Start image */
471efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
472 efi_uintn_t *exit_data_size,
473 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900474/* Unload image */
475efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200476/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100477efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200478 const efi_guid_t *protocol_guid,
479 struct efi_handler **handler);
480/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100481efi_status_t efi_add_protocol(const efi_handle_t handle,
482 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200483 void *protocol_interface);
484/* Delete protocol from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100485efi_status_t efi_remove_protocol(const efi_handle_t handle,
486 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200487 void *protocol_interface);
488/* Delete all protocols from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100489efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200490/* Install multiple protocol interfaces */
491efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
492 (efi_handle_t *handle, ...);
AKASHI Takahirod99b1b32020-03-17 11:12:36 +0900493/* Get handles that support a given protocol */
494efi_status_t EFIAPI efi_locate_handle_buffer(
495 enum efi_locate_search_type search_type,
496 const efi_guid_t *protocol, void *search_key,
497 efi_uintn_t *no_handles, efi_handle_t **buffer);
498/* Close an previously opened protocol interface */
499efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
500 const efi_guid_t *protocol,
501 efi_handle_t agent_handle,
502 efi_handle_t controller_handle);
503/* Open a protocol interface */
504efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
505 const efi_guid_t *protocol,
506 void **protocol_interface);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200507/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100508efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200509 void (EFIAPI *notify_function) (
510 struct efi_event *event,
511 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100512 void *notify_context, efi_guid_t *group,
513 struct efi_event **event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200514/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200515efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200516 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200517/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200518void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100519
Rob Clark53142032017-09-13 18:05:34 -0400520/* open file system: */
521struct efi_simple_file_system_protocol *efi_simple_file_system(
522 struct blk_desc *desc, int part, struct efi_device_path *dp);
523
524/* open file from device-path: */
525struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
526
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100527/**
528 * efi_size_in_pages() - convert size in bytes to size in pages
529 *
530 * This macro returns the number of EFI memory pages required to hold 'size'
531 * bytes.
532 *
533 * @size: size in bytes
534 * Return: size in pages
535 */
536#define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf8623f922016-03-04 01:10:04 +0100537/* Generic EFI memory allocator, call this to get memory */
538void *efi_alloc(uint64_t len, int memory_type);
539/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100540efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf8623f922016-03-04 01:10:04 +0100541 uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200542/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100543efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200544/* EFI memory allocator for small allocations */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100545efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200546 void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200547/* EFI pool memory free function. */
548efi_status_t efi_free_pool(void *buffer);
Alexander Graf8623f922016-03-04 01:10:04 +0100549/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100550efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100551 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100552 efi_uintn_t *map_key,
553 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100554 uint32_t *descriptor_version);
555/* Adds a range into the EFI memory map */
Michael Walle282d3862020-05-17 12:29:19 +0200556efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidene009e7a2019-09-03 17:43:43 +0000557/* Adds a conventional range into the EFI memory map */
558efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
559 u64 ram_top);
560
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100561/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100562efi_status_t efi_driver_init(void);
Alexander Graf8623f922016-03-04 01:10:04 +0100563/* Called by board init to initialize the EFI memory map */
564int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200565/* Adds new or overrides configuration table entry to the system table */
566efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100567/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200568efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
569 struct efi_device_path *file_path,
570 struct efi_loaded_image_obj **handle_ptr,
571 struct efi_loaded_image **info_ptr);
Heinrich Schuchardt83d96b72018-04-05 11:56:21 +0200572/* Print information about all loaded images */
573void efi_print_image_infos(void *pc);
Alexander Graf8623f922016-03-04 01:10:04 +0100574
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200575#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
576extern void *efi_bounce_buffer;
577#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
578#endif
579
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400580
581struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200582int efi_dp_match(const struct efi_device_path *a,
583 const struct efi_device_path *b);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400584struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
585 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200586/* get size of the first device path instance excluding end node */
587efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
588/* size of multi-instance device path excluding end node */
589efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400590struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
591struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
592 const struct efi_device_path *dp2);
593struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
594 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200595/* Create a device path node of given type, sub-type, length */
596struct efi_device_path *efi_dp_create_device_node(const u8 type,
597 const u8 sub_type,
598 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200599/* Append device path instance */
600struct efi_device_path *efi_dp_append_instance(
601 const struct efi_device_path *dp,
602 const struct efi_device_path *dpi);
603/* Get next device path instance */
604struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
605 efi_uintn_t *size);
606/* Check if a device path contains muliple instances */
607bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400608
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400609struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100610/* Create a device node for a block device partition. */
611struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400612struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
613 const char *path);
614struct efi_device_path *efi_dp_from_eth(void);
Rob Clark18ceba72017-10-10 08:23:06 -0400615struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
616 uint64_t start_address,
617 uint64_t end_address);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100618/* Determine the last device path node that is not the end node. */
619const struct efi_device_path *efi_dp_last_node(
620 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100621efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
622 struct efi_device_path **device_path,
623 struct efi_device_path **file_path);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900624efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
625 const char *path,
626 struct efi_device_path **device,
627 struct efi_device_path **file);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400628
629#define EFI_DP_TYPE(_dp, _type, _subtype) \
630 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
631 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
632
Alexander Graf0bd425a2016-03-04 01:10:01 +0100633/*
634 * Use these to indicate that your code / data should go into the EFI runtime
635 * section and thus still be available when the OS is running
636 */
Alexander Graf94a10f22018-06-12 07:48:37 +0200637#define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
638#define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
Alexander Grafc15d9212016-03-04 01:09:59 +0100639
AKASHI Takahiro32401842019-06-05 13:21:38 +0900640/* Indicate supported runtime services */
641efi_status_t efi_init_runtime_supported(void);
642
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200643/* Update CRC32 in table header */
644void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
645
Alexander Graf77256092016-08-16 21:08:45 +0200646/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
647 * to make it available at runtime */
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100648efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf77256092016-08-16 21:08:45 +0200649
650/* Boards may provide the functions below to implement RTS functionality */
651
Alexander Graf393dd912016-10-14 13:45:30 +0200652void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200653 enum efi_reset_type reset_type,
654 efi_status_t reset_status,
655 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100656
657/* Architecture specific initialization of the EFI subsystem */
658efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200659
Alexander Graf393dd912016-10-14 13:45:30 +0200660efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200661 struct efi_time *time,
662 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200663
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200664efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
665
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200666#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
667/*
668 * Entry point for the tests of the EFI API.
669 * It is called by 'bootefi selftest'
670 */
671efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
672 struct efi_system_table *systab);
673#endif
674
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100675efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
676 const efi_guid_t *vendor, u32 *attributes,
677 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200678efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
679 u16 *variable_name,
Heinrich Schuchardt82cd6c42020-03-22 18:28:20 +0100680 efi_guid_t *vendor);
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100681efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
682 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100683 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400684
Heinrich Schuchardt9b19dae2019-06-20 12:13:05 +0200685efi_status_t EFIAPI efi_query_variable_info(
686 u32 attributes, u64 *maximum_variable_storage_size,
687 u64 *remaining_variable_storage_size,
688 u64 *maximum_variable_size);
689
AKASHI Takahirobd237742018-11-05 18:06:41 +0900690/*
691 * See section 3.1.3 in the v2.7 UEFI spec for more details on
692 * the layout of EFI_LOAD_OPTION. In short it is:
693 *
694 * typedef struct _EFI_LOAD_OPTION {
695 * UINT32 Attributes;
696 * UINT16 FilePathListLength;
697 * // CHAR16 Description[]; <-- variable length, NULL terminated
698 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
699 * <-- FilePathListLength bytes
700 * // UINT8 OptionalData[];
701 * } EFI_LOAD_OPTION;
702 */
703struct efi_load_option {
704 u32 attributes;
705 u16 file_path_length;
706 u16 *label;
707 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +0200708 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +0900709};
710
711void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
712unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
AKASHI Takahiro14ff23b2019-04-19 12:22:35 +0900713efi_status_t efi_bootmgr_load(efi_handle_t *handle);
Rob Clarkc84c1102017-09-13 18:05:38 -0400714
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900715/**
716 * efi_image_regions - A list of memory regions
717 *
718 * @max: Maximum number of regions
719 * @num: Number of regions
720 * @reg: array of regions
721 */
722struct efi_image_regions {
723 int max;
724 int num;
725 struct image_region reg[];
726};
727
728/**
729 * efi_sig_data - A decoded data of struct efi_signature_data
730 *
731 * This structure represents an internal form of signature in
732 * signature database. A listed list may represent a signature list.
733 *
734 * @next: Pointer to next entry
735 * @onwer: Signature owner
736 * @data: Pointer to signature data
737 * @size: Size of signature data
738 */
739struct efi_sig_data {
740 struct efi_sig_data *next;
741 efi_guid_t owner;
742 void *data;
743 size_t size;
744};
745
746/**
747 * efi_signature_store - A decoded data of signature database
748 *
749 * This structure represents an internal form of signature database.
750 *
751 * @next: Pointer to next entry
752 * @sig_type: Signature type
753 * @sig_data_list: Pointer to signature list
754 */
755struct efi_signature_store {
756 struct efi_signature_store *next;
757 efi_guid_t sig_type;
758 struct efi_sig_data *sig_data_list;
759};
760
761struct x509_certificate;
762struct pkcs7_message;
763
764bool efi_signature_verify_cert(struct x509_certificate *cert,
765 struct efi_signature_store *dbx);
766bool efi_signature_verify_signers(struct pkcs7_message *msg,
767 struct efi_signature_store *dbx);
768bool efi_signature_verify_with_sigdb(struct efi_image_regions *regs,
769 struct pkcs7_message *msg,
770 struct efi_signature_store *db,
771 struct x509_certificate **cert);
772
773efi_status_t efi_image_region_add(struct efi_image_regions *regs,
774 const void *start, const void *end,
775 int nocheck);
AKASHI Takahirod2cefc82020-04-14 11:51:40 +0900776
777void efi_sigstore_free(struct efi_signature_store *sigstore);
778struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahirob0f49ee2020-04-14 11:51:41 +0900779
780bool efi_secure_boot_enabled(void);
AKASHI Takahiro0e104e32020-04-14 11:51:44 +0900781
782bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
783 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro1faaca42020-04-14 11:51:39 +0900784
Stephen Warrend0de8062018-08-30 15:43:43 -0600785#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafc15d9212016-03-04 01:09:59 +0100786
Alexander Graf0bd425a2016-03-04 01:10:01 +0100787/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf393dd912016-10-14 13:45:30 +0200788#define __efi_runtime_data
789#define __efi_runtime
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100790static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
791{
792 return EFI_SUCCESS;
793}
Alexander Graf0bd425a2016-03-04 01:10:01 +0100794
Alexander Grafc15d9212016-03-04 01:09:59 +0100795/* No loader configured, stub out EFI_ENTRY */
796static inline void efi_restore_gd(void) { }
Alexander Grafc49a1b82016-04-11 16:16:19 +0200797static inline void efi_set_bootdev(const char *dev, const char *devnr,
798 const char *path) { }
Alexander Graf94c4b992016-05-06 21:01:01 +0200799static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardt83d96b72018-04-05 11:56:21 +0200800static inline void efi_print_image_infos(void *pc) { }
Alexander Grafc15d9212016-03-04 01:09:59 +0100801
Stephen Warrend0de8062018-08-30 15:43:43 -0600802#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +0200803
804#endif /* _EFI_LOADER_H */