2 * Copyright (c) 2001 Takanori Watanabe <takawata@jp.freebsd.org>
3 * Copyright (c) 2001-2012 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>
40 #include <sys/systm.h>
45 #include <machine/clock.h>
46 #include <machine/cpu.h>
47 #include <machine/intr_machdep.h>
49 #include <machine/pcb.h>
50 #include <machine/pmap.h>
51 #include <machine/specialreg.h>
52 #include <machine/md_var.h>
55 #include <x86/apicreg.h>
56 #include <machine/smp.h>
57 #include <machine/vmparam.h>
60 #include <contrib/dev/acpica/include/acpi.h>
62 #include <dev/acpica/acpivar.h>
64 #include "acpi_wakecode.h"
65 #include "acpi_wakedata.h"
67 /* Make sure the code is less than a page and leave room for the stack. */
68 CTASSERT(sizeof(wakecode) < PAGE_SIZE - 1024);
70 extern int acpi_resume_beep;
71 extern int acpi_reset_video;
74 extern struct pcb **susppcbs;
75 static cpuset_t suspcpus;
77 static struct pcb **susppcbs;
80 static void *acpi_alloc_wakeup_handler(void);
81 static void acpi_stop_beep(void *);
84 static int acpi_wakeup_ap(struct acpi_softc *, int);
85 static void acpi_wakeup_cpus(struct acpi_softc *);
89 #define ACPI_PAGETABLES 3
91 #define ACPI_PAGETABLES 0
94 #define WAKECODE_VADDR(sc) \
95 ((sc)->acpi_wakeaddr + (ACPI_PAGETABLES * PAGE_SIZE))
96 #define WAKECODE_PADDR(sc) \
97 ((sc)->acpi_wakephys + (ACPI_PAGETABLES * PAGE_SIZE))
98 #define WAKECODE_FIXUP(offset, type, val) do { \
100 addr = (type *)(WAKECODE_VADDR(sc) + offset); \
105 acpi_stop_beep(void *arg)
108 if (acpi_resume_beep != 0)
109 timer_spkr_release();
114 acpi_wakeup_ap(struct acpi_softc *sc, int cpu)
116 int vector = (WAKECODE_PADDR(sc) >> 12) & 0xff;
117 int apic_id = cpu_apic_ids[cpu];
120 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, susppcbs[cpu]);
121 WAKECODE_FIXUP(wakeup_gdt, uint16_t, susppcbs[cpu]->pcb_gdt.rd_limit);
122 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t,
123 susppcbs[cpu]->pcb_gdt.rd_base);
125 ipi_startup(apic_id, vector);
127 /* Wait up to 5 seconds for it to resume. */
128 for (ms = 0; ms < 5000; ms++) {
129 if (!CPU_ISSET(cpu, &suspended_cpus))
130 return (1); /* return SUCCESS */
133 return (0); /* return FAILURE */
136 #define WARMBOOT_TARGET 0
137 #define WARMBOOT_OFF (KERNBASE + 0x0467)
138 #define WARMBOOT_SEG (KERNBASE + 0x0469)
140 #define CMOS_REG (0x70)
141 #define CMOS_DATA (0x71)
142 #define BIOS_RESET (0x0f)
143 #define BIOS_WARM (0x0a)
146 acpi_wakeup_cpus(struct acpi_softc *sc)
148 uint32_t mpbioswarmvec;
152 /* save the current value of the warm-start vector */
153 mpbioswarmvec = *((uint32_t *)WARMBOOT_OFF);
154 outb(CMOS_REG, BIOS_RESET);
155 mpbiosreason = inb(CMOS_DATA);
157 /* setup a vector to our boot code */
158 *((volatile u_short *)WARMBOOT_OFF) = WARMBOOT_TARGET;
159 *((volatile u_short *)WARMBOOT_SEG) = WAKECODE_PADDR(sc) >> 4;
160 outb(CMOS_REG, BIOS_RESET);
161 outb(CMOS_DATA, BIOS_WARM); /* 'warm-start' */
163 /* Wake up each AP. */
164 for (cpu = 1; cpu < mp_ncpus; cpu++) {
165 if (!CPU_ISSET(cpu, &suspcpus))
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]);
175 /* restore the warmstart vector */
176 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
178 outb(CMOS_REG, BIOS_RESET);
179 outb(CMOS_DATA, mpbiosreason);
184 acpi_sleep_machdep(struct acpi_softc *sc, int state)
188 if (sc->acpi_wakeaddr == 0ul)
189 return (-1); /* couldn't alloc wake memory */
193 CPU_CLR(PCPU_GET(cpuid), &suspcpus);
196 if (acpi_resume_beep != 0)
197 timer_spkr_acquire();
199 AcpiSetFirmwareWakingVector(WAKECODE_PADDR(sc));
203 if (savectx(susppcbs[0])) {
205 fpususpend(susppcbs[0]->pcb_fpususpend);
208 if (!CPU_EMPTY(&suspcpus) && suspend_cpus(suspcpus) == 0) {
209 device_printf(sc->acpi_dev, "Failed to suspend APs\n");
210 return (0); /* couldn't sleep */
214 WAKECODE_FIXUP(resume_beep, uint8_t, (acpi_resume_beep != 0));
215 WAKECODE_FIXUP(reset_video, uint8_t, (acpi_reset_video != 0));
218 WAKECODE_FIXUP(wakeup_cr4, register_t, susppcbs[0]->pcb_cr4);
220 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, susppcbs[0]);
221 WAKECODE_FIXUP(wakeup_gdt, uint16_t,
222 susppcbs[0]->pcb_gdt.rd_limit);
223 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t,
224 susppcbs[0]->pcb_gdt.rd_base);
226 /* Call ACPICA to enter the desired sleep state */
227 if (state == ACPI_STATE_S4 && sc->acpi_s4bios)
228 status = AcpiEnterSleepStateS4bios();
230 status = AcpiEnterSleepState(state);
231 if (ACPI_FAILURE(status)) {
232 device_printf(sc->acpi_dev,
233 "AcpiEnterSleepState failed - %s\n",
234 AcpiFormatException(status));
235 return (0); /* couldn't sleep */
242 return (1); /* wakeup successfully */
246 acpi_wakeup_machdep(struct acpi_softc *sc, int state, int sleep_result,
250 if (sleep_result == -1)
251 return (sleep_result);
254 /* Wakeup MD procedures in interrupt disabled context */
255 if (sleep_result == 1) {
258 PCPU_SET(switchtime, 0);
259 PCPU_SET(switchticks, ticks);
261 if (!CPU_EMPTY(&suspcpus))
262 acpi_wakeup_cpus(sc);
267 if (!CPU_EMPTY(&suspcpus))
268 restart_cpus(suspcpus);
272 if (vmm_resume_p != NULL)
275 intr_resume(/*suspend_cancelled*/false);
277 AcpiSetFirmwareWakingVector(0);
279 /* Wakeup MD procedures in interrupt enabled context */
280 if (sleep_result == 1 && mem_range_softc.mr_op != NULL &&
281 mem_range_softc.mr_op->reinit != NULL)
282 mem_range_softc.mr_op->reinit(&mem_range_softc);
285 return (sleep_result);
289 acpi_alloc_wakeup_handler(void)
295 * Specify the region for our wakeup code. We want it in the low 1 MB
296 * region, excluding real mode IVT (0-0x3ff), BDA (0x400-0x4ff), EBDA
297 * (less than 128KB, below 0xa0000, must be excluded by SMAP and DSDT),
298 * and ROM area (0xa0000 and above). The temporary page tables must be
301 wakeaddr = contigmalloc((ACPI_PAGETABLES + 1) * PAGE_SIZE, M_DEVBUF,
302 M_WAITOK, 0x500, 0xa0000, PAGE_SIZE, 0ul);
303 if (wakeaddr == NULL) {
304 printf("%s: can't alloc wake memory\n", __func__);
307 if (EVENTHANDLER_REGISTER(power_resume, acpi_stop_beep, NULL,
308 EVENTHANDLER_PRI_LAST) == NULL) {
309 printf("%s: can't register event handler\n", __func__);
310 contigfree(wakeaddr, (ACPI_PAGETABLES + 1) * PAGE_SIZE,
314 susppcbs = malloc(mp_ncpus * sizeof(*susppcbs), M_DEVBUF, M_WAITOK);
315 for (i = 0; i < mp_ncpus; i++) {
316 susppcbs[i] = malloc(sizeof(**susppcbs), M_DEVBUF, M_WAITOK);
318 susppcbs[i]->pcb_fpususpend = alloc_fpusave(M_WAITOK);
326 acpi_install_wakeup_handler(struct acpi_softc *sc)
328 static void *wakeaddr = NULL;
330 uint64_t *pt4, *pt3, *pt2;
334 if (wakeaddr != NULL)
337 wakeaddr = acpi_alloc_wakeup_handler();
338 if (wakeaddr == NULL)
341 sc->acpi_wakeaddr = (vm_offset_t)wakeaddr;
342 sc->acpi_wakephys = vtophys(wakeaddr);
344 bcopy(wakecode, (void *)WAKECODE_VADDR(sc), sizeof(wakecode));
346 /* Patch GDT base address, ljmp targets. */
347 WAKECODE_FIXUP((bootgdtdesc + 2), uint32_t,
348 WAKECODE_PADDR(sc) + bootgdt);
349 WAKECODE_FIXUP((wakeup_sw32 + 2), uint32_t,
350 WAKECODE_PADDR(sc) + wakeup_32);
352 WAKECODE_FIXUP((wakeup_sw64 + 1), uint32_t,
353 WAKECODE_PADDR(sc) + wakeup_64);
354 WAKECODE_FIXUP(wakeup_pagetables, uint32_t, sc->acpi_wakephys);
357 /* Save pointers to some global data. */
358 WAKECODE_FIXUP(wakeup_ret, void *, resumectx);
361 WAKECODE_FIXUP(wakeup_cr3, register_t, vtophys(kernel_pmap->pm_pdpt));
363 WAKECODE_FIXUP(wakeup_cr3, register_t, vtophys(kernel_pmap->pm_pdir));
367 /* Build temporary page tables below realmode code. */
369 pt3 = pt4 + (PAGE_SIZE) / sizeof(uint64_t);
370 pt2 = pt3 + (PAGE_SIZE) / sizeof(uint64_t);
372 /* Create the initial 1GB replicated page tables */
373 for (i = 0; i < 512; i++) {
375 * Each slot of the level 4 pages points
376 * to the same level 3 page
378 pt4[i] = (uint64_t)(sc->acpi_wakephys + PAGE_SIZE);
379 pt4[i] |= PG_V | PG_RW | PG_U;
382 * Each slot of the level 3 pages points
383 * to the same level 2 page
385 pt3[i] = (uint64_t)(sc->acpi_wakephys + (2 * PAGE_SIZE));
386 pt3[i] |= PG_V | PG_RW | PG_U;
388 /* The level 2 page slots are mapped with 2MB pages for 1GB. */
389 pt2[i] = i * (2 * 1024 * 1024);
390 pt2[i] |= PG_V | PG_RW | PG_PS | PG_U;
395 device_printf(sc->acpi_dev, "wakeup code va %#jx pa %#jx\n",
396 (uintmax_t)sc->acpi_wakeaddr, (uintmax_t)sc->acpi_wakephys);