2 * Copyright (c) 2001 Takanori Watanabe <takawata@jp.freebsd.org>
3 * Copyright (c) 2001 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
4 * Copyright (c) 2003 Peter Wemm
5 * Copyright (c) 2008-2012 Jung-uk Kim <jkim@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
35 #include <sys/eventhandler.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/memrange.h>
44 #include <machine/clock.h>
45 #include <machine/intr_machdep.h>
47 #include <machine/pcb.h>
48 #include <machine/pmap.h>
49 #include <machine/specialreg.h>
50 #include <machine/md_var.h>
53 #include <x86/apicreg.h>
54 #include <machine/smp.h>
55 #include <machine/vmparam.h>
58 #include <contrib/dev/acpica/include/acpi.h>
60 #include <dev/acpica/acpivar.h>
62 #include "acpi_wakecode.h"
63 #include "acpi_wakedata.h"
65 /* Make sure the code is less than a page and leave room for the stack. */
66 CTASSERT(sizeof(wakecode) < PAGE_SIZE - 1024);
68 extern int acpi_resume_beep;
69 extern int acpi_reset_video;
72 extern struct pcb **susppcbs;
73 extern void **suspfpusave;
75 static struct pcb **susppcbs;
76 static void **suspfpusave;
79 int acpi_restorecpu(uint64_t, vm_offset_t);
81 static void *acpi_alloc_wakeup_handler(void);
82 static void acpi_stop_beep(void *);
85 static int acpi_wakeup_ap(struct acpi_softc *, int);
86 static void acpi_wakeup_cpus(struct acpi_softc *, const cpuset_t *);
89 #define WAKECODE_VADDR(sc) ((sc)->acpi_wakeaddr + (3 * PAGE_SIZE))
90 #define WAKECODE_PADDR(sc) ((sc)->acpi_wakephys + (3 * PAGE_SIZE))
91 #define WAKECODE_FIXUP(offset, type, val) do { \
93 addr = (type *)(WAKECODE_VADDR(sc) + offset); \
98 acpi_stop_beep(void *arg)
101 if (acpi_resume_beep != 0)
102 timer_spkr_release();
107 acpi_wakeup_ap(struct acpi_softc *sc, int cpu)
109 int vector = (WAKECODE_PADDR(sc) >> 12) & 0xff;
110 int apic_id = cpu_apic_ids[cpu];
113 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, susppcbs[cpu]);
114 WAKECODE_FIXUP(wakeup_fpusave, void *, suspfpusave[cpu]);
115 WAKECODE_FIXUP(wakeup_gdt, uint16_t, susppcbs[cpu]->pcb_gdt.rd_limit);
116 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t,
117 susppcbs[cpu]->pcb_gdt.rd_base);
118 WAKECODE_FIXUP(wakeup_cpu, int, cpu);
120 /* do an INIT IPI: assert RESET */
121 lapic_ipi_raw(APIC_DEST_DESTFLD | APIC_TRIGMOD_EDGE |
122 APIC_LEVEL_ASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_INIT, apic_id);
124 /* wait for pending status end */
127 /* do an INIT IPI: deassert RESET */
128 lapic_ipi_raw(APIC_DEST_ALLESELF | APIC_TRIGMOD_LEVEL |
129 APIC_LEVEL_DEASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_INIT, 0);
131 /* wait for pending status end */
132 DELAY(10000); /* wait ~10mS */
136 * next we do a STARTUP IPI: the previous INIT IPI might still be
137 * latched, (P5 bug) this 1st STARTUP would then terminate
138 * immediately, and the previously started INIT IPI would continue. OR
139 * the previous INIT IPI has already run. and this STARTUP IPI will
140 * run. OR the previous INIT IPI was ignored. and this STARTUP IPI
144 /* do a STARTUP IPI */
145 lapic_ipi_raw(APIC_DEST_DESTFLD | APIC_TRIGMOD_EDGE |
146 APIC_LEVEL_DEASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_STARTUP |
149 DELAY(200); /* wait ~200uS */
152 * finally we do a 2nd STARTUP IPI: this 2nd STARTUP IPI should run IF
153 * the previous STARTUP IPI was cancelled by a latched INIT IPI. OR
154 * this STARTUP IPI will be ignored, as only ONE STARTUP IPI is
155 * recognized after hardware RESET or INIT IPI.
158 lapic_ipi_raw(APIC_DEST_DESTFLD | APIC_TRIGMOD_EDGE |
159 APIC_LEVEL_DEASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_STARTUP |
162 DELAY(200); /* wait ~200uS */
164 /* Wait up to 5 seconds for it to start. */
165 for (ms = 0; ms < 5000; ms++) {
166 if (*(int *)(WAKECODE_VADDR(sc) + wakeup_cpu) == 0)
167 return (1); /* return SUCCESS */
170 return (0); /* return FAILURE */
173 #define WARMBOOT_TARGET 0
174 #define WARMBOOT_OFF (KERNBASE + 0x0467)
175 #define WARMBOOT_SEG (KERNBASE + 0x0469)
177 #define CMOS_REG (0x70)
178 #define CMOS_DATA (0x71)
179 #define BIOS_RESET (0x0f)
180 #define BIOS_WARM (0x0a)
183 acpi_wakeup_cpus(struct acpi_softc *sc, const cpuset_t *wakeup_cpus)
185 uint32_t mpbioswarmvec;
189 /* save the current value of the warm-start vector */
190 mpbioswarmvec = *((uint32_t *)WARMBOOT_OFF);
191 outb(CMOS_REG, BIOS_RESET);
192 mpbiosreason = inb(CMOS_DATA);
194 /* setup a vector to our boot code */
195 *((volatile u_short *)WARMBOOT_OFF) = WARMBOOT_TARGET;
196 *((volatile u_short *)WARMBOOT_SEG) = WAKECODE_PADDR(sc) >> 4;
197 outb(CMOS_REG, BIOS_RESET);
198 outb(CMOS_DATA, BIOS_WARM); /* 'warm-start' */
200 /* Wake up each AP. */
201 for (cpu = 1; cpu < mp_ncpus; cpu++) {
202 if (!CPU_ISSET(cpu, wakeup_cpus))
204 if (acpi_wakeup_ap(sc, cpu) == 0) {
205 /* restore the warmstart vector */
206 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
207 panic("acpi_wakeup: failed to resume AP #%d (PHY #%d)",
208 cpu, cpu_apic_ids[cpu]);
212 /* restore the warmstart vector */
213 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
215 outb(CMOS_REG, BIOS_RESET);
216 outb(CMOS_DATA, mpbiosreason);
221 acpi_sleep_machdep(struct acpi_softc *sc, int state)
224 cpuset_t wakeup_cpus;
232 if (sc->acpi_wakeaddr == 0ul)
236 wakeup_cpus = all_cpus;
237 CPU_CLR(PCPU_GET(cpuid), &wakeup_cpus);
240 if (acpi_resume_beep != 0)
241 timer_spkr_acquire();
243 AcpiSetFirmwareWakingVector(WAKECODE_PADDR(sc));
248 if (savectx(susppcbs[0])) {
249 ctx_fpusave(suspfpusave[0]);
251 if (!CPU_EMPTY(&wakeup_cpus) &&
252 suspend_cpus(wakeup_cpus) == 0) {
253 device_printf(sc->acpi_dev, "Failed to suspend APs\n");
258 WAKECODE_FIXUP(resume_beep, uint8_t, (acpi_resume_beep != 0));
259 WAKECODE_FIXUP(reset_video, uint8_t, (acpi_reset_video != 0));
261 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, susppcbs[0]);
262 WAKECODE_FIXUP(wakeup_fpusave, void *, suspfpusave[0]);
263 WAKECODE_FIXUP(wakeup_gdt, uint16_t,
264 susppcbs[0]->pcb_gdt.rd_limit);
265 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t,
266 susppcbs[0]->pcb_gdt.rd_base);
267 WAKECODE_FIXUP(wakeup_cpu, int, 0);
269 /* Call ACPICA to enter the desired sleep state */
270 if (state == ACPI_STATE_S4 && sc->acpi_s4bios)
271 status = AcpiEnterSleepStateS4bios();
273 status = AcpiEnterSleepState(state, acpi_sleep_flags);
275 if (status != AE_OK) {
276 device_printf(sc->acpi_dev,
277 "AcpiEnterSleepState failed - %s\n",
278 AcpiFormatException(status));
286 load_cr3(susppcbs[0]->pcb_cr3);
288 PCPU_SET(switchtime, 0);
289 PCPU_SET(switchticks, ticks);
291 if (!CPU_EMPTY(&wakeup_cpus))
292 acpi_wakeup_cpus(sc, &wakeup_cpus);
299 if (!CPU_EMPTY(&wakeup_cpus))
300 restart_cpus(wakeup_cpus);
307 AcpiSetFirmwareWakingVector(0);
309 if (ret == 0 && mem_range_softc.mr_op != NULL &&
310 mem_range_softc.mr_op->reinit != NULL)
311 mem_range_softc.mr_op->reinit(&mem_range_softc);
317 acpi_alloc_wakeup_handler(void)
323 * Specify the region for our wakeup code. We want it in the low 1 MB
324 * region, excluding real mode IVT (0-0x3ff), BDA (0x400-0x4ff), EBDA
325 * (less than 128KB, below 0xa0000, must be excluded by SMAP and DSDT),
326 * and ROM area (0xa0000 and above). The temporary page tables must be
329 wakeaddr = contigmalloc(4 * PAGE_SIZE, M_DEVBUF, M_WAITOK, 0x500,
330 0xa0000, PAGE_SIZE, 0ul);
331 if (wakeaddr == NULL) {
332 printf("%s: can't alloc wake memory\n", __func__);
335 if (EVENTHANDLER_REGISTER(power_resume, acpi_stop_beep, NULL,
336 EVENTHANDLER_PRI_LAST) == NULL) {
337 printf("%s: can't register event handler\n", __func__);
338 contigfree(wakeaddr, 4 * PAGE_SIZE, M_DEVBUF);
341 susppcbs = malloc(mp_ncpus * sizeof(*susppcbs), M_DEVBUF, M_WAITOK);
342 suspfpusave = malloc(mp_ncpus * sizeof(void *), M_DEVBUF, M_WAITOK);
343 for (i = 0; i < mp_ncpus; i++) {
344 susppcbs[i] = malloc(sizeof(**susppcbs), M_DEVBUF, M_WAITOK);
345 suspfpusave[i] = alloc_fpusave(M_WAITOK);
352 acpi_install_wakeup_handler(struct acpi_softc *sc)
354 static void *wakeaddr = NULL;
355 uint64_t *pt4, *pt3, *pt2;
358 if (wakeaddr != NULL)
361 wakeaddr = acpi_alloc_wakeup_handler();
362 if (wakeaddr == NULL)
365 sc->acpi_wakeaddr = (vm_offset_t)wakeaddr;
366 sc->acpi_wakephys = vtophys(wakeaddr);
368 bcopy(wakecode, (void *)WAKECODE_VADDR(sc), sizeof(wakecode));
370 /* Patch GDT base address, ljmp targets and page table base address. */
371 WAKECODE_FIXUP((bootgdtdesc + 2), uint32_t,
372 WAKECODE_PADDR(sc) + bootgdt);
373 WAKECODE_FIXUP((wakeup_sw32 + 2), uint32_t,
374 WAKECODE_PADDR(sc) + wakeup_32);
375 WAKECODE_FIXUP((wakeup_sw64 + 1), uint32_t,
376 WAKECODE_PADDR(sc) + wakeup_64);
377 WAKECODE_FIXUP(wakeup_pagetables, uint32_t, sc->acpi_wakephys);
379 /* Save pointers to some global data. */
380 WAKECODE_FIXUP(wakeup_retaddr, void *, acpi_restorecpu);
381 WAKECODE_FIXUP(wakeup_kpml4, uint64_t, KPML4phys);
382 WAKECODE_FIXUP(wakeup_ctx, vm_offset_t,
383 WAKECODE_VADDR(sc) + wakeup_ctx);
384 WAKECODE_FIXUP(wakeup_efer, uint64_t, rdmsr(MSR_EFER));
385 WAKECODE_FIXUP(wakeup_star, uint64_t, rdmsr(MSR_STAR));
386 WAKECODE_FIXUP(wakeup_lstar, uint64_t, rdmsr(MSR_LSTAR));
387 WAKECODE_FIXUP(wakeup_cstar, uint64_t, rdmsr(MSR_CSTAR));
388 WAKECODE_FIXUP(wakeup_sfmask, uint64_t, rdmsr(MSR_SF_MASK));
389 WAKECODE_FIXUP(wakeup_xsmask, uint64_t, xsave_mask);
391 /* Build temporary page tables below realmode code. */
393 pt3 = pt4 + (PAGE_SIZE) / sizeof(uint64_t);
394 pt2 = pt3 + (PAGE_SIZE) / sizeof(uint64_t);
396 /* Create the initial 1GB replicated page tables */
397 for (i = 0; i < 512; i++) {
399 * Each slot of the level 4 pages points
400 * to the same level 3 page
402 pt4[i] = (uint64_t)(sc->acpi_wakephys + PAGE_SIZE);
403 pt4[i] |= PG_V | PG_RW | PG_U;
406 * Each slot of the level 3 pages points
407 * to the same level 2 page
409 pt3[i] = (uint64_t)(sc->acpi_wakephys + (2 * PAGE_SIZE));
410 pt3[i] |= PG_V | PG_RW | PG_U;
412 /* The level 2 page slots are mapped with 2MB pages for 1GB. */
413 pt2[i] = i * (2 * 1024 * 1024);
414 pt2[i] |= PG_V | PG_RW | PG_PS | PG_U;
418 device_printf(sc->acpi_dev, "wakeup code va %p pa %p\n",
419 (void *)sc->acpi_wakeaddr, (void *)sc->acpi_wakephys);