2 * Copyright (c) 2005 Hans Petter Selasky
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
36 #include <contrib/dev/acpica/include/acpi.h>
38 #include <dev/acpica/acpivar.h>
39 #include <dev/acpica/acpiio.h>
40 #include <dev/acpica/acpi_smbus.h>
42 /* Transactions have failed after 500 ms. */
43 #define SMBUS_TIMEOUT 50
45 struct acpi_smbat_softc {
51 struct timespec bix_lastupdated;
52 struct timespec bst_lastupdated;
55 static int acpi_smbat_probe(device_t dev);
56 static int acpi_smbat_attach(device_t dev);
57 static int acpi_smbat_shutdown(device_t dev);
58 static int acpi_smbat_info_expired(struct timespec *lastupdated);
59 static void acpi_smbat_info_updated(struct timespec *lastupdated);
60 static int acpi_smbat_get_bix(device_t dev, void *, size_t);
61 static int acpi_smbat_get_bst(device_t dev, struct acpi_bst *bst);
63 ACPI_SERIAL_DECL(smbat, "ACPI Smart Battery");
65 static SYSCTL_NODE(_debug_acpi, OID_AUTO, batt,
66 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL,
69 /* On some laptops with smart batteries, enabling battery monitoring
70 * software causes keystrokes from atkbd to be lost. This has also been
71 * reported on Linux, and is apparently due to the keyboard and I2C line
72 * for the battery being routed through the same chip. Whether that's
73 * accurate or not, adding extra sleeps to the status checking code
74 * causes the problem to go away.
76 * If you experience that problem, try a value of 10ms and move up
79 static int batt_sleep_ms;
80 SYSCTL_INT(_debug_acpi_batt, OID_AUTO, batt_sleep_ms, CTLFLAG_RW, &batt_sleep_ms, 0,
81 "Sleep during battery status updates to prevent keystroke loss.");
83 static device_method_t acpi_smbat_methods[] = {
84 /* device interface */
85 DEVMETHOD(device_probe, acpi_smbat_probe),
86 DEVMETHOD(device_attach, acpi_smbat_attach),
87 DEVMETHOD(device_shutdown, acpi_smbat_shutdown),
89 /* ACPI battery interface */
90 DEVMETHOD(acpi_batt_get_status, acpi_smbat_get_bst),
91 DEVMETHOD(acpi_batt_get_info, acpi_smbat_get_bix),
96 static driver_t acpi_smbat_driver = {
99 sizeof(struct acpi_smbat_softc),
102 static devclass_t acpi_smbat_devclass;
103 DRIVER_MODULE(acpi_smbat, acpi, acpi_smbat_driver, acpi_smbat_devclass, 0, 0);
104 MODULE_DEPEND(acpi_smbat, acpi, 1, 1, 1);
107 acpi_smbat_probe(device_t dev)
109 static char *smbat_ids[] = {"ACPI0001", "ACPI0005", NULL};
113 if (acpi_disabled("smbat"))
115 rv = ACPI_ID_PROBE(device_get_parent(dev), dev, smbat_ids, NULL);
118 status = AcpiEvaluateObject(acpi_get_handle(dev), "_EC", NULL, NULL);
119 if (ACPI_FAILURE(status))
121 device_set_desc(dev, "ACPI Smart Battery");
126 acpi_smbat_attach(device_t dev)
128 struct acpi_smbat_softc *sc;
131 sc = device_get_softc(dev);
132 if (ACPI_FAILURE(acpi_GetInteger(acpi_get_handle(dev), "_EC", &base))) {
133 device_printf(dev, "cannot get EC base address\n");
136 sc->sb_base_addr = (base >> 8) & 0xff;
138 /* XXX Only works with one EC, but nearly all systems only have one. */
139 sc->ec_dev = devclass_get_device(devclass_find("acpi_ec"), 0);
140 if (sc->ec_dev == NULL) {
141 device_printf(dev, "cannot find EC device\n");
145 timespecclear(&sc->bix_lastupdated);
146 timespecclear(&sc->bst_lastupdated);
148 if (acpi_battery_register(dev) != 0) {
149 device_printf(dev, "cannot register battery\n");
156 acpi_smbat_shutdown(device_t dev)
159 acpi_battery_remove(dev);
164 acpi_smbat_info_expired(struct timespec *lastupdated)
166 struct timespec curtime;
168 ACPI_SERIAL_ASSERT(smbat);
170 if (lastupdated == NULL)
172 if (!timespecisset(lastupdated))
175 getnanotime(&curtime);
176 timespecsub(&curtime, lastupdated, &curtime);
177 return (curtime.tv_sec < 0 ||
178 curtime.tv_sec > acpi_battery_get_info_expire());
182 acpi_smbat_info_updated(struct timespec *lastupdated)
185 ACPI_SERIAL_ASSERT(smbat);
187 if (lastupdated != NULL)
188 getnanotime(lastupdated);
192 acpi_smbus_read_2(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
198 ACPI_SERIAL_ASSERT(smbat);
201 AcpiOsSleep(batt_sleep_ms);
204 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
210 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
215 val = 0x09; /* | 0x80 if PEC */
216 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
222 AcpiOsSleep(batt_sleep_ms);
224 for (to = SMBUS_TIMEOUT; to != 0; to--) {
225 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
238 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
241 if (val & SMBUS_STS_MASK) {
242 printf("%s: AE_ERROR 0x%x\n",
243 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
248 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA,
260 acpi_smbus_read_multi_1(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
261 uint8_t *ptr, uint16_t len)
267 ACPI_SERIAL_ASSERT(smbat);
270 AcpiOsSleep(batt_sleep_ms);
273 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
279 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
284 val = 0x0B /* | 0x80 if PEC */ ;
285 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
291 AcpiOsSleep(batt_sleep_ms);
293 for (to = SMBUS_TIMEOUT; to != 0; to--) {
294 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
307 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
310 if (val & SMBUS_STS_MASK) {
311 printf("%s: AE_ERROR 0x%x\n",
312 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
318 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_BCNT,
322 val = (val & 0x1f) + 1;
329 AcpiOsSleep(batt_sleep_ms);
332 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA
339 AcpiOsSleep(batt_sleep_ms);
347 acpi_smbat_get_bst(device_t dev, struct acpi_bst *bst)
349 struct acpi_smbat_softc *sc;
355 ACPI_SERIAL_BEGIN(smbat);
357 addr = SMBATT_ADDRESS;
359 sc = device_get_softc(dev);
361 if (!acpi_smbat_info_expired(&sc->bst_lastupdated)) {
366 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
368 if (val & SMBATT_BM_CAPACITY_MODE)
373 /* get battery status */
374 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_STATUS, &val))
378 if (val & SMBATT_BS_DISCHARGING)
379 sc->bst.state |= ACPI_BATT_STAT_DISCHARG;
381 if (val & SMBATT_BS_REMAINING_CAPACITY_ALARM)
382 sc->bst.state |= ACPI_BATT_STAT_CRITICAL;
385 * If the rate is negative, it is discharging. Otherwise,
388 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_CURRENT, &val))
392 sc->bst.rate = val * factor;
393 sc->bst.state &= ~SMBATT_BS_DISCHARGING;
394 sc->bst.state |= ACPI_BATT_STAT_CHARGING;
396 sc->bst.rate = (-val) * factor;
400 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_REMAINING_CAPACITY, &val))
402 sc->bst.cap = val * factor;
404 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_VOLTAGE, &val))
408 acpi_smbat_info_updated(&sc->bst_lastupdated);
413 memcpy(bst, &sc->bst, sizeof(sc->bst));
414 ACPI_SERIAL_END(smbat);
419 acpi_smbat_get_bix(device_t dev, void *bix, size_t len)
421 struct acpi_smbat_softc *sc;
427 if (len != sizeof(struct acpi_bix) &&
428 len != sizeof(struct acpi_bif))
431 ACPI_SERIAL_BEGIN(smbat);
433 addr = SMBATT_ADDRESS;
435 sc = device_get_softc(dev);
437 if (!acpi_smbat_info_expired(&sc->bix_lastupdated)) {
442 sc->bix.rev = ACPI_BIX_REV_BIF;
444 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
446 if (val & SMBATT_BM_CAPACITY_MODE) {
448 sc->bix.units = ACPI_BIX_UNITS_MW;
451 sc->bix.units = ACPI_BIX_UNITS_MA;
454 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_CAPACITY, &val))
456 sc->bix.dcap = val * factor;
458 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_FULL_CHARGE_CAPACITY, &val))
460 sc->bix.lfcap = val * factor;
461 sc->bix.btech = 1; /* secondary (rechargeable) */
463 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_VOLTAGE, &val))
467 sc->bix.wcap = sc->bix.dcap / 10;
468 sc->bix.lcap = sc->bix.dcap / 10;
470 sc->bix.gra1 = factor; /* not supported */
471 sc->bix.gra2 = factor; /* not supported */
473 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_NAME,
474 sc->bix.model, sizeof(sc->bix.model)))
477 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_SERIAL_NUMBER, &val))
479 snprintf(sc->bix.serial, sizeof(sc->bix.serial), "0x%04x", val);
481 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_CHEMISTRY,
482 sc->bix.type, sizeof(sc->bix.type)))
485 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_MANUFACTURER_DATA,
486 sc->bix.oeminfo, sizeof(sc->bix.oeminfo)))
489 /* XXX check if device was replugged during read? */
491 acpi_smbat_info_updated(&sc->bix_lastupdated);
496 memcpy(bix, &sc->bix, len);
497 ACPI_SERIAL_END(smbat);