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, tmp;
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 tmp = number_of_drivers;
1354 while (number_of_drivers) {
1355 ret = EFI_CALL(efi_disconnect_controller(
1357 driver_handle_buffer[--number_of_drivers],
1359 if (ret != EFI_SUCCESS)
1363 free(driver_handle_buffer);
1367 /* Reconnect all disconnected drivers */
1368 for (; number_of_drivers < tmp; number_of_drivers++) {
1369 r = EFI_CALL(efi_connect_controller(handle,
1370 &driver_handle_buffer[number_of_drivers],
1372 if (r != EFI_SUCCESS)
1373 EFI_PRINT("Failed to reconnect controller\n");
1376 free(driver_handle_buffer);
1381 * efi_uninstall_protocol() - uninstall protocol interface
1383 * @handle: handle from which the protocol shall be removed
1384 * @protocol: GUID of the protocol to be removed
1385 * @protocol_interface: interface to be removed
1386 * @preserve: preserve or delete the handle and remove it from any
1387 * list it participates if no protocols remain
1389 * This function DOES NOT delete a handle without installed protocol.
1391 * Return: status code
1393 static efi_status_t efi_uninstall_protocol
1394 (efi_handle_t handle, const efi_guid_t *protocol,
1395 void *protocol_interface, bool preserve)
1397 struct efi_handler *handler;
1398 struct efi_open_protocol_info_item *item;
1399 struct efi_open_protocol_info_item *pos;
1402 /* Find the protocol on the handle */
1403 r = efi_search_protocol(handle, protocol, &handler);
1404 if (r != EFI_SUCCESS)
1406 if (handler->protocol_interface != protocol_interface)
1407 return EFI_NOT_FOUND;
1408 /* Disconnect controllers */
1409 r = efi_disconnect_all_drivers(handle, protocol, NULL);
1410 if (r != EFI_SUCCESS) {
1411 r = EFI_ACCESS_DENIED;
1414 /* Close protocol */
1415 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1416 if (item->info.attributes ==
1417 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1418 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1419 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1420 efi_delete_open_info(item);
1422 /* if agents didn't close the protocols properly */
1423 if (!list_empty(&handler->open_infos)) {
1424 r = EFI_ACCESS_DENIED;
1425 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
1428 r = efi_remove_protocol(handle, protocol, protocol_interface);
1429 if (r != EFI_SUCCESS)
1432 * We don't care about the return value here since the
1433 * handle might have more protocols installed
1436 efi_purge_handle(handle);
1442 * efi_uninstall_protocol_interface() - uninstall protocol interface
1443 * @handle: handle from which the protocol shall be removed
1444 * @protocol: GUID of the protocol to be removed
1445 * @protocol_interface: interface to be removed
1447 * This function implements the UninstallProtocolInterface service.
1449 * See the Unified Extensible Firmware Interface (UEFI) specification for
1452 * Return: status code
1454 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1455 (efi_handle_t handle, const efi_guid_t *protocol,
1456 void *protocol_interface)
1460 EFI_ENTRY("%p, %pUs, %p", handle, protocol, protocol_interface);
1462 ret = efi_uninstall_protocol(handle, protocol, protocol_interface, false);
1463 if (ret != EFI_SUCCESS)
1467 return EFI_EXIT(ret);
1471 * efi_register_protocol_notify() - register an event for notification when a
1472 * protocol is installed.
1473 * @protocol: GUID of the protocol whose installation shall be notified
1474 * @event: event to be signaled upon installation of the protocol
1475 * @registration: key for retrieving the registration information
1477 * This function implements the RegisterProtocolNotify service.
1478 * See the Unified Extensible Firmware Interface (UEFI) specification
1481 * Return: status code
1483 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
1484 struct efi_event *event,
1485 void **registration)
1487 struct efi_register_notify_event *item;
1488 efi_status_t ret = EFI_SUCCESS;
1490 EFI_ENTRY("%pUs, %p, %p", protocol, event, registration);
1492 if (!protocol || !event || !registration) {
1493 ret = EFI_INVALID_PARAMETER;
1497 item = calloc(1, sizeof(struct efi_register_notify_event));
1499 ret = EFI_OUT_OF_RESOURCES;
1503 item->event = event;
1504 guidcpy(&item->protocol, protocol);
1505 INIT_LIST_HEAD(&item->handles);
1507 list_add_tail(&item->link, &efi_register_notify_events);
1509 *registration = item;
1511 return EFI_EXIT(ret);
1515 * efi_search() - determine if an EFI handle implements a protocol
1517 * @search_type: selection criterion
1518 * @protocol: GUID of the protocol
1521 * See the documentation of the LocateHandle service in the UEFI specification.
1523 * Return: 0 if the handle implements the protocol
1525 static int efi_search(enum efi_locate_search_type search_type,
1526 const efi_guid_t *protocol, efi_handle_t handle)
1530 switch (search_type) {
1534 ret = efi_search_protocol(handle, protocol, NULL);
1535 return (ret != EFI_SUCCESS);
1537 /* Invalid search type */
1543 * efi_check_register_notify_event() - check if registration key is valid
1545 * Check that a pointer is a valid registration key as returned by
1546 * RegisterProtocolNotify().
1548 * @key: registration key
1549 * Return: valid registration key or NULL
1551 static struct efi_register_notify_event *efi_check_register_notify_event
1554 struct efi_register_notify_event *event;
1556 list_for_each_entry(event, &efi_register_notify_events, link) {
1557 if (event == (struct efi_register_notify_event *)key)
1564 * efi_locate_handle() - locate handles implementing a protocol
1566 * @search_type: selection criterion
1567 * @protocol: GUID of the protocol
1568 * @search_key: registration key
1569 * @buffer_size: size of the buffer to receive the handles in bytes
1570 * @buffer: buffer to receive the relevant handles
1572 * This function is meant for U-Boot internal calls. For the API implementation
1573 * of the LocateHandle service see efi_locate_handle_ext.
1575 * Return: status code
1577 static efi_status_t efi_locate_handle(
1578 enum efi_locate_search_type search_type,
1579 const efi_guid_t *protocol, void *search_key,
1580 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1582 struct efi_object *efiobj;
1583 efi_uintn_t size = 0;
1584 struct efi_register_notify_event *event;
1585 struct efi_protocol_notification *handle = NULL;
1587 /* Check parameters */
1588 switch (search_type) {
1591 case BY_REGISTER_NOTIFY:
1593 return EFI_INVALID_PARAMETER;
1594 /* Check that the registration key is valid */
1595 event = efi_check_register_notify_event(search_key);
1597 return EFI_INVALID_PARAMETER;
1601 return EFI_INVALID_PARAMETER;
1604 return EFI_INVALID_PARAMETER;
1607 /* Count how much space we need */
1608 if (search_type == BY_REGISTER_NOTIFY) {
1609 if (list_empty(&event->handles))
1610 return EFI_NOT_FOUND;
1611 handle = list_first_entry(&event->handles,
1612 struct efi_protocol_notification,
1614 efiobj = handle->handle;
1615 size += sizeof(void *);
1617 list_for_each_entry(efiobj, &efi_obj_list, link) {
1618 if (!efi_search(search_type, protocol, efiobj))
1619 size += sizeof(void *);
1622 return EFI_NOT_FOUND;
1626 return EFI_INVALID_PARAMETER;
1628 if (*buffer_size < size) {
1629 *buffer_size = size;
1630 return EFI_BUFFER_TOO_SMALL;
1633 *buffer_size = size;
1635 /* The buffer size is sufficient but there is no buffer */
1637 return EFI_INVALID_PARAMETER;
1639 /* Then fill the array */
1640 if (search_type == BY_REGISTER_NOTIFY) {
1642 list_del(&handle->link);
1644 list_for_each_entry(efiobj, &efi_obj_list, link) {
1645 if (!efi_search(search_type, protocol, efiobj))
1654 * efi_locate_handle_ext() - locate handles implementing a protocol.
1655 * @search_type: selection criterion
1656 * @protocol: GUID of the protocol
1657 * @search_key: registration key
1658 * @buffer_size: size of the buffer to receive the handles in bytes
1659 * @buffer: buffer to receive the relevant handles
1661 * This function implements the LocateHandle service.
1663 * See the Unified Extensible Firmware Interface (UEFI) specification for
1666 * Return: 0 if the handle implements the protocol
1668 static efi_status_t EFIAPI efi_locate_handle_ext(
1669 enum efi_locate_search_type search_type,
1670 const efi_guid_t *protocol, void *search_key,
1671 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1673 EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key,
1674 buffer_size, buffer);
1676 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1677 buffer_size, buffer));
1681 * efi_remove_configuration_table() - collapses configuration table entries,
1684 * @i: index of the table entry to be removed
1686 static void efi_remove_configuration_table(int i)
1688 struct efi_configuration_table *this = &systab.tables[i];
1689 struct efi_configuration_table *next = &systab.tables[i + 1];
1690 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1692 memmove(this, next, (ulong)end - (ulong)next);
1697 * efi_install_configuration_table() - adds, updates, or removes a
1698 * configuration table
1699 * @guid: GUID of the installed table
1700 * @table: table to be installed
1702 * This function is used for internal calls. For the API implementation of the
1703 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1705 * Return: status code
1707 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1710 struct efi_event *evt;
1714 return EFI_INVALID_PARAMETER;
1716 /* Check for GUID override */
1717 for (i = 0; i < systab.nr_tables; i++) {
1718 if (!guidcmp(guid, &systab.tables[i].guid)) {
1720 systab.tables[i].table = table;
1722 efi_remove_configuration_table(i);
1728 return EFI_NOT_FOUND;
1730 /* No override, check for overflow */
1731 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1732 return EFI_OUT_OF_RESOURCES;
1734 /* Add a new entry */
1735 guidcpy(&systab.tables[i].guid, guid);
1736 systab.tables[i].table = table;
1737 systab.nr_tables = i + 1;
1740 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1741 efi_update_table_header_crc32(&systab.hdr);
1743 /* Notify that the configuration table was changed */
1744 list_for_each_entry(evt, &efi_events, link) {
1745 if (evt->group && !guidcmp(evt->group, guid)) {
1746 efi_signal_event(evt);
1755 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1756 * configuration table.
1757 * @guid: GUID of the installed table
1758 * @table: table to be installed
1760 * This function implements the InstallConfigurationTable service.
1762 * See the Unified Extensible Firmware Interface (UEFI) specification for
1765 * Return: status code
1768 EFIAPI efi_install_configuration_table_ext(const efi_guid_t *guid,
1771 EFI_ENTRY("%pUs, %p", guid, table);
1772 return EFI_EXIT(efi_install_configuration_table(guid, table));
1776 * efi_setup_loaded_image() - initialize a loaded image
1778 * Initialize a loaded_image_info and loaded_image_info object with correct
1779 * protocols, boot-device, etc.
1781 * In case of an error \*handle_ptr and \*info_ptr are set to NULL and an error
1784 * @device_path: device path of the loaded image
1785 * @file_path: file path of the loaded image
1786 * @handle_ptr: handle of the loaded image
1787 * @info_ptr: loaded image protocol
1788 * Return: status code
1790 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1791 struct efi_device_path *file_path,
1792 struct efi_loaded_image_obj **handle_ptr,
1793 struct efi_loaded_image **info_ptr)
1796 struct efi_loaded_image *info = NULL;
1797 struct efi_loaded_image_obj *obj = NULL;
1798 struct efi_device_path *dp;
1800 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1804 info = calloc(1, sizeof(*info));
1806 return EFI_OUT_OF_RESOURCES;
1807 obj = calloc(1, sizeof(*obj));
1810 return EFI_OUT_OF_RESOURCES;
1812 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1814 /* Add internal object to object list */
1815 efi_add_handle(&obj->header);
1817 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1818 info->file_path = file_path;
1819 info->system_table = &systab;
1822 info->device_handle = efi_dp_find_obj(device_path, NULL, NULL);
1824 dp = efi_dp_append(device_path, file_path);
1826 ret = EFI_OUT_OF_RESOURCES;
1832 ret = efi_add_protocol(&obj->header,
1833 &efi_guid_loaded_image_device_path, dp);
1834 if (ret != EFI_SUCCESS)
1838 * When asking for the loaded_image interface, just
1839 * return handle which points to loaded_image_info
1841 ret = efi_add_protocol(&obj->header,
1842 &efi_guid_loaded_image, info);
1843 if (ret != EFI_SUCCESS)
1851 printf("ERROR: Failure to install protocols for loaded image\n");
1852 efi_delete_handle(&obj->header);
1858 * efi_locate_device_path() - Get the device path and handle of an device
1859 * implementing a protocol
1860 * @protocol: GUID of the protocol
1861 * @device_path: device path
1862 * @device: handle of the device
1864 * This function implements the LocateDevicePath service.
1866 * See the Unified Extensible Firmware Interface (UEFI) specification for
1869 * Return: status code
1871 efi_status_t EFIAPI efi_locate_device_path(const efi_guid_t *protocol,
1872 struct efi_device_path **device_path,
1873 efi_handle_t *device)
1875 struct efi_device_path *dp;
1877 struct efi_handler *handler;
1878 efi_handle_t *handles;
1880 size_t len_best = 0;
1881 efi_uintn_t no_handles;
1885 EFI_ENTRY("%pUs, %p, %p", protocol, device_path, device);
1887 if (!protocol || !device_path || !*device_path) {
1888 ret = EFI_INVALID_PARAMETER;
1892 /* Find end of device path */
1893 len = efi_dp_instance_size(*device_path);
1895 /* Get all handles implementing the protocol */
1896 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1897 &no_handles, &handles));
1898 if (ret != EFI_SUCCESS)
1901 for (i = 0; i < no_handles; ++i) {
1902 /* Find the device path protocol */
1903 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1905 if (ret != EFI_SUCCESS)
1907 dp = (struct efi_device_path *)handler->protocol_interface;
1908 len_dp = efi_dp_instance_size(dp);
1910 * This handle can only be a better fit
1911 * if its device path length is longer than the best fit and
1912 * if its device path length is shorter of equal the searched
1915 if (len_dp <= len_best || len_dp > len)
1917 /* Check if dp is a subpath of device_path */
1918 if (memcmp(*device_path, dp, len_dp))
1921 ret = EFI_INVALID_PARAMETER;
1924 *device = handles[i];
1928 remainder = (u8 *)*device_path + len_best;
1929 *device_path = (struct efi_device_path *)remainder;
1932 ret = EFI_NOT_FOUND;
1935 return EFI_EXIT(ret);
1939 * efi_load_image_from_file() - load an image from file system
1941 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1942 * callers obligation to update the memory type as needed.
1944 * @file_path: the path of the image to load
1945 * @buffer: buffer containing the loaded image
1946 * @size: size of the loaded image
1947 * Return: status code
1950 efi_status_t efi_load_image_from_file(struct efi_device_path *file_path,
1951 void **buffer, efi_uintn_t *size)
1953 struct efi_file_handle *f;
1959 f = efi_file_from_path(file_path);
1961 return EFI_NOT_FOUND;
1963 ret = efi_file_size(f, &bs);
1964 if (ret != EFI_SUCCESS)
1968 * When reading the file we do not yet know if it contains an
1969 * application, a boottime driver, or a runtime driver. So here we
1970 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1971 * update the reservation according to the image type.
1973 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1974 EFI_BOOT_SERVICES_DATA,
1975 efi_size_in_pages(bs), &addr);
1976 if (ret != EFI_SUCCESS) {
1977 ret = EFI_OUT_OF_RESOURCES;
1982 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1983 if (ret != EFI_SUCCESS)
1984 efi_free_pages(addr, efi_size_in_pages(bs));
1985 *buffer = (void *)(uintptr_t)addr;
1988 EFI_CALL(f->close(f));
1993 * efi_load_image_from_path() - load an image using a file path
1995 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1996 * callers obligation to update the memory type as needed.
1998 * @boot_policy: true for request originating from the boot manager
1999 * @file_path: the path of the image to load
2000 * @buffer: buffer containing the loaded image
2001 * @size: size of the loaded image
2002 * Return: status code
2005 efi_status_t efi_load_image_from_path(bool boot_policy,
2006 struct efi_device_path *file_path,
2007 void **buffer, efi_uintn_t *size)
2009 efi_handle_t device;
2011 struct efi_device_path *dp, *rem;
2012 struct efi_load_file_protocol *load_file_protocol = NULL;
2013 efi_uintn_t buffer_size;
2014 uint64_t addr, pages;
2015 const efi_guid_t *guid;
2016 struct efi_handler *handler;
2018 /* In case of failure nothing is returned */
2023 device = efi_dp_find_obj(dp, NULL, &rem);
2024 ret = efi_search_protocol(device, &efi_simple_file_system_protocol_guid,
2026 if (ret == EFI_SUCCESS)
2027 return efi_load_image_from_file(file_path, buffer, size);
2029 ret = efi_search_protocol(device, &efi_guid_load_file_protocol, NULL);
2030 if (ret == EFI_SUCCESS) {
2031 guid = &efi_guid_load_file_protocol;
2032 } else if (!boot_policy) {
2033 guid = &efi_guid_load_file2_protocol;
2034 ret = efi_search_protocol(device, guid, NULL);
2036 if (ret != EFI_SUCCESS)
2037 return EFI_NOT_FOUND;
2038 ret = efi_search_protocol(device, guid, &handler);
2039 if (ret != EFI_SUCCESS)
2040 return EFI_NOT_FOUND;
2042 load_file_protocol = handler->protocol_interface;
2043 ret = EFI_CALL(load_file_protocol->load_file(
2044 load_file_protocol, rem, boot_policy,
2045 &buffer_size, NULL));
2046 if (ret != EFI_BUFFER_TOO_SMALL)
2048 pages = efi_size_in_pages(buffer_size);
2049 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, EFI_BOOT_SERVICES_DATA,
2051 if (ret != EFI_SUCCESS) {
2052 ret = EFI_OUT_OF_RESOURCES;
2055 ret = EFI_CALL(load_file_protocol->load_file(
2056 load_file_protocol, rem, boot_policy,
2057 &buffer_size, (void *)(uintptr_t)addr));
2058 if (ret != EFI_SUCCESS)
2059 efi_free_pages(addr, pages);
2061 efi_close_protocol(device, guid, efi_root, NULL);
2062 if (ret == EFI_SUCCESS) {
2063 *buffer = (void *)(uintptr_t)addr;
2064 *size = buffer_size;
2071 * efi_load_image() - load an EFI image into memory
2072 * @boot_policy: true for request originating from the boot manager
2073 * @parent_image: the caller's image handle
2074 * @file_path: the path of the image to load
2075 * @source_buffer: memory location from which the image is installed
2076 * @source_size: size of the memory area from which the image is installed
2077 * @image_handle: handle for the newly installed image
2079 * This function implements the LoadImage service.
2081 * See the Unified Extensible Firmware Interface (UEFI) specification
2084 * Return: status code
2086 efi_status_t EFIAPI efi_load_image(bool boot_policy,
2087 efi_handle_t parent_image,
2088 struct efi_device_path *file_path,
2089 void *source_buffer,
2090 efi_uintn_t source_size,
2091 efi_handle_t *image_handle)
2093 struct efi_device_path *dp, *fp;
2094 struct efi_loaded_image *info = NULL;
2095 struct efi_loaded_image_obj **image_obj =
2096 (struct efi_loaded_image_obj **)image_handle;
2100 EFI_ENTRY("%d, %p, %pD, %p, %zu, %p", boot_policy, parent_image,
2101 file_path, source_buffer, source_size, image_handle);
2103 if (!image_handle || (!source_buffer && !file_path) ||
2104 !efi_search_obj(parent_image) ||
2105 /* The parent image handle must refer to a loaded image */
2106 !parent_image->type) {
2107 ret = EFI_INVALID_PARAMETER;
2111 if (!source_buffer) {
2112 ret = efi_load_image_from_path(boot_policy, file_path,
2113 &dest_buffer, &source_size);
2114 if (ret != EFI_SUCCESS)
2117 dest_buffer = source_buffer;
2119 /* split file_path which contains both the device and file parts */
2120 efi_dp_split_file_path(file_path, &dp, &fp);
2121 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
2122 if (ret == EFI_SUCCESS)
2123 ret = efi_load_pe(*image_obj, dest_buffer, source_size, info);
2125 /* Release buffer to which file was loaded */
2126 efi_free_pages((uintptr_t)dest_buffer,
2127 efi_size_in_pages(source_size));
2128 if (ret == EFI_SUCCESS || ret == EFI_SECURITY_VIOLATION) {
2129 info->system_table = &systab;
2130 info->parent_handle = parent_image;
2132 /* The image is invalid. Release all associated resources. */
2133 efi_delete_handle(*image_handle);
2134 *image_handle = NULL;
2138 return EFI_EXIT(ret);
2142 * efi_exit_caches() - fix up caches for EFI payloads if necessary
2144 static void efi_exit_caches(void)
2146 #if defined(CONFIG_EFI_GRUB_ARM32_WORKAROUND)
2148 * Boooting Linux via GRUB prior to version 2.04 fails on 32bit ARM if
2149 * caches are enabled.
2152 * According to the UEFI spec caches that can be managed via CP15
2153 * operations should be enabled. Caches requiring platform information
2154 * to manage should be disabled. This should not happen in
2155 * ExitBootServices() but before invoking any UEFI binary is invoked.
2157 * We want to keep the current workaround while GRUB prior to version
2158 * 2.04 is still in use.
2160 cleanup_before_linux();
2165 * efi_exit_boot_services() - stop all boot services
2166 * @image_handle: handle of the loaded image
2167 * @map_key: key of the memory map
2169 * This function implements the ExitBootServices service.
2171 * See the Unified Extensible Firmware Interface (UEFI) specification
2174 * All timer events are disabled. For exit boot services events the
2175 * notification function is called. The boot services are disabled in the
2178 * Return: status code
2180 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
2181 efi_uintn_t map_key)
2183 struct efi_event *evt, *next_event;
2184 efi_status_t ret = EFI_SUCCESS;
2186 EFI_ENTRY("%p, %zx", image_handle, map_key);
2188 /* Check that the caller has read the current memory map */
2189 if (map_key != efi_memory_map_key) {
2190 ret = EFI_INVALID_PARAMETER;
2194 /* Check if ExitBootServices has already been called */
2195 if (!systab.boottime)
2198 /* Notify EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES event group. */
2199 list_for_each_entry(evt, &efi_events, link) {
2201 !guidcmp(evt->group,
2202 &efi_guid_event_group_before_exit_boot_services)) {
2203 efi_signal_event(evt);
2208 /* Stop all timer related activities */
2209 timers_enabled = false;
2211 /* Add related events to the event group */
2212 list_for_each_entry(evt, &efi_events, link) {
2213 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
2214 evt->group = &efi_guid_event_group_exit_boot_services;
2216 /* Notify that ExitBootServices is invoked. */
2217 list_for_each_entry(evt, &efi_events, link) {
2219 !guidcmp(evt->group,
2220 &efi_guid_event_group_exit_boot_services)) {
2221 efi_signal_event(evt);
2226 /* Make sure that notification functions are not called anymore */
2227 efi_tpl = TPL_HIGH_LEVEL;
2229 /* Notify variable services */
2230 efi_variables_boot_exit_notify();
2232 /* Remove all events except EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
2233 list_for_each_entry_safe(evt, next_event, &efi_events, link) {
2234 if (evt->type != EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE)
2235 list_del(&evt->link);
2238 if (!efi_st_keep_devices) {
2239 bootm_disable_interrupts();
2240 if (IS_ENABLED(CONFIG_USB_DEVICE))
2242 board_quiesce_devices();
2243 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
2246 /* Patch out unsupported runtime function */
2247 efi_runtime_detach();
2249 /* Fix up caches for EFI payloads if necessary */
2252 /* Disable boot time services */
2253 systab.con_in_handle = NULL;
2254 systab.con_in = NULL;
2255 systab.con_out_handle = NULL;
2256 systab.con_out = NULL;
2257 systab.stderr_handle = NULL;
2258 systab.std_err = NULL;
2259 systab.boottime = NULL;
2261 /* Recalculate CRC32 */
2262 efi_update_table_header_crc32(&systab.hdr);
2264 /* Give the payload some time to boot */
2265 efi_set_watchdog(0);
2268 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
2269 if (ret != EFI_SUCCESS)
2270 efi_tcg2_notify_exit_boot_services_failed();
2273 return EFI_EXIT(ret);
2277 * efi_get_next_monotonic_count() - get next value of the counter
2278 * @count: returned value of the counter
2280 * This function implements the NextMonotonicCount service.
2282 * See the Unified Extensible Firmware Interface (UEFI) specification for
2285 * Return: status code
2287 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2289 static uint64_t mono;
2292 EFI_ENTRY("%p", count);
2294 ret = EFI_INVALID_PARAMETER;
2300 return EFI_EXIT(ret);
2304 * efi_stall() - sleep
2305 * @microseconds: period to sleep in microseconds
2307 * This function implements the Stall service.
2309 * See the Unified Extensible Firmware Interface (UEFI) specification for
2312 * Return: status code
2314 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2318 EFI_ENTRY("%ld", microseconds);
2320 end_tick = get_ticks() + usec_to_tick(microseconds);
2321 while (get_ticks() < end_tick)
2324 return EFI_EXIT(EFI_SUCCESS);
2328 * efi_set_watchdog_timer() - reset the watchdog timer
2329 * @timeout: seconds before reset by watchdog
2330 * @watchdog_code: code to be logged when resetting
2331 * @data_size: size of buffer in bytes
2332 * @watchdog_data: buffer with data describing the reset reason
2334 * This function implements the SetWatchdogTimer service.
2336 * See the Unified Extensible Firmware Interface (UEFI) specification for
2339 * Return: status code
2341 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2342 uint64_t watchdog_code,
2343 unsigned long data_size,
2344 uint16_t *watchdog_data)
2346 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
2347 data_size, watchdog_data);
2348 return EFI_EXIT(efi_set_watchdog(timeout));
2352 * efi_close_protocol() - close a protocol
2353 * @handle: handle on which the protocol shall be closed
2354 * @protocol: GUID of the protocol to close
2355 * @agent_handle: handle of the driver
2356 * @controller_handle: handle of the controller
2358 * This is the function implementing the CloseProtocol service is for internal
2359 * usage in U-Boot. For API usage wrapper efi_close_protocol_ext() is provided.
2361 * See the Unified Extensible Firmware Interface (UEFI) specification for
2364 * Return: status code
2366 efi_status_t efi_close_protocol(efi_handle_t handle, const efi_guid_t *protocol,
2367 efi_handle_t agent_handle,
2368 efi_handle_t controller_handle)
2370 struct efi_handler *handler;
2371 struct efi_open_protocol_info_item *item;
2372 struct efi_open_protocol_info_item *pos;
2375 if (!efi_search_obj(agent_handle) ||
2376 (controller_handle && !efi_search_obj(controller_handle)))
2377 return EFI_INVALID_PARAMETER;
2378 ret = efi_search_protocol(handle, protocol, &handler);
2379 if (ret != EFI_SUCCESS)
2382 ret = EFI_NOT_FOUND;
2383 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2384 if (item->info.agent_handle == agent_handle &&
2385 item->info.controller_handle == controller_handle) {
2386 efi_delete_open_info(item);
2395 * efi_close_protocol_ext() - close a protocol
2396 * @handle: handle on which the protocol shall be closed
2397 * @protocol: GUID of the protocol to close
2398 * @agent_handle: handle of the driver
2399 * @controller_handle: handle of the controller
2401 * This function implements the CloseProtocol service.
2403 * See the Unified Extensible Firmware Interface (UEFI) specification for
2406 * Return: status code
2408 static efi_status_t EFIAPI
2409 efi_close_protocol_ext(efi_handle_t handle, const efi_guid_t *protocol,
2410 efi_handle_t agent_handle,
2411 efi_handle_t controller_handle)
2415 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, agent_handle,
2418 ret = efi_close_protocol(handle, protocol,
2419 agent_handle, controller_handle);
2421 return EFI_EXIT(ret);
2425 * efi_open_protocol_information() - provide information about then open status
2426 * of a protocol on a handle
2427 * @handle: handle for which the information shall be retrieved
2428 * @protocol: GUID of the protocol
2429 * @entry_buffer: buffer to receive the open protocol information
2430 * @entry_count: number of entries available in the buffer
2432 * This function implements the OpenProtocolInformation service.
2434 * See the Unified Extensible Firmware Interface (UEFI) specification for
2437 * Return: status code
2439 static efi_status_t EFIAPI efi_open_protocol_information(
2440 efi_handle_t handle, const efi_guid_t *protocol,
2441 struct efi_open_protocol_info_entry **entry_buffer,
2442 efi_uintn_t *entry_count)
2444 unsigned long buffer_size;
2445 unsigned long count;
2446 struct efi_handler *handler;
2447 struct efi_open_protocol_info_item *item;
2450 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, entry_buffer,
2453 /* Check parameters */
2454 if (!entry_buffer) {
2455 r = EFI_INVALID_PARAMETER;
2458 r = efi_search_protocol(handle, protocol, &handler);
2459 if (r != EFI_SUCCESS)
2464 list_for_each_entry(item, &handler->open_infos, link) {
2465 if (item->info.open_count)
2468 *entry_count = count;
2469 *entry_buffer = NULL;
2476 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2477 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2478 (void **)entry_buffer);
2479 if (r != EFI_SUCCESS)
2481 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2482 if (item->info.open_count)
2483 (*entry_buffer)[--count] = item->info;
2490 * efi_protocols_per_handle() - get protocols installed on a handle
2491 * @handle: handle for which the information is retrieved
2492 * @protocol_buffer: buffer with protocol GUIDs
2493 * @protocol_buffer_count: number of entries in the buffer
2495 * This function implements the ProtocolsPerHandleService.
2497 * See the Unified Extensible Firmware Interface (UEFI) specification for
2500 * Return: status code
2502 static efi_status_t EFIAPI efi_protocols_per_handle(
2503 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2504 efi_uintn_t *protocol_buffer_count)
2506 unsigned long buffer_size;
2507 struct efi_object *efiobj;
2508 struct list_head *protocol_handle;
2511 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2512 protocol_buffer_count);
2514 if (!handle || !protocol_buffer || !protocol_buffer_count)
2515 return EFI_EXIT(EFI_INVALID_PARAMETER);
2517 *protocol_buffer = NULL;
2518 *protocol_buffer_count = 0;
2520 efiobj = efi_search_obj(handle);
2522 return EFI_EXIT(EFI_INVALID_PARAMETER);
2524 /* Count protocols */
2525 list_for_each(protocol_handle, &efiobj->protocols) {
2526 ++*protocol_buffer_count;
2530 if (*protocol_buffer_count) {
2533 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2534 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2535 (void **)protocol_buffer);
2536 if (r != EFI_SUCCESS)
2538 list_for_each(protocol_handle, &efiobj->protocols) {
2539 struct efi_handler *protocol;
2541 protocol = list_entry(protocol_handle,
2542 struct efi_handler, link);
2543 (*protocol_buffer)[j] = (void *)&protocol->guid;
2548 return EFI_EXIT(EFI_SUCCESS);
2551 efi_status_t efi_locate_handle_buffer_int(enum efi_locate_search_type search_type,
2552 const efi_guid_t *protocol, void *search_key,
2553 efi_uintn_t *no_handles, efi_handle_t **buffer)
2556 efi_uintn_t buffer_size = 0;
2558 if (!no_handles || !buffer) {
2559 r = EFI_INVALID_PARAMETER;
2564 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2566 if (r != EFI_BUFFER_TOO_SMALL)
2568 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2570 if (r != EFI_SUCCESS)
2572 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2574 if (r == EFI_SUCCESS)
2575 *no_handles = buffer_size / sizeof(efi_handle_t);
2581 * efi_locate_handle_buffer() - locate handles implementing a protocol
2582 * @search_type: selection criterion
2583 * @protocol: GUID of the protocol
2584 * @search_key: registration key
2585 * @no_handles: number of returned handles
2586 * @buffer: buffer with the returned handles
2588 * This function implements the LocateHandleBuffer service.
2590 * See the Unified Extensible Firmware Interface (UEFI) specification for
2593 * Return: status code
2595 efi_status_t EFIAPI efi_locate_handle_buffer(
2596 enum efi_locate_search_type search_type,
2597 const efi_guid_t *protocol, void *search_key,
2598 efi_uintn_t *no_handles, efi_handle_t **buffer)
2602 EFI_ENTRY("%d, %pUs, %p, %p, %p", search_type, protocol, search_key,
2603 no_handles, buffer);
2605 r = efi_locate_handle_buffer_int(search_type, protocol, search_key,
2606 no_handles, buffer);
2612 * efi_locate_protocol() - find an interface implementing a protocol
2613 * @protocol: GUID of the protocol
2614 * @registration: registration key passed to the notification function
2615 * @protocol_interface: interface implementing the protocol
2617 * This function implements the LocateProtocol service.
2619 * See the Unified Extensible Firmware Interface (UEFI) specification for
2622 * Return: status code
2624 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2626 void **protocol_interface)
2628 struct efi_handler *handler;
2630 struct efi_object *efiobj;
2632 EFI_ENTRY("%pUs, %p, %p", protocol, registration, protocol_interface);
2635 * The UEFI spec explicitly requires a protocol even if a registration
2636 * key is provided. This differs from the logic in LocateHandle().
2638 if (!protocol || !protocol_interface)
2639 return EFI_EXIT(EFI_INVALID_PARAMETER);
2642 struct efi_register_notify_event *event;
2643 struct efi_protocol_notification *handle;
2645 event = efi_check_register_notify_event(registration);
2647 return EFI_EXIT(EFI_INVALID_PARAMETER);
2649 * The UEFI spec requires to return EFI_NOT_FOUND if no
2650 * protocol instance matches protocol and registration.
2651 * So let's do the same for a mismatch between protocol and
2654 if (guidcmp(&event->protocol, protocol))
2656 if (list_empty(&event->handles))
2658 handle = list_first_entry(&event->handles,
2659 struct efi_protocol_notification,
2661 efiobj = handle->handle;
2662 list_del(&handle->link);
2664 ret = efi_search_protocol(efiobj, protocol, &handler);
2665 if (ret == EFI_SUCCESS)
2668 list_for_each_entry(efiobj, &efi_obj_list, link) {
2669 ret = efi_search_protocol(efiobj, protocol, &handler);
2670 if (ret == EFI_SUCCESS)
2675 *protocol_interface = NULL;
2676 return EFI_EXIT(EFI_NOT_FOUND);
2678 *protocol_interface = handler->protocol_interface;
2679 return EFI_EXIT(EFI_SUCCESS);
2683 * efi_install_multiple_protocol_interfaces_int() - Install multiple protocol
2685 * @handle: handle on which the protocol interfaces shall be installed
2686 * @argptr: va_list of args
2688 * Core functionality of efi_install_multiple_protocol_interfaces
2689 * Must not be called directly
2691 * Return: status code
2693 static efi_status_t EFIAPI
2694 efi_install_multiple_protocol_interfaces_int(efi_handle_t *handle,
2697 const efi_guid_t *protocol;
2698 void *protocol_interface;
2699 efi_handle_t old_handle;
2700 efi_status_t ret = EFI_SUCCESS;
2702 efi_va_list argptr_copy;
2705 return EFI_INVALID_PARAMETER;
2707 efi_va_copy(argptr_copy, argptr);
2709 protocol = efi_va_arg(argptr, efi_guid_t*);
2712 protocol_interface = efi_va_arg(argptr, void*);
2713 /* Check that a device path has not been installed before */
2714 if (!guidcmp(protocol, &efi_guid_device_path)) {
2715 struct efi_device_path *dp = protocol_interface;
2717 ret = EFI_CALL(efi_locate_device_path(protocol, &dp,
2719 if (ret == EFI_SUCCESS &&
2720 dp->type == DEVICE_PATH_TYPE_END) {
2721 EFI_PRINT("Path %pD already installed\n",
2722 protocol_interface);
2723 ret = EFI_ALREADY_STARTED;
2727 ret = EFI_CALL(efi_install_protocol_interface(handle, protocol,
2728 EFI_NATIVE_INTERFACE,
2729 protocol_interface));
2730 if (ret != EFI_SUCCESS)
2734 if (ret == EFI_SUCCESS)
2737 /* If an error occurred undo all changes. */
2739 protocol = efi_va_arg(argptr_copy, efi_guid_t*);
2740 protocol_interface = efi_va_arg(argptr_copy, void*);
2741 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2742 protocol_interface));
2746 efi_va_end(argptr_copy);
2752 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2754 * @handle: handle on which the protocol interfaces shall be installed
2755 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2759 * This is the function for internal usage in U-Boot. For the API function
2760 * implementing the InstallMultipleProtocol service see
2761 * efi_install_multiple_protocol_interfaces_ext()
2763 * Return: status code
2766 efi_install_multiple_protocol_interfaces(efi_handle_t *handle, ...)
2771 efi_va_start(argptr, handle);
2772 ret = efi_install_multiple_protocol_interfaces_int(handle, argptr);
2778 * efi_install_multiple_protocol_interfaces_ext() - Install multiple protocol
2780 * @handle: handle on which the protocol interfaces shall be installed
2781 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2784 * This function implements the MultipleProtocolInterfaces service.
2786 * See the Unified Extensible Firmware Interface (UEFI) specification for
2789 * Return: status code
2791 static efi_status_t EFIAPI
2792 efi_install_multiple_protocol_interfaces_ext(efi_handle_t *handle, ...)
2794 EFI_ENTRY("%p", handle);
2798 efi_va_start(argptr, handle);
2799 ret = efi_install_multiple_protocol_interfaces_int(handle, argptr);
2801 return EFI_EXIT(ret);
2805 * efi_uninstall_multiple_protocol_interfaces_int() - wrapper for uninstall
2808 * @handle: handle from which the protocol interfaces shall be removed
2809 * @argptr: va_list of args
2811 * Core functionality of efi_uninstall_multiple_protocol_interfaces
2812 * Must not be called directly
2814 * Return: status code
2816 static efi_status_t EFIAPI
2817 efi_uninstall_multiple_protocol_interfaces_int(efi_handle_t handle,
2820 const efi_guid_t *protocol, *next_protocol;
2821 void *protocol_interface;
2822 efi_status_t ret = EFI_SUCCESS;
2824 efi_va_list argptr_copy;
2827 return EFI_INVALID_PARAMETER;
2829 efi_va_copy(argptr_copy, argptr);
2830 protocol = efi_va_arg(argptr, efi_guid_t*);
2833 * If efi_uninstall_protocol() fails we need to be able to
2834 * reinstall the previously uninstalled protocols on the same
2836 * Instead of calling efi_uninstall_protocol(...,..., false)
2837 * and potentially removing the handle, only allow the handle
2838 * removal on the last protocol that we requested to uninstall.
2839 * That way we can preserve the handle in case the latter fails
2841 bool preserve = true;
2845 protocol_interface = efi_va_arg(argptr, void*);
2846 next_protocol = efi_va_arg(argptr, efi_guid_t*);
2849 ret = efi_uninstall_protocol(handle, protocol,
2850 protocol_interface, preserve);
2851 if (ret != EFI_SUCCESS)
2854 protocol = next_protocol;
2856 if (ret == EFI_SUCCESS)
2859 /* If an error occurred undo all changes. */
2861 protocol = efi_va_arg(argptr_copy, efi_guid_t*);
2862 protocol_interface = efi_va_arg(argptr_copy, void*);
2863 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2864 EFI_NATIVE_INTERFACE,
2865 protocol_interface));
2868 * If any errors are generated while the protocol interfaces are being
2869 * uninstalled, then the protocols uninstalled prior to the error will
2870 * be reinstalled using InstallProtocolInterface() and the status code
2871 * EFI_INVALID_PARAMETER is returned.
2873 ret = EFI_INVALID_PARAMETER;
2876 efi_va_end(argptr_copy);
2881 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2883 * @handle: handle from which the protocol interfaces shall be removed
2884 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2887 * This function implements the UninstallMultipleProtocolInterfaces service.
2889 * This is the function for internal usage in U-Boot. For the API function
2890 * implementing the UninstallMultipleProtocolInterfaces service see
2891 * efi_uninstall_multiple_protocol_interfaces_ext()
2893 * Return: status code
2896 efi_uninstall_multiple_protocol_interfaces(efi_handle_t handle, ...)
2901 efi_va_start(argptr, handle);
2902 ret = efi_uninstall_multiple_protocol_interfaces_int(handle, argptr);
2908 * efi_uninstall_multiple_protocol_interfaces_ext() - uninstall multiple protocol
2910 * @handle: handle from which the protocol interfaces shall be removed
2911 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2914 * This function implements the UninstallMultipleProtocolInterfaces service.
2916 * See the Unified Extensible Firmware Interface (UEFI) specification for
2919 * Return: status code
2921 static efi_status_t EFIAPI
2922 efi_uninstall_multiple_protocol_interfaces_ext(efi_handle_t handle, ...)
2924 EFI_ENTRY("%p", handle);
2928 efi_va_start(argptr, handle);
2929 ret = efi_uninstall_multiple_protocol_interfaces_int(handle, argptr);
2931 return EFI_EXIT(ret);
2935 * efi_calculate_crc32() - calculate cyclic redundancy code
2936 * @data: buffer with data
2937 * @data_size: size of buffer in bytes
2938 * @crc32_p: cyclic redundancy code
2940 * This function implements the CalculateCrc32 service.
2942 * See the Unified Extensible Firmware Interface (UEFI) specification for
2945 * Return: status code
2947 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2948 efi_uintn_t data_size,
2951 efi_status_t ret = EFI_SUCCESS;
2953 EFI_ENTRY("%p, %zu", data, data_size);
2954 if (!data || !data_size || !crc32_p) {
2955 ret = EFI_INVALID_PARAMETER;
2958 *crc32_p = crc32(0, data, data_size);
2960 return EFI_EXIT(ret);
2964 * efi_copy_mem() - copy memory
2965 * @destination: destination of the copy operation
2966 * @source: source of the copy operation
2967 * @length: number of bytes to copy
2969 * This function implements the CopyMem service.
2971 * See the Unified Extensible Firmware Interface (UEFI) specification for
2974 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2977 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2978 memmove(destination, source, length);
2979 EFI_EXIT(EFI_SUCCESS);
2983 * efi_set_mem() - Fill memory with a byte value.
2984 * @buffer: buffer to fill
2985 * @size: size of buffer in bytes
2986 * @value: byte to copy to the buffer
2988 * This function implements the SetMem service.
2990 * See the Unified Extensible Firmware Interface (UEFI) specification for
2993 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2995 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2996 memset(buffer, value, size);
2997 EFI_EXIT(EFI_SUCCESS);
3001 * efi_protocol_open() - open protocol interface on a handle
3002 * @handler: handler of a protocol
3003 * @protocol_interface: interface implementing the protocol
3004 * @agent_handle: handle of the driver
3005 * @controller_handle: handle of the controller
3006 * @attributes: attributes indicating how to open the protocol
3008 * Return: status code
3010 efi_status_t efi_protocol_open(
3011 struct efi_handler *handler,
3012 void **protocol_interface, void *agent_handle,
3013 void *controller_handle, uint32_t attributes)
3015 struct efi_open_protocol_info_item *item;
3016 struct efi_open_protocol_info_entry *match = NULL;
3017 bool opened_by_driver = false;
3018 bool opened_exclusive = false;
3020 /* If there is no agent, only return the interface */
3024 /* For TEST_PROTOCOL ignore interface attribute */
3025 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
3026 *protocol_interface = NULL;
3029 * Check if the protocol is already opened by a driver with the same
3030 * attributes or opened exclusively
3032 list_for_each_entry(item, &handler->open_infos, link) {
3033 if (item->info.agent_handle == agent_handle) {
3034 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
3035 (item->info.attributes == attributes))
3036 return EFI_ALREADY_STARTED;
3038 if (item->info.attributes &
3039 EFI_OPEN_PROTOCOL_BY_DRIVER)
3040 opened_by_driver = true;
3042 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
3043 opened_exclusive = true;
3046 /* Only one controller can open the protocol exclusively */
3047 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
3048 if (opened_exclusive)
3049 return EFI_ACCESS_DENIED;
3050 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
3051 if (opened_exclusive || opened_by_driver)
3052 return EFI_ACCESS_DENIED;
3055 /* Prepare exclusive opening */
3056 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
3057 /* Try to disconnect controllers */
3059 opened_by_driver = false;
3060 list_for_each_entry(item, &handler->open_infos, link) {
3063 if (item->info.attributes ==
3064 EFI_OPEN_PROTOCOL_BY_DRIVER) {
3065 ret = EFI_CALL(efi_disconnect_controller(
3066 item->info.controller_handle,
3067 item->info.agent_handle,
3069 if (ret == EFI_SUCCESS)
3071 * Child controllers may have been
3072 * removed from the open_infos list. So
3073 * let's restart the loop.
3075 goto disconnect_next;
3077 opened_by_driver = true;
3080 /* Only one driver can be connected */
3081 if (opened_by_driver)
3082 return EFI_ACCESS_DENIED;
3085 /* Find existing entry */
3086 list_for_each_entry(item, &handler->open_infos, link) {
3087 if (item->info.agent_handle == agent_handle &&
3088 item->info.controller_handle == controller_handle &&
3089 item->info.attributes == attributes)
3090 match = &item->info;
3092 /* None found, create one */
3094 match = efi_create_open_info(handler);
3096 return EFI_OUT_OF_RESOURCES;
3099 match->agent_handle = agent_handle;
3100 match->controller_handle = controller_handle;
3101 match->attributes = attributes;
3102 match->open_count++;
3105 /* For TEST_PROTOCOL ignore interface attribute. */
3106 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
3107 *protocol_interface = handler->protocol_interface;
3113 * efi_open_protocol() - open protocol interface on a handle
3114 * @handle: handle on which the protocol shall be opened
3115 * @protocol: GUID of the protocol
3116 * @protocol_interface: interface implementing the protocol
3117 * @agent_handle: handle of the driver
3118 * @controller_handle: handle of the controller
3119 * @attributes: attributes indicating how to open the protocol
3121 * This function implements the OpenProtocol interface.
3123 * See the Unified Extensible Firmware Interface (UEFI) specification for
3126 * Return: status code
3128 static efi_status_t EFIAPI efi_open_protocol
3129 (efi_handle_t handle, const efi_guid_t *protocol,
3130 void **protocol_interface, efi_handle_t agent_handle,
3131 efi_handle_t controller_handle, uint32_t attributes)
3133 struct efi_handler *handler;
3134 efi_status_t r = EFI_INVALID_PARAMETER;
3136 EFI_ENTRY("%p, %pUs, %p, %p, %p, 0x%x", handle, protocol,
3137 protocol_interface, agent_handle, controller_handle,
3140 if (!handle || !protocol ||
3141 (!protocol_interface && attributes !=
3142 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
3146 switch (attributes) {
3147 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
3148 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
3149 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
3151 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
3152 if (controller_handle == handle)
3155 case EFI_OPEN_PROTOCOL_BY_DRIVER:
3156 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
3157 /* Check that the controller handle is valid */
3158 if (!efi_search_obj(controller_handle))
3161 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
3162 /* Check that the agent handle is valid */
3163 if (!efi_search_obj(agent_handle))
3170 r = efi_search_protocol(handle, protocol, &handler);
3175 r = EFI_UNSUPPORTED;
3181 r = efi_protocol_open(handler, protocol_interface, agent_handle,
3182 controller_handle, attributes);
3188 * efi_start_image() - call the entry point of an image
3189 * @image_handle: handle of the image
3190 * @exit_data_size: size of the buffer
3191 * @exit_data: buffer to receive the exit data of the called image
3193 * This function implements the StartImage service.
3195 * See the Unified Extensible Firmware Interface (UEFI) specification for
3198 * Return: status code
3200 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
3201 efi_uintn_t *exit_data_size,
3204 struct efi_loaded_image_obj *image_obj =
3205 (struct efi_loaded_image_obj *)image_handle;
3208 efi_handle_t parent_image = current_image;
3209 efi_status_t exit_status;
3210 struct jmp_buf_data exit_jmp;
3212 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
3214 if (!efi_search_obj(image_handle))
3215 return EFI_EXIT(EFI_INVALID_PARAMETER);
3217 /* Check parameters */
3218 if (image_obj->header.type != EFI_OBJECT_TYPE_LOADED_IMAGE)
3219 return EFI_EXIT(EFI_INVALID_PARAMETER);
3221 if (image_obj->auth_status != EFI_IMAGE_AUTH_PASSED)
3222 return EFI_EXIT(EFI_SECURITY_VIOLATION);
3224 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3226 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3227 if (ret != EFI_SUCCESS)
3228 return EFI_EXIT(EFI_INVALID_PARAMETER);
3230 image_obj->exit_data_size = exit_data_size;
3231 image_obj->exit_data = exit_data;
3232 image_obj->exit_status = &exit_status;
3233 image_obj->exit_jmp = &exit_jmp;
3235 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3236 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3237 ret = efi_tcg2_measure_efi_app_invocation(image_obj);
3238 if (ret == EFI_SECURITY_VIOLATION) {
3240 * TCG2 Protocol is installed but no TPM device found,
3241 * this is not expected.
3243 return EFI_EXIT(EFI_SECURITY_VIOLATION);
3248 /* call the image! */
3249 if (setjmp(&exit_jmp)) {
3251 * We called the entry point of the child image with EFI_CALL
3252 * in the lines below. The child image called the Exit() boot
3253 * service efi_exit() which executed the long jump that brought
3254 * us to the current line. This implies that the second half
3255 * of the EFI_CALL macro has not been executed.
3257 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
3259 * efi_exit() called efi_restore_gd(). We have to undo this
3260 * otherwise __efi_entry_check() will put the wrong value into
3266 * To get ready to call EFI_EXIT below we have to execute the
3267 * missed out steps of EFI_CALL.
3269 assert(__efi_entry_check());
3270 EFI_PRINT("%lu returned by started image\n",
3271 (unsigned long)((uintptr_t)exit_status &
3273 current_image = parent_image;
3274 return EFI_EXIT(exit_status);
3277 current_image = image_handle;
3278 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
3279 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
3280 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
3283 * Control is returned from a started UEFI image either by calling
3284 * Exit() (where exit data can be provided) or by simply returning from
3285 * the entry point. In the latter case call Exit() on behalf of the
3288 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
3292 * efi_delete_image() - delete loaded image from memory)
3294 * @image_obj: handle of the loaded image
3295 * @loaded_image_protocol: loaded image protocol
3297 static efi_status_t efi_delete_image
3298 (struct efi_loaded_image_obj *image_obj,
3299 struct efi_loaded_image *loaded_image_protocol)
3301 struct efi_object *efiobj;
3302 efi_status_t r, ret = EFI_SUCCESS;
3305 list_for_each_entry(efiobj, &efi_obj_list, link) {
3306 struct efi_handler *protocol;
3308 list_for_each_entry(protocol, &efiobj->protocols, link) {
3309 struct efi_open_protocol_info_item *info;
3311 list_for_each_entry(info, &protocol->open_infos, link) {
3312 if (info->info.agent_handle !=
3313 (efi_handle_t)image_obj)
3315 r = efi_close_protocol(
3316 efiobj, &protocol->guid,
3317 info->info.agent_handle,
3318 info->info.controller_handle);
3319 if (r != EFI_SUCCESS)
3322 * Closing protocols may results in further
3323 * items being deleted. To play it safe loop
3324 * over all elements again.
3331 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
3332 efi_size_in_pages(loaded_image_protocol->image_size));
3333 efi_delete_handle(&image_obj->header);
3339 * efi_unload_image() - unload an EFI image
3340 * @image_handle: handle of the image to be unloaded
3342 * This function implements the UnloadImage service.
3344 * See the Unified Extensible Firmware Interface (UEFI) specification for
3347 * Return: status code
3349 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
3351 efi_status_t ret = EFI_SUCCESS;
3352 struct efi_object *efiobj;
3353 struct efi_loaded_image *loaded_image_protocol;
3355 EFI_ENTRY("%p", image_handle);
3357 efiobj = efi_search_obj(image_handle);
3359 ret = EFI_INVALID_PARAMETER;
3362 /* Find the loaded image protocol */
3363 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3364 (void **)&loaded_image_protocol,
3366 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3367 if (ret != EFI_SUCCESS) {
3368 ret = EFI_INVALID_PARAMETER;
3371 switch (efiobj->type) {
3372 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3373 /* Call the unload function */
3374 if (!loaded_image_protocol->unload) {
3375 ret = EFI_UNSUPPORTED;
3378 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
3379 if (ret != EFI_SUCCESS)
3382 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3385 ret = EFI_INVALID_PARAMETER;
3388 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
3389 loaded_image_protocol);
3391 return EFI_EXIT(ret);
3395 * efi_update_exit_data() - fill exit data parameters of StartImage()
3397 * @image_obj: image handle
3398 * @exit_data_size: size of the exit data buffer
3399 * @exit_data: buffer with data returned by UEFI payload
3400 * Return: status code
3402 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
3403 efi_uintn_t exit_data_size,
3409 * If exit_data is not provided to StartImage(), exit_data_size must be
3412 if (!image_obj->exit_data)
3414 if (image_obj->exit_data_size)
3415 *image_obj->exit_data_size = exit_data_size;
3416 if (exit_data_size && exit_data) {
3417 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3419 (void **)image_obj->exit_data);
3420 if (ret != EFI_SUCCESS)
3422 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3424 image_obj->exit_data = NULL;
3430 * efi_exit() - leave an EFI application or driver
3431 * @image_handle: handle of the application or driver that is exiting
3432 * @exit_status: status code
3433 * @exit_data_size: size of the buffer in bytes
3434 * @exit_data: buffer with data describing an error
3436 * This function implements the Exit service.
3438 * See the Unified Extensible Firmware Interface (UEFI) specification for
3441 * Return: status code
3443 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3444 efi_status_t exit_status,
3445 efi_uintn_t exit_data_size,
3449 * TODO: We should call the unload procedure of the loaded
3453 struct efi_loaded_image *loaded_image_protocol;
3454 struct efi_loaded_image_obj *image_obj =
3455 (struct efi_loaded_image_obj *)image_handle;
3456 struct jmp_buf_data *exit_jmp;
3458 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3459 exit_data_size, exit_data);
3461 /* Check parameters */
3462 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3463 (void **)&loaded_image_protocol,
3465 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3466 if (ret != EFI_SUCCESS) {
3467 ret = EFI_INVALID_PARAMETER;
3471 /* Unloading of unstarted images */
3472 switch (image_obj->header.type) {
3473 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3475 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3476 efi_delete_image(image_obj, loaded_image_protocol);
3480 /* Handle does not refer to loaded image */
3481 ret = EFI_INVALID_PARAMETER;
3484 /* A started image can only be unloaded it is the last one started. */
3485 if (image_handle != current_image) {
3486 ret = EFI_INVALID_PARAMETER;
3490 /* Exit data is only foreseen in case of failure. */
3491 if (exit_status != EFI_SUCCESS) {
3492 ret = efi_update_exit_data(image_obj, exit_data_size,
3494 /* Exiting has priority. Don't return error to caller. */
3495 if (ret != EFI_SUCCESS)
3496 EFI_PRINT("%s: out of memory\n", __func__);
3498 /* efi_delete_image() frees image_obj. Copy before the call. */
3499 exit_jmp = image_obj->exit_jmp;
3500 *image_obj->exit_status = exit_status;
3501 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3502 exit_status != EFI_SUCCESS)
3503 efi_delete_image(image_obj, loaded_image_protocol);
3505 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3506 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3507 ret = efi_tcg2_measure_efi_app_exit();
3508 if (ret != EFI_SUCCESS) {
3509 log_warning("tcg2 measurement fails(0x%lx)\n",
3515 /* Make sure entry/exit counts for EFI world cross-overs match */
3516 EFI_EXIT(exit_status);
3519 * But longjmp out with the U-Boot gd, not the application's, as
3520 * the other end is a setjmp call inside EFI context.
3524 longjmp(exit_jmp, 1);
3526 panic("EFI application exited");
3528 return EFI_EXIT(ret);
3532 * efi_handle_protocol() - get interface of a protocol on a handle
3533 * @handle: handle on which the protocol shall be opened
3534 * @protocol: GUID of the protocol
3535 * @protocol_interface: interface implementing the protocol
3537 * This function implements the HandleProtocol service.
3539 * See the Unified Extensible Firmware Interface (UEFI) specification for
3542 * Return: status code
3544 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
3545 const efi_guid_t *protocol,
3546 void **protocol_interface)
3548 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
3549 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
3553 * efi_bind_controller() - bind a single driver to a controller
3554 * @controller_handle: controller handle
3555 * @driver_image_handle: driver handle
3556 * @remain_device_path: remaining path
3558 * Return: status code
3560 static efi_status_t efi_bind_controller(
3561 efi_handle_t controller_handle,
3562 efi_handle_t driver_image_handle,
3563 struct efi_device_path *remain_device_path)
3565 struct efi_driver_binding_protocol *binding_protocol;
3568 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3569 &efi_guid_driver_binding_protocol,
3570 (void **)&binding_protocol,
3571 driver_image_handle, NULL,
3572 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3573 if (r != EFI_SUCCESS)
3575 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3577 remain_device_path));
3578 if (r == EFI_SUCCESS)
3579 r = EFI_CALL(binding_protocol->start(binding_protocol,
3581 remain_device_path));
3582 efi_close_protocol(driver_image_handle,
3583 &efi_guid_driver_binding_protocol,
3584 driver_image_handle, NULL);
3589 * efi_connect_single_controller() - connect a single driver to a controller
3590 * @controller_handle: controller
3591 * @driver_image_handle: driver
3592 * @remain_device_path: remaining path
3594 * Return: status code
3596 static efi_status_t efi_connect_single_controller(
3597 efi_handle_t controller_handle,
3598 efi_handle_t *driver_image_handle,
3599 struct efi_device_path *remain_device_path)
3601 efi_handle_t *buffer;
3605 size_t connected = 0;
3607 /* Get buffer with all handles with driver binding protocol */
3608 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3609 &efi_guid_driver_binding_protocol,
3610 NULL, &count, &buffer));
3611 if (r != EFI_SUCCESS)
3614 /* Context Override */
3615 if (driver_image_handle) {
3616 for (; *driver_image_handle; ++driver_image_handle) {
3617 for (i = 0; i < count; ++i) {
3618 if (buffer[i] == *driver_image_handle) {
3620 r = efi_bind_controller(
3622 *driver_image_handle,
3623 remain_device_path);
3625 * For drivers that do not support the
3626 * controller or are already connected
3627 * we receive an error code here.
3629 if (r == EFI_SUCCESS)
3637 * TODO: Some overrides are not yet implemented:
3638 * - Platform Driver Override
3639 * - Driver Family Override Search
3640 * - Bus Specific Driver Override
3643 /* Driver Binding Search */
3644 for (i = 0; i < count; ++i) {
3646 r = efi_bind_controller(controller_handle,
3648 remain_device_path);
3649 if (r == EFI_SUCCESS)
3654 efi_free_pool(buffer);
3656 return EFI_NOT_FOUND;
3661 * efi_connect_controller() - connect a controller to a driver
3662 * @controller_handle: handle of the controller
3663 * @driver_image_handle: handle of the driver
3664 * @remain_device_path: device path of a child controller
3665 * @recursive: true to connect all child controllers
3667 * This function implements the ConnectController service.
3669 * See the Unified Extensible Firmware Interface (UEFI) specification for
3672 * First all driver binding protocol handles are tried for binding drivers.
3673 * Afterwards all handles that have opened a protocol of the controller
3674 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3676 * Return: status code
3678 static efi_status_t EFIAPI efi_connect_controller(
3679 efi_handle_t controller_handle,
3680 efi_handle_t *driver_image_handle,
3681 struct efi_device_path *remain_device_path,
3685 efi_status_t ret = EFI_NOT_FOUND;
3686 struct efi_object *efiobj;
3688 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3689 remain_device_path, recursive);
3691 efiobj = efi_search_obj(controller_handle);
3693 ret = EFI_INVALID_PARAMETER;
3697 r = efi_connect_single_controller(controller_handle,
3698 driver_image_handle,
3699 remain_device_path);
3700 if (r == EFI_SUCCESS)
3703 struct efi_handler *handler;
3704 struct efi_open_protocol_info_item *item;
3706 list_for_each_entry(handler, &efiobj->protocols, link) {
3707 list_for_each_entry(item, &handler->open_infos, link) {
3708 if (item->info.attributes &
3709 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3710 r = EFI_CALL(efi_connect_controller(
3711 item->info.controller_handle,
3712 driver_image_handle,
3715 if (r == EFI_SUCCESS)
3721 /* Check for child controller specified by end node */
3722 if (ret != EFI_SUCCESS && remain_device_path &&
3723 remain_device_path->type == DEVICE_PATH_TYPE_END)
3726 return EFI_EXIT(ret);
3730 * efi_reinstall_protocol_interface() - reinstall protocol interface
3731 * @handle: handle on which the protocol shall be reinstalled
3732 * @protocol: GUID of the protocol to be installed
3733 * @old_interface: interface to be removed
3734 * @new_interface: interface to be installed
3736 * This function implements the ReinstallProtocolInterface service.
3738 * See the Unified Extensible Firmware Interface (UEFI) specification for
3741 * The old interface is uninstalled. The new interface is installed.
3742 * Drivers are connected.
3744 * Return: status code
3746 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3747 efi_handle_t handle, const efi_guid_t *protocol,
3748 void *old_interface, void *new_interface)
3752 EFI_ENTRY("%p, %pUs, %p, %p", handle, protocol, old_interface,
3755 /* Uninstall protocol but do not delete handle */
3756 ret = efi_uninstall_protocol(handle, protocol, old_interface, true);
3757 if (ret != EFI_SUCCESS)
3760 /* Install the new protocol */
3761 ret = efi_add_protocol(handle, protocol, new_interface);
3763 * The UEFI spec does not specify what should happen to the handle
3764 * if in case of an error no protocol interface remains on the handle.
3765 * So let's do nothing here.
3767 if (ret != EFI_SUCCESS)
3770 * The returned status code has to be ignored.
3771 * Do not create an error if no suitable driver for the handle exists.
3773 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3775 return EFI_EXIT(ret);
3779 * efi_get_child_controllers() - get all child controllers associated to a driver
3780 * @efiobj: handle of the controller
3781 * @driver_handle: handle of the driver
3782 * @number_of_children: number of child controllers
3783 * @child_handle_buffer: handles of the the child controllers
3785 * The allocated buffer has to be freed with free().
3787 * Return: status code
3789 static efi_status_t efi_get_child_controllers(
3790 struct efi_object *efiobj,
3791 efi_handle_t driver_handle,
3792 efi_uintn_t *number_of_children,
3793 efi_handle_t **child_handle_buffer)
3795 struct efi_handler *handler;
3796 struct efi_open_protocol_info_item *item;
3797 efi_uintn_t count = 0, i;
3800 /* Count all child controller associations */
3801 list_for_each_entry(handler, &efiobj->protocols, link) {
3802 list_for_each_entry(item, &handler->open_infos, link) {
3803 if (item->info.agent_handle == driver_handle &&
3804 item->info.attributes &
3805 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3810 * Create buffer. In case of duplicate child controller assignments
3811 * the buffer will be too large. But that does not harm.
3813 *number_of_children = 0;
3816 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3817 if (!*child_handle_buffer)
3818 return EFI_OUT_OF_RESOURCES;
3819 /* Copy unique child handles */
3820 list_for_each_entry(handler, &efiobj->protocols, link) {
3821 list_for_each_entry(item, &handler->open_infos, link) {
3822 if (item->info.agent_handle == driver_handle &&
3823 item->info.attributes &
3824 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3825 /* Check this is a new child controller */
3827 for (i = 0; i < *number_of_children; ++i) {
3828 if ((*child_handle_buffer)[i] ==
3829 item->info.controller_handle)
3832 /* Copy handle to buffer */
3834 i = (*number_of_children)++;
3835 (*child_handle_buffer)[i] =
3836 item->info.controller_handle;
3845 * efi_disconnect_controller() - disconnect a controller from a driver
3846 * @controller_handle: handle of the controller
3847 * @driver_image_handle: handle of the driver
3848 * @child_handle: handle of the child to destroy
3850 * This function implements the DisconnectController service.
3852 * See the Unified Extensible Firmware Interface (UEFI) specification for
3855 * Return: status code
3857 static efi_status_t EFIAPI efi_disconnect_controller(
3858 efi_handle_t controller_handle,
3859 efi_handle_t driver_image_handle,
3860 efi_handle_t child_handle)
3862 struct efi_driver_binding_protocol *binding_protocol;
3863 efi_handle_t *child_handle_buffer = NULL;
3864 size_t number_of_children = 0;
3866 struct efi_object *efiobj;
3869 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3872 efiobj = efi_search_obj(controller_handle);
3874 r = EFI_INVALID_PARAMETER;
3878 if (child_handle && !efi_search_obj(child_handle)) {
3879 r = EFI_INVALID_PARAMETER;
3883 /* If no driver handle is supplied, disconnect all drivers */
3884 if (!driver_image_handle) {
3885 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3889 /* Create list of child handles */
3890 r = efi_get_child_controllers(efiobj,
3891 driver_image_handle,
3892 &number_of_children,
3893 &child_handle_buffer);
3894 if (r != EFI_SUCCESS)
3896 sole_child = (number_of_children == 1);
3899 number_of_children = 1;
3900 free(child_handle_buffer);
3901 child_handle_buffer = &child_handle;
3904 /* Get the driver binding protocol */
3905 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3906 &efi_guid_driver_binding_protocol,
3907 (void **)&binding_protocol,
3908 driver_image_handle, NULL,
3909 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3910 if (r != EFI_SUCCESS) {
3911 r = EFI_INVALID_PARAMETER;
3914 /* Remove the children */
3915 if (number_of_children) {
3916 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3919 child_handle_buffer));
3920 if (r != EFI_SUCCESS) {
3921 r = EFI_DEVICE_ERROR;
3925 /* Remove the driver */
3926 if (!child_handle || sole_child) {
3927 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3930 if (r != EFI_SUCCESS) {
3931 r = EFI_DEVICE_ERROR;
3935 efi_close_protocol(driver_image_handle,
3936 &efi_guid_driver_binding_protocol,
3937 driver_image_handle, NULL);
3941 free(child_handle_buffer);
3945 static struct efi_boot_services efi_boot_services = {
3947 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3948 .revision = EFI_SPECIFICATION_VERSION,
3949 .headersize = sizeof(struct efi_boot_services),
3951 .raise_tpl = efi_raise_tpl,
3952 .restore_tpl = efi_restore_tpl,
3953 .allocate_pages = efi_allocate_pages_ext,
3954 .free_pages = efi_free_pages_ext,
3955 .get_memory_map = efi_get_memory_map_ext,
3956 .allocate_pool = efi_allocate_pool_ext,
3957 .free_pool = efi_free_pool_ext,
3958 .create_event = efi_create_event_ext,
3959 .set_timer = efi_set_timer_ext,
3960 .wait_for_event = efi_wait_for_event,
3961 .signal_event = efi_signal_event_ext,
3962 .close_event = efi_close_event,
3963 .check_event = efi_check_event,
3964 .install_protocol_interface = efi_install_protocol_interface,
3965 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3966 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3967 .handle_protocol = efi_handle_protocol,
3969 .register_protocol_notify = efi_register_protocol_notify,
3970 .locate_handle = efi_locate_handle_ext,
3971 .locate_device_path = efi_locate_device_path,
3972 .install_configuration_table = efi_install_configuration_table_ext,
3973 .load_image = efi_load_image,
3974 .start_image = efi_start_image,
3976 .unload_image = efi_unload_image,
3977 .exit_boot_services = efi_exit_boot_services,
3978 .get_next_monotonic_count = efi_get_next_monotonic_count,
3980 .set_watchdog_timer = efi_set_watchdog_timer,
3981 .connect_controller = efi_connect_controller,
3982 .disconnect_controller = efi_disconnect_controller,
3983 .open_protocol = efi_open_protocol,
3984 .close_protocol = efi_close_protocol_ext,
3985 .open_protocol_information = efi_open_protocol_information,
3986 .protocols_per_handle = efi_protocols_per_handle,
3987 .locate_handle_buffer = efi_locate_handle_buffer,
3988 .locate_protocol = efi_locate_protocol,
3989 .install_multiple_protocol_interfaces =
3990 efi_install_multiple_protocol_interfaces_ext,
3991 .uninstall_multiple_protocol_interfaces =
3992 efi_uninstall_multiple_protocol_interfaces_ext,
3993 .calculate_crc32 = efi_calculate_crc32,
3994 .copy_mem = efi_copy_mem,
3995 .set_mem = efi_set_mem,
3996 .create_event_ex = efi_create_event_ex,
3999 static u16 __efi_runtime_data firmware_vendor[] = u"Das U-Boot";
4001 struct efi_system_table __efi_runtime_data systab = {
4003 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
4004 .revision = EFI_SPECIFICATION_VERSION,
4005 .headersize = sizeof(struct efi_system_table),
4007 .fw_vendor = firmware_vendor,
4008 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
4009 .runtime = &efi_runtime_services,
4015 * efi_initialize_system_table() - Initialize system table
4017 * Return: status code
4019 efi_status_t efi_initialize_system_table(void)
4023 /* Allocate configuration table array */
4024 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
4025 EFI_MAX_CONFIGURATION_TABLES *
4026 sizeof(struct efi_configuration_table),
4027 (void **)&systab.tables);
4030 * These entries will be set to NULL in ExitBootServices(). To avoid
4031 * relocation in SetVirtualAddressMap(), set them dynamically.
4033 systab.con_in_handle = efi_root;
4034 systab.con_in = &efi_con_in;
4035 systab.con_out_handle = efi_root;
4036 systab.con_out = &efi_con_out;
4037 systab.stderr_handle = efi_root;
4038 systab.std_err = &efi_con_out;
4039 systab.boottime = &efi_boot_services;
4041 /* Set CRC32 field in table headers */
4042 efi_update_table_header_crc32(&systab.hdr);
4043 efi_update_table_header_crc32(&efi_runtime_services.hdr);
4044 efi_update_table_header_crc32(&efi_boot_services.hdr);