2 * EFI application boot time services
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
10 #include <efi_loader.h>
12 #include <asm/global_data.h>
13 #include <libfdt_env.h>
14 #include <u-boot/crc.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 /* This list contains all the EFI objects our payload has access to */
22 LIST_HEAD(efi_obj_list);
25 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
26 * we need to do trickery with caches. Since we don't want to break the EFI
27 * aware boot path, only apply hacks when loading exiting directly (breaking
28 * direct Linux EFI booting along the way - oh well).
30 static bool efi_is_direct_boot = true;
33 * EFI can pass arbitrary additional "tables" containing vendor specific
34 * information to the payload. One such table is the FDT table which contains
35 * a pointer to a flattened device tree blob.
37 * In most cases we want to pass an FDT to the payload, so reserve one slot of
38 * config table space for it. The pointer gets populated by do_bootefi_exec().
40 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
44 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
45 * fixed when compiling U-Boot. However, the payload does not know about that
46 * restriction so we need to manually swap its and our view of that register on
47 * EFI callback entry/exit.
49 static volatile void *efi_gd, *app_gd;
52 /* Called from do_bootefi_exec() */
53 void efi_save_gd(void)
60 /* Called on every callback entry */
61 void efi_restore_gd(void)
64 /* Only restore if we're already in EFI context */
74 /* Called on every callback exit */
75 efi_status_t efi_exit_func(efi_status_t ret)
84 static efi_status_t efi_unsupported(const char *funcname)
86 debug("EFI: App called into unimplemented function %s\n", funcname);
87 return EFI_EXIT(EFI_UNSUPPORTED);
90 static int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
92 return memcmp(g1, g2, sizeof(efi_guid_t));
95 static unsigned long EFIAPI efi_raise_tpl(unsigned long new_tpl)
97 EFI_ENTRY("0x%lx", new_tpl);
101 static void EFIAPI efi_restore_tpl(unsigned long old_tpl)
103 EFI_ENTRY("0x%lx", old_tpl);
104 EFI_EXIT(efi_unsupported(__func__));
107 efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
113 EFI_ENTRY("%d, %d, 0x%lx, %p", type, memory_type, pages, memory);
114 r = efi_allocate_pages(type, memory_type, pages, memory);
118 efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory, unsigned long pages)
122 EFI_ENTRY("%"PRIx64", 0x%lx", memory, pages);
123 r = efi_free_pages(memory, pages);
127 efi_status_t EFIAPI efi_get_memory_map_ext(unsigned long *memory_map_size,
128 struct efi_mem_desc *memory_map,
129 unsigned long *map_key,
130 unsigned long *descriptor_size,
131 uint32_t *descriptor_version)
135 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
136 map_key, descriptor_size, descriptor_version);
137 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
138 descriptor_size, descriptor_version);
142 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
148 EFI_ENTRY("%d, %ld, %p", pool_type, size, buffer);
149 r = efi_allocate_pool(pool_type, size, buffer);
153 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
157 EFI_ENTRY("%p", buffer);
158 r = efi_free_pool(buffer);
163 * Our event capabilities are very limited. Only support a single
164 * event to exist, so we don't need to maintain lists.
167 enum efi_event_type type;
171 unsigned long notify_tpl;
172 void (EFIAPI *notify_function) (void *event, void *context);
173 void *notify_context;
175 /* Disable timers on bootup */
176 .trigger_next = -1ULL,
179 static efi_status_t EFIAPI efi_create_event(
180 enum efi_event_type type, ulong notify_tpl,
181 void (EFIAPI *notify_function) (void *event,
183 void *notify_context, void **event)
185 EFI_ENTRY("%d, 0x%lx, %p, %p", type, notify_tpl, notify_function,
187 if (efi_event.notify_function) {
188 /* We only support one event at a time */
189 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
192 efi_event.type = type;
193 efi_event.notify_tpl = notify_tpl;
194 efi_event.notify_function = notify_function;
195 efi_event.notify_context = notify_context;
198 return EFI_EXIT(EFI_SUCCESS);
202 * Our timers have to work without interrupts, so we check whenever keyboard
203 * input or disk accesses happen if enough time elapsed for it to fire.
205 void efi_timer_check(void)
207 u64 now = timer_get_us();
209 if (now >= efi_event.trigger_next) {
211 if (efi_event.trigger_type == EFI_TIMER_PERIODIC)
212 efi_event.trigger_next += efi_event.trigger_time / 10;
213 if (efi_event.type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL))
214 efi_event.notify_function(&efi_event,
215 efi_event.notify_context);
221 static efi_status_t EFIAPI efi_set_timer(void *event, int type,
222 uint64_t trigger_time)
224 /* We don't have 64bit division available everywhere, so limit timer
225 * distances to 32bit bits. */
226 u32 trigger32 = trigger_time;
228 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
230 if (trigger32 < trigger_time) {
231 printf("WARNING: Truncating timer from %"PRIx64" to %x\n",
232 trigger_time, trigger32);
235 if (event != &efi_event) {
236 /* We only support one event at a time */
237 return EFI_EXIT(EFI_INVALID_PARAMETER);
242 efi_event.trigger_next = -1ULL;
244 case EFI_TIMER_PERIODIC:
245 case EFI_TIMER_RELATIVE:
246 efi_event.trigger_next = timer_get_us() + (trigger32 / 10);
249 return EFI_EXIT(EFI_INVALID_PARAMETER);
251 efi_event.trigger_type = type;
252 efi_event.trigger_time = trigger_time;
254 return EFI_EXIT(EFI_SUCCESS);
257 static efi_status_t EFIAPI efi_wait_for_event(unsigned long num_events,
258 void *event, unsigned long *index)
262 EFI_ENTRY("%ld, %p, %p", num_events, event, index);
264 now = timer_get_us();
265 while (now < efi_event.trigger_next) { }
268 return EFI_EXIT(EFI_SUCCESS);
271 static efi_status_t EFIAPI efi_signal_event(void *event)
273 EFI_ENTRY("%p", event);
274 return EFI_EXIT(EFI_SUCCESS);
277 static efi_status_t EFIAPI efi_close_event(void *event)
279 EFI_ENTRY("%p", event);
280 efi_event.trigger_next = -1ULL;
281 return EFI_EXIT(EFI_SUCCESS);
284 static efi_status_t EFIAPI efi_check_event(void *event)
286 EFI_ENTRY("%p", event);
287 return EFI_EXIT(EFI_NOT_READY);
290 static efi_status_t EFIAPI efi_install_protocol_interface(void **handle,
291 efi_guid_t *protocol, int protocol_interface_type,
292 void *protocol_interface)
294 EFI_ENTRY("%p, %p, %d, %p", handle, protocol, protocol_interface_type,
296 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
298 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
299 efi_guid_t *protocol, void *old_interface,
302 EFI_ENTRY("%p, %p, %p, %p", handle, protocol, old_interface,
304 return EFI_EXIT(EFI_ACCESS_DENIED);
307 static efi_status_t EFIAPI efi_uninstall_protocol_interface(void *handle,
308 efi_guid_t *protocol, void *protocol_interface)
310 EFI_ENTRY("%p, %p, %p", handle, protocol, protocol_interface);
311 return EFI_EXIT(EFI_NOT_FOUND);
314 static efi_status_t EFIAPI efi_register_protocol_notify(efi_guid_t *protocol,
318 EFI_ENTRY("%p, %p, %p", protocol, event, registration);
319 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
322 static int efi_search(enum efi_locate_search_type search_type,
323 efi_guid_t *protocol, void *search_key,
324 struct efi_object *efiobj)
328 switch (search_type) {
331 case by_register_notify:
334 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
335 const efi_guid_t *guid = efiobj->protocols[i].guid;
336 if (guid && !guidcmp(guid, protocol))
345 static efi_status_t EFIAPI efi_locate_handle(
346 enum efi_locate_search_type search_type,
347 efi_guid_t *protocol, void *search_key,
348 unsigned long *buffer_size, efi_handle_t *buffer)
350 struct list_head *lhandle;
351 unsigned long size = 0;
353 EFI_ENTRY("%d, %p, %p, %p, %p", search_type, protocol, search_key,
354 buffer_size, buffer);
356 /* Count how much space we need */
357 list_for_each(lhandle, &efi_obj_list) {
358 struct efi_object *efiobj;
359 efiobj = list_entry(lhandle, struct efi_object, link);
360 if (!efi_search(search_type, protocol, search_key, efiobj)) {
361 size += sizeof(void*);
365 if (*buffer_size < size) {
367 return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
370 /* Then fill the array */
371 list_for_each(lhandle, &efi_obj_list) {
372 struct efi_object *efiobj;
373 efiobj = list_entry(lhandle, struct efi_object, link);
374 if (!efi_search(search_type, protocol, search_key, efiobj)) {
375 *(buffer++) = efiobj->handle;
380 return EFI_EXIT(EFI_SUCCESS);
383 static efi_status_t EFIAPI efi_locate_device_path(efi_guid_t *protocol,
384 struct efi_device_path **device_path,
385 efi_handle_t *device)
387 EFI_ENTRY("%p, %p, %p", protocol, device_path, device);
388 return EFI_EXIT(EFI_NOT_FOUND);
391 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
395 /* Check for guid override */
396 for (i = 0; i < systab.nr_tables; i++) {
397 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
398 efi_conf_table[i].table = table;
403 /* No override, check for overflow */
404 if (i >= ARRAY_SIZE(efi_conf_table))
405 return EFI_OUT_OF_RESOURCES;
407 /* Add a new entry */
408 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
409 efi_conf_table[i].table = table;
410 systab.nr_tables = i + 1;
415 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
418 EFI_ENTRY("%p, %p", guid, table);
419 return EFI_EXIT(efi_install_configuration_table(guid, table));
422 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
423 efi_handle_t parent_image,
424 struct efi_device_path *file_path,
426 unsigned long source_size,
427 efi_handle_t *image_handle)
429 static struct efi_object loaded_image_info_obj = {
432 .guid = &efi_guid_loaded_image,
433 .open = &efi_return_handle,
437 struct efi_loaded_image *info;
438 struct efi_object *obj;
440 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
441 file_path, source_buffer, source_size, image_handle);
442 info = malloc(sizeof(*info));
443 obj = malloc(sizeof(loaded_image_info_obj));
444 memset(info, 0, sizeof(*info));
445 memcpy(obj, &loaded_image_info_obj, sizeof(loaded_image_info_obj));
447 info->file_path = file_path;
448 info->reserved = efi_load_pe(source_buffer, info);
449 if (!info->reserved) {
452 return EFI_EXIT(EFI_UNSUPPORTED);
455 *image_handle = info;
456 list_add_tail(&obj->link, &efi_obj_list);
458 return EFI_EXIT(EFI_SUCCESS);
461 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
462 unsigned long *exit_data_size,
465 ulong (*entry)(void *image_handle, struct efi_system_table *st);
466 struct efi_loaded_image *info = image_handle;
468 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
469 entry = info->reserved;
471 efi_is_direct_boot = false;
473 /* call the image! */
474 if (setjmp(&info->exit_jmp)) {
475 /* We returned from the child image */
476 return EFI_EXIT(info->exit_status);
479 entry(image_handle, &systab);
481 /* Should usually never get here */
482 return EFI_EXIT(EFI_SUCCESS);
485 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
486 efi_status_t exit_status, unsigned long exit_data_size,
489 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
491 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
492 exit_data_size, exit_data);
494 loaded_image_info->exit_status = exit_status;
495 longjmp(&loaded_image_info->exit_jmp, 1);
497 panic("EFI application exited");
500 static struct efi_object *efi_search_obj(void *handle)
502 struct list_head *lhandle;
504 list_for_each(lhandle, &efi_obj_list) {
505 struct efi_object *efiobj;
506 efiobj = list_entry(lhandle, struct efi_object, link);
507 if (efiobj->handle == handle)
514 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
516 struct efi_object *efiobj;
518 EFI_ENTRY("%p", image_handle);
519 efiobj = efi_search_obj(image_handle);
521 list_del(&efiobj->link);
523 return EFI_EXIT(EFI_SUCCESS);
526 static void efi_exit_caches(void)
528 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
530 * Grub on 32bit ARM needs to have caches disabled before jumping into
531 * a zImage, but does not know of all cache layers. Give it a hand.
533 if (efi_is_direct_boot)
534 cleanup_before_linux();
538 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
539 unsigned long map_key)
541 EFI_ENTRY("%p, %ld", image_handle, map_key);
543 board_quiesce_devices();
545 /* Fix up caches for EFI payloads if necessary */
548 /* This stops all lingering devices */
549 bootm_disable_interrupts();
551 /* Give the payload some time to boot */
554 return EFI_EXIT(EFI_SUCCESS);
557 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
559 static uint64_t mono = 0;
560 EFI_ENTRY("%p", count);
562 return EFI_EXIT(EFI_SUCCESS);
565 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
567 EFI_ENTRY("%ld", microseconds);
568 udelay(microseconds);
569 return EFI_EXIT(EFI_SUCCESS);
572 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
573 uint64_t watchdog_code,
574 unsigned long data_size,
575 uint16_t *watchdog_data)
577 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
578 data_size, watchdog_data);
579 return EFI_EXIT(efi_unsupported(__func__));
582 static efi_status_t EFIAPI efi_connect_controller(
583 efi_handle_t controller_handle,
584 efi_handle_t *driver_image_handle,
585 struct efi_device_path *remain_device_path,
588 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
589 remain_device_path, recursive);
590 return EFI_EXIT(EFI_NOT_FOUND);
593 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
594 void *driver_image_handle,
597 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
599 return EFI_EXIT(EFI_INVALID_PARAMETER);
602 static efi_status_t EFIAPI efi_close_protocol(void *handle,
603 efi_guid_t *protocol,
605 void *controller_handle)
607 EFI_ENTRY("%p, %p, %p, %p", handle, protocol, agent_handle,
609 return EFI_EXIT(EFI_NOT_FOUND);
612 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
613 efi_guid_t *protocol,
614 struct efi_open_protocol_info_entry **entry_buffer,
615 unsigned long *entry_count)
617 EFI_ENTRY("%p, %p, %p, %p", handle, protocol, entry_buffer,
619 return EFI_EXIT(EFI_NOT_FOUND);
622 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
623 efi_guid_t ***protocol_buffer,
624 unsigned long *protocol_buffer_count)
626 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
627 protocol_buffer_count);
628 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
631 static efi_status_t EFIAPI efi_locate_handle_buffer(
632 enum efi_locate_search_type search_type,
633 efi_guid_t *protocol, void *search_key,
634 unsigned long *no_handles, efi_handle_t **buffer)
636 EFI_ENTRY("%d, %p, %p, %p, %p", search_type, protocol, search_key,
638 return EFI_EXIT(EFI_NOT_FOUND);
641 static struct efi_class_map efi_class_maps[] = {
643 .guid = &efi_guid_console_control,
644 .interface = &efi_console_control
648 static efi_status_t EFIAPI efi_locate_protocol(efi_guid_t *protocol,
650 void **protocol_interface)
654 EFI_ENTRY("%p, %p, %p", protocol, registration, protocol_interface);
655 for (i = 0; i < ARRAY_SIZE(efi_class_maps); i++) {
656 struct efi_class_map *curmap = &efi_class_maps[i];
657 if (!guidcmp(protocol, curmap->guid)) {
658 *protocol_interface = (void*)curmap->interface;
659 return EFI_EXIT(EFI_SUCCESS);
663 return EFI_EXIT(EFI_NOT_FOUND);
666 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
669 EFI_ENTRY("%p", handle);
670 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
673 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
676 EFI_ENTRY("%p", handle);
677 return EFI_EXIT(EFI_INVALID_PARAMETER);
680 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
681 unsigned long data_size,
684 EFI_ENTRY("%p, %ld", data, data_size);
685 *crc32_p = crc32(0, data, data_size);
686 return EFI_EXIT(EFI_SUCCESS);
689 static void EFIAPI efi_copy_mem(void *destination, void *source,
690 unsigned long length)
692 EFI_ENTRY("%p, %p, %ld", destination, source, length);
693 memcpy(destination, source, length);
696 static void EFIAPI efi_set_mem(void *buffer, unsigned long size, uint8_t value)
698 EFI_ENTRY("%p, %ld, 0x%x", buffer, size, value);
699 memset(buffer, value, size);
702 static efi_status_t EFIAPI efi_open_protocol(
703 void *handle, efi_guid_t *protocol,
704 void **protocol_interface, void *agent_handle,
705 void *controller_handle, uint32_t attributes)
707 struct list_head *lhandle;
709 efi_status_t r = EFI_UNSUPPORTED;
711 EFI_ENTRY("%p, %p, %p, %p, %p, 0x%x", handle, protocol,
712 protocol_interface, agent_handle, controller_handle,
714 list_for_each(lhandle, &efi_obj_list) {
715 struct efi_object *efiobj;
716 efiobj = list_entry(lhandle, struct efi_object, link);
718 if (efiobj->handle != handle)
721 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
722 struct efi_handler *handler = &efiobj->protocols[i];
723 const efi_guid_t *hprotocol = handler->guid;
726 if (!guidcmp(hprotocol, protocol)) {
727 r = handler->open(handle, protocol,
728 protocol_interface, agent_handle,
729 controller_handle, attributes);
739 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
740 efi_guid_t *protocol,
741 void **protocol_interface)
743 return efi_open_protocol(handle, protocol, protocol_interface,
747 static const struct efi_boot_services efi_boot_services = {
749 .headersize = sizeof(struct efi_table_hdr),
751 .raise_tpl = efi_raise_tpl,
752 .restore_tpl = efi_restore_tpl,
753 .allocate_pages = efi_allocate_pages_ext,
754 .free_pages = efi_free_pages_ext,
755 .get_memory_map = efi_get_memory_map_ext,
756 .allocate_pool = efi_allocate_pool_ext,
757 .free_pool = efi_free_pool_ext,
758 .create_event = efi_create_event,
759 .set_timer = efi_set_timer,
760 .wait_for_event = efi_wait_for_event,
761 .signal_event = efi_signal_event,
762 .close_event = efi_close_event,
763 .check_event = efi_check_event,
764 .install_protocol_interface = efi_install_protocol_interface,
765 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
766 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
767 .handle_protocol = efi_handle_protocol,
769 .register_protocol_notify = efi_register_protocol_notify,
770 .locate_handle = efi_locate_handle,
771 .locate_device_path = efi_locate_device_path,
772 .install_configuration_table = efi_install_configuration_table_ext,
773 .load_image = efi_load_image,
774 .start_image = efi_start_image,
776 .unload_image = efi_unload_image,
777 .exit_boot_services = efi_exit_boot_services,
778 .get_next_monotonic_count = efi_get_next_monotonic_count,
780 .set_watchdog_timer = efi_set_watchdog_timer,
781 .connect_controller = efi_connect_controller,
782 .disconnect_controller = efi_disconnect_controller,
783 .open_protocol = efi_open_protocol,
784 .close_protocol = efi_close_protocol,
785 .open_protocol_information = efi_open_protocol_information,
786 .protocols_per_handle = efi_protocols_per_handle,
787 .locate_handle_buffer = efi_locate_handle_buffer,
788 .locate_protocol = efi_locate_protocol,
789 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
790 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
791 .calculate_crc32 = efi_calculate_crc32,
792 .copy_mem = efi_copy_mem,
793 .set_mem = efi_set_mem,
797 static uint16_t __efi_runtime_data firmware_vendor[] =
798 { 'D','a','s',' ','U','-','b','o','o','t',0 };
800 struct efi_system_table __efi_runtime_data systab = {
802 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
803 .revision = 0x20005, /* 2.5 */
804 .headersize = sizeof(struct efi_table_hdr),
806 .fw_vendor = (long)firmware_vendor,
807 .con_in = (void*)&efi_con_in,
808 .con_out = (void*)&efi_con_out,
809 .std_err = (void*)&efi_con_out,
810 .runtime = (void*)&efi_runtime_services,
811 .boottime = (void*)&efi_boot_services,
813 .tables = (void*)efi_conf_table,