1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application runtime services
5 * Copyright (c) 2016 Alexander Graf
12 #include <efi_loader.h>
15 /* For manual relocation support */
16 DECLARE_GLOBAL_DATA_PTR
;
18 struct efi_runtime_mmio_list
{
19 struct list_head link
;
25 /* This list contains all runtime available mmio regions */
26 LIST_HEAD(efi_runtime_mmio
);
28 static efi_status_t __efi_runtime EFIAPI
efi_unimplemented(void);
29 static efi_status_t __efi_runtime EFIAPI
efi_device_error(void);
30 static efi_status_t __efi_runtime EFIAPI
efi_invalid_parameter(void);
33 * TODO(sjg@chromium.org): These defines and structures should come from the ELF
34 * header for each architecture (or a generic header) rather than being repeated
37 #if defined(__aarch64__)
38 #define R_RELATIVE R_AARCH64_RELATIVE
39 #define R_MASK 0xffffffffULL
41 #elif defined(__arm__)
42 #define R_RELATIVE R_ARM_RELATIVE
43 #define R_MASK 0xffULL
44 #elif defined(__i386__)
45 #define R_RELATIVE R_386_RELATIVE
46 #define R_MASK 0xffULL
47 #elif defined(__x86_64__)
48 #define R_RELATIVE R_X86_64_RELATIVE
49 #define R_MASK 0xffffffffULL
51 #elif defined(__riscv)
52 #define R_RELATIVE R_RISCV_RELATIVE
53 #define R_MASK 0xffULL
62 #if (__riscv_xlen == 32)
63 #define R_ABSOLUTE R_RISCV_32
65 #elif (__riscv_xlen == 64)
66 #define R_ABSOLUTE R_RISCV_64
69 #error unknown riscv target
72 #error Need to add relocation awareness
87 * EFI runtime code lives in two stages. In the first stage, U-Boot and an EFI
88 * payload are running concurrently at the same time. In this mode, we can
89 * handle a good number of runtime callbacks
93 * efi_update_table_header_crc32() - Update crc32 in table header
97 void __efi_runtime
efi_update_table_header_crc32(struct efi_table_hdr
*table
)
100 table
->crc32
= crc32(0, (const unsigned char *)table
,
105 * efi_reset_system_boottime() - reset system at boot time
107 * This function implements the ResetSystem() runtime service before
108 * SetVirtualAddressMap() is called.
110 * See the Unified Extensible Firmware Interface (UEFI) specification for
113 * @reset_type: type of reset to perform
114 * @reset_status: status code for the reset
115 * @data_size: size of reset_data
116 * @reset_data: information about the reset
118 static void EFIAPI
efi_reset_system_boottime(
119 enum efi_reset_type reset_type
,
120 efi_status_t reset_status
,
121 unsigned long data_size
, void *reset_data
)
123 struct efi_event
*evt
;
125 EFI_ENTRY("%d %lx %lx %p", reset_type
, reset_status
, data_size
,
129 list_for_each_entry(evt
, &efi_events
, link
) {
132 &efi_guid_event_group_reset_system
)) {
133 efi_signal_event(evt
);
137 switch (reset_type
) {
140 case EFI_RESET_PLATFORM_SPECIFIC
:
141 do_reset(NULL
, 0, 0, NULL
);
143 case EFI_RESET_SHUTDOWN
:
144 #ifdef CONFIG_CMD_POWEROFF
145 do_poweroff(NULL
, 0, 0, NULL
);
154 * efi_get_time_boottime() - get current time at boot time
156 * This function implements the GetTime runtime service before
157 * SetVirtualAddressMap() is called.
159 * See the Unified Extensible Firmware Interface (UEFI) specification
162 * @time: pointer to structure to receive current time
163 * @capabilities: pointer to structure to receive RTC properties
164 * Returns: status code
166 static efi_status_t EFIAPI
efi_get_time_boottime(
167 struct efi_time
*time
,
168 struct efi_time_cap
*capabilities
)
170 #ifdef CONFIG_EFI_GET_TIME
171 efi_status_t ret
= EFI_SUCCESS
;
175 EFI_ENTRY("%p %p", time
, capabilities
);
178 ret
= EFI_INVALID_PARAMETER
;
181 if (uclass_get_device(UCLASS_RTC
, 0, &dev
) ||
182 dm_rtc_get(dev
, &tm
)) {
183 ret
= EFI_UNSUPPORTED
;
186 if (dm_rtc_get(dev
, &tm
)) {
187 ret
= EFI_DEVICE_ERROR
;
191 memset(time
, 0, sizeof(*time
));
192 time
->year
= tm
.tm_year
;
193 time
->month
= tm
.tm_mon
;
194 time
->day
= tm
.tm_mday
;
195 time
->hour
= tm
.tm_hour
;
196 time
->minute
= tm
.tm_min
;
197 time
->second
= tm
.tm_sec
;
200 EFI_TIME_ADJUST_DAYLIGHT
| EFI_TIME_IN_DAYLIGHT
;
201 time
->timezone
= EFI_UNSPECIFIED_TIMEZONE
;
204 /* Set reasonable dummy values */
205 capabilities
->resolution
= 1; /* 1 Hz */
206 capabilities
->accuracy
= 100000000; /* 100 ppm */
207 capabilities
->sets_to_zero
= false;
210 return EFI_EXIT(ret
);
212 EFI_ENTRY("%p %p", time
, capabilities
);
213 return EFI_EXIT(EFI_UNSUPPORTED
);
217 #ifdef CONFIG_EFI_SET_TIME
220 * efi_validate_time() - checks if timestamp is valid
222 * @time: timestamp to validate
223 * Returns: 0 if timestamp is valid, 1 otherwise
225 static int efi_validate_time(struct efi_time
*time
)
228 time
->year
< 1900 || time
->year
> 9999 ||
229 !time
->month
|| time
->month
> 12 || !time
->day
||
230 time
->day
> rtc_month_days(time
->month
- 1, time
->year
) ||
231 time
->hour
> 23 || time
->minute
> 59 || time
->second
> 59 ||
232 time
->nanosecond
> 999999999 ||
234 ~(EFI_TIME_IN_DAYLIGHT
| EFI_TIME_ADJUST_DAYLIGHT
) ||
235 ((time
->timezone
< -1440 || time
->timezone
> 1440) &&
236 time
->timezone
!= EFI_UNSPECIFIED_TIMEZONE
));
242 * efi_set_time_boottime() - set current time
244 * This function implements the SetTime() runtime service before
245 * SetVirtualAddressMap() is called.
247 * See the Unified Extensible Firmware Interface (UEFI) specification
250 * @time: pointer to structure to with current time
251 * Returns: status code
253 static efi_status_t EFIAPI
efi_set_time_boottime(struct efi_time
*time
)
255 #ifdef CONFIG_EFI_SET_TIME
256 efi_status_t ret
= EFI_SUCCESS
;
260 EFI_ENTRY("%p", time
);
262 if (efi_validate_time(time
)) {
263 ret
= EFI_INVALID_PARAMETER
;
267 if (uclass_get_device(UCLASS_RTC
, 0, &dev
)) {
268 ret
= EFI_UNSUPPORTED
;
272 memset(&tm
, 0, sizeof(tm
));
273 tm
.tm_year
= time
->year
;
274 tm
.tm_mon
= time
->month
;
275 tm
.tm_mday
= time
->day
;
276 tm
.tm_hour
= time
->hour
;
277 tm
.tm_min
= time
->minute
;
278 tm
.tm_sec
= time
->second
;
279 tm
.tm_isdst
= time
->daylight
==
280 (EFI_TIME_ADJUST_DAYLIGHT
| EFI_TIME_IN_DAYLIGHT
);
281 /* Calculate day of week */
282 rtc_calc_weekday(&tm
);
284 if (dm_rtc_set(dev
, &tm
))
285 ret
= EFI_DEVICE_ERROR
;
287 return EFI_EXIT(ret
);
289 EFI_ENTRY("%p", time
);
290 return EFI_EXIT(EFI_UNSUPPORTED
);
294 * efi_reset_system() - reset system
296 * This function implements the ResetSystem() runtime service after
297 * SetVirtualAddressMap() is called. It only executes an endless loop.
298 * Boards may override the helpers below to implement reset functionality.
300 * See the Unified Extensible Firmware Interface (UEFI) specification for
303 * @reset_type: type of reset to perform
304 * @reset_status: status code for the reset
305 * @data_size: size of reset_data
306 * @reset_data: information about the reset
308 void __weak __efi_runtime EFIAPI
efi_reset_system(
309 enum efi_reset_type reset_type
,
310 efi_status_t reset_status
,
311 unsigned long data_size
, void *reset_data
)
313 /* Nothing we can do */
318 * efi_reset_system_init() - initialize the reset driver
320 * Boards may override this function to initialize the reset driver.
322 efi_status_t __weak
efi_reset_system_init(void)
328 * efi_get_time() - get current time
330 * This function implements the GetTime runtime service after
331 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
332 * anymore only an error code is returned.
334 * See the Unified Extensible Firmware Interface (UEFI) specification
337 * @time: pointer to structure to receive current time
338 * @capabilities: pointer to structure to receive RTC properties
339 * Returns: status code
341 efi_status_t __weak __efi_runtime EFIAPI
efi_get_time(
342 struct efi_time
*time
,
343 struct efi_time_cap
*capabilities
)
345 /* Nothing we can do */
346 return EFI_DEVICE_ERROR
;
350 * efi_set_time() - set current time
352 * This function implements the SetTime runtime service after
353 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
354 * anymore only an error code is returned.
356 * See the Unified Extensible Firmware Interface (UEFI) specification
359 * @time: pointer to structure to with current time
360 * Returns: status code
362 efi_status_t __weak __efi_runtime EFIAPI
efi_set_time(struct efi_time
*time
)
364 return EFI_UNSUPPORTED
;
367 struct efi_runtime_detach_list_struct
{
372 static const struct efi_runtime_detach_list_struct efi_runtime_detach_list
[] = {
374 /* do_reset is gone */
375 .ptr
= &efi_runtime_services
.reset_system
,
376 .patchto
= efi_reset_system
,
378 /* invalidate_*cache_all are gone */
379 .ptr
= &efi_runtime_services
.set_virtual_address_map
,
380 .patchto
= &efi_unimplemented
,
382 /* RTC accessors are gone */
383 .ptr
= &efi_runtime_services
.get_time
,
384 .patchto
= &efi_get_time
,
386 .ptr
= &efi_runtime_services
.set_time
,
387 .patchto
= &efi_set_time
,
389 /* Clean up system table */
390 .ptr
= &systab
.con_in
,
393 /* Clean up system table */
394 .ptr
= &systab
.con_out
,
397 /* Clean up system table */
398 .ptr
= &systab
.std_err
,
401 /* Clean up system table */
402 .ptr
= &systab
.boottime
,
405 .ptr
= &efi_runtime_services
.get_variable
,
406 .patchto
= &efi_device_error
,
408 .ptr
= &efi_runtime_services
.get_next_variable_name
,
409 .patchto
= &efi_device_error
,
411 .ptr
= &efi_runtime_services
.set_variable
,
412 .patchto
= &efi_device_error
,
416 static bool efi_runtime_tobedetached(void *p
)
420 for (i
= 0; i
< ARRAY_SIZE(efi_runtime_detach_list
); i
++)
421 if (efi_runtime_detach_list
[i
].ptr
== p
)
427 static void efi_runtime_detach(ulong offset
)
430 ulong patchoff
= offset
- (ulong
)gd
->relocaddr
;
432 for (i
= 0; i
< ARRAY_SIZE(efi_runtime_detach_list
); i
++) {
433 ulong patchto
= (ulong
)efi_runtime_detach_list
[i
].patchto
;
434 ulong
*p
= efi_runtime_detach_list
[i
].ptr
;
435 ulong newaddr
= patchto
? (patchto
+ patchoff
) : 0;
437 debug("%s: Setting %p to %lx\n", __func__
, p
, newaddr
);
442 efi_update_table_header_crc32(&efi_runtime_services
.hdr
);
445 /* Relocate EFI runtime to uboot_reloc_base = offset */
446 void efi_runtime_relocate(ulong offset
, struct efi_mem_desc
*map
)
449 struct elf_rela
*rel
= (void*)&__efi_runtime_rel_start
;
451 struct elf_rel
*rel
= (void*)&__efi_runtime_rel_start
;
452 static ulong lastoff
= CONFIG_SYS_TEXT_BASE
;
455 debug("%s: Relocating to offset=%lx\n", __func__
, offset
);
456 for (; (ulong
)rel
< (ulong
)&__efi_runtime_rel_stop
; rel
++) {
457 ulong base
= CONFIG_SYS_TEXT_BASE
;
461 p
= (void*)((ulong
)rel
->offset
- base
) + gd
->relocaddr
;
463 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__
,
464 rel
->info
, *p
, rel
->offset
);
466 switch (rel
->info
& R_MASK
) {
469 newaddr
= rel
->addend
+ offset
- CONFIG_SYS_TEXT_BASE
;
471 newaddr
= *p
- lastoff
+ offset
;
476 ulong symidx
= rel
->info
>> SYM_INDEX
;
477 extern struct dyn_sym __dyn_sym_start
[];
478 newaddr
= __dyn_sym_start
[symidx
].addr
+ offset
;
480 newaddr
-= CONFIG_SYS_TEXT_BASE
;
486 if (!efi_runtime_tobedetached(p
))
487 printf("%s: Unknown relocation type %llx\n",
488 __func__
, rel
->info
& R_MASK
);
492 /* Check if the relocation is inside bounds */
493 if (map
&& ((newaddr
< map
->virtual_start
) ||
494 newaddr
> (map
->virtual_start
+
495 (map
->num_pages
<< EFI_PAGE_SHIFT
)))) {
496 if (!efi_runtime_tobedetached(p
))
497 printf("%s: Relocation at %p is out of "
498 "range (%lx)\n", __func__
, p
, newaddr
);
502 debug("%s: Setting %p to %lx\n", __func__
, p
, newaddr
);
504 flush_dcache_range((ulong
)p
& ~(EFI_CACHELINE_SIZE
- 1),
505 ALIGN((ulong
)&p
[1], EFI_CACHELINE_SIZE
));
512 invalidate_icache_all();
516 * efi_set_virtual_address_map() - change from physical to virtual mapping
518 * This function implements the SetVirtualAddressMap() runtime service.
520 * See the Unified Extensible Firmware Interface (UEFI) specification for
523 * @memory_map_size: size of the virtual map
524 * @descriptor_size: size of an entry in the map
525 * @descriptor_version: version of the map entries
526 * @virtmap: virtual address mapping information
527 * Return: status code
529 static efi_status_t EFIAPI
efi_set_virtual_address_map(
530 unsigned long memory_map_size
,
531 unsigned long descriptor_size
,
532 uint32_t descriptor_version
,
533 struct efi_mem_desc
*virtmap
)
535 int n
= memory_map_size
/ descriptor_size
;
537 int rt_code_sections
= 0;
539 EFI_ENTRY("%lx %lx %x %p", memory_map_size
, descriptor_size
,
540 descriptor_version
, virtmap
);
544 * Further down we are cheating. While really we should implement
545 * SetVirtualAddressMap() events and ConvertPointer() to allow
546 * dynamically loaded drivers to expose runtime services, we don't
549 * So let's ensure we see exactly one single runtime section, as
550 * that is the built-in one. If we see more (or less), someone must
551 * have tried adding or removing to that which we don't support yet.
552 * In that case, let's better fail rather than expose broken runtime
555 for (i
= 0; i
< n
; i
++) {
556 struct efi_mem_desc
*map
= (void*)virtmap
+
557 (descriptor_size
* i
);
559 if (map
->type
== EFI_RUNTIME_SERVICES_CODE
)
563 if (rt_code_sections
!= 1) {
565 * We expose exactly one single runtime code section, so
566 * something is definitely going wrong.
568 return EFI_EXIT(EFI_INVALID_PARAMETER
);
571 /* Rebind mmio pointers */
572 for (i
= 0; i
< n
; i
++) {
573 struct efi_mem_desc
*map
= (void*)virtmap
+
574 (descriptor_size
* i
);
575 struct list_head
*lhandle
;
576 efi_physical_addr_t map_start
= map
->physical_start
;
577 efi_physical_addr_t map_len
= map
->num_pages
<< EFI_PAGE_SHIFT
;
578 efi_physical_addr_t map_end
= map_start
+ map_len
;
579 u64 off
= map
->virtual_start
- map_start
;
581 /* Adjust all mmio pointers in this region */
582 list_for_each(lhandle
, &efi_runtime_mmio
) {
583 struct efi_runtime_mmio_list
*lmmio
;
585 lmmio
= list_entry(lhandle
,
586 struct efi_runtime_mmio_list
,
588 if ((map_start
<= lmmio
->paddr
) &&
589 (map_end
>= lmmio
->paddr
)) {
590 uintptr_t new_addr
= lmmio
->paddr
+ off
;
591 *lmmio
->ptr
= (void *)new_addr
;
594 if ((map_start
<= (uintptr_t)systab
.tables
) &&
595 (map_end
>= (uintptr_t)systab
.tables
)) {
596 char *ptr
= (char *)systab
.tables
;
599 systab
.tables
= (struct efi_configuration_table
*)ptr
;
603 /* Move the actual runtime code over */
604 for (i
= 0; i
< n
; i
++) {
605 struct efi_mem_desc
*map
;
607 map
= (void*)virtmap
+ (descriptor_size
* i
);
608 if (map
->type
== EFI_RUNTIME_SERVICES_CODE
) {
609 ulong new_offset
= map
->virtual_start
-
610 map
->physical_start
+ gd
->relocaddr
;
612 efi_runtime_relocate(new_offset
, map
);
613 /* Once we're virtual, we can no longer handle
615 efi_runtime_detach(new_offset
);
616 return EFI_EXIT(EFI_SUCCESS
);
620 return EFI_EXIT(EFI_INVALID_PARAMETER
);
624 * efi_add_runtime_mmio() - add memory-mapped IO region
626 * This function adds a memory-mapped IO region to the memory map to make it
627 * available at runtime.
629 * @mmio_ptr: pointer to a pointer to the start of the memory-mapped
631 * @len: size of the memory-mapped IO region
632 * Returns: status code
634 efi_status_t
efi_add_runtime_mmio(void *mmio_ptr
, u64 len
)
636 struct efi_runtime_mmio_list
*newmmio
;
637 u64 pages
= (len
+ EFI_PAGE_MASK
) >> EFI_PAGE_SHIFT
;
638 uint64_t addr
= *(uintptr_t *)mmio_ptr
;
641 retaddr
= efi_add_memory_map(addr
, pages
, EFI_MMAP_IO
, false);
643 return EFI_OUT_OF_RESOURCES
;
645 newmmio
= calloc(1, sizeof(*newmmio
));
647 return EFI_OUT_OF_RESOURCES
;
648 newmmio
->ptr
= mmio_ptr
;
649 newmmio
->paddr
= *(uintptr_t *)mmio_ptr
;
651 list_add_tail(&newmmio
->link
, &efi_runtime_mmio
);
657 * In the second stage, U-Boot has disappeared. To isolate our runtime code
658 * that at this point still exists from the rest, we put it into a special
663 * This means that we can not rely on any code outside of this file in any
664 * function or variable below this line.
666 * Please keep everything fully self-contained and annotated with
667 * __efi_runtime and __efi_runtime_data markers.
671 * Relocate the EFI runtime stub to a different place. We need to call this
672 * the first time we expose the runtime interface to a user and on set virtual
677 * efi_unimplemented() - replacement function, returns EFI_UNSUPPORTED
679 * This function is used after SetVirtualAddressMap() is called as replacement
680 * for services that are not available anymore due to constraints of the U-Boot
683 * Return: EFI_UNSUPPORTED
685 static efi_status_t __efi_runtime EFIAPI
efi_unimplemented(void)
687 return EFI_UNSUPPORTED
;
691 * efi_device_error() - replacement function, returns EFI_DEVICE_ERROR
693 * This function is used after SetVirtualAddressMap() is called as replacement
694 * for services that are not available anymore due to constraints of the U-Boot
697 * Return: EFI_DEVICE_ERROR
699 static efi_status_t __efi_runtime EFIAPI
efi_device_error(void)
701 return EFI_DEVICE_ERROR
;
705 * efi_invalid_parameter() - replacement function, returns EFI_INVALID_PARAMETER
707 * This function is used after SetVirtualAddressMap() is called as replacement
708 * for services that are not available anymore due to constraints of the U-Boot
711 * Return: EFI_INVALID_PARAMETER
713 static efi_status_t __efi_runtime EFIAPI
efi_invalid_parameter(void)
715 return EFI_INVALID_PARAMETER
;
719 * efi_update_capsule() - process information from operating system
721 * This function implements the UpdateCapsule() runtime service.
723 * See the Unified Extensible Firmware Interface (UEFI) specification for
726 * @capsule_header_array: pointer to array of virtual pointers
727 * @capsule_count: number of pointers in capsule_header_array
728 * @scatter_gather_list: pointer to arry of physical pointers
729 * Returns: status code
731 efi_status_t __efi_runtime EFIAPI
efi_update_capsule(
732 struct efi_capsule_header
**capsule_header_array
,
733 efi_uintn_t capsule_count
,
734 u64 scatter_gather_list
)
736 return EFI_UNSUPPORTED
;
740 * efi_query_capsule_caps() - check if capsule is supported
742 * This function implements the QueryCapsuleCapabilities() runtime service.
744 * See the Unified Extensible Firmware Interface (UEFI) specification for
747 * @capsule_header_array: pointer to array of virtual pointers
748 * @capsule_count: number of pointers in capsule_header_array
749 * @maximum_capsule_size: maximum capsule size
750 * @reset_type: type of reset needed for capsule update
751 * Returns: status code
753 efi_status_t __efi_runtime EFIAPI
efi_query_capsule_caps(
754 struct efi_capsule_header
**capsule_header_array
,
755 efi_uintn_t capsule_count
,
756 u64
*maximum_capsule_size
,
759 return EFI_UNSUPPORTED
;
763 * efi_query_variable_info() - get information about EFI variables
765 * This function implements the QueryVariableInfo() runtime service.
767 * See the Unified Extensible Firmware Interface (UEFI) specification for
770 * @attributes: bitmask to select variables to be
772 * @maximum_variable_storage_size: maximum size of storage area for the
773 * selected variable types
774 * @remaining_variable_storage_size: remaining size of storage are for the
775 * selected variable types
776 * @maximum_variable_size: maximum size of a variable of the
778 * Returns: status code
780 efi_status_t __efi_runtime EFIAPI
efi_query_variable_info(
782 u64
*maximum_variable_storage_size
,
783 u64
*remaining_variable_storage_size
,
784 u64
*maximum_variable_size
)
786 return EFI_UNSUPPORTED
;
789 struct efi_runtime_services __efi_runtime_data efi_runtime_services
= {
791 .signature
= EFI_RUNTIME_SERVICES_SIGNATURE
,
792 .revision
= EFI_SPECIFICATION_VERSION
,
793 .headersize
= sizeof(struct efi_runtime_services
),
795 .get_time
= &efi_get_time_boottime
,
796 .set_time
= &efi_set_time_boottime
,
797 .get_wakeup_time
= (void *)&efi_unimplemented
,
798 .set_wakeup_time
= (void *)&efi_unimplemented
,
799 .set_virtual_address_map
= &efi_set_virtual_address_map
,
800 .convert_pointer
= (void *)&efi_invalid_parameter
,
801 .get_variable
= efi_get_variable
,
802 .get_next_variable_name
= efi_get_next_variable_name
,
803 .set_variable
= efi_set_variable
,
804 .get_next_high_mono_count
= (void *)&efi_device_error
,
805 .reset_system
= &efi_reset_system_boottime
,
806 .update_capsule
= efi_update_capsule
,
807 .query_capsule_caps
= efi_query_capsule_caps
,
808 .query_variable_info
= efi_query_variable_info
,