ACPI: button: remove unnecessary null pointer checks
[safe/jmp/linux-2.6] / drivers / acpi / button.c
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 <acpi/acpi_bus.h>
34 #include <acpi/acpi_drivers.h>
35
36 #define ACPI_BUTTON_CLASS               "button"
37 #define ACPI_BUTTON_FILE_INFO           "info"
38 #define ACPI_BUTTON_FILE_STATE          "state"
39 #define ACPI_BUTTON_TYPE_UNKNOWN        0x00
40 #define ACPI_BUTTON_NOTIFY_STATUS       0x80
41
42 #define ACPI_BUTTON_SUBCLASS_POWER      "power"
43 #define ACPI_BUTTON_HID_POWER           "PNP0C0C"
44 #define ACPI_BUTTON_DEVICE_NAME_POWER   "Power Button (CM)"
45 #define ACPI_BUTTON_DEVICE_NAME_POWERF  "Power Button (FF)"
46 #define ACPI_BUTTON_TYPE_POWER          0x01
47 #define ACPI_BUTTON_TYPE_POWERF         0x02
48
49 #define ACPI_BUTTON_SUBCLASS_SLEEP      "sleep"
50 #define ACPI_BUTTON_HID_SLEEP           "PNP0C0E"
51 #define ACPI_BUTTON_DEVICE_NAME_SLEEP   "Sleep Button (CM)"
52 #define ACPI_BUTTON_DEVICE_NAME_SLEEPF  "Sleep Button (FF)"
53 #define ACPI_BUTTON_TYPE_SLEEP          0x03
54 #define ACPI_BUTTON_TYPE_SLEEPF         0x04
55
56 #define ACPI_BUTTON_SUBCLASS_LID        "lid"
57 #define ACPI_BUTTON_HID_LID             "PNP0C0D"
58 #define ACPI_BUTTON_DEVICE_NAME_LID     "Lid Switch"
59 #define ACPI_BUTTON_TYPE_LID            0x05
60
61 #define _COMPONENT              ACPI_BUTTON_COMPONENT
62 ACPI_MODULE_NAME("button");
63
64 MODULE_AUTHOR("Paul Diefenbaugh");
65 MODULE_DESCRIPTION("ACPI Button Driver");
66 MODULE_LICENSE("GPL");
67
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},
74         {"", 0},
75 };
76 MODULE_DEVICE_TABLE(acpi, button_device_ids);
77
78 static int acpi_button_add(struct acpi_device *device);
79 static int acpi_button_remove(struct acpi_device *device, int type);
80 static int acpi_button_resume(struct acpi_device *device);
81 static void acpi_button_notify(struct acpi_device *device, u32 event);
82 static int acpi_button_info_open_fs(struct inode *inode, struct file *file);
83 static int acpi_button_state_open_fs(struct inode *inode, struct file *file);
84
85 static struct acpi_driver acpi_button_driver = {
86         .name = "button",
87         .class = ACPI_BUTTON_CLASS,
88         .ids = button_device_ids,
89         .ops = {
90                 .add = acpi_button_add,
91                 .resume = acpi_button_resume,
92                 .remove = acpi_button_remove,
93                 .notify = acpi_button_notify,
94         },
95 };
96
97 struct acpi_button {
98         struct acpi_device *device;     /* Fixed button kludge */
99         unsigned int type;
100         struct input_dev *input;
101         char phys[32];                  /* for input device */
102         unsigned long pushed;
103 };
104
105 static const struct file_operations acpi_button_info_fops = {
106         .owner = THIS_MODULE,
107         .open = acpi_button_info_open_fs,
108         .read = seq_read,
109         .llseek = seq_lseek,
110         .release = single_release,
111 };
112
113 static const struct file_operations acpi_button_state_fops = {
114         .owner = THIS_MODULE,
115         .open = acpi_button_state_open_fs,
116         .read = seq_read,
117         .llseek = seq_lseek,
118         .release = single_release,
119 };
120
121 /* --------------------------------------------------------------------------
122                               FS Interface (/proc)
123    -------------------------------------------------------------------------- */
124
125 static struct proc_dir_entry *acpi_button_dir;
126
127 static int acpi_button_info_seq_show(struct seq_file *seq, void *offset)
128 {
129         struct acpi_button *button = seq->private;
130
131         seq_printf(seq, "type:                    %s\n",
132                    acpi_device_name(button->device));
133         return 0;
134 }
135
136 static int acpi_button_info_open_fs(struct inode *inode, struct file *file)
137 {
138         return single_open(file, acpi_button_info_seq_show, PDE(inode)->data);
139 }
140
141 static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
142 {
143         struct acpi_button *button = seq->private;
144         acpi_status status;
145         unsigned long long state;
146
147         status = acpi_evaluate_integer(button->device->handle, "_LID", NULL, &state);
148         seq_printf(seq, "state:      %s\n",
149                    ACPI_FAILURE(status) ? "unsupported" :
150                         (state ? "open" : "closed"));
151         return 0;
152 }
153
154 static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
155 {
156         return single_open(file, acpi_button_state_seq_show, PDE(inode)->data);
157 }
158
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;
162
163 static int acpi_button_add_fs(struct acpi_device *device)
164 {
165         struct proc_dir_entry *entry = NULL;
166         struct acpi_button *button;
167
168         button = acpi_driver_data(device);
169
170         switch (button->type) {
171         case ACPI_BUTTON_TYPE_POWER:
172         case ACPI_BUTTON_TYPE_POWERF:
173                 if (!acpi_power_dir)
174                         acpi_power_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_POWER,
175                                                     acpi_button_dir);
176                 entry = acpi_power_dir;
177                 break;
178         case ACPI_BUTTON_TYPE_SLEEP:
179         case ACPI_BUTTON_TYPE_SLEEPF:
180                 if (!acpi_sleep_dir)
181                         acpi_sleep_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_SLEEP,
182                                                     acpi_button_dir);
183                 entry = acpi_sleep_dir;
184                 break;
185         case ACPI_BUTTON_TYPE_LID:
186                 if (!acpi_lid_dir)
187                         acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID,
188                                                   acpi_button_dir);
189                 entry = acpi_lid_dir;
190                 break;
191         }
192
193         if (!entry)
194                 return -ENODEV;
195
196         acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), entry);
197         if (!acpi_device_dir(device))
198                 return -ENODEV;
199
200         /* 'info' [R] */
201         entry = proc_create_data(ACPI_BUTTON_FILE_INFO,
202                                  S_IRUGO, acpi_device_dir(device),
203                                  &acpi_button_info_fops,
204                                  acpi_driver_data(device));
205         if (!entry)
206                 return -ENODEV;
207
208         /* show lid state [R] */
209         if (button->type == ACPI_BUTTON_TYPE_LID) {
210                 entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
211                                          S_IRUGO, acpi_device_dir(device),
212                                          &acpi_button_state_fops,
213                                          acpi_driver_data(device));
214                 if (!entry)
215                         return -ENODEV;
216         }
217
218         return 0;
219 }
220
221 static int acpi_button_remove_fs(struct acpi_device *device)
222 {
223         struct acpi_button *button = acpi_driver_data(device);
224
225         if (acpi_device_dir(device)) {
226                 if (button->type == ACPI_BUTTON_TYPE_LID)
227                         remove_proc_entry(ACPI_BUTTON_FILE_STATE,
228                                           acpi_device_dir(device));
229                 remove_proc_entry(ACPI_BUTTON_FILE_INFO,
230                                   acpi_device_dir(device));
231
232                 remove_proc_entry(acpi_device_bid(device),
233                                   acpi_device_dir(device)->parent);
234                 acpi_device_dir(device) = NULL;
235         }
236
237         return 0;
238 }
239
240 /* --------------------------------------------------------------------------
241                                 Driver Interface
242    -------------------------------------------------------------------------- */
243 static int acpi_lid_send_state(struct acpi_button *button)
244 {
245         unsigned long long state;
246         acpi_status status;
247
248         status = acpi_evaluate_integer(button->device->handle, "_LID", NULL,
249                                         &state);
250         if (ACPI_FAILURE(status))
251                 return -ENODEV;
252
253         /* input layer checks if event is redundant */
254         input_report_switch(button->input, SW_LID, !state);
255         input_sync(button->input);
256         return 0;
257 }
258
259 static void acpi_button_notify(struct acpi_device *device, u32 event)
260 {
261         struct acpi_button *button = acpi_driver_data(device);
262         struct input_dev *input;
263
264         switch (event) {
265         case ACPI_FIXED_HARDWARE_EVENT:
266                 event = ACPI_BUTTON_NOTIFY_STATUS;
267                 /* fall through */
268         case ACPI_BUTTON_NOTIFY_STATUS:
269                 input = button->input;
270                 if (button->type == ACPI_BUTTON_TYPE_LID) {
271                         acpi_lid_send_state(button);
272                 } else {
273                         int keycode = test_bit(KEY_SLEEP, input->keybit) ?
274                                                 KEY_SLEEP : KEY_POWER;
275
276                         input_report_key(input, keycode, 1);
277                         input_sync(input);
278                         input_report_key(input, keycode, 0);
279                         input_sync(input);
280                 }
281
282                 acpi_bus_generate_proc_event(button->device, event,
283                                         ++button->pushed);
284                 break;
285         default:
286                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
287                                   "Unsupported event [0x%x]\n", event));
288                 break;
289         }
290 }
291
292 static int acpi_button_resume(struct acpi_device *device)
293 {
294         struct acpi_button *button;
295
296         button = acpi_driver_data(device);
297         if (button->type == ACPI_BUTTON_TYPE_LID)
298                 return acpi_lid_send_state(button);
299         return 0;
300 }
301
302 static int acpi_button_add(struct acpi_device *device)
303 {
304         int error;
305         struct acpi_button *button;
306         struct input_dev *input;
307
308         button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
309         if (!button)
310                 return -ENOMEM;
311
312         button->device = device;
313         device->driver_data = button;
314
315         button->input = input = input_allocate_device();
316         if (!input) {
317                 error = -ENOMEM;
318                 goto err_free_button;
319         }
320
321         /*
322          * Determine the button type (via hid), as fixed-feature buttons
323          * need to be handled a bit differently than generic-space.
324          */
325         if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWER)) {
326                 button->type = ACPI_BUTTON_TYPE_POWER;
327                 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_POWER);
328                 sprintf(acpi_device_class(device), "%s/%s",
329                         ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
330         } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWERF)) {
331                 button->type = ACPI_BUTTON_TYPE_POWERF;
332                 strcpy(acpi_device_name(device),
333                        ACPI_BUTTON_DEVICE_NAME_POWERF);
334                 sprintf(acpi_device_class(device), "%s/%s",
335                         ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
336         } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEP)) {
337                 button->type = ACPI_BUTTON_TYPE_SLEEP;
338                 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_SLEEP);
339                 sprintf(acpi_device_class(device), "%s/%s",
340                         ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
341         } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEPF)) {
342                 button->type = ACPI_BUTTON_TYPE_SLEEPF;
343                 strcpy(acpi_device_name(device),
344                        ACPI_BUTTON_DEVICE_NAME_SLEEPF);
345                 sprintf(acpi_device_class(device), "%s/%s",
346                         ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
347         } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_LID)) {
348                 button->type = ACPI_BUTTON_TYPE_LID;
349                 strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_LID);
350                 sprintf(acpi_device_class(device), "%s/%s",
351                         ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
352         } else {
353                 printk(KERN_ERR PREFIX "Unsupported hid [%s]\n",
354                             acpi_device_hid(device));
355                 error = -ENODEV;
356                 goto err_free_input;
357         }
358
359         error = acpi_button_add_fs(device);
360         if (error)
361                 goto err_free_input;
362
363         snprintf(button->phys, sizeof(button->phys),
364                  "%s/button/input0", acpi_device_hid(device));
365
366         input->name = acpi_device_name(device);
367         input->phys = button->phys;
368         input->id.bustype = BUS_HOST;
369         input->id.product = button->type;
370         input->dev.parent = &device->dev;
371
372         switch (button->type) {
373         case ACPI_BUTTON_TYPE_POWER:
374         case ACPI_BUTTON_TYPE_POWERF:
375                 input->evbit[0] = BIT_MASK(EV_KEY);
376                 set_bit(KEY_POWER, input->keybit);
377                 break;
378
379         case ACPI_BUTTON_TYPE_SLEEP:
380         case ACPI_BUTTON_TYPE_SLEEPF:
381                 input->evbit[0] = BIT_MASK(EV_KEY);
382                 set_bit(KEY_SLEEP, input->keybit);
383                 break;
384
385         case ACPI_BUTTON_TYPE_LID:
386                 input->evbit[0] = BIT_MASK(EV_SW);
387                 set_bit(SW_LID, input->swbit);
388                 break;
389         }
390
391         error = input_register_device(input);
392         if (error)
393                 goto err_remove_fs;
394         if (button->type == ACPI_BUTTON_TYPE_LID)
395                 acpi_lid_send_state(button);
396
397         if (device->wakeup.flags.valid) {
398                 /* Button's GPE is run-wake GPE */
399                 acpi_set_gpe_type(device->wakeup.gpe_device,
400                                   device->wakeup.gpe_number,
401                                   ACPI_GPE_TYPE_WAKE_RUN);
402                 acpi_enable_gpe(device->wakeup.gpe_device,
403                                 device->wakeup.gpe_number);
404                 device->wakeup.state.enabled = 1;
405         }
406
407         printk(KERN_INFO PREFIX "%s [%s]\n",
408                acpi_device_name(device), acpi_device_bid(device));
409         return 0;
410
411  err_remove_fs:
412         acpi_button_remove_fs(device);
413  err_free_input:
414         input_free_device(input);
415  err_free_button:
416         kfree(button);
417         return error;
418 }
419
420 static int acpi_button_remove(struct acpi_device *device, int type)
421 {
422         struct acpi_button *button;
423
424         button = acpi_driver_data(device);
425
426         acpi_button_remove_fs(device);
427         input_unregister_device(button->input);
428         kfree(button);
429         return 0;
430 }
431
432 static int __init acpi_button_init(void)
433 {
434         int result;
435
436         acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
437         if (!acpi_button_dir)
438                 return -ENODEV;
439
440         result = acpi_bus_register_driver(&acpi_button_driver);
441         if (result < 0) {
442                 remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
443                 return -ENODEV;
444         }
445
446         return 0;
447 }
448
449 static void __exit acpi_button_exit(void)
450 {
451         acpi_bus_unregister_driver(&acpi_button_driver);
452
453         if (acpi_power_dir)
454                 remove_proc_entry(ACPI_BUTTON_SUBCLASS_POWER, acpi_button_dir);
455         if (acpi_sleep_dir)
456                 remove_proc_entry(ACPI_BUTTON_SUBCLASS_SLEEP, acpi_button_dir);
457         if (acpi_lid_dir)
458                 remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
459         remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
460 }
461
462 module_init(acpi_button_init);
463 module_exit(acpi_button_exit);