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