xref: /freebsd/sys/dev/acpica/acpi_lid.c (revision d34048812292b714a0bf99967270d18fe3097c62)
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     int rv;
92 
93     if (acpi_disabled("lid"))
94 	return (ENXIO);
95     rv = ACPI_ID_PROBE(device_get_parent(dev), dev, lid_ids, NULL);
96     if (rv <= 0)
97 	device_set_desc(dev, "Control Method Lid Switch");
98     return (rv);
99 }
100 
101 static int
102 acpi_lid_attach(device_t dev)
103 {
104     struct acpi_prw_data	prw;
105     struct acpi_lid_softc	*sc;
106 
107     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
108 
109     sc = device_get_softc(dev);
110     sc->lid_dev = dev;
111     acpi_lid_handle = sc->lid_handle = acpi_get_handle(dev);
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     /*
127      * Export the lid status
128      */
129     SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
130 	SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
131 	"state", CTLFLAG_RD, &sc->lid_status, 0,
132 	"Device set to wake the system");
133 
134     return (0);
135 }
136 
137 static int
138 acpi_lid_suspend(device_t dev)
139 {
140     return (0);
141 }
142 
143 static int
144 acpi_lid_resume(device_t dev)
145 {
146     return (0);
147 }
148 
149 static void
150 acpi_lid_notify_status_changed(void *arg)
151 {
152     struct acpi_lid_softc	*sc;
153     struct acpi_softc		*acpi_sc;
154     ACPI_STATUS			status;
155 
156     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
157 
158     sc = (struct acpi_lid_softc *)arg;
159     ACPI_SERIAL_BEGIN(lid);
160 
161     /*
162      * Evaluate _LID and check the return value, update lid status.
163      *	Zero:		The lid is closed
164      *	Non-zero:	The lid is open
165      */
166     status = acpi_GetInteger(sc->lid_handle, "_LID", &sc->lid_status);
167     if (ACPI_FAILURE(status))
168 	goto out;
169 
170     acpi_sc = acpi_device_get_parent_softc(sc->lid_dev);
171     if (acpi_sc == NULL)
172 	goto out;
173 
174     ACPI_VPRINT(sc->lid_dev, acpi_sc, "Lid %s\n",
175 		sc->lid_status ? "opened" : "closed");
176 
177     acpi_UserNotify("Lid", sc->lid_handle, sc->lid_status);
178 
179     if (sc->lid_status == 0)
180 	EVENTHANDLER_INVOKE(acpi_sleep_event, acpi_sc->acpi_lid_switch_sx);
181     else
182 	EVENTHANDLER_INVOKE(acpi_wakeup_event, acpi_sc->acpi_lid_switch_sx);
183 
184 out:
185     ACPI_SERIAL_END(lid);
186     return_VOID;
187 }
188 
189 /* XXX maybe not here */
190 #define	ACPI_NOTIFY_STATUS_CHANGED	0x80
191 
192 static void
193 acpi_lid_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
194 {
195     struct acpi_lid_softc	*sc;
196 
197     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
198 
199     sc = (struct acpi_lid_softc *)context;
200     switch (notify) {
201     case ACPI_NOTIFY_STATUS_CHANGED:
202 	AcpiOsExecute(OSL_NOTIFY_HANDLER,
203 		      acpi_lid_notify_status_changed, sc);
204 	break;
205     default:
206 	device_printf(sc->lid_dev, "unknown notify %#x\n", notify);
207 	break;
208     }
209 
210     return_VOID;
211 }
212