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 <linux/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;
59 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60 const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
63 static efi_status_t EFIAPI efi_disconnect_controller(
64 efi_handle_t controller_handle,
65 efi_handle_t driver_image_handle,
66 efi_handle_t child_handle);
68 /* Called on every callback entry */
69 int __efi_entry_check(void)
71 int ret = entry_count++ == 0;
80 /* Called on every callback exit */
81 int __efi_exit_check(void)
83 int ret = --entry_count == 0;
90 /* Called from do_bootefi_exec() */
91 void efi_save_gd(void)
99 * Special case handler for error/abort that just forces things back
100 * to u-boot world so we can dump out an abort msg, without any care
101 * about returning back to UEFI world.
103 void efi_restore_gd(void)
106 /* Only restore if we're already in EFI context */
114 * Return a string for indenting with two spaces per level. A maximum of ten
115 * indent levels is supported. Higher indent levels will be truncated.
117 * @level indent level
118 * @return indent string
120 static const char *indent_string(int level)
122 const char *indent = " ";
123 const int max = strlen(indent);
124 level = min(max, level * 2);
125 return &indent[max - level];
128 const char *__efi_nesting(void)
130 return indent_string(nesting_level);
133 const char *__efi_nesting_inc(void)
135 return indent_string(nesting_level++);
138 const char *__efi_nesting_dec(void)
140 return indent_string(--nesting_level);
144 * Queue an EFI event.
146 * This function queues the notification function of the event for future
149 * The notification function is called if the task priority level of the
150 * event is higher than the current task priority level.
152 * For the SignalEvent service see efi_signal_event_ext.
154 * @event event to signal
155 * @check_tpl check the TPL level
157 void efi_signal_event(struct efi_event *event, bool check_tpl)
159 if (event->notify_function) {
160 event->is_queued = true;
162 if (check_tpl && efi_tpl >= event->notify_tpl)
164 EFI_CALL_VOID(event->notify_function(event,
165 event->notify_context));
167 event->is_queued = false;
171 * Raise the task priority level.
173 * This function implements the RaiseTpl service.
174 * See the Unified Extensible Firmware Interface (UEFI) specification
177 * @new_tpl new value of the task priority level
178 * @return old value of the task priority level
180 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
182 efi_uintn_t old_tpl = efi_tpl;
184 EFI_ENTRY("0x%zx", new_tpl);
186 if (new_tpl < efi_tpl)
187 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
189 if (efi_tpl > TPL_HIGH_LEVEL)
190 efi_tpl = TPL_HIGH_LEVEL;
192 EFI_EXIT(EFI_SUCCESS);
197 * Lower the task priority level.
199 * This function implements the RestoreTpl service.
200 * See the Unified Extensible Firmware Interface (UEFI) specification
203 * @old_tpl value of the task priority level to be restored
205 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
207 EFI_ENTRY("0x%zx", old_tpl);
209 if (old_tpl > efi_tpl)
210 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
212 if (efi_tpl > TPL_HIGH_LEVEL)
213 efi_tpl = TPL_HIGH_LEVEL;
215 EFI_EXIT(EFI_SUCCESS);
219 * Allocate memory pages.
221 * This function implements the AllocatePages service.
222 * See the Unified Extensible Firmware Interface (UEFI) specification
225 * @type type of allocation to be performed
226 * @memory_type usage type of the allocated memory
227 * @pages number of pages to be allocated
228 * @memory allocated memory
229 * @return status code
231 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
237 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
238 r = efi_allocate_pages(type, memory_type, pages, memory);
245 * This function implements the FreePages service.
246 * See the Unified Extensible Firmware Interface (UEFI) specification
249 * @memory start of the memory area to be freed
250 * @pages number of pages to be freed
251 * @return status code
253 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
258 EFI_ENTRY("%"PRIx64", 0x%zx", memory, pages);
259 r = efi_free_pages(memory, pages);
264 * Get map describing memory usage.
266 * This function implements the GetMemoryMap service.
267 * See the Unified Extensible Firmware Interface (UEFI) specification
270 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
271 * on exit the size of the copied memory map
272 * @memory_map buffer to which the memory map is written
273 * @map_key key for the memory map
274 * @descriptor_size size of an individual memory descriptor
275 * @descriptor_version version number of the memory descriptor structure
276 * @return status code
278 static efi_status_t EFIAPI efi_get_memory_map_ext(
279 efi_uintn_t *memory_map_size,
280 struct efi_mem_desc *memory_map,
281 efi_uintn_t *map_key,
282 efi_uintn_t *descriptor_size,
283 uint32_t *descriptor_version)
287 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
288 map_key, descriptor_size, descriptor_version);
289 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
290 descriptor_size, descriptor_version);
295 * Allocate memory from pool.
297 * This function implements the AllocatePool service.
298 * See the Unified Extensible Firmware Interface (UEFI) specification
301 * @pool_type type of the pool from which memory is to be allocated
302 * @size number of bytes to be allocated
303 * @buffer allocated memory
304 * @return status code
306 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
312 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
313 r = efi_allocate_pool(pool_type, size, buffer);
318 * Free memory from pool.
320 * This function implements the FreePool service.
321 * See the Unified Extensible Firmware Interface (UEFI) specification
324 * @buffer start of memory to be freed
325 * @return status code
327 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
331 EFI_ENTRY("%p", buffer);
332 r = efi_free_pool(buffer);
337 * Add a new object to the object list.
339 * The protocols list is initialized.
340 * The object handle is set.
342 * @obj object to be added
344 void efi_add_handle(struct efi_object *obj)
348 INIT_LIST_HEAD(&obj->protocols);
350 list_add_tail(&obj->link, &efi_obj_list);
357 * @return status code
359 efi_status_t efi_create_handle(efi_handle_t *handle)
361 struct efi_object *obj;
364 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
365 sizeof(struct efi_object),
367 if (r != EFI_SUCCESS)
370 *handle = obj->handle;
375 * Find a protocol on a handle.
378 * @protocol_guid GUID of the protocol
379 * @handler reference to the protocol
380 * @return status code
382 efi_status_t efi_search_protocol(const efi_handle_t handle,
383 const efi_guid_t *protocol_guid,
384 struct efi_handler **handler)
386 struct efi_object *efiobj;
387 struct list_head *lhandle;
389 if (!handle || !protocol_guid)
390 return EFI_INVALID_PARAMETER;
391 efiobj = efi_search_obj(handle);
393 return EFI_INVALID_PARAMETER;
394 list_for_each(lhandle, &efiobj->protocols) {
395 struct efi_handler *protocol;
397 protocol = list_entry(lhandle, struct efi_handler, link);
398 if (!guidcmp(protocol->guid, protocol_guid)) {
404 return EFI_NOT_FOUND;
408 * Delete protocol from a handle.
410 * @handle handle from which the protocol shall be deleted
411 * @protocol GUID of the protocol to be deleted
412 * @protocol_interface interface of the protocol implementation
413 * @return status code
415 efi_status_t efi_remove_protocol(const efi_handle_t handle,
416 const efi_guid_t *protocol,
417 void *protocol_interface)
419 struct efi_handler *handler;
422 ret = efi_search_protocol(handle, protocol, &handler);
423 if (ret != EFI_SUCCESS)
425 if (guidcmp(handler->guid, protocol))
426 return EFI_INVALID_PARAMETER;
427 list_del(&handler->link);
433 * Delete all protocols from a handle.
435 * @handle handle from which the protocols shall be deleted
436 * @return status code
438 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
440 struct efi_object *efiobj;
441 struct efi_handler *protocol;
442 struct efi_handler *pos;
444 efiobj = efi_search_obj(handle);
446 return EFI_INVALID_PARAMETER;
447 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
450 ret = efi_remove_protocol(handle, protocol->guid,
451 protocol->protocol_interface);
452 if (ret != EFI_SUCCESS)
461 * @handle handle to delete
463 void efi_delete_handle(struct efi_object *obj)
467 efi_remove_all_protocols(obj->handle);
468 list_del(&obj->link);
473 * Our event capabilities are very limited. Only a small limited
474 * number of events is allowed to coexist.
476 static struct efi_event efi_events[16];
481 * This function is used inside U-Boot code to create an event.
483 * For the API function implementing the CreateEvent service see
484 * efi_create_event_ext.
486 * @type type of the event to create
487 * @notify_tpl task priority level of the event
488 * @notify_function notification function of the event
489 * @notify_context pointer passed to the notification function
490 * @event created event
491 * @return status code
493 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
494 void (EFIAPI *notify_function) (
495 struct efi_event *event,
497 void *notify_context, struct efi_event **event)
502 return EFI_INVALID_PARAMETER;
504 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
505 return EFI_INVALID_PARAMETER;
507 if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
508 notify_function == NULL)
509 return EFI_INVALID_PARAMETER;
511 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
512 if (efi_events[i].type)
514 efi_events[i].type = type;
515 efi_events[i].notify_tpl = notify_tpl;
516 efi_events[i].notify_function = notify_function;
517 efi_events[i].notify_context = notify_context;
518 /* Disable timers on bootup */
519 efi_events[i].trigger_next = -1ULL;
520 efi_events[i].is_queued = false;
521 efi_events[i].is_signaled = false;
522 *event = &efi_events[i];
525 return EFI_OUT_OF_RESOURCES;
529 * Create an event in a group.
531 * This function implements the CreateEventEx service.
532 * See the Unified Extensible Firmware Interface (UEFI) specification
534 * TODO: Support event groups
536 * @type type of the event to create
537 * @notify_tpl task priority level of the event
538 * @notify_function notification function of the event
539 * @notify_context pointer passed to the notification function
540 * @event created event
541 * @event_group event group
542 * @return status code
544 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
545 void (EFIAPI *notify_function) (
546 struct efi_event *event,
548 void *notify_context,
549 efi_guid_t *event_group,
550 struct efi_event **event)
552 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
553 notify_context, event_group);
555 return EFI_EXIT(EFI_UNSUPPORTED);
556 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
557 notify_context, event));
563 * This function implements the CreateEvent service.
564 * See the Unified Extensible Firmware Interface (UEFI) specification
567 * @type type of the event to create
568 * @notify_tpl task priority level of the event
569 * @notify_function notification function of the event
570 * @notify_context pointer passed to the notification function
571 * @event created event
572 * @return status code
574 static efi_status_t EFIAPI efi_create_event_ext(
575 uint32_t type, efi_uintn_t notify_tpl,
576 void (EFIAPI *notify_function) (
577 struct efi_event *event,
579 void *notify_context, struct efi_event **event)
581 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
583 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
584 notify_context, event));
589 * Check if a timer event has occurred or a queued notification function should
592 * Our timers have to work without interrupts, so we check whenever keyboard
593 * input or disk accesses happen if enough time elapsed for them to fire.
595 void efi_timer_check(void)
598 u64 now = timer_get_us();
600 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
601 if (!efi_events[i].type)
603 if (efi_events[i].is_queued)
604 efi_signal_event(&efi_events[i], true);
605 if (!(efi_events[i].type & EVT_TIMER) ||
606 now < efi_events[i].trigger_next)
608 switch (efi_events[i].trigger_type) {
609 case EFI_TIMER_RELATIVE:
610 efi_events[i].trigger_type = EFI_TIMER_STOP;
612 case EFI_TIMER_PERIODIC:
613 efi_events[i].trigger_next +=
614 efi_events[i].trigger_time;
619 efi_events[i].is_signaled = true;
620 efi_signal_event(&efi_events[i], true);
626 * Set the trigger time for a timer event or stop the event.
628 * This is the function for internal usage in U-Boot. For the API function
629 * implementing the SetTimer service see efi_set_timer_ext.
631 * @event event for which the timer is set
632 * @type type of the timer
633 * @trigger_time trigger period in multiples of 100ns
634 * @return status code
636 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
637 uint64_t trigger_time)
642 * The parameter defines a multiple of 100ns.
643 * We use multiples of 1000ns. So divide by 10.
645 do_div(trigger_time, 10);
647 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
648 if (event != &efi_events[i])
651 if (!(event->type & EVT_TIMER))
655 event->trigger_next = -1ULL;
657 case EFI_TIMER_PERIODIC:
658 case EFI_TIMER_RELATIVE:
659 event->trigger_next =
660 timer_get_us() + trigger_time;
663 return EFI_INVALID_PARAMETER;
665 event->trigger_type = type;
666 event->trigger_time = trigger_time;
667 event->is_signaled = false;
670 return EFI_INVALID_PARAMETER;
674 * Set the trigger time for a timer event or stop the event.
676 * This function implements the SetTimer service.
677 * See the Unified Extensible Firmware Interface (UEFI) specification
680 * @event event for which the timer is set
681 * @type type of the timer
682 * @trigger_time trigger period in multiples of 100ns
683 * @return status code
685 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
686 enum efi_timer_delay type,
687 uint64_t trigger_time)
689 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
690 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
694 * Wait for events to be signaled.
696 * This function implements the WaitForEvent service.
697 * See the Unified Extensible Firmware Interface (UEFI) specification
700 * @num_events number of events to be waited for
701 * @events events to be waited for
702 * @index index of the event that was signaled
703 * @return status code
705 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
706 struct efi_event **event,
711 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
713 /* Check parameters */
714 if (!num_events || !event)
715 return EFI_EXIT(EFI_INVALID_PARAMETER);
717 if (efi_tpl != TPL_APPLICATION)
718 return EFI_EXIT(EFI_UNSUPPORTED);
719 for (i = 0; i < num_events; ++i) {
720 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
721 if (event[i] == &efi_events[j])
724 return EFI_EXIT(EFI_INVALID_PARAMETER);
726 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
727 return EFI_EXIT(EFI_INVALID_PARAMETER);
728 if (!event[i]->is_signaled)
729 efi_signal_event(event[i], true);
732 /* Wait for signal */
734 for (i = 0; i < num_events; ++i) {
735 if (event[i]->is_signaled)
738 /* Allow events to occur. */
744 * Reset the signal which is passed to the caller to allow periodic
747 event[i]->is_signaled = false;
751 return EFI_EXIT(EFI_SUCCESS);
755 * Signal an EFI event.
757 * This function implements the SignalEvent service.
758 * See the Unified Extensible Firmware Interface (UEFI) specification
761 * This functions sets the signaled state of the event and queues the
762 * notification function for execution.
764 * @event event to signal
765 * @return status code
767 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
771 EFI_ENTRY("%p", event);
772 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
773 if (event != &efi_events[i])
775 if (event->is_signaled)
777 event->is_signaled = true;
778 if (event->type & EVT_NOTIFY_SIGNAL)
779 efi_signal_event(event, true);
782 return EFI_EXIT(EFI_SUCCESS);
786 * Close an EFI event.
788 * This function implements the CloseEvent service.
789 * See the Unified Extensible Firmware Interface (UEFI) specification
792 * @event event to close
793 * @return status code
795 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
799 EFI_ENTRY("%p", event);
800 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
801 if (event == &efi_events[i]) {
803 event->trigger_next = -1ULL;
804 event->is_queued = false;
805 event->is_signaled = false;
806 return EFI_EXIT(EFI_SUCCESS);
809 return EFI_EXIT(EFI_INVALID_PARAMETER);
813 * Check if an event is signaled.
815 * This function implements the CheckEvent service.
816 * See the Unified Extensible Firmware Interface (UEFI) specification
819 * If an event is not signaled yet the notification function is queued.
821 * @event event to check
822 * @return status code
824 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
828 EFI_ENTRY("%p", event);
830 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
831 if (event != &efi_events[i])
833 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
835 if (!event->is_signaled)
836 efi_signal_event(event, true);
837 if (event->is_signaled)
838 return EFI_EXIT(EFI_SUCCESS);
839 return EFI_EXIT(EFI_NOT_READY);
841 return EFI_EXIT(EFI_INVALID_PARAMETER);
845 * Find the internal EFI object for a handle.
847 * @handle handle to find
850 struct efi_object *efi_search_obj(const efi_handle_t handle)
852 struct efi_object *efiobj;
854 list_for_each_entry(efiobj, &efi_obj_list, link) {
855 if (efiobj->handle == handle)
863 * Create open protocol info entry and add it to a protocol.
865 * @handler handler of a protocol
866 * @return open protocol info entry
868 static struct efi_open_protocol_info_entry *efi_create_open_info(
869 struct efi_handler *handler)
871 struct efi_open_protocol_info_item *item;
873 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
876 /* Append the item to the open protocol info list. */
877 list_add_tail(&item->link, &handler->open_infos);
883 * Remove an open protocol info entry from a protocol.
885 * @handler handler of a protocol
886 * @return status code
888 static efi_status_t efi_delete_open_info(
889 struct efi_open_protocol_info_item *item)
891 list_del(&item->link);
897 * Install new protocol on a handle.
899 * @handle handle on which the protocol shall be installed
900 * @protocol GUID of the protocol to be installed
901 * @protocol_interface interface of the protocol implementation
902 * @return status code
904 efi_status_t efi_add_protocol(const efi_handle_t handle,
905 const efi_guid_t *protocol,
906 void *protocol_interface)
908 struct efi_object *efiobj;
909 struct efi_handler *handler;
912 efiobj = efi_search_obj(handle);
914 return EFI_INVALID_PARAMETER;
915 ret = efi_search_protocol(handle, protocol, NULL);
916 if (ret != EFI_NOT_FOUND)
917 return EFI_INVALID_PARAMETER;
918 handler = calloc(1, sizeof(struct efi_handler));
920 return EFI_OUT_OF_RESOURCES;
921 handler->guid = protocol;
922 handler->protocol_interface = protocol_interface;
923 INIT_LIST_HEAD(&handler->open_infos);
924 list_add_tail(&handler->link, &efiobj->protocols);
925 if (!guidcmp(&efi_guid_device_path, protocol))
926 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
931 * Install protocol interface.
933 * This function implements the InstallProtocolInterface service.
934 * See the Unified Extensible Firmware Interface (UEFI) specification
937 * @handle handle on which the protocol shall be installed
938 * @protocol GUID of the protocol to be installed
939 * @protocol_interface_type type of the interface to be installed,
940 * always EFI_NATIVE_INTERFACE
941 * @protocol_interface interface of the protocol implementation
942 * @return status code
944 static efi_status_t EFIAPI efi_install_protocol_interface(
945 void **handle, const efi_guid_t *protocol,
946 int protocol_interface_type, void *protocol_interface)
950 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
953 if (!handle || !protocol ||
954 protocol_interface_type != EFI_NATIVE_INTERFACE) {
955 r = EFI_INVALID_PARAMETER;
959 /* Create new handle if requested. */
961 r = efi_create_handle(handle);
962 if (r != EFI_SUCCESS)
964 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
967 debug("%sEFI: handle %p\n", indent_string(nesting_level),
970 /* Add new protocol */
971 r = efi_add_protocol(*handle, protocol, protocol_interface);
977 * Reinstall protocol interface.
979 * This function implements the ReinstallProtocolInterface service.
980 * See the Unified Extensible Firmware Interface (UEFI) specification
983 * @handle handle on which the protocol shall be
985 * @protocol GUID of the protocol to be installed
986 * @old_interface interface to be removed
987 * @new_interface interface to be installed
988 * @return status code
990 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
991 efi_handle_t handle, const efi_guid_t *protocol,
992 void *old_interface, void *new_interface)
994 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
996 return EFI_EXIT(EFI_ACCESS_DENIED);
1000 * Get all drivers associated to a controller.
1001 * The allocated buffer has to be freed with free().
1003 * @efiobj handle of the controller
1004 * @protocol protocol guid (optional)
1005 * @number_of_drivers number of child controllers
1006 * @driver_handle_buffer handles of the the drivers
1007 * @return status code
1009 static efi_status_t efi_get_drivers(struct efi_object *efiobj,
1010 const efi_guid_t *protocol,
1011 efi_uintn_t *number_of_drivers,
1012 efi_handle_t **driver_handle_buffer)
1014 struct efi_handler *handler;
1015 struct efi_open_protocol_info_item *item;
1016 efi_uintn_t count = 0, i;
1019 /* Count all driver associations */
1020 list_for_each_entry(handler, &efiobj->protocols, link) {
1021 if (protocol && guidcmp(handler->guid, protocol))
1023 list_for_each_entry(item, &handler->open_infos, link) {
1024 if (item->info.attributes &
1025 EFI_OPEN_PROTOCOL_BY_DRIVER)
1030 * Create buffer. In case of duplicate driver assignments the buffer
1031 * will be too large. But that does not harm.
1033 *number_of_drivers = 0;
1034 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1035 if (!*driver_handle_buffer)
1036 return EFI_OUT_OF_RESOURCES;
1037 /* Collect unique driver handles */
1038 list_for_each_entry(handler, &efiobj->protocols, link) {
1039 if (protocol && guidcmp(handler->guid, protocol))
1041 list_for_each_entry(item, &handler->open_infos, link) {
1042 if (item->info.attributes &
1043 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1044 /* Check this is a new driver */
1046 for (i = 0; i < *number_of_drivers; ++i) {
1047 if ((*driver_handle_buffer)[i] ==
1048 item->info.agent_handle)
1051 /* Copy handle to buffer */
1053 i = (*number_of_drivers)++;
1054 (*driver_handle_buffer)[i] =
1055 item->info.agent_handle;
1064 * Disconnect all drivers from a controller.
1066 * This function implements the DisconnectController service.
1067 * See the Unified Extensible Firmware Interface (UEFI) specification
1070 * @efiobj handle of the controller
1071 * @protocol protocol guid (optional)
1072 * @child_handle handle of the child to destroy
1073 * @return status code
1075 static efi_status_t efi_disconnect_all_drivers(
1076 struct efi_object *efiobj,
1077 const efi_guid_t *protocol,
1078 efi_handle_t child_handle)
1080 efi_uintn_t number_of_drivers;
1081 efi_handle_t *driver_handle_buffer;
1082 efi_status_t r, ret;
1084 ret = efi_get_drivers(efiobj, protocol, &number_of_drivers,
1085 &driver_handle_buffer);
1086 if (ret != EFI_SUCCESS)
1089 ret = EFI_NOT_FOUND;
1090 while (number_of_drivers) {
1091 r = EFI_CALL(efi_disconnect_controller(
1093 driver_handle_buffer[--number_of_drivers],
1095 if (r == EFI_SUCCESS)
1098 free(driver_handle_buffer);
1103 * Uninstall protocol interface.
1105 * This function implements the UninstallProtocolInterface service.
1106 * See the Unified Extensible Firmware Interface (UEFI) specification
1109 * @handle handle from which the protocol shall be removed
1110 * @protocol GUID of the protocol to be removed
1111 * @protocol_interface interface to be removed
1112 * @return status code
1114 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
1115 efi_handle_t handle, const efi_guid_t *protocol,
1116 void *protocol_interface)
1118 struct efi_object *efiobj;
1119 struct efi_handler *handler;
1120 struct efi_open_protocol_info_item *item;
1121 struct efi_open_protocol_info_item *pos;
1124 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1127 efiobj = efi_search_obj(handle);
1129 r = EFI_INVALID_PARAMETER;
1132 /* Find the protocol on the handle */
1133 r = efi_search_protocol(handle, protocol, &handler);
1134 if (r != EFI_SUCCESS)
1136 /* Disconnect controllers */
1137 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1138 if (!list_empty(&handler->open_infos)) {
1139 r = EFI_ACCESS_DENIED;
1142 /* Close protocol */
1143 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1144 if (item->info.attributes ==
1145 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1146 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1147 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1148 list_del(&item->link);
1150 if (!list_empty(&handler->open_infos)) {
1151 r = EFI_ACCESS_DENIED;
1154 r = efi_remove_protocol(handle, protocol, protocol_interface);
1160 * Register an event for notification when a protocol is installed.
1162 * This function implements the RegisterProtocolNotify service.
1163 * See the Unified Extensible Firmware Interface (UEFI) specification
1166 * @protocol GUID of the protocol whose installation shall be
1168 * @event event to be signaled upon installation of the protocol
1169 * @registration key for retrieving the registration information
1170 * @return status code
1172 static efi_status_t EFIAPI efi_register_protocol_notify(
1173 const efi_guid_t *protocol,
1174 struct efi_event *event,
1175 void **registration)
1177 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1178 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1182 * Determine if an EFI handle implements a protocol.
1184 * See the documentation of the LocateHandle service in the UEFI specification.
1186 * @search_type selection criterion
1187 * @protocol GUID of the protocol
1188 * @search_key registration key
1190 * @return 0 if the handle implements the protocol
1192 static int efi_search(enum efi_locate_search_type search_type,
1193 const efi_guid_t *protocol, void *search_key,
1194 struct efi_object *efiobj)
1198 switch (search_type) {
1201 case BY_REGISTER_NOTIFY:
1202 /* TODO: RegisterProtocolNotify is not implemented yet */
1205 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1206 return (ret != EFI_SUCCESS);
1208 /* Invalid search type */
1214 * Locate handles implementing a protocol.
1216 * This function is meant for U-Boot internal calls. For the API implementation
1217 * of the LocateHandle service see efi_locate_handle_ext.
1219 * @search_type selection criterion
1220 * @protocol GUID of the protocol
1221 * @search_key registration key
1222 * @buffer_size size of the buffer to receive the handles in bytes
1223 * @buffer buffer to receive the relevant handles
1224 * @return status code
1226 static efi_status_t efi_locate_handle(
1227 enum efi_locate_search_type search_type,
1228 const efi_guid_t *protocol, void *search_key,
1229 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1231 struct efi_object *efiobj;
1232 efi_uintn_t size = 0;
1234 /* Check parameters */
1235 switch (search_type) {
1238 case BY_REGISTER_NOTIFY:
1240 return EFI_INVALID_PARAMETER;
1241 /* RegisterProtocolNotify is not implemented yet */
1242 return EFI_UNSUPPORTED;
1245 return EFI_INVALID_PARAMETER;
1248 return EFI_INVALID_PARAMETER;
1252 * efi_locate_handle_buffer uses this function for
1253 * the calculation of the necessary buffer size.
1254 * So do not require a buffer for buffersize == 0.
1256 if (!buffer_size || (*buffer_size && !buffer))
1257 return EFI_INVALID_PARAMETER;
1259 /* Count how much space we need */
1260 list_for_each_entry(efiobj, &efi_obj_list, link) {
1261 if (!efi_search(search_type, protocol, search_key, efiobj))
1262 size += sizeof(void*);
1265 if (*buffer_size < size) {
1266 *buffer_size = size;
1267 return EFI_BUFFER_TOO_SMALL;
1270 *buffer_size = size;
1272 return EFI_NOT_FOUND;
1274 /* Then fill the array */
1275 list_for_each_entry(efiobj, &efi_obj_list, link) {
1276 if (!efi_search(search_type, protocol, search_key, efiobj))
1277 *buffer++ = efiobj->handle;
1284 * Locate handles implementing a protocol.
1286 * This function implements the LocateHandle service.
1287 * See the Unified Extensible Firmware Interface (UEFI) specification
1290 * @search_type selection criterion
1291 * @protocol GUID of the protocol
1292 * @search_key registration key
1293 * @buffer_size size of the buffer to receive the handles in bytes
1294 * @buffer buffer to receive the relevant handles
1295 * @return 0 if the handle implements the protocol
1297 static efi_status_t EFIAPI efi_locate_handle_ext(
1298 enum efi_locate_search_type search_type,
1299 const efi_guid_t *protocol, void *search_key,
1300 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1302 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1303 buffer_size, buffer);
1305 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1306 buffer_size, buffer));
1309 /* Collapses configuration table entries, removing index i */
1310 static void efi_remove_configuration_table(int i)
1312 struct efi_configuration_table *this = &efi_conf_table[i];
1313 struct efi_configuration_table *next = &efi_conf_table[i+1];
1314 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1316 memmove(this, next, (ulong)end - (ulong)next);
1321 * Adds, updates, or removes a configuration table.
1323 * This function is used for internal calls. For the API implementation of the
1324 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1326 * @guid GUID of the installed table
1327 * @table table to be installed
1328 * @return status code
1330 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1334 /* Check for guid override */
1335 for (i = 0; i < systab.nr_tables; i++) {
1336 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1338 efi_conf_table[i].table = table;
1340 efi_remove_configuration_table(i);
1346 return EFI_NOT_FOUND;
1348 /* No override, check for overflow */
1349 if (i >= ARRAY_SIZE(efi_conf_table))
1350 return EFI_OUT_OF_RESOURCES;
1352 /* Add a new entry */
1353 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1354 efi_conf_table[i].table = table;
1355 systab.nr_tables = i + 1;
1361 * Adds, updates, or removes a configuration table.
1363 * This function implements the InstallConfigurationTable service.
1364 * See the Unified Extensible Firmware Interface (UEFI) specification
1367 * @guid GUID of the installed table
1368 * @table table to be installed
1369 * @return status code
1371 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1374 EFI_ENTRY("%pUl, %p", guid, table);
1375 return EFI_EXIT(efi_install_configuration_table(guid, table));
1379 * Initialize a loaded_image_info + loaded_image_info object with correct
1380 * protocols, boot-device, etc.
1382 * @info loaded image info to be passed to the entry point of the
1384 * @obj internal object associated with the loaded image
1385 * @device_path device path of the loaded image
1386 * @file_path file path of the loaded image
1387 * @return status code
1389 efi_status_t efi_setup_loaded_image(
1390 struct efi_loaded_image *info, struct efi_object *obj,
1391 struct efi_device_path *device_path,
1392 struct efi_device_path *file_path)
1396 /* Add internal object to object list */
1397 efi_add_handle(obj);
1398 /* efi_exit() assumes that the handle points to the info */
1401 info->file_path = file_path;
1404 info->device_handle = efi_dp_find_obj(device_path, NULL);
1406 * When asking for the device path interface, return
1407 * bootefi_device_path
1409 ret = efi_add_protocol(obj->handle, &efi_guid_device_path,
1411 if (ret != EFI_SUCCESS)
1416 * When asking for the loaded_image interface, just
1417 * return handle which points to loaded_image_info
1419 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1420 if (ret != EFI_SUCCESS)
1423 ret = efi_add_protocol(obj->handle,
1424 &efi_guid_device_path_to_text_protocol,
1425 (void *)&efi_device_path_to_text);
1426 if (ret != EFI_SUCCESS)
1429 ret = efi_add_protocol(obj->handle,
1430 &efi_guid_device_path_utilities_protocol,
1431 (void *)&efi_device_path_utilities);
1432 if (ret != EFI_SUCCESS)
1437 printf("ERROR: Failure to install protocols for loaded image\n");
1442 * Load an image using a file path.
1444 * @file_path the path of the image to load
1445 * @buffer buffer containing the loaded image
1446 * @return status code
1448 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1451 struct efi_file_info *info = NULL;
1452 struct efi_file_handle *f;
1453 static efi_status_t ret;
1456 f = efi_file_from_path(file_path);
1458 return EFI_DEVICE_ERROR;
1461 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1463 if (ret == EFI_BUFFER_TOO_SMALL) {
1465 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1468 if (ret != EFI_SUCCESS)
1471 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1475 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1479 EFI_CALL(f->close(f));
1481 if (ret != EFI_SUCCESS) {
1482 efi_free_pool(*buffer);
1490 * Load an EFI image into memory.
1492 * This function implements the LoadImage service.
1493 * See the Unified Extensible Firmware Interface (UEFI) specification
1496 * @boot_policy true for request originating from the boot manager
1497 * @parent_image the caller's image handle
1498 * @file_path the path of the image to load
1499 * @source_buffer memory location from which the image is installed
1500 * @source_size size of the memory area from which the image is
1502 * @image_handle handle for the newly installed image
1503 * @return status code
1505 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1506 efi_handle_t parent_image,
1507 struct efi_device_path *file_path,
1508 void *source_buffer,
1509 unsigned long source_size,
1510 efi_handle_t *image_handle)
1512 struct efi_loaded_image *info;
1513 struct efi_object *obj;
1516 EFI_ENTRY("%d, %p, %pD, %p, %ld, %p", boot_policy, parent_image,
1517 file_path, source_buffer, source_size, image_handle);
1519 if (!image_handle || !parent_image) {
1520 ret = EFI_INVALID_PARAMETER;
1524 if (!source_buffer && !file_path) {
1525 ret = EFI_NOT_FOUND;
1529 info = calloc(1, sizeof(*info));
1531 ret = EFI_OUT_OF_RESOURCES;
1534 obj = calloc(1, sizeof(*obj));
1537 ret = EFI_OUT_OF_RESOURCES;
1541 if (!source_buffer) {
1542 struct efi_device_path *dp, *fp;
1544 ret = efi_load_image_from_path(file_path, &source_buffer);
1545 if (ret != EFI_SUCCESS)
1548 * split file_path which contains both the device and
1551 efi_dp_split_file_path(file_path, &dp, &fp);
1552 ret = efi_setup_loaded_image(info, obj, dp, fp);
1553 if (ret != EFI_SUCCESS)
1556 /* In this case, file_path is the "device" path, ie.
1557 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1559 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1560 if (ret != EFI_SUCCESS)
1563 info->reserved = efi_load_pe(source_buffer, info);
1564 if (!info->reserved) {
1565 ret = EFI_UNSUPPORTED;
1568 info->system_table = &systab;
1569 info->parent_handle = parent_image;
1570 *image_handle = obj->handle;
1571 return EFI_EXIT(EFI_SUCCESS);
1574 efi_delete_handle(obj);
1576 return EFI_EXIT(ret);
1580 * Call the entry point of an image.
1582 * This function implements the StartImage service.
1583 * See the Unified Extensible Firmware Interface (UEFI) specification
1586 * @image_handle handle of the image
1587 * @exit_data_size size of the buffer
1588 * @exit_data buffer to receive the exit data of the called image
1589 * @return status code
1591 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1592 unsigned long *exit_data_size,
1595 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
1596 struct efi_system_table *st);
1597 struct efi_loaded_image *info = image_handle;
1600 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1601 entry = info->reserved;
1603 efi_is_direct_boot = false;
1605 /* call the image! */
1606 if (setjmp(&info->exit_jmp)) {
1608 * We called the entry point of the child image with EFI_CALL
1609 * in the lines below. The child image called the Exit() boot
1610 * service efi_exit() which executed the long jump that brought
1611 * us to the current line. This implies that the second half
1612 * of the EFI_CALL macro has not been executed.
1616 * efi_exit() called efi_restore_gd(). We have to undo this
1617 * otherwise __efi_entry_check() will put the wrong value into
1623 * To get ready to call EFI_EXIT below we have to execute the
1624 * missed out steps of EFI_CALL.
1626 assert(__efi_entry_check());
1627 debug("%sEFI: %lu returned by started image\n",
1628 __efi_nesting_dec(),
1629 (unsigned long)((uintptr_t)info->exit_status &
1631 return EFI_EXIT(info->exit_status);
1634 ret = EFI_CALL(entry(image_handle, &systab));
1637 * Usually UEFI applications call Exit() instead of returning.
1638 * But because the world doesn not consist of ponies and unicorns,
1639 * we're happy to emulate that behavior on behalf of a payload
1642 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
1646 * Leave an EFI application or driver.
1648 * This function implements the Exit service.
1649 * See the Unified Extensible Firmware Interface (UEFI) specification
1652 * @image_handle handle of the application or driver that is exiting
1653 * @exit_status status code
1654 * @exit_data_size size of the buffer in bytes
1655 * @exit_data buffer with data describing an error
1656 * @return status code
1658 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1659 efi_status_t exit_status, unsigned long exit_data_size,
1663 * We require that the handle points to the original loaded
1664 * image protocol interface.
1666 * For getting the longjmp address this is safer than locating
1667 * the protocol because the protocol may have been reinstalled
1668 * pointing to another memory location.
1670 * TODO: We should call the unload procedure of the loaded
1673 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1675 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1676 exit_data_size, exit_data);
1678 /* Make sure entry/exit counts for EFI world cross-overs match */
1679 EFI_EXIT(exit_status);
1682 * But longjmp out with the U-Boot gd, not the application's, as
1683 * the other end is a setjmp call inside EFI context.
1687 loaded_image_info->exit_status = exit_status;
1688 longjmp(&loaded_image_info->exit_jmp, 1);
1690 panic("EFI application exited");
1694 * Unload an EFI image.
1696 * This function implements the UnloadImage service.
1697 * See the Unified Extensible Firmware Interface (UEFI) specification
1700 * @image_handle handle of the image to be unloaded
1701 * @return status code
1703 static efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
1705 struct efi_object *efiobj;
1707 EFI_ENTRY("%p", image_handle);
1708 efiobj = efi_search_obj(image_handle);
1710 list_del(&efiobj->link);
1712 return EFI_EXIT(EFI_SUCCESS);
1716 * Fix up caches for EFI payloads if necessary.
1718 static void efi_exit_caches(void)
1720 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1722 * Grub on 32bit ARM needs to have caches disabled before jumping into
1723 * a zImage, but does not know of all cache layers. Give it a hand.
1725 if (efi_is_direct_boot)
1726 cleanup_before_linux();
1731 * Stop all boot services.
1733 * This function implements the ExitBootServices service.
1734 * See the Unified Extensible Firmware Interface (UEFI) specification
1737 * All timer events are disabled.
1738 * For exit boot services events the notification function is called.
1739 * The boot services are disabled in the system table.
1741 * @image_handle handle of the loaded image
1742 * @map_key key of the memory map
1743 * @return status code
1745 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1746 unsigned long map_key)
1750 EFI_ENTRY("%p, %ld", image_handle, map_key);
1752 /* Make sure that notification functions are not called anymore */
1753 efi_tpl = TPL_HIGH_LEVEL;
1755 /* Check if ExitBootServices has already been called */
1756 if (!systab.boottime)
1757 return EFI_EXIT(EFI_SUCCESS);
1759 /* Notify that ExitBootServices is invoked. */
1760 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1761 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1763 efi_events[i].is_signaled = true;
1764 efi_signal_event(&efi_events[i], false);
1767 /* TODO Should persist EFI variables here */
1769 board_quiesce_devices();
1771 /* Fix up caches for EFI payloads if necessary */
1774 /* This stops all lingering devices */
1775 bootm_disable_interrupts();
1777 /* Disable boottime services */
1778 systab.con_in_handle = NULL;
1779 systab.con_in = NULL;
1780 systab.con_out_handle = NULL;
1781 systab.con_out = NULL;
1782 systab.stderr_handle = NULL;
1783 systab.std_err = NULL;
1784 systab.boottime = NULL;
1786 /* Recalculate CRC32 */
1787 systab.hdr.crc32 = 0;
1788 systab.hdr.crc32 = crc32(0, (const unsigned char *)&systab,
1789 sizeof(struct efi_system_table));
1791 /* Give the payload some time to boot */
1792 efi_set_watchdog(0);
1795 return EFI_EXIT(EFI_SUCCESS);
1799 * Get next value of the counter.
1801 * This function implements the NextMonotonicCount service.
1802 * See the Unified Extensible Firmware Interface (UEFI) specification
1805 * @count returned value of the counter
1806 * @return status code
1808 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1810 static uint64_t mono = 0;
1811 EFI_ENTRY("%p", count);
1813 return EFI_EXIT(EFI_SUCCESS);
1819 * This function implements the Stall sercive.
1820 * See the Unified Extensible Firmware Interface (UEFI) specification
1823 * @microseconds period to sleep in microseconds
1824 * @return status code
1826 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1828 EFI_ENTRY("%ld", microseconds);
1829 udelay(microseconds);
1830 return EFI_EXIT(EFI_SUCCESS);
1834 * Reset the watchdog timer.
1836 * This function implements the SetWatchdogTimer service.
1837 * See the Unified Extensible Firmware Interface (UEFI) specification
1840 * @timeout seconds before reset by watchdog
1841 * @watchdog_code code to be logged when resetting
1842 * @data_size size of buffer in bytes
1843 * @watchdog_data buffer with data describing the reset reason
1844 * @return status code
1846 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1847 uint64_t watchdog_code,
1848 unsigned long data_size,
1849 uint16_t *watchdog_data)
1851 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1852 data_size, watchdog_data);
1853 return EFI_EXIT(efi_set_watchdog(timeout));
1859 * This function implements the CloseProtocol service.
1860 * See the Unified Extensible Firmware Interface (UEFI) specification
1863 * @handle handle on which the protocol shall be closed
1864 * @protocol GUID of the protocol to close
1865 * @agent_handle handle of the driver
1866 * @controller_handle handle of the controller
1867 * @return status code
1869 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1870 const efi_guid_t *protocol,
1871 efi_handle_t agent_handle,
1872 efi_handle_t controller_handle)
1874 struct efi_handler *handler;
1875 struct efi_open_protocol_info_item *item;
1876 struct efi_open_protocol_info_item *pos;
1879 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1882 if (!agent_handle) {
1883 r = EFI_INVALID_PARAMETER;
1886 r = efi_search_protocol(handle, protocol, &handler);
1887 if (r != EFI_SUCCESS)
1891 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1892 if (item->info.agent_handle == agent_handle &&
1893 item->info.controller_handle == controller_handle) {
1894 efi_delete_open_info(item);
1904 * Provide information about then open status of a protocol on a handle
1906 * This function implements the OpenProtocolInformation service.
1907 * See the Unified Extensible Firmware Interface (UEFI) specification
1910 * @handle handle for which the information shall be retrieved
1911 * @protocol GUID of the protocol
1912 * @entry_buffer buffer to receive the open protocol information
1913 * @entry_count number of entries available in the buffer
1914 * @return status code
1916 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1917 const efi_guid_t *protocol,
1918 struct efi_open_protocol_info_entry **entry_buffer,
1919 efi_uintn_t *entry_count)
1921 unsigned long buffer_size;
1922 unsigned long count;
1923 struct efi_handler *handler;
1924 struct efi_open_protocol_info_item *item;
1927 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1930 /* Check parameters */
1931 if (!entry_buffer) {
1932 r = EFI_INVALID_PARAMETER;
1935 r = efi_search_protocol(handle, protocol, &handler);
1936 if (r != EFI_SUCCESS)
1941 list_for_each_entry(item, &handler->open_infos, link) {
1942 if (item->info.open_count)
1945 *entry_count = count;
1946 *entry_buffer = NULL;
1953 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
1954 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1955 (void **)entry_buffer);
1956 if (r != EFI_SUCCESS)
1958 list_for_each_entry_reverse(item, &handler->open_infos, link) {
1959 if (item->info.open_count)
1960 (*entry_buffer)[--count] = item->info;
1967 * Get protocols installed on a handle.
1969 * This function implements the ProtocolsPerHandleService.
1970 * See the Unified Extensible Firmware Interface (UEFI) specification
1973 * @handle handle for which the information is retrieved
1974 * @protocol_buffer buffer with protocol GUIDs
1975 * @protocol_buffer_count number of entries in the buffer
1976 * @return status code
1978 static efi_status_t EFIAPI efi_protocols_per_handle(
1979 efi_handle_t handle, efi_guid_t ***protocol_buffer,
1980 efi_uintn_t *protocol_buffer_count)
1982 unsigned long buffer_size;
1983 struct efi_object *efiobj;
1984 struct list_head *protocol_handle;
1987 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1988 protocol_buffer_count);
1990 if (!handle || !protocol_buffer || !protocol_buffer_count)
1991 return EFI_EXIT(EFI_INVALID_PARAMETER);
1993 *protocol_buffer = NULL;
1994 *protocol_buffer_count = 0;
1996 efiobj = efi_search_obj(handle);
1998 return EFI_EXIT(EFI_INVALID_PARAMETER);
2000 /* Count protocols */
2001 list_for_each(protocol_handle, &efiobj->protocols) {
2002 ++*protocol_buffer_count;
2006 if (*protocol_buffer_count) {
2009 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2010 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2011 (void **)protocol_buffer);
2012 if (r != EFI_SUCCESS)
2014 list_for_each(protocol_handle, &efiobj->protocols) {
2015 struct efi_handler *protocol;
2017 protocol = list_entry(protocol_handle,
2018 struct efi_handler, link);
2019 (*protocol_buffer)[j] = (void *)protocol->guid;
2024 return EFI_EXIT(EFI_SUCCESS);
2028 * Locate handles implementing a protocol.
2030 * This function implements the LocateHandleBuffer service.
2031 * See the Unified Extensible Firmware Interface (UEFI) specification
2034 * @search_type selection criterion
2035 * @protocol GUID of the protocol
2036 * @search_key registration key
2037 * @no_handles number of returned handles
2038 * @buffer buffer with the returned handles
2039 * @return status code
2041 static efi_status_t EFIAPI efi_locate_handle_buffer(
2042 enum efi_locate_search_type search_type,
2043 const efi_guid_t *protocol, void *search_key,
2044 efi_uintn_t *no_handles, efi_handle_t **buffer)
2047 efi_uintn_t buffer_size = 0;
2049 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2050 no_handles, buffer);
2052 if (!no_handles || !buffer) {
2053 r = EFI_INVALID_PARAMETER;
2058 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2060 if (r != EFI_BUFFER_TOO_SMALL)
2062 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2064 if (r != EFI_SUCCESS)
2066 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2068 if (r == EFI_SUCCESS)
2069 *no_handles = buffer_size / sizeof(efi_handle_t);
2075 * Find an interface implementing a protocol.
2077 * This function implements the LocateProtocol service.
2078 * See the Unified Extensible Firmware Interface (UEFI) specification
2081 * @protocol GUID of the protocol
2082 * @registration registration key passed to the notification function
2083 * @protocol_interface interface implementing the protocol
2084 * @return status code
2086 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2088 void **protocol_interface)
2090 struct list_head *lhandle;
2093 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2095 if (!protocol || !protocol_interface)
2096 return EFI_EXIT(EFI_INVALID_PARAMETER);
2098 list_for_each(lhandle, &efi_obj_list) {
2099 struct efi_object *efiobj;
2100 struct efi_handler *handler;
2102 efiobj = list_entry(lhandle, struct efi_object, link);
2104 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
2105 if (ret == EFI_SUCCESS) {
2106 *protocol_interface = handler->protocol_interface;
2107 return EFI_EXIT(EFI_SUCCESS);
2110 *protocol_interface = NULL;
2112 return EFI_EXIT(EFI_NOT_FOUND);
2116 * Get the device path and handle of an device implementing a protocol.
2118 * This function implements the LocateDevicePath service.
2119 * See the Unified Extensible Firmware Interface (UEFI) specification
2122 * @protocol GUID of the protocol
2123 * @device_path device path
2124 * @device handle of the device
2125 * @return status code
2127 static efi_status_t EFIAPI efi_locate_device_path(
2128 const efi_guid_t *protocol,
2129 struct efi_device_path **device_path,
2130 efi_handle_t *device)
2132 struct efi_device_path *dp;
2134 struct efi_handler *handler;
2135 efi_handle_t *handles;
2137 size_t len_best = 0;
2138 efi_uintn_t no_handles;
2142 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2144 if (!protocol || !device_path || !*device_path || !device) {
2145 ret = EFI_INVALID_PARAMETER;
2149 /* Find end of device path */
2150 len = efi_dp_size(*device_path);
2152 /* Get all handles implementing the protocol */
2153 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2154 &no_handles, &handles));
2155 if (ret != EFI_SUCCESS)
2158 for (i = 0; i < no_handles; ++i) {
2159 /* Find the device path protocol */
2160 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2162 if (ret != EFI_SUCCESS)
2164 dp = (struct efi_device_path *)handler->protocol_interface;
2165 len_dp = efi_dp_size(dp);
2167 * This handle can only be a better fit
2168 * if its device path length is longer than the best fit and
2169 * if its device path length is shorter of equal the searched
2172 if (len_dp <= len_best || len_dp > len)
2174 /* Check if dp is a subpath of device_path */
2175 if (memcmp(*device_path, dp, len_dp))
2177 *device = handles[i];
2181 remainder = (u8 *)*device_path + len_best;
2182 *device_path = (struct efi_device_path *)remainder;
2185 ret = EFI_NOT_FOUND;
2188 return EFI_EXIT(ret);
2192 * Install multiple protocol interfaces.
2194 * This function implements the MultipleProtocolInterfaces service.
2195 * See the Unified Extensible Firmware Interface (UEFI) specification
2198 * @handle handle on which the protocol interfaces shall be installed
2199 * @... NULL terminated argument list with pairs of protocol GUIDS and
2201 * @return status code
2203 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2206 EFI_ENTRY("%p", handle);
2209 const efi_guid_t *protocol;
2210 void *protocol_interface;
2211 efi_status_t r = EFI_SUCCESS;
2215 return EFI_EXIT(EFI_INVALID_PARAMETER);
2217 va_start(argptr, handle);
2219 protocol = va_arg(argptr, efi_guid_t*);
2222 protocol_interface = va_arg(argptr, void*);
2223 r = EFI_CALL(efi_install_protocol_interface(
2225 EFI_NATIVE_INTERFACE,
2226 protocol_interface));
2227 if (r != EFI_SUCCESS)
2232 if (r == EFI_SUCCESS)
2235 /* If an error occurred undo all changes. */
2236 va_start(argptr, handle);
2238 protocol = va_arg(argptr, efi_guid_t*);
2239 protocol_interface = va_arg(argptr, void*);
2240 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2241 protocol_interface));
2249 * Uninstall multiple protocol interfaces.
2251 * This function implements the UninstallMultipleProtocolInterfaces service.
2252 * See the Unified Extensible Firmware Interface (UEFI) specification
2255 * @handle handle from which the protocol interfaces shall be removed
2256 * @... NULL terminated argument list with pairs of protocol GUIDS and
2258 * @return status code
2260 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2263 EFI_ENTRY("%p", handle);
2266 const efi_guid_t *protocol;
2267 void *protocol_interface;
2268 efi_status_t r = EFI_SUCCESS;
2272 return EFI_EXIT(EFI_INVALID_PARAMETER);
2274 va_start(argptr, handle);
2276 protocol = va_arg(argptr, efi_guid_t*);
2279 protocol_interface = va_arg(argptr, void*);
2280 r = EFI_CALL(efi_uninstall_protocol_interface(
2282 protocol_interface));
2283 if (r != EFI_SUCCESS)
2288 if (r == EFI_SUCCESS)
2291 /* If an error occurred undo all changes. */
2292 va_start(argptr, handle);
2294 protocol = va_arg(argptr, efi_guid_t*);
2295 protocol_interface = va_arg(argptr, void*);
2296 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2297 EFI_NATIVE_INTERFACE,
2298 protocol_interface));
2306 * Calculate cyclic redundancy code.
2308 * This function implements the CalculateCrc32 service.
2309 * See the Unified Extensible Firmware Interface (UEFI) specification
2312 * @data buffer with data
2313 * @data_size size of buffer in bytes
2314 * @crc32_p cyclic redundancy code
2315 * @return status code
2317 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2318 unsigned long data_size,
2321 EFI_ENTRY("%p, %ld", data, data_size);
2322 *crc32_p = crc32(0, data, data_size);
2323 return EFI_EXIT(EFI_SUCCESS);
2329 * This function implements the CopyMem service.
2330 * See the Unified Extensible Firmware Interface (UEFI) specification
2333 * @destination destination of the copy operation
2334 * @source source of the copy operation
2335 * @length number of bytes to copy
2337 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2340 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2341 memcpy(destination, source, length);
2342 EFI_EXIT(EFI_SUCCESS);
2346 * Fill memory with a byte value.
2348 * This function implements the SetMem service.
2349 * See the Unified Extensible Firmware Interface (UEFI) specification
2352 * @buffer buffer to fill
2353 * @size size of buffer in bytes
2354 * @value byte to copy to the buffer
2356 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2358 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2359 memset(buffer, value, size);
2360 EFI_EXIT(EFI_SUCCESS);
2364 * Open protocol interface on a handle.
2366 * @handler handler of a protocol
2367 * @protocol_interface interface implementing the protocol
2368 * @agent_handle handle of the driver
2369 * @controller_handle handle of the controller
2370 * @attributes attributes indicating how to open the protocol
2371 * @return status code
2373 static efi_status_t efi_protocol_open(
2374 struct efi_handler *handler,
2375 void **protocol_interface, void *agent_handle,
2376 void *controller_handle, uint32_t attributes)
2378 struct efi_open_protocol_info_item *item;
2379 struct efi_open_protocol_info_entry *match = NULL;
2380 bool opened_by_driver = false;
2381 bool opened_exclusive = false;
2383 /* If there is no agent, only return the interface */
2387 /* For TEST_PROTOCOL ignore interface attribute */
2388 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2389 *protocol_interface = NULL;
2392 * Check if the protocol is already opened by a driver with the same
2393 * attributes or opened exclusively
2395 list_for_each_entry(item, &handler->open_infos, link) {
2396 if (item->info.agent_handle == agent_handle) {
2397 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2398 (item->info.attributes == attributes))
2399 return EFI_ALREADY_STARTED;
2401 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2402 opened_exclusive = true;
2405 /* Only one controller can open the protocol exclusively */
2406 if (opened_exclusive && attributes &
2407 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2408 return EFI_ACCESS_DENIED;
2410 /* Prepare exclusive opening */
2411 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2412 /* Try to disconnect controllers */
2413 list_for_each_entry(item, &handler->open_infos, link) {
2414 if (item->info.attributes ==
2415 EFI_OPEN_PROTOCOL_BY_DRIVER)
2416 EFI_CALL(efi_disconnect_controller(
2417 item->info.controller_handle,
2418 item->info.agent_handle,
2421 opened_by_driver = false;
2422 /* Check if all controllers are disconnected */
2423 list_for_each_entry(item, &handler->open_infos, link) {
2424 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2425 opened_by_driver = true;
2427 /* Only one controller can be conncected */
2428 if (opened_by_driver)
2429 return EFI_ACCESS_DENIED;
2432 /* Find existing entry */
2433 list_for_each_entry(item, &handler->open_infos, link) {
2434 if (item->info.agent_handle == agent_handle &&
2435 item->info.controller_handle == controller_handle)
2436 match = &item->info;
2438 /* None found, create one */
2440 match = efi_create_open_info(handler);
2442 return EFI_OUT_OF_RESOURCES;
2445 match->agent_handle = agent_handle;
2446 match->controller_handle = controller_handle;
2447 match->attributes = attributes;
2448 match->open_count++;
2451 /* For TEST_PROTOCOL ignore interface attribute. */
2452 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2453 *protocol_interface = handler->protocol_interface;
2459 * Open protocol interface on a handle.
2461 * This function implements the OpenProtocol interface.
2462 * See the Unified Extensible Firmware Interface (UEFI) specification
2465 * @handle handle on which the protocol shall be opened
2466 * @protocol GUID of the protocol
2467 * @protocol_interface interface implementing the protocol
2468 * @agent_handle handle of the driver
2469 * @controller_handle handle of the controller
2470 * @attributes attributes indicating how to open the protocol
2471 * @return status code
2473 static efi_status_t EFIAPI efi_open_protocol(
2474 void *handle, const efi_guid_t *protocol,
2475 void **protocol_interface, void *agent_handle,
2476 void *controller_handle, uint32_t attributes)
2478 struct efi_handler *handler;
2479 efi_status_t r = EFI_INVALID_PARAMETER;
2481 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2482 protocol_interface, agent_handle, controller_handle,
2485 if (!handle || !protocol ||
2486 (!protocol_interface && attributes !=
2487 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2491 switch (attributes) {
2492 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2493 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2494 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2496 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2497 if (controller_handle == handle)
2500 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2501 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2502 /* Check that the controller handle is valid */
2503 if (!efi_search_obj(controller_handle))
2506 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2507 /* Check that the agent handle is valid */
2508 if (!efi_search_obj(agent_handle))
2515 r = efi_search_protocol(handle, protocol, &handler);
2516 if (r != EFI_SUCCESS)
2519 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2520 controller_handle, attributes);
2526 * Get interface of a protocol on a handle.
2528 * This function implements the HandleProtocol service.
2529 * See the Unified Extensible Firmware Interface (UEFI) specification
2532 * @handle handle on which the protocol shall be opened
2533 * @protocol GUID of the protocol
2534 * @protocol_interface interface implementing the protocol
2535 * @return status code
2537 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2538 const efi_guid_t *protocol,
2539 void **protocol_interface)
2541 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2542 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2545 static efi_status_t efi_bind_controller(
2546 efi_handle_t controller_handle,
2547 efi_handle_t driver_image_handle,
2548 struct efi_device_path *remain_device_path)
2550 struct efi_driver_binding_protocol *binding_protocol;
2553 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2554 &efi_guid_driver_binding_protocol,
2555 (void **)&binding_protocol,
2556 driver_image_handle, NULL,
2557 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2558 if (r != EFI_SUCCESS)
2560 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2562 remain_device_path));
2563 if (r == EFI_SUCCESS)
2564 r = EFI_CALL(binding_protocol->start(binding_protocol,
2566 remain_device_path));
2567 EFI_CALL(efi_close_protocol(driver_image_handle,
2568 &efi_guid_driver_binding_protocol,
2569 driver_image_handle, NULL));
2573 static efi_status_t efi_connect_single_controller(
2574 efi_handle_t controller_handle,
2575 efi_handle_t *driver_image_handle,
2576 struct efi_device_path *remain_device_path)
2578 efi_handle_t *buffer;
2582 size_t connected = 0;
2584 /* Get buffer with all handles with driver binding protocol */
2585 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2586 &efi_guid_driver_binding_protocol,
2587 NULL, &count, &buffer));
2588 if (r != EFI_SUCCESS)
2591 /* Context Override */
2592 if (driver_image_handle) {
2593 for (; *driver_image_handle; ++driver_image_handle) {
2594 for (i = 0; i < count; ++i) {
2595 if (buffer[i] == *driver_image_handle) {
2597 r = efi_bind_controller(
2599 *driver_image_handle,
2600 remain_device_path);
2602 * For drivers that do not support the
2603 * controller or are already connected
2604 * we receive an error code here.
2606 if (r == EFI_SUCCESS)
2614 * TODO: Some overrides are not yet implemented:
2615 * - Platform Driver Override
2616 * - Driver Family Override Search
2617 * - Bus Specific Driver Override
2620 /* Driver Binding Search */
2621 for (i = 0; i < count; ++i) {
2623 r = efi_bind_controller(controller_handle,
2625 remain_device_path);
2626 if (r == EFI_SUCCESS)
2631 efi_free_pool(buffer);
2633 return EFI_NOT_FOUND;
2638 * Connect a controller to a driver.
2640 * This function implements the ConnectController service.
2641 * See the Unified Extensible Firmware Interface (UEFI) specification
2644 * First all driver binding protocol handles are tried for binding drivers.
2645 * Afterwards all handles that have openened a protocol of the controller
2646 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2648 * @controller_handle handle of the controller
2649 * @driver_image_handle handle of the driver
2650 * @remain_device_path device path of a child controller
2651 * @recursive true to connect all child controllers
2652 * @return status code
2654 static efi_status_t EFIAPI efi_connect_controller(
2655 efi_handle_t controller_handle,
2656 efi_handle_t *driver_image_handle,
2657 struct efi_device_path *remain_device_path,
2661 efi_status_t ret = EFI_NOT_FOUND;
2662 struct efi_object *efiobj;
2664 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
2665 remain_device_path, recursive);
2667 efiobj = efi_search_obj(controller_handle);
2669 ret = EFI_INVALID_PARAMETER;
2673 r = efi_connect_single_controller(controller_handle,
2674 driver_image_handle,
2675 remain_device_path);
2676 if (r == EFI_SUCCESS)
2679 struct efi_handler *handler;
2680 struct efi_open_protocol_info_item *item;
2682 list_for_each_entry(handler, &efiobj->protocols, link) {
2683 list_for_each_entry(item, &handler->open_infos, link) {
2684 if (item->info.attributes &
2685 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2686 r = EFI_CALL(efi_connect_controller(
2687 item->info.controller_handle,
2688 driver_image_handle,
2691 if (r == EFI_SUCCESS)
2697 /* Check for child controller specified by end node */
2698 if (ret != EFI_SUCCESS && remain_device_path &&
2699 remain_device_path->type == DEVICE_PATH_TYPE_END)
2702 return EFI_EXIT(ret);
2706 * Get all child controllers associated to a driver.
2707 * The allocated buffer has to be freed with free().
2709 * @efiobj handle of the controller
2710 * @driver_handle handle of the driver
2711 * @number_of_children number of child controllers
2712 * @child_handle_buffer handles of the the child controllers
2714 static efi_status_t efi_get_child_controllers(
2715 struct efi_object *efiobj,
2716 efi_handle_t driver_handle,
2717 efi_uintn_t *number_of_children,
2718 efi_handle_t **child_handle_buffer)
2720 struct efi_handler *handler;
2721 struct efi_open_protocol_info_item *item;
2722 efi_uintn_t count = 0, i;
2725 /* Count all child controller associations */
2726 list_for_each_entry(handler, &efiobj->protocols, link) {
2727 list_for_each_entry(item, &handler->open_infos, link) {
2728 if (item->info.agent_handle == driver_handle &&
2729 item->info.attributes &
2730 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
2735 * Create buffer. In case of duplicate child controller assignments
2736 * the buffer will be too large. But that does not harm.
2738 *number_of_children = 0;
2739 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
2740 if (!*child_handle_buffer)
2741 return EFI_OUT_OF_RESOURCES;
2742 /* Copy unique child handles */
2743 list_for_each_entry(handler, &efiobj->protocols, link) {
2744 list_for_each_entry(item, &handler->open_infos, link) {
2745 if (item->info.agent_handle == driver_handle &&
2746 item->info.attributes &
2747 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2748 /* Check this is a new child controller */
2750 for (i = 0; i < *number_of_children; ++i) {
2751 if ((*child_handle_buffer)[i] ==
2752 item->info.controller_handle)
2755 /* Copy handle to buffer */
2757 i = (*number_of_children)++;
2758 (*child_handle_buffer)[i] =
2759 item->info.controller_handle;
2768 * Disconnect a controller from a driver.
2770 * This function implements the DisconnectController service.
2771 * See the Unified Extensible Firmware Interface (UEFI) specification
2774 * @controller_handle handle of the controller
2775 * @driver_image_handle handle of the driver
2776 * @child_handle handle of the child to destroy
2777 * @return status code
2779 static efi_status_t EFIAPI efi_disconnect_controller(
2780 efi_handle_t controller_handle,
2781 efi_handle_t driver_image_handle,
2782 efi_handle_t child_handle)
2784 struct efi_driver_binding_protocol *binding_protocol;
2785 efi_handle_t *child_handle_buffer = NULL;
2786 size_t number_of_children = 0;
2788 size_t stop_count = 0;
2789 struct efi_object *efiobj;
2791 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
2794 efiobj = efi_search_obj(controller_handle);
2796 r = EFI_INVALID_PARAMETER;
2800 if (child_handle && !efi_search_obj(child_handle)) {
2801 r = EFI_INVALID_PARAMETER;
2805 /* If no driver handle is supplied, disconnect all drivers */
2806 if (!driver_image_handle) {
2807 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
2811 /* Create list of child handles */
2813 number_of_children = 1;
2814 child_handle_buffer = &child_handle;
2816 efi_get_child_controllers(efiobj,
2817 driver_image_handle,
2818 &number_of_children,
2819 &child_handle_buffer);
2822 /* Get the driver binding protocol */
2823 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2824 &efi_guid_driver_binding_protocol,
2825 (void **)&binding_protocol,
2826 driver_image_handle, NULL,
2827 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2828 if (r != EFI_SUCCESS)
2830 /* Remove the children */
2831 if (number_of_children) {
2832 r = EFI_CALL(binding_protocol->stop(binding_protocol,
2835 child_handle_buffer));
2836 if (r == EFI_SUCCESS)
2839 /* Remove the driver */
2841 r = EFI_CALL(binding_protocol->stop(binding_protocol,
2844 if (r == EFI_SUCCESS)
2846 EFI_CALL(efi_close_protocol(driver_image_handle,
2847 &efi_guid_driver_binding_protocol,
2848 driver_image_handle, NULL));
2856 free(child_handle_buffer);
2860 static const struct efi_boot_services efi_boot_services = {
2862 .headersize = sizeof(struct efi_table_hdr),
2864 .raise_tpl = efi_raise_tpl,
2865 .restore_tpl = efi_restore_tpl,
2866 .allocate_pages = efi_allocate_pages_ext,
2867 .free_pages = efi_free_pages_ext,
2868 .get_memory_map = efi_get_memory_map_ext,
2869 .allocate_pool = efi_allocate_pool_ext,
2870 .free_pool = efi_free_pool_ext,
2871 .create_event = efi_create_event_ext,
2872 .set_timer = efi_set_timer_ext,
2873 .wait_for_event = efi_wait_for_event,
2874 .signal_event = efi_signal_event_ext,
2875 .close_event = efi_close_event,
2876 .check_event = efi_check_event,
2877 .install_protocol_interface = efi_install_protocol_interface,
2878 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2879 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2880 .handle_protocol = efi_handle_protocol,
2882 .register_protocol_notify = efi_register_protocol_notify,
2883 .locate_handle = efi_locate_handle_ext,
2884 .locate_device_path = efi_locate_device_path,
2885 .install_configuration_table = efi_install_configuration_table_ext,
2886 .load_image = efi_load_image,
2887 .start_image = efi_start_image,
2889 .unload_image = efi_unload_image,
2890 .exit_boot_services = efi_exit_boot_services,
2891 .get_next_monotonic_count = efi_get_next_monotonic_count,
2893 .set_watchdog_timer = efi_set_watchdog_timer,
2894 .connect_controller = efi_connect_controller,
2895 .disconnect_controller = efi_disconnect_controller,
2896 .open_protocol = efi_open_protocol,
2897 .close_protocol = efi_close_protocol,
2898 .open_protocol_information = efi_open_protocol_information,
2899 .protocols_per_handle = efi_protocols_per_handle,
2900 .locate_handle_buffer = efi_locate_handle_buffer,
2901 .locate_protocol = efi_locate_protocol,
2902 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2903 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2904 .calculate_crc32 = efi_calculate_crc32,
2905 .copy_mem = efi_copy_mem,
2906 .set_mem = efi_set_mem,
2907 .create_event_ex = efi_create_event_ex,
2911 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
2913 struct efi_system_table __efi_runtime_data systab = {
2915 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2916 .revision = 2 << 16 | 70, /* 2.7 */
2917 .headersize = sizeof(struct efi_table_hdr),
2919 .fw_vendor = (long)firmware_vendor,
2920 .con_in = (void*)&efi_con_in,
2921 .con_out = (void*)&efi_con_out,
2922 .std_err = (void*)&efi_con_out,
2923 .runtime = (void*)&efi_runtime_services,
2924 .boottime = (void*)&efi_boot_services,
2926 .tables = (void*)efi_conf_table,