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)
842 struct list_head *lhandle;
846 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
849 if (!handle || !protocol ||
850 protocol_interface_type != EFI_NATIVE_INTERFACE) {
851 r = EFI_INVALID_PARAMETER;
855 /* Create new handle if requested. */
857 r = efi_create_handle(handle);
858 if (r != EFI_SUCCESS)
860 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
863 debug("%sEFI: handle %p\n", indent_string(nesting_level),
867 list_for_each(lhandle, &efi_obj_list) {
868 struct efi_object *efiobj;
869 efiobj = list_entry(lhandle, struct efi_object, link);
871 if (efiobj->handle != *handle)
873 /* Check if protocol is already installed on the handle. */
874 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
875 struct efi_handler *handler = &efiobj->protocols[i];
879 if (!guidcmp(handler->guid, protocol)) {
880 r = EFI_INVALID_PARAMETER;
884 /* Install protocol in first empty slot. */
885 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
886 struct efi_handler *handler = &efiobj->protocols[i];
891 handler->guid = protocol;
892 handler->protocol_interface = protocol_interface;
896 r = EFI_OUT_OF_RESOURCES;
899 r = EFI_INVALID_PARAMETER;
905 * Reinstall protocol interface.
907 * This function implements the ReinstallProtocolInterface service.
908 * See the Unified Extensible Firmware Interface (UEFI) specification
911 * @handle handle on which the protocol shall be
913 * @protocol GUID of the protocol to be installed
914 * @old_interface interface to be removed
915 * @new_interface interface to be installed
916 * @return status code
918 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
919 const efi_guid_t *protocol, void *old_interface,
922 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
924 return EFI_EXIT(EFI_ACCESS_DENIED);
928 * Uninstall protocol interface.
930 * This function implements the UninstallProtocolInterface service.
931 * See the Unified Extensible Firmware Interface (UEFI) specification
934 * @handle handle from which the protocol shall be removed
935 * @protocol GUID of the protocol to be removed
936 * @protocol_interface interface to be removed
937 * @return status code
939 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
940 void *handle, const efi_guid_t *protocol,
941 void *protocol_interface)
943 struct list_head *lhandle;
945 efi_status_t r = EFI_NOT_FOUND;
947 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
949 if (!handle || !protocol) {
950 r = EFI_INVALID_PARAMETER;
954 list_for_each(lhandle, &efi_obj_list) {
955 struct efi_object *efiobj;
956 efiobj = list_entry(lhandle, struct efi_object, link);
958 if (efiobj->handle != handle)
961 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
962 struct efi_handler *handler = &efiobj->protocols[i];
963 const efi_guid_t *hprotocol = handler->guid;
967 if (!guidcmp(hprotocol, protocol)) {
968 if (handler->protocol_interface) {
969 r = EFI_ACCESS_DENIED;
984 * Register an event for notification when a protocol is installed.
986 * This function implements the RegisterProtocolNotify service.
987 * See the Unified Extensible Firmware Interface (UEFI) specification
990 * @protocol GUID of the protocol whose installation shall be
992 * @event event to be signaled upon installation of the protocol
993 * @registration key for retrieving the registration information
994 * @return status code
996 static efi_status_t EFIAPI efi_register_protocol_notify(
997 const efi_guid_t *protocol,
998 struct efi_event *event,
1001 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
1002 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
1006 * Determine if an EFI handle implements a protocol.
1008 * See the documentation of the LocateHandle service in the UEFI specification.
1010 * @search_type selection criterion
1011 * @protocol GUID of the protocol
1012 * @search_key registration key
1014 * @return 0 if the handle implements the protocol
1016 static int efi_search(enum efi_locate_search_type search_type,
1017 const efi_guid_t *protocol, void *search_key,
1018 struct efi_object *efiobj)
1022 switch (search_type) {
1025 case BY_REGISTER_NOTIFY:
1026 /* RegisterProtocolNotify is not implemented yet */
1029 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1030 const efi_guid_t *guid = efiobj->protocols[i].guid;
1031 if (guid && !guidcmp(guid, protocol))
1041 * Locate handles implementing a protocol.
1043 * This function is meant for U-Boot internal calls. For the API implementation
1044 * of the LocateHandle service see efi_locate_handle_ext.
1046 * @search_type selection criterion
1047 * @protocol GUID of the protocol
1048 * @search_key registration key
1049 * @buffer_size size of the buffer to receive the handles in bytes
1050 * @buffer buffer to receive the relevant handles
1051 * @return status code
1053 static efi_status_t efi_locate_handle(
1054 enum efi_locate_search_type search_type,
1055 const efi_guid_t *protocol, void *search_key,
1056 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1058 struct efi_object *efiobj;
1059 efi_uintn_t size = 0;
1061 /* Check parameters */
1062 switch (search_type) {
1065 case BY_REGISTER_NOTIFY:
1067 return EFI_INVALID_PARAMETER;
1068 /* RegisterProtocolNotify is not implemented yet */
1069 return EFI_UNSUPPORTED;
1072 return EFI_INVALID_PARAMETER;
1075 return EFI_INVALID_PARAMETER;
1079 * efi_locate_handle_buffer uses this function for
1080 * the calculation of the necessary buffer size.
1081 * So do not require a buffer for buffersize == 0.
1083 if (!buffer_size || (*buffer_size && !buffer))
1084 return EFI_INVALID_PARAMETER;
1086 /* Count how much space we need */
1087 list_for_each_entry(efiobj, &efi_obj_list, link) {
1088 if (!efi_search(search_type, protocol, search_key, efiobj))
1089 size += sizeof(void*);
1092 if (*buffer_size < size) {
1093 *buffer_size = size;
1094 return EFI_BUFFER_TOO_SMALL;
1097 *buffer_size = size;
1099 return EFI_NOT_FOUND;
1101 /* Then fill the array */
1102 list_for_each_entry(efiobj, &efi_obj_list, link) {
1103 if (!efi_search(search_type, protocol, search_key, efiobj))
1104 *buffer++ = efiobj->handle;
1111 * Locate handles implementing a protocol.
1113 * This function implements the LocateHandle service.
1114 * See the Unified Extensible Firmware Interface (UEFI) specification
1117 * @search_type selection criterion
1118 * @protocol GUID of the protocol
1119 * @search_key registration key
1120 * @buffer_size size of the buffer to receive the handles in bytes
1121 * @buffer buffer to receive the relevant handles
1122 * @return 0 if the handle implements the protocol
1124 static efi_status_t EFIAPI efi_locate_handle_ext(
1125 enum efi_locate_search_type search_type,
1126 const efi_guid_t *protocol, void *search_key,
1127 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1129 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1130 buffer_size, buffer);
1132 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1133 buffer_size, buffer));
1137 * Get the device path and handle of an device implementing a protocol.
1139 * This function implements the LocateDevicePath service.
1140 * See the Unified Extensible Firmware Interface (UEFI) specification
1143 * @protocol GUID of the protocol
1144 * @device_path device path
1145 * @device handle of the device
1146 * @return status code
1148 static efi_status_t EFIAPI efi_locate_device_path(
1149 const efi_guid_t *protocol,
1150 struct efi_device_path **device_path,
1151 efi_handle_t *device)
1153 struct efi_object *efiobj;
1155 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1157 efiobj = efi_dp_find_obj(*device_path, device_path);
1159 return EFI_EXIT(EFI_NOT_FOUND);
1161 *device = efiobj->handle;
1163 return EFI_EXIT(EFI_SUCCESS);
1166 /* Collapses configuration table entries, removing index i */
1167 static void efi_remove_configuration_table(int i)
1169 struct efi_configuration_table *this = &efi_conf_table[i];
1170 struct efi_configuration_table *next = &efi_conf_table[i+1];
1171 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1173 memmove(this, next, (ulong)end - (ulong)next);
1178 * Adds, updates, or removes a configuration table.
1180 * This function is used for internal calls. For the API implementation of the
1181 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1183 * @guid GUID of the installed table
1184 * @table table to be installed
1185 * @return status code
1187 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1191 /* Check for guid override */
1192 for (i = 0; i < systab.nr_tables; i++) {
1193 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1195 efi_conf_table[i].table = table;
1197 efi_remove_configuration_table(i);
1203 return EFI_NOT_FOUND;
1205 /* No override, check for overflow */
1206 if (i >= ARRAY_SIZE(efi_conf_table))
1207 return EFI_OUT_OF_RESOURCES;
1209 /* Add a new entry */
1210 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1211 efi_conf_table[i].table = table;
1212 systab.nr_tables = i + 1;
1218 * Adds, updates, or removes a configuration table.
1220 * This function implements the InstallConfigurationTable service.
1221 * See the Unified Extensible Firmware Interface (UEFI) specification
1224 * @guid GUID of the installed table
1225 * @table table to be installed
1226 * @return status code
1228 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1231 EFI_ENTRY("%pUl, %p", guid, table);
1232 return EFI_EXIT(efi_install_configuration_table(guid, table));
1236 * Initialize a loaded_image_info + loaded_image_info object with correct
1237 * protocols, boot-device, etc.
1239 * @info loaded image info to be passed to the entry point of the
1241 * @obj internal object associated with the loaded image
1242 * @device_path device path of the loaded image
1243 * @file_path file path of the loaded image
1245 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
1246 struct efi_device_path *device_path,
1247 struct efi_device_path *file_path)
1252 * When asking for the device path interface, return
1253 * bootefi_device_path
1255 obj->protocols[0].guid = &efi_guid_device_path;
1256 obj->protocols[0].protocol_interface = device_path;
1259 * When asking for the loaded_image interface, just
1260 * return handle which points to loaded_image_info
1262 obj->protocols[1].guid = &efi_guid_loaded_image;
1263 obj->protocols[1].protocol_interface = info;
1265 obj->protocols[2].guid = &efi_guid_console_control;
1266 obj->protocols[2].protocol_interface = (void *)&efi_console_control;
1268 obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
1269 obj->protocols[3].protocol_interface =
1270 (void *)&efi_device_path_to_text;
1272 info->file_path = file_path;
1274 info->device_handle = efi_dp_find_obj(device_path, NULL);
1276 list_add_tail(&obj->link, &efi_obj_list);
1280 * Load an image using a file path.
1282 * @file_path the path of the image to load
1283 * @buffer buffer containing the loaded image
1284 * @return status code
1286 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1289 struct efi_file_info *info = NULL;
1290 struct efi_file_handle *f;
1291 static efi_status_t ret;
1294 f = efi_file_from_path(file_path);
1296 return EFI_DEVICE_ERROR;
1299 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1301 if (ret == EFI_BUFFER_TOO_SMALL) {
1303 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1306 if (ret != EFI_SUCCESS)
1309 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1313 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1317 EFI_CALL(f->close(f));
1319 if (ret != EFI_SUCCESS) {
1320 efi_free_pool(*buffer);
1328 * Load an EFI image into memory.
1330 * This function implements the LoadImage service.
1331 * See the Unified Extensible Firmware Interface (UEFI) specification
1334 * @boot_policy true for request originating from the boot manager
1335 * @parent_image the calles's image handle
1336 * @file_path the path of the image to load
1337 * @source_buffer memory location from which the image is installed
1338 * @source_size size of the memory area from which the image is
1340 * @image_handle handle for the newly installed image
1341 * @return status code
1343 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1344 efi_handle_t parent_image,
1345 struct efi_device_path *file_path,
1346 void *source_buffer,
1347 unsigned long source_size,
1348 efi_handle_t *image_handle)
1350 struct efi_loaded_image *info;
1351 struct efi_object *obj;
1353 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1354 file_path, source_buffer, source_size, image_handle);
1356 info = calloc(1, sizeof(*info));
1357 obj = calloc(1, sizeof(*obj));
1359 if (!source_buffer) {
1360 struct efi_device_path *dp, *fp;
1363 ret = efi_load_image_from_path(file_path, &source_buffer);
1364 if (ret != EFI_SUCCESS) {
1367 return EFI_EXIT(ret);
1371 * split file_path which contains both the device and
1374 efi_dp_split_file_path(file_path, &dp, &fp);
1376 efi_setup_loaded_image(info, obj, dp, fp);
1378 /* In this case, file_path is the "device" path, ie.
1379 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1381 efi_setup_loaded_image(info, obj, file_path, NULL);
1384 info->reserved = efi_load_pe(source_buffer, info);
1385 if (!info->reserved) {
1388 return EFI_EXIT(EFI_UNSUPPORTED);
1391 info->system_table = &systab;
1392 info->parent_handle = parent_image;
1393 *image_handle = info;
1395 return EFI_EXIT(EFI_SUCCESS);
1399 * Call the entry point of an image.
1401 * This function implements the StartImage service.
1402 * See the Unified Extensible Firmware Interface (UEFI) specification
1405 * @image_handle handle of the image
1406 * @exit_data_size size of the buffer
1407 * @exit_data buffer to receive the exit data of the called image
1408 * @return status code
1410 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1411 unsigned long *exit_data_size,
1414 ulong (*entry)(void *image_handle, struct efi_system_table *st);
1415 struct efi_loaded_image *info = image_handle;
1417 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1418 entry = info->reserved;
1420 efi_is_direct_boot = false;
1422 /* call the image! */
1423 if (setjmp(&info->exit_jmp)) {
1424 /* We returned from the child image */
1425 return EFI_EXIT(info->exit_status);
1428 __efi_nesting_dec();
1430 entry(image_handle, &systab);
1431 __efi_entry_check();
1432 __efi_nesting_inc();
1434 /* Should usually never get here */
1435 return EFI_EXIT(EFI_SUCCESS);
1439 * Leave an EFI application or driver.
1441 * This function implements the Exit service.
1442 * See the Unified Extensible Firmware Interface (UEFI) specification
1445 * @image_handle handle of the application or driver that is exiting
1446 * @exit_status status code
1447 * @exit_data_size size of the buffer in bytes
1448 * @exit_data buffer with data describing an error
1449 * @return status code
1451 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1452 efi_status_t exit_status, unsigned long exit_data_size,
1455 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1457 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1458 exit_data_size, exit_data);
1460 /* Make sure entry/exit counts for EFI world cross-overs match */
1464 * But longjmp out with the U-Boot gd, not the application's, as
1465 * the other end is a setjmp call inside EFI context.
1469 loaded_image_info->exit_status = exit_status;
1470 longjmp(&loaded_image_info->exit_jmp, 1);
1472 panic("EFI application exited");
1476 * Unload an EFI image.
1478 * This function implements the UnloadImage service.
1479 * See the Unified Extensible Firmware Interface (UEFI) specification
1482 * @image_handle handle of the image to be unloaded
1483 * @return status code
1485 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1487 struct efi_object *efiobj;
1489 EFI_ENTRY("%p", image_handle);
1490 efiobj = efi_search_obj(image_handle);
1492 list_del(&efiobj->link);
1494 return EFI_EXIT(EFI_SUCCESS);
1498 * Fix up caches for EFI payloads if necessary.
1500 static void efi_exit_caches(void)
1502 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1504 * Grub on 32bit ARM needs to have caches disabled before jumping into
1505 * a zImage, but does not know of all cache layers. Give it a hand.
1507 if (efi_is_direct_boot)
1508 cleanup_before_linux();
1513 * Stop boot services.
1515 * This function implements the ExitBootServices service.
1516 * See the Unified Extensible Firmware Interface (UEFI) specification
1519 * @image_handle handle of the loaded image
1520 * @map_key key of the memory map
1521 * @return status code
1523 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1524 unsigned long map_key)
1528 EFI_ENTRY("%p, %ld", image_handle, map_key);
1530 /* Notify that ExitBootServices is invoked. */
1531 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1532 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1534 efi_signal_event(&efi_events[i]);
1536 /* Make sure that notification functions are not called anymore */
1537 efi_tpl = TPL_HIGH_LEVEL;
1539 /* XXX Should persist EFI variables here */
1541 board_quiesce_devices();
1543 /* Fix up caches for EFI payloads if necessary */
1546 /* This stops all lingering devices */
1547 bootm_disable_interrupts();
1549 /* Give the payload some time to boot */
1550 efi_set_watchdog(0);
1553 return EFI_EXIT(EFI_SUCCESS);
1557 * Get next value of the counter.
1559 * This function implements the NextMonotonicCount service.
1560 * See the Unified Extensible Firmware Interface (UEFI) specification
1563 * @count returned value of the counter
1564 * @return status code
1566 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1568 static uint64_t mono = 0;
1569 EFI_ENTRY("%p", count);
1571 return EFI_EXIT(EFI_SUCCESS);
1577 * This function implements the Stall sercive.
1578 * See the Unified Extensible Firmware Interface (UEFI) specification
1581 * @microseconds period to sleep in microseconds
1582 * @return status code
1584 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1586 EFI_ENTRY("%ld", microseconds);
1587 udelay(microseconds);
1588 return EFI_EXIT(EFI_SUCCESS);
1592 * Reset the watchdog timer.
1594 * This function implements the SetWatchdogTimer service.
1595 * See the Unified Extensible Firmware Interface (UEFI) specification
1598 * @timeout seconds before reset by watchdog
1599 * @watchdog_code code to be logged when resetting
1600 * @data_size size of buffer in bytes
1601 * @watchdog_data buffer with data describing the reset reason
1602 * @return status code
1604 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1605 uint64_t watchdog_code,
1606 unsigned long data_size,
1607 uint16_t *watchdog_data)
1609 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1610 data_size, watchdog_data);
1611 return EFI_EXIT(efi_set_watchdog(timeout));
1615 * Connect a controller to a driver.
1617 * This function implements the ConnectController service.
1618 * See the Unified Extensible Firmware Interface (UEFI) specification
1621 * @controller_handle handle of the controller
1622 * @driver_image_handle handle of the driver
1623 * @remain_device_path device path of a child controller
1624 * @recursive true to connect all child controllers
1625 * @return status code
1627 static efi_status_t EFIAPI efi_connect_controller(
1628 efi_handle_t controller_handle,
1629 efi_handle_t *driver_image_handle,
1630 struct efi_device_path *remain_device_path,
1633 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1634 remain_device_path, recursive);
1635 return EFI_EXIT(EFI_NOT_FOUND);
1639 * Disconnect a controller from a driver.
1641 * This function implements the DisconnectController service.
1642 * See the Unified Extensible Firmware Interface (UEFI) specification
1645 * @controller_handle handle of the controller
1646 * @driver_image_handle handle of the driver
1647 * @child_handle handle of the child to destroy
1648 * @return status code
1650 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1651 void *driver_image_handle,
1654 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1656 return EFI_EXIT(EFI_INVALID_PARAMETER);
1662 * This function implements the CloseProtocol service.
1663 * See the Unified Extensible Firmware Interface (UEFI) specification
1666 * @handle handle on which the protocol shall be closed
1667 * @protocol GUID of the protocol to close
1668 * @agent_handle handle of the driver
1669 * @controller_handle handle of the controller
1670 * @return status code
1672 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1673 const efi_guid_t *protocol,
1675 void *controller_handle)
1677 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1679 return EFI_EXIT(EFI_NOT_FOUND);
1683 * Provide information about then open status of a protocol on a handle
1685 * This function implements the OpenProtocolInformation service.
1686 * See the Unified Extensible Firmware Interface (UEFI) specification
1689 * @handle handle for which the information shall be retrieved
1690 * @protocol GUID of the protocol
1691 * @entry_buffer buffer to receive the open protocol information
1692 * @entry_count number of entries available in the buffer
1693 * @return status code
1695 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1696 const efi_guid_t *protocol,
1697 struct efi_open_protocol_info_entry **entry_buffer,
1698 efi_uintn_t *entry_count)
1700 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1702 return EFI_EXIT(EFI_NOT_FOUND);
1706 * Get protocols installed on a handle.
1708 * This function implements the ProtocolsPerHandleService.
1709 * See the Unified Extensible Firmware Interface (UEFI) specification
1712 * @handle handle for which the information is retrieved
1713 * @protocol_buffer buffer with protocol GUIDs
1714 * @protocol_buffer_count number of entries in the buffer
1715 * @return status code
1717 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1718 efi_guid_t ***protocol_buffer,
1719 efi_uintn_t *protocol_buffer_count)
1721 unsigned long buffer_size;
1722 struct efi_object *efiobj;
1724 struct list_head *lhandle;
1727 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1728 protocol_buffer_count);
1730 if (!handle || !protocol_buffer || !protocol_buffer_count)
1731 return EFI_EXIT(EFI_INVALID_PARAMETER);
1733 *protocol_buffer = NULL;
1734 *protocol_buffer_count = 0;
1735 list_for_each(lhandle, &efi_obj_list) {
1736 efiobj = list_entry(lhandle, struct efi_object, link);
1738 if (efiobj->handle != handle)
1741 /* Count protocols */
1742 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1743 if (efiobj->protocols[i].guid)
1744 ++*protocol_buffer_count;
1747 if (*protocol_buffer_count) {
1748 buffer_size = sizeof(efi_guid_t *) *
1749 *protocol_buffer_count;
1750 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
1752 (void **)protocol_buffer);
1753 if (r != EFI_SUCCESS)
1756 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
1757 if (efiobj->protocols[i].guid) {
1758 (*protocol_buffer)[j] = (void *)
1759 efiobj->protocols[i].guid;
1767 return EFI_EXIT(EFI_SUCCESS);
1771 * Locate handles implementing a protocol.
1773 * This function implements the LocateHandleBuffer service.
1774 * See the Unified Extensible Firmware Interface (UEFI) specification
1777 * @search_type selection criterion
1778 * @protocol GUID of the protocol
1779 * @search_key registration key
1780 * @no_handles number of returned handles
1781 * @buffer buffer with the returned handles
1782 * @return status code
1784 static efi_status_t EFIAPI efi_locate_handle_buffer(
1785 enum efi_locate_search_type search_type,
1786 const efi_guid_t *protocol, void *search_key,
1787 efi_uintn_t *no_handles, efi_handle_t **buffer)
1790 efi_uintn_t buffer_size = 0;
1792 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1793 no_handles, buffer);
1795 if (!no_handles || !buffer) {
1796 r = EFI_INVALID_PARAMETER;
1801 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1803 if (r != EFI_BUFFER_TOO_SMALL)
1805 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1807 if (r != EFI_SUCCESS)
1809 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1811 if (r == EFI_SUCCESS)
1812 *no_handles = buffer_size / sizeof(void *);
1818 * Find an interface implementing a protocol.
1820 * This function implements the LocateProtocol service.
1821 * See the Unified Extensible Firmware Interface (UEFI) specification
1824 * @protocol GUID of the protocol
1825 * @registration registration key passed to the notification function
1826 * @protocol_interface interface implementing the protocol
1827 * @return status code
1829 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1831 void **protocol_interface)
1833 struct list_head *lhandle;
1836 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1838 if (!protocol || !protocol_interface)
1839 return EFI_EXIT(EFI_INVALID_PARAMETER);
1841 EFI_PRINT_GUID("protocol", protocol);
1843 list_for_each(lhandle, &efi_obj_list) {
1844 struct efi_object *efiobj;
1846 efiobj = list_entry(lhandle, struct efi_object, link);
1847 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1848 struct efi_handler *handler = &efiobj->protocols[i];
1852 if (!guidcmp(handler->guid, protocol)) {
1853 *protocol_interface =
1854 handler->protocol_interface;
1855 return EFI_EXIT(EFI_SUCCESS);
1859 *protocol_interface = NULL;
1861 return EFI_EXIT(EFI_NOT_FOUND);
1865 * Install multiple protocol interfaces.
1867 * This function implements the MultipleProtocolInterfaces service.
1868 * See the Unified Extensible Firmware Interface (UEFI) specification
1871 * @handle handle on which the protocol interfaces shall be installed
1872 * @... NULL terminated argument list with pairs of protocol GUIDS and
1874 * @return status code
1876 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1879 EFI_ENTRY("%p", handle);
1882 const efi_guid_t *protocol;
1883 void *protocol_interface;
1884 efi_status_t r = EFI_SUCCESS;
1888 return EFI_EXIT(EFI_INVALID_PARAMETER);
1890 va_start(argptr, handle);
1892 protocol = va_arg(argptr, efi_guid_t*);
1895 protocol_interface = va_arg(argptr, void*);
1896 r = EFI_CALL(efi_install_protocol_interface(
1898 EFI_NATIVE_INTERFACE,
1899 protocol_interface));
1900 if (r != EFI_SUCCESS)
1905 if (r == EFI_SUCCESS)
1908 /* If an error occurred undo all changes. */
1909 va_start(argptr, handle);
1911 protocol = va_arg(argptr, efi_guid_t*);
1912 protocol_interface = va_arg(argptr, void*);
1913 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
1914 protocol_interface));
1922 * Uninstall multiple protocol interfaces.
1924 * This function implements the UninstallMultipleProtocolInterfaces service.
1925 * See the Unified Extensible Firmware Interface (UEFI) specification
1928 * @handle handle from which the protocol interfaces shall be removed
1929 * @... NULL terminated argument list with pairs of protocol GUIDS and
1931 * @return status code
1933 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
1936 EFI_ENTRY("%p", handle);
1939 const efi_guid_t *protocol;
1940 void *protocol_interface;
1941 efi_status_t r = EFI_SUCCESS;
1945 return EFI_EXIT(EFI_INVALID_PARAMETER);
1947 va_start(argptr, handle);
1949 protocol = va_arg(argptr, efi_guid_t*);
1952 protocol_interface = va_arg(argptr, void*);
1953 r = EFI_CALL(efi_uninstall_protocol_interface(
1955 protocol_interface));
1956 if (r != EFI_SUCCESS)
1961 if (r == EFI_SUCCESS)
1964 /* If an error occurred undo all changes. */
1965 va_start(argptr, handle);
1967 protocol = va_arg(argptr, efi_guid_t*);
1968 protocol_interface = va_arg(argptr, void*);
1969 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
1970 EFI_NATIVE_INTERFACE,
1971 protocol_interface));
1979 * Calculate cyclic redundancy code.
1981 * This function implements the CalculateCrc32 service.
1982 * See the Unified Extensible Firmware Interface (UEFI) specification
1985 * @data buffer with data
1986 * @data_size size of buffer in bytes
1987 * @crc32_p cyclic redundancy code
1988 * @return status code
1990 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
1991 unsigned long data_size,
1994 EFI_ENTRY("%p, %ld", data, data_size);
1995 *crc32_p = crc32(0, data, data_size);
1996 return EFI_EXIT(EFI_SUCCESS);
2002 * This function implements the CopyMem service.
2003 * See the Unified Extensible Firmware Interface (UEFI) specification
2006 * @destination destination of the copy operation
2007 * @source source of the copy operation
2008 * @length number of bytes to copy
2010 static void EFIAPI efi_copy_mem(void *destination, const void *source,
2013 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
2014 memcpy(destination, source, length);
2015 EFI_EXIT(EFI_SUCCESS);
2019 * Fill memory with a byte value.
2021 * This function implements the SetMem service.
2022 * See the Unified Extensible Firmware Interface (UEFI) specification
2025 * @buffer buffer to fill
2026 * @size size of buffer in bytes
2027 * @value byte to copy to the buffer
2029 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
2031 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
2032 memset(buffer, value, size);
2033 EFI_EXIT(EFI_SUCCESS);
2037 * Open protocol interface on a handle.
2039 * This function implements the OpenProtocol interface.
2040 * See the Unified Extensible Firmware Interface (UEFI) specification
2043 * @handle handle on which the protocol shall be opened
2044 * @protocol GUID of the protocol
2045 * @protocol_interface interface implementing the protocol
2046 * @agent_handle handle of the driver
2047 * @controller_handle handle of the controller
2048 * @attributes attributes indicating how to open the protocol
2049 * @return status code
2051 static efi_status_t EFIAPI efi_open_protocol(
2052 void *handle, const efi_guid_t *protocol,
2053 void **protocol_interface, void *agent_handle,
2054 void *controller_handle, uint32_t attributes)
2056 struct list_head *lhandle;
2058 efi_status_t r = EFI_INVALID_PARAMETER;
2060 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
2061 protocol_interface, agent_handle, controller_handle,
2064 if (!handle || !protocol ||
2065 (!protocol_interface && attributes !=
2066 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
2070 EFI_PRINT_GUID("protocol", protocol);
2072 switch (attributes) {
2073 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
2074 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
2075 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
2077 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
2078 if (controller_handle == handle)
2080 case EFI_OPEN_PROTOCOL_BY_DRIVER:
2081 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
2082 if (controller_handle == NULL)
2084 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
2085 if (agent_handle == NULL)
2092 list_for_each(lhandle, &efi_obj_list) {
2093 struct efi_object *efiobj;
2094 efiobj = list_entry(lhandle, struct efi_object, link);
2096 if (efiobj->handle != handle)
2099 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
2100 struct efi_handler *handler = &efiobj->protocols[i];
2101 const efi_guid_t *hprotocol = handler->guid;
2104 if (!guidcmp(hprotocol, protocol)) {
2106 EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
2107 *protocol_interface =
2108 handler->protocol_interface;
2118 r = EFI_UNSUPPORTED;
2124 * Get interface of a protocol on a handle.
2126 * This function implements the HandleProtocol service.
2127 * See the Unified Extensible Firmware Interface (UEFI) specification
2130 * @handle handle on which the protocol shall be opened
2131 * @protocol GUID of the protocol
2132 * @protocol_interface interface implementing the protocol
2133 * @return status code
2135 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
2136 const efi_guid_t *protocol,
2137 void **protocol_interface)
2139 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2140 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2143 static const struct efi_boot_services efi_boot_services = {
2145 .headersize = sizeof(struct efi_table_hdr),
2147 .raise_tpl = efi_raise_tpl,
2148 .restore_tpl = efi_restore_tpl,
2149 .allocate_pages = efi_allocate_pages_ext,
2150 .free_pages = efi_free_pages_ext,
2151 .get_memory_map = efi_get_memory_map_ext,
2152 .allocate_pool = efi_allocate_pool_ext,
2153 .free_pool = efi_free_pool_ext,
2154 .create_event = efi_create_event_ext,
2155 .set_timer = efi_set_timer_ext,
2156 .wait_for_event = efi_wait_for_event,
2157 .signal_event = efi_signal_event_ext,
2158 .close_event = efi_close_event,
2159 .check_event = efi_check_event,
2160 .install_protocol_interface = efi_install_protocol_interface,
2161 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2162 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2163 .handle_protocol = efi_handle_protocol,
2165 .register_protocol_notify = efi_register_protocol_notify,
2166 .locate_handle = efi_locate_handle_ext,
2167 .locate_device_path = efi_locate_device_path,
2168 .install_configuration_table = efi_install_configuration_table_ext,
2169 .load_image = efi_load_image,
2170 .start_image = efi_start_image,
2172 .unload_image = efi_unload_image,
2173 .exit_boot_services = efi_exit_boot_services,
2174 .get_next_monotonic_count = efi_get_next_monotonic_count,
2176 .set_watchdog_timer = efi_set_watchdog_timer,
2177 .connect_controller = efi_connect_controller,
2178 .disconnect_controller = efi_disconnect_controller,
2179 .open_protocol = efi_open_protocol,
2180 .close_protocol = efi_close_protocol,
2181 .open_protocol_information = efi_open_protocol_information,
2182 .protocols_per_handle = efi_protocols_per_handle,
2183 .locate_handle_buffer = efi_locate_handle_buffer,
2184 .locate_protocol = efi_locate_protocol,
2185 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2186 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2187 .calculate_crc32 = efi_calculate_crc32,
2188 .copy_mem = efi_copy_mem,
2189 .set_mem = efi_set_mem,
2193 static uint16_t __efi_runtime_data firmware_vendor[] =
2194 { 'D','a','s',' ','U','-','b','o','o','t',0 };
2196 struct efi_system_table __efi_runtime_data systab = {
2198 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2199 .revision = 0x20005, /* 2.5 */
2200 .headersize = sizeof(struct efi_table_hdr),
2202 .fw_vendor = (long)firmware_vendor,
2203 .con_in = (void*)&efi_con_in,
2204 .con_out = (void*)&efi_con_out,
2205 .std_err = (void*)&efi_con_out,
2206 .runtime = (void*)&efi_runtime_services,
2207 .boottime = (void*)&efi_boot_services,
2209 .tables = (void*)efi_conf_table,