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 static SYSCTL_NODE(_debug_acpi
, OID_AUTO
, batt
, CTLFLAG_RD
, NULL
,
66 /* On some laptops with smart batteries, enabling battery monitoring
67 * software causes keystrokes from atkbd to be lost. This has also been
68 * reported on Linux, and is apparently due to the keyboard and I2C line
69 * for the battery being routed through the same chip. Whether that's
70 * accurate or not, adding extra sleeps to the status checking code
71 * causes the problem to go away.
73 * If you experience that problem, try a value of 10ms and move up
76 static int batt_sleep_ms
;
77 SYSCTL_INT(_debug_acpi_batt
, OID_AUTO
, batt_sleep_ms
, CTLFLAG_RW
, &batt_sleep_ms
, 0,
78 "Sleep during battery status updates to prevent keystroke loss.");
80 static device_method_t acpi_smbat_methods
[] = {
81 /* device interface */
82 DEVMETHOD(device_probe
, acpi_smbat_probe
),
83 DEVMETHOD(device_attach
, acpi_smbat_attach
),
84 DEVMETHOD(device_shutdown
, acpi_smbat_shutdown
),
86 /* ACPI battery interface */
87 DEVMETHOD(acpi_batt_get_status
, acpi_smbat_get_bst
),
88 DEVMETHOD(acpi_batt_get_info
, acpi_smbat_get_bif
),
93 static driver_t acpi_smbat_driver
= {
96 sizeof(struct acpi_smbat_softc
),
99 static devclass_t acpi_smbat_devclass
;
100 DRIVER_MODULE(acpi_smbat
, acpi
, acpi_smbat_driver
, acpi_smbat_devclass
,
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 ACPI_SERIAL_INIT(smbat
);
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 kprintf("%s: AE_ERROR 0x%x\n",
240 __func__
, (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 kprintf("%s: AE_ERROR 0x%x\n",
309 __func__
, (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
;
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
)
370 /* get battery status */
371 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_BATTERY_STATUS
, &val
))
375 if (val
& SMBATT_BS_DISCHARGING
)
376 sc
->bst
.state
|= ACPI_BATT_STAT_DISCHARG
;
378 if (val
& SMBATT_BS_REMAINING_CAPACITY_ALARM
)
379 sc
->bst
.state
|= ACPI_BATT_STAT_CRITICAL
;
382 * If the rate is negative, it is discharging. Otherwise,
385 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_CURRENT
, &val
))
389 sc
->bst
.rate
= val
* factor
;
390 sc
->bst
.state
&= ~SMBATT_BS_DISCHARGING
;
391 sc
->bst
.state
|= ACPI_BATT_STAT_CHARGING
;
393 sc
->bst
.rate
= (-val
) * factor
;
397 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_REMAINING_CAPACITY
, &val
))
399 sc
->bst
.cap
= val
* factor
;
401 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_VOLTAGE
, &val
))
405 acpi_smbat_info_updated(&sc
->bst_lastupdated
);
410 memcpy(bst
, &sc
->bst
, sizeof(sc
->bst
));
411 ACPI_SERIAL_END(smbat
);
416 acpi_smbat_get_bif(device_t dev
, struct acpi_bif
*bif
)
418 struct acpi_smbat_softc
*sc
;
424 ACPI_SERIAL_BEGIN(smbat
);
426 addr
= SMBATT_ADDRESS
;
428 sc
= device_get_softc(dev
);
430 if (!acpi_smbat_info_expired(&sc
->bif_lastupdated
)) {
435 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_BATTERY_MODE
, &val
))
437 if (val
& SMBATT_BM_CAPACITY_MODE
) {
439 sc
->bif
.units
= ACPI_BIF_UNITS_MW
;
442 sc
->bif
.units
= ACPI_BIF_UNITS_MA
;
445 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_DESIGN_CAPACITY
, &val
))
447 sc
->bif
.dcap
= val
* factor
;
449 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_FULL_CHARGE_CAPACITY
, &val
))
451 sc
->bif
.lfcap
= val
* factor
;
452 sc
->bif
.btech
= 1; /* secondary (rechargeable) */
454 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_DESIGN_VOLTAGE
, &val
))
458 sc
->bif
.wcap
= sc
->bif
.dcap
/ 10;
459 sc
->bif
.lcap
= sc
->bif
.dcap
/ 10;
461 sc
->bif
.gra1
= factor
; /* not supported */
462 sc
->bif
.gra2
= factor
; /* not supported */
464 if (acpi_smbus_read_multi_1(sc
, addr
, SMBATT_CMD_DEVICE_NAME
,
465 sc
->bif
.model
, sizeof(sc
->bif
.model
)))
468 if (acpi_smbus_read_2(sc
, addr
, SMBATT_CMD_SERIAL_NUMBER
, &val
))
470 ksnprintf(sc
->bif
.serial
, sizeof(sc
->bif
.serial
), "0x%04x", val
);
472 if (acpi_smbus_read_multi_1(sc
, addr
, SMBATT_CMD_DEVICE_CHEMISTRY
,
473 sc
->bif
.type
, sizeof(sc
->bif
.type
)))
476 if (acpi_smbus_read_multi_1(sc
, addr
, SMBATT_CMD_MANUFACTURER_DATA
,
477 sc
->bif
.oeminfo
, sizeof(sc
->bif
.oeminfo
)))
480 /* XXX check if device was replugged during read? */
482 acpi_smbat_info_updated(&sc
->bif_lastupdated
);
487 memcpy(bif
, &sc
->bif
, sizeof(sc
->bif
));
488 ACPI_SERIAL_END(smbat
);