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 bif_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_bif(device_t dev, struct acpi_bif *bif);
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, CTLFLAG_RD, NULL,
68 /* On some laptops with smart batteries, enabling battery monitoring
69 * software causes keystrokes from atkbd to be lost. This has also been
70 * reported on Linux, and is apparently due to the keyboard and I2C line
71 * for the battery being routed through the same chip. Whether that's
72 * accurate or not, adding extra sleeps to the status checking code
73 * causes the problem to go away.
75 * If you experience that problem, try a value of 10ms and move up
78 static int batt_sleep_ms;
79 SYSCTL_INT(_debug_acpi_batt, OID_AUTO, batt_sleep_ms, CTLFLAG_RW, &batt_sleep_ms, 0,
80 "Sleep during battery status updates to prevent keystroke loss.");
82 static device_method_t acpi_smbat_methods[] = {
83 /* device interface */
84 DEVMETHOD(device_probe, acpi_smbat_probe),
85 DEVMETHOD(device_attach, acpi_smbat_attach),
86 DEVMETHOD(device_shutdown, acpi_smbat_shutdown),
88 /* ACPI battery interface */
89 DEVMETHOD(acpi_batt_get_status, acpi_smbat_get_bst),
90 DEVMETHOD(acpi_batt_get_info, acpi_smbat_get_bif),
95 static driver_t acpi_smbat_driver = {
98 sizeof(struct acpi_smbat_softc),
101 static devclass_t acpi_smbat_devclass;
102 DRIVER_MODULE(acpi_smbat, acpi, acpi_smbat_driver, acpi_smbat_devclass, 0, 0);
103 MODULE_DEPEND(acpi_smbat, acpi, 1, 1, 1);
106 acpi_smbat_probe(device_t dev)
108 static char *smbat_ids[] = {"ACPI0001", "ACPI0005", NULL};
112 if (acpi_disabled("smbat"))
114 rv = ACPI_ID_PROBE(device_get_parent(dev), dev, smbat_ids, NULL);
117 status = AcpiEvaluateObject(acpi_get_handle(dev), "_EC", NULL, NULL);
118 if (ACPI_FAILURE(status))
120 device_set_desc(dev, "ACPI Smart Battery");
125 acpi_smbat_attach(device_t dev)
127 struct acpi_smbat_softc *sc;
130 sc = device_get_softc(dev);
131 if (ACPI_FAILURE(acpi_GetInteger(acpi_get_handle(dev), "_EC", &base))) {
132 device_printf(dev, "cannot get EC base address\n");
135 sc->sb_base_addr = (base >> 8) & 0xff;
137 /* XXX Only works with one EC, but nearly all systems only have one. */
138 sc->ec_dev = devclass_get_device(devclass_find("acpi_ec"), 0);
139 if (sc->ec_dev == NULL) {
140 device_printf(dev, "cannot find EC device\n");
144 timespecclear(&sc->bif_lastupdated);
145 timespecclear(&sc->bst_lastupdated);
147 if (acpi_battery_register(dev) != 0) {
148 device_printf(dev, "cannot register battery\n");
155 acpi_smbat_shutdown(device_t dev)
158 acpi_battery_remove(dev);
163 acpi_smbat_info_expired(struct timespec *lastupdated)
165 struct timespec curtime;
167 ACPI_SERIAL_ASSERT(smbat);
169 if (lastupdated == NULL)
171 if (!timespecisset(lastupdated))
174 getnanotime(&curtime);
175 timespecsub(&curtime, lastupdated, &curtime);
176 return (curtime.tv_sec < 0 ||
177 curtime.tv_sec > acpi_battery_get_info_expire());
181 acpi_smbat_info_updated(struct timespec *lastupdated)
184 ACPI_SERIAL_ASSERT(smbat);
186 if (lastupdated != NULL)
187 getnanotime(lastupdated);
191 acpi_smbus_read_2(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
197 ACPI_SERIAL_ASSERT(smbat);
200 AcpiOsSleep(batt_sleep_ms);
203 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
209 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
214 val = 0x09; /* | 0x80 if PEC */
215 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
221 AcpiOsSleep(batt_sleep_ms);
223 for (to = SMBUS_TIMEOUT; to != 0; to--) {
224 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
237 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
240 if (val & SMBUS_STS_MASK) {
241 printf("%s: AE_ERROR 0x%x\n",
242 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
247 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA,
259 acpi_smbus_read_multi_1(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
260 uint8_t *ptr, uint16_t len)
266 ACPI_SERIAL_ASSERT(smbat);
269 AcpiOsSleep(batt_sleep_ms);
272 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
278 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
283 val = 0x0B /* | 0x80 if PEC */ ;
284 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
290 AcpiOsSleep(batt_sleep_ms);
292 for (to = SMBUS_TIMEOUT; to != 0; to--) {
293 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
306 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
309 if (val & SMBUS_STS_MASK) {
310 printf("%s: AE_ERROR 0x%x\n",
311 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
317 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_BCNT,
321 val = (val & 0x1f) + 1;
328 AcpiOsSleep(batt_sleep_ms);
331 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA
338 AcpiOsSleep(batt_sleep_ms);
346 acpi_smbat_get_bst(device_t dev, struct acpi_bst *bst)
348 struct acpi_smbat_softc *sc;
354 ACPI_SERIAL_BEGIN(smbat);
356 addr = SMBATT_ADDRESS;
358 sc = device_get_softc(dev);
360 if (!acpi_smbat_info_expired(&sc->bst_lastupdated)) {
365 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
367 if (val & SMBATT_BM_CAPACITY_MODE)
372 /* get battery status */
373 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_STATUS, &val))
377 if (val & SMBATT_BS_DISCHARGING)
378 sc->bst.state |= ACPI_BATT_STAT_DISCHARG;
380 if (val & SMBATT_BS_REMAINING_CAPACITY_ALARM)
381 sc->bst.state |= ACPI_BATT_STAT_CRITICAL;
384 * If the rate is negative, it is discharging. Otherwise,
387 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_CURRENT, &val))
391 sc->bst.rate = val * factor;
392 sc->bst.state &= ~SMBATT_BS_DISCHARGING;
393 sc->bst.state |= ACPI_BATT_STAT_CHARGING;
395 sc->bst.rate = (-val) * factor;
399 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_REMAINING_CAPACITY, &val))
401 sc->bst.cap = val * factor;
403 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_VOLTAGE, &val))
407 acpi_smbat_info_updated(&sc->bst_lastupdated);
412 memcpy(bst, &sc->bst, sizeof(sc->bst));
413 ACPI_SERIAL_END(smbat);
418 acpi_smbat_get_bif(device_t dev, struct acpi_bif *bif)
420 struct acpi_smbat_softc *sc;
426 ACPI_SERIAL_BEGIN(smbat);
428 addr = SMBATT_ADDRESS;
430 sc = device_get_softc(dev);
432 if (!acpi_smbat_info_expired(&sc->bif_lastupdated)) {
437 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
439 if (val & SMBATT_BM_CAPACITY_MODE) {
441 sc->bif.units = ACPI_BIF_UNITS_MW;
444 sc->bif.units = ACPI_BIF_UNITS_MA;
447 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_CAPACITY, &val))
449 sc->bif.dcap = val * factor;
451 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_FULL_CHARGE_CAPACITY, &val))
453 sc->bif.lfcap = val * factor;
454 sc->bif.btech = 1; /* secondary (rechargeable) */
456 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_VOLTAGE, &val))
460 sc->bif.wcap = sc->bif.dcap / 10;
461 sc->bif.lcap = sc->bif.dcap / 10;
463 sc->bif.gra1 = factor; /* not supported */
464 sc->bif.gra2 = factor; /* not supported */
466 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_NAME,
467 sc->bif.model, sizeof(sc->bif.model)))
470 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_SERIAL_NUMBER, &val))
472 snprintf(sc->bif.serial, sizeof(sc->bif.serial), "0x%04x", val);
474 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_CHEMISTRY,
475 sc->bif.type, sizeof(sc->bif.type)))
478 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_MANUFACTURER_DATA,
479 sc->bif.oeminfo, sizeof(sc->bif.oeminfo)))
482 /* XXX check if device was replugged during read? */
484 acpi_smbat_info_updated(&sc->bif_lastupdated);
489 memcpy(bif, &sc->bif, sizeof(sc->bif));
490 ACPI_SERIAL_END(smbat);