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