sys/powerpc/powermac/pmu.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2006 Michael Lorenz
   5  * Copyright 2008 by Nathan Whitehorn
   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 ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * 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  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35 #include <sys/systm.h>
  36 #include <sys/module.h>
  37 #include <sys/bus.h>
  38 #include <sys/conf.h>
  39 #include <sys/eventhandler.h>
  40 #include <sys/kernel.h>
  41 #include <sys/kthread.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/clock.h>
  45 #include <sys/proc.h>
  46 #include <sys/reboot.h>
  47 #include <sys/sysctl.h>
  48
  49 #include <dev/ofw/ofw_bus.h>
  50 #include <dev/ofw/openfirm.h>
  51 #include <dev/led/led.h>
  52
  53 #include <machine/_inttypes.h>
  54 #include <machine/bus.h>
  55 #include <machine/cpu.h>
  56 #include <machine/hid.h>
  57 #include <machine/intr_machdep.h>
  58 #include <machine/md_var.h>
  59 #include <machine/pcb.h>
  60 #include <machine/pio.h>
  61 #include <machine/resource.h>
  62
  63 #include <vm/vm.h>
  64 #include <vm/pmap.h>
  65
  66 #include <sys/rman.h>
  67
  68 #include <dev/adb/adb.h>
  69
  70 #include "clock_if.h"
  71 #include "pmuvar.h"
  72 #include "viareg.h"
  73 #include "uninorthvar.h"        /* For unin_chip_sleep()/unin_chip_wake() */
  74
  75 #define PMU_DEFAULTS    PMU_INT_TICK | PMU_INT_ADB | \
  76         PMU_INT_PCEJECT | PMU_INT_SNDBRT | \
  77         PMU_INT_BATTERY | PMU_INT_ENVIRONMENT
  78
  79 /*
  80  * Bus interface
  81  */
  82 static int      pmu_probe(device_t);
  83 static int      pmu_attach(device_t);
  84 static int      pmu_detach(device_t);
  85
  86 /*
  87  * Clock interface
  88  */
  89 static int      pmu_gettime(device_t dev, struct timespec *ts);
  90 static int      pmu_settime(device_t dev, struct timespec *ts);
  91
  92 /*
  93  * ADB Interface
  94  */
  95
  96 static u_int    pmu_adb_send(device_t dev, u_char command_byte, int len,
  97                     u_char *data, u_char poll);
  98 static u_int    pmu_adb_autopoll(device_t dev, uint16_t mask);
  99 static u_int    pmu_poll(device_t dev);
 100
 101 /*
 102  * Power interface
 103  */
 104
 105 static void     pmu_shutdown(void *xsc, int howto);
 106 static void     pmu_set_sleepled(void *xsc, int onoff);
 107 static int      pmu_server_mode(SYSCTL_HANDLER_ARGS);
 108 static int      pmu_acline_state(SYSCTL_HANDLER_ARGS);
 109 static int      pmu_query_battery(struct pmu_softc *sc, int batt,
 110                     struct pmu_battstate *info);
 111 static int      pmu_battquery_sysctl(SYSCTL_HANDLER_ARGS);
 112 static int      pmu_battmon(SYSCTL_HANDLER_ARGS);
 113 static void     pmu_battquery_proc(void);
 114 static void     pmu_battery_notify(struct pmu_battstate *batt,
 115                     struct pmu_battstate *old);
 116
 117 /*
 118  * List of battery-related sysctls we might ask for
 119  */
 120
 121 enum {
 122         PMU_BATSYSCTL_PRESENT   = 1 << 8,
 123         PMU_BATSYSCTL_CHARGING  = 2 << 8,
 124         PMU_BATSYSCTL_CHARGE    = 3 << 8,
 125         PMU_BATSYSCTL_MAXCHARGE = 4 << 8,
 126         PMU_BATSYSCTL_CURRENT   = 5 << 8,
 127         PMU_BATSYSCTL_VOLTAGE   = 6 << 8,
 128         PMU_BATSYSCTL_TIME      = 7 << 8,
 129         PMU_BATSYSCTL_LIFE      = 8 << 8
 130 };
 131
 132 static device_method_t  pmu_methods[] = {
 133         /* Device interface */
 134         DEVMETHOD(device_probe,         pmu_probe),
 135         DEVMETHOD(device_attach,        pmu_attach),
 136         DEVMETHOD(device_detach,        pmu_detach),
 137         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 138
 139         /* ADB bus interface */
 140         DEVMETHOD(adb_hb_send_raw_packet,   pmu_adb_send),
 141         DEVMETHOD(adb_hb_controller_poll,   pmu_poll),
 142         DEVMETHOD(adb_hb_set_autopoll_mask, pmu_adb_autopoll),
 143
 144         /* Clock interface */
 145         DEVMETHOD(clock_gettime,        pmu_gettime),
 146         DEVMETHOD(clock_settime,        pmu_settime),
 147
 148         DEVMETHOD_END
 149 };
 150
 151 static driver_t pmu_driver = {
 152         "pmu",
 153         pmu_methods,
 154         sizeof(struct pmu_softc),
 155 };
 156
 157 static devclass_t pmu_devclass;
 158
 159 EARLY_DRIVER_MODULE(pmu, macio, pmu_driver, pmu_devclass, 0, 0,
 160     BUS_PASS_RESOURCE);
 161 DRIVER_MODULE(adb, pmu, adb_driver, adb_devclass, 0, 0);
 162
 163 static int      pmuextint_probe(device_t);
 164 static int      pmuextint_attach(device_t);
 165
 166 static device_method_t  pmuextint_methods[] = {
 167         /* Device interface */
 168         DEVMETHOD(device_probe,         pmuextint_probe),
 169         DEVMETHOD(device_attach,        pmuextint_attach),
 170         {0,0}
 171 };
 172
 173 static driver_t pmuextint_driver = {
 174         "pmuextint",
 175         pmuextint_methods,
 176         0
 177 };
 178
 179 static devclass_t pmuextint_devclass;
 180
 181 EARLY_DRIVER_MODULE(pmuextint, macgpio, pmuextint_driver, pmuextint_devclass,
 182     0, 0, BUS_PASS_RESOURCE);
 183
 184 /* Make sure uhid is loaded, as it turns off some of the ADB emulation */
 185 MODULE_DEPEND(pmu, usb, 1, 1, 1);
 186
 187 static void pmu_intr(void *arg);
 188 static void pmu_in(struct pmu_softc *sc);
 189 static void pmu_out(struct pmu_softc *sc);
 190 static void pmu_ack_on(struct pmu_softc *sc);
 191 static void pmu_ack_off(struct pmu_softc *sc);
 192 static int pmu_send(void *cookie, int cmd, int length, uint8_t *in_msg,
 193         int rlen, uint8_t *out_msg);
 194 static uint8_t pmu_read_reg(struct pmu_softc *sc, u_int offset);
 195 static void pmu_write_reg(struct pmu_softc *sc, u_int offset, uint8_t value);
 196 static int pmu_intr_state(struct pmu_softc *);
 197
 198 /* these values shows that number of data returned after 'send' cmd is sent */
 199 static signed char pm_send_cmd_type[] = {
 200           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 201           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 202         0x01, 0x01,   -1,   -1,   -1,   -1,   -1,   -1,
 203         0x00, 0x00,   -1,   -1,   -1,   -1,   -1, 0x00,
 204           -1, 0x00, 0x02, 0x01, 0x01,   -1,   -1,   -1,
 205         0x00,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 206         0x04, 0x14,   -1, 0x03,   -1,   -1,   -1,   -1,
 207         0x00, 0x00, 0x02, 0x02,   -1,   -1,   -1,   -1,
 208         0x01, 0x01,   -1,   -1,   -1,   -1,   -1,   -1,
 209         0x00, 0x00,   -1,   -1, 0x01,   -1,   -1,   -1,
 210         0x01, 0x00, 0x02, 0x02,   -1, 0x01, 0x03, 0x01,
 211         0x00, 0x01, 0x00, 0x00, 0x00,   -1,   -1,   -1,
 212         0x02,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 213         0x00, 0x00, 0x00, 0x00, 0x00, 0x00,   -1,   -1,
 214         0x01, 0x01, 0x01,   -1,   -1,   -1,   -1,   -1,
 215         0x00, 0x00,   -1,   -1,   -1, 0x05, 0x04, 0x04,
 216         0x04,   -1, 0x00,   -1,   -1,   -1,   -1,   -1,
 217         0x00,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 218         0x01, 0x02,   -1,   -1,   -1,   -1,   -1,   -1,
 219         0x00, 0x00,   -1,   -1,   -1,   -1,   -1,   -1,
 220         0x02, 0x02, 0x02, 0x04,   -1, 0x00,   -1,   -1,
 221         0x01, 0x01, 0x03, 0x02,   -1,   -1,   -1,   -1,
 222           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 223           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 224           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 225           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 226         0x00,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 227         0x01, 0x01,   -1,   -1, 0x00, 0x00,   -1,   -1,
 228           -1, 0x04, 0x00,   -1,   -1,   -1,   -1,   -1,
 229         0x03,   -1, 0x00,   -1, 0x00,   -1,   -1, 0x00,
 230           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 231           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1
 232 };
 233
 234 /* these values shows that number of data returned after 'receive' cmd is sent */
 235 static signed char pm_receive_cmd_type[] = {
 236         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 237           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 238         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 239         0x02, 0x02,   -1,   -1,   -1,   -1,   -1, 0x00,
 240         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 241           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 242         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 243         0x05, 0x15,   -1, 0x02,   -1,   -1,   -1,   -1,
 244         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 245         0x02, 0x02,   -1,   -1,   -1,   -1,   -1,   -1,
 246         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 247         0x02, 0x00, 0x03, 0x03,   -1,   -1,   -1,   -1,
 248         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 249         0x04, 0x04, 0x03, 0x09,   -1,   -1,   -1,   -1,
 250         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 251           -1,   -1,   -1,   -1,   -1, 0x01, 0x01, 0x01,
 252         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 253         0x06,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 254         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 255         0x02, 0x02,   -1,   -1,   -1,   -1,   -1,   -1,
 256         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 257         0x02, 0x00, 0x00, 0x00,   -1,   -1,   -1,   -1,
 258         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 259           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 260         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 261           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 262         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 263         0x02, 0x02,   -1,   -1, 0x02,   -1,   -1,   -1,
 264         0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00,
 265           -1,   -1, 0x02,   -1,   -1,   -1,   -1, 0x00,
 266         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 267           -1,   -1,   -1,   -1,   -1,   -1,   -1,   -1,
 268 };
 269
 270 static int pmu_battmon_enabled = 1;
 271 static struct proc *pmubattproc;
 272 static struct kproc_desc pmu_batt_kp = {
 273         "pmu_batt",
 274         pmu_battquery_proc,
 275         &pmubattproc
 276 };
 277
 278 /* We only have one of each device, so globals are safe */
 279 static device_t pmu = NULL;
 280 static device_t pmu_extint = NULL;
 281
 282 static int
 283 pmuextint_probe(device_t dev)
 284 {
 285         const char *type = ofw_bus_get_type(dev);
 286
 287         if (strcmp(type, "extint-gpio1") != 0)
 288                 return (ENXIO);
 289
 290         device_set_desc(dev, "Apple PMU99 External Interrupt");
 291         return (0);
 292 }
 293
 294 static int
 295 pmu_probe(device_t dev)
 296 {
 297         const char *type = ofw_bus_get_type(dev);
 298
 299         if (strcmp(type, "via-pmu") != 0)
 300                 return (ENXIO);
 301
 302         device_set_desc(dev, "Apple PMU99 Controller");
 303         return (0);
 304 }
 305
 306 static int
 307 setup_pmu_intr(device_t dev, device_t extint)
 308 {
 309         struct pmu_softc *sc;
 310         sc = device_get_softc(dev);
 311
 312         sc->sc_irqrid = 0;
 313         sc->sc_irq = bus_alloc_resource_any(extint, SYS_RES_IRQ, &sc->sc_irqrid,
 314                 RF_ACTIVE);
 315         if (sc->sc_irq == NULL) {
 316                 device_printf(dev, "could not allocate interrupt\n");
 317                 return (ENXIO);
 318         }
 319
 320         if (bus_setup_intr(dev, sc->sc_irq, INTR_TYPE_MISC | INTR_MPSAFE
 321             | INTR_ENTROPY, NULL, pmu_intr, dev, &sc->sc_ih) != 0) {
 322                 device_printf(dev, "could not setup interrupt\n");
 323                 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irqrid,
 324                     sc->sc_irq);
 325                 return (ENXIO);
 326         }
 327
 328         return (0);
 329 }
 330
 331 static int
 332 pmuextint_attach(device_t dev)
 333 {
 334         pmu_extint = dev;
 335         if (pmu)
 336                 return (setup_pmu_intr(pmu,dev));
 337
 338         return (0);
 339 }
 340
 341 static int
 342 pmu_attach(device_t dev)
 343 {
 344         struct pmu_softc *sc;
 345
 346         int i;
 347         uint8_t reg;
 348         uint8_t cmd[2] = {2, 0};
 349         uint8_t resp[16];
 350         phandle_t node,child;
 351         struct sysctl_ctx_list *ctx;
 352         struct sysctl_oid *tree;
 353
 354         sc = device_get_softc(dev);
 355         sc->sc_dev = dev;
 356
 357         sc->sc_memrid = 0;
 358         sc->sc_memr = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
 359                           &sc->sc_memrid, RF_ACTIVE);
 360
 361         mtx_init(&sc->sc_mutex,"pmu",NULL,MTX_DEF | MTX_RECURSE);
 362
 363         if (sc->sc_memr == NULL) {
 364                 device_printf(dev, "Could not alloc mem resource!\n");
 365                 return (ENXIO);
 366         }
 367
 368         /*
 369          * Our interrupt is attached to a GPIO pin. Depending on probe order,
 370          * we may not have found it yet. If we haven't, it will find us, and
 371          * attach our interrupt then.
 372          */
 373         pmu = dev;
 374         if (pmu_extint != NULL) {
 375                 if (setup_pmu_intr(dev,pmu_extint) != 0)
 376                         return (ENXIO);
 377         }
 378
 379         sc->sc_autopoll = 0;
 380         sc->sc_batteries = 0;
 381         sc->adb_bus = NULL;
 382         sc->sc_leddev = NULL;
 383
 384         /* Init PMU */
 385
 386         pmu_write_reg(sc, vBufB, pmu_read_reg(sc, vBufB) | vPB4);
 387         pmu_write_reg(sc, vDirB, (pmu_read_reg(sc, vDirB) | vPB4) & ~vPB3);
 388
 389         reg = PMU_DEFAULTS;
 390         pmu_send(sc, PMU_SET_IMASK, 1, &reg, 16, resp);
 391
 392         pmu_write_reg(sc, vIER, 0x94); /* make sure VIA interrupts are on */
 393
 394         pmu_send(sc, PMU_SYSTEM_READY, 1, cmd, 16, resp);
 395         pmu_send(sc, PMU_GET_VERSION, 0, cmd, 16, resp);
 396
 397         /* Initialize child buses (ADB) */
 398         node = ofw_bus_get_node(dev);
 399
 400         for (child = OF_child(node); child != 0; child = OF_peer(child)) {
 401                 char name[32];
 402
 403                 memset(name, 0, sizeof(name));
 404                 OF_getprop(child, "name", name, sizeof(name));
 405
 406                 if (bootverbose)
 407                         device_printf(dev, "PMU child <%s>\n",name);
 408
 409                 if (strncmp(name, "adb", 4) == 0) {
 410                         sc->adb_bus = device_add_child(dev,"adb",-1);
 411                 }
 412
 413                 if (strncmp(name, "power-mgt", 9) == 0) {
 414                         uint32_t prim_info[9];
 415
 416                         if (OF_getprop(child, "prim-info", prim_info,
 417                             sizeof(prim_info)) >= 7)
 418                                 sc->sc_batteries = (prim_info[6] >> 16) & 0xff;
 419
 420                         if (bootverbose && sc->sc_batteries > 0)
 421                                 device_printf(dev, "%d batteries detected\n",
 422                                     sc->sc_batteries);
 423                 }
 424         }
 425
 426         /*
 427          * Set up sysctls
 428          */
 429
 430         ctx = device_get_sysctl_ctx(dev);
 431         tree = device_get_sysctl_tree(dev);
 432
 433         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 434             "server_mode", CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE, sc, 0,
 435             pmu_server_mode, "I", "Enable reboot after power failure");
 436
 437         if (sc->sc_batteries > 0) {
 438                 struct sysctl_oid *oid, *battroot;
 439                 char battnum[2];
 440
 441                 /* Only start the battery monitor if we have a battery. */
 442                 kproc_start(&pmu_batt_kp);
 443                 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 444                     "monitor_batteries",
 445                     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, sc, 0,
 446                     pmu_battmon, "I", "Post battery events to devd");
 447
 448                 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 449                     "acline", CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 450                     0, pmu_acline_state, "I", "AC Line Status");
 451
 452                 battroot = SYSCTL_ADD_NODE(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 453                     "batteries", CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
 454                     "Battery Information");
 455
 456                 for (i = 0; i < sc->sc_batteries; i++) {
 457                         battnum[0] = i + '0';
 458                         battnum[1] = '\0';
 459
 460                         oid = SYSCTL_ADD_NODE(ctx, SYSCTL_CHILDREN(battroot),
 461                             OID_AUTO, battnum, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
 462                             "Battery Information");
 463
 464                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 465                             "present",
 466                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 467                             PMU_BATSYSCTL_PRESENT | i, pmu_battquery_sysctl,
 468                             "I", "Battery present");
 469                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 470                             "charging",
 471                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 472                             PMU_BATSYSCTL_CHARGING | i, pmu_battquery_sysctl,
 473                             "I", "Battery charging");
 474                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 475                             "charge",
 476                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 477                             PMU_BATSYSCTL_CHARGE | i, pmu_battquery_sysctl,
 478                             "I", "Battery charge (mAh)");
 479                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 480                             "maxcharge",
 481                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 482                             PMU_BATSYSCTL_MAXCHARGE | i, pmu_battquery_sysctl,
 483                             "I", "Maximum battery capacity (mAh)");
 484                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 485                             "rate",
 486                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 487                             PMU_BATSYSCTL_CURRENT | i, pmu_battquery_sysctl,
 488                             "I", "Battery discharge rate (mA)");
 489                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 490                             "voltage",
 491                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 492                             PMU_BATSYSCTL_VOLTAGE | i, pmu_battquery_sysctl,
 493                             "I", "Battery voltage (mV)");
 494
 495                         /* Knobs for mental compatibility with ACPI */
 496
 497                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 498                             "time",
 499                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 500                             PMU_BATSYSCTL_TIME | i, pmu_battquery_sysctl,
 501                             "I", "Time Remaining (minutes)");
 502                         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 503                             "life",
 504                             CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, sc,
 505                             PMU_BATSYSCTL_LIFE | i, pmu_battquery_sysctl,
 506                             "I", "Capacity remaining (percent)");
 507                 }
 508         }
 509
 510         /*
 511          * Set up LED interface
 512          */
 513
 514         sc->sc_leddev = led_create(pmu_set_sleepled, sc, "sleepled");
 515
 516         /*
 517          * Register RTC
 518          */
 519
 520         clock_register(dev, 1000);
 521
 522         /*
 523          * Register power control handler
 524          */
 525         EVENTHANDLER_REGISTER(shutdown_final, pmu_shutdown, sc,
 526             SHUTDOWN_PRI_LAST);
 527
 528         return (bus_generic_attach(dev));
 529 }
 530
 531 static int
 532 pmu_detach(device_t dev)
 533 {
 534         struct pmu_softc *sc;
 535
 536         sc = device_get_softc(dev);
 537
 538         if (sc->sc_leddev != NULL)
 539                 led_destroy(sc->sc_leddev);
 540
 541         bus_teardown_intr(dev, sc->sc_irq, sc->sc_ih);
 542         bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irqrid, sc->sc_irq);
 543         bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_memrid, sc->sc_memr);
 544         mtx_destroy(&sc->sc_mutex);
 545
 546         return (bus_generic_detach(dev));
 547 }
 548
 549 static uint8_t
 550 pmu_read_reg(struct pmu_softc *sc, u_int offset)
 551 {
 552         return (bus_read_1(sc->sc_memr, offset));
 553 }
 554
 555 static void
 556 pmu_write_reg(struct pmu_softc *sc, u_int offset, uint8_t value)
 557 {
 558         bus_write_1(sc->sc_memr, offset, value);
 559 }
 560
 561 static int
 562 pmu_send_byte(struct pmu_softc *sc, uint8_t data)
 563 {
 564
 565         pmu_out(sc);
 566         pmu_write_reg(sc, vSR, data);
 567         pmu_ack_off(sc);
 568         /* wait for intr to come up */
 569         /* XXX should add a timeout and bail if it expires */
 570         do {} while (pmu_intr_state(sc) == 0);
 571         pmu_ack_on(sc);
 572         do {} while (pmu_intr_state(sc));
 573         pmu_ack_on(sc);
 574         return 0;
 575 }
 576
 577 static inline int
 578 pmu_read_byte(struct pmu_softc *sc, uint8_t *data)
 579 {
 580         volatile uint8_t scratch;
 581         pmu_in(sc);
 582         scratch = pmu_read_reg(sc, vSR);
 583         pmu_ack_off(sc);
 584         /* wait for intr to come up */
 585         do {} while (pmu_intr_state(sc) == 0);
 586         pmu_ack_on(sc);
 587         do {} while (pmu_intr_state(sc));
 588         *data = pmu_read_reg(sc, vSR);
 589         return 0;
 590 }
 591
 592 static int
 593 pmu_intr_state(struct pmu_softc *sc)
 594 {
 595         return ((pmu_read_reg(sc, vBufB) & vPB3) == 0);
 596 }
 597
 598 static int
 599 pmu_send(void *cookie, int cmd, int length, uint8_t *in_msg, int rlen,
 600     uint8_t *out_msg)
 601 {
 602         struct pmu_softc *sc = cookie;
 603         int i, rcv_len = -1;
 604         uint8_t out_len, intreg;
 605
 606         intreg = pmu_read_reg(sc, vIER);
 607         intreg &= 0x10;
 608         pmu_write_reg(sc, vIER, intreg);
 609
 610         /* wait idle */
 611         do {} while (pmu_intr_state(sc));
 612
 613         /* send command */
 614         pmu_send_byte(sc, cmd);
 615
 616         /* send length if necessary */
 617         if (pm_send_cmd_type[cmd] < 0) {
 618                 pmu_send_byte(sc, length);
 619         }
 620
 621         for (i = 0; i < length; i++) {
 622                 pmu_send_byte(sc, in_msg[i]);
 623         }
 624
 625         /* see if there's data to read */
 626         rcv_len = pm_receive_cmd_type[cmd];
 627         if (rcv_len == 0)
 628                 goto done;
 629
 630         /* read command */
 631         if (rcv_len == 1) {
 632                 pmu_read_byte(sc, out_msg);
 633                 goto done;
 634         } else
 635                 out_msg[0] = cmd;
 636         if (rcv_len < 0) {
 637                 pmu_read_byte(sc, &out_len);
 638                 rcv_len = out_len + 1;
 639         }
 640         for (i = 1; i < min(rcv_len, rlen); i++)
 641                 pmu_read_byte(sc, &out_msg[i]);
 642
 643 done:
 644         pmu_write_reg(sc, vIER, (intreg == 0) ? 0 : 0x90);
 645
 646         return rcv_len;
 647 }
 648
 649 static u_int
 650 pmu_poll(device_t dev)
 651 {
 652         pmu_intr(dev);
 653         return (0);
 654 }
 655
 656 static void
 657 pmu_in(struct pmu_softc *sc)
 658 {
 659         uint8_t reg;
 660
 661         reg = pmu_read_reg(sc, vACR);
 662         reg &= ~vSR_OUT;
 663         reg |= 0x0c;
 664         pmu_write_reg(sc, vACR, reg);
 665 }
 666
 667 static void
 668 pmu_out(struct pmu_softc *sc)
 669 {
 670         uint8_t reg;
 671
 672         reg = pmu_read_reg(sc, vACR);
 673         reg |= vSR_OUT;
 674         reg |= 0x0c;
 675         pmu_write_reg(sc, vACR, reg);
 676 }
 677
 678 static void
 679 pmu_ack_off(struct pmu_softc *sc)
 680 {
 681         uint8_t reg;
 682
 683         reg = pmu_read_reg(sc, vBufB);
 684         reg &= ~vPB4;
 685         pmu_write_reg(sc, vBufB, reg);
 686 }
 687
 688 static void
 689 pmu_ack_on(struct pmu_softc *sc)
 690 {
 691         uint8_t reg;
 692
 693         reg = pmu_read_reg(sc, vBufB);
 694         reg |= vPB4;
 695         pmu_write_reg(sc, vBufB, reg);
 696 }
 697
 698 static void
 699 pmu_intr(void *arg)
 700 {
 701         device_t        dev;
 702         struct pmu_softc *sc;
 703
 704         unsigned int len;
 705         uint8_t resp[16];
 706         uint8_t junk[16];
 707
 708         dev = (device_t)arg;
 709         sc = device_get_softc(dev);
 710
 711         mtx_lock(&sc->sc_mutex);
 712
 713         pmu_write_reg(sc, vIFR, 0x90);  /* Clear 'em */
 714         len = pmu_send(sc, PMU_INT_ACK, 0, NULL, 16, resp);
 715
 716         mtx_unlock(&sc->sc_mutex);
 717
 718         if ((len < 1) || (resp[1] == 0)) {
 719                 return;
 720         }
 721
 722         if (resp[1] & PMU_INT_ADB) {
 723                 /*
 724                  * the PMU will turn off autopolling after each command that
 725                  * it did not issue, so we assume any but TALK R0 is ours and
 726                  * re-enable autopoll here whenever we receive an ACK for a
 727                  * non TR0 command.
 728                  */
 729                 mtx_lock(&sc->sc_mutex);
 730
 731                 if ((resp[2] & 0x0f) != (ADB_COMMAND_TALK << 2)) {
 732                         if (sc->sc_autopoll) {
 733                                 uint8_t cmd[] = {0, PMU_SET_POLL_MASK,
 734                                     (sc->sc_autopoll >> 8) & 0xff,
 735                                     sc->sc_autopoll & 0xff};
 736
 737                                 pmu_send(sc, PMU_ADB_CMD, 4, cmd, 16, junk);
 738                         }
 739                 }
 740
 741                 mtx_unlock(&sc->sc_mutex);
 742
 743                 adb_receive_raw_packet(sc->adb_bus,resp[1],resp[2],
 744                         len - 3,&resp[3]);
 745         }
 746         if (resp[1] & PMU_INT_ENVIRONMENT) {
 747                 /* if the lid was just closed, notify devd. */
 748                 if ((resp[2] & PMU_ENV_LID_CLOSED) && (!sc->lid_closed)) {
 749                         sc->lid_closed = 1;
 750                         devctl_notify("PMU", "lid", "close", NULL);
 751                 }
 752                 else if (!(resp[2] & PMU_ENV_LID_CLOSED) && (sc->lid_closed)) {
 753                         /* if the lid was just opened, notify devd. */
 754                         sc->lid_closed = 0;
 755                         devctl_notify("PMU", "lid", "open", NULL);
 756                 }
 757                 if (resp[2] & PMU_ENV_POWER)
 758                         devctl_notify("PMU", "Button", "pressed", NULL);
 759         }
 760 }
 761
 762 static u_int
 763 pmu_adb_send(device_t dev, u_char command_byte, int len, u_char *data,
 764     u_char poll)
 765 {
 766         struct pmu_softc *sc = device_get_softc(dev);
 767         int i,replen;
 768         uint8_t packet[16], resp[16];
 769
 770         /* construct an ADB command packet and send it */
 771
 772         packet[0] = command_byte;
 773
 774         packet[1] = 0;
 775         packet[2] = len;
 776         for (i = 0; i < len; i++)
 777                 packet[i + 3] = data[i];
 778
 779         mtx_lock(&sc->sc_mutex);
 780         replen = pmu_send(sc, PMU_ADB_CMD, len + 3, packet, 16, resp);
 781         mtx_unlock(&sc->sc_mutex);
 782
 783         if (poll)
 784                 pmu_poll(dev);
 785
 786         return 0;
 787 }
 788
 789 static u_int
 790 pmu_adb_autopoll(device_t dev, uint16_t mask)
 791 {
 792         struct pmu_softc *sc = device_get_softc(dev);
 793
 794         /* magical incantation to re-enable autopolling */
 795         uint8_t cmd[] = {0, PMU_SET_POLL_MASK, (mask >> 8) & 0xff, mask & 0xff};
 796         uint8_t resp[16];
 797
 798         mtx_lock(&sc->sc_mutex);
 799
 800         if (sc->sc_autopoll == mask) {
 801                 mtx_unlock(&sc->sc_mutex);
 802                 return 0;
 803         }
 804
 805         sc->sc_autopoll = mask & 0xffff;
 806
 807         if (mask)
 808                 pmu_send(sc, PMU_ADB_CMD, 4, cmd, 16, resp);
 809         else
 810                 pmu_send(sc, PMU_ADB_POLL_OFF, 0, NULL, 16, resp);
 811
 812         mtx_unlock(&sc->sc_mutex);
 813
 814         return 0;
 815 }
 816
 817 static void
 818 pmu_shutdown(void *xsc, int howto)
 819 {
 820         struct pmu_softc *sc = xsc;
 821         uint8_t cmd[] = {'M', 'A', 'T', 'T'};
 822
 823         if (howto & RB_HALT)
 824                 pmu_send(sc, PMU_POWER_OFF, 4, cmd, 0, NULL);
 825         else
 826                 pmu_send(sc, PMU_RESET_CPU, 0, NULL, 0, NULL);
 827
 828         for (;;);
 829 }
 830
 831 static void
 832 pmu_set_sleepled(void *xsc, int onoff)
 833 {
 834         struct pmu_softc *sc = xsc;
 835         uint8_t cmd[] = {4, 0, 0};
 836
 837         cmd[2] = onoff;
 838
 839         mtx_lock(&sc->sc_mutex);
 840         pmu_send(sc, PMU_SET_SLEEPLED, 3, cmd, 0, NULL);
 841         mtx_unlock(&sc->sc_mutex);
 842 }
 843
 844 static int
 845 pmu_server_mode(SYSCTL_HANDLER_ARGS)
 846 {
 847         struct pmu_softc *sc = arg1;
 848
 849         u_int server_mode = 0;
 850         uint8_t getcmd[] = {PMU_PWR_GET_POWERUP_EVENTS};
 851         uint8_t setcmd[] = {0, 0, PMU_PWR_WAKEUP_AC_INSERT};
 852         uint8_t resp[3];
 853         int error, len;
 854
 855         mtx_lock(&sc->sc_mutex);
 856         len = pmu_send(sc, PMU_POWER_EVENTS, 1, getcmd, 3, resp);
 857         mtx_unlock(&sc->sc_mutex);
 858
 859         if (len == 3)
 860                 server_mode = (resp[2] & PMU_PWR_WAKEUP_AC_INSERT) ? 1 : 0;
 861
 862         error = sysctl_handle_int(oidp, &server_mode, 0, req);
 863
 864         if (len != 3)
 865                 return (EINVAL);
 866
 867         if (error || !req->newptr)
 868                 return (error);
 869
 870         if (server_mode == 1)
 871                 setcmd[0] = PMU_PWR_SET_POWERUP_EVENTS;
 872         else if (server_mode == 0)
 873                 setcmd[0] = PMU_PWR_CLR_POWERUP_EVENTS;
 874         else
 875                 return (EINVAL);
 876
 877         setcmd[1] = resp[1];
 878
 879         mtx_lock(&sc->sc_mutex);
 880         pmu_send(sc, PMU_POWER_EVENTS, 3, setcmd, 2, resp);
 881         mtx_unlock(&sc->sc_mutex);
 882
 883         return (0);
 884 }
 885
 886 static int
 887 pmu_query_battery(struct pmu_softc *sc, int batt, struct pmu_battstate *info)
 888 {
 889         uint8_t reg;
 890         uint8_t resp[16];
 891         int len;
 892
 893         reg = batt + 1;
 894
 895         mtx_lock(&sc->sc_mutex);
 896         len = pmu_send(sc, PMU_SMART_BATTERY_STATE, 1, &reg, 16, resp);
 897         mtx_unlock(&sc->sc_mutex);
 898
 899         if (len < 3)
 900                 return (-1);
 901
 902         /* All PMU battery info replies share a common header:
 903          * Byte 1       Payload Format
 904          * Byte 2       Battery Flags
 905          */
 906
 907         info->state = resp[2];
 908
 909         switch (resp[1]) {
 910         case 3:
 911         case 4:
 912                 /*
 913                  * Formats 3 and 4 appear to be the same:
 914                  * Byte 3       Charge
 915                  * Byte 4       Max Charge
 916                  * Byte 5       Current
 917                  * Byte 6       Voltage
 918                  */
 919
 920                 info->charge = resp[3];
 921                 info->maxcharge = resp[4];
 922                 /* Current can be positive or negative */
 923                 info->current = (int8_t)resp[5];
 924                 info->voltage = resp[6];
 925                 break;
 926         case 5:
 927                 /*
 928                  * Formats 5 is a wider version of formats 3 and 4
 929                  * Byte 3-4     Charge
 930                  * Byte 5-6     Max Charge
 931                  * Byte 7-8     Current
 932                  * Byte 9-10    Voltage
 933                  */
 934
 935                 info->charge = (resp[3] << 8) | resp[4];
 936                 info->maxcharge = (resp[5] << 8) | resp[6];
 937                 /* Current can be positive or negative */
 938                 info->current = (int16_t)((resp[7] << 8) | resp[8]);
 939                 info->voltage = (resp[9] << 8) | resp[10];
 940                 break;
 941         default:
 942                 device_printf(sc->sc_dev, "Unknown battery info format (%d)!\n",
 943                     resp[1]);
 944                 return (-1);
 945         }
 946
 947         return (0);
 948 }
 949
 950 static void
 951 pmu_battery_notify(struct pmu_battstate *batt, struct pmu_battstate *old)
 952 {
 953         char notify_buf[16];
 954         int new_acline, old_acline;
 955
 956         new_acline = (batt->state & PMU_PWR_AC_PRESENT) ? 1 : 0;
 957         old_acline = (old->state & PMU_PWR_AC_PRESENT) ? 1 : 0;
 958
 959         if (new_acline != old_acline) {
 960                 snprintf(notify_buf, sizeof(notify_buf),
 961                     "notify=0x%02x", new_acline);
 962                 devctl_notify("PMU", "POWER", "ACLINE", notify_buf);
 963         }
 964 }
 965
 966 static void
 967 pmu_battquery_proc()
 968 {
 969         struct pmu_softc *sc;
 970         struct pmu_battstate batt;
 971         struct pmu_battstate cur_batt;
 972         int error;
 973
 974         sc = device_get_softc(pmu);
 975
 976         bzero(&cur_batt, sizeof(cur_batt));
 977         while (1) {
 978                 kproc_suspend_check(curproc);
 979                 error = pmu_query_battery(sc, 0, &batt);
 980                 pmu_battery_notify(&batt, &cur_batt);
 981                 cur_batt = batt;
 982                 pause("pmu_batt", hz);
 983         }
 984 }
 985
 986 static int
 987 pmu_battmon(SYSCTL_HANDLER_ARGS)
 988 {
 989         struct pmu_softc *sc;
 990         int error, result;
 991
 992         sc = arg1;
 993         result = pmu_battmon_enabled;
 994
 995         error = sysctl_handle_int(oidp, &result, 0, req);
 996
 997         if (error || !req->newptr)
 998                 return (error);
 999
1000         if (!result && pmu_battmon_enabled)
1001                 error = kproc_suspend(pmubattproc, hz);
1002         else if (result && pmu_battmon_enabled == 0)
1003                 error = kproc_resume(pmubattproc);
1004         pmu_battmon_enabled = (result != 0);
1005
1006         return (error);
1007 }
1008
1009 static int
1010 pmu_acline_state(SYSCTL_HANDLER_ARGS)
1011 {
1012         struct pmu_softc *sc;
1013         struct pmu_battstate batt;
1014         int error, result;
1015
1016         sc = arg1;
1017
1018         /* The PMU treats the AC line status as a property of the battery */
1019         error = pmu_query_battery(sc, 0, &batt);
1020
1021         if (error != 0)
1022                 return (error);
1023
1024         result = (batt.state & PMU_PWR_AC_PRESENT) ? 1 : 0;
1025         error = sysctl_handle_int(oidp, &result, 0, req);
1026
1027         return (error);
1028 }
1029
1030 static int
1031 pmu_battquery_sysctl(SYSCTL_HANDLER_ARGS)
1032 {
1033         struct pmu_softc *sc;
1034         struct pmu_battstate batt;
1035         int error, result;
1036
1037         sc = arg1;
1038
1039         error = pmu_query_battery(sc, arg2 & 0x00ff, &batt);
1040
1041         if (error != 0)
1042                 return (error);
1043
1044         switch (arg2 & 0xff00) {
1045         case PMU_BATSYSCTL_PRESENT:
1046                 result = (batt.state & PMU_PWR_BATT_PRESENT) ? 1 : 0;
1047                 break;
1048         case PMU_BATSYSCTL_CHARGING:
1049                 result = (batt.state & PMU_PWR_BATT_CHARGING) ? 1 : 0;
1050                 break;
1051         case PMU_BATSYSCTL_CHARGE:
1052                 result = batt.charge;
1053                 break;
1054         case PMU_BATSYSCTL_MAXCHARGE:
1055                 result = batt.maxcharge;
1056                 break;
1057         case PMU_BATSYSCTL_CURRENT:
1058                 result = batt.current;
1059                 break;
1060         case PMU_BATSYSCTL_VOLTAGE:
1061                 result = batt.voltage;
1062                 break;
1063         case PMU_BATSYSCTL_TIME:
1064                 /* Time remaining until full charge/discharge, in minutes */
1065
1066                 if (batt.current >= 0)
1067                         result = (batt.maxcharge - batt.charge) /* mAh */ * 60
1068                             / batt.current /* mA */;
1069                 else
1070                         result = (batt.charge /* mAh */ * 60)
1071                             / (-batt.current /* mA */);
1072                 break;
1073         case PMU_BATSYSCTL_LIFE:
1074                 /* Battery charge fraction, in percent */
1075                 result = (batt.charge * 100) / batt.maxcharge;
1076                 break;
1077         default:
1078                 /* This should never happen */
1079                 result = -1;
1080         }
1081
1082         error = sysctl_handle_int(oidp, &result, 0, req);
1083
1084         return (error);
1085 }
1086
1087 #define DIFF19041970    2082844800
1088
1089 static int
1090 pmu_gettime(device_t dev, struct timespec *ts)
1091 {
1092         struct pmu_softc *sc = device_get_softc(dev);
1093         uint8_t resp[16];
1094         uint32_t sec;
1095
1096         mtx_lock(&sc->sc_mutex);
1097         pmu_send(sc, PMU_READ_RTC, 0, NULL, 16, resp);
1098         mtx_unlock(&sc->sc_mutex);
1099
1100         memcpy(&sec, &resp[1], 4);
1101         ts->tv_sec = sec - DIFF19041970;
1102         ts->tv_nsec = 0;
1103
1104         return (0);
1105 }
1106
1107 static int
1108 pmu_settime(device_t dev, struct timespec *ts)
1109 {
1110         struct pmu_softc *sc = device_get_softc(dev);
1111         uint32_t sec;
1112
1113         sec = ts->tv_sec + DIFF19041970;
1114
1115         mtx_lock(&sc->sc_mutex);
1116         pmu_send(sc, PMU_SET_RTC, sizeof(sec), (uint8_t *)&sec, 0, NULL);
1117         mtx_unlock(&sc->sc_mutex);
1118
1119         return (0);
1120 }
1121
1122 int
1123 pmu_set_speed(int low_speed)
1124 {
1125         struct pmu_softc *sc;
1126         uint8_t sleepcmd[] = {'W', 'O', 'O', 'F', 0};
1127         uint8_t resp[16];
1128
1129         sc = device_get_softc(pmu);
1130         pmu_write_reg(sc, vIER, 0x10);
1131         spinlock_enter();
1132         mtdec(0x7fffffff);
1133         mb();
1134         mtdec(0x7fffffff);
1135
1136         sleepcmd[4] = low_speed;
1137         pmu_send(sc, PMU_CPU_SPEED, 5, sleepcmd, 16, resp);
1138         unin_chip_sleep(NULL, 1);
1139         platform_sleep();
1140         unin_chip_wake(NULL);
1141
1142         mtdec(1);       /* Force a decrementer exception */
1143         spinlock_exit();
1144         pmu_write_reg(sc, vIER, 0x90);
1145
1146         return (0);
1147 }