1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * button.c - ACPI Button Driver
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,
135 * Samsung galaxybook2 ,initial _LID device notification returns
139 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
140 DMI_MATCH(DMI_PRODUCT_NAME, "750XED"),
142 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
147 static int acpi_button_add(struct acpi_device *device);
148 static void acpi_button_remove(struct acpi_device *device);
150 #ifdef CONFIG_PM_SLEEP
151 static int acpi_button_suspend(struct device *dev);
152 static int acpi_button_resume(struct device *dev);
154 #define acpi_button_suspend NULL
155 #define acpi_button_resume NULL
157 static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
159 static struct acpi_driver acpi_button_driver = {
161 .class = ACPI_BUTTON_CLASS,
162 .ids = button_device_ids,
164 .add = acpi_button_add,
165 .remove = acpi_button_remove,
167 .drv.pm = &acpi_button_pm,
172 struct input_dev *input;
173 char phys[32]; /* for input device */
174 unsigned long pushed;
178 bool lid_state_initialized;
181 static struct acpi_device *lid_device;
182 static long lid_init_state = -1;
184 static unsigned long lid_report_interval __read_mostly = 500;
185 module_param(lid_report_interval, ulong, 0644);
186 MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
188 /* FS Interface (/proc) */
189 static struct proc_dir_entry *acpi_button_dir;
190 static struct proc_dir_entry *acpi_lid_dir;
192 static int acpi_lid_evaluate_state(struct acpi_device *device)
194 unsigned long long lid_state;
197 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
198 if (ACPI_FAILURE(status))
201 return lid_state ? 1 : 0;
204 static int acpi_lid_notify_state(struct acpi_device *device, int state)
206 struct acpi_button *button = acpi_driver_data(device);
211 * In lid_init_state=ignore mode, if user opens/closes lid
212 * frequently with "open" missing, and "last_time" is also updated
213 * frequently, "close" cannot be delivered to the userspace.
214 * So "last_time" is only updated after a timeout or an actual
217 if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
218 button->last_state != !!state)
223 next_report = ktime_add(button->last_time,
224 ms_to_ktime(lid_report_interval));
225 if (button->last_state == !!state &&
226 ktime_after(ktime_get(), next_report)) {
227 /* Complain the buggy firmware */
228 pr_warn_once("The lid device is not compliant to SW_LID.\n");
231 * Send the unreliable complement switch event:
233 * On most platforms, the lid device is reliable. However
234 * there are exceptions:
235 * 1. Platforms returning initial lid state as "close" by
236 * default after booting/resuming:
237 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
238 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
239 * 2. Platforms never reporting "open" events:
240 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
241 * On these buggy platforms, the usage model of the ACPI
242 * lid device actually is:
243 * 1. The initial returning value of _LID may not be
245 * 2. The open event may not be reliable.
246 * 3. The close event is reliable.
248 * But SW_LID is typed as input switch event, the input
249 * layer checks if the event is redundant. Hence if the
250 * state is not switched, the userspace cannot see this
251 * platform triggered reliable event. By inserting a
252 * complement switch event, it then is guaranteed that the
253 * platform triggered reliable one can always be seen by
256 if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
259 * Do generate complement switch event for "close"
260 * as "close" is reliable and wrong "open" won't
261 * trigger unexpected behaviors.
262 * Do not generate complement switch event for
263 * "open" as "open" is not reliable and wrong
264 * "close" will trigger unexpected behaviors.
267 input_report_switch(button->input,
269 input_sync(button->input);
273 /* Send the platform triggered reliable event */
275 acpi_handle_debug(device->handle, "ACPI LID %s\n",
276 state ? "open" : "closed");
277 input_report_switch(button->input, SW_LID, !state);
278 input_sync(button->input);
279 button->last_state = !!state;
280 button->last_time = ktime_get();
286 static int __maybe_unused acpi_button_state_seq_show(struct seq_file *seq,
289 struct acpi_device *device = seq->private;
292 state = acpi_lid_evaluate_state(device);
293 seq_printf(seq, "state: %s\n",
294 state < 0 ? "unsupported" : (state ? "open" : "closed"));
298 static int acpi_button_add_fs(struct acpi_device *device)
300 struct acpi_button *button = acpi_driver_data(device);
301 struct proc_dir_entry *entry = NULL;
304 /* procfs I/F for ACPI lid device only */
305 if (button->type != ACPI_BUTTON_TYPE_LID)
308 if (acpi_button_dir || acpi_lid_dir) {
309 pr_info("More than one Lid device found!\n");
313 /* create /proc/acpi/button */
314 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
315 if (!acpi_button_dir)
318 /* create /proc/acpi/button/lid */
319 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
322 goto remove_button_dir;
325 /* create /proc/acpi/button/lid/LID/ */
326 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
327 if (!acpi_device_dir(device)) {
332 /* create /proc/acpi/button/lid/LID/state */
333 entry = proc_create_single_data(ACPI_BUTTON_FILE_STATE, S_IRUGO,
334 acpi_device_dir(device), acpi_button_state_seq_show,
345 remove_proc_entry(acpi_device_bid(device),
347 acpi_device_dir(device) = NULL;
349 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;
357 static int acpi_button_remove_fs(struct acpi_device *device)
359 struct acpi_button *button = acpi_driver_data(device);
361 if (button->type != ACPI_BUTTON_TYPE_LID)
364 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
365 acpi_device_dir(device));
366 remove_proc_entry(acpi_device_bid(device),
368 acpi_device_dir(device) = NULL;
369 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
371 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
372 acpi_button_dir = NULL;
377 /* Driver Interface */
378 int acpi_lid_open(void)
383 return acpi_lid_evaluate_state(lid_device);
385 EXPORT_SYMBOL(acpi_lid_open);
387 static int acpi_lid_update_state(struct acpi_device *device,
392 state = acpi_lid_evaluate_state(device);
396 if (state && signal_wakeup)
397 acpi_pm_wakeup_event(&device->dev);
399 return acpi_lid_notify_state(device, state);
402 static void acpi_lid_initialize_state(struct acpi_device *device)
404 struct acpi_button *button = acpi_driver_data(device);
406 switch (lid_init_state) {
407 case ACPI_BUTTON_LID_INIT_OPEN:
408 (void)acpi_lid_notify_state(device, 1);
410 case ACPI_BUTTON_LID_INIT_METHOD:
411 (void)acpi_lid_update_state(device, false);
413 case ACPI_BUTTON_LID_INIT_IGNORE:
418 button->lid_state_initialized = true;
421 static void acpi_lid_notify(acpi_handle handle, u32 event, void *data)
423 struct acpi_device *device = data;
424 struct acpi_button *button;
426 if (event != ACPI_BUTTON_NOTIFY_STATUS) {
427 acpi_handle_debug(device->handle, "Unsupported event [0x%x]\n",
432 button = acpi_driver_data(device);
433 if (!button->lid_state_initialized)
436 acpi_lid_update_state(device, true);
439 static void acpi_button_notify(acpi_handle handle, u32 event, void *data)
441 struct acpi_device *device = data;
442 struct acpi_button *button;
443 struct input_dev *input;
446 if (event != ACPI_BUTTON_NOTIFY_STATUS) {
447 acpi_handle_debug(device->handle, "Unsupported event [0x%x]\n",
452 acpi_pm_wakeup_event(&device->dev);
454 button = acpi_driver_data(device);
455 if (button->suspended)
458 input = button->input;
459 keycode = test_bit(KEY_SLEEP, input->keybit) ? KEY_SLEEP : KEY_POWER;
461 input_report_key(input, keycode, 1);
463 input_report_key(input, keycode, 0);
466 acpi_bus_generate_netlink_event(device->pnp.device_class,
467 dev_name(&device->dev),
468 event, ++button->pushed);
471 static void acpi_button_notify_run(void *data)
473 acpi_button_notify(NULL, ACPI_BUTTON_NOTIFY_STATUS, data);
476 static u32 acpi_button_event(void *data)
478 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_button_notify_run, data);
479 return ACPI_INTERRUPT_HANDLED;
482 #ifdef CONFIG_PM_SLEEP
483 static int acpi_button_suspend(struct device *dev)
485 struct acpi_device *device = to_acpi_device(dev);
486 struct acpi_button *button = acpi_driver_data(device);
488 button->suspended = true;
492 static int acpi_button_resume(struct device *dev)
494 struct input_dev *input;
495 struct acpi_device *device = to_acpi_device(dev);
496 struct acpi_button *button = acpi_driver_data(device);
498 button->suspended = false;
499 if (button->type == ACPI_BUTTON_TYPE_LID) {
500 button->last_state = !!acpi_lid_evaluate_state(device);
501 button->last_time = ktime_get();
502 acpi_lid_initialize_state(device);
505 if (button->type == ACPI_BUTTON_TYPE_POWER) {
506 input = button->input;
507 input_report_key(input, KEY_WAKEUP, 1);
509 input_report_key(input, KEY_WAKEUP, 0);
516 static int acpi_lid_input_open(struct input_dev *input)
518 struct acpi_device *device = input_get_drvdata(input);
519 struct acpi_button *button = acpi_driver_data(device);
521 button->last_state = !!acpi_lid_evaluate_state(device);
522 button->last_time = ktime_get();
523 acpi_lid_initialize_state(device);
528 static int acpi_button_add(struct acpi_device *device)
530 acpi_notify_handler handler;
531 struct acpi_button *button;
532 struct input_dev *input;
533 const char *hid = acpi_device_hid(device);
538 if (!strcmp(hid, ACPI_BUTTON_HID_LID) &&
539 lid_init_state == ACPI_BUTTON_LID_INIT_DISABLED)
542 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
546 device->driver_data = button;
548 button->input = input = input_allocate_device();
551 goto err_free_button;
554 name = acpi_device_name(device);
555 class = acpi_device_class(device);
557 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
558 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
559 button->type = ACPI_BUTTON_TYPE_POWER;
560 handler = acpi_button_notify;
561 strscpy(name, ACPI_BUTTON_DEVICE_NAME_POWER, MAX_ACPI_DEVICE_NAME_LEN);
562 sprintf(class, "%s/%s",
563 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
564 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
565 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
566 button->type = ACPI_BUTTON_TYPE_SLEEP;
567 handler = acpi_button_notify;
568 strscpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP, MAX_ACPI_DEVICE_NAME_LEN);
569 sprintf(class, "%s/%s",
570 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
571 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
572 button->type = ACPI_BUTTON_TYPE_LID;
573 handler = acpi_lid_notify;
574 strscpy(name, ACPI_BUTTON_DEVICE_NAME_LID, MAX_ACPI_DEVICE_NAME_LEN);
575 sprintf(class, "%s/%s",
576 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
577 input->open = acpi_lid_input_open;
579 pr_info("Unsupported hid [%s]\n", hid);
584 error = acpi_button_add_fs(device);
587 input_free_device(input);
588 goto err_free_button;
591 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
594 input->phys = button->phys;
595 input->id.bustype = BUS_HOST;
596 input->id.product = button->type;
597 input->dev.parent = &device->dev;
599 switch (button->type) {
600 case ACPI_BUTTON_TYPE_POWER:
601 input_set_capability(input, EV_KEY, KEY_POWER);
602 input_set_capability(input, EV_KEY, KEY_WAKEUP);
605 case ACPI_BUTTON_TYPE_SLEEP:
606 input_set_capability(input, EV_KEY, KEY_SLEEP);
609 case ACPI_BUTTON_TYPE_LID:
610 input_set_capability(input, EV_SW, SW_LID);
614 input_set_drvdata(input, device);
615 error = input_register_device(input);
619 switch (device->device_type) {
620 case ACPI_BUS_TYPE_POWER_BUTTON:
621 status = acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
625 case ACPI_BUS_TYPE_SLEEP_BUTTON:
626 status = acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
631 status = acpi_install_notify_handler(device->handle,
632 ACPI_DEVICE_NOTIFY, handler,
636 if (ACPI_FAILURE(status)) {
638 goto err_input_unregister;
641 if (button->type == ACPI_BUTTON_TYPE_LID) {
643 * This assumes there's only one lid device, or if there are
644 * more we only care about the last one...
649 device_init_wakeup(&device->dev, true);
650 pr_info("%s [%s]\n", name, acpi_device_bid(device));
653 err_input_unregister:
654 input_unregister_device(input);
656 acpi_button_remove_fs(device);
662 static void acpi_button_remove(struct acpi_device *device)
664 struct acpi_button *button = acpi_driver_data(device);
666 switch (device->device_type) {
667 case ACPI_BUS_TYPE_POWER_BUTTON:
668 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
671 case ACPI_BUS_TYPE_SLEEP_BUTTON:
672 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
676 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
677 button->type == ACPI_BUTTON_TYPE_LID ?
682 acpi_os_wait_events_complete();
684 acpi_button_remove_fs(device);
685 input_unregister_device(button->input);
689 static int param_set_lid_init_state(const char *val,
690 const struct kernel_param *kp)
694 i = sysfs_match_string(lid_init_state_str, val);
699 pr_info("Initial lid state set to '%s'\n", lid_init_state_str[i]);
703 static int param_get_lid_init_state(char *buf, const struct kernel_param *kp)
707 for (i = 0; i < ARRAY_SIZE(lid_init_state_str); i++)
708 if (i == lid_init_state)
709 c += sprintf(buf + c, "[%s] ", lid_init_state_str[i]);
711 c += sprintf(buf + c, "%s ", lid_init_state_str[i]);
713 buf[c - 1] = '\n'; /* Replace the final space with a newline */
718 module_param_call(lid_init_state,
719 param_set_lid_init_state, param_get_lid_init_state,
721 MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
723 static int acpi_button_register_driver(struct acpi_driver *driver)
725 const struct dmi_system_id *dmi_id;
727 if (lid_init_state == -1) {
728 dmi_id = dmi_first_match(dmi_lid_quirks);
730 lid_init_state = (long)dmi_id->driver_data;
732 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
736 * Modules such as nouveau.ko and i915.ko have a link time dependency
737 * on acpi_lid_open(), and would therefore not be loadable on ACPI
738 * capable kernels booted in non-ACPI mode if the return value of
739 * acpi_bus_register_driver() is returned from here with ACPI disabled
740 * when this driver is built as a module.
745 return acpi_bus_register_driver(driver);
748 static void acpi_button_unregister_driver(struct acpi_driver *driver)
751 acpi_bus_unregister_driver(driver);
754 module_driver(acpi_button_driver, acpi_button_register_driver,
755 acpi_button_unregister_driver);