2 * Copyright (c) 2005 Nate Lawson
3 * Copyright (c) 2000 Munehiro Matsuda
4 * Copyright (c) 2000 Takanori Watanabe
5 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
38 #include <sys/ioccom.h>
40 #include <machine/bus.h>
42 #include <sys/malloc.h>
44 #include <contrib/dev/acpica/include/acpi.h>
46 #include <dev/acpica/acpivar.h>
47 #include <dev/acpica/acpiio.h>
49 MALLOC_DEFINE(M_ACPICMBAT, "acpicmbat", "ACPI control method battery data");
51 /* Number of times to retry initialization before giving up. */
52 #define ACPI_CMBAT_RETRY_MAX 6
54 /* Check the battery once a minute. */
55 #define CMBAT_POLLRATE (60 * hz)
57 /* Hooks for the ACPI CA debugging infrastructure */
58 #define _COMPONENT ACPI_BATTERY
59 ACPI_MODULE_NAME("BATTERY")
61 #define ACPI_BATTERY_BST_CHANGE 0x80
62 #define ACPI_BATTERY_BIF_CHANGE 0x81
64 struct acpi_cmbat_softc {
70 struct timespec bst_lastupdated;
73 ACPI_SERIAL_DECL(cmbat, "ACPI cmbat");
75 static int acpi_cmbat_probe(device_t dev);
76 static int acpi_cmbat_attach(device_t dev);
77 static int acpi_cmbat_detach(device_t dev);
78 static int acpi_cmbat_resume(device_t dev);
79 static void acpi_cmbat_notify_handler(ACPI_HANDLE h, UINT32 notify,
81 static int acpi_cmbat_info_expired(struct timespec *lastupdated);
82 static void acpi_cmbat_info_updated(struct timespec *lastupdated);
83 static void acpi_cmbat_get_bst(void *arg);
84 static void acpi_cmbat_get_bif_task(void *arg);
85 static void acpi_cmbat_get_bif(void *arg);
86 static int acpi_cmbat_bst(device_t dev, struct acpi_bst *bstp);
87 static int acpi_cmbat_bif(device_t dev, struct acpi_bif *bifp);
88 static void acpi_cmbat_init_battery(void *arg);
90 static device_method_t acpi_cmbat_methods[] = {
91 /* Device interface */
92 DEVMETHOD(device_probe, acpi_cmbat_probe),
93 DEVMETHOD(device_attach, acpi_cmbat_attach),
94 DEVMETHOD(device_detach, acpi_cmbat_detach),
95 DEVMETHOD(device_resume, acpi_cmbat_resume),
97 /* ACPI battery interface */
98 DEVMETHOD(acpi_batt_get_info, acpi_cmbat_bif),
99 DEVMETHOD(acpi_batt_get_status, acpi_cmbat_bst),
104 static driver_t acpi_cmbat_driver = {
107 sizeof(struct acpi_cmbat_softc),
110 static devclass_t acpi_cmbat_devclass;
111 DRIVER_MODULE(acpi_cmbat, acpi, acpi_cmbat_driver, acpi_cmbat_devclass, 0, 0);
112 MODULE_DEPEND(acpi_cmbat, acpi, 1, 1, 1);
115 acpi_cmbat_probe(device_t dev)
117 static char *cmbat_ids[] = { "PNP0C0A", NULL };
119 if (acpi_disabled("cmbat") ||
120 ACPI_ID_PROBE(device_get_parent(dev), dev, cmbat_ids) == NULL)
123 device_set_desc(dev, "ACPI Control Method Battery");
128 acpi_cmbat_attach(device_t dev)
132 struct acpi_cmbat_softc *sc;
134 sc = device_get_softc(dev);
135 handle = acpi_get_handle(dev);
138 timespecclear(&sc->bst_lastupdated);
140 error = acpi_battery_register(dev);
142 device_printf(dev, "registering battery failed\n");
147 * Install a system notify handler in addition to the device notify.
148 * Toshiba notebook uses this alternate notify for its battery.
150 AcpiInstallNotifyHandler(handle, ACPI_ALL_NOTIFY,
151 acpi_cmbat_notify_handler, dev);
153 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cmbat_init_battery, dev);
159 acpi_cmbat_detach(device_t dev)
163 handle = acpi_get_handle(dev);
164 AcpiRemoveNotifyHandler(handle, ACPI_ALL_NOTIFY, acpi_cmbat_notify_handler);
165 acpi_battery_remove(dev);
170 acpi_cmbat_resume(device_t dev)
173 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cmbat_init_battery, dev);
178 acpi_cmbat_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
180 struct acpi_cmbat_softc *sc;
183 dev = (device_t)context;
184 sc = device_get_softc(dev);
187 case ACPI_NOTIFY_DEVICE_CHECK:
188 case ACPI_BATTERY_BST_CHANGE:
190 * Clear the last updated time. The next call to retrieve the
191 * battery status will get the new value for us.
193 timespecclear(&sc->bst_lastupdated);
195 case ACPI_NOTIFY_BUS_CHECK:
196 case ACPI_BATTERY_BIF_CHANGE:
198 * Queue a callback to get the current battery info from thread
199 * context. It's not safe to block in a notify handler.
201 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cmbat_get_bif_task, dev);
205 acpi_UserNotify("CMBAT", h, notify);
209 acpi_cmbat_info_expired(struct timespec *lastupdated)
211 struct timespec curtime;
213 ACPI_SERIAL_ASSERT(cmbat);
215 if (lastupdated == NULL)
217 if (!timespecisset(lastupdated))
220 getnanotime(&curtime);
221 timespecsub(&curtime, lastupdated);
222 return (curtime.tv_sec < 0 ||
223 curtime.tv_sec > acpi_battery_get_info_expire());
227 acpi_cmbat_info_updated(struct timespec *lastupdated)
230 ACPI_SERIAL_ASSERT(cmbat);
232 if (lastupdated != NULL)
233 getnanotime(lastupdated);
237 acpi_cmbat_get_bst(void *arg)
239 struct acpi_cmbat_softc *sc;
243 ACPI_BUFFER bst_buffer;
246 ACPI_SERIAL_ASSERT(cmbat);
249 sc = device_get_softc(dev);
250 h = acpi_get_handle(dev);
251 bst_buffer.Pointer = NULL;
252 bst_buffer.Length = ACPI_ALLOCATE_BUFFER;
254 if (!acpi_cmbat_info_expired(&sc->bst_lastupdated))
257 as = AcpiEvaluateObject(h, "_BST", NULL, &bst_buffer);
258 if (ACPI_FAILURE(as)) {
259 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
260 "error fetching current battery status -- %s\n",
261 AcpiFormatException(as));
265 res = (ACPI_OBJECT *)bst_buffer.Pointer;
266 if (!ACPI_PKG_VALID(res, 4)) {
267 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
268 "battery status corrupted\n");
272 if (acpi_PkgInt32(res, 0, &sc->bst.state) != 0)
274 if (acpi_PkgInt32(res, 1, &sc->bst.rate) != 0)
276 if (acpi_PkgInt32(res, 2, &sc->bst.cap) != 0)
278 if (acpi_PkgInt32(res, 3, &sc->bst.volt) != 0)
280 acpi_cmbat_info_updated(&sc->bst_lastupdated);
282 /* Clear out undefined/extended bits that might be set by hardware. */
283 sc->bst.state &= ACPI_BATT_STAT_BST_MASK;
284 if ((sc->bst.state & ACPI_BATT_STAT_INVALID) == ACPI_BATT_STAT_INVALID)
285 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
286 "battery reports simultaneous charging and discharging\n");
288 /* XXX If all batteries are critical, perhaps we should suspend. */
289 if (sc->bst.state & ACPI_BATT_STAT_CRITICAL) {
290 if ((sc->flags & ACPI_BATT_STAT_CRITICAL) == 0) {
291 sc->flags |= ACPI_BATT_STAT_CRITICAL;
292 device_printf(dev, "critically low charge!\n");
295 sc->flags &= ~ACPI_BATT_STAT_CRITICAL;
298 if (bst_buffer.Pointer != NULL)
299 AcpiOsFree(bst_buffer.Pointer);
302 /* XXX There should be a cleaner way to do this locking. */
304 acpi_cmbat_get_bif_task(void *arg)
307 ACPI_SERIAL_BEGIN(cmbat);
308 acpi_cmbat_get_bif(arg);
309 ACPI_SERIAL_END(cmbat);
313 acpi_cmbat_get_bif(void *arg)
315 struct acpi_cmbat_softc *sc;
319 ACPI_BUFFER bif_buffer;
322 ACPI_SERIAL_ASSERT(cmbat);
325 sc = device_get_softc(dev);
326 h = acpi_get_handle(dev);
327 bif_buffer.Pointer = NULL;
328 bif_buffer.Length = ACPI_ALLOCATE_BUFFER;
330 as = AcpiEvaluateObject(h, "_BIF", NULL, &bif_buffer);
331 if (ACPI_FAILURE(as)) {
332 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
333 "error fetching current battery info -- %s\n",
334 AcpiFormatException(as));
338 res = (ACPI_OBJECT *)bif_buffer.Pointer;
339 if (!ACPI_PKG_VALID(res, 13)) {
340 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
341 "battery info corrupted\n");
345 if (acpi_PkgInt32(res, 0, &sc->bif.units) != 0)
347 if (acpi_PkgInt32(res, 1, &sc->bif.dcap) != 0)
349 if (acpi_PkgInt32(res, 2, &sc->bif.lfcap) != 0)
351 if (acpi_PkgInt32(res, 3, &sc->bif.btech) != 0)
353 if (acpi_PkgInt32(res, 4, &sc->bif.dvol) != 0)
355 if (acpi_PkgInt32(res, 5, &sc->bif.wcap) != 0)
357 if (acpi_PkgInt32(res, 6, &sc->bif.lcap) != 0)
359 if (acpi_PkgInt32(res, 7, &sc->bif.gra1) != 0)
361 if (acpi_PkgInt32(res, 8, &sc->bif.gra2) != 0)
363 if (acpi_PkgStr(res, 9, sc->bif.model, ACPI_CMBAT_MAXSTRLEN) != 0)
365 if (acpi_PkgStr(res, 10, sc->bif.serial, ACPI_CMBAT_MAXSTRLEN) != 0)
367 if (acpi_PkgStr(res, 11, sc->bif.type, ACPI_CMBAT_MAXSTRLEN) != 0)
369 if (acpi_PkgStr(res, 12, sc->bif.oeminfo, ACPI_CMBAT_MAXSTRLEN) != 0)
373 if (bif_buffer.Pointer != NULL)
374 AcpiOsFree(bif_buffer.Pointer);
378 acpi_cmbat_bif(device_t dev, struct acpi_bif *bifp)
380 struct acpi_cmbat_softc *sc;
382 sc = device_get_softc(dev);
385 * Just copy the data. The only value that should change is the
386 * last-full capacity, so we only update when we get a notify that says
387 * the info has changed. Many systems apparently take a long time to
388 * process a _BIF call so we avoid it if possible.
390 ACPI_SERIAL_BEGIN(cmbat);
391 bifp->units = sc->bif.units;
392 bifp->dcap = sc->bif.dcap;
393 bifp->lfcap = sc->bif.lfcap;
394 bifp->btech = sc->bif.btech;
395 bifp->dvol = sc->bif.dvol;
396 bifp->wcap = sc->bif.wcap;
397 bifp->lcap = sc->bif.lcap;
398 bifp->gra1 = sc->bif.gra1;
399 bifp->gra2 = sc->bif.gra2;
400 strncpy(bifp->model, sc->bif.model, sizeof(sc->bif.model));
401 strncpy(bifp->serial, sc->bif.serial, sizeof(sc->bif.serial));
402 strncpy(bifp->type, sc->bif.type, sizeof(sc->bif.type));
403 strncpy(bifp->oeminfo, sc->bif.oeminfo, sizeof(sc->bif.oeminfo));
404 ACPI_SERIAL_END(cmbat);
410 acpi_cmbat_bst(device_t dev, struct acpi_bst *bstp)
412 struct acpi_cmbat_softc *sc;
414 sc = device_get_softc(dev);
416 ACPI_SERIAL_BEGIN(cmbat);
417 if (acpi_BatteryIsPresent(dev)) {
418 acpi_cmbat_get_bst(dev);
419 bstp->state = sc->bst.state;
420 bstp->rate = sc->bst.rate;
421 bstp->cap = sc->bst.cap;
422 bstp->volt = sc->bst.volt;
424 bstp->state = ACPI_BATT_STAT_NOT_PRESENT;
425 ACPI_SERIAL_END(cmbat);
431 acpi_cmbat_init_battery(void *arg)
433 struct acpi_cmbat_softc *sc;
438 sc = device_get_softc(dev);
439 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
440 "battery initialization start\n");
443 * Try repeatedly to get valid data from the battery. Since the
444 * embedded controller isn't always ready just after boot, we may have
447 for (retry = 0; retry < ACPI_CMBAT_RETRY_MAX; retry++, AcpiOsSleep(10000)) {
448 /* batteries on DOCK can be ejected w/ DOCK during retrying */
449 if (!device_is_attached(dev))
452 if (!acpi_BatteryIsPresent(dev))
456 * Only query the battery if this is the first try or the specific
457 * type of info is still invalid.
459 ACPI_SERIAL_BEGIN(cmbat);
460 if (retry == 0 || !acpi_battery_bst_valid(&sc->bst)) {
461 timespecclear(&sc->bst_lastupdated);
462 acpi_cmbat_get_bst(dev);
464 if (retry == 0 || !acpi_battery_bif_valid(&sc->bif))
465 acpi_cmbat_get_bif(dev);
467 valid = acpi_battery_bst_valid(&sc->bst) &&
468 acpi_battery_bif_valid(&sc->bif);
469 ACPI_SERIAL_END(cmbat);
475 if (retry == ACPI_CMBAT_RETRY_MAX) {
476 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
477 "battery initialization failed, giving up\n");
479 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
480 "battery initialization done, tried %d times\n", retry + 1);