acpi_apm.c revision 170976 
1/*-
2 * Copyright (c) 2001 Mitsuru IWASAKI
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: head/sys/i386/acpica/acpi_machdep.c 170976 2007-06-21 22:50:37Z njl $");
29
30#include <sys/param.h>
31#include <sys/bus.h>
32#include <sys/condvar.h>
33#include <sys/conf.h>
34#include <sys/fcntl.h>
35#include <sys/kernel.h>
36#include <sys/malloc.h>
37#include <sys/poll.h>
38#include <sys/sysctl.h>
39#include <sys/uio.h>
40#include <vm/vm.h>
41#include <vm/pmap.h>
42
43#include <contrib/dev/acpica/acpi.h>
44#include <dev/acpica/acpivar.h>
45#include <dev/acpica/acpiio.h>
46
47/*
48 * APM driver emulation
49 */
50
51#include <machine/apm_bios.h>
52#include <machine/pc/bios.h>
53
54#include <i386/bios/apm.h>
55
56SYSCTL_DECL(_debug_acpi);
57
58uint32_t acpi_resume_beep;
59TUNABLE_INT("debug.acpi.resume_beep", &acpi_resume_beep);
60SYSCTL_UINT(_debug_acpi, OID_AUTO, resume_beep, CTLFLAG_RW, &acpi_resume_beep,
61    0, "Beep the PC speaker when resuming");
62uint32_t acpi_reset_video;
63TUNABLE_INT("hw.acpi.reset_video", &acpi_reset_video);
64
65static int intr_model = ACPI_INTR_PIC;
66static int apm_active;
67static struct clonedevs *apm_clones;
68
69MALLOC_DEFINE(M_APMDEV, "apmdev", "APM device emulation");
70
71static d_open_t		apmopen;
72static d_close_t	apmclose;
73static d_write_t	apmwrite;
74static d_ioctl_t	apmioctl;
75static d_poll_t		apmpoll;
76static d_kqfilter_t	apmkqfilter;
77static void		apmreadfiltdetach(struct knote *kn);
78static int		apmreadfilt(struct knote *kn, long hint);
79static struct filterops	apm_readfiltops =
80	{ 1, NULL, apmreadfiltdetach, apmreadfilt };
81
82static struct cdevsw apm_cdevsw = {
83	.d_version =	D_VERSION,
84	.d_flags =	D_TRACKCLOSE,
85	.d_open =	apmopen,
86	.d_close =	apmclose,
87	.d_write =	apmwrite,
88	.d_ioctl =	apmioctl,
89	.d_poll =	apmpoll,
90	.d_name =	"apm",
91	.d_kqfilter =	apmkqfilter
92};
93
94static int
95acpi_capm_convert_battstate(struct  acpi_battinfo *battp)
96{
97	int	state;
98
99	state = APM_UNKNOWN;
100
101	if (battp->state & ACPI_BATT_STAT_DISCHARG) {
102		if (battp->cap >= 50)
103			state = 0;	/* high */
104		else
105			state = 1;	/* low */
106	}
107	if (battp->state & ACPI_BATT_STAT_CRITICAL)
108		state = 2;		/* critical */
109	if (battp->state & ACPI_BATT_STAT_CHARGING)
110		state = 3;		/* charging */
111
112	/* If still unknown, determine it based on the battery capacity. */
113	if (state == APM_UNKNOWN) {
114		if (battp->cap >= 50)
115			state = 0;	/* high */
116		else
117			state = 1;	/* low */
118	}
119
120	return (state);
121}
122
123static int
124acpi_capm_convert_battflags(struct  acpi_battinfo *battp)
125{
126	int	flags;
127
128	flags = 0;
129
130	if (battp->cap >= 50)
131		flags |= APM_BATT_HIGH;
132	else {
133		if (battp->state & ACPI_BATT_STAT_CRITICAL)
134			flags |= APM_BATT_CRITICAL;
135		else
136			flags |= APM_BATT_LOW;
137	}
138	if (battp->state & ACPI_BATT_STAT_CHARGING)
139		flags |= APM_BATT_CHARGING;
140	if (battp->state == ACPI_BATT_STAT_NOT_PRESENT)
141		flags = APM_BATT_NOT_PRESENT;
142
143	return (flags);
144}
145
146static int
147acpi_capm_get_info(apm_info_t aip)
148{
149	int	acline;
150	struct	acpi_battinfo batt;
151
152	aip->ai_infoversion = 1;
153	aip->ai_major       = 1;
154	aip->ai_minor       = 2;
155	aip->ai_status      = apm_active;
156	aip->ai_capabilities= 0xff00;	/* unknown */
157
158	if (acpi_acad_get_acline(&acline))
159		aip->ai_acline = APM_UNKNOWN;	/* unknown */
160	else
161		aip->ai_acline = acline;	/* on/off */
162
163	if (acpi_battery_get_battinfo(NULL, &batt) != 0) {
164		aip->ai_batt_stat = APM_UNKNOWN;
165		aip->ai_batt_life = APM_UNKNOWN;
166		aip->ai_batt_time = -1;		 /* unknown */
167		aip->ai_batteries = ~0U;	 /* unknown */
168	} else {
169		aip->ai_batt_stat = acpi_capm_convert_battstate(&batt);
170		aip->ai_batt_life = batt.cap;
171		aip->ai_batt_time = (batt.min == -1) ? -1 : batt.min * 60;
172		aip->ai_batteries = acpi_battery_get_units();
173	}
174
175	return (0);
176}
177
178static int
179acpi_capm_get_pwstatus(apm_pwstatus_t app)
180{
181	device_t dev;
182	int	acline, unit, error;
183	struct	acpi_battinfo batt;
184
185	if (app->ap_device != PMDV_ALLDEV &&
186	    (app->ap_device < PMDV_BATT0 || app->ap_device > PMDV_BATT_ALL))
187		return (1);
188
189	if (app->ap_device == PMDV_ALLDEV)
190		error = acpi_battery_get_battinfo(NULL, &batt);
191	else {
192		unit = app->ap_device - PMDV_BATT0;
193		dev = devclass_get_device(devclass_find("battery"), unit);
194		if (dev != NULL)
195			error = acpi_battery_get_battinfo(dev, &batt);
196		else
197			error = ENXIO;
198	}
199	if (error)
200		return (1);
201
202	app->ap_batt_stat = acpi_capm_convert_battstate(&batt);
203	app->ap_batt_flag = acpi_capm_convert_battflags(&batt);
204	app->ap_batt_life = batt.cap;
205	app->ap_batt_time = (batt.min == -1) ? -1 : batt.min * 60;
206
207	if (acpi_acad_get_acline(&acline))
208		app->ap_acline = APM_UNKNOWN;
209	else
210		app->ap_acline = acline;	/* on/off */
211
212	return (0);
213}
214
215/* Create single-use devices for /dev/apm and /dev/apmctl. */
216static void
217apm_clone(void *arg, struct ucred *cred, char *name, int namelen,
218    struct cdev **dev)
219{
220	int ctl_dev, unit;
221
222	if (*dev != NULL)
223		return;
224	if (strcmp(name, "apmctl") == 0)
225		ctl_dev = TRUE;
226	else if (strcmp(name, "apm") == 0)
227		ctl_dev = FALSE;
228	else
229		return;
230
231	/* Always create a new device and unit number. */
232	unit = -1;
233	if (clone_create(&apm_clones, &apm_cdevsw, &unit, dev, 0)) {
234		if (ctl_dev) {
235			*dev = make_dev(&apm_cdevsw, unit2minor(unit),
236			    UID_ROOT, GID_OPERATOR, 0660, "apmctl%d", unit);
237		} else {
238			*dev = make_dev(&apm_cdevsw, unit2minor(unit),
239			    UID_ROOT, GID_OPERATOR, 0664, "apm%d", unit);
240		}
241		if (*dev != NULL) {
242			dev_ref(*dev);
243			(*dev)->si_flags |= SI_CHEAPCLONE;
244		}
245	}
246}
247
248/* Create a struct for tracking per-device suspend notification. */
249static struct apm_clone_data *
250apm_create_clone(struct cdev *dev, struct acpi_softc *acpi_sc)
251{
252	struct apm_clone_data *clone;
253
254	clone = malloc(sizeof(*clone), M_APMDEV, M_WAITOK);
255	clone->cdev = dev;
256	clone->acpi_sc = acpi_sc;
257	clone->notify_status = APM_EV_NONE;
258	bzero(&clone->sel_read, sizeof(clone->sel_read));
259	knlist_init(&clone->sel_read.si_note, &acpi_mutex, NULL, NULL, NULL);
260
261	/*
262	 * The acpi device is always managed by devd(8) and is considered
263	 * writable (i.e., ack is required to allow suspend to proceed.)
264	 */
265	if (strcmp("acpi", devtoname(dev)) == 0)
266		clone->flags = ACPI_EVF_DEVD | ACPI_EVF_WRITE;
267	else
268		clone->flags = ACPI_EVF_NONE;
269
270	ACPI_LOCK(acpi);
271	STAILQ_INSERT_TAIL(&acpi_sc->apm_cdevs, clone, entries);
272	ACPI_UNLOCK(acpi);
273	return (clone);
274}
275
276/* XXX Kernel should be updated to allow calls to destroy_dev() in close(). */
277static void
278apm_destroy_clone(void *arg)
279{
280
281	destroy_dev((struct cdev *)arg);
282}
283
284static int
285apmopen(struct cdev *dev, int flag, int fmt, d_thread_t *td)
286{
287	struct	acpi_softc *acpi_sc;
288	struct 	apm_clone_data *clone;
289
290	acpi_sc = devclass_get_softc(devclass_find("acpi"), 0);
291	clone = apm_create_clone(dev, acpi_sc);
292	dev->si_drv1 = clone;
293
294	/* If the device is opened for write, record that. */
295	if ((flag & FWRITE) != 0)
296		clone->flags |= ACPI_EVF_WRITE;
297
298	return (0);
299}
300
301static int
302apmclose(struct cdev *dev, int flag, int fmt, d_thread_t *td)
303{
304	struct	apm_clone_data *clone;
305	struct	acpi_softc *acpi_sc;
306
307	clone = dev->si_drv1;
308	acpi_sc = clone->acpi_sc;
309
310	/* We are about to lose a reference so check if suspend should occur */
311	if (acpi_sc->acpi_next_sstate != 0 &&
312	    clone->notify_status != APM_EV_ACKED)
313		acpi_AckSleepState(clone, 0);
314
315	/* Remove this clone's data from the list and free it. */
316	ACPI_LOCK(acpi);
317	STAILQ_REMOVE(&acpi_sc->apm_cdevs, clone, apm_clone_data, entries);
318	knlist_destroy(&clone->sel_read.si_note);
319	ACPI_UNLOCK(acpi);
320	free(clone, M_APMDEV);
321	AcpiOsExecute(OSL_GPE_HANDLER, apm_destroy_clone, dev);
322	return (0);
323}
324
325static int
326apmioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, d_thread_t *td)
327{
328	int	error;
329	struct	apm_clone_data *clone;
330	struct	acpi_softc *acpi_sc;
331	struct	apm_info info;
332	struct 	apm_event_info *ev_info;
333	apm_info_old_t aiop;
334
335	error = 0;
336	clone = dev->si_drv1;
337	acpi_sc = clone->acpi_sc;
338
339	switch (cmd) {
340	case APMIO_SUSPEND:
341		if ((flag & FWRITE) == 0)
342			return (EPERM);
343		if (acpi_sc->acpi_next_sstate == 0) {
344			if (acpi_sc->acpi_suspend_sx != ACPI_STATE_S5) {
345				error = acpi_ReqSleepState(acpi_sc,
346				    acpi_sc->acpi_suspend_sx);
347			} else {
348				printf(
349			"power off via apm suspend not supported\n");
350				error = ENXIO;
351			}
352		} else
353			error = acpi_AckSleepState(clone, 0);
354		break;
355	case APMIO_STANDBY:
356		if ((flag & FWRITE) == 0)
357			return (EPERM);
358		if (acpi_sc->acpi_next_sstate == 0) {
359			if (acpi_sc->acpi_standby_sx != ACPI_STATE_S5) {
360				error = acpi_ReqSleepState(acpi_sc,
361				    acpi_sc->acpi_standby_sx);
362			} else {
363				printf(
364			"power off via apm standby not supported\n");
365				error = ENXIO;
366			}
367		} else
368			error = acpi_AckSleepState(clone, 0);
369		break;
370	case APMIO_NEXTEVENT:
371		printf("apm nextevent start\n");
372		ACPI_LOCK(acpi);
373		if (acpi_sc->acpi_next_sstate != 0 && clone->notify_status ==
374		    APM_EV_NONE) {
375			ev_info = (struct apm_event_info *)addr;
376			if (acpi_sc->acpi_next_sstate <= ACPI_STATE_S3)
377				ev_info->type = PMEV_STANDBYREQ;
378			else
379				ev_info->type = PMEV_SUSPENDREQ;
380			ev_info->index = 0;
381			clone->notify_status = APM_EV_NOTIFIED;
382			printf("apm event returning %d\n", ev_info->type);
383		} else
384			error = EAGAIN;
385		ACPI_UNLOCK(acpi);
386		break;
387	case APMIO_GETINFO_OLD:
388		if (acpi_capm_get_info(&info))
389			error = ENXIO;
390		aiop = (apm_info_old_t)addr;
391		aiop->ai_major = info.ai_major;
392		aiop->ai_minor = info.ai_minor;
393		aiop->ai_acline = info.ai_acline;
394		aiop->ai_batt_stat = info.ai_batt_stat;
395		aiop->ai_batt_life = info.ai_batt_life;
396		aiop->ai_status = info.ai_status;
397		break;
398	case APMIO_GETINFO:
399		if (acpi_capm_get_info((apm_info_t)addr))
400			error = ENXIO;
401		break;
402	case APMIO_GETPWSTATUS:
403		if (acpi_capm_get_pwstatus((apm_pwstatus_t)addr))
404			error = ENXIO;
405		break;
406	case APMIO_ENABLE:
407		if ((flag & FWRITE) == 0)
408			return (EPERM);
409		apm_active = 1;
410		break;
411	case APMIO_DISABLE:
412		if ((flag & FWRITE) == 0)
413			return (EPERM);
414		apm_active = 0;
415		break;
416	case APMIO_HALTCPU:
417		break;
418	case APMIO_NOTHALTCPU:
419		break;
420	case APMIO_DISPLAY:
421		if ((flag & FWRITE) == 0)
422			return (EPERM);
423		break;
424	case APMIO_BIOS:
425		if ((flag & FWRITE) == 0)
426			return (EPERM);
427		bzero(addr, sizeof(struct apm_bios_arg));
428		break;
429	default:
430		error = EINVAL;
431		break;
432	}
433
434	return (error);
435}
436
437static int
438apmwrite(struct cdev *dev, struct uio *uio, int ioflag)
439{
440	return (uio->uio_resid);
441}
442
443static int
444apmpoll(struct cdev *dev, int events, d_thread_t *td)
445{
446	struct	apm_clone_data *clone;
447	int revents;
448
449	revents = 0;
450	ACPI_LOCK(acpi);
451	clone = dev->si_drv1;
452	if (clone->acpi_sc->acpi_next_sstate)
453		revents |= events & (POLLIN | POLLRDNORM);
454	else
455		selrecord(td, &clone->sel_read);
456	ACPI_UNLOCK(acpi);
457	return (revents);
458}
459
460static int
461apmkqfilter(struct cdev *dev, struct knote *kn)
462{
463	struct	apm_clone_data *clone;
464
465	ACPI_LOCK(acpi);
466	clone = dev->si_drv1;
467	kn->kn_hook = clone;
468	kn->kn_fop = &apm_readfiltops;
469	knlist_add(&clone->sel_read.si_note, kn, 0);
470	ACPI_UNLOCK(acpi);
471	return (0);
472}
473
474static void
475apmreadfiltdetach(struct knote *kn)
476{
477	struct	apm_clone_data *clone;
478
479	ACPI_LOCK(acpi);
480	clone = kn->kn_hook;
481	knlist_remove(&clone->sel_read.si_note, kn, 0);
482	ACPI_UNLOCK(acpi);
483}
484
485static int
486apmreadfilt(struct knote *kn, long hint)
487{
488	struct	apm_clone_data *clone;
489	int	sleeping;
490
491	ACPI_LOCK(acpi);
492	clone = kn->kn_hook;
493	sleeping = clone->acpi_sc->acpi_next_sstate ? 1 : 0;
494	ACPI_UNLOCK(acpi);
495	return (sleeping);
496}
497
498int
499acpi_machdep_init(device_t dev)
500{
501	struct	acpi_softc *acpi_sc;
502
503	acpi_sc = devclass_get_softc(devclass_find("acpi"), 0);
504
505	/* Create a clone for /dev/acpi also. */
506	STAILQ_INIT(&acpi_sc->apm_cdevs);
507	acpi_sc->acpi_clone = apm_create_clone(acpi_sc->acpi_dev_t, acpi_sc);
508	clone_setup(&apm_clones);
509	EVENTHANDLER_REGISTER(dev_clone, apm_clone, 0, 1000);
510	acpi_install_wakeup_handler(acpi_sc);
511
512	if (intr_model == ACPI_INTR_PIC)
513		BUS_CONFIG_INTR(dev, AcpiGbl_FADT.SciInterrupt,
514		    INTR_TRIGGER_LEVEL, INTR_POLARITY_LOW);
515	else
516		acpi_SetIntrModel(intr_model);
517
518	SYSCTL_ADD_UINT(&acpi_sc->acpi_sysctl_ctx,
519	    SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO,
520	    "reset_video", CTLFLAG_RW, &acpi_reset_video, 0,
521	    "Call the VESA reset BIOS vector on the resume path");
522
523	return (0);
524}
525
526void
527acpi_SetDefaultIntrModel(int model)
528{
529
530	intr_model = model;
531}
532
533/* Check BIOS date.  If 1998 or older, disable ACPI. */
534int
535acpi_machdep_quirks(int *quirks)
536{
537	char *va;
538	int year;
539
540	/* BIOS address 0xffff5 contains the date in the format mm/dd/yy. */
541	va = pmap_mapbios(0xffff0, 16);
542	sscanf(va + 11, "%2d", &year);
543	pmap_unmapbios((vm_offset_t)va, 16);
544
545	/*
546	 * Date must be >= 1/1/1999 or we don't trust ACPI.  Note that this
547	 * check must be changed by my 114th birthday.
548	 */
549	if (year > 90 && year < 99)
550		*quirks = ACPI_Q_BROKEN;
551
552	return (0);
553}
554
555void
556acpi_cpu_c1()
557{
558	__asm __volatile("sti; hlt");
559}
560