1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application boot time services
5 * Copyright (c) 2016 Alexander Graf
10 #include <efi_loader.h>
11 #include <environment.h>
13 #include <linux/libfdt_env.h>
14 #include <u-boot/crc.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 /* Task priority level */
22 static efi_uintn_t efi_tpl = TPL_APPLICATION;
24 /* This list contains all the EFI objects our payload has access to */
25 LIST_HEAD(efi_obj_list);
27 /* List of all events */
28 LIST_HEAD(efi_events);
31 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
32 * we need to do trickery with caches. Since we don't want to break the EFI
33 * aware boot path, only apply hacks when loading exiting directly (breaking
34 * direct Linux EFI booting along the way - oh well).
36 static bool efi_is_direct_boot = true;
40 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
41 * fixed when compiling U-Boot. However, the payload does not know about that
42 * restriction so we need to manually swap its and our view of that register on
43 * EFI callback entry/exit.
45 static volatile void *efi_gd, *app_gd;
48 static int entry_count;
49 static int nesting_level;
50 /* GUID of the device tree table */
51 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
52 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
53 const efi_guid_t efi_guid_driver_binding_protocol =
54 EFI_DRIVER_BINDING_PROTOCOL_GUID;
56 /* event group ExitBootServices() invoked */
57 const efi_guid_t efi_guid_event_group_exit_boot_services =
58 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
59 /* event group SetVirtualAddressMap() invoked */
60 const efi_guid_t efi_guid_event_group_virtual_address_change =
61 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
62 /* event group memory map changed */
63 const efi_guid_t efi_guid_event_group_memory_map_change =
64 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
65 /* event group boot manager about to boot */
66 const efi_guid_t efi_guid_event_group_ready_to_boot =
67 EFI_EVENT_GROUP_READY_TO_BOOT;
68 /* event group ResetSystem() invoked (before ExitBootServices) */
69 const efi_guid_t efi_guid_event_group_reset_system =
70 EFI_EVENT_GROUP_RESET_SYSTEM;
72 static efi_status_t EFIAPI efi_disconnect_controller(
73 efi_handle_t controller_handle,
74 efi_handle_t driver_image_handle,
75 efi_handle_t child_handle);
77 /* Called on every callback entry */
78 int __efi_entry_check(void)
80 int ret = entry_count++ == 0;
89 /* Called on every callback exit */
90 int __efi_exit_check(void)
92 int ret = --entry_count == 0;
99 /* Called from do_bootefi_exec() */
100 void efi_save_gd(void)
108 * Special case handler for error/abort that just forces things back to u-boot
109 * world so we can dump out an abort msg, without any care about returning back
112 void efi_restore_gd(void)
115 /* Only restore if we're already in EFI context */
123 * indent_string() - returns a string for indenting with two spaces per level
124 * @level: indent level
126 * A maximum of ten indent levels is supported. Higher indent levels will be
129 * Return: A string for indenting with two spaces per level is
132 static const char *indent_string(int level)
134 const char *indent = " ";
135 const int max = strlen(indent);
137 level = min(max, level * 2);
138 return &indent[max - level];
141 const char *__efi_nesting(void)
143 return indent_string(nesting_level);
146 const char *__efi_nesting_inc(void)
148 return indent_string(nesting_level++);
151 const char *__efi_nesting_dec(void)
153 return indent_string(--nesting_level);
157 * efi_update_table_header_crc32() - Update CRC32 in table header
161 static void efi_update_table_header_crc32(struct efi_table_hdr *table)
164 table->crc32 = crc32(0, (const unsigned char *)table,
169 * efi_queue_event() - queue an EFI event
170 * @event: event to signal
171 * @check_tpl: check the TPL level
173 * This function queues the notification function of the event for future
176 * The notification function is called if the task priority level of the event
177 * is higher than the current task priority level.
179 * For the SignalEvent service see efi_signal_event_ext.
182 static void efi_queue_event(struct efi_event *event, bool check_tpl)
184 if (event->notify_function) {
185 event->is_queued = true;
187 if (check_tpl && efi_tpl >= event->notify_tpl)
189 EFI_CALL_VOID(event->notify_function(event,
190 event->notify_context));
192 event->is_queued = false;
196 * is_valid_tpl() - check if the task priority level is valid
198 * @tpl: TPL level to check
199 * ReturnValue: status code
201 efi_status_t is_valid_tpl(efi_uintn_t tpl)
204 case TPL_APPLICATION:
210 return EFI_INVALID_PARAMETER;
215 * efi_signal_event() - signal an EFI event
216 * @event: event to signal
217 * @check_tpl: check the TPL level
219 * This function signals an event. If the event belongs to an event group all
220 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
221 * their notification function is queued.
223 * For the SignalEvent service see efi_signal_event_ext.
225 void efi_signal_event(struct efi_event *event, bool check_tpl)
228 struct efi_event *evt;
231 * The signaled state has to set before executing any
232 * notification function
234 list_for_each_entry(evt, &efi_events, link) {
235 if (!evt->group || guidcmp(evt->group, event->group))
237 if (evt->is_signaled)
239 evt->is_signaled = true;
240 if (evt->type & EVT_NOTIFY_SIGNAL &&
241 evt->notify_function)
242 evt->is_queued = true;
244 list_for_each_entry(evt, &efi_events, link) {
245 if (!evt->group || guidcmp(evt->group, event->group))
248 efi_queue_event(evt, check_tpl);
250 } else if (!event->is_signaled) {
251 event->is_signaled = true;
252 if (event->type & EVT_NOTIFY_SIGNAL)
253 efi_queue_event(event, check_tpl);
258 * efi_raise_tpl() - raise the task priority level
259 * @new_tpl: new value of the task priority level
261 * This function implements the RaiseTpl service.
263 * See the Unified Extensible Firmware Interface (UEFI) specification for
266 * Return: old value of the task priority level
268 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
270 efi_uintn_t old_tpl = efi_tpl;
272 EFI_ENTRY("0x%zx", new_tpl);
274 if (new_tpl < efi_tpl)
275 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
277 if (efi_tpl > TPL_HIGH_LEVEL)
278 efi_tpl = TPL_HIGH_LEVEL;
280 EFI_EXIT(EFI_SUCCESS);
285 * efi_restore_tpl() - lower the task priority level
286 * @old_tpl: value of the task priority level to be restored
288 * This function implements the RestoreTpl service.
290 * See the Unified Extensible Firmware Interface (UEFI) specification for
293 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
295 EFI_ENTRY("0x%zx", old_tpl);
297 if (old_tpl > efi_tpl)
298 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
300 if (efi_tpl > TPL_HIGH_LEVEL)
301 efi_tpl = TPL_HIGH_LEVEL;
304 * Lowering the TPL may have made queued events eligible for execution.
308 EFI_EXIT(EFI_SUCCESS);
312 * efi_allocate_pages_ext() - allocate memory pages
313 * @type: type of allocation to be performed
314 * @memory_type: usage type of the allocated memory
315 * @pages: number of pages to be allocated
316 * @memory: allocated memory
318 * This function implements the AllocatePages service.
320 * See the Unified Extensible Firmware Interface (UEFI) specification for
323 * Return: status code
325 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
331 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
332 r = efi_allocate_pages(type, memory_type, pages, memory);
337 * efi_free_pages_ext() - Free memory pages.
338 * @memory: start of the memory area to be freed
339 * @pages: number of pages to be freed
341 * This function implements the FreePages service.
343 * See the Unified Extensible Firmware Interface (UEFI) specification for
346 * Return: status code
348 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
353 EFI_ENTRY("%" PRIx64 ", 0x%zx", memory, pages);
354 r = efi_free_pages(memory, pages);
359 * efi_get_memory_map_ext() - get map describing memory usage
360 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
361 * on exit the size of the copied memory map
362 * @memory_map: buffer to which the memory map is written
363 * @map_key: key for the memory map
364 * @descriptor_size: size of an individual memory descriptor
365 * @descriptor_version: version number of the memory descriptor structure
367 * This function implements the GetMemoryMap service.
369 * See the Unified Extensible Firmware Interface (UEFI) specification for
372 * Return: status code
374 static efi_status_t EFIAPI efi_get_memory_map_ext(
375 efi_uintn_t *memory_map_size,
376 struct efi_mem_desc *memory_map,
377 efi_uintn_t *map_key,
378 efi_uintn_t *descriptor_size,
379 uint32_t *descriptor_version)
383 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
384 map_key, descriptor_size, descriptor_version);
385 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
386 descriptor_size, descriptor_version);
391 * efi_allocate_pool_ext() - allocate memory from pool
392 * @pool_type: type of the pool from which memory is to be allocated
393 * @size: number of bytes to be allocated
394 * @buffer: allocated memory
396 * This function implements the AllocatePool service.
398 * See the Unified Extensible Firmware Interface (UEFI) specification for
401 * Return: status code
403 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
409 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
410 r = efi_allocate_pool(pool_type, size, buffer);
415 * efi_free_pool_ext() - free memory from pool
416 * @buffer: start of memory to be freed
418 * This function implements the FreePool service.
420 * See the Unified Extensible Firmware Interface (UEFI) specification for
423 * Return: status code
425 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
429 EFI_ENTRY("%p", buffer);
430 r = efi_free_pool(buffer);
435 * efi_add_handle() - add a new object to the object list
436 * @obj: object to be added
438 * The protocols list is initialized. The object handle is set.
440 void efi_add_handle(struct efi_object *obj)
444 INIT_LIST_HEAD(&obj->protocols);
446 list_add_tail(&obj->link, &efi_obj_list);
450 * efi_create_handle() - create handle
451 * @handle: new handle
453 * Return: status code
455 efi_status_t efi_create_handle(efi_handle_t *handle)
457 struct efi_object *obj;
459 obj = calloc(1, sizeof(struct efi_object));
461 return EFI_OUT_OF_RESOURCES;
464 *handle = obj->handle;
470 * efi_search_protocol() - find a protocol on a handle.
472 * @protocol_guid: GUID of the protocol
473 * @handler: reference to the protocol
475 * Return: status code
477 efi_status_t efi_search_protocol(const efi_handle_t handle,
478 const efi_guid_t *protocol_guid,
479 struct efi_handler **handler)
481 struct efi_object *efiobj;
482 struct list_head *lhandle;
484 if (!handle || !protocol_guid)
485 return EFI_INVALID_PARAMETER;
486 efiobj = efi_search_obj(handle);
488 return EFI_INVALID_PARAMETER;
489 list_for_each(lhandle, &efiobj->protocols) {
490 struct efi_handler *protocol;
492 protocol = list_entry(lhandle, struct efi_handler, link);
493 if (!guidcmp(protocol->guid, protocol_guid)) {
499 return EFI_NOT_FOUND;
503 * efi_remove_protocol() - delete protocol from a handle
504 * @handle: handle from which the protocol shall be deleted
505 * @protocol: GUID of the protocol to be deleted
506 * @protocol_interface: interface of the protocol implementation
508 * Return: status code
510 efi_status_t efi_remove_protocol(const efi_handle_t handle,
511 const efi_guid_t *protocol,
512 void *protocol_interface)
514 struct efi_handler *handler;
517 ret = efi_search_protocol(handle, protocol, &handler);
518 if (ret != EFI_SUCCESS)
520 if (guidcmp(handler->guid, protocol))
521 return EFI_INVALID_PARAMETER;
522 if (handler->protocol_interface != protocol_interface)
523 return EFI_INVALID_PARAMETER;
524 list_del(&handler->link);
530 * efi_remove_all_protocols() - delete all protocols from a handle
531 * @handle: handle from which the protocols shall be deleted
533 * Return: status code
535 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
537 struct efi_object *efiobj;
538 struct efi_handler *protocol;
539 struct efi_handler *pos;
541 efiobj = efi_search_obj(handle);
543 return EFI_INVALID_PARAMETER;
544 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
547 ret = efi_remove_protocol(handle, protocol->guid,
548 protocol->protocol_interface);
549 if (ret != EFI_SUCCESS)
556 * efi_delete_handle() - delete handle
558 * @obj: handle to delete
560 void efi_delete_handle(struct efi_object *obj)
564 efi_remove_all_protocols(obj->handle);
565 list_del(&obj->link);
570 * efi_is_event() - check if a pointer is a valid event
571 * @event: pointer to check
573 * Return: status code
575 static efi_status_t efi_is_event(const struct efi_event *event)
577 const struct efi_event *evt;
580 return EFI_INVALID_PARAMETER;
581 list_for_each_entry(evt, &efi_events, link) {
585 return EFI_INVALID_PARAMETER;
589 * efi_create_event() - create an event
590 * @type: type of the event to create
591 * @notify_tpl: task priority level of the event
592 * @notify_function: notification function of the event
593 * @notify_context: pointer passed to the notification function
594 * @group: event group
595 * @event: created event
597 * This function is used inside U-Boot code to create an event.
599 * For the API function implementing the CreateEvent service see
600 * efi_create_event_ext.
602 * Return: status code
604 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
605 void (EFIAPI *notify_function) (
606 struct efi_event *event,
608 void *notify_context, efi_guid_t *group,
609 struct efi_event **event)
611 struct efi_event *evt;
614 return EFI_INVALID_PARAMETER;
619 case EVT_NOTIFY_SIGNAL:
620 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
621 case EVT_NOTIFY_WAIT:
622 case EVT_TIMER | EVT_NOTIFY_WAIT:
623 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
624 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
627 return EFI_INVALID_PARAMETER;
630 if (is_valid_tpl(notify_tpl) != EFI_SUCCESS)
631 return EFI_INVALID_PARAMETER;
633 evt = calloc(1, sizeof(struct efi_event));
635 return EFI_OUT_OF_RESOURCES;
637 evt->notify_tpl = notify_tpl;
638 evt->notify_function = notify_function;
639 evt->notify_context = notify_context;
641 /* Disable timers on bootup */
642 evt->trigger_next = -1ULL;
643 evt->is_queued = false;
644 evt->is_signaled = false;
645 list_add_tail(&evt->link, &efi_events);
651 * efi_create_event_ex() - create an event in a group
652 * @type: type of the event to create
653 * @notify_tpl: task priority level of the event
654 * @notify_function: notification function of the event
655 * @notify_context: pointer passed to the notification function
656 * @event: created event
657 * @event_group: event group
659 * This function implements the CreateEventEx service.
661 * See the Unified Extensible Firmware Interface (UEFI) specification for
664 * Return: status code
666 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
667 void (EFIAPI *notify_function) (
668 struct efi_event *event,
670 void *notify_context,
671 efi_guid_t *event_group,
672 struct efi_event **event)
674 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
675 notify_context, event_group);
676 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
677 notify_context, event_group, event));
681 * efi_create_event_ext() - create an event
682 * @type: type of the event to create
683 * @notify_tpl: task priority level of the event
684 * @notify_function: notification function of the event
685 * @notify_context: pointer passed to the notification function
686 * @event: created event
688 * This function implements the CreateEvent service.
690 * See the Unified Extensible Firmware Interface (UEFI) specification for
693 * Return: status code
695 static efi_status_t EFIAPI efi_create_event_ext(
696 uint32_t type, efi_uintn_t notify_tpl,
697 void (EFIAPI *notify_function) (
698 struct efi_event *event,
700 void *notify_context, struct efi_event **event)
702 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
704 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
705 notify_context, NULL, event));
709 * efi_timer_check() - check if a timer event has occurred
711 * Check if a timer event has occurred or a queued notification function should
714 * Our timers have to work without interrupts, so we check whenever keyboard
715 * input or disk accesses happen if enough time elapsed for them to fire.
717 void efi_timer_check(void)
719 struct efi_event *evt;
720 u64 now = timer_get_us();
722 list_for_each_entry(evt, &efi_events, link) {
724 efi_queue_event(evt, true);
725 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
727 switch (evt->trigger_type) {
728 case EFI_TIMER_RELATIVE:
729 evt->trigger_type = EFI_TIMER_STOP;
731 case EFI_TIMER_PERIODIC:
732 evt->trigger_next += evt->trigger_time;
737 evt->is_signaled = false;
738 efi_signal_event(evt, true);
744 * efi_set_timer() - set the trigger time for a timer event or stop the event
745 * @event: event for which the timer is set
746 * @type: type of the timer
747 * @trigger_time: trigger period in multiples of 100ns
749 * This is the function for internal usage in U-Boot. For the API function
750 * implementing the SetTimer service see efi_set_timer_ext.
752 * Return: status code
754 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
755 uint64_t trigger_time)
757 /* Check that the event is valid */
758 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
759 return EFI_INVALID_PARAMETER;
762 * The parameter defines a multiple of 100ns.
763 * We use multiples of 1000ns. So divide by 10.
765 do_div(trigger_time, 10);
769 event->trigger_next = -1ULL;
771 case EFI_TIMER_PERIODIC:
772 case EFI_TIMER_RELATIVE:
773 event->trigger_next = timer_get_us() + trigger_time;
776 return EFI_INVALID_PARAMETER;
778 event->trigger_type = type;
779 event->trigger_time = trigger_time;
780 event->is_signaled = false;
785 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
787 * @event: event for which the timer is set
788 * @type: type of the timer
789 * @trigger_time: trigger period in multiples of 100ns
791 * This function implements the SetTimer service.
793 * See the Unified Extensible Firmware Interface (UEFI) specification for
797 * Return: status code
799 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
800 enum efi_timer_delay type,
801 uint64_t trigger_time)
803 EFI_ENTRY("%p, %d, %" PRIx64, event, type, trigger_time);
804 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
808 * efi_wait_for_event() - wait for events to be signaled
809 * @num_events: number of events to be waited for
810 * @event: events to be waited for
811 * @index: index of the event that was signaled
813 * This function implements the WaitForEvent service.
815 * See the Unified Extensible Firmware Interface (UEFI) specification for
818 * Return: status code
820 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
821 struct efi_event **event,
826 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
828 /* Check parameters */
829 if (!num_events || !event)
830 return EFI_EXIT(EFI_INVALID_PARAMETER);
832 if (efi_tpl != TPL_APPLICATION)
833 return EFI_EXIT(EFI_UNSUPPORTED);
834 for (i = 0; i < num_events; ++i) {
835 if (efi_is_event(event[i]) != EFI_SUCCESS)
836 return EFI_EXIT(EFI_INVALID_PARAMETER);
837 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
838 return EFI_EXIT(EFI_INVALID_PARAMETER);
839 if (!event[i]->is_signaled)
840 efi_queue_event(event[i], true);
843 /* Wait for signal */
845 for (i = 0; i < num_events; ++i) {
846 if (event[i]->is_signaled)
849 /* Allow events to occur. */
855 * Reset the signal which is passed to the caller to allow periodic
858 event[i]->is_signaled = false;
862 return EFI_EXIT(EFI_SUCCESS);
866 * efi_signal_event_ext() - signal an EFI event
867 * @event: event to signal
869 * This function implements the SignalEvent service.
871 * See the Unified Extensible Firmware Interface (UEFI) specification for
874 * This functions sets the signaled state of the event and queues the
875 * notification function for execution.
877 * Return: status code
879 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
881 EFI_ENTRY("%p", event);
882 if (efi_is_event(event) != EFI_SUCCESS)
883 return EFI_EXIT(EFI_INVALID_PARAMETER);
884 efi_signal_event(event, true);
885 return EFI_EXIT(EFI_SUCCESS);
889 * efi_close_event() - close an EFI event
890 * @event: event to close
892 * This function implements the CloseEvent service.
894 * See the Unified Extensible Firmware Interface (UEFI) specification for
897 * Return: status code
899 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
901 EFI_ENTRY("%p", event);
902 if (efi_is_event(event) != EFI_SUCCESS)
903 return EFI_EXIT(EFI_INVALID_PARAMETER);
904 list_del(&event->link);
906 return EFI_EXIT(EFI_SUCCESS);
910 * efi_check_event() - check if an event is signaled
911 * @event: event to check
913 * This function implements the CheckEvent service.
915 * See the Unified Extensible Firmware Interface (UEFI) specification for
918 * If an event is not signaled yet, the notification function is queued. The
919 * signaled state is cleared.
921 * Return: status code
923 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
925 EFI_ENTRY("%p", event);
927 if (efi_is_event(event) != EFI_SUCCESS ||
928 event->type & EVT_NOTIFY_SIGNAL)
929 return EFI_EXIT(EFI_INVALID_PARAMETER);
930 if (!event->is_signaled)
931 efi_queue_event(event, true);
932 if (event->is_signaled) {
933 event->is_signaled = false;
934 return EFI_EXIT(EFI_SUCCESS);
936 return EFI_EXIT(EFI_NOT_READY);
940 * efi_search_obj() - find the internal EFI object for a handle
941 * @handle: handle to find
945 struct efi_object *efi_search_obj(const efi_handle_t handle)
947 struct efi_object *efiobj;
949 list_for_each_entry(efiobj, &efi_obj_list, link) {
950 if (efiobj->handle == handle)
958 * efi_open_protocol_info_entry() - create open protocol info entry and add it
960 * @handler: handler of a protocol
962 * Return: open protocol info entry
964 static struct efi_open_protocol_info_entry *efi_create_open_info(
965 struct efi_handler *handler)
967 struct efi_open_protocol_info_item *item;
969 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
972 /* Append the item to the open protocol info list. */
973 list_add_tail(&item->link, &handler->open_infos);
979 * efi_delete_open_info() - remove an open protocol info entry from a protocol
980 * @item: open protocol info entry to delete
982 * Return: status code
984 static efi_status_t efi_delete_open_info(
985 struct efi_open_protocol_info_item *item)
987 list_del(&item->link);
993 * efi_add_protocol() - install new protocol on a handle
994 * @handle: handle on which the protocol shall be installed
995 * @protocol: GUID of the protocol to be installed
996 * @protocol_interface: interface of the protocol implementation
998 * Return: status code
1000 efi_status_t efi_add_protocol(const efi_handle_t handle,
1001 const efi_guid_t *protocol,
1002 void *protocol_interface)
1004 struct efi_object *efiobj;
1005 struct efi_handler *handler;
1008 efiobj = efi_search_obj(handle);
1010 return EFI_INVALID_PARAMETER;
1011 ret = efi_search_protocol(handle, protocol, NULL);
1012 if (ret != EFI_NOT_FOUND)
1013 return EFI_INVALID_PARAMETER;
1014 handler = calloc(1, sizeof(struct efi_handler));
1016 return EFI_OUT_OF_RESOURCES;
1017 handler->guid = protocol;
1018 handler->protocol_interface = protocol_interface;
1019 INIT_LIST_HEAD(&handler->open_infos);
1020 list_add_tail(&handler->link, &efiobj->protocols);
1021 if (!guidcmp(&efi_guid_device_path, protocol))
1022 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1027 * efi_install_protocol_interface() - install protocol interface
1028 * @handle: handle on which the protocol shall be installed
1029 * @protocol: GUID of the protocol to be installed
1030 * @protocol_interface_type: type of the interface to be installed,
1031 * always EFI_NATIVE_INTERFACE
1032 * @protocol_interface: interface of the protocol implementation
1034 * This function implements the InstallProtocolInterface service.
1036 * See the Unified Extensible Firmware Interface (UEFI) specification for
1039 * Return: status code
1041 static efi_status_t EFIAPI efi_install_protocol_interface(
1042 void **handle, const efi_guid_t *protocol,
1043 int protocol_interface_type, void *protocol_interface)
1047 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1048 protocol_interface);
1050 if (!handle || !protocol ||
1051 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1052 r = EFI_INVALID_PARAMETER;
1056 /* Create new handle if requested. */
1058 r = efi_create_handle(handle);
1059 if (r != EFI_SUCCESS)
1061 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
1064 debug("%sEFI: handle %p\n", indent_string(nesting_level),
1067 /* Add new protocol */
1068 r = efi_add_protocol(*handle, protocol, protocol_interface);
1074 * efi_get_drivers() - get all drivers associated to a controller
1075 * @efiobj: handle of the controller
1076 * @protocol: protocol guid (optional)
1077 * @number_of_drivers: number of child controllers
1078 * @driver_handle_buffer: handles of the the drivers
1080 * The allocated buffer has to be freed with free().
1082 * Return: status code
1084 static efi_status_t efi_get_drivers(struct efi_object *efiobj,
1085 const efi_guid_t *protocol,
1086 efi_uintn_t *number_of_drivers,
1087 efi_handle_t **driver_handle_buffer)
1089 struct efi_handler *handler;
1090 struct efi_open_protocol_info_item *item;
1091 efi_uintn_t count = 0, i;
1094 /* Count all driver associations */
1095 list_for_each_entry(handler, &efiobj->protocols, link) {
1096 if (protocol && guidcmp(handler->guid, protocol))
1098 list_for_each_entry(item, &handler->open_infos, link) {
1099 if (item->info.attributes &
1100 EFI_OPEN_PROTOCOL_BY_DRIVER)
1105 * Create buffer. In case of duplicate driver assignments the buffer
1106 * will be too large. But that does not harm.
1108 *number_of_drivers = 0;
1109 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1110 if (!*driver_handle_buffer)
1111 return EFI_OUT_OF_RESOURCES;
1112 /* Collect unique driver handles */
1113 list_for_each_entry(handler, &efiobj->protocols, link) {
1114 if (protocol && guidcmp(handler->guid, protocol))
1116 list_for_each_entry(item, &handler->open_infos, link) {
1117 if (item->info.attributes &
1118 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1119 /* Check this is a new driver */
1121 for (i = 0; i < *number_of_drivers; ++i) {
1122 if ((*driver_handle_buffer)[i] ==
1123 item->info.agent_handle)
1126 /* Copy handle to buffer */
1128 i = (*number_of_drivers)++;
1129 (*driver_handle_buffer)[i] =
1130 item->info.agent_handle;
1139 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1140 * @efiobj: handle of the controller
1141 * @protocol: protocol guid (optional)
1142 * @child_handle: handle of the child to destroy
1144 * This function implements the DisconnectController service.
1146 * See the Unified Extensible Firmware Interface (UEFI) specification for
1149 * Return: status code
1151 static efi_status_t efi_disconnect_all_drivers(
1152 struct efi_object *efiobj,
1153 const efi_guid_t *protocol,
1154 efi_handle_t child_handle)
1156 efi_uintn_t number_of_drivers;
1157 efi_handle_t *driver_handle_buffer;
1158 efi_status_t r, ret;
1160 ret = efi_get_drivers(efiobj, protocol, &number_of_drivers,
1161 &driver_handle_buffer);
1162 if (ret != EFI_SUCCESS)
1165 ret = EFI_NOT_FOUND;
1166 while (number_of_drivers) {
1167 r = EFI_CALL(efi_disconnect_controller(
1169 driver_handle_buffer[--number_of_drivers],
1171 if (r == EFI_SUCCESS)
1174 free(driver_handle_buffer);
1179 * efi_uninstall_protocol_interface() - uninstall protocol interface
1180 * @handle: handle from which the protocol shall be removed
1181 * @protocol: GUID of the protocol to be removed
1182 * @protocol_interface: interface to be removed
1184 * This function implements the UninstallProtocolInterface service.
1186 * See the Unified Extensible Firmware Interface (UEFI) specification for
1189 * Return: status code
1191 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
1192 efi_handle_t handle, const efi_guid_t *protocol,
1193 void *protocol_interface)
1195 struct efi_object *efiobj;
1196 struct efi_handler *handler;
1197 struct efi_open_protocol_info_item *item;
1198 struct efi_open_protocol_info_item *pos;
1201 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1204 efiobj = efi_search_obj(handle);
1206 r = EFI_INVALID_PARAMETER;
1209 /* Find the protocol on the handle */
1210 r = efi_search_protocol(handle, protocol, &handler);
1211 if (r != EFI_SUCCESS)
1213 /* Disconnect controllers */
1214 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1215 if (!list_empty(&handler->open_infos)) {
1216 r = EFI_ACCESS_DENIED;
1219 /* Close protocol */
1220 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1221 if (item->info.attributes ==
1222 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1223 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1224 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1225 list_del(&item->link);
1227 if (!list_empty(&handler->open_infos)) {
1228 r = EFI_ACCESS_DENIED;
1231 r = efi_remove_protocol(handle, protocol, protocol_interface);
1237 * efi_register_protocol_notify() - register an event for notification when a
1238 * protocol is installed.
1239 * @protocol: GUID of the protocol whose installation shall be notified
1240 * @event: event to be signaled upon installation of the protocol
1241 * @registration: key for retrieving the registration information
1243 * This function implements the RegisterProtocolNotify service.
1244 * See the Unified Extensible Firmware Interface (UEFI) specification
1247 * Return: status code
1249 static efi_status_t EFIAPI efi_register_protocol_notify(
1250 const efi_guid_t *protocol,
1251 struct efi_event *event,
1252 void **registration)
1254 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1255 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1259 * efi_search() - determine if an EFI handle implements a protocol
1260 * @search_type: selection criterion
1261 * @protocol: GUID of the protocol
1262 * @search_key: registration key
1265 * See the documentation of the LocateHandle service in the UEFI specification.
1267 * Return: 0 if the handle implements the protocol
1269 static int efi_search(enum efi_locate_search_type search_type,
1270 const efi_guid_t *protocol, void *search_key,
1271 struct efi_object *efiobj)
1275 switch (search_type) {
1278 case BY_REGISTER_NOTIFY:
1279 /* TODO: RegisterProtocolNotify is not implemented yet */
1282 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
1283 return (ret != EFI_SUCCESS);
1285 /* Invalid search type */
1291 * efi_locate_handle() - locate handles implementing a protocol
1292 * @search_type: selection criterion
1293 * @protocol: GUID of the protocol
1294 * @search_key: registration key
1295 * @buffer_size: size of the buffer to receive the handles in bytes
1296 * @buffer: buffer to receive the relevant handles
1298 * This function is meant for U-Boot internal calls. For the API implementation
1299 * of the LocateHandle service see efi_locate_handle_ext.
1301 * Return: status code
1303 static efi_status_t efi_locate_handle(
1304 enum efi_locate_search_type search_type,
1305 const efi_guid_t *protocol, void *search_key,
1306 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1308 struct efi_object *efiobj;
1309 efi_uintn_t size = 0;
1311 /* Check parameters */
1312 switch (search_type) {
1315 case BY_REGISTER_NOTIFY:
1317 return EFI_INVALID_PARAMETER;
1318 /* RegisterProtocolNotify is not implemented yet */
1319 return EFI_UNSUPPORTED;
1322 return EFI_INVALID_PARAMETER;
1325 return EFI_INVALID_PARAMETER;
1329 * efi_locate_handle_buffer uses this function for
1330 * the calculation of the necessary buffer size.
1331 * So do not require a buffer for buffersize == 0.
1333 if (!buffer_size || (*buffer_size && !buffer))
1334 return EFI_INVALID_PARAMETER;
1336 /* Count how much space we need */
1337 list_for_each_entry(efiobj, &efi_obj_list, link) {
1338 if (!efi_search(search_type, protocol, search_key, efiobj))
1339 size += sizeof(void *);
1342 if (*buffer_size < size) {
1343 *buffer_size = size;
1344 return EFI_BUFFER_TOO_SMALL;
1347 *buffer_size = size;
1349 return EFI_NOT_FOUND;
1351 /* Then fill the array */
1352 list_for_each_entry(efiobj, &efi_obj_list, link) {
1353 if (!efi_search(search_type, protocol, search_key, efiobj))
1354 *buffer++ = efiobj->handle;
1361 * efi_locate_handle_ext() - locate handles implementing a protocol.
1362 * @search_type: selection criterion
1363 * @protocol: GUID of the protocol
1364 * @search_key: registration key
1365 * @buffer_size: size of the buffer to receive the handles in bytes
1366 * @buffer: buffer to receive the relevant handles
1368 * This function implements the LocateHandle service.
1370 * See the Unified Extensible Firmware Interface (UEFI) specification for
1373 * Return: 0 if the handle implements the protocol
1375 static efi_status_t EFIAPI efi_locate_handle_ext(
1376 enum efi_locate_search_type search_type,
1377 const efi_guid_t *protocol, void *search_key,
1378 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1380 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1381 buffer_size, buffer);
1383 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1384 buffer_size, buffer));
1388 * efi_remove_configuration_table() - collapses configuration table entries,
1391 * @i: index of the table entry to be removed
1393 static void efi_remove_configuration_table(int i)
1395 struct efi_configuration_table *this = &systab.tables[i];
1396 struct efi_configuration_table *next = &systab.tables[i + 1];
1397 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1399 memmove(this, next, (ulong)end - (ulong)next);
1404 * efi_install_configuration_table() - adds, updates, or removes a
1405 * configuration table
1406 * @guid: GUID of the installed table
1407 * @table: table to be installed
1409 * This function is used for internal calls. For the API implementation of the
1410 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1412 * Return: status code
1414 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1417 struct efi_event *evt;
1421 return EFI_INVALID_PARAMETER;
1423 /* Check for guid override */
1424 for (i = 0; i < systab.nr_tables; i++) {
1425 if (!guidcmp(guid, &systab.tables[i].guid)) {
1427 systab.tables[i].table = table;
1429 efi_remove_configuration_table(i);
1435 return EFI_NOT_FOUND;
1437 /* No override, check for overflow */
1438 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1439 return EFI_OUT_OF_RESOURCES;
1441 /* Add a new entry */
1442 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1443 systab.tables[i].table = table;
1444 systab.nr_tables = i + 1;
1447 /* systab.nr_tables may have changed. So we need to update the crc32 */
1448 efi_update_table_header_crc32(&systab.hdr);
1450 /* Notify that the configuration table was changed */
1451 list_for_each_entry(evt, &efi_events, link) {
1452 if (evt->group && !guidcmp(evt->group, guid)) {
1453 efi_signal_event(evt, false);
1462 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1463 * configuration table.
1464 * @guid: GUID of the installed table
1465 * @table: table to be installed
1467 * This function implements the InstallConfigurationTable service.
1469 * See the Unified Extensible Firmware Interface (UEFI) specification for
1472 * Return: status code
1474 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1477 EFI_ENTRY("%pUl, %p", guid, table);
1478 return EFI_EXIT(efi_install_configuration_table(guid, table));
1482 * efi_setup_loaded_image() - initialize a loaded image
1483 * @info: loaded image info to be passed to the entry point of the image
1484 * @obj: internal object associated with the loaded image
1485 * @device_path: device path of the loaded image
1486 * @file_path: file path of the loaded image
1488 * Initialize a loaded_image_info and loaded_image_info object with correct
1489 * protocols, boot-device, etc.
1491 * Return: status code
1493 efi_status_t efi_setup_loaded_image(
1494 struct efi_loaded_image *info, struct efi_object *obj,
1495 struct efi_device_path *device_path,
1496 struct efi_device_path *file_path)
1500 /* Add internal object to object list */
1501 efi_add_handle(obj);
1502 /* efi_exit() assumes that the handle points to the info */
1505 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1506 info->file_path = file_path;
1509 info->device_handle = efi_dp_find_obj(device_path, NULL);
1511 * When asking for the device path interface, return
1512 * bootefi_device_path
1514 ret = efi_add_protocol(obj->handle, &efi_guid_device_path,
1516 if (ret != EFI_SUCCESS)
1521 * When asking for the loaded_image interface, just
1522 * return handle which points to loaded_image_info
1524 ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
1525 if (ret != EFI_SUCCESS)
1528 ret = efi_add_protocol(obj->handle,
1529 &efi_guid_device_path_to_text_protocol,
1530 (void *)&efi_device_path_to_text);
1531 if (ret != EFI_SUCCESS)
1534 ret = efi_add_protocol(obj->handle,
1535 &efi_guid_device_path_utilities_protocol,
1536 (void *)&efi_device_path_utilities);
1537 if (ret != EFI_SUCCESS)
1542 printf("ERROR: Failure to install protocols for loaded image\n");
1547 * efi_load_image_from_path() - load an image using a file path
1548 * @file_path: the path of the image to load
1549 * @buffer: buffer containing the loaded image
1551 * Return: status code
1553 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1556 struct efi_file_info *info = NULL;
1557 struct efi_file_handle *f;
1558 static efi_status_t ret;
1561 f = efi_file_from_path(file_path);
1563 return EFI_DEVICE_ERROR;
1566 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1568 if (ret == EFI_BUFFER_TOO_SMALL) {
1570 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1573 if (ret != EFI_SUCCESS)
1576 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1580 bs = info->file_size;
1581 EFI_CALL(ret = f->read(f, &bs, *buffer));
1585 EFI_CALL(f->close(f));
1587 if (ret != EFI_SUCCESS) {
1588 efi_free_pool(*buffer);
1596 * efi_load_image() - load an EFI image into memory
1597 * @boot_policy: true for request originating from the boot manager
1598 * @parent_image: the caller's image handle
1599 * @file_path: the path of the image to load
1600 * @source_buffer: memory location from which the image is installed
1601 * @source_size: size of the memory area from which the image is installed
1602 * @image_handle: handle for the newly installed image
1604 * This function implements the LoadImage service.
1606 * See the Unified Extensible Firmware Interface (UEFI) specification
1609 * Return: status code
1611 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1612 efi_handle_t parent_image,
1613 struct efi_device_path *file_path,
1614 void *source_buffer,
1615 efi_uintn_t source_size,
1616 efi_handle_t *image_handle)
1618 struct efi_loaded_image *info;
1619 struct efi_object *obj;
1622 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1623 file_path, source_buffer, source_size, image_handle);
1625 if (!image_handle || !parent_image) {
1626 ret = EFI_INVALID_PARAMETER;
1630 if (!source_buffer && !file_path) {
1631 ret = EFI_NOT_FOUND;
1635 info = calloc(1, sizeof(*info));
1637 ret = EFI_OUT_OF_RESOURCES;
1640 obj = calloc(1, sizeof(*obj));
1643 ret = EFI_OUT_OF_RESOURCES;
1647 if (!source_buffer) {
1648 struct efi_device_path *dp, *fp;
1650 ret = efi_load_image_from_path(file_path, &source_buffer);
1651 if (ret != EFI_SUCCESS)
1654 * split file_path which contains both the device and
1657 efi_dp_split_file_path(file_path, &dp, &fp);
1658 ret = efi_setup_loaded_image(info, obj, dp, fp);
1659 if (ret != EFI_SUCCESS)
1662 /* In this case, file_path is the "device" path, ie.
1663 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1665 ret = efi_setup_loaded_image(info, obj, file_path, NULL);
1666 if (ret != EFI_SUCCESS)
1669 info->reserved = efi_load_pe(source_buffer, info);
1670 if (!info->reserved) {
1671 ret = EFI_UNSUPPORTED;
1674 info->system_table = &systab;
1675 info->parent_handle = parent_image;
1676 *image_handle = obj->handle;
1677 return EFI_EXIT(EFI_SUCCESS);
1680 efi_delete_handle(obj);
1682 return EFI_EXIT(ret);
1686 * efi_start_image() - dall the entry point of an image
1687 * @image_handle: handle of the image
1688 * @exit_data_size: size of the buffer
1689 * @exit_data: buffer to receive the exit data of the called image
1691 * This function implements the StartImage service.
1693 * See the Unified Extensible Firmware Interface (UEFI) specification for
1696 * Return: status code
1698 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1699 unsigned long *exit_data_size,
1702 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
1703 struct efi_system_table *st);
1704 struct efi_loaded_image *info = image_handle;
1707 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1708 entry = info->reserved;
1710 efi_is_direct_boot = false;
1712 /* call the image! */
1713 if (setjmp(&info->exit_jmp)) {
1715 * We called the entry point of the child image with EFI_CALL
1716 * in the lines below. The child image called the Exit() boot
1717 * service efi_exit() which executed the long jump that brought
1718 * us to the current line. This implies that the second half
1719 * of the EFI_CALL macro has not been executed.
1723 * efi_exit() called efi_restore_gd(). We have to undo this
1724 * otherwise __efi_entry_check() will put the wrong value into
1730 * To get ready to call EFI_EXIT below we have to execute the
1731 * missed out steps of EFI_CALL.
1733 assert(__efi_entry_check());
1734 debug("%sEFI: %lu returned by started image\n",
1735 __efi_nesting_dec(),
1736 (unsigned long)((uintptr_t)info->exit_status &
1738 return EFI_EXIT(info->exit_status);
1741 ret = EFI_CALL(entry(image_handle, &systab));
1744 * Usually UEFI applications call Exit() instead of returning.
1745 * But because the world doesn not consist of ponies and unicorns,
1746 * we're happy to emulate that behavior on behalf of a payload
1749 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
1753 * efi_exit() - leave an EFI application or driver
1754 * @image_handle: handle of the application or driver that is exiting
1755 * @exit_status: status code
1756 * @exit_data_size: size of the buffer in bytes
1757 * @exit_data: buffer with data describing an error
1759 * This function implements the Exit service.
1761 * See the Unified Extensible Firmware Interface (UEFI) specification for
1764 * Return: status code
1766 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1767 efi_status_t exit_status,
1768 unsigned long exit_data_size,
1772 * We require that the handle points to the original loaded
1773 * image protocol interface.
1775 * For getting the longjmp address this is safer than locating
1776 * the protocol because the protocol may have been reinstalled
1777 * pointing to another memory location.
1779 * TODO: We should call the unload procedure of the loaded
1782 struct efi_loaded_image *loaded_image_info = (void *)image_handle;
1784 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1785 exit_data_size, exit_data);
1787 /* Make sure entry/exit counts for EFI world cross-overs match */
1788 EFI_EXIT(exit_status);
1791 * But longjmp out with the U-Boot gd, not the application's, as
1792 * the other end is a setjmp call inside EFI context.
1796 loaded_image_info->exit_status = exit_status;
1797 longjmp(&loaded_image_info->exit_jmp, 1);
1799 panic("EFI application exited");
1803 * efi_unload_image() - unload an EFI image
1804 * @image_handle: handle of the image to be unloaded
1806 * This function implements the UnloadImage service.
1808 * See the Unified Extensible Firmware Interface (UEFI) specification for
1811 * Return: status code
1813 static efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
1815 struct efi_object *efiobj;
1817 EFI_ENTRY("%p", image_handle);
1818 efiobj = efi_search_obj(image_handle);
1820 list_del(&efiobj->link);
1822 return EFI_EXIT(EFI_SUCCESS);
1826 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1828 static void efi_exit_caches(void)
1830 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1832 * Grub on 32bit ARM needs to have caches disabled before jumping into
1833 * a zImage, but does not know of all cache layers. Give it a hand.
1835 if (efi_is_direct_boot)
1836 cleanup_before_linux();
1841 * efi_exit_boot_services() - stop all boot services
1842 * @image_handle: handle of the loaded image
1843 * @map_key: key of the memory map
1845 * This function implements the ExitBootServices service.
1847 * See the Unified Extensible Firmware Interface (UEFI) specification
1850 * All timer events are disabled. For exit boot services events the
1851 * notification function is called. The boot services are disabled in the
1854 * Return: status code
1856 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1857 unsigned long map_key)
1859 struct efi_event *evt;
1861 EFI_ENTRY("%p, %ld", image_handle, map_key);
1863 /* Check that the caller has read the current memory map */
1864 if (map_key != efi_memory_map_key)
1865 return EFI_INVALID_PARAMETER;
1867 /* Make sure that notification functions are not called anymore */
1868 efi_tpl = TPL_HIGH_LEVEL;
1870 /* Check if ExitBootServices has already been called */
1871 if (!systab.boottime)
1872 return EFI_EXIT(EFI_SUCCESS);
1874 /* Add related events to the event group */
1875 list_for_each_entry(evt, &efi_events, link) {
1876 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1877 evt->group = &efi_guid_event_group_exit_boot_services;
1879 /* Notify that ExitBootServices is invoked. */
1880 list_for_each_entry(evt, &efi_events, link) {
1882 !guidcmp(evt->group,
1883 &efi_guid_event_group_exit_boot_services)) {
1884 efi_signal_event(evt, false);
1889 /* TODO Should persist EFI variables here */
1891 board_quiesce_devices();
1893 /* Fix up caches for EFI payloads if necessary */
1896 /* This stops all lingering devices */
1897 bootm_disable_interrupts();
1899 /* Disable boottime services */
1900 systab.con_in_handle = NULL;
1901 systab.con_in = NULL;
1902 systab.con_out_handle = NULL;
1903 systab.con_out = NULL;
1904 systab.stderr_handle = NULL;
1905 systab.std_err = NULL;
1906 systab.boottime = NULL;
1908 /* Recalculate CRC32 */
1909 efi_update_table_header_crc32(&systab.hdr);
1911 /* Give the payload some time to boot */
1912 efi_set_watchdog(0);
1915 return EFI_EXIT(EFI_SUCCESS);
1919 * efi_get_next_monotonic_count() - get next value of the counter
1920 * @count: returned value of the counter
1922 * This function implements the NextMonotonicCount service.
1924 * See the Unified Extensible Firmware Interface (UEFI) specification for
1927 * Return: status code
1929 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1931 static uint64_t mono;
1933 EFI_ENTRY("%p", count);
1935 return EFI_EXIT(EFI_SUCCESS);
1939 * efi_stall() - sleep
1940 * @microseconds: period to sleep in microseconds
1942 * This function implements the Stall service.
1944 * See the Unified Extensible Firmware Interface (UEFI) specification for
1947 * Return: status code
1949 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1951 EFI_ENTRY("%ld", microseconds);
1952 udelay(microseconds);
1953 return EFI_EXIT(EFI_SUCCESS);
1957 * efi_set_watchdog_timer() - reset the watchdog timer
1958 * @timeout: seconds before reset by watchdog
1959 * @watchdog_code: code to be logged when resetting
1960 * @data_size: size of buffer in bytes
1961 * @watchdog_data: buffer with data describing the reset reason
1963 * This function implements the SetWatchdogTimer service.
1965 * See the Unified Extensible Firmware Interface (UEFI) specification for
1968 * Return: status code
1970 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1971 uint64_t watchdog_code,
1972 unsigned long data_size,
1973 uint16_t *watchdog_data)
1975 EFI_ENTRY("%ld, 0x%" PRIx64 ", %ld, %p", timeout, watchdog_code,
1976 data_size, watchdog_data);
1977 return EFI_EXIT(efi_set_watchdog(timeout));
1981 * efi_close_protocol() - close a protocol
1982 * @handle: handle on which the protocol shall be closed
1983 * @protocol: GUID of the protocol to close
1984 * @agent_handle: handle of the driver
1985 * @controller_handle: handle of the controller
1987 * This function implements the CloseProtocol service.
1989 * See the Unified Extensible Firmware Interface (UEFI) specification for
1992 * Return: status code
1994 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
1995 const efi_guid_t *protocol,
1996 efi_handle_t agent_handle,
1997 efi_handle_t controller_handle)
1999 struct efi_handler *handler;
2000 struct efi_open_protocol_info_item *item;
2001 struct efi_open_protocol_info_item *pos;
2004 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2007 if (!agent_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_ALLOCATE_ANY_PAGES, 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_ALLOCATE_ANY_PAGES, 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_ALLOCATE_ANY_PAGES, 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->handle, 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 || !device) {
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))
2309 *device = handles[i];
2313 remainder = (u8 *)*device_path + len_best;
2314 *device_path = (struct efi_device_path *)remainder;
2317 ret = EFI_NOT_FOUND;
2320 return EFI_EXIT(ret);
2324 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2326 * @handle: handle on which the protocol interfaces shall be installed
2327 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2330 * This function implements the MultipleProtocolInterfaces service.
2332 * See the Unified Extensible Firmware Interface (UEFI) specification for
2335 * Return: status code
2337 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
2340 EFI_ENTRY("%p", handle);
2343 const efi_guid_t *protocol;
2344 void *protocol_interface;
2345 efi_status_t r = EFI_SUCCESS;
2349 return EFI_EXIT(EFI_INVALID_PARAMETER);
2351 efi_va_start(argptr, handle);
2353 protocol = efi_va_arg(argptr, efi_guid_t*);
2356 protocol_interface = efi_va_arg(argptr, void*);
2357 r = EFI_CALL(efi_install_protocol_interface(
2359 EFI_NATIVE_INTERFACE,
2360 protocol_interface));
2361 if (r != EFI_SUCCESS)
2366 if (r == EFI_SUCCESS)
2369 /* If an error occurred undo all changes. */
2370 efi_va_start(argptr, handle);
2372 protocol = efi_va_arg(argptr, efi_guid_t*);
2373 protocol_interface = efi_va_arg(argptr, void*);
2374 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2375 protocol_interface));
2383 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2385 * @handle: handle from which the protocol interfaces shall be removed
2386 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2389 * This function implements the UninstallMultipleProtocolInterfaces service.
2391 * See the Unified Extensible Firmware Interface (UEFI) specification for
2394 * Return: status code
2396 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2399 EFI_ENTRY("%p", handle);
2402 const efi_guid_t *protocol;
2403 void *protocol_interface;
2404 efi_status_t r = EFI_SUCCESS;
2408 return EFI_EXIT(EFI_INVALID_PARAMETER);
2410 efi_va_start(argptr, handle);
2412 protocol = efi_va_arg(argptr, efi_guid_t*);
2415 protocol_interface = efi_va_arg(argptr, void*);
2416 r = EFI_CALL(efi_uninstall_protocol_interface(
2418 protocol_interface));
2419 if (r != EFI_SUCCESS)
2424 if (r == EFI_SUCCESS)
2427 /* If an error occurred undo all changes. */
2428 efi_va_start(argptr, handle);
2430 protocol = efi_va_arg(argptr, efi_guid_t*);
2431 protocol_interface = efi_va_arg(argptr, void*);
2432 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2433 EFI_NATIVE_INTERFACE,
2434 protocol_interface));
2442 * efi_calculate_crc32() - calculate cyclic redundancy code
2443 * @data: buffer with data
2444 * @data_size: size of buffer in bytes
2445 * @crc32_p: cyclic redundancy code
2447 * This function implements the CalculateCrc32 service.
2449 * See the Unified Extensible Firmware Interface (UEFI) specification for
2452 * Return: status code
2454 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2455 efi_uintn_t data_size,
2458 EFI_ENTRY("%p, %zu", data, data_size);
2459 *crc32_p = crc32(0, data, data_size);
2460 return EFI_EXIT(EFI_SUCCESS);
2464 * efi_copy_mem() - copy memory
2465 * @destination: destination of the copy operation
2466 * @source: source of the copy operation
2467 * @length: number of bytes to copy
2469 * This function implements the CopyMem service.
2471 * See the Unified Extensible Firmware Interface (UEFI) specification for
2474 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2477 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2478 memcpy(destination, source, length);
2479 EFI_EXIT(EFI_SUCCESS);
2483 * efi_set_mem() - Fill memory with a byte value.
2484 * @buffer: buffer to fill
2485 * @size: size of buffer in bytes
2486 * @value: byte to copy to the buffer
2488 * This function implements the SetMem service.
2490 * See the Unified Extensible Firmware Interface (UEFI) specification for
2493 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2495 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2496 memset(buffer, value, size);
2497 EFI_EXIT(EFI_SUCCESS);
2501 * efi_protocol_open() - open protocol interface on a handle
2502 * @handler: handler of a protocol
2503 * @protocol_interface: interface implementing the protocol
2504 * @agent_handle: handle of the driver
2505 * @controller_handle: handle of the controller
2506 * @attributes: attributes indicating how to open the protocol
2508 * Return: status code
2510 static efi_status_t efi_protocol_open(
2511 struct efi_handler *handler,
2512 void **protocol_interface, void *agent_handle,
2513 void *controller_handle, uint32_t attributes)
2515 struct efi_open_protocol_info_item *item;
2516 struct efi_open_protocol_info_entry *match = NULL;
2517 bool opened_by_driver = false;
2518 bool opened_exclusive = false;
2520 /* If there is no agent, only return the interface */
2524 /* For TEST_PROTOCOL ignore interface attribute */
2525 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2526 *protocol_interface = NULL;
2529 * Check if the protocol is already opened by a driver with the same
2530 * attributes or opened exclusively
2532 list_for_each_entry(item, &handler->open_infos, link) {
2533 if (item->info.agent_handle == agent_handle) {
2534 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2535 (item->info.attributes == attributes))
2536 return EFI_ALREADY_STARTED;
2538 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2539 opened_exclusive = true;
2542 /* Only one controller can open the protocol exclusively */
2543 if (opened_exclusive && attributes &
2544 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2545 return EFI_ACCESS_DENIED;
2547 /* Prepare exclusive opening */
2548 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2549 /* Try to disconnect controllers */
2550 list_for_each_entry(item, &handler->open_infos, link) {
2551 if (item->info.attributes ==
2552 EFI_OPEN_PROTOCOL_BY_DRIVER)
2553 EFI_CALL(efi_disconnect_controller(
2554 item->info.controller_handle,
2555 item->info.agent_handle,
2558 opened_by_driver = false;
2559 /* Check if all controllers are disconnected */
2560 list_for_each_entry(item, &handler->open_infos, link) {
2561 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2562 opened_by_driver = true;
2564 /* Only one controller can be conncected */
2565 if (opened_by_driver)
2566 return EFI_ACCESS_DENIED;
2569 /* Find existing entry */
2570 list_for_each_entry(item, &handler->open_infos, link) {
2571 if (item->info.agent_handle == agent_handle &&
2572 item->info.controller_handle == controller_handle)
2573 match = &item->info;
2575 /* None found, create one */
2577 match = efi_create_open_info(handler);
2579 return EFI_OUT_OF_RESOURCES;
2582 match->agent_handle = agent_handle;
2583 match->controller_handle = controller_handle;
2584 match->attributes = attributes;
2585 match->open_count++;
2588 /* For TEST_PROTOCOL ignore interface attribute. */
2589 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2590 *protocol_interface = handler->protocol_interface;
2596 * efi_open_protocol() - open protocol interface on a handle
2597 * @handle: handle on which the protocol shall be opened
2598 * @protocol: GUID of the protocol
2599 * @protocol_interface: interface implementing the protocol
2600 * @agent_handle: handle of the driver
2601 * @controller_handle: handle of the controller
2602 * @attributes: attributes indicating how to open the protocol
2604 * This function implements the OpenProtocol interface.
2606 * See the Unified Extensible Firmware Interface (UEFI) specification for
2609 * Return: status code
2611 static efi_status_t EFIAPI efi_open_protocol(
2612 void *handle, const efi_guid_t *protocol,
2613 void **protocol_interface, void *agent_handle,
2614 void *controller_handle, uint32_t attributes)
2616 struct efi_handler *handler;
2617 efi_status_t r = EFI_INVALID_PARAMETER;
2619 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2620 protocol_interface, agent_handle, controller_handle,
2623 if (!handle || !protocol ||
2624 (!protocol_interface && attributes !=
2625 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2629 switch (attributes) {
2630 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2631 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2632 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2634 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2635 if (controller_handle == handle)
2638 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2639 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2640 /* Check that the controller handle is valid */
2641 if (!efi_search_obj(controller_handle))
2644 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2645 /* Check that the agent handle is valid */
2646 if (!efi_search_obj(agent_handle))
2653 r = efi_search_protocol(handle, protocol, &handler);
2654 if (r != EFI_SUCCESS)
2657 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2658 controller_handle, attributes);
2664 * efi_handle_protocol() - get interface of a protocol on a handle
2665 * @handle: handle on which the protocol shall be opened
2666 * @protocol: GUID of the protocol
2667 * @protocol_interface: interface implementing the protocol
2669 * This function implements the HandleProtocol service.
2671 * See the Unified Extensible Firmware Interface (UEFI) specification for
2674 * Return: status code
2676 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
2677 const efi_guid_t *protocol,
2678 void **protocol_interface)
2680 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2681 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2685 * efi_bind_controller() - bind a single driver to a controller
2686 * @controller_handle: controller handle
2687 * @driver_image_handle: driver handle
2688 * @remain_device_path: remaining path
2690 * Return: status code
2692 static efi_status_t efi_bind_controller(
2693 efi_handle_t controller_handle,
2694 efi_handle_t driver_image_handle,
2695 struct efi_device_path *remain_device_path)
2697 struct efi_driver_binding_protocol *binding_protocol;
2700 r = EFI_CALL(efi_open_protocol(driver_image_handle,
2701 &efi_guid_driver_binding_protocol,
2702 (void **)&binding_protocol,
2703 driver_image_handle, NULL,
2704 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2705 if (r != EFI_SUCCESS)
2707 r = EFI_CALL(binding_protocol->supported(binding_protocol,
2709 remain_device_path));
2710 if (r == EFI_SUCCESS)
2711 r = EFI_CALL(binding_protocol->start(binding_protocol,
2713 remain_device_path));
2714 EFI_CALL(efi_close_protocol(driver_image_handle,
2715 &efi_guid_driver_binding_protocol,
2716 driver_image_handle, NULL));
2721 * efi_connect_single_controller() - connect a single driver to a controller
2722 * @controller_handle: controller
2723 * @driver_image_handle: driver
2724 * @remain_device_path: remainting path
2726 * Return: status code
2728 static efi_status_t efi_connect_single_controller(
2729 efi_handle_t controller_handle,
2730 efi_handle_t *driver_image_handle,
2731 struct efi_device_path *remain_device_path)
2733 efi_handle_t *buffer;
2737 size_t connected = 0;
2739 /* Get buffer with all handles with driver binding protocol */
2740 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
2741 &efi_guid_driver_binding_protocol,
2742 NULL, &count, &buffer));
2743 if (r != EFI_SUCCESS)
2746 /* Context Override */
2747 if (driver_image_handle) {
2748 for (; *driver_image_handle; ++driver_image_handle) {
2749 for (i = 0; i < count; ++i) {
2750 if (buffer[i] == *driver_image_handle) {
2752 r = efi_bind_controller(
2754 *driver_image_handle,
2755 remain_device_path);
2757 * For drivers that do not support the
2758 * controller or are already connected
2759 * we receive an error code here.
2761 if (r == EFI_SUCCESS)
2769 * TODO: Some overrides are not yet implemented:
2770 * - Platform Driver Override
2771 * - Driver Family Override Search
2772 * - Bus Specific Driver Override
2775 /* Driver Binding Search */
2776 for (i = 0; i < count; ++i) {
2778 r = efi_bind_controller(controller_handle,
2780 remain_device_path);
2781 if (r == EFI_SUCCESS)
2786 efi_free_pool(buffer);
2788 return EFI_NOT_FOUND;
2793 * efi_connect_controller() - connect a controller to a driver
2794 * @controller_handle: handle of the controller
2795 * @driver_image_handle: handle of the driver
2796 * @remain_device_path: device path of a child controller
2797 * @recursive: true to connect all child controllers
2799 * This function implements the ConnectController service.
2801 * See the Unified Extensible Firmware Interface (UEFI) specification for
2804 * First all driver binding protocol handles are tried for binding drivers.
2805 * Afterwards all handles that have openened a protocol of the controller
2806 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
2808 * Return: status code
2810 static efi_status_t EFIAPI efi_connect_controller(
2811 efi_handle_t controller_handle,
2812 efi_handle_t *driver_image_handle,
2813 struct efi_device_path *remain_device_path,
2817 efi_status_t ret = EFI_NOT_FOUND;
2818 struct efi_object *efiobj;
2820 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
2821 remain_device_path, recursive);
2823 efiobj = efi_search_obj(controller_handle);
2825 ret = EFI_INVALID_PARAMETER;
2829 r = efi_connect_single_controller(controller_handle,
2830 driver_image_handle,
2831 remain_device_path);
2832 if (r == EFI_SUCCESS)
2835 struct efi_handler *handler;
2836 struct efi_open_protocol_info_item *item;
2838 list_for_each_entry(handler, &efiobj->protocols, link) {
2839 list_for_each_entry(item, &handler->open_infos, link) {
2840 if (item->info.attributes &
2841 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2842 r = EFI_CALL(efi_connect_controller(
2843 item->info.controller_handle,
2844 driver_image_handle,
2847 if (r == EFI_SUCCESS)
2853 /* Check for child controller specified by end node */
2854 if (ret != EFI_SUCCESS && remain_device_path &&
2855 remain_device_path->type == DEVICE_PATH_TYPE_END)
2858 return EFI_EXIT(ret);
2862 * efi_reinstall_protocol_interface() - reinstall protocol interface
2863 * @handle: handle on which the protocol shall be reinstalled
2864 * @protocol: GUID of the protocol to be installed
2865 * @old_interface: interface to be removed
2866 * @new_interface: interface to be installed
2868 * This function implements the ReinstallProtocolInterface service.
2870 * See the Unified Extensible Firmware Interface (UEFI) specification for
2873 * The old interface is uninstalled. The new interface is installed.
2874 * Drivers are connected.
2876 * Return: status code
2878 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
2879 efi_handle_t handle, const efi_guid_t *protocol,
2880 void *old_interface, void *new_interface)
2884 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
2886 ret = EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
2888 if (ret != EFI_SUCCESS)
2890 ret = EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2891 EFI_NATIVE_INTERFACE,
2893 if (ret != EFI_SUCCESS)
2896 * The returned status code has to be ignored.
2897 * Do not create an error if no suitable driver for the handle exists.
2899 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
2901 return EFI_EXIT(ret);
2905 * efi_get_child_controllers() - get all child controllers associated to a driver
2906 * @efiobj: handle of the controller
2907 * @driver_handle: handle of the driver
2908 * @number_of_children: number of child controllers
2909 * @child_handle_buffer: handles of the the child controllers
2911 * The allocated buffer has to be freed with free().
2913 * Return: status code
2915 static efi_status_t efi_get_child_controllers(
2916 struct efi_object *efiobj,
2917 efi_handle_t driver_handle,
2918 efi_uintn_t *number_of_children,
2919 efi_handle_t **child_handle_buffer)
2921 struct efi_handler *handler;
2922 struct efi_open_protocol_info_item *item;
2923 efi_uintn_t count = 0, i;
2926 /* Count all child controller associations */
2927 list_for_each_entry(handler, &efiobj->protocols, link) {
2928 list_for_each_entry(item, &handler->open_infos, link) {
2929 if (item->info.agent_handle == driver_handle &&
2930 item->info.attributes &
2931 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
2936 * Create buffer. In case of duplicate child controller assignments
2937 * the buffer will be too large. But that does not harm.
2939 *number_of_children = 0;
2940 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
2941 if (!*child_handle_buffer)
2942 return EFI_OUT_OF_RESOURCES;
2943 /* Copy unique child handles */
2944 list_for_each_entry(handler, &efiobj->protocols, link) {
2945 list_for_each_entry(item, &handler->open_infos, link) {
2946 if (item->info.agent_handle == driver_handle &&
2947 item->info.attributes &
2948 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
2949 /* Check this is a new child controller */
2951 for (i = 0; i < *number_of_children; ++i) {
2952 if ((*child_handle_buffer)[i] ==
2953 item->info.controller_handle)
2956 /* Copy handle to buffer */
2958 i = (*number_of_children)++;
2959 (*child_handle_buffer)[i] =
2960 item->info.controller_handle;
2969 * efi_disconnect_controller() - disconnect a controller from a driver
2970 * @controller_handle: handle of the controller
2971 * @driver_image_handle: handle of the driver
2972 * @child_handle: handle of the child to destroy
2974 * This function implements the DisconnectController service.
2976 * See the Unified Extensible Firmware Interface (UEFI) specification for
2979 * Return: status code
2981 static efi_status_t EFIAPI efi_disconnect_controller(
2982 efi_handle_t controller_handle,
2983 efi_handle_t driver_image_handle,
2984 efi_handle_t child_handle)
2986 struct efi_driver_binding_protocol *binding_protocol;
2987 efi_handle_t *child_handle_buffer = NULL;
2988 size_t number_of_children = 0;
2990 size_t stop_count = 0;
2991 struct efi_object *efiobj;
2993 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
2996 efiobj = efi_search_obj(controller_handle);
2998 r = EFI_INVALID_PARAMETER;
3002 if (child_handle && !efi_search_obj(child_handle)) {
3003 r = EFI_INVALID_PARAMETER;
3007 /* If no driver handle is supplied, disconnect all drivers */
3008 if (!driver_image_handle) {
3009 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3013 /* Create list of child handles */
3015 number_of_children = 1;
3016 child_handle_buffer = &child_handle;
3018 efi_get_child_controllers(efiobj,
3019 driver_image_handle,
3020 &number_of_children,
3021 &child_handle_buffer);
3024 /* Get the driver binding protocol */
3025 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3026 &efi_guid_driver_binding_protocol,
3027 (void **)&binding_protocol,
3028 driver_image_handle, NULL,
3029 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3030 if (r != EFI_SUCCESS)
3032 /* Remove the children */
3033 if (number_of_children) {
3034 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3037 child_handle_buffer));
3038 if (r == EFI_SUCCESS)
3041 /* Remove the driver */
3043 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3046 if (r == EFI_SUCCESS)
3048 EFI_CALL(efi_close_protocol(driver_image_handle,
3049 &efi_guid_driver_binding_protocol,
3050 driver_image_handle, NULL));
3058 free(child_handle_buffer);
3062 static struct efi_boot_services efi_boot_services = {
3064 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3065 .revision = EFI_SPECIFICATION_VERSION,
3066 .headersize = sizeof(struct efi_boot_services),
3068 .raise_tpl = efi_raise_tpl,
3069 .restore_tpl = efi_restore_tpl,
3070 .allocate_pages = efi_allocate_pages_ext,
3071 .free_pages = efi_free_pages_ext,
3072 .get_memory_map = efi_get_memory_map_ext,
3073 .allocate_pool = efi_allocate_pool_ext,
3074 .free_pool = efi_free_pool_ext,
3075 .create_event = efi_create_event_ext,
3076 .set_timer = efi_set_timer_ext,
3077 .wait_for_event = efi_wait_for_event,
3078 .signal_event = efi_signal_event_ext,
3079 .close_event = efi_close_event,
3080 .check_event = efi_check_event,
3081 .install_protocol_interface = efi_install_protocol_interface,
3082 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3083 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3084 .handle_protocol = efi_handle_protocol,
3086 .register_protocol_notify = efi_register_protocol_notify,
3087 .locate_handle = efi_locate_handle_ext,
3088 .locate_device_path = efi_locate_device_path,
3089 .install_configuration_table = efi_install_configuration_table_ext,
3090 .load_image = efi_load_image,
3091 .start_image = efi_start_image,
3093 .unload_image = efi_unload_image,
3094 .exit_boot_services = efi_exit_boot_services,
3095 .get_next_monotonic_count = efi_get_next_monotonic_count,
3097 .set_watchdog_timer = efi_set_watchdog_timer,
3098 .connect_controller = efi_connect_controller,
3099 .disconnect_controller = efi_disconnect_controller,
3100 .open_protocol = efi_open_protocol,
3101 .close_protocol = efi_close_protocol,
3102 .open_protocol_information = efi_open_protocol_information,
3103 .protocols_per_handle = efi_protocols_per_handle,
3104 .locate_handle_buffer = efi_locate_handle_buffer,
3105 .locate_protocol = efi_locate_protocol,
3106 .install_multiple_protocol_interfaces =
3107 efi_install_multiple_protocol_interfaces,
3108 .uninstall_multiple_protocol_interfaces =
3109 efi_uninstall_multiple_protocol_interfaces,
3110 .calculate_crc32 = efi_calculate_crc32,
3111 .copy_mem = efi_copy_mem,
3112 .set_mem = efi_set_mem,
3113 .create_event_ex = efi_create_event_ex,
3116 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3118 struct efi_system_table __efi_runtime_data systab = {
3120 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3121 .revision = EFI_SPECIFICATION_VERSION,
3122 .headersize = sizeof(struct efi_system_table),
3124 .fw_vendor = firmware_vendor,
3125 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3126 .con_in = (void *)&efi_con_in,
3127 .con_out = (void *)&efi_con_out,
3128 .std_err = (void *)&efi_con_out,
3129 .runtime = (void *)&efi_runtime_services,
3130 .boottime = (void *)&efi_boot_services,
3136 * efi_initialize_system_table() - Initialize system table
3138 * Return Value: status code
3140 efi_status_t efi_initialize_system_table(void)
3144 /* Allocate configuration table array */
3145 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3146 EFI_MAX_CONFIGURATION_TABLES *
3147 sizeof(struct efi_configuration_table),
3148 (void **)&systab.tables);
3150 /* Set crc32 field in table headers */
3151 efi_update_table_header_crc32(&systab.hdr);
3152 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3153 efi_update_table_header_crc32(&efi_boot_services.hdr);