2 * acpi_button.c - ACPI Button Driver ($Revision: 30 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <acpi/acpi_bus.h>
34 #include <acpi/acpi_drivers.h>
36 #define ACPI_BUTTON_CLASS "button"
37 #define ACPI_BUTTON_FILE_INFO "info"
38 #define ACPI_BUTTON_FILE_STATE "state"
39 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00
40 #define ACPI_BUTTON_NOTIFY_STATUS 0x80
42 #define ACPI_BUTTON_SUBCLASS_POWER "power"
43 #define ACPI_BUTTON_HID_POWER "PNP0C0C"
44 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button (CM)"
45 #define ACPI_BUTTON_DEVICE_NAME_POWERF "Power Button (FF)"
46 #define ACPI_BUTTON_TYPE_POWER 0x01
47 #define ACPI_BUTTON_TYPE_POWERF 0x02
49 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
50 #define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
51 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button (CM)"
52 #define ACPI_BUTTON_DEVICE_NAME_SLEEPF "Sleep Button (FF)"
53 #define ACPI_BUTTON_TYPE_SLEEP 0x03
54 #define ACPI_BUTTON_TYPE_SLEEPF 0x04
56 #define ACPI_BUTTON_SUBCLASS_LID "lid"
57 #define ACPI_BUTTON_HID_LID "PNP0C0D"
58 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
59 #define ACPI_BUTTON_TYPE_LID 0x05
61 #define _COMPONENT ACPI_BUTTON_COMPONENT
62 ACPI_MODULE_NAME("button");
64 MODULE_AUTHOR("Paul Diefenbaugh");
65 MODULE_DESCRIPTION("ACPI Button Driver");
66 MODULE_LICENSE("GPL");
68 static const struct acpi_device_id button_device_ids[] = {
69 {ACPI_BUTTON_HID_LID, 0},
70 {ACPI_BUTTON_HID_SLEEP, 0},
71 {ACPI_BUTTON_HID_SLEEPF, 0},
72 {ACPI_BUTTON_HID_POWER, 0},
73 {ACPI_BUTTON_HID_POWERF, 0},
76 MODULE_DEVICE_TABLE(acpi, button_device_ids);
78 static int acpi_button_add(struct acpi_device *device);
79 static int acpi_button_remove(struct acpi_device *device, int type);
80 static int acpi_button_resume(struct acpi_device *device);
81 static int acpi_button_info_open_fs(struct inode *inode, struct file *file);
82 static int acpi_button_state_open_fs(struct inode *inode, struct file *file);
84 static struct acpi_driver acpi_button_driver = {
86 .class = ACPI_BUTTON_CLASS,
87 .ids = button_device_ids,
89 .add = acpi_button_add,
90 .resume = acpi_button_resume,
91 .remove = acpi_button_remove,
96 struct acpi_device *device; /* Fixed button kludge */
98 struct input_dev *input;
99 char phys[32]; /* for input device */
100 unsigned long pushed;
103 static const struct file_operations acpi_button_info_fops = {
104 .owner = THIS_MODULE,
105 .open = acpi_button_info_open_fs,
108 .release = single_release,
111 static const struct file_operations acpi_button_state_fops = {
112 .owner = THIS_MODULE,
113 .open = acpi_button_state_open_fs,
116 .release = single_release,
119 /* --------------------------------------------------------------------------
121 -------------------------------------------------------------------------- */
123 static struct proc_dir_entry *acpi_button_dir;
125 static int acpi_button_info_seq_show(struct seq_file *seq, void *offset)
127 struct acpi_button *button = seq->private;
129 if (!button || !button->device)
132 seq_printf(seq, "type: %s\n",
133 acpi_device_name(button->device));
138 static int acpi_button_info_open_fs(struct inode *inode, struct file *file)
140 return single_open(file, acpi_button_info_seq_show, PDE(inode)->data);
143 static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
145 struct acpi_button *button = seq->private;
147 unsigned long long state;
149 if (!button || !button->device)
152 status = acpi_evaluate_integer(button->device->handle, "_LID", NULL, &state);
153 seq_printf(seq, "state: %s\n",
154 ACPI_FAILURE(status) ? "unsupported" :
155 (state ? "open" : "closed"));
159 static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
161 return single_open(file, acpi_button_state_seq_show, PDE(inode)->data);
164 static struct proc_dir_entry *acpi_power_dir;
165 static struct proc_dir_entry *acpi_sleep_dir;
166 static struct proc_dir_entry *acpi_lid_dir;
168 static int acpi_button_add_fs(struct acpi_device *device)
170 struct proc_dir_entry *entry = NULL;
171 struct acpi_button *button;
173 if (!device || !acpi_driver_data(device))
176 button = acpi_driver_data(device);
178 switch (button->type) {
179 case ACPI_BUTTON_TYPE_POWER:
180 case ACPI_BUTTON_TYPE_POWERF:
182 acpi_power_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_POWER,
184 entry = acpi_power_dir;
186 case ACPI_BUTTON_TYPE_SLEEP:
187 case ACPI_BUTTON_TYPE_SLEEPF:
189 acpi_sleep_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_SLEEP,
191 entry = acpi_sleep_dir;
193 case ACPI_BUTTON_TYPE_LID:
195 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID,
197 entry = acpi_lid_dir;
203 entry->owner = THIS_MODULE;
205 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), entry);
206 if (!acpi_device_dir(device))
208 acpi_device_dir(device)->owner = THIS_MODULE;
211 entry = proc_create_data(ACPI_BUTTON_FILE_INFO,
212 S_IRUGO, acpi_device_dir(device),
213 &acpi_button_info_fops,
214 acpi_driver_data(device));
218 /* show lid state [R] */
219 if (button->type == ACPI_BUTTON_TYPE_LID) {
220 entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
221 S_IRUGO, acpi_device_dir(device),
222 &acpi_button_state_fops,
223 acpi_driver_data(device));
231 static int acpi_button_remove_fs(struct acpi_device *device)
233 struct acpi_button *button = acpi_driver_data(device);
235 if (acpi_device_dir(device)) {
236 if (button->type == ACPI_BUTTON_TYPE_LID)
237 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
238 acpi_device_dir(device));
239 remove_proc_entry(ACPI_BUTTON_FILE_INFO,
240 acpi_device_dir(device));
242 remove_proc_entry(acpi_device_bid(device),
243 acpi_device_dir(device)->parent);
244 acpi_device_dir(device) = NULL;
250 /* --------------------------------------------------------------------------
252 -------------------------------------------------------------------------- */
253 static int acpi_lid_send_state(struct acpi_button *button)
255 unsigned long long state;
258 status = acpi_evaluate_integer(button->device->handle, "_LID", NULL,
260 if (ACPI_FAILURE(status))
262 /* input layer checks if event is redundant */
263 input_report_switch(button->input, SW_LID, !state);
264 input_sync(button->input);
268 static void acpi_button_notify(acpi_handle handle, u32 event, void *data)
270 struct acpi_button *button = data;
271 struct input_dev *input;
273 if (!button || !button->device)
277 case ACPI_BUTTON_NOTIFY_STATUS:
278 input = button->input;
279 if (button->type == ACPI_BUTTON_TYPE_LID) {
280 acpi_lid_send_state(button);
282 int keycode = test_bit(KEY_SLEEP, input->keybit) ?
283 KEY_SLEEP : KEY_POWER;
285 input_report_key(input, keycode, 1);
287 input_report_key(input, keycode, 0);
291 acpi_bus_generate_proc_event(button->device, event,
295 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
296 "Unsupported event [0x%x]\n", event));
303 static acpi_status acpi_button_notify_fixed(void *data)
305 struct acpi_button *button = data;
308 return AE_BAD_PARAMETER;
310 acpi_button_notify(button->device->handle, ACPI_BUTTON_NOTIFY_STATUS, button);
315 static int acpi_button_install_notify_handlers(struct acpi_button *button)
319 switch (button->type) {
320 case ACPI_BUTTON_TYPE_POWERF:
322 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
323 acpi_button_notify_fixed,
326 case ACPI_BUTTON_TYPE_SLEEPF:
328 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
329 acpi_button_notify_fixed,
333 status = acpi_install_notify_handler(button->device->handle,
340 return ACPI_FAILURE(status) ? -ENODEV : 0;
343 static int acpi_button_resume(struct acpi_device *device)
345 struct acpi_button *button;
348 button = acpi_driver_data(device);
349 if (button && button->type == ACPI_BUTTON_TYPE_LID)
350 return acpi_lid_send_state(button);
354 static void acpi_button_remove_notify_handlers(struct acpi_button *button)
356 switch (button->type) {
357 case ACPI_BUTTON_TYPE_POWERF:
358 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
359 acpi_button_notify_fixed);
361 case ACPI_BUTTON_TYPE_SLEEPF:
362 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
363 acpi_button_notify_fixed);
366 acpi_remove_notify_handler(button->device->handle,
373 static int acpi_button_add(struct acpi_device *device)
376 struct acpi_button *button;
377 struct input_dev *input;
382 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
386 button->device = device;
387 device->driver_data = button;
389 button->input = input = input_allocate_device();
392 goto err_free_button;
396 * Determine the button type (via hid), as fixed-feature buttons
397 * need to be handled a bit differently than generic-space.
399 if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWER)) {
400 button->type = ACPI_BUTTON_TYPE_POWER;
401 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_POWER);
402 sprintf(acpi_device_class(device), "%s/%s",
403 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
404 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWERF)) {
405 button->type = ACPI_BUTTON_TYPE_POWERF;
406 strcpy(acpi_device_name(device),
407 ACPI_BUTTON_DEVICE_NAME_POWERF);
408 sprintf(acpi_device_class(device), "%s/%s",
409 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
410 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEP)) {
411 button->type = ACPI_BUTTON_TYPE_SLEEP;
412 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_SLEEP);
413 sprintf(acpi_device_class(device), "%s/%s",
414 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
415 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEPF)) {
416 button->type = ACPI_BUTTON_TYPE_SLEEPF;
417 strcpy(acpi_device_name(device),
418 ACPI_BUTTON_DEVICE_NAME_SLEEPF);
419 sprintf(acpi_device_class(device), "%s/%s",
420 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
421 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_LID)) {
422 button->type = ACPI_BUTTON_TYPE_LID;
423 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_LID);
424 sprintf(acpi_device_class(device), "%s/%s",
425 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
427 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n",
428 acpi_device_hid(device));
433 error = acpi_button_add_fs(device);
437 error = acpi_button_install_notify_handlers(button);
441 snprintf(button->phys, sizeof(button->phys),
442 "%s/button/input0", acpi_device_hid(device));
444 input->name = acpi_device_name(device);
445 input->phys = button->phys;
446 input->id.bustype = BUS_HOST;
447 input->id.product = button->type;
448 input->dev.parent = &device->dev;
450 switch (button->type) {
451 case ACPI_BUTTON_TYPE_POWER:
452 case ACPI_BUTTON_TYPE_POWERF:
453 input->evbit[0] = BIT_MASK(EV_KEY);
454 set_bit(KEY_POWER, input->keybit);
457 case ACPI_BUTTON_TYPE_SLEEP:
458 case ACPI_BUTTON_TYPE_SLEEPF:
459 input->evbit[0] = BIT_MASK(EV_KEY);
460 set_bit(KEY_SLEEP, input->keybit);
463 case ACPI_BUTTON_TYPE_LID:
464 input->evbit[0] = BIT_MASK(EV_SW);
465 set_bit(SW_LID, input->swbit);
469 error = input_register_device(input);
471 goto err_remove_handlers;
472 if (button->type == ACPI_BUTTON_TYPE_LID)
473 acpi_lid_send_state(button);
475 if (device->wakeup.flags.valid) {
476 /* Button's GPE is run-wake GPE */
477 acpi_set_gpe_type(device->wakeup.gpe_device,
478 device->wakeup.gpe_number,
479 ACPI_GPE_TYPE_WAKE_RUN);
480 acpi_enable_gpe(device->wakeup.gpe_device,
481 device->wakeup.gpe_number);
482 device->wakeup.state.enabled = 1;
485 printk(KERN_INFO PREFIX "%s [%s]\n",
486 acpi_device_name(device), acpi_device_bid(device));
491 acpi_button_remove_notify_handlers(button);
493 acpi_button_remove_fs(device);
495 input_free_device(input);
501 static int acpi_button_remove(struct acpi_device *device, int type)
503 struct acpi_button *button;
505 if (!device || !acpi_driver_data(device))
508 button = acpi_driver_data(device);
510 acpi_button_remove_notify_handlers(button);
511 acpi_button_remove_fs(device);
512 input_unregister_device(button->input);
518 static int __init acpi_button_init(void)
522 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
523 if (!acpi_button_dir)
525 acpi_button_dir->owner = THIS_MODULE;
526 result = acpi_bus_register_driver(&acpi_button_driver);
528 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
535 static void __exit acpi_button_exit(void)
537 acpi_bus_unregister_driver(&acpi_button_driver);
540 remove_proc_entry(ACPI_BUTTON_SUBCLASS_POWER, acpi_button_dir);
542 remove_proc_entry(ACPI_BUTTON_SUBCLASS_SLEEP, acpi_button_dir);
544 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
545 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
548 module_init(acpi_button_init);
549 module_exit(acpi_button_exit);