1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * button.c - ACPI Button Driver
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
9 #define pr_fmt(fmt) "ACPI: button: " fmt
11 #include <linux/compiler.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/types.h>
16 #include <linux/proc_fs.h>
17 #include <linux/seq_file.h>
18 #include <linux/input.h>
19 #include <linux/slab.h>
20 #include <linux/acpi.h>
21 #include <linux/dmi.h>
22 #include <acpi/button.h>
24 #define ACPI_BUTTON_CLASS "button"
25 #define ACPI_BUTTON_FILE_STATE "state"
26 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00
27 #define ACPI_BUTTON_NOTIFY_STATUS 0x80
29 #define ACPI_BUTTON_SUBCLASS_POWER "power"
30 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
31 #define ACPI_BUTTON_TYPE_POWER 0x01
33 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
34 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
35 #define ACPI_BUTTON_TYPE_SLEEP 0x03
37 #define ACPI_BUTTON_SUBCLASS_LID "lid"
38 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
39 #define ACPI_BUTTON_TYPE_LID 0x05
42 ACPI_BUTTON_LID_INIT_IGNORE,
43 ACPI_BUTTON_LID_INIT_OPEN,
44 ACPI_BUTTON_LID_INIT_METHOD,
45 ACPI_BUTTON_LID_INIT_DISABLED,
48 static const char * const lid_init_state_str[] = {
49 [ACPI_BUTTON_LID_INIT_IGNORE] = "ignore",
50 [ACPI_BUTTON_LID_INIT_OPEN] = "open",
51 [ACPI_BUTTON_LID_INIT_METHOD] = "method",
52 [ACPI_BUTTON_LID_INIT_DISABLED] = "disabled",
55 MODULE_AUTHOR("Paul Diefenbaugh");
56 MODULE_DESCRIPTION("ACPI Button Driver");
57 MODULE_LICENSE("GPL");
59 static const struct acpi_device_id button_device_ids[] = {
60 {ACPI_BUTTON_HID_LID, 0},
61 {ACPI_BUTTON_HID_SLEEP, 0},
62 {ACPI_BUTTON_HID_SLEEPF, 0},
63 {ACPI_BUTTON_HID_POWER, 0},
64 {ACPI_BUTTON_HID_POWERF, 0},
67 MODULE_DEVICE_TABLE(acpi, button_device_ids);
69 /* Please keep this list sorted alphabetically by vendor and model */
70 static const struct dmi_system_id dmi_lid_quirks[] = {
72 /* GP-electronic T701, _LID method points to a floating GPIO */
74 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
75 DMI_MATCH(DMI_PRODUCT_NAME, "T701"),
76 DMI_MATCH(DMI_BIOS_VERSION, "BYT70A.YNCHENG.WIN.007"),
78 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_DISABLED,
81 /* Nextbook Ares 8A tablet, _LID device always reports lid closed */
83 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
84 DMI_MATCH(DMI_PRODUCT_NAME, "CherryTrail"),
85 DMI_MATCH(DMI_BIOS_VERSION, "M882"),
87 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_DISABLED,
91 * Lenovo Yoga 9 14ITL5, initial notification of the LID device
95 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
96 DMI_MATCH(DMI_PRODUCT_NAME, "82BG"),
98 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
102 * Medion Akoya E2215T, notification of the LID device only
103 * happens on close, not on open and _LID always returns closed.
106 DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
107 DMI_MATCH(DMI_PRODUCT_NAME, "E2215T"),
109 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
113 * Medion Akoya E2228T, notification of the LID device only
114 * happens on close, not on open and _LID always returns closed.
117 DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
118 DMI_MATCH(DMI_PRODUCT_NAME, "E2228T"),
120 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
124 * Razer Blade Stealth 13 late 2019, notification of the LID device
125 * only happens on close, not on open and _LID always returns closed.
128 DMI_MATCH(DMI_SYS_VENDOR, "Razer"),
129 DMI_MATCH(DMI_PRODUCT_NAME, "Razer Blade Stealth 13 Late 2019"),
131 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
136 static int acpi_button_add(struct acpi_device *device);
137 static void acpi_button_remove(struct acpi_device *device);
139 #ifdef CONFIG_PM_SLEEP
140 static int acpi_button_suspend(struct device *dev);
141 static int acpi_button_resume(struct device *dev);
143 #define acpi_button_suspend NULL
144 #define acpi_button_resume NULL
146 static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
148 static struct acpi_driver acpi_button_driver = {
150 .class = ACPI_BUTTON_CLASS,
151 .ids = button_device_ids,
153 .add = acpi_button_add,
154 .remove = acpi_button_remove,
156 .drv.pm = &acpi_button_pm,
161 struct input_dev *input;
162 char phys[32]; /* for input device */
163 unsigned long pushed;
167 bool lid_state_initialized;
170 static struct acpi_device *lid_device;
171 static long lid_init_state = -1;
173 static unsigned long lid_report_interval __read_mostly = 500;
174 module_param(lid_report_interval, ulong, 0644);
175 MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
177 /* FS Interface (/proc) */
178 static struct proc_dir_entry *acpi_button_dir;
179 static struct proc_dir_entry *acpi_lid_dir;
181 static int acpi_lid_evaluate_state(struct acpi_device *device)
183 unsigned long long lid_state;
186 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
187 if (ACPI_FAILURE(status))
190 return lid_state ? 1 : 0;
193 static int acpi_lid_notify_state(struct acpi_device *device, int state)
195 struct acpi_button *button = acpi_driver_data(device);
200 * In lid_init_state=ignore mode, if user opens/closes lid
201 * frequently with "open" missing, and "last_time" is also updated
202 * frequently, "close" cannot be delivered to the userspace.
203 * So "last_time" is only updated after a timeout or an actual
206 if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
207 button->last_state != !!state)
212 next_report = ktime_add(button->last_time,
213 ms_to_ktime(lid_report_interval));
214 if (button->last_state == !!state &&
215 ktime_after(ktime_get(), next_report)) {
216 /* Complain the buggy firmware */
217 pr_warn_once("The lid device is not compliant to SW_LID.\n");
220 * Send the unreliable complement switch event:
222 * On most platforms, the lid device is reliable. However
223 * there are exceptions:
224 * 1. Platforms returning initial lid state as "close" by
225 * default after booting/resuming:
226 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
227 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
228 * 2. Platforms never reporting "open" events:
229 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
230 * On these buggy platforms, the usage model of the ACPI
231 * lid device actually is:
232 * 1. The initial returning value of _LID may not be
234 * 2. The open event may not be reliable.
235 * 3. The close event is reliable.
237 * But SW_LID is typed as input switch event, the input
238 * layer checks if the event is redundant. Hence if the
239 * state is not switched, the userspace cannot see this
240 * platform triggered reliable event. By inserting a
241 * complement switch event, it then is guaranteed that the
242 * platform triggered reliable one can always be seen by
245 if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
248 * Do generate complement switch event for "close"
249 * as "close" is reliable and wrong "open" won't
250 * trigger unexpected behaviors.
251 * Do not generate complement switch event for
252 * "open" as "open" is not reliable and wrong
253 * "close" will trigger unexpected behaviors.
256 input_report_switch(button->input,
258 input_sync(button->input);
262 /* Send the platform triggered reliable event */
264 acpi_handle_debug(device->handle, "ACPI LID %s\n",
265 state ? "open" : "closed");
266 input_report_switch(button->input, SW_LID, !state);
267 input_sync(button->input);
268 button->last_state = !!state;
269 button->last_time = ktime_get();
275 static int __maybe_unused acpi_button_state_seq_show(struct seq_file *seq,
278 struct acpi_device *device = seq->private;
281 state = acpi_lid_evaluate_state(device);
282 seq_printf(seq, "state: %s\n",
283 state < 0 ? "unsupported" : (state ? "open" : "closed"));
287 static int acpi_button_add_fs(struct acpi_device *device)
289 struct acpi_button *button = acpi_driver_data(device);
290 struct proc_dir_entry *entry = NULL;
293 /* procfs I/F for ACPI lid device only */
294 if (button->type != ACPI_BUTTON_TYPE_LID)
297 if (acpi_button_dir || acpi_lid_dir) {
298 pr_info("More than one Lid device found!\n");
302 /* create /proc/acpi/button */
303 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
304 if (!acpi_button_dir)
307 /* create /proc/acpi/button/lid */
308 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
311 goto remove_button_dir;
314 /* create /proc/acpi/button/lid/LID/ */
315 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
316 if (!acpi_device_dir(device)) {
321 /* create /proc/acpi/button/lid/LID/state */
322 entry = proc_create_single_data(ACPI_BUTTON_FILE_STATE, S_IRUGO,
323 acpi_device_dir(device), acpi_button_state_seq_show,
334 remove_proc_entry(acpi_device_bid(device),
336 acpi_device_dir(device) = NULL;
338 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
341 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
342 acpi_button_dir = NULL;
346 static int acpi_button_remove_fs(struct acpi_device *device)
348 struct acpi_button *button = acpi_driver_data(device);
350 if (button->type != ACPI_BUTTON_TYPE_LID)
353 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
354 acpi_device_dir(device));
355 remove_proc_entry(acpi_device_bid(device),
357 acpi_device_dir(device) = NULL;
358 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
360 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
361 acpi_button_dir = NULL;
366 /* Driver Interface */
367 int acpi_lid_open(void)
372 return acpi_lid_evaluate_state(lid_device);
374 EXPORT_SYMBOL(acpi_lid_open);
376 static int acpi_lid_update_state(struct acpi_device *device,
381 state = acpi_lid_evaluate_state(device);
385 if (state && signal_wakeup)
386 acpi_pm_wakeup_event(&device->dev);
388 return acpi_lid_notify_state(device, state);
391 static void acpi_lid_initialize_state(struct acpi_device *device)
393 struct acpi_button *button = acpi_driver_data(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, false);
402 case ACPI_BUTTON_LID_INIT_IGNORE:
407 button->lid_state_initialized = true;
410 static void acpi_lid_notify(acpi_handle handle, u32 event, void *data)
412 struct acpi_device *device = data;
413 struct acpi_button *button;
415 if (event != ACPI_BUTTON_NOTIFY_STATUS) {
416 acpi_handle_debug(device->handle, "Unsupported event [0x%x]\n",
421 button = acpi_driver_data(device);
422 if (!button->lid_state_initialized)
425 acpi_lid_update_state(device, true);
428 static void acpi_button_notify(acpi_handle handle, u32 event, void *data)
430 struct acpi_device *device = data;
431 struct acpi_button *button;
432 struct input_dev *input;
435 if (event != ACPI_BUTTON_NOTIFY_STATUS) {
436 acpi_handle_debug(device->handle, "Unsupported event [0x%x]\n",
441 acpi_pm_wakeup_event(&device->dev);
443 button = acpi_driver_data(device);
444 if (button->suspended)
447 input = button->input;
448 keycode = test_bit(KEY_SLEEP, input->keybit) ? KEY_SLEEP : KEY_POWER;
450 input_report_key(input, keycode, 1);
452 input_report_key(input, keycode, 0);
455 acpi_bus_generate_netlink_event(device->pnp.device_class,
456 dev_name(&device->dev),
457 event, ++button->pushed);
460 static void acpi_button_notify_run(void *data)
462 acpi_button_notify(NULL, ACPI_BUTTON_NOTIFY_STATUS, data);
465 static u32 acpi_button_event(void *data)
467 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_button_notify_run, data);
468 return ACPI_INTERRUPT_HANDLED;
471 #ifdef CONFIG_PM_SLEEP
472 static int acpi_button_suspend(struct device *dev)
474 struct acpi_device *device = to_acpi_device(dev);
475 struct acpi_button *button = acpi_driver_data(device);
477 button->suspended = true;
481 static int acpi_button_resume(struct device *dev)
483 struct input_dev *input;
484 struct acpi_device *device = to_acpi_device(dev);
485 struct acpi_button *button = acpi_driver_data(device);
487 button->suspended = false;
488 if (button->type == ACPI_BUTTON_TYPE_LID) {
489 button->last_state = !!acpi_lid_evaluate_state(device);
490 button->last_time = ktime_get();
491 acpi_lid_initialize_state(device);
494 if (button->type == ACPI_BUTTON_TYPE_POWER) {
495 input = button->input;
496 input_report_key(input, KEY_WAKEUP, 1);
498 input_report_key(input, KEY_WAKEUP, 0);
505 static int acpi_lid_input_open(struct input_dev *input)
507 struct acpi_device *device = input_get_drvdata(input);
508 struct acpi_button *button = acpi_driver_data(device);
510 button->last_state = !!acpi_lid_evaluate_state(device);
511 button->last_time = ktime_get();
512 acpi_lid_initialize_state(device);
517 static int acpi_button_add(struct acpi_device *device)
519 acpi_notify_handler handler;
520 struct acpi_button *button;
521 struct input_dev *input;
522 const char *hid = acpi_device_hid(device);
527 if (!strcmp(hid, ACPI_BUTTON_HID_LID) &&
528 lid_init_state == ACPI_BUTTON_LID_INIT_DISABLED)
531 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
535 device->driver_data = button;
537 button->input = input = input_allocate_device();
540 goto err_free_button;
543 name = acpi_device_name(device);
544 class = acpi_device_class(device);
546 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
547 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
548 button->type = ACPI_BUTTON_TYPE_POWER;
549 handler = acpi_button_notify;
550 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
551 sprintf(class, "%s/%s",
552 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
553 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
554 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
555 button->type = ACPI_BUTTON_TYPE_SLEEP;
556 handler = acpi_button_notify;
557 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
558 sprintf(class, "%s/%s",
559 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
560 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
561 button->type = ACPI_BUTTON_TYPE_LID;
562 handler = acpi_lid_notify;
563 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
564 sprintf(class, "%s/%s",
565 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
566 input->open = acpi_lid_input_open;
568 pr_info("Unsupported hid [%s]\n", hid);
573 error = acpi_button_add_fs(device);
576 input_free_device(input);
577 goto err_free_button;
580 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
583 input->phys = button->phys;
584 input->id.bustype = BUS_HOST;
585 input->id.product = button->type;
586 input->dev.parent = &device->dev;
588 switch (button->type) {
589 case ACPI_BUTTON_TYPE_POWER:
590 input_set_capability(input, EV_KEY, KEY_POWER);
591 input_set_capability(input, EV_KEY, KEY_WAKEUP);
594 case ACPI_BUTTON_TYPE_SLEEP:
595 input_set_capability(input, EV_KEY, KEY_SLEEP);
598 case ACPI_BUTTON_TYPE_LID:
599 input_set_capability(input, EV_SW, SW_LID);
603 input_set_drvdata(input, device);
604 error = input_register_device(input);
608 switch (device->device_type) {
609 case ACPI_BUS_TYPE_POWER_BUTTON:
610 status = acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
614 case ACPI_BUS_TYPE_SLEEP_BUTTON:
615 status = acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
620 status = acpi_install_notify_handler(device->handle,
621 ACPI_DEVICE_NOTIFY, handler,
625 if (ACPI_FAILURE(status)) {
627 goto err_input_unregister;
630 if (button->type == ACPI_BUTTON_TYPE_LID) {
632 * This assumes there's only one lid device, or if there are
633 * more we only care about the last one...
638 device_init_wakeup(&device->dev, true);
639 pr_info("%s [%s]\n", name, acpi_device_bid(device));
642 err_input_unregister:
643 input_unregister_device(input);
645 acpi_button_remove_fs(device);
651 static void acpi_button_remove(struct acpi_device *device)
653 struct acpi_button *button = acpi_driver_data(device);
655 switch (device->device_type) {
656 case ACPI_BUS_TYPE_POWER_BUTTON:
657 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
660 case ACPI_BUS_TYPE_SLEEP_BUTTON:
661 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
665 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
666 button->type == ACPI_BUTTON_TYPE_LID ?
671 acpi_os_wait_events_complete();
673 acpi_button_remove_fs(device);
674 input_unregister_device(button->input);
678 static int param_set_lid_init_state(const char *val,
679 const struct kernel_param *kp)
683 i = sysfs_match_string(lid_init_state_str, val);
688 pr_info("Initial lid state set to '%s'\n", lid_init_state_str[i]);
692 static int param_get_lid_init_state(char *buf, const struct kernel_param *kp)
696 for (i = 0; i < ARRAY_SIZE(lid_init_state_str); i++)
697 if (i == lid_init_state)
698 c += sprintf(buf + c, "[%s] ", lid_init_state_str[i]);
700 c += sprintf(buf + c, "%s ", lid_init_state_str[i]);
702 buf[c - 1] = '\n'; /* Replace the final space with a newline */
707 module_param_call(lid_init_state,
708 param_set_lid_init_state, param_get_lid_init_state,
710 MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
712 static int acpi_button_register_driver(struct acpi_driver *driver)
714 const struct dmi_system_id *dmi_id;
716 if (lid_init_state == -1) {
717 dmi_id = dmi_first_match(dmi_lid_quirks);
719 lid_init_state = (long)dmi_id->driver_data;
721 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
725 * Modules such as nouveau.ko and i915.ko have a link time dependency
726 * on acpi_lid_open(), and would therefore not be loadable on ACPI
727 * capable kernels booted in non-ACPI mode if the return value of
728 * acpi_bus_register_driver() is returned from here with ACPI disabled
729 * when this driver is built as a module.
734 return acpi_bus_register_driver(driver);
737 static void acpi_button_unregister_driver(struct acpi_driver *driver)
740 acpi_bus_unregister_driver(driver);
743 module_driver(acpi_button_driver, acpi_button_register_driver,
744 acpi_button_unregister_driver);