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/acpi.h>
40 #include <dev/acpica/acpivar.h>
41 #include <dev/acpica/acpiio.h>
43 /* Default seconds before re-sampling the battery state. */
44 #define ACPI_BATTERY_INFO_EXPIRE 5
46 static int acpi_batteries_initted;
47 static int acpi_battery_info_expire = ACPI_BATTERY_INFO_EXPIRE;
48 static struct acpi_battinfo acpi_battery_battinfo;
49 static struct sysctl_ctx_list acpi_battery_sysctl_ctx;
50 static struct sysctl_oid *acpi_battery_sysctl_tree;
52 ACPI_SERIAL_DECL(battery, "ACPI generic battery");
54 static void acpi_reset_battinfo(struct acpi_battinfo *info);
55 static void acpi_battery_clean_str(char *str, int len);
56 static device_t acpi_battery_find_dev(u_int logical_unit);
57 static int acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg);
58 static int acpi_battery_sysctl(SYSCTL_HANDLER_ARGS);
59 static int acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS);
60 static int acpi_battery_init(void);
63 acpi_battery_register(device_t dev)
68 ACPI_SERIAL_BEGIN(battery);
69 if (!acpi_batteries_initted)
70 error = acpi_battery_init();
71 ACPI_SERIAL_END(battery);
76 acpi_battery_remove(device_t dev)
83 acpi_battery_get_units(void)
87 batt_dc = devclass_find("battery");
90 return (devclass_get_count(batt_dc));
94 acpi_battery_get_info_expire(void)
97 return (acpi_battery_info_expire);
100 /* Check _BST results for validity. */
102 acpi_battery_bst_valid(struct acpi_bst *bst)
104 return (bst->state < ACPI_BATT_STAT_MAX && bst->cap != ACPI_BATT_UNKNOWN &&
105 bst->volt != ACPI_BATT_UNKNOWN);
108 /* Check _BIF results for validity. */
110 acpi_battery_bif_valid(struct acpi_bif *bif)
112 return (bif->lfcap != 0);
115 /* Get info about one or all batteries. */
117 acpi_battery_get_battinfo(device_t dev, struct acpi_battinfo *battinfo)
119 int batt_stat, devcount, dev_idx, error, i;
120 int total_cap, total_min, valid_rate, valid_units;
123 struct acpi_bst *bst;
124 struct acpi_bif *bif;
125 struct acpi_battinfo *bi;
128 * Get the battery devclass and max unit for battery devices. If there
129 * are none or error, return immediately.
131 batt_dc = devclass_find("battery");
134 devcount = devclass_get_maxunit(batt_dc);
139 * Allocate storage for all _BST data, their derived battinfo data,
140 * and the current battery's _BIF data.
142 bst = malloc(devcount * sizeof(*bst), M_TEMP, M_WAITOK | M_ZERO);
143 bi = malloc(devcount * sizeof(*bi), M_TEMP, M_WAITOK | M_ZERO);
144 bif = malloc(sizeof(*bif), M_TEMP, M_WAITOK | M_ZERO);
147 * Pass 1: for each battery that is present and valid, get its status,
148 * calculate percent capacity remaining, and sum all the current
152 batt_stat = valid_rate = valid_units = 0;
153 for (i = 0; i < devcount; i++) {
154 /* Default info for every battery is "not present". */
155 acpi_reset_battinfo(&bi[i]);
158 * Find the device. Since devcount is in terms of max units, this
159 * may be a sparse array so skip devices that aren't present.
161 batt_dev = devclass_get_device(batt_dc, i);
162 if (batt_dev == NULL)
165 /* If examining a specific battery and this is it, record its index. */
166 if (dev != NULL && dev == batt_dev)
170 * Be sure we can get various info from the battery. Note that we
171 * can't check acpi_BatteryIsPresent() because smart batteries only
172 * return that the device is present.
174 if (ACPI_BATT_GET_STATUS(batt_dev, &bst[i]) != 0 ||
175 ACPI_BATT_GET_INFO(batt_dev, bif) != 0)
178 /* If a battery is not installed, we sometimes get strange values. */
179 if (!acpi_battery_bst_valid(&bst[i]) ||
180 !acpi_battery_bif_valid(bif))
184 * Record current state. If both charging and discharging are set,
185 * ignore the charging flag.
188 if ((bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
189 bst[i].state &= ~ACPI_BATT_STAT_CHARGING;
190 batt_stat |= bst[i].state;
191 bi[i].state = bst[i].state;
194 * If the battery info is in terms of mA, convert to mW by
195 * multiplying by the design voltage.
197 if (bif->units == ACPI_BIF_UNITS_MA) {
198 bst[i].rate = (bst[i].rate * bif->dvol) / 1000;
199 bst[i].cap = (bst[i].cap * bif->dvol) / 1000;
200 bif->lfcap = (bif->lfcap * bif->dvol) / 1000;
203 /* Calculate percent capacity remaining. */
204 bi[i].cap = (100 * bst[i].cap) / bif->lfcap;
207 * Some laptops report the "design-capacity" instead of the
208 * "real-capacity" when the battery is fully charged. That breaks
209 * the above arithmetic as it needs to be 100% maximum.
215 * On systems with more than one battery, they may get used
216 * sequentially, thus bst.rate may only signify the one currently
217 * in use. For the remaining batteries, bst.rate will be zero,
218 * which makes it impossible to calculate the total remaining time.
219 * Therefore, we sum the bst.rate for batteries in the discharging
220 * state and use the sum to calculate the total remaining time.
222 if (bst[i].rate != ACPI_BATT_UNKNOWN &&
223 (bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
224 valid_rate += bst[i].rate;
227 /* If the caller asked for a device but we didn't find it, error. */
228 if (dev != NULL && dev_idx == -1) {
233 /* Pass 2: calculate capacity and remaining time for all batteries. */
234 total_cap = total_min = 0;
235 for (i = 0; i < devcount; i++) {
237 * If any batteries are discharging, use the sum of the bst.rate
238 * values. Otherwise, we are on AC power, and there is infinite
239 * time remaining for this battery until we go offline.
242 bi[i].min = (60 * bst[i].cap) / valid_rate;
245 total_min += bi[i].min;
247 /* If this battery is not present, don't use its capacity. */
249 total_cap += bi[i].cap;
253 * Return total battery percent and time remaining. If there are
254 * no valid batteries, report values as unknown.
256 if (valid_units > 0) {
258 battinfo->cap = total_cap / valid_units;
259 battinfo->min = total_min;
260 battinfo->state = batt_stat;
261 battinfo->rate = valid_rate;
263 battinfo->cap = bi[dev_idx].cap;
264 battinfo->min = bi[dev_idx].min;
265 battinfo->state = bi[dev_idx].state;
266 battinfo->rate = bst[dev_idx].rate;
270 * If the queried battery has no discharge rate or is charging,
271 * report that we don't know the remaining time.
273 if (valid_rate == 0 || (battinfo->state & ACPI_BATT_STAT_CHARGING))
276 acpi_reset_battinfo(battinfo);
291 acpi_reset_battinfo(struct acpi_battinfo *info)
295 info->state = ACPI_BATT_STAT_NOT_PRESENT;
299 /* Make string printable, removing invalid chars. */
301 acpi_battery_clean_str(char *str, int len)
305 for (i = 0; i < len && *str != '\0'; i++, str++) {
310 /* NUL-terminate the string if we reached the end. */
316 * The battery interface deals with devices and methods but userland
317 * expects a logical unit number. Convert a logical unit to a device_t.
320 acpi_battery_find_dev(u_int logical_unit)
322 int found_unit, i, maxunit;
328 batt_dc = devclass_find("battery");
329 maxunit = devclass_get_maxunit(batt_dc);
330 for (i = 0; i < maxunit; i++) {
331 dev = devclass_get_device(batt_dc, i);
334 if (logical_unit == found_unit)
344 acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg)
346 union acpi_battery_ioctl_arg *ioctl_arg;
350 /* For commands that use the ioctl_arg struct, validate it first. */
355 if (IOCPARM_LEN(cmd) == sizeof(*ioctl_arg)) {
356 ioctl_arg = (union acpi_battery_ioctl_arg *)addr;
357 unit = ioctl_arg->unit;
358 if (unit != ACPI_BATTERY_ALL_UNITS)
359 dev = acpi_battery_find_dev(unit);
363 * No security check required: information retrieval only. If
364 * new functions are added here, a check might be required.
367 case ACPIIO_BATT_GET_UNITS:
368 *(int *)addr = acpi_battery_get_units();
370 case ACPIIO_BATT_GET_BATTINFO:
371 if (dev != NULL || unit == ACPI_BATTERY_ALL_UNITS) {
372 bzero(&ioctl_arg->battinfo, sizeof(ioctl_arg->battinfo));
373 error = acpi_battery_get_battinfo(dev, &ioctl_arg->battinfo);
376 case ACPIIO_BATT_GET_BIF:
378 bzero(&ioctl_arg->bif, sizeof(ioctl_arg->bif));
379 error = ACPI_BATT_GET_INFO(dev, &ioctl_arg->bif);
382 * Remove invalid characters. Perhaps this should be done
383 * within a convenience function so all callers get the
386 acpi_battery_clean_str(ioctl_arg->bif.model,
387 sizeof(ioctl_arg->bif.model));
388 acpi_battery_clean_str(ioctl_arg->bif.serial,
389 sizeof(ioctl_arg->bif.serial));
390 acpi_battery_clean_str(ioctl_arg->bif.type,
391 sizeof(ioctl_arg->bif.type));
392 acpi_battery_clean_str(ioctl_arg->bif.oeminfo,
393 sizeof(ioctl_arg->bif.oeminfo));
396 case ACPIIO_BATT_GET_BST:
398 bzero(&ioctl_arg->bst, sizeof(ioctl_arg->bst));
399 error = ACPI_BATT_GET_STATUS(dev, &ioctl_arg->bst);
410 acpi_battery_sysctl(SYSCTL_HANDLER_ARGS)
414 acpi_battery_get_battinfo(NULL, &acpi_battery_battinfo);
415 val = *(u_int *)oidp->oid_arg1;
416 error = sysctl_handle_int(oidp, &val, 0, req);
421 acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS)
425 count = acpi_battery_get_units();
426 error = sysctl_handle_int(oidp, &count, 0, req);
431 acpi_battery_init(void)
433 struct acpi_softc *sc;
437 ACPI_SERIAL_ASSERT(battery);
440 dev = devclass_get_device(devclass_find("acpi"), 0);
443 sc = device_get_softc(dev);
445 error = acpi_register_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl,
449 error = acpi_register_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl,
453 error = acpi_register_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl, NULL);
456 error = acpi_register_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl, NULL);
460 sysctl_ctx_init(&acpi_battery_sysctl_ctx);
461 acpi_battery_sysctl_tree = SYSCTL_ADD_NODE(&acpi_battery_sysctl_ctx,
462 SYSCTL_CHILDREN(sc->acpi_sysctl_tree), OID_AUTO, "battery", CTLFLAG_RD,
463 0, "battery status and info");
464 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
465 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
466 OID_AUTO, "life", CTLTYPE_INT | CTLFLAG_RD,
467 &acpi_battery_battinfo.cap, 0, acpi_battery_sysctl, "I",
468 "percent capacity remaining");
469 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
470 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
471 OID_AUTO, "time", CTLTYPE_INT | CTLFLAG_RD,
472 &acpi_battery_battinfo.min, 0, acpi_battery_sysctl, "I",
473 "remaining time in minutes");
474 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
475 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
476 OID_AUTO, "state", CTLTYPE_INT | CTLFLAG_RD,
477 &acpi_battery_battinfo.state, 0, acpi_battery_sysctl, "I",
478 "current status flags");
479 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
480 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
481 OID_AUTO, "units", CTLTYPE_INT | CTLFLAG_RD,
482 NULL, 0, acpi_battery_units_sysctl, "I", "number of batteries");
483 SYSCTL_ADD_INT(&acpi_battery_sysctl_ctx,
484 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
485 OID_AUTO, "info_expire", CTLFLAG_RD | CTLFLAG_RW,
486 &acpi_battery_info_expire, 0,
487 "time in seconds until info is refreshed");
489 acpi_batteries_initted = TRUE;
493 acpi_deregister_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl);
494 acpi_deregister_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl);
495 acpi_deregister_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl);
496 acpi_deregister_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl);