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