xref: /freebsd/sys/dev/acpica/acpi_lid.c (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
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 #include "opt_acpi.h"
32 #include "opt_evdev.h"
33 #include <sys/param.h>
34 #include <sys/eventhandler.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 #ifdef EVDEV_SUPPORT
46 #include <dev/evdev/input.h>
47 #include <dev/evdev/evdev.h>
48 #endif
49 
50 /* Hooks for the ACPI CA debugging infrastructure */
51 #define _COMPONENT	ACPI_BUTTON
52 ACPI_MODULE_NAME("LID")
53 
54 struct acpi_lid_softc {
55     device_t	lid_dev;
56     ACPI_HANDLE	lid_handle;
57     int		lid_status;	/* open or closed */
58 #ifdef EVDEV_SUPPORT
59     struct evdev_dev *lid_evdev;
60 #endif
61 };
62 
63 ACPI_HANDLE acpi_lid_handle;
64 
65 ACPI_SERIAL_DECL(lid, "ACPI lid");
66 
67 static int	acpi_lid_probe(device_t dev);
68 static int	acpi_lid_attach(device_t dev);
69 static int	acpi_lid_suspend(device_t dev);
70 static int	acpi_lid_resume(device_t dev);
71 static void	acpi_lid_notify_status_changed(void *arg);
72 static void 	acpi_lid_notify_handler(ACPI_HANDLE h, UINT32 notify,
73 					void *context);
74 
75 static device_method_t acpi_lid_methods[] = {
76     /* Device interface */
77     DEVMETHOD(device_probe,	acpi_lid_probe),
78     DEVMETHOD(device_attach,	acpi_lid_attach),
79     DEVMETHOD(device_suspend,	acpi_lid_suspend),
80     DEVMETHOD(device_resume,	acpi_lid_resume),
81 
82     DEVMETHOD_END
83 };
84 
85 static driver_t acpi_lid_driver = {
86     "acpi_lid",
87     acpi_lid_methods,
88     sizeof(struct acpi_lid_softc),
89 };
90 
91 DRIVER_MODULE(acpi_lid, acpi, acpi_lid_driver, 0, 0);
92 MODULE_DEPEND(acpi_lid, acpi, 1, 1, 1);
93 
94 static void
95 acpi_lid_status_update(struct acpi_lid_softc *sc)
96 {
97 	ACPI_STATUS status;
98 	int lid_status;
99 
100 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
101 
102 	/*
103 	 * Evaluate _LID and check the return value, update lid status.
104 	 *	Zero:		The lid is closed
105 	 *	Non-zero:	The lid is open
106 	 */
107 	status = acpi_GetInteger(sc->lid_handle, "_LID", &lid_status);
108 	if (ACPI_FAILURE(status))
109 		lid_status = 1;		/* assume lid is opened */
110 
111 	/* range check value */
112 	sc->lid_status = lid_status ? 1 : 0;
113 
114 	/* Send notification via devd */
115 	acpi_UserNotify("Lid", sc->lid_handle, sc->lid_status);
116 
117 #ifdef EVDEV_SUPPORT
118 	/* Notify evdev about lid status */
119 	evdev_push_sw(sc->lid_evdev, SW_LID, lid_status ? 0 : 1);
120 	evdev_sync(sc->lid_evdev);
121 #endif
122 }
123 
124 static int
125 acpi_lid_probe(device_t dev)
126 {
127     static char *lid_ids[] = { "PNP0C0D", NULL };
128     int rv;
129 
130     if (acpi_disabled("lid"))
131 	return (ENXIO);
132     rv = ACPI_ID_PROBE(device_get_parent(dev), dev, lid_ids, NULL);
133     if (rv <= 0)
134 	device_set_desc(dev, "Control Method Lid Switch");
135     return (rv);
136 }
137 
138 static int
139 acpi_lid_attach(device_t dev)
140 {
141     struct acpi_prw_data	prw;
142     struct acpi_lid_softc	*sc;
143 
144     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
145 
146     sc = device_get_softc(dev);
147     sc->lid_dev = dev;
148     acpi_lid_handle = sc->lid_handle = acpi_get_handle(dev);
149 
150 #ifdef EVDEV_SUPPORT
151     /* Register evdev device before initial status update */
152     sc->lid_evdev = evdev_alloc();
153     evdev_set_name(sc->lid_evdev, device_get_desc(dev));
154     evdev_set_phys(sc->lid_evdev, device_get_nameunit(dev));
155     evdev_set_id(sc->lid_evdev, BUS_HOST, 0, 0, 1);
156     evdev_support_event(sc->lid_evdev, EV_SYN);
157     evdev_support_event(sc->lid_evdev, EV_SW);
158     evdev_support_sw(sc->lid_evdev, SW_LID);
159 
160     if (evdev_register(sc->lid_evdev))
161         return (ENXIO);
162 #endif
163 
164     /*
165      * If a system does not get lid events, it may make sense to change
166      * the type to ACPI_ALL_NOTIFY.  Some systems generate both a wake and
167      * runtime notify in that case though.
168      */
169     AcpiInstallNotifyHandler(sc->lid_handle, ACPI_DEVICE_NOTIFY,
170 			     acpi_lid_notify_handler, sc);
171 
172     /* Enable the GPE for wake/runtime. */
173     acpi_wake_set_enable(dev, 1);
174     if (acpi_parse_prw(sc->lid_handle, &prw) == 0)
175 	AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit);
176 
177     /* Get the initial lid status */
178     acpi_lid_status_update(sc);
179 
180     /*
181      * Export the lid status
182      */
183     SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
184 	SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
185 	"state", CTLFLAG_RD, &sc->lid_status, 0,
186 	"Device state (0 = closed, 1 = open)");
187 
188     return (0);
189 }
190 
191 static int
192 acpi_lid_suspend(device_t dev)
193 {
194     return (0);
195 }
196 
197 static int
198 acpi_lid_resume(device_t dev)
199 {
200     struct acpi_lid_softc	*sc;
201 
202     sc = device_get_softc(dev);
203 
204     /* Update lid status, if any */
205     acpi_lid_status_update(sc);
206 
207     return (0);
208 }
209 
210 static void
211 acpi_lid_notify_status_changed(void *arg)
212 {
213     struct acpi_lid_softc	*sc;
214     struct acpi_softc		*acpi_sc;
215 
216     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
217 
218     sc = (struct acpi_lid_softc *)arg;
219     ACPI_SERIAL_BEGIN(lid);
220 
221     /* Update lid status, if any */
222     acpi_lid_status_update(sc);
223 
224     acpi_sc = acpi_device_get_parent_softc(sc->lid_dev);
225     if (acpi_sc == NULL)
226 	goto out;
227 
228     ACPI_VPRINT(sc->lid_dev, acpi_sc, "Lid %s\n",
229 		sc->lid_status ? "opened" : "closed");
230 
231     acpi_UserNotify("Lid", sc->lid_handle, sc->lid_status);
232 
233     if (sc->lid_status == 0)
234 	EVENTHANDLER_INVOKE(acpi_sleep_event, acpi_sc->acpi_lid_switch_sx);
235     else
236 	EVENTHANDLER_INVOKE(acpi_wakeup_event, acpi_sc->acpi_lid_switch_sx);
237 
238 out:
239     ACPI_SERIAL_END(lid);
240     return_VOID;
241 }
242 
243 /* XXX maybe not here */
244 #define	ACPI_NOTIFY_STATUS_CHANGED	0x80
245 
246 static void
247 acpi_lid_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
248 {
249     struct acpi_lid_softc	*sc;
250 
251     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
252 
253     sc = (struct acpi_lid_softc *)context;
254     switch (notify) {
255     case ACPI_NOTIFY_STATUS_CHANGED:
256 	AcpiOsExecute(OSL_NOTIFY_HANDLER,
257 		      acpi_lid_notify_status_changed, sc);
258 	break;
259     default:
260 	device_printf(sc->lid_dev, "unknown notify %#x\n", notify);
261 	break;
262     }
263 
264     return_VOID;
265 }
266