]> git.ipfire.org Git - thirdparty/u-boot.git/blame - include/efi_loader.h
efi_loader: move efi_query_variable_info()
[thirdparty/u-boot.git] / include / efi_loader.h
CommitLineData
f739fcd8 1/* SPDX-License-Identifier: GPL-2.0+ */
cb149c66
AG
2/*
3 * EFI application loader
4 *
5 * Copyright (c) 2016 Alexander Graf
cb149c66
AG
6 */
7
cd9e18de
HS
8#ifndef _EFI_LOADER_H
9#define _EFI_LOADER_H 1
10
bee91169 11#include <common.h>
cb149c66
AG
12#include <part_efi.h>
13#include <efi_api.h>
bee91169
AG
14
15/* No need for efi loader support in SPL */
9b5e6396 16#if CONFIG_IS_ENABLED(EFI_LOADER)
bee91169 17
cb149c66
AG
18#include <linux/list.h>
19
4182a129
HS
20/* Maximum number of configuration tables */
21#define EFI_MAX_CONFIGURATION_TABLES 16
22
4e6b5d65
HS
23/* 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
a2a4bc3b
AT
28/* Root node */
29extern efi_handle_t efi_root;
30
c160d2f5
RC
31int __efi_entry_check(void);
32int __efi_exit_check(void);
ae0bd3a9 33const char *__efi_nesting(void);
af65db85
RC
34const char *__efi_nesting_inc(void);
35const char *__efi_nesting_dec(void);
c160d2f5 36
a095aadf
RC
37/*
38 * Enter the u-boot world from UEFI:
39 */
bee91169 40#define EFI_ENTRY(format, ...) do { \
c160d2f5 41 assert(__efi_entry_check()); \
af65db85
RC
42 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
43 __func__, ##__VA_ARGS__); \
bee91169 44 } while(0)
bee91169 45
a095aadf
RC
46/*
47 * Exit the u-boot world back to UEFI:
48 */
804b1d73 49#define EFI_EXIT(ret) ({ \
c81883df 50 typeof(ret) _r = ret; \
af65db85 51 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
c81883df 52 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
c160d2f5
RC
53 assert(__efi_exit_check()); \
54 _r; \
804b1d73 55 })
bee91169 56
a095aadf 57/*
ea630ce9 58 * Call non-void UEFI function from u-boot and retrieve return value:
a095aadf 59 */
ea630ce9
HS
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:
72 */
73#define EFI_CALL_VOID(exp) do { \
af65db85 74 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
c160d2f5 75 assert(__efi_exit_check()); \
a095aadf 76 exp; \
c160d2f5 77 assert(__efi_entry_check()); \
af65db85 78 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
a095aadf
RC
79 } while(0)
80
ae0bd3a9 81/*
d5504144 82 * Write an indented message with EFI prefix
ae0bd3a9 83 */
d5504144
HS
84#define EFI_PRINT(format, ...) ({ \
85 debug("%sEFI: " format, __efi_nesting(), \
86 ##__VA_ARGS__); \
ae0bd3a9
HS
87 })
88
89aea436
AG
89#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
1fcb7ea2
HS
96/* Key identifying current memory map */
97extern efi_uintn_t efi_memory_map_key;
98
50149ea3 99extern struct efi_runtime_services efi_runtime_services;
bee91169
AG
100extern struct efi_system_table systab;
101
ebb4dd5b 102extern struct efi_simple_text_output_protocol efi_con_out;
3e603ec7 103extern struct efi_simple_text_input_protocol efi_con_in;
ebb4dd5b 104extern struct efi_console_control_protocol efi_console_control;
cc5b7081 105extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
e70f8dfa
LL
106/* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
107extern const struct efi_device_path_utilities_protocol
108 efi_device_path_utilities;
b1b782d3
HS
109/* 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 */
0bc4b0da 113extern const struct efi_unicode_collation_protocol
95ab3816 114 efi_unicode_collation_protocol2;
cb728e51
AT
115extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
116extern const struct efi_hii_config_access_protocol efi_hii_config_access;
c9bfb222
LL
117extern const struct efi_hii_database_protocol efi_hii_database;
118extern const struct efi_hii_string_protocol efi_hii_string;
c1311ad4 119
adae4313
RC
120uint16_t *efi_dp_str(struct efi_device_path *dp);
121
4e6b5d65
HS
122/* GUID of the U-Boot root node */
123extern const efi_guid_t efi_u_boot_guid;
b3dd14b6
HS
124/* GUID of the EFI_BLOCK_IO_PROTOCOL */
125extern const efi_guid_t efi_block_io_guid;
9975fe96 126extern const efi_guid_t efi_global_variable_guid;
c1311ad4 127extern const efi_guid_t efi_guid_console_control;
cb149c66 128extern const efi_guid_t efi_guid_device_path;
f0959dbe
HS
129/* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
130extern const efi_guid_t efi_guid_driver_binding_protocol;
a3a28f5f
HS
131/* 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;
bc4f9133
HS
141/* GUID of the device tree table */
142extern const efi_guid_t efi_guid_fdt;
cb149c66 143extern const efi_guid_t efi_guid_loaded_image;
bc8fc328 144extern const efi_guid_t efi_guid_loaded_image_device_path;
cc5b7081 145extern const efi_guid_t efi_guid_device_path_to_text_protocol;
2a92080d
RC
146extern const efi_guid_t efi_simple_file_system_protocol_guid;
147extern const efi_guid_t efi_file_info_guid;
9e6835e6
HS
148/* GUID for file system information */
149extern const efi_guid_t efi_file_system_info_guid;
e70f8dfa 150extern const efi_guid_t efi_guid_device_path_utilities_protocol;
b1b782d3
HS
151/* GUID of the deprecated Unicode collation protocol */
152extern const efi_guid_t efi_guid_unicode_collation_protocol;
0bc4b0da 153/* GUID of the Unicode collation protocol */
95ab3816 154extern const efi_guid_t efi_guid_unicode_collation_protocol2;
cb728e51
AT
155extern const efi_guid_t efi_guid_hii_config_routing_protocol;
156extern const efi_guid_t efi_guid_hii_config_access_protocol;
c9bfb222
LL
157extern const efi_guid_t efi_guid_hii_database_protocol;
158extern const efi_guid_t efi_guid_hii_string_protocol;
cb149c66 159
50149ea3
AG
160extern unsigned int __efi_runtime_start, __efi_runtime_stop;
161extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
162
1f1075c6
HS
163/**
164 * struct efi_open_protocol_info_item - open protocol info item
165 *
fe1599da
HS
166 * When a protocol is opened a open protocol info entry is created.
167 * These are maintained in a list.
1f1075c6
HS
168 *
169 * @link: link to the list of open protocol info entries of a protocol
170 * @info: information about the opening of a protocol
fe1599da
HS
171 */
172struct efi_open_protocol_info_item {
fe1599da
HS
173 struct list_head link;
174 struct efi_open_protocol_info_entry info;
175};
176
1f1075c6
HS
177/**
178 * struct efi_handler - single protocol interface of a handle
179 *
bee91169
AG
180 * 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
fe1599da 182 * protocol GUID to the respective protocol interface
1f1075c6
HS
183 *
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
fe1599da 188 */
bee91169 189struct efi_handler {
69fb6b1a 190 struct list_head link;
bee91169 191 const efi_guid_t *guid;
b5349f74 192 void *protocol_interface;
fe1599da 193 struct list_head open_infos;
bee91169
AG
194};
195
cd73aba6
HS
196/**
197 * 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,
84a918e8 204 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
cd73aba6
HS
205 EFI_OBJECT_TYPE_LOADED_IMAGE,
206 EFI_OBJECT_TYPE_STARTED_IMAGE,
207};
208
fae0118e
HS
209/**
210 * 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.
bee91169 222 *
fae0118e
HS
223 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
224 * has been created for such pointers.
bee91169
AG
225 */
226struct efi_object {
227 /* Every UEFI object is part of a global object list */
228 struct list_head link;
69fb6b1a
HS
229 /* The list of protocols */
230 struct list_head protocols;
cd73aba6 231 enum efi_object_type type;
bee91169
AG
232};
233
c982874e
HS
234/**
235 * struct efi_loaded_image_obj - handle of a loaded image
d39646a3
HS
236 *
237 * @header: EFI object header
556d8dc9
HS
238 * @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()
d39646a3
HS
241 * @exit_jmp: long jump buffer for returning form started image
242 * @entry: entry address of the relocated image
c982874e
HS
243 */
244struct efi_loaded_image_obj {
d39646a3 245 struct efi_object header;
c982874e 246 efi_status_t exit_status;
556d8dc9
HS
247 efi_uintn_t *exit_data_size;
248 u16 **exit_data;
c982874e
HS
249 struct jmp_buf_data exit_jmp;
250 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
251 struct efi_system_table *st);
126a43f1 252 u16 image_type;
c982874e
HS
253};
254
c6841592
HS
255/**
256 * struct efi_event
257 *
43bce442 258 * @link: Link to list of all events
7a69e97b 259 * @queue_link: Link to the list of queued events
c6841592
HS
260 * @type: Type of event, see efi_create_event
261 * @notify_tpl: Task priority level of notifications
c6841592
HS
262 * @nofify_function: Function to call when the event is triggered
263 * @notify_context: Data to be passed to the notify function
b095f3c8 264 * @group: Event group
43bce442
HS
265 * @trigger_time: Period of the timer
266 * @trigger_next: Next time to trigger the timer
c6841592 267 * @trigger_type: Type of timer, see efi_set_timer
43bce442 268 * @is_signaled: The event occurred. The event is in the signaled state.
c6841592
HS
269 */
270struct efi_event {
43bce442 271 struct list_head link;
7a69e97b 272 struct list_head queue_link;
b521d29e 273 uint32_t type;
152cade3 274 efi_uintn_t notify_tpl;
c6841592
HS
275 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
276 void *notify_context;
b095f3c8 277 const efi_guid_t *group;
c6841592
HS
278 u64 trigger_next;
279 u64 trigger_time;
b521d29e 280 enum efi_timer_delay trigger_type;
e190e897 281 bool is_signaled;
c6841592
HS
282};
283
bee91169
AG
284/* This list contains all UEFI objects we know of */
285extern struct list_head efi_obj_list;
b095f3c8
HS
286/* List of all events */
287extern struct list_head efi_events;
bee91169 288
f09cea36
HS
289/**
290 * 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
ab15d414
HS
304/**
305 * efi_register_notify_event - event registered by RegisterProtocolNotify()
306 *
307 * The address of this structure serves as registration value.
308 *
f09cea36
HS
309 * @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
ab15d414
HS
315 */
316struct efi_register_notify_event {
317 struct list_head link;
318 struct efi_event *event;
319 efi_guid_t protocol;
f09cea36 320 struct list_head handles;
ab15d414
HS
321};
322
323/* List of all events registered by RegisterProtocolNotify() */
324extern struct list_head efi_register_notify_events;
325
056b45bc
AT
326/* Initialize efi execution environment */
327efi_status_t efi_init_obj_list(void);
4e6b5d65
HS
328/* Called by bootefi to initialize root node */
329efi_status_t efi_root_node_register(void);
640adadf
HS
330/* Called by bootefi to initialize runtime */
331efi_status_t efi_initialize_system_table(void);
91be9a77 332/* Called by bootefi to make console interface available */
6f566c23 333efi_status_t efi_console_register(void);
2a22d05d 334/* Called by bootefi to make all disk storage accessible as EFI objects */
df9cf561 335efi_status_t efi_disk_register(void);
64e4db0f
HS
336/* 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);
be8d3241 340/* Called by bootefi to make GOP (graphical) interface available */
80ea9b09 341efi_status_t efi_gop_register(void);
0efe1bcf 342/* Called by bootefi to make the network interface available */
075d425d 343efi_status_t efi_net_register(void);
b3d60900 344/* Called by bootefi to make the watchdog available */
d7b181d5 345efi_status_t efi_watchdog_register(void);
e663b350 346/* Called by bootefi to make SMBIOS tables available */
86df34d4
BM
347/**
348 * 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);
0864c565
SG
355/**
356 * 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 */
7657152b 362efi_status_t efi_smbios_register(void);
0efe1bcf 363
2a92080d
RC
364struct efi_simple_file_system_protocol *
365efi_fs_from_path(struct efi_device_path *fp);
366
0efe1bcf
AG
367/* Called by networking code to memorize the dhcp ack package */
368void efi_net_set_dhcp_ack(void *pkt, int len);
b3d60900
HS
369/* Called by efi_set_watchdog_timer to reset the timer */
370efi_status_t efi_set_watchdog(unsigned long timeout);
0efe1bcf 371
bee91169
AG
372/* Called from places to check whether a timer expired */
373void efi_timer_check(void);
374/* PE loader implementation */
8f7e2b29
HS
375efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle, void *efi,
376 struct efi_loaded_image *loaded_image_info);
bee91169
AG
377/* Called once to store the pristine gd pointer */
378void efi_save_gd(void);
c160d2f5
RC
379/* Special case handler for error/abort that just tries to dtrt to get
380 * back to u-boot world */
bee91169 381void efi_restore_gd(void);
50149ea3
AG
382/* Call this to relocate the runtime section to an address space */
383void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
0f4060eb 384/* Call this to set the current device name */
c07ad7c0 385void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
44549d62 386/* Add a new object to the object list. */
fae0118e 387void efi_add_handle(efi_handle_t obj);
2edab5e2 388/* Create handle */
2074f700 389efi_status_t efi_create_handle(efi_handle_t *handle);
678e03a0 390/* Delete handle */
fae0118e 391void efi_delete_handle(efi_handle_t obj);
1b68153a 392/* Call this to validate a handle and find the EFI object for it */
2074f700 393struct efi_object *efi_search_obj(const efi_handle_t handle);
d7e0b010
AT
394/* 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);
f69d63fa
HS
401/* 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);
d7e0b010
AT
405/* Unload image */
406efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
3f79a2b5 407/* Find a protocol on a handle */
2074f700 408efi_status_t efi_search_protocol(const efi_handle_t handle,
3f79a2b5
HS
409 const efi_guid_t *protocol_guid,
410 struct efi_handler **handler);
411/* Install new protocol on a handle */
2074f700
HS
412efi_status_t efi_add_protocol(const efi_handle_t handle,
413 const efi_guid_t *protocol,
3f79a2b5
HS
414 void *protocol_interface);
415/* Delete protocol from a handle */
2074f700
HS
416efi_status_t efi_remove_protocol(const efi_handle_t handle,
417 const efi_guid_t *protocol,
3f79a2b5
HS
418 void *protocol_interface);
419/* Delete all protocols from a handle */
2074f700 420efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
7657ae12
HS
421/* Install multiple protocol interfaces */
422efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
423 (efi_handle_t *handle, ...);
49deb455 424/* Call this to create an event */
152cade3 425efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
49deb455
HS
426 void (EFIAPI *notify_function) (
427 struct efi_event *event,
428 void *context),
b095f3c8
HS
429 void *notify_context, efi_guid_t *group,
430 struct efi_event **event);
bfc72462 431/* Call this to set a timer */
b521d29e 432efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
bfc72462 433 uint64_t trigger_time);
91be9a77 434/* Call this to signal an event */
7eaa900e 435void efi_signal_event(struct efi_event *event);
50149ea3 436
2a92080d
RC
437/* 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
c3772ca1
HS
444/**
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)
5d00995c
AG
454/* 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 */
f5a2a938 457efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
5d00995c 458 uint64_t *memory);
b61d857b 459/* EFI memory free function. */
f5a2a938 460efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
ead1274b 461/* EFI memory allocator for small allocations */
f5a2a938 462efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
ead1274b 463 void **buffer);
42417bc8
SB
464/* EFI pool memory free function. */
465efi_status_t efi_free_pool(void *buffer);
5d00995c 466/* Returns the EFI memory map */
f5a2a938 467efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
5d00995c 468 struct efi_mem_desc *memory_map,
f5a2a938
HS
469 efi_uintn_t *map_key,
470 efi_uintn_t *descriptor_size,
5d00995c
AG
471 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);
05ef48a2 475/* Called by board init to initialize the EFI drivers */
038782a2 476efi_status_t efi_driver_init(void);
5d00995c
AG
477/* Called by board init to initialize the EFI memory map */
478int efi_memory_init(void);
488bf12d
AG
479/* 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);
56d92888 481/* Sets up a loaded image */
c982874e
HS
482efi_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);
c9a63f44
HS
486/* Print information about all loaded images */
487void efi_print_image_infos(void *pc);
5d00995c 488
51735ae0
AG
489#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
490extern void *efi_bounce_buffer;
491#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
492#endif
493
b66c60dd
RC
494
495struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
ff401d3f
HS
496int efi_dp_match(const struct efi_device_path *a,
497 const struct efi_device_path *b);
b66c60dd
RC
498struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
499 struct efi_device_path **rem);
f6dd3f35
HS
500/* 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);
b66c60dd
RC
504struct 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);
211314c1
HS
509/* 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);
3acef5da
HS
513/* 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);
b66c60dd
RC
522
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);
98d48bdf
HS
525/* Create a device node for a block device partition. */
526struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
b66c60dd
RC
527struct 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);
bf19273e
RC
530struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
531 uint64_t start_address,
532 uint64_t end_address);
65436f91
HS
533/* 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);
04298686
HS
536efi_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);
f1589ffb
AT
539efi_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);
b66c60dd
RC
543
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
9d08f6db
HS
548/**
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 */
487d756f 557static inline void ascii2unicode(u16 *unicode, const char *ascii)
0f4060eb
AG
558{
559 while (*ascii)
560 *(unicode++) = *(ascii++);
c412166d 561 *unicode = 0;
0f4060eb
AG
562}
563
3e094c59
RC
564static 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
50149ea3
AG
569/*
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 */
7e21fbca
AG
573#define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
574#define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
bee91169 575
e771b4b3
AT
576/* Indicate supported runtime services */
577efi_status_t efi_init_runtime_supported(void);
578
a39f39cd
HS
579/* Update CRC32 in table header */
580void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
581
80a4800e
AG
582/* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
583 * to make it available at runtime */
22c793e6 584efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
80a4800e
AG
585
586/* Boards may provide the functions below to implement RTS functionality */
587
3c63db9c 588void __efi_runtime EFIAPI efi_reset_system(
80a4800e
AG
589 enum efi_reset_type reset_type,
590 efi_status_t reset_status,
591 unsigned long data_size, void *reset_data);
22c793e6
HS
592
593/* Architecture specific initialization of the EFI subsystem */
594efi_status_t efi_reset_system_init(void);
80a4800e 595
3c63db9c 596efi_status_t __efi_runtime EFIAPI efi_get_time(
80a4800e
AG
597 struct efi_time *time,
598 struct efi_time_cap *capabilities);
80a4800e 599
656f1710
HS
600efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
601
623b3a57
HS
602#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
0bda81bf
HS
611efi_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);
45c66f9c
HS
614efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
615 u16 *variable_name,
0bda81bf
HS
616 const efi_guid_t *vendor);
617efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
618 const efi_guid_t *vendor, u32 attributes,
452257a3 619 efi_uintn_t data_size, const void *data);
ad644e7c 620
ce43528d
HS
621efi_status_t EFIAPI efi_query_variable_info(
622 u32 attributes, u64 *maximum_variable_storage_size,
623 u64 *remaining_variable_storage_size,
624 u64 *maximum_variable_size);
625
1a82b341
AT
626/*
627 * See section 3.1.3 in the v2.7 UEFI spec for more details on
628 * the layout of EFI_LOAD_OPTION. In short it is:
629 *
630 * typedef struct _EFI_LOAD_OPTION {
631 * UINT32 Attributes;
632 * UINT16 FilePathListLength;
633 * // CHAR16 Description[]; <-- variable length, NULL terminated
634 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
635 * <-- FilePathListLength bytes
636 * // UINT8 OptionalData[];
637 * } EFI_LOAD_OPTION;
638 */
639struct efi_load_option {
640 u32 attributes;
641 u16 file_path_length;
642 u16 *label;
643 struct efi_device_path *file_path;
39a1ff8c 644 const u8 *optional_data;
1a82b341
AT
645};
646
647void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
648unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
6b95b38c 649efi_status_t efi_bootmgr_load(efi_handle_t *handle);
9975fe96 650
9b5e6396 651#else /* CONFIG_IS_ENABLED(EFI_LOADER) */
bee91169 652
50149ea3 653/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
3c63db9c
AG
654#define __efi_runtime_data
655#define __efi_runtime
22c793e6
HS
656static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
657{
658 return EFI_SUCCESS;
659}
50149ea3 660
bee91169
AG
661/* No loader configured, stub out EFI_ENTRY */
662static inline void efi_restore_gd(void) { }
c07ad7c0
AG
663static inline void efi_set_bootdev(const char *dev, const char *devnr,
664 const char *path) { }
0efe1bcf 665static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
c9a63f44 666static inline void efi_print_image_infos(void *pc) { }
bee91169 667
9b5e6396 668#endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
cd9e18de
HS
669
670#endif /* _EFI_LOADER_H */