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