2 * EFI application boot time services
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
11 #include <efi_loader.h>
12 #include <environment.h>
14 #include <asm/global_data.h>
15 #include <libfdt_env.h>
16 #include <u-boot/crc.h>
21 DECLARE_GLOBAL_DATA_PTR
;
23 /* Task priority level */
24 static efi_uintn_t efi_tpl
= TPL_APPLICATION
;
26 /* This list contains all the EFI objects our payload has access to */
27 LIST_HEAD(efi_obj_list
);
30 * If we're running on nasty systems (32bit ARM booting into non-EFI Linux)
31 * we need to do trickery with caches. Since we don't want to break the EFI
32 * aware boot path, only apply hacks when loading exiting directly (breaking
33 * direct Linux EFI booting along the way - oh well).
35 static bool efi_is_direct_boot
= true;
38 * EFI can pass arbitrary additional "tables" containing vendor specific
39 * information to the payload. One such table is the FDT table which contains
40 * a pointer to a flattened device tree blob.
42 * In most cases we want to pass an FDT to the payload, so reserve one slot of
43 * config table space for it. The pointer gets populated by do_bootefi_exec().
45 static struct efi_configuration_table __efi_runtime_data efi_conf_table
[2];
49 * The "gd" pointer lives in a register on ARM and AArch64 that we declare
50 * fixed when compiling U-Boot. However, the payload does not know about that
51 * restriction so we need to manually swap its and our view of that register on
52 * EFI callback entry/exit.
54 static volatile void *efi_gd
, *app_gd
;
57 static int entry_count
;
58 static int nesting_level
;
60 /* Called on every callback entry */
61 int __efi_entry_check(void)
63 int ret
= entry_count
++ == 0;
72 /* Called on every callback exit */
73 int __efi_exit_check(void)
75 int ret
= --entry_count
== 0;
82 /* Called from do_bootefi_exec() */
83 void efi_save_gd(void)
91 * Special case handler for error/abort that just forces things back
92 * to u-boot world so we can dump out an abort msg, without any care
93 * about returning back to UEFI world.
95 void efi_restore_gd(void)
98 /* Only restore if we're already in EFI context */
106 * Two spaces per indent level, maxing out at 10.. which ought to be
107 * enough for anyone ;-)
109 static const char *indent_string(int level
)
111 const char *indent
= " ";
112 const int max
= strlen(indent
);
113 level
= min(max
, level
* 2);
114 return &indent
[max
- level
];
117 const char *__efi_nesting(void)
119 return indent_string(nesting_level
);
122 const char *__efi_nesting_inc(void)
124 return indent_string(nesting_level
++);
127 const char *__efi_nesting_dec(void)
129 return indent_string(--nesting_level
);
133 * Queue an EFI event.
135 * This function queues the notification function of the event for future
138 * The notification function is called if the task priority level of the
139 * event is higher than the current task priority level.
141 * For the SignalEvent service see efi_signal_event_ext.
143 * @event event to signal
145 void efi_signal_event(struct efi_event
*event
)
147 if (event
->notify_function
) {
148 event
->is_queued
= true;
150 if (efi_tpl
>= event
->notify_tpl
)
152 EFI_CALL_VOID(event
->notify_function(event
,
153 event
->notify_context
));
155 event
->is_queued
= false;
159 * Raise the task priority level.
161 * This function implements the RaiseTpl service.
162 * See the Unified Extensible Firmware Interface (UEFI) specification
165 * @new_tpl new value of the task priority level
166 * @return old value of the task priority level
168 static unsigned long EFIAPI
efi_raise_tpl(efi_uintn_t new_tpl
)
170 efi_uintn_t old_tpl
= efi_tpl
;
172 EFI_ENTRY("0x%zx", new_tpl
);
174 if (new_tpl
< efi_tpl
)
175 debug("WARNING: new_tpl < current_tpl in %s\n", __func__
);
177 if (efi_tpl
> TPL_HIGH_LEVEL
)
178 efi_tpl
= TPL_HIGH_LEVEL
;
180 EFI_EXIT(EFI_SUCCESS
);
185 * Lower the task priority level.
187 * This function implements the RestoreTpl service.
188 * See the Unified Extensible Firmware Interface (UEFI) specification
191 * @old_tpl value of the task priority level to be restored
193 static void EFIAPI
efi_restore_tpl(efi_uintn_t old_tpl
)
195 EFI_ENTRY("0x%zx", old_tpl
);
197 if (old_tpl
> efi_tpl
)
198 debug("WARNING: old_tpl > current_tpl in %s\n", __func__
);
200 if (efi_tpl
> TPL_HIGH_LEVEL
)
201 efi_tpl
= TPL_HIGH_LEVEL
;
203 EFI_EXIT(EFI_SUCCESS
);
207 * Allocate memory pages.
209 * This function implements the AllocatePages service.
210 * See the Unified Extensible Firmware Interface (UEFI) specification
213 * @type type of allocation to be performed
214 * @memory_type usage type of the allocated memory
215 * @pages number of pages to be allocated
216 * @memory allocated memory
217 * @return status code
219 static efi_status_t EFIAPI
efi_allocate_pages_ext(int type
, int memory_type
,
225 EFI_ENTRY("%d, %d, 0x%zx, %p", type
, memory_type
, pages
, memory
);
226 r
= efi_allocate_pages(type
, memory_type
, pages
, memory
);
233 * This function implements the FreePages service.
234 * See the Unified Extensible Firmware Interface (UEFI) specification
237 * @memory start of the memory area to be freed
238 * @pages number of pages to be freed
239 * @return status code
241 static efi_status_t EFIAPI
efi_free_pages_ext(uint64_t memory
,
246 EFI_ENTRY("%"PRIx64
", 0x%zx", memory
, pages
);
247 r
= efi_free_pages(memory
, pages
);
252 * Get map describing memory usage.
254 * This function implements the GetMemoryMap service.
255 * See the Unified Extensible Firmware Interface (UEFI) specification
258 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
259 * on exit the size of the copied memory map
260 * @memory_map buffer to which the memory map is written
261 * @map_key key for the memory map
262 * @descriptor_size size of an individual memory descriptor
263 * @descriptor_version version number of the memory descriptor structure
264 * @return status code
266 static efi_status_t EFIAPI
efi_get_memory_map_ext(
267 efi_uintn_t
*memory_map_size
,
268 struct efi_mem_desc
*memory_map
,
269 efi_uintn_t
*map_key
,
270 efi_uintn_t
*descriptor_size
,
271 uint32_t *descriptor_version
)
275 EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size
, memory_map
,
276 map_key
, descriptor_size
, descriptor_version
);
277 r
= efi_get_memory_map(memory_map_size
, memory_map
, map_key
,
278 descriptor_size
, descriptor_version
);
283 * Allocate memory from pool.
285 * This function implements the AllocatePool service.
286 * See the Unified Extensible Firmware Interface (UEFI) specification
289 * @pool_type type of the pool from which memory is to be allocated
290 * @size number of bytes to be allocated
291 * @buffer allocated memory
292 * @return status code
294 static efi_status_t EFIAPI
efi_allocate_pool_ext(int pool_type
,
300 EFI_ENTRY("%d, %zd, %p", pool_type
, size
, buffer
);
301 r
= efi_allocate_pool(pool_type
, size
, buffer
);
306 * Free memory from pool.
308 * This function implements the FreePool service.
309 * See the Unified Extensible Firmware Interface (UEFI) specification
312 * @buffer start of memory to be freed
313 * @return status code
315 static efi_status_t EFIAPI
efi_free_pool_ext(void *buffer
)
319 EFI_ENTRY("%p", buffer
);
320 r
= efi_free_pool(buffer
);
328 * @return status code
330 efi_status_t
efi_create_handle(void **handle
)
332 struct efi_object
*obj
;
335 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
,
336 sizeof(struct efi_object
),
338 if (r
!= EFI_SUCCESS
)
340 memset(obj
, 0, sizeof(struct efi_object
));
342 list_add_tail(&obj
->link
, &efi_obj_list
);
348 * Our event capabilities are very limited. Only a small limited
349 * number of events is allowed to coexist.
351 static struct efi_event efi_events
[16];
356 * This function is used inside U-Boot code to create an event.
358 * For the API function implementing the CreateEvent service see
359 * efi_create_event_ext.
361 * @type type of the event to create
362 * @notify_tpl task priority level of the event
363 * @notify_function notification function of the event
364 * @notify_context pointer passed to the notification function
365 * @event created event
366 * @return status code
368 efi_status_t
efi_create_event(uint32_t type
, efi_uintn_t notify_tpl
,
369 void (EFIAPI
*notify_function
) (
370 struct efi_event
*event
,
372 void *notify_context
, struct efi_event
**event
)
377 return EFI_INVALID_PARAMETER
;
379 if ((type
& EVT_NOTIFY_SIGNAL
) && (type
& EVT_NOTIFY_WAIT
))
380 return EFI_INVALID_PARAMETER
;
382 if ((type
& (EVT_NOTIFY_SIGNAL
|EVT_NOTIFY_WAIT
)) &&
383 notify_function
== NULL
)
384 return EFI_INVALID_PARAMETER
;
386 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
387 if (efi_events
[i
].type
)
389 efi_events
[i
].type
= type
;
390 efi_events
[i
].notify_tpl
= notify_tpl
;
391 efi_events
[i
].notify_function
= notify_function
;
392 efi_events
[i
].notify_context
= notify_context
;
393 /* Disable timers on bootup */
394 efi_events
[i
].trigger_next
= -1ULL;
395 efi_events
[i
].is_queued
= false;
396 efi_events
[i
].is_signaled
= false;
397 *event
= &efi_events
[i
];
400 return EFI_OUT_OF_RESOURCES
;
406 * This function implements the CreateEvent service.
407 * See the Unified Extensible Firmware Interface (UEFI) specification
410 * @type type of the event to create
411 * @notify_tpl task priority level of the event
412 * @notify_function notification function of the event
413 * @notify_context pointer passed to the notification function
414 * @event created event
415 * @return status code
417 static efi_status_t EFIAPI
efi_create_event_ext(
418 uint32_t type
, efi_uintn_t notify_tpl
,
419 void (EFIAPI
*notify_function
) (
420 struct efi_event
*event
,
422 void *notify_context
, struct efi_event
**event
)
424 EFI_ENTRY("%d, 0x%zx, %p, %p", type
, notify_tpl
, notify_function
,
426 return EFI_EXIT(efi_create_event(type
, notify_tpl
, notify_function
,
427 notify_context
, event
));
432 * Check if a timer event has occurred or a queued notification function should
435 * Our timers have to work without interrupts, so we check whenever keyboard
436 * input or disk accesses happen if enough time elapsed for them to fire.
438 void efi_timer_check(void)
441 u64 now
= timer_get_us();
443 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
444 if (!efi_events
[i
].type
)
446 if (efi_events
[i
].is_queued
)
447 efi_signal_event(&efi_events
[i
]);
448 if (!(efi_events
[i
].type
& EVT_TIMER
) ||
449 now
< efi_events
[i
].trigger_next
)
451 switch (efi_events
[i
].trigger_type
) {
452 case EFI_TIMER_RELATIVE
:
453 efi_events
[i
].trigger_type
= EFI_TIMER_STOP
;
455 case EFI_TIMER_PERIODIC
:
456 efi_events
[i
].trigger_next
+=
457 efi_events
[i
].trigger_time
;
462 efi_events
[i
].is_signaled
= true;
463 efi_signal_event(&efi_events
[i
]);
469 * Set the trigger time for a timer event or stop the event.
471 * This is the function for internal usage in U-Boot. For the API function
472 * implementing the SetTimer service see efi_set_timer_ext.
474 * @event event for which the timer is set
475 * @type type of the timer
476 * @trigger_time trigger period in multiples of 100ns
477 * @return status code
479 efi_status_t
efi_set_timer(struct efi_event
*event
, enum efi_timer_delay type
,
480 uint64_t trigger_time
)
485 * The parameter defines a multiple of 100ns.
486 * We use multiples of 1000ns. So divide by 10.
488 do_div(trigger_time
, 10);
490 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
491 if (event
!= &efi_events
[i
])
494 if (!(event
->type
& EVT_TIMER
))
498 event
->trigger_next
= -1ULL;
500 case EFI_TIMER_PERIODIC
:
501 case EFI_TIMER_RELATIVE
:
502 event
->trigger_next
=
503 timer_get_us() + trigger_time
;
506 return EFI_INVALID_PARAMETER
;
508 event
->trigger_type
= type
;
509 event
->trigger_time
= trigger_time
;
510 event
->is_signaled
= false;
513 return EFI_INVALID_PARAMETER
;
517 * Set the trigger time for a timer event or stop the event.
519 * This function implements the SetTimer service.
520 * See the Unified Extensible Firmware Interface (UEFI) specification
523 * @event event for which the timer is set
524 * @type type of the timer
525 * @trigger_time trigger period in multiples of 100ns
526 * @return status code
528 static efi_status_t EFIAPI
efi_set_timer_ext(struct efi_event
*event
,
529 enum efi_timer_delay type
,
530 uint64_t trigger_time
)
532 EFI_ENTRY("%p, %d, %"PRIx64
, event
, type
, trigger_time
);
533 return EFI_EXIT(efi_set_timer(event
, type
, trigger_time
));
537 * Wait for events to be signaled.
539 * This function implements the WaitForEvent service.
540 * See the Unified Extensible Firmware Interface (UEFI) specification
543 * @num_events number of events to be waited for
544 * @events events to be waited for
545 * @index index of the event that was signaled
546 * @return status code
548 static efi_status_t EFIAPI
efi_wait_for_event(efi_uintn_t num_events
,
549 struct efi_event
**event
,
554 EFI_ENTRY("%zd, %p, %p", num_events
, event
, index
);
556 /* Check parameters */
557 if (!num_events
|| !event
)
558 return EFI_EXIT(EFI_INVALID_PARAMETER
);
560 if (efi_tpl
!= TPL_APPLICATION
)
561 return EFI_EXIT(EFI_UNSUPPORTED
);
562 for (i
= 0; i
< num_events
; ++i
) {
563 for (j
= 0; j
< ARRAY_SIZE(efi_events
); ++j
) {
564 if (event
[i
] == &efi_events
[j
])
567 return EFI_EXIT(EFI_INVALID_PARAMETER
);
569 if (!event
[i
]->type
|| event
[i
]->type
& EVT_NOTIFY_SIGNAL
)
570 return EFI_EXIT(EFI_INVALID_PARAMETER
);
571 if (!event
[i
]->is_signaled
)
572 efi_signal_event(event
[i
]);
575 /* Wait for signal */
577 for (i
= 0; i
< num_events
; ++i
) {
578 if (event
[i
]->is_signaled
)
581 /* Allow events to occur. */
587 * Reset the signal which is passed to the caller to allow periodic
590 event
[i
]->is_signaled
= false;
594 return EFI_EXIT(EFI_SUCCESS
);
598 * Signal an EFI event.
600 * This function implements the SignalEvent service.
601 * See the Unified Extensible Firmware Interface (UEFI) specification
604 * This functions sets the signaled state of the event and queues the
605 * notification function for execution.
607 * @event event to signal
608 * @return status code
610 static efi_status_t EFIAPI
efi_signal_event_ext(struct efi_event
*event
)
614 EFI_ENTRY("%p", event
);
615 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
616 if (event
!= &efi_events
[i
])
618 if (event
->is_signaled
)
620 event
->is_signaled
= true;
621 if (event
->type
& EVT_NOTIFY_SIGNAL
)
622 efi_signal_event(event
);
625 return EFI_EXIT(EFI_SUCCESS
);
629 * Close an EFI event.
631 * This function implements the CloseEvent service.
632 * See the Unified Extensible Firmware Interface (UEFI) specification
635 * @event event to close
636 * @return status code
638 static efi_status_t EFIAPI
efi_close_event(struct efi_event
*event
)
642 EFI_ENTRY("%p", event
);
643 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
644 if (event
== &efi_events
[i
]) {
646 event
->trigger_next
= -1ULL;
647 event
->is_queued
= false;
648 event
->is_signaled
= false;
649 return EFI_EXIT(EFI_SUCCESS
);
652 return EFI_EXIT(EFI_INVALID_PARAMETER
);
656 * Check if an event is signaled.
658 * This function implements the CheckEvent service.
659 * See the Unified Extensible Firmware Interface (UEFI) specification
662 * If an event is not signaled yet the notification function is queued.
664 * @event event to check
665 * @return status code
667 static efi_status_t EFIAPI
efi_check_event(struct efi_event
*event
)
671 EFI_ENTRY("%p", event
);
673 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
674 if (event
!= &efi_events
[i
])
676 if (!event
->type
|| event
->type
& EVT_NOTIFY_SIGNAL
)
678 if (!event
->is_signaled
)
679 efi_signal_event(event
);
680 if (event
->is_signaled
)
681 return EFI_EXIT(EFI_SUCCESS
);
682 return EFI_EXIT(EFI_NOT_READY
);
684 return EFI_EXIT(EFI_INVALID_PARAMETER
);
688 * Find the internal EFI object for a handle.
690 * @handle handle to find
693 struct efi_object
*efi_search_obj(const void *handle
)
695 struct efi_object
*efiobj
;
697 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
698 if (efiobj
->handle
== handle
)
706 * Find a protocol on a handle.
709 * @protocol_guid GUID of the protocol
710 * @handler reference to the protocol
711 * @return status code
713 efi_status_t
efi_search_protocol(const void *handle
,
714 const efi_guid_t
*protocol_guid
,
715 struct efi_handler
**handler
)
717 struct efi_object
*efiobj
;
719 struct efi_handler
*protocol
;
721 if (!handle
|| !protocol_guid
)
722 return EFI_INVALID_PARAMETER
;
723 efiobj
= efi_search_obj(handle
);
725 return EFI_INVALID_PARAMETER
;
726 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
727 protocol
= &efiobj
->protocols
[i
];
730 if (!guidcmp(protocol
->guid
, protocol_guid
)) {
736 return EFI_NOT_FOUND
;
740 * Install new protocol on a handle.
742 * @handle handle on which the protocol shall be installed
743 * @protocol GUID of the protocol to be installed
744 * @protocol_interface interface of the protocol implementation
745 * @return status code
747 efi_status_t
efi_add_protocol(const void *handle
, const efi_guid_t
*protocol
,
748 void *protocol_interface
)
750 struct efi_object
*efiobj
;
751 struct efi_handler
*handler
;
755 efiobj
= efi_search_obj(handle
);
757 return EFI_INVALID_PARAMETER
;
758 ret
= efi_search_protocol(handle
, protocol
, NULL
);
759 if (ret
!= EFI_NOT_FOUND
)
760 return EFI_INVALID_PARAMETER
;
761 handler
= calloc(1, sizeof(struct efi_handler
));
763 return EFI_OUT_OF_RESOURCES
;
764 /* Install protocol in first empty slot. */
765 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
766 handler
= &efiobj
->protocols
[i
];
769 handler
->guid
= protocol
;
770 handler
->protocol_interface
= protocol_interface
;
773 return EFI_OUT_OF_RESOURCES
;
777 * Delete protocol from a handle.
779 * @handle handle from which the protocol shall be deleted
780 * @protocol GUID of the protocol to be deleted
781 * @protocol_interface interface of the protocol implementation
782 * @return status code
784 efi_status_t
efi_remove_protocol(const void *handle
, const efi_guid_t
*protocol
,
785 void *protocol_interface
)
787 struct efi_handler
*handler
;
790 ret
= efi_search_protocol(handle
, protocol
, &handler
);
791 if (ret
!= EFI_SUCCESS
)
793 if (handler
->protocol_interface
!= protocol_interface
)
794 return EFI_NOT_FOUND
;
795 handler
->guid
= NULL
;
796 handler
->protocol_interface
= NULL
;
801 * Delete all protocols from a handle.
803 * @handle handle from which the protocols shall be deleted
804 * @return status code
806 efi_status_t
efi_remove_all_protocols(const void *handle
)
808 struct efi_object
*efiobj
;
809 struct efi_handler
*handler
;
812 efiobj
= efi_search_obj(handle
);
814 return EFI_INVALID_PARAMETER
;
816 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
817 handler
= &efiobj
->protocols
[i
];
818 handler
->guid
= NULL
;
819 handler
->protocol_interface
= NULL
;
825 * Install protocol interface.
827 * This function implements the InstallProtocolInterface service.
828 * See the Unified Extensible Firmware Interface (UEFI) specification
831 * @handle handle on which the protocol shall be installed
832 * @protocol GUID of the protocol to be installed
833 * @protocol_interface_type type of the interface to be installed,
834 * always EFI_NATIVE_INTERFACE
835 * @protocol_interface interface of the protocol implementation
836 * @return status code
838 static efi_status_t EFIAPI
efi_install_protocol_interface(
839 void **handle
, const efi_guid_t
*protocol
,
840 int protocol_interface_type
, void *protocol_interface
)
844 EFI_ENTRY("%p, %pUl, %d, %p", handle
, protocol
, protocol_interface_type
,
847 if (!handle
|| !protocol
||
848 protocol_interface_type
!= EFI_NATIVE_INTERFACE
) {
849 r
= EFI_INVALID_PARAMETER
;
853 /* Create new handle if requested. */
855 r
= efi_create_handle(handle
);
856 if (r
!= EFI_SUCCESS
)
858 debug("%sEFI: new handle %p\n", indent_string(nesting_level
),
861 debug("%sEFI: handle %p\n", indent_string(nesting_level
),
864 /* Add new protocol */
865 r
= efi_add_protocol(*handle
, protocol
, protocol_interface
);
871 * Reinstall protocol interface.
873 * This function implements the ReinstallProtocolInterface service.
874 * See the Unified Extensible Firmware Interface (UEFI) specification
877 * @handle handle on which the protocol shall be
879 * @protocol GUID of the protocol to be installed
880 * @old_interface interface to be removed
881 * @new_interface interface to be installed
882 * @return status code
884 static efi_status_t EFIAPI
efi_reinstall_protocol_interface(void *handle
,
885 const efi_guid_t
*protocol
, void *old_interface
,
888 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, old_interface
,
890 return EFI_EXIT(EFI_ACCESS_DENIED
);
894 * Uninstall protocol interface.
896 * This function implements the UninstallProtocolInterface service.
897 * See the Unified Extensible Firmware Interface (UEFI) specification
900 * @handle handle from which the protocol shall be removed
901 * @protocol GUID of the protocol to be removed
902 * @protocol_interface interface to be removed
903 * @return status code
905 static efi_status_t EFIAPI
efi_uninstall_protocol_interface(
906 void *handle
, const efi_guid_t
*protocol
,
907 void *protocol_interface
)
909 struct list_head
*lhandle
;
911 efi_status_t r
= EFI_NOT_FOUND
;
913 EFI_ENTRY("%p, %pUl, %p", handle
, protocol
, protocol_interface
);
915 if (!handle
|| !protocol
) {
916 r
= EFI_INVALID_PARAMETER
;
920 list_for_each(lhandle
, &efi_obj_list
) {
921 struct efi_object
*efiobj
;
922 efiobj
= list_entry(lhandle
, struct efi_object
, link
);
924 if (efiobj
->handle
!= handle
)
927 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
928 struct efi_handler
*handler
= &efiobj
->protocols
[i
];
929 const efi_guid_t
*hprotocol
= handler
->guid
;
933 if (!guidcmp(hprotocol
, protocol
)) {
934 if (handler
->protocol_interface
) {
935 r
= EFI_ACCESS_DENIED
;
950 * Register an event for notification when a protocol is installed.
952 * This function implements the RegisterProtocolNotify service.
953 * See the Unified Extensible Firmware Interface (UEFI) specification
956 * @protocol GUID of the protocol whose installation shall be
958 * @event event to be signaled upon installation of the protocol
959 * @registration key for retrieving the registration information
960 * @return status code
962 static efi_status_t EFIAPI
efi_register_protocol_notify(
963 const efi_guid_t
*protocol
,
964 struct efi_event
*event
,
967 EFI_ENTRY("%pUl, %p, %p", protocol
, event
, registration
);
968 return EFI_EXIT(EFI_OUT_OF_RESOURCES
);
972 * Determine if an EFI handle implements a protocol.
974 * See the documentation of the LocateHandle service in the UEFI specification.
976 * @search_type selection criterion
977 * @protocol GUID of the protocol
978 * @search_key registration key
980 * @return 0 if the handle implements the protocol
982 static int efi_search(enum efi_locate_search_type search_type
,
983 const efi_guid_t
*protocol
, void *search_key
,
984 struct efi_object
*efiobj
)
988 switch (search_type
) {
991 case BY_REGISTER_NOTIFY
:
992 /* RegisterProtocolNotify is not implemented yet */
995 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
996 const efi_guid_t
*guid
= efiobj
->protocols
[i
].guid
;
997 if (guid
&& !guidcmp(guid
, protocol
))
1007 * Locate handles implementing a protocol.
1009 * This function is meant for U-Boot internal calls. For the API implementation
1010 * of the LocateHandle service see efi_locate_handle_ext.
1012 * @search_type selection criterion
1013 * @protocol GUID of the protocol
1014 * @search_key registration key
1015 * @buffer_size size of the buffer to receive the handles in bytes
1016 * @buffer buffer to receive the relevant handles
1017 * @return status code
1019 static efi_status_t
efi_locate_handle(
1020 enum efi_locate_search_type search_type
,
1021 const efi_guid_t
*protocol
, void *search_key
,
1022 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1024 struct efi_object
*efiobj
;
1025 efi_uintn_t size
= 0;
1027 /* Check parameters */
1028 switch (search_type
) {
1031 case BY_REGISTER_NOTIFY
:
1033 return EFI_INVALID_PARAMETER
;
1034 /* RegisterProtocolNotify is not implemented yet */
1035 return EFI_UNSUPPORTED
;
1038 return EFI_INVALID_PARAMETER
;
1041 return EFI_INVALID_PARAMETER
;
1045 * efi_locate_handle_buffer uses this function for
1046 * the calculation of the necessary buffer size.
1047 * So do not require a buffer for buffersize == 0.
1049 if (!buffer_size
|| (*buffer_size
&& !buffer
))
1050 return EFI_INVALID_PARAMETER
;
1052 /* Count how much space we need */
1053 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1054 if (!efi_search(search_type
, protocol
, search_key
, efiobj
))
1055 size
+= sizeof(void*);
1058 if (*buffer_size
< size
) {
1059 *buffer_size
= size
;
1060 return EFI_BUFFER_TOO_SMALL
;
1063 *buffer_size
= size
;
1065 return EFI_NOT_FOUND
;
1067 /* Then fill the array */
1068 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
1069 if (!efi_search(search_type
, protocol
, search_key
, efiobj
))
1070 *buffer
++ = efiobj
->handle
;
1077 * Locate handles implementing a protocol.
1079 * This function implements the LocateHandle service.
1080 * See the Unified Extensible Firmware Interface (UEFI) specification
1083 * @search_type selection criterion
1084 * @protocol GUID of the protocol
1085 * @search_key registration key
1086 * @buffer_size size of the buffer to receive the handles in bytes
1087 * @buffer buffer to receive the relevant handles
1088 * @return 0 if the handle implements the protocol
1090 static efi_status_t EFIAPI
efi_locate_handle_ext(
1091 enum efi_locate_search_type search_type
,
1092 const efi_guid_t
*protocol
, void *search_key
,
1093 efi_uintn_t
*buffer_size
, efi_handle_t
*buffer
)
1095 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
1096 buffer_size
, buffer
);
1098 return EFI_EXIT(efi_locate_handle(search_type
, protocol
, search_key
,
1099 buffer_size
, buffer
));
1103 * Get the device path and handle of an device implementing a protocol.
1105 * This function implements the LocateDevicePath service.
1106 * See the Unified Extensible Firmware Interface (UEFI) specification
1109 * @protocol GUID of the protocol
1110 * @device_path device path
1111 * @device handle of the device
1112 * @return status code
1114 static efi_status_t EFIAPI
efi_locate_device_path(
1115 const efi_guid_t
*protocol
,
1116 struct efi_device_path
**device_path
,
1117 efi_handle_t
*device
)
1119 struct efi_object
*efiobj
;
1121 EFI_ENTRY("%pUl, %p, %p", protocol
, device_path
, device
);
1123 efiobj
= efi_dp_find_obj(*device_path
, device_path
);
1125 return EFI_EXIT(EFI_NOT_FOUND
);
1127 *device
= efiobj
->handle
;
1129 return EFI_EXIT(EFI_SUCCESS
);
1132 /* Collapses configuration table entries, removing index i */
1133 static void efi_remove_configuration_table(int i
)
1135 struct efi_configuration_table
*this = &efi_conf_table
[i
];
1136 struct efi_configuration_table
*next
= &efi_conf_table
[i
+1];
1137 struct efi_configuration_table
*end
= &efi_conf_table
[systab
.nr_tables
];
1139 memmove(this, next
, (ulong
)end
- (ulong
)next
);
1144 * Adds, updates, or removes a configuration table.
1146 * This function is used for internal calls. For the API implementation of the
1147 * InstallConfigurationTable service see efi_install_configuration_table_ext.
1149 * @guid GUID of the installed table
1150 * @table table to be installed
1151 * @return status code
1153 efi_status_t
efi_install_configuration_table(const efi_guid_t
*guid
, void *table
)
1157 /* Check for guid override */
1158 for (i
= 0; i
< systab
.nr_tables
; i
++) {
1159 if (!guidcmp(guid
, &efi_conf_table
[i
].guid
)) {
1161 efi_conf_table
[i
].table
= table
;
1163 efi_remove_configuration_table(i
);
1169 return EFI_NOT_FOUND
;
1171 /* No override, check for overflow */
1172 if (i
>= ARRAY_SIZE(efi_conf_table
))
1173 return EFI_OUT_OF_RESOURCES
;
1175 /* Add a new entry */
1176 memcpy(&efi_conf_table
[i
].guid
, guid
, sizeof(*guid
));
1177 efi_conf_table
[i
].table
= table
;
1178 systab
.nr_tables
= i
+ 1;
1184 * Adds, updates, or removes a configuration table.
1186 * This function implements the InstallConfigurationTable service.
1187 * See the Unified Extensible Firmware Interface (UEFI) specification
1190 * @guid GUID of the installed table
1191 * @table table to be installed
1192 * @return status code
1194 static efi_status_t EFIAPI
efi_install_configuration_table_ext(efi_guid_t
*guid
,
1197 EFI_ENTRY("%pUl, %p", guid
, table
);
1198 return EFI_EXIT(efi_install_configuration_table(guid
, table
));
1202 * Initialize a loaded_image_info + loaded_image_info object with correct
1203 * protocols, boot-device, etc.
1205 * @info loaded image info to be passed to the entry point of the
1207 * @obj internal object associated with the loaded image
1208 * @device_path device path of the loaded image
1209 * @file_path file path of the loaded image
1211 void efi_setup_loaded_image(struct efi_loaded_image
*info
, struct efi_object
*obj
,
1212 struct efi_device_path
*device_path
,
1213 struct efi_device_path
*file_path
)
1218 * When asking for the device path interface, return
1219 * bootefi_device_path
1221 obj
->protocols
[0].guid
= &efi_guid_device_path
;
1222 obj
->protocols
[0].protocol_interface
= device_path
;
1225 * When asking for the loaded_image interface, just
1226 * return handle which points to loaded_image_info
1228 obj
->protocols
[1].guid
= &efi_guid_loaded_image
;
1229 obj
->protocols
[1].protocol_interface
= info
;
1231 obj
->protocols
[2].guid
= &efi_guid_console_control
;
1232 obj
->protocols
[2].protocol_interface
= (void *)&efi_console_control
;
1234 obj
->protocols
[3].guid
= &efi_guid_device_path_to_text_protocol
;
1235 obj
->protocols
[3].protocol_interface
=
1236 (void *)&efi_device_path_to_text
;
1238 info
->file_path
= file_path
;
1240 info
->device_handle
= efi_dp_find_obj(device_path
, NULL
);
1242 list_add_tail(&obj
->link
, &efi_obj_list
);
1246 * Load an image using a file path.
1248 * @file_path the path of the image to load
1249 * @buffer buffer containing the loaded image
1250 * @return status code
1252 efi_status_t
efi_load_image_from_path(struct efi_device_path
*file_path
,
1255 struct efi_file_info
*info
= NULL
;
1256 struct efi_file_handle
*f
;
1257 static efi_status_t ret
;
1260 f
= efi_file_from_path(file_path
);
1262 return EFI_DEVICE_ERROR
;
1265 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1267 if (ret
== EFI_BUFFER_TOO_SMALL
) {
1269 EFI_CALL(ret
= f
->getinfo(f
, (efi_guid_t
*)&efi_file_info_guid
,
1272 if (ret
!= EFI_SUCCESS
)
1275 ret
= efi_allocate_pool(EFI_LOADER_DATA
, info
->file_size
, buffer
);
1279 EFI_CALL(ret
= f
->read(f
, &info
->file_size
, *buffer
));
1283 EFI_CALL(f
->close(f
));
1285 if (ret
!= EFI_SUCCESS
) {
1286 efi_free_pool(*buffer
);
1294 * Load an EFI image into memory.
1296 * This function implements the LoadImage service.
1297 * See the Unified Extensible Firmware Interface (UEFI) specification
1300 * @boot_policy true for request originating from the boot manager
1301 * @parent_image the calles's image handle
1302 * @file_path the path of the image to load
1303 * @source_buffer memory location from which the image is installed
1304 * @source_size size of the memory area from which the image is
1306 * @image_handle handle for the newly installed image
1307 * @return status code
1309 static efi_status_t EFIAPI
efi_load_image(bool boot_policy
,
1310 efi_handle_t parent_image
,
1311 struct efi_device_path
*file_path
,
1312 void *source_buffer
,
1313 unsigned long source_size
,
1314 efi_handle_t
*image_handle
)
1316 struct efi_loaded_image
*info
;
1317 struct efi_object
*obj
;
1319 EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy
, parent_image
,
1320 file_path
, source_buffer
, source_size
, image_handle
);
1322 info
= calloc(1, sizeof(*info
));
1323 obj
= calloc(1, sizeof(*obj
));
1325 if (!source_buffer
) {
1326 struct efi_device_path
*dp
, *fp
;
1329 ret
= efi_load_image_from_path(file_path
, &source_buffer
);
1330 if (ret
!= EFI_SUCCESS
) {
1333 return EFI_EXIT(ret
);
1337 * split file_path which contains both the device and
1340 efi_dp_split_file_path(file_path
, &dp
, &fp
);
1342 efi_setup_loaded_image(info
, obj
, dp
, fp
);
1344 /* In this case, file_path is the "device" path, ie.
1345 * something like a HARDWARE_DEVICE:MEMORY_MAPPED
1347 efi_setup_loaded_image(info
, obj
, file_path
, NULL
);
1350 info
->reserved
= efi_load_pe(source_buffer
, info
);
1351 if (!info
->reserved
) {
1354 return EFI_EXIT(EFI_UNSUPPORTED
);
1357 info
->system_table
= &systab
;
1358 info
->parent_handle
= parent_image
;
1359 *image_handle
= info
;
1361 return EFI_EXIT(EFI_SUCCESS
);
1365 * Call the entry point of an image.
1367 * This function implements the StartImage service.
1368 * See the Unified Extensible Firmware Interface (UEFI) specification
1371 * @image_handle handle of the image
1372 * @exit_data_size size of the buffer
1373 * @exit_data buffer to receive the exit data of the called image
1374 * @return status code
1376 static efi_status_t EFIAPI
efi_start_image(efi_handle_t image_handle
,
1377 unsigned long *exit_data_size
,
1380 ulong (*entry
)(void *image_handle
, struct efi_system_table
*st
);
1381 struct efi_loaded_image
*info
= image_handle
;
1383 EFI_ENTRY("%p, %p, %p", image_handle
, exit_data_size
, exit_data
);
1384 entry
= info
->reserved
;
1386 efi_is_direct_boot
= false;
1388 /* call the image! */
1389 if (setjmp(&info
->exit_jmp
)) {
1390 /* We returned from the child image */
1391 return EFI_EXIT(info
->exit_status
);
1394 __efi_nesting_dec();
1396 entry(image_handle
, &systab
);
1397 __efi_entry_check();
1398 __efi_nesting_inc();
1400 /* Should usually never get here */
1401 return EFI_EXIT(EFI_SUCCESS
);
1405 * Leave an EFI application or driver.
1407 * This function implements the Exit service.
1408 * See the Unified Extensible Firmware Interface (UEFI) specification
1411 * @image_handle handle of the application or driver that is exiting
1412 * @exit_status status code
1413 * @exit_data_size size of the buffer in bytes
1414 * @exit_data buffer with data describing an error
1415 * @return status code
1417 static efi_status_t EFIAPI
efi_exit(efi_handle_t image_handle
,
1418 efi_status_t exit_status
, unsigned long exit_data_size
,
1421 struct efi_loaded_image
*loaded_image_info
= (void*)image_handle
;
1423 EFI_ENTRY("%p, %ld, %ld, %p", image_handle
, exit_status
,
1424 exit_data_size
, exit_data
);
1426 /* Make sure entry/exit counts for EFI world cross-overs match */
1430 * But longjmp out with the U-Boot gd, not the application's, as
1431 * the other end is a setjmp call inside EFI context.
1435 loaded_image_info
->exit_status
= exit_status
;
1436 longjmp(&loaded_image_info
->exit_jmp
, 1);
1438 panic("EFI application exited");
1442 * Unload an EFI image.
1444 * This function implements the UnloadImage service.
1445 * See the Unified Extensible Firmware Interface (UEFI) specification
1448 * @image_handle handle of the image to be unloaded
1449 * @return status code
1451 static efi_status_t EFIAPI
efi_unload_image(void *image_handle
)
1453 struct efi_object
*efiobj
;
1455 EFI_ENTRY("%p", image_handle
);
1456 efiobj
= efi_search_obj(image_handle
);
1458 list_del(&efiobj
->link
);
1460 return EFI_EXIT(EFI_SUCCESS
);
1464 * Fix up caches for EFI payloads if necessary.
1466 static void efi_exit_caches(void)
1468 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
1470 * Grub on 32bit ARM needs to have caches disabled before jumping into
1471 * a zImage, but does not know of all cache layers. Give it a hand.
1473 if (efi_is_direct_boot
)
1474 cleanup_before_linux();
1479 * Stop boot services.
1481 * This function implements the ExitBootServices service.
1482 * See the Unified Extensible Firmware Interface (UEFI) specification
1485 * @image_handle handle of the loaded image
1486 * @map_key key of the memory map
1487 * @return status code
1489 static efi_status_t EFIAPI
efi_exit_boot_services(void *image_handle
,
1490 unsigned long map_key
)
1494 EFI_ENTRY("%p, %ld", image_handle
, map_key
);
1496 /* Notify that ExitBootServices is invoked. */
1497 for (i
= 0; i
< ARRAY_SIZE(efi_events
); ++i
) {
1498 if (efi_events
[i
].type
!= EVT_SIGNAL_EXIT_BOOT_SERVICES
)
1500 efi_signal_event(&efi_events
[i
]);
1502 /* Make sure that notification functions are not called anymore */
1503 efi_tpl
= TPL_HIGH_LEVEL
;
1505 /* XXX Should persist EFI variables here */
1507 board_quiesce_devices();
1509 /* Fix up caches for EFI payloads if necessary */
1512 /* This stops all lingering devices */
1513 bootm_disable_interrupts();
1515 /* Give the payload some time to boot */
1516 efi_set_watchdog(0);
1519 return EFI_EXIT(EFI_SUCCESS
);
1523 * Get next value of the counter.
1525 * This function implements the NextMonotonicCount service.
1526 * See the Unified Extensible Firmware Interface (UEFI) specification
1529 * @count returned value of the counter
1530 * @return status code
1532 static efi_status_t EFIAPI
efi_get_next_monotonic_count(uint64_t *count
)
1534 static uint64_t mono
= 0;
1535 EFI_ENTRY("%p", count
);
1537 return EFI_EXIT(EFI_SUCCESS
);
1543 * This function implements the Stall sercive.
1544 * See the Unified Extensible Firmware Interface (UEFI) specification
1547 * @microseconds period to sleep in microseconds
1548 * @return status code
1550 static efi_status_t EFIAPI
efi_stall(unsigned long microseconds
)
1552 EFI_ENTRY("%ld", microseconds
);
1553 udelay(microseconds
);
1554 return EFI_EXIT(EFI_SUCCESS
);
1558 * Reset the watchdog timer.
1560 * This function implements the SetWatchdogTimer service.
1561 * See the Unified Extensible Firmware Interface (UEFI) specification
1564 * @timeout seconds before reset by watchdog
1565 * @watchdog_code code to be logged when resetting
1566 * @data_size size of buffer in bytes
1567 * @watchdog_data buffer with data describing the reset reason
1568 * @return status code
1570 static efi_status_t EFIAPI
efi_set_watchdog_timer(unsigned long timeout
,
1571 uint64_t watchdog_code
,
1572 unsigned long data_size
,
1573 uint16_t *watchdog_data
)
1575 EFI_ENTRY("%ld, 0x%"PRIx64
", %ld, %p", timeout
, watchdog_code
,
1576 data_size
, watchdog_data
);
1577 return EFI_EXIT(efi_set_watchdog(timeout
));
1581 * Connect a controller to a driver.
1583 * This function implements the ConnectController service.
1584 * See the Unified Extensible Firmware Interface (UEFI) specification
1587 * @controller_handle handle of the controller
1588 * @driver_image_handle handle of the driver
1589 * @remain_device_path device path of a child controller
1590 * @recursive true to connect all child controllers
1591 * @return status code
1593 static efi_status_t EFIAPI
efi_connect_controller(
1594 efi_handle_t controller_handle
,
1595 efi_handle_t
*driver_image_handle
,
1596 struct efi_device_path
*remain_device_path
,
1599 EFI_ENTRY("%p, %p, %p, %d", controller_handle
, driver_image_handle
,
1600 remain_device_path
, recursive
);
1601 return EFI_EXIT(EFI_NOT_FOUND
);
1605 * Disconnect a controller from a driver.
1607 * This function implements the DisconnectController service.
1608 * See the Unified Extensible Firmware Interface (UEFI) specification
1611 * @controller_handle handle of the controller
1612 * @driver_image_handle handle of the driver
1613 * @child_handle handle of the child to destroy
1614 * @return status code
1616 static efi_status_t EFIAPI
efi_disconnect_controller(void *controller_handle
,
1617 void *driver_image_handle
,
1620 EFI_ENTRY("%p, %p, %p", controller_handle
, driver_image_handle
,
1622 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1628 * This function implements the CloseProtocol service.
1629 * See the Unified Extensible Firmware Interface (UEFI) specification
1632 * @handle handle on which the protocol shall be closed
1633 * @protocol GUID of the protocol to close
1634 * @agent_handle handle of the driver
1635 * @controller_handle handle of the controller
1636 * @return status code
1638 static efi_status_t EFIAPI
efi_close_protocol(void *handle
,
1639 const efi_guid_t
*protocol
,
1641 void *controller_handle
)
1643 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, agent_handle
,
1645 return EFI_EXIT(EFI_NOT_FOUND
);
1649 * Provide information about then open status of a protocol on a handle
1651 * This function implements the OpenProtocolInformation service.
1652 * See the Unified Extensible Firmware Interface (UEFI) specification
1655 * @handle handle for which the information shall be retrieved
1656 * @protocol GUID of the protocol
1657 * @entry_buffer buffer to receive the open protocol information
1658 * @entry_count number of entries available in the buffer
1659 * @return status code
1661 static efi_status_t EFIAPI
efi_open_protocol_information(efi_handle_t handle
,
1662 const efi_guid_t
*protocol
,
1663 struct efi_open_protocol_info_entry
**entry_buffer
,
1664 efi_uintn_t
*entry_count
)
1666 EFI_ENTRY("%p, %pUl, %p, %p", handle
, protocol
, entry_buffer
,
1668 return EFI_EXIT(EFI_NOT_FOUND
);
1672 * Get protocols installed on a handle.
1674 * This function implements the ProtocolsPerHandleService.
1675 * See the Unified Extensible Firmware Interface (UEFI) specification
1678 * @handle handle for which the information is retrieved
1679 * @protocol_buffer buffer with protocol GUIDs
1680 * @protocol_buffer_count number of entries in the buffer
1681 * @return status code
1683 static efi_status_t EFIAPI
efi_protocols_per_handle(void *handle
,
1684 efi_guid_t
***protocol_buffer
,
1685 efi_uintn_t
*protocol_buffer_count
)
1687 unsigned long buffer_size
;
1688 struct efi_object
*efiobj
;
1690 struct list_head
*lhandle
;
1693 EFI_ENTRY("%p, %p, %p", handle
, protocol_buffer
,
1694 protocol_buffer_count
);
1696 if (!handle
|| !protocol_buffer
|| !protocol_buffer_count
)
1697 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1699 *protocol_buffer
= NULL
;
1700 *protocol_buffer_count
= 0;
1701 list_for_each(lhandle
, &efi_obj_list
) {
1702 efiobj
= list_entry(lhandle
, struct efi_object
, link
);
1704 if (efiobj
->handle
!= handle
)
1707 /* Count protocols */
1708 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
1709 if (efiobj
->protocols
[i
].guid
)
1710 ++*protocol_buffer_count
;
1713 if (*protocol_buffer_count
) {
1714 buffer_size
= sizeof(efi_guid_t
*) *
1715 *protocol_buffer_count
;
1716 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
,
1718 (void **)protocol_buffer
);
1719 if (r
!= EFI_SUCCESS
)
1722 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); ++i
) {
1723 if (efiobj
->protocols
[i
].guid
) {
1724 (*protocol_buffer
)[j
] = (void *)
1725 efiobj
->protocols
[i
].guid
;
1733 return EFI_EXIT(EFI_SUCCESS
);
1737 * Locate handles implementing a protocol.
1739 * This function implements the LocateHandleBuffer service.
1740 * See the Unified Extensible Firmware Interface (UEFI) specification
1743 * @search_type selection criterion
1744 * @protocol GUID of the protocol
1745 * @search_key registration key
1746 * @no_handles number of returned handles
1747 * @buffer buffer with the returned handles
1748 * @return status code
1750 static efi_status_t EFIAPI
efi_locate_handle_buffer(
1751 enum efi_locate_search_type search_type
,
1752 const efi_guid_t
*protocol
, void *search_key
,
1753 efi_uintn_t
*no_handles
, efi_handle_t
**buffer
)
1756 efi_uintn_t buffer_size
= 0;
1758 EFI_ENTRY("%d, %pUl, %p, %p, %p", search_type
, protocol
, search_key
,
1759 no_handles
, buffer
);
1761 if (!no_handles
|| !buffer
) {
1762 r
= EFI_INVALID_PARAMETER
;
1767 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
1769 if (r
!= EFI_BUFFER_TOO_SMALL
)
1771 r
= efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, buffer_size
,
1773 if (r
!= EFI_SUCCESS
)
1775 r
= efi_locate_handle(search_type
, protocol
, search_key
, &buffer_size
,
1777 if (r
== EFI_SUCCESS
)
1778 *no_handles
= buffer_size
/ sizeof(void *);
1784 * Find an interface implementing a protocol.
1786 * This function implements the LocateProtocol service.
1787 * See the Unified Extensible Firmware Interface (UEFI) specification
1790 * @protocol GUID of the protocol
1791 * @registration registration key passed to the notification function
1792 * @protocol_interface interface implementing the protocol
1793 * @return status code
1795 static efi_status_t EFIAPI
efi_locate_protocol(const efi_guid_t
*protocol
,
1797 void **protocol_interface
)
1799 struct list_head
*lhandle
;
1802 EFI_ENTRY("%pUl, %p, %p", protocol
, registration
, protocol_interface
);
1804 if (!protocol
|| !protocol_interface
)
1805 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1807 EFI_PRINT_GUID("protocol", protocol
);
1809 list_for_each(lhandle
, &efi_obj_list
) {
1810 struct efi_object
*efiobj
;
1812 efiobj
= list_entry(lhandle
, struct efi_object
, link
);
1813 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
1814 struct efi_handler
*handler
= &efiobj
->protocols
[i
];
1818 if (!guidcmp(handler
->guid
, protocol
)) {
1819 *protocol_interface
=
1820 handler
->protocol_interface
;
1821 return EFI_EXIT(EFI_SUCCESS
);
1825 *protocol_interface
= NULL
;
1827 return EFI_EXIT(EFI_NOT_FOUND
);
1831 * Install multiple protocol interfaces.
1833 * This function implements the MultipleProtocolInterfaces service.
1834 * See the Unified Extensible Firmware Interface (UEFI) specification
1837 * @handle handle on which the protocol interfaces shall be installed
1838 * @... NULL terminated argument list with pairs of protocol GUIDS and
1840 * @return status code
1842 static efi_status_t EFIAPI
efi_install_multiple_protocol_interfaces(
1845 EFI_ENTRY("%p", handle
);
1848 const efi_guid_t
*protocol
;
1849 void *protocol_interface
;
1850 efi_status_t r
= EFI_SUCCESS
;
1854 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1856 va_start(argptr
, handle
);
1858 protocol
= va_arg(argptr
, efi_guid_t
*);
1861 protocol_interface
= va_arg(argptr
, void*);
1862 r
= EFI_CALL(efi_install_protocol_interface(
1864 EFI_NATIVE_INTERFACE
,
1865 protocol_interface
));
1866 if (r
!= EFI_SUCCESS
)
1871 if (r
== EFI_SUCCESS
)
1874 /* If an error occurred undo all changes. */
1875 va_start(argptr
, handle
);
1877 protocol
= va_arg(argptr
, efi_guid_t
*);
1878 protocol_interface
= va_arg(argptr
, void*);
1879 EFI_CALL(efi_uninstall_protocol_interface(handle
, protocol
,
1880 protocol_interface
));
1888 * Uninstall multiple protocol interfaces.
1890 * This function implements the UninstallMultipleProtocolInterfaces service.
1891 * See the Unified Extensible Firmware Interface (UEFI) specification
1894 * @handle handle from which the protocol interfaces shall be removed
1895 * @... NULL terminated argument list with pairs of protocol GUIDS and
1897 * @return status code
1899 static efi_status_t EFIAPI
efi_uninstall_multiple_protocol_interfaces(
1902 EFI_ENTRY("%p", handle
);
1905 const efi_guid_t
*protocol
;
1906 void *protocol_interface
;
1907 efi_status_t r
= EFI_SUCCESS
;
1911 return EFI_EXIT(EFI_INVALID_PARAMETER
);
1913 va_start(argptr
, handle
);
1915 protocol
= va_arg(argptr
, efi_guid_t
*);
1918 protocol_interface
= va_arg(argptr
, void*);
1919 r
= EFI_CALL(efi_uninstall_protocol_interface(
1921 protocol_interface
));
1922 if (r
!= EFI_SUCCESS
)
1927 if (r
== EFI_SUCCESS
)
1930 /* If an error occurred undo all changes. */
1931 va_start(argptr
, handle
);
1933 protocol
= va_arg(argptr
, efi_guid_t
*);
1934 protocol_interface
= va_arg(argptr
, void*);
1935 EFI_CALL(efi_install_protocol_interface(&handle
, protocol
,
1936 EFI_NATIVE_INTERFACE
,
1937 protocol_interface
));
1945 * Calculate cyclic redundancy code.
1947 * This function implements the CalculateCrc32 service.
1948 * See the Unified Extensible Firmware Interface (UEFI) specification
1951 * @data buffer with data
1952 * @data_size size of buffer in bytes
1953 * @crc32_p cyclic redundancy code
1954 * @return status code
1956 static efi_status_t EFIAPI
efi_calculate_crc32(void *data
,
1957 unsigned long data_size
,
1960 EFI_ENTRY("%p, %ld", data
, data_size
);
1961 *crc32_p
= crc32(0, data
, data_size
);
1962 return EFI_EXIT(EFI_SUCCESS
);
1968 * This function implements the CopyMem service.
1969 * See the Unified Extensible Firmware Interface (UEFI) specification
1972 * @destination destination of the copy operation
1973 * @source source of the copy operation
1974 * @length number of bytes to copy
1976 static void EFIAPI
efi_copy_mem(void *destination
, const void *source
,
1979 EFI_ENTRY("%p, %p, %ld", destination
, source
, (unsigned long)length
);
1980 memcpy(destination
, source
, length
);
1981 EFI_EXIT(EFI_SUCCESS
);
1985 * Fill memory with a byte value.
1987 * This function implements the SetMem service.
1988 * See the Unified Extensible Firmware Interface (UEFI) specification
1991 * @buffer buffer to fill
1992 * @size size of buffer in bytes
1993 * @value byte to copy to the buffer
1995 static void EFIAPI
efi_set_mem(void *buffer
, size_t size
, uint8_t value
)
1997 EFI_ENTRY("%p, %ld, 0x%x", buffer
, (unsigned long)size
, value
);
1998 memset(buffer
, value
, size
);
1999 EFI_EXIT(EFI_SUCCESS
);
2003 * Open protocol interface on a handle.
2005 * This function implements the OpenProtocol interface.
2006 * See the Unified Extensible Firmware Interface (UEFI) specification
2009 * @handle handle on which the protocol shall be opened
2010 * @protocol GUID of the protocol
2011 * @protocol_interface interface implementing the protocol
2012 * @agent_handle handle of the driver
2013 * @controller_handle handle of the controller
2014 * @attributes attributes indicating how to open the protocol
2015 * @return status code
2017 static efi_status_t EFIAPI
efi_open_protocol(
2018 void *handle
, const efi_guid_t
*protocol
,
2019 void **protocol_interface
, void *agent_handle
,
2020 void *controller_handle
, uint32_t attributes
)
2022 struct list_head
*lhandle
;
2024 efi_status_t r
= EFI_INVALID_PARAMETER
;
2026 EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle
, protocol
,
2027 protocol_interface
, agent_handle
, controller_handle
,
2030 if (!handle
|| !protocol
||
2031 (!protocol_interface
&& attributes
!=
2032 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
)) {
2036 EFI_PRINT_GUID("protocol", protocol
);
2038 switch (attributes
) {
2039 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
:
2040 case EFI_OPEN_PROTOCOL_GET_PROTOCOL
:
2041 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL
:
2043 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
:
2044 if (controller_handle
== handle
)
2046 case EFI_OPEN_PROTOCOL_BY_DRIVER
:
2047 case EFI_OPEN_PROTOCOL_BY_DRIVER
| EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2048 if (controller_handle
== NULL
)
2050 case EFI_OPEN_PROTOCOL_EXCLUSIVE
:
2051 if (agent_handle
== NULL
)
2058 list_for_each(lhandle
, &efi_obj_list
) {
2059 struct efi_object
*efiobj
;
2060 efiobj
= list_entry(lhandle
, struct efi_object
, link
);
2062 if (efiobj
->handle
!= handle
)
2065 for (i
= 0; i
< ARRAY_SIZE(efiobj
->protocols
); i
++) {
2066 struct efi_handler
*handler
= &efiobj
->protocols
[i
];
2067 const efi_guid_t
*hprotocol
= handler
->guid
;
2070 if (!guidcmp(hprotocol
, protocol
)) {
2072 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) {
2073 *protocol_interface
=
2074 handler
->protocol_interface
;
2084 r
= EFI_UNSUPPORTED
;
2090 * Get interface of a protocol on a handle.
2092 * This function implements the HandleProtocol service.
2093 * See the Unified Extensible Firmware Interface (UEFI) specification
2096 * @handle handle on which the protocol shall be opened
2097 * @protocol GUID of the protocol
2098 * @protocol_interface interface implementing the protocol
2099 * @return status code
2101 static efi_status_t EFIAPI
efi_handle_protocol(void *handle
,
2102 const efi_guid_t
*protocol
,
2103 void **protocol_interface
)
2105 return efi_open_protocol(handle
, protocol
, protocol_interface
, NULL
,
2106 NULL
, EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
);
2109 static const struct efi_boot_services efi_boot_services
= {
2111 .headersize
= sizeof(struct efi_table_hdr
),
2113 .raise_tpl
= efi_raise_tpl
,
2114 .restore_tpl
= efi_restore_tpl
,
2115 .allocate_pages
= efi_allocate_pages_ext
,
2116 .free_pages
= efi_free_pages_ext
,
2117 .get_memory_map
= efi_get_memory_map_ext
,
2118 .allocate_pool
= efi_allocate_pool_ext
,
2119 .free_pool
= efi_free_pool_ext
,
2120 .create_event
= efi_create_event_ext
,
2121 .set_timer
= efi_set_timer_ext
,
2122 .wait_for_event
= efi_wait_for_event
,
2123 .signal_event
= efi_signal_event_ext
,
2124 .close_event
= efi_close_event
,
2125 .check_event
= efi_check_event
,
2126 .install_protocol_interface
= efi_install_protocol_interface
,
2127 .reinstall_protocol_interface
= efi_reinstall_protocol_interface
,
2128 .uninstall_protocol_interface
= efi_uninstall_protocol_interface
,
2129 .handle_protocol
= efi_handle_protocol
,
2131 .register_protocol_notify
= efi_register_protocol_notify
,
2132 .locate_handle
= efi_locate_handle_ext
,
2133 .locate_device_path
= efi_locate_device_path
,
2134 .install_configuration_table
= efi_install_configuration_table_ext
,
2135 .load_image
= efi_load_image
,
2136 .start_image
= efi_start_image
,
2138 .unload_image
= efi_unload_image
,
2139 .exit_boot_services
= efi_exit_boot_services
,
2140 .get_next_monotonic_count
= efi_get_next_monotonic_count
,
2142 .set_watchdog_timer
= efi_set_watchdog_timer
,
2143 .connect_controller
= efi_connect_controller
,
2144 .disconnect_controller
= efi_disconnect_controller
,
2145 .open_protocol
= efi_open_protocol
,
2146 .close_protocol
= efi_close_protocol
,
2147 .open_protocol_information
= efi_open_protocol_information
,
2148 .protocols_per_handle
= efi_protocols_per_handle
,
2149 .locate_handle_buffer
= efi_locate_handle_buffer
,
2150 .locate_protocol
= efi_locate_protocol
,
2151 .install_multiple_protocol_interfaces
= efi_install_multiple_protocol_interfaces
,
2152 .uninstall_multiple_protocol_interfaces
= efi_uninstall_multiple_protocol_interfaces
,
2153 .calculate_crc32
= efi_calculate_crc32
,
2154 .copy_mem
= efi_copy_mem
,
2155 .set_mem
= efi_set_mem
,
2159 static uint16_t __efi_runtime_data firmware_vendor
[] =
2160 { 'D','a','s',' ','U','-','b','o','o','t',0 };
2162 struct efi_system_table __efi_runtime_data systab
= {
2164 .signature
= EFI_SYSTEM_TABLE_SIGNATURE
,
2165 .revision
= 0x20005, /* 2.5 */
2166 .headersize
= sizeof(struct efi_table_hdr
),
2168 .fw_vendor
= (long)firmware_vendor
,
2169 .con_in
= (void*)&efi_con_in
,
2170 .con_out
= (void*)&efi_con_out
,
2171 .std_err
= (void*)&efi_con_out
,
2172 .runtime
= (void*)&efi_runtime_services
,
2173 .boottime
= (void*)&efi_boot_services
,
2175 .tables
= (void*)efi_conf_table
,