2 * EFI application boot time services
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
11 #include <efi_loader.h>
12 #include <environment.h>
14 #include <asm/global_data.h>
15 #include <libfdt_env.h>
16 #include <u-boot/crc.h>
21 DECLARE_GLOBAL_DATA_PTR;
23 /* Task priority level */
24 static efi_uintn_t efi_tpl = TPL_APPLICATION;
26 /* This list contains all the EFI objects our payload has access to */
27 LIST_HEAD(efi_obj_list);
30 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
31 * we need to do trickery with caches. Since we don't want to break the EFI
32 * aware boot path, only apply hacks when loading exiting directly (breaking
33 * direct Linux EFI booting along the way - oh well).
35 static bool efi_is_direct_boot = true;
38 * EFI can pass arbitrary additional "tables" containing vendor specific
39 * information to the payload. One such table is the FDT table which contains
40 * a pointer to a flattened device tree blob.
42 * In most cases we want to pass an FDT to the payload, so reserve one slot of
43 * config table space for it. The pointer gets populated by do_bootefi_exec().
45 static struct efi_configuration_table __efi_runtime_data efi_conf_table[2];
49 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
50 * fixed when compiling U-Boot. However, the payload does not know about that
51 * restriction so we need to manually swap its and our view of that register on
52 * EFI callback entry/exit.
54 static volatile void *efi_gd, *app_gd;
57 static int entry_count;
58 static int nesting_level;
60 /* Called on every callback entry */
61 int __efi_entry_check(void)
63 int ret = entry_count++ == 0;
72 /* Called on every callback exit */
73 int __efi_exit_check(void)
75 int ret = --entry_count == 0;
82 /* Called from do_bootefi_exec() */
83 void efi_save_gd(void)
91 * Special case handler for error/abort that just forces things back
92 * to u-boot world so we can dump out an abort msg, without any care
93 * about returning back to UEFI world.
95 void efi_restore_gd(void)
98 /* Only restore if we're already in EFI context */
106 * Two spaces per indent level, maxing out at 10.. which ought to be
107 * enough for anyone ;-)
109 static const char *indent_string(int level)
111 const char *indent = " ";
112 const int max = strlen(indent);
113 level = min(max, level * 2);
114 return &indent[max - level];
117 const char *__efi_nesting(void)
119 return indent_string(nesting_level);
122 const char *__efi_nesting_inc(void)
124 return indent_string(nesting_level++);
127 const char *__efi_nesting_dec(void)
129 return indent_string(--nesting_level);
133 * Queue an EFI event.
135 * This function queues the notification function of the event for future
138 * The notification function is called if the task priority level of the
139 * event is higher than the current task priority level.
141 * For the SignalEvent service see efi_signal_event_ext.
143 * @event event to signal
145 void efi_signal_event(struct efi_event *event)
147 if (event->notify_function) {
148 event->is_queued = true;
150 if (efi_tpl >= event->notify_tpl)
152 EFI_CALL_VOID(event->notify_function(event,
153 event->notify_context));
155 event->is_queued = false;
159 * Raise the task priority level.
161 * This function implements the RaiseTpl service.
162 * See the Unified Extensible Firmware Interface (UEFI) specification
165 * @new_tpl new value of the task priority level
166 * @return old value of the task priority level
168 static unsigned long EFIAPI efi_raise_tpl(efi_uintn_t new_tpl)
170 efi_uintn_t old_tpl = efi_tpl;
172 EFI_ENTRY("0x%zx", new_tpl);
174 if (new_tpl < efi_tpl)
175 debug("WARNING: new_tpl < current_tpl in %s\n", __func__);
177 if (efi_tpl > TPL_HIGH_LEVEL)
178 efi_tpl = TPL_HIGH_LEVEL;
180 EFI_EXIT(EFI_SUCCESS);
185 * Lower the task priority level.
187 * This function implements the RestoreTpl service.
188 * See the Unified Extensible Firmware Interface (UEFI) specification
191 * @old_tpl value of the task priority level to be restored
193 static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
195 EFI_ENTRY("0x%zx", old_tpl);
197 if (old_tpl > efi_tpl)
198 debug("WARNING: old_tpl > current_tpl in %s\n", __func__);
200 if (efi_tpl > TPL_HIGH_LEVEL)
201 efi_tpl = TPL_HIGH_LEVEL;
203 EFI_EXIT(EFI_SUCCESS);
207 * Allocate memory pages.
209 * This function implements the AllocatePages service.
210 * See the Unified Extensible Firmware Interface (UEFI) specification
213 * @type type of allocation to be performed
214 * @memory_type usage type of the allocated memory
215 * @pages number of pages to be allocated
216 * @memory allocated memory
217 * @return status code
219 static efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type,
225 EFI_ENTRY("%d, %d, 0x%zx, %p", type, memory_type, pages, memory);
226 r = efi_allocate_pages(type, memory_type, pages, memory);
233 * This function implements the FreePages service.
234 * See the Unified Extensible Firmware Interface (UEFI) specification
237 * @memory start of the memory area to be freed
238 * @pages number of pages to be freed
239 * @return status code
241 static efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory,
246 EFI_ENTRY("%"PRIx64", 0x%zx", memory, pages);
247 r = efi_free_pages(memory, pages);
252 * Get map describing memory usage.
254 * This function implements the GetMemoryMap service.
255 * See the Unified Extensible Firmware Interface (UEFI) specification
258 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
259 * on exit the size of the copied memory map
260 * @memory_map buffer to which the memory map is written
261 * @map_key key for the memory map
262 * @descriptor_size size of an individual memory descriptor
263 * @descriptor_version version number of the memory descriptor structure
264 * @return status code
266 static efi_status_t EFIAPI efi_get_memory_map_ext(
267 efi_uintn_t *memory_map_size,
268 struct efi_mem_desc *memory_map,
269 efi_uintn_t *map_key,
270 efi_uintn_t *descriptor_size,
271 uint32_t *descriptor_version)
275 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map,
276 map_key, descriptor_size, descriptor_version);
277 r = efi_get_memory_map(memory_map_size, memory_map, map_key,
278 descriptor_size, descriptor_version);
283 * Allocate memory from pool.
285 * This function implements the AllocatePool service.
286 * See the Unified Extensible Firmware Interface (UEFI) specification
289 * @pool_type type of the pool from which memory is to be allocated
290 * @size number of bytes to be allocated
291 * @buffer allocated memory
292 * @return status code
294 static efi_status_t EFIAPI efi_allocate_pool_ext(int pool_type,
300 EFI_ENTRY("%d, %zd, %p", pool_type, size, buffer);
301 r = efi_allocate_pool(pool_type, size, buffer);
306 * Free memory from pool.
308 * This function implements the FreePool service.
309 * See the Unified Extensible Firmware Interface (UEFI) specification
312 * @buffer start of memory to be freed
313 * @return status code
315 static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
319 EFI_ENTRY("%p", buffer);
320 r = efi_free_pool(buffer);
328 * @return status code
330 efi_status_t efi_create_handle(void **handle)
332 struct efi_object *obj;
335 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
336 sizeof(struct efi_object),
338 if (r != EFI_SUCCESS)
340 memset(obj, 0, sizeof(struct efi_object));
342 list_add_tail(&obj->link, &efi_obj_list);
348 * Our event capabilities are very limited. Only a small limited
349 * number of events is allowed to coexist.
351 static struct efi_event efi_events[16];
356 * This function is used inside U-Boot code to create an event.
358 * For the API function implementing the CreateEvent service see
359 * efi_create_event_ext.
361 * @type type of the event to create
362 * @notify_tpl task priority level of the event
363 * @notify_function notification function of the event
364 * @notify_context pointer passed to the notification function
365 * @event created event
366 * @return status code
368 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
369 void (EFIAPI *notify_function) (
370 struct efi_event *event,
372 void *notify_context, struct efi_event **event)
377 return EFI_INVALID_PARAMETER;
379 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
380 return EFI_INVALID_PARAMETER;
382 if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
383 notify_function == NULL)
384 return EFI_INVALID_PARAMETER;
386 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
387 if (efi_events[i].type)
389 efi_events[i].type = type;
390 efi_events[i].notify_tpl = notify_tpl;
391 efi_events[i].notify_function = notify_function;
392 efi_events[i].notify_context = notify_context;
393 /* Disable timers on bootup */
394 efi_events[i].trigger_next = -1ULL;
395 efi_events[i].is_queued = false;
396 efi_events[i].is_signaled = false;
397 *event = &efi_events[i];
400 return EFI_OUT_OF_RESOURCES;
406 * This function implements the CreateEvent service.
407 * See the Unified Extensible Firmware Interface (UEFI) specification
410 * @type type of the event to create
411 * @notify_tpl task priority level of the event
412 * @notify_function notification function of the event
413 * @notify_context pointer passed to the notification function
414 * @event created event
415 * @return status code
417 static efi_status_t EFIAPI efi_create_event_ext(
418 uint32_t type, efi_uintn_t notify_tpl,
419 void (EFIAPI *notify_function) (
420 struct efi_event *event,
422 void *notify_context, struct efi_event **event)
424 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
426 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
427 notify_context, event));
432 * Check if a timer event has occurred or a queued notification function should
435 * Our timers have to work without interrupts, so we check whenever keyboard
436 * input or disk accesses happen if enough time elapsed for them to fire.
438 void efi_timer_check(void)
441 u64 now = timer_get_us();
443 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
444 if (!efi_events[i].type)
446 if (efi_events[i].is_queued)
447 efi_signal_event(&efi_events[i]);
448 if (!(efi_events[i].type & EVT_TIMER) ||
449 now < efi_events[i].trigger_next)
451 switch (efi_events[i].trigger_type) {
452 case EFI_TIMER_RELATIVE:
453 efi_events[i].trigger_type = EFI_TIMER_STOP;
455 case EFI_TIMER_PERIODIC:
456 efi_events[i].trigger_next +=
457 efi_events[i].trigger_time;
462 efi_events[i].is_signaled = true;
463 efi_signal_event(&efi_events[i]);
469 * Set the trigger time for a timer event or stop the event.
471 * This is the function for internal usage in U-Boot. For the API function
472 * implementing the SetTimer service see efi_set_timer_ext.
474 * @event event for which the timer is set
475 * @type type of the timer
476 * @trigger_time trigger period in multiples of 100ns
477 * @return status code
479 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
480 uint64_t trigger_time)
485 * The parameter defines a multiple of 100ns.
486 * We use multiples of 1000ns. So divide by 10.
488 do_div(trigger_time, 10);
490 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
491 if (event != &efi_events[i])
494 if (!(event->type & EVT_TIMER))
498 event->trigger_next = -1ULL;
500 case EFI_TIMER_PERIODIC:
501 case EFI_TIMER_RELATIVE:
502 event->trigger_next =
503 timer_get_us() + trigger_time;
506 return EFI_INVALID_PARAMETER;
508 event->trigger_type = type;
509 event->trigger_time = trigger_time;
510 event->is_signaled = false;
513 return EFI_INVALID_PARAMETER;
517 * Set the trigger time for a timer event or stop the event.
519 * This function implements the SetTimer service.
520 * See the Unified Extensible Firmware Interface (UEFI) specification
523 * @event event for which the timer is set
524 * @type type of the timer
525 * @trigger_time trigger period in multiples of 100ns
526 * @return status code
528 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
529 enum efi_timer_delay type,
530 uint64_t trigger_time)
532 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
533 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
537 * Wait for events to be signaled.
539 * This function implements the WaitForEvent service.
540 * See the Unified Extensible Firmware Interface (UEFI) specification
543 * @num_events number of events to be waited for
544 * @events events to be waited for
545 * @index index of the event that was signaled
546 * @return status code
548 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
549 struct efi_event **event,
554 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
556 /* Check parameters */
557 if (!num_events || !event)
558 return EFI_EXIT(EFI_INVALID_PARAMETER);
560 if (efi_tpl != TPL_APPLICATION)
561 return EFI_EXIT(EFI_UNSUPPORTED);
562 for (i = 0; i < num_events; ++i) {
563 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
564 if (event[i] == &efi_events[j])
567 return EFI_EXIT(EFI_INVALID_PARAMETER);
569 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
570 return EFI_EXIT(EFI_INVALID_PARAMETER);
571 if (!event[i]->is_signaled)
572 efi_signal_event(event[i]);
575 /* Wait for signal */
577 for (i = 0; i < num_events; ++i) {
578 if (event[i]->is_signaled)
581 /* Allow events to occur. */
587 * Reset the signal which is passed to the caller to allow periodic
590 event[i]->is_signaled = false;
594 return EFI_EXIT(EFI_SUCCESS);
598 * Signal an EFI event.
600 * This function implements the SignalEvent service.
601 * See the Unified Extensible Firmware Interface (UEFI) specification
604 * This functions sets the signaled state of the event and queues the
605 * notification function for execution.
607 * @event event to signal
608 * @return status code
610 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
614 EFI_ENTRY("%p", event);
615 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
616 if (event != &efi_events[i])
618 if (event->is_signaled)
620 event->is_signaled = true;
621 if (event->type & EVT_NOTIFY_SIGNAL)
622 efi_signal_event(event);
625 return EFI_EXIT(EFI_SUCCESS);
629 * Close an EFI event.
631 * This function implements the CloseEvent service.
632 * See the Unified Extensible Firmware Interface (UEFI) specification
635 * @event event to close
636 * @return status code
638 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
642 EFI_ENTRY("%p", event);
643 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
644 if (event == &efi_events[i]) {
646 event->trigger_next = -1ULL;
647 event->is_queued = false;
648 event->is_signaled = false;
649 return EFI_EXIT(EFI_SUCCESS);
652 return EFI_EXIT(EFI_INVALID_PARAMETER);
656 * Check if an event is signaled.
658 * This function implements the CheckEvent service.
659 * See the Unified Extensible Firmware Interface (UEFI) specification
662 * If an event is not signaled yet the notification function is queued.
664 * @event event to check
665 * @return status code
667 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
671 EFI_ENTRY("%p", event);
673 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
674 if (event != &efi_events[i])
676 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
678 if (!event->is_signaled)
679 efi_signal_event(event);
680 if (event->is_signaled)
681 return EFI_EXIT(EFI_SUCCESS);
682 return EFI_EXIT(EFI_NOT_READY);
684 return EFI_EXIT(EFI_INVALID_PARAMETER);
688 * Find the internal EFI object for a handle.
690 * @handle handle to find
693 struct efi_object *efi_search_obj(const void *handle)
695 struct efi_object *efiobj;
697 list_for_each_entry(efiobj, &efi_obj_list, link) {
698 if (efiobj->handle == handle)
706 * Find a protocol on a handle.
709 * @protocol_guid GUID of the protocol
710 * @handler reference to the protocol
711 * @return status code
713 efi_status_t efi_search_protocol(const void *handle,
714 const efi_guid_t *protocol_guid,
715 struct efi_handler **handler)
717 struct efi_object *efiobj;
719 struct efi_handler *protocol;
721 if (!handle || !protocol_guid)
722 return EFI_INVALID_PARAMETER;
723 efiobj = efi_search_obj(handle);
725 return EFI_INVALID_PARAMETER;
726 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
727 protocol = &efiobj->protocols[i];
730 if (!guidcmp(protocol->guid, protocol_guid)) {
736 return EFI_NOT_FOUND;
740 * Install new protocol on a handle.
742 * @handle handle on which the protocol shall be installed
743 * @protocol GUID of the protocol to be installed
744 * @protocol_interface interface of the protocol implementation
745 * @return status code
747 efi_status_t efi_add_protocol(const void *handle, const efi_guid_t *protocol,
748 void *protocol_interface)
750 struct efi_object *efiobj;
751 struct efi_handler *handler;
755 efiobj = efi_search_obj(handle);
757 return EFI_INVALID_PARAMETER;
758 ret = efi_search_protocol(handle, protocol, NULL);
759 if (ret != EFI_NOT_FOUND)
760 return EFI_INVALID_PARAMETER;
761 handler = calloc(1, sizeof(struct efi_handler));
763 return EFI_OUT_OF_RESOURCES;
764 /* Install protocol in first empty slot. */
765 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
766 handler = &efiobj->protocols[i];
769 handler->guid = protocol;
770 handler->protocol_interface = protocol_interface;
773 return EFI_OUT_OF_RESOURCES;
777 * Delete protocol from a handle.
779 * @handle handle from which the protocol shall be deleted
780 * @protocol GUID of the protocol to be deleted
781 * @protocol_interface interface of the protocol implementation
782 * @return status code
784 efi_status_t efi_remove_protocol(const void *handle, const efi_guid_t *protocol,
785 void *protocol_interface)
787 struct efi_handler *handler;
790 ret = efi_search_protocol(handle, protocol, &handler);
791 if (ret != EFI_SUCCESS)
793 if (handler->protocol_interface != protocol_interface)
794 return EFI_NOT_FOUND;
795 handler->guid = NULL;
796 handler->protocol_interface = NULL;
801 * Delete all protocols from a handle.
803 * @handle handle from which the protocols shall be deleted
804 * @return status code
806 efi_status_t efi_remove_all_protocols(const void *handle)
808 struct efi_object *efiobj;
809 struct efi_handler *handler;
812 efiobj = efi_search_obj(handle);
814 return EFI_INVALID_PARAMETER;
816 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
817 handler = &efiobj->protocols[i];
818 handler->guid = NULL;
819 handler->protocol_interface = NULL;
825 * Install protocol interface.
827 * This function implements the InstallProtocolInterface service.
828 * See the Unified Extensible Firmware Interface (UEFI) specification
831 * @handle handle on which the protocol shall be installed
832 * @protocol GUID of the protocol to be installed
833 * @protocol_interface_type type of the interface to be installed,
834 * always EFI_NATIVE_INTERFACE
835 * @protocol_interface interface of the protocol implementation
836 * @return status code
838 static efi_status_t EFIAPI efi_install_protocol_interface(
839 void **handle, const efi_guid_t *protocol,
840 int protocol_interface_type, void *protocol_interface)
844 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
847 if (!handle || !protocol ||
848 protocol_interface_type != EFI_NATIVE_INTERFACE) {
849 r = EFI_INVALID_PARAMETER;
853 /* Create new handle if requested. */
855 r = efi_create_handle(handle);
856 if (r != EFI_SUCCESS)
858 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
861 debug("%sEFI: handle %p\n", indent_string(nesting_level),
864 /* Add new protocol */
865 r = efi_add_protocol(*handle, protocol, protocol_interface);
871 * Reinstall protocol interface.
873 * This function implements the ReinstallProtocolInterface service.
874 * See the Unified Extensible Firmware Interface (UEFI) specification
877 * @handle handle on which the protocol shall be
879 * @protocol GUID of the protocol to be installed
880 * @old_interface interface to be removed
881 * @new_interface interface to be installed
882 * @return status code
884 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
885 const efi_guid_t *protocol, void *old_interface,
888 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
890 return EFI_EXIT(EFI_ACCESS_DENIED);
894 * Uninstall protocol interface.
896 * This function implements the UninstallProtocolInterface service.
897 * See the Unified Extensible Firmware Interface (UEFI) specification
900 * @handle handle from which the protocol shall be removed
901 * @protocol GUID of the protocol to be removed
902 * @protocol_interface interface to be removed
903 * @return status code
905 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
906 void *handle, const efi_guid_t *protocol,
907 void *protocol_interface)
909 struct list_head *lhandle;
911 efi_status_t r = EFI_NOT_FOUND;
913 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
915 if (!handle || !protocol) {
916 r = EFI_INVALID_PARAMETER;
920 list_for_each(lhandle, &efi_obj_list) {
921 struct efi_object *efiobj;
922 efiobj = list_entry(lhandle, struct efi_object, link);
924 if (efiobj->handle != handle)
927 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
928 struct efi_handler *handler = &efiobj->protocols[i];
929 const efi_guid_t *hprotocol = handler->guid;
933 if (!guidcmp(hprotocol, protocol)) {
934 if (handler->protocol_interface) {
935 r = EFI_ACCESS_DENIED;
950 * Register an event for notification when a protocol is installed.
952 * This function implements the RegisterProtocolNotify service.
953 * See the Unified Extensible Firmware Interface (UEFI) specification
956 * @protocol GUID of the protocol whose installation shall be
958 * @event event to be signaled upon installation of the protocol
959 * @registration key for retrieving the registration information
960 * @return status code
962 static efi_status_t EFIAPI efi_register_protocol_notify(
963 const efi_guid_t *protocol,
964 struct efi_event *event,
967 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
968 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
972 * Determine if an EFI handle implements a protocol.
974 * See the documentation of the LocateHandle service in the UEFI specification.
976 * @search_type selection criterion
977 * @protocol GUID of the protocol
978 * @search_key registration key
980 * @return 0 if the handle implements the protocol
982 static int efi_search(enum efi_locate_search_type search_type,
983 const efi_guid_t *protocol, void *search_key,
984 struct efi_object *efiobj)
988 switch (search_type) {
991 case BY_REGISTER_NOTIFY:
992 /* TODO: RegisterProtocolNotify is not implemented yet */
995 ret = efi_search_protocol(efiobj->handle, protocol, NULL);
996 return (ret != EFI_SUCCESS);
998 /* Invalid search type */
1004 * Locate handles implementing a protocol.
1006 * This function is meant for U-Boot internal calls. For the API implementation
1007 * of the LocateHandle service see efi_locate_handle_ext.
1009 * @search_type selection criterion
1010 * @protocol GUID of the protocol
1011 * @search_key registration key
1012 * @buffer_size size of the buffer to receive the handles in bytes
1013 * @buffer buffer to receive the relevant handles
1014 * @return status code
1016 static efi_status_t efi_locate_handle(
1017 enum efi_locate_search_type search_type,
1018 const efi_guid_t *protocol, void *search_key,
1019 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1021 struct efi_object *efiobj;
1022 efi_uintn_t size = 0;
1024 /* Check parameters */
1025 switch (search_type) {
1028 case BY_REGISTER_NOTIFY:
1030 return EFI_INVALID_PARAMETER;
1031 /* RegisterProtocolNotify is not implemented yet */
1032 return EFI_UNSUPPORTED;
1035 return EFI_INVALID_PARAMETER;
1038 return EFI_INVALID_PARAMETER;
1042 * efi_locate_handle_buffer uses this function for
1043 * the calculation of the necessary buffer size.
1044 * So do not require a buffer for buffersize == 0.
1046 if (!buffer_size || (*buffer_size && !buffer))
1047 return EFI_INVALID_PARAMETER;
1049 /* Count how much space we need */
1050 list_for_each_entry(efiobj, &efi_obj_list, link) {
1051 if (!efi_search(search_type, protocol, search_key, efiobj))
1052 size += sizeof(void*);
1055 if (*buffer_size < size) {
1056 *buffer_size = size;
1057 return EFI_BUFFER_TOO_SMALL;
1060 *buffer_size = size;
1062 return EFI_NOT_FOUND;
1064 /* Then fill the array */
1065 list_for_each_entry(efiobj, &efi_obj_list, link) {
1066 if (!efi_search(search_type, protocol, search_key, efiobj))
1067 *buffer++ = efiobj->handle;
1074 * Locate handles implementing a protocol.
1076 * This function implements the LocateHandle service.
1077 * See the Unified Extensible Firmware Interface (UEFI) specification
1080 * @search_type selection criterion
1081 * @protocol GUID of the protocol
1082 * @search_key registration key
1083 * @buffer_size size of the buffer to receive the handles in bytes
1084 * @buffer buffer to receive the relevant handles
1085 * @return 0 if the handle implements the protocol
1087 static efi_status_t EFIAPI efi_locate_handle_ext(
1088 enum efi_locate_search_type search_type,
1089 const efi_guid_t *protocol, void *search_key,
1090 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1092 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1093 buffer_size, buffer);
1095 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1096 buffer_size, buffer));
1100 * Get the device path and handle of an device implementing a protocol.
1102 * This function implements the LocateDevicePath service.
1103 * See the Unified Extensible Firmware Interface (UEFI) specification
1106 * @protocol GUID of the protocol
1107 * @device_path device path
1108 * @device handle of the device
1109 * @return status code
1111 static efi_status_t EFIAPI efi_locate_device_path(
1112 const efi_guid_t *protocol,
1113 struct efi_device_path **device_path,
1114 efi_handle_t *device)
1116 struct efi_object *efiobj;
1118 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1120 efiobj = efi_dp_find_obj(*device_path, device_path);
1122 return EFI_EXIT(EFI_NOT_FOUND);
1124 *device = efiobj->handle;
1126 return EFI_EXIT(EFI_SUCCESS);
1129 /* Collapses configuration table entries, removing index i */
1130 static void efi_remove_configuration_table(int i)
1132 struct efi_configuration_table *this = &efi_conf_table[i];
1133 struct efi_configuration_table *next = &efi_conf_table[i+1];
1134 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1136 memmove(this, next, (ulong)end - (ulong)next);
1141 * Adds, updates, or removes a configuration table.
1143 * This function is used for internal calls. For the API implementation of the
1144 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1146 * @guid GUID of the installed table
1147 * @table table to be installed
1148 * @return status code
1150 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1154 /* Check for guid override */
1155 for (i = 0; i < systab.nr_tables; i++) {
1156 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1158 efi_conf_table[i].table = table;
1160 efi_remove_configuration_table(i);
1166 return EFI_NOT_FOUND;
1168 /* No override, check for overflow */
1169 if (i >= ARRAY_SIZE(efi_conf_table))
1170 return EFI_OUT_OF_RESOURCES;
1172 /* Add a new entry */
1173 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1174 efi_conf_table[i].table = table;
1175 systab.nr_tables = i + 1;
1181 * Adds, updates, or removes a configuration table.
1183 * This function implements the InstallConfigurationTable service.
1184 * See the Unified Extensible Firmware Interface (UEFI) specification
1187 * @guid GUID of the installed table
1188 * @table table to be installed
1189 * @return status code
1191 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1194 EFI_ENTRY("%pUl, %p", guid, table);
1195 return EFI_EXIT(efi_install_configuration_table(guid, table));
1199 * Initialize a loaded_image_info + loaded_image_info object with correct
1200 * protocols, boot-device, etc.
1202 * @info loaded image info to be passed to the entry point of the
1204 * @obj internal object associated with the loaded image
1205 * @device_path device path of the loaded image
1206 * @file_path file path of the loaded image
1208 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
1209 struct efi_device_path *device_path,
1210 struct efi_device_path *file_path)
1215 * When asking for the device path interface, return
1216 * bootefi_device_path
1218 obj->protocols[0].guid = &efi_guid_device_path;
1219 obj->protocols[0].protocol_interface = device_path;
1222 * When asking for the loaded_image interface, just
1223 * return handle which points to loaded_image_info
1225 obj->protocols[1].guid = &efi_guid_loaded_image;
1226 obj->protocols[1].protocol_interface = info;
1228 obj->protocols[2].guid = &efi_guid_console_control;
1229 obj->protocols[2].protocol_interface = (void *)&efi_console_control;
1231 obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
1232 obj->protocols[3].protocol_interface =
1233 (void *)&efi_device_path_to_text;
1235 info->file_path = file_path;
1237 info->device_handle = efi_dp_find_obj(device_path, NULL);
1239 list_add_tail(&obj->link, &efi_obj_list);
1243 * Load an image using a file path.
1245 * @file_path the path of the image to load
1246 * @buffer buffer containing the loaded image
1247 * @return status code
1249 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1252 struct efi_file_info *info = NULL;
1253 struct efi_file_handle *f;
1254 static efi_status_t ret;
1257 f = efi_file_from_path(file_path);
1259 return EFI_DEVICE_ERROR;
1262 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1264 if (ret == EFI_BUFFER_TOO_SMALL) {
1266 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1269 if (ret != EFI_SUCCESS)
1272 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1276 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1280 EFI_CALL(f->close(f));
1282 if (ret != EFI_SUCCESS) {
1283 efi_free_pool(*buffer);
1291 * Load an EFI image into memory.
1293 * This function implements the LoadImage service.
1294 * See the Unified Extensible Firmware Interface (UEFI) specification
1297 * @boot_policy true for request originating from the boot manager
1298 * @parent_image the calles's image handle
1299 * @file_path the path of the image to load
1300 * @source_buffer memory location from which the image is installed
1301 * @source_size size of the memory area from which the image is
1303 * @image_handle handle for the newly installed image
1304 * @return status code
1306 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1307 efi_handle_t parent_image,
1308 struct efi_device_path *file_path,
1309 void *source_buffer,
1310 unsigned long source_size,
1311 efi_handle_t *image_handle)
1313 struct efi_loaded_image *info;
1314 struct efi_object *obj;
1316 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1317 file_path, source_buffer, source_size, image_handle);
1319 info = calloc(1, sizeof(*info));
1320 obj = calloc(1, sizeof(*obj));
1322 if (!source_buffer) {
1323 struct efi_device_path *dp, *fp;
1326 ret = efi_load_image_from_path(file_path, &source_buffer);
1327 if (ret != EFI_SUCCESS) {
1330 return EFI_EXIT(ret);
1334 * split file_path which contains both the device and
1337 efi_dp_split_file_path(file_path, &dp, &fp);
1339 efi_setup_loaded_image(info, obj, dp, fp);
1341 /* In this case, file_path is the "device" path, ie.
1342 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1344 efi_setup_loaded_image(info, obj, file_path, NULL);
1347 info->reserved = efi_load_pe(source_buffer, info);
1348 if (!info->reserved) {
1351 return EFI_EXIT(EFI_UNSUPPORTED);
1354 info->system_table = &systab;
1355 info->parent_handle = parent_image;
1356 *image_handle = info;
1358 return EFI_EXIT(EFI_SUCCESS);
1362 * Call the entry point of an image.
1364 * This function implements the StartImage service.
1365 * See the Unified Extensible Firmware Interface (UEFI) specification
1368 * @image_handle handle of the image
1369 * @exit_data_size size of the buffer
1370 * @exit_data buffer to receive the exit data of the called image
1371 * @return status code
1373 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1374 unsigned long *exit_data_size,
1377 ulong (*entry)(void *image_handle, struct efi_system_table *st);
1378 struct efi_loaded_image *info = image_handle;
1380 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1381 entry = info->reserved;
1383 efi_is_direct_boot = false;
1385 /* call the image! */
1386 if (setjmp(&info->exit_jmp)) {
1387 /* We returned from the child image */
1388 return EFI_EXIT(info->exit_status);
1391 __efi_nesting_dec();
1393 entry(image_handle, &systab);
1394 __efi_entry_check();
1395 __efi_nesting_inc();
1397 /* Should usually never get here */
1398 return EFI_EXIT(EFI_SUCCESS);
1402 * Leave an EFI application or driver.
1404 * This function implements the Exit service.
1405 * See the Unified Extensible Firmware Interface (UEFI) specification
1408 * @image_handle handle of the application or driver that is exiting
1409 * @exit_status status code
1410 * @exit_data_size size of the buffer in bytes
1411 * @exit_data buffer with data describing an error
1412 * @return status code
1414 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1415 efi_status_t exit_status, unsigned long exit_data_size,
1418 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1420 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1421 exit_data_size, exit_data);
1423 /* Make sure entry/exit counts for EFI world cross-overs match */
1427 * But longjmp out with the U-Boot gd, not the application's, as
1428 * the other end is a setjmp call inside EFI context.
1432 loaded_image_info->exit_status = exit_status;
1433 longjmp(&loaded_image_info->exit_jmp, 1);
1435 panic("EFI application exited");
1439 * Unload an EFI image.
1441 * This function implements the UnloadImage service.
1442 * See the Unified Extensible Firmware Interface (UEFI) specification
1445 * @image_handle handle of the image to be unloaded
1446 * @return status code
1448 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1450 struct efi_object *efiobj;
1452 EFI_ENTRY("%p", image_handle);
1453 efiobj = efi_search_obj(image_handle);
1455 list_del(&efiobj->link);
1457 return EFI_EXIT(EFI_SUCCESS);
1461 * Fix up caches for EFI payloads if necessary.
1463 static void efi_exit_caches(void)
1465 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1467 * Grub on 32bit ARM needs to have caches disabled before jumping into
1468 * a zImage, but does not know of all cache layers. Give it a hand.
1470 if (efi_is_direct_boot)
1471 cleanup_before_linux();
1476 * Stop boot services.
1478 * This function implements the ExitBootServices service.
1479 * See the Unified Extensible Firmware Interface (UEFI) specification
1482 * @image_handle handle of the loaded image
1483 * @map_key key of the memory map
1484 * @return status code
1486 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1487 unsigned long map_key)
1491 EFI_ENTRY("%p, %ld", image_handle, map_key);
1493 /* Notify that ExitBootServices is invoked. */
1494 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1495 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1497 efi_signal_event(&efi_events[i]);
1499 /* Make sure that notification functions are not called anymore */
1500 efi_tpl = TPL_HIGH_LEVEL;
1502 /* XXX Should persist EFI variables here */
1504 board_quiesce_devices();
1506 /* Fix up caches for EFI payloads if necessary */
1509 /* This stops all lingering devices */
1510 bootm_disable_interrupts();
1512 /* Give the payload some time to boot */
1513 efi_set_watchdog(0);
1516 return EFI_EXIT(EFI_SUCCESS);
1520 * Get next value of the counter.
1522 * This function implements the NextMonotonicCount service.
1523 * See the Unified Extensible Firmware Interface (UEFI) specification
1526 * @count returned value of the counter
1527 * @return status code
1529 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1531 static uint64_t mono = 0;
1532 EFI_ENTRY("%p", count);
1534 return EFI_EXIT(EFI_SUCCESS);
1540 * This function implements the Stall sercive.
1541 * See the Unified Extensible Firmware Interface (UEFI) specification
1544 * @microseconds period to sleep in microseconds
1545 * @return status code
1547 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1549 EFI_ENTRY("%ld", microseconds);
1550 udelay(microseconds);
1551 return EFI_EXIT(EFI_SUCCESS);
1555 * Reset the watchdog timer.
1557 * This function implements the SetWatchdogTimer service.
1558 * See the Unified Extensible Firmware Interface (UEFI) specification
1561 * @timeout seconds before reset by watchdog
1562 * @watchdog_code code to be logged when resetting
1563 * @data_size size of buffer in bytes
1564 * @watchdog_data buffer with data describing the reset reason
1565 * @return status code
1567 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1568 uint64_t watchdog_code,
1569 unsigned long data_size,
1570 uint16_t *watchdog_data)
1572 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1573 data_size, watchdog_data);
1574 return EFI_EXIT(efi_set_watchdog(timeout));
1578 * Connect a controller to a driver.
1580 * This function implements the ConnectController service.
1581 * See the Unified Extensible Firmware Interface (UEFI) specification
1584 * @controller_handle handle of the controller
1585 * @driver_image_handle handle of the driver
1586 * @remain_device_path device path of a child controller
1587 * @recursive true to connect all child controllers
1588 * @return status code
1590 static efi_status_t EFIAPI efi_connect_controller(
1591 efi_handle_t controller_handle,
1592 efi_handle_t *driver_image_handle,
1593 struct efi_device_path *remain_device_path,
1596 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1597 remain_device_path, recursive);
1598 return EFI_EXIT(EFI_NOT_FOUND);
1602 * Disconnect a controller from a driver.
1604 * This function implements the DisconnectController service.
1605 * See the Unified Extensible Firmware Interface (UEFI) specification
1608 * @controller_handle handle of the controller
1609 * @driver_image_handle handle of the driver
1610 * @child_handle handle of the child to destroy
1611 * @return status code
1613 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1614 void *driver_image_handle,
1617 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1619 return EFI_EXIT(EFI_INVALID_PARAMETER);
1625 * This function implements the CloseProtocol service.
1626 * See the Unified Extensible Firmware Interface (UEFI) specification
1629 * @handle handle on which the protocol shall be closed
1630 * @protocol GUID of the protocol to close
1631 * @agent_handle handle of the driver
1632 * @controller_handle handle of the controller
1633 * @return status code
1635 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1636 const efi_guid_t *protocol,
1638 void *controller_handle)
1640 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1642 return EFI_EXIT(EFI_NOT_FOUND);
1646 * Provide information about then open status of a protocol on a handle
1648 * This function implements the OpenProtocolInformation service.
1649 * See the Unified Extensible Firmware Interface (UEFI) specification
1652 * @handle handle for which the information shall be retrieved
1653 * @protocol GUID of the protocol
1654 * @entry_buffer buffer to receive the open protocol information
1655 * @entry_count number of entries available in the buffer
1656 * @return status code
1658 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1659 const efi_guid_t *protocol,
1660 struct efi_open_protocol_info_entry **entry_buffer,
1661 efi_uintn_t *entry_count)
1663 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1665 return EFI_EXIT(EFI_NOT_FOUND);
1669 * Get protocols installed on a handle.
1671 * This function implements the ProtocolsPerHandleService.
1672 * See the Unified Extensible Firmware Interface (UEFI) specification
1675 * @handle handle for which the information is retrieved
1676 * @protocol_buffer buffer with protocol GUIDs
1677 * @protocol_buffer_count number of entries in the buffer
1678 * @return status code
1680 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1681 efi_guid_t ***protocol_buffer,
1682 efi_uintn_t *protocol_buffer_count)
1684 unsigned long buffer_size;
1685 struct efi_object *efiobj;
1687 struct list_head *lhandle;
1690 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1691 protocol_buffer_count);
1693 if (!handle || !protocol_buffer || !protocol_buffer_count)
1694 return EFI_EXIT(EFI_INVALID_PARAMETER);
1696 *protocol_buffer = NULL;
1697 *protocol_buffer_count = 0;
1698 list_for_each(lhandle, &efi_obj_list) {
1699 efiobj = list_entry(lhandle, struct efi_object, link);
1701 if (efiobj->handle != handle)
1704 /* Count protocols */
1705 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1706 if (efiobj->protocols[i].guid)
1707 ++*protocol_buffer_count;
1710 if (*protocol_buffer_count) {
1711 buffer_size = sizeof(efi_guid_t *) *
1712 *protocol_buffer_count;
1713 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
1715 (void **)protocol_buffer);
1716 if (r != EFI_SUCCESS)
1719 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
1720 if (efiobj->protocols[i].guid) {
1721 (*protocol_buffer)[j] = (void *)
1722 efiobj->protocols[i].guid;
1730 return EFI_EXIT(EFI_SUCCESS);
1734 * Locate handles implementing a protocol.
1736 * This function implements the LocateHandleBuffer service.
1737 * See the Unified Extensible Firmware Interface (UEFI) specification
1740 * @search_type selection criterion
1741 * @protocol GUID of the protocol
1742 * @search_key registration key
1743 * @no_handles number of returned handles
1744 * @buffer buffer with the returned handles
1745 * @return status code
1747 static efi_status_t EFIAPI efi_locate_handle_buffer(
1748 enum efi_locate_search_type search_type,
1749 const efi_guid_t *protocol, void *search_key,
1750 efi_uintn_t *no_handles, efi_handle_t **buffer)
1753 efi_uintn_t buffer_size = 0;
1755 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1756 no_handles, buffer);
1758 if (!no_handles || !buffer) {
1759 r = EFI_INVALID_PARAMETER;
1764 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1766 if (r != EFI_BUFFER_TOO_SMALL)
1768 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1770 if (r != EFI_SUCCESS)
1772 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1774 if (r == EFI_SUCCESS)
1775 *no_handles = buffer_size / sizeof(void *);
1781 * Find an interface implementing a protocol.
1783 * This function implements the LocateProtocol service.
1784 * See the Unified Extensible Firmware Interface (UEFI) specification
1787 * @protocol GUID of the protocol
1788 * @registration registration key passed to the notification function
1789 * @protocol_interface interface implementing the protocol
1790 * @return status code
1792 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1794 void **protocol_interface)
1796 struct list_head *lhandle;
1799 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1801 if (!protocol || !protocol_interface)
1802 return EFI_EXIT(EFI_INVALID_PARAMETER);
1804 EFI_PRINT_GUID("protocol", protocol);
1806 list_for_each(lhandle, &efi_obj_list) {
1807 struct efi_object *efiobj;
1809 efiobj = list_entry(lhandle, struct efi_object, link);
1810 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1811 struct efi_handler *handler = &efiobj->protocols[i];
1815 if (!guidcmp(handler->guid, protocol)) {
1816 *protocol_interface =
1817 handler->protocol_interface;
1818 return EFI_EXIT(EFI_SUCCESS);
1822 *protocol_interface = NULL;
1824 return EFI_EXIT(EFI_NOT_FOUND);
1828 * Install multiple protocol interfaces.
1830 * This function implements the MultipleProtocolInterfaces service.
1831 * See the Unified Extensible Firmware Interface (UEFI) specification
1834 * @handle handle on which the protocol interfaces shall be installed
1835 * @... NULL terminated argument list with pairs of protocol GUIDS and
1837 * @return status code
1839 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1842 EFI_ENTRY("%p", handle);
1845 const efi_guid_t *protocol;
1846 void *protocol_interface;
1847 efi_status_t r = EFI_SUCCESS;
1851 return EFI_EXIT(EFI_INVALID_PARAMETER);
1853 va_start(argptr, handle);
1855 protocol = va_arg(argptr, efi_guid_t*);
1858 protocol_interface = va_arg(argptr, void*);
1859 r = EFI_CALL(efi_install_protocol_interface(
1861 EFI_NATIVE_INTERFACE,
1862 protocol_interface));
1863 if (r != EFI_SUCCESS)
1868 if (r == EFI_SUCCESS)
1871 /* If an error occurred undo all changes. */
1872 va_start(argptr, handle);
1874 protocol = va_arg(argptr, efi_guid_t*);
1875 protocol_interface = va_arg(argptr, void*);
1876 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
1877 protocol_interface));
1885 * Uninstall multiple protocol interfaces.
1887 * This function implements the UninstallMultipleProtocolInterfaces service.
1888 * See the Unified Extensible Firmware Interface (UEFI) specification
1891 * @handle handle from which the protocol interfaces shall be removed
1892 * @... NULL terminated argument list with pairs of protocol GUIDS and
1894 * @return status code
1896 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
1899 EFI_ENTRY("%p", handle);
1902 const efi_guid_t *protocol;
1903 void *protocol_interface;
1904 efi_status_t r = EFI_SUCCESS;
1908 return EFI_EXIT(EFI_INVALID_PARAMETER);
1910 va_start(argptr, handle);
1912 protocol = va_arg(argptr, efi_guid_t*);
1915 protocol_interface = va_arg(argptr, void*);
1916 r = EFI_CALL(efi_uninstall_protocol_interface(
1918 protocol_interface));
1919 if (r != EFI_SUCCESS)
1924 if (r == EFI_SUCCESS)
1927 /* If an error occurred undo all changes. */
1928 va_start(argptr, handle);
1930 protocol = va_arg(argptr, efi_guid_t*);
1931 protocol_interface = va_arg(argptr, void*);
1932 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
1933 EFI_NATIVE_INTERFACE,
1934 protocol_interface));
1942 * Calculate cyclic redundancy code.
1944 * This function implements the CalculateCrc32 service.
1945 * See the Unified Extensible Firmware Interface (UEFI) specification
1948 * @data buffer with data
1949 * @data_size size of buffer in bytes
1950 * @crc32_p cyclic redundancy code
1951 * @return status code
1953 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
1954 unsigned long data_size,
1957 EFI_ENTRY("%p, %ld", data, data_size);
1958 *crc32_p = crc32(0, data, data_size);
1959 return EFI_EXIT(EFI_SUCCESS);
1965 * This function implements the CopyMem service.
1966 * See the Unified Extensible Firmware Interface (UEFI) specification
1969 * @destination destination of the copy operation
1970 * @source source of the copy operation
1971 * @length number of bytes to copy
1973 static void EFIAPI efi_copy_mem(void *destination, const void *source,
1976 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
1977 memcpy(destination, source, length);
1978 EFI_EXIT(EFI_SUCCESS);
1982 * Fill memory with a byte value.
1984 * This function implements the SetMem service.
1985 * See the Unified Extensible Firmware Interface (UEFI) specification
1988 * @buffer buffer to fill
1989 * @size size of buffer in bytes
1990 * @value byte to copy to the buffer
1992 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
1994 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
1995 memset(buffer, value, size);
1996 EFI_EXIT(EFI_SUCCESS);
2000 * Open protocol interface on a handle.
2002 * This function implements the OpenProtocol interface.
2003 * See the Unified Extensible Firmware Interface (UEFI) specification
2006 * @handle handle on which the protocol shall be opened
2007 * @protocol GUID of the protocol
2008 * @protocol_interface interface implementing the protocol
2009 * @agent_handle handle of the driver
2010 * @controller_handle handle of the controller
2011 * @attributes attributes indicating how to open the protocol
2012 * @return status code
2014 static efi_status_t EFIAPI efi_open_protocol(
2015 void *handle, const efi_guid_t *protocol,
2016 void **protocol_interface, void *agent_handle,
2017 void *controller_handle, uint32_t attributes)
2019 struct list_head *lhandle;
2021 efi_status_t r = EFI_INVALID_PARAMETER;
2023 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2024 protocol_interface, agent_handle, controller_handle,
2027 if (!handle || !protocol ||
2028 (!protocol_interface && attributes !=
2029 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2033 EFI_PRINT_GUID("protocol", protocol);
2035 switch (attributes) {
2036 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2037 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2038 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2040 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2041 if (controller_handle == handle)
2043 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2044 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2045 if (controller_handle == NULL)
2047 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2048 if (agent_handle == NULL)
2055 list_for_each(lhandle, &efi_obj_list) {
2056 struct efi_object *efiobj;
2057 efiobj = list_entry(lhandle, struct efi_object, link);
2059 if (efiobj->handle != handle)
2062 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
2063 struct efi_handler *handler = &efiobj->protocols[i];
2064 const efi_guid_t *hprotocol = handler->guid;
2067 if (!guidcmp(hprotocol, protocol)) {
2069 EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
2070 *protocol_interface =
2071 handler->protocol_interface;
2081 r = EFI_UNSUPPORTED;
2087 * Get interface of a protocol on a handle.
2089 * This function implements the HandleProtocol service.
2090 * See the Unified Extensible Firmware Interface (UEFI) specification
2093 * @handle handle on which the protocol shall be opened
2094 * @protocol GUID of the protocol
2095 * @protocol_interface interface implementing the protocol
2096 * @return status code
2098 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
2099 const efi_guid_t *protocol,
2100 void **protocol_interface)
2102 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2103 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2106 static const struct efi_boot_services efi_boot_services = {
2108 .headersize = sizeof(struct efi_table_hdr),
2110 .raise_tpl = efi_raise_tpl,
2111 .restore_tpl = efi_restore_tpl,
2112 .allocate_pages = efi_allocate_pages_ext,
2113 .free_pages = efi_free_pages_ext,
2114 .get_memory_map = efi_get_memory_map_ext,
2115 .allocate_pool = efi_allocate_pool_ext,
2116 .free_pool = efi_free_pool_ext,
2117 .create_event = efi_create_event_ext,
2118 .set_timer = efi_set_timer_ext,
2119 .wait_for_event = efi_wait_for_event,
2120 .signal_event = efi_signal_event_ext,
2121 .close_event = efi_close_event,
2122 .check_event = efi_check_event,
2123 .install_protocol_interface = efi_install_protocol_interface,
2124 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2125 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2126 .handle_protocol = efi_handle_protocol,
2128 .register_protocol_notify = efi_register_protocol_notify,
2129 .locate_handle = efi_locate_handle_ext,
2130 .locate_device_path = efi_locate_device_path,
2131 .install_configuration_table = efi_install_configuration_table_ext,
2132 .load_image = efi_load_image,
2133 .start_image = efi_start_image,
2135 .unload_image = efi_unload_image,
2136 .exit_boot_services = efi_exit_boot_services,
2137 .get_next_monotonic_count = efi_get_next_monotonic_count,
2139 .set_watchdog_timer = efi_set_watchdog_timer,
2140 .connect_controller = efi_connect_controller,
2141 .disconnect_controller = efi_disconnect_controller,
2142 .open_protocol = efi_open_protocol,
2143 .close_protocol = efi_close_protocol,
2144 .open_protocol_information = efi_open_protocol_information,
2145 .protocols_per_handle = efi_protocols_per_handle,
2146 .locate_handle_buffer = efi_locate_handle_buffer,
2147 .locate_protocol = efi_locate_protocol,
2148 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2149 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2150 .calculate_crc32 = efi_calculate_crc32,
2151 .copy_mem = efi_copy_mem,
2152 .set_mem = efi_set_mem,
2156 static uint16_t __efi_runtime_data firmware_vendor[] =
2157 { 'D','a','s',' ','U','-','b','o','o','t',0 };
2159 struct efi_system_table __efi_runtime_data systab = {
2161 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2162 .revision = 0x20005, /* 2.5 */
2163 .headersize = sizeof(struct efi_table_hdr),
2165 .fw_vendor = (long)firmware_vendor,
2166 .con_in = (void*)&efi_con_in,
2167 .con_out = (void*)&efi_con_out,
2168 .std_err = (void*)&efi_con_out,
2169 .runtime = (void*)&efi_runtime_services,
2170 .boottime = (void*)&efi_boot_services,
2172 .tables = (void*)efi_conf_table,