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 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include "opt_acpi.h" 33 #include "opt_evdev.h" 34 #include <sys/param.h> 35 #include <sys/kernel.h> 36 #include <sys/module.h> 37 #include <sys/bus.h> 38 39 #include <contrib/dev/acpica/include/acpi.h> 40 #include <contrib/dev/acpica/include/accommon.h> 41 42 #include <dev/acpica/acpivar.h> 43 44 #ifdef EVDEV_SUPPORT 45 #include <dev/evdev/input.h> 46 #include <dev/evdev/evdev.h> 47 #endif 48 49 /* Hooks for the ACPI CA debugging infrastructure */ 50 #define _COMPONENT ACPI_BUTTON 51 ACPI_MODULE_NAME("BUTTON") 52 53 struct acpi_button_softc { 54 device_t button_dev; 55 ACPI_HANDLE button_handle; 56 boolean_t button_type; 57 #define ACPI_POWER_BUTTON 0 58 #define ACPI_SLEEP_BUTTON 1 59 boolean_t fixed; 60 #ifdef EVDEV_SUPPORT 61 struct evdev_dev *button_evdev; 62 #endif 63 }; 64 65 #define ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP 0x80 66 #define ACPI_NOTIFY_BUTTON_PRESSED_FOR_WAKEUP 0x02 67 68 static int acpi_button_probe(device_t dev); 69 static int acpi_button_attach(device_t dev); 70 static int acpi_button_suspend(device_t dev); 71 static int acpi_button_resume(device_t dev); 72 static void acpi_button_notify_handler(ACPI_HANDLE h, UINT32 notify, 73 void *context); 74 static ACPI_STATUS 75 acpi_button_fixed_handler(void *context); 76 static void acpi_button_notify_sleep(void *arg); 77 static void acpi_button_notify_wakeup(void *arg); 78 79 static char *btn_ids[] = { 80 "PNP0C0C", "ACPI_FPB", "PNP0C0E", "ACPI_FSB", 81 NULL 82 }; 83 84 static device_method_t acpi_button_methods[] = { 85 /* Device interface */ 86 DEVMETHOD(device_probe, acpi_button_probe), 87 DEVMETHOD(device_attach, acpi_button_attach), 88 DEVMETHOD(device_suspend, acpi_button_suspend), 89 DEVMETHOD(device_shutdown, acpi_button_suspend), 90 DEVMETHOD(device_resume, acpi_button_resume), 91 DEVMETHOD_END 92 }; 93 94 static driver_t acpi_button_driver = { 95 "acpi_button", 96 acpi_button_methods, 97 sizeof(struct acpi_button_softc), 98 }; 99 100 DRIVER_MODULE(acpi_button, acpi, acpi_button_driver, 0, 0); 101 MODULE_DEPEND(acpi_button, acpi, 1, 1, 1); 102 103 static int 104 acpi_button_probe(device_t dev) 105 { 106 struct acpi_button_softc *sc; 107 char *str; 108 int rv; 109 110 if (acpi_disabled("button")) 111 return (ENXIO); 112 rv = ACPI_ID_PROBE(device_get_parent(dev), dev, btn_ids, &str); 113 if (rv > 0) 114 return (ENXIO); 115 116 sc = device_get_softc(dev); 117 if (strcmp(str, "PNP0C0C") == 0) { 118 device_set_desc(dev, "Power Button"); 119 sc->button_type = ACPI_POWER_BUTTON; 120 } else if (strcmp(str, "ACPI_FPB") == 0) { 121 device_set_desc(dev, "Power Button (fixed)"); 122 sc->button_type = ACPI_POWER_BUTTON; 123 sc->fixed = 1; 124 } else if (strcmp(str, "PNP0C0E") == 0) { 125 device_set_desc(dev, "Sleep Button"); 126 sc->button_type = ACPI_SLEEP_BUTTON; 127 } else if (strcmp(str, "ACPI_FSB") == 0) { 128 device_set_desc(dev, "Sleep Button (fixed)"); 129 sc->button_type = ACPI_SLEEP_BUTTON; 130 sc->fixed = 1; 131 } 132 133 return (rv); 134 } 135 136 static int 137 acpi_button_attach(device_t dev) 138 { 139 struct acpi_prw_data prw; 140 struct acpi_button_softc *sc; 141 ACPI_STATUS status; 142 int event; 143 144 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 145 146 sc = device_get_softc(dev); 147 sc->button_dev = dev; 148 sc->button_handle = acpi_get_handle(dev); 149 event = (sc->button_type == ACPI_SLEEP_BUTTON) ? 150 ACPI_EVENT_SLEEP_BUTTON : ACPI_EVENT_POWER_BUTTON; 151 152 #ifdef EVDEV_SUPPORT 153 sc->button_evdev = evdev_alloc(); 154 evdev_set_name(sc->button_evdev, device_get_desc(dev)); 155 evdev_set_phys(sc->button_evdev, device_get_nameunit(dev)); 156 evdev_set_id(sc->button_evdev, BUS_HOST, 0, 0, 1); 157 evdev_support_event(sc->button_evdev, EV_SYN); 158 evdev_support_event(sc->button_evdev, EV_KEY); 159 evdev_support_key(sc->button_evdev, 160 (sc->button_type == ACPI_SLEEP_BUTTON) ? KEY_SLEEP : KEY_POWER); 161 162 if (evdev_register(sc->button_evdev)) 163 return (ENXIO); 164 #endif 165 166 /* 167 * Install the new handler. We could remove any fixed handlers added 168 * from the FADT once we have a duplicate from the AML but some systems 169 * only return events on one or the other so we have to keep both. 170 */ 171 if (sc->fixed) { 172 AcpiClearEvent(event); 173 status = AcpiInstallFixedEventHandler(event, 174 acpi_button_fixed_handler, sc); 175 } else { 176 /* 177 * If a system does not get lid events, it may make sense to change 178 * the type to ACPI_ALL_NOTIFY. Some systems generate both a wake 179 * and runtime notify in that case though. 180 */ 181 status = AcpiInstallNotifyHandler(sc->button_handle, 182 ACPI_DEVICE_NOTIFY, acpi_button_notify_handler, sc); 183 } 184 if (ACPI_FAILURE(status)) { 185 device_printf(sc->button_dev, "couldn't install notify handler - %s\n", 186 AcpiFormatException(status)); 187 return_VALUE (ENXIO); 188 } 189 190 /* Enable the GPE for wake/runtime. */ 191 acpi_wake_set_enable(dev, 1); 192 if (acpi_parse_prw(sc->button_handle, &prw) == 0) 193 AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit); 194 195 return_VALUE (0); 196 } 197 198 static int 199 acpi_button_suspend(device_t dev) 200 { 201 return (0); 202 } 203 204 static int 205 acpi_button_resume(device_t dev) 206 { 207 return (0); 208 } 209 210 static void 211 acpi_button_notify_sleep(void *arg) 212 { 213 struct acpi_button_softc *sc; 214 struct acpi_softc *acpi_sc; 215 216 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 217 218 sc = (struct acpi_button_softc *)arg; 219 acpi_sc = acpi_device_get_parent_softc(sc->button_dev); 220 if (acpi_sc == NULL) 221 return_VOID; 222 223 acpi_UserNotify("Button", sc->button_handle, sc->button_type); 224 225 switch (sc->button_type) { 226 case ACPI_POWER_BUTTON: 227 ACPI_VPRINT(sc->button_dev, acpi_sc, "power button pressed\n"); 228 acpi_event_power_button_sleep(acpi_sc); 229 break; 230 case ACPI_SLEEP_BUTTON: 231 ACPI_VPRINT(sc->button_dev, acpi_sc, "sleep button pressed\n"); 232 acpi_event_sleep_button_sleep(acpi_sc); 233 break; 234 default: 235 break; /* unknown button type */ 236 } 237 } 238 239 static void 240 acpi_button_notify_wakeup(void *arg) 241 { 242 struct acpi_button_softc *sc; 243 struct acpi_softc *acpi_sc; 244 245 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 246 247 sc = (struct acpi_button_softc *)arg; 248 acpi_sc = acpi_device_get_parent_softc(sc->button_dev); 249 if (acpi_sc == NULL) 250 return_VOID; 251 252 acpi_UserNotify("Button", sc->button_handle, sc->button_type); 253 254 switch (sc->button_type) { 255 case ACPI_POWER_BUTTON: 256 ACPI_VPRINT(sc->button_dev, acpi_sc, "wakeup by power button\n"); 257 acpi_event_power_button_wake(acpi_sc); 258 break; 259 case ACPI_SLEEP_BUTTON: 260 ACPI_VPRINT(sc->button_dev, acpi_sc, "wakeup by sleep button\n"); 261 acpi_event_sleep_button_wake(acpi_sc); 262 break; 263 default: 264 break; /* unknown button type */ 265 } 266 } 267 268 static void 269 acpi_button_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context) 270 { 271 struct acpi_button_softc *sc; 272 #ifdef EVDEV_SUPPORT 273 uint16_t key; 274 #endif 275 276 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify); 277 278 sc = (struct acpi_button_softc *)context; 279 switch (notify) { 280 case ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP: 281 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_button_notify_sleep, sc); 282 break; 283 case ACPI_NOTIFY_BUTTON_PRESSED_FOR_WAKEUP: 284 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_button_notify_wakeup, sc); 285 break; 286 default: 287 device_printf(sc->button_dev, "unknown notify %#x\n", notify); 288 break; 289 } 290 291 #ifdef EVDEV_SUPPORT 292 key = (sc->button_type == ACPI_SLEEP_BUTTON) ? KEY_SLEEP : KEY_POWER; 293 evdev_push_key(sc->button_evdev, key, 1); 294 evdev_sync(sc->button_evdev); 295 evdev_push_key(sc->button_evdev, key, 0); 296 evdev_sync(sc->button_evdev); 297 #endif 298 } 299 300 static ACPI_STATUS 301 acpi_button_fixed_handler(void *context) 302 { 303 struct acpi_button_softc *sc = (struct acpi_button_softc *)context; 304 305 ACPI_FUNCTION_TRACE_PTR((char *)(uintptr_t)__func__, context); 306 307 if (context == NULL) 308 return_ACPI_STATUS (AE_BAD_PARAMETER); 309 310 acpi_button_notify_handler(sc->button_handle, 311 ACPI_NOTIFY_BUTTON_PRESSED_FOR_SLEEP, sc); 312 return_ACPI_STATUS (AE_OK); 313 } 314