sys/dev/acpica/acpi_battery.c

   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_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;
  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     error = 0;
  69     ACPI_SERIAL_BEGIN(battery);
  70     if (!acpi_batteries_initted)
  71         error = acpi_battery_init();
  72     ACPI_SERIAL_END(battery);
  73     return (error);
  74 }
  75
  76 int
  77 acpi_battery_remove(device_t dev)
  78 {
  79
  80     return (0);
  81 }
  82
  83 int
  84 acpi_battery_get_units(void)
  85 {
  86     devclass_t batt_dc;
  87
  88     batt_dc = devclass_find("battery");
  89     if (batt_dc == NULL)
  90         return (0);
  91     return (devclass_get_count(batt_dc));
  92 }
  93
  94 int
  95 acpi_battery_get_info_expire(void)
  96 {
  97
  98     return (acpi_battery_info_expire);
  99 }
 100
 101 /* Check _BST results for validity. */
 102 int
 103 acpi_battery_bst_valid(struct acpi_bst *bst)
 104 {
 105
 106     return (bst->state != ACPI_BATT_STAT_NOT_PRESENT &&
 107         bst->cap != ACPI_BATT_UNKNOWN && bst->volt != ACPI_BATT_UNKNOWN);
 108 }
 109
 110 /* Check _BIF results for validity. */
 111 int
 112 acpi_battery_bif_valid(struct acpi_bif *bif)
 113 {
 114     return (bif->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_min, valid_rate, valid_units;
 123     devclass_t batt_dc;
 124     device_t batt_dev;
 125     struct acpi_bst *bst;
 126     struct acpi_bif *bif;
 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 _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     bif = malloc(sizeof(*bif), 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     for (i = 0; i < devcount; i++) {
 156         /* Default info for every battery is "not present". */
 157         acpi_reset_battinfo(&bi[i]);
 158
 159         /*
 160          * Find the device.  Since devcount is in terms of max units, this
 161          * may be a sparse array so skip devices that aren't present.
 162          */
 163         batt_dev = devclass_get_device(batt_dc, i);
 164         if (batt_dev == NULL)
 165             continue;
 166
 167         /* If examining a specific battery and this is it, record its index. */
 168         if (dev != NULL && dev == batt_dev)
 169             dev_idx = i;
 170
 171         /*
 172          * Be sure we can get various info from the battery.
 173          */
 174         if (ACPI_BATT_GET_STATUS(batt_dev, &bst[i]) != 0 ||
 175             ACPI_BATT_GET_INFO(batt_dev, bif) != 0)
 176                 continue;
 177
 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))
 181             continue;
 182
 183         /*
 184          * Record current state.  If both charging and discharging are set,
 185          * ignore the charging flag.
 186          */
 187         valid_units++;
 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;
 192
 193         /*
 194          * If the battery info is in terms of mA, convert to mW by
 195          * multiplying by the design voltage.  If the design voltage
 196          * is 0 (due to some error reading the battery), skip this
 197          * conversion.
 198          */
 199         if (bif->units == ACPI_BIF_UNITS_MA && bif->dvol != 0 && dev == NULL) {
 200             bst[i].rate = (bst[i].rate * bif->dvol) / 1000;
 201             bst[i].cap = (bst[i].cap * bif->dvol) / 1000;
 202             bif->lfcap = (bif->lfcap * bif->dvol) / 1000;
 203         }
 204
 205         /*
 206          * The calculation above may set bif->lfcap to zero. This was
 207          * seen on a laptop with a broken battery. The result of the
 208          * division was rounded to zero.
 209          */
 210         if (!acpi_battery_bif_valid(bif))
 211             continue;
 212
 213         /* Calculate percent capacity remaining. */
 214         bi[i].cap = (100 * bst[i].cap) / bif->lfcap;
 215
 216         /*
 217          * Some laptops report the "design-capacity" instead of the
 218          * "real-capacity" when the battery is fully charged.  That breaks
 219          * the above arithmetic as it needs to be 100% maximum.
 220          */
 221         if (bi[i].cap > 100)
 222             bi[i].cap = 100;
 223
 224         /*
 225          * On systems with more than one battery, they may get used
 226          * sequentially, thus bst.rate may only signify the one currently
 227          * in use.  For the remaining batteries, bst.rate will be zero,
 228          * which makes it impossible to calculate the total remaining time.
 229          * Therefore, we sum the bst.rate for batteries in the discharging
 230          * state and use the sum to calculate the total remaining time.
 231          */
 232         if (bst[i].rate != ACPI_BATT_UNKNOWN &&
 233             (bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
 234             valid_rate += bst[i].rate;
 235     }
 236
 237     /* If the caller asked for a device but we didn't find it, error. */
 238     if (dev != NULL && dev_idx == -1) {
 239         error = ENXIO;
 240         goto out;
 241     }
 242
 243     /* Pass 2:  calculate capacity and remaining time for all batteries. */
 244     total_cap = total_min = 0;
 245     for (i = 0; i < devcount; i++) {
 246         /*
 247          * If any batteries are discharging, use the sum of the bst.rate
 248          * values.  Otherwise, we are on AC power, and there is infinite
 249          * time remaining for this battery until we go offline.
 250          */
 251         if (valid_rate > 0)
 252             bi[i].min = (60 * bst[i].cap) / valid_rate;
 253         else
 254             bi[i].min = 0;
 255         total_min += bi[i].min;
 256
 257         /* If this battery is not present, don't use its capacity. */
 258         if (bi[i].cap != -1)
 259             total_cap += bi[i].cap;
 260     }
 261
 262     /*
 263      * Return total battery percent and time remaining.  If there are
 264      * no valid batteries, report values as unknown.
 265      */
 266     if (valid_units > 0) {
 267         if (dev == NULL) {
 268             battinfo->cap = total_cap / valid_units;
 269             battinfo->min = total_min;
 270             battinfo->state = batt_stat;
 271             battinfo->rate = valid_rate;
 272         } else {
 273             battinfo->cap = bi[dev_idx].cap;
 274             battinfo->min = bi[dev_idx].min;
 275             battinfo->state = bi[dev_idx].state;
 276             battinfo->rate = bst[dev_idx].rate;
 277         }
 278
 279         /*
 280          * If the queried battery has no discharge rate or is charging,
 281          * report that we don't know the remaining time.
 282          */
 283         if (valid_rate == 0 || (battinfo->state & ACPI_BATT_STAT_CHARGING))
 284             battinfo->min = -1;
 285     } else
 286         acpi_reset_battinfo(battinfo);
 287
 288     error = 0;
 289
 290 out:
 291     if (bi)
 292         free(bi, M_TEMP);
 293     if (bif)
 294         free(bif, M_TEMP);
 295     if (bst)
 296         free(bst, M_TEMP);
 297     return (error);
 298 }
 299
 300 static void
 301 acpi_reset_battinfo(struct acpi_battinfo *info)
 302 {
 303     info->cap = -1;
 304     info->min = -1;
 305     info->state = ACPI_BATT_STAT_NOT_PRESENT;
 306     info->rate = -1;
 307 }
 308
 309 /* Make string printable, removing invalid chars. */
 310 static void
 311 acpi_battery_clean_str(char *str, int len)
 312 {
 313     int i;
 314
 315     for (i = 0; i < len && *str != '\0'; i++, str++) {
 316         if (!isprint(*str))
 317             *str = '?';
 318     }
 319
 320     /* NUL-terminate the string if we reached the end. */
 321     if (i == len)
 322         *str = '\0';
 323 }
 324
 325 /*
 326  * The battery interface deals with devices and methods but userland
 327  * expects a logical unit number.  Convert a logical unit to a device_t.
 328  */
 329 static device_t
 330 acpi_battery_find_dev(u_int logical_unit)
 331 {
 332     int found_unit, i, maxunit;
 333     device_t dev;
 334     devclass_t batt_dc;
 335
 336     dev = NULL;
 337     found_unit = 0;
 338     batt_dc = devclass_find("battery");
 339     maxunit = devclass_get_maxunit(batt_dc);
 340     for (i = 0; i < maxunit; i++) {
 341         dev = devclass_get_device(batt_dc, i);
 342         if (dev == NULL)
 343             continue;
 344         if (logical_unit == found_unit)
 345             break;
 346         found_unit++;
 347         dev = NULL;
 348     }
 349
 350     return (dev);
 351 }
 352
 353 static int
 354 acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg)
 355 {
 356     union acpi_battery_ioctl_arg *ioctl_arg;
 357     int error, unit;
 358     device_t dev;
 359
 360     /* For commands that use the ioctl_arg struct, validate it first. */
 361     error = ENXIO;
 362     unit = 0;
 363     dev = NULL;
 364     ioctl_arg = NULL;
 365     if (IOCPARM_LEN(cmd) == sizeof(*ioctl_arg)) {
 366         ioctl_arg = (union acpi_battery_ioctl_arg *)addr;
 367         unit = ioctl_arg->unit;
 368         if (unit != ACPI_BATTERY_ALL_UNITS)
 369             dev = acpi_battery_find_dev(unit);
 370     }
 371
 372     /*
 373      * No security check required: information retrieval only.  If
 374      * new functions are added here, a check might be required.
 375      */
 376     switch (cmd) {
 377     case ACPIIO_BATT_GET_UNITS:
 378         *(int *)addr = acpi_battery_get_units();
 379         error = 0;
 380         break;
 381     case ACPIIO_BATT_GET_BATTINFO:
 382         if (dev != NULL || unit == ACPI_BATTERY_ALL_UNITS) {
 383             bzero(&ioctl_arg->battinfo, sizeof(ioctl_arg->battinfo));
 384             error = acpi_battery_get_battinfo(dev, &ioctl_arg->battinfo);
 385         }
 386         break;
 387     case ACPIIO_BATT_GET_BIF:
 388         if (dev != NULL) {
 389             bzero(&ioctl_arg->bif, sizeof(ioctl_arg->bif));
 390             error = ACPI_BATT_GET_INFO(dev, &ioctl_arg->bif);
 391
 392             /*
 393              * Remove invalid characters.  Perhaps this should be done
 394              * within a convenience function so all callers get the
 395              * benefit.
 396              */
 397             acpi_battery_clean_str(ioctl_arg->bif.model,
 398                 sizeof(ioctl_arg->bif.model));
 399             acpi_battery_clean_str(ioctl_arg->bif.serial,
 400                 sizeof(ioctl_arg->bif.serial));
 401             acpi_battery_clean_str(ioctl_arg->bif.type,
 402                 sizeof(ioctl_arg->bif.type));
 403             acpi_battery_clean_str(ioctl_arg->bif.oeminfo,
 404                 sizeof(ioctl_arg->bif.oeminfo));
 405         }
 406         break;
 407     case ACPIIO_BATT_GET_BST:
 408         if (dev != NULL) {
 409             bzero(&ioctl_arg->bst, sizeof(ioctl_arg->bst));
 410             error = ACPI_BATT_GET_STATUS(dev, &ioctl_arg->bst);
 411         }
 412         break;
 413     default:
 414         error = EINVAL;
 415     }
 416
 417     return (error);
 418 }
 419
 420 static int
 421 acpi_battery_sysctl(SYSCTL_HANDLER_ARGS)
 422 {
 423     int val, error;
 424
 425     acpi_battery_get_battinfo(NULL, &acpi_battery_battinfo);
 426     val = *(u_int *)oidp->oid_arg1;
 427     error = sysctl_handle_int(oidp, &val, 0, req);
 428     return (error);
 429 }
 430
 431 static int
 432 acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS)
 433 {
 434     int count, error;
 435
 436     count = acpi_battery_get_units();
 437     error = sysctl_handle_int(oidp, &count, 0, req);
 438     return (error);
 439 }
 440
 441 static int
 442 acpi_battery_init(void)
 443 {
 444     struct acpi_softc   *sc;
 445     device_t             dev;
 446     int                  error;
 447
 448     ACPI_SERIAL_ASSERT(battery);
 449
 450     error = ENXIO;
 451     dev = devclass_get_device(devclass_find("acpi"), 0);
 452     if (dev == NULL)
 453         goto out;
 454     sc = device_get_softc(dev);
 455
 456     error = acpi_register_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl,
 457         NULL);
 458     if (error != 0)
 459         goto out;
 460     error = acpi_register_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl,
 461         NULL);
 462     if (error != 0)
 463         goto out;
 464     error = acpi_register_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl, NULL);
 465     if (error != 0)
 466         goto out;
 467     error = acpi_register_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl, NULL);
 468     if (error != 0)
 469         goto out;
 470
 471     sysctl_ctx_init(&acpi_battery_sysctl_ctx);
 472     acpi_battery_sysctl_tree = SYSCTL_ADD_NODE(&acpi_battery_sysctl_ctx,
 473         SYSCTL_CHILDREN(sc->acpi_sysctl_tree), OID_AUTO, "battery", CTLFLAG_RD,
 474         0, "battery status and info");
 475     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 476         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 477         OID_AUTO, "life", CTLTYPE_INT | CTLFLAG_RD,
 478         &acpi_battery_battinfo.cap, 0, acpi_battery_sysctl, "I",
 479         "percent capacity remaining");
 480     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 481         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 482         OID_AUTO, "time", CTLTYPE_INT | CTLFLAG_RD,
 483         &acpi_battery_battinfo.min, 0, acpi_battery_sysctl, "I",
 484         "remaining time in minutes");
 485     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 486         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 487         OID_AUTO, "rate", CTLTYPE_INT | CTLFLAG_RD,
 488         &acpi_battery_battinfo.rate, 0, acpi_battery_sysctl, "I",
 489         "present rate in mW");
 490     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 491         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 492         OID_AUTO, "state", CTLTYPE_INT | CTLFLAG_RD,
 493         &acpi_battery_battinfo.state, 0, acpi_battery_sysctl, "I",
 494         "current status flags");
 495     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 496         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 497         OID_AUTO, "units", CTLTYPE_INT | CTLFLAG_RD,
 498         NULL, 0, acpi_battery_units_sysctl, "I", "number of batteries");
 499     SYSCTL_ADD_INT(&acpi_battery_sysctl_ctx,
 500         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 501         OID_AUTO, "info_expire", CTLFLAG_RW,
 502         &acpi_battery_info_expire, 0,
 503         "time in seconds until info is refreshed");
 504
 505     acpi_batteries_initted = TRUE;
 506
 507 out:
 508     if (error != 0) {
 509         acpi_deregister_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl);
 510         acpi_deregister_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl);
 511         acpi_deregister_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl);
 512         acpi_deregister_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl);
 513     }
 514     return (error);
 515 }