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