1 /* 2 * button.c - ACPI Button Driver 3 * 4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com> 5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com> 6 * 7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License as published by 11 * the Free Software Foundation; either version 2 of the License, or (at 12 * your option) any later version. 13 * 14 * This program is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License along 20 * with this program; if not, write to the Free Software Foundation, Inc., 21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 22 * 23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 */ 25 26 #include <linux/kernel.h> 27 #include <linux/module.h> 28 #include <linux/init.h> 29 #include <linux/types.h> 30 #include <linux/proc_fs.h> 31 #include <linux/seq_file.h> 32 #include <linux/input.h> 33 #include <linux/slab.h> 34 #include <acpi/acpi_bus.h> 35 #include <acpi/acpi_drivers.h> 36 37 #define PREFIX "ACPI: " 38 39 #define ACPI_BUTTON_CLASS "button" 40 #define ACPI_BUTTON_FILE_INFO "info" 41 #define ACPI_BUTTON_FILE_STATE "state" 42 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00 43 #define ACPI_BUTTON_NOTIFY_STATUS 0x80 44 45 #define ACPI_BUTTON_SUBCLASS_POWER "power" 46 #define ACPI_BUTTON_HID_POWER "PNP0C0C" 47 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button" 48 #define ACPI_BUTTON_TYPE_POWER 0x01 49 50 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep" 51 #define ACPI_BUTTON_HID_SLEEP "PNP0C0E" 52 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button" 53 #define ACPI_BUTTON_TYPE_SLEEP 0x03 54 55 #define ACPI_BUTTON_SUBCLASS_LID "lid" 56 #define ACPI_BUTTON_HID_LID "PNP0C0D" 57 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch" 58 #define ACPI_BUTTON_TYPE_LID 0x05 59 60 #define _COMPONENT ACPI_BUTTON_COMPONENT 61 ACPI_MODULE_NAME("button"); 62 63 MODULE_AUTHOR("Paul Diefenbaugh"); 64 MODULE_DESCRIPTION("ACPI Button Driver"); 65 MODULE_LICENSE("GPL"); 66 67 static const struct acpi_device_id button_device_ids[] = { 68 {ACPI_BUTTON_HID_LID, 0}, 69 {ACPI_BUTTON_HID_SLEEP, 0}, 70 {ACPI_BUTTON_HID_SLEEPF, 0}, 71 {ACPI_BUTTON_HID_POWER, 0}, 72 {ACPI_BUTTON_HID_POWERF, 0}, 73 {"", 0}, 74 }; 75 MODULE_DEVICE_TABLE(acpi, button_device_ids); 76 77 static int acpi_button_add(struct acpi_device *device); 78 static int acpi_button_remove(struct acpi_device *device, int type); 79 static void acpi_button_notify(struct acpi_device *device, u32 event); 80 81 static int acpi_button_resume(struct device *dev); 82 static SIMPLE_DEV_PM_OPS(acpi_button_pm, NULL, acpi_button_resume); 83 84 static struct acpi_driver acpi_button_driver = { 85 .name = "button", 86 .class = ACPI_BUTTON_CLASS, 87 .ids = button_device_ids, 88 .ops = { 89 .add = acpi_button_add, 90 .remove = acpi_button_remove, 91 .notify = acpi_button_notify, 92 }, 93 .drv.pm = &acpi_button_pm, 94 }; 95 96 struct acpi_button { 97 unsigned int type; 98 struct input_dev *input; 99 char phys[32]; /* for input device */ 100 unsigned long pushed; 101 bool wakeup_enabled; 102 }; 103 104 static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier); 105 static struct acpi_device *lid_device; 106 107 /* -------------------------------------------------------------------------- 108 FS Interface (/proc) 109 -------------------------------------------------------------------------- */ 110 111 static struct proc_dir_entry *acpi_button_dir; 112 static struct proc_dir_entry *acpi_lid_dir; 113 114 static int acpi_button_state_seq_show(struct seq_file *seq, void *offset) 115 { 116 struct acpi_device *device = seq->private; 117 acpi_status status; 118 unsigned long long state; 119 120 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &state); 121 seq_printf(seq, "state: %s\n", 122 ACPI_FAILURE(status) ? "unsupported" : 123 (state ? "open" : "closed")); 124 return 0; 125 } 126 127 static int acpi_button_state_open_fs(struct inode *inode, struct file *file) 128 { 129 return single_open(file, acpi_button_state_seq_show, PDE(inode)->data); 130 } 131 132 static const struct file_operations acpi_button_state_fops = { 133 .owner = THIS_MODULE, 134 .open = acpi_button_state_open_fs, 135 .read = seq_read, 136 .llseek = seq_lseek, 137 .release = single_release, 138 }; 139 140 static int acpi_button_add_fs(struct acpi_device *device) 141 { 142 struct acpi_button *button = acpi_driver_data(device); 143 struct proc_dir_entry *entry = NULL; 144 int ret = 0; 145 146 /* procfs I/F for ACPI lid device only */ 147 if (button->type != ACPI_BUTTON_TYPE_LID) 148 return 0; 149 150 if (acpi_button_dir || acpi_lid_dir) { 151 printk(KERN_ERR PREFIX "More than one Lid device found!\n"); 152 return -EEXIST; 153 } 154 155 /* create /proc/acpi/button */ 156 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir); 157 if (!acpi_button_dir) 158 return -ENODEV; 159 160 /* create /proc/acpi/button/lid */ 161 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir); 162 if (!acpi_lid_dir) { 163 ret = -ENODEV; 164 goto remove_button_dir; 165 } 166 167 /* create /proc/acpi/button/lid/LID/ */ 168 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir); 169 if (!acpi_device_dir(device)) { 170 ret = -ENODEV; 171 goto remove_lid_dir; 172 } 173 174 /* create /proc/acpi/button/lid/LID/state */ 175 entry = proc_create_data(ACPI_BUTTON_FILE_STATE, 176 S_IRUGO, acpi_device_dir(device), 177 &acpi_button_state_fops, device); 178 if (!entry) { 179 ret = -ENODEV; 180 goto remove_dev_dir; 181 } 182 183 done: 184 return ret; 185 186 remove_dev_dir: 187 remove_proc_entry(acpi_device_bid(device), 188 acpi_lid_dir); 189 acpi_device_dir(device) = NULL; 190 remove_lid_dir: 191 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir); 192 remove_button_dir: 193 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir); 194 goto done; 195 } 196 197 static int acpi_button_remove_fs(struct acpi_device *device) 198 { 199 struct acpi_button *button = acpi_driver_data(device); 200 201 if (button->type != ACPI_BUTTON_TYPE_LID) 202 return 0; 203 204 remove_proc_entry(ACPI_BUTTON_FILE_STATE, 205 acpi_device_dir(device)); 206 remove_proc_entry(acpi_device_bid(device), 207 acpi_lid_dir); 208 acpi_device_dir(device) = NULL; 209 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir); 210 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir); 211 212 return 0; 213 } 214 215 /* -------------------------------------------------------------------------- 216 Driver Interface 217 -------------------------------------------------------------------------- */ 218 int acpi_lid_notifier_register(struct notifier_block *nb) 219 { 220 return blocking_notifier_chain_register(&acpi_lid_notifier, nb); 221 } 222 EXPORT_SYMBOL(acpi_lid_notifier_register); 223 224 int acpi_lid_notifier_unregister(struct notifier_block *nb) 225 { 226 return blocking_notifier_chain_unregister(&acpi_lid_notifier, nb); 227 } 228 EXPORT_SYMBOL(acpi_lid_notifier_unregister); 229 230 int acpi_lid_open(void) 231 { 232 acpi_status status; 233 unsigned long long state; 234 235 if (!lid_device) 236 return -ENODEV; 237 238 status = acpi_evaluate_integer(lid_device->handle, "_LID", NULL, 239 &state); 240 if (ACPI_FAILURE(status)) 241 return -ENODEV; 242 243 return !!state; 244 } 245 EXPORT_SYMBOL(acpi_lid_open); 246 247 static int acpi_lid_send_state(struct acpi_device *device) 248 { 249 struct acpi_button *button = acpi_driver_data(device); 250 unsigned long long state; 251 acpi_status status; 252 int ret; 253 254 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &state); 255 if (ACPI_FAILURE(status)) 256 return -ENODEV; 257 258 /* input layer checks if event is redundant */ 259 input_report_switch(button->input, SW_LID, !state); 260 input_sync(button->input); 261 262 if (state) 263 pm_wakeup_event(&device->dev, 0); 264 265 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, device); 266 if (ret == NOTIFY_DONE) 267 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, 268 device); 269 if (ret == NOTIFY_DONE || ret == NOTIFY_OK) { 270 /* 271 * It is also regarded as success if the notifier_chain 272 * returns NOTIFY_OK or NOTIFY_DONE. 273 */ 274 ret = 0; 275 } 276 return ret; 277 } 278 279 static void acpi_button_notify(struct acpi_device *device, u32 event) 280 { 281 struct acpi_button *button = acpi_driver_data(device); 282 struct input_dev *input; 283 284 switch (event) { 285 case ACPI_FIXED_HARDWARE_EVENT: 286 event = ACPI_BUTTON_NOTIFY_STATUS; 287 /* fall through */ 288 case ACPI_BUTTON_NOTIFY_STATUS: 289 input = button->input; 290 if (button->type == ACPI_BUTTON_TYPE_LID) { 291 acpi_lid_send_state(device); 292 } else { 293 int keycode = test_bit(KEY_SLEEP, input->keybit) ? 294 KEY_SLEEP : KEY_POWER; 295 296 input_report_key(input, keycode, 1); 297 input_sync(input); 298 input_report_key(input, keycode, 0); 299 input_sync(input); 300 301 pm_wakeup_event(&device->dev, 0); 302 } 303 304 acpi_bus_generate_proc_event(device, event, ++button->pushed); 305 break; 306 default: 307 ACPI_DEBUG_PRINT((ACPI_DB_INFO, 308 "Unsupported event [0x%x]\n", event)); 309 break; 310 } 311 } 312 313 static int acpi_button_resume(struct device *dev) 314 { 315 struct acpi_device *device = to_acpi_device(dev); 316 struct acpi_button *button = acpi_driver_data(device); 317 318 if (button->type == ACPI_BUTTON_TYPE_LID) 319 return acpi_lid_send_state(device); 320 return 0; 321 } 322 323 static int acpi_button_add(struct acpi_device *device) 324 { 325 struct acpi_button *button; 326 struct input_dev *input; 327 const char *hid = acpi_device_hid(device); 328 char *name, *class; 329 int error; 330 331 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL); 332 if (!button) 333 return -ENOMEM; 334 335 device->driver_data = button; 336 337 button->input = input = input_allocate_device(); 338 if (!input) { 339 error = -ENOMEM; 340 goto err_free_button; 341 } 342 343 name = acpi_device_name(device); 344 class = acpi_device_class(device); 345 346 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) || 347 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) { 348 button->type = ACPI_BUTTON_TYPE_POWER; 349 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER); 350 sprintf(class, "%s/%s", 351 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER); 352 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) || 353 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) { 354 button->type = ACPI_BUTTON_TYPE_SLEEP; 355 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP); 356 sprintf(class, "%s/%s", 357 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP); 358 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) { 359 button->type = ACPI_BUTTON_TYPE_LID; 360 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID); 361 sprintf(class, "%s/%s", 362 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID); 363 } else { 364 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid); 365 error = -ENODEV; 366 goto err_free_input; 367 } 368 369 error = acpi_button_add_fs(device); 370 if (error) 371 goto err_free_input; 372 373 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid); 374 375 input->name = name; 376 input->phys = button->phys; 377 input->id.bustype = BUS_HOST; 378 input->id.product = button->type; 379 input->dev.parent = &device->dev; 380 381 switch (button->type) { 382 case ACPI_BUTTON_TYPE_POWER: 383 input->evbit[0] = BIT_MASK(EV_KEY); 384 set_bit(KEY_POWER, input->keybit); 385 break; 386 387 case ACPI_BUTTON_TYPE_SLEEP: 388 input->evbit[0] = BIT_MASK(EV_KEY); 389 set_bit(KEY_SLEEP, input->keybit); 390 break; 391 392 case ACPI_BUTTON_TYPE_LID: 393 input->evbit[0] = BIT_MASK(EV_SW); 394 set_bit(SW_LID, input->swbit); 395 break; 396 } 397 398 error = input_register_device(input); 399 if (error) 400 goto err_remove_fs; 401 if (button->type == ACPI_BUTTON_TYPE_LID) { 402 acpi_lid_send_state(device); 403 /* 404 * This assumes there's only one lid device, or if there are 405 * more we only care about the last one... 406 */ 407 lid_device = device; 408 } 409 410 if (device->wakeup.flags.valid) { 411 /* Button's GPE is run-wake GPE */ 412 acpi_enable_gpe(device->wakeup.gpe_device, 413 device->wakeup.gpe_number); 414 if (!device_may_wakeup(&device->dev)) { 415 device_set_wakeup_enable(&device->dev, true); 416 button->wakeup_enabled = true; 417 } 418 } 419 420 printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device)); 421 return 0; 422 423 err_remove_fs: 424 acpi_button_remove_fs(device); 425 err_free_input: 426 input_free_device(input); 427 err_free_button: 428 kfree(button); 429 return error; 430 } 431 432 static int acpi_button_remove(struct acpi_device *device, int type) 433 { 434 struct acpi_button *button = acpi_driver_data(device); 435 436 if (device->wakeup.flags.valid) { 437 acpi_disable_gpe(device->wakeup.gpe_device, 438 device->wakeup.gpe_number); 439 if (button->wakeup_enabled) 440 device_set_wakeup_enable(&device->dev, false); 441 } 442 443 acpi_button_remove_fs(device); 444 input_unregister_device(button->input); 445 kfree(button); 446 return 0; 447 } 448 449 static int __init acpi_button_init(void) 450 { 451 return acpi_bus_register_driver(&acpi_button_driver); 452 } 453 454 static void __exit acpi_button_exit(void) 455 { 456 acpi_bus_unregister_driver(&acpi_button_driver); 457 } 458 459 module_init(acpi_button_init); 460 module_exit(acpi_button_exit); 461