Home | History | Annotate | Line # | Download | only in dev
apm.c revision 1.24
      1 /*	$NetBSD: apm.c,v 1.24 2011/06/18 08:08:28 matt 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.24 2011/06/18 08:08:28 matt 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(device_t, cfdata_t, void *);
    106 void apmattach(device_t, device_t, void *);
    107 
    108 #ifdef __NetBSD__
    109 #if 0
    110 static int	apm_record_event(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(device_t parent, cfdata_t match, void *aux)
    164 {
    165 	struct adb_attach_args *aa = (void *)aux;
    166 	if (aa->origaddr != ADBADDR_APM ||
    167 	    aa->handler_id != ADBADDR_APM ||
    168 	    aa->adbaddr != ADBADDR_APM)
    169 		return 0;
    170 
    171 	if (adbHardware != ADB_HW_PMU)
    172 		return 0;
    173 
    174 	return 1;
    175 }
    176 
    177 void
    178 apmattach(device_t parent, device_t self, void *aux)
    179 {
    180 	struct apm_softc *sc = (struct apm_softc *) self;
    181 	struct pmu_battery_info info;
    182 
    183 	pm_battery_info(0, &info);
    184 
    185 	printf(": battery flags 0x%X, ", info.flags);
    186 	printf("%d%% charged\n", ((info.cur_charge * 100) / info.max_charge));
    187 
    188 	sc->sc_flags = 0;
    189 	sc->event_ptr = 0;
    190 	sc->event_count = 0;
    191 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_NONE);
    192 	selinit(&sc->sc_rsel);
    193 }
    194 
    195 int
    196 apmopen(dev_t dev, int flag, int mode, struct lwp *l)
    197 {
    198 	struct apm_softc *sc;
    199 	int error = 0;
    200 
    201 	/* apm0 only */
    202 	sc = device_lookup_private(&apm_cd, APMUNIT(dev));
    203 	if (sc == NULL)
    204 		return ENXIO;
    205 
    206 	DPRINTF(("apmopen: dev %d pid %d flag %x mode %x\n",
    207 	    APMDEV(dev), l->l_proc->p_pid, flag, mode));
    208 
    209 	APM_LOCK(sc);
    210 	switch (APMDEV(dev)) {
    211 	case APMDEV_CTL:
    212 		if (!(flag & FWRITE)) {
    213 			error = EINVAL;
    214 			break;
    215 		}
    216 		if (sc->sc_flags & SCFLAG_OWRITE) {
    217 			error = EBUSY;
    218 			break;
    219 		}
    220 		sc->sc_flags |= SCFLAG_OWRITE;
    221 		break;
    222 	case APMDEV_NORMAL:
    223 		if (!(flag & FREAD) || (flag & FWRITE)) {
    224 			error = EINVAL;
    225 			break;
    226 		}
    227 		sc->sc_flags |= SCFLAG_OREAD;
    228 		break;
    229 	default:
    230 		error = ENXIO;
    231 		break;
    232 	}
    233 	APM_UNLOCK(sc);
    234 	return error;
    235 }
    236 
    237 int
    238 apmclose(dev_t dev, int flag, int mode, struct lwp *l)
    239 {
    240 	struct apm_softc *sc;
    241 
    242 	/* apm0 only */
    243 	sc = device_lookup_private(&apm_cd, APMUNIT(dev));
    244 	if (sc == NULL)
    245 		return ENXIO;
    246 
    247 	DPRINTF(("apmclose: pid %d flag %x mode %x\n", l->l_proc->p_pid, flag, mode));
    248 
    249 	APM_LOCK(sc);
    250 	switch (APMDEV(dev)) {
    251 	case APMDEV_CTL:
    252 		sc->sc_flags &= ~SCFLAG_OWRITE;
    253 		break;
    254 	case APMDEV_NORMAL:
    255 		sc->sc_flags &= ~SCFLAG_OREAD;
    256 		break;
    257 	}
    258 	APM_UNLOCK(sc);
    259 	return 0;
    260 }
    261 
    262 int
    263 apmioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
    264 {
    265 	struct apm_softc *sc;
    266 	struct pmu_battery_info batt;
    267 	struct apm_power_info *power;
    268 	int error = 0;
    269 
    270 	/* apm0 only */
    271 	sc = device_lookup_private(&apm_cd, APMUNIT(dev));
    272 	if (sc == NULL)
    273 		return ENXIO;
    274 
    275 	APM_LOCK(sc);
    276 	switch (cmd) {
    277 		/* some ioctl names from linux */
    278 	case APM_IOC_STANDBY:
    279 		if ((flag & FWRITE) == 0)
    280 			error = EBADF;
    281 	case APM_IOC_SUSPEND:
    282 		if ((flag & FWRITE) == 0)
    283 			error = EBADF;
    284 		break;
    285 	case APM_IOC_PRN_CTL:
    286 		if ((flag & FWRITE) == 0)
    287 			error = EBADF;
    288 		else {
    289 			int op = *(int *)data;
    290 			DPRINTF(( "APM_IOC_PRN_CTL: %d\n", op ));
    291 			switch (op) {
    292 			case APM_PRINT_ON:	/* enable printing */
    293 				sc->sc_flags &= ~SCFLAG_PRINT;
    294 				break;
    295 			case APM_PRINT_OFF: /* disable printing */
    296 				sc->sc_flags &= ~SCFLAG_PRINT;
    297 				sc->sc_flags |= SCFLAG_NOPRINT;
    298 				break;
    299 			case APM_PRINT_PCT: /* disable some printing */
    300 				sc->sc_flags &= ~SCFLAG_PRINT;
    301 				sc->sc_flags |= SCFLAG_PCTPRINT;
    302 				break;
    303 			default:
    304 				error = EINVAL;
    305 				break;
    306 			}
    307 		}
    308 		break;
    309 	case APM_IOC_DEV_CTL:
    310 		if ((flag & FWRITE) == 0)
    311 			error = EBADF;
    312 		break;
    313 	case APM_IOC_GETPOWER:
    314 	        power = (struct apm_power_info *)data;
    315 
    316 		pm_battery_info(0, &batt);
    317 
    318 		power->ac_state = ((batt.flags & PMU_PWR_AC_PRESENT) ?
    319 		    APM_AC_ON : APM_AC_OFF);
    320 		power->battery_life =
    321 		    ((batt.cur_charge * 100) / batt.max_charge);
    322 
    323 		/*
    324 		 * If the battery is charging, return the minutes left until
    325 		 * charging is complete. apmd knows this.
    326 		 */
    327 
    328 		if (!(batt.flags & PMU_PWR_BATT_PRESENT)) {
    329 			power->battery_state = APM_BATT_UNKNOWN;
    330 			power->minutes_left = 0;
    331 			power->battery_life = 0;
    332 		} else if ((power->ac_state == APM_AC_ON) &&
    333 			   (batt.draw > 0)) {
    334 			power->minutes_left = batt.secs_remaining / 60;
    335 			power->battery_state = APM_BATT_CHARGING;
    336 		} else {
    337 			power->minutes_left = batt.secs_remaining / 60;
    338 
    339 			/* XXX - Arbitrary */
    340 			if (power->battery_life > 60) {
    341 				power->battery_state = APM_BATT_HIGH;
    342 			} else if (power->battery_life < 10) {
    343 				power->battery_state = APM_BATT_CRITICAL;
    344 			} else {
    345 				power->battery_state = APM_BATT_LOW;
    346 			}
    347 		}
    348 
    349 		break;
    350 
    351 	default:
    352 		error = ENOTTY;
    353 	}
    354 	APM_UNLOCK(sc);
    355 
    356 	return error;
    357 }
    358 
    359 #ifdef __NetBSD__
    360 #if 0
    361 /*
    362  * return 0 if the user will notice and handle the event,
    363  * return 1 if the kernel driver should do so.
    364  */
    365 static int
    366 apm_record_event(struct apm_softc *sc, u_int event_type)
    367 {
    368 	struct apm_event_info *evp;
    369 
    370 	if ((sc->sc_flags & SCFLAG_OPEN) == 0)
    371 		return 1;		/* no user waiting */
    372 	if (sc->event_count == APM_NEVENTS) {
    373 		DPRINTF(("apm_record_event: queue full!\n"));
    374 		return 1;			/* overflow */
    375 	}
    376 	evp = &sc->event_list[sc->event_ptr];
    377 	sc->event_count++;
    378 	sc->event_ptr++;
    379 	sc->event_ptr %= APM_NEVENTS;
    380 	evp->type = event_type;
    381 	evp->index = ++apm_evindex;
    382 	selnotify(&sc->sc_rsel, 0, 0);
    383 	return (sc->sc_flags & SCFLAG_OWRITE) ? 0 : 1; /* user may handle */
    384 }
    385 #endif
    386 
    387 int
    388 apmpoll(dev_t dev, int events, struct lwp *l)
    389 {
    390 	struct apm_softc *sc = device_lookup_private(&apm_cd,APMUNIT(dev));
    391 	int revents = 0;
    392 
    393 	APM_LOCK(sc);
    394 	if (events & (POLLIN | POLLRDNORM)) {
    395 		if (sc->event_count)
    396 			revents |= events & (POLLIN | POLLRDNORM);
    397 		else
    398 			selrecord(l, &sc->sc_rsel);
    399 	}
    400 	APM_UNLOCK(sc);
    401 
    402 	return (revents);
    403 }
    404 #endif
    405 
    406 static void
    407 filt_apmrdetach(struct knote *kn)
    408 {
    409 	struct apm_softc *sc = (struct apm_softc *)kn->kn_hook;
    410 
    411 	APM_LOCK(sc);
    412 	SLIST_REMOVE(&sc->sc_rsel.sel_klist, kn, knote, kn_selnext);
    413 	APM_UNLOCK(sc);
    414 }
    415 
    416 static int
    417 filt_apmread(struct knote *kn, long hint)
    418 {
    419 	struct apm_softc *sc = kn->kn_hook;
    420 
    421 	kn->kn_data = sc->event_count;
    422 	return (kn->kn_data > 0);
    423 }
    424 
    425 static struct filterops apmread_filtops =
    426 	{ 1, NULL, filt_apmrdetach, filt_apmread};
    427 
    428 int
    429 apmkqfilter(dev_t dev, struct knote *kn)
    430 {
    431 	struct apm_softc *sc = device_lookup_private(&apm_cd,APMUNIT(dev));
    432 	struct klist *klist;
    433 
    434 	switch (kn->kn_filter) {
    435 	case EVFILT_READ:
    436 		klist = &sc->sc_rsel.sel_klist;
    437 		kn->kn_fop = &apmread_filtops;
    438 		break;
    439 	default:
    440 		return (1);
    441 	}
    442 
    443 	kn->kn_hook = sc;
    444 
    445 	APM_LOCK(sc);
    446 	SLIST_INSERT_HEAD(klist, kn, kn_selnext);
    447 	APM_UNLOCK(sc);
    448 
    449 	return (0);
    450 }
    451