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>
19 DECLARE_GLOBAL_DATA_PTR
;
21 /* Task priority level */
22 static efi_uintn_t efi_tpl
= TPL_APPLICATION
;
24 /* This list contains all the EFI objects our payload has access to */
25 LIST_HEAD(efi_obj_list
);
27 /* List of all events */
28 LIST_HEAD(efi_events
);
30 /* List of all events registered by RegisterProtocolNotify() */
31 LIST_HEAD(efi_register_notify_events
);
33 /* Handle of the currently executing image */
34 static efi_handle_t current_image
;
37 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
38 * we need to do trickery with caches. Since we don't want to break the EFI
39 * aware boot path, only apply hacks when loading exiting directly (breaking
40 * direct Linux EFI booting along the way - oh well).
42 static bool efi_is_direct_boot
= true;
46 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
47 * fixed when compiling U-Boot. However, the payload does not know about that
48 * restriction so we need to manually swap its and our view of that register on
49 * EFI callback entry/exit.
51 static volatile void *efi_gd
, *app_gd
;
54 /* 1 if inside U-Boot code, 0 if inside EFI payload code */
55 static int entry_count
= 1;
56 static int nesting_level
;
57 /* GUID of the device tree table */
58 const efi_guid_t efi_guid_fdt
= EFI_FDT_GUID
;
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 /* event group ExitBootServices() invoked */
64 const efi_guid_t efi_guid_event_group_exit_boot_services
=
65 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES
;
66 /* event group SetVirtualAddressMap() invoked */
67 const efi_guid_t efi_guid_event_group_virtual_address_change
=
68 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE
;
69 /* event group memory map changed */
70 const efi_guid_t efi_guid_event_group_memory_map_change
=
71 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE
;
72 /* event group boot manager about to boot */
73 const efi_guid_t efi_guid_event_group_ready_to_boot
=
74 EFI_EVENT_GROUP_READY_TO_BOOT
;
75 /* event group ResetSystem() invoked (before ExitBootServices) */
76 const efi_guid_t efi_guid_event_group_reset_system
=
77 EFI_EVENT_GROUP_RESET_SYSTEM
;
79 static efi_status_t EFIAPI
efi_disconnect_controller(
80 efi_handle_t controller_handle
,
81 efi_handle_t driver_image_handle
,
82 efi_handle_t child_handle
);
84 /* Called on every callback entry */
85 int __efi_entry_check(void)
87 int ret
= entry_count
++ == 0;
96 /* Called on every callback exit */
97 int __efi_exit_check(void)
99 int ret
= --entry_count
== 0;
106 /* Called from do_bootefi_exec() */
107 void efi_save_gd(void)
115 * Special case handler for error/abort that just forces things back to u-boot
116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
119 void efi_restore_gd(void)
122 /* Only restore if we're already in EFI context */
130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
133 * A maximum of ten indent levels is supported. Higher indent levels will be
136 * Return: A string for indenting with two spaces per level is
139 static const char *indent_string(int level
)
141 const char *indent
= " ";
142 const int max
= strlen(indent
);
144 level
= min(max
, level
* 2);
145 return &indent
[max
- level
];
148 const char *__efi_nesting(void)
150 return indent_string(nesting_level
);
153 const char *__efi_nesting_inc(void)
155 return indent_string(nesting_level
++);
158 const char *__efi_nesting_dec(void)
160 return indent_string(--nesting_level
);
164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
168 * This function queues the notification function of the event for future
171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
174 * For the SignalEvent service see efi_signal_event_ext.
177 static void efi_queue_event(struct efi_event
*event
, bool check_tpl
)
179 if (event
->notify_function
) {
180 event
->is_queued
= true;
182 if (check_tpl
&& efi_tpl
>= event
->notify_tpl
)
184 event
->is_queued
= false;
185 EFI_CALL_VOID(event
->notify_function(event
,
186 event
->notify_context
));
188 event
->is_queued
= false;
193 * is_valid_tpl() - check if the task priority level is valid
195 * @tpl: TPL level to check
196 * Return: status code
198 efi_status_t
is_valid_tpl(efi_uintn_t tpl
)
201 case TPL_APPLICATION
:
207 return EFI_INVALID_PARAMETER
;
212 * efi_signal_event() - signal an EFI event
213 * @event: event to signal
214 * @check_tpl: check the TPL level
216 * This function signals an event. If the event belongs to an event group all
217 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
218 * their notification function is queued.
220 * For the SignalEvent service see efi_signal_event_ext.
222 void efi_signal_event(struct efi_event
*event
, bool check_tpl
)
225 struct efi_event
*evt
;
228 * The signaled state has to set before executing any
229 * notification function
231 list_for_each_entry(evt
, &efi_events
, link
) {
232 if (!evt
->group
|| guidcmp(evt
->group
, event
->group
))
234 if (evt
->is_signaled
)
236 evt
->is_signaled
= true;
237 if (evt
->type
& EVT_NOTIFY_SIGNAL
&&
238 evt
->notify_function
)
239 evt
->is_queued
= true;
241 list_for_each_entry(evt
, &efi_events
, link
) {
242 if (!evt
->group
|| guidcmp(evt
->group
, event
->group
))
245 efi_queue_event(evt
, check_tpl
);
248 event
->is_signaled
= true;
249 if (event
->type
& EVT_NOTIFY_SIGNAL
)
250 efi_queue_event(event
, check_tpl
);
255 * efi_raise_tpl() - raise the task priority level
256 * @new_tpl: new value of the task priority level
258 * This function implements the RaiseTpl service.
260 * See the Unified Extensible Firmware Interface (UEFI) specification for
263 * Return: old value of the task priority level
265 static unsigned long EFIAPI
efi_raise_tpl(efi_uintn_t new_tpl
)
267 efi_uintn_t old_tpl
= efi_tpl
;
269 EFI_ENTRY("0x%zx", new_tpl
);
271 if (new_tpl
< efi_tpl
)
272 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__
);
274 if (efi_tpl
> TPL_HIGH_LEVEL
)
275 efi_tpl
= TPL_HIGH_LEVEL
;
277 EFI_EXIT(EFI_SUCCESS
);
282 * efi_restore_tpl() - lower the task priority level
283 * @old_tpl: value of the task priority level to be restored
285 * This function implements the RestoreTpl service.
287 * See the Unified Extensible Firmware Interface (UEFI) specification for
290 static void EFIAPI
efi_restore_tpl(efi_uintn_t old_tpl
)
292 EFI_ENTRY("0x%zx", old_tpl
);
294 if (old_tpl
> efi_tpl
)
295 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__
);
297 if (efi_tpl
> TPL_HIGH_LEVEL
)
298 efi_tpl
= TPL_HIGH_LEVEL
;
301 * Lowering the TPL may have made queued events eligible for execution.
305 EFI_EXIT(EFI_SUCCESS
);
309 * efi_allocate_pages_ext() - allocate memory pages
310 * @type: type of allocation to be performed
311 * @memory_type: usage type of the allocated memory
312 * @pages: number of pages to be allocated
313 * @memory: allocated memory
315 * This function implements the AllocatePages service.
317 * See the Unified Extensible Firmware Interface (UEFI) specification for
320 * Return: status code
322 static efi_status_t EFIAPI
efi_allocate_pages_ext(int type
, int memory_type
,
328 EFI_ENTRY("%d, %d, 0x%zx, %p", type
, memory_type
, pages
, memory
);
329 r
= efi_allocate_pages(type
, memory_type
, pages
, memory
);
334 * efi_free_pages_ext() - Free memory pages.
335 * @memory: start of the memory area to be freed
336 * @pages: number of pages to be freed
338 * This function implements the FreePages service.
340 * See the Unified Extensible Firmware Interface (UEFI) specification for
343 * Return: status code
345 static efi_status_t EFIAPI
efi_free_pages_ext(uint64_t memory
,
350 EFI_ENTRY("%llx, 0x%zx", memory
, pages
);
351 r
= efi_free_pages(memory
, pages
);
356 * efi_get_memory_map_ext() - get map describing memory usage
357 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
358 * on exit the size of the copied memory map
359 * @memory_map: buffer to which the memory map is written
360 * @map_key: key for the memory map
361 * @descriptor_size: size of an individual memory descriptor
362 * @descriptor_version: version number of the memory descriptor structure
364 * This function implements the GetMemoryMap service.
366 * See the Unified Extensible Firmware Interface (UEFI) specification for
369 * Return: status code
371 static efi_status_t EFIAPI
efi_get_memory_map_ext(
372 efi_uintn_t
*memory_map_size
,
373 struct efi_mem_desc
*memory_map
,
374 efi_uintn_t
*map_key
,
375 efi_uintn_t
*descriptor_size
,
376 uint32_t *descriptor_version
)
380 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size
, memory_map
,
381 map_key
, descriptor_size
, descriptor_version
);
382 r
= efi_get_memory_map(memory_map_size
, memory_map
, map_key
,
383 descriptor_size
, descriptor_version
);
388 * efi_allocate_pool_ext() - allocate memory from pool
389 * @pool_type: type of the pool from which memory is to be allocated
390 * @size: number of bytes to be allocated
391 * @buffer: allocated memory
393 * This function implements the AllocatePool service.
395 * See the Unified Extensible Firmware Interface (UEFI) specification for
398 * Return: status code
400 static efi_status_t EFIAPI
efi_allocate_pool_ext(int pool_type
,
406 EFI_ENTRY("%d, %zd, %p", pool_type
, size
, buffer
);
407 r
= efi_allocate_pool(pool_type
, size
, buffer
);
412 * efi_free_pool_ext() - free memory from pool
413 * @buffer: start of memory to be freed
415 * This function implements the FreePool service.
417 * See the Unified Extensible Firmware Interface (UEFI) specification for
420 * Return: status code
422 static efi_status_t EFIAPI
efi_free_pool_ext(void *buffer
)
426 EFI_ENTRY("%p", buffer
);
427 r
= efi_free_pool(buffer
);
432 * efi_add_handle() - add a new handle to the object list
434 * @handle: handle to be added
436 * The protocols list is initialized. The handle is added to the list of known
439 void efi_add_handle(efi_handle_t handle
)
443 INIT_LIST_HEAD(&handle
->protocols
);
444 list_add_tail(&handle
->link
, &efi_obj_list
);
448 * efi_create_handle() - create handle
449 * @handle: new handle
451 * Return: status code
453 efi_status_t
efi_create_handle(efi_handle_t
*handle
)
455 struct efi_object
*obj
;
457 obj
= calloc(1, sizeof(struct efi_object
));
459 return EFI_OUT_OF_RESOURCES
;
468 * efi_search_protocol() - find a protocol on a handle.
470 * @protocol_guid: GUID of the protocol
471 * @handler: reference to the protocol
473 * Return: status code
475 efi_status_t
efi_search_protocol(const efi_handle_t handle
,
476 const efi_guid_t
*protocol_guid
,
477 struct efi_handler
**handler
)
479 struct efi_object
*efiobj
;
480 struct list_head
*lhandle
;
482 if (!handle
|| !protocol_guid
)
483 return EFI_INVALID_PARAMETER
;
484 efiobj
= efi_search_obj(handle
);
486 return EFI_INVALID_PARAMETER
;
487 list_for_each(lhandle
, &efiobj
->protocols
) {
488 struct efi_handler
*protocol
;
490 protocol
= list_entry(lhandle
, struct efi_handler
, link
);
491 if (!guidcmp(protocol
->guid
, protocol_guid
)) {
497 return EFI_NOT_FOUND
;
501 * efi_remove_protocol() - delete protocol from a handle
502 * @handle: handle from which the protocol shall be deleted
503 * @protocol: GUID of the protocol to be deleted
504 * @protocol_interface: interface of the protocol implementation
506 * Return: status code
508 efi_status_t
efi_remove_protocol(const efi_handle_t handle
,
509 const efi_guid_t
*protocol
,
510 void *protocol_interface
)
512 struct efi_handler
*handler
;
515 ret
= efi_search_protocol(handle
, protocol
, &handler
);
516 if (ret
!= EFI_SUCCESS
)
518 if (handler
->protocol_interface
!= protocol_interface
)
519 return EFI_NOT_FOUND
;
520 list_del(&handler
->link
);
526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
529 * Return: status code
531 efi_status_t
efi_remove_all_protocols(const efi_handle_t handle
)
533 struct efi_object
*efiobj
;
534 struct efi_handler
*protocol
;
535 struct efi_handler
*pos
;
537 efiobj
= efi_search_obj(handle
);
539 return EFI_INVALID_PARAMETER
;
540 list_for_each_entry_safe(protocol
, pos
, &efiobj
->protocols
, link
) {
543 ret
= efi_remove_protocol(handle
, protocol
->guid
,
544 protocol
->protocol_interface
);
545 if (ret
!= EFI_SUCCESS
)
552 * efi_delete_handle() - delete handle
554 * @obj: handle to delete
556 void efi_delete_handle(efi_handle_t handle
)
560 efi_remove_all_protocols(handle
);
561 list_del(&handle
->link
);
566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
569 * Return: status code
571 static efi_status_t
efi_is_event(const struct efi_event
*event
)
573 const struct efi_event
*evt
;
576 return EFI_INVALID_PARAMETER
;
577 list_for_each_entry(evt
, &efi_events
, link
) {
581 return EFI_INVALID_PARAMETER
;
585 * efi_create_event() - create an event
586 * @type: type of the event to create
587 * @notify_tpl: task priority level of the event
588 * @notify_function: notification function of the event
589 * @notify_context: pointer passed to the notification function
590 * @group: event group
591 * @event: created event
593 * This function is used inside U-Boot code to create an event.
595 * For the API function implementing the CreateEvent service see
596 * efi_create_event_ext.
598 * Return: status code
600 efi_status_t
efi_create_event(uint32_t type
, efi_uintn_t notify_tpl
,
601 void (EFIAPI
*notify_function
) (
602 struct efi_event
*event
,
604 void *notify_context
, efi_guid_t
*group
,
605 struct efi_event
**event
)
607 struct efi_event
*evt
;
610 return EFI_INVALID_PARAMETER
;
615 case EVT_NOTIFY_SIGNAL
:
616 case EVT_TIMER
| EVT_NOTIFY_SIGNAL
:
617 case EVT_NOTIFY_WAIT
:
618 case EVT_TIMER
| EVT_NOTIFY_WAIT
:
619 case EVT_SIGNAL_EXIT_BOOT_SERVICES
:
620 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
:
623 return EFI_INVALID_PARAMETER
;
626 if ((type
& (EVT_NOTIFY_WAIT
| EVT_NOTIFY_SIGNAL
)) &&
627 (!notify_function
|| is_valid_tpl(notify_tpl
) != EFI_SUCCESS
))
628 return EFI_INVALID_PARAMETER
;
630 evt
= calloc(1, sizeof(struct efi_event
));
632 return EFI_OUT_OF_RESOURCES
;
634 evt
->notify_tpl
= notify_tpl
;
635 evt
->notify_function
= notify_function
;
636 evt
->notify_context
= notify_context
;
638 /* Disable timers on boot up */
639 evt
->trigger_next
= -1ULL;
640 evt
->is_queued
= false;
641 evt
->is_signaled
= false;
642 list_add_tail(&evt
->link
, &efi_events
);
648 * efi_create_event_ex() - create an event in a group
649 * @type: type of the event to create
650 * @notify_tpl: task priority level of the event
651 * @notify_function: notification function of the event
652 * @notify_context: pointer passed to the notification function
653 * @event: created event
654 * @event_group: event group
656 * This function implements the CreateEventEx service.
658 * See the Unified Extensible Firmware Interface (UEFI) specification for
661 * Return: status code
663 efi_status_t EFIAPI
efi_create_event_ex(uint32_t type
, efi_uintn_t notify_tpl
,
664 void (EFIAPI
*notify_function
) (
665 struct efi_event
*event
,
667 void *notify_context
,
668 efi_guid_t
*event_group
,
669 struct efi_event
**event
)
673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type
, notify_tpl
, notify_function
,
674 notify_context
, event_group
);
677 * The allowable input parameters are the same as in CreateEvent()
678 * except for the following two disallowed event types.
681 case EVT_SIGNAL_EXIT_BOOT_SERVICES
:
682 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
:
683 ret
= EFI_INVALID_PARAMETER
;
687 ret
= efi_create_event(type
, notify_tpl
, notify_function
,
688 notify_context
, event_group
, event
);
690 return EFI_EXIT(ret
);
694 * efi_create_event_ext() - create an event
695 * @type: type of the event to create
696 * @notify_tpl: task priority level of the event
697 * @notify_function: notification function of the event
698 * @notify_context: pointer passed to the notification function
699 * @event: created event
701 * This function implements the CreateEvent service.
703 * See the Unified Extensible Firmware Interface (UEFI) specification for
706 * Return: status code
708 static efi_status_t EFIAPI
efi_create_event_ext(
709 uint32_t type
, efi_uintn_t notify_tpl
,
710 void (EFIAPI
*notify_function
) (
711 struct efi_event
*event
,
713 void *notify_context
, struct efi_event
**event
)
715 EFI_ENTRY("%d, 0x%zx, %p, %p", type
, notify_tpl
, notify_function
,
717 return EFI_EXIT(efi_create_event(type
, notify_tpl
, notify_function
,
718 notify_context
, NULL
, event
));
722 * efi_timer_check() - check if a timer event has occurred
724 * Check if a timer event has occurred or a queued notification function should
727 * Our timers have to work without interrupts, so we check whenever keyboard
728 * input or disk accesses happen if enough time elapsed for them to fire.
730 void efi_timer_check(void)
732 struct efi_event
*evt
;
733 u64 now
= timer_get_us();
735 list_for_each_entry(evt
, &efi_events
, link
) {
737 efi_queue_event(evt
, true);
738 if (!(evt
->type
& EVT_TIMER
) || now
< evt
->trigger_next
)
740 switch (evt
->trigger_type
) {
741 case EFI_TIMER_RELATIVE
:
742 evt
->trigger_type
= EFI_TIMER_STOP
;
744 case EFI_TIMER_PERIODIC
:
745 evt
->trigger_next
+= evt
->trigger_time
;
750 evt
->is_signaled
= false;
751 efi_signal_event(evt
, true);
757 * efi_set_timer() - set the trigger time for a timer event or stop the event
758 * @event: event for which the timer is set
759 * @type: type of the timer
760 * @trigger_time: trigger period in multiples of 100 ns
762 * This is the function for internal usage in U-Boot. For the API function
763 * implementing the SetTimer service see efi_set_timer_ext.
765 * Return: status code
767 efi_status_t
efi_set_timer(struct efi_event
*event
, enum efi_timer_delay type
,
768 uint64_t trigger_time
)
770 /* Check that the event is valid */
771 if (efi_is_event(event
) != EFI_SUCCESS
|| !(event
->type
& EVT_TIMER
))
772 return EFI_INVALID_PARAMETER
;
775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
778 do_div(trigger_time
, 10);
782 event
->trigger_next
= -1ULL;
784 case EFI_TIMER_PERIODIC
:
785 case EFI_TIMER_RELATIVE
:
786 event
->trigger_next
= timer_get_us() + trigger_time
;
789 return EFI_INVALID_PARAMETER
;
791 event
->trigger_type
= type
;
792 event
->trigger_time
= trigger_time
;
793 event
->is_signaled
= false;
798 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
800 * @event: event for which the timer is set
801 * @type: type of the timer
802 * @trigger_time: trigger period in multiples of 100 ns
804 * This function implements the SetTimer service.
806 * See the Unified Extensible Firmware Interface (UEFI) specification for
810 * Return: status code
812 static efi_status_t EFIAPI
efi_set_timer_ext(struct efi_event
*event
,
813 enum efi_timer_delay type
,
814 uint64_t trigger_time
)
816 EFI_ENTRY("%p, %d, %llx", event
, type
, trigger_time
);
817 return EFI_EXIT(efi_set_timer(event
, type
, trigger_time
));
821 * efi_wait_for_event() - wait for events to be signaled
822 * @num_events: number of events to be waited for
823 * @event: events to be waited for
824 * @index: index of the event that was signaled
826 * This function implements the WaitForEvent service.
828 * See the Unified Extensible Firmware Interface (UEFI) specification for
831 * Return: status code
833 static efi_status_t EFIAPI
efi_wait_for_event(efi_uintn_t num_events
,
834 struct efi_event
**event
,
839 EFI_ENTRY("%zd, %p, %p", num_events
, event
, index
);
841 /* Check parameters */
842 if (!num_events
|| !event
)
843 return EFI_EXIT(EFI_INVALID_PARAMETER
);
845 if (efi_tpl
!= TPL_APPLICATION
)
846 return EFI_EXIT(EFI_UNSUPPORTED
);
847 for (i
= 0; i
< num_events
; ++i
) {
848 if (efi_is_event(event
[i
]) != EFI_SUCCESS
)
849 return EFI_EXIT(EFI_INVALID_PARAMETER
);
850 if (!event
[i
]->type
|| event
[i
]->type
& EVT_NOTIFY_SIGNAL
)
851 return EFI_EXIT(EFI_INVALID_PARAMETER
);
852 if (!event
[i
]->is_signaled
)
853 efi_queue_event(event
[i
], true);
856 /* Wait for signal */
858 for (i
= 0; i
< num_events
; ++i
) {
859 if (event
[i
]->is_signaled
)
862 /* Allow events to occur. */
868 * Reset the signal which is passed to the caller to allow periodic
871 event
[i
]->is_signaled
= false;
875 return EFI_EXIT(EFI_SUCCESS
);
879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
882 * This function implements the SignalEvent service.
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
890 * Return: status code
892 static efi_status_t EFIAPI
efi_signal_event_ext(struct efi_event
*event
)
894 EFI_ENTRY("%p", event
);
895 if (efi_is_event(event
) != EFI_SUCCESS
)
896 return EFI_EXIT(EFI_INVALID_PARAMETER
);
897 efi_signal_event(event
, true);
898 return EFI_EXIT(EFI_SUCCESS
);
902 * efi_close_event() - close an EFI event
903 * @event: event to close
905 * This function implements the CloseEvent service.
907 * See the Unified Extensible Firmware Interface (UEFI) specification for
910 * Return: status code
912 static efi_status_t EFIAPI
efi_close_event(struct efi_event
*event
)
914 struct efi_register_notify_event
*item
, *next
;
916 EFI_ENTRY("%p", event
);
917 if (efi_is_event(event
) != EFI_SUCCESS
)
918 return EFI_EXIT(EFI_INVALID_PARAMETER
);
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item
, next
, &efi_register_notify_events
,
923 if (event
== item
->event
) {
924 struct efi_protocol_notification
*hitem
, *hnext
;
926 /* Remove signaled handles */
927 list_for_each_entry_safe(hitem
, hnext
, &item
->handles
,
929 list_del(&hitem
->link
);
932 list_del(&item
->link
);
937 list_del(&event
->link
);
939 return EFI_EXIT(EFI_SUCCESS
);
943 * efi_check_event() - check if an event is signaled
944 * @event: event to check
946 * This function implements the CheckEvent service.
948 * See the Unified Extensible Firmware Interface (UEFI) specification for
951 * If an event is not signaled yet, the notification function is queued. The
952 * signaled state is cleared.
954 * Return: status code
956 static efi_status_t EFIAPI
efi_check_event(struct efi_event
*event
)
958 EFI_ENTRY("%p", event
);
960 if (efi_is_event(event
) != EFI_SUCCESS
||
961 event
->type
& EVT_NOTIFY_SIGNAL
)
962 return EFI_EXIT(EFI_INVALID_PARAMETER
);
963 if (!event
->is_signaled
)
964 efi_queue_event(event
, true);
965 if (event
->is_signaled
) {
966 event
->is_signaled
= false;
967 return EFI_EXIT(EFI_SUCCESS
);
969 return EFI_EXIT(EFI_NOT_READY
);
973 * efi_search_obj() - find the internal EFI object for a handle
974 * @handle: handle to find
978 struct efi_object
*efi_search_obj(const efi_handle_t handle
)
980 struct efi_object
*efiobj
;
985 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
986 if (efiobj
== handle
)
993 * efi_open_protocol_info_entry() - create open protocol info entry and add it
995 * @handler: handler of a protocol
997 * Return: open protocol info entry
999 static struct efi_open_protocol_info_entry
*efi_create_open_info(
1000 struct efi_handler
*handler
)
1002 struct efi_open_protocol_info_item
*item
;
1004 item
= calloc(1, sizeof(struct efi_open_protocol_info_item
));
1007 /* Append the item to the open protocol info list. */
1008 list_add_tail(&item
->link
, &handler
->open_infos
);
1014 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1015 * @item: open protocol info entry to delete
1017 * Return: status code
1019 static efi_status_t
efi_delete_open_info(
1020 struct efi_open_protocol_info_item
*item
)
1022 list_del(&item
->link
);
1028 * efi_add_protocol() - install new protocol on a handle
1029 * @handle: handle on which the protocol shall be installed
1030 * @protocol: GUID of the protocol to be installed
1031 * @protocol_interface: interface of the protocol implementation
1033 * Return: status code
1035 efi_status_t
efi_add_protocol(const efi_handle_t handle
,
1036 const efi_guid_t
*protocol
,
1037 void *protocol_interface
)
1039 struct efi_object
*efiobj
;
1040 struct efi_handler
*handler
;
1042 struct efi_register_notify_event
*event
;
1044 efiobj
= efi_search_obj(handle
);
1046 return EFI_INVALID_PARAMETER
;
1047 ret
= efi_search_protocol(handle
, protocol
, NULL
);
1048 if (ret
!= EFI_NOT_FOUND
)
1049 return EFI_INVALID_PARAMETER
;
1050 handler
= calloc(1, sizeof(struct efi_handler
));
1052 return EFI_OUT_OF_RESOURCES
;
1053 handler
->guid
= protocol
;
1054 handler
->protocol_interface
= protocol_interface
;
1055 INIT_LIST_HEAD(&handler
->open_infos
);
1056 list_add_tail(&handler
->link
, &efiobj
->protocols
);
1058 /* Notify registered events */
1059 list_for_each_entry(event
, &efi_register_notify_events
, link
) {
1060 if (!guidcmp(protocol
, &event
->protocol
)) {
1061 struct efi_protocol_notification
*notif
;
1063 notif
= calloc(1, sizeof(*notif
));
1065 list_del(&handler
->link
);
1067 return EFI_OUT_OF_RESOURCES
;
1069 notif
->handle
= handle
;
1070 list_add_tail(¬if
->link
, &event
->handles
);
1071 efi_signal_event(event
->event
, true);
1075 if (!guidcmp(&efi_guid_device_path
, protocol
))
1076 EFI_PRINT("installed device path '%pD'\n", protocol_interface
);
1081 * efi_install_protocol_interface() - install protocol interface
1082 * @handle: handle on which the protocol shall be installed
1083 * @protocol: GUID of the protocol to be installed
1084 * @protocol_interface_type: type of the interface to be installed,
1085 * always EFI_NATIVE_INTERFACE
1086 * @protocol_interface: interface of the protocol implementation
1088 * This function implements the InstallProtocolInterface service.
1090 * See the Unified Extensible Firmware Interface (UEFI) specification for
1093 * Return: status code
1095 static efi_status_t EFIAPI
efi_install_protocol_interface(
1096 efi_handle_t
*handle
, const efi_guid_t
*protocol
,
1097 int protocol_interface_type
, void *protocol_interface
)
1101 EFI_ENTRY("%p, %pUl, %d, %p", handle
, protocol
, protocol_interface_type
,
1102 protocol_interface
);
1104 if (!handle
|| !protocol
||
1105 protocol_interface_type
!= EFI_NATIVE_INTERFACE
) {
1106 r
= EFI_INVALID_PARAMETER
;
1110 /* Create new handle if requested. */
1112 r
= efi_create_handle(handle
);
1113 if (r
!= EFI_SUCCESS
)
1115 EFI_PRINT("new handle %p\n", *handle
);
1117 EFI_PRINT("handle %p\n", *handle
);
1119 /* Add new protocol */
1120 r
= efi_add_protocol(*handle
, protocol
, protocol_interface
);
1126 * efi_get_drivers() - get all drivers associated to a controller
1127 * @handle: handle of the controller
1128 * @protocol: protocol GUID (optional)
1129 * @number_of_drivers: number of child controllers
1130 * @driver_handle_buffer: handles of the the drivers
1132 * The allocated buffer has to be freed with free().
1134 * Return: status code
1136 static efi_status_t
efi_get_drivers(efi_handle_t handle
,
1137 const efi_guid_t
*protocol
,
1138 efi_uintn_t
*number_of_drivers
,
1139 efi_handle_t
**driver_handle_buffer
)
1141 struct efi_handler
*handler
;
1142 struct efi_open_protocol_info_item
*item
;
1143 efi_uintn_t count
= 0, i
;
1146 /* Count all driver associations */
1147 list_for_each_entry(handler
, &handle
->protocols
, link
) {
1148 if (protocol
&& guidcmp(handler
->guid
, protocol
))
1150 list_for_each_entry(item
, &handler
->open_infos
, link
) {
1151 if (item
->info
.attributes
&
1152 EFI_OPEN_PROTOCOL_BY_DRIVER
)
1156 *number_of_drivers
= 0;
1158 *driver_handle_buffer
= NULL
;
1162 * Create buffer. In case of duplicate driver assignments the buffer
1163 * will be too large. But that does not harm.
1165 *driver_handle_buffer
= calloc(count
, sizeof(efi_handle_t
));
1166 if (!*driver_handle_buffer
)
1167 return EFI_OUT_OF_RESOURCES
;
1168 /* Collect unique driver handles */
1169 list_for_each_entry(handler
, &handle
->protocols
, link
) {
1170 if (protocol
&& guidcmp(handler
->guid
, protocol
))
1172 list_for_each_entry(item
, &handler
->open_infos
, link
) {
1173 if (item
->info
.attributes
&
1174 EFI_OPEN_PROTOCOL_BY_DRIVER
) {
1175 /* Check this is a new driver */
1177 for (i
= 0; i
< *number_of_drivers
; ++i
) {
1178 if ((*driver_handle_buffer
)[i
] ==
1179 item
->info
.agent_handle
)
1182 /* Copy handle to buffer */
1184 i
= (*number_of_drivers
)++;
1185 (*driver_handle_buffer
)[i
] =
1186 item
->info
.agent_handle
;
1195 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1196 * @handle: handle of the controller
1197 * @protocol: protocol GUID (optional)
1198 * @child_handle: handle of the child to destroy
1200 * This function implements the DisconnectController service.
1202 * See the Unified Extensible Firmware Interface (UEFI) specification for
1205 * Return: status code
1207 static efi_status_t efi_disconnect_all_drivers
1208 (efi_handle_t handle
,
1209 const efi_guid_t
*protocol
,
1210 efi_handle_t child_handle
)
1212 efi_uintn_t number_of_drivers
;
1213 efi_handle_t
*driver_handle_buffer
;
1214 efi_status_t r
, ret
;
1216 ret
= efi_get_drivers(handle
, protocol
, &number_of_drivers
,
1217 &driver_handle_buffer
);
1218 if (ret
!= EFI_SUCCESS
)
1220 if (!number_of_drivers
)
1222 ret
= EFI_NOT_FOUND
;
1223 while (number_of_drivers
) {
1224 r
= EFI_CALL(efi_disconnect_controller(
1226 driver_handle_buffer
[--number_of_drivers
],
1228 if (r
== EFI_SUCCESS
)
1231 free(driver_handle_buffer
);
1236 * efi_uninstall_protocol() - uninstall protocol interface
1238 * @handle: handle from which the protocol shall be removed
1239 * @protocol: GUID of the protocol to be removed
1240 * @protocol_interface: interface to be removed
1242 * This function DOES NOT delete a handle without installed protocol.
1244 * Return: status code
1246 static efi_status_t efi_uninstall_protocol
1247 (efi_handle_t handle
, const efi_guid_t
*protocol
,
1248 void *protocol_interface
)
1250 struct efi_object
*efiobj
;
1251 struct efi_handler
*handler
;
1252 struct efi_open_protocol_info_item
*item
;
1253 struct efi_open_protocol_info_item
*pos
;
1257 efiobj
= efi_search_obj(handle
);
1259 r
= EFI_INVALID_PARAMETER
;
1262 /* Find the protocol on the handle */
1263 r
= efi_search_protocol(handle
, protocol
, &handler
);
1264 if (r
!= EFI_SUCCESS
)
1266 /* Disconnect controllers */
1267 efi_disconnect_all_drivers(efiobj
, protocol
, NULL
);
1268 /* Close protocol */
1269 list_for_each_entry_safe(item
, pos
, &handler
->open_infos
, link
) {
1270 if (item
->info
.attributes
==
1271 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
||
1272 item
->info
.attributes
== EFI_OPEN_PROTOCOL_GET_PROTOCOL
||
1273 item
->info
.attributes
== EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
1274 list_del(&item
->link
);
1276 if (!list_empty(&handler
->open_infos
)) {
1277 r
= EFI_ACCESS_DENIED
;
1280 r
= efi_remove_protocol(handle
, protocol
, protocol_interface
);
1286 * efi_uninstall_protocol_interface() - uninstall protocol interface
1287 * @handle: handle from which the protocol shall be removed
1288 * @protocol: GUID of the protocol to be removed
1289 * @protocol_interface: interface to be removed
1291 * This function implements the UninstallProtocolInterface service.
1293 * See the Unified Extensible Firmware Interface (UEFI) specification for
1296 * Return: status code
1298 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1299 (efi_handle_t handle
, const efi_guid_t
*protocol
,
1300 void *protocol_interface
)
1304 EFI_ENTRY("%p, %pUl, %p", handle
, protocol
, protocol_interface
);
1306 ret
= efi_uninstall_protocol(handle
, protocol
, protocol_interface
);
1307 if (ret
!= EFI_SUCCESS
)
1310 /* If the last protocol has been removed, delete the handle. */
1311 if (list_empty(&handle
->protocols
)) {
1312 list_del(&handle
->link
);
1316 return EFI_EXIT(ret
);
1320 * efi_register_protocol_notify() - register an event for notification when a
1321 * protocol is installed.
1322 * @protocol: GUID of the protocol whose installation shall be notified
1323 * @event: event to be signaled upon installation of the protocol
1324 * @registration: key for retrieving the registration information
1326 * This function implements the RegisterProtocolNotify service.
1327 * See the Unified Extensible Firmware Interface (UEFI) specification
1330 * Return: status code
1332 static efi_status_t EFIAPI
efi_register_protocol_notify(
1333 const efi_guid_t
*protocol
,
1334 struct efi_event
*event
,
1335 void **registration
)
1337 struct efi_register_notify_event
*item
;
1338 efi_status_t ret
= EFI_SUCCESS
;
1340 EFI_ENTRY("%pUl, %p, %p", protocol
, event
, registration
);
1342 if (!protocol
|| !event
|| !registration
) {
1343 ret
= EFI_INVALID_PARAMETER
;
1347 item
= calloc(1, sizeof(struct efi_register_notify_event
));
1349 ret
= EFI_OUT_OF_RESOURCES
;
1353 item
->event
= event
;
1354 memcpy(&item
->protocol
, protocol
, sizeof(efi_guid_t
));
1355 INIT_LIST_HEAD(&item
->handles
);
1357 list_add_tail(&item
->link
, &efi_register_notify_events
);
1359 *registration
= item
;
1361 return EFI_EXIT(ret
);
1365 * efi_search() - determine if an EFI handle implements a protocol
1366 * @search_type: selection criterion
1367 * @protocol: GUID of the protocol
1368 * @search_key: registration key
1371 * See the documentation of the LocateHandle service in the UEFI specification.
1373 * Return: 0 if the handle implements the protocol
1375 static int efi_search(enum efi_locate_search_type search_type
,
1376 const efi_guid_t
*protocol
, efi_handle_t handle
)
1380 switch (search_type
) {
1384 ret
= efi_search_protocol(handle
, protocol
, NULL
);
1385 return (ret
!= EFI_SUCCESS
);
1387 /* Invalid search type */
1393 * efi_check_register_notify_event() - check if registration key is valid
1395 * Check that a pointer is a valid registration key as returned by
1396 * RegisterProtocolNotify().
1398 * @key: registration key
1399 * Return: valid registration key or NULL
1401 static struct efi_register_notify_event
*efi_check_register_notify_event
1404 struct efi_register_notify_event
*event
;
1406 list_for_each_entry(event
, &efi_register_notify_events
, link
) {
1407 if (event
== (struct efi_register_notify_event
*)key
)
1414 * efi_locate_handle() - locate handles implementing a protocol
1416 * @search_type: selection criterion
1417 * @protocol: GUID of the protocol
1418 * @search_key: registration key
1419 * @buffer_size: size of the buffer to receive the handles in bytes
1420 * @buffer: buffer to receive the relevant handles
1422 * This function is meant for U-Boot internal calls. For the API implementation
1423 * of the LocateHandle service see efi_locate_handle_ext.
1425 * Return: status code
1427 static efi_status_t
efi_locate_handle(
1428 enum efi_locate_search_type search_type
,
1429 const efi_guid_t
*protocol
, void *search_key
,
1430 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1432 struct efi_object
*efiobj
;
1433 efi_uintn_t size
= 0;
1434 struct efi_register_notify_event
*event
;
1435 struct efi_protocol_notification
*handle
= NULL
;
1437 /* Check parameters */
1438 switch (search_type
) {
1441 case BY_REGISTER_NOTIFY
:
1443 return EFI_INVALID_PARAMETER
;
1444 /* Check that the registration key is valid */
1445 event
= efi_check_register_notify_event(search_key
);
1447 return EFI_INVALID_PARAMETER
;
1451 return EFI_INVALID_PARAMETER
;
1454 return EFI_INVALID_PARAMETER
;
1457 /* Count how much space we need */
1458 if (search_type
== BY_REGISTER_NOTIFY
) {
1459 if (list_empty(&event
->handles
))
1460 return EFI_NOT_FOUND
;
1461 handle
= list_first_entry(&event
->handles
,
1462 struct efi_protocol_notification
,
1464 efiobj
= handle
->handle
;
1465 size
+= sizeof(void *);
1467 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1468 if (!efi_search(search_type
, protocol
, efiobj
))
1469 size
+= sizeof(void *);
1472 return EFI_NOT_FOUND
;
1476 return EFI_INVALID_PARAMETER
;
1478 if (*buffer_size
< size
) {
1479 *buffer_size
= size
;
1480 return EFI_BUFFER_TOO_SMALL
;
1483 *buffer_size
= size
;
1485 /* The buffer size is sufficient but there is no buffer */
1487 return EFI_INVALID_PARAMETER
;
1489 /* Then fill the array */
1490 if (search_type
== BY_REGISTER_NOTIFY
) {
1492 list_del(&handle
->link
);
1494 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1495 if (!efi_search(search_type
, protocol
, efiobj
))
1504 * efi_locate_handle_ext() - locate handles implementing a protocol.
1505 * @search_type: selection criterion
1506 * @protocol: GUID of the protocol
1507 * @search_key: registration key
1508 * @buffer_size: size of the buffer to receive the handles in bytes
1509 * @buffer: buffer to receive the relevant handles
1511 * This function implements the LocateHandle service.
1513 * See the Unified Extensible Firmware Interface (UEFI) specification for
1516 * Return: 0 if the handle implements the protocol
1518 static efi_status_t EFIAPI
efi_locate_handle_ext(
1519 enum efi_locate_search_type search_type
,
1520 const efi_guid_t
*protocol
, void *search_key
,
1521 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1523 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
1524 buffer_size
, buffer
);
1526 return EFI_EXIT(efi_locate_handle(search_type
, protocol
, search_key
,
1527 buffer_size
, buffer
));
1531 * efi_remove_configuration_table() - collapses configuration table entries,
1534 * @i: index of the table entry to be removed
1536 static void efi_remove_configuration_table(int i
)
1538 struct efi_configuration_table
*this = &systab
.tables
[i
];
1539 struct efi_configuration_table
*next
= &systab
.tables
[i
+ 1];
1540 struct efi_configuration_table
*end
= &systab
.tables
[systab
.nr_tables
];
1542 memmove(this, next
, (ulong
)end
- (ulong
)next
);
1547 * efi_install_configuration_table() - adds, updates, or removes a
1548 * configuration table
1549 * @guid: GUID of the installed table
1550 * @table: table to be installed
1552 * This function is used for internal calls. For the API implementation of the
1553 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1555 * Return: status code
1557 efi_status_t
efi_install_configuration_table(const efi_guid_t
*guid
,
1560 struct efi_event
*evt
;
1564 return EFI_INVALID_PARAMETER
;
1566 /* Check for GUID override */
1567 for (i
= 0; i
< systab
.nr_tables
; i
++) {
1568 if (!guidcmp(guid
, &systab
.tables
[i
].guid
)) {
1570 systab
.tables
[i
].table
= table
;
1572 efi_remove_configuration_table(i
);
1578 return EFI_NOT_FOUND
;
1580 /* No override, check for overflow */
1581 if (i
>= EFI_MAX_CONFIGURATION_TABLES
)
1582 return EFI_OUT_OF_RESOURCES
;
1584 /* Add a new entry */
1585 memcpy(&systab
.tables
[i
].guid
, guid
, sizeof(*guid
));
1586 systab
.tables
[i
].table
= table
;
1587 systab
.nr_tables
= i
+ 1;
1590 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1591 efi_update_table_header_crc32(&systab
.hdr
);
1593 /* Notify that the configuration table was changed */
1594 list_for_each_entry(evt
, &efi_events
, link
) {
1595 if (evt
->group
&& !guidcmp(evt
->group
, guid
)) {
1596 efi_signal_event(evt
, false);
1605 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1606 * configuration table.
1607 * @guid: GUID of the installed table
1608 * @table: table to be installed
1610 * This function implements the InstallConfigurationTable service.
1612 * See the Unified Extensible Firmware Interface (UEFI) specification for
1615 * Return: status code
1617 static efi_status_t EFIAPI
efi_install_configuration_table_ext(efi_guid_t
*guid
,
1620 EFI_ENTRY("%pUl, %p", guid
, table
);
1621 return EFI_EXIT(efi_install_configuration_table(guid
, table
));
1625 * efi_setup_loaded_image() - initialize a loaded image
1627 * Initialize a loaded_image_info and loaded_image_info object with correct
1628 * protocols, boot-device, etc.
1630 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1633 * @device_path: device path of the loaded image
1634 * @file_path: file path of the loaded image
1635 * @handle_ptr: handle of the loaded image
1636 * @info_ptr: loaded image protocol
1637 * Return: status code
1639 efi_status_t
efi_setup_loaded_image(struct efi_device_path
*device_path
,
1640 struct efi_device_path
*file_path
,
1641 struct efi_loaded_image_obj
**handle_ptr
,
1642 struct efi_loaded_image
**info_ptr
)
1645 struct efi_loaded_image
*info
= NULL
;
1646 struct efi_loaded_image_obj
*obj
= NULL
;
1647 struct efi_device_path
*dp
;
1649 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1653 info
= calloc(1, sizeof(*info
));
1655 return EFI_OUT_OF_RESOURCES
;
1656 obj
= calloc(1, sizeof(*obj
));
1659 return EFI_OUT_OF_RESOURCES
;
1661 obj
->header
.type
= EFI_OBJECT_TYPE_LOADED_IMAGE
;
1663 /* Add internal object to object list */
1664 efi_add_handle(&obj
->header
);
1666 info
->revision
= EFI_LOADED_IMAGE_PROTOCOL_REVISION
;
1667 info
->file_path
= file_path
;
1668 info
->system_table
= &systab
;
1671 info
->device_handle
= efi_dp_find_obj(device_path
, NULL
);
1673 dp
= efi_dp_append(device_path
, file_path
);
1675 ret
= EFI_OUT_OF_RESOURCES
;
1681 ret
= efi_add_protocol(&obj
->header
,
1682 &efi_guid_loaded_image_device_path
, dp
);
1683 if (ret
!= EFI_SUCCESS
)
1687 * When asking for the loaded_image interface, just
1688 * return handle which points to loaded_image_info
1690 ret
= efi_add_protocol(&obj
->header
,
1691 &efi_guid_loaded_image
, info
);
1692 if (ret
!= EFI_SUCCESS
)
1700 printf("ERROR: Failure to install protocols for loaded image\n");
1701 efi_delete_handle(&obj
->header
);
1707 * efi_load_image_from_path() - load an image using a file path
1709 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1710 * callers obligation to update the memory type as needed.
1712 * @file_path: the path of the image to load
1713 * @buffer: buffer containing the loaded image
1714 * @size: size of the loaded image
1715 * Return: status code
1718 efi_status_t
efi_load_image_from_path(struct efi_device_path
*file_path
,
1719 void **buffer
, efi_uintn_t
*size
)
1721 struct efi_file_info
*info
= NULL
;
1722 struct efi_file_handle
*f
;
1723 static efi_status_t ret
;
1727 /* In case of failure nothing is returned */
1732 f
= efi_file_from_path(file_path
);
1734 return EFI_DEVICE_ERROR
;
1738 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1740 if (ret
!= EFI_BUFFER_TOO_SMALL
) {
1741 ret
= EFI_DEVICE_ERROR
;
1746 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
, &bs
,
1748 if (ret
!= EFI_SUCCESS
)
1752 * When reading the file we do not yet know if it contains an
1753 * application, a boottime driver, or a runtime driver. So here we
1754 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1755 * update the reservation according to the image type.
1757 bs
= info
->file_size
;
1758 ret
= efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES
,
1759 EFI_BOOT_SERVICES_DATA
,
1760 efi_size_in_pages(bs
), &addr
);
1761 if (ret
!= EFI_SUCCESS
) {
1762 ret
= EFI_OUT_OF_RESOURCES
;
1767 EFI_CALL(ret
= f
->read(f
, &bs
, (void *)(uintptr_t)addr
));
1768 if (ret
!= EFI_SUCCESS
)
1769 efi_free_pages(addr
, efi_size_in_pages(bs
));
1770 *buffer
= (void *)(uintptr_t)addr
;
1773 EFI_CALL(f
->close(f
));
1779 * efi_load_image() - load an EFI image into memory
1780 * @boot_policy: true for request originating from the boot manager
1781 * @parent_image: the caller's image handle
1782 * @file_path: the path of the image to load
1783 * @source_buffer: memory location from which the image is installed
1784 * @source_size: size of the memory area from which the image is installed
1785 * @image_handle: handle for the newly installed image
1787 * This function implements the LoadImage service.
1789 * See the Unified Extensible Firmware Interface (UEFI) specification
1792 * Return: status code
1794 efi_status_t EFIAPI
efi_load_image(bool boot_policy
,
1795 efi_handle_t parent_image
,
1796 struct efi_device_path
*file_path
,
1797 void *source_buffer
,
1798 efi_uintn_t source_size
,
1799 efi_handle_t
*image_handle
)
1801 struct efi_device_path
*dp
, *fp
;
1802 struct efi_loaded_image
*info
= NULL
;
1803 struct efi_loaded_image_obj
**image_obj
=
1804 (struct efi_loaded_image_obj
**)image_handle
;
1808 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy
, parent_image
,
1809 file_path
, source_buffer
, source_size
, image_handle
);
1811 if (!image_handle
|| !efi_search_obj(parent_image
)) {
1812 ret
= EFI_INVALID_PARAMETER
;
1816 if (!source_buffer
&& !file_path
) {
1817 ret
= EFI_NOT_FOUND
;
1820 /* The parent image handle must refer to a loaded image */
1821 if (!parent_image
->type
) {
1822 ret
= EFI_INVALID_PARAMETER
;
1826 if (!source_buffer
) {
1827 ret
= efi_load_image_from_path(file_path
, &dest_buffer
,
1829 if (ret
!= EFI_SUCCESS
)
1833 ret
= EFI_LOAD_ERROR
;
1836 dest_buffer
= source_buffer
;
1838 /* split file_path which contains both the device and file parts */
1839 efi_dp_split_file_path(file_path
, &dp
, &fp
);
1840 ret
= efi_setup_loaded_image(dp
, fp
, image_obj
, &info
);
1841 if (ret
== EFI_SUCCESS
)
1842 ret
= efi_load_pe(*image_obj
, dest_buffer
, info
);
1844 /* Release buffer to which file was loaded */
1845 efi_free_pages((uintptr_t)dest_buffer
,
1846 efi_size_in_pages(source_size
));
1847 if (ret
== EFI_SUCCESS
) {
1848 info
->system_table
= &systab
;
1849 info
->parent_handle
= parent_image
;
1851 /* The image is invalid. Release all associated resources. */
1852 efi_delete_handle(*image_handle
);
1853 *image_handle
= NULL
;
1857 return EFI_EXIT(ret
);
1861 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1863 static void efi_exit_caches(void)
1865 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1867 * Grub on 32bit ARM needs to have caches disabled before jumping into
1868 * a zImage, but does not know of all cache layers. Give it a hand.
1870 if (efi_is_direct_boot
)
1871 cleanup_before_linux();
1876 * efi_exit_boot_services() - stop all boot services
1877 * @image_handle: handle of the loaded image
1878 * @map_key: key of the memory map
1880 * This function implements the ExitBootServices service.
1882 * See the Unified Extensible Firmware Interface (UEFI) specification
1885 * All timer events are disabled. For exit boot services events the
1886 * notification function is called. The boot services are disabled in the
1889 * Return: status code
1891 static efi_status_t EFIAPI
efi_exit_boot_services(efi_handle_t image_handle
,
1892 efi_uintn_t map_key
)
1894 struct efi_event
*evt
;
1896 EFI_ENTRY("%p, %zx", image_handle
, map_key
);
1898 /* Check that the caller has read the current memory map */
1899 if (map_key
!= efi_memory_map_key
)
1900 return EFI_INVALID_PARAMETER
;
1902 /* Make sure that notification functions are not called anymore */
1903 efi_tpl
= TPL_HIGH_LEVEL
;
1905 /* Check if ExitBootServices has already been called */
1906 if (!systab
.boottime
)
1907 return EFI_EXIT(EFI_SUCCESS
);
1909 /* Add related events to the event group */
1910 list_for_each_entry(evt
, &efi_events
, link
) {
1911 if (evt
->type
== EVT_SIGNAL_EXIT_BOOT_SERVICES
)
1912 evt
->group
= &efi_guid_event_group_exit_boot_services
;
1914 /* Notify that ExitBootServices is invoked. */
1915 list_for_each_entry(evt
, &efi_events
, link
) {
1917 !guidcmp(evt
->group
,
1918 &efi_guid_event_group_exit_boot_services
)) {
1919 efi_signal_event(evt
, false);
1924 /* TODO: Should persist EFI variables here */
1926 board_quiesce_devices();
1928 /* Fix up caches for EFI payloads if necessary */
1931 /* This stops all lingering devices */
1932 bootm_disable_interrupts();
1934 /* Disable boot time services */
1935 systab
.con_in_handle
= NULL
;
1936 systab
.con_in
= NULL
;
1937 systab
.con_out_handle
= NULL
;
1938 systab
.con_out
= NULL
;
1939 systab
.stderr_handle
= NULL
;
1940 systab
.std_err
= NULL
;
1941 systab
.boottime
= NULL
;
1943 /* Recalculate CRC32 */
1944 efi_update_table_header_crc32(&systab
.hdr
);
1946 /* Give the payload some time to boot */
1947 efi_set_watchdog(0);
1950 return EFI_EXIT(EFI_SUCCESS
);
1954 * efi_get_next_monotonic_count() - get next value of the counter
1955 * @count: returned value of the counter
1957 * This function implements the NextMonotonicCount service.
1959 * See the Unified Extensible Firmware Interface (UEFI) specification for
1962 * Return: status code
1964 static efi_status_t EFIAPI
efi_get_next_monotonic_count(uint64_t *count
)
1966 static uint64_t mono
;
1969 EFI_ENTRY("%p", count
);
1971 ret
= EFI_INVALID_PARAMETER
;
1977 return EFI_EXIT(ret
);
1981 * efi_stall() - sleep
1982 * @microseconds: period to sleep in microseconds
1984 * This function implements the Stall service.
1986 * See the Unified Extensible Firmware Interface (UEFI) specification for
1989 * Return: status code
1991 static efi_status_t EFIAPI
efi_stall(unsigned long microseconds
)
1995 EFI_ENTRY("%ld", microseconds
);
1997 end_tick
= get_ticks() + usec_to_tick(microseconds
);
1998 while (get_ticks() < end_tick
)
2001 return EFI_EXIT(EFI_SUCCESS
);
2005 * efi_set_watchdog_timer() - reset the watchdog timer
2006 * @timeout: seconds before reset by watchdog
2007 * @watchdog_code: code to be logged when resetting
2008 * @data_size: size of buffer in bytes
2009 * @watchdog_data: buffer with data describing the reset reason
2011 * This function implements the SetWatchdogTimer service.
2013 * See the Unified Extensible Firmware Interface (UEFI) specification for
2016 * Return: status code
2018 static efi_status_t EFIAPI
efi_set_watchdog_timer(unsigned long timeout
,
2019 uint64_t watchdog_code
,
2020 unsigned long data_size
,
2021 uint16_t *watchdog_data
)
2023 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout
, watchdog_code
,
2024 data_size
, watchdog_data
);
2025 return EFI_EXIT(efi_set_watchdog(timeout
));
2029 * efi_close_protocol() - close a protocol
2030 * @handle: handle on which the protocol shall be closed
2031 * @protocol: GUID of the protocol to close
2032 * @agent_handle: handle of the driver
2033 * @controller_handle: handle of the controller
2035 * This function implements the CloseProtocol service.
2037 * See the Unified Extensible Firmware Interface (UEFI) specification for
2040 * Return: status code
2042 static efi_status_t EFIAPI
efi_close_protocol(efi_handle_t handle
,
2043 const efi_guid_t
*protocol
,
2044 efi_handle_t agent_handle
,
2045 efi_handle_t controller_handle
)
2047 struct efi_handler
*handler
;
2048 struct efi_open_protocol_info_item
*item
;
2049 struct efi_open_protocol_info_item
*pos
;
2052 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, agent_handle
,
2055 if (!efi_search_obj(agent_handle
) ||
2056 (controller_handle
&& !efi_search_obj(controller_handle
))) {
2057 r
= EFI_INVALID_PARAMETER
;
2060 r
= efi_search_protocol(handle
, protocol
, &handler
);
2061 if (r
!= EFI_SUCCESS
)
2065 list_for_each_entry_safe(item
, pos
, &handler
->open_infos
, link
) {
2066 if (item
->info
.agent_handle
== agent_handle
&&
2067 item
->info
.controller_handle
== controller_handle
) {
2068 efi_delete_open_info(item
);
2077 * efi_open_protocol_information() - provide information about then open status
2078 * of a protocol on a handle
2079 * @handle: handle for which the information shall be retrieved
2080 * @protocol: GUID of the protocol
2081 * @entry_buffer: buffer to receive the open protocol information
2082 * @entry_count: number of entries available in the buffer
2084 * This function implements the OpenProtocolInformation service.
2086 * See the Unified Extensible Firmware Interface (UEFI) specification for
2089 * Return: status code
2091 static efi_status_t EFIAPI
efi_open_protocol_information(
2092 efi_handle_t handle
, const efi_guid_t
*protocol
,
2093 struct efi_open_protocol_info_entry
**entry_buffer
,
2094 efi_uintn_t
*entry_count
)
2096 unsigned long buffer_size
;
2097 unsigned long count
;
2098 struct efi_handler
*handler
;
2099 struct efi_open_protocol_info_item
*item
;
2102 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, entry_buffer
,
2105 /* Check parameters */
2106 if (!entry_buffer
) {
2107 r
= EFI_INVALID_PARAMETER
;
2110 r
= efi_search_protocol(handle
, protocol
, &handler
);
2111 if (r
!= EFI_SUCCESS
)
2116 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2117 if (item
->info
.open_count
)
2120 *entry_count
= count
;
2121 *entry_buffer
= NULL
;
2128 buffer_size
= count
* sizeof(struct efi_open_protocol_info_entry
);
2129 r
= efi_allocate_pool(EFI_BOOT_SERVICES_DATA
, buffer_size
,
2130 (void **)entry_buffer
);
2131 if (r
!= EFI_SUCCESS
)
2133 list_for_each_entry_reverse(item
, &handler
->open_infos
, link
) {
2134 if (item
->info
.open_count
)
2135 (*entry_buffer
)[--count
] = item
->info
;
2142 * efi_protocols_per_handle() - get protocols installed on a handle
2143 * @handle: handle for which the information is retrieved
2144 * @protocol_buffer: buffer with protocol GUIDs
2145 * @protocol_buffer_count: number of entries in the buffer
2147 * This function implements the ProtocolsPerHandleService.
2149 * See the Unified Extensible Firmware Interface (UEFI) specification for
2152 * Return: status code
2154 static efi_status_t EFIAPI
efi_protocols_per_handle(
2155 efi_handle_t handle
, efi_guid_t
***protocol_buffer
,
2156 efi_uintn_t
*protocol_buffer_count
)
2158 unsigned long buffer_size
;
2159 struct efi_object
*efiobj
;
2160 struct list_head
*protocol_handle
;
2163 EFI_ENTRY("%p, %p, %p", handle
, protocol_buffer
,
2164 protocol_buffer_count
);
2166 if (!handle
|| !protocol_buffer
|| !protocol_buffer_count
)
2167 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2169 *protocol_buffer
= NULL
;
2170 *protocol_buffer_count
= 0;
2172 efiobj
= efi_search_obj(handle
);
2174 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2176 /* Count protocols */
2177 list_for_each(protocol_handle
, &efiobj
->protocols
) {
2178 ++*protocol_buffer_count
;
2182 if (*protocol_buffer_count
) {
2185 buffer_size
= sizeof(efi_guid_t
*) * *protocol_buffer_count
;
2186 r
= efi_allocate_pool(EFI_BOOT_SERVICES_DATA
, buffer_size
,
2187 (void **)protocol_buffer
);
2188 if (r
!= EFI_SUCCESS
)
2190 list_for_each(protocol_handle
, &efiobj
->protocols
) {
2191 struct efi_handler
*protocol
;
2193 protocol
= list_entry(protocol_handle
,
2194 struct efi_handler
, link
);
2195 (*protocol_buffer
)[j
] = (void *)protocol
->guid
;
2200 return EFI_EXIT(EFI_SUCCESS
);
2204 * efi_locate_handle_buffer() - locate handles implementing a protocol
2205 * @search_type: selection criterion
2206 * @protocol: GUID of the protocol
2207 * @search_key: registration key
2208 * @no_handles: number of returned handles
2209 * @buffer: buffer with the returned handles
2211 * This function implements the LocateHandleBuffer service.
2213 * See the Unified Extensible Firmware Interface (UEFI) specification for
2216 * Return: status code
2218 static efi_status_t EFIAPI
efi_locate_handle_buffer(
2219 enum efi_locate_search_type search_type
,
2220 const efi_guid_t
*protocol
, void *search_key
,
2221 efi_uintn_t
*no_handles
, efi_handle_t
**buffer
)
2224 efi_uintn_t buffer_size
= 0;
2226 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
2227 no_handles
, buffer
);
2229 if (!no_handles
|| !buffer
) {
2230 r
= EFI_INVALID_PARAMETER
;
2235 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
2237 if (r
!= EFI_BUFFER_TOO_SMALL
)
2239 r
= efi_allocate_pool(EFI_BOOT_SERVICES_DATA
, buffer_size
,
2241 if (r
!= EFI_SUCCESS
)
2243 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
2245 if (r
== EFI_SUCCESS
)
2246 *no_handles
= buffer_size
/ sizeof(efi_handle_t
);
2252 * efi_locate_protocol() - find an interface implementing a protocol
2253 * @protocol: GUID of the protocol
2254 * @registration: registration key passed to the notification function
2255 * @protocol_interface: interface implementing the protocol
2257 * This function implements the LocateProtocol service.
2259 * See the Unified Extensible Firmware Interface (UEFI) specification for
2262 * Return: status code
2264 static efi_status_t EFIAPI
efi_locate_protocol(const efi_guid_t
*protocol
,
2266 void **protocol_interface
)
2268 struct efi_handler
*handler
;
2270 struct efi_object
*efiobj
;
2272 EFI_ENTRY("%pUl, %p, %p", protocol
, registration
, protocol_interface
);
2275 * The UEFI spec explicitly requires a protocol even if a registration
2276 * key is provided. This differs from the logic in LocateHandle().
2278 if (!protocol
|| !protocol_interface
)
2279 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2282 struct efi_register_notify_event
*event
;
2283 struct efi_protocol_notification
*handle
;
2285 event
= efi_check_register_notify_event(registration
);
2287 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2289 * The UEFI spec requires to return EFI_NOT_FOUND if no
2290 * protocol instance matches protocol and registration.
2291 * So let's do the same for a mismatch between protocol and
2294 if (guidcmp(&event
->protocol
, protocol
))
2296 if (list_empty(&event
->handles
))
2298 handle
= list_first_entry(&event
->handles
,
2299 struct efi_protocol_notification
,
2301 efiobj
= handle
->handle
;
2302 list_del(&handle
->link
);
2304 ret
= efi_search_protocol(efiobj
, protocol
, &handler
);
2305 if (ret
== EFI_SUCCESS
)
2308 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
2309 ret
= efi_search_protocol(efiobj
, protocol
, &handler
);
2310 if (ret
== EFI_SUCCESS
)
2315 *protocol_interface
= NULL
;
2316 return EFI_EXIT(EFI_NOT_FOUND
);
2318 *protocol_interface
= handler
->protocol_interface
;
2319 return EFI_EXIT(EFI_SUCCESS
);
2323 * efi_locate_device_path() - Get the device path and handle of an device
2324 * implementing a protocol
2325 * @protocol: GUID of the protocol
2326 * @device_path: device path
2327 * @device: handle of the device
2329 * This function implements the LocateDevicePath service.
2331 * See the Unified Extensible Firmware Interface (UEFI) specification for
2334 * Return: status code
2336 static efi_status_t EFIAPI
efi_locate_device_path(
2337 const efi_guid_t
*protocol
,
2338 struct efi_device_path
**device_path
,
2339 efi_handle_t
*device
)
2341 struct efi_device_path
*dp
;
2343 struct efi_handler
*handler
;
2344 efi_handle_t
*handles
;
2346 size_t len_best
= 0;
2347 efi_uintn_t no_handles
;
2351 EFI_ENTRY("%pUl, %p, %p", protocol
, device_path
, device
);
2353 if (!protocol
|| !device_path
|| !*device_path
) {
2354 ret
= EFI_INVALID_PARAMETER
;
2358 /* Find end of device path */
2359 len
= efi_dp_instance_size(*device_path
);
2361 /* Get all handles implementing the protocol */
2362 ret
= EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL
, protocol
, NULL
,
2363 &no_handles
, &handles
));
2364 if (ret
!= EFI_SUCCESS
)
2367 for (i
= 0; i
< no_handles
; ++i
) {
2368 /* Find the device path protocol */
2369 ret
= efi_search_protocol(handles
[i
], &efi_guid_device_path
,
2371 if (ret
!= EFI_SUCCESS
)
2373 dp
= (struct efi_device_path
*)handler
->protocol_interface
;
2374 len_dp
= efi_dp_instance_size(dp
);
2376 * This handle can only be a better fit
2377 * if its device path length is longer than the best fit and
2378 * if its device path length is shorter of equal the searched
2381 if (len_dp
<= len_best
|| len_dp
> len
)
2383 /* Check if dp is a subpath of device_path */
2384 if (memcmp(*device_path
, dp
, len_dp
))
2387 ret
= EFI_INVALID_PARAMETER
;
2390 *device
= handles
[i
];
2394 remainder
= (u8
*)*device_path
+ len_best
;
2395 *device_path
= (struct efi_device_path
*)remainder
;
2398 ret
= EFI_NOT_FOUND
;
2401 return EFI_EXIT(ret
);
2405 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2407 * @handle: handle on which the protocol interfaces shall be installed
2408 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2411 * This function implements the MultipleProtocolInterfaces service.
2413 * See the Unified Extensible Firmware Interface (UEFI) specification for
2416 * Return: status code
2418 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2419 (efi_handle_t
*handle
, ...)
2421 EFI_ENTRY("%p", handle
);
2424 const efi_guid_t
*protocol
;
2425 void *protocol_interface
;
2426 efi_handle_t old_handle
;
2427 efi_status_t r
= EFI_SUCCESS
;
2431 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2433 efi_va_start(argptr
, handle
);
2435 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2438 protocol_interface
= efi_va_arg(argptr
, void*);
2439 /* Check that a device path has not been installed before */
2440 if (!guidcmp(protocol
, &efi_guid_device_path
)) {
2441 struct efi_device_path
*dp
= protocol_interface
;
2443 r
= EFI_CALL(efi_locate_device_path(protocol
, &dp
,
2445 if (r
== EFI_SUCCESS
&&
2446 dp
->type
== DEVICE_PATH_TYPE_END
) {
2447 EFI_PRINT("Path %pD already installed\n",
2448 protocol_interface
);
2449 r
= EFI_ALREADY_STARTED
;
2453 r
= EFI_CALL(efi_install_protocol_interface(
2455 EFI_NATIVE_INTERFACE
,
2456 protocol_interface
));
2457 if (r
!= EFI_SUCCESS
)
2462 if (r
== EFI_SUCCESS
)
2465 /* If an error occurred undo all changes. */
2466 efi_va_start(argptr
, handle
);
2468 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2469 protocol_interface
= efi_va_arg(argptr
, void*);
2470 EFI_CALL(efi_uninstall_protocol_interface(*handle
, protocol
,
2471 protocol_interface
));
2479 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2481 * @handle: handle from which the protocol interfaces shall be removed
2482 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2485 * This function implements the UninstallMultipleProtocolInterfaces service.
2487 * See the Unified Extensible Firmware Interface (UEFI) specification for
2490 * Return: status code
2492 static efi_status_t EFIAPI
efi_uninstall_multiple_protocol_interfaces(
2493 efi_handle_t handle
, ...)
2495 EFI_ENTRY("%p", handle
);
2498 const efi_guid_t
*protocol
;
2499 void *protocol_interface
;
2500 efi_status_t r
= EFI_SUCCESS
;
2504 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2506 efi_va_start(argptr
, handle
);
2508 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2511 protocol_interface
= efi_va_arg(argptr
, void*);
2512 r
= efi_uninstall_protocol(handle
, protocol
,
2513 protocol_interface
);
2514 if (r
!= EFI_SUCCESS
)
2519 if (r
== EFI_SUCCESS
) {
2520 /* If the last protocol has been removed, delete the handle. */
2521 if (list_empty(&handle
->protocols
)) {
2522 list_del(&handle
->link
);
2528 /* If an error occurred undo all changes. */
2529 efi_va_start(argptr
, handle
);
2531 protocol
= efi_va_arg(argptr
, efi_guid_t
*);
2532 protocol_interface
= efi_va_arg(argptr
, void*);
2533 EFI_CALL(efi_install_protocol_interface(&handle
, protocol
,
2534 EFI_NATIVE_INTERFACE
,
2535 protocol_interface
));
2539 /* In case of an error always return EFI_INVALID_PARAMETER */
2540 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2544 * efi_calculate_crc32() - calculate cyclic redundancy code
2545 * @data: buffer with data
2546 * @data_size: size of buffer in bytes
2547 * @crc32_p: cyclic redundancy code
2549 * This function implements the CalculateCrc32 service.
2551 * See the Unified Extensible Firmware Interface (UEFI) specification for
2554 * Return: status code
2556 static efi_status_t EFIAPI
efi_calculate_crc32(const void *data
,
2557 efi_uintn_t data_size
,
2560 efi_status_t ret
= EFI_SUCCESS
;
2562 EFI_ENTRY("%p, %zu", data
, data_size
);
2563 if (!data
|| !data_size
|| !crc32_p
) {
2564 ret
= EFI_INVALID_PARAMETER
;
2567 *crc32_p
= crc32(0, data
, data_size
);
2569 return EFI_EXIT(ret
);
2573 * efi_copy_mem() - copy memory
2574 * @destination: destination of the copy operation
2575 * @source: source of the copy operation
2576 * @length: number of bytes to copy
2578 * This function implements the CopyMem service.
2580 * See the Unified Extensible Firmware Interface (UEFI) specification for
2583 static void EFIAPI
efi_copy_mem(void *destination
, const void *source
,
2586 EFI_ENTRY("%p, %p, %ld", destination
, source
, (unsigned long)length
);
2587 memmove(destination
, source
, length
);
2588 EFI_EXIT(EFI_SUCCESS
);
2592 * efi_set_mem() - Fill memory with a byte value.
2593 * @buffer: buffer to fill
2594 * @size: size of buffer in bytes
2595 * @value: byte to copy to the buffer
2597 * This function implements the SetMem service.
2599 * See the Unified Extensible Firmware Interface (UEFI) specification for
2602 static void EFIAPI
efi_set_mem(void *buffer
, size_t size
, uint8_t value
)
2604 EFI_ENTRY("%p, %ld, 0x%x", buffer
, (unsigned long)size
, value
);
2605 memset(buffer
, value
, size
);
2606 EFI_EXIT(EFI_SUCCESS
);
2610 * efi_protocol_open() - open protocol interface on a handle
2611 * @handler: handler of a protocol
2612 * @protocol_interface: interface implementing the protocol
2613 * @agent_handle: handle of the driver
2614 * @controller_handle: handle of the controller
2615 * @attributes: attributes indicating how to open the protocol
2617 * Return: status code
2619 static efi_status_t
efi_protocol_open(
2620 struct efi_handler
*handler
,
2621 void **protocol_interface
, void *agent_handle
,
2622 void *controller_handle
, uint32_t attributes
)
2624 struct efi_open_protocol_info_item
*item
;
2625 struct efi_open_protocol_info_entry
*match
= NULL
;
2626 bool opened_by_driver
= false;
2627 bool opened_exclusive
= false;
2629 /* If there is no agent, only return the interface */
2633 /* For TEST_PROTOCOL ignore interface attribute */
2634 if (attributes
!= EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
2635 *protocol_interface
= NULL
;
2638 * Check if the protocol is already opened by a driver with the same
2639 * attributes or opened exclusively
2641 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2642 if (item
->info
.agent_handle
== agent_handle
) {
2643 if ((attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) &&
2644 (item
->info
.attributes
== attributes
))
2645 return EFI_ALREADY_STARTED
;
2647 if (item
->info
.attributes
&
2648 EFI_OPEN_PROTOCOL_BY_DRIVER
)
2649 opened_by_driver
= true;
2651 if (item
->info
.attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
)
2652 opened_exclusive
= true;
2655 /* Only one controller can open the protocol exclusively */
2656 if (attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
) {
2657 if (opened_exclusive
)
2658 return EFI_ACCESS_DENIED
;
2659 } else if (attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) {
2660 if (opened_exclusive
|| opened_by_driver
)
2661 return EFI_ACCESS_DENIED
;
2664 /* Prepare exclusive opening */
2665 if (attributes
& EFI_OPEN_PROTOCOL_EXCLUSIVE
) {
2666 /* Try to disconnect controllers */
2668 opened_by_driver
= false;
2669 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2672 if (item
->info
.attributes
==
2673 EFI_OPEN_PROTOCOL_BY_DRIVER
) {
2674 ret
= EFI_CALL(efi_disconnect_controller(
2675 item
->info
.controller_handle
,
2676 item
->info
.agent_handle
,
2678 if (ret
== EFI_SUCCESS
)
2680 * Child controllers may have been
2681 * removed from the open_infos list. So
2682 * let's restart the loop.
2684 goto disconnect_next
;
2686 opened_by_driver
= true;
2689 /* Only one driver can be connected */
2690 if (opened_by_driver
)
2691 return EFI_ACCESS_DENIED
;
2694 /* Find existing entry */
2695 list_for_each_entry(item
, &handler
->open_infos
, link
) {
2696 if (item
->info
.agent_handle
== agent_handle
&&
2697 item
->info
.controller_handle
== controller_handle
&&
2698 item
->info
.attributes
== attributes
)
2699 match
= &item
->info
;
2701 /* None found, create one */
2703 match
= efi_create_open_info(handler
);
2705 return EFI_OUT_OF_RESOURCES
;
2708 match
->agent_handle
= agent_handle
;
2709 match
->controller_handle
= controller_handle
;
2710 match
->attributes
= attributes
;
2711 match
->open_count
++;
2714 /* For TEST_PROTOCOL ignore interface attribute. */
2715 if (attributes
!= EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)
2716 *protocol_interface
= handler
->protocol_interface
;
2722 * efi_open_protocol() - open protocol interface on a handle
2723 * @handle: handle on which the protocol shall be opened
2724 * @protocol: GUID of the protocol
2725 * @protocol_interface: interface implementing the protocol
2726 * @agent_handle: handle of the driver
2727 * @controller_handle: handle of the controller
2728 * @attributes: attributes indicating how to open the protocol
2730 * This function implements the OpenProtocol interface.
2732 * See the Unified Extensible Firmware Interface (UEFI) specification for
2735 * Return: status code
2737 static efi_status_t EFIAPI efi_open_protocol
2738 (efi_handle_t handle
, const efi_guid_t
*protocol
,
2739 void **protocol_interface
, efi_handle_t agent_handle
,
2740 efi_handle_t controller_handle
, uint32_t attributes
)
2742 struct efi_handler
*handler
;
2743 efi_status_t r
= EFI_INVALID_PARAMETER
;
2745 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle
, protocol
,
2746 protocol_interface
, agent_handle
, controller_handle
,
2749 if (!handle
|| !protocol
||
2750 (!protocol_interface
&& attributes
!=
2751 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)) {
2755 switch (attributes
) {
2756 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
:
2757 case EFI_OPEN_PROTOCOL_GET_PROTOCOL
:
2758 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL
:
2760 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
:
2761 if (controller_handle
== handle
)
2764 case EFI_OPEN_PROTOCOL_BY_DRIVER
:
2765 case EFI_OPEN_PROTOCOL_BY_DRIVER
| EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2766 /* Check that the controller handle is valid */
2767 if (!efi_search_obj(controller_handle
))
2770 case EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2771 /* Check that the agent handle is valid */
2772 if (!efi_search_obj(agent_handle
))
2779 r
= efi_search_protocol(handle
, protocol
, &handler
);
2784 r
= EFI_UNSUPPORTED
;
2790 r
= efi_protocol_open(handler
, protocol_interface
, agent_handle
,
2791 controller_handle
, attributes
);
2797 * efi_start_image() - call the entry point of an image
2798 * @image_handle: handle of the image
2799 * @exit_data_size: size of the buffer
2800 * @exit_data: buffer to receive the exit data of the called image
2802 * This function implements the StartImage service.
2804 * See the Unified Extensible Firmware Interface (UEFI) specification for
2807 * Return: status code
2809 efi_status_t EFIAPI
efi_start_image(efi_handle_t image_handle
,
2810 efi_uintn_t
*exit_data_size
,
2813 struct efi_loaded_image_obj
*image_obj
=
2814 (struct efi_loaded_image_obj
*)image_handle
;
2817 efi_handle_t parent_image
= current_image
;
2819 EFI_ENTRY("%p, %p, %p", image_handle
, exit_data_size
, exit_data
);
2821 /* Check parameters */
2822 ret
= EFI_CALL(efi_open_protocol(image_handle
, &efi_guid_loaded_image
,
2824 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
2825 if (ret
!= EFI_SUCCESS
)
2826 return EFI_EXIT(EFI_INVALID_PARAMETER
);
2828 efi_is_direct_boot
= false;
2830 image_obj
->exit_data_size
= exit_data_size
;
2831 image_obj
->exit_data
= exit_data
;
2833 /* call the image! */
2834 if (setjmp(&image_obj
->exit_jmp
)) {
2836 * We called the entry point of the child image with EFI_CALL
2837 * in the lines below. The child image called the Exit() boot
2838 * service efi_exit() which executed the long jump that brought
2839 * us to the current line. This implies that the second half
2840 * of the EFI_CALL macro has not been executed.
2844 * efi_exit() called efi_restore_gd(). We have to undo this
2845 * otherwise __efi_entry_check() will put the wrong value into
2851 * To get ready to call EFI_EXIT below we have to execute the
2852 * missed out steps of EFI_CALL.
2854 assert(__efi_entry_check());
2855 EFI_PRINT("%lu returned by started image\n",
2856 (unsigned long)((uintptr_t)image_obj
->exit_status
&
2858 current_image
= parent_image
;
2859 return EFI_EXIT(image_obj
->exit_status
);
2862 current_image
= image_handle
;
2863 image_obj
->header
.type
= EFI_OBJECT_TYPE_STARTED_IMAGE
;
2864 EFI_PRINT("Jumping into 0x%p\n", image_obj
->entry
);
2865 ret
= EFI_CALL(image_obj
->entry(image_handle
, &systab
));
2868 * Usually UEFI applications call Exit() instead of returning.
2869 * But because the world doesn't consist of ponies and unicorns,
2870 * we're happy to emulate that behavior on behalf of a payload
2873 return EFI_CALL(systab
.boottime
->exit(image_handle
, ret
, 0, NULL
));
2877 * efi_delete_image() - delete loaded image from memory)
2879 * @image_obj: handle of the loaded image
2880 * @loaded_image_protocol: loaded image protocol
2882 static efi_status_t efi_delete_image
2883 (struct efi_loaded_image_obj
*image_obj
,
2884 struct efi_loaded_image
*loaded_image_protocol
)
2886 struct efi_object
*efiobj
;
2887 efi_status_t r
, ret
= EFI_SUCCESS
;
2890 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
2891 struct efi_handler
*protocol
;
2893 list_for_each_entry(protocol
, &efiobj
->protocols
, link
) {
2894 struct efi_open_protocol_info_item
*info
;
2896 list_for_each_entry(info
, &protocol
->open_infos
, link
) {
2897 if (info
->info
.agent_handle
!=
2898 (efi_handle_t
)image_obj
)
2900 r
= EFI_CALL(efi_close_protocol
2901 (efiobj
, protocol
->guid
,
2902 info
->info
.agent_handle
,
2903 info
->info
.controller_handle
2905 if (r
!= EFI_SUCCESS
)
2908 * Closing protocols may results in further
2909 * items being deleted. To play it safe loop
2910 * over all elements again.
2917 efi_free_pages((uintptr_t)loaded_image_protocol
->image_base
,
2918 efi_size_in_pages(loaded_image_protocol
->image_size
));
2919 efi_delete_handle(&image_obj
->header
);
2925 * efi_unload_image() - unload an EFI image
2926 * @image_handle: handle of the image to be unloaded
2928 * This function implements the UnloadImage service.
2930 * See the Unified Extensible Firmware Interface (UEFI) specification for
2933 * Return: status code
2935 efi_status_t EFIAPI
efi_unload_image(efi_handle_t image_handle
)
2937 efi_status_t ret
= EFI_SUCCESS
;
2938 struct efi_object
*efiobj
;
2939 struct efi_loaded_image
*loaded_image_protocol
;
2941 EFI_ENTRY("%p", image_handle
);
2943 efiobj
= efi_search_obj(image_handle
);
2945 ret
= EFI_INVALID_PARAMETER
;
2948 /* Find the loaded image protocol */
2949 ret
= EFI_CALL(efi_open_protocol(image_handle
, &efi_guid_loaded_image
,
2950 (void **)&loaded_image_protocol
,
2952 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
2953 if (ret
!= EFI_SUCCESS
) {
2954 ret
= EFI_INVALID_PARAMETER
;
2957 switch (efiobj
->type
) {
2958 case EFI_OBJECT_TYPE_STARTED_IMAGE
:
2959 /* Call the unload function */
2960 if (!loaded_image_protocol
->unload
) {
2961 ret
= EFI_UNSUPPORTED
;
2964 ret
= EFI_CALL(loaded_image_protocol
->unload(image_handle
));
2965 if (ret
!= EFI_SUCCESS
)
2968 case EFI_OBJECT_TYPE_LOADED_IMAGE
:
2971 ret
= EFI_INVALID_PARAMETER
;
2974 efi_delete_image((struct efi_loaded_image_obj
*)efiobj
,
2975 loaded_image_protocol
);
2977 return EFI_EXIT(ret
);
2981 * efi_update_exit_data() - fill exit data parameters of StartImage()
2983 * @image_obj image handle
2984 * @exit_data_size size of the exit data buffer
2985 * @exit_data buffer with data returned by UEFI payload
2986 * Return: status code
2988 static efi_status_t
efi_update_exit_data(struct efi_loaded_image_obj
*image_obj
,
2989 efi_uintn_t exit_data_size
,
2995 * If exit_data is not provided to StartImage(), exit_data_size must be
2998 if (!image_obj
->exit_data
)
3000 if (image_obj
->exit_data_size
)
3001 *image_obj
->exit_data_size
= exit_data_size
;
3002 if (exit_data_size
&& exit_data
) {
3003 ret
= efi_allocate_pool(EFI_BOOT_SERVICES_DATA
,
3005 (void **)image_obj
->exit_data
);
3006 if (ret
!= EFI_SUCCESS
)
3008 memcpy(*image_obj
->exit_data
, exit_data
, exit_data_size
);
3010 image_obj
->exit_data
= NULL
;
3016 * efi_exit() - leave an EFI application or driver
3017 * @image_handle: handle of the application or driver that is exiting
3018 * @exit_status: status code
3019 * @exit_data_size: size of the buffer in bytes
3020 * @exit_data: buffer with data describing an error
3022 * This function implements the Exit service.
3024 * See the Unified Extensible Firmware Interface (UEFI) specification for
3027 * Return: status code
3029 static efi_status_t EFIAPI
efi_exit(efi_handle_t image_handle
,
3030 efi_status_t exit_status
,
3031 efi_uintn_t exit_data_size
,
3035 * TODO: We should call the unload procedure of the loaded
3039 struct efi_loaded_image
*loaded_image_protocol
;
3040 struct efi_loaded_image_obj
*image_obj
=
3041 (struct efi_loaded_image_obj
*)image_handle
;
3043 EFI_ENTRY("%p, %ld, %zu, %p", image_handle
, exit_status
,
3044 exit_data_size
, exit_data
);
3046 /* Check parameters */
3047 ret
= EFI_CALL(efi_open_protocol(image_handle
, &efi_guid_loaded_image
,
3048 (void **)&loaded_image_protocol
,
3050 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
3051 if (ret
!= EFI_SUCCESS
) {
3052 ret
= EFI_INVALID_PARAMETER
;
3056 /* Unloading of unstarted images */
3057 switch (image_obj
->header
.type
) {
3058 case EFI_OBJECT_TYPE_STARTED_IMAGE
:
3060 case EFI_OBJECT_TYPE_LOADED_IMAGE
:
3061 efi_delete_image(image_obj
, loaded_image_protocol
);
3065 /* Handle does not refer to loaded image */
3066 ret
= EFI_INVALID_PARAMETER
;
3069 /* A started image can only be unloaded it is the last one started. */
3070 if (image_handle
!= current_image
) {
3071 ret
= EFI_INVALID_PARAMETER
;
3075 /* Exit data is only foreseen in case of failure. */
3076 if (exit_status
!= EFI_SUCCESS
) {
3077 ret
= efi_update_exit_data(image_obj
, exit_data_size
,
3079 /* Exiting has priority. Don't return error to caller. */
3080 if (ret
!= EFI_SUCCESS
)
3081 EFI_PRINT("%s: out of memory\n", __func__
);
3083 if (image_obj
->image_type
== IMAGE_SUBSYSTEM_EFI_APPLICATION
||
3084 exit_status
!= EFI_SUCCESS
)
3085 efi_delete_image(image_obj
, loaded_image_protocol
);
3087 /* Make sure entry/exit counts for EFI world cross-overs match */
3088 EFI_EXIT(exit_status
);
3091 * But longjmp out with the U-Boot gd, not the application's, as
3092 * the other end is a setjmp call inside EFI context.
3096 image_obj
->exit_status
= exit_status
;
3097 longjmp(&image_obj
->exit_jmp
, 1);
3099 panic("EFI application exited");
3101 return EFI_EXIT(ret
);
3105 * efi_handle_protocol() - get interface of a protocol on a handle
3106 * @handle: handle on which the protocol shall be opened
3107 * @protocol: GUID of the protocol
3108 * @protocol_interface: interface implementing the protocol
3110 * This function implements the HandleProtocol service.
3112 * See the Unified Extensible Firmware Interface (UEFI) specification for
3115 * Return: status code
3117 static efi_status_t EFIAPI
efi_handle_protocol(efi_handle_t handle
,
3118 const efi_guid_t
*protocol
,
3119 void **protocol_interface
)
3121 return efi_open_protocol(handle
, protocol
, protocol_interface
, efi_root
,
3122 NULL
, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
);
3126 * efi_bind_controller() - bind a single driver to a controller
3127 * @controller_handle: controller handle
3128 * @driver_image_handle: driver handle
3129 * @remain_device_path: remaining path
3131 * Return: status code
3133 static efi_status_t
efi_bind_controller(
3134 efi_handle_t controller_handle
,
3135 efi_handle_t driver_image_handle
,
3136 struct efi_device_path
*remain_device_path
)
3138 struct efi_driver_binding_protocol
*binding_protocol
;
3141 r
= EFI_CALL(efi_open_protocol(driver_image_handle
,
3142 &efi_guid_driver_binding_protocol
,
3143 (void **)&binding_protocol
,
3144 driver_image_handle
, NULL
,
3145 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
3146 if (r
!= EFI_SUCCESS
)
3148 r
= EFI_CALL(binding_protocol
->supported(binding_protocol
,
3150 remain_device_path
));
3151 if (r
== EFI_SUCCESS
)
3152 r
= EFI_CALL(binding_protocol
->start(binding_protocol
,
3154 remain_device_path
));
3155 EFI_CALL(efi_close_protocol(driver_image_handle
,
3156 &efi_guid_driver_binding_protocol
,
3157 driver_image_handle
, NULL
));
3162 * efi_connect_single_controller() - connect a single driver to a controller
3163 * @controller_handle: controller
3164 * @driver_image_handle: driver
3165 * @remain_device_path: remaining path
3167 * Return: status code
3169 static efi_status_t
efi_connect_single_controller(
3170 efi_handle_t controller_handle
,
3171 efi_handle_t
*driver_image_handle
,
3172 struct efi_device_path
*remain_device_path
)
3174 efi_handle_t
*buffer
;
3178 size_t connected
= 0;
3180 /* Get buffer with all handles with driver binding protocol */
3181 r
= EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL
,
3182 &efi_guid_driver_binding_protocol
,
3183 NULL
, &count
, &buffer
));
3184 if (r
!= EFI_SUCCESS
)
3187 /* Context Override */
3188 if (driver_image_handle
) {
3189 for (; *driver_image_handle
; ++driver_image_handle
) {
3190 for (i
= 0; i
< count
; ++i
) {
3191 if (buffer
[i
] == *driver_image_handle
) {
3193 r
= efi_bind_controller(
3195 *driver_image_handle
,
3196 remain_device_path
);
3198 * For drivers that do not support the
3199 * controller or are already connected
3200 * we receive an error code here.
3202 if (r
== EFI_SUCCESS
)
3210 * TODO: Some overrides are not yet implemented:
3211 * - Platform Driver Override
3212 * - Driver Family Override Search
3213 * - Bus Specific Driver Override
3216 /* Driver Binding Search */
3217 for (i
= 0; i
< count
; ++i
) {
3219 r
= efi_bind_controller(controller_handle
,
3221 remain_device_path
);
3222 if (r
== EFI_SUCCESS
)
3227 efi_free_pool(buffer
);
3229 return EFI_NOT_FOUND
;
3234 * efi_connect_controller() - connect a controller to a driver
3235 * @controller_handle: handle of the controller
3236 * @driver_image_handle: handle of the driver
3237 * @remain_device_path: device path of a child controller
3238 * @recursive: true to connect all child controllers
3240 * This function implements the ConnectController service.
3242 * See the Unified Extensible Firmware Interface (UEFI) specification for
3245 * First all driver binding protocol handles are tried for binding drivers.
3246 * Afterwards all handles that have opened a protocol of the controller
3247 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3249 * Return: status code
3251 static efi_status_t EFIAPI
efi_connect_controller(
3252 efi_handle_t controller_handle
,
3253 efi_handle_t
*driver_image_handle
,
3254 struct efi_device_path
*remain_device_path
,
3258 efi_status_t ret
= EFI_NOT_FOUND
;
3259 struct efi_object
*efiobj
;
3261 EFI_ENTRY("%p, %p, %pD, %d", controller_handle
, driver_image_handle
,
3262 remain_device_path
, recursive
);
3264 efiobj
= efi_search_obj(controller_handle
);
3266 ret
= EFI_INVALID_PARAMETER
;
3270 r
= efi_connect_single_controller(controller_handle
,
3271 driver_image_handle
,
3272 remain_device_path
);
3273 if (r
== EFI_SUCCESS
)
3276 struct efi_handler
*handler
;
3277 struct efi_open_protocol_info_item
*item
;
3279 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
3280 list_for_each_entry(item
, &handler
->open_infos
, link
) {
3281 if (item
->info
.attributes
&
3282 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) {
3283 r
= EFI_CALL(efi_connect_controller(
3284 item
->info
.controller_handle
,
3285 driver_image_handle
,
3288 if (r
== EFI_SUCCESS
)
3294 /* Check for child controller specified by end node */
3295 if (ret
!= EFI_SUCCESS
&& remain_device_path
&&
3296 remain_device_path
->type
== DEVICE_PATH_TYPE_END
)
3299 return EFI_EXIT(ret
);
3303 * efi_reinstall_protocol_interface() - reinstall protocol interface
3304 * @handle: handle on which the protocol shall be reinstalled
3305 * @protocol: GUID of the protocol to be installed
3306 * @old_interface: interface to be removed
3307 * @new_interface: interface to be installed
3309 * This function implements the ReinstallProtocolInterface service.
3311 * See the Unified Extensible Firmware Interface (UEFI) specification for
3314 * The old interface is uninstalled. The new interface is installed.
3315 * Drivers are connected.
3317 * Return: status code
3319 static efi_status_t EFIAPI
efi_reinstall_protocol_interface(
3320 efi_handle_t handle
, const efi_guid_t
*protocol
,
3321 void *old_interface
, void *new_interface
)
3325 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, old_interface
,
3328 /* Uninstall protocol but do not delete handle */
3329 ret
= efi_uninstall_protocol(handle
, protocol
, old_interface
);
3330 if (ret
!= EFI_SUCCESS
)
3333 /* Install the new protocol */
3334 ret
= efi_add_protocol(handle
, protocol
, new_interface
);
3336 * The UEFI spec does not specify what should happen to the handle
3337 * if in case of an error no protocol interface remains on the handle.
3338 * So let's do nothing here.
3340 if (ret
!= EFI_SUCCESS
)
3343 * The returned status code has to be ignored.
3344 * Do not create an error if no suitable driver for the handle exists.
3346 EFI_CALL(efi_connect_controller(handle
, NULL
, NULL
, true));
3348 return EFI_EXIT(ret
);
3352 * efi_get_child_controllers() - get all child controllers associated to a driver
3353 * @efiobj: handle of the controller
3354 * @driver_handle: handle of the driver
3355 * @number_of_children: number of child controllers
3356 * @child_handle_buffer: handles of the the child controllers
3358 * The allocated buffer has to be freed with free().
3360 * Return: status code
3362 static efi_status_t
efi_get_child_controllers(
3363 struct efi_object
*efiobj
,
3364 efi_handle_t driver_handle
,
3365 efi_uintn_t
*number_of_children
,
3366 efi_handle_t
**child_handle_buffer
)
3368 struct efi_handler
*handler
;
3369 struct efi_open_protocol_info_item
*item
;
3370 efi_uintn_t count
= 0, i
;
3373 /* Count all child controller associations */
3374 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
3375 list_for_each_entry(item
, &handler
->open_infos
, link
) {
3376 if (item
->info
.agent_handle
== driver_handle
&&
3377 item
->info
.attributes
&
3378 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
)
3383 * Create buffer. In case of duplicate child controller assignments
3384 * the buffer will be too large. But that does not harm.
3386 *number_of_children
= 0;
3387 *child_handle_buffer
= calloc(count
, sizeof(efi_handle_t
));
3388 if (!*child_handle_buffer
)
3389 return EFI_OUT_OF_RESOURCES
;
3390 /* Copy unique child handles */
3391 list_for_each_entry(handler
, &efiobj
->protocols
, link
) {
3392 list_for_each_entry(item
, &handler
->open_infos
, link
) {
3393 if (item
->info
.agent_handle
== driver_handle
&&
3394 item
->info
.attributes
&
3395 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) {
3396 /* Check this is a new child controller */
3398 for (i
= 0; i
< *number_of_children
; ++i
) {
3399 if ((*child_handle_buffer
)[i
] ==
3400 item
->info
.controller_handle
)
3403 /* Copy handle to buffer */
3405 i
= (*number_of_children
)++;
3406 (*child_handle_buffer
)[i
] =
3407 item
->info
.controller_handle
;
3416 * efi_disconnect_controller() - disconnect a controller from a driver
3417 * @controller_handle: handle of the controller
3418 * @driver_image_handle: handle of the driver
3419 * @child_handle: handle of the child to destroy
3421 * This function implements the DisconnectController service.
3423 * See the Unified Extensible Firmware Interface (UEFI) specification for
3426 * Return: status code
3428 static efi_status_t EFIAPI
efi_disconnect_controller(
3429 efi_handle_t controller_handle
,
3430 efi_handle_t driver_image_handle
,
3431 efi_handle_t child_handle
)
3433 struct efi_driver_binding_protocol
*binding_protocol
;
3434 efi_handle_t
*child_handle_buffer
= NULL
;
3435 size_t number_of_children
= 0;
3437 size_t stop_count
= 0;
3438 struct efi_object
*efiobj
;
3440 EFI_ENTRY("%p, %p, %p", controller_handle
, driver_image_handle
,
3443 efiobj
= efi_search_obj(controller_handle
);
3445 r
= EFI_INVALID_PARAMETER
;
3449 if (child_handle
&& !efi_search_obj(child_handle
)) {
3450 r
= EFI_INVALID_PARAMETER
;
3454 /* If no driver handle is supplied, disconnect all drivers */
3455 if (!driver_image_handle
) {
3456 r
= efi_disconnect_all_drivers(efiobj
, NULL
, child_handle
);
3460 /* Create list of child handles */
3462 number_of_children
= 1;
3463 child_handle_buffer
= &child_handle
;
3465 efi_get_child_controllers(efiobj
,
3466 driver_image_handle
,
3467 &number_of_children
,
3468 &child_handle_buffer
);
3471 /* Get the driver binding protocol */
3472 r
= EFI_CALL(efi_open_protocol(driver_image_handle
,
3473 &efi_guid_driver_binding_protocol
,
3474 (void **)&binding_protocol
,
3475 driver_image_handle
, NULL
,
3476 EFI_OPEN_PROTOCOL_GET_PROTOCOL
));
3477 if (r
!= EFI_SUCCESS
)
3479 /* Remove the children */
3480 if (number_of_children
) {
3481 r
= EFI_CALL(binding_protocol
->stop(binding_protocol
,
3484 child_handle_buffer
));
3485 if (r
== EFI_SUCCESS
)
3488 /* Remove the driver */
3490 r
= EFI_CALL(binding_protocol
->stop(binding_protocol
,
3493 if (r
== EFI_SUCCESS
)
3495 EFI_CALL(efi_close_protocol(driver_image_handle
,
3496 &efi_guid_driver_binding_protocol
,
3497 driver_image_handle
, NULL
));
3505 free(child_handle_buffer
);
3509 static struct efi_boot_services efi_boot_services
= {
3511 .signature
= EFI_BOOT_SERVICES_SIGNATURE
,
3512 .revision
= EFI_SPECIFICATION_VERSION
,
3513 .headersize
= sizeof(struct efi_boot_services
),
3515 .raise_tpl
= efi_raise_tpl
,
3516 .restore_tpl
= efi_restore_tpl
,
3517 .allocate_pages
= efi_allocate_pages_ext
,
3518 .free_pages
= efi_free_pages_ext
,
3519 .get_memory_map
= efi_get_memory_map_ext
,
3520 .allocate_pool
= efi_allocate_pool_ext
,
3521 .free_pool
= efi_free_pool_ext
,
3522 .create_event
= efi_create_event_ext
,
3523 .set_timer
= efi_set_timer_ext
,
3524 .wait_for_event
= efi_wait_for_event
,
3525 .signal_event
= efi_signal_event_ext
,
3526 .close_event
= efi_close_event
,
3527 .check_event
= efi_check_event
,
3528 .install_protocol_interface
= efi_install_protocol_interface
,
3529 .reinstall_protocol_interface
= efi_reinstall_protocol_interface
,
3530 .uninstall_protocol_interface
= efi_uninstall_protocol_interface
,
3531 .handle_protocol
= efi_handle_protocol
,
3533 .register_protocol_notify
= efi_register_protocol_notify
,
3534 .locate_handle
= efi_locate_handle_ext
,
3535 .locate_device_path
= efi_locate_device_path
,
3536 .install_configuration_table
= efi_install_configuration_table_ext
,
3537 .load_image
= efi_load_image
,
3538 .start_image
= efi_start_image
,
3540 .unload_image
= efi_unload_image
,
3541 .exit_boot_services
= efi_exit_boot_services
,
3542 .get_next_monotonic_count
= efi_get_next_monotonic_count
,
3544 .set_watchdog_timer
= efi_set_watchdog_timer
,
3545 .connect_controller
= efi_connect_controller
,
3546 .disconnect_controller
= efi_disconnect_controller
,
3547 .open_protocol
= efi_open_protocol
,
3548 .close_protocol
= efi_close_protocol
,
3549 .open_protocol_information
= efi_open_protocol_information
,
3550 .protocols_per_handle
= efi_protocols_per_handle
,
3551 .locate_handle_buffer
= efi_locate_handle_buffer
,
3552 .locate_protocol
= efi_locate_protocol
,
3553 .install_multiple_protocol_interfaces
=
3554 efi_install_multiple_protocol_interfaces
,
3555 .uninstall_multiple_protocol_interfaces
=
3556 efi_uninstall_multiple_protocol_interfaces
,
3557 .calculate_crc32
= efi_calculate_crc32
,
3558 .copy_mem
= efi_copy_mem
,
3559 .set_mem
= efi_set_mem
,
3560 .create_event_ex
= efi_create_event_ex
,
3563 static u16 __efi_runtime_data firmware_vendor
[] = L
"Das U-Boot";
3565 struct efi_system_table __efi_runtime_data systab
= {
3567 .signature
= EFI_SYSTEM_TABLE_SIGNATURE
,
3568 .revision
= EFI_SPECIFICATION_VERSION
,
3569 .headersize
= sizeof(struct efi_system_table
),
3571 .fw_vendor
= firmware_vendor
,
3572 .fw_revision
= FW_VERSION
<< 16 | FW_PATCHLEVEL
<< 8,
3573 .con_in
= (void *)&efi_con_in
,
3574 .con_out
= (void *)&efi_con_out
,
3575 .std_err
= (void *)&efi_con_out
,
3576 .runtime
= (void *)&efi_runtime_services
,
3577 .boottime
= (void *)&efi_boot_services
,
3583 * efi_initialize_system_table() - Initialize system table
3585 * Return: status code
3587 efi_status_t
efi_initialize_system_table(void)
3591 /* Allocate configuration table array */
3592 ret
= efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA
,
3593 EFI_MAX_CONFIGURATION_TABLES
*
3594 sizeof(struct efi_configuration_table
),
3595 (void **)&systab
.tables
);
3597 /* Set CRC32 field in table headers */
3598 efi_update_table_header_crc32(&systab
.hdr
);
3599 efi_update_table_header_crc32(&efi_runtime_services
.hdr
);
3600 efi_update_table_header_crc32(&efi_boot_services
.hdr
);