blob: b07155cecb7cab8ed91d276cc7381fd55a15cf5c [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>
Alexander Graf4e0c1c12016-03-04 01:09:58 +010012#include <part_efi.h>
13#include <efi_api.h>
Alexander Grafc15d9212016-03-04 01:09:59 +010014
15/* No need for efi loader support in SPL */
Stephen Warrend0de8062018-08-30 15:43:43 -060016#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafc15d9212016-03-04 01:09:59 +010017
Alexander Graf4e0c1c12016-03-04 01:09:58 +010018#include <linux/list.h>
19
Heinrich Schuchardt2f528c22018-06-28 12:45:32 +020020/* Maximum number of configuration tables */
21#define EFI_MAX_CONFIGURATION_TABLES 16
22
Heinrich Schuchardt79d72022018-09-20 21:58:23 +020023/* GUID used by the root node */
24#define U_BOOT_GUID \
25 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
26 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
27
AKASHI Takahiro0b275752019-04-16 13:24:20 +090028/* Root node */
29extern efi_handle_t efi_root;
30
Rob Clark86789d52017-07-27 08:04:18 -040031int __efi_entry_check(void);
32int __efi_exit_check(void);
Heinrich Schuchardt4d664892017-08-18 17:45:16 +020033const char *__efi_nesting(void);
Rob Clarke7896c32017-07-27 08:04:19 -040034const char *__efi_nesting_inc(void);
35const char *__efi_nesting_dec(void);
Rob Clark86789d52017-07-27 08:04:18 -040036
Rob Clark63ea77a2017-07-27 08:04:17 -040037/*
38 * Enter the u-boot world from UEFI:
39 */
Alexander Grafc15d9212016-03-04 01:09:59 +010040#define EFI_ENTRY(format, ...) do { \
Rob Clark86789d52017-07-27 08:04:18 -040041 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -040042 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
43 __func__, ##__VA_ARGS__); \
Alexander Grafc15d9212016-03-04 01:09:59 +010044 } while(0)
Alexander Grafc15d9212016-03-04 01:09:59 +010045
Rob Clark63ea77a2017-07-27 08:04:17 -040046/*
47 * Exit the u-boot world back to UEFI:
48 */
Rob Clark84a19a02017-07-24 10:31:52 -040049#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +020050 typeof(ret) _r = ret; \
Rob Clarke7896c32017-07-27 08:04:19 -040051 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.de8f9dd922017-08-17 18:57:36 +020052 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clark86789d52017-07-27 08:04:18 -040053 assert(__efi_exit_check()); \
54 _r; \
Rob Clark84a19a02017-07-24 10:31:52 -040055 })
Alexander Grafc15d9212016-03-04 01:09:59 +010056
Rob Clark63ea77a2017-07-27 08:04:17 -040057/*
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +020058 * Call non-void UEFI function from u-boot and retrieve return value:
59 */
60#define EFI_CALL(exp) ({ \
61 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
62 assert(__efi_exit_check()); \
63 typeof(exp) _r = exp; \
64 assert(__efi_entry_check()); \
65 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
66 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
67 _r; \
68})
69
70/*
71 * Call void UEFI function from u-boot:
Rob Clark63ea77a2017-07-27 08:04:17 -040072 */
Heinrich Schuchardt91e5b8a2017-09-15 10:06:10 +020073#define EFI_CALL_VOID(exp) do { \
Rob Clarke7896c32017-07-27 08:04:19 -040074 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clark86789d52017-07-27 08:04:18 -040075 assert(__efi_exit_check()); \
Rob Clark63ea77a2017-07-27 08:04:17 -040076 exp; \
Rob Clark86789d52017-07-27 08:04:18 -040077 assert(__efi_entry_check()); \
Rob Clarke7896c32017-07-27 08:04:19 -040078 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clark63ea77a2017-07-27 08:04:17 -040079 } while(0)
80
Heinrich Schuchardt4d664892017-08-18 17:45:16 +020081/*
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +010082 * Write an indented message with EFI prefix
Heinrich Schuchardt4d664892017-08-18 17:45:16 +020083 */
Heinrich Schuchardt3d2abc32018-01-11 08:16:01 +010084#define EFI_PRINT(format, ...) ({ \
85 debug("%sEFI: " format, __efi_nesting(), \
86 ##__VA_ARGS__); \
Heinrich Schuchardt4d664892017-08-18 17:45:16 +020087 })
88
Alexander Graf59254d62018-04-23 07:59:47 +020089#ifdef CONFIG_SYS_CACHELINE_SIZE
90#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
91#else
92/* Just use the greatest cache flush alignment requirement I'm aware of */
93#define EFI_CACHELINE_SIZE 128
94#endif
95
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +020096/* Key identifying current memory map */
97extern efi_uintn_t efi_memory_map_key;
98
Alexander Graf0bd425a2016-03-04 01:10:01 +010099extern struct efi_runtime_services efi_runtime_services;
Alexander Grafc15d9212016-03-04 01:09:59 +0100100extern struct efi_system_table systab;
101
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200102extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +0200103extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardt580c13b2017-10-26 19:25:59 +0200104extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200105extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100106/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
107extern const struct efi_device_path_utilities_protocol
108 efi_device_path_utilities;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200109/* deprecated version of the EFI_UNICODE_COLLATION_PROTOCOL */
110extern const struct efi_unicode_collation_protocol
111 efi_unicode_collation_protocol;
112/* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200113extern const struct efi_unicode_collation_protocol
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200114 efi_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900115extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
116extern const struct efi_hii_config_access_protocol efi_hii_config_access;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900117extern const struct efi_hii_database_protocol efi_hii_database;
118extern const struct efi_hii_string_protocol efi_hii_string;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100119
Rob Clark85dd7212017-09-13 18:05:30 -0400120uint16_t *efi_dp_str(struct efi_device_path *dp);
121
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200122/* GUID of the U-Boot root node */
123extern const efi_guid_t efi_u_boot_guid;
Heinrich Schuchardt405afb52018-01-19 20:24:45 +0100124/* GUID of the EFI_BLOCK_IO_PROTOCOL */
125extern const efi_guid_t efi_block_io_guid;
Rob Clarkc84c1102017-09-13 18:05:38 -0400126extern const efi_guid_t efi_global_variable_guid;
Alexander Graf4aacacc2016-03-04 01:10:00 +0100127extern const efi_guid_t efi_guid_console_control;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100128extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardt760255f2018-01-11 08:16:02 +0100129/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
130extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardt672d99e2018-02-18 15:17:51 +0100131/* event group ExitBootServices() invoked */
132extern const efi_guid_t efi_guid_event_group_exit_boot_services;
133/* event group SetVirtualAddressMap() invoked */
134extern const efi_guid_t efi_guid_event_group_virtual_address_change;
135/* event group memory map changed */
136extern const efi_guid_t efi_guid_event_group_memory_map_change;
137/* event group boot manager about to boot */
138extern const efi_guid_t efi_guid_event_group_ready_to_boot;
139/* event group ResetSystem() invoked (before ExitBootServices) */
140extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardt44ab21b2018-03-03 15:29:03 +0100141/* GUID of the device tree table */
142extern const efi_guid_t efi_guid_fdt;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100143extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobbe13da2019-03-27 13:40:32 +0900144extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.de3c042b22017-07-11 22:06:25 +0200145extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark53142032017-09-13 18:05:34 -0400146extern const efi_guid_t efi_simple_file_system_protocol_guid;
147extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt37fb4b92018-04-04 15:42:11 +0200148/* GUID for file system information */
149extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholmb6e6fdc2018-03-09 17:43:21 +0100150extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardt18ed8cf2019-05-16 18:19:00 +0200151/* GUID of the deprecated Unicode collation protocol */
152extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardte59072a2018-09-04 19:34:58 +0200153/* GUID of the Unicode collation protocol */
Heinrich Schuchardtb3258842019-05-16 07:52:58 +0200154extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahiroca8aa712019-01-21 12:13:00 +0900155extern const efi_guid_t efi_guid_hii_config_routing_protocol;
156extern const efi_guid_t efi_guid_hii_config_access_protocol;
Leif Lindholm5aab1b82019-01-21 12:12:57 +0900157extern const efi_guid_t efi_guid_hii_database_protocol;
158extern const efi_guid_t efi_guid_hii_string_protocol;
Alexander Graf4e0c1c12016-03-04 01:09:58 +0100159
Alexander Graf0bd425a2016-03-04 01:10:01 +0100160extern unsigned int __efi_runtime_start, __efi_runtime_stop;
161extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
162
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200163/**
164 * struct efi_open_protocol_info_item - open protocol info item
165 *
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100166 * When a protocol is opened a open protocol info entry is created.
167 * These are maintained in a list.
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200168 *
169 * @link: link to the list of open protocol info entries of a protocol
170 * @info: information about the opening of a protocol
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100171 */
172struct efi_open_protocol_info_item {
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100173 struct list_head link;
174 struct efi_open_protocol_info_entry info;
175};
176
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200177/**
178 * struct efi_handler - single protocol interface of a handle
179 *
Alexander Grafc15d9212016-03-04 01:09:59 +0100180 * When the UEFI payload wants to open a protocol on an object to get its
181 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100182 * protocol GUID to the respective protocol interface
Heinrich Schuchardt2e4b41f2019-05-21 17:51:35 +0200183 *
184 * @link: link to the list of protocols of a handle
185 * @guid: GUID of the protocol
186 * @protocol_interface: protocol interface
187 * @open_infos link to the list of open protocol info items
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100188 */
Alexander Grafc15d9212016-03-04 01:09:59 +0100189struct efi_handler {
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100190 struct list_head link;
Alexander Grafc15d9212016-03-04 01:09:59 +0100191 const efi_guid_t *guid;
xypron.glpk@gmx.dec35c9242017-07-11 22:06:14 +0200192 void *protocol_interface;
Heinrich Schuchardta277d3a2018-01-11 08:15:57 +0100193 struct list_head open_infos;
Alexander Grafc15d9212016-03-04 01:09:59 +0100194};
195
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200196/**
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200197 * enum efi_object_type - type of EFI object
198 *
199 * In UnloadImage we must be able to identify if the handle relates to a
200 * started image.
201 */
202enum efi_object_type {
203 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt2e0a7902019-05-05 16:55:06 +0200204 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200205 EFI_OBJECT_TYPE_LOADED_IMAGE,
206 EFI_OBJECT_TYPE_STARTED_IMAGE,
207};
208
209/**
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200210 * struct efi_object - dereferenced EFI handle
211 *
212 * @link: pointers to put the handle into a linked list
213 * @protocols: linked list with the protocol interfaces installed on this
214 * handle
215 *
216 * UEFI offers a flexible and expandable object model. The objects in the UEFI
217 * API are devices, drivers, and loaded images. struct efi_object is our storage
218 * structure for these objects.
219 *
220 * When including this structure into a larger structure always put it first so
221 * that when deleting a handle the whole encompassing structure can be freed.
Alexander Grafc15d9212016-03-04 01:09:59 +0100222 *
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200223 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
224 * has been created for such pointers.
Alexander Grafc15d9212016-03-04 01:09:59 +0100225 */
226struct efi_object {
227 /* Every UEFI object is part of a global object list */
228 struct list_head link;
Heinrich Schuchardt99ce2062017-11-26 14:05:17 +0100229 /* The list of protocols */
230 struct list_head protocols;
Heinrich Schuchardtb27ced42019-05-01 14:20:18 +0200231 enum efi_object_type type;
Alexander Grafc15d9212016-03-04 01:09:59 +0100232};
233
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200234/**
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200235 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200236 *
237 * @header: EFI object header
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200238 * @exit_status: exit status passed to Exit()
239 * @exit_data_size: exit data size passed to Exit()
240 * @exit_data: exit data passed to Exit()
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200241 * @exit_jmp: long jump buffer for returning form started image
242 * @entry: entry address of the relocated image
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200243 */
244struct efi_loaded_image_obj {
Heinrich Schuchardt72928722018-09-26 05:27:56 +0200245 struct efi_object header;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200246 efi_status_t exit_status;
Heinrich Schuchardt3d445122019-04-30 17:57:30 +0200247 efi_uintn_t *exit_data_size;
248 u16 **exit_data;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200249 struct jmp_buf_data exit_jmp;
250 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
251 struct efi_system_table *st);
Heinrich Schuchardt37587522019-05-01 20:07:04 +0200252 u16 image_type;
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200253};
254
255/**
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200256 * struct efi_event
257 *
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100258 * @link: Link to list of all events
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200259 * @queue_link: Link to the list of queued events
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200260 * @type: Type of event, see efi_create_event
261 * @notify_tpl: Task priority level of notifications
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200262 * @nofify_function: Function to call when the event is triggered
263 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100264 * @group: Event group
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100265 * @trigger_time: Period of the timer
266 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200267 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100268 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200269 */
270struct efi_event {
Heinrich Schuchardt370c7a82018-02-18 15:17:50 +0100271 struct list_head link;
Heinrich Schuchardt35c0cf62019-06-05 21:00:39 +0200272 struct list_head queue_link;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200273 uint32_t type;
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100274 efi_uintn_t notify_tpl;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200275 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
276 void *notify_context;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100277 const efi_guid_t *group;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200278 u64 trigger_next;
279 u64 trigger_time;
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200280 enum efi_timer_delay trigger_type;
Heinrich Schuchardt1bbee392017-10-04 15:03:24 +0200281 bool is_signaled;
xypron.glpk@gmx.de30708232017-07-18 20:17:18 +0200282};
283
Alexander Grafc15d9212016-03-04 01:09:59 +0100284/* This list contains all UEFI objects we know of */
285extern struct list_head efi_obj_list;
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100286/* List of all events */
287extern struct list_head efi_events;
Alexander Grafc15d9212016-03-04 01:09:59 +0100288
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200289/**
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200290 * struct efi_protocol_notification - handle for notified protocol
291 *
292 * When a protocol interface is installed for which an event was registered with
293 * the RegisterProtocolNotify() service this structure is used to hold the
294 * handle on which the protocol interface was installed.
295 *
296 * @link: link to list of all handles notified for this event
297 * @handle: handle on which the notified protocol interface was installed
298 */
299struct efi_protocol_notification {
300 struct list_head link;
301 efi_handle_t handle;
302};
303
304/**
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200305 * efi_register_notify_event - event registered by RegisterProtocolNotify()
306 *
307 * The address of this structure serves as registration value.
308 *
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200309 * @link: link to list of all registered events
310 * @event: registered event. The same event may registered for multiple
311 * GUIDs.
312 * @protocol: protocol for which the event is registered
313 * @handles: linked list of all handles on which the notified protocol was
314 * installed
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200315 */
316struct efi_register_notify_event {
317 struct list_head link;
318 struct efi_event *event;
319 efi_guid_t protocol;
Heinrich Schuchardtd375e752019-05-21 18:19:01 +0200320 struct list_head handles;
Heinrich Schuchardt6eec42d2019-05-04 17:27:54 +0200321};
322
323/* List of all events registered by RegisterProtocolNotify() */
324extern struct list_head efi_register_notify_events;
325
AKASHI Takahiro7e0badb2018-12-30 15:16:55 +0100326/* Initialize efi execution environment */
327efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt79d72022018-09-20 21:58:23 +0200328/* Called by bootefi to initialize root node */
329efi_status_t efi_root_node_register(void);
Heinrich Schuchardt15070db2018-06-28 12:45:31 +0200330/* Called by bootefi to initialize runtime */
331efi_status_t efi_initialize_system_table(void);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200332/* Called by bootefi to make console interface available */
Heinrich Schuchardta92e9ab2018-10-02 06:08:26 +0200333efi_status_t efi_console_register(void);
Alexander Grafe83be452016-03-04 01:10:02 +0100334/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtcde7a362018-02-09 20:55:47 +0100335efi_status_t efi_disk_register(void);
Heinrich Schuchardt6f3de6b2018-01-19 20:24:47 +0100336/* Create handles and protocols for the partitions of a block device */
337int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
338 const char *if_typename, int diskid,
339 const char *pdevname);
Alexander Grafd65783d2016-03-15 18:38:21 +0100340/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardtb91c0842018-03-03 15:28:55 +0100341efi_status_t efi_gop_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200342/* Called by bootefi to make the network interface available */
Heinrich Schuchardt6f5c73f2018-03-03 15:28:56 +0100343efi_status_t efi_net_register(void);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200344/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtf2704cc2018-03-03 15:28:57 +0100345efi_status_t efi_watchdog_register(void);
Alexander Graf66f96e12016-08-19 01:23:29 +0200346/* Called by bootefi to make SMBIOS tables available */
Simon Glass2e2858f2018-05-16 09:42:19 -0600347/**
Bin Meng2cfbdae2018-06-27 20:38:03 -0700348 * efi_acpi_register() - write out ACPI tables
349 *
350 * Called by bootefi to make ACPI tables available
351 *
352 * @return 0 if OK, -ENOMEM if no memory is available for the tables
353 */
354efi_status_t efi_acpi_register(void);
355/**
Simon Glass2e2858f2018-05-16 09:42:19 -0600356 * efi_smbios_register() - write out SMBIOS tables
357 *
358 * Called by bootefi to make SMBIOS tables available
359 *
360 * @return 0 if OK, -ENOMEM if no memory is available for the tables
361 */
Heinrich Schuchardt7a369c42018-03-03 15:28:54 +0100362efi_status_t efi_smbios_register(void);
Alexander Graf94c4b992016-05-06 21:01:01 +0200363
Rob Clark53142032017-09-13 18:05:34 -0400364struct efi_simple_file_system_protocol *
365efi_fs_from_path(struct efi_device_path *fp);
366
Alexander Graf94c4b992016-05-06 21:01:01 +0200367/* Called by networking code to memorize the dhcp ack package */
368void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardt18081d42017-10-18 18:13:04 +0200369/* Called by efi_set_watchdog_timer to reset the timer */
370efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf94c4b992016-05-06 21:01:01 +0200371
Alexander Grafc15d9212016-03-04 01:09:59 +0100372/* Called from places to check whether a timer expired */
373void efi_timer_check(void);
374/* PE loader implementation */
Heinrich Schuchardt408fbcc2018-12-26 12:49:09 +0100375efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle, void *efi,
376 struct efi_loaded_image *loaded_image_info);
Alexander Grafc15d9212016-03-04 01:09:59 +0100377/* Called once to store the pristine gd pointer */
378void efi_save_gd(void);
Rob Clark86789d52017-07-27 08:04:18 -0400379/* Special case handler for error/abort that just tries to dtrt to get
380 * back to u-boot world */
Alexander Grafc15d9212016-03-04 01:09:59 +0100381void efi_restore_gd(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100382/* Call this to relocate the runtime section to an address space */
383void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf8f19f262016-03-04 01:10:14 +0100384/* Call this to set the current device name */
Alexander Grafc49a1b82016-04-11 16:16:19 +0200385void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Heinrich Schuchardt967d7de2017-11-26 14:05:23 +0100386/* Add a new object to the object list. */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200387void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardteb6106e2017-10-26 19:25:49 +0200388/* Create handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100389efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt7d135462017-12-04 18:03:02 +0100390/* Delete handle */
Heinrich Schuchardtadb50d02018-09-26 05:27:55 +0200391void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt274cc872017-11-06 21:17:50 +0100392/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100393struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900394/* Load image */
395efi_status_t EFIAPI efi_load_image(bool boot_policy,
396 efi_handle_t parent_image,
397 struct efi_device_path *file_path,
398 void *source_buffer,
399 efi_uintn_t source_size,
400 efi_handle_t *image_handle);
Heinrich Schuchardt2f8eb082018-12-26 13:28:09 +0100401/* Start image */
402efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
403 efi_uintn_t *exit_data_size,
404 u16 **exit_data);
AKASHI Takahirob0ad9052019-03-05 14:53:31 +0900405/* Unload image */
406efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200407/* Find a protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100408efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200409 const efi_guid_t *protocol_guid,
410 struct efi_handler **handler);
411/* Install new protocol on a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100412efi_status_t efi_add_protocol(const efi_handle_t handle,
413 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200414 void *protocol_interface);
415/* Delete protocol from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100416efi_status_t efi_remove_protocol(const efi_handle_t handle,
417 const efi_guid_t *protocol,
Heinrich Schuchardt5aef61d2017-10-26 19:25:53 +0200418 void *protocol_interface);
419/* Delete all protocols from a handle */
Heinrich Schuchardtb7cb8b42018-01-11 08:16:09 +0100420efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt744d83e2019-04-12 06:59:49 +0200421/* Install multiple protocol interfaces */
422efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
423 (efi_handle_t *handle, ...);
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200424/* Call this to create an event */
Heinrich Schuchardtf8d4ec32017-11-06 21:17:47 +0100425efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de852a0e1772017-07-18 20:17:20 +0200426 void (EFIAPI *notify_function) (
427 struct efi_event *event,
428 void *context),
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100429 void *notify_context, efi_guid_t *group,
430 struct efi_event **event);
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200431/* Call this to set a timer */
xypron.glpk@gmx.de3ecc6bd2017-07-19 19:22:34 +0200432efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.dea587fd12017-07-18 20:17:21 +0200433 uint64_t trigger_time);
xypron.glpk@gmx.de54c7a8e2017-07-18 20:17:22 +0200434/* Call this to signal an event */
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200435void efi_signal_event(struct efi_event *event);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100436
Rob Clark53142032017-09-13 18:05:34 -0400437/* open file system: */
438struct efi_simple_file_system_protocol *efi_simple_file_system(
439 struct blk_desc *desc, int part, struct efi_device_path *dp);
440
441/* open file from device-path: */
442struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
443
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100444/**
445 * efi_size_in_pages() - convert size in bytes to size in pages
446 *
447 * This macro returns the number of EFI memory pages required to hold 'size'
448 * bytes.
449 *
450 * @size: size in bytes
451 * Return: size in pages
452 */
453#define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf8623f922016-03-04 01:10:04 +0100454/* Generic EFI memory allocator, call this to get memory */
455void *efi_alloc(uint64_t len, int memory_type);
456/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100457efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf8623f922016-03-04 01:10:04 +0100458 uint64_t *memory);
Stefan Brünsa4f43022016-10-01 23:32:27 +0200459/* EFI memory free function. */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100460efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200461/* EFI memory allocator for small allocations */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100462efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200463 void **buffer);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200464/* EFI pool memory free function. */
465efi_status_t efi_free_pool(void *buffer);
Alexander Graf8623f922016-03-04 01:10:04 +0100466/* Returns the EFI memory map */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100467efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100468 struct efi_mem_desc *memory_map,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100469 efi_uintn_t *map_key,
470 efi_uintn_t *descriptor_size,
Alexander Graf8623f922016-03-04 01:10:04 +0100471 uint32_t *descriptor_version);
472/* Adds a range into the EFI memory map */
473uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
474 bool overlap_only_ram);
Heinrich Schuchardt11206f42018-01-21 19:29:30 +0100475/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt8f3cc5b2018-02-01 12:53:32 +0100476efi_status_t efi_driver_init(void);
Alexander Graf8623f922016-03-04 01:10:04 +0100477/* Called by board init to initialize the EFI memory map */
478int efi_memory_init(void);
Alexander Grafc5c11632016-08-19 01:23:24 +0200479/* Adds new or overrides configuration table entry to the system table */
480efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt7db9f892017-12-04 18:03:01 +0100481/* Sets up a loaded image */
Heinrich Schuchardt3c3a7352018-09-23 17:21:51 +0200482efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
483 struct efi_device_path *file_path,
484 struct efi_loaded_image_obj **handle_ptr,
485 struct efi_loaded_image **info_ptr);
Heinrich Schuchardt83d96b72018-04-05 11:56:21 +0200486/* Print information about all loaded images */
487void efi_print_image_infos(void *pc);
Alexander Graf8623f922016-03-04 01:10:04 +0100488
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200489#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
490extern void *efi_bounce_buffer;
491#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
492#endif
493
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400494
495struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardt753e2482017-10-26 19:25:48 +0200496int efi_dp_match(const struct efi_device_path *a,
497 const struct efi_device_path *b);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400498struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
499 struct efi_device_path **rem);
Heinrich Schuchardt51ca4f52018-04-16 07:59:08 +0200500/* get size of the first device path instance excluding end node */
501efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
502/* size of multi-instance device path excluding end node */
503efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400504struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
505struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
506 const struct efi_device_path *dp2);
507struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
508 const struct efi_device_path *node);
Heinrich Schuchardtb41c8e22018-04-16 07:59:05 +0200509/* Create a device path node of given type, sub-type, length */
510struct efi_device_path *efi_dp_create_device_node(const u8 type,
511 const u8 sub_type,
512 const u16 length);
Heinrich Schuchardtcb0f7ce2018-04-16 07:59:09 +0200513/* Append device path instance */
514struct efi_device_path *efi_dp_append_instance(
515 const struct efi_device_path *dp,
516 const struct efi_device_path *dpi);
517/* Get next device path instance */
518struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
519 efi_uintn_t *size);
520/* Check if a device path contains muliple instances */
521bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400522
523struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
524struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt6c6307c2018-01-19 20:24:46 +0100525/* Create a device node for a block device partition. */
526struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400527struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
528 const char *path);
529struct efi_device_path *efi_dp_from_eth(void);
Rob Clark18ceba72017-10-10 08:23:06 -0400530struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
531 uint64_t start_address,
532 uint64_t end_address);
Heinrich Schuchardt0976f8b2018-01-19 20:24:49 +0100533/* Determine the last device path node that is not the end node. */
534const struct efi_device_path *efi_dp_last_node(
535 const struct efi_device_path *dp);
Heinrich Schuchardt468bf972018-01-19 20:24:37 +0100536efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
537 struct efi_device_path **device_path,
538 struct efi_device_path **file_path);
AKASHI Takahiro035fb012018-10-17 16:32:03 +0900539efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
540 const char *path,
541 struct efi_device_path **device,
542 struct efi_device_path **file);
Rob Clarkf90cb9f2017-09-13 18:05:28 -0400543
544#define EFI_DP_TYPE(_dp, _type, _subtype) \
545 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
546 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
547
Heinrich Schuchardt7b588f42018-09-20 19:57:54 +0200548/**
549 * ascii2unicode() - convert ASCII string to UTF-16 string
550 *
551 * A zero terminated ASCII string is converted to a zero terminated UTF-16
552 * string. The output buffer must be preassigned.
553 *
554 * @unicode: preassigned output buffer for UTF-16 string
555 * @ascii: ASCII string to be converted
556 */
Simon Glass302d4f82016-05-14 14:03:05 -0600557static inline void ascii2unicode(u16 *unicode, const char *ascii)
Alexander Graf8f19f262016-03-04 01:10:14 +0100558{
559 while (*ascii)
560 *(unicode++) = *(ascii++);
Heinrich Schuchardt164026c2018-04-04 15:42:10 +0200561 *unicode = 0;
Alexander Graf8f19f262016-03-04 01:10:14 +0100562}
563
Rob Clark544df3b2017-07-24 07:59:11 -0400564static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
565{
566 return memcmp(g1, g2, sizeof(efi_guid_t));
567}
568
Alexander Graf0bd425a2016-03-04 01:10:01 +0100569/*
570 * Use these to indicate that your code / data should go into the EFI runtime
571 * section and thus still be available when the OS is running
572 */
Alexander Graf94a10f22018-06-12 07:48:37 +0200573#define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
574#define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
Alexander Grafc15d9212016-03-04 01:09:59 +0100575
AKASHI Takahiro32401842019-06-05 13:21:38 +0900576/* Indicate supported runtime services */
577efi_status_t efi_init_runtime_supported(void);
578
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200579/* Update CRC32 in table header */
580void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
581
Alexander Graf77256092016-08-16 21:08:45 +0200582/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
583 * to make it available at runtime */
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100584efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf77256092016-08-16 21:08:45 +0200585
586/* Boards may provide the functions below to implement RTS functionality */
587
Alexander Graf393dd912016-10-14 13:45:30 +0200588void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200589 enum efi_reset_type reset_type,
590 efi_status_t reset_status,
591 unsigned long data_size, void *reset_data);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100592
593/* Architecture specific initialization of the EFI subsystem */
594efi_status_t efi_reset_system_init(void);
Alexander Graf77256092016-08-16 21:08:45 +0200595
Alexander Graf393dd912016-10-14 13:45:30 +0200596efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200597 struct efi_time *time,
598 struct efi_time_cap *capabilities);
Alexander Graf77256092016-08-16 21:08:45 +0200599
Heinrich Schuchardt289121e2019-05-31 07:38:29 +0200600efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
601
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200602#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
603/*
604 * Entry point for the tests of the EFI API.
605 * It is called by 'bootefi selftest'
606 */
607efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
608 struct efi_system_table *systab);
609#endif
610
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100611efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
612 const efi_guid_t *vendor, u32 *attributes,
613 efi_uintn_t *data_size, void *data);
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200614efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
615 u16 *variable_name,
Heinrich Schuchardte06ae192018-12-30 20:53:51 +0100616 const efi_guid_t *vendor);
617efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
618 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt73e2ab02018-12-30 21:03:15 +0100619 efi_uintn_t data_size, const void *data);
Rob Clark15f3d742017-09-13 18:05:37 -0400620
AKASHI Takahirobd237742018-11-05 18:06:41 +0900621/*
622 * See section 3.1.3 in the v2.7 UEFI spec for more details on
623 * the layout of EFI_LOAD_OPTION. In short it is:
624 *
625 * typedef struct _EFI_LOAD_OPTION {
626 * UINT32 Attributes;
627 * UINT16 FilePathListLength;
628 * // CHAR16 Description[]; <-- variable length, NULL terminated
629 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
630 * <-- FilePathListLength bytes
631 * // UINT8 OptionalData[];
632 * } EFI_LOAD_OPTION;
633 */
634struct efi_load_option {
635 u32 attributes;
636 u16 file_path_length;
637 u16 *label;
638 struct efi_device_path *file_path;
Heinrich Schuchardt9df002e2019-04-29 13:51:45 +0200639 const u8 *optional_data;
AKASHI Takahirobd237742018-11-05 18:06:41 +0900640};
641
642void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
643unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
AKASHI Takahiro14ff23b2019-04-19 12:22:35 +0900644efi_status_t efi_bootmgr_load(efi_handle_t *handle);
Rob Clarkc84c1102017-09-13 18:05:38 -0400645
Stephen Warrend0de8062018-08-30 15:43:43 -0600646#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafc15d9212016-03-04 01:09:59 +0100647
Alexander Graf0bd425a2016-03-04 01:10:01 +0100648/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf393dd912016-10-14 13:45:30 +0200649#define __efi_runtime_data
650#define __efi_runtime
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100651static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
652{
653 return EFI_SUCCESS;
654}
Alexander Graf0bd425a2016-03-04 01:10:01 +0100655
Alexander Grafc15d9212016-03-04 01:09:59 +0100656/* No loader configured, stub out EFI_ENTRY */
657static inline void efi_restore_gd(void) { }
Alexander Grafc49a1b82016-04-11 16:16:19 +0200658static inline void efi_set_bootdev(const char *dev, const char *devnr,
659 const char *path) { }
Alexander Graf94c4b992016-05-06 21:01:01 +0200660static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardt83d96b72018-04-05 11:56:21 +0200661static inline void efi_print_image_infos(void *pc) { }
Alexander Grafc15d9212016-03-04 01:09:59 +0100662
Stephen Warrend0de8062018-08-30 15:43:43 -0600663#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Heinrich Schuchardtc2fd4772017-10-18 18:13:07 +0200664
665#endif /* _EFI_LOADER_H */