2 * EFI application boot time services
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
11 #include <efi_loader.h>
12 #include <environment.h>
14 #include <asm/global_data.h>
15 #include <libfdt_env.h>
16 #include <u-boot/crc.h>
21 DECLARE_GLOBAL_DATA_PTR;
23 /* Task priority level */
24 static efi_uintn_t efi_tpl = TPL_APPLICATION;
26 /* This list contains all the EFI objects our payload has access to */
27 LIST_HEAD(efi_obj_list);
30 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
31 * we need to do trickery with caches. Since we don't want to break the EFI
32 * aware boot path, only apply hacks when loading exiting directly (breaking
33 * direct Linux EFI booting along the way - oh well).
35 static bool efi_is_direct_boot = true;
38 * EFI can pass arbitrary additional "tables" containing vendor specific
39 * information to the payload. One such table is the FDT table which contains
40 * a pointer to a flattened device tree blob.
42 * In most cases we want to pass an FDT to the payload, so reserve one slot of
43 * config table space for it. The pointer gets populated by do_bootefi_exec().
45 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
49 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
50 * fixed when compiling U-Boot. However, the payload does not know about that
51 * restriction so we need to manually swap its and our view of that register on
52 * EFI callback entry/exit.
54 static volatile void *efi_gd, *app_gd;
57 static int entry_count;
58 static int nesting_level;
60 /* Called on every callback entry */
61 int __efi_entry_check(void)
63 int ret = entry_count++ == 0;
72 /* Called on every callback exit */
73 int __efi_exit_check(void)
75 int ret = --entry_count == 0;
82 /* Called from do_bootefi_exec() */
83 void efi_save_gd(void)
91 * Special case handler for error/abort that just forces things back
92 * to u-boot world so we can dump out an abort msg, without any care
93 * about returning back to UEFI world.
95 void efi_restore_gd(void)
98 /* Only restore if we're already in EFI context */
106 * Two spaces per indent level, maxing out at 10.. which ought to be
107 * enough for anyone ;-)
109 static const char *indent_string(int level)
111 const char *indent = " ";
112 const int max = strlen(indent);
113 level = min(max, level * 2);
114 return &indent[max - level];
117 const char *__efi_nesting(void)
119 return indent_string(nesting_level);
122 const char *__efi_nesting_inc(void)
124 return indent_string(nesting_level++);
127 const char *__efi_nesting_dec(void)
129 return indent_string(--nesting_level);
133 * Queue an EFI event.
135 * This function queues the notification function of the event for future
138 * The notification function is called if the task priority level of the
139 * event is higher than the current task priority level.
141 * For the SignalEvent service see efi_signal_event_ext.
143 * @event event to signal
145 void efi_signal_event(struct efi_event *event)
147 if (event->notify_function) {
148 event->is_queued = true;
150 if (efi_tpl >= event->notify_tpl)
152 EFI_CALL_VOID(event->notify_function(event,
153 event->notify_context));
155 event->is_queued = false;
159 * Raise the task priority level.
161 * This function implements the RaiseTpl service.
162 * See the Unified Extensible Firmware Interface (UEFI) specification
165 * @new_tpl new value of the task priority level
166 * @return old value of the task priority level
168 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
170 efi_uintn_t old_tpl = efi_tpl;
172 EFI_ENTRY("0x%zx", new_tpl);
174 if (new_tpl < efi_tpl)
175 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
177 if (efi_tpl > TPL_HIGH_LEVEL)
178 efi_tpl = TPL_HIGH_LEVEL;
180 EFI_EXIT(EFI_SUCCESS);
185 * Lower the task priority level.
187 * This function implements the RestoreTpl service.
188 * See the Unified Extensible Firmware Interface (UEFI) specification
191 * @old_tpl value of the task priority level to be restored
193 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
195 EFI_ENTRY("0x%zx", old_tpl);
197 if (old_tpl > efi_tpl)
198 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
200 if (efi_tpl > TPL_HIGH_LEVEL)
201 efi_tpl = TPL_HIGH_LEVEL;
203 EFI_EXIT(EFI_SUCCESS);
207 * Allocate memory pages.
209 * This function implements the AllocatePages service.
210 * See the Unified Extensible Firmware Interface (UEFI) specification
213 * @type type of allocation to be performed
214 * @memory_type usage type of the allocated memory
215 * @pages number of pages to be allocated
216 * @memory allocated memory
217 * @return status code
219 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
225 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
226 r = efi_allocate_pages(type, memory_type, pages, memory);
233 * This function implements the FreePages service.
234 * See the Unified Extensible Firmware Interface (UEFI) specification
237 * @memory start of the memory area to be freed
238 * @pages number of pages to be freed
239 * @return status code
241 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
246 EFI_ENTRY("%"PRIx64", 0x%zx", memory, pages);
247 r = efi_free_pages(memory, pages);
252 * Get map describing memory usage.
254 * This function implements the GetMemoryMap service.
255 * See the Unified Extensible Firmware Interface (UEFI) specification
258 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
259 * on exit the size of the copied memory map
260 * @memory_map buffer to which the memory map is written
261 * @map_key key for the memory map
262 * @descriptor_size size of an individual memory descriptor
263 * @descriptor_version version number of the memory descriptor structure
264 * @return status code
266 static efi_status_t EFIAPI efi_get_memory_map_ext(
267 efi_uintn_t *memory_map_size,
268 struct efi_mem_desc *memory_map,
269 efi_uintn_t *map_key,
270 efi_uintn_t *descriptor_size,
271 uint32_t *descriptor_version)
275 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
276 map_key, descriptor_size, descriptor_version);
277 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
278 descriptor_size, descriptor_version);
283 * Allocate memory from pool.
285 * This function implements the AllocatePool service.
286 * See the Unified Extensible Firmware Interface (UEFI) specification
289 * @pool_type type of the pool from which memory is to be allocated
290 * @size number of bytes to be allocated
291 * @buffer allocated memory
292 * @return status code
294 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
300 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
301 r = efi_allocate_pool(pool_type, size, buffer);
306 * Free memory from pool.
308 * This function implements the FreePool service.
309 * See the Unified Extensible Firmware Interface (UEFI) specification
312 * @buffer start of memory to be freed
313 * @return status code
315 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
319 EFI_ENTRY("%p", buffer);
320 r = efi_free_pool(buffer);
325 * Add a new object to the object list.
327 * The protocols list is initialized.
328 * The object handle is set.
330 * @obj object to be added
332 void efi_add_handle(struct efi_object *obj)
336 INIT_LIST_HEAD(&obj->protocols);
338 list_add_tail(&obj->link, &efi_obj_list);
345 * @return status code
347 efi_status_t efi_create_handle(void **handle)
349 struct efi_object *obj;
352 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
353 sizeof(struct efi_object),
355 if (r != EFI_SUCCESS)
358 *handle = obj->handle;
363 * Find a protocol on a handle.
366 * @protocol_guid GUID of the protocol
367 * @handler reference to the protocol
368 * @return status code
370 efi_status_t efi_search_protocol(const void *handle,
371 const efi_guid_t *protocol_guid,
372 struct efi_handler **handler)
374 struct efi_object *efiobj;
375 struct list_head *lhandle;
377 if (!handle || !protocol_guid)
378 return EFI_INVALID_PARAMETER;
379 efiobj = efi_search_obj(handle);
381 return EFI_INVALID_PARAMETER;
382 list_for_each(lhandle, &efiobj->protocols) {
383 struct efi_handler *protocol;
385 protocol = list_entry(lhandle, struct efi_handler, link);
386 if (!guidcmp(protocol->guid, protocol_guid)) {
392 return EFI_NOT_FOUND;
396 * Delete protocol from a handle.
398 * @handle handle from which the protocol shall be deleted
399 * @protocol GUID of the protocol to be deleted
400 * @protocol_interface interface of the protocol implementation
401 * @return status code
403 efi_status_t efi_remove_protocol(const void *handle, const efi_guid_t *protocol,
404 void *protocol_interface)
406 struct efi_handler *handler;
409 ret = efi_search_protocol(handle, protocol, &handler);
410 if (ret != EFI_SUCCESS)
412 if (guidcmp(handler->guid, protocol))
413 return EFI_INVALID_PARAMETER;
414 list_del(&handler->link);
420 * Delete all protocols from a handle.
422 * @handle handle from which the protocols shall be deleted
423 * @return status code
425 efi_status_t efi_remove_all_protocols(const void *handle)
427 struct efi_object *efiobj;
428 struct efi_handler *protocol;
429 struct efi_handler *pos;
431 efiobj = efi_search_obj(handle);
433 return EFI_INVALID_PARAMETER;
434 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
437 ret = efi_remove_protocol(handle, protocol->guid,
438 protocol->protocol_interface);
439 if (ret != EFI_SUCCESS)
448 * @handle handle to delete
450 void efi_delete_handle(struct efi_object *obj)
454 efi_remove_all_protocols(obj->handle);
455 list_del(&obj->link);
460 * Our event capabilities are very limited. Only a small limited
461 * number of events is allowed to coexist.
463 static struct efi_event efi_events[16];
468 * This function is used inside U-Boot code to create an event.
470 * For the API function implementing the CreateEvent service see
471 * efi_create_event_ext.
473 * @type type of the event to create
474 * @notify_tpl task priority level of the event
475 * @notify_function notification function of the event
476 * @notify_context pointer passed to the notification function
477 * @event created event
478 * @return status code
480 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
481 void (EFIAPI *notify_function) (
482 struct efi_event *event,
484 void *notify_context, struct efi_event **event)
489 return EFI_INVALID_PARAMETER;
491 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
492 return EFI_INVALID_PARAMETER;
494 if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
495 notify_function == NULL)
496 return EFI_INVALID_PARAMETER;
498 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
499 if (efi_events[i].type)
501 efi_events[i].type = type;
502 efi_events[i].notify_tpl = notify_tpl;
503 efi_events[i].notify_function = notify_function;
504 efi_events[i].notify_context = notify_context;
505 /* Disable timers on bootup */
506 efi_events[i].trigger_next = -1ULL;
507 efi_events[i].is_queued = false;
508 efi_events[i].is_signaled = false;
509 *event = &efi_events[i];
512 return EFI_OUT_OF_RESOURCES;
518 * This function implements the CreateEvent service.
519 * See the Unified Extensible Firmware Interface (UEFI) specification
522 * @type type of the event to create
523 * @notify_tpl task priority level of the event
524 * @notify_function notification function of the event
525 * @notify_context pointer passed to the notification function
526 * @event created event
527 * @return status code
529 static efi_status_t EFIAPI efi_create_event_ext(
530 uint32_t type, efi_uintn_t notify_tpl,
531 void (EFIAPI *notify_function) (
532 struct efi_event *event,
534 void *notify_context, struct efi_event **event)
536 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
538 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
539 notify_context, event));
544 * Check if a timer event has occurred or a queued notification function should
547 * Our timers have to work without interrupts, so we check whenever keyboard
548 * input or disk accesses happen if enough time elapsed for them to fire.
550 void efi_timer_check(void)
553 u64 now = timer_get_us();
555 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
556 if (!efi_events[i].type)
558 if (efi_events[i].is_queued)
559 efi_signal_event(&efi_events[i]);
560 if (!(efi_events[i].type & EVT_TIMER) ||
561 now < efi_events[i].trigger_next)
563 switch (efi_events[i].trigger_type) {
564 case EFI_TIMER_RELATIVE:
565 efi_events[i].trigger_type = EFI_TIMER_STOP;
567 case EFI_TIMER_PERIODIC:
568 efi_events[i].trigger_next +=
569 efi_events[i].trigger_time;
574 efi_events[i].is_signaled = true;
575 efi_signal_event(&efi_events[i]);
581 * Set the trigger time for a timer event or stop the event.
583 * This is the function for internal usage in U-Boot. For the API function
584 * implementing the SetTimer service see efi_set_timer_ext.
586 * @event event for which the timer is set
587 * @type type of the timer
588 * @trigger_time trigger period in multiples of 100ns
589 * @return status code
591 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
592 uint64_t trigger_time)
597 * The parameter defines a multiple of 100ns.
598 * We use multiples of 1000ns. So divide by 10.
600 do_div(trigger_time, 10);
602 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
603 if (event != &efi_events[i])
606 if (!(event->type & EVT_TIMER))
610 event->trigger_next = -1ULL;
612 case EFI_TIMER_PERIODIC:
613 case EFI_TIMER_RELATIVE:
614 event->trigger_next =
615 timer_get_us() + trigger_time;
618 return EFI_INVALID_PARAMETER;
620 event->trigger_type = type;
621 event->trigger_time = trigger_time;
622 event->is_signaled = false;
625 return EFI_INVALID_PARAMETER;
629 * Set the trigger time for a timer event or stop the event.
631 * This function implements the SetTimer service.
632 * See the Unified Extensible Firmware Interface (UEFI) specification
635 * @event event for which the timer is set
636 * @type type of the timer
637 * @trigger_time trigger period in multiples of 100ns
638 * @return status code
640 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
641 enum efi_timer_delay type,
642 uint64_t trigger_time)
644 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
645 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
649 * Wait for events to be signaled.
651 * This function implements the WaitForEvent service.
652 * See the Unified Extensible Firmware Interface (UEFI) specification
655 * @num_events number of events to be waited for
656 * @events events to be waited for
657 * @index index of the event that was signaled
658 * @return status code
660 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
661 struct efi_event **event,
666 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
668 /* Check parameters */
669 if (!num_events || !event)
670 return EFI_EXIT(EFI_INVALID_PARAMETER);
672 if (efi_tpl != TPL_APPLICATION)
673 return EFI_EXIT(EFI_UNSUPPORTED);
674 for (i = 0; i < num_events; ++i) {
675 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
676 if (event[i] == &efi_events[j])
679 return EFI_EXIT(EFI_INVALID_PARAMETER);
681 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
682 return EFI_EXIT(EFI_INVALID_PARAMETER);
683 if (!event[i]->is_signaled)
684 efi_signal_event(event[i]);
687 /* Wait for signal */
689 for (i = 0; i < num_events; ++i) {
690 if (event[i]->is_signaled)
693 /* Allow events to occur. */
699 * Reset the signal which is passed to the caller to allow periodic
702 event[i]->is_signaled = false;
706 return EFI_EXIT(EFI_SUCCESS);
710 * Signal an EFI event.
712 * This function implements the SignalEvent service.
713 * See the Unified Extensible Firmware Interface (UEFI) specification
716 * This functions sets the signaled state of the event and queues the
717 * notification function for execution.
719 * @event event to signal
720 * @return status code
722 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
726 EFI_ENTRY("%p", event);
727 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
728 if (event != &efi_events[i])
730 if (event->is_signaled)
732 event->is_signaled = true;
733 if (event->type & EVT_NOTIFY_SIGNAL)
734 efi_signal_event(event);
737 return EFI_EXIT(EFI_SUCCESS);
741 * Close an EFI event.
743 * This function implements the CloseEvent service.
744 * See the Unified Extensible Firmware Interface (UEFI) specification
747 * @event event to close
748 * @return status code
750 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
754 EFI_ENTRY("%p", event);
755 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
756 if (event == &efi_events[i]) {
758 event->trigger_next = -1ULL;
759 event->is_queued = false;
760 event->is_signaled = false;
761 return EFI_EXIT(EFI_SUCCESS);
764 return EFI_EXIT(EFI_INVALID_PARAMETER);
768 * Check if an event is signaled.
770 * This function implements the CheckEvent service.
771 * See the Unified Extensible Firmware Interface (UEFI) specification
774 * If an event is not signaled yet the notification function is queued.
776 * @event event to check
777 * @return status code
779 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
783 EFI_ENTRY("%p", event);
785 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
786 if (event != &efi_events[i])
788 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
790 if (!event->is_signaled)
791 efi_signal_event(event);
792 if (event->is_signaled)
793 return EFI_EXIT(EFI_SUCCESS);
794 return EFI_EXIT(EFI_NOT_READY);
796 return EFI_EXIT(EFI_INVALID_PARAMETER);
800 * Find the internal EFI object for a handle.
802 * @handle handle to find
805 struct efi_object *efi_search_obj(const void *handle)
807 struct efi_object *efiobj;
809 list_for_each_entry(efiobj, &efi_obj_list, link) {
810 if (efiobj->handle == handle)
818 * Create open protocol info entry and add it to a protocol.
820 * @handler handler of a protocol
821 * @return open protocol info entry
823 static struct efi_open_protocol_info_entry *efi_create_open_info(
824 struct efi_handler *handler)
826 struct efi_open_protocol_info_item *item;
828 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
831 /* Append the item to the open protocol info list. */
832 list_add_tail(&item->link, &handler->open_infos);
838 * Remove an open protocol info entry from a protocol.
840 * @handler handler of a protocol
841 * @return status code
843 static efi_status_t efi_delete_open_info(
844 struct efi_open_protocol_info_item *item)
846 list_del(&item->link);
852 * Install new protocol on a handle.
854 * @handle handle on which the protocol shall be installed
855 * @protocol GUID of the protocol to be installed
856 * @protocol_interface interface of the protocol implementation
857 * @return status code
859 efi_status_t efi_add_protocol(const void *handle, const efi_guid_t *protocol,
860 void *protocol_interface)
862 struct efi_object *efiobj;
863 struct efi_handler *handler;
866 efiobj = efi_search_obj(handle);
868 return EFI_INVALID_PARAMETER;
869 ret = efi_search_protocol(handle, protocol, NULL);
870 if (ret != EFI_NOT_FOUND)
871 return EFI_INVALID_PARAMETER;
872 handler = calloc(1, sizeof(struct efi_handler));
874 return EFI_OUT_OF_RESOURCES;
875 handler->guid = protocol;
876 handler->protocol_interface = protocol_interface;
877 INIT_LIST_HEAD(&handler->open_infos);
878 list_add_tail(&handler->link, &efiobj->protocols);
883 * Install protocol interface.
885 * This function implements the InstallProtocolInterface service.
886 * See the Unified Extensible Firmware Interface (UEFI) specification
889 * @handle handle on which the protocol shall be installed
890 * @protocol GUID of the protocol to be installed
891 * @protocol_interface_type type of the interface to be installed,
892 * always EFI_NATIVE_INTERFACE
893 * @protocol_interface interface of the protocol implementation
894 * @return status code
896 static efi_status_t EFIAPI efi_install_protocol_interface(
897 void **handle, const efi_guid_t *protocol,
898 int protocol_interface_type, void *protocol_interface)
902 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
905 if (!handle || !protocol ||
906 protocol_interface_type != EFI_NATIVE_INTERFACE) {
907 r = EFI_INVALID_PARAMETER;
911 /* Create new handle if requested. */
913 r = efi_create_handle(handle);
914 if (r != EFI_SUCCESS)
916 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
919 debug("%sEFI: handle %p\n", indent_string(nesting_level),
922 /* Add new protocol */
923 r = efi_add_protocol(*handle, protocol, protocol_interface);
929 * Reinstall protocol interface.
931 * This function implements the ReinstallProtocolInterface service.
932 * See the Unified Extensible Firmware Interface (UEFI) specification
935 * @handle handle on which the protocol shall be
937 * @protocol GUID of the protocol to be installed
938 * @old_interface interface to be removed
939 * @new_interface interface to be installed
940 * @return status code
942 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
943 const efi_guid_t *protocol, void *old_interface,
946 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
948 return EFI_EXIT(EFI_ACCESS_DENIED);
952 * Uninstall protocol interface.
954 * This function implements the UninstallProtocolInterface service.
955 * See the Unified Extensible Firmware Interface (UEFI) specification
958 * @handle handle from which the protocol shall be removed
959 * @protocol GUID of the protocol to be removed
960 * @protocol_interface interface to be removed
961 * @return status code
963 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
964 void *handle, const efi_guid_t *protocol,
965 void *protocol_interface)
967 struct efi_handler *handler;
970 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
972 if (!handle || !protocol) {
973 r = EFI_INVALID_PARAMETER;
977 /* Find the protocol on the handle */
978 r = efi_search_protocol(handle, protocol, &handler);
979 if (r != EFI_SUCCESS)
981 if (handler->protocol_interface) {
982 /* TODO disconnect controllers */
983 r = EFI_ACCESS_DENIED;
985 r = efi_remove_protocol(handle, protocol, protocol_interface);
992 * Register an event for notification when a protocol is installed.
994 * This function implements the RegisterProtocolNotify service.
995 * See the Unified Extensible Firmware Interface (UEFI) specification
998 * @protocol GUID of the protocol whose installation shall be
1000 * @event event to be signaled upon installation of the protocol
1001 * @registration key for retrieving the registration information
1002 * @return status code
1004 static efi_status_t EFIAPI efi_register_protocol_notify(
1005 const efi_guid_t *protocol,
1006 struct efi_event *event,
1007 void **registration)
1009 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1010 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1014 * Determine if an EFI handle implements a protocol.
1016 * See the documentation of the LocateHandle service in the UEFI specification.
1018 * @search_type selection criterion
1019 * @protocol GUID of the protocol
1020 * @search_key registration key
1022 * @return 0 if the handle implements the protocol
1024 static int efi_search(enum efi_locate_search_type search_type,
1025 const efi_guid_t *protocol, void *search_key,
1026 struct efi_object *efiobj)
1030 switch (search_type) {
1033 case BY_REGISTER_NOTIFY:
1034 /* TODO: RegisterProtocolNotify is not implemented yet */
1037 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1038 return (ret != EFI_SUCCESS);
1040 /* Invalid search type */
1046 * Locate handles implementing a protocol.
1048 * This function is meant for U-Boot internal calls. For the API implementation
1049 * of the LocateHandle service see efi_locate_handle_ext.
1051 * @search_type selection criterion
1052 * @protocol GUID of the protocol
1053 * @search_key registration key
1054 * @buffer_size size of the buffer to receive the handles in bytes
1055 * @buffer buffer to receive the relevant handles
1056 * @return status code
1058 static efi_status_t efi_locate_handle(
1059 enum efi_locate_search_type search_type,
1060 const efi_guid_t *protocol, void *search_key,
1061 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1063 struct efi_object *efiobj;
1064 efi_uintn_t size = 0;
1066 /* Check parameters */
1067 switch (search_type) {
1070 case BY_REGISTER_NOTIFY:
1072 return EFI_INVALID_PARAMETER;
1073 /* RegisterProtocolNotify is not implemented yet */
1074 return EFI_UNSUPPORTED;
1077 return EFI_INVALID_PARAMETER;
1080 return EFI_INVALID_PARAMETER;
1084 * efi_locate_handle_buffer uses this function for
1085 * the calculation of the necessary buffer size.
1086 * So do not require a buffer for buffersize == 0.
1088 if (!buffer_size || (*buffer_size && !buffer))
1089 return EFI_INVALID_PARAMETER;
1091 /* Count how much space we need */
1092 list_for_each_entry(efiobj, &efi_obj_list, link) {
1093 if (!efi_search(search_type, protocol, search_key, efiobj))
1094 size += sizeof(void*);
1097 if (*buffer_size < size) {
1098 *buffer_size = size;
1099 return EFI_BUFFER_TOO_SMALL;
1102 *buffer_size = size;
1104 return EFI_NOT_FOUND;
1106 /* Then fill the array */
1107 list_for_each_entry(efiobj, &efi_obj_list, link) {
1108 if (!efi_search(search_type, protocol, search_key, efiobj))
1109 *buffer++ = efiobj->handle;
1116 * Locate handles implementing a protocol.
1118 * This function implements the LocateHandle service.
1119 * See the Unified Extensible Firmware Interface (UEFI) specification
1122 * @search_type selection criterion
1123 * @protocol GUID of the protocol
1124 * @search_key registration key
1125 * @buffer_size size of the buffer to receive the handles in bytes
1126 * @buffer buffer to receive the relevant handles
1127 * @return 0 if the handle implements the protocol
1129 static efi_status_t EFIAPI efi_locate_handle_ext(
1130 enum efi_locate_search_type search_type,
1131 const efi_guid_t *protocol, void *search_key,
1132 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1134 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1135 buffer_size, buffer);
1137 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1138 buffer_size, buffer));
1141 /* Collapses configuration table entries, removing index i */
1142 static void efi_remove_configuration_table(int i)
1144 struct efi_configuration_table *this = &efi_conf_table[i];
1145 struct efi_configuration_table *next = &efi_conf_table[i+1];
1146 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1148 memmove(this, next, (ulong)end - (ulong)next);
1153 * Adds, updates, or removes a configuration table.
1155 * This function is used for internal calls. For the API implementation of the
1156 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1158 * @guid GUID of the installed table
1159 * @table table to be installed
1160 * @return status code
1162 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1166 /* Check for guid override */
1167 for (i = 0; i < systab.nr_tables; i++) {
1168 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1170 efi_conf_table[i].table = table;
1172 efi_remove_configuration_table(i);
1178 return EFI_NOT_FOUND;
1180 /* No override, check for overflow */
1181 if (i >= ARRAY_SIZE(efi_conf_table))
1182 return EFI_OUT_OF_RESOURCES;
1184 /* Add a new entry */
1185 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1186 efi_conf_table[i].table = table;
1187 systab.nr_tables = i + 1;
1193 * Adds, updates, or removes a configuration table.
1195 * This function implements the InstallConfigurationTable service.
1196 * See the Unified Extensible Firmware Interface (UEFI) specification
1199 * @guid GUID of the installed table
1200 * @table table to be installed
1201 * @return status code
1203 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1206 EFI_ENTRY("%pUl, %p", guid, table);
1207 return EFI_EXIT(efi_install_configuration_table(guid, table));
1211 * Initialize a loaded_image_info + loaded_image_info object with correct
1212 * protocols, boot-device, etc.
1214 * @info loaded image info to be passed to the entry point of the
1216 * @obj internal object associated with the loaded image
1217 * @device_path device path of the loaded image
1218 * @file_path file path of the loaded image
1219 * @return status code
1221 efi_status_t efi_setup_loaded_image(
1222 struct efi_loaded_image *info, struct efi_object *obj,
1223 struct efi_device_path *device_path,
1224 struct efi_device_path *file_path)
1228 /* Add internal object to object list */
1229 efi_add_handle(obj);
1230 /* efi_exit() assumes that the handle points to the info */
1233 info->file_path = file_path;
1235 info->device_handle = efi_dp_find_obj(device_path, NULL);
1238 * When asking for the device path interface, return
1239 * bootefi_device_path
1241 ret = efi_add_protocol(obj->handle, &efi_guid_device_path, device_path);
1242 if (ret != EFI_SUCCESS)
1246 * When asking for the loaded_image interface, just
1247 * return handle which points to loaded_image_info
1249 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1250 if (ret != EFI_SUCCESS)
1253 ret = efi_add_protocol(obj->handle, &efi_guid_console_control,
1254 (void *)&efi_console_control);
1255 if (ret != EFI_SUCCESS)
1258 ret = efi_add_protocol(obj->handle,
1259 &efi_guid_device_path_to_text_protocol,
1260 (void *)&efi_device_path_to_text);
1261 if (ret != EFI_SUCCESS)
1266 printf("ERROR: Failure to install protocols for loaded image\n");
1271 * Load an image using a file path.
1273 * @file_path the path of the image to load
1274 * @buffer buffer containing the loaded image
1275 * @return status code
1277 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1280 struct efi_file_info *info = NULL;
1281 struct efi_file_handle *f;
1282 static efi_status_t ret;
1285 f = efi_file_from_path(file_path);
1287 return EFI_DEVICE_ERROR;
1290 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1292 if (ret == EFI_BUFFER_TOO_SMALL) {
1294 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1297 if (ret != EFI_SUCCESS)
1300 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1304 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1308 EFI_CALL(f->close(f));
1310 if (ret != EFI_SUCCESS) {
1311 efi_free_pool(*buffer);
1319 * Load an EFI image into memory.
1321 * This function implements the LoadImage service.
1322 * See the Unified Extensible Firmware Interface (UEFI) specification
1325 * @boot_policy true for request originating from the boot manager
1326 * @parent_image the calles's image handle
1327 * @file_path the path of the image to load
1328 * @source_buffer memory location from which the image is installed
1329 * @source_size size of the memory area from which the image is
1331 * @image_handle handle for the newly installed image
1332 * @return status code
1334 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1335 efi_handle_t parent_image,
1336 struct efi_device_path *file_path,
1337 void *source_buffer,
1338 unsigned long source_size,
1339 efi_handle_t *image_handle)
1341 struct efi_loaded_image *info;
1342 struct efi_object *obj;
1345 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1346 file_path, source_buffer, source_size, image_handle);
1348 info = calloc(1, sizeof(*info));
1349 obj = calloc(1, sizeof(*obj));
1351 if (!source_buffer) {
1352 struct efi_device_path *dp, *fp;
1354 ret = efi_load_image_from_path(file_path, &source_buffer);
1355 if (ret != EFI_SUCCESS)
1358 * split file_path which contains both the device and
1361 efi_dp_split_file_path(file_path, &dp, &fp);
1362 ret = efi_setup_loaded_image(info, obj, dp, fp);
1363 if (ret != EFI_SUCCESS)
1366 /* In this case, file_path is the "device" path, ie.
1367 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1369 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1370 if (ret != EFI_SUCCESS)
1373 info->reserved = efi_load_pe(source_buffer, info);
1374 if (!info->reserved) {
1375 ret = EFI_UNSUPPORTED;
1378 info->system_table = &systab;
1379 info->parent_handle = parent_image;
1380 *image_handle = obj->handle;
1381 return EFI_EXIT(EFI_SUCCESS);
1384 efi_delete_handle(obj);
1385 return EFI_EXIT(ret);
1389 * Call the entry point of an image.
1391 * This function implements the StartImage service.
1392 * See the Unified Extensible Firmware Interface (UEFI) specification
1395 * @image_handle handle of the image
1396 * @exit_data_size size of the buffer
1397 * @exit_data buffer to receive the exit data of the called image
1398 * @return status code
1400 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1401 unsigned long *exit_data_size,
1404 ulong (*entry)(void *image_handle, struct efi_system_table *st);
1405 struct efi_loaded_image *info = image_handle;
1408 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1409 entry = info->reserved;
1411 efi_is_direct_boot = false;
1413 /* call the image! */
1414 if (setjmp(&info->exit_jmp)) {
1416 * We called the entry point of the child image with EFI_CALL
1417 * in the lines below. The child image called the Exit() boot
1418 * service efi_exit() which executed the long jump that brought
1419 * us to the current line. This implies that the second half
1420 * of the EFI_CALL macro has not been executed.
1424 * efi_exit() called efi_restore_gd(). We have to undo this
1425 * otherwise __efi_entry_check() will put the wrong value into
1431 * To get ready to call EFI_EXIT below we have to execute the
1432 * missed out steps of EFI_CALL.
1434 assert(__efi_entry_check());
1435 debug("%sEFI: %lu returned by started image\n",
1436 __efi_nesting_dec(),
1437 (unsigned long)((uintptr_t)info->exit_status &
1439 return EFI_EXIT(info->exit_status);
1442 ret = EFI_CALL(entry(image_handle, &systab));
1444 /* Should usually never get here */
1445 return EFI_EXIT(ret);
1449 * Leave an EFI application or driver.
1451 * This function implements the Exit service.
1452 * See the Unified Extensible Firmware Interface (UEFI) specification
1455 * @image_handle handle of the application or driver that is exiting
1456 * @exit_status status code
1457 * @exit_data_size size of the buffer in bytes
1458 * @exit_data buffer with data describing an error
1459 * @return status code
1461 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1462 efi_status_t exit_status, unsigned long exit_data_size,
1466 * We require that the handle points to the original loaded
1467 * image protocol interface.
1469 * For getting the longjmp address this is safer than locating
1470 * the protocol because the protocol may have been reinstalled
1471 * pointing to another memory location.
1473 * TODO: We should call the unload procedure of the loaded
1476 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1478 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1479 exit_data_size, exit_data);
1481 /* Make sure entry/exit counts for EFI world cross-overs match */
1482 EFI_EXIT(exit_status);
1485 * But longjmp out with the U-Boot gd, not the application's, as
1486 * the other end is a setjmp call inside EFI context.
1490 loaded_image_info->exit_status = exit_status;
1491 longjmp(&loaded_image_info->exit_jmp, 1);
1493 panic("EFI application exited");
1497 * Unload an EFI image.
1499 * This function implements the UnloadImage service.
1500 * See the Unified Extensible Firmware Interface (UEFI) specification
1503 * @image_handle handle of the image to be unloaded
1504 * @return status code
1506 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1508 struct efi_object *efiobj;
1510 EFI_ENTRY("%p", image_handle);
1511 efiobj = efi_search_obj(image_handle);
1513 list_del(&efiobj->link);
1515 return EFI_EXIT(EFI_SUCCESS);
1519 * Fix up caches for EFI payloads if necessary.
1521 static void efi_exit_caches(void)
1523 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1525 * Grub on 32bit ARM needs to have caches disabled before jumping into
1526 * a zImage, but does not know of all cache layers. Give it a hand.
1528 if (efi_is_direct_boot)
1529 cleanup_before_linux();
1534 * Stop boot services.
1536 * This function implements the ExitBootServices service.
1537 * See the Unified Extensible Firmware Interface (UEFI) specification
1540 * @image_handle handle of the loaded image
1541 * @map_key key of the memory map
1542 * @return status code
1544 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1545 unsigned long map_key)
1549 EFI_ENTRY("%p, %ld", image_handle, map_key);
1551 /* Notify that ExitBootServices is invoked. */
1552 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1553 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1555 efi_signal_event(&efi_events[i]);
1557 /* Make sure that notification functions are not called anymore */
1558 efi_tpl = TPL_HIGH_LEVEL;
1560 /* XXX Should persist EFI variables here */
1562 board_quiesce_devices();
1564 /* Fix up caches for EFI payloads if necessary */
1567 /* This stops all lingering devices */
1568 bootm_disable_interrupts();
1570 /* Give the payload some time to boot */
1571 efi_set_watchdog(0);
1574 return EFI_EXIT(EFI_SUCCESS);
1578 * Get next value of the counter.
1580 * This function implements the NextMonotonicCount service.
1581 * See the Unified Extensible Firmware Interface (UEFI) specification
1584 * @count returned value of the counter
1585 * @return status code
1587 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1589 static uint64_t mono = 0;
1590 EFI_ENTRY("%p", count);
1592 return EFI_EXIT(EFI_SUCCESS);
1598 * This function implements the Stall sercive.
1599 * See the Unified Extensible Firmware Interface (UEFI) specification
1602 * @microseconds period to sleep in microseconds
1603 * @return status code
1605 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1607 EFI_ENTRY("%ld", microseconds);
1608 udelay(microseconds);
1609 return EFI_EXIT(EFI_SUCCESS);
1613 * Reset the watchdog timer.
1615 * This function implements the SetWatchdogTimer service.
1616 * See the Unified Extensible Firmware Interface (UEFI) specification
1619 * @timeout seconds before reset by watchdog
1620 * @watchdog_code code to be logged when resetting
1621 * @data_size size of buffer in bytes
1622 * @watchdog_data buffer with data describing the reset reason
1623 * @return status code
1625 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1626 uint64_t watchdog_code,
1627 unsigned long data_size,
1628 uint16_t *watchdog_data)
1630 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1631 data_size, watchdog_data);
1632 return EFI_EXIT(efi_set_watchdog(timeout));
1636 * Connect a controller to a driver.
1638 * This function implements the ConnectController service.
1639 * See the Unified Extensible Firmware Interface (UEFI) specification
1642 * @controller_handle handle of the controller
1643 * @driver_image_handle handle of the driver
1644 * @remain_device_path device path of a child controller
1645 * @recursive true to connect all child controllers
1646 * @return status code
1648 static efi_status_t EFIAPI efi_connect_controller(
1649 efi_handle_t controller_handle,
1650 efi_handle_t *driver_image_handle,
1651 struct efi_device_path *remain_device_path,
1654 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1655 remain_device_path, recursive);
1656 return EFI_EXIT(EFI_NOT_FOUND);
1660 * Disconnect a controller from a driver.
1662 * This function implements the DisconnectController service.
1663 * See the Unified Extensible Firmware Interface (UEFI) specification
1666 * @controller_handle handle of the controller
1667 * @driver_image_handle handle of the driver
1668 * @child_handle handle of the child to destroy
1669 * @return status code
1671 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1672 void *driver_image_handle,
1675 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1677 return EFI_EXIT(EFI_INVALID_PARAMETER);
1683 * This function implements the CloseProtocol service.
1684 * See the Unified Extensible Firmware Interface (UEFI) specification
1687 * @handle handle on which the protocol shall be closed
1688 * @protocol GUID of the protocol to close
1689 * @agent_handle handle of the driver
1690 * @controller_handle handle of the controller
1691 * @return status code
1693 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1694 const efi_guid_t *protocol,
1696 void *controller_handle)
1698 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1700 return EFI_EXIT(EFI_NOT_FOUND);
1704 * Provide information about then open status of a protocol on a handle
1706 * This function implements the OpenProtocolInformation service.
1707 * See the Unified Extensible Firmware Interface (UEFI) specification
1710 * @handle handle for which the information shall be retrieved
1711 * @protocol GUID of the protocol
1712 * @entry_buffer buffer to receive the open protocol information
1713 * @entry_count number of entries available in the buffer
1714 * @return status code
1716 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1717 const efi_guid_t *protocol,
1718 struct efi_open_protocol_info_entry **entry_buffer,
1719 efi_uintn_t *entry_count)
1721 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1723 return EFI_EXIT(EFI_NOT_FOUND);
1727 * Get protocols installed on a handle.
1729 * This function implements the ProtocolsPerHandleService.
1730 * See the Unified Extensible Firmware Interface (UEFI) specification
1733 * @handle handle for which the information is retrieved
1734 * @protocol_buffer buffer with protocol GUIDs
1735 * @protocol_buffer_count number of entries in the buffer
1736 * @return status code
1738 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1739 efi_guid_t ***protocol_buffer,
1740 efi_uintn_t *protocol_buffer_count)
1742 unsigned long buffer_size;
1743 struct efi_object *efiobj;
1744 struct list_head *protocol_handle;
1747 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1748 protocol_buffer_count);
1750 if (!handle || !protocol_buffer || !protocol_buffer_count)
1751 return EFI_EXIT(EFI_INVALID_PARAMETER);
1753 *protocol_buffer = NULL;
1754 *protocol_buffer_count = 0;
1756 efiobj = efi_search_obj(handle);
1758 return EFI_EXIT(EFI_INVALID_PARAMETER);
1760 /* Count protocols */
1761 list_for_each(protocol_handle, &efiobj->protocols) {
1762 ++*protocol_buffer_count;
1766 if (*protocol_buffer_count) {
1769 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
1770 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1771 (void **)protocol_buffer);
1772 if (r != EFI_SUCCESS)
1774 list_for_each(protocol_handle, &efiobj->protocols) {
1775 struct efi_handler *protocol;
1777 protocol = list_entry(protocol_handle,
1778 struct efi_handler, link);
1779 (*protocol_buffer)[j] = (void *)protocol->guid;
1784 return EFI_EXIT(EFI_SUCCESS);
1788 * Locate handles implementing a protocol.
1790 * This function implements the LocateHandleBuffer service.
1791 * See the Unified Extensible Firmware Interface (UEFI) specification
1794 * @search_type selection criterion
1795 * @protocol GUID of the protocol
1796 * @search_key registration key
1797 * @no_handles number of returned handles
1798 * @buffer buffer with the returned handles
1799 * @return status code
1801 static efi_status_t EFIAPI efi_locate_handle_buffer(
1802 enum efi_locate_search_type search_type,
1803 const efi_guid_t *protocol, void *search_key,
1804 efi_uintn_t *no_handles, efi_handle_t **buffer)
1807 efi_uintn_t buffer_size = 0;
1809 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1810 no_handles, buffer);
1812 if (!no_handles || !buffer) {
1813 r = EFI_INVALID_PARAMETER;
1818 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1820 if (r != EFI_BUFFER_TOO_SMALL)
1822 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1824 if (r != EFI_SUCCESS)
1826 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1828 if (r == EFI_SUCCESS)
1829 *no_handles = buffer_size / sizeof(void *);
1835 * Find an interface implementing a protocol.
1837 * This function implements the LocateProtocol service.
1838 * See the Unified Extensible Firmware Interface (UEFI) specification
1841 * @protocol GUID of the protocol
1842 * @registration registration key passed to the notification function
1843 * @protocol_interface interface implementing the protocol
1844 * @return status code
1846 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1848 void **protocol_interface)
1850 struct list_head *lhandle;
1853 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1855 if (!protocol || !protocol_interface)
1856 return EFI_EXIT(EFI_INVALID_PARAMETER);
1858 list_for_each(lhandle, &efi_obj_list) {
1859 struct efi_object *efiobj;
1860 struct efi_handler *handler;
1862 efiobj = list_entry(lhandle, struct efi_object, link);
1864 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
1865 if (ret == EFI_SUCCESS) {
1866 *protocol_interface = handler->protocol_interface;
1867 return EFI_EXIT(EFI_SUCCESS);
1870 *protocol_interface = NULL;
1872 return EFI_EXIT(EFI_NOT_FOUND);
1876 * Get the device path and handle of an device implementing a protocol.
1878 * This function implements the LocateDevicePath service.
1879 * See the Unified Extensible Firmware Interface (UEFI) specification
1882 * @protocol GUID of the protocol
1883 * @device_path device path
1884 * @device handle of the device
1885 * @return status code
1887 static efi_status_t EFIAPI efi_locate_device_path(
1888 const efi_guid_t *protocol,
1889 struct efi_device_path **device_path,
1890 efi_handle_t *device)
1892 struct efi_device_path *dp;
1894 struct efi_handler *handler;
1895 efi_handle_t *handles;
1897 size_t len_best = 0;
1898 efi_uintn_t no_handles;
1902 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1904 if (!protocol || !device_path || !*device_path || !device) {
1905 ret = EFI_INVALID_PARAMETER;
1909 /* Find end of device path */
1910 len = efi_dp_size(*device_path);
1912 /* Get all handles implementing the protocol */
1913 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1914 &no_handles, &handles));
1915 if (ret != EFI_SUCCESS)
1918 for (i = 0; i < no_handles; ++i) {
1919 /* Find the device path protocol */
1920 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1922 if (ret != EFI_SUCCESS)
1924 dp = (struct efi_device_path *)handler->protocol_interface;
1925 len_dp = efi_dp_size(dp);
1927 * This handle can only be a better fit
1928 * if its device path length is longer than the best fit and
1929 * if its device path length is shorter of equal the searched
1932 if (len_dp <= len_best || len_dp > len)
1934 /* Check if dp is a subpath of device_path */
1935 if (memcmp(*device_path, dp, len_dp))
1937 *device = handles[i];
1941 remainder = (u8 *)*device_path + len_best;
1942 *device_path = (struct efi_device_path *)remainder;
1945 ret = EFI_NOT_FOUND;
1948 return EFI_EXIT(ret);
1952 * Install multiple protocol interfaces.
1954 * This function implements the MultipleProtocolInterfaces service.
1955 * See the Unified Extensible Firmware Interface (UEFI) specification
1958 * @handle handle on which the protocol interfaces shall be installed
1959 * @... NULL terminated argument list with pairs of protocol GUIDS and
1961 * @return status code
1963 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1966 EFI_ENTRY("%p", handle);
1969 const efi_guid_t *protocol;
1970 void *protocol_interface;
1971 efi_status_t r = EFI_SUCCESS;
1975 return EFI_EXIT(EFI_INVALID_PARAMETER);
1977 va_start(argptr, handle);
1979 protocol = va_arg(argptr, efi_guid_t*);
1982 protocol_interface = va_arg(argptr, void*);
1983 r = EFI_CALL(efi_install_protocol_interface(
1985 EFI_NATIVE_INTERFACE,
1986 protocol_interface));
1987 if (r != EFI_SUCCESS)
1992 if (r == EFI_SUCCESS)
1995 /* If an error occurred undo all changes. */
1996 va_start(argptr, handle);
1998 protocol = va_arg(argptr, efi_guid_t*);
1999 protocol_interface = va_arg(argptr, void*);
2000 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2001 protocol_interface));
2009 * Uninstall multiple protocol interfaces.
2011 * This function implements the UninstallMultipleProtocolInterfaces service.
2012 * See the Unified Extensible Firmware Interface (UEFI) specification
2015 * @handle handle from which the protocol interfaces shall be removed
2016 * @... NULL terminated argument list with pairs of protocol GUIDS and
2018 * @return status code
2020 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2023 EFI_ENTRY("%p", handle);
2026 const efi_guid_t *protocol;
2027 void *protocol_interface;
2028 efi_status_t r = EFI_SUCCESS;
2032 return EFI_EXIT(EFI_INVALID_PARAMETER);
2034 va_start(argptr, handle);
2036 protocol = va_arg(argptr, efi_guid_t*);
2039 protocol_interface = va_arg(argptr, void*);
2040 r = EFI_CALL(efi_uninstall_protocol_interface(
2042 protocol_interface));
2043 if (r != EFI_SUCCESS)
2048 if (r == EFI_SUCCESS)
2051 /* If an error occurred undo all changes. */
2052 va_start(argptr, handle);
2054 protocol = va_arg(argptr, efi_guid_t*);
2055 protocol_interface = va_arg(argptr, void*);
2056 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2057 EFI_NATIVE_INTERFACE,
2058 protocol_interface));
2066 * Calculate cyclic redundancy code.
2068 * This function implements the CalculateCrc32 service.
2069 * See the Unified Extensible Firmware Interface (UEFI) specification
2072 * @data buffer with data
2073 * @data_size size of buffer in bytes
2074 * @crc32_p cyclic redundancy code
2075 * @return status code
2077 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2078 unsigned long data_size,
2081 EFI_ENTRY("%p, %ld", data, data_size);
2082 *crc32_p = crc32(0, data, data_size);
2083 return EFI_EXIT(EFI_SUCCESS);
2089 * This function implements the CopyMem service.
2090 * See the Unified Extensible Firmware Interface (UEFI) specification
2093 * @destination destination of the copy operation
2094 * @source source of the copy operation
2095 * @length number of bytes to copy
2097 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2100 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2101 memcpy(destination, source, length);
2102 EFI_EXIT(EFI_SUCCESS);
2106 * Fill memory with a byte value.
2108 * This function implements the SetMem service.
2109 * See the Unified Extensible Firmware Interface (UEFI) specification
2112 * @buffer buffer to fill
2113 * @size size of buffer in bytes
2114 * @value byte to copy to the buffer
2116 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2118 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2119 memset(buffer, value, size);
2120 EFI_EXIT(EFI_SUCCESS);
2124 * Open protocol interface on a handle.
2126 * @handler handler of a protocol
2127 * @protocol_interface interface implementing the protocol
2128 * @agent_handle handle of the driver
2129 * @controller_handle handle of the controller
2130 * @attributes attributes indicating how to open the protocol
2131 * @return status code
2133 static efi_status_t efi_protocol_open(
2134 struct efi_handler *handler,
2135 void **protocol_interface, void *agent_handle,
2136 void *controller_handle, uint32_t attributes)
2138 struct efi_open_protocol_info_item *item;
2139 struct efi_open_protocol_info_entry *match = NULL;
2140 bool opened_by_driver = false;
2141 bool opened_exclusive = false;
2143 /* If there is no agent, only return the interface */
2147 /* For TEST_PROTOCOL ignore interface attribute */
2148 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2149 *protocol_interface = NULL;
2152 * Check if the protocol is already opened by a driver with the same
2153 * attributes or opened exclusively
2155 list_for_each_entry(item, &handler->open_infos, link) {
2156 if (item->info.agent_handle == agent_handle) {
2157 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2158 (item->info.attributes == attributes))
2159 return EFI_ALREADY_STARTED;
2161 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2162 opened_exclusive = true;
2165 /* Only one controller can open the protocol exclusively */
2166 if (opened_exclusive && attributes &
2167 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2168 return EFI_ACCESS_DENIED;
2170 /* Prepare exclusive opening */
2171 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2172 /* Try to disconnect controllers */
2173 list_for_each_entry(item, &handler->open_infos, link) {
2174 if (item->info.attributes ==
2175 EFI_OPEN_PROTOCOL_BY_DRIVER)
2176 EFI_CALL(efi_disconnect_controller(
2177 item->info.controller_handle,
2178 item->info.agent_handle,
2181 opened_by_driver = false;
2182 /* Check if all controllers are disconnected */
2183 list_for_each_entry(item, &handler->open_infos, link) {
2184 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2185 opened_by_driver = true;
2187 /* Only one controller can be conncected */
2188 if (opened_by_driver)
2189 return EFI_ACCESS_DENIED;
2192 /* Find existing entry */
2193 list_for_each_entry(item, &handler->open_infos, link) {
2194 if (item->info.agent_handle == agent_handle &&
2195 item->info.controller_handle == controller_handle)
2196 match = &item->info;
2198 /* None found, create one */
2200 match = efi_create_open_info(handler);
2202 return EFI_OUT_OF_RESOURCES;
2205 match->agent_handle = agent_handle;
2206 match->controller_handle = controller_handle;
2207 match->attributes = attributes;
2208 match->open_count++;
2211 /* For TEST_PROTOCOL ignore interface attribute. */
2212 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2213 *protocol_interface = handler->protocol_interface;
2219 * Open protocol interface on a handle.
2221 * This function implements the OpenProtocol interface.
2222 * See the Unified Extensible Firmware Interface (UEFI) specification
2225 * @handle handle on which the protocol shall be opened
2226 * @protocol GUID of the protocol
2227 * @protocol_interface interface implementing the protocol
2228 * @agent_handle handle of the driver
2229 * @controller_handle handle of the controller
2230 * @attributes attributes indicating how to open the protocol
2231 * @return status code
2233 static efi_status_t EFIAPI efi_open_protocol(
2234 void *handle, const efi_guid_t *protocol,
2235 void **protocol_interface, void *agent_handle,
2236 void *controller_handle, uint32_t attributes)
2238 struct efi_handler *handler;
2239 efi_status_t r = EFI_INVALID_PARAMETER;
2241 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2242 protocol_interface, agent_handle, controller_handle,
2245 if (!handle || !protocol ||
2246 (!protocol_interface && attributes !=
2247 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2251 switch (attributes) {
2252 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2253 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2254 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2256 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2257 if (controller_handle == handle)
2260 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2261 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2262 /* Check that the controller handle is valid */
2263 if (!efi_search_obj(controller_handle))
2266 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2267 /* Check that the agent handle is valid */
2268 if (!efi_search_obj(agent_handle))
2275 r = efi_search_protocol(handle, protocol, &handler);
2276 if (r != EFI_SUCCESS)
2279 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2280 controller_handle, attributes);
2286 * Get interface of a protocol on a handle.
2288 * This function implements the HandleProtocol service.
2289 * See the Unified Extensible Firmware Interface (UEFI) specification
2292 * @handle handle on which the protocol shall be opened
2293 * @protocol GUID of the protocol
2294 * @protocol_interface interface implementing the protocol
2295 * @return status code
2297 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
2298 const efi_guid_t *protocol,
2299 void **protocol_interface)
2301 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2302 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2305 static const struct efi_boot_services efi_boot_services = {
2307 .headersize = sizeof(struct efi_table_hdr),
2309 .raise_tpl = efi_raise_tpl,
2310 .restore_tpl = efi_restore_tpl,
2311 .allocate_pages = efi_allocate_pages_ext,
2312 .free_pages = efi_free_pages_ext,
2313 .get_memory_map = efi_get_memory_map_ext,
2314 .allocate_pool = efi_allocate_pool_ext,
2315 .free_pool = efi_free_pool_ext,
2316 .create_event = efi_create_event_ext,
2317 .set_timer = efi_set_timer_ext,
2318 .wait_for_event = efi_wait_for_event,
2319 .signal_event = efi_signal_event_ext,
2320 .close_event = efi_close_event,
2321 .check_event = efi_check_event,
2322 .install_protocol_interface = efi_install_protocol_interface,
2323 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2324 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2325 .handle_protocol = efi_handle_protocol,
2327 .register_protocol_notify = efi_register_protocol_notify,
2328 .locate_handle = efi_locate_handle_ext,
2329 .locate_device_path = efi_locate_device_path,
2330 .install_configuration_table = efi_install_configuration_table_ext,
2331 .load_image = efi_load_image,
2332 .start_image = efi_start_image,
2334 .unload_image = efi_unload_image,
2335 .exit_boot_services = efi_exit_boot_services,
2336 .get_next_monotonic_count = efi_get_next_monotonic_count,
2338 .set_watchdog_timer = efi_set_watchdog_timer,
2339 .connect_controller = efi_connect_controller,
2340 .disconnect_controller = efi_disconnect_controller,
2341 .open_protocol = efi_open_protocol,
2342 .close_protocol = efi_close_protocol,
2343 .open_protocol_information = efi_open_protocol_information,
2344 .protocols_per_handle = efi_protocols_per_handle,
2345 .locate_handle_buffer = efi_locate_handle_buffer,
2346 .locate_protocol = efi_locate_protocol,
2347 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2348 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2349 .calculate_crc32 = efi_calculate_crc32,
2350 .copy_mem = efi_copy_mem,
2351 .set_mem = efi_set_mem,
2355 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
2357 struct efi_system_table __efi_runtime_data systab = {
2359 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2360 .revision = 0x20005, /* 2.5 */
2361 .headersize = sizeof(struct efi_table_hdr),
2363 .fw_vendor = (long)firmware_vendor,
2364 .con_in = (void*)&efi_con_in,
2365 .con_out = (void*)&efi_con_out,
2366 .std_err = (void*)&efi_con_out,
2367 .runtime = (void*)&efi_runtime_services,
2368 .boottime = (void*)&efi_boot_services,
2370 .tables = (void*)efi_conf_table,