2 * Copyright (c) 2000 Munehiro Matsuda
3 * Copyright (c) 2000 Takanori Watanabe
4 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: src/sys/dev/acpica/acpi_cmbat.c,v 1.29 2004/05/30 20:08:23 phk Exp $
29 * $DragonFly: src/sys/dev/acpica5/acpi_cmbat.c,v 1.8 2006/09/05 03:48:09 dillon Exp $
33 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/ioccom.h>
39 #include <machine/bus.h>
41 #include <sys/malloc.h>
44 #include <dev/acpica5/acpivar.h>
45 #include <dev/acpica5/acpiio.h>
47 MALLOC_DEFINE(M_ACPICMBAT, "acpicmbat", "ACPI control method battery data");
49 /* Number of times to retry initialization before giving up. */
50 #define ACPI_CMBAT_RETRY_MAX 6
52 /* Check the battery once a minute. */
53 #define CMBAT_POLLRATE (60 * hz)
55 /* Hooks for the ACPI CA debugging infrastructure */
56 #define _COMPONENT ACPI_BATTERY
57 ACPI_MODULE_NAME("BATTERY")
59 #define ACPI_BATTERY_BST_CHANGE 0x80
60 #define ACPI_BATTERY_BIF_CHANGE 0x81
62 struct acpi_cmbat_softc {
67 struct timespec bif_lastupdated;
68 struct timespec bst_lastupdated;
79 static struct timespec acpi_cmbat_info_lastupdated;
81 /* XXX: devclass_get_maxunit() don't give us the current allocated units. */
82 static int acpi_cmbat_units = 0;
84 static int acpi_cmbat_info_expired(struct timespec *);
85 static void acpi_cmbat_info_updated(struct timespec *);
86 static void acpi_cmbat_get_bst(void *);
87 static void acpi_cmbat_get_bif(void *);
88 static void acpi_cmbat_notify_handler(ACPI_HANDLE, UINT32, void *);
89 static int acpi_cmbat_probe(device_t);
90 static int acpi_cmbat_attach(device_t);
91 static int acpi_cmbat_resume(device_t);
92 static int acpi_cmbat_ioctl(u_long, caddr_t, void *);
93 static int acpi_cmbat_is_bst_valid(struct acpi_bst*);
94 static int acpi_cmbat_is_bif_valid(struct acpi_bif*);
95 static int acpi_cmbat_get_total_battinfo(struct acpi_battinfo *);
96 static void acpi_cmbat_init_battery(void *);
98 static device_method_t acpi_cmbat_methods[] = {
99 /* Device interface */
100 DEVMETHOD(device_probe, acpi_cmbat_probe),
101 DEVMETHOD(device_attach, acpi_cmbat_attach),
102 DEVMETHOD(device_resume, acpi_cmbat_resume),
107 static driver_t acpi_cmbat_driver = {
110 sizeof(struct acpi_cmbat_softc),
113 static devclass_t acpi_cmbat_devclass;
114 DRIVER_MODULE(acpi_cmbat, acpi, acpi_cmbat_driver, acpi_cmbat_devclass, 0, 0);
115 MODULE_DEPEND(acpi_cmbat, acpi, 1, 1, 1);
118 acpi_cmbat_info_expired(struct timespec *lastupdated)
120 struct timespec curtime;
122 if (lastupdated == NULL)
124 if (!timespecisset(lastupdated))
127 getnanotime(&curtime);
128 timespecsub(&curtime, lastupdated);
129 return (curtime.tv_sec < 0 ||
130 curtime.tv_sec > acpi_battery_get_info_expire());
135 acpi_cmbat_info_updated(struct timespec *lastupdated)
137 if (lastupdated != NULL)
138 getnanotime(lastupdated);
142 acpi_cmbat_get_bst(void *context)
145 struct acpi_cmbat_softc *sc;
149 ACPI_BUFFER bst_buffer;
152 sc = device_get_softc(dev);
153 h = acpi_get_handle(dev);
155 if (!acpi_cmbat_info_expired(&sc->bst_lastupdated))
157 if (sc->bst_updating)
159 sc->bst_updating = 1;
161 bst_buffer.Pointer = NULL;
162 bst_buffer.Length = ACPI_ALLOCATE_BUFFER;
163 as = AcpiEvaluateObject(h, "_BST", NULL, &bst_buffer);
164 if (ACPI_FAILURE(as)) {
165 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
166 "error fetching current battery status -- %s\n",
167 AcpiFormatException(as));
171 res = (ACPI_OBJECT *)bst_buffer.Pointer;
172 if (!ACPI_PKG_VALID(res, 4)) {
173 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
174 "battery status corrupted\n");
178 if (acpi_PkgInt32(res, 0, &sc->bst.state) != 0)
180 if (acpi_PkgInt32(res, 1, &sc->bst.rate) != 0)
182 if (acpi_PkgInt32(res, 2, &sc->bst.cap) != 0)
184 if (acpi_PkgInt32(res, 3, &sc->bst.volt) != 0)
186 acpi_cmbat_info_updated(&sc->bst_lastupdated);
189 if (bst_buffer.Pointer != NULL)
190 AcpiOsFree(bst_buffer.Pointer);
191 sc->bst_updating = 0;
195 acpi_cmbat_get_bif(void *context)
198 struct acpi_cmbat_softc *sc;
202 ACPI_BUFFER bif_buffer;
205 sc = device_get_softc(dev);
206 h = acpi_get_handle(dev);
208 if (!acpi_cmbat_info_expired(&sc->bif_lastupdated))
210 if (sc->bif_updating)
212 sc->bif_updating = 1;
214 bif_buffer.Pointer = NULL;
215 bif_buffer.Length = ACPI_ALLOCATE_BUFFER;
216 as = AcpiEvaluateObject(h, "_BIF", NULL, &bif_buffer);
217 if (ACPI_FAILURE(as)) {
218 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
219 "error fetching current battery info -- %s\n",
220 AcpiFormatException(as));
224 res = (ACPI_OBJECT *)bif_buffer.Pointer;
225 if (!ACPI_PKG_VALID(res, 13)) {
226 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
227 "battery info corrupted\n");
231 if (acpi_PkgInt32(res, 0, &sc->bif.units) != 0)
233 if (acpi_PkgInt32(res, 1, &sc->bif.dcap) != 0)
235 if (acpi_PkgInt32(res, 2, &sc->bif.lfcap) != 0)
237 if (acpi_PkgInt32(res, 3, &sc->bif.btech) != 0)
239 if (acpi_PkgInt32(res, 4, &sc->bif.dvol) != 0)
241 if (acpi_PkgInt32(res, 5, &sc->bif.wcap) != 0)
243 if (acpi_PkgInt32(res, 6, &sc->bif.lcap) != 0)
245 if (acpi_PkgInt32(res, 7, &sc->bif.gra1) != 0)
247 if (acpi_PkgInt32(res, 8, &sc->bif.gra2) != 0)
249 if (acpi_PkgStr(res, 9, sc->bif.model, ACPI_CMBAT_MAXSTRLEN) != 0)
251 if (acpi_PkgStr(res, 10, sc->bif.serial, ACPI_CMBAT_MAXSTRLEN) != 0)
253 if (acpi_PkgStr(res, 11, sc->bif.type, ACPI_CMBAT_MAXSTRLEN) != 0)
255 if (acpi_PkgStr(res, 12, sc->bif.oeminfo, ACPI_CMBAT_MAXSTRLEN) != 0)
257 acpi_cmbat_info_updated(&sc->bif_lastupdated);
260 if (bif_buffer.Pointer != NULL)
261 AcpiOsFree(bif_buffer.Pointer);
262 sc->bif_updating = 0;
266 acpi_cmbat_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
269 struct acpi_cmbat_softc *sc;
271 dev = (device_t)context;
272 if ((sc = device_get_softc(dev)) == NULL)
275 acpi_UserNotify("CMBAT", h, notify);
278 case ACPI_NOTIFY_DEVICE_CHECK:
279 case ACPI_BATTERY_BST_CHANGE:
280 timespecclear(&sc->bst_lastupdated);
282 case ACPI_NOTIFY_BUS_CHECK:
283 case ACPI_BATTERY_BIF_CHANGE:
284 timespecclear(&sc->bif_lastupdated);
285 AcpiOsQueueForExecution(OSD_PRIORITY_LO, acpi_cmbat_get_bif, dev);
293 acpi_cmbat_probe(device_t dev)
295 if (acpi_get_type(dev) == ACPI_TYPE_DEVICE &&
296 !acpi_disabled("cmbat") && acpi_MatchHid(dev, "PNP0C0A")) {
298 device_set_desc(dev, "Control Method Battery");
305 acpi_cmbat_attach(device_t dev)
309 struct acpi_cmbat_softc *sc;
311 if ((sc = device_get_softc(dev)) == NULL)
314 handle = acpi_get_handle(dev);
317 * Install a system notify handler in addition to the device notify.
318 * Toshiba notebook uses this alternate notify for its battery.
320 AcpiInstallNotifyHandler(handle, ACPI_SYSTEM_NOTIFY,
321 acpi_cmbat_notify_handler, dev);
322 AcpiInstallNotifyHandler(handle, ACPI_DEVICE_NOTIFY,
323 acpi_cmbat_notify_handler, dev);
325 sc->bif_updating = sc->bst_updating = 0;
328 timespecclear(&sc->bif_lastupdated);
329 timespecclear(&sc->bst_lastupdated);
331 if (acpi_cmbat_units == 0) {
332 error = acpi_register_ioctl(ACPIIO_CMBAT_GET_BIF,
333 acpi_cmbat_ioctl, NULL);
336 error = acpi_register_ioctl(ACPIIO_CMBAT_GET_BST,
337 acpi_cmbat_ioctl, NULL);
342 error = acpi_battery_register(ACPI_BATT_TYPE_CMBAT, acpi_cmbat_units);
347 timespecclear(&acpi_cmbat_info_lastupdated);
348 sc->initializing = 0;
349 AcpiOsQueueForExecution(OSD_PRIORITY_LO, acpi_cmbat_init_battery, dev);
355 acpi_cmbat_resume(device_t dev)
357 AcpiOsQueueForExecution(OSD_PRIORITY_LO, acpi_cmbat_init_battery, dev);
362 acpi_cmbat_ioctl(u_long cmd, caddr_t addr, void *arg)
365 union acpi_battery_ioctl_arg *ioctl_arg;
366 struct acpi_cmbat_softc *sc;
367 struct acpi_bif *bifp;
368 struct acpi_bst *bstp;
370 ioctl_arg = (union acpi_battery_ioctl_arg *)addr;
371 dev = devclass_get_device(acpi_cmbat_devclass, ioctl_arg->unit);
374 sc = device_get_softc(dev);
379 * No security check required: information retrieval only. If
380 * new functions are added here, a check might be required.
383 case ACPIIO_CMBAT_GET_BIF:
384 acpi_cmbat_get_bif(dev);
385 bifp = &ioctl_arg->bif;
386 bifp->units = sc->bif.units;
387 bifp->dcap = sc->bif.dcap;
388 bifp->lfcap = sc->bif.lfcap;
389 bifp->btech = sc->bif.btech;
390 bifp->dvol = sc->bif.dvol;
391 bifp->wcap = sc->bif.wcap;
392 bifp->lcap = sc->bif.lcap;
393 bifp->gra1 = sc->bif.gra1;
394 bifp->gra2 = sc->bif.gra2;
395 strncpy(bifp->model, sc->bif.model, sizeof(sc->bif.model));
396 strncpy(bifp->serial, sc->bif.serial, sizeof(sc->bif.serial));
397 strncpy(bifp->type, sc->bif.type, sizeof(sc->bif.type));
398 strncpy(bifp->oeminfo, sc->bif.oeminfo, sizeof(sc->bif.oeminfo));
400 case ACPIIO_CMBAT_GET_BST:
401 bstp = &ioctl_arg->bst;
402 if (acpi_BatteryIsPresent(dev)) {
403 acpi_cmbat_get_bst(dev);
404 bstp->state = sc->bst.state;
405 bstp->rate = sc->bst.rate;
406 bstp->cap = sc->bst.cap;
407 bstp->volt = sc->bst.volt;
409 bstp->state = ACPI_BATT_STAT_NOT_PRESENT;
420 acpi_cmbat_is_bst_valid(struct acpi_bst *bst)
422 if (bst->state >= ACPI_BATT_STAT_MAX || bst->cap == 0xffffffff ||
423 bst->volt == 0xffffffff)
431 acpi_cmbat_is_bif_valid(struct acpi_bif *bif)
440 acpi_cmbat_get_total_battinfo(struct acpi_battinfo *battinfo)
445 int valid_rate, valid_units;
447 int total_cap, total_min, total_full;
449 struct acpi_cmbat_softc *sc;
450 static int bat_units = 0;
451 static struct acpi_cmbat_softc **bat = NULL;
454 batt_stat = ACPI_BATT_STAT_NOT_PRESENT;
457 /* Allocate array of softc pointers */
458 if (bat_units != acpi_cmbat_units) {
460 kfree(bat, M_ACPICMBAT);
466 bat_units = acpi_cmbat_units;
467 bat = kmalloc(sizeof(struct acpi_cmbat_softc *) * bat_units,
468 M_ACPICMBAT, M_INTWAIT);
470 /* Collect softc pointers */
471 for (i = 0; i < acpi_cmbat_units; i++) {
472 if ((dev = devclass_get_device(acpi_cmbat_devclass, i)) == NULL) {
476 if ((sc = device_get_softc(dev)) == NULL) {
484 /* Get battery status, valid rate and valid units */
485 batt_stat = valid_rate = valid_units = 0;
486 for (i = 0; i < acpi_cmbat_units; i++) {
487 bat[i]->present = acpi_BatteryIsPresent(bat[i]->dev);
488 if (!bat[i]->present)
491 acpi_cmbat_get_bst(bat[i]->dev);
493 /* If battery not installed, we get strange values */
494 if (!acpi_cmbat_is_bst_valid(&(bat[i]->bst)) ||
495 !acpi_cmbat_is_bif_valid(&(bat[i]->bif))) {
502 bat[i]->cap = 100 * bat[i]->bst.cap / bat[i]->bif.lfcap;
503 batt_stat |= bat[i]->bst.state;
505 if (bat[i]->bst.rate > 0) {
507 * XXX Hack to calculate total battery time.
508 * Systems with 2 or more battries, they may get used
509 * one by one, thus bst.rate is set only to the one
510 * in use. For remaining batteries bst.rate = 0, which
511 * makes it impossible to calculate remaining time.
512 * Some other systems may need sum of bst.rate in
513 * dis-charging state.
514 * There for we sum up the bst.rate that is valid
515 * (in dis-charging state), and use the sum to
516 * calcutate remaining batteries' time.
518 if (bat[i]->bst.state & ACPI_BATT_STAT_DISCHARG)
519 valid_rate += bat[i]->bst.rate;
523 /* Calculate total battery capacity and time */
524 total_cap = total_min = total_full = 0;
525 for (i = 0; i < acpi_cmbat_units; i++) {
526 if (!bat[i]->present)
529 if (valid_rate > 0) {
530 /* Use the sum of bst.rate */
531 bat[i]->min = 60 * bat[i]->bst.cap / valid_rate;
532 } else if (bat[i]->full_charge_time > 0) {
533 bat[i]->min = (bat[i]->full_charge_time * bat[i]->cap) / 100;
535 /* Couldn't find valid rate and full battery time */
538 total_min += bat[i]->min;
539 total_cap += bat[i]->cap;
540 total_full += bat[i]->full_charge_time;
544 if (valid_units == 0) {
546 batt_stat = ACPI_BATT_STAT_NOT_PRESENT;
548 cap = total_cap / valid_units;
552 if (valid_units == 0) {
554 } else if (valid_rate == 0 || (batt_stat & ACPI_BATT_STAT_CHARGING)) {
558 min = (total_full * cap) / 100;
562 acpi_cmbat_info_updated(&acpi_cmbat_info_lastupdated);
567 battinfo->state = batt_stat;
573 acpi_cmbat_init_battery(void *arg)
576 device_t dev = (device_t)arg;
577 struct acpi_cmbat_softc *sc = device_get_softc(dev);
579 if (sc->initializing)
582 sc->initializing = 1;
583 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
584 "battery initialization start\n");
586 for (retry = 0; retry < ACPI_CMBAT_RETRY_MAX; retry++, AcpiOsSleep(10)) {
587 sc->present = acpi_BatteryIsPresent(dev);
591 timespecclear(&sc->bst_lastupdated);
592 timespecclear(&sc->bif_lastupdated);
594 acpi_cmbat_get_bst(dev);
595 if (!acpi_cmbat_is_bst_valid(&sc->bst))
598 acpi_cmbat_get_bif(dev);
599 if (!acpi_cmbat_is_bif_valid(&sc->bif))
604 sc->initializing = 0;
605 if (retry == ACPI_CMBAT_RETRY_MAX) {
606 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
607 "battery initialization failed, giving up\n");
609 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
610 "battery initialization done, tried %d times\n", retry + 1);
618 acpi_cmbat_get_battinfo(int unit, struct acpi_battinfo *battinfo)
622 struct acpi_cmbat_softc *sc;
625 return (acpi_cmbat_get_total_battinfo(battinfo));
627 if (acpi_cmbat_info_expired(&acpi_cmbat_info_lastupdated)) {
628 error = acpi_cmbat_get_total_battinfo(battinfo);
634 if (unit >= acpi_cmbat_units) {
639 if ((dev = devclass_get_device(acpi_cmbat_devclass, unit)) == NULL) {
643 if ((sc = device_get_softc(dev)) == NULL) {
651 battinfo->state = ACPI_BATT_STAT_NOT_PRESENT;
653 battinfo->cap = sc->cap;
654 battinfo->min = sc->min;
655 battinfo->state = sc->bst.state;