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
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_acpi.h"
  31 #include <sys/param.h>
  32 #include <sys/kernel.h>
  33 #include <sys/bus.h>
  34
  35 #include <machine/bus.h>
  36 #include <sys/rman.h>
  37 #include <sys/ioccom.h>
  38 #include <sys/malloc.h>
  39 #include <sys/module.h>
  40 #include <sys/conf.h>
  41 #include <sys/power.h>
  42
  43 #include <contrib/dev/acpica/include/acpi.h>
  44
  45 #include <dev/acpica/acpivar.h>
  46 #include <dev/acpica/acpiio.h>
  47 #include <isa/isavar.h>
  48 #include <isa/pnpvar.h>
  49
  50 /* Hooks for the ACPI CA debugging infrastructure */
  51 #define _COMPONENT      ACPI_AC_ADAPTER
  52 ACPI_MODULE_NAME("AC_ADAPTER")
  53
  54 /* Number of times to retry initialization before giving up. */
  55 #define ACPI_ACAD_RETRY_MAX             6
  56
  57 #define ACPI_POWERSOURCE_STAT_CHANGE    0x80
  58
  59 struct  acpi_acad_softc {
  60     int status;
  61 };
  62
  63 static void     acpi_acad_get_status(void *);
  64 static void     acpi_acad_notify_handler(ACPI_HANDLE, UINT32, void *);
  65 static int      acpi_acad_probe(device_t);
  66 static int      acpi_acad_attach(device_t);
  67 static int      acpi_acad_ioctl(u_long, caddr_t, void *);
  68 static int      acpi_acad_sysctl(SYSCTL_HANDLER_ARGS);
  69 static void     acpi_acad_init_acline(void *arg);
  70 static void     acpi_acad_ac_only(void *arg);
  71
  72 static device_method_t acpi_acad_methods[] = {
  73     /* Device interface */
  74     DEVMETHOD(device_probe,     acpi_acad_probe),
  75     DEVMETHOD(device_attach,    acpi_acad_attach),
  76
  77     DEVMETHOD_END
  78 };
  79
  80 static driver_t acpi_acad_driver = {
  81     "acpi_acad",
  82     acpi_acad_methods,
  83     sizeof(struct acpi_acad_softc),
  84 };
  85
  86 static devclass_t acpi_acad_devclass;
  87 DRIVER_MODULE(acpi_acad, acpi, acpi_acad_driver, acpi_acad_devclass, 0, 0);
  88 MODULE_DEPEND(acpi_acad, acpi, 1, 1, 1);
  89
  90 ACPI_SERIAL_DECL(acad, "ACPI AC adapter");
  91
  92 SYSINIT(acad, SI_SUB_KTHREAD_IDLE, SI_ORDER_FIRST, acpi_acad_ac_only, NULL);
  93
  94 static void
  95 acpi_acad_get_status(void *context)
  96 {
  97     struct acpi_acad_softc *sc;
  98     device_t    dev;
  99     ACPI_HANDLE h;
 100     int         newstatus;
 101
 102     dev = context;
 103     sc = device_get_softc(dev);
 104     h = acpi_get_handle(dev);
 105     newstatus = -1;
 106     acpi_GetInteger(h, "_PSR", &newstatus);
 107
 108     /* If status is valid and has changed, notify the system. */
 109     ACPI_SERIAL_BEGIN(acad);
 110     if (newstatus != -1 && sc->status != newstatus) {
 111         sc->status = newstatus;
 112         ACPI_SERIAL_END(acad);
 113         power_profile_set_state(newstatus ? POWER_PROFILE_PERFORMANCE :
 114             POWER_PROFILE_ECONOMY);
 115         ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 116             "%s Line\n", newstatus ? "On" : "Off");
 117         acpi_UserNotify("ACAD", h, newstatus);
 118     } else
 119         ACPI_SERIAL_END(acad);
 120 }
 121
 122 static void
 123 acpi_acad_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
 124 {
 125     device_t dev;
 126
 127     dev = (device_t)context;
 128     switch (notify) {
 129     case ACPI_NOTIFY_BUS_CHECK:
 130     case ACPI_NOTIFY_DEVICE_CHECK:
 131     case ACPI_POWERSOURCE_STAT_CHANGE:
 132         /* Temporarily.  It is better to notify policy manager */
 133         AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_get_status, context);
 134         break;
 135     default:
 136         device_printf(dev, "unknown notify %#x\n", notify);
 137         break;
 138     }
 139 }
 140
 141 static int
 142 acpi_acad_probe(device_t dev)
 143 {
 144     static char *acad_ids[] = { "ACPI0003", NULL };
 145
 146     if (acpi_disabled("acad") ||
 147         ACPI_ID_PROBE(device_get_parent(dev), dev, acad_ids) == NULL)
 148         return (ENXIO);
 149
 150     device_set_desc(dev, "AC Adapter");
 151     return (0);
 152 }
 153
 154 static int
 155 acpi_acad_attach(device_t dev)
 156 {
 157     struct acpi_acad_softc *sc;
 158     struct acpi_softc      *acpi_sc;
 159     ACPI_HANDLE handle;
 160     int         error;
 161
 162     sc = device_get_softc(dev);
 163     handle = acpi_get_handle(dev);
 164
 165     error = acpi_register_ioctl(ACPIIO_ACAD_GET_STATUS, acpi_acad_ioctl, dev);
 166     if (error != 0)
 167         return (error);
 168
 169     if (device_get_unit(dev) == 0) {
 170         acpi_sc = acpi_device_get_parent_softc(dev);
 171         SYSCTL_ADD_PROC(&acpi_sc->acpi_sysctl_ctx,
 172                         SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
 173                         OID_AUTO, "acline", CTLTYPE_INT | CTLFLAG_RD,
 174                         &sc->status, 0, acpi_acad_sysctl, "I", "");
 175     }
 176
 177     /* Get initial status after whole system is up. */
 178     sc->status = -1;
 179
 180     /*
 181      * Install both system and device notify handlers since the Casio
 182      * FIVA needs them.
 183      */
 184     AcpiInstallNotifyHandler(handle, ACPI_ALL_NOTIFY,
 185                              acpi_acad_notify_handler, dev);
 186     AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_acad_init_acline, dev);
 187
 188     return (0);
 189 }
 190
 191 static int
 192 acpi_acad_ioctl(u_long cmd, caddr_t addr, void *arg)
 193 {
 194     struct acpi_acad_softc *sc;
 195     device_t dev;
 196
 197     dev = (device_t)arg;
 198     sc = device_get_softc(dev);
 199
 200     /*
 201      * No security check required: information retrieval only.  If
 202      * new functions are added here, a check might be required.
 203      */
 204     switch (cmd) {
 205     case ACPIIO_ACAD_GET_STATUS:
 206         acpi_acad_get_status(dev);
 207         *(int *)addr = sc->status;
 208         break;
 209     default:
 210         break;
 211     }
 212
 213     return (0);
 214 }
 215
 216 static int
 217 acpi_acad_sysctl(SYSCTL_HANDLER_ARGS)
 218 {
 219     int val, error;
 220
 221     if (acpi_acad_get_acline(&val) != 0)
 222         return (ENXIO);
 223
 224     val = *(u_int *)oidp->oid_arg1;
 225     error = sysctl_handle_int(oidp, &val, 0, req);
 226     return (error);
 227 }
 228
 229 static void
 230 acpi_acad_init_acline(void *arg)
 231 {
 232     struct acpi_acad_softc *sc;
 233     device_t    dev;
 234     int         retry;
 235
 236     dev = (device_t)arg;
 237     sc = device_get_softc(dev);
 238     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 239                 "acline initialization start\n");
 240
 241     for (retry = 0; retry < ACPI_ACAD_RETRY_MAX; retry++) {
 242         acpi_acad_get_status(dev);
 243         if (sc->status != -1)
 244             break;
 245         AcpiOsSleep(10000);
 246     }
 247
 248     ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
 249                 "acline initialization done, tried %d times\n", retry + 1);
 250 }
 251
 252 /*
 253  * If no AC line devices detected after boot, create an "online" event
 254  * so that userland code can adjust power settings accordingly.  The default
 255  * power profile is "performance" so we don't need to repeat that here.
 256  */
 257 static void
 258 acpi_acad_ac_only(void __unused *arg)
 259 {
 260
 261     if (devclass_get_count(acpi_acad_devclass) == 0)
 262         acpi_UserNotify("ACAD", ACPI_ROOT_OBJECT, 1);
 263 }
 264
 265 /*
 266  * Public interfaces.
 267  */
 268 int
 269 acpi_acad_get_acline(int *status)
 270 {
 271     struct acpi_acad_softc *sc;
 272     device_t dev;
 273
 274     dev = devclass_get_device(acpi_acad_devclass, 0);
 275     if (dev == NULL)
 276         return (ENXIO);
 277     sc = device_get_softc(dev);
 278
 279     acpi_acad_get_status(dev);
 280     *status = sc->status;
 281
 282     return (0);
 283 }