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