Home | History | Annotate | Line # | Download | only in dev
apm.c revision 1.18
      1 /*	$NetBSD: apm.c,v 1.18 2007/12/11 23:23:02 david Exp $	*/
      2 /*	$OpenBSD: apm.c,v 1.5 2002/06/07 07:13:59 miod Exp $	*/
      3 
      4 /*-
      5  * Copyright (c) 2001 Alexander Guy.  All rights reserved.
      6  * Copyright (c) 1998-2001 Michael Shalayeff. All rights reserved.
      7  * Copyright (c) 1995 John T. Kohl.  All rights reserved.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  * 3. Neither the names of the authors nor the names of contributors
     18  *    may be used to endorse or promote products derived from this software
     19  *    without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
     22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
     25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     27  * OR SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     31  * SUCH DAMAGE.
     32  *
     33  */
     34 
     35 #include <sys/cdefs.h>
     36 __KERNEL_RCSID(0, "$NetBSD: apm.c,v 1.18 2007/12/11 23:23:02 david Exp $");
     37 
     38 #include "apm.h"
     39 
     40 #if NAPM > 1
     41 #error only one APM emulation device may be configured
     42 #endif
     43 
     44 #include <sys/param.h>
     45 #include <sys/systm.h>
     46 #include <sys/kernel.h>
     47 #include <sys/proc.h>
     48 #include <sys/device.h>
     49 #include <sys/fcntl.h>
     50 #include <sys/ioctl.h>
     51 #include <sys/mutex.h>
     52 #ifdef __OpenBSD__
     53 #include <sys/event.h>
     54 #endif
     55 #ifdef __NetBSD__
     56 #include <sys/select.h>
     57 #include <sys/poll.h>
     58 #include <sys/conf.h>
     59 #endif
     60 
     61 #ifdef __OpenBSD__
     62 #include <machine/conf.h>
     63 #endif
     64 #include <machine/cpu.h>
     65 #include <machine/apmvar.h>
     66 
     67 #include <macppc/dev/adbvar.h>
     68 #include <macppc/dev/pm_direct.h>
     69 
     70 #if defined(APMDEBUG)
     71 #define DPRINTF(x)	printf x
     72 #else
     73 #define	DPRINTF(x)	/**/
     74 #endif
     75 
     76 #define APM_NEVENTS 16
     77 
     78 struct apm_softc {
     79 	struct device sc_dev;
     80 	struct selinfo sc_rsel;
     81 #ifdef __OpenBSD__
     82 	struct klist sc_note;
     83 #endif
     84 	int    sc_flags;
     85 	int	event_count;
     86 	int	event_ptr;
     87 	kmutex_t sc_lock;
     88 	struct	apm_event_info event_list[APM_NEVENTS];
     89 };
     90 
     91 /*
     92  * A brief note on the locking protocol: it's very simple; we
     93  * assert an exclusive lock any time thread context enters the
     94  * APM module.  This is both the APM thread itself, as well as
     95  * user context.
     96  */
     97 #ifdef __NetBSD__
     98 #define	APM_LOCK(apmsc)		mutex_enter(&(apmsc)->sc_lock)
     99 #define	APM_UNLOCK(apmsc)	mutex_exit(&(apmsc)->sc_lock)
    100 #else
    101 #define APM_LOCK(apmsc)
    102 #define APM_UNLOCK(apmsc)
    103 #endif
    104 
    105 int apmmatch(struct device *, struct cfdata *, void *);
    106 void apmattach(struct device *, struct device *, void *);
    107 
    108 #ifdef __NetBSD__
    109 #if 0
    110 static int	apm_record_event __P((struct apm_softc *, u_int));
    111 #endif
    112 #endif
    113 
    114 CFATTACH_DECL(apm, sizeof(struct apm_softc),
    115     apmmatch, apmattach, NULL, NULL);
    116 
    117 #ifdef __OpenBSD__
    118 struct cfdriver apm_cd = {
    119 	NULL, "apm", DV_DULL
    120 };
    121 #else
    122 extern struct cfdriver apm_cd;
    123 
    124 dev_type_open(apmopen);
    125 dev_type_close(apmclose);
    126 dev_type_ioctl(apmioctl);
    127 dev_type_poll(apmpoll);
    128 dev_type_kqfilter(apmkqfilter);
    129 
    130 const struct cdevsw apm_cdevsw = {
    131 	apmopen, apmclose, noread, nowrite, apmioctl,
    132 	nostop, notty, apmpoll, nommap, apmkqfilter,
    133 };
    134 #endif
    135 
    136 int	apm_evindex;
    137 
    138 #define	APMUNIT(dev)	(minor(dev)&0xf0)
    139 #define	APMDEV(dev)	(minor(dev)&0x0f)
    140 #define APMDEV_NORMAL	0
    141 #define APMDEV_CTL	8
    142 
    143 /*
    144  * Flags to control kernel display
    145  *	SCFLAG_NOPRINT:		do not output APM power messages due to
    146  *				a power change event.
    147  *
    148  *	SCFLAG_PCTPRINT:	do not output APM power messages due to
    149  *				to a power change event unless the battery
    150  *				percentage changes.
    151  */
    152 
    153 #define SCFLAG_NOPRINT	0x0008000
    154 #define SCFLAG_PCTPRINT	0x0004000
    155 #define SCFLAG_PRINT	(SCFLAG_NOPRINT|SCFLAG_PCTPRINT)
    156 
    157 #define	SCFLAG_OREAD 	(1 << 0)
    158 #define	SCFLAG_OWRITE	(1 << 1)
    159 #define	SCFLAG_OPEN	(SCFLAG_OREAD|SCFLAG_OWRITE)
    160 
    161 
    162 int
    163 apmmatch(parent, match, aux)
    164 	struct device *parent;
    165 	struct cfdata *match;
    166 	void *aux;
    167 {
    168 	struct adb_attach_args *aa = (void *)aux;
    169 	if (aa->origaddr != ADBADDR_APM ||
    170 	    aa->handler_id != ADBADDR_APM ||
    171 	    aa->adbaddr != ADBADDR_APM)
    172 		return 0;
    173 
    174 	if (adbHardware != ADB_HW_PMU)
    175 		return 0;
    176 
    177 	return 1;
    178 }
    179 
    180 void
    181 apmattach(parent, self, aux)
    182 	struct device *parent, *self;
    183 	void *aux;
    184 {
    185 	struct apm_softc *sc = (struct apm_softc *) self;
    186 	struct pmu_battery_info info;
    187 
    188 	pm_battery_info(0, &info);
    189 
    190 	printf(": battery flags 0x%X, ", info.flags);
    191 	printf("%d%% charged\n", ((info.cur_charge * 100) / info.max_charge));
    192 
    193 	sc->sc_flags = 0;
    194 	sc->event_ptr = 0;
    195 	sc->event_count = 0;
    196 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_NONE);
    197 }
    198 
    199 int
    200 apmopen(dev, flag, mode, l)
    201 	dev_t dev;
    202 	int flag, mode;
    203 	struct lwp *l;
    204 {
    205 	struct apm_softc *sc;
    206 	int error = 0;
    207 
    208 	/* apm0 only */
    209 	if (!apm_cd.cd_ndevs || APMUNIT(dev) != 0 ||
    210 	    !(sc = apm_cd.cd_devs[APMUNIT(dev)]))
    211 		return ENXIO;
    212 
    213 	DPRINTF(("apmopen: dev %d pid %d flag %x mode %x\n",
    214 	    APMDEV(dev), l->l_proc->p_pid, flag, mode));
    215 
    216 	APM_LOCK(sc);
    217 	switch (APMDEV(dev)) {
    218 	case APMDEV_CTL:
    219 		if (!(flag & FWRITE)) {
    220 			error = EINVAL;
    221 			break;
    222 		}
    223 		if (sc->sc_flags & SCFLAG_OWRITE) {
    224 			error = EBUSY;
    225 			break;
    226 		}
    227 		sc->sc_flags |= SCFLAG_OWRITE;
    228 		break;
    229 	case APMDEV_NORMAL:
    230 		if (!(flag & FREAD) || (flag & FWRITE)) {
    231 			error = EINVAL;
    232 			break;
    233 		}
    234 		sc->sc_flags |= SCFLAG_OREAD;
    235 		break;
    236 	default:
    237 		error = ENXIO;
    238 		break;
    239 	}
    240 	APM_UNLOCK(sc);
    241 	return error;
    242 }
    243 
    244 int
    245 apmclose(dev, flag, mode, l)
    246 	dev_t dev;
    247 	int flag, mode;
    248 	struct lwp *l;
    249 {
    250 	struct apm_softc *sc;
    251 
    252 	/* apm0 only */
    253 	if (!apm_cd.cd_ndevs || APMUNIT(dev) != 0 ||
    254 	    !(sc = apm_cd.cd_devs[APMUNIT(dev)]))
    255 		return ENXIO;
    256 
    257 	DPRINTF(("apmclose: pid %d flag %x mode %x\n", l->l_proc->p_pid, flag, mode));
    258 
    259 	APM_LOCK(sc);
    260 	switch (APMDEV(dev)) {
    261 	case APMDEV_CTL:
    262 		sc->sc_flags &= ~SCFLAG_OWRITE;
    263 		break;
    264 	case APMDEV_NORMAL:
    265 		sc->sc_flags &= ~SCFLAG_OREAD;
    266 		break;
    267 	}
    268 	APM_UNLOCK(sc);
    269 	return 0;
    270 }
    271 
    272 int
    273 apmioctl(dev, cmd, data, flag, l)
    274 	dev_t dev;
    275 	u_long cmd;
    276 	void *data;
    277 	int flag;
    278 	struct lwp *l;
    279 {
    280 	struct apm_softc *sc;
    281 	struct pmu_battery_info batt;
    282 	struct apm_power_info *power;
    283 	int error = 0;
    284 
    285 	/* apm0 only */
    286 	if (!apm_cd.cd_ndevs || APMUNIT(dev) != 0 ||
    287 	    !(sc = apm_cd.cd_devs[APMUNIT(dev)]))
    288 		return ENXIO;
    289 
    290 	APM_LOCK(sc);
    291 	switch (cmd) {
    292 		/* some ioctl names from linux */
    293 	case APM_IOC_STANDBY:
    294 		if ((flag & FWRITE) == 0)
    295 			error = EBADF;
    296 	case APM_IOC_SUSPEND:
    297 		if ((flag & FWRITE) == 0)
    298 			error = EBADF;
    299 		break;
    300 	case APM_IOC_PRN_CTL:
    301 		if ((flag & FWRITE) == 0)
    302 			error = EBADF;
    303 		else {
    304 			int op = *(int *)data;
    305 			DPRINTF(( "APM_IOC_PRN_CTL: %d\n", op ));
    306 			switch (op) {
    307 			case APM_PRINT_ON:	/* enable printing */
    308 				sc->sc_flags &= ~SCFLAG_PRINT;
    309 				break;
    310 			case APM_PRINT_OFF: /* disable printing */
    311 				sc->sc_flags &= ~SCFLAG_PRINT;
    312 				sc->sc_flags |= SCFLAG_NOPRINT;
    313 				break;
    314 			case APM_PRINT_PCT: /* disable some printing */
    315 				sc->sc_flags &= ~SCFLAG_PRINT;
    316 				sc->sc_flags |= SCFLAG_PCTPRINT;
    317 				break;
    318 			default:
    319 				error = EINVAL;
    320 				break;
    321 			}
    322 		}
    323 		break;
    324 	case APM_IOC_DEV_CTL:
    325 		if ((flag & FWRITE) == 0)
    326 			error = EBADF;
    327 		break;
    328 	case APM_IOC_GETPOWER:
    329 	        power = (struct apm_power_info *)data;
    330 
    331 		pm_battery_info(0, &batt);
    332 
    333 		power->ac_state = ((batt.flags & PMU_PWR_AC_PRESENT) ?
    334 		    APM_AC_ON : APM_AC_OFF);
    335 		power->battery_life =
    336 		    ((batt.cur_charge * 100) / batt.max_charge);
    337 
    338 		/*
    339 		 * If the battery is charging, return the minutes left until
    340 		 * charging is complete. apmd knows this.
    341 		 */
    342 
    343 		if (!(batt.flags & PMU_PWR_BATT_PRESENT)) {
    344 			power->battery_state = APM_BATT_UNKNOWN;
    345 			power->minutes_left = 0;
    346 			power->battery_life = 0;
    347 		} else if ((power->ac_state == APM_AC_ON) &&
    348 			   (batt.draw > 0)) {
    349 			power->minutes_left = batt.secs_remaining / 60;
    350 			power->battery_state = APM_BATT_CHARGING;
    351 		} else {
    352 			power->minutes_left = batt.secs_remaining / 60;
    353 
    354 			/* XXX - Arbitrary */
    355 			if (power->battery_life > 60) {
    356 				power->battery_state = APM_BATT_HIGH;
    357 			} else if (power->battery_life < 10) {
    358 				power->battery_state = APM_BATT_CRITICAL;
    359 			} else {
    360 				power->battery_state = APM_BATT_LOW;
    361 			}
    362 		}
    363 
    364 		break;
    365 
    366 	default:
    367 		error = ENOTTY;
    368 	}
    369 	APM_UNLOCK(sc);
    370 
    371 	return error;
    372 }
    373 
    374 #ifdef __NetBSD__
    375 #if 0
    376 /*
    377  * return 0 if the user will notice and handle the event,
    378  * return 1 if the kernel driver should do so.
    379  */
    380 static int
    381 apm_record_event(sc, event_type)
    382 	struct apm_softc *sc;
    383 	u_int event_type;
    384 {
    385 	struct apm_event_info *evp;
    386 
    387 	if ((sc->sc_flags & SCFLAG_OPEN) == 0)
    388 		return 1;		/* no user waiting */
    389 	if (sc->event_count == APM_NEVENTS) {
    390 		DPRINTF(("apm_record_event: queue full!\n"));
    391 		return 1;			/* overflow */
    392 	}
    393 	evp = &sc->event_list[sc->event_ptr];
    394 	sc->event_count++;
    395 	sc->event_ptr++;
    396 	sc->event_ptr %= APM_NEVENTS;
    397 	evp->type = event_type;
    398 	evp->index = ++apm_evindex;
    399 	selwakeup(&sc->sc_rsel);
    400 	return (sc->sc_flags & SCFLAG_OWRITE) ? 0 : 1; /* user may handle */
    401 }
    402 #endif
    403 
    404 int
    405 apmpoll(dev, events, l)
    406 	dev_t dev;
    407 	int events;
    408 	struct lwp *l;
    409 {
    410 	struct apm_softc *sc = apm_cd.cd_devs[APMUNIT(dev)];
    411 	int revents = 0;
    412 
    413 	APM_LOCK(sc);
    414 	if (events & (POLLIN | POLLRDNORM)) {
    415 		if (sc->event_count)
    416 			revents |= events & (POLLIN | POLLRDNORM);
    417 		else
    418 			selrecord(l, &sc->sc_rsel);
    419 	}
    420 	APM_UNLOCK(sc);
    421 
    422 	return (revents);
    423 }
    424 #endif
    425 
    426 static void
    427 filt_apmrdetach(struct knote *kn)
    428 {
    429 	struct apm_softc *sc = (struct apm_softc *)kn->kn_hook;
    430 
    431 	APM_LOCK(sc);
    432 	SLIST_REMOVE(&sc->sc_rsel.sel_klist, kn, knote, kn_selnext);
    433 	APM_UNLOCK(sc);
    434 }
    435 
    436 static int
    437 filt_apmread(struct knote *kn, long hint)
    438 {
    439 	struct apm_softc *sc = kn->kn_hook;
    440 
    441 	kn->kn_data = sc->event_count;
    442 	return (kn->kn_data > 0);
    443 }
    444 
    445 static struct filterops apmread_filtops =
    446 	{ 1, NULL, filt_apmrdetach, filt_apmread};
    447 
    448 int
    449 apmkqfilter(dev, kn)
    450 	dev_t dev;
    451 	struct knote *kn;
    452 {
    453 	struct apm_softc *sc = apm_cd.cd_devs[APMUNIT(dev)];
    454 	struct klist *klist;
    455 
    456 	switch (kn->kn_filter) {
    457 	case EVFILT_READ:
    458 		klist = &sc->sc_rsel.sel_klist;
    459 		kn->kn_fop = &apmread_filtops;
    460 		break;
    461 	default:
    462 		return (1);
    463 	}
    464 
    465 	kn->kn_hook = sc;
    466 
    467 	APM_LOCK(sc);
    468 	SLIST_INSERT_HEAD(klist, kn, kn_selnext);
    469 	APM_UNLOCK(sc);
    470 
    471 	return (0);
    472 }
    473