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 <linux/libfdt_env.h>
14 #include <u-boot/crc.h>
18 DECLARE_GLOBAL_DATA_PTR
;
20 /* Task priority level */
21 static efi_uintn_t efi_tpl
= TPL_APPLICATION
;
23 /* This list contains all the EFI objects our payload has access to */
24 LIST_HEAD(efi_obj_list
);
26 /* List of all events */
27 LIST_HEAD(efi_events
);
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;
39 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
40 * fixed when compiling U-Boot. However, the payload does not know about that
41 * restriction so we need to manually swap its and our view of that register on
42 * EFI callback entry/exit.
44 static volatile void *efi_gd
, *app_gd
;
47 static int entry_count
;
48 static int nesting_level
;
49 /* GUID of the device tree table */
50 const efi_guid_t efi_guid_fdt
= EFI_FDT_GUID
;
51 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
52 const efi_guid_t efi_guid_driver_binding_protocol
=
53 EFI_DRIVER_BINDING_PROTOCOL_GUID
;
55 /* event group ExitBootServices() invoked */
56 const efi_guid_t efi_guid_event_group_exit_boot_services
=
57 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES
;
58 /* event group SetVirtualAddressMap() invoked */
59 const efi_guid_t efi_guid_event_group_virtual_address_change
=
60 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE
;
61 /* event group memory map changed */
62 const efi_guid_t efi_guid_event_group_memory_map_change
=
63 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE
;
64 /* event group boot manager about to boot */
65 const efi_guid_t efi_guid_event_group_ready_to_boot
=
66 EFI_EVENT_GROUP_READY_TO_BOOT
;
67 /* event group ResetSystem() invoked (before ExitBootServices) */
68 const efi_guid_t efi_guid_event_group_reset_system
=
69 EFI_EVENT_GROUP_RESET_SYSTEM
;
71 static efi_status_t EFIAPI
efi_disconnect_controller(
72 efi_handle_t controller_handle
,
73 efi_handle_t driver_image_handle
,
74 efi_handle_t child_handle
);
76 /* Called on every callback entry */
77 int __efi_entry_check(void)
79 int ret
= entry_count
++ == 0;
88 /* Called on every callback exit */
89 int __efi_exit_check(void)
91 int ret
= --entry_count
== 0;
98 /* Called from do_bootefi_exec() */
99 void efi_save_gd(void)
107 * Special case handler for error/abort that just forces things back to u-boot
108 * world so we can dump out an abort msg, without any care about returning back
111 void efi_restore_gd(void)
114 /* Only restore if we're already in EFI context */
122 * indent_string() - returns a string for indenting with two spaces per level
123 * @level: indent level
125 * A maximum of ten indent levels is supported. Higher indent levels will be
128 * Return: A string for indenting with two spaces per level is
131 static const char *indent_string(int level
)
133 const char *indent
= " ";
134 const int max
= strlen(indent
);
136 level
= min(max
, level
* 2);
137 return &indent
[max
- level
];
140 const char *__efi_nesting(void)
142 return indent_string(nesting_level
);
145 const char *__efi_nesting_inc(void)
147 return indent_string(nesting_level
++);
150 const char *__efi_nesting_dec(void)
152 return indent_string(--nesting_level
);
156 * efi_queue_event() - queue an EFI event
157 * @event: event to signal
158 * @check_tpl: check the TPL level
160 * This function queues the notification function of the event for future
163 * The notification function is called if the task priority level of the event
164 * is higher than the current task priority level.
166 * For the SignalEvent service see efi_signal_event_ext.
169 static void efi_queue_event(struct efi_event
*event
, bool check_tpl
)
171 if (event
->notify_function
) {
172 event
->is_queued
= true;
174 if (check_tpl
&& efi_tpl
>= event
->notify_tpl
)
176 EFI_CALL_VOID(event
->notify_function(event
,
177 event
->notify_context
));
179 event
->is_queued
= false;
183 * is_valid_tpl() - check if the task priority level is valid
185 * @tpl: TPL level to check
186 * ReturnValue: status code
188 efi_status_t
is_valid_tpl(efi_uintn_t tpl
)
191 case TPL_APPLICATION
:
197 return EFI_INVALID_PARAMETER
;
202 * efi_signal_event() - signal an EFI event
203 * @event: event to signal
204 * @check_tpl: check the TPL level
206 * This function signals an event. If the event belongs to an event group all
207 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
208 * their notification function is queued.
210 * For the SignalEvent service see efi_signal_event_ext.
212 void efi_signal_event(struct efi_event
*event
, bool check_tpl
)
215 struct efi_event
*evt
;
218 * The signaled state has to set before executing any
219 * notification function
221 list_for_each_entry(evt
, &efi_events
, link
) {
222 if (!evt
->group
|| guidcmp(evt
->group
, event
->group
))
224 if (evt
->is_signaled
)
226 evt
->is_signaled
= true;
227 if (evt
->type
& EVT_NOTIFY_SIGNAL
&&
228 evt
->notify_function
)
229 evt
->is_queued
= true;
231 list_for_each_entry(evt
, &efi_events
, link
) {
232 if (!evt
->group
|| guidcmp(evt
->group
, event
->group
))
235 efi_queue_event(evt
, check_tpl
);
237 } else if (!event
->is_signaled
) {
238 event
->is_signaled
= true;
239 if (event
->type
& EVT_NOTIFY_SIGNAL
)
240 efi_queue_event(event
, check_tpl
);
245 * efi_raise_tpl() - raise the task priority level
246 * @new_tpl: new value of the task priority level
248 * This function implements the RaiseTpl service.
250 * See the Unified Extensible Firmware Interface (UEFI) specification for
253 * Return: old value of the task priority level
255 static unsigned long EFIAPI
efi_raise_tpl(efi_uintn_t new_tpl
)
257 efi_uintn_t old_tpl
= efi_tpl
;
259 EFI_ENTRY("0x%zx", new_tpl
);
261 if (new_tpl
< efi_tpl
)
262 debug("WARNING: new_tpl < current_tpl in %s\n", __func__
);
264 if (efi_tpl
> TPL_HIGH_LEVEL
)
265 efi_tpl
= TPL_HIGH_LEVEL
;
267 EFI_EXIT(EFI_SUCCESS
);
272 * efi_restore_tpl() - lower the task priority level
273 * @old_tpl: value of the task priority level to be restored
275 * This function implements the RestoreTpl service.
277 * See the Unified Extensible Firmware Interface (UEFI) specification for
280 static void EFIAPI
efi_restore_tpl(efi_uintn_t old_tpl
)
282 EFI_ENTRY("0x%zx", old_tpl
);
284 if (old_tpl
> efi_tpl
)
285 debug("WARNING: old_tpl > current_tpl in %s\n", __func__
);
287 if (efi_tpl
> TPL_HIGH_LEVEL
)
288 efi_tpl
= TPL_HIGH_LEVEL
;
291 * Lowering the TPL may have made queued events eligible for execution.
295 EFI_EXIT(EFI_SUCCESS
);
299 * efi_allocate_pages_ext() - allocate memory pages
300 * @type: type of allocation to be performed
301 * @memory_type: usage type of the allocated memory
302 * @pages: number of pages to be allocated
303 * @memory: allocated memory
305 * This function implements the AllocatePages service.
307 * See the Unified Extensible Firmware Interface (UEFI) specification for
310 * Return: status code
312 static efi_status_t EFIAPI
efi_allocate_pages_ext(int type
, int memory_type
,
318 EFI_ENTRY("%d, %d, 0x%zx, %p", type
, memory_type
, pages
, memory
);
319 r
= efi_allocate_pages(type
, memory_type
, pages
, memory
);
324 * efi_free_pages_ext() - Free memory pages.
325 * @memory: start of the memory area to be freed
326 * @pages: number of pages to be freed
328 * This function implements the FreePages service.
330 * See the Unified Extensible Firmware Interface (UEFI) specification for
333 * Return: status code
335 static efi_status_t EFIAPI
efi_free_pages_ext(uint64_t memory
,
340 EFI_ENTRY("%llx, 0x%zx", memory
, pages
);
341 r
= efi_free_pages(memory
, pages
);
346 * efi_get_memory_map_ext() - get map describing memory usage
347 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
348 * on exit the size of the copied memory map
349 * @memory_map: buffer to which the memory map is written
350 * @map_key: key for the memory map
351 * @descriptor_size: size of an individual memory descriptor
352 * @descriptor_version: version number of the memory descriptor structure
354 * This function implements the GetMemoryMap service.
356 * See the Unified Extensible Firmware Interface (UEFI) specification for
359 * Return: status code
361 static efi_status_t EFIAPI
efi_get_memory_map_ext(
362 efi_uintn_t
*memory_map_size
,
363 struct efi_mem_desc
*memory_map
,
364 efi_uintn_t
*map_key
,
365 efi_uintn_t
*descriptor_size
,
366 uint32_t *descriptor_version
)
370 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size
, memory_map
,
371 map_key
, descriptor_size
, descriptor_version
);
372 r
= efi_get_memory_map(memory_map_size
, memory_map
, map_key
,
373 descriptor_size
, descriptor_version
);
378 * efi_allocate_pool_ext() - allocate memory from pool
379 * @pool_type: type of the pool from which memory is to be allocated
380 * @size: number of bytes to be allocated
381 * @buffer: allocated memory
383 * This function implements the AllocatePool service.
385 * See the Unified Extensible Firmware Interface (UEFI) specification for
388 * Return: status code
390 static efi_status_t EFIAPI
efi_allocate_pool_ext(int pool_type
,
396 EFI_ENTRY("%d, %zd, %p", pool_type
, size
, buffer
);
397 r
= efi_allocate_pool(pool_type
, size
, buffer
);
402 * efi_free_pool_ext() - free memory from pool
403 * @buffer: start of memory to be freed
405 * This function implements the FreePool service.
407 * See the Unified Extensible Firmware Interface (UEFI) specification for
410 * Return: status code
412 static efi_status_t EFIAPI
efi_free_pool_ext(void *buffer
)
416 EFI_ENTRY("%p", buffer
);
417 r
= efi_free_pool(buffer
);
422 * efi_add_handle() - add a new object to the object list
423 * @obj: object to be added
425 * The protocols list is initialized. The object handle is set.
427 void efi_add_handle(struct efi_object
*obj
)
431 INIT_LIST_HEAD(&obj
->protocols
);
433 list_add_tail(&obj
->link
, &efi_obj_list
);
437 * efi_create_handle() - create handle
438 * @handle: new handle
440 * Return: status code
442 efi_status_t
efi_create_handle(efi_handle_t
*handle
)
444 struct efi_object
*obj
;
446 obj
= calloc(1, sizeof(struct efi_object
));
448 return EFI_OUT_OF_RESOURCES
;
451 *handle
= obj
->handle
;
457 * efi_search_protocol() - find a protocol on a handle.
459 * @protocol_guid: GUID of the protocol
460 * @handler: reference to the protocol
462 * Return: status code
464 efi_status_t
efi_search_protocol(const efi_handle_t handle
,
465 const efi_guid_t
*protocol_guid
,
466 struct efi_handler
**handler
)
468 struct efi_object
*efiobj
;
469 struct list_head
*lhandle
;
471 if (!handle
|| !protocol_guid
)
472 return EFI_INVALID_PARAMETER
;
473 efiobj
= efi_search_obj(handle
);
475 return EFI_INVALID_PARAMETER
;
476 list_for_each(lhandle
, &efiobj
->protocols
) {
477 struct efi_handler
*protocol
;
479 protocol
= list_entry(lhandle
, struct efi_handler
, link
);
480 if (!guidcmp(protocol
->guid
, protocol_guid
)) {
486 return EFI_NOT_FOUND
;
490 * efi_remove_protocol() - delete protocol from a handle
491 * @handle: handle from which the protocol shall be deleted
492 * @protocol: GUID of the protocol to be deleted
493 * @protocol_interface: interface of the protocol implementation
495 * Return: status code
497 efi_status_t
efi_remove_protocol(const efi_handle_t handle
,
498 const efi_guid_t
*protocol
,
499 void *protocol_interface
)
501 struct efi_handler
*handler
;
504 ret
= efi_search_protocol(handle
, protocol
, &handler
);
505 if (ret
!= EFI_SUCCESS
)
507 if (guidcmp(handler
->guid
, protocol
))
508 return EFI_INVALID_PARAMETER
;
509 if (handler
->protocol_interface
!= protocol_interface
)
510 return EFI_INVALID_PARAMETER
;
511 list_del(&handler
->link
);
517 * efi_remove_all_protocols() - delete all protocols from a handle
518 * @handle: handle from which the protocols shall be deleted
520 * Return: status code
522 efi_status_t
efi_remove_all_protocols(const efi_handle_t handle
)
524 struct efi_object
*efiobj
;
525 struct efi_handler
*protocol
;
526 struct efi_handler
*pos
;
528 efiobj
= efi_search_obj(handle
);
530 return EFI_INVALID_PARAMETER
;
531 list_for_each_entry_safe(protocol
, pos
, &efiobj
->protocols
, link
) {
534 ret
= efi_remove_protocol(handle
, protocol
->guid
,
535 protocol
->protocol_interface
);
536 if (ret
!= EFI_SUCCESS
)
543 * efi_delete_handle() - delete handle
545 * @obj: handle to delete
547 void efi_delete_handle(struct efi_object
*obj
)
551 efi_remove_all_protocols(obj
->handle
);
552 list_del(&obj
->link
);
557 * efi_is_event() - check if a pointer is a valid event
558 * @event: pointer to check
560 * Return: status code
562 static efi_status_t
efi_is_event(const struct efi_event
*event
)
564 const struct efi_event
*evt
;
567 return EFI_INVALID_PARAMETER
;
568 list_for_each_entry(evt
, &efi_events
, link
) {
572 return EFI_INVALID_PARAMETER
;
576 * efi_create_event() - create an event
577 * @type: type of the event to create
578 * @notify_tpl: task priority level of the event
579 * @notify_function: notification function of the event
580 * @notify_context: pointer passed to the notification function
581 * @group: event group
582 * @event: created event
584 * This function is used inside U-Boot code to create an event.
586 * For the API function implementing the CreateEvent service see
587 * efi_create_event_ext.
589 * Return: status code
591 efi_status_t
efi_create_event(uint32_t type
, efi_uintn_t notify_tpl
,
592 void (EFIAPI
*notify_function
) (
593 struct efi_event
*event
,
595 void *notify_context
, efi_guid_t
*group
,
596 struct efi_event
**event
)
598 struct efi_event
*evt
;
601 return EFI_INVALID_PARAMETER
;
606 case EVT_NOTIFY_SIGNAL
:
607 case EVT_TIMER
| EVT_NOTIFY_SIGNAL
:
608 case EVT_NOTIFY_WAIT
:
609 case EVT_TIMER
| EVT_NOTIFY_WAIT
:
610 case EVT_SIGNAL_EXIT_BOOT_SERVICES
:
611 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
:
614 return EFI_INVALID_PARAMETER
;
617 if ((type
& (EVT_NOTIFY_WAIT
| EVT_NOTIFY_SIGNAL
)) &&
618 (is_valid_tpl(notify_tpl
) != EFI_SUCCESS
))
619 return EFI_INVALID_PARAMETER
;
621 evt
= calloc(1, sizeof(struct efi_event
));
623 return EFI_OUT_OF_RESOURCES
;
625 evt
->notify_tpl
= notify_tpl
;
626 evt
->notify_function
= notify_function
;
627 evt
->notify_context
= notify_context
;
629 /* Disable timers on bootup */
630 evt
->trigger_next
= -1ULL;
631 evt
->is_queued
= false;
632 evt
->is_signaled
= false;
633 list_add_tail(&evt
->link
, &efi_events
);
639 * efi_create_event_ex() - create an event in a group
640 * @type: type of the event to create
641 * @notify_tpl: task priority level of the event
642 * @notify_function: notification function of the event
643 * @notify_context: pointer passed to the notification function
644 * @event: created event
645 * @event_group: event group
647 * This function implements the CreateEventEx service.
649 * See the Unified Extensible Firmware Interface (UEFI) specification for
652 * Return: status code
654 efi_status_t EFIAPI
efi_create_event_ex(uint32_t type
, efi_uintn_t notify_tpl
,
655 void (EFIAPI
*notify_function
) (
656 struct efi_event
*event
,
658 void *notify_context
,
659 efi_guid_t
*event_group
,
660 struct efi_event
**event
)
662 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type
, notify_tpl
, notify_function
,
663 notify_context
, event_group
);
664 return EFI_EXIT(efi_create_event(type
, notify_tpl
, notify_function
,
665 notify_context
, event_group
, event
));
669 * efi_create_event_ext() - create an event
670 * @type: type of the event to create
671 * @notify_tpl: task priority level of the event
672 * @notify_function: notification function of the event
673 * @notify_context: pointer passed to the notification function
674 * @event: created event
676 * This function implements the CreateEvent service.
678 * See the Unified Extensible Firmware Interface (UEFI) specification for
681 * Return: status code
683 static efi_status_t EFIAPI
efi_create_event_ext(
684 uint32_t type
, efi_uintn_t notify_tpl
,
685 void (EFIAPI
*notify_function
) (
686 struct efi_event
*event
,
688 void *notify_context
, struct efi_event
**event
)
690 EFI_ENTRY("%d, 0x%zx, %p, %p", type
, notify_tpl
, notify_function
,
692 return EFI_EXIT(efi_create_event(type
, notify_tpl
, notify_function
,
693 notify_context
, NULL
, event
));
697 * efi_timer_check() - check if a timer event has occurred
699 * Check if a timer event has occurred or a queued notification function should
702 * Our timers have to work without interrupts, so we check whenever keyboard
703 * input or disk accesses happen if enough time elapsed for them to fire.
705 void efi_timer_check(void)
707 struct efi_event
*evt
;
708 u64 now
= timer_get_us();
710 list_for_each_entry(evt
, &efi_events
, link
) {
712 efi_queue_event(evt
, true);
713 if (!(evt
->type
& EVT_TIMER
) || now
< evt
->trigger_next
)
715 switch (evt
->trigger_type
) {
716 case EFI_TIMER_RELATIVE
:
717 evt
->trigger_type
= EFI_TIMER_STOP
;
719 case EFI_TIMER_PERIODIC
:
720 evt
->trigger_next
+= evt
->trigger_time
;
725 evt
->is_signaled
= false;
726 efi_signal_event(evt
, true);
732 * efi_set_timer() - set the trigger time for a timer event or stop the event
733 * @event: event for which the timer is set
734 * @type: type of the timer
735 * @trigger_time: trigger period in multiples of 100ns
737 * This is the function for internal usage in U-Boot. For the API function
738 * implementing the SetTimer service see efi_set_timer_ext.
740 * Return: status code
742 efi_status_t
efi_set_timer(struct efi_event
*event
, enum efi_timer_delay type
,
743 uint64_t trigger_time
)
745 /* Check that the event is valid */
746 if (efi_is_event(event
) != EFI_SUCCESS
|| !(event
->type
& EVT_TIMER
))
747 return EFI_INVALID_PARAMETER
;
750 * The parameter defines a multiple of 100ns.
751 * We use multiples of 1000ns. So divide by 10.
753 do_div(trigger_time
, 10);
757 event
->trigger_next
= -1ULL;
759 case EFI_TIMER_PERIODIC
:
760 case EFI_TIMER_RELATIVE
:
761 event
->trigger_next
= timer_get_us() + trigger_time
;
764 return EFI_INVALID_PARAMETER
;
766 event
->trigger_type
= type
;
767 event
->trigger_time
= trigger_time
;
768 event
->is_signaled
= false;
773 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
775 * @event: event for which the timer is set
776 * @type: type of the timer
777 * @trigger_time: trigger period in multiples of 100ns
779 * This function implements the SetTimer service.
781 * See the Unified Extensible Firmware Interface (UEFI) specification for
785 * Return: status code
787 static efi_status_t EFIAPI
efi_set_timer_ext(struct efi_event
*event
,
788 enum efi_timer_delay type
,
789 uint64_t trigger_time
)
791 EFI_ENTRY("%p, %d, %llx", event
, type
, trigger_time
);
792 return EFI_EXIT(efi_set_timer(event
, type
, trigger_time
));
796 * efi_wait_for_event() - wait for events to be signaled
797 * @num_events: number of events to be waited for
798 * @event: events to be waited for
799 * @index: index of the event that was signaled
801 * This function implements the WaitForEvent service.
803 * See the Unified Extensible Firmware Interface (UEFI) specification for
806 * Return: status code
808 static efi_status_t EFIAPI
efi_wait_for_event(efi_uintn_t num_events
,
809 struct efi_event
**event
,
814 EFI_ENTRY("%zd, %p, %p", num_events
, event
, index
);
816 /* Check parameters */
817 if (!num_events
|| !event
)
818 return EFI_EXIT(EFI_INVALID_PARAMETER
);
820 if (efi_tpl
!= TPL_APPLICATION
)
821 return EFI_EXIT(EFI_UNSUPPORTED
);
822 for (i
= 0; i
< num_events
; ++i
) {
823 if (efi_is_event(event
[i
]) != EFI_SUCCESS
)
824 return EFI_EXIT(EFI_INVALID_PARAMETER
);
825 if (!event
[i
]->type
|| event
[i
]->type
& EVT_NOTIFY_SIGNAL
)
826 return EFI_EXIT(EFI_INVALID_PARAMETER
);
827 if (!event
[i
]->is_signaled
)
828 efi_queue_event(event
[i
], true);
831 /* Wait for signal */
833 for (i
= 0; i
< num_events
; ++i
) {
834 if (event
[i
]->is_signaled
)
837 /* Allow events to occur. */
843 * Reset the signal which is passed to the caller to allow periodic
846 event
[i
]->is_signaled
= false;
850 return EFI_EXIT(EFI_SUCCESS
);
854 * efi_signal_event_ext() - signal an EFI event
855 * @event: event to signal
857 * This function implements the SignalEvent service.
859 * See the Unified Extensible Firmware Interface (UEFI) specification for
862 * This functions sets the signaled state of the event and queues the
863 * notification function for execution.
865 * Return: status code
867 static efi_status_t EFIAPI
efi_signal_event_ext(struct efi_event
*event
)
869 EFI_ENTRY("%p", event
);
870 if (efi_is_event(event
) != EFI_SUCCESS
)
871 return EFI_EXIT(EFI_INVALID_PARAMETER
);
872 efi_signal_event(event
, true);
873 return EFI_EXIT(EFI_SUCCESS
);
877 * efi_close_event() - close an EFI event
878 * @event: event to close
880 * This function implements the CloseEvent service.
882 * See the Unified Extensible Firmware Interface (UEFI) specification for
885 * Return: status code
887 static efi_status_t EFIAPI
efi_close_event(struct efi_event
*event
)
889 EFI_ENTRY("%p", event
);
890 if (efi_is_event(event
) != EFI_SUCCESS
)
891 return EFI_EXIT(EFI_INVALID_PARAMETER
);
892 list_del(&event
->link
);
894 return EFI_EXIT(EFI_SUCCESS
);
898 * efi_check_event() - check if an event is signaled
899 * @event: event to check
901 * This function implements the CheckEvent service.
903 * See the Unified Extensible Firmware Interface (UEFI) specification for
906 * If an event is not signaled yet, the notification function is queued. The
907 * signaled state is cleared.
909 * Return: status code
911 static efi_status_t EFIAPI
efi_check_event(struct efi_event
*event
)
913 EFI_ENTRY("%p", event
);
915 if (efi_is_event(event
) != EFI_SUCCESS
||
916 event
->type
& EVT_NOTIFY_SIGNAL
)
917 return EFI_EXIT(EFI_INVALID_PARAMETER
);
918 if (!event
->is_signaled
)
919 efi_queue_event(event
, true);
920 if (event
->is_signaled
) {
921 event
->is_signaled
= false;
922 return EFI_EXIT(EFI_SUCCESS
);
924 return EFI_EXIT(EFI_NOT_READY
);
928 * efi_search_obj() - find the internal EFI object for a handle
929 * @handle: handle to find
933 struct efi_object
*efi_search_obj(const efi_handle_t handle
)
935 struct efi_object
*efiobj
;
937 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
938 if (efiobj
->handle
== handle
)
946 * efi_open_protocol_info_entry() - create open protocol info entry and add it
948 * @handler: handler of a protocol
950 * Return: open protocol info entry
952 static struct efi_open_protocol_info_entry
*efi_create_open_info(
953 struct efi_handler
*handler
)
955 struct efi_open_protocol_info_item
*item
;
957 item
= calloc(1, sizeof(struct efi_open_protocol_info_item
));
960 /* Append the item to the open protocol info list. */
961 list_add_tail(&item
->link
, &handler
->open_infos
);
967 * efi_delete_open_info() - remove an open protocol info entry from a protocol
968 * @item: open protocol info entry to delete
970 * Return: status code
972 static efi_status_t
efi_delete_open_info(
973 struct efi_open_protocol_info_item
*item
)
975 list_del(&item
->link
);
981 * efi_add_protocol() - install new protocol on a handle
982 * @handle: handle on which the protocol shall be installed
983 * @protocol: GUID of the protocol to be installed
984 * @protocol_interface: interface of the protocol implementation
986 * Return: status code
988 efi_status_t
efi_add_protocol(const efi_handle_t handle
,
989 const efi_guid_t
*protocol
,
990 void *protocol_interface
)
992 struct efi_object
*efiobj
;
993 struct efi_handler
*handler
;
996 efiobj
= efi_search_obj(handle
);
998 return EFI_INVALID_PARAMETER
;
999 ret
= efi_search_protocol(handle
, protocol
, NULL
);
1000 if (ret
!= EFI_NOT_FOUND
)
1001 return EFI_INVALID_PARAMETER
;
1002 handler
= calloc(1, sizeof(struct efi_handler
));
1004 return EFI_OUT_OF_RESOURCES
;
1005 handler
->guid
= protocol
;
1006 handler
->protocol_interface
= protocol_interface
;
1007 INIT_LIST_HEAD(&handler
->open_infos
);
1008 list_add_tail(&handler
->link
, &efiobj
->protocols
);
1009 if (!guidcmp(&efi_guid_device_path
, protocol
))
1010 EFI_PRINT("installed device path '%pD'\n", protocol_interface
);
1015 * efi_install_protocol_interface() - install protocol interface
1016 * @handle: handle on which the protocol shall be installed
1017 * @protocol: GUID of the protocol to be installed
1018 * @protocol_interface_type: type of the interface to be installed,
1019 * always EFI_NATIVE_INTERFACE
1020 * @protocol_interface: interface of the protocol implementation
1022 * This function implements the InstallProtocolInterface service.
1024 * See the Unified Extensible Firmware Interface (UEFI) specification for
1027 * Return: status code
1029 static efi_status_t EFIAPI
efi_install_protocol_interface(
1030 void **handle
, const efi_guid_t
*protocol
,
1031 int protocol_interface_type
, void *protocol_interface
)
1035 EFI_ENTRY("%p, %pUl, %d, %p", handle
, protocol
, protocol_interface_type
,
1036 protocol_interface
);
1038 if (!handle
|| !protocol
||
1039 protocol_interface_type
!= EFI_NATIVE_INTERFACE
) {
1040 r
= EFI_INVALID_PARAMETER
;
1044 /* Create new handle if requested. */
1046 r
= efi_create_handle(handle
);
1047 if (r
!= EFI_SUCCESS
)
1049 debug("%sEFI: new handle %p\n", indent_string(nesting_level
),
1052 debug("%sEFI: handle %p\n", indent_string(nesting_level
),
1055 /* Add new protocol */
1056 r
= efi_add_protocol(*handle
, protocol
, protocol_interface
);
1062 * efi_get_drivers() - get all drivers associated to a controller
1063 * @efiobj: handle of the controller
1064 * @protocol: protocol guid (optional)
1065 * @number_of_drivers: number of child controllers
1066 * @driver_handle_buffer: handles of the the drivers
1068 * The allocated buffer has to be freed with free().
1070 * Return: status code
1072 static efi_status_t
efi_get_drivers(struct efi_object
*efiobj
,
1073 const efi_guid_t
*protocol
,
1074 efi_uintn_t
*number_of_drivers
,
1075 efi_handle_t
**driver_handle_buffer
)
1077 struct efi_handler
*handler
;
1078 struct efi_open_protocol_info_item
*item
;
1079 efi_uintn_t count
= 0, i
;
1082 /* Count all driver associations */
1083 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
1084 if (protocol
&& guidcmp(handler
->guid
, protocol
))
1086 list_for_each_entry(item
, &handler
->open_infos
, link
) {
1087 if (item
->info
.attributes
&
1088 EFI_OPEN_PROTOCOL_BY_DRIVER
)
1093 * Create buffer. In case of duplicate driver assignments the buffer
1094 * will be too large. But that does not harm.
1096 *number_of_drivers
= 0;
1097 *driver_handle_buffer
= calloc(count
, sizeof(efi_handle_t
));
1098 if (!*driver_handle_buffer
)
1099 return EFI_OUT_OF_RESOURCES
;
1100 /* Collect unique driver handles */
1101 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
1102 if (protocol
&& guidcmp(handler
->guid
, protocol
))
1104 list_for_each_entry(item
, &handler
->open_infos
, link
) {
1105 if (item
->info
.attributes
&
1106 EFI_OPEN_PROTOCOL_BY_DRIVER
) {
1107 /* Check this is a new driver */
1109 for (i
= 0; i
< *number_of_drivers
; ++i
) {
1110 if ((*driver_handle_buffer
)[i
] ==
1111 item
->info
.agent_handle
)
1114 /* Copy handle to buffer */
1116 i
= (*number_of_drivers
)++;
1117 (*driver_handle_buffer
)[i
] =
1118 item
->info
.agent_handle
;
1127 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1128 * @efiobj: handle of the controller
1129 * @protocol: protocol guid (optional)
1130 * @child_handle: handle of the child to destroy
1132 * This function implements the DisconnectController service.
1134 * See the Unified Extensible Firmware Interface (UEFI) specification for
1137 * Return: status code
1139 static efi_status_t
efi_disconnect_all_drivers(
1140 struct efi_object
*efiobj
,
1141 const efi_guid_t
*protocol
,
1142 efi_handle_t child_handle
)
1144 efi_uintn_t number_of_drivers
;
1145 efi_handle_t
*driver_handle_buffer
;
1146 efi_status_t r
, ret
;
1148 ret
= efi_get_drivers(efiobj
, protocol
, &number_of_drivers
,
1149 &driver_handle_buffer
);
1150 if (ret
!= EFI_SUCCESS
)
1153 ret
= EFI_NOT_FOUND
;
1154 while (number_of_drivers
) {
1155 r
= EFI_CALL(efi_disconnect_controller(
1157 driver_handle_buffer
[--number_of_drivers
],
1159 if (r
== EFI_SUCCESS
)
1162 free(driver_handle_buffer
);
1167 * efi_uninstall_protocol_interface() - uninstall protocol interface
1168 * @handle: handle from which the protocol shall be removed
1169 * @protocol: GUID of the protocol to be removed
1170 * @protocol_interface: interface to be removed
1172 * This function implements the UninstallProtocolInterface service.
1174 * See the Unified Extensible Firmware Interface (UEFI) specification for
1177 * Return: status code
1179 static efi_status_t EFIAPI
efi_uninstall_protocol_interface(
1180 efi_handle_t handle
, const efi_guid_t
*protocol
,
1181 void *protocol_interface
)
1183 struct efi_object
*efiobj
;
1184 struct efi_handler
*handler
;
1185 struct efi_open_protocol_info_item
*item
;
1186 struct efi_open_protocol_info_item
*pos
;
1189 EFI_ENTRY("%p, %pUl, %p", handle
, protocol
, protocol_interface
);
1192 efiobj
= efi_search_obj(handle
);
1194 r
= EFI_INVALID_PARAMETER
;
1197 /* Find the protocol on the handle */
1198 r
= efi_search_protocol(handle
, protocol
, &handler
);
1199 if (r
!= EFI_SUCCESS
)
1201 /* Disconnect controllers */
1202 efi_disconnect_all_drivers(efiobj
, protocol
, NULL
);
1203 if (!list_empty(&handler
->open_infos
)) {
1204 r
= EFI_ACCESS_DENIED
;
1207 /* Close protocol */
1208 list_for_each_entry_safe(item
, pos
, &handler
->open_infos
, link
) {
1209 if (item
->info
.attributes
==
1210 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
||
1211 item
->info
.attributes
== EFI_OPEN_PROTOCOL_GET_PROTOCOL
||
1212 item
->info
.attributes
== EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
1213 list_del(&item
->link
);
1215 if (!list_empty(&handler
->open_infos
)) {
1216 r
= EFI_ACCESS_DENIED
;
1219 r
= efi_remove_protocol(handle
, protocol
, protocol_interface
);
1225 * efi_register_protocol_notify() - register an event for notification when a
1226 * protocol is installed.
1227 * @protocol: GUID of the protocol whose installation shall be notified
1228 * @event: event to be signaled upon installation of the protocol
1229 * @registration: key for retrieving the registration information
1231 * This function implements the RegisterProtocolNotify service.
1232 * See the Unified Extensible Firmware Interface (UEFI) specification
1235 * Return: status code
1237 static efi_status_t EFIAPI
efi_register_protocol_notify(
1238 const efi_guid_t
*protocol
,
1239 struct efi_event
*event
,
1240 void **registration
)
1242 EFI_ENTRY("%pUl, %p, %p", protocol
, event
, registration
);
1243 return EFI_EXIT(EFI_OUT_OF_RESOURCES
);
1247 * efi_search() - determine if an EFI handle implements a protocol
1248 * @search_type: selection criterion
1249 * @protocol: GUID of the protocol
1250 * @search_key: registration key
1253 * See the documentation of the LocateHandle service in the UEFI specification.
1255 * Return: 0 if the handle implements the protocol
1257 static int efi_search(enum efi_locate_search_type search_type
,
1258 const efi_guid_t
*protocol
, void *search_key
,
1259 struct efi_object
*efiobj
)
1263 switch (search_type
) {
1266 case BY_REGISTER_NOTIFY
:
1267 /* TODO: RegisterProtocolNotify is not implemented yet */
1270 ret
= efi_search_protocol(efiobj
->handle
, protocol
, NULL
);
1271 return (ret
!= EFI_SUCCESS
);
1273 /* Invalid search type */
1279 * efi_locate_handle() - locate handles implementing a protocol
1280 * @search_type: selection criterion
1281 * @protocol: GUID of the protocol
1282 * @search_key: registration key
1283 * @buffer_size: size of the buffer to receive the handles in bytes
1284 * @buffer: buffer to receive the relevant handles
1286 * This function is meant for U-Boot internal calls. For the API implementation
1287 * of the LocateHandle service see efi_locate_handle_ext.
1289 * Return: status code
1291 static efi_status_t
efi_locate_handle(
1292 enum efi_locate_search_type search_type
,
1293 const efi_guid_t
*protocol
, void *search_key
,
1294 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1296 struct efi_object
*efiobj
;
1297 efi_uintn_t size
= 0;
1299 /* Check parameters */
1300 switch (search_type
) {
1303 case BY_REGISTER_NOTIFY
:
1305 return EFI_INVALID_PARAMETER
;
1306 /* RegisterProtocolNotify is not implemented yet */
1307 return EFI_UNSUPPORTED
;
1310 return EFI_INVALID_PARAMETER
;
1313 return EFI_INVALID_PARAMETER
;
1317 * efi_locate_handle_buffer uses this function for
1318 * the calculation of the necessary buffer size.
1319 * So do not require a buffer for buffersize == 0.
1321 if (!buffer_size
|| (*buffer_size
&& !buffer
))
1322 return EFI_INVALID_PARAMETER
;
1324 /* Count how much space we need */
1325 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1326 if (!efi_search(search_type
, protocol
, search_key
, efiobj
))
1327 size
+= sizeof(void *);
1330 if (*buffer_size
< size
) {
1331 *buffer_size
= size
;
1332 return EFI_BUFFER_TOO_SMALL
;
1335 *buffer_size
= size
;
1337 return EFI_NOT_FOUND
;
1339 /* Then fill the array */
1340 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1341 if (!efi_search(search_type
, protocol
, search_key
, efiobj
))
1342 *buffer
++ = efiobj
->handle
;
1349 * efi_locate_handle_ext() - locate handles implementing a protocol.
1350 * @search_type: selection criterion
1351 * @protocol: GUID of the protocol
1352 * @search_key: registration key
1353 * @buffer_size: size of the buffer to receive the handles in bytes
1354 * @buffer: buffer to receive the relevant handles
1356 * This function implements the LocateHandle service.
1358 * See the Unified Extensible Firmware Interface (UEFI) specification for
1361 * Return: 0 if the handle implements the protocol
1363 static efi_status_t EFIAPI
efi_locate_handle_ext(
1364 enum efi_locate_search_type search_type
,
1365 const efi_guid_t
*protocol
, void *search_key
,
1366 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1368 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
1369 buffer_size
, buffer
);
1371 return EFI_EXIT(efi_locate_handle(search_type
, protocol
, search_key
,
1372 buffer_size
, buffer
));
1376 * efi_remove_configuration_table() - collapses configuration table entries,
1379 * @i: index of the table entry to be removed
1381 static void efi_remove_configuration_table(int i
)
1383 struct efi_configuration_table
*this = &systab
.tables
[i
];
1384 struct efi_configuration_table
*next
= &systab
.tables
[i
+ 1];
1385 struct efi_configuration_table
*end
= &systab
.tables
[systab
.nr_tables
];
1387 memmove(this, next
, (ulong
)end
- (ulong
)next
);
1392 * efi_install_configuration_table() - adds, updates, or removes a
1393 * configuration table
1394 * @guid: GUID of the installed table
1395 * @table: table to be installed
1397 * This function is used for internal calls. For the API implementation of the
1398 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1400 * Return: status code
1402 efi_status_t
efi_install_configuration_table(const efi_guid_t
*guid
,
1405 struct efi_event
*evt
;
1409 return EFI_INVALID_PARAMETER
;
1411 /* Check for guid override */
1412 for (i
= 0; i
< systab
.nr_tables
; i
++) {
1413 if (!guidcmp(guid
, &systab
.tables
[i
].guid
)) {
1415 systab
.tables
[i
].table
= table
;
1417 efi_remove_configuration_table(i
);
1423 return EFI_NOT_FOUND
;
1425 /* No override, check for overflow */
1426 if (i
>= EFI_MAX_CONFIGURATION_TABLES
)
1427 return EFI_OUT_OF_RESOURCES
;
1429 /* Add a new entry */
1430 memcpy(&systab
.tables
[i
].guid
, guid
, sizeof(*guid
));
1431 systab
.tables
[i
].table
= table
;
1432 systab
.nr_tables
= i
+ 1;
1435 /* systab.nr_tables may have changed. So we need to update the crc32 */
1436 efi_update_table_header_crc32(&systab
.hdr
);
1438 /* Notify that the configuration table was changed */
1439 list_for_each_entry(evt
, &efi_events
, link
) {
1440 if (evt
->group
&& !guidcmp(evt
->group
, guid
)) {
1441 efi_signal_event(evt
, false);
1450 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1451 * configuration table.
1452 * @guid: GUID of the installed table
1453 * @table: table to be installed
1455 * This function implements the InstallConfigurationTable service.
1457 * See the Unified Extensible Firmware Interface (UEFI) specification for
1460 * Return: status code
1462 static efi_status_t EFIAPI
efi_install_configuration_table_ext(efi_guid_t
*guid
,
1465 EFI_ENTRY("%pUl, %p", guid
, table
);
1466 return EFI_EXIT(efi_install_configuration_table(guid
, table
));
1470 * efi_setup_loaded_image() - initialize a loaded image
1471 * @info: loaded image info to be passed to the entry point of the image
1472 * @obj: internal object associated with the loaded image
1473 * @device_path: device path of the loaded image
1474 * @file_path: file path of the loaded image
1476 * Initialize a loaded_image_info and loaded_image_info object with correct
1477 * protocols, boot-device, etc.
1479 * Return: status code
1481 efi_status_t
efi_setup_loaded_image(
1482 struct efi_loaded_image
*info
, struct efi_object
*obj
,
1483 struct efi_device_path
*device_path
,
1484 struct efi_device_path
*file_path
)
1488 /* Add internal object to object list */
1489 efi_add_handle(obj
);
1490 /* efi_exit() assumes that the handle points to the info */
1493 info
->revision
= EFI_LOADED_IMAGE_PROTOCOL_REVISION
;
1494 info
->file_path
= file_path
;
1497 info
->device_handle
= efi_dp_find_obj(device_path
, NULL
);
1499 * When asking for the device path interface, return
1500 * bootefi_device_path
1502 ret
= efi_add_protocol(obj
->handle
, &efi_guid_device_path
,
1504 if (ret
!= EFI_SUCCESS
)
1509 * When asking for the loaded_image interface, just
1510 * return handle which points to loaded_image_info
1512 ret
= efi_add_protocol(obj
->handle
, &efi_guid_loaded_image
, info
);
1513 if (ret
!= EFI_SUCCESS
)
1516 ret
= efi_add_protocol(obj
->handle
,
1517 &efi_guid_device_path_to_text_protocol
,
1518 (void *)&efi_device_path_to_text
);
1519 if (ret
!= EFI_SUCCESS
)
1522 ret
= efi_add_protocol(obj
->handle
,
1523 &efi_guid_device_path_utilities_protocol
,
1524 (void *)&efi_device_path_utilities
);
1525 if (ret
!= EFI_SUCCESS
)
1530 printf("ERROR: Failure to install protocols for loaded image\n");
1535 * efi_load_image_from_path() - load an image using a file path
1536 * @file_path: the path of the image to load
1537 * @buffer: buffer containing the loaded image
1539 * Return: status code
1541 efi_status_t
efi_load_image_from_path(struct efi_device_path
*file_path
,
1544 struct efi_file_info
*info
= NULL
;
1545 struct efi_file_handle
*f
;
1546 static efi_status_t ret
;
1549 f
= efi_file_from_path(file_path
);
1551 return EFI_DEVICE_ERROR
;
1554 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1556 if (ret
== EFI_BUFFER_TOO_SMALL
) {
1558 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1561 if (ret
!= EFI_SUCCESS
)
1564 ret
= efi_allocate_pool(EFI_LOADER_DATA
, info
->file_size
, buffer
);
1568 bs
= info
->file_size
;
1569 EFI_CALL(ret
= f
->read(f
, &bs
, *buffer
));
1573 EFI_CALL(f
->close(f
));
1575 if (ret
!= EFI_SUCCESS
) {
1576 efi_free_pool(*buffer
);
1584 * efi_load_image() - load an EFI image into memory
1585 * @boot_policy: true for request originating from the boot manager
1586 * @parent_image: the caller's image handle
1587 * @file_path: the path of the image to load
1588 * @source_buffer: memory location from which the image is installed
1589 * @source_size: size of the memory area from which the image is installed
1590 * @image_handle: handle for the newly installed image
1592 * This function implements the LoadImage service.
1594 * See the Unified Extensible Firmware Interface (UEFI) specification
1597 * Return: status code
1599 static efi_status_t EFIAPI
efi_load_image(bool boot_policy
,
1600 efi_handle_t parent_image
,
1601 struct efi_device_path
*file_path
,
1602 void *source_buffer
,
1603 efi_uintn_t source_size
,
1604 efi_handle_t
*image_handle
)
1606 struct efi_loaded_image
*info
;
1607 struct efi_object
*obj
;
1610 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy
, parent_image
,
1611 file_path
, source_buffer
, source_size
, image_handle
);
1613 if (!image_handle
|| !parent_image
) {
1614 ret
= EFI_INVALID_PARAMETER
;
1618 if (!source_buffer
&& !file_path
) {
1619 ret
= EFI_NOT_FOUND
;
1623 info
= calloc(1, sizeof(*info
));
1625 ret
= EFI_OUT_OF_RESOURCES
;
1628 obj
= calloc(1, sizeof(*obj
));
1631 ret
= EFI_OUT_OF_RESOURCES
;
1635 if (!source_buffer
) {
1636 struct efi_device_path
*dp
, *fp
;
1638 ret
= efi_load_image_from_path(file_path
, &source_buffer
);
1639 if (ret
!= EFI_SUCCESS
)
1642 * split file_path which contains both the device and
1645 efi_dp_split_file_path(file_path
, &dp
, &fp
);
1646 ret
= efi_setup_loaded_image(info
, obj
, dp
, fp
);
1647 if (ret
!= EFI_SUCCESS
)
1650 /* In this case, file_path is the "device" path, ie.
1651 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1653 ret
= efi_setup_loaded_image(info
, obj
, file_path
, NULL
);
1654 if (ret
!= EFI_SUCCESS
)
1657 info
->reserved
= efi_load_pe(source_buffer
, info
);
1658 if (!info
->reserved
) {
1659 ret
= EFI_UNSUPPORTED
;
1662 info
->system_table
= &systab
;
1663 info
->parent_handle
= parent_image
;
1664 *image_handle
= obj
->handle
;
1665 return EFI_EXIT(EFI_SUCCESS
);
1668 efi_delete_handle(obj
);
1670 return EFI_EXIT(ret
);
1674 * efi_start_image() - dall the entry point of an image
1675 * @image_handle: handle of the image
1676 * @exit_data_size: size of the buffer
1677 * @exit_data: buffer to receive the exit data of the called image
1679 * This function implements the StartImage service.
1681 * See the Unified Extensible Firmware Interface (UEFI) specification for
1684 * Return: status code
1686 static efi_status_t EFIAPI
efi_start_image(efi_handle_t image_handle
,
1687 unsigned long *exit_data_size
,
1690 EFIAPI
efi_status_t (*entry
)(efi_handle_t image_handle
,
1691 struct efi_system_table
*st
);
1692 struct efi_loaded_image
*info
= image_handle
;
1695 EFI_ENTRY("%p, %p, %p", image_handle
, exit_data_size
, exit_data
);
1696 entry
= info
->reserved
;
1698 efi_is_direct_boot
= false;
1700 /* call the image! */
1701 if (setjmp(&info
->exit_jmp
)) {
1703 * We called the entry point of the child image with EFI_CALL
1704 * in the lines below. The child image called the Exit() boot
1705 * service efi_exit() which executed the long jump that brought
1706 * us to the current line. This implies that the second half
1707 * of the EFI_CALL macro has not been executed.
1711 * efi_exit() called efi_restore_gd(). We have to undo this
1712 * otherwise __efi_entry_check() will put the wrong value into
1718 * To get ready to call EFI_EXIT below we have to execute the
1719 * missed out steps of EFI_CALL.
1721 assert(__efi_entry_check());
1722 debug("%sEFI: %lu returned by started image\n",
1723 __efi_nesting_dec(),
1724 (unsigned long)((uintptr_t)info
->exit_status
&
1726 return EFI_EXIT(info
->exit_status
);
1729 ret
= EFI_CALL(entry(image_handle
, &systab
));
1732 * Usually UEFI applications call Exit() instead of returning.
1733 * But because the world doesn not consist of ponies and unicorns,
1734 * we're happy to emulate that behavior on behalf of a payload
1737 return EFI_CALL(systab
.boottime
->exit(image_handle
, ret
, 0, NULL
));
1741 * efi_exit() - leave an EFI application or driver
1742 * @image_handle: handle of the application or driver that is exiting
1743 * @exit_status: status code
1744 * @exit_data_size: size of the buffer in bytes
1745 * @exit_data: buffer with data describing an error
1747 * This function implements the Exit service.
1749 * See the Unified Extensible Firmware Interface (UEFI) specification for
1752 * Return: status code
1754 static efi_status_t EFIAPI
efi_exit(efi_handle_t image_handle
,
1755 efi_status_t exit_status
,
1756 unsigned long exit_data_size
,
1760 * We require that the handle points to the original loaded
1761 * image protocol interface.
1763 * For getting the longjmp address this is safer than locating
1764 * the protocol because the protocol may have been reinstalled
1765 * pointing to another memory location.
1767 * TODO: We should call the unload procedure of the loaded
1770 struct efi_loaded_image
*loaded_image_info
= (void *)image_handle
;
1772 EFI_ENTRY("%p, %ld, %ld, %p", image_handle
, exit_status
,
1773 exit_data_size
, exit_data
);
1775 /* Make sure entry/exit counts for EFI world cross-overs match */
1776 EFI_EXIT(exit_status
);
1779 * But longjmp out with the U-Boot gd, not the application's, as
1780 * the other end is a setjmp call inside EFI context.
1784 loaded_image_info
->exit_status
= exit_status
;
1785 longjmp(&loaded_image_info
->exit_jmp
, 1);
1787 panic("EFI application exited");
1791 * efi_unload_image() - unload an EFI image
1792 * @image_handle: handle of the image to be unloaded
1794 * This function implements the UnloadImage service.
1796 * See the Unified Extensible Firmware Interface (UEFI) specification for
1799 * Return: status code
1801 static efi_status_t EFIAPI
efi_unload_image(efi_handle_t image_handle
)
1803 struct efi_object
*efiobj
;
1805 EFI_ENTRY("%p", image_handle
);
1806 efiobj
= efi_search_obj(image_handle
);
1808 list_del(&efiobj
->link
);
1810 return EFI_EXIT(EFI_SUCCESS
);
1814 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1816 static void efi_exit_caches(void)
1818 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1820 * Grub on 32bit ARM needs to have caches disabled before jumping into
1821 * a zImage, but does not know of all cache layers. Give it a hand.
1823 if (efi_is_direct_boot
)
1824 cleanup_before_linux();
1829 * efi_exit_boot_services() - stop all boot services
1830 * @image_handle: handle of the loaded image
1831 * @map_key: key of the memory map
1833 * This function implements the ExitBootServices service.
1835 * See the Unified Extensible Firmware Interface (UEFI) specification
1838 * All timer events are disabled. For exit boot services events the
1839 * notification function is called. The boot services are disabled in the
1842 * Return: status code
1844 static efi_status_t EFIAPI
efi_exit_boot_services(efi_handle_t image_handle
,
1845 unsigned long map_key
)
1847 struct efi_event
*evt
;
1849 EFI_ENTRY("%p, %ld", image_handle
, map_key
);
1851 /* Check that the caller has read the current memory map */
1852 if (map_key
!= efi_memory_map_key
)
1853 return EFI_INVALID_PARAMETER
;
1855 /* Make sure that notification functions are not called anymore */
1856 efi_tpl
= TPL_HIGH_LEVEL
;
1858 /* Check if ExitBootServices has already been called */
1859 if (!systab
.boottime
)
1860 return EFI_EXIT(EFI_SUCCESS
);
1862 /* Add related events to the event group */
1863 list_for_each_entry(evt
, &efi_events
, link
) {
1864 if (evt
->type
== EVT_SIGNAL_EXIT_BOOT_SERVICES
)
1865 evt
->group
= &efi_guid_event_group_exit_boot_services
;
1867 /* Notify that ExitBootServices is invoked. */
1868 list_for_each_entry(evt
, &efi_events
, link
) {
1870 !guidcmp(evt
->group
,
1871 &efi_guid_event_group_exit_boot_services
)) {
1872 efi_signal_event(evt
, false);
1877 /* TODO Should persist EFI variables here */
1879 board_quiesce_devices();
1881 /* Fix up caches for EFI payloads if necessary */
1884 /* This stops all lingering devices */
1885 bootm_disable_interrupts();
1887 /* Disable boottime services */
1888 systab
.con_in_handle
= NULL
;
1889 systab
.con_in
= NULL
;
1890 systab
.con_out_handle
= NULL
;
1891 systab
.con_out
= NULL
;
1892 systab
.stderr_handle
= NULL
;
1893 systab
.std_err
= NULL
;
1894 systab
.boottime
= NULL
;
1896 /* Recalculate CRC32 */
1897 efi_update_table_header_crc32(&systab
.hdr
);
1899 /* Give the payload some time to boot */
1900 efi_set_watchdog(0);
1903 return EFI_EXIT(EFI_SUCCESS
);
1907 * efi_get_next_monotonic_count() - get next value of the counter
1908 * @count: returned value of the counter
1910 * This function implements the NextMonotonicCount service.
1912 * See the Unified Extensible Firmware Interface (UEFI) specification for
1915 * Return: status code
1917 static efi_status_t EFIAPI
efi_get_next_monotonic_count(uint64_t *count
)
1919 static uint64_t mono
;
1921 EFI_ENTRY("%p", count
);
1923 return EFI_EXIT(EFI_SUCCESS
);
1927 * efi_stall() - sleep
1928 * @microseconds: period to sleep in microseconds
1930 * This function implements the Stall service.
1932 * See the Unified Extensible Firmware Interface (UEFI) specification for
1935 * Return: status code
1937 static efi_status_t EFIAPI
efi_stall(unsigned long microseconds
)
1939 EFI_ENTRY("%ld", microseconds
);
1940 udelay(microseconds
);
1941 return EFI_EXIT(EFI_SUCCESS
);
1945 * efi_set_watchdog_timer() - reset the watchdog timer
1946 * @timeout: seconds before reset by watchdog
1947 * @watchdog_code: code to be logged when resetting
1948 * @data_size: size of buffer in bytes
1949 * @watchdog_data: buffer with data describing the reset reason
1951 * This function implements the SetWatchdogTimer service.
1953 * See the Unified Extensible Firmware Interface (UEFI) specification for
1956 * Return: status code
1958 static efi_status_t EFIAPI
efi_set_watchdog_timer(unsigned long timeout
,
1959 uint64_t watchdog_code
,
1960 unsigned long data_size
,
1961 uint16_t *watchdog_data
)
1963 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout
, watchdog_code
,
1964 data_size
, watchdog_data
);
1965 return EFI_EXIT(efi_set_watchdog(timeout
));
1969 * efi_close_protocol() - close a protocol
1970 * @handle: handle on which the protocol shall be closed
1971 * @protocol: GUID of the protocol to close
1972 * @agent_handle: handle of the driver
1973 * @controller_handle: handle of the controller
1975 * This function implements the CloseProtocol service.
1977 * See the Unified Extensible Firmware Interface (UEFI) specification for
1980 * Return: status code
1982 static efi_status_t EFIAPI
efi_close_protocol(efi_handle_t handle
,
1983 const efi_guid_t
*protocol
,
1984 efi_handle_t agent_handle
,
1985 efi_handle_t controller_handle
)
1987 struct efi_handler
*handler
;
1988 struct efi_open_protocol_info_item
*item
;
1989 struct efi_open_protocol_info_item
*pos
;
1992 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, agent_handle
,
1995 if (!agent_handle
) {
1996 r
= EFI_INVALID_PARAMETER
;
1999 r
= efi_search_protocol(handle
, protocol
, &handler
);
2000 if (r
!= EFI_SUCCESS
)
2004 list_for_each_entry_safe(item
, pos
, &handler
->open_infos
, link
) {
2005 if (item
->info
.agent_handle
== agent_handle
&&
2006 item
->info
.controller_handle
== controller_handle
) {
2007 efi_delete_open_info(item
);
2017 * efi_open_protocol_information() - provide information about then open status
2018 * of a protocol on a handle
2019 * @handle: handle for which the information shall be retrieved
2020 * @protocol: GUID of the protocol
2021 * @entry_buffer: buffer to receive the open protocol information
2022 * @entry_count: number of entries available in the buffer
2024 * This function implements the OpenProtocolInformation service.
2026 * See the Unified Extensible Firmware Interface (UEFI) specification for
2029 * Return: status code
2031 static efi_status_t EFIAPI
efi_open_protocol_information(
2032 efi_handle_t handle
, const efi_guid_t
*protocol
,
2033 struct efi_open_protocol_info_entry
**entry_buffer
,
2034 efi_uintn_t
*entry_count
)
2036 unsigned long buffer_size
;
2037 unsigned long count
;
2038 struct efi_handler
*handler
;
2039 struct efi_open_protocol_info_item
*item
;
2042 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, entry_buffer
,
2045 /* Check parameters */
2046 if (!entry_buffer
) {
2047 r
= EFI_INVALID_PARAMETER
;
2050 r
= efi_search_protocol(handle
, protocol
, &handler
);
2051 if (r
!= EFI_SUCCESS
)
2056 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2057 if (item
->info
.open_count
)
2060 *entry_count
= count
;
2061 *entry_buffer
= NULL
;
2068 buffer_size
= count
* sizeof(struct efi_open_protocol_info_entry
);
2069 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
2070 (void **)entry_buffer
);
2071 if (r
!= EFI_SUCCESS
)
2073 list_for_each_entry_reverse(item
, &handler
->open_infos
, link
) {
2074 if (item
->info
.open_count
)
2075 (*entry_buffer
)[--count
] = item
->info
;
2082 * efi_protocols_per_handle() - get protocols installed on a handle
2083 * @handle: handle for which the information is retrieved
2084 * @protocol_buffer: buffer with protocol GUIDs
2085 * @protocol_buffer_count: number of entries in the buffer
2087 * This function implements the ProtocolsPerHandleService.
2089 * See the Unified Extensible Firmware Interface (UEFI) specification for
2092 * Return: status code
2094 static efi_status_t EFIAPI
efi_protocols_per_handle(
2095 efi_handle_t handle
, efi_guid_t
***protocol_buffer
,
2096 efi_uintn_t
*protocol_buffer_count
)
2098 unsigned long buffer_size
;
2099 struct efi_object
*efiobj
;
2100 struct list_head
*protocol_handle
;
2103 EFI_ENTRY("%p, %p, %p", handle
, protocol_buffer
,
2104 protocol_buffer_count
);
2106 if (!handle
|| !protocol_buffer
|| !protocol_buffer_count
)
2107 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2109 *protocol_buffer
= NULL
;
2110 *protocol_buffer_count
= 0;
2112 efiobj
= efi_search_obj(handle
);
2114 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2116 /* Count protocols */
2117 list_for_each(protocol_handle
, &efiobj
->protocols
) {
2118 ++*protocol_buffer_count
;
2122 if (*protocol_buffer_count
) {
2125 buffer_size
= sizeof(efi_guid_t
*) * *protocol_buffer_count
;
2126 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
2127 (void **)protocol_buffer
);
2128 if (r
!= EFI_SUCCESS
)
2130 list_for_each(protocol_handle
, &efiobj
->protocols
) {
2131 struct efi_handler
*protocol
;
2133 protocol
= list_entry(protocol_handle
,
2134 struct efi_handler
, link
);
2135 (*protocol_buffer
)[j
] = (void *)protocol
->guid
;
2140 return EFI_EXIT(EFI_SUCCESS
);
2144 * efi_locate_handle_buffer() - locate handles implementing a protocol
2145 * @search_type: selection criterion
2146 * @protocol: GUID of the protocol
2147 * @search_key: registration key
2148 * @no_handles: number of returned handles
2149 * @buffer: buffer with the returned handles
2151 * This function implements the LocateHandleBuffer service.
2153 * See the Unified Extensible Firmware Interface (UEFI) specification for
2156 * Return: status code
2158 static efi_status_t EFIAPI
efi_locate_handle_buffer(
2159 enum efi_locate_search_type search_type
,
2160 const efi_guid_t
*protocol
, void *search_key
,
2161 efi_uintn_t
*no_handles
, efi_handle_t
**buffer
)
2164 efi_uintn_t buffer_size
= 0;
2166 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
2167 no_handles
, buffer
);
2169 if (!no_handles
|| !buffer
) {
2170 r
= EFI_INVALID_PARAMETER
;
2175 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
2177 if (r
!= EFI_BUFFER_TOO_SMALL
)
2179 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
2181 if (r
!= EFI_SUCCESS
)
2183 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
2185 if (r
== EFI_SUCCESS
)
2186 *no_handles
= buffer_size
/ sizeof(efi_handle_t
);
2192 * efi_locate_protocol() - find an interface implementing a protocol
2193 * @protocol: GUID of the protocol
2194 * @registration: registration key passed to the notification function
2195 * @protocol_interface: interface implementing the protocol
2197 * This function implements the LocateProtocol service.
2199 * See the Unified Extensible Firmware Interface (UEFI) specification for
2202 * Return: status code
2204 static efi_status_t EFIAPI
efi_locate_protocol(const efi_guid_t
*protocol
,
2206 void **protocol_interface
)
2208 struct list_head
*lhandle
;
2211 EFI_ENTRY("%pUl, %p, %p", protocol
, registration
, protocol_interface
);
2213 if (!protocol
|| !protocol_interface
)
2214 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2216 list_for_each(lhandle
, &efi_obj_list
) {
2217 struct efi_object
*efiobj
;
2218 struct efi_handler
*handler
;
2220 efiobj
= list_entry(lhandle
, struct efi_object
, link
);
2222 ret
= efi_search_protocol(efiobj
->handle
, protocol
, &handler
);
2223 if (ret
== EFI_SUCCESS
) {
2224 *protocol_interface
= handler
->protocol_interface
;
2225 return EFI_EXIT(EFI_SUCCESS
);
2228 *protocol_interface
= NULL
;
2230 return EFI_EXIT(EFI_NOT_FOUND
);
2234 * efi_locate_device_path() - Get the device path and handle of an device
2235 * implementing a protocol
2236 * @protocol: GUID of the protocol
2237 * @device_path: device path
2238 * @device: handle of the device
2240 * This function implements the LocateDevicePath service.
2242 * See the Unified Extensible Firmware Interface (UEFI) specification for
2245 * Return: status code
2247 static efi_status_t EFIAPI
efi_locate_device_path(
2248 const efi_guid_t
*protocol
,
2249 struct efi_device_path
**device_path
,
2250 efi_handle_t
*device
)
2252 struct efi_device_path
*dp
;
2254 struct efi_handler
*handler
;
2255 efi_handle_t
*handles
;
2257 size_t len_best
= 0;
2258 efi_uintn_t no_handles
;
2262 EFI_ENTRY("%pUl, %p, %p", protocol
, device_path
, device
);
2264 if (!protocol
|| !device_path
|| !*device_path
|| !device
) {
2265 ret
= EFI_INVALID_PARAMETER
;
2269 /* Find end of device path */
2270 len
= efi_dp_instance_size(*device_path
);
2272 /* Get all handles implementing the protocol */
2273 ret
= EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL
, protocol
, NULL
,
2274 &no_handles
, &handles
));
2275 if (ret
!= EFI_SUCCESS
)
2278 for (i
= 0; i
< no_handles
; ++i
) {
2279 /* Find the device path protocol */
2280 ret
= efi_search_protocol(handles
[i
], &efi_guid_device_path
,
2282 if (ret
!= EFI_SUCCESS
)
2284 dp
= (struct efi_device_path
*)handler
->protocol_interface
;
2285 len_dp
= efi_dp_instance_size(dp
);
2287 * This handle can only be a better fit
2288 * if its device path length is longer than the best fit and
2289 * if its device path length is shorter of equal the searched
2292 if (len_dp
<= len_best
|| len_dp
> len
)
2294 /* Check if dp is a subpath of device_path */
2295 if (memcmp(*device_path
, dp
, len_dp
))
2297 *device
= handles
[i
];
2301 remainder
= (u8
*)*device_path
+ len_best
;
2302 *device_path
= (struct efi_device_path
*)remainder
;
2305 ret
= EFI_NOT_FOUND
;
2308 return EFI_EXIT(ret
);
2312 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2314 * @handle: handle on which the protocol interfaces shall be installed
2315 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2318 * This function implements the MultipleProtocolInterfaces service.
2320 * See the Unified Extensible Firmware Interface (UEFI) specification for
2323 * Return: status code
2325 static efi_status_t EFIAPI
efi_install_multiple_protocol_interfaces(
2328 EFI_ENTRY("%p", handle
);
2331 const efi_guid_t
*protocol
;
2332 void *protocol_interface
;
2333 efi_status_t r
= EFI_SUCCESS
;
2337 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2339 efi_va_start(argptr
, handle
);
2341 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2344 protocol_interface
= efi_va_arg(argptr
, void*);
2345 r
= EFI_CALL(efi_install_protocol_interface(
2347 EFI_NATIVE_INTERFACE
,
2348 protocol_interface
));
2349 if (r
!= EFI_SUCCESS
)
2354 if (r
== EFI_SUCCESS
)
2357 /* If an error occurred undo all changes. */
2358 efi_va_start(argptr
, handle
);
2360 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2361 protocol_interface
= efi_va_arg(argptr
, void*);
2362 EFI_CALL(efi_uninstall_protocol_interface(handle
, protocol
,
2363 protocol_interface
));
2371 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2373 * @handle: handle from which the protocol interfaces shall be removed
2374 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2377 * This function implements the UninstallMultipleProtocolInterfaces service.
2379 * See the Unified Extensible Firmware Interface (UEFI) specification for
2382 * Return: status code
2384 static efi_status_t EFIAPI
efi_uninstall_multiple_protocol_interfaces(
2387 EFI_ENTRY("%p", handle
);
2390 const efi_guid_t
*protocol
;
2391 void *protocol_interface
;
2392 efi_status_t r
= EFI_SUCCESS
;
2396 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2398 efi_va_start(argptr
, handle
);
2400 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2403 protocol_interface
= efi_va_arg(argptr
, void*);
2404 r
= EFI_CALL(efi_uninstall_protocol_interface(
2406 protocol_interface
));
2407 if (r
!= EFI_SUCCESS
)
2412 if (r
== EFI_SUCCESS
)
2415 /* If an error occurred undo all changes. */
2416 efi_va_start(argptr
, handle
);
2418 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2419 protocol_interface
= efi_va_arg(argptr
, void*);
2420 EFI_CALL(efi_install_protocol_interface(&handle
, protocol
,
2421 EFI_NATIVE_INTERFACE
,
2422 protocol_interface
));
2430 * efi_calculate_crc32() - calculate cyclic redundancy code
2431 * @data: buffer with data
2432 * @data_size: size of buffer in bytes
2433 * @crc32_p: cyclic redundancy code
2435 * This function implements the CalculateCrc32 service.
2437 * See the Unified Extensible Firmware Interface (UEFI) specification for
2440 * Return: status code
2442 static efi_status_t EFIAPI
efi_calculate_crc32(const void *data
,
2443 efi_uintn_t data_size
,
2446 EFI_ENTRY("%p, %zu", data
, data_size
);
2447 *crc32_p
= crc32(0, data
, data_size
);
2448 return EFI_EXIT(EFI_SUCCESS
);
2452 * efi_copy_mem() - copy memory
2453 * @destination: destination of the copy operation
2454 * @source: source of the copy operation
2455 * @length: number of bytes to copy
2457 * This function implements the CopyMem service.
2459 * See the Unified Extensible Firmware Interface (UEFI) specification for
2462 static void EFIAPI
efi_copy_mem(void *destination
, const void *source
,
2465 EFI_ENTRY("%p, %p, %ld", destination
, source
, (unsigned long)length
);
2466 memcpy(destination
, source
, length
);
2467 EFI_EXIT(EFI_SUCCESS
);
2471 * efi_set_mem() - Fill memory with a byte value.
2472 * @buffer: buffer to fill
2473 * @size: size of buffer in bytes
2474 * @value: byte to copy to the buffer
2476 * This function implements the SetMem service.
2478 * See the Unified Extensible Firmware Interface (UEFI) specification for
2481 static void EFIAPI
efi_set_mem(void *buffer
, size_t size
, uint8_t value
)
2483 EFI_ENTRY("%p, %ld, 0x%x", buffer
, (unsigned long)size
, value
);
2484 memset(buffer
, value
, size
);
2485 EFI_EXIT(EFI_SUCCESS
);
2489 * efi_protocol_open() - open protocol interface on a handle
2490 * @handler: handler of a protocol
2491 * @protocol_interface: interface implementing the protocol
2492 * @agent_handle: handle of the driver
2493 * @controller_handle: handle of the controller
2494 * @attributes: attributes indicating how to open the protocol
2496 * Return: status code
2498 static efi_status_t
efi_protocol_open(
2499 struct efi_handler
*handler
,
2500 void **protocol_interface
, void *agent_handle
,
2501 void *controller_handle
, uint32_t attributes
)
2503 struct efi_open_protocol_info_item
*item
;
2504 struct efi_open_protocol_info_entry
*match
= NULL
;
2505 bool opened_by_driver
= false;
2506 bool opened_exclusive
= false;
2508 /* If there is no agent, only return the interface */
2512 /* For TEST_PROTOCOL ignore interface attribute */
2513 if (attributes
!= EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
2514 *protocol_interface
= NULL
;
2517 * Check if the protocol is already opened by a driver with the same
2518 * attributes or opened exclusively
2520 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2521 if (item
->info
.agent_handle
== agent_handle
) {
2522 if ((attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) &&
2523 (item
->info
.attributes
== attributes
))
2524 return EFI_ALREADY_STARTED
;
2526 if (item
->info
.attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
)
2527 opened_exclusive
= true;
2530 /* Only one controller can open the protocol exclusively */
2531 if (opened_exclusive
&& attributes
&
2532 (EFI_OPEN_PROTOCOL_EXCLUSIVE
| EFI_OPEN_PROTOCOL_BY_DRIVER
))
2533 return EFI_ACCESS_DENIED
;
2535 /* Prepare exclusive opening */
2536 if (attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
) {
2537 /* Try to disconnect controllers */
2538 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2539 if (item
->info
.attributes
==
2540 EFI_OPEN_PROTOCOL_BY_DRIVER
)
2541 EFI_CALL(efi_disconnect_controller(
2542 item
->info
.controller_handle
,
2543 item
->info
.agent_handle
,
2546 opened_by_driver
= false;
2547 /* Check if all controllers are disconnected */
2548 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2549 if (item
->info
.attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
)
2550 opened_by_driver
= true;
2552 /* Only one controller can be conncected */
2553 if (opened_by_driver
)
2554 return EFI_ACCESS_DENIED
;
2557 /* Find existing entry */
2558 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2559 if (item
->info
.agent_handle
== agent_handle
&&
2560 item
->info
.controller_handle
== controller_handle
)
2561 match
= &item
->info
;
2563 /* None found, create one */
2565 match
= efi_create_open_info(handler
);
2567 return EFI_OUT_OF_RESOURCES
;
2570 match
->agent_handle
= agent_handle
;
2571 match
->controller_handle
= controller_handle
;
2572 match
->attributes
= attributes
;
2573 match
->open_count
++;
2576 /* For TEST_PROTOCOL ignore interface attribute. */
2577 if (attributes
!= EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
2578 *protocol_interface
= handler
->protocol_interface
;
2584 * efi_open_protocol() - open protocol interface on a handle
2585 * @handle: handle on which the protocol shall be opened
2586 * @protocol: GUID of the protocol
2587 * @protocol_interface: interface implementing the protocol
2588 * @agent_handle: handle of the driver
2589 * @controller_handle: handle of the controller
2590 * @attributes: attributes indicating how to open the protocol
2592 * This function implements the OpenProtocol interface.
2594 * See the Unified Extensible Firmware Interface (UEFI) specification for
2597 * Return: status code
2599 static efi_status_t EFIAPI
efi_open_protocol(
2600 void *handle
, const efi_guid_t
*protocol
,
2601 void **protocol_interface
, void *agent_handle
,
2602 void *controller_handle
, uint32_t attributes
)
2604 struct efi_handler
*handler
;
2605 efi_status_t r
= EFI_INVALID_PARAMETER
;
2607 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle
, protocol
,
2608 protocol_interface
, agent_handle
, controller_handle
,
2611 if (!handle
|| !protocol
||
2612 (!protocol_interface
&& attributes
!=
2613 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)) {
2617 switch (attributes
) {
2618 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
:
2619 case EFI_OPEN_PROTOCOL_GET_PROTOCOL
:
2620 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL
:
2622 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
:
2623 if (controller_handle
== handle
)
2626 case EFI_OPEN_PROTOCOL_BY_DRIVER
:
2627 case EFI_OPEN_PROTOCOL_BY_DRIVER
| EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2628 /* Check that the controller handle is valid */
2629 if (!efi_search_obj(controller_handle
))
2632 case EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2633 /* Check that the agent handle is valid */
2634 if (!efi_search_obj(agent_handle
))
2641 r
= efi_search_protocol(handle
, protocol
, &handler
);
2642 if (r
!= EFI_SUCCESS
)
2645 r
= efi_protocol_open(handler
, protocol_interface
, agent_handle
,
2646 controller_handle
, attributes
);
2652 * efi_handle_protocol() - get interface of a protocol on a handle
2653 * @handle: handle on which the protocol shall be opened
2654 * @protocol: GUID of the protocol
2655 * @protocol_interface: interface implementing the protocol
2657 * This function implements the HandleProtocol service.
2659 * See the Unified Extensible Firmware Interface (UEFI) specification for
2662 * Return: status code
2664 static efi_status_t EFIAPI
efi_handle_protocol(efi_handle_t handle
,
2665 const efi_guid_t
*protocol
,
2666 void **protocol_interface
)
2668 return efi_open_protocol(handle
, protocol
, protocol_interface
, NULL
,
2669 NULL
, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
);
2673 * efi_bind_controller() - bind a single driver to a controller
2674 * @controller_handle: controller handle
2675 * @driver_image_handle: driver handle
2676 * @remain_device_path: remaining path
2678 * Return: status code
2680 static efi_status_t
efi_bind_controller(
2681 efi_handle_t controller_handle
,
2682 efi_handle_t driver_image_handle
,
2683 struct efi_device_path
*remain_device_path
)
2685 struct efi_driver_binding_protocol
*binding_protocol
;
2688 r
= EFI_CALL(efi_open_protocol(driver_image_handle
,
2689 &efi_guid_driver_binding_protocol
,
2690 (void **)&binding_protocol
,
2691 driver_image_handle
, NULL
,
2692 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
2693 if (r
!= EFI_SUCCESS
)
2695 r
= EFI_CALL(binding_protocol
->supported(binding_protocol
,
2697 remain_device_path
));
2698 if (r
== EFI_SUCCESS
)
2699 r
= EFI_CALL(binding_protocol
->start(binding_protocol
,
2701 remain_device_path
));
2702 EFI_CALL(efi_close_protocol(driver_image_handle
,
2703 &efi_guid_driver_binding_protocol
,
2704 driver_image_handle
, NULL
));
2709 * efi_connect_single_controller() - connect a single driver to a controller
2710 * @controller_handle: controller
2711 * @driver_image_handle: driver
2712 * @remain_device_path: remainting path
2714 * Return: status code
2716 static efi_status_t
efi_connect_single_controller(
2717 efi_handle_t controller_handle
,
2718 efi_handle_t
*driver_image_handle
,
2719 struct efi_device_path
*remain_device_path
)
2721 efi_handle_t
*buffer
;
2725 size_t connected
= 0;
2727 /* Get buffer with all handles with driver binding protocol */
2728 r
= EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL
,
2729 &efi_guid_driver_binding_protocol
,
2730 NULL
, &count
, &buffer
));
2731 if (r
!= EFI_SUCCESS
)
2734 /* Context Override */
2735 if (driver_image_handle
) {
2736 for (; *driver_image_handle
; ++driver_image_handle
) {
2737 for (i
= 0; i
< count
; ++i
) {
2738 if (buffer
[i
] == *driver_image_handle
) {
2740 r
= efi_bind_controller(
2742 *driver_image_handle
,
2743 remain_device_path
);
2745 * For drivers that do not support the
2746 * controller or are already connected
2747 * we receive an error code here.
2749 if (r
== EFI_SUCCESS
)
2757 * TODO: Some overrides are not yet implemented:
2758 * - Platform Driver Override
2759 * - Driver Family Override Search
2760 * - Bus Specific Driver Override
2763 /* Driver Binding Search */
2764 for (i
= 0; i
< count
; ++i
) {
2766 r
= efi_bind_controller(controller_handle
,
2768 remain_device_path
);
2769 if (r
== EFI_SUCCESS
)
2774 efi_free_pool(buffer
);
2776 return EFI_NOT_FOUND
;
2781 * efi_connect_controller() - connect a controller to a driver
2782 * @controller_handle: handle of the controller
2783 * @driver_image_handle: handle of the driver
2784 * @remain_device_path: device path of a child controller
2785 * @recursive: true to connect all child controllers
2787 * This function implements the ConnectController service.
2789 * See the Unified Extensible Firmware Interface (UEFI) specification for
2792 * First all driver binding protocol handles are tried for binding drivers.
2793 * Afterwards all handles that have openened a protocol of the controller
2794 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2796 * Return: status code
2798 static efi_status_t EFIAPI
efi_connect_controller(
2799 efi_handle_t controller_handle
,
2800 efi_handle_t
*driver_image_handle
,
2801 struct efi_device_path
*remain_device_path
,
2805 efi_status_t ret
= EFI_NOT_FOUND
;
2806 struct efi_object
*efiobj
;
2808 EFI_ENTRY("%p, %p, %p, %d", controller_handle
, driver_image_handle
,
2809 remain_device_path
, recursive
);
2811 efiobj
= efi_search_obj(controller_handle
);
2813 ret
= EFI_INVALID_PARAMETER
;
2817 r
= efi_connect_single_controller(controller_handle
,
2818 driver_image_handle
,
2819 remain_device_path
);
2820 if (r
== EFI_SUCCESS
)
2823 struct efi_handler
*handler
;
2824 struct efi_open_protocol_info_item
*item
;
2826 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
2827 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2828 if (item
->info
.attributes
&
2829 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) {
2830 r
= EFI_CALL(efi_connect_controller(
2831 item
->info
.controller_handle
,
2832 driver_image_handle
,
2835 if (r
== EFI_SUCCESS
)
2841 /* Check for child controller specified by end node */
2842 if (ret
!= EFI_SUCCESS
&& remain_device_path
&&
2843 remain_device_path
->type
== DEVICE_PATH_TYPE_END
)
2846 return EFI_EXIT(ret
);
2850 * efi_reinstall_protocol_interface() - reinstall protocol interface
2851 * @handle: handle on which the protocol shall be reinstalled
2852 * @protocol: GUID of the protocol to be installed
2853 * @old_interface: interface to be removed
2854 * @new_interface: interface to be installed
2856 * This function implements the ReinstallProtocolInterface service.
2858 * See the Unified Extensible Firmware Interface (UEFI) specification for
2861 * The old interface is uninstalled. The new interface is installed.
2862 * Drivers are connected.
2864 * Return: status code
2866 static efi_status_t EFIAPI
efi_reinstall_protocol_interface(
2867 efi_handle_t handle
, const efi_guid_t
*protocol
,
2868 void *old_interface
, void *new_interface
)
2872 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, old_interface
,
2874 ret
= EFI_CALL(efi_uninstall_protocol_interface(handle
, protocol
,
2876 if (ret
!= EFI_SUCCESS
)
2878 ret
= EFI_CALL(efi_install_protocol_interface(&handle
, protocol
,
2879 EFI_NATIVE_INTERFACE
,
2881 if (ret
!= EFI_SUCCESS
)
2884 * The returned status code has to be ignored.
2885 * Do not create an error if no suitable driver for the handle exists.
2887 EFI_CALL(efi_connect_controller(handle
, NULL
, NULL
, true));
2889 return EFI_EXIT(ret
);
2893 * efi_get_child_controllers() - get all child controllers associated to a driver
2894 * @efiobj: handle of the controller
2895 * @driver_handle: handle of the driver
2896 * @number_of_children: number of child controllers
2897 * @child_handle_buffer: handles of the the child controllers
2899 * The allocated buffer has to be freed with free().
2901 * Return: status code
2903 static efi_status_t
efi_get_child_controllers(
2904 struct efi_object
*efiobj
,
2905 efi_handle_t driver_handle
,
2906 efi_uintn_t
*number_of_children
,
2907 efi_handle_t
**child_handle_buffer
)
2909 struct efi_handler
*handler
;
2910 struct efi_open_protocol_info_item
*item
;
2911 efi_uintn_t count
= 0, i
;
2914 /* Count all child controller associations */
2915 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
2916 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2917 if (item
->info
.agent_handle
== driver_handle
&&
2918 item
->info
.attributes
&
2919 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
)
2924 * Create buffer. In case of duplicate child controller assignments
2925 * the buffer will be too large. But that does not harm.
2927 *number_of_children
= 0;
2928 *child_handle_buffer
= calloc(count
, sizeof(efi_handle_t
));
2929 if (!*child_handle_buffer
)
2930 return EFI_OUT_OF_RESOURCES
;
2931 /* Copy unique child handles */
2932 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
2933 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2934 if (item
->info
.agent_handle
== driver_handle
&&
2935 item
->info
.attributes
&
2936 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) {
2937 /* Check this is a new child controller */
2939 for (i
= 0; i
< *number_of_children
; ++i
) {
2940 if ((*child_handle_buffer
)[i
] ==
2941 item
->info
.controller_handle
)
2944 /* Copy handle to buffer */
2946 i
= (*number_of_children
)++;
2947 (*child_handle_buffer
)[i
] =
2948 item
->info
.controller_handle
;
2957 * efi_disconnect_controller() - disconnect a controller from a driver
2958 * @controller_handle: handle of the controller
2959 * @driver_image_handle: handle of the driver
2960 * @child_handle: handle of the child to destroy
2962 * This function implements the DisconnectController service.
2964 * See the Unified Extensible Firmware Interface (UEFI) specification for
2967 * Return: status code
2969 static efi_status_t EFIAPI
efi_disconnect_controller(
2970 efi_handle_t controller_handle
,
2971 efi_handle_t driver_image_handle
,
2972 efi_handle_t child_handle
)
2974 struct efi_driver_binding_protocol
*binding_protocol
;
2975 efi_handle_t
*child_handle_buffer
= NULL
;
2976 size_t number_of_children
= 0;
2978 size_t stop_count
= 0;
2979 struct efi_object
*efiobj
;
2981 EFI_ENTRY("%p, %p, %p", controller_handle
, driver_image_handle
,
2984 efiobj
= efi_search_obj(controller_handle
);
2986 r
= EFI_INVALID_PARAMETER
;
2990 if (child_handle
&& !efi_search_obj(child_handle
)) {
2991 r
= EFI_INVALID_PARAMETER
;
2995 /* If no driver handle is supplied, disconnect all drivers */
2996 if (!driver_image_handle
) {
2997 r
= efi_disconnect_all_drivers(efiobj
, NULL
, child_handle
);
3001 /* Create list of child handles */
3003 number_of_children
= 1;
3004 child_handle_buffer
= &child_handle
;
3006 efi_get_child_controllers(efiobj
,
3007 driver_image_handle
,
3008 &number_of_children
,
3009 &child_handle_buffer
);
3012 /* Get the driver binding protocol */
3013 r
= EFI_CALL(efi_open_protocol(driver_image_handle
,
3014 &efi_guid_driver_binding_protocol
,
3015 (void **)&binding_protocol
,
3016 driver_image_handle
, NULL
,
3017 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
3018 if (r
!= EFI_SUCCESS
)
3020 /* Remove the children */
3021 if (number_of_children
) {
3022 r
= EFI_CALL(binding_protocol
->stop(binding_protocol
,
3025 child_handle_buffer
));
3026 if (r
== EFI_SUCCESS
)
3029 /* Remove the driver */
3031 r
= EFI_CALL(binding_protocol
->stop(binding_protocol
,
3034 if (r
== EFI_SUCCESS
)
3036 EFI_CALL(efi_close_protocol(driver_image_handle
,
3037 &efi_guid_driver_binding_protocol
,
3038 driver_image_handle
, NULL
));
3046 free(child_handle_buffer
);
3050 static struct efi_boot_services efi_boot_services
= {
3052 .signature
= EFI_BOOT_SERVICES_SIGNATURE
,
3053 .revision
= EFI_SPECIFICATION_VERSION
,
3054 .headersize
= sizeof(struct efi_boot_services
),
3056 .raise_tpl
= efi_raise_tpl
,
3057 .restore_tpl
= efi_restore_tpl
,
3058 .allocate_pages
= efi_allocate_pages_ext
,
3059 .free_pages
= efi_free_pages_ext
,
3060 .get_memory_map
= efi_get_memory_map_ext
,
3061 .allocate_pool
= efi_allocate_pool_ext
,
3062 .free_pool
= efi_free_pool_ext
,
3063 .create_event
= efi_create_event_ext
,
3064 .set_timer
= efi_set_timer_ext
,
3065 .wait_for_event
= efi_wait_for_event
,
3066 .signal_event
= efi_signal_event_ext
,
3067 .close_event
= efi_close_event
,
3068 .check_event
= efi_check_event
,
3069 .install_protocol_interface
= efi_install_protocol_interface
,
3070 .reinstall_protocol_interface
= efi_reinstall_protocol_interface
,
3071 .uninstall_protocol_interface
= efi_uninstall_protocol_interface
,
3072 .handle_protocol
= efi_handle_protocol
,
3074 .register_protocol_notify
= efi_register_protocol_notify
,
3075 .locate_handle
= efi_locate_handle_ext
,
3076 .locate_device_path
= efi_locate_device_path
,
3077 .install_configuration_table
= efi_install_configuration_table_ext
,
3078 .load_image
= efi_load_image
,
3079 .start_image
= efi_start_image
,
3081 .unload_image
= efi_unload_image
,
3082 .exit_boot_services
= efi_exit_boot_services
,
3083 .get_next_monotonic_count
= efi_get_next_monotonic_count
,
3085 .set_watchdog_timer
= efi_set_watchdog_timer
,
3086 .connect_controller
= efi_connect_controller
,
3087 .disconnect_controller
= efi_disconnect_controller
,
3088 .open_protocol
= efi_open_protocol
,
3089 .close_protocol
= efi_close_protocol
,
3090 .open_protocol_information
= efi_open_protocol_information
,
3091 .protocols_per_handle
= efi_protocols_per_handle
,
3092 .locate_handle_buffer
= efi_locate_handle_buffer
,
3093 .locate_protocol
= efi_locate_protocol
,
3094 .install_multiple_protocol_interfaces
=
3095 efi_install_multiple_protocol_interfaces
,
3096 .uninstall_multiple_protocol_interfaces
=
3097 efi_uninstall_multiple_protocol_interfaces
,
3098 .calculate_crc32
= efi_calculate_crc32
,
3099 .copy_mem
= efi_copy_mem
,
3100 .set_mem
= efi_set_mem
,
3101 .create_event_ex
= efi_create_event_ex
,
3104 static u16 __efi_runtime_data firmware_vendor
[] = L
"Das U-Boot";
3106 struct efi_system_table __efi_runtime_data systab
= {
3108 .signature
= EFI_SYSTEM_TABLE_SIGNATURE
,
3109 .revision
= EFI_SPECIFICATION_VERSION
,
3110 .headersize
= sizeof(struct efi_system_table
),
3112 .fw_vendor
= firmware_vendor
,
3113 .fw_revision
= FW_VERSION
<< 16 | FW_PATCHLEVEL
<< 8,
3114 .con_in
= (void *)&efi_con_in
,
3115 .con_out
= (void *)&efi_con_out
,
3116 .std_err
= (void *)&efi_con_out
,
3117 .runtime
= (void *)&efi_runtime_services
,
3118 .boottime
= (void *)&efi_boot_services
,
3124 * efi_initialize_system_table() - Initialize system table
3126 * Return Value: status code
3128 efi_status_t
efi_initialize_system_table(void)
3132 /* Allocate configuration table array */
3133 ret
= efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA
,
3134 EFI_MAX_CONFIGURATION_TABLES
*
3135 sizeof(struct efi_configuration_table
),
3136 (void **)&systab
.tables
);
3138 /* Set crc32 field in table headers */
3139 efi_update_table_header_crc32(&systab
.hdr
);
3140 efi_update_table_header_crc32(&efi_runtime_services
.hdr
);
3141 efi_update_table_header_crc32(&efi_boot_services
.hdr
);