2 * EFI application boot time services
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
10 #include <efi_loader.h>
11 #include <environment.h>
13 #include <asm/global_data.h>
14 #include <libfdt_env.h>
15 #include <u-boot/crc.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 /* Task priority level */
23 static UINTN efi_tpl = TPL_APPLICATION;
25 /* This list contains all the EFI objects our payload has access to */
26 LIST_HEAD(efi_obj_list);
29 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
30 * we need to do trickery with caches. Since we don't want to break the EFI
31 * aware boot path, only apply hacks when loading exiting directly (breaking
32 * direct Linux EFI booting along the way - oh well).
34 static bool efi_is_direct_boot = true;
37 * EFI can pass arbitrary additional "tables" containing vendor specific
38 * information to the payload. One such table is the FDT table which contains
39 * a pointer to a flattened device tree blob.
41 * In most cases we want to pass an FDT to the payload, so reserve one slot of
42 * config table space for it. The pointer gets populated by do_bootefi_exec().
44 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
48 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
49 * fixed when compiling U-Boot. However, the payload does not know about that
50 * restriction so we need to manually swap its and our view of that register on
51 * EFI callback entry/exit.
53 static volatile void *efi_gd, *app_gd;
56 static int entry_count;
57 static int nesting_level;
59 /* Called on every callback entry */
60 int __efi_entry_check(void)
62 int ret = entry_count++ == 0;
71 /* Called on every callback exit */
72 int __efi_exit_check(void)
74 int ret = --entry_count == 0;
81 /* Called from do_bootefi_exec() */
82 void efi_save_gd(void)
90 * Special case handler for error/abort that just forces things back
91 * to u-boot world so we can dump out an abort msg, without any care
92 * about returning back to UEFI world.
94 void efi_restore_gd(void)
97 /* Only restore if we're already in EFI context */
105 * Two spaces per indent level, maxing out at 10.. which ought to be
106 * enough for anyone ;-)
108 static const char *indent_string(int level)
110 const char *indent = " ";
111 const int max = strlen(indent);
112 level = min(max, level * 2);
113 return &indent[max - level];
116 const char *__efi_nesting(void)
118 return indent_string(nesting_level);
121 const char *__efi_nesting_inc(void)
123 return indent_string(nesting_level++);
126 const char *__efi_nesting_dec(void)
128 return indent_string(--nesting_level);
132 #define EFI_LOW32(a) (a & 0xFFFFFFFFULL)
134 #define EFI_HIGH32(a) (a >> 32)
137 * 64bit division by 10 implemented as multiplication by 1 / 10
139 * Decimals of one tenth: 0x1 / 0xA = 0x0.19999...
141 #define EFI_TENTH 0x199999999999999A
142 static u64 efi_div10(u64 a)
148 ret = EFI_HIGH32(a) * EFI_HIGH32(EFI_TENTH);
149 prod = EFI_HIGH32(a) * EFI_LOW32(EFI_TENTH);
150 rem = EFI_LOW32(prod);
151 ret += EFI_HIGH32(prod);
152 prod = EFI_LOW32(a) * EFI_HIGH32(EFI_TENTH);
153 rem += EFI_LOW32(prod);
154 ret += EFI_HIGH32(prod);
155 prod = EFI_LOW32(a) * EFI_LOW32(EFI_TENTH);
156 rem += EFI_HIGH32(prod);
157 ret += EFI_HIGH32(rem);
158 /* Round to nearest integer */
159 if (rem >= (1 << 31))
164 void efi_signal_event(struct efi_event *event)
166 if (event->notify_function) {
169 if (efi_tpl >= event->notify_tpl)
171 EFI_CALL_VOID(event->notify_function(event,
172 event->notify_context));
177 static efi_status_t efi_unsupported(const char *funcname)
179 debug("EFI: App called into unimplemented function %s\n", funcname);
180 return EFI_EXIT(EFI_UNSUPPORTED);
183 static unsigned long EFIAPI efi_raise_tpl(UINTN new_tpl)
185 UINTN old_tpl = efi_tpl;
187 EFI_ENTRY("0x%zx", new_tpl);
189 if (new_tpl < efi_tpl)
190 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
192 if (efi_tpl > TPL_HIGH_LEVEL)
193 efi_tpl = TPL_HIGH_LEVEL;
195 EFI_EXIT(EFI_SUCCESS);
199 static void EFIAPI efi_restore_tpl(UINTN old_tpl)
201 EFI_ENTRY("0x%zx", old_tpl);
203 if (old_tpl > efi_tpl)
204 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
206 if (efi_tpl > TPL_HIGH_LEVEL)
207 efi_tpl = TPL_HIGH_LEVEL;
209 EFI_EXIT(EFI_SUCCESS);
212 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
218 EFI_ENTRY("%d, %d, 0x%lx, %p", type, memory_type, pages, memory);
219 r = efi_allocate_pages(type, memory_type, pages, memory);
223 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
228 EFI_ENTRY("%"PRIx64", 0x%lx", memory, pages);
229 r = efi_free_pages(memory, pages);
233 static efi_status_t EFIAPI efi_get_memory_map_ext(
234 unsigned long *memory_map_size,
235 struct efi_mem_desc *memory_map,
236 unsigned long *map_key,
237 unsigned long *descriptor_size,
238 uint32_t *descriptor_version)
242 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
243 map_key, descriptor_size, descriptor_version);
244 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
245 descriptor_size, descriptor_version);
249 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
255 EFI_ENTRY("%d, %ld, %p", pool_type, size, buffer);
256 r = efi_allocate_pool(pool_type, size, buffer);
260 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
264 EFI_ENTRY("%p", buffer);
265 r = efi_free_pool(buffer);
269 static efi_status_t efi_create_handle(void **handle)
271 struct efi_object *obj;
274 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
275 sizeof(struct efi_object),
277 if (r != EFI_SUCCESS)
279 memset(obj, 0, sizeof(struct efi_object));
281 list_add_tail(&obj->link, &efi_obj_list);
287 * Our event capabilities are very limited. Only a small limited
288 * number of events is allowed to coexist.
290 static struct efi_event efi_events[16];
292 efi_status_t efi_create_event(uint32_t type, UINTN notify_tpl,
293 void (EFIAPI *notify_function) (
294 struct efi_event *event,
296 void *notify_context, struct efi_event **event)
301 return EFI_INVALID_PARAMETER;
303 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
304 return EFI_INVALID_PARAMETER;
306 if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
307 notify_function == NULL)
308 return EFI_INVALID_PARAMETER;
310 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
311 if (efi_events[i].type)
313 efi_events[i].type = type;
314 efi_events[i].notify_tpl = notify_tpl;
315 efi_events[i].notify_function = notify_function;
316 efi_events[i].notify_context = notify_context;
317 /* Disable timers on bootup */
318 efi_events[i].trigger_next = -1ULL;
319 efi_events[i].queued = 0;
320 efi_events[i].signaled = 0;
321 *event = &efi_events[i];
324 return EFI_OUT_OF_RESOURCES;
327 static efi_status_t EFIAPI efi_create_event_ext(
328 uint32_t type, UINTN notify_tpl,
329 void (EFIAPI *notify_function) (
330 struct efi_event *event,
332 void *notify_context, struct efi_event **event)
334 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
336 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
337 notify_context, event));
342 * Our timers have to work without interrupts, so we check whenever keyboard
343 * input or disk accesses happen if enough time elapsed for it to fire.
345 void efi_timer_check(void)
348 u64 now = timer_get_us();
350 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
351 if (!efi_events[i].type)
353 if (efi_events[i].queued)
354 efi_signal_event(&efi_events[i]);
355 if (!(efi_events[i].type & EVT_TIMER) ||
356 now < efi_events[i].trigger_next)
358 switch (efi_events[i].trigger_type) {
359 case EFI_TIMER_RELATIVE:
360 efi_events[i].trigger_type = EFI_TIMER_STOP;
362 case EFI_TIMER_PERIODIC:
363 efi_events[i].trigger_next +=
364 efi_events[i].trigger_time;
369 efi_events[i].signaled = 1;
370 efi_signal_event(&efi_events[i]);
375 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
376 uint64_t trigger_time)
381 * The parameter defines a multiple of 100ns.
382 * We use multiples of 1000ns. So divide by 10.
384 trigger_time = efi_div10(trigger_time);
386 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
387 if (event != &efi_events[i])
390 if (!(event->type & EVT_TIMER))
394 event->trigger_next = -1ULL;
396 case EFI_TIMER_PERIODIC:
397 case EFI_TIMER_RELATIVE:
398 event->trigger_next =
399 timer_get_us() + trigger_time;
402 return EFI_INVALID_PARAMETER;
404 event->trigger_type = type;
405 event->trigger_time = trigger_time;
409 return EFI_INVALID_PARAMETER;
412 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
413 enum efi_timer_delay type,
414 uint64_t trigger_time)
416 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
417 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
420 static efi_status_t EFIAPI efi_wait_for_event(unsigned long num_events,
421 struct efi_event **event,
422 unsigned long *index)
426 EFI_ENTRY("%ld, %p, %p", num_events, event, index);
428 /* Check parameters */
429 if (!num_events || !event)
430 return EFI_EXIT(EFI_INVALID_PARAMETER);
432 if (efi_tpl != TPL_APPLICATION)
433 return EFI_EXIT(EFI_UNSUPPORTED);
434 for (i = 0; i < num_events; ++i) {
435 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
436 if (event[i] == &efi_events[j])
439 return EFI_EXIT(EFI_INVALID_PARAMETER);
441 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
442 return EFI_EXIT(EFI_INVALID_PARAMETER);
443 if (!event[i]->signaled)
444 efi_signal_event(event[i]);
447 /* Wait for signal */
449 for (i = 0; i < num_events; ++i) {
450 if (event[i]->signaled)
453 /* Allow events to occur. */
459 * Reset the signal which is passed to the caller to allow periodic
462 event[i]->signaled = 0;
466 return EFI_EXIT(EFI_SUCCESS);
469 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
473 EFI_ENTRY("%p", event);
474 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
475 if (event != &efi_events[i])
480 if (event->type & EVT_NOTIFY_SIGNAL)
481 efi_signal_event(event);
484 return EFI_EXIT(EFI_SUCCESS);
487 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
491 EFI_ENTRY("%p", event);
492 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
493 if (event == &efi_events[i]) {
495 event->trigger_next = -1ULL;
498 return EFI_EXIT(EFI_SUCCESS);
501 return EFI_EXIT(EFI_INVALID_PARAMETER);
504 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
508 EFI_ENTRY("%p", event);
510 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
511 if (event != &efi_events[i])
513 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
515 if (!event->signaled)
516 efi_signal_event(event);
518 return EFI_EXIT(EFI_SUCCESS);
519 return EFI_EXIT(EFI_NOT_READY);
521 return EFI_EXIT(EFI_INVALID_PARAMETER);
524 static efi_status_t EFIAPI efi_install_protocol_interface(void **handle,
525 efi_guid_t *protocol, int protocol_interface_type,
526 void *protocol_interface)
528 struct list_head *lhandle;
532 if (!handle || !protocol ||
533 protocol_interface_type != EFI_NATIVE_INTERFACE) {
534 r = EFI_INVALID_PARAMETER;
538 /* Create new handle if requested. */
540 r = efi_create_handle(handle);
541 if (r != EFI_SUCCESS)
545 list_for_each(lhandle, &efi_obj_list) {
546 struct efi_object *efiobj;
547 efiobj = list_entry(lhandle, struct efi_object, link);
549 if (efiobj->handle != *handle)
551 /* Check if protocol is already installed on the handle. */
552 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
553 struct efi_handler *handler = &efiobj->protocols[i];
557 if (!guidcmp(handler->guid, protocol)) {
558 r = EFI_INVALID_PARAMETER;
562 /* Install protocol in first empty slot. */
563 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
564 struct efi_handler *handler = &efiobj->protocols[i];
569 handler->guid = protocol;
570 handler->protocol_interface = protocol_interface;
574 r = EFI_OUT_OF_RESOURCES;
577 r = EFI_INVALID_PARAMETER;
582 static efi_status_t EFIAPI efi_install_protocol_interface_ext(void **handle,
583 efi_guid_t *protocol, int protocol_interface_type,
584 void *protocol_interface)
586 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
589 return EFI_EXIT(efi_install_protocol_interface(handle, protocol,
590 protocol_interface_type,
591 protocol_interface));
594 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
595 efi_guid_t *protocol, void *old_interface,
598 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
600 return EFI_EXIT(EFI_ACCESS_DENIED);
603 static efi_status_t EFIAPI efi_uninstall_protocol_interface(void *handle,
604 efi_guid_t *protocol, void *protocol_interface)
606 struct list_head *lhandle;
608 efi_status_t r = EFI_NOT_FOUND;
610 if (!handle || !protocol) {
611 r = EFI_INVALID_PARAMETER;
615 list_for_each(lhandle, &efi_obj_list) {
616 struct efi_object *efiobj;
617 efiobj = list_entry(lhandle, struct efi_object, link);
619 if (efiobj->handle != handle)
622 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
623 struct efi_handler *handler = &efiobj->protocols[i];
624 const efi_guid_t *hprotocol = handler->guid;
628 if (!guidcmp(hprotocol, protocol)) {
629 if (handler->protocol_interface) {
630 r = EFI_ACCESS_DENIED;
644 static efi_status_t EFIAPI efi_uninstall_protocol_interface_ext(void *handle,
645 efi_guid_t *protocol, void *protocol_interface)
647 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
649 return EFI_EXIT(efi_uninstall_protocol_interface(handle, protocol,
650 protocol_interface));
653 static efi_status_t EFIAPI efi_register_protocol_notify(efi_guid_t *protocol,
654 struct efi_event *event,
657 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
658 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
661 static int efi_search(enum efi_locate_search_type search_type,
662 efi_guid_t *protocol, void *search_key,
663 struct efi_object *efiobj)
667 switch (search_type) {
670 case by_register_notify:
673 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
674 const efi_guid_t *guid = efiobj->protocols[i].guid;
675 if (guid && !guidcmp(guid, protocol))
684 static efi_status_t efi_locate_handle(
685 enum efi_locate_search_type search_type,
686 efi_guid_t *protocol, void *search_key,
687 unsigned long *buffer_size, efi_handle_t *buffer)
689 struct list_head *lhandle;
690 unsigned long size = 0;
692 /* Count how much space we need */
693 list_for_each(lhandle, &efi_obj_list) {
694 struct efi_object *efiobj;
695 efiobj = list_entry(lhandle, struct efi_object, link);
696 if (!efi_search(search_type, protocol, search_key, efiobj)) {
697 size += sizeof(void*);
701 if (*buffer_size < size) {
703 return EFI_BUFFER_TOO_SMALL;
708 return EFI_NOT_FOUND;
710 /* Then fill the array */
711 list_for_each(lhandle, &efi_obj_list) {
712 struct efi_object *efiobj;
713 efiobj = list_entry(lhandle, struct efi_object, link);
714 if (!efi_search(search_type, protocol, search_key, efiobj)) {
715 *(buffer++) = efiobj->handle;
722 static efi_status_t EFIAPI efi_locate_handle_ext(
723 enum efi_locate_search_type search_type,
724 efi_guid_t *protocol, void *search_key,
725 unsigned long *buffer_size, efi_handle_t *buffer)
727 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
728 buffer_size, buffer);
730 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
731 buffer_size, buffer));
734 static efi_status_t EFIAPI efi_locate_device_path(efi_guid_t *protocol,
735 struct efi_device_path **device_path,
736 efi_handle_t *device)
738 struct efi_object *efiobj;
740 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
742 efiobj = efi_dp_find_obj(*device_path, device_path);
744 return EFI_EXIT(EFI_NOT_FOUND);
746 *device = efiobj->handle;
748 return EFI_EXIT(EFI_SUCCESS);
751 /* Collapses configuration table entries, removing index i */
752 static void efi_remove_configuration_table(int i)
754 struct efi_configuration_table *this = &efi_conf_table[i];
755 struct efi_configuration_table *next = &efi_conf_table[i+1];
756 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
758 memmove(this, next, (ulong)end - (ulong)next);
762 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
766 /* Check for guid override */
767 for (i = 0; i < systab.nr_tables; i++) {
768 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
770 efi_conf_table[i].table = table;
772 efi_remove_configuration_table(i);
778 return EFI_NOT_FOUND;
780 /* No override, check for overflow */
781 if (i >= ARRAY_SIZE(efi_conf_table))
782 return EFI_OUT_OF_RESOURCES;
784 /* Add a new entry */
785 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
786 efi_conf_table[i].table = table;
787 systab.nr_tables = i + 1;
792 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
795 EFI_ENTRY("%pUl, %p", guid, table);
796 return EFI_EXIT(efi_install_configuration_table(guid, table));
799 /* Initialize a loaded_image_info + loaded_image_info object with correct
800 * protocols, boot-device, etc.
802 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
803 struct efi_device_path *device_path,
804 struct efi_device_path *file_path)
809 * When asking for the device path interface, return
810 * bootefi_device_path
812 obj->protocols[0].guid = &efi_guid_device_path;
813 obj->protocols[0].protocol_interface = device_path;
816 * When asking for the loaded_image interface, just
817 * return handle which points to loaded_image_info
819 obj->protocols[1].guid = &efi_guid_loaded_image;
820 obj->protocols[1].protocol_interface = info;
822 obj->protocols[2].guid = &efi_guid_console_control;
823 obj->protocols[2].protocol_interface = (void *)&efi_console_control;
825 obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
826 obj->protocols[3].protocol_interface =
827 (void *)&efi_device_path_to_text;
829 info->file_path = file_path;
830 info->device_handle = efi_dp_find_obj(device_path, NULL);
832 list_add_tail(&obj->link, &efi_obj_list);
835 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
838 struct efi_file_info *info = NULL;
839 struct efi_file_handle *f;
840 static efi_status_t ret;
843 f = efi_file_from_path(file_path);
845 return EFI_DEVICE_ERROR;
848 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
850 if (ret == EFI_BUFFER_TOO_SMALL) {
852 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
855 if (ret != EFI_SUCCESS)
858 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
862 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
866 EFI_CALL(f->close(f));
868 if (ret != EFI_SUCCESS) {
869 efi_free_pool(*buffer);
876 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
877 efi_handle_t parent_image,
878 struct efi_device_path *file_path,
880 unsigned long source_size,
881 efi_handle_t *image_handle)
883 struct efi_loaded_image *info;
884 struct efi_object *obj;
886 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
887 file_path, source_buffer, source_size, image_handle);
889 info = calloc(1, sizeof(*info));
890 obj = calloc(1, sizeof(*obj));
892 if (!source_buffer) {
893 struct efi_device_path *dp, *fp;
896 ret = efi_load_image_from_path(file_path, &source_buffer);
897 if (ret != EFI_SUCCESS) {
900 return EFI_EXIT(ret);
904 * split file_path which contains both the device and
907 efi_dp_split_file_path(file_path, &dp, &fp);
909 efi_setup_loaded_image(info, obj, dp, fp);
911 /* In this case, file_path is the "device" path, ie.
912 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
914 efi_setup_loaded_image(info, obj, file_path, NULL);
917 info->reserved = efi_load_pe(source_buffer, info);
918 if (!info->reserved) {
921 return EFI_EXIT(EFI_UNSUPPORTED);
924 *image_handle = info;
926 return EFI_EXIT(EFI_SUCCESS);
929 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
930 unsigned long *exit_data_size,
933 ulong (*entry)(void *image_handle, struct efi_system_table *st);
934 struct efi_loaded_image *info = image_handle;
936 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
937 entry = info->reserved;
939 efi_is_direct_boot = false;
941 /* call the image! */
942 if (setjmp(&info->exit_jmp)) {
943 /* We returned from the child image */
944 return EFI_EXIT(info->exit_status);
949 entry(image_handle, &systab);
953 /* Should usually never get here */
954 return EFI_EXIT(EFI_SUCCESS);
957 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
958 efi_status_t exit_status, unsigned long exit_data_size,
961 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
963 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
964 exit_data_size, exit_data);
966 /* Make sure entry/exit counts for EFI world cross-overs match */
970 * But longjmp out with the U-Boot gd, not the application's, as
971 * the other end is a setjmp call inside EFI context.
975 loaded_image_info->exit_status = exit_status;
976 longjmp(&loaded_image_info->exit_jmp, 1);
978 panic("EFI application exited");
981 static struct efi_object *efi_search_obj(void *handle)
983 struct list_head *lhandle;
985 list_for_each(lhandle, &efi_obj_list) {
986 struct efi_object *efiobj;
987 efiobj = list_entry(lhandle, struct efi_object, link);
988 if (efiobj->handle == handle)
995 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
997 struct efi_object *efiobj;
999 EFI_ENTRY("%p", image_handle);
1000 efiobj = efi_search_obj(image_handle);
1002 list_del(&efiobj->link);
1004 return EFI_EXIT(EFI_SUCCESS);
1007 static void efi_exit_caches(void)
1009 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1011 * Grub on 32bit ARM needs to have caches disabled before jumping into
1012 * a zImage, but does not know of all cache layers. Give it a hand.
1014 if (efi_is_direct_boot)
1015 cleanup_before_linux();
1019 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1020 unsigned long map_key)
1024 EFI_ENTRY("%p, %ld", image_handle, map_key);
1026 /* Notify that ExitBootServices is invoked. */
1027 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1028 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1030 efi_signal_event(&efi_events[i]);
1032 /* Make sure that notification functions are not called anymore */
1033 efi_tpl = TPL_HIGH_LEVEL;
1035 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1036 /* save any EFI variables that have been written: */
1040 board_quiesce_devices();
1042 /* Fix up caches for EFI payloads if necessary */
1045 /* This stops all lingering devices */
1046 bootm_disable_interrupts();
1048 /* Give the payload some time to boot */
1051 return EFI_EXIT(EFI_SUCCESS);
1054 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1056 static uint64_t mono = 0;
1057 EFI_ENTRY("%p", count);
1059 return EFI_EXIT(EFI_SUCCESS);
1062 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1064 EFI_ENTRY("%ld", microseconds);
1065 udelay(microseconds);
1066 return EFI_EXIT(EFI_SUCCESS);
1069 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1070 uint64_t watchdog_code,
1071 unsigned long data_size,
1072 uint16_t *watchdog_data)
1074 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1075 data_size, watchdog_data);
1076 return efi_unsupported(__func__);
1079 static efi_status_t EFIAPI efi_connect_controller(
1080 efi_handle_t controller_handle,
1081 efi_handle_t *driver_image_handle,
1082 struct efi_device_path *remain_device_path,
1085 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1086 remain_device_path, recursive);
1087 return EFI_EXIT(EFI_NOT_FOUND);
1090 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1091 void *driver_image_handle,
1094 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1096 return EFI_EXIT(EFI_INVALID_PARAMETER);
1099 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1100 efi_guid_t *protocol,
1102 void *controller_handle)
1104 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1106 return EFI_EXIT(EFI_NOT_FOUND);
1109 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1110 efi_guid_t *protocol,
1111 struct efi_open_protocol_info_entry **entry_buffer,
1112 unsigned long *entry_count)
1114 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1116 return EFI_EXIT(EFI_NOT_FOUND);
1119 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1120 efi_guid_t ***protocol_buffer,
1121 unsigned long *protocol_buffer_count)
1123 unsigned long buffer_size;
1124 struct efi_object *efiobj;
1126 struct list_head *lhandle;
1129 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1130 protocol_buffer_count);
1132 if (!handle || !protocol_buffer || !protocol_buffer_count)
1133 return EFI_EXIT(EFI_INVALID_PARAMETER);
1135 *protocol_buffer = NULL;
1136 *protocol_buffer_count = 0;
1137 list_for_each(lhandle, &efi_obj_list) {
1138 efiobj = list_entry(lhandle, struct efi_object, link);
1140 if (efiobj->handle != handle)
1143 /* Count protocols */
1144 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1145 if (efiobj->protocols[i].guid)
1146 ++*protocol_buffer_count;
1149 if (*protocol_buffer_count) {
1150 buffer_size = sizeof(efi_guid_t *) *
1151 *protocol_buffer_count;
1152 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
1154 (void **)protocol_buffer);
1155 if (r != EFI_SUCCESS)
1158 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
1159 if (efiobj->protocols[i].guid) {
1160 (*protocol_buffer)[j] = (void *)
1161 efiobj->protocols[i].guid;
1169 return EFI_EXIT(EFI_SUCCESS);
1172 static efi_status_t EFIAPI efi_locate_handle_buffer(
1173 enum efi_locate_search_type search_type,
1174 efi_guid_t *protocol, void *search_key,
1175 unsigned long *no_handles, efi_handle_t **buffer)
1178 unsigned long buffer_size = 0;
1180 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1181 no_handles, buffer);
1183 if (!no_handles || !buffer) {
1184 r = EFI_INVALID_PARAMETER;
1189 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1191 if (r != EFI_BUFFER_TOO_SMALL)
1193 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1195 if (r != EFI_SUCCESS)
1197 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1199 if (r == EFI_SUCCESS)
1200 *no_handles = buffer_size / sizeof(void *);
1205 static efi_status_t EFIAPI efi_locate_protocol(efi_guid_t *protocol,
1207 void **protocol_interface)
1209 struct list_head *lhandle;
1212 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1214 if (!protocol || !protocol_interface)
1215 return EFI_EXIT(EFI_INVALID_PARAMETER);
1217 EFI_PRINT_GUID("protocol", protocol);
1219 list_for_each(lhandle, &efi_obj_list) {
1220 struct efi_object *efiobj;
1222 efiobj = list_entry(lhandle, struct efi_object, link);
1223 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1224 struct efi_handler *handler = &efiobj->protocols[i];
1228 if (!guidcmp(handler->guid, protocol)) {
1229 *protocol_interface =
1230 handler->protocol_interface;
1231 return EFI_EXIT(EFI_SUCCESS);
1235 *protocol_interface = NULL;
1237 return EFI_EXIT(EFI_NOT_FOUND);
1240 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1243 EFI_ENTRY("%p", handle);
1246 efi_guid_t *protocol;
1247 void *protocol_interface;
1248 efi_status_t r = EFI_SUCCESS;
1252 return EFI_EXIT(EFI_INVALID_PARAMETER);
1254 va_start(argptr, handle);
1256 protocol = va_arg(argptr, efi_guid_t*);
1259 protocol_interface = va_arg(argptr, void*);
1260 r = efi_install_protocol_interface(handle, protocol,
1261 EFI_NATIVE_INTERFACE,
1262 protocol_interface);
1263 if (r != EFI_SUCCESS)
1268 if (r == EFI_SUCCESS)
1271 /* If an error occured undo all changes. */
1272 va_start(argptr, handle);
1274 protocol = va_arg(argptr, efi_guid_t*);
1275 protocol_interface = va_arg(argptr, void*);
1276 efi_uninstall_protocol_interface(handle, protocol,
1277 protocol_interface);
1284 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
1287 EFI_ENTRY("%p", handle);
1288 return EFI_EXIT(EFI_INVALID_PARAMETER);
1291 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
1292 unsigned long data_size,
1295 EFI_ENTRY("%p, %ld", data, data_size);
1296 *crc32_p = crc32(0, data, data_size);
1297 return EFI_EXIT(EFI_SUCCESS);
1300 static void EFIAPI efi_copy_mem(void *destination, void *source,
1301 unsigned long length)
1303 EFI_ENTRY("%p, %p, %ld", destination, source, length);
1304 memcpy(destination, source, length);
1307 static void EFIAPI efi_set_mem(void *buffer, unsigned long size, uint8_t value)
1309 EFI_ENTRY("%p, %ld, 0x%x", buffer, size, value);
1310 memset(buffer, value, size);
1313 static efi_status_t EFIAPI efi_open_protocol(
1314 void *handle, efi_guid_t *protocol,
1315 void **protocol_interface, void *agent_handle,
1316 void *controller_handle, uint32_t attributes)
1318 struct list_head *lhandle;
1320 efi_status_t r = EFI_INVALID_PARAMETER;
1322 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
1323 protocol_interface, agent_handle, controller_handle,
1326 if (!handle || !protocol ||
1327 (!protocol_interface && attributes !=
1328 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
1332 EFI_PRINT_GUID("protocol", protocol);
1334 switch (attributes) {
1335 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
1336 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
1337 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
1339 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
1340 if (controller_handle == handle)
1342 case EFI_OPEN_PROTOCOL_BY_DRIVER:
1343 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
1344 if (controller_handle == NULL)
1346 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
1347 if (agent_handle == NULL)
1354 list_for_each(lhandle, &efi_obj_list) {
1355 struct efi_object *efiobj;
1356 efiobj = list_entry(lhandle, struct efi_object, link);
1358 if (efiobj->handle != handle)
1361 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1362 struct efi_handler *handler = &efiobj->protocols[i];
1363 const efi_guid_t *hprotocol = handler->guid;
1366 if (!guidcmp(hprotocol, protocol)) {
1368 EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
1369 *protocol_interface =
1370 handler->protocol_interface;
1380 r = EFI_UNSUPPORTED;
1385 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
1386 efi_guid_t *protocol,
1387 void **protocol_interface)
1389 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
1390 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
1393 static const struct efi_boot_services efi_boot_services = {
1395 .headersize = sizeof(struct efi_table_hdr),
1397 .raise_tpl = efi_raise_tpl,
1398 .restore_tpl = efi_restore_tpl,
1399 .allocate_pages = efi_allocate_pages_ext,
1400 .free_pages = efi_free_pages_ext,
1401 .get_memory_map = efi_get_memory_map_ext,
1402 .allocate_pool = efi_allocate_pool_ext,
1403 .free_pool = efi_free_pool_ext,
1404 .create_event = efi_create_event_ext,
1405 .set_timer = efi_set_timer_ext,
1406 .wait_for_event = efi_wait_for_event,
1407 .signal_event = efi_signal_event_ext,
1408 .close_event = efi_close_event,
1409 .check_event = efi_check_event,
1410 .install_protocol_interface = efi_install_protocol_interface_ext,
1411 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
1412 .uninstall_protocol_interface = efi_uninstall_protocol_interface_ext,
1413 .handle_protocol = efi_handle_protocol,
1415 .register_protocol_notify = efi_register_protocol_notify,
1416 .locate_handle = efi_locate_handle_ext,
1417 .locate_device_path = efi_locate_device_path,
1418 .install_configuration_table = efi_install_configuration_table_ext,
1419 .load_image = efi_load_image,
1420 .start_image = efi_start_image,
1422 .unload_image = efi_unload_image,
1423 .exit_boot_services = efi_exit_boot_services,
1424 .get_next_monotonic_count = efi_get_next_monotonic_count,
1426 .set_watchdog_timer = efi_set_watchdog_timer,
1427 .connect_controller = efi_connect_controller,
1428 .disconnect_controller = efi_disconnect_controller,
1429 .open_protocol = efi_open_protocol,
1430 .close_protocol = efi_close_protocol,
1431 .open_protocol_information = efi_open_protocol_information,
1432 .protocols_per_handle = efi_protocols_per_handle,
1433 .locate_handle_buffer = efi_locate_handle_buffer,
1434 .locate_protocol = efi_locate_protocol,
1435 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
1436 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
1437 .calculate_crc32 = efi_calculate_crc32,
1438 .copy_mem = efi_copy_mem,
1439 .set_mem = efi_set_mem,
1443 static uint16_t __efi_runtime_data firmware_vendor[] =
1444 { 'D','a','s',' ','U','-','b','o','o','t',0 };
1446 struct efi_system_table __efi_runtime_data systab = {
1448 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
1449 .revision = 0x20005, /* 2.5 */
1450 .headersize = sizeof(struct efi_table_hdr),
1452 .fw_vendor = (long)firmware_vendor,
1453 .con_in = (void*)&efi_con_in,
1454 .con_out = (void*)&efi_con_out,
1455 .std_err = (void*)&efi_con_out,
1456 .runtime = (void*)&efi_runtime_services,
1457 .boottime = (void*)&efi_boot_services,
1459 .tables = (void*)efi_conf_table,