blob: d837e7b157fda8167b1889e9ef9079f9ce2c877d [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 */
16#if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
17
Alexander Grafcb149c62016-03-04 01:09:58 +010018#include <linux/list.h>
19
Rob Clarkc160d2f2017-07-27 08:04:18 -040020int __efi_entry_check(void);
21int __efi_exit_check(void);
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020022const char *__efi_nesting(void);
Rob Clarkaf65db82017-07-27 08:04:19 -040023const char *__efi_nesting_inc(void);
24const char *__efi_nesting_dec(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -040025
Rob Clarka095aad2017-07-27 08:04:17 -040026/*
27 * Enter the u-boot world from UEFI:
28 */
Alexander Grafbee91162016-03-04 01:09:59 +010029#define EFI_ENTRY(format, ...) do { \
Rob Clarkc160d2f2017-07-27 08:04:18 -040030 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -040031 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
32 __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +010033 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +010034
Rob Clarka095aad2017-07-27 08:04:17 -040035/*
36 * Exit the u-boot world back to UEFI:
37 */
Rob Clark804b1d72017-07-24 10:31:52 -040038#define EFI_EXIT(ret) ({ \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020039 typeof(ret) _r = ret; \
Rob Clarkaf65db82017-07-27 08:04:19 -040040 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
xypron.glpk@gmx.dec81883d2017-08-17 18:57:36 +020041 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
Rob Clarkc160d2f2017-07-27 08:04:18 -040042 assert(__efi_exit_check()); \
43 _r; \
Rob Clark804b1d72017-07-24 10:31:52 -040044 })
Alexander Grafbee91162016-03-04 01:09:59 +010045
Rob Clarka095aad2017-07-27 08:04:17 -040046/*
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020047 * Call non-void UEFI function from u-boot and retrieve return value:
Rob Clarka095aad2017-07-27 08:04:17 -040048 */
Heinrich Schuchardtea630ce2017-09-15 10:06:10 +020049#define EFI_CALL(exp) ({ \
50 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
51 assert(__efi_exit_check()); \
52 typeof(exp) _r = exp; \
53 assert(__efi_entry_check()); \
54 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
55 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
56 _r; \
57})
58
59/*
60 * Call void UEFI function from u-boot:
61 */
62#define EFI_CALL_VOID(exp) do { \
Rob Clarkaf65db82017-07-27 08:04:19 -040063 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
Rob Clarkc160d2f2017-07-27 08:04:18 -040064 assert(__efi_exit_check()); \
Rob Clarka095aad2017-07-27 08:04:17 -040065 exp; \
Rob Clarkc160d2f2017-07-27 08:04:18 -040066 assert(__efi_entry_check()); \
Rob Clarkaf65db82017-07-27 08:04:19 -040067 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
Rob Clarka095aad2017-07-27 08:04:17 -040068 } while(0)
69
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020070/*
Heinrich Schuchardtd5504142018-01-11 08:16:01 +010071 * Write an indented message with EFI prefix
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020072 */
Heinrich Schuchardtd5504142018-01-11 08:16:01 +010073#define EFI_PRINT(format, ...) ({ \
74 debug("%sEFI: " format, __efi_nesting(), \
75 ##__VA_ARGS__); \
Heinrich Schuchardtae0bd3a2017-08-18 17:45:16 +020076 })
77
Alexander Graf89aea432018-04-23 07:59:47 +020078#ifdef CONFIG_SYS_CACHELINE_SIZE
79#define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
80#else
81/* Just use the greatest cache flush alignment requirement I'm aware of */
82#define EFI_CACHELINE_SIZE 128
83#endif
84
Alexander Graf50149ea2016-03-04 01:10:01 +010085extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +010086extern struct efi_system_table systab;
87
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +020088extern struct efi_simple_text_output_protocol efi_con_out;
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +020089extern struct efi_simple_input_interface efi_con_in;
Heinrich Schuchardtebb4dd52017-10-26 19:25:59 +020090extern struct efi_console_control_protocol efi_console_control;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +020091extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
Leif Lindholme70f8df2018-03-09 17:43:21 +010092/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
93extern const struct efi_device_path_utilities_protocol
94 efi_device_path_utilities;
Alexander Grafc1311ad2016-03-04 01:10:00 +010095
Rob Clarkadae4312017-09-13 18:05:30 -040096uint16_t *efi_dp_str(struct efi_device_path *dp);
97
Heinrich Schuchardtb3dd14b2018-01-19 20:24:45 +010098/* GUID of the EFI_BLOCK_IO_PROTOCOL */
99extern const efi_guid_t efi_block_io_guid;
Rob Clark9975fe92017-09-13 18:05:38 -0400100extern const efi_guid_t efi_global_variable_guid;
Alexander Grafc1311ad2016-03-04 01:10:00 +0100101extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +0100102extern const efi_guid_t efi_guid_device_path;
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +0100103/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
104extern const efi_guid_t efi_guid_driver_binding_protocol;
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100105/* event group ExitBootServices() invoked */
106extern const efi_guid_t efi_guid_event_group_exit_boot_services;
107/* event group SetVirtualAddressMap() invoked */
108extern const efi_guid_t efi_guid_event_group_virtual_address_change;
109/* event group memory map changed */
110extern const efi_guid_t efi_guid_event_group_memory_map_change;
111/* event group boot manager about to boot */
112extern const efi_guid_t efi_guid_event_group_ready_to_boot;
113/* event group ResetSystem() invoked (before ExitBootServices) */
114extern const efi_guid_t efi_guid_event_group_reset_system;
Heinrich Schuchardtbc4f9132018-03-03 15:29:03 +0100115/* GUID of the device tree table */
116extern const efi_guid_t efi_guid_fdt;
Alexander Grafcb149c62016-03-04 01:09:58 +0100117extern const efi_guid_t efi_guid_loaded_image;
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200118extern const efi_guid_t efi_guid_device_path_to_text_protocol;
Rob Clark2a920802017-09-13 18:05:34 -0400119extern const efi_guid_t efi_simple_file_system_protocol_guid;
120extern const efi_guid_t efi_file_info_guid;
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +0200121/* GUID for file system information */
122extern const efi_guid_t efi_file_system_info_guid;
Leif Lindholme70f8df2018-03-09 17:43:21 +0100123extern const efi_guid_t efi_guid_device_path_utilities_protocol;
Alexander Grafcb149c62016-03-04 01:09:58 +0100124
Alexander Graf50149ea2016-03-04 01:10:01 +0100125extern unsigned int __efi_runtime_start, __efi_runtime_stop;
126extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
127
Alexander Grafbee91162016-03-04 01:09:59 +0100128/*
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100129 * When a protocol is opened a open protocol info entry is created.
130 * These are maintained in a list.
131 */
132struct efi_open_protocol_info_item {
133 /* Link to the list of open protocol info entries of a protocol */
134 struct list_head link;
135 struct efi_open_protocol_info_entry info;
136};
137
138/*
Alexander Grafbee91162016-03-04 01:09:59 +0100139 * When the UEFI payload wants to open a protocol on an object to get its
140 * interface (usually a struct with callback functions), this struct maps the
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100141 * protocol GUID to the respective protocol interface
142 */
Alexander Grafbee91162016-03-04 01:09:59 +0100143struct efi_handler {
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100144 /* Link to the list of protocols of a handle */
145 struct list_head link;
Alexander Grafbee91162016-03-04 01:09:59 +0100146 const efi_guid_t *guid;
xypron.glpk@gmx.deb5349f72017-07-11 22:06:14 +0200147 void *protocol_interface;
Heinrich Schuchardtfe1599d2018-01-11 08:15:57 +0100148 /* Link to the list of open protocol info items */
149 struct list_head open_infos;
Alexander Grafbee91162016-03-04 01:09:59 +0100150};
151
152/*
153 * UEFI has a poor man's OO model where one "object" can be polymorphic and have
154 * multiple different protocols (classes) attached to it.
155 *
156 * This struct is the parent struct for all of our actual implementation objects
157 * that can include it to make themselves an EFI object
158 */
159struct efi_object {
160 /* Every UEFI object is part of a global object list */
161 struct list_head link;
Heinrich Schuchardt69fb6b12017-11-26 14:05:17 +0100162 /* The list of protocols */
163 struct list_head protocols;
Alexander Grafbee91162016-03-04 01:09:59 +0100164 /* The object spawner can either use this for data or as identifier */
165 void *handle;
166};
167
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200168/**
169 * struct efi_event
170 *
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100171 * @link: Link to list of all events
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200172 * @type: Type of event, see efi_create_event
173 * @notify_tpl: Task priority level of notifications
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200174 * @nofify_function: Function to call when the event is triggered
175 * @notify_context: Data to be passed to the notify function
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100176 * @group: Event group
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100177 * @trigger_time: Period of the timer
178 * @trigger_next: Next time to trigger the timer
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200179 * @trigger_type: Type of timer, see efi_set_timer
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100180 * @is_queued: The notification function is queued
181 * @is_signaled: The event occurred. The event is in the signaled state.
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200182 */
183struct efi_event {
Heinrich Schuchardt43bce442018-02-18 15:17:50 +0100184 struct list_head link;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200185 uint32_t type;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100186 efi_uintn_t notify_tpl;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200187 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
188 void *notify_context;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100189 const efi_guid_t *group;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200190 u64 trigger_next;
191 u64 trigger_time;
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200192 enum efi_timer_delay trigger_type;
Heinrich Schuchardte190e892017-10-04 15:03:24 +0200193 bool is_queued;
194 bool is_signaled;
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +0200195};
196
Alexander Grafbee91162016-03-04 01:09:59 +0100197/* This list contains all UEFI objects we know of */
198extern struct list_head efi_obj_list;
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100199/* List of all events */
200extern struct list_head efi_events;
Alexander Grafbee91162016-03-04 01:09:59 +0100201
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200202/* Called by bootefi to make console interface available */
203int efi_console_register(void);
Alexander Graf2a22d052016-03-04 01:10:02 +0100204/* Called by bootefi to make all disk storage accessible as EFI objects */
Heinrich Schuchardtdf9cf562018-02-09 20:55:47 +0100205efi_status_t efi_disk_register(void);
Heinrich Schuchardt64e4db02018-01-19 20:24:47 +0100206/* Create handles and protocols for the partitions of a block device */
207int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
208 const char *if_typename, int diskid,
209 const char *pdevname);
Alexander Grafbe8d3242016-03-15 18:38:21 +0100210/* Called by bootefi to make GOP (graphical) interface available */
Heinrich Schuchardt80ea9b02018-03-03 15:28:55 +0100211efi_status_t efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200212/* Called by bootefi to make the network interface available */
Heinrich Schuchardt075d4252018-03-03 15:28:56 +0100213efi_status_t efi_net_register(void);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200214/* Called by bootefi to make the watchdog available */
Heinrich Schuchardtd7b181d2018-03-03 15:28:57 +0100215efi_status_t efi_watchdog_register(void);
Alexander Grafe663b352016-08-19 01:23:29 +0200216/* Called by bootefi to make SMBIOS tables available */
Simon Glass0864c562018-05-16 09:42:19 -0600217/**
Bin Meng86df34d2018-06-27 20:38:03 -0700218 * efi_acpi_register() - write out ACPI tables
219 *
220 * Called by bootefi to make ACPI tables available
221 *
222 * @return 0 if OK, -ENOMEM if no memory is available for the tables
223 */
224efi_status_t efi_acpi_register(void);
225/**
Simon Glass0864c562018-05-16 09:42:19 -0600226 * efi_smbios_register() - write out SMBIOS tables
227 *
228 * Called by bootefi to make SMBIOS tables available
229 *
230 * @return 0 if OK, -ENOMEM if no memory is available for the tables
231 */
Heinrich Schuchardt76571522018-03-03 15:28:54 +0100232efi_status_t efi_smbios_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200233
Rob Clark2a920802017-09-13 18:05:34 -0400234struct efi_simple_file_system_protocol *
235efi_fs_from_path(struct efi_device_path *fp);
236
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200237/* Called by networking code to memorize the dhcp ack package */
238void efi_net_set_dhcp_ack(void *pkt, int len);
Heinrich Schuchardtb3d60902017-10-18 18:13:04 +0200239/* Called by efi_set_watchdog_timer to reset the timer */
240efi_status_t efi_set_watchdog(unsigned long timeout);
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200241
Alexander Grafbee91162016-03-04 01:09:59 +0100242/* Called from places to check whether a timer expired */
243void efi_timer_check(void);
244/* PE loader implementation */
Alexander Grafcb149c62016-03-04 01:09:58 +0100245void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100246/* Called once to store the pristine gd pointer */
247void efi_save_gd(void);
Rob Clarkc160d2f2017-07-27 08:04:18 -0400248/* Special case handler for error/abort that just tries to dtrt to get
249 * back to u-boot world */
Alexander Grafbee91162016-03-04 01:09:59 +0100250void efi_restore_gd(void);
Alexander Graf50149ea2016-03-04 01:10:01 +0100251/* Call this to relocate the runtime section to an address space */
252void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100253/* Call this to set the current device name */
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200254void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Heinrich Schuchardt44549d62017-11-26 14:05:23 +0100255/* Add a new object to the object list. */
256void efi_add_handle(struct efi_object *obj);
Heinrich Schuchardt2edab5e2017-10-26 19:25:49 +0200257/* Create handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100258efi_status_t efi_create_handle(efi_handle_t *handle);
Heinrich Schuchardt678e03a2017-12-04 18:03:02 +0100259/* Delete handle */
260void efi_delete_handle(struct efi_object *obj);
Heinrich Schuchardt1b681532017-11-06 21:17:50 +0100261/* Call this to validate a handle and find the EFI object for it */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100262struct efi_object *efi_search_obj(const efi_handle_t handle);
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200263/* Find a protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100264efi_status_t efi_search_protocol(const efi_handle_t handle,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200265 const efi_guid_t *protocol_guid,
266 struct efi_handler **handler);
267/* Install new protocol on a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100268efi_status_t efi_add_protocol(const efi_handle_t handle,
269 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200270 void *protocol_interface);
271/* Delete protocol from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100272efi_status_t efi_remove_protocol(const efi_handle_t handle,
273 const efi_guid_t *protocol,
Heinrich Schuchardt3f79a2b2017-10-26 19:25:53 +0200274 void *protocol_interface);
275/* Delete all protocols from a handle */
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100276efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200277/* Call this to create an event */
Heinrich Schuchardt152cade2017-11-06 21:17:47 +0100278efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
xypron.glpk@gmx.de49deb452017-07-18 20:17:20 +0200279 void (EFIAPI *notify_function) (
280 struct efi_event *event,
281 void *context),
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100282 void *notify_context, efi_guid_t *group,
283 struct efi_event **event);
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200284/* Call this to set a timer */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +0200285efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
xypron.glpk@gmx.debfc72462017-07-18 20:17:21 +0200286 uint64_t trigger_time);
xypron.glpk@gmx.de91be9a72017-07-18 20:17:22 +0200287/* Call this to signal an event */
Heinrich Schuchardt9bc96642018-01-19 20:24:51 +0100288void efi_signal_event(struct efi_event *event, bool check_tpl);
Alexander Graf50149ea2016-03-04 01:10:01 +0100289
Rob Clark2a920802017-09-13 18:05:34 -0400290/* open file system: */
291struct efi_simple_file_system_protocol *efi_simple_file_system(
292 struct blk_desc *desc, int part, struct efi_device_path *dp);
293
294/* open file from device-path: */
295struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
296
297
Alexander Graf5d009952016-03-04 01:10:04 +0100298/* Generic EFI memory allocator, call this to get memory */
299void *efi_alloc(uint64_t len, int memory_type);
300/* More specific EFI memory allocator, called by EFI payloads */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100301efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
Alexander Graf5d009952016-03-04 01:10:04 +0100302 uint64_t *memory);
Stefan Brünsb61d8572016-10-01 23:32:27 +0200303/* EFI memory free function. */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100304efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
Stefan Brünsead12742016-10-09 22:17:18 +0200305/* EFI memory allocator for small allocations */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100306efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
Stefan Brünsead12742016-10-09 22:17:18 +0200307 void **buffer);
Stefan Brüns42417bc2016-10-09 22:17:26 +0200308/* EFI pool memory free function. */
309efi_status_t efi_free_pool(void *buffer);
Alexander Graf5d009952016-03-04 01:10:04 +0100310/* Returns the EFI memory map */
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100311efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100312 struct efi_mem_desc *memory_map,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100313 efi_uintn_t *map_key,
314 efi_uintn_t *descriptor_size,
Alexander Graf5d009952016-03-04 01:10:04 +0100315 uint32_t *descriptor_version);
316/* Adds a range into the EFI memory map */
317uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
318 bool overlap_only_ram);
Heinrich Schuchardt05ef48a2018-01-21 19:29:30 +0100319/* Called by board init to initialize the EFI drivers */
Heinrich Schuchardt038782a2018-02-01 12:53:32 +0100320efi_status_t efi_driver_init(void);
Alexander Graf5d009952016-03-04 01:10:04 +0100321/* Called by board init to initialize the EFI memory map */
322int efi_memory_init(void);
Alexander Graf488bf122016-08-19 01:23:24 +0200323/* Adds new or overrides configuration table entry to the system table */
324efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
Heinrich Schuchardt56d92882017-12-04 18:03:01 +0100325/* Sets up a loaded image */
326efi_status_t efi_setup_loaded_image(
327 struct efi_loaded_image *info, struct efi_object *obj,
328 struct efi_device_path *device_path,
329 struct efi_device_path *file_path);
Rob Clark9975fe92017-09-13 18:05:38 -0400330efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
331 void **buffer);
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200332/* Print information about a loaded image */
333efi_status_t efi_print_image_info(struct efi_loaded_image *image, void *pc);
334/* Print information about all loaded images */
335void efi_print_image_infos(void *pc);
Alexander Graf5d009952016-03-04 01:10:04 +0100336
Alexander Graf51735ae2016-05-11 18:25:48 +0200337#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
338extern void *efi_bounce_buffer;
339#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
340#endif
341
Rob Clarkb66c60d2017-09-13 18:05:28 -0400342
343struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
Heinrich Schuchardtff401d32017-10-26 19:25:48 +0200344int efi_dp_match(const struct efi_device_path *a,
345 const struct efi_device_path *b);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400346struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
347 struct efi_device_path **rem);
Heinrich Schuchardtf6dd3f32018-04-16 07:59:08 +0200348/* get size of the first device path instance excluding end node */
349efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
350/* size of multi-instance device path excluding end node */
351efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400352struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
353struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
354 const struct efi_device_path *dp2);
355struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
356 const struct efi_device_path *node);
Heinrich Schuchardt211314c2018-04-16 07:59:05 +0200357/* Create a device path node of given type, sub-type, length */
358struct efi_device_path *efi_dp_create_device_node(const u8 type,
359 const u8 sub_type,
360 const u16 length);
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200361/* Append device path instance */
362struct efi_device_path *efi_dp_append_instance(
363 const struct efi_device_path *dp,
364 const struct efi_device_path *dpi);
365/* Get next device path instance */
366struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
367 efi_uintn_t *size);
368/* Check if a device path contains muliple instances */
369bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400370
371struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
372struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
Heinrich Schuchardt98d48bd2018-01-19 20:24:46 +0100373/* Create a device node for a block device partition. */
374struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400375struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
376 const char *path);
377struct efi_device_path *efi_dp_from_eth(void);
Rob Clarkbf192732017-10-10 08:23:06 -0400378struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
379 uint64_t start_address,
380 uint64_t end_address);
Heinrich Schuchardt65436f92018-01-19 20:24:49 +0100381/* Determine the last device path node that is not the end node. */
382const struct efi_device_path *efi_dp_last_node(
383 const struct efi_device_path *dp);
Heinrich Schuchardt04298682018-01-19 20:24:37 +0100384efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
385 struct efi_device_path **device_path,
386 struct efi_device_path **file_path);
Rob Clarkb66c60d2017-09-13 18:05:28 -0400387
388#define EFI_DP_TYPE(_dp, _type, _subtype) \
389 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
390 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
391
Alexander Graf0f4060e2016-03-04 01:10:14 +0100392/* Convert strings from normal C strings to uEFI strings */
Simon Glass487d7562016-05-14 14:03:05 -0600393static inline void ascii2unicode(u16 *unicode, const char *ascii)
Alexander Graf0f4060e2016-03-04 01:10:14 +0100394{
395 while (*ascii)
396 *(unicode++) = *(ascii++);
Heinrich Schuchardtc4121662018-04-04 15:42:10 +0200397 *unicode = 0;
Alexander Graf0f4060e2016-03-04 01:10:14 +0100398}
399
Rob Clark3e094c52017-07-24 07:59:11 -0400400static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
401{
402 return memcmp(g1, g2, sizeof(efi_guid_t));
403}
404
Alexander Graf50149ea2016-03-04 01:10:01 +0100405/*
406 * Use these to indicate that your code / data should go into the EFI runtime
407 * section and thus still be available when the OS is running
408 */
Alexander Graf3c63db92016-10-14 13:45:30 +0200409#define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
410#define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
Alexander Grafbee91162016-03-04 01:09:59 +0100411
Alexander Graf80a48002016-08-16 21:08:45 +0200412/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
413 * to make it available at runtime */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100414efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
Alexander Graf80a48002016-08-16 21:08:45 +0200415
416/* Boards may provide the functions below to implement RTS functionality */
417
Alexander Graf3c63db92016-10-14 13:45:30 +0200418void __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200419 enum efi_reset_type reset_type,
420 efi_status_t reset_status,
421 unsigned long data_size, void *reset_data);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100422
423/* Architecture specific initialization of the EFI subsystem */
424efi_status_t efi_reset_system_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200425
Alexander Graf3c63db92016-10-14 13:45:30 +0200426efi_status_t __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200427 struct efi_time *time,
428 struct efi_time_cap *capabilities);
Heinrich Schuchardt14ad49d2018-03-03 15:29:00 +0100429efi_status_t efi_get_time_init(void);
Alexander Graf80a48002016-08-16 21:08:45 +0200430
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200431#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
432/*
433 * Entry point for the tests of the EFI API.
434 * It is called by 'bootefi selftest'
435 */
436efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
437 struct efi_system_table *systab);
438#endif
439
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200440efi_status_t EFIAPI efi_get_variable(u16 *variable_name, efi_guid_t *vendor,
441 u32 *attributes, efi_uintn_t *data_size,
442 void *data);
443efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
444 u16 *variable_name,
445 efi_guid_t *vendor);
446efi_status_t EFIAPI efi_set_variable(u16 *variable_name, efi_guid_t *vendor,
447 u32 attributes, efi_uintn_t data_size,
448 void *data);
Rob Clarkad644e72017-09-13 18:05:37 -0400449
Rob Clark9975fe92017-09-13 18:05:38 -0400450void *efi_bootmgr_load(struct efi_device_path **device_path,
451 struct efi_device_path **file_path);
452
Alexander Grafbee91162016-03-04 01:09:59 +0100453#else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
454
Alexander Graf50149ea2016-03-04 01:10:01 +0100455/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
Alexander Graf3c63db92016-10-14 13:45:30 +0200456#define __efi_runtime_data
457#define __efi_runtime
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100458static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
459{
460 return EFI_SUCCESS;
461}
Alexander Graf50149ea2016-03-04 01:10:01 +0100462
Alexander Grafbee91162016-03-04 01:09:59 +0100463/* No loader configured, stub out EFI_ENTRY */
464static inline void efi_restore_gd(void) { }
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200465static inline void efi_set_bootdev(const char *dev, const char *devnr,
466 const char *path) { }
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200467static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Heinrich Schuchardtc9a63f42018-04-05 11:56:21 +0200468static inline void efi_print_image_infos(void *pc) { }
Alexander Grafbee91162016-03-04 01:09:59 +0100469
Heinrich Schuchardtcd9e18d2017-10-18 18:13:07 +0200470#endif /* CONFIG_EFI_LOADER && !CONFIG_SPL_BUILD */
471
472#endif /* _EFI_LOADER_H */