blob: 8167e6ffcbb26e839f285e7de913d438756b189c [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>
Alexander Grafcb149c62016-03-04 01:09:58 +010012#include <part_efi.h>
13#include <efi_api.h>
Alexander Grafbee91162016-03-04 01:09:59 +010014
15/* No need for efi loader support in SPL */
Stephen Warren9b5e6392018-08-30 15:43:43 -060016#if CONFIG_IS_ENABLED(EFI_LOADER)
Alexander Grafbee91162016-03-04 01:09:59 +010017
Alexander Grafcb149c62016-03-04 01:09:58 +010018#include <linux/list.h>
19
Heinrich Schuchardt4182a122018-06-28 12:45:32 +020020/* Maximum number of configuration tables */
21#define EFI_MAX_CONFIGURATION_TABLES 16
22
Heinrich Schuchardt4e6b5d62018-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 Takahiroa2a4bc32019-04-16 13:24:20 +090028/* Root node */
29extern efi_handle_t efi_root;
30
Rob Clarkc160d2f2017-07-27 08:04:18 -040031int __efi_entry_check(void);
32int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020033const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -040034const char *__efi_nesting_inc(void);
35const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -040036
Rob Clarka095aad2017-07-27 08:04:17 -040037/*
38 * Enter the u-boot world from UEFI:
39 */
Alexander Grafbee91162016-03-04 01:09:59 +010040#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -040041 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -040042 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
43 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +010044 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +010045
Rob Clarka095aad2017-07-27 08:04:17 -040046/*
47 * Exit the u-boot world back to UEFI:
48 */
Rob Clark804b1d72017-07-24 10:31:52 -040049#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020050 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -040051 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020052 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -040053 assert(__efi_exit_check()); \
54 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -040055 })
Alexander Grafbee91162016-03-04 01:09:59 +010056
Rob Clarka095aad2017-07-27 08:04:17 -040057/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020058 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -040059 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020060#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:
72 */
73#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -040074 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -040075 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -040076 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -040077 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -040078 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -040079 } while(0)
80
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020081/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +010082 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020083 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +010084#define EFI_PRINT(format, ...) ({ \
85 debug("%sEFI: " format, __efi_nesting(), \
86 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020087 })
88
Alexander Graf89aea432018-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 Schuchardt1fcb7ea2018-07-02 12:53:55 +020096/* Key identifying current memory map */
97extern efi_uintn_t efi_memory_map_key;
98
Alexander Graf50149ea2016-03-04 01:10:01 +010099extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +0100100extern struct efi_system_table systab;
101
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200102extern struct efi_simple_text_output_protocol efi_con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200103extern struct efi_simple_text_input_protocol efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +0200104extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200105extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-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 Schuchardtb1b782d2019-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 Schuchardt0bc4b0d2018-09-04 19:34:58 +0200113extern const struct efi_unicode_collation_protocol
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200114 efi_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-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 Lindholmc9bfb222019-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 Grafc1311ad2016-03-04 01:10:00 +0100119
Rob Clarkadae4312017-09-13 18:05:30 -0400120uint16_t *efi_dp_str(struct efi_device_path *dp);
121
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200122/* GUID of the U-Boot root node */
123extern const efi_guid_t efi_u_boot_guid;
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +0100124/* GUID of the EFI_BLOCK_IO_PROTOCOL */
125extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400126extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100127extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100128extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100129/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
130extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-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 Schuchardtbc4f9132018-03-03 15:29:03 +0100141/* GUID of the device tree table */
142extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100143extern const efi_guid_t efi_guid_loaded_image;
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900144extern const efi_guid_t efi_guid_loaded_image_device_path;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200145extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-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 Schuchardt9e6835e2018-04-04 15:42:11 +0200148/* GUID for file system information */
149extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100150extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +0200151/* GUID of the deprecated Unicode collation protocol */
152extern const efi_guid_t efi_guid_unicode_collation_protocol;
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +0200153/* GUID of the Unicode collation protocol */
Heinrich Schuchardt95ab3812019-05-16 07:52:58 +0200154extern const efi_guid_t efi_guid_unicode_collation_protocol2;
AKASHI Takahirocb728e52019-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 Lindholmc9bfb222019-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 Grafcb149c62016-03-04 01:09:58 +0100159
Alexander Graf50149ea2016-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
Alexander Grafbee91162016-03-04 01:09:59 +0100163/*
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100164 * When a protocol is opened a open protocol info entry is created.
165 * These are maintained in a list.
166 */
167struct efi_open_protocol_info_item {
168 /* Link to the list of open protocol info entries of a protocol */
169 struct list_head link;
170 struct efi_open_protocol_info_entry info;
171};
172
173/*
Alexander Grafbee91162016-03-04 01:09:59 +0100174 * When the UEFI payload wants to open a protocol on an object to get its
175 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100176 * protocol GUID to the respective protocol interface
177 */
Alexander Grafbee91162016-03-04 01:09:59 +0100178struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100179 /* Link to the list of protocols of a handle */
180 struct list_head link;
Alexander Grafbee91162016-03-04 01:09:59 +0100181 const efi_guid_t *guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200182 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100183 /* Link to the list of open protocol info items */
184 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100185};
186
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200187/**
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200188 * enum efi_object_type - type of EFI object
189 *
190 * In UnloadImage we must be able to identify if the handle relates to a
191 * started image.
192 */
193enum efi_object_type {
194 EFI_OBJECT_TYPE_UNDEFINED = 0,
Heinrich Schuchardt84a918e2019-05-05 16:55:06 +0200195 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200196 EFI_OBJECT_TYPE_LOADED_IMAGE,
197 EFI_OBJECT_TYPE_STARTED_IMAGE,
198};
199
200/**
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200201 * struct efi_object - dereferenced EFI handle
Alexander Grafbee91162016-03-04 01:09:59 +0100202 *
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200203 * @link: pointers to put the handle into a linked list
204 * @protocols: linked list with the protocol interfaces installed on this
205 * handle
206 *
207 * UEFI offers a flexible and expandable object model. The objects in the UEFI
208 * API are devices, drivers, and loaded images. struct efi_object is our storage
209 * structure for these objects.
210 *
211 * When including this structure into a larger structure always put it first so
212 * that when deleting a handle the whole encompassing structure can be freed.
213 *
214 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
215 * has been created for such pointers.
Alexander Grafbee91162016-03-04 01:09:59 +0100216 */
217struct efi_object {
218 /* Every UEFI object is part of a global object list */
219 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100220 /* The list of protocols */
221 struct list_head protocols;
Heinrich Schuchardtcd73aba2019-05-01 14:20:18 +0200222 enum efi_object_type type;
Alexander Grafbee91162016-03-04 01:09:59 +0100223};
224
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200225/**
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200226 * struct efi_loaded_image_obj - handle of a loaded image
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200227 *
228 * @header: EFI object header
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200229 * @exit_status: exit status passed to Exit()
230 * @exit_data_size: exit data size passed to Exit()
231 * @exit_data: exit data passed to Exit()
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200232 * @exit_jmp: long jump buffer for returning form started image
233 * @entry: entry address of the relocated image
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200234 */
235struct efi_loaded_image_obj {
Heinrich Schuchardtd39646a2018-09-26 05:27:56 +0200236 struct efi_object header;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200237 efi_status_t exit_status;
Heinrich Schuchardt556d8dc2019-04-30 17:57:30 +0200238 efi_uintn_t *exit_data_size;
239 u16 **exit_data;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200240 struct jmp_buf_data exit_jmp;
241 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
242 struct efi_system_table *st);
Heinrich Schuchardt126a43f2019-05-01 20:07:04 +0200243 u16 image_type;
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200244};
245
246/**
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200247 * struct efi_event
248 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100249 * @link: Link to list of all events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200250 * @type: Type of event, see efi_create_event
251 * @notify_tpl: Task priority level of notifications
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200252 * @nofify_function: Function to call when the event is triggered
253 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100254 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100255 * @trigger_time: Period of the timer
256 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200257 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100258 * @is_queued: The notification function is queued
259 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200260 */
261struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100262 struct list_head link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200263 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100264 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200265 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
266 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100267 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200268 u64 trigger_next;
269 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200270 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200271 bool is_queued;
272 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200273};
274
Alexander Grafbee91162016-03-04 01:09:59 +0100275/* This list contains all UEFI objects we know of */
276extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100277/* List of all events */
278extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100279
Heinrich Schuchardtab15d412019-05-04 17:27:54 +0200280/**
281 * efi_register_notify_event - event registered by RegisterProtocolNotify()
282 *
283 * The address of this structure serves as registration value.
284 *
285 * @link: link to list of all registered events
286 * @event: registered event. The same event may registered for
287 * multiple GUIDs.
288 * @protocol: protocol for which the event is registered
289 */
290struct efi_register_notify_event {
291 struct list_head link;
292 struct efi_event *event;
293 efi_guid_t protocol;
294};
295
296/* List of all events registered by RegisterProtocolNotify() */
297extern struct list_head efi_register_notify_events;
298
AKASHI Takahiro056b45b2018-12-30 15:16:55 +0100299/* Initialize efi execution environment */
300efi_status_t efi_init_obj_list(void);
Heinrich Schuchardt4e6b5d62018-09-20 21:58:23 +0200301/* Called by bootefi to initialize root node */
302efi_status_t efi_root_node_register(void);
Heinrich Schuchardt640adad2018-06-28 12:45:31 +0200303/* Called by bootefi to initialize runtime */
304efi_status_t efi_initialize_system_table(void);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200305/* Called by bootefi to make console interface available */
Heinrich Schuchardt6f566c22018-10-02 06:08:26 +0200306efi_status_t efi_console_register(void);
Alexander Graf2a22d052016-03-04 01:10:02 +0100307/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtdf9cf562018-02-09 20:55:47 +0100308efi_status_t efi_disk_register(void);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100309/* Create handles and protocols for the partitions of a block device */
310int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
311 const char *if_typename, int diskid,
312 const char *pdevname);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100313/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100314efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200315/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100316efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200317/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100318efi_status_t efi_watchdog_register(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200319/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600320/**
Bin Meng86df34d2018-06-27 20:38:03 -0700321 * efi_acpi_register() - write out ACPI tables
322 *
323 * Called by bootefi to make ACPI tables available
324 *
325 * @return 0 if OK, -ENOMEM if no memory is available for the tables
326 */
327efi_status_t efi_acpi_register(void);
328/**
Simon Glass0864c562018-05-16 09:42:19 -0600329 * efi_smbios_register() - write out SMBIOS tables
330 *
331 * Called by bootefi to make SMBIOS tables available
332 *
333 * @return 0 if OK, -ENOMEM if no memory is available for the tables
334 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100335efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200336
Rob Clark2a920802017-09-13 18:05:34 -0400337struct efi_simple_file_system_protocol *
338efi_fs_from_path(struct efi_device_path *fp);
339
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200340/* Called by networking code to memorize the dhcp ack package */
341void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200342/* Called by efi_set_watchdog_timer to reset the timer */
343efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200344
Alexander Grafbee91162016-03-04 01:09:59 +0100345/* Called from places to check whether a timer expired */
346void efi_timer_check(void);
347/* PE loader implementation */
Heinrich Schuchardt8f7e2b22018-12-26 12:49:09 +0100348efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle, void *efi,
349 struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100350/* Called once to store the pristine gd pointer */
351void efi_save_gd(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400352/* Special case handler for error/abort that just tries to dtrt to get
353 * back to u-boot world */
Alexander Grafbee91162016-03-04 01:09:59 +0100354void efi_restore_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100355/* Call this to relocate the runtime section to an address space */
356void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100357/* Call this to set the current device name */
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200358void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100359/* Add a new object to the object list. */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200360void efi_add_handle(efi_handle_t obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200361/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100362efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100363/* Delete handle */
Heinrich Schuchardtfae01182018-09-26 05:27:55 +0200364void efi_delete_handle(efi_handle_t obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100365/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100366struct efi_object *efi_search_obj(const efi_handle_t handle);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900367/* Load image */
368efi_status_t EFIAPI efi_load_image(bool boot_policy,
369 efi_handle_t parent_image,
370 struct efi_device_path *file_path,
371 void *source_buffer,
372 efi_uintn_t source_size,
373 efi_handle_t *image_handle);
Heinrich Schuchardtf69d63f2018-12-26 13:28:09 +0100374/* Start image */
375efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
376 efi_uintn_t *exit_data_size,
377 u16 **exit_data);
AKASHI Takahirod7e0b012019-03-05 14:53:31 +0900378/* Unload image */
379efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200380/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100381efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200382 const efi_guid_t *protocol_guid,
383 struct efi_handler **handler);
384/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100385efi_status_t efi_add_protocol(const efi_handle_t handle,
386 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200387 void *protocol_interface);
388/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100389efi_status_t efi_remove_protocol(const efi_handle_t handle,
390 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200391 void *protocol_interface);
392/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100393efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
Heinrich Schuchardt7657ae12019-04-12 06:59:49 +0200394/* Install multiple protocol interfaces */
395efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
396 (efi_handle_t *handle, ...);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200397/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100398efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200399 void (EFIAPI *notify_function) (
400 struct efi_event *event,
401 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100402 void *notify_context, efi_guid_t *group,
403 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200404/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200405efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200406 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200407/* Call this to signal an event */
Heinrich Schuchardt9bc96642018-01-19 20:24:51 +0100408void efi_signal_event(struct efi_event *event, bool check_tpl);
Alexander Graf50149ea2016-03-04 01:10:01 +0100409
Rob Clark2a920802017-09-13 18:05:34 -0400410/* open file system: */
411struct efi_simple_file_system_protocol *efi_simple_file_system(
412 struct blk_desc *desc, int part, struct efi_device_path *dp);
413
414/* open file from device-path: */
415struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
416
Heinrich Schuchardtc3772ca2018-11-18 17:58:49 +0100417/**
418 * efi_size_in_pages() - convert size in bytes to size in pages
419 *
420 * This macro returns the number of EFI memory pages required to hold 'size'
421 * bytes.
422 *
423 * @size: size in bytes
424 * Return: size in pages
425 */
426#define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
Alexander Graf5d009952016-03-04 01:10:04 +0100427/* Generic EFI memory allocator, call this to get memory */
428void *efi_alloc(uint64_t len, int memory_type);
429/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100430efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf5d009952016-03-04 01:10:04 +0100431 uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200432/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100433efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200434/* EFI memory allocator for small allocations */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100435efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200436 void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200437/* EFI pool memory free function. */
438efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100439/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100440efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100441 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100442 efi_uintn_t *map_key,
443 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100444 uint32_t *descriptor_version);
445/* Adds a range into the EFI memory map */
446uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
447 bool overlap_only_ram);
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100448/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100449efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100450/* Called by board init to initialize the EFI memory map */
451int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200452/* Adds new or overrides configuration table entry to the system table */
453efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100454/* Sets up a loaded image */
Heinrich Schuchardtc9828742018-09-23 17:21:51 +0200455efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
456 struct efi_device_path *file_path,
457 struct efi_loaded_image_obj **handle_ptr,
458 struct efi_loaded_image **info_ptr);
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200459/* Print information about all loaded images */
460void efi_print_image_infos(void *pc);
Alexander Graf5d009952016-03-04 01:10:04 +0100461
Alexander Graf51735ae2016-05-11 18:25:48 +0200462#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
463extern void *efi_bounce_buffer;
464#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
465#endif
466
Rob Clarkb66c60d2017-09-13 18:05:28 -0400467
468struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200469int efi_dp_match(const struct efi_device_path *a,
470 const struct efi_device_path *b);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400471struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
472 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200473/* get size of the first device path instance excluding end node */
474efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
475/* size of multi-instance device path excluding end node */
476efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400477struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
478struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
479 const struct efi_device_path *dp2);
480struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
481 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200482/* Create a device path node of given type, sub-type, length */
483struct efi_device_path *efi_dp_create_device_node(const u8 type,
484 const u8 sub_type,
485 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200486/* Append device path instance */
487struct efi_device_path *efi_dp_append_instance(
488 const struct efi_device_path *dp,
489 const struct efi_device_path *dpi);
490/* Get next device path instance */
491struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
492 efi_uintn_t *size);
493/* Check if a device path contains muliple instances */
494bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400495
496struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
497struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100498/* Create a device node for a block device partition. */
499struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400500struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
501 const char *path);
502struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400503struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
504 uint64_t start_address,
505 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100506/* Determine the last device path node that is not the end node. */
507const struct efi_device_path *efi_dp_last_node(
508 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100509efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
510 struct efi_device_path **device_path,
511 struct efi_device_path **file_path);
AKASHI Takahirof1589ff2018-10-17 16:32:03 +0900512efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
513 const char *path,
514 struct efi_device_path **device,
515 struct efi_device_path **file);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400516
517#define EFI_DP_TYPE(_dp, _type, _subtype) \
518 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
519 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
520
Heinrich Schuchardt9d08f6d2018-09-20 19:57:54 +0200521/**
522 * ascii2unicode() - convert ASCII string to UTF-16 string
523 *
524 * A zero terminated ASCII string is converted to a zero terminated UTF-16
525 * string. The output buffer must be preassigned.
526 *
527 * @unicode: preassigned output buffer for UTF-16 string
528 * @ascii: ASCII string to be converted
529 */
Simon Glass487d7562016-05-14 14:03:05 -0600530static inline void ascii2unicode(u16 *unicode, const char *ascii)
Alexander Graf0f4060e2016-03-04 01:10:14 +0100531{
532 while (*ascii)
533 *(unicode++) = *(ascii++);
Heinrich Schuchardtc4121662018-04-04 15:42:10 +0200534 *unicode = 0;
Alexander Graf0f4060e2016-03-04 01:10:14 +0100535}
536
Rob Clark3e094c52017-07-24 07:59:11 -0400537static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
538{
539 return memcmp(g1, g2, sizeof(efi_guid_t));
540}
541
Alexander Graf50149ea2016-03-04 01:10:01 +0100542/*
543 * Use these to indicate that your code / data should go into the EFI runtime
544 * section and thus still be available when the OS is running
545 */
Alexander Graf7e21fbc2018-06-12 07:48:37 +0200546#define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
547#define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
Alexander Grafbee91162016-03-04 01:09:59 +0100548
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200549/* Update CRC32 in table header */
550void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
551
Alexander Graf80a48002016-08-16 21:08:45 +0200552/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
553 * to make it available at runtime */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100554efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf80a48002016-08-16 21:08:45 +0200555
556/* Boards may provide the functions below to implement RTS functionality */
557
Alexander Graf3c63db92016-10-14 13:45:30 +0200558void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200559 enum efi_reset_type reset_type,
560 efi_status_t reset_status,
561 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100562
563/* Architecture specific initialization of the EFI subsystem */
564efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200565
Alexander Graf3c63db92016-10-14 13:45:30 +0200566efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200567 struct efi_time *time,
568 struct efi_time_cap *capabilities);
Alexander Graf80a48002016-08-16 21:08:45 +0200569
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200570#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
571/*
572 * Entry point for the tests of the EFI API.
573 * It is called by 'bootefi selftest'
574 */
575efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
576 struct efi_system_table *systab);
577#endif
578
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100579efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
580 const efi_guid_t *vendor, u32 *attributes,
581 efi_uintn_t *data_size, void *data);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200582efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
583 u16 *variable_name,
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100584 const efi_guid_t *vendor);
585efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
586 const efi_guid_t *vendor, u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100587 efi_uintn_t data_size, const void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400588
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900589/*
590 * See section 3.1.3 in the v2.7 UEFI spec for more details on
591 * the layout of EFI_LOAD_OPTION. In short it is:
592 *
593 * typedef struct _EFI_LOAD_OPTION {
594 * UINT32 Attributes;
595 * UINT16 FilePathListLength;
596 * // CHAR16 Description[]; <-- variable length, NULL terminated
597 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
598 * <-- FilePathListLength bytes
599 * // UINT8 OptionalData[];
600 * } EFI_LOAD_OPTION;
601 */
602struct efi_load_option {
603 u32 attributes;
604 u16 file_path_length;
605 u16 *label;
606 struct efi_device_path *file_path;
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200607 const u8 *optional_data;
AKASHI Takahiro1a82b342018-11-05 18:06:41 +0900608};
609
610void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
611unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
AKASHI Takahiro6b95b382019-04-19 12:22:35 +0900612efi_status_t efi_bootmgr_load(efi_handle_t *handle);
Rob Clark9975fe92017-09-13 18:05:38 -0400613
Stephen Warren9b5e6392018-08-30 15:43:43 -0600614#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
Alexander Grafbee91162016-03-04 01:09:59 +0100615
Alexander Graf50149ea2016-03-04 01:10:01 +0100616/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf3c63db92016-10-14 13:45:30 +0200617#define __efi_runtime_data
618#define __efi_runtime
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100619static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
620{
621 return EFI_SUCCESS;
622}
Alexander Graf50149ea2016-03-04 01:10:01 +0100623
Alexander Grafbee91162016-03-04 01:09:59 +0100624/* No loader configured, stub out EFI_ENTRY */
625static inline void efi_restore_gd(void) { }
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200626static inline void efi_set_bootdev(const char *dev, const char *devnr,
627 const char *path) { }
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200628static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200629static inline void efi_print_image_infos(void *pc) { }
Alexander Grafbee91162016-03-04 01:09:59 +0100630
Stephen Warren9b5e6392018-08-30 15:43:43 -0600631#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200632
633#endif /* _EFI_LOADER_H */