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);
879 if (!guidcmp(&efi_guid_device_path, protocol))
880 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
885 * Install protocol interface.
887 * This function implements the InstallProtocolInterface service.
888 * See the Unified Extensible Firmware Interface (UEFI) specification
891 * @handle handle on which the protocol shall be installed
892 * @protocol GUID of the protocol to be installed
893 * @protocol_interface_type type of the interface to be installed,
894 * always EFI_NATIVE_INTERFACE
895 * @protocol_interface interface of the protocol implementation
896 * @return status code
898 static efi_status_t EFIAPI efi_install_protocol_interface(
899 void **handle, const efi_guid_t *protocol,
900 int protocol_interface_type, void *protocol_interface)
904 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
907 if (!handle || !protocol ||
908 protocol_interface_type != EFI_NATIVE_INTERFACE) {
909 r = EFI_INVALID_PARAMETER;
913 /* Create new handle if requested. */
915 r = efi_create_handle(handle);
916 if (r != EFI_SUCCESS)
918 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
921 debug("%sEFI: handle %p\n", indent_string(nesting_level),
924 /* Add new protocol */
925 r = efi_add_protocol(*handle, protocol, protocol_interface);
931 * Reinstall protocol interface.
933 * This function implements the ReinstallProtocolInterface service.
934 * See the Unified Extensible Firmware Interface (UEFI) specification
937 * @handle handle on which the protocol shall be
939 * @protocol GUID of the protocol to be installed
940 * @old_interface interface to be removed
941 * @new_interface interface to be installed
942 * @return status code
944 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
945 const efi_guid_t *protocol, void *old_interface,
948 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
950 return EFI_EXIT(EFI_ACCESS_DENIED);
954 * Uninstall protocol interface.
956 * This function implements the UninstallProtocolInterface service.
957 * See the Unified Extensible Firmware Interface (UEFI) specification
960 * @handle handle from which the protocol shall be removed
961 * @protocol GUID of the protocol to be removed
962 * @protocol_interface interface to be removed
963 * @return status code
965 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
966 void *handle, const efi_guid_t *protocol,
967 void *protocol_interface)
969 struct efi_handler *handler;
972 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
974 if (!handle || !protocol) {
975 r = EFI_INVALID_PARAMETER;
979 /* Find the protocol on the handle */
980 r = efi_search_protocol(handle, protocol, &handler);
981 if (r != EFI_SUCCESS)
983 if (handler->protocol_interface) {
984 /* TODO disconnect controllers */
985 r = EFI_ACCESS_DENIED;
987 r = efi_remove_protocol(handle, protocol, protocol_interface);
994 * Register an event for notification when a protocol is installed.
996 * This function implements the RegisterProtocolNotify service.
997 * See the Unified Extensible Firmware Interface (UEFI) specification
1000 * @protocol GUID of the protocol whose installation shall be
1002 * @event event to be signaled upon installation of the protocol
1003 * @registration key for retrieving the registration information
1004 * @return status code
1006 static efi_status_t EFIAPI efi_register_protocol_notify(
1007 const efi_guid_t *protocol,
1008 struct efi_event *event,
1009 void **registration)
1011 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1012 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1016 * Determine if an EFI handle implements a protocol.
1018 * See the documentation of the LocateHandle service in the UEFI specification.
1020 * @search_type selection criterion
1021 * @protocol GUID of the protocol
1022 * @search_key registration key
1024 * @return 0 if the handle implements the protocol
1026 static int efi_search(enum efi_locate_search_type search_type,
1027 const efi_guid_t *protocol, void *search_key,
1028 struct efi_object *efiobj)
1032 switch (search_type) {
1035 case BY_REGISTER_NOTIFY:
1036 /* TODO: RegisterProtocolNotify is not implemented yet */
1039 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1040 return (ret != EFI_SUCCESS);
1042 /* Invalid search type */
1048 * Locate handles implementing a protocol.
1050 * This function is meant for U-Boot internal calls. For the API implementation
1051 * of the LocateHandle service see efi_locate_handle_ext.
1053 * @search_type selection criterion
1054 * @protocol GUID of the protocol
1055 * @search_key registration key
1056 * @buffer_size size of the buffer to receive the handles in bytes
1057 * @buffer buffer to receive the relevant handles
1058 * @return status code
1060 static efi_status_t efi_locate_handle(
1061 enum efi_locate_search_type search_type,
1062 const efi_guid_t *protocol, void *search_key,
1063 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1065 struct efi_object *efiobj;
1066 efi_uintn_t size = 0;
1068 /* Check parameters */
1069 switch (search_type) {
1072 case BY_REGISTER_NOTIFY:
1074 return EFI_INVALID_PARAMETER;
1075 /* RegisterProtocolNotify is not implemented yet */
1076 return EFI_UNSUPPORTED;
1079 return EFI_INVALID_PARAMETER;
1082 return EFI_INVALID_PARAMETER;
1086 * efi_locate_handle_buffer uses this function for
1087 * the calculation of the necessary buffer size.
1088 * So do not require a buffer for buffersize == 0.
1090 if (!buffer_size || (*buffer_size && !buffer))
1091 return EFI_INVALID_PARAMETER;
1093 /* Count how much space we need */
1094 list_for_each_entry(efiobj, &efi_obj_list, link) {
1095 if (!efi_search(search_type, protocol, search_key, efiobj))
1096 size += sizeof(void*);
1099 if (*buffer_size < size) {
1100 *buffer_size = size;
1101 return EFI_BUFFER_TOO_SMALL;
1104 *buffer_size = size;
1106 return EFI_NOT_FOUND;
1108 /* Then fill the array */
1109 list_for_each_entry(efiobj, &efi_obj_list, link) {
1110 if (!efi_search(search_type, protocol, search_key, efiobj))
1111 *buffer++ = efiobj->handle;
1118 * Locate handles implementing a protocol.
1120 * This function implements the LocateHandle service.
1121 * See the Unified Extensible Firmware Interface (UEFI) specification
1124 * @search_type selection criterion
1125 * @protocol GUID of the protocol
1126 * @search_key registration key
1127 * @buffer_size size of the buffer to receive the handles in bytes
1128 * @buffer buffer to receive the relevant handles
1129 * @return 0 if the handle implements the protocol
1131 static efi_status_t EFIAPI efi_locate_handle_ext(
1132 enum efi_locate_search_type search_type,
1133 const efi_guid_t *protocol, void *search_key,
1134 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1136 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1137 buffer_size, buffer);
1139 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1140 buffer_size, buffer));
1143 /* Collapses configuration table entries, removing index i */
1144 static void efi_remove_configuration_table(int i)
1146 struct efi_configuration_table *this = &efi_conf_table[i];
1147 struct efi_configuration_table *next = &efi_conf_table[i+1];
1148 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1150 memmove(this, next, (ulong)end - (ulong)next);
1155 * Adds, updates, or removes a configuration table.
1157 * This function is used for internal calls. For the API implementation of the
1158 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1160 * @guid GUID of the installed table
1161 * @table table to be installed
1162 * @return status code
1164 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1168 /* Check for guid override */
1169 for (i = 0; i < systab.nr_tables; i++) {
1170 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1172 efi_conf_table[i].table = table;
1174 efi_remove_configuration_table(i);
1180 return EFI_NOT_FOUND;
1182 /* No override, check for overflow */
1183 if (i >= ARRAY_SIZE(efi_conf_table))
1184 return EFI_OUT_OF_RESOURCES;
1186 /* Add a new entry */
1187 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1188 efi_conf_table[i].table = table;
1189 systab.nr_tables = i + 1;
1195 * Adds, updates, or removes a configuration table.
1197 * This function implements the InstallConfigurationTable service.
1198 * See the Unified Extensible Firmware Interface (UEFI) specification
1201 * @guid GUID of the installed table
1202 * @table table to be installed
1203 * @return status code
1205 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1208 EFI_ENTRY("%pUl, %p", guid, table);
1209 return EFI_EXIT(efi_install_configuration_table(guid, table));
1213 * Initialize a loaded_image_info + loaded_image_info object with correct
1214 * protocols, boot-device, etc.
1216 * @info loaded image info to be passed to the entry point of the
1218 * @obj internal object associated with the loaded image
1219 * @device_path device path of the loaded image
1220 * @file_path file path of the loaded image
1221 * @return status code
1223 efi_status_t efi_setup_loaded_image(
1224 struct efi_loaded_image *info, struct efi_object *obj,
1225 struct efi_device_path *device_path,
1226 struct efi_device_path *file_path)
1230 /* Add internal object to object list */
1231 efi_add_handle(obj);
1232 /* efi_exit() assumes that the handle points to the info */
1235 info->file_path = file_path;
1237 info->device_handle = efi_dp_find_obj(device_path, NULL);
1240 * When asking for the device path interface, return
1241 * bootefi_device_path
1243 ret = efi_add_protocol(obj->handle, &efi_guid_device_path, device_path);
1244 if (ret != EFI_SUCCESS)
1248 * When asking for the loaded_image interface, just
1249 * return handle which points to loaded_image_info
1251 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1252 if (ret != EFI_SUCCESS)
1255 ret = efi_add_protocol(obj->handle, &efi_guid_console_control,
1256 (void *)&efi_console_control);
1257 if (ret != EFI_SUCCESS)
1260 ret = efi_add_protocol(obj->handle,
1261 &efi_guid_device_path_to_text_protocol,
1262 (void *)&efi_device_path_to_text);
1263 if (ret != EFI_SUCCESS)
1268 printf("ERROR: Failure to install protocols for loaded image\n");
1273 * Load an image using a file path.
1275 * @file_path the path of the image to load
1276 * @buffer buffer containing the loaded image
1277 * @return status code
1279 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1282 struct efi_file_info *info = NULL;
1283 struct efi_file_handle *f;
1284 static efi_status_t ret;
1287 f = efi_file_from_path(file_path);
1289 return EFI_DEVICE_ERROR;
1292 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1294 if (ret == EFI_BUFFER_TOO_SMALL) {
1296 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1299 if (ret != EFI_SUCCESS)
1302 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1306 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1310 EFI_CALL(f->close(f));
1312 if (ret != EFI_SUCCESS) {
1313 efi_free_pool(*buffer);
1321 * Load an EFI image into memory.
1323 * This function implements the LoadImage service.
1324 * See the Unified Extensible Firmware Interface (UEFI) specification
1327 * @boot_policy true for request originating from the boot manager
1328 * @parent_image the calles's image handle
1329 * @file_path the path of the image to load
1330 * @source_buffer memory location from which the image is installed
1331 * @source_size size of the memory area from which the image is
1333 * @image_handle handle for the newly installed image
1334 * @return status code
1336 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1337 efi_handle_t parent_image,
1338 struct efi_device_path *file_path,
1339 void *source_buffer,
1340 unsigned long source_size,
1341 efi_handle_t *image_handle)
1343 struct efi_loaded_image *info;
1344 struct efi_object *obj;
1347 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1348 file_path, source_buffer, source_size, image_handle);
1350 info = calloc(1, sizeof(*info));
1351 obj = calloc(1, sizeof(*obj));
1353 if (!source_buffer) {
1354 struct efi_device_path *dp, *fp;
1356 ret = efi_load_image_from_path(file_path, &source_buffer);
1357 if (ret != EFI_SUCCESS)
1360 * split file_path which contains both the device and
1363 efi_dp_split_file_path(file_path, &dp, &fp);
1364 ret = efi_setup_loaded_image(info, obj, dp, fp);
1365 if (ret != EFI_SUCCESS)
1368 /* In this case, file_path is the "device" path, ie.
1369 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1371 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1372 if (ret != EFI_SUCCESS)
1375 info->reserved = efi_load_pe(source_buffer, info);
1376 if (!info->reserved) {
1377 ret = EFI_UNSUPPORTED;
1380 info->system_table = &systab;
1381 info->parent_handle = parent_image;
1382 *image_handle = obj->handle;
1383 return EFI_EXIT(EFI_SUCCESS);
1386 efi_delete_handle(obj);
1387 return EFI_EXIT(ret);
1391 * Call the entry point of an image.
1393 * This function implements the StartImage service.
1394 * See the Unified Extensible Firmware Interface (UEFI) specification
1397 * @image_handle handle of the image
1398 * @exit_data_size size of the buffer
1399 * @exit_data buffer to receive the exit data of the called image
1400 * @return status code
1402 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1403 unsigned long *exit_data_size,
1406 ulong (*entry)(void *image_handle, struct efi_system_table *st);
1407 struct efi_loaded_image *info = image_handle;
1410 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1411 entry = info->reserved;
1413 efi_is_direct_boot = false;
1415 /* call the image! */
1416 if (setjmp(&info->exit_jmp)) {
1418 * We called the entry point of the child image with EFI_CALL
1419 * in the lines below. The child image called the Exit() boot
1420 * service efi_exit() which executed the long jump that brought
1421 * us to the current line. This implies that the second half
1422 * of the EFI_CALL macro has not been executed.
1426 * efi_exit() called efi_restore_gd(). We have to undo this
1427 * otherwise __efi_entry_check() will put the wrong value into
1433 * To get ready to call EFI_EXIT below we have to execute the
1434 * missed out steps of EFI_CALL.
1436 assert(__efi_entry_check());
1437 debug("%sEFI: %lu returned by started image\n",
1438 __efi_nesting_dec(),
1439 (unsigned long)((uintptr_t)info->exit_status &
1441 return EFI_EXIT(info->exit_status);
1444 ret = EFI_CALL(entry(image_handle, &systab));
1446 /* Should usually never get here */
1447 return EFI_EXIT(ret);
1451 * Leave an EFI application or driver.
1453 * This function implements the Exit service.
1454 * See the Unified Extensible Firmware Interface (UEFI) specification
1457 * @image_handle handle of the application or driver that is exiting
1458 * @exit_status status code
1459 * @exit_data_size size of the buffer in bytes
1460 * @exit_data buffer with data describing an error
1461 * @return status code
1463 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1464 efi_status_t exit_status, unsigned long exit_data_size,
1468 * We require that the handle points to the original loaded
1469 * image protocol interface.
1471 * For getting the longjmp address this is safer than locating
1472 * the protocol because the protocol may have been reinstalled
1473 * pointing to another memory location.
1475 * TODO: We should call the unload procedure of the loaded
1478 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1480 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1481 exit_data_size, exit_data);
1483 /* Make sure entry/exit counts for EFI world cross-overs match */
1484 EFI_EXIT(exit_status);
1487 * But longjmp out with the U-Boot gd, not the application's, as
1488 * the other end is a setjmp call inside EFI context.
1492 loaded_image_info->exit_status = exit_status;
1493 longjmp(&loaded_image_info->exit_jmp, 1);
1495 panic("EFI application exited");
1499 * Unload an EFI image.
1501 * This function implements the UnloadImage service.
1502 * See the Unified Extensible Firmware Interface (UEFI) specification
1505 * @image_handle handle of the image to be unloaded
1506 * @return status code
1508 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1510 struct efi_object *efiobj;
1512 EFI_ENTRY("%p", image_handle);
1513 efiobj = efi_search_obj(image_handle);
1515 list_del(&efiobj->link);
1517 return EFI_EXIT(EFI_SUCCESS);
1521 * Fix up caches for EFI payloads if necessary.
1523 static void efi_exit_caches(void)
1525 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1527 * Grub on 32bit ARM needs to have caches disabled before jumping into
1528 * a zImage, but does not know of all cache layers. Give it a hand.
1530 if (efi_is_direct_boot)
1531 cleanup_before_linux();
1536 * Stop boot services.
1538 * This function implements the ExitBootServices service.
1539 * See the Unified Extensible Firmware Interface (UEFI) specification
1542 * @image_handle handle of the loaded image
1543 * @map_key key of the memory map
1544 * @return status code
1546 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1547 unsigned long map_key)
1551 EFI_ENTRY("%p, %ld", image_handle, map_key);
1553 /* Notify that ExitBootServices is invoked. */
1554 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1555 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1557 efi_signal_event(&efi_events[i]);
1559 /* Make sure that notification functions are not called anymore */
1560 efi_tpl = TPL_HIGH_LEVEL;
1562 /* XXX Should persist EFI variables here */
1564 board_quiesce_devices();
1566 /* Fix up caches for EFI payloads if necessary */
1569 /* This stops all lingering devices */
1570 bootm_disable_interrupts();
1572 /* Give the payload some time to boot */
1573 efi_set_watchdog(0);
1576 return EFI_EXIT(EFI_SUCCESS);
1580 * Get next value of the counter.
1582 * This function implements the NextMonotonicCount service.
1583 * See the Unified Extensible Firmware Interface (UEFI) specification
1586 * @count returned value of the counter
1587 * @return status code
1589 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1591 static uint64_t mono = 0;
1592 EFI_ENTRY("%p", count);
1594 return EFI_EXIT(EFI_SUCCESS);
1600 * This function implements the Stall sercive.
1601 * See the Unified Extensible Firmware Interface (UEFI) specification
1604 * @microseconds period to sleep in microseconds
1605 * @return status code
1607 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1609 EFI_ENTRY("%ld", microseconds);
1610 udelay(microseconds);
1611 return EFI_EXIT(EFI_SUCCESS);
1615 * Reset the watchdog timer.
1617 * This function implements the SetWatchdogTimer service.
1618 * See the Unified Extensible Firmware Interface (UEFI) specification
1621 * @timeout seconds before reset by watchdog
1622 * @watchdog_code code to be logged when resetting
1623 * @data_size size of buffer in bytes
1624 * @watchdog_data buffer with data describing the reset reason
1625 * @return status code
1627 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1628 uint64_t watchdog_code,
1629 unsigned long data_size,
1630 uint16_t *watchdog_data)
1632 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1633 data_size, watchdog_data);
1634 return EFI_EXIT(efi_set_watchdog(timeout));
1638 * Connect a controller to a driver.
1640 * This function implements the ConnectController service.
1641 * See the Unified Extensible Firmware Interface (UEFI) specification
1644 * @controller_handle handle of the controller
1645 * @driver_image_handle handle of the driver
1646 * @remain_device_path device path of a child controller
1647 * @recursive true to connect all child controllers
1648 * @return status code
1650 static efi_status_t EFIAPI efi_connect_controller(
1651 efi_handle_t controller_handle,
1652 efi_handle_t *driver_image_handle,
1653 struct efi_device_path *remain_device_path,
1656 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1657 remain_device_path, recursive);
1658 return EFI_EXIT(EFI_NOT_FOUND);
1662 * Disconnect a controller from a driver.
1664 * This function implements the DisconnectController service.
1665 * See the Unified Extensible Firmware Interface (UEFI) specification
1668 * @controller_handle handle of the controller
1669 * @driver_image_handle handle of the driver
1670 * @child_handle handle of the child to destroy
1671 * @return status code
1673 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1674 void *driver_image_handle,
1677 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1679 return EFI_EXIT(EFI_INVALID_PARAMETER);
1685 * This function implements the CloseProtocol service.
1686 * See the Unified Extensible Firmware Interface (UEFI) specification
1689 * @handle handle on which the protocol shall be closed
1690 * @protocol GUID of the protocol to close
1691 * @agent_handle handle of the driver
1692 * @controller_handle handle of the controller
1693 * @return status code
1695 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1696 const efi_guid_t *protocol,
1698 void *controller_handle)
1700 struct efi_handler *handler;
1701 struct efi_open_protocol_info_item *item;
1702 struct efi_open_protocol_info_item *pos;
1705 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1708 if (!agent_handle) {
1709 r = EFI_INVALID_PARAMETER;
1712 r = efi_search_protocol(handle, protocol, &handler);
1713 if (r != EFI_SUCCESS)
1717 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1718 if (item->info.agent_handle == agent_handle &&
1719 item->info.controller_handle == controller_handle) {
1720 efi_delete_open_info(item);
1730 * Provide information about then open status of a protocol on a handle
1732 * This function implements the OpenProtocolInformation service.
1733 * See the Unified Extensible Firmware Interface (UEFI) specification
1736 * @handle handle for which the information shall be retrieved
1737 * @protocol GUID of the protocol
1738 * @entry_buffer buffer to receive the open protocol information
1739 * @entry_count number of entries available in the buffer
1740 * @return status code
1742 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1743 const efi_guid_t *protocol,
1744 struct efi_open_protocol_info_entry **entry_buffer,
1745 efi_uintn_t *entry_count)
1747 unsigned long buffer_size;
1748 unsigned long count;
1749 struct efi_handler *handler;
1750 struct efi_open_protocol_info_item *item;
1753 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1756 /* Check parameters */
1757 if (!entry_buffer) {
1758 r = EFI_INVALID_PARAMETER;
1761 r = efi_search_protocol(handle, protocol, &handler);
1762 if (r != EFI_SUCCESS)
1767 list_for_each_entry(item, &handler->open_infos, link) {
1768 if (item->info.open_count)
1771 *entry_count = count;
1772 *entry_buffer = NULL;
1779 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
1780 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1781 (void **)entry_buffer);
1782 if (r != EFI_SUCCESS)
1784 list_for_each_entry_reverse(item, &handler->open_infos, link) {
1785 if (item->info.open_count)
1786 (*entry_buffer)[--count] = item->info;
1793 * Get protocols installed on a handle.
1795 * This function implements the ProtocolsPerHandleService.
1796 * See the Unified Extensible Firmware Interface (UEFI) specification
1799 * @handle handle for which the information is retrieved
1800 * @protocol_buffer buffer with protocol GUIDs
1801 * @protocol_buffer_count number of entries in the buffer
1802 * @return status code
1804 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1805 efi_guid_t ***protocol_buffer,
1806 efi_uintn_t *protocol_buffer_count)
1808 unsigned long buffer_size;
1809 struct efi_object *efiobj;
1810 struct list_head *protocol_handle;
1813 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1814 protocol_buffer_count);
1816 if (!handle || !protocol_buffer || !protocol_buffer_count)
1817 return EFI_EXIT(EFI_INVALID_PARAMETER);
1819 *protocol_buffer = NULL;
1820 *protocol_buffer_count = 0;
1822 efiobj = efi_search_obj(handle);
1824 return EFI_EXIT(EFI_INVALID_PARAMETER);
1826 /* Count protocols */
1827 list_for_each(protocol_handle, &efiobj->protocols) {
1828 ++*protocol_buffer_count;
1832 if (*protocol_buffer_count) {
1835 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
1836 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1837 (void **)protocol_buffer);
1838 if (r != EFI_SUCCESS)
1840 list_for_each(protocol_handle, &efiobj->protocols) {
1841 struct efi_handler *protocol;
1843 protocol = list_entry(protocol_handle,
1844 struct efi_handler, link);
1845 (*protocol_buffer)[j] = (void *)protocol->guid;
1850 return EFI_EXIT(EFI_SUCCESS);
1854 * Locate handles implementing a protocol.
1856 * This function implements the LocateHandleBuffer service.
1857 * See the Unified Extensible Firmware Interface (UEFI) specification
1860 * @search_type selection criterion
1861 * @protocol GUID of the protocol
1862 * @search_key registration key
1863 * @no_handles number of returned handles
1864 * @buffer buffer with the returned handles
1865 * @return status code
1867 static efi_status_t EFIAPI efi_locate_handle_buffer(
1868 enum efi_locate_search_type search_type,
1869 const efi_guid_t *protocol, void *search_key,
1870 efi_uintn_t *no_handles, efi_handle_t **buffer)
1873 efi_uintn_t buffer_size = 0;
1875 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1876 no_handles, buffer);
1878 if (!no_handles || !buffer) {
1879 r = EFI_INVALID_PARAMETER;
1884 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1886 if (r != EFI_BUFFER_TOO_SMALL)
1888 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1890 if (r != EFI_SUCCESS)
1892 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1894 if (r == EFI_SUCCESS)
1895 *no_handles = buffer_size / sizeof(void *);
1901 * Find an interface implementing a protocol.
1903 * This function implements the LocateProtocol service.
1904 * See the Unified Extensible Firmware Interface (UEFI) specification
1907 * @protocol GUID of the protocol
1908 * @registration registration key passed to the notification function
1909 * @protocol_interface interface implementing the protocol
1910 * @return status code
1912 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1914 void **protocol_interface)
1916 struct list_head *lhandle;
1919 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1921 if (!protocol || !protocol_interface)
1922 return EFI_EXIT(EFI_INVALID_PARAMETER);
1924 list_for_each(lhandle, &efi_obj_list) {
1925 struct efi_object *efiobj;
1926 struct efi_handler *handler;
1928 efiobj = list_entry(lhandle, struct efi_object, link);
1930 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
1931 if (ret == EFI_SUCCESS) {
1932 *protocol_interface = handler->protocol_interface;
1933 return EFI_EXIT(EFI_SUCCESS);
1936 *protocol_interface = NULL;
1938 return EFI_EXIT(EFI_NOT_FOUND);
1942 * Get the device path and handle of an device implementing a protocol.
1944 * This function implements the LocateDevicePath service.
1945 * See the Unified Extensible Firmware Interface (UEFI) specification
1948 * @protocol GUID of the protocol
1949 * @device_path device path
1950 * @device handle of the device
1951 * @return status code
1953 static efi_status_t EFIAPI efi_locate_device_path(
1954 const efi_guid_t *protocol,
1955 struct efi_device_path **device_path,
1956 efi_handle_t *device)
1958 struct efi_device_path *dp;
1960 struct efi_handler *handler;
1961 efi_handle_t *handles;
1963 size_t len_best = 0;
1964 efi_uintn_t no_handles;
1968 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1970 if (!protocol || !device_path || !*device_path || !device) {
1971 ret = EFI_INVALID_PARAMETER;
1975 /* Find end of device path */
1976 len = efi_dp_size(*device_path);
1978 /* Get all handles implementing the protocol */
1979 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1980 &no_handles, &handles));
1981 if (ret != EFI_SUCCESS)
1984 for (i = 0; i < no_handles; ++i) {
1985 /* Find the device path protocol */
1986 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1988 if (ret != EFI_SUCCESS)
1990 dp = (struct efi_device_path *)handler->protocol_interface;
1991 len_dp = efi_dp_size(dp);
1993 * This handle can only be a better fit
1994 * if its device path length is longer than the best fit and
1995 * if its device path length is shorter of equal the searched
1998 if (len_dp <= len_best || len_dp > len)
2000 /* Check if dp is a subpath of device_path */
2001 if (memcmp(*device_path, dp, len_dp))
2003 *device = handles[i];
2007 remainder = (u8 *)*device_path + len_best;
2008 *device_path = (struct efi_device_path *)remainder;
2011 ret = EFI_NOT_FOUND;
2014 return EFI_EXIT(ret);
2018 * Install multiple protocol interfaces.
2020 * This function implements the MultipleProtocolInterfaces service.
2021 * See the Unified Extensible Firmware Interface (UEFI) specification
2024 * @handle handle on which the protocol interfaces shall be installed
2025 * @... NULL terminated argument list with pairs of protocol GUIDS and
2027 * @return status code
2029 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2032 EFI_ENTRY("%p", handle);
2035 const efi_guid_t *protocol;
2036 void *protocol_interface;
2037 efi_status_t r = EFI_SUCCESS;
2041 return EFI_EXIT(EFI_INVALID_PARAMETER);
2043 va_start(argptr, handle);
2045 protocol = va_arg(argptr, efi_guid_t*);
2048 protocol_interface = va_arg(argptr, void*);
2049 r = EFI_CALL(efi_install_protocol_interface(
2051 EFI_NATIVE_INTERFACE,
2052 protocol_interface));
2053 if (r != EFI_SUCCESS)
2058 if (r == EFI_SUCCESS)
2061 /* If an error occurred undo all changes. */
2062 va_start(argptr, handle);
2064 protocol = va_arg(argptr, efi_guid_t*);
2065 protocol_interface = va_arg(argptr, void*);
2066 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2067 protocol_interface));
2075 * Uninstall multiple protocol interfaces.
2077 * This function implements the UninstallMultipleProtocolInterfaces service.
2078 * See the Unified Extensible Firmware Interface (UEFI) specification
2081 * @handle handle from which the protocol interfaces shall be removed
2082 * @... NULL terminated argument list with pairs of protocol GUIDS and
2084 * @return status code
2086 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2089 EFI_ENTRY("%p", handle);
2092 const efi_guid_t *protocol;
2093 void *protocol_interface;
2094 efi_status_t r = EFI_SUCCESS;
2098 return EFI_EXIT(EFI_INVALID_PARAMETER);
2100 va_start(argptr, handle);
2102 protocol = va_arg(argptr, efi_guid_t*);
2105 protocol_interface = va_arg(argptr, void*);
2106 r = EFI_CALL(efi_uninstall_protocol_interface(
2108 protocol_interface));
2109 if (r != EFI_SUCCESS)
2114 if (r == EFI_SUCCESS)
2117 /* If an error occurred undo all changes. */
2118 va_start(argptr, handle);
2120 protocol = va_arg(argptr, efi_guid_t*);
2121 protocol_interface = va_arg(argptr, void*);
2122 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2123 EFI_NATIVE_INTERFACE,
2124 protocol_interface));
2132 * Calculate cyclic redundancy code.
2134 * This function implements the CalculateCrc32 service.
2135 * See the Unified Extensible Firmware Interface (UEFI) specification
2138 * @data buffer with data
2139 * @data_size size of buffer in bytes
2140 * @crc32_p cyclic redundancy code
2141 * @return status code
2143 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2144 unsigned long data_size,
2147 EFI_ENTRY("%p, %ld", data, data_size);
2148 *crc32_p = crc32(0, data, data_size);
2149 return EFI_EXIT(EFI_SUCCESS);
2155 * This function implements the CopyMem service.
2156 * See the Unified Extensible Firmware Interface (UEFI) specification
2159 * @destination destination of the copy operation
2160 * @source source of the copy operation
2161 * @length number of bytes to copy
2163 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2166 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2167 memcpy(destination, source, length);
2168 EFI_EXIT(EFI_SUCCESS);
2172 * Fill memory with a byte value.
2174 * This function implements the SetMem service.
2175 * See the Unified Extensible Firmware Interface (UEFI) specification
2178 * @buffer buffer to fill
2179 * @size size of buffer in bytes
2180 * @value byte to copy to the buffer
2182 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2184 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2185 memset(buffer, value, size);
2186 EFI_EXIT(EFI_SUCCESS);
2190 * Open protocol interface on a handle.
2192 * @handler handler of a protocol
2193 * @protocol_interface interface implementing the protocol
2194 * @agent_handle handle of the driver
2195 * @controller_handle handle of the controller
2196 * @attributes attributes indicating how to open the protocol
2197 * @return status code
2199 static efi_status_t efi_protocol_open(
2200 struct efi_handler *handler,
2201 void **protocol_interface, void *agent_handle,
2202 void *controller_handle, uint32_t attributes)
2204 struct efi_open_protocol_info_item *item;
2205 struct efi_open_protocol_info_entry *match = NULL;
2206 bool opened_by_driver = false;
2207 bool opened_exclusive = false;
2209 /* If there is no agent, only return the interface */
2213 /* For TEST_PROTOCOL ignore interface attribute */
2214 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2215 *protocol_interface = NULL;
2218 * Check if the protocol is already opened by a driver with the same
2219 * attributes or opened exclusively
2221 list_for_each_entry(item, &handler->open_infos, link) {
2222 if (item->info.agent_handle == agent_handle) {
2223 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2224 (item->info.attributes == attributes))
2225 return EFI_ALREADY_STARTED;
2227 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2228 opened_exclusive = true;
2231 /* Only one controller can open the protocol exclusively */
2232 if (opened_exclusive && attributes &
2233 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2234 return EFI_ACCESS_DENIED;
2236 /* Prepare exclusive opening */
2237 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2238 /* Try to disconnect controllers */
2239 list_for_each_entry(item, &handler->open_infos, link) {
2240 if (item->info.attributes ==
2241 EFI_OPEN_PROTOCOL_BY_DRIVER)
2242 EFI_CALL(efi_disconnect_controller(
2243 item->info.controller_handle,
2244 item->info.agent_handle,
2247 opened_by_driver = false;
2248 /* Check if all controllers are disconnected */
2249 list_for_each_entry(item, &handler->open_infos, link) {
2250 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2251 opened_by_driver = true;
2253 /* Only one controller can be conncected */
2254 if (opened_by_driver)
2255 return EFI_ACCESS_DENIED;
2258 /* Find existing entry */
2259 list_for_each_entry(item, &handler->open_infos, link) {
2260 if (item->info.agent_handle == agent_handle &&
2261 item->info.controller_handle == controller_handle)
2262 match = &item->info;
2264 /* None found, create one */
2266 match = efi_create_open_info(handler);
2268 return EFI_OUT_OF_RESOURCES;
2271 match->agent_handle = agent_handle;
2272 match->controller_handle = controller_handle;
2273 match->attributes = attributes;
2274 match->open_count++;
2277 /* For TEST_PROTOCOL ignore interface attribute. */
2278 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2279 *protocol_interface = handler->protocol_interface;
2285 * Open protocol interface on a handle.
2287 * This function implements the OpenProtocol interface.
2288 * See the Unified Extensible Firmware Interface (UEFI) specification
2291 * @handle handle on which the protocol shall be opened
2292 * @protocol GUID of the protocol
2293 * @protocol_interface interface implementing the protocol
2294 * @agent_handle handle of the driver
2295 * @controller_handle handle of the controller
2296 * @attributes attributes indicating how to open the protocol
2297 * @return status code
2299 static efi_status_t EFIAPI efi_open_protocol(
2300 void *handle, const efi_guid_t *protocol,
2301 void **protocol_interface, void *agent_handle,
2302 void *controller_handle, uint32_t attributes)
2304 struct efi_handler *handler;
2305 efi_status_t r = EFI_INVALID_PARAMETER;
2307 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2308 protocol_interface, agent_handle, controller_handle,
2311 if (!handle || !protocol ||
2312 (!protocol_interface && attributes !=
2313 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2317 switch (attributes) {
2318 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2319 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2320 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2322 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2323 if (controller_handle == handle)
2326 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2327 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2328 /* Check that the controller handle is valid */
2329 if (!efi_search_obj(controller_handle))
2332 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2333 /* Check that the agent handle is valid */
2334 if (!efi_search_obj(agent_handle))
2341 r = efi_search_protocol(handle, protocol, &handler);
2342 if (r != EFI_SUCCESS)
2345 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2346 controller_handle, attributes);
2352 * Get interface of a protocol on a handle.
2354 * This function implements the HandleProtocol service.
2355 * See the Unified Extensible Firmware Interface (UEFI) specification
2358 * @handle handle on which the protocol shall be opened
2359 * @protocol GUID of the protocol
2360 * @protocol_interface interface implementing the protocol
2361 * @return status code
2363 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
2364 const efi_guid_t *protocol,
2365 void **protocol_interface)
2367 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2368 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2371 static const struct efi_boot_services efi_boot_services = {
2373 .headersize = sizeof(struct efi_table_hdr),
2375 .raise_tpl = efi_raise_tpl,
2376 .restore_tpl = efi_restore_tpl,
2377 .allocate_pages = efi_allocate_pages_ext,
2378 .free_pages = efi_free_pages_ext,
2379 .get_memory_map = efi_get_memory_map_ext,
2380 .allocate_pool = efi_allocate_pool_ext,
2381 .free_pool = efi_free_pool_ext,
2382 .create_event = efi_create_event_ext,
2383 .set_timer = efi_set_timer_ext,
2384 .wait_for_event = efi_wait_for_event,
2385 .signal_event = efi_signal_event_ext,
2386 .close_event = efi_close_event,
2387 .check_event = efi_check_event,
2388 .install_protocol_interface = efi_install_protocol_interface,
2389 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2390 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2391 .handle_protocol = efi_handle_protocol,
2393 .register_protocol_notify = efi_register_protocol_notify,
2394 .locate_handle = efi_locate_handle_ext,
2395 .locate_device_path = efi_locate_device_path,
2396 .install_configuration_table = efi_install_configuration_table_ext,
2397 .load_image = efi_load_image,
2398 .start_image = efi_start_image,
2400 .unload_image = efi_unload_image,
2401 .exit_boot_services = efi_exit_boot_services,
2402 .get_next_monotonic_count = efi_get_next_monotonic_count,
2404 .set_watchdog_timer = efi_set_watchdog_timer,
2405 .connect_controller = efi_connect_controller,
2406 .disconnect_controller = efi_disconnect_controller,
2407 .open_protocol = efi_open_protocol,
2408 .close_protocol = efi_close_protocol,
2409 .open_protocol_information = efi_open_protocol_information,
2410 .protocols_per_handle = efi_protocols_per_handle,
2411 .locate_handle_buffer = efi_locate_handle_buffer,
2412 .locate_protocol = efi_locate_protocol,
2413 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2414 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2415 .calculate_crc32 = efi_calculate_crc32,
2416 .copy_mem = efi_copy_mem,
2417 .set_mem = efi_set_mem,
2421 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
2423 struct efi_system_table __efi_runtime_data systab = {
2425 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2426 .revision = 0x20005, /* 2.5 */
2427 .headersize = sizeof(struct efi_table_hdr),
2429 .fw_vendor = (long)firmware_vendor,
2430 .con_in = (void*)&efi_con_in,
2431 .con_out = (void*)&efi_con_out,
2432 .std_err = (void*)&efi_con_out,
2433 .runtime = (void*)&efi_runtime_services,
2434 .boottime = (void*)&efi_boot_services,
2436 .tables = (void*)efi_conf_table,