1 /*-
2 * Copyright (c) 2000 Mitsaru IWASAKI <iwasaki@jp.freebsd.org>
3 * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
4 * Copyright (c) 2000 BSDi
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: src/sys/dev/acpica/acpi_button.c,v 1.33 2009/06/05 18:44:36 jkim Exp
29 */
30
31 #include "opt_acpi.h"
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/bus.h>
36
37 #include "acpi.h"
38 #include "accommon.h"
39
40 #include <dev/acpica/acpivar.h>
41
42 /* Hooks for the ACPICA debugging infrastructure */
43 #define _COMPONENT ACPI_BUTTON
44 ACPI_MODULE_NAME("BUTTON")
45
46 struct acpi_button_softc {
47 device_t button_dev;
48 ACPI_HANDLE button_handle;
49 int button_type;
50 #define ACPI_POWER_BUTTON 0
51 #define ACPI_SLEEP_BUTTON 1
52 boolean_t fixed;
53 };
54
55 #define ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP 0x80
56 #define ACPI_NOTIFY_BUTTON_PRESSED_FOR_WAKEUP 0x02
57
58 static int acpi_button_probe(device_t dev);
59 static int acpi_button_attach(device_t dev);
60 static int acpi_button_suspend(device_t dev);
61 static int acpi_button_resume(device_t dev);
62 static void acpi_button_notify_handler(ACPI_HANDLE h, UINT32 notify,
63 void *context);
64 static ACPI_STATUS
65 acpi_button_fixed_handler(void *context);
66 static void acpi_button_notify_sleep(void *arg);
67 static void acpi_button_notify_wakeup(void *arg);
68
69 static char *btn_ids[] = {
70 "PNP0C0C", "ACPI_FPB", "PNP0C0E", "ACPI_FSB",
71 NULL
72 };
73
74 static device_method_t acpi_button_methods[] = {
75 /* Device interface */
76 DEVMETHOD(device_probe, acpi_button_probe),
77 DEVMETHOD(device_attach, acpi_button_attach),
78 DEVMETHOD(device_suspend, acpi_button_suspend),
79 DEVMETHOD(device_shutdown, acpi_button_suspend),
80 DEVMETHOD(device_resume, acpi_button_resume),
81
82 DEVMETHOD_END
83 };
84
85 static driver_t acpi_button_driver = {
86 "acpi_button",
87 acpi_button_methods,
88 sizeof(struct acpi_button_softc),
89 .gpri = KOBJ_GPRI_ACPI
90 };
91
92 static devclass_t acpi_button_devclass;
93 DRIVER_MODULE(acpi_button, acpi, acpi_button_driver, acpi_button_devclass,
94 NULL, NULL);
95 MODULE_DEPEND(acpi_button, acpi, 1, 1, 1);
96
97 static int
acpi_button_probe(device_t dev)98 acpi_button_probe(device_t dev)
99 {
100 struct acpi_button_softc *sc;
101 char *str;
102
103 if (acpi_disabled("button") ||
104 (str = ACPI_ID_PROBE(device_get_parent(dev), dev, btn_ids)) == NULL)
105 return (ENXIO);
106
107 sc = device_get_softc(dev);
108 if (strcmp(str, "PNP0C0C") == 0) {
109 device_set_desc(dev, "Power Button");
110 sc->button_type = ACPI_POWER_BUTTON;
111 } else if (strcmp(str, "ACPI_FPB") == 0) {
112 device_set_desc(dev, "Power Button (fixed)");
113 sc->button_type = ACPI_POWER_BUTTON;
114 sc->fixed = 1;
115 } else if (strcmp(str, "PNP0C0E") == 0) {
116 device_set_desc(dev, "Sleep Button");
117 sc->button_type = ACPI_SLEEP_BUTTON;
118 } else if (strcmp(str, "ACPI_FSB") == 0) {
119 device_set_desc(dev, "Sleep Button (fixed)");
120 sc->button_type = ACPI_SLEEP_BUTTON;
121 sc->fixed = 1;
122 }
123
124 return (0);
125 }
126
127 static int
acpi_button_attach(device_t dev)128 acpi_button_attach(device_t dev)
129 {
130 struct acpi_prw_data prw;
131 struct acpi_button_softc *sc;
132 ACPI_STATUS status;
133 int event;
134
135 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
136
137 sc = device_get_softc(dev);
138 sc->button_dev = dev;
139 sc->button_handle = acpi_get_handle(dev);
140 event = (sc->button_type == ACPI_SLEEP_BUTTON) ?
141 ACPI_EVENT_SLEEP_BUTTON : ACPI_EVENT_POWER_BUTTON;
142
143 /*
144 * Install the new handler. We could remove any fixed handlers added
145 * from the FADT once we have a duplicate from the AML but some systems
146 * only return events on one or the other so we have to keep both.
147 */
148 if (sc->fixed) {
149 AcpiClearEvent(event);
150 status = AcpiInstallFixedEventHandler(event,
151 acpi_button_fixed_handler, sc);
152 } else {
153 /*
154 * If a system does not get lid events, it may make sense to change
155 * the type to ACPI_ALL_NOTIFY. Some systems generate both a wake
156 * and runtime notify in that case though.
157 */
158 status = AcpiInstallNotifyHandler(sc->button_handle,
159 ACPI_DEVICE_NOTIFY, acpi_button_notify_handler, sc);
160 }
161 if (ACPI_FAILURE(status)) {
162 device_printf(sc->button_dev, "couldn't install notify handler - %s\n",
163 AcpiFormatException(status));
164 return_VALUE (ENXIO);
165 }
166
167 /* Enable the GPE for wake/runtime */
168 acpi_wake_set_enable(dev, 1);
169 if (acpi_parse_prw(sc->button_handle, &prw) == 0)
170 AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit);
171
172 return_VALUE (0);
173 }
174
175 static int
acpi_button_suspend(device_t dev)176 acpi_button_suspend(device_t dev)
177 {
178 return (0);
179 }
180
181 static int
acpi_button_resume(device_t dev)182 acpi_button_resume(device_t dev)
183 {
184 return (0);
185 }
186
187 static void
acpi_button_notify_sleep(void * arg)188 acpi_button_notify_sleep(void *arg)
189 {
190 struct acpi_button_softc *sc;
191 struct acpi_softc *acpi_sc;
192
193 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
194
195 sc = (struct acpi_button_softc *)arg;
196 acpi_sc = acpi_device_get_parent_softc(sc->button_dev);
197 if (acpi_sc == NULL)
198 return_VOID;
199
200 acpi_UserNotify("Button", sc->button_handle, sc->button_type);
201
202 switch (sc->button_type) {
203 case ACPI_POWER_BUTTON:
204 ACPI_VPRINT(sc->button_dev, acpi_sc, "power button pressed\n");
205 acpi_event_power_button_sleep(acpi_sc);
206 break;
207 case ACPI_SLEEP_BUTTON:
208 ACPI_VPRINT(sc->button_dev, acpi_sc, "sleep button pressed\n");
209 acpi_event_sleep_button_sleep(acpi_sc);
210 break;
211 default:
212 break; /* unknown button type */
213 }
214 }
215
216 static void
acpi_button_notify_wakeup(void * arg)217 acpi_button_notify_wakeup(void *arg)
218 {
219 struct acpi_button_softc *sc;
220 struct acpi_softc *acpi_sc;
221
222 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
223
224 sc = (struct acpi_button_softc *)arg;
225 acpi_sc = acpi_device_get_parent_softc(sc->button_dev);
226 if (acpi_sc == NULL)
227 return_VOID;
228
229 acpi_UserNotify("Button", sc->button_handle, sc->button_type);
230
231 switch (sc->button_type) {
232 case ACPI_POWER_BUTTON:
233 ACPI_VPRINT(sc->button_dev, acpi_sc, "wakeup by power button\n");
234 acpi_event_power_button_wake(acpi_sc);
235 break;
236 case ACPI_SLEEP_BUTTON:
237 ACPI_VPRINT(sc->button_dev, acpi_sc, "wakeup by sleep button\n");
238 acpi_event_sleep_button_wake(acpi_sc);
239 break;
240 default:
241 break; /* unknown button type */
242 }
243 }
244
245 static void
acpi_button_notify_handler(ACPI_HANDLE h,UINT32 notify,void * context)246 acpi_button_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
247 {
248 struct acpi_button_softc *sc;
249
250 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
251
252 sc = (struct acpi_button_softc *)context;
253 switch (notify) {
254 case ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP:
255 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_button_notify_sleep, sc);
256 break;
257 case ACPI_NOTIFY_BUTTON_PRESSED_FOR_WAKEUP:
258 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_button_notify_wakeup, sc);
259 break;
260 default:
261 device_printf(sc->button_dev, "unknown notify: %#x\n", notify);
262 break;
263 }
264 }
265
266 static ACPI_STATUS
acpi_button_fixed_handler(void * context)267 acpi_button_fixed_handler(void *context)
268 {
269 struct acpi_button_softc *sc = (struct acpi_button_softc *)context;
270
271 ACPI_FUNCTION_TRACE_PTR((char *)(uintptr_t)__func__, context);
272
273 if (context == NULL)
274 return_ACPI_STATUS (AE_BAD_PARAMETER);
275
276 acpi_button_notify_handler(sc->button_handle,
277 ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP, sc);
278 return_ACPI_STATUS (AE_OK);
279 }
280