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 PREFIX "ACPI: "
26 #define ACPI_BUTTON_CLASS "button"
27 #define ACPI_BUTTON_FILE_STATE "state"
28 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00
29 #define ACPI_BUTTON_NOTIFY_STATUS 0x80
31 #define ACPI_BUTTON_SUBCLASS_POWER "power"
32 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
33 #define ACPI_BUTTON_TYPE_POWER 0x01
35 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
36 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
37 #define ACPI_BUTTON_TYPE_SLEEP 0x03
39 #define ACPI_BUTTON_SUBCLASS_LID "lid"
40 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
41 #define ACPI_BUTTON_TYPE_LID 0x05
44 ACPI_BUTTON_LID_INIT_IGNORE,
45 ACPI_BUTTON_LID_INIT_OPEN,
46 ACPI_BUTTON_LID_INIT_METHOD,
47 ACPI_BUTTON_LID_INIT_DISABLED,
50 static const char * const lid_init_state_str[] = {
51 [ACPI_BUTTON_LID_INIT_IGNORE] = "ignore",
52 [ACPI_BUTTON_LID_INIT_OPEN] = "open",
53 [ACPI_BUTTON_LID_INIT_METHOD] = "method",
54 [ACPI_BUTTON_LID_INIT_DISABLED] = "disabled",
57 #define _COMPONENT ACPI_BUTTON_COMPONENT
58 ACPI_MODULE_NAME("button");
60 MODULE_AUTHOR("Paul Diefenbaugh");
61 MODULE_DESCRIPTION("ACPI Button Driver");
62 MODULE_LICENSE("GPL");
64 static const struct acpi_device_id button_device_ids[] = {
65 {ACPI_BUTTON_HID_LID, 0},
66 {ACPI_BUTTON_HID_SLEEP, 0},
67 {ACPI_BUTTON_HID_SLEEPF, 0},
68 {ACPI_BUTTON_HID_POWER, 0},
69 {ACPI_BUTTON_HID_POWERF, 0},
72 MODULE_DEVICE_TABLE(acpi, button_device_ids);
74 /* Please keep this list sorted alphabetically by vendor and model */
75 static const struct dmi_system_id dmi_lid_quirks[] = {
77 /* GP-electronic T701, _LID method points to a floating GPIO */
79 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
80 DMI_MATCH(DMI_PRODUCT_NAME, "T701"),
81 DMI_MATCH(DMI_BIOS_VERSION, "BYT70A.YNCHENG.WIN.007"),
83 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_DISABLED,
87 * Medion Akoya E2215T, notification of the LID device only
88 * happens on close, not on open and _LID always returns closed.
91 DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
92 DMI_MATCH(DMI_PRODUCT_NAME, "E2215T MD60198"),
94 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
98 * Razer Blade Stealth 13 late 2019, notification of the LID device
99 * only happens on close, not on open and _LID always returns closed.
102 DMI_MATCH(DMI_SYS_VENDOR, "Razer"),
103 DMI_MATCH(DMI_PRODUCT_NAME, "Razer Blade Stealth 13 Late 2019"),
105 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
110 static int acpi_button_add(struct acpi_device *device);
111 static int acpi_button_remove(struct acpi_device *device);
112 static void acpi_button_notify(struct acpi_device *device, u32 event);
114 #ifdef CONFIG_PM_SLEEP
115 static int acpi_button_suspend(struct device *dev);
116 static int acpi_button_resume(struct device *dev);
118 #define acpi_button_suspend NULL
119 #define acpi_button_resume NULL
121 static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
123 static struct acpi_driver acpi_button_driver = {
125 .class = ACPI_BUTTON_CLASS,
126 .ids = button_device_ids,
128 .add = acpi_button_add,
129 .remove = acpi_button_remove,
130 .notify = acpi_button_notify,
132 .drv.pm = &acpi_button_pm,
137 struct input_dev *input;
138 char phys[32]; /* for input device */
139 unsigned long pushed;
143 bool lid_state_initialized;
146 static struct acpi_device *lid_device;
147 static long lid_init_state = -1;
149 static unsigned long lid_report_interval __read_mostly = 500;
150 module_param(lid_report_interval, ulong, 0644);
151 MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
153 /* --------------------------------------------------------------------------
155 -------------------------------------------------------------------------- */
157 static struct proc_dir_entry *acpi_button_dir;
158 static struct proc_dir_entry *acpi_lid_dir;
160 static int acpi_lid_evaluate_state(struct acpi_device *device)
162 unsigned long long lid_state;
165 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
166 if (ACPI_FAILURE(status))
169 return lid_state ? 1 : 0;
172 static int acpi_lid_notify_state(struct acpi_device *device, int state)
174 struct acpi_button *button = acpi_driver_data(device);
179 * In lid_init_state=ignore mode, if user opens/closes lid
180 * frequently with "open" missing, and "last_time" is also updated
181 * frequently, "close" cannot be delivered to the userspace.
182 * So "last_time" is only updated after a timeout or an actual
185 if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
186 button->last_state != !!state)
191 next_report = ktime_add(button->last_time,
192 ms_to_ktime(lid_report_interval));
193 if (button->last_state == !!state &&
194 ktime_after(ktime_get(), next_report)) {
195 /* Complain the buggy firmware */
196 pr_warn_once("The lid device is not compliant to SW_LID.\n");
199 * Send the unreliable complement switch event:
201 * On most platforms, the lid device is reliable. However
202 * there are exceptions:
203 * 1. Platforms returning initial lid state as "close" by
204 * default after booting/resuming:
205 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
206 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
207 * 2. Platforms never reporting "open" events:
208 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
209 * On these buggy platforms, the usage model of the ACPI
210 * lid device actually is:
211 * 1. The initial returning value of _LID may not be
213 * 2. The open event may not be reliable.
214 * 3. The close event is reliable.
216 * But SW_LID is typed as input switch event, the input
217 * layer checks if the event is redundant. Hence if the
218 * state is not switched, the userspace cannot see this
219 * platform triggered reliable event. By inserting a
220 * complement switch event, it then is guaranteed that the
221 * platform triggered reliable one can always be seen by
224 if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
227 * Do generate complement switch event for "close"
228 * as "close" is reliable and wrong "open" won't
229 * trigger unexpected behaviors.
230 * Do not generate complement switch event for
231 * "open" as "open" is not reliable and wrong
232 * "close" will trigger unexpected behaviors.
235 input_report_switch(button->input,
237 input_sync(button->input);
241 /* Send the platform triggered reliable event */
243 acpi_handle_debug(device->handle, "ACPI LID %s\n",
244 state ? "open" : "closed");
245 input_report_switch(button->input, SW_LID, !state);
246 input_sync(button->input);
247 button->last_state = !!state;
248 button->last_time = ktime_get();
254 static int __maybe_unused acpi_button_state_seq_show(struct seq_file *seq,
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_add_fs(struct acpi_device *device)
268 struct acpi_button *button = acpi_driver_data(device);
269 struct proc_dir_entry *entry = NULL;
272 /* procfs I/F for ACPI lid device only */
273 if (button->type != ACPI_BUTTON_TYPE_LID)
276 if (acpi_button_dir || acpi_lid_dir) {
277 printk(KERN_ERR PREFIX "More than one Lid device found!\n");
281 /* create /proc/acpi/button */
282 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
283 if (!acpi_button_dir)
286 /* create /proc/acpi/button/lid */
287 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
290 goto remove_button_dir;
293 /* create /proc/acpi/button/lid/LID/ */
294 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
295 if (!acpi_device_dir(device)) {
300 /* create /proc/acpi/button/lid/LID/state */
301 entry = proc_create_single_data(ACPI_BUTTON_FILE_STATE, S_IRUGO,
302 acpi_device_dir(device), acpi_button_state_seq_show,
313 remove_proc_entry(acpi_device_bid(device),
315 acpi_device_dir(device) = NULL;
317 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
320 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
321 acpi_button_dir = NULL;
325 static int acpi_button_remove_fs(struct acpi_device *device)
327 struct acpi_button *button = acpi_driver_data(device);
329 if (button->type != ACPI_BUTTON_TYPE_LID)
332 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
333 acpi_device_dir(device));
334 remove_proc_entry(acpi_device_bid(device),
336 acpi_device_dir(device) = NULL;
337 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
339 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
340 acpi_button_dir = NULL;
345 /* --------------------------------------------------------------------------
347 -------------------------------------------------------------------------- */
348 int acpi_lid_open(void)
353 return acpi_lid_evaluate_state(lid_device);
355 EXPORT_SYMBOL(acpi_lid_open);
357 static int acpi_lid_update_state(struct acpi_device *device,
362 state = acpi_lid_evaluate_state(device);
366 if (state && signal_wakeup)
367 acpi_pm_wakeup_event(&device->dev);
369 return acpi_lid_notify_state(device, state);
372 static void acpi_lid_initialize_state(struct acpi_device *device)
374 struct acpi_button *button = acpi_driver_data(device);
376 switch (lid_init_state) {
377 case ACPI_BUTTON_LID_INIT_OPEN:
378 (void)acpi_lid_notify_state(device, 1);
380 case ACPI_BUTTON_LID_INIT_METHOD:
381 (void)acpi_lid_update_state(device, false);
383 case ACPI_BUTTON_LID_INIT_IGNORE:
388 button->lid_state_initialized = true;
391 static void acpi_button_notify(struct acpi_device *device, u32 event)
393 struct acpi_button *button = acpi_driver_data(device);
394 struct input_dev *input;
397 case ACPI_FIXED_HARDWARE_EVENT:
398 event = ACPI_BUTTON_NOTIFY_STATUS;
400 case ACPI_BUTTON_NOTIFY_STATUS:
401 input = button->input;
402 if (button->type == ACPI_BUTTON_TYPE_LID) {
403 if (button->lid_state_initialized)
404 acpi_lid_update_state(device, true);
408 acpi_pm_wakeup_event(&device->dev);
409 if (button->suspended)
412 keycode = test_bit(KEY_SLEEP, input->keybit) ?
413 KEY_SLEEP : KEY_POWER;
414 input_report_key(input, keycode, 1);
416 input_report_key(input, keycode, 0);
419 acpi_bus_generate_netlink_event(
420 device->pnp.device_class,
421 dev_name(&device->dev),
422 event, ++button->pushed);
426 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
427 "Unsupported event [0x%x]\n", event));
432 #ifdef CONFIG_PM_SLEEP
433 static int acpi_button_suspend(struct device *dev)
435 struct acpi_device *device = to_acpi_device(dev);
436 struct acpi_button *button = acpi_driver_data(device);
438 button->suspended = true;
442 static int acpi_button_resume(struct device *dev)
444 struct acpi_device *device = to_acpi_device(dev);
445 struct acpi_button *button = acpi_driver_data(device);
447 button->suspended = false;
448 if (button->type == ACPI_BUTTON_TYPE_LID) {
449 button->last_state = !!acpi_lid_evaluate_state(device);
450 button->last_time = ktime_get();
451 acpi_lid_initialize_state(device);
457 static int acpi_lid_input_open(struct input_dev *input)
459 struct acpi_device *device = input_get_drvdata(input);
460 struct acpi_button *button = acpi_driver_data(device);
462 button->last_state = !!acpi_lid_evaluate_state(device);
463 button->last_time = ktime_get();
464 acpi_lid_initialize_state(device);
469 static int acpi_button_add(struct acpi_device *device)
471 struct acpi_button *button;
472 struct input_dev *input;
473 const char *hid = acpi_device_hid(device);
477 if (!strcmp(hid, ACPI_BUTTON_HID_LID) &&
478 lid_init_state == ACPI_BUTTON_LID_INIT_DISABLED)
481 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
485 device->driver_data = button;
487 button->input = input = input_allocate_device();
490 goto err_free_button;
493 name = acpi_device_name(device);
494 class = acpi_device_class(device);
496 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
497 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
498 button->type = ACPI_BUTTON_TYPE_POWER;
499 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
500 sprintf(class, "%s/%s",
501 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
502 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
503 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
504 button->type = ACPI_BUTTON_TYPE_SLEEP;
505 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
506 sprintf(class, "%s/%s",
507 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
508 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
509 button->type = ACPI_BUTTON_TYPE_LID;
510 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
511 sprintf(class, "%s/%s",
512 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
513 input->open = acpi_lid_input_open;
515 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid);
520 error = acpi_button_add_fs(device);
524 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
527 input->phys = button->phys;
528 input->id.bustype = BUS_HOST;
529 input->id.product = button->type;
530 input->dev.parent = &device->dev;
532 switch (button->type) {
533 case ACPI_BUTTON_TYPE_POWER:
534 input_set_capability(input, EV_KEY, KEY_POWER);
537 case ACPI_BUTTON_TYPE_SLEEP:
538 input_set_capability(input, EV_KEY, KEY_SLEEP);
541 case ACPI_BUTTON_TYPE_LID:
542 input_set_capability(input, EV_SW, SW_LID);
546 input_set_drvdata(input, device);
547 error = input_register_device(input);
550 if (button->type == ACPI_BUTTON_TYPE_LID) {
552 * This assumes there's only one lid device, or if there are
553 * more we only care about the last one...
558 device_init_wakeup(&device->dev, true);
559 printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device));
563 acpi_button_remove_fs(device);
565 input_free_device(input);
571 static int acpi_button_remove(struct acpi_device *device)
573 struct acpi_button *button = acpi_driver_data(device);
575 acpi_button_remove_fs(device);
576 input_unregister_device(button->input);
581 static int param_set_lid_init_state(const char *val,
582 const struct kernel_param *kp)
586 i = sysfs_match_string(lid_init_state_str, val);
591 pr_info("Initial lid state set to '%s'\n", lid_init_state_str[i]);
595 static int param_get_lid_init_state(char *buf, const struct kernel_param *kp)
599 for (i = 0; i < ARRAY_SIZE(lid_init_state_str); i++)
600 if (i == lid_init_state)
601 c += sprintf(buf + c, "[%s] ", lid_init_state_str[i]);
603 c += sprintf(buf + c, "%s ", lid_init_state_str[i]);
605 buf[c - 1] = '\n'; /* Replace the final space with a newline */
610 module_param_call(lid_init_state,
611 param_set_lid_init_state, param_get_lid_init_state,
613 MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
615 static int acpi_button_register_driver(struct acpi_driver *driver)
617 const struct dmi_system_id *dmi_id;
619 if (lid_init_state == -1) {
620 dmi_id = dmi_first_match(dmi_lid_quirks);
622 lid_init_state = (long)dmi_id->driver_data;
624 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
628 * Modules such as nouveau.ko and i915.ko have a link time dependency
629 * on acpi_lid_open(), and would therefore not be loadable on ACPI
630 * capable kernels booted in non-ACPI mode if the return value of
631 * acpi_bus_register_driver() is returned from here with ACPI disabled
632 * when this driver is built as a module.
637 return acpi_bus_register_driver(driver);
640 static void acpi_button_unregister_driver(struct acpi_driver *driver)
643 acpi_bus_unregister_driver(driver);
646 module_driver(acpi_button_driver, acpi_button_register_driver,
647 acpi_button_unregister_driver);