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