1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application boot time services
5 * Copyright (c) 2016 Alexander Graf
11 #include <dm/device.h>
13 #include <efi_loader.h>
19 #include <u-boot/crc.h>
22 #include <asm/global_data.h>
23 #include <asm/setjmp.h>
24 #include <linux/libfdt_env.h>
26 DECLARE_GLOBAL_DATA_PTR;
28 /* Task priority level */
29 static efi_uintn_t efi_tpl = TPL_APPLICATION;
31 /* This list contains all the EFI objects our payload has access to */
32 LIST_HEAD(efi_obj_list);
34 /* List of all events */
35 __efi_runtime_data LIST_HEAD(efi_events);
37 /* List of queued events */
38 static LIST_HEAD(efi_event_queue);
40 /* Flag to disable timer activity in ExitBootServices() */
41 static bool timers_enabled = true;
43 /* Flag used by the selftest to avoid detaching devices in ExitBootServices() */
44 bool efi_st_keep_devices;
46 /* List of all events registered by RegisterProtocolNotify() */
47 static LIST_HEAD(efi_register_notify_events);
49 /* Handle of the currently executing image */
50 static efi_handle_t current_image;
52 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
54 * The "gd" pointer lives in a register on ARM and RISC-V that we declare
55 * fixed when compiling U-Boot. However, the payload does not know about that
56 * restriction so we need to manually swap its and our view of that register on
57 * EFI callback entry/exit.
59 static volatile gd_t *efi_gd, *app_gd;
62 static efi_status_t efi_uninstall_protocol
63 (efi_handle_t handle, const efi_guid_t *protocol,
64 void *protocol_interface, bool preserve);
66 /* 1 if inside U-Boot code, 0 if inside EFI payload code */
67 static int entry_count = 1;
68 static int nesting_level;
69 /* GUID of the device tree table */
70 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
71 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
72 const efi_guid_t efi_guid_driver_binding_protocol =
73 EFI_DRIVER_BINDING_PROTOCOL_GUID;
75 /* event group ExitBootServices() invoked */
76 const efi_guid_t efi_guid_event_group_exit_boot_services =
77 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
78 /* event group before ExitBootServices() invoked */
79 const efi_guid_t efi_guid_event_group_before_exit_boot_services =
80 EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES;
81 /* event group SetVirtualAddressMap() invoked */
82 const efi_guid_t efi_guid_event_group_virtual_address_change =
83 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
84 /* event group memory map changed */
85 const efi_guid_t efi_guid_event_group_memory_map_change =
86 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
87 /* event group boot manager about to boot */
88 const efi_guid_t efi_guid_event_group_ready_to_boot =
89 EFI_EVENT_GROUP_READY_TO_BOOT;
90 /* event group ResetSystem() invoked (before ExitBootServices) */
91 const efi_guid_t efi_guid_event_group_reset_system =
92 EFI_EVENT_GROUP_RESET_SYSTEM;
93 /* GUIDs of the Load File and Load File2 protocols */
94 const efi_guid_t efi_guid_load_file_protocol = EFI_LOAD_FILE_PROTOCOL_GUID;
95 const efi_guid_t efi_guid_load_file2_protocol = EFI_LOAD_FILE2_PROTOCOL_GUID;
96 /* GUID of the SMBIOS table */
97 const efi_guid_t smbios_guid = SMBIOS_TABLE_GUID;
99 static efi_status_t EFIAPI efi_disconnect_controller(
100 efi_handle_t controller_handle,
101 efi_handle_t driver_image_handle,
102 efi_handle_t child_handle);
105 efi_status_t EFIAPI efi_connect_controller(efi_handle_t controller_handle,
106 efi_handle_t *driver_image_handle,
107 struct efi_device_path *remain_device_path,
110 /* Called on every callback entry */
111 int __efi_entry_check(void)
113 int ret = entry_count++ == 0;
114 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
122 /* Called on every callback exit */
123 int __efi_exit_check(void)
125 int ret = --entry_count == 0;
126 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
133 * efi_save_gd() - save global data register
135 * On the ARM and RISC-V architectures gd is mapped to a fixed register.
136 * As this register may be overwritten by an EFI payload we save it here
137 * and restore it on every callback entered.
139 * This function is called after relocation from initr_reloc_global_data().
141 void efi_save_gd(void)
143 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
149 * efi_restore_gd() - restore global data register
151 * On the ARM and RISC-V architectures gd is mapped to a fixed register.
152 * Restore it after returning from the UEFI world to the value saved via
155 void efi_restore_gd(void)
157 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
158 /* Only restore if we're already in EFI context */
166 * indent_string() - returns a string for indenting with two spaces per level
167 * @level: indent level
169 * A maximum of ten indent levels is supported. Higher indent levels will be
172 * Return: A string for indenting with two spaces per level is
175 static const char *indent_string(int level)
177 const char *indent = " ";
178 const int max = strlen(indent);
180 level = min(max, level * 2);
181 return &indent[max - level];
184 const char *__efi_nesting(void)
186 return indent_string(nesting_level);
189 const char *__efi_nesting_inc(void)
191 return indent_string(nesting_level++);
194 const char *__efi_nesting_dec(void)
196 return indent_string(--nesting_level);
200 * efi_event_is_queued() - check if an event is queued
203 * Return: true if event is queued
205 static bool efi_event_is_queued(struct efi_event *event)
207 return !!event->queue_link.next;
211 * efi_purge_handle() - Clean the deleted handle from the various lists
212 * @handle: handle to remove
214 * Return: status code
216 static efi_status_t efi_purge_handle(efi_handle_t handle)
218 struct efi_register_notify_event *item;
220 if (!list_empty(&handle->protocols))
221 return EFI_ACCESS_DENIED;
222 /* The handle is about to be freed. Remove it from events */
223 list_for_each_entry(item, &efi_register_notify_events, link) {
224 struct efi_protocol_notification *hitem, *hnext;
226 list_for_each_entry_safe(hitem, hnext, &item->handles, link) {
227 if (handle == hitem->handle) {
228 list_del(&hitem->link);
233 /* The last protocol has been removed, delete the handle. */
234 list_del(&handle->link);
241 * efi_process_event_queue() - process event queue
243 static void efi_process_event_queue(void)
245 while (!list_empty(&efi_event_queue)) {
246 struct efi_event *event;
249 event = list_first_entry(&efi_event_queue, struct efi_event,
251 if (efi_tpl >= event->notify_tpl)
253 list_del(&event->queue_link);
254 event->queue_link.next = NULL;
255 event->queue_link.prev = NULL;
256 /* Events must be executed at the event's TPL */
258 efi_tpl = event->notify_tpl;
259 EFI_CALL_VOID(event->notify_function(event,
260 event->notify_context));
262 if (event->type == EVT_NOTIFY_SIGNAL)
263 event->is_signaled = 0;
268 * efi_queue_event() - queue an EFI event
269 * @event: event to signal
271 * This function queues the notification function of the event for future
275 static void efi_queue_event(struct efi_event *event)
277 struct efi_event *item;
279 if (!event->notify_function)
282 if (!efi_event_is_queued(event)) {
284 * Events must be notified in order of decreasing task priority
285 * level. Insert the new event accordingly.
287 list_for_each_entry(item, &efi_event_queue, queue_link) {
288 if (item->notify_tpl < event->notify_tpl) {
289 list_add_tail(&event->queue_link,
296 list_add_tail(&event->queue_link, &efi_event_queue);
297 efi_process_event_queue();
302 * is_valid_tpl() - check if the task priority level is valid
304 * @tpl: TPL level to check
305 * Return: status code
307 static efi_status_t is_valid_tpl(efi_uintn_t tpl)
310 case TPL_APPLICATION:
315 return EFI_INVALID_PARAMETER;
320 * efi_signal_event() - signal an EFI event
321 * @event: event to signal
323 * This function signals an event. If the event belongs to an event group, all
324 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL,
325 * their notification function is queued.
327 * For the SignalEvent service see efi_signal_event_ext.
329 void efi_signal_event(struct efi_event *event)
331 if (event->is_signaled)
334 struct efi_event *evt;
337 * The signaled state has to set before executing any
338 * notification function
340 list_for_each_entry(evt, &efi_events, link) {
341 if (!evt->group || guidcmp(evt->group, event->group))
343 if (evt->is_signaled)
345 evt->is_signaled = true;
347 list_for_each_entry(evt, &efi_events, link) {
348 if (!evt->group || guidcmp(evt->group, event->group))
350 efi_queue_event(evt);
353 event->is_signaled = true;
354 efi_queue_event(event);
359 * efi_raise_tpl() - raise the task priority level
360 * @new_tpl: new value of the task priority level
362 * This function implements the RaiseTpl service.
364 * See the Unified Extensible Firmware Interface (UEFI) specification for
367 * Return: old value of the task priority level
369 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
371 efi_uintn_t old_tpl = efi_tpl;
373 EFI_ENTRY("0x%zx", new_tpl);
375 if (new_tpl < efi_tpl)
376 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
378 if (efi_tpl > TPL_HIGH_LEVEL)
379 efi_tpl = TPL_HIGH_LEVEL;
381 EFI_EXIT(EFI_SUCCESS);
386 * efi_restore_tpl() - lower the task priority level
387 * @old_tpl: value of the task priority level to be restored
389 * This function implements the RestoreTpl service.
391 * See the Unified Extensible Firmware Interface (UEFI) specification for
394 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
396 EFI_ENTRY("0x%zx", old_tpl);
398 if (old_tpl > efi_tpl)
399 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
401 if (efi_tpl > TPL_HIGH_LEVEL)
402 efi_tpl = TPL_HIGH_LEVEL;
405 * Lowering the TPL may have made queued events eligible for execution.
409 EFI_EXIT(EFI_SUCCESS);
413 * efi_allocate_pages_ext() - allocate memory pages
414 * @type: type of allocation to be performed
415 * @memory_type: usage type of the allocated memory
416 * @pages: number of pages to be allocated
417 * @memory: allocated memory
419 * This function implements the AllocatePages service.
421 * See the Unified Extensible Firmware Interface (UEFI) specification for
424 * Return: status code
426 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
432 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
433 r = efi_allocate_pages(type, memory_type, pages, memory);
438 * efi_free_pages_ext() - Free memory pages.
439 * @memory: start of the memory area to be freed
440 * @pages: number of pages to be freed
442 * This function implements the FreePages service.
444 * See the Unified Extensible Firmware Interface (UEFI) specification for
447 * Return: status code
449 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
454 EFI_ENTRY("%llx, 0x%zx", memory, pages);
455 r = efi_free_pages(memory, pages);
460 * efi_get_memory_map_ext() - get map describing memory usage
461 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
462 * on exit the size of the copied memory map
463 * @memory_map: buffer to which the memory map is written
464 * @map_key: key for the memory map
465 * @descriptor_size: size of an individual memory descriptor
466 * @descriptor_version: version number of the memory descriptor structure
468 * This function implements the GetMemoryMap service.
470 * See the Unified Extensible Firmware Interface (UEFI) specification for
473 * Return: status code
475 static efi_status_t EFIAPI efi_get_memory_map_ext(
476 efi_uintn_t *memory_map_size,
477 struct efi_mem_desc *memory_map,
478 efi_uintn_t *map_key,
479 efi_uintn_t *descriptor_size,
480 uint32_t *descriptor_version)
484 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
485 map_key, descriptor_size, descriptor_version);
486 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
487 descriptor_size, descriptor_version);
492 * efi_allocate_pool_ext() - allocate memory from pool
493 * @pool_type: type of the pool from which memory is to be allocated
494 * @size: number of bytes to be allocated
495 * @buffer: allocated memory
497 * This function implements the AllocatePool service.
499 * See the Unified Extensible Firmware Interface (UEFI) specification for
502 * Return: status code
504 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
510 EFI_ENTRY("%d, %zu, %p", pool_type, size, buffer);
511 r = efi_allocate_pool(pool_type, size, buffer);
516 * efi_free_pool_ext() - free memory from pool
517 * @buffer: start of memory to be freed
519 * This function implements the FreePool service.
521 * See the Unified Extensible Firmware Interface (UEFI) specification for
524 * Return: status code
526 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
530 EFI_ENTRY("%p", buffer);
531 r = efi_free_pool(buffer);
536 * efi_add_handle() - add a new handle to the object list
538 * @handle: handle to be added
540 * The protocols list is initialized. The handle is added to the list of known
543 void efi_add_handle(efi_handle_t handle)
547 INIT_LIST_HEAD(&handle->protocols);
548 list_add_tail(&handle->link, &efi_obj_list);
552 * efi_create_handle() - create handle
553 * @handle: new handle
555 * Return: status code
557 efi_status_t efi_create_handle(efi_handle_t *handle)
559 struct efi_object *obj;
561 obj = calloc(1, sizeof(struct efi_object));
563 return EFI_OUT_OF_RESOURCES;
572 * efi_search_protocol() - find a protocol on a handle.
574 * @protocol_guid: GUID of the protocol
575 * @handler: reference to the protocol
577 * Return: status code
579 efi_status_t efi_search_protocol(const efi_handle_t handle,
580 const efi_guid_t *protocol_guid,
581 struct efi_handler **handler)
583 struct efi_object *efiobj;
584 struct list_head *lhandle;
586 if (!handle || !protocol_guid)
587 return EFI_INVALID_PARAMETER;
588 efiobj = efi_search_obj(handle);
590 return EFI_INVALID_PARAMETER;
591 list_for_each(lhandle, &efiobj->protocols) {
592 struct efi_handler *protocol;
594 protocol = list_entry(lhandle, struct efi_handler, link);
595 if (!guidcmp(&protocol->guid, protocol_guid)) {
601 return EFI_NOT_FOUND;
605 * efi_remove_protocol() - delete protocol from a handle
606 * @handle: handle from which the protocol shall be deleted
607 * @protocol: GUID of the protocol to be deleted
608 * @protocol_interface: interface of the protocol implementation
610 * Return: status code
612 static efi_status_t efi_remove_protocol(const efi_handle_t handle,
613 const efi_guid_t *protocol,
614 void *protocol_interface)
616 struct efi_handler *handler;
619 ret = efi_search_protocol(handle, protocol, &handler);
620 if (ret != EFI_SUCCESS)
622 if (handler->protocol_interface != protocol_interface)
623 return EFI_NOT_FOUND;
624 list_del(&handler->link);
630 * efi_remove_all_protocols() - delete all protocols from a handle
631 * @handle: handle from which the protocols shall be deleted
633 * Return: status code
635 static efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
637 struct efi_object *efiobj;
638 struct efi_handler *protocol;
639 struct efi_handler *pos;
641 efiobj = efi_search_obj(handle);
643 return EFI_INVALID_PARAMETER;
644 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
647 ret = efi_uninstall_protocol(handle, &protocol->guid,
648 protocol->protocol_interface, true);
649 if (ret != EFI_SUCCESS)
656 * efi_delete_handle() - delete handle
658 * @handle: handle to delete
660 * Return: status code
662 efi_status_t efi_delete_handle(efi_handle_t handle)
666 ret = efi_remove_all_protocols(handle);
667 if (ret != EFI_SUCCESS) {
668 log_err("Handle %p has protocols installed. Unable to delete\n", handle);
672 return efi_purge_handle(handle);
676 * efi_is_event() - check if a pointer is a valid event
677 * @event: pointer to check
679 * Return: status code
681 static efi_status_t efi_is_event(const struct efi_event *event)
683 const struct efi_event *evt;
686 return EFI_INVALID_PARAMETER;
687 list_for_each_entry(evt, &efi_events, link) {
691 return EFI_INVALID_PARAMETER;
695 * efi_create_event() - create an event
697 * @type: type of the event to create
698 * @notify_tpl: task priority level of the event
699 * @notify_function: notification function of the event
700 * @notify_context: pointer passed to the notification function
701 * @group: event group
702 * @event: created event
704 * This function is used inside U-Boot code to create an event.
706 * For the API function implementing the CreateEvent service see
707 * efi_create_event_ext.
709 * Return: status code
711 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
712 void (EFIAPI *notify_function) (
713 struct efi_event *event,
715 void *notify_context, efi_guid_t *group,
716 struct efi_event **event)
718 struct efi_event *evt;
723 return EFI_INVALID_PARAMETER;
728 case EVT_NOTIFY_SIGNAL:
729 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
730 case EVT_NOTIFY_WAIT:
731 case EVT_TIMER | EVT_NOTIFY_WAIT:
732 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
733 pool_type = EFI_BOOT_SERVICES_DATA;
735 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
736 pool_type = EFI_RUNTIME_SERVICES_DATA;
739 return EFI_INVALID_PARAMETER;
743 * The UEFI specification requires event notification levels to be
744 * > TPL_APPLICATION and <= TPL_HIGH_LEVEL.
746 * Parameter NotifyTpl should not be checked if it is not used.
748 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
749 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS ||
750 notify_tpl == TPL_APPLICATION))
751 return EFI_INVALID_PARAMETER;
753 ret = efi_allocate_pool(pool_type, sizeof(struct efi_event),
755 if (ret != EFI_SUCCESS)
757 memset(evt, 0, sizeof(struct efi_event));
759 evt->notify_tpl = notify_tpl;
760 evt->notify_function = notify_function;
761 evt->notify_context = notify_context;
763 /* Disable timers on boot up */
764 evt->trigger_next = -1ULL;
765 list_add_tail(&evt->link, &efi_events);
771 * efi_create_event_ex() - create an event in a group
773 * @type: type of the event to create
774 * @notify_tpl: task priority level of the event
775 * @notify_function: notification function of the event
776 * @notify_context: pointer passed to the notification function
777 * @event: created event
778 * @event_group: event group
780 * This function implements the CreateEventEx service.
782 * See the Unified Extensible Firmware Interface (UEFI) specification for
785 * Return: status code
788 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
789 void (EFIAPI *notify_function) (
790 struct efi_event *event,
792 void *notify_context,
793 efi_guid_t *event_group,
794 struct efi_event **event)
798 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUs", type, notify_tpl, notify_function,
799 notify_context, event_group);
802 * The allowable input parameters are the same as in CreateEvent()
803 * except for the following two disallowed event types.
806 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
807 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
808 ret = EFI_INVALID_PARAMETER;
812 ret = efi_create_event(type, notify_tpl, notify_function,
813 notify_context, event_group, event);
815 return EFI_EXIT(ret);
819 * efi_create_event_ext() - create an event
820 * @type: type of the event to create
821 * @notify_tpl: task priority level of the event
822 * @notify_function: notification function of the event
823 * @notify_context: pointer passed to the notification function
824 * @event: created event
826 * This function implements the CreateEvent service.
828 * See the Unified Extensible Firmware Interface (UEFI) specification for
831 * Return: status code
833 static efi_status_t EFIAPI efi_create_event_ext(
834 uint32_t type, efi_uintn_t notify_tpl,
835 void (EFIAPI *notify_function) (
836 struct efi_event *event,
838 void *notify_context, struct efi_event **event)
840 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
842 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
843 notify_context, NULL, event));
847 * efi_timer_check() - check if a timer event has occurred
849 * Check if a timer event has occurred or a queued notification function should
852 * Our timers have to work without interrupts, so we check whenever keyboard
853 * input or disk accesses happen if enough time elapsed for them to fire.
855 void efi_timer_check(void)
857 struct efi_event *evt;
858 u64 now = timer_get_us();
860 list_for_each_entry(evt, &efi_events, link) {
863 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
865 switch (evt->trigger_type) {
866 case EFI_TIMER_RELATIVE:
867 evt->trigger_type = EFI_TIMER_STOP;
869 case EFI_TIMER_PERIODIC:
870 evt->trigger_next += evt->trigger_time;
875 evt->is_signaled = false;
876 efi_signal_event(evt);
878 efi_process_event_queue();
883 * efi_set_timer() - set the trigger time for a timer event or stop the event
884 * @event: event for which the timer is set
885 * @type: type of the timer
886 * @trigger_time: trigger period in multiples of 100 ns
888 * This is the function for internal usage in U-Boot. For the API function
889 * implementing the SetTimer service see efi_set_timer_ext.
891 * Return: status code
893 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
894 uint64_t trigger_time)
896 /* Check that the event is valid */
897 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
898 return EFI_INVALID_PARAMETER;
901 * The parameter defines a multiple of 100 ns.
902 * We use multiples of 1000 ns. So divide by 10.
904 do_div(trigger_time, 10);
908 event->trigger_next = -1ULL;
910 case EFI_TIMER_PERIODIC:
911 case EFI_TIMER_RELATIVE:
912 event->trigger_next = timer_get_us() + trigger_time;
915 return EFI_INVALID_PARAMETER;
917 event->trigger_type = type;
918 event->trigger_time = trigger_time;
919 event->is_signaled = false;
924 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
926 * @event: event for which the timer is set
927 * @type: type of the timer
928 * @trigger_time: trigger period in multiples of 100 ns
930 * This function implements the SetTimer service.
932 * See the Unified Extensible Firmware Interface (UEFI) specification for
936 * Return: status code
938 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
939 enum efi_timer_delay type,
940 uint64_t trigger_time)
942 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
943 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
947 * efi_wait_for_event() - wait for events to be signaled
948 * @num_events: number of events to be waited for
949 * @event: events to be waited for
950 * @index: index of the event that was signaled
952 * This function implements the WaitForEvent service.
954 * See the Unified Extensible Firmware Interface (UEFI) specification for
957 * Return: status code
959 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
960 struct efi_event **event,
965 EFI_ENTRY("%zu, %p, %p", num_events, event, index);
967 /* Check parameters */
968 if (!num_events || !event)
969 return EFI_EXIT(EFI_INVALID_PARAMETER);
971 if (efi_tpl != TPL_APPLICATION)
972 return EFI_EXIT(EFI_UNSUPPORTED);
973 for (i = 0; i < num_events; ++i) {
974 if (efi_is_event(event[i]) != EFI_SUCCESS)
975 return EFI_EXIT(EFI_INVALID_PARAMETER);
976 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
977 return EFI_EXIT(EFI_INVALID_PARAMETER);
978 if (!event[i]->is_signaled)
979 efi_queue_event(event[i]);
982 /* Wait for signal */
984 for (i = 0; i < num_events; ++i) {
985 if (event[i]->is_signaled)
988 /* Allow events to occur. */
994 * Reset the signal which is passed to the caller to allow periodic
997 event[i]->is_signaled = false;
1001 return EFI_EXIT(EFI_SUCCESS);
1005 * efi_signal_event_ext() - signal an EFI event
1006 * @event: event to signal
1008 * This function implements the SignalEvent service.
1010 * See the Unified Extensible Firmware Interface (UEFI) specification for
1013 * This functions sets the signaled state of the event and queues the
1014 * notification function for execution.
1016 * Return: status code
1018 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
1020 EFI_ENTRY("%p", event);
1021 if (efi_is_event(event) != EFI_SUCCESS)
1022 return EFI_EXIT(EFI_INVALID_PARAMETER);
1023 efi_signal_event(event);
1024 return EFI_EXIT(EFI_SUCCESS);
1028 * efi_close_event() - close an EFI event
1029 * @event: event to close
1031 * This function implements the CloseEvent service.
1033 * See the Unified Extensible Firmware Interface (UEFI) specification for
1036 * Return: status code
1038 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
1040 struct efi_register_notify_event *item, *next;
1042 EFI_ENTRY("%p", event);
1043 if (efi_is_event(event) != EFI_SUCCESS)
1044 return EFI_EXIT(EFI_INVALID_PARAMETER);
1046 /* Remove protocol notify registrations for the event */
1047 list_for_each_entry_safe(item, next, &efi_register_notify_events,
1049 if (event == item->event) {
1050 struct efi_protocol_notification *hitem, *hnext;
1052 /* Remove signaled handles */
1053 list_for_each_entry_safe(hitem, hnext, &item->handles,
1055 list_del(&hitem->link);
1058 list_del(&item->link);
1062 /* Remove event from queue */
1063 if (efi_event_is_queued(event))
1064 list_del(&event->queue_link);
1066 list_del(&event->link);
1067 efi_free_pool(event);
1068 return EFI_EXIT(EFI_SUCCESS);
1072 * efi_check_event() - check if an event is signaled
1073 * @event: event to check
1075 * This function implements the CheckEvent service.
1077 * See the Unified Extensible Firmware Interface (UEFI) specification for
1080 * If an event is not signaled yet, the notification function is queued. The
1081 * signaled state is cleared.
1083 * Return: status code
1085 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
1087 EFI_ENTRY("%p", event);
1089 if (efi_is_event(event) != EFI_SUCCESS ||
1090 event->type & EVT_NOTIFY_SIGNAL)
1091 return EFI_EXIT(EFI_INVALID_PARAMETER);
1092 if (!event->is_signaled)
1093 efi_queue_event(event);
1094 if (event->is_signaled) {
1095 event->is_signaled = false;
1096 return EFI_EXIT(EFI_SUCCESS);
1098 return EFI_EXIT(EFI_NOT_READY);
1102 * efi_search_obj() - find the internal EFI object for a handle
1103 * @handle: handle to find
1105 * Return: EFI object
1107 struct efi_object *efi_search_obj(const efi_handle_t handle)
1109 struct efi_object *efiobj;
1114 list_for_each_entry(efiobj, &efi_obj_list, link) {
1115 if (efiobj == handle)
1122 * efi_open_protocol_info_entry() - create open protocol info entry and add it
1124 * @handler: handler of a protocol
1126 * Return: open protocol info entry
1128 static struct efi_open_protocol_info_entry *efi_create_open_info(
1129 struct efi_handler *handler)
1131 struct efi_open_protocol_info_item *item;
1133 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
1136 /* Append the item to the open protocol info list. */
1137 list_add_tail(&item->link, &handler->open_infos);
1143 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1144 * @item: open protocol info entry to delete
1146 * Return: status code
1148 static efi_status_t efi_delete_open_info(
1149 struct efi_open_protocol_info_item *item)
1151 list_del(&item->link);
1157 * efi_add_protocol() - install new protocol on a handle
1158 * @handle: handle on which the protocol shall be installed
1159 * @protocol: GUID of the protocol to be installed
1160 * @protocol_interface: interface of the protocol implementation
1162 * Return: status code
1164 efi_status_t efi_add_protocol(const efi_handle_t handle,
1165 const efi_guid_t *protocol,
1166 void *protocol_interface)
1168 struct efi_object *efiobj;
1169 struct efi_handler *handler;
1171 struct efi_register_notify_event *event;
1173 efiobj = efi_search_obj(handle);
1175 return EFI_INVALID_PARAMETER;
1176 ret = efi_search_protocol(handle, protocol, NULL);
1177 if (ret != EFI_NOT_FOUND)
1178 return EFI_INVALID_PARAMETER;
1179 handler = calloc(1, sizeof(struct efi_handler));
1181 return EFI_OUT_OF_RESOURCES;
1182 memcpy((void *)&handler->guid, protocol, sizeof(efi_guid_t));
1183 handler->protocol_interface = protocol_interface;
1184 INIT_LIST_HEAD(&handler->open_infos);
1185 list_add_tail(&handler->link, &efiobj->protocols);
1187 /* Notify registered events */
1188 list_for_each_entry(event, &efi_register_notify_events, link) {
1189 if (!guidcmp(protocol, &event->protocol)) {
1190 struct efi_protocol_notification *notif;
1192 notif = calloc(1, sizeof(*notif));
1194 list_del(&handler->link);
1196 return EFI_OUT_OF_RESOURCES;
1198 notif->handle = handle;
1199 list_add_tail(¬if->link, &event->handles);
1200 event->event->is_signaled = false;
1201 efi_signal_event(event->event);
1205 if (!guidcmp(&efi_guid_device_path, protocol))
1206 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1211 * efi_install_protocol_interface() - install protocol interface
1212 * @handle: handle on which the protocol shall be installed
1213 * @protocol: GUID of the protocol to be installed
1214 * @protocol_interface_type: type of the interface to be installed,
1215 * always EFI_NATIVE_INTERFACE
1216 * @protocol_interface: interface of the protocol implementation
1218 * This function implements the InstallProtocolInterface service.
1220 * See the Unified Extensible Firmware Interface (UEFI) specification for
1223 * Return: status code
1225 static efi_status_t EFIAPI efi_install_protocol_interface(
1226 efi_handle_t *handle, const efi_guid_t *protocol,
1227 int protocol_interface_type, void *protocol_interface)
1231 EFI_ENTRY("%p, %pUs, %d, %p", handle, protocol, protocol_interface_type,
1232 protocol_interface);
1234 if (!handle || !protocol ||
1235 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1236 r = EFI_INVALID_PARAMETER;
1240 /* Create new handle if requested. */
1242 r = efi_create_handle(handle);
1243 if (r != EFI_SUCCESS)
1245 EFI_PRINT("new handle %p\n", *handle);
1247 EFI_PRINT("handle %p\n", *handle);
1249 /* Add new protocol */
1250 r = efi_add_protocol(*handle, protocol, protocol_interface);
1256 * efi_get_drivers() - get all drivers associated to a controller
1257 * @handle: handle of the controller
1258 * @protocol: protocol GUID (optional)
1259 * @number_of_drivers: number of child controllers
1260 * @driver_handle_buffer: handles of the the drivers
1262 * The allocated buffer has to be freed with free().
1264 * Return: status code
1266 static efi_status_t efi_get_drivers(efi_handle_t handle,
1267 const efi_guid_t *protocol,
1268 efi_uintn_t *number_of_drivers,
1269 efi_handle_t **driver_handle_buffer)
1271 struct efi_handler *handler;
1272 struct efi_open_protocol_info_item *item;
1273 efi_uintn_t count = 0, i;
1276 /* Count all driver associations */
1277 list_for_each_entry(handler, &handle->protocols, link) {
1278 if (protocol && guidcmp(&handler->guid, protocol))
1280 list_for_each_entry(item, &handler->open_infos, link) {
1281 if (item->info.attributes &
1282 EFI_OPEN_PROTOCOL_BY_DRIVER)
1286 *number_of_drivers = 0;
1288 *driver_handle_buffer = NULL;
1292 * Create buffer. In case of duplicate driver assignments the buffer
1293 * will be too large. But that does not harm.
1295 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1296 if (!*driver_handle_buffer)
1297 return EFI_OUT_OF_RESOURCES;
1298 /* Collect unique driver handles */
1299 list_for_each_entry(handler, &handle->protocols, link) {
1300 if (protocol && guidcmp(&handler->guid, protocol))
1302 list_for_each_entry(item, &handler->open_infos, link) {
1303 if (item->info.attributes &
1304 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1305 /* Check this is a new driver */
1307 for (i = 0; i < *number_of_drivers; ++i) {
1308 if ((*driver_handle_buffer)[i] ==
1309 item->info.agent_handle)
1312 /* Copy handle to buffer */
1314 i = (*number_of_drivers)++;
1315 (*driver_handle_buffer)[i] =
1316 item->info.agent_handle;
1325 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1326 * @handle: handle of the controller
1327 * @protocol: protocol GUID (optional)
1328 * @child_handle: handle of the child to destroy
1330 * This function implements the DisconnectController service.
1332 * See the Unified Extensible Firmware Interface (UEFI) specification for
1335 * Return: status code
1337 static efi_status_t efi_disconnect_all_drivers
1338 (efi_handle_t handle,
1339 const efi_guid_t *protocol,
1340 efi_handle_t child_handle)
1342 efi_uintn_t number_of_drivers;
1343 efi_handle_t *driver_handle_buffer;
1344 efi_status_t r, ret;
1346 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1347 &driver_handle_buffer);
1348 if (ret != EFI_SUCCESS)
1350 if (!number_of_drivers)
1353 while (number_of_drivers) {
1354 r = EFI_CALL(efi_disconnect_controller(
1356 driver_handle_buffer[--number_of_drivers],
1358 if (r != EFI_SUCCESS)
1362 free(driver_handle_buffer);
1367 * efi_uninstall_protocol() - uninstall protocol interface
1369 * @handle: handle from which the protocol shall be removed
1370 * @protocol: GUID of the protocol to be removed
1371 * @protocol_interface: interface to be removed
1372 * @preserve: preserve or delete the handle and remove it from any
1373 * list it participates if no protocols remain
1375 * This function DOES NOT delete a handle without installed protocol.
1377 * Return: status code
1379 static efi_status_t efi_uninstall_protocol
1380 (efi_handle_t handle, const efi_guid_t *protocol,
1381 void *protocol_interface, bool preserve)
1383 struct efi_handler *handler;
1384 struct efi_open_protocol_info_item *item;
1385 struct efi_open_protocol_info_item *pos;
1388 /* Find the protocol on the handle */
1389 r = efi_search_protocol(handle, protocol, &handler);
1390 if (r != EFI_SUCCESS)
1392 if (handler->protocol_interface != protocol_interface)
1393 return EFI_NOT_FOUND;
1394 /* Disconnect controllers */
1395 r = efi_disconnect_all_drivers(handle, protocol, NULL);
1396 if (r != EFI_SUCCESS) {
1397 r = EFI_ACCESS_DENIED;
1399 * This will reconnect all controllers of the handle, even ones
1400 * that were not connected before. This can be done better
1401 * but we are following the EDKII implementation on this for
1404 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
1407 /* Close protocol */
1408 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1409 if (item->info.attributes ==
1410 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1411 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1412 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1413 efi_delete_open_info(item);
1415 /* if agents didn't close the protocols properly */
1416 if (!list_empty(&handler->open_infos)) {
1417 r = EFI_ACCESS_DENIED;
1418 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
1421 r = efi_remove_protocol(handle, protocol, protocol_interface);
1422 if (r != EFI_SUCCESS)
1425 * We don't care about the return value here since the
1426 * handle might have more protocols installed
1429 efi_purge_handle(handle);
1435 * efi_uninstall_protocol_interface() - uninstall protocol interface
1436 * @handle: handle from which the protocol shall be removed
1437 * @protocol: GUID of the protocol to be removed
1438 * @protocol_interface: interface to be removed
1440 * This function implements the UninstallProtocolInterface service.
1442 * See the Unified Extensible Firmware Interface (UEFI) specification for
1445 * Return: status code
1447 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1448 (efi_handle_t handle, const efi_guid_t *protocol,
1449 void *protocol_interface)
1453 EFI_ENTRY("%p, %pUs, %p", handle, protocol, protocol_interface);
1455 ret = efi_uninstall_protocol(handle, protocol, protocol_interface, false);
1456 if (ret != EFI_SUCCESS)
1460 return EFI_EXIT(ret);
1464 * efi_register_protocol_notify() - register an event for notification when a
1465 * protocol is installed.
1466 * @protocol: GUID of the protocol whose installation shall be notified
1467 * @event: event to be signaled upon installation of the protocol
1468 * @registration: key for retrieving the registration information
1470 * This function implements the RegisterProtocolNotify service.
1471 * See the Unified Extensible Firmware Interface (UEFI) specification
1474 * Return: status code
1476 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
1477 struct efi_event *event,
1478 void **registration)
1480 struct efi_register_notify_event *item;
1481 efi_status_t ret = EFI_SUCCESS;
1483 EFI_ENTRY("%pUs, %p, %p", protocol, event, registration);
1485 if (!protocol || !event || !registration) {
1486 ret = EFI_INVALID_PARAMETER;
1490 item = calloc(1, sizeof(struct efi_register_notify_event));
1492 ret = EFI_OUT_OF_RESOURCES;
1496 item->event = event;
1497 guidcpy(&item->protocol, protocol);
1498 INIT_LIST_HEAD(&item->handles);
1500 list_add_tail(&item->link, &efi_register_notify_events);
1502 *registration = item;
1504 return EFI_EXIT(ret);
1508 * efi_search() - determine if an EFI handle implements a protocol
1510 * @search_type: selection criterion
1511 * @protocol: GUID of the protocol
1514 * See the documentation of the LocateHandle service in the UEFI specification.
1516 * Return: 0 if the handle implements the protocol
1518 static int efi_search(enum efi_locate_search_type search_type,
1519 const efi_guid_t *protocol, efi_handle_t handle)
1523 switch (search_type) {
1527 ret = efi_search_protocol(handle, protocol, NULL);
1528 return (ret != EFI_SUCCESS);
1530 /* Invalid search type */
1536 * efi_check_register_notify_event() - check if registration key is valid
1538 * Check that a pointer is a valid registration key as returned by
1539 * RegisterProtocolNotify().
1541 * @key: registration key
1542 * Return: valid registration key or NULL
1544 static struct efi_register_notify_event *efi_check_register_notify_event
1547 struct efi_register_notify_event *event;
1549 list_for_each_entry(event, &efi_register_notify_events, link) {
1550 if (event == (struct efi_register_notify_event *)key)
1557 * efi_locate_handle() - locate handles implementing a protocol
1559 * @search_type: selection criterion
1560 * @protocol: GUID of the protocol
1561 * @search_key: registration key
1562 * @buffer_size: size of the buffer to receive the handles in bytes
1563 * @buffer: buffer to receive the relevant handles
1565 * This function is meant for U-Boot internal calls. For the API implementation
1566 * of the LocateHandle service see efi_locate_handle_ext.
1568 * Return: status code
1570 static efi_status_t efi_locate_handle(
1571 enum efi_locate_search_type search_type,
1572 const efi_guid_t *protocol, void *search_key,
1573 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1575 struct efi_object *efiobj;
1576 efi_uintn_t size = 0;
1577 struct efi_register_notify_event *event;
1578 struct efi_protocol_notification *handle = NULL;
1580 /* Check parameters */
1581 switch (search_type) {
1584 case BY_REGISTER_NOTIFY:
1586 return EFI_INVALID_PARAMETER;
1587 /* Check that the registration key is valid */
1588 event = efi_check_register_notify_event(search_key);
1590 return EFI_INVALID_PARAMETER;
1594 return EFI_INVALID_PARAMETER;
1597 return EFI_INVALID_PARAMETER;
1600 /* Count how much space we need */
1601 if (search_type == BY_REGISTER_NOTIFY) {
1602 if (list_empty(&event->handles))
1603 return EFI_NOT_FOUND;
1604 handle = list_first_entry(&event->handles,
1605 struct efi_protocol_notification,
1607 efiobj = handle->handle;
1608 size += sizeof(void *);
1610 list_for_each_entry(efiobj, &efi_obj_list, link) {
1611 if (!efi_search(search_type, protocol, efiobj))
1612 size += sizeof(void *);
1615 return EFI_NOT_FOUND;
1619 return EFI_INVALID_PARAMETER;
1621 if (*buffer_size < size) {
1622 *buffer_size = size;
1623 return EFI_BUFFER_TOO_SMALL;
1626 *buffer_size = size;
1628 /* The buffer size is sufficient but there is no buffer */
1630 return EFI_INVALID_PARAMETER;
1632 /* Then fill the array */
1633 if (search_type == BY_REGISTER_NOTIFY) {
1635 list_del(&handle->link);
1637 list_for_each_entry(efiobj, &efi_obj_list, link) {
1638 if (!efi_search(search_type, protocol, efiobj))
1647 * efi_locate_handle_ext() - locate handles implementing a protocol.
1648 * @search_type: selection criterion
1649 * @protocol: GUID of the protocol
1650 * @search_key: registration key
1651 * @buffer_size: size of the buffer to receive the handles in bytes
1652 * @buffer: buffer to receive the relevant handles
1654 * This function implements the LocateHandle service.
1656 * See the Unified Extensible Firmware Interface (UEFI) specification for
1659 * Return: 0 if the handle implements the protocol
1661 static efi_status_t EFIAPI efi_locate_handle_ext(
1662 enum efi_locate_search_type search_type,
1663 const efi_guid_t *protocol, void *search_key,
1664 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1666 EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key,
1667 buffer_size, buffer);
1669 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1670 buffer_size, buffer));
1674 * efi_remove_configuration_table() - collapses configuration table entries,
1677 * @i: index of the table entry to be removed
1679 static void efi_remove_configuration_table(int i)
1681 struct efi_configuration_table *this = &systab.tables[i];
1682 struct efi_configuration_table *next = &systab.tables[i + 1];
1683 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1685 memmove(this, next, (ulong)end - (ulong)next);
1690 * efi_install_configuration_table() - adds, updates, or removes a
1691 * configuration table
1692 * @guid: GUID of the installed table
1693 * @table: table to be installed
1695 * This function is used for internal calls. For the API implementation of the
1696 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1698 * Return: status code
1700 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1703 struct efi_event *evt;
1707 return EFI_INVALID_PARAMETER;
1709 /* Check for GUID override */
1710 for (i = 0; i < systab.nr_tables; i++) {
1711 if (!guidcmp(guid, &systab.tables[i].guid)) {
1713 systab.tables[i].table = table;
1715 efi_remove_configuration_table(i);
1721 return EFI_NOT_FOUND;
1723 /* No override, check for overflow */
1724 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1725 return EFI_OUT_OF_RESOURCES;
1727 /* Add a new entry */
1728 guidcpy(&systab.tables[i].guid, guid);
1729 systab.tables[i].table = table;
1730 systab.nr_tables = i + 1;
1733 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1734 efi_update_table_header_crc32(&systab.hdr);
1736 /* Notify that the configuration table was changed */
1737 list_for_each_entry(evt, &efi_events, link) {
1738 if (evt->group && !guidcmp(evt->group, guid)) {
1739 efi_signal_event(evt);
1748 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1749 * configuration table.
1750 * @guid: GUID of the installed table
1751 * @table: table to be installed
1753 * This function implements the InstallConfigurationTable service.
1755 * See the Unified Extensible Firmware Interface (UEFI) specification for
1758 * Return: status code
1761 EFIAPI efi_install_configuration_table_ext(const efi_guid_t *guid,
1764 EFI_ENTRY("%pUs, %p", guid, table);
1765 return EFI_EXIT(efi_install_configuration_table(guid, table));
1769 * efi_setup_loaded_image() - initialize a loaded image
1771 * Initialize a loaded_image_info and loaded_image_info object with correct
1772 * protocols, boot-device, etc.
1774 * In case of an error \*handle_ptr and \*info_ptr are set to NULL and an error
1777 * @device_path: device path of the loaded image
1778 * @file_path: file path of the loaded image
1779 * @handle_ptr: handle of the loaded image
1780 * @info_ptr: loaded image protocol
1781 * Return: status code
1783 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1784 struct efi_device_path *file_path,
1785 struct efi_loaded_image_obj **handle_ptr,
1786 struct efi_loaded_image **info_ptr)
1789 struct efi_loaded_image *info = NULL;
1790 struct efi_loaded_image_obj *obj = NULL;
1791 struct efi_device_path *dp;
1793 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1797 info = calloc(1, sizeof(*info));
1799 return EFI_OUT_OF_RESOURCES;
1800 obj = calloc(1, sizeof(*obj));
1803 return EFI_OUT_OF_RESOURCES;
1805 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1807 /* Add internal object to object list */
1808 efi_add_handle(&obj->header);
1810 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1811 info->file_path = file_path;
1812 info->system_table = &systab;
1815 info->device_handle = efi_dp_find_obj(device_path, NULL, NULL);
1817 dp = efi_dp_append(device_path, file_path);
1819 ret = EFI_OUT_OF_RESOURCES;
1825 ret = efi_add_protocol(&obj->header,
1826 &efi_guid_loaded_image_device_path, dp);
1827 if (ret != EFI_SUCCESS)
1831 * When asking for the loaded_image interface, just
1832 * return handle which points to loaded_image_info
1834 ret = efi_add_protocol(&obj->header,
1835 &efi_guid_loaded_image, info);
1836 if (ret != EFI_SUCCESS)
1844 printf("ERROR: Failure to install protocols for loaded image\n");
1845 efi_delete_handle(&obj->header);
1851 * efi_locate_device_path() - Get the device path and handle of an device
1852 * implementing a protocol
1853 * @protocol: GUID of the protocol
1854 * @device_path: device path
1855 * @device: handle of the device
1857 * This function implements the LocateDevicePath service.
1859 * See the Unified Extensible Firmware Interface (UEFI) specification for
1862 * Return: status code
1864 efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
1865 struct efi_device_path **device_path,
1866 efi_handle_t *device)
1868 struct efi_device_path *dp;
1870 struct efi_handler *handler;
1871 efi_handle_t *handles;
1873 size_t len_best = 0;
1874 efi_uintn_t no_handles;
1878 EFI_ENTRY("%pUs, %p, %p", protocol, device_path, device);
1880 if (!protocol || !device_path || !*device_path) {
1881 ret = EFI_INVALID_PARAMETER;
1885 /* Find end of device path */
1886 len = efi_dp_instance_size(*device_path);
1888 /* Get all handles implementing the protocol */
1889 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1890 &no_handles, &handles));
1891 if (ret != EFI_SUCCESS)
1894 for (i = 0; i < no_handles; ++i) {
1895 /* Find the device path protocol */
1896 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1898 if (ret != EFI_SUCCESS)
1900 dp = (struct efi_device_path *)handler->protocol_interface;
1901 len_dp = efi_dp_instance_size(dp);
1903 * This handle can only be a better fit
1904 * if its device path length is longer than the best fit and
1905 * if its device path length is shorter of equal the searched
1908 if (len_dp <= len_best || len_dp > len)
1910 /* Check if dp is a subpath of device_path */
1911 if (memcmp(*device_path, dp, len_dp))
1914 ret = EFI_INVALID_PARAMETER;
1917 *device = handles[i];
1921 remainder = (u8 *)*device_path + len_best;
1922 *device_path = (struct efi_device_path *)remainder;
1925 ret = EFI_NOT_FOUND;
1928 return EFI_EXIT(ret);
1932 * efi_load_image_from_file() - load an image from file system
1934 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1935 * callers obligation to update the memory type as needed.
1937 * @file_path: the path of the image to load
1938 * @buffer: buffer containing the loaded image
1939 * @size: size of the loaded image
1940 * Return: status code
1943 efi_status_t efi_load_image_from_file(struct efi_device_path *file_path,
1944 void **buffer, efi_uintn_t *size)
1946 struct efi_file_handle *f;
1952 f = efi_file_from_path(file_path);
1954 return EFI_NOT_FOUND;
1956 ret = efi_file_size(f, &bs);
1957 if (ret != EFI_SUCCESS)
1961 * When reading the file we do not yet know if it contains an
1962 * application, a boottime driver, or a runtime driver. So here we
1963 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1964 * update the reservation according to the image type.
1966 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1967 EFI_BOOT_SERVICES_DATA,
1968 efi_size_in_pages(bs), &addr);
1969 if (ret != EFI_SUCCESS) {
1970 ret = EFI_OUT_OF_RESOURCES;
1975 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1976 if (ret != EFI_SUCCESS)
1977 efi_free_pages(addr, efi_size_in_pages(bs));
1978 *buffer = (void *)(uintptr_t)addr;
1981 EFI_CALL(f->close(f));
1986 * efi_load_image_from_path() - load an image using a file path
1988 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1989 * callers obligation to update the memory type as needed.
1991 * @boot_policy: true for request originating from the boot manager
1992 * @file_path: the path of the image to load
1993 * @buffer: buffer containing the loaded image
1994 * @size: size of the loaded image
1995 * Return: status code
1998 efi_status_t efi_load_image_from_path(bool boot_policy,
1999 struct efi_device_path *file_path,
2000 void **buffer, efi_uintn_t *size)
2002 efi_handle_t device;
2004 struct efi_device_path *dp, *rem;
2005 struct efi_load_file_protocol *load_file_protocol = NULL;
2006 efi_uintn_t buffer_size;
2007 uint64_t addr, pages;
2008 const efi_guid_t *guid;
2009 struct efi_handler *handler;
2011 /* In case of failure nothing is returned */
2016 device = efi_dp_find_obj(dp, NULL, &rem);
2017 ret = efi_search_protocol(device, &efi_simple_file_system_protocol_guid,
2019 if (ret == EFI_SUCCESS)
2020 return efi_load_image_from_file(file_path, buffer, size);
2022 ret = efi_search_protocol(device, &efi_guid_load_file_protocol, NULL);
2023 if (ret == EFI_SUCCESS) {
2024 guid = &efi_guid_load_file_protocol;
2025 } else if (!boot_policy) {
2026 guid = &efi_guid_load_file2_protocol;
2027 ret = efi_search_protocol(device, guid, NULL);
2029 if (ret != EFI_SUCCESS)
2030 return EFI_NOT_FOUND;
2031 ret = efi_search_protocol(device, guid, &handler);
2032 if (ret != EFI_SUCCESS)
2033 return EFI_NOT_FOUND;
2035 load_file_protocol = handler->protocol_interface;
2036 ret = EFI_CALL(load_file_protocol->load_file(
2037 load_file_protocol, rem, boot_policy,
2038 &buffer_size, NULL));
2039 if (ret != EFI_BUFFER_TOO_SMALL)
2041 pages = efi_size_in_pages(buffer_size);
2042 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, EFI_BOOT_SERVICES_DATA,
2044 if (ret != EFI_SUCCESS) {
2045 ret = EFI_OUT_OF_RESOURCES;
2048 ret = EFI_CALL(load_file_protocol->load_file(
2049 load_file_protocol, rem, boot_policy,
2050 &buffer_size, (void *)(uintptr_t)addr));
2051 if (ret != EFI_SUCCESS)
2052 efi_free_pages(addr, pages);
2054 efi_close_protocol(device, guid, efi_root, NULL);
2055 if (ret == EFI_SUCCESS) {
2056 *buffer = (void *)(uintptr_t)addr;
2057 *size = buffer_size;
2064 * efi_load_image() - load an EFI image into memory
2065 * @boot_policy: true for request originating from the boot manager
2066 * @parent_image: the caller's image handle
2067 * @file_path: the path of the image to load
2068 * @source_buffer: memory location from which the image is installed
2069 * @source_size: size of the memory area from which the image is installed
2070 * @image_handle: handle for the newly installed image
2072 * This function implements the LoadImage service.
2074 * See the Unified Extensible Firmware Interface (UEFI) specification
2077 * Return: status code
2079 efi_status_t EFIAPI efi_load_image(bool boot_policy,
2080 efi_handle_t parent_image,
2081 struct efi_device_path *file_path,
2082 void *source_buffer,
2083 efi_uintn_t source_size,
2084 efi_handle_t *image_handle)
2086 struct efi_device_path *dp, *fp;
2087 struct efi_loaded_image *info = NULL;
2088 struct efi_loaded_image_obj **image_obj =
2089 (struct efi_loaded_image_obj **)image_handle;
2093 EFI_ENTRY("%d, %p, %pD, %p, %zu, %p", boot_policy, parent_image,
2094 file_path, source_buffer, source_size, image_handle);
2096 if (!image_handle || (!source_buffer && !file_path) ||
2097 !efi_search_obj(parent_image) ||
2098 /* The parent image handle must refer to a loaded image */
2099 !parent_image->type) {
2100 ret = EFI_INVALID_PARAMETER;
2104 if (!source_buffer) {
2105 ret = efi_load_image_from_path(boot_policy, file_path,
2106 &dest_buffer, &source_size);
2107 if (ret != EFI_SUCCESS)
2110 dest_buffer = source_buffer;
2112 /* split file_path which contains both the device and file parts */
2113 efi_dp_split_file_path(file_path, &dp, &fp);
2114 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
2115 if (ret == EFI_SUCCESS)
2116 ret = efi_load_pe(*image_obj, dest_buffer, source_size, info);
2118 /* Release buffer to which file was loaded */
2119 efi_free_pages((uintptr_t)dest_buffer,
2120 efi_size_in_pages(source_size));
2121 if (ret == EFI_SUCCESS || ret == EFI_SECURITY_VIOLATION) {
2122 info->system_table = &systab;
2123 info->parent_handle = parent_image;
2125 /* The image is invalid. Release all associated resources. */
2126 efi_delete_handle(*image_handle);
2127 *image_handle = NULL;
2131 return EFI_EXIT(ret);
2135 * efi_exit_caches() - fix up caches for EFI payloads if necessary
2137 static void efi_exit_caches(void)
2139 #if defined(CONFIG_EFI_GRUB_ARM32_WORKAROUND)
2141 * Boooting Linux via GRUB prior to version 2.04 fails on 32bit ARM if
2142 * caches are enabled.
2145 * According to the UEFI spec caches that can be managed via CP15
2146 * operations should be enabled. Caches requiring platform information
2147 * to manage should be disabled. This should not happen in
2148 * ExitBootServices() but before invoking any UEFI binary is invoked.
2150 * We want to keep the current workaround while GRUB prior to version
2151 * 2.04 is still in use.
2153 cleanup_before_linux();
2158 * efi_exit_boot_services() - stop all boot services
2159 * @image_handle: handle of the loaded image
2160 * @map_key: key of the memory map
2162 * This function implements the ExitBootServices service.
2164 * See the Unified Extensible Firmware Interface (UEFI) specification
2167 * All timer events are disabled. For exit boot services events the
2168 * notification function is called. The boot services are disabled in the
2171 * Return: status code
2173 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
2174 efi_uintn_t map_key)
2176 struct efi_event *evt, *next_event;
2177 efi_status_t ret = EFI_SUCCESS;
2179 EFI_ENTRY("%p, %zx", image_handle, map_key);
2181 /* Check that the caller has read the current memory map */
2182 if (map_key != efi_memory_map_key) {
2183 ret = EFI_INVALID_PARAMETER;
2187 /* Check if ExitBootServices has already been called */
2188 if (!systab.boottime)
2191 /* Notify EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES event group. */
2192 list_for_each_entry(evt, &efi_events, link) {
2194 !guidcmp(evt->group,
2195 &efi_guid_event_group_before_exit_boot_services)) {
2196 efi_signal_event(evt);
2201 /* Stop all timer related activities */
2202 timers_enabled = false;
2204 /* Add related events to the event group */
2205 list_for_each_entry(evt, &efi_events, link) {
2206 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
2207 evt->group = &efi_guid_event_group_exit_boot_services;
2209 /* Notify that ExitBootServices is invoked. */
2210 list_for_each_entry(evt, &efi_events, link) {
2212 !guidcmp(evt->group,
2213 &efi_guid_event_group_exit_boot_services)) {
2214 efi_signal_event(evt);
2219 /* Make sure that notification functions are not called anymore */
2220 efi_tpl = TPL_HIGH_LEVEL;
2222 /* Notify variable services */
2223 efi_variables_boot_exit_notify();
2225 /* Remove all events except EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
2226 list_for_each_entry_safe(evt, next_event, &efi_events, link) {
2227 if (evt->type != EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE)
2228 list_del(&evt->link);
2231 if (!efi_st_keep_devices) {
2232 bootm_disable_interrupts();
2233 if (IS_ENABLED(CONFIG_USB_DEVICE))
2235 board_quiesce_devices();
2236 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
2239 /* Patch out unsupported runtime function */
2240 efi_runtime_detach();
2242 /* Fix up caches for EFI payloads if necessary */
2245 /* Disable boot time services */
2246 systab.con_in_handle = NULL;
2247 systab.con_in = NULL;
2248 systab.con_out_handle = NULL;
2249 systab.con_out = NULL;
2250 systab.stderr_handle = NULL;
2251 systab.std_err = NULL;
2252 systab.boottime = NULL;
2254 /* Recalculate CRC32 */
2255 efi_update_table_header_crc32(&systab.hdr);
2257 /* Give the payload some time to boot */
2258 efi_set_watchdog(0);
2261 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
2262 if (ret != EFI_SUCCESS)
2263 efi_tcg2_notify_exit_boot_services_failed();
2266 return EFI_EXIT(ret);
2270 * efi_get_next_monotonic_count() - get next value of the counter
2271 * @count: returned value of the counter
2273 * This function implements the NextMonotonicCount service.
2275 * See the Unified Extensible Firmware Interface (UEFI) specification for
2278 * Return: status code
2280 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2282 static uint64_t mono;
2285 EFI_ENTRY("%p", count);
2287 ret = EFI_INVALID_PARAMETER;
2293 return EFI_EXIT(ret);
2297 * efi_stall() - sleep
2298 * @microseconds: period to sleep in microseconds
2300 * This function implements the Stall service.
2302 * See the Unified Extensible Firmware Interface (UEFI) specification for
2305 * Return: status code
2307 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2311 EFI_ENTRY("%ld", microseconds);
2313 end_tick = get_ticks() + usec_to_tick(microseconds);
2314 while (get_ticks() < end_tick)
2317 return EFI_EXIT(EFI_SUCCESS);
2321 * efi_set_watchdog_timer() - reset the watchdog timer
2322 * @timeout: seconds before reset by watchdog
2323 * @watchdog_code: code to be logged when resetting
2324 * @data_size: size of buffer in bytes
2325 * @watchdog_data: buffer with data describing the reset reason
2327 * This function implements the SetWatchdogTimer service.
2329 * See the Unified Extensible Firmware Interface (UEFI) specification for
2332 * Return: status code
2334 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2335 uint64_t watchdog_code,
2336 unsigned long data_size,
2337 uint16_t *watchdog_data)
2339 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
2340 data_size, watchdog_data);
2341 return EFI_EXIT(efi_set_watchdog(timeout));
2345 * efi_close_protocol() - close a protocol
2346 * @handle: handle on which the protocol shall be closed
2347 * @protocol: GUID of the protocol to close
2348 * @agent_handle: handle of the driver
2349 * @controller_handle: handle of the controller
2351 * This is the function implementing the CloseProtocol service is for internal
2352 * usage in U-Boot. For API usage wrapper efi_close_protocol_ext() is provided.
2354 * See the Unified Extensible Firmware Interface (UEFI) specification for
2357 * Return: status code
2359 efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
2360 efi_handle_t agent_handle,
2361 efi_handle_t controller_handle)
2363 struct efi_handler *handler;
2364 struct efi_open_protocol_info_item *item;
2365 struct efi_open_protocol_info_item *pos;
2368 if (!efi_search_obj(agent_handle) ||
2369 (controller_handle && !efi_search_obj(controller_handle)))
2370 return EFI_INVALID_PARAMETER;
2371 ret = efi_search_protocol(handle, protocol, &handler);
2372 if (ret != EFI_SUCCESS)
2375 ret = EFI_NOT_FOUND;
2376 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2377 if (item->info.agent_handle == agent_handle &&
2378 item->info.controller_handle == controller_handle) {
2379 efi_delete_open_info(item);
2388 * efi_close_protocol_ext() - close a protocol
2389 * @handle: handle on which the protocol shall be closed
2390 * @protocol: GUID of the protocol to close
2391 * @agent_handle: handle of the driver
2392 * @controller_handle: handle of the controller
2394 * This function implements the CloseProtocol service.
2396 * See the Unified Extensible Firmware Interface (UEFI) specification for
2399 * Return: status code
2401 static efi_status_t EFIAPI
2402 efi_close_protocol_ext(efi_handle_t handle, const efi_guid_t *protocol,
2403 efi_handle_t agent_handle,
2404 efi_handle_t controller_handle)
2408 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, agent_handle,
2411 ret = efi_close_protocol(handle, protocol,
2412 agent_handle, controller_handle);
2414 return EFI_EXIT(ret);
2418 * efi_open_protocol_information() - provide information about then open status
2419 * of a protocol on a handle
2420 * @handle: handle for which the information shall be retrieved
2421 * @protocol: GUID of the protocol
2422 * @entry_buffer: buffer to receive the open protocol information
2423 * @entry_count: number of entries available in the buffer
2425 * This function implements the OpenProtocolInformation service.
2427 * See the Unified Extensible Firmware Interface (UEFI) specification for
2430 * Return: status code
2432 static efi_status_t EFIAPI efi_open_protocol_information(
2433 efi_handle_t handle, const efi_guid_t *protocol,
2434 struct efi_open_protocol_info_entry **entry_buffer,
2435 efi_uintn_t *entry_count)
2437 unsigned long buffer_size;
2438 unsigned long count;
2439 struct efi_handler *handler;
2440 struct efi_open_protocol_info_item *item;
2443 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, entry_buffer,
2446 /* Check parameters */
2447 if (!entry_buffer) {
2448 r = EFI_INVALID_PARAMETER;
2451 r = efi_search_protocol(handle, protocol, &handler);
2452 if (r != EFI_SUCCESS)
2457 list_for_each_entry(item, &handler->open_infos, link) {
2458 if (item->info.open_count)
2461 *entry_count = count;
2462 *entry_buffer = NULL;
2469 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2470 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2471 (void **)entry_buffer);
2472 if (r != EFI_SUCCESS)
2474 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2475 if (item->info.open_count)
2476 (*entry_buffer)[--count] = item->info;
2483 * efi_protocols_per_handle() - get protocols installed on a handle
2484 * @handle: handle for which the information is retrieved
2485 * @protocol_buffer: buffer with protocol GUIDs
2486 * @protocol_buffer_count: number of entries in the buffer
2488 * This function implements the ProtocolsPerHandleService.
2490 * See the Unified Extensible Firmware Interface (UEFI) specification for
2493 * Return: status code
2495 static efi_status_t EFIAPI efi_protocols_per_handle(
2496 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2497 efi_uintn_t *protocol_buffer_count)
2499 unsigned long buffer_size;
2500 struct efi_object *efiobj;
2501 struct list_head *protocol_handle;
2504 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2505 protocol_buffer_count);
2507 if (!handle || !protocol_buffer || !protocol_buffer_count)
2508 return EFI_EXIT(EFI_INVALID_PARAMETER);
2510 *protocol_buffer = NULL;
2511 *protocol_buffer_count = 0;
2513 efiobj = efi_search_obj(handle);
2515 return EFI_EXIT(EFI_INVALID_PARAMETER);
2517 /* Count protocols */
2518 list_for_each(protocol_handle, &efiobj->protocols) {
2519 ++*protocol_buffer_count;
2523 if (*protocol_buffer_count) {
2526 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2527 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2528 (void **)protocol_buffer);
2529 if (r != EFI_SUCCESS)
2531 list_for_each(protocol_handle, &efiobj->protocols) {
2532 struct efi_handler *protocol;
2534 protocol = list_entry(protocol_handle,
2535 struct efi_handler, link);
2536 (*protocol_buffer)[j] = (void *)&protocol->guid;
2541 return EFI_EXIT(EFI_SUCCESS);
2544 efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
2545 const efi_guid_t *protocol, void *search_key,
2546 efi_uintn_t *no_handles, efi_handle_t **buffer)
2549 efi_uintn_t buffer_size = 0;
2551 if (!no_handles || !buffer) {
2552 r = EFI_INVALID_PARAMETER;
2557 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2559 if (r != EFI_BUFFER_TOO_SMALL)
2561 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2563 if (r != EFI_SUCCESS)
2565 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2567 if (r == EFI_SUCCESS)
2568 *no_handles = buffer_size / sizeof(efi_handle_t);
2574 * efi_locate_handle_buffer() - locate handles implementing a protocol
2575 * @search_type: selection criterion
2576 * @protocol: GUID of the protocol
2577 * @search_key: registration key
2578 * @no_handles: number of returned handles
2579 * @buffer: buffer with the returned handles
2581 * This function implements the LocateHandleBuffer service.
2583 * See the Unified Extensible Firmware Interface (UEFI) specification for
2586 * Return: status code
2588 efi_status_t EFIAPI efi_locate_handle_buffer(
2589 enum efi_locate_search_type search_type,
2590 const efi_guid_t *protocol, void *search_key,
2591 efi_uintn_t *no_handles, efi_handle_t **buffer)
2595 EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key,
2596 no_handles, buffer);
2598 r = efi_locate_handle_buffer_int(search_type, protocol, search_key,
2599 no_handles, buffer);
2605 * efi_locate_protocol() - find an interface implementing a protocol
2606 * @protocol: GUID of the protocol
2607 * @registration: registration key passed to the notification function
2608 * @protocol_interface: interface implementing the protocol
2610 * This function implements the LocateProtocol service.
2612 * See the Unified Extensible Firmware Interface (UEFI) specification for
2615 * Return: status code
2617 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2619 void **protocol_interface)
2621 struct efi_handler *handler;
2623 struct efi_object *efiobj;
2625 EFI_ENTRY("%pUs, %p, %p", protocol, registration, protocol_interface);
2628 * The UEFI spec explicitly requires a protocol even if a registration
2629 * key is provided. This differs from the logic in LocateHandle().
2631 if (!protocol || !protocol_interface)
2632 return EFI_EXIT(EFI_INVALID_PARAMETER);
2635 struct efi_register_notify_event *event;
2636 struct efi_protocol_notification *handle;
2638 event = efi_check_register_notify_event(registration);
2640 return EFI_EXIT(EFI_INVALID_PARAMETER);
2642 * The UEFI spec requires to return EFI_NOT_FOUND if no
2643 * protocol instance matches protocol and registration.
2644 * So let's do the same for a mismatch between protocol and
2647 if (guidcmp(&event->protocol, protocol))
2649 if (list_empty(&event->handles))
2651 handle = list_first_entry(&event->handles,
2652 struct efi_protocol_notification,
2654 efiobj = handle->handle;
2655 list_del(&handle->link);
2657 ret = efi_search_protocol(efiobj, protocol, &handler);
2658 if (ret == EFI_SUCCESS)
2661 list_for_each_entry(efiobj, &efi_obj_list, link) {
2662 ret = efi_search_protocol(efiobj, protocol, &handler);
2663 if (ret == EFI_SUCCESS)
2668 *protocol_interface = NULL;
2669 return EFI_EXIT(EFI_NOT_FOUND);
2671 *protocol_interface = handler->protocol_interface;
2672 return EFI_EXIT(EFI_SUCCESS);
2676 * efi_install_multiple_protocol_interfaces_int() - Install multiple protocol
2678 * @handle: handle on which the protocol interfaces shall be installed
2679 * @argptr: va_list of args
2681 * Core functionality of efi_install_multiple_protocol_interfaces
2682 * Must not be called directly
2684 * Return: status code
2686 static efi_status_t EFIAPI
2687 efi_install_multiple_protocol_interfaces_int(efi_handle_t *handle,
2690 const efi_guid_t *protocol;
2691 void *protocol_interface;
2692 efi_handle_t old_handle;
2693 efi_status_t ret = EFI_SUCCESS;
2695 efi_va_list argptr_copy;
2698 return EFI_INVALID_PARAMETER;
2700 efi_va_copy(argptr_copy, argptr);
2702 protocol = efi_va_arg(argptr, efi_guid_t*);
2705 protocol_interface = efi_va_arg(argptr, void*);
2706 /* Check that a device path has not been installed before */
2707 if (!guidcmp(protocol, &efi_guid_device_path)) {
2708 struct efi_device_path *dp = protocol_interface;
2710 ret = EFI_CALL(efi_locate_device_path(protocol, &dp,
2712 if (ret == EFI_SUCCESS &&
2713 dp->type == DEVICE_PATH_TYPE_END) {
2714 EFI_PRINT("Path %pD already installed\n",
2715 protocol_interface);
2716 ret = EFI_ALREADY_STARTED;
2720 ret = EFI_CALL(efi_install_protocol_interface(handle, protocol,
2721 EFI_NATIVE_INTERFACE,
2722 protocol_interface));
2723 if (ret != EFI_SUCCESS)
2727 if (ret == EFI_SUCCESS)
2730 /* If an error occurred undo all changes. */
2732 protocol = efi_va_arg(argptr_copy, efi_guid_t*);
2733 protocol_interface = efi_va_arg(argptr_copy, void*);
2734 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2735 protocol_interface));
2739 efi_va_end(argptr_copy);
2745 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2747 * @handle: handle on which the protocol interfaces shall be installed
2748 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2752 * This is the function for internal usage in U-Boot. For the API function
2753 * implementing the InstallMultipleProtocol service see
2754 * efi_install_multiple_protocol_interfaces_ext()
2756 * Return: status code
2759 efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...)
2764 efi_va_start(argptr, handle);
2765 ret = efi_install_multiple_protocol_interfaces_int(handle, argptr);
2771 * efi_install_multiple_protocol_interfaces_ext() - Install multiple protocol
2773 * @handle: handle on which the protocol interfaces shall be installed
2774 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2777 * This function implements the MultipleProtocolInterfaces service.
2779 * See the Unified Extensible Firmware Interface (UEFI) specification for
2782 * Return: status code
2784 static efi_status_t EFIAPI
2785 efi_install_multiple_protocol_interfaces_ext(efi_handle_t *handle, ...)
2787 EFI_ENTRY("%p", handle);
2791 efi_va_start(argptr, handle);
2792 ret = efi_install_multiple_protocol_interfaces_int(handle, argptr);
2794 return EFI_EXIT(ret);
2798 * efi_uninstall_multiple_protocol_interfaces_int() - wrapper for uninstall
2801 * @handle: handle from which the protocol interfaces shall be removed
2802 * @argptr: va_list of args
2804 * Core functionality of efi_uninstall_multiple_protocol_interfaces
2805 * Must not be called directly
2807 * Return: status code
2809 static efi_status_t EFIAPI
2810 efi_uninstall_multiple_protocol_interfaces_int(efi_handle_t handle,
2813 const efi_guid_t *protocol, *next_protocol;
2814 void *protocol_interface;
2815 efi_status_t ret = EFI_SUCCESS;
2817 efi_va_list argptr_copy;
2820 return EFI_INVALID_PARAMETER;
2822 efi_va_copy(argptr_copy, argptr);
2823 protocol = efi_va_arg(argptr, efi_guid_t*);
2826 * If efi_uninstall_protocol() fails we need to be able to
2827 * reinstall the previously uninstalled protocols on the same
2829 * Instead of calling efi_uninstall_protocol(...,..., false)
2830 * and potentially removing the handle, only allow the handle
2831 * removal on the last protocol that we requested to uninstall.
2832 * That way we can preserve the handle in case the latter fails
2834 bool preserve = true;
2838 protocol_interface = efi_va_arg(argptr, void*);
2839 next_protocol = efi_va_arg(argptr, efi_guid_t*);
2842 ret = efi_uninstall_protocol(handle, protocol,
2843 protocol_interface, preserve);
2844 if (ret != EFI_SUCCESS)
2847 protocol = next_protocol;
2849 if (ret == EFI_SUCCESS)
2852 /* If an error occurred undo all changes. */
2854 protocol = efi_va_arg(argptr_copy, efi_guid_t*);
2855 protocol_interface = efi_va_arg(argptr_copy, void*);
2856 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2857 EFI_NATIVE_INTERFACE,
2858 protocol_interface));
2861 * If any errors are generated while the protocol interfaces are being
2862 * uninstalled, then the protocols uninstalled prior to the error will
2863 * be reinstalled using InstallProtocolInterface() and the status code
2864 * EFI_INVALID_PARAMETER is returned.
2866 ret = EFI_INVALID_PARAMETER;
2869 efi_va_end(argptr_copy);
2874 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2876 * @handle: handle from which the protocol interfaces shall be removed
2877 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2880 * This function implements the UninstallMultipleProtocolInterfaces service.
2882 * This is the function for internal usage in U-Boot. For the API function
2883 * implementing the UninstallMultipleProtocolInterfaces service see
2884 * efi_uninstall_multiple_protocol_interfaces_ext()
2886 * Return: status code
2889 efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...)
2894 efi_va_start(argptr, handle);
2895 ret = efi_uninstall_multiple_protocol_interfaces_int(handle, argptr);
2901 * efi_uninstall_multiple_protocol_interfaces_ext() - uninstall multiple protocol
2903 * @handle: handle from which the protocol interfaces shall be removed
2904 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2907 * This function implements the UninstallMultipleProtocolInterfaces service.
2909 * See the Unified Extensible Firmware Interface (UEFI) specification for
2912 * Return: status code
2914 static efi_status_t EFIAPI
2915 efi_uninstall_multiple_protocol_interfaces_ext(efi_handle_t handle, ...)
2917 EFI_ENTRY("%p", handle);
2921 efi_va_start(argptr, handle);
2922 ret = efi_uninstall_multiple_protocol_interfaces_int(handle, argptr);
2924 return EFI_EXIT(ret);
2928 * efi_calculate_crc32() - calculate cyclic redundancy code
2929 * @data: buffer with data
2930 * @data_size: size of buffer in bytes
2931 * @crc32_p: cyclic redundancy code
2933 * This function implements the CalculateCrc32 service.
2935 * See the Unified Extensible Firmware Interface (UEFI) specification for
2938 * Return: status code
2940 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2941 efi_uintn_t data_size,
2944 efi_status_t ret = EFI_SUCCESS;
2946 EFI_ENTRY("%p, %zu", data, data_size);
2947 if (!data || !data_size || !crc32_p) {
2948 ret = EFI_INVALID_PARAMETER;
2951 *crc32_p = crc32(0, data, data_size);
2953 return EFI_EXIT(ret);
2957 * efi_copy_mem() - copy memory
2958 * @destination: destination of the copy operation
2959 * @source: source of the copy operation
2960 * @length: number of bytes to copy
2962 * This function implements the CopyMem service.
2964 * See the Unified Extensible Firmware Interface (UEFI) specification for
2967 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2970 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2971 memmove(destination, source, length);
2972 EFI_EXIT(EFI_SUCCESS);
2976 * efi_set_mem() - Fill memory with a byte value.
2977 * @buffer: buffer to fill
2978 * @size: size of buffer in bytes
2979 * @value: byte to copy to the buffer
2981 * This function implements the SetMem service.
2983 * See the Unified Extensible Firmware Interface (UEFI) specification for
2986 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2988 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2989 memset(buffer, value, size);
2990 EFI_EXIT(EFI_SUCCESS);
2994 * efi_protocol_open() - open protocol interface on a handle
2995 * @handler: handler of a protocol
2996 * @protocol_interface: interface implementing the protocol
2997 * @agent_handle: handle of the driver
2998 * @controller_handle: handle of the controller
2999 * @attributes: attributes indicating how to open the protocol
3001 * Return: status code
3003 efi_status_t efi_protocol_open(
3004 struct efi_handler *handler,
3005 void **protocol_interface, void *agent_handle,
3006 void *controller_handle, uint32_t attributes)
3008 struct efi_open_protocol_info_item *item;
3009 struct efi_open_protocol_info_entry *match = NULL;
3010 bool opened_by_driver = false;
3011 bool opened_exclusive = false;
3013 /* If there is no agent, only return the interface */
3017 /* For TEST_PROTOCOL ignore interface attribute */
3018 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
3019 *protocol_interface = NULL;
3022 * Check if the protocol is already opened by a driver with the same
3023 * attributes or opened exclusively
3025 list_for_each_entry(item, &handler->open_infos, link) {
3026 if (item->info.agent_handle == agent_handle) {
3027 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
3028 (item->info.attributes == attributes))
3029 return EFI_ALREADY_STARTED;
3031 if (item->info.attributes &
3032 EFI_OPEN_PROTOCOL_BY_DRIVER)
3033 opened_by_driver = true;
3035 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
3036 opened_exclusive = true;
3039 /* Only one controller can open the protocol exclusively */
3040 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
3041 if (opened_exclusive)
3042 return EFI_ACCESS_DENIED;
3043 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
3044 if (opened_exclusive || opened_by_driver)
3045 return EFI_ACCESS_DENIED;
3048 /* Prepare exclusive opening */
3049 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
3050 /* Try to disconnect controllers */
3052 opened_by_driver = false;
3053 list_for_each_entry(item, &handler->open_infos, link) {
3056 if (item->info.attributes ==
3057 EFI_OPEN_PROTOCOL_BY_DRIVER) {
3058 ret = EFI_CALL(efi_disconnect_controller(
3059 item->info.controller_handle,
3060 item->info.agent_handle,
3062 if (ret == EFI_SUCCESS)
3064 * Child controllers may have been
3065 * removed from the open_infos list. So
3066 * let's restart the loop.
3068 goto disconnect_next;
3070 opened_by_driver = true;
3073 /* Only one driver can be connected */
3074 if (opened_by_driver)
3075 return EFI_ACCESS_DENIED;
3078 /* Find existing entry */
3079 list_for_each_entry(item, &handler->open_infos, link) {
3080 if (item->info.agent_handle == agent_handle &&
3081 item->info.controller_handle == controller_handle &&
3082 item->info.attributes == attributes)
3083 match = &item->info;
3085 /* None found, create one */
3087 match = efi_create_open_info(handler);
3089 return EFI_OUT_OF_RESOURCES;
3092 match->agent_handle = agent_handle;
3093 match->controller_handle = controller_handle;
3094 match->attributes = attributes;
3095 match->open_count++;
3098 /* For TEST_PROTOCOL ignore interface attribute. */
3099 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
3100 *protocol_interface = handler->protocol_interface;
3106 * efi_open_protocol() - open protocol interface on a handle
3107 * @handle: handle on which the protocol shall be opened
3108 * @protocol: GUID of the protocol
3109 * @protocol_interface: interface implementing the protocol
3110 * @agent_handle: handle of the driver
3111 * @controller_handle: handle of the controller
3112 * @attributes: attributes indicating how to open the protocol
3114 * This function implements the OpenProtocol interface.
3116 * See the Unified Extensible Firmware Interface (UEFI) specification for
3119 * Return: status code
3121 static efi_status_t EFIAPI efi_open_protocol
3122 (efi_handle_t handle, const efi_guid_t *protocol,
3123 void **protocol_interface, efi_handle_t agent_handle,
3124 efi_handle_t controller_handle, uint32_t attributes)
3126 struct efi_handler *handler;
3127 efi_status_t r = EFI_INVALID_PARAMETER;
3129 EFI_ENTRY("%p, %pUs, %p, %p, %p, 0x%x", handle, protocol,
3130 protocol_interface, agent_handle, controller_handle,
3133 if (!handle || !protocol ||
3134 (!protocol_interface && attributes !=
3135 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
3139 switch (attributes) {
3140 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
3141 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
3142 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
3144 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
3145 if (controller_handle == handle)
3148 case EFI_OPEN_PROTOCOL_BY_DRIVER:
3149 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
3150 /* Check that the controller handle is valid */
3151 if (!efi_search_obj(controller_handle))
3154 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
3155 /* Check that the agent handle is valid */
3156 if (!efi_search_obj(agent_handle))
3163 r = efi_search_protocol(handle, protocol, &handler);
3168 r = EFI_UNSUPPORTED;
3174 r = efi_protocol_open(handler, protocol_interface, agent_handle,
3175 controller_handle, attributes);
3181 * efi_start_image() - call the entry point of an image
3182 * @image_handle: handle of the image
3183 * @exit_data_size: size of the buffer
3184 * @exit_data: buffer to receive the exit data of the called image
3186 * This function implements the StartImage service.
3188 * See the Unified Extensible Firmware Interface (UEFI) specification for
3191 * Return: status code
3193 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
3194 efi_uintn_t *exit_data_size,
3197 struct efi_loaded_image_obj *image_obj =
3198 (struct efi_loaded_image_obj *)image_handle;
3201 efi_handle_t parent_image = current_image;
3202 efi_status_t exit_status;
3203 struct jmp_buf_data exit_jmp;
3205 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
3207 if (!efi_search_obj(image_handle))
3208 return EFI_EXIT(EFI_INVALID_PARAMETER);
3210 /* Check parameters */
3211 if (image_obj->header.type != EFI_OBJECT_TYPE_LOADED_IMAGE)
3212 return EFI_EXIT(EFI_INVALID_PARAMETER);
3214 if (image_obj->auth_status != EFI_IMAGE_AUTH_PASSED)
3215 return EFI_EXIT(EFI_SECURITY_VIOLATION);
3217 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3219 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3220 if (ret != EFI_SUCCESS)
3221 return EFI_EXIT(EFI_INVALID_PARAMETER);
3223 image_obj->exit_data_size = exit_data_size;
3224 image_obj->exit_data = exit_data;
3225 image_obj->exit_status = &exit_status;
3226 image_obj->exit_jmp = &exit_jmp;
3228 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3229 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3230 ret = efi_tcg2_measure_efi_app_invocation(image_obj);
3231 if (ret == EFI_SECURITY_VIOLATION) {
3233 * TCG2 Protocol is installed but no TPM device found,
3234 * this is not expected.
3236 return EFI_EXIT(EFI_SECURITY_VIOLATION);
3241 /* call the image! */
3242 if (setjmp(&exit_jmp)) {
3244 * We called the entry point of the child image with EFI_CALL
3245 * in the lines below. The child image called the Exit() boot
3246 * service efi_exit() which executed the long jump that brought
3247 * us to the current line. This implies that the second half
3248 * of the EFI_CALL macro has not been executed.
3250 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
3252 * efi_exit() called efi_restore_gd(). We have to undo this
3253 * otherwise __efi_entry_check() will put the wrong value into
3259 * To get ready to call EFI_EXIT below we have to execute the
3260 * missed out steps of EFI_CALL.
3262 assert(__efi_entry_check());
3263 EFI_PRINT("%lu returned by started image\n",
3264 (unsigned long)((uintptr_t)exit_status &
3266 current_image = parent_image;
3267 return EFI_EXIT(exit_status);
3270 current_image = image_handle;
3271 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
3272 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
3273 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
3276 * Control is returned from a started UEFI image either by calling
3277 * Exit() (where exit data can be provided) or by simply returning from
3278 * the entry point. In the latter case call Exit() on behalf of the
3281 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
3285 * efi_delete_image() - delete loaded image from memory)
3287 * @image_obj: handle of the loaded image
3288 * @loaded_image_protocol: loaded image protocol
3290 static efi_status_t efi_delete_image
3291 (struct efi_loaded_image_obj *image_obj,
3292 struct efi_loaded_image *loaded_image_protocol)
3294 struct efi_object *efiobj;
3295 efi_status_t r, ret = EFI_SUCCESS;
3298 list_for_each_entry(efiobj, &efi_obj_list, link) {
3299 struct efi_handler *protocol;
3301 list_for_each_entry(protocol, &efiobj->protocols, link) {
3302 struct efi_open_protocol_info_item *info;
3304 list_for_each_entry(info, &protocol->open_infos, link) {
3305 if (info->info.agent_handle !=
3306 (efi_handle_t)image_obj)
3308 r = efi_close_protocol(
3309 efiobj, &protocol->guid,
3310 info->info.agent_handle,
3311 info->info.controller_handle);
3312 if (r != EFI_SUCCESS)
3315 * Closing protocols may results in further
3316 * items being deleted. To play it safe loop
3317 * over all elements again.
3324 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
3325 efi_size_in_pages(loaded_image_protocol->image_size));
3326 efi_delete_handle(&image_obj->header);
3332 * efi_unload_image() - unload an EFI image
3333 * @image_handle: handle of the image to be unloaded
3335 * This function implements the UnloadImage service.
3337 * See the Unified Extensible Firmware Interface (UEFI) specification for
3340 * Return: status code
3342 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
3344 efi_status_t ret = EFI_SUCCESS;
3345 struct efi_object *efiobj;
3346 struct efi_loaded_image *loaded_image_protocol;
3348 EFI_ENTRY("%p", image_handle);
3350 efiobj = efi_search_obj(image_handle);
3352 ret = EFI_INVALID_PARAMETER;
3355 /* Find the loaded image protocol */
3356 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3357 (void **)&loaded_image_protocol,
3359 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3360 if (ret != EFI_SUCCESS) {
3361 ret = EFI_INVALID_PARAMETER;
3364 switch (efiobj->type) {
3365 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3366 /* Call the unload function */
3367 if (!loaded_image_protocol->unload) {
3368 ret = EFI_UNSUPPORTED;
3371 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
3372 if (ret != EFI_SUCCESS)
3375 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3378 ret = EFI_INVALID_PARAMETER;
3381 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
3382 loaded_image_protocol);
3384 return EFI_EXIT(ret);
3388 * efi_update_exit_data() - fill exit data parameters of StartImage()
3390 * @image_obj: image handle
3391 * @exit_data_size: size of the exit data buffer
3392 * @exit_data: buffer with data returned by UEFI payload
3393 * Return: status code
3395 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
3396 efi_uintn_t exit_data_size,
3402 * If exit_data is not provided to StartImage(), exit_data_size must be
3405 if (!image_obj->exit_data)
3407 if (image_obj->exit_data_size)
3408 *image_obj->exit_data_size = exit_data_size;
3409 if (exit_data_size && exit_data) {
3410 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3412 (void **)image_obj->exit_data);
3413 if (ret != EFI_SUCCESS)
3415 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3417 image_obj->exit_data = NULL;
3423 * efi_exit() - leave an EFI application or driver
3424 * @image_handle: handle of the application or driver that is exiting
3425 * @exit_status: status code
3426 * @exit_data_size: size of the buffer in bytes
3427 * @exit_data: buffer with data describing an error
3429 * This function implements the Exit service.
3431 * See the Unified Extensible Firmware Interface (UEFI) specification for
3434 * Return: status code
3436 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3437 efi_status_t exit_status,
3438 efi_uintn_t exit_data_size,
3442 * TODO: We should call the unload procedure of the loaded
3446 struct efi_loaded_image *loaded_image_protocol;
3447 struct efi_loaded_image_obj *image_obj =
3448 (struct efi_loaded_image_obj *)image_handle;
3449 struct jmp_buf_data *exit_jmp;
3451 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3452 exit_data_size, exit_data);
3454 /* Check parameters */
3455 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3456 (void **)&loaded_image_protocol,
3458 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3459 if (ret != EFI_SUCCESS) {
3460 ret = EFI_INVALID_PARAMETER;
3464 /* Unloading of unstarted images */
3465 switch (image_obj->header.type) {
3466 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3468 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3469 efi_delete_image(image_obj, loaded_image_protocol);
3473 /* Handle does not refer to loaded image */
3474 ret = EFI_INVALID_PARAMETER;
3477 /* A started image can only be unloaded it is the last one started. */
3478 if (image_handle != current_image) {
3479 ret = EFI_INVALID_PARAMETER;
3483 /* Exit data is only foreseen in case of failure. */
3484 if (exit_status != EFI_SUCCESS) {
3485 ret = efi_update_exit_data(image_obj, exit_data_size,
3487 /* Exiting has priority. Don't return error to caller. */
3488 if (ret != EFI_SUCCESS)
3489 EFI_PRINT("%s: out of memory\n", __func__);
3491 /* efi_delete_image() frees image_obj. Copy before the call. */
3492 exit_jmp = image_obj->exit_jmp;
3493 *image_obj->exit_status = exit_status;
3494 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3495 exit_status != EFI_SUCCESS)
3496 efi_delete_image(image_obj, loaded_image_protocol);
3498 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3499 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3500 ret = efi_tcg2_measure_efi_app_exit();
3501 if (ret != EFI_SUCCESS) {
3502 log_warning("tcg2 measurement fails(0x%lx)\n",
3508 /* Make sure entry/exit counts for EFI world cross-overs match */
3509 EFI_EXIT(exit_status);
3512 * But longjmp out with the U-Boot gd, not the application's, as
3513 * the other end is a setjmp call inside EFI context.
3517 longjmp(exit_jmp, 1);
3519 panic("EFI application exited");
3521 return EFI_EXIT(ret);
3525 * efi_handle_protocol() - get interface of a protocol on a handle
3526 * @handle: handle on which the protocol shall be opened
3527 * @protocol: GUID of the protocol
3528 * @protocol_interface: interface implementing the protocol
3530 * This function implements the HandleProtocol service.
3532 * See the Unified Extensible Firmware Interface (UEFI) specification for
3535 * Return: status code
3537 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
3538 const efi_guid_t *protocol,
3539 void **protocol_interface)
3541 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
3542 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
3546 * efi_bind_controller() - bind a single driver to a controller
3547 * @controller_handle: controller handle
3548 * @driver_image_handle: driver handle
3549 * @remain_device_path: remaining path
3551 * Return: status code
3553 static efi_status_t efi_bind_controller(
3554 efi_handle_t controller_handle,
3555 efi_handle_t driver_image_handle,
3556 struct efi_device_path *remain_device_path)
3558 struct efi_driver_binding_protocol *binding_protocol;
3561 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3562 &efi_guid_driver_binding_protocol,
3563 (void **)&binding_protocol,
3564 driver_image_handle, NULL,
3565 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3566 if (r != EFI_SUCCESS)
3568 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3570 remain_device_path));
3571 if (r == EFI_SUCCESS)
3572 r = EFI_CALL(binding_protocol->start(binding_protocol,
3574 remain_device_path));
3575 efi_close_protocol(driver_image_handle,
3576 &efi_guid_driver_binding_protocol,
3577 driver_image_handle, NULL);
3582 * efi_connect_single_controller() - connect a single driver to a controller
3583 * @controller_handle: controller
3584 * @driver_image_handle: driver
3585 * @remain_device_path: remaining path
3587 * Return: status code
3589 static efi_status_t efi_connect_single_controller(
3590 efi_handle_t controller_handle,
3591 efi_handle_t *driver_image_handle,
3592 struct efi_device_path *remain_device_path)
3594 efi_handle_t *buffer;
3598 size_t connected = 0;
3600 /* Get buffer with all handles with driver binding protocol */
3601 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3602 &efi_guid_driver_binding_protocol,
3603 NULL, &count, &buffer));
3604 if (r != EFI_SUCCESS)
3607 /* Context Override */
3608 if (driver_image_handle) {
3609 for (; *driver_image_handle; ++driver_image_handle) {
3610 for (i = 0; i < count; ++i) {
3611 if (buffer[i] == *driver_image_handle) {
3613 r = efi_bind_controller(
3615 *driver_image_handle,
3616 remain_device_path);
3618 * For drivers that do not support the
3619 * controller or are already connected
3620 * we receive an error code here.
3622 if (r == EFI_SUCCESS)
3630 * TODO: Some overrides are not yet implemented:
3631 * - Platform Driver Override
3632 * - Driver Family Override Search
3633 * - Bus Specific Driver Override
3636 /* Driver Binding Search */
3637 for (i = 0; i < count; ++i) {
3639 r = efi_bind_controller(controller_handle,
3641 remain_device_path);
3642 if (r == EFI_SUCCESS)
3647 efi_free_pool(buffer);
3649 return EFI_NOT_FOUND;
3654 * efi_connect_controller() - connect a controller to a driver
3655 * @controller_handle: handle of the controller
3656 * @driver_image_handle: handle of the driver
3657 * @remain_device_path: device path of a child controller
3658 * @recursive: true to connect all child controllers
3660 * This function implements the ConnectController service.
3662 * See the Unified Extensible Firmware Interface (UEFI) specification for
3665 * First all driver binding protocol handles are tried for binding drivers.
3666 * Afterwards all handles that have opened a protocol of the controller
3667 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3669 * Return: status code
3671 static efi_status_t EFIAPI efi_connect_controller(
3672 efi_handle_t controller_handle,
3673 efi_handle_t *driver_image_handle,
3674 struct efi_device_path *remain_device_path,
3678 efi_status_t ret = EFI_NOT_FOUND;
3679 struct efi_object *efiobj;
3681 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3682 remain_device_path, recursive);
3684 efiobj = efi_search_obj(controller_handle);
3686 ret = EFI_INVALID_PARAMETER;
3690 r = efi_connect_single_controller(controller_handle,
3691 driver_image_handle,
3692 remain_device_path);
3693 if (r == EFI_SUCCESS)
3696 struct efi_handler *handler;
3697 struct efi_open_protocol_info_item *item;
3699 list_for_each_entry(handler, &efiobj->protocols, link) {
3700 list_for_each_entry(item, &handler->open_infos, link) {
3701 if (item->info.attributes &
3702 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3703 r = EFI_CALL(efi_connect_controller(
3704 item->info.controller_handle,
3705 driver_image_handle,
3708 if (r == EFI_SUCCESS)
3714 /* Check for child controller specified by end node */
3715 if (ret != EFI_SUCCESS && remain_device_path &&
3716 remain_device_path->type == DEVICE_PATH_TYPE_END)
3719 return EFI_EXIT(ret);
3723 * efi_reinstall_protocol_interface() - reinstall protocol interface
3724 * @handle: handle on which the protocol shall be reinstalled
3725 * @protocol: GUID of the protocol to be installed
3726 * @old_interface: interface to be removed
3727 * @new_interface: interface to be installed
3729 * This function implements the ReinstallProtocolInterface service.
3731 * See the Unified Extensible Firmware Interface (UEFI) specification for
3734 * The old interface is uninstalled. The new interface is installed.
3735 * Drivers are connected.
3737 * Return: status code
3739 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3740 efi_handle_t handle, const efi_guid_t *protocol,
3741 void *old_interface, void *new_interface)
3745 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, old_interface,
3748 /* Uninstall protocol but do not delete handle */
3749 ret = efi_uninstall_protocol(handle, protocol, old_interface, true);
3750 if (ret != EFI_SUCCESS)
3753 /* Install the new protocol */
3754 ret = efi_add_protocol(handle, protocol, new_interface);
3756 * The UEFI spec does not specify what should happen to the handle
3757 * if in case of an error no protocol interface remains on the handle.
3758 * So let's do nothing here.
3760 if (ret != EFI_SUCCESS)
3763 * The returned status code has to be ignored.
3764 * Do not create an error if no suitable driver for the handle exists.
3766 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3768 return EFI_EXIT(ret);
3772 * efi_get_child_controllers() - get all child controllers associated to a driver
3773 * @efiobj: handle of the controller
3774 * @driver_handle: handle of the driver
3775 * @number_of_children: number of child controllers
3776 * @child_handle_buffer: handles of the the child controllers
3778 * The allocated buffer has to be freed with free().
3780 * Return: status code
3782 static efi_status_t efi_get_child_controllers(
3783 struct efi_object *efiobj,
3784 efi_handle_t driver_handle,
3785 efi_uintn_t *number_of_children,
3786 efi_handle_t **child_handle_buffer)
3788 struct efi_handler *handler;
3789 struct efi_open_protocol_info_item *item;
3790 efi_uintn_t count = 0, i;
3793 /* Count all child controller associations */
3794 list_for_each_entry(handler, &efiobj->protocols, link) {
3795 list_for_each_entry(item, &handler->open_infos, link) {
3796 if (item->info.agent_handle == driver_handle &&
3797 item->info.attributes &
3798 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3803 * Create buffer. In case of duplicate child controller assignments
3804 * the buffer will be too large. But that does not harm.
3806 *number_of_children = 0;
3809 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3810 if (!*child_handle_buffer)
3811 return EFI_OUT_OF_RESOURCES;
3812 /* Copy unique child handles */
3813 list_for_each_entry(handler, &efiobj->protocols, link) {
3814 list_for_each_entry(item, &handler->open_infos, link) {
3815 if (item->info.agent_handle == driver_handle &&
3816 item->info.attributes &
3817 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3818 /* Check this is a new child controller */
3820 for (i = 0; i < *number_of_children; ++i) {
3821 if ((*child_handle_buffer)[i] ==
3822 item->info.controller_handle)
3825 /* Copy handle to buffer */
3827 i = (*number_of_children)++;
3828 (*child_handle_buffer)[i] =
3829 item->info.controller_handle;
3838 * efi_disconnect_controller() - disconnect a controller from a driver
3839 * @controller_handle: handle of the controller
3840 * @driver_image_handle: handle of the driver
3841 * @child_handle: handle of the child to destroy
3843 * This function implements the DisconnectController service.
3845 * See the Unified Extensible Firmware Interface (UEFI) specification for
3848 * Return: status code
3850 static efi_status_t EFIAPI efi_disconnect_controller(
3851 efi_handle_t controller_handle,
3852 efi_handle_t driver_image_handle,
3853 efi_handle_t child_handle)
3855 struct efi_driver_binding_protocol *binding_protocol;
3856 efi_handle_t *child_handle_buffer = NULL;
3857 size_t number_of_children = 0;
3859 struct efi_object *efiobj;
3862 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3865 efiobj = efi_search_obj(controller_handle);
3867 r = EFI_INVALID_PARAMETER;
3871 if (child_handle && !efi_search_obj(child_handle)) {
3872 r = EFI_INVALID_PARAMETER;
3876 /* If no driver handle is supplied, disconnect all drivers */
3877 if (!driver_image_handle) {
3878 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3882 /* Create list of child handles */
3883 r = efi_get_child_controllers(efiobj,
3884 driver_image_handle,
3885 &number_of_children,
3886 &child_handle_buffer);
3887 if (r != EFI_SUCCESS)
3889 sole_child = (number_of_children == 1);
3892 number_of_children = 1;
3893 free(child_handle_buffer);
3894 child_handle_buffer = &child_handle;
3897 /* Get the driver binding protocol */
3898 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3899 &efi_guid_driver_binding_protocol,
3900 (void **)&binding_protocol,
3901 driver_image_handle, NULL,
3902 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3903 if (r != EFI_SUCCESS) {
3904 r = EFI_INVALID_PARAMETER;
3907 /* Remove the children */
3908 if (number_of_children) {
3909 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3912 child_handle_buffer));
3913 if (r != EFI_SUCCESS) {
3914 r = EFI_DEVICE_ERROR;
3918 /* Remove the driver */
3919 if (!child_handle || sole_child) {
3920 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3923 if (r != EFI_SUCCESS) {
3924 r = EFI_DEVICE_ERROR;
3928 efi_close_protocol(driver_image_handle,
3929 &efi_guid_driver_binding_protocol,
3930 driver_image_handle, NULL);
3934 free(child_handle_buffer);
3938 static struct efi_boot_services efi_boot_services = {
3940 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3941 .revision = EFI_SPECIFICATION_VERSION,
3942 .headersize = sizeof(struct efi_boot_services),
3944 .raise_tpl = efi_raise_tpl,
3945 .restore_tpl = efi_restore_tpl,
3946 .allocate_pages = efi_allocate_pages_ext,
3947 .free_pages = efi_free_pages_ext,
3948 .get_memory_map = efi_get_memory_map_ext,
3949 .allocate_pool = efi_allocate_pool_ext,
3950 .free_pool = efi_free_pool_ext,
3951 .create_event = efi_create_event_ext,
3952 .set_timer = efi_set_timer_ext,
3953 .wait_for_event = efi_wait_for_event,
3954 .signal_event = efi_signal_event_ext,
3955 .close_event = efi_close_event,
3956 .check_event = efi_check_event,
3957 .install_protocol_interface = efi_install_protocol_interface,
3958 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3959 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3960 .handle_protocol = efi_handle_protocol,
3962 .register_protocol_notify = efi_register_protocol_notify,
3963 .locate_handle = efi_locate_handle_ext,
3964 .locate_device_path = efi_locate_device_path,
3965 .install_configuration_table = efi_install_configuration_table_ext,
3966 .load_image = efi_load_image,
3967 .start_image = efi_start_image,
3969 .unload_image = efi_unload_image,
3970 .exit_boot_services = efi_exit_boot_services,
3971 .get_next_monotonic_count = efi_get_next_monotonic_count,
3973 .set_watchdog_timer = efi_set_watchdog_timer,
3974 .connect_controller = efi_connect_controller,
3975 .disconnect_controller = efi_disconnect_controller,
3976 .open_protocol = efi_open_protocol,
3977 .close_protocol = efi_close_protocol_ext,
3978 .open_protocol_information = efi_open_protocol_information,
3979 .protocols_per_handle = efi_protocols_per_handle,
3980 .locate_handle_buffer = efi_locate_handle_buffer,
3981 .locate_protocol = efi_locate_protocol,
3982 .install_multiple_protocol_interfaces =
3983 efi_install_multiple_protocol_interfaces_ext,
3984 .uninstall_multiple_protocol_interfaces =
3985 efi_uninstall_multiple_protocol_interfaces_ext,
3986 .calculate_crc32 = efi_calculate_crc32,
3987 .copy_mem = efi_copy_mem,
3988 .set_mem = efi_set_mem,
3989 .create_event_ex = efi_create_event_ex,
3992 static u16 __efi_runtime_data firmware_vendor[] = u"Das U-Boot";
3994 struct efi_system_table __efi_runtime_data systab = {
3996 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3997 .revision = EFI_SPECIFICATION_VERSION,
3998 .headersize = sizeof(struct efi_system_table),
4000 .fw_vendor = firmware_vendor,
4001 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
4002 .runtime = &efi_runtime_services,
4008 * efi_initialize_system_table() - Initialize system table
4010 * Return: status code
4012 efi_status_t efi_initialize_system_table(void)
4016 /* Allocate configuration table array */
4017 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
4018 EFI_MAX_CONFIGURATION_TABLES *
4019 sizeof(struct efi_configuration_table),
4020 (void **)&systab.tables);
4023 * These entries will be set to NULL in ExitBootServices(). To avoid
4024 * relocation in SetVirtualAddressMap(), set them dynamically.
4026 systab.con_in_handle = efi_root;
4027 systab.con_in = &efi_con_in;
4028 systab.con_out_handle = efi_root;
4029 systab.con_out = &efi_con_out;
4030 systab.stderr_handle = efi_root;
4031 systab.std_err = &efi_con_out;
4032 systab.boottime = &efi_boot_services;
4034 /* Set CRC32 field in table headers */
4035 efi_update_table_header_crc32(&systab.hdr);
4036 efi_update_table_header_crc32(&efi_runtime_services.hdr);
4037 efi_update_table_header_crc32(&efi_boot_services.hdr);