1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application boot time services
5 * Copyright (c) 2016 Alexander Graf
10 #include <efi_loader.h>
11 #include <environment.h>
13 #include <linux/libfdt_env.h>
14 #include <u-boot/crc.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 /* Task priority level */
22 static efi_uintn_t efi_tpl = TPL_APPLICATION;
24 /* This list contains all the EFI objects our payload has access to */
25 LIST_HEAD(efi_obj_list);
27 /* List of all events */
28 LIST_HEAD(efi_events);
31 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
32 * we need to do trickery with caches. Since we don't want to break the EFI
33 * aware boot path, only apply hacks when loading exiting directly (breaking
34 * direct Linux EFI booting along the way - oh well).
36 static bool efi_is_direct_boot = true;
39 * EFI can pass arbitrary additional "tables" containing vendor specific
40 * information to the payload. One such table is the FDT table which contains
41 * a pointer to a flattened device tree blob.
43 * In most cases we want to pass an FDT to the payload, so reserve one slot of
44 * config table space for it. The pointer gets populated by do_bootefi_exec().
46 static struct efi_configuration_table __efi_runtime_data efi_conf_table[16];
50 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
51 * fixed when compiling U-Boot. However, the payload does not know about that
52 * restriction so we need to manually swap its and our view of that register on
53 * EFI callback entry/exit.
55 static volatile void *efi_gd, *app_gd;
58 static int entry_count;
59 static int nesting_level;
60 /* GUID of the device tree table */
61 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
62 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
63 const efi_guid_t efi_guid_driver_binding_protocol =
64 EFI_DRIVER_BINDING_PROTOCOL_GUID;
66 /* event group ExitBootServices() invoked */
67 const efi_guid_t efi_guid_event_group_exit_boot_services =
68 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
69 /* event group SetVirtualAddressMap() invoked */
70 const efi_guid_t efi_guid_event_group_virtual_address_change =
71 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
72 /* event group memory map changed */
73 const efi_guid_t efi_guid_event_group_memory_map_change =
74 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
75 /* event group boot manager about to boot */
76 const efi_guid_t efi_guid_event_group_ready_to_boot =
77 EFI_EVENT_GROUP_READY_TO_BOOT;
78 /* event group ResetSystem() invoked (before ExitBootServices) */
79 const efi_guid_t efi_guid_event_group_reset_system =
80 EFI_EVENT_GROUP_RESET_SYSTEM;
82 static efi_status_t EFIAPI efi_disconnect_controller(
83 efi_handle_t controller_handle,
84 efi_handle_t driver_image_handle,
85 efi_handle_t child_handle);
87 /* Called on every callback entry */
88 int __efi_entry_check(void)
90 int ret = entry_count++ == 0;
99 /* Called on every callback exit */
100 int __efi_exit_check(void)
102 int ret = --entry_count == 0;
109 /* Called from do_bootefi_exec() */
110 void efi_save_gd(void)
118 * Special case handler for error/abort that just forces things back to u-boot
119 * world so we can dump out an abort msg, without any care about returning back
122 void efi_restore_gd(void)
125 /* Only restore if we're already in EFI context */
133 * indent_string() - returns a string for indenting with two spaces per level
134 * @level: indent level
136 * A maximum of ten indent levels is supported. Higher indent levels will be
139 * Return: A string for indenting with two spaces per level is
142 static const char *indent_string(int level)
144 const char *indent = " ";
145 const int max = strlen(indent);
147 level = min(max, level * 2);
148 return &indent[max - level];
151 const char *__efi_nesting(void)
153 return indent_string(nesting_level);
156 const char *__efi_nesting_inc(void)
158 return indent_string(nesting_level++);
161 const char *__efi_nesting_dec(void)
163 return indent_string(--nesting_level);
167 * efi_queue_event() - queue an EFI event
168 * @event: event to signal
169 * @check_tpl: check the TPL level
171 * This function queues the notification function of the event for future
174 * The notification function is called if the task priority level of the event
175 * is higher than the current task priority level.
177 * For the SignalEvent service see efi_signal_event_ext.
180 static void efi_queue_event(struct efi_event *event, bool check_tpl)
182 if (event->notify_function) {
183 event->is_queued = true;
185 if (check_tpl && efi_tpl >= event->notify_tpl)
187 EFI_CALL_VOID(event->notify_function(event,
188 event->notify_context));
190 event->is_queued = false;
194 * is_valid_tpl() - check if the task priority level is valid
196 * @tpl: TPL level to check
197 * ReturnValue: status code
199 efi_status_t is_valid_tpl(efi_uintn_t tpl)
202 case TPL_APPLICATION:
208 return EFI_INVALID_PARAMETER;
213 * efi_signal_event() - signal an EFI event
214 * @event: event to signal
215 * @check_tpl: check the TPL level
217 * This function signals an event. If the event belongs to an event group all
218 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
219 * their notification function is queued.
221 * For the SignalEvent service see efi_signal_event_ext.
223 void efi_signal_event(struct efi_event *event, bool check_tpl)
226 struct efi_event *evt;
229 * The signaled state has to set before executing any
230 * notification function
232 list_for_each_entry(evt, &efi_events, link) {
233 if (!evt->group || guidcmp(evt->group, event->group))
235 if (evt->is_signaled)
237 evt->is_signaled = true;
238 if (evt->type & EVT_NOTIFY_SIGNAL &&
239 evt->notify_function)
240 evt->is_queued = true;
242 list_for_each_entry(evt, &efi_events, link) {
243 if (!evt->group || guidcmp(evt->group, event->group))
246 efi_queue_event(evt, check_tpl);
248 } else if (!event->is_signaled) {
249 event->is_signaled = true;
250 if (event->type & EVT_NOTIFY_SIGNAL)
251 efi_queue_event(event, check_tpl);
256 * efi_raise_tpl() - raise the task priority level
257 * @new_tpl: new value of the task priority level
259 * This function implements the RaiseTpl service.
261 * See the Unified Extensible Firmware Interface (UEFI) specification for
264 * Return: old value of the task priority level
266 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
268 efi_uintn_t old_tpl = efi_tpl;
270 EFI_ENTRY("0x%zx", new_tpl);
272 if (new_tpl < efi_tpl)
273 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
275 if (efi_tpl > TPL_HIGH_LEVEL)
276 efi_tpl = TPL_HIGH_LEVEL;
278 EFI_EXIT(EFI_SUCCESS);
283 * efi_restore_tpl() - lower the task priority level
284 * @old_tpl: value of the task priority level to be restored
286 * This function implements the RestoreTpl service.
288 * See the Unified Extensible Firmware Interface (UEFI) specification for
291 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
293 EFI_ENTRY("0x%zx", old_tpl);
295 if (old_tpl > efi_tpl)
296 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
298 if (efi_tpl > TPL_HIGH_LEVEL)
299 efi_tpl = TPL_HIGH_LEVEL;
302 * Lowering the TPL may have made queued events eligible for execution.
306 EFI_EXIT(EFI_SUCCESS);
310 * efi_allocate_pages_ext() - allocate memory pages
311 * @type: type of allocation to be performed
312 * @memory_type: usage type of the allocated memory
313 * @pages: number of pages to be allocated
314 * @memory: allocated memory
316 * This function implements the AllocatePages service.
318 * See the Unified Extensible Firmware Interface (UEFI) specification for
321 * Return: status code
323 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
329 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
330 r = efi_allocate_pages(type, memory_type, pages, memory);
335 * efi_free_pages_ext() - Free memory pages.
336 * @memory: start of the memory area to be freed
337 * @pages: number of pages to be freed
339 * This function implements the FreePages service.
341 * See the Unified Extensible Firmware Interface (UEFI) specification for
344 * Return: status code
346 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
351 EFI_ENTRY("%" PRIx64 ", 0x%zx", memory, pages);
352 r = efi_free_pages(memory, pages);
357 * efi_get_memory_map_ext() - get map describing memory usage
358 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
359 * on exit the size of the copied memory map
360 * @memory_map: buffer to which the memory map is written
361 * @map_key: key for the memory map
362 * @descriptor_size: size of an individual memory descriptor
363 * @descriptor_version: version number of the memory descriptor structure
365 * This function implements the GetMemoryMap service.
367 * See the Unified Extensible Firmware Interface (UEFI) specification for
370 * Return: status code
372 static efi_status_t EFIAPI efi_get_memory_map_ext(
373 efi_uintn_t *memory_map_size,
374 struct efi_mem_desc *memory_map,
375 efi_uintn_t *map_key,
376 efi_uintn_t *descriptor_size,
377 uint32_t *descriptor_version)
381 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
382 map_key, descriptor_size, descriptor_version);
383 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
384 descriptor_size, descriptor_version);
389 * efi_allocate_pool_ext() - allocate memory from pool
390 * @pool_type: type of the pool from which memory is to be allocated
391 * @size: number of bytes to be allocated
392 * @buffer: allocated memory
394 * This function implements the AllocatePool service.
396 * See the Unified Extensible Firmware Interface (UEFI) specification for
399 * Return: status code
401 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
407 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
408 r = efi_allocate_pool(pool_type, size, buffer);
413 * efi_free_pool_ext() - free memory from pool
414 * @buffer: start of memory to be freed
416 * This function implements the FreePool service.
418 * See the Unified Extensible Firmware Interface (UEFI) specification for
421 * Return: status code
423 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
427 EFI_ENTRY("%p", buffer);
428 r = efi_free_pool(buffer);
433 * efi_add_handle() - add a new object to the object list
434 * @obj: object to be added
436 * The protocols list is initialized. The object handle is set.
438 void efi_add_handle(struct efi_object *obj)
442 INIT_LIST_HEAD(&obj->protocols);
444 list_add_tail(&obj->link, &efi_obj_list);
448 * efi_create_handle() - create handle
449 * @handle: new handle
451 * Return: status code
453 efi_status_t efi_create_handle(efi_handle_t *handle)
455 struct efi_object *obj;
457 obj = calloc(1, sizeof(struct efi_object));
459 return EFI_OUT_OF_RESOURCES;
462 *handle = obj->handle;
468 * efi_search_protocol() - find a protocol on a handle.
470 * @protocol_guid: GUID of the protocol
471 * @handler: reference to the protocol
473 * Return: status code
475 efi_status_t efi_search_protocol(const efi_handle_t handle,
476 const efi_guid_t *protocol_guid,
477 struct efi_handler **handler)
479 struct efi_object *efiobj;
480 struct list_head *lhandle;
482 if (!handle || !protocol_guid)
483 return EFI_INVALID_PARAMETER;
484 efiobj = efi_search_obj(handle);
486 return EFI_INVALID_PARAMETER;
487 list_for_each(lhandle, &efiobj->protocols) {
488 struct efi_handler *protocol;
490 protocol = list_entry(lhandle, struct efi_handler, link);
491 if (!guidcmp(protocol->guid, protocol_guid)) {
497 return EFI_NOT_FOUND;
501 * efi_remove_protocol() - delete protocol from a handle
502 * @handle: handle from which the protocol shall be deleted
503 * @protocol: GUID of the protocol to be deleted
504 * @protocol_interface: interface of the protocol implementation
506 * Return: status code
508 efi_status_t efi_remove_protocol(const efi_handle_t handle,
509 const efi_guid_t *protocol,
510 void *protocol_interface)
512 struct efi_handler *handler;
515 ret = efi_search_protocol(handle, protocol, &handler);
516 if (ret != EFI_SUCCESS)
518 if (guidcmp(handler->guid, protocol))
519 return EFI_INVALID_PARAMETER;
520 if (handler->protocol_interface != protocol_interface)
521 return EFI_INVALID_PARAMETER;
522 list_del(&handler->link);
528 * efi_remove_all_protocols() - delete all protocols from a handle
529 * @handle: handle from which the protocols shall be deleted
531 * Return: status code
533 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
535 struct efi_object *efiobj;
536 struct efi_handler *protocol;
537 struct efi_handler *pos;
539 efiobj = efi_search_obj(handle);
541 return EFI_INVALID_PARAMETER;
542 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
545 ret = efi_remove_protocol(handle, protocol->guid,
546 protocol->protocol_interface);
547 if (ret != EFI_SUCCESS)
554 * efi_delete_handle() - delete handle
556 * @obj: handle to delete
558 void efi_delete_handle(struct efi_object *obj)
562 efi_remove_all_protocols(obj->handle);
563 list_del(&obj->link);
568 * efi_is_event() - check if a pointer is a valid event
569 * @event: pointer to check
571 * Return: status code
573 static efi_status_t efi_is_event(const struct efi_event *event)
575 const struct efi_event *evt;
578 return EFI_INVALID_PARAMETER;
579 list_for_each_entry(evt, &efi_events, link) {
583 return EFI_INVALID_PARAMETER;
587 * efi_create_event() - create an event
588 * @type: type of the event to create
589 * @notify_tpl: task priority level of the event
590 * @notify_function: notification function of the event
591 * @notify_context: pointer passed to the notification function
592 * @group: event group
593 * @event: created event
595 * This function is used inside U-Boot code to create an event.
597 * For the API function implementing the CreateEvent service see
598 * efi_create_event_ext.
600 * Return: status code
602 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
603 void (EFIAPI *notify_function) (
604 struct efi_event *event,
606 void *notify_context, efi_guid_t *group,
607 struct efi_event **event)
609 struct efi_event *evt;
612 return EFI_INVALID_PARAMETER;
617 case EVT_NOTIFY_SIGNAL:
618 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
619 case EVT_NOTIFY_WAIT:
620 case EVT_TIMER | EVT_NOTIFY_WAIT:
621 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
622 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
625 return EFI_INVALID_PARAMETER;
628 if (is_valid_tpl(notify_tpl) != EFI_SUCCESS)
629 return EFI_INVALID_PARAMETER;
631 evt = calloc(1, sizeof(struct efi_event));
633 return EFI_OUT_OF_RESOURCES;
635 evt->notify_tpl = notify_tpl;
636 evt->notify_function = notify_function;
637 evt->notify_context = notify_context;
639 /* Disable timers on bootup */
640 evt->trigger_next = -1ULL;
641 evt->is_queued = false;
642 evt->is_signaled = false;
643 list_add_tail(&evt->link, &efi_events);
649 * efi_create_event_ex() - create an event in a group
650 * @type: type of the event to create
651 * @notify_tpl: task priority level of the event
652 * @notify_function: notification function of the event
653 * @notify_context: pointer passed to the notification function
654 * @event: created event
655 * @event_group: event group
657 * This function implements the CreateEventEx service.
659 * See the Unified Extensible Firmware Interface (UEFI) specification for
662 * Return: status code
664 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
665 void (EFIAPI *notify_function) (
666 struct efi_event *event,
668 void *notify_context,
669 efi_guid_t *event_group,
670 struct efi_event **event)
672 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
673 notify_context, event_group);
674 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
675 notify_context, event_group, event));
679 * efi_create_event_ext() - create an event
680 * @type: type of the event to create
681 * @notify_tpl: task priority level of the event
682 * @notify_function: notification function of the event
683 * @notify_context: pointer passed to the notification function
684 * @event: created event
686 * This function implements the CreateEvent service.
688 * See the Unified Extensible Firmware Interface (UEFI) specification for
691 * Return: status code
693 static efi_status_t EFIAPI efi_create_event_ext(
694 uint32_t type, efi_uintn_t notify_tpl,
695 void (EFIAPI *notify_function) (
696 struct efi_event *event,
698 void *notify_context, struct efi_event **event)
700 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
702 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
703 notify_context, NULL, event));
707 * efi_timer_check() - check if a timer event has occurred
709 * Check if a timer event has occurred or a queued notification function should
712 * Our timers have to work without interrupts, so we check whenever keyboard
713 * input or disk accesses happen if enough time elapsed for them to fire.
715 void efi_timer_check(void)
717 struct efi_event *evt;
718 u64 now = timer_get_us();
720 list_for_each_entry(evt, &efi_events, link) {
722 efi_queue_event(evt, true);
723 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
725 switch (evt->trigger_type) {
726 case EFI_TIMER_RELATIVE:
727 evt->trigger_type = EFI_TIMER_STOP;
729 case EFI_TIMER_PERIODIC:
730 evt->trigger_next += evt->trigger_time;
735 evt->is_signaled = false;
736 efi_signal_event(evt, true);
742 * efi_set_timer() - set the trigger time for a timer event or stop the event
743 * @event: event for which the timer is set
744 * @type: type of the timer
745 * @trigger_time: trigger period in multiples of 100ns
747 * This is the function for internal usage in U-Boot. For the API function
748 * implementing the SetTimer service see efi_set_timer_ext.
750 * Return: status code
752 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
753 uint64_t trigger_time)
755 /* Check that the event is valid */
756 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
757 return EFI_INVALID_PARAMETER;
760 * The parameter defines a multiple of 100ns.
761 * We use multiples of 1000ns. So divide by 10.
763 do_div(trigger_time, 10);
767 event->trigger_next = -1ULL;
769 case EFI_TIMER_PERIODIC:
770 case EFI_TIMER_RELATIVE:
771 event->trigger_next = timer_get_us() + trigger_time;
774 return EFI_INVALID_PARAMETER;
776 event->trigger_type = type;
777 event->trigger_time = trigger_time;
778 event->is_signaled = false;
783 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
785 * @event: event for which the timer is set
786 * @type: type of the timer
787 * @trigger_time: trigger period in multiples of 100ns
789 * This function implements the SetTimer service.
791 * See the Unified Extensible Firmware Interface (UEFI) specification for
795 * Return: status code
797 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
798 enum efi_timer_delay type,
799 uint64_t trigger_time)
801 EFI_ENTRY("%p, %d, %" PRIx64, event, type, trigger_time);
802 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
806 * efi_wait_for_event() - wait for events to be signaled
807 * @num_events: number of events to be waited for
808 * @event: events to be waited for
809 * @index: index of the event that was signaled
811 * This function implements the WaitForEvent service.
813 * See the Unified Extensible Firmware Interface (UEFI) specification for
816 * Return: status code
818 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
819 struct efi_event **event,
824 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
826 /* Check parameters */
827 if (!num_events || !event)
828 return EFI_EXIT(EFI_INVALID_PARAMETER);
830 if (efi_tpl != TPL_APPLICATION)
831 return EFI_EXIT(EFI_UNSUPPORTED);
832 for (i = 0; i < num_events; ++i) {
833 if (efi_is_event(event[i]) != EFI_SUCCESS)
834 return EFI_EXIT(EFI_INVALID_PARAMETER);
835 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
836 return EFI_EXIT(EFI_INVALID_PARAMETER);
837 if (!event[i]->is_signaled)
838 efi_queue_event(event[i], true);
841 /* Wait for signal */
843 for (i = 0; i < num_events; ++i) {
844 if (event[i]->is_signaled)
847 /* Allow events to occur. */
853 * Reset the signal which is passed to the caller to allow periodic
856 event[i]->is_signaled = false;
860 return EFI_EXIT(EFI_SUCCESS);
864 * efi_signal_event_ext() - signal an EFI event
865 * @event: event to signal
867 * This function implements the SignalEvent service.
869 * See the Unified Extensible Firmware Interface (UEFI) specification for
872 * This functions sets the signaled state of the event and queues the
873 * notification function for execution.
875 * Return: status code
877 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
879 EFI_ENTRY("%p", event);
880 if (efi_is_event(event) != EFI_SUCCESS)
881 return EFI_EXIT(EFI_INVALID_PARAMETER);
882 efi_signal_event(event, true);
883 return EFI_EXIT(EFI_SUCCESS);
887 * efi_close_event() - close an EFI event
888 * @event: event to close
890 * This function implements the CloseEvent service.
892 * See the Unified Extensible Firmware Interface (UEFI) specification for
895 * Return: status code
897 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
899 EFI_ENTRY("%p", event);
900 if (efi_is_event(event) != EFI_SUCCESS)
901 return EFI_EXIT(EFI_INVALID_PARAMETER);
902 list_del(&event->link);
904 return EFI_EXIT(EFI_SUCCESS);
908 * efi_check_event() - check if an event is signaled
909 * @event: event to check
911 * This function implements the CheckEvent service.
913 * See the Unified Extensible Firmware Interface (UEFI) specification for
916 * If an event is not signaled yet, the notification function is queued. The
917 * signaled state is cleared.
919 * Return: status code
921 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
923 EFI_ENTRY("%p", event);
925 if (efi_is_event(event) != EFI_SUCCESS ||
926 event->type & EVT_NOTIFY_SIGNAL)
927 return EFI_EXIT(EFI_INVALID_PARAMETER);
928 if (!event->is_signaled)
929 efi_queue_event(event, true);
930 if (event->is_signaled) {
931 event->is_signaled = false;
932 return EFI_EXIT(EFI_SUCCESS);
934 return EFI_EXIT(EFI_NOT_READY);
938 * efi_search_obj() - find the internal EFI object for a handle
939 * @handle: handle to find
943 struct efi_object *efi_search_obj(const efi_handle_t handle)
945 struct efi_object *efiobj;
947 list_for_each_entry(efiobj, &efi_obj_list, link) {
948 if (efiobj->handle == handle)
956 * efi_open_protocol_info_entry() - create open protocol info entry and add it
958 * @handler: handler of a protocol
960 * Return: open protocol info entry
962 static struct efi_open_protocol_info_entry *efi_create_open_info(
963 struct efi_handler *handler)
965 struct efi_open_protocol_info_item *item;
967 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
970 /* Append the item to the open protocol info list. */
971 list_add_tail(&item->link, &handler->open_infos);
977 * efi_delete_open_info() - remove an open protocol info entry from a protocol
978 * @item: open protocol info entry to delete
980 * Return: status code
982 static efi_status_t efi_delete_open_info(
983 struct efi_open_protocol_info_item *item)
985 list_del(&item->link);
991 * efi_add_protocol() - install new protocol on a handle
992 * @handle: handle on which the protocol shall be installed
993 * @protocol: GUID of the protocol to be installed
994 * @protocol_interface: interface of the protocol implementation
996 * Return: status code
998 efi_status_t efi_add_protocol(const efi_handle_t handle,
999 const efi_guid_t *protocol,
1000 void *protocol_interface)
1002 struct efi_object *efiobj;
1003 struct efi_handler *handler;
1006 efiobj = efi_search_obj(handle);
1008 return EFI_INVALID_PARAMETER;
1009 ret = efi_search_protocol(handle, protocol, NULL);
1010 if (ret != EFI_NOT_FOUND)
1011 return EFI_INVALID_PARAMETER;
1012 handler = calloc(1, sizeof(struct efi_handler));
1014 return EFI_OUT_OF_RESOURCES;
1015 handler->guid = protocol;
1016 handler->protocol_interface = protocol_interface;
1017 INIT_LIST_HEAD(&handler->open_infos);
1018 list_add_tail(&handler->link, &efiobj->protocols);
1019 if (!guidcmp(&efi_guid_device_path, protocol))
1020 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1025 * efi_install_protocol_interface() - install protocol interface
1026 * @handle: handle on which the protocol shall be installed
1027 * @protocol: GUID of the protocol to be installed
1028 * @protocol_interface_type: type of the interface to be installed,
1029 * always EFI_NATIVE_INTERFACE
1030 * @protocol_interface: interface of the protocol implementation
1032 * This function implements the InstallProtocolInterface service.
1034 * See the Unified Extensible Firmware Interface (UEFI) specification for
1037 * Return: status code
1039 static efi_status_t EFIAPI efi_install_protocol_interface(
1040 void **handle, const efi_guid_t *protocol,
1041 int protocol_interface_type, void *protocol_interface)
1045 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1046 protocol_interface);
1048 if (!handle || !protocol ||
1049 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1050 r = EFI_INVALID_PARAMETER;
1054 /* Create new handle if requested. */
1056 r = efi_create_handle(handle);
1057 if (r != EFI_SUCCESS)
1059 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1062 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1065 /* Add new protocol */
1066 r = efi_add_protocol(*handle, protocol, protocol_interface);
1072 * efi_get_drivers() - get all drivers associated to a controller
1073 * @efiobj: handle of the controller
1074 * @protocol: protocol guid (optional)
1075 * @number_of_drivers: number of child controllers
1076 * @driver_handle_buffer: handles of the the drivers
1078 * The allocated buffer has to be freed with free().
1080 * Return: status code
1082 static efi_status_t efi_get_drivers(struct efi_object *efiobj,
1083 const efi_guid_t *protocol,
1084 efi_uintn_t *number_of_drivers,
1085 efi_handle_t **driver_handle_buffer)
1087 struct efi_handler *handler;
1088 struct efi_open_protocol_info_item *item;
1089 efi_uintn_t count = 0, i;
1092 /* Count all driver associations */
1093 list_for_each_entry(handler, &efiobj->protocols, link) {
1094 if (protocol && guidcmp(handler->guid, protocol))
1096 list_for_each_entry(item, &handler->open_infos, link) {
1097 if (item->info.attributes &
1098 EFI_OPEN_PROTOCOL_BY_DRIVER)
1103 * Create buffer. In case of duplicate driver assignments the buffer
1104 * will be too large. But that does not harm.
1106 *number_of_drivers = 0;
1107 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1108 if (!*driver_handle_buffer)
1109 return EFI_OUT_OF_RESOURCES;
1110 /* Collect unique driver handles */
1111 list_for_each_entry(handler, &efiobj->protocols, link) {
1112 if (protocol && guidcmp(handler->guid, protocol))
1114 list_for_each_entry(item, &handler->open_infos, link) {
1115 if (item->info.attributes &
1116 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1117 /* Check this is a new driver */
1119 for (i = 0; i < *number_of_drivers; ++i) {
1120 if ((*driver_handle_buffer)[i] ==
1121 item->info.agent_handle)
1124 /* Copy handle to buffer */
1126 i = (*number_of_drivers)++;
1127 (*driver_handle_buffer)[i] =
1128 item->info.agent_handle;
1137 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1138 * @efiobj: handle of the controller
1139 * @protocol: protocol guid (optional)
1140 * @child_handle: handle of the child to destroy
1142 * This function implements the DisconnectController service.
1144 * See the Unified Extensible Firmware Interface (UEFI) specification for
1147 * Return: status code
1149 static efi_status_t efi_disconnect_all_drivers(
1150 struct efi_object *efiobj,
1151 const efi_guid_t *protocol,
1152 efi_handle_t child_handle)
1154 efi_uintn_t number_of_drivers;
1155 efi_handle_t *driver_handle_buffer;
1156 efi_status_t r, ret;
1158 ret = efi_get_drivers(efiobj, protocol, &number_of_drivers,
1159 &driver_handle_buffer);
1160 if (ret != EFI_SUCCESS)
1163 ret = EFI_NOT_FOUND;
1164 while (number_of_drivers) {
1165 r = EFI_CALL(efi_disconnect_controller(
1167 driver_handle_buffer[--number_of_drivers],
1169 if (r == EFI_SUCCESS)
1172 free(driver_handle_buffer);
1177 * efi_uninstall_protocol_interface() - uninstall protocol interface
1178 * @handle: handle from which the protocol shall be removed
1179 * @protocol: GUID of the protocol to be removed
1180 * @protocol_interface: interface to be removed
1182 * This function implements the UninstallProtocolInterface service.
1184 * See the Unified Extensible Firmware Interface (UEFI) specification for
1187 * Return: status code
1189 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
1190 efi_handle_t handle, const efi_guid_t *protocol,
1191 void *protocol_interface)
1193 struct efi_object *efiobj;
1194 struct efi_handler *handler;
1195 struct efi_open_protocol_info_item *item;
1196 struct efi_open_protocol_info_item *pos;
1199 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1202 efiobj = efi_search_obj(handle);
1204 r = EFI_INVALID_PARAMETER;
1207 /* Find the protocol on the handle */
1208 r = efi_search_protocol(handle, protocol, &handler);
1209 if (r != EFI_SUCCESS)
1211 /* Disconnect controllers */
1212 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1213 if (!list_empty(&handler->open_infos)) {
1214 r = EFI_ACCESS_DENIED;
1217 /* Close protocol */
1218 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1219 if (item->info.attributes ==
1220 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1221 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1222 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1223 list_del(&item->link);
1225 if (!list_empty(&handler->open_infos)) {
1226 r = EFI_ACCESS_DENIED;
1229 r = efi_remove_protocol(handle, protocol, protocol_interface);
1235 * efi_register_protocol_notify() - register an event for notification when a
1236 * protocol is installed.
1237 * @protocol: GUID of the protocol whose installation shall be notified
1238 * @event: event to be signaled upon installation of the protocol
1239 * @registration: key for retrieving the registration information
1241 * This function implements the RegisterProtocolNotify service.
1242 * See the Unified Extensible Firmware Interface (UEFI) specification
1245 * Return: status code
1247 static efi_status_t EFIAPI efi_register_protocol_notify(
1248 const efi_guid_t *protocol,
1249 struct efi_event *event,
1250 void **registration)
1252 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1253 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1257 * efi_search() - determine if an EFI handle implements a protocol
1258 * @search_type: selection criterion
1259 * @protocol: GUID of the protocol
1260 * @search_key: registration key
1263 * See the documentation of the LocateHandle service in the UEFI specification.
1265 * Return: 0 if the handle implements the protocol
1267 static int efi_search(enum efi_locate_search_type search_type,
1268 const efi_guid_t *protocol, void *search_key,
1269 struct efi_object *efiobj)
1273 switch (search_type) {
1276 case BY_REGISTER_NOTIFY:
1277 /* TODO: RegisterProtocolNotify is not implemented yet */
1280 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1281 return (ret != EFI_SUCCESS);
1283 /* Invalid search type */
1289 * efi_locate_handle() - locate handles implementing a protocol
1290 * @search_type: selection criterion
1291 * @protocol: GUID of the protocol
1292 * @search_key: registration key
1293 * @buffer_size: size of the buffer to receive the handles in bytes
1294 * @buffer: buffer to receive the relevant handles
1296 * This function is meant for U-Boot internal calls. For the API implementation
1297 * of the LocateHandle service see efi_locate_handle_ext.
1299 * Return: status code
1301 static efi_status_t efi_locate_handle(
1302 enum efi_locate_search_type search_type,
1303 const efi_guid_t *protocol, void *search_key,
1304 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1306 struct efi_object *efiobj;
1307 efi_uintn_t size = 0;
1309 /* Check parameters */
1310 switch (search_type) {
1313 case BY_REGISTER_NOTIFY:
1315 return EFI_INVALID_PARAMETER;
1316 /* RegisterProtocolNotify is not implemented yet */
1317 return EFI_UNSUPPORTED;
1320 return EFI_INVALID_PARAMETER;
1323 return EFI_INVALID_PARAMETER;
1327 * efi_locate_handle_buffer uses this function for
1328 * the calculation of the necessary buffer size.
1329 * So do not require a buffer for buffersize == 0.
1331 if (!buffer_size || (*buffer_size && !buffer))
1332 return EFI_INVALID_PARAMETER;
1334 /* Count how much space we need */
1335 list_for_each_entry(efiobj, &efi_obj_list, link) {
1336 if (!efi_search(search_type, protocol, search_key, efiobj))
1337 size += sizeof(void *);
1340 if (*buffer_size < size) {
1341 *buffer_size = size;
1342 return EFI_BUFFER_TOO_SMALL;
1345 *buffer_size = size;
1347 return EFI_NOT_FOUND;
1349 /* Then fill the array */
1350 list_for_each_entry(efiobj, &efi_obj_list, link) {
1351 if (!efi_search(search_type, protocol, search_key, efiobj))
1352 *buffer++ = efiobj->handle;
1359 * efi_locate_handle_ext() - locate handles implementing a protocol.
1360 * @search_type: selection criterion
1361 * @protocol: GUID of the protocol
1362 * @search_key: registration key
1363 * @buffer_size: size of the buffer to receive the handles in bytes
1364 * @buffer: buffer to receive the relevant handles
1366 * This function implements the LocateHandle service.
1368 * See the Unified Extensible Firmware Interface (UEFI) specification for
1371 * Return: 0 if the handle implements the protocol
1373 static efi_status_t EFIAPI efi_locate_handle_ext(
1374 enum efi_locate_search_type search_type,
1375 const efi_guid_t *protocol, void *search_key,
1376 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1378 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1379 buffer_size, buffer);
1381 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1382 buffer_size, buffer));
1386 * efi_remove_configuration_table() - collapses configuration table entries,
1389 * @i: index of the table entry to be removed
1391 static void efi_remove_configuration_table(int i)
1393 struct efi_configuration_table *this = &efi_conf_table[i];
1394 struct efi_configuration_table *next = &efi_conf_table[i + 1];
1395 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1397 memmove(this, next, (ulong)end - (ulong)next);
1402 * efi_install_configuration_table() - adds, updates, or removes a
1403 * configuration table
1404 * @guid: GUID of the installed table
1405 * @table: table to be installed
1407 * This function is used for internal calls. For the API implementation of the
1408 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1410 * Return: status code
1412 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1415 struct efi_event *evt;
1419 return EFI_INVALID_PARAMETER;
1421 /* Check for guid override */
1422 for (i = 0; i < systab.nr_tables; i++) {
1423 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1425 efi_conf_table[i].table = table;
1427 efi_remove_configuration_table(i);
1433 return EFI_NOT_FOUND;
1435 /* No override, check for overflow */
1436 if (i >= ARRAY_SIZE(efi_conf_table))
1437 return EFI_OUT_OF_RESOURCES;
1439 /* Add a new entry */
1440 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1441 efi_conf_table[i].table = table;
1442 systab.nr_tables = i + 1;
1445 /* Notify that the configuration table was changed */
1446 list_for_each_entry(evt, &efi_events, link) {
1447 if (evt->group && !guidcmp(evt->group, guid)) {
1448 efi_signal_event(evt, false);
1457 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1458 * configuration table.
1459 * @guid: GUID of the installed table
1460 * @table: table to be installed
1462 * This function implements the InstallConfigurationTable service.
1464 * See the Unified Extensible Firmware Interface (UEFI) specification for
1467 * Return: status code
1469 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1472 EFI_ENTRY("%pUl, %p", guid, table);
1473 return EFI_EXIT(efi_install_configuration_table(guid, table));
1477 * efi_setup_loaded_image() - initialize a loaded image
1478 * @info: loaded image info to be passed to the entry point of the image
1479 * @obj: internal object associated with the loaded image
1480 * @device_path: device path of the loaded image
1481 * @file_path: file path of the loaded image
1483 * Initialize a loaded_image_info and loaded_image_info object with correct
1484 * protocols, boot-device, etc.
1486 * Return: status code
1488 efi_status_t efi_setup_loaded_image(
1489 struct efi_loaded_image *info, struct efi_object *obj,
1490 struct efi_device_path *device_path,
1491 struct efi_device_path *file_path)
1495 /* Add internal object to object list */
1496 efi_add_handle(obj);
1497 /* efi_exit() assumes that the handle points to the info */
1500 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1501 info->file_path = file_path;
1504 info->device_handle = efi_dp_find_obj(device_path, NULL);
1506 * When asking for the device path interface, return
1507 * bootefi_device_path
1509 ret = efi_add_protocol(obj->handle, &efi_guid_device_path,
1511 if (ret != EFI_SUCCESS)
1516 * When asking for the loaded_image interface, just
1517 * return handle which points to loaded_image_info
1519 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1520 if (ret != EFI_SUCCESS)
1523 ret = efi_add_protocol(obj->handle,
1524 &efi_guid_device_path_to_text_protocol,
1525 (void *)&efi_device_path_to_text);
1526 if (ret != EFI_SUCCESS)
1529 ret = efi_add_protocol(obj->handle,
1530 &efi_guid_device_path_utilities_protocol,
1531 (void *)&efi_device_path_utilities);
1532 if (ret != EFI_SUCCESS)
1537 printf("ERROR: Failure to install protocols for loaded image\n");
1542 * efi_load_image_from_path() - load an image using a file path
1543 * @file_path: the path of the image to load
1544 * @buffer: buffer containing the loaded image
1546 * Return: status code
1548 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1551 struct efi_file_info *info = NULL;
1552 struct efi_file_handle *f;
1553 static efi_status_t ret;
1556 f = efi_file_from_path(file_path);
1558 return EFI_DEVICE_ERROR;
1561 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1563 if (ret == EFI_BUFFER_TOO_SMALL) {
1565 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1568 if (ret != EFI_SUCCESS)
1571 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1575 bs = info->file_size;
1576 EFI_CALL(ret = f->read(f, &bs, *buffer));
1580 EFI_CALL(f->close(f));
1582 if (ret != EFI_SUCCESS) {
1583 efi_free_pool(*buffer);
1591 * efi_load_image() - load an EFI image into memory
1592 * @boot_policy: true for request originating from the boot manager
1593 * @parent_image: the caller's image handle
1594 * @file_path: the path of the image to load
1595 * @source_buffer: memory location from which the image is installed
1596 * @source_size: size of the memory area from which the image is installed
1597 * @image_handle: handle for the newly installed image
1599 * This function implements the LoadImage service.
1601 * See the Unified Extensible Firmware Interface (UEFI) specification
1604 * Return: status code
1606 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1607 efi_handle_t parent_image,
1608 struct efi_device_path *file_path,
1609 void *source_buffer,
1610 efi_uintn_t source_size,
1611 efi_handle_t *image_handle)
1613 struct efi_loaded_image *info;
1614 struct efi_object *obj;
1617 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1618 file_path, source_buffer, source_size, image_handle);
1620 if (!image_handle || !parent_image) {
1621 ret = EFI_INVALID_PARAMETER;
1625 if (!source_buffer && !file_path) {
1626 ret = EFI_NOT_FOUND;
1630 info = calloc(1, sizeof(*info));
1632 ret = EFI_OUT_OF_RESOURCES;
1635 obj = calloc(1, sizeof(*obj));
1638 ret = EFI_OUT_OF_RESOURCES;
1642 if (!source_buffer) {
1643 struct efi_device_path *dp, *fp;
1645 ret = efi_load_image_from_path(file_path, &source_buffer);
1646 if (ret != EFI_SUCCESS)
1649 * split file_path which contains both the device and
1652 efi_dp_split_file_path(file_path, &dp, &fp);
1653 ret = efi_setup_loaded_image(info, obj, dp, fp);
1654 if (ret != EFI_SUCCESS)
1657 /* In this case, file_path is the "device" path, ie.
1658 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1660 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1661 if (ret != EFI_SUCCESS)
1664 info->reserved = efi_load_pe(source_buffer, info);
1665 if (!info->reserved) {
1666 ret = EFI_UNSUPPORTED;
1669 info->system_table = &systab;
1670 info->parent_handle = parent_image;
1671 *image_handle = obj->handle;
1672 return EFI_EXIT(EFI_SUCCESS);
1675 efi_delete_handle(obj);
1677 return EFI_EXIT(ret);
1681 * efi_start_image() - dall the entry point of an image
1682 * @image_handle: handle of the image
1683 * @exit_data_size: size of the buffer
1684 * @exit_data: buffer to receive the exit data of the called image
1686 * This function implements the StartImage service.
1688 * See the Unified Extensible Firmware Interface (UEFI) specification for
1691 * Return: status code
1693 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1694 unsigned long *exit_data_size,
1697 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
1698 struct efi_system_table *st);
1699 struct efi_loaded_image *info = image_handle;
1702 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1703 entry = info->reserved;
1705 efi_is_direct_boot = false;
1707 /* call the image! */
1708 if (setjmp(&info->exit_jmp)) {
1710 * We called the entry point of the child image with EFI_CALL
1711 * in the lines below. The child image called the Exit() boot
1712 * service efi_exit() which executed the long jump that brought
1713 * us to the current line. This implies that the second half
1714 * of the EFI_CALL macro has not been executed.
1718 * efi_exit() called efi_restore_gd(). We have to undo this
1719 * otherwise __efi_entry_check() will put the wrong value into
1725 * To get ready to call EFI_EXIT below we have to execute the
1726 * missed out steps of EFI_CALL.
1728 assert(__efi_entry_check());
1729 debug("%sEFI: %lu returned by started image\n",
1730 __efi_nesting_dec(),
1731 (unsigned long)((uintptr_t)info->exit_status &
1733 return EFI_EXIT(info->exit_status);
1736 ret = EFI_CALL(entry(image_handle, &systab));
1739 * Usually UEFI applications call Exit() instead of returning.
1740 * But because the world doesn not consist of ponies and unicorns,
1741 * we're happy to emulate that behavior on behalf of a payload
1744 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
1748 * efi_exit() - leave an EFI application or driver
1749 * @image_handle: handle of the application or driver that is exiting
1750 * @exit_status: status code
1751 * @exit_data_size: size of the buffer in bytes
1752 * @exit_data: buffer with data describing an error
1754 * This function implements the Exit service.
1756 * See the Unified Extensible Firmware Interface (UEFI) specification for
1759 * Return: status code
1761 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1762 efi_status_t exit_status,
1763 unsigned long exit_data_size,
1767 * We require that the handle points to the original loaded
1768 * image protocol interface.
1770 * For getting the longjmp address this is safer than locating
1771 * the protocol because the protocol may have been reinstalled
1772 * pointing to another memory location.
1774 * TODO: We should call the unload procedure of the loaded
1777 struct efi_loaded_image *loaded_image_info = (void *)image_handle;
1779 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1780 exit_data_size, exit_data);
1782 /* Make sure entry/exit counts for EFI world cross-overs match */
1783 EFI_EXIT(exit_status);
1786 * But longjmp out with the U-Boot gd, not the application's, as
1787 * the other end is a setjmp call inside EFI context.
1791 loaded_image_info->exit_status = exit_status;
1792 longjmp(&loaded_image_info->exit_jmp, 1);
1794 panic("EFI application exited");
1798 * efi_unload_image() - unload an EFI image
1799 * @image_handle: handle of the image to be unloaded
1801 * This function implements the UnloadImage service.
1803 * See the Unified Extensible Firmware Interface (UEFI) specification for
1806 * Return: status code
1808 static efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
1810 struct efi_object *efiobj;
1812 EFI_ENTRY("%p", image_handle);
1813 efiobj = efi_search_obj(image_handle);
1815 list_del(&efiobj->link);
1817 return EFI_EXIT(EFI_SUCCESS);
1821 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1823 static void efi_exit_caches(void)
1825 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1827 * Grub on 32bit ARM needs to have caches disabled before jumping into
1828 * a zImage, but does not know of all cache layers. Give it a hand.
1830 if (efi_is_direct_boot)
1831 cleanup_before_linux();
1836 * efi_exit_boot_services() - stop all boot services
1837 * @image_handle: handle of the loaded image
1838 * @map_key: key of the memory map
1840 * This function implements the ExitBootServices service.
1842 * See the Unified Extensible Firmware Interface (UEFI) specification
1845 * All timer events are disabled. For exit boot services events the
1846 * notification function is called. The boot services are disabled in the
1849 * Return: status code
1851 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1852 unsigned long map_key)
1854 struct efi_event *evt;
1856 EFI_ENTRY("%p, %ld", image_handle, map_key);
1858 /* Check that the caller has read the current memory map */
1859 if (map_key != efi_memory_map_key)
1860 return EFI_INVALID_PARAMETER;
1862 /* Make sure that notification functions are not called anymore */
1863 efi_tpl = TPL_HIGH_LEVEL;
1865 /* Check if ExitBootServices has already been called */
1866 if (!systab.boottime)
1867 return EFI_EXIT(EFI_SUCCESS);
1869 /* Add related events to the event group */
1870 list_for_each_entry(evt, &efi_events, link) {
1871 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1872 evt->group = &efi_guid_event_group_exit_boot_services;
1874 /* Notify that ExitBootServices is invoked. */
1875 list_for_each_entry(evt, &efi_events, link) {
1877 !guidcmp(evt->group,
1878 &efi_guid_event_group_exit_boot_services)) {
1879 efi_signal_event(evt, false);
1884 /* TODO Should persist EFI variables here */
1886 board_quiesce_devices();
1888 /* Fix up caches for EFI payloads if necessary */
1891 /* This stops all lingering devices */
1892 bootm_disable_interrupts();
1894 /* Disable boottime services */
1895 systab.con_in_handle = NULL;
1896 systab.con_in = NULL;
1897 systab.con_out_handle = NULL;
1898 systab.con_out = NULL;
1899 systab.stderr_handle = NULL;
1900 systab.std_err = NULL;
1901 systab.boottime = NULL;
1903 /* Recalculate CRC32 */
1904 systab.hdr.crc32 = 0;
1905 systab.hdr.crc32 = crc32(0, (const unsigned char *)&systab,
1906 sizeof(struct efi_system_table));
1908 /* Give the payload some time to boot */
1909 efi_set_watchdog(0);
1912 return EFI_EXIT(EFI_SUCCESS);
1916 * efi_get_next_monotonic_count() - get next value of the counter
1917 * @count: returned value of the counter
1919 * This function implements the NextMonotonicCount service.
1921 * See the Unified Extensible Firmware Interface (UEFI) specification for
1924 * Return: status code
1926 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1928 static uint64_t mono;
1930 EFI_ENTRY("%p", count);
1932 return EFI_EXIT(EFI_SUCCESS);
1936 * efi_stall() - sleep
1937 * @microseconds: period to sleep in microseconds
1939 * This function implements the Stall service.
1941 * See the Unified Extensible Firmware Interface (UEFI) specification for
1944 * Return: status code
1946 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1948 EFI_ENTRY("%ld", microseconds);
1949 udelay(microseconds);
1950 return EFI_EXIT(EFI_SUCCESS);
1954 * efi_set_watchdog_timer() - reset the watchdog timer
1955 * @timeout: seconds before reset by watchdog
1956 * @watchdog_code: code to be logged when resetting
1957 * @data_size: size of buffer in bytes
1958 * @watchdog_data: buffer with data describing the reset reason
1960 * This function implements the SetWatchdogTimer service.
1962 * See the Unified Extensible Firmware Interface (UEFI) specification for
1965 * Return: status code
1967 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1968 uint64_t watchdog_code,
1969 unsigned long data_size,
1970 uint16_t *watchdog_data)
1972 EFI_ENTRY("%ld, 0x%" PRIx64 ", %ld, %p", timeout, watchdog_code,
1973 data_size, watchdog_data);
1974 return EFI_EXIT(efi_set_watchdog(timeout));
1978 * efi_close_protocol() - close a protocol
1979 * @handle: handle on which the protocol shall be closed
1980 * @protocol: GUID of the protocol to close
1981 * @agent_handle: handle of the driver
1982 * @controller_handle: handle of the controller
1984 * This function implements the CloseProtocol service.
1986 * See the Unified Extensible Firmware Interface (UEFI) specification for
1989 * Return: status code
1991 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1992 const efi_guid_t *protocol,
1993 efi_handle_t agent_handle,
1994 efi_handle_t controller_handle)
1996 struct efi_handler *handler;
1997 struct efi_open_protocol_info_item *item;
1998 struct efi_open_protocol_info_item *pos;
2001 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2004 if (!agent_handle) {
2005 r = EFI_INVALID_PARAMETER;
2008 r = efi_search_protocol(handle, protocol, &handler);
2009 if (r != EFI_SUCCESS)
2013 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2014 if (item->info.agent_handle == agent_handle &&
2015 item->info.controller_handle == controller_handle) {
2016 efi_delete_open_info(item);
2026 * efi_open_protocol_information() - provide information about then open status
2027 * of a protocol on a handle
2028 * @handle: handle for which the information shall be retrieved
2029 * @protocol: GUID of the protocol
2030 * @entry_buffer: buffer to receive the open protocol information
2031 * @entry_count: number of entries available in the buffer
2033 * This function implements the OpenProtocolInformation service.
2035 * See the Unified Extensible Firmware Interface (UEFI) specification for
2038 * Return: status code
2040 static efi_status_t EFIAPI efi_open_protocol_information(
2041 efi_handle_t handle, const efi_guid_t *protocol,
2042 struct efi_open_protocol_info_entry **entry_buffer,
2043 efi_uintn_t *entry_count)
2045 unsigned long buffer_size;
2046 unsigned long count;
2047 struct efi_handler *handler;
2048 struct efi_open_protocol_info_item *item;
2051 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2054 /* Check parameters */
2055 if (!entry_buffer) {
2056 r = EFI_INVALID_PARAMETER;
2059 r = efi_search_protocol(handle, protocol, &handler);
2060 if (r != EFI_SUCCESS)
2065 list_for_each_entry(item, &handler->open_infos, link) {
2066 if (item->info.open_count)
2069 *entry_count = count;
2070 *entry_buffer = NULL;
2077 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2078 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2079 (void **)entry_buffer);
2080 if (r != EFI_SUCCESS)
2082 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2083 if (item->info.open_count)
2084 (*entry_buffer)[--count] = item->info;
2091 * efi_protocols_per_handle() - get protocols installed on a handle
2092 * @handle: handle for which the information is retrieved
2093 * @protocol_buffer: buffer with protocol GUIDs
2094 * @protocol_buffer_count: number of entries in the buffer
2096 * This function implements the ProtocolsPerHandleService.
2098 * See the Unified Extensible Firmware Interface (UEFI) specification for
2101 * Return: status code
2103 static efi_status_t EFIAPI efi_protocols_per_handle(
2104 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2105 efi_uintn_t *protocol_buffer_count)
2107 unsigned long buffer_size;
2108 struct efi_object *efiobj;
2109 struct list_head *protocol_handle;
2112 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2113 protocol_buffer_count);
2115 if (!handle || !protocol_buffer || !protocol_buffer_count)
2116 return EFI_EXIT(EFI_INVALID_PARAMETER);
2118 *protocol_buffer = NULL;
2119 *protocol_buffer_count = 0;
2121 efiobj = efi_search_obj(handle);
2123 return EFI_EXIT(EFI_INVALID_PARAMETER);
2125 /* Count protocols */
2126 list_for_each(protocol_handle, &efiobj->protocols) {
2127 ++*protocol_buffer_count;
2131 if (*protocol_buffer_count) {
2134 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2135 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2136 (void **)protocol_buffer);
2137 if (r != EFI_SUCCESS)
2139 list_for_each(protocol_handle, &efiobj->protocols) {
2140 struct efi_handler *protocol;
2142 protocol = list_entry(protocol_handle,
2143 struct efi_handler, link);
2144 (*protocol_buffer)[j] = (void *)protocol->guid;
2149 return EFI_EXIT(EFI_SUCCESS);
2153 * efi_locate_handle_buffer() - locate handles implementing a protocol
2154 * @search_type: selection criterion
2155 * @protocol: GUID of the protocol
2156 * @search_key: registration key
2157 * @no_handles: number of returned handles
2158 * @buffer: buffer with the returned handles
2160 * This function implements the LocateHandleBuffer service.
2162 * See the Unified Extensible Firmware Interface (UEFI) specification for
2165 * Return: status code
2167 static efi_status_t EFIAPI efi_locate_handle_buffer(
2168 enum efi_locate_search_type search_type,
2169 const efi_guid_t *protocol, void *search_key,
2170 efi_uintn_t *no_handles, efi_handle_t **buffer)
2173 efi_uintn_t buffer_size = 0;
2175 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2176 no_handles, buffer);
2178 if (!no_handles || !buffer) {
2179 r = EFI_INVALID_PARAMETER;
2184 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2186 if (r != EFI_BUFFER_TOO_SMALL)
2188 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
2190 if (r != EFI_SUCCESS)
2192 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2194 if (r == EFI_SUCCESS)
2195 *no_handles = buffer_size / sizeof(efi_handle_t);
2201 * efi_locate_protocol() - find an interface implementing a protocol
2202 * @protocol: GUID of the protocol
2203 * @registration: registration key passed to the notification function
2204 * @protocol_interface: interface implementing the protocol
2206 * This function implements the LocateProtocol service.
2208 * See the Unified Extensible Firmware Interface (UEFI) specification for
2211 * Return: status code
2213 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2215 void **protocol_interface)
2217 struct list_head *lhandle;
2220 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2222 if (!protocol || !protocol_interface)
2223 return EFI_EXIT(EFI_INVALID_PARAMETER);
2225 list_for_each(lhandle, &efi_obj_list) {
2226 struct efi_object *efiobj;
2227 struct efi_handler *handler;
2229 efiobj = list_entry(lhandle, struct efi_object, link);
2231 ret = efi_search_protocol(efiobj->handle, protocol, &handler);
2232 if (ret == EFI_SUCCESS) {
2233 *protocol_interface = handler->protocol_interface;
2234 return EFI_EXIT(EFI_SUCCESS);
2237 *protocol_interface = NULL;
2239 return EFI_EXIT(EFI_NOT_FOUND);
2243 * efi_locate_device_path() - Get the device path and handle of an device
2244 * implementing a protocol
2245 * @protocol: GUID of the protocol
2246 * @device_path: device path
2247 * @device: handle of the device
2249 * This function implements the LocateDevicePath service.
2251 * See the Unified Extensible Firmware Interface (UEFI) specification for
2254 * Return: status code
2256 static efi_status_t EFIAPI efi_locate_device_path(
2257 const efi_guid_t *protocol,
2258 struct efi_device_path **device_path,
2259 efi_handle_t *device)
2261 struct efi_device_path *dp;
2263 struct efi_handler *handler;
2264 efi_handle_t *handles;
2266 size_t len_best = 0;
2267 efi_uintn_t no_handles;
2271 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2273 if (!protocol || !device_path || !*device_path || !device) {
2274 ret = EFI_INVALID_PARAMETER;
2278 /* Find end of device path */
2279 len = efi_dp_instance_size(*device_path);
2281 /* Get all handles implementing the protocol */
2282 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2283 &no_handles, &handles));
2284 if (ret != EFI_SUCCESS)
2287 for (i = 0; i < no_handles; ++i) {
2288 /* Find the device path protocol */
2289 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2291 if (ret != EFI_SUCCESS)
2293 dp = (struct efi_device_path *)handler->protocol_interface;
2294 len_dp = efi_dp_instance_size(dp);
2296 * This handle can only be a better fit
2297 * if its device path length is longer than the best fit and
2298 * if its device path length is shorter of equal the searched
2301 if (len_dp <= len_best || len_dp > len)
2303 /* Check if dp is a subpath of device_path */
2304 if (memcmp(*device_path, dp, len_dp))
2306 *device = handles[i];
2310 remainder = (u8 *)*device_path + len_best;
2311 *device_path = (struct efi_device_path *)remainder;
2314 ret = EFI_NOT_FOUND;
2317 return EFI_EXIT(ret);
2321 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2323 * @handle: handle on which the protocol interfaces shall be installed
2324 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2327 * This function implements the MultipleProtocolInterfaces service.
2329 * See the Unified Extensible Firmware Interface (UEFI) specification for
2332 * Return: status code
2334 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2337 EFI_ENTRY("%p", handle);
2340 const efi_guid_t *protocol;
2341 void *protocol_interface;
2342 efi_status_t r = EFI_SUCCESS;
2346 return EFI_EXIT(EFI_INVALID_PARAMETER);
2348 efi_va_start(argptr, handle);
2350 protocol = efi_va_arg(argptr, efi_guid_t*);
2353 protocol_interface = efi_va_arg(argptr, void*);
2354 r = EFI_CALL(efi_install_protocol_interface(
2356 EFI_NATIVE_INTERFACE,
2357 protocol_interface));
2358 if (r != EFI_SUCCESS)
2363 if (r == EFI_SUCCESS)
2366 /* If an error occurred undo all changes. */
2367 efi_va_start(argptr, handle);
2369 protocol = efi_va_arg(argptr, efi_guid_t*);
2370 protocol_interface = efi_va_arg(argptr, void*);
2371 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2372 protocol_interface));
2380 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2382 * @handle: handle from which the protocol interfaces shall be removed
2383 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2386 * This function implements the UninstallMultipleProtocolInterfaces service.
2388 * See the Unified Extensible Firmware Interface (UEFI) specification for
2391 * Return: status code
2393 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2396 EFI_ENTRY("%p", handle);
2399 const efi_guid_t *protocol;
2400 void *protocol_interface;
2401 efi_status_t r = EFI_SUCCESS;
2405 return EFI_EXIT(EFI_INVALID_PARAMETER);
2407 efi_va_start(argptr, handle);
2409 protocol = efi_va_arg(argptr, efi_guid_t*);
2412 protocol_interface = efi_va_arg(argptr, void*);
2413 r = EFI_CALL(efi_uninstall_protocol_interface(
2415 protocol_interface));
2416 if (r != EFI_SUCCESS)
2421 if (r == EFI_SUCCESS)
2424 /* If an error occurred undo all changes. */
2425 efi_va_start(argptr, handle);
2427 protocol = efi_va_arg(argptr, efi_guid_t*);
2428 protocol_interface = efi_va_arg(argptr, void*);
2429 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2430 EFI_NATIVE_INTERFACE,
2431 protocol_interface));
2439 * efi_calculate_crc32() - calculate cyclic redundancy code
2440 * @data: buffer with data
2441 * @data_size: size of buffer in bytes
2442 * @crc32_p: cyclic redundancy code
2444 * This function implements the CalculateCrc32 service.
2446 * See the Unified Extensible Firmware Interface (UEFI) specification for
2449 * Return: status code
2451 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
2452 unsigned long data_size,
2455 EFI_ENTRY("%p, %ld", data, data_size);
2456 *crc32_p = crc32(0, data, data_size);
2457 return EFI_EXIT(EFI_SUCCESS);
2461 * efi_copy_mem() - copy memory
2462 * @destination: destination of the copy operation
2463 * @source: source of the copy operation
2464 * @length: number of bytes to copy
2466 * This function implements the CopyMem service.
2468 * See the Unified Extensible Firmware Interface (UEFI) specification for
2471 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2474 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2475 memcpy(destination, source, length);
2476 EFI_EXIT(EFI_SUCCESS);
2480 * efi_set_mem() - Fill memory with a byte value.
2481 * @buffer: buffer to fill
2482 * @size: size of buffer in bytes
2483 * @value: byte to copy to the buffer
2485 * This function implements the SetMem service.
2487 * See the Unified Extensible Firmware Interface (UEFI) specification for
2490 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2492 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2493 memset(buffer, value, size);
2494 EFI_EXIT(EFI_SUCCESS);
2498 * efi_protocol_open() - open protocol interface on a handle
2499 * @handler: handler of a protocol
2500 * @protocol_interface: interface implementing the protocol
2501 * @agent_handle: handle of the driver
2502 * @controller_handle: handle of the controller
2503 * @attributes: attributes indicating how to open the protocol
2505 * Return: status code
2507 static efi_status_t efi_protocol_open(
2508 struct efi_handler *handler,
2509 void **protocol_interface, void *agent_handle,
2510 void *controller_handle, uint32_t attributes)
2512 struct efi_open_protocol_info_item *item;
2513 struct efi_open_protocol_info_entry *match = NULL;
2514 bool opened_by_driver = false;
2515 bool opened_exclusive = false;
2517 /* If there is no agent, only return the interface */
2521 /* For TEST_PROTOCOL ignore interface attribute */
2522 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2523 *protocol_interface = NULL;
2526 * Check if the protocol is already opened by a driver with the same
2527 * attributes or opened exclusively
2529 list_for_each_entry(item, &handler->open_infos, link) {
2530 if (item->info.agent_handle == agent_handle) {
2531 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2532 (item->info.attributes == attributes))
2533 return EFI_ALREADY_STARTED;
2535 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2536 opened_exclusive = true;
2539 /* Only one controller can open the protocol exclusively */
2540 if (opened_exclusive && attributes &
2541 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2542 return EFI_ACCESS_DENIED;
2544 /* Prepare exclusive opening */
2545 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2546 /* Try to disconnect controllers */
2547 list_for_each_entry(item, &handler->open_infos, link) {
2548 if (item->info.attributes ==
2549 EFI_OPEN_PROTOCOL_BY_DRIVER)
2550 EFI_CALL(efi_disconnect_controller(
2551 item->info.controller_handle,
2552 item->info.agent_handle,
2555 opened_by_driver = false;
2556 /* Check if all controllers are disconnected */
2557 list_for_each_entry(item, &handler->open_infos, link) {
2558 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2559 opened_by_driver = true;
2561 /* Only one controller can be conncected */
2562 if (opened_by_driver)
2563 return EFI_ACCESS_DENIED;
2566 /* Find existing entry */
2567 list_for_each_entry(item, &handler->open_infos, link) {
2568 if (item->info.agent_handle == agent_handle &&
2569 item->info.controller_handle == controller_handle)
2570 match = &item->info;
2572 /* None found, create one */
2574 match = efi_create_open_info(handler);
2576 return EFI_OUT_OF_RESOURCES;
2579 match->agent_handle = agent_handle;
2580 match->controller_handle = controller_handle;
2581 match->attributes = attributes;
2582 match->open_count++;
2585 /* For TEST_PROTOCOL ignore interface attribute. */
2586 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2587 *protocol_interface = handler->protocol_interface;
2593 * efi_open_protocol() - open protocol interface on a handle
2594 * @handle: handle on which the protocol shall be opened
2595 * @protocol: GUID of the protocol
2596 * @protocol_interface: interface implementing the protocol
2597 * @agent_handle: handle of the driver
2598 * @controller_handle: handle of the controller
2599 * @attributes: attributes indicating how to open the protocol
2601 * This function implements the OpenProtocol interface.
2603 * See the Unified Extensible Firmware Interface (UEFI) specification for
2606 * Return: status code
2608 static efi_status_t EFIAPI efi_open_protocol(
2609 void *handle, const efi_guid_t *protocol,
2610 void **protocol_interface, void *agent_handle,
2611 void *controller_handle, uint32_t attributes)
2613 struct efi_handler *handler;
2614 efi_status_t r = EFI_INVALID_PARAMETER;
2616 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2617 protocol_interface, agent_handle, controller_handle,
2620 if (!handle || !protocol ||
2621 (!protocol_interface && attributes !=
2622 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2626 switch (attributes) {
2627 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2628 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2629 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2631 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2632 if (controller_handle == handle)
2635 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2636 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2637 /* Check that the controller handle is valid */
2638 if (!efi_search_obj(controller_handle))
2641 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2642 /* Check that the agent handle is valid */
2643 if (!efi_search_obj(agent_handle))
2650 r = efi_search_protocol(handle, protocol, &handler);
2651 if (r != EFI_SUCCESS)
2654 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2655 controller_handle, attributes);
2661 * efi_handle_protocol() - get interface of a protocol on a handle
2662 * @handle: handle on which the protocol shall be opened
2663 * @protocol: GUID of the protocol
2664 * @protocol_interface: interface implementing the protocol
2666 * This function implements the HandleProtocol service.
2668 * See the Unified Extensible Firmware Interface (UEFI) specification for
2671 * Return: status code
2673 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2674 const efi_guid_t *protocol,
2675 void **protocol_interface)
2677 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2678 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2682 * efi_bind_controller() - bind a single driver to a controller
2683 * @controller_handle: controller handle
2684 * @driver_image_handle: driver handle
2685 * @remain_device_path: remaining path
2687 * Return: status code
2689 static efi_status_t efi_bind_controller(
2690 efi_handle_t controller_handle,
2691 efi_handle_t driver_image_handle,
2692 struct efi_device_path *remain_device_path)
2694 struct efi_driver_binding_protocol *binding_protocol;
2697 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2698 &efi_guid_driver_binding_protocol,
2699 (void **)&binding_protocol,
2700 driver_image_handle, NULL,
2701 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2702 if (r != EFI_SUCCESS)
2704 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2706 remain_device_path));
2707 if (r == EFI_SUCCESS)
2708 r = EFI_CALL(binding_protocol->start(binding_protocol,
2710 remain_device_path));
2711 EFI_CALL(efi_close_protocol(driver_image_handle,
2712 &efi_guid_driver_binding_protocol,
2713 driver_image_handle, NULL));
2718 * efi_connect_single_controller() - connect a single driver to a controller
2719 * @controller_handle: controller
2720 * @driver_image_handle: driver
2721 * @remain_device_path: remainting path
2723 * Return: status code
2725 static efi_status_t efi_connect_single_controller(
2726 efi_handle_t controller_handle,
2727 efi_handle_t *driver_image_handle,
2728 struct efi_device_path *remain_device_path)
2730 efi_handle_t *buffer;
2734 size_t connected = 0;
2736 /* Get buffer with all handles with driver binding protocol */
2737 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2738 &efi_guid_driver_binding_protocol,
2739 NULL, &count, &buffer));
2740 if (r != EFI_SUCCESS)
2743 /* Context Override */
2744 if (driver_image_handle) {
2745 for (; *driver_image_handle; ++driver_image_handle) {
2746 for (i = 0; i < count; ++i) {
2747 if (buffer[i] == *driver_image_handle) {
2749 r = efi_bind_controller(
2751 *driver_image_handle,
2752 remain_device_path);
2754 * For drivers that do not support the
2755 * controller or are already connected
2756 * we receive an error code here.
2758 if (r == EFI_SUCCESS)
2766 * TODO: Some overrides are not yet implemented:
2767 * - Platform Driver Override
2768 * - Driver Family Override Search
2769 * - Bus Specific Driver Override
2772 /* Driver Binding Search */
2773 for (i = 0; i < count; ++i) {
2775 r = efi_bind_controller(controller_handle,
2777 remain_device_path);
2778 if (r == EFI_SUCCESS)
2783 efi_free_pool(buffer);
2785 return EFI_NOT_FOUND;
2790 * efi_connect_controller() - connect a controller to a driver
2791 * @controller_handle: handle of the controller
2792 * @driver_image_handle: handle of the driver
2793 * @remain_device_path: device path of a child controller
2794 * @recursive: true to connect all child controllers
2796 * This function implements the ConnectController service.
2798 * See the Unified Extensible Firmware Interface (UEFI) specification for
2801 * First all driver binding protocol handles are tried for binding drivers.
2802 * Afterwards all handles that have openened a protocol of the controller
2803 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2805 * Return: status code
2807 static efi_status_t EFIAPI efi_connect_controller(
2808 efi_handle_t controller_handle,
2809 efi_handle_t *driver_image_handle,
2810 struct efi_device_path *remain_device_path,
2814 efi_status_t ret = EFI_NOT_FOUND;
2815 struct efi_object *efiobj;
2817 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
2818 remain_device_path, recursive);
2820 efiobj = efi_search_obj(controller_handle);
2822 ret = EFI_INVALID_PARAMETER;
2826 r = efi_connect_single_controller(controller_handle,
2827 driver_image_handle,
2828 remain_device_path);
2829 if (r == EFI_SUCCESS)
2832 struct efi_handler *handler;
2833 struct efi_open_protocol_info_item *item;
2835 list_for_each_entry(handler, &efiobj->protocols, link) {
2836 list_for_each_entry(item, &handler->open_infos, link) {
2837 if (item->info.attributes &
2838 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2839 r = EFI_CALL(efi_connect_controller(
2840 item->info.controller_handle,
2841 driver_image_handle,
2844 if (r == EFI_SUCCESS)
2850 /* Check for child controller specified by end node */
2851 if (ret != EFI_SUCCESS && remain_device_path &&
2852 remain_device_path->type == DEVICE_PATH_TYPE_END)
2855 return EFI_EXIT(ret);
2859 * efi_reinstall_protocol_interface() - reinstall protocol interface
2860 * @handle: handle on which the protocol shall be reinstalled
2861 * @protocol: GUID of the protocol to be installed
2862 * @old_interface: interface to be removed
2863 * @new_interface: interface to be installed
2865 * This function implements the ReinstallProtocolInterface service.
2867 * See the Unified Extensible Firmware Interface (UEFI) specification for
2870 * The old interface is uninstalled. The new interface is installed.
2871 * Drivers are connected.
2873 * Return: status code
2875 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
2876 efi_handle_t handle, const efi_guid_t *protocol,
2877 void *old_interface, void *new_interface)
2881 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
2883 ret = EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2885 if (ret != EFI_SUCCESS)
2887 ret = EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2888 EFI_NATIVE_INTERFACE,
2890 if (ret != EFI_SUCCESS)
2893 * The returned status code has to be ignored.
2894 * Do not create an error if no suitable driver for the handle exists.
2896 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
2898 return EFI_EXIT(ret);
2902 * efi_get_child_controllers() - get all child controllers associated to a driver
2903 * @efiobj: handle of the controller
2904 * @driver_handle: handle of the driver
2905 * @number_of_children: number of child controllers
2906 * @child_handle_buffer: handles of the the child controllers
2908 * The allocated buffer has to be freed with free().
2910 * Return: status code
2912 static efi_status_t efi_get_child_controllers(
2913 struct efi_object *efiobj,
2914 efi_handle_t driver_handle,
2915 efi_uintn_t *number_of_children,
2916 efi_handle_t **child_handle_buffer)
2918 struct efi_handler *handler;
2919 struct efi_open_protocol_info_item *item;
2920 efi_uintn_t count = 0, i;
2923 /* Count all child controller associations */
2924 list_for_each_entry(handler, &efiobj->protocols, link) {
2925 list_for_each_entry(item, &handler->open_infos, link) {
2926 if (item->info.agent_handle == driver_handle &&
2927 item->info.attributes &
2928 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
2933 * Create buffer. In case of duplicate child controller assignments
2934 * the buffer will be too large. But that does not harm.
2936 *number_of_children = 0;
2937 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
2938 if (!*child_handle_buffer)
2939 return EFI_OUT_OF_RESOURCES;
2940 /* Copy unique child handles */
2941 list_for_each_entry(handler, &efiobj->protocols, link) {
2942 list_for_each_entry(item, &handler->open_infos, link) {
2943 if (item->info.agent_handle == driver_handle &&
2944 item->info.attributes &
2945 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2946 /* Check this is a new child controller */
2948 for (i = 0; i < *number_of_children; ++i) {
2949 if ((*child_handle_buffer)[i] ==
2950 item->info.controller_handle)
2953 /* Copy handle to buffer */
2955 i = (*number_of_children)++;
2956 (*child_handle_buffer)[i] =
2957 item->info.controller_handle;
2966 * efi_disconnect_controller() - disconnect a controller from a driver
2967 * @controller_handle: handle of the controller
2968 * @driver_image_handle: handle of the driver
2969 * @child_handle: handle of the child to destroy
2971 * This function implements the DisconnectController service.
2973 * See the Unified Extensible Firmware Interface (UEFI) specification for
2976 * Return: status code
2978 static efi_status_t EFIAPI efi_disconnect_controller(
2979 efi_handle_t controller_handle,
2980 efi_handle_t driver_image_handle,
2981 efi_handle_t child_handle)
2983 struct efi_driver_binding_protocol *binding_protocol;
2984 efi_handle_t *child_handle_buffer = NULL;
2985 size_t number_of_children = 0;
2987 size_t stop_count = 0;
2988 struct efi_object *efiobj;
2990 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
2993 efiobj = efi_search_obj(controller_handle);
2995 r = EFI_INVALID_PARAMETER;
2999 if (child_handle && !efi_search_obj(child_handle)) {
3000 r = EFI_INVALID_PARAMETER;
3004 /* If no driver handle is supplied, disconnect all drivers */
3005 if (!driver_image_handle) {
3006 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3010 /* Create list of child handles */
3012 number_of_children = 1;
3013 child_handle_buffer = &child_handle;
3015 efi_get_child_controllers(efiobj,
3016 driver_image_handle,
3017 &number_of_children,
3018 &child_handle_buffer);
3021 /* Get the driver binding protocol */
3022 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3023 &efi_guid_driver_binding_protocol,
3024 (void **)&binding_protocol,
3025 driver_image_handle, NULL,
3026 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3027 if (r != EFI_SUCCESS)
3029 /* Remove the children */
3030 if (number_of_children) {
3031 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3034 child_handle_buffer));
3035 if (r == EFI_SUCCESS)
3038 /* Remove the driver */
3040 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3043 if (r == EFI_SUCCESS)
3045 EFI_CALL(efi_close_protocol(driver_image_handle,
3046 &efi_guid_driver_binding_protocol,
3047 driver_image_handle, NULL));
3055 free(child_handle_buffer);
3059 static const struct efi_boot_services efi_boot_services = {
3061 .headersize = sizeof(struct efi_table_hdr),
3063 .raise_tpl = efi_raise_tpl,
3064 .restore_tpl = efi_restore_tpl,
3065 .allocate_pages = efi_allocate_pages_ext,
3066 .free_pages = efi_free_pages_ext,
3067 .get_memory_map = efi_get_memory_map_ext,
3068 .allocate_pool = efi_allocate_pool_ext,
3069 .free_pool = efi_free_pool_ext,
3070 .create_event = efi_create_event_ext,
3071 .set_timer = efi_set_timer_ext,
3072 .wait_for_event = efi_wait_for_event,
3073 .signal_event = efi_signal_event_ext,
3074 .close_event = efi_close_event,
3075 .check_event = efi_check_event,
3076 .install_protocol_interface = efi_install_protocol_interface,
3077 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3078 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3079 .handle_protocol = efi_handle_protocol,
3081 .register_protocol_notify = efi_register_protocol_notify,
3082 .locate_handle = efi_locate_handle_ext,
3083 .locate_device_path = efi_locate_device_path,
3084 .install_configuration_table = efi_install_configuration_table_ext,
3085 .load_image = efi_load_image,
3086 .start_image = efi_start_image,
3088 .unload_image = efi_unload_image,
3089 .exit_boot_services = efi_exit_boot_services,
3090 .get_next_monotonic_count = efi_get_next_monotonic_count,
3092 .set_watchdog_timer = efi_set_watchdog_timer,
3093 .connect_controller = efi_connect_controller,
3094 .disconnect_controller = efi_disconnect_controller,
3095 .open_protocol = efi_open_protocol,
3096 .close_protocol = efi_close_protocol,
3097 .open_protocol_information = efi_open_protocol_information,
3098 .protocols_per_handle = efi_protocols_per_handle,
3099 .locate_handle_buffer = efi_locate_handle_buffer,
3100 .locate_protocol = efi_locate_protocol,
3101 .install_multiple_protocol_interfaces =
3102 efi_install_multiple_protocol_interfaces,
3103 .uninstall_multiple_protocol_interfaces =
3104 efi_uninstall_multiple_protocol_interfaces,
3105 .calculate_crc32 = efi_calculate_crc32,
3106 .copy_mem = efi_copy_mem,
3107 .set_mem = efi_set_mem,
3108 .create_event_ex = efi_create_event_ex,
3111 static uint16_t __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3113 struct efi_system_table __efi_runtime_data systab = {
3115 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3116 .revision = 2 << 16 | 70, /* 2.7 */
3117 .headersize = sizeof(struct efi_table_hdr),
3119 .fw_vendor = (long)firmware_vendor,
3120 .con_in = (void *)&efi_con_in,
3121 .con_out = (void *)&efi_con_out,
3122 .std_err = (void *)&efi_con_out,
3123 .runtime = (void *)&efi_runtime_services,
3124 .boottime = (void *)&efi_boot_services,
3126 .tables = (void *)efi_conf_table,