blob: 0a9c82a257e1438612ecdc8e149e2371b132dc68 [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 Schuchardtfccd3d92020-11-12 21:26:28 +010062/* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
63extern bool efi_st_keep_devices;
64
Heinrich Schuchardt11078bb2020-03-19 15:16:31 +010065/* EFI system partition */
66extern struct efi_system_partition {
67 enum if_type if_type;
68 int devnum;
69 u8 part;
70} efi_system_partition;
71
Rob Clarkc160d2f2017-07-27 08:04:18 -040072int __efi_entry_check(void);
73int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020074const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -040075const char *__efi_nesting_inc(void);
76const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -040077
Rob Clarka095aad2017-07-27 08:04:17 -040078/*
79 * Enter the u-boot world from UEFI:
80 */
Alexander Grafbee91162016-03-04 01:09:59 +010081#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -040082 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -040083 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
84 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +010085 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +010086
Rob Clarka095aad2017-07-27 08:04:17 -040087/*
88 * Exit the u-boot world back to UEFI:
89 */
Rob Clark804b1d72017-07-24 10:31:52 -040090#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020091 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -040092 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020093 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -040094 assert(__efi_exit_check()); \
95 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -040096 })
Alexander Grafbee91162016-03-04 01:09:59 +010097
Rob Clarka095aad2017-07-27 08:04:17 -040098/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020099 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -0400100 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +0200101#define EFI_CALL(exp) ({ \
102 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
103 assert(__efi_exit_check()); \
104 typeof(exp) _r = exp; \
105 assert(__efi_entry_check()); \
106 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
107 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
108 _r; \
109})
110
111/*
112 * Call void UEFI function from u-boot:
113 */
114#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -0400115 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400116 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -0400117 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -0400118 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -0400119 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -0400120 } while(0)
121
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200122/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100123 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200124 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +0100125#define EFI_PRINT(format, ...) ({ \
126 debug("%sEFI: " format, __efi_nesting(), \
127 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +0200128 })
129
Alexander Graf89aea432018-04-23 07:59:47 +0200130#ifdef CONFIG_SYS_CACHELINE_SIZE
131#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
132#else
133/* Just use the greatest cache flush alignment requirement I'm aware of */
134#define EFI_CACHELINE_SIZE 128
135#endif
136
Heinrich Schuchardt1fcb7ea2018-07-02 12:53:55 +0200137/* Key identifying current memory map */
138extern efi_uintn_t efi_memory_map_key;
139
Alexander Graf50149ea2016-03-04 01:10:01 +0100140extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100141extern struct efi_system_table systab;
142
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200143extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200144extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200145extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200146extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100147/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
148extern const struct efi_device_path_utilities_protocol
149 efi_device_path_utilities;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200150/* 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 Schuchardtb6f11092020-12-04 03:33:41 +0100195/* GUIDs of the Load File and Load File2 protocol */
196extern const efi_guid_t efi_guid_load_file_protocol;
197extern const efi_guid_t efi_guid_load_file2_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200198/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200199extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-01-21 12:13:00 +0900200extern const efi_guid_t efi_guid_hii_config_routing_protocol;
201extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900202extern const efi_guid_t efi_guid_hii_database_protocol;
203extern const efi_guid_t efi_guid_hii_string_protocol;
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900204/* GUIDs for authentication */
205extern const efi_guid_t efi_guid_image_security_database;
206extern const efi_guid_t efi_guid_sha256;
207extern const efi_guid_t efi_guid_cert_x509;
208extern const efi_guid_t efi_guid_cert_x509_sha256;
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900209extern const efi_guid_t efi_guid_cert_type_pkcs7;
Alexander Grafcb149c62016-03-04 01:09:58 +0100210
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530211/* GUID of RNG protocol */
212extern const efi_guid_t efi_guid_rng_protocol;
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900213/* GUID of capsule update result */
214extern const efi_guid_t efi_guid_capsule_report;
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900215/* GUID of firmware management protocol */
216extern const efi_guid_t efi_guid_firmware_management_protocol;
Jose Marinho64a8aae2021-03-02 17:26:38 +0000217/* GUID for the ESRT */
218extern const efi_guid_t efi_esrt_guid;
Sughosh Ganu33c37d92019-12-29 00:01:06 +0530219
Marek BehĂșn2bdc6f52021-05-20 13:23:56 +0200220extern char __efi_runtime_start[], __efi_runtime_stop[];
221extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
Alexander Graf50149ea2016-03-04 01:10:01 +0100222
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200223/**
224 * struct efi_open_protocol_info_item - open protocol info item
225 *
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100226 * When a protocol is opened a open protocol info entry is created.
227 * These are maintained in a list.
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200228 *
229 * @link: link to the list of open protocol info entries of a protocol
230 * @info: information about the opening of a protocol
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100231 */
232struct efi_open_protocol_info_item {
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100233 struct list_head link;
234 struct efi_open_protocol_info_entry info;
235};
236
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200237/**
238 * struct efi_handler - single protocol interface of a handle
239 *
Alexander Grafbee91162016-03-04 01:09:59 +0100240 * When the UEFI payload wants to open a protocol on an object to get its
241 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100242 * protocol GUID to the respective protocol interface
Heinrich Schuchardt1f1075c2019-05-21 17:51:35 +0200243 *
244 * @link: link to the list of protocols of a handle
245 * @guid: GUID of the protocol
246 * @protocol_interface: protocol interface
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100247 * @open_infos: link to the list of open protocol info items
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100248 */
Alexander Grafbee91162016-03-04 01:09:59 +0100249struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100250 struct list_head link;
Alexander Grafbee91162016-03-04 01:09:59 +0100251 const efi_guid_t *guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200252 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100253 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100254};
255
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200256/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200257 * enum efi_object_type - type of EFI object
258 *
259 * In UnloadImage we must be able to identify if the handle relates to a
260 * started image.
261 */
262enum efi_object_type {
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100263 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200264 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100265 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200266 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100267 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200268 EFI_OBJECT_TYPE_LOADED_IMAGE,
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100269 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200270 EFI_OBJECT_TYPE_STARTED_IMAGE,
271};
272
273/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200274 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100275 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200276 * @link: pointers to put the handle into a linked list
277 * @protocols: linked list with the protocol interfaces installed on this
278 * handle
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100279 * @type: image type if the handle relates to an image
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200280 *
281 * UEFI offers a flexible and expandable object model. The objects in the UEFI
282 * API are devices, drivers, and loaded images. struct efi_object is our storage
283 * structure for these objects.
284 *
285 * When including this structure into a larger structure always put it first so
286 * that when deleting a handle the whole encompassing structure can be freed.
287 *
288 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
289 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100290 */
291struct efi_object {
292 /* Every UEFI object is part of a global object list */
293 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100294 /* The list of protocols */
295 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200296 enum efi_object_type type;
Alexander Grafbee91162016-03-04 01:09:59 +0100297};
298
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900299enum efi_image_auth_status {
300 EFI_IMAGE_AUTH_FAILED = 0,
301 EFI_IMAGE_AUTH_PASSED,
302};
303
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200304/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200305 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200306 *
307 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200308 * @exit_status: exit status passed to Exit()
309 * @exit_data_size: exit data size passed to Exit()
310 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100311 * @exit_jmp: long jump buffer for returning from started image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200312 * @entry: entry address of the relocated image
Heinrich Schuchardt0ce3fb52020-12-28 22:42:51 +0100313 * @image_type: indicates if the image is an applicition or a driver
314 * @auth_status: indicates if the image is authenticated
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200315 */
316struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200317 struct efi_object header;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100318 efi_status_t *exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200319 efi_uintn_t *exit_data_size;
320 u16 **exit_data;
Heinrich Schuchardtf8212f02020-12-28 23:24:40 +0100321 struct jmp_buf_data *exit_jmp;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200322 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
323 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200324 u16 image_type;
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900325 enum efi_image_auth_status auth_status;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200326};
327
328/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200329 * struct efi_event
330 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100331 * @link: Link to list of all events
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200332 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200333 * @type: Type of event, see efi_create_event
334 * @notify_tpl: Task priority level of notifications
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100335 * @notify_function: Function to call when the event is triggered
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200336 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100337 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100338 * @trigger_time: Period of the timer
339 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200340 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100341 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200342 */
343struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100344 struct list_head link;
Heinrich Schuchardt7a69e972019-06-05 21:00:39 +0200345 struct list_head queue_link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200346 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100347 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200348 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
349 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100350 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200351 u64 trigger_next;
352 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200353 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200354 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200355};
356
Alexander Grafbee91162016-03-04 01:09:59 +0100357/* This list contains all UEFI objects we know of */
358extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100359/* List of all events */
360extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100361
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200362/**
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200363 * struct efi_protocol_notification - handle for notified protocol
364 *
365 * When a protocol interface is installed for which an event was registered with
366 * the RegisterProtocolNotify() service this structure is used to hold the
367 * handle on which the protocol interface was installed.
368 *
369 * @link: link to list of all handles notified for this event
370 * @handle: handle on which the notified protocol interface was installed
371 */
372struct efi_protocol_notification {
373 struct list_head link;
374 efi_handle_t handle;
375};
376
377/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100378 * struct efi_register_notify_event - event registered by
379 * RegisterProtocolNotify()
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200380 *
381 * The address of this structure serves as registration value.
382 *
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200383 * @link: link to list of all registered events
384 * @event: registered event. The same event may registered for multiple
385 * GUIDs.
386 * @protocol: protocol for which the event is registered
387 * @handles: linked list of all handles on which the notified protocol was
388 * installed
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200389 */
390struct efi_register_notify_event {
391 struct list_head link;
392 struct efi_event *event;
393 efi_guid_t protocol;
Heinrich Schuchardtf09cea32019-05-21 18:19:01 +0200394 struct list_head handles;
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200395};
396
397/* List of all events registered by RegisterProtocolNotify() */
398extern struct list_head efi_register_notify_events;
399
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100400/* Initialize efi execution environment */
401efi_status_t efi_init_obj_list(void);
Heinrich Schuchardtf64f2232019-12-08 01:07:01 +0100402/* Install device tree */
403efi_status_t efi_install_fdt(void *fdt);
Heinrich Schuchardtf9ceb6a2019-12-07 20:51:06 +0100404/* Run loaded UEFI image */
405efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
Heinrich Schuchardt88192092019-06-20 13:52:16 +0200406/* Initialize variable services */
407efi_status_t efi_init_variables(void);
Heinrich Schuchardt29018ab2019-06-20 15:25:48 +0200408/* Notify ExitBootServices() is called */
409void efi_variables_boot_exit_notify(void);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200410/* Called by bootefi to initialize root node */
411efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200412/* Called by bootefi to initialize runtime */
413efi_status_t efi_initialize_system_table(void);
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200414/* efi_runtime_detach() - detach unimplemented runtime functions */
415void efi_runtime_detach(void);
Heinrich Schuchardta44d2a22020-03-24 18:05:22 +0100416/* efi_convert_pointer() - convert pointer to virtual address */
417efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
418 void **address);
Heinrich Schuchardt94686f62020-12-13 10:30:24 +0100419/* Carve out DT reserved memory ranges */
420void efi_carve_out_dt_rsv(void *fdt);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200421/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200422efi_status_t efi_console_register(void);
Alexander Graf2a22d052016-03-04 01:10:02 +0100423/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtdf9cf562018-02-09 20:55:47 +0100424efi_status_t efi_disk_register(void);
Heinrich Schuchardtb59c13d2020-09-25 12:50:19 +0200425/* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
426efi_status_t efi_rng_register(void);
Ilias Apalodimasc1c02102020-11-11 11:18:11 +0200427/* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
428efi_status_t efi_tcg2_register(void);
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900429/* measure the pe-coff image, extend PCR and add Event Log */
430efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
431 struct efi_loaded_image_obj *handle,
432 struct efi_loaded_image *loaded_image_info);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100433/* Create handles and protocols for the partitions of a block device */
434int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
435 const char *if_typename, int diskid,
436 const char *pdevname);
AKASHI Takahiro41fd5062020-04-27 18:48:20 +0900437/* Check if it is EFI system partition */
438bool efi_disk_is_system_part(efi_handle_t handle);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100439/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100440efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200441/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100442efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200443/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100444efi_status_t efi_watchdog_register(void);
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200445efi_status_t efi_initrd_register(void);
Ilias Apalodimas53f6a5a2021-03-17 21:55:00 +0200446void efi_initrd_deregister(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200447/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600448/**
Bin Meng86df34d2018-06-27 20:38:03 -0700449 * efi_acpi_register() - write out ACPI tables
450 *
451 * Called by bootefi to make ACPI tables available
452 *
453 * @return 0 if OK, -ENOMEM if no memory is available for the tables
454 */
455efi_status_t efi_acpi_register(void);
456/**
Simon Glass0864c562018-05-16 09:42:19 -0600457 * efi_smbios_register() - write out SMBIOS tables
458 *
459 * Called by bootefi to make SMBIOS tables available
460 *
461 * @return 0 if OK, -ENOMEM if no memory is available for the tables
462 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100463efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200464
Rob Clark2a920802017-09-13 18:05:34 -0400465struct efi_simple_file_system_protocol *
466efi_fs_from_path(struct efi_device_path *fp);
467
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200468/* Called by networking code to memorize the dhcp ack package */
469void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200470/* Called by efi_set_watchdog_timer to reset the timer */
471efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200472
Alexander Grafbee91162016-03-04 01:09:59 +0100473/* Called from places to check whether a timer expired */
474void efi_timer_check(void);
Heinrich Schuchardt5dad05a2021-01-12 12:40:32 +0100475/* Check if a buffer contains a PE-COFF image */
476efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
Alexander Grafbee91162016-03-04 01:09:59 +0100477/* PE loader implementation */
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900478efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
479 void *efi, size_t efi_size,
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100480 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100481/* Called once to store the pristine gd pointer */
482void efi_save_gd(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400483/* Special case handler for error/abort that just tries to dtrt to get
484 * back to u-boot world */
Alexander Grafbee91162016-03-04 01:09:59 +0100485void efi_restore_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100486/* Call this to relocate the runtime section to an address space */
487void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100488/* Call this to set the current device name */
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100489void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
490 void *buffer, size_t buffer_size);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100491/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200492void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200493/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100494efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100495/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200496void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100497/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100498struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900499/* Load image */
500efi_status_t EFIAPI efi_load_image(bool boot_policy,
501 efi_handle_t parent_image,
502 struct efi_device_path *file_path,
503 void *source_buffer,
504 efi_uintn_t source_size,
505 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100506/* Start image */
507efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
508 efi_uintn_t *exit_data_size,
509 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900510/* Unload image */
511efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200512/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100513efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200514 const efi_guid_t *protocol_guid,
515 struct efi_handler **handler);
516/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100517efi_status_t efi_add_protocol(const efi_handle_t handle,
518 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200519 void *protocol_interface);
Heinrich Schuchardtf9ad2402020-01-10 12:33:59 +0100520/* Open protocol */
521efi_status_t efi_protocol_open(struct efi_handler *handler,
522 void **protocol_interface, void *agent_handle,
523 void *controller_handle, uint32_t attributes);
524
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200525/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100526efi_status_t efi_remove_protocol(const efi_handle_t handle,
527 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200528 void *protocol_interface);
529/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100530efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200531/* Install multiple protocol interfaces */
532efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
533 (efi_handle_t *handle, ...);
AKASHI Takahirob51ec632020-03-17 11:12:36 +0900534/* Get handles that support a given protocol */
535efi_status_t EFIAPI efi_locate_handle_buffer(
536 enum efi_locate_search_type search_type,
537 const efi_guid_t *protocol, void *search_key,
538 efi_uintn_t *no_handles, efi_handle_t **buffer);
539/* Close an previously opened protocol interface */
540efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
541 const efi_guid_t *protocol,
542 efi_handle_t agent_handle,
543 efi_handle_t controller_handle);
544/* Open a protocol interface */
545efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
546 const efi_guid_t *protocol,
547 void **protocol_interface);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200548/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100549efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200550 void (EFIAPI *notify_function) (
551 struct efi_event *event,
552 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100553 void *notify_context, efi_guid_t *group,
554 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200555/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200556efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200557 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200558/* Call this to signal an event */
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200559void efi_signal_event(struct efi_event *event);
Alexander Graf50149ea2016-03-04 01:10:01 +0100560
Rob Clark2a920802017-09-13 18:05:34 -0400561/* open file system: */
562struct efi_simple_file_system_protocol *efi_simple_file_system(
563 struct blk_desc *desc, int part, struct efi_device_path *dp);
564
565/* open file from device-path: */
566struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
567
Jose Marinho64a8aae2021-03-02 17:26:38 +0000568/* Registers a callback function for a notification event. */
569efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
570 struct efi_event *event,
571 void **registration);
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200572efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
573
574/* get a device path from a Boot#### option */
575struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
576
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100577/**
578 * efi_size_in_pages() - convert size in bytes to size in pages
579 *
580 * This macro returns the number of EFI memory pages required to hold 'size'
581 * bytes.
582 *
583 * @size: size in bytes
584 * Return: size in pages
585 */
Heinrich Schuchardt0a7e5162021-01-17 07:52:09 +0100586#define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100587/* Generic EFI memory allocator, call this to get memory */
588void *efi_alloc(uint64_t len, int memory_type);
589/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100590efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf5d009952016-03-04 01:10:04 +0100591 uint64_t *memory);
Stefan BrĂŒnsb61d8572016-10-01 23:32:27 +0200592/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100593efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan BrĂŒnsead12742016-10-09 22:17:18 +0200594/* EFI memory allocator for small allocations */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100595efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan BrĂŒnsead12742016-10-09 22:17:18 +0200596 void **buffer);
Stefan BrĂŒns42417bc2016-10-09 22:17:26 +0200597/* EFI pool memory free function. */
598efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100599/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100600efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100601 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100602 efi_uintn_t *map_key,
603 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100604 uint32_t *descriptor_version);
605/* Adds a range into the EFI memory map */
Michael Walle714497e2020-05-17 12:29:19 +0200606efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
Park, Aidenb5b9eff2019-09-03 17:43:43 +0000607/* Adds a conventional range into the EFI memory map */
608efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
609 u64 ram_top);
610
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100611/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100612efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100613/* Called by board init to initialize the EFI memory map */
614int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200615/* Adds new or overrides configuration table entry to the system table */
616efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100617/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200618efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
619 struct efi_device_path *file_path,
620 struct efi_loaded_image_obj **handle_ptr,
621 struct efi_loaded_image **info_ptr);
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200622/* Print information about all loaded images */
623void efi_print_image_infos(void *pc);
Alexander Graf5d009952016-03-04 01:10:04 +0100624
Alexander Graf51735ae2016-05-11 18:25:48 +0200625#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
626extern void *efi_bounce_buffer;
627#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
628#endif
629
Rob Clarkb66c60d2017-09-13 18:05:28 -0400630
631struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200632int efi_dp_match(const struct efi_device_path *a,
633 const struct efi_device_path *b);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400634struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
635 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200636/* get size of the first device path instance excluding end node */
637efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
638/* size of multi-instance device path excluding end node */
639efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400640struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
641struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
642 const struct efi_device_path *dp2);
643struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
644 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200645/* Create a device path node of given type, sub-type, length */
646struct efi_device_path *efi_dp_create_device_node(const u8 type,
647 const u8 sub_type,
648 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200649/* Append device path instance */
650struct efi_device_path *efi_dp_append_instance(
651 const struct efi_device_path *dp,
652 const struct efi_device_path *dpi);
653/* Get next device path instance */
654struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
655 efi_uintn_t *size);
656/* Check if a device path contains muliple instances */
657bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400658
Rob Clarkb66c60d2017-09-13 18:05:28 -0400659struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100660/* Create a device node for a block device partition. */
661struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400662struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
663 const char *path);
664struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400665struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
666 uint64_t start_address,
667 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100668/* Determine the last device path node that is not the end node. */
669const struct efi_device_path *efi_dp_last_node(
670 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100671efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
672 struct efi_device_path **device_path,
673 struct efi_device_path **file_path);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900674efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
675 const char *path,
676 struct efi_device_path **device,
677 struct efi_device_path **file);
Heinrich Schuchardt5cad4a32020-08-23 10:49:46 +0200678ssize_t efi_dp_check_length(const struct efi_device_path *dp,
679 const size_t maxlen);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400680
681#define EFI_DP_TYPE(_dp, _type, _subtype) \
682 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
683 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
684
Marek BehĂșn82836972021-05-20 13:23:57 +0200685/**
686 * __efi_runtime_data - declares a non-const variable for EFI runtime section
687 *
688 * This macro indicates that a variable is non-const and should go into the
689 * EFI runtime section, and thus still be available when the OS is running.
690 *
691 * Only use on variables not declared const.
692 *
693 * Example:
694 *
695 * ::
696 *
697 * static __efi_runtime_data my_computed_table[256];
Alexander Graf50149ea2016-03-04 01:10:01 +0100698 */
Marek BehĂșn236f2ec2021-05-20 13:23:52 +0200699#define __efi_runtime_data __section(".data.efi_runtime")
Marek BehĂșn82836972021-05-20 13:23:57 +0200700
701/**
Marek BehĂșn15f537c2021-05-20 13:23:58 +0200702 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
703 *
704 * This macro indicates that a variable is read-only (const) and should go into
705 * the EFI runtime section, and thus still be available when the OS is running.
706 *
707 * Only use on variables also declared const.
708 *
709 * Example:
710 *
711 * ::
712 *
713 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
714 */
715#define __efi_runtime_rodata __section(".rodata.efi_runtime")
716
717/**
Marek BehĂșn82836972021-05-20 13:23:57 +0200718 * __efi_runtime - declares a function for EFI runtime section
719 *
720 * This macro indicates that a function should go into the EFI runtime section,
721 * and thus still be available when the OS is running.
722 *
723 * Example:
724 *
725 * ::
726 *
727 * static __efi_runtime compute_my_table(void);
728 */
Marek BehĂșn236f2ec2021-05-20 13:23:52 +0200729#define __efi_runtime __section(".text.efi_runtime")
Alexander Grafbee91162016-03-04 01:09:59 +0100730
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900731/* Indicate supported runtime services */
732efi_status_t efi_init_runtime_supported(void);
733
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200734/* Update CRC32 in table header */
735void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
736
Alexander Graf80a48002016-08-16 21:08:45 +0200737/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
738 * to make it available at runtime */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100739efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf80a48002016-08-16 21:08:45 +0200740
741/* Boards may provide the functions below to implement RTS functionality */
742
Alexander Graf3c63db92016-10-14 13:45:30 +0200743void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200744 enum efi_reset_type reset_type,
745 efi_status_t reset_status,
746 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100747
748/* Architecture specific initialization of the EFI subsystem */
749efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200750
Alexander Graf3c63db92016-10-14 13:45:30 +0200751efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200752 struct efi_time *time,
753 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200754
Heinrich Schuchardt656f1712019-05-31 07:38:29 +0200755efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
756
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200757#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
758/*
759 * Entry point for the tests of the EFI API.
760 * It is called by 'bootefi selftest'
761 */
762efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
763 struct efi_system_table *systab);
764#endif
765
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100766efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
767 const efi_guid_t *vendor, u32 *attributes,
768 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200769efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
770 u16 *variable_name,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100771 efi_guid_t *vendor);
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100772efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
773 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100774 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400775
Heinrich Schuchardtce435282019-06-20 12:13:05 +0200776efi_status_t EFIAPI efi_query_variable_info(
777 u32 attributes, u64 *maximum_variable_storage_size,
778 u64 *remaining_variable_storage_size,
779 u64 *maximum_variable_size);
780
Ilias Apalodimas37c3ca52021-03-17 21:54:59 +0200781void *efi_get_var(u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
782
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900783/*
784 * See section 3.1.3 in the v2.7 UEFI spec for more details on
785 * the layout of EFI_LOAD_OPTION. In short it is:
786 *
787 * typedef struct _EFI_LOAD_OPTION {
788 * UINT32 Attributes;
789 * UINT16 FilePathListLength;
790 * // CHAR16 Description[]; <-- variable length, NULL terminated
791 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
792 * <-- FilePathListLength bytes
793 * // UINT8 OptionalData[];
794 * } EFI_LOAD_OPTION;
795 */
796struct efi_load_option {
797 u32 attributes;
798 u16 file_path_length;
799 u16 *label;
800 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200801 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900802};
803
Ilias Apalodimas76e8acc2021-03-17 21:54:58 +0200804struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
805 efi_uintn_t *size, efi_guid_t guid);
806struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
807 const struct efi_device_path *dp2);
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200808efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
809 efi_uintn_t *size);
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900810unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
Heinrich Schuchardt1064d042020-08-07 17:47:13 +0200811efi_status_t efi_set_load_options(efi_handle_t handle,
812 efi_uintn_t load_options_size,
813 void *load_options);
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +0200814efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
Rob Clark9975fe92017-09-13 18:05:38 -0400815
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900816/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100817 * struct efi_image_regions - A list of memory regions
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900818 *
819 * @max: Maximum number of regions
820 * @num: Number of regions
821 * @reg: array of regions
822 */
823struct efi_image_regions {
824 int max;
825 int num;
826 struct image_region reg[];
827};
828
829/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100830 * struct efi_sig_data - A decoded data of struct efi_signature_data
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900831 *
832 * This structure represents an internal form of signature in
833 * signature database. A listed list may represent a signature list.
834 *
835 * @next: Pointer to next entry
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100836 * @owner: Signature owner
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900837 * @data: Pointer to signature data
838 * @size: Size of signature data
839 */
840struct efi_sig_data {
841 struct efi_sig_data *next;
842 efi_guid_t owner;
843 void *data;
844 size_t size;
845};
846
847/**
Heinrich Schuchardtc6f077a2021-02-25 08:02:37 +0100848 * struct efi_signature_store - A decoded data of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900849 *
850 * This structure represents an internal form of signature database.
851 *
852 * @next: Pointer to next entry
853 * @sig_type: Signature type
854 * @sig_data_list: Pointer to signature list
855 */
856struct efi_signature_store {
857 struct efi_signature_store *next;
858 efi_guid_t sig_type;
859 struct efi_sig_data *sig_data_list;
860};
861
862struct x509_certificate;
863struct pkcs7_message;
864
AKASHI Takahiro7926dfb2020-07-08 14:01:57 +0900865bool efi_signature_lookup_digest(struct efi_image_regions *regs,
866 struct efi_signature_store *db);
AKASHI Takahiro1115edd2020-07-21 19:35:22 +0900867bool efi_signature_verify(struct efi_image_regions *regs,
868 struct pkcs7_message *msg,
869 struct efi_signature_store *db,
870 struct efi_signature_store *dbx);
AKASHI Takahiro52956e52020-08-14 14:39:23 +0900871static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
872 struct pkcs7_message *msg,
873 struct efi_signature_store *db)
874{
875 return efi_signature_verify(regs, msg, db, NULL);
876}
AKASHI Takahiro11bafb22020-07-08 14:01:56 +0900877bool efi_signature_check_signers(struct pkcs7_message *msg,
878 struct efi_signature_store *dbx);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900879
880efi_status_t efi_image_region_add(struct efi_image_regions *regs,
881 const void *start, const void *end,
882 int nocheck);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900883
884void efi_sigstore_free(struct efi_signature_store *sigstore);
Sughosh Ganub4f20a52020-12-30 19:27:08 +0530885struct efi_signature_store *efi_build_signature_store(void *sig_list,
886 efi_uintn_t size);
AKASHI Takahirobe6296d2020-04-14 11:51:40 +0900887struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
AKASHI Takahiro767f6ee2020-04-14 11:51:41 +0900888
889bool efi_secure_boot_enabled(void);
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900890
Sughosh Ganu04be98b2020-12-30 19:27:09 +0530891bool efi_capsule_auth_enabled(void);
892
Masahisa Kojima163a0d72021-05-26 12:09:58 +0900893void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
894
AKASHI Takahiro4540dab2020-04-14 11:51:44 +0900895bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
896 WIN_CERTIFICATE **auth, size_t *auth_len);
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900897
Sughosh Ganu201b8062020-12-30 19:27:07 +0530898struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
899 size_t buflen,
900 u8 **tmpbuf);
901
Heinrich Schuchardtb0dd8cb2020-06-28 16:30:29 +0200902/* runtime implementation of memcpy() */
903void efi_memcpy_runtime(void *dest, const void *src, size_t n);
904
AKASHI Takahiro077153e2020-10-29 13:47:46 +0900905/* commonly used helper function */
Ilias Apalodimasfe179d72020-12-31 12:26:46 +0200906u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
907 unsigned int index);
AKASHI Takahiro077153e2020-10-29 13:47:46 +0900908
AKASHI Takahirof27c2012020-11-30 18:12:12 +0900909extern const struct efi_firmware_management_protocol efi_fmp_fit;
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +0900910extern const struct efi_firmware_management_protocol efi_fmp_raw;
AKASHI Takahirof27c2012020-11-30 18:12:12 +0900911
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900912/* Capsule update */
913efi_status_t EFIAPI efi_update_capsule(
914 struct efi_capsule_header **capsule_header_array,
915 efi_uintn_t capsule_count,
916 u64 scatter_gather_list);
917efi_status_t EFIAPI efi_query_capsule_caps(
918 struct efi_capsule_header **capsule_header_array,
919 efi_uintn_t capsule_count,
920 u64 *maximum_capsule_size,
921 u32 *reset_type);
922
Sughosh Ganu04be98b2020-12-30 19:27:09 +0530923efi_status_t efi_capsule_authenticate(const void *capsule,
924 efi_uintn_t capsule_size,
925 void **image, efi_uintn_t *image_size);
926
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +0900927#define EFI_CAPSULE_DIR L"\\EFI\\UpdateCapsule\\"
928
929/* Hook at initialization */
930efi_status_t efi_launch_capsules(void);
931
Stephen Warren9b5e6392018-08-30 15:43:43 -0600932#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafbee91162016-03-04 01:09:59 +0100933
Alexander Graf50149ea2016-03-04 01:10:01 +0100934/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf3c63db92016-10-14 13:45:30 +0200935#define __efi_runtime_data
Marek BehĂșn15f537c2021-05-20 13:23:58 +0200936#define __efi_runtime_rodata
Alexander Graf3c63db92016-10-14 13:45:30 +0200937#define __efi_runtime
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100938static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
939{
940 return EFI_SUCCESS;
941}
Alexander Graf50149ea2016-03-04 01:10:01 +0100942
Alexander Grafbee91162016-03-04 01:09:59 +0100943/* No loader configured, stub out EFI_ENTRY */
944static inline void efi_restore_gd(void) { }
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200945static inline void efi_set_bootdev(const char *dev, const char *devnr,
Heinrich Schuchardt5f595182021-01-12 12:46:24 +0100946 const char *path, void *buffer,
947 size_t buffer_size) { }
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200948static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200949static inline void efi_print_image_infos(void *pc) { }
AKASHI Takahiroc74cd8b2020-11-17 09:27:56 +0900950static inline efi_status_t efi_launch_capsules(void)
951{
952 return EFI_SUCCESS;
953}
Alexander Grafbee91162016-03-04 01:09:59 +0100954
Stephen Warren9b5e6392018-08-30 15:43:43 -0600955#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200956
Jose Marinho64a8aae2021-03-02 17:26:38 +0000957/**
958 * Install the ESRT system table.
959 *
960 * @return status code
961 */
962efi_status_t efi_esrt_register(void);
963
964/**
965 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
966 * present in the system.
967 * If an ESRT already exists, the old ESRT is replaced in the system table.
968 * The memory of the old ESRT is deallocated.
969 *
970 * Return:
971 * - EFI_SUCCESS if the ESRT is correctly created
972 * - error code otherwise.
973 */
974efi_status_t efi_esrt_populate(void);
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200975#endif /* _EFI_LOADER_H */