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