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, false);
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)
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;
198 time->daylight = EFI_TIME_ADJUST_DAYLIGHT;
200 time->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);
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)
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 == EFI_TIME_IN_DAYLIGHT;
280 /* Calculate day of week */
281 rtc_calc_weekday(&tm);
283 if (dm_rtc_set(dev, &tm))
284 ret = EFI_DEVICE_ERROR;
286 return EFI_EXIT(ret);
288 EFI_ENTRY("%p", time);
289 return EFI_EXIT(EFI_UNSUPPORTED);
293 * efi_reset_system() - reset system
295 * This function implements the ResetSystem() runtime service after
296 * SetVirtualAddressMap() is called. It only executes an endless loop.
297 * Boards may override the helpers below to implement reset functionality.
299 * See the Unified Extensible Firmware Interface (UEFI) specification for
302 * @reset_type: type of reset to perform
303 * @reset_status: status code for the reset
304 * @data_size: size of reset_data
305 * @reset_data: information about the reset
307 void __weak __efi_runtime EFIAPI efi_reset_system(
308 enum efi_reset_type reset_type,
309 efi_status_t reset_status,
310 unsigned long data_size, void *reset_data)
312 /* Nothing we can do */
317 * efi_reset_system_init() - initialize the reset driver
319 * Boards may override this function to initialize the reset driver.
321 efi_status_t __weak efi_reset_system_init(void)
327 * efi_get_time() - get current time
329 * This function implements the GetTime runtime service after
330 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
331 * anymore only an error code is returned.
333 * See the Unified Extensible Firmware Interface (UEFI) specification
336 * @time: pointer to structure to receive current time
337 * @capabilities: pointer to structure to receive RTC properties
338 * Returns: status code
340 efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
341 struct efi_time *time,
342 struct efi_time_cap *capabilities)
344 /* Nothing we can do */
345 return EFI_DEVICE_ERROR;
349 * efi_set_time() - set current time
351 * This function implements the SetTime runtime service after
352 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
353 * anymore only an error code is returned.
355 * See the Unified Extensible Firmware Interface (UEFI) specification
358 * @time: pointer to structure to with current time
359 * Returns: status code
361 efi_status_t __weak __efi_runtime EFIAPI efi_set_time(struct efi_time *time)
363 return EFI_UNSUPPORTED;
366 struct efi_runtime_detach_list_struct {
371 static const struct efi_runtime_detach_list_struct efi_runtime_detach_list[] = {
373 /* do_reset is gone */
374 .ptr = &efi_runtime_services.reset_system,
375 .patchto = efi_reset_system,
377 /* invalidate_*cache_all are gone */
378 .ptr = &efi_runtime_services.set_virtual_address_map,
379 .patchto = &efi_unimplemented,
381 /* RTC accessors are gone */
382 .ptr = &efi_runtime_services.get_time,
383 .patchto = &efi_get_time,
385 .ptr = &efi_runtime_services.set_time,
386 .patchto = &efi_set_time,
388 /* Clean up system table */
389 .ptr = &systab.con_in,
392 /* Clean up system table */
393 .ptr = &systab.con_out,
396 /* Clean up system table */
397 .ptr = &systab.std_err,
400 /* Clean up system table */
401 .ptr = &systab.boottime,
404 .ptr = &efi_runtime_services.get_variable,
405 .patchto = &efi_device_error,
407 .ptr = &efi_runtime_services.get_next_variable_name,
408 .patchto = &efi_device_error,
410 .ptr = &efi_runtime_services.set_variable,
411 .patchto = &efi_device_error,
415 static bool efi_runtime_tobedetached(void *p)
419 for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++)
420 if (efi_runtime_detach_list[i].ptr == p)
426 static void efi_runtime_detach(ulong offset)
429 ulong patchoff = offset - (ulong)gd->relocaddr;
431 for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++) {
432 ulong patchto = (ulong)efi_runtime_detach_list[i].patchto;
433 ulong *p = efi_runtime_detach_list[i].ptr;
434 ulong newaddr = patchto ? (patchto + patchoff) : 0;
436 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
441 efi_update_table_header_crc32(&efi_runtime_services.hdr);
444 /* Relocate EFI runtime to uboot_reloc_base = offset */
445 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
448 struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
450 struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
451 static ulong lastoff = CONFIG_SYS_TEXT_BASE;
454 debug("%s: Relocating to offset=%lx\n", __func__, offset);
455 for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
456 ulong base = CONFIG_SYS_TEXT_BASE;
460 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
462 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__,
463 rel->info, *p, rel->offset);
465 switch (rel->info & R_MASK) {
468 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
470 newaddr = *p - lastoff + offset;
475 ulong symidx = rel->info >> SYM_INDEX;
476 extern struct dyn_sym __dyn_sym_start[];
477 newaddr = __dyn_sym_start[symidx].addr + offset;
479 newaddr -= CONFIG_SYS_TEXT_BASE;
485 if (!efi_runtime_tobedetached(p))
486 printf("%s: Unknown relocation type %llx\n",
487 __func__, rel->info & R_MASK);
491 /* Check if the relocation is inside bounds */
492 if (map && ((newaddr < map->virtual_start) ||
493 newaddr > (map->virtual_start +
494 (map->num_pages << EFI_PAGE_SHIFT)))) {
495 if (!efi_runtime_tobedetached(p))
496 printf("%s: Relocation at %p is out of "
497 "range (%lx)\n", __func__, p, newaddr);
501 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
503 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
504 ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
511 invalidate_icache_all();
515 * efi_set_virtual_address_map() - change from physical to virtual mapping
517 * This function implements the SetVirtualAddressMap() runtime service.
519 * See the Unified Extensible Firmware Interface (UEFI) specification for
522 * @memory_map_size: size of the virtual map
523 * @descriptor_size: size of an entry in the map
524 * @descriptor_version: version of the map entries
525 * @virtmap: virtual address mapping information
526 * Return: status code
528 static efi_status_t EFIAPI efi_set_virtual_address_map(
529 unsigned long memory_map_size,
530 unsigned long descriptor_size,
531 uint32_t descriptor_version,
532 struct efi_mem_desc *virtmap)
534 int n = memory_map_size / descriptor_size;
536 int rt_code_sections = 0;
538 EFI_ENTRY("%lx %lx %x %p", memory_map_size, descriptor_size,
539 descriptor_version, virtmap);
543 * Further down we are cheating. While really we should implement
544 * SetVirtualAddressMap() events and ConvertPointer() to allow
545 * dynamically loaded drivers to expose runtime services, we don't
548 * So let's ensure we see exactly one single runtime section, as
549 * that is the built-in one. If we see more (or less), someone must
550 * have tried adding or removing to that which we don't support yet.
551 * In that case, let's better fail rather than expose broken runtime
554 for (i = 0; i < n; i++) {
555 struct efi_mem_desc *map = (void*)virtmap +
556 (descriptor_size * i);
558 if (map->type == EFI_RUNTIME_SERVICES_CODE)
562 if (rt_code_sections != 1) {
564 * We expose exactly one single runtime code section, so
565 * something is definitely going wrong.
567 return EFI_EXIT(EFI_INVALID_PARAMETER);
570 /* Rebind mmio pointers */
571 for (i = 0; i < n; i++) {
572 struct efi_mem_desc *map = (void*)virtmap +
573 (descriptor_size * i);
574 struct list_head *lhandle;
575 efi_physical_addr_t map_start = map->physical_start;
576 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
577 efi_physical_addr_t map_end = map_start + map_len;
578 u64 off = map->virtual_start - map_start;
580 /* Adjust all mmio pointers in this region */
581 list_for_each(lhandle, &efi_runtime_mmio) {
582 struct efi_runtime_mmio_list *lmmio;
584 lmmio = list_entry(lhandle,
585 struct efi_runtime_mmio_list,
587 if ((map_start <= lmmio->paddr) &&
588 (map_end >= lmmio->paddr)) {
589 uintptr_t new_addr = lmmio->paddr + off;
590 *lmmio->ptr = (void *)new_addr;
593 if ((map_start <= (uintptr_t)systab.tables) &&
594 (map_end >= (uintptr_t)systab.tables)) {
595 char *ptr = (char *)systab.tables;
598 systab.tables = (struct efi_configuration_table *)ptr;
602 /* Move the actual runtime code over */
603 for (i = 0; i < n; i++) {
604 struct efi_mem_desc *map;
606 map = (void*)virtmap + (descriptor_size * i);
607 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
608 ulong new_offset = map->virtual_start -
609 map->physical_start + gd->relocaddr;
611 efi_runtime_relocate(new_offset, map);
612 /* Once we're virtual, we can no longer handle
614 efi_runtime_detach(new_offset);
615 return EFI_EXIT(EFI_SUCCESS);
619 return EFI_EXIT(EFI_INVALID_PARAMETER);
623 * efi_add_runtime_mmio() - add memory-mapped IO region
625 * This function adds a memory-mapped IO region to the memory map to make it
626 * available at runtime.
628 * @mmio_ptr: pointer to a pointer to the start of the memory-mapped
630 * @len: size of the memory-mapped IO region
631 * Returns: status code
633 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
635 struct efi_runtime_mmio_list *newmmio;
636 u64 pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
637 uint64_t addr = *(uintptr_t *)mmio_ptr;
640 retaddr = efi_add_memory_map(addr, pages, EFI_MMAP_IO, false);
642 return EFI_OUT_OF_RESOURCES;
644 newmmio = calloc(1, sizeof(*newmmio));
646 return EFI_OUT_OF_RESOURCES;
647 newmmio->ptr = mmio_ptr;
648 newmmio->paddr = *(uintptr_t *)mmio_ptr;
650 list_add_tail(&newmmio->link, &efi_runtime_mmio);
656 * In the second stage, U-Boot has disappeared. To isolate our runtime code
657 * that at this point still exists from the rest, we put it into a special
662 * This means that we can not rely on any code outside of this file in any
663 * function or variable below this line.
665 * Please keep everything fully self-contained and annotated with
666 * __efi_runtime and __efi_runtime_data markers.
670 * Relocate the EFI runtime stub to a different place. We need to call this
671 * the first time we expose the runtime interface to a user and on set virtual
676 * efi_unimplemented() - replacement function, returns EFI_UNSUPPORTED
678 * This function is used after SetVirtualAddressMap() is called as replacement
679 * for services that are not available anymore due to constraints of the U-Boot
682 * Return: EFI_UNSUPPORTED
684 static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
686 return EFI_UNSUPPORTED;
690 * efi_device_error() - replacement function, returns EFI_DEVICE_ERROR
692 * This function is used after SetVirtualAddressMap() is called as replacement
693 * for services that are not available anymore due to constraints of the U-Boot
696 * Return: EFI_DEVICE_ERROR
698 static efi_status_t __efi_runtime EFIAPI efi_device_error(void)
700 return EFI_DEVICE_ERROR;
704 * efi_invalid_parameter() - replacement function, returns EFI_INVALID_PARAMETER
706 * This function is used after SetVirtualAddressMap() is called as replacement
707 * for services that are not available anymore due to constraints of the U-Boot
710 * Return: EFI_INVALID_PARAMETER
712 static efi_status_t __efi_runtime EFIAPI efi_invalid_parameter(void)
714 return EFI_INVALID_PARAMETER;
718 * efi_update_capsule() - process information from operating system
720 * This function implements the UpdateCapsule() runtime service.
722 * See the Unified Extensible Firmware Interface (UEFI) specification for
725 * @capsule_header_array: pointer to array of virtual pointers
726 * @capsule_count: number of pointers in capsule_header_array
727 * @scatter_gather_list: pointer to arry of physical pointers
728 * Returns: status code
730 efi_status_t __efi_runtime EFIAPI efi_update_capsule(
731 struct efi_capsule_header **capsule_header_array,
732 efi_uintn_t capsule_count,
733 u64 scatter_gather_list)
735 return EFI_UNSUPPORTED;
739 * efi_query_capsule_caps() - check if capsule is supported
741 * This function implements the QueryCapsuleCapabilities() runtime service.
743 * See the Unified Extensible Firmware Interface (UEFI) specification for
746 * @capsule_header_array: pointer to array of virtual pointers
747 * @capsule_count: number of pointers in capsule_header_array
748 * @maximum_capsule_size: maximum capsule size
749 * @reset_type: type of reset needed for capsule update
750 * Returns: status code
752 efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
753 struct efi_capsule_header **capsule_header_array,
754 efi_uintn_t capsule_count,
755 u64 *maximum_capsule_size,
758 return EFI_UNSUPPORTED;
762 * efi_query_variable_info() - get information about EFI variables
764 * This function implements the QueryVariableInfo() runtime service.
766 * See the Unified Extensible Firmware Interface (UEFI) specification for
769 * @attributes: bitmask to select variables to be
771 * @maximum_variable_storage_size: maximum size of storage area for the
772 * selected variable types
773 * @remaining_variable_storage_size: remaining size of storage are for the
774 * selected variable types
775 * @maximum_variable_size: maximum size of a variable of the
777 * Returns: status code
779 efi_status_t __efi_runtime EFIAPI efi_query_variable_info(
781 u64 *maximum_variable_storage_size,
782 u64 *remaining_variable_storage_size,
783 u64 *maximum_variable_size)
785 return EFI_UNSUPPORTED;
788 struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
790 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
791 .revision = EFI_SPECIFICATION_VERSION,
792 .headersize = sizeof(struct efi_runtime_services),
794 .get_time = &efi_get_time_boottime,
795 .set_time = &efi_set_time_boottime,
796 .get_wakeup_time = (void *)&efi_unimplemented,
797 .set_wakeup_time = (void *)&efi_unimplemented,
798 .set_virtual_address_map = &efi_set_virtual_address_map,
799 .convert_pointer = (void *)&efi_invalid_parameter,
800 .get_variable = efi_get_variable,
801 .get_next_variable_name = efi_get_next_variable_name,
802 .set_variable = efi_set_variable,
803 .get_next_high_mono_count = (void *)&efi_device_error,
804 .reset_system = &efi_reset_system_boottime,
805 .update_capsule = efi_update_capsule,
806 .query_capsule_caps = efi_query_capsule_caps,
807 .query_variable_info = efi_query_variable_info,