sys/dev/acpica/acpi_cmbat.c

   1 /*-
   2  * Copyright (c) 2005 Nate Lawson
   3  * Copyright (c) 2000 Munehiro Matsuda
   4  * Copyright (c) 2000 Takanori Watanabe
   5  * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: head/sys/dev/acpica/acpi_cmbat.c 246128 2013-01-30 18:01:20Z sbz $
  30  */
  31
  32 #include "opt_acpi.h"
  33 #include <sys/param.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/bus.h>
  37
  38 #include <sys/rman.h>
  39
  40 #include "acpi.h"
  41 #include <dev/acpica/acpivar.h>
  42 #include <dev/acpica/acpiio.h>
  43
  44 /* Number of times to retry initialization before giving up. */
  45 #define ACPI_CMBAT_RETRY_MAX    6
  46
  47 /* Check the battery once a minute. */
  48 #define CMBAT_POLLRATE          (60 * hz)
  49
  50 /* Hooks for the ACPICA debugging infrastructure */
  51 #define _COMPONENT      ACPI_BATTERY
  52 ACPI_MODULE_NAME("BATTERY")
  53
  54 #define ACPI_BATTERY_BST_CHANGE 0x80
  55 #define ACPI_BATTERY_BIF_CHANGE 0x81
  56
  57 struct acpi_cmbat_softc {
  58     device_t        dev;
  59     int             flags;
  60     int             bix_present;
  61
  62     struct acpi_bif bif;
  63     struct acpi_bst bst;
  64     struct timespec bst_lastupdated;
  65 };
  66
  67 ACPI_SERIAL_DECL(cmbat, "ACPI cmbat");
  68
  69 static int              acpi_cmbat_probe(device_t dev);
  70 static int              acpi_cmbat_attach(device_t dev);
  71 static int              acpi_cmbat_detach(device_t dev);
  72 static int              acpi_cmbat_resume(device_t dev);
  73 static void             acpi_cmbat_notify_handler(ACPI_HANDLE h, UINT32 notify,
  74                             void *context);
  75 static int              acpi_cmbat_info_expired(struct timespec *lastupdated);
  76 static void             acpi_cmbat_info_updated(struct timespec *lastupdated);
  77 static void             acpi_cmbat_get_bst(void *arg);
  78 static void             acpi_cmbat_get_bif_task(void *arg);
  79 static void             acpi_cmbat_get_bif(void *arg);
  80 static int              acpi_cmbat_bst(device_t dev, struct acpi_bst *bstp);
  81 static int              acpi_cmbat_bif(device_t dev, struct acpi_bif *bifp);
  82 static void             acpi_cmbat_init_battery(void *arg);
  83
  84 static device_method_t acpi_cmbat_methods[] = {
  85     /* Device interface */
  86     DEVMETHOD(device_probe,     acpi_cmbat_probe),
  87     DEVMETHOD(device_attach,    acpi_cmbat_attach),
  88     DEVMETHOD(device_detach,    acpi_cmbat_detach),
  89     DEVMETHOD(device_resume,    acpi_cmbat_resume),
  90
  91     /* ACPI battery interface */
  92     DEVMETHOD(acpi_batt_get_info, acpi_cmbat_bif),
  93     DEVMETHOD(acpi_batt_get_status, acpi_cmbat_bst),
  94
  95     DEVMETHOD_END
  96 };
  97
  98 static driver_t acpi_cmbat_driver = {
  99     "battery",
 100     acpi_cmbat_methods,
 101     sizeof(struct acpi_cmbat_softc),
 102 };
 103
 104 static devclass_t acpi_cmbat_devclass;
 105 DRIVER_MODULE(acpi_cmbat, acpi, acpi_cmbat_driver, acpi_cmbat_devclass, NULL, NULL);
 106 MODULE_DEPEND(acpi_cmbat, acpi, 1, 1, 1);
 107
 108 static int
 109 acpi_cmbat_probe(device_t dev)
 110 {
 111     static char *cmbat_ids[] = { "PNP0C0A", NULL };
 112
 113     if (acpi_disabled("cmbat") ||
 114         ACPI_ID_PROBE(device_get_parent(dev), dev, cmbat_ids) == NULL)
 115         return (ENXIO);
 116
 117     device_set_desc(dev, "ACPI Control Method Battery");
 118     return (0);
 119 }
 120
 121 static int
 122 acpi_cmbat_attach(device_t dev)
 123 {
 124     int         error;
 125     ACPI_HANDLE handle, h;
 126     struct acpi_cmbat_softc *sc;
 127
 128     sc = device_get_softc(dev);
 129     handle = acpi_get_handle(dev);
 130     sc->dev = dev;
 131
 132     ACPI_SERIAL_INIT(cmbat);
 133
 134     timespecclear(&sc->bst_lastupdated);
 135
 136     sc->bix_present = ACPI_SUCCESS(AcpiGetHandle(handle, "_BIX", &h));
 137     if (sc->bix_present)
 138         device_printf(dev, "supports extended information\n");
 139
 140     error = acpi_battery_register(dev);
 141     if (error != 0) {
 142         device_printf(dev, "registering battery failed\n");
 143         return (error);
 144     }
 145
 146     /*
 147      * Install a system notify handler in addition to the device notify.
 148      * Toshiba notebook uses this alternate notify for its battery.
 149      */
 150     AcpiInstallNotifyHandler(handle, ACPI_ALL_NOTIFY,
 151         acpi_cmbat_notify_handler, dev);
 152
 153     AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cmbat_init_battery, dev);
 154
 155     return (0);
 156 }
 157
 158 static int
 159 acpi_cmbat_detach(device_t dev)
 160 {
 161     ACPI_HANDLE handle;
 162
 163     handle = acpi_get_handle(dev);
 164     AcpiRemoveNotifyHandler(handle, ACPI_ALL_NOTIFY, acpi_cmbat_notify_handler);
 165     acpi_battery_remove(dev);
 166     return (0);
 167 }
 168
 169 static int
 170 acpi_cmbat_resume(device_t dev)
 171 {
 172
 173     AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cmbat_init_battery, dev);
 174     return (0);
 175 }
 176
 177 static void
 178 acpi_cmbat_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
 179 {
 180     struct acpi_cmbat_softc *sc;
 181     device_t dev;
 182
 183     dev = (device_t)context;
 184     sc = device_get_softc(dev);
 185
 186     switch (notify) {
 187     case ACPI_NOTIFY_DEVICE_CHECK:
 188     case ACPI_BATTERY_BST_CHANGE:
 189         /*
 190          * Clear the last updated time.  The next call to retrieve the
 191          * battery status will get the new value for us.
 192          */
 193         timespecclear(&sc->bst_lastupdated);
 194         break;
 195     case ACPI_NOTIFY_BUS_CHECK:
 196     case ACPI_BATTERY_BIF_CHANGE:
 197         /*
 198          * Queue a callback to get the current battery info from thread
 199          * context.  It's not safe to block in a notify handler.
 200          */
 201         AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cmbat_get_bif_task, dev);
 202         break;
 203     default:
 204         device_printf(sc->dev, "unknown notify: %#x\n", notify);
 205         break;
 206     }
 207
 208     acpi_UserNotify("CMBAT", h, notify);
 209 }
 210
 211 static int
 212 acpi_cmbat_info_expired(struct timespec *lastupdated)
 213 {
 214     struct timespec     curtime;
 215
 216     ACPI_SERIAL_ASSERT(cmbat);
 217
 218     if (lastupdated == NULL)
 219         return (TRUE);
 220     if (!timespecisset(lastupdated))
 221         return (TRUE);
 222
 223     getnanotime(&curtime);
 224     timespecsub(&curtime, lastupdated);
 225     return (curtime.tv_sec < 0 ||
 226             curtime.tv_sec > acpi_battery_get_info_expire());
 227 }
 228
 229 static void
 230 acpi_cmbat_info_updated(struct timespec *lastupdated)
 231 {
 232
 233     ACPI_SERIAL_ASSERT(cmbat);
 234
 235     if (lastupdated != NULL)
 236         getnanotime(lastupdated);
 237 }
 238
 239 static void
 240 acpi_cmbat_get_bst(void *arg)
 241 {
 242     struct acpi_cmbat_softc *sc;
 243     ACPI_STATUS as;
 244     ACPI_OBJECT *res;
 245     ACPI_HANDLE h;
 246     ACPI_BUFFER bst_buffer;
 247     device_t dev;
 248
 249     ACPI_SERIAL_ASSERT(cmbat);
 250
 251     dev = arg;
 252     sc = device_get_softc(dev);
 253     h = acpi_get_handle(dev);
 254     bst_buffer.Pointer = NULL;
 255     bst_buffer.Length = ACPI_ALLOCATE_BUFFER;
 256
 257     if (!acpi_cmbat_info_expired(&sc->bst_lastupdated))
 258         goto end;
 259
 260     as = AcpiEvaluateObject(h, "_BST", NULL, &bst_buffer);
 261     if (ACPI_FAILURE(as)) {
 262         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 263                     "error fetching current battery status -- %s\n",
 264                     AcpiFormatException(as));
 265         goto end;
 266     }
 267
 268     res = (ACPI_OBJECT *)bst_buffer.Pointer;
 269     if (!ACPI_PKG_VALID(res, 4)) {
 270         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 271                     "battery status corrupted\n");
 272         goto end;
 273     }
 274
 275     if (acpi_PkgInt32(res, 0, &sc->bst.state) != 0)
 276         goto end;
 277     if (acpi_PkgInt32(res, 1, &sc->bst.rate) != 0)
 278         goto end;
 279     if (acpi_PkgInt32(res, 2, &sc->bst.cap) != 0)
 280         goto end;
 281     if (acpi_PkgInt32(res, 3, &sc->bst.volt) != 0)
 282         goto end;
 283     acpi_cmbat_info_updated(&sc->bst_lastupdated);
 284
 285     /* Clear out undefined/extended bits that might be set by hardware. */
 286     sc->bst.state &= ACPI_BATT_STAT_BST_MASK;
 287     if ((sc->bst.state & ACPI_BATT_STAT_INVALID) == ACPI_BATT_STAT_INVALID)
 288         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 289             "battery reports simultaneous charging and discharging\n");
 290
 291     /* XXX If all batteries are critical, perhaps we should suspend. */
 292     if (sc->bst.state & ACPI_BATT_STAT_CRITICAL) {
 293         if ((sc->flags & ACPI_BATT_STAT_CRITICAL) == 0) {
 294             sc->flags |= ACPI_BATT_STAT_CRITICAL;
 295             device_printf(dev, "critically low charge!\n");
 296         }
 297     } else
 298         sc->flags &= ~ACPI_BATT_STAT_CRITICAL;
 299
 300 end:
 301     if (bst_buffer.Pointer != NULL)
 302         AcpiOsFree(bst_buffer.Pointer);
 303 }
 304
 305 /* XXX There should be a cleaner way to do this locking. */
 306 static void
 307 acpi_cmbat_get_bif_task(void *arg)
 308 {
 309
 310     ACPI_SERIAL_BEGIN(cmbat);
 311     acpi_cmbat_get_bif(arg);
 312     ACPI_SERIAL_END(cmbat);
 313 }
 314
 315 static void
 316 acpi_cmbat_get_bif(void *arg)
 317 {
 318     struct acpi_cmbat_softc *sc;
 319     ACPI_STATUS as;
 320     ACPI_OBJECT *res;
 321     ACPI_HANDLE h;
 322     ACPI_BUFFER info_buffer;
 323     device_t dev;
 324     int i;
 325
 326     ACPI_SERIAL_ASSERT(cmbat);
 327
 328     dev = arg;
 329     sc = device_get_softc(dev);
 330     h = acpi_get_handle(dev);
 331     info_buffer.Pointer = NULL;
 332     info_buffer.Length = ACPI_ALLOCATE_BUFFER;
 333
 334     as = AcpiEvaluateObject(h, sc->bix_present ? "_BIX" : "_BIF", NULL,
 335         &info_buffer);
 336     if (ACPI_FAILURE(as)) {
 337         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 338                     "error fetching current %sbattery info -- %s\n",
 339                     sc->bix_present ? "extended " : "",
 340                     AcpiFormatException(as));
 341         goto end;
 342     }
 343
 344     res = (ACPI_OBJECT *)info_buffer.Pointer;
 345     if (!ACPI_PKG_VALID(res, sc->bix_present ? 20 : 13)) {
 346         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 347                     "%sbattery info corrupted\n",
 348                     sc->bix_present ? "extended " : "");
 349         goto end;
 350     }
 351
 352     i = sc->bix_present ? 1 : 0; /* _BIX: Skip Revision field. */
 353     if (acpi_PkgInt32(res, i++, &sc->bif.units) != 0)
 354         goto end;
 355     if (acpi_PkgInt32(res, i++, &sc->bif.dcap) != 0)
 356         goto end;
 357     if (acpi_PkgInt32(res, i++, &sc->bif.lfcap) != 0)
 358         goto end;
 359     if (acpi_PkgInt32(res, i++, &sc->bif.btech) != 0)
 360         goto end;
 361     if (acpi_PkgInt32(res, i++, &sc->bif.dvol) != 0)
 362         goto end;
 363     if (acpi_PkgInt32(res, i++, &sc->bif.wcap) != 0)
 364         goto end;
 365     if (acpi_PkgInt32(res, i++, &sc->bif.lcap) != 0)
 366         goto end;
 367     if (sc->bix_present)
 368         i += 6;    /* _BIX: Continue with Battery Capacity Granularity 1. */
 369     if (acpi_PkgInt32(res, i++, &sc->bif.gra1) != 0)
 370         goto end;
 371     if (acpi_PkgInt32(res, i++, &sc->bif.gra2) != 0)
 372         goto end;
 373     if (acpi_PkgStr(res,  i++, sc->bif.model, ACPI_CMBAT_MAXSTRLEN) != 0)
 374         goto end;
 375     if (acpi_PkgStr(res, i++, sc->bif.serial, ACPI_CMBAT_MAXSTRLEN) != 0)
 376         goto end;
 377     if (acpi_PkgStr(res, i++, sc->bif.type, ACPI_CMBAT_MAXSTRLEN) != 0)
 378         goto end;
 379     if (acpi_PkgStr(res, i++, sc->bif.oeminfo, ACPI_CMBAT_MAXSTRLEN) != 0)
 380         goto end;
 381     /* _BIX: Ignore Battery Swapping Capability field. */
 382
 383 end:
 384     if (info_buffer.Pointer != NULL)
 385         AcpiOsFree(info_buffer.Pointer);
 386 }
 387
 388 static int
 389 acpi_cmbat_bif(device_t dev, struct acpi_bif *bifp)
 390 {
 391     struct acpi_cmbat_softc *sc;
 392
 393     sc = device_get_softc(dev);
 394
 395     /*
 396      * Just copy the data.  The only value that should change is the
 397      * last-full capacity, so we only update when we get a notify that says
 398      * the info has changed.  Many systems apparently take a long time to
 399      * process a _BIF call so we avoid it if possible.
 400      */
 401     ACPI_SERIAL_BEGIN(cmbat);
 402     bifp->units = sc->bif.units;
 403     bifp->dcap = sc->bif.dcap;
 404     bifp->lfcap = sc->bif.lfcap;
 405     bifp->btech = sc->bif.btech;
 406     bifp->dvol = sc->bif.dvol;
 407     bifp->wcap = sc->bif.wcap;
 408     bifp->lcap = sc->bif.lcap;
 409     bifp->gra1 = sc->bif.gra1;
 410     bifp->gra2 = sc->bif.gra2;
 411     strncpy(bifp->model, sc->bif.model, sizeof(sc->bif.model));
 412     strncpy(bifp->serial, sc->bif.serial, sizeof(sc->bif.serial));
 413     strncpy(bifp->type, sc->bif.type, sizeof(sc->bif.type));
 414     strncpy(bifp->oeminfo, sc->bif.oeminfo, sizeof(sc->bif.oeminfo));
 415     ACPI_SERIAL_END(cmbat);
 416
 417     return (0);
 418 }
 419
 420 static int
 421 acpi_cmbat_bst(device_t dev, struct acpi_bst *bstp)
 422 {
 423     struct acpi_cmbat_softc *sc;
 424
 425     sc = device_get_softc(dev);
 426
 427     ACPI_SERIAL_BEGIN(cmbat);
 428     if (acpi_BatteryIsPresent(dev)) {
 429         acpi_cmbat_get_bst(dev);
 430         bstp->state = sc->bst.state;
 431         bstp->rate = sc->bst.rate;
 432         bstp->cap = sc->bst.cap;
 433         bstp->volt = sc->bst.volt;
 434     } else
 435         bstp->state = ACPI_BATT_STAT_NOT_PRESENT;
 436     ACPI_SERIAL_END(cmbat);
 437
 438     return (0);
 439 }
 440
 441 static void
 442 acpi_cmbat_init_battery(void *arg)
 443 {
 444     struct acpi_cmbat_softc *sc;
 445     int         retry, valid;
 446     device_t    dev;
 447
 448     dev = (device_t)arg;
 449     sc = device_get_softc(dev);
 450     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 451                 "battery initialization start\n");
 452
 453     /*
 454      * Try repeatedly to get valid data from the battery.  Since the
 455      * embedded controller isn't always ready just after boot, we may have
 456      * to wait a while.
 457      */
 458     for (retry = 0; retry < ACPI_CMBAT_RETRY_MAX; retry++, AcpiOsSleep(10000)) {
 459         /* batteries on DOCK can be ejected w/ DOCK during retrying */
 460         if (!device_is_attached(dev))
 461             return;
 462
 463         if (!acpi_BatteryIsPresent(dev))
 464             continue;
 465
 466         /*
 467          * Only query the battery if this is the first try or the specific
 468          * type of info is still invalid.
 469          */
 470         ACPI_SERIAL_BEGIN(cmbat);
 471         if (retry == 0 || !acpi_battery_bst_valid(&sc->bst)) {
 472             timespecclear(&sc->bst_lastupdated);
 473             acpi_cmbat_get_bst(dev);
 474         }
 475         if (retry == 0 || !acpi_battery_bif_valid(&sc->bif))
 476             acpi_cmbat_get_bif(dev);
 477
 478         valid = acpi_battery_bst_valid(&sc->bst) &&
 479             acpi_battery_bif_valid(&sc->bif);
 480         ACPI_SERIAL_END(cmbat);
 481
 482         if (valid)
 483             break;
 484     }
 485
 486     if (retry == ACPI_CMBAT_RETRY_MAX) {
 487         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 488                     "battery initialization failed, giving up\n");
 489     } else {
 490         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 491                     "battery initialization done, tried %d times\n", retry + 1);
 492     }
 493 }