2 * Copyright (c) 2004 Marcel Moolenaar
3 * Copyright (c) 2001 Doug Rabson
4 * Copyright (c) 2016, 2018 The FreeBSD Foundation
7 * Portions of this software were developed by Konstantin Belousov
8 * under sponsorship from the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/eventhandler.h>
38 #include <sys/kernel.h>
39 #include <sys/linker.h>
41 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <sys/clock.h>
45 #include <sys/reboot.h>
46 #include <sys/rwlock.h>
47 #include <sys/sched.h>
48 #include <sys/sysctl.h>
49 #include <sys/systm.h>
50 #include <sys/vmmeter.h>
52 #include <machine/fpu.h>
53 #include <machine/efi.h>
54 #include <machine/metadata.h>
55 #include <machine/vmparam.h>
59 #include <vm/vm_map.h>
61 static struct efi_systbl *efi_systbl;
62 static eventhandler_tag efi_shutdown_tag;
64 * The following pointers point to tables in the EFI runtime service data pages.
65 * Care should be taken to make sure that we've properly entered the EFI runtime
66 * environment (efi_enter()) before dereferencing them.
68 static struct efi_cfgtbl *efi_cfgtbl;
69 static struct efi_rt *efi_runtime;
71 static int efi_status2err[25] = {
73 ENOEXEC, /* EFI_LOAD_ERROR */
74 EINVAL, /* EFI_INVALID_PARAMETER */
75 ENOSYS, /* EFI_UNSUPPORTED */
76 EMSGSIZE, /* EFI_BAD_BUFFER_SIZE */
77 EOVERFLOW, /* EFI_BUFFER_TOO_SMALL */
78 EBUSY, /* EFI_NOT_READY */
79 EIO, /* EFI_DEVICE_ERROR */
80 EROFS, /* EFI_WRITE_PROTECTED */
81 EAGAIN, /* EFI_OUT_OF_RESOURCES */
82 EIO, /* EFI_VOLUME_CORRUPTED */
83 ENOSPC, /* EFI_VOLUME_FULL */
84 ENXIO, /* EFI_NO_MEDIA */
85 ESTALE, /* EFI_MEDIA_CHANGED */
86 ENOENT, /* EFI_NOT_FOUND */
87 EACCES, /* EFI_ACCESS_DENIED */
88 ETIMEDOUT, /* EFI_NO_RESPONSE */
89 EADDRNOTAVAIL, /* EFI_NO_MAPPING */
90 ETIMEDOUT, /* EFI_TIMEOUT */
91 EDOOFUS, /* EFI_NOT_STARTED */
92 EALREADY, /* EFI_ALREADY_STARTED */
93 ECANCELED, /* EFI_ABORTED */
94 EPROTO, /* EFI_ICMP_ERROR */
95 EPROTO, /* EFI_TFTP_ERROR */
96 EPROTO /* EFI_PROTOCOL_ERROR */
99 static int efi_enter(void);
100 static void efi_leave(void);
103 efi_status_to_errno(efi_status status)
107 code = status & 0x3ffffffffffffffful;
108 return (code < nitems(efi_status2err) ? efi_status2err[code] : EDOOFUS);
111 static struct mtx efi_lock;
112 static SYSCTL_NODE(_hw, OID_AUTO, efi, CTLFLAG_RWTUN, NULL, "EFI");
113 static bool efi_poweroff = true;
114 SYSCTL_BOOL(_hw_efi, OID_AUTO, poweroff, CTLFLAG_RWTUN, &efi_poweroff, 0,
115 "If true, use EFI runtime services to power off in preference to ACPI");
118 efi_is_in_map(struct efi_md *map, int ndesc, int descsz, vm_offset_t addr)
123 for (i = 0, p = map; i < ndesc; i++, p = efi_next_descriptor(p,
125 if ((p->md_attr & EFI_MD_ATTR_RT) == 0)
128 if (addr >= (uintptr_t)p->md_virt &&
129 addr < (uintptr_t)p->md_virt + p->md_pages * PAGE_SIZE)
137 efi_shutdown_final(void *dummy __unused, int howto)
141 * On some systems, ACPI S5 is missing or does not function properly.
142 * When present, shutdown via EFI Runtime Services instead, unless
145 if ((howto & RB_POWEROFF) != 0 && efi_poweroff)
146 (void)efi_reset_system(EFI_RESET_SHUTDOWN);
152 struct efi_map_header *efihdr;
157 int ndesc, rt_disabled;
160 TUNABLE_INT_FETCH("efi.rt.disabled", &rt_disabled);
161 if (rt_disabled == 1)
163 mtx_init(&efi_lock, "efi", NULL, MTX_DEF);
165 if (efi_systbl_phys == 0) {
167 printf("EFI systbl not available\n");
171 efi_systbl = (struct efi_systbl *)efi_phys_to_kva(efi_systbl_phys);
172 if (efi_systbl == NULL || efi_systbl->st_hdr.th_sig != EFI_SYSTBL_SIG) {
175 printf("EFI systbl signature invalid\n");
178 efi_cfgtbl = (efi_systbl->st_cfgtbl == 0) ? NULL :
179 (struct efi_cfgtbl *)efi_systbl->st_cfgtbl;
180 if (efi_cfgtbl == NULL) {
182 printf("EFI config table is not present\n");
185 kmdp = preload_search_by_type("elf kernel");
187 kmdp = preload_search_by_type("elf64 kernel");
188 efihdr = (struct efi_map_header *)preload_search_info(kmdp,
189 MODINFO_METADATA | MODINFOMD_EFI_MAP);
190 if (efihdr == NULL) {
192 printf("EFI map is not present\n");
195 efisz = (sizeof(struct efi_map_header) + 0xf) & ~0xf;
196 map = (struct efi_md *)((uint8_t *)efihdr + efisz);
197 if (efihdr->descriptor_size == 0)
200 ndesc = efihdr->memory_size / efihdr->descriptor_size;
201 if (!efi_create_1t1_map(map, ndesc, efihdr->descriptor_size)) {
203 printf("EFI cannot create runtime map\n");
207 efi_runtime = (efi_systbl->st_rt == 0) ? NULL :
208 (struct efi_rt *)efi_systbl->st_rt;
209 if (efi_runtime == NULL) {
211 printf("EFI runtime services table is not present\n");
212 efi_destroy_1t1_map();
216 #if defined(__aarch64__) || defined(__amd64__)
218 * Some UEFI implementations have multiple implementations of the
219 * RS->GetTime function. They switch from one we can only use early
220 * in the boot process to one valid as a RunTime service only when we
221 * call RS->SetVirtualAddressMap. As this is not always the case, e.g.
222 * with an old loader.efi, check if the RS->GetTime function is within
223 * the EFI map, and fail to attach if not.
225 rtdm = (struct efi_rt *)efi_phys_to_kva((uintptr_t)efi_runtime);
226 if (rtdm == NULL || !efi_is_in_map(map, ndesc, efihdr->descriptor_size,
227 (vm_offset_t)rtdm->rt_gettime)) {
230 "EFI runtime services table has an invalid pointer\n");
232 efi_destroy_1t1_map();
238 * We use SHUTDOWN_PRI_LAST - 1 to trigger after IPMI, but before ACPI.
240 efi_shutdown_tag = EVENTHANDLER_REGISTER(shutdown_final,
241 efi_shutdown_final, NULL, SHUTDOWN_PRI_LAST - 1);
250 /* Most likely disabled by tunable */
251 if (efi_runtime == NULL)
253 if (efi_shutdown_tag != NULL)
254 EVENTHANDLER_DEREGISTER(shutdown_final, efi_shutdown_tag);
255 efi_destroy_1t1_map();
261 mtx_destroy(&efi_lock);
268 if (efi_runtime == NULL)
280 if (efi_runtime == NULL)
283 curpmap = &td->td_proc->p_vmspace->vm_pmap;
286 fpu_kern_enter(td, NULL, FPU_KERN_NOCTX);
287 error = efi_arch_enter();
289 fpu_kern_leave(td, NULL);
290 mtx_unlock(&efi_lock);
291 PMAP_UNLOCK(curpmap);
304 curpmap = &curproc->p_vmspace->vm_pmap;
306 fpu_kern_leave(td, NULL);
307 mtx_unlock(&efi_lock);
308 PMAP_UNLOCK(curpmap);
312 efi_get_table(struct uuid *uuid, void **ptr)
314 struct efi_cfgtbl *ct;
317 if (efi_cfgtbl == NULL || efi_systbl == NULL)
319 count = efi_systbl->st_entries;
322 if (!bcmp(&ct->ct_uuid, uuid, sizeof(*uuid))) {
323 *ptr = (void *)efi_phys_to_kva(ct->ct_data);
331 static int efi_rt_handle_faults = EFI_RT_HANDLE_FAULTS_DEFAULT;
332 SYSCTL_INT(_machdep, OID_AUTO, efi_rt_handle_faults, CTLFLAG_RWTUN,
333 &efi_rt_handle_faults, 0,
334 "Call EFI RT methods with fault handler wrapper around");
337 efi_rt_arch_call_nofault(struct efirt_callinfo *ec)
340 switch (ec->ec_argcnt) {
342 ec->ec_efi_status = ((register_t (*)(void))ec->ec_fptr)();
345 ec->ec_efi_status = ((register_t (*)(register_t))ec->ec_fptr)
349 ec->ec_efi_status = ((register_t (*)(register_t, register_t))
350 ec->ec_fptr)(ec->ec_arg1, ec->ec_arg2);
353 ec->ec_efi_status = ((register_t (*)(register_t, register_t,
354 register_t))ec->ec_fptr)(ec->ec_arg1, ec->ec_arg2,
358 ec->ec_efi_status = ((register_t (*)(register_t, register_t,
359 register_t, register_t))ec->ec_fptr)(ec->ec_arg1,
360 ec->ec_arg2, ec->ec_arg3, ec->ec_arg4);
363 ec->ec_efi_status = ((register_t (*)(register_t, register_t,
364 register_t, register_t, register_t))ec->ec_fptr)(
365 ec->ec_arg1, ec->ec_arg2, ec->ec_arg3, ec->ec_arg4,
369 panic("efi_rt_arch_call: %d args", (int)ec->ec_argcnt);
376 efi_call(struct efirt_callinfo *ecp)
383 error = efi_rt_handle_faults ? efi_rt_arch_call(ecp) :
384 efi_rt_arch_call_nofault(ecp);
387 error = efi_status_to_errno(ecp->ec_efi_status);
388 else if (bootverbose)
389 printf("EFI %s call faulted, error %d\n", ecp->ec_name, error);
393 #define EFI_RT_METHOD_PA(method) \
394 ((uintptr_t)((struct efi_rt *)efi_phys_to_kva((uintptr_t) \
395 efi_runtime))->method)
398 efi_get_time_locked(struct efi_tm *tm, struct efi_tmcap *tmcap)
400 struct efirt_callinfo ec;
403 if (efi_runtime == NULL)
405 bzero(&ec, sizeof(ec));
406 ec.ec_name = "rt_gettime";
408 ec.ec_arg1 = (uintptr_t)tm;
409 ec.ec_arg2 = (uintptr_t)tmcap;
410 ec.ec_fptr = EFI_RT_METHOD_PA(rt_gettime);
411 return (efi_call(&ec));
415 efi_get_time(struct efi_tm *tm)
417 struct efi_tmcap dummy;
420 if (efi_runtime == NULL)
424 * UEFI spec states that the Capabilities argument to GetTime is
425 * optional, but some UEFI implementations choke when passed a NULL
426 * pointer. Pass a dummy efi_tmcap, even though we won't use it,
427 * to workaround such implementations.
429 error = efi_get_time_locked(tm, &dummy);
435 efi_get_time_capabilities(struct efi_tmcap *tmcap)
440 if (efi_runtime == NULL)
443 error = efi_get_time_locked(&dummy, tmcap);
449 efi_reset_system(enum efi_reset type)
451 struct efirt_callinfo ec;
456 case EFI_RESET_SHUTDOWN:
461 if (efi_runtime == NULL)
463 bzero(&ec, sizeof(ec));
464 ec.ec_name = "rt_reset";
466 ec.ec_arg1 = (uintptr_t)type;
467 ec.ec_arg2 = (uintptr_t)0;
468 ec.ec_arg3 = (uintptr_t)0;
469 ec.ec_arg4 = (uintptr_t)NULL;
470 ec.ec_fptr = EFI_RT_METHOD_PA(rt_reset);
471 return (efi_call(&ec));
475 efi_set_time_locked(struct efi_tm *tm)
477 struct efirt_callinfo ec;
480 if (efi_runtime == NULL)
482 bzero(&ec, sizeof(ec));
483 ec.ec_name = "rt_settime";
485 ec.ec_arg1 = (uintptr_t)tm;
486 ec.ec_fptr = EFI_RT_METHOD_PA(rt_settime);
487 return (efi_call(&ec));
491 efi_set_time(struct efi_tm *tm)
495 if (efi_runtime == NULL)
498 error = efi_set_time_locked(tm);
504 efi_var_get(efi_char *name, struct uuid *vendor, uint32_t *attrib,
505 size_t *datasize, void *data)
507 struct efirt_callinfo ec;
509 if (efi_runtime == NULL)
511 bzero(&ec, sizeof(ec));
513 ec.ec_name = "rt_getvar";
514 ec.ec_arg1 = (uintptr_t)name;
515 ec.ec_arg2 = (uintptr_t)vendor;
516 ec.ec_arg3 = (uintptr_t)attrib;
517 ec.ec_arg4 = (uintptr_t)datasize;
518 ec.ec_arg5 = (uintptr_t)data;
519 ec.ec_fptr = EFI_RT_METHOD_PA(rt_getvar);
520 return (efi_call(&ec));
524 efi_var_nextname(size_t *namesize, efi_char *name, struct uuid *vendor)
526 struct efirt_callinfo ec;
528 if (efi_runtime == NULL)
530 bzero(&ec, sizeof(ec));
532 ec.ec_name = "rt_scanvar";
533 ec.ec_arg1 = (uintptr_t)namesize;
534 ec.ec_arg2 = (uintptr_t)name;
535 ec.ec_arg3 = (uintptr_t)vendor;
536 ec.ec_fptr = EFI_RT_METHOD_PA(rt_scanvar);
537 return (efi_call(&ec));
541 efi_var_set(efi_char *name, struct uuid *vendor, uint32_t attrib,
542 size_t datasize, void *data)
544 struct efirt_callinfo ec;
546 if (efi_runtime == NULL)
548 bzero(&ec, sizeof(ec));
550 ec.ec_name = "rt_setvar";
551 ec.ec_arg1 = (uintptr_t)name;
552 ec.ec_arg2 = (uintptr_t)vendor;
553 ec.ec_arg3 = (uintptr_t)attrib;
554 ec.ec_arg4 = (uintptr_t)datasize;
555 ec.ec_arg5 = (uintptr_t)data;
556 ec.ec_fptr = EFI_RT_METHOD_PA(rt_setvar);
557 return (efi_call(&ec));
561 efirt_modevents(module_t m, int event, void *arg __unused)
580 static moduledata_t efirt_moddata = {
582 .evhand = efirt_modevents,
585 /* After fpuinitstate, before efidev */
586 DECLARE_MODULE(efirt, efirt_moddata, SI_SUB_DRIVERS, SI_ORDER_SECOND);
587 MODULE_VERSION(efirt, 1);