2 * button.c - ACPI Button Driver
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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 #define pr_fmt(fmt) "ACPI: button: " fmt
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/types.h>
28 #include <linux/proc_fs.h>
29 #include <linux/seq_file.h>
30 #include <linux/input.h>
31 #include <linux/slab.h>
32 #include <linux/acpi.h>
33 #include <linux/dmi.h>
34 #include <acpi/button.h>
36 #define PREFIX "ACPI: "
38 #define ACPI_BUTTON_CLASS "button"
39 #define ACPI_BUTTON_FILE_INFO "info"
40 #define ACPI_BUTTON_FILE_STATE "state"
41 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00
42 #define ACPI_BUTTON_NOTIFY_STATUS 0x80
44 #define ACPI_BUTTON_SUBCLASS_POWER "power"
45 #define ACPI_BUTTON_HID_POWER "PNP0C0C"
46 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
47 #define ACPI_BUTTON_TYPE_POWER 0x01
49 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
50 #define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
51 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
52 #define ACPI_BUTTON_TYPE_SLEEP 0x03
54 #define ACPI_BUTTON_SUBCLASS_LID "lid"
55 #define ACPI_BUTTON_HID_LID "PNP0C0D"
56 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
57 #define ACPI_BUTTON_TYPE_LID 0x05
59 #define ACPI_BUTTON_LID_INIT_IGNORE 0x00
60 #define ACPI_BUTTON_LID_INIT_OPEN 0x01
61 #define ACPI_BUTTON_LID_INIT_METHOD 0x02
63 #define _COMPONENT ACPI_BUTTON_COMPONENT
64 ACPI_MODULE_NAME("button");
66 MODULE_AUTHOR("Paul Diefenbaugh");
67 MODULE_DESCRIPTION("ACPI Button Driver");
68 MODULE_LICENSE("GPL");
70 static const struct acpi_device_id button_device_ids[] = {
71 {ACPI_BUTTON_HID_LID, 0},
72 {ACPI_BUTTON_HID_SLEEP, 0},
73 {ACPI_BUTTON_HID_SLEEPF, 0},
74 {ACPI_BUTTON_HID_POWER, 0},
75 {ACPI_BUTTON_HID_POWERF, 0},
78 MODULE_DEVICE_TABLE(acpi, button_device_ids);
81 * Some devices which don't even have a lid in anyway have a broken _LID
82 * method (e.g. pointing to a floating gpio pin) causing spurious LID events.
84 static const struct dmi_system_id lid_blacklst[] = {
86 /* GP-electronic T701 */
88 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
89 DMI_MATCH(DMI_PRODUCT_NAME, "T701"),
90 DMI_MATCH(DMI_BIOS_VERSION, "BYT70A.YNCHENG.WIN.007"),
96 static int acpi_button_add(struct acpi_device *device);
97 static int acpi_button_remove(struct acpi_device *device);
98 static void acpi_button_notify(struct acpi_device *device, u32 event);
100 #ifdef CONFIG_PM_SLEEP
101 static int acpi_button_suspend(struct device *dev);
102 static int acpi_button_resume(struct device *dev);
104 #define acpi_button_suspend NULL
105 #define acpi_button_resume NULL
107 static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
109 static struct acpi_driver acpi_button_driver = {
111 .class = ACPI_BUTTON_CLASS,
112 .ids = button_device_ids,
114 .add = acpi_button_add,
115 .remove = acpi_button_remove,
116 .notify = acpi_button_notify,
118 .drv.pm = &acpi_button_pm,
123 struct input_dev *input;
124 char phys[32]; /* for input device */
125 unsigned long pushed;
131 static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier);
132 static struct acpi_device *lid_device;
133 static u8 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
135 static unsigned long lid_report_interval __read_mostly = 500;
136 module_param(lid_report_interval, ulong, 0644);
137 MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
139 /* --------------------------------------------------------------------------
141 -------------------------------------------------------------------------- */
143 static struct proc_dir_entry *acpi_button_dir;
144 static struct proc_dir_entry *acpi_lid_dir;
146 static int acpi_lid_evaluate_state(struct acpi_device *device)
148 unsigned long long lid_state;
151 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
152 if (ACPI_FAILURE(status))
155 return lid_state ? 1 : 0;
158 static int acpi_lid_notify_state(struct acpi_device *device, int state)
160 struct acpi_button *button = acpi_driver_data(device);
166 * In lid_init_state=ignore mode, if user opens/closes lid
167 * frequently with "open" missing, and "last_time" is also updated
168 * frequently, "close" cannot be delivered to the userspace.
169 * So "last_time" is only updated after a timeout or an actual
172 if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
173 button->last_state != !!state)
178 next_report = ktime_add(button->last_time,
179 ms_to_ktime(lid_report_interval));
180 if (button->last_state == !!state &&
181 ktime_after(ktime_get(), next_report)) {
182 /* Complain the buggy firmware */
183 pr_warn_once("The lid device is not compliant to SW_LID.\n");
186 * Send the unreliable complement switch event:
188 * On most platforms, the lid device is reliable. However
189 * there are exceptions:
190 * 1. Platforms returning initial lid state as "close" by
191 * default after booting/resuming:
192 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
193 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
194 * 2. Platforms never reporting "open" events:
195 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
196 * On these buggy platforms, the usage model of the ACPI
197 * lid device actually is:
198 * 1. The initial returning value of _LID may not be
200 * 2. The open event may not be reliable.
201 * 3. The close event is reliable.
203 * But SW_LID is typed as input switch event, the input
204 * layer checks if the event is redundant. Hence if the
205 * state is not switched, the userspace cannot see this
206 * platform triggered reliable event. By inserting a
207 * complement switch event, it then is guaranteed that the
208 * platform triggered reliable one can always be seen by
211 if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
214 * Do generate complement switch event for "close"
215 * as "close" is reliable and wrong "open" won't
216 * trigger unexpected behaviors.
217 * Do not generate complement switch event for
218 * "open" as "open" is not reliable and wrong
219 * "close" will trigger unexpected behaviors.
222 input_report_switch(button->input,
224 input_sync(button->input);
228 /* Send the platform triggered reliable event */
230 acpi_handle_debug(device->handle, "ACPI LID %s\n",
231 state ? "open" : "closed");
232 input_report_switch(button->input, SW_LID, !state);
233 input_sync(button->input);
234 button->last_state = !!state;
235 button->last_time = ktime_get();
239 acpi_pm_wakeup_event(&device->dev);
241 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, device);
242 if (ret == NOTIFY_DONE)
243 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state,
245 if (ret == NOTIFY_DONE || ret == NOTIFY_OK) {
247 * It is also regarded as success if the notifier_chain
248 * returns NOTIFY_OK or NOTIFY_DONE.
255 static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
257 struct acpi_device *device = seq->private;
260 state = acpi_lid_evaluate_state(device);
261 seq_printf(seq, "state: %s\n",
262 state < 0 ? "unsupported" : (state ? "open" : "closed"));
266 static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
268 return single_open(file, acpi_button_state_seq_show, PDE_DATA(inode));
271 static const struct file_operations acpi_button_state_fops = {
272 .owner = THIS_MODULE,
273 .open = acpi_button_state_open_fs,
276 .release = single_release,
279 static int acpi_button_add_fs(struct acpi_device *device)
281 struct acpi_button *button = acpi_driver_data(device);
282 struct proc_dir_entry *entry = NULL;
285 /* procfs I/F for ACPI lid device only */
286 if (button->type != ACPI_BUTTON_TYPE_LID)
289 if (acpi_button_dir || acpi_lid_dir) {
290 printk(KERN_ERR PREFIX "More than one Lid device found!\n");
294 /* create /proc/acpi/button */
295 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
296 if (!acpi_button_dir)
299 /* create /proc/acpi/button/lid */
300 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
303 goto remove_button_dir;
306 /* create /proc/acpi/button/lid/LID/ */
307 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
308 if (!acpi_device_dir(device)) {
313 /* create /proc/acpi/button/lid/LID/state */
314 entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
315 S_IRUGO, acpi_device_dir(device),
316 &acpi_button_state_fops, device);
326 remove_proc_entry(acpi_device_bid(device),
328 acpi_device_dir(device) = NULL;
330 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
333 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
334 acpi_button_dir = NULL;
338 static int acpi_button_remove_fs(struct acpi_device *device)
340 struct acpi_button *button = acpi_driver_data(device);
342 if (button->type != ACPI_BUTTON_TYPE_LID)
345 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
346 acpi_device_dir(device));
347 remove_proc_entry(acpi_device_bid(device),
349 acpi_device_dir(device) = NULL;
350 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
352 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
353 acpi_button_dir = NULL;
358 /* --------------------------------------------------------------------------
360 -------------------------------------------------------------------------- */
361 int acpi_lid_notifier_register(struct notifier_block *nb)
363 return blocking_notifier_chain_register(&acpi_lid_notifier, nb);
365 EXPORT_SYMBOL(acpi_lid_notifier_register);
367 int acpi_lid_notifier_unregister(struct notifier_block *nb)
369 return blocking_notifier_chain_unregister(&acpi_lid_notifier, nb);
371 EXPORT_SYMBOL(acpi_lid_notifier_unregister);
373 int acpi_lid_open(void)
378 return acpi_lid_evaluate_state(lid_device);
380 EXPORT_SYMBOL(acpi_lid_open);
382 static int acpi_lid_update_state(struct acpi_device *device)
386 state = acpi_lid_evaluate_state(device);
390 return acpi_lid_notify_state(device, state);
393 static void acpi_lid_initialize_state(struct acpi_device *device)
395 switch (lid_init_state) {
396 case ACPI_BUTTON_LID_INIT_OPEN:
397 (void)acpi_lid_notify_state(device, 1);
399 case ACPI_BUTTON_LID_INIT_METHOD:
400 (void)acpi_lid_update_state(device);
402 case ACPI_BUTTON_LID_INIT_IGNORE:
408 static void acpi_button_notify(struct acpi_device *device, u32 event)
410 struct acpi_button *button = acpi_driver_data(device);
411 struct input_dev *input;
415 case ACPI_FIXED_HARDWARE_EVENT:
416 event = ACPI_BUTTON_NOTIFY_STATUS;
418 case ACPI_BUTTON_NOTIFY_STATUS:
419 input = button->input;
420 if (button->type == ACPI_BUTTON_TYPE_LID) {
421 mutex_lock(&button->input->mutex);
422 users = button->input->users;
423 mutex_unlock(&button->input->mutex);
425 acpi_lid_update_state(device);
429 acpi_pm_wakeup_event(&device->dev);
430 if (button->suspended)
433 keycode = test_bit(KEY_SLEEP, input->keybit) ?
434 KEY_SLEEP : KEY_POWER;
435 input_report_key(input, keycode, 1);
437 input_report_key(input, keycode, 0);
440 acpi_bus_generate_netlink_event(
441 device->pnp.device_class,
442 dev_name(&device->dev),
443 event, ++button->pushed);
447 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
448 "Unsupported event [0x%x]\n", event));
453 #ifdef CONFIG_PM_SLEEP
454 static int acpi_button_suspend(struct device *dev)
456 struct acpi_device *device = to_acpi_device(dev);
457 struct acpi_button *button = acpi_driver_data(device);
459 button->suspended = true;
463 static int acpi_button_resume(struct device *dev)
465 struct acpi_device *device = to_acpi_device(dev);
466 struct acpi_button *button = acpi_driver_data(device);
468 button->suspended = false;
469 if (button->type == ACPI_BUTTON_TYPE_LID && button->input->users)
470 acpi_lid_initialize_state(device);
475 static int acpi_lid_input_open(struct input_dev *input)
477 struct acpi_device *device = input_get_drvdata(input);
478 struct acpi_button *button = acpi_driver_data(device);
480 button->last_state = !!acpi_lid_evaluate_state(device);
481 button->last_time = ktime_get();
482 acpi_lid_initialize_state(device);
487 static int acpi_button_add(struct acpi_device *device)
489 struct acpi_button *button;
490 struct input_dev *input;
491 const char *hid = acpi_device_hid(device);
495 if (!strcmp(hid, ACPI_BUTTON_HID_LID) && dmi_check_system(lid_blacklst))
498 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
502 device->driver_data = button;
504 button->input = input = input_allocate_device();
507 goto err_free_button;
510 name = acpi_device_name(device);
511 class = acpi_device_class(device);
513 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
514 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
515 button->type = ACPI_BUTTON_TYPE_POWER;
516 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
517 sprintf(class, "%s/%s",
518 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
519 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
520 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
521 button->type = ACPI_BUTTON_TYPE_SLEEP;
522 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
523 sprintf(class, "%s/%s",
524 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
525 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
526 button->type = ACPI_BUTTON_TYPE_LID;
527 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
528 sprintf(class, "%s/%s",
529 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
530 input->open = acpi_lid_input_open;
532 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid);
537 error = acpi_button_add_fs(device);
541 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
544 input->phys = button->phys;
545 input->id.bustype = BUS_HOST;
546 input->id.product = button->type;
547 input->dev.parent = &device->dev;
549 switch (button->type) {
550 case ACPI_BUTTON_TYPE_POWER:
551 input_set_capability(input, EV_KEY, KEY_POWER);
554 case ACPI_BUTTON_TYPE_SLEEP:
555 input_set_capability(input, EV_KEY, KEY_SLEEP);
558 case ACPI_BUTTON_TYPE_LID:
559 input_set_capability(input, EV_SW, SW_LID);
563 input_set_drvdata(input, device);
564 error = input_register_device(input);
567 if (button->type == ACPI_BUTTON_TYPE_LID) {
569 * This assumes there's only one lid device, or if there are
570 * more we only care about the last one...
575 device_init_wakeup(&device->dev, true);
576 printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device));
580 acpi_button_remove_fs(device);
582 input_free_device(input);
588 static int acpi_button_remove(struct acpi_device *device)
590 struct acpi_button *button = acpi_driver_data(device);
592 acpi_button_remove_fs(device);
593 input_unregister_device(button->input);
598 static int param_set_lid_init_state(const char *val,
599 const struct kernel_param *kp)
603 if (!strncmp(val, "open", sizeof("open") - 1)) {
604 lid_init_state = ACPI_BUTTON_LID_INIT_OPEN;
605 pr_info("Notify initial lid state as open\n");
606 } else if (!strncmp(val, "method", sizeof("method") - 1)) {
607 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
608 pr_info("Notify initial lid state with _LID return value\n");
609 } else if (!strncmp(val, "ignore", sizeof("ignore") - 1)) {
610 lid_init_state = ACPI_BUTTON_LID_INIT_IGNORE;
611 pr_info("Do not notify initial lid state\n");
617 static int param_get_lid_init_state(char *buffer,
618 const struct kernel_param *kp)
620 switch (lid_init_state) {
621 case ACPI_BUTTON_LID_INIT_OPEN:
622 return sprintf(buffer, "open");
623 case ACPI_BUTTON_LID_INIT_METHOD:
624 return sprintf(buffer, "method");
625 case ACPI_BUTTON_LID_INIT_IGNORE:
626 return sprintf(buffer, "ignore");
628 return sprintf(buffer, "invalid");
633 module_param_call(lid_init_state,
634 param_set_lid_init_state, param_get_lid_init_state,
636 MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
638 module_acpi_driver(acpi_button_driver);