1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2001 Takanori Watanabe <takawata@jp.freebsd.org> 5 * Copyright (c) 2001-2012 Mitsuru IWASAKI <iwasaki@jp.freebsd.org> 6 * Copyright (c) 2003 Peter Wemm 7 * Copyright (c) 2008-2012 Jung-uk Kim <jkim@FreeBSD.org> 8 * All rights reserved. 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/bus.h> 37 #include <sys/eventhandler.h> 38 #include <sys/kernel.h> 39 #include <sys/malloc.h> 40 #include <sys/memrange.h> 41 #include <sys/smp.h> 42 #include <sys/systm.h> 43 #include <sys/cons.h> 44 45 #include <vm/vm.h> 46 #include <vm/pmap.h> 47 #include <vm/vm_page.h> 48 49 #include <machine/clock.h> 50 #include <machine/cpu.h> 51 #include <machine/intr_machdep.h> 52 #include <machine/md_var.h> 53 #include <x86/mca.h> 54 #include <machine/pcb.h> 55 #include <machine/specialreg.h> 56 #include <x86/ucode.h> 57 58 #include <x86/apicreg.h> 59 #include <x86/apicvar.h> 60 #ifdef SMP 61 #include <machine/smp.h> 62 #include <machine/vmparam.h> 63 #endif 64 65 #include <contrib/dev/acpica/include/acpi.h> 66 67 #include <dev/acpica/acpivar.h> 68 69 #include "acpi_wakecode.h" 70 #include "acpi_wakedata.h" 71 72 /* Make sure the code is less than a page and leave room for the stack. */ 73 CTASSERT(sizeof(wakecode) < PAGE_SIZE - 1024); 74 75 extern int acpi_resume_beep; 76 extern int acpi_reset_video; 77 extern int acpi_susp_bounce; 78 79 #ifdef SMP 80 extern struct susppcb **susppcbs; 81 static cpuset_t suspcpus; 82 #else 83 static struct susppcb **susppcbs; 84 #endif 85 86 static void acpi_stop_beep(void *); 87 88 #ifdef SMP 89 static int acpi_wakeup_ap(struct acpi_softc *, int); 90 static void acpi_wakeup_cpus(struct acpi_softc *); 91 #endif 92 93 #define ACPI_WAKEPT_PAGES 7 94 95 #define WAKECODE_FIXUP(offset, type, val) do { \ 96 type *addr; \ 97 addr = (type *)(sc->acpi_wakeaddr + (offset)); \ 98 *addr = val; \ 99 } while (0) 100 101 static void 102 acpi_stop_beep(void *arg) 103 { 104 105 if (acpi_resume_beep != 0) 106 timer_spkr_release(); 107 } 108 109 #ifdef SMP 110 static int 111 acpi_wakeup_ap(struct acpi_softc *sc, int cpu) 112 { 113 struct pcb *pcb; 114 int vector = (sc->acpi_wakephys >> 12) & 0xff; 115 int apic_id = cpu_apic_ids[cpu]; 116 int ms; 117 118 pcb = &susppcbs[cpu]->sp_pcb; 119 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, pcb); 120 WAKECODE_FIXUP(wakeup_gdt, uint16_t, pcb->pcb_gdt.rd_limit); 121 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t, pcb->pcb_gdt.rd_base); 122 123 ipi_startup(apic_id, vector); 124 125 /* Wait up to 5 seconds for it to resume. */ 126 for (ms = 0; ms < 5000; ms++) { 127 if (!CPU_ISSET(cpu, &suspended_cpus)) 128 return (1); /* return SUCCESS */ 129 DELAY(1000); 130 } 131 return (0); /* return FAILURE */ 132 } 133 134 #define WARMBOOT_TARGET 0 135 #define WARMBOOT_OFF (KERNBASE + 0x0467) 136 #define WARMBOOT_SEG (KERNBASE + 0x0469) 137 138 #define CMOS_REG (0x70) 139 #define CMOS_DATA (0x71) 140 #define BIOS_RESET (0x0f) 141 #define BIOS_WARM (0x0a) 142 143 static void 144 acpi_wakeup_cpus(struct acpi_softc *sc) 145 { 146 uint32_t mpbioswarmvec; 147 int cpu; 148 u_char mpbiosreason; 149 150 if (!efi_boot) { 151 /* save the current value of the warm-start vector */ 152 mpbioswarmvec = *((uint32_t *)WARMBOOT_OFF); 153 outb(CMOS_REG, BIOS_RESET); 154 mpbiosreason = inb(CMOS_DATA); 155 156 /* setup a vector to our boot code */ 157 *((volatile u_short *)WARMBOOT_OFF) = WARMBOOT_TARGET; 158 *((volatile u_short *)WARMBOOT_SEG) = sc->acpi_wakephys >> 4; 159 outb(CMOS_REG, BIOS_RESET); 160 outb(CMOS_DATA, BIOS_WARM); /* 'warm-start' */ 161 } 162 163 /* Wake up each AP. */ 164 for (cpu = 1; cpu < mp_ncpus; cpu++) { 165 if (!CPU_ISSET(cpu, &suspcpus)) 166 continue; 167 if (acpi_wakeup_ap(sc, cpu) == 0) { 168 /* restore the warmstart vector */ 169 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec; 170 panic("acpi_wakeup: failed to resume AP #%d (PHY #%d)", 171 cpu, cpu_apic_ids[cpu]); 172 } 173 } 174 175 if (!efi_boot) { 176 /* restore the warmstart vector */ 177 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec; 178 179 outb(CMOS_REG, BIOS_RESET); 180 outb(CMOS_DATA, mpbiosreason); 181 } 182 } 183 #endif 184 185 int 186 acpi_sleep_machdep(struct acpi_softc *sc, int state) 187 { 188 ACPI_STATUS status; 189 struct pcb *pcb; 190 struct pcpu *pc; 191 int i; 192 193 if (sc->acpi_wakeaddr == 0ul) 194 return (-1); /* couldn't alloc wake memory */ 195 196 #ifdef SMP 197 suspcpus = all_cpus; 198 CPU_CLR(PCPU_GET(cpuid), &suspcpus); 199 #endif 200 201 if (acpi_resume_beep != 0) 202 timer_spkr_acquire(); 203 204 AcpiSetFirmwareWakingVector(sc->acpi_wakephys, 0); 205 206 intr_suspend(); 207 208 pcb = &susppcbs[0]->sp_pcb; 209 if (savectx(pcb)) { 210 fpususpend(susppcbs[0]->sp_fpususpend); 211 #ifdef SMP 212 if (!CPU_EMPTY(&suspcpus) && suspend_cpus(suspcpus) == 0) { 213 device_printf(sc->acpi_dev, "Failed to suspend APs\n"); 214 return (0); /* couldn't sleep */ 215 } 216 #endif 217 hw_ibrs_ibpb_active = 0; 218 hw_ssb_active = 0; 219 cpu_stdext_feature3 = 0; 220 CPU_FOREACH(i) { 221 pc = pcpu_find(i); 222 pc->pc_ibpb_set = 0; 223 } 224 225 WAKECODE_FIXUP(resume_beep, uint8_t, (acpi_resume_beep != 0)); 226 WAKECODE_FIXUP(reset_video, uint8_t, (acpi_reset_video != 0)); 227 228 WAKECODE_FIXUP(wakeup_efer, uint64_t, rdmsr(MSR_EFER) & 229 ~(EFER_LMA)); 230 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, pcb); 231 WAKECODE_FIXUP(wakeup_gdt, uint16_t, pcb->pcb_gdt.rd_limit); 232 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t, pcb->pcb_gdt.rd_base); 233 234 /* Call ACPICA to enter the desired sleep state */ 235 if (state == ACPI_STATE_S4 && sc->acpi_s4bios) 236 status = AcpiEnterSleepStateS4bios(); 237 else 238 status = AcpiEnterSleepState(state); 239 if (ACPI_FAILURE(status)) { 240 device_printf(sc->acpi_dev, 241 "AcpiEnterSleepState failed - %s\n", 242 AcpiFormatException(status)); 243 return (0); /* couldn't sleep */ 244 } 245 246 if (acpi_susp_bounce) 247 resumectx(pcb); 248 249 for (;;) 250 ia32_pause(); 251 } else { 252 /* 253 * Re-initialize console hardware as soon as possible. 254 * No console output (e.g. printf) is allowed before 255 * this point. 256 */ 257 cnresume(); 258 fpuresume(susppcbs[0]->sp_fpususpend); 259 } 260 261 return (1); /* wakeup successfully */ 262 } 263 264 int 265 acpi_wakeup_machdep(struct acpi_softc *sc, int state, int sleep_result, 266 int intr_enabled) 267 { 268 269 if (sleep_result == -1) 270 return (sleep_result); 271 272 if (!intr_enabled) { 273 /* Wakeup MD procedures in interrupt disabled context */ 274 if (sleep_result == 1) { 275 ucode_reload(); 276 pmap_init_pat(); 277 initializecpu(); 278 PCPU_SET(switchtime, 0); 279 PCPU_SET(switchticks, ticks); 280 lapic_xapic_mode(); 281 #ifdef SMP 282 if (!CPU_EMPTY(&suspcpus)) 283 acpi_wakeup_cpus(sc); 284 #endif 285 } 286 287 #ifdef SMP 288 if (!CPU_EMPTY(&suspcpus)) 289 resume_cpus(suspcpus); 290 #endif 291 292 /* 293 * Re-read cpu_stdext_feature3, which was zeroed-out 294 * in acpi_sleep_machdep(), after the microcode was 295 * reloaded. Then recalculate the active mitigation 296 * knobs that depend on the microcode and 297 * cpu_stdext_feature3. Do it after LAPICs are woken, 298 * so that IPIs work. 299 */ 300 identify_cpu_ext_features(); 301 302 mca_resume(); 303 if (vmm_resume_p != NULL) 304 vmm_resume_p(); 305 intr_resume(/*suspend_cancelled*/false); 306 307 hw_ibrs_recalculate(true); 308 amd64_syscall_ret_flush_l1d_recalc(); 309 hw_ssb_recalculate(true); 310 x86_rngds_mitg_recalculate(true); 311 312 AcpiSetFirmwareWakingVector(0, 0); 313 } else { 314 /* Wakeup MD procedures in interrupt enabled context */ 315 if (sleep_result == 1 && mem_range_softc.mr_op != NULL && 316 mem_range_softc.mr_op->reinit != NULL) 317 mem_range_softc.mr_op->reinit(&mem_range_softc); 318 } 319 320 return (sleep_result); 321 } 322 323 static void 324 acpi_alloc_wakeup_handler(void **wakeaddr, 325 void *wakept_pages[ACPI_WAKEPT_PAGES]) 326 { 327 vm_page_t wakept_m[ACPI_WAKEPT_PAGES]; 328 int i; 329 330 *wakeaddr = NULL; 331 memset(wakept_pages, 0, ACPI_WAKEPT_PAGES * sizeof(*wakept_pages)); 332 memset(wakept_m, 0, ACPI_WAKEPT_PAGES * sizeof(*wakept_m)); 333 334 /* 335 * Specify the region for our wakeup code. We want it in the 336 * low 1 MB region, excluding real mode IVT (0-0x3ff), BDA 337 * (0x400-0x4ff), EBDA (less than 128KB, below 0xa0000, must 338 * be excluded by SMAP and DSDT), and ROM area (0xa0000 and 339 * above). 340 */ 341 *wakeaddr = contigmalloc(PAGE_SIZE, M_DEVBUF, 342 M_NOWAIT, 0x500, 0xa0000, PAGE_SIZE, 0ul); 343 if (*wakeaddr == NULL) { 344 printf("%s: can't alloc wake memory\n", __func__); 345 goto freepages; 346 } 347 348 for (i = 0; i < ACPI_WAKEPT_PAGES - (la57 ? 0 : 1); i++) { 349 wakept_m[i] = pmap_page_alloc_below_4g(true); 350 wakept_pages[i] = (void *)PHYS_TO_DMAP(VM_PAGE_TO_PHYS( 351 wakept_m[i])); 352 } 353 if (EVENTHANDLER_REGISTER(power_resume, acpi_stop_beep, NULL, 354 EVENTHANDLER_PRI_LAST) == NULL) { 355 printf("%s: can't register event handler\n", __func__); 356 goto freepages; 357 } 358 susppcbs = malloc(mp_ncpus * sizeof(*susppcbs), M_DEVBUF, M_WAITOK); 359 for (i = 0; i < mp_ncpus; i++) { 360 susppcbs[i] = malloc(sizeof(**susppcbs), M_DEVBUF, M_WAITOK); 361 susppcbs[i]->sp_fpususpend = alloc_fpusave(M_WAITOK); 362 } 363 return; 364 365 freepages: 366 if (*wakeaddr != NULL) 367 contigfree(*wakeaddr, PAGE_SIZE, M_DEVBUF); 368 for (i = 0; i < ACPI_WAKEPT_PAGES; i++) { 369 if (wakept_m[i] != NULL) 370 vm_page_free(wakept_m[i]); 371 } 372 *wakeaddr = NULL; 373 } 374 375 void 376 acpi_install_wakeup_handler(struct acpi_softc *sc) 377 { 378 static void *wakeaddr; 379 void *wakept_pages[ACPI_WAKEPT_PAGES]; 380 uint64_t *pt5, *pt4, *pt3, *pt2_0, *pt2_1, *pt2_2, *pt2_3; 381 vm_paddr_t pt5pa, pt4pa, pt3pa, pt2_0pa, pt2_1pa, pt2_2pa, pt2_3pa; 382 int i; 383 384 if (wakeaddr != NULL) 385 return; 386 acpi_alloc_wakeup_handler(&wakeaddr, wakept_pages); 387 if (wakeaddr == NULL) 388 return; 389 390 sc->acpi_wakeaddr = (vm_offset_t)wakeaddr; 391 sc->acpi_wakephys = vtophys(wakeaddr); 392 393 if (la57) { 394 pt5 = wakept_pages[6]; 395 pt5pa = vtophys(pt5); 396 } 397 pt4 = wakept_pages[0]; 398 pt3 = wakept_pages[1]; 399 pt2_0 = wakept_pages[2]; 400 pt2_1 = wakept_pages[3]; 401 pt2_2 = wakept_pages[4]; 402 pt2_3 = wakept_pages[5]; 403 pt4pa = vtophys(pt4); 404 pt3pa = vtophys(pt3); 405 pt2_0pa = vtophys(pt2_0); 406 pt2_1pa = vtophys(pt2_1); 407 pt2_2pa = vtophys(pt2_2); 408 pt2_3pa = vtophys(pt2_3); 409 410 bcopy(wakecode, (void *)sc->acpi_wakeaddr, sizeof(wakecode)); 411 412 /* Patch GDT base address, ljmp targets. */ 413 WAKECODE_FIXUP((bootgdtdesc + 2), uint32_t, 414 sc->acpi_wakephys + bootgdt); 415 WAKECODE_FIXUP((wakeup_sw32 + 2), uint32_t, 416 sc->acpi_wakephys + wakeup_32); 417 WAKECODE_FIXUP((wakeup_sw64 + 1), uint32_t, 418 sc->acpi_wakephys + wakeup_64); 419 WAKECODE_FIXUP(wakeup_pagetables, uint32_t, la57 ? (pt5pa | 0x1) : 420 pt4pa); 421 422 /* Save pointers to some global data. */ 423 WAKECODE_FIXUP(wakeup_ret, void *, resumectx); 424 /* Create 1:1 mapping for the low 4G */ 425 if (la57) { 426 bcopy(kernel_pmap->pm_pmltop, pt5, PAGE_SIZE); 427 pt5[0] = (uint64_t)pt4pa; 428 pt5[0] |= PG_V | PG_RW | PG_U; 429 } else { 430 bcopy(kernel_pmap->pm_pmltop, pt4, PAGE_SIZE); 431 } 432 433 pt4[0] = (uint64_t)pt3pa; 434 pt4[0] |= PG_V | PG_RW | PG_U; 435 436 pt3[0] = (uint64_t)pt2_0pa; 437 pt3[0] |= PG_V | PG_RW | PG_U; 438 pt3[1] = (uint64_t)pt2_1pa; 439 pt3[1] |= PG_V | PG_RW | PG_U; 440 pt3[2] = (uint64_t)pt2_2pa; 441 pt3[2] |= PG_V | PG_RW | PG_U; 442 pt3[3] = (uint64_t)pt2_3pa; 443 pt3[3] |= PG_V | PG_RW | PG_U; 444 445 for (i = 0; i < NPDEPG; i++) { 446 pt2_0[i] = (pd_entry_t)i * NBPDR; 447 pt2_0[i] |= PG_V | PG_RW | PG_PS | PG_U; 448 } 449 for (i = 0; i < NPDEPG; i++) { 450 pt2_1[i] = (pd_entry_t)NBPDP + i * NBPDR; 451 pt2_1[i] |= PG_V | PG_RW | PG_PS | PG_U; 452 } 453 for (i = 0; i < NPDEPG; i++) { 454 pt2_2[i] = (pd_entry_t)2 * NBPDP + i * NBPDR; 455 pt2_2[i] |= PG_V | PG_RW | PG_PS | PG_U; 456 } 457 for (i = 0; i < NPDEPG; i++) { 458 pt2_3[i] = (pd_entry_t)3 * NBPDP + i * NBPDR; 459 pt2_3[i] |= PG_V | PG_RW | PG_PS | PG_U; 460 } 461 462 if (bootverbose) 463 device_printf(sc->acpi_dev, "wakeup code va %#jx pa %#jx\n", 464 (uintmax_t)sc->acpi_wakeaddr, (uintmax_t)sc->acpi_wakephys); 465 } 466