Loading...
1/*
2 * button.c - ACPI Button Driver
3 *
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
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.
13 *
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.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#include <linux/kernel.h>
27#include <linux/module.h>
28#include <linux/init.h>
29#include <linux/types.h>
30#include <linux/proc_fs.h>
31#include <linux/seq_file.h>
32#include <linux/input.h>
33#include <linux/slab.h>
34#include <acpi/acpi_bus.h>
35#include <acpi/acpi_drivers.h>
36
37#define PREFIX "ACPI: "
38
39#define ACPI_BUTTON_CLASS "button"
40#define ACPI_BUTTON_FILE_INFO "info"
41#define ACPI_BUTTON_FILE_STATE "state"
42#define ACPI_BUTTON_TYPE_UNKNOWN 0x00
43#define ACPI_BUTTON_NOTIFY_STATUS 0x80
44
45#define ACPI_BUTTON_SUBCLASS_POWER "power"
46#define ACPI_BUTTON_HID_POWER "PNP0C0C"
47#define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
48#define ACPI_BUTTON_TYPE_POWER 0x01
49
50#define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
51#define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
52#define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
53#define ACPI_BUTTON_TYPE_SLEEP 0x03
54
55#define ACPI_BUTTON_SUBCLASS_LID "lid"
56#define ACPI_BUTTON_HID_LID "PNP0C0D"
57#define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
58#define ACPI_BUTTON_TYPE_LID 0x05
59
60#define _COMPONENT ACPI_BUTTON_COMPONENT
61ACPI_MODULE_NAME("button");
62
63MODULE_AUTHOR("Paul Diefenbaugh");
64MODULE_DESCRIPTION("ACPI Button Driver");
65MODULE_LICENSE("GPL");
66
67static const struct acpi_device_id button_device_ids[] = {
68 {ACPI_BUTTON_HID_LID, 0},
69 {ACPI_BUTTON_HID_SLEEP, 0},
70 {ACPI_BUTTON_HID_SLEEPF, 0},
71 {ACPI_BUTTON_HID_POWER, 0},
72 {ACPI_BUTTON_HID_POWERF, 0},
73 {"", 0},
74};
75MODULE_DEVICE_TABLE(acpi, button_device_ids);
76
77static int acpi_button_add(struct acpi_device *device);
78static int acpi_button_remove(struct acpi_device *device, int type);
79static int acpi_button_resume(struct acpi_device *device);
80static void acpi_button_notify(struct acpi_device *device, u32 event);
81
82static struct acpi_driver acpi_button_driver = {
83 .name = "button",
84 .class = ACPI_BUTTON_CLASS,
85 .ids = button_device_ids,
86 .ops = {
87 .add = acpi_button_add,
88 .resume = acpi_button_resume,
89 .remove = acpi_button_remove,
90 .notify = acpi_button_notify,
91 },
92};
93
94struct acpi_button {
95 unsigned int type;
96 struct input_dev *input;
97 char phys[32]; /* for input device */
98 unsigned long pushed;
99 bool wakeup_enabled;
100};
101
102static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier);
103static struct acpi_device *lid_device;
104
105/* --------------------------------------------------------------------------
106 FS Interface (/proc)
107 -------------------------------------------------------------------------- */
108
109static struct proc_dir_entry *acpi_button_dir;
110static struct proc_dir_entry *acpi_lid_dir;
111
112static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
113{
114 struct acpi_device *device = seq->private;
115 acpi_status status;
116 unsigned long long state;
117
118 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &state);
119 seq_printf(seq, "state: %s\n",
120 ACPI_FAILURE(status) ? "unsupported" :
121 (state ? "open" : "closed"));
122 return 0;
123}
124
125static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
126{
127 return single_open(file, acpi_button_state_seq_show, PDE(inode)->data);
128}
129
130static const struct file_operations acpi_button_state_fops = {
131 .owner = THIS_MODULE,
132 .open = acpi_button_state_open_fs,
133 .read = seq_read,
134 .llseek = seq_lseek,
135 .release = single_release,
136};
137
138static int acpi_button_add_fs(struct acpi_device *device)
139{
140 struct acpi_button *button = acpi_driver_data(device);
141 struct proc_dir_entry *entry = NULL;
142 int ret = 0;
143
144 /* procfs I/F for ACPI lid device only */
145 if (button->type != ACPI_BUTTON_TYPE_LID)
146 return 0;
147
148 if (acpi_button_dir || acpi_lid_dir) {
149 printk(KERN_ERR PREFIX "More than one Lid device found!\n");
150 return -EEXIST;
151 }
152
153 /* create /proc/acpi/button */
154 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
155 if (!acpi_button_dir)
156 return -ENODEV;
157
158 /* create /proc/acpi/button/lid */
159 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
160 if (!acpi_lid_dir) {
161 ret = -ENODEV;
162 goto remove_button_dir;
163 }
164
165 /* create /proc/acpi/button/lid/LID/ */
166 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
167 if (!acpi_device_dir(device)) {
168 ret = -ENODEV;
169 goto remove_lid_dir;
170 }
171
172 /* create /proc/acpi/button/lid/LID/state */
173 entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
174 S_IRUGO, acpi_device_dir(device),
175 &acpi_button_state_fops, device);
176 if (!entry) {
177 ret = -ENODEV;
178 goto remove_dev_dir;
179 }
180
181done:
182 return ret;
183
184remove_dev_dir:
185 remove_proc_entry(acpi_device_bid(device),
186 acpi_lid_dir);
187 acpi_device_dir(device) = NULL;
188remove_lid_dir:
189 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
190remove_button_dir:
191 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
192 goto done;
193}
194
195static int acpi_button_remove_fs(struct acpi_device *device)
196{
197 struct acpi_button *button = acpi_driver_data(device);
198
199 if (button->type != ACPI_BUTTON_TYPE_LID)
200 return 0;
201
202 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
203 acpi_device_dir(device));
204 remove_proc_entry(acpi_device_bid(device),
205 acpi_lid_dir);
206 acpi_device_dir(device) = NULL;
207 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
208 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
209
210 return 0;
211}
212
213/* --------------------------------------------------------------------------
214 Driver Interface
215 -------------------------------------------------------------------------- */
216int acpi_lid_notifier_register(struct notifier_block *nb)
217{
218 return blocking_notifier_chain_register(&acpi_lid_notifier, nb);
219}
220EXPORT_SYMBOL(acpi_lid_notifier_register);
221
222int acpi_lid_notifier_unregister(struct notifier_block *nb)
223{
224 return blocking_notifier_chain_unregister(&acpi_lid_notifier, nb);
225}
226EXPORT_SYMBOL(acpi_lid_notifier_unregister);
227
228int acpi_lid_open(void)
229{
230 acpi_status status;
231 unsigned long long state;
232
233 if (!lid_device)
234 return -ENODEV;
235
236 status = acpi_evaluate_integer(lid_device->handle, "_LID", NULL,
237 &state);
238 if (ACPI_FAILURE(status))
239 return -ENODEV;
240
241 return !!state;
242}
243EXPORT_SYMBOL(acpi_lid_open);
244
245static int acpi_lid_send_state(struct acpi_device *device)
246{
247 struct acpi_button *button = acpi_driver_data(device);
248 unsigned long long state;
249 acpi_status status;
250 int ret;
251
252 status = acpi_evaluate_integer(device->handle, "_LID", NULL, &state);
253 if (ACPI_FAILURE(status))
254 return -ENODEV;
255
256 /* input layer checks if event is redundant */
257 input_report_switch(button->input, SW_LID, !state);
258 input_sync(button->input);
259
260 if (state)
261 pm_wakeup_event(&device->dev, 0);
262
263 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, device);
264 if (ret == NOTIFY_DONE)
265 ret = blocking_notifier_call_chain(&acpi_lid_notifier, state,
266 device);
267 if (ret == NOTIFY_DONE || ret == NOTIFY_OK) {
268 /*
269 * It is also regarded as success if the notifier_chain
270 * returns NOTIFY_OK or NOTIFY_DONE.
271 */
272 ret = 0;
273 }
274 return ret;
275}
276
277static void acpi_button_notify(struct acpi_device *device, u32 event)
278{
279 struct acpi_button *button = acpi_driver_data(device);
280 struct input_dev *input;
281
282 switch (event) {
283 case ACPI_FIXED_HARDWARE_EVENT:
284 event = ACPI_BUTTON_NOTIFY_STATUS;
285 /* fall through */
286 case ACPI_BUTTON_NOTIFY_STATUS:
287 input = button->input;
288 if (button->type == ACPI_BUTTON_TYPE_LID) {
289 acpi_lid_send_state(device);
290 } else {
291 int keycode = test_bit(KEY_SLEEP, input->keybit) ?
292 KEY_SLEEP : KEY_POWER;
293
294 input_report_key(input, keycode, 1);
295 input_sync(input);
296 input_report_key(input, keycode, 0);
297 input_sync(input);
298
299 pm_wakeup_event(&device->dev, 0);
300 }
301
302 acpi_bus_generate_proc_event(device, event, ++button->pushed);
303 break;
304 default:
305 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
306 "Unsupported event [0x%x]\n", event));
307 break;
308 }
309}
310
311static int acpi_button_resume(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 acpi_lid_send_state(device);
317 return 0;
318}
319
320static int acpi_button_add(struct acpi_device *device)
321{
322 struct acpi_button *button;
323 struct input_dev *input;
324 const char *hid = acpi_device_hid(device);
325 char *name, *class;
326 int error;
327
328 button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
329 if (!button)
330 return -ENOMEM;
331
332 device->driver_data = button;
333
334 button->input = input = input_allocate_device();
335 if (!input) {
336 error = -ENOMEM;
337 goto err_free_button;
338 }
339
340 name = acpi_device_name(device);
341 class = acpi_device_class(device);
342
343 if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
344 !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
345 button->type = ACPI_BUTTON_TYPE_POWER;
346 strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
347 sprintf(class, "%s/%s",
348 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
349 } else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
350 !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
351 button->type = ACPI_BUTTON_TYPE_SLEEP;
352 strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
353 sprintf(class, "%s/%s",
354 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
355 } else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
356 button->type = ACPI_BUTTON_TYPE_LID;
357 strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
358 sprintf(class, "%s/%s",
359 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
360 } else {
361 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid);
362 error = -ENODEV;
363 goto err_free_input;
364 }
365
366 error = acpi_button_add_fs(device);
367 if (error)
368 goto err_free_input;
369
370 snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
371
372 input->name = name;
373 input->phys = button->phys;
374 input->id.bustype = BUS_HOST;
375 input->id.product = button->type;
376 input->dev.parent = &device->dev;
377
378 switch (button->type) {
379 case ACPI_BUTTON_TYPE_POWER:
380 input->evbit[0] = BIT_MASK(EV_KEY);
381 set_bit(KEY_POWER, input->keybit);
382 break;
383
384 case ACPI_BUTTON_TYPE_SLEEP:
385 input->evbit[0] = BIT_MASK(EV_KEY);
386 set_bit(KEY_SLEEP, input->keybit);
387 break;
388
389 case ACPI_BUTTON_TYPE_LID:
390 input->evbit[0] = BIT_MASK(EV_SW);
391 set_bit(SW_LID, input->swbit);
392 break;
393 }
394
395 error = input_register_device(input);
396 if (error)
397 goto err_remove_fs;
398 if (button->type == ACPI_BUTTON_TYPE_LID) {
399 acpi_lid_send_state(device);
400 /*
401 * This assumes there's only one lid device, or if there are
402 * more we only care about the last one...
403 */
404 lid_device = device;
405 }
406
407 if (device->wakeup.flags.valid) {
408 /* Button's GPE is run-wake GPE */
409 acpi_enable_gpe(device->wakeup.gpe_device,
410 device->wakeup.gpe_number);
411 if (!device_may_wakeup(&device->dev)) {
412 device_set_wakeup_enable(&device->dev, true);
413 button->wakeup_enabled = true;
414 }
415 }
416
417 printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device));
418 return 0;
419
420 err_remove_fs:
421 acpi_button_remove_fs(device);
422 err_free_input:
423 input_free_device(input);
424 err_free_button:
425 kfree(button);
426 return error;
427}
428
429static int acpi_button_remove(struct acpi_device *device, int type)
430{
431 struct acpi_button *button = acpi_driver_data(device);
432
433 if (device->wakeup.flags.valid) {
434 acpi_disable_gpe(device->wakeup.gpe_device,
435 device->wakeup.gpe_number);
436 if (button->wakeup_enabled)
437 device_set_wakeup_enable(&device->dev, false);
438 }
439
440 acpi_button_remove_fs(device);
441 input_unregister_device(button->input);
442 kfree(button);
443 return 0;
444}
445
446static int __init acpi_button_init(void)
447{
448 return acpi_bus_register_driver(&acpi_button_driver);
449}
450
451static void __exit acpi_button_exit(void)
452{
453 acpi_bus_unregister_driver(&acpi_button_driver);
454}
455
456module_init(acpi_button_init);
457module_exit(acpi_button_exit);
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);