1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application boot time services
5 * Copyright (c) 2016 Alexander Graf
10 #include <efi_loader.h>
11 #include <environment.h>
13 #include <linux/libfdt_env.h>
14 #include <u-boot/crc.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 /* Task priority level */
22 static efi_uintn_t efi_tpl = TPL_APPLICATION;
24 /* This list contains all the EFI objects our payload has access to */
25 LIST_HEAD(efi_obj_list);
27 /* List of all events */
28 LIST_HEAD(efi_events);
30 /* List of all events registered by RegisterProtocolNotify() */
31 LIST_HEAD(efi_register_notify_events);
33 /* Handle of the currently executing image */
34 static efi_handle_t current_image;
37 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
38 * we need to do trickery with caches. Since we don't want to break the EFI
39 * aware boot path, only apply hacks when loading exiting directly (breaking
40 * direct Linux EFI booting along the way - oh well).
42 static bool efi_is_direct_boot = true;
46 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
47 * fixed when compiling U-Boot. However, the payload does not know about that
48 * restriction so we need to manually swap its and our view of that register on
49 * EFI callback entry/exit.
51 static volatile void *efi_gd, *app_gd;
54 /* 1 if inside U-Boot code, 0 if inside EFI payload code */
55 static int entry_count = 1;
56 static int nesting_level;
57 /* GUID of the device tree table */
58 const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
59 /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
60 const efi_guid_t efi_guid_driver_binding_protocol =
61 EFI_DRIVER_BINDING_PROTOCOL_GUID;
63 /* event group ExitBootServices() invoked */
64 const efi_guid_t efi_guid_event_group_exit_boot_services =
65 EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
66 /* event group SetVirtualAddressMap() invoked */
67 const efi_guid_t efi_guid_event_group_virtual_address_change =
68 EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
69 /* event group memory map changed */
70 const efi_guid_t efi_guid_event_group_memory_map_change =
71 EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
72 /* event group boot manager about to boot */
73 const efi_guid_t efi_guid_event_group_ready_to_boot =
74 EFI_EVENT_GROUP_READY_TO_BOOT;
75 /* event group ResetSystem() invoked (before ExitBootServices) */
76 const efi_guid_t efi_guid_event_group_reset_system =
77 EFI_EVENT_GROUP_RESET_SYSTEM;
79 static efi_status_t EFIAPI efi_disconnect_controller(
80 efi_handle_t controller_handle,
81 efi_handle_t driver_image_handle,
82 efi_handle_t child_handle);
84 /* Called on every callback entry */
85 int __efi_entry_check(void)
87 int ret = entry_count++ == 0;
96 /* Called on every callback exit */
97 int __efi_exit_check(void)
99 int ret = --entry_count == 0;
106 /* Called from do_bootefi_exec() */
107 void efi_save_gd(void)
115 * Special case handler for error/abort that just forces things back to u-boot
116 * world so we can dump out an abort message, without any care about returning
117 * back to UEFI world.
119 void efi_restore_gd(void)
122 /* Only restore if we're already in EFI context */
130 * indent_string() - returns a string for indenting with two spaces per level
131 * @level: indent level
133 * A maximum of ten indent levels is supported. Higher indent levels will be
136 * Return: A string for indenting with two spaces per level is
139 static const char *indent_string(int level)
141 const char *indent = " ";
142 const int max = strlen(indent);
144 level = min(max, level * 2);
145 return &indent[max - level];
148 const char *__efi_nesting(void)
150 return indent_string(nesting_level);
153 const char *__efi_nesting_inc(void)
155 return indent_string(nesting_level++);
158 const char *__efi_nesting_dec(void)
160 return indent_string(--nesting_level);
164 * efi_queue_event() - queue an EFI event
165 * @event: event to signal
166 * @check_tpl: check the TPL level
168 * This function queues the notification function of the event for future
171 * The notification function is called if the task priority level of the event
172 * is higher than the current task priority level.
174 * For the SignalEvent service see efi_signal_event_ext.
177 static void efi_queue_event(struct efi_event *event, bool check_tpl)
179 if (event->notify_function) {
180 event->is_queued = true;
182 if (check_tpl && efi_tpl >= event->notify_tpl)
184 event->is_queued = false;
185 EFI_CALL_VOID(event->notify_function(event,
186 event->notify_context));
188 event->is_queued = false;
193 * is_valid_tpl() - check if the task priority level is valid
195 * @tpl: TPL level to check
196 * Return: status code
198 efi_status_t is_valid_tpl(efi_uintn_t tpl)
201 case TPL_APPLICATION:
207 return EFI_INVALID_PARAMETER;
212 * efi_signal_event() - signal an EFI event
213 * @event: event to signal
214 * @check_tpl: check the TPL level
216 * This function signals an event. If the event belongs to an event group all
217 * events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
218 * their notification function is queued.
220 * For the SignalEvent service see efi_signal_event_ext.
222 void efi_signal_event(struct efi_event *event, bool check_tpl)
225 struct efi_event *evt;
228 * The signaled state has to set before executing any
229 * notification function
231 list_for_each_entry(evt, &efi_events, link) {
232 if (!evt->group || guidcmp(evt->group, event->group))
234 if (evt->is_signaled)
236 evt->is_signaled = true;
237 if (evt->type & EVT_NOTIFY_SIGNAL &&
238 evt->notify_function)
239 evt->is_queued = true;
241 list_for_each_entry(evt, &efi_events, link) {
242 if (!evt->group || guidcmp(evt->group, event->group))
245 efi_queue_event(evt, check_tpl);
248 event->is_signaled = true;
249 if (event->type & EVT_NOTIFY_SIGNAL)
250 efi_queue_event(event, check_tpl);
255 * efi_raise_tpl() - raise the task priority level
256 * @new_tpl: new value of the task priority level
258 * This function implements the RaiseTpl service.
260 * See the Unified Extensible Firmware Interface (UEFI) specification for
263 * Return: old value of the task priority level
265 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
267 efi_uintn_t old_tpl = efi_tpl;
269 EFI_ENTRY("0x%zx", new_tpl);
271 if (new_tpl < efi_tpl)
272 EFI_PRINT("WARNING: new_tpl < current_tpl in %s\n", __func__);
274 if (efi_tpl > TPL_HIGH_LEVEL)
275 efi_tpl = TPL_HIGH_LEVEL;
277 EFI_EXIT(EFI_SUCCESS);
282 * efi_restore_tpl() - lower the task priority level
283 * @old_tpl: value of the task priority level to be restored
285 * This function implements the RestoreTpl service.
287 * See the Unified Extensible Firmware Interface (UEFI) specification for
290 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
292 EFI_ENTRY("0x%zx", old_tpl);
294 if (old_tpl > efi_tpl)
295 EFI_PRINT("WARNING: old_tpl > current_tpl in %s\n", __func__);
297 if (efi_tpl > TPL_HIGH_LEVEL)
298 efi_tpl = TPL_HIGH_LEVEL;
301 * Lowering the TPL may have made queued events eligible for execution.
305 EFI_EXIT(EFI_SUCCESS);
309 * efi_allocate_pages_ext() - allocate memory pages
310 * @type: type of allocation to be performed
311 * @memory_type: usage type of the allocated memory
312 * @pages: number of pages to be allocated
313 * @memory: allocated memory
315 * This function implements the AllocatePages service.
317 * See the Unified Extensible Firmware Interface (UEFI) specification for
320 * Return: status code
322 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
328 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
329 r = efi_allocate_pages(type, memory_type, pages, memory);
334 * efi_free_pages_ext() - Free memory pages.
335 * @memory: start of the memory area to be freed
336 * @pages: number of pages to be freed
338 * This function implements the FreePages service.
340 * See the Unified Extensible Firmware Interface (UEFI) specification for
343 * Return: status code
345 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
350 EFI_ENTRY("%llx, 0x%zx", memory, pages);
351 r = efi_free_pages(memory, pages);
356 * efi_get_memory_map_ext() - get map describing memory usage
357 * @memory_map_size: on entry the size, in bytes, of the memory map buffer,
358 * on exit the size of the copied memory map
359 * @memory_map: buffer to which the memory map is written
360 * @map_key: key for the memory map
361 * @descriptor_size: size of an individual memory descriptor
362 * @descriptor_version: version number of the memory descriptor structure
364 * This function implements the GetMemoryMap service.
366 * See the Unified Extensible Firmware Interface (UEFI) specification for
369 * Return: status code
371 static efi_status_t EFIAPI efi_get_memory_map_ext(
372 efi_uintn_t *memory_map_size,
373 struct efi_mem_desc *memory_map,
374 efi_uintn_t *map_key,
375 efi_uintn_t *descriptor_size,
376 uint32_t *descriptor_version)
380 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
381 map_key, descriptor_size, descriptor_version);
382 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
383 descriptor_size, descriptor_version);
388 * efi_allocate_pool_ext() - allocate memory from pool
389 * @pool_type: type of the pool from which memory is to be allocated
390 * @size: number of bytes to be allocated
391 * @buffer: allocated memory
393 * This function implements the AllocatePool service.
395 * See the Unified Extensible Firmware Interface (UEFI) specification for
398 * Return: status code
400 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
406 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
407 r = efi_allocate_pool(pool_type, size, buffer);
412 * efi_free_pool_ext() - free memory from pool
413 * @buffer: start of memory to be freed
415 * This function implements the FreePool service.
417 * See the Unified Extensible Firmware Interface (UEFI) specification for
420 * Return: status code
422 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
426 EFI_ENTRY("%p", buffer);
427 r = efi_free_pool(buffer);
432 * efi_add_handle() - add a new handle to the object list
434 * @handle: handle to be added
436 * The protocols list is initialized. The handle is added to the list of known
439 void efi_add_handle(efi_handle_t handle)
443 INIT_LIST_HEAD(&handle->protocols);
444 list_add_tail(&handle->link, &efi_obj_list);
448 * efi_create_handle() - create handle
449 * @handle: new handle
451 * Return: status code
453 efi_status_t efi_create_handle(efi_handle_t *handle)
455 struct efi_object *obj;
457 obj = calloc(1, sizeof(struct efi_object));
459 return EFI_OUT_OF_RESOURCES;
468 * efi_search_protocol() - find a protocol on a handle.
470 * @protocol_guid: GUID of the protocol
471 * @handler: reference to the protocol
473 * Return: status code
475 efi_status_t efi_search_protocol(const efi_handle_t handle,
476 const efi_guid_t *protocol_guid,
477 struct efi_handler **handler)
479 struct efi_object *efiobj;
480 struct list_head *lhandle;
482 if (!handle || !protocol_guid)
483 return EFI_INVALID_PARAMETER;
484 efiobj = efi_search_obj(handle);
486 return EFI_INVALID_PARAMETER;
487 list_for_each(lhandle, &efiobj->protocols) {
488 struct efi_handler *protocol;
490 protocol = list_entry(lhandle, struct efi_handler, link);
491 if (!guidcmp(protocol->guid, protocol_guid)) {
497 return EFI_NOT_FOUND;
501 * efi_remove_protocol() - delete protocol from a handle
502 * @handle: handle from which the protocol shall be deleted
503 * @protocol: GUID of the protocol to be deleted
504 * @protocol_interface: interface of the protocol implementation
506 * Return: status code
508 efi_status_t efi_remove_protocol(const efi_handle_t handle,
509 const efi_guid_t *protocol,
510 void *protocol_interface)
512 struct efi_handler *handler;
515 ret = efi_search_protocol(handle, protocol, &handler);
516 if (ret != EFI_SUCCESS)
518 if (handler->protocol_interface != protocol_interface)
519 return EFI_NOT_FOUND;
520 list_del(&handler->link);
526 * efi_remove_all_protocols() - delete all protocols from a handle
527 * @handle: handle from which the protocols shall be deleted
529 * Return: status code
531 efi_status_t efi_remove_all_protocols(const efi_handle_t handle)
533 struct efi_object *efiobj;
534 struct efi_handler *protocol;
535 struct efi_handler *pos;
537 efiobj = efi_search_obj(handle);
539 return EFI_INVALID_PARAMETER;
540 list_for_each_entry_safe(protocol, pos, &efiobj->protocols, link) {
543 ret = efi_remove_protocol(handle, protocol->guid,
544 protocol->protocol_interface);
545 if (ret != EFI_SUCCESS)
552 * efi_delete_handle() - delete handle
554 * @obj: handle to delete
556 void efi_delete_handle(efi_handle_t handle)
560 efi_remove_all_protocols(handle);
561 list_del(&handle->link);
566 * efi_is_event() - check if a pointer is a valid event
567 * @event: pointer to check
569 * Return: status code
571 static efi_status_t efi_is_event(const struct efi_event *event)
573 const struct efi_event *evt;
576 return EFI_INVALID_PARAMETER;
577 list_for_each_entry(evt, &efi_events, link) {
581 return EFI_INVALID_PARAMETER;
585 * efi_create_event() - create an event
586 * @type: type of the event to create
587 * @notify_tpl: task priority level of the event
588 * @notify_function: notification function of the event
589 * @notify_context: pointer passed to the notification function
590 * @group: event group
591 * @event: created event
593 * This function is used inside U-Boot code to create an event.
595 * For the API function implementing the CreateEvent service see
596 * efi_create_event_ext.
598 * Return: status code
600 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
601 void (EFIAPI *notify_function) (
602 struct efi_event *event,
604 void *notify_context, efi_guid_t *group,
605 struct efi_event **event)
607 struct efi_event *evt;
610 return EFI_INVALID_PARAMETER;
615 case EVT_NOTIFY_SIGNAL:
616 case EVT_TIMER | EVT_NOTIFY_SIGNAL:
617 case EVT_NOTIFY_WAIT:
618 case EVT_TIMER | EVT_NOTIFY_WAIT:
619 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
620 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
623 return EFI_INVALID_PARAMETER;
626 if ((type & (EVT_NOTIFY_WAIT | EVT_NOTIFY_SIGNAL)) &&
627 (!notify_function || is_valid_tpl(notify_tpl) != EFI_SUCCESS))
628 return EFI_INVALID_PARAMETER;
630 evt = calloc(1, sizeof(struct efi_event));
632 return EFI_OUT_OF_RESOURCES;
634 evt->notify_tpl = notify_tpl;
635 evt->notify_function = notify_function;
636 evt->notify_context = notify_context;
638 /* Disable timers on boot up */
639 evt->trigger_next = -1ULL;
640 evt->is_queued = false;
641 evt->is_signaled = false;
642 list_add_tail(&evt->link, &efi_events);
648 * efi_create_event_ex() - create an event in a group
649 * @type: type of the event to create
650 * @notify_tpl: task priority level of the event
651 * @notify_function: notification function of the event
652 * @notify_context: pointer passed to the notification function
653 * @event: created event
654 * @event_group: event group
656 * This function implements the CreateEventEx service.
658 * See the Unified Extensible Firmware Interface (UEFI) specification for
661 * Return: status code
663 efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
664 void (EFIAPI *notify_function) (
665 struct efi_event *event,
667 void *notify_context,
668 efi_guid_t *event_group,
669 struct efi_event **event)
673 EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
674 notify_context, event_group);
677 * The allowable input parameters are the same as in CreateEvent()
678 * except for the following two disallowed event types.
681 case EVT_SIGNAL_EXIT_BOOT_SERVICES:
682 case EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE:
683 ret = EFI_INVALID_PARAMETER;
687 ret = efi_create_event(type, notify_tpl, notify_function,
688 notify_context, event_group, event);
690 return EFI_EXIT(ret);
694 * efi_create_event_ext() - create an event
695 * @type: type of the event to create
696 * @notify_tpl: task priority level of the event
697 * @notify_function: notification function of the event
698 * @notify_context: pointer passed to the notification function
699 * @event: created event
701 * This function implements the CreateEvent service.
703 * See the Unified Extensible Firmware Interface (UEFI) specification for
706 * Return: status code
708 static efi_status_t EFIAPI efi_create_event_ext(
709 uint32_t type, efi_uintn_t notify_tpl,
710 void (EFIAPI *notify_function) (
711 struct efi_event *event,
713 void *notify_context, struct efi_event **event)
715 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
717 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
718 notify_context, NULL, event));
722 * efi_timer_check() - check if a timer event has occurred
724 * Check if a timer event has occurred or a queued notification function should
727 * Our timers have to work without interrupts, so we check whenever keyboard
728 * input or disk accesses happen if enough time elapsed for them to fire.
730 void efi_timer_check(void)
732 struct efi_event *evt;
733 u64 now = timer_get_us();
735 list_for_each_entry(evt, &efi_events, link) {
737 efi_queue_event(evt, true);
738 if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
740 switch (evt->trigger_type) {
741 case EFI_TIMER_RELATIVE:
742 evt->trigger_type = EFI_TIMER_STOP;
744 case EFI_TIMER_PERIODIC:
745 evt->trigger_next += evt->trigger_time;
750 evt->is_signaled = false;
751 efi_signal_event(evt, true);
757 * efi_set_timer() - set the trigger time for a timer event or stop the event
758 * @event: event for which the timer is set
759 * @type: type of the timer
760 * @trigger_time: trigger period in multiples of 100 ns
762 * This is the function for internal usage in U-Boot. For the API function
763 * implementing the SetTimer service see efi_set_timer_ext.
765 * Return: status code
767 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
768 uint64_t trigger_time)
770 /* Check that the event is valid */
771 if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
772 return EFI_INVALID_PARAMETER;
775 * The parameter defines a multiple of 100 ns.
776 * We use multiples of 1000 ns. So divide by 10.
778 do_div(trigger_time, 10);
782 event->trigger_next = -1ULL;
784 case EFI_TIMER_PERIODIC:
785 case EFI_TIMER_RELATIVE:
786 event->trigger_next = timer_get_us() + trigger_time;
789 return EFI_INVALID_PARAMETER;
791 event->trigger_type = type;
792 event->trigger_time = trigger_time;
793 event->is_signaled = false;
798 * efi_set_timer_ext() - Set the trigger time for a timer event or stop the
800 * @event: event for which the timer is set
801 * @type: type of the timer
802 * @trigger_time: trigger period in multiples of 100 ns
804 * This function implements the SetTimer service.
806 * See the Unified Extensible Firmware Interface (UEFI) specification for
810 * Return: status code
812 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
813 enum efi_timer_delay type,
814 uint64_t trigger_time)
816 EFI_ENTRY("%p, %d, %llx", event, type, trigger_time);
817 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
821 * efi_wait_for_event() - wait for events to be signaled
822 * @num_events: number of events to be waited for
823 * @event: events to be waited for
824 * @index: index of the event that was signaled
826 * This function implements the WaitForEvent service.
828 * See the Unified Extensible Firmware Interface (UEFI) specification for
831 * Return: status code
833 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
834 struct efi_event **event,
839 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
841 /* Check parameters */
842 if (!num_events || !event)
843 return EFI_EXIT(EFI_INVALID_PARAMETER);
845 if (efi_tpl != TPL_APPLICATION)
846 return EFI_EXIT(EFI_UNSUPPORTED);
847 for (i = 0; i < num_events; ++i) {
848 if (efi_is_event(event[i]) != EFI_SUCCESS)
849 return EFI_EXIT(EFI_INVALID_PARAMETER);
850 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
851 return EFI_EXIT(EFI_INVALID_PARAMETER);
852 if (!event[i]->is_signaled)
853 efi_queue_event(event[i], true);
856 /* Wait for signal */
858 for (i = 0; i < num_events; ++i) {
859 if (event[i]->is_signaled)
862 /* Allow events to occur. */
868 * Reset the signal which is passed to the caller to allow periodic
871 event[i]->is_signaled = false;
875 return EFI_EXIT(EFI_SUCCESS);
879 * efi_signal_event_ext() - signal an EFI event
880 * @event: event to signal
882 * This function implements the SignalEvent service.
884 * See the Unified Extensible Firmware Interface (UEFI) specification for
887 * This functions sets the signaled state of the event and queues the
888 * notification function for execution.
890 * Return: status code
892 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
894 EFI_ENTRY("%p", event);
895 if (efi_is_event(event) != EFI_SUCCESS)
896 return EFI_EXIT(EFI_INVALID_PARAMETER);
897 efi_signal_event(event, true);
898 return EFI_EXIT(EFI_SUCCESS);
902 * efi_close_event() - close an EFI event
903 * @event: event to close
905 * This function implements the CloseEvent service.
907 * See the Unified Extensible Firmware Interface (UEFI) specification for
910 * Return: status code
912 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
914 struct efi_register_notify_event *item, *next;
916 EFI_ENTRY("%p", event);
917 if (efi_is_event(event) != EFI_SUCCESS)
918 return EFI_EXIT(EFI_INVALID_PARAMETER);
920 /* Remove protocol notify registrations for the event */
921 list_for_each_entry_safe(item, next, &efi_register_notify_events,
923 if (event == item->event) {
924 struct efi_protocol_notification *hitem, *hnext;
926 /* Remove signaled handles */
927 list_for_each_entry_safe(hitem, hnext, &item->handles,
929 list_del(&hitem->link);
932 list_del(&item->link);
937 list_del(&event->link);
939 return EFI_EXIT(EFI_SUCCESS);
943 * efi_check_event() - check if an event is signaled
944 * @event: event to check
946 * This function implements the CheckEvent service.
948 * See the Unified Extensible Firmware Interface (UEFI) specification for
951 * If an event is not signaled yet, the notification function is queued. The
952 * signaled state is cleared.
954 * Return: status code
956 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
958 EFI_ENTRY("%p", event);
960 if (efi_is_event(event) != EFI_SUCCESS ||
961 event->type & EVT_NOTIFY_SIGNAL)
962 return EFI_EXIT(EFI_INVALID_PARAMETER);
963 if (!event->is_signaled)
964 efi_queue_event(event, true);
965 if (event->is_signaled) {
966 event->is_signaled = false;
967 return EFI_EXIT(EFI_SUCCESS);
969 return EFI_EXIT(EFI_NOT_READY);
973 * efi_search_obj() - find the internal EFI object for a handle
974 * @handle: handle to find
978 struct efi_object *efi_search_obj(const efi_handle_t handle)
980 struct efi_object *efiobj;
985 list_for_each_entry(efiobj, &efi_obj_list, link) {
986 if (efiobj == handle)
993 * efi_open_protocol_info_entry() - create open protocol info entry and add it
995 * @handler: handler of a protocol
997 * Return: open protocol info entry
999 static struct efi_open_protocol_info_entry *efi_create_open_info(
1000 struct efi_handler *handler)
1002 struct efi_open_protocol_info_item *item;
1004 item = calloc(1, sizeof(struct efi_open_protocol_info_item));
1007 /* Append the item to the open protocol info list. */
1008 list_add_tail(&item->link, &handler->open_infos);
1014 * efi_delete_open_info() - remove an open protocol info entry from a protocol
1015 * @item: open protocol info entry to delete
1017 * Return: status code
1019 static efi_status_t efi_delete_open_info(
1020 struct efi_open_protocol_info_item *item)
1022 list_del(&item->link);
1028 * efi_add_protocol() - install new protocol on a handle
1029 * @handle: handle on which the protocol shall be installed
1030 * @protocol: GUID of the protocol to be installed
1031 * @protocol_interface: interface of the protocol implementation
1033 * Return: status code
1035 efi_status_t efi_add_protocol(const efi_handle_t handle,
1036 const efi_guid_t *protocol,
1037 void *protocol_interface)
1039 struct efi_object *efiobj;
1040 struct efi_handler *handler;
1042 struct efi_register_notify_event *event;
1044 efiobj = efi_search_obj(handle);
1046 return EFI_INVALID_PARAMETER;
1047 ret = efi_search_protocol(handle, protocol, NULL);
1048 if (ret != EFI_NOT_FOUND)
1049 return EFI_INVALID_PARAMETER;
1050 handler = calloc(1, sizeof(struct efi_handler));
1052 return EFI_OUT_OF_RESOURCES;
1053 handler->guid = protocol;
1054 handler->protocol_interface = protocol_interface;
1055 INIT_LIST_HEAD(&handler->open_infos);
1056 list_add_tail(&handler->link, &efiobj->protocols);
1058 /* Notify registered events */
1059 list_for_each_entry(event, &efi_register_notify_events, link) {
1060 if (!guidcmp(protocol, &event->protocol)) {
1061 struct efi_protocol_notification *notif;
1063 notif = calloc(1, sizeof(*notif));
1065 list_del(&handler->link);
1067 return EFI_OUT_OF_RESOURCES;
1069 notif->handle = handle;
1070 list_add_tail(¬if->link, &event->handles);
1071 event->event->is_signaled = false;
1072 efi_signal_event(event->event, true);
1076 if (!guidcmp(&efi_guid_device_path, protocol))
1077 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1082 * efi_install_protocol_interface() - install protocol interface
1083 * @handle: handle on which the protocol shall be installed
1084 * @protocol: GUID of the protocol to be installed
1085 * @protocol_interface_type: type of the interface to be installed,
1086 * always EFI_NATIVE_INTERFACE
1087 * @protocol_interface: interface of the protocol implementation
1089 * This function implements the InstallProtocolInterface service.
1091 * See the Unified Extensible Firmware Interface (UEFI) specification for
1094 * Return: status code
1096 static efi_status_t EFIAPI efi_install_protocol_interface(
1097 efi_handle_t *handle, const efi_guid_t *protocol,
1098 int protocol_interface_type, void *protocol_interface)
1102 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1103 protocol_interface);
1105 if (!handle || !protocol ||
1106 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1107 r = EFI_INVALID_PARAMETER;
1111 /* Create new handle if requested. */
1113 r = efi_create_handle(handle);
1114 if (r != EFI_SUCCESS)
1116 EFI_PRINT("new handle %p\n", *handle);
1118 EFI_PRINT("handle %p\n", *handle);
1120 /* Add new protocol */
1121 r = efi_add_protocol(*handle, protocol, protocol_interface);
1127 * efi_get_drivers() - get all drivers associated to a controller
1128 * @handle: handle of the controller
1129 * @protocol: protocol GUID (optional)
1130 * @number_of_drivers: number of child controllers
1131 * @driver_handle_buffer: handles of the the drivers
1133 * The allocated buffer has to be freed with free().
1135 * Return: status code
1137 static efi_status_t efi_get_drivers(efi_handle_t handle,
1138 const efi_guid_t *protocol,
1139 efi_uintn_t *number_of_drivers,
1140 efi_handle_t **driver_handle_buffer)
1142 struct efi_handler *handler;
1143 struct efi_open_protocol_info_item *item;
1144 efi_uintn_t count = 0, i;
1147 /* Count all driver associations */
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)
1157 *number_of_drivers = 0;
1159 *driver_handle_buffer = NULL;
1163 * Create buffer. In case of duplicate driver assignments the buffer
1164 * will be too large. But that does not harm.
1166 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1167 if (!*driver_handle_buffer)
1168 return EFI_OUT_OF_RESOURCES;
1169 /* Collect unique driver handles */
1170 list_for_each_entry(handler, &handle->protocols, link) {
1171 if (protocol && guidcmp(handler->guid, protocol))
1173 list_for_each_entry(item, &handler->open_infos, link) {
1174 if (item->info.attributes &
1175 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1176 /* Check this is a new driver */
1178 for (i = 0; i < *number_of_drivers; ++i) {
1179 if ((*driver_handle_buffer)[i] ==
1180 item->info.agent_handle)
1183 /* Copy handle to buffer */
1185 i = (*number_of_drivers)++;
1186 (*driver_handle_buffer)[i] =
1187 item->info.agent_handle;
1196 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1197 * @handle: handle of the controller
1198 * @protocol: protocol GUID (optional)
1199 * @child_handle: handle of the child to destroy
1201 * This function implements the DisconnectController service.
1203 * See the Unified Extensible Firmware Interface (UEFI) specification for
1206 * Return: status code
1208 static efi_status_t efi_disconnect_all_drivers
1209 (efi_handle_t handle,
1210 const efi_guid_t *protocol,
1211 efi_handle_t child_handle)
1213 efi_uintn_t number_of_drivers;
1214 efi_handle_t *driver_handle_buffer;
1215 efi_status_t r, ret;
1217 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1218 &driver_handle_buffer);
1219 if (ret != EFI_SUCCESS)
1221 if (!number_of_drivers)
1223 ret = EFI_NOT_FOUND;
1224 while (number_of_drivers) {
1225 r = EFI_CALL(efi_disconnect_controller(
1227 driver_handle_buffer[--number_of_drivers],
1229 if (r == EFI_SUCCESS)
1232 free(driver_handle_buffer);
1237 * efi_uninstall_protocol() - uninstall protocol interface
1239 * @handle: handle from which the protocol shall be removed
1240 * @protocol: GUID of the protocol to be removed
1241 * @protocol_interface: interface to be removed
1243 * This function DOES NOT delete a handle without installed protocol.
1245 * Return: status code
1247 static efi_status_t efi_uninstall_protocol
1248 (efi_handle_t handle, const efi_guid_t *protocol,
1249 void *protocol_interface)
1251 struct efi_object *efiobj;
1252 struct efi_handler *handler;
1253 struct efi_open_protocol_info_item *item;
1254 struct efi_open_protocol_info_item *pos;
1258 efiobj = efi_search_obj(handle);
1260 r = EFI_INVALID_PARAMETER;
1263 /* Find the protocol on the handle */
1264 r = efi_search_protocol(handle, protocol, &handler);
1265 if (r != EFI_SUCCESS)
1267 /* Disconnect controllers */
1268 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1269 /* Close protocol */
1270 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1271 if (item->info.attributes ==
1272 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1273 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1274 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1275 list_del(&item->link);
1277 if (!list_empty(&handler->open_infos)) {
1278 r = EFI_ACCESS_DENIED;
1281 r = efi_remove_protocol(handle, protocol, protocol_interface);
1287 * efi_uninstall_protocol_interface() - uninstall protocol interface
1288 * @handle: handle from which the protocol shall be removed
1289 * @protocol: GUID of the protocol to be removed
1290 * @protocol_interface: interface to be removed
1292 * This function implements the UninstallProtocolInterface service.
1294 * See the Unified Extensible Firmware Interface (UEFI) specification for
1297 * Return: status code
1299 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1300 (efi_handle_t handle, const efi_guid_t *protocol,
1301 void *protocol_interface)
1305 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1307 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1308 if (ret != EFI_SUCCESS)
1311 /* If the last protocol has been removed, delete the handle. */
1312 if (list_empty(&handle->protocols)) {
1313 list_del(&handle->link);
1317 return EFI_EXIT(ret);
1321 * efi_register_protocol_notify() - register an event for notification when a
1322 * protocol is installed.
1323 * @protocol: GUID of the protocol whose installation shall be notified
1324 * @event: event to be signaled upon installation of the protocol
1325 * @registration: key for retrieving the registration information
1327 * This function implements the RegisterProtocolNotify service.
1328 * See the Unified Extensible Firmware Interface (UEFI) specification
1331 * Return: status code
1333 static efi_status_t EFIAPI efi_register_protocol_notify(
1334 const efi_guid_t *protocol,
1335 struct efi_event *event,
1336 void **registration)
1338 struct efi_register_notify_event *item;
1339 efi_status_t ret = EFI_SUCCESS;
1341 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1343 if (!protocol || !event || !registration) {
1344 ret = EFI_INVALID_PARAMETER;
1348 item = calloc(1, sizeof(struct efi_register_notify_event));
1350 ret = EFI_OUT_OF_RESOURCES;
1354 item->event = event;
1355 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1356 INIT_LIST_HEAD(&item->handles);
1358 list_add_tail(&item->link, &efi_register_notify_events);
1360 *registration = item;
1362 return EFI_EXIT(ret);
1366 * efi_search() - determine if an EFI handle implements a protocol
1367 * @search_type: selection criterion
1368 * @protocol: GUID of the protocol
1369 * @search_key: registration key
1372 * See the documentation of the LocateHandle service in the UEFI specification.
1374 * Return: 0 if the handle implements the protocol
1376 static int efi_search(enum efi_locate_search_type search_type,
1377 const efi_guid_t *protocol, efi_handle_t handle)
1381 switch (search_type) {
1385 ret = efi_search_protocol(handle, protocol, NULL);
1386 return (ret != EFI_SUCCESS);
1388 /* Invalid search type */
1394 * efi_check_register_notify_event() - check if registration key is valid
1396 * Check that a pointer is a valid registration key as returned by
1397 * RegisterProtocolNotify().
1399 * @key: registration key
1400 * Return: valid registration key or NULL
1402 static struct efi_register_notify_event *efi_check_register_notify_event
1405 struct efi_register_notify_event *event;
1407 list_for_each_entry(event, &efi_register_notify_events, link) {
1408 if (event == (struct efi_register_notify_event *)key)
1415 * efi_locate_handle() - locate handles implementing a protocol
1417 * @search_type: selection criterion
1418 * @protocol: GUID of the protocol
1419 * @search_key: registration key
1420 * @buffer_size: size of the buffer to receive the handles in bytes
1421 * @buffer: buffer to receive the relevant handles
1423 * This function is meant for U-Boot internal calls. For the API implementation
1424 * of the LocateHandle service see efi_locate_handle_ext.
1426 * Return: status code
1428 static efi_status_t efi_locate_handle(
1429 enum efi_locate_search_type search_type,
1430 const efi_guid_t *protocol, void *search_key,
1431 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1433 struct efi_object *efiobj;
1434 efi_uintn_t size = 0;
1435 struct efi_register_notify_event *event;
1436 struct efi_protocol_notification *handle = NULL;
1438 /* Check parameters */
1439 switch (search_type) {
1442 case BY_REGISTER_NOTIFY:
1444 return EFI_INVALID_PARAMETER;
1445 /* Check that the registration key is valid */
1446 event = efi_check_register_notify_event(search_key);
1448 return EFI_INVALID_PARAMETER;
1452 return EFI_INVALID_PARAMETER;
1455 return EFI_INVALID_PARAMETER;
1458 /* Count how much space we need */
1459 if (search_type == BY_REGISTER_NOTIFY) {
1460 if (list_empty(&event->handles))
1461 return EFI_NOT_FOUND;
1462 handle = list_first_entry(&event->handles,
1463 struct efi_protocol_notification,
1465 efiobj = handle->handle;
1466 size += sizeof(void *);
1468 list_for_each_entry(efiobj, &efi_obj_list, link) {
1469 if (!efi_search(search_type, protocol, efiobj))
1470 size += sizeof(void *);
1473 return EFI_NOT_FOUND;
1477 return EFI_INVALID_PARAMETER;
1479 if (*buffer_size < size) {
1480 *buffer_size = size;
1481 return EFI_BUFFER_TOO_SMALL;
1484 *buffer_size = size;
1486 /* The buffer size is sufficient but there is no buffer */
1488 return EFI_INVALID_PARAMETER;
1490 /* Then fill the array */
1491 if (search_type == BY_REGISTER_NOTIFY) {
1493 list_del(&handle->link);
1495 list_for_each_entry(efiobj, &efi_obj_list, link) {
1496 if (!efi_search(search_type, protocol, efiobj))
1505 * efi_locate_handle_ext() - locate handles implementing a protocol.
1506 * @search_type: selection criterion
1507 * @protocol: GUID of the protocol
1508 * @search_key: registration key
1509 * @buffer_size: size of the buffer to receive the handles in bytes
1510 * @buffer: buffer to receive the relevant handles
1512 * This function implements the LocateHandle service.
1514 * See the Unified Extensible Firmware Interface (UEFI) specification for
1517 * Return: 0 if the handle implements the protocol
1519 static efi_status_t EFIAPI efi_locate_handle_ext(
1520 enum efi_locate_search_type search_type,
1521 const efi_guid_t *protocol, void *search_key,
1522 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1524 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1525 buffer_size, buffer);
1527 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1528 buffer_size, buffer));
1532 * efi_remove_configuration_table() - collapses configuration table entries,
1535 * @i: index of the table entry to be removed
1537 static void efi_remove_configuration_table(int i)
1539 struct efi_configuration_table *this = &systab.tables[i];
1540 struct efi_configuration_table *next = &systab.tables[i + 1];
1541 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1543 memmove(this, next, (ulong)end - (ulong)next);
1548 * efi_install_configuration_table() - adds, updates, or removes a
1549 * configuration table
1550 * @guid: GUID of the installed table
1551 * @table: table to be installed
1553 * This function is used for internal calls. For the API implementation of the
1554 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1556 * Return: status code
1558 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1561 struct efi_event *evt;
1565 return EFI_INVALID_PARAMETER;
1567 /* Check for GUID override */
1568 for (i = 0; i < systab.nr_tables; i++) {
1569 if (!guidcmp(guid, &systab.tables[i].guid)) {
1571 systab.tables[i].table = table;
1573 efi_remove_configuration_table(i);
1579 return EFI_NOT_FOUND;
1581 /* No override, check for overflow */
1582 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1583 return EFI_OUT_OF_RESOURCES;
1585 /* Add a new entry */
1586 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1587 systab.tables[i].table = table;
1588 systab.nr_tables = i + 1;
1591 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1592 efi_update_table_header_crc32(&systab.hdr);
1594 /* Notify that the configuration table was changed */
1595 list_for_each_entry(evt, &efi_events, link) {
1596 if (evt->group && !guidcmp(evt->group, guid)) {
1597 efi_signal_event(evt, false);
1606 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1607 * configuration table.
1608 * @guid: GUID of the installed table
1609 * @table: table to be installed
1611 * This function implements the InstallConfigurationTable service.
1613 * See the Unified Extensible Firmware Interface (UEFI) specification for
1616 * Return: status code
1618 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1621 EFI_ENTRY("%pUl, %p", guid, table);
1622 return EFI_EXIT(efi_install_configuration_table(guid, table));
1626 * efi_setup_loaded_image() - initialize a loaded image
1628 * Initialize a loaded_image_info and loaded_image_info object with correct
1629 * protocols, boot-device, etc.
1631 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1634 * @device_path: device path of the loaded image
1635 * @file_path: file path of the loaded image
1636 * @handle_ptr: handle of the loaded image
1637 * @info_ptr: loaded image protocol
1638 * Return: status code
1640 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1641 struct efi_device_path *file_path,
1642 struct efi_loaded_image_obj **handle_ptr,
1643 struct efi_loaded_image **info_ptr)
1646 struct efi_loaded_image *info = NULL;
1647 struct efi_loaded_image_obj *obj = NULL;
1648 struct efi_device_path *dp;
1650 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1654 info = calloc(1, sizeof(*info));
1656 return EFI_OUT_OF_RESOURCES;
1657 obj = calloc(1, sizeof(*obj));
1660 return EFI_OUT_OF_RESOURCES;
1662 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1664 /* Add internal object to object list */
1665 efi_add_handle(&obj->header);
1667 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1668 info->file_path = file_path;
1669 info->system_table = &systab;
1672 info->device_handle = efi_dp_find_obj(device_path, NULL);
1674 dp = efi_dp_append(device_path, file_path);
1676 ret = EFI_OUT_OF_RESOURCES;
1682 ret = efi_add_protocol(&obj->header,
1683 &efi_guid_loaded_image_device_path, dp);
1684 if (ret != EFI_SUCCESS)
1688 * When asking for the loaded_image interface, just
1689 * return handle which points to loaded_image_info
1691 ret = efi_add_protocol(&obj->header,
1692 &efi_guid_loaded_image, info);
1693 if (ret != EFI_SUCCESS)
1701 printf("ERROR: Failure to install protocols for loaded image\n");
1702 efi_delete_handle(&obj->header);
1708 * efi_load_image_from_path() - load an image using a file path
1710 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1711 * callers obligation to update the memory type as needed.
1713 * @file_path: the path of the image to load
1714 * @buffer: buffer containing the loaded image
1715 * @size: size of the loaded image
1716 * Return: status code
1719 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1720 void **buffer, efi_uintn_t *size)
1722 struct efi_file_info *info = NULL;
1723 struct efi_file_handle *f;
1724 static efi_status_t ret;
1728 /* In case of failure nothing is returned */
1733 f = efi_file_from_path(file_path);
1735 return EFI_DEVICE_ERROR;
1739 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1741 if (ret != EFI_BUFFER_TOO_SMALL) {
1742 ret = EFI_DEVICE_ERROR;
1747 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1749 if (ret != EFI_SUCCESS)
1753 * When reading the file we do not yet know if it contains an
1754 * application, a boottime driver, or a runtime driver. So here we
1755 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1756 * update the reservation according to the image type.
1758 bs = info->file_size;
1759 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1760 EFI_BOOT_SERVICES_DATA,
1761 efi_size_in_pages(bs), &addr);
1762 if (ret != EFI_SUCCESS) {
1763 ret = EFI_OUT_OF_RESOURCES;
1768 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1769 if (ret != EFI_SUCCESS)
1770 efi_free_pages(addr, efi_size_in_pages(bs));
1771 *buffer = (void *)(uintptr_t)addr;
1774 EFI_CALL(f->close(f));
1780 * efi_load_image() - load an EFI image into memory
1781 * @boot_policy: true for request originating from the boot manager
1782 * @parent_image: the caller's image handle
1783 * @file_path: the path of the image to load
1784 * @source_buffer: memory location from which the image is installed
1785 * @source_size: size of the memory area from which the image is installed
1786 * @image_handle: handle for the newly installed image
1788 * This function implements the LoadImage service.
1790 * See the Unified Extensible Firmware Interface (UEFI) specification
1793 * Return: status code
1795 efi_status_t EFIAPI efi_load_image(bool boot_policy,
1796 efi_handle_t parent_image,
1797 struct efi_device_path *file_path,
1798 void *source_buffer,
1799 efi_uintn_t source_size,
1800 efi_handle_t *image_handle)
1802 struct efi_device_path *dp, *fp;
1803 struct efi_loaded_image *info = NULL;
1804 struct efi_loaded_image_obj **image_obj =
1805 (struct efi_loaded_image_obj **)image_handle;
1809 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1810 file_path, source_buffer, source_size, image_handle);
1812 if (!image_handle || !efi_search_obj(parent_image)) {
1813 ret = EFI_INVALID_PARAMETER;
1817 if (!source_buffer && !file_path) {
1818 ret = EFI_NOT_FOUND;
1821 /* The parent image handle must refer to a loaded image */
1822 if (!parent_image->type) {
1823 ret = EFI_INVALID_PARAMETER;
1827 if (!source_buffer) {
1828 ret = efi_load_image_from_path(file_path, &dest_buffer,
1830 if (ret != EFI_SUCCESS)
1834 ret = EFI_LOAD_ERROR;
1837 dest_buffer = source_buffer;
1839 /* split file_path which contains both the device and file parts */
1840 efi_dp_split_file_path(file_path, &dp, &fp);
1841 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
1842 if (ret == EFI_SUCCESS)
1843 ret = efi_load_pe(*image_obj, dest_buffer, info);
1845 /* Release buffer to which file was loaded */
1846 efi_free_pages((uintptr_t)dest_buffer,
1847 efi_size_in_pages(source_size));
1848 if (ret == EFI_SUCCESS) {
1849 info->system_table = &systab;
1850 info->parent_handle = parent_image;
1852 /* The image is invalid. Release all associated resources. */
1853 efi_delete_handle(*image_handle);
1854 *image_handle = NULL;
1858 return EFI_EXIT(ret);
1862 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1864 static void efi_exit_caches(void)
1866 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1868 * Grub on 32bit ARM needs to have caches disabled before jumping into
1869 * a zImage, but does not know of all cache layers. Give it a hand.
1871 if (efi_is_direct_boot)
1872 cleanup_before_linux();
1877 * efi_exit_boot_services() - stop all boot services
1878 * @image_handle: handle of the loaded image
1879 * @map_key: key of the memory map
1881 * This function implements the ExitBootServices service.
1883 * See the Unified Extensible Firmware Interface (UEFI) specification
1886 * All timer events are disabled. For exit boot services events the
1887 * notification function is called. The boot services are disabled in the
1890 * Return: status code
1892 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1893 efi_uintn_t map_key)
1895 struct efi_event *evt;
1897 EFI_ENTRY("%p, %zx", image_handle, map_key);
1899 /* Check that the caller has read the current memory map */
1900 if (map_key != efi_memory_map_key)
1901 return EFI_INVALID_PARAMETER;
1903 /* Make sure that notification functions are not called anymore */
1904 efi_tpl = TPL_HIGH_LEVEL;
1906 /* Check if ExitBootServices has already been called */
1907 if (!systab.boottime)
1908 return EFI_EXIT(EFI_SUCCESS);
1910 /* Add related events to the event group */
1911 list_for_each_entry(evt, &efi_events, link) {
1912 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1913 evt->group = &efi_guid_event_group_exit_boot_services;
1915 /* Notify that ExitBootServices is invoked. */
1916 list_for_each_entry(evt, &efi_events, link) {
1918 !guidcmp(evt->group,
1919 &efi_guid_event_group_exit_boot_services)) {
1920 efi_signal_event(evt, false);
1925 /* TODO: Should persist EFI variables here */
1927 board_quiesce_devices();
1929 /* Fix up caches for EFI payloads if necessary */
1932 /* This stops all lingering devices */
1933 bootm_disable_interrupts();
1935 /* Disable boot time services */
1936 systab.con_in_handle = NULL;
1937 systab.con_in = NULL;
1938 systab.con_out_handle = NULL;
1939 systab.con_out = NULL;
1940 systab.stderr_handle = NULL;
1941 systab.std_err = NULL;
1942 systab.boottime = NULL;
1944 /* Recalculate CRC32 */
1945 efi_update_table_header_crc32(&systab.hdr);
1947 /* Give the payload some time to boot */
1948 efi_set_watchdog(0);
1951 return EFI_EXIT(EFI_SUCCESS);
1955 * efi_get_next_monotonic_count() - get next value of the counter
1956 * @count: returned value of the counter
1958 * This function implements the NextMonotonicCount service.
1960 * See the Unified Extensible Firmware Interface (UEFI) specification for
1963 * Return: status code
1965 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1967 static uint64_t mono;
1970 EFI_ENTRY("%p", count);
1972 ret = EFI_INVALID_PARAMETER;
1978 return EFI_EXIT(ret);
1982 * efi_stall() - sleep
1983 * @microseconds: period to sleep in microseconds
1985 * This function implements the Stall service.
1987 * See the Unified Extensible Firmware Interface (UEFI) specification for
1990 * Return: status code
1992 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1996 EFI_ENTRY("%ld", microseconds);
1998 end_tick = get_ticks() + usec_to_tick(microseconds);
1999 while (get_ticks() < end_tick)
2002 return EFI_EXIT(EFI_SUCCESS);
2006 * efi_set_watchdog_timer() - reset the watchdog timer
2007 * @timeout: seconds before reset by watchdog
2008 * @watchdog_code: code to be logged when resetting
2009 * @data_size: size of buffer in bytes
2010 * @watchdog_data: buffer with data describing the reset reason
2012 * This function implements the SetWatchdogTimer service.
2014 * See the Unified Extensible Firmware Interface (UEFI) specification for
2017 * Return: status code
2019 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2020 uint64_t watchdog_code,
2021 unsigned long data_size,
2022 uint16_t *watchdog_data)
2024 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
2025 data_size, watchdog_data);
2026 return EFI_EXIT(efi_set_watchdog(timeout));
2030 * efi_close_protocol() - close a protocol
2031 * @handle: handle on which the protocol shall be closed
2032 * @protocol: GUID of the protocol to close
2033 * @agent_handle: handle of the driver
2034 * @controller_handle: handle of the controller
2036 * This function implements the CloseProtocol service.
2038 * See the Unified Extensible Firmware Interface (UEFI) specification for
2041 * Return: status code
2043 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
2044 const efi_guid_t *protocol,
2045 efi_handle_t agent_handle,
2046 efi_handle_t controller_handle)
2048 struct efi_handler *handler;
2049 struct efi_open_protocol_info_item *item;
2050 struct efi_open_protocol_info_item *pos;
2053 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2056 if (!efi_search_obj(agent_handle) ||
2057 (controller_handle && !efi_search_obj(controller_handle))) {
2058 r = EFI_INVALID_PARAMETER;
2061 r = efi_search_protocol(handle, protocol, &handler);
2062 if (r != EFI_SUCCESS)
2066 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2067 if (item->info.agent_handle == agent_handle &&
2068 item->info.controller_handle == controller_handle) {
2069 efi_delete_open_info(item);
2078 * efi_open_protocol_information() - provide information about then open status
2079 * of a protocol on a handle
2080 * @handle: handle for which the information shall be retrieved
2081 * @protocol: GUID of the protocol
2082 * @entry_buffer: buffer to receive the open protocol information
2083 * @entry_count: number of entries available in the buffer
2085 * This function implements the OpenProtocolInformation service.
2087 * See the Unified Extensible Firmware Interface (UEFI) specification for
2090 * Return: status code
2092 static efi_status_t EFIAPI efi_open_protocol_information(
2093 efi_handle_t handle, const efi_guid_t *protocol,
2094 struct efi_open_protocol_info_entry **entry_buffer,
2095 efi_uintn_t *entry_count)
2097 unsigned long buffer_size;
2098 unsigned long count;
2099 struct efi_handler *handler;
2100 struct efi_open_protocol_info_item *item;
2103 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2106 /* Check parameters */
2107 if (!entry_buffer) {
2108 r = EFI_INVALID_PARAMETER;
2111 r = efi_search_protocol(handle, protocol, &handler);
2112 if (r != EFI_SUCCESS)
2117 list_for_each_entry(item, &handler->open_infos, link) {
2118 if (item->info.open_count)
2121 *entry_count = count;
2122 *entry_buffer = NULL;
2129 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2130 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2131 (void **)entry_buffer);
2132 if (r != EFI_SUCCESS)
2134 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2135 if (item->info.open_count)
2136 (*entry_buffer)[--count] = item->info;
2143 * efi_protocols_per_handle() - get protocols installed on a handle
2144 * @handle: handle for which the information is retrieved
2145 * @protocol_buffer: buffer with protocol GUIDs
2146 * @protocol_buffer_count: number of entries in the buffer
2148 * This function implements the ProtocolsPerHandleService.
2150 * See the Unified Extensible Firmware Interface (UEFI) specification for
2153 * Return: status code
2155 static efi_status_t EFIAPI efi_protocols_per_handle(
2156 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2157 efi_uintn_t *protocol_buffer_count)
2159 unsigned long buffer_size;
2160 struct efi_object *efiobj;
2161 struct list_head *protocol_handle;
2164 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2165 protocol_buffer_count);
2167 if (!handle || !protocol_buffer || !protocol_buffer_count)
2168 return EFI_EXIT(EFI_INVALID_PARAMETER);
2170 *protocol_buffer = NULL;
2171 *protocol_buffer_count = 0;
2173 efiobj = efi_search_obj(handle);
2175 return EFI_EXIT(EFI_INVALID_PARAMETER);
2177 /* Count protocols */
2178 list_for_each(protocol_handle, &efiobj->protocols) {
2179 ++*protocol_buffer_count;
2183 if (*protocol_buffer_count) {
2186 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2187 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2188 (void **)protocol_buffer);
2189 if (r != EFI_SUCCESS)
2191 list_for_each(protocol_handle, &efiobj->protocols) {
2192 struct efi_handler *protocol;
2194 protocol = list_entry(protocol_handle,
2195 struct efi_handler, link);
2196 (*protocol_buffer)[j] = (void *)protocol->guid;
2201 return EFI_EXIT(EFI_SUCCESS);
2205 * efi_locate_handle_buffer() - locate handles implementing a protocol
2206 * @search_type: selection criterion
2207 * @protocol: GUID of the protocol
2208 * @search_key: registration key
2209 * @no_handles: number of returned handles
2210 * @buffer: buffer with the returned handles
2212 * This function implements the LocateHandleBuffer service.
2214 * See the Unified Extensible Firmware Interface (UEFI) specification for
2217 * Return: status code
2219 static efi_status_t EFIAPI efi_locate_handle_buffer(
2220 enum efi_locate_search_type search_type,
2221 const efi_guid_t *protocol, void *search_key,
2222 efi_uintn_t *no_handles, efi_handle_t **buffer)
2225 efi_uintn_t buffer_size = 0;
2227 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2228 no_handles, buffer);
2230 if (!no_handles || !buffer) {
2231 r = EFI_INVALID_PARAMETER;
2236 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2238 if (r != EFI_BUFFER_TOO_SMALL)
2240 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2242 if (r != EFI_SUCCESS)
2244 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2246 if (r == EFI_SUCCESS)
2247 *no_handles = buffer_size / sizeof(efi_handle_t);
2253 * efi_locate_protocol() - find an interface implementing a protocol
2254 * @protocol: GUID of the protocol
2255 * @registration: registration key passed to the notification function
2256 * @protocol_interface: interface implementing the protocol
2258 * This function implements the LocateProtocol service.
2260 * See the Unified Extensible Firmware Interface (UEFI) specification for
2263 * Return: status code
2265 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2267 void **protocol_interface)
2269 struct efi_handler *handler;
2271 struct efi_object *efiobj;
2273 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2276 * The UEFI spec explicitly requires a protocol even if a registration
2277 * key is provided. This differs from the logic in LocateHandle().
2279 if (!protocol || !protocol_interface)
2280 return EFI_EXIT(EFI_INVALID_PARAMETER);
2283 struct efi_register_notify_event *event;
2284 struct efi_protocol_notification *handle;
2286 event = efi_check_register_notify_event(registration);
2288 return EFI_EXIT(EFI_INVALID_PARAMETER);
2290 * The UEFI spec requires to return EFI_NOT_FOUND if no
2291 * protocol instance matches protocol and registration.
2292 * So let's do the same for a mismatch between protocol and
2295 if (guidcmp(&event->protocol, protocol))
2297 if (list_empty(&event->handles))
2299 handle = list_first_entry(&event->handles,
2300 struct efi_protocol_notification,
2302 efiobj = handle->handle;
2303 list_del(&handle->link);
2305 ret = efi_search_protocol(efiobj, protocol, &handler);
2306 if (ret == EFI_SUCCESS)
2309 list_for_each_entry(efiobj, &efi_obj_list, link) {
2310 ret = efi_search_protocol(efiobj, protocol, &handler);
2311 if (ret == EFI_SUCCESS)
2316 *protocol_interface = NULL;
2317 return EFI_EXIT(EFI_NOT_FOUND);
2319 *protocol_interface = handler->protocol_interface;
2320 return EFI_EXIT(EFI_SUCCESS);
2324 * efi_locate_device_path() - Get the device path and handle of an device
2325 * implementing a protocol
2326 * @protocol: GUID of the protocol
2327 * @device_path: device path
2328 * @device: handle of the device
2330 * This function implements the LocateDevicePath service.
2332 * See the Unified Extensible Firmware Interface (UEFI) specification for
2335 * Return: status code
2337 static efi_status_t EFIAPI efi_locate_device_path(
2338 const efi_guid_t *protocol,
2339 struct efi_device_path **device_path,
2340 efi_handle_t *device)
2342 struct efi_device_path *dp;
2344 struct efi_handler *handler;
2345 efi_handle_t *handles;
2347 size_t len_best = 0;
2348 efi_uintn_t no_handles;
2352 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2354 if (!protocol || !device_path || !*device_path) {
2355 ret = EFI_INVALID_PARAMETER;
2359 /* Find end of device path */
2360 len = efi_dp_instance_size(*device_path);
2362 /* Get all handles implementing the protocol */
2363 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2364 &no_handles, &handles));
2365 if (ret != EFI_SUCCESS)
2368 for (i = 0; i < no_handles; ++i) {
2369 /* Find the device path protocol */
2370 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2372 if (ret != EFI_SUCCESS)
2374 dp = (struct efi_device_path *)handler->protocol_interface;
2375 len_dp = efi_dp_instance_size(dp);
2377 * This handle can only be a better fit
2378 * if its device path length is longer than the best fit and
2379 * if its device path length is shorter of equal the searched
2382 if (len_dp <= len_best || len_dp > len)
2384 /* Check if dp is a subpath of device_path */
2385 if (memcmp(*device_path, dp, len_dp))
2388 ret = EFI_INVALID_PARAMETER;
2391 *device = handles[i];
2395 remainder = (u8 *)*device_path + len_best;
2396 *device_path = (struct efi_device_path *)remainder;
2399 ret = EFI_NOT_FOUND;
2402 return EFI_EXIT(ret);
2406 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2408 * @handle: handle on which the protocol interfaces shall be installed
2409 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2412 * This function implements the MultipleProtocolInterfaces service.
2414 * See the Unified Extensible Firmware Interface (UEFI) specification for
2417 * Return: status code
2419 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2420 (efi_handle_t *handle, ...)
2422 EFI_ENTRY("%p", handle);
2425 const efi_guid_t *protocol;
2426 void *protocol_interface;
2427 efi_handle_t old_handle;
2428 efi_status_t r = EFI_SUCCESS;
2432 return EFI_EXIT(EFI_INVALID_PARAMETER);
2434 efi_va_start(argptr, handle);
2436 protocol = efi_va_arg(argptr, efi_guid_t*);
2439 protocol_interface = efi_va_arg(argptr, void*);
2440 /* Check that a device path has not been installed before */
2441 if (!guidcmp(protocol, &efi_guid_device_path)) {
2442 struct efi_device_path *dp = protocol_interface;
2444 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2446 if (r == EFI_SUCCESS &&
2447 dp->type == DEVICE_PATH_TYPE_END) {
2448 EFI_PRINT("Path %pD already installed\n",
2449 protocol_interface);
2450 r = EFI_ALREADY_STARTED;
2454 r = EFI_CALL(efi_install_protocol_interface(
2456 EFI_NATIVE_INTERFACE,
2457 protocol_interface));
2458 if (r != EFI_SUCCESS)
2463 if (r == EFI_SUCCESS)
2466 /* If an error occurred undo all changes. */
2467 efi_va_start(argptr, handle);
2469 protocol = efi_va_arg(argptr, efi_guid_t*);
2470 protocol_interface = efi_va_arg(argptr, void*);
2471 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2472 protocol_interface));
2480 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2482 * @handle: handle from which the protocol interfaces shall be removed
2483 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2486 * This function implements the UninstallMultipleProtocolInterfaces service.
2488 * See the Unified Extensible Firmware Interface (UEFI) specification for
2491 * Return: status code
2493 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2494 efi_handle_t handle, ...)
2496 EFI_ENTRY("%p", handle);
2499 const efi_guid_t *protocol;
2500 void *protocol_interface;
2501 efi_status_t r = EFI_SUCCESS;
2505 return EFI_EXIT(EFI_INVALID_PARAMETER);
2507 efi_va_start(argptr, handle);
2509 protocol = efi_va_arg(argptr, efi_guid_t*);
2512 protocol_interface = efi_va_arg(argptr, void*);
2513 r = efi_uninstall_protocol(handle, protocol,
2514 protocol_interface);
2515 if (r != EFI_SUCCESS)
2520 if (r == EFI_SUCCESS) {
2521 /* If the last protocol has been removed, delete the handle. */
2522 if (list_empty(&handle->protocols)) {
2523 list_del(&handle->link);
2529 /* If an error occurred undo all changes. */
2530 efi_va_start(argptr, handle);
2532 protocol = efi_va_arg(argptr, efi_guid_t*);
2533 protocol_interface = efi_va_arg(argptr, void*);
2534 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2535 EFI_NATIVE_INTERFACE,
2536 protocol_interface));
2540 /* In case of an error always return EFI_INVALID_PARAMETER */
2541 return EFI_EXIT(EFI_INVALID_PARAMETER);
2545 * efi_calculate_crc32() - calculate cyclic redundancy code
2546 * @data: buffer with data
2547 * @data_size: size of buffer in bytes
2548 * @crc32_p: cyclic redundancy code
2550 * This function implements the CalculateCrc32 service.
2552 * See the Unified Extensible Firmware Interface (UEFI) specification for
2555 * Return: status code
2557 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2558 efi_uintn_t data_size,
2561 efi_status_t ret = EFI_SUCCESS;
2563 EFI_ENTRY("%p, %zu", data, data_size);
2564 if (!data || !data_size || !crc32_p) {
2565 ret = EFI_INVALID_PARAMETER;
2568 *crc32_p = crc32(0, data, data_size);
2570 return EFI_EXIT(ret);
2574 * efi_copy_mem() - copy memory
2575 * @destination: destination of the copy operation
2576 * @source: source of the copy operation
2577 * @length: number of bytes to copy
2579 * This function implements the CopyMem service.
2581 * See the Unified Extensible Firmware Interface (UEFI) specification for
2584 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2587 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2588 memmove(destination, source, length);
2589 EFI_EXIT(EFI_SUCCESS);
2593 * efi_set_mem() - Fill memory with a byte value.
2594 * @buffer: buffer to fill
2595 * @size: size of buffer in bytes
2596 * @value: byte to copy to the buffer
2598 * This function implements the SetMem service.
2600 * See the Unified Extensible Firmware Interface (UEFI) specification for
2603 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2605 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2606 memset(buffer, value, size);
2607 EFI_EXIT(EFI_SUCCESS);
2611 * efi_protocol_open() - open protocol interface on a handle
2612 * @handler: handler of a protocol
2613 * @protocol_interface: interface implementing the protocol
2614 * @agent_handle: handle of the driver
2615 * @controller_handle: handle of the controller
2616 * @attributes: attributes indicating how to open the protocol
2618 * Return: status code
2620 static efi_status_t efi_protocol_open(
2621 struct efi_handler *handler,
2622 void **protocol_interface, void *agent_handle,
2623 void *controller_handle, uint32_t attributes)
2625 struct efi_open_protocol_info_item *item;
2626 struct efi_open_protocol_info_entry *match = NULL;
2627 bool opened_by_driver = false;
2628 bool opened_exclusive = false;
2630 /* If there is no agent, only return the interface */
2634 /* For TEST_PROTOCOL ignore interface attribute */
2635 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2636 *protocol_interface = NULL;
2639 * Check if the protocol is already opened by a driver with the same
2640 * attributes or opened exclusively
2642 list_for_each_entry(item, &handler->open_infos, link) {
2643 if (item->info.agent_handle == agent_handle) {
2644 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2645 (item->info.attributes == attributes))
2646 return EFI_ALREADY_STARTED;
2648 if (item->info.attributes &
2649 EFI_OPEN_PROTOCOL_BY_DRIVER)
2650 opened_by_driver = true;
2652 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2653 opened_exclusive = true;
2656 /* Only one controller can open the protocol exclusively */
2657 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2658 if (opened_exclusive)
2659 return EFI_ACCESS_DENIED;
2660 } else if (attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {
2661 if (opened_exclusive || opened_by_driver)
2662 return EFI_ACCESS_DENIED;
2665 /* Prepare exclusive opening */
2666 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2667 /* Try to disconnect controllers */
2669 opened_by_driver = false;
2670 list_for_each_entry(item, &handler->open_infos, link) {
2673 if (item->info.attributes ==
2674 EFI_OPEN_PROTOCOL_BY_DRIVER) {
2675 ret = EFI_CALL(efi_disconnect_controller(
2676 item->info.controller_handle,
2677 item->info.agent_handle,
2679 if (ret == EFI_SUCCESS)
2681 * Child controllers may have been
2682 * removed from the open_infos list. So
2683 * let's restart the loop.
2685 goto disconnect_next;
2687 opened_by_driver = true;
2690 /* Only one driver can be connected */
2691 if (opened_by_driver)
2692 return EFI_ACCESS_DENIED;
2695 /* Find existing entry */
2696 list_for_each_entry(item, &handler->open_infos, link) {
2697 if (item->info.agent_handle == agent_handle &&
2698 item->info.controller_handle == controller_handle &&
2699 item->info.attributes == attributes)
2700 match = &item->info;
2702 /* None found, create one */
2704 match = efi_create_open_info(handler);
2706 return EFI_OUT_OF_RESOURCES;
2709 match->agent_handle = agent_handle;
2710 match->controller_handle = controller_handle;
2711 match->attributes = attributes;
2712 match->open_count++;
2715 /* For TEST_PROTOCOL ignore interface attribute. */
2716 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2717 *protocol_interface = handler->protocol_interface;
2723 * efi_open_protocol() - open protocol interface on a handle
2724 * @handle: handle on which the protocol shall be opened
2725 * @protocol: GUID of the protocol
2726 * @protocol_interface: interface implementing the protocol
2727 * @agent_handle: handle of the driver
2728 * @controller_handle: handle of the controller
2729 * @attributes: attributes indicating how to open the protocol
2731 * This function implements the OpenProtocol interface.
2733 * See the Unified Extensible Firmware Interface (UEFI) specification for
2736 * Return: status code
2738 static efi_status_t EFIAPI efi_open_protocol
2739 (efi_handle_t handle, const efi_guid_t *protocol,
2740 void **protocol_interface, efi_handle_t agent_handle,
2741 efi_handle_t controller_handle, uint32_t attributes)
2743 struct efi_handler *handler;
2744 efi_status_t r = EFI_INVALID_PARAMETER;
2746 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2747 protocol_interface, agent_handle, controller_handle,
2750 if (!handle || !protocol ||
2751 (!protocol_interface && attributes !=
2752 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2756 switch (attributes) {
2757 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2758 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2759 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2761 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2762 if (controller_handle == handle)
2765 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2766 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2767 /* Check that the controller handle is valid */
2768 if (!efi_search_obj(controller_handle))
2771 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2772 /* Check that the agent handle is valid */
2773 if (!efi_search_obj(agent_handle))
2780 r = efi_search_protocol(handle, protocol, &handler);
2785 r = EFI_UNSUPPORTED;
2791 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2792 controller_handle, attributes);
2798 * efi_start_image() - call the entry point of an image
2799 * @image_handle: handle of the image
2800 * @exit_data_size: size of the buffer
2801 * @exit_data: buffer to receive the exit data of the called image
2803 * This function implements the StartImage service.
2805 * See the Unified Extensible Firmware Interface (UEFI) specification for
2808 * Return: status code
2810 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2811 efi_uintn_t *exit_data_size,
2814 struct efi_loaded_image_obj *image_obj =
2815 (struct efi_loaded_image_obj *)image_handle;
2818 efi_handle_t parent_image = current_image;
2820 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2822 /* Check parameters */
2823 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2825 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2826 if (ret != EFI_SUCCESS)
2827 return EFI_EXIT(EFI_INVALID_PARAMETER);
2829 efi_is_direct_boot = false;
2831 image_obj->exit_data_size = exit_data_size;
2832 image_obj->exit_data = exit_data;
2834 /* call the image! */
2835 if (setjmp(&image_obj->exit_jmp)) {
2837 * We called the entry point of the child image with EFI_CALL
2838 * in the lines below. The child image called the Exit() boot
2839 * service efi_exit() which executed the long jump that brought
2840 * us to the current line. This implies that the second half
2841 * of the EFI_CALL macro has not been executed.
2845 * efi_exit() called efi_restore_gd(). We have to undo this
2846 * otherwise __efi_entry_check() will put the wrong value into
2852 * To get ready to call EFI_EXIT below we have to execute the
2853 * missed out steps of EFI_CALL.
2855 assert(__efi_entry_check());
2856 EFI_PRINT("%lu returned by started image\n",
2857 (unsigned long)((uintptr_t)image_obj->exit_status &
2859 current_image = parent_image;
2860 return EFI_EXIT(image_obj->exit_status);
2863 current_image = image_handle;
2864 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
2865 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
2866 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2869 * Usually UEFI applications call Exit() instead of returning.
2870 * But because the world doesn't consist of ponies and unicorns,
2871 * we're happy to emulate that behavior on behalf of a payload
2874 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2878 * efi_delete_image() - delete loaded image from memory)
2880 * @image_obj: handle of the loaded image
2881 * @loaded_image_protocol: loaded image protocol
2883 static efi_status_t efi_delete_image
2884 (struct efi_loaded_image_obj *image_obj,
2885 struct efi_loaded_image *loaded_image_protocol)
2887 struct efi_object *efiobj;
2888 efi_status_t r, ret = EFI_SUCCESS;
2891 list_for_each_entry(efiobj, &efi_obj_list, link) {
2892 struct efi_handler *protocol;
2894 list_for_each_entry(protocol, &efiobj->protocols, link) {
2895 struct efi_open_protocol_info_item *info;
2897 list_for_each_entry(info, &protocol->open_infos, link) {
2898 if (info->info.agent_handle !=
2899 (efi_handle_t)image_obj)
2901 r = EFI_CALL(efi_close_protocol
2902 (efiobj, protocol->guid,
2903 info->info.agent_handle,
2904 info->info.controller_handle
2906 if (r != EFI_SUCCESS)
2909 * Closing protocols may results in further
2910 * items being deleted. To play it safe loop
2911 * over all elements again.
2918 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2919 efi_size_in_pages(loaded_image_protocol->image_size));
2920 efi_delete_handle(&image_obj->header);
2926 * efi_unload_image() - unload an EFI image
2927 * @image_handle: handle of the image to be unloaded
2929 * This function implements the UnloadImage service.
2931 * See the Unified Extensible Firmware Interface (UEFI) specification for
2934 * Return: status code
2936 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2938 efi_status_t ret = EFI_SUCCESS;
2939 struct efi_object *efiobj;
2940 struct efi_loaded_image *loaded_image_protocol;
2942 EFI_ENTRY("%p", image_handle);
2944 efiobj = efi_search_obj(image_handle);
2946 ret = EFI_INVALID_PARAMETER;
2949 /* Find the loaded image protocol */
2950 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2951 (void **)&loaded_image_protocol,
2953 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2954 if (ret != EFI_SUCCESS) {
2955 ret = EFI_INVALID_PARAMETER;
2958 switch (efiobj->type) {
2959 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2960 /* Call the unload function */
2961 if (!loaded_image_protocol->unload) {
2962 ret = EFI_UNSUPPORTED;
2965 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2966 if (ret != EFI_SUCCESS)
2969 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2972 ret = EFI_INVALID_PARAMETER;
2975 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2976 loaded_image_protocol);
2978 return EFI_EXIT(ret);
2982 * efi_update_exit_data() - fill exit data parameters of StartImage()
2984 * @image_obj image handle
2985 * @exit_data_size size of the exit data buffer
2986 * @exit_data buffer with data returned by UEFI payload
2987 * Return: status code
2989 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2990 efi_uintn_t exit_data_size,
2996 * If exit_data is not provided to StartImage(), exit_data_size must be
2999 if (!image_obj->exit_data)
3001 if (image_obj->exit_data_size)
3002 *image_obj->exit_data_size = exit_data_size;
3003 if (exit_data_size && exit_data) {
3004 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
3006 (void **)image_obj->exit_data);
3007 if (ret != EFI_SUCCESS)
3009 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
3011 image_obj->exit_data = NULL;
3017 * efi_exit() - leave an EFI application or driver
3018 * @image_handle: handle of the application or driver that is exiting
3019 * @exit_status: status code
3020 * @exit_data_size: size of the buffer in bytes
3021 * @exit_data: buffer with data describing an error
3023 * This function implements the Exit service.
3025 * See the Unified Extensible Firmware Interface (UEFI) specification for
3028 * Return: status code
3030 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
3031 efi_status_t exit_status,
3032 efi_uintn_t exit_data_size,
3036 * TODO: We should call the unload procedure of the loaded
3040 struct efi_loaded_image *loaded_image_protocol;
3041 struct efi_loaded_image_obj *image_obj =
3042 (struct efi_loaded_image_obj *)image_handle;
3044 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
3045 exit_data_size, exit_data);
3047 /* Check parameters */
3048 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
3049 (void **)&loaded_image_protocol,
3051 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3052 if (ret != EFI_SUCCESS) {
3053 ret = EFI_INVALID_PARAMETER;
3057 /* Unloading of unstarted images */
3058 switch (image_obj->header.type) {
3059 case EFI_OBJECT_TYPE_STARTED_IMAGE:
3061 case EFI_OBJECT_TYPE_LOADED_IMAGE:
3062 efi_delete_image(image_obj, loaded_image_protocol);
3066 /* Handle does not refer to loaded image */
3067 ret = EFI_INVALID_PARAMETER;
3070 /* A started image can only be unloaded it is the last one started. */
3071 if (image_handle != current_image) {
3072 ret = EFI_INVALID_PARAMETER;
3076 /* Exit data is only foreseen in case of failure. */
3077 if (exit_status != EFI_SUCCESS) {
3078 ret = efi_update_exit_data(image_obj, exit_data_size,
3080 /* Exiting has priority. Don't return error to caller. */
3081 if (ret != EFI_SUCCESS)
3082 EFI_PRINT("%s: out of memory\n", __func__);
3084 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
3085 exit_status != EFI_SUCCESS)
3086 efi_delete_image(image_obj, loaded_image_protocol);
3088 /* Make sure entry/exit counts for EFI world cross-overs match */
3089 EFI_EXIT(exit_status);
3092 * But longjmp out with the U-Boot gd, not the application's, as
3093 * the other end is a setjmp call inside EFI context.
3097 image_obj->exit_status = exit_status;
3098 longjmp(&image_obj->exit_jmp, 1);
3100 panic("EFI application exited");
3102 return EFI_EXIT(ret);
3106 * efi_handle_protocol() - get interface of a protocol on a handle
3107 * @handle: handle on which the protocol shall be opened
3108 * @protocol: GUID of the protocol
3109 * @protocol_interface: interface implementing the protocol
3111 * This function implements the HandleProtocol service.
3113 * See the Unified Extensible Firmware Interface (UEFI) specification for
3116 * Return: status code
3118 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
3119 const efi_guid_t *protocol,
3120 void **protocol_interface)
3122 return efi_open_protocol(handle, protocol, protocol_interface, efi_root,
3123 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
3127 * efi_bind_controller() - bind a single driver to a controller
3128 * @controller_handle: controller handle
3129 * @driver_image_handle: driver handle
3130 * @remain_device_path: remaining path
3132 * Return: status code
3134 static efi_status_t efi_bind_controller(
3135 efi_handle_t controller_handle,
3136 efi_handle_t driver_image_handle,
3137 struct efi_device_path *remain_device_path)
3139 struct efi_driver_binding_protocol *binding_protocol;
3142 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3143 &efi_guid_driver_binding_protocol,
3144 (void **)&binding_protocol,
3145 driver_image_handle, NULL,
3146 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3147 if (r != EFI_SUCCESS)
3149 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3151 remain_device_path));
3152 if (r == EFI_SUCCESS)
3153 r = EFI_CALL(binding_protocol->start(binding_protocol,
3155 remain_device_path));
3156 EFI_CALL(efi_close_protocol(driver_image_handle,
3157 &efi_guid_driver_binding_protocol,
3158 driver_image_handle, NULL));
3163 * efi_connect_single_controller() - connect a single driver to a controller
3164 * @controller_handle: controller
3165 * @driver_image_handle: driver
3166 * @remain_device_path: remaining path
3168 * Return: status code
3170 static efi_status_t efi_connect_single_controller(
3171 efi_handle_t controller_handle,
3172 efi_handle_t *driver_image_handle,
3173 struct efi_device_path *remain_device_path)
3175 efi_handle_t *buffer;
3179 size_t connected = 0;
3181 /* Get buffer with all handles with driver binding protocol */
3182 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3183 &efi_guid_driver_binding_protocol,
3184 NULL, &count, &buffer));
3185 if (r != EFI_SUCCESS)
3188 /* Context Override */
3189 if (driver_image_handle) {
3190 for (; *driver_image_handle; ++driver_image_handle) {
3191 for (i = 0; i < count; ++i) {
3192 if (buffer[i] == *driver_image_handle) {
3194 r = efi_bind_controller(
3196 *driver_image_handle,
3197 remain_device_path);
3199 * For drivers that do not support the
3200 * controller or are already connected
3201 * we receive an error code here.
3203 if (r == EFI_SUCCESS)
3211 * TODO: Some overrides are not yet implemented:
3212 * - Platform Driver Override
3213 * - Driver Family Override Search
3214 * - Bus Specific Driver Override
3217 /* Driver Binding Search */
3218 for (i = 0; i < count; ++i) {
3220 r = efi_bind_controller(controller_handle,
3222 remain_device_path);
3223 if (r == EFI_SUCCESS)
3228 efi_free_pool(buffer);
3230 return EFI_NOT_FOUND;
3235 * efi_connect_controller() - connect a controller to a driver
3236 * @controller_handle: handle of the controller
3237 * @driver_image_handle: handle of the driver
3238 * @remain_device_path: device path of a child controller
3239 * @recursive: true to connect all child controllers
3241 * This function implements the ConnectController service.
3243 * See the Unified Extensible Firmware Interface (UEFI) specification for
3246 * First all driver binding protocol handles are tried for binding drivers.
3247 * Afterwards all handles that have opened a protocol of the controller
3248 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3250 * Return: status code
3252 static efi_status_t EFIAPI efi_connect_controller(
3253 efi_handle_t controller_handle,
3254 efi_handle_t *driver_image_handle,
3255 struct efi_device_path *remain_device_path,
3259 efi_status_t ret = EFI_NOT_FOUND;
3260 struct efi_object *efiobj;
3262 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3263 remain_device_path, recursive);
3265 efiobj = efi_search_obj(controller_handle);
3267 ret = EFI_INVALID_PARAMETER;
3271 r = efi_connect_single_controller(controller_handle,
3272 driver_image_handle,
3273 remain_device_path);
3274 if (r == EFI_SUCCESS)
3277 struct efi_handler *handler;
3278 struct efi_open_protocol_info_item *item;
3280 list_for_each_entry(handler, &efiobj->protocols, link) {
3281 list_for_each_entry(item, &handler->open_infos, link) {
3282 if (item->info.attributes &
3283 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3284 r = EFI_CALL(efi_connect_controller(
3285 item->info.controller_handle,
3286 driver_image_handle,
3289 if (r == EFI_SUCCESS)
3295 /* Check for child controller specified by end node */
3296 if (ret != EFI_SUCCESS && remain_device_path &&
3297 remain_device_path->type == DEVICE_PATH_TYPE_END)
3300 return EFI_EXIT(ret);
3304 * efi_reinstall_protocol_interface() - reinstall protocol interface
3305 * @handle: handle on which the protocol shall be reinstalled
3306 * @protocol: GUID of the protocol to be installed
3307 * @old_interface: interface to be removed
3308 * @new_interface: interface to be installed
3310 * This function implements the ReinstallProtocolInterface service.
3312 * See the Unified Extensible Firmware Interface (UEFI) specification for
3315 * The old interface is uninstalled. The new interface is installed.
3316 * Drivers are connected.
3318 * Return: status code
3320 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3321 efi_handle_t handle, const efi_guid_t *protocol,
3322 void *old_interface, void *new_interface)
3326 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3329 /* Uninstall protocol but do not delete handle */
3330 ret = efi_uninstall_protocol(handle, protocol, old_interface);
3331 if (ret != EFI_SUCCESS)
3334 /* Install the new protocol */
3335 ret = efi_add_protocol(handle, protocol, new_interface);
3337 * The UEFI spec does not specify what should happen to the handle
3338 * if in case of an error no protocol interface remains on the handle.
3339 * So let's do nothing here.
3341 if (ret != EFI_SUCCESS)
3344 * The returned status code has to be ignored.
3345 * Do not create an error if no suitable driver for the handle exists.
3347 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3349 return EFI_EXIT(ret);
3353 * efi_get_child_controllers() - get all child controllers associated to a driver
3354 * @efiobj: handle of the controller
3355 * @driver_handle: handle of the driver
3356 * @number_of_children: number of child controllers
3357 * @child_handle_buffer: handles of the the child controllers
3359 * The allocated buffer has to be freed with free().
3361 * Return: status code
3363 static efi_status_t efi_get_child_controllers(
3364 struct efi_object *efiobj,
3365 efi_handle_t driver_handle,
3366 efi_uintn_t *number_of_children,
3367 efi_handle_t **child_handle_buffer)
3369 struct efi_handler *handler;
3370 struct efi_open_protocol_info_item *item;
3371 efi_uintn_t count = 0, i;
3374 /* Count all child controller associations */
3375 list_for_each_entry(handler, &efiobj->protocols, link) {
3376 list_for_each_entry(item, &handler->open_infos, link) {
3377 if (item->info.agent_handle == driver_handle &&
3378 item->info.attributes &
3379 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3384 * Create buffer. In case of duplicate child controller assignments
3385 * the buffer will be too large. But that does not harm.
3387 *number_of_children = 0;
3388 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3389 if (!*child_handle_buffer)
3390 return EFI_OUT_OF_RESOURCES;
3391 /* Copy unique child handles */
3392 list_for_each_entry(handler, &efiobj->protocols, link) {
3393 list_for_each_entry(item, &handler->open_infos, link) {
3394 if (item->info.agent_handle == driver_handle &&
3395 item->info.attributes &
3396 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3397 /* Check this is a new child controller */
3399 for (i = 0; i < *number_of_children; ++i) {
3400 if ((*child_handle_buffer)[i] ==
3401 item->info.controller_handle)
3404 /* Copy handle to buffer */
3406 i = (*number_of_children)++;
3407 (*child_handle_buffer)[i] =
3408 item->info.controller_handle;
3417 * efi_disconnect_controller() - disconnect a controller from a driver
3418 * @controller_handle: handle of the controller
3419 * @driver_image_handle: handle of the driver
3420 * @child_handle: handle of the child to destroy
3422 * This function implements the DisconnectController service.
3424 * See the Unified Extensible Firmware Interface (UEFI) specification for
3427 * Return: status code
3429 static efi_status_t EFIAPI efi_disconnect_controller(
3430 efi_handle_t controller_handle,
3431 efi_handle_t driver_image_handle,
3432 efi_handle_t child_handle)
3434 struct efi_driver_binding_protocol *binding_protocol;
3435 efi_handle_t *child_handle_buffer = NULL;
3436 size_t number_of_children = 0;
3438 size_t stop_count = 0;
3439 struct efi_object *efiobj;
3441 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3444 efiobj = efi_search_obj(controller_handle);
3446 r = EFI_INVALID_PARAMETER;
3450 if (child_handle && !efi_search_obj(child_handle)) {
3451 r = EFI_INVALID_PARAMETER;
3455 /* If no driver handle is supplied, disconnect all drivers */
3456 if (!driver_image_handle) {
3457 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3461 /* Create list of child handles */
3463 number_of_children = 1;
3464 child_handle_buffer = &child_handle;
3466 efi_get_child_controllers(efiobj,
3467 driver_image_handle,
3468 &number_of_children,
3469 &child_handle_buffer);
3472 /* Get the driver binding protocol */
3473 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3474 &efi_guid_driver_binding_protocol,
3475 (void **)&binding_protocol,
3476 driver_image_handle, NULL,
3477 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3478 if (r != EFI_SUCCESS)
3480 /* Remove the children */
3481 if (number_of_children) {
3482 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3485 child_handle_buffer));
3486 if (r == EFI_SUCCESS)
3489 /* Remove the driver */
3491 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3494 if (r == EFI_SUCCESS)
3496 EFI_CALL(efi_close_protocol(driver_image_handle,
3497 &efi_guid_driver_binding_protocol,
3498 driver_image_handle, NULL));
3506 free(child_handle_buffer);
3510 static struct efi_boot_services efi_boot_services = {
3512 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3513 .revision = EFI_SPECIFICATION_VERSION,
3514 .headersize = sizeof(struct efi_boot_services),
3516 .raise_tpl = efi_raise_tpl,
3517 .restore_tpl = efi_restore_tpl,
3518 .allocate_pages = efi_allocate_pages_ext,
3519 .free_pages = efi_free_pages_ext,
3520 .get_memory_map = efi_get_memory_map_ext,
3521 .allocate_pool = efi_allocate_pool_ext,
3522 .free_pool = efi_free_pool_ext,
3523 .create_event = efi_create_event_ext,
3524 .set_timer = efi_set_timer_ext,
3525 .wait_for_event = efi_wait_for_event,
3526 .signal_event = efi_signal_event_ext,
3527 .close_event = efi_close_event,
3528 .check_event = efi_check_event,
3529 .install_protocol_interface = efi_install_protocol_interface,
3530 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3531 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3532 .handle_protocol = efi_handle_protocol,
3534 .register_protocol_notify = efi_register_protocol_notify,
3535 .locate_handle = efi_locate_handle_ext,
3536 .locate_device_path = efi_locate_device_path,
3537 .install_configuration_table = efi_install_configuration_table_ext,
3538 .load_image = efi_load_image,
3539 .start_image = efi_start_image,
3541 .unload_image = efi_unload_image,
3542 .exit_boot_services = efi_exit_boot_services,
3543 .get_next_monotonic_count = efi_get_next_monotonic_count,
3545 .set_watchdog_timer = efi_set_watchdog_timer,
3546 .connect_controller = efi_connect_controller,
3547 .disconnect_controller = efi_disconnect_controller,
3548 .open_protocol = efi_open_protocol,
3549 .close_protocol = efi_close_protocol,
3550 .open_protocol_information = efi_open_protocol_information,
3551 .protocols_per_handle = efi_protocols_per_handle,
3552 .locate_handle_buffer = efi_locate_handle_buffer,
3553 .locate_protocol = efi_locate_protocol,
3554 .install_multiple_protocol_interfaces =
3555 efi_install_multiple_protocol_interfaces,
3556 .uninstall_multiple_protocol_interfaces =
3557 efi_uninstall_multiple_protocol_interfaces,
3558 .calculate_crc32 = efi_calculate_crc32,
3559 .copy_mem = efi_copy_mem,
3560 .set_mem = efi_set_mem,
3561 .create_event_ex = efi_create_event_ex,
3564 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3566 struct efi_system_table __efi_runtime_data systab = {
3568 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3569 .revision = EFI_SPECIFICATION_VERSION,
3570 .headersize = sizeof(struct efi_system_table),
3572 .fw_vendor = firmware_vendor,
3573 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3574 .con_in = (void *)&efi_con_in,
3575 .con_out = (void *)&efi_con_out,
3576 .std_err = (void *)&efi_con_out,
3577 .runtime = (void *)&efi_runtime_services,
3578 .boottime = (void *)&efi_boot_services,
3584 * efi_initialize_system_table() - Initialize system table
3586 * Return: status code
3588 efi_status_t efi_initialize_system_table(void)
3592 /* Allocate configuration table array */
3593 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3594 EFI_MAX_CONFIGURATION_TABLES *
3595 sizeof(struct efi_configuration_table),
3596 (void **)&systab.tables);
3598 /* Set CRC32 field in table headers */
3599 efi_update_table_header_crc32(&systab.hdr);
3600 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3601 efi_update_table_header_crc32(&efi_boot_services.hdr);