linux/drivers/acpi/button.c
<<
>>
Prefs
   1/*
   2 *  acpi_button.c - ACPI Button Driver ($Revision: 30 $)
   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_COMPONENT           0x00080000
  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
  42
  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
  49
  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
  56
  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
  61
  62#define _COMPONENT              ACPI_BUTTON_COMPONENT
  63ACPI_MODULE_NAME("button");
  64
  65MODULE_AUTHOR("Paul Diefenbaugh");
  66MODULE_DESCRIPTION("ACPI Button Driver");
  67MODULE_LICENSE("GPL");
  68
  69static const struct acpi_device_id button_device_ids[] = {
  70        {ACPI_BUTTON_HID_LID,    0},
  71        {ACPI_BUTTON_HID_SLEEP,  0},
  72        {ACPI_BUTTON_HID_SLEEPF, 0},
  73        {ACPI_BUTTON_HID_POWER,  0},
  74        {ACPI_BUTTON_HID_POWERF, 0},
  75        {"", 0},
  76};
  77MODULE_DEVICE_TABLE(acpi, button_device_ids);
  78
  79static int acpi_button_add(struct acpi_device *device);
  80static int acpi_button_remove(struct acpi_device *device, int type);
  81static int acpi_button_resume(struct acpi_device *device);
  82static int acpi_button_info_open_fs(struct inode *inode, struct file *file);
  83static int acpi_button_state_open_fs(struct inode *inode, struct file *file);
  84
  85static 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        },
  94};
  95
  96struct acpi_button {
  97        struct acpi_device *device;     /* Fixed button kludge */
  98        unsigned int type;
  99        struct input_dev *input;
 100        char phys[32];                  /* for input device */
 101        unsigned long pushed;
 102};
 103
 104static const struct file_operations acpi_button_info_fops = {
 105        .owner = THIS_MODULE,
 106        .open = acpi_button_info_open_fs,
 107        .read = seq_read,
 108        .llseek = seq_lseek,
 109        .release = single_release,
 110};
 111
 112static const struct file_operations acpi_button_state_fops = {
 113        .owner = THIS_MODULE,
 114        .open = acpi_button_state_open_fs,
 115        .read = seq_read,
 116        .llseek = seq_lseek,
 117        .release = single_release,
 118};
 119
 120/* --------------------------------------------------------------------------
 121                              FS Interface (/proc)
 122   -------------------------------------------------------------------------- */
 123
 124static struct proc_dir_entry *acpi_button_dir;
 125
 126static int acpi_button_info_seq_show(struct seq_file *seq, void *offset)
 127{
 128        struct acpi_button *button = seq->private;
 129
 130        if (!button || !button->device)
 131                return 0;
 132
 133        seq_printf(seq, "type:                    %s\n",
 134                   acpi_device_name(button->device));
 135
 136        return 0;
 137}
 138
 139static int acpi_button_info_open_fs(struct inode *inode, struct file *file)
 140{
 141        return single_open(file, acpi_button_info_seq_show, PDE(inode)->data);
 142}
 143
 144static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
 145{
 146        struct acpi_button *button = seq->private;
 147        acpi_status status;
 148        unsigned long long state;
 149
 150        if (!button || !button->device)
 151                return 0;
 152
 153        status = acpi_evaluate_integer(button->device->handle, "_LID", NULL, &state);
 154        seq_printf(seq, "state:      %s\n",
 155                   ACPI_FAILURE(status) ? "unsupported" :
 156                        (state ? "open" : "closed"));
 157        return 0;
 158}
 159
 160static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
 161{
 162        return single_open(file, acpi_button_state_seq_show, PDE(inode)->data);
 163}
 164
 165static struct proc_dir_entry *acpi_power_dir;
 166static struct proc_dir_entry *acpi_sleep_dir;
 167static struct proc_dir_entry *acpi_lid_dir;
 168
 169static int acpi_button_add_fs(struct acpi_device *device)
 170{
 171        struct proc_dir_entry *entry = NULL;
 172        struct acpi_button *button;
 173
 174        if (!device || !acpi_driver_data(device))
 175                return -EINVAL;
 176
 177        button = acpi_driver_data(device);
 178
 179        switch (button->type) {
 180        case ACPI_BUTTON_TYPE_POWER:
 181        case ACPI_BUTTON_TYPE_POWERF:
 182                if (!acpi_power_dir)
 183                        acpi_power_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_POWER,
 184                                                    acpi_button_dir);
 185                entry = acpi_power_dir;
 186                break;
 187        case ACPI_BUTTON_TYPE_SLEEP:
 188        case ACPI_BUTTON_TYPE_SLEEPF:
 189                if (!acpi_sleep_dir)
 190                        acpi_sleep_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_SLEEP,
 191                                                    acpi_button_dir);
 192                entry = acpi_sleep_dir;
 193                break;
 194        case ACPI_BUTTON_TYPE_LID:
 195                if (!acpi_lid_dir)
 196                        acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID,
 197                                                  acpi_button_dir);
 198                entry = acpi_lid_dir;
 199                break;
 200        }
 201
 202        if (!entry)
 203                return -ENODEV;
 204        entry->owner = THIS_MODULE;
 205
 206        acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), entry);
 207        if (!acpi_device_dir(device))
 208                return -ENODEV;
 209        acpi_device_dir(device)->owner = THIS_MODULE;
 210
 211        /* 'info' [R] */
 212        entry = proc_create_data(ACPI_BUTTON_FILE_INFO,
 213                                 S_IRUGO, acpi_device_dir(device),
 214                                 &acpi_button_info_fops,
 215                                 acpi_driver_data(device));
 216        if (!entry)
 217                return -ENODEV;
 218
 219        /* show lid state [R] */
 220        if (button->type == ACPI_BUTTON_TYPE_LID) {
 221                entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
 222                                         S_IRUGO, acpi_device_dir(device),
 223                                         &acpi_button_state_fops,
 224                                         acpi_driver_data(device));
 225                if (!entry)
 226                        return -ENODEV;
 227        }
 228
 229        return 0;
 230}
 231
 232static int acpi_button_remove_fs(struct acpi_device *device)
 233{
 234        struct acpi_button *button = acpi_driver_data(device);
 235
 236        if (acpi_device_dir(device)) {
 237                if (button->type == ACPI_BUTTON_TYPE_LID)
 238                        remove_proc_entry(ACPI_BUTTON_FILE_STATE,
 239                                          acpi_device_dir(device));
 240                remove_proc_entry(ACPI_BUTTON_FILE_INFO,
 241                                  acpi_device_dir(device));
 242
 243                remove_proc_entry(acpi_device_bid(device),
 244                                  acpi_device_dir(device)->parent);
 245                acpi_device_dir(device) = NULL;
 246        }
 247
 248        return 0;
 249}
 250
 251/* --------------------------------------------------------------------------
 252                                Driver Interface
 253   -------------------------------------------------------------------------- */
 254static int acpi_lid_send_state(struct acpi_button *button)
 255{
 256        unsigned long long state;
 257        acpi_status status;
 258
 259        status = acpi_evaluate_integer(button->device->handle, "_LID", NULL,
 260                                        &state);
 261        if (ACPI_FAILURE(status))
 262                return -ENODEV;
 263        /* input layer checks if event is redundant */
 264        input_report_switch(button->input, SW_LID, !state);
 265        input_sync(button->input);
 266        return 0;
 267}
 268
 269static void acpi_button_notify(acpi_handle handle, u32 event, void *data)
 270{
 271        struct acpi_button *button = data;
 272        struct input_dev *input;
 273
 274        if (!button || !button->device)
 275                return;
 276
 277        switch (event) {
 278        case ACPI_BUTTON_NOTIFY_STATUS:
 279                input = button->input;
 280                if (button->type == ACPI_BUTTON_TYPE_LID) {
 281                        acpi_lid_send_state(button);
 282                } else {
 283                        int keycode = test_bit(KEY_SLEEP, input->keybit) ?
 284                                                KEY_SLEEP : KEY_POWER;
 285
 286                        input_report_key(input, keycode, 1);
 287                        input_sync(input);
 288                        input_report_key(input, keycode, 0);
 289                        input_sync(input);
 290                }
 291
 292                acpi_bus_generate_proc_event(button->device, event,
 293                                        ++button->pushed);
 294                break;
 295        default:
 296                ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 297                                  "Unsupported event [0x%x]\n", event));
 298                break;
 299        }
 300
 301        return;
 302}
 303
 304static acpi_status acpi_button_notify_fixed(void *data)
 305{
 306        struct acpi_button *button = data;
 307
 308        if (!button)
 309                return AE_BAD_PARAMETER;
 310
 311        acpi_button_notify(button->device->handle, ACPI_BUTTON_NOTIFY_STATUS, button);
 312
 313        return AE_OK;
 314}
 315
 316static int acpi_button_install_notify_handlers(struct acpi_button *button)
 317{
 318        acpi_status status;
 319
 320        switch (button->type) {
 321        case ACPI_BUTTON_TYPE_POWERF:
 322                status =
 323                    acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
 324                                                     acpi_button_notify_fixed,
 325                                                     button);
 326                break;
 327        case ACPI_BUTTON_TYPE_SLEEPF:
 328                status =
 329                    acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
 330                                                     acpi_button_notify_fixed,
 331                                                     button);
 332                break;
 333        default:
 334                status = acpi_install_notify_handler(button->device->handle,
 335                                                     ACPI_DEVICE_NOTIFY,
 336                                                     acpi_button_notify,
 337                                                     button);
 338                break;
 339        }
 340
 341        return ACPI_FAILURE(status) ? -ENODEV : 0;
 342}
 343
 344static int acpi_button_resume(struct acpi_device *device)
 345{
 346        struct acpi_button *button;
 347        if (!device)
 348                return -EINVAL;
 349        button = acpi_driver_data(device);
 350        if (button && button->type == ACPI_BUTTON_TYPE_LID)
 351                return acpi_lid_send_state(button);
 352        return 0;
 353}
 354
 355static void acpi_button_remove_notify_handlers(struct acpi_button *button)
 356{
 357        switch (button->type) {
 358        case ACPI_BUTTON_TYPE_POWERF:
 359                acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
 360                                                acpi_button_notify_fixed);
 361                break;
 362        case ACPI_BUTTON_TYPE_SLEEPF:
 363                acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
 364                                                acpi_button_notify_fixed);
 365                break;
 366        default:
 367                acpi_remove_notify_handler(button->device->handle,
 368                                           ACPI_DEVICE_NOTIFY,
 369                                           acpi_button_notify);
 370                break;
 371        }
 372}
 373
 374static int acpi_button_add(struct acpi_device *device)
 375{
 376        int error;
 377        struct acpi_button *button;
 378        struct input_dev *input;
 379
 380        if (!device)
 381                return -EINVAL;
 382
 383        button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
 384        if (!button)
 385                return -ENOMEM;
 386
 387        button->device = device;
 388        acpi_driver_data(device) = button;
 389
 390        button->input = input = input_allocate_device();
 391        if (!input) {
 392                error = -ENOMEM;
 393                goto err_free_button;
 394        }
 395
 396        /*
 397         * Determine the button type (via hid), as fixed-feature buttons
 398         * need to be handled a bit differently than generic-space.
 399         */
 400        if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWER)) {
 401                button->type = ACPI_BUTTON_TYPE_POWER;
 402                strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_POWER);
 403                sprintf(acpi_device_class(device), "%s/%s",
 404                        ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
 405        } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_POWERF)) {
 406                button->type = ACPI_BUTTON_TYPE_POWERF;
 407                strcpy(acpi_device_name(device),
 408                       ACPI_BUTTON_DEVICE_NAME_POWERF);
 409                sprintf(acpi_device_class(device), "%s/%s",
 410                        ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
 411        } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEP)) {
 412                button->type = ACPI_BUTTON_TYPE_SLEEP;
 413                strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_SLEEP);
 414                sprintf(acpi_device_class(device), "%s/%s",
 415                        ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
 416        } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_SLEEPF)) {
 417                button->type = ACPI_BUTTON_TYPE_SLEEPF;
 418                strcpy(acpi_device_name(device),
 419                       ACPI_BUTTON_DEVICE_NAME_SLEEPF);
 420                sprintf(acpi_device_class(device), "%s/%s",
 421                        ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
 422        } else if (!strcmp(acpi_device_hid(device), ACPI_BUTTON_HID_LID)) {
 423                button->type = ACPI_BUTTON_TYPE_LID;
 424                strcpy(acpi_device_name(device), ACPI_BUTTON_DEVICE_NAME_LID);
 425                sprintf(acpi_device_class(device), "%s/%s",
 426                        ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
 427        } else {
 428                printk(KERN_ERR PREFIX "Unsupported hid [%s]\n",
 429                            acpi_device_hid(device));
 430                error = -ENODEV;
 431                goto err_free_input;
 432        }
 433
 434        error = acpi_button_add_fs(device);
 435        if (error)
 436                goto err_free_input;
 437
 438        error = acpi_button_install_notify_handlers(button);
 439        if (error)
 440                goto err_remove_fs;
 441
 442        snprintf(button->phys, sizeof(button->phys),
 443                 "%s/button/input0", acpi_device_hid(device));
 444
 445        input->name = acpi_device_name(device);
 446        input->phys = button->phys;
 447        input->id.bustype = BUS_HOST;
 448        input->id.product = button->type;
 449        input->dev.parent = &device->dev;
 450
 451        switch (button->type) {
 452        case ACPI_BUTTON_TYPE_POWER:
 453        case ACPI_BUTTON_TYPE_POWERF:
 454                input->evbit[0] = BIT_MASK(EV_KEY);
 455                set_bit(KEY_POWER, input->keybit);
 456                break;
 457
 458        case ACPI_BUTTON_TYPE_SLEEP:
 459        case ACPI_BUTTON_TYPE_SLEEPF:
 460                input->evbit[0] = BIT_MASK(EV_KEY);
 461                set_bit(KEY_SLEEP, input->keybit);
 462                break;
 463
 464        case ACPI_BUTTON_TYPE_LID:
 465                input->evbit[0] = BIT_MASK(EV_SW);
 466                set_bit(SW_LID, input->swbit);
 467                break;
 468        }
 469
 470        error = input_register_device(input);
 471        if (error)
 472                goto err_remove_handlers;
 473        if (button->type == ACPI_BUTTON_TYPE_LID)
 474                acpi_lid_send_state(button);
 475
 476        if (device->wakeup.flags.valid) {
 477                /* Button's GPE is run-wake GPE */
 478                acpi_set_gpe_type(device->wakeup.gpe_device,
 479                                  device->wakeup.gpe_number,
 480                                  ACPI_GPE_TYPE_WAKE_RUN);
 481                acpi_enable_gpe(device->wakeup.gpe_device,
 482                                device->wakeup.gpe_number, ACPI_NOT_ISR);
 483                device->wakeup.state.enabled = 1;
 484        }
 485
 486        printk(KERN_INFO PREFIX "%s [%s]\n",
 487               acpi_device_name(device), acpi_device_bid(device));
 488
 489        return 0;
 490
 491 err_remove_handlers:
 492        acpi_button_remove_notify_handlers(button);
 493 err_remove_fs:
 494        acpi_button_remove_fs(device);
 495 err_free_input:
 496        input_free_device(input);
 497 err_free_button:
 498        kfree(button);
 499        return error;
 500}
 501
 502static int acpi_button_remove(struct acpi_device *device, int type)
 503{
 504        struct acpi_button *button;
 505
 506        if (!device || !acpi_driver_data(device))
 507                return -EINVAL;
 508
 509        button = acpi_driver_data(device);
 510
 511        acpi_button_remove_notify_handlers(button);
 512        acpi_button_remove_fs(device);
 513        input_unregister_device(button->input);
 514        kfree(button);
 515
 516        return 0;
 517}
 518
 519static int __init acpi_button_init(void)
 520{
 521        int result;
 522
 523        acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
 524        if (!acpi_button_dir)
 525                return -ENODEV;
 526        acpi_button_dir->owner = THIS_MODULE;
 527        result = acpi_bus_register_driver(&acpi_button_driver);
 528        if (result < 0) {
 529                remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
 530                return -ENODEV;
 531        }
 532
 533        return 0;
 534}
 535
 536static void __exit acpi_button_exit(void)
 537{
 538        acpi_bus_unregister_driver(&acpi_button_driver);
 539
 540        if (acpi_power_dir)
 541                remove_proc_entry(ACPI_BUTTON_SUBCLASS_POWER, acpi_button_dir);
 542        if (acpi_sleep_dir)
 543                remove_proc_entry(ACPI_BUTTON_SUBCLASS_SLEEP, acpi_button_dir);
 544        if (acpi_lid_dir)
 545                remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
 546        remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
 547}
 548
 549module_init(acpi_button_init);
 550module_exit(acpi_button_exit);
 551