acpi_wakeup.c revision 236772 
1/*-
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>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
16 *
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
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: head/sys/x86/acpica/acpi_wakeup.c 236772 2012-06-09 00:37:26Z iwasaki $");
32
33#include <sys/param.h>
34#include <sys/bus.h>
35#include <sys/eventhandler.h>
36#include <sys/kernel.h>
37#include <sys/malloc.h>
38#include <sys/memrange.h>
39#include <sys/smp.h>
40
41#include <vm/vm.h>
42#include <vm/pmap.h>
43
44#include <machine/clock.h>
45#include <machine/intr_machdep.h>
46#include <x86/mca.h>
47#include <machine/pcb.h>
48#include <machine/pmap.h>
49#include <machine/specialreg.h>
50#include <machine/md_var.h>
51
52#ifdef SMP
53#include <x86/apicreg.h>
54#include <machine/smp.h>
55#include <machine/vmparam.h>
56#endif
57
58#include <contrib/dev/acpica/include/acpi.h>
59
60#include <dev/acpica/acpivar.h>
61
62#include "acpi_wakecode.h"
63#include "acpi_wakedata.h"
64
65/* Make sure the code is less than a page and leave room for the stack. */
66CTASSERT(sizeof(wakecode) < PAGE_SIZE - 1024);
67
68extern int		acpi_resume_beep;
69extern int		acpi_reset_video;
70
71#ifdef SMP
72extern struct pcb	**susppcbs;
73static cpuset_t		suspcpus;
74#else
75static struct pcb	**susppcbs;
76#endif
77
78static void		*acpi_alloc_wakeup_handler(void);
79static void		acpi_stop_beep(void *);
80
81#ifdef SMP
82static int		acpi_wakeup_ap(struct acpi_softc *, int);
83static void		acpi_wakeup_cpus(struct acpi_softc *);
84#endif
85
86#ifdef __amd64__
87#define ACPI_PAGETABLES	3
88#else
89#define ACPI_PAGETABLES	0
90#endif
91
92#define	WAKECODE_VADDR(sc)	((sc)->acpi_wakeaddr + (ACPI_PAGETABLES * PAGE_SIZE))
93#define	WAKECODE_PADDR(sc)	((sc)->acpi_wakephys + (ACPI_PAGETABLES * PAGE_SIZE))
94#define	WAKECODE_FIXUP(offset, type, val) do	{	\
95	type	*addr;					\
96	addr = (type *)(WAKECODE_VADDR(sc) + offset);	\
97	*addr = val;					\
98} while (0)
99
100static void
101acpi_stop_beep(void *arg)
102{
103
104	if (acpi_resume_beep != 0)
105		timer_spkr_release();
106}
107
108#ifdef SMP
109static int
110acpi_wakeup_ap(struct acpi_softc *sc, int cpu)
111{
112	int		vector = (WAKECODE_PADDR(sc) >> 12) & 0xff;
113	int		apic_id = cpu_apic_ids[cpu];
114	int		ms;
115
116	WAKECODE_FIXUP(wakeup_pcb, struct pcb *, susppcbs[cpu]);
117	WAKECODE_FIXUP(wakeup_gdt, uint16_t, susppcbs[cpu]->pcb_gdt.rd_limit);
118	WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t,
119	    susppcbs[cpu]->pcb_gdt.rd_base);
120
121	/* do an INIT IPI: assert RESET */
122	lapic_ipi_raw(APIC_DEST_DESTFLD | APIC_TRIGMOD_EDGE |
123	    APIC_LEVEL_ASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_INIT, apic_id);
124
125	/* wait for pending status end */
126	lapic_ipi_wait(-1);
127
128	/* do an INIT IPI: deassert RESET */
129	lapic_ipi_raw(APIC_DEST_ALLESELF | APIC_TRIGMOD_LEVEL |
130	    APIC_LEVEL_DEASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_INIT, 0);
131
132	/* wait for pending status end */
133	DELAY(10000);		/* wait ~10mS */
134	lapic_ipi_wait(-1);
135
136	/*
137	 * next we do a STARTUP IPI: the previous INIT IPI might still be
138	 * latched, (P5 bug) this 1st STARTUP would then terminate
139	 * immediately, and the previously started INIT IPI would continue. OR
140	 * the previous INIT IPI has already run. and this STARTUP IPI will
141	 * run. OR the previous INIT IPI was ignored. and this STARTUP IPI
142	 * will run.
143	 */
144
145	/* do a STARTUP IPI */
146	lapic_ipi_raw(APIC_DEST_DESTFLD | APIC_TRIGMOD_EDGE |
147	    APIC_LEVEL_DEASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_STARTUP |
148	    vector, apic_id);
149	lapic_ipi_wait(-1);
150	DELAY(200);		/* wait ~200uS */
151
152	/*
153	 * finally we do a 2nd STARTUP IPI: this 2nd STARTUP IPI should run IF
154	 * the previous STARTUP IPI was cancelled by a latched INIT IPI. OR
155	 * this STARTUP IPI will be ignored, as only ONE STARTUP IPI is
156	 * recognized after hardware RESET or INIT IPI.
157	 */
158
159	lapic_ipi_raw(APIC_DEST_DESTFLD | APIC_TRIGMOD_EDGE |
160	    APIC_LEVEL_DEASSERT | APIC_DESTMODE_PHY | APIC_DELMODE_STARTUP |
161	    vector, apic_id);
162	lapic_ipi_wait(-1);
163	DELAY(200);		/* wait ~200uS */
164
165	/* Wait up to 5 seconds for it to resume. */
166	for (ms = 0; ms < 5000; ms++) {
167		if (!CPU_ISSET(cpu, &suspended_cpus))
168			return (1);	/* return SUCCESS */
169		DELAY(1000);
170	}
171	return (0);		/* return FAILURE */
172}
173
174#define	WARMBOOT_TARGET		0
175#define	WARMBOOT_OFF		(KERNBASE + 0x0467)
176#define	WARMBOOT_SEG		(KERNBASE + 0x0469)
177
178#define	CMOS_REG		(0x70)
179#define	CMOS_DATA		(0x71)
180#define	BIOS_RESET		(0x0f)
181#define	BIOS_WARM		(0x0a)
182
183static void
184acpi_wakeup_cpus(struct acpi_softc *sc)
185{
186	uint32_t	mpbioswarmvec;
187	int		cpu;
188	u_char		mpbiosreason;
189
190	/* save the current value of the warm-start vector */
191	mpbioswarmvec = *((uint32_t *)WARMBOOT_OFF);
192	outb(CMOS_REG, BIOS_RESET);
193	mpbiosreason = inb(CMOS_DATA);
194
195	/* setup a vector to our boot code */
196	*((volatile u_short *)WARMBOOT_OFF) = WARMBOOT_TARGET;
197	*((volatile u_short *)WARMBOOT_SEG) = WAKECODE_PADDR(sc) >> 4;
198	outb(CMOS_REG, BIOS_RESET);
199	outb(CMOS_DATA, BIOS_WARM);	/* 'warm-start' */
200
201	/* Wake up each AP. */
202	for (cpu = 1; cpu < mp_ncpus; cpu++) {
203		if (!CPU_ISSET(cpu, &suspcpus))
204			continue;
205		if (acpi_wakeup_ap(sc, cpu) == 0) {
206			/* restore the warmstart vector */
207			*(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
208			panic("acpi_wakeup: failed to resume AP #%d (PHY #%d)",
209			    cpu, cpu_apic_ids[cpu]);
210		}
211	}
212
213	/* restore the warmstart vector */
214	*(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
215
216	outb(CMOS_REG, BIOS_RESET);
217	outb(CMOS_DATA, mpbiosreason);
218}
219#endif
220
221int
222acpi_sleep_machdep(struct acpi_softc *sc, int state)
223{
224	ACPI_STATUS	status;
225
226	if (sc->acpi_wakeaddr == 0ul)
227		return (-1);	/* couldn't alloc wake memory */
228
229#ifdef SMP
230	suspcpus = all_cpus;
231	CPU_CLR(PCPU_GET(cpuid), &suspcpus);
232#endif
233
234	if (acpi_resume_beep != 0)
235		timer_spkr_acquire();
236
237	AcpiSetFirmwareWakingVector(WAKECODE_PADDR(sc));
238
239	intr_suspend();
240
241	if (savectx(susppcbs[0])) {
242#ifdef __amd64__
243		ctx_fpusave(susppcbs[0]->pcb_fpususpend);
244#endif
245#ifdef SMP
246		if (!CPU_EMPTY(&suspcpus) && suspend_cpus(suspcpus) == 0) {
247			device_printf(sc->acpi_dev, "Failed to suspend APs\n");
248			return (0);	/* couldn't sleep */
249		}
250#endif
251
252		WAKECODE_FIXUP(resume_beep, uint8_t, (acpi_resume_beep != 0));
253		WAKECODE_FIXUP(reset_video, uint8_t, (acpi_reset_video != 0));
254
255		WAKECODE_FIXUP(wakeup_cr4, register_t, susppcbs[0]->pcb_cr4);
256		WAKECODE_FIXUP(wakeup_pcb, struct pcb *, susppcbs[0]);
257		WAKECODE_FIXUP(wakeup_gdt, uint16_t,
258		    susppcbs[0]->pcb_gdt.rd_limit);
259		WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t,
260		    susppcbs[0]->pcb_gdt.rd_base);
261
262		/* Call ACPICA to enter the desired sleep state */
263		if (state == ACPI_STATE_S4 && sc->acpi_s4bios)
264			status = AcpiEnterSleepStateS4bios();
265		else
266			status = AcpiEnterSleepState(state, acpi_sleep_flags);
267		if (ACPI_FAILURE(status)) {
268			device_printf(sc->acpi_dev,
269			    "AcpiEnterSleepState failed - %s\n",
270			    AcpiFormatException(status));
271			return (0);	/* couldn't sleep */
272		}
273
274		for (;;)
275			ia32_pause();
276	}
277
278	return (1);	/* wakeup successfully */
279}
280
281int
282acpi_wakeup_machdep(struct acpi_softc *sc, int state, int sleep_result,
283    int intr_enabled)
284{
285
286	if (sleep_result == -1)
287		return (sleep_result);
288
289	if (!intr_enabled) {
290		/* Wakeup MD procedures in interrupt disabled context */
291		if (sleep_result == 1) {
292			pmap_init_pat();
293#if 0
294			load_cr3(susppcbs[0]->pcb_cr3);
295#endif
296			initializecpu();
297			PCPU_SET(switchtime, 0);
298			PCPU_SET(switchticks, ticks);
299#ifdef SMP
300			if (!CPU_EMPTY(&suspcpus))
301				acpi_wakeup_cpus(sc);
302#endif
303		}
304
305#ifdef SMP
306		if (!CPU_EMPTY(&suspcpus))
307			restart_cpus(suspcpus);
308#endif
309		mca_resume();
310		intr_resume();
311
312		AcpiSetFirmwareWakingVector(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
323static void *
324acpi_alloc_wakeup_handler(void)
325{
326	void		*wakeaddr;
327	int		i;
328
329	/*
330	 * Specify the region for our wakeup code.  We want it in the low 1 MB
331	 * region, excluding real mode IVT (0-0x3ff), BDA (0x400-0x4ff), EBDA
332	 * (less than 128KB, below 0xa0000, must be excluded by SMAP and DSDT),
333	 * and ROM area (0xa0000 and above).  The temporary page tables must be
334	 * page-aligned.
335	 */
336	wakeaddr = contigmalloc((ACPI_PAGETABLES + 1) * PAGE_SIZE, M_DEVBUF,
337	    M_WAITOK, 0x500, 0xa0000, PAGE_SIZE, 0ul);
338	if (wakeaddr == NULL) {
339		printf("%s: can't alloc wake memory\n", __func__);
340		return (NULL);
341	}
342	if (EVENTHANDLER_REGISTER(power_resume, acpi_stop_beep, NULL,
343	    EVENTHANDLER_PRI_LAST) == NULL) {
344		printf("%s: can't register event handler\n", __func__);
345		contigfree(wakeaddr, (ACPI_PAGETABLES + 1) * PAGE_SIZE, M_DEVBUF);
346		return (NULL);
347	}
348	susppcbs = malloc(mp_ncpus * sizeof(*susppcbs), M_DEVBUF, M_WAITOK);
349	for (i = 0; i < mp_ncpus; i++) {
350		susppcbs[i] = malloc(sizeof(**susppcbs), M_DEVBUF, M_WAITOK);
351#ifdef __amd64__
352		susppcbs[i]->pcb_fpususpend = alloc_fpusave(M_WAITOK);
353#endif
354	}
355
356	return (wakeaddr);
357}
358
359void
360acpi_install_wakeup_handler(struct acpi_softc *sc)
361{
362	static void	*wakeaddr = NULL;
363#ifdef __amd64__
364	uint64_t	*pt4, *pt3, *pt2;
365	int		i;
366#endif
367
368	if (wakeaddr != NULL)
369		return;
370
371	wakeaddr = acpi_alloc_wakeup_handler();
372	if (wakeaddr == NULL)
373		return;
374
375	sc->acpi_wakeaddr = (vm_offset_t)wakeaddr;
376	sc->acpi_wakephys = vtophys(wakeaddr);
377
378	bcopy(wakecode, (void *)WAKECODE_VADDR(sc), sizeof(wakecode));
379
380	/* Patch GDT base address, ljmp targets. */
381	WAKECODE_FIXUP((bootgdtdesc + 2), uint32_t,
382	    WAKECODE_PADDR(sc) + bootgdt);
383	WAKECODE_FIXUP((wakeup_sw32 + 2), uint32_t,
384	    WAKECODE_PADDR(sc) + wakeup_32);
385#ifdef __amd64__
386	WAKECODE_FIXUP((wakeup_sw64 + 1), uint32_t,
387	    WAKECODE_PADDR(sc) + wakeup_64);
388	WAKECODE_FIXUP(wakeup_pagetables, uint32_t, sc->acpi_wakephys);
389#endif
390
391	/* Save pointers to some global data. */
392	WAKECODE_FIXUP(wakeup_ret, void *, resumectx);
393#ifdef __amd64__
394	WAKECODE_FIXUP(wakeup_cr3, uint64_t, KPML4phys);
395#else
396#ifdef PAE
397	WAKECODE_FIXUP(wakeup_cr3, register_t, vtophys(kernel_pmap->pm_pdpt));
398#else
399	WAKECODE_FIXUP(wakeup_cr3, register_t, vtophys(kernel_pmap->pm_pdir));
400#endif
401#endif
402
403#ifdef __amd64__
404	/* Build temporary page tables below realmode code. */
405	pt4 = wakeaddr;
406	pt3 = pt4 + (PAGE_SIZE) / sizeof(uint64_t);
407	pt2 = pt3 + (PAGE_SIZE) / sizeof(uint64_t);
408
409	/* Create the initial 1GB replicated page tables */
410	for (i = 0; i < 512; i++) {
411		/*
412		 * Each slot of the level 4 pages points
413		 * to the same level 3 page
414		 */
415		pt4[i] = (uint64_t)(sc->acpi_wakephys + PAGE_SIZE);
416		pt4[i] |= PG_V | PG_RW | PG_U;
417
418		/*
419		 * Each slot of the level 3 pages points
420		 * to the same level 2 page
421		 */
422		pt3[i] = (uint64_t)(sc->acpi_wakephys + (2 * PAGE_SIZE));
423		pt3[i] |= PG_V | PG_RW | PG_U;
424
425		/* The level 2 page slots are mapped with 2MB pages for 1GB. */
426		pt2[i] = i * (2 * 1024 * 1024);
427		pt2[i] |= PG_V | PG_RW | PG_PS | PG_U;
428	}
429#endif
430
431	if (bootverbose)
432		device_printf(sc->acpi_dev, "wakeup code va %#jx pa %#jx\n",
433		    (uintmax_t)sc->acpi_wakeaddr, (uintmax_t)sc->acpi_wakephys);
434}
435