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 <acpi/button.h>
35 #define PREFIX "ACPI: "
37 #define ACPI_BUTTON_CLASS "button"
38 #define ACPI_BUTTON_FILE_INFO "info"
39 #define ACPI_BUTTON_FILE_STATE "state"
40 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00
41 #define ACPI_BUTTON_NOTIFY_STATUS 0x80
43 #define ACPI_BUTTON_SUBCLASS_POWER "power"
44 #define ACPI_BUTTON_HID_POWER "PNP0C0C"
45 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
46 #define ACPI_BUTTON_TYPE_POWER 0x01
48 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
49 #define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
50 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
51 #define ACPI_BUTTON_TYPE_SLEEP 0x03
53 #define ACPI_BUTTON_SUBCLASS_LID "lid"
54 #define ACPI_BUTTON_HID_LID "PNP0C0D"
55 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
56 #define ACPI_BUTTON_TYPE_LID 0x05
58 #define ACPI_BUTTON_LID_INIT_IGNORE 0x00
59 #define ACPI_BUTTON_LID_INIT_OPEN 0x01
61 #define _COMPONENT ACPI_BUTTON_COMPONENT
62 ACPI_MODULE_NAME("button");
64 MODULE_AUTHOR("Paul Diefenbaugh");
65 MODULE_DESCRIPTION("ACPI Button Driver");
66 MODULE_LICENSE("GPL");
68 static const struct acpi_device_id button_device_ids
[] = {
69 {ACPI_BUTTON_HID_LID
, 0},
70 {ACPI_BUTTON_HID_SLEEP
, 0},
71 {ACPI_BUTTON_HID_SLEEPF
, 0},
72 {ACPI_BUTTON_HID_POWER
, 0},
73 {ACPI_BUTTON_HID_POWERF
, 0},
76 MODULE_DEVICE_TABLE(acpi
, button_device_ids
);
78 static int acpi_button_add(struct acpi_device
*device
);
79 static int acpi_button_remove(struct acpi_device
*device
);
80 static void acpi_button_notify(struct acpi_device
*device
, u32 event
);
82 #ifdef CONFIG_PM_SLEEP
83 static int acpi_button_suspend(struct device
*dev
);
84 static int acpi_button_resume(struct device
*dev
);
86 #define acpi_button_suspend NULL
87 #define acpi_button_resume NULL
89 static SIMPLE_DEV_PM_OPS(acpi_button_pm
, acpi_button_suspend
, acpi_button_resume
);
91 static struct acpi_driver acpi_button_driver
= {
93 .class = ACPI_BUTTON_CLASS
,
94 .ids
= button_device_ids
,
96 .add
= acpi_button_add
,
97 .remove
= acpi_button_remove
,
98 .notify
= acpi_button_notify
,
100 .drv
.pm
= &acpi_button_pm
,
105 struct input_dev
*input
;
106 char phys
[32]; /* for input device */
107 unsigned long pushed
;
113 static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier
);
114 static struct acpi_device
*lid_device
;
115 static u8 lid_init_state
= ACPI_BUTTON_LID_INIT_OPEN
;
117 static unsigned long lid_report_interval __read_mostly
= 500;
118 module_param(lid_report_interval
, ulong
, 0644);
119 MODULE_PARM_DESC(lid_report_interval
, "Interval (ms) between lid key events");
121 /* --------------------------------------------------------------------------
123 -------------------------------------------------------------------------- */
125 static struct proc_dir_entry
*acpi_button_dir
;
126 static struct proc_dir_entry
*acpi_lid_dir
;
128 static int acpi_lid_evaluate_state(struct acpi_device
*device
)
130 unsigned long long lid_state
;
133 status
= acpi_evaluate_integer(device
->handle
, "_LID", NULL
, &lid_state
);
134 if (ACPI_FAILURE(status
))
137 return lid_state
? 1 : 0;
140 static int acpi_lid_notify_state(struct acpi_device
*device
, int state
)
142 struct acpi_button
*button
= acpi_driver_data(device
);
148 * In lid_init_state=ignore mode, if user opens/closes lid
149 * frequently with "open" missing, and "last_time" is also updated
150 * frequently, "close" cannot be delivered to the userspace.
151 * So "last_time" is only updated after a timeout or an actual
154 if (lid_init_state
!= ACPI_BUTTON_LID_INIT_IGNORE
||
155 button
->last_state
!= !!state
)
160 next_report
= ktime_add(button
->last_time
,
161 ms_to_ktime(lid_report_interval
));
162 if (button
->last_state
== !!state
&&
163 ktime_after(ktime_get(), next_report
)) {
164 /* Complain the buggy firmware */
165 pr_warn_once("The lid device is not compliant to SW_LID.\n");
168 * Send the unreliable complement switch event:
170 * On most platforms, the lid device is reliable. However
171 * there are exceptions:
172 * 1. Platforms returning initial lid state as "close" by
173 * default after booting/resuming:
174 * https://bugzilla.kernel.org/show_bug.cgi?id=89211
175 * https://bugzilla.kernel.org/show_bug.cgi?id=106151
176 * 2. Platforms never reporting "open" events:
177 * https://bugzilla.kernel.org/show_bug.cgi?id=106941
178 * On these buggy platforms, the usage model of the ACPI
179 * lid device actually is:
180 * 1. The initial returning value of _LID may not be
182 * 2. The open event may not be reliable.
183 * 3. The close event is reliable.
185 * But SW_LID is typed as input switch event, the input
186 * layer checks if the event is redundant. Hence if the
187 * state is not switched, the userspace cannot see this
188 * platform triggered reliable event. By inserting a
189 * complement switch event, it then is guaranteed that the
190 * platform triggered reliable one can always be seen by
193 if (lid_init_state
== ACPI_BUTTON_LID_INIT_IGNORE
) {
196 * Do generate complement switch event for "close"
197 * as "close" is reliable and wrong "open" won't
198 * trigger unexpected behaviors.
199 * Do not generate complement switch event for
200 * "open" as "open" is not reliable and wrong
201 * "close" will trigger unexpected behaviors.
204 input_report_switch(button
->input
,
206 input_sync(button
->input
);
210 /* Send the platform triggered reliable event */
212 input_report_switch(button
->input
, SW_LID
, !state
);
213 input_sync(button
->input
);
214 button
->last_state
= !!state
;
215 button
->last_time
= ktime_get();
219 pm_wakeup_event(&device
->dev
, 0);
221 ret
= blocking_notifier_call_chain(&acpi_lid_notifier
, state
, device
);
222 if (ret
== NOTIFY_DONE
)
223 ret
= blocking_notifier_call_chain(&acpi_lid_notifier
, state
,
225 if (ret
== NOTIFY_DONE
|| ret
== NOTIFY_OK
) {
227 * It is also regarded as success if the notifier_chain
228 * returns NOTIFY_OK or NOTIFY_DONE.
235 static int acpi_button_state_seq_show(struct seq_file
*seq
, void *offset
)
237 struct acpi_device
*device
= seq
->private;
240 state
= acpi_lid_evaluate_state(device
);
241 seq_printf(seq
, "state: %s\n",
242 state
< 0 ? "unsupported" : (state
? "open" : "closed"));
246 static int acpi_button_state_open_fs(struct inode
*inode
, struct file
*file
)
248 return single_open(file
, acpi_button_state_seq_show
, PDE_DATA(inode
));
251 static const struct file_operations acpi_button_state_fops
= {
252 .owner
= THIS_MODULE
,
253 .open
= acpi_button_state_open_fs
,
256 .release
= single_release
,
259 static int acpi_button_add_fs(struct acpi_device
*device
)
261 struct acpi_button
*button
= acpi_driver_data(device
);
262 struct proc_dir_entry
*entry
= NULL
;
265 /* procfs I/F for ACPI lid device only */
266 if (button
->type
!= ACPI_BUTTON_TYPE_LID
)
269 if (acpi_button_dir
|| acpi_lid_dir
) {
270 printk(KERN_ERR PREFIX
"More than one Lid device found!\n");
274 /* create /proc/acpi/button */
275 acpi_button_dir
= proc_mkdir(ACPI_BUTTON_CLASS
, acpi_root_dir
);
276 if (!acpi_button_dir
)
279 /* create /proc/acpi/button/lid */
280 acpi_lid_dir
= proc_mkdir(ACPI_BUTTON_SUBCLASS_LID
, acpi_button_dir
);
283 goto remove_button_dir
;
286 /* create /proc/acpi/button/lid/LID/ */
287 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
), acpi_lid_dir
);
288 if (!acpi_device_dir(device
)) {
293 /* create /proc/acpi/button/lid/LID/state */
294 entry
= proc_create_data(ACPI_BUTTON_FILE_STATE
,
295 S_IRUGO
, acpi_device_dir(device
),
296 &acpi_button_state_fops
, device
);
306 remove_proc_entry(acpi_device_bid(device
),
308 acpi_device_dir(device
) = NULL
;
310 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID
, acpi_button_dir
);
313 remove_proc_entry(ACPI_BUTTON_CLASS
, acpi_root_dir
);
314 acpi_button_dir
= NULL
;
318 static int acpi_button_remove_fs(struct acpi_device
*device
)
320 struct acpi_button
*button
= acpi_driver_data(device
);
322 if (button
->type
!= ACPI_BUTTON_TYPE_LID
)
325 remove_proc_entry(ACPI_BUTTON_FILE_STATE
,
326 acpi_device_dir(device
));
327 remove_proc_entry(acpi_device_bid(device
),
329 acpi_device_dir(device
) = NULL
;
330 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID
, acpi_button_dir
);
332 remove_proc_entry(ACPI_BUTTON_CLASS
, acpi_root_dir
);
333 acpi_button_dir
= NULL
;
338 /* --------------------------------------------------------------------------
340 -------------------------------------------------------------------------- */
341 int acpi_lid_notifier_register(struct notifier_block
*nb
)
343 return blocking_notifier_chain_register(&acpi_lid_notifier
, nb
);
345 EXPORT_SYMBOL(acpi_lid_notifier_register
);
347 int acpi_lid_notifier_unregister(struct notifier_block
*nb
)
349 return blocking_notifier_chain_unregister(&acpi_lid_notifier
, nb
);
351 EXPORT_SYMBOL(acpi_lid_notifier_unregister
);
353 int acpi_lid_open(void)
358 return acpi_lid_evaluate_state(lid_device
);
360 EXPORT_SYMBOL(acpi_lid_open
);
362 static int acpi_lid_update_state(struct acpi_device
*device
)
366 state
= acpi_lid_evaluate_state(device
);
370 return acpi_lid_notify_state(device
, state
);
373 static void acpi_lid_initialize_state(struct acpi_device
*device
)
375 switch (lid_init_state
) {
376 case ACPI_BUTTON_LID_INIT_OPEN
:
377 (void)acpi_lid_notify_state(device
, 1);
379 case ACPI_BUTTON_LID_INIT_IGNORE
:
385 static void acpi_button_notify(struct acpi_device
*device
, u32 event
)
387 struct acpi_button
*button
= acpi_driver_data(device
);
388 struct input_dev
*input
;
391 case ACPI_FIXED_HARDWARE_EVENT
:
392 event
= ACPI_BUTTON_NOTIFY_STATUS
;
394 case ACPI_BUTTON_NOTIFY_STATUS
:
395 input
= button
->input
;
396 if (button
->type
== ACPI_BUTTON_TYPE_LID
) {
397 acpi_lid_update_state(device
);
401 pm_wakeup_event(&device
->dev
, 0);
402 if (button
->suspended
)
405 keycode
= test_bit(KEY_SLEEP
, input
->keybit
) ?
406 KEY_SLEEP
: KEY_POWER
;
407 input_report_key(input
, keycode
, 1);
409 input_report_key(input
, keycode
, 0);
412 acpi_bus_generate_netlink_event(
413 device
->pnp
.device_class
,
414 dev_name(&device
->dev
),
415 event
, ++button
->pushed
);
419 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
420 "Unsupported event [0x%x]\n", event
));
425 #ifdef CONFIG_PM_SLEEP
426 static int acpi_button_suspend(struct device
*dev
)
428 struct acpi_device
*device
= to_acpi_device(dev
);
429 struct acpi_button
*button
= acpi_driver_data(device
);
431 button
->suspended
= true;
435 static int acpi_button_resume(struct device
*dev
)
437 struct acpi_device
*device
= to_acpi_device(dev
);
438 struct acpi_button
*button
= acpi_driver_data(device
);
440 button
->suspended
= false;
441 if (button
->type
== ACPI_BUTTON_TYPE_LID
)
442 acpi_lid_initialize_state(device
);
447 static int acpi_button_add(struct acpi_device
*device
)
449 struct acpi_button
*button
;
450 struct input_dev
*input
;
451 const char *hid
= acpi_device_hid(device
);
455 button
= kzalloc(sizeof(struct acpi_button
), GFP_KERNEL
);
459 device
->driver_data
= button
;
461 button
->input
= input
= input_allocate_device();
464 goto err_free_button
;
467 name
= acpi_device_name(device
);
468 class = acpi_device_class(device
);
470 if (!strcmp(hid
, ACPI_BUTTON_HID_POWER
) ||
471 !strcmp(hid
, ACPI_BUTTON_HID_POWERF
)) {
472 button
->type
= ACPI_BUTTON_TYPE_POWER
;
473 strcpy(name
, ACPI_BUTTON_DEVICE_NAME_POWER
);
474 sprintf(class, "%s/%s",
475 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_POWER
);
476 } else if (!strcmp(hid
, ACPI_BUTTON_HID_SLEEP
) ||
477 !strcmp(hid
, ACPI_BUTTON_HID_SLEEPF
)) {
478 button
->type
= ACPI_BUTTON_TYPE_SLEEP
;
479 strcpy(name
, ACPI_BUTTON_DEVICE_NAME_SLEEP
);
480 sprintf(class, "%s/%s",
481 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_SLEEP
);
482 } else if (!strcmp(hid
, ACPI_BUTTON_HID_LID
)) {
483 button
->type
= ACPI_BUTTON_TYPE_LID
;
484 strcpy(name
, ACPI_BUTTON_DEVICE_NAME_LID
);
485 sprintf(class, "%s/%s",
486 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_LID
);
487 button
->last_state
= !!acpi_lid_evaluate_state(device
);
488 button
->last_time
= ktime_get();
490 printk(KERN_ERR PREFIX
"Unsupported hid [%s]\n", hid
);
495 error
= acpi_button_add_fs(device
);
499 snprintf(button
->phys
, sizeof(button
->phys
), "%s/button/input0", hid
);
502 input
->phys
= button
->phys
;
503 input
->id
.bustype
= BUS_HOST
;
504 input
->id
.product
= button
->type
;
505 input
->dev
.parent
= &device
->dev
;
507 switch (button
->type
) {
508 case ACPI_BUTTON_TYPE_POWER
:
509 input_set_capability(input
, EV_KEY
, KEY_POWER
);
512 case ACPI_BUTTON_TYPE_SLEEP
:
513 input_set_capability(input
, EV_KEY
, KEY_SLEEP
);
516 case ACPI_BUTTON_TYPE_LID
:
517 input_set_capability(input
, EV_SW
, SW_LID
);
521 error
= input_register_device(input
);
524 if (button
->type
== ACPI_BUTTON_TYPE_LID
) {
525 acpi_lid_initialize_state(device
);
527 * This assumes there's only one lid device, or if there are
528 * more we only care about the last one...
533 printk(KERN_INFO PREFIX
"%s [%s]\n", name
, acpi_device_bid(device
));
537 acpi_button_remove_fs(device
);
539 input_free_device(input
);
545 static int acpi_button_remove(struct acpi_device
*device
)
547 struct acpi_button
*button
= acpi_driver_data(device
);
549 acpi_button_remove_fs(device
);
550 input_unregister_device(button
->input
);
555 static int param_set_lid_init_state(const char *val
, struct kernel_param
*kp
)
559 if (!strncmp(val
, "open", sizeof("open") - 1)) {
560 lid_init_state
= ACPI_BUTTON_LID_INIT_OPEN
;
561 pr_info("Notify initial lid state as open\n");
562 } else if (!strncmp(val
, "ignore", sizeof("ignore") - 1)) {
563 lid_init_state
= ACPI_BUTTON_LID_INIT_IGNORE
;
564 pr_info("Do not notify initial lid state\n");
570 static int param_get_lid_init_state(char *buffer
, struct kernel_param
*kp
)
572 switch (lid_init_state
) {
573 case ACPI_BUTTON_LID_INIT_OPEN
:
574 return sprintf(buffer
, "open");
575 case ACPI_BUTTON_LID_INIT_IGNORE
:
576 return sprintf(buffer
, "ignore");
578 return sprintf(buffer
, "invalid");
583 module_param_call(lid_init_state
,
584 param_set_lid_init_state
, param_get_lid_init_state
,
586 MODULE_PARM_DESC(lid_init_state
, "Behavior for reporting LID initial state");
588 module_acpi_driver(acpi_button_driver
);