1 /*-
2 * Copyright (c) 2005 Nate Lawson
3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
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.
14 *
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
25 * SUCH DAMAGE.
26 */
27
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30
31 #include "opt_acpi.h"
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/malloc.h>
35 #include <sys/bus.h>
36 #include <sys/ioccom.h>
37 #include <sys/sysctl.h>
38
39 #include <contrib/dev/acpica/include/acpi.h>
40
41 #include <dev/acpica/acpivar.h>
42 #include <dev/acpica/acpiio.h>
43
44 /* Default seconds before re-sampling the battery state. */
45 #define ACPI_BATTERY_INFO_EXPIRE 5
46
47 static int acpi_batteries_initialized;
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;
52
53 ACPI_SERIAL_DECL(battery, "ACPI generic battery");
54
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);
62
63 int
64 acpi_battery_register(device_t dev)
65 {
66 int error;
67
68 ACPI_SERIAL_BEGIN(battery);
69 error = acpi_battery_init();
70 ACPI_SERIAL_END(battery);
71
72 return (error);
73 }
74
75 int
76 acpi_battery_remove(device_t dev)
77 {
78
79 return (0);
80 }
81
82 int
83 acpi_battery_get_units(void)
84 {
85 devclass_t batt_dc;
86
87 batt_dc = devclass_find("battery");
88 if (batt_dc == NULL)
89 return (0);
90 return (devclass_get_count(batt_dc));
91 }
92
93 int
94 acpi_battery_get_info_expire(void)
95 {
96
97 return (acpi_battery_info_expire);
98 }
99
100 /* Check _BST results for validity. */
101 int
102 acpi_battery_bst_valid(struct acpi_bst *bst)
103 {
104
105 return (bst->state != ACPI_BATT_STAT_NOT_PRESENT &&
106 bst->cap != ACPI_BATT_UNKNOWN && bst->volt != ACPI_BATT_UNKNOWN);
107 }
108
109 /* Check _BI[FX] results for validity. */
110 int
111 acpi_battery_bix_valid(struct acpi_bix *bix)
112 {
113
114 return (bix->lfcap != 0);
115 }
116
117 /* Get info about one or all batteries. */
118 int
119 acpi_battery_get_battinfo(device_t dev, struct acpi_battinfo *battinfo)
120 {
121 int batt_stat, devcount, dev_idx, error, i;
122 int total_cap, total_lfcap, total_min, valid_rate, valid_units;
123 devclass_t batt_dc;
124 device_t batt_dev;
125 struct acpi_bst *bst;
126 struct acpi_bix *bix;
127 struct acpi_battinfo *bi;
128
129 /*
130 * Get the battery devclass and max unit for battery devices. If there
131 * are none or error, return immediately.
132 */
133 batt_dc = devclass_find("battery");
134 if (batt_dc == NULL)
135 return (ENXIO);
136 devcount = devclass_get_maxunit(batt_dc);
137 if (devcount == 0)
138 return (ENXIO);
139
140 /*
141 * Allocate storage for all _BST data, their derived battinfo data,
142 * and the current battery's _BIX (or _BIF) data.
143 */
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 bix = malloc(sizeof(*bix), M_TEMP, M_WAITOK | M_ZERO);
147
148 /*
149 * Pass 1: for each battery that is present and valid, get its status,
150 * calculate percent capacity remaining, and sum all the current
151 * discharge rates.
152 */
153 dev_idx = -1;
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]);
159
160 /*
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.
163 */
164 batt_dev = devclass_get_device(batt_dc, i);
165 if (batt_dev == NULL)
166 continue;
167
168 /* If examining a specific battery and this is it, record its index. */
169 if (dev != NULL && dev == batt_dev)
170 dev_idx = i;
171
172 /*
173 * Be sure we can get various info from the battery. Note that
174 * acpi_BatteryIsPresent() is not enough because smart batteries only
175 * return that the device is present.
176 */
177 if (!acpi_BatteryIsPresent(batt_dev) ||
178 ACPI_BATT_GET_STATUS(batt_dev, &bst[i]) != 0 ||
179 ACPI_BATT_GET_INFO(batt_dev, bix, sizeof(*bix)) != 0)
180 continue;
181
182 /* If a battery is not installed, we sometimes get strange values. */
183 if (!acpi_battery_bst_valid(&bst[i]) ||
184 !acpi_battery_bix_valid(bix))
185 continue;
186
187 /*
188 * Record current state. If both charging and discharging are set,
189 * ignore the charging flag.
190 */
191 valid_units++;
192 if ((bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
193 bst[i].state &= ~ACPI_BATT_STAT_CHARGING;
194 batt_stat |= bst[i].state;
195 bi[i].state = bst[i].state;
196
197 /*
198 * If the battery info is in terms of mA, convert to mW by
199 * multiplying by the design voltage. If the design voltage
200 * is 0 (due to some error reading the battery), skip this
201 * conversion.
202 */
203 if (bix->units == ACPI_BIX_UNITS_MA && bix->dvol != 0 && dev == NULL) {
204 bst[i].rate = (bst[i].rate * bix->dvol) / 1000;
205 bst[i].cap = (bst[i].cap * bix->dvol) / 1000;
206 bix->lfcap = (bix->lfcap * bix->dvol) / 1000;
207 }
208
209 /*
210 * The calculation above may set bix->lfcap to zero. This was
211 * seen on a laptop with a broken battery. The result of the
212 * division was rounded to zero.
213 */
214 if (!acpi_battery_bix_valid(bix))
215 continue;
216
217 /*
218 * Some laptops report the "design-capacity" instead of the
219 * "real-capacity" when the battery is fully charged. That breaks
220 * the above arithmetic as it needs to be 100% maximum.
221 */
222 if (bst[i].cap > bix->lfcap)
223 bst[i].cap = bix->lfcap;
224
225 /* Calculate percent capacity remaining. */
226 bi[i].cap = (100 * bst[i].cap) / bix->lfcap;
227
228 /* If this battery is not present, don't use its capacity. */
229 if (bi[i].cap != -1) {
230 total_cap += bst[i].cap;
231 total_lfcap += bix->lfcap;
232 }
233
234 /*
235 * On systems with more than one battery, they may get used
236 * sequentially, thus bst.rate may only signify the one currently
237 * in use. For the remaining batteries, bst.rate will be zero,
238 * which makes it impossible to calculate the total remaining time.
239 * Therefore, we sum the bst.rate for batteries in the discharging
240 * state and use the sum to calculate the total remaining time.
241 */
242 if (bst[i].rate != ACPI_BATT_UNKNOWN &&
243 (bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
244 valid_rate += bst[i].rate;
245 }
246
247 /* If the caller asked for a device but we didn't find it, error. */
248 if (dev != NULL && dev_idx == -1) {
249 error = ENXIO;
250 goto out;
251 }
252
253 /* Pass 2: calculate capacity and remaining time for all batteries. */
254 total_min = 0;
255 for (i = 0; i < devcount; i++) {
256 /*
257 * If any batteries are discharging, use the sum of the bst.rate
258 * values. Otherwise, we are on AC power, and there is infinite
259 * time remaining for this battery until we go offline.
260 */
261 if (valid_rate > 0)
262 bi[i].min = (60 * bst[i].cap) / valid_rate;
263 else
264 bi[i].min = 0;
265 total_min += bi[i].min;
266 }
267
268 /*
269 * Return total battery percent and time remaining. If there are
270 * no valid batteries, report values as unknown.
271 */
272 if (valid_units > 0) {
273 if (dev == NULL) {
274 battinfo->cap = (total_cap * 100) / total_lfcap;
275 battinfo->min = total_min;
276 battinfo->state = batt_stat;
277 battinfo->rate = valid_rate;
278 } else {
279 battinfo->cap = bi[dev_idx].cap;
280 battinfo->min = bi[dev_idx].min;
281 battinfo->state = bi[dev_idx].state;
282 battinfo->rate = bst[dev_idx].rate;
283 }
284
285 /*
286 * If the queried battery has no discharge rate or is charging,
287 * report that we don't know the remaining time.
288 */
289 if (valid_rate == 0 || (battinfo->state & ACPI_BATT_STAT_CHARGING))
290 battinfo->min = -1;
291 } else
292 acpi_reset_battinfo(battinfo);
293
294 error = 0;
295
296 out:
297 free(bi, M_TEMP);
298 free(bix, M_TEMP);
299 free(bst, M_TEMP);
300 return (error);
301 }
302
303 static void
304 acpi_reset_battinfo(struct acpi_battinfo *info)
305 {
306 info->cap = -1;
307 info->min = -1;
308 info->state = ACPI_BATT_STAT_NOT_PRESENT;
309 info->rate = -1;
310 }
311
312 /* Make string printable, removing invalid chars. */
313 static void
314 acpi_battery_clean_str(char *str, int len)
315 {
316 int i;
317
318 for (i = 0; i < len && *str != '\0'; i++, str++) {
319 if (!isprint(*str))
320 *str = '?';
321 }
322
323 /* NUL-terminate the string if we reached the end. */
324 if (i == len)
325 *str = '\0';
326 }
327
328 /*
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.
331 */
332 static device_t
333 acpi_battery_find_dev(u_int logical_unit)
334 {
335 int found_unit, i, maxunit;
336 device_t dev;
337 devclass_t batt_dc;
338
339 dev = NULL;
340 found_unit = 0;
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);
345 if (dev == NULL)
346 continue;
347 if (logical_unit == found_unit)
348 break;
349 found_unit++;
350 dev = NULL;
351 }
352
353 return (dev);
354 }
355
356 static int
357 acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg)
358 {
359 union acpi_battery_ioctl_arg *ioctl_arg;
360 int error, unit;
361 device_t dev;
362
363 /* For commands that use the ioctl_arg struct, validate it first. */
364 error = ENXIO;
365 unit = 0;
366 dev = NULL;
367 ioctl_arg = NULL;
368 if (IOCPARM_LEN(cmd) == sizeof(union acpi_battery_ioctl_arg) ||
369 IOCPARM_LEN(cmd) == sizeof(union acpi_battery_ioctl_arg_v1)) {
370 ioctl_arg = (union acpi_battery_ioctl_arg *)addr;
371 unit = ioctl_arg->unit;
372 if (unit != ACPI_BATTERY_ALL_UNITS)
373 dev = acpi_battery_find_dev(unit);
374 }
375
376 /*
377 * No security check required: information retrieval only. If
378 * new functions are added here, a check might be required.
379 */
380 /* Unit check */
381 switch (cmd) {
382 case ACPIIO_BATT_GET_UNITS:
383 *(int *)addr = acpi_battery_get_units();
384 error = 0;
385 break;
386 case ACPIIO_BATT_GET_BATTINFO:
387 case ACPIIO_BATT_GET_BATTINFO_V1:
388 if (dev != NULL || unit == ACPI_BATTERY_ALL_UNITS) {
389 bzero(&ioctl_arg->battinfo, sizeof(ioctl_arg->battinfo));
390 error = acpi_battery_get_battinfo(dev, &ioctl_arg->battinfo);
391 }
392 break;
393 case ACPIIO_BATT_GET_BIF:
394 if (dev != NULL) {
395 bzero(&ioctl_arg->bif, sizeof(ioctl_arg->bif));
396 error = ACPI_BATT_GET_INFO(dev, &ioctl_arg->bif,
397 sizeof(ioctl_arg->bif));
398 }
399 break;
400 case ACPIIO_BATT_GET_BIX:
401 if (dev != NULL) {
402 bzero(&ioctl_arg->bix, sizeof(ioctl_arg->bix));
403 error = ACPI_BATT_GET_INFO(dev, &ioctl_arg->bix,
404 sizeof(ioctl_arg->bix));
405 }
406 break;
407 case ACPIIO_BATT_GET_BST:
408 case ACPIIO_BATT_GET_BST_V1:
409 if (dev != NULL) {
410 bzero(&ioctl_arg->bst, sizeof(ioctl_arg->bst));
411 error = ACPI_BATT_GET_STATUS(dev, &ioctl_arg->bst);
412 }
413 break;
414 default:
415 error = EINVAL;
416 }
417
418 /* Sanitize the string members. */
419 switch (cmd) {
420 case ACPIIO_BATT_GET_BIX:
421 case ACPIIO_BATT_GET_BIF:
422 /*
423 * Remove invalid characters. Perhaps this should be done
424 * within a convenience function so all callers get the
425 * benefit.
426 */
427 acpi_battery_clean_str(ioctl_arg->bix.model,
428 sizeof(ioctl_arg->bix.model));
429 acpi_battery_clean_str(ioctl_arg->bix.serial,
430 sizeof(ioctl_arg->bix.serial));
431 acpi_battery_clean_str(ioctl_arg->bix.type,
432 sizeof(ioctl_arg->bix.type));
433 acpi_battery_clean_str(ioctl_arg->bix.oeminfo,
434 sizeof(ioctl_arg->bix.oeminfo));
435 };
436
437 return (error);
438 }
439
440 static int
441 acpi_battery_sysctl(SYSCTL_HANDLER_ARGS)
442 {
443 int val, error;
444
445 acpi_battery_get_battinfo(NULL, &acpi_battery_battinfo);
446 val = *(u_int *)oidp->oid_arg1;
447 error = sysctl_handle_int(oidp, &val, 0, req);
448 return (error);
449 }
450
451 static int
452 acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS)
453 {
454 int count, error;
455
456 count = acpi_battery_get_units();
457 error = sysctl_handle_int(oidp, &count, 0, req);
458 return (error);
459 }
460
461 static int
462 acpi_battery_init(void)
463 {
464 struct acpi_softc *sc;
465 device_t dev;
466 int error;
467
468 ACPI_SERIAL_ASSERT(battery);
469
470 if (acpi_batteries_initialized)
471 return(0);
472
473 error = ENXIO;
474 dev = devclass_get_device(devclass_find("acpi"), 0);
475 if (dev == NULL)
476 goto out;
477 sc = device_get_softc(dev);
478
479 #define ACPI_REGISTER_IOCTL(a, b, c) do { \
480 error = acpi_register_ioctl(a, b, c); \
481 if (error) \
482 goto out; \
483 } while (0)
484
485 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl, NULL);
486 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl, NULL);
487 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_BATTINFO_V1, acpi_battery_ioctl, NULL);
488 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl, NULL);
489 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_BIX, acpi_battery_ioctl, NULL);
490 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_BST, acpi_battery_ioctl, NULL);
491 ACPI_REGISTER_IOCTL(ACPIIO_BATT_GET_BST_V1, acpi_battery_ioctl, NULL);
492 #undef ACPI_REGISTER_IOCTL
493
494 sysctl_ctx_init(&acpi_battery_sysctl_ctx);
495 acpi_battery_sysctl_tree = SYSCTL_ADD_NODE(&acpi_battery_sysctl_ctx,
496 SYSCTL_CHILDREN(sc->acpi_sysctl_tree), OID_AUTO, "battery", CTLFLAG_RD,
497 0, "battery status and info");
498 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
499 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
500 OID_AUTO, "life", CTLTYPE_INT | CTLFLAG_RD,
501 &acpi_battery_battinfo.cap, 0, acpi_battery_sysctl, "I",
502 "percent capacity remaining");
503 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
504 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
505 OID_AUTO, "time", CTLTYPE_INT | CTLFLAG_RD,
506 &acpi_battery_battinfo.min, 0, acpi_battery_sysctl, "I",
507 "remaining time in minutes");
508 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
509 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
510 OID_AUTO, "rate", CTLTYPE_INT | CTLFLAG_RD,
511 &acpi_battery_battinfo.rate, 0, acpi_battery_sysctl, "I",
512 "present rate in mW");
513 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
514 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
515 OID_AUTO, "state", CTLTYPE_INT | CTLFLAG_RD,
516 &acpi_battery_battinfo.state, 0, acpi_battery_sysctl, "I",
517 "current status flags");
518 SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
519 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
520 OID_AUTO, "units", CTLTYPE_INT | CTLFLAG_RD,
521 NULL, 0, acpi_battery_units_sysctl, "I", "number of batteries");
522 SYSCTL_ADD_INT(&acpi_battery_sysctl_ctx,
523 SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
524 OID_AUTO, "info_expire", CTLFLAG_RW,
525 &acpi_battery_info_expire, 0,
526 "time in seconds until info is refreshed");
527
528 acpi_batteries_initialized = TRUE;
529
530 out:
531 if (error) {
532 acpi_deregister_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl);
533 acpi_deregister_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl);
534 acpi_deregister_ioctl(ACPIIO_BATT_GET_BATTINFO_V1, acpi_battery_ioctl);
535 acpi_deregister_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl);
536 acpi_deregister_ioctl(ACPIIO_BATT_GET_BIX, acpi_battery_ioctl);
537 acpi_deregister_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl);
538 acpi_deregister_ioctl(ACPIIO_BATT_GET_BST_V1, acpi_battery_ioctl);
539 }
540 return (error);
541 }
Cache object: 68b081ade30004daff30d3551c35f7d4
|