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 EFI_CALL_VOID(event->notify_function(event,
185 event->notify_context));
187 event->is_queued = false;
191 * is_valid_tpl() - check if the task priority level is valid
193 * @tpl: TPL level to check
194 * Return: status code
196 efi_status_t is_valid_tpl(efi_uintn_t tpl)
199 case TPL_APPLICATION:
205 return EFI_INVALID_PARAMETER;
210 * efi_signal_event() - signal an EFI event
211 * @event: event to signal
212 * @check_tpl: check the TPL level
214 * This function signals an event. If the event belongs to an event group all
215 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
216 * their notification function is queued.
218 * For the SignalEvent service see efi_signal_event_ext.
220 void efi_signal_event(struct efi_event *event, bool check_tpl)
223 struct efi_event *evt;
226 * The signaled state has to set before executing any
227 * notification function
229 list_for_each_entry(evt, &efi_events, link) {
230 if (!evt->group || guidcmp(evt->group, event->group))
232 if (evt->is_signaled)
234 evt->is_signaled = true;
235 if (evt->type & EVT_NOTIFY_SIGNAL &&
236 evt->notify_function)
237 evt->is_queued = true;
239 list_for_each_entry(evt, &efi_events, link) {
240 if (!evt->group || guidcmp(evt->group, event->group))
243 efi_queue_event(evt, check_tpl);
246 event->is_signaled = true;
247 if (event->type & EVT_NOTIFY_SIGNAL)
248 efi_queue_event(event, check_tpl);
253 * efi_raise_tpl() - raise the task priority level
254 * @new_tpl: new value of the task priority level
256 * This function implements the RaiseTpl service.
258 * See the Unified Extensible Firmware Interface (UEFI) specification for
261 * Return: old value of the task priority level
263 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
265 efi_uintn_t old_tpl = efi_tpl;
267 EFI_ENTRY("0x%zx", new_tpl);
269 if (new_tpl < efi_tpl)
270 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
272 if (efi_tpl > TPL_HIGH_LEVEL)
273 efi_tpl = TPL_HIGH_LEVEL;
275 EFI_EXIT(EFI_SUCCESS);
280 * efi_restore_tpl() - lower the task priority level
281 * @old_tpl: value of the task priority level to be restored
283 * This function implements the RestoreTpl service.
285 * See the Unified Extensible Firmware Interface (UEFI) specification for
288 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
290 EFI_ENTRY("0x%zx", old_tpl);
292 if (old_tpl > efi_tpl)
293 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
295 if (efi_tpl > TPL_HIGH_LEVEL)
296 efi_tpl = TPL_HIGH_LEVEL;
299 * Lowering the TPL may have made queued events eligible for execution.
303 EFI_EXIT(EFI_SUCCESS);
307 * efi_allocate_pages_ext() - allocate memory pages
308 * @type: type of allocation to be performed
309 * @memory_type: usage type of the allocated memory
310 * @pages: number of pages to be allocated
311 * @memory: allocated memory
313 * This function implements the AllocatePages service.
315 * See the Unified Extensible Firmware Interface (UEFI) specification for
318 * Return: status code
320 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
326 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
327 r = efi_allocate_pages(type, memory_type, pages, memory);
332 * efi_free_pages_ext() - Free memory pages.
333 * @memory: start of the memory area to be freed
334 * @pages: number of pages to be freed
336 * This function implements the FreePages service.
338 * See the Unified Extensible Firmware Interface (UEFI) specification for
341 * Return: status code
343 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
348 EFI_ENTRY("%llx, 0x%zx", memory, pages);
349 r = efi_free_pages(memory, pages);
354 * efi_get_memory_map_ext() - get map describing memory usage
355 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
356 * on exit the size of the copied memory map
357 * @memory_map: buffer to which the memory map is written
358 * @map_key: key for the memory map
359 * @descriptor_size: size of an individual memory descriptor
360 * @descriptor_version: version number of the memory descriptor structure
362 * This function implements the GetMemoryMap service.
364 * See the Unified Extensible Firmware Interface (UEFI) specification for
367 * Return: status code
369 static efi_status_t EFIAPI efi_get_memory_map_ext(
370 efi_uintn_t *memory_map_size,
371 struct efi_mem_desc *memory_map,
372 efi_uintn_t *map_key,
373 efi_uintn_t *descriptor_size,
374 uint32_t *descriptor_version)
378 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
379 map_key, descriptor_size, descriptor_version);
380 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
381 descriptor_size, descriptor_version);
386 * efi_allocate_pool_ext() - allocate memory from pool
387 * @pool_type: type of the pool from which memory is to be allocated
388 * @size: number of bytes to be allocated
389 * @buffer: allocated memory
391 * This function implements the AllocatePool service.
393 * See the Unified Extensible Firmware Interface (UEFI) specification for
396 * Return: status code
398 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
404 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
405 r = efi_allocate_pool(pool_type, size, buffer);
410 * efi_free_pool_ext() - free memory from pool
411 * @buffer: start of memory to be freed
413 * This function implements the FreePool service.
415 * See the Unified Extensible Firmware Interface (UEFI) specification for
418 * Return: status code
420 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
424 EFI_ENTRY("%p", buffer);
425 r = efi_free_pool(buffer);
430 * efi_add_handle() - add a new handle to the object list
432 * @handle: handle to be added
434 * The protocols list is initialized. The handle is added to the list of known
437 void efi_add_handle(efi_handle_t handle)
441 INIT_LIST_HEAD(&handle->protocols);
442 list_add_tail(&handle->link, &efi_obj_list);
446 * efi_create_handle() - create handle
447 * @handle: new handle
449 * Return: status code
451 efi_status_t efi_create_handle(efi_handle_t *handle)
453 struct efi_object *obj;
455 obj = calloc(1, sizeof(struct efi_object));
457 return EFI_OUT_OF_RESOURCES;
466 * efi_search_protocol() - find a protocol on a handle.
468 * @protocol_guid: GUID of the protocol
469 * @handler: reference to the protocol
471 * Return: status code
473 efi_status_t efi_search_protocol(const efi_handle_t handle,
474 const efi_guid_t *protocol_guid,
475 struct efi_handler **handler)
477 struct efi_object *efiobj;
478 struct list_head *lhandle;
480 if (!handle || !protocol_guid)
481 return EFI_INVALID_PARAMETER;
482 efiobj = efi_search_obj(handle);
484 return EFI_INVALID_PARAMETER;
485 list_for_each(lhandle, &efiobj->protocols) {
486 struct efi_handler *protocol;
488 protocol = list_entry(lhandle, struct efi_handler, link);
489 if (!guidcmp(protocol->guid, protocol_guid)) {
495 return EFI_NOT_FOUND;
499 * efi_remove_protocol() - delete protocol from a handle
500 * @handle: handle from which the protocol shall be deleted
501 * @protocol: GUID of the protocol to be deleted
502 * @protocol_interface: interface of the protocol implementation
504 * Return: status code
506 efi_status_t efi_remove_protocol(const efi_handle_t handle,
507 const efi_guid_t *protocol,
508 void *protocol_interface)
510 struct efi_handler *handler;
513 ret = efi_search_protocol(handle, protocol, &handler);
514 if (ret != EFI_SUCCESS)
516 if (guidcmp(handler->guid, protocol))
517 return EFI_INVALID_PARAMETER;
518 if (handler->protocol_interface != protocol_interface)
519 return EFI_INVALID_PARAMETER;
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 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1099 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1102 /* Add new protocol */
1103 r = efi_add_protocol(*handle, protocol, protocol_interface);
1109 * efi_get_drivers() - get all drivers associated to a controller
1110 * @handle: handle of the controller
1111 * @protocol: protocol GUID (optional)
1112 * @number_of_drivers: number of child controllers
1113 * @driver_handle_buffer: handles of the the drivers
1115 * The allocated buffer has to be freed with free().
1117 * Return: status code
1119 static efi_status_t efi_get_drivers(efi_handle_t handle,
1120 const efi_guid_t *protocol,
1121 efi_uintn_t *number_of_drivers,
1122 efi_handle_t **driver_handle_buffer)
1124 struct efi_handler *handler;
1125 struct efi_open_protocol_info_item *item;
1126 efi_uintn_t count = 0, i;
1129 /* Count all driver associations */
1130 list_for_each_entry(handler, &handle->protocols, link) {
1131 if (protocol && guidcmp(handler->guid, protocol))
1133 list_for_each_entry(item, &handler->open_infos, link) {
1134 if (item->info.attributes &
1135 EFI_OPEN_PROTOCOL_BY_DRIVER)
1140 * Create buffer. In case of duplicate driver assignments the buffer
1141 * will be too large. But that does not harm.
1143 *number_of_drivers = 0;
1144 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1145 if (!*driver_handle_buffer)
1146 return EFI_OUT_OF_RESOURCES;
1147 /* Collect unique driver handles */
1148 list_for_each_entry(handler, &handle->protocols, link) {
1149 if (protocol && guidcmp(handler->guid, protocol))
1151 list_for_each_entry(item, &handler->open_infos, link) {
1152 if (item->info.attributes &
1153 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1154 /* Check this is a new driver */
1156 for (i = 0; i < *number_of_drivers; ++i) {
1157 if ((*driver_handle_buffer)[i] ==
1158 item->info.agent_handle)
1161 /* Copy handle to buffer */
1163 i = (*number_of_drivers)++;
1164 (*driver_handle_buffer)[i] =
1165 item->info.agent_handle;
1174 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1175 * @handle: handle of the controller
1176 * @protocol: protocol GUID (optional)
1177 * @child_handle: handle of the child to destroy
1179 * This function implements the DisconnectController service.
1181 * See the Unified Extensible Firmware Interface (UEFI) specification for
1184 * Return: status code
1186 static efi_status_t efi_disconnect_all_drivers
1187 (efi_handle_t handle,
1188 const efi_guid_t *protocol,
1189 efi_handle_t child_handle)
1191 efi_uintn_t number_of_drivers;
1192 efi_handle_t *driver_handle_buffer;
1193 efi_status_t r, ret;
1195 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1196 &driver_handle_buffer);
1197 if (ret != EFI_SUCCESS)
1200 ret = EFI_NOT_FOUND;
1201 while (number_of_drivers) {
1202 r = EFI_CALL(efi_disconnect_controller(
1204 driver_handle_buffer[--number_of_drivers],
1206 if (r == EFI_SUCCESS)
1209 free(driver_handle_buffer);
1214 * efi_uninstall_protocol() - uninstall protocol interface
1216 * @handle: handle from which the protocol shall be removed
1217 * @protocol: GUID of the protocol to be removed
1218 * @protocol_interface: interface to be removed
1220 * This function DOES NOT delete a handle without installed protocol.
1222 * Return: status code
1224 static efi_status_t efi_uninstall_protocol
1225 (efi_handle_t handle, const efi_guid_t *protocol,
1226 void *protocol_interface)
1228 struct efi_object *efiobj;
1229 struct efi_handler *handler;
1230 struct efi_open_protocol_info_item *item;
1231 struct efi_open_protocol_info_item *pos;
1235 efiobj = efi_search_obj(handle);
1237 r = EFI_INVALID_PARAMETER;
1240 /* Find the protocol on the handle */
1241 r = efi_search_protocol(handle, protocol, &handler);
1242 if (r != EFI_SUCCESS)
1244 /* Disconnect controllers */
1245 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1246 if (!list_empty(&handler->open_infos)) {
1247 r = EFI_ACCESS_DENIED;
1250 /* Close protocol */
1251 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1252 if (item->info.attributes ==
1253 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1254 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1255 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1256 list_del(&item->link);
1258 if (!list_empty(&handler->open_infos)) {
1259 r = EFI_ACCESS_DENIED;
1262 r = efi_remove_protocol(handle, protocol, protocol_interface);
1268 * efi_uninstall_protocol_interface() - uninstall protocol interface
1269 * @handle: handle from which the protocol shall be removed
1270 * @protocol: GUID of the protocol to be removed
1271 * @protocol_interface: interface to be removed
1273 * This function implements the UninstallProtocolInterface service.
1275 * See the Unified Extensible Firmware Interface (UEFI) specification for
1278 * Return: status code
1280 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1281 (efi_handle_t handle, const efi_guid_t *protocol,
1282 void *protocol_interface)
1286 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1288 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1289 if (ret != EFI_SUCCESS)
1292 /* If the last protocol has been removed, delete the handle. */
1293 if (list_empty(&handle->protocols)) {
1294 list_del(&handle->link);
1298 return EFI_EXIT(ret);
1302 * efi_register_protocol_notify() - register an event for notification when a
1303 * protocol is installed.
1304 * @protocol: GUID of the protocol whose installation shall be notified
1305 * @event: event to be signaled upon installation of the protocol
1306 * @registration: key for retrieving the registration information
1308 * This function implements the RegisterProtocolNotify service.
1309 * See the Unified Extensible Firmware Interface (UEFI) specification
1312 * Return: status code
1314 static efi_status_t EFIAPI efi_register_protocol_notify(
1315 const efi_guid_t *protocol,
1316 struct efi_event *event,
1317 void **registration)
1319 struct efi_register_notify_event *item;
1320 efi_status_t ret = EFI_SUCCESS;
1322 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1324 if (!protocol || !event || !registration) {
1325 ret = EFI_INVALID_PARAMETER;
1329 item = calloc(1, sizeof(struct efi_register_notify_event));
1331 ret = EFI_OUT_OF_RESOURCES;
1335 item->event = event;
1336 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1338 list_add_tail(&item->link, &efi_register_notify_events);
1340 *registration = item;
1342 return EFI_EXIT(ret);
1346 * efi_search() - determine if an EFI handle implements a protocol
1347 * @search_type: selection criterion
1348 * @protocol: GUID of the protocol
1349 * @search_key: registration key
1352 * See the documentation of the LocateHandle service in the UEFI specification.
1354 * Return: 0 if the handle implements the protocol
1356 static int efi_search(enum efi_locate_search_type search_type,
1357 const efi_guid_t *protocol, efi_handle_t handle)
1361 switch (search_type) {
1364 case BY_REGISTER_NOTIFY:
1366 ret = efi_search_protocol(handle, protocol, NULL);
1367 return (ret != EFI_SUCCESS);
1369 /* Invalid search type */
1375 * efi_locate_handle() - locate handles implementing a protocol
1377 * @search_type: selection criterion
1378 * @protocol: GUID of the protocol
1379 * @search_key: registration key
1380 * @buffer_size: size of the buffer to receive the handles in bytes
1381 * @buffer: buffer to receive the relevant handles
1383 * This function is meant for U-Boot internal calls. For the API implementation
1384 * of the LocateHandle service see efi_locate_handle_ext.
1386 * Return: status code
1388 static efi_status_t efi_locate_handle(
1389 enum efi_locate_search_type search_type,
1390 const efi_guid_t *protocol, void *search_key,
1391 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1393 struct efi_object *efiobj;
1394 efi_uintn_t size = 0;
1395 struct efi_register_notify_event *item, *event = NULL;
1397 /* Check parameters */
1398 switch (search_type) {
1401 case BY_REGISTER_NOTIFY:
1403 return EFI_INVALID_PARAMETER;
1404 /* Check that the registration key is valid */
1405 list_for_each_entry(item, &efi_register_notify_events, link) {
1407 (struct efi_register_notify_event *)search_key) {
1413 return EFI_INVALID_PARAMETER;
1415 protocol = &event->protocol;
1419 return EFI_INVALID_PARAMETER;
1422 return EFI_INVALID_PARAMETER;
1425 /* Count how much space we need */
1426 list_for_each_entry(efiobj, &efi_obj_list, link) {
1427 if (!efi_search(search_type, protocol, efiobj))
1428 size += sizeof(void *);
1432 return EFI_NOT_FOUND;
1435 return EFI_INVALID_PARAMETER;
1437 if (*buffer_size < size) {
1438 *buffer_size = size;
1439 return EFI_BUFFER_TOO_SMALL;
1442 *buffer_size = size;
1444 /* The buffer size is sufficient but there is not buffer */
1446 return EFI_INVALID_PARAMETER;
1448 /* Then fill the array */
1449 list_for_each_entry(efiobj, &efi_obj_list, link) {
1450 if (!efi_search(search_type, protocol, efiobj))
1458 * efi_locate_handle_ext() - locate handles implementing a protocol.
1459 * @search_type: selection criterion
1460 * @protocol: GUID of the protocol
1461 * @search_key: registration key
1462 * @buffer_size: size of the buffer to receive the handles in bytes
1463 * @buffer: buffer to receive the relevant handles
1465 * This function implements the LocateHandle service.
1467 * See the Unified Extensible Firmware Interface (UEFI) specification for
1470 * Return: 0 if the handle implements the protocol
1472 static efi_status_t EFIAPI efi_locate_handle_ext(
1473 enum efi_locate_search_type search_type,
1474 const efi_guid_t *protocol, void *search_key,
1475 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1477 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1478 buffer_size, buffer);
1480 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1481 buffer_size, buffer));
1485 * efi_remove_configuration_table() - collapses configuration table entries,
1488 * @i: index of the table entry to be removed
1490 static void efi_remove_configuration_table(int i)
1492 struct efi_configuration_table *this = &systab.tables[i];
1493 struct efi_configuration_table *next = &systab.tables[i + 1];
1494 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1496 memmove(this, next, (ulong)end - (ulong)next);
1501 * efi_install_configuration_table() - adds, updates, or removes a
1502 * configuration table
1503 * @guid: GUID of the installed table
1504 * @table: table to be installed
1506 * This function is used for internal calls. For the API implementation of the
1507 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1509 * Return: status code
1511 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1514 struct efi_event *evt;
1518 return EFI_INVALID_PARAMETER;
1520 /* Check for GUID override */
1521 for (i = 0; i < systab.nr_tables; i++) {
1522 if (!guidcmp(guid, &systab.tables[i].guid)) {
1524 systab.tables[i].table = table;
1526 efi_remove_configuration_table(i);
1532 return EFI_NOT_FOUND;
1534 /* No override, check for overflow */
1535 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1536 return EFI_OUT_OF_RESOURCES;
1538 /* Add a new entry */
1539 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1540 systab.tables[i].table = table;
1541 systab.nr_tables = i + 1;
1544 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1545 efi_update_table_header_crc32(&systab.hdr);
1547 /* Notify that the configuration table was changed */
1548 list_for_each_entry(evt, &efi_events, link) {
1549 if (evt->group && !guidcmp(evt->group, guid)) {
1550 efi_signal_event(evt, false);
1559 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1560 * configuration table.
1561 * @guid: GUID of the installed table
1562 * @table: table to be installed
1564 * This function implements the InstallConfigurationTable service.
1566 * See the Unified Extensible Firmware Interface (UEFI) specification for
1569 * Return: status code
1571 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1574 EFI_ENTRY("%pUl, %p", guid, table);
1575 return EFI_EXIT(efi_install_configuration_table(guid, table));
1579 * efi_setup_loaded_image() - initialize a loaded image
1581 * Initialize a loaded_image_info and loaded_image_info object with correct
1582 * protocols, boot-device, etc.
1584 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1587 * @device_path: device path of the loaded image
1588 * @file_path: file path of the loaded image
1589 * @handle_ptr: handle of the loaded image
1590 * @info_ptr: loaded image protocol
1591 * Return: status code
1593 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1594 struct efi_device_path *file_path,
1595 struct efi_loaded_image_obj **handle_ptr,
1596 struct efi_loaded_image **info_ptr)
1599 struct efi_loaded_image *info = NULL;
1600 struct efi_loaded_image_obj *obj = NULL;
1601 struct efi_device_path *dp;
1603 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1607 info = calloc(1, sizeof(*info));
1609 return EFI_OUT_OF_RESOURCES;
1610 obj = calloc(1, sizeof(*obj));
1613 return EFI_OUT_OF_RESOURCES;
1615 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1617 /* Add internal object to object list */
1618 efi_add_handle(&obj->header);
1620 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1621 info->file_path = file_path;
1622 info->system_table = &systab;
1625 info->device_handle = efi_dp_find_obj(device_path, NULL);
1627 dp = efi_dp_append(device_path, file_path);
1629 ret = EFI_OUT_OF_RESOURCES;
1635 ret = efi_add_protocol(&obj->header,
1636 &efi_guid_loaded_image_device_path, dp);
1637 if (ret != EFI_SUCCESS)
1641 * When asking for the loaded_image interface, just
1642 * return handle which points to loaded_image_info
1644 ret = efi_add_protocol(&obj->header,
1645 &efi_guid_loaded_image, info);
1646 if (ret != EFI_SUCCESS)
1654 printf("ERROR: Failure to install protocols for loaded image\n");
1655 efi_delete_handle(&obj->header);
1661 * efi_load_image_from_path() - load an image using a file path
1663 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1664 * callers obligation to update the memory type as needed.
1666 * @file_path: the path of the image to load
1667 * @buffer: buffer containing the loaded image
1668 * @size: size of the loaded image
1669 * Return: status code
1672 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1673 void **buffer, efi_uintn_t *size)
1675 struct efi_file_info *info = NULL;
1676 struct efi_file_handle *f;
1677 static efi_status_t ret;
1681 /* In case of failure nothing is returned */
1686 f = efi_file_from_path(file_path);
1688 return EFI_DEVICE_ERROR;
1692 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1694 if (ret != EFI_BUFFER_TOO_SMALL) {
1695 ret = EFI_DEVICE_ERROR;
1700 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1702 if (ret != EFI_SUCCESS)
1706 * When reading the file we do not yet know if it contains an
1707 * application, a boottime driver, or a runtime driver. So here we
1708 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1709 * update the reservation according to the image type.
1711 bs = info->file_size;
1712 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1713 EFI_BOOT_SERVICES_DATA,
1714 efi_size_in_pages(bs), &addr);
1715 if (ret != EFI_SUCCESS) {
1716 ret = EFI_OUT_OF_RESOURCES;
1721 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1722 if (ret != EFI_SUCCESS)
1723 efi_free_pages(addr, efi_size_in_pages(bs));
1724 *buffer = (void *)(uintptr_t)addr;
1727 EFI_CALL(f->close(f));
1733 * efi_load_image() - load an EFI image into memory
1734 * @boot_policy: true for request originating from the boot manager
1735 * @parent_image: the caller's image handle
1736 * @file_path: the path of the image to load
1737 * @source_buffer: memory location from which the image is installed
1738 * @source_size: size of the memory area from which the image is installed
1739 * @image_handle: handle for the newly installed image
1741 * This function implements the LoadImage service.
1743 * See the Unified Extensible Firmware Interface (UEFI) specification
1746 * Return: status code
1748 efi_status_t EFIAPI efi_load_image(bool boot_policy,
1749 efi_handle_t parent_image,
1750 struct efi_device_path *file_path,
1751 void *source_buffer,
1752 efi_uintn_t source_size,
1753 efi_handle_t *image_handle)
1755 struct efi_device_path *dp, *fp;
1756 struct efi_loaded_image *info = NULL;
1757 struct efi_loaded_image_obj **image_obj =
1758 (struct efi_loaded_image_obj **)image_handle;
1762 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1763 file_path, source_buffer, source_size, image_handle);
1765 if (!image_handle || !parent_image) {
1766 ret = EFI_INVALID_PARAMETER;
1770 if (!source_buffer && !file_path) {
1771 ret = EFI_NOT_FOUND;
1775 if (!source_buffer) {
1776 ret = efi_load_image_from_path(file_path, &dest_buffer,
1778 if (ret != EFI_SUCCESS)
1781 dest_buffer = source_buffer;
1783 /* split file_path which contains both the device and file parts */
1784 efi_dp_split_file_path(file_path, &dp, &fp);
1785 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
1786 if (ret == EFI_SUCCESS)
1787 ret = efi_load_pe(*image_obj, dest_buffer, info);
1789 /* Release buffer to which file was loaded */
1790 efi_free_pages((uintptr_t)dest_buffer,
1791 efi_size_in_pages(source_size));
1792 if (ret == EFI_SUCCESS) {
1793 info->system_table = &systab;
1794 info->parent_handle = parent_image;
1796 /* The image is invalid. Release all associated resources. */
1797 efi_delete_handle(*image_handle);
1798 *image_handle = NULL;
1802 return EFI_EXIT(ret);
1806 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1808 static void efi_exit_caches(void)
1810 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1812 * Grub on 32bit ARM needs to have caches disabled before jumping into
1813 * a zImage, but does not know of all cache layers. Give it a hand.
1815 if (efi_is_direct_boot)
1816 cleanup_before_linux();
1821 * efi_exit_boot_services() - stop all boot services
1822 * @image_handle: handle of the loaded image
1823 * @map_key: key of the memory map
1825 * This function implements the ExitBootServices service.
1827 * See the Unified Extensible Firmware Interface (UEFI) specification
1830 * All timer events are disabled. For exit boot services events the
1831 * notification function is called. The boot services are disabled in the
1834 * Return: status code
1836 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1837 unsigned long map_key)
1839 struct efi_event *evt;
1841 EFI_ENTRY("%p, %ld", image_handle, map_key);
1843 /* Check that the caller has read the current memory map */
1844 if (map_key != efi_memory_map_key)
1845 return EFI_INVALID_PARAMETER;
1847 /* Make sure that notification functions are not called anymore */
1848 efi_tpl = TPL_HIGH_LEVEL;
1850 /* Check if ExitBootServices has already been called */
1851 if (!systab.boottime)
1852 return EFI_EXIT(EFI_SUCCESS);
1854 /* Add related events to the event group */
1855 list_for_each_entry(evt, &efi_events, link) {
1856 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1857 evt->group = &efi_guid_event_group_exit_boot_services;
1859 /* Notify that ExitBootServices is invoked. */
1860 list_for_each_entry(evt, &efi_events, link) {
1862 !guidcmp(evt->group,
1863 &efi_guid_event_group_exit_boot_services)) {
1864 efi_signal_event(evt, false);
1869 /* TODO: Should persist EFI variables here */
1871 board_quiesce_devices();
1873 /* Fix up caches for EFI payloads if necessary */
1876 /* This stops all lingering devices */
1877 bootm_disable_interrupts();
1879 /* Disable boot time services */
1880 systab.con_in_handle = NULL;
1881 systab.con_in = NULL;
1882 systab.con_out_handle = NULL;
1883 systab.con_out = NULL;
1884 systab.stderr_handle = NULL;
1885 systab.std_err = NULL;
1886 systab.boottime = NULL;
1888 /* Recalculate CRC32 */
1889 efi_update_table_header_crc32(&systab.hdr);
1891 /* Give the payload some time to boot */
1892 efi_set_watchdog(0);
1895 return EFI_EXIT(EFI_SUCCESS);
1899 * efi_get_next_monotonic_count() - get next value of the counter
1900 * @count: returned value of the counter
1902 * This function implements the NextMonotonicCount service.
1904 * See the Unified Extensible Firmware Interface (UEFI) specification for
1907 * Return: status code
1909 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1911 static uint64_t mono;
1913 EFI_ENTRY("%p", count);
1915 return EFI_EXIT(EFI_SUCCESS);
1919 * efi_stall() - sleep
1920 * @microseconds: period to sleep in microseconds
1922 * This function implements the Stall service.
1924 * See the Unified Extensible Firmware Interface (UEFI) specification for
1927 * Return: status code
1929 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1931 EFI_ENTRY("%ld", microseconds);
1932 udelay(microseconds);
1933 return EFI_EXIT(EFI_SUCCESS);
1937 * efi_set_watchdog_timer() - reset the watchdog timer
1938 * @timeout: seconds before reset by watchdog
1939 * @watchdog_code: code to be logged when resetting
1940 * @data_size: size of buffer in bytes
1941 * @watchdog_data: buffer with data describing the reset reason
1943 * This function implements the SetWatchdogTimer service.
1945 * See the Unified Extensible Firmware Interface (UEFI) specification for
1948 * Return: status code
1950 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1951 uint64_t watchdog_code,
1952 unsigned long data_size,
1953 uint16_t *watchdog_data)
1955 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
1956 data_size, watchdog_data);
1957 return EFI_EXIT(efi_set_watchdog(timeout));
1961 * efi_close_protocol() - close a protocol
1962 * @handle: handle on which the protocol shall be closed
1963 * @protocol: GUID of the protocol to close
1964 * @agent_handle: handle of the driver
1965 * @controller_handle: handle of the controller
1967 * This function implements the CloseProtocol service.
1969 * See the Unified Extensible Firmware Interface (UEFI) specification for
1972 * Return: status code
1974 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1975 const efi_guid_t *protocol,
1976 efi_handle_t agent_handle,
1977 efi_handle_t controller_handle)
1979 struct efi_handler *handler;
1980 struct efi_open_protocol_info_item *item;
1981 struct efi_open_protocol_info_item *pos;
1984 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1987 if (!efi_search_obj(agent_handle) ||
1988 (controller_handle && !efi_search_obj(controller_handle))) {
1989 r = EFI_INVALID_PARAMETER;
1992 r = efi_search_protocol(handle, protocol, &handler);
1993 if (r != EFI_SUCCESS)
1997 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1998 if (item->info.agent_handle == agent_handle &&
1999 item->info.controller_handle == controller_handle) {
2000 efi_delete_open_info(item);
2010 * efi_open_protocol_information() - provide information about then open status
2011 * of a protocol on a handle
2012 * @handle: handle for which the information shall be retrieved
2013 * @protocol: GUID of the protocol
2014 * @entry_buffer: buffer to receive the open protocol information
2015 * @entry_count: number of entries available in the buffer
2017 * This function implements the OpenProtocolInformation service.
2019 * See the Unified Extensible Firmware Interface (UEFI) specification for
2022 * Return: status code
2024 static efi_status_t EFIAPI efi_open_protocol_information(
2025 efi_handle_t handle, const efi_guid_t *protocol,
2026 struct efi_open_protocol_info_entry **entry_buffer,
2027 efi_uintn_t *entry_count)
2029 unsigned long buffer_size;
2030 unsigned long count;
2031 struct efi_handler *handler;
2032 struct efi_open_protocol_info_item *item;
2035 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2038 /* Check parameters */
2039 if (!entry_buffer) {
2040 r = EFI_INVALID_PARAMETER;
2043 r = efi_search_protocol(handle, protocol, &handler);
2044 if (r != EFI_SUCCESS)
2049 list_for_each_entry(item, &handler->open_infos, link) {
2050 if (item->info.open_count)
2053 *entry_count = count;
2054 *entry_buffer = NULL;
2061 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2062 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2063 (void **)entry_buffer);
2064 if (r != EFI_SUCCESS)
2066 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2067 if (item->info.open_count)
2068 (*entry_buffer)[--count] = item->info;
2075 * efi_protocols_per_handle() - get protocols installed on a handle
2076 * @handle: handle for which the information is retrieved
2077 * @protocol_buffer: buffer with protocol GUIDs
2078 * @protocol_buffer_count: number of entries in the buffer
2080 * This function implements the ProtocolsPerHandleService.
2082 * See the Unified Extensible Firmware Interface (UEFI) specification for
2085 * Return: status code
2087 static efi_status_t EFIAPI efi_protocols_per_handle(
2088 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2089 efi_uintn_t *protocol_buffer_count)
2091 unsigned long buffer_size;
2092 struct efi_object *efiobj;
2093 struct list_head *protocol_handle;
2096 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2097 protocol_buffer_count);
2099 if (!handle || !protocol_buffer || !protocol_buffer_count)
2100 return EFI_EXIT(EFI_INVALID_PARAMETER);
2102 *protocol_buffer = NULL;
2103 *protocol_buffer_count = 0;
2105 efiobj = efi_search_obj(handle);
2107 return EFI_EXIT(EFI_INVALID_PARAMETER);
2109 /* Count protocols */
2110 list_for_each(protocol_handle, &efiobj->protocols) {
2111 ++*protocol_buffer_count;
2115 if (*protocol_buffer_count) {
2118 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2119 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2120 (void **)protocol_buffer);
2121 if (r != EFI_SUCCESS)
2123 list_for_each(protocol_handle, &efiobj->protocols) {
2124 struct efi_handler *protocol;
2126 protocol = list_entry(protocol_handle,
2127 struct efi_handler, link);
2128 (*protocol_buffer)[j] = (void *)protocol->guid;
2133 return EFI_EXIT(EFI_SUCCESS);
2137 * efi_locate_handle_buffer() - locate handles implementing a protocol
2138 * @search_type: selection criterion
2139 * @protocol: GUID of the protocol
2140 * @search_key: registration key
2141 * @no_handles: number of returned handles
2142 * @buffer: buffer with the returned handles
2144 * This function implements the LocateHandleBuffer service.
2146 * See the Unified Extensible Firmware Interface (UEFI) specification for
2149 * Return: status code
2151 static efi_status_t EFIAPI efi_locate_handle_buffer(
2152 enum efi_locate_search_type search_type,
2153 const efi_guid_t *protocol, void *search_key,
2154 efi_uintn_t *no_handles, efi_handle_t **buffer)
2157 efi_uintn_t buffer_size = 0;
2159 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2160 no_handles, buffer);
2162 if (!no_handles || !buffer) {
2163 r = EFI_INVALID_PARAMETER;
2168 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2170 if (r != EFI_BUFFER_TOO_SMALL)
2172 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2174 if (r != EFI_SUCCESS)
2176 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2178 if (r == EFI_SUCCESS)
2179 *no_handles = buffer_size / sizeof(efi_handle_t);
2185 * efi_locate_protocol() - find an interface implementing a protocol
2186 * @protocol: GUID of the protocol
2187 * @registration: registration key passed to the notification function
2188 * @protocol_interface: interface implementing the protocol
2190 * This function implements the LocateProtocol service.
2192 * See the Unified Extensible Firmware Interface (UEFI) specification for
2195 * Return: status code
2197 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2199 void **protocol_interface)
2201 struct list_head *lhandle;
2204 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2206 if (!protocol || !protocol_interface)
2207 return EFI_EXIT(EFI_INVALID_PARAMETER);
2209 list_for_each(lhandle, &efi_obj_list) {
2210 struct efi_object *efiobj;
2211 struct efi_handler *handler;
2213 efiobj = list_entry(lhandle, struct efi_object, link);
2215 ret = efi_search_protocol(efiobj, protocol, &handler);
2216 if (ret == EFI_SUCCESS) {
2217 *protocol_interface = handler->protocol_interface;
2218 return EFI_EXIT(EFI_SUCCESS);
2221 *protocol_interface = NULL;
2223 return EFI_EXIT(EFI_NOT_FOUND);
2227 * efi_locate_device_path() - Get the device path and handle of an device
2228 * implementing a protocol
2229 * @protocol: GUID of the protocol
2230 * @device_path: device path
2231 * @device: handle of the device
2233 * This function implements the LocateDevicePath service.
2235 * See the Unified Extensible Firmware Interface (UEFI) specification for
2238 * Return: status code
2240 static efi_status_t EFIAPI efi_locate_device_path(
2241 const efi_guid_t *protocol,
2242 struct efi_device_path **device_path,
2243 efi_handle_t *device)
2245 struct efi_device_path *dp;
2247 struct efi_handler *handler;
2248 efi_handle_t *handles;
2250 size_t len_best = 0;
2251 efi_uintn_t no_handles;
2255 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2257 if (!protocol || !device_path || !*device_path || !device) {
2258 ret = EFI_INVALID_PARAMETER;
2262 /* Find end of device path */
2263 len = efi_dp_instance_size(*device_path);
2265 /* Get all handles implementing the protocol */
2266 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2267 &no_handles, &handles));
2268 if (ret != EFI_SUCCESS)
2271 for (i = 0; i < no_handles; ++i) {
2272 /* Find the device path protocol */
2273 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2275 if (ret != EFI_SUCCESS)
2277 dp = (struct efi_device_path *)handler->protocol_interface;
2278 len_dp = efi_dp_instance_size(dp);
2280 * This handle can only be a better fit
2281 * if its device path length is longer than the best fit and
2282 * if its device path length is shorter of equal the searched
2285 if (len_dp <= len_best || len_dp > len)
2287 /* Check if dp is a subpath of device_path */
2288 if (memcmp(*device_path, dp, len_dp))
2290 *device = handles[i];
2294 remainder = (u8 *)*device_path + len_best;
2295 *device_path = (struct efi_device_path *)remainder;
2298 ret = EFI_NOT_FOUND;
2301 return EFI_EXIT(ret);
2305 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2307 * @handle: handle on which the protocol interfaces shall be installed
2308 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2311 * This function implements the MultipleProtocolInterfaces service.
2313 * See the Unified Extensible Firmware Interface (UEFI) specification for
2316 * Return: status code
2318 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2319 (efi_handle_t *handle, ...)
2321 EFI_ENTRY("%p", handle);
2324 const efi_guid_t *protocol;
2325 void *protocol_interface;
2326 efi_status_t r = EFI_SUCCESS;
2330 return EFI_EXIT(EFI_INVALID_PARAMETER);
2332 efi_va_start(argptr, handle);
2334 protocol = efi_va_arg(argptr, efi_guid_t*);
2337 protocol_interface = efi_va_arg(argptr, void*);
2338 r = EFI_CALL(efi_install_protocol_interface(
2340 EFI_NATIVE_INTERFACE,
2341 protocol_interface));
2342 if (r != EFI_SUCCESS)
2347 if (r == EFI_SUCCESS)
2350 /* If an error occurred undo all changes. */
2351 efi_va_start(argptr, handle);
2353 protocol = efi_va_arg(argptr, efi_guid_t*);
2354 protocol_interface = efi_va_arg(argptr, void*);
2355 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2356 protocol_interface));
2364 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2366 * @handle: handle from which the protocol interfaces shall be removed
2367 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2370 * This function implements the UninstallMultipleProtocolInterfaces service.
2372 * See the Unified Extensible Firmware Interface (UEFI) specification for
2375 * Return: status code
2377 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2378 efi_handle_t handle, ...)
2380 EFI_ENTRY("%p", handle);
2383 const efi_guid_t *protocol;
2384 void *protocol_interface;
2385 efi_status_t r = EFI_SUCCESS;
2389 return EFI_EXIT(EFI_INVALID_PARAMETER);
2391 efi_va_start(argptr, handle);
2393 protocol = efi_va_arg(argptr, efi_guid_t*);
2396 protocol_interface = efi_va_arg(argptr, void*);
2397 r = efi_uninstall_protocol(handle, protocol,
2398 protocol_interface);
2399 if (r != EFI_SUCCESS)
2404 if (r == EFI_SUCCESS) {
2405 /* If the last protocol has been removed, delete the handle. */
2406 if (list_empty(&handle->protocols)) {
2407 list_del(&handle->link);
2413 /* If an error occurred undo all changes. */
2414 efi_va_start(argptr, handle);
2416 protocol = efi_va_arg(argptr, efi_guid_t*);
2417 protocol_interface = efi_va_arg(argptr, void*);
2418 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2419 EFI_NATIVE_INTERFACE,
2420 protocol_interface));
2424 /* In case of an error always return EFI_INVALID_PARAMETER */
2425 return EFI_EXIT(EFI_INVALID_PARAMETER);
2429 * efi_calculate_crc32() - calculate cyclic redundancy code
2430 * @data: buffer with data
2431 * @data_size: size of buffer in bytes
2432 * @crc32_p: cyclic redundancy code
2434 * This function implements the CalculateCrc32 service.
2436 * See the Unified Extensible Firmware Interface (UEFI) specification for
2439 * Return: status code
2441 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2442 efi_uintn_t data_size,
2445 EFI_ENTRY("%p, %zu", data, data_size);
2446 *crc32_p = crc32(0, data, data_size);
2447 return EFI_EXIT(EFI_SUCCESS);
2451 * efi_copy_mem() - copy memory
2452 * @destination: destination of the copy operation
2453 * @source: source of the copy operation
2454 * @length: number of bytes to copy
2456 * This function implements the CopyMem service.
2458 * See the Unified Extensible Firmware Interface (UEFI) specification for
2461 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2464 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2465 memmove(destination, source, length);
2466 EFI_EXIT(EFI_SUCCESS);
2470 * efi_set_mem() - Fill memory with a byte value.
2471 * @buffer: buffer to fill
2472 * @size: size of buffer in bytes
2473 * @value: byte to copy to the buffer
2475 * This function implements the SetMem service.
2477 * See the Unified Extensible Firmware Interface (UEFI) specification for
2480 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2482 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2483 memset(buffer, value, size);
2484 EFI_EXIT(EFI_SUCCESS);
2488 * efi_protocol_open() - open protocol interface on a handle
2489 * @handler: handler of a protocol
2490 * @protocol_interface: interface implementing the protocol
2491 * @agent_handle: handle of the driver
2492 * @controller_handle: handle of the controller
2493 * @attributes: attributes indicating how to open the protocol
2495 * Return: status code
2497 static efi_status_t efi_protocol_open(
2498 struct efi_handler *handler,
2499 void **protocol_interface, void *agent_handle,
2500 void *controller_handle, uint32_t attributes)
2502 struct efi_open_protocol_info_item *item;
2503 struct efi_open_protocol_info_entry *match = NULL;
2504 bool opened_by_driver = false;
2505 bool opened_exclusive = false;
2507 /* If there is no agent, only return the interface */
2511 /* For TEST_PROTOCOL ignore interface attribute */
2512 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2513 *protocol_interface = NULL;
2516 * Check if the protocol is already opened by a driver with the same
2517 * attributes or opened exclusively
2519 list_for_each_entry(item, &handler->open_infos, link) {
2520 if (item->info.agent_handle == agent_handle) {
2521 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2522 (item->info.attributes == attributes))
2523 return EFI_ALREADY_STARTED;
2525 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2526 opened_exclusive = true;
2529 /* Only one controller can open the protocol exclusively */
2530 if (opened_exclusive && attributes &
2531 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2532 return EFI_ACCESS_DENIED;
2534 /* Prepare exclusive opening */
2535 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2536 /* Try to disconnect controllers */
2537 list_for_each_entry(item, &handler->open_infos, link) {
2538 if (item->info.attributes ==
2539 EFI_OPEN_PROTOCOL_BY_DRIVER)
2540 EFI_CALL(efi_disconnect_controller(
2541 item->info.controller_handle,
2542 item->info.agent_handle,
2545 opened_by_driver = false;
2546 /* Check if all controllers are disconnected */
2547 list_for_each_entry(item, &handler->open_infos, link) {
2548 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2549 opened_by_driver = true;
2551 /* Only one controller can be connected */
2552 if (opened_by_driver)
2553 return EFI_ACCESS_DENIED;
2556 /* Find existing entry */
2557 list_for_each_entry(item, &handler->open_infos, link) {
2558 if (item->info.agent_handle == agent_handle &&
2559 item->info.controller_handle == controller_handle)
2560 match = &item->info;
2562 /* None found, create one */
2564 match = efi_create_open_info(handler);
2566 return EFI_OUT_OF_RESOURCES;
2569 match->agent_handle = agent_handle;
2570 match->controller_handle = controller_handle;
2571 match->attributes = attributes;
2572 match->open_count++;
2575 /* For TEST_PROTOCOL ignore interface attribute. */
2576 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2577 *protocol_interface = handler->protocol_interface;
2583 * efi_open_protocol() - open protocol interface on a handle
2584 * @handle: handle on which the protocol shall be opened
2585 * @protocol: GUID of the protocol
2586 * @protocol_interface: interface implementing the protocol
2587 * @agent_handle: handle of the driver
2588 * @controller_handle: handle of the controller
2589 * @attributes: attributes indicating how to open the protocol
2591 * This function implements the OpenProtocol interface.
2593 * See the Unified Extensible Firmware Interface (UEFI) specification for
2596 * Return: status code
2598 static efi_status_t EFIAPI efi_open_protocol
2599 (efi_handle_t handle, const efi_guid_t *protocol,
2600 void **protocol_interface, efi_handle_t agent_handle,
2601 efi_handle_t controller_handle, uint32_t attributes)
2603 struct efi_handler *handler;
2604 efi_status_t r = EFI_INVALID_PARAMETER;
2606 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2607 protocol_interface, agent_handle, controller_handle,
2610 if (!handle || !protocol ||
2611 (!protocol_interface && attributes !=
2612 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2616 switch (attributes) {
2617 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2618 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2619 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2621 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2622 if (controller_handle == handle)
2625 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2626 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2627 /* Check that the controller handle is valid */
2628 if (!efi_search_obj(controller_handle))
2631 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2632 /* Check that the agent handle is valid */
2633 if (!efi_search_obj(agent_handle))
2640 r = efi_search_protocol(handle, protocol, &handler);
2641 if (r != EFI_SUCCESS)
2644 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2645 controller_handle, attributes);
2651 * efi_start_image() - call the entry point of an image
2652 * @image_handle: handle of the image
2653 * @exit_data_size: size of the buffer
2654 * @exit_data: buffer to receive the exit data of the called image
2656 * This function implements the StartImage service.
2658 * See the Unified Extensible Firmware Interface (UEFI) specification for
2661 * Return: status code
2663 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2664 efi_uintn_t *exit_data_size,
2667 struct efi_loaded_image_obj *image_obj =
2668 (struct efi_loaded_image_obj *)image_handle;
2671 efi_handle_t parent_image = current_image;
2673 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2675 /* Check parameters */
2676 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2678 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2679 if (ret != EFI_SUCCESS)
2680 return EFI_EXIT(EFI_INVALID_PARAMETER);
2682 efi_is_direct_boot = false;
2684 image_obj->exit_data_size = exit_data_size;
2685 image_obj->exit_data = exit_data;
2687 /* call the image! */
2688 if (setjmp(&image_obj->exit_jmp)) {
2690 * We called the entry point of the child image with EFI_CALL
2691 * in the lines below. The child image called the Exit() boot
2692 * service efi_exit() which executed the long jump that brought
2693 * us to the current line. This implies that the second half
2694 * of the EFI_CALL macro has not been executed.
2698 * efi_exit() called efi_restore_gd(). We have to undo this
2699 * otherwise __efi_entry_check() will put the wrong value into
2705 * To get ready to call EFI_EXIT below we have to execute the
2706 * missed out steps of EFI_CALL.
2708 assert(__efi_entry_check());
2709 debug("%sEFI: %lu returned by started image\n",
2710 __efi_nesting_dec(),
2711 (unsigned long)((uintptr_t)image_obj->exit_status &
2713 current_image = parent_image;
2714 return EFI_EXIT(image_obj->exit_status);
2717 current_image = image_handle;
2718 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
2719 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
2720 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2723 * Usually UEFI applications call Exit() instead of returning.
2724 * But because the world doesn't consist of ponies and unicorns,
2725 * we're happy to emulate that behavior on behalf of a payload
2728 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2732 * efi_delete_image() - delete loaded image from memory)
2734 * @image_obj: handle of the loaded image
2735 * @loaded_image_protocol: loaded image protocol
2737 static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2738 struct efi_loaded_image *loaded_image_protocol)
2740 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2741 efi_size_in_pages(loaded_image_protocol->image_size));
2742 efi_delete_handle(&image_obj->header);
2746 * efi_unload_image() - unload an EFI image
2747 * @image_handle: handle of the image to be unloaded
2749 * This function implements the UnloadImage service.
2751 * See the Unified Extensible Firmware Interface (UEFI) specification for
2754 * Return: status code
2756 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2758 efi_status_t ret = EFI_SUCCESS;
2759 struct efi_object *efiobj;
2760 struct efi_loaded_image *loaded_image_protocol;
2762 EFI_ENTRY("%p", image_handle);
2764 efiobj = efi_search_obj(image_handle);
2766 ret = EFI_INVALID_PARAMETER;
2769 /* Find the loaded image protocol */
2770 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2771 (void **)&loaded_image_protocol,
2773 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2774 if (ret != EFI_SUCCESS) {
2775 ret = EFI_INVALID_PARAMETER;
2778 switch (efiobj->type) {
2779 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2780 /* Call the unload function */
2781 if (!loaded_image_protocol->unload) {
2782 ret = EFI_UNSUPPORTED;
2785 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2786 if (ret != EFI_SUCCESS)
2789 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2792 ret = EFI_INVALID_PARAMETER;
2795 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2796 loaded_image_protocol);
2798 return EFI_EXIT(ret);
2802 * efi_update_exit_data() - fill exit data parameters of StartImage()
2804 * @image_obj image handle
2805 * @exit_data_size size of the exit data buffer
2806 * @exit_data buffer with data returned by UEFI payload
2807 * Return: status code
2809 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2810 efi_uintn_t exit_data_size,
2816 * If exit_data is not provided to StartImage(), exit_data_size must be
2819 if (!image_obj->exit_data)
2821 if (image_obj->exit_data_size)
2822 *image_obj->exit_data_size = exit_data_size;
2823 if (exit_data_size && exit_data) {
2824 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2826 (void **)image_obj->exit_data);
2827 if (ret != EFI_SUCCESS)
2829 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2831 image_obj->exit_data = NULL;
2837 * efi_exit() - leave an EFI application or driver
2838 * @image_handle: handle of the application or driver that is exiting
2839 * @exit_status: status code
2840 * @exit_data_size: size of the buffer in bytes
2841 * @exit_data: buffer with data describing an error
2843 * This function implements the Exit service.
2845 * See the Unified Extensible Firmware Interface (UEFI) specification for
2848 * Return: status code
2850 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2851 efi_status_t exit_status,
2852 efi_uintn_t exit_data_size,
2856 * TODO: We should call the unload procedure of the loaded
2860 struct efi_loaded_image *loaded_image_protocol;
2861 struct efi_loaded_image_obj *image_obj =
2862 (struct efi_loaded_image_obj *)image_handle;
2864 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2865 exit_data_size, exit_data);
2867 /* Check parameters */
2868 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2869 (void **)&loaded_image_protocol,
2871 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2872 if (ret != EFI_SUCCESS) {
2873 ret = EFI_INVALID_PARAMETER;
2877 /* Unloading of unstarted images */
2878 switch (image_obj->header.type) {
2879 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2881 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2882 efi_delete_image(image_obj, loaded_image_protocol);
2886 /* Handle does not refer to loaded image */
2887 ret = EFI_INVALID_PARAMETER;
2890 /* A started image can only be unloaded it is the last one started. */
2891 if (image_handle != current_image) {
2892 ret = EFI_INVALID_PARAMETER;
2896 /* Exit data is only foreseen in case of failure. */
2897 if (exit_status != EFI_SUCCESS) {
2898 ret = efi_update_exit_data(image_obj, exit_data_size,
2900 /* Exiting has priority. Don't return error to caller. */
2901 if (ret != EFI_SUCCESS)
2902 EFI_PRINT("%s: out of memory\n", __func__);
2904 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2905 exit_status != EFI_SUCCESS)
2906 efi_delete_image(image_obj, loaded_image_protocol);
2908 /* Make sure entry/exit counts for EFI world cross-overs match */
2909 EFI_EXIT(exit_status);
2912 * But longjmp out with the U-Boot gd, not the application's, as
2913 * the other end is a setjmp call inside EFI context.
2917 image_obj->exit_status = exit_status;
2918 longjmp(&image_obj->exit_jmp, 1);
2920 panic("EFI application exited");
2922 return EFI_EXIT(ret);
2926 * efi_handle_protocol() - get interface of a protocol on a handle
2927 * @handle: handle on which the protocol shall be opened
2928 * @protocol: GUID of the protocol
2929 * @protocol_interface: interface implementing the protocol
2931 * This function implements the HandleProtocol service.
2933 * See the Unified Extensible Firmware Interface (UEFI) specification for
2936 * Return: status code
2938 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2939 const efi_guid_t *protocol,
2940 void **protocol_interface)
2942 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2943 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2947 * efi_bind_controller() - bind a single driver to a controller
2948 * @controller_handle: controller handle
2949 * @driver_image_handle: driver handle
2950 * @remain_device_path: remaining path
2952 * Return: status code
2954 static efi_status_t efi_bind_controller(
2955 efi_handle_t controller_handle,
2956 efi_handle_t driver_image_handle,
2957 struct efi_device_path *remain_device_path)
2959 struct efi_driver_binding_protocol *binding_protocol;
2962 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2963 &efi_guid_driver_binding_protocol,
2964 (void **)&binding_protocol,
2965 driver_image_handle, NULL,
2966 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2967 if (r != EFI_SUCCESS)
2969 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2971 remain_device_path));
2972 if (r == EFI_SUCCESS)
2973 r = EFI_CALL(binding_protocol->start(binding_protocol,
2975 remain_device_path));
2976 EFI_CALL(efi_close_protocol(driver_image_handle,
2977 &efi_guid_driver_binding_protocol,
2978 driver_image_handle, NULL));
2983 * efi_connect_single_controller() - connect a single driver to a controller
2984 * @controller_handle: controller
2985 * @driver_image_handle: driver
2986 * @remain_device_path: remaining path
2988 * Return: status code
2990 static efi_status_t efi_connect_single_controller(
2991 efi_handle_t controller_handle,
2992 efi_handle_t *driver_image_handle,
2993 struct efi_device_path *remain_device_path)
2995 efi_handle_t *buffer;
2999 size_t connected = 0;
3001 /* Get buffer with all handles with driver binding protocol */
3002 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3003 &efi_guid_driver_binding_protocol,
3004 NULL, &count, &buffer));
3005 if (r != EFI_SUCCESS)
3008 /* Context Override */
3009 if (driver_image_handle) {
3010 for (; *driver_image_handle; ++driver_image_handle) {
3011 for (i = 0; i < count; ++i) {
3012 if (buffer[i] == *driver_image_handle) {
3014 r = efi_bind_controller(
3016 *driver_image_handle,
3017 remain_device_path);
3019 * For drivers that do not support the
3020 * controller or are already connected
3021 * we receive an error code here.
3023 if (r == EFI_SUCCESS)
3031 * TODO: Some overrides are not yet implemented:
3032 * - Platform Driver Override
3033 * - Driver Family Override Search
3034 * - Bus Specific Driver Override
3037 /* Driver Binding Search */
3038 for (i = 0; i < count; ++i) {
3040 r = efi_bind_controller(controller_handle,
3042 remain_device_path);
3043 if (r == EFI_SUCCESS)
3048 efi_free_pool(buffer);
3050 return EFI_NOT_FOUND;
3055 * efi_connect_controller() - connect a controller to a driver
3056 * @controller_handle: handle of the controller
3057 * @driver_image_handle: handle of the driver
3058 * @remain_device_path: device path of a child controller
3059 * @recursive: true to connect all child controllers
3061 * This function implements the ConnectController service.
3063 * See the Unified Extensible Firmware Interface (UEFI) specification for
3066 * First all driver binding protocol handles are tried for binding drivers.
3067 * Afterwards all handles that have opened a protocol of the controller
3068 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3070 * Return: status code
3072 static efi_status_t EFIAPI efi_connect_controller(
3073 efi_handle_t controller_handle,
3074 efi_handle_t *driver_image_handle,
3075 struct efi_device_path *remain_device_path,
3079 efi_status_t ret = EFI_NOT_FOUND;
3080 struct efi_object *efiobj;
3082 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3083 remain_device_path, recursive);
3085 efiobj = efi_search_obj(controller_handle);
3087 ret = EFI_INVALID_PARAMETER;
3091 r = efi_connect_single_controller(controller_handle,
3092 driver_image_handle,
3093 remain_device_path);
3094 if (r == EFI_SUCCESS)
3097 struct efi_handler *handler;
3098 struct efi_open_protocol_info_item *item;
3100 list_for_each_entry(handler, &efiobj->protocols, link) {
3101 list_for_each_entry(item, &handler->open_infos, link) {
3102 if (item->info.attributes &
3103 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3104 r = EFI_CALL(efi_connect_controller(
3105 item->info.controller_handle,
3106 driver_image_handle,
3109 if (r == EFI_SUCCESS)
3115 /* Check for child controller specified by end node */
3116 if (ret != EFI_SUCCESS && remain_device_path &&
3117 remain_device_path->type == DEVICE_PATH_TYPE_END)
3120 return EFI_EXIT(ret);
3124 * efi_reinstall_protocol_interface() - reinstall protocol interface
3125 * @handle: handle on which the protocol shall be reinstalled
3126 * @protocol: GUID of the protocol to be installed
3127 * @old_interface: interface to be removed
3128 * @new_interface: interface to be installed
3130 * This function implements the ReinstallProtocolInterface service.
3132 * See the Unified Extensible Firmware Interface (UEFI) specification for
3135 * The old interface is uninstalled. The new interface is installed.
3136 * Drivers are connected.
3138 * Return: status code
3140 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3141 efi_handle_t handle, const efi_guid_t *protocol,
3142 void *old_interface, void *new_interface)
3146 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3149 /* Uninstall protocol but do not delete handle */
3150 ret = efi_uninstall_protocol(handle, protocol, old_interface);
3151 if (ret != EFI_SUCCESS)
3154 /* Install the new protocol */
3155 ret = efi_add_protocol(handle, protocol, new_interface);
3157 * The UEFI spec does not specify what should happen to the handle
3158 * if in case of an error no protocol interface remains on the handle.
3159 * So let's do nothing here.
3161 if (ret != EFI_SUCCESS)
3164 * The returned status code has to be ignored.
3165 * Do not create an error if no suitable driver for the handle exists.
3167 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3169 return EFI_EXIT(ret);
3173 * efi_get_child_controllers() - get all child controllers associated to a driver
3174 * @efiobj: handle of the controller
3175 * @driver_handle: handle of the driver
3176 * @number_of_children: number of child controllers
3177 * @child_handle_buffer: handles of the the child controllers
3179 * The allocated buffer has to be freed with free().
3181 * Return: status code
3183 static efi_status_t efi_get_child_controllers(
3184 struct efi_object *efiobj,
3185 efi_handle_t driver_handle,
3186 efi_uintn_t *number_of_children,
3187 efi_handle_t **child_handle_buffer)
3189 struct efi_handler *handler;
3190 struct efi_open_protocol_info_item *item;
3191 efi_uintn_t count = 0, i;
3194 /* Count all child controller associations */
3195 list_for_each_entry(handler, &efiobj->protocols, link) {
3196 list_for_each_entry(item, &handler->open_infos, link) {
3197 if (item->info.agent_handle == driver_handle &&
3198 item->info.attributes &
3199 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3204 * Create buffer. In case of duplicate child controller assignments
3205 * the buffer will be too large. But that does not harm.
3207 *number_of_children = 0;
3208 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3209 if (!*child_handle_buffer)
3210 return EFI_OUT_OF_RESOURCES;
3211 /* Copy unique child handles */
3212 list_for_each_entry(handler, &efiobj->protocols, link) {
3213 list_for_each_entry(item, &handler->open_infos, link) {
3214 if (item->info.agent_handle == driver_handle &&
3215 item->info.attributes &
3216 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3217 /* Check this is a new child controller */
3219 for (i = 0; i < *number_of_children; ++i) {
3220 if ((*child_handle_buffer)[i] ==
3221 item->info.controller_handle)
3224 /* Copy handle to buffer */
3226 i = (*number_of_children)++;
3227 (*child_handle_buffer)[i] =
3228 item->info.controller_handle;
3237 * efi_disconnect_controller() - disconnect a controller from a driver
3238 * @controller_handle: handle of the controller
3239 * @driver_image_handle: handle of the driver
3240 * @child_handle: handle of the child to destroy
3242 * This function implements the DisconnectController service.
3244 * See the Unified Extensible Firmware Interface (UEFI) specification for
3247 * Return: status code
3249 static efi_status_t EFIAPI efi_disconnect_controller(
3250 efi_handle_t controller_handle,
3251 efi_handle_t driver_image_handle,
3252 efi_handle_t child_handle)
3254 struct efi_driver_binding_protocol *binding_protocol;
3255 efi_handle_t *child_handle_buffer = NULL;
3256 size_t number_of_children = 0;
3258 size_t stop_count = 0;
3259 struct efi_object *efiobj;
3261 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3264 efiobj = efi_search_obj(controller_handle);
3266 r = EFI_INVALID_PARAMETER;
3270 if (child_handle && !efi_search_obj(child_handle)) {
3271 r = EFI_INVALID_PARAMETER;
3275 /* If no driver handle is supplied, disconnect all drivers */
3276 if (!driver_image_handle) {
3277 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3281 /* Create list of child handles */
3283 number_of_children = 1;
3284 child_handle_buffer = &child_handle;
3286 efi_get_child_controllers(efiobj,
3287 driver_image_handle,
3288 &number_of_children,
3289 &child_handle_buffer);
3292 /* Get the driver binding protocol */
3293 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3294 &efi_guid_driver_binding_protocol,
3295 (void **)&binding_protocol,
3296 driver_image_handle, NULL,
3297 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3298 if (r != EFI_SUCCESS)
3300 /* Remove the children */
3301 if (number_of_children) {
3302 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3305 child_handle_buffer));
3306 if (r == EFI_SUCCESS)
3309 /* Remove the driver */
3311 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3314 if (r == EFI_SUCCESS)
3316 EFI_CALL(efi_close_protocol(driver_image_handle,
3317 &efi_guid_driver_binding_protocol,
3318 driver_image_handle, NULL));
3326 free(child_handle_buffer);
3330 static struct efi_boot_services efi_boot_services = {
3332 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3333 .revision = EFI_SPECIFICATION_VERSION,
3334 .headersize = sizeof(struct efi_boot_services),
3336 .raise_tpl = efi_raise_tpl,
3337 .restore_tpl = efi_restore_tpl,
3338 .allocate_pages = efi_allocate_pages_ext,
3339 .free_pages = efi_free_pages_ext,
3340 .get_memory_map = efi_get_memory_map_ext,
3341 .allocate_pool = efi_allocate_pool_ext,
3342 .free_pool = efi_free_pool_ext,
3343 .create_event = efi_create_event_ext,
3344 .set_timer = efi_set_timer_ext,
3345 .wait_for_event = efi_wait_for_event,
3346 .signal_event = efi_signal_event_ext,
3347 .close_event = efi_close_event,
3348 .check_event = efi_check_event,
3349 .install_protocol_interface = efi_install_protocol_interface,
3350 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3351 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3352 .handle_protocol = efi_handle_protocol,
3354 .register_protocol_notify = efi_register_protocol_notify,
3355 .locate_handle = efi_locate_handle_ext,
3356 .locate_device_path = efi_locate_device_path,
3357 .install_configuration_table = efi_install_configuration_table_ext,
3358 .load_image = efi_load_image,
3359 .start_image = efi_start_image,
3361 .unload_image = efi_unload_image,
3362 .exit_boot_services = efi_exit_boot_services,
3363 .get_next_monotonic_count = efi_get_next_monotonic_count,
3365 .set_watchdog_timer = efi_set_watchdog_timer,
3366 .connect_controller = efi_connect_controller,
3367 .disconnect_controller = efi_disconnect_controller,
3368 .open_protocol = efi_open_protocol,
3369 .close_protocol = efi_close_protocol,
3370 .open_protocol_information = efi_open_protocol_information,
3371 .protocols_per_handle = efi_protocols_per_handle,
3372 .locate_handle_buffer = efi_locate_handle_buffer,
3373 .locate_protocol = efi_locate_protocol,
3374 .install_multiple_protocol_interfaces =
3375 efi_install_multiple_protocol_interfaces,
3376 .uninstall_multiple_protocol_interfaces =
3377 efi_uninstall_multiple_protocol_interfaces,
3378 .calculate_crc32 = efi_calculate_crc32,
3379 .copy_mem = efi_copy_mem,
3380 .set_mem = efi_set_mem,
3381 .create_event_ex = efi_create_event_ex,
3384 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3386 struct efi_system_table __efi_runtime_data systab = {
3388 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3389 .revision = EFI_SPECIFICATION_VERSION,
3390 .headersize = sizeof(struct efi_system_table),
3392 .fw_vendor = firmware_vendor,
3393 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3394 .con_in = (void *)&efi_con_in,
3395 .con_out = (void *)&efi_con_out,
3396 .std_err = (void *)&efi_con_out,
3397 .runtime = (void *)&efi_runtime_services,
3398 .boottime = (void *)&efi_boot_services,
3404 * efi_initialize_system_table() - Initialize system table
3406 * Return: status code
3408 efi_status_t efi_initialize_system_table(void)
3412 /* Allocate configuration table array */
3413 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3414 EFI_MAX_CONFIGURATION_TABLES *
3415 sizeof(struct efi_configuration_table),
3416 (void **)&systab.tables);
3418 /* Set CRC32 field in table headers */
3419 efi_update_table_header_crc32(&systab.hdr);
3420 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3421 efi_update_table_header_crc32(&efi_boot_services.hdr);