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 efi_signal_event(event->event, true);
1075 if (!guidcmp(&efi_guid_device_path, protocol))
1076 EFI_PRINT("installed device path '%pD'\n", protocol_interface);
1081 * efi_install_protocol_interface() - install protocol interface
1082 * @handle: handle on which the protocol shall be installed
1083 * @protocol: GUID of the protocol to be installed
1084 * @protocol_interface_type: type of the interface to be installed,
1085 * always EFI_NATIVE_INTERFACE
1086 * @protocol_interface: interface of the protocol implementation
1088 * This function implements the InstallProtocolInterface service.
1090 * See the Unified Extensible Firmware Interface (UEFI) specification for
1093 * Return: status code
1095 static efi_status_t EFIAPI efi_install_protocol_interface(
1096 efi_handle_t *handle, const efi_guid_t *protocol,
1097 int protocol_interface_type, void *protocol_interface)
1101 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
1102 protocol_interface);
1104 if (!handle || !protocol ||
1105 protocol_interface_type != EFI_NATIVE_INTERFACE) {
1106 r = EFI_INVALID_PARAMETER;
1110 /* Create new handle if requested. */
1112 r = efi_create_handle(handle);
1113 if (r != EFI_SUCCESS)
1115 EFI_PRINT("new handle %p\n", *handle);
1117 EFI_PRINT("handle %p\n", *handle);
1119 /* Add new protocol */
1120 r = efi_add_protocol(*handle, protocol, protocol_interface);
1126 * efi_get_drivers() - get all drivers associated to a controller
1127 * @handle: handle of the controller
1128 * @protocol: protocol GUID (optional)
1129 * @number_of_drivers: number of child controllers
1130 * @driver_handle_buffer: handles of the the drivers
1132 * The allocated buffer has to be freed with free().
1134 * Return: status code
1136 static efi_status_t efi_get_drivers(efi_handle_t handle,
1137 const efi_guid_t *protocol,
1138 efi_uintn_t *number_of_drivers,
1139 efi_handle_t **driver_handle_buffer)
1141 struct efi_handler *handler;
1142 struct efi_open_protocol_info_item *item;
1143 efi_uintn_t count = 0, i;
1146 /* Count all driver associations */
1147 list_for_each_entry(handler, &handle->protocols, link) {
1148 if (protocol && guidcmp(handler->guid, protocol))
1150 list_for_each_entry(item, &handler->open_infos, link) {
1151 if (item->info.attributes &
1152 EFI_OPEN_PROTOCOL_BY_DRIVER)
1157 * Create buffer. In case of duplicate driver assignments the buffer
1158 * will be too large. But that does not harm.
1160 *number_of_drivers = 0;
1161 *driver_handle_buffer = calloc(count, sizeof(efi_handle_t));
1162 if (!*driver_handle_buffer)
1163 return EFI_OUT_OF_RESOURCES;
1164 /* Collect unique driver handles */
1165 list_for_each_entry(handler, &handle->protocols, link) {
1166 if (protocol && guidcmp(handler->guid, protocol))
1168 list_for_each_entry(item, &handler->open_infos, link) {
1169 if (item->info.attributes &
1170 EFI_OPEN_PROTOCOL_BY_DRIVER) {
1171 /* Check this is a new driver */
1173 for (i = 0; i < *number_of_drivers; ++i) {
1174 if ((*driver_handle_buffer)[i] ==
1175 item->info.agent_handle)
1178 /* Copy handle to buffer */
1180 i = (*number_of_drivers)++;
1181 (*driver_handle_buffer)[i] =
1182 item->info.agent_handle;
1191 * efi_disconnect_all_drivers() - disconnect all drivers from a controller
1192 * @handle: handle of the controller
1193 * @protocol: protocol GUID (optional)
1194 * @child_handle: handle of the child to destroy
1196 * This function implements the DisconnectController service.
1198 * See the Unified Extensible Firmware Interface (UEFI) specification for
1201 * Return: status code
1203 static efi_status_t efi_disconnect_all_drivers
1204 (efi_handle_t handle,
1205 const efi_guid_t *protocol,
1206 efi_handle_t child_handle)
1208 efi_uintn_t number_of_drivers;
1209 efi_handle_t *driver_handle_buffer;
1210 efi_status_t r, ret;
1212 ret = efi_get_drivers(handle, protocol, &number_of_drivers,
1213 &driver_handle_buffer);
1214 if (ret != EFI_SUCCESS)
1217 ret = EFI_NOT_FOUND;
1218 while (number_of_drivers) {
1219 r = EFI_CALL(efi_disconnect_controller(
1221 driver_handle_buffer[--number_of_drivers],
1223 if (r == EFI_SUCCESS)
1226 free(driver_handle_buffer);
1231 * efi_uninstall_protocol() - uninstall protocol interface
1233 * @handle: handle from which the protocol shall be removed
1234 * @protocol: GUID of the protocol to be removed
1235 * @protocol_interface: interface to be removed
1237 * This function DOES NOT delete a handle without installed protocol.
1239 * Return: status code
1241 static efi_status_t efi_uninstall_protocol
1242 (efi_handle_t handle, const efi_guid_t *protocol,
1243 void *protocol_interface)
1245 struct efi_object *efiobj;
1246 struct efi_handler *handler;
1247 struct efi_open_protocol_info_item *item;
1248 struct efi_open_protocol_info_item *pos;
1252 efiobj = efi_search_obj(handle);
1254 r = EFI_INVALID_PARAMETER;
1257 /* Find the protocol on the handle */
1258 r = efi_search_protocol(handle, protocol, &handler);
1259 if (r != EFI_SUCCESS)
1261 /* Disconnect controllers */
1262 efi_disconnect_all_drivers(efiobj, protocol, NULL);
1263 if (!list_empty(&handler->open_infos)) {
1264 r = EFI_ACCESS_DENIED;
1267 /* Close protocol */
1268 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
1269 if (item->info.attributes ==
1270 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL ||
1271 item->info.attributes == EFI_OPEN_PROTOCOL_GET_PROTOCOL ||
1272 item->info.attributes == EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
1273 list_del(&item->link);
1275 if (!list_empty(&handler->open_infos)) {
1276 r = EFI_ACCESS_DENIED;
1279 r = efi_remove_protocol(handle, protocol, protocol_interface);
1285 * efi_uninstall_protocol_interface() - uninstall protocol interface
1286 * @handle: handle from which the protocol shall be removed
1287 * @protocol: GUID of the protocol to be removed
1288 * @protocol_interface: interface to be removed
1290 * This function implements the UninstallProtocolInterface service.
1292 * See the Unified Extensible Firmware Interface (UEFI) specification for
1295 * Return: status code
1297 static efi_status_t EFIAPI efi_uninstall_protocol_interface
1298 (efi_handle_t handle, const efi_guid_t *protocol,
1299 void *protocol_interface)
1303 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
1305 ret = efi_uninstall_protocol(handle, protocol, protocol_interface);
1306 if (ret != EFI_SUCCESS)
1309 /* If the last protocol has been removed, delete the handle. */
1310 if (list_empty(&handle->protocols)) {
1311 list_del(&handle->link);
1315 return EFI_EXIT(ret);
1319 * efi_register_protocol_notify() - register an event for notification when a
1320 * protocol is installed.
1321 * @protocol: GUID of the protocol whose installation shall be notified
1322 * @event: event to be signaled upon installation of the protocol
1323 * @registration: key for retrieving the registration information
1325 * This function implements the RegisterProtocolNotify service.
1326 * See the Unified Extensible Firmware Interface (UEFI) specification
1329 * Return: status code
1331 static efi_status_t EFIAPI efi_register_protocol_notify(
1332 const efi_guid_t *protocol,
1333 struct efi_event *event,
1334 void **registration)
1336 struct efi_register_notify_event *item;
1337 efi_status_t ret = EFI_SUCCESS;
1339 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1341 if (!protocol || !event || !registration) {
1342 ret = EFI_INVALID_PARAMETER;
1346 item = calloc(1, sizeof(struct efi_register_notify_event));
1348 ret = EFI_OUT_OF_RESOURCES;
1352 item->event = event;
1353 memcpy(&item->protocol, protocol, sizeof(efi_guid_t));
1354 INIT_LIST_HEAD(&item->handles);
1356 list_add_tail(&item->link, &efi_register_notify_events);
1358 *registration = item;
1360 return EFI_EXIT(ret);
1364 * efi_search() - determine if an EFI handle implements a protocol
1365 * @search_type: selection criterion
1366 * @protocol: GUID of the protocol
1367 * @search_key: registration key
1370 * See the documentation of the LocateHandle service in the UEFI specification.
1372 * Return: 0 if the handle implements the protocol
1374 static int efi_search(enum efi_locate_search_type search_type,
1375 const efi_guid_t *protocol, efi_handle_t handle)
1379 switch (search_type) {
1383 ret = efi_search_protocol(handle, protocol, NULL);
1384 return (ret != EFI_SUCCESS);
1386 /* Invalid search type */
1392 * efi_check_register_notify_event() - check if registration key is valid
1394 * Check that a pointer is a valid registration key as returned by
1395 * RegisterProtocolNotify().
1397 * @key: registration key
1398 * Return: valid registration key or NULL
1400 static struct efi_register_notify_event *efi_check_register_notify_event
1403 struct efi_register_notify_event *event;
1405 list_for_each_entry(event, &efi_register_notify_events, link) {
1406 if (event == (struct efi_register_notify_event *)key)
1413 * efi_locate_handle() - locate handles implementing a protocol
1415 * @search_type: selection criterion
1416 * @protocol: GUID of the protocol
1417 * @search_key: registration key
1418 * @buffer_size: size of the buffer to receive the handles in bytes
1419 * @buffer: buffer to receive the relevant handles
1421 * This function is meant for U-Boot internal calls. For the API implementation
1422 * of the LocateHandle service see efi_locate_handle_ext.
1424 * Return: status code
1426 static efi_status_t efi_locate_handle(
1427 enum efi_locate_search_type search_type,
1428 const efi_guid_t *protocol, void *search_key,
1429 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1431 struct efi_object *efiobj;
1432 efi_uintn_t size = 0;
1433 struct efi_register_notify_event *event;
1434 struct efi_protocol_notification *handle = NULL;
1436 /* Check parameters */
1437 switch (search_type) {
1440 case BY_REGISTER_NOTIFY:
1442 return EFI_INVALID_PARAMETER;
1443 /* Check that the registration key is valid */
1444 event = efi_check_register_notify_event(search_key);
1446 return EFI_INVALID_PARAMETER;
1450 return EFI_INVALID_PARAMETER;
1453 return EFI_INVALID_PARAMETER;
1456 /* Count how much space we need */
1457 if (search_type == BY_REGISTER_NOTIFY) {
1458 if (list_empty(&event->handles))
1459 return EFI_NOT_FOUND;
1460 handle = list_first_entry(&event->handles,
1461 struct efi_protocol_notification,
1463 efiobj = handle->handle;
1464 size += sizeof(void *);
1466 list_for_each_entry(efiobj, &efi_obj_list, link) {
1467 if (!efi_search(search_type, protocol, efiobj))
1468 size += sizeof(void *);
1471 return EFI_NOT_FOUND;
1475 return EFI_INVALID_PARAMETER;
1477 if (*buffer_size < size) {
1478 *buffer_size = size;
1479 return EFI_BUFFER_TOO_SMALL;
1482 *buffer_size = size;
1484 /* The buffer size is sufficient but there is no buffer */
1486 return EFI_INVALID_PARAMETER;
1488 /* Then fill the array */
1489 if (search_type == BY_REGISTER_NOTIFY) {
1491 list_del(&handle->link);
1493 list_for_each_entry(efiobj, &efi_obj_list, link) {
1494 if (!efi_search(search_type, protocol, efiobj))
1503 * efi_locate_handle_ext() - locate handles implementing a protocol.
1504 * @search_type: selection criterion
1505 * @protocol: GUID of the protocol
1506 * @search_key: registration key
1507 * @buffer_size: size of the buffer to receive the handles in bytes
1508 * @buffer: buffer to receive the relevant handles
1510 * This function implements the LocateHandle service.
1512 * See the Unified Extensible Firmware Interface (UEFI) specification for
1515 * Return: 0 if the handle implements the protocol
1517 static efi_status_t EFIAPI efi_locate_handle_ext(
1518 enum efi_locate_search_type search_type,
1519 const efi_guid_t *protocol, void *search_key,
1520 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1522 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1523 buffer_size, buffer);
1525 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1526 buffer_size, buffer));
1530 * efi_remove_configuration_table() - collapses configuration table entries,
1533 * @i: index of the table entry to be removed
1535 static void efi_remove_configuration_table(int i)
1537 struct efi_configuration_table *this = &systab.tables[i];
1538 struct efi_configuration_table *next = &systab.tables[i + 1];
1539 struct efi_configuration_table *end = &systab.tables[systab.nr_tables];
1541 memmove(this, next, (ulong)end - (ulong)next);
1546 * efi_install_configuration_table() - adds, updates, or removes a
1547 * configuration table
1548 * @guid: GUID of the installed table
1549 * @table: table to be installed
1551 * This function is used for internal calls. For the API implementation of the
1552 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1554 * Return: status code
1556 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
1559 struct efi_event *evt;
1563 return EFI_INVALID_PARAMETER;
1565 /* Check for GUID override */
1566 for (i = 0; i < systab.nr_tables; i++) {
1567 if (!guidcmp(guid, &systab.tables[i].guid)) {
1569 systab.tables[i].table = table;
1571 efi_remove_configuration_table(i);
1577 return EFI_NOT_FOUND;
1579 /* No override, check for overflow */
1580 if (i >= EFI_MAX_CONFIGURATION_TABLES)
1581 return EFI_OUT_OF_RESOURCES;
1583 /* Add a new entry */
1584 memcpy(&systab.tables[i].guid, guid, sizeof(*guid));
1585 systab.tables[i].table = table;
1586 systab.nr_tables = i + 1;
1589 /* systab.nr_tables may have changed. So we need to update the CRC32 */
1590 efi_update_table_header_crc32(&systab.hdr);
1592 /* Notify that the configuration table was changed */
1593 list_for_each_entry(evt, &efi_events, link) {
1594 if (evt->group && !guidcmp(evt->group, guid)) {
1595 efi_signal_event(evt, false);
1604 * efi_install_configuration_table_ex() - Adds, updates, or removes a
1605 * configuration table.
1606 * @guid: GUID of the installed table
1607 * @table: table to be installed
1609 * This function implements the InstallConfigurationTable service.
1611 * See the Unified Extensible Firmware Interface (UEFI) specification for
1614 * Return: status code
1616 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1619 EFI_ENTRY("%pUl, %p", guid, table);
1620 return EFI_EXIT(efi_install_configuration_table(guid, table));
1624 * efi_setup_loaded_image() - initialize a loaded image
1626 * Initialize a loaded_image_info and loaded_image_info object with correct
1627 * protocols, boot-device, etc.
1629 * In case of an error *handle_ptr and *info_ptr are set to NULL and an error
1632 * @device_path: device path of the loaded image
1633 * @file_path: file path of the loaded image
1634 * @handle_ptr: handle of the loaded image
1635 * @info_ptr: loaded image protocol
1636 * Return: status code
1638 efi_status_t efi_setup_loaded_image(struct efi_device_path *device_path,
1639 struct efi_device_path *file_path,
1640 struct efi_loaded_image_obj **handle_ptr,
1641 struct efi_loaded_image **info_ptr)
1644 struct efi_loaded_image *info = NULL;
1645 struct efi_loaded_image_obj *obj = NULL;
1646 struct efi_device_path *dp;
1648 /* In case of EFI_OUT_OF_RESOURCES avoid illegal free by caller. */
1652 info = calloc(1, sizeof(*info));
1654 return EFI_OUT_OF_RESOURCES;
1655 obj = calloc(1, sizeof(*obj));
1658 return EFI_OUT_OF_RESOURCES;
1660 obj->header.type = EFI_OBJECT_TYPE_LOADED_IMAGE;
1662 /* Add internal object to object list */
1663 efi_add_handle(&obj->header);
1665 info->revision = EFI_LOADED_IMAGE_PROTOCOL_REVISION;
1666 info->file_path = file_path;
1667 info->system_table = &systab;
1670 info->device_handle = efi_dp_find_obj(device_path, NULL);
1672 dp = efi_dp_append(device_path, file_path);
1674 ret = EFI_OUT_OF_RESOURCES;
1680 ret = efi_add_protocol(&obj->header,
1681 &efi_guid_loaded_image_device_path, dp);
1682 if (ret != EFI_SUCCESS)
1686 * When asking for the loaded_image interface, just
1687 * return handle which points to loaded_image_info
1689 ret = efi_add_protocol(&obj->header,
1690 &efi_guid_loaded_image, info);
1691 if (ret != EFI_SUCCESS)
1699 printf("ERROR: Failure to install protocols for loaded image\n");
1700 efi_delete_handle(&obj->header);
1706 * efi_load_image_from_path() - load an image using a file path
1708 * Read a file into a buffer allocated as EFI_BOOT_SERVICES_DATA. It is the
1709 * callers obligation to update the memory type as needed.
1711 * @file_path: the path of the image to load
1712 * @buffer: buffer containing the loaded image
1713 * @size: size of the loaded image
1714 * Return: status code
1717 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1718 void **buffer, efi_uintn_t *size)
1720 struct efi_file_info *info = NULL;
1721 struct efi_file_handle *f;
1722 static efi_status_t ret;
1726 /* In case of failure nothing is returned */
1731 f = efi_file_from_path(file_path);
1733 return EFI_DEVICE_ERROR;
1737 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1739 if (ret != EFI_BUFFER_TOO_SMALL) {
1740 ret = EFI_DEVICE_ERROR;
1745 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid, &bs,
1747 if (ret != EFI_SUCCESS)
1751 * When reading the file we do not yet know if it contains an
1752 * application, a boottime driver, or a runtime driver. So here we
1753 * allocate a buffer as EFI_BOOT_SERVICES_DATA. The caller has to
1754 * update the reservation according to the image type.
1756 bs = info->file_size;
1757 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
1758 EFI_BOOT_SERVICES_DATA,
1759 efi_size_in_pages(bs), &addr);
1760 if (ret != EFI_SUCCESS) {
1761 ret = EFI_OUT_OF_RESOURCES;
1766 EFI_CALL(ret = f->read(f, &bs, (void *)(uintptr_t)addr));
1767 if (ret != EFI_SUCCESS)
1768 efi_free_pages(addr, efi_size_in_pages(bs));
1769 *buffer = (void *)(uintptr_t)addr;
1772 EFI_CALL(f->close(f));
1778 * efi_load_image() - load an EFI image into memory
1779 * @boot_policy: true for request originating from the boot manager
1780 * @parent_image: the caller's image handle
1781 * @file_path: the path of the image to load
1782 * @source_buffer: memory location from which the image is installed
1783 * @source_size: size of the memory area from which the image is installed
1784 * @image_handle: handle for the newly installed image
1786 * This function implements the LoadImage service.
1788 * See the Unified Extensible Firmware Interface (UEFI) specification
1791 * Return: status code
1793 efi_status_t EFIAPI efi_load_image(bool boot_policy,
1794 efi_handle_t parent_image,
1795 struct efi_device_path *file_path,
1796 void *source_buffer,
1797 efi_uintn_t source_size,
1798 efi_handle_t *image_handle)
1800 struct efi_device_path *dp, *fp;
1801 struct efi_loaded_image *info = NULL;
1802 struct efi_loaded_image_obj **image_obj =
1803 (struct efi_loaded_image_obj **)image_handle;
1807 EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
1808 file_path, source_buffer, source_size, image_handle);
1810 if (!image_handle || !efi_search_obj(parent_image)) {
1811 ret = EFI_INVALID_PARAMETER;
1815 if (!source_buffer && !file_path) {
1816 ret = EFI_NOT_FOUND;
1819 /* The parent image handle must refer to a loaded image */
1820 if (!parent_image->type) {
1821 ret = EFI_INVALID_PARAMETER;
1825 if (!source_buffer) {
1826 ret = efi_load_image_from_path(file_path, &dest_buffer,
1828 if (ret != EFI_SUCCESS)
1832 ret = EFI_LOAD_ERROR;
1835 dest_buffer = source_buffer;
1837 /* split file_path which contains both the device and file parts */
1838 efi_dp_split_file_path(file_path, &dp, &fp);
1839 ret = efi_setup_loaded_image(dp, fp, image_obj, &info);
1840 if (ret == EFI_SUCCESS)
1841 ret = efi_load_pe(*image_obj, dest_buffer, info);
1843 /* Release buffer to which file was loaded */
1844 efi_free_pages((uintptr_t)dest_buffer,
1845 efi_size_in_pages(source_size));
1846 if (ret == EFI_SUCCESS) {
1847 info->system_table = &systab;
1848 info->parent_handle = parent_image;
1850 /* The image is invalid. Release all associated resources. */
1851 efi_delete_handle(*image_handle);
1852 *image_handle = NULL;
1856 return EFI_EXIT(ret);
1860 * efi_exit_caches() - fix up caches for EFI payloads if necessary
1862 static void efi_exit_caches(void)
1864 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1866 * Grub on 32bit ARM needs to have caches disabled before jumping into
1867 * a zImage, but does not know of all cache layers. Give it a hand.
1869 if (efi_is_direct_boot)
1870 cleanup_before_linux();
1875 * efi_exit_boot_services() - stop all boot services
1876 * @image_handle: handle of the loaded image
1877 * @map_key: key of the memory map
1879 * This function implements the ExitBootServices service.
1881 * See the Unified Extensible Firmware Interface (UEFI) specification
1884 * All timer events are disabled. For exit boot services events the
1885 * notification function is called. The boot services are disabled in the
1888 * Return: status code
1890 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
1891 efi_uintn_t map_key)
1893 struct efi_event *evt;
1895 EFI_ENTRY("%p, %zx", image_handle, map_key);
1897 /* Check that the caller has read the current memory map */
1898 if (map_key != efi_memory_map_key)
1899 return EFI_INVALID_PARAMETER;
1901 /* Make sure that notification functions are not called anymore */
1902 efi_tpl = TPL_HIGH_LEVEL;
1904 /* Check if ExitBootServices has already been called */
1905 if (!systab.boottime)
1906 return EFI_EXIT(EFI_SUCCESS);
1908 /* Add related events to the event group */
1909 list_for_each_entry(evt, &efi_events, link) {
1910 if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
1911 evt->group = &efi_guid_event_group_exit_boot_services;
1913 /* Notify that ExitBootServices is invoked. */
1914 list_for_each_entry(evt, &efi_events, link) {
1916 !guidcmp(evt->group,
1917 &efi_guid_event_group_exit_boot_services)) {
1918 efi_signal_event(evt, false);
1923 /* TODO: Should persist EFI variables here */
1925 board_quiesce_devices();
1927 /* Fix up caches for EFI payloads if necessary */
1930 /* This stops all lingering devices */
1931 bootm_disable_interrupts();
1933 /* Disable boot time services */
1934 systab.con_in_handle = NULL;
1935 systab.con_in = NULL;
1936 systab.con_out_handle = NULL;
1937 systab.con_out = NULL;
1938 systab.stderr_handle = NULL;
1939 systab.std_err = NULL;
1940 systab.boottime = NULL;
1942 /* Recalculate CRC32 */
1943 efi_update_table_header_crc32(&systab.hdr);
1945 /* Give the payload some time to boot */
1946 efi_set_watchdog(0);
1949 return EFI_EXIT(EFI_SUCCESS);
1953 * efi_get_next_monotonic_count() - get next value of the counter
1954 * @count: returned value of the counter
1956 * This function implements the NextMonotonicCount service.
1958 * See the Unified Extensible Firmware Interface (UEFI) specification for
1961 * Return: status code
1963 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1965 static uint64_t mono;
1968 EFI_ENTRY("%p", count);
1970 ret = EFI_INVALID_PARAMETER;
1976 return EFI_EXIT(ret);
1980 * efi_stall() - sleep
1981 * @microseconds: period to sleep in microseconds
1983 * This function implements the Stall service.
1985 * See the Unified Extensible Firmware Interface (UEFI) specification for
1988 * Return: status code
1990 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1992 EFI_ENTRY("%ld", microseconds);
1993 udelay(microseconds);
1994 return EFI_EXIT(EFI_SUCCESS);
1998 * efi_set_watchdog_timer() - reset the watchdog timer
1999 * @timeout: seconds before reset by watchdog
2000 * @watchdog_code: code to be logged when resetting
2001 * @data_size: size of buffer in bytes
2002 * @watchdog_data: buffer with data describing the reset reason
2004 * This function implements the SetWatchdogTimer service.
2006 * See the Unified Extensible Firmware Interface (UEFI) specification for
2009 * Return: status code
2011 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
2012 uint64_t watchdog_code,
2013 unsigned long data_size,
2014 uint16_t *watchdog_data)
2016 EFI_ENTRY("%ld, 0x%llx, %ld, %p", timeout, watchdog_code,
2017 data_size, watchdog_data);
2018 return EFI_EXIT(efi_set_watchdog(timeout));
2022 * efi_close_protocol() - close a protocol
2023 * @handle: handle on which the protocol shall be closed
2024 * @protocol: GUID of the protocol to close
2025 * @agent_handle: handle of the driver
2026 * @controller_handle: handle of the controller
2028 * This function implements the CloseProtocol service.
2030 * See the Unified Extensible Firmware Interface (UEFI) specification for
2033 * Return: status code
2035 static efi_status_t EFIAPI efi_close_protocol(efi_handle_t handle,
2036 const efi_guid_t *protocol,
2037 efi_handle_t agent_handle,
2038 efi_handle_t controller_handle)
2040 struct efi_handler *handler;
2041 struct efi_open_protocol_info_item *item;
2042 struct efi_open_protocol_info_item *pos;
2045 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
2048 if (!efi_search_obj(agent_handle) ||
2049 (controller_handle && !efi_search_obj(controller_handle))) {
2050 r = EFI_INVALID_PARAMETER;
2053 r = efi_search_protocol(handle, protocol, &handler);
2054 if (r != EFI_SUCCESS)
2058 list_for_each_entry_safe(item, pos, &handler->open_infos, link) {
2059 if (item->info.agent_handle == agent_handle &&
2060 item->info.controller_handle == controller_handle) {
2061 efi_delete_open_info(item);
2071 * efi_open_protocol_information() - provide information about then open status
2072 * of a protocol on a handle
2073 * @handle: handle for which the information shall be retrieved
2074 * @protocol: GUID of the protocol
2075 * @entry_buffer: buffer to receive the open protocol information
2076 * @entry_count: number of entries available in the buffer
2078 * This function implements the OpenProtocolInformation service.
2080 * See the Unified Extensible Firmware Interface (UEFI) specification for
2083 * Return: status code
2085 static efi_status_t EFIAPI efi_open_protocol_information(
2086 efi_handle_t handle, const efi_guid_t *protocol,
2087 struct efi_open_protocol_info_entry **entry_buffer,
2088 efi_uintn_t *entry_count)
2090 unsigned long buffer_size;
2091 unsigned long count;
2092 struct efi_handler *handler;
2093 struct efi_open_protocol_info_item *item;
2096 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
2099 /* Check parameters */
2100 if (!entry_buffer) {
2101 r = EFI_INVALID_PARAMETER;
2104 r = efi_search_protocol(handle, protocol, &handler);
2105 if (r != EFI_SUCCESS)
2110 list_for_each_entry(item, &handler->open_infos, link) {
2111 if (item->info.open_count)
2114 *entry_count = count;
2115 *entry_buffer = NULL;
2122 buffer_size = count * sizeof(struct efi_open_protocol_info_entry);
2123 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2124 (void **)entry_buffer);
2125 if (r != EFI_SUCCESS)
2127 list_for_each_entry_reverse(item, &handler->open_infos, link) {
2128 if (item->info.open_count)
2129 (*entry_buffer)[--count] = item->info;
2136 * efi_protocols_per_handle() - get protocols installed on a handle
2137 * @handle: handle for which the information is retrieved
2138 * @protocol_buffer: buffer with protocol GUIDs
2139 * @protocol_buffer_count: number of entries in the buffer
2141 * This function implements the ProtocolsPerHandleService.
2143 * See the Unified Extensible Firmware Interface (UEFI) specification for
2146 * Return: status code
2148 static efi_status_t EFIAPI efi_protocols_per_handle(
2149 efi_handle_t handle, efi_guid_t ***protocol_buffer,
2150 efi_uintn_t *protocol_buffer_count)
2152 unsigned long buffer_size;
2153 struct efi_object *efiobj;
2154 struct list_head *protocol_handle;
2157 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
2158 protocol_buffer_count);
2160 if (!handle || !protocol_buffer || !protocol_buffer_count)
2161 return EFI_EXIT(EFI_INVALID_PARAMETER);
2163 *protocol_buffer = NULL;
2164 *protocol_buffer_count = 0;
2166 efiobj = efi_search_obj(handle);
2168 return EFI_EXIT(EFI_INVALID_PARAMETER);
2170 /* Count protocols */
2171 list_for_each(protocol_handle, &efiobj->protocols) {
2172 ++*protocol_buffer_count;
2176 if (*protocol_buffer_count) {
2179 buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
2180 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2181 (void **)protocol_buffer);
2182 if (r != EFI_SUCCESS)
2184 list_for_each(protocol_handle, &efiobj->protocols) {
2185 struct efi_handler *protocol;
2187 protocol = list_entry(protocol_handle,
2188 struct efi_handler, link);
2189 (*protocol_buffer)[j] = (void *)protocol->guid;
2194 return EFI_EXIT(EFI_SUCCESS);
2198 * efi_locate_handle_buffer() - locate handles implementing a protocol
2199 * @search_type: selection criterion
2200 * @protocol: GUID of the protocol
2201 * @search_key: registration key
2202 * @no_handles: number of returned handles
2203 * @buffer: buffer with the returned handles
2205 * This function implements the LocateHandleBuffer service.
2207 * See the Unified Extensible Firmware Interface (UEFI) specification for
2210 * Return: status code
2212 static efi_status_t EFIAPI efi_locate_handle_buffer(
2213 enum efi_locate_search_type search_type,
2214 const efi_guid_t *protocol, void *search_key,
2215 efi_uintn_t *no_handles, efi_handle_t **buffer)
2218 efi_uintn_t buffer_size = 0;
2220 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
2221 no_handles, buffer);
2223 if (!no_handles || !buffer) {
2224 r = EFI_INVALID_PARAMETER;
2229 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2231 if (r != EFI_BUFFER_TOO_SMALL)
2233 r = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
2235 if (r != EFI_SUCCESS)
2237 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
2239 if (r == EFI_SUCCESS)
2240 *no_handles = buffer_size / sizeof(efi_handle_t);
2246 * efi_locate_protocol() - find an interface implementing a protocol
2247 * @protocol: GUID of the protocol
2248 * @registration: registration key passed to the notification function
2249 * @protocol_interface: interface implementing the protocol
2251 * This function implements the LocateProtocol service.
2253 * See the Unified Extensible Firmware Interface (UEFI) specification for
2256 * Return: status code
2258 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
2260 void **protocol_interface)
2262 struct list_head *lhandle;
2265 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
2267 if (!protocol || !protocol_interface)
2268 return EFI_EXIT(EFI_INVALID_PARAMETER);
2270 list_for_each(lhandle, &efi_obj_list) {
2271 struct efi_object *efiobj;
2272 struct efi_handler *handler;
2274 efiobj = list_entry(lhandle, struct efi_object, link);
2276 ret = efi_search_protocol(efiobj, protocol, &handler);
2277 if (ret == EFI_SUCCESS) {
2278 *protocol_interface = handler->protocol_interface;
2279 return EFI_EXIT(EFI_SUCCESS);
2282 *protocol_interface = NULL;
2284 return EFI_EXIT(EFI_NOT_FOUND);
2288 * efi_locate_device_path() - Get the device path and handle of an device
2289 * implementing a protocol
2290 * @protocol: GUID of the protocol
2291 * @device_path: device path
2292 * @device: handle of the device
2294 * This function implements the LocateDevicePath service.
2296 * See the Unified Extensible Firmware Interface (UEFI) specification for
2299 * Return: status code
2301 static efi_status_t EFIAPI efi_locate_device_path(
2302 const efi_guid_t *protocol,
2303 struct efi_device_path **device_path,
2304 efi_handle_t *device)
2306 struct efi_device_path *dp;
2308 struct efi_handler *handler;
2309 efi_handle_t *handles;
2311 size_t len_best = 0;
2312 efi_uintn_t no_handles;
2316 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
2318 if (!protocol || !device_path || !*device_path) {
2319 ret = EFI_INVALID_PARAMETER;
2323 /* Find end of device path */
2324 len = efi_dp_instance_size(*device_path);
2326 /* Get all handles implementing the protocol */
2327 ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
2328 &no_handles, &handles));
2329 if (ret != EFI_SUCCESS)
2332 for (i = 0; i < no_handles; ++i) {
2333 /* Find the device path protocol */
2334 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
2336 if (ret != EFI_SUCCESS)
2338 dp = (struct efi_device_path *)handler->protocol_interface;
2339 len_dp = efi_dp_instance_size(dp);
2341 * This handle can only be a better fit
2342 * if its device path length is longer than the best fit and
2343 * if its device path length is shorter of equal the searched
2346 if (len_dp <= len_best || len_dp > len)
2348 /* Check if dp is a subpath of device_path */
2349 if (memcmp(*device_path, dp, len_dp))
2352 ret = EFI_INVALID_PARAMETER;
2355 *device = handles[i];
2359 remainder = (u8 *)*device_path + len_best;
2360 *device_path = (struct efi_device_path *)remainder;
2363 ret = EFI_NOT_FOUND;
2366 return EFI_EXIT(ret);
2370 * efi_install_multiple_protocol_interfaces() - Install multiple protocol
2372 * @handle: handle on which the protocol interfaces shall be installed
2373 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2376 * This function implements the MultipleProtocolInterfaces service.
2378 * See the Unified Extensible Firmware Interface (UEFI) specification for
2381 * Return: status code
2383 efi_status_t EFIAPI efi_install_multiple_protocol_interfaces
2384 (efi_handle_t *handle, ...)
2386 EFI_ENTRY("%p", handle);
2389 const efi_guid_t *protocol;
2390 void *protocol_interface;
2391 efi_handle_t old_handle;
2392 efi_status_t r = EFI_SUCCESS;
2396 return EFI_EXIT(EFI_INVALID_PARAMETER);
2398 efi_va_start(argptr, handle);
2400 protocol = efi_va_arg(argptr, efi_guid_t*);
2403 protocol_interface = efi_va_arg(argptr, void*);
2404 /* Check that a device path has not been installed before */
2405 if (!guidcmp(protocol, &efi_guid_device_path)) {
2406 struct efi_device_path *dp = protocol_interface;
2408 r = EFI_CALL(efi_locate_device_path(protocol, &dp,
2410 if (r == EFI_SUCCESS &&
2411 dp->type == DEVICE_PATH_TYPE_END) {
2412 EFI_PRINT("Path %pD already installed\n",
2413 protocol_interface);
2414 r = EFI_ALREADY_STARTED;
2418 r = EFI_CALL(efi_install_protocol_interface(
2420 EFI_NATIVE_INTERFACE,
2421 protocol_interface));
2422 if (r != EFI_SUCCESS)
2427 if (r == EFI_SUCCESS)
2430 /* If an error occurred undo all changes. */
2431 efi_va_start(argptr, handle);
2433 protocol = efi_va_arg(argptr, efi_guid_t*);
2434 protocol_interface = efi_va_arg(argptr, void*);
2435 EFI_CALL(efi_uninstall_protocol_interface(*handle, protocol,
2436 protocol_interface));
2444 * efi_uninstall_multiple_protocol_interfaces() - uninstall multiple protocol
2446 * @handle: handle from which the protocol interfaces shall be removed
2447 * @...: NULL terminated argument list with pairs of protocol GUIDS and
2450 * This function implements the UninstallMultipleProtocolInterfaces service.
2452 * See the Unified Extensible Firmware Interface (UEFI) specification for
2455 * Return: status code
2457 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
2458 efi_handle_t handle, ...)
2460 EFI_ENTRY("%p", handle);
2463 const efi_guid_t *protocol;
2464 void *protocol_interface;
2465 efi_status_t r = EFI_SUCCESS;
2469 return EFI_EXIT(EFI_INVALID_PARAMETER);
2471 efi_va_start(argptr, handle);
2473 protocol = efi_va_arg(argptr, efi_guid_t*);
2476 protocol_interface = efi_va_arg(argptr, void*);
2477 r = efi_uninstall_protocol(handle, protocol,
2478 protocol_interface);
2479 if (r != EFI_SUCCESS)
2484 if (r == EFI_SUCCESS) {
2485 /* If the last protocol has been removed, delete the handle. */
2486 if (list_empty(&handle->protocols)) {
2487 list_del(&handle->link);
2493 /* If an error occurred undo all changes. */
2494 efi_va_start(argptr, handle);
2496 protocol = efi_va_arg(argptr, efi_guid_t*);
2497 protocol_interface = efi_va_arg(argptr, void*);
2498 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
2499 EFI_NATIVE_INTERFACE,
2500 protocol_interface));
2504 /* In case of an error always return EFI_INVALID_PARAMETER */
2505 return EFI_EXIT(EFI_INVALID_PARAMETER);
2509 * efi_calculate_crc32() - calculate cyclic redundancy code
2510 * @data: buffer with data
2511 * @data_size: size of buffer in bytes
2512 * @crc32_p: cyclic redundancy code
2514 * This function implements the CalculateCrc32 service.
2516 * See the Unified Extensible Firmware Interface (UEFI) specification for
2519 * Return: status code
2521 static efi_status_t EFIAPI efi_calculate_crc32(const void *data,
2522 efi_uintn_t data_size,
2525 efi_status_t ret = EFI_SUCCESS;
2527 EFI_ENTRY("%p, %zu", data, data_size);
2528 if (!data || !data_size || !crc32_p) {
2529 ret = EFI_INVALID_PARAMETER;
2532 *crc32_p = crc32(0, data, data_size);
2534 return EFI_EXIT(ret);
2538 * efi_copy_mem() - copy memory
2539 * @destination: destination of the copy operation
2540 * @source: source of the copy operation
2541 * @length: number of bytes to copy
2543 * This function implements the CopyMem service.
2545 * See the Unified Extensible Firmware Interface (UEFI) specification for
2548 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2551 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2552 memmove(destination, source, length);
2553 EFI_EXIT(EFI_SUCCESS);
2557 * efi_set_mem() - Fill memory with a byte value.
2558 * @buffer: buffer to fill
2559 * @size: size of buffer in bytes
2560 * @value: byte to copy to the buffer
2562 * This function implements the SetMem service.
2564 * See the Unified Extensible Firmware Interface (UEFI) specification for
2567 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2569 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2570 memset(buffer, value, size);
2571 EFI_EXIT(EFI_SUCCESS);
2575 * efi_protocol_open() - open protocol interface on a handle
2576 * @handler: handler of a protocol
2577 * @protocol_interface: interface implementing the protocol
2578 * @agent_handle: handle of the driver
2579 * @controller_handle: handle of the controller
2580 * @attributes: attributes indicating how to open the protocol
2582 * Return: status code
2584 static efi_status_t efi_protocol_open(
2585 struct efi_handler *handler,
2586 void **protocol_interface, void *agent_handle,
2587 void *controller_handle, uint32_t attributes)
2589 struct efi_open_protocol_info_item *item;
2590 struct efi_open_protocol_info_entry *match = NULL;
2591 bool opened_by_driver = false;
2592 bool opened_exclusive = false;
2594 /* If there is no agent, only return the interface */
2598 /* For TEST_PROTOCOL ignore interface attribute */
2599 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2600 *protocol_interface = NULL;
2603 * Check if the protocol is already opened by a driver with the same
2604 * attributes or opened exclusively
2606 list_for_each_entry(item, &handler->open_infos, link) {
2607 if (item->info.agent_handle == agent_handle) {
2608 if ((attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) &&
2609 (item->info.attributes == attributes))
2610 return EFI_ALREADY_STARTED;
2612 if (item->info.attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE)
2613 opened_exclusive = true;
2616 /* Only one controller can open the protocol exclusively */
2617 if (opened_exclusive && attributes &
2618 (EFI_OPEN_PROTOCOL_EXCLUSIVE | EFI_OPEN_PROTOCOL_BY_DRIVER))
2619 return EFI_ACCESS_DENIED;
2621 /* Prepare exclusive opening */
2622 if (attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {
2623 /* Try to disconnect controllers */
2624 list_for_each_entry(item, &handler->open_infos, link) {
2625 if (item->info.attributes ==
2626 EFI_OPEN_PROTOCOL_BY_DRIVER)
2627 EFI_CALL(efi_disconnect_controller(
2628 item->info.controller_handle,
2629 item->info.agent_handle,
2632 opened_by_driver = false;
2633 /* Check if all controllers are disconnected */
2634 list_for_each_entry(item, &handler->open_infos, link) {
2635 if (item->info.attributes & EFI_OPEN_PROTOCOL_BY_DRIVER)
2636 opened_by_driver = true;
2638 /* Only one controller can be connected */
2639 if (opened_by_driver)
2640 return EFI_ACCESS_DENIED;
2643 /* Find existing entry */
2644 list_for_each_entry(item, &handler->open_infos, link) {
2645 if (item->info.agent_handle == agent_handle &&
2646 item->info.controller_handle == controller_handle)
2647 match = &item->info;
2649 /* None found, create one */
2651 match = efi_create_open_info(handler);
2653 return EFI_OUT_OF_RESOURCES;
2656 match->agent_handle = agent_handle;
2657 match->controller_handle = controller_handle;
2658 match->attributes = attributes;
2659 match->open_count++;
2662 /* For TEST_PROTOCOL ignore interface attribute. */
2663 if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
2664 *protocol_interface = handler->protocol_interface;
2670 * efi_open_protocol() - open protocol interface on a handle
2671 * @handle: handle on which the protocol shall be opened
2672 * @protocol: GUID of the protocol
2673 * @protocol_interface: interface implementing the protocol
2674 * @agent_handle: handle of the driver
2675 * @controller_handle: handle of the controller
2676 * @attributes: attributes indicating how to open the protocol
2678 * This function implements the OpenProtocol interface.
2680 * See the Unified Extensible Firmware Interface (UEFI) specification for
2683 * Return: status code
2685 static efi_status_t EFIAPI efi_open_protocol
2686 (efi_handle_t handle, const efi_guid_t *protocol,
2687 void **protocol_interface, efi_handle_t agent_handle,
2688 efi_handle_t controller_handle, uint32_t attributes)
2690 struct efi_handler *handler;
2691 efi_status_t r = EFI_INVALID_PARAMETER;
2693 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2694 protocol_interface, agent_handle, controller_handle,
2697 if (!handle || !protocol ||
2698 (!protocol_interface && attributes !=
2699 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2703 switch (attributes) {
2704 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2705 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2706 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2708 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2709 if (controller_handle == handle)
2712 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2713 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2714 /* Check that the controller handle is valid */
2715 if (!efi_search_obj(controller_handle))
2718 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2719 /* Check that the agent handle is valid */
2720 if (!efi_search_obj(agent_handle))
2727 r = efi_search_protocol(handle, protocol, &handler);
2732 r = EFI_UNSUPPORTED;
2738 r = efi_protocol_open(handler, protocol_interface, agent_handle,
2739 controller_handle, attributes);
2745 * efi_start_image() - call the entry point of an image
2746 * @image_handle: handle of the image
2747 * @exit_data_size: size of the buffer
2748 * @exit_data: buffer to receive the exit data of the called image
2750 * This function implements the StartImage service.
2752 * See the Unified Extensible Firmware Interface (UEFI) specification for
2755 * Return: status code
2757 efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
2758 efi_uintn_t *exit_data_size,
2761 struct efi_loaded_image_obj *image_obj =
2762 (struct efi_loaded_image_obj *)image_handle;
2765 efi_handle_t parent_image = current_image;
2767 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
2769 /* Check parameters */
2770 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2772 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2773 if (ret != EFI_SUCCESS)
2774 return EFI_EXIT(EFI_INVALID_PARAMETER);
2776 efi_is_direct_boot = false;
2778 image_obj->exit_data_size = exit_data_size;
2779 image_obj->exit_data = exit_data;
2781 /* call the image! */
2782 if (setjmp(&image_obj->exit_jmp)) {
2784 * We called the entry point of the child image with EFI_CALL
2785 * in the lines below. The child image called the Exit() boot
2786 * service efi_exit() which executed the long jump that brought
2787 * us to the current line. This implies that the second half
2788 * of the EFI_CALL macro has not been executed.
2792 * efi_exit() called efi_restore_gd(). We have to undo this
2793 * otherwise __efi_entry_check() will put the wrong value into
2799 * To get ready to call EFI_EXIT below we have to execute the
2800 * missed out steps of EFI_CALL.
2802 assert(__efi_entry_check());
2803 EFI_PRINT("%lu returned by started image\n",
2804 (unsigned long)((uintptr_t)image_obj->exit_status &
2806 current_image = parent_image;
2807 return EFI_EXIT(image_obj->exit_status);
2810 current_image = image_handle;
2811 image_obj->header.type = EFI_OBJECT_TYPE_STARTED_IMAGE;
2812 EFI_PRINT("Jumping into 0x%p\n", image_obj->entry);
2813 ret = EFI_CALL(image_obj->entry(image_handle, &systab));
2816 * Usually UEFI applications call Exit() instead of returning.
2817 * But because the world doesn't consist of ponies and unicorns,
2818 * we're happy to emulate that behavior on behalf of a payload
2821 return EFI_CALL(systab.boottime->exit(image_handle, ret, 0, NULL));
2825 * efi_delete_image() - delete loaded image from memory)
2827 * @image_obj: handle of the loaded image
2828 * @loaded_image_protocol: loaded image protocol
2830 static void efi_delete_image(struct efi_loaded_image_obj *image_obj,
2831 struct efi_loaded_image *loaded_image_protocol)
2833 efi_free_pages((uintptr_t)loaded_image_protocol->image_base,
2834 efi_size_in_pages(loaded_image_protocol->image_size));
2835 efi_delete_handle(&image_obj->header);
2839 * efi_unload_image() - unload an EFI image
2840 * @image_handle: handle of the image to be unloaded
2842 * This function implements the UnloadImage service.
2844 * See the Unified Extensible Firmware Interface (UEFI) specification for
2847 * Return: status code
2849 efi_status_t EFIAPI efi_unload_image(efi_handle_t image_handle)
2851 efi_status_t ret = EFI_SUCCESS;
2852 struct efi_object *efiobj;
2853 struct efi_loaded_image *loaded_image_protocol;
2855 EFI_ENTRY("%p", image_handle);
2857 efiobj = efi_search_obj(image_handle);
2859 ret = EFI_INVALID_PARAMETER;
2862 /* Find the loaded image protocol */
2863 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2864 (void **)&loaded_image_protocol,
2866 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2867 if (ret != EFI_SUCCESS) {
2868 ret = EFI_INVALID_PARAMETER;
2871 switch (efiobj->type) {
2872 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2873 /* Call the unload function */
2874 if (!loaded_image_protocol->unload) {
2875 ret = EFI_UNSUPPORTED;
2878 ret = EFI_CALL(loaded_image_protocol->unload(image_handle));
2879 if (ret != EFI_SUCCESS)
2882 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2885 ret = EFI_INVALID_PARAMETER;
2888 efi_delete_image((struct efi_loaded_image_obj *)efiobj,
2889 loaded_image_protocol);
2891 return EFI_EXIT(ret);
2895 * efi_update_exit_data() - fill exit data parameters of StartImage()
2897 * @image_obj image handle
2898 * @exit_data_size size of the exit data buffer
2899 * @exit_data buffer with data returned by UEFI payload
2900 * Return: status code
2902 static efi_status_t efi_update_exit_data(struct efi_loaded_image_obj *image_obj,
2903 efi_uintn_t exit_data_size,
2909 * If exit_data is not provided to StartImage(), exit_data_size must be
2912 if (!image_obj->exit_data)
2914 if (image_obj->exit_data_size)
2915 *image_obj->exit_data_size = exit_data_size;
2916 if (exit_data_size && exit_data) {
2917 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA,
2919 (void **)image_obj->exit_data);
2920 if (ret != EFI_SUCCESS)
2922 memcpy(*image_obj->exit_data, exit_data, exit_data_size);
2924 image_obj->exit_data = NULL;
2930 * efi_exit() - leave an EFI application or driver
2931 * @image_handle: handle of the application or driver that is exiting
2932 * @exit_status: status code
2933 * @exit_data_size: size of the buffer in bytes
2934 * @exit_data: buffer with data describing an error
2936 * This function implements the Exit service.
2938 * See the Unified Extensible Firmware Interface (UEFI) specification for
2941 * Return: status code
2943 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
2944 efi_status_t exit_status,
2945 efi_uintn_t exit_data_size,
2949 * TODO: We should call the unload procedure of the loaded
2953 struct efi_loaded_image *loaded_image_protocol;
2954 struct efi_loaded_image_obj *image_obj =
2955 (struct efi_loaded_image_obj *)image_handle;
2957 EFI_ENTRY("%p, %ld, %zu, %p", image_handle, exit_status,
2958 exit_data_size, exit_data);
2960 /* Check parameters */
2961 ret = EFI_CALL(efi_open_protocol(image_handle, &efi_guid_loaded_image,
2962 (void **)&loaded_image_protocol,
2964 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
2965 if (ret != EFI_SUCCESS) {
2966 ret = EFI_INVALID_PARAMETER;
2970 /* Unloading of unstarted images */
2971 switch (image_obj->header.type) {
2972 case EFI_OBJECT_TYPE_STARTED_IMAGE:
2974 case EFI_OBJECT_TYPE_LOADED_IMAGE:
2975 efi_delete_image(image_obj, loaded_image_protocol);
2979 /* Handle does not refer to loaded image */
2980 ret = EFI_INVALID_PARAMETER;
2983 /* A started image can only be unloaded it is the last one started. */
2984 if (image_handle != current_image) {
2985 ret = EFI_INVALID_PARAMETER;
2989 /* Exit data is only foreseen in case of failure. */
2990 if (exit_status != EFI_SUCCESS) {
2991 ret = efi_update_exit_data(image_obj, exit_data_size,
2993 /* Exiting has priority. Don't return error to caller. */
2994 if (ret != EFI_SUCCESS)
2995 EFI_PRINT("%s: out of memory\n", __func__);
2997 if (image_obj->image_type == IMAGE_SUBSYSTEM_EFI_APPLICATION ||
2998 exit_status != EFI_SUCCESS)
2999 efi_delete_image(image_obj, loaded_image_protocol);
3001 /* Make sure entry/exit counts for EFI world cross-overs match */
3002 EFI_EXIT(exit_status);
3005 * But longjmp out with the U-Boot gd, not the application's, as
3006 * the other end is a setjmp call inside EFI context.
3010 image_obj->exit_status = exit_status;
3011 longjmp(&image_obj->exit_jmp, 1);
3013 panic("EFI application exited");
3015 return EFI_EXIT(ret);
3019 * efi_handle_protocol() - get interface of a protocol on a handle
3020 * @handle: handle on which the protocol shall be opened
3021 * @protocol: GUID of the protocol
3022 * @protocol_interface: interface implementing the protocol
3024 * This function implements the HandleProtocol service.
3026 * See the Unified Extensible Firmware Interface (UEFI) specification for
3029 * Return: status code
3031 static efi_status_t EFIAPI efi_handle_protocol(efi_handle_t handle,
3032 const efi_guid_t *protocol,
3033 void **protocol_interface)
3035 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
3036 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
3040 * efi_bind_controller() - bind a single driver to a controller
3041 * @controller_handle: controller handle
3042 * @driver_image_handle: driver handle
3043 * @remain_device_path: remaining path
3045 * Return: status code
3047 static efi_status_t efi_bind_controller(
3048 efi_handle_t controller_handle,
3049 efi_handle_t driver_image_handle,
3050 struct efi_device_path *remain_device_path)
3052 struct efi_driver_binding_protocol *binding_protocol;
3055 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3056 &efi_guid_driver_binding_protocol,
3057 (void **)&binding_protocol,
3058 driver_image_handle, NULL,
3059 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3060 if (r != EFI_SUCCESS)
3062 r = EFI_CALL(binding_protocol->supported(binding_protocol,
3064 remain_device_path));
3065 if (r == EFI_SUCCESS)
3066 r = EFI_CALL(binding_protocol->start(binding_protocol,
3068 remain_device_path));
3069 EFI_CALL(efi_close_protocol(driver_image_handle,
3070 &efi_guid_driver_binding_protocol,
3071 driver_image_handle, NULL));
3076 * efi_connect_single_controller() - connect a single driver to a controller
3077 * @controller_handle: controller
3078 * @driver_image_handle: driver
3079 * @remain_device_path: remaining path
3081 * Return: status code
3083 static efi_status_t efi_connect_single_controller(
3084 efi_handle_t controller_handle,
3085 efi_handle_t *driver_image_handle,
3086 struct efi_device_path *remain_device_path)
3088 efi_handle_t *buffer;
3092 size_t connected = 0;
3094 /* Get buffer with all handles with driver binding protocol */
3095 r = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL,
3096 &efi_guid_driver_binding_protocol,
3097 NULL, &count, &buffer));
3098 if (r != EFI_SUCCESS)
3101 /* Context Override */
3102 if (driver_image_handle) {
3103 for (; *driver_image_handle; ++driver_image_handle) {
3104 for (i = 0; i < count; ++i) {
3105 if (buffer[i] == *driver_image_handle) {
3107 r = efi_bind_controller(
3109 *driver_image_handle,
3110 remain_device_path);
3112 * For drivers that do not support the
3113 * controller or are already connected
3114 * we receive an error code here.
3116 if (r == EFI_SUCCESS)
3124 * TODO: Some overrides are not yet implemented:
3125 * - Platform Driver Override
3126 * - Driver Family Override Search
3127 * - Bus Specific Driver Override
3130 /* Driver Binding Search */
3131 for (i = 0; i < count; ++i) {
3133 r = efi_bind_controller(controller_handle,
3135 remain_device_path);
3136 if (r == EFI_SUCCESS)
3141 efi_free_pool(buffer);
3143 return EFI_NOT_FOUND;
3148 * efi_connect_controller() - connect a controller to a driver
3149 * @controller_handle: handle of the controller
3150 * @driver_image_handle: handle of the driver
3151 * @remain_device_path: device path of a child controller
3152 * @recursive: true to connect all child controllers
3154 * This function implements the ConnectController service.
3156 * See the Unified Extensible Firmware Interface (UEFI) specification for
3159 * First all driver binding protocol handles are tried for binding drivers.
3160 * Afterwards all handles that have opened a protocol of the controller
3161 * with EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER are connected to drivers.
3163 * Return: status code
3165 static efi_status_t EFIAPI efi_connect_controller(
3166 efi_handle_t controller_handle,
3167 efi_handle_t *driver_image_handle,
3168 struct efi_device_path *remain_device_path,
3172 efi_status_t ret = EFI_NOT_FOUND;
3173 struct efi_object *efiobj;
3175 EFI_ENTRY("%p, %p, %pD, %d", controller_handle, driver_image_handle,
3176 remain_device_path, recursive);
3178 efiobj = efi_search_obj(controller_handle);
3180 ret = EFI_INVALID_PARAMETER;
3184 r = efi_connect_single_controller(controller_handle,
3185 driver_image_handle,
3186 remain_device_path);
3187 if (r == EFI_SUCCESS)
3190 struct efi_handler *handler;
3191 struct efi_open_protocol_info_item *item;
3193 list_for_each_entry(handler, &efiobj->protocols, link) {
3194 list_for_each_entry(item, &handler->open_infos, link) {
3195 if (item->info.attributes &
3196 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3197 r = EFI_CALL(efi_connect_controller(
3198 item->info.controller_handle,
3199 driver_image_handle,
3202 if (r == EFI_SUCCESS)
3208 /* Check for child controller specified by end node */
3209 if (ret != EFI_SUCCESS && remain_device_path &&
3210 remain_device_path->type == DEVICE_PATH_TYPE_END)
3213 return EFI_EXIT(ret);
3217 * efi_reinstall_protocol_interface() - reinstall protocol interface
3218 * @handle: handle on which the protocol shall be reinstalled
3219 * @protocol: GUID of the protocol to be installed
3220 * @old_interface: interface to be removed
3221 * @new_interface: interface to be installed
3223 * This function implements the ReinstallProtocolInterface service.
3225 * See the Unified Extensible Firmware Interface (UEFI) specification for
3228 * The old interface is uninstalled. The new interface is installed.
3229 * Drivers are connected.
3231 * Return: status code
3233 static efi_status_t EFIAPI efi_reinstall_protocol_interface(
3234 efi_handle_t handle, const efi_guid_t *protocol,
3235 void *old_interface, void *new_interface)
3239 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
3242 /* Uninstall protocol but do not delete handle */
3243 ret = efi_uninstall_protocol(handle, protocol, old_interface);
3244 if (ret != EFI_SUCCESS)
3247 /* Install the new protocol */
3248 ret = efi_add_protocol(handle, protocol, new_interface);
3250 * The UEFI spec does not specify what should happen to the handle
3251 * if in case of an error no protocol interface remains on the handle.
3252 * So let's do nothing here.
3254 if (ret != EFI_SUCCESS)
3257 * The returned status code has to be ignored.
3258 * Do not create an error if no suitable driver for the handle exists.
3260 EFI_CALL(efi_connect_controller(handle, NULL, NULL, true));
3262 return EFI_EXIT(ret);
3266 * efi_get_child_controllers() - get all child controllers associated to a driver
3267 * @efiobj: handle of the controller
3268 * @driver_handle: handle of the driver
3269 * @number_of_children: number of child controllers
3270 * @child_handle_buffer: handles of the the child controllers
3272 * The allocated buffer has to be freed with free().
3274 * Return: status code
3276 static efi_status_t efi_get_child_controllers(
3277 struct efi_object *efiobj,
3278 efi_handle_t driver_handle,
3279 efi_uintn_t *number_of_children,
3280 efi_handle_t **child_handle_buffer)
3282 struct efi_handler *handler;
3283 struct efi_open_protocol_info_item *item;
3284 efi_uintn_t count = 0, i;
3287 /* Count all child controller associations */
3288 list_for_each_entry(handler, &efiobj->protocols, link) {
3289 list_for_each_entry(item, &handler->open_infos, link) {
3290 if (item->info.agent_handle == driver_handle &&
3291 item->info.attributes &
3292 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER)
3297 * Create buffer. In case of duplicate child controller assignments
3298 * the buffer will be too large. But that does not harm.
3300 *number_of_children = 0;
3301 *child_handle_buffer = calloc(count, sizeof(efi_handle_t));
3302 if (!*child_handle_buffer)
3303 return EFI_OUT_OF_RESOURCES;
3304 /* Copy unique child handles */
3305 list_for_each_entry(handler, &efiobj->protocols, link) {
3306 list_for_each_entry(item, &handler->open_infos, link) {
3307 if (item->info.agent_handle == driver_handle &&
3308 item->info.attributes &
3309 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
3310 /* Check this is a new child controller */
3312 for (i = 0; i < *number_of_children; ++i) {
3313 if ((*child_handle_buffer)[i] ==
3314 item->info.controller_handle)
3317 /* Copy handle to buffer */
3319 i = (*number_of_children)++;
3320 (*child_handle_buffer)[i] =
3321 item->info.controller_handle;
3330 * efi_disconnect_controller() - disconnect a controller from a driver
3331 * @controller_handle: handle of the controller
3332 * @driver_image_handle: handle of the driver
3333 * @child_handle: handle of the child to destroy
3335 * This function implements the DisconnectController service.
3337 * See the Unified Extensible Firmware Interface (UEFI) specification for
3340 * Return: status code
3342 static efi_status_t EFIAPI efi_disconnect_controller(
3343 efi_handle_t controller_handle,
3344 efi_handle_t driver_image_handle,
3345 efi_handle_t child_handle)
3347 struct efi_driver_binding_protocol *binding_protocol;
3348 efi_handle_t *child_handle_buffer = NULL;
3349 size_t number_of_children = 0;
3351 size_t stop_count = 0;
3352 struct efi_object *efiobj;
3354 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
3357 efiobj = efi_search_obj(controller_handle);
3359 r = EFI_INVALID_PARAMETER;
3363 if (child_handle && !efi_search_obj(child_handle)) {
3364 r = EFI_INVALID_PARAMETER;
3368 /* If no driver handle is supplied, disconnect all drivers */
3369 if (!driver_image_handle) {
3370 r = efi_disconnect_all_drivers(efiobj, NULL, child_handle);
3374 /* Create list of child handles */
3376 number_of_children = 1;
3377 child_handle_buffer = &child_handle;
3379 efi_get_child_controllers(efiobj,
3380 driver_image_handle,
3381 &number_of_children,
3382 &child_handle_buffer);
3385 /* Get the driver binding protocol */
3386 r = EFI_CALL(efi_open_protocol(driver_image_handle,
3387 &efi_guid_driver_binding_protocol,
3388 (void **)&binding_protocol,
3389 driver_image_handle, NULL,
3390 EFI_OPEN_PROTOCOL_GET_PROTOCOL));
3391 if (r != EFI_SUCCESS)
3393 /* Remove the children */
3394 if (number_of_children) {
3395 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3398 child_handle_buffer));
3399 if (r == EFI_SUCCESS)
3402 /* Remove the driver */
3404 r = EFI_CALL(binding_protocol->stop(binding_protocol,
3407 if (r == EFI_SUCCESS)
3409 EFI_CALL(efi_close_protocol(driver_image_handle,
3410 &efi_guid_driver_binding_protocol,
3411 driver_image_handle, NULL));
3419 free(child_handle_buffer);
3423 static struct efi_boot_services efi_boot_services = {
3425 .signature = EFI_BOOT_SERVICES_SIGNATURE,
3426 .revision = EFI_SPECIFICATION_VERSION,
3427 .headersize = sizeof(struct efi_boot_services),
3429 .raise_tpl = efi_raise_tpl,
3430 .restore_tpl = efi_restore_tpl,
3431 .allocate_pages = efi_allocate_pages_ext,
3432 .free_pages = efi_free_pages_ext,
3433 .get_memory_map = efi_get_memory_map_ext,
3434 .allocate_pool = efi_allocate_pool_ext,
3435 .free_pool = efi_free_pool_ext,
3436 .create_event = efi_create_event_ext,
3437 .set_timer = efi_set_timer_ext,
3438 .wait_for_event = efi_wait_for_event,
3439 .signal_event = efi_signal_event_ext,
3440 .close_event = efi_close_event,
3441 .check_event = efi_check_event,
3442 .install_protocol_interface = efi_install_protocol_interface,
3443 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
3444 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
3445 .handle_protocol = efi_handle_protocol,
3447 .register_protocol_notify = efi_register_protocol_notify,
3448 .locate_handle = efi_locate_handle_ext,
3449 .locate_device_path = efi_locate_device_path,
3450 .install_configuration_table = efi_install_configuration_table_ext,
3451 .load_image = efi_load_image,
3452 .start_image = efi_start_image,
3454 .unload_image = efi_unload_image,
3455 .exit_boot_services = efi_exit_boot_services,
3456 .get_next_monotonic_count = efi_get_next_monotonic_count,
3458 .set_watchdog_timer = efi_set_watchdog_timer,
3459 .connect_controller = efi_connect_controller,
3460 .disconnect_controller = efi_disconnect_controller,
3461 .open_protocol = efi_open_protocol,
3462 .close_protocol = efi_close_protocol,
3463 .open_protocol_information = efi_open_protocol_information,
3464 .protocols_per_handle = efi_protocols_per_handle,
3465 .locate_handle_buffer = efi_locate_handle_buffer,
3466 .locate_protocol = efi_locate_protocol,
3467 .install_multiple_protocol_interfaces =
3468 efi_install_multiple_protocol_interfaces,
3469 .uninstall_multiple_protocol_interfaces =
3470 efi_uninstall_multiple_protocol_interfaces,
3471 .calculate_crc32 = efi_calculate_crc32,
3472 .copy_mem = efi_copy_mem,
3473 .set_mem = efi_set_mem,
3474 .create_event_ex = efi_create_event_ex,
3477 static u16 __efi_runtime_data firmware_vendor[] = L"Das U-Boot";
3479 struct efi_system_table __efi_runtime_data systab = {
3481 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
3482 .revision = EFI_SPECIFICATION_VERSION,
3483 .headersize = sizeof(struct efi_system_table),
3485 .fw_vendor = firmware_vendor,
3486 .fw_revision = FW_VERSION << 16 | FW_PATCHLEVEL << 8,
3487 .con_in = (void *)&efi_con_in,
3488 .con_out = (void *)&efi_con_out,
3489 .std_err = (void *)&efi_con_out,
3490 .runtime = (void *)&efi_runtime_services,
3491 .boottime = (void *)&efi_boot_services,
3497 * efi_initialize_system_table() - Initialize system table
3499 * Return: status code
3501 efi_status_t efi_initialize_system_table(void)
3505 /* Allocate configuration table array */
3506 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
3507 EFI_MAX_CONFIGURATION_TABLES *
3508 sizeof(struct efi_configuration_table),
3509 (void **)&systab.tables);
3511 /* Set CRC32 field in table headers */
3512 efi_update_table_header_crc32(&systab.hdr);
3513 efi_update_table_header_crc32(&efi_runtime_services.hdr);
3514 efi_update_table_header_crc32(&efi_boot_services.hdr);