2 * Copyright (c) 2005 Nate Lawson
3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/malloc.h>
36 #include <sys/ioccom.h>
37 #include <sys/sysctl.h>
39 #include <contrib/dev/acpica/include/acpi.h>
41 #include <dev/acpica/acpivar.h>
42 #include <dev/acpica/acpiio.h>
44 /* Default seconds before re-sampling the battery state. */
45 #define ACPI_BATTERY_INFO_EXPIRE 5
47 static int acpi_batteries_initted;
48 static int acpi_battery_info_expire = ACPI_BATTERY_INFO_EXPIRE;
49 static struct acpi_battinfo acpi_battery_battinfo;
50 static struct sysctl_ctx_list acpi_battery_sysctl_ctx;
51 static struct sysctl_oid *acpi_battery_sysctl_tree;
53 ACPI_SERIAL_DECL(battery, "ACPI generic battery");
55 static void acpi_reset_battinfo(struct acpi_battinfo *info);
56 static void acpi_battery_clean_str(char *str, int len);
57 static device_t acpi_battery_find_dev(u_int logical_unit);
58 static int acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg);
59 static int acpi_battery_sysctl(SYSCTL_HANDLER_ARGS);
60 static int acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS);
61 static int acpi_battery_init(void);
64 acpi_battery_register(device_t dev)
69 ACPI_SERIAL_BEGIN(battery);
70 if (!acpi_batteries_initted)
71 error = acpi_battery_init();
72 ACPI_SERIAL_END(battery);
77 acpi_battery_remove(device_t dev)
84 acpi_battery_get_units(void)
88 batt_dc = devclass_find("battery");
91 return (devclass_get_count(batt_dc));
95 acpi_battery_get_info_expire(void)
98 return (acpi_battery_info_expire);
101 /* Check _BST results for validity. */
103 acpi_battery_bst_valid(struct acpi_bst *bst)
106 return (bst->state != ACPI_BATT_STAT_NOT_PRESENT &&
107 bst->cap != ACPI_BATT_UNKNOWN && bst->volt != ACPI_BATT_UNKNOWN);
110 /* Check _BIF results for validity. */
112 acpi_battery_bif_valid(struct acpi_bif *bif)
114 return (bif->lfcap != 0);
117 /* Get info about one or all batteries. */
119 acpi_battery_get_battinfo(device_t dev, struct acpi_battinfo *battinfo)
121 int batt_stat, devcount, dev_idx, error, i;
122 int total_cap, total_lfcap, total_min, valid_rate, valid_units;
125 struct acpi_bst *bst;
126 struct acpi_bif *bif;
127 struct acpi_battinfo *bi;
130 * Get the battery devclass and max unit for battery devices. If there
131 * are none or error, return immediately.
133 batt_dc = devclass_find("battery");
136 devcount = devclass_get_maxunit(batt_dc);
141 * Allocate storage for all _BST data, their derived battinfo data,
142 * and the current battery's _BIF data.
144 bst = malloc(devcount * sizeof(*bst), M_TEMP, M_WAITOK | M_ZERO);
145 bi = malloc(devcount * sizeof(*bi), M_TEMP, M_WAITOK | M_ZERO);
146 bif = malloc(sizeof(*bif), M_TEMP, M_WAITOK | M_ZERO);
149 * Pass 1: for each battery that is present and valid, get its status,
150 * calculate percent capacity remaining, and sum all the current
154 batt_stat = valid_rate = valid_units = 0;
155 total_cap = total_lfcap = 0;
156 for (i = 0; i < devcount; i++) {
157 /* Default info for every battery is "not present". */
158 acpi_reset_battinfo(&bi[i]);
161 * Find the device. Since devcount is in terms of max units, this
162 * may be a sparse array so skip devices that aren't present.
164 batt_dev = devclass_get_device(batt_dc, i);
165 if (batt_dev == NULL)
168 /* If examining a specific battery and this is it, record its index. */
169 if (dev != NULL && dev == batt_dev)
173 * Be sure we can get various info from the battery.
175 if (ACPI_BATT_GET_STATUS(batt_dev, &bst[i]) != 0 ||
176 ACPI_BATT_GET_INFO(batt_dev, bif) != 0)
179 /* If a battery is not installed, we sometimes get strange values. */
180 if (!acpi_battery_bst_valid(&bst[i]) ||
181 !acpi_battery_bif_valid(bif))
185 * Record current state. If both charging and discharging are set,
186 * ignore the charging flag.
189 if ((bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
190 bst[i].state &= ~ACPI_BATT_STAT_CHARGING;
191 batt_stat |= bst[i].state;
192 bi[i].state = bst[i].state;
195 * If the battery info is in terms of mA, convert to mW by
196 * multiplying by the design voltage. If the design voltage
197 * is 0 (due to some error reading the battery), skip this
200 if (bif->units == ACPI_BIF_UNITS_MA && bif->dvol != 0 && dev == NULL) {
201 bst[i].rate = (bst[i].rate * bif->dvol) / 1000;
202 bst[i].cap = (bst[i].cap * bif->dvol) / 1000;
203 bif->lfcap = (bif->lfcap * bif->dvol) / 1000;
207 * The calculation above may set bif->lfcap to zero. This was
208 * seen on a laptop with a broken battery. The result of the
209 * division was rounded to zero.
211 if (!acpi_battery_bif_valid(bif))
215 * Some laptops report the "design-capacity" instead of the
216 * "real-capacity" when the battery is fully charged. That breaks
217 * the above arithmetic as it needs to be 100% maximum.
219 if (bst[i].cap > bif->lfcap)
220 bst[i].cap = bif->lfcap;
222 /* Calculate percent capacity remaining. */
223 bi[i].cap = (100 * bst[i].cap) / bif->lfcap;
225 /* If this battery is not present, don't use its capacity. */
226 if (bi[i].cap != -1) {
227 total_cap += bst[i].cap;
228 total_lfcap += bif->lfcap;
232 * On systems with more than one battery, they may get used
233 * sequentially, thus bst.rate may only signify the one currently
234 * in use. For the remaining batteries, bst.rate will be zero,
235 * which makes it impossible to calculate the total remaining time.
236 * Therefore, we sum the bst.rate for batteries in the discharging
237 * state and use the sum to calculate the total remaining time.
239 if (bst[i].rate != ACPI_BATT_UNKNOWN &&
240 (bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
241 valid_rate += bst[i].rate;
244 /* If the caller asked for a device but we didn't find it, error. */
245 if (dev != NULL && dev_idx == -1) {
250 /* Pass 2: calculate capacity and remaining time for all batteries. */
252 for (i = 0; i < devcount; i++) {
254 * If any batteries are discharging, use the sum of the bst.rate
255 * values. Otherwise, we are on AC power, and there is infinite
256 * time remaining for this battery until we go offline.
259 bi[i].min = (60 * bst[i].cap) / valid_rate;
262 total_min += bi[i].min;
266 * Return total battery percent and time remaining. If there are
267 * no valid batteries, report values as unknown.
269 if (valid_units > 0) {
271 battinfo->cap = (total_cap * 100) / total_lfcap;
272 battinfo->min = total_min;
273 battinfo->state = batt_stat;
274 battinfo->rate = valid_rate;
276 battinfo->cap = bi[dev_idx].cap;
277 battinfo->min = bi[dev_idx].min;
278 battinfo->state = bi[dev_idx].state;
279 battinfo->rate = bst[dev_idx].rate;
283 * If the queried battery has no discharge rate or is charging,
284 * report that we don't know the remaining time.
286 if (valid_rate == 0 || (battinfo->state & ACPI_BATT_STAT_CHARGING))
289 acpi_reset_battinfo(battinfo);
304 acpi_reset_battinfo(struct acpi_battinfo *info)
308 info->state = ACPI_BATT_STAT_NOT_PRESENT;
312 /* Make string printable, removing invalid chars. */
314 acpi_battery_clean_str(char *str, int len)
318 for (i = 0; i < len && *str != '\0'; i++, str++) {
323 /* NUL-terminate the string if we reached the end. */
329 * The battery interface deals with devices and methods but userland
330 * expects a logical unit number. Convert a logical unit to a device_t.
333 acpi_battery_find_dev(u_int logical_unit)
335 int found_unit, i, maxunit;
341 batt_dc = devclass_find("battery");
342 maxunit = devclass_get_maxunit(batt_dc);
343 for (i = 0; i < maxunit; i++) {
344 dev = devclass_get_device(batt_dc, i);
347 if (logical_unit == found_unit)
357 acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg)
359 union acpi_battery_ioctl_arg *ioctl_arg;
363 /* For commands that use the ioctl_arg struct, validate it first. */
368 if (IOCPARM_LEN(cmd) == sizeof(*ioctl_arg)) {
369 ioctl_arg = (union acpi_battery_ioctl_arg *)addr;
370 unit = ioctl_arg->unit;
371 if (unit != ACPI_BATTERY_ALL_UNITS)
372 dev = acpi_battery_find_dev(unit);
376 * No security check required: information retrieval only. If
377 * new functions are added here, a check might be required.
380 case ACPIIO_BATT_GET_UNITS:
381 *(int *)addr = acpi_battery_get_units();
384 case ACPIIO_BATT_GET_BATTINFO:
385 if (dev != NULL || unit == ACPI_BATTERY_ALL_UNITS) {
386 bzero(&ioctl_arg->battinfo, sizeof(ioctl_arg->battinfo));
387 error = acpi_battery_get_battinfo(dev, &ioctl_arg->battinfo);
390 case ACPIIO_BATT_GET_BIF:
392 bzero(&ioctl_arg->bif, sizeof(ioctl_arg->bif));
393 error = ACPI_BATT_GET_INFO(dev, &ioctl_arg->bif);
396 * Remove invalid characters. Perhaps this should be done
397 * within a convenience function so all callers get the
400 acpi_battery_clean_str(ioctl_arg->bif.model,
401 sizeof(ioctl_arg->bif.model));
402 acpi_battery_clean_str(ioctl_arg->bif.serial,
403 sizeof(ioctl_arg->bif.serial));
404 acpi_battery_clean_str(ioctl_arg->bif.type,
405 sizeof(ioctl_arg->bif.type));
406 acpi_battery_clean_str(ioctl_arg->bif.oeminfo,
407 sizeof(ioctl_arg->bif.oeminfo));
410 case ACPIIO_BATT_GET_BST:
412 bzero(&ioctl_arg->bst, sizeof(ioctl_arg->bst));
413 error = ACPI_BATT_GET_STATUS(dev, &ioctl_arg->bst);
424 acpi_battery_sysctl(SYSCTL_HANDLER_ARGS)
428 acpi_battery_get_battinfo(NULL, &acpi_battery_battinfo);
429 val = *(u_int *)oidp->oid_arg1;
430 error = sysctl_handle_int(oidp, &val, 0, req);
435 acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS)
439 count = acpi_battery_get_units();
440 error = sysctl_handle_int(oidp, &count, 0, req);
445 acpi_battery_init(void)
447 struct acpi_softc *sc;
451 ACPI_SERIAL_ASSERT(battery);
454 dev = devclass_get_device(devclass_find("acpi"), 0);
457 sc = device_get_softc(dev);
459 error = acpi_register_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl,
463 error = acpi_register_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl,
467 error = acpi_register_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl, NULL);
470 error = acpi_register_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl, NULL);
474 sysctl_ctx_init(&acpi_battery_sysctl_ctx);
475 acpi_battery_sysctl_tree = SYSCTL_ADD_NODE(&acpi_battery_sysctl_ctx,
476 SYSCTL_CHILDREN(sc->acpi_sysctl_tree), OID_AUTO, "battery", CTLFLAG_RD,
477 0, "battery status and info");
478 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
479 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
480 OID_AUTO, "life", CTLTYPE_INT | CTLFLAG_RD,
481 &acpi_battery_battinfo.cap, 0, acpi_battery_sysctl, "I",
482 "percent capacity remaining");
483 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
484 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
485 OID_AUTO, "time", CTLTYPE_INT | CTLFLAG_RD,
486 &acpi_battery_battinfo.min, 0, acpi_battery_sysctl, "I",
487 "remaining time in minutes");
488 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
489 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
490 OID_AUTO, "rate", CTLTYPE_INT | CTLFLAG_RD,
491 &acpi_battery_battinfo.rate, 0, acpi_battery_sysctl, "I",
492 "present rate in mW");
493 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
494 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
495 OID_AUTO, "state", CTLTYPE_INT | CTLFLAG_RD,
496 &acpi_battery_battinfo.state, 0, acpi_battery_sysctl, "I",
497 "current status flags");
498 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
499 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
500 OID_AUTO, "units", CTLTYPE_INT | CTLFLAG_RD,
501 NULL, 0, acpi_battery_units_sysctl, "I", "number of batteries");
502 SYSCTL_ADD_INT(&acpi_battery_sysctl_ctx,
503 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
504 OID_AUTO, "info_expire", CTLFLAG_RW,
505 &acpi_battery_info_expire, 0,
506 "time in seconds until info is refreshed");
508 acpi_batteries_initted = TRUE;
512 acpi_deregister_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl);
513 acpi_deregister_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl);
514 acpi_deregister_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl);
515 acpi_deregister_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl);