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