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);
30 /* List of all events registered by RegisterProtocolNotify() */
31 LIST_HEAD(efi_register_notify_events);
33 /* Handle of the currently executing image */
34 static efi_handle_t current_image;
37 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
38 * we need to do trickery with caches. Since we don't want to break the EFI
39 * aware boot path, only apply hacks when loading exiting directly (breaking
40 * direct Linux EFI booting along the way - oh well).
42 static bool efi_is_direct_boot = true;
46 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
47 * fixed when compiling U-Boot. However, the payload does not know about that
48 * restriction so we need to manually swap its and our view of that register on
49 * EFI callback entry/exit.
51 static volatile void *efi_gd, *app_gd;
54 /* 1 if inside U-Boot code, 0 if inside EFI payload code */
55 static int entry_count = 1;
56 static int nesting_level;
57 /* GUID of the device tree table */
58 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
59 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60 const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
63 /* event group ExitBootServices() invoked */
64 const efi_guid_t efi_guid_event_group_exit_boot_services =
65 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
66 /* event group SetVirtualAddressMap() invoked */
67 const efi_guid_t efi_guid_event_group_virtual_address_change =
68 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
69 /* event group memory map changed */
70 const efi_guid_t efi_guid_event_group_memory_map_change =
71 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
72 /* event group boot manager about to boot */
73 const efi_guid_t efi_guid_event_group_ready_to_boot =
74 EFI_EVENT_GROUP_READY_TO_BOOT;
75 /* event group ResetSystem() invoked (before ExitBootServices) */
76 const efi_guid_t efi_guid_event_group_reset_system =
77 EFI_EVENT_GROUP_RESET_SYSTEM;
79 static efi_status_t EFIAPI efi_disconnect_controller(
80 efi_handle_t controller_handle,
81 efi_handle_t driver_image_handle,
82 efi_handle_t child_handle);
84 /* Called on every callback entry */
85 int __efi_entry_check(void)
87 int ret = entry_count++ == 0;
96 /* Called on every callback exit */
97 int __efi_exit_check(void)
99 int ret = --entry_count == 0;
106 /* Called from do_bootefi_exec() */
107 void efi_save_gd(void)
115 * Special case handler for error/abort that just forces things back to u-boot
116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
119 void efi_restore_gd(void)
122 /* Only restore if we're already in EFI context */
130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
133 * A maximum of ten indent levels is supported. Higher indent levels will be
136 * Return: A string for indenting with two spaces per level is
139 static const char *indent_string(int level)
141 const char *indent = " ";
142 const int max = strlen(indent);
144 level = min(max, level * 2);
145 return &indent[max - level];
148 const char *__efi_nesting(void)
150 return indent_string(nesting_level);
153 const char *__efi_nesting_inc(void)
155 return indent_string(nesting_level++);
158 const char *__efi_nesting_dec(void)
160 return indent_string(--nesting_level);
164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
168 * This function queues the notification function of the event for future
171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
174 * For the SignalEvent service see efi_signal_event_ext.
177 static void efi_queue_event(struct efi_event *event, bool check_tpl)
179 if (event->notify_function) {
180 event->is_queued = true;
182 if (check_tpl && efi_tpl >= event->notify_tpl)
184 event->is_queued = false;
185 EFI_CALL_VOID(event->notify_function(event,
186 event->notify_context));
188 event->is_queued = false;
193 * is_valid_tpl() - check if the task priority level is valid
195 * @tpl: TPL level to check
196 * Return: status code
198 efi_status_t is_valid_tpl(efi_uintn_t tpl)
201 case TPL_APPLICATION:
207 return EFI_INVALID_PARAMETER;
212 * efi_signal_event() - signal an EFI event
213 * @event: event to signal
214 * @check_tpl: check the TPL level
216 * This function signals an event. If the event belongs to an event group all
217 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
218 * their notification function is queued.
220 * For the SignalEvent service see efi_signal_event_ext.
222 void efi_signal_event(struct efi_event *event, bool check_tpl)
225 struct efi_event *evt;
228 * The signaled state has to set before executing any
229 * notification function
231 list_for_each_entry(evt, &efi_events, link) {
232 if (!evt->group || guidcmp(evt->group, event->group))
234 if (evt->is_signaled)
236 evt->is_signaled = true;
237 if (evt->type & EVT_NOTIFY_SIGNAL &&
238 evt->notify_function)
239 evt->is_queued = true;
241 list_for_each_entry(evt, &efi_events, link) {
242 if (!evt->group || guidcmp(evt->group, event->group))
245 efi_queue_event(evt, check_tpl);
248 event->is_signaled = true;
249 if (event->type & EVT_NOTIFY_SIGNAL)
250 efi_queue_event(event, check_tpl);
255 * efi_raise_tpl() - raise the task priority level
256 * @new_tpl: new value of the task priority level
258 * This function implements the RaiseTpl service.
260 * See the Unified Extensible Firmware Interface (UEFI) specification for
263 * Return: old value of the task priority level
265 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
267 efi_uintn_t old_tpl = efi_tpl;
269 EFI_ENTRY("0x%zx", new_tpl);
271 if (new_tpl < efi_tpl)
272 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
274 if (efi_tpl > TPL_HIGH_LEVEL)
275 efi_tpl = TPL_HIGH_LEVEL;
277 EFI_EXIT(EFI_SUCCESS);
282 * efi_restore_tpl() - lower the task priority level
283 * @old_tpl: value of the task priority level to be restored
285 * This function implements the RestoreTpl service.
287 * See the Unified Extensible Firmware Interface (UEFI) specification for
290 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
292 EFI_ENTRY("0x%zx", old_tpl);
294 if (old_tpl > efi_tpl)
295 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
297 if (efi_tpl > TPL_HIGH_LEVEL)
298 efi_tpl = TPL_HIGH_LEVEL;
301 * Lowering the TPL may have made queued events eligible for execution.
305 EFI_EXIT(EFI_SUCCESS);
309 * efi_allocate_pages_ext() - allocate memory pages
310 * @type: type of allocation to be performed
311 * @memory_type: usage type of the allocated memory
312 * @pages: number of pages to be allocated
313 * @memory: allocated memory
315 * This function implements the AllocatePages service.
317 * See the Unified Extensible Firmware Interface (UEFI) specification for
320 * Return: status code
322 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
328 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
329 r = efi_allocate_pages(type, memory_type, pages, memory);
334 * efi_free_pages_ext() - Free memory pages.
335 * @memory: start of the memory area to be freed
336 * @pages: number of pages to be freed
338 * This function implements the FreePages service.
340 * See the Unified Extensible Firmware Interface (UEFI) specification for
343 * Return: status code
345 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
350 EFI_ENTRY("%llx, 0x%zx", memory, pages);
351 r = efi_free_pages(memory, pages);
356 * efi_get_memory_map_ext() - get map describing memory usage
357 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
358 * on exit the size of the copied memory map
359 * @memory_map: buffer to which the memory map is written
360 * @map_key: key for the memory map
361 * @descriptor_size: size of an individual memory descriptor
362 * @descriptor_version: version number of the memory descriptor structure
364 * This function implements the GetMemoryMap service.
366 * See the Unified Extensible Firmware Interface (UEFI) specification for
369 * Return: status code
371 static efi_status_t EFIAPI efi_get_memory_map_ext(
372 efi_uintn_t *memory_map_size,
373 struct efi_mem_desc *memory_map,
374 efi_uintn_t *map_key,
375 efi_uintn_t *descriptor_size,
376 uint32_t *descriptor_version)
380 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
381 map_key, descriptor_size, descriptor_version);
382 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
383 descriptor_size, descriptor_version);
388 * efi_allocate_pool_ext() - allocate memory from pool
389 * @pool_type: type of the pool from which memory is to be allocated
390 * @size: number of bytes to be allocated
391 * @buffer: allocated memory
393 * This function implements the AllocatePool service.
395 * See the Unified Extensible Firmware Interface (UEFI) specification for
398 * Return: status code
400 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
406 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
407 r = efi_allocate_pool(pool_type, size, buffer);
412 * efi_free_pool_ext() - free memory from pool
413 * @buffer: start of memory to be freed
415 * This function implements the FreePool service.
417 * See the Unified Extensible Firmware Interface (UEFI) specification for
420 * Return: status code
422 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
426 EFI_ENTRY("%p", buffer);
427 r = efi_free_pool(buffer);
432 * efi_add_handle() - add a new handle to the object list
434 * @handle: handle to be added
436 * The protocols list is initialized. The handle is added to the list of known
439 void efi_add_handle(efi_handle_t handle)
443 INIT_LIST_HEAD(&handle->protocols);
444 list_add_tail(&handle->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;
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 (handler->protocol_interface != protocol_interface)
519 return EFI_NOT_FOUND;
520 list_del(&handler->link);
526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
529 * Return: status code
531 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
533 struct efi_object *efiobj;
534 struct efi_handler *protocol;
535 struct efi_handler *pos;
537 efiobj = efi_search_obj(handle);
539 return EFI_INVALID_PARAMETER;
540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
543 ret = efi_remove_protocol(handle, protocol->guid,
544 protocol->protocol_interface);
545 if (ret != EFI_SUCCESS)
552 * efi_delete_handle() - delete handle
554 * @obj: handle to delete
556 void efi_delete_handle(efi_handle_t handle)
560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
569 * Return: status code
571 static efi_status_t efi_is_event(const struct efi_event *event)
573 const struct efi_event *evt;
576 return EFI_INVALID_PARAMETER;
577 list_for_each_entry(evt, &efi_events, link) {
581 return EFI_INVALID_PARAMETER;
585 * efi_create_event() - create an event
586 * @type: type of the event to create
587 * @notify_tpl: task priority level of the event
588 * @notify_function: notification function of the event
589 * @notify_context: pointer passed to the notification function
590 * @group: event group
591 * @event: created event
593 * This function is used inside U-Boot code to create an event.
595 * For the API function implementing the CreateEvent service see
596 * efi_create_event_ext.
598 * Return: status code
600 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
601 void (EFIAPI *notify_function) (
602 struct efi_event *event,
604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
607 struct efi_event *evt;
610 return EFI_INVALID_PARAMETER;
615 case EVT_NOTIFY_SIGNAL:
616 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
617 case EVT_NOTIFY_WAIT:
618 case EVT_TIMER | EVT_NOTIFY_WAIT:
619 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
620 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
623 return EFI_INVALID_PARAMETER;
626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
628 return EFI_INVALID_PARAMETER;
630 evt = calloc(1, sizeof(struct efi_event));
632 return EFI_OUT_OF_RESOURCES;
634 evt->notify_tpl = notify_tpl;
635 evt->notify_function = notify_function;
636 evt->notify_context = notify_context;
638 /* Disable timers on boot up */
639 evt->trigger_next = -1ULL;
640 evt->is_queued = false;
641 evt->is_signaled = false;
642 list_add_tail(&evt->link, &efi_events);
648 * efi_create_event_ex() - create an event in a group
649 * @type: type of the event to create
650 * @notify_tpl: task priority level of the event
651 * @notify_function: notification function of the event
652 * @notify_context: pointer passed to the notification function
653 * @event: created event
654 * @event_group: event group
656 * This function implements the CreateEventEx service.
658 * See the Unified Extensible Firmware Interface (UEFI) specification for
661 * Return: status code
663 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
664 void (EFIAPI *notify_function) (
665 struct efi_event *event,
667 void *notify_context,
668 efi_guid_t *event_group,
669 struct efi_event **event)
673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
674 notify_context, event_group);
677 * The allowable input parameters are the same as in CreateEvent()
678 * except for the following two disallowed event types.
681 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
682 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
683 ret = EFI_INVALID_PARAMETER;
687 ret = efi_create_event(type, notify_tpl, notify_function,
688 notify_context, event_group, event);
690 return EFI_EXIT(ret);
694 * efi_create_event_ext() - create an event
695 * @type: type of the event to create
696 * @notify_tpl: task priority level of the event
697 * @notify_function: notification function of the event
698 * @notify_context: pointer passed to the notification function
699 * @event: created event
701 * This function implements the CreateEvent service.
703 * See the Unified Extensible Firmware Interface (UEFI) specification for
706 * Return: status code
708 static efi_status_t EFIAPI efi_create_event_ext(
709 uint32_t type, efi_uintn_t notify_tpl,
710 void (EFIAPI *notify_function) (
711 struct efi_event *event,
713 void *notify_context, struct efi_event **event)
715 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
717 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
718 notify_context, NULL, event));
722 * efi_timer_check() - check if a timer event has occurred
724 * Check if a timer event has occurred or a queued notification function should
727 * Our timers have to work without interrupts, so we check whenever keyboard
728 * input or disk accesses happen if enough time elapsed for them to fire.
730 void efi_timer_check(void)
732 struct efi_event *evt;
733 u64 now = timer_get_us();
735 list_for_each_entry(evt, &efi_events, link) {
737 efi_queue_event(evt, true);
738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
740 switch (evt->trigger_type) {
741 case EFI_TIMER_RELATIVE:
742 evt->trigger_type = EFI_TIMER_STOP;
744 case EFI_TIMER_PERIODIC:
745 evt->trigger_next += evt->trigger_time;
750 evt->is_signaled = false;
751 efi_signal_event(evt, true);
757 * efi_set_timer() - set the trigger time for a timer event or stop the event
758 * @event: event for which the timer is set
759 * @type: type of the timer
760 * @trigger_time: trigger period in multiples of 100 ns
762 * This is the function for internal usage in U-Boot. For the API function
763 * implementing the SetTimer service see efi_set_timer_ext.
765 * Return: status code
767 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
768 uint64_t trigger_time)
770 /* Check that the event is valid */
771 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
772 return EFI_INVALID_PARAMETER;
775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
778 do_div(trigger_time, 10);
782 event->trigger_next = -1ULL;
784 case EFI_TIMER_PERIODIC:
785 case EFI_TIMER_RELATIVE:
786 event->trigger_next = timer_get_us() + trigger_time;
789 return EFI_INVALID_PARAMETER;
791 event->trigger_type = type;
792 event->trigger_time = trigger_time;
793 event->is_signaled = false;
798 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
800 * @event: event for which the timer is set
801 * @type: type of the timer
802 * @trigger_time: trigger period in multiples of 100 ns
804 * This function implements the SetTimer service.
806 * See the Unified Extensible Firmware Interface (UEFI) specification for
810 * Return: status code
812 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
813 enum efi_timer_delay type,
814 uint64_t trigger_time)
816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
821 * efi_wait_for_event() - wait for events to be signaled
822 * @num_events: number of events to be waited for
823 * @event: events to be waited for
824 * @index: index of the event that was signaled
826 * This function implements the WaitForEvent service.
828 * See the Unified Extensible Firmware Interface (UEFI) specification for
831 * Return: status code
833 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
834 struct efi_event **event,
839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
847 for (i = 0; i < num_events; ++i) {
848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
852 if (!event[i]->is_signaled)
853 efi_queue_event(event[i], true);
856 /* Wait for signal */
858 for (i = 0; i < num_events; ++i) {
859 if (event[i]->is_signaled)
862 /* Allow events to occur. */
868 * Reset the signal which is passed to the caller to allow periodic
871 event[i]->is_signaled = false;
875 return EFI_EXIT(EFI_SUCCESS);
879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
882 * This function implements the SignalEvent service.
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
890 * Return: status code
892 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
894 EFI_ENTRY("%p", event);
895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
897 efi_signal_event(event, true);
898 return EFI_EXIT(EFI_SUCCESS);
902 * efi_close_event() - close an EFI event
903 * @event: event to close
905 * This function implements the CloseEvent service.
907 * See the Unified Extensible Firmware Interface (UEFI) specification for
910 * Return: status code
912 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
914 struct efi_register_notify_event *item, *next;
916 EFI_ENTRY("%p", event);
917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item, next, &efi_register_notify_events,
923 if (event == item->event) {
924 list_del(&item->link);
929 list_del(&event->link);
931 return EFI_EXIT(EFI_SUCCESS);
935 * efi_check_event() - check if an event is signaled
936 * @event: event to check
938 * This function implements the CheckEvent service.
940 * See the Unified Extensible Firmware Interface (UEFI) specification for
943 * If an event is not signaled yet, the notification function is queued. The
944 * signaled state is cleared.
946 * Return: status code
948 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
950 EFI_ENTRY("%p", event);
952 if (efi_is_event(event) != EFI_SUCCESS ||
953 event->type & EVT_NOTIFY_SIGNAL)
954 return EFI_EXIT(EFI_INVALID_PARAMETER);
955 if (!event->is_signaled)
956 efi_queue_event(event, true);
957 if (event->is_signaled) {
958 event->is_signaled = false;
959 return EFI_EXIT(EFI_SUCCESS);
961 return EFI_EXIT(EFI_NOT_READY);
965 * efi_search_obj() - find the internal EFI object for a handle
966 * @handle: handle to find
970 struct efi_object *efi_search_obj(const efi_handle_t handle)
972 struct efi_object *efiobj;
977 list_for_each_entry(efiobj, &efi_obj_list, link) {
978 if (efiobj == handle)
985 * efi_open_protocol_info_entry() - create open protocol info entry and add it
987 * @handler: handler of a protocol
989 * Return: open protocol info entry
991 static struct efi_open_protocol_info_entry *efi_create_open_info(
992 struct efi_handler *handler)
994 struct efi_open_protocol_info_item *item;
996 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
999 /* Append the item to the open protocol info list. */
1000 list_add_tail(&item->link, &handler->open_infos);
1006 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1007 * @item: open protocol info entry to delete
1009 * Return: status code
1011 static efi_status_t efi_delete_open_info(
1012 struct efi_open_protocol_info_item *item)
1014 list_del(&item->link);
1020 * efi_add_protocol() - install new protocol on a handle
1021 * @handle: handle on which the protocol shall be installed
1022 * @protocol: GUID of the protocol to be installed
1023 * @protocol_interface: interface of the protocol implementation
1025 * Return: status code
1027 efi_status_t efi_add_protocol(const efi_handle_t handle,
1028 const efi_guid_t *protocol,
1029 void *protocol_interface)
1031 struct efi_object *efiobj;
1032 struct efi_handler *handler;
1034 struct efi_register_notify_event *event;
1036 efiobj = efi_search_obj(handle);
1038 return EFI_INVALID_PARAMETER;
1039 ret = efi_search_protocol(handle, protocol, NULL);
1040 if (ret != EFI_NOT_FOUND)
1041 return EFI_INVALID_PARAMETER;
1042 handler = calloc(1, sizeof(struct efi_handler));
1044 return EFI_OUT_OF_RESOURCES;
1045 handler->guid = protocol;
1046 handler->protocol_interface = protocol_interface;
1047 INIT_LIST_HEAD(&handler->open_infos);
1048 list_add_tail(&handler->link, &efiobj->protocols);
1050 /* Notify registered events */
1051 list_for_each_entry(event, &efi_register_notify_events, link) {
1052 if (!guidcmp(protocol, &event->protocol))
1053 efi_signal_event(event->event, true);
1056 if (!guidcmp(&efi_guid_device_path, protocol))
1057 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1062 * efi_install_protocol_interface() - install protocol interface
1063 * @handle: handle on which the protocol shall be installed
1064 * @protocol: GUID of the protocol to be installed
1065 * @protocol_interface_type: type of the interface to be installed,
1066 * always EFI_NATIVE_INTERFACE
1067 * @protocol_interface: interface of the protocol implementation
1069 * This function implements the InstallProtocolInterface service.
1071 * See the Unified Extensible Firmware Interface (UEFI) specification for
1074 * Return: status code
1076 static efi_status_t EFIAPI efi_install_protocol_interface(
1077 efi_handle_t *handle, const efi_guid_t *protocol,
1078 int protocol_interface_type, void *protocol_interface)
1082 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1083 protocol_interface);
1085 if (!handle || !protocol ||
1086 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1087 r = EFI_INVALID_PARAMETER;
1091 /* Create new handle if requested. */
1093 r = efi_create_handle(handle);
1094 if (r != EFI_SUCCESS)
1096 EFI_PRINT("new handle %p\n", *handle);
1098 EFI_PRINT("handle %p\n", *handle);
1100 /* Add new protocol */
1101 r = efi_add_protocol(*handle, protocol, protocol_interface);
1107 * efi_get_drivers() - get all drivers associated to a controller
1108 * @handle: handle of the controller
1109 * @protocol: protocol GUID (optional)
1110 * @number_of_drivers: number of child controllers
1111 * @driver_handle_buffer: handles of the the drivers
1113 * The allocated buffer has to be freed with free().
1115 * Return: status code
1117 static efi_status_t efi_get_drivers(efi_handle_t handle,
1118 const efi_guid_t *protocol,
1119 efi_uintn_t *number_of_drivers,
1120 efi_handle_t **driver_handle_buffer)
1122 struct efi_handler *handler;
1123 struct efi_open_protocol_info_item *item;
1124 efi_uintn_t count = 0, i;
1127 /* Count all driver associations */
1128 list_for_each_entry(handler, &handle->protocols, link) {
1129 if (protocol && guidcmp(handler->guid, protocol))
1131 list_for_each_entry(item, &handler->open_infos, link) {
1132 if (item->info.attributes &
1133 EFI_OPEN_PROTOCOL_BY_DRIVER)
1137 *number_of_drivers = 0;
1139 *driver_handle_buffer = NULL;
1143 * Create buffer. In case of duplicate driver assignments the buffer
1144 * will be too large. But that does not harm.
1146 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1147 if (!*driver_handle_buffer)
1148 return EFI_OUT_OF_RESOURCES;
1149 /* Collect unique driver handles */
1150 list_for_each_entry(handler, &handle->protocols, link) {
1151 if (protocol && guidcmp(handler->guid, protocol))
1153 list_for_each_entry(item, &handler->open_infos, link) {
1154 if (item->info.attributes &
1155 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1156 /* Check this is a new driver */
1158 for (i = 0; i < *number_of_drivers; ++i) {
1159 if ((*driver_handle_buffer)[i] ==
1160 item->info.agent_handle)
1163 /* Copy handle to buffer */
1165 i = (*number_of_drivers)++;
1166 (*driver_handle_buffer)[i] =
1167 item->info.agent_handle;
1176 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1177 * @handle: handle of the controller
1178 * @protocol: protocol GUID (optional)
1179 * @child_handle: handle of the child to destroy
1181 * This function implements the DisconnectController service.
1183 * See the Unified Extensible Firmware Interface (UEFI) specification for
1186 * Return: status code
1188 static efi_status_t efi_disconnect_all_drivers
1189 (efi_handle_t handle,
1190 const efi_guid_t *protocol,
1191 efi_handle_t child_handle)
1193 efi_uintn_t number_of_drivers;
1194 efi_handle_t *driver_handle_buffer;
1195 efi_status_t r, ret;
1197 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1198 &driver_handle_buffer);
1199 if (ret != EFI_SUCCESS)
1201 if (!number_of_drivers)
1203 ret = EFI_NOT_FOUND;
1204 while (number_of_drivers) {
1205 r = EFI_CALL(efi_disconnect_controller(
1207 driver_handle_buffer[--number_of_drivers],
1209 if (r == EFI_SUCCESS)
1212 free(driver_handle_buffer);
1217 * efi_uninstall_protocol() - uninstall protocol interface
1219 * @handle: handle from which the protocol shall be removed
1220 * @protocol: GUID of the protocol to be removed
1221 * @protocol_interface: interface to be removed
1223 * This function DOES NOT delete a handle without installed protocol.
1225 * Return: status code
1227 static efi_status_t efi_uninstall_protocol
1228 (efi_handle_t handle, const efi_guid_t *protocol,
1229 void *protocol_interface)
1231 struct efi_object *efiobj;
1232 struct efi_handler *handler;
1233 struct efi_open_protocol_info_item *item;
1234 struct efi_open_protocol_info_item *pos;
1238 efiobj = efi_search_obj(handle);
1240 r = EFI_INVALID_PARAMETER;
1243 /* Find the protocol on the handle */
1244 r = efi_search_protocol(handle, protocol, &handler);
1245 if (r != EFI_SUCCESS)
1247 /* Disconnect controllers */
1248 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1249 if (!list_empty(&handler->open_infos)) {
1250 r = EFI_ACCESS_DENIED;
1253 /* Close protocol */
1254 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1255 if (item->info.attributes ==
1256 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1257 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1258 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1259 list_del(&item->link);
1261 if (!list_empty(&handler->open_infos)) {
1262 r = EFI_ACCESS_DENIED;
1265 r = efi_remove_protocol(handle, protocol, protocol_interface);
1271 * efi_uninstall_protocol_interface() - uninstall protocol interface
1272 * @handle: handle from which the protocol shall be removed
1273 * @protocol: GUID of the protocol to be removed
1274 * @protocol_interface: interface to be removed
1276 * This function implements the UninstallProtocolInterface service.
1278 * See the Unified Extensible Firmware Interface (UEFI) specification for
1281 * Return: status code
1283 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1284 (efi_handle_t handle, const efi_guid_t *protocol,
1285 void *protocol_interface)
1289 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1291 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1292 if (ret != EFI_SUCCESS)
1295 /* If the last protocol has been removed, delete the handle. */
1296 if (list_empty(&handle->protocols)) {
1297 list_del(&handle->link);
1301 return EFI_EXIT(ret);
1305 * efi_register_protocol_notify() - register an event for notification when a
1306 * protocol is installed.
1307 * @protocol: GUID of the protocol whose installation shall be notified
1308 * @event: event to be signaled upon installation of the protocol
1309 * @registration: key for retrieving the registration information
1311 * This function implements the RegisterProtocolNotify service.
1312 * See the Unified Extensible Firmware Interface (UEFI) specification
1315 * Return: status code
1317 static efi_status_t EFIAPI efi_register_protocol_notify(
1318 const efi_guid_t *protocol,
1319 struct efi_event *event,
1320 void **registration)
1322 struct efi_register_notify_event *item;
1323 efi_status_t ret = EFI_SUCCESS;
1325 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1327 if (!protocol || !event || !registration) {
1328 ret = EFI_INVALID_PARAMETER;
1332 item = calloc(1, sizeof(struct efi_register_notify_event));
1334 ret = EFI_OUT_OF_RESOURCES;
1338 item->event = event;
1339 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1341 list_add_tail(&item->link, &efi_register_notify_events);
1343 *registration = item;
1345 return EFI_EXIT(ret);
1349 * efi_search() - determine if an EFI handle implements a protocol
1350 * @search_type: selection criterion
1351 * @protocol: GUID of the protocol
1352 * @search_key: registration key
1355 * See the documentation of the LocateHandle service in the UEFI specification.
1357 * Return: 0 if the handle implements the protocol
1359 static int efi_search(enum efi_locate_search_type search_type,
1360 const efi_guid_t *protocol, efi_handle_t handle)
1364 switch (search_type) {
1367 case BY_REGISTER_NOTIFY:
1369 ret = efi_search_protocol(handle, protocol, NULL);
1370 return (ret != EFI_SUCCESS);
1372 /* Invalid search type */
1378 * efi_locate_handle() - locate handles implementing a protocol
1380 * @search_type: selection criterion
1381 * @protocol: GUID of the protocol
1382 * @search_key: registration key
1383 * @buffer_size: size of the buffer to receive the handles in bytes
1384 * @buffer: buffer to receive the relevant handles
1386 * This function is meant for U-Boot internal calls. For the API implementation
1387 * of the LocateHandle service see efi_locate_handle_ext.
1389 * Return: status code
1391 static efi_status_t efi_locate_handle(
1392 enum efi_locate_search_type search_type,
1393 const efi_guid_t *protocol, void *search_key,
1394 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1396 struct efi_object *efiobj;
1397 efi_uintn_t size = 0;
1398 struct efi_register_notify_event *item, *event = NULL;
1400 /* Check parameters */
1401 switch (search_type) {
1404 case BY_REGISTER_NOTIFY:
1406 return EFI_INVALID_PARAMETER;
1407 /* Check that the registration key is valid */
1408 list_for_each_entry(item, &efi_register_notify_events, link) {
1410 (struct efi_register_notify_event *)search_key) {
1416 return EFI_INVALID_PARAMETER;
1418 protocol = &event->protocol;
1422 return EFI_INVALID_PARAMETER;
1425 return EFI_INVALID_PARAMETER;
1428 /* Count how much space we need */
1429 list_for_each_entry(efiobj, &efi_obj_list, link) {
1430 if (!efi_search(search_type, protocol, efiobj))
1431 size += sizeof(void *);
1435 return EFI_NOT_FOUND;
1438 return EFI_INVALID_PARAMETER;
1440 if (*buffer_size < size) {
1441 *buffer_size = size;
1442 return EFI_BUFFER_TOO_SMALL;
1445 *buffer_size = size;
1447 /* The buffer size is sufficient but there is no buffer */
1449 return EFI_INVALID_PARAMETER;
1451 /* Then fill the array */
1452 list_for_each_entry(efiobj, &efi_obj_list, link) {
1453 if (!efi_search(search_type, protocol, efiobj))
1461 * efi_locate_handle_ext() - locate handles implementing a protocol.
1462 * @search_type: selection criterion
1463 * @protocol: GUID of the protocol
1464 * @search_key: registration key
1465 * @buffer_size: size of the buffer to receive the handles in bytes
1466 * @buffer: buffer to receive the relevant handles
1468 * This function implements the LocateHandle service.
1470 * See the Unified Extensible Firmware Interface (UEFI) specification for
1473 * Return: 0 if the handle implements the protocol
1475 static efi_status_t EFIAPI efi_locate_handle_ext(
1476 enum efi_locate_search_type search_type,
1477 const efi_guid_t *protocol, void *search_key,
1478 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1480 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1481 buffer_size, buffer);
1483 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1484 buffer_size, buffer));
1488 * efi_remove_configuration_table() - collapses configuration table entries,
1491 * @i: index of the table entry to be removed
1493 static void efi_remove_configuration_table(int i)
1495 struct efi_configuration_table *this = &systab.tables[i];
1496 struct efi_configuration_table *next = &systab.tables[i + 1];
1497 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1499 memmove(this, next, (ulong)end - (ulong)next);
1504 * efi_install_configuration_table() - adds, updates, or removes a
1505 * configuration table
1506 * @guid: GUID of the installed table
1507 * @table: table to be installed
1509 * This function is used for internal calls. For the API implementation of the
1510 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1512 * Return: status code
1514 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1517 struct efi_event *evt;
1521 return EFI_INVALID_PARAMETER;
1523 /* Check for GUID override */
1524 for (i = 0; i < systab.nr_tables; i++) {
1525 if (!guidcmp(guid, &systab.tables[i].guid)) {
1527 systab.tables[i].table = table;
1529 efi_remove_configuration_table(i);
1535 return EFI_NOT_FOUND;
1537 /* No override, check for overflow */
1538 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1539 return EFI_OUT_OF_RESOURCES;
1541 /* Add a new entry */
1542 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1543 systab.tables[i].table = table;
1544 systab.nr_tables = i + 1;
1547 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1548 efi_update_table_header_crc32(&systab.hdr);
1550 /* Notify that the configuration table was changed */
1551 list_for_each_entry(evt, &efi_events, link) {
1552 if (evt->group && !guidcmp(evt->group, guid)) {
1553 efi_signal_event(evt, false);
1562 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1563 * configuration table.
1564 * @guid: GUID of the installed table
1565 * @table: table to be installed
1567 * This function implements the InstallConfigurationTable service.
1569 * See the Unified Extensible Firmware Interface (UEFI) specification for
1572 * Return: status code
1574 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1577 EFI_ENTRY("%pUl, %p", guid, table);
1578 return EFI_EXIT(efi_install_configuration_table(guid, table));
1582 * efi_setup_loaded_image() - initialize a loaded image
1584 * Initialize a loaded_image_info and loaded_image_info object with correct
1585 * protocols, boot-device, etc.
1587 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1590 * @device_path: device path of the loaded image
1591 * @file_path: file path of the loaded image
1592 * @handle_ptr: handle of the loaded image
1593 * @info_ptr: loaded image protocol
1594 * Return: status code
1596 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1597 struct efi_device_path *file_path,
1598 struct efi_loaded_image_obj **handle_ptr,
1599 struct efi_loaded_image **info_ptr)
1602 struct efi_loaded_image *info = NULL;
1603 struct efi_loaded_image_obj *obj = NULL;
1604 struct efi_device_path *dp;
1606 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1610 info = calloc(1, sizeof(*info));
1612 return EFI_OUT_OF_RESOURCES;
1613 obj = calloc(1, sizeof(*obj));
1616 return EFI_OUT_OF_RESOURCES;
1618 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1620 /* Add internal object to object list */
1621 efi_add_handle(&obj->header);
1623 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1624 info->file_path = file_path;
1625 info->system_table = &systab;
1628 info->device_handle = efi_dp_find_obj(device_path, NULL);
1630 dp = efi_dp_append(device_path, file_path);
1632 ret = EFI_OUT_OF_RESOURCES;
1638 ret = efi_add_protocol(&obj->header,
1639 &efi_guid_loaded_image_device_path, dp);
1640 if (ret != EFI_SUCCESS)
1644 * When asking for the loaded_image interface, just
1645 * return handle which points to loaded_image_info
1647 ret = efi_add_protocol(&obj->header,
1648 &efi_guid_loaded_image, info);
1649 if (ret != EFI_SUCCESS)
1657 printf("ERROR: Failure to install protocols for loaded image\n");
1658 efi_delete_handle(&obj->header);
1664 * efi_load_image_from_path() - load an image using a file path
1666 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1667 * callers obligation to update the memory type as needed.
1669 * @file_path: the path of the image to load
1670 * @buffer: buffer containing the loaded image
1671 * @size: size of the loaded image
1672 * Return: status code
1675 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1676 void **buffer, efi_uintn_t *size)
1678 struct efi_file_info *info = NULL;
1679 struct efi_file_handle *f;
1680 static efi_status_t ret;
1684 /* In case of failure nothing is returned */
1689 f = efi_file_from_path(file_path);
1691 return EFI_DEVICE_ERROR;
1695 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1697 if (ret != EFI_BUFFER_TOO_SMALL) {
1698 ret = EFI_DEVICE_ERROR;
1703 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1705 if (ret != EFI_SUCCESS)
1709 * When reading the file we do not yet know if it contains an
1710 * application, a boottime driver, or a runtime driver. So here we
1711 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1712 * update the reservation according to the image type.
1714 bs = info->file_size;
1715 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1716 EFI_BOOT_SERVICES_DATA,
1717 efi_size_in_pages(bs), &addr);
1718 if (ret != EFI_SUCCESS) {
1719 ret = EFI_OUT_OF_RESOURCES;
1724 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1725 if (ret != EFI_SUCCESS)
1726 efi_free_pages(addr, efi_size_in_pages(bs));
1727 *buffer = (void *)(uintptr_t)addr;
1730 EFI_CALL(f->close(f));
1736 * efi_load_image() - load an EFI image into memory
1737 * @boot_policy: true for request originating from the boot manager
1738 * @parent_image: the caller's image handle
1739 * @file_path: the path of the image to load
1740 * @source_buffer: memory location from which the image is installed
1741 * @source_size: size of the memory area from which the image is installed
1742 * @image_handle: handle for the newly installed image
1744 * This function implements the LoadImage service.
1746 * See the Unified Extensible Firmware Interface (UEFI) specification
1749 * Return: status code
1751 efi_status_t EFIAPI efi_load_image(bool boot_policy,
1752 efi_handle_t parent_image,
1753 struct efi_device_path *file_path,
1754 void *source_buffer,
1755 efi_uintn_t source_size,
1756 efi_handle_t *image_handle)
1758 struct efi_device_path *dp, *fp;
1759 struct efi_loaded_image *info = NULL;
1760 struct efi_loaded_image_obj **image_obj =
1761 (struct efi_loaded_image_obj **)image_handle;
1765 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1766 file_path, source_buffer, source_size, image_handle);
1768 if (!image_handle || !efi_search_obj(parent_image)) {
1769 ret = EFI_INVALID_PARAMETER;
1773 if (!source_buffer && !file_path) {
1774 ret = EFI_NOT_FOUND;
1777 /* The parent image handle must refer to a loaded image */
1778 if (!parent_image->type) {
1779 ret = EFI_INVALID_PARAMETER;
1783 if (!source_buffer) {
1784 ret = efi_load_image_from_path(file_path, &dest_buffer,
1786 if (ret != EFI_SUCCESS)
1790 ret = EFI_LOAD_ERROR;
1793 dest_buffer = source_buffer;
1795 /* split file_path which contains both the device and file parts */
1796 efi_dp_split_file_path(file_path, &dp, &fp);
1797 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
1798 if (ret == EFI_SUCCESS)
1799 ret = efi_load_pe(*image_obj, dest_buffer, info);
1801 /* Release buffer to which file was loaded */
1802 efi_free_pages((uintptr_t)dest_buffer,
1803 efi_size_in_pages(source_size));
1804 if (ret == EFI_SUCCESS) {
1805 info->system_table = &systab;
1806 info->parent_handle = parent_image;
1808 /* The image is invalid. Release all associated resources. */
1809 efi_delete_handle(*image_handle);
1810 *image_handle = NULL;
1814 return EFI_EXIT(ret);
1818 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1820 static void efi_exit_caches(void)
1822 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1824 * Grub on 32bit ARM needs to have caches disabled before jumping into
1825 * a zImage, but does not know of all cache layers. Give it a hand.
1827 if (efi_is_direct_boot)
1828 cleanup_before_linux();
1833 * efi_exit_boot_services() - stop all boot services
1834 * @image_handle: handle of the loaded image
1835 * @map_key: key of the memory map
1837 * This function implements the ExitBootServices service.
1839 * See the Unified Extensible Firmware Interface (UEFI) specification
1842 * All timer events are disabled. For exit boot services events the
1843 * notification function is called. The boot services are disabled in the
1846 * Return: status code
1848 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1849 efi_uintn_t map_key)
1851 struct efi_event *evt;
1853 EFI_ENTRY("%p, %zx", image_handle, map_key);
1855 /* Check that the caller has read the current memory map */
1856 if (map_key != efi_memory_map_key)
1857 return EFI_INVALID_PARAMETER;
1859 /* Make sure that notification functions are not called anymore */
1860 efi_tpl = TPL_HIGH_LEVEL;
1862 /* Check if ExitBootServices has already been called */
1863 if (!systab.boottime)
1864 return EFI_EXIT(EFI_SUCCESS);
1866 /* Add related events to the event group */
1867 list_for_each_entry(evt, &efi_events, link) {
1868 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1869 evt->group = &efi_guid_event_group_exit_boot_services;
1871 /* Notify that ExitBootServices is invoked. */
1872 list_for_each_entry(evt, &efi_events, link) {
1874 !guidcmp(evt->group,
1875 &efi_guid_event_group_exit_boot_services)) {
1876 efi_signal_event(evt, false);
1881 /* TODO: Should persist EFI variables here */
1883 board_quiesce_devices();
1885 /* Fix up caches for EFI payloads if necessary */
1888 /* This stops all lingering devices */
1889 bootm_disable_interrupts();
1891 /* Disable boot time services */
1892 systab.con_in_handle = NULL;
1893 systab.con_in = NULL;
1894 systab.con_out_handle = NULL;
1895 systab.con_out = NULL;
1896 systab.stderr_handle = NULL;
1897 systab.std_err = NULL;
1898 systab.boottime = NULL;
1900 /* Recalculate CRC32 */
1901 efi_update_table_header_crc32(&systab.hdr);
1903 /* Give the payload some time to boot */
1904 efi_set_watchdog(0);
1907 return EFI_EXIT(EFI_SUCCESS);
1911 * efi_get_next_monotonic_count() - get next value of the counter
1912 * @count: returned value of the counter
1914 * This function implements the NextMonotonicCount service.
1916 * See the Unified Extensible Firmware Interface (UEFI) specification for
1919 * Return: status code
1921 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1923 static uint64_t mono;
1926 EFI_ENTRY("%p", count);
1928 ret = EFI_INVALID_PARAMETER;
1934 return EFI_EXIT(ret);
1938 * efi_stall() - sleep
1939 * @microseconds: period to sleep in microseconds
1941 * This function implements the Stall service.
1943 * See the Unified Extensible Firmware Interface (UEFI) specification for
1946 * Return: status code
1948 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1950 EFI_ENTRY("%ld", microseconds);
1951 udelay(microseconds);
1952 return EFI_EXIT(EFI_SUCCESS);
1956 * efi_set_watchdog_timer() - reset the watchdog timer
1957 * @timeout: seconds before reset by watchdog
1958 * @watchdog_code: code to be logged when resetting
1959 * @data_size: size of buffer in bytes
1960 * @watchdog_data: buffer with data describing the reset reason
1962 * This function implements the SetWatchdogTimer service.
1964 * See the Unified Extensible Firmware Interface (UEFI) specification for
1967 * Return: status code
1969 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1970 uint64_t watchdog_code,
1971 unsigned long data_size,
1972 uint16_t *watchdog_data)
1974 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
1975 data_size, watchdog_data);
1976 return EFI_EXIT(efi_set_watchdog(timeout));
1980 * efi_close_protocol() - close a protocol
1981 * @handle: handle on which the protocol shall be closed
1982 * @protocol: GUID of the protocol to close
1983 * @agent_handle: handle of the driver
1984 * @controller_handle: handle of the controller
1986 * This function implements the CloseProtocol service.
1988 * See the Unified Extensible Firmware Interface (UEFI) specification for
1991 * Return: status code
1993 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1994 const efi_guid_t *protocol,
1995 efi_handle_t agent_handle,
1996 efi_handle_t controller_handle)
1998 struct efi_handler *handler;
1999 struct efi_open_protocol_info_item *item;
2000 struct efi_open_protocol_info_item *pos;
2003 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2006 if (!efi_search_obj(agent_handle) ||
2007 (controller_handle && !efi_search_obj(controller_handle))) {
2008 r = EFI_INVALID_PARAMETER;
2011 r = efi_search_protocol(handle, protocol, &handler);
2012 if (r != EFI_SUCCESS)
2016 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2017 if (item->info.agent_handle == agent_handle &&
2018 item->info.controller_handle == controller_handle) {
2019 efi_delete_open_info(item);
2029 * efi_open_protocol_information() - provide information about then open status
2030 * of a protocol on a handle
2031 * @handle: handle for which the information shall be retrieved
2032 * @protocol: GUID of the protocol
2033 * @entry_buffer: buffer to receive the open protocol information
2034 * @entry_count: number of entries available in the buffer
2036 * This function implements the OpenProtocolInformation service.
2038 * See the Unified Extensible Firmware Interface (UEFI) specification for
2041 * Return: status code
2043 static efi_status_t EFIAPI efi_open_protocol_information(
2044 efi_handle_t handle, const efi_guid_t *protocol,
2045 struct efi_open_protocol_info_entry **entry_buffer,
2046 efi_uintn_t *entry_count)
2048 unsigned long buffer_size;
2049 unsigned long count;
2050 struct efi_handler *handler;
2051 struct efi_open_protocol_info_item *item;
2054 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2057 /* Check parameters */
2058 if (!entry_buffer) {
2059 r = EFI_INVALID_PARAMETER;
2062 r = efi_search_protocol(handle, protocol, &handler);
2063 if (r != EFI_SUCCESS)
2068 list_for_each_entry(item, &handler->open_infos, link) {
2069 if (item->info.open_count)
2072 *entry_count = count;
2073 *entry_buffer = NULL;
2080 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2081 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2082 (void **)entry_buffer);
2083 if (r != EFI_SUCCESS)
2085 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2086 if (item->info.open_count)
2087 (*entry_buffer)[--count] = item->info;
2094 * efi_protocols_per_handle() - get protocols installed on a handle
2095 * @handle: handle for which the information is retrieved
2096 * @protocol_buffer: buffer with protocol GUIDs
2097 * @protocol_buffer_count: number of entries in the buffer
2099 * This function implements the ProtocolsPerHandleService.
2101 * See the Unified Extensible Firmware Interface (UEFI) specification for
2104 * Return: status code
2106 static efi_status_t EFIAPI efi_protocols_per_handle(
2107 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2108 efi_uintn_t *protocol_buffer_count)
2110 unsigned long buffer_size;
2111 struct efi_object *efiobj;
2112 struct list_head *protocol_handle;
2115 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2116 protocol_buffer_count);
2118 if (!handle || !protocol_buffer || !protocol_buffer_count)
2119 return EFI_EXIT(EFI_INVALID_PARAMETER);
2121 *protocol_buffer = NULL;
2122 *protocol_buffer_count = 0;
2124 efiobj = efi_search_obj(handle);
2126 return EFI_EXIT(EFI_INVALID_PARAMETER);
2128 /* Count protocols */
2129 list_for_each(protocol_handle, &efiobj->protocols) {
2130 ++*protocol_buffer_count;
2134 if (*protocol_buffer_count) {
2137 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2138 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2139 (void **)protocol_buffer);
2140 if (r != EFI_SUCCESS)
2142 list_for_each(protocol_handle, &efiobj->protocols) {
2143 struct efi_handler *protocol;
2145 protocol = list_entry(protocol_handle,
2146 struct efi_handler, link);
2147 (*protocol_buffer)[j] = (void *)protocol->guid;
2152 return EFI_EXIT(EFI_SUCCESS);
2156 * efi_locate_handle_buffer() - locate handles implementing a protocol
2157 * @search_type: selection criterion
2158 * @protocol: GUID of the protocol
2159 * @search_key: registration key
2160 * @no_handles: number of returned handles
2161 * @buffer: buffer with the returned handles
2163 * This function implements the LocateHandleBuffer service.
2165 * See the Unified Extensible Firmware Interface (UEFI) specification for
2168 * Return: status code
2170 static efi_status_t EFIAPI efi_locate_handle_buffer(
2171 enum efi_locate_search_type search_type,
2172 const efi_guid_t *protocol, void *search_key,
2173 efi_uintn_t *no_handles, efi_handle_t **buffer)
2176 efi_uintn_t buffer_size = 0;
2178 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2179 no_handles, buffer);
2181 if (!no_handles || !buffer) {
2182 r = EFI_INVALID_PARAMETER;
2187 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2189 if (r != EFI_BUFFER_TOO_SMALL)
2191 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2193 if (r != EFI_SUCCESS)
2195 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2197 if (r == EFI_SUCCESS)
2198 *no_handles = buffer_size / sizeof(efi_handle_t);
2204 * efi_locate_protocol() - find an interface implementing a protocol
2205 * @protocol: GUID of the protocol
2206 * @registration: registration key passed to the notification function
2207 * @protocol_interface: interface implementing the protocol
2209 * This function implements the LocateProtocol service.
2211 * See the Unified Extensible Firmware Interface (UEFI) specification for
2214 * Return: status code
2216 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2218 void **protocol_interface)
2220 struct list_head *lhandle;
2223 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2225 if (!protocol || !protocol_interface)
2226 return EFI_EXIT(EFI_INVALID_PARAMETER);
2228 list_for_each(lhandle, &efi_obj_list) {
2229 struct efi_object *efiobj;
2230 struct efi_handler *handler;
2232 efiobj = list_entry(lhandle, struct efi_object, link);
2234 ret = efi_search_protocol(efiobj, protocol, &handler);
2235 if (ret == EFI_SUCCESS) {
2236 *protocol_interface = handler->protocol_interface;
2237 return EFI_EXIT(EFI_SUCCESS);
2240 *protocol_interface = NULL;
2242 return EFI_EXIT(EFI_NOT_FOUND);
2246 * efi_locate_device_path() - Get the device path and handle of an device
2247 * implementing a protocol
2248 * @protocol: GUID of the protocol
2249 * @device_path: device path
2250 * @device: handle of the device
2252 * This function implements the LocateDevicePath service.
2254 * See the Unified Extensible Firmware Interface (UEFI) specification for
2257 * Return: status code
2259 static efi_status_t EFIAPI efi_locate_device_path(
2260 const efi_guid_t *protocol,
2261 struct efi_device_path **device_path,
2262 efi_handle_t *device)
2264 struct efi_device_path *dp;
2266 struct efi_handler *handler;
2267 efi_handle_t *handles;
2269 size_t len_best = 0;
2270 efi_uintn_t no_handles;
2274 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2276 if (!protocol || !device_path || !*device_path) {
2277 ret = EFI_INVALID_PARAMETER;
2281 /* Find end of device path */
2282 len = efi_dp_instance_size(*device_path);
2284 /* Get all handles implementing the protocol */
2285 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2286 &no_handles, &handles));
2287 if (ret != EFI_SUCCESS)
2290 for (i = 0; i < no_handles; ++i) {
2291 /* Find the device path protocol */
2292 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2294 if (ret != EFI_SUCCESS)
2296 dp = (struct efi_device_path *)handler->protocol_interface;
2297 len_dp = efi_dp_instance_size(dp);
2299 * This handle can only be a better fit
2300 * if its device path length is longer than the best fit and
2301 * if its device path length is shorter of equal the searched
2304 if (len_dp <= len_best || len_dp > len)
2306 /* Check if dp is a subpath of device_path */
2307 if (memcmp(*device_path, dp, len_dp))
2310 ret = EFI_INVALID_PARAMETER;
2313 *device = handles[i];
2317 remainder = (u8 *)*device_path + len_best;
2318 *device_path = (struct efi_device_path *)remainder;
2321 ret = EFI_NOT_FOUND;
2324 return EFI_EXIT(ret);
2328 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2330 * @handle: handle on which the protocol interfaces shall be installed
2331 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2334 * This function implements the MultipleProtocolInterfaces service.
2336 * See the Unified Extensible Firmware Interface (UEFI) specification for
2339 * Return: status code
2341 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2342 (efi_handle_t *handle, ...)
2344 EFI_ENTRY("%p", handle);
2347 const efi_guid_t *protocol;
2348 void *protocol_interface;
2349 efi_handle_t old_handle;
2350 efi_status_t r = EFI_SUCCESS;
2354 return EFI_EXIT(EFI_INVALID_PARAMETER);
2356 efi_va_start(argptr, handle);
2358 protocol = efi_va_arg(argptr, efi_guid_t*);
2361 protocol_interface = efi_va_arg(argptr, void*);
2362 /* Check that a device path has not been installed before */
2363 if (!guidcmp(protocol, &efi_guid_device_path)) {
2364 struct efi_device_path *dp = protocol_interface;
2366 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2368 if (r == EFI_SUCCESS &&
2369 dp->type == DEVICE_PATH_TYPE_END) {
2370 EFI_PRINT("Path %pD already installed\n",
2371 protocol_interface);
2372 r = EFI_ALREADY_STARTED;
2376 r = EFI_CALL(efi_install_protocol_interface(
2378 EFI_NATIVE_INTERFACE,
2379 protocol_interface));
2380 if (r != EFI_SUCCESS)
2385 if (r == EFI_SUCCESS)
2388 /* If an error occurred undo all changes. */
2389 efi_va_start(argptr, handle);
2391 protocol = efi_va_arg(argptr, efi_guid_t*);
2392 protocol_interface = efi_va_arg(argptr, void*);
2393 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2394 protocol_interface));
2402 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2404 * @handle: handle from which the protocol interfaces shall be removed
2405 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2408 * This function implements the UninstallMultipleProtocolInterfaces service.
2410 * See the Unified Extensible Firmware Interface (UEFI) specification for
2413 * Return: status code
2415 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2416 efi_handle_t handle, ...)
2418 EFI_ENTRY("%p", handle);
2421 const efi_guid_t *protocol;
2422 void *protocol_interface;
2423 efi_status_t r = EFI_SUCCESS;
2427 return EFI_EXIT(EFI_INVALID_PARAMETER);
2429 efi_va_start(argptr, handle);
2431 protocol = efi_va_arg(argptr, efi_guid_t*);
2434 protocol_interface = efi_va_arg(argptr, void*);
2435 r = efi_uninstall_protocol(handle, protocol,
2436 protocol_interface);
2437 if (r != EFI_SUCCESS)
2442 if (r == EFI_SUCCESS) {
2443 /* If the last protocol has been removed, delete the handle. */
2444 if (list_empty(&handle->protocols)) {
2445 list_del(&handle->link);
2451 /* If an error occurred undo all changes. */
2452 efi_va_start(argptr, handle);
2454 protocol = efi_va_arg(argptr, efi_guid_t*);
2455 protocol_interface = efi_va_arg(argptr, void*);
2456 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2457 EFI_NATIVE_INTERFACE,
2458 protocol_interface));
2462 /* In case of an error always return EFI_INVALID_PARAMETER */
2463 return EFI_EXIT(EFI_INVALID_PARAMETER);
2467 * efi_calculate_crc32() - calculate cyclic redundancy code
2468 * @data: buffer with data
2469 * @data_size: size of buffer in bytes
2470 * @crc32_p: cyclic redundancy code
2472 * This function implements the CalculateCrc32 service.
2474 * See the Unified Extensible Firmware Interface (UEFI) specification for
2477 * Return: status code
2479 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2480 efi_uintn_t data_size,
2483 efi_status_t ret = EFI_SUCCESS;
2485 EFI_ENTRY("%p, %zu", data, data_size);
2486 if (!data || !data_size || !crc32_p) {
2487 ret = EFI_INVALID_PARAMETER;
2490 *crc32_p = crc32(0, data, data_size);
2492 return EFI_EXIT(ret);
2496 * efi_copy_mem() - copy memory
2497 * @destination: destination of the copy operation
2498 * @source: source of the copy operation
2499 * @length: number of bytes to copy
2501 * This function implements the CopyMem service.
2503 * See the Unified Extensible Firmware Interface (UEFI) specification for
2506 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2509 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2510 memmove(destination, source, length);
2511 EFI_EXIT(EFI_SUCCESS);
2515 * efi_set_mem() - Fill memory with a byte value.
2516 * @buffer: buffer to fill
2517 * @size: size of buffer in bytes
2518 * @value: byte to copy to the buffer
2520 * This function implements the SetMem service.
2522 * See the Unified Extensible Firmware Interface (UEFI) specification for
2525 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2527 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2528 memset(buffer, value, size);
2529 EFI_EXIT(EFI_SUCCESS);
2533 * efi_protocol_open() - open protocol interface on a handle
2534 * @handler: handler of a protocol
2535 * @protocol_interface: interface implementing the protocol
2536 * @agent_handle: handle of the driver
2537 * @controller_handle: handle of the controller
2538 * @attributes: attributes indicating how to open the protocol
2540 * Return: status code
2542 static efi_status_t efi_protocol_open(
2543 struct efi_handler *handler,
2544 void **protocol_interface, void *agent_handle,
2545 void *controller_handle, uint32_t attributes)
2547 struct efi_open_protocol_info_item *item;
2548 struct efi_open_protocol_info_entry *match = NULL;
2549 bool opened_by_driver = false;
2550 bool opened_exclusive = false;
2552 /* If there is no agent, only return the interface */
2556 /* For TEST_PROTOCOL ignore interface attribute */
2557 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2558 *protocol_interface = NULL;
2561 * Check if the protocol is already opened by a driver with the same
2562 * attributes or opened exclusively
2564 list_for_each_entry(item, &handler->open_infos, link) {
2565 if (item->info.agent_handle == agent_handle) {
2566 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2567 (item->info.attributes == attributes))
2568 return EFI_ALREADY_STARTED;
2570 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2571 opened_exclusive = true;
2574 /* Only one controller can open the protocol exclusively */
2575 if (opened_exclusive && attributes &
2576 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2577 return EFI_ACCESS_DENIED;
2579 /* Prepare exclusive opening */
2580 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2581 /* Try to disconnect controllers */
2582 list_for_each_entry(item, &handler->open_infos, link) {
2583 if (item->info.attributes ==
2584 EFI_OPEN_PROTOCOL_BY_DRIVER)
2585 EFI_CALL(efi_disconnect_controller(
2586 item->info.controller_handle,
2587 item->info.agent_handle,
2590 opened_by_driver = false;
2591 /* Check if all controllers are disconnected */
2592 list_for_each_entry(item, &handler->open_infos, link) {
2593 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2594 opened_by_driver = true;
2596 /* Only one controller can be connected */
2597 if (opened_by_driver)
2598 return EFI_ACCESS_DENIED;
2601 /* Find existing entry */
2602 list_for_each_entry(item, &handler->open_infos, link) {
2603 if (item->info.agent_handle == agent_handle &&
2604 item->info.controller_handle == controller_handle)
2605 match = &item->info;
2607 /* None found, create one */
2609 match = efi_create_open_info(handler);
2611 return EFI_OUT_OF_RESOURCES;
2614 match->agent_handle = agent_handle;
2615 match->controller_handle = controller_handle;
2616 match->attributes = attributes;
2617 match->open_count++;
2620 /* For TEST_PROTOCOL ignore interface attribute. */
2621 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2622 *protocol_interface = handler->protocol_interface;
2628 * efi_open_protocol() - open protocol interface on a handle
2629 * @handle: handle on which the protocol shall be opened
2630 * @protocol: GUID of the protocol
2631 * @protocol_interface: interface implementing the protocol
2632 * @agent_handle: handle of the driver
2633 * @controller_handle: handle of the controller
2634 * @attributes: attributes indicating how to open the protocol
2636 * This function implements the OpenProtocol interface.
2638 * See the Unified Extensible Firmware Interface (UEFI) specification for
2641 * Return: status code
2643 static efi_status_t EFIAPI efi_open_protocol
2644 (efi_handle_t handle, const efi_guid_t *protocol,
2645 void **protocol_interface, efi_handle_t agent_handle,
2646 efi_handle_t controller_handle, uint32_t attributes)
2648 struct efi_handler *handler;
2649 efi_status_t r = EFI_INVALID_PARAMETER;
2651 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2652 protocol_interface, agent_handle, controller_handle,
2655 if (!handle || !protocol ||
2656 (!protocol_interface && attributes !=
2657 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2661 switch (attributes) {
2662 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2663 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2664 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2666 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2667 if (controller_handle == handle)
2670 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2671 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2672 /* Check that the controller handle is valid */
2673 if (!efi_search_obj(controller_handle))
2676 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2677 /* Check that the agent handle is valid */
2678 if (!efi_search_obj(agent_handle))
2685 r = efi_search_protocol(handle, protocol, &handler);
2690 r = EFI_UNSUPPORTED;
2696 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2697 controller_handle, attributes);
2703 * efi_start_image() - call the entry point of an image
2704 * @image_handle: handle of the image
2705 * @exit_data_size: size of the buffer
2706 * @exit_data: buffer to receive the exit data of the called image
2708 * This function implements the StartImage service.
2710 * See the Unified Extensible Firmware Interface (UEFI) specification for
2713 * Return: status code
2715 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2716 efi_uintn_t *exit_data_size,
2719 struct efi_loaded_image_obj *image_obj =
2720 (struct efi_loaded_image_obj *)image_handle;
2723 efi_handle_t parent_image = current_image;
2725 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2727 /* Check parameters */
2728 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2730 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2731 if (ret != EFI_SUCCESS)
2732 return EFI_EXIT(EFI_INVALID_PARAMETER);
2734 efi_is_direct_boot = false;
2736 image_obj->exit_data_size = exit_data_size;
2737 image_obj->exit_data = exit_data;
2739 /* call the image! */
2740 if (setjmp(&image_obj->exit_jmp)) {
2742 * We called the entry point of the child image with EFI_CALL
2743 * in the lines below. The child image called the Exit() boot
2744 * service efi_exit() which executed the long jump that brought
2745 * us to the current line. This implies that the second half
2746 * of the EFI_CALL macro has not been executed.
2750 * efi_exit() called efi_restore_gd(). We have to undo this
2751 * otherwise __efi_entry_check() will put the wrong value into
2757 * To get ready to call EFI_EXIT below we have to execute the
2758 * missed out steps of EFI_CALL.
2760 assert(__efi_entry_check());
2761 EFI_PRINT("%lu returned by started image\n",
2762 (unsigned long)((uintptr_t)image_obj->exit_status &
2764 current_image = parent_image;
2765 return EFI_EXIT(image_obj->exit_status);
2768 current_image = image_handle;
2769 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
2770 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
2771 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2774 * Usually UEFI applications call Exit() instead of returning.
2775 * But because the world doesn't consist of ponies and unicorns,
2776 * we're happy to emulate that behavior on behalf of a payload
2779 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2783 * efi_delete_image() - delete loaded image from memory)
2785 * @image_obj: handle of the loaded image
2786 * @loaded_image_protocol: loaded image protocol
2788 static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2789 struct efi_loaded_image *loaded_image_protocol)
2791 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2792 efi_size_in_pages(loaded_image_protocol->image_size));
2793 efi_delete_handle(&image_obj->header);
2797 * efi_unload_image() - unload an EFI image
2798 * @image_handle: handle of the image to be unloaded
2800 * This function implements the UnloadImage service.
2802 * See the Unified Extensible Firmware Interface (UEFI) specification for
2805 * Return: status code
2807 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2809 efi_status_t ret = EFI_SUCCESS;
2810 struct efi_object *efiobj;
2811 struct efi_loaded_image *loaded_image_protocol;
2813 EFI_ENTRY("%p", image_handle);
2815 efiobj = efi_search_obj(image_handle);
2817 ret = EFI_INVALID_PARAMETER;
2820 /* Find the loaded image protocol */
2821 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2822 (void **)&loaded_image_protocol,
2824 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2825 if (ret != EFI_SUCCESS) {
2826 ret = EFI_INVALID_PARAMETER;
2829 switch (efiobj->type) {
2830 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2831 /* Call the unload function */
2832 if (!loaded_image_protocol->unload) {
2833 ret = EFI_UNSUPPORTED;
2836 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2837 if (ret != EFI_SUCCESS)
2840 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2843 ret = EFI_INVALID_PARAMETER;
2846 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2847 loaded_image_protocol);
2849 return EFI_EXIT(ret);
2853 * efi_update_exit_data() - fill exit data parameters of StartImage()
2855 * @image_obj image handle
2856 * @exit_data_size size of the exit data buffer
2857 * @exit_data buffer with data returned by UEFI payload
2858 * Return: status code
2860 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2861 efi_uintn_t exit_data_size,
2867 * If exit_data is not provided to StartImage(), exit_data_size must be
2870 if (!image_obj->exit_data)
2872 if (image_obj->exit_data_size)
2873 *image_obj->exit_data_size = exit_data_size;
2874 if (exit_data_size && exit_data) {
2875 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2877 (void **)image_obj->exit_data);
2878 if (ret != EFI_SUCCESS)
2880 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2882 image_obj->exit_data = NULL;
2888 * efi_exit() - leave an EFI application or driver
2889 * @image_handle: handle of the application or driver that is exiting
2890 * @exit_status: status code
2891 * @exit_data_size: size of the buffer in bytes
2892 * @exit_data: buffer with data describing an error
2894 * This function implements the Exit service.
2896 * See the Unified Extensible Firmware Interface (UEFI) specification for
2899 * Return: status code
2901 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2902 efi_status_t exit_status,
2903 efi_uintn_t exit_data_size,
2907 * TODO: We should call the unload procedure of the loaded
2911 struct efi_loaded_image *loaded_image_protocol;
2912 struct efi_loaded_image_obj *image_obj =
2913 (struct efi_loaded_image_obj *)image_handle;
2915 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2916 exit_data_size, exit_data);
2918 /* Check parameters */
2919 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2920 (void **)&loaded_image_protocol,
2922 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2923 if (ret != EFI_SUCCESS) {
2924 ret = EFI_INVALID_PARAMETER;
2928 /* Unloading of unstarted images */
2929 switch (image_obj->header.type) {
2930 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2932 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2933 efi_delete_image(image_obj, loaded_image_protocol);
2937 /* Handle does not refer to loaded image */
2938 ret = EFI_INVALID_PARAMETER;
2941 /* A started image can only be unloaded it is the last one started. */
2942 if (image_handle != current_image) {
2943 ret = EFI_INVALID_PARAMETER;
2947 /* Exit data is only foreseen in case of failure. */
2948 if (exit_status != EFI_SUCCESS) {
2949 ret = efi_update_exit_data(image_obj, exit_data_size,
2951 /* Exiting has priority. Don't return error to caller. */
2952 if (ret != EFI_SUCCESS)
2953 EFI_PRINT("%s: out of memory\n", __func__);
2955 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2956 exit_status != EFI_SUCCESS)
2957 efi_delete_image(image_obj, loaded_image_protocol);
2959 /* Make sure entry/exit counts for EFI world cross-overs match */
2960 EFI_EXIT(exit_status);
2963 * But longjmp out with the U-Boot gd, not the application's, as
2964 * the other end is a setjmp call inside EFI context.
2968 image_obj->exit_status = exit_status;
2969 longjmp(&image_obj->exit_jmp, 1);
2971 panic("EFI application exited");
2973 return EFI_EXIT(ret);
2977 * efi_handle_protocol() - get interface of a protocol on a handle
2978 * @handle: handle on which the protocol shall be opened
2979 * @protocol: GUID of the protocol
2980 * @protocol_interface: interface implementing the protocol
2982 * This function implements the HandleProtocol service.
2984 * See the Unified Extensible Firmware Interface (UEFI) specification for
2987 * Return: status code
2989 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2990 const efi_guid_t *protocol,
2991 void **protocol_interface)
2993 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2994 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2998 * efi_bind_controller() - bind a single driver to a controller
2999 * @controller_handle: controller handle
3000 * @driver_image_handle: driver handle
3001 * @remain_device_path: remaining path
3003 * Return: status code
3005 static efi_status_t efi_bind_controller(
3006 efi_handle_t controller_handle,
3007 efi_handle_t driver_image_handle,
3008 struct efi_device_path *remain_device_path)
3010 struct efi_driver_binding_protocol *binding_protocol;
3013 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3014 &efi_guid_driver_binding_protocol,
3015 (void **)&binding_protocol,
3016 driver_image_handle, NULL,
3017 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3018 if (r != EFI_SUCCESS)
3020 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3022 remain_device_path));
3023 if (r == EFI_SUCCESS)
3024 r = EFI_CALL(binding_protocol->start(binding_protocol,
3026 remain_device_path));
3027 EFI_CALL(efi_close_protocol(driver_image_handle,
3028 &efi_guid_driver_binding_protocol,
3029 driver_image_handle, NULL));
3034 * efi_connect_single_controller() - connect a single driver to a controller
3035 * @controller_handle: controller
3036 * @driver_image_handle: driver
3037 * @remain_device_path: remaining path
3039 * Return: status code
3041 static efi_status_t efi_connect_single_controller(
3042 efi_handle_t controller_handle,
3043 efi_handle_t *driver_image_handle,
3044 struct efi_device_path *remain_device_path)
3046 efi_handle_t *buffer;
3050 size_t connected = 0;
3052 /* Get buffer with all handles with driver binding protocol */
3053 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3054 &efi_guid_driver_binding_protocol,
3055 NULL, &count, &buffer));
3056 if (r != EFI_SUCCESS)
3059 /* Context Override */
3060 if (driver_image_handle) {
3061 for (; *driver_image_handle; ++driver_image_handle) {
3062 for (i = 0; i < count; ++i) {
3063 if (buffer[i] == *driver_image_handle) {
3065 r = efi_bind_controller(
3067 *driver_image_handle,
3068 remain_device_path);
3070 * For drivers that do not support the
3071 * controller or are already connected
3072 * we receive an error code here.
3074 if (r == EFI_SUCCESS)
3082 * TODO: Some overrides are not yet implemented:
3083 * - Platform Driver Override
3084 * - Driver Family Override Search
3085 * - Bus Specific Driver Override
3088 /* Driver Binding Search */
3089 for (i = 0; i < count; ++i) {
3091 r = efi_bind_controller(controller_handle,
3093 remain_device_path);
3094 if (r == EFI_SUCCESS)
3099 efi_free_pool(buffer);
3101 return EFI_NOT_FOUND;
3106 * efi_connect_controller() - connect a controller to a driver
3107 * @controller_handle: handle of the controller
3108 * @driver_image_handle: handle of the driver
3109 * @remain_device_path: device path of a child controller
3110 * @recursive: true to connect all child controllers
3112 * This function implements the ConnectController service.
3114 * See the Unified Extensible Firmware Interface (UEFI) specification for
3117 * First all driver binding protocol handles are tried for binding drivers.
3118 * Afterwards all handles that have opened a protocol of the controller
3119 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3121 * Return: status code
3123 static efi_status_t EFIAPI efi_connect_controller(
3124 efi_handle_t controller_handle,
3125 efi_handle_t *driver_image_handle,
3126 struct efi_device_path *remain_device_path,
3130 efi_status_t ret = EFI_NOT_FOUND;
3131 struct efi_object *efiobj;
3133 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3134 remain_device_path, recursive);
3136 efiobj = efi_search_obj(controller_handle);
3138 ret = EFI_INVALID_PARAMETER;
3142 r = efi_connect_single_controller(controller_handle,
3143 driver_image_handle,
3144 remain_device_path);
3145 if (r == EFI_SUCCESS)
3148 struct efi_handler *handler;
3149 struct efi_open_protocol_info_item *item;
3151 list_for_each_entry(handler, &efiobj->protocols, link) {
3152 list_for_each_entry(item, &handler->open_infos, link) {
3153 if (item->info.attributes &
3154 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3155 r = EFI_CALL(efi_connect_controller(
3156 item->info.controller_handle,
3157 driver_image_handle,
3160 if (r == EFI_SUCCESS)
3166 /* Check for child controller specified by end node */
3167 if (ret != EFI_SUCCESS && remain_device_path &&
3168 remain_device_path->type == DEVICE_PATH_TYPE_END)
3171 return EFI_EXIT(ret);
3175 * efi_reinstall_protocol_interface() - reinstall protocol interface
3176 * @handle: handle on which the protocol shall be reinstalled
3177 * @protocol: GUID of the protocol to be installed
3178 * @old_interface: interface to be removed
3179 * @new_interface: interface to be installed
3181 * This function implements the ReinstallProtocolInterface service.
3183 * See the Unified Extensible Firmware Interface (UEFI) specification for
3186 * The old interface is uninstalled. The new interface is installed.
3187 * Drivers are connected.
3189 * Return: status code
3191 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3192 efi_handle_t handle, const efi_guid_t *protocol,
3193 void *old_interface, void *new_interface)
3197 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3200 /* Uninstall protocol but do not delete handle */
3201 ret = efi_uninstall_protocol(handle, protocol, old_interface);
3202 if (ret != EFI_SUCCESS)
3205 /* Install the new protocol */
3206 ret = efi_add_protocol(handle, protocol, new_interface);
3208 * The UEFI spec does not specify what should happen to the handle
3209 * if in case of an error no protocol interface remains on the handle.
3210 * So let's do nothing here.
3212 if (ret != EFI_SUCCESS)
3215 * The returned status code has to be ignored.
3216 * Do not create an error if no suitable driver for the handle exists.
3218 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3220 return EFI_EXIT(ret);
3224 * efi_get_child_controllers() - get all child controllers associated to a driver
3225 * @efiobj: handle of the controller
3226 * @driver_handle: handle of the driver
3227 * @number_of_children: number of child controllers
3228 * @child_handle_buffer: handles of the the child controllers
3230 * The allocated buffer has to be freed with free().
3232 * Return: status code
3234 static efi_status_t efi_get_child_controllers(
3235 struct efi_object *efiobj,
3236 efi_handle_t driver_handle,
3237 efi_uintn_t *number_of_children,
3238 efi_handle_t **child_handle_buffer)
3240 struct efi_handler *handler;
3241 struct efi_open_protocol_info_item *item;
3242 efi_uintn_t count = 0, i;
3245 /* Count all child controller associations */
3246 list_for_each_entry(handler, &efiobj->protocols, link) {
3247 list_for_each_entry(item, &handler->open_infos, link) {
3248 if (item->info.agent_handle == driver_handle &&
3249 item->info.attributes &
3250 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3255 * Create buffer. In case of duplicate child controller assignments
3256 * the buffer will be too large. But that does not harm.
3258 *number_of_children = 0;
3259 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3260 if (!*child_handle_buffer)
3261 return EFI_OUT_OF_RESOURCES;
3262 /* Copy unique child handles */
3263 list_for_each_entry(handler, &efiobj->protocols, link) {
3264 list_for_each_entry(item, &handler->open_infos, link) {
3265 if (item->info.agent_handle == driver_handle &&
3266 item->info.attributes &
3267 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3268 /* Check this is a new child controller */
3270 for (i = 0; i < *number_of_children; ++i) {
3271 if ((*child_handle_buffer)[i] ==
3272 item->info.controller_handle)
3275 /* Copy handle to buffer */
3277 i = (*number_of_children)++;
3278 (*child_handle_buffer)[i] =
3279 item->info.controller_handle;
3288 * efi_disconnect_controller() - disconnect a controller from a driver
3289 * @controller_handle: handle of the controller
3290 * @driver_image_handle: handle of the driver
3291 * @child_handle: handle of the child to destroy
3293 * This function implements the DisconnectController service.
3295 * See the Unified Extensible Firmware Interface (UEFI) specification for
3298 * Return: status code
3300 static efi_status_t EFIAPI efi_disconnect_controller(
3301 efi_handle_t controller_handle,
3302 efi_handle_t driver_image_handle,
3303 efi_handle_t child_handle)
3305 struct efi_driver_binding_protocol *binding_protocol;
3306 efi_handle_t *child_handle_buffer = NULL;
3307 size_t number_of_children = 0;
3309 size_t stop_count = 0;
3310 struct efi_object *efiobj;
3312 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3315 efiobj = efi_search_obj(controller_handle);
3317 r = EFI_INVALID_PARAMETER;
3321 if (child_handle && !efi_search_obj(child_handle)) {
3322 r = EFI_INVALID_PARAMETER;
3326 /* If no driver handle is supplied, disconnect all drivers */
3327 if (!driver_image_handle) {
3328 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3332 /* Create list of child handles */
3334 number_of_children = 1;
3335 child_handle_buffer = &child_handle;
3337 efi_get_child_controllers(efiobj,
3338 driver_image_handle,
3339 &number_of_children,
3340 &child_handle_buffer);
3343 /* Get the driver binding protocol */
3344 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3345 &efi_guid_driver_binding_protocol,
3346 (void **)&binding_protocol,
3347 driver_image_handle, NULL,
3348 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3349 if (r != EFI_SUCCESS)
3351 /* Remove the children */
3352 if (number_of_children) {
3353 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3356 child_handle_buffer));
3357 if (r == EFI_SUCCESS)
3360 /* Remove the driver */
3362 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3365 if (r == EFI_SUCCESS)
3367 EFI_CALL(efi_close_protocol(driver_image_handle,
3368 &efi_guid_driver_binding_protocol,
3369 driver_image_handle, NULL));
3377 free(child_handle_buffer);
3381 static struct efi_boot_services efi_boot_services = {
3383 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3384 .revision = EFI_SPECIFICATION_VERSION,
3385 .headersize = sizeof(struct efi_boot_services),
3387 .raise_tpl = efi_raise_tpl,
3388 .restore_tpl = efi_restore_tpl,
3389 .allocate_pages = efi_allocate_pages_ext,
3390 .free_pages = efi_free_pages_ext,
3391 .get_memory_map = efi_get_memory_map_ext,
3392 .allocate_pool = efi_allocate_pool_ext,
3393 .free_pool = efi_free_pool_ext,
3394 .create_event = efi_create_event_ext,
3395 .set_timer = efi_set_timer_ext,
3396 .wait_for_event = efi_wait_for_event,
3397 .signal_event = efi_signal_event_ext,
3398 .close_event = efi_close_event,
3399 .check_event = efi_check_event,
3400 .install_protocol_interface = efi_install_protocol_interface,
3401 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3402 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3403 .handle_protocol = efi_handle_protocol,
3405 .register_protocol_notify = efi_register_protocol_notify,
3406 .locate_handle = efi_locate_handle_ext,
3407 .locate_device_path = efi_locate_device_path,
3408 .install_configuration_table = efi_install_configuration_table_ext,
3409 .load_image = efi_load_image,
3410 .start_image = efi_start_image,
3412 .unload_image = efi_unload_image,
3413 .exit_boot_services = efi_exit_boot_services,
3414 .get_next_monotonic_count = efi_get_next_monotonic_count,
3416 .set_watchdog_timer = efi_set_watchdog_timer,
3417 .connect_controller = efi_connect_controller,
3418 .disconnect_controller = efi_disconnect_controller,
3419 .open_protocol = efi_open_protocol,
3420 .close_protocol = efi_close_protocol,
3421 .open_protocol_information = efi_open_protocol_information,
3422 .protocols_per_handle = efi_protocols_per_handle,
3423 .locate_handle_buffer = efi_locate_handle_buffer,
3424 .locate_protocol = efi_locate_protocol,
3425 .install_multiple_protocol_interfaces =
3426 efi_install_multiple_protocol_interfaces,
3427 .uninstall_multiple_protocol_interfaces =
3428 efi_uninstall_multiple_protocol_interfaces,
3429 .calculate_crc32 = efi_calculate_crc32,
3430 .copy_mem = efi_copy_mem,
3431 .set_mem = efi_set_mem,
3432 .create_event_ex = efi_create_event_ex,
3435 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3437 struct efi_system_table __efi_runtime_data systab = {
3439 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3440 .revision = EFI_SPECIFICATION_VERSION,
3441 .headersize = sizeof(struct efi_system_table),
3443 .fw_vendor = firmware_vendor,
3444 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3445 .con_in = (void *)&efi_con_in,
3446 .con_out = (void *)&efi_con_out,
3447 .std_err = (void *)&efi_con_out,
3448 .runtime = (void *)&efi_runtime_services,
3449 .boottime = (void *)&efi_boot_services,
3455 * efi_initialize_system_table() - Initialize system table
3457 * Return: status code
3459 efi_status_t efi_initialize_system_table(void)
3463 /* Allocate configuration table array */
3464 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3465 EFI_MAX_CONFIGURATION_TABLES *
3466 sizeof(struct efi_configuration_table),
3467 (void **)&systab.tables);
3469 /* Set CRC32 field in table headers */
3470 efi_update_table_header_crc32(&systab.hdr);
3471 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3472 efi_update_table_header_crc32(&efi_boot_services.hdr);