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 #if defined(__amd64__)
42 #include <sys/param.h>
44 #include <sys/eventhandler.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
47 #include <sys/memrange.h>
49 #include <sys/systm.h>
54 #include <machine/clock.h>
55 #include <machine/cpu.h>
56 #include <machine/intr_machdep.h>
58 #include <machine/pcb.h>
59 #include <machine/specialreg.h>
60 #include <machine/md_var.h>
63 #include <x86/apicreg.h>
64 #include <x86/apicvar.h>
67 #include <machine/smp.h>
68 #include <machine/vmparam.h>
71 #include <contrib/dev/acpica/include/acpi.h>
73 #include <dev/acpica/acpivar.h>
75 #include "acpi_wakecode.h"
76 #include "acpi_wakedata.h"
78 /* Make sure the code is less than a page and leave room for the stack. */
79 CTASSERT(sizeof(wakecode) < PAGE_SIZE - 1024);
81 extern int acpi_resume_beep;
82 extern int acpi_reset_video;
85 extern struct susppcb **susppcbs;
86 static cpuset_t suspcpus;
88 static struct susppcb **susppcbs;
91 static void *acpi_alloc_wakeup_handler(void);
92 static void acpi_stop_beep(void *);
95 static int acpi_wakeup_ap(struct acpi_softc *, int);
96 static void acpi_wakeup_cpus(struct acpi_softc *);
100 #define ACPI_PAGETABLES 3
102 #define ACPI_PAGETABLES 0
105 #define WAKECODE_VADDR(sc) \
106 ((sc)->acpi_wakeaddr + (ACPI_PAGETABLES * PAGE_SIZE))
107 #define WAKECODE_PADDR(sc) \
108 ((sc)->acpi_wakephys + (ACPI_PAGETABLES * PAGE_SIZE))
109 #define WAKECODE_FIXUP(offset, type, val) do { \
111 addr = (type *)(WAKECODE_VADDR(sc) + offset); \
116 acpi_stop_beep(void *arg)
119 if (acpi_resume_beep != 0)
120 timer_spkr_release();
125 acpi_wakeup_ap(struct acpi_softc *sc, int cpu)
128 int vector = (WAKECODE_PADDR(sc) >> 12) & 0xff;
129 int apic_id = cpu_apic_ids[cpu];
132 pcb = &susppcbs[cpu]->sp_pcb;
133 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, pcb);
134 WAKECODE_FIXUP(wakeup_gdt, uint16_t, pcb->pcb_gdt.rd_limit);
135 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t, pcb->pcb_gdt.rd_base);
137 ipi_startup(apic_id, vector);
139 /* Wait up to 5 seconds for it to resume. */
140 for (ms = 0; ms < 5000; ms++) {
141 if (!CPU_ISSET(cpu, &suspended_cpus))
142 return (1); /* return SUCCESS */
145 return (0); /* return FAILURE */
148 #define WARMBOOT_TARGET 0
149 #define WARMBOOT_OFF (KERNBASE + 0x0467)
150 #define WARMBOOT_SEG (KERNBASE + 0x0469)
152 #define CMOS_REG (0x70)
153 #define CMOS_DATA (0x71)
154 #define BIOS_RESET (0x0f)
155 #define BIOS_WARM (0x0a)
158 acpi_wakeup_cpus(struct acpi_softc *sc)
160 uint32_t mpbioswarmvec;
164 /* save the current value of the warm-start vector */
165 mpbioswarmvec = *((uint32_t *)WARMBOOT_OFF);
166 outb(CMOS_REG, BIOS_RESET);
167 mpbiosreason = inb(CMOS_DATA);
169 /* setup a vector to our boot code */
170 *((volatile u_short *)WARMBOOT_OFF) = WARMBOOT_TARGET;
171 *((volatile u_short *)WARMBOOT_SEG) = WAKECODE_PADDR(sc) >> 4;
172 outb(CMOS_REG, BIOS_RESET);
173 outb(CMOS_DATA, BIOS_WARM); /* 'warm-start' */
175 /* Wake up each AP. */
176 for (cpu = 1; cpu < mp_ncpus; cpu++) {
177 if (!CPU_ISSET(cpu, &suspcpus))
179 if (acpi_wakeup_ap(sc, cpu) == 0) {
180 /* restore the warmstart vector */
181 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
182 panic("acpi_wakeup: failed to resume AP #%d (PHY #%d)",
183 cpu, cpu_apic_ids[cpu]);
187 /* restore the warmstart vector */
188 *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
190 outb(CMOS_REG, BIOS_RESET);
191 outb(CMOS_DATA, mpbiosreason);
196 acpi_sleep_machdep(struct acpi_softc *sc, int state)
201 if (sc->acpi_wakeaddr == 0ul)
202 return (-1); /* couldn't alloc wake memory */
206 CPU_CLR(PCPU_GET(cpuid), &suspcpus);
209 if (acpi_resume_beep != 0)
210 timer_spkr_acquire();
212 AcpiSetFirmwareWakingVector(WAKECODE_PADDR(sc), 0);
216 pcb = &susppcbs[0]->sp_pcb;
219 fpususpend(susppcbs[0]->sp_fpususpend);
220 #elif defined(DEV_NPX)
221 npxsuspend(susppcbs[0]->sp_fpususpend);
224 if (!CPU_EMPTY(&suspcpus) && suspend_cpus(suspcpus) == 0) {
225 device_printf(sc->acpi_dev, "Failed to suspend APs\n");
226 return (0); /* couldn't sleep */
230 WAKECODE_FIXUP(resume_beep, uint8_t, (acpi_resume_beep != 0));
231 WAKECODE_FIXUP(reset_video, uint8_t, (acpi_reset_video != 0));
234 WAKECODE_FIXUP(wakeup_cr4, register_t, pcb->pcb_cr4);
236 WAKECODE_FIXUP(wakeup_pcb, struct pcb *, pcb);
237 WAKECODE_FIXUP(wakeup_gdt, uint16_t, pcb->pcb_gdt.rd_limit);
238 WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t, pcb->pcb_gdt.rd_base);
240 /* Call ACPICA to enter the desired sleep state */
241 if (state == ACPI_STATE_S4 && sc->acpi_s4bios)
242 status = AcpiEnterSleepStateS4bios();
244 status = AcpiEnterSleepState(state);
245 if (ACPI_FAILURE(status)) {
246 device_printf(sc->acpi_dev,
247 "AcpiEnterSleepState failed - %s\n",
248 AcpiFormatException(status));
249 return (0); /* couldn't sleep */
256 fpuresume(susppcbs[0]->sp_fpususpend);
257 #elif defined(DEV_NPX)
258 npxresume(susppcbs[0]->sp_fpususpend);
262 return (1); /* wakeup successfully */
266 acpi_wakeup_machdep(struct acpi_softc *sc, int state, int sleep_result,
270 if (sleep_result == -1)
271 return (sleep_result);
274 /* Wakeup MD procedures in interrupt disabled context */
275 if (sleep_result == 1) {
278 PCPU_SET(switchtime, 0);
279 PCPU_SET(switchticks, ticks);
284 if (!CPU_EMPTY(&suspcpus))
285 acpi_wakeup_cpus(sc);
290 if (!CPU_EMPTY(&suspcpus))
291 restart_cpus(suspcpus);
295 if (vmm_resume_p != NULL)
298 intr_resume(/*suspend_cancelled*/false);
300 AcpiSetFirmwareWakingVector(0, 0);
302 /* Wakeup MD procedures in interrupt enabled context */
303 if (sleep_result == 1 && mem_range_softc.mr_op != NULL &&
304 mem_range_softc.mr_op->reinit != NULL)
305 mem_range_softc.mr_op->reinit(&mem_range_softc);
308 return (sleep_result);
312 acpi_alloc_wakeup_handler(void)
318 * Specify the region for our wakeup code. We want it in the low 1 MB
319 * region, excluding real mode IVT (0-0x3ff), BDA (0x400-0x4ff), EBDA
320 * (less than 128KB, below 0xa0000, must be excluded by SMAP and DSDT),
321 * and ROM area (0xa0000 and above). The temporary page tables must be
324 wakeaddr = contigmalloc((ACPI_PAGETABLES + 1) * PAGE_SIZE, M_DEVBUF,
325 M_WAITOK, 0x500, 0xa0000, PAGE_SIZE, 0ul);
326 if (wakeaddr == NULL) {
327 printf("%s: can't alloc wake memory\n", __func__);
330 if (EVENTHANDLER_REGISTER(power_resume, acpi_stop_beep, NULL,
331 EVENTHANDLER_PRI_LAST) == NULL) {
332 printf("%s: can't register event handler\n", __func__);
333 contigfree(wakeaddr, (ACPI_PAGETABLES + 1) * PAGE_SIZE,
337 susppcbs = malloc(mp_ncpus * sizeof(*susppcbs), M_DEVBUF, M_WAITOK);
338 for (i = 0; i < mp_ncpus; i++) {
339 susppcbs[i] = malloc(sizeof(**susppcbs), M_DEVBUF, M_WAITOK);
340 susppcbs[i]->sp_fpususpend = alloc_fpusave(M_WAITOK);
347 acpi_install_wakeup_handler(struct acpi_softc *sc)
349 static void *wakeaddr = NULL;
351 uint64_t *pt4, *pt3, *pt2;
355 if (wakeaddr != NULL)
358 wakeaddr = acpi_alloc_wakeup_handler();
359 if (wakeaddr == NULL)
362 sc->acpi_wakeaddr = (vm_offset_t)wakeaddr;
363 sc->acpi_wakephys = vtophys(wakeaddr);
365 bcopy(wakecode, (void *)WAKECODE_VADDR(sc), sizeof(wakecode));
367 /* Patch GDT base address, ljmp targets. */
368 WAKECODE_FIXUP((bootgdtdesc + 2), uint32_t,
369 WAKECODE_PADDR(sc) + bootgdt);
370 WAKECODE_FIXUP((wakeup_sw32 + 2), uint32_t,
371 WAKECODE_PADDR(sc) + wakeup_32);
373 WAKECODE_FIXUP((wakeup_sw64 + 1), uint32_t,
374 WAKECODE_PADDR(sc) + wakeup_64);
375 WAKECODE_FIXUP(wakeup_pagetables, uint32_t, sc->acpi_wakephys);
378 /* Save pointers to some global data. */
379 WAKECODE_FIXUP(wakeup_ret, void *, resumectx);
381 #if defined(PAE) || defined(PAE_TABLES)
382 WAKECODE_FIXUP(wakeup_cr3, register_t, vtophys(kernel_pmap->pm_pdpt));
384 WAKECODE_FIXUP(wakeup_cr3, register_t, vtophys(kernel_pmap->pm_pdir));
388 /* Build temporary page tables below realmode code. */
390 pt3 = pt4 + (PAGE_SIZE) / sizeof(uint64_t);
391 pt2 = pt3 + (PAGE_SIZE) / sizeof(uint64_t);
393 /* Create the initial 1GB replicated page tables */
394 for (i = 0; i < 512; i++) {
396 * Each slot of the level 4 pages points
397 * to the same level 3 page
399 pt4[i] = (uint64_t)(sc->acpi_wakephys + PAGE_SIZE);
400 pt4[i] |= PG_V | PG_RW | PG_U;
403 * Each slot of the level 3 pages points
404 * to the same level 2 page
406 pt3[i] = (uint64_t)(sc->acpi_wakephys + (2 * PAGE_SIZE));
407 pt3[i] |= PG_V | PG_RW | PG_U;
409 /* The level 2 page slots are mapped with 2MB pages for 1GB. */
410 pt2[i] = i * (2 * 1024 * 1024);
411 pt2[i] |= PG_V | PG_RW | PG_PS | PG_U;
416 device_printf(sc->acpi_dev, "wakeup code va %#jx pa %#jx\n",
417 (uintmax_t)sc->acpi_wakeaddr, (uintmax_t)sc->acpi_wakephys);