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};
111 if (acpi_disabled("smbat") ||
112 ACPI_ID_PROBE(device_get_parent(dev), dev, smbat_ids) == NULL)
114 status = AcpiEvaluateObject(acpi_get_handle(dev), "_EC", NULL, NULL);
115 if (ACPI_FAILURE(status))
118 device_set_desc(dev, "ACPI Smart Battery");
123 acpi_smbat_attach(device_t dev)
125 struct acpi_smbat_softc *sc;
128 sc = device_get_softc(dev);
129 if (ACPI_FAILURE(acpi_GetInteger(acpi_get_handle(dev), "_EC", &base))) {
130 device_printf(dev, "cannot get EC base address\n");
133 sc->sb_base_addr = (base >> 8) & 0xff;
135 /* XXX Only works with one EC, but nearly all systems only have one. */
136 sc->ec_dev = devclass_get_device(devclass_find("acpi_ec"), 0);
137 if (sc->ec_dev == NULL) {
138 device_printf(dev, "cannot find EC device\n");
142 timespecclear(&sc->bif_lastupdated);
143 timespecclear(&sc->bst_lastupdated);
145 if (acpi_battery_register(dev) != 0) {
146 device_printf(dev, "cannot register battery\n");
153 acpi_smbat_shutdown(device_t dev)
156 acpi_battery_remove(dev);
161 acpi_smbat_info_expired(struct timespec *lastupdated)
163 struct timespec curtime;
165 ACPI_SERIAL_ASSERT(smbat);
167 if (lastupdated == NULL)
169 if (!timespecisset(lastupdated))
172 getnanotime(&curtime);
173 timespecsub(&curtime, lastupdated);
174 return (curtime.tv_sec < 0 ||
175 curtime.tv_sec > acpi_battery_get_info_expire());
179 acpi_smbat_info_updated(struct timespec *lastupdated)
182 ACPI_SERIAL_ASSERT(smbat);
184 if (lastupdated != NULL)
185 getnanotime(lastupdated);
189 acpi_smbus_read_2(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
195 ACPI_SERIAL_ASSERT(smbat);
198 AcpiOsSleep(batt_sleep_ms);
201 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
207 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
212 val = 0x09; /* | 0x80 if PEC */
213 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
219 AcpiOsSleep(batt_sleep_ms);
221 for (to = SMBUS_TIMEOUT; to != 0; to--) {
222 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
235 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
238 if (val & SMBUS_STS_MASK) {
239 printf("%s: AE_ERROR 0x%x\n",
240 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
245 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA,
257 acpi_smbus_read_multi_1(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
258 uint8_t *ptr, uint16_t len)
264 ACPI_SERIAL_ASSERT(smbat);
267 AcpiOsSleep(batt_sleep_ms);
270 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
276 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
281 val = 0x0B /* | 0x80 if PEC */ ;
282 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
288 AcpiOsSleep(batt_sleep_ms);
290 for (to = SMBUS_TIMEOUT; to != 0; to--) {
291 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
304 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
307 if (val & SMBUS_STS_MASK) {
308 printf("%s: AE_ERROR 0x%x\n",
309 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
315 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_BCNT,
319 val = (val & 0x1f) + 1;
326 AcpiOsSleep(batt_sleep_ms);
329 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA
336 AcpiOsSleep(batt_sleep_ms);
344 acpi_smbat_get_bst(device_t dev, struct acpi_bst *bst)
346 struct acpi_smbat_softc *sc;
348 uint32_t cap_units, factor;
352 ACPI_SERIAL_BEGIN(smbat);
354 addr = SMBATT_ADDRESS;
356 sc = device_get_softc(dev);
358 if (!acpi_smbat_info_expired(&sc->bst_lastupdated)) {
363 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
365 if (val & SMBATT_BM_CAPACITY_MODE) {
367 cap_units = ACPI_BIF_UNITS_MW;
370 cap_units = ACPI_BIF_UNITS_MA;
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_bif(device_t dev, struct acpi_bif *bif)
421 struct acpi_smbat_softc *sc;
427 ACPI_SERIAL_BEGIN(smbat);
429 addr = SMBATT_ADDRESS;
431 sc = device_get_softc(dev);
433 if (!acpi_smbat_info_expired(&sc->bif_lastupdated)) {
438 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
440 if (val & SMBATT_BM_CAPACITY_MODE) {
442 sc->bif.units = ACPI_BIF_UNITS_MW;
445 sc->bif.units = ACPI_BIF_UNITS_MA;
448 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_CAPACITY, &val))
450 sc->bif.dcap = val * factor;
452 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_FULL_CHARGE_CAPACITY, &val))
454 sc->bif.lfcap = val * factor;
455 sc->bif.btech = 1; /* secondary (rechargeable) */
457 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_VOLTAGE, &val))
461 sc->bif.wcap = sc->bif.dcap / 10;
462 sc->bif.lcap = sc->bif.dcap / 10;
464 sc->bif.gra1 = factor; /* not supported */
465 sc->bif.gra2 = factor; /* not supported */
467 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_NAME,
468 sc->bif.model, sizeof(sc->bif.model)))
471 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_SERIAL_NUMBER, &val))
473 snprintf(sc->bif.serial, sizeof(sc->bif.serial), "0x%04x", val);
475 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_CHEMISTRY,
476 sc->bif.type, sizeof(sc->bif.type)))
479 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_MANUFACTURER_DATA,
480 sc->bif.oeminfo, sizeof(sc->bif.oeminfo)))
483 /* XXX check if device was replugged during read? */
485 acpi_smbat_info_updated(&sc->bif_lastupdated);
490 memcpy(bif, &sc->bif, sizeof(sc->bif));
491 ACPI_SERIAL_END(smbat);