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 <blk.h>
13 #include <log.h>
14 #include <part_efi.h>
15 #include <efi_api.h>
16 #include <image.h>
17 #include <pe.h>
18 #include <linux/list.h>
19 #include <linux/oid_registry.h>
20
21 struct blk_desc;
22 struct jmp_buf_data;
23
guidcmp(const void * g1,const void * g2)24 static inline int guidcmp(const void *g1, const void *g2)
25 {
26 return memcmp(g1, g2, sizeof(efi_guid_t));
27 }
28
guidcpy(void * dst,const void * src)29 static inline void *guidcpy(void *dst, const void *src)
30 {
31 return memcpy(dst, src, sizeof(efi_guid_t));
32 }
33
34 #if CONFIG_IS_ENABLED(EFI_LOADER)
35
36 /**
37 * __efi_runtime_data - declares a non-const variable for EFI runtime section
38 *
39 * This macro indicates that a variable is non-const and should go into the
40 * EFI runtime section, and thus still be available when the OS is running.
41 *
42 * Only use on variables not declared const.
43 *
44 * Example:
45 *
46 * ::
47 *
48 * static __efi_runtime_data my_computed_table[256];
49 */
50 #define __efi_runtime_data __section(".data.efi_runtime")
51
52 /**
53 * __efi_runtime_rodata - declares a read-only variable for EFI runtime section
54 *
55 * This macro indicates that a variable is read-only (const) and should go into
56 * the EFI runtime section, and thus still be available when the OS is running.
57 *
58 * Only use on variables also declared const.
59 *
60 * Example:
61 *
62 * ::
63 *
64 * static const __efi_runtime_rodata my_const_table[] = { 1, 2, 3 };
65 */
66 #define __efi_runtime_rodata __section(".rodata.efi_runtime")
67
68 /**
69 * __efi_runtime - declares a function for EFI runtime section
70 *
71 * This macro indicates that a function should go into the EFI runtime section,
72 * and thus still be available when the OS is running.
73 *
74 * Example:
75 *
76 * ::
77 *
78 * static __efi_runtime compute_my_table(void);
79 */
80 #define __efi_runtime __section(".text.efi_runtime")
81
82 /*
83 * Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
84 * to make it available at runtime
85 */
86 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
87
88 /*
89 * Special case handler for error/abort that just tries to dtrt to get
90 * back to u-boot world
91 */
92 void efi_restore_gd(void);
93 /* Call this to set the current device name */
94 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
95 void *buffer, size_t buffer_size);
96 /* Called by networking code to memorize the dhcp ack package */
97 void efi_net_set_dhcp_ack(void *pkt, int len);
98 /* Print information about all loaded images */
99 void efi_print_image_infos(void *pc);
100
101 /* Hook at initialization */
102 efi_status_t efi_launch_capsules(void);
103
104 #else /* CONFIG_IS_ENABLED(EFI_LOADER) */
105
106 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
107 #define __efi_runtime_data
108 #define __efi_runtime_rodata
109 #define __efi_runtime
efi_add_runtime_mmio(void * mmio_ptr,u64 len)110 static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
111 {
112 return EFI_SUCCESS;
113 }
114
115 /* No loader configured, stub out EFI_ENTRY */
efi_restore_gd(void)116 static inline void efi_restore_gd(void) { }
efi_set_bootdev(const char * dev,const char * devnr,const char * path,void * buffer,size_t buffer_size)117 static inline void efi_set_bootdev(const char *dev, const char *devnr,
118 const char *path, void *buffer,
119 size_t buffer_size) { }
efi_net_set_dhcp_ack(void * pkt,int len)120 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
efi_print_image_infos(void * pc)121 static inline void efi_print_image_infos(void *pc) { }
efi_launch_capsules(void)122 static inline efi_status_t efi_launch_capsules(void)
123 {
124 return EFI_SUCCESS;
125 }
126
127 #endif /* CONFIG_IS_ENABLED(EFI_LOADER) */
128
129 /* Maximum number of configuration tables */
130 #define EFI_MAX_CONFIGURATION_TABLES 16
131
132 /* GUID used by the root node */
133 #define U_BOOT_GUID \
134 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
135 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
136 /* GUID used as host device on sandbox */
137 #define U_BOOT_HOST_DEV_GUID \
138 EFI_GUID(0xbbe4e671, 0x5773, 0x4ea1, \
139 0x9a, 0xab, 0x3a, 0x7d, 0xbf, 0x40, 0xc4, 0x82)
140 /* GUID used as root for virtio devices */
141 #define U_BOOT_VIRTIO_DEV_GUID \
142 EFI_GUID(0x63293792, 0xadf5, 0x9325, \
143 0xb9, 0x9f, 0x4e, 0x0e, 0x45, 0x5c, 0x1b, 0x1e)
144
145 /* Use internal device tree when starting UEFI application */
146 #define EFI_FDT_USE_INTERNAL NULL
147
148 /* Root node */
149 extern efi_handle_t efi_root;
150
151 /* Set to EFI_SUCCESS when initialized */
152 extern efi_status_t efi_obj_list_initialized;
153
154 /* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
155 extern bool efi_st_keep_devices;
156
157 /* EFI system partition */
158 extern struct efi_system_partition {
159 enum if_type if_type;
160 int devnum;
161 u8 part;
162 } efi_system_partition;
163
164 int __efi_entry_check(void);
165 int __efi_exit_check(void);
166 const char *__efi_nesting(void);
167 const char *__efi_nesting_inc(void);
168 const char *__efi_nesting_dec(void);
169
170 /*
171 * Enter the u-boot world from UEFI:
172 */
173 #define EFI_ENTRY(format, ...) do { \
174 assert(__efi_entry_check()); \
175 debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
176 __func__, ##__VA_ARGS__); \
177 } while(0)
178
179 /*
180 * Exit the u-boot world back to UEFI:
181 */
182 #define EFI_EXIT(ret) ({ \
183 typeof(ret) _r = ret; \
184 debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
185 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
186 assert(__efi_exit_check()); \
187 _r; \
188 })
189
190 /*
191 * Call non-void UEFI function from u-boot and retrieve return value:
192 */
193 #define EFI_CALL(exp) ({ \
194 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
195 assert(__efi_exit_check()); \
196 typeof(exp) _r = exp; \
197 assert(__efi_entry_check()); \
198 debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
199 (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
200 _r; \
201 })
202
203 /*
204 * Call void UEFI function from u-boot:
205 */
206 #define EFI_CALL_VOID(exp) do { \
207 debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
208 assert(__efi_exit_check()); \
209 exp; \
210 assert(__efi_entry_check()); \
211 debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
212 } while(0)
213
214 /*
215 * Write an indented message with EFI prefix
216 */
217 #define EFI_PRINT(format, ...) ({ \
218 debug("%sEFI: " format, __efi_nesting(), \
219 ##__VA_ARGS__); \
220 })
221
222 #ifdef CONFIG_SYS_CACHELINE_SIZE
223 #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
224 #else
225 /* Just use the greatest cache flush alignment requirement I'm aware of */
226 #define EFI_CACHELINE_SIZE 128
227 #endif
228
229 /* Key identifying current memory map */
230 extern efi_uintn_t efi_memory_map_key;
231
232 extern struct efi_runtime_services efi_runtime_services;
233 extern struct efi_system_table systab;
234
235 extern struct efi_simple_text_output_protocol efi_con_out;
236 extern struct efi_simple_text_input_protocol efi_con_in;
237 extern struct efi_console_control_protocol efi_console_control;
238 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
239 /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
240 extern const struct efi_device_path_utilities_protocol
241 efi_device_path_utilities;
242 /* current version of the EFI_UNICODE_COLLATION_PROTOCOL */
243 extern const struct efi_unicode_collation_protocol
244 efi_unicode_collation_protocol2;
245 extern const struct efi_hii_config_routing_protocol efi_hii_config_routing;
246 extern const struct efi_hii_config_access_protocol efi_hii_config_access;
247 extern const struct efi_hii_database_protocol efi_hii_database;
248 extern const struct efi_hii_string_protocol efi_hii_string;
249
250 uint16_t *efi_dp_str(struct efi_device_path *dp);
251
252 /* GUID of the U-Boot root node */
253 extern const efi_guid_t efi_u_boot_guid;
254 #ifdef CONFIG_SANDBOX
255 /* GUID of U-Boot host device on sandbox */
256 extern const efi_guid_t efi_guid_host_dev;
257 #endif
258 /* GUID of the EFI_BLOCK_IO_PROTOCOL */
259 extern const efi_guid_t efi_block_io_guid;
260 extern const efi_guid_t efi_global_variable_guid;
261 extern const efi_guid_t efi_guid_console_control;
262 extern const efi_guid_t efi_guid_device_path;
263 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
264 extern const efi_guid_t efi_guid_driver_binding_protocol;
265 /* event group ExitBootServices() invoked */
266 extern const efi_guid_t efi_guid_event_group_exit_boot_services;
267 /* event group SetVirtualAddressMap() invoked */
268 extern const efi_guid_t efi_guid_event_group_virtual_address_change;
269 /* event group memory map changed */
270 extern const efi_guid_t efi_guid_event_group_memory_map_change;
271 /* event group boot manager about to boot */
272 extern const efi_guid_t efi_guid_event_group_ready_to_boot;
273 /* event group ResetSystem() invoked (before ExitBootServices) */
274 extern const efi_guid_t efi_guid_event_group_reset_system;
275 /* GUID of the device tree table */
276 extern const efi_guid_t efi_guid_fdt;
277 extern const efi_guid_t efi_guid_loaded_image;
278 extern const efi_guid_t efi_guid_loaded_image_device_path;
279 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
280 extern const efi_guid_t efi_simple_file_system_protocol_guid;
281 extern const efi_guid_t efi_file_info_guid;
282 /* GUID for file system information */
283 extern const efi_guid_t efi_file_system_info_guid;
284 extern const efi_guid_t efi_guid_device_path_utilities_protocol;
285 /* GUID of the deprecated Unicode collation protocol */
286 extern const efi_guid_t efi_guid_unicode_collation_protocol;
287 /* GUIDs of the Load File and Load File2 protocol */
288 extern const efi_guid_t efi_guid_load_file_protocol;
289 extern const efi_guid_t efi_guid_load_file2_protocol;
290 /* GUID of the Unicode collation protocol */
291 extern const efi_guid_t efi_guid_unicode_collation_protocol2;
292 extern const efi_guid_t efi_guid_hii_config_routing_protocol;
293 extern const efi_guid_t efi_guid_hii_config_access_protocol;
294 extern const efi_guid_t efi_guid_hii_database_protocol;
295 extern const efi_guid_t efi_guid_hii_string_protocol;
296 /* GUIDs for authentication */
297 extern const efi_guid_t efi_guid_image_security_database;
298 extern const efi_guid_t efi_guid_sha256;
299 extern const efi_guid_t efi_guid_cert_x509;
300 extern const efi_guid_t efi_guid_cert_x509_sha256;
301 extern const efi_guid_t efi_guid_cert_type_pkcs7;
302
303 /* GUID of RNG protocol */
304 extern const efi_guid_t efi_guid_rng_protocol;
305 /* GUID of capsule update result */
306 extern const efi_guid_t efi_guid_capsule_report;
307 /* GUID of firmware management protocol */
308 extern const efi_guid_t efi_guid_firmware_management_protocol;
309 /* GUID for the ESRT */
310 extern const efi_guid_t efi_esrt_guid;
311 /* GUID of the SMBIOS table */
312 extern const efi_guid_t smbios_guid;
313
314 extern char __efi_runtime_start[], __efi_runtime_stop[];
315 extern char __efi_runtime_rel_start[], __efi_runtime_rel_stop[];
316
317 /**
318 * struct efi_open_protocol_info_item - open protocol info item
319 *
320 * When a protocol is opened a open protocol info entry is created.
321 * These are maintained in a list.
322 *
323 * @link: link to the list of open protocol info entries of a protocol
324 * @info: information about the opening of a protocol
325 */
326 struct efi_open_protocol_info_item {
327 struct list_head link;
328 struct efi_open_protocol_info_entry info;
329 };
330
331 /**
332 * struct efi_handler - single protocol interface of a handle
333 *
334 * When the UEFI payload wants to open a protocol on an object to get its
335 * interface (usually a struct with callback functions), this struct maps the
336 * protocol GUID to the respective protocol interface
337 *
338 * @link: link to the list of protocols of a handle
339 * @guid: GUID of the protocol
340 * @protocol_interface: protocol interface
341 * @open_infos: link to the list of open protocol info items
342 */
343 struct efi_handler {
344 struct list_head link;
345 const efi_guid_t *guid;
346 void *protocol_interface;
347 struct list_head open_infos;
348 };
349
350 /**
351 * enum efi_object_type - type of EFI object
352 *
353 * In UnloadImage we must be able to identify if the handle relates to a
354 * started image.
355 */
356 enum efi_object_type {
357 /** @EFI_OBJECT_TYPE_UNDEFINED: undefined image type */
358 EFI_OBJECT_TYPE_UNDEFINED = 0,
359 /** @EFI_OBJECT_TYPE_U_BOOT_FIRMWARE: U-Boot firmware */
360 EFI_OBJECT_TYPE_U_BOOT_FIRMWARE,
361 /** @EFI_OBJECT_TYPE_LOADED_IMAGE: loaded image (not started) */
362 EFI_OBJECT_TYPE_LOADED_IMAGE,
363 /** @EFI_OBJECT_TYPE_STARTED_IMAGE: started image */
364 EFI_OBJECT_TYPE_STARTED_IMAGE,
365 };
366
367 /**
368 * struct efi_object - dereferenced EFI handle
369 *
370 * @link: pointers to put the handle into a linked list
371 * @protocols: linked list with the protocol interfaces installed on this
372 * handle
373 * @type: image type if the handle relates to an image
374 *
375 * UEFI offers a flexible and expandable object model. The objects in the UEFI
376 * API are devices, drivers, and loaded images. struct efi_object is our storage
377 * structure for these objects.
378 *
379 * When including this structure into a larger structure always put it first so
380 * that when deleting a handle the whole encompassing structure can be freed.
381 *
382 * A pointer to this structure is referred to as a handle. Typedef efi_handle_t
383 * has been created for such pointers.
384 */
385 struct efi_object {
386 /* Every UEFI object is part of a global object list */
387 struct list_head link;
388 /* The list of protocols */
389 struct list_head protocols;
390 enum efi_object_type type;
391 };
392
393 enum efi_image_auth_status {
394 EFI_IMAGE_AUTH_FAILED = 0,
395 EFI_IMAGE_AUTH_PASSED,
396 };
397
398 /**
399 * struct efi_loaded_image_obj - handle of a loaded image
400 *
401 * @header: EFI object header
402 * @exit_status: exit status passed to Exit()
403 * @exit_data_size: exit data size passed to Exit()
404 * @exit_data: exit data passed to Exit()
405 * @exit_jmp: long jump buffer for returning from started image
406 * @entry: entry address of the relocated image
407 * @image_type: indicates if the image is an applicition or a driver
408 * @auth_status: indicates if the image is authenticated
409 */
410 struct efi_loaded_image_obj {
411 struct efi_object header;
412 efi_status_t *exit_status;
413 efi_uintn_t *exit_data_size;
414 u16 **exit_data;
415 struct jmp_buf_data *exit_jmp;
416 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
417 struct efi_system_table *st);
418 u16 image_type;
419 enum efi_image_auth_status auth_status;
420 };
421
422 /**
423 * struct efi_event
424 *
425 * @link: Link to list of all events
426 * @queue_link: Link to the list of queued events
427 * @type: Type of event, see efi_create_event
428 * @notify_tpl: Task priority level of notifications
429 * @notify_function: Function to call when the event is triggered
430 * @notify_context: Data to be passed to the notify function
431 * @group: Event group
432 * @trigger_time: Period of the timer
433 * @trigger_next: Next time to trigger the timer
434 * @trigger_type: Type of timer, see efi_set_timer
435 * @is_signaled: The event occurred. The event is in the signaled state.
436 */
437 struct efi_event {
438 struct list_head link;
439 struct list_head queue_link;
440 uint32_t type;
441 efi_uintn_t notify_tpl;
442 void (EFIAPI *notify_function)(struct efi_event *event, void *context);
443 void *notify_context;
444 const efi_guid_t *group;
445 u64 trigger_next;
446 u64 trigger_time;
447 enum efi_timer_delay trigger_type;
448 bool is_signaled;
449 };
450
451 /* This list contains all UEFI objects we know of */
452 extern struct list_head efi_obj_list;
453 /* List of all events */
454 extern struct list_head efi_events;
455
456 /**
457 * struct efi_protocol_notification - handle for notified protocol
458 *
459 * When a protocol interface is installed for which an event was registered with
460 * the RegisterProtocolNotify() service this structure is used to hold the
461 * handle on which the protocol interface was installed.
462 *
463 * @link: link to list of all handles notified for this event
464 * @handle: handle on which the notified protocol interface was installed
465 */
466 struct efi_protocol_notification {
467 struct list_head link;
468 efi_handle_t handle;
469 };
470
471 /**
472 * struct efi_register_notify_event - event registered by
473 * RegisterProtocolNotify()
474 *
475 * The address of this structure serves as registration value.
476 *
477 * @link: link to list of all registered events
478 * @event: registered event. The same event may registered for multiple
479 * GUIDs.
480 * @protocol: protocol for which the event is registered
481 * @handles: linked list of all handles on which the notified protocol was
482 * installed
483 */
484 struct efi_register_notify_event {
485 struct list_head link;
486 struct efi_event *event;
487 efi_guid_t protocol;
488 struct list_head handles;
489 };
490
491 /* List of all events registered by RegisterProtocolNotify() */
492 extern struct list_head efi_register_notify_events;
493
494 /* Initialize efi execution environment */
495 efi_status_t efi_init_obj_list(void);
496 /* Install device tree */
497 efi_status_t efi_install_fdt(void *fdt);
498 /* Run loaded UEFI image */
499 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size);
500 /* Initialize variable services */
501 efi_status_t efi_init_variables(void);
502 /* Notify ExitBootServices() is called */
503 void efi_variables_boot_exit_notify(void);
504 efi_status_t efi_tcg2_notify_exit_boot_services_failed(void);
505 /* Measure efi application invocation */
506 efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle);
507 /* Measure efi application exit */
508 efi_status_t efi_tcg2_measure_efi_app_exit(void);
509 /* Called by bootefi to initialize root node */
510 efi_status_t efi_root_node_register(void);
511 /* Called by bootefi to initialize runtime */
512 efi_status_t efi_initialize_system_table(void);
513 /* efi_runtime_detach() - detach unimplemented runtime functions */
514 void efi_runtime_detach(void);
515 /* efi_convert_pointer() - convert pointer to virtual address */
516 efi_status_t EFIAPI efi_convert_pointer(efi_uintn_t debug_disposition,
517 void **address);
518 /* Carve out DT reserved memory ranges */
519 void efi_carve_out_dt_rsv(void *fdt);
520 /* Called by bootefi to make console interface available */
521 efi_status_t efi_console_register(void);
522 /* Called by bootefi to make all disk storage accessible as EFI objects */
523 efi_status_t efi_disk_register(void);
524 /* Called by efi_init_obj_list() to install EFI_RNG_PROTOCOL */
525 efi_status_t efi_rng_register(void);
526 /* Called by efi_init_obj_list() to install EFI_TCG2_PROTOCOL */
527 efi_status_t efi_tcg2_register(void);
528 /* measure the pe-coff image, extend PCR and add Event Log */
529 efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
530 struct efi_loaded_image_obj *handle,
531 struct efi_loaded_image *loaded_image_info);
532 /* Create handles and protocols for the partitions of a block device */
533 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
534 const char *if_typename, int diskid,
535 const char *pdevname);
536 /* Check if it is EFI system partition */
537 bool efi_disk_is_system_part(efi_handle_t handle);
538 /* Called by bootefi to make GOP (graphical) interface available */
539 efi_status_t efi_gop_register(void);
540 /* Called by bootefi to make the network interface available */
541 efi_status_t efi_net_register(void);
542 /* Called by bootefi to make the watchdog available */
543 efi_status_t efi_watchdog_register(void);
544 efi_status_t efi_initrd_register(void);
545 void efi_initrd_deregister(void);
546 /* Called by bootefi to make SMBIOS tables available */
547 /**
548 * efi_acpi_register() - write out ACPI tables
549 *
550 * Called by bootefi to make ACPI tables available
551 *
552 * @return 0 if OK, -ENOMEM if no memory is available for the tables
553 */
554 efi_status_t efi_acpi_register(void);
555 /**
556 * efi_smbios_register() - write out SMBIOS tables
557 *
558 * Called by bootefi to make SMBIOS tables available
559 *
560 * @return 0 if OK, -ENOMEM if no memory is available for the tables
561 */
562 efi_status_t efi_smbios_register(void);
563
564 struct efi_simple_file_system_protocol *
565 efi_fs_from_path(struct efi_device_path *fp);
566
567 /* Called by efi_set_watchdog_timer to reset the timer */
568 efi_status_t efi_set_watchdog(unsigned long timeout);
569
570 /* Called from places to check whether a timer expired */
571 void efi_timer_check(void);
572 /* Check if a buffer contains a PE-COFF image */
573 efi_status_t efi_check_pe(void *buffer, size_t size, void **nt_header);
574 /* PE loader implementation */
575 efi_status_t efi_load_pe(struct efi_loaded_image_obj *handle,
576 void *efi, size_t efi_size,
577 struct efi_loaded_image *loaded_image_info);
578 /* Called once to store the pristine gd pointer */
579 void efi_save_gd(void);
580 /* Call this to relocate the runtime section to an address space */
581 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
582 /* Add a new object to the object list. */
583 void efi_add_handle(efi_handle_t obj);
584 /* Create handle */
585 efi_status_t efi_create_handle(efi_handle_t *handle);
586 /* Delete handle */
587 void efi_delete_handle(efi_handle_t obj);
588 /* Call this to validate a handle and find the EFI object for it */
589 struct efi_object *efi_search_obj(const efi_handle_t handle);
590 /* Load image */
591 efi_status_t EFIAPI efi_load_image(bool boot_policy,
592 efi_handle_t parent_image,
593 struct efi_device_path *file_path,
594 void *source_buffer,
595 efi_uintn_t source_size,
596 efi_handle_t *image_handle);
597 /* Start image */
598 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
599 efi_uintn_t *exit_data_size,
600 u16 **exit_data);
601 /* Unload image */
602 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle);
603 /* Find a protocol on a handle */
604 efi_status_t efi_search_protocol(const efi_handle_t handle,
605 const efi_guid_t *protocol_guid,
606 struct efi_handler **handler);
607 /* Install new protocol on a handle */
608 efi_status_t efi_add_protocol(const efi_handle_t handle,
609 const efi_guid_t *protocol,
610 void *protocol_interface);
611 /* Open protocol */
612 efi_status_t efi_protocol_open(struct efi_handler *handler,
613 void **protocol_interface, void *agent_handle,
614 void *controller_handle, uint32_t attributes);
615
616 /* Delete protocol from a handle */
617 efi_status_t efi_remove_protocol(const efi_handle_t handle,
618 const efi_guid_t *protocol,
619 void *protocol_interface);
620 /* Delete all protocols from a handle */
621 efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
622 /* Install multiple protocol interfaces */
623 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
624 (efi_handle_t *handle, ...);
625 /* Get handles that support a given protocol */
626 efi_status_t EFIAPI efi_locate_handle_buffer(
627 enum efi_locate_search_type search_type,
628 const efi_guid_t *protocol, void *search_key,
629 efi_uintn_t *no_handles, efi_handle_t **buffer);
630 /* Close an previously opened protocol interface */
631 efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
632 const efi_guid_t *protocol,
633 efi_handle_t agent_handle,
634 efi_handle_t controller_handle);
635 /* Open a protocol interface */
636 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
637 const efi_guid_t *protocol,
638 void **protocol_interface);
639 /* Call this to create an event */
640 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
641 void (EFIAPI *notify_function) (
642 struct efi_event *event,
643 void *context),
644 void *notify_context, efi_guid_t *group,
645 struct efi_event **event);
646 /* Call this to set a timer */
647 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
648 uint64_t trigger_time);
649 /* Call this to signal an event */
650 void efi_signal_event(struct efi_event *event);
651
652 /* open file system: */
653 struct efi_simple_file_system_protocol *efi_simple_file_system(
654 struct blk_desc *desc, int part, struct efi_device_path *dp);
655
656 /* open file from device-path: */
657 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
658
659 /* Registers a callback function for a notification event. */
660 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
661 struct efi_event *event,
662 void **registration);
663 efi_status_t efi_file_size(struct efi_file_handle *fh, efi_uintn_t *size);
664
665 /* get a device path from a Boot#### option */
666 struct efi_device_path *efi_get_dp_from_boot(const efi_guid_t guid);
667
668 /**
669 * efi_size_in_pages() - convert size in bytes to size in pages
670 *
671 * This macro returns the number of EFI memory pages required to hold 'size'
672 * bytes.
673 *
674 * @size: size in bytes
675 * Return: size in pages
676 */
677 #define efi_size_in_pages(size) (((size) + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT)
678 /* Generic EFI memory allocator, call this to get memory */
679 void *efi_alloc(uint64_t len, int memory_type);
680 /* Allocate pages on the specified alignment */
681 void *efi_alloc_aligned_pages(u64 len, int memory_type, size_t align);
682 /* More specific EFI memory allocator, called by EFI payloads */
683 efi_status_t efi_allocate_pages(enum efi_allocate_type type,
684 enum efi_memory_type memory_type,
685 efi_uintn_t pages, uint64_t *memory);
686 /* EFI memory free function. */
687 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
688 /* EFI memory allocator for small allocations */
689 efi_status_t efi_allocate_pool(enum efi_memory_type pool_type,
690 efi_uintn_t size, void **buffer);
691 /* EFI pool memory free function. */
692 efi_status_t efi_free_pool(void *buffer);
693 /* Returns the EFI memory map */
694 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
695 struct efi_mem_desc *memory_map,
696 efi_uintn_t *map_key,
697 efi_uintn_t *descriptor_size,
698 uint32_t *descriptor_version);
699 /* Adds a range into the EFI memory map */
700 efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type);
701 /* Adds a conventional range into the EFI memory map */
702 efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
703 u64 ram_top);
704
705 /* Called by board init to initialize the EFI drivers */
706 efi_status_t efi_driver_init(void);
707 /* Called by board init to initialize the EFI memory map */
708 int efi_memory_init(void);
709 /* Adds new or overrides configuration table entry to the system table */
710 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
711 /* Sets up a loaded image */
712 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
713 struct efi_device_path *file_path,
714 struct efi_loaded_image_obj **handle_ptr,
715 struct efi_loaded_image **info_ptr);
716
717 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
718 extern void *efi_bounce_buffer;
719 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
720 #endif
721
722
723 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
724 int efi_dp_match(const struct efi_device_path *a,
725 const struct efi_device_path *b);
726 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
727 struct efi_device_path **rem);
728 /* get size of the first device path instance excluding end node */
729 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp);
730 /* size of multi-instance device path excluding end node */
731 efi_uintn_t efi_dp_size(const struct efi_device_path *dp);
732 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
733 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
734 const struct efi_device_path *dp2);
735 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
736 const struct efi_device_path *node);
737 /* Create a device path node of given type, sub-type, length */
738 struct efi_device_path *efi_dp_create_device_node(const u8 type,
739 const u8 sub_type,
740 const u16 length);
741 /* Append device path instance */
742 struct efi_device_path *efi_dp_append_instance(
743 const struct efi_device_path *dp,
744 const struct efi_device_path *dpi);
745 /* Get next device path instance */
746 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
747 efi_uintn_t *size);
748 /* Check if a device path contains muliple instances */
749 bool efi_dp_is_multi_instance(const struct efi_device_path *dp);
750
751 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
752 /* Create a device node for a block device partition. */
753 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
754 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
755 const char *path);
756 struct efi_device_path *efi_dp_from_eth(void);
757 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
758 uint64_t start_address,
759 uint64_t end_address);
760 /* Determine the last device path node that is not the end node. */
761 const struct efi_device_path *efi_dp_last_node(
762 const struct efi_device_path *dp);
763 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
764 struct efi_device_path **device_path,
765 struct efi_device_path **file_path);
766 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
767 const char *path,
768 struct efi_device_path **device,
769 struct efi_device_path **file);
770 ssize_t efi_dp_check_length(const struct efi_device_path *dp,
771 const size_t maxlen);
772
773 #define EFI_DP_TYPE(_dp, _type, _subtype) \
774 (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
775 ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
776
777 /* Indicate supported runtime services */
778 efi_status_t efi_init_runtime_supported(void);
779
780 /* Update CRC32 in table header */
781 void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table);
782
783 /* Boards may provide the functions below to implement RTS functionality */
784
785 void __efi_runtime EFIAPI efi_reset_system(
786 enum efi_reset_type reset_type,
787 efi_status_t reset_status,
788 unsigned long data_size, void *reset_data);
789
790 /* Architecture specific initialization of the EFI subsystem */
791 efi_status_t efi_reset_system_init(void);
792
793 efi_status_t __efi_runtime EFIAPI efi_get_time(
794 struct efi_time *time,
795 struct efi_time_cap *capabilities);
796
797 efi_status_t __efi_runtime EFIAPI efi_set_time(struct efi_time *time);
798
799 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
800 /*
801 * Entry point for the tests of the EFI API.
802 * It is called by 'bootefi selftest'
803 */
804 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
805 struct efi_system_table *systab);
806 #endif
807
808 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
809 const efi_guid_t *vendor, u32 *attributes,
810 efi_uintn_t *data_size, void *data);
811 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
812 u16 *variable_name,
813 efi_guid_t *vendor);
814 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
815 const efi_guid_t *vendor, u32 attributes,
816 efi_uintn_t data_size, const void *data);
817
818 efi_status_t EFIAPI efi_query_variable_info(
819 u32 attributes, u64 *maximum_variable_storage_size,
820 u64 *remaining_variable_storage_size,
821 u64 *maximum_variable_size);
822
823 void *efi_get_var(const u16 *name, const efi_guid_t *vendor, efi_uintn_t *size);
824
825 /*
826 * See section 3.1.3 in the v2.7 UEFI spec for more details on
827 * the layout of EFI_LOAD_OPTION. In short it is:
828 *
829 * typedef struct _EFI_LOAD_OPTION {
830 * UINT32 Attributes;
831 * UINT16 FilePathListLength;
832 * // CHAR16 Description[]; <-- variable length, NULL terminated
833 * // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
834 * <-- FilePathListLength bytes
835 * // UINT8 OptionalData[];
836 * } EFI_LOAD_OPTION;
837 */
838 struct efi_load_option {
839 u32 attributes;
840 u16 file_path_length;
841 u16 *label;
842 struct efi_device_path *file_path;
843 const u8 *optional_data;
844 };
845
846 struct efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
847 const efi_guid_t *guid);
848 struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
849 const struct efi_device_path *dp2);
850 struct efi_device_path *search_gpt_dp_node(struct efi_device_path *device_path);
851 efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
852 efi_uintn_t *size);
853 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data);
854 efi_status_t efi_set_load_options(efi_handle_t handle,
855 efi_uintn_t load_options_size,
856 void *load_options);
857 efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options);
858
859 /**
860 * struct efi_image_regions - A list of memory regions
861 *
862 * @max: Maximum number of regions
863 * @num: Number of regions
864 * @reg: array of regions
865 */
866 struct efi_image_regions {
867 int max;
868 int num;
869 struct image_region reg[];
870 };
871
872 /**
873 * struct efi_sig_data - A decoded data of struct efi_signature_data
874 *
875 * This structure represents an internal form of signature in
876 * signature database. A listed list may represent a signature list.
877 *
878 * @next: Pointer to next entry
879 * @owner: Signature owner
880 * @data: Pointer to signature data
881 * @size: Size of signature data
882 */
883 struct efi_sig_data {
884 struct efi_sig_data *next;
885 efi_guid_t owner;
886 void *data;
887 size_t size;
888 };
889
890 /**
891 * struct efi_signature_store - A decoded data of signature database
892 *
893 * This structure represents an internal form of signature database.
894 *
895 * @next: Pointer to next entry
896 * @sig_type: Signature type
897 * @sig_data_list: Pointer to signature list
898 */
899 struct efi_signature_store {
900 struct efi_signature_store *next;
901 efi_guid_t sig_type;
902 struct efi_sig_data *sig_data_list;
903 };
904
905 struct x509_certificate;
906 struct pkcs7_message;
907
908 bool efi_signature_lookup_digest(struct efi_image_regions *regs,
909 struct efi_signature_store *db);
910 bool efi_signature_verify(struct efi_image_regions *regs,
911 struct pkcs7_message *msg,
912 struct efi_signature_store *db,
913 struct efi_signature_store *dbx);
efi_signature_verify_one(struct efi_image_regions * regs,struct pkcs7_message * msg,struct efi_signature_store * db)914 static inline bool efi_signature_verify_one(struct efi_image_regions *regs,
915 struct pkcs7_message *msg,
916 struct efi_signature_store *db)
917 {
918 return efi_signature_verify(regs, msg, db, NULL);
919 }
920 bool efi_signature_check_signers(struct pkcs7_message *msg,
921 struct efi_signature_store *dbx);
922
923 efi_status_t efi_image_region_add(struct efi_image_regions *regs,
924 const void *start, const void *end,
925 int nocheck);
926
927 void efi_sigstore_free(struct efi_signature_store *sigstore);
928 struct efi_signature_store *efi_build_signature_store(void *sig_list,
929 efi_uintn_t size);
930 struct efi_signature_store *efi_sigstore_parse_sigdb(u16 *name);
931
932 bool efi_secure_boot_enabled(void);
933
934 bool efi_capsule_auth_enabled(void);
935
936 void *efi_prepare_aligned_image(void *efi, u64 *efi_size);
937
938 bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
939 WIN_CERTIFICATE **auth, size_t *auth_len);
940
941 struct pkcs7_message *efi_parse_pkcs7_header(const void *buf,
942 size_t buflen,
943 u8 **tmpbuf);
944
945 /* runtime implementation of memcpy() */
946 void efi_memcpy_runtime(void *dest, const void *src, size_t n);
947
948 /* commonly used helper function */
949 u16 *efi_create_indexed_name(u16 *buffer, size_t buffer_size, const char *name,
950 unsigned int index);
951
952 extern const struct efi_firmware_management_protocol efi_fmp_fit;
953 extern const struct efi_firmware_management_protocol efi_fmp_raw;
954
955 /* Capsule update */
956 efi_status_t EFIAPI efi_update_capsule(
957 struct efi_capsule_header **capsule_header_array,
958 efi_uintn_t capsule_count,
959 u64 scatter_gather_list);
960 efi_status_t EFIAPI efi_query_capsule_caps(
961 struct efi_capsule_header **capsule_header_array,
962 efi_uintn_t capsule_count,
963 u64 *maximum_capsule_size,
964 u32 *reset_type);
965
966 efi_status_t efi_capsule_authenticate(const void *capsule,
967 efi_uintn_t capsule_size,
968 void **image, efi_uintn_t *image_size);
969
970 #define EFI_CAPSULE_DIR L"\\EFI\\UpdateCapsule\\"
971
972 /**
973 * Install the ESRT system table.
974 *
975 * @return status code
976 */
977 efi_status_t efi_esrt_register(void);
978
979 /**
980 * efi_esrt_populate() - Populates the ESRT entries from the FMP instances
981 * present in the system.
982 * If an ESRT already exists, the old ESRT is replaced in the system table.
983 * The memory of the old ESRT is deallocated.
984 *
985 * Return:
986 * - EFI_SUCCESS if the ESRT is correctly created
987 * - error code otherwise.
988 */
989 efi_status_t efi_esrt_populate(void);
990 efi_status_t efi_load_capsule_drivers(void);
991 #endif /* _EFI_LOADER_H */
992