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);
324 static efi_status_t efi_create_handle(void **handle)
326 struct efi_object *obj;
329 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
330 sizeof(struct efi_object),
332 if (r != EFI_SUCCESS)
334 memset(obj, 0, sizeof(struct efi_object));
336 list_add_tail(&obj->link, &efi_obj_list);
342 * Our event capabilities are very limited. Only a small limited
343 * number of events is allowed to coexist.
345 static struct efi_event efi_events[16];
350 * This function is used inside U-Boot code to create an event.
352 * For the API function implementing the CreateEvent service see
353 * efi_create_event_ext.
355 * @type type of the event to create
356 * @notify_tpl task priority level of the event
357 * @notify_function notification function of the event
358 * @notify_context pointer passed to the notification function
359 * @event created event
360 * @return status code
362 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
363 void (EFIAPI *notify_function) (
364 struct efi_event *event,
366 void *notify_context, struct efi_event **event)
371 return EFI_INVALID_PARAMETER;
373 if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
374 return EFI_INVALID_PARAMETER;
376 if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
377 notify_function == NULL)
378 return EFI_INVALID_PARAMETER;
380 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
381 if (efi_events[i].type)
383 efi_events[i].type = type;
384 efi_events[i].notify_tpl = notify_tpl;
385 efi_events[i].notify_function = notify_function;
386 efi_events[i].notify_context = notify_context;
387 /* Disable timers on bootup */
388 efi_events[i].trigger_next = -1ULL;
389 efi_events[i].is_queued = false;
390 efi_events[i].is_signaled = false;
391 *event = &efi_events[i];
394 return EFI_OUT_OF_RESOURCES;
400 * This function implements the CreateEvent service.
401 * See the Unified Extensible Firmware Interface (UEFI) specification
404 * @type type of the event to create
405 * @notify_tpl task priority level of the event
406 * @notify_function notification function of the event
407 * @notify_context pointer passed to the notification function
408 * @event created event
409 * @return status code
411 static efi_status_t EFIAPI efi_create_event_ext(
412 uint32_t type, efi_uintn_t notify_tpl,
413 void (EFIAPI *notify_function) (
414 struct efi_event *event,
416 void *notify_context, struct efi_event **event)
418 EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
420 return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
421 notify_context, event));
426 * Check if a timer event has occurred or a queued notification function should
429 * Our timers have to work without interrupts, so we check whenever keyboard
430 * input or disk accesses happen if enough time elapsed for them to fire.
432 void efi_timer_check(void)
435 u64 now = timer_get_us();
437 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
438 if (!efi_events[i].type)
440 if (efi_events[i].is_queued)
441 efi_signal_event(&efi_events[i]);
442 if (!(efi_events[i].type & EVT_TIMER) ||
443 now < efi_events[i].trigger_next)
445 switch (efi_events[i].trigger_type) {
446 case EFI_TIMER_RELATIVE:
447 efi_events[i].trigger_type = EFI_TIMER_STOP;
449 case EFI_TIMER_PERIODIC:
450 efi_events[i].trigger_next +=
451 efi_events[i].trigger_time;
456 efi_events[i].is_signaled = true;
457 efi_signal_event(&efi_events[i]);
463 * Set the trigger time for a timer event or stop the event.
465 * This is the function for internal usage in U-Boot. For the API function
466 * implementing the SetTimer service see efi_set_timer_ext.
468 * @event event for which the timer is set
469 * @type type of the timer
470 * @trigger_time trigger period in multiples of 100ns
471 * @return status code
473 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
474 uint64_t trigger_time)
479 * The parameter defines a multiple of 100ns.
480 * We use multiples of 1000ns. So divide by 10.
482 do_div(trigger_time, 10);
484 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
485 if (event != &efi_events[i])
488 if (!(event->type & EVT_TIMER))
492 event->trigger_next = -1ULL;
494 case EFI_TIMER_PERIODIC:
495 case EFI_TIMER_RELATIVE:
496 event->trigger_next =
497 timer_get_us() + trigger_time;
500 return EFI_INVALID_PARAMETER;
502 event->trigger_type = type;
503 event->trigger_time = trigger_time;
504 event->is_signaled = false;
507 return EFI_INVALID_PARAMETER;
511 * Set the trigger time for a timer event or stop the event.
513 * This function implements the SetTimer service.
514 * See the Unified Extensible Firmware Interface (UEFI) specification
517 * @event event for which the timer is set
518 * @type type of the timer
519 * @trigger_time trigger period in multiples of 100ns
520 * @return status code
522 static efi_status_t EFIAPI efi_set_timer_ext(struct efi_event *event,
523 enum efi_timer_delay type,
524 uint64_t trigger_time)
526 EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time);
527 return EFI_EXIT(efi_set_timer(event, type, trigger_time));
531 * Wait for events to be signaled.
533 * This function implements the WaitForEvent service.
534 * See the Unified Extensible Firmware Interface (UEFI) specification
537 * @num_events number of events to be waited for
538 * @events events to be waited for
539 * @index index of the event that was signaled
540 * @return status code
542 static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
543 struct efi_event **event,
548 EFI_ENTRY("%zd, %p, %p", num_events, event, index);
550 /* Check parameters */
551 if (!num_events || !event)
552 return EFI_EXIT(EFI_INVALID_PARAMETER);
554 if (efi_tpl != TPL_APPLICATION)
555 return EFI_EXIT(EFI_UNSUPPORTED);
556 for (i = 0; i < num_events; ++i) {
557 for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
558 if (event[i] == &efi_events[j])
561 return EFI_EXIT(EFI_INVALID_PARAMETER);
563 if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
564 return EFI_EXIT(EFI_INVALID_PARAMETER);
565 if (!event[i]->is_signaled)
566 efi_signal_event(event[i]);
569 /* Wait for signal */
571 for (i = 0; i < num_events; ++i) {
572 if (event[i]->is_signaled)
575 /* Allow events to occur. */
581 * Reset the signal which is passed to the caller to allow periodic
584 event[i]->is_signaled = false;
588 return EFI_EXIT(EFI_SUCCESS);
592 * Signal an EFI event.
594 * This function implements the SignalEvent service.
595 * See the Unified Extensible Firmware Interface (UEFI) specification
598 * This functions sets the signaled state of the event and queues the
599 * notification function for execution.
601 * @event event to signal
602 * @return status code
604 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
608 EFI_ENTRY("%p", event);
609 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
610 if (event != &efi_events[i])
612 if (event->is_signaled)
614 event->is_signaled = true;
615 if (event->type & EVT_NOTIFY_SIGNAL)
616 efi_signal_event(event);
619 return EFI_EXIT(EFI_SUCCESS);
623 * Close an EFI event.
625 * This function implements the CloseEvent service.
626 * See the Unified Extensible Firmware Interface (UEFI) specification
629 * @event event to close
630 * @return status code
632 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
636 EFI_ENTRY("%p", event);
637 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
638 if (event == &efi_events[i]) {
640 event->trigger_next = -1ULL;
641 event->is_queued = false;
642 event->is_signaled = false;
643 return EFI_EXIT(EFI_SUCCESS);
646 return EFI_EXIT(EFI_INVALID_PARAMETER);
650 * Check if an event is signaled.
652 * This function implements the CheckEvent service.
653 * See the Unified Extensible Firmware Interface (UEFI) specification
656 * If an event is not signaled yet the notification function is queued.
658 * @event event to check
659 * @return status code
661 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
665 EFI_ENTRY("%p", event);
667 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
668 if (event != &efi_events[i])
670 if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
672 if (!event->is_signaled)
673 efi_signal_event(event);
674 if (event->is_signaled)
675 return EFI_EXIT(EFI_SUCCESS);
676 return EFI_EXIT(EFI_NOT_READY);
678 return EFI_EXIT(EFI_INVALID_PARAMETER);
682 * Find the internal EFI object for a handle.
684 * @handle handle to find
687 static struct efi_object *efi_search_obj(void *handle)
689 struct list_head *lhandle;
691 list_for_each(lhandle, &efi_obj_list) {
692 struct efi_object *efiobj;
694 efiobj = list_entry(lhandle, struct efi_object, link);
695 if (efiobj->handle == handle)
703 * Install protocol interface.
705 * This function implements the InstallProtocolInterface service.
706 * See the Unified Extensible Firmware Interface (UEFI) specification
709 * @handle handle on which the protocol shall be installed
710 * @protocol GUID of the protocol to be installed
711 * @protocol_interface_type type of the interface to be installed,
712 * always EFI_NATIVE_INTERFACE
713 * @protocol_interface interface of the protocol implementation
714 * @return status code
716 static efi_status_t EFIAPI efi_install_protocol_interface(
717 void **handle, const efi_guid_t *protocol,
718 int protocol_interface_type, void *protocol_interface)
720 struct list_head *lhandle;
724 EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
727 if (!handle || !protocol ||
728 protocol_interface_type != EFI_NATIVE_INTERFACE) {
729 r = EFI_INVALID_PARAMETER;
733 /* Create new handle if requested. */
735 r = efi_create_handle(handle);
736 if (r != EFI_SUCCESS)
740 list_for_each(lhandle, &efi_obj_list) {
741 struct efi_object *efiobj;
742 efiobj = list_entry(lhandle, struct efi_object, link);
744 if (efiobj->handle != *handle)
746 /* Check if protocol is already installed on the handle. */
747 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
748 struct efi_handler *handler = &efiobj->protocols[i];
752 if (!guidcmp(handler->guid, protocol)) {
753 r = EFI_INVALID_PARAMETER;
757 /* Install protocol in first empty slot. */
758 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
759 struct efi_handler *handler = &efiobj->protocols[i];
764 handler->guid = protocol;
765 handler->protocol_interface = protocol_interface;
769 r = EFI_OUT_OF_RESOURCES;
772 r = EFI_INVALID_PARAMETER;
778 * Reinstall protocol interface.
780 * This function implements the ReinstallProtocolInterface service.
781 * See the Unified Extensible Firmware Interface (UEFI) specification
784 * @handle handle on which the protocol shall be
786 * @protocol GUID of the protocol to be installed
787 * @old_interface interface to be removed
788 * @new_interface interface to be installed
789 * @return status code
791 static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle,
792 const efi_guid_t *protocol, void *old_interface,
795 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, old_interface,
797 return EFI_EXIT(EFI_ACCESS_DENIED);
801 * Uninstall protocol interface.
803 * This function implements the UninstallProtocolInterface service.
804 * See the Unified Extensible Firmware Interface (UEFI) specification
807 * @handle handle from which the protocol shall be removed
808 * @protocol GUID of the protocol to be removed
809 * @protocol_interface interface to be removed
810 * @return status code
812 static efi_status_t EFIAPI efi_uninstall_protocol_interface(
813 void *handle, const efi_guid_t *protocol,
814 void *protocol_interface)
816 struct list_head *lhandle;
818 efi_status_t r = EFI_NOT_FOUND;
820 EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
822 if (!handle || !protocol) {
823 r = EFI_INVALID_PARAMETER;
827 list_for_each(lhandle, &efi_obj_list) {
828 struct efi_object *efiobj;
829 efiobj = list_entry(lhandle, struct efi_object, link);
831 if (efiobj->handle != handle)
834 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
835 struct efi_handler *handler = &efiobj->protocols[i];
836 const efi_guid_t *hprotocol = handler->guid;
840 if (!guidcmp(hprotocol, protocol)) {
841 if (handler->protocol_interface) {
842 r = EFI_ACCESS_DENIED;
857 * Register an event for notification when a protocol is installed.
859 * This function implements the RegisterProtocolNotify service.
860 * See the Unified Extensible Firmware Interface (UEFI) specification
863 * @protocol GUID of the protocol whose installation shall be
865 * @event event to be signaled upon installation of the protocol
866 * @registration key for retrieving the registration information
867 * @return status code
869 static efi_status_t EFIAPI efi_register_protocol_notify(
870 const efi_guid_t *protocol,
871 struct efi_event *event,
874 EFI_ENTRY("%pUl, %p, %p", protocol, event, registration);
875 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
879 * Determine if an EFI handle implements a protocol.
881 * See the documentation of the LocateHandle service in the UEFI specification.
883 * @search_type selection criterion
884 * @protocol GUID of the protocol
885 * @search_key registration key
887 * @return 0 if the handle implements the protocol
889 static int efi_search(enum efi_locate_search_type search_type,
890 const efi_guid_t *protocol, void *search_key,
891 struct efi_object *efiobj)
895 switch (search_type) {
898 case BY_REGISTER_NOTIFY:
899 /* RegisterProtocolNotify is not implemented yet */
902 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
903 const efi_guid_t *guid = efiobj->protocols[i].guid;
904 if (guid && !guidcmp(guid, protocol))
914 * Locate handles implementing a protocol.
916 * This function is meant for U-Boot internal calls. For the API implementation
917 * of the LocateHandle service see efi_locate_handle_ext.
919 * @search_type selection criterion
920 * @protocol GUID of the protocol
921 * @search_key registration key
922 * @buffer_size size of the buffer to receive the handles in bytes
923 * @buffer buffer to receive the relevant handles
924 * @return status code
926 static efi_status_t efi_locate_handle(
927 enum efi_locate_search_type search_type,
928 const efi_guid_t *protocol, void *search_key,
929 efi_uintn_t *buffer_size, efi_handle_t *buffer)
931 struct efi_object *efiobj;
932 efi_uintn_t size = 0;
934 /* Check parameters */
935 switch (search_type) {
938 case BY_REGISTER_NOTIFY:
940 return EFI_INVALID_PARAMETER;
941 /* RegisterProtocolNotify is not implemented yet */
942 return EFI_UNSUPPORTED;
945 return EFI_INVALID_PARAMETER;
948 return EFI_INVALID_PARAMETER;
952 * efi_locate_handle_buffer uses this function for
953 * the calculation of the necessary buffer size.
954 * So do not require a buffer for buffersize == 0.
956 if (!buffer_size || (*buffer_size && !buffer))
957 return EFI_INVALID_PARAMETER;
959 /* Count how much space we need */
960 list_for_each_entry(efiobj, &efi_obj_list, link) {
961 if (!efi_search(search_type, protocol, search_key, efiobj))
962 size += sizeof(void*);
965 if (*buffer_size < size) {
967 return EFI_BUFFER_TOO_SMALL;
972 return EFI_NOT_FOUND;
974 /* Then fill the array */
975 list_for_each_entry(efiobj, &efi_obj_list, link) {
976 if (!efi_search(search_type, protocol, search_key, efiobj))
977 *buffer++ = efiobj->handle;
984 * Locate handles implementing a protocol.
986 * This function implements the LocateHandle service.
987 * See the Unified Extensible Firmware Interface (UEFI) specification
990 * @search_type selection criterion
991 * @protocol GUID of the protocol
992 * @search_key registration key
993 * @buffer_size size of the buffer to receive the handles in bytes
994 * @buffer buffer to receive the relevant handles
995 * @return 0 if the handle implements the protocol
997 static efi_status_t EFIAPI efi_locate_handle_ext(
998 enum efi_locate_search_type search_type,
999 const efi_guid_t *protocol, void *search_key,
1000 efi_uintn_t *buffer_size, efi_handle_t *buffer)
1002 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1003 buffer_size, buffer);
1005 return EFI_EXIT(efi_locate_handle(search_type, protocol, search_key,
1006 buffer_size, buffer));
1010 * Get the device path and handle of an device implementing a protocol.
1012 * This function implements the LocateDevicePath service.
1013 * See the Unified Extensible Firmware Interface (UEFI) specification
1016 * @protocol GUID of the protocol
1017 * @device_path device path
1018 * @device handle of the device
1019 * @return status code
1021 static efi_status_t EFIAPI efi_locate_device_path(
1022 const efi_guid_t *protocol,
1023 struct efi_device_path **device_path,
1024 efi_handle_t *device)
1026 struct efi_object *efiobj;
1028 EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
1030 efiobj = efi_dp_find_obj(*device_path, device_path);
1032 return EFI_EXIT(EFI_NOT_FOUND);
1034 *device = efiobj->handle;
1036 return EFI_EXIT(EFI_SUCCESS);
1039 /* Collapses configuration table entries, removing index i */
1040 static void efi_remove_configuration_table(int i)
1042 struct efi_configuration_table *this = &efi_conf_table[i];
1043 struct efi_configuration_table *next = &efi_conf_table[i+1];
1044 struct efi_configuration_table *end = &efi_conf_table[systab.nr_tables];
1046 memmove(this, next, (ulong)end - (ulong)next);
1051 * Adds, updates, or removes a configuration table.
1053 * This function is used for internal calls. For the API implementation of the
1054 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1056 * @guid GUID of the installed table
1057 * @table table to be installed
1058 * @return status code
1060 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table)
1064 /* Check for guid override */
1065 for (i = 0; i < systab.nr_tables; i++) {
1066 if (!guidcmp(guid, &efi_conf_table[i].guid)) {
1068 efi_conf_table[i].table = table;
1070 efi_remove_configuration_table(i);
1076 return EFI_NOT_FOUND;
1078 /* No override, check for overflow */
1079 if (i >= ARRAY_SIZE(efi_conf_table))
1080 return EFI_OUT_OF_RESOURCES;
1082 /* Add a new entry */
1083 memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid));
1084 efi_conf_table[i].table = table;
1085 systab.nr_tables = i + 1;
1091 * Adds, updates, or removes a configuration table.
1093 * This function implements the InstallConfigurationTable service.
1094 * See the Unified Extensible Firmware Interface (UEFI) specification
1097 * @guid GUID of the installed table
1098 * @table table to be installed
1099 * @return status code
1101 static efi_status_t EFIAPI efi_install_configuration_table_ext(efi_guid_t *guid,
1104 EFI_ENTRY("%pUl, %p", guid, table);
1105 return EFI_EXIT(efi_install_configuration_table(guid, table));
1109 * Initialize a loaded_image_info + loaded_image_info object with correct
1110 * protocols, boot-device, etc.
1112 * @info loaded image info to be passed to the entry point of the
1114 * @obj internal object associated with the loaded image
1115 * @device_path device path of the loaded image
1116 * @file_path file path of the loaded image
1118 void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *obj,
1119 struct efi_device_path *device_path,
1120 struct efi_device_path *file_path)
1125 * When asking for the device path interface, return
1126 * bootefi_device_path
1128 obj->protocols[0].guid = &efi_guid_device_path;
1129 obj->protocols[0].protocol_interface = device_path;
1132 * When asking for the loaded_image interface, just
1133 * return handle which points to loaded_image_info
1135 obj->protocols[1].guid = &efi_guid_loaded_image;
1136 obj->protocols[1].protocol_interface = info;
1138 obj->protocols[2].guid = &efi_guid_console_control;
1139 obj->protocols[2].protocol_interface = (void *)&efi_console_control;
1141 obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
1142 obj->protocols[3].protocol_interface =
1143 (void *)&efi_device_path_to_text;
1145 info->file_path = file_path;
1147 info->device_handle = efi_dp_find_obj(device_path, NULL);
1149 list_add_tail(&obj->link, &efi_obj_list);
1153 * Load an image using a file path.
1155 * @file_path the path of the image to load
1156 * @buffer buffer containing the loaded image
1157 * @return status code
1159 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
1162 struct efi_file_info *info = NULL;
1163 struct efi_file_handle *f;
1164 static efi_status_t ret;
1167 f = efi_file_from_path(file_path);
1169 return EFI_DEVICE_ERROR;
1172 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1174 if (ret == EFI_BUFFER_TOO_SMALL) {
1176 EFI_CALL(ret = f->getinfo(f, (efi_guid_t *)&efi_file_info_guid,
1179 if (ret != EFI_SUCCESS)
1182 ret = efi_allocate_pool(EFI_LOADER_DATA, info->file_size, buffer);
1186 EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
1190 EFI_CALL(f->close(f));
1192 if (ret != EFI_SUCCESS) {
1193 efi_free_pool(*buffer);
1201 * Load an EFI image into memory.
1203 * This function implements the LoadImage service.
1204 * See the Unified Extensible Firmware Interface (UEFI) specification
1207 * @boot_policy true for request originating from the boot manager
1208 * @parent_image the calles's image handle
1209 * @file_path the path of the image to load
1210 * @source_buffer memory location from which the image is installed
1211 * @source_size size of the memory area from which the image is
1213 * @image_handle handle for the newly installed image
1214 * @return status code
1216 static efi_status_t EFIAPI efi_load_image(bool boot_policy,
1217 efi_handle_t parent_image,
1218 struct efi_device_path *file_path,
1219 void *source_buffer,
1220 unsigned long source_size,
1221 efi_handle_t *image_handle)
1223 struct efi_loaded_image *info;
1224 struct efi_object *obj;
1226 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image,
1227 file_path, source_buffer, source_size, image_handle);
1229 info = calloc(1, sizeof(*info));
1230 obj = calloc(1, sizeof(*obj));
1232 if (!source_buffer) {
1233 struct efi_device_path *dp, *fp;
1236 ret = efi_load_image_from_path(file_path, &source_buffer);
1237 if (ret != EFI_SUCCESS) {
1240 return EFI_EXIT(ret);
1244 * split file_path which contains both the device and
1247 efi_dp_split_file_path(file_path, &dp, &fp);
1249 efi_setup_loaded_image(info, obj, dp, fp);
1251 /* In this case, file_path is the "device" path, ie.
1252 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1254 efi_setup_loaded_image(info, obj, file_path, NULL);
1257 info->reserved = efi_load_pe(source_buffer, info);
1258 if (!info->reserved) {
1261 return EFI_EXIT(EFI_UNSUPPORTED);
1264 info->system_table = &systab;
1265 info->parent_handle = parent_image;
1266 *image_handle = info;
1268 return EFI_EXIT(EFI_SUCCESS);
1272 * Call the entry point of an image.
1274 * This function implements the StartImage service.
1275 * See the Unified Extensible Firmware Interface (UEFI) specification
1278 * @image_handle handle of the image
1279 * @exit_data_size size of the buffer
1280 * @exit_data buffer to receive the exit data of the called image
1281 * @return status code
1283 static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle,
1284 unsigned long *exit_data_size,
1287 ulong (*entry)(void *image_handle, struct efi_system_table *st);
1288 struct efi_loaded_image *info = image_handle;
1290 EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data);
1291 entry = info->reserved;
1293 efi_is_direct_boot = false;
1295 /* call the image! */
1296 if (setjmp(&info->exit_jmp)) {
1297 /* We returned from the child image */
1298 return EFI_EXIT(info->exit_status);
1301 __efi_nesting_dec();
1303 entry(image_handle, &systab);
1304 __efi_entry_check();
1305 __efi_nesting_inc();
1307 /* Should usually never get here */
1308 return EFI_EXIT(EFI_SUCCESS);
1312 * Leave an EFI application or driver.
1314 * This function implements the Exit service.
1315 * See the Unified Extensible Firmware Interface (UEFI) specification
1318 * @image_handle handle of the application or driver that is exiting
1319 * @exit_status status code
1320 * @exit_data_size size of the buffer in bytes
1321 * @exit_data buffer with data describing an error
1322 * @return status code
1324 static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
1325 efi_status_t exit_status, unsigned long exit_data_size,
1328 struct efi_loaded_image *loaded_image_info = (void*)image_handle;
1330 EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
1331 exit_data_size, exit_data);
1333 /* Make sure entry/exit counts for EFI world cross-overs match */
1337 * But longjmp out with the U-Boot gd, not the application's, as
1338 * the other end is a setjmp call inside EFI context.
1342 loaded_image_info->exit_status = exit_status;
1343 longjmp(&loaded_image_info->exit_jmp, 1);
1345 panic("EFI application exited");
1349 * Unload an EFI image.
1351 * This function implements the UnloadImage service.
1352 * See the Unified Extensible Firmware Interface (UEFI) specification
1355 * @image_handle handle of the image to be unloaded
1356 * @return status code
1358 static efi_status_t EFIAPI efi_unload_image(void *image_handle)
1360 struct efi_object *efiobj;
1362 EFI_ENTRY("%p", image_handle);
1363 efiobj = efi_search_obj(image_handle);
1365 list_del(&efiobj->link);
1367 return EFI_EXIT(EFI_SUCCESS);
1371 * Fix up caches for EFI payloads if necessary.
1373 static void efi_exit_caches(void)
1375 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1377 * Grub on 32bit ARM needs to have caches disabled before jumping into
1378 * a zImage, but does not know of all cache layers. Give it a hand.
1380 if (efi_is_direct_boot)
1381 cleanup_before_linux();
1386 * Stop boot services.
1388 * This function implements the ExitBootServices service.
1389 * See the Unified Extensible Firmware Interface (UEFI) specification
1392 * @image_handle handle of the loaded image
1393 * @map_key key of the memory map
1394 * @return status code
1396 static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle,
1397 unsigned long map_key)
1401 EFI_ENTRY("%p, %ld", image_handle, map_key);
1403 /* Notify that ExitBootServices is invoked. */
1404 for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
1405 if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
1407 efi_signal_event(&efi_events[i]);
1409 /* Make sure that notification functions are not called anymore */
1410 efi_tpl = TPL_HIGH_LEVEL;
1412 /* XXX Should persist EFI variables here */
1414 board_quiesce_devices();
1416 /* Fix up caches for EFI payloads if necessary */
1419 /* This stops all lingering devices */
1420 bootm_disable_interrupts();
1422 /* Give the payload some time to boot */
1423 efi_set_watchdog(0);
1426 return EFI_EXIT(EFI_SUCCESS);
1430 * Get next value of the counter.
1432 * This function implements the NextMonotonicCount service.
1433 * See the Unified Extensible Firmware Interface (UEFI) specification
1436 * @count returned value of the counter
1437 * @return status code
1439 static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count)
1441 static uint64_t mono = 0;
1442 EFI_ENTRY("%p", count);
1444 return EFI_EXIT(EFI_SUCCESS);
1450 * This function implements the Stall sercive.
1451 * See the Unified Extensible Firmware Interface (UEFI) specification
1454 * @microseconds period to sleep in microseconds
1455 * @return status code
1457 static efi_status_t EFIAPI efi_stall(unsigned long microseconds)
1459 EFI_ENTRY("%ld", microseconds);
1460 udelay(microseconds);
1461 return EFI_EXIT(EFI_SUCCESS);
1465 * Reset the watchdog timer.
1467 * This function implements the SetWatchdogTimer service.
1468 * See the Unified Extensible Firmware Interface (UEFI) specification
1471 * @timeout seconds before reset by watchdog
1472 * @watchdog_code code to be logged when resetting
1473 * @data_size size of buffer in bytes
1474 * @watchdog_data buffer with data describing the reset reason
1475 * @return status code
1477 static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout,
1478 uint64_t watchdog_code,
1479 unsigned long data_size,
1480 uint16_t *watchdog_data)
1482 EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code,
1483 data_size, watchdog_data);
1484 return EFI_EXIT(efi_set_watchdog(timeout));
1488 * Connect a controller to a driver.
1490 * This function implements the ConnectController service.
1491 * See the Unified Extensible Firmware Interface (UEFI) specification
1494 * @controller_handle handle of the controller
1495 * @driver_image_handle handle of the driver
1496 * @remain_device_path device path of a child controller
1497 * @recursive true to connect all child controllers
1498 * @return status code
1500 static efi_status_t EFIAPI efi_connect_controller(
1501 efi_handle_t controller_handle,
1502 efi_handle_t *driver_image_handle,
1503 struct efi_device_path *remain_device_path,
1506 EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle,
1507 remain_device_path, recursive);
1508 return EFI_EXIT(EFI_NOT_FOUND);
1512 * Disconnect a controller from a driver.
1514 * This function implements the DisconnectController service.
1515 * See the Unified Extensible Firmware Interface (UEFI) specification
1518 * @controller_handle handle of the controller
1519 * @driver_image_handle handle of the driver
1520 * @child_handle handle of the child to destroy
1521 * @return status code
1523 static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle,
1524 void *driver_image_handle,
1527 EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle,
1529 return EFI_EXIT(EFI_INVALID_PARAMETER);
1535 * This function implements the CloseProtocol service.
1536 * See the Unified Extensible Firmware Interface (UEFI) specification
1539 * @handle handle on which the protocol shall be closed
1540 * @protocol GUID of the protocol to close
1541 * @agent_handle handle of the driver
1542 * @controller_handle handle of the controller
1543 * @return status code
1545 static efi_status_t EFIAPI efi_close_protocol(void *handle,
1546 const efi_guid_t *protocol,
1548 void *controller_handle)
1550 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, agent_handle,
1552 return EFI_EXIT(EFI_NOT_FOUND);
1556 * Provide information about then open status of a protocol on a handle
1558 * This function implements the OpenProtocolInformation service.
1559 * See the Unified Extensible Firmware Interface (UEFI) specification
1562 * @handle handle for which the information shall be retrieved
1563 * @protocol GUID of the protocol
1564 * @entry_buffer buffer to receive the open protocol information
1565 * @entry_count number of entries available in the buffer
1566 * @return status code
1568 static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle,
1569 const efi_guid_t *protocol,
1570 struct efi_open_protocol_info_entry **entry_buffer,
1571 efi_uintn_t *entry_count)
1573 EFI_ENTRY("%p, %pUl, %p, %p", handle, protocol, entry_buffer,
1575 return EFI_EXIT(EFI_NOT_FOUND);
1579 * Get protocols installed on a handle.
1581 * This function implements the ProtocolsPerHandleService.
1582 * See the Unified Extensible Firmware Interface (UEFI) specification
1585 * @handle handle for which the information is retrieved
1586 * @protocol_buffer buffer with protocol GUIDs
1587 * @protocol_buffer_count number of entries in the buffer
1588 * @return status code
1590 static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
1591 efi_guid_t ***protocol_buffer,
1592 efi_uintn_t *protocol_buffer_count)
1594 unsigned long buffer_size;
1595 struct efi_object *efiobj;
1597 struct list_head *lhandle;
1600 EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
1601 protocol_buffer_count);
1603 if (!handle || !protocol_buffer || !protocol_buffer_count)
1604 return EFI_EXIT(EFI_INVALID_PARAMETER);
1606 *protocol_buffer = NULL;
1607 *protocol_buffer_count = 0;
1608 list_for_each(lhandle, &efi_obj_list) {
1609 efiobj = list_entry(lhandle, struct efi_object, link);
1611 if (efiobj->handle != handle)
1614 /* Count protocols */
1615 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1616 if (efiobj->protocols[i].guid)
1617 ++*protocol_buffer_count;
1620 if (*protocol_buffer_count) {
1621 buffer_size = sizeof(efi_guid_t *) *
1622 *protocol_buffer_count;
1623 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
1625 (void **)protocol_buffer);
1626 if (r != EFI_SUCCESS)
1629 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
1630 if (efiobj->protocols[i].guid) {
1631 (*protocol_buffer)[j] = (void *)
1632 efiobj->protocols[i].guid;
1640 return EFI_EXIT(EFI_SUCCESS);
1644 * Locate handles implementing a protocol.
1646 * This function implements the LocateHandleBuffer service.
1647 * See the Unified Extensible Firmware Interface (UEFI) specification
1650 * @search_type selection criterion
1651 * @protocol GUID of the protocol
1652 * @search_key registration key
1653 * @no_handles number of returned handles
1654 * @buffer buffer with the returned handles
1655 * @return status code
1657 static efi_status_t EFIAPI efi_locate_handle_buffer(
1658 enum efi_locate_search_type search_type,
1659 const efi_guid_t *protocol, void *search_key,
1660 efi_uintn_t *no_handles, efi_handle_t **buffer)
1663 efi_uintn_t buffer_size = 0;
1665 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type, protocol, search_key,
1666 no_handles, buffer);
1668 if (!no_handles || !buffer) {
1669 r = EFI_INVALID_PARAMETER;
1674 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1676 if (r != EFI_BUFFER_TOO_SMALL)
1678 r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
1680 if (r != EFI_SUCCESS)
1682 r = efi_locate_handle(search_type, protocol, search_key, &buffer_size,
1684 if (r == EFI_SUCCESS)
1685 *no_handles = buffer_size / sizeof(void *);
1691 * Find an interface implementing a protocol.
1693 * This function implements the LocateProtocol service.
1694 * See the Unified Extensible Firmware Interface (UEFI) specification
1697 * @protocol GUID of the protocol
1698 * @registration registration key passed to the notification function
1699 * @protocol_interface interface implementing the protocol
1700 * @return status code
1702 static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
1704 void **protocol_interface)
1706 struct list_head *lhandle;
1709 EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
1711 if (!protocol || !protocol_interface)
1712 return EFI_EXIT(EFI_INVALID_PARAMETER);
1714 EFI_PRINT_GUID("protocol", protocol);
1716 list_for_each(lhandle, &efi_obj_list) {
1717 struct efi_object *efiobj;
1719 efiobj = list_entry(lhandle, struct efi_object, link);
1720 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1721 struct efi_handler *handler = &efiobj->protocols[i];
1725 if (!guidcmp(handler->guid, protocol)) {
1726 *protocol_interface =
1727 handler->protocol_interface;
1728 return EFI_EXIT(EFI_SUCCESS);
1732 *protocol_interface = NULL;
1734 return EFI_EXIT(EFI_NOT_FOUND);
1738 * Install multiple protocol interfaces.
1740 * This function implements the MultipleProtocolInterfaces service.
1741 * See the Unified Extensible Firmware Interface (UEFI) specification
1744 * @handle handle on which the protocol interfaces shall be installed
1745 * @... NULL terminated argument list with pairs of protocol GUIDS and
1747 * @return status code
1749 static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces(
1752 EFI_ENTRY("%p", handle);
1755 const efi_guid_t *protocol;
1756 void *protocol_interface;
1757 efi_status_t r = EFI_SUCCESS;
1761 return EFI_EXIT(EFI_INVALID_PARAMETER);
1763 va_start(argptr, handle);
1765 protocol = va_arg(argptr, efi_guid_t*);
1768 protocol_interface = va_arg(argptr, void*);
1769 r = EFI_CALL(efi_install_protocol_interface(
1771 EFI_NATIVE_INTERFACE,
1772 protocol_interface));
1773 if (r != EFI_SUCCESS)
1778 if (r == EFI_SUCCESS)
1781 /* If an error occured undo all changes. */
1782 va_start(argptr, handle);
1784 protocol = va_arg(argptr, efi_guid_t*);
1785 protocol_interface = va_arg(argptr, void*);
1786 EFI_CALL(efi_uninstall_protocol_interface(handle, protocol,
1787 protocol_interface));
1795 * Uninstall multiple protocol interfaces.
1797 * This function implements the UninstallMultipleProtocolInterfaces service.
1798 * See the Unified Extensible Firmware Interface (UEFI) specification
1801 * @handle handle from which the protocol interfaces shall be removed
1802 * @... NULL terminated argument list with pairs of protocol GUIDS and
1804 * @return status code
1806 static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces(
1809 EFI_ENTRY("%p", handle);
1810 return EFI_EXIT(EFI_INVALID_PARAMETER);
1814 * Calculate cyclic redundancy code.
1816 * This function implements the CalculateCrc32 service.
1817 * See the Unified Extensible Firmware Interface (UEFI) specification
1820 * @data buffer with data
1821 * @data_size size of buffer in bytes
1822 * @crc32_p cyclic redundancy code
1823 * @return status code
1825 static efi_status_t EFIAPI efi_calculate_crc32(void *data,
1826 unsigned long data_size,
1829 EFI_ENTRY("%p, %ld", data, data_size);
1830 *crc32_p = crc32(0, data, data_size);
1831 return EFI_EXIT(EFI_SUCCESS);
1837 * This function implements the CopyMem service.
1838 * See the Unified Extensible Firmware Interface (UEFI) specification
1841 * @destination destination of the copy operation
1842 * @source source of the copy operation
1843 * @length number of bytes to copy
1845 static void EFIAPI efi_copy_mem(void *destination, const void *source,
1848 EFI_ENTRY("%p, %p, %ld", destination, source, (unsigned long)length);
1849 memcpy(destination, source, length);
1850 EFI_EXIT(EFI_SUCCESS);
1854 * Fill memory with a byte value.
1856 * This function implements the SetMem service.
1857 * See the Unified Extensible Firmware Interface (UEFI) specification
1860 * @buffer buffer to fill
1861 * @size size of buffer in bytes
1862 * @value byte to copy to the buffer
1864 static void EFIAPI efi_set_mem(void *buffer, size_t size, uint8_t value)
1866 EFI_ENTRY("%p, %ld, 0x%x", buffer, (unsigned long)size, value);
1867 memset(buffer, value, size);
1868 EFI_EXIT(EFI_SUCCESS);
1872 * Open protocol interface on a handle.
1874 * This function implements the OpenProtocol interface.
1875 * See the Unified Extensible Firmware Interface (UEFI) specification
1878 * @handle handle on which the protocol shall be opened
1879 * @protocol GUID of the protocol
1880 * @protocol_interface interface implementing the protocol
1881 * @agent_handle handle of the driver
1882 * @controller_handle handle of the controller
1883 * @attributes attributes indicating how to open the protocol
1884 * @return status code
1886 static efi_status_t EFIAPI efi_open_protocol(
1887 void *handle, const efi_guid_t *protocol,
1888 void **protocol_interface, void *agent_handle,
1889 void *controller_handle, uint32_t attributes)
1891 struct list_head *lhandle;
1893 efi_status_t r = EFI_INVALID_PARAMETER;
1895 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
1896 protocol_interface, agent_handle, controller_handle,
1899 if (!handle || !protocol ||
1900 (!protocol_interface && attributes !=
1901 EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {
1905 EFI_PRINT_GUID("protocol", protocol);
1907 switch (attributes) {
1908 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
1909 case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
1910 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:
1912 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER:
1913 if (controller_handle == handle)
1915 case EFI_OPEN_PROTOCOL_BY_DRIVER:
1916 case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE:
1917 if (controller_handle == NULL)
1919 case EFI_OPEN_PROTOCOL_EXCLUSIVE:
1920 if (agent_handle == NULL)
1927 list_for_each(lhandle, &efi_obj_list) {
1928 struct efi_object *efiobj;
1929 efiobj = list_entry(lhandle, struct efi_object, link);
1931 if (efiobj->handle != handle)
1934 for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
1935 struct efi_handler *handler = &efiobj->protocols[i];
1936 const efi_guid_t *hprotocol = handler->guid;
1939 if (!guidcmp(hprotocol, protocol)) {
1941 EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
1942 *protocol_interface =
1943 handler->protocol_interface;
1953 r = EFI_UNSUPPORTED;
1959 * Get interface of a protocol on a handle.
1961 * This function implements the HandleProtocol service.
1962 * See the Unified Extensible Firmware Interface (UEFI) specification
1965 * @handle handle on which the protocol shall be opened
1966 * @protocol GUID of the protocol
1967 * @protocol_interface interface implementing the protocol
1968 * @return status code
1970 static efi_status_t EFIAPI efi_handle_protocol(void *handle,
1971 const efi_guid_t *protocol,
1972 void **protocol_interface)
1974 return efi_open_protocol(handle, protocol, protocol_interface, NULL,
1975 NULL, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL);
1978 static const struct efi_boot_services efi_boot_services = {
1980 .headersize = sizeof(struct efi_table_hdr),
1982 .raise_tpl = efi_raise_tpl,
1983 .restore_tpl = efi_restore_tpl,
1984 .allocate_pages = efi_allocate_pages_ext,
1985 .free_pages = efi_free_pages_ext,
1986 .get_memory_map = efi_get_memory_map_ext,
1987 .allocate_pool = efi_allocate_pool_ext,
1988 .free_pool = efi_free_pool_ext,
1989 .create_event = efi_create_event_ext,
1990 .set_timer = efi_set_timer_ext,
1991 .wait_for_event = efi_wait_for_event,
1992 .signal_event = efi_signal_event_ext,
1993 .close_event = efi_close_event,
1994 .check_event = efi_check_event,
1995 .install_protocol_interface = efi_install_protocol_interface,
1996 .reinstall_protocol_interface = efi_reinstall_protocol_interface,
1997 .uninstall_protocol_interface = efi_uninstall_protocol_interface,
1998 .handle_protocol = efi_handle_protocol,
2000 .register_protocol_notify = efi_register_protocol_notify,
2001 .locate_handle = efi_locate_handle_ext,
2002 .locate_device_path = efi_locate_device_path,
2003 .install_configuration_table = efi_install_configuration_table_ext,
2004 .load_image = efi_load_image,
2005 .start_image = efi_start_image,
2007 .unload_image = efi_unload_image,
2008 .exit_boot_services = efi_exit_boot_services,
2009 .get_next_monotonic_count = efi_get_next_monotonic_count,
2011 .set_watchdog_timer = efi_set_watchdog_timer,
2012 .connect_controller = efi_connect_controller,
2013 .disconnect_controller = efi_disconnect_controller,
2014 .open_protocol = efi_open_protocol,
2015 .close_protocol = efi_close_protocol,
2016 .open_protocol_information = efi_open_protocol_information,
2017 .protocols_per_handle = efi_protocols_per_handle,
2018 .locate_handle_buffer = efi_locate_handle_buffer,
2019 .locate_protocol = efi_locate_protocol,
2020 .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces,
2021 .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces,
2022 .calculate_crc32 = efi_calculate_crc32,
2023 .copy_mem = efi_copy_mem,
2024 .set_mem = efi_set_mem,
2028 static uint16_t __efi_runtime_data firmware_vendor[] =
2029 { 'D','a','s',' ','U','-','b','o','o','t',0 };
2031 struct efi_system_table __efi_runtime_data systab = {
2033 .signature = EFI_SYSTEM_TABLE_SIGNATURE,
2034 .revision = 0x20005, /* 2.5 */
2035 .headersize = sizeof(struct efi_table_hdr),
2037 .fw_vendor = (long)firmware_vendor,
2038 .con_in = (void*)&efi_con_in,
2039 .con_out = (void*)&efi_con_out,
2040 .std_err = (void*)&efi_con_out,
2041 .runtime = (void*)&efi_runtime_services,
2042 .boottime = (void*)&efi_boot_services,
2044 .tables = (void*)efi_conf_table,