1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application boot time services
5 * Copyright (c) 2016 Alexander Graf
10 #include <efi_loader.h>
11 #include <environment.h>
13 #include <linux/libfdt_env.h>
14 #include <u-boot/crc.h>
18 DECLARE_GLOBAL_DATA_PTR;
20 /* Task priority level */
21 static efi_uintn_t efi_tpl = TPL_APPLICATION;
23 /* This list contains all the EFI objects our payload has access to */
24 LIST_HEAD(efi_obj_list);
26 /* List of all events */
27 LIST_HEAD(efi_events);
30 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
31 * we need to do trickery with caches. Since we don't want to break the EFI
32 * aware boot path, only apply hacks when loading exiting directly (breaking
33 * direct Linux EFI booting along the way - oh well).
35 static bool efi_is_direct_boot = true;
39 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
40 * fixed when compiling U-Boot. However, the payload does not know about that
41 * restriction so we need to manually swap its and our view of that register on
42 * EFI callback entry/exit.
44 static volatile void *efi_gd, *app_gd;
47 static int entry_count;
48 static int nesting_level;
49 /* GUID of the device tree table */
50 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
51 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
52 const efi_guid_t efi_guid_driver_binding_protocol =
53 EFI_DRIVER_BINDING_PROTOCOL_GUID;
55 /* event group ExitBootServices() invoked */
56 const efi_guid_t efi_guid_event_group_exit_boot_services =
57 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
58 /* event group SetVirtualAddressMap() invoked */
59 const efi_guid_t efi_guid_event_group_virtual_address_change =
60 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
61 /* event group memory map changed */
62 const efi_guid_t efi_guid_event_group_memory_map_change =
63 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
64 /* event group boot manager about to boot */
65 const efi_guid_t efi_guid_event_group_ready_to_boot =
66 EFI_EVENT_GROUP_READY_TO_BOOT;
67 /* event group ResetSystem() invoked (before ExitBootServices) */
68 const efi_guid_t efi_guid_event_group_reset_system =
69 EFI_EVENT_GROUP_RESET_SYSTEM;
71 static efi_status_t EFIAPI efi_disconnect_controller(
72 efi_handle_t controller_handle,
73 efi_handle_t driver_image_handle,
74 efi_handle_t child_handle);
76 /* Called on every callback entry */
77 int __efi_entry_check(void)
79 int ret = entry_count++ == 0;
88 /* Called on every callback exit */
89 int __efi_exit_check(void)
91 int ret = --entry_count == 0;
98 /* Called from do_bootefi_exec() */
99 void efi_save_gd(void)
107 * Special case handler for error/abort that just forces things back to u-boot
108 * world so we can dump out an abort message, without any care about returning
109 * back to UEFI world.
111 void efi_restore_gd(void)
114 /* Only restore if we're already in EFI context */
122 * indent_string() - returns a string for indenting with two spaces per level
123 * @level: indent level
125 * A maximum of ten indent levels is supported. Higher indent levels will be
128 * Return: A string for indenting with two spaces per level is
131 static const char *indent_string(int level)
133 const char *indent = " ";
134 const int max = strlen(indent);
136 level = min(max, level * 2);
137 return &indent[max - level];
140 const char *__efi_nesting(void)
142 return indent_string(nesting_level);
145 const char *__efi_nesting_inc(void)
147 return indent_string(nesting_level++);
150 const char *__efi_nesting_dec(void)
152 return indent_string(--nesting_level);
156 * efi_queue_event() - queue an EFI event
157 * @event: event to signal
158 * @check_tpl: check the TPL level
160 * This function queues the notification function of the event for future
163 * The notification function is called if the task priority level of the event
164 * is higher than the current task priority level.
166 * For the SignalEvent service see efi_signal_event_ext.
169 static void efi_queue_event(struct efi_event *event, bool check_tpl)
171 if (event->notify_function) {
172 event->is_queued = true;
174 if (check_tpl && efi_tpl >= event->notify_tpl)
176 EFI_CALL_VOID(event->notify_function(event,
177 event->notify_context));
179 event->is_queued = false;
183 * is_valid_tpl() - check if the task priority level is valid
185 * @tpl: TPL level to check
186 * Return: status code
188 efi_status_t is_valid_tpl(efi_uintn_t tpl)
191 case TPL_APPLICATION:
197 return EFI_INVALID_PARAMETER;
202 * efi_signal_event() - signal an EFI event
203 * @event: event to signal
204 * @check_tpl: check the TPL level
206 * This function signals an event. If the event belongs to an event group all
207 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
208 * their notification function is queued.
210 * For the SignalEvent service see efi_signal_event_ext.
212 void efi_signal_event(struct efi_event *event, bool check_tpl)
215 struct efi_event *evt;
218 * The signaled state has to set before executing any
219 * notification function
221 list_for_each_entry(evt, &efi_events, link) {
222 if (!evt->group || guidcmp(evt->group, event->group))
224 if (evt->is_signaled)
226 evt->is_signaled = true;
227 if (evt->type & EVT_NOTIFY_SIGNAL &&
228 evt->notify_function)
229 evt->is_queued = true;
231 list_for_each_entry(evt, &efi_events, link) {
232 if (!evt->group || guidcmp(evt->group, event->group))
235 efi_queue_event(evt, check_tpl);
237 } else if (!event->is_signaled) {
238 event->is_signaled = true;
239 if (event->type & EVT_NOTIFY_SIGNAL)
240 efi_queue_event(event, check_tpl);
245 * efi_raise_tpl() - raise the task priority level
246 * @new_tpl: new value of the task priority level
248 * This function implements the RaiseTpl service.
250 * See the Unified Extensible Firmware Interface (UEFI) specification for
253 * Return: old value of the task priority level
255 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
257 efi_uintn_t old_tpl = efi_tpl;
259 EFI_ENTRY("0x%zx", new_tpl);
261 if (new_tpl < efi_tpl)
262 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
264 if (efi_tpl > TPL_HIGH_LEVEL)
265 efi_tpl = TPL_HIGH_LEVEL;
267 EFI_EXIT(EFI_SUCCESS);
272 * efi_restore_tpl() - lower the task priority level
273 * @old_tpl: value of the task priority level to be restored
275 * This function implements the RestoreTpl service.
277 * See the Unified Extensible Firmware Interface (UEFI) specification for
280 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
282 EFI_ENTRY("0x%zx", old_tpl);
284 if (old_tpl > efi_tpl)
285 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
287 if (efi_tpl > TPL_HIGH_LEVEL)
288 efi_tpl = TPL_HIGH_LEVEL;
291 * Lowering the TPL may have made queued events eligible for execution.
295 EFI_EXIT(EFI_SUCCESS);
299 * efi_allocate_pages_ext() - allocate memory pages
300 * @type: type of allocation to be performed
301 * @memory_type: usage type of the allocated memory
302 * @pages: number of pages to be allocated
303 * @memory: allocated memory
305 * This function implements the AllocatePages service.
307 * See the Unified Extensible Firmware Interface (UEFI) specification for
310 * Return: status code
312 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
318 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
319 r = efi_allocate_pages(type, memory_type, pages, memory);
324 * efi_free_pages_ext() - Free memory pages.
325 * @memory: start of the memory area to be freed
326 * @pages: number of pages to be freed
328 * This function implements the FreePages service.
330 * See the Unified Extensible Firmware Interface (UEFI) specification for
333 * Return: status code
335 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
340 EFI_ENTRY("%llx, 0x%zx", memory, pages);
341 r = efi_free_pages(memory, pages);
346 * efi_get_memory_map_ext() - get map describing memory usage
347 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
348 * on exit the size of the copied memory map
349 * @memory_map: buffer to which the memory map is written
350 * @map_key: key for the memory map
351 * @descriptor_size: size of an individual memory descriptor
352 * @descriptor_version: version number of the memory descriptor structure
354 * This function implements the GetMemoryMap service.
356 * See the Unified Extensible Firmware Interface (UEFI) specification for
359 * Return: status code
361 static efi_status_t EFIAPI efi_get_memory_map_ext(
362 efi_uintn_t *memory_map_size,
363 struct efi_mem_desc *memory_map,
364 efi_uintn_t *map_key,
365 efi_uintn_t *descriptor_size,
366 uint32_t *descriptor_version)
370 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
371 map_key, descriptor_size, descriptor_version);
372 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
373 descriptor_size, descriptor_version);
378 * efi_allocate_pool_ext() - allocate memory from pool
379 * @pool_type: type of the pool from which memory is to be allocated
380 * @size: number of bytes to be allocated
381 * @buffer: allocated memory
383 * This function implements the AllocatePool service.
385 * See the Unified Extensible Firmware Interface (UEFI) specification for
388 * Return: status code
390 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
396 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
397 r = efi_allocate_pool(pool_type, size, buffer);
402 * efi_free_pool_ext() - free memory from pool
403 * @buffer: start of memory to be freed
405 * This function implements the FreePool service.
407 * See the Unified Extensible Firmware Interface (UEFI) specification for
410 * Return: status code
412 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
416 EFI_ENTRY("%p", buffer);
417 r = efi_free_pool(buffer);
422 * efi_add_handle() - add a new object to the object list
423 * @obj: object to be added
425 * The protocols list is initialized. The object handle is set.
427 void efi_add_handle(efi_handle_t handle)
431 INIT_LIST_HEAD(&handle->protocols);
432 list_add_tail(&handle->link, &efi_obj_list);
436 * efi_create_handle() - create handle
437 * @handle: new handle
439 * Return: status code
441 efi_status_t efi_create_handle(efi_handle_t *handle)
443 struct efi_object *obj;
445 obj = calloc(1, sizeof(struct efi_object));
447 return EFI_OUT_OF_RESOURCES;
456 * efi_search_protocol() - find a protocol on a handle.
458 * @protocol_guid: GUID of the protocol
459 * @handler: reference to the protocol
461 * Return: status code
463 efi_status_t efi_search_protocol(const efi_handle_t handle,
464 const efi_guid_t *protocol_guid,
465 struct efi_handler **handler)
467 struct efi_object *efiobj;
468 struct list_head *lhandle;
470 if (!handle || !protocol_guid)
471 return EFI_INVALID_PARAMETER;
472 efiobj = efi_search_obj(handle);
474 return EFI_INVALID_PARAMETER;
475 list_for_each(lhandle, &efiobj->protocols) {
476 struct efi_handler *protocol;
478 protocol = list_entry(lhandle, struct efi_handler, link);
479 if (!guidcmp(protocol->guid, protocol_guid)) {
485 return EFI_NOT_FOUND;
489 * efi_remove_protocol() - delete protocol from a handle
490 * @handle: handle from which the protocol shall be deleted
491 * @protocol: GUID of the protocol to be deleted
492 * @protocol_interface: interface of the protocol implementation
494 * Return: status code
496 efi_status_t efi_remove_protocol(const efi_handle_t handle,
497 const efi_guid_t *protocol,
498 void *protocol_interface)
500 struct efi_handler *handler;
503 ret = efi_search_protocol(handle, protocol, &handler);
504 if (ret != EFI_SUCCESS)
506 if (guidcmp(handler->guid, protocol))
507 return EFI_INVALID_PARAMETER;
508 if (handler->protocol_interface != protocol_interface)
509 return EFI_INVALID_PARAMETER;
510 list_del(&handler->link);
516 * efi_remove_all_protocols() - delete all protocols from a handle
517 * @handle: handle from which the protocols shall be deleted
519 * Return: status code
521 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
523 struct efi_object *efiobj;
524 struct efi_handler *protocol;
525 struct efi_handler *pos;
527 efiobj = efi_search_obj(handle);
529 return EFI_INVALID_PARAMETER;
530 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
533 ret = efi_remove_protocol(handle, protocol->guid,
534 protocol->protocol_interface);
535 if (ret != EFI_SUCCESS)
542 * efi_delete_handle() - delete handle
544 * @obj: handle to delete
546 void efi_delete_handle(efi_handle_t handle)
550 efi_remove_all_protocols(handle);
551 list_del(&handle->link);
556 * efi_is_event() - check if a pointer is a valid event
557 * @event: pointer to check
559 * Return: status code
561 static efi_status_t efi_is_event(const struct efi_event *event)
563 const struct efi_event *evt;
566 return EFI_INVALID_PARAMETER;
567 list_for_each_entry(evt, &efi_events, link) {
571 return EFI_INVALID_PARAMETER;
575 * efi_create_event() - create an event
576 * @type: type of the event to create
577 * @notify_tpl: task priority level of the event
578 * @notify_function: notification function of the event
579 * @notify_context: pointer passed to the notification function
580 * @group: event group
581 * @event: created event
583 * This function is used inside U-Boot code to create an event.
585 * For the API function implementing the CreateEvent service see
586 * efi_create_event_ext.
588 * Return: status code
590 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
591 void (EFIAPI *notify_function) (
592 struct efi_event *event,
594 void *notify_context, efi_guid_t *group,
595 struct efi_event **event)
597 struct efi_event *evt;
600 return EFI_INVALID_PARAMETER;
605 case EVT_NOTIFY_SIGNAL:
606 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
607 case EVT_NOTIFY_WAIT:
608 case EVT_TIMER | EVT_NOTIFY_WAIT:
609 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
610 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
613 return EFI_INVALID_PARAMETER;
616 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
617 (is_valid_tpl(notify_tpl) != EFI_SUCCESS))
618 return EFI_INVALID_PARAMETER;
620 evt = calloc(1, sizeof(struct efi_event));
622 return EFI_OUT_OF_RESOURCES;
624 evt->notify_tpl = notify_tpl;
625 evt->notify_function = notify_function;
626 evt->notify_context = notify_context;
628 /* Disable timers on boot up */
629 evt->trigger_next = -1ULL;
630 evt->is_queued = false;
631 evt->is_signaled = false;
632 list_add_tail(&evt->link, &efi_events);
638 * efi_create_event_ex() - create an event in a group
639 * @type: type of the event to create
640 * @notify_tpl: task priority level of the event
641 * @notify_function: notification function of the event
642 * @notify_context: pointer passed to the notification function
643 * @event: created event
644 * @event_group: event group
646 * This function implements the CreateEventEx service.
648 * See the Unified Extensible Firmware Interface (UEFI) specification for
651 * Return: status code
653 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
654 void (EFIAPI *notify_function) (
655 struct efi_event *event,
657 void *notify_context,
658 efi_guid_t *event_group,
659 struct efi_event **event)
661 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
662 notify_context, event_group);
663 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
664 notify_context, event_group, event));
668 * efi_create_event_ext() - create an event
669 * @type: type of the event to create
670 * @notify_tpl: task priority level of the event
671 * @notify_function: notification function of the event
672 * @notify_context: pointer passed to the notification function
673 * @event: created event
675 * This function implements the CreateEvent service.
677 * See the Unified Extensible Firmware Interface (UEFI) specification for
680 * Return: status code
682 static efi_status_t EFIAPI efi_create_event_ext(
683 uint32_t type, efi_uintn_t notify_tpl,
684 void (EFIAPI *notify_function) (
685 struct efi_event *event,
687 void *notify_context, struct efi_event **event)
689 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
691 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
692 notify_context, NULL, event));
696 * efi_timer_check() - check if a timer event has occurred
698 * Check if a timer event has occurred or a queued notification function should
701 * Our timers have to work without interrupts, so we check whenever keyboard
702 * input or disk accesses happen if enough time elapsed for them to fire.
704 void efi_timer_check(void)
706 struct efi_event *evt;
707 u64 now = timer_get_us();
709 list_for_each_entry(evt, &efi_events, link) {
711 efi_queue_event(evt, true);
712 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
714 switch (evt->trigger_type) {
715 case EFI_TIMER_RELATIVE:
716 evt->trigger_type = EFI_TIMER_STOP;
718 case EFI_TIMER_PERIODIC:
719 evt->trigger_next += evt->trigger_time;
724 evt->is_signaled = false;
725 efi_signal_event(evt, true);
731 * efi_set_timer() - set the trigger time for a timer event or stop the event
732 * @event: event for which the timer is set
733 * @type: type of the timer
734 * @trigger_time: trigger period in multiples of 100 ns
736 * This is the function for internal usage in U-Boot. For the API function
737 * implementing the SetTimer service see efi_set_timer_ext.
739 * Return: status code
741 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
742 uint64_t trigger_time)
744 /* Check that the event is valid */
745 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
746 return EFI_INVALID_PARAMETER;
749 * The parameter defines a multiple of 100 ns.
750 * We use multiples of 1000 ns. So divide by 10.
752 do_div(trigger_time, 10);
756 event->trigger_next = -1ULL;
758 case EFI_TIMER_PERIODIC:
759 case EFI_TIMER_RELATIVE:
760 event->trigger_next = timer_get_us() + trigger_time;
763 return EFI_INVALID_PARAMETER;
765 event->trigger_type = type;
766 event->trigger_time = trigger_time;
767 event->is_signaled = false;
772 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
774 * @event: event for which the timer is set
775 * @type: type of the timer
776 * @trigger_time: trigger period in multiples of 100 ns
778 * This function implements the SetTimer service.
780 * See the Unified Extensible Firmware Interface (UEFI) specification for
784 * Return: status code
786 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
787 enum efi_timer_delay type,
788 uint64_t trigger_time)
790 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
791 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
795 * efi_wait_for_event() - wait for events to be signaled
796 * @num_events: number of events to be waited for
797 * @event: events to be waited for
798 * @index: index of the event that was signaled
800 * This function implements the WaitForEvent service.
802 * See the Unified Extensible Firmware Interface (UEFI) specification for
805 * Return: status code
807 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
808 struct efi_event **event,
813 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
815 /* Check parameters */
816 if (!num_events || !event)
817 return EFI_EXIT(EFI_INVALID_PARAMETER);
819 if (efi_tpl != TPL_APPLICATION)
820 return EFI_EXIT(EFI_UNSUPPORTED);
821 for (i = 0; i < num_events; ++i) {
822 if (efi_is_event(event[i]) != EFI_SUCCESS)
823 return EFI_EXIT(EFI_INVALID_PARAMETER);
824 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
825 return EFI_EXIT(EFI_INVALID_PARAMETER);
826 if (!event[i]->is_signaled)
827 efi_queue_event(event[i], true);
830 /* Wait for signal */
832 for (i = 0; i < num_events; ++i) {
833 if (event[i]->is_signaled)
836 /* Allow events to occur. */
842 * Reset the signal which is passed to the caller to allow periodic
845 event[i]->is_signaled = false;
849 return EFI_EXIT(EFI_SUCCESS);
853 * efi_signal_event_ext() - signal an EFI event
854 * @event: event to signal
856 * This function implements the SignalEvent service.
858 * See the Unified Extensible Firmware Interface (UEFI) specification for
861 * This functions sets the signaled state of the event and queues the
862 * notification function for execution.
864 * Return: status code
866 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
868 EFI_ENTRY("%p", event);
869 if (efi_is_event(event) != EFI_SUCCESS)
870 return EFI_EXIT(EFI_INVALID_PARAMETER);
871 efi_signal_event(event, true);
872 return EFI_EXIT(EFI_SUCCESS);
876 * efi_close_event() - close an EFI event
877 * @event: event to close
879 * This function implements the CloseEvent service.
881 * See the Unified Extensible Firmware Interface (UEFI) specification for
884 * Return: status code
886 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
888 EFI_ENTRY("%p", event);
889 if (efi_is_event(event) != EFI_SUCCESS)
890 return EFI_EXIT(EFI_INVALID_PARAMETER);
891 list_del(&event->link);
893 return EFI_EXIT(EFI_SUCCESS);
897 * efi_check_event() - check if an event is signaled
898 * @event: event to check
900 * This function implements the CheckEvent service.
902 * See the Unified Extensible Firmware Interface (UEFI) specification for
905 * If an event is not signaled yet, the notification function is queued. The
906 * signaled state is cleared.
908 * Return: status code
910 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
912 EFI_ENTRY("%p", event);
914 if (efi_is_event(event) != EFI_SUCCESS ||
915 event->type & EVT_NOTIFY_SIGNAL)
916 return EFI_EXIT(EFI_INVALID_PARAMETER);
917 if (!event->is_signaled)
918 efi_queue_event(event, true);
919 if (event->is_signaled) {
920 event->is_signaled = false;
921 return EFI_EXIT(EFI_SUCCESS);
923 return EFI_EXIT(EFI_NOT_READY);
927 * efi_search_obj() - find the internal EFI object for a handle
928 * @handle: handle to find
932 struct efi_object *efi_search_obj(const efi_handle_t handle)
934 struct efi_object *efiobj;
936 list_for_each_entry(efiobj, &efi_obj_list, link) {
937 if (efiobj == handle)
945 * efi_open_protocol_info_entry() - create open protocol info entry and add it
947 * @handler: handler of a protocol
949 * Return: open protocol info entry
951 static struct efi_open_protocol_info_entry *efi_create_open_info(
952 struct efi_handler *handler)
954 struct efi_open_protocol_info_item *item;
956 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
959 /* Append the item to the open protocol info list. */
960 list_add_tail(&item->link, &handler->open_infos);
966 * efi_delete_open_info() - remove an open protocol info entry from a protocol
967 * @item: open protocol info entry to delete
969 * Return: status code
971 static efi_status_t efi_delete_open_info(
972 struct efi_open_protocol_info_item *item)
974 list_del(&item->link);
980 * efi_add_protocol() - install new protocol on a handle
981 * @handle: handle on which the protocol shall be installed
982 * @protocol: GUID of the protocol to be installed
983 * @protocol_interface: interface of the protocol implementation
985 * Return: status code
987 efi_status_t efi_add_protocol(const efi_handle_t handle,
988 const efi_guid_t *protocol,
989 void *protocol_interface)
991 struct efi_object *efiobj;
992 struct efi_handler *handler;
995 efiobj = efi_search_obj(handle);
997 return EFI_INVALID_PARAMETER;
998 ret = efi_search_protocol(handle, protocol, NULL);
999 if (ret != EFI_NOT_FOUND)
1000 return EFI_INVALID_PARAMETER;
1001 handler = calloc(1, sizeof(struct efi_handler));
1003 return EFI_OUT_OF_RESOURCES;
1004 handler->guid = protocol;
1005 handler->protocol_interface = protocol_interface;
1006 INIT_LIST_HEAD(&handler->open_infos);
1007 list_add_tail(&handler->link, &efiobj->protocols);
1008 if (!guidcmp(&efi_guid_device_path, protocol))
1009 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1014 * efi_install_protocol_interface() - install protocol interface
1015 * @handle: handle on which the protocol shall be installed
1016 * @protocol: GUID of the protocol to be installed
1017 * @protocol_interface_type: type of the interface to be installed,
1018 * always EFI_NATIVE_INTERFACE
1019 * @protocol_interface: interface of the protocol implementation
1021 * This function implements the InstallProtocolInterface service.
1023 * See the Unified Extensible Firmware Interface (UEFI) specification for
1026 * Return: status code
1028 static efi_status_t EFIAPI efi_install_protocol_interface(
1029 efi_handle_t *handle, const efi_guid_t *protocol,
1030 int protocol_interface_type, void *protocol_interface)
1034 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1035 protocol_interface);
1037 if (!handle || !protocol ||
1038 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1039 r = EFI_INVALID_PARAMETER;
1043 /* Create new handle if requested. */
1045 r = efi_create_handle(handle);
1046 if (r != EFI_SUCCESS)
1048 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1051 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1054 /* Add new protocol */
1055 r = efi_add_protocol(*handle, protocol, protocol_interface);
1061 * efi_get_drivers() - get all drivers associated to a controller
1062 * @handle: handle of the controller
1063 * @protocol: protocol GUID (optional)
1064 * @number_of_drivers: number of child controllers
1065 * @driver_handle_buffer: handles of the the drivers
1067 * The allocated buffer has to be freed with free().
1069 * Return: status code
1071 static efi_status_t efi_get_drivers(efi_handle_t handle,
1072 const efi_guid_t *protocol,
1073 efi_uintn_t *number_of_drivers,
1074 efi_handle_t **driver_handle_buffer)
1076 struct efi_handler *handler;
1077 struct efi_open_protocol_info_item *item;
1078 efi_uintn_t count = 0, i;
1081 /* Count all driver associations */
1082 list_for_each_entry(handler, &handle->protocols, link) {
1083 if (protocol && guidcmp(handler->guid, protocol))
1085 list_for_each_entry(item, &handler->open_infos, link) {
1086 if (item->info.attributes &
1087 EFI_OPEN_PROTOCOL_BY_DRIVER)
1092 * Create buffer. In case of duplicate driver assignments the buffer
1093 * will be too large. But that does not harm.
1095 *number_of_drivers = 0;
1096 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1097 if (!*driver_handle_buffer)
1098 return EFI_OUT_OF_RESOURCES;
1099 /* Collect unique driver handles */
1100 list_for_each_entry(handler, &handle->protocols, link) {
1101 if (protocol && guidcmp(handler->guid, protocol))
1103 list_for_each_entry(item, &handler->open_infos, link) {
1104 if (item->info.attributes &
1105 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1106 /* Check this is a new driver */
1108 for (i = 0; i < *number_of_drivers; ++i) {
1109 if ((*driver_handle_buffer)[i] ==
1110 item->info.agent_handle)
1113 /* Copy handle to buffer */
1115 i = (*number_of_drivers)++;
1116 (*driver_handle_buffer)[i] =
1117 item->info.agent_handle;
1126 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1127 * @handle: handle of the controller
1128 * @protocol: protocol GUID (optional)
1129 * @child_handle: handle of the child to destroy
1131 * This function implements the DisconnectController service.
1133 * See the Unified Extensible Firmware Interface (UEFI) specification for
1136 * Return: status code
1138 static efi_status_t efi_disconnect_all_drivers
1139 (efi_handle_t handle,
1140 const efi_guid_t *protocol,
1141 efi_handle_t child_handle)
1143 efi_uintn_t number_of_drivers;
1144 efi_handle_t *driver_handle_buffer;
1145 efi_status_t r, ret;
1147 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1148 &driver_handle_buffer);
1149 if (ret != EFI_SUCCESS)
1152 ret = EFI_NOT_FOUND;
1153 while (number_of_drivers) {
1154 r = EFI_CALL(efi_disconnect_controller(
1156 driver_handle_buffer[--number_of_drivers],
1158 if (r == EFI_SUCCESS)
1161 free(driver_handle_buffer);
1166 * efi_uninstall_protocol() - uninstall protocol interface
1168 * @handle: handle from which the protocol shall be removed
1169 * @protocol: GUID of the protocol to be removed
1170 * @protocol_interface: interface to be removed
1172 * This function DOES NOT delete a handle without installed protocol.
1174 * Return: status code
1176 static efi_status_t efi_uninstall_protocol
1177 (efi_handle_t handle, const efi_guid_t *protocol,
1178 void *protocol_interface)
1180 struct efi_object *efiobj;
1181 struct efi_handler *handler;
1182 struct efi_open_protocol_info_item *item;
1183 struct efi_open_protocol_info_item *pos;
1187 efiobj = efi_search_obj(handle);
1189 r = EFI_INVALID_PARAMETER;
1192 /* Find the protocol on the handle */
1193 r = efi_search_protocol(handle, protocol, &handler);
1194 if (r != EFI_SUCCESS)
1196 /* Disconnect controllers */
1197 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1198 if (!list_empty(&handler->open_infos)) {
1199 r = EFI_ACCESS_DENIED;
1202 /* Close protocol */
1203 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1204 if (item->info.attributes ==
1205 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1206 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1207 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1208 list_del(&item->link);
1210 if (!list_empty(&handler->open_infos)) {
1211 r = EFI_ACCESS_DENIED;
1214 r = efi_remove_protocol(handle, protocol, protocol_interface);
1220 * efi_uninstall_protocol_interface() - uninstall protocol interface
1221 * @handle: handle from which the protocol shall be removed
1222 * @protocol: GUID of the protocol to be removed
1223 * @protocol_interface: interface to be removed
1225 * This function implements the UninstallProtocolInterface service.
1227 * See the Unified Extensible Firmware Interface (UEFI) specification for
1230 * Return: status code
1232 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1233 (efi_handle_t handle, const efi_guid_t *protocol,
1234 void *protocol_interface)
1238 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1240 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1241 if (ret != EFI_SUCCESS)
1244 /* If the last protocol has been removed, delete the handle. */
1245 if (list_empty(&handle->protocols)) {
1246 list_del(&handle->link);
1250 return EFI_EXIT(ret);
1254 * efi_register_protocol_notify() - register an event for notification when a
1255 * protocol is installed.
1256 * @protocol: GUID of the protocol whose installation shall be notified
1257 * @event: event to be signaled upon installation of the protocol
1258 * @registration: key for retrieving the registration information
1260 * This function implements the RegisterProtocolNotify service.
1261 * See the Unified Extensible Firmware Interface (UEFI) specification
1264 * Return: status code
1266 static efi_status_t EFIAPI efi_register_protocol_notify(
1267 const efi_guid_t *protocol,
1268 struct efi_event *event,
1269 void **registration)
1271 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1272 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1276 * efi_search() - determine if an EFI handle implements a protocol
1277 * @search_type: selection criterion
1278 * @protocol: GUID of the protocol
1279 * @search_key: registration key
1282 * See the documentation of the LocateHandle service in the UEFI specification.
1284 * Return: 0 if the handle implements the protocol
1286 static int efi_search(enum efi_locate_search_type search_type,
1287 const efi_guid_t *protocol, void *search_key,
1288 efi_handle_t handle)
1292 switch (search_type) {
1295 case BY_REGISTER_NOTIFY:
1296 /* TODO: RegisterProtocolNotify is not implemented yet */
1299 ret = efi_search_protocol(handle, protocol, NULL);
1300 return (ret != EFI_SUCCESS);
1302 /* Invalid search type */
1308 * efi_locate_handle() - locate handles implementing a protocol
1309 * @search_type: selection criterion
1310 * @protocol: GUID of the protocol
1311 * @search_key: registration key
1312 * @buffer_size: size of the buffer to receive the handles in bytes
1313 * @buffer: buffer to receive the relevant handles
1315 * This function is meant for U-Boot internal calls. For the API implementation
1316 * of the LocateHandle service see efi_locate_handle_ext.
1318 * Return: status code
1320 static efi_status_t efi_locate_handle(
1321 enum efi_locate_search_type search_type,
1322 const efi_guid_t *protocol, void *search_key,
1323 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1325 struct efi_object *efiobj;
1326 efi_uintn_t size = 0;
1328 /* Check parameters */
1329 switch (search_type) {
1332 case BY_REGISTER_NOTIFY:
1334 return EFI_INVALID_PARAMETER;
1335 /* RegisterProtocolNotify is not implemented yet */
1336 return EFI_UNSUPPORTED;
1339 return EFI_INVALID_PARAMETER;
1342 return EFI_INVALID_PARAMETER;
1346 * efi_locate_handle_buffer uses this function for
1347 * the calculation of the necessary buffer size.
1348 * So do not require a buffer for buffersize == 0.
1350 if (!buffer_size || (*buffer_size && !buffer))
1351 return EFI_INVALID_PARAMETER;
1353 /* Count how much space we need */
1354 list_for_each_entry(efiobj, &efi_obj_list, link) {
1355 if (!efi_search(search_type, protocol, search_key, efiobj))
1356 size += sizeof(void *);
1359 if (*buffer_size < size) {
1360 *buffer_size = size;
1361 return EFI_BUFFER_TOO_SMALL;
1364 *buffer_size = size;
1366 return EFI_NOT_FOUND;
1368 /* Then fill the array */
1369 list_for_each_entry(efiobj, &efi_obj_list, link) {
1370 if (!efi_search(search_type, protocol, search_key, efiobj))
1378 * efi_locate_handle_ext() - locate handles implementing a protocol.
1379 * @search_type: selection criterion
1380 * @protocol: GUID of the protocol
1381 * @search_key: registration key
1382 * @buffer_size: size of the buffer to receive the handles in bytes
1383 * @buffer: buffer to receive the relevant handles
1385 * This function implements the LocateHandle service.
1387 * See the Unified Extensible Firmware Interface (UEFI) specification for
1390 * Return: 0 if the handle implements the protocol
1392 static efi_status_t EFIAPI efi_locate_handle_ext(
1393 enum efi_locate_search_type search_type,
1394 const efi_guid_t *protocol, void *search_key,
1395 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1397 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1398 buffer_size, buffer);
1400 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1401 buffer_size, buffer));
1405 * efi_remove_configuration_table() - collapses configuration table entries,
1408 * @i: index of the table entry to be removed
1410 static void efi_remove_configuration_table(int i)
1412 struct efi_configuration_table *this = &systab.tables[i];
1413 struct efi_configuration_table *next = &systab.tables[i + 1];
1414 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1416 memmove(this, next, (ulong)end - (ulong)next);
1421 * efi_install_configuration_table() - adds, updates, or removes a
1422 * configuration table
1423 * @guid: GUID of the installed table
1424 * @table: table to be installed
1426 * This function is used for internal calls. For the API implementation of the
1427 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1429 * Return: status code
1431 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1434 struct efi_event *evt;
1438 return EFI_INVALID_PARAMETER;
1440 /* Check for GUID override */
1441 for (i = 0; i < systab.nr_tables; i++) {
1442 if (!guidcmp(guid, &systab.tables[i].guid)) {
1444 systab.tables[i].table = table;
1446 efi_remove_configuration_table(i);
1452 return EFI_NOT_FOUND;
1454 /* No override, check for overflow */
1455 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1456 return EFI_OUT_OF_RESOURCES;
1458 /* Add a new entry */
1459 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1460 systab.tables[i].table = table;
1461 systab.nr_tables = i + 1;
1464 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1465 efi_update_table_header_crc32(&systab.hdr);
1467 /* Notify that the configuration table was changed */
1468 list_for_each_entry(evt, &efi_events, link) {
1469 if (evt->group && !guidcmp(evt->group, guid)) {
1470 efi_signal_event(evt, false);
1479 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1480 * configuration table.
1481 * @guid: GUID of the installed table
1482 * @table: table to be installed
1484 * This function implements the InstallConfigurationTable service.
1486 * See the Unified Extensible Firmware Interface (UEFI) specification for
1489 * Return: status code
1491 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1494 EFI_ENTRY("%pUl, %p", guid, table);
1495 return EFI_EXIT(efi_install_configuration_table(guid, table));
1499 * efi_setup_loaded_image() - initialize a loaded image
1501 * Initialize a loaded_image_info and loaded_image_info object with correct
1502 * protocols, boot-device, etc.
1504 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1507 * @device_path: device path of the loaded image
1508 * @file_path: file path of the loaded image
1509 * @handle_ptr: handle of the loaded image
1510 * @info_ptr: loaded image protocol
1511 * Return: status code
1513 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1514 struct efi_device_path *file_path,
1515 struct efi_loaded_image_obj **handle_ptr,
1516 struct efi_loaded_image **info_ptr)
1519 struct efi_loaded_image *info = NULL;
1520 struct efi_loaded_image_obj *obj = NULL;
1522 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1526 info = calloc(1, sizeof(*info));
1528 return EFI_OUT_OF_RESOURCES;
1529 obj = calloc(1, sizeof(*obj));
1532 return EFI_OUT_OF_RESOURCES;
1535 /* Add internal object to object list */
1536 efi_add_handle(&obj->header);
1538 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1539 info->file_path = file_path;
1540 info->system_table = &systab;
1543 info->device_handle = efi_dp_find_obj(device_path, NULL);
1545 * When asking for the device path interface, return
1546 * bootefi_device_path
1548 ret = efi_add_protocol(&obj->header,
1549 &efi_guid_device_path, device_path);
1550 if (ret != EFI_SUCCESS)
1555 * When asking for the loaded_image interface, just
1556 * return handle which points to loaded_image_info
1558 ret = efi_add_protocol(&obj->header,
1559 &efi_guid_loaded_image, info);
1560 if (ret != EFI_SUCCESS)
1563 #if CONFIG_IS_ENABLED(EFI_LOADER_HII)
1564 ret = efi_add_protocol(&obj->header,
1565 &efi_guid_hii_string_protocol,
1566 (void *)&efi_hii_string);
1567 if (ret != EFI_SUCCESS)
1570 ret = efi_add_protocol(&obj->header,
1571 &efi_guid_hii_database_protocol,
1572 (void *)&efi_hii_database);
1573 if (ret != EFI_SUCCESS)
1576 ret = efi_add_protocol(&obj->header,
1577 &efi_guid_hii_config_routing_protocol,
1578 (void *)&efi_hii_config_routing);
1579 if (ret != EFI_SUCCESS)
1590 printf("ERROR: Failure to install protocols for loaded image\n");
1591 efi_delete_handle(&obj->header);
1597 * efi_load_image_from_path() - load an image using a file path
1599 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1600 * callers obligation to update the memory type as needed.
1602 * @file_path: the path of the image to load
1603 * @buffer: buffer containing the loaded image
1604 * @size: size of the loaded image
1605 * Return: status code
1607 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1608 void **buffer, efi_uintn_t *size)
1610 struct efi_file_info *info = NULL;
1611 struct efi_file_handle *f;
1612 static efi_status_t ret;
1616 /* In case of failure nothing is returned */
1621 f = efi_file_from_path(file_path);
1623 return EFI_DEVICE_ERROR;
1627 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1629 if (ret != EFI_BUFFER_TOO_SMALL) {
1630 ret = EFI_DEVICE_ERROR;
1635 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1637 if (ret != EFI_SUCCESS)
1641 * When reading the file we do not yet know if it contains an
1642 * application, a boottime driver, or a runtime driver. So here we
1643 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1644 * update the reservation according to the image type.
1646 bs = info->file_size;
1647 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1648 EFI_BOOT_SERVICES_DATA,
1649 efi_size_in_pages(bs), &addr);
1650 if (ret != EFI_SUCCESS) {
1651 ret = EFI_OUT_OF_RESOURCES;
1656 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1657 if (ret != EFI_SUCCESS)
1658 efi_free_pages(addr, efi_size_in_pages(bs));
1659 *buffer = (void *)(uintptr_t)addr;
1662 EFI_CALL(f->close(f));
1668 * efi_load_image() - load an EFI image into memory
1669 * @boot_policy: true for request originating from the boot manager
1670 * @parent_image: the caller's image handle
1671 * @file_path: the path of the image to load
1672 * @source_buffer: memory location from which the image is installed
1673 * @source_size: size of the memory area from which the image is installed
1674 * @image_handle: handle for the newly installed image
1676 * This function implements the LoadImage service.
1678 * See the Unified Extensible Firmware Interface (UEFI) specification
1681 * Return: status code
1683 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1684 efi_handle_t parent_image,
1685 struct efi_device_path *file_path,
1686 void *source_buffer,
1687 efi_uintn_t source_size,
1688 efi_handle_t *image_handle)
1690 struct efi_device_path *dp, *fp;
1691 struct efi_loaded_image *info = NULL;
1692 struct efi_loaded_image_obj **image_obj =
1693 (struct efi_loaded_image_obj **)image_handle;
1696 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1697 file_path, source_buffer, source_size, image_handle);
1699 if (!image_handle || !parent_image) {
1700 ret = EFI_INVALID_PARAMETER;
1704 if (!source_buffer && !file_path) {
1705 ret = EFI_NOT_FOUND;
1709 if (!source_buffer) {
1710 ret = efi_load_image_from_path(file_path, &source_buffer,
1712 if (ret != EFI_SUCCESS)
1715 * split file_path which contains both the device and
1718 efi_dp_split_file_path(file_path, &dp, &fp);
1720 /* In this case, file_path is the "device" path, i.e.
1721 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1726 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1727 EFI_RUNTIME_SERVICES_CODE,
1728 efi_size_in_pages(source_size), &addr);
1729 if (ret != EFI_SUCCESS)
1731 dest_buffer = (void *)(uintptr_t)addr;
1732 memcpy(dest_buffer, source_buffer, source_size);
1733 source_buffer = dest_buffer;
1738 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
1739 if (ret != EFI_SUCCESS)
1740 goto error_invalid_image;
1741 ret = efi_load_pe(*image_obj, source_buffer, info);
1742 if (ret != EFI_SUCCESS)
1743 goto error_invalid_image;
1744 /* Update the type of the allocated memory */
1745 efi_add_memory_map((uintptr_t)source_buffer,
1746 efi_size_in_pages(source_size),
1747 info->image_code_type, false);
1748 info->system_table = &systab;
1749 info->parent_handle = parent_image;
1750 return EFI_EXIT(EFI_SUCCESS);
1751 error_invalid_image:
1752 /* The image is invalid. Release all associated resources. */
1753 efi_free_pages((uintptr_t)source_buffer,
1754 efi_size_in_pages(source_size));
1755 efi_delete_handle(*image_handle);
1756 *image_handle = NULL;
1759 return EFI_EXIT(ret);
1763 * efi_start_image() - call the entry point of an image
1764 * @image_handle: handle of the image
1765 * @exit_data_size: size of the buffer
1766 * @exit_data: buffer to receive the exit data of the called image
1768 * This function implements the StartImage service.
1770 * See the Unified Extensible Firmware Interface (UEFI) specification for
1773 * Return: status code
1775 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1776 efi_uintn_t *exit_data_size,
1779 struct efi_loaded_image_obj *image_obj =
1780 (struct efi_loaded_image_obj *)image_handle;
1783 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1785 efi_is_direct_boot = false;
1787 /* call the image! */
1788 if (setjmp(&image_obj->exit_jmp)) {
1790 * We called the entry point of the child image with EFI_CALL
1791 * in the lines below. The child image called the Exit() boot
1792 * service efi_exit() which executed the long jump that brought
1793 * us to the current line. This implies that the second half
1794 * of the EFI_CALL macro has not been executed.
1798 * efi_exit() called efi_restore_gd(). We have to undo this
1799 * otherwise __efi_entry_check() will put the wrong value into
1805 * To get ready to call EFI_EXIT below we have to execute the
1806 * missed out steps of EFI_CALL.
1808 assert(__efi_entry_check());
1809 debug("%sEFI: %lu returned by started image\n",
1810 __efi_nesting_dec(),
1811 (unsigned long)((uintptr_t)image_obj->exit_status &
1813 return EFI_EXIT(image_obj->exit_status);
1816 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
1819 * Usually UEFI applications call Exit() instead of returning.
1820 * But because the world doesn't consist of ponies and unicorns,
1821 * we're happy to emulate that behavior on behalf of a payload
1824 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
1828 * efi_exit() - leave an EFI application or driver
1829 * @image_handle: handle of the application or driver that is exiting
1830 * @exit_status: status code
1831 * @exit_data_size: size of the buffer in bytes
1832 * @exit_data: buffer with data describing an error
1834 * This function implements the Exit service.
1836 * See the Unified Extensible Firmware Interface (UEFI) specification for
1839 * Return: status code
1841 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1842 efi_status_t exit_status,
1843 efi_uintn_t exit_data_size,
1847 * TODO: We should call the unload procedure of the loaded
1850 struct efi_loaded_image_obj *image_obj =
1851 (struct efi_loaded_image_obj *)image_handle;
1853 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
1854 exit_data_size, exit_data);
1856 /* Make sure entry/exit counts for EFI world cross-overs match */
1857 EFI_EXIT(exit_status);
1860 * But longjmp out with the U-Boot gd, not the application's, as
1861 * the other end is a setjmp call inside EFI context.
1865 image_obj->exit_status = exit_status;
1866 longjmp(&image_obj->exit_jmp, 1);
1868 panic("EFI application exited");
1872 * efi_unload_image() - unload an EFI image
1873 * @image_handle: handle of the image to be unloaded
1875 * This function implements the UnloadImage service.
1877 * See the Unified Extensible Firmware Interface (UEFI) specification for
1880 * Return: status code
1882 static efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
1884 struct efi_object *efiobj;
1886 EFI_ENTRY("%p", image_handle);
1887 efiobj = efi_search_obj(image_handle);
1889 list_del(&efiobj->link);
1891 return EFI_EXIT(EFI_SUCCESS);
1895 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1897 static void efi_exit_caches(void)
1899 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1901 * Grub on 32bit ARM needs to have caches disabled before jumping into
1902 * a zImage, but does not know of all cache layers. Give it a hand.
1904 if (efi_is_direct_boot)
1905 cleanup_before_linux();
1910 * efi_exit_boot_services() - stop all boot services
1911 * @image_handle: handle of the loaded image
1912 * @map_key: key of the memory map
1914 * This function implements the ExitBootServices service.
1916 * See the Unified Extensible Firmware Interface (UEFI) specification
1919 * All timer events are disabled. For exit boot services events the
1920 * notification function is called. The boot services are disabled in the
1923 * Return: status code
1925 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1926 unsigned long map_key)
1928 struct efi_event *evt;
1930 EFI_ENTRY("%p, %ld", image_handle, map_key);
1932 /* Check that the caller has read the current memory map */
1933 if (map_key != efi_memory_map_key)
1934 return EFI_INVALID_PARAMETER;
1936 /* Make sure that notification functions are not called anymore */
1937 efi_tpl = TPL_HIGH_LEVEL;
1939 /* Check if ExitBootServices has already been called */
1940 if (!systab.boottime)
1941 return EFI_EXIT(EFI_SUCCESS);
1943 /* Add related events to the event group */
1944 list_for_each_entry(evt, &efi_events, link) {
1945 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1946 evt->group = &efi_guid_event_group_exit_boot_services;
1948 /* Notify that ExitBootServices is invoked. */
1949 list_for_each_entry(evt, &efi_events, link) {
1951 !guidcmp(evt->group,
1952 &efi_guid_event_group_exit_boot_services)) {
1953 efi_signal_event(evt, false);
1958 /* TODO: Should persist EFI variables here */
1960 board_quiesce_devices();
1962 /* Fix up caches for EFI payloads if necessary */
1965 /* This stops all lingering devices */
1966 bootm_disable_interrupts();
1968 /* Disable boot time services */
1969 systab.con_in_handle = NULL;
1970 systab.con_in = NULL;
1971 systab.con_out_handle = NULL;
1972 systab.con_out = NULL;
1973 systab.stderr_handle = NULL;
1974 systab.std_err = NULL;
1975 systab.boottime = NULL;
1977 /* Recalculate CRC32 */
1978 efi_update_table_header_crc32(&systab.hdr);
1980 /* Give the payload some time to boot */
1981 efi_set_watchdog(0);
1984 return EFI_EXIT(EFI_SUCCESS);
1988 * efi_get_next_monotonic_count() - get next value of the counter
1989 * @count: returned value of the counter
1991 * This function implements the NextMonotonicCount service.
1993 * See the Unified Extensible Firmware Interface (UEFI) specification for
1996 * Return: status code
1998 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
2000 static uint64_t mono;
2002 EFI_ENTRY("%p", count);
2004 return EFI_EXIT(EFI_SUCCESS);
2008 * efi_stall() - sleep
2009 * @microseconds: period to sleep in microseconds
2011 * This function implements the Stall service.
2013 * See the Unified Extensible Firmware Interface (UEFI) specification for
2016 * Return: status code
2018 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
2020 EFI_ENTRY("%ld", microseconds);
2021 udelay(microseconds);
2022 return EFI_EXIT(EFI_SUCCESS);
2026 * efi_set_watchdog_timer() - reset the watchdog timer
2027 * @timeout: seconds before reset by watchdog
2028 * @watchdog_code: code to be logged when resetting
2029 * @data_size: size of buffer in bytes
2030 * @watchdog_data: buffer with data describing the reset reason
2032 * This function implements the SetWatchdogTimer service.
2034 * See the Unified Extensible Firmware Interface (UEFI) specification for
2037 * Return: status code
2039 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2040 uint64_t watchdog_code,
2041 unsigned long data_size,
2042 uint16_t *watchdog_data)
2044 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
2045 data_size, watchdog_data);
2046 return EFI_EXIT(efi_set_watchdog(timeout));
2050 * efi_close_protocol() - close a protocol
2051 * @handle: handle on which the protocol shall be closed
2052 * @protocol: GUID of the protocol to close
2053 * @agent_handle: handle of the driver
2054 * @controller_handle: handle of the controller
2056 * This function implements the CloseProtocol service.
2058 * See the Unified Extensible Firmware Interface (UEFI) specification for
2061 * Return: status code
2063 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
2064 const efi_guid_t *protocol,
2065 efi_handle_t agent_handle,
2066 efi_handle_t controller_handle)
2068 struct efi_handler *handler;
2069 struct efi_open_protocol_info_item *item;
2070 struct efi_open_protocol_info_item *pos;
2073 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2076 if (!agent_handle) {
2077 r = EFI_INVALID_PARAMETER;
2080 r = efi_search_protocol(handle, protocol, &handler);
2081 if (r != EFI_SUCCESS)
2085 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2086 if (item->info.agent_handle == agent_handle &&
2087 item->info.controller_handle == controller_handle) {
2088 efi_delete_open_info(item);
2098 * efi_open_protocol_information() - provide information about then open status
2099 * of a protocol on a handle
2100 * @handle: handle for which the information shall be retrieved
2101 * @protocol: GUID of the protocol
2102 * @entry_buffer: buffer to receive the open protocol information
2103 * @entry_count: number of entries available in the buffer
2105 * This function implements the OpenProtocolInformation service.
2107 * See the Unified Extensible Firmware Interface (UEFI) specification for
2110 * Return: status code
2112 static efi_status_t EFIAPI efi_open_protocol_information(
2113 efi_handle_t handle, const efi_guid_t *protocol,
2114 struct efi_open_protocol_info_entry **entry_buffer,
2115 efi_uintn_t *entry_count)
2117 unsigned long buffer_size;
2118 unsigned long count;
2119 struct efi_handler *handler;
2120 struct efi_open_protocol_info_item *item;
2123 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2126 /* Check parameters */
2127 if (!entry_buffer) {
2128 r = EFI_INVALID_PARAMETER;
2131 r = efi_search_protocol(handle, protocol, &handler);
2132 if (r != EFI_SUCCESS)
2137 list_for_each_entry(item, &handler->open_infos, link) {
2138 if (item->info.open_count)
2141 *entry_count = count;
2142 *entry_buffer = NULL;
2149 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2150 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2151 (void **)entry_buffer);
2152 if (r != EFI_SUCCESS)
2154 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2155 if (item->info.open_count)
2156 (*entry_buffer)[--count] = item->info;
2163 * efi_protocols_per_handle() - get protocols installed on a handle
2164 * @handle: handle for which the information is retrieved
2165 * @protocol_buffer: buffer with protocol GUIDs
2166 * @protocol_buffer_count: number of entries in the buffer
2168 * This function implements the ProtocolsPerHandleService.
2170 * See the Unified Extensible Firmware Interface (UEFI) specification for
2173 * Return: status code
2175 static efi_status_t EFIAPI efi_protocols_per_handle(
2176 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2177 efi_uintn_t *protocol_buffer_count)
2179 unsigned long buffer_size;
2180 struct efi_object *efiobj;
2181 struct list_head *protocol_handle;
2184 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2185 protocol_buffer_count);
2187 if (!handle || !protocol_buffer || !protocol_buffer_count)
2188 return EFI_EXIT(EFI_INVALID_PARAMETER);
2190 *protocol_buffer = NULL;
2191 *protocol_buffer_count = 0;
2193 efiobj = efi_search_obj(handle);
2195 return EFI_EXIT(EFI_INVALID_PARAMETER);
2197 /* Count protocols */
2198 list_for_each(protocol_handle, &efiobj->protocols) {
2199 ++*protocol_buffer_count;
2203 if (*protocol_buffer_count) {
2206 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2207 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2208 (void **)protocol_buffer);
2209 if (r != EFI_SUCCESS)
2211 list_for_each(protocol_handle, &efiobj->protocols) {
2212 struct efi_handler *protocol;
2214 protocol = list_entry(protocol_handle,
2215 struct efi_handler, link);
2216 (*protocol_buffer)[j] = (void *)protocol->guid;
2221 return EFI_EXIT(EFI_SUCCESS);
2225 * efi_locate_handle_buffer() - locate handles implementing a protocol
2226 * @search_type: selection criterion
2227 * @protocol: GUID of the protocol
2228 * @search_key: registration key
2229 * @no_handles: number of returned handles
2230 * @buffer: buffer with the returned handles
2232 * This function implements the LocateHandleBuffer service.
2234 * See the Unified Extensible Firmware Interface (UEFI) specification for
2237 * Return: status code
2239 static efi_status_t EFIAPI efi_locate_handle_buffer(
2240 enum efi_locate_search_type search_type,
2241 const efi_guid_t *protocol, void *search_key,
2242 efi_uintn_t *no_handles, efi_handle_t **buffer)
2245 efi_uintn_t buffer_size = 0;
2247 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2248 no_handles, buffer);
2250 if (!no_handles || !buffer) {
2251 r = EFI_INVALID_PARAMETER;
2256 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2258 if (r != EFI_BUFFER_TOO_SMALL)
2260 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2262 if (r != EFI_SUCCESS)
2264 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2266 if (r == EFI_SUCCESS)
2267 *no_handles = buffer_size / sizeof(efi_handle_t);
2273 * efi_locate_protocol() - find an interface implementing a protocol
2274 * @protocol: GUID of the protocol
2275 * @registration: registration key passed to the notification function
2276 * @protocol_interface: interface implementing the protocol
2278 * This function implements the LocateProtocol service.
2280 * See the Unified Extensible Firmware Interface (UEFI) specification for
2283 * Return: status code
2285 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2287 void **protocol_interface)
2289 struct list_head *lhandle;
2292 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2294 if (!protocol || !protocol_interface)
2295 return EFI_EXIT(EFI_INVALID_PARAMETER);
2297 list_for_each(lhandle, &efi_obj_list) {
2298 struct efi_object *efiobj;
2299 struct efi_handler *handler;
2301 efiobj = list_entry(lhandle, struct efi_object, link);
2303 ret = efi_search_protocol(efiobj, protocol, &handler);
2304 if (ret == EFI_SUCCESS) {
2305 *protocol_interface = handler->protocol_interface;
2306 return EFI_EXIT(EFI_SUCCESS);
2309 *protocol_interface = NULL;
2311 return EFI_EXIT(EFI_NOT_FOUND);
2315 * efi_locate_device_path() - Get the device path and handle of an device
2316 * implementing a protocol
2317 * @protocol: GUID of the protocol
2318 * @device_path: device path
2319 * @device: handle of the device
2321 * This function implements the LocateDevicePath service.
2323 * See the Unified Extensible Firmware Interface (UEFI) specification for
2326 * Return: status code
2328 static efi_status_t EFIAPI efi_locate_device_path(
2329 const efi_guid_t *protocol,
2330 struct efi_device_path **device_path,
2331 efi_handle_t *device)
2333 struct efi_device_path *dp;
2335 struct efi_handler *handler;
2336 efi_handle_t *handles;
2338 size_t len_best = 0;
2339 efi_uintn_t no_handles;
2343 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2345 if (!protocol || !device_path || !*device_path || !device) {
2346 ret = EFI_INVALID_PARAMETER;
2350 /* Find end of device path */
2351 len = efi_dp_instance_size(*device_path);
2353 /* Get all handles implementing the protocol */
2354 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2355 &no_handles, &handles));
2356 if (ret != EFI_SUCCESS)
2359 for (i = 0; i < no_handles; ++i) {
2360 /* Find the device path protocol */
2361 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2363 if (ret != EFI_SUCCESS)
2365 dp = (struct efi_device_path *)handler->protocol_interface;
2366 len_dp = efi_dp_instance_size(dp);
2368 * This handle can only be a better fit
2369 * if its device path length is longer than the best fit and
2370 * if its device path length is shorter of equal the searched
2373 if (len_dp <= len_best || len_dp > len)
2375 /* Check if dp is a subpath of device_path */
2376 if (memcmp(*device_path, dp, len_dp))
2378 *device = handles[i];
2382 remainder = (u8 *)*device_path + len_best;
2383 *device_path = (struct efi_device_path *)remainder;
2386 ret = EFI_NOT_FOUND;
2389 return EFI_EXIT(ret);
2393 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2395 * @handle: handle on which the protocol interfaces shall be installed
2396 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2399 * This function implements the MultipleProtocolInterfaces service.
2401 * See the Unified Extensible Firmware Interface (UEFI) specification for
2404 * Return: status code
2406 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2407 (efi_handle_t *handle, ...)
2409 EFI_ENTRY("%p", handle);
2412 const efi_guid_t *protocol;
2413 void *protocol_interface;
2414 efi_status_t r = EFI_SUCCESS;
2418 return EFI_EXIT(EFI_INVALID_PARAMETER);
2420 efi_va_start(argptr, handle);
2422 protocol = efi_va_arg(argptr, efi_guid_t*);
2425 protocol_interface = efi_va_arg(argptr, void*);
2426 r = EFI_CALL(efi_install_protocol_interface(
2428 EFI_NATIVE_INTERFACE,
2429 protocol_interface));
2430 if (r != EFI_SUCCESS)
2435 if (r == EFI_SUCCESS)
2438 /* If an error occurred undo all changes. */
2439 efi_va_start(argptr, handle);
2441 protocol = efi_va_arg(argptr, efi_guid_t*);
2442 protocol_interface = efi_va_arg(argptr, void*);
2443 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2444 protocol_interface));
2452 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2454 * @handle: handle from which the protocol interfaces shall be removed
2455 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2458 * This function implements the UninstallMultipleProtocolInterfaces service.
2460 * See the Unified Extensible Firmware Interface (UEFI) specification for
2463 * Return: status code
2465 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2466 efi_handle_t handle, ...)
2468 EFI_ENTRY("%p", handle);
2471 const efi_guid_t *protocol;
2472 void *protocol_interface;
2473 efi_status_t r = EFI_SUCCESS;
2477 return EFI_EXIT(EFI_INVALID_PARAMETER);
2479 efi_va_start(argptr, handle);
2481 protocol = efi_va_arg(argptr, efi_guid_t*);
2484 protocol_interface = efi_va_arg(argptr, void*);
2485 r = efi_uninstall_protocol(handle, protocol,
2486 protocol_interface);
2487 if (r != EFI_SUCCESS)
2492 if (r == EFI_SUCCESS) {
2493 /* If the last protocol has been removed, delete the handle. */
2494 if (list_empty(&handle->protocols)) {
2495 list_del(&handle->link);
2501 /* If an error occurred undo all changes. */
2502 efi_va_start(argptr, handle);
2504 protocol = efi_va_arg(argptr, efi_guid_t*);
2505 protocol_interface = efi_va_arg(argptr, void*);
2506 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2507 EFI_NATIVE_INTERFACE,
2508 protocol_interface));
2512 /* In case of an error always return EFI_INVALID_PARAMETER */
2513 return EFI_EXIT(EFI_INVALID_PARAMETER);
2517 * efi_calculate_crc32() - calculate cyclic redundancy code
2518 * @data: buffer with data
2519 * @data_size: size of buffer in bytes
2520 * @crc32_p: cyclic redundancy code
2522 * This function implements the CalculateCrc32 service.
2524 * See the Unified Extensible Firmware Interface (UEFI) specification for
2527 * Return: status code
2529 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2530 efi_uintn_t data_size,
2533 EFI_ENTRY("%p, %zu", data, data_size);
2534 *crc32_p = crc32(0, data, data_size);
2535 return EFI_EXIT(EFI_SUCCESS);
2539 * efi_copy_mem() - copy memory
2540 * @destination: destination of the copy operation
2541 * @source: source of the copy operation
2542 * @length: number of bytes to copy
2544 * This function implements the CopyMem service.
2546 * See the Unified Extensible Firmware Interface (UEFI) specification for
2549 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2552 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2553 memmove(destination, source, length);
2554 EFI_EXIT(EFI_SUCCESS);
2558 * efi_set_mem() - Fill memory with a byte value.
2559 * @buffer: buffer to fill
2560 * @size: size of buffer in bytes
2561 * @value: byte to copy to the buffer
2563 * This function implements the SetMem service.
2565 * See the Unified Extensible Firmware Interface (UEFI) specification for
2568 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2570 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2571 memset(buffer, value, size);
2572 EFI_EXIT(EFI_SUCCESS);
2576 * efi_protocol_open() - open protocol interface on a handle
2577 * @handler: handler of a protocol
2578 * @protocol_interface: interface implementing the protocol
2579 * @agent_handle: handle of the driver
2580 * @controller_handle: handle of the controller
2581 * @attributes: attributes indicating how to open the protocol
2583 * Return: status code
2585 static efi_status_t efi_protocol_open(
2586 struct efi_handler *handler,
2587 void **protocol_interface, void *agent_handle,
2588 void *controller_handle, uint32_t attributes)
2590 struct efi_open_protocol_info_item *item;
2591 struct efi_open_protocol_info_entry *match = NULL;
2592 bool opened_by_driver = false;
2593 bool opened_exclusive = false;
2595 /* If there is no agent, only return the interface */
2599 /* For TEST_PROTOCOL ignore interface attribute */
2600 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2601 *protocol_interface = NULL;
2604 * Check if the protocol is already opened by a driver with the same
2605 * attributes or opened exclusively
2607 list_for_each_entry(item, &handler->open_infos, link) {
2608 if (item->info.agent_handle == agent_handle) {
2609 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2610 (item->info.attributes == attributes))
2611 return EFI_ALREADY_STARTED;
2613 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2614 opened_exclusive = true;
2617 /* Only one controller can open the protocol exclusively */
2618 if (opened_exclusive && attributes &
2619 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2620 return EFI_ACCESS_DENIED;
2622 /* Prepare exclusive opening */
2623 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2624 /* Try to disconnect controllers */
2625 list_for_each_entry(item, &handler->open_infos, link) {
2626 if (item->info.attributes ==
2627 EFI_OPEN_PROTOCOL_BY_DRIVER)
2628 EFI_CALL(efi_disconnect_controller(
2629 item->info.controller_handle,
2630 item->info.agent_handle,
2633 opened_by_driver = false;
2634 /* Check if all controllers are disconnected */
2635 list_for_each_entry(item, &handler->open_infos, link) {
2636 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2637 opened_by_driver = true;
2639 /* Only one controller can be connected */
2640 if (opened_by_driver)
2641 return EFI_ACCESS_DENIED;
2644 /* Find existing entry */
2645 list_for_each_entry(item, &handler->open_infos, link) {
2646 if (item->info.agent_handle == agent_handle &&
2647 item->info.controller_handle == controller_handle)
2648 match = &item->info;
2650 /* None found, create one */
2652 match = efi_create_open_info(handler);
2654 return EFI_OUT_OF_RESOURCES;
2657 match->agent_handle = agent_handle;
2658 match->controller_handle = controller_handle;
2659 match->attributes = attributes;
2660 match->open_count++;
2663 /* For TEST_PROTOCOL ignore interface attribute. */
2664 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2665 *protocol_interface = handler->protocol_interface;
2671 * efi_open_protocol() - open protocol interface on a handle
2672 * @handle: handle on which the protocol shall be opened
2673 * @protocol: GUID of the protocol
2674 * @protocol_interface: interface implementing the protocol
2675 * @agent_handle: handle of the driver
2676 * @controller_handle: handle of the controller
2677 * @attributes: attributes indicating how to open the protocol
2679 * This function implements the OpenProtocol interface.
2681 * See the Unified Extensible Firmware Interface (UEFI) specification for
2684 * Return: status code
2686 static efi_status_t EFIAPI efi_open_protocol
2687 (efi_handle_t handle, const efi_guid_t *protocol,
2688 void **protocol_interface, efi_handle_t agent_handle,
2689 efi_handle_t controller_handle, uint32_t attributes)
2691 struct efi_handler *handler;
2692 efi_status_t r = EFI_INVALID_PARAMETER;
2694 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2695 protocol_interface, agent_handle, controller_handle,
2698 if (!handle || !protocol ||
2699 (!protocol_interface && attributes !=
2700 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2704 switch (attributes) {
2705 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2706 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2707 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2709 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2710 if (controller_handle == handle)
2713 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2714 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2715 /* Check that the controller handle is valid */
2716 if (!efi_search_obj(controller_handle))
2719 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2720 /* Check that the agent handle is valid */
2721 if (!efi_search_obj(agent_handle))
2728 r = efi_search_protocol(handle, protocol, &handler);
2729 if (r != EFI_SUCCESS)
2732 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2733 controller_handle, attributes);
2739 * efi_handle_protocol() - get interface of a protocol on a handle
2740 * @handle: handle on which the protocol shall be opened
2741 * @protocol: GUID of the protocol
2742 * @protocol_interface: interface implementing the protocol
2744 * This function implements the HandleProtocol service.
2746 * See the Unified Extensible Firmware Interface (UEFI) specification for
2749 * Return: status code
2751 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2752 const efi_guid_t *protocol,
2753 void **protocol_interface)
2755 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2756 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2760 * efi_bind_controller() - bind a single driver to a controller
2761 * @controller_handle: controller handle
2762 * @driver_image_handle: driver handle
2763 * @remain_device_path: remaining path
2765 * Return: status code
2767 static efi_status_t efi_bind_controller(
2768 efi_handle_t controller_handle,
2769 efi_handle_t driver_image_handle,
2770 struct efi_device_path *remain_device_path)
2772 struct efi_driver_binding_protocol *binding_protocol;
2775 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2776 &efi_guid_driver_binding_protocol,
2777 (void **)&binding_protocol,
2778 driver_image_handle, NULL,
2779 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2780 if (r != EFI_SUCCESS)
2782 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2784 remain_device_path));
2785 if (r == EFI_SUCCESS)
2786 r = EFI_CALL(binding_protocol->start(binding_protocol,
2788 remain_device_path));
2789 EFI_CALL(efi_close_protocol(driver_image_handle,
2790 &efi_guid_driver_binding_protocol,
2791 driver_image_handle, NULL));
2796 * efi_connect_single_controller() - connect a single driver to a controller
2797 * @controller_handle: controller
2798 * @driver_image_handle: driver
2799 * @remain_device_path: remaining path
2801 * Return: status code
2803 static efi_status_t efi_connect_single_controller(
2804 efi_handle_t controller_handle,
2805 efi_handle_t *driver_image_handle,
2806 struct efi_device_path *remain_device_path)
2808 efi_handle_t *buffer;
2812 size_t connected = 0;
2814 /* Get buffer with all handles with driver binding protocol */
2815 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2816 &efi_guid_driver_binding_protocol,
2817 NULL, &count, &buffer));
2818 if (r != EFI_SUCCESS)
2821 /* Context Override */
2822 if (driver_image_handle) {
2823 for (; *driver_image_handle; ++driver_image_handle) {
2824 for (i = 0; i < count; ++i) {
2825 if (buffer[i] == *driver_image_handle) {
2827 r = efi_bind_controller(
2829 *driver_image_handle,
2830 remain_device_path);
2832 * For drivers that do not support the
2833 * controller or are already connected
2834 * we receive an error code here.
2836 if (r == EFI_SUCCESS)
2844 * TODO: Some overrides are not yet implemented:
2845 * - Platform Driver Override
2846 * - Driver Family Override Search
2847 * - Bus Specific Driver Override
2850 /* Driver Binding Search */
2851 for (i = 0; i < count; ++i) {
2853 r = efi_bind_controller(controller_handle,
2855 remain_device_path);
2856 if (r == EFI_SUCCESS)
2861 efi_free_pool(buffer);
2863 return EFI_NOT_FOUND;
2868 * efi_connect_controller() - connect a controller to a driver
2869 * @controller_handle: handle of the controller
2870 * @driver_image_handle: handle of the driver
2871 * @remain_device_path: device path of a child controller
2872 * @recursive: true to connect all child controllers
2874 * This function implements the ConnectController service.
2876 * See the Unified Extensible Firmware Interface (UEFI) specification for
2879 * First all driver binding protocol handles are tried for binding drivers.
2880 * Afterwards all handles that have opened a protocol of the controller
2881 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2883 * Return: status code
2885 static efi_status_t EFIAPI efi_connect_controller(
2886 efi_handle_t controller_handle,
2887 efi_handle_t *driver_image_handle,
2888 struct efi_device_path *remain_device_path,
2892 efi_status_t ret = EFI_NOT_FOUND;
2893 struct efi_object *efiobj;
2895 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
2896 remain_device_path, recursive);
2898 efiobj = efi_search_obj(controller_handle);
2900 ret = EFI_INVALID_PARAMETER;
2904 r = efi_connect_single_controller(controller_handle,
2905 driver_image_handle,
2906 remain_device_path);
2907 if (r == EFI_SUCCESS)
2910 struct efi_handler *handler;
2911 struct efi_open_protocol_info_item *item;
2913 list_for_each_entry(handler, &efiobj->protocols, link) {
2914 list_for_each_entry(item, &handler->open_infos, link) {
2915 if (item->info.attributes &
2916 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2917 r = EFI_CALL(efi_connect_controller(
2918 item->info.controller_handle,
2919 driver_image_handle,
2922 if (r == EFI_SUCCESS)
2928 /* Check for child controller specified by end node */
2929 if (ret != EFI_SUCCESS && remain_device_path &&
2930 remain_device_path->type == DEVICE_PATH_TYPE_END)
2933 return EFI_EXIT(ret);
2937 * efi_reinstall_protocol_interface() - reinstall protocol interface
2938 * @handle: handle on which the protocol shall be reinstalled
2939 * @protocol: GUID of the protocol to be installed
2940 * @old_interface: interface to be removed
2941 * @new_interface: interface to be installed
2943 * This function implements the ReinstallProtocolInterface service.
2945 * See the Unified Extensible Firmware Interface (UEFI) specification for
2948 * The old interface is uninstalled. The new interface is installed.
2949 * Drivers are connected.
2951 * Return: status code
2953 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
2954 efi_handle_t handle, const efi_guid_t *protocol,
2955 void *old_interface, void *new_interface)
2959 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
2962 /* Uninstall protocol but do not delete handle */
2963 ret = efi_uninstall_protocol(handle, protocol, old_interface);
2964 if (ret != EFI_SUCCESS)
2967 /* Install the new protocol */
2968 ret = efi_add_protocol(handle, protocol, new_interface);
2970 * The UEFI spec does not specify what should happen to the handle
2971 * if in case of an error no protocol interface remains on the handle.
2972 * So let's do nothing here.
2974 if (ret != EFI_SUCCESS)
2977 * The returned status code has to be ignored.
2978 * Do not create an error if no suitable driver for the handle exists.
2980 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
2982 return EFI_EXIT(ret);
2986 * efi_get_child_controllers() - get all child controllers associated to a driver
2987 * @efiobj: handle of the controller
2988 * @driver_handle: handle of the driver
2989 * @number_of_children: number of child controllers
2990 * @child_handle_buffer: handles of the the child controllers
2992 * The allocated buffer has to be freed with free().
2994 * Return: status code
2996 static efi_status_t efi_get_child_controllers(
2997 struct efi_object *efiobj,
2998 efi_handle_t driver_handle,
2999 efi_uintn_t *number_of_children,
3000 efi_handle_t **child_handle_buffer)
3002 struct efi_handler *handler;
3003 struct efi_open_protocol_info_item *item;
3004 efi_uintn_t count = 0, i;
3007 /* Count all child controller associations */
3008 list_for_each_entry(handler, &efiobj->protocols, link) {
3009 list_for_each_entry(item, &handler->open_infos, link) {
3010 if (item->info.agent_handle == driver_handle &&
3011 item->info.attributes &
3012 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3017 * Create buffer. In case of duplicate child controller assignments
3018 * the buffer will be too large. But that does not harm.
3020 *number_of_children = 0;
3021 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3022 if (!*child_handle_buffer)
3023 return EFI_OUT_OF_RESOURCES;
3024 /* Copy unique child handles */
3025 list_for_each_entry(handler, &efiobj->protocols, link) {
3026 list_for_each_entry(item, &handler->open_infos, link) {
3027 if (item->info.agent_handle == driver_handle &&
3028 item->info.attributes &
3029 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3030 /* Check this is a new child controller */
3032 for (i = 0; i < *number_of_children; ++i) {
3033 if ((*child_handle_buffer)[i] ==
3034 item->info.controller_handle)
3037 /* Copy handle to buffer */
3039 i = (*number_of_children)++;
3040 (*child_handle_buffer)[i] =
3041 item->info.controller_handle;
3050 * efi_disconnect_controller() - disconnect a controller from a driver
3051 * @controller_handle: handle of the controller
3052 * @driver_image_handle: handle of the driver
3053 * @child_handle: handle of the child to destroy
3055 * This function implements the DisconnectController service.
3057 * See the Unified Extensible Firmware Interface (UEFI) specification for
3060 * Return: status code
3062 static efi_status_t EFIAPI efi_disconnect_controller(
3063 efi_handle_t controller_handle,
3064 efi_handle_t driver_image_handle,
3065 efi_handle_t child_handle)
3067 struct efi_driver_binding_protocol *binding_protocol;
3068 efi_handle_t *child_handle_buffer = NULL;
3069 size_t number_of_children = 0;
3071 size_t stop_count = 0;
3072 struct efi_object *efiobj;
3074 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3077 efiobj = efi_search_obj(controller_handle);
3079 r = EFI_INVALID_PARAMETER;
3083 if (child_handle && !efi_search_obj(child_handle)) {
3084 r = EFI_INVALID_PARAMETER;
3088 /* If no driver handle is supplied, disconnect all drivers */
3089 if (!driver_image_handle) {
3090 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3094 /* Create list of child handles */
3096 number_of_children = 1;
3097 child_handle_buffer = &child_handle;
3099 efi_get_child_controllers(efiobj,
3100 driver_image_handle,
3101 &number_of_children,
3102 &child_handle_buffer);
3105 /* Get the driver binding protocol */
3106 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3107 &efi_guid_driver_binding_protocol,
3108 (void **)&binding_protocol,
3109 driver_image_handle, NULL,
3110 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3111 if (r != EFI_SUCCESS)
3113 /* Remove the children */
3114 if (number_of_children) {
3115 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3118 child_handle_buffer));
3119 if (r == EFI_SUCCESS)
3122 /* Remove the driver */
3124 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3127 if (r == EFI_SUCCESS)
3129 EFI_CALL(efi_close_protocol(driver_image_handle,
3130 &efi_guid_driver_binding_protocol,
3131 driver_image_handle, NULL));
3139 free(child_handle_buffer);
3143 static struct efi_boot_services efi_boot_services = {
3145 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3146 .revision = EFI_SPECIFICATION_VERSION,
3147 .headersize = sizeof(struct efi_boot_services),
3149 .raise_tpl = efi_raise_tpl,
3150 .restore_tpl = efi_restore_tpl,
3151 .allocate_pages = efi_allocate_pages_ext,
3152 .free_pages = efi_free_pages_ext,
3153 .get_memory_map = efi_get_memory_map_ext,
3154 .allocate_pool = efi_allocate_pool_ext,
3155 .free_pool = efi_free_pool_ext,
3156 .create_event = efi_create_event_ext,
3157 .set_timer = efi_set_timer_ext,
3158 .wait_for_event = efi_wait_for_event,
3159 .signal_event = efi_signal_event_ext,
3160 .close_event = efi_close_event,
3161 .check_event = efi_check_event,
3162 .install_protocol_interface = efi_install_protocol_interface,
3163 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3164 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3165 .handle_protocol = efi_handle_protocol,
3167 .register_protocol_notify = efi_register_protocol_notify,
3168 .locate_handle = efi_locate_handle_ext,
3169 .locate_device_path = efi_locate_device_path,
3170 .install_configuration_table = efi_install_configuration_table_ext,
3171 .load_image = efi_load_image,
3172 .start_image = efi_start_image,
3174 .unload_image = efi_unload_image,
3175 .exit_boot_services = efi_exit_boot_services,
3176 .get_next_monotonic_count = efi_get_next_monotonic_count,
3178 .set_watchdog_timer = efi_set_watchdog_timer,
3179 .connect_controller = efi_connect_controller,
3180 .disconnect_controller = efi_disconnect_controller,
3181 .open_protocol = efi_open_protocol,
3182 .close_protocol = efi_close_protocol,
3183 .open_protocol_information = efi_open_protocol_information,
3184 .protocols_per_handle = efi_protocols_per_handle,
3185 .locate_handle_buffer = efi_locate_handle_buffer,
3186 .locate_protocol = efi_locate_protocol,
3187 .install_multiple_protocol_interfaces =
3188 efi_install_multiple_protocol_interfaces,
3189 .uninstall_multiple_protocol_interfaces =
3190 efi_uninstall_multiple_protocol_interfaces,
3191 .calculate_crc32 = efi_calculate_crc32,
3192 .copy_mem = efi_copy_mem,
3193 .set_mem = efi_set_mem,
3194 .create_event_ex = efi_create_event_ex,
3197 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3199 struct efi_system_table __efi_runtime_data systab = {
3201 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3202 .revision = EFI_SPECIFICATION_VERSION,
3203 .headersize = sizeof(struct efi_system_table),
3205 .fw_vendor = firmware_vendor,
3206 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3207 .con_in = (void *)&efi_con_in,
3208 .con_out = (void *)&efi_con_out,
3209 .std_err = (void *)&efi_con_out,
3210 .runtime = (void *)&efi_runtime_services,
3211 .boottime = (void *)&efi_boot_services,
3217 * efi_initialize_system_table() - Initialize system table
3219 * Return: status code
3221 efi_status_t efi_initialize_system_table(void)
3225 /* Allocate configuration table array */
3226 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3227 EFI_MAX_CONFIGURATION_TABLES *
3228 sizeof(struct efi_configuration_table),
3229 (void **)&systab.tables);
3231 /* Set CRC32 field in table headers */
3232 efi_update_table_header_crc32(&systab.hdr);
3233 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3234 efi_update_table_header_crc32(&efi_boot_services.hdr);