xref: /freebsd/sys/i386/acpica/acpi_wakeup.c (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
1 /*-
2  * Copyright (c) 2001 Takanori Watanabe <takawata@jp.freebsd.org>
3  * Copyright (c) 2001 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30 
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/bus.h>
35 #include <sys/lock.h>
36 #include <sys/proc.h>
37 #include <sys/sysctl.h>
38 
39 #include <vm/vm.h>
40 #include <vm/pmap.h>
41 #include <vm/vm_object.h>
42 #include <vm/vm_page.h>
43 #include <vm/vm_map.h>
44 
45 #include <machine/bus.h>
46 #include <machine/cpufunc.h>
47 #include <machine/intr_machdep.h>
48 #include <machine/segments.h>
49 
50 #include "acpi.h"
51 #include <dev/acpica/acpivar.h>
52 
53 #include "acpi_wakecode.h"
54 
55 extern uint32_t	acpi_reset_video;
56 extern void	initializecpu(void);
57 
58 static struct region_descriptor	r_idt, r_gdt, *p_gdt;
59 static uint16_t		r_ldt;
60 
61 static uint32_t		r_eax, r_ebx, r_ecx, r_edx, r_ebp, r_esi, r_edi,
62 			r_efl, r_cr0, r_cr2, r_cr3, r_cr4, ret_addr;
63 
64 static uint16_t		r_cs, r_ds, r_es, r_fs, r_gs, r_ss, r_tr;
65 static uint32_t		r_esp = 0;
66 
67 static void		acpi_printcpu(void);
68 static void		acpi_realmodeinst(void *arg, bus_dma_segment_t *segs,
69 					  int nsegs, int error);
70 static void		acpi_alloc_wakeup_handler(void);
71 
72 /* XXX shut gcc up */
73 extern int		acpi_savecpu(void);
74 extern int		acpi_restorecpu(void);
75 
76 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
77 __asm__("				\n\
78 	.text				\n\
79 	.p2align 2, 0x90		\n\
80 	.type acpi_restorecpu, @function\n\
81 acpi_restorecpu:			\n\
82 	.align 4			\n\
83 	movl	r_eax,%eax		\n\
84 	movl	r_ebx,%ebx		\n\
85 	movl	r_ecx,%ecx		\n\
86 	movl	r_edx,%edx		\n\
87 	movl	r_ebp,%ebp		\n\
88 	movl	r_esi,%esi		\n\
89 	movl	r_edi,%edi		\n\
90 	movl	r_esp,%esp		\n\
91 					\n\
92 	pushl	r_efl			\n\
93 	popfl				\n\
94 					\n\
95 	movl	ret_addr,%eax		\n\
96 	movl	%eax,(%esp)		\n\
97 	xorl	%eax,%eax		\n\
98 	ret				\n\
99 					\n\
100 	.text				\n\
101 	.p2align 2, 0x90		\n\
102 	.type acpi_savecpu, @function	\n\
103 acpi_savecpu:				\n\
104 	movw	%cs,r_cs		\n\
105 	movw	%ds,r_ds		\n\
106 	movw	%es,r_es		\n\
107 	movw	%fs,r_fs		\n\
108 	movw	%gs,r_gs		\n\
109 	movw	%ss,r_ss		\n\
110 					\n\
111 	movl	%eax,r_eax		\n\
112 	movl	%ebx,r_ebx		\n\
113 	movl	%ecx,r_ecx		\n\
114 	movl	%edx,r_edx		\n\
115 	movl	%ebp,r_ebp		\n\
116 	movl	%esi,r_esi		\n\
117 	movl	%edi,r_edi		\n\
118 					\n\
119 	movl	%cr0,%eax		\n\
120 	movl	%eax,r_cr0		\n\
121 	movl	%cr2,%eax		\n\
122 	movl	%eax,r_cr2		\n\
123 	movl	%cr3,%eax		\n\
124 	movl	%eax,r_cr3		\n\
125 	movl	%cr4,%eax		\n\
126 	movl	%eax,r_cr4		\n\
127 					\n\
128 	pushfl				\n\
129 	popl	r_efl			\n\
130 					\n\
131 	movl	%esp,r_esp		\n\
132 					\n\
133 	sgdt	r_gdt			\n\
134 	sidt	r_idt			\n\
135 	sldt	r_ldt			\n\
136 	str	r_tr			\n\
137 					\n\
138 	movl	(%esp),%eax		\n\
139 	movl	%eax,ret_addr		\n\
140 	movl	$1,%eax			\n\
141 	ret				\n\
142 ");
143 #endif /* __GNUC__ || __INTEL_COMPILER */
144 
145 static void
146 acpi_printcpu(void)
147 {
148 	printf("======== acpi_printcpu() debug dump ========\n");
149 	printf("gdt[%04x:%08x] idt[%04x:%08x] ldt[%04x] tr[%04x] efl[%08x]\n",
150 		r_gdt.rd_limit, r_gdt.rd_base, r_idt.rd_limit, r_idt.rd_base,
151 		r_ldt, r_tr, r_efl);
152 	printf("eax[%08x] ebx[%08x] ecx[%08x] edx[%08x]\n",
153 		r_eax, r_ebx, r_ecx, r_edx);
154 	printf("esi[%08x] edi[%08x] ebp[%08x] esp[%08x]\n",
155 		r_esi, r_edi, r_ebp, r_esp);
156 	printf("cr0[%08x] cr2[%08x] cr3[%08x] cr4[%08x]\n",
157 		r_cr0, r_cr2, r_cr3, r_cr4);
158 	printf("cs[%04x] ds[%04x] es[%04x] fs[%04x] gs[%04x] ss[%04x]\n",
159 		r_cs, r_ds, r_es, r_fs, r_gs, r_ss);
160 }
161 
162 #define WAKECODE_FIXUP(offset, type, val) do	{		\
163 	type	*addr;						\
164 	addr = (type *)(sc->acpi_wakeaddr + offset);		\
165 	*addr = val;						\
166 } while (0)
167 
168 #define WAKECODE_BCOPY(offset, type, val) do	{		\
169 	void	*addr;						\
170 	addr = (void *)(sc->acpi_wakeaddr + offset);		\
171 	bcopy(&(val), addr, sizeof(type));			\
172 } while (0)
173 
174 int
175 acpi_sleep_machdep(struct acpi_softc *sc, int state)
176 {
177 	ACPI_STATUS		status;
178 	vm_paddr_t		oldphys;
179 	struct pmap		*pm;
180 	vm_page_t		page;
181 	static vm_page_t	opage = NULL;
182 	int			ret = 0;
183 	uint32_t		cr3;
184 	u_long			ef;
185 	struct proc		*p;
186 
187 	if (sc->acpi_wakeaddr == 0)
188 		return (0);
189 
190 	AcpiSetFirmwareWakingVector(sc->acpi_wakephys);
191 
192 	ef = read_eflags();
193 	ACPI_DISABLE_IRQS();
194 
195 	/* Create Identity Mapping */
196 	if ((p = curproc) == NULL)
197 		p = &proc0;
198 	pm = vmspace_pmap(p->p_vmspace);
199 	cr3 = rcr3();
200 #ifdef PAE
201 	load_cr3(vtophys(pm->pm_pdpt));
202 #else
203 	load_cr3(vtophys(pm->pm_pdir));
204 #endif
205 
206 	oldphys = pmap_extract(pm, sc->acpi_wakephys);
207 	if (oldphys)
208 		opage = PHYS_TO_VM_PAGE(oldphys);
209 	page = PHYS_TO_VM_PAGE(sc->acpi_wakephys);
210 	pmap_enter(pm, sc->acpi_wakephys, page,
211 		   VM_PROT_READ | VM_PROT_WRITE | VM_PROT_EXECUTE, 1);
212 
213 	ret_addr = 0;
214 	if (acpi_savecpu()) {
215 		/* Execute Sleep */
216 		intr_suspend();
217 
218 		p_gdt = (struct region_descriptor *)
219 				(sc->acpi_wakeaddr + physical_gdt);
220 		p_gdt->rd_limit = r_gdt.rd_limit;
221 		p_gdt->rd_base = vtophys(r_gdt.rd_base);
222 
223 		WAKECODE_FIXUP(physical_esp, uint32_t, vtophys(r_esp));
224 		WAKECODE_FIXUP(previous_cr0, uint32_t, r_cr0);
225 		WAKECODE_FIXUP(previous_cr2, uint32_t, r_cr2);
226 		WAKECODE_FIXUP(previous_cr3, uint32_t, r_cr3);
227 		WAKECODE_FIXUP(previous_cr4, uint32_t, r_cr4);
228 
229 		WAKECODE_FIXUP(reset_video, uint32_t, acpi_reset_video);
230 
231 		WAKECODE_FIXUP(previous_tr,  uint16_t, r_tr);
232 		WAKECODE_BCOPY(previous_gdt, struct region_descriptor, r_gdt);
233 		WAKECODE_FIXUP(previous_ldt, uint16_t, r_ldt);
234 		WAKECODE_BCOPY(previous_idt, struct region_descriptor, r_idt);
235 
236 		WAKECODE_FIXUP(where_to_recover, void *, acpi_restorecpu);
237 
238 		WAKECODE_FIXUP(previous_ds,  uint16_t, r_ds);
239 		WAKECODE_FIXUP(previous_es,  uint16_t, r_es);
240 		WAKECODE_FIXUP(previous_fs,  uint16_t, r_fs);
241 		WAKECODE_FIXUP(previous_gs,  uint16_t, r_gs);
242 		WAKECODE_FIXUP(previous_ss,  uint16_t, r_ss);
243 
244 		if (bootverbose)
245 			acpi_printcpu();
246 
247 		/* Call ACPICA to enter the desired sleep state */
248 		if (state == ACPI_STATE_S4 && sc->acpi_s4bios)
249 			status = AcpiEnterSleepStateS4bios();
250 		else
251 			status = AcpiEnterSleepState(state);
252 
253 		if (status != AE_OK) {
254 			device_printf(sc->acpi_dev,
255 				"AcpiEnterSleepState failed - %s\n",
256 				AcpiFormatException(status));
257 			ret = -1;
258 			goto out;
259 		}
260 
261 		for (;;) ;
262 	} else {
263 		/* Execute Wakeup */
264 #if 0
265 		initializecpu();
266 #endif
267 		intr_resume();
268 
269 		if (bootverbose) {
270 			acpi_savecpu();
271 			acpi_printcpu();
272 		}
273 	}
274 
275 out:
276 	pmap_remove(pm, sc->acpi_wakephys, sc->acpi_wakephys + PAGE_SIZE);
277 	if (opage) {
278 		pmap_enter(pm, sc->acpi_wakephys, page,
279 			   VM_PROT_READ | VM_PROT_WRITE, 0);
280 	}
281 
282 	load_cr3(cr3);
283 
284 	write_eflags(ef);
285 
286 	return (ret);
287 }
288 
289 static bus_dma_tag_t	acpi_waketag;
290 static bus_dmamap_t	acpi_wakemap;
291 static vm_offset_t	acpi_wakeaddr = 0;
292 
293 static void
294 acpi_alloc_wakeup_handler(void)
295 {
296 	void *wakeaddr;
297 
298 	if (!cold)
299 		return;
300 
301 	if (bus_dma_tag_create(/* parent */ NULL, /* alignment */ 2, 0,
302 			       /* lowaddr below 1MB */ 0x9ffff,
303 			       /* highaddr */ BUS_SPACE_MAXADDR, NULL, NULL,
304 				PAGE_SIZE, 1, PAGE_SIZE, 0, busdma_lock_mutex,
305 				&Giant, &acpi_waketag) != 0) {
306 		printf("acpi_alloc_wakeup_handler: can't create wake tag\n");
307 		return;
308 	}
309 	if (bus_dmamem_alloc(acpi_waketag, &wakeaddr,
310 			     BUS_DMA_NOWAIT, &acpi_wakemap)) {
311 		printf("acpi_alloc_wakeup_handler: can't alloc wake memory\n");
312 		return;
313 	}
314 	acpi_wakeaddr = (vm_offset_t)wakeaddr;
315 }
316 
317 SYSINIT(acpiwakeup, SI_SUB_KMEM, SI_ORDER_ANY, acpi_alloc_wakeup_handler, 0)
318 
319 static void
320 acpi_realmodeinst(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
321 {
322 	struct acpi_softc	*sc = arg;
323 	uint32_t		*addr;
324 
325 	addr = (uint32_t *)&wakecode[wakeup_sw32 + 2];
326 	*addr = segs[0].ds_addr + wakeup_32;
327 	bcopy(wakecode, (void *)sc->acpi_wakeaddr, sizeof(wakecode));
328 	sc->acpi_wakephys = segs[0].ds_addr;
329 }
330 
331 void
332 acpi_install_wakeup_handler(struct acpi_softc *sc)
333 {
334 	if (acpi_wakeaddr == 0)
335 		return;
336 
337 	sc->acpi_waketag = acpi_waketag;
338 	sc->acpi_wakeaddr = acpi_wakeaddr;
339 	sc->acpi_wakemap = acpi_wakemap;
340 
341 	bus_dmamap_load(sc->acpi_waketag, sc->acpi_wakemap,
342 			(void *)sc->acpi_wakeaddr, PAGE_SIZE,
343 			acpi_realmodeinst, sc, 0);
344 }
345