2 * acpi_button.c - ACPI Button Driver ($Revision: 30 $)
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 * 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.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <acpi/acpi_bus.h>
33 #include <acpi/acpi_drivers.h>
35 #define ACPI_BUTTON_COMPONENT 0x00080000
36 #define ACPI_BUTTON_DRIVER_NAME "ACPI Button Driver"
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 (CM)"
46 #define ACPI_BUTTON_DEVICE_NAME_POWERF "Power Button (FF)"
47 #define ACPI_BUTTON_TYPE_POWER 0x01
48 #define ACPI_BUTTON_TYPE_POWERF 0x02
50 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
51 #define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
52 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button (CM)"
53 #define ACPI_BUTTON_DEVICE_NAME_SLEEPF "Sleep Button (FF)"
54 #define ACPI_BUTTON_TYPE_SLEEP 0x03
55 #define ACPI_BUTTON_TYPE_SLEEPF 0x04
57 #define ACPI_BUTTON_SUBCLASS_LID "lid"
58 #define ACPI_BUTTON_HID_LID "PNP0C0D"
59 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
60 #define ACPI_BUTTON_TYPE_LID 0x05
62 #define _COMPONENT ACPI_BUTTON_COMPONENT
63 ACPI_MODULE_NAME("acpi_button")
65 MODULE_AUTHOR("Paul Diefenbaugh");
66 MODULE_DESCRIPTION(ACPI_BUTTON_DRIVER_NAME);
67 MODULE_LICENSE("GPL");
69 static int acpi_button_add(struct acpi_device *device);
70 static int acpi_button_remove(struct acpi_device *device, int type);
71 static int acpi_button_info_open_fs(struct inode *inode, struct file *file);
72 static int acpi_button_state_open_fs(struct inode *inode, struct file *file);
74 static struct acpi_driver acpi_button_driver = {
75 .name = ACPI_BUTTON_DRIVER_NAME,
76 .class = ACPI_BUTTON_CLASS,
77 .ids = "ACPI_FPB,ACPI_FSB,PNP0C0D,PNP0C0C,PNP0C0E",
79 .add = acpi_button_add,
80 .remove = acpi_button_remove,
86 struct acpi_device *device; /* Fixed button kludge */
91 static struct file_operations acpi_button_info_fops = {
92 .open = acpi_button_info_open_fs,
95 .release = single_release,
98 static struct file_operations acpi_button_state_fops = {
99 .open = acpi_button_state_open_fs,
102 .release = single_release,
105 /* --------------------------------------------------------------------------
107 -------------------------------------------------------------------------- */
109 static struct proc_dir_entry *acpi_button_dir;
111 static int acpi_button_info_seq_show(struct seq_file *seq, void *offset)
113 struct acpi_button *button = (struct acpi_button *)seq->private;
115 ACPI_FUNCTION_TRACE("acpi_button_info_seq_show");
117 if (!button || !button->device)
120 seq_printf(seq, "type: %s\n",
121 acpi_device_name(button->device));
126 static int acpi_button_info_open_fs(struct inode *inode, struct file *file)
128 return single_open(file, acpi_button_info_seq_show, PDE(inode)->data);
131 static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
133 struct acpi_button *button = (struct acpi_button *)seq->private;
137 ACPI_FUNCTION_TRACE("acpi_button_state_seq_show");
139 if (!button || !button->device)
142 status = acpi_evaluate_integer(button->handle, "_LID", NULL, &state);
143 if (ACPI_FAILURE(status)) {
144 seq_printf(seq, "state: unsupported\n");
146 seq_printf(seq, "state: %s\n",
147 (state ? "open" : "closed"));
153 static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
155 return single_open(file, acpi_button_state_seq_show, PDE(inode)->data);
158 static struct proc_dir_entry *acpi_power_dir;
159 static struct proc_dir_entry *acpi_sleep_dir;
160 static struct proc_dir_entry *acpi_lid_dir;
162 static int acpi_button_add_fs(struct acpi_device *device)
164 struct proc_dir_entry *entry = NULL;
165 struct acpi_button *button = NULL;
167 ACPI_FUNCTION_TRACE("acpi_button_add_fs");
169 if (!device || !acpi_driver_data(device))
170 return_VALUE(-EINVAL);
172 button = acpi_driver_data(device);
174 switch (button->type) {
175 case ACPI_BUTTON_TYPE_POWER:
176 case ACPI_BUTTON_TYPE_POWERF:
178 acpi_power_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_POWER,
180 entry = acpi_power_dir;
182 case ACPI_BUTTON_TYPE_SLEEP:
183 case ACPI_BUTTON_TYPE_SLEEPF:
185 acpi_sleep_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_SLEEP,
187 entry = acpi_sleep_dir;
189 case ACPI_BUTTON_TYPE_LID:
191 acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID,
193 entry = acpi_lid_dir;
198 return_VALUE(-ENODEV);
199 entry->owner = THIS_MODULE;
201 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), entry);
202 if (!acpi_device_dir(device))
203 return_VALUE(-ENODEV);
204 acpi_device_dir(device)->owner = THIS_MODULE;
207 entry = create_proc_entry(ACPI_BUTTON_FILE_INFO,
208 S_IRUGO, acpi_device_dir(device));
210 return_VALUE(-ENODEV);
212 entry->proc_fops = &acpi_button_info_fops;
213 entry->data = acpi_driver_data(device);
214 entry->owner = THIS_MODULE;
217 /* show lid state [R] */
218 if (button->type == ACPI_BUTTON_TYPE_LID) {
219 entry = create_proc_entry(ACPI_BUTTON_FILE_STATE,
220 S_IRUGO, acpi_device_dir(device));
224 entry->proc_fops = &acpi_button_state_fops;
225 entry->data = acpi_driver_data(device);
226 entry->owner = THIS_MODULE;
233 static int acpi_button_remove_fs(struct acpi_device *device)
235 struct acpi_button *button = NULL;
237 ACPI_FUNCTION_TRACE("acpi_button_remove_fs");
239 button = acpi_driver_data(device);
240 if (acpi_device_dir(device)) {
241 if (button->type == ACPI_BUTTON_TYPE_LID)
242 remove_proc_entry(ACPI_BUTTON_FILE_STATE,
243 acpi_device_dir(device));
244 remove_proc_entry(ACPI_BUTTON_FILE_INFO,
245 acpi_device_dir(device));
247 remove_proc_entry(acpi_device_bid(device),
248 acpi_device_dir(device)->parent);
249 acpi_device_dir(device) = NULL;
255 /* --------------------------------------------------------------------------
257 -------------------------------------------------------------------------- */
259 static void acpi_button_notify(acpi_handle handle, u32 event, void *data)
261 struct acpi_button *button = (struct acpi_button *)data;
263 ACPI_FUNCTION_TRACE("acpi_button_notify");
265 if (!button || !button->device)
269 case ACPI_BUTTON_NOTIFY_STATUS:
270 acpi_bus_generate_event(button->device, event,
274 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
275 "Unsupported event [0x%x]\n", event));
282 static acpi_status acpi_button_notify_fixed(void *data)
284 struct acpi_button *button = (struct acpi_button *)data;
286 ACPI_FUNCTION_TRACE("acpi_button_notify_fixed");
289 return_ACPI_STATUS(AE_BAD_PARAMETER);
291 acpi_button_notify(button->handle, ACPI_BUTTON_NOTIFY_STATUS, button);
293 return_ACPI_STATUS(AE_OK);
296 static int acpi_button_add(struct acpi_device *device)
299 acpi_status status = AE_OK;
300 struct acpi_button *button = NULL;
302 ACPI_FUNCTION_TRACE("acpi_button_add");
305 return_VALUE(-EINVAL);
307 button = kmalloc(sizeof(struct acpi_button), GFP_KERNEL);
309 return_VALUE(-ENOMEM);
310 memset(button, 0, sizeof(struct acpi_button));
312 button->device = device;
313 button->handle = device->handle;
314 acpi_driver_data(device) = button;
317 * Determine the button type (via hid), as fixed-feature buttons
318 * need to be handled a bit differently than generic-space.
320 if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWER)) {
321 button->type = ACPI_BUTTON_TYPE_POWER;
322 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_POWER);
323 sprintf(acpi_device_class(device), "%s/%s",
324 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
325 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWERF)) {
326 button->type = ACPI_BUTTON_TYPE_POWERF;
327 strcpy(acpi_device_name(device),
328 ACPI_BUTTON_DEVICE_NAME_POWERF);
329 sprintf(acpi_device_class(device), "%s/%s",
330 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
331 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEP)) {
332 button->type = ACPI_BUTTON_TYPE_SLEEP;
333 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_SLEEP);
334 sprintf(acpi_device_class(device), "%s/%s",
335 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
336 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEPF)) {
337 button->type = ACPI_BUTTON_TYPE_SLEEPF;
338 strcpy(acpi_device_name(device),
339 ACPI_BUTTON_DEVICE_NAME_SLEEPF);
340 sprintf(acpi_device_class(device), "%s/%s",
341 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
342 } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_LID)) {
343 button->type = ACPI_BUTTON_TYPE_LID;
344 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_LID);
345 sprintf(acpi_device_class(device), "%s/%s",
346 ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
348 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n",
349 acpi_device_hid(device));
354 result = acpi_button_add_fs(device);
358 switch (button->type) {
359 case ACPI_BUTTON_TYPE_POWERF:
361 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
362 acpi_button_notify_fixed,
365 case ACPI_BUTTON_TYPE_SLEEPF:
367 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
368 acpi_button_notify_fixed,
372 status = acpi_install_notify_handler(button->handle,
379 if (ACPI_FAILURE(status)) {
384 if (device->wakeup.flags.valid) {
385 /* Button's GPE is run-wake GPE */
386 acpi_set_gpe_type(device->wakeup.gpe_device,
387 device->wakeup.gpe_number,
388 ACPI_GPE_TYPE_WAKE_RUN);
389 acpi_enable_gpe(device->wakeup.gpe_device,
390 device->wakeup.gpe_number, ACPI_NOT_ISR);
391 device->wakeup.state.enabled = 1;
394 printk(KERN_INFO PREFIX "%s [%s]\n",
395 acpi_device_name(device), acpi_device_bid(device));
399 acpi_button_remove_fs(device);
403 return_VALUE(result);
406 static int acpi_button_remove(struct acpi_device *device, int type)
408 acpi_status status = 0;
409 struct acpi_button *button = NULL;
411 ACPI_FUNCTION_TRACE("acpi_button_remove");
413 if (!device || !acpi_driver_data(device))
414 return_VALUE(-EINVAL);
416 button = acpi_driver_data(device);
418 /* Unregister for device notifications. */
419 switch (button->type) {
420 case ACPI_BUTTON_TYPE_POWERF:
422 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
423 acpi_button_notify_fixed);
425 case ACPI_BUTTON_TYPE_SLEEPF:
427 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
428 acpi_button_notify_fixed);
431 status = acpi_remove_notify_handler(button->handle,
437 acpi_button_remove_fs(device);
444 static int __init acpi_button_init(void)
448 ACPI_FUNCTION_TRACE("acpi_button_init");
450 acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
451 if (!acpi_button_dir)
452 return_VALUE(-ENODEV);
453 acpi_button_dir->owner = THIS_MODULE;
454 result = acpi_bus_register_driver(&acpi_button_driver);
456 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
457 return_VALUE(-ENODEV);
463 static void __exit acpi_button_exit(void)
465 ACPI_FUNCTION_TRACE("acpi_button_exit");
467 acpi_bus_unregister_driver(&acpi_button_driver);
470 remove_proc_entry(ACPI_BUTTON_SUBCLASS_POWER, acpi_button_dir);
472 remove_proc_entry(ACPI_BUTTON_SUBCLASS_SLEEP, acpi_button_dir);
474 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
475 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
480 module_init(acpi_button_init);
481 module_exit(acpi_button_exit);