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;
176 EFI_ENTRY("%p %p", time, capabilities);
179 ret = EFI_INVALID_PARAMETER;
183 r = uclass_get_device(UCLASS_RTC, 0, &dev);
185 r = 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_DEVICE_ERROR);
219 * efi_reset_system() - reset system
221 * This function implements the ResetSystem() runtime service after
222 * SetVirtualAddressMap() is called. It only executes an endless loop.
223 * Boards may override the helpers below to implement reset functionality.
225 * See the Unified Extensible Firmware Interface (UEFI) specification for
228 * @reset_type: type of reset to perform
229 * @reset_status: status code for the reset
230 * @data_size: size of reset_data
231 * @reset_data: information about the reset
233 void __weak __efi_runtime EFIAPI efi_reset_system(
234 enum efi_reset_type reset_type,
235 efi_status_t reset_status,
236 unsigned long data_size, void *reset_data)
238 /* Nothing we can do */
243 * efi_reset_system_init() - initialize the reset driver
245 * Boards may override this function to initialize the reset driver.
247 efi_status_t __weak efi_reset_system_init(void)
253 * efi_get_time() - get current time
255 * This function implements the GetTime runtime service after
256 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
257 * anymore only an error code is returned.
259 * See the Unified Extensible Firmware Interface (UEFI) specification
262 * @time: pointer to structure to receive current time
263 * @capabilities: pointer to structure to receive RTC properties
264 * Returns: status code
266 efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
267 struct efi_time *time,
268 struct efi_time_cap *capabilities)
270 /* Nothing we can do */
271 return EFI_DEVICE_ERROR;
274 struct efi_runtime_detach_list_struct {
279 static const struct efi_runtime_detach_list_struct efi_runtime_detach_list[] = {
281 /* do_reset is gone */
282 .ptr = &efi_runtime_services.reset_system,
283 .patchto = efi_reset_system,
285 /* invalidate_*cache_all are gone */
286 .ptr = &efi_runtime_services.set_virtual_address_map,
287 .patchto = &efi_unimplemented,
289 /* RTC accessors are gone */
290 .ptr = &efi_runtime_services.get_time,
291 .patchto = &efi_get_time,
293 /* Clean up system table */
294 .ptr = &systab.con_in,
297 /* Clean up system table */
298 .ptr = &systab.con_out,
301 /* Clean up system table */
302 .ptr = &systab.std_err,
305 /* Clean up system table */
306 .ptr = &systab.boottime,
309 .ptr = &efi_runtime_services.get_variable,
310 .patchto = &efi_device_error,
312 .ptr = &efi_runtime_services.get_next_variable_name,
313 .patchto = &efi_device_error,
315 .ptr = &efi_runtime_services.set_variable,
316 .patchto = &efi_device_error,
320 static bool efi_runtime_tobedetached(void *p)
324 for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++)
325 if (efi_runtime_detach_list[i].ptr == p)
331 static void efi_runtime_detach(ulong offset)
334 ulong patchoff = offset - (ulong)gd->relocaddr;
336 for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++) {
337 ulong patchto = (ulong)efi_runtime_detach_list[i].patchto;
338 ulong *p = efi_runtime_detach_list[i].ptr;
339 ulong newaddr = patchto ? (patchto + patchoff) : 0;
341 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
346 efi_update_table_header_crc32(&efi_runtime_services.hdr);
349 /* Relocate EFI runtime to uboot_reloc_base = offset */
350 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
353 struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
355 struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
356 static ulong lastoff = CONFIG_SYS_TEXT_BASE;
359 debug("%s: Relocating to offset=%lx\n", __func__, offset);
360 for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
361 ulong base = CONFIG_SYS_TEXT_BASE;
365 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
367 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__,
368 rel->info, *p, rel->offset);
370 switch (rel->info & R_MASK) {
373 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
375 newaddr = *p - lastoff + offset;
380 ulong symidx = rel->info >> SYM_INDEX;
381 extern struct dyn_sym __dyn_sym_start[];
382 newaddr = __dyn_sym_start[symidx].addr + offset;
384 newaddr -= CONFIG_SYS_TEXT_BASE;
390 if (!efi_runtime_tobedetached(p))
391 printf("%s: Unknown relocation type %llx\n",
392 __func__, rel->info & R_MASK);
396 /* Check if the relocation is inside bounds */
397 if (map && ((newaddr < map->virtual_start) ||
398 newaddr > (map->virtual_start +
399 (map->num_pages << EFI_PAGE_SHIFT)))) {
400 if (!efi_runtime_tobedetached(p))
401 printf("%s: Relocation at %p is out of "
402 "range (%lx)\n", __func__, p, newaddr);
406 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
408 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
409 ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
416 invalidate_icache_all();
420 * efi_set_virtual_address_map() - change from physical to virtual mapping
422 * This function implements the SetVirtualAddressMap() runtime service.
424 * See the Unified Extensible Firmware Interface (UEFI) specification for
427 * @memory_map_size: size of the virtual map
428 * @descriptor_size: size of an entry in the map
429 * @descriptor_version: version of the map entries
430 * @virtmap: virtual address mapping information
431 * Return: status code
433 static efi_status_t EFIAPI efi_set_virtual_address_map(
434 unsigned long memory_map_size,
435 unsigned long descriptor_size,
436 uint32_t descriptor_version,
437 struct efi_mem_desc *virtmap)
439 ulong runtime_start = (ulong)&__efi_runtime_start &
440 ~(ulong)EFI_PAGE_MASK;
441 int n = memory_map_size / descriptor_size;
444 EFI_ENTRY("%lx %lx %x %p", memory_map_size, descriptor_size,
445 descriptor_version, virtmap);
447 /* Rebind mmio pointers */
448 for (i = 0; i < n; i++) {
449 struct efi_mem_desc *map = (void*)virtmap +
450 (descriptor_size * i);
451 struct list_head *lhandle;
452 efi_physical_addr_t map_start = map->physical_start;
453 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
454 efi_physical_addr_t map_end = map_start + map_len;
455 u64 off = map->virtual_start - map_start;
457 /* Adjust all mmio pointers in this region */
458 list_for_each(lhandle, &efi_runtime_mmio) {
459 struct efi_runtime_mmio_list *lmmio;
461 lmmio = list_entry(lhandle,
462 struct efi_runtime_mmio_list,
464 if ((map_start <= lmmio->paddr) &&
465 (map_end >= lmmio->paddr)) {
466 uintptr_t new_addr = lmmio->paddr + off;
467 *lmmio->ptr = (void *)new_addr;
470 if ((map_start <= (uintptr_t)systab.tables) &&
471 (map_end >= (uintptr_t)systab.tables)) {
472 char *ptr = (char *)systab.tables;
475 systab.tables = (struct efi_configuration_table *)ptr;
479 /* Move the actual runtime code over */
480 for (i = 0; i < n; i++) {
481 struct efi_mem_desc *map;
483 map = (void*)virtmap + (descriptor_size * i);
484 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
485 ulong new_offset = map->virtual_start -
486 (runtime_start - gd->relocaddr);
488 efi_runtime_relocate(new_offset, map);
489 /* Once we're virtual, we can no longer handle
491 efi_runtime_detach(new_offset);
492 return EFI_EXIT(EFI_SUCCESS);
496 return EFI_EXIT(EFI_INVALID_PARAMETER);
500 * efi_add_runtime_mmio() - add memory-mapped IO region
502 * This function adds a memory-mapped IO region to the memory map to make it
503 * available at runtime.
505 * @mmio_ptr: address of the memory-mapped IO region
506 * @len: size of the memory-mapped IO region
507 * Returns: status code
509 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
511 struct efi_runtime_mmio_list *newmmio;
512 u64 pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
513 uint64_t addr = *(uintptr_t *)mmio_ptr;
516 retaddr = efi_add_memory_map(addr, pages, EFI_MMAP_IO, false);
518 return EFI_OUT_OF_RESOURCES;
520 newmmio = calloc(1, sizeof(*newmmio));
522 return EFI_OUT_OF_RESOURCES;
523 newmmio->ptr = mmio_ptr;
524 newmmio->paddr = *(uintptr_t *)mmio_ptr;
526 list_add_tail(&newmmio->link, &efi_runtime_mmio);
532 * In the second stage, U-Boot has disappeared. To isolate our runtime code
533 * that at this point still exists from the rest, we put it into a special
538 * This means that we can not rely on any code outside of this file in any
539 * function or variable below this line.
541 * Please keep everything fully self-contained and annotated with
542 * __efi_runtime and __efi_runtime_data markers.
546 * Relocate the EFI runtime stub to a different place. We need to call this
547 * the first time we expose the runtime interface to a user and on set virtual
552 * efi_unimplemented() - replacement function, returns EFI_UNSUPPORTED
554 * This function is used after SetVirtualAddressMap() is called as replacement
555 * for services that are not available anymore due to constraints of the U-Boot
558 * Return: EFI_UNSUPPORTED
560 static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
562 return EFI_UNSUPPORTED;
566 * efi_device_error() - replacement function, returns EFI_DEVICE_ERROR
568 * This function is used after SetVirtualAddressMap() is called as replacement
569 * for services that are not available anymore due to constraints of the U-Boot
572 * Return: EFI_DEVICE_ERROR
574 static efi_status_t __efi_runtime EFIAPI efi_device_error(void)
576 return EFI_DEVICE_ERROR;
580 * efi_invalid_parameter() - replacement function, returns EFI_INVALID_PARAMETER
582 * This function is used after SetVirtualAddressMap() is called as replacement
583 * for services that are not available anymore due to constraints of the U-Boot
586 * Return: EFI_INVALID_PARAMETER
588 static efi_status_t __efi_runtime EFIAPI efi_invalid_parameter(void)
590 return EFI_INVALID_PARAMETER;
594 * efi_update_capsule() - process information from operating system
596 * This function implements the UpdateCapsule() runtime service.
598 * See the Unified Extensible Firmware Interface (UEFI) specification for
601 * @capsule_header_array: pointer to array of virtual pointers
602 * @capsule_count: number of pointers in capsule_header_array
603 * @scatter_gather_list: pointer to arry of physical pointers
604 * Returns: status code
606 efi_status_t __efi_runtime EFIAPI efi_update_capsule(
607 struct efi_capsule_header **capsule_header_array,
608 efi_uintn_t capsule_count,
609 u64 scatter_gather_list)
611 return EFI_UNSUPPORTED;
615 * efi_query_capsule_caps() - check if capsule is supported
617 * This function implements the QueryCapsuleCapabilities() runtime service.
619 * See the Unified Extensible Firmware Interface (UEFI) specification for
622 * @capsule_header_array: pointer to array of virtual pointers
623 * @capsule_count: number of pointers in capsule_header_array
624 * @maximum_capsule_size: maximum capsule size
625 * @reset_type: type of reset needed for capsule update
626 * Returns: status code
628 efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
629 struct efi_capsule_header **capsule_header_array,
630 efi_uintn_t capsule_count,
631 u64 *maximum_capsule_size,
634 return EFI_UNSUPPORTED;
638 * efi_query_variable_info() - get information about EFI variables
640 * This function implements the QueryVariableInfo() runtime service.
642 * See the Unified Extensible Firmware Interface (UEFI) specification for
645 * @attributes: bitmask to select variables to be
647 * @maximum_variable_storage_size: maximum size of storage area for the
648 * selected variable types
649 * @remaining_variable_storage_size: remaining size of storage are for the
650 * selected variable types
651 * @maximum_variable_size: maximum size of a variable of the
653 * Returns: status code
655 efi_status_t __efi_runtime EFIAPI efi_query_variable_info(
657 u64 *maximum_variable_storage_size,
658 u64 *remaining_variable_storage_size,
659 u64 *maximum_variable_size)
661 return EFI_UNSUPPORTED;
664 struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
666 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
667 .revision = EFI_SPECIFICATION_VERSION,
668 .headersize = sizeof(struct efi_runtime_services),
670 .get_time = &efi_get_time_boottime,
671 .set_time = (void *)&efi_device_error,
672 .get_wakeup_time = (void *)&efi_unimplemented,
673 .set_wakeup_time = (void *)&efi_unimplemented,
674 .set_virtual_address_map = &efi_set_virtual_address_map,
675 .convert_pointer = (void *)&efi_invalid_parameter,
676 .get_variable = efi_get_variable,
677 .get_next_variable_name = efi_get_next_variable_name,
678 .set_variable = efi_set_variable,
679 .get_next_high_mono_count = (void *)&efi_device_error,
680 .reset_system = &efi_reset_system_boottime,
681 .update_capsule = efi_update_capsule,
682 .query_capsule_caps = efi_query_capsule_caps,
683 .query_variable_info = efi_query_variable_info,