1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application runtime services
5 * Copyright (c) 2016 Alexander Graf
11 #include <efi_loader.h>
14 /* For manual relocation support */
15 DECLARE_GLOBAL_DATA_PTR;
17 struct efi_runtime_mmio_list {
18 struct list_head link;
24 /* This list contains all runtime available mmio regions */
25 LIST_HEAD(efi_runtime_mmio);
27 static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void);
28 static efi_status_t __efi_runtime EFIAPI efi_device_error(void);
29 static efi_status_t __efi_runtime EFIAPI efi_invalid_parameter(void);
32 * TODO(sjg@chromium.org): These defines and structs should come from the elf
33 * header for each arch (or a generic header) rather than being repeated here.
35 #if defined(CONFIG_ARM64)
36 #define R_RELATIVE 1027
37 #define R_MASK 0xffffffffULL
39 #elif defined(CONFIG_ARM)
41 #define R_MASK 0xffULL
42 #elif defined(CONFIG_X86)
44 #define R_RELATIVE R_386_RELATIVE
45 #define R_MASK 0xffULL
46 #elif defined(CONFIG_RISCV)
48 #define R_RELATIVE R_RISCV_RELATIVE
49 #define R_MASK 0xffULL
58 #ifdef CONFIG_CPU_RISCV_32
59 #define R_ABSOLUTE R_RISCV_32
62 #define R_ABSOLUTE R_RISCV_64
66 #error Need to add relocation awareness
81 * EFI Runtime code lives in 2 stages. In the first stage, U-Boot and an EFI
82 * payload are running concurrently at the same time. In this mode, we can
83 * handle a good number of runtime callbacks
86 static void EFIAPI efi_reset_system_boottime(
87 enum efi_reset_type reset_type,
88 efi_status_t reset_status,
89 unsigned long data_size, void *reset_data)
91 struct efi_event *evt;
93 EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size,
97 list_for_each_entry(evt, &efi_events, link) {
100 &efi_guid_event_group_reset_system)) {
101 efi_signal_event(evt, false);
105 switch (reset_type) {
108 case EFI_RESET_PLATFORM_SPECIFIC:
109 do_reset(NULL, 0, 0, NULL);
111 case EFI_RESET_SHUTDOWN:
112 /* We don't have anything to map this to */
119 static efi_status_t EFIAPI efi_get_time_boottime(
120 struct efi_time *time,
121 struct efi_time_cap *capabilities)
123 #if defined(CONFIG_CMD_DATE) && defined(CONFIG_DM_RTC)
128 EFI_ENTRY("%p %p", time, capabilities);
130 r = uclass_get_device(UCLASS_RTC, 0, &dev);
132 return EFI_EXIT(EFI_DEVICE_ERROR);
134 r = dm_rtc_get(dev, &tm);
136 return EFI_EXIT(EFI_DEVICE_ERROR);
138 memset(time, 0, sizeof(*time));
139 time->year = tm.tm_year;
140 time->month = tm.tm_mon;
141 time->day = tm.tm_mday;
142 time->hour = tm.tm_hour;
143 time->minute = tm.tm_min;
144 time->daylight = tm.tm_isdst;
146 return EFI_EXIT(EFI_SUCCESS);
148 return EFI_DEVICE_ERROR;
152 /* Boards may override the helpers below to implement RTS functionality */
154 void __weak __efi_runtime EFIAPI efi_reset_system(
155 enum efi_reset_type reset_type,
156 efi_status_t reset_status,
157 unsigned long data_size, void *reset_data)
159 /* Nothing we can do */
163 efi_status_t __weak efi_reset_system_init(void)
168 efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
169 struct efi_time *time,
170 struct efi_time_cap *capabilities)
172 /* Nothing we can do */
173 return EFI_DEVICE_ERROR;
176 efi_status_t __weak efi_get_time_init(void)
181 struct efi_runtime_detach_list_struct {
186 static const struct efi_runtime_detach_list_struct efi_runtime_detach_list[] = {
188 /* do_reset is gone */
189 .ptr = &efi_runtime_services.reset_system,
190 .patchto = efi_reset_system,
192 /* invalidate_*cache_all are gone */
193 .ptr = &efi_runtime_services.set_virtual_address_map,
194 .patchto = &efi_invalid_parameter,
196 /* RTC accessors are gone */
197 .ptr = &efi_runtime_services.get_time,
198 .patchto = &efi_get_time,
200 /* Clean up system table */
201 .ptr = &systab.con_in,
204 /* Clean up system table */
205 .ptr = &systab.con_out,
208 /* Clean up system table */
209 .ptr = &systab.std_err,
212 /* Clean up system table */
213 .ptr = &systab.boottime,
216 .ptr = &efi_runtime_services.get_variable,
217 .patchto = &efi_device_error,
219 .ptr = &efi_runtime_services.get_next_variable_name,
220 .patchto = &efi_device_error,
222 .ptr = &efi_runtime_services.set_variable,
223 .patchto = &efi_device_error,
227 static bool efi_runtime_tobedetached(void *p)
231 for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++)
232 if (efi_runtime_detach_list[i].ptr == p)
238 static void efi_runtime_detach(ulong offset)
241 ulong patchoff = offset - (ulong)gd->relocaddr;
243 for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++) {
244 ulong patchto = (ulong)efi_runtime_detach_list[i].patchto;
245 ulong *p = efi_runtime_detach_list[i].ptr;
246 ulong newaddr = patchto ? (patchto + patchoff) : 0;
248 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
253 /* Relocate EFI runtime to uboot_reloc_base = offset */
254 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
257 struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
259 struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
260 static ulong lastoff = CONFIG_SYS_TEXT_BASE;
263 debug("%s: Relocating to offset=%lx\n", __func__, offset);
264 for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
265 ulong base = CONFIG_SYS_TEXT_BASE;
269 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
271 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__, rel->info, *p, rel->offset);
273 switch (rel->info & R_MASK) {
276 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
278 newaddr = *p - lastoff + offset;
283 ulong symidx = rel->info >> SYM_INDEX;
284 extern struct dyn_sym __dyn_sym_start[];
285 newaddr = __dyn_sym_start[symidx].addr + offset;
293 /* Check if the relocation is inside bounds */
294 if (map && ((newaddr < map->virtual_start) ||
295 newaddr > (map->virtual_start +
296 (map->num_pages << EFI_PAGE_SHIFT)))) {
297 if (!efi_runtime_tobedetached(p))
298 printf("U-Boot EFI: Relocation at %p is out of "
299 "range (%lx)\n", p, newaddr);
303 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
305 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
306 ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
313 invalidate_icache_all();
316 static efi_status_t EFIAPI efi_set_virtual_address_map(
317 unsigned long memory_map_size,
318 unsigned long descriptor_size,
319 uint32_t descriptor_version,
320 struct efi_mem_desc *virtmap)
322 ulong runtime_start = (ulong)&__efi_runtime_start &
323 ~(ulong)EFI_PAGE_MASK;
324 int n = memory_map_size / descriptor_size;
327 EFI_ENTRY("%lx %lx %x %p", memory_map_size, descriptor_size,
328 descriptor_version, virtmap);
330 /* Rebind mmio pointers */
331 for (i = 0; i < n; i++) {
332 struct efi_mem_desc *map = (void*)virtmap +
333 (descriptor_size * i);
334 struct list_head *lhandle;
335 efi_physical_addr_t map_start = map->physical_start;
336 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
337 efi_physical_addr_t map_end = map_start + map_len;
339 /* Adjust all mmio pointers in this region */
340 list_for_each(lhandle, &efi_runtime_mmio) {
341 struct efi_runtime_mmio_list *lmmio;
343 lmmio = list_entry(lhandle,
344 struct efi_runtime_mmio_list,
346 if ((map_start <= lmmio->paddr) &&
347 (map_end >= lmmio->paddr)) {
348 u64 off = map->virtual_start - map_start;
349 uintptr_t new_addr = lmmio->paddr + off;
350 *lmmio->ptr = (void *)new_addr;
355 /* Move the actual runtime code over */
356 for (i = 0; i < n; i++) {
357 struct efi_mem_desc *map;
359 map = (void*)virtmap + (descriptor_size * i);
360 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
361 ulong new_offset = map->virtual_start -
362 (runtime_start - gd->relocaddr);
364 efi_runtime_relocate(new_offset, map);
365 /* Once we're virtual, we can no longer handle
367 efi_runtime_detach(new_offset);
368 return EFI_EXIT(EFI_SUCCESS);
372 return EFI_EXIT(EFI_INVALID_PARAMETER);
375 efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
377 struct efi_runtime_mmio_list *newmmio;
378 u64 pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
379 uint64_t addr = *(uintptr_t *)mmio_ptr;
382 retaddr = efi_add_memory_map(addr, pages, EFI_MMAP_IO, false);
384 return EFI_OUT_OF_RESOURCES;
386 newmmio = calloc(1, sizeof(*newmmio));
388 return EFI_OUT_OF_RESOURCES;
389 newmmio->ptr = mmio_ptr;
390 newmmio->paddr = *(uintptr_t *)mmio_ptr;
392 list_add_tail(&newmmio->link, &efi_runtime_mmio);
398 * In the second stage, U-Boot has disappeared. To isolate our runtime code
399 * that at this point still exists from the rest, we put it into a special
404 * This means that we can not rely on any code outside of this file in any
405 * function or variable below this line.
407 * Please keep everything fully self-contained and annotated with
408 * __efi_runtime and __efi_runtime_data markers.
412 * Relocate the EFI runtime stub to a different place. We need to call this
413 * the first time we expose the runtime interface to a user and on set virtual
417 static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
419 return EFI_UNSUPPORTED;
422 static efi_status_t __efi_runtime EFIAPI efi_device_error(void)
424 return EFI_DEVICE_ERROR;
427 static efi_status_t __efi_runtime EFIAPI efi_invalid_parameter(void)
429 return EFI_INVALID_PARAMETER;
432 efi_status_t __efi_runtime EFIAPI efi_update_capsule(
433 struct efi_capsule_header **capsule_header_array,
434 efi_uintn_t capsule_count,
435 u64 scatter_gather_list)
437 return EFI_UNSUPPORTED;
440 efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
441 struct efi_capsule_header **capsule_header_array,
442 efi_uintn_t capsule_count,
443 u64 maximum_capsule_size,
446 return EFI_UNSUPPORTED;
449 efi_status_t __efi_runtime EFIAPI efi_query_variable_info(
451 u64 *maximum_variable_storage_size,
452 u64 *remaining_variable_storage_size,
453 u64 *maximum_variable_size)
455 return EFI_UNSUPPORTED;
458 struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
460 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
461 .revision = EFI_RUNTIME_SERVICES_REVISION,
462 .headersize = sizeof(struct efi_table_hdr),
464 .get_time = &efi_get_time_boottime,
465 .set_time = (void *)&efi_device_error,
466 .get_wakeup_time = (void *)&efi_unimplemented,
467 .set_wakeup_time = (void *)&efi_unimplemented,
468 .set_virtual_address_map = &efi_set_virtual_address_map,
469 .convert_pointer = (void *)&efi_invalid_parameter,
470 .get_variable = efi_get_variable,
471 .get_next_variable_name = efi_get_next_variable_name,
472 .set_variable = efi_set_variable,
473 .get_next_high_mono_count = (void *)&efi_device_error,
474 .reset_system = &efi_reset_system_boottime,
475 .update_capsule = efi_update_capsule,
476 .query_capsule_caps = efi_query_capsule_caps,
477 .query_variable_info = efi_query_variable_info,