1 /*- 2 * Copyright (c) 2004 Marcel Moolenaar 3 * Copyright (c) 2001 Doug Rabson 4 * Copyright (c) 2016 The FreeBSD Foundation 5 * All rights reserved. 6 * 7 * Portions of this software were developed by Konstantin Belousov 8 * under sponsorship from the FreeBSD Foundation. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 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. 18 * 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 29 * SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 __FBSDID("$FreeBSD$"); 34 35 #include <sys/param.h> 36 #include <sys/efi.h> 37 #include <sys/kernel.h> 38 #include <sys/linker.h> 39 #include <sys/lock.h> 40 #include <sys/module.h> 41 #include <sys/mutex.h> 42 #include <sys/clock.h> 43 #include <sys/proc.h> 44 #include <sys/rwlock.h> 45 #include <sys/sched.h> 46 #include <sys/sysctl.h> 47 #include <sys/systm.h> 48 #include <sys/vmmeter.h> 49 50 #include <machine/fpu.h> 51 #include <machine/efi.h> 52 #include <machine/metadata.h> 53 #include <machine/vmparam.h> 54 55 #include <vm/vm.h> 56 #include <vm/pmap.h> 57 #include <vm/vm_map.h> 58 59 static struct efi_systbl *efi_systbl; 60 /* 61 * The following pointers point to tables in the EFI runtime service data pages. 62 * Care should be taken to make sure that we've properly entered the EFI runtime 63 * environment (efi_enter()) before dereferencing them. 64 */ 65 static struct efi_cfgtbl *efi_cfgtbl; 66 static struct efi_rt *efi_runtime; 67 68 static int efi_status2err[25] = { 69 0, /* EFI_SUCCESS */ 70 ENOEXEC, /* EFI_LOAD_ERROR */ 71 EINVAL, /* EFI_INVALID_PARAMETER */ 72 ENOSYS, /* EFI_UNSUPPORTED */ 73 EMSGSIZE, /* EFI_BAD_BUFFER_SIZE */ 74 EOVERFLOW, /* EFI_BUFFER_TOO_SMALL */ 75 EBUSY, /* EFI_NOT_READY */ 76 EIO, /* EFI_DEVICE_ERROR */ 77 EROFS, /* EFI_WRITE_PROTECTED */ 78 EAGAIN, /* EFI_OUT_OF_RESOURCES */ 79 EIO, /* EFI_VOLUME_CORRUPTED */ 80 ENOSPC, /* EFI_VOLUME_FULL */ 81 ENXIO, /* EFI_NO_MEDIA */ 82 ESTALE, /* EFI_MEDIA_CHANGED */ 83 ENOENT, /* EFI_NOT_FOUND */ 84 EACCES, /* EFI_ACCESS_DENIED */ 85 ETIMEDOUT, /* EFI_NO_RESPONSE */ 86 EADDRNOTAVAIL, /* EFI_NO_MAPPING */ 87 ETIMEDOUT, /* EFI_TIMEOUT */ 88 EDOOFUS, /* EFI_NOT_STARTED */ 89 EALREADY, /* EFI_ALREADY_STARTED */ 90 ECANCELED, /* EFI_ABORTED */ 91 EPROTO, /* EFI_ICMP_ERROR */ 92 EPROTO, /* EFI_TFTP_ERROR */ 93 EPROTO /* EFI_PROTOCOL_ERROR */ 94 }; 95 96 static int efi_enter(void); 97 static void efi_leave(void); 98 99 static int 100 efi_status_to_errno(efi_status status) 101 { 102 u_long code; 103 104 code = status & 0x3ffffffffffffffful; 105 return (code < nitems(efi_status2err) ? efi_status2err[code] : EDOOFUS); 106 } 107 108 static struct mtx efi_lock; 109 110 static bool 111 efi_is_in_map(struct efi_md *map, int ndesc, int descsz, vm_offset_t addr) 112 { 113 struct efi_md *p; 114 int i; 115 116 for (i = 0, p = map; i < ndesc; i++, p = efi_next_descriptor(p, 117 descsz)) { 118 if ((p->md_attr & EFI_MD_ATTR_RT) == 0) 119 continue; 120 121 if (addr >= (uintptr_t)p->md_virt && 122 addr < (uintptr_t)p->md_virt + p->md_pages * PAGE_SIZE) 123 return (true); 124 } 125 126 return (false); 127 } 128 129 static int 130 efi_init(void) 131 { 132 struct efi_map_header *efihdr; 133 struct efi_md *map; 134 caddr_t kmdp; 135 size_t efisz; 136 int rt_disabled; 137 138 rt_disabled = 0; 139 TUNABLE_INT_FETCH("efi.rt_disabled", &rt_disabled); 140 if (rt_disabled == 1) 141 return (0); 142 mtx_init(&efi_lock, "efi", NULL, MTX_DEF); 143 144 if (efi_systbl_phys == 0) { 145 if (bootverbose) 146 printf("EFI systbl not available\n"); 147 return (0); 148 } 149 if (!PMAP_HAS_DMAP) { 150 if (bootverbose) 151 printf("EFI systbl requires direct map\n"); 152 return (0); 153 } 154 efi_systbl = (struct efi_systbl *)PHYS_TO_DMAP(efi_systbl_phys); 155 if (efi_systbl->st_hdr.th_sig != EFI_SYSTBL_SIG) { 156 efi_systbl = NULL; 157 if (bootverbose) 158 printf("EFI systbl signature invalid\n"); 159 return (0); 160 } 161 efi_cfgtbl = (efi_systbl->st_cfgtbl == 0) ? NULL : 162 (struct efi_cfgtbl *)efi_systbl->st_cfgtbl; 163 if (efi_cfgtbl == NULL) { 164 if (bootverbose) 165 printf("EFI config table is not present\n"); 166 } 167 168 kmdp = preload_search_by_type("elf kernel"); 169 if (kmdp == NULL) 170 kmdp = preload_search_by_type("elf64 kernel"); 171 efihdr = (struct efi_map_header *)preload_search_info(kmdp, 172 MODINFO_METADATA | MODINFOMD_EFI_MAP); 173 if (efihdr == NULL) { 174 if (bootverbose) 175 printf("EFI map is not present\n"); 176 return (0); 177 } 178 efisz = (sizeof(struct efi_map_header) + 0xf) & ~0xf; 179 map = (struct efi_md *)((uint8_t *)efihdr + efisz); 180 if (efihdr->descriptor_size == 0) 181 return (ENOMEM); 182 183 if (!efi_create_1t1_map(map, efihdr->memory_size / 184 efihdr->descriptor_size, efihdr->descriptor_size)) { 185 if (bootverbose) 186 printf("EFI cannot create runtime map\n"); 187 return (ENOMEM); 188 } 189 190 efi_runtime = (efi_systbl->st_rt == 0) ? NULL : 191 (struct efi_rt *)efi_systbl->st_rt; 192 if (efi_runtime == NULL) { 193 if (bootverbose) 194 printf("EFI runtime services table is not present\n"); 195 efi_destroy_1t1_map(); 196 return (ENXIO); 197 } 198 199 /* 200 * Some UEFI implementations have multiple implementations of the 201 * RS->GetTime function. They switch from one we can only use early 202 * in the boot process to one valid as a RunTime service only when we 203 * call RS->SetVirtualAddressMap. As this is not always the case, e.g. 204 * with an old loader.efi, check if the RS->GetTime function is within 205 * the EFI map, and fail to attach if not. 206 * 207 * We need to enter into the EFI environment as efi_runtime may point 208 * to an EFI address. 209 */ 210 efi_enter(); 211 if (!efi_is_in_map(map, efihdr->memory_size / efihdr->descriptor_size, 212 efihdr->descriptor_size, (vm_offset_t)efi_runtime->rt_gettime)) { 213 efi_leave(); 214 if (bootverbose) 215 printf( 216 "EFI runtime services table has an invalid pointer\n"); 217 efi_runtime = NULL; 218 efi_destroy_1t1_map(); 219 return (ENXIO); 220 } 221 efi_leave(); 222 223 return (0); 224 } 225 226 static void 227 efi_uninit(void) 228 { 229 230 /* Most likely disabled by tunable */ 231 if (efi_runtime == NULL) 232 return; 233 efi_destroy_1t1_map(); 234 235 efi_systbl = NULL; 236 efi_cfgtbl = NULL; 237 efi_runtime = NULL; 238 239 mtx_destroy(&efi_lock); 240 } 241 242 int 243 efi_rt_ok(void) 244 { 245 246 if (efi_runtime == NULL) 247 return (ENXIO); 248 return (0); 249 } 250 251 static int 252 efi_enter(void) 253 { 254 struct thread *td; 255 pmap_t curpmap; 256 257 if (efi_runtime == NULL) 258 return (ENXIO); 259 td = curthread; 260 curpmap = &td->td_proc->p_vmspace->vm_pmap; 261 PMAP_LOCK(curpmap); 262 mtx_lock(&efi_lock); 263 fpu_kern_enter(td, NULL, FPU_KERN_NOCTX); 264 return (efi_arch_enter()); 265 } 266 267 static void 268 efi_leave(void) 269 { 270 struct thread *td; 271 pmap_t curpmap; 272 273 efi_arch_leave(); 274 275 curpmap = &curproc->p_vmspace->vm_pmap; 276 td = curthread; 277 fpu_kern_leave(td, NULL); 278 mtx_unlock(&efi_lock); 279 PMAP_UNLOCK(curpmap); 280 } 281 282 int 283 efi_get_table(struct uuid *uuid, void **ptr) 284 { 285 struct efi_cfgtbl *ct; 286 u_long count; 287 288 if (efi_cfgtbl == NULL || efi_systbl == NULL) 289 return (ENXIO); 290 count = efi_systbl->st_entries; 291 ct = efi_cfgtbl; 292 while (count--) { 293 if (!bcmp(&ct->ct_uuid, uuid, sizeof(*uuid))) { 294 *ptr = (void *)PHYS_TO_DMAP(ct->ct_data); 295 return (0); 296 } 297 ct++; 298 } 299 return (ENOENT); 300 } 301 302 static int 303 efi_get_time_locked(struct efi_tm *tm, struct efi_tmcap *tmcap) 304 { 305 efi_status status; 306 int error; 307 308 EFI_TIME_OWNED() 309 error = efi_enter(); 310 if (error != 0) 311 return (error); 312 status = efi_runtime->rt_gettime(tm, tmcap); 313 efi_leave(); 314 error = efi_status_to_errno(status); 315 return (error); 316 } 317 318 int 319 efi_get_time(struct efi_tm *tm) 320 { 321 struct efi_tmcap dummy; 322 int error; 323 324 if (efi_runtime == NULL) 325 return (ENXIO); 326 EFI_TIME_LOCK() 327 /* 328 * UEFI spec states that the Capabilities argument to GetTime is 329 * optional, but some UEFI implementations choke when passed a NULL 330 * pointer. Pass a dummy efi_tmcap, even though we won't use it, 331 * to workaround such implementations. 332 */ 333 error = efi_get_time_locked(tm, &dummy); 334 EFI_TIME_UNLOCK() 335 return (error); 336 } 337 338 int 339 efi_get_time_capabilities(struct efi_tmcap *tmcap) 340 { 341 struct efi_tm dummy; 342 int error; 343 344 if (efi_runtime == NULL) 345 return (ENXIO); 346 EFI_TIME_LOCK() 347 error = efi_get_time_locked(&dummy, tmcap); 348 EFI_TIME_UNLOCK() 349 return (error); 350 } 351 352 int 353 efi_reset_system(void) 354 { 355 int error; 356 357 error = efi_enter(); 358 if (error != 0) 359 return (error); 360 efi_runtime->rt_reset(EFI_RESET_WARM, 0, 0, NULL); 361 efi_leave(); 362 return (EIO); 363 } 364 365 static int 366 efi_set_time_locked(struct efi_tm *tm) 367 { 368 efi_status status; 369 int error; 370 371 EFI_TIME_OWNED(); 372 error = efi_enter(); 373 if (error != 0) 374 return (error); 375 status = efi_runtime->rt_settime(tm); 376 efi_leave(); 377 error = efi_status_to_errno(status); 378 return (error); 379 } 380 381 int 382 efi_set_time(struct efi_tm *tm) 383 { 384 int error; 385 386 if (efi_runtime == NULL) 387 return (ENXIO); 388 EFI_TIME_LOCK() 389 error = efi_set_time_locked(tm); 390 EFI_TIME_UNLOCK() 391 return (error); 392 } 393 394 int 395 efi_var_get(efi_char *name, struct uuid *vendor, uint32_t *attrib, 396 size_t *datasize, void *data) 397 { 398 efi_status status; 399 int error; 400 401 error = efi_enter(); 402 if (error != 0) 403 return (error); 404 status = efi_runtime->rt_getvar(name, vendor, attrib, datasize, data); 405 efi_leave(); 406 error = efi_status_to_errno(status); 407 return (error); 408 } 409 410 int 411 efi_var_nextname(size_t *namesize, efi_char *name, struct uuid *vendor) 412 { 413 efi_status status; 414 int error; 415 416 error = efi_enter(); 417 if (error != 0) 418 return (error); 419 status = efi_runtime->rt_scanvar(namesize, name, vendor); 420 efi_leave(); 421 error = efi_status_to_errno(status); 422 return (error); 423 } 424 425 int 426 efi_var_set(efi_char *name, struct uuid *vendor, uint32_t attrib, 427 size_t datasize, void *data) 428 { 429 efi_status status; 430 int error; 431 432 error = efi_enter(); 433 if (error != 0) 434 return (error); 435 status = efi_runtime->rt_setvar(name, vendor, attrib, datasize, data); 436 efi_leave(); 437 error = efi_status_to_errno(status); 438 return (error); 439 } 440 441 static int 442 efirt_modevents(module_t m, int event, void *arg __unused) 443 { 444 445 switch (event) { 446 case MOD_LOAD: 447 return (efi_init()); 448 449 case MOD_UNLOAD: 450 efi_uninit(); 451 return (0); 452 453 case MOD_SHUTDOWN: 454 return (0); 455 456 default: 457 return (EOPNOTSUPP); 458 } 459 } 460 461 static moduledata_t efirt_moddata = { 462 .name = "efirt", 463 .evhand = efirt_modevents, 464 .priv = NULL, 465 }; 466 /* After fpuinitstate, before efidev */ 467 DECLARE_MODULE(efirt, efirt_moddata, SI_SUB_DRIVERS, SI_ORDER_SECOND); 468 MODULE_VERSION(efirt, 1); 469