2 * EFI application boot time services
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
11 #include <efi_loader.h>
12 #include <environment.h>
14 #include <asm/global_data.h>
15 #include <libfdt_env.h>
16 #include <u-boot/crc.h>
21 DECLARE_GLOBAL_DATA_PTR
;
23 /* Task priority level */
24 static efi_uintn_t efi_tpl
= TPL_APPLICATION
;
26 /* This list contains all the EFI objects our payload has access to */
27 LIST_HEAD(efi_obj_list
);
30 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
31 * we need to do trickery with caches. Since we don't want to break the EFI
32 * aware boot path, only apply hacks when loading exiting directly (breaking
33 * direct Linux EFI booting along the way - oh well).
35 static bool efi_is_direct_boot
= true;
38 * EFI can pass arbitrary additional "tables" containing vendor specific
39 * information to the payload. One such table is the FDT table which contains
40 * a pointer to a flattened device tree blob.
42 * In most cases we want to pass an FDT to the payload, so reserve one slot of
43 * config table space for it. The pointer gets populated by do_bootefi_exec().
45 static struct efi_configuration_table __efi_runtime_data efi_conf_table
[2];
49 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
50 * fixed when compiling U-Boot. However, the payload does not know about that
51 * restriction so we need to manually swap its and our view of that register on
52 * EFI callback entry/exit.
54 static volatile void *efi_gd
, *app_gd
;
57 static int entry_count
;
58 static int nesting_level
;
59 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60 const efi_guid_t efi_guid_driver_binding_protocol
=
61 EFI_DRIVER_BINDING_PROTOCOL_GUID
;
63 static efi_status_t EFIAPI
efi_disconnect_controller(
64 efi_handle_t controller_handle
,
65 efi_handle_t driver_image_handle
,
66 efi_handle_t child_handle
);
68 /* Called on every callback entry */
69 int __efi_entry_check(void)
71 int ret
= entry_count
++ == 0;
80 /* Called on every callback exit */
81 int __efi_exit_check(void)
83 int ret
= --entry_count
== 0;
90 /* Called from do_bootefi_exec() */
91 void efi_save_gd(void)
99 * Special case handler for error/abort that just forces things back
100 * to u-boot world so we can dump out an abort msg, without any care
101 * about returning back to UEFI world.
103 void efi_restore_gd(void)
106 /* Only restore if we're already in EFI context */
114 * Return a string for indenting with two spaces per level. A maximum of ten
115 * indent levels is supported. Higher indent levels will be truncated.
117 * @level indent level
118 * @return indent string
120 static const char *indent_string(int level
)
122 const char *indent
= " ";
123 const int max
= strlen(indent
);
124 level
= min(max
, level
* 2);
125 return &indent
[max
- level
];
128 const char *__efi_nesting(void)
130 return indent_string(nesting_level
);
133 const char *__efi_nesting_inc(void)
135 return indent_string(nesting_level
++);
138 const char *__efi_nesting_dec(void)
140 return indent_string(--nesting_level
);
144 * Queue an EFI event.
146 * This function queues the notification function of the event for future
149 * The notification function is called if the task priority level of the
150 * event is higher than the current task priority level.
152 * For the SignalEvent service see efi_signal_event_ext.
154 * @event event to signal
155 * @check_tpl check the TPL level
157 void efi_signal_event(struct efi_event
*event
, bool check_tpl
)
159 if (event
->notify_function
) {
160 event
->is_queued
= true;
162 if (check_tpl
&& efi_tpl
>= event
->notify_tpl
)
164 EFI_CALL_VOID(event
->notify_function(event
,
165 event
->notify_context
));
167 event
->is_queued
= false;
171 * Raise the task priority level.
173 * This function implements the RaiseTpl service.
174 * See the Unified Extensible Firmware Interface (UEFI) specification
177 * @new_tpl new value of the task priority level
178 * @return old value of the task priority level
180 static unsigned long EFIAPI
efi_raise_tpl(efi_uintn_t new_tpl
)
182 efi_uintn_t old_tpl
= efi_tpl
;
184 EFI_ENTRY("0x%zx", new_tpl
);
186 if (new_tpl
< efi_tpl
)
187 debug("WARNING: new_tpl < current_tpl in %s\n", __func__
);
189 if (efi_tpl
> TPL_HIGH_LEVEL
)
190 efi_tpl
= TPL_HIGH_LEVEL
;
192 EFI_EXIT(EFI_SUCCESS
);
197 * Lower the task priority level.
199 * This function implements the RestoreTpl service.
200 * See the Unified Extensible Firmware Interface (UEFI) specification
203 * @old_tpl value of the task priority level to be restored
205 static void EFIAPI
efi_restore_tpl(efi_uintn_t old_tpl
)
207 EFI_ENTRY("0x%zx", old_tpl
);
209 if (old_tpl
> efi_tpl
)
210 debug("WARNING: old_tpl > current_tpl in %s\n", __func__
);
212 if (efi_tpl
> TPL_HIGH_LEVEL
)
213 efi_tpl
= TPL_HIGH_LEVEL
;
215 EFI_EXIT(EFI_SUCCESS
);
219 * Allocate memory pages.
221 * This function implements the AllocatePages service.
222 * See the Unified Extensible Firmware Interface (UEFI) specification
225 * @type type of allocation to be performed
226 * @memory_type usage type of the allocated memory
227 * @pages number of pages to be allocated
228 * @memory allocated memory
229 * @return status code
231 static efi_status_t EFIAPI
efi_allocate_pages_ext(int type
, int memory_type
,
237 EFI_ENTRY("%d, %d, 0x%zx, %p", type
, memory_type
, pages
, memory
);
238 r
= efi_allocate_pages(type
, memory_type
, pages
, memory
);
245 * This function implements the FreePages service.
246 * See the Unified Extensible Firmware Interface (UEFI) specification
249 * @memory start of the memory area to be freed
250 * @pages number of pages to be freed
251 * @return status code
253 static efi_status_t EFIAPI
efi_free_pages_ext(uint64_t memory
,
258 EFI_ENTRY("%"PRIx64
", 0x%zx", memory
, pages
);
259 r
= efi_free_pages(memory
, pages
);
264 * Get map describing memory usage.
266 * This function implements the GetMemoryMap service.
267 * See the Unified Extensible Firmware Interface (UEFI) specification
270 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
271 * on exit the size of the copied memory map
272 * @memory_map buffer to which the memory map is written
273 * @map_key key for the memory map
274 * @descriptor_size size of an individual memory descriptor
275 * @descriptor_version version number of the memory descriptor structure
276 * @return status code
278 static efi_status_t EFIAPI
efi_get_memory_map_ext(
279 efi_uintn_t
*memory_map_size
,
280 struct efi_mem_desc
*memory_map
,
281 efi_uintn_t
*map_key
,
282 efi_uintn_t
*descriptor_size
,
283 uint32_t *descriptor_version
)
287 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size
, memory_map
,
288 map_key
, descriptor_size
, descriptor_version
);
289 r
= efi_get_memory_map(memory_map_size
, memory_map
, map_key
,
290 descriptor_size
, descriptor_version
);
295 * Allocate memory from pool.
297 * This function implements the AllocatePool service.
298 * See the Unified Extensible Firmware Interface (UEFI) specification
301 * @pool_type type of the pool from which memory is to be allocated
302 * @size number of bytes to be allocated
303 * @buffer allocated memory
304 * @return status code
306 static efi_status_t EFIAPI
efi_allocate_pool_ext(int pool_type
,
312 EFI_ENTRY("%d, %zd, %p", pool_type
, size
, buffer
);
313 r
= efi_allocate_pool(pool_type
, size
, buffer
);
318 * Free memory from pool.
320 * This function implements the FreePool service.
321 * See the Unified Extensible Firmware Interface (UEFI) specification
324 * @buffer start of memory to be freed
325 * @return status code
327 static efi_status_t EFIAPI
efi_free_pool_ext(void *buffer
)
331 EFI_ENTRY("%p", buffer
);
332 r
= efi_free_pool(buffer
);
337 * Add a new object to the object list.
339 * The protocols list is initialized.
340 * The object handle is set.
342 * @obj object to be added
344 void efi_add_handle(struct efi_object
*obj
)
348 INIT_LIST_HEAD(&obj
->protocols
);
350 list_add_tail(&obj
->link
, &efi_obj_list
);
357 * @return status code
359 efi_status_t
efi_create_handle(efi_handle_t
*handle
)
361 struct efi_object
*obj
;
364 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
,
365 sizeof(struct efi_object
),
367 if (r
!= EFI_SUCCESS
)
370 *handle
= obj
->handle
;
375 * Find a protocol on a handle.
378 * @protocol_guid GUID of the protocol
379 * @handler reference to the protocol
380 * @return status code
382 efi_status_t
efi_search_protocol(const efi_handle_t handle
,
383 const efi_guid_t
*protocol_guid
,
384 struct efi_handler
**handler
)
386 struct efi_object
*efiobj
;
387 struct list_head
*lhandle
;
389 if (!handle
|| !protocol_guid
)
390 return EFI_INVALID_PARAMETER
;
391 efiobj
= efi_search_obj(handle
);
393 return EFI_INVALID_PARAMETER
;
394 list_for_each(lhandle
, &efiobj
->protocols
) {
395 struct efi_handler
*protocol
;
397 protocol
= list_entry(lhandle
, struct efi_handler
, link
);
398 if (!guidcmp(protocol
->guid
, protocol_guid
)) {
404 return EFI_NOT_FOUND
;
408 * Delete protocol from a handle.
410 * @handle handle from which the protocol shall be deleted
411 * @protocol GUID of the protocol to be deleted
412 * @protocol_interface interface of the protocol implementation
413 * @return status code
415 efi_status_t
efi_remove_protocol(const efi_handle_t handle
,
416 const efi_guid_t
*protocol
,
417 void *protocol_interface
)
419 struct efi_handler
*handler
;
422 ret
= efi_search_protocol(handle
, protocol
, &handler
);
423 if (ret
!= EFI_SUCCESS
)
425 if (guidcmp(handler
->guid
, protocol
))
426 return EFI_INVALID_PARAMETER
;
427 list_del(&handler
->link
);
433 * Delete all protocols from a handle.
435 * @handle handle from which the protocols shall be deleted
436 * @return status code
438 efi_status_t
efi_remove_all_protocols(const efi_handle_t handle
)
440 struct efi_object
*efiobj
;
441 struct efi_handler
*protocol
;
442 struct efi_handler
*pos
;
444 efiobj
= efi_search_obj(handle
);
446 return EFI_INVALID_PARAMETER
;
447 list_for_each_entry_safe(protocol
, pos
, &efiobj
->protocols
, link
) {
450 ret
= efi_remove_protocol(handle
, protocol
->guid
,
451 protocol
->protocol_interface
);
452 if (ret
!= EFI_SUCCESS
)
461 * @handle handle to delete
463 void efi_delete_handle(struct efi_object
*obj
)
467 efi_remove_all_protocols(obj
->handle
);
468 list_del(&obj
->link
);
473 * Our event capabilities are very limited. Only a small limited
474 * number of events is allowed to coexist.
476 static struct efi_event efi_events
[16];
481 * This function is used inside U-Boot code to create an event.
483 * For the API function implementing the CreateEvent service see
484 * efi_create_event_ext.
486 * @type type of the event to create
487 * @notify_tpl task priority level of the event
488 * @notify_function notification function of the event
489 * @notify_context pointer passed to the notification function
490 * @event created event
491 * @return status code
493 efi_status_t
efi_create_event(uint32_t type
, efi_uintn_t notify_tpl
,
494 void (EFIAPI
*notify_function
) (
495 struct efi_event
*event
,
497 void *notify_context
, struct efi_event
**event
)
502 return EFI_INVALID_PARAMETER
;
504 if ((type
& EVT_NOTIFY_SIGNAL
) && (type
& EVT_NOTIFY_WAIT
))
505 return EFI_INVALID_PARAMETER
;
507 if ((type
& (EVT_NOTIFY_SIGNAL
|EVT_NOTIFY_WAIT
)) &&
508 notify_function
== NULL
)
509 return EFI_INVALID_PARAMETER
;
511 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
512 if (efi_events
[i
].type
)
514 efi_events
[i
].type
= type
;
515 efi_events
[i
].notify_tpl
= notify_tpl
;
516 efi_events
[i
].notify_function
= notify_function
;
517 efi_events
[i
].notify_context
= notify_context
;
518 /* Disable timers on bootup */
519 efi_events
[i
].trigger_next
= -1ULL;
520 efi_events
[i
].is_queued
= false;
521 efi_events
[i
].is_signaled
= false;
522 *event
= &efi_events
[i
];
525 return EFI_OUT_OF_RESOURCES
;
531 * This function implements the CreateEvent service.
532 * See the Unified Extensible Firmware Interface (UEFI) specification
535 * @type type of the event to create
536 * @notify_tpl task priority level of the event
537 * @notify_function notification function of the event
538 * @notify_context pointer passed to the notification function
539 * @event created event
540 * @return status code
542 static efi_status_t EFIAPI
efi_create_event_ext(
543 uint32_t type
, efi_uintn_t notify_tpl
,
544 void (EFIAPI
*notify_function
) (
545 struct efi_event
*event
,
547 void *notify_context
, struct efi_event
**event
)
549 EFI_ENTRY("%d, 0x%zx, %p, %p", type
, notify_tpl
, notify_function
,
551 return EFI_EXIT(efi_create_event(type
, notify_tpl
, notify_function
,
552 notify_context
, event
));
557 * Check if a timer event has occurred or a queued notification function should
560 * Our timers have to work without interrupts, so we check whenever keyboard
561 * input or disk accesses happen if enough time elapsed for them to fire.
563 void efi_timer_check(void)
566 u64 now
= timer_get_us();
568 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
569 if (!efi_events
[i
].type
)
571 if (efi_events
[i
].is_queued
)
572 efi_signal_event(&efi_events
[i
], true);
573 if (!(efi_events
[i
].type
& EVT_TIMER
) ||
574 now
< efi_events
[i
].trigger_next
)
576 switch (efi_events
[i
].trigger_type
) {
577 case EFI_TIMER_RELATIVE
:
578 efi_events
[i
].trigger_type
= EFI_TIMER_STOP
;
580 case EFI_TIMER_PERIODIC
:
581 efi_events
[i
].trigger_next
+=
582 efi_events
[i
].trigger_time
;
587 efi_events
[i
].is_signaled
= true;
588 efi_signal_event(&efi_events
[i
], true);
594 * Set the trigger time for a timer event or stop the event.
596 * This is the function for internal usage in U-Boot. For the API function
597 * implementing the SetTimer service see efi_set_timer_ext.
599 * @event event for which the timer is set
600 * @type type of the timer
601 * @trigger_time trigger period in multiples of 100ns
602 * @return status code
604 efi_status_t
efi_set_timer(struct efi_event
*event
, enum efi_timer_delay type
,
605 uint64_t trigger_time
)
610 * The parameter defines a multiple of 100ns.
611 * We use multiples of 1000ns. So divide by 10.
613 do_div(trigger_time
, 10);
615 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
616 if (event
!= &efi_events
[i
])
619 if (!(event
->type
& EVT_TIMER
))
623 event
->trigger_next
= -1ULL;
625 case EFI_TIMER_PERIODIC
:
626 case EFI_TIMER_RELATIVE
:
627 event
->trigger_next
=
628 timer_get_us() + trigger_time
;
631 return EFI_INVALID_PARAMETER
;
633 event
->trigger_type
= type
;
634 event
->trigger_time
= trigger_time
;
635 event
->is_signaled
= false;
638 return EFI_INVALID_PARAMETER
;
642 * Set the trigger time for a timer event or stop the event.
644 * This function implements the SetTimer service.
645 * See the Unified Extensible Firmware Interface (UEFI) specification
648 * @event event for which the timer is set
649 * @type type of the timer
650 * @trigger_time trigger period in multiples of 100ns
651 * @return status code
653 static efi_status_t EFIAPI
efi_set_timer_ext(struct efi_event
*event
,
654 enum efi_timer_delay type
,
655 uint64_t trigger_time
)
657 EFI_ENTRY("%p, %d, %"PRIx64
, event
, type
, trigger_time
);
658 return EFI_EXIT(efi_set_timer(event
, type
, trigger_time
));
662 * Wait for events to be signaled.
664 * This function implements the WaitForEvent service.
665 * See the Unified Extensible Firmware Interface (UEFI) specification
668 * @num_events number of events to be waited for
669 * @events events to be waited for
670 * @index index of the event that was signaled
671 * @return status code
673 static efi_status_t EFIAPI
efi_wait_for_event(efi_uintn_t num_events
,
674 struct efi_event
**event
,
679 EFI_ENTRY("%zd, %p, %p", num_events
, event
, index
);
681 /* Check parameters */
682 if (!num_events
|| !event
)
683 return EFI_EXIT(EFI_INVALID_PARAMETER
);
685 if (efi_tpl
!= TPL_APPLICATION
)
686 return EFI_EXIT(EFI_UNSUPPORTED
);
687 for (i
= 0; i
< num_events
; ++i
) {
688 for (j
= 0; j
< ARRAY_SIZE(efi_events
); ++j
) {
689 if (event
[i
] == &efi_events
[j
])
692 return EFI_EXIT(EFI_INVALID_PARAMETER
);
694 if (!event
[i
]->type
|| event
[i
]->type
& EVT_NOTIFY_SIGNAL
)
695 return EFI_EXIT(EFI_INVALID_PARAMETER
);
696 if (!event
[i
]->is_signaled
)
697 efi_signal_event(event
[i
], true);
700 /* Wait for signal */
702 for (i
= 0; i
< num_events
; ++i
) {
703 if (event
[i
]->is_signaled
)
706 /* Allow events to occur. */
712 * Reset the signal which is passed to the caller to allow periodic
715 event
[i
]->is_signaled
= false;
719 return EFI_EXIT(EFI_SUCCESS
);
723 * Signal an EFI event.
725 * This function implements the SignalEvent service.
726 * See the Unified Extensible Firmware Interface (UEFI) specification
729 * This functions sets the signaled state of the event and queues the
730 * notification function for execution.
732 * @event event to signal
733 * @return status code
735 static efi_status_t EFIAPI
efi_signal_event_ext(struct efi_event
*event
)
739 EFI_ENTRY("%p", event
);
740 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
741 if (event
!= &efi_events
[i
])
743 if (event
->is_signaled
)
745 event
->is_signaled
= true;
746 if (event
->type
& EVT_NOTIFY_SIGNAL
)
747 efi_signal_event(event
, true);
750 return EFI_EXIT(EFI_SUCCESS
);
754 * Close an EFI event.
756 * This function implements the CloseEvent service.
757 * See the Unified Extensible Firmware Interface (UEFI) specification
760 * @event event to close
761 * @return status code
763 static efi_status_t EFIAPI
efi_close_event(struct efi_event
*event
)
767 EFI_ENTRY("%p", event
);
768 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
769 if (event
== &efi_events
[i
]) {
771 event
->trigger_next
= -1ULL;
772 event
->is_queued
= false;
773 event
->is_signaled
= false;
774 return EFI_EXIT(EFI_SUCCESS
);
777 return EFI_EXIT(EFI_INVALID_PARAMETER
);
781 * Check if an event is signaled.
783 * This function implements the CheckEvent service.
784 * See the Unified Extensible Firmware Interface (UEFI) specification
787 * If an event is not signaled yet the notification function is queued.
789 * @event event to check
790 * @return status code
792 static efi_status_t EFIAPI
efi_check_event(struct efi_event
*event
)
796 EFI_ENTRY("%p", event
);
798 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
799 if (event
!= &efi_events
[i
])
801 if (!event
->type
|| event
->type
& EVT_NOTIFY_SIGNAL
)
803 if (!event
->is_signaled
)
804 efi_signal_event(event
, true);
805 if (event
->is_signaled
)
806 return EFI_EXIT(EFI_SUCCESS
);
807 return EFI_EXIT(EFI_NOT_READY
);
809 return EFI_EXIT(EFI_INVALID_PARAMETER
);
813 * Find the internal EFI object for a handle.
815 * @handle handle to find
818 struct efi_object
*efi_search_obj(const efi_handle_t handle
)
820 struct efi_object
*efiobj
;
822 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
823 if (efiobj
->handle
== handle
)
831 * Create open protocol info entry and add it to a protocol.
833 * @handler handler of a protocol
834 * @return open protocol info entry
836 static struct efi_open_protocol_info_entry
*efi_create_open_info(
837 struct efi_handler
*handler
)
839 struct efi_open_protocol_info_item
*item
;
841 item
= calloc(1, sizeof(struct efi_open_protocol_info_item
));
844 /* Append the item to the open protocol info list. */
845 list_add_tail(&item
->link
, &handler
->open_infos
);
851 * Remove an open protocol info entry from a protocol.
853 * @handler handler of a protocol
854 * @return status code
856 static efi_status_t
efi_delete_open_info(
857 struct efi_open_protocol_info_item
*item
)
859 list_del(&item
->link
);
865 * Install new protocol on a handle.
867 * @handle handle on which the protocol shall be installed
868 * @protocol GUID of the protocol to be installed
869 * @protocol_interface interface of the protocol implementation
870 * @return status code
872 efi_status_t
efi_add_protocol(const efi_handle_t handle
,
873 const efi_guid_t
*protocol
,
874 void *protocol_interface
)
876 struct efi_object
*efiobj
;
877 struct efi_handler
*handler
;
880 efiobj
= efi_search_obj(handle
);
882 return EFI_INVALID_PARAMETER
;
883 ret
= efi_search_protocol(handle
, protocol
, NULL
);
884 if (ret
!= EFI_NOT_FOUND
)
885 return EFI_INVALID_PARAMETER
;
886 handler
= calloc(1, sizeof(struct efi_handler
));
888 return EFI_OUT_OF_RESOURCES
;
889 handler
->guid
= protocol
;
890 handler
->protocol_interface
= protocol_interface
;
891 INIT_LIST_HEAD(&handler
->open_infos
);
892 list_add_tail(&handler
->link
, &efiobj
->protocols
);
893 if (!guidcmp(&efi_guid_device_path
, protocol
))
894 EFI_PRINT("installed device path '%pD'\n", protocol_interface
);
899 * Install protocol interface.
901 * This function implements the InstallProtocolInterface service.
902 * See the Unified Extensible Firmware Interface (UEFI) specification
905 * @handle handle on which the protocol shall be installed
906 * @protocol GUID of the protocol to be installed
907 * @protocol_interface_type type of the interface to be installed,
908 * always EFI_NATIVE_INTERFACE
909 * @protocol_interface interface of the protocol implementation
910 * @return status code
912 static efi_status_t EFIAPI
efi_install_protocol_interface(
913 void **handle
, const efi_guid_t
*protocol
,
914 int protocol_interface_type
, void *protocol_interface
)
918 EFI_ENTRY("%p, %pUl, %d, %p", handle
, protocol
, protocol_interface_type
,
921 if (!handle
|| !protocol
||
922 protocol_interface_type
!= EFI_NATIVE_INTERFACE
) {
923 r
= EFI_INVALID_PARAMETER
;
927 /* Create new handle if requested. */
929 r
= efi_create_handle(handle
);
930 if (r
!= EFI_SUCCESS
)
932 debug("%sEFI: new handle %p\n", indent_string(nesting_level
),
935 debug("%sEFI: handle %p\n", indent_string(nesting_level
),
938 /* Add new protocol */
939 r
= efi_add_protocol(*handle
, protocol
, protocol_interface
);
945 * Reinstall protocol interface.
947 * This function implements the ReinstallProtocolInterface service.
948 * See the Unified Extensible Firmware Interface (UEFI) specification
951 * @handle handle on which the protocol shall be
953 * @protocol GUID of the protocol to be installed
954 * @old_interface interface to be removed
955 * @new_interface interface to be installed
956 * @return status code
958 static efi_status_t EFIAPI
efi_reinstall_protocol_interface(
959 efi_handle_t handle
, const efi_guid_t
*protocol
,
960 void *old_interface
, void *new_interface
)
962 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, old_interface
,
964 return EFI_EXIT(EFI_ACCESS_DENIED
);
968 * Get all drivers associated to a controller.
969 * The allocated buffer has to be freed with free().
971 * @efiobj handle of the controller
972 * @protocol protocol guid (optional)
973 * @number_of_drivers number of child controllers
974 * @driver_handle_buffer handles of the the drivers
975 * @return status code
977 static efi_status_t
efi_get_drivers(struct efi_object
*efiobj
,
978 const efi_guid_t
*protocol
,
979 efi_uintn_t
*number_of_drivers
,
980 efi_handle_t
**driver_handle_buffer
)
982 struct efi_handler
*handler
;
983 struct efi_open_protocol_info_item
*item
;
984 efi_uintn_t count
= 0, i
;
987 /* Count all driver associations */
988 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
989 if (protocol
&& guidcmp(handler
->guid
, protocol
))
991 list_for_each_entry(item
, &handler
->open_infos
, link
) {
992 if (item
->info
.attributes
&
993 EFI_OPEN_PROTOCOL_BY_DRIVER
)
998 * Create buffer. In case of duplicate driver assignments the buffer
999 * will be too large. But that does not harm.
1001 *number_of_drivers
= 0;
1002 *driver_handle_buffer
= calloc(count
, sizeof(efi_handle_t
));
1003 if (!*driver_handle_buffer
)
1004 return EFI_OUT_OF_RESOURCES
;
1005 /* Collect unique driver handles */
1006 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
1007 if (protocol
&& guidcmp(handler
->guid
, protocol
))
1009 list_for_each_entry(item
, &handler
->open_infos
, link
) {
1010 if (item
->info
.attributes
&
1011 EFI_OPEN_PROTOCOL_BY_DRIVER
) {
1012 /* Check this is a new driver */
1014 for (i
= 0; i
< *number_of_drivers
; ++i
) {
1015 if ((*driver_handle_buffer
)[i
] ==
1016 item
->info
.agent_handle
)
1019 /* Copy handle to buffer */
1021 i
= (*number_of_drivers
)++;
1022 (*driver_handle_buffer
)[i
] =
1023 item
->info
.agent_handle
;
1032 * Disconnect all drivers from a controller.
1034 * This function implements the DisconnectController service.
1035 * See the Unified Extensible Firmware Interface (UEFI) specification
1038 * @efiobj handle of the controller
1039 * @protocol protocol guid (optional)
1040 * @child_handle handle of the child to destroy
1041 * @return status code
1043 static efi_status_t
efi_disconnect_all_drivers(
1044 struct efi_object
*efiobj
,
1045 const efi_guid_t
*protocol
,
1046 efi_handle_t child_handle
)
1048 efi_uintn_t number_of_drivers
;
1049 efi_handle_t
*driver_handle_buffer
;
1050 efi_status_t r
, ret
;
1052 ret
= efi_get_drivers(efiobj
, protocol
, &number_of_drivers
,
1053 &driver_handle_buffer
);
1054 if (ret
!= EFI_SUCCESS
)
1057 ret
= EFI_NOT_FOUND
;
1058 while (number_of_drivers
) {
1059 r
= EFI_CALL(efi_disconnect_controller(
1061 driver_handle_buffer
[--number_of_drivers
],
1063 if (r
== EFI_SUCCESS
)
1066 free(driver_handle_buffer
);
1071 * Uninstall protocol interface.
1073 * This function implements the UninstallProtocolInterface service.
1074 * See the Unified Extensible Firmware Interface (UEFI) specification
1077 * @handle handle from which the protocol shall be removed
1078 * @protocol GUID of the protocol to be removed
1079 * @protocol_interface interface to be removed
1080 * @return status code
1082 static efi_status_t EFIAPI
efi_uninstall_protocol_interface(
1083 efi_handle_t handle
, const efi_guid_t
*protocol
,
1084 void *protocol_interface
)
1086 struct efi_object
*efiobj
;
1087 struct efi_handler
*handler
;
1088 struct efi_open_protocol_info_item
*item
;
1089 struct efi_open_protocol_info_item
*pos
;
1092 EFI_ENTRY("%p, %pUl, %p", handle
, protocol
, protocol_interface
);
1095 efiobj
= efi_search_obj(handle
);
1097 r
= EFI_INVALID_PARAMETER
;
1100 /* Find the protocol on the handle */
1101 r
= efi_search_protocol(handle
, protocol
, &handler
);
1102 if (r
!= EFI_SUCCESS
)
1104 /* Disconnect controllers */
1105 efi_disconnect_all_drivers(efiobj
, protocol
, NULL
);
1106 if (!list_empty(&handler
->open_infos
)) {
1107 r
= EFI_ACCESS_DENIED
;
1110 /* Close protocol */
1111 list_for_each_entry_safe(item
, pos
, &handler
->open_infos
, link
) {
1112 if (item
->info
.attributes
==
1113 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
||
1114 item
->info
.attributes
== EFI_OPEN_PROTOCOL_GET_PROTOCOL
||
1115 item
->info
.attributes
== EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
1116 list_del(&item
->link
);
1118 if (!list_empty(&handler
->open_infos
)) {
1119 r
= EFI_ACCESS_DENIED
;
1122 r
= efi_remove_protocol(handle
, protocol
, protocol_interface
);
1128 * Register an event for notification when a protocol is installed.
1130 * This function implements the RegisterProtocolNotify service.
1131 * See the Unified Extensible Firmware Interface (UEFI) specification
1134 * @protocol GUID of the protocol whose installation shall be
1136 * @event event to be signaled upon installation of the protocol
1137 * @registration key for retrieving the registration information
1138 * @return status code
1140 static efi_status_t EFIAPI
efi_register_protocol_notify(
1141 const efi_guid_t
*protocol
,
1142 struct efi_event
*event
,
1143 void **registration
)
1145 EFI_ENTRY("%pUl, %p, %p", protocol
, event
, registration
);
1146 return EFI_EXIT(EFI_OUT_OF_RESOURCES
);
1150 * Determine if an EFI handle implements a protocol.
1152 * See the documentation of the LocateHandle service in the UEFI specification.
1154 * @search_type selection criterion
1155 * @protocol GUID of the protocol
1156 * @search_key registration key
1158 * @return 0 if the handle implements the protocol
1160 static int efi_search(enum efi_locate_search_type search_type
,
1161 const efi_guid_t
*protocol
, void *search_key
,
1162 struct efi_object
*efiobj
)
1166 switch (search_type
) {
1169 case BY_REGISTER_NOTIFY
:
1170 /* TODO: RegisterProtocolNotify is not implemented yet */
1173 ret
= efi_search_protocol(efiobj
->handle
, protocol
, NULL
);
1174 return (ret
!= EFI_SUCCESS
);
1176 /* Invalid search type */
1182 * Locate handles implementing a protocol.
1184 * This function is meant for U-Boot internal calls. For the API implementation
1185 * of the LocateHandle service see efi_locate_handle_ext.
1187 * @search_type selection criterion
1188 * @protocol GUID of the protocol
1189 * @search_key registration key
1190 * @buffer_size size of the buffer to receive the handles in bytes
1191 * @buffer buffer to receive the relevant handles
1192 * @return status code
1194 static efi_status_t
efi_locate_handle(
1195 enum efi_locate_search_type search_type
,
1196 const efi_guid_t
*protocol
, void *search_key
,
1197 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1199 struct efi_object
*efiobj
;
1200 efi_uintn_t size
= 0;
1202 /* Check parameters */
1203 switch (search_type
) {
1206 case BY_REGISTER_NOTIFY
:
1208 return EFI_INVALID_PARAMETER
;
1209 /* RegisterProtocolNotify is not implemented yet */
1210 return EFI_UNSUPPORTED
;
1213 return EFI_INVALID_PARAMETER
;
1216 return EFI_INVALID_PARAMETER
;
1220 * efi_locate_handle_buffer uses this function for
1221 * the calculation of the necessary buffer size.
1222 * So do not require a buffer for buffersize == 0.
1224 if (!buffer_size
|| (*buffer_size
&& !buffer
))
1225 return EFI_INVALID_PARAMETER
;
1227 /* Count how much space we need */
1228 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1229 if (!efi_search(search_type
, protocol
, search_key
, efiobj
))
1230 size
+= sizeof(void*);
1233 if (*buffer_size
< size
) {
1234 *buffer_size
= size
;
1235 return EFI_BUFFER_TOO_SMALL
;
1238 *buffer_size
= size
;
1240 return EFI_NOT_FOUND
;
1242 /* Then fill the array */
1243 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1244 if (!efi_search(search_type
, protocol
, search_key
, efiobj
))
1245 *buffer
++ = efiobj
->handle
;
1252 * Locate handles implementing a protocol.
1254 * This function implements the LocateHandle service.
1255 * See the Unified Extensible Firmware Interface (UEFI) specification
1258 * @search_type selection criterion
1259 * @protocol GUID of the protocol
1260 * @search_key registration key
1261 * @buffer_size size of the buffer to receive the handles in bytes
1262 * @buffer buffer to receive the relevant handles
1263 * @return 0 if the handle implements the protocol
1265 static efi_status_t EFIAPI
efi_locate_handle_ext(
1266 enum efi_locate_search_type search_type
,
1267 const efi_guid_t
*protocol
, void *search_key
,
1268 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1270 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
1271 buffer_size
, buffer
);
1273 return EFI_EXIT(efi_locate_handle(search_type
, protocol
, search_key
,
1274 buffer_size
, buffer
));
1277 /* Collapses configuration table entries, removing index i */
1278 static void efi_remove_configuration_table(int i
)
1280 struct efi_configuration_table
*this = &efi_conf_table
[i
];
1281 struct efi_configuration_table
*next
= &efi_conf_table
[i
+1];
1282 struct efi_configuration_table
*end
= &efi_conf_table
[systab
.nr_tables
];
1284 memmove(this, next
, (ulong
)end
- (ulong
)next
);
1289 * Adds, updates, or removes a configuration table.
1291 * This function is used for internal calls. For the API implementation of the
1292 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1294 * @guid GUID of the installed table
1295 * @table table to be installed
1296 * @return status code
1298 efi_status_t
efi_install_configuration_table(const efi_guid_t
*guid
, void *table
)
1302 /* Check for guid override */
1303 for (i
= 0; i
< systab
.nr_tables
; i
++) {
1304 if (!guidcmp(guid
, &efi_conf_table
[i
].guid
)) {
1306 efi_conf_table
[i
].table
= table
;
1308 efi_remove_configuration_table(i
);
1314 return EFI_NOT_FOUND
;
1316 /* No override, check for overflow */
1317 if (i
>= ARRAY_SIZE(efi_conf_table
))
1318 return EFI_OUT_OF_RESOURCES
;
1320 /* Add a new entry */
1321 memcpy(&efi_conf_table
[i
].guid
, guid
, sizeof(*guid
));
1322 efi_conf_table
[i
].table
= table
;
1323 systab
.nr_tables
= i
+ 1;
1329 * Adds, updates, or removes a configuration table.
1331 * This function implements the InstallConfigurationTable service.
1332 * See the Unified Extensible Firmware Interface (UEFI) specification
1335 * @guid GUID of the installed table
1336 * @table table to be installed
1337 * @return status code
1339 static efi_status_t EFIAPI
efi_install_configuration_table_ext(efi_guid_t
*guid
,
1342 EFI_ENTRY("%pUl, %p", guid
, table
);
1343 return EFI_EXIT(efi_install_configuration_table(guid
, table
));
1347 * Initialize a loaded_image_info + loaded_image_info object with correct
1348 * protocols, boot-device, etc.
1350 * @info loaded image info to be passed to the entry point of the
1352 * @obj internal object associated with the loaded image
1353 * @device_path device path of the loaded image
1354 * @file_path file path of the loaded image
1355 * @return status code
1357 efi_status_t
efi_setup_loaded_image(
1358 struct efi_loaded_image
*info
, struct efi_object
*obj
,
1359 struct efi_device_path
*device_path
,
1360 struct efi_device_path
*file_path
)
1364 /* Add internal object to object list */
1365 efi_add_handle(obj
);
1366 /* efi_exit() assumes that the handle points to the info */
1369 info
->file_path
= file_path
;
1371 info
->device_handle
= efi_dp_find_obj(device_path
, NULL
);
1374 * When asking for the device path interface, return
1375 * bootefi_device_path
1377 ret
= efi_add_protocol(obj
->handle
, &efi_guid_device_path
, device_path
);
1378 if (ret
!= EFI_SUCCESS
)
1382 * When asking for the loaded_image interface, just
1383 * return handle which points to loaded_image_info
1385 ret
= efi_add_protocol(obj
->handle
, &efi_guid_loaded_image
, info
);
1386 if (ret
!= EFI_SUCCESS
)
1389 ret
= efi_add_protocol(obj
->handle
, &efi_guid_console_control
,
1390 (void *)&efi_console_control
);
1391 if (ret
!= EFI_SUCCESS
)
1394 ret
= efi_add_protocol(obj
->handle
,
1395 &efi_guid_device_path_to_text_protocol
,
1396 (void *)&efi_device_path_to_text
);
1397 if (ret
!= EFI_SUCCESS
)
1402 printf("ERROR: Failure to install protocols for loaded image\n");
1407 * Load an image using a file path.
1409 * @file_path the path of the image to load
1410 * @buffer buffer containing the loaded image
1411 * @return status code
1413 efi_status_t
efi_load_image_from_path(struct efi_device_path
*file_path
,
1416 struct efi_file_info
*info
= NULL
;
1417 struct efi_file_handle
*f
;
1418 static efi_status_t ret
;
1421 f
= efi_file_from_path(file_path
);
1423 return EFI_DEVICE_ERROR
;
1426 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1428 if (ret
== EFI_BUFFER_TOO_SMALL
) {
1430 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1433 if (ret
!= EFI_SUCCESS
)
1436 ret
= efi_allocate_pool(EFI_LOADER_DATA
, info
->file_size
, buffer
);
1440 EFI_CALL(ret
= f
->read(f
, &info
->file_size
, *buffer
));
1444 EFI_CALL(f
->close(f
));
1446 if (ret
!= EFI_SUCCESS
) {
1447 efi_free_pool(*buffer
);
1455 * Load an EFI image into memory.
1457 * This function implements the LoadImage service.
1458 * See the Unified Extensible Firmware Interface (UEFI) specification
1461 * @boot_policy true for request originating from the boot manager
1462 * @parent_image the caller's image handle
1463 * @file_path the path of the image to load
1464 * @source_buffer memory location from which the image is installed
1465 * @source_size size of the memory area from which the image is
1467 * @image_handle handle for the newly installed image
1468 * @return status code
1470 static efi_status_t EFIAPI
efi_load_image(bool boot_policy
,
1471 efi_handle_t parent_image
,
1472 struct efi_device_path
*file_path
,
1473 void *source_buffer
,
1474 unsigned long source_size
,
1475 efi_handle_t
*image_handle
)
1477 struct efi_loaded_image
*info
;
1478 struct efi_object
*obj
;
1481 EFI_ENTRY("%d, %p, %pD, %p, %ld, %p", boot_policy
, parent_image
,
1482 file_path
, source_buffer
, source_size
, image_handle
);
1484 info
= calloc(1, sizeof(*info
));
1485 obj
= calloc(1, sizeof(*obj
));
1487 if (!source_buffer
) {
1488 struct efi_device_path
*dp
, *fp
;
1490 ret
= efi_load_image_from_path(file_path
, &source_buffer
);
1491 if (ret
!= EFI_SUCCESS
)
1494 * split file_path which contains both the device and
1497 efi_dp_split_file_path(file_path
, &dp
, &fp
);
1498 ret
= efi_setup_loaded_image(info
, obj
, dp
, fp
);
1499 if (ret
!= EFI_SUCCESS
)
1502 /* In this case, file_path is the "device" path, ie.
1503 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1505 ret
= efi_setup_loaded_image(info
, obj
, file_path
, NULL
);
1506 if (ret
!= EFI_SUCCESS
)
1509 info
->reserved
= efi_load_pe(source_buffer
, info
);
1510 if (!info
->reserved
) {
1511 ret
= EFI_UNSUPPORTED
;
1514 info
->system_table
= &systab
;
1515 info
->parent_handle
= parent_image
;
1516 *image_handle
= obj
->handle
;
1517 return EFI_EXIT(EFI_SUCCESS
);
1520 efi_delete_handle(obj
);
1521 return EFI_EXIT(ret
);
1525 * Call the entry point of an image.
1527 * This function implements the StartImage service.
1528 * See the Unified Extensible Firmware Interface (UEFI) specification
1531 * @image_handle handle of the image
1532 * @exit_data_size size of the buffer
1533 * @exit_data buffer to receive the exit data of the called image
1534 * @return status code
1536 static efi_status_t EFIAPI
efi_start_image(efi_handle_t image_handle
,
1537 unsigned long *exit_data_size
,
1540 EFIAPI
efi_status_t (*entry
)(efi_handle_t image_handle
,
1541 struct efi_system_table
*st
);
1542 struct efi_loaded_image
*info
= image_handle
;
1545 EFI_ENTRY("%p, %p, %p", image_handle
, exit_data_size
, exit_data
);
1546 entry
= info
->reserved
;
1548 efi_is_direct_boot
= false;
1550 /* call the image! */
1551 if (setjmp(&info
->exit_jmp
)) {
1553 * We called the entry point of the child image with EFI_CALL
1554 * in the lines below. The child image called the Exit() boot
1555 * service efi_exit() which executed the long jump that brought
1556 * us to the current line. This implies that the second half
1557 * of the EFI_CALL macro has not been executed.
1561 * efi_exit() called efi_restore_gd(). We have to undo this
1562 * otherwise __efi_entry_check() will put the wrong value into
1568 * To get ready to call EFI_EXIT below we have to execute the
1569 * missed out steps of EFI_CALL.
1571 assert(__efi_entry_check());
1572 debug("%sEFI: %lu returned by started image\n",
1573 __efi_nesting_dec(),
1574 (unsigned long)((uintptr_t)info
->exit_status
&
1576 return EFI_EXIT(info
->exit_status
);
1579 ret
= EFI_CALL(entry(image_handle
, &systab
));
1582 * Usually UEFI applications call Exit() instead of returning.
1583 * But because the world doesn not consist of ponies and unicorns,
1584 * we're happy to emulate that behavior on behalf of a payload
1587 return EFI_CALL(systab
.boottime
->exit(image_handle
, ret
, 0, NULL
));
1591 * Leave an EFI application or driver.
1593 * This function implements the Exit service.
1594 * See the Unified Extensible Firmware Interface (UEFI) specification
1597 * @image_handle handle of the application or driver that is exiting
1598 * @exit_status status code
1599 * @exit_data_size size of the buffer in bytes
1600 * @exit_data buffer with data describing an error
1601 * @return status code
1603 static efi_status_t EFIAPI
efi_exit(efi_handle_t image_handle
,
1604 efi_status_t exit_status
, unsigned long exit_data_size
,
1608 * We require that the handle points to the original loaded
1609 * image protocol interface.
1611 * For getting the longjmp address this is safer than locating
1612 * the protocol because the protocol may have been reinstalled
1613 * pointing to another memory location.
1615 * TODO: We should call the unload procedure of the loaded
1618 struct efi_loaded_image
*loaded_image_info
= (void*)image_handle
;
1620 EFI_ENTRY("%p, %ld, %ld, %p", image_handle
, exit_status
,
1621 exit_data_size
, exit_data
);
1623 /* Make sure entry/exit counts for EFI world cross-overs match */
1624 EFI_EXIT(exit_status
);
1627 * But longjmp out with the U-Boot gd, not the application's, as
1628 * the other end is a setjmp call inside EFI context.
1632 loaded_image_info
->exit_status
= exit_status
;
1633 longjmp(&loaded_image_info
->exit_jmp
, 1);
1635 panic("EFI application exited");
1639 * Unload an EFI image.
1641 * This function implements the UnloadImage service.
1642 * See the Unified Extensible Firmware Interface (UEFI) specification
1645 * @image_handle handle of the image to be unloaded
1646 * @return status code
1648 static efi_status_t EFIAPI
efi_unload_image(efi_handle_t image_handle
)
1650 struct efi_object
*efiobj
;
1652 EFI_ENTRY("%p", image_handle
);
1653 efiobj
= efi_search_obj(image_handle
);
1655 list_del(&efiobj
->link
);
1657 return EFI_EXIT(EFI_SUCCESS
);
1661 * Fix up caches for EFI payloads if necessary.
1663 static void efi_exit_caches(void)
1665 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1667 * Grub on 32bit ARM needs to have caches disabled before jumping into
1668 * a zImage, but does not know of all cache layers. Give it a hand.
1670 if (efi_is_direct_boot
)
1671 cleanup_before_linux();
1676 * Stop all boot services.
1678 * This function implements the ExitBootServices service.
1679 * See the Unified Extensible Firmware Interface (UEFI) specification
1682 * All timer events are disabled.
1683 * For exit boot services events the notification function is called.
1684 * The boot services are disabled in the system table.
1686 * @image_handle handle of the loaded image
1687 * @map_key key of the memory map
1688 * @return status code
1690 static efi_status_t EFIAPI
efi_exit_boot_services(efi_handle_t image_handle
,
1691 unsigned long map_key
)
1695 EFI_ENTRY("%p, %ld", image_handle
, map_key
);
1697 /* Make sure that notification functions are not called anymore */
1698 efi_tpl
= TPL_HIGH_LEVEL
;
1700 /* Check if ExitBootServices has already been called */
1701 if (!systab
.boottime
)
1702 return EFI_EXIT(EFI_SUCCESS
);
1704 /* Notify that ExitBootServices is invoked. */
1705 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
1706 if (efi_events
[i
].type
!= EVT_SIGNAL_EXIT_BOOT_SERVICES
)
1708 efi_events
[i
].is_signaled
= true;
1709 efi_signal_event(&efi_events
[i
], false);
1712 /* TODO Should persist EFI variables here */
1714 board_quiesce_devices();
1716 /* Fix up caches for EFI payloads if necessary */
1719 /* This stops all lingering devices */
1720 bootm_disable_interrupts();
1722 /* Disable boottime services */
1723 systab
.con_in_handle
= NULL
;
1724 systab
.con_in
= NULL
;
1725 systab
.con_out_handle
= NULL
;
1726 systab
.con_out
= NULL
;
1727 systab
.stderr_handle
= NULL
;
1728 systab
.std_err
= NULL
;
1729 systab
.boottime
= NULL
;
1731 /* Recalculate CRC32 */
1732 systab
.hdr
.crc32
= 0;
1733 systab
.hdr
.crc32
= crc32(0, (const unsigned char *)&systab
,
1734 sizeof(struct efi_system_table
));
1736 /* Give the payload some time to boot */
1737 efi_set_watchdog(0);
1740 return EFI_EXIT(EFI_SUCCESS
);
1744 * Get next value of the counter.
1746 * This function implements the NextMonotonicCount service.
1747 * See the Unified Extensible Firmware Interface (UEFI) specification
1750 * @count returned value of the counter
1751 * @return status code
1753 static efi_status_t EFIAPI
efi_get_next_monotonic_count(uint64_t *count
)
1755 static uint64_t mono
= 0;
1756 EFI_ENTRY("%p", count
);
1758 return EFI_EXIT(EFI_SUCCESS
);
1764 * This function implements the Stall sercive.
1765 * See the Unified Extensible Firmware Interface (UEFI) specification
1768 * @microseconds period to sleep in microseconds
1769 * @return status code
1771 static efi_status_t EFIAPI
efi_stall(unsigned long microseconds
)
1773 EFI_ENTRY("%ld", microseconds
);
1774 udelay(microseconds
);
1775 return EFI_EXIT(EFI_SUCCESS
);
1779 * Reset the watchdog timer.
1781 * This function implements the SetWatchdogTimer service.
1782 * See the Unified Extensible Firmware Interface (UEFI) specification
1785 * @timeout seconds before reset by watchdog
1786 * @watchdog_code code to be logged when resetting
1787 * @data_size size of buffer in bytes
1788 * @watchdog_data buffer with data describing the reset reason
1789 * @return status code
1791 static efi_status_t EFIAPI
efi_set_watchdog_timer(unsigned long timeout
,
1792 uint64_t watchdog_code
,
1793 unsigned long data_size
,
1794 uint16_t *watchdog_data
)
1796 EFI_ENTRY("%ld, 0x%"PRIx64
", %ld, %p", timeout
, watchdog_code
,
1797 data_size
, watchdog_data
);
1798 return EFI_EXIT(efi_set_watchdog(timeout
));
1804 * This function implements the CloseProtocol service.
1805 * See the Unified Extensible Firmware Interface (UEFI) specification
1808 * @handle handle on which the protocol shall be closed
1809 * @protocol GUID of the protocol to close
1810 * @agent_handle handle of the driver
1811 * @controller_handle handle of the controller
1812 * @return status code
1814 static efi_status_t EFIAPI
efi_close_protocol(efi_handle_t handle
,
1815 const efi_guid_t
*protocol
,
1816 efi_handle_t agent_handle
,
1817 efi_handle_t controller_handle
)
1819 struct efi_handler
*handler
;
1820 struct efi_open_protocol_info_item
*item
;
1821 struct efi_open_protocol_info_item
*pos
;
1824 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, agent_handle
,
1827 if (!agent_handle
) {
1828 r
= EFI_INVALID_PARAMETER
;
1831 r
= efi_search_protocol(handle
, protocol
, &handler
);
1832 if (r
!= EFI_SUCCESS
)
1836 list_for_each_entry_safe(item
, pos
, &handler
->open_infos
, link
) {
1837 if (item
->info
.agent_handle
== agent_handle
&&
1838 item
->info
.controller_handle
== controller_handle
) {
1839 efi_delete_open_info(item
);
1849 * Provide information about then open status of a protocol on a handle
1851 * This function implements the OpenProtocolInformation service.
1852 * See the Unified Extensible Firmware Interface (UEFI) specification
1855 * @handle handle for which the information shall be retrieved
1856 * @protocol GUID of the protocol
1857 * @entry_buffer buffer to receive the open protocol information
1858 * @entry_count number of entries available in the buffer
1859 * @return status code
1861 static efi_status_t EFIAPI
efi_open_protocol_information(efi_handle_t handle
,
1862 const efi_guid_t
*protocol
,
1863 struct efi_open_protocol_info_entry
**entry_buffer
,
1864 efi_uintn_t
*entry_count
)
1866 unsigned long buffer_size
;
1867 unsigned long count
;
1868 struct efi_handler
*handler
;
1869 struct efi_open_protocol_info_item
*item
;
1872 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, entry_buffer
,
1875 /* Check parameters */
1876 if (!entry_buffer
) {
1877 r
= EFI_INVALID_PARAMETER
;
1880 r
= efi_search_protocol(handle
, protocol
, &handler
);
1881 if (r
!= EFI_SUCCESS
)
1886 list_for_each_entry(item
, &handler
->open_infos
, link
) {
1887 if (item
->info
.open_count
)
1890 *entry_count
= count
;
1891 *entry_buffer
= NULL
;
1898 buffer_size
= count
* sizeof(struct efi_open_protocol_info_entry
);
1899 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
1900 (void **)entry_buffer
);
1901 if (r
!= EFI_SUCCESS
)
1903 list_for_each_entry_reverse(item
, &handler
->open_infos
, link
) {
1904 if (item
->info
.open_count
)
1905 (*entry_buffer
)[--count
] = item
->info
;
1912 * Get protocols installed on a handle.
1914 * This function implements the ProtocolsPerHandleService.
1915 * See the Unified Extensible Firmware Interface (UEFI) specification
1918 * @handle handle for which the information is retrieved
1919 * @protocol_buffer buffer with protocol GUIDs
1920 * @protocol_buffer_count number of entries in the buffer
1921 * @return status code
1923 static efi_status_t EFIAPI
efi_protocols_per_handle(
1924 efi_handle_t handle
, efi_guid_t
***protocol_buffer
,
1925 efi_uintn_t
*protocol_buffer_count
)
1927 unsigned long buffer_size
;
1928 struct efi_object
*efiobj
;
1929 struct list_head
*protocol_handle
;
1932 EFI_ENTRY("%p, %p, %p", handle
, protocol_buffer
,
1933 protocol_buffer_count
);
1935 if (!handle
|| !protocol_buffer
|| !protocol_buffer_count
)
1936 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1938 *protocol_buffer
= NULL
;
1939 *protocol_buffer_count
= 0;
1941 efiobj
= efi_search_obj(handle
);
1943 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1945 /* Count protocols */
1946 list_for_each(protocol_handle
, &efiobj
->protocols
) {
1947 ++*protocol_buffer_count
;
1951 if (*protocol_buffer_count
) {
1954 buffer_size
= sizeof(efi_guid_t
*) * *protocol_buffer_count
;
1955 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
1956 (void **)protocol_buffer
);
1957 if (r
!= EFI_SUCCESS
)
1959 list_for_each(protocol_handle
, &efiobj
->protocols
) {
1960 struct efi_handler
*protocol
;
1962 protocol
= list_entry(protocol_handle
,
1963 struct efi_handler
, link
);
1964 (*protocol_buffer
)[j
] = (void *)protocol
->guid
;
1969 return EFI_EXIT(EFI_SUCCESS
);
1973 * Locate handles implementing a protocol.
1975 * This function implements the LocateHandleBuffer service.
1976 * See the Unified Extensible Firmware Interface (UEFI) specification
1979 * @search_type selection criterion
1980 * @protocol GUID of the protocol
1981 * @search_key registration key
1982 * @no_handles number of returned handles
1983 * @buffer buffer with the returned handles
1984 * @return status code
1986 static efi_status_t EFIAPI
efi_locate_handle_buffer(
1987 enum efi_locate_search_type search_type
,
1988 const efi_guid_t
*protocol
, void *search_key
,
1989 efi_uintn_t
*no_handles
, efi_handle_t
**buffer
)
1992 efi_uintn_t buffer_size
= 0;
1994 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
1995 no_handles
, buffer
);
1997 if (!no_handles
|| !buffer
) {
1998 r
= EFI_INVALID_PARAMETER
;
2003 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
2005 if (r
!= EFI_BUFFER_TOO_SMALL
)
2007 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
2009 if (r
!= EFI_SUCCESS
)
2011 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
2013 if (r
== EFI_SUCCESS
)
2014 *no_handles
= buffer_size
/ sizeof(efi_handle_t
);
2020 * Find an interface implementing a protocol.
2022 * This function implements the LocateProtocol service.
2023 * See the Unified Extensible Firmware Interface (UEFI) specification
2026 * @protocol GUID of the protocol
2027 * @registration registration key passed to the notification function
2028 * @protocol_interface interface implementing the protocol
2029 * @return status code
2031 static efi_status_t EFIAPI
efi_locate_protocol(const efi_guid_t
*protocol
,
2033 void **protocol_interface
)
2035 struct list_head
*lhandle
;
2038 EFI_ENTRY("%pUl, %p, %p", protocol
, registration
, protocol_interface
);
2040 if (!protocol
|| !protocol_interface
)
2041 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2043 list_for_each(lhandle
, &efi_obj_list
) {
2044 struct efi_object
*efiobj
;
2045 struct efi_handler
*handler
;
2047 efiobj
= list_entry(lhandle
, struct efi_object
, link
);
2049 ret
= efi_search_protocol(efiobj
->handle
, protocol
, &handler
);
2050 if (ret
== EFI_SUCCESS
) {
2051 *protocol_interface
= handler
->protocol_interface
;
2052 return EFI_EXIT(EFI_SUCCESS
);
2055 *protocol_interface
= NULL
;
2057 return EFI_EXIT(EFI_NOT_FOUND
);
2061 * Get the device path and handle of an device implementing a protocol.
2063 * This function implements the LocateDevicePath service.
2064 * See the Unified Extensible Firmware Interface (UEFI) specification
2067 * @protocol GUID of the protocol
2068 * @device_path device path
2069 * @device handle of the device
2070 * @return status code
2072 static efi_status_t EFIAPI
efi_locate_device_path(
2073 const efi_guid_t
*protocol
,
2074 struct efi_device_path
**device_path
,
2075 efi_handle_t
*device
)
2077 struct efi_device_path
*dp
;
2079 struct efi_handler
*handler
;
2080 efi_handle_t
*handles
;
2082 size_t len_best
= 0;
2083 efi_uintn_t no_handles
;
2087 EFI_ENTRY("%pUl, %p, %p", protocol
, device_path
, device
);
2089 if (!protocol
|| !device_path
|| !*device_path
|| !device
) {
2090 ret
= EFI_INVALID_PARAMETER
;
2094 /* Find end of device path */
2095 len
= efi_dp_size(*device_path
);
2097 /* Get all handles implementing the protocol */
2098 ret
= EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL
, protocol
, NULL
,
2099 &no_handles
, &handles
));
2100 if (ret
!= EFI_SUCCESS
)
2103 for (i
= 0; i
< no_handles
; ++i
) {
2104 /* Find the device path protocol */
2105 ret
= efi_search_protocol(handles
[i
], &efi_guid_device_path
,
2107 if (ret
!= EFI_SUCCESS
)
2109 dp
= (struct efi_device_path
*)handler
->protocol_interface
;
2110 len_dp
= efi_dp_size(dp
);
2112 * This handle can only be a better fit
2113 * if its device path length is longer than the best fit and
2114 * if its device path length is shorter of equal the searched
2117 if (len_dp
<= len_best
|| len_dp
> len
)
2119 /* Check if dp is a subpath of device_path */
2120 if (memcmp(*device_path
, dp
, len_dp
))
2122 *device
= handles
[i
];
2126 remainder
= (u8
*)*device_path
+ len_best
;
2127 *device_path
= (struct efi_device_path
*)remainder
;
2130 ret
= EFI_NOT_FOUND
;
2133 return EFI_EXIT(ret
);
2137 * Install multiple protocol interfaces.
2139 * This function implements the MultipleProtocolInterfaces service.
2140 * See the Unified Extensible Firmware Interface (UEFI) specification
2143 * @handle handle on which the protocol interfaces shall be installed
2144 * @... NULL terminated argument list with pairs of protocol GUIDS and
2146 * @return status code
2148 static efi_status_t EFIAPI
efi_install_multiple_protocol_interfaces(
2151 EFI_ENTRY("%p", handle
);
2154 const efi_guid_t
*protocol
;
2155 void *protocol_interface
;
2156 efi_status_t r
= EFI_SUCCESS
;
2160 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2162 va_start(argptr
, handle
);
2164 protocol
= va_arg(argptr
, efi_guid_t
*);
2167 protocol_interface
= va_arg(argptr
, void*);
2168 r
= EFI_CALL(efi_install_protocol_interface(
2170 EFI_NATIVE_INTERFACE
,
2171 protocol_interface
));
2172 if (r
!= EFI_SUCCESS
)
2177 if (r
== EFI_SUCCESS
)
2180 /* If an error occurred undo all changes. */
2181 va_start(argptr
, handle
);
2183 protocol
= va_arg(argptr
, efi_guid_t
*);
2184 protocol_interface
= va_arg(argptr
, void*);
2185 EFI_CALL(efi_uninstall_protocol_interface(handle
, protocol
,
2186 protocol_interface
));
2194 * Uninstall multiple protocol interfaces.
2196 * This function implements the UninstallMultipleProtocolInterfaces service.
2197 * See the Unified Extensible Firmware Interface (UEFI) specification
2200 * @handle handle from which the protocol interfaces shall be removed
2201 * @... NULL terminated argument list with pairs of protocol GUIDS and
2203 * @return status code
2205 static efi_status_t EFIAPI
efi_uninstall_multiple_protocol_interfaces(
2208 EFI_ENTRY("%p", handle
);
2211 const efi_guid_t
*protocol
;
2212 void *protocol_interface
;
2213 efi_status_t r
= EFI_SUCCESS
;
2217 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2219 va_start(argptr
, handle
);
2221 protocol
= va_arg(argptr
, efi_guid_t
*);
2224 protocol_interface
= va_arg(argptr
, void*);
2225 r
= EFI_CALL(efi_uninstall_protocol_interface(
2227 protocol_interface
));
2228 if (r
!= EFI_SUCCESS
)
2233 if (r
== EFI_SUCCESS
)
2236 /* If an error occurred undo all changes. */
2237 va_start(argptr
, handle
);
2239 protocol
= va_arg(argptr
, efi_guid_t
*);
2240 protocol_interface
= va_arg(argptr
, void*);
2241 EFI_CALL(efi_install_protocol_interface(&handle
, protocol
,
2242 EFI_NATIVE_INTERFACE
,
2243 protocol_interface
));
2251 * Calculate cyclic redundancy code.
2253 * This function implements the CalculateCrc32 service.
2254 * See the Unified Extensible Firmware Interface (UEFI) specification
2257 * @data buffer with data
2258 * @data_size size of buffer in bytes
2259 * @crc32_p cyclic redundancy code
2260 * @return status code
2262 static efi_status_t EFIAPI
efi_calculate_crc32(void *data
,
2263 unsigned long data_size
,
2266 EFI_ENTRY("%p, %ld", data
, data_size
);
2267 *crc32_p
= crc32(0, data
, data_size
);
2268 return EFI_EXIT(EFI_SUCCESS
);
2274 * This function implements the CopyMem service.
2275 * See the Unified Extensible Firmware Interface (UEFI) specification
2278 * @destination destination of the copy operation
2279 * @source source of the copy operation
2280 * @length number of bytes to copy
2282 static void EFIAPI
efi_copy_mem(void *destination
, const void *source
,
2285 EFI_ENTRY("%p, %p, %ld", destination
, source
, (unsigned long)length
);
2286 memcpy(destination
, source
, length
);
2287 EFI_EXIT(EFI_SUCCESS
);
2291 * Fill memory with a byte value.
2293 * This function implements the SetMem service.
2294 * See the Unified Extensible Firmware Interface (UEFI) specification
2297 * @buffer buffer to fill
2298 * @size size of buffer in bytes
2299 * @value byte to copy to the buffer
2301 static void EFIAPI
efi_set_mem(void *buffer
, size_t size
, uint8_t value
)
2303 EFI_ENTRY("%p, %ld, 0x%x", buffer
, (unsigned long)size
, value
);
2304 memset(buffer
, value
, size
);
2305 EFI_EXIT(EFI_SUCCESS
);
2309 * Open protocol interface on a handle.
2311 * @handler handler of a protocol
2312 * @protocol_interface interface implementing the protocol
2313 * @agent_handle handle of the driver
2314 * @controller_handle handle of the controller
2315 * @attributes attributes indicating how to open the protocol
2316 * @return status code
2318 static efi_status_t
efi_protocol_open(
2319 struct efi_handler
*handler
,
2320 void **protocol_interface
, void *agent_handle
,
2321 void *controller_handle
, uint32_t attributes
)
2323 struct efi_open_protocol_info_item
*item
;
2324 struct efi_open_protocol_info_entry
*match
= NULL
;
2325 bool opened_by_driver
= false;
2326 bool opened_exclusive
= false;
2328 /* If there is no agent, only return the interface */
2332 /* For TEST_PROTOCOL ignore interface attribute */
2333 if (attributes
!= EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
2334 *protocol_interface
= NULL
;
2337 * Check if the protocol is already opened by a driver with the same
2338 * attributes or opened exclusively
2340 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2341 if (item
->info
.agent_handle
== agent_handle
) {
2342 if ((attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) &&
2343 (item
->info
.attributes
== attributes
))
2344 return EFI_ALREADY_STARTED
;
2346 if (item
->info
.attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
)
2347 opened_exclusive
= true;
2350 /* Only one controller can open the protocol exclusively */
2351 if (opened_exclusive
&& attributes
&
2352 (EFI_OPEN_PROTOCOL_EXCLUSIVE
| EFI_OPEN_PROTOCOL_BY_DRIVER
))
2353 return EFI_ACCESS_DENIED
;
2355 /* Prepare exclusive opening */
2356 if (attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
) {
2357 /* Try to disconnect controllers */
2358 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2359 if (item
->info
.attributes
==
2360 EFI_OPEN_PROTOCOL_BY_DRIVER
)
2361 EFI_CALL(efi_disconnect_controller(
2362 item
->info
.controller_handle
,
2363 item
->info
.agent_handle
,
2366 opened_by_driver
= false;
2367 /* Check if all controllers are disconnected */
2368 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2369 if (item
->info
.attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
)
2370 opened_by_driver
= true;
2372 /* Only one controller can be conncected */
2373 if (opened_by_driver
)
2374 return EFI_ACCESS_DENIED
;
2377 /* Find existing entry */
2378 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2379 if (item
->info
.agent_handle
== agent_handle
&&
2380 item
->info
.controller_handle
== controller_handle
)
2381 match
= &item
->info
;
2383 /* None found, create one */
2385 match
= efi_create_open_info(handler
);
2387 return EFI_OUT_OF_RESOURCES
;
2390 match
->agent_handle
= agent_handle
;
2391 match
->controller_handle
= controller_handle
;
2392 match
->attributes
= attributes
;
2393 match
->open_count
++;
2396 /* For TEST_PROTOCOL ignore interface attribute. */
2397 if (attributes
!= EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
2398 *protocol_interface
= handler
->protocol_interface
;
2404 * Open protocol interface on a handle.
2406 * This function implements the OpenProtocol interface.
2407 * See the Unified Extensible Firmware Interface (UEFI) specification
2410 * @handle handle on which the protocol shall be opened
2411 * @protocol GUID of the protocol
2412 * @protocol_interface interface implementing the protocol
2413 * @agent_handle handle of the driver
2414 * @controller_handle handle of the controller
2415 * @attributes attributes indicating how to open the protocol
2416 * @return status code
2418 static efi_status_t EFIAPI
efi_open_protocol(
2419 void *handle
, const efi_guid_t
*protocol
,
2420 void **protocol_interface
, void *agent_handle
,
2421 void *controller_handle
, uint32_t attributes
)
2423 struct efi_handler
*handler
;
2424 efi_status_t r
= EFI_INVALID_PARAMETER
;
2426 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle
, protocol
,
2427 protocol_interface
, agent_handle
, controller_handle
,
2430 if (!handle
|| !protocol
||
2431 (!protocol_interface
&& attributes
!=
2432 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)) {
2436 switch (attributes
) {
2437 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
:
2438 case EFI_OPEN_PROTOCOL_GET_PROTOCOL
:
2439 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL
:
2441 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
:
2442 if (controller_handle
== handle
)
2445 case EFI_OPEN_PROTOCOL_BY_DRIVER
:
2446 case EFI_OPEN_PROTOCOL_BY_DRIVER
| EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2447 /* Check that the controller handle is valid */
2448 if (!efi_search_obj(controller_handle
))
2451 case EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2452 /* Check that the agent handle is valid */
2453 if (!efi_search_obj(agent_handle
))
2460 r
= efi_search_protocol(handle
, protocol
, &handler
);
2461 if (r
!= EFI_SUCCESS
)
2464 r
= efi_protocol_open(handler
, protocol_interface
, agent_handle
,
2465 controller_handle
, attributes
);
2471 * Get interface of a protocol on a handle.
2473 * This function implements the HandleProtocol service.
2474 * See the Unified Extensible Firmware Interface (UEFI) specification
2477 * @handle handle on which the protocol shall be opened
2478 * @protocol GUID of the protocol
2479 * @protocol_interface interface implementing the protocol
2480 * @return status code
2482 static efi_status_t EFIAPI
efi_handle_protocol(efi_handle_t handle
,
2483 const efi_guid_t
*protocol
,
2484 void **protocol_interface
)
2486 return efi_open_protocol(handle
, protocol
, protocol_interface
, NULL
,
2487 NULL
, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
);
2490 static efi_status_t
efi_bind_controller(
2491 efi_handle_t controller_handle
,
2492 efi_handle_t driver_image_handle
,
2493 struct efi_device_path
*remain_device_path
)
2495 struct efi_driver_binding_protocol
*binding_protocol
;
2498 r
= EFI_CALL(efi_open_protocol(driver_image_handle
,
2499 &efi_guid_driver_binding_protocol
,
2500 (void **)&binding_protocol
,
2501 driver_image_handle
, NULL
,
2502 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
2503 if (r
!= EFI_SUCCESS
)
2505 r
= EFI_CALL(binding_protocol
->supported(binding_protocol
,
2507 remain_device_path
));
2508 if (r
== EFI_SUCCESS
)
2509 r
= EFI_CALL(binding_protocol
->start(binding_protocol
,
2511 remain_device_path
));
2512 EFI_CALL(efi_close_protocol(driver_image_handle
,
2513 &efi_guid_driver_binding_protocol
,
2514 driver_image_handle
, NULL
));
2518 static efi_status_t
efi_connect_single_controller(
2519 efi_handle_t controller_handle
,
2520 efi_handle_t
*driver_image_handle
,
2521 struct efi_device_path
*remain_device_path
)
2523 efi_handle_t
*buffer
;
2527 size_t connected
= 0;
2529 /* Get buffer with all handles with driver binding protocol */
2530 r
= EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL
,
2531 &efi_guid_driver_binding_protocol
,
2532 NULL
, &count
, &buffer
));
2533 if (r
!= EFI_SUCCESS
)
2536 /* Context Override */
2537 if (driver_image_handle
) {
2538 for (; *driver_image_handle
; ++driver_image_handle
) {
2539 for (i
= 0; i
< count
; ++i
) {
2540 if (buffer
[i
] == *driver_image_handle
) {
2542 r
= efi_bind_controller(
2544 *driver_image_handle
,
2545 remain_device_path
);
2547 * For drivers that do not support the
2548 * controller or are already connected
2549 * we receive an error code here.
2551 if (r
== EFI_SUCCESS
)
2559 * TODO: Some overrides are not yet implemented:
2560 * - Platform Driver Override
2561 * - Driver Family Override Search
2562 * - Bus Specific Driver Override
2565 /* Driver Binding Search */
2566 for (i
= 0; i
< count
; ++i
) {
2568 r
= efi_bind_controller(controller_handle
,
2570 remain_device_path
);
2571 if (r
== EFI_SUCCESS
)
2576 efi_free_pool(buffer
);
2578 return EFI_NOT_FOUND
;
2583 * Connect a controller to a driver.
2585 * This function implements the ConnectController service.
2586 * See the Unified Extensible Firmware Interface (UEFI) specification
2589 * First all driver binding protocol handles are tried for binding drivers.
2590 * Afterwards all handles that have openened a protocol of the controller
2591 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2593 * @controller_handle handle of the controller
2594 * @driver_image_handle handle of the driver
2595 * @remain_device_path device path of a child controller
2596 * @recursive true to connect all child controllers
2597 * @return status code
2599 static efi_status_t EFIAPI
efi_connect_controller(
2600 efi_handle_t controller_handle
,
2601 efi_handle_t
*driver_image_handle
,
2602 struct efi_device_path
*remain_device_path
,
2606 efi_status_t ret
= EFI_NOT_FOUND
;
2607 struct efi_object
*efiobj
;
2609 EFI_ENTRY("%p, %p, %p, %d", controller_handle
, driver_image_handle
,
2610 remain_device_path
, recursive
);
2612 efiobj
= efi_search_obj(controller_handle
);
2614 ret
= EFI_INVALID_PARAMETER
;
2618 r
= efi_connect_single_controller(controller_handle
,
2619 driver_image_handle
,
2620 remain_device_path
);
2621 if (r
== EFI_SUCCESS
)
2624 struct efi_handler
*handler
;
2625 struct efi_open_protocol_info_item
*item
;
2627 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
2628 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2629 if (item
->info
.attributes
&
2630 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) {
2631 r
= EFI_CALL(efi_connect_controller(
2632 item
->info
.controller_handle
,
2633 driver_image_handle
,
2636 if (r
== EFI_SUCCESS
)
2642 /* Check for child controller specified by end node */
2643 if (ret
!= EFI_SUCCESS
&& remain_device_path
&&
2644 remain_device_path
->type
== DEVICE_PATH_TYPE_END
)
2647 return EFI_EXIT(ret
);
2651 * Get all child controllers associated to a driver.
2652 * The allocated buffer has to be freed with free().
2654 * @efiobj handle of the controller
2655 * @driver_handle handle of the driver
2656 * @number_of_children number of child controllers
2657 * @child_handle_buffer handles of the the child controllers
2659 static efi_status_t
efi_get_child_controllers(
2660 struct efi_object
*efiobj
,
2661 efi_handle_t driver_handle
,
2662 efi_uintn_t
*number_of_children
,
2663 efi_handle_t
**child_handle_buffer
)
2665 struct efi_handler
*handler
;
2666 struct efi_open_protocol_info_item
*item
;
2667 efi_uintn_t count
= 0, i
;
2670 /* Count all child controller associations */
2671 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
2672 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2673 if (item
->info
.agent_handle
== driver_handle
&&
2674 item
->info
.attributes
&
2675 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
)
2680 * Create buffer. In case of duplicate child controller assignments
2681 * the buffer will be too large. But that does not harm.
2683 *number_of_children
= 0;
2684 *child_handle_buffer
= calloc(count
, sizeof(efi_handle_t
));
2685 if (!*child_handle_buffer
)
2686 return EFI_OUT_OF_RESOURCES
;
2687 /* Copy unique child handles */
2688 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
2689 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2690 if (item
->info
.agent_handle
== driver_handle
&&
2691 item
->info
.attributes
&
2692 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) {
2693 /* Check this is a new child controller */
2695 for (i
= 0; i
< *number_of_children
; ++i
) {
2696 if ((*child_handle_buffer
)[i
] ==
2697 item
->info
.controller_handle
)
2700 /* Copy handle to buffer */
2702 i
= (*number_of_children
)++;
2703 (*child_handle_buffer
)[i
] =
2704 item
->info
.controller_handle
;
2713 * Disconnect a controller from a driver.
2715 * This function implements the DisconnectController service.
2716 * See the Unified Extensible Firmware Interface (UEFI) specification
2719 * @controller_handle handle of the controller
2720 * @driver_image_handle handle of the driver
2721 * @child_handle handle of the child to destroy
2722 * @return status code
2724 static efi_status_t EFIAPI
efi_disconnect_controller(
2725 efi_handle_t controller_handle
,
2726 efi_handle_t driver_image_handle
,
2727 efi_handle_t child_handle
)
2729 struct efi_driver_binding_protocol
*binding_protocol
;
2730 efi_handle_t
*child_handle_buffer
= NULL
;
2731 size_t number_of_children
= 0;
2733 size_t stop_count
= 0;
2734 struct efi_object
*efiobj
;
2736 EFI_ENTRY("%p, %p, %p", controller_handle
, driver_image_handle
,
2739 efiobj
= efi_search_obj(controller_handle
);
2741 r
= EFI_INVALID_PARAMETER
;
2745 if (child_handle
&& !efi_search_obj(child_handle
)) {
2746 r
= EFI_INVALID_PARAMETER
;
2750 /* If no driver handle is supplied, disconnect all drivers */
2751 if (!driver_image_handle
) {
2752 r
= efi_disconnect_all_drivers(efiobj
, NULL
, child_handle
);
2756 /* Create list of child handles */
2758 number_of_children
= 1;
2759 child_handle_buffer
= &child_handle
;
2761 efi_get_child_controllers(efiobj
,
2762 driver_image_handle
,
2763 &number_of_children
,
2764 &child_handle_buffer
);
2767 /* Get the driver binding protocol */
2768 r
= EFI_CALL(efi_open_protocol(driver_image_handle
,
2769 &efi_guid_driver_binding_protocol
,
2770 (void **)&binding_protocol
,
2771 driver_image_handle
, NULL
,
2772 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
2773 if (r
!= EFI_SUCCESS
)
2775 /* Remove the children */
2776 if (number_of_children
) {
2777 r
= EFI_CALL(binding_protocol
->stop(binding_protocol
,
2780 child_handle_buffer
));
2781 if (r
== EFI_SUCCESS
)
2784 /* Remove the driver */
2786 r
= EFI_CALL(binding_protocol
->stop(binding_protocol
,
2789 if (r
== EFI_SUCCESS
)
2791 EFI_CALL(efi_close_protocol(driver_image_handle
,
2792 &efi_guid_driver_binding_protocol
,
2793 driver_image_handle
, NULL
));
2801 free(child_handle_buffer
);
2805 static const struct efi_boot_services efi_boot_services
= {
2807 .headersize
= sizeof(struct efi_table_hdr
),
2809 .raise_tpl
= efi_raise_tpl
,
2810 .restore_tpl
= efi_restore_tpl
,
2811 .allocate_pages
= efi_allocate_pages_ext
,
2812 .free_pages
= efi_free_pages_ext
,
2813 .get_memory_map
= efi_get_memory_map_ext
,
2814 .allocate_pool
= efi_allocate_pool_ext
,
2815 .free_pool
= efi_free_pool_ext
,
2816 .create_event
= efi_create_event_ext
,
2817 .set_timer
= efi_set_timer_ext
,
2818 .wait_for_event
= efi_wait_for_event
,
2819 .signal_event
= efi_signal_event_ext
,
2820 .close_event
= efi_close_event
,
2821 .check_event
= efi_check_event
,
2822 .install_protocol_interface
= efi_install_protocol_interface
,
2823 .reinstall_protocol_interface
= efi_reinstall_protocol_interface
,
2824 .uninstall_protocol_interface
= efi_uninstall_protocol_interface
,
2825 .handle_protocol
= efi_handle_protocol
,
2827 .register_protocol_notify
= efi_register_protocol_notify
,
2828 .locate_handle
= efi_locate_handle_ext
,
2829 .locate_device_path
= efi_locate_device_path
,
2830 .install_configuration_table
= efi_install_configuration_table_ext
,
2831 .load_image
= efi_load_image
,
2832 .start_image
= efi_start_image
,
2834 .unload_image
= efi_unload_image
,
2835 .exit_boot_services
= efi_exit_boot_services
,
2836 .get_next_monotonic_count
= efi_get_next_monotonic_count
,
2838 .set_watchdog_timer
= efi_set_watchdog_timer
,
2839 .connect_controller
= efi_connect_controller
,
2840 .disconnect_controller
= efi_disconnect_controller
,
2841 .open_protocol
= efi_open_protocol
,
2842 .close_protocol
= efi_close_protocol
,
2843 .open_protocol_information
= efi_open_protocol_information
,
2844 .protocols_per_handle
= efi_protocols_per_handle
,
2845 .locate_handle_buffer
= efi_locate_handle_buffer
,
2846 .locate_protocol
= efi_locate_protocol
,
2847 .install_multiple_protocol_interfaces
= efi_install_multiple_protocol_interfaces
,
2848 .uninstall_multiple_protocol_interfaces
= efi_uninstall_multiple_protocol_interfaces
,
2849 .calculate_crc32
= efi_calculate_crc32
,
2850 .copy_mem
= efi_copy_mem
,
2851 .set_mem
= efi_set_mem
,
2855 static uint16_t __efi_runtime_data firmware_vendor
[] = L
"Das U-Boot";
2857 struct efi_system_table __efi_runtime_data systab
= {
2859 .signature
= EFI_SYSTEM_TABLE_SIGNATURE
,
2860 .revision
= 0x20005, /* 2.5 */
2861 .headersize
= sizeof(struct efi_table_hdr
),
2863 .fw_vendor
= (long)firmware_vendor
,
2864 .con_in
= (void*)&efi_con_in
,
2865 .con_out
= (void*)&efi_con_out
,
2866 .std_err
= (void*)&efi_con_out
,
2867 .runtime
= (void*)&efi_runtime_services
,
2868 .boottime
= (void*)&efi_boot_services
,
2870 .tables
= (void*)efi_conf_table
,