1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application boot time services
5 * Copyright (c) 2016 Alexander Graf
10 #include <efi_loader.h>
11 #include <environment.h>
13 #include <asm/global_data.h>
14 #include <linux/libfdt_env.h>
15 #include <u-boot/crc.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 /* Task priority level */
23 static efi_uintn_t efi_tpl = TPL_APPLICATION;
25 /* This list contains all the EFI objects our payload has access to */
26 LIST_HEAD(efi_obj_list);
28 /* List of all events */
29 LIST_HEAD(efi_events);
32 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
33 * we need to do trickery with caches. Since we don't want to break the EFI
34 * aware boot path, only apply hacks when loading exiting directly (breaking
35 * direct Linux EFI booting along the way - oh well).
37 static bool efi_is_direct_boot = true;
40 * EFI can pass arbitrary additional "tables" containing vendor specific
41 * information to the payload. One such table is the FDT table which contains
42 * a pointer to a flattened device tree blob.
44 * In most cases we want to pass an FDT to the payload, so reserve one slot of
45 * config table space for it. The pointer gets populated by do_bootefi_exec().
47 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
51 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
52 * fixed when compiling U-Boot. However, the payload does not know about that
53 * restriction so we need to manually swap its and our view of that register on
54 * EFI callback entry/exit.
56 static volatile void *efi_gd, *app_gd;
59 static int entry_count;
60 static int nesting_level;
61 /* GUID of the device tree table */
62 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
63 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
64 const efi_guid_t efi_guid_driver_binding_protocol =
65 EFI_DRIVER_BINDING_PROTOCOL_GUID;
67 /* event group ExitBootServices() invoked */
68 const efi_guid_t efi_guid_event_group_exit_boot_services =
69 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
70 /* event group SetVirtualAddressMap() invoked */
71 const efi_guid_t efi_guid_event_group_virtual_address_change =
72 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
73 /* event group memory map changed */
74 const efi_guid_t efi_guid_event_group_memory_map_change =
75 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
76 /* event group boot manager about to boot */
77 const efi_guid_t efi_guid_event_group_ready_to_boot =
78 EFI_EVENT_GROUP_READY_TO_BOOT;
79 /* event group ResetSystem() invoked (before ExitBootServices) */
80 const efi_guid_t efi_guid_event_group_reset_system =
81 EFI_EVENT_GROUP_RESET_SYSTEM;
83 static efi_status_t EFIAPI efi_disconnect_controller(
84 efi_handle_t controller_handle,
85 efi_handle_t driver_image_handle,
86 efi_handle_t child_handle);
88 /* Called on every callback entry */
89 int __efi_entry_check(void)
91 int ret = entry_count++ == 0;
100 /* Called on every callback exit */
101 int __efi_exit_check(void)
103 int ret = --entry_count == 0;
110 /* Called from do_bootefi_exec() */
111 void efi_save_gd(void)
119 * Special case handler for error/abort that just forces things back
120 * to u-boot world so we can dump out an abort msg, without any care
121 * about returning back to UEFI world.
123 void efi_restore_gd(void)
126 /* Only restore if we're already in EFI context */
134 * Return a string for indenting with two spaces per level. A maximum of ten
135 * indent levels is supported. Higher indent levels will be truncated.
137 * @level indent level
138 * @return indent string
140 static const char *indent_string(int level)
142 const char *indent = " ";
143 const int max = strlen(indent);
145 level = min(max, level * 2);
146 return &indent[max - level];
149 const char *__efi_nesting(void)
151 return indent_string(nesting_level);
154 const char *__efi_nesting_inc(void)
156 return indent_string(nesting_level++);
159 const char *__efi_nesting_dec(void)
161 return indent_string(--nesting_level);
165 * Queue an EFI event.
167 * This function queues the notification function of the event for future
170 * The notification function is called if the task priority level of the
171 * event is higher than the current task priority level.
173 * For the SignalEvent service see efi_signal_event_ext.
175 * @event event to signal
176 * @check_tpl check the TPL level
178 static void efi_queue_event(struct efi_event *event, bool check_tpl)
180 if (event->notify_function) {
181 event->is_queued = true;
183 if (check_tpl && efi_tpl >= event->notify_tpl)
185 EFI_CALL_VOID(event->notify_function(event,
186 event->notify_context));
188 event->is_queued = false;
192 * Signal an EFI event.
194 * This function signals an event. If the event belongs to an event group
195 * all events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
196 * their notification function is queued.
198 * For the SignalEvent service see efi_signal_event_ext.
200 * @event event to signal
201 * @check_tpl check the TPL level
203 void efi_signal_event(struct efi_event *event, bool check_tpl)
206 struct efi_event *evt;
209 * The signaled state has to set before executing any
210 * notification function
212 list_for_each_entry(evt, &efi_events, link) {
213 if (!evt->group || guidcmp(evt->group, event->group))
215 if (evt->is_signaled)
217 evt->is_signaled = true;
218 if (evt->type & EVT_NOTIFY_SIGNAL &&
219 evt->notify_function)
220 evt->is_queued = true;
222 list_for_each_entry(evt, &efi_events, link) {
223 if (!evt->group || guidcmp(evt->group, event->group))
226 efi_queue_event(evt, check_tpl);
228 } else if (!event->is_signaled) {
229 event->is_signaled = true;
230 if (event->type & EVT_NOTIFY_SIGNAL)
231 efi_queue_event(event, check_tpl);
236 * Raise the task priority level.
238 * This function implements the RaiseTpl service.
239 * See the Unified Extensible Firmware Interface (UEFI) specification
242 * @new_tpl new value of the task priority level
243 * @return old value of the task priority level
245 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
247 efi_uintn_t old_tpl = efi_tpl;
249 EFI_ENTRY("0x%zx", new_tpl);
251 if (new_tpl < efi_tpl)
252 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
254 if (efi_tpl > TPL_HIGH_LEVEL)
255 efi_tpl = TPL_HIGH_LEVEL;
257 EFI_EXIT(EFI_SUCCESS);
262 * Lower the task priority level.
264 * This function implements the RestoreTpl service.
265 * See the Unified Extensible Firmware Interface (UEFI) specification
268 * @old_tpl value of the task priority level to be restored
270 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
272 EFI_ENTRY("0x%zx", old_tpl);
274 if (old_tpl > efi_tpl)
275 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
277 if (efi_tpl > TPL_HIGH_LEVEL)
278 efi_tpl = TPL_HIGH_LEVEL;
281 * Lowering the TPL may have made queued events eligible for execution.
285 EFI_EXIT(EFI_SUCCESS);
289 * Allocate memory pages.
291 * This function implements the AllocatePages service.
292 * See the Unified Extensible Firmware Interface (UEFI) specification
295 * @type type of allocation to be performed
296 * @memory_type usage type of the allocated memory
297 * @pages number of pages to be allocated
298 * @memory allocated memory
299 * @return status code
301 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
307 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
308 r = efi_allocate_pages(type, memory_type, pages, memory);
315 * This function implements the FreePages service.
316 * See the Unified Extensible Firmware Interface (UEFI) specification
319 * @memory start of the memory area to be freed
320 * @pages number of pages to be freed
321 * @return status code
323 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
328 EFI_ENTRY("%" PRIx64 ", 0x%zx", memory, pages);
329 r = efi_free_pages(memory, pages);
334 * Get map describing memory usage.
336 * This function implements the GetMemoryMap service.
337 * See the Unified Extensible Firmware Interface (UEFI) specification
340 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
341 * on exit the size of the copied memory map
342 * @memory_map buffer to which the memory map is written
343 * @map_key key for the memory map
344 * @descriptor_size size of an individual memory descriptor
345 * @descriptor_version version number of the memory descriptor structure
346 * @return status code
348 static efi_status_t EFIAPI efi_get_memory_map_ext(
349 efi_uintn_t *memory_map_size,
350 struct efi_mem_desc *memory_map,
351 efi_uintn_t *map_key,
352 efi_uintn_t *descriptor_size,
353 uint32_t *descriptor_version)
357 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
358 map_key, descriptor_size, descriptor_version);
359 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
360 descriptor_size, descriptor_version);
365 * Allocate memory from pool.
367 * This function implements the AllocatePool service.
368 * See the Unified Extensible Firmware Interface (UEFI) specification
371 * @pool_type type of the pool from which memory is to be allocated
372 * @size number of bytes to be allocated
373 * @buffer allocated memory
374 * @return status code
376 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
382 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
383 r = efi_allocate_pool(pool_type, size, buffer);
388 * Free memory from pool.
390 * This function implements the FreePool service.
391 * See the Unified Extensible Firmware Interface (UEFI) specification
394 * @buffer start of memory to be freed
395 * @return status code
397 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
401 EFI_ENTRY("%p", buffer);
402 r = efi_free_pool(buffer);
407 * Add a new object to the object list.
409 * The protocols list is initialized.
410 * The object handle is set.
412 * @obj object to be added
414 void efi_add_handle(struct efi_object *obj)
418 INIT_LIST_HEAD(&obj->protocols);
420 list_add_tail(&obj->link, &efi_obj_list);
427 * @return status code
429 efi_status_t efi_create_handle(efi_handle_t *handle)
431 struct efi_object *obj;
434 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
435 sizeof(struct efi_object),
437 if (r != EFI_SUCCESS)
440 *handle = obj->handle;
445 * Find a protocol on a handle.
448 * @protocol_guid GUID of the protocol
449 * @handler reference to the protocol
450 * @return status code
452 efi_status_t efi_search_protocol(const efi_handle_t handle,
453 const efi_guid_t *protocol_guid,
454 struct efi_handler **handler)
456 struct efi_object *efiobj;
457 struct list_head *lhandle;
459 if (!handle || !protocol_guid)
460 return EFI_INVALID_PARAMETER;
461 efiobj = efi_search_obj(handle);
463 return EFI_INVALID_PARAMETER;
464 list_for_each(lhandle, &efiobj->protocols) {
465 struct efi_handler *protocol;
467 protocol = list_entry(lhandle, struct efi_handler, link);
468 if (!guidcmp(protocol->guid, protocol_guid)) {
474 return EFI_NOT_FOUND;
478 * Delete protocol from a handle.
480 * @handle handle from which the protocol shall be deleted
481 * @protocol GUID of the protocol to be deleted
482 * @protocol_interface interface of the protocol implementation
483 * @return status code
485 efi_status_t efi_remove_protocol(const efi_handle_t handle,
486 const efi_guid_t *protocol,
487 void *protocol_interface)
489 struct efi_handler *handler;
492 ret = efi_search_protocol(handle, protocol, &handler);
493 if (ret != EFI_SUCCESS)
495 if (guidcmp(handler->guid, protocol))
496 return EFI_INVALID_PARAMETER;
497 list_del(&handler->link);
503 * Delete all protocols from a handle.
505 * @handle handle from which the protocols shall be deleted
506 * @return status code
508 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
510 struct efi_object *efiobj;
511 struct efi_handler *protocol;
512 struct efi_handler *pos;
514 efiobj = efi_search_obj(handle);
516 return EFI_INVALID_PARAMETER;
517 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
520 ret = efi_remove_protocol(handle, protocol->guid,
521 protocol->protocol_interface);
522 if (ret != EFI_SUCCESS)
531 * @handle handle to delete
533 void efi_delete_handle(struct efi_object *obj)
537 efi_remove_all_protocols(obj->handle);
538 list_del(&obj->link);
543 * Check if a pointer is a valid event.
545 * @event pointer to check
546 * @return status code
548 static efi_status_t efi_is_event(const struct efi_event *event)
550 const struct efi_event *evt;
553 return EFI_INVALID_PARAMETER;
554 list_for_each_entry(evt, &efi_events, link) {
558 return EFI_INVALID_PARAMETER;
564 * This function is used inside U-Boot code to create an event.
566 * For the API function implementing the CreateEvent service see
567 * efi_create_event_ext.
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 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
577 void (EFIAPI *notify_function) (
578 struct efi_event *event,
580 void *notify_context, efi_guid_t *group,
581 struct efi_event **event)
583 struct efi_event *evt;
586 return EFI_INVALID_PARAMETER;
588 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
589 return EFI_INVALID_PARAMETER;
591 if ((type & (EVT_NOTIFY_SIGNAL | EVT_NOTIFY_WAIT)) &&
592 notify_function == NULL)
593 return EFI_INVALID_PARAMETER;
595 evt = calloc(1, sizeof(struct efi_event));
597 return EFI_OUT_OF_RESOURCES;
599 evt->notify_tpl = notify_tpl;
600 evt->notify_function = notify_function;
601 evt->notify_context = notify_context;
603 /* Disable timers on bootup */
604 evt->trigger_next = -1ULL;
605 evt->is_queued = false;
606 evt->is_signaled = false;
607 list_add_tail(&evt->link, &efi_events);
613 * Create an event in a group.
615 * This function implements the CreateEventEx service.
616 * See the Unified Extensible Firmware Interface (UEFI) specification
618 * TODO: Support event groups
620 * @type type of the event to create
621 * @notify_tpl task priority level of the event
622 * @notify_function notification function of the event
623 * @notify_context pointer passed to the notification function
624 * @event created event
625 * @event_group event group
626 * @return status code
628 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
629 void (EFIAPI *notify_function) (
630 struct efi_event *event,
632 void *notify_context,
633 efi_guid_t *event_group,
634 struct efi_event **event)
636 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
637 notify_context, event_group);
638 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
639 notify_context, event_group, event));
645 * This function implements the CreateEvent service.
646 * See the Unified Extensible Firmware Interface (UEFI) specification
649 * @type type of the event to create
650 * @notify_tpl task priority level of the event
651 * @notify_function notification function of the event
652 * @notify_context pointer passed to the notification function
653 * @event created event
654 * @return status code
656 static efi_status_t EFIAPI efi_create_event_ext(
657 uint32_t type, efi_uintn_t notify_tpl,
658 void (EFIAPI *notify_function) (
659 struct efi_event *event,
661 void *notify_context, struct efi_event **event)
663 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
665 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
666 notify_context, NULL, event));
670 * Check if a timer event has occurred or a queued notification function should
673 * Our timers have to work without interrupts, so we check whenever keyboard
674 * input or disk accesses happen if enough time elapsed for them to fire.
676 void efi_timer_check(void)
678 struct efi_event *evt;
679 u64 now = timer_get_us();
681 list_for_each_entry(evt, &efi_events, link) {
683 efi_queue_event(evt, true);
684 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
686 switch (evt->trigger_type) {
687 case EFI_TIMER_RELATIVE:
688 evt->trigger_type = EFI_TIMER_STOP;
690 case EFI_TIMER_PERIODIC:
691 evt->trigger_next += evt->trigger_time;
696 evt->is_signaled = false;
697 efi_signal_event(evt, true);
703 * Set the trigger time for a timer event or stop the event.
705 * This is the function for internal usage in U-Boot. For the API function
706 * implementing the SetTimer service see efi_set_timer_ext.
708 * @event event for which the timer is set
709 * @type type of the timer
710 * @trigger_time trigger period in multiples of 100ns
711 * @return status code
713 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
714 uint64_t trigger_time)
716 /* Check that the event is valid */
717 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
718 return EFI_INVALID_PARAMETER;
721 * The parameter defines a multiple of 100ns.
722 * We use multiples of 1000ns. So divide by 10.
724 do_div(trigger_time, 10);
728 event->trigger_next = -1ULL;
730 case EFI_TIMER_PERIODIC:
731 case EFI_TIMER_RELATIVE:
732 event->trigger_next = timer_get_us() + trigger_time;
735 return EFI_INVALID_PARAMETER;
737 event->trigger_type = type;
738 event->trigger_time = trigger_time;
739 event->is_signaled = false;
744 * Set the trigger time for a timer event or stop the event.
746 * This function implements the SetTimer service.
747 * See the Unified Extensible Firmware Interface (UEFI) specification
750 * @event event for which the timer is set
751 * @type type of the timer
752 * @trigger_time trigger period in multiples of 100ns
753 * @return status code
755 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
756 enum efi_timer_delay type,
757 uint64_t trigger_time)
759 EFI_ENTRY("%p, %d, %" PRIx64, event, type, trigger_time);
760 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
764 * Wait for events to be signaled.
766 * This function implements the WaitForEvent service.
767 * See the Unified Extensible Firmware Interface (UEFI) specification
770 * @num_events number of events to be waited for
771 * @events events to be waited for
772 * @index index of the event that was signaled
773 * @return status code
775 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
776 struct efi_event **event,
781 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
783 /* Check parameters */
784 if (!num_events || !event)
785 return EFI_EXIT(EFI_INVALID_PARAMETER);
787 if (efi_tpl != TPL_APPLICATION)
788 return EFI_EXIT(EFI_UNSUPPORTED);
789 for (i = 0; i < num_events; ++i) {
790 if (efi_is_event(event[i]) != EFI_SUCCESS)
791 return EFI_EXIT(EFI_INVALID_PARAMETER);
792 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
793 return EFI_EXIT(EFI_INVALID_PARAMETER);
794 if (!event[i]->is_signaled)
795 efi_queue_event(event[i], true);
798 /* Wait for signal */
800 for (i = 0; i < num_events; ++i) {
801 if (event[i]->is_signaled)
804 /* Allow events to occur. */
810 * Reset the signal which is passed to the caller to allow periodic
813 event[i]->is_signaled = false;
817 return EFI_EXIT(EFI_SUCCESS);
821 * Signal an EFI event.
823 * This function implements the SignalEvent service.
824 * See the Unified Extensible Firmware Interface (UEFI) specification
827 * This functions sets the signaled state of the event and queues the
828 * notification function for execution.
830 * @event event to signal
831 * @return status code
833 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
835 EFI_ENTRY("%p", event);
836 if (efi_is_event(event) != EFI_SUCCESS)
837 return EFI_EXIT(EFI_INVALID_PARAMETER);
838 efi_signal_event(event, true);
839 return EFI_EXIT(EFI_SUCCESS);
843 * Close an EFI event.
845 * This function implements the CloseEvent service.
846 * See the Unified Extensible Firmware Interface (UEFI) specification
849 * @event event to close
850 * @return status code
852 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
854 EFI_ENTRY("%p", event);
855 if (efi_is_event(event) != EFI_SUCCESS)
856 return EFI_EXIT(EFI_INVALID_PARAMETER);
857 list_del(&event->link);
859 return EFI_EXIT(EFI_SUCCESS);
863 * Check if an event is signaled.
865 * This function implements the CheckEvent service.
866 * See the Unified Extensible Firmware Interface (UEFI) specification
869 * If an event is not signaled yet, the notification function is queued.
870 * The signaled state is cleared.
872 * @event event to check
873 * @return status code
875 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
877 EFI_ENTRY("%p", event);
879 if (efi_is_event(event) != EFI_SUCCESS ||
880 event->type & EVT_NOTIFY_SIGNAL)
881 return EFI_EXIT(EFI_INVALID_PARAMETER);
882 if (!event->is_signaled)
883 efi_queue_event(event, true);
884 if (event->is_signaled) {
885 event->is_signaled = false;
886 return EFI_EXIT(EFI_SUCCESS);
888 return EFI_EXIT(EFI_NOT_READY);
892 * Find the internal EFI object for a handle.
894 * @handle handle to find
897 struct efi_object *efi_search_obj(const efi_handle_t handle)
899 struct efi_object *efiobj;
901 list_for_each_entry(efiobj, &efi_obj_list, link) {
902 if (efiobj->handle == handle)
910 * Create open protocol info entry and add it to a protocol.
912 * @handler handler of a protocol
913 * @return open protocol info entry
915 static struct efi_open_protocol_info_entry *efi_create_open_info(
916 struct efi_handler *handler)
918 struct efi_open_protocol_info_item *item;
920 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
923 /* Append the item to the open protocol info list. */
924 list_add_tail(&item->link, &handler->open_infos);
930 * Remove an open protocol info entry from a protocol.
932 * @handler handler of a protocol
933 * @return status code
935 static efi_status_t efi_delete_open_info(
936 struct efi_open_protocol_info_item *item)
938 list_del(&item->link);
944 * Install new protocol on a handle.
946 * @handle handle on which the protocol shall be installed
947 * @protocol GUID of the protocol to be installed
948 * @protocol_interface interface of the protocol implementation
949 * @return status code
951 efi_status_t efi_add_protocol(const efi_handle_t handle,
952 const efi_guid_t *protocol,
953 void *protocol_interface)
955 struct efi_object *efiobj;
956 struct efi_handler *handler;
959 efiobj = efi_search_obj(handle);
961 return EFI_INVALID_PARAMETER;
962 ret = efi_search_protocol(handle, protocol, NULL);
963 if (ret != EFI_NOT_FOUND)
964 return EFI_INVALID_PARAMETER;
965 handler = calloc(1, sizeof(struct efi_handler));
967 return EFI_OUT_OF_RESOURCES;
968 handler->guid = protocol;
969 handler->protocol_interface = protocol_interface;
970 INIT_LIST_HEAD(&handler->open_infos);
971 list_add_tail(&handler->link, &efiobj->protocols);
972 if (!guidcmp(&efi_guid_device_path, protocol))
973 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
978 * Install protocol interface.
980 * This function implements the InstallProtocolInterface service.
981 * See the Unified Extensible Firmware Interface (UEFI) specification
984 * @handle handle on which the protocol shall be installed
985 * @protocol GUID of the protocol to be installed
986 * @protocol_interface_type type of the interface to be installed,
987 * always EFI_NATIVE_INTERFACE
988 * @protocol_interface interface of the protocol implementation
989 * @return status code
991 static efi_status_t EFIAPI efi_install_protocol_interface(
992 void **handle, const efi_guid_t *protocol,
993 int protocol_interface_type, void *protocol_interface)
997 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1000 if (!handle || !protocol ||
1001 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1002 r = EFI_INVALID_PARAMETER;
1006 /* Create new handle if requested. */
1008 r = efi_create_handle(handle);
1009 if (r != EFI_SUCCESS)
1011 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1014 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1017 /* Add new protocol */
1018 r = efi_add_protocol(*handle, protocol, protocol_interface);
1024 * Reinstall protocol interface.
1026 * This function implements the ReinstallProtocolInterface service.
1027 * See the Unified Extensible Firmware Interface (UEFI) specification
1030 * @handle handle on which the protocol shall be
1032 * @protocol GUID of the protocol to be installed
1033 * @old_interface interface to be removed
1034 * @new_interface interface to be installed
1035 * @return status code
1037 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
1038 efi_handle_t handle, const efi_guid_t *protocol,
1039 void *old_interface, void *new_interface)
1041 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
1043 return EFI_EXIT(EFI_ACCESS_DENIED);
1047 * Get all drivers associated to a controller.
1048 * The allocated buffer has to be freed with free().
1050 * @efiobj handle of the controller
1051 * @protocol protocol guid (optional)
1052 * @number_of_drivers number of child controllers
1053 * @driver_handle_buffer handles of the the drivers
1054 * @return status code
1056 static efi_status_t efi_get_drivers(struct efi_object *efiobj,
1057 const efi_guid_t *protocol,
1058 efi_uintn_t *number_of_drivers,
1059 efi_handle_t **driver_handle_buffer)
1061 struct efi_handler *handler;
1062 struct efi_open_protocol_info_item *item;
1063 efi_uintn_t count = 0, i;
1066 /* Count all driver associations */
1067 list_for_each_entry(handler, &efiobj->protocols, link) {
1068 if (protocol && guidcmp(handler->guid, protocol))
1070 list_for_each_entry(item, &handler->open_infos, link) {
1071 if (item->info.attributes &
1072 EFI_OPEN_PROTOCOL_BY_DRIVER)
1077 * Create buffer. In case of duplicate driver assignments the buffer
1078 * will be too large. But that does not harm.
1080 *number_of_drivers = 0;
1081 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1082 if (!*driver_handle_buffer)
1083 return EFI_OUT_OF_RESOURCES;
1084 /* Collect unique driver handles */
1085 list_for_each_entry(handler, &efiobj->protocols, link) {
1086 if (protocol && guidcmp(handler->guid, protocol))
1088 list_for_each_entry(item, &handler->open_infos, link) {
1089 if (item->info.attributes &
1090 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1091 /* Check this is a new driver */
1093 for (i = 0; i < *number_of_drivers; ++i) {
1094 if ((*driver_handle_buffer)[i] ==
1095 item->info.agent_handle)
1098 /* Copy handle to buffer */
1100 i = (*number_of_drivers)++;
1101 (*driver_handle_buffer)[i] =
1102 item->info.agent_handle;
1111 * Disconnect all drivers from a controller.
1113 * This function implements the DisconnectController service.
1114 * See the Unified Extensible Firmware Interface (UEFI) specification
1117 * @efiobj handle of the controller
1118 * @protocol protocol guid (optional)
1119 * @child_handle handle of the child to destroy
1120 * @return status code
1122 static efi_status_t efi_disconnect_all_drivers(
1123 struct efi_object *efiobj,
1124 const efi_guid_t *protocol,
1125 efi_handle_t child_handle)
1127 efi_uintn_t number_of_drivers;
1128 efi_handle_t *driver_handle_buffer;
1129 efi_status_t r, ret;
1131 ret = efi_get_drivers(efiobj, protocol, &number_of_drivers,
1132 &driver_handle_buffer);
1133 if (ret != EFI_SUCCESS)
1136 ret = EFI_NOT_FOUND;
1137 while (number_of_drivers) {
1138 r = EFI_CALL(efi_disconnect_controller(
1140 driver_handle_buffer[--number_of_drivers],
1142 if (r == EFI_SUCCESS)
1145 free(driver_handle_buffer);
1150 * Uninstall protocol interface.
1152 * This function implements the UninstallProtocolInterface service.
1153 * See the Unified Extensible Firmware Interface (UEFI) specification
1156 * @handle handle from which the protocol shall be removed
1157 * @protocol GUID of the protocol to be removed
1158 * @protocol_interface interface to be removed
1159 * @return status code
1161 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
1162 efi_handle_t handle, const efi_guid_t *protocol,
1163 void *protocol_interface)
1165 struct efi_object *efiobj;
1166 struct efi_handler *handler;
1167 struct efi_open_protocol_info_item *item;
1168 struct efi_open_protocol_info_item *pos;
1171 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1174 efiobj = efi_search_obj(handle);
1176 r = EFI_INVALID_PARAMETER;
1179 /* Find the protocol on the handle */
1180 r = efi_search_protocol(handle, protocol, &handler);
1181 if (r != EFI_SUCCESS)
1183 /* Disconnect controllers */
1184 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1185 if (!list_empty(&handler->open_infos)) {
1186 r = EFI_ACCESS_DENIED;
1189 /* Close protocol */
1190 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1191 if (item->info.attributes ==
1192 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1193 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1194 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1195 list_del(&item->link);
1197 if (!list_empty(&handler->open_infos)) {
1198 r = EFI_ACCESS_DENIED;
1201 r = efi_remove_protocol(handle, protocol, protocol_interface);
1207 * Register an event for notification when a protocol is installed.
1209 * This function implements the RegisterProtocolNotify service.
1210 * See the Unified Extensible Firmware Interface (UEFI) specification
1213 * @protocol GUID of the protocol whose installation shall be
1215 * @event event to be signaled upon installation of the protocol
1216 * @registration key for retrieving the registration information
1217 * @return status code
1219 static efi_status_t EFIAPI efi_register_protocol_notify(
1220 const efi_guid_t *protocol,
1221 struct efi_event *event,
1222 void **registration)
1224 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1225 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1229 * Determine if an EFI handle implements a protocol.
1231 * See the documentation of the LocateHandle service in the UEFI specification.
1233 * @search_type selection criterion
1234 * @protocol GUID of the protocol
1235 * @search_key registration key
1237 * @return 0 if the handle implements the protocol
1239 static int efi_search(enum efi_locate_search_type search_type,
1240 const efi_guid_t *protocol, void *search_key,
1241 struct efi_object *efiobj)
1245 switch (search_type) {
1248 case BY_REGISTER_NOTIFY:
1249 /* TODO: RegisterProtocolNotify is not implemented yet */
1252 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1253 return (ret != EFI_SUCCESS);
1255 /* Invalid search type */
1261 * Locate handles implementing a protocol.
1263 * This function is meant for U-Boot internal calls. For the API implementation
1264 * of the LocateHandle service see efi_locate_handle_ext.
1266 * @search_type selection criterion
1267 * @protocol GUID of the protocol
1268 * @search_key registration key
1269 * @buffer_size size of the buffer to receive the handles in bytes
1270 * @buffer buffer to receive the relevant handles
1271 * @return status code
1273 static efi_status_t efi_locate_handle(
1274 enum efi_locate_search_type search_type,
1275 const efi_guid_t *protocol, void *search_key,
1276 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1278 struct efi_object *efiobj;
1279 efi_uintn_t size = 0;
1281 /* Check parameters */
1282 switch (search_type) {
1285 case BY_REGISTER_NOTIFY:
1287 return EFI_INVALID_PARAMETER;
1288 /* RegisterProtocolNotify is not implemented yet */
1289 return EFI_UNSUPPORTED;
1292 return EFI_INVALID_PARAMETER;
1295 return EFI_INVALID_PARAMETER;
1299 * efi_locate_handle_buffer uses this function for
1300 * the calculation of the necessary buffer size.
1301 * So do not require a buffer for buffersize == 0.
1303 if (!buffer_size || (*buffer_size && !buffer))
1304 return EFI_INVALID_PARAMETER;
1306 /* Count how much space we need */
1307 list_for_each_entry(efiobj, &efi_obj_list, link) {
1308 if (!efi_search(search_type, protocol, search_key, efiobj))
1309 size += sizeof(void *);
1312 if (*buffer_size < size) {
1313 *buffer_size = size;
1314 return EFI_BUFFER_TOO_SMALL;
1317 *buffer_size = size;
1319 return EFI_NOT_FOUND;
1321 /* Then fill the array */
1322 list_for_each_entry(efiobj, &efi_obj_list, link) {
1323 if (!efi_search(search_type, protocol, search_key, efiobj))
1324 *buffer++ = efiobj->handle;
1331 * Locate handles implementing a protocol.
1333 * This function implements the LocateHandle service.
1334 * See the Unified Extensible Firmware Interface (UEFI) specification
1337 * @search_type selection criterion
1338 * @protocol GUID of the protocol
1339 * @search_key registration key
1340 * @buffer_size size of the buffer to receive the handles in bytes
1341 * @buffer buffer to receive the relevant handles
1342 * @return 0 if the handle implements the protocol
1344 static efi_status_t EFIAPI efi_locate_handle_ext(
1345 enum efi_locate_search_type search_type,
1346 const efi_guid_t *protocol, void *search_key,
1347 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1349 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1350 buffer_size, buffer);
1352 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1353 buffer_size, buffer));
1356 /* Collapses configuration table entries, removing index i */
1357 static void efi_remove_configuration_table(int i)
1359 struct efi_configuration_table *this = &efi_conf_table[i];
1360 struct efi_configuration_table *next = &efi_conf_table[i + 1];
1361 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1363 memmove(this, next, (ulong)end - (ulong)next);
1368 * Adds, updates, or removes a configuration table.
1370 * This function is used for internal calls. For the API implementation of the
1371 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1373 * @guid GUID of the installed table
1374 * @table table to be installed
1375 * @return status code
1377 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1380 struct efi_event *evt;
1384 return EFI_INVALID_PARAMETER;
1386 /* Check for guid override */
1387 for (i = 0; i < systab.nr_tables; i++) {
1388 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1390 efi_conf_table[i].table = table;
1392 efi_remove_configuration_table(i);
1398 return EFI_NOT_FOUND;
1400 /* No override, check for overflow */
1401 if (i >= ARRAY_SIZE(efi_conf_table))
1402 return EFI_OUT_OF_RESOURCES;
1404 /* Add a new entry */
1405 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1406 efi_conf_table[i].table = table;
1407 systab.nr_tables = i + 1;
1410 /* Notify that the configuration table was changed */
1411 list_for_each_entry(evt, &efi_events, link) {
1412 if (evt->group && !guidcmp(evt->group, guid)) {
1413 efi_signal_event(evt, false);
1422 * Adds, updates, or removes a configuration table.
1424 * This function implements the InstallConfigurationTable service.
1425 * See the Unified Extensible Firmware Interface (UEFI) specification
1428 * @guid GUID of the installed table
1429 * @table table to be installed
1430 * @return status code
1432 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1435 EFI_ENTRY("%pUl, %p", guid, table);
1436 return EFI_EXIT(efi_install_configuration_table(guid, table));
1440 * Initialize a loaded_image_info + loaded_image_info object with correct
1441 * protocols, boot-device, etc.
1443 * @info loaded image info to be passed to the entry point of the
1445 * @obj internal object associated with the loaded image
1446 * @device_path device path of the loaded image
1447 * @file_path file path of the loaded image
1448 * @return status code
1450 efi_status_t efi_setup_loaded_image(
1451 struct efi_loaded_image *info, struct efi_object *obj,
1452 struct efi_device_path *device_path,
1453 struct efi_device_path *file_path)
1457 /* Add internal object to object list */
1458 efi_add_handle(obj);
1459 /* efi_exit() assumes that the handle points to the info */
1462 info->file_path = file_path;
1465 info->device_handle = efi_dp_find_obj(device_path, NULL);
1467 * When asking for the device path interface, return
1468 * bootefi_device_path
1470 ret = efi_add_protocol(obj->handle, &efi_guid_device_path,
1472 if (ret != EFI_SUCCESS)
1477 * When asking for the loaded_image interface, just
1478 * return handle which points to loaded_image_info
1480 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1481 if (ret != EFI_SUCCESS)
1484 ret = efi_add_protocol(obj->handle,
1485 &efi_guid_device_path_to_text_protocol,
1486 (void *)&efi_device_path_to_text);
1487 if (ret != EFI_SUCCESS)
1490 ret = efi_add_protocol(obj->handle,
1491 &efi_guid_device_path_utilities_protocol,
1492 (void *)&efi_device_path_utilities);
1493 if (ret != EFI_SUCCESS)
1498 printf("ERROR: Failure to install protocols for loaded image\n");
1503 * Load an image using a file path.
1505 * @file_path the path of the image to load
1506 * @buffer buffer containing the loaded image
1507 * @return status code
1509 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1512 struct efi_file_info *info = NULL;
1513 struct efi_file_handle *f;
1514 static efi_status_t ret;
1517 f = efi_file_from_path(file_path);
1519 return EFI_DEVICE_ERROR;
1522 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1524 if (ret == EFI_BUFFER_TOO_SMALL) {
1526 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1529 if (ret != EFI_SUCCESS)
1532 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1536 bs = info->file_size;
1537 EFI_CALL(ret = f->read(f, &bs, *buffer));
1541 EFI_CALL(f->close(f));
1543 if (ret != EFI_SUCCESS) {
1544 efi_free_pool(*buffer);
1552 * Load an EFI image into memory.
1554 * This function implements the LoadImage service.
1555 * See the Unified Extensible Firmware Interface (UEFI) specification
1558 * @boot_policy true for request originating from the boot manager
1559 * @parent_image the caller's image handle
1560 * @file_path the path of the image to load
1561 * @source_buffer memory location from which the image is installed
1562 * @source_size size of the memory area from which the image is
1564 * @image_handle handle for the newly installed image
1565 * @return status code
1567 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1568 efi_handle_t parent_image,
1569 struct efi_device_path *file_path,
1570 void *source_buffer,
1571 efi_uintn_t source_size,
1572 efi_handle_t *image_handle)
1574 struct efi_loaded_image *info;
1575 struct efi_object *obj;
1578 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1579 file_path, source_buffer, source_size, image_handle);
1581 if (!image_handle || !parent_image) {
1582 ret = EFI_INVALID_PARAMETER;
1586 if (!source_buffer && !file_path) {
1587 ret = EFI_NOT_FOUND;
1591 info = calloc(1, sizeof(*info));
1593 ret = EFI_OUT_OF_RESOURCES;
1596 obj = calloc(1, sizeof(*obj));
1599 ret = EFI_OUT_OF_RESOURCES;
1603 if (!source_buffer) {
1604 struct efi_device_path *dp, *fp;
1606 ret = efi_load_image_from_path(file_path, &source_buffer);
1607 if (ret != EFI_SUCCESS)
1610 * split file_path which contains both the device and
1613 efi_dp_split_file_path(file_path, &dp, &fp);
1614 ret = efi_setup_loaded_image(info, obj, dp, fp);
1615 if (ret != EFI_SUCCESS)
1618 /* In this case, file_path is the "device" path, ie.
1619 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1621 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1622 if (ret != EFI_SUCCESS)
1625 info->reserved = efi_load_pe(source_buffer, info);
1626 if (!info->reserved) {
1627 ret = EFI_UNSUPPORTED;
1630 info->system_table = &systab;
1631 info->parent_handle = parent_image;
1632 *image_handle = obj->handle;
1633 return EFI_EXIT(EFI_SUCCESS);
1636 efi_delete_handle(obj);
1638 return EFI_EXIT(ret);
1642 * Call the entry point of an image.
1644 * This function implements the StartImage service.
1645 * See the Unified Extensible Firmware Interface (UEFI) specification
1648 * @image_handle handle of the image
1649 * @exit_data_size size of the buffer
1650 * @exit_data buffer to receive the exit data of the called image
1651 * @return status code
1653 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1654 unsigned long *exit_data_size,
1657 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
1658 struct efi_system_table *st);
1659 struct efi_loaded_image *info = image_handle;
1662 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1663 entry = info->reserved;
1665 efi_is_direct_boot = false;
1667 /* call the image! */
1668 if (setjmp(&info->exit_jmp)) {
1670 * We called the entry point of the child image with EFI_CALL
1671 * in the lines below. The child image called the Exit() boot
1672 * service efi_exit() which executed the long jump that brought
1673 * us to the current line. This implies that the second half
1674 * of the EFI_CALL macro has not been executed.
1678 * efi_exit() called efi_restore_gd(). We have to undo this
1679 * otherwise __efi_entry_check() will put the wrong value into
1685 * To get ready to call EFI_EXIT below we have to execute the
1686 * missed out steps of EFI_CALL.
1688 assert(__efi_entry_check());
1689 debug("%sEFI: %lu returned by started image\n",
1690 __efi_nesting_dec(),
1691 (unsigned long)((uintptr_t)info->exit_status &
1693 return EFI_EXIT(info->exit_status);
1696 ret = EFI_CALL(entry(image_handle, &systab));
1699 * Usually UEFI applications call Exit() instead of returning.
1700 * But because the world doesn not consist of ponies and unicorns,
1701 * we're happy to emulate that behavior on behalf of a payload
1704 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
1708 * Leave an EFI application or driver.
1710 * This function implements the Exit service.
1711 * See the Unified Extensible Firmware Interface (UEFI) specification
1714 * @image_handle handle of the application or driver that is exiting
1715 * @exit_status status code
1716 * @exit_data_size size of the buffer in bytes
1717 * @exit_data buffer with data describing an error
1718 * @return status code
1720 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1721 efi_status_t exit_status,
1722 unsigned long exit_data_size,
1726 * We require that the handle points to the original loaded
1727 * image protocol interface.
1729 * For getting the longjmp address this is safer than locating
1730 * the protocol because the protocol may have been reinstalled
1731 * pointing to another memory location.
1733 * TODO: We should call the unload procedure of the loaded
1736 struct efi_loaded_image *loaded_image_info = (void *)image_handle;
1738 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1739 exit_data_size, exit_data);
1741 /* Make sure entry/exit counts for EFI world cross-overs match */
1742 EFI_EXIT(exit_status);
1745 * But longjmp out with the U-Boot gd, not the application's, as
1746 * the other end is a setjmp call inside EFI context.
1750 loaded_image_info->exit_status = exit_status;
1751 longjmp(&loaded_image_info->exit_jmp, 1);
1753 panic("EFI application exited");
1757 * Unload an EFI image.
1759 * This function implements the UnloadImage service.
1760 * See the Unified Extensible Firmware Interface (UEFI) specification
1763 * @image_handle handle of the image to be unloaded
1764 * @return status code
1766 static efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
1768 struct efi_object *efiobj;
1770 EFI_ENTRY("%p", image_handle);
1771 efiobj = efi_search_obj(image_handle);
1773 list_del(&efiobj->link);
1775 return EFI_EXIT(EFI_SUCCESS);
1779 * Fix up caches for EFI payloads if necessary.
1781 static void efi_exit_caches(void)
1783 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1785 * Grub on 32bit ARM needs to have caches disabled before jumping into
1786 * a zImage, but does not know of all cache layers. Give it a hand.
1788 if (efi_is_direct_boot)
1789 cleanup_before_linux();
1794 * Stop all boot services.
1796 * This function implements the ExitBootServices service.
1797 * See the Unified Extensible Firmware Interface (UEFI) specification
1800 * All timer events are disabled.
1801 * For exit boot services events the notification function is called.
1802 * The boot services are disabled in the system table.
1804 * @image_handle handle of the loaded image
1805 * @map_key key of the memory map
1806 * @return status code
1808 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1809 unsigned long map_key)
1811 struct efi_event *evt;
1813 EFI_ENTRY("%p, %ld", image_handle, map_key);
1815 /* Make sure that notification functions are not called anymore */
1816 efi_tpl = TPL_HIGH_LEVEL;
1818 /* Check if ExitBootServices has already been called */
1819 if (!systab.boottime)
1820 return EFI_EXIT(EFI_SUCCESS);
1822 /* Add related events to the event group */
1823 list_for_each_entry(evt, &efi_events, link) {
1824 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1825 evt->group = &efi_guid_event_group_exit_boot_services;
1827 /* Notify that ExitBootServices is invoked. */
1828 list_for_each_entry(evt, &efi_events, link) {
1830 !guidcmp(evt->group,
1831 &efi_guid_event_group_exit_boot_services)) {
1832 efi_signal_event(evt, false);
1837 /* TODO Should persist EFI variables here */
1839 board_quiesce_devices();
1841 /* Fix up caches for EFI payloads if necessary */
1844 /* This stops all lingering devices */
1845 bootm_disable_interrupts();
1847 /* Disable boottime services */
1848 systab.con_in_handle = NULL;
1849 systab.con_in = NULL;
1850 systab.con_out_handle = NULL;
1851 systab.con_out = NULL;
1852 systab.stderr_handle = NULL;
1853 systab.std_err = NULL;
1854 systab.boottime = NULL;
1856 /* Recalculate CRC32 */
1857 systab.hdr.crc32 = 0;
1858 systab.hdr.crc32 = crc32(0, (const unsigned char *)&systab,
1859 sizeof(struct efi_system_table));
1861 /* Give the payload some time to boot */
1862 efi_set_watchdog(0);
1865 return EFI_EXIT(EFI_SUCCESS);
1869 * Get next value of the counter.
1871 * This function implements the NextMonotonicCount service.
1872 * See the Unified Extensible Firmware Interface (UEFI) specification
1875 * @count returned value of the counter
1876 * @return status code
1878 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1880 static uint64_t mono;
1882 EFI_ENTRY("%p", count);
1884 return EFI_EXIT(EFI_SUCCESS);
1890 * This function implements the Stall sercive.
1891 * See the Unified Extensible Firmware Interface (UEFI) specification
1894 * @microseconds period to sleep in microseconds
1895 * @return status code
1897 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1899 EFI_ENTRY("%ld", microseconds);
1900 udelay(microseconds);
1901 return EFI_EXIT(EFI_SUCCESS);
1905 * Reset the watchdog timer.
1907 * This function implements the SetWatchdogTimer service.
1908 * See the Unified Extensible Firmware Interface (UEFI) specification
1911 * @timeout seconds before reset by watchdog
1912 * @watchdog_code code to be logged when resetting
1913 * @data_size size of buffer in bytes
1914 * @watchdog_data buffer with data describing the reset reason
1915 * @return status code
1917 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1918 uint64_t watchdog_code,
1919 unsigned long data_size,
1920 uint16_t *watchdog_data)
1922 EFI_ENTRY("%ld, 0x%" PRIx64 ", %ld, %p", timeout, watchdog_code,
1923 data_size, watchdog_data);
1924 return EFI_EXIT(efi_set_watchdog(timeout));
1930 * This function implements the CloseProtocol service.
1931 * See the Unified Extensible Firmware Interface (UEFI) specification
1934 * @handle handle on which the protocol shall be closed
1935 * @protocol GUID of the protocol to close
1936 * @agent_handle handle of the driver
1937 * @controller_handle handle of the controller
1938 * @return status code
1940 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1941 const efi_guid_t *protocol,
1942 efi_handle_t agent_handle,
1943 efi_handle_t controller_handle)
1945 struct efi_handler *handler;
1946 struct efi_open_protocol_info_item *item;
1947 struct efi_open_protocol_info_item *pos;
1950 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1953 if (!agent_handle) {
1954 r = EFI_INVALID_PARAMETER;
1957 r = efi_search_protocol(handle, protocol, &handler);
1958 if (r != EFI_SUCCESS)
1962 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1963 if (item->info.agent_handle == agent_handle &&
1964 item->info.controller_handle == controller_handle) {
1965 efi_delete_open_info(item);
1975 * Provide information about then open status of a protocol on a handle
1977 * This function implements the OpenProtocolInformation service.
1978 * See the Unified Extensible Firmware Interface (UEFI) specification
1981 * @handle handle for which the information shall be retrieved
1982 * @protocol GUID of the protocol
1983 * @entry_buffer buffer to receive the open protocol information
1984 * @entry_count number of entries available in the buffer
1985 * @return status code
1987 static efi_status_t EFIAPI efi_open_protocol_information(
1988 efi_handle_t handle, const efi_guid_t *protocol,
1989 struct efi_open_protocol_info_entry **entry_buffer,
1990 efi_uintn_t *entry_count)
1992 unsigned long buffer_size;
1993 unsigned long count;
1994 struct efi_handler *handler;
1995 struct efi_open_protocol_info_item *item;
1998 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2001 /* Check parameters */
2002 if (!entry_buffer) {
2003 r = EFI_INVALID_PARAMETER;
2006 r = efi_search_protocol(handle, protocol, &handler);
2007 if (r != EFI_SUCCESS)
2012 list_for_each_entry(item, &handler->open_infos, link) {
2013 if (item->info.open_count)
2016 *entry_count = count;
2017 *entry_buffer = NULL;
2024 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2025 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2026 (void **)entry_buffer);
2027 if (r != EFI_SUCCESS)
2029 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2030 if (item->info.open_count)
2031 (*entry_buffer)[--count] = item->info;
2038 * Get protocols installed on a handle.
2040 * This function implements the ProtocolsPerHandleService.
2041 * See the Unified Extensible Firmware Interface (UEFI) specification
2044 * @handle handle for which the information is retrieved
2045 * @protocol_buffer buffer with protocol GUIDs
2046 * @protocol_buffer_count number of entries in the buffer
2047 * @return status code
2049 static efi_status_t EFIAPI efi_protocols_per_handle(
2050 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2051 efi_uintn_t *protocol_buffer_count)
2053 unsigned long buffer_size;
2054 struct efi_object *efiobj;
2055 struct list_head *protocol_handle;
2058 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2059 protocol_buffer_count);
2061 if (!handle || !protocol_buffer || !protocol_buffer_count)
2062 return EFI_EXIT(EFI_INVALID_PARAMETER);
2064 *protocol_buffer = NULL;
2065 *protocol_buffer_count = 0;
2067 efiobj = efi_search_obj(handle);
2069 return EFI_EXIT(EFI_INVALID_PARAMETER);
2071 /* Count protocols */
2072 list_for_each(protocol_handle, &efiobj->protocols) {
2073 ++*protocol_buffer_count;
2077 if (*protocol_buffer_count) {
2080 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2081 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2082 (void **)protocol_buffer);
2083 if (r != EFI_SUCCESS)
2085 list_for_each(protocol_handle, &efiobj->protocols) {
2086 struct efi_handler *protocol;
2088 protocol = list_entry(protocol_handle,
2089 struct efi_handler, link);
2090 (*protocol_buffer)[j] = (void *)protocol->guid;
2095 return EFI_EXIT(EFI_SUCCESS);
2099 * Locate handles implementing a protocol.
2101 * This function implements the LocateHandleBuffer service.
2102 * See the Unified Extensible Firmware Interface (UEFI) specification
2105 * @search_type selection criterion
2106 * @protocol GUID of the protocol
2107 * @search_key registration key
2108 * @no_handles number of returned handles
2109 * @buffer buffer with the returned handles
2110 * @return status code
2112 static efi_status_t EFIAPI efi_locate_handle_buffer(
2113 enum efi_locate_search_type search_type,
2114 const efi_guid_t *protocol, void *search_key,
2115 efi_uintn_t *no_handles, efi_handle_t **buffer)
2118 efi_uintn_t buffer_size = 0;
2120 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2121 no_handles, buffer);
2123 if (!no_handles || !buffer) {
2124 r = EFI_INVALID_PARAMETER;
2129 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2131 if (r != EFI_BUFFER_TOO_SMALL)
2133 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2135 if (r != EFI_SUCCESS)
2137 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2139 if (r == EFI_SUCCESS)
2140 *no_handles = buffer_size / sizeof(efi_handle_t);
2146 * Find an interface implementing a protocol.
2148 * This function implements the LocateProtocol service.
2149 * See the Unified Extensible Firmware Interface (UEFI) specification
2152 * @protocol GUID of the protocol
2153 * @registration registration key passed to the notification function
2154 * @protocol_interface interface implementing the protocol
2155 * @return status code
2157 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2159 void **protocol_interface)
2161 struct list_head *lhandle;
2164 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2166 if (!protocol || !protocol_interface)
2167 return EFI_EXIT(EFI_INVALID_PARAMETER);
2169 list_for_each(lhandle, &efi_obj_list) {
2170 struct efi_object *efiobj;
2171 struct efi_handler *handler;
2173 efiobj = list_entry(lhandle, struct efi_object, link);
2175 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
2176 if (ret == EFI_SUCCESS) {
2177 *protocol_interface = handler->protocol_interface;
2178 return EFI_EXIT(EFI_SUCCESS);
2181 *protocol_interface = NULL;
2183 return EFI_EXIT(EFI_NOT_FOUND);
2187 * Get the device path and handle of an device implementing a protocol.
2189 * This function implements the LocateDevicePath service.
2190 * See the Unified Extensible Firmware Interface (UEFI) specification
2193 * @protocol GUID of the protocol
2194 * @device_path device path
2195 * @device handle of the device
2196 * @return status code
2198 static efi_status_t EFIAPI efi_locate_device_path(
2199 const efi_guid_t *protocol,
2200 struct efi_device_path **device_path,
2201 efi_handle_t *device)
2203 struct efi_device_path *dp;
2205 struct efi_handler *handler;
2206 efi_handle_t *handles;
2208 size_t len_best = 0;
2209 efi_uintn_t no_handles;
2213 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2215 if (!protocol || !device_path || !*device_path || !device) {
2216 ret = EFI_INVALID_PARAMETER;
2220 /* Find end of device path */
2221 len = efi_dp_instance_size(*device_path);
2223 /* Get all handles implementing the protocol */
2224 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2225 &no_handles, &handles));
2226 if (ret != EFI_SUCCESS)
2229 for (i = 0; i < no_handles; ++i) {
2230 /* Find the device path protocol */
2231 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2233 if (ret != EFI_SUCCESS)
2235 dp = (struct efi_device_path *)handler->protocol_interface;
2236 len_dp = efi_dp_instance_size(dp);
2238 * This handle can only be a better fit
2239 * if its device path length is longer than the best fit and
2240 * if its device path length is shorter of equal the searched
2243 if (len_dp <= len_best || len_dp > len)
2245 /* Check if dp is a subpath of device_path */
2246 if (memcmp(*device_path, dp, len_dp))
2248 *device = handles[i];
2252 remainder = (u8 *)*device_path + len_best;
2253 *device_path = (struct efi_device_path *)remainder;
2256 ret = EFI_NOT_FOUND;
2259 return EFI_EXIT(ret);
2263 * Install multiple protocol interfaces.
2265 * This function implements the MultipleProtocolInterfaces service.
2266 * See the Unified Extensible Firmware Interface (UEFI) specification
2269 * @handle handle on which the protocol interfaces shall be installed
2270 * @... NULL terminated argument list with pairs of protocol GUIDS and
2272 * @return status code
2274 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2277 EFI_ENTRY("%p", handle);
2280 const efi_guid_t *protocol;
2281 void *protocol_interface;
2282 efi_status_t r = EFI_SUCCESS;
2286 return EFI_EXIT(EFI_INVALID_PARAMETER);
2288 va_start(argptr, handle);
2290 protocol = va_arg(argptr, efi_guid_t*);
2293 protocol_interface = va_arg(argptr, void*);
2294 r = EFI_CALL(efi_install_protocol_interface(
2296 EFI_NATIVE_INTERFACE,
2297 protocol_interface));
2298 if (r != EFI_SUCCESS)
2303 if (r == EFI_SUCCESS)
2306 /* If an error occurred undo all changes. */
2307 va_start(argptr, handle);
2309 protocol = va_arg(argptr, efi_guid_t*);
2310 protocol_interface = va_arg(argptr, void*);
2311 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2312 protocol_interface));
2320 * Uninstall multiple protocol interfaces.
2322 * This function implements the UninstallMultipleProtocolInterfaces service.
2323 * See the Unified Extensible Firmware Interface (UEFI) specification
2326 * @handle handle from which the protocol interfaces shall be removed
2327 * @... NULL terminated argument list with pairs of protocol GUIDS and
2329 * @return status code
2331 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2334 EFI_ENTRY("%p", handle);
2337 const efi_guid_t *protocol;
2338 void *protocol_interface;
2339 efi_status_t r = EFI_SUCCESS;
2343 return EFI_EXIT(EFI_INVALID_PARAMETER);
2345 va_start(argptr, handle);
2347 protocol = va_arg(argptr, efi_guid_t*);
2350 protocol_interface = va_arg(argptr, void*);
2351 r = EFI_CALL(efi_uninstall_protocol_interface(
2353 protocol_interface));
2354 if (r != EFI_SUCCESS)
2359 if (r == EFI_SUCCESS)
2362 /* If an error occurred undo all changes. */
2363 va_start(argptr, handle);
2365 protocol = va_arg(argptr, efi_guid_t*);
2366 protocol_interface = va_arg(argptr, void*);
2367 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2368 EFI_NATIVE_INTERFACE,
2369 protocol_interface));
2377 * Calculate cyclic redundancy code.
2379 * This function implements the CalculateCrc32 service.
2380 * See the Unified Extensible Firmware Interface (UEFI) specification
2383 * @data buffer with data
2384 * @data_size size of buffer in bytes
2385 * @crc32_p cyclic redundancy code
2386 * @return status code
2388 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2389 unsigned long data_size,
2392 EFI_ENTRY("%p, %ld", data, data_size);
2393 *crc32_p = crc32(0, data, data_size);
2394 return EFI_EXIT(EFI_SUCCESS);
2400 * This function implements the CopyMem service.
2401 * See the Unified Extensible Firmware Interface (UEFI) specification
2404 * @destination destination of the copy operation
2405 * @source source of the copy operation
2406 * @length number of bytes to copy
2408 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2411 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2412 memcpy(destination, source, length);
2413 EFI_EXIT(EFI_SUCCESS);
2417 * Fill memory with a byte value.
2419 * This function implements the SetMem service.
2420 * See the Unified Extensible Firmware Interface (UEFI) specification
2423 * @buffer buffer to fill
2424 * @size size of buffer in bytes
2425 * @value byte to copy to the buffer
2427 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2429 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2430 memset(buffer, value, size);
2431 EFI_EXIT(EFI_SUCCESS);
2435 * Open protocol interface on a handle.
2437 * @handler handler of a protocol
2438 * @protocol_interface interface implementing the protocol
2439 * @agent_handle handle of the driver
2440 * @controller_handle handle of the controller
2441 * @attributes attributes indicating how to open the protocol
2442 * @return status code
2444 static efi_status_t efi_protocol_open(
2445 struct efi_handler *handler,
2446 void **protocol_interface, void *agent_handle,
2447 void *controller_handle, uint32_t attributes)
2449 struct efi_open_protocol_info_item *item;
2450 struct efi_open_protocol_info_entry *match = NULL;
2451 bool opened_by_driver = false;
2452 bool opened_exclusive = false;
2454 /* If there is no agent, only return the interface */
2458 /* For TEST_PROTOCOL ignore interface attribute */
2459 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2460 *protocol_interface = NULL;
2463 * Check if the protocol is already opened by a driver with the same
2464 * attributes or opened exclusively
2466 list_for_each_entry(item, &handler->open_infos, link) {
2467 if (item->info.agent_handle == agent_handle) {
2468 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2469 (item->info.attributes == attributes))
2470 return EFI_ALREADY_STARTED;
2472 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2473 opened_exclusive = true;
2476 /* Only one controller can open the protocol exclusively */
2477 if (opened_exclusive && attributes &
2478 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2479 return EFI_ACCESS_DENIED;
2481 /* Prepare exclusive opening */
2482 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2483 /* Try to disconnect controllers */
2484 list_for_each_entry(item, &handler->open_infos, link) {
2485 if (item->info.attributes ==
2486 EFI_OPEN_PROTOCOL_BY_DRIVER)
2487 EFI_CALL(efi_disconnect_controller(
2488 item->info.controller_handle,
2489 item->info.agent_handle,
2492 opened_by_driver = false;
2493 /* Check if all controllers are disconnected */
2494 list_for_each_entry(item, &handler->open_infos, link) {
2495 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2496 opened_by_driver = true;
2498 /* Only one controller can be conncected */
2499 if (opened_by_driver)
2500 return EFI_ACCESS_DENIED;
2503 /* Find existing entry */
2504 list_for_each_entry(item, &handler->open_infos, link) {
2505 if (item->info.agent_handle == agent_handle &&
2506 item->info.controller_handle == controller_handle)
2507 match = &item->info;
2509 /* None found, create one */
2511 match = efi_create_open_info(handler);
2513 return EFI_OUT_OF_RESOURCES;
2516 match->agent_handle = agent_handle;
2517 match->controller_handle = controller_handle;
2518 match->attributes = attributes;
2519 match->open_count++;
2522 /* For TEST_PROTOCOL ignore interface attribute. */
2523 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2524 *protocol_interface = handler->protocol_interface;
2530 * Open protocol interface on a handle.
2532 * This function implements the OpenProtocol interface.
2533 * See the Unified Extensible Firmware Interface (UEFI) specification
2536 * @handle handle on which the protocol shall be opened
2537 * @protocol GUID of the protocol
2538 * @protocol_interface interface implementing the protocol
2539 * @agent_handle handle of the driver
2540 * @controller_handle handle of the controller
2541 * @attributes attributes indicating how to open the protocol
2542 * @return status code
2544 static efi_status_t EFIAPI efi_open_protocol(
2545 void *handle, const efi_guid_t *protocol,
2546 void **protocol_interface, void *agent_handle,
2547 void *controller_handle, uint32_t attributes)
2549 struct efi_handler *handler;
2550 efi_status_t r = EFI_INVALID_PARAMETER;
2552 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2553 protocol_interface, agent_handle, controller_handle,
2556 if (!handle || !protocol ||
2557 (!protocol_interface && attributes !=
2558 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2562 switch (attributes) {
2563 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2564 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2565 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2567 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2568 if (controller_handle == handle)
2571 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2572 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2573 /* Check that the controller handle is valid */
2574 if (!efi_search_obj(controller_handle))
2577 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2578 /* Check that the agent handle is valid */
2579 if (!efi_search_obj(agent_handle))
2586 r = efi_search_protocol(handle, protocol, &handler);
2587 if (r != EFI_SUCCESS)
2590 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2591 controller_handle, attributes);
2597 * Get interface of a protocol on a handle.
2599 * This function implements the HandleProtocol service.
2600 * See the Unified Extensible Firmware Interface (UEFI) specification
2603 * @handle handle on which the protocol shall be opened
2604 * @protocol GUID of the protocol
2605 * @protocol_interface interface implementing the protocol
2606 * @return status code
2608 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2609 const efi_guid_t *protocol,
2610 void **protocol_interface)
2612 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2613 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2616 static efi_status_t efi_bind_controller(
2617 efi_handle_t controller_handle,
2618 efi_handle_t driver_image_handle,
2619 struct efi_device_path *remain_device_path)
2621 struct efi_driver_binding_protocol *binding_protocol;
2624 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2625 &efi_guid_driver_binding_protocol,
2626 (void **)&binding_protocol,
2627 driver_image_handle, NULL,
2628 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2629 if (r != EFI_SUCCESS)
2631 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2633 remain_device_path));
2634 if (r == EFI_SUCCESS)
2635 r = EFI_CALL(binding_protocol->start(binding_protocol,
2637 remain_device_path));
2638 EFI_CALL(efi_close_protocol(driver_image_handle,
2639 &efi_guid_driver_binding_protocol,
2640 driver_image_handle, NULL));
2644 static efi_status_t efi_connect_single_controller(
2645 efi_handle_t controller_handle,
2646 efi_handle_t *driver_image_handle,
2647 struct efi_device_path *remain_device_path)
2649 efi_handle_t *buffer;
2653 size_t connected = 0;
2655 /* Get buffer with all handles with driver binding protocol */
2656 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2657 &efi_guid_driver_binding_protocol,
2658 NULL, &count, &buffer));
2659 if (r != EFI_SUCCESS)
2662 /* Context Override */
2663 if (driver_image_handle) {
2664 for (; *driver_image_handle; ++driver_image_handle) {
2665 for (i = 0; i < count; ++i) {
2666 if (buffer[i] == *driver_image_handle) {
2668 r = efi_bind_controller(
2670 *driver_image_handle,
2671 remain_device_path);
2673 * For drivers that do not support the
2674 * controller or are already connected
2675 * we receive an error code here.
2677 if (r == EFI_SUCCESS)
2685 * TODO: Some overrides are not yet implemented:
2686 * - Platform Driver Override
2687 * - Driver Family Override Search
2688 * - Bus Specific Driver Override
2691 /* Driver Binding Search */
2692 for (i = 0; i < count; ++i) {
2694 r = efi_bind_controller(controller_handle,
2696 remain_device_path);
2697 if (r == EFI_SUCCESS)
2702 efi_free_pool(buffer);
2704 return EFI_NOT_FOUND;
2709 * Connect a controller to a driver.
2711 * This function implements the ConnectController service.
2712 * See the Unified Extensible Firmware Interface (UEFI) specification
2715 * First all driver binding protocol handles are tried for binding drivers.
2716 * Afterwards all handles that have openened a protocol of the controller
2717 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2719 * @controller_handle handle of the controller
2720 * @driver_image_handle handle of the driver
2721 * @remain_device_path device path of a child controller
2722 * @recursive true to connect all child controllers
2723 * @return status code
2725 static efi_status_t EFIAPI efi_connect_controller(
2726 efi_handle_t controller_handle,
2727 efi_handle_t *driver_image_handle,
2728 struct efi_device_path *remain_device_path,
2732 efi_status_t ret = EFI_NOT_FOUND;
2733 struct efi_object *efiobj;
2735 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
2736 remain_device_path, recursive);
2738 efiobj = efi_search_obj(controller_handle);
2740 ret = EFI_INVALID_PARAMETER;
2744 r = efi_connect_single_controller(controller_handle,
2745 driver_image_handle,
2746 remain_device_path);
2747 if (r == EFI_SUCCESS)
2750 struct efi_handler *handler;
2751 struct efi_open_protocol_info_item *item;
2753 list_for_each_entry(handler, &efiobj->protocols, link) {
2754 list_for_each_entry(item, &handler->open_infos, link) {
2755 if (item->info.attributes &
2756 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2757 r = EFI_CALL(efi_connect_controller(
2758 item->info.controller_handle,
2759 driver_image_handle,
2762 if (r == EFI_SUCCESS)
2768 /* Check for child controller specified by end node */
2769 if (ret != EFI_SUCCESS && remain_device_path &&
2770 remain_device_path->type == DEVICE_PATH_TYPE_END)
2773 return EFI_EXIT(ret);
2777 * Get all child controllers associated to a driver.
2778 * The allocated buffer has to be freed with free().
2780 * @efiobj handle of the controller
2781 * @driver_handle handle of the driver
2782 * @number_of_children number of child controllers
2783 * @child_handle_buffer handles of the the child controllers
2785 static efi_status_t efi_get_child_controllers(
2786 struct efi_object *efiobj,
2787 efi_handle_t driver_handle,
2788 efi_uintn_t *number_of_children,
2789 efi_handle_t **child_handle_buffer)
2791 struct efi_handler *handler;
2792 struct efi_open_protocol_info_item *item;
2793 efi_uintn_t count = 0, i;
2796 /* Count all child controller associations */
2797 list_for_each_entry(handler, &efiobj->protocols, link) {
2798 list_for_each_entry(item, &handler->open_infos, link) {
2799 if (item->info.agent_handle == driver_handle &&
2800 item->info.attributes &
2801 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
2806 * Create buffer. In case of duplicate child controller assignments
2807 * the buffer will be too large. But that does not harm.
2809 *number_of_children = 0;
2810 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
2811 if (!*child_handle_buffer)
2812 return EFI_OUT_OF_RESOURCES;
2813 /* Copy unique child handles */
2814 list_for_each_entry(handler, &efiobj->protocols, link) {
2815 list_for_each_entry(item, &handler->open_infos, link) {
2816 if (item->info.agent_handle == driver_handle &&
2817 item->info.attributes &
2818 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2819 /* Check this is a new child controller */
2821 for (i = 0; i < *number_of_children; ++i) {
2822 if ((*child_handle_buffer)[i] ==
2823 item->info.controller_handle)
2826 /* Copy handle to buffer */
2828 i = (*number_of_children)++;
2829 (*child_handle_buffer)[i] =
2830 item->info.controller_handle;
2839 * Disconnect a controller from a driver.
2841 * This function implements the DisconnectController service.
2842 * See the Unified Extensible Firmware Interface (UEFI) specification
2845 * @controller_handle handle of the controller
2846 * @driver_image_handle handle of the driver
2847 * @child_handle handle of the child to destroy
2848 * @return status code
2850 static efi_status_t EFIAPI efi_disconnect_controller(
2851 efi_handle_t controller_handle,
2852 efi_handle_t driver_image_handle,
2853 efi_handle_t child_handle)
2855 struct efi_driver_binding_protocol *binding_protocol;
2856 efi_handle_t *child_handle_buffer = NULL;
2857 size_t number_of_children = 0;
2859 size_t stop_count = 0;
2860 struct efi_object *efiobj;
2862 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
2865 efiobj = efi_search_obj(controller_handle);
2867 r = EFI_INVALID_PARAMETER;
2871 if (child_handle && !efi_search_obj(child_handle)) {
2872 r = EFI_INVALID_PARAMETER;
2876 /* If no driver handle is supplied, disconnect all drivers */
2877 if (!driver_image_handle) {
2878 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
2882 /* Create list of child handles */
2884 number_of_children = 1;
2885 child_handle_buffer = &child_handle;
2887 efi_get_child_controllers(efiobj,
2888 driver_image_handle,
2889 &number_of_children,
2890 &child_handle_buffer);
2893 /* Get the driver binding protocol */
2894 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2895 &efi_guid_driver_binding_protocol,
2896 (void **)&binding_protocol,
2897 driver_image_handle, NULL,
2898 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2899 if (r != EFI_SUCCESS)
2901 /* Remove the children */
2902 if (number_of_children) {
2903 r = EFI_CALL(binding_protocol->stop(binding_protocol,
2906 child_handle_buffer));
2907 if (r == EFI_SUCCESS)
2910 /* Remove the driver */
2912 r = EFI_CALL(binding_protocol->stop(binding_protocol,
2915 if (r == EFI_SUCCESS)
2917 EFI_CALL(efi_close_protocol(driver_image_handle,
2918 &efi_guid_driver_binding_protocol,
2919 driver_image_handle, NULL));
2927 free(child_handle_buffer);
2931 static const struct efi_boot_services efi_boot_services = {
2933 .headersize = sizeof(struct efi_table_hdr),
2935 .raise_tpl = efi_raise_tpl,
2936 .restore_tpl = efi_restore_tpl,
2937 .allocate_pages = efi_allocate_pages_ext,
2938 .free_pages = efi_free_pages_ext,
2939 .get_memory_map = efi_get_memory_map_ext,
2940 .allocate_pool = efi_allocate_pool_ext,
2941 .free_pool = efi_free_pool_ext,
2942 .create_event = efi_create_event_ext,
2943 .set_timer = efi_set_timer_ext,
2944 .wait_for_event = efi_wait_for_event,
2945 .signal_event = efi_signal_event_ext,
2946 .close_event = efi_close_event,
2947 .check_event = efi_check_event,
2948 .install_protocol_interface = efi_install_protocol_interface,
2949 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2950 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2951 .handle_protocol = efi_handle_protocol,
2953 .register_protocol_notify = efi_register_protocol_notify,
2954 .locate_handle = efi_locate_handle_ext,
2955 .locate_device_path = efi_locate_device_path,
2956 .install_configuration_table = efi_install_configuration_table_ext,
2957 .load_image = efi_load_image,
2958 .start_image = efi_start_image,
2960 .unload_image = efi_unload_image,
2961 .exit_boot_services = efi_exit_boot_services,
2962 .get_next_monotonic_count = efi_get_next_monotonic_count,
2964 .set_watchdog_timer = efi_set_watchdog_timer,
2965 .connect_controller = efi_connect_controller,
2966 .disconnect_controller = efi_disconnect_controller,
2967 .open_protocol = efi_open_protocol,
2968 .close_protocol = efi_close_protocol,
2969 .open_protocol_information = efi_open_protocol_information,
2970 .protocols_per_handle = efi_protocols_per_handle,
2971 .locate_handle_buffer = efi_locate_handle_buffer,
2972 .locate_protocol = efi_locate_protocol,
2973 .install_multiple_protocol_interfaces =
2974 efi_install_multiple_protocol_interfaces,
2975 .uninstall_multiple_protocol_interfaces =
2976 efi_uninstall_multiple_protocol_interfaces,
2977 .calculate_crc32 = efi_calculate_crc32,
2978 .copy_mem = efi_copy_mem,
2979 .set_mem = efi_set_mem,
2980 .create_event_ex = efi_create_event_ex,
2983 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
2985 struct efi_system_table __efi_runtime_data systab = {
2987 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2988 .revision = 2 << 16 | 70, /* 2.7 */
2989 .headersize = sizeof(struct efi_table_hdr),
2991 .fw_vendor = (long)firmware_vendor,
2992 .con_in = (void *)&efi_con_in,
2993 .con_out = (void *)&efi_con_out,
2994 .std_err = (void *)&efi_con_out,
2995 .runtime = (void *)&efi_runtime_services,
2996 .boottime = (void *)&efi_boot_services,
2998 .tables = (void *)efi_conf_table,