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
26 * $FreeBSD: src/sys/dev/acpica/acpi_smbat.c,v 1.11 2011/11/07 15:43:11 ed Exp $
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/module.h>
38 #include <acpi_smbus.h>
40 /* Transactions have failed after 500 ms. */
41 #define SMBUS_TIMEOUT 50
43 struct acpi_smbat_softc {
49 struct timespec bif_lastupdated;
50 struct timespec bst_lastupdated;
53 static int acpi_smbat_probe(device_t dev);
54 static int acpi_smbat_attach(device_t dev);
55 static int acpi_smbat_shutdown(device_t dev);
56 static int acpi_smbat_info_expired(struct timespec *lastupdated);
57 static void acpi_smbat_info_updated(struct timespec *lastupdated);
58 static int acpi_smbat_get_bif(device_t dev, struct acpi_bif *bif);
59 static int acpi_smbat_get_bst(device_t dev, struct acpi_bst *bst);
61 ACPI_SERIAL_DECL(smbat, "ACPI Smart Battery");
63 SYSCTL_DECL(_debug_acpi);
64 static SYSCTL_NODE(_debug_acpi, OID_AUTO, batt, CTLFLAG_RD, NULL,
67 /* On some laptops with smart batteries, enabling battery monitoring
68 * software causes keystrokes from atkbd to be lost. This has also been
69 * reported on Linux, and is apparently due to the keyboard and I2C line
70 * for the battery being routed through the same chip. Whether that's
71 * accurate or not, adding extra sleeps to the status checking code
72 * causes the problem to go away.
74 * If you experience that problem, try a value of 10ms and move up
77 static int batt_sleep_ms;
78 SYSCTL_INT(_debug_acpi_batt, OID_AUTO, batt_sleep_ms, CTLFLAG_RW, &batt_sleep_ms, 0,
79 "Sleep during battery status updates to prevent keystroke loss.");
81 static device_method_t acpi_smbat_methods[] = {
82 /* device interface */
83 DEVMETHOD(device_probe, acpi_smbat_probe),
84 DEVMETHOD(device_attach, acpi_smbat_attach),
85 DEVMETHOD(device_shutdown, acpi_smbat_shutdown),
87 /* ACPI battery interface */
88 DEVMETHOD(acpi_batt_get_status, acpi_smbat_get_bst),
89 DEVMETHOD(acpi_batt_get_info, acpi_smbat_get_bif),
94 static driver_t acpi_smbat_driver = {
97 sizeof(struct acpi_smbat_softc),
100 static devclass_t acpi_smbat_devclass;
101 DRIVER_MODULE(acpi_smbat, acpi, acpi_smbat_driver, acpi_smbat_devclass, 0, 0);
102 MODULE_DEPEND(acpi_smbat, acpi, 1, 1, 1);
105 acpi_smbat_probe(device_t dev)
107 static char *smbat_ids[] = {"ACPI0001", "ACPI0005", NULL};
110 if (acpi_disabled("smbat") ||
111 ACPI_ID_PROBE(device_get_parent(dev), dev, smbat_ids) == NULL)
113 status = AcpiEvaluateObject(acpi_get_handle(dev), "_EC", NULL, NULL);
114 if (ACPI_FAILURE(status))
117 device_set_desc(dev, "ACPI Smart Battery");
122 acpi_smbat_attach(device_t dev)
124 struct acpi_smbat_softc *sc;
127 sc = device_get_softc(dev);
128 if (ACPI_FAILURE(acpi_GetInteger(acpi_get_handle(dev), "_EC", &base))) {
129 device_printf(dev, "cannot get EC base address\n");
132 sc->sb_base_addr = (base >> 8) & 0xff;
134 /* XXX Only works with one EC, but nearly all systems only have one. */
135 sc->ec_dev = devclass_get_device(devclass_find("acpi_ec"), 0);
136 if (sc->ec_dev == NULL) {
137 device_printf(dev, "cannot find EC device\n");
141 timespecclear(&sc->bif_lastupdated);
142 timespecclear(&sc->bst_lastupdated);
144 if (acpi_battery_register(dev) != 0) {
145 device_printf(dev, "cannot register battery\n");
152 acpi_smbat_shutdown(device_t dev)
155 acpi_battery_remove(dev);
160 acpi_smbat_info_expired(struct timespec *lastupdated)
162 struct timespec curtime;
164 ACPI_SERIAL_ASSERT(smbat);
166 if (lastupdated == NULL)
168 if (!timespecisset(lastupdated))
171 getnanotime(&curtime);
172 timespecsub(&curtime, lastupdated);
173 return (curtime.tv_sec < 0 ||
174 curtime.tv_sec > acpi_battery_get_info_expire());
178 acpi_smbat_info_updated(struct timespec *lastupdated)
181 ACPI_SERIAL_ASSERT(smbat);
183 if (lastupdated != NULL)
184 getnanotime(lastupdated);
188 acpi_smbus_read_2(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
194 ACPI_SERIAL_ASSERT(smbat);
197 AcpiOsSleep(batt_sleep_ms);
200 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
206 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
211 val = 0x09; /* | 0x80 if PEC */
212 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
218 AcpiOsSleep(batt_sleep_ms);
220 for (to = SMBUS_TIMEOUT; to != 0; to--) {
221 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
234 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
237 if (val & SMBUS_STS_MASK) {
238 kprintf("%s: AE_ERROR 0x%x\n",
239 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
244 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA,
256 acpi_smbus_read_multi_1(struct acpi_smbat_softc *sc, uint8_t addr, uint8_t cmd,
257 uint8_t *ptr, uint16_t len)
263 ACPI_SERIAL_ASSERT(smbat);
266 AcpiOsSleep(batt_sleep_ms);
269 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_ADDR,
275 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_CMD,
280 val = 0x0B /* | 0x80 if PEC */ ;
281 error = ACPI_EC_WRITE(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
287 AcpiOsSleep(batt_sleep_ms);
289 for (to = SMBUS_TIMEOUT; to != 0; to--) {
290 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_PRTCL,
303 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_STS, &val, 1);
306 if (val & SMBUS_STS_MASK) {
307 kprintf("%s: AE_ERROR 0x%x\n",
308 __FUNCTION__, (int)(val & SMBUS_STS_MASK));
314 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_BCNT,
318 val = (val & 0x1f) + 1;
325 AcpiOsSleep(batt_sleep_ms);
328 error = ACPI_EC_READ(sc->ec_dev, sc->sb_base_addr + SMBUS_DATA
335 AcpiOsSleep(batt_sleep_ms);
343 acpi_smbat_get_bst(device_t dev, struct acpi_bst *bst)
345 struct acpi_smbat_softc *sc;
351 ACPI_SERIAL_BEGIN(smbat);
353 addr = SMBATT_ADDRESS;
355 sc = device_get_softc(dev);
357 if (!acpi_smbat_info_expired(&sc->bst_lastupdated)) {
362 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
364 if (val & SMBATT_BM_CAPACITY_MODE)
369 /* get battery status */
370 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_STATUS, &val))
374 if (val & SMBATT_BS_DISCHARGING)
375 sc->bst.state |= ACPI_BATT_STAT_DISCHARG;
377 if (val & SMBATT_BS_REMAINING_CAPACITY_ALARM)
378 sc->bst.state |= ACPI_BATT_STAT_CRITICAL;
381 * If the rate is negative, it is discharging. Otherwise,
384 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_CURRENT, &val))
388 sc->bst.rate = val * factor;
389 sc->bst.state &= ~SMBATT_BS_DISCHARGING;
390 sc->bst.state |= ACPI_BATT_STAT_CHARGING;
392 sc->bst.rate = (-val) * factor;
396 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_REMAINING_CAPACITY, &val))
398 sc->bst.cap = val * factor;
400 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_VOLTAGE, &val))
404 acpi_smbat_info_updated(&sc->bst_lastupdated);
409 memcpy(bst, &sc->bst, sizeof(sc->bst));
410 ACPI_SERIAL_END(smbat);
415 acpi_smbat_get_bif(device_t dev, struct acpi_bif *bif)
417 struct acpi_smbat_softc *sc;
423 ACPI_SERIAL_BEGIN(smbat);
425 addr = SMBATT_ADDRESS;
427 sc = device_get_softc(dev);
429 if (!acpi_smbat_info_expired(&sc->bif_lastupdated)) {
434 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_BATTERY_MODE, &val))
436 if (val & SMBATT_BM_CAPACITY_MODE) {
438 sc->bif.units = ACPI_BIF_UNITS_MW;
441 sc->bif.units = ACPI_BIF_UNITS_MA;
444 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_CAPACITY, &val))
446 sc->bif.dcap = val * factor;
448 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_FULL_CHARGE_CAPACITY, &val))
450 sc->bif.lfcap = val * factor;
451 sc->bif.btech = 1; /* secondary (rechargeable) */
453 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_DESIGN_VOLTAGE, &val))
457 sc->bif.wcap = sc->bif.dcap / 10;
458 sc->bif.lcap = sc->bif.dcap / 10;
460 sc->bif.gra1 = factor; /* not supported */
461 sc->bif.gra2 = factor; /* not supported */
463 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_NAME,
464 sc->bif.model, sizeof(sc->bif.model)))
467 if (acpi_smbus_read_2(sc, addr, SMBATT_CMD_SERIAL_NUMBER, &val))
469 ksnprintf(sc->bif.serial, sizeof(sc->bif.serial), "0x%04x", val);
471 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_DEVICE_CHEMISTRY,
472 sc->bif.type, sizeof(sc->bif.type)))
475 if (acpi_smbus_read_multi_1(sc, addr, SMBATT_CMD_MANUFACTURER_DATA,
476 sc->bif.oeminfo, sizeof(sc->bif.oeminfo)))
479 /* XXX check if device was replugged during read? */
481 acpi_smbat_info_updated(&sc->bif_lastupdated);
486 memcpy(bif, &sc->bif, sizeof(sc->bif));
487 ACPI_SERIAL_END(smbat);