xref: /freebsd/sys/i386/acpica/acpi_wakeup.c (revision c17d43407fe04133a94055b0dbc7ea8965654a9f)
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  *      $FreeBSD$
28  */
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/bus.h>
34 #include <sys/lock.h>
35 #include <sys/mutex.h>
36 #include <sys/proc.h>
37 #include <sys/sysctl.h>
38 
39 #include <vm/vm.h>
40 #include <vm/vm_param.h>
41 #include <vm/pmap.h>
42 #include <vm/vm_object.h>
43 #include <vm/vm_page.h>
44 #include <vm/vm_map.h>
45 #include <vm/vm_kern.h>
46 #include <vm/vm_extern.h>
47 
48 #include <machine/bus.h>
49 #include <machine/cpufunc.h>
50 #include <machine/segments.h>
51 
52 #include <i386/isa/intr_machdep.h>
53 
54 #include "acpi.h"
55 
56 #include <dev/acpica/acpica_support.h>
57 
58 #include <dev/acpica/acpivar.h>
59 
60 #include "acpi_wakecode.h"
61 
62 extern void initializecpu(void);
63 
64 static struct region_descriptor	r_idt, r_gdt, *p_gdt;
65 static u_int16_t	r_ldt;
66 
67 static u_int32_t	r_eax, r_ebx, r_ecx, r_edx, r_ebp, r_esi, r_edi,
68 			r_efl, r_cr0, r_cr2, r_cr3, r_cr4, ret_addr;
69 
70 static u_int16_t	r_cs, r_ds, r_es, r_fs, r_gs, r_ss, r_tr;
71 static u_int32_t	r_esp = 0;
72 
73 static void		acpi_printcpu(void);
74 static void		acpi_realmodeinst(void *arg, bus_dma_segment_t *segs,
75 					  int nsegs, int error);
76 static void		acpi_alloc_wakeup_handler(void);
77 
78 /* XXX shut gcc up */
79 extern int		acpi_savecpu(void);
80 extern int		acpi_restorecpu(void);
81 
82 __asm__("
83 	.text
84 	.p2align 2, 0x90
85 	.type acpi_restorecpu, @function
86 acpi_restorecpu:
87 	.align 4
88 	movl	r_eax,%eax
89 	movl	r_ebx,%ebx
90 	movl	r_ecx,%ecx
91 	movl	r_edx,%edx
92 	movl	r_ebp,%ebp
93 	movl	r_esi,%esi
94 	movl	r_edi,%edi
95 	movl	r_esp,%esp
96 
97 	pushl	r_efl
98 	popfl
99 
100 	pushl	ret_addr
101 	xorl	%eax,%eax
102 	ret
103 
104 	.text
105 	.p2align 2, 0x90
106 	.type acpi_savecpu, @function
107 acpi_savecpu:
108 	movw	%cs,r_cs
109 	movw	%ds,r_ds
110 	movw	%es,r_es
111 	movw	%fs,r_fs
112 	movw	%gs,r_gs
113 	movw	%ss,r_ss
114 
115 	movl	%eax,r_eax
116 	movl	%ebx,r_ebx
117 	movl	%ecx,r_ecx
118 	movl	%edx,r_edx
119 	movl	%ebp,r_ebp
120 	movl	%esi,r_esi
121 	movl	%edi,r_edi
122 
123 	movl	%cr0,%eax
124 	movl	%eax,r_cr0
125 	movl	%cr2,%eax
126 	movl	%eax,r_cr2
127 	movl	%cr3,%eax
128 	movl	%eax,r_cr3
129 	movl	%cr4,%eax
130 	movl	%eax,r_cr4
131 
132 	pushfl
133 	popl	r_efl
134 
135 	movl	%esp,r_esp
136 
137 	sgdt	r_gdt
138 	sidt	r_idt
139 	sldt	r_ldt
140 	str	r_tr
141 
142 	movl	(%esp),%eax
143 	movl	%eax,ret_addr
144 	movl	$1,%eax
145 	ret
146 ");
147 
148 static void
149 acpi_printcpu(void)
150 {
151 
152 	printf("======== acpi_printcpu() debug dump ========\n");
153 	printf("gdt[%04x:%08x] idt[%04x:%08x] ldt[%04x] tr[%04x] efl[%08x]\n",
154 		r_gdt.rd_limit, r_gdt.rd_base, r_idt.rd_limit, r_idt.rd_base,
155 		r_ldt, r_tr, r_efl);
156 	printf("eax[%08x] ebx[%08x] ecx[%08x] edx[%08x]\n",
157 		r_eax, r_ebx, r_ecx, r_edx);
158 	printf("esi[%08x] edi[%08x] ebp[%08x] esp[%08x]\n",
159 		r_esi, r_edi, r_ebp, r_esp);
160 	printf("cr0[%08x] cr2[%08x] cr3[%08x] cr4[%08x]\n",
161 		r_cr0, r_cr2, r_cr3, r_cr4);
162 	printf("cs[%04x] ds[%04x] es[%04x] fs[%04x] gs[%04x] ss[%04x]\n",
163 		r_cs, r_ds, r_es, r_fs, r_gs, r_ss);
164 }
165 
166 #define WAKECODE_FIXUP(offset, type, val) do	{		\
167 	void	**addr;						\
168 	addr = (void **)(sc->acpi_wakeaddr + offset);		\
169 	(type *)*addr = val;					\
170 } while (0)
171 
172 #define WAKECODE_BCOPY(offset, type, val) do	{		\
173 	void	**addr;						\
174 	addr = (void **)(sc->acpi_wakeaddr + offset);		\
175 	bcopy(&(val), addr, sizeof(type));			\
176 } while (0)
177 
178 int
179 acpi_sleep_machdep(struct acpi_softc *sc, int state)
180 {
181 	ACPI_STATUS		status;
182 	vm_offset_t		oldphys;
183 	struct pmap		*pm;
184 	vm_page_t		page;
185 	static vm_page_t	opage = NULL;
186 	int			ret = 0;
187 	int			pteobj_allocated = 0;
188 	u_long			ef;
189 
190 	if (sc->acpi_wakeaddr == NULL) {
191 		return (0);
192 	}
193 
194 	AcpiSetFirmwareWakingVector(sc->acpi_wakephys);
195 
196 	ef = read_eflags();
197 	disable_intr();
198 
199 	/* Create Identity Mapping */
200 	pm = vmspace_pmap(CURPROC->p_vmspace);
201 	if (pm->pm_pteobj == NULL) {
202 		pm->pm_pteobj = vm_object_allocate(OBJT_DEFAULT, PTDPTDI + 1);
203 		pteobj_allocated = 1;
204 	}
205 
206 	oldphys = pmap_extract(pm, sc->acpi_wakephys);
207 	if (oldphys) {
208 		opage = PHYS_TO_VM_PAGE(oldphys);
209 	}
210 	page = PHYS_TO_VM_PAGE(sc->acpi_wakephys);
211 	pmap_enter(pm, sc->acpi_wakephys, page,
212 		   VM_PROT_READ | VM_PROT_WRITE | VM_PROT_EXECUTE, 1);
213 
214 	ret_addr = 0;
215 	if (acpi_savecpu()) {
216 		/* Execute Sleep */
217 		p_gdt = (struct region_descriptor *)(sc->acpi_wakeaddr + physical_gdt);
218 		p_gdt->rd_limit = r_gdt.rd_limit;
219 		p_gdt->rd_base = vtophys(r_gdt.rd_base);
220 
221 		WAKECODE_FIXUP(physical_esp, u_int32_t, vtophys(r_esp));
222 		WAKECODE_FIXUP(previous_cr0, u_int32_t, r_cr0);
223 		WAKECODE_FIXUP(previous_cr2, u_int32_t, r_cr2);
224 		WAKECODE_FIXUP(previous_cr3, u_int32_t, r_cr3);
225 		WAKECODE_FIXUP(previous_cr4, u_int32_t, r_cr4);
226 
227 		WAKECODE_FIXUP(previous_tr,  u_int16_t, r_tr);
228 		WAKECODE_BCOPY(previous_gdt, struct region_descriptor, r_gdt);
229 		WAKECODE_FIXUP(previous_ldt, u_int16_t, r_ldt);
230 		WAKECODE_BCOPY(previous_idt, struct region_descriptor, r_idt);
231 
232 		WAKECODE_FIXUP(where_to_recover, void, acpi_restorecpu);
233 
234 		WAKECODE_FIXUP(previous_ds,  u_int16_t, r_ds);
235 		WAKECODE_FIXUP(previous_es,  u_int16_t, r_es);
236 		WAKECODE_FIXUP(previous_fs,  u_int16_t, r_fs);
237 		WAKECODE_FIXUP(previous_gs,  u_int16_t, r_gs);
238 		WAKECODE_FIXUP(previous_ss,  u_int16_t, r_ss);
239 
240 		if (acpi_get_verbose(sc)) {
241 			acpi_printcpu();
242 		}
243 
244 		wbinvd();
245 
246 		if (state == ACPI_STATE_S4 && sc->acpi_s4bios) {
247 			status = AcpiEnterSleepStateS4Bios();
248 		} else {
249 			status = AcpiEnterSleepState(state);
250 		}
251 
252 		if (status != AE_OK) {
253 			device_printf(sc->acpi_dev,
254 				"AcpiEnterSleepState failed - %s\n",
255 				AcpiFormatException(status));
256 			ret = -1;
257 			goto out;
258 		}
259 
260 		for (;;) ;
261 	} else {
262 		/* Execute Wakeup */
263 #if 0
264 		initializecpu();
265 #endif
266 		icu_reinit();
267 
268 		if (acpi_get_verbose(sc)) {
269 			acpi_savecpu();
270 			acpi_printcpu();
271 		}
272 	}
273 
274 out:
275 	pmap_remove(pm, sc->acpi_wakephys, sc->acpi_wakephys + PAGE_SIZE);
276 	if (opage) {
277 		pmap_enter(pm, sc->acpi_wakephys, page,
278 			   VM_PROT_READ | VM_PROT_WRITE, 0);
279 	}
280 
281 	if (pteobj_allocated) {
282 		vm_object_deallocate(pm->pm_pteobj);
283 		pm->pm_pteobj = NULL;
284 	}
285 
286 	write_eflags(ef);
287 
288 	return (ret);
289 }
290 
291 static bus_dma_tag_t	acpi_waketag;
292 static bus_dmamap_t	acpi_wakemap;
293 static vm_offset_t	acpi_wakeaddr = 0;
294 
295 static void
296 acpi_alloc_wakeup_handler(void)
297 {
298 
299 	if (bus_dma_tag_create(/* parent */ NULL, /* alignment */ 2, 0,
300 			       /* lowaddr below 1MB */ 0x9ffff,
301 			       /* highaddr */ BUS_SPACE_MAXADDR, NULL, NULL,
302 				PAGE_SIZE, 1, PAGE_SIZE, 0, &acpi_waketag) != 0) {
303 		printf("acpi_alloc_wakeup_handler: unable to create wake tag\n");
304 		return;
305 	}
306 
307 	if (bus_dmamem_alloc(acpi_waketag, (void **)&acpi_wakeaddr,
308 			     BUS_DMA_NOWAIT, &acpi_wakemap)) {
309 		printf("acpi_alloc_wakeup_handler: unable to allocate wake memory\n");
310 		return;
311 	}
312 }
313 
314 SYSINIT(acpiwakeup, SI_SUB_KMEM, SI_ORDER_ANY, acpi_alloc_wakeup_handler, 0)
315 
316 static void
317 acpi_realmodeinst(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
318 {
319 	struct acpi_softc	*sc = arg;
320 	u_int32_t		*addr;
321 
322 	addr = (u_int32_t *)&wakecode[wakeup_sw32 + 2];
323 	*addr = segs[0].ds_addr + wakeup_32;
324 	bcopy(wakecode, (void *)sc->acpi_wakeaddr, sizeof(wakecode));
325 	sc->acpi_wakephys = segs[0].ds_addr;
326 }
327 
328 void
329 acpi_install_wakeup_handler(struct acpi_softc *sc)
330 {
331 
332 	if (acpi_wakeaddr == 0) {
333 		return;
334 	}
335 
336 	sc->acpi_waketag = acpi_waketag;
337 	sc->acpi_wakeaddr = acpi_wakeaddr;
338 	sc->acpi_wakemap = acpi_wakemap;
339 
340 	bus_dmamap_load(sc->acpi_waketag, sc->acpi_wakemap,
341 			(void *)sc->acpi_wakeaddr, PAGE_SIZE,
342 			acpi_realmodeinst, sc, 0);
343 }
344 
345