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: head/sys/dev/acpica/acpi_button.c 125986 2004-02-19 05:35:20Z njl $
29 */
30
31#include "opt_acpi.h"
32#include <sys/param.h>
33#include <sys/kernel.h>
34#include <sys/bus.h>
35
36#include "acpi.h"
37#include <dev/acpica/acpivar.h>
38
39/* Hooks for the ACPI CA debugging infrastructure */
40#define _COMPONENT ACPI_BUTTON
41ACPI_MODULE_NAME("BUTTON")
42
43struct acpi_button_softc {
44 device_t button_dev;
45 ACPI_HANDLE button_handle;
46 boolean_t button_type;
47#define ACPI_POWER_BUTTON 0
48#define ACPI_SLEEP_BUTTON 1
49 boolean_t fixed;
50};
51
52#define ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP 0x80
53#define ACPI_NOTIFY_BUTTON_PRESSED_FOR_WAKEUP 0x02
54
55static int acpi_button_probe(device_t dev);
56static int acpi_button_attach(device_t dev);
57static int acpi_button_suspend(device_t dev);
58static int acpi_button_resume(device_t dev);
59static void acpi_button_notify_handler(ACPI_HANDLE h, UINT32 notify,
60 void *context);
61static ACPI_STATUS
62 acpi_button_fixed_handler(void *context);
63static void acpi_button_notify_sleep(void *arg);
64static void acpi_button_notify_wakeup(void *arg);
65
66static device_method_t acpi_button_methods[] = {
67 /* Device interface */
68 DEVMETHOD(device_probe, acpi_button_probe),
69 DEVMETHOD(device_attach, acpi_button_attach),
70 DEVMETHOD(device_suspend, acpi_button_suspend),
71 DEVMETHOD(device_shutdown, acpi_button_suspend),
72 DEVMETHOD(device_resume, acpi_button_resume),
73
74 {0, 0}
75};
76
77static driver_t acpi_button_driver = {
78 "acpi_button",
79 acpi_button_methods,
80 sizeof(struct acpi_button_softc),
81};
82
83static devclass_t acpi_button_devclass;
84DRIVER_MODULE(acpi_button, acpi, acpi_button_driver, acpi_button_devclass,
85 0, 0);
86
87static int
88acpi_button_probe(device_t dev)
89{
90 struct acpi_button_softc *sc;
91 int ret = ENXIO;
92
93 sc = device_get_softc(dev);
94 if (acpi_get_type(dev) == ACPI_TYPE_DEVICE && !acpi_disabled("button")) {
95 if (acpi_MatchHid(dev, "PNP0C0C")) {
96 device_set_desc(dev, "Power Button");
97 sc->button_type = ACPI_POWER_BUTTON;
98 ret = 0;
99 } else if (acpi_MatchHid(dev, "ACPI_FPB")) {
100 device_set_desc(dev, "Power Button (fixed)");
101 sc->button_type = ACPI_POWER_BUTTON;
102 sc->fixed = 1;
103 ret = 0;
104 } else if (acpi_MatchHid(dev, "PNP0C0E")) {
105 device_set_desc(dev, "Sleep Button");
106 sc->button_type = ACPI_SLEEP_BUTTON;
107 ret = 0;
108 } else if (acpi_MatchHid(dev, "ACPI_FSB")) {
109 device_set_desc(dev, "Sleep Button (fixed)");
110 sc->button_type = ACPI_SLEEP_BUTTON;
111 sc->fixed = 1;
112 ret = 0;
113 }
114 }
115 return (ret);
116}
117
118static int
119acpi_button_attach(device_t dev)
120{
121 struct acpi_button_softc *sc;
122 ACPI_STATUS status;
123 int event;
124
125 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
126
127 sc = device_get_softc(dev);
128 sc->button_dev = dev;
129 sc->button_handle = acpi_get_handle(dev);
130 event = (sc->button_type == ACPI_SLEEP_BUTTON) ?
131 ACPI_EVENT_SLEEP_BUTTON : ACPI_EVENT_POWER_BUTTON;
132
133 /* Install the appropriate new handler. */
134 if (sc->fixed) {
135 AcpiClearEvent(event);
136 status = AcpiInstallFixedEventHandler(event,
137 acpi_button_fixed_handler, sc);
138 } else {
139 status = AcpiInstallNotifyHandler(sc->button_handle,
140 ACPI_DEVICE_NOTIFY, acpi_button_notify_handler, sc);
141 }
142 if (ACPI_FAILURE(status)) {
143 device_printf(sc->button_dev, "couldn't install notify handler - %s\n",
144 AcpiFormatException(status));
145 return_VALUE (ENXIO);
146 }
147 acpi_device_enable_wake_capability(sc->button_handle, 1);
148
149 /*
150 * If we have fixed buttons defined in the FADT, remove them now that
151 * we have found one in the AML. Some systems define buttons both ways
152 * but only deliver events to the AML object.
153 */
154 if (event == ACPI_EVENT_POWER_BUTTON && AcpiGbl_FADT->PwrButton == 0)
155 AcpiRemoveFixedEventHandler(event, acpi_event_power_button_sleep);
156 if (event == ACPI_EVENT_SLEEP_BUTTON && AcpiGbl_FADT->SleepButton == 0)
157 AcpiRemoveFixedEventHandler(event, acpi_event_sleep_button_sleep);
158
159 return_VALUE (0);
160}
161
162static int
163acpi_button_suspend(device_t dev)
164{
165 struct acpi_button_softc *sc;
166
167 sc = device_get_softc(dev);
168 acpi_device_enable_wake_event(sc->button_handle);
169 return (0);
170}
171
172static int
173acpi_button_resume(device_t dev)
174{
175 return (0);
176}
177
178static void
179acpi_button_notify_sleep(void *arg)
180{
181 struct acpi_button_softc *sc;
182 struct acpi_softc *acpi_sc;
183
184 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
185
186 sc = (struct acpi_button_softc *)arg;
187 acpi_sc = acpi_device_get_parent_softc(sc->button_dev);
188 if (acpi_sc == NULL)
189 return_VOID;
190
191 acpi_UserNotify("Button", sc->button_handle, sc->button_type);
192
193 switch (sc->button_type) {
194 case ACPI_POWER_BUTTON:
195 ACPI_VPRINT(sc->button_dev, acpi_sc, "power button pressed\n");
196 acpi_event_power_button_sleep(acpi_sc);
197 break;
198 case ACPI_SLEEP_BUTTON:
199 ACPI_VPRINT(sc->button_dev, acpi_sc, "sleep button pressed\n");
200 acpi_event_sleep_button_sleep(acpi_sc);
201 break;
202 default:
203 break; /* unknown button type */
204 }
205}
206
207static void
208acpi_button_notify_wakeup(void *arg)
209{
210 struct acpi_button_softc *sc;
211 struct acpi_softc *acpi_sc;
212
213 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
214
215 sc = (struct acpi_button_softc *)arg;
216 acpi_sc = acpi_device_get_parent_softc(sc->button_dev);
217 if (acpi_sc == NULL)
218 return_VOID;
219
220 acpi_UserNotify("Button", sc->button_handle, sc->button_type);
221
222 switch (sc->button_type) {
223 case ACPI_POWER_BUTTON:
224 ACPI_VPRINT(sc->button_dev, acpi_sc, "wakeup by power button\n");
225 acpi_event_power_button_wake(acpi_sc);
226 break;
227 case ACPI_SLEEP_BUTTON:
228 ACPI_VPRINT(sc->button_dev, acpi_sc, "wakeup by sleep button\n");
229 acpi_event_sleep_button_wake(acpi_sc);
230 break;
231 default:
232 break; /* unknown button type */
233 }
234}
235
236static void
237acpi_button_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
238{
239 struct acpi_button_softc *sc = (struct acpi_button_softc *)context;
240
241 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
242
243 switch (notify) {
244 case ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP:
245 AcpiOsQueueForExecution(OSD_PRIORITY_LO,
246 acpi_button_notify_sleep, sc);
247 break;
248 case ACPI_NOTIFY_BUTTON_PRESSED_FOR_WAKEUP:
249 AcpiOsQueueForExecution(OSD_PRIORITY_LO,
250 acpi_button_notify_wakeup, sc);
251 break;
252 default:
253 break; /* unknown notification value */
254 }
255}
256
257static ACPI_STATUS
258acpi_button_fixed_handler(void *context)
259{
260 struct acpi_button_softc *sc = (struct acpi_button_softc *)context;
261
262 ACPI_FUNCTION_TRACE_PTR((char *)(uintptr_t)__func__, context);
263
264 if (context == NULL)
265 return_ACPI_STATUS (AE_BAD_PARAMETER);
266
267 acpi_button_notify_handler(sc->button_handle,
268 ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP, sc);
269 return_ACPI_STATUS (AE_OK);
270}