Merge branch 'master' of https://gitlab.denx.de/u-boot/custodians/u-boot-sunxi
[platform/kernel/u-boot.git] / include / efi_loader.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  *  EFI application loader
4  *
5  *  Copyright (c) 2016 Alexander Graf
6  */
7
8 #ifndef _EFI_LOADER_H
9 #define _EFI_LOADER_H 1
10
11 #include <common.h>
12 #include <part_efi.h>
13 #include <efi_api.h>
14
15 static inline int guidcmp(const void *g1, const void *g2)
16 {
17         return memcmp(g1, g2, sizeof(efi_guid_t));
18 }
19
20 static inline void *guidcpy(void *dst, const void *src)
21 {
22         return memcpy(dst, src, sizeof(efi_guid_t));
23 }
24
25 /* No need for efi loader support in SPL */
26 #if CONFIG_IS_ENABLED(EFI_LOADER)
27
28 #include <linux/list.h>
29
30 /* Maximum number of configuration tables */
31 #define EFI_MAX_CONFIGURATION_TABLES 16
32
33 /* GUID used by the root node */
34 #define U_BOOT_GUID \
35         EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
36                  0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
37 /* GUID used as host device on sandbox */
38 #define U_BOOT_HOST_DEV_GUID \
39         EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
40                  0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
41
42 /* Use internal device tree when starting UEFI application */
43 #define EFI_FDT_USE_INTERNAL NULL
44
45 /* Root node */
46 extern efi_handle_t efi_root;
47
48 int __efi_entry_check(void);
49 int __efi_exit_check(void);
50 const char *__efi_nesting(void);
51 const char *__efi_nesting_inc(void);
52 const char *__efi_nesting_dec(void);
53
54 /*
55  * Enter the u-boot world from UEFI:
56  */
57 #define EFI_ENTRY(format, ...) do { \
58         assert(__efi_entry_check()); \
59         debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
60                 __func__, ##__VA_ARGS__); \
61         } while(0)
62
63 /*
64  * Exit the u-boot world back to UEFI:
65  */
66 #define EFI_EXIT(ret) ({ \
67         typeof(ret) _r = ret; \
68         debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
69                 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
70         assert(__efi_exit_check()); \
71         _r; \
72         })
73
74 /*
75  * Call non-void UEFI function from u-boot and retrieve return value:
76  */
77 #define EFI_CALL(exp) ({ \
78         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
79         assert(__efi_exit_check()); \
80         typeof(exp) _r = exp; \
81         assert(__efi_entry_check()); \
82         debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
83               (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
84         _r; \
85 })
86
87 /*
88  * Call void UEFI function from u-boot:
89  */
90 #define EFI_CALL_VOID(exp) do { \
91         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
92         assert(__efi_exit_check()); \
93         exp; \
94         assert(__efi_entry_check()); \
95         debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
96         } while(0)
97
98 /*
99  * Write an indented message with EFI prefix
100  */
101 #define EFI_PRINT(format, ...) ({ \
102         debug("%sEFI: " format, __efi_nesting(), \
103                 ##__VA_ARGS__); \
104         })
105
106 #ifdef CONFIG_SYS_CACHELINE_SIZE
107 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
108 #else
109 /* Just use the greatest cache flush alignment requirement I'm aware of */
110 #define EFI_CACHELINE_SIZE 128
111 #endif
112
113 /* Key identifying current memory map */
114 extern efi_uintn_t efi_memory_map_key;
115
116 extern struct efi_runtime_services efi_runtime_services;
117 extern struct efi_system_table systab;
118
119 extern struct efi_simple_text_output_protocol efi_con_out;
120 extern struct efi_simple_text_input_protocol efi_con_in;
121 extern struct efi_console_control_protocol efi_console_control;
122 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
123 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
124 extern const struct efi_device_path_utilities_protocol
125                                         efi_device_path_utilities;
126 /* deprecated version of the EFI_UNICODE_COLLATION_PROTOCOL */
127 extern const struct efi_unicode_collation_protocol
128                                         efi_unicode_collation_protocol;
129 /* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
130 extern const struct efi_unicode_collation_protocol
131                                         efi_unicode_collation_protocol2;
132 extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
133 extern const struct efi_hii_config_access_protocol efi_hii_config_access;
134 extern const struct efi_hii_database_protocol efi_hii_database;
135 extern const struct efi_hii_string_protocol efi_hii_string;
136 extern const struct efi_rng_protocol efi_rng_protocol;
137
138 uint16_t *efi_dp_str(struct efi_device_path *dp);
139
140 /* GUID of the U-Boot root node */
141 extern const efi_guid_t efi_u_boot_guid;
142 #ifdef CONFIG_SANDBOX
143 /* GUID of U-Boot host device on sandbox */
144 extern const efi_guid_t efi_guid_host_dev;
145 #endif
146 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
147 extern const efi_guid_t efi_block_io_guid;
148 extern const efi_guid_t efi_global_variable_guid;
149 extern const efi_guid_t efi_guid_console_control;
150 extern const efi_guid_t efi_guid_device_path;
151 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
152 extern const efi_guid_t efi_guid_driver_binding_protocol;
153 /* event group ExitBootServices() invoked */
154 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
155 /* event group SetVirtualAddressMap() invoked */
156 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
157 /* event group memory map changed */
158 extern const efi_guid_t efi_guid_event_group_memory_map_change;
159 /* event group boot manager about to boot */
160 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
161 /* event group ResetSystem() invoked (before ExitBootServices) */
162 extern const efi_guid_t efi_guid_event_group_reset_system;
163 /* GUID of the device tree table */
164 extern const efi_guid_t efi_guid_fdt;
165 extern const efi_guid_t efi_guid_loaded_image;
166 extern const efi_guid_t efi_guid_loaded_image_device_path;
167 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
168 extern const efi_guid_t efi_simple_file_system_protocol_guid;
169 extern const efi_guid_t efi_file_info_guid;
170 /* GUID for file system information */
171 extern const efi_guid_t efi_file_system_info_guid;
172 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
173 /* GUID of the deprecated Unicode collation protocol */
174 extern const efi_guid_t efi_guid_unicode_collation_protocol;
175 /* GUID of the Unicode collation protocol */
176 extern const efi_guid_t efi_guid_unicode_collation_protocol2;
177 extern const efi_guid_t efi_guid_hii_config_routing_protocol;
178 extern const efi_guid_t efi_guid_hii_config_access_protocol;
179 extern const efi_guid_t efi_guid_hii_database_protocol;
180 extern const efi_guid_t efi_guid_hii_string_protocol;
181
182 /* GUID of RNG protocol */
183 extern const efi_guid_t efi_guid_rng_protocol;
184
185 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
186 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
187
188 /**
189  * struct efi_open_protocol_info_item - open protocol info item
190  *
191  * When a protocol is opened a open protocol info entry is created.
192  * These are maintained in a list.
193  *
194  * @link:       link to the list of open protocol info entries of a protocol
195  * @info:       information about the opening of a protocol
196  */
197 struct efi_open_protocol_info_item {
198         struct list_head link;
199         struct efi_open_protocol_info_entry info;
200 };
201
202 /**
203  * struct efi_handler - single protocol interface of a handle
204  *
205  * When the UEFI payload wants to open a protocol on an object to get its
206  * interface (usually a struct with callback functions), this struct maps the
207  * protocol GUID to the respective protocol interface
208  *
209  * @link:               link to the list of protocols of a handle
210  * @guid:               GUID of the protocol
211  * @protocol_interface: protocol interface
212  * @open_infos          link to the list of open protocol info items
213  */
214 struct efi_handler {
215         struct list_head link;
216         const efi_guid_t *guid;
217         void *protocol_interface;
218         struct list_head open_infos;
219 };
220
221 /**
222  * enum efi_object_type - type of EFI object
223  *
224  * In UnloadImage we must be able to identify if the handle relates to a
225  * started image.
226  */
227 enum efi_object_type {
228         EFI_OBJECT_TYPE_UNDEFINED = 0,
229         EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
230         EFI_OBJECT_TYPE_LOADED_IMAGE,
231         EFI_OBJECT_TYPE_STARTED_IMAGE,
232 };
233
234 /**
235  * struct efi_object - dereferenced EFI handle
236  *
237  * @link:       pointers to put the handle into a linked list
238  * @protocols:  linked list with the protocol interfaces installed on this
239  *              handle
240  *
241  * UEFI offers a flexible and expandable object model. The objects in the UEFI
242  * API are devices, drivers, and loaded images. struct efi_object is our storage
243  * structure for these objects.
244  *
245  * When including this structure into a larger structure always put it first so
246  * that when deleting a handle the whole encompassing structure can be freed.
247  *
248  * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
249  * has been created for such pointers.
250  */
251 struct efi_object {
252         /* Every UEFI object is part of a global object list */
253         struct list_head link;
254         /* The list of protocols */
255         struct list_head protocols;
256         enum efi_object_type type;
257 };
258
259 /**
260  * struct efi_loaded_image_obj - handle of a loaded image
261  *
262  * @header:             EFI object header
263  * @exit_status:        exit status passed to Exit()
264  * @exit_data_size:     exit data size passed to Exit()
265  * @exit_data:          exit data passed to Exit()
266  * @exit_jmp:           long jump buffer for returning form started image
267  * @entry:              entry address of the relocated image
268  */
269 struct efi_loaded_image_obj {
270         struct efi_object header;
271         efi_status_t exit_status;
272         efi_uintn_t *exit_data_size;
273         u16 **exit_data;
274         struct jmp_buf_data exit_jmp;
275         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
276                                      struct efi_system_table *st);
277         u16 image_type;
278 };
279
280 /**
281  * struct efi_event
282  *
283  * @link:               Link to list of all events
284  * @queue_link:         Link to the list of queued events
285  * @type:               Type of event, see efi_create_event
286  * @notify_tpl:         Task priority level of notifications
287  * @nofify_function:    Function to call when the event is triggered
288  * @notify_context:     Data to be passed to the notify function
289  * @group:              Event group
290  * @trigger_time:       Period of the timer
291  * @trigger_next:       Next time to trigger the timer
292  * @trigger_type:       Type of timer, see efi_set_timer
293  * @is_signaled:        The event occurred. The event is in the signaled state.
294  */
295 struct efi_event {
296         struct list_head link;
297         struct list_head queue_link;
298         uint32_t type;
299         efi_uintn_t notify_tpl;
300         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
301         void *notify_context;
302         const efi_guid_t *group;
303         u64 trigger_next;
304         u64 trigger_time;
305         enum efi_timer_delay trigger_type;
306         bool is_signaled;
307 };
308
309 /* This list contains all UEFI objects we know of */
310 extern struct list_head efi_obj_list;
311 /* List of all events */
312 extern struct list_head efi_events;
313
314 /**
315  * struct efi_protocol_notification - handle for notified protocol
316  *
317  * When a protocol interface is installed for which an event was registered with
318  * the RegisterProtocolNotify() service this structure is used to hold the
319  * handle on which the protocol interface was installed.
320  *
321  * @link:       link to list of all handles notified for this event
322  * @handle:     handle on which the notified protocol interface was installed
323  */
324 struct efi_protocol_notification {
325         struct list_head link;
326         efi_handle_t handle;
327 };
328
329 /**
330  * efi_register_notify_event - event registered by RegisterProtocolNotify()
331  *
332  * The address of this structure serves as registration value.
333  *
334  * @link:       link to list of all registered events
335  * @event:      registered event. The same event may registered for multiple
336  *              GUIDs.
337  * @protocol:   protocol for which the event is registered
338  * @handles:    linked list of all handles on which the notified protocol was
339  *              installed
340  */
341 struct efi_register_notify_event {
342         struct list_head link;
343         struct efi_event *event;
344         efi_guid_t protocol;
345         struct list_head handles;
346 };
347
348 /* List of all events registered by RegisterProtocolNotify() */
349 extern struct list_head efi_register_notify_events;
350
351 /* Initialize efi execution environment */
352 efi_status_t efi_init_obj_list(void);
353 /* Install device tree */
354 efi_status_t efi_install_fdt(void *fdt);
355 /* Run loaded UEFI image */
356 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
357 /* Initialize variable services */
358 efi_status_t efi_init_variables(void);
359 /* Notify ExitBootServices() is called */
360 void efi_variables_boot_exit_notify(void);
361 /* Called by bootefi to initialize root node */
362 efi_status_t efi_root_node_register(void);
363 /* Called by bootefi to initialize runtime */
364 efi_status_t efi_initialize_system_table(void);
365 /* efi_runtime_detach() - detach unimplemented runtime functions */
366 void efi_runtime_detach(void);
367 /* Called by bootefi to make console interface available */
368 efi_status_t efi_console_register(void);
369 /* Called by bootefi to make all disk storage accessible as EFI objects */
370 efi_status_t efi_disk_register(void);
371 /* Create handles and protocols for the partitions of a block device */
372 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
373                                const char *if_typename, int diskid,
374                                const char *pdevname);
375 /* Called by bootefi to make GOP (graphical) interface available */
376 efi_status_t efi_gop_register(void);
377 /* Called by bootefi to make the network interface available */
378 efi_status_t efi_net_register(void);
379 /* Called by bootefi to make the watchdog available */
380 efi_status_t efi_watchdog_register(void);
381 efi_status_t efi_initrd_register(void);
382 /* Called by bootefi to make SMBIOS tables available */
383 /**
384  * efi_acpi_register() - write out ACPI tables
385  *
386  * Called by bootefi to make ACPI tables available
387  *
388  * @return 0 if OK, -ENOMEM if no memory is available for the tables
389  */
390 efi_status_t efi_acpi_register(void);
391 /**
392  * efi_smbios_register() - write out SMBIOS tables
393  *
394  * Called by bootefi to make SMBIOS tables available
395  *
396  * @return 0 if OK, -ENOMEM if no memory is available for the tables
397  */
398 efi_status_t efi_smbios_register(void);
399
400 struct efi_simple_file_system_protocol *
401 efi_fs_from_path(struct efi_device_path *fp);
402
403 /* Called by networking code to memorize the dhcp ack package */
404 void efi_net_set_dhcp_ack(void *pkt, int len);
405 /* Called by efi_set_watchdog_timer to reset the timer */
406 efi_status_t efi_set_watchdog(unsigned long timeout);
407
408 /* Called from places to check whether a timer expired */
409 void efi_timer_check(void);
410 /* PE loader implementation */
411 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle, void *efi,
412                          struct efi_loaded_image *loaded_image_info);
413 /* Called once to store the pristine gd pointer */
414 void efi_save_gd(void);
415 /* Special case handler for error/abort that just tries to dtrt to get
416  * back to u-boot world */
417 void efi_restore_gd(void);
418 /* Call this to relocate the runtime section to an address space */
419 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
420 /* Call this to set the current device name */
421 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
422 /* Add a new object to the object list. */
423 void efi_add_handle(efi_handle_t obj);
424 /* Create handle */
425 efi_status_t efi_create_handle(efi_handle_t *handle);
426 /* Delete handle */
427 void efi_delete_handle(efi_handle_t obj);
428 /* Call this to validate a handle and find the EFI object for it */
429 struct efi_object *efi_search_obj(const efi_handle_t handle);
430 /* Load image */
431 efi_status_t EFIAPI efi_load_image(bool boot_policy,
432                                    efi_handle_t parent_image,
433                                    struct efi_device_path *file_path,
434                                    void *source_buffer,
435                                    efi_uintn_t source_size,
436                                    efi_handle_t *image_handle);
437 /* Start image */
438 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
439                                     efi_uintn_t *exit_data_size,
440                                     u16 **exit_data);
441 /* Unload image */
442 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
443 /* Find a protocol on a handle */
444 efi_status_t efi_search_protocol(const efi_handle_t handle,
445                                  const efi_guid_t *protocol_guid,
446                                  struct efi_handler **handler);
447 /* Install new protocol on a handle */
448 efi_status_t efi_add_protocol(const efi_handle_t handle,
449                               const efi_guid_t *protocol,
450                               void *protocol_interface);
451 /* Delete protocol from a handle */
452 efi_status_t efi_remove_protocol(const efi_handle_t handle,
453                                  const efi_guid_t *protocol,
454                                  void *protocol_interface);
455 /* Delete all protocols from a handle */
456 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
457 /* Install multiple protocol interfaces */
458 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
459                                 (efi_handle_t *handle, ...);
460 /* Get handles that support a given protocol */
461 efi_status_t EFIAPI efi_locate_handle_buffer(
462                         enum efi_locate_search_type search_type,
463                         const efi_guid_t *protocol, void *search_key,
464                         efi_uintn_t *no_handles, efi_handle_t **buffer);
465 /* Close an previously opened protocol interface */
466 efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
467                                        const efi_guid_t *protocol,
468                                        efi_handle_t agent_handle,
469                                        efi_handle_t controller_handle);
470 /* Open a protocol interface */
471 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
472                                         const efi_guid_t *protocol,
473                                         void **protocol_interface);
474 /* Call this to create an event */
475 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
476                               void (EFIAPI *notify_function) (
477                                         struct efi_event *event,
478                                         void *context),
479                               void *notify_context, efi_guid_t *group,
480                               struct efi_event **event);
481 /* Call this to set a timer */
482 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
483                            uint64_t trigger_time);
484 /* Call this to signal an event */
485 void efi_signal_event(struct efi_event *event);
486
487 /* open file system: */
488 struct efi_simple_file_system_protocol *efi_simple_file_system(
489                 struct blk_desc *desc, int part, struct efi_device_path *dp);
490
491 /* open file from device-path: */
492 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
493
494 /**
495  * efi_size_in_pages() - convert size in bytes to size in pages
496  *
497  * This macro returns the number of EFI memory pages required to hold 'size'
498  * bytes.
499  *
500  * @size:       size in bytes
501  * Return:      size in pages
502  */
503 #define efi_size_in_pages(size) ((size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
504 /* Generic EFI memory allocator, call this to get memory */
505 void *efi_alloc(uint64_t len, int memory_type);
506 /* More specific EFI memory allocator, called by EFI payloads */
507 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
508                                 uint64_t *memory);
509 /* EFI memory free function. */
510 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
511 /* EFI memory allocator for small allocations */
512 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
513                                void **buffer);
514 /* EFI pool memory free function. */
515 efi_status_t efi_free_pool(void *buffer);
516 /* Returns the EFI memory map */
517 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
518                                 struct efi_mem_desc *memory_map,
519                                 efi_uintn_t *map_key,
520                                 efi_uintn_t *descriptor_size,
521                                 uint32_t *descriptor_version);
522 /* Adds a range into the EFI memory map */
523 efi_status_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
524                                 bool overlap_only_ram);
525 /* Adds a conventional range into the EFI memory map */
526 efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
527                                              u64 ram_top);
528
529 /* Called by board init to initialize the EFI drivers */
530 efi_status_t efi_driver_init(void);
531 /* Called by board init to initialize the EFI memory map */
532 int efi_memory_init(void);
533 /* Adds new or overrides configuration table entry to the system table */
534 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
535 /* Sets up a loaded image */
536 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
537                                     struct efi_device_path *file_path,
538                                     struct efi_loaded_image_obj **handle_ptr,
539                                     struct efi_loaded_image **info_ptr);
540 /* Print information about all loaded images */
541 void efi_print_image_infos(void *pc);
542
543 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
544 extern void *efi_bounce_buffer;
545 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
546 #endif
547
548
549 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
550 int efi_dp_match(const struct efi_device_path *a,
551                  const struct efi_device_path *b);
552 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
553                                    struct efi_device_path **rem);
554 /* get size of the first device path instance excluding end node */
555 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
556 /* size of multi-instance device path excluding end node */
557 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
558 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
559 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
560                                       const struct efi_device_path *dp2);
561 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
562                                            const struct efi_device_path *node);
563 /* Create a device path node of given type, sub-type, length */
564 struct efi_device_path *efi_dp_create_device_node(const u8 type,
565                                                   const u8 sub_type,
566                                                   const u16 length);
567 /* Append device path instance */
568 struct efi_device_path *efi_dp_append_instance(
569                 const struct efi_device_path *dp,
570                 const struct efi_device_path *dpi);
571 /* Get next device path instance */
572 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
573                                                  efi_uintn_t *size);
574 /* Check if a device path contains muliple instances */
575 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
576
577 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
578 /* Create a device node for a block device partition. */
579 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
580 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
581                                          const char *path);
582 struct efi_device_path *efi_dp_from_eth(void);
583 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
584                                         uint64_t start_address,
585                                         uint64_t end_address);
586 /* Determine the last device path node that is not the end node. */
587 const struct efi_device_path *efi_dp_last_node(
588                         const struct efi_device_path *dp);
589 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
590                                     struct efi_device_path **device_path,
591                                     struct efi_device_path **file_path);
592 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
593                               const char *path,
594                               struct efi_device_path **device,
595                               struct efi_device_path **file);
596
597 #define EFI_DP_TYPE(_dp, _type, _subtype) \
598         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
599          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
600
601 /*
602  * Use these to indicate that your code / data should go into the EFI runtime
603  * section and thus still be available when the OS is running
604  */
605 #define __efi_runtime_data __attribute__ ((section (".data.efi_runtime")))
606 #define __efi_runtime __attribute__ ((section (".text.efi_runtime")))
607
608 /* Indicate supported runtime services */
609 efi_status_t efi_init_runtime_supported(void);
610
611 /* Update CRC32 in table header */
612 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
613
614 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
615  * to make it available at runtime */
616 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
617
618 /* Boards may provide the functions below to implement RTS functionality */
619
620 void __efi_runtime EFIAPI efi_reset_system(
621                         enum efi_reset_type reset_type,
622                         efi_status_t reset_status,
623                         unsigned long data_size, void *reset_data);
624
625 /* Architecture specific initialization of the EFI subsystem */
626 efi_status_t efi_reset_system_init(void);
627
628 efi_status_t __efi_runtime EFIAPI efi_get_time(
629                         struct efi_time *time,
630                         struct efi_time_cap *capabilities);
631
632 efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
633
634 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
635 /*
636  * Entry point for the tests of the EFI API.
637  * It is called by 'bootefi selftest'
638  */
639 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
640                                  struct efi_system_table *systab);
641 #endif
642
643 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
644                                      const efi_guid_t *vendor, u32 *attributes,
645                                      efi_uintn_t *data_size, void *data);
646 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
647                                                u16 *variable_name,
648                                                efi_guid_t *vendor);
649 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
650                                      const efi_guid_t *vendor, u32 attributes,
651                                      efi_uintn_t data_size, const void *data);
652
653 efi_status_t EFIAPI efi_query_variable_info(
654                         u32 attributes, u64 *maximum_variable_storage_size,
655                         u64 *remaining_variable_storage_size,
656                         u64 *maximum_variable_size);
657
658 /*
659  * See section 3.1.3 in the v2.7 UEFI spec for more details on
660  * the layout of EFI_LOAD_OPTION.  In short it is:
661  *
662  *    typedef struct _EFI_LOAD_OPTION {
663  *        UINT32 Attributes;
664  *        UINT16 FilePathListLength;
665  *        // CHAR16 Description[];   <-- variable length, NULL terminated
666  *        // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
667  *                                               <-- FilePathListLength bytes
668  *        // UINT8 OptionalData[];
669  *    } EFI_LOAD_OPTION;
670  */
671 struct efi_load_option {
672         u32 attributes;
673         u16 file_path_length;
674         u16 *label;
675         struct efi_device_path *file_path;
676         const u8 *optional_data;
677 };
678
679 void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data);
680 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
681 efi_status_t efi_bootmgr_load(efi_handle_t *handle);
682
683 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
684
685 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
686 #define __efi_runtime_data
687 #define __efi_runtime
688 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
689 {
690         return EFI_SUCCESS;
691 }
692
693 /* No loader configured, stub out EFI_ENTRY */
694 static inline void efi_restore_gd(void) { }
695 static inline void efi_set_bootdev(const char *dev, const char *devnr,
696                                    const char *path) { }
697 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
698 static inline void efi_print_image_infos(void *pc) { }
699
700 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
701
702 #endif /* _EFI_LOADER_H */