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>
36 #define ACPI_BUTTON_COMPONENT 0x00080000
37 #define ACPI_BUTTON_DRIVER_NAME "ACPI Button Driver"
38 #define ACPI_BUTTON_CLASS "button"
39 #define ACPI_BUTTON_FILE_INFO "info"
40 #define ACPI_BUTTON_FILE_STATE "state"
41 #define ACPI_BUTTON_TYPE_UNKNOWN 0x00
42 #define ACPI_BUTTON_NOTIFY_STATUS 0x80
44 #define ACPI_BUTTON_SUBCLASS_POWER "power"
45 #define ACPI_BUTTON_HID_POWER "PNP0C0C"
46 #define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button (CM)"
47 #define ACPI_BUTTON_DEVICE_NAME_POWERF "Power Button (FF)"
48 #define ACPI_BUTTON_TYPE_POWER 0x01
49 #define ACPI_BUTTON_TYPE_POWERF 0x02
51 #define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
52 #define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
53 #define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button (CM)"
54 #define ACPI_BUTTON_DEVICE_NAME_SLEEPF "Sleep Button (FF)"
55 #define ACPI_BUTTON_TYPE_SLEEP 0x03
56 #define ACPI_BUTTON_TYPE_SLEEPF 0x04
58 #define ACPI_BUTTON_SUBCLASS_LID "lid"
59 #define ACPI_BUTTON_HID_LID "PNP0C0D"
60 #define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
61 #define ACPI_BUTTON_TYPE_LID 0x05
63 #define _COMPONENT ACPI_BUTTON_COMPONENT
64 ACPI_MODULE_NAME ("acpi_button")
66 MODULE_AUTHOR("Paul Diefenbaugh");
67 MODULE_DESCRIPTION(ACPI_BUTTON_DRIVER_NAME
);
68 MODULE_LICENSE("GPL");
71 static int acpi_button_add (struct acpi_device
*device
);
72 static int acpi_button_remove (struct acpi_device
*device
, int type
);
73 static int acpi_button_info_open_fs(struct inode
*inode
, struct file
*file
);
74 static int acpi_button_state_open_fs(struct inode
*inode
, struct file
*file
);
76 static struct acpi_driver acpi_button_driver
= {
77 .name
= ACPI_BUTTON_DRIVER_NAME
,
78 .class = ACPI_BUTTON_CLASS
,
79 .ids
= "ACPI_FPB,ACPI_FSB,PNP0C0D,PNP0C0C,PNP0C0E",
81 .add
= acpi_button_add
,
82 .remove
= acpi_button_remove
,
88 struct acpi_device
*device
; /* Fixed button kludge */
93 static struct file_operations acpi_button_info_fops
= {
94 .open
= acpi_button_info_open_fs
,
97 .release
= single_release
,
100 static struct file_operations acpi_button_state_fops
= {
101 .open
= acpi_button_state_open_fs
,
104 .release
= single_release
,
106 /* --------------------------------------------------------------------------
108 -------------------------------------------------------------------------- */
110 static struct proc_dir_entry
*acpi_button_dir
;
112 static int acpi_button_info_seq_show(struct seq_file
*seq
, void *offset
)
114 struct acpi_button
*button
= (struct acpi_button
*) seq
->private;
116 ACPI_FUNCTION_TRACE("acpi_button_info_seq_show");
118 if (!button
|| !button
->device
)
121 seq_printf(seq
, "type: %s\n",
122 acpi_device_name(button
->device
));
127 static int acpi_button_info_open_fs(struct inode
*inode
, struct file
*file
)
129 return single_open(file
, acpi_button_info_seq_show
, PDE(inode
)->data
);
132 static int acpi_button_state_seq_show(struct seq_file
*seq
, void *offset
)
134 struct acpi_button
*button
= (struct acpi_button
*) seq
->private;
138 ACPI_FUNCTION_TRACE("acpi_button_state_seq_show");
140 if (!button
|| !button
->device
)
143 status
= acpi_evaluate_integer(button
->handle
,"_LID",NULL
,&state
);
144 if (ACPI_FAILURE(status
)) {
145 seq_printf(seq
, "state: unsupported\n");
148 seq_printf(seq
, "state: %s\n", (state
? "open" : "closed"));
154 static int acpi_button_state_open_fs(struct inode
*inode
, struct file
*file
)
156 return single_open(file
, acpi_button_state_seq_show
, PDE(inode
)->data
);
159 static struct proc_dir_entry
*acpi_power_dir
;
160 static struct proc_dir_entry
*acpi_sleep_dir
;
161 static struct proc_dir_entry
*acpi_lid_dir
;
165 struct acpi_device
*device
)
167 struct proc_dir_entry
*entry
= NULL
;
168 struct acpi_button
*button
= NULL
;
170 ACPI_FUNCTION_TRACE("acpi_button_add_fs");
172 if (!device
|| !acpi_driver_data(device
))
173 return_VALUE(-EINVAL
);
175 button
= acpi_driver_data(device
);
177 switch (button
->type
) {
178 case ACPI_BUTTON_TYPE_POWER
:
179 case ACPI_BUTTON_TYPE_POWERF
:
181 acpi_power_dir
= proc_mkdir(ACPI_BUTTON_SUBCLASS_POWER
,
183 entry
= acpi_power_dir
;
185 case ACPI_BUTTON_TYPE_SLEEP
:
186 case ACPI_BUTTON_TYPE_SLEEPF
:
188 acpi_sleep_dir
= proc_mkdir(ACPI_BUTTON_SUBCLASS_SLEEP
,
190 entry
= acpi_sleep_dir
;
192 case ACPI_BUTTON_TYPE_LID
:
194 acpi_lid_dir
= proc_mkdir(ACPI_BUTTON_SUBCLASS_LID
,
196 entry
= acpi_lid_dir
;
201 return_VALUE(-ENODEV
);
202 entry
->owner
= THIS_MODULE
;
204 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
), entry
);
205 if (!acpi_device_dir(device
))
206 return_VALUE(-ENODEV
);
207 acpi_device_dir(device
)->owner
= THIS_MODULE
;
210 entry
= create_proc_entry(ACPI_BUTTON_FILE_INFO
,
211 S_IRUGO
, acpi_device_dir(device
));
213 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
214 "Unable to create '%s' fs entry\n",
215 ACPI_BUTTON_FILE_INFO
));
217 entry
->proc_fops
= &acpi_button_info_fops
;
218 entry
->data
= acpi_driver_data(device
);
219 entry
->owner
= THIS_MODULE
;
222 /* show lid state [R] */
223 if (button
->type
== ACPI_BUTTON_TYPE_LID
) {
224 entry
= create_proc_entry(ACPI_BUTTON_FILE_STATE
,
225 S_IRUGO
, acpi_device_dir(device
));
227 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
228 "Unable to create '%s' fs entry\n",
229 ACPI_BUTTON_FILE_INFO
));
231 entry
->proc_fops
= &acpi_button_state_fops
;
232 entry
->data
= acpi_driver_data(device
);
233 entry
->owner
= THIS_MODULE
;
242 acpi_button_remove_fs (
243 struct acpi_device
*device
)
245 struct acpi_button
*button
= NULL
;
247 ACPI_FUNCTION_TRACE("acpi_button_remove_fs");
249 button
= acpi_driver_data(device
);
250 if (acpi_device_dir(device
)) {
251 if (button
->type
== ACPI_BUTTON_TYPE_LID
)
252 remove_proc_entry(ACPI_BUTTON_FILE_STATE
,
253 acpi_device_dir(device
));
254 remove_proc_entry(ACPI_BUTTON_FILE_INFO
,
255 acpi_device_dir(device
));
257 remove_proc_entry(acpi_device_bid(device
),
258 acpi_device_dir(device
)->parent
);
259 acpi_device_dir(device
) = NULL
;
266 /* --------------------------------------------------------------------------
268 -------------------------------------------------------------------------- */
276 struct acpi_button
*button
= (struct acpi_button
*) data
;
278 ACPI_FUNCTION_TRACE("acpi_button_notify");
280 if (!button
|| !button
->device
)
284 case ACPI_BUTTON_NOTIFY_STATUS
:
285 acpi_bus_generate_event(button
->device
, event
, ++button
->pushed
);
288 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
289 "Unsupported event [0x%x]\n", event
));
298 acpi_button_notify_fixed (
301 struct acpi_button
*button
= (struct acpi_button
*) data
;
303 ACPI_FUNCTION_TRACE("acpi_button_notify_fixed");
306 return_ACPI_STATUS(AE_BAD_PARAMETER
);
308 acpi_button_notify(button
->handle
, ACPI_BUTTON_NOTIFY_STATUS
, button
);
310 return_ACPI_STATUS(AE_OK
);
316 struct acpi_device
*device
)
319 acpi_status status
= AE_OK
;
320 struct acpi_button
*button
= NULL
;
322 ACPI_FUNCTION_TRACE("acpi_button_add");
325 return_VALUE(-EINVAL
);
327 button
= kmalloc(sizeof(struct acpi_button
), GFP_KERNEL
);
329 return_VALUE(-ENOMEM
);
330 memset(button
, 0, sizeof(struct acpi_button
));
332 button
->device
= device
;
333 button
->handle
= device
->handle
;
334 acpi_driver_data(device
) = button
;
337 * Determine the button type (via hid), as fixed-feature buttons
338 * need to be handled a bit differently than generic-space.
340 if (!strcmp(acpi_device_hid(device
), ACPI_BUTTON_HID_POWER
)) {
341 button
->type
= ACPI_BUTTON_TYPE_POWER
;
342 strcpy(acpi_device_name(device
),
343 ACPI_BUTTON_DEVICE_NAME_POWER
);
344 sprintf(acpi_device_class(device
), "%s/%s",
345 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_POWER
);
347 else if (!strcmp(acpi_device_hid(device
), ACPI_BUTTON_HID_POWERF
)) {
348 button
->type
= ACPI_BUTTON_TYPE_POWERF
;
349 strcpy(acpi_device_name(device
),
350 ACPI_BUTTON_DEVICE_NAME_POWERF
);
351 sprintf(acpi_device_class(device
), "%s/%s",
352 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_POWER
);
354 else if (!strcmp(acpi_device_hid(device
), ACPI_BUTTON_HID_SLEEP
)) {
355 button
->type
= ACPI_BUTTON_TYPE_SLEEP
;
356 strcpy(acpi_device_name(device
),
357 ACPI_BUTTON_DEVICE_NAME_SLEEP
);
358 sprintf(acpi_device_class(device
), "%s/%s",
359 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_SLEEP
);
361 else if (!strcmp(acpi_device_hid(device
), ACPI_BUTTON_HID_SLEEPF
)) {
362 button
->type
= ACPI_BUTTON_TYPE_SLEEPF
;
363 strcpy(acpi_device_name(device
),
364 ACPI_BUTTON_DEVICE_NAME_SLEEPF
);
365 sprintf(acpi_device_class(device
), "%s/%s",
366 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_SLEEP
);
368 else if (!strcmp(acpi_device_hid(device
), ACPI_BUTTON_HID_LID
)) {
369 button
->type
= ACPI_BUTTON_TYPE_LID
;
370 strcpy(acpi_device_name(device
),
371 ACPI_BUTTON_DEVICE_NAME_LID
);
372 sprintf(acpi_device_class(device
), "%s/%s",
373 ACPI_BUTTON_CLASS
, ACPI_BUTTON_SUBCLASS_LID
);
376 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Unsupported hid [%s]\n",
377 acpi_device_hid(device
)));
382 result
= acpi_button_add_fs(device
);
386 switch (button
->type
) {
387 case ACPI_BUTTON_TYPE_POWERF
:
388 status
= acpi_install_fixed_event_handler (
389 ACPI_EVENT_POWER_BUTTON
,
390 acpi_button_notify_fixed
,
393 case ACPI_BUTTON_TYPE_SLEEPF
:
394 status
= acpi_install_fixed_event_handler (
395 ACPI_EVENT_SLEEP_BUTTON
,
396 acpi_button_notify_fixed
,
400 status
= acpi_install_notify_handler (
408 if (ACPI_FAILURE(status
)) {
409 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
410 "Error installing notify handler\n"));
415 if (device
->wakeup
.flags
.valid
) {
416 /* Button's GPE is run-wake GPE */
417 acpi_set_gpe_type(device
->wakeup
.gpe_device
,
418 device
->wakeup
.gpe_number
, ACPI_GPE_TYPE_WAKE_RUN
);
419 acpi_enable_gpe(device
->wakeup
.gpe_device
,
420 device
->wakeup
.gpe_number
, ACPI_NOT_ISR
);
421 device
->wakeup
.state
.enabled
= 1;
424 printk(KERN_INFO PREFIX
"%s [%s]\n",
425 acpi_device_name(device
), acpi_device_bid(device
));
429 acpi_button_remove_fs(device
);
433 return_VALUE(result
);
438 acpi_button_remove (struct acpi_device
*device
, int type
)
440 acpi_status status
= 0;
441 struct acpi_button
*button
= NULL
;
443 ACPI_FUNCTION_TRACE("acpi_button_remove");
445 if (!device
|| !acpi_driver_data(device
))
446 return_VALUE(-EINVAL
);
448 button
= acpi_driver_data(device
);
450 /* Unregister for device notifications. */
451 switch (button
->type
) {
452 case ACPI_BUTTON_TYPE_POWERF
:
453 status
= acpi_remove_fixed_event_handler(
454 ACPI_EVENT_POWER_BUTTON
, acpi_button_notify_fixed
);
456 case ACPI_BUTTON_TYPE_SLEEPF
:
457 status
= acpi_remove_fixed_event_handler(
458 ACPI_EVENT_SLEEP_BUTTON
, acpi_button_notify_fixed
);
461 status
= acpi_remove_notify_handler(button
->handle
,
462 ACPI_DEVICE_NOTIFY
, acpi_button_notify
);
466 if (ACPI_FAILURE(status
))
467 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
468 "Error removing notify handler\n"));
470 acpi_button_remove_fs(device
);
479 acpi_button_init (void)
483 ACPI_FUNCTION_TRACE("acpi_button_init");
485 acpi_button_dir
= proc_mkdir(ACPI_BUTTON_CLASS
, acpi_root_dir
);
486 if (!acpi_button_dir
)
487 return_VALUE(-ENODEV
);
488 acpi_button_dir
->owner
= THIS_MODULE
;
489 result
= acpi_bus_register_driver(&acpi_button_driver
);
491 remove_proc_entry(ACPI_BUTTON_CLASS
, acpi_root_dir
);
492 return_VALUE(-ENODEV
);
500 acpi_button_exit (void)
502 ACPI_FUNCTION_TRACE("acpi_button_exit");
504 acpi_bus_unregister_driver(&acpi_button_driver
);
507 remove_proc_entry(ACPI_BUTTON_SUBCLASS_POWER
, acpi_button_dir
);
509 remove_proc_entry(ACPI_BUTTON_SUBCLASS_SLEEP
, acpi_button_dir
);
511 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID
, acpi_button_dir
);
512 remove_proc_entry(ACPI_BUTTON_CLASS
, acpi_root_dir
);
518 module_init(acpi_button_init
);
519 module_exit(acpi_button_exit
);