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 device tree table */
60 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
61 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
62 const efi_guid_t efi_guid_driver_binding_protocol =
63 EFI_DRIVER_BINDING_PROTOCOL_GUID;
65 static efi_status_t EFIAPI efi_disconnect_controller(
66 efi_handle_t controller_handle,
67 efi_handle_t driver_image_handle,
68 efi_handle_t child_handle);
70 /* Called on every callback entry */
71 int __efi_entry_check(void)
73 int ret = entry_count++ == 0;
82 /* Called on every callback exit */
83 int __efi_exit_check(void)
85 int ret = --entry_count == 0;
92 /* Called from do_bootefi_exec() */
93 void efi_save_gd(void)
101 * Special case handler for error/abort that just forces things back
102 * to u-boot world so we can dump out an abort msg, without any care
103 * about returning back to UEFI world.
105 void efi_restore_gd(void)
108 /* Only restore if we're already in EFI context */
116 * Return a string for indenting with two spaces per level. A maximum of ten
117 * indent levels is supported. Higher indent levels will be truncated.
119 * @level indent level
120 * @return indent string
122 static const char *indent_string(int level)
124 const char *indent = " ";
125 const int max = strlen(indent);
126 level = min(max, level * 2);
127 return &indent[max - level];
130 const char *__efi_nesting(void)
132 return indent_string(nesting_level);
135 const char *__efi_nesting_inc(void)
137 return indent_string(nesting_level++);
140 const char *__efi_nesting_dec(void)
142 return indent_string(--nesting_level);
146 * Queue an EFI event.
148 * This function queues the notification function of the event for future
151 * The notification function is called if the task priority level of the
152 * event is higher than the current task priority level.
154 * For the SignalEvent service see efi_signal_event_ext.
156 * @event event to signal
157 * @check_tpl check the TPL level
159 void efi_signal_event(struct efi_event *event, bool check_tpl)
161 if (event->notify_function) {
162 event->is_queued = true;
164 if (check_tpl && efi_tpl >= event->notify_tpl)
166 EFI_CALL_VOID(event->notify_function(event,
167 event->notify_context));
169 event->is_queued = false;
173 * Raise the task priority level.
175 * This function implements the RaiseTpl service.
176 * See the Unified Extensible Firmware Interface (UEFI) specification
179 * @new_tpl new value of the task priority level
180 * @return old value of the task priority level
182 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
184 efi_uintn_t old_tpl = efi_tpl;
186 EFI_ENTRY("0x%zx", new_tpl);
188 if (new_tpl < efi_tpl)
189 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
191 if (efi_tpl > TPL_HIGH_LEVEL)
192 efi_tpl = TPL_HIGH_LEVEL;
194 EFI_EXIT(EFI_SUCCESS);
199 * Lower the task priority level.
201 * This function implements the RestoreTpl service.
202 * See the Unified Extensible Firmware Interface (UEFI) specification
205 * @old_tpl value of the task priority level to be restored
207 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
209 EFI_ENTRY("0x%zx", old_tpl);
211 if (old_tpl > efi_tpl)
212 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
214 if (efi_tpl > TPL_HIGH_LEVEL)
215 efi_tpl = TPL_HIGH_LEVEL;
217 EFI_EXIT(EFI_SUCCESS);
221 * Allocate memory pages.
223 * This function implements the AllocatePages service.
224 * See the Unified Extensible Firmware Interface (UEFI) specification
227 * @type type of allocation to be performed
228 * @memory_type usage type of the allocated memory
229 * @pages number of pages to be allocated
230 * @memory allocated memory
231 * @return status code
233 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
239 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
240 r = efi_allocate_pages(type, memory_type, pages, memory);
247 * This function implements the FreePages service.
248 * See the Unified Extensible Firmware Interface (UEFI) specification
251 * @memory start of the memory area to be freed
252 * @pages number of pages to be freed
253 * @return status code
255 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
260 EFI_ENTRY("%"PRIx64", 0x%zx", memory, pages);
261 r = efi_free_pages(memory, pages);
266 * Get map describing memory usage.
268 * This function implements the GetMemoryMap service.
269 * See the Unified Extensible Firmware Interface (UEFI) specification
272 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
273 * on exit the size of the copied memory map
274 * @memory_map buffer to which the memory map is written
275 * @map_key key for the memory map
276 * @descriptor_size size of an individual memory descriptor
277 * @descriptor_version version number of the memory descriptor structure
278 * @return status code
280 static efi_status_t EFIAPI efi_get_memory_map_ext(
281 efi_uintn_t *memory_map_size,
282 struct efi_mem_desc *memory_map,
283 efi_uintn_t *map_key,
284 efi_uintn_t *descriptor_size,
285 uint32_t *descriptor_version)
289 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
290 map_key, descriptor_size, descriptor_version);
291 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
292 descriptor_size, descriptor_version);
297 * Allocate memory from pool.
299 * This function implements the AllocatePool service.
300 * See the Unified Extensible Firmware Interface (UEFI) specification
303 * @pool_type type of the pool from which memory is to be allocated
304 * @size number of bytes to be allocated
305 * @buffer allocated memory
306 * @return status code
308 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
314 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
315 r = efi_allocate_pool(pool_type, size, buffer);
320 * Free memory from pool.
322 * This function implements the FreePool service.
323 * See the Unified Extensible Firmware Interface (UEFI) specification
326 * @buffer start of memory to be freed
327 * @return status code
329 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
333 EFI_ENTRY("%p", buffer);
334 r = efi_free_pool(buffer);
339 * Add a new object to the object list.
341 * The protocols list is initialized.
342 * The object handle is set.
344 * @obj object to be added
346 void efi_add_handle(struct efi_object *obj)
350 INIT_LIST_HEAD(&obj->protocols);
352 list_add_tail(&obj->link, &efi_obj_list);
359 * @return status code
361 efi_status_t efi_create_handle(efi_handle_t *handle)
363 struct efi_object *obj;
366 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
367 sizeof(struct efi_object),
369 if (r != EFI_SUCCESS)
372 *handle = obj->handle;
377 * Find a protocol on a handle.
380 * @protocol_guid GUID of the protocol
381 * @handler reference to the protocol
382 * @return status code
384 efi_status_t efi_search_protocol(const efi_handle_t handle,
385 const efi_guid_t *protocol_guid,
386 struct efi_handler **handler)
388 struct efi_object *efiobj;
389 struct list_head *lhandle;
391 if (!handle || !protocol_guid)
392 return EFI_INVALID_PARAMETER;
393 efiobj = efi_search_obj(handle);
395 return EFI_INVALID_PARAMETER;
396 list_for_each(lhandle, &efiobj->protocols) {
397 struct efi_handler *protocol;
399 protocol = list_entry(lhandle, struct efi_handler, link);
400 if (!guidcmp(protocol->guid, protocol_guid)) {
406 return EFI_NOT_FOUND;
410 * Delete protocol from a handle.
412 * @handle handle from which the protocol shall be deleted
413 * @protocol GUID of the protocol to be deleted
414 * @protocol_interface interface of the protocol implementation
415 * @return status code
417 efi_status_t efi_remove_protocol(const efi_handle_t handle,
418 const efi_guid_t *protocol,
419 void *protocol_interface)
421 struct efi_handler *handler;
424 ret = efi_search_protocol(handle, protocol, &handler);
425 if (ret != EFI_SUCCESS)
427 if (guidcmp(handler->guid, protocol))
428 return EFI_INVALID_PARAMETER;
429 list_del(&handler->link);
435 * Delete all protocols from a handle.
437 * @handle handle from which the protocols shall be deleted
438 * @return status code
440 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
442 struct efi_object *efiobj;
443 struct efi_handler *protocol;
444 struct efi_handler *pos;
446 efiobj = efi_search_obj(handle);
448 return EFI_INVALID_PARAMETER;
449 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
452 ret = efi_remove_protocol(handle, protocol->guid,
453 protocol->protocol_interface);
454 if (ret != EFI_SUCCESS)
463 * @handle handle to delete
465 void efi_delete_handle(struct efi_object *obj)
469 efi_remove_all_protocols(obj->handle);
470 list_del(&obj->link);
475 * Our event capabilities are very limited. Only a small limited
476 * number of events is allowed to coexist.
478 static struct efi_event efi_events[16];
483 * This function is used inside U-Boot code to create an event.
485 * For the API function implementing the CreateEvent service see
486 * efi_create_event_ext.
488 * @type type of the event to create
489 * @notify_tpl task priority level of the event
490 * @notify_function notification function of the event
491 * @notify_context pointer passed to the notification function
492 * @event created event
493 * @return status code
495 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
496 void (EFIAPI *notify_function) (
497 struct efi_event *event,
499 void *notify_context, struct efi_event **event)
504 return EFI_INVALID_PARAMETER;
506 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
507 return EFI_INVALID_PARAMETER;
509 if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
510 notify_function == NULL)
511 return EFI_INVALID_PARAMETER;
513 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
514 if (efi_events[i].type)
516 efi_events[i].type = type;
517 efi_events[i].notify_tpl = notify_tpl;
518 efi_events[i].notify_function = notify_function;
519 efi_events[i].notify_context = notify_context;
520 /* Disable timers on bootup */
521 efi_events[i].trigger_next = -1ULL;
522 efi_events[i].is_queued = false;
523 efi_events[i].is_signaled = false;
524 *event = &efi_events[i];
527 return EFI_OUT_OF_RESOURCES;
531 * Create an event in a group.
533 * This function implements the CreateEventEx service.
534 * See the Unified Extensible Firmware Interface (UEFI) specification
536 * TODO: Support event groups
538 * @type type of the event to create
539 * @notify_tpl task priority level of the event
540 * @notify_function notification function of the event
541 * @notify_context pointer passed to the notification function
542 * @event created event
543 * @event_group event group
544 * @return status code
546 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
547 void (EFIAPI *notify_function) (
548 struct efi_event *event,
550 void *notify_context,
551 efi_guid_t *event_group,
552 struct efi_event **event)
554 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
555 notify_context, event_group);
557 return EFI_EXIT(EFI_UNSUPPORTED);
558 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
559 notify_context, event));
565 * This function implements the CreateEvent service.
566 * See the Unified Extensible Firmware Interface (UEFI) specification
569 * @type type of the event to create
570 * @notify_tpl task priority level of the event
571 * @notify_function notification function of the event
572 * @notify_context pointer passed to the notification function
573 * @event created event
574 * @return status code
576 static efi_status_t EFIAPI efi_create_event_ext(
577 uint32_t type, efi_uintn_t notify_tpl,
578 void (EFIAPI *notify_function) (
579 struct efi_event *event,
581 void *notify_context, struct efi_event **event)
583 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
585 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
586 notify_context, event));
591 * Check if a timer event has occurred or a queued notification function should
594 * Our timers have to work without interrupts, so we check whenever keyboard
595 * input or disk accesses happen if enough time elapsed for them to fire.
597 void efi_timer_check(void)
600 u64 now = timer_get_us();
602 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
603 if (!efi_events[i].type)
605 if (efi_events[i].is_queued)
606 efi_signal_event(&efi_events[i], true);
607 if (!(efi_events[i].type & EVT_TIMER) ||
608 now < efi_events[i].trigger_next)
610 switch (efi_events[i].trigger_type) {
611 case EFI_TIMER_RELATIVE:
612 efi_events[i].trigger_type = EFI_TIMER_STOP;
614 case EFI_TIMER_PERIODIC:
615 efi_events[i].trigger_next +=
616 efi_events[i].trigger_time;
621 efi_events[i].is_signaled = true;
622 efi_signal_event(&efi_events[i], true);
628 * Set the trigger time for a timer event or stop the event.
630 * This is the function for internal usage in U-Boot. For the API function
631 * implementing the SetTimer service see efi_set_timer_ext.
633 * @event event for which the timer is set
634 * @type type of the timer
635 * @trigger_time trigger period in multiples of 100ns
636 * @return status code
638 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
639 uint64_t trigger_time)
644 * The parameter defines a multiple of 100ns.
645 * We use multiples of 1000ns. So divide by 10.
647 do_div(trigger_time, 10);
649 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
650 if (event != &efi_events[i])
653 if (!(event->type & EVT_TIMER))
657 event->trigger_next = -1ULL;
659 case EFI_TIMER_PERIODIC:
660 case EFI_TIMER_RELATIVE:
661 event->trigger_next =
662 timer_get_us() + trigger_time;
665 return EFI_INVALID_PARAMETER;
667 event->trigger_type = type;
668 event->trigger_time = trigger_time;
669 event->is_signaled = false;
672 return EFI_INVALID_PARAMETER;
676 * Set the trigger time for a timer event or stop the event.
678 * This function implements the SetTimer service.
679 * See the Unified Extensible Firmware Interface (UEFI) specification
682 * @event event for which the timer is set
683 * @type type of the timer
684 * @trigger_time trigger period in multiples of 100ns
685 * @return status code
687 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
688 enum efi_timer_delay type,
689 uint64_t trigger_time)
691 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
692 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
696 * Wait for events to be signaled.
698 * This function implements the WaitForEvent service.
699 * See the Unified Extensible Firmware Interface (UEFI) specification
702 * @num_events number of events to be waited for
703 * @events events to be waited for
704 * @index index of the event that was signaled
705 * @return status code
707 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
708 struct efi_event **event,
713 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
715 /* Check parameters */
716 if (!num_events || !event)
717 return EFI_EXIT(EFI_INVALID_PARAMETER);
719 if (efi_tpl != TPL_APPLICATION)
720 return EFI_EXIT(EFI_UNSUPPORTED);
721 for (i = 0; i < num_events; ++i) {
722 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
723 if (event[i] == &efi_events[j])
726 return EFI_EXIT(EFI_INVALID_PARAMETER);
728 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
729 return EFI_EXIT(EFI_INVALID_PARAMETER);
730 if (!event[i]->is_signaled)
731 efi_signal_event(event[i], true);
734 /* Wait for signal */
736 for (i = 0; i < num_events; ++i) {
737 if (event[i]->is_signaled)
740 /* Allow events to occur. */
746 * Reset the signal which is passed to the caller to allow periodic
749 event[i]->is_signaled = false;
753 return EFI_EXIT(EFI_SUCCESS);
757 * Signal an EFI event.
759 * This function implements the SignalEvent service.
760 * See the Unified Extensible Firmware Interface (UEFI) specification
763 * This functions sets the signaled state of the event and queues the
764 * notification function for execution.
766 * @event event to signal
767 * @return status code
769 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
773 EFI_ENTRY("%p", event);
774 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
775 if (event != &efi_events[i])
777 if (event->is_signaled)
779 event->is_signaled = true;
780 if (event->type & EVT_NOTIFY_SIGNAL)
781 efi_signal_event(event, true);
784 return EFI_EXIT(EFI_SUCCESS);
788 * Close an EFI event.
790 * This function implements the CloseEvent service.
791 * See the Unified Extensible Firmware Interface (UEFI) specification
794 * @event event to close
795 * @return status code
797 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
801 EFI_ENTRY("%p", event);
802 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
803 if (event == &efi_events[i]) {
805 event->trigger_next = -1ULL;
806 event->is_queued = false;
807 event->is_signaled = false;
808 return EFI_EXIT(EFI_SUCCESS);
811 return EFI_EXIT(EFI_INVALID_PARAMETER);
815 * Check if an event is signaled.
817 * This function implements the CheckEvent service.
818 * See the Unified Extensible Firmware Interface (UEFI) specification
821 * If an event is not signaled yet the notification function is queued.
823 * @event event to check
824 * @return status code
826 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
830 EFI_ENTRY("%p", event);
832 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
833 if (event != &efi_events[i])
835 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
837 if (!event->is_signaled)
838 efi_signal_event(event, true);
839 if (event->is_signaled)
840 return EFI_EXIT(EFI_SUCCESS);
841 return EFI_EXIT(EFI_NOT_READY);
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
847 * Find the internal EFI object for a handle.
849 * @handle handle to find
852 struct efi_object *efi_search_obj(const efi_handle_t handle)
854 struct efi_object *efiobj;
856 list_for_each_entry(efiobj, &efi_obj_list, link) {
857 if (efiobj->handle == handle)
865 * Create open protocol info entry and add it to a protocol.
867 * @handler handler of a protocol
868 * @return open protocol info entry
870 static struct efi_open_protocol_info_entry *efi_create_open_info(
871 struct efi_handler *handler)
873 struct efi_open_protocol_info_item *item;
875 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
878 /* Append the item to the open protocol info list. */
879 list_add_tail(&item->link, &handler->open_infos);
885 * Remove an open protocol info entry from a protocol.
887 * @handler handler of a protocol
888 * @return status code
890 static efi_status_t efi_delete_open_info(
891 struct efi_open_protocol_info_item *item)
893 list_del(&item->link);
899 * Install new protocol on a handle.
901 * @handle handle on which the protocol shall be installed
902 * @protocol GUID of the protocol to be installed
903 * @protocol_interface interface of the protocol implementation
904 * @return status code
906 efi_status_t efi_add_protocol(const efi_handle_t handle,
907 const efi_guid_t *protocol,
908 void *protocol_interface)
910 struct efi_object *efiobj;
911 struct efi_handler *handler;
914 efiobj = efi_search_obj(handle);
916 return EFI_INVALID_PARAMETER;
917 ret = efi_search_protocol(handle, protocol, NULL);
918 if (ret != EFI_NOT_FOUND)
919 return EFI_INVALID_PARAMETER;
920 handler = calloc(1, sizeof(struct efi_handler));
922 return EFI_OUT_OF_RESOURCES;
923 handler->guid = protocol;
924 handler->protocol_interface = protocol_interface;
925 INIT_LIST_HEAD(&handler->open_infos);
926 list_add_tail(&handler->link, &efiobj->protocols);
927 if (!guidcmp(&efi_guid_device_path, protocol))
928 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
933 * Install protocol interface.
935 * This function implements the InstallProtocolInterface service.
936 * See the Unified Extensible Firmware Interface (UEFI) specification
939 * @handle handle on which the protocol shall be installed
940 * @protocol GUID of the protocol to be installed
941 * @protocol_interface_type type of the interface to be installed,
942 * always EFI_NATIVE_INTERFACE
943 * @protocol_interface interface of the protocol implementation
944 * @return status code
946 static efi_status_t EFIAPI efi_install_protocol_interface(
947 void **handle, const efi_guid_t *protocol,
948 int protocol_interface_type, void *protocol_interface)
952 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
955 if (!handle || !protocol ||
956 protocol_interface_type != EFI_NATIVE_INTERFACE) {
957 r = EFI_INVALID_PARAMETER;
961 /* Create new handle if requested. */
963 r = efi_create_handle(handle);
964 if (r != EFI_SUCCESS)
966 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
969 debug("%sEFI: handle %p\n", indent_string(nesting_level),
972 /* Add new protocol */
973 r = efi_add_protocol(*handle, protocol, protocol_interface);
979 * Reinstall protocol interface.
981 * This function implements the ReinstallProtocolInterface service.
982 * See the Unified Extensible Firmware Interface (UEFI) specification
985 * @handle handle on which the protocol shall be
987 * @protocol GUID of the protocol to be installed
988 * @old_interface interface to be removed
989 * @new_interface interface to be installed
990 * @return status code
992 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
993 efi_handle_t handle, const efi_guid_t *protocol,
994 void *old_interface, void *new_interface)
996 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
998 return EFI_EXIT(EFI_ACCESS_DENIED);
1002 * Get all drivers associated to a controller.
1003 * The allocated buffer has to be freed with free().
1005 * @efiobj handle of the controller
1006 * @protocol protocol guid (optional)
1007 * @number_of_drivers number of child controllers
1008 * @driver_handle_buffer handles of the the drivers
1009 * @return status code
1011 static efi_status_t efi_get_drivers(struct efi_object *efiobj,
1012 const efi_guid_t *protocol,
1013 efi_uintn_t *number_of_drivers,
1014 efi_handle_t **driver_handle_buffer)
1016 struct efi_handler *handler;
1017 struct efi_open_protocol_info_item *item;
1018 efi_uintn_t count = 0, i;
1021 /* Count all driver associations */
1022 list_for_each_entry(handler, &efiobj->protocols, link) {
1023 if (protocol && guidcmp(handler->guid, protocol))
1025 list_for_each_entry(item, &handler->open_infos, link) {
1026 if (item->info.attributes &
1027 EFI_OPEN_PROTOCOL_BY_DRIVER)
1032 * Create buffer. In case of duplicate driver assignments the buffer
1033 * will be too large. But that does not harm.
1035 *number_of_drivers = 0;
1036 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1037 if (!*driver_handle_buffer)
1038 return EFI_OUT_OF_RESOURCES;
1039 /* Collect unique driver handles */
1040 list_for_each_entry(handler, &efiobj->protocols, link) {
1041 if (protocol && guidcmp(handler->guid, protocol))
1043 list_for_each_entry(item, &handler->open_infos, link) {
1044 if (item->info.attributes &
1045 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1046 /* Check this is a new driver */
1048 for (i = 0; i < *number_of_drivers; ++i) {
1049 if ((*driver_handle_buffer)[i] ==
1050 item->info.agent_handle)
1053 /* Copy handle to buffer */
1055 i = (*number_of_drivers)++;
1056 (*driver_handle_buffer)[i] =
1057 item->info.agent_handle;
1066 * Disconnect all drivers from a controller.
1068 * This function implements the DisconnectController service.
1069 * See the Unified Extensible Firmware Interface (UEFI) specification
1072 * @efiobj handle of the controller
1073 * @protocol protocol guid (optional)
1074 * @child_handle handle of the child to destroy
1075 * @return status code
1077 static efi_status_t efi_disconnect_all_drivers(
1078 struct efi_object *efiobj,
1079 const efi_guid_t *protocol,
1080 efi_handle_t child_handle)
1082 efi_uintn_t number_of_drivers;
1083 efi_handle_t *driver_handle_buffer;
1084 efi_status_t r, ret;
1086 ret = efi_get_drivers(efiobj, protocol, &number_of_drivers,
1087 &driver_handle_buffer);
1088 if (ret != EFI_SUCCESS)
1091 ret = EFI_NOT_FOUND;
1092 while (number_of_drivers) {
1093 r = EFI_CALL(efi_disconnect_controller(
1095 driver_handle_buffer[--number_of_drivers],
1097 if (r == EFI_SUCCESS)
1100 free(driver_handle_buffer);
1105 * Uninstall protocol interface.
1107 * This function implements the UninstallProtocolInterface service.
1108 * See the Unified Extensible Firmware Interface (UEFI) specification
1111 * @handle handle from which the protocol shall be removed
1112 * @protocol GUID of the protocol to be removed
1113 * @protocol_interface interface to be removed
1114 * @return status code
1116 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
1117 efi_handle_t handle, const efi_guid_t *protocol,
1118 void *protocol_interface)
1120 struct efi_object *efiobj;
1121 struct efi_handler *handler;
1122 struct efi_open_protocol_info_item *item;
1123 struct efi_open_protocol_info_item *pos;
1126 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1129 efiobj = efi_search_obj(handle);
1131 r = EFI_INVALID_PARAMETER;
1134 /* Find the protocol on the handle */
1135 r = efi_search_protocol(handle, protocol, &handler);
1136 if (r != EFI_SUCCESS)
1138 /* Disconnect controllers */
1139 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1140 if (!list_empty(&handler->open_infos)) {
1141 r = EFI_ACCESS_DENIED;
1144 /* Close protocol */
1145 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1146 if (item->info.attributes ==
1147 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1148 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1149 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1150 list_del(&item->link);
1152 if (!list_empty(&handler->open_infos)) {
1153 r = EFI_ACCESS_DENIED;
1156 r = efi_remove_protocol(handle, protocol, protocol_interface);
1162 * Register an event for notification when a protocol is installed.
1164 * This function implements the RegisterProtocolNotify service.
1165 * See the Unified Extensible Firmware Interface (UEFI) specification
1168 * @protocol GUID of the protocol whose installation shall be
1170 * @event event to be signaled upon installation of the protocol
1171 * @registration key for retrieving the registration information
1172 * @return status code
1174 static efi_status_t EFIAPI efi_register_protocol_notify(
1175 const efi_guid_t *protocol,
1176 struct efi_event *event,
1177 void **registration)
1179 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1180 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1184 * Determine if an EFI handle implements a protocol.
1186 * See the documentation of the LocateHandle service in the UEFI specification.
1188 * @search_type selection criterion
1189 * @protocol GUID of the protocol
1190 * @search_key registration key
1192 * @return 0 if the handle implements the protocol
1194 static int efi_search(enum efi_locate_search_type search_type,
1195 const efi_guid_t *protocol, void *search_key,
1196 struct efi_object *efiobj)
1200 switch (search_type) {
1203 case BY_REGISTER_NOTIFY:
1204 /* TODO: RegisterProtocolNotify is not implemented yet */
1207 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1208 return (ret != EFI_SUCCESS);
1210 /* Invalid search type */
1216 * Locate handles implementing a protocol.
1218 * This function is meant for U-Boot internal calls. For the API implementation
1219 * of the LocateHandle service see efi_locate_handle_ext.
1221 * @search_type selection criterion
1222 * @protocol GUID of the protocol
1223 * @search_key registration key
1224 * @buffer_size size of the buffer to receive the handles in bytes
1225 * @buffer buffer to receive the relevant handles
1226 * @return status code
1228 static efi_status_t efi_locate_handle(
1229 enum efi_locate_search_type search_type,
1230 const efi_guid_t *protocol, void *search_key,
1231 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1233 struct efi_object *efiobj;
1234 efi_uintn_t size = 0;
1236 /* Check parameters */
1237 switch (search_type) {
1240 case BY_REGISTER_NOTIFY:
1242 return EFI_INVALID_PARAMETER;
1243 /* RegisterProtocolNotify is not implemented yet */
1244 return EFI_UNSUPPORTED;
1247 return EFI_INVALID_PARAMETER;
1250 return EFI_INVALID_PARAMETER;
1254 * efi_locate_handle_buffer uses this function for
1255 * the calculation of the necessary buffer size.
1256 * So do not require a buffer for buffersize == 0.
1258 if (!buffer_size || (*buffer_size && !buffer))
1259 return EFI_INVALID_PARAMETER;
1261 /* Count how much space we need */
1262 list_for_each_entry(efiobj, &efi_obj_list, link) {
1263 if (!efi_search(search_type, protocol, search_key, efiobj))
1264 size += sizeof(void*);
1267 if (*buffer_size < size) {
1268 *buffer_size = size;
1269 return EFI_BUFFER_TOO_SMALL;
1272 *buffer_size = size;
1274 return EFI_NOT_FOUND;
1276 /* Then fill the array */
1277 list_for_each_entry(efiobj, &efi_obj_list, link) {
1278 if (!efi_search(search_type, protocol, search_key, efiobj))
1279 *buffer++ = efiobj->handle;
1286 * Locate handles implementing a protocol.
1288 * This function implements the LocateHandle service.
1289 * See the Unified Extensible Firmware Interface (UEFI) specification
1292 * @search_type selection criterion
1293 * @protocol GUID of the protocol
1294 * @search_key registration key
1295 * @buffer_size size of the buffer to receive the handles in bytes
1296 * @buffer buffer to receive the relevant handles
1297 * @return 0 if the handle implements the protocol
1299 static efi_status_t EFIAPI efi_locate_handle_ext(
1300 enum efi_locate_search_type search_type,
1301 const efi_guid_t *protocol, void *search_key,
1302 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1304 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1305 buffer_size, buffer);
1307 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1308 buffer_size, buffer));
1311 /* Collapses configuration table entries, removing index i */
1312 static void efi_remove_configuration_table(int i)
1314 struct efi_configuration_table *this = &efi_conf_table[i];
1315 struct efi_configuration_table *next = &efi_conf_table[i+1];
1316 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1318 memmove(this, next, (ulong)end - (ulong)next);
1323 * Adds, updates, or removes a configuration table.
1325 * This function is used for internal calls. For the API implementation of the
1326 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1328 * @guid GUID of the installed table
1329 * @table table to be installed
1330 * @return status code
1332 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1337 return EFI_INVALID_PARAMETER;
1339 /* Check for guid override */
1340 for (i = 0; i < systab.nr_tables; i++) {
1341 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1343 efi_conf_table[i].table = table;
1345 efi_remove_configuration_table(i);
1351 return EFI_NOT_FOUND;
1353 /* No override, check for overflow */
1354 if (i >= ARRAY_SIZE(efi_conf_table))
1355 return EFI_OUT_OF_RESOURCES;
1357 /* Add a new entry */
1358 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1359 efi_conf_table[i].table = table;
1360 systab.nr_tables = i + 1;
1366 * Adds, updates, or removes a configuration table.
1368 * This function implements the InstallConfigurationTable service.
1369 * See the Unified Extensible Firmware Interface (UEFI) specification
1372 * @guid GUID of the installed table
1373 * @table table to be installed
1374 * @return status code
1376 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1379 EFI_ENTRY("%pUl, %p", guid, table);
1380 return EFI_EXIT(efi_install_configuration_table(guid, table));
1384 * Initialize a loaded_image_info + loaded_image_info object with correct
1385 * protocols, boot-device, etc.
1387 * @info loaded image info to be passed to the entry point of the
1389 * @obj internal object associated with the loaded image
1390 * @device_path device path of the loaded image
1391 * @file_path file path of the loaded image
1392 * @return status code
1394 efi_status_t efi_setup_loaded_image(
1395 struct efi_loaded_image *info, struct efi_object *obj,
1396 struct efi_device_path *device_path,
1397 struct efi_device_path *file_path)
1401 /* Add internal object to object list */
1402 efi_add_handle(obj);
1403 /* efi_exit() assumes that the handle points to the info */
1406 info->file_path = file_path;
1409 info->device_handle = efi_dp_find_obj(device_path, NULL);
1411 * When asking for the device path interface, return
1412 * bootefi_device_path
1414 ret = efi_add_protocol(obj->handle, &efi_guid_device_path,
1416 if (ret != EFI_SUCCESS)
1421 * When asking for the loaded_image interface, just
1422 * return handle which points to loaded_image_info
1424 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1425 if (ret != EFI_SUCCESS)
1428 ret = efi_add_protocol(obj->handle,
1429 &efi_guid_device_path_to_text_protocol,
1430 (void *)&efi_device_path_to_text);
1431 if (ret != EFI_SUCCESS)
1434 ret = efi_add_protocol(obj->handle,
1435 &efi_guid_device_path_utilities_protocol,
1436 (void *)&efi_device_path_utilities);
1437 if (ret != EFI_SUCCESS)
1442 printf("ERROR: Failure to install protocols for loaded image\n");
1447 * Load an image using a file path.
1449 * @file_path the path of the image to load
1450 * @buffer buffer containing the loaded image
1451 * @return status code
1453 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1456 struct efi_file_info *info = NULL;
1457 struct efi_file_handle *f;
1458 static efi_status_t ret;
1461 f = efi_file_from_path(file_path);
1463 return EFI_DEVICE_ERROR;
1466 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1468 if (ret == EFI_BUFFER_TOO_SMALL) {
1470 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1473 if (ret != EFI_SUCCESS)
1476 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1480 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1484 EFI_CALL(f->close(f));
1486 if (ret != EFI_SUCCESS) {
1487 efi_free_pool(*buffer);
1495 * Load an EFI image into memory.
1497 * This function implements the LoadImage service.
1498 * See the Unified Extensible Firmware Interface (UEFI) specification
1501 * @boot_policy true for request originating from the boot manager
1502 * @parent_image the caller's image handle
1503 * @file_path the path of the image to load
1504 * @source_buffer memory location from which the image is installed
1505 * @source_size size of the memory area from which the image is
1507 * @image_handle handle for the newly installed image
1508 * @return status code
1510 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1511 efi_handle_t parent_image,
1512 struct efi_device_path *file_path,
1513 void *source_buffer,
1514 unsigned long source_size,
1515 efi_handle_t *image_handle)
1517 struct efi_loaded_image *info;
1518 struct efi_object *obj;
1521 EFI_ENTRY("%d, %p, %pD, %p, %ld, %p", boot_policy, parent_image,
1522 file_path, source_buffer, source_size, image_handle);
1524 if (!image_handle || !parent_image) {
1525 ret = EFI_INVALID_PARAMETER;
1529 if (!source_buffer && !file_path) {
1530 ret = EFI_NOT_FOUND;
1534 info = calloc(1, sizeof(*info));
1536 ret = EFI_OUT_OF_RESOURCES;
1539 obj = calloc(1, sizeof(*obj));
1542 ret = EFI_OUT_OF_RESOURCES;
1546 if (!source_buffer) {
1547 struct efi_device_path *dp, *fp;
1549 ret = efi_load_image_from_path(file_path, &source_buffer);
1550 if (ret != EFI_SUCCESS)
1553 * split file_path which contains both the device and
1556 efi_dp_split_file_path(file_path, &dp, &fp);
1557 ret = efi_setup_loaded_image(info, obj, dp, fp);
1558 if (ret != EFI_SUCCESS)
1561 /* In this case, file_path is the "device" path, ie.
1562 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1564 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1565 if (ret != EFI_SUCCESS)
1568 info->reserved = efi_load_pe(source_buffer, info);
1569 if (!info->reserved) {
1570 ret = EFI_UNSUPPORTED;
1573 info->system_table = &systab;
1574 info->parent_handle = parent_image;
1575 *image_handle = obj->handle;
1576 return EFI_EXIT(EFI_SUCCESS);
1579 efi_delete_handle(obj);
1581 return EFI_EXIT(ret);
1585 * Call the entry point of an image.
1587 * This function implements the StartImage service.
1588 * See the Unified Extensible Firmware Interface (UEFI) specification
1591 * @image_handle handle of the image
1592 * @exit_data_size size of the buffer
1593 * @exit_data buffer to receive the exit data of the called image
1594 * @return status code
1596 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1597 unsigned long *exit_data_size,
1600 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
1601 struct efi_system_table *st);
1602 struct efi_loaded_image *info = image_handle;
1605 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1606 entry = info->reserved;
1608 efi_is_direct_boot = false;
1610 /* call the image! */
1611 if (setjmp(&info->exit_jmp)) {
1613 * We called the entry point of the child image with EFI_CALL
1614 * in the lines below. The child image called the Exit() boot
1615 * service efi_exit() which executed the long jump that brought
1616 * us to the current line. This implies that the second half
1617 * of the EFI_CALL macro has not been executed.
1621 * efi_exit() called efi_restore_gd(). We have to undo this
1622 * otherwise __efi_entry_check() will put the wrong value into
1628 * To get ready to call EFI_EXIT below we have to execute the
1629 * missed out steps of EFI_CALL.
1631 assert(__efi_entry_check());
1632 debug("%sEFI: %lu returned by started image\n",
1633 __efi_nesting_dec(),
1634 (unsigned long)((uintptr_t)info->exit_status &
1636 return EFI_EXIT(info->exit_status);
1639 ret = EFI_CALL(entry(image_handle, &systab));
1642 * Usually UEFI applications call Exit() instead of returning.
1643 * But because the world doesn not consist of ponies and unicorns,
1644 * we're happy to emulate that behavior on behalf of a payload
1647 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
1651 * Leave an EFI application or driver.
1653 * This function implements the Exit service.
1654 * See the Unified Extensible Firmware Interface (UEFI) specification
1657 * @image_handle handle of the application or driver that is exiting
1658 * @exit_status status code
1659 * @exit_data_size size of the buffer in bytes
1660 * @exit_data buffer with data describing an error
1661 * @return status code
1663 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1664 efi_status_t exit_status, unsigned long exit_data_size,
1668 * We require that the handle points to the original loaded
1669 * image protocol interface.
1671 * For getting the longjmp address this is safer than locating
1672 * the protocol because the protocol may have been reinstalled
1673 * pointing to another memory location.
1675 * TODO: We should call the unload procedure of the loaded
1678 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1680 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1681 exit_data_size, exit_data);
1683 /* Make sure entry/exit counts for EFI world cross-overs match */
1684 EFI_EXIT(exit_status);
1687 * But longjmp out with the U-Boot gd, not the application's, as
1688 * the other end is a setjmp call inside EFI context.
1692 loaded_image_info->exit_status = exit_status;
1693 longjmp(&loaded_image_info->exit_jmp, 1);
1695 panic("EFI application exited");
1699 * Unload an EFI image.
1701 * This function implements the UnloadImage service.
1702 * See the Unified Extensible Firmware Interface (UEFI) specification
1705 * @image_handle handle of the image to be unloaded
1706 * @return status code
1708 static efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
1710 struct efi_object *efiobj;
1712 EFI_ENTRY("%p", image_handle);
1713 efiobj = efi_search_obj(image_handle);
1715 list_del(&efiobj->link);
1717 return EFI_EXIT(EFI_SUCCESS);
1721 * Fix up caches for EFI payloads if necessary.
1723 static void efi_exit_caches(void)
1725 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1727 * Grub on 32bit ARM needs to have caches disabled before jumping into
1728 * a zImage, but does not know of all cache layers. Give it a hand.
1730 if (efi_is_direct_boot)
1731 cleanup_before_linux();
1736 * Stop all boot services.
1738 * This function implements the ExitBootServices service.
1739 * See the Unified Extensible Firmware Interface (UEFI) specification
1742 * All timer events are disabled.
1743 * For exit boot services events the notification function is called.
1744 * The boot services are disabled in the system table.
1746 * @image_handle handle of the loaded image
1747 * @map_key key of the memory map
1748 * @return status code
1750 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1751 unsigned long map_key)
1755 EFI_ENTRY("%p, %ld", image_handle, map_key);
1757 /* Make sure that notification functions are not called anymore */
1758 efi_tpl = TPL_HIGH_LEVEL;
1760 /* Check if ExitBootServices has already been called */
1761 if (!systab.boottime)
1762 return EFI_EXIT(EFI_SUCCESS);
1764 /* Notify that ExitBootServices is invoked. */
1765 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1766 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1768 efi_events[i].is_signaled = true;
1769 efi_signal_event(&efi_events[i], false);
1772 /* TODO Should persist EFI variables here */
1774 board_quiesce_devices();
1776 /* Fix up caches for EFI payloads if necessary */
1779 /* This stops all lingering devices */
1780 bootm_disable_interrupts();
1782 /* Disable boottime services */
1783 systab.con_in_handle = NULL;
1784 systab.con_in = NULL;
1785 systab.con_out_handle = NULL;
1786 systab.con_out = NULL;
1787 systab.stderr_handle = NULL;
1788 systab.std_err = NULL;
1789 systab.boottime = NULL;
1791 /* Recalculate CRC32 */
1792 systab.hdr.crc32 = 0;
1793 systab.hdr.crc32 = crc32(0, (const unsigned char *)&systab,
1794 sizeof(struct efi_system_table));
1796 /* Give the payload some time to boot */
1797 efi_set_watchdog(0);
1800 return EFI_EXIT(EFI_SUCCESS);
1804 * Get next value of the counter.
1806 * This function implements the NextMonotonicCount service.
1807 * See the Unified Extensible Firmware Interface (UEFI) specification
1810 * @count returned value of the counter
1811 * @return status code
1813 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1815 static uint64_t mono = 0;
1816 EFI_ENTRY("%p", count);
1818 return EFI_EXIT(EFI_SUCCESS);
1824 * This function implements the Stall sercive.
1825 * See the Unified Extensible Firmware Interface (UEFI) specification
1828 * @microseconds period to sleep in microseconds
1829 * @return status code
1831 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1833 EFI_ENTRY("%ld", microseconds);
1834 udelay(microseconds);
1835 return EFI_EXIT(EFI_SUCCESS);
1839 * Reset the watchdog timer.
1841 * This function implements the SetWatchdogTimer service.
1842 * See the Unified Extensible Firmware Interface (UEFI) specification
1845 * @timeout seconds before reset by watchdog
1846 * @watchdog_code code to be logged when resetting
1847 * @data_size size of buffer in bytes
1848 * @watchdog_data buffer with data describing the reset reason
1849 * @return status code
1851 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1852 uint64_t watchdog_code,
1853 unsigned long data_size,
1854 uint16_t *watchdog_data)
1856 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1857 data_size, watchdog_data);
1858 return EFI_EXIT(efi_set_watchdog(timeout));
1864 * This function implements the CloseProtocol service.
1865 * See the Unified Extensible Firmware Interface (UEFI) specification
1868 * @handle handle on which the protocol shall be closed
1869 * @protocol GUID of the protocol to close
1870 * @agent_handle handle of the driver
1871 * @controller_handle handle of the controller
1872 * @return status code
1874 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1875 const efi_guid_t *protocol,
1876 efi_handle_t agent_handle,
1877 efi_handle_t controller_handle)
1879 struct efi_handler *handler;
1880 struct efi_open_protocol_info_item *item;
1881 struct efi_open_protocol_info_item *pos;
1884 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1887 if (!agent_handle) {
1888 r = EFI_INVALID_PARAMETER;
1891 r = efi_search_protocol(handle, protocol, &handler);
1892 if (r != EFI_SUCCESS)
1896 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1897 if (item->info.agent_handle == agent_handle &&
1898 item->info.controller_handle == controller_handle) {
1899 efi_delete_open_info(item);
1909 * Provide information about then open status of a protocol on a handle
1911 * This function implements the OpenProtocolInformation service.
1912 * See the Unified Extensible Firmware Interface (UEFI) specification
1915 * @handle handle for which the information shall be retrieved
1916 * @protocol GUID of the protocol
1917 * @entry_buffer buffer to receive the open protocol information
1918 * @entry_count number of entries available in the buffer
1919 * @return status code
1921 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1922 const efi_guid_t *protocol,
1923 struct efi_open_protocol_info_entry **entry_buffer,
1924 efi_uintn_t *entry_count)
1926 unsigned long buffer_size;
1927 unsigned long count;
1928 struct efi_handler *handler;
1929 struct efi_open_protocol_info_item *item;
1932 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1935 /* Check parameters */
1936 if (!entry_buffer) {
1937 r = EFI_INVALID_PARAMETER;
1940 r = efi_search_protocol(handle, protocol, &handler);
1941 if (r != EFI_SUCCESS)
1946 list_for_each_entry(item, &handler->open_infos, link) {
1947 if (item->info.open_count)
1950 *entry_count = count;
1951 *entry_buffer = NULL;
1958 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
1959 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1960 (void **)entry_buffer);
1961 if (r != EFI_SUCCESS)
1963 list_for_each_entry_reverse(item, &handler->open_infos, link) {
1964 if (item->info.open_count)
1965 (*entry_buffer)[--count] = item->info;
1972 * Get protocols installed on a handle.
1974 * This function implements the ProtocolsPerHandleService.
1975 * See the Unified Extensible Firmware Interface (UEFI) specification
1978 * @handle handle for which the information is retrieved
1979 * @protocol_buffer buffer with protocol GUIDs
1980 * @protocol_buffer_count number of entries in the buffer
1981 * @return status code
1983 static efi_status_t EFIAPI efi_protocols_per_handle(
1984 efi_handle_t handle, efi_guid_t ***protocol_buffer,
1985 efi_uintn_t *protocol_buffer_count)
1987 unsigned long buffer_size;
1988 struct efi_object *efiobj;
1989 struct list_head *protocol_handle;
1992 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1993 protocol_buffer_count);
1995 if (!handle || !protocol_buffer || !protocol_buffer_count)
1996 return EFI_EXIT(EFI_INVALID_PARAMETER);
1998 *protocol_buffer = NULL;
1999 *protocol_buffer_count = 0;
2001 efiobj = efi_search_obj(handle);
2003 return EFI_EXIT(EFI_INVALID_PARAMETER);
2005 /* Count protocols */
2006 list_for_each(protocol_handle, &efiobj->protocols) {
2007 ++*protocol_buffer_count;
2011 if (*protocol_buffer_count) {
2014 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2015 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2016 (void **)protocol_buffer);
2017 if (r != EFI_SUCCESS)
2019 list_for_each(protocol_handle, &efiobj->protocols) {
2020 struct efi_handler *protocol;
2022 protocol = list_entry(protocol_handle,
2023 struct efi_handler, link);
2024 (*protocol_buffer)[j] = (void *)protocol->guid;
2029 return EFI_EXIT(EFI_SUCCESS);
2033 * Locate handles implementing a protocol.
2035 * This function implements the LocateHandleBuffer service.
2036 * See the Unified Extensible Firmware Interface (UEFI) specification
2039 * @search_type selection criterion
2040 * @protocol GUID of the protocol
2041 * @search_key registration key
2042 * @no_handles number of returned handles
2043 * @buffer buffer with the returned handles
2044 * @return status code
2046 static efi_status_t EFIAPI efi_locate_handle_buffer(
2047 enum efi_locate_search_type search_type,
2048 const efi_guid_t *protocol, void *search_key,
2049 efi_uintn_t *no_handles, efi_handle_t **buffer)
2052 efi_uintn_t buffer_size = 0;
2054 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2055 no_handles, buffer);
2057 if (!no_handles || !buffer) {
2058 r = EFI_INVALID_PARAMETER;
2063 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2065 if (r != EFI_BUFFER_TOO_SMALL)
2067 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2069 if (r != EFI_SUCCESS)
2071 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2073 if (r == EFI_SUCCESS)
2074 *no_handles = buffer_size / sizeof(efi_handle_t);
2080 * Find an interface implementing a protocol.
2082 * This function implements the LocateProtocol service.
2083 * See the Unified Extensible Firmware Interface (UEFI) specification
2086 * @protocol GUID of the protocol
2087 * @registration registration key passed to the notification function
2088 * @protocol_interface interface implementing the protocol
2089 * @return status code
2091 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2093 void **protocol_interface)
2095 struct list_head *lhandle;
2098 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2100 if (!protocol || !protocol_interface)
2101 return EFI_EXIT(EFI_INVALID_PARAMETER);
2103 list_for_each(lhandle, &efi_obj_list) {
2104 struct efi_object *efiobj;
2105 struct efi_handler *handler;
2107 efiobj = list_entry(lhandle, struct efi_object, link);
2109 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
2110 if (ret == EFI_SUCCESS) {
2111 *protocol_interface = handler->protocol_interface;
2112 return EFI_EXIT(EFI_SUCCESS);
2115 *protocol_interface = NULL;
2117 return EFI_EXIT(EFI_NOT_FOUND);
2121 * Get the device path and handle of an device implementing a protocol.
2123 * This function implements the LocateDevicePath service.
2124 * See the Unified Extensible Firmware Interface (UEFI) specification
2127 * @protocol GUID of the protocol
2128 * @device_path device path
2129 * @device handle of the device
2130 * @return status code
2132 static efi_status_t EFIAPI efi_locate_device_path(
2133 const efi_guid_t *protocol,
2134 struct efi_device_path **device_path,
2135 efi_handle_t *device)
2137 struct efi_device_path *dp;
2139 struct efi_handler *handler;
2140 efi_handle_t *handles;
2142 size_t len_best = 0;
2143 efi_uintn_t no_handles;
2147 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2149 if (!protocol || !device_path || !*device_path || !device) {
2150 ret = EFI_INVALID_PARAMETER;
2154 /* Find end of device path */
2155 len = efi_dp_size(*device_path);
2157 /* Get all handles implementing the protocol */
2158 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2159 &no_handles, &handles));
2160 if (ret != EFI_SUCCESS)
2163 for (i = 0; i < no_handles; ++i) {
2164 /* Find the device path protocol */
2165 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2167 if (ret != EFI_SUCCESS)
2169 dp = (struct efi_device_path *)handler->protocol_interface;
2170 len_dp = efi_dp_size(dp);
2172 * This handle can only be a better fit
2173 * if its device path length is longer than the best fit and
2174 * if its device path length is shorter of equal the searched
2177 if (len_dp <= len_best || len_dp > len)
2179 /* Check if dp is a subpath of device_path */
2180 if (memcmp(*device_path, dp, len_dp))
2182 *device = handles[i];
2186 remainder = (u8 *)*device_path + len_best;
2187 *device_path = (struct efi_device_path *)remainder;
2190 ret = EFI_NOT_FOUND;
2193 return EFI_EXIT(ret);
2197 * Install multiple protocol interfaces.
2199 * This function implements the MultipleProtocolInterfaces service.
2200 * See the Unified Extensible Firmware Interface (UEFI) specification
2203 * @handle handle on which the protocol interfaces shall be installed
2204 * @... NULL terminated argument list with pairs of protocol GUIDS and
2206 * @return status code
2208 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2211 EFI_ENTRY("%p", handle);
2214 const efi_guid_t *protocol;
2215 void *protocol_interface;
2216 efi_status_t r = EFI_SUCCESS;
2220 return EFI_EXIT(EFI_INVALID_PARAMETER);
2222 va_start(argptr, handle);
2224 protocol = va_arg(argptr, efi_guid_t*);
2227 protocol_interface = va_arg(argptr, void*);
2228 r = EFI_CALL(efi_install_protocol_interface(
2230 EFI_NATIVE_INTERFACE,
2231 protocol_interface));
2232 if (r != EFI_SUCCESS)
2237 if (r == EFI_SUCCESS)
2240 /* If an error occurred undo all changes. */
2241 va_start(argptr, handle);
2243 protocol = va_arg(argptr, efi_guid_t*);
2244 protocol_interface = va_arg(argptr, void*);
2245 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2246 protocol_interface));
2254 * Uninstall multiple protocol interfaces.
2256 * This function implements the UninstallMultipleProtocolInterfaces service.
2257 * See the Unified Extensible Firmware Interface (UEFI) specification
2260 * @handle handle from which the protocol interfaces shall be removed
2261 * @... NULL terminated argument list with pairs of protocol GUIDS and
2263 * @return status code
2265 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2268 EFI_ENTRY("%p", handle);
2271 const efi_guid_t *protocol;
2272 void *protocol_interface;
2273 efi_status_t r = EFI_SUCCESS;
2277 return EFI_EXIT(EFI_INVALID_PARAMETER);
2279 va_start(argptr, handle);
2281 protocol = va_arg(argptr, efi_guid_t*);
2284 protocol_interface = va_arg(argptr, void*);
2285 r = EFI_CALL(efi_uninstall_protocol_interface(
2287 protocol_interface));
2288 if (r != EFI_SUCCESS)
2293 if (r == EFI_SUCCESS)
2296 /* If an error occurred undo all changes. */
2297 va_start(argptr, handle);
2299 protocol = va_arg(argptr, efi_guid_t*);
2300 protocol_interface = va_arg(argptr, void*);
2301 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2302 EFI_NATIVE_INTERFACE,
2303 protocol_interface));
2311 * Calculate cyclic redundancy code.
2313 * This function implements the CalculateCrc32 service.
2314 * See the Unified Extensible Firmware Interface (UEFI) specification
2317 * @data buffer with data
2318 * @data_size size of buffer in bytes
2319 * @crc32_p cyclic redundancy code
2320 * @return status code
2322 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2323 unsigned long data_size,
2326 EFI_ENTRY("%p, %ld", data, data_size);
2327 *crc32_p = crc32(0, data, data_size);
2328 return EFI_EXIT(EFI_SUCCESS);
2334 * This function implements the CopyMem service.
2335 * See the Unified Extensible Firmware Interface (UEFI) specification
2338 * @destination destination of the copy operation
2339 * @source source of the copy operation
2340 * @length number of bytes to copy
2342 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2345 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2346 memcpy(destination, source, length);
2347 EFI_EXIT(EFI_SUCCESS);
2351 * Fill memory with a byte value.
2353 * This function implements the SetMem service.
2354 * See the Unified Extensible Firmware Interface (UEFI) specification
2357 * @buffer buffer to fill
2358 * @size size of buffer in bytes
2359 * @value byte to copy to the buffer
2361 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2363 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2364 memset(buffer, value, size);
2365 EFI_EXIT(EFI_SUCCESS);
2369 * Open protocol interface on a handle.
2371 * @handler handler of a protocol
2372 * @protocol_interface interface implementing the protocol
2373 * @agent_handle handle of the driver
2374 * @controller_handle handle of the controller
2375 * @attributes attributes indicating how to open the protocol
2376 * @return status code
2378 static efi_status_t efi_protocol_open(
2379 struct efi_handler *handler,
2380 void **protocol_interface, void *agent_handle,
2381 void *controller_handle, uint32_t attributes)
2383 struct efi_open_protocol_info_item *item;
2384 struct efi_open_protocol_info_entry *match = NULL;
2385 bool opened_by_driver = false;
2386 bool opened_exclusive = false;
2388 /* If there is no agent, only return the interface */
2392 /* For TEST_PROTOCOL ignore interface attribute */
2393 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2394 *protocol_interface = NULL;
2397 * Check if the protocol is already opened by a driver with the same
2398 * attributes or opened exclusively
2400 list_for_each_entry(item, &handler->open_infos, link) {
2401 if (item->info.agent_handle == agent_handle) {
2402 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2403 (item->info.attributes == attributes))
2404 return EFI_ALREADY_STARTED;
2406 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2407 opened_exclusive = true;
2410 /* Only one controller can open the protocol exclusively */
2411 if (opened_exclusive && attributes &
2412 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2413 return EFI_ACCESS_DENIED;
2415 /* Prepare exclusive opening */
2416 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2417 /* Try to disconnect controllers */
2418 list_for_each_entry(item, &handler->open_infos, link) {
2419 if (item->info.attributes ==
2420 EFI_OPEN_PROTOCOL_BY_DRIVER)
2421 EFI_CALL(efi_disconnect_controller(
2422 item->info.controller_handle,
2423 item->info.agent_handle,
2426 opened_by_driver = false;
2427 /* Check if all controllers are disconnected */
2428 list_for_each_entry(item, &handler->open_infos, link) {
2429 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2430 opened_by_driver = true;
2432 /* Only one controller can be conncected */
2433 if (opened_by_driver)
2434 return EFI_ACCESS_DENIED;
2437 /* Find existing entry */
2438 list_for_each_entry(item, &handler->open_infos, link) {
2439 if (item->info.agent_handle == agent_handle &&
2440 item->info.controller_handle == controller_handle)
2441 match = &item->info;
2443 /* None found, create one */
2445 match = efi_create_open_info(handler);
2447 return EFI_OUT_OF_RESOURCES;
2450 match->agent_handle = agent_handle;
2451 match->controller_handle = controller_handle;
2452 match->attributes = attributes;
2453 match->open_count++;
2456 /* For TEST_PROTOCOL ignore interface attribute. */
2457 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2458 *protocol_interface = handler->protocol_interface;
2464 * Open protocol interface on a handle.
2466 * This function implements the OpenProtocol interface.
2467 * See the Unified Extensible Firmware Interface (UEFI) specification
2470 * @handle handle on which the protocol shall be opened
2471 * @protocol GUID of the protocol
2472 * @protocol_interface interface implementing the protocol
2473 * @agent_handle handle of the driver
2474 * @controller_handle handle of the controller
2475 * @attributes attributes indicating how to open the protocol
2476 * @return status code
2478 static efi_status_t EFIAPI efi_open_protocol(
2479 void *handle, const efi_guid_t *protocol,
2480 void **protocol_interface, void *agent_handle,
2481 void *controller_handle, uint32_t attributes)
2483 struct efi_handler *handler;
2484 efi_status_t r = EFI_INVALID_PARAMETER;
2486 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2487 protocol_interface, agent_handle, controller_handle,
2490 if (!handle || !protocol ||
2491 (!protocol_interface && attributes !=
2492 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2496 switch (attributes) {
2497 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2498 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2499 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2501 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2502 if (controller_handle == handle)
2505 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2506 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2507 /* Check that the controller handle is valid */
2508 if (!efi_search_obj(controller_handle))
2511 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2512 /* Check that the agent handle is valid */
2513 if (!efi_search_obj(agent_handle))
2520 r = efi_search_protocol(handle, protocol, &handler);
2521 if (r != EFI_SUCCESS)
2524 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2525 controller_handle, attributes);
2531 * Get interface of a protocol on a handle.
2533 * This function implements the HandleProtocol service.
2534 * See the Unified Extensible Firmware Interface (UEFI) specification
2537 * @handle handle on which the protocol shall be opened
2538 * @protocol GUID of the protocol
2539 * @protocol_interface interface implementing the protocol
2540 * @return status code
2542 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2543 const efi_guid_t *protocol,
2544 void **protocol_interface)
2546 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2547 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2550 static efi_status_t efi_bind_controller(
2551 efi_handle_t controller_handle,
2552 efi_handle_t driver_image_handle,
2553 struct efi_device_path *remain_device_path)
2555 struct efi_driver_binding_protocol *binding_protocol;
2558 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2559 &efi_guid_driver_binding_protocol,
2560 (void **)&binding_protocol,
2561 driver_image_handle, NULL,
2562 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2563 if (r != EFI_SUCCESS)
2565 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2567 remain_device_path));
2568 if (r == EFI_SUCCESS)
2569 r = EFI_CALL(binding_protocol->start(binding_protocol,
2571 remain_device_path));
2572 EFI_CALL(efi_close_protocol(driver_image_handle,
2573 &efi_guid_driver_binding_protocol,
2574 driver_image_handle, NULL));
2578 static efi_status_t efi_connect_single_controller(
2579 efi_handle_t controller_handle,
2580 efi_handle_t *driver_image_handle,
2581 struct efi_device_path *remain_device_path)
2583 efi_handle_t *buffer;
2587 size_t connected = 0;
2589 /* Get buffer with all handles with driver binding protocol */
2590 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2591 &efi_guid_driver_binding_protocol,
2592 NULL, &count, &buffer));
2593 if (r != EFI_SUCCESS)
2596 /* Context Override */
2597 if (driver_image_handle) {
2598 for (; *driver_image_handle; ++driver_image_handle) {
2599 for (i = 0; i < count; ++i) {
2600 if (buffer[i] == *driver_image_handle) {
2602 r = efi_bind_controller(
2604 *driver_image_handle,
2605 remain_device_path);
2607 * For drivers that do not support the
2608 * controller or are already connected
2609 * we receive an error code here.
2611 if (r == EFI_SUCCESS)
2619 * TODO: Some overrides are not yet implemented:
2620 * - Platform Driver Override
2621 * - Driver Family Override Search
2622 * - Bus Specific Driver Override
2625 /* Driver Binding Search */
2626 for (i = 0; i < count; ++i) {
2628 r = efi_bind_controller(controller_handle,
2630 remain_device_path);
2631 if (r == EFI_SUCCESS)
2636 efi_free_pool(buffer);
2638 return EFI_NOT_FOUND;
2643 * Connect a controller to a driver.
2645 * This function implements the ConnectController service.
2646 * See the Unified Extensible Firmware Interface (UEFI) specification
2649 * First all driver binding protocol handles are tried for binding drivers.
2650 * Afterwards all handles that have openened a protocol of the controller
2651 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2653 * @controller_handle handle of the controller
2654 * @driver_image_handle handle of the driver
2655 * @remain_device_path device path of a child controller
2656 * @recursive true to connect all child controllers
2657 * @return status code
2659 static efi_status_t EFIAPI efi_connect_controller(
2660 efi_handle_t controller_handle,
2661 efi_handle_t *driver_image_handle,
2662 struct efi_device_path *remain_device_path,
2666 efi_status_t ret = EFI_NOT_FOUND;
2667 struct efi_object *efiobj;
2669 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
2670 remain_device_path, recursive);
2672 efiobj = efi_search_obj(controller_handle);
2674 ret = EFI_INVALID_PARAMETER;
2678 r = efi_connect_single_controller(controller_handle,
2679 driver_image_handle,
2680 remain_device_path);
2681 if (r == EFI_SUCCESS)
2684 struct efi_handler *handler;
2685 struct efi_open_protocol_info_item *item;
2687 list_for_each_entry(handler, &efiobj->protocols, link) {
2688 list_for_each_entry(item, &handler->open_infos, link) {
2689 if (item->info.attributes &
2690 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2691 r = EFI_CALL(efi_connect_controller(
2692 item->info.controller_handle,
2693 driver_image_handle,
2696 if (r == EFI_SUCCESS)
2702 /* Check for child controller specified by end node */
2703 if (ret != EFI_SUCCESS && remain_device_path &&
2704 remain_device_path->type == DEVICE_PATH_TYPE_END)
2707 return EFI_EXIT(ret);
2711 * Get all child controllers associated to a driver.
2712 * The allocated buffer has to be freed with free().
2714 * @efiobj handle of the controller
2715 * @driver_handle handle of the driver
2716 * @number_of_children number of child controllers
2717 * @child_handle_buffer handles of the the child controllers
2719 static efi_status_t efi_get_child_controllers(
2720 struct efi_object *efiobj,
2721 efi_handle_t driver_handle,
2722 efi_uintn_t *number_of_children,
2723 efi_handle_t **child_handle_buffer)
2725 struct efi_handler *handler;
2726 struct efi_open_protocol_info_item *item;
2727 efi_uintn_t count = 0, i;
2730 /* Count all child controller associations */
2731 list_for_each_entry(handler, &efiobj->protocols, link) {
2732 list_for_each_entry(item, &handler->open_infos, link) {
2733 if (item->info.agent_handle == driver_handle &&
2734 item->info.attributes &
2735 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
2740 * Create buffer. In case of duplicate child controller assignments
2741 * the buffer will be too large. But that does not harm.
2743 *number_of_children = 0;
2744 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
2745 if (!*child_handle_buffer)
2746 return EFI_OUT_OF_RESOURCES;
2747 /* Copy unique child handles */
2748 list_for_each_entry(handler, &efiobj->protocols, link) {
2749 list_for_each_entry(item, &handler->open_infos, link) {
2750 if (item->info.agent_handle == driver_handle &&
2751 item->info.attributes &
2752 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2753 /* Check this is a new child controller */
2755 for (i = 0; i < *number_of_children; ++i) {
2756 if ((*child_handle_buffer)[i] ==
2757 item->info.controller_handle)
2760 /* Copy handle to buffer */
2762 i = (*number_of_children)++;
2763 (*child_handle_buffer)[i] =
2764 item->info.controller_handle;
2773 * Disconnect a controller from a driver.
2775 * This function implements the DisconnectController service.
2776 * See the Unified Extensible Firmware Interface (UEFI) specification
2779 * @controller_handle handle of the controller
2780 * @driver_image_handle handle of the driver
2781 * @child_handle handle of the child to destroy
2782 * @return status code
2784 static efi_status_t EFIAPI efi_disconnect_controller(
2785 efi_handle_t controller_handle,
2786 efi_handle_t driver_image_handle,
2787 efi_handle_t child_handle)
2789 struct efi_driver_binding_protocol *binding_protocol;
2790 efi_handle_t *child_handle_buffer = NULL;
2791 size_t number_of_children = 0;
2793 size_t stop_count = 0;
2794 struct efi_object *efiobj;
2796 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
2799 efiobj = efi_search_obj(controller_handle);
2801 r = EFI_INVALID_PARAMETER;
2805 if (child_handle && !efi_search_obj(child_handle)) {
2806 r = EFI_INVALID_PARAMETER;
2810 /* If no driver handle is supplied, disconnect all drivers */
2811 if (!driver_image_handle) {
2812 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
2816 /* Create list of child handles */
2818 number_of_children = 1;
2819 child_handle_buffer = &child_handle;
2821 efi_get_child_controllers(efiobj,
2822 driver_image_handle,
2823 &number_of_children,
2824 &child_handle_buffer);
2827 /* Get the driver binding protocol */
2828 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2829 &efi_guid_driver_binding_protocol,
2830 (void **)&binding_protocol,
2831 driver_image_handle, NULL,
2832 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2833 if (r != EFI_SUCCESS)
2835 /* Remove the children */
2836 if (number_of_children) {
2837 r = EFI_CALL(binding_protocol->stop(binding_protocol,
2840 child_handle_buffer));
2841 if (r == EFI_SUCCESS)
2844 /* Remove the driver */
2846 r = EFI_CALL(binding_protocol->stop(binding_protocol,
2849 if (r == EFI_SUCCESS)
2851 EFI_CALL(efi_close_protocol(driver_image_handle,
2852 &efi_guid_driver_binding_protocol,
2853 driver_image_handle, NULL));
2861 free(child_handle_buffer);
2865 static const struct efi_boot_services efi_boot_services = {
2867 .headersize = sizeof(struct efi_table_hdr),
2869 .raise_tpl = efi_raise_tpl,
2870 .restore_tpl = efi_restore_tpl,
2871 .allocate_pages = efi_allocate_pages_ext,
2872 .free_pages = efi_free_pages_ext,
2873 .get_memory_map = efi_get_memory_map_ext,
2874 .allocate_pool = efi_allocate_pool_ext,
2875 .free_pool = efi_free_pool_ext,
2876 .create_event = efi_create_event_ext,
2877 .set_timer = efi_set_timer_ext,
2878 .wait_for_event = efi_wait_for_event,
2879 .signal_event = efi_signal_event_ext,
2880 .close_event = efi_close_event,
2881 .check_event = efi_check_event,
2882 .install_protocol_interface = efi_install_protocol_interface,
2883 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2884 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2885 .handle_protocol = efi_handle_protocol,
2887 .register_protocol_notify = efi_register_protocol_notify,
2888 .locate_handle = efi_locate_handle_ext,
2889 .locate_device_path = efi_locate_device_path,
2890 .install_configuration_table = efi_install_configuration_table_ext,
2891 .load_image = efi_load_image,
2892 .start_image = efi_start_image,
2894 .unload_image = efi_unload_image,
2895 .exit_boot_services = efi_exit_boot_services,
2896 .get_next_monotonic_count = efi_get_next_monotonic_count,
2898 .set_watchdog_timer = efi_set_watchdog_timer,
2899 .connect_controller = efi_connect_controller,
2900 .disconnect_controller = efi_disconnect_controller,
2901 .open_protocol = efi_open_protocol,
2902 .close_protocol = efi_close_protocol,
2903 .open_protocol_information = efi_open_protocol_information,
2904 .protocols_per_handle = efi_protocols_per_handle,
2905 .locate_handle_buffer = efi_locate_handle_buffer,
2906 .locate_protocol = efi_locate_protocol,
2907 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2908 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2909 .calculate_crc32 = efi_calculate_crc32,
2910 .copy_mem = efi_copy_mem,
2911 .set_mem = efi_set_mem,
2912 .create_event_ex = efi_create_event_ex,
2916 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
2918 struct efi_system_table __efi_runtime_data systab = {
2920 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2921 .revision = 2 << 16 | 70, /* 2.7 */
2922 .headersize = sizeof(struct efi_table_hdr),
2924 .fw_vendor = (long)firmware_vendor,
2925 .con_in = (void*)&efi_con_in,
2926 .con_out = (void*)&efi_con_out,
2927 .std_err = (void*)&efi_con_out,
2928 .runtime = (void*)&efi_runtime_services,
2929 .boottime = (void*)&efi_boot_services,
2931 .tables = (void*)efi_conf_table,