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/acpi.h>
  40 #include <dev/acpica/acpivar.h>
  41 #include <dev/acpica/acpiio.h>
  42
  43 /* Default seconds before re-sampling the battery state. */
  44 #define ACPI_BATTERY_INFO_EXPIRE        5
  45
  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;
  51
  52 ACPI_SERIAL_DECL(battery, "ACPI generic battery");
  53
  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);
  61
  62 int
  63 acpi_battery_register(device_t dev)
  64 {
  65     int error;
  66
  67     error = 0;
  68     ACPI_SERIAL_BEGIN(battery);
  69     if (!acpi_batteries_initted)
  70         error = acpi_battery_init();
  71     ACPI_SERIAL_END(battery);
  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     return (bst->state < ACPI_BATT_STAT_MAX && bst->cap != ACPI_BATT_UNKNOWN &&
 105         bst->volt != ACPI_BATT_UNKNOWN);
 106 }
 107
 108 /* Check _BIF results for validity. */
 109 int
 110 acpi_battery_bif_valid(struct acpi_bif *bif)
 111 {
 112     return (bif->lfcap != 0);
 113 }
 114
 115 /* Get info about one or all batteries. */
 116 int
 117 acpi_battery_get_battinfo(device_t dev, struct acpi_battinfo *battinfo)
 118 {
 119     int batt_stat, devcount, dev_idx, error, i;
 120     int total_cap, total_min, valid_rate, valid_units;
 121     devclass_t batt_dc;
 122     device_t batt_dev;
 123     struct acpi_bst *bst;
 124     struct acpi_bif *bif;
 125     struct acpi_battinfo *bi;
 126
 127     /*
 128      * Get the battery devclass and max unit for battery devices.  If there
 129      * are none or error, return immediately.
 130      */
 131     batt_dc = devclass_find("battery");
 132     if (batt_dc == NULL)
 133         return (ENXIO);
 134     devcount = devclass_get_maxunit(batt_dc);
 135     if (devcount == 0)
 136         return (ENXIO);
 137
 138     /*
 139      * Allocate storage for all _BST data, their derived battinfo data,
 140      * and the current battery's _BIF data.
 141      */
 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);
 145
 146     /*
 147      * Pass 1:  for each battery that is present and valid, get its status,
 148      * calculate percent capacity remaining, and sum all the current
 149      * discharge rates.
 150      */
 151     dev_idx = -1;
 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]);
 156
 157         /*
 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.
 160          */
 161         batt_dev = devclass_get_device(batt_dc, i);
 162         if (batt_dev == NULL)
 163             continue;
 164
 165         /* If examining a specific battery and this is it, record its index. */
 166         if (dev != NULL && dev == batt_dev)
 167             dev_idx = i;
 168
 169         /*
 170          * Be sure we can get various info from the battery.  Note that
 171          * acpi_BatteryIsPresent() is not enough because smart batteries only
 172          * return that the device is present.
 173          */
 174         if (!acpi_BatteryIsPresent(batt_dev) ||
 175             ACPI_BATT_GET_STATUS(batt_dev, &bst[i]) != 0 ||
 176             ACPI_BATT_GET_INFO(batt_dev, bif) != 0)
 177             continue;
 178
 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))
 182             continue;
 183
 184         /*
 185          * Record current state.  If both charging and discharging are set,
 186          * ignore the charging flag.
 187          */
 188         valid_units++;
 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;
 193
 194         /*
 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
 198          * conversion.
 199          */
 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;
 204         }
 205
 206         /* Calculate percent capacity remaining. */
 207         bi[i].cap = (100 * bst[i].cap) / bif->lfcap;
 208
 209         /*
 210          * Some laptops report the "design-capacity" instead of the
 211          * "real-capacity" when the battery is fully charged.  That breaks
 212          * the above arithmetic as it needs to be 100% maximum.
 213          */
 214         if (bi[i].cap > 100)
 215             bi[i].cap = 100;
 216
 217         /*
 218          * On systems with more than one battery, they may get used
 219          * sequentially, thus bst.rate may only signify the one currently
 220          * in use.  For the remaining batteries, bst.rate will be zero,
 221          * which makes it impossible to calculate the total remaining time.
 222          * Therefore, we sum the bst.rate for batteries in the discharging
 223          * state and use the sum to calculate the total remaining time.
 224          */
 225         if (bst[i].rate != ACPI_BATT_UNKNOWN &&
 226             (bst[i].state & ACPI_BATT_STAT_DISCHARG) != 0)
 227             valid_rate += bst[i].rate;
 228     }
 229
 230     /* If the caller asked for a device but we didn't find it, error. */
 231     if (dev != NULL && dev_idx == -1) {
 232         error = ENXIO;
 233         goto out;
 234     }
 235
 236     /* Pass 2:  calculate capacity and remaining time for all batteries. */
 237     total_cap = total_min = 0;
 238     for (i = 0; i < devcount; i++) {
 239         /*
 240          * If any batteries are discharging, use the sum of the bst.rate
 241          * values.  Otherwise, we are on AC power, and there is infinite
 242          * time remaining for this battery until we go offline.
 243          */
 244         if (valid_rate > 0)
 245             bi[i].min = (60 * bst[i].cap) / valid_rate;
 246         else
 247             bi[i].min = 0;
 248         total_min += bi[i].min;
 249
 250         /* If this battery is not present, don't use its capacity. */
 251         if (bi[i].cap != -1)
 252             total_cap += bi[i].cap;
 253     }
 254
 255     /*
 256      * Return total battery percent and time remaining.  If there are
 257      * no valid batteries, report values as unknown.
 258      */
 259     if (valid_units > 0) {
 260         if (dev == NULL) {
 261             battinfo->cap = total_cap / valid_units;
 262             battinfo->min = total_min;
 263             battinfo->state = batt_stat;
 264             battinfo->rate = valid_rate;
 265         } else {
 266             battinfo->cap = bi[dev_idx].cap;
 267             battinfo->min = bi[dev_idx].min;
 268             battinfo->state = bi[dev_idx].state;
 269             battinfo->rate = bst[dev_idx].rate;
 270         }
 271
 272         /*
 273          * If the queried battery has no discharge rate or is charging,
 274          * report that we don't know the remaining time.
 275          */
 276         if (valid_rate == 0 || (battinfo->state & ACPI_BATT_STAT_CHARGING))
 277             battinfo->min = -1;
 278     } else
 279         acpi_reset_battinfo(battinfo);
 280
 281     error = 0;
 282
 283 out:
 284     if (bi)
 285         free(bi, M_TEMP);
 286     if (bif)
 287         free(bif, M_TEMP);
 288     if (bst)
 289         free(bst, M_TEMP);
 290     return (error);
 291 }
 292
 293 static void
 294 acpi_reset_battinfo(struct acpi_battinfo *info)
 295 {
 296     info->cap = -1;
 297     info->min = -1;
 298     info->state = ACPI_BATT_STAT_NOT_PRESENT;
 299     info->rate = -1;
 300 }
 301
 302 /* Make string printable, removing invalid chars. */
 303 static void
 304 acpi_battery_clean_str(char *str, int len)
 305 {
 306     int i;
 307
 308     for (i = 0; i < len && *str != '\0'; i++, str++) {
 309         if (!isprint(*str))
 310             *str = '?';
 311     }
 312
 313     /* NUL-terminate the string if we reached the end. */
 314     if (i == len)
 315         *str = '\0';
 316 }
 317
 318 /*
 319  * The battery interface deals with devices and methods but userland
 320  * expects a logical unit number.  Convert a logical unit to a device_t.
 321  */
 322 static device_t
 323 acpi_battery_find_dev(u_int logical_unit)
 324 {
 325     int found_unit, i, maxunit;
 326     device_t dev;
 327     devclass_t batt_dc;
 328
 329     dev = NULL;
 330     found_unit = 0;
 331     batt_dc = devclass_find("battery");
 332     maxunit = devclass_get_maxunit(batt_dc);
 333     for (i = 0; i < maxunit; i++) {
 334         dev = devclass_get_device(batt_dc, i);
 335         if (dev == NULL)
 336             continue;
 337         if (logical_unit == found_unit)
 338             break;
 339         found_unit++;
 340         dev = NULL;
 341     }
 342
 343     return (dev);
 344 }
 345
 346 static int
 347 acpi_battery_ioctl(u_long cmd, caddr_t addr, void *arg)
 348 {
 349     union acpi_battery_ioctl_arg *ioctl_arg;
 350     int error, unit;
 351     device_t dev;
 352
 353     /* For commands that use the ioctl_arg struct, validate it first. */
 354     error = ENXIO;
 355     unit = 0;
 356     dev = NULL;
 357     ioctl_arg = NULL;
 358     if (IOCPARM_LEN(cmd) == sizeof(*ioctl_arg)) {
 359         ioctl_arg = (union acpi_battery_ioctl_arg *)addr;
 360         unit = ioctl_arg->unit;
 361         if (unit != ACPI_BATTERY_ALL_UNITS)
 362             dev = acpi_battery_find_dev(unit);
 363     }
 364
 365     /*
 366      * No security check required: information retrieval only.  If
 367      * new functions are added here, a check might be required.
 368      */
 369     switch (cmd) {
 370     case ACPIIO_BATT_GET_UNITS:
 371         *(int *)addr = acpi_battery_get_units();
 372         error = 0;
 373         break;
 374     case ACPIIO_BATT_GET_BATTINFO:
 375         if (dev != NULL || unit == ACPI_BATTERY_ALL_UNITS) {
 376             bzero(&ioctl_arg->battinfo, sizeof(ioctl_arg->battinfo));
 377             error = acpi_battery_get_battinfo(dev, &ioctl_arg->battinfo);
 378         }
 379         break;
 380     case ACPIIO_BATT_GET_BIF:
 381         if (dev != NULL) {
 382             bzero(&ioctl_arg->bif, sizeof(ioctl_arg->bif));
 383             error = ACPI_BATT_GET_INFO(dev, &ioctl_arg->bif);
 384
 385             /*
 386              * Remove invalid characters.  Perhaps this should be done
 387              * within a convenience function so all callers get the
 388              * benefit.
 389              */
 390             acpi_battery_clean_str(ioctl_arg->bif.model,
 391                 sizeof(ioctl_arg->bif.model));
 392             acpi_battery_clean_str(ioctl_arg->bif.serial,
 393                 sizeof(ioctl_arg->bif.serial));
 394             acpi_battery_clean_str(ioctl_arg->bif.type,
 395                 sizeof(ioctl_arg->bif.type));
 396             acpi_battery_clean_str(ioctl_arg->bif.oeminfo,
 397                 sizeof(ioctl_arg->bif.oeminfo));
 398         }
 399         break;
 400     case ACPIIO_BATT_GET_BST:
 401         if (dev != NULL) {
 402             bzero(&ioctl_arg->bst, sizeof(ioctl_arg->bst));
 403             error = ACPI_BATT_GET_STATUS(dev, &ioctl_arg->bst);
 404         }
 405         break;
 406     default:
 407         error = EINVAL;
 408     }
 409
 410     return (error);
 411 }
 412
 413 static int
 414 acpi_battery_sysctl(SYSCTL_HANDLER_ARGS)
 415 {
 416     int val, error;
 417
 418     acpi_battery_get_battinfo(NULL, &acpi_battery_battinfo);
 419     val = *(u_int *)oidp->oid_arg1;
 420     error = sysctl_handle_int(oidp, &val, 0, req);
 421     return (error);
 422 }
 423
 424 static int
 425 acpi_battery_units_sysctl(SYSCTL_HANDLER_ARGS)
 426 {
 427     int count, error;
 428
 429     count = acpi_battery_get_units();
 430     error = sysctl_handle_int(oidp, &count, 0, req);
 431     return (error);
 432 }
 433
 434 static int
 435 acpi_battery_init(void)
 436 {
 437     struct acpi_softc   *sc;
 438     device_t             dev;
 439     int                  error;
 440
 441     ACPI_SERIAL_ASSERT(battery);
 442
 443     error = ENXIO;
 444     dev = devclass_get_device(devclass_find("acpi"), 0);
 445     if (dev == NULL)
 446         goto out;
 447     sc = device_get_softc(dev);
 448
 449     error = acpi_register_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl,
 450         NULL);
 451     if (error != 0)
 452         goto out;
 453     error = acpi_register_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl,
 454         NULL);
 455     if (error != 0)
 456         goto out;
 457     error = acpi_register_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl, NULL);
 458     if (error != 0)
 459         goto out;
 460     error = acpi_register_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl, NULL);
 461     if (error != 0)
 462         goto out;
 463
 464     sysctl_ctx_init(&acpi_battery_sysctl_ctx);
 465     acpi_battery_sysctl_tree = SYSCTL_ADD_NODE(&acpi_battery_sysctl_ctx,
 466         SYSCTL_CHILDREN(sc->acpi_sysctl_tree), OID_AUTO, "battery", CTLFLAG_RD,
 467         0, "battery status and info");
 468     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 469         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 470         OID_AUTO, "life", CTLTYPE_INT | CTLFLAG_RD,
 471         &acpi_battery_battinfo.cap, 0, acpi_battery_sysctl, "I",
 472         "percent capacity remaining");
 473     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 474         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 475         OID_AUTO, "time", CTLTYPE_INT | CTLFLAG_RD,
 476         &acpi_battery_battinfo.min, 0, acpi_battery_sysctl, "I",
 477         "remaining time in minutes");
 478     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 479         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 480         OID_AUTO, "state", CTLTYPE_INT | CTLFLAG_RD,
 481         &acpi_battery_battinfo.state, 0, acpi_battery_sysctl, "I",
 482         "current status flags");
 483     SYSCTL_ADD_PROC(&acpi_battery_sysctl_ctx,
 484         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 485         OID_AUTO, "units", CTLTYPE_INT | CTLFLAG_RD,
 486         NULL, 0, acpi_battery_units_sysctl, "I", "number of batteries");
 487     SYSCTL_ADD_INT(&acpi_battery_sysctl_ctx,
 488         SYSCTL_CHILDREN(acpi_battery_sysctl_tree),
 489         OID_AUTO, "info_expire", CTLFLAG_RW,
 490         &acpi_battery_info_expire, 0,
 491         "time in seconds until info is refreshed");
 492
 493     acpi_batteries_initted = TRUE;
 494
 495 out:
 496     if (error != 0) {
 497         acpi_deregister_ioctl(ACPIIO_BATT_GET_UNITS, acpi_battery_ioctl);
 498         acpi_deregister_ioctl(ACPIIO_BATT_GET_BATTINFO, acpi_battery_ioctl);
 499         acpi_deregister_ioctl(ACPIIO_BATT_GET_BIF, acpi_battery_ioctl);
 500         acpi_deregister_ioctl(ACPIIO_BATT_GET_BST, acpi_battery_ioctl);
 501     }
 502     return (error);
 503 }