xref: /freebsd/sys/i386/acpica/acpi_wakeup.c (revision c0b9f4fe659b6839541970eb5675e57f4d814969)
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 <contrib/dev/acpica/acpi.h>
51 #include <dev/acpica/acpivar.h>
52 
53 #include "acpi_wakecode.h"
54 
55 #ifndef _SYS_CDEFS_H_
56 #error this file needs sys/cdefs.h as a prerequisite
57 #endif
58 
59 extern uint32_t	acpi_reset_video;
60 extern void	initializecpu(void);
61 
62 static struct region_descriptor	saved_idt, saved_gdt, *p_gdt;
63 static uint16_t		saved_ldt;
64 
65 static uint32_t		r_eax, r_ebx, r_ecx, r_edx, r_ebp, r_esi, r_edi,
66 			r_efl, r_cr0, r_cr2, r_cr3, r_cr4, ret_addr;
67 
68 static uint16_t		r_cs, r_ds, r_es, r_fs, r_gs, r_ss, r_tr;
69 static uint32_t		r_esp = 0;
70 
71 static void		acpi_printcpu(void);
72 static void		acpi_realmodeinst(void *arg, bus_dma_segment_t *segs,
73 					  int nsegs, int error);
74 static void		acpi_alloc_wakeup_handler(void);
75 
76 /* XXX shut gcc up */
77 extern int		acpi_savecpu(void);
78 extern int		acpi_restorecpu(void);
79 
80 #ifdef __GNUCLIKE_ASM
81 __asm__("				\n\
82 	.text				\n\
83 	.p2align 2, 0x90		\n\
84 	.type acpi_restorecpu, @function\n\
85 acpi_restorecpu:			\n\
86 	.align 4			\n\
87 	movl	r_eax,%eax		\n\
88 	movl	r_ebx,%ebx		\n\
89 	movl	r_ecx,%ecx		\n\
90 	movl	r_edx,%edx		\n\
91 	movl	r_ebp,%ebp		\n\
92 	movl	r_esi,%esi		\n\
93 	movl	r_edi,%edi		\n\
94 	movl	r_esp,%esp		\n\
95 					\n\
96 	pushl	r_efl			\n\
97 	popfl				\n\
98 					\n\
99 	movl	ret_addr,%eax		\n\
100 	movl	%eax,(%esp)		\n\
101 	xorl	%eax,%eax		\n\
102 	ret				\n\
103 					\n\
104 	.text				\n\
105 	.p2align 2, 0x90		\n\
106 	.type acpi_savecpu, @function	\n\
107 acpi_savecpu:				\n\
108 	movw	%cs,r_cs		\n\
109 	movw	%ds,r_ds		\n\
110 	movw	%es,r_es		\n\
111 	movw	%fs,r_fs		\n\
112 	movw	%gs,r_gs		\n\
113 	movw	%ss,r_ss		\n\
114 					\n\
115 	movl	%eax,r_eax		\n\
116 	movl	%ebx,r_ebx		\n\
117 	movl	%ecx,r_ecx		\n\
118 	movl	%edx,r_edx		\n\
119 	movl	%ebp,r_ebp		\n\
120 	movl	%esi,r_esi		\n\
121 	movl	%edi,r_edi		\n\
122 					\n\
123 	movl	%cr0,%eax		\n\
124 	movl	%eax,r_cr0		\n\
125 	movl	%cr2,%eax		\n\
126 	movl	%eax,r_cr2		\n\
127 	movl	%cr3,%eax		\n\
128 	movl	%eax,r_cr3		\n\
129 	movl	%cr4,%eax		\n\
130 	movl	%eax,r_cr4		\n\
131 					\n\
132 	pushfl				\n\
133 	popl	r_efl			\n\
134 					\n\
135 	movl	%esp,r_esp		\n\
136 					\n\
137 	sgdt	saved_gdt		\n\
138 	sidt	saved_idt		\n\
139 	sldt	saved_ldt		\n\
140 	str	r_tr			\n\
141 					\n\
142 	movl	(%esp),%eax		\n\
143 	movl	%eax,ret_addr		\n\
144 	movl	$1,%eax			\n\
145 	ret				\n\
146 ");
147 #endif /* __GNUCLIKE_ASM */
148 
149 static void
150 acpi_printcpu(void)
151 {
152 	printf("======== acpi_printcpu() debug dump ========\n");
153 	printf("gdt[%04x:%08x] idt[%04x:%08x] ldt[%04x] tr[%04x] efl[%08x]\n",
154 		saved_gdt.rd_limit, saved_gdt.rd_base,
155 		saved_idt.rd_limit, saved_idt.rd_base,
156 		saved_ldt, r_tr, r_efl);
157 	printf("eax[%08x] ebx[%08x] ecx[%08x] edx[%08x]\n",
158 		r_eax, r_ebx, r_ecx, r_edx);
159 	printf("esi[%08x] edi[%08x] ebp[%08x] esp[%08x]\n",
160 		r_esi, r_edi, r_ebp, r_esp);
161 	printf("cr0[%08x] cr2[%08x] cr3[%08x] cr4[%08x]\n",
162 		r_cr0, r_cr2, r_cr3, r_cr4);
163 	printf("cs[%04x] ds[%04x] es[%04x] fs[%04x] gs[%04x] ss[%04x]\n",
164 		r_cs, r_ds, r_es, r_fs, r_gs, r_ss);
165 }
166 
167 #define WAKECODE_FIXUP(offset, type, val) do	{		\
168 	type	*addr;						\
169 	addr = (type *)(sc->acpi_wakeaddr + offset);		\
170 	*addr = val;						\
171 } while (0)
172 
173 #define WAKECODE_BCOPY(offset, type, val) do	{		\
174 	void	*addr;						\
175 	addr = (void *)(sc->acpi_wakeaddr + offset);		\
176 	bcopy(&(val), addr, sizeof(type));			\
177 } while (0)
178 
179 int
180 acpi_sleep_machdep(struct acpi_softc *sc, int state)
181 {
182 	ACPI_STATUS		status;
183 	struct pmap		*pm;
184 	vm_page_t		page;
185 	int			ret;
186 	uint32_t		cr3;
187 	u_long			ef;
188 	struct proc		*p;
189 
190 	ret = 0;
191 	if (sc->acpi_wakeaddr == 0)
192 		return (0);
193 
194 	AcpiSetFirmwareWakingVector(sc->acpi_wakephys);
195 
196 	ef = read_eflags();
197 
198 	/* Create Identity Mapping */
199 	if ((p = curproc) == NULL)
200 		p = &proc0;
201 	pm = vmspace_pmap(p->p_vmspace);
202 	cr3 = rcr3();
203 #ifdef PAE
204 	load_cr3(vtophys(pm->pm_pdpt));
205 #else
206 	load_cr3(vtophys(pm->pm_pdir));
207 #endif
208 
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 	ACPI_DISABLE_IRQS();
215 	if (acpi_savecpu()) {
216 		/* Execute Sleep */
217 		intr_suspend();
218 
219 		p_gdt = (struct region_descriptor *)
220 				(sc->acpi_wakeaddr + physical_gdt);
221 		p_gdt->rd_limit = saved_gdt.rd_limit;
222 		p_gdt->rd_base = vtophys(saved_gdt.rd_base);
223 
224 		WAKECODE_FIXUP(physical_esp, uint32_t, vtophys(r_esp));
225 		WAKECODE_FIXUP(previous_cr0, uint32_t, r_cr0);
226 		WAKECODE_FIXUP(previous_cr2, uint32_t, r_cr2);
227 		WAKECODE_FIXUP(previous_cr3, uint32_t, r_cr3);
228 		WAKECODE_FIXUP(previous_cr4, uint32_t, r_cr4);
229 
230 		WAKECODE_FIXUP(reset_video, uint32_t, acpi_reset_video);
231 
232 		WAKECODE_FIXUP(previous_tr,  uint16_t, r_tr);
233 		WAKECODE_BCOPY(previous_gdt, struct region_descriptor, saved_gdt);
234 		WAKECODE_FIXUP(previous_ldt, uint16_t, saved_ldt);
235 		WAKECODE_BCOPY(previous_idt, struct region_descriptor, saved_idt);
236 
237 		WAKECODE_FIXUP(where_to_recover, void *, acpi_restorecpu);
238 
239 		WAKECODE_FIXUP(previous_ds,  uint16_t, r_ds);
240 		WAKECODE_FIXUP(previous_es,  uint16_t, r_es);
241 		WAKECODE_FIXUP(previous_fs,  uint16_t, r_fs);
242 		WAKECODE_FIXUP(previous_gs,  uint16_t, r_gs);
243 		WAKECODE_FIXUP(previous_ss,  uint16_t, r_ss);
244 
245 		if (bootverbose)
246 			acpi_printcpu();
247 
248 		/* Call ACPICA to enter the desired sleep state */
249 		if (state == ACPI_STATE_S4 && sc->acpi_s4bios)
250 			status = AcpiEnterSleepStateS4bios();
251 		else
252 			status = AcpiEnterSleepState(state);
253 
254 		if (status != AE_OK) {
255 			device_printf(sc->acpi_dev,
256 				"AcpiEnterSleepState failed - %s\n",
257 				AcpiFormatException(status));
258 			ret = -1;
259 			goto out;
260 		}
261 
262 		for (;;) ;
263 	} else {
264 		/* Execute Wakeup */
265 		intr_resume();
266 
267 		if (bootverbose) {
268 			acpi_savecpu();
269 			acpi_printcpu();
270 		}
271 	}
272 
273 out:
274 	pmap_remove(pm, sc->acpi_wakephys, sc->acpi_wakephys + PAGE_SIZE);
275 	load_cr3(cr3);
276 	write_eflags(ef);
277 
278 	return (ret);
279 }
280 
281 static bus_dma_tag_t	acpi_waketag;
282 static bus_dmamap_t	acpi_wakemap;
283 static vm_offset_t	acpi_wakeaddr = 0;
284 
285 static void
286 acpi_alloc_wakeup_handler(void)
287 {
288 	void *wakeaddr;
289 
290 	if (!cold)
291 		return;
292 
293 	if (bus_dma_tag_create(/* parent */ NULL, /* alignment */ 2, 0,
294 			       /* lowaddr below 1MB */ 0x9ffff,
295 			       /* highaddr */ BUS_SPACE_MAXADDR, NULL, NULL,
296 				PAGE_SIZE, 1, PAGE_SIZE, 0, busdma_lock_mutex,
297 				&Giant, &acpi_waketag) != 0) {
298 		printf("acpi_alloc_wakeup_handler: can't create wake tag\n");
299 		return;
300 	}
301 	if (bus_dmamem_alloc(acpi_waketag, &wakeaddr,
302 			     BUS_DMA_NOWAIT, &acpi_wakemap)) {
303 		printf("acpi_alloc_wakeup_handler: can't alloc wake memory\n");
304 		return;
305 	}
306 	acpi_wakeaddr = (vm_offset_t)wakeaddr;
307 }
308 
309 SYSINIT(acpiwakeup, SI_SUB_KMEM, SI_ORDER_ANY, acpi_alloc_wakeup_handler, 0)
310 
311 static void
312 acpi_realmodeinst(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
313 {
314 	struct acpi_softc	*sc = arg;
315 	uint32_t		*addr;
316 
317 	addr = (uint32_t *)&wakecode[wakeup_sw32 + 2];
318 	*addr = segs[0].ds_addr + wakeup_32;
319 	bcopy(wakecode, (void *)sc->acpi_wakeaddr, sizeof(wakecode));
320 	sc->acpi_wakephys = segs[0].ds_addr;
321 }
322 
323 void
324 acpi_install_wakeup_handler(struct acpi_softc *sc)
325 {
326 	if (acpi_wakeaddr == 0)
327 		return;
328 
329 	sc->acpi_waketag = acpi_waketag;
330 	sc->acpi_wakeaddr = acpi_wakeaddr;
331 	sc->acpi_wakemap = acpi_wakemap;
332 
333 	bus_dmamap_load(sc->acpi_waketag, sc->acpi_wakemap,
334 			(void *)sc->acpi_wakeaddr, PAGE_SIZE,
335 			acpi_realmodeinst, sc, 0);
336 }
337