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