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