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(void *handle)
695 struct efi_object *efiobj;
697 list_for_each_entry(efiobj, &efi_obj_list, link) {
698 if (efiobj->handle == handle)
706 * Install protocol interface.
708 * This function implements the InstallProtocolInterface service.
709 * See the Unified Extensible Firmware Interface (UEFI) specification
712 * @handle handle on which the protocol shall be installed
713 * @protocol GUID of the protocol to be installed
714 * @protocol_interface_type type of the interface to be installed,
715 * always EFI_NATIVE_INTERFACE
716 * @protocol_interface interface of the protocol implementation
717 * @return status code
719 static efi_status_t EFIAPI efi_install_protocol_interface(
720 void **handle, const efi_guid_t *protocol,
721 int protocol_interface_type, void *protocol_interface)
723 struct list_head *lhandle;
727 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
730 if (!handle || !protocol ||
731 protocol_interface_type != EFI_NATIVE_INTERFACE) {
732 r = EFI_INVALID_PARAMETER;
736 /* Create new handle if requested. */
738 r = efi_create_handle(handle);
739 if (r != EFI_SUCCESS)
741 debug("%sEFI: new handle %p\n", indent_string(nesting_level),
744 debug("%sEFI: handle %p\n", indent_string(nesting_level),
748 list_for_each(lhandle, &efi_obj_list) {
749 struct efi_object *efiobj;
750 efiobj = list_entry(lhandle, struct efi_object, link);
752 if (efiobj->handle != *handle)
754 /* Check if protocol is already installed on the handle. */
755 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
756 struct efi_handler *handler = &efiobj->protocols[i];
760 if (!guidcmp(handler->guid, protocol)) {
761 r = EFI_INVALID_PARAMETER;
765 /* Install protocol in first empty slot. */
766 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
767 struct efi_handler *handler = &efiobj->protocols[i];
772 handler->guid = protocol;
773 handler->protocol_interface = protocol_interface;
777 r = EFI_OUT_OF_RESOURCES;
780 r = EFI_INVALID_PARAMETER;
786 * Reinstall protocol interface.
788 * This function implements the ReinstallProtocolInterface service.
789 * See the Unified Extensible Firmware Interface (UEFI) specification
792 * @handle handle on which the protocol shall be
794 * @protocol GUID of the protocol to be installed
795 * @old_interface interface to be removed
796 * @new_interface interface to be installed
797 * @return status code
799 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
800 const efi_guid_t *protocol, void *old_interface,
803 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
805 return EFI_EXIT(EFI_ACCESS_DENIED);
809 * Uninstall protocol interface.
811 * This function implements the UninstallProtocolInterface service.
812 * See the Unified Extensible Firmware Interface (UEFI) specification
815 * @handle handle from which the protocol shall be removed
816 * @protocol GUID of the protocol to be removed
817 * @protocol_interface interface to be removed
818 * @return status code
820 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
821 void *handle, const efi_guid_t *protocol,
822 void *protocol_interface)
824 struct list_head *lhandle;
826 efi_status_t r = EFI_NOT_FOUND;
828 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
830 if (!handle || !protocol) {
831 r = EFI_INVALID_PARAMETER;
835 list_for_each(lhandle, &efi_obj_list) {
836 struct efi_object *efiobj;
837 efiobj = list_entry(lhandle, struct efi_object, link);
839 if (efiobj->handle != handle)
842 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
843 struct efi_handler *handler = &efiobj->protocols[i];
844 const efi_guid_t *hprotocol = handler->guid;
848 if (!guidcmp(hprotocol, protocol)) {
849 if (handler->protocol_interface) {
850 r = EFI_ACCESS_DENIED;
865 * Register an event for notification when a protocol is installed.
867 * This function implements the RegisterProtocolNotify service.
868 * See the Unified Extensible Firmware Interface (UEFI) specification
871 * @protocol GUID of the protocol whose installation shall be
873 * @event event to be signaled upon installation of the protocol
874 * @registration key for retrieving the registration information
875 * @return status code
877 static efi_status_t EFIAPI efi_register_protocol_notify(
878 const efi_guid_t *protocol,
879 struct efi_event *event,
882 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
883 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
887 * Determine if an EFI handle implements a protocol.
889 * See the documentation of the LocateHandle service in the UEFI specification.
891 * @search_type selection criterion
892 * @protocol GUID of the protocol
893 * @search_key registration key
895 * @return 0 if the handle implements the protocol
897 static int efi_search(enum efi_locate_search_type search_type,
898 const efi_guid_t *protocol, void *search_key,
899 struct efi_object *efiobj)
903 switch (search_type) {
906 case BY_REGISTER_NOTIFY:
907 /* RegisterProtocolNotify is not implemented yet */
910 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
911 const efi_guid_t *guid = efiobj->protocols[i].guid;
912 if (guid && !guidcmp(guid, protocol))
922 * Locate handles implementing a protocol.
924 * This function is meant for U-Boot internal calls. For the API implementation
925 * of the LocateHandle service see efi_locate_handle_ext.
927 * @search_type selection criterion
928 * @protocol GUID of the protocol
929 * @search_key registration key
930 * @buffer_size size of the buffer to receive the handles in bytes
931 * @buffer buffer to receive the relevant handles
932 * @return status code
934 static efi_status_t efi_locate_handle(
935 enum efi_locate_search_type search_type,
936 const efi_guid_t *protocol, void *search_key,
937 efi_uintn_t *buffer_size, efi_handle_t *buffer)
939 struct efi_object *efiobj;
940 efi_uintn_t size = 0;
942 /* Check parameters */
943 switch (search_type) {
946 case BY_REGISTER_NOTIFY:
948 return EFI_INVALID_PARAMETER;
949 /* RegisterProtocolNotify is not implemented yet */
950 return EFI_UNSUPPORTED;
953 return EFI_INVALID_PARAMETER;
956 return EFI_INVALID_PARAMETER;
960 * efi_locate_handle_buffer uses this function for
961 * the calculation of the necessary buffer size.
962 * So do not require a buffer for buffersize == 0.
964 if (!buffer_size || (*buffer_size && !buffer))
965 return EFI_INVALID_PARAMETER;
967 /* Count how much space we need */
968 list_for_each_entry(efiobj, &efi_obj_list, link) {
969 if (!efi_search(search_type, protocol, search_key, efiobj))
970 size += sizeof(void*);
973 if (*buffer_size < size) {
975 return EFI_BUFFER_TOO_SMALL;
980 return EFI_NOT_FOUND;
982 /* Then fill the array */
983 list_for_each_entry(efiobj, &efi_obj_list, link) {
984 if (!efi_search(search_type, protocol, search_key, efiobj))
985 *buffer++ = efiobj->handle;
992 * Locate handles implementing a protocol.
994 * This function implements the LocateHandle service.
995 * See the Unified Extensible Firmware Interface (UEFI) specification
998 * @search_type selection criterion
999 * @protocol GUID of the protocol
1000 * @search_key registration key
1001 * @buffer_size size of the buffer to receive the handles in bytes
1002 * @buffer buffer to receive the relevant handles
1003 * @return 0 if the handle implements the protocol
1005 static efi_status_t EFIAPI efi_locate_handle_ext(
1006 enum efi_locate_search_type search_type,
1007 const efi_guid_t *protocol, void *search_key,
1008 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1010 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1011 buffer_size, buffer);
1013 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1014 buffer_size, buffer));
1018 * Get the device path and handle of an device implementing a protocol.
1020 * This function implements the LocateDevicePath service.
1021 * See the Unified Extensible Firmware Interface (UEFI) specification
1024 * @protocol GUID of the protocol
1025 * @device_path device path
1026 * @device handle of the device
1027 * @return status code
1029 static efi_status_t EFIAPI efi_locate_device_path(
1030 const efi_guid_t *protocol,
1031 struct efi_device_path **device_path,
1032 efi_handle_t *device)
1034 struct efi_object *efiobj;
1036 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1038 efiobj = efi_dp_find_obj(*device_path, device_path);
1040 return EFI_EXIT(EFI_NOT_FOUND);
1042 *device = efiobj->handle;
1044 return EFI_EXIT(EFI_SUCCESS);
1047 /* Collapses configuration table entries, removing index i */
1048 static void efi_remove_configuration_table(int i)
1050 struct efi_configuration_table *this = &efi_conf_table[i];
1051 struct efi_configuration_table *next = &efi_conf_table[i+1];
1052 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1054 memmove(this, next, (ulong)end - (ulong)next);
1059 * Adds, updates, or removes a configuration table.
1061 * This function is used for internal calls. For the API implementation of the
1062 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1064 * @guid GUID of the installed table
1065 * @table table to be installed
1066 * @return status code
1068 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1072 /* Check for guid override */
1073 for (i = 0; i < systab.nr_tables; i++) {
1074 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1076 efi_conf_table[i].table = table;
1078 efi_remove_configuration_table(i);
1084 return EFI_NOT_FOUND;
1086 /* No override, check for overflow */
1087 if (i >= ARRAY_SIZE(efi_conf_table))
1088 return EFI_OUT_OF_RESOURCES;
1090 /* Add a new entry */
1091 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1092 efi_conf_table[i].table = table;
1093 systab.nr_tables = i + 1;
1099 * Adds, updates, or removes a configuration table.
1101 * This function implements the InstallConfigurationTable service.
1102 * See the Unified Extensible Firmware Interface (UEFI) specification
1105 * @guid GUID of the installed table
1106 * @table table to be installed
1107 * @return status code
1109 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1112 EFI_ENTRY("%pUl, %p", guid, table);
1113 return EFI_EXIT(efi_install_configuration_table(guid, table));
1117 * Initialize a loaded_image_info + loaded_image_info object with correct
1118 * protocols, boot-device, etc.
1120 * @info loaded image info to be passed to the entry point of the
1122 * @obj internal object associated with the loaded image
1123 * @device_path device path of the loaded image
1124 * @file_path file path of the loaded image
1126 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
1127 struct efi_device_path *device_path,
1128 struct efi_device_path *file_path)
1133 * When asking for the device path interface, return
1134 * bootefi_device_path
1136 obj->protocols[0].guid = &efi_guid_device_path;
1137 obj->protocols[0].protocol_interface = device_path;
1140 * When asking for the loaded_image interface, just
1141 * return handle which points to loaded_image_info
1143 obj->protocols[1].guid = &efi_guid_loaded_image;
1144 obj->protocols[1].protocol_interface = info;
1146 obj->protocols[2].guid = &efi_guid_console_control;
1147 obj->protocols[2].protocol_interface = (void *)&efi_console_control;
1149 obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
1150 obj->protocols[3].protocol_interface =
1151 (void *)&efi_device_path_to_text;
1153 info->file_path = file_path;
1155 info->device_handle = efi_dp_find_obj(device_path, NULL);
1157 list_add_tail(&obj->link, &efi_obj_list);
1161 * Load an image using a file path.
1163 * @file_path the path of the image to load
1164 * @buffer buffer containing the loaded image
1165 * @return status code
1167 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1170 struct efi_file_info *info = NULL;
1171 struct efi_file_handle *f;
1172 static efi_status_t ret;
1175 f = efi_file_from_path(file_path);
1177 return EFI_DEVICE_ERROR;
1180 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1182 if (ret == EFI_BUFFER_TOO_SMALL) {
1184 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1187 if (ret != EFI_SUCCESS)
1190 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1194 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1198 EFI_CALL(f->close(f));
1200 if (ret != EFI_SUCCESS) {
1201 efi_free_pool(*buffer);
1209 * Load an EFI image into memory.
1211 * This function implements the LoadImage service.
1212 * See the Unified Extensible Firmware Interface (UEFI) specification
1215 * @boot_policy true for request originating from the boot manager
1216 * @parent_image the calles's image handle
1217 * @file_path the path of the image to load
1218 * @source_buffer memory location from which the image is installed
1219 * @source_size size of the memory area from which the image is
1221 * @image_handle handle for the newly installed image
1222 * @return status code
1224 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1225 efi_handle_t parent_image,
1226 struct efi_device_path *file_path,
1227 void *source_buffer,
1228 unsigned long source_size,
1229 efi_handle_t *image_handle)
1231 struct efi_loaded_image *info;
1232 struct efi_object *obj;
1234 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1235 file_path, source_buffer, source_size, image_handle);
1237 info = calloc(1, sizeof(*info));
1238 obj = calloc(1, sizeof(*obj));
1240 if (!source_buffer) {
1241 struct efi_device_path *dp, *fp;
1244 ret = efi_load_image_from_path(file_path, &source_buffer);
1245 if (ret != EFI_SUCCESS) {
1248 return EFI_EXIT(ret);
1252 * split file_path which contains both the device and
1255 efi_dp_split_file_path(file_path, &dp, &fp);
1257 efi_setup_loaded_image(info, obj, dp, fp);
1259 /* In this case, file_path is the "device" path, ie.
1260 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1262 efi_setup_loaded_image(info, obj, file_path, NULL);
1265 info->reserved = efi_load_pe(source_buffer, info);
1266 if (!info->reserved) {
1269 return EFI_EXIT(EFI_UNSUPPORTED);
1272 info->system_table = &systab;
1273 info->parent_handle = parent_image;
1274 *image_handle = info;
1276 return EFI_EXIT(EFI_SUCCESS);
1280 * Call the entry point of an image.
1282 * This function implements the StartImage service.
1283 * See the Unified Extensible Firmware Interface (UEFI) specification
1286 * @image_handle handle of the image
1287 * @exit_data_size size of the buffer
1288 * @exit_data buffer to receive the exit data of the called image
1289 * @return status code
1291 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1292 unsigned long *exit_data_size,
1295 ulong (*entry)(void *image_handle, struct efi_system_table *st);
1296 struct efi_loaded_image *info = image_handle;
1298 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1299 entry = info->reserved;
1301 efi_is_direct_boot = false;
1303 /* call the image! */
1304 if (setjmp(&info->exit_jmp)) {
1305 /* We returned from the child image */
1306 return EFI_EXIT(info->exit_status);
1309 __efi_nesting_dec();
1311 entry(image_handle, &systab);
1312 __efi_entry_check();
1313 __efi_nesting_inc();
1315 /* Should usually never get here */
1316 return EFI_EXIT(EFI_SUCCESS);
1320 * Leave an EFI application or driver.
1322 * This function implements the Exit service.
1323 * See the Unified Extensible Firmware Interface (UEFI) specification
1326 * @image_handle handle of the application or driver that is exiting
1327 * @exit_status status code
1328 * @exit_data_size size of the buffer in bytes
1329 * @exit_data buffer with data describing an error
1330 * @return status code
1332 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1333 efi_status_t exit_status, unsigned long exit_data_size,
1336 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1338 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1339 exit_data_size, exit_data);
1341 /* Make sure entry/exit counts for EFI world cross-overs match */
1345 * But longjmp out with the U-Boot gd, not the application's, as
1346 * the other end is a setjmp call inside EFI context.
1350 loaded_image_info->exit_status = exit_status;
1351 longjmp(&loaded_image_info->exit_jmp, 1);
1353 panic("EFI application exited");
1357 * Unload an EFI image.
1359 * This function implements the UnloadImage service.
1360 * See the Unified Extensible Firmware Interface (UEFI) specification
1363 * @image_handle handle of the image to be unloaded
1364 * @return status code
1366 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1368 struct efi_object *efiobj;
1370 EFI_ENTRY("%p", image_handle);
1371 efiobj = efi_search_obj(image_handle);
1373 list_del(&efiobj->link);
1375 return EFI_EXIT(EFI_SUCCESS);
1379 * Fix up caches for EFI payloads if necessary.
1381 static void efi_exit_caches(void)
1383 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1385 * Grub on 32bit ARM needs to have caches disabled before jumping into
1386 * a zImage, but does not know of all cache layers. Give it a hand.
1388 if (efi_is_direct_boot)
1389 cleanup_before_linux();
1394 * Stop boot services.
1396 * This function implements the ExitBootServices service.
1397 * See the Unified Extensible Firmware Interface (UEFI) specification
1400 * @image_handle handle of the loaded image
1401 * @map_key key of the memory map
1402 * @return status code
1404 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1405 unsigned long map_key)
1409 EFI_ENTRY("%p, %ld", image_handle, map_key);
1411 /* Notify that ExitBootServices is invoked. */
1412 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1413 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1415 efi_signal_event(&efi_events[i]);
1417 /* Make sure that notification functions are not called anymore */
1418 efi_tpl = TPL_HIGH_LEVEL;
1420 /* XXX Should persist EFI variables here */
1422 board_quiesce_devices();
1424 /* Fix up caches for EFI payloads if necessary */
1427 /* This stops all lingering devices */
1428 bootm_disable_interrupts();
1430 /* Give the payload some time to boot */
1431 efi_set_watchdog(0);
1434 return EFI_EXIT(EFI_SUCCESS);
1438 * Get next value of the counter.
1440 * This function implements the NextMonotonicCount service.
1441 * See the Unified Extensible Firmware Interface (UEFI) specification
1444 * @count returned value of the counter
1445 * @return status code
1447 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1449 static uint64_t mono = 0;
1450 EFI_ENTRY("%p", count);
1452 return EFI_EXIT(EFI_SUCCESS);
1458 * This function implements the Stall sercive.
1459 * See the Unified Extensible Firmware Interface (UEFI) specification
1462 * @microseconds period to sleep in microseconds
1463 * @return status code
1465 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1467 EFI_ENTRY("%ld", microseconds);
1468 udelay(microseconds);
1469 return EFI_EXIT(EFI_SUCCESS);
1473 * Reset the watchdog timer.
1475 * This function implements the SetWatchdogTimer service.
1476 * See the Unified Extensible Firmware Interface (UEFI) specification
1479 * @timeout seconds before reset by watchdog
1480 * @watchdog_code code to be logged when resetting
1481 * @data_size size of buffer in bytes
1482 * @watchdog_data buffer with data describing the reset reason
1483 * @return status code
1485 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1486 uint64_t watchdog_code,
1487 unsigned long data_size,
1488 uint16_t *watchdog_data)
1490 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1491 data_size, watchdog_data);
1492 return EFI_EXIT(efi_set_watchdog(timeout));
1496 * Connect a controller to a driver.
1498 * This function implements the ConnectController service.
1499 * See the Unified Extensible Firmware Interface (UEFI) specification
1502 * @controller_handle handle of the controller
1503 * @driver_image_handle handle of the driver
1504 * @remain_device_path device path of a child controller
1505 * @recursive true to connect all child controllers
1506 * @return status code
1508 static efi_status_t EFIAPI efi_connect_controller(
1509 efi_handle_t controller_handle,
1510 efi_handle_t *driver_image_handle,
1511 struct efi_device_path *remain_device_path,
1514 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1515 remain_device_path, recursive);
1516 return EFI_EXIT(EFI_NOT_FOUND);
1520 * Disconnect a controller from a driver.
1522 * This function implements the DisconnectController service.
1523 * See the Unified Extensible Firmware Interface (UEFI) specification
1526 * @controller_handle handle of the controller
1527 * @driver_image_handle handle of the driver
1528 * @child_handle handle of the child to destroy
1529 * @return status code
1531 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1532 void *driver_image_handle,
1535 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1537 return EFI_EXIT(EFI_INVALID_PARAMETER);
1543 * This function implements the CloseProtocol service.
1544 * See the Unified Extensible Firmware Interface (UEFI) specification
1547 * @handle handle on which the protocol shall be closed
1548 * @protocol GUID of the protocol to close
1549 * @agent_handle handle of the driver
1550 * @controller_handle handle of the controller
1551 * @return status code
1553 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1554 const efi_guid_t *protocol,
1556 void *controller_handle)
1558 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1560 return EFI_EXIT(EFI_NOT_FOUND);
1564 * Provide information about then open status of a protocol on a handle
1566 * This function implements the OpenProtocolInformation service.
1567 * See the Unified Extensible Firmware Interface (UEFI) specification
1570 * @handle handle for which the information shall be retrieved
1571 * @protocol GUID of the protocol
1572 * @entry_buffer buffer to receive the open protocol information
1573 * @entry_count number of entries available in the buffer
1574 * @return status code
1576 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1577 const efi_guid_t *protocol,
1578 struct efi_open_protocol_info_entry **entry_buffer,
1579 efi_uintn_t *entry_count)
1581 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1583 return EFI_EXIT(EFI_NOT_FOUND);
1587 * Get protocols installed on a handle.
1589 * This function implements the ProtocolsPerHandleService.
1590 * See the Unified Extensible Firmware Interface (UEFI) specification
1593 * @handle handle for which the information is retrieved
1594 * @protocol_buffer buffer with protocol GUIDs
1595 * @protocol_buffer_count number of entries in the buffer
1596 * @return status code
1598 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1599 efi_guid_t ***protocol_buffer,
1600 efi_uintn_t *protocol_buffer_count)
1602 unsigned long buffer_size;
1603 struct efi_object *efiobj;
1605 struct list_head *lhandle;
1608 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1609 protocol_buffer_count);
1611 if (!handle || !protocol_buffer || !protocol_buffer_count)
1612 return EFI_EXIT(EFI_INVALID_PARAMETER);
1614 *protocol_buffer = NULL;
1615 *protocol_buffer_count = 0;
1616 list_for_each(lhandle, &efi_obj_list) {
1617 efiobj = list_entry(lhandle, struct efi_object, link);
1619 if (efiobj->handle != handle)
1622 /* Count protocols */
1623 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1624 if (efiobj->protocols[i].guid)
1625 ++*protocol_buffer_count;
1628 if (*protocol_buffer_count) {
1629 buffer_size = sizeof(efi_guid_t *) *
1630 *protocol_buffer_count;
1631 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
1633 (void **)protocol_buffer);
1634 if (r != EFI_SUCCESS)
1637 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
1638 if (efiobj->protocols[i].guid) {
1639 (*protocol_buffer)[j] = (void *)
1640 efiobj->protocols[i].guid;
1648 return EFI_EXIT(EFI_SUCCESS);
1652 * Locate handles implementing a protocol.
1654 * This function implements the LocateHandleBuffer service.
1655 * See the Unified Extensible Firmware Interface (UEFI) specification
1658 * @search_type selection criterion
1659 * @protocol GUID of the protocol
1660 * @search_key registration key
1661 * @no_handles number of returned handles
1662 * @buffer buffer with the returned handles
1663 * @return status code
1665 static efi_status_t EFIAPI efi_locate_handle_buffer(
1666 enum efi_locate_search_type search_type,
1667 const efi_guid_t *protocol, void *search_key,
1668 efi_uintn_t *no_handles, efi_handle_t **buffer)
1671 efi_uintn_t buffer_size = 0;
1673 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1674 no_handles, buffer);
1676 if (!no_handles || !buffer) {
1677 r = EFI_INVALID_PARAMETER;
1682 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1684 if (r != EFI_BUFFER_TOO_SMALL)
1686 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1688 if (r != EFI_SUCCESS)
1690 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1692 if (r == EFI_SUCCESS)
1693 *no_handles = buffer_size / sizeof(void *);
1699 * Find an interface implementing a protocol.
1701 * This function implements the LocateProtocol service.
1702 * See the Unified Extensible Firmware Interface (UEFI) specification
1705 * @protocol GUID of the protocol
1706 * @registration registration key passed to the notification function
1707 * @protocol_interface interface implementing the protocol
1708 * @return status code
1710 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1712 void **protocol_interface)
1714 struct list_head *lhandle;
1717 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1719 if (!protocol || !protocol_interface)
1720 return EFI_EXIT(EFI_INVALID_PARAMETER);
1722 EFI_PRINT_GUID("protocol", protocol);
1724 list_for_each(lhandle, &efi_obj_list) {
1725 struct efi_object *efiobj;
1727 efiobj = list_entry(lhandle, struct efi_object, link);
1728 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1729 struct efi_handler *handler = &efiobj->protocols[i];
1733 if (!guidcmp(handler->guid, protocol)) {
1734 *protocol_interface =
1735 handler->protocol_interface;
1736 return EFI_EXIT(EFI_SUCCESS);
1740 *protocol_interface = NULL;
1742 return EFI_EXIT(EFI_NOT_FOUND);
1746 * Install multiple protocol interfaces.
1748 * This function implements the MultipleProtocolInterfaces service.
1749 * See the Unified Extensible Firmware Interface (UEFI) specification
1752 * @handle handle on which the protocol interfaces shall be installed
1753 * @... NULL terminated argument list with pairs of protocol GUIDS and
1755 * @return status code
1757 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1760 EFI_ENTRY("%p", handle);
1763 const efi_guid_t *protocol;
1764 void *protocol_interface;
1765 efi_status_t r = EFI_SUCCESS;
1769 return EFI_EXIT(EFI_INVALID_PARAMETER);
1771 va_start(argptr, handle);
1773 protocol = va_arg(argptr, efi_guid_t*);
1776 protocol_interface = va_arg(argptr, void*);
1777 r = EFI_CALL(efi_install_protocol_interface(
1779 EFI_NATIVE_INTERFACE,
1780 protocol_interface));
1781 if (r != EFI_SUCCESS)
1786 if (r == EFI_SUCCESS)
1789 /* If an error occurred undo all changes. */
1790 va_start(argptr, handle);
1792 protocol = va_arg(argptr, efi_guid_t*);
1793 protocol_interface = va_arg(argptr, void*);
1794 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
1795 protocol_interface));
1803 * Uninstall multiple protocol interfaces.
1805 * This function implements the UninstallMultipleProtocolInterfaces service.
1806 * See the Unified Extensible Firmware Interface (UEFI) specification
1809 * @handle handle from which the protocol interfaces shall be removed
1810 * @... NULL terminated argument list with pairs of protocol GUIDS and
1812 * @return status code
1814 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
1817 EFI_ENTRY("%p", handle);
1820 const efi_guid_t *protocol;
1821 void *protocol_interface;
1822 efi_status_t r = EFI_SUCCESS;
1826 return EFI_EXIT(EFI_INVALID_PARAMETER);
1828 va_start(argptr, handle);
1830 protocol = va_arg(argptr, efi_guid_t*);
1833 protocol_interface = va_arg(argptr, void*);
1834 r = EFI_CALL(efi_uninstall_protocol_interface(
1836 protocol_interface));
1837 if (r != EFI_SUCCESS)
1842 if (r == EFI_SUCCESS)
1845 /* If an error occurred undo all changes. */
1846 va_start(argptr, handle);
1848 protocol = va_arg(argptr, efi_guid_t*);
1849 protocol_interface = va_arg(argptr, void*);
1850 EFI_CALL(efi_install_protocol_interface(&handle, protocol,
1851 EFI_NATIVE_INTERFACE,
1852 protocol_interface));
1860 * Calculate cyclic redundancy code.
1862 * This function implements the CalculateCrc32 service.
1863 * See the Unified Extensible Firmware Interface (UEFI) specification
1866 * @data buffer with data
1867 * @data_size size of buffer in bytes
1868 * @crc32_p cyclic redundancy code
1869 * @return status code
1871 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
1872 unsigned long data_size,
1875 EFI_ENTRY("%p, %ld", data, data_size);
1876 *crc32_p = crc32(0, data, data_size);
1877 return EFI_EXIT(EFI_SUCCESS);
1883 * This function implements the CopyMem service.
1884 * See the Unified Extensible Firmware Interface (UEFI) specification
1887 * @destination destination of the copy operation
1888 * @source source of the copy operation
1889 * @length number of bytes to copy
1891 static void EFIAPI efi_copy_mem(void *destination, const void *source,
1894 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
1895 memcpy(destination, source, length);
1896 EFI_EXIT(EFI_SUCCESS);
1900 * Fill memory with a byte value.
1902 * This function implements the SetMem service.
1903 * See the Unified Extensible Firmware Interface (UEFI) specification
1906 * @buffer buffer to fill
1907 * @size size of buffer in bytes
1908 * @value byte to copy to the buffer
1910 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
1912 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
1913 memset(buffer, value, size);
1914 EFI_EXIT(EFI_SUCCESS);
1918 * Open protocol interface on a handle.
1920 * This function implements the OpenProtocol interface.
1921 * See the Unified Extensible Firmware Interface (UEFI) specification
1924 * @handle handle on which the protocol shall be opened
1925 * @protocol GUID of the protocol
1926 * @protocol_interface interface implementing the protocol
1927 * @agent_handle handle of the driver
1928 * @controller_handle handle of the controller
1929 * @attributes attributes indicating how to open the protocol
1930 * @return status code
1932 static efi_status_t EFIAPI efi_open_protocol(
1933 void *handle, const efi_guid_t *protocol,
1934 void **protocol_interface, void *agent_handle,
1935 void *controller_handle, uint32_t attributes)
1937 struct list_head *lhandle;
1939 efi_status_t r = EFI_INVALID_PARAMETER;
1941 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
1942 protocol_interface, agent_handle, controller_handle,
1945 if (!handle || !protocol ||
1946 (!protocol_interface && attributes !=
1947 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
1951 EFI_PRINT_GUID("protocol", protocol);
1953 switch (attributes) {
1954 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
1955 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
1956 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
1958 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
1959 if (controller_handle == handle)
1961 case EFI_OPEN_PROTOCOL_BY_DRIVER:
1962 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
1963 if (controller_handle == NULL)
1965 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
1966 if (agent_handle == NULL)
1973 list_for_each(lhandle, &efi_obj_list) {
1974 struct efi_object *efiobj;
1975 efiobj = list_entry(lhandle, struct efi_object, link);
1977 if (efiobj->handle != handle)
1980 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1981 struct efi_handler *handler = &efiobj->protocols[i];
1982 const efi_guid_t *hprotocol = handler->guid;
1985 if (!guidcmp(hprotocol, protocol)) {
1987 EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
1988 *protocol_interface =
1989 handler->protocol_interface;
1999 r = EFI_UNSUPPORTED;
2005 * Get interface of a protocol on a handle.
2007 * This function implements the HandleProtocol service.
2008 * See the Unified Extensible Firmware Interface (UEFI) specification
2011 * @handle handle on which the protocol shall be opened
2012 * @protocol GUID of the protocol
2013 * @protocol_interface interface implementing the protocol
2014 * @return status code
2016 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
2017 const efi_guid_t *protocol,
2018 void **protocol_interface)
2020 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
2021 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
2024 static const struct efi_boot_services efi_boot_services = {
2026 .headersize = sizeof(struct efi_table_hdr),
2028 .raise_tpl = efi_raise_tpl,
2029 .restore_tpl = efi_restore_tpl,
2030 .allocate_pages = efi_allocate_pages_ext,
2031 .free_pages = efi_free_pages_ext,
2032 .get_memory_map = efi_get_memory_map_ext,
2033 .allocate_pool = efi_allocate_pool_ext,
2034 .free_pool = efi_free_pool_ext,
2035 .create_event = efi_create_event_ext,
2036 .set_timer = efi_set_timer_ext,
2037 .wait_for_event = efi_wait_for_event,
2038 .signal_event = efi_signal_event_ext,
2039 .close_event = efi_close_event,
2040 .check_event = efi_check_event,
2041 .install_protocol_interface = efi_install_protocol_interface,
2042 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
2043 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
2044 .handle_protocol = efi_handle_protocol,
2046 .register_protocol_notify = efi_register_protocol_notify,
2047 .locate_handle = efi_locate_handle_ext,
2048 .locate_device_path = efi_locate_device_path,
2049 .install_configuration_table = efi_install_configuration_table_ext,
2050 .load_image = efi_load_image,
2051 .start_image = efi_start_image,
2053 .unload_image = efi_unload_image,
2054 .exit_boot_services = efi_exit_boot_services,
2055 .get_next_monotonic_count = efi_get_next_monotonic_count,
2057 .set_watchdog_timer = efi_set_watchdog_timer,
2058 .connect_controller = efi_connect_controller,
2059 .disconnect_controller = efi_disconnect_controller,
2060 .open_protocol = efi_open_protocol,
2061 .close_protocol = efi_close_protocol,
2062 .open_protocol_information = efi_open_protocol_information,
2063 .protocols_per_handle = efi_protocols_per_handle,
2064 .locate_handle_buffer = efi_locate_handle_buffer,
2065 .locate_protocol = efi_locate_protocol,
2066 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2067 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2068 .calculate_crc32 = efi_calculate_crc32,
2069 .copy_mem = efi_copy_mem,
2070 .set_mem = efi_set_mem,
2074 static uint16_t __efi_runtime_data firmware_vendor[] =
2075 { 'D','a','s',' ','U','-','b','o','o','t',0 };
2077 struct efi_system_table __efi_runtime_data systab = {
2079 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2080 .revision = 0x20005, /* 2.5 */
2081 .headersize = sizeof(struct efi_table_hdr),
2083 .fw_vendor = (long)firmware_vendor,
2084 .con_in = (void*)&efi_con_in,
2085 .con_out = (void*)&efi_con_out,
2086 .std_err = (void*)&efi_con_out,
2087 .runtime = (void*)&efi_runtime_services,
2088 .boottime = (void*)&efi_boot_services,
2090 .tables = (void*)efi_conf_table,