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 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 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 /* 1 if inside U-Boot code, 0 if inside EFI payload code */
63 static int entry_count = 1;
64 static int nesting_level;
65 /* GUID of the device tree table */
66 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
67 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
68 const efi_guid_t efi_guid_driver_binding_protocol =
69 EFI_DRIVER_BINDING_PROTOCOL_GUID;
71 /* event group ExitBootServices() invoked */
72 const efi_guid_t efi_guid_event_group_exit_boot_services =
73 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
74 /* event group before ExitBootServices() invoked */
75 const efi_guid_t efi_guid_event_group_before_exit_boot_services =
76 EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES;
77 /* event group SetVirtualAddressMap() invoked */
78 const efi_guid_t efi_guid_event_group_virtual_address_change =
79 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
80 /* event group memory map changed */
81 const efi_guid_t efi_guid_event_group_memory_map_change =
82 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
83 /* event group boot manager about to boot */
84 const efi_guid_t efi_guid_event_group_ready_to_boot =
85 EFI_EVENT_GROUP_READY_TO_BOOT;
86 /* event group ResetSystem() invoked (before ExitBootServices) */
87 const efi_guid_t efi_guid_event_group_reset_system =
88 EFI_EVENT_GROUP_RESET_SYSTEM;
89 /* GUIDs of the Load File and Load File2 protocols */
90 const efi_guid_t efi_guid_load_file_protocol = EFI_LOAD_FILE_PROTOCOL_GUID;
91 const efi_guid_t efi_guid_load_file2_protocol = EFI_LOAD_FILE2_PROTOCOL_GUID;
92 /* GUID of the SMBIOS table */
93 const efi_guid_t smbios_guid = SMBIOS_TABLE_GUID;
95 static efi_status_t EFIAPI efi_disconnect_controller(
96 efi_handle_t controller_handle,
97 efi_handle_t driver_image_handle,
98 efi_handle_t child_handle);
100 /* Called on every callback entry */
101 int __efi_entry_check(void)
103 int ret = entry_count++ == 0;
104 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
112 /* Called on every callback exit */
113 int __efi_exit_check(void)
115 int ret = --entry_count == 0;
116 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
123 * efi_save_gd() - save global data register
125 * On the ARM and RISC-V architectures gd is mapped to a fixed register.
126 * As this register may be overwritten by an EFI payload we save it here
127 * and restore it on every callback entered.
129 * This function is called after relocation from initr_reloc_global_data().
131 void efi_save_gd(void)
133 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
139 * efi_restore_gd() - restore global data register
141 * On the ARM and RISC-V architectures gd is mapped to a fixed register.
142 * Restore it after returning from the UEFI world to the value saved via
145 void efi_restore_gd(void)
147 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
148 /* Only restore if we're already in EFI context */
156 * indent_string() - returns a string for indenting with two spaces per level
157 * @level: indent level
159 * A maximum of ten indent levels is supported. Higher indent levels will be
162 * Return: A string for indenting with two spaces per level is
165 static const char *indent_string(int level)
167 const char *indent = " ";
168 const int max = strlen(indent);
170 level = min(max, level * 2);
171 return &indent[max - level];
174 const char *__efi_nesting(void)
176 return indent_string(nesting_level);
179 const char *__efi_nesting_inc(void)
181 return indent_string(nesting_level++);
184 const char *__efi_nesting_dec(void)
186 return indent_string(--nesting_level);
190 * efi_event_is_queued() - check if an event is queued
193 * Return: true if event is queued
195 static bool efi_event_is_queued(struct efi_event *event)
197 return !!event->queue_link.next;
201 * efi_process_event_queue() - process event queue
203 static void efi_process_event_queue(void)
205 while (!list_empty(&efi_event_queue)) {
206 struct efi_event *event;
209 event = list_first_entry(&efi_event_queue, struct efi_event,
211 if (efi_tpl >= event->notify_tpl)
213 list_del(&event->queue_link);
214 event->queue_link.next = NULL;
215 event->queue_link.prev = NULL;
216 /* Events must be executed at the event's TPL */
218 efi_tpl = event->notify_tpl;
219 EFI_CALL_VOID(event->notify_function(event,
220 event->notify_context));
222 if (event->type == EVT_NOTIFY_SIGNAL)
223 event->is_signaled = 0;
228 * efi_queue_event() - queue an EFI event
229 * @event: event to signal
231 * This function queues the notification function of the event for future
235 static void efi_queue_event(struct efi_event *event)
237 struct efi_event *item;
239 if (!event->notify_function)
242 if (!efi_event_is_queued(event)) {
244 * Events must be notified in order of decreasing task priority
245 * level. Insert the new event accordingly.
247 list_for_each_entry(item, &efi_event_queue, queue_link) {
248 if (item->notify_tpl < event->notify_tpl) {
249 list_add_tail(&event->queue_link,
256 list_add_tail(&event->queue_link, &efi_event_queue);
257 efi_process_event_queue();
262 * is_valid_tpl() - check if the task priority level is valid
264 * @tpl: TPL level to check
265 * Return: status code
267 efi_status_t is_valid_tpl(efi_uintn_t tpl)
270 case TPL_APPLICATION:
275 return EFI_INVALID_PARAMETER;
280 * efi_signal_event() - signal an EFI event
281 * @event: event to signal
283 * This function signals an event. If the event belongs to an event group, all
284 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL,
285 * their notification function is queued.
287 * For the SignalEvent service see efi_signal_event_ext.
289 void efi_signal_event(struct efi_event *event)
291 if (event->is_signaled)
294 struct efi_event *evt;
297 * The signaled state has to set before executing any
298 * notification function
300 list_for_each_entry(evt, &efi_events, link) {
301 if (!evt->group || guidcmp(evt->group, event->group))
303 if (evt->is_signaled)
305 evt->is_signaled = true;
307 list_for_each_entry(evt, &efi_events, link) {
308 if (!evt->group || guidcmp(evt->group, event->group))
310 efi_queue_event(evt);
313 event->is_signaled = true;
314 efi_queue_event(event);
319 * efi_raise_tpl() - raise the task priority level
320 * @new_tpl: new value of the task priority level
322 * This function implements the RaiseTpl service.
324 * See the Unified Extensible Firmware Interface (UEFI) specification for
327 * Return: old value of the task priority level
329 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
331 efi_uintn_t old_tpl = efi_tpl;
333 EFI_ENTRY("0x%zx", new_tpl);
335 if (new_tpl < efi_tpl)
336 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
338 if (efi_tpl > TPL_HIGH_LEVEL)
339 efi_tpl = TPL_HIGH_LEVEL;
341 EFI_EXIT(EFI_SUCCESS);
346 * efi_restore_tpl() - lower the task priority level
347 * @old_tpl: value of the task priority level to be restored
349 * This function implements the RestoreTpl service.
351 * See the Unified Extensible Firmware Interface (UEFI) specification for
354 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
356 EFI_ENTRY("0x%zx", old_tpl);
358 if (old_tpl > efi_tpl)
359 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
361 if (efi_tpl > TPL_HIGH_LEVEL)
362 efi_tpl = TPL_HIGH_LEVEL;
365 * Lowering the TPL may have made queued events eligible for execution.
369 EFI_EXIT(EFI_SUCCESS);
373 * efi_allocate_pages_ext() - allocate memory pages
374 * @type: type of allocation to be performed
375 * @memory_type: usage type of the allocated memory
376 * @pages: number of pages to be allocated
377 * @memory: allocated memory
379 * This function implements the AllocatePages service.
381 * See the Unified Extensible Firmware Interface (UEFI) specification for
384 * Return: status code
386 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
392 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
393 r = efi_allocate_pages(type, memory_type, pages, memory);
398 * efi_free_pages_ext() - Free memory pages.
399 * @memory: start of the memory area to be freed
400 * @pages: number of pages to be freed
402 * This function implements the FreePages service.
404 * See the Unified Extensible Firmware Interface (UEFI) specification for
407 * Return: status code
409 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
414 EFI_ENTRY("%llx, 0x%zx", memory, pages);
415 r = efi_free_pages(memory, pages);
420 * efi_get_memory_map_ext() - get map describing memory usage
421 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
422 * on exit the size of the copied memory map
423 * @memory_map: buffer to which the memory map is written
424 * @map_key: key for the memory map
425 * @descriptor_size: size of an individual memory descriptor
426 * @descriptor_version: version number of the memory descriptor structure
428 * This function implements the GetMemoryMap service.
430 * See the Unified Extensible Firmware Interface (UEFI) specification for
433 * Return: status code
435 static efi_status_t EFIAPI efi_get_memory_map_ext(
436 efi_uintn_t *memory_map_size,
437 struct efi_mem_desc *memory_map,
438 efi_uintn_t *map_key,
439 efi_uintn_t *descriptor_size,
440 uint32_t *descriptor_version)
444 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
445 map_key, descriptor_size, descriptor_version);
446 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
447 descriptor_size, descriptor_version);
452 * efi_allocate_pool_ext() - allocate memory from pool
453 * @pool_type: type of the pool from which memory is to be allocated
454 * @size: number of bytes to be allocated
455 * @buffer: allocated memory
457 * This function implements the AllocatePool service.
459 * See the Unified Extensible Firmware Interface (UEFI) specification for
462 * Return: status code
464 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
470 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
471 r = efi_allocate_pool(pool_type, size, buffer);
476 * efi_free_pool_ext() - free memory from pool
477 * @buffer: start of memory to be freed
479 * This function implements the FreePool service.
481 * See the Unified Extensible Firmware Interface (UEFI) specification for
484 * Return: status code
486 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
490 EFI_ENTRY("%p", buffer);
491 r = efi_free_pool(buffer);
496 * efi_add_handle() - add a new handle to the object list
498 * @handle: handle to be added
500 * The protocols list is initialized. The handle is added to the list of known
503 void efi_add_handle(efi_handle_t handle)
507 INIT_LIST_HEAD(&handle->protocols);
508 list_add_tail(&handle->link, &efi_obj_list);
512 * efi_create_handle() - create handle
513 * @handle: new handle
515 * Return: status code
517 efi_status_t efi_create_handle(efi_handle_t *handle)
519 struct efi_object *obj;
521 obj = calloc(1, sizeof(struct efi_object));
523 return EFI_OUT_OF_RESOURCES;
532 * efi_search_protocol() - find a protocol on a handle.
534 * @protocol_guid: GUID of the protocol
535 * @handler: reference to the protocol
537 * Return: status code
539 efi_status_t efi_search_protocol(const efi_handle_t handle,
540 const efi_guid_t *protocol_guid,
541 struct efi_handler **handler)
543 struct efi_object *efiobj;
544 struct list_head *lhandle;
546 if (!handle || !protocol_guid)
547 return EFI_INVALID_PARAMETER;
548 efiobj = efi_search_obj(handle);
550 return EFI_INVALID_PARAMETER;
551 list_for_each(lhandle, &efiobj->protocols) {
552 struct efi_handler *protocol;
554 protocol = list_entry(lhandle, struct efi_handler, link);
555 if (!guidcmp(protocol->guid, protocol_guid)) {
561 return EFI_NOT_FOUND;
565 * efi_remove_protocol() - delete protocol from a handle
566 * @handle: handle from which the protocol shall be deleted
567 * @protocol: GUID of the protocol to be deleted
568 * @protocol_interface: interface of the protocol implementation
570 * Return: status code
572 efi_status_t efi_remove_protocol(const efi_handle_t handle,
573 const efi_guid_t *protocol,
574 void *protocol_interface)
576 struct efi_handler *handler;
579 ret = efi_search_protocol(handle, protocol, &handler);
580 if (ret != EFI_SUCCESS)
582 if (handler->protocol_interface != protocol_interface)
583 return EFI_NOT_FOUND;
584 list_del(&handler->link);
590 * efi_remove_all_protocols() - delete all protocols from a handle
591 * @handle: handle from which the protocols shall be deleted
593 * Return: status code
595 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
597 struct efi_object *efiobj;
598 struct efi_handler *protocol;
599 struct efi_handler *pos;
601 efiobj = efi_search_obj(handle);
603 return EFI_INVALID_PARAMETER;
604 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
607 ret = efi_remove_protocol(handle, protocol->guid,
608 protocol->protocol_interface);
609 if (ret != EFI_SUCCESS)
616 * efi_delete_handle() - delete handle
618 * @handle: handle to delete
620 void efi_delete_handle(efi_handle_t handle)
624 efi_remove_all_protocols(handle);
625 list_del(&handle->link);
630 * efi_is_event() - check if a pointer is a valid event
631 * @event: pointer to check
633 * Return: status code
635 static efi_status_t efi_is_event(const struct efi_event *event)
637 const struct efi_event *evt;
640 return EFI_INVALID_PARAMETER;
641 list_for_each_entry(evt, &efi_events, link) {
645 return EFI_INVALID_PARAMETER;
649 * efi_create_event() - create an event
651 * @type: type of the event to create
652 * @notify_tpl: task priority level of the event
653 * @notify_function: notification function of the event
654 * @notify_context: pointer passed to the notification function
655 * @group: event group
656 * @event: created event
658 * This function is used inside U-Boot code to create an event.
660 * For the API function implementing the CreateEvent service see
661 * efi_create_event_ext.
663 * Return: status code
665 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
666 void (EFIAPI *notify_function) (
667 struct efi_event *event,
669 void *notify_context, efi_guid_t *group,
670 struct efi_event **event)
672 struct efi_event *evt;
677 return EFI_INVALID_PARAMETER;
682 case EVT_NOTIFY_SIGNAL:
683 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
684 case EVT_NOTIFY_WAIT:
685 case EVT_TIMER | EVT_NOTIFY_WAIT:
686 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
687 pool_type = EFI_BOOT_SERVICES_DATA;
689 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
690 pool_type = EFI_RUNTIME_SERVICES_DATA;
693 return EFI_INVALID_PARAMETER;
697 * The UEFI specification requires event notification levels to be
698 * > TPL_APPLICATION and <= TPL_HIGH_LEVEL.
700 * Parameter NotifyTpl should not be checked if it is not used.
702 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
703 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS ||
704 notify_tpl == TPL_APPLICATION))
705 return EFI_INVALID_PARAMETER;
707 ret = efi_allocate_pool(pool_type, sizeof(struct efi_event),
709 if (ret != EFI_SUCCESS)
711 memset(evt, 0, sizeof(struct efi_event));
713 evt->notify_tpl = notify_tpl;
714 evt->notify_function = notify_function;
715 evt->notify_context = notify_context;
717 /* Disable timers on boot up */
718 evt->trigger_next = -1ULL;
719 list_add_tail(&evt->link, &efi_events);
725 * efi_create_event_ex() - create an event in a group
726 * @type: type of the event to create
727 * @notify_tpl: task priority level of the event
728 * @notify_function: notification function of the event
729 * @notify_context: pointer passed to the notification function
730 * @event: created event
731 * @event_group: event group
733 * This function implements the CreateEventEx service.
735 * See the Unified Extensible Firmware Interface (UEFI) specification for
738 * Return: status code
740 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
741 void (EFIAPI *notify_function) (
742 struct efi_event *event,
744 void *notify_context,
745 efi_guid_t *event_group,
746 struct efi_event **event)
750 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
751 notify_context, event_group);
754 * The allowable input parameters are the same as in CreateEvent()
755 * except for the following two disallowed event types.
758 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
759 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
760 ret = EFI_INVALID_PARAMETER;
764 ret = efi_create_event(type, notify_tpl, notify_function,
765 notify_context, event_group, event);
767 return EFI_EXIT(ret);
771 * efi_create_event_ext() - create an event
772 * @type: type of the event to create
773 * @notify_tpl: task priority level of the event
774 * @notify_function: notification function of the event
775 * @notify_context: pointer passed to the notification function
776 * @event: created event
778 * This function implements the CreateEvent service.
780 * See the Unified Extensible Firmware Interface (UEFI) specification for
783 * Return: status code
785 static efi_status_t EFIAPI efi_create_event_ext(
786 uint32_t type, efi_uintn_t notify_tpl,
787 void (EFIAPI *notify_function) (
788 struct efi_event *event,
790 void *notify_context, struct efi_event **event)
792 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
794 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
795 notify_context, NULL, event));
799 * efi_timer_check() - check if a timer event has occurred
801 * Check if a timer event has occurred or a queued notification function should
804 * Our timers have to work without interrupts, so we check whenever keyboard
805 * input or disk accesses happen if enough time elapsed for them to fire.
807 void efi_timer_check(void)
809 struct efi_event *evt;
810 u64 now = timer_get_us();
812 list_for_each_entry(evt, &efi_events, link) {
815 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
817 switch (evt->trigger_type) {
818 case EFI_TIMER_RELATIVE:
819 evt->trigger_type = EFI_TIMER_STOP;
821 case EFI_TIMER_PERIODIC:
822 evt->trigger_next += evt->trigger_time;
827 evt->is_signaled = false;
828 efi_signal_event(evt);
830 efi_process_event_queue();
835 * efi_set_timer() - set the trigger time for a timer event or stop the event
836 * @event: event for which the timer is set
837 * @type: type of the timer
838 * @trigger_time: trigger period in multiples of 100 ns
840 * This is the function for internal usage in U-Boot. For the API function
841 * implementing the SetTimer service see efi_set_timer_ext.
843 * Return: status code
845 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
846 uint64_t trigger_time)
848 /* Check that the event is valid */
849 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
850 return EFI_INVALID_PARAMETER;
853 * The parameter defines a multiple of 100 ns.
854 * We use multiples of 1000 ns. So divide by 10.
856 do_div(trigger_time, 10);
860 event->trigger_next = -1ULL;
862 case EFI_TIMER_PERIODIC:
863 case EFI_TIMER_RELATIVE:
864 event->trigger_next = timer_get_us() + trigger_time;
867 return EFI_INVALID_PARAMETER;
869 event->trigger_type = type;
870 event->trigger_time = trigger_time;
871 event->is_signaled = false;
876 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
878 * @event: event for which the timer is set
879 * @type: type of the timer
880 * @trigger_time: trigger period in multiples of 100 ns
882 * This function implements the SetTimer service.
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
888 * Return: status code
890 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
891 enum efi_timer_delay type,
892 uint64_t trigger_time)
894 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
895 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
899 * efi_wait_for_event() - wait for events to be signaled
900 * @num_events: number of events to be waited for
901 * @event: events to be waited for
902 * @index: index of the event that was signaled
904 * This function implements the WaitForEvent service.
906 * See the Unified Extensible Firmware Interface (UEFI) specification for
909 * Return: status code
911 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
912 struct efi_event **event,
917 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
919 /* Check parameters */
920 if (!num_events || !event)
921 return EFI_EXIT(EFI_INVALID_PARAMETER);
923 if (efi_tpl != TPL_APPLICATION)
924 return EFI_EXIT(EFI_UNSUPPORTED);
925 for (i = 0; i < num_events; ++i) {
926 if (efi_is_event(event[i]) != EFI_SUCCESS)
927 return EFI_EXIT(EFI_INVALID_PARAMETER);
928 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
929 return EFI_EXIT(EFI_INVALID_PARAMETER);
930 if (!event[i]->is_signaled)
931 efi_queue_event(event[i]);
934 /* Wait for signal */
936 for (i = 0; i < num_events; ++i) {
937 if (event[i]->is_signaled)
940 /* Allow events to occur. */
946 * Reset the signal which is passed to the caller to allow periodic
949 event[i]->is_signaled = false;
953 return EFI_EXIT(EFI_SUCCESS);
957 * efi_signal_event_ext() - signal an EFI event
958 * @event: event to signal
960 * This function implements the SignalEvent service.
962 * See the Unified Extensible Firmware Interface (UEFI) specification for
965 * This functions sets the signaled state of the event and queues the
966 * notification function for execution.
968 * Return: status code
970 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
972 EFI_ENTRY("%p", event);
973 if (efi_is_event(event) != EFI_SUCCESS)
974 return EFI_EXIT(EFI_INVALID_PARAMETER);
975 efi_signal_event(event);
976 return EFI_EXIT(EFI_SUCCESS);
980 * efi_close_event() - close an EFI event
981 * @event: event to close
983 * This function implements the CloseEvent service.
985 * See the Unified Extensible Firmware Interface (UEFI) specification for
988 * Return: status code
990 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
992 struct efi_register_notify_event *item, *next;
994 EFI_ENTRY("%p", event);
995 if (efi_is_event(event) != EFI_SUCCESS)
996 return EFI_EXIT(EFI_INVALID_PARAMETER);
998 /* Remove protocol notify registrations for the event */
999 list_for_each_entry_safe(item, next, &efi_register_notify_events,
1001 if (event == item->event) {
1002 struct efi_protocol_notification *hitem, *hnext;
1004 /* Remove signaled handles */
1005 list_for_each_entry_safe(hitem, hnext, &item->handles,
1007 list_del(&hitem->link);
1010 list_del(&item->link);
1014 /* Remove event from queue */
1015 if (efi_event_is_queued(event))
1016 list_del(&event->queue_link);
1018 list_del(&event->link);
1019 efi_free_pool(event);
1020 return EFI_EXIT(EFI_SUCCESS);
1024 * efi_check_event() - check if an event is signaled
1025 * @event: event to check
1027 * This function implements the CheckEvent service.
1029 * See the Unified Extensible Firmware Interface (UEFI) specification for
1032 * If an event is not signaled yet, the notification function is queued. The
1033 * signaled state is cleared.
1035 * Return: status code
1037 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
1039 EFI_ENTRY("%p", event);
1041 if (efi_is_event(event) != EFI_SUCCESS ||
1042 event->type & EVT_NOTIFY_SIGNAL)
1043 return EFI_EXIT(EFI_INVALID_PARAMETER);
1044 if (!event->is_signaled)
1045 efi_queue_event(event);
1046 if (event->is_signaled) {
1047 event->is_signaled = false;
1048 return EFI_EXIT(EFI_SUCCESS);
1050 return EFI_EXIT(EFI_NOT_READY);
1054 * efi_search_obj() - find the internal EFI object for a handle
1055 * @handle: handle to find
1057 * Return: EFI object
1059 struct efi_object *efi_search_obj(const efi_handle_t handle)
1061 struct efi_object *efiobj;
1066 list_for_each_entry(efiobj, &efi_obj_list, link) {
1067 if (efiobj == handle)
1074 * efi_open_protocol_info_entry() - create open protocol info entry and add it
1076 * @handler: handler of a protocol
1078 * Return: open protocol info entry
1080 static struct efi_open_protocol_info_entry *efi_create_open_info(
1081 struct efi_handler *handler)
1083 struct efi_open_protocol_info_item *item;
1085 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
1088 /* Append the item to the open protocol info list. */
1089 list_add_tail(&item->link, &handler->open_infos);
1095 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1096 * @item: open protocol info entry to delete
1098 * Return: status code
1100 static efi_status_t efi_delete_open_info(
1101 struct efi_open_protocol_info_item *item)
1103 list_del(&item->link);
1109 * efi_add_protocol() - install new protocol on a handle
1110 * @handle: handle on which the protocol shall be installed
1111 * @protocol: GUID of the protocol to be installed
1112 * @protocol_interface: interface of the protocol implementation
1114 * Return: status code
1116 efi_status_t efi_add_protocol(const efi_handle_t handle,
1117 const efi_guid_t *protocol,
1118 void *protocol_interface)
1120 struct efi_object *efiobj;
1121 struct efi_handler *handler;
1123 struct efi_register_notify_event *event;
1125 efiobj = efi_search_obj(handle);
1127 return EFI_INVALID_PARAMETER;
1128 ret = efi_search_protocol(handle, protocol, NULL);
1129 if (ret != EFI_NOT_FOUND)
1130 return EFI_INVALID_PARAMETER;
1131 handler = calloc(1, sizeof(struct efi_handler));
1133 return EFI_OUT_OF_RESOURCES;
1134 handler->guid = protocol;
1135 handler->protocol_interface = protocol_interface;
1136 INIT_LIST_HEAD(&handler->open_infos);
1137 list_add_tail(&handler->link, &efiobj->protocols);
1139 /* Notify registered events */
1140 list_for_each_entry(event, &efi_register_notify_events, link) {
1141 if (!guidcmp(protocol, &event->protocol)) {
1142 struct efi_protocol_notification *notif;
1144 notif = calloc(1, sizeof(*notif));
1146 list_del(&handler->link);
1148 return EFI_OUT_OF_RESOURCES;
1150 notif->handle = handle;
1151 list_add_tail(¬if->link, &event->handles);
1152 event->event->is_signaled = false;
1153 efi_signal_event(event->event);
1157 if (!guidcmp(&efi_guid_device_path, protocol))
1158 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1163 * efi_install_protocol_interface() - install protocol interface
1164 * @handle: handle on which the protocol shall be installed
1165 * @protocol: GUID of the protocol to be installed
1166 * @protocol_interface_type: type of the interface to be installed,
1167 * always EFI_NATIVE_INTERFACE
1168 * @protocol_interface: interface of the protocol implementation
1170 * This function implements the InstallProtocolInterface service.
1172 * See the Unified Extensible Firmware Interface (UEFI) specification for
1175 * Return: status code
1177 static efi_status_t EFIAPI efi_install_protocol_interface(
1178 efi_handle_t *handle, const efi_guid_t *protocol,
1179 int protocol_interface_type, void *protocol_interface)
1183 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1184 protocol_interface);
1186 if (!handle || !protocol ||
1187 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1188 r = EFI_INVALID_PARAMETER;
1192 /* Create new handle if requested. */
1194 r = efi_create_handle(handle);
1195 if (r != EFI_SUCCESS)
1197 EFI_PRINT("new handle %p\n", *handle);
1199 EFI_PRINT("handle %p\n", *handle);
1201 /* Add new protocol */
1202 r = efi_add_protocol(*handle, protocol, protocol_interface);
1208 * efi_get_drivers() - get all drivers associated to a controller
1209 * @handle: handle of the controller
1210 * @protocol: protocol GUID (optional)
1211 * @number_of_drivers: number of child controllers
1212 * @driver_handle_buffer: handles of the the drivers
1214 * The allocated buffer has to be freed with free().
1216 * Return: status code
1218 static efi_status_t efi_get_drivers(efi_handle_t handle,
1219 const efi_guid_t *protocol,
1220 efi_uintn_t *number_of_drivers,
1221 efi_handle_t **driver_handle_buffer)
1223 struct efi_handler *handler;
1224 struct efi_open_protocol_info_item *item;
1225 efi_uintn_t count = 0, i;
1228 /* Count all driver associations */
1229 list_for_each_entry(handler, &handle->protocols, link) {
1230 if (protocol && guidcmp(handler->guid, protocol))
1232 list_for_each_entry(item, &handler->open_infos, link) {
1233 if (item->info.attributes &
1234 EFI_OPEN_PROTOCOL_BY_DRIVER)
1238 *number_of_drivers = 0;
1240 *driver_handle_buffer = NULL;
1244 * Create buffer. In case of duplicate driver assignments the buffer
1245 * will be too large. But that does not harm.
1247 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1248 if (!*driver_handle_buffer)
1249 return EFI_OUT_OF_RESOURCES;
1250 /* Collect unique driver handles */
1251 list_for_each_entry(handler, &handle->protocols, link) {
1252 if (protocol && guidcmp(handler->guid, protocol))
1254 list_for_each_entry(item, &handler->open_infos, link) {
1255 if (item->info.attributes &
1256 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1257 /* Check this is a new driver */
1259 for (i = 0; i < *number_of_drivers; ++i) {
1260 if ((*driver_handle_buffer)[i] ==
1261 item->info.agent_handle)
1264 /* Copy handle to buffer */
1266 i = (*number_of_drivers)++;
1267 (*driver_handle_buffer)[i] =
1268 item->info.agent_handle;
1277 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1278 * @handle: handle of the controller
1279 * @protocol: protocol GUID (optional)
1280 * @child_handle: handle of the child to destroy
1282 * This function implements the DisconnectController service.
1284 * See the Unified Extensible Firmware Interface (UEFI) specification for
1287 * Return: status code
1289 static efi_status_t efi_disconnect_all_drivers
1290 (efi_handle_t handle,
1291 const efi_guid_t *protocol,
1292 efi_handle_t child_handle)
1294 efi_uintn_t number_of_drivers;
1295 efi_handle_t *driver_handle_buffer;
1296 efi_status_t r, ret;
1298 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1299 &driver_handle_buffer);
1300 if (ret != EFI_SUCCESS)
1302 if (!number_of_drivers)
1304 ret = EFI_NOT_FOUND;
1305 while (number_of_drivers) {
1306 r = EFI_CALL(efi_disconnect_controller(
1308 driver_handle_buffer[--number_of_drivers],
1310 if (r == EFI_SUCCESS)
1313 free(driver_handle_buffer);
1318 * efi_uninstall_protocol() - uninstall protocol interface
1320 * @handle: handle from which the protocol shall be removed
1321 * @protocol: GUID of the protocol to be removed
1322 * @protocol_interface: interface to be removed
1324 * This function DOES NOT delete a handle without installed protocol.
1326 * Return: status code
1328 static efi_status_t efi_uninstall_protocol
1329 (efi_handle_t handle, const efi_guid_t *protocol,
1330 void *protocol_interface)
1332 struct efi_object *efiobj;
1333 struct efi_handler *handler;
1334 struct efi_open_protocol_info_item *item;
1335 struct efi_open_protocol_info_item *pos;
1339 efiobj = efi_search_obj(handle);
1341 r = EFI_INVALID_PARAMETER;
1344 /* Find the protocol on the handle */
1345 r = efi_search_protocol(handle, protocol, &handler);
1346 if (r != EFI_SUCCESS)
1348 /* Disconnect controllers */
1349 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1350 /* Close protocol */
1351 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1352 if (item->info.attributes ==
1353 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1354 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1355 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1356 list_del(&item->link);
1358 if (!list_empty(&handler->open_infos)) {
1359 r = EFI_ACCESS_DENIED;
1362 r = efi_remove_protocol(handle, protocol, protocol_interface);
1368 * efi_uninstall_protocol_interface() - uninstall protocol interface
1369 * @handle: handle from which the protocol shall be removed
1370 * @protocol: GUID of the protocol to be removed
1371 * @protocol_interface: interface to be removed
1373 * This function implements the UninstallProtocolInterface service.
1375 * See the Unified Extensible Firmware Interface (UEFI) specification for
1378 * Return: status code
1380 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1381 (efi_handle_t handle, const efi_guid_t *protocol,
1382 void *protocol_interface)
1386 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1388 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1389 if (ret != EFI_SUCCESS)
1392 /* If the last protocol has been removed, delete the handle. */
1393 if (list_empty(&handle->protocols)) {
1394 list_del(&handle->link);
1398 return EFI_EXIT(ret);
1402 * efi_register_protocol_notify() - register an event for notification when a
1403 * protocol is installed.
1404 * @protocol: GUID of the protocol whose installation shall be notified
1405 * @event: event to be signaled upon installation of the protocol
1406 * @registration: key for retrieving the registration information
1408 * This function implements the RegisterProtocolNotify service.
1409 * See the Unified Extensible Firmware Interface (UEFI) specification
1412 * Return: status code
1414 efi_status_t EFIAPI efi_register_protocol_notify(const efi_guid_t *protocol,
1415 struct efi_event *event,
1416 void **registration)
1418 struct efi_register_notify_event *item;
1419 efi_status_t ret = EFI_SUCCESS;
1421 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1423 if (!protocol || !event || !registration) {
1424 ret = EFI_INVALID_PARAMETER;
1428 item = calloc(1, sizeof(struct efi_register_notify_event));
1430 ret = EFI_OUT_OF_RESOURCES;
1434 item->event = event;
1435 guidcpy(&item->protocol, protocol);
1436 INIT_LIST_HEAD(&item->handles);
1438 list_add_tail(&item->link, &efi_register_notify_events);
1440 *registration = item;
1442 return EFI_EXIT(ret);
1446 * efi_search() - determine if an EFI handle implements a protocol
1448 * @search_type: selection criterion
1449 * @protocol: GUID of the protocol
1452 * See the documentation of the LocateHandle service in the UEFI specification.
1454 * Return: 0 if the handle implements the protocol
1456 static int efi_search(enum efi_locate_search_type search_type,
1457 const efi_guid_t *protocol, efi_handle_t handle)
1461 switch (search_type) {
1465 ret = efi_search_protocol(handle, protocol, NULL);
1466 return (ret != EFI_SUCCESS);
1468 /* Invalid search type */
1474 * efi_check_register_notify_event() - check if registration key is valid
1476 * Check that a pointer is a valid registration key as returned by
1477 * RegisterProtocolNotify().
1479 * @key: registration key
1480 * Return: valid registration key or NULL
1482 static struct efi_register_notify_event *efi_check_register_notify_event
1485 struct efi_register_notify_event *event;
1487 list_for_each_entry(event, &efi_register_notify_events, link) {
1488 if (event == (struct efi_register_notify_event *)key)
1495 * efi_locate_handle() - locate handles implementing a protocol
1497 * @search_type: selection criterion
1498 * @protocol: GUID of the protocol
1499 * @search_key: registration key
1500 * @buffer_size: size of the buffer to receive the handles in bytes
1501 * @buffer: buffer to receive the relevant handles
1503 * This function is meant for U-Boot internal calls. For the API implementation
1504 * of the LocateHandle service see efi_locate_handle_ext.
1506 * Return: status code
1508 static efi_status_t efi_locate_handle(
1509 enum efi_locate_search_type search_type,
1510 const efi_guid_t *protocol, void *search_key,
1511 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1513 struct efi_object *efiobj;
1514 efi_uintn_t size = 0;
1515 struct efi_register_notify_event *event;
1516 struct efi_protocol_notification *handle = NULL;
1518 /* Check parameters */
1519 switch (search_type) {
1522 case BY_REGISTER_NOTIFY:
1524 return EFI_INVALID_PARAMETER;
1525 /* Check that the registration key is valid */
1526 event = efi_check_register_notify_event(search_key);
1528 return EFI_INVALID_PARAMETER;
1532 return EFI_INVALID_PARAMETER;
1535 return EFI_INVALID_PARAMETER;
1538 /* Count how much space we need */
1539 if (search_type == BY_REGISTER_NOTIFY) {
1540 if (list_empty(&event->handles))
1541 return EFI_NOT_FOUND;
1542 handle = list_first_entry(&event->handles,
1543 struct efi_protocol_notification,
1545 efiobj = handle->handle;
1546 size += sizeof(void *);
1548 list_for_each_entry(efiobj, &efi_obj_list, link) {
1549 if (!efi_search(search_type, protocol, efiobj))
1550 size += sizeof(void *);
1553 return EFI_NOT_FOUND;
1557 return EFI_INVALID_PARAMETER;
1559 if (*buffer_size < size) {
1560 *buffer_size = size;
1561 return EFI_BUFFER_TOO_SMALL;
1564 *buffer_size = size;
1566 /* The buffer size is sufficient but there is no buffer */
1568 return EFI_INVALID_PARAMETER;
1570 /* Then fill the array */
1571 if (search_type == BY_REGISTER_NOTIFY) {
1573 list_del(&handle->link);
1575 list_for_each_entry(efiobj, &efi_obj_list, link) {
1576 if (!efi_search(search_type, protocol, efiobj))
1585 * efi_locate_handle_ext() - locate handles implementing a protocol.
1586 * @search_type: selection criterion
1587 * @protocol: GUID of the protocol
1588 * @search_key: registration key
1589 * @buffer_size: size of the buffer to receive the handles in bytes
1590 * @buffer: buffer to receive the relevant handles
1592 * This function implements the LocateHandle service.
1594 * See the Unified Extensible Firmware Interface (UEFI) specification for
1597 * Return: 0 if the handle implements the protocol
1599 static efi_status_t EFIAPI efi_locate_handle_ext(
1600 enum efi_locate_search_type search_type,
1601 const efi_guid_t *protocol, void *search_key,
1602 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1604 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1605 buffer_size, buffer);
1607 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1608 buffer_size, buffer));
1612 * efi_remove_configuration_table() - collapses configuration table entries,
1615 * @i: index of the table entry to be removed
1617 static void efi_remove_configuration_table(int i)
1619 struct efi_configuration_table *this = &systab.tables[i];
1620 struct efi_configuration_table *next = &systab.tables[i + 1];
1621 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1623 memmove(this, next, (ulong)end - (ulong)next);
1628 * efi_install_configuration_table() - adds, updates, or removes a
1629 * configuration table
1630 * @guid: GUID of the installed table
1631 * @table: table to be installed
1633 * This function is used for internal calls. For the API implementation of the
1634 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1636 * Return: status code
1638 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1641 struct efi_event *evt;
1645 return EFI_INVALID_PARAMETER;
1647 /* Check for GUID override */
1648 for (i = 0; i < systab.nr_tables; i++) {
1649 if (!guidcmp(guid, &systab.tables[i].guid)) {
1651 systab.tables[i].table = table;
1653 efi_remove_configuration_table(i);
1659 return EFI_NOT_FOUND;
1661 /* No override, check for overflow */
1662 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1663 return EFI_OUT_OF_RESOURCES;
1665 /* Add a new entry */
1666 guidcpy(&systab.tables[i].guid, guid);
1667 systab.tables[i].table = table;
1668 systab.nr_tables = i + 1;
1671 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1672 efi_update_table_header_crc32(&systab.hdr);
1674 /* Notify that the configuration table was changed */
1675 list_for_each_entry(evt, &efi_events, link) {
1676 if (evt->group && !guidcmp(evt->group, guid)) {
1677 efi_signal_event(evt);
1686 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1687 * configuration table.
1688 * @guid: GUID of the installed table
1689 * @table: table to be installed
1691 * This function implements the InstallConfigurationTable service.
1693 * See the Unified Extensible Firmware Interface (UEFI) specification for
1696 * Return: status code
1699 EFIAPI efi_install_configuration_table_ext(const efi_guid_t *guid,
1702 EFI_ENTRY("%pUl, %p", guid, table);
1703 return EFI_EXIT(efi_install_configuration_table(guid, table));
1707 * efi_setup_loaded_image() - initialize a loaded image
1709 * Initialize a loaded_image_info and loaded_image_info object with correct
1710 * protocols, boot-device, etc.
1712 * In case of an error \*handle_ptr and \*info_ptr are set to NULL and an error
1715 * @device_path: device path of the loaded image
1716 * @file_path: file path of the loaded image
1717 * @handle_ptr: handle of the loaded image
1718 * @info_ptr: loaded image protocol
1719 * Return: status code
1721 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1722 struct efi_device_path *file_path,
1723 struct efi_loaded_image_obj **handle_ptr,
1724 struct efi_loaded_image **info_ptr)
1727 struct efi_loaded_image *info = NULL;
1728 struct efi_loaded_image_obj *obj = NULL;
1729 struct efi_device_path *dp;
1731 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1735 info = calloc(1, sizeof(*info));
1737 return EFI_OUT_OF_RESOURCES;
1738 obj = calloc(1, sizeof(*obj));
1741 return EFI_OUT_OF_RESOURCES;
1743 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1745 /* Add internal object to object list */
1746 efi_add_handle(&obj->header);
1748 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1749 info->file_path = file_path;
1750 info->system_table = &systab;
1753 info->device_handle = efi_dp_find_obj(device_path, NULL);
1755 dp = efi_dp_append(device_path, file_path);
1757 ret = EFI_OUT_OF_RESOURCES;
1763 ret = efi_add_protocol(&obj->header,
1764 &efi_guid_loaded_image_device_path, dp);
1765 if (ret != EFI_SUCCESS)
1769 * When asking for the loaded_image interface, just
1770 * return handle which points to loaded_image_info
1772 ret = efi_add_protocol(&obj->header,
1773 &efi_guid_loaded_image, info);
1774 if (ret != EFI_SUCCESS)
1782 printf("ERROR: Failure to install protocols for loaded image\n");
1783 efi_delete_handle(&obj->header);
1789 * efi_locate_device_path() - Get the device path and handle of an device
1790 * implementing a protocol
1791 * @protocol: GUID of the protocol
1792 * @device_path: device path
1793 * @device: handle of the device
1795 * This function implements the LocateDevicePath service.
1797 * See the Unified Extensible Firmware Interface (UEFI) specification for
1800 * Return: status code
1802 static efi_status_t EFIAPI efi_locate_device_path(
1803 const efi_guid_t *protocol,
1804 struct efi_device_path **device_path,
1805 efi_handle_t *device)
1807 struct efi_device_path *dp;
1809 struct efi_handler *handler;
1810 efi_handle_t *handles;
1812 size_t len_best = 0;
1813 efi_uintn_t no_handles;
1817 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1819 if (!protocol || !device_path || !*device_path) {
1820 ret = EFI_INVALID_PARAMETER;
1824 /* Find end of device path */
1825 len = efi_dp_instance_size(*device_path);
1827 /* Get all handles implementing the protocol */
1828 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
1829 &no_handles, &handles));
1830 if (ret != EFI_SUCCESS)
1833 for (i = 0; i < no_handles; ++i) {
1834 /* Find the device path protocol */
1835 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
1837 if (ret != EFI_SUCCESS)
1839 dp = (struct efi_device_path *)handler->protocol_interface;
1840 len_dp = efi_dp_instance_size(dp);
1842 * This handle can only be a better fit
1843 * if its device path length is longer than the best fit and
1844 * if its device path length is shorter of equal the searched
1847 if (len_dp <= len_best || len_dp > len)
1849 /* Check if dp is a subpath of device_path */
1850 if (memcmp(*device_path, dp, len_dp))
1853 ret = EFI_INVALID_PARAMETER;
1856 *device = handles[i];
1860 remainder = (u8 *)*device_path + len_best;
1861 *device_path = (struct efi_device_path *)remainder;
1864 ret = EFI_NOT_FOUND;
1867 return EFI_EXIT(ret);
1871 * efi_load_image_from_file() - load an image from file system
1873 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1874 * callers obligation to update the memory type as needed.
1876 * @file_path: the path of the image to load
1877 * @buffer: buffer containing the loaded image
1878 * @size: size of the loaded image
1879 * Return: status code
1882 efi_status_t efi_load_image_from_file(struct efi_device_path *file_path,
1883 void **buffer, efi_uintn_t *size)
1885 struct efi_file_handle *f;
1891 f = efi_file_from_path(file_path);
1893 return EFI_NOT_FOUND;
1895 ret = efi_file_size(f, &bs);
1896 if (ret != EFI_SUCCESS)
1900 * When reading the file we do not yet know if it contains an
1901 * application, a boottime driver, or a runtime driver. So here we
1902 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1903 * update the reservation according to the image type.
1905 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1906 EFI_BOOT_SERVICES_DATA,
1907 efi_size_in_pages(bs), &addr);
1908 if (ret != EFI_SUCCESS) {
1909 ret = EFI_OUT_OF_RESOURCES;
1914 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1915 if (ret != EFI_SUCCESS)
1916 efi_free_pages(addr, efi_size_in_pages(bs));
1917 *buffer = (void *)(uintptr_t)addr;
1920 EFI_CALL(f->close(f));
1925 * efi_load_image_from_path() - load an image using a file path
1927 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1928 * callers obligation to update the memory type as needed.
1930 * @boot_policy: true for request originating from the boot manager
1931 * @file_path: the path of the image to load
1932 * @buffer: buffer containing the loaded image
1933 * @size: size of the loaded image
1934 * Return: status code
1937 efi_status_t efi_load_image_from_path(bool boot_policy,
1938 struct efi_device_path *file_path,
1939 void **buffer, efi_uintn_t *size)
1941 efi_handle_t device;
1943 struct efi_device_path *dp;
1944 struct efi_load_file_protocol *load_file_protocol = NULL;
1945 efi_uintn_t buffer_size;
1946 uint64_t addr, pages;
1947 const efi_guid_t *guid;
1949 /* In case of failure nothing is returned */
1954 ret = EFI_CALL(efi_locate_device_path(
1955 &efi_simple_file_system_protocol_guid, &dp, &device));
1956 if (ret == EFI_SUCCESS)
1957 return efi_load_image_from_file(file_path, buffer, size);
1959 ret = EFI_CALL(efi_locate_device_path(
1960 &efi_guid_load_file_protocol, &dp, &device));
1961 if (ret == EFI_SUCCESS) {
1962 guid = &efi_guid_load_file_protocol;
1963 } else if (!boot_policy) {
1964 guid = &efi_guid_load_file2_protocol;
1965 ret = EFI_CALL(efi_locate_device_path(guid, &dp, &device));
1967 if (ret != EFI_SUCCESS)
1968 return EFI_NOT_FOUND;
1969 ret = EFI_CALL(efi_handle_protocol(device, guid,
1970 (void **)&load_file_protocol));
1971 if (ret != EFI_SUCCESS)
1972 return EFI_NOT_FOUND;
1974 ret = load_file_protocol->load_file(load_file_protocol, dp,
1975 boot_policy, &buffer_size,
1977 if (ret != EFI_BUFFER_TOO_SMALL)
1979 pages = efi_size_in_pages(buffer_size);
1980 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, EFI_BOOT_SERVICES_DATA,
1982 if (ret != EFI_SUCCESS) {
1983 ret = EFI_OUT_OF_RESOURCES;
1986 ret = EFI_CALL(load_file_protocol->load_file(
1987 load_file_protocol, dp, boot_policy,
1988 &buffer_size, (void *)(uintptr_t)addr));
1989 if (ret != EFI_SUCCESS)
1990 efi_free_pages(addr, pages);
1992 EFI_CALL(efi_close_protocol(device, guid, efi_root, NULL));
1993 if (ret == EFI_SUCCESS) {
1994 *buffer = (void *)(uintptr_t)addr;
1995 *size = buffer_size;
2002 * efi_load_image() - load an EFI image into memory
2003 * @boot_policy: true for request originating from the boot manager
2004 * @parent_image: the caller's image handle
2005 * @file_path: the path of the image to load
2006 * @source_buffer: memory location from which the image is installed
2007 * @source_size: size of the memory area from which the image is installed
2008 * @image_handle: handle for the newly installed image
2010 * This function implements the LoadImage service.
2012 * See the Unified Extensible Firmware Interface (UEFI) specification
2015 * Return: status code
2017 efi_status_t EFIAPI efi_load_image(bool boot_policy,
2018 efi_handle_t parent_image,
2019 struct efi_device_path *file_path,
2020 void *source_buffer,
2021 efi_uintn_t source_size,
2022 efi_handle_t *image_handle)
2024 struct efi_device_path *dp, *fp;
2025 struct efi_loaded_image *info = NULL;
2026 struct efi_loaded_image_obj **image_obj =
2027 (struct efi_loaded_image_obj **)image_handle;
2031 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
2032 file_path, source_buffer, source_size, image_handle);
2034 if (!image_handle || (!source_buffer && !file_path) ||
2035 !efi_search_obj(parent_image) ||
2036 /* The parent image handle must refer to a loaded image */
2037 !parent_image->type) {
2038 ret = EFI_INVALID_PARAMETER;
2042 if (!source_buffer) {
2043 ret = efi_load_image_from_path(boot_policy, file_path,
2044 &dest_buffer, &source_size);
2045 if (ret != EFI_SUCCESS)
2048 dest_buffer = source_buffer;
2050 /* split file_path which contains both the device and file parts */
2051 efi_dp_split_file_path(file_path, &dp, &fp);
2052 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
2053 if (ret == EFI_SUCCESS)
2054 ret = efi_load_pe(*image_obj, dest_buffer, source_size, info);
2056 /* Release buffer to which file was loaded */
2057 efi_free_pages((uintptr_t)dest_buffer,
2058 efi_size_in_pages(source_size));
2059 if (ret == EFI_SUCCESS || ret == EFI_SECURITY_VIOLATION) {
2060 info->system_table = &systab;
2061 info->parent_handle = parent_image;
2063 /* The image is invalid. Release all associated resources. */
2064 efi_delete_handle(*image_handle);
2065 *image_handle = NULL;
2069 return EFI_EXIT(ret);
2073 * efi_exit_caches() - fix up caches for EFI payloads if necessary
2075 static void efi_exit_caches(void)
2077 #if defined(CONFIG_EFI_GRUB_ARM32_WORKAROUND)
2079 * Boooting Linux via GRUB prior to version 2.04 fails on 32bit ARM if
2080 * caches are enabled.
2083 * According to the UEFI spec caches that can be managed via CP15
2084 * operations should be enabled. Caches requiring platform information
2085 * to manage should be disabled. This should not happen in
2086 * ExitBootServices() but before invoking any UEFI binary is invoked.
2088 * We want to keep the current workaround while GRUB prior to version
2089 * 2.04 is still in use.
2091 cleanup_before_linux();
2096 * efi_exit_boot_services() - stop all boot services
2097 * @image_handle: handle of the loaded image
2098 * @map_key: key of the memory map
2100 * This function implements the ExitBootServices service.
2102 * See the Unified Extensible Firmware Interface (UEFI) specification
2105 * All timer events are disabled. For exit boot services events the
2106 * notification function is called. The boot services are disabled in the
2109 * Return: status code
2111 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
2112 efi_uintn_t map_key)
2114 struct efi_event *evt, *next_event;
2115 efi_status_t ret = EFI_SUCCESS;
2117 EFI_ENTRY("%p, %zx", image_handle, map_key);
2119 /* Check that the caller has read the current memory map */
2120 if (map_key != efi_memory_map_key) {
2121 ret = EFI_INVALID_PARAMETER;
2125 /* Check if ExitBootServices has already been called */
2126 if (!systab.boottime)
2129 /* Notify EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES event group. */
2130 list_for_each_entry(evt, &efi_events, link) {
2132 !guidcmp(evt->group,
2133 &efi_guid_event_group_before_exit_boot_services)) {
2134 efi_signal_event(evt);
2139 /* Stop all timer related activities */
2140 timers_enabled = false;
2142 /* Add related events to the event group */
2143 list_for_each_entry(evt, &efi_events, link) {
2144 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
2145 evt->group = &efi_guid_event_group_exit_boot_services;
2147 /* Notify that ExitBootServices is invoked. */
2148 list_for_each_entry(evt, &efi_events, link) {
2150 !guidcmp(evt->group,
2151 &efi_guid_event_group_exit_boot_services)) {
2152 efi_signal_event(evt);
2157 /* Make sure that notification functions are not called anymore */
2158 efi_tpl = TPL_HIGH_LEVEL;
2160 /* Notify variable services */
2161 efi_variables_boot_exit_notify();
2163 /* Remove all events except EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
2164 list_for_each_entry_safe(evt, next_event, &efi_events, link) {
2165 if (evt->type != EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE)
2166 list_del(&evt->link);
2169 if (!efi_st_keep_devices) {
2170 bootm_disable_interrupts();
2171 if (IS_ENABLED(CONFIG_USB_DEVICE))
2173 board_quiesce_devices();
2174 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
2177 /* Patch out unsupported runtime function */
2178 efi_runtime_detach();
2180 /* Fix up caches for EFI payloads if necessary */
2183 /* Disable boot time services */
2184 systab.con_in_handle = NULL;
2185 systab.con_in = NULL;
2186 systab.con_out_handle = NULL;
2187 systab.con_out = NULL;
2188 systab.stderr_handle = NULL;
2189 systab.std_err = NULL;
2190 systab.boottime = NULL;
2192 /* Recalculate CRC32 */
2193 efi_update_table_header_crc32(&systab.hdr);
2195 /* Give the payload some time to boot */
2196 efi_set_watchdog(0);
2199 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
2200 if (ret != EFI_SUCCESS)
2201 efi_tcg2_notify_exit_boot_services_failed();
2204 return EFI_EXIT(ret);
2208 * efi_get_next_monotonic_count() - get next value of the counter
2209 * @count: returned value of the counter
2211 * This function implements the NextMonotonicCount service.
2213 * See the Unified Extensible Firmware Interface (UEFI) specification for
2216 * Return: status code
2218 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2220 static uint64_t mono;
2223 EFI_ENTRY("%p", count);
2225 ret = EFI_INVALID_PARAMETER;
2231 return EFI_EXIT(ret);
2235 * efi_stall() - sleep
2236 * @microseconds: period to sleep in microseconds
2238 * This function implements the Stall service.
2240 * See the Unified Extensible Firmware Interface (UEFI) specification for
2243 * Return: status code
2245 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2249 EFI_ENTRY("%ld", microseconds);
2251 end_tick = get_ticks() + usec_to_tick(microseconds);
2252 while (get_ticks() < end_tick)
2255 return EFI_EXIT(EFI_SUCCESS);
2259 * efi_set_watchdog_timer() - reset the watchdog timer
2260 * @timeout: seconds before reset by watchdog
2261 * @watchdog_code: code to be logged when resetting
2262 * @data_size: size of buffer in bytes
2263 * @watchdog_data: buffer with data describing the reset reason
2265 * This function implements the SetWatchdogTimer service.
2267 * See the Unified Extensible Firmware Interface (UEFI) specification for
2270 * Return: status code
2272 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2273 uint64_t watchdog_code,
2274 unsigned long data_size,
2275 uint16_t *watchdog_data)
2277 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
2278 data_size, watchdog_data);
2279 return EFI_EXIT(efi_set_watchdog(timeout));
2283 * efi_close_protocol() - close a protocol
2284 * @handle: handle on which the protocol shall be closed
2285 * @protocol: GUID of the protocol to close
2286 * @agent_handle: handle of the driver
2287 * @controller_handle: handle of the controller
2289 * This function implements the CloseProtocol service.
2291 * See the Unified Extensible Firmware Interface (UEFI) specification for
2294 * Return: status code
2296 efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
2297 const efi_guid_t *protocol,
2298 efi_handle_t agent_handle,
2299 efi_handle_t controller_handle)
2301 struct efi_handler *handler;
2302 struct efi_open_protocol_info_item *item;
2303 struct efi_open_protocol_info_item *pos;
2306 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2309 if (!efi_search_obj(agent_handle) ||
2310 (controller_handle && !efi_search_obj(controller_handle))) {
2311 r = EFI_INVALID_PARAMETER;
2314 r = efi_search_protocol(handle, protocol, &handler);
2315 if (r != EFI_SUCCESS)
2319 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2320 if (item->info.agent_handle == agent_handle &&
2321 item->info.controller_handle == controller_handle) {
2322 efi_delete_open_info(item);
2331 * efi_open_protocol_information() - provide information about then open status
2332 * of a protocol on a handle
2333 * @handle: handle for which the information shall be retrieved
2334 * @protocol: GUID of the protocol
2335 * @entry_buffer: buffer to receive the open protocol information
2336 * @entry_count: number of entries available in the buffer
2338 * This function implements the OpenProtocolInformation service.
2340 * See the Unified Extensible Firmware Interface (UEFI) specification for
2343 * Return: status code
2345 static efi_status_t EFIAPI efi_open_protocol_information(
2346 efi_handle_t handle, const efi_guid_t *protocol,
2347 struct efi_open_protocol_info_entry **entry_buffer,
2348 efi_uintn_t *entry_count)
2350 unsigned long buffer_size;
2351 unsigned long count;
2352 struct efi_handler *handler;
2353 struct efi_open_protocol_info_item *item;
2356 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2359 /* Check parameters */
2360 if (!entry_buffer) {
2361 r = EFI_INVALID_PARAMETER;
2364 r = efi_search_protocol(handle, protocol, &handler);
2365 if (r != EFI_SUCCESS)
2370 list_for_each_entry(item, &handler->open_infos, link) {
2371 if (item->info.open_count)
2374 *entry_count = count;
2375 *entry_buffer = NULL;
2382 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2383 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2384 (void **)entry_buffer);
2385 if (r != EFI_SUCCESS)
2387 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2388 if (item->info.open_count)
2389 (*entry_buffer)[--count] = item->info;
2396 * efi_protocols_per_handle() - get protocols installed on a handle
2397 * @handle: handle for which the information is retrieved
2398 * @protocol_buffer: buffer with protocol GUIDs
2399 * @protocol_buffer_count: number of entries in the buffer
2401 * This function implements the ProtocolsPerHandleService.
2403 * See the Unified Extensible Firmware Interface (UEFI) specification for
2406 * Return: status code
2408 static efi_status_t EFIAPI efi_protocols_per_handle(
2409 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2410 efi_uintn_t *protocol_buffer_count)
2412 unsigned long buffer_size;
2413 struct efi_object *efiobj;
2414 struct list_head *protocol_handle;
2417 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2418 protocol_buffer_count);
2420 if (!handle || !protocol_buffer || !protocol_buffer_count)
2421 return EFI_EXIT(EFI_INVALID_PARAMETER);
2423 *protocol_buffer = NULL;
2424 *protocol_buffer_count = 0;
2426 efiobj = efi_search_obj(handle);
2428 return EFI_EXIT(EFI_INVALID_PARAMETER);
2430 /* Count protocols */
2431 list_for_each(protocol_handle, &efiobj->protocols) {
2432 ++*protocol_buffer_count;
2436 if (*protocol_buffer_count) {
2439 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2440 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2441 (void **)protocol_buffer);
2442 if (r != EFI_SUCCESS)
2444 list_for_each(protocol_handle, &efiobj->protocols) {
2445 struct efi_handler *protocol;
2447 protocol = list_entry(protocol_handle,
2448 struct efi_handler, link);
2449 (*protocol_buffer)[j] = (void *)protocol->guid;
2454 return EFI_EXIT(EFI_SUCCESS);
2458 * efi_locate_handle_buffer() - locate handles implementing a protocol
2459 * @search_type: selection criterion
2460 * @protocol: GUID of the protocol
2461 * @search_key: registration key
2462 * @no_handles: number of returned handles
2463 * @buffer: buffer with the returned handles
2465 * This function implements the LocateHandleBuffer service.
2467 * See the Unified Extensible Firmware Interface (UEFI) specification for
2470 * Return: status code
2472 efi_status_t EFIAPI efi_locate_handle_buffer(
2473 enum efi_locate_search_type search_type,
2474 const efi_guid_t *protocol, void *search_key,
2475 efi_uintn_t *no_handles, efi_handle_t **buffer)
2478 efi_uintn_t buffer_size = 0;
2480 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2481 no_handles, buffer);
2483 if (!no_handles || !buffer) {
2484 r = EFI_INVALID_PARAMETER;
2489 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2491 if (r != EFI_BUFFER_TOO_SMALL)
2493 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2495 if (r != EFI_SUCCESS)
2497 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2499 if (r == EFI_SUCCESS)
2500 *no_handles = buffer_size / sizeof(efi_handle_t);
2506 * efi_locate_protocol() - find an interface implementing a protocol
2507 * @protocol: GUID of the protocol
2508 * @registration: registration key passed to the notification function
2509 * @protocol_interface: interface implementing the protocol
2511 * This function implements the LocateProtocol service.
2513 * See the Unified Extensible Firmware Interface (UEFI) specification for
2516 * Return: status code
2518 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2520 void **protocol_interface)
2522 struct efi_handler *handler;
2524 struct efi_object *efiobj;
2526 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2529 * The UEFI spec explicitly requires a protocol even if a registration
2530 * key is provided. This differs from the logic in LocateHandle().
2532 if (!protocol || !protocol_interface)
2533 return EFI_EXIT(EFI_INVALID_PARAMETER);
2536 struct efi_register_notify_event *event;
2537 struct efi_protocol_notification *handle;
2539 event = efi_check_register_notify_event(registration);
2541 return EFI_EXIT(EFI_INVALID_PARAMETER);
2543 * The UEFI spec requires to return EFI_NOT_FOUND if no
2544 * protocol instance matches protocol and registration.
2545 * So let's do the same for a mismatch between protocol and
2548 if (guidcmp(&event->protocol, protocol))
2550 if (list_empty(&event->handles))
2552 handle = list_first_entry(&event->handles,
2553 struct efi_protocol_notification,
2555 efiobj = handle->handle;
2556 list_del(&handle->link);
2558 ret = efi_search_protocol(efiobj, protocol, &handler);
2559 if (ret == EFI_SUCCESS)
2562 list_for_each_entry(efiobj, &efi_obj_list, link) {
2563 ret = efi_search_protocol(efiobj, protocol, &handler);
2564 if (ret == EFI_SUCCESS)
2569 *protocol_interface = NULL;
2570 return EFI_EXIT(EFI_NOT_FOUND);
2572 *protocol_interface = handler->protocol_interface;
2573 return EFI_EXIT(EFI_SUCCESS);
2577 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2579 * @handle: handle on which the protocol interfaces shall be installed
2580 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2583 * This function implements the MultipleProtocolInterfaces service.
2585 * See the Unified Extensible Firmware Interface (UEFI) specification for
2588 * Return: status code
2590 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2591 (efi_handle_t *handle, ...)
2593 EFI_ENTRY("%p", handle);
2596 const efi_guid_t *protocol;
2597 void *protocol_interface;
2598 efi_handle_t old_handle;
2599 efi_status_t r = EFI_SUCCESS;
2603 return EFI_EXIT(EFI_INVALID_PARAMETER);
2605 efi_va_start(argptr, handle);
2607 protocol = efi_va_arg(argptr, efi_guid_t*);
2610 protocol_interface = efi_va_arg(argptr, void*);
2611 /* Check that a device path has not been installed before */
2612 if (!guidcmp(protocol, &efi_guid_device_path)) {
2613 struct efi_device_path *dp = protocol_interface;
2615 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2617 if (r == EFI_SUCCESS &&
2618 dp->type == DEVICE_PATH_TYPE_END) {
2619 EFI_PRINT("Path %pD already installed\n",
2620 protocol_interface);
2621 r = EFI_ALREADY_STARTED;
2625 r = EFI_CALL(efi_install_protocol_interface(
2627 EFI_NATIVE_INTERFACE,
2628 protocol_interface));
2629 if (r != EFI_SUCCESS)
2634 if (r == EFI_SUCCESS)
2637 /* If an error occurred undo all changes. */
2638 efi_va_start(argptr, handle);
2640 protocol = efi_va_arg(argptr, efi_guid_t*);
2641 protocol_interface = efi_va_arg(argptr, void*);
2642 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2643 protocol_interface));
2651 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2653 * @handle: handle from which the protocol interfaces shall be removed
2654 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2657 * This function implements the UninstallMultipleProtocolInterfaces service.
2659 * See the Unified Extensible Firmware Interface (UEFI) specification for
2662 * Return: status code
2664 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2665 efi_handle_t handle, ...)
2667 EFI_ENTRY("%p", handle);
2670 const efi_guid_t *protocol;
2671 void *protocol_interface;
2672 efi_status_t r = EFI_SUCCESS;
2676 return EFI_EXIT(EFI_INVALID_PARAMETER);
2678 efi_va_start(argptr, handle);
2680 protocol = efi_va_arg(argptr, efi_guid_t*);
2683 protocol_interface = efi_va_arg(argptr, void*);
2684 r = efi_uninstall_protocol(handle, protocol,
2685 protocol_interface);
2686 if (r != EFI_SUCCESS)
2691 if (r == EFI_SUCCESS) {
2692 /* If the last protocol has been removed, delete the handle. */
2693 if (list_empty(&handle->protocols)) {
2694 list_del(&handle->link);
2700 /* If an error occurred undo all changes. */
2701 efi_va_start(argptr, handle);
2703 protocol = efi_va_arg(argptr, efi_guid_t*);
2704 protocol_interface = efi_va_arg(argptr, void*);
2705 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2706 EFI_NATIVE_INTERFACE,
2707 protocol_interface));
2711 /* In case of an error always return EFI_INVALID_PARAMETER */
2712 return EFI_EXIT(EFI_INVALID_PARAMETER);
2716 * efi_calculate_crc32() - calculate cyclic redundancy code
2717 * @data: buffer with data
2718 * @data_size: size of buffer in bytes
2719 * @crc32_p: cyclic redundancy code
2721 * This function implements the CalculateCrc32 service.
2723 * See the Unified Extensible Firmware Interface (UEFI) specification for
2726 * Return: status code
2728 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2729 efi_uintn_t data_size,
2732 efi_status_t ret = EFI_SUCCESS;
2734 EFI_ENTRY("%p, %zu", data, data_size);
2735 if (!data || !data_size || !crc32_p) {
2736 ret = EFI_INVALID_PARAMETER;
2739 *crc32_p = crc32(0, data, data_size);
2741 return EFI_EXIT(ret);
2745 * efi_copy_mem() - copy memory
2746 * @destination: destination of the copy operation
2747 * @source: source of the copy operation
2748 * @length: number of bytes to copy
2750 * This function implements the CopyMem service.
2752 * See the Unified Extensible Firmware Interface (UEFI) specification for
2755 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2758 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2759 memmove(destination, source, length);
2760 EFI_EXIT(EFI_SUCCESS);
2764 * efi_set_mem() - Fill memory with a byte value.
2765 * @buffer: buffer to fill
2766 * @size: size of buffer in bytes
2767 * @value: byte to copy to the buffer
2769 * This function implements the SetMem service.
2771 * See the Unified Extensible Firmware Interface (UEFI) specification for
2774 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2776 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2777 memset(buffer, value, size);
2778 EFI_EXIT(EFI_SUCCESS);
2782 * efi_protocol_open() - open protocol interface on a handle
2783 * @handler: handler of a protocol
2784 * @protocol_interface: interface implementing the protocol
2785 * @agent_handle: handle of the driver
2786 * @controller_handle: handle of the controller
2787 * @attributes: attributes indicating how to open the protocol
2789 * Return: status code
2791 efi_status_t efi_protocol_open(
2792 struct efi_handler *handler,
2793 void **protocol_interface, void *agent_handle,
2794 void *controller_handle, uint32_t attributes)
2796 struct efi_open_protocol_info_item *item;
2797 struct efi_open_protocol_info_entry *match = NULL;
2798 bool opened_by_driver = false;
2799 bool opened_exclusive = false;
2801 /* If there is no agent, only return the interface */
2805 /* For TEST_PROTOCOL ignore interface attribute */
2806 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2807 *protocol_interface = NULL;
2810 * Check if the protocol is already opened by a driver with the same
2811 * attributes or opened exclusively
2813 list_for_each_entry(item, &handler->open_infos, link) {
2814 if (item->info.agent_handle == agent_handle) {
2815 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2816 (item->info.attributes == attributes))
2817 return EFI_ALREADY_STARTED;
2819 if (item->info.attributes &
2820 EFI_OPEN_PROTOCOL_BY_DRIVER)
2821 opened_by_driver = true;
2823 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2824 opened_exclusive = true;
2827 /* Only one controller can open the protocol exclusively */
2828 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2829 if (opened_exclusive)
2830 return EFI_ACCESS_DENIED;
2831 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
2832 if (opened_exclusive || opened_by_driver)
2833 return EFI_ACCESS_DENIED;
2836 /* Prepare exclusive opening */
2837 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2838 /* Try to disconnect controllers */
2840 opened_by_driver = false;
2841 list_for_each_entry(item, &handler->open_infos, link) {
2844 if (item->info.attributes ==
2845 EFI_OPEN_PROTOCOL_BY_DRIVER) {
2846 ret = EFI_CALL(efi_disconnect_controller(
2847 item->info.controller_handle,
2848 item->info.agent_handle,
2850 if (ret == EFI_SUCCESS)
2852 * Child controllers may have been
2853 * removed from the open_infos list. So
2854 * let's restart the loop.
2856 goto disconnect_next;
2858 opened_by_driver = true;
2861 /* Only one driver can be connected */
2862 if (opened_by_driver)
2863 return EFI_ACCESS_DENIED;
2866 /* Find existing entry */
2867 list_for_each_entry(item, &handler->open_infos, link) {
2868 if (item->info.agent_handle == agent_handle &&
2869 item->info.controller_handle == controller_handle &&
2870 item->info.attributes == attributes)
2871 match = &item->info;
2873 /* None found, create one */
2875 match = efi_create_open_info(handler);
2877 return EFI_OUT_OF_RESOURCES;
2880 match->agent_handle = agent_handle;
2881 match->controller_handle = controller_handle;
2882 match->attributes = attributes;
2883 match->open_count++;
2886 /* For TEST_PROTOCOL ignore interface attribute. */
2887 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2888 *protocol_interface = handler->protocol_interface;
2894 * efi_open_protocol() - open protocol interface on a handle
2895 * @handle: handle on which the protocol shall be opened
2896 * @protocol: GUID of the protocol
2897 * @protocol_interface: interface implementing the protocol
2898 * @agent_handle: handle of the driver
2899 * @controller_handle: handle of the controller
2900 * @attributes: attributes indicating how to open the protocol
2902 * This function implements the OpenProtocol interface.
2904 * See the Unified Extensible Firmware Interface (UEFI) specification for
2907 * Return: status code
2909 static efi_status_t EFIAPI efi_open_protocol
2910 (efi_handle_t handle, const efi_guid_t *protocol,
2911 void **protocol_interface, efi_handle_t agent_handle,
2912 efi_handle_t controller_handle, uint32_t attributes)
2914 struct efi_handler *handler;
2915 efi_status_t r = EFI_INVALID_PARAMETER;
2917 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2918 protocol_interface, agent_handle, controller_handle,
2921 if (!handle || !protocol ||
2922 (!protocol_interface && attributes !=
2923 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2927 switch (attributes) {
2928 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2929 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2930 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2932 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2933 if (controller_handle == handle)
2936 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2937 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2938 /* Check that the controller handle is valid */
2939 if (!efi_search_obj(controller_handle))
2942 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2943 /* Check that the agent handle is valid */
2944 if (!efi_search_obj(agent_handle))
2951 r = efi_search_protocol(handle, protocol, &handler);
2956 r = EFI_UNSUPPORTED;
2962 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2963 controller_handle, attributes);
2969 * efi_start_image() - call the entry point of an image
2970 * @image_handle: handle of the image
2971 * @exit_data_size: size of the buffer
2972 * @exit_data: buffer to receive the exit data of the called image
2974 * This function implements the StartImage service.
2976 * See the Unified Extensible Firmware Interface (UEFI) specification for
2979 * Return: status code
2981 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2982 efi_uintn_t *exit_data_size,
2985 struct efi_loaded_image_obj *image_obj =
2986 (struct efi_loaded_image_obj *)image_handle;
2989 efi_handle_t parent_image = current_image;
2990 efi_status_t exit_status;
2991 struct jmp_buf_data exit_jmp;
2993 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2995 if (!efi_search_obj(image_handle))
2996 return EFI_EXIT(EFI_INVALID_PARAMETER);
2998 /* Check parameters */
2999 if (image_obj->header.type != EFI_OBJECT_TYPE_LOADED_IMAGE)
3000 return EFI_EXIT(EFI_INVALID_PARAMETER);
3002 if (image_obj->auth_status != EFI_IMAGE_AUTH_PASSED)
3003 return EFI_EXIT(EFI_SECURITY_VIOLATION);
3005 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3007 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3008 if (ret != EFI_SUCCESS)
3009 return EFI_EXIT(EFI_INVALID_PARAMETER);
3011 image_obj->exit_data_size = exit_data_size;
3012 image_obj->exit_data = exit_data;
3013 image_obj->exit_status = &exit_status;
3014 image_obj->exit_jmp = &exit_jmp;
3016 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3017 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3018 ret = efi_tcg2_measure_efi_app_invocation(image_obj);
3019 if (ret != EFI_SUCCESS) {
3020 log_warning("tcg2 measurement fails(0x%lx)\n",
3026 /* call the image! */
3027 if (setjmp(&exit_jmp)) {
3029 * We called the entry point of the child image with EFI_CALL
3030 * in the lines below. The child image called the Exit() boot
3031 * service efi_exit() which executed the long jump that brought
3032 * us to the current line. This implies that the second half
3033 * of the EFI_CALL macro has not been executed.
3035 #if defined(CONFIG_ARM) || defined(CONFIG_RISCV)
3037 * efi_exit() called efi_restore_gd(). We have to undo this
3038 * otherwise __efi_entry_check() will put the wrong value into
3044 * To get ready to call EFI_EXIT below we have to execute the
3045 * missed out steps of EFI_CALL.
3047 assert(__efi_entry_check());
3048 EFI_PRINT("%lu returned by started image\n",
3049 (unsigned long)((uintptr_t)exit_status &
3051 current_image = parent_image;
3052 return EFI_EXIT(exit_status);
3055 current_image = image_handle;
3056 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
3057 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
3058 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
3061 * Control is returned from a started UEFI image either by calling
3062 * Exit() (where exit data can be provided) or by simply returning from
3063 * the entry point. In the latter case call Exit() on behalf of the
3066 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
3070 * efi_delete_image() - delete loaded image from memory)
3072 * @image_obj: handle of the loaded image
3073 * @loaded_image_protocol: loaded image protocol
3075 static efi_status_t efi_delete_image
3076 (struct efi_loaded_image_obj *image_obj,
3077 struct efi_loaded_image *loaded_image_protocol)
3079 struct efi_object *efiobj;
3080 efi_status_t r, ret = EFI_SUCCESS;
3083 list_for_each_entry(efiobj, &efi_obj_list, link) {
3084 struct efi_handler *protocol;
3086 list_for_each_entry(protocol, &efiobj->protocols, link) {
3087 struct efi_open_protocol_info_item *info;
3089 list_for_each_entry(info, &protocol->open_infos, link) {
3090 if (info->info.agent_handle !=
3091 (efi_handle_t)image_obj)
3093 r = EFI_CALL(efi_close_protocol
3094 (efiobj, protocol->guid,
3095 info->info.agent_handle,
3096 info->info.controller_handle
3098 if (r != EFI_SUCCESS)
3101 * Closing protocols may results in further
3102 * items being deleted. To play it safe loop
3103 * over all elements again.
3110 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
3111 efi_size_in_pages(loaded_image_protocol->image_size));
3112 efi_delete_handle(&image_obj->header);
3118 * efi_unload_image() - unload an EFI image
3119 * @image_handle: handle of the image to be unloaded
3121 * This function implements the UnloadImage service.
3123 * See the Unified Extensible Firmware Interface (UEFI) specification for
3126 * Return: status code
3128 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
3130 efi_status_t ret = EFI_SUCCESS;
3131 struct efi_object *efiobj;
3132 struct efi_loaded_image *loaded_image_protocol;
3134 EFI_ENTRY("%p", image_handle);
3136 efiobj = efi_search_obj(image_handle);
3138 ret = EFI_INVALID_PARAMETER;
3141 /* Find the loaded image protocol */
3142 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3143 (void **)&loaded_image_protocol,
3145 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3146 if (ret != EFI_SUCCESS) {
3147 ret = EFI_INVALID_PARAMETER;
3150 switch (efiobj->type) {
3151 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3152 /* Call the unload function */
3153 if (!loaded_image_protocol->unload) {
3154 ret = EFI_UNSUPPORTED;
3157 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
3158 if (ret != EFI_SUCCESS)
3161 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3164 ret = EFI_INVALID_PARAMETER;
3167 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
3168 loaded_image_protocol);
3170 return EFI_EXIT(ret);
3174 * efi_update_exit_data() - fill exit data parameters of StartImage()
3176 * @image_obj: image handle
3177 * @exit_data_size: size of the exit data buffer
3178 * @exit_data: buffer with data returned by UEFI payload
3179 * Return: status code
3181 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
3182 efi_uintn_t exit_data_size,
3188 * If exit_data is not provided to StartImage(), exit_data_size must be
3191 if (!image_obj->exit_data)
3193 if (image_obj->exit_data_size)
3194 *image_obj->exit_data_size = exit_data_size;
3195 if (exit_data_size && exit_data) {
3196 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3198 (void **)image_obj->exit_data);
3199 if (ret != EFI_SUCCESS)
3201 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3203 image_obj->exit_data = NULL;
3209 * efi_exit() - leave an EFI application or driver
3210 * @image_handle: handle of the application or driver that is exiting
3211 * @exit_status: status code
3212 * @exit_data_size: size of the buffer in bytes
3213 * @exit_data: buffer with data describing an error
3215 * This function implements the Exit service.
3217 * See the Unified Extensible Firmware Interface (UEFI) specification for
3220 * Return: status code
3222 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3223 efi_status_t exit_status,
3224 efi_uintn_t exit_data_size,
3228 * TODO: We should call the unload procedure of the loaded
3232 struct efi_loaded_image *loaded_image_protocol;
3233 struct efi_loaded_image_obj *image_obj =
3234 (struct efi_loaded_image_obj *)image_handle;
3235 struct jmp_buf_data *exit_jmp;
3237 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3238 exit_data_size, exit_data);
3240 /* Check parameters */
3241 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3242 (void **)&loaded_image_protocol,
3244 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3245 if (ret != EFI_SUCCESS) {
3246 ret = EFI_INVALID_PARAMETER;
3250 /* Unloading of unstarted images */
3251 switch (image_obj->header.type) {
3252 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3254 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3255 efi_delete_image(image_obj, loaded_image_protocol);
3259 /* Handle does not refer to loaded image */
3260 ret = EFI_INVALID_PARAMETER;
3263 /* A started image can only be unloaded it is the last one started. */
3264 if (image_handle != current_image) {
3265 ret = EFI_INVALID_PARAMETER;
3269 /* Exit data is only foreseen in case of failure. */
3270 if (exit_status != EFI_SUCCESS) {
3271 ret = efi_update_exit_data(image_obj, exit_data_size,
3273 /* Exiting has priority. Don't return error to caller. */
3274 if (ret != EFI_SUCCESS)
3275 EFI_PRINT("%s: out of memory\n", __func__);
3277 /* efi_delete_image() frees image_obj. Copy before the call. */
3278 exit_jmp = image_obj->exit_jmp;
3279 *image_obj->exit_status = exit_status;
3280 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3281 exit_status != EFI_SUCCESS)
3282 efi_delete_image(image_obj, loaded_image_protocol);
3284 if (IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL)) {
3285 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION) {
3286 ret = efi_tcg2_measure_efi_app_exit();
3287 if (ret != EFI_SUCCESS) {
3288 log_warning("tcg2 measurement fails(0x%lx)\n",
3294 /* Make sure entry/exit counts for EFI world cross-overs match */
3295 EFI_EXIT(exit_status);
3298 * But longjmp out with the U-Boot gd, not the application's, as
3299 * the other end is a setjmp call inside EFI context.
3303 longjmp(exit_jmp, 1);
3305 panic("EFI application exited");
3307 return EFI_EXIT(ret);
3311 * efi_handle_protocol() - get interface of a protocol on a handle
3312 * @handle: handle on which the protocol shall be opened
3313 * @protocol: GUID of the protocol
3314 * @protocol_interface: interface implementing the protocol
3316 * This function implements the HandleProtocol service.
3318 * See the Unified Extensible Firmware Interface (UEFI) specification for
3321 * Return: status code
3323 efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
3324 const efi_guid_t *protocol,
3325 void **protocol_interface)
3327 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
3328 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
3332 * efi_bind_controller() - bind a single driver to a controller
3333 * @controller_handle: controller handle
3334 * @driver_image_handle: driver handle
3335 * @remain_device_path: remaining path
3337 * Return: status code
3339 static efi_status_t efi_bind_controller(
3340 efi_handle_t controller_handle,
3341 efi_handle_t driver_image_handle,
3342 struct efi_device_path *remain_device_path)
3344 struct efi_driver_binding_protocol *binding_protocol;
3347 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3348 &efi_guid_driver_binding_protocol,
3349 (void **)&binding_protocol,
3350 driver_image_handle, NULL,
3351 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3352 if (r != EFI_SUCCESS)
3354 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3356 remain_device_path));
3357 if (r == EFI_SUCCESS)
3358 r = EFI_CALL(binding_protocol->start(binding_protocol,
3360 remain_device_path));
3361 EFI_CALL(efi_close_protocol(driver_image_handle,
3362 &efi_guid_driver_binding_protocol,
3363 driver_image_handle, NULL));
3368 * efi_connect_single_controller() - connect a single driver to a controller
3369 * @controller_handle: controller
3370 * @driver_image_handle: driver
3371 * @remain_device_path: remaining path
3373 * Return: status code
3375 static efi_status_t efi_connect_single_controller(
3376 efi_handle_t controller_handle,
3377 efi_handle_t *driver_image_handle,
3378 struct efi_device_path *remain_device_path)
3380 efi_handle_t *buffer;
3384 size_t connected = 0;
3386 /* Get buffer with all handles with driver binding protocol */
3387 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3388 &efi_guid_driver_binding_protocol,
3389 NULL, &count, &buffer));
3390 if (r != EFI_SUCCESS)
3393 /* Context Override */
3394 if (driver_image_handle) {
3395 for (; *driver_image_handle; ++driver_image_handle) {
3396 for (i = 0; i < count; ++i) {
3397 if (buffer[i] == *driver_image_handle) {
3399 r = efi_bind_controller(
3401 *driver_image_handle,
3402 remain_device_path);
3404 * For drivers that do not support the
3405 * controller or are already connected
3406 * we receive an error code here.
3408 if (r == EFI_SUCCESS)
3416 * TODO: Some overrides are not yet implemented:
3417 * - Platform Driver Override
3418 * - Driver Family Override Search
3419 * - Bus Specific Driver Override
3422 /* Driver Binding Search */
3423 for (i = 0; i < count; ++i) {
3425 r = efi_bind_controller(controller_handle,
3427 remain_device_path);
3428 if (r == EFI_SUCCESS)
3433 efi_free_pool(buffer);
3435 return EFI_NOT_FOUND;
3440 * efi_connect_controller() - connect a controller to a driver
3441 * @controller_handle: handle of the controller
3442 * @driver_image_handle: handle of the driver
3443 * @remain_device_path: device path of a child controller
3444 * @recursive: true to connect all child controllers
3446 * This function implements the ConnectController service.
3448 * See the Unified Extensible Firmware Interface (UEFI) specification for
3451 * First all driver binding protocol handles are tried for binding drivers.
3452 * Afterwards all handles that have opened a protocol of the controller
3453 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3455 * Return: status code
3457 static efi_status_t EFIAPI efi_connect_controller(
3458 efi_handle_t controller_handle,
3459 efi_handle_t *driver_image_handle,
3460 struct efi_device_path *remain_device_path,
3464 efi_status_t ret = EFI_NOT_FOUND;
3465 struct efi_object *efiobj;
3467 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3468 remain_device_path, recursive);
3470 efiobj = efi_search_obj(controller_handle);
3472 ret = EFI_INVALID_PARAMETER;
3476 r = efi_connect_single_controller(controller_handle,
3477 driver_image_handle,
3478 remain_device_path);
3479 if (r == EFI_SUCCESS)
3482 struct efi_handler *handler;
3483 struct efi_open_protocol_info_item *item;
3485 list_for_each_entry(handler, &efiobj->protocols, link) {
3486 list_for_each_entry(item, &handler->open_infos, link) {
3487 if (item->info.attributes &
3488 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3489 r = EFI_CALL(efi_connect_controller(
3490 item->info.controller_handle,
3491 driver_image_handle,
3494 if (r == EFI_SUCCESS)
3500 /* Check for child controller specified by end node */
3501 if (ret != EFI_SUCCESS && remain_device_path &&
3502 remain_device_path->type == DEVICE_PATH_TYPE_END)
3505 return EFI_EXIT(ret);
3509 * efi_reinstall_protocol_interface() - reinstall protocol interface
3510 * @handle: handle on which the protocol shall be reinstalled
3511 * @protocol: GUID of the protocol to be installed
3512 * @old_interface: interface to be removed
3513 * @new_interface: interface to be installed
3515 * This function implements the ReinstallProtocolInterface service.
3517 * See the Unified Extensible Firmware Interface (UEFI) specification for
3520 * The old interface is uninstalled. The new interface is installed.
3521 * Drivers are connected.
3523 * Return: status code
3525 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3526 efi_handle_t handle, const efi_guid_t *protocol,
3527 void *old_interface, void *new_interface)
3531 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3534 /* Uninstall protocol but do not delete handle */
3535 ret = efi_uninstall_protocol(handle, protocol, old_interface);
3536 if (ret != EFI_SUCCESS)
3539 /* Install the new protocol */
3540 ret = efi_add_protocol(handle, protocol, new_interface);
3542 * The UEFI spec does not specify what should happen to the handle
3543 * if in case of an error no protocol interface remains on the handle.
3544 * So let's do nothing here.
3546 if (ret != EFI_SUCCESS)
3549 * The returned status code has to be ignored.
3550 * Do not create an error if no suitable driver for the handle exists.
3552 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3554 return EFI_EXIT(ret);
3558 * efi_get_child_controllers() - get all child controllers associated to a driver
3559 * @efiobj: handle of the controller
3560 * @driver_handle: handle of the driver
3561 * @number_of_children: number of child controllers
3562 * @child_handle_buffer: handles of the the child controllers
3564 * The allocated buffer has to be freed with free().
3566 * Return: status code
3568 static efi_status_t efi_get_child_controllers(
3569 struct efi_object *efiobj,
3570 efi_handle_t driver_handle,
3571 efi_uintn_t *number_of_children,
3572 efi_handle_t **child_handle_buffer)
3574 struct efi_handler *handler;
3575 struct efi_open_protocol_info_item *item;
3576 efi_uintn_t count = 0, i;
3579 /* Count all child controller associations */
3580 list_for_each_entry(handler, &efiobj->protocols, link) {
3581 list_for_each_entry(item, &handler->open_infos, link) {
3582 if (item->info.agent_handle == driver_handle &&
3583 item->info.attributes &
3584 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3589 * Create buffer. In case of duplicate child controller assignments
3590 * the buffer will be too large. But that does not harm.
3592 *number_of_children = 0;
3595 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3596 if (!*child_handle_buffer)
3597 return EFI_OUT_OF_RESOURCES;
3598 /* Copy unique child handles */
3599 list_for_each_entry(handler, &efiobj->protocols, link) {
3600 list_for_each_entry(item, &handler->open_infos, link) {
3601 if (item->info.agent_handle == driver_handle &&
3602 item->info.attributes &
3603 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3604 /* Check this is a new child controller */
3606 for (i = 0; i < *number_of_children; ++i) {
3607 if ((*child_handle_buffer)[i] ==
3608 item->info.controller_handle)
3611 /* Copy handle to buffer */
3613 i = (*number_of_children)++;
3614 (*child_handle_buffer)[i] =
3615 item->info.controller_handle;
3624 * efi_disconnect_controller() - disconnect a controller from a driver
3625 * @controller_handle: handle of the controller
3626 * @driver_image_handle: handle of the driver
3627 * @child_handle: handle of the child to destroy
3629 * This function implements the DisconnectController service.
3631 * See the Unified Extensible Firmware Interface (UEFI) specification for
3634 * Return: status code
3636 static efi_status_t EFIAPI efi_disconnect_controller(
3637 efi_handle_t controller_handle,
3638 efi_handle_t driver_image_handle,
3639 efi_handle_t child_handle)
3641 struct efi_driver_binding_protocol *binding_protocol;
3642 efi_handle_t *child_handle_buffer = NULL;
3643 size_t number_of_children = 0;
3645 struct efi_object *efiobj;
3648 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3651 efiobj = efi_search_obj(controller_handle);
3653 r = EFI_INVALID_PARAMETER;
3657 if (child_handle && !efi_search_obj(child_handle)) {
3658 r = EFI_INVALID_PARAMETER;
3662 /* If no driver handle is supplied, disconnect all drivers */
3663 if (!driver_image_handle) {
3664 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3668 /* Create list of child handles */
3669 r = efi_get_child_controllers(efiobj,
3670 driver_image_handle,
3671 &number_of_children,
3672 &child_handle_buffer);
3673 if (r != EFI_SUCCESS)
3675 sole_child = (number_of_children == 1);
3678 number_of_children = 1;
3679 free(child_handle_buffer);
3680 child_handle_buffer = &child_handle;
3683 /* Get the driver binding protocol */
3684 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3685 &efi_guid_driver_binding_protocol,
3686 (void **)&binding_protocol,
3687 driver_image_handle, NULL,
3688 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3689 if (r != EFI_SUCCESS) {
3690 r = EFI_INVALID_PARAMETER;
3693 /* Remove the children */
3694 if (number_of_children) {
3695 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3698 child_handle_buffer));
3699 if (r != EFI_SUCCESS) {
3700 r = EFI_DEVICE_ERROR;
3704 /* Remove the driver */
3705 if (!child_handle || sole_child) {
3706 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3709 if (r != EFI_SUCCESS) {
3710 r = EFI_DEVICE_ERROR;
3714 EFI_CALL(efi_close_protocol(driver_image_handle,
3715 &efi_guid_driver_binding_protocol,
3716 driver_image_handle, NULL));
3720 free(child_handle_buffer);
3724 static struct efi_boot_services efi_boot_services = {
3726 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3727 .revision = EFI_SPECIFICATION_VERSION,
3728 .headersize = sizeof(struct efi_boot_services),
3730 .raise_tpl = efi_raise_tpl,
3731 .restore_tpl = efi_restore_tpl,
3732 .allocate_pages = efi_allocate_pages_ext,
3733 .free_pages = efi_free_pages_ext,
3734 .get_memory_map = efi_get_memory_map_ext,
3735 .allocate_pool = efi_allocate_pool_ext,
3736 .free_pool = efi_free_pool_ext,
3737 .create_event = efi_create_event_ext,
3738 .set_timer = efi_set_timer_ext,
3739 .wait_for_event = efi_wait_for_event,
3740 .signal_event = efi_signal_event_ext,
3741 .close_event = efi_close_event,
3742 .check_event = efi_check_event,
3743 .install_protocol_interface = efi_install_protocol_interface,
3744 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3745 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3746 .handle_protocol = efi_handle_protocol,
3748 .register_protocol_notify = efi_register_protocol_notify,
3749 .locate_handle = efi_locate_handle_ext,
3750 .locate_device_path = efi_locate_device_path,
3751 .install_configuration_table = efi_install_configuration_table_ext,
3752 .load_image = efi_load_image,
3753 .start_image = efi_start_image,
3755 .unload_image = efi_unload_image,
3756 .exit_boot_services = efi_exit_boot_services,
3757 .get_next_monotonic_count = efi_get_next_monotonic_count,
3759 .set_watchdog_timer = efi_set_watchdog_timer,
3760 .connect_controller = efi_connect_controller,
3761 .disconnect_controller = efi_disconnect_controller,
3762 .open_protocol = efi_open_protocol,
3763 .close_protocol = efi_close_protocol,
3764 .open_protocol_information = efi_open_protocol_information,
3765 .protocols_per_handle = efi_protocols_per_handle,
3766 .locate_handle_buffer = efi_locate_handle_buffer,
3767 .locate_protocol = efi_locate_protocol,
3768 .install_multiple_protocol_interfaces =
3769 efi_install_multiple_protocol_interfaces,
3770 .uninstall_multiple_protocol_interfaces =
3771 efi_uninstall_multiple_protocol_interfaces,
3772 .calculate_crc32 = efi_calculate_crc32,
3773 .copy_mem = efi_copy_mem,
3774 .set_mem = efi_set_mem,
3775 .create_event_ex = efi_create_event_ex,
3778 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3780 struct efi_system_table __efi_runtime_data systab = {
3782 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3783 .revision = EFI_SPECIFICATION_VERSION,
3784 .headersize = sizeof(struct efi_system_table),
3786 .fw_vendor = firmware_vendor,
3787 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3788 .runtime = &efi_runtime_services,
3794 * efi_initialize_system_table() - Initialize system table
3796 * Return: status code
3798 efi_status_t efi_initialize_system_table(void)
3802 /* Allocate configuration table array */
3803 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3804 EFI_MAX_CONFIGURATION_TABLES *
3805 sizeof(struct efi_configuration_table),
3806 (void **)&systab.tables);
3809 * These entries will be set to NULL in ExitBootServices(). To avoid
3810 * relocation in SetVirtualAddressMap(), set them dynamically.
3812 systab.con_in = &efi_con_in;
3813 systab.con_out = &efi_con_out;
3814 systab.std_err = &efi_con_out;
3815 systab.boottime = &efi_boot_services;
3817 /* Set CRC32 field in table headers */
3818 efi_update_table_header_crc32(&systab.hdr);
3819 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3820 efi_update_table_header_crc32(&efi_boot_services.hdr);