sys/dev/acpica/acpi_lid.c

   1 /*-
   2  * Copyright (c) 2000 Takanori Watanabe <takawata@jp.freebsd.org>
   3  * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
   4  * Copyright (c) 2000 Michael Smith <msmith@freebd.org>
   5  * Copyright (c) 2000 BSDi
   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
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include "opt_acpi.h"
  34 #include <sys/param.h>
  35 #include <sys/kernel.h>
  36 #include <sys/module.h>
  37 #include <sys/bus.h>
  38 #include <sys/proc.h>
  39
  40 #include <contrib/dev/acpica/include/acpi.h>
  41 #include <contrib/dev/acpica/include/accommon.h>
  42
  43 #include <dev/acpica/acpivar.h>
  44
  45 /* Hooks for the ACPI CA debugging infrastructure */
  46 #define _COMPONENT      ACPI_BUTTON
  47 ACPI_MODULE_NAME("LID")
  48
  49 struct acpi_lid_softc {
  50     device_t    lid_dev;
  51     ACPI_HANDLE lid_handle;
  52     int         lid_status;     /* open or closed */
  53 };
  54
  55 ACPI_HANDLE acpi_lid_handle;
  56
  57 ACPI_SERIAL_DECL(lid, "ACPI lid");
  58
  59 static int      acpi_lid_probe(device_t dev);
  60 static int      acpi_lid_attach(device_t dev);
  61 static int      acpi_lid_suspend(device_t dev);
  62 static int      acpi_lid_resume(device_t dev);
  63 static void     acpi_lid_notify_status_changed(void *arg);
  64 static void     acpi_lid_notify_handler(ACPI_HANDLE h, UINT32 notify,
  65                                         void *context);
  66
  67 static device_method_t acpi_lid_methods[] = {
  68     /* Device interface */
  69     DEVMETHOD(device_probe,     acpi_lid_probe),
  70     DEVMETHOD(device_attach,    acpi_lid_attach),
  71     DEVMETHOD(device_suspend,   acpi_lid_suspend),
  72     DEVMETHOD(device_resume,    acpi_lid_resume),
  73
  74     DEVMETHOD_END
  75 };
  76
  77 static driver_t acpi_lid_driver = {
  78     "acpi_lid",
  79     acpi_lid_methods,
  80     sizeof(struct acpi_lid_softc),
  81 };
  82
  83 static devclass_t acpi_lid_devclass;
  84 DRIVER_MODULE(acpi_lid, acpi, acpi_lid_driver, acpi_lid_devclass, 0, 0);
  85 MODULE_DEPEND(acpi_lid, acpi, 1, 1, 1);
  86
  87 static int
  88 acpi_lid_probe(device_t dev)
  89 {
  90     static char *lid_ids[] = { "PNP0C0D", NULL };
  91
  92     if (acpi_disabled("lid") ||
  93         ACPI_ID_PROBE(device_get_parent(dev), dev, lid_ids) == NULL)
  94         return (ENXIO);
  95
  96     device_set_desc(dev, "Control Method Lid Switch");
  97     return (0);
  98 }
  99
 100 static int
 101 acpi_lid_attach(device_t dev)
 102 {
 103     struct acpi_prw_data        prw;
 104     struct acpi_lid_softc       *sc;
 105
 106     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 107
 108     sc = device_get_softc(dev);
 109     sc->lid_dev = dev;
 110     acpi_lid_handle = sc->lid_handle = acpi_get_handle(dev);
 111
 112     /*
 113      * If a system does not get lid events, it may make sense to change
 114      * the type to ACPI_ALL_NOTIFY.  Some systems generate both a wake and
 115      * runtime notify in that case though.
 116      */
 117     AcpiInstallNotifyHandler(sc->lid_handle, ACPI_DEVICE_NOTIFY,
 118                              acpi_lid_notify_handler, sc);
 119
 120     /* Enable the GPE for wake/runtime. */
 121     acpi_wake_set_enable(dev, 1);
 122     if (acpi_parse_prw(sc->lid_handle, &prw) == 0)
 123         AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit);
 124
 125     /*
 126      * Export the lid status
 127      */
 128     SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 129         SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
 130         "state", CTLFLAG_RD, &sc->lid_status, 0,
 131         "Device set to wake the system");
 132
 133     return (0);
 134 }
 135
 136 static int
 137 acpi_lid_suspend(device_t dev)
 138 {
 139     return (0);
 140 }
 141
 142 static int
 143 acpi_lid_resume(device_t dev)
 144 {
 145     return (0);
 146 }
 147
 148 static void
 149 acpi_lid_notify_status_changed(void *arg)
 150 {
 151     struct acpi_lid_softc       *sc;
 152     struct acpi_softc           *acpi_sc;
 153     ACPI_STATUS                 status;
 154
 155     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 156
 157     sc = (struct acpi_lid_softc *)arg;
 158     ACPI_SERIAL_BEGIN(lid);
 159
 160     /*
 161      * Evaluate _LID and check the return value, update lid status.
 162      *  Zero:           The lid is closed
 163      *  Non-zero:       The lid is open
 164      */
 165     status = acpi_GetInteger(sc->lid_handle, "_LID", &sc->lid_status);
 166     if (ACPI_FAILURE(status))
 167         goto out;
 168
 169     acpi_sc = acpi_device_get_parent_softc(sc->lid_dev);
 170     if (acpi_sc == NULL)
 171         goto out;
 172
 173     ACPI_VPRINT(sc->lid_dev, acpi_sc, "Lid %s\n",
 174                 sc->lid_status ? "opened" : "closed");
 175
 176     acpi_UserNotify("Lid", sc->lid_handle, sc->lid_status);
 177
 178     if (sc->lid_status == 0)
 179         EVENTHANDLER_INVOKE(acpi_sleep_event, acpi_sc->acpi_lid_switch_sx);
 180     else
 181         EVENTHANDLER_INVOKE(acpi_wakeup_event, acpi_sc->acpi_lid_switch_sx);
 182
 183 out:
 184     ACPI_SERIAL_END(lid);
 185     return_VOID;
 186 }
 187
 188 /* XXX maybe not here */
 189 #define ACPI_NOTIFY_STATUS_CHANGED      0x80
 190
 191 static void
 192 acpi_lid_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
 193 {
 194     struct acpi_lid_softc       *sc;
 195
 196     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
 197
 198     sc = (struct acpi_lid_softc *)context;
 199     switch (notify) {
 200     case ACPI_NOTIFY_STATUS_CHANGED:
 201         AcpiOsExecute(OSL_NOTIFY_HANDLER,
 202                       acpi_lid_notify_status_changed, sc);
 203         break;
 204     default:
 205         device_printf(sc->lid_dev, "unknown notify %#x\n", notify);
 206         break;
 207     }
 208
 209     return_VOID;
 210 }