Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * button.c - ACPI Button Driver
4 *
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 */
8
9#define pr_fmt(fmt) "ACPI: button: " fmt
10
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>
23
24#define PREFIX "ACPI: "
25
26#define ACPI_BUTTON_CLASS "button"
27#define ACPI_BUTTON_FILE_INFO "info"
28#define ACPI_BUTTON_FILE_STATE "state"
29#define ACPI_BUTTON_TYPE_UNKNOWN 0x00
30#define ACPI_BUTTON_NOTIFY_STATUS 0x80
31
32#define ACPI_BUTTON_SUBCLASS_POWER "power"
33#define ACPI_BUTTON_HID_POWER "PNP0C0C"
34#define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
35#define ACPI_BUTTON_TYPE_POWER 0x01
36
37#define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
38#define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
39#define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
40#define ACPI_BUTTON_TYPE_SLEEP 0x03
41
42#define ACPI_BUTTON_SUBCLASS_LID "lid"
43#define ACPI_BUTTON_HID_LID "PNP0C0D"
44#define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
45#define ACPI_BUTTON_TYPE_LID 0x05
46
47#define ACPI_BUTTON_LID_INIT_IGNORE 0x00
48#define ACPI_BUTTON_LID_INIT_OPEN 0x01
49#define ACPI_BUTTON_LID_INIT_METHOD 0x02
50
51#define _COMPONENT ACPI_BUTTON_COMPONENT
52ACPI_MODULE_NAME("button");
53
54MODULE_AUTHOR("Paul Diefenbaugh");
55MODULE_DESCRIPTION("ACPI Button Driver");
56MODULE_LICENSE("GPL");
57
58static const struct acpi_device_id button_device_ids[] = {
59 {ACPI_BUTTON_HID_LID, 0},
60 {ACPI_BUTTON_HID_SLEEP, 0},
61 {ACPI_BUTTON_HID_SLEEPF, 0},
62 {ACPI_BUTTON_HID_POWER, 0},
63 {ACPI_BUTTON_HID_POWERF, 0},
64 {"", 0},
65};
66MODULE_DEVICE_TABLE(acpi, button_device_ids);
67
68/*
69 * Some devices which don't even have a lid in anyway have a broken _LID
70 * method (e.g. pointing to a floating gpio pin) causing spurious LID events.
71 */
72static const struct dmi_system_id lid_blacklst[] = {
73 {
74 /* GP-electronic T701 */
75 .matches = {
76 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
77 DMI_MATCH(DMI_PRODUCT_NAME, "T701"),
78 DMI_MATCH(DMI_BIOS_VERSION, "BYT70A.YNCHENG.WIN.007"),
79 },
80 },
81 {}
82};
83
84static int acpi_button_add(struct acpi_device *device);
85static int acpi_button_remove(struct acpi_device *device);
86static void acpi_button_notify(struct acpi_device *device, u32 event);
87
88#ifdef CONFIG_PM_SLEEP
89static int acpi_button_suspend(struct device *dev);
90static int acpi_button_resume(struct device *dev);
91#else
92#define acpi_button_suspend NULL
93#define acpi_button_resume NULL
94#endif
95static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
96
97static struct acpi_driver acpi_button_driver = {
98 .name = "button",
99 .class = ACPI_BUTTON_CLASS,
100 .ids = button_device_ids,
101 .ops = {
102 .add = acpi_button_add,
103 .remove = acpi_button_remove,
104 .notify = acpi_button_notify,
105 },
106 .drv.pm = &acpi_button_pm,
107};
108
109struct acpi_button {
110 unsigned int type;
111 struct input_dev *input;
112 char phys[32]; /* for input device */
113 unsigned long pushed;
114 int last_state;
115 ktime_t last_time;
116 bool suspended;
117};
118
119static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier);
120static struct acpi_device *lid_device;
121static u8 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
122
123static unsigned long lid_report_interval __read_mostly = 500;
124module_param(lid_report_interval, ulong, 0644);
125MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
126
127/* --------------------------------------------------------------------------
128 FS Interface (/proc)
129 -------------------------------------------------------------------------- */
130
131static struct proc_dir_entry *acpi_button_dir;
132static struct proc_dir_entry *acpi_lid_dir;
133
134static int acpi_lid_evaluate_state(struct acpi_device *device)
135{
136 unsigned long long lid_state;
137 acpi_status status;
138
139 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
140 if (ACPI_FAILURE(status))
141 return -ENODEV;
142
143 return lid_state ? 1 : 0;
144}
145
146static int acpi_lid_notify_state(struct acpi_device *device, int state)
147{
148 struct acpi_button *button = acpi_driver_data(device);
149 int ret;
150 ktime_t next_report;
151 bool do_update;
152
153 /*
154 * In lid_init_state=ignore mode, if user opens/closes lid
155 * frequently with "open" missing, and "last_time" is also updated
156 * frequently, "close" cannot be delivered to the userspace.
157 * So "last_time" is only updated after a timeout or an actual
158 * switch.
159 */
160 if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
161 button->last_state != !!state)
162 do_update = true;
163 else
164 do_update = false;
165
166 next_report = ktime_add(button->last_time,
167 ms_to_ktime(lid_report_interval));
168 if (button->last_state == !!state &&
169 ktime_after(ktime_get(), next_report)) {
170 /* Complain the buggy firmware */
171 pr_warn_once("The lid device is not compliant to SW_LID.\n");
172
173 /*
174 * Send the unreliable complement switch event:
175 *
176 * On most platforms, the lid device is reliable. However
177 * there are exceptions:
178 * 1. Platforms returning initial lid state as "close" by
179 * default after booting/resuming:
180 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
181 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
182 * 2. Platforms never reporting "open" events:
183 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
184 * On these buggy platforms, the usage model of the ACPI
185 * lid device actually is:
186 * 1. The initial returning value of _LID may not be
187 * reliable.
188 * 2. The open event may not be reliable.
189 * 3. The close event is reliable.
190 *
191 * But SW_LID is typed as input switch event, the input
192 * layer checks if the event is redundant. Hence if the
193 * state is not switched, the userspace cannot see this
194 * platform triggered reliable event. By inserting a
195 * complement switch event, it then is guaranteed that the
196 * platform triggered reliable one can always be seen by
197 * the userspace.
198 */
199 if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
200 do_update = true;
201 /*
202 * Do generate complement switch event for "close"
203 * as "close" is reliable and wrong "open" won't
204 * trigger unexpected behaviors.
205 * Do not generate complement switch event for
206 * "open" as "open" is not reliable and wrong
207 * "close" will trigger unexpected behaviors.
208 */
209 if (!state) {
210 input_report_switch(button->input,
211 SW_LID, state);
212 input_sync(button->input);
213 }
214 }
215 }
216 /* Send the platform triggered reliable event */
217 if (do_update) {
218 acpi_handle_debug(device->handle, "ACPI LID %s\n",
219 state ? "open" : "closed");
220 input_report_switch(button->input, SW_LID, !state);
221 input_sync(button->input);
222 button->last_state = !!state;
223 button->last_time = ktime_get();
224 }
225
226 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, device);
227 if (ret == NOTIFY_DONE)
228 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state,
229 device);
230 if (ret == NOTIFY_DONE || ret == NOTIFY_OK) {
231 /*
232 * It is also regarded as success if the notifier_chain
233 * returns NOTIFY_OK or NOTIFY_DONE.
234 */
235 ret = 0;
236 }
237 return ret;
238}
239
240static int __maybe_unused acpi_button_state_seq_show(struct seq_file *seq,
241 void *offset)
242{
243 struct acpi_device *device = seq->private;
244 int state;
245
246 state = acpi_lid_evaluate_state(device);
247 seq_printf(seq, "state: %s\n",
248 state < 0 ? "unsupported" : (state ? "open" : "closed"));
249 return 0;
250}
251
252static int acpi_button_add_fs(struct acpi_device *device)
253{
254 struct acpi_button *button = acpi_driver_data(device);
255 struct proc_dir_entry *entry = NULL;
256 int ret = 0;
257
258 /* procfs I/F for ACPI lid device only */
259 if (button->type != ACPI_BUTTON_TYPE_LID)
260 return 0;
261
262 if (acpi_button_dir || acpi_lid_dir) {
263 printk(KERN_ERR PREFIX "More than one Lid device found!\n");
264 return -EEXIST;
265 }
266
267 /* create /proc/acpi/button */
268 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
269 if (!acpi_button_dir)
270 return -ENODEV;
271
272 /* create /proc/acpi/button/lid */
273 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
274 if (!acpi_lid_dir) {
275 ret = -ENODEV;
276 goto remove_button_dir;
277 }
278
279 /* create /proc/acpi/button/lid/LID/ */
280 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
281 if (!acpi_device_dir(device)) {
282 ret = -ENODEV;
283 goto remove_lid_dir;
284 }
285
286 /* create /proc/acpi/button/lid/LID/state */
287 entry = proc_create_single_data(ACPI_BUTTON_FILE_STATE, S_IRUGO,
288 acpi_device_dir(device), acpi_button_state_seq_show,
289 device);
290 if (!entry) {
291 ret = -ENODEV;
292 goto remove_dev_dir;
293 }
294
295done:
296 return ret;
297
298remove_dev_dir:
299 remove_proc_entry(acpi_device_bid(device),
300 acpi_lid_dir);
301 acpi_device_dir(device) = NULL;
302remove_lid_dir:
303 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
304 acpi_lid_dir = NULL;
305remove_button_dir:
306 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
307 acpi_button_dir = NULL;
308 goto done;
309}
310
311static int acpi_button_remove_fs(struct acpi_device *device)
312{
313 struct acpi_button *button = acpi_driver_data(device);
314
315 if (button->type != ACPI_BUTTON_TYPE_LID)
316 return 0;
317
318 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
319 acpi_device_dir(device));
320 remove_proc_entry(acpi_device_bid(device),
321 acpi_lid_dir);
322 acpi_device_dir(device) = NULL;
323 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
324 acpi_lid_dir = NULL;
325 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
326 acpi_button_dir = NULL;
327
328 return 0;
329}
330
331/* --------------------------------------------------------------------------
332 Driver Interface
333 -------------------------------------------------------------------------- */
334int acpi_lid_notifier_register(struct notifier_block *nb)
335{
336 return blocking_notifier_chain_register(&acpi_lid_notifier, nb);
337}
338EXPORT_SYMBOL(acpi_lid_notifier_register);
339
340int acpi_lid_notifier_unregister(struct notifier_block *nb)
341{
342 return blocking_notifier_chain_unregister(&acpi_lid_notifier, nb);
343}
344EXPORT_SYMBOL(acpi_lid_notifier_unregister);
345
346int acpi_lid_open(void)
347{
348 if (!lid_device)
349 return -ENODEV;
350
351 return acpi_lid_evaluate_state(lid_device);
352}
353EXPORT_SYMBOL(acpi_lid_open);
354
355static int acpi_lid_update_state(struct acpi_device *device,
356 bool signal_wakeup)
357{
358 int state;
359
360 state = acpi_lid_evaluate_state(device);
361 if (state < 0)
362 return state;
363
364 if (state && signal_wakeup)
365 acpi_pm_wakeup_event(&device->dev);
366
367 return acpi_lid_notify_state(device, state);
368}
369
370static void acpi_lid_initialize_state(struct acpi_device *device)
371{
372 switch (lid_init_state) {
373 case ACPI_BUTTON_LID_INIT_OPEN:
374 (void)acpi_lid_notify_state(device, 1);
375 break;
376 case ACPI_BUTTON_LID_INIT_METHOD:
377 (void)acpi_lid_update_state(device, false);
378 break;
379 case ACPI_BUTTON_LID_INIT_IGNORE:
380 default:
381 break;
382 }
383}
384
385static void acpi_button_notify(struct acpi_device *device, u32 event)
386{
387 struct acpi_button *button = acpi_driver_data(device);
388 struct input_dev *input;
389 int users;
390
391 switch (event) {
392 case ACPI_FIXED_HARDWARE_EVENT:
393 event = ACPI_BUTTON_NOTIFY_STATUS;
394 /* fall through */
395 case ACPI_BUTTON_NOTIFY_STATUS:
396 input = button->input;
397 if (button->type == ACPI_BUTTON_TYPE_LID) {
398 mutex_lock(&button->input->mutex);
399 users = button->input->users;
400 mutex_unlock(&button->input->mutex);
401 if (users)
402 acpi_lid_update_state(device, true);
403 } else {
404 int keycode;
405
406 acpi_pm_wakeup_event(&device->dev);
407 if (button->suspended)
408 break;
409
410 keycode = test_bit(KEY_SLEEP, input->keybit) ?
411 KEY_SLEEP : KEY_POWER;
412 input_report_key(input, keycode, 1);
413 input_sync(input);
414 input_report_key(input, keycode, 0);
415 input_sync(input);
416
417 acpi_bus_generate_netlink_event(
418 device->pnp.device_class,
419 dev_name(&device->dev),
420 event, ++button->pushed);
421 }
422 break;
423 default:
424 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
425 "Unsupported event [0x%x]\n", event));
426 break;
427 }
428}
429
430#ifdef CONFIG_PM_SLEEP
431static int acpi_button_suspend(struct device *dev)
432{
433 struct acpi_device *device = to_acpi_device(dev);
434 struct acpi_button *button = acpi_driver_data(device);
435
436 button->suspended = true;
437 return 0;
438}
439
440static int acpi_button_resume(struct device *dev)
441{
442 struct acpi_device *device = to_acpi_device(dev);
443 struct acpi_button *button = acpi_driver_data(device);
444
445 button->suspended = false;
446 if (button->type == ACPI_BUTTON_TYPE_LID && button->input->users) {
447 button->last_state = !!acpi_lid_evaluate_state(device);
448 button->last_time = ktime_get();
449 acpi_lid_initialize_state(device);
450 }
451 return 0;
452}
453#endif
454
455static int acpi_lid_input_open(struct input_dev *input)
456{
457 struct acpi_device *device = input_get_drvdata(input);
458 struct acpi_button *button = acpi_driver_data(device);
459
460 button->last_state = !!acpi_lid_evaluate_state(device);
461 button->last_time = ktime_get();
462 acpi_lid_initialize_state(device);
463
464 return 0;
465}
466
467static int acpi_button_add(struct acpi_device *device)
468{
469 struct acpi_button *button;
470 struct input_dev *input;
471 const char *hid = acpi_device_hid(device);
472 char *name, *class;
473 int error;
474
475 if (!strcmp(hid, ACPI_BUTTON_HID_LID) && dmi_check_system(lid_blacklst))
476 return -ENODEV;
477
478 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
479 if (!button)
480 return -ENOMEM;
481
482 device->driver_data = button;
483
484 button->input = input = input_allocate_device();
485 if (!input) {
486 error = -ENOMEM;
487 goto err_free_button;
488 }
489
490 name = acpi_device_name(device);
491 class = acpi_device_class(device);
492
493 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
494 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
495 button->type = ACPI_BUTTON_TYPE_POWER;
496 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
497 sprintf(class, "%s/%s",
498 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
499 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
500 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
501 button->type = ACPI_BUTTON_TYPE_SLEEP;
502 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
503 sprintf(class, "%s/%s",
504 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
505 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
506 button->type = ACPI_BUTTON_TYPE_LID;
507 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
508 sprintf(class, "%s/%s",
509 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
510 input->open = acpi_lid_input_open;
511 } else {
512 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid);
513 error = -ENODEV;
514 goto err_free_input;
515 }
516
517 error = acpi_button_add_fs(device);
518 if (error)
519 goto err_free_input;
520
521 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
522
523 input->name = name;
524 input->phys = button->phys;
525 input->id.bustype = BUS_HOST;
526 input->id.product = button->type;
527 input->dev.parent = &device->dev;
528
529 switch (button->type) {
530 case ACPI_BUTTON_TYPE_POWER:
531 input_set_capability(input, EV_KEY, KEY_POWER);
532 break;
533
534 case ACPI_BUTTON_TYPE_SLEEP:
535 input_set_capability(input, EV_KEY, KEY_SLEEP);
536 break;
537
538 case ACPI_BUTTON_TYPE_LID:
539 input_set_capability(input, EV_SW, SW_LID);
540 break;
541 }
542
543 input_set_drvdata(input, device);
544 error = input_register_device(input);
545 if (error)
546 goto err_remove_fs;
547 if (button->type == ACPI_BUTTON_TYPE_LID) {
548 /*
549 * This assumes there's only one lid device, or if there are
550 * more we only care about the last one...
551 */
552 lid_device = device;
553 }
554
555 device_init_wakeup(&device->dev, true);
556 printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device));
557 return 0;
558
559 err_remove_fs:
560 acpi_button_remove_fs(device);
561 err_free_input:
562 input_free_device(input);
563 err_free_button:
564 kfree(button);
565 return error;
566}
567
568static int acpi_button_remove(struct acpi_device *device)
569{
570 struct acpi_button *button = acpi_driver_data(device);
571
572 acpi_button_remove_fs(device);
573 input_unregister_device(button->input);
574 kfree(button);
575 return 0;
576}
577
578static int param_set_lid_init_state(const char *val,
579 const struct kernel_param *kp)
580{
581 int result = 0;
582
583 if (!strncmp(val, "open", sizeof("open") - 1)) {
584 lid_init_state = ACPI_BUTTON_LID_INIT_OPEN;
585 pr_info("Notify initial lid state as open\n");
586 } else if (!strncmp(val, "method", sizeof("method") - 1)) {
587 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
588 pr_info("Notify initial lid state with _LID return value\n");
589 } else if (!strncmp(val, "ignore", sizeof("ignore") - 1)) {
590 lid_init_state = ACPI_BUTTON_LID_INIT_IGNORE;
591 pr_info("Do not notify initial lid state\n");
592 } else
593 result = -EINVAL;
594 return result;
595}
596
597static int param_get_lid_init_state(char *buffer,
598 const struct kernel_param *kp)
599{
600 switch (lid_init_state) {
601 case ACPI_BUTTON_LID_INIT_OPEN:
602 return sprintf(buffer, "open");
603 case ACPI_BUTTON_LID_INIT_METHOD:
604 return sprintf(buffer, "method");
605 case ACPI_BUTTON_LID_INIT_IGNORE:
606 return sprintf(buffer, "ignore");
607 default:
608 return sprintf(buffer, "invalid");
609 }
610 return 0;
611}
612
613module_param_call(lid_init_state,
614 param_set_lid_init_state, param_get_lid_init_state,
615 NULL, 0644);
616MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
617
618static int acpi_button_register_driver(struct acpi_driver *driver)
619{
620 /*
621 * Modules such as nouveau.ko and i915.ko have a link time dependency
622 * on acpi_lid_open(), and would therefore not be loadable on ACPI
623 * capable kernels booted in non-ACPI mode if the return value of
624 * acpi_bus_register_driver() is returned from here with ACPI disabled
625 * when this driver is built as a module.
626 */
627 if (acpi_disabled)
628 return 0;
629
630 return acpi_bus_register_driver(driver);
631}
632
633static void acpi_button_unregister_driver(struct acpi_driver *driver)
634{
635 if (!acpi_disabled)
636 acpi_bus_unregister_driver(driver);
637}
638
639module_driver(acpi_button_driver, acpi_button_register_driver,
640 acpi_button_unregister_driver);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * button.c - ACPI Button Driver
4 *
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 */
8
9#define pr_fmt(fmt) "ACPI: button: " fmt
10
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>
23
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
28
29#define ACPI_BUTTON_SUBCLASS_POWER "power"
30#define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
31#define ACPI_BUTTON_TYPE_POWER 0x01
32
33#define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
34#define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
35#define ACPI_BUTTON_TYPE_SLEEP 0x03
36
37#define ACPI_BUTTON_SUBCLASS_LID "lid"
38#define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
39#define ACPI_BUTTON_TYPE_LID 0x05
40
41enum {
42 ACPI_BUTTON_LID_INIT_IGNORE,
43 ACPI_BUTTON_LID_INIT_OPEN,
44 ACPI_BUTTON_LID_INIT_METHOD,
45 ACPI_BUTTON_LID_INIT_DISABLED,
46};
47
48static 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",
53};
54
55MODULE_AUTHOR("Paul Diefenbaugh");
56MODULE_DESCRIPTION("ACPI Button Driver");
57MODULE_LICENSE("GPL");
58
59static 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},
65 {"", 0},
66};
67MODULE_DEVICE_TABLE(acpi, button_device_ids);
68
69/* Please keep this list sorted alphabetically by vendor and model */
70static const struct dmi_system_id dmi_lid_quirks[] = {
71 {
72 /* GP-electronic T701, _LID method points to a floating GPIO */
73 .matches = {
74 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
75 DMI_MATCH(DMI_PRODUCT_NAME, "T701"),
76 DMI_MATCH(DMI_BIOS_VERSION, "BYT70A.YNCHENG.WIN.007"),
77 },
78 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_DISABLED,
79 },
80 {
81 /*
82 * Lenovo Yoga 9 14ITL5, initial notification of the LID device
83 * never happens.
84 */
85 .matches = {
86 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
87 DMI_MATCH(DMI_PRODUCT_NAME, "82BG"),
88 },
89 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
90 },
91 {
92 /*
93 * Medion Akoya E2215T, notification of the LID device only
94 * happens on close, not on open and _LID always returns closed.
95 */
96 .matches = {
97 DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
98 DMI_MATCH(DMI_PRODUCT_NAME, "E2215T"),
99 },
100 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
101 },
102 {
103 /*
104 * Medion Akoya E2228T, notification of the LID device only
105 * happens on close, not on open and _LID always returns closed.
106 */
107 .matches = {
108 DMI_MATCH(DMI_SYS_VENDOR, "MEDION"),
109 DMI_MATCH(DMI_PRODUCT_NAME, "E2228T"),
110 },
111 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
112 },
113 {
114 /*
115 * Razer Blade Stealth 13 late 2019, notification of the LID device
116 * only happens on close, not on open and _LID always returns closed.
117 */
118 .matches = {
119 DMI_MATCH(DMI_SYS_VENDOR, "Razer"),
120 DMI_MATCH(DMI_PRODUCT_NAME, "Razer Blade Stealth 13 Late 2019"),
121 },
122 .driver_data = (void *)(long)ACPI_BUTTON_LID_INIT_OPEN,
123 },
124 {}
125};
126
127static int acpi_button_add(struct acpi_device *device);
128static void acpi_button_remove(struct acpi_device *device);
129static void acpi_button_notify(struct acpi_device *device, u32 event);
130
131#ifdef CONFIG_PM_SLEEP
132static int acpi_button_suspend(struct device *dev);
133static int acpi_button_resume(struct device *dev);
134#else
135#define acpi_button_suspend NULL
136#define acpi_button_resume NULL
137#endif
138static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
139
140static struct acpi_driver acpi_button_driver = {
141 .name = "button",
142 .class = ACPI_BUTTON_CLASS,
143 .ids = button_device_ids,
144 .ops = {
145 .add = acpi_button_add,
146 .remove = acpi_button_remove,
147 .notify = acpi_button_notify,
148 },
149 .drv.pm = &acpi_button_pm,
150};
151
152struct acpi_button {
153 unsigned int type;
154 struct input_dev *input;
155 char phys[32]; /* for input device */
156 unsigned long pushed;
157 int last_state;
158 ktime_t last_time;
159 bool suspended;
160 bool lid_state_initialized;
161};
162
163static struct acpi_device *lid_device;
164static long lid_init_state = -1;
165
166static unsigned long lid_report_interval __read_mostly = 500;
167module_param(lid_report_interval, ulong, 0644);
168MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
169
170/* FS Interface (/proc) */
171static struct proc_dir_entry *acpi_button_dir;
172static struct proc_dir_entry *acpi_lid_dir;
173
174static int acpi_lid_evaluate_state(struct acpi_device *device)
175{
176 unsigned long long lid_state;
177 acpi_status status;
178
179 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
180 if (ACPI_FAILURE(status))
181 return -ENODEV;
182
183 return lid_state ? 1 : 0;
184}
185
186static int acpi_lid_notify_state(struct acpi_device *device, int state)
187{
188 struct acpi_button *button = acpi_driver_data(device);
189 ktime_t next_report;
190 bool do_update;
191
192 /*
193 * In lid_init_state=ignore mode, if user opens/closes lid
194 * frequently with "open" missing, and "last_time" is also updated
195 * frequently, "close" cannot be delivered to the userspace.
196 * So "last_time" is only updated after a timeout or an actual
197 * switch.
198 */
199 if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
200 button->last_state != !!state)
201 do_update = true;
202 else
203 do_update = false;
204
205 next_report = ktime_add(button->last_time,
206 ms_to_ktime(lid_report_interval));
207 if (button->last_state == !!state &&
208 ktime_after(ktime_get(), next_report)) {
209 /* Complain the buggy firmware */
210 pr_warn_once("The lid device is not compliant to SW_LID.\n");
211
212 /*
213 * Send the unreliable complement switch event:
214 *
215 * On most platforms, the lid device is reliable. However
216 * there are exceptions:
217 * 1. Platforms returning initial lid state as "close" by
218 * default after booting/resuming:
219 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
220 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
221 * 2. Platforms never reporting "open" events:
222 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
223 * On these buggy platforms, the usage model of the ACPI
224 * lid device actually is:
225 * 1. The initial returning value of _LID may not be
226 * reliable.
227 * 2. The open event may not be reliable.
228 * 3. The close event is reliable.
229 *
230 * But SW_LID is typed as input switch event, the input
231 * layer checks if the event is redundant. Hence if the
232 * state is not switched, the userspace cannot see this
233 * platform triggered reliable event. By inserting a
234 * complement switch event, it then is guaranteed that the
235 * platform triggered reliable one can always be seen by
236 * the userspace.
237 */
238 if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
239 do_update = true;
240 /*
241 * Do generate complement switch event for "close"
242 * as "close" is reliable and wrong "open" won't
243 * trigger unexpected behaviors.
244 * Do not generate complement switch event for
245 * "open" as "open" is not reliable and wrong
246 * "close" will trigger unexpected behaviors.
247 */
248 if (!state) {
249 input_report_switch(button->input,
250 SW_LID, state);
251 input_sync(button->input);
252 }
253 }
254 }
255 /* Send the platform triggered reliable event */
256 if (do_update) {
257 acpi_handle_debug(device->handle, "ACPI LID %s\n",
258 state ? "open" : "closed");
259 input_report_switch(button->input, SW_LID, !state);
260 input_sync(button->input);
261 button->last_state = !!state;
262 button->last_time = ktime_get();
263 }
264
265 return 0;
266}
267
268static int __maybe_unused acpi_button_state_seq_show(struct seq_file *seq,
269 void *offset)
270{
271 struct acpi_device *device = seq->private;
272 int state;
273
274 state = acpi_lid_evaluate_state(device);
275 seq_printf(seq, "state: %s\n",
276 state < 0 ? "unsupported" : (state ? "open" : "closed"));
277 return 0;
278}
279
280static int acpi_button_add_fs(struct acpi_device *device)
281{
282 struct acpi_button *button = acpi_driver_data(device);
283 struct proc_dir_entry *entry = NULL;
284 int ret = 0;
285
286 /* procfs I/F for ACPI lid device only */
287 if (button->type != ACPI_BUTTON_TYPE_LID)
288 return 0;
289
290 if (acpi_button_dir || acpi_lid_dir) {
291 pr_info("More than one Lid device found!\n");
292 return -EEXIST;
293 }
294
295 /* create /proc/acpi/button */
296 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
297 if (!acpi_button_dir)
298 return -ENODEV;
299
300 /* create /proc/acpi/button/lid */
301 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
302 if (!acpi_lid_dir) {
303 ret = -ENODEV;
304 goto remove_button_dir;
305 }
306
307 /* create /proc/acpi/button/lid/LID/ */
308 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
309 if (!acpi_device_dir(device)) {
310 ret = -ENODEV;
311 goto remove_lid_dir;
312 }
313
314 /* create /proc/acpi/button/lid/LID/state */
315 entry = proc_create_single_data(ACPI_BUTTON_FILE_STATE, S_IRUGO,
316 acpi_device_dir(device), acpi_button_state_seq_show,
317 device);
318 if (!entry) {
319 ret = -ENODEV;
320 goto remove_dev_dir;
321 }
322
323done:
324 return ret;
325
326remove_dev_dir:
327 remove_proc_entry(acpi_device_bid(device),
328 acpi_lid_dir);
329 acpi_device_dir(device) = NULL;
330remove_lid_dir:
331 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
332 acpi_lid_dir = NULL;
333remove_button_dir:
334 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
335 acpi_button_dir = NULL;
336 goto done;
337}
338
339static int acpi_button_remove_fs(struct acpi_device *device)
340{
341 struct acpi_button *button = acpi_driver_data(device);
342
343 if (button->type != ACPI_BUTTON_TYPE_LID)
344 return 0;
345
346 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
347 acpi_device_dir(device));
348 remove_proc_entry(acpi_device_bid(device),
349 acpi_lid_dir);
350 acpi_device_dir(device) = NULL;
351 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
352 acpi_lid_dir = NULL;
353 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
354 acpi_button_dir = NULL;
355
356 return 0;
357}
358
359/* Driver Interface */
360int acpi_lid_open(void)
361{
362 if (!lid_device)
363 return -ENODEV;
364
365 return acpi_lid_evaluate_state(lid_device);
366}
367EXPORT_SYMBOL(acpi_lid_open);
368
369static int acpi_lid_update_state(struct acpi_device *device,
370 bool signal_wakeup)
371{
372 int state;
373
374 state = acpi_lid_evaluate_state(device);
375 if (state < 0)
376 return state;
377
378 if (state && signal_wakeup)
379 acpi_pm_wakeup_event(&device->dev);
380
381 return acpi_lid_notify_state(device, state);
382}
383
384static void acpi_lid_initialize_state(struct acpi_device *device)
385{
386 struct acpi_button *button = acpi_driver_data(device);
387
388 switch (lid_init_state) {
389 case ACPI_BUTTON_LID_INIT_OPEN:
390 (void)acpi_lid_notify_state(device, 1);
391 break;
392 case ACPI_BUTTON_LID_INIT_METHOD:
393 (void)acpi_lid_update_state(device, false);
394 break;
395 case ACPI_BUTTON_LID_INIT_IGNORE:
396 default:
397 break;
398 }
399
400 button->lid_state_initialized = true;
401}
402
403static void acpi_button_notify(struct acpi_device *device, u32 event)
404{
405 struct acpi_button *button = acpi_driver_data(device);
406 struct input_dev *input;
407
408 switch (event) {
409 case ACPI_FIXED_HARDWARE_EVENT:
410 event = ACPI_BUTTON_NOTIFY_STATUS;
411 fallthrough;
412 case ACPI_BUTTON_NOTIFY_STATUS:
413 input = button->input;
414 if (button->type == ACPI_BUTTON_TYPE_LID) {
415 if (button->lid_state_initialized)
416 acpi_lid_update_state(device, true);
417 } else {
418 int keycode;
419
420 acpi_pm_wakeup_event(&device->dev);
421 if (button->suspended)
422 break;
423
424 keycode = test_bit(KEY_SLEEP, input->keybit) ?
425 KEY_SLEEP : KEY_POWER;
426 input_report_key(input, keycode, 1);
427 input_sync(input);
428 input_report_key(input, keycode, 0);
429 input_sync(input);
430
431 acpi_bus_generate_netlink_event(
432 device->pnp.device_class,
433 dev_name(&device->dev),
434 event, ++button->pushed);
435 }
436 break;
437 default:
438 acpi_handle_debug(device->handle, "Unsupported event [0x%x]\n",
439 event);
440 break;
441 }
442}
443
444#ifdef CONFIG_PM_SLEEP
445static int acpi_button_suspend(struct device *dev)
446{
447 struct acpi_device *device = to_acpi_device(dev);
448 struct acpi_button *button = acpi_driver_data(device);
449
450 button->suspended = true;
451 return 0;
452}
453
454static int acpi_button_resume(struct device *dev)
455{
456 struct acpi_device *device = to_acpi_device(dev);
457 struct acpi_button *button = acpi_driver_data(device);
458
459 button->suspended = false;
460 if (button->type == ACPI_BUTTON_TYPE_LID) {
461 button->last_state = !!acpi_lid_evaluate_state(device);
462 button->last_time = ktime_get();
463 acpi_lid_initialize_state(device);
464 }
465 return 0;
466}
467#endif
468
469static int acpi_lid_input_open(struct input_dev *input)
470{
471 struct acpi_device *device = input_get_drvdata(input);
472 struct acpi_button *button = acpi_driver_data(device);
473
474 button->last_state = !!acpi_lid_evaluate_state(device);
475 button->last_time = ktime_get();
476 acpi_lid_initialize_state(device);
477
478 return 0;
479}
480
481static int acpi_button_add(struct acpi_device *device)
482{
483 struct acpi_button *button;
484 struct input_dev *input;
485 const char *hid = acpi_device_hid(device);
486 char *name, *class;
487 int error;
488
489 if (!strcmp(hid, ACPI_BUTTON_HID_LID) &&
490 lid_init_state == ACPI_BUTTON_LID_INIT_DISABLED)
491 return -ENODEV;
492
493 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
494 if (!button)
495 return -ENOMEM;
496
497 device->driver_data = button;
498
499 button->input = input = input_allocate_device();
500 if (!input) {
501 error = -ENOMEM;
502 goto err_free_button;
503 }
504
505 name = acpi_device_name(device);
506 class = acpi_device_class(device);
507
508 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
509 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
510 button->type = ACPI_BUTTON_TYPE_POWER;
511 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
512 sprintf(class, "%s/%s",
513 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
514 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
515 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
516 button->type = ACPI_BUTTON_TYPE_SLEEP;
517 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
518 sprintf(class, "%s/%s",
519 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
520 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
521 button->type = ACPI_BUTTON_TYPE_LID;
522 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
523 sprintf(class, "%s/%s",
524 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
525 input->open = acpi_lid_input_open;
526 } else {
527 pr_info("Unsupported hid [%s]\n", hid);
528 error = -ENODEV;
529 goto err_free_input;
530 }
531
532 error = acpi_button_add_fs(device);
533 if (error)
534 goto err_free_input;
535
536 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
537
538 input->name = name;
539 input->phys = button->phys;
540 input->id.bustype = BUS_HOST;
541 input->id.product = button->type;
542 input->dev.parent = &device->dev;
543
544 switch (button->type) {
545 case ACPI_BUTTON_TYPE_POWER:
546 input_set_capability(input, EV_KEY, KEY_POWER);
547 break;
548
549 case ACPI_BUTTON_TYPE_SLEEP:
550 input_set_capability(input, EV_KEY, KEY_SLEEP);
551 break;
552
553 case ACPI_BUTTON_TYPE_LID:
554 input_set_capability(input, EV_SW, SW_LID);
555 break;
556 }
557
558 input_set_drvdata(input, device);
559 error = input_register_device(input);
560 if (error)
561 goto err_remove_fs;
562 if (button->type == ACPI_BUTTON_TYPE_LID) {
563 /*
564 * This assumes there's only one lid device, or if there are
565 * more we only care about the last one...
566 */
567 lid_device = device;
568 }
569
570 device_init_wakeup(&device->dev, true);
571 pr_info("%s [%s]\n", name, acpi_device_bid(device));
572 return 0;
573
574 err_remove_fs:
575 acpi_button_remove_fs(device);
576 err_free_input:
577 input_free_device(input);
578 err_free_button:
579 kfree(button);
580 return error;
581}
582
583static void acpi_button_remove(struct acpi_device *device)
584{
585 struct acpi_button *button = acpi_driver_data(device);
586
587 acpi_button_remove_fs(device);
588 input_unregister_device(button->input);
589 kfree(button);
590}
591
592static int param_set_lid_init_state(const char *val,
593 const struct kernel_param *kp)
594{
595 int i;
596
597 i = sysfs_match_string(lid_init_state_str, val);
598 if (i < 0)
599 return i;
600
601 lid_init_state = i;
602 pr_info("Initial lid state set to '%s'\n", lid_init_state_str[i]);
603 return 0;
604}
605
606static int param_get_lid_init_state(char *buf, const struct kernel_param *kp)
607{
608 int i, c = 0;
609
610 for (i = 0; i < ARRAY_SIZE(lid_init_state_str); i++)
611 if (i == lid_init_state)
612 c += sprintf(buf + c, "[%s] ", lid_init_state_str[i]);
613 else
614 c += sprintf(buf + c, "%s ", lid_init_state_str[i]);
615
616 buf[c - 1] = '\n'; /* Replace the final space with a newline */
617
618 return c;
619}
620
621module_param_call(lid_init_state,
622 param_set_lid_init_state, param_get_lid_init_state,
623 NULL, 0644);
624MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
625
626static int acpi_button_register_driver(struct acpi_driver *driver)
627{
628 const struct dmi_system_id *dmi_id;
629
630 if (lid_init_state == -1) {
631 dmi_id = dmi_first_match(dmi_lid_quirks);
632 if (dmi_id)
633 lid_init_state = (long)dmi_id->driver_data;
634 else
635 lid_init_state = ACPI_BUTTON_LID_INIT_METHOD;
636 }
637
638 /*
639 * Modules such as nouveau.ko and i915.ko have a link time dependency
640 * on acpi_lid_open(), and would therefore not be loadable on ACPI
641 * capable kernels booted in non-ACPI mode if the return value of
642 * acpi_bus_register_driver() is returned from here with ACPI disabled
643 * when this driver is built as a module.
644 */
645 if (acpi_disabled)
646 return 0;
647
648 return acpi_bus_register_driver(driver);
649}
650
651static void acpi_button_unregister_driver(struct acpi_driver *driver)
652{
653 if (!acpi_disabled)
654 acpi_bus_unregister_driver(driver);
655}
656
657module_driver(acpi_button_driver, acpi_button_register_driver,
658 acpi_button_unregister_driver);