sys/dev/acpica/acpi_acad.c

   1 /*-
   2  * Copyright (c) 2000 Takanori Watanabe
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/dev/acpica/acpi_acad.c,v 1.39 2009/06/05 18:44:36 jkim Exp
  27  */
  28
  29 #include "opt_acpi.h"
  30 #include <sys/param.h>
  31 #include <sys/kernel.h>
  32 #include <sys/bus.h>
  33
  34 #include <sys/rman.h>
  35 #include <sys/malloc.h>
  36 #include <sys/module.h>
  37 #include <sys/conf.h>
  38 #include <sys/power.h>
  39
  40 #include "acpi.h"
  41
  42 #include <dev/acpica/acpivar.h>
  43 #include <dev/acpica/acpiio.h>
  44 #include <bus/isa/isavar.h>
  45 #include <bus/isa/pnpvar.h>
  46
  47 /* Hooks for the ACPI CA debugging infrastructure */
  48 #define _COMPONENT      ACPI_AC_ADAPTER
  49 ACPI_MODULE_NAME("AC_ADAPTER")
  50
  51 /* Number of times to retry initialization before giving up. */
  52 #define ACPI_ACAD_RETRY_MAX             6
  53
  54 #define ACPI_POWERSOURCE_STAT_CHANGE    0x80
  55
  56 /*
  57  * _CST changed.
  58  * Also serves as notification code, when line is unplugged
  59  * on certain laptops.
  60  */
  61 #define ACPI_NOTIFY_CX_STATES           0x81
  62
  63 struct  acpi_acad_softc {
  64     int status;
  65 };
  66
  67 static void     acpi_acad_get_status(void *);
  68 static void     acpi_acad_notify_handler(ACPI_HANDLE, UINT32, void *);
  69 static int      acpi_acad_probe(device_t);
  70 static int      acpi_acad_attach(device_t);
  71 static int      acpi_acad_ioctl(u_long, caddr_t, void *);
  72 static int      acpi_acad_sysctl(SYSCTL_HANDLER_ARGS);
  73 static void     acpi_acad_init_acline(void *arg);
  74 static void     acpi_acad_ac_only(void *arg);
  75
  76 static device_method_t acpi_acad_methods[] = {
  77     /* Device interface */
  78     DEVMETHOD(device_probe,     acpi_acad_probe),
  79     DEVMETHOD(device_attach,    acpi_acad_attach),
  80
  81     DEVMETHOD_END
  82 };
  83
  84 static driver_t acpi_acad_driver = {
  85     "acpi_acad",
  86     acpi_acad_methods,
  87     sizeof(struct acpi_acad_softc),
  88 };
  89
  90 static devclass_t acpi_acad_devclass;
  91 DRIVER_MODULE(acpi_acad, acpi, acpi_acad_driver, acpi_acad_devclass, NULL, NULL);
  92 MODULE_DEPEND(acpi_acad, acpi, 1, 1, 1);
  93
  94 ACPI_SERIAL_DECL(acad, "ACPI AC adapter");
  95
  96 SYSINIT(acad, SI_SUB_KTHREAD_IDLE, SI_ORDER_FIRST, acpi_acad_ac_only, NULL);
  97
  98 static void
  99 acpi_acad_get_status(void *context)
 100 {
 101     struct acpi_acad_softc *sc;
 102     device_t    dev;
 103     ACPI_HANDLE h;
 104     int         newstatus;
 105
 106     dev = context;
 107     sc = device_get_softc(dev);
 108     h = acpi_get_handle(dev);
 109     newstatus = -1;
 110     acpi_GetInteger(h, "_PSR", &newstatus);
 111
 112     /* If status is valid and has changed, notify the system. */
 113     ACPI_SERIAL_BEGIN(acad);
 114     if (newstatus != -1 && sc->status != newstatus) {
 115         sc->status = newstatus;
 116         power_profile_set_state(newstatus ? POWER_PROFILE_PERFORMANCE :
 117             POWER_PROFILE_ECONOMY);
 118         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 119             "%s Line\n", newstatus ? "On" : "Off");
 120         acpi_UserNotify("ACAD", h, newstatus);
 121     }
 122     ACPI_SERIAL_END(acad);
 123 }
 124
 125 static void
 126 acpi_acad_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
 127 {
 128     device_t dev;
 129
 130     dev = (device_t)context;
 131     switch (notify) {
 132     case ACPI_NOTIFY_BUS_CHECK:
 133     case ACPI_NOTIFY_DEVICE_CHECK:
 134     case ACPI_POWERSOURCE_STAT_CHANGE:
 135     case ACPI_NOTIFY_CX_STATES:
 136         /* Temporarily.  It is better to notify policy manager */
 137         AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_get_status, context);
 138         break;
 139     default:
 140         if (bootverbose)
 141             device_printf(dev, "unknown notify %#x\n", notify);
 142         break;
 143     }
 144 }
 145
 146 static int
 147 acpi_acad_probe(device_t dev)
 148 {
 149     static char *acad_ids[] = { "ACPI0003", NULL };
 150
 151     if (acpi_disabled("acad") ||
 152         ACPI_ID_PROBE(device_get_parent(dev), dev, acad_ids) == NULL)
 153         return (ENXIO);
 154
 155     device_set_desc(dev, "AC Adapter");
 156     return (0);
 157 }
 158
 159 static int
 160 acpi_acad_attach(device_t dev)
 161 {
 162     struct acpi_acad_softc *sc;
 163     struct acpi_softc      *acpi_sc;
 164     ACPI_HANDLE handle;
 165     int         error;
 166
 167     sc = device_get_softc(dev);
 168     handle = acpi_get_handle(dev);
 169
 170     error = acpi_register_ioctl(ACPIIO_ACAD_GET_STATUS, acpi_acad_ioctl, dev);
 171     if (error != 0)
 172         return (error);
 173
 174     ACPI_SERIAL_INIT(acad);
 175
 176     if (device_get_unit(dev) == 0) {
 177         acpi_sc = acpi_device_get_parent_softc(dev);
 178         SYSCTL_ADD_PROC(&acpi_sc->acpi_sysctl_ctx,
 179                         SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
 180                         OID_AUTO, "acline", CTLTYPE_INT | CTLFLAG_RD,
 181                         &sc->status, 0, acpi_acad_sysctl, "I", "");
 182     }
 183
 184     /* Get initial status after whole system is up. */
 185     sc->status = -1;
 186
 187     /*
 188      * Install both system and device notify handlers since the Casio
 189      * FIVA needs them.
 190      */
 191     AcpiInstallNotifyHandler(handle, ACPI_ALL_NOTIFY,
 192                              acpi_acad_notify_handler, dev);
 193     AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_init_acline, dev);
 194
 195     return (0);
 196 }
 197
 198 static int
 199 acpi_acad_ioctl(u_long cmd, caddr_t addr, void *arg)
 200 {
 201     struct acpi_acad_softc *sc;
 202     device_t dev;
 203
 204     dev = (device_t)arg;
 205     sc = device_get_softc(dev);
 206
 207     /*
 208      * No security check required: information retrieval only.  If
 209      * new functions are added here, a check might be required.
 210      */
 211     switch (cmd) {
 212     case ACPIIO_ACAD_GET_STATUS:
 213         acpi_acad_get_status(dev);
 214         *(int *)addr = sc->status;
 215         break;
 216     default:
 217         break;
 218     }
 219
 220     return (0);
 221 }
 222
 223 static int
 224 acpi_acad_sysctl(SYSCTL_HANDLER_ARGS)
 225 {
 226     int val, error;
 227
 228     if (acpi_acad_get_acline(&val) != 0)
 229         return (ENXIO);
 230
 231     val = *(u_int *)oidp->oid_arg1;
 232     error = sysctl_handle_int(oidp, &val, 0, req);
 233     return (error);
 234 }
 235
 236 static void
 237 acpi_acad_init_acline(void *arg)
 238 {
 239     struct acpi_acad_softc *sc;
 240     device_t    dev;
 241     int         retry;
 242
 243     dev = (device_t)arg;
 244     sc = device_get_softc(dev);
 245     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 246                 "acline initialization start\n");
 247
 248     for (retry = 0; retry < ACPI_ACAD_RETRY_MAX; retry++) {
 249         acpi_acad_get_status(dev);
 250         if (sc->status != -1)
 251             break;
 252         AcpiOsSleep(10000);
 253     }
 254
 255     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 256                 "acline initialization done, tried %d times\n", retry + 1);
 257 }
 258
 259 /*
 260  * If no AC line devices detected after boot, create an "online" event
 261  * so that userland code can adjust power settings accordingly.  The default
 262  * power profile is "performance" so we don't need to repeat that here.
 263  */
 264 static void
 265 acpi_acad_ac_only(void __unused *arg)
 266 {
 267
 268     if (devclass_get_count(acpi_acad_devclass) == 0)
 269         acpi_UserNotify("ACAD", ACPI_ROOT_OBJECT, 1);
 270 }
 271
 272 /*
 273  * Public interfaces.
 274  */
 275 int
 276 acpi_acad_get_acline(int *status)
 277 {
 278     struct acpi_acad_softc *sc;
 279     device_t dev;
 280
 281     dev = devclass_get_device(acpi_acad_devclass, 0);
 282     if (dev == NULL)
 283         return (ENXIO);
 284     sc = device_get_softc(dev);
 285
 286     acpi_acad_get_status(dev);
 287     *status = sc->status;
 288
 289     return (0);
 290 }