drivers/platform/x86/hp_accel.c

   1 /*
   2  *  hp_accel.c - Interface between LIS3LV02DL driver and HP ACPI BIOS
   3  *
   4  *  Copyright (C) 2007-2008 Yan Burman
   5  *  Copyright (C) 2008 Eric Piel
   6  *  Copyright (C) 2008-2009 Pavel Machek
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  24
  25 #include <linux/kernel.h>
  26 #include <linux/init.h>
  27 #include <linux/dmi.h>
  28 #include <linux/module.h>
  29 #include <linux/types.h>
  30 #include <linux/platform_device.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/delay.h>
  33 #include <linux/wait.h>
  34 #include <linux/poll.h>
  35 #include <linux/freezer.h>
  36 #include <linux/uaccess.h>
  37 #include <linux/leds.h>
  38 #include <linux/atomic.h>
  39 #include <linux/acpi.h>
  40 #include <linux/i8042.h>
  41 #include <linux/serio.h>
  42 #include "../../misc/lis3lv02d/lis3lv02d.h"
  43
  44 #define DRIVER_NAME     "hp_accel"
  45 #define ACPI_MDPS_CLASS "accelerometer"
  46
  47 /* Delayed LEDs infrastructure ------------------------------------ */
  48
  49 /* Special LED class that can defer work */
  50 struct delayed_led_classdev {
  51         struct led_classdev led_classdev;
  52         struct work_struct work;
  53         enum led_brightness new_brightness;
  54
  55         unsigned int led;               /* For driver */
  56         void (*set_brightness)(struct delayed_led_classdev *data, enum led_brightness value);
  57 };
  58
  59 static inline void delayed_set_status_worker(struct work_struct *work)
  60 {
  61         struct delayed_led_classdev *data =
  62                         container_of(work, struct delayed_led_classdev, work);
  63
  64         data->set_brightness(data, data->new_brightness);
  65 }
  66
  67 static inline void delayed_sysfs_set(struct led_classdev *led_cdev,
  68                               enum led_brightness brightness)
  69 {
  70         struct delayed_led_classdev *data = container_of(led_cdev,
  71                              struct delayed_led_classdev, led_classdev);
  72         data->new_brightness = brightness;
  73         schedule_work(&data->work);
  74 }
  75
  76 /* HP-specific accelerometer driver ------------------------------------ */
  77
  78 /* e0 25, e0 26, e0 27, e0 28 are scan codes that the accelerometer with acpi id
  79  * HPQ6000 sends through the keyboard bus */
  80 #define ACCEL_1 0x25
  81 #define ACCEL_2 0x26
  82 #define ACCEL_3 0x27
  83 #define ACCEL_4 0x28
  84
  85 /* For automatic insertion of the module */
  86 static const struct acpi_device_id lis3lv02d_device_ids[] = {
  87         {"HPQ0004", 0}, /* HP Mobile Data Protection System PNP */
  88         {"HPQ6000", 0}, /* HP Mobile Data Protection System PNP */
  89         {"HPQ6007", 0}, /* HP Mobile Data Protection System PNP */
  90         {"", 0},
  91 };
  92 MODULE_DEVICE_TABLE(acpi, lis3lv02d_device_ids);
  93
  94
  95 /**
  96  * lis3lv02d_acpi_init - ACPI _INI method: initialize the device.
  97  * @lis3: pointer to the device struct
  98  *
  99  * Returns 0 on success.
 100  */
 101 static int lis3lv02d_acpi_init(struct lis3lv02d *lis3)
 102 {
 103         struct acpi_device *dev = lis3->bus_priv;
 104         if (acpi_evaluate_object(dev->handle, METHOD_NAME__INI,
 105                                  NULL, NULL) != AE_OK)
 106                 return -EINVAL;
 107
 108         return 0;
 109 }
 110
 111 /**
 112  * lis3lv02d_acpi_read - ACPI ALRD method: read a register
 113  * @lis3: pointer to the device struct
 114  * @reg:    the register to read
 115  * @ret:    result of the operation
 116  *
 117  * Returns 0 on success.
 118  */
 119 static int lis3lv02d_acpi_read(struct lis3lv02d *lis3, int reg, u8 *ret)
 120 {
 121         struct acpi_device *dev = lis3->bus_priv;
 122         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
 123         struct acpi_object_list args = { 1, &arg0 };
 124         unsigned long long lret;
 125         acpi_status status;
 126
 127         arg0.integer.value = reg;
 128
 129         status = acpi_evaluate_integer(dev->handle, "ALRD", &args, &lret);
 130         *ret = lret;
 131         return (status != AE_OK) ? -EINVAL : 0;
 132 }
 133
 134 /**
 135  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
 136  * @lis3: pointer to the device struct
 137  * @reg:    the register to write to
 138  * @val:    the value to write
 139  *
 140  * Returns 0 on success.
 141  */
 142 static int lis3lv02d_acpi_write(struct lis3lv02d *lis3, int reg, u8 val)
 143 {
 144         struct acpi_device *dev = lis3->bus_priv;
 145         unsigned long long ret; /* Not used when writting */
 146         union acpi_object in_obj[2];
 147         struct acpi_object_list args = { 2, in_obj };
 148
 149         in_obj[0].type          = ACPI_TYPE_INTEGER;
 150         in_obj[0].integer.value = reg;
 151         in_obj[1].type          = ACPI_TYPE_INTEGER;
 152         in_obj[1].integer.value = val;
 153
 154         if (acpi_evaluate_integer(dev->handle, "ALWR", &args, &ret) != AE_OK)
 155                 return -EINVAL;
 156
 157         return 0;
 158 }
 159
 160 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
 161 {
 162         lis3_dev.ac = *((union axis_conversion *)dmi->driver_data);
 163         pr_info("hardware type %s found\n", dmi->ident);
 164
 165         return 1;
 166 }
 167
 168 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
 169  * If the value is negative, the opposite of the hw value is used. */
 170 #define DEFINE_CONV(name, x, y, z)                            \
 171         static union axis_conversion lis3lv02d_axis_##name = \
 172                 { .as_array = { x, y, z } }
 173 DEFINE_CONV(normal, 1, 2, 3);
 174 DEFINE_CONV(y_inverted, 1, -2, 3);
 175 DEFINE_CONV(x_inverted, -1, 2, 3);
 176 DEFINE_CONV(z_inverted, 1, 2, -3);
 177 DEFINE_CONV(xy_swap, 2, 1, 3);
 178 DEFINE_CONV(xy_rotated_left, -2, 1, 3);
 179 DEFINE_CONV(xy_rotated_left_usd, -2, 1, -3);
 180 DEFINE_CONV(xy_swap_inverted, -2, -1, 3);
 181 DEFINE_CONV(xy_rotated_right, 2, -1, 3);
 182 DEFINE_CONV(xy_swap_yz_inverted, 2, -1, -3);
 183
 184 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
 185         .ident = _ident,                                \
 186         .callback = lis3lv02d_dmi_matched,              \
 187         .matches = {                                    \
 188                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
 189         },                                              \
 190         .driver_data = &lis3lv02d_axis_##_axis          \
 191 }
 192
 193 #define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
 194                                 _class2, _name2,        \
 195                                 _axis) {                \
 196         .ident = _ident,                                \
 197         .callback = lis3lv02d_dmi_matched,              \
 198         .matches = {                                    \
 199                 DMI_MATCH(DMI_##_class1, _name1),       \
 200                 DMI_MATCH(DMI_##_class2, _name2),       \
 201         },                                              \
 202         .driver_data = &lis3lv02d_axis_##_axis          \
 203 }
 204 static const struct dmi_system_id lis3lv02d_dmi_ids[] = {
 205         /* product names are truncated to match all kinds of a same model */
 206         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
 207         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
 208         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
 209         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
 210         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
 211         AXIS_DMI_MATCH("NC2710", "HP Compaq 2710", xy_swap),
 212         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
 213         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
 214         AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
 215         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
 216         AXIS_DMI_MATCH("NC6730b", "HP Compaq 6730b", xy_rotated_left_usd),
 217         AXIS_DMI_MATCH("NC6730s", "HP Compaq 6730s", xy_swap),
 218         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
 219         AXIS_DMI_MATCH("NC6710x", "HP Compaq 6710", xy_swap_yz_inverted),
 220         AXIS_DMI_MATCH("NC6715x", "HP Compaq 6715", y_inverted),
 221         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 693", xy_rotated_right),
 222         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 853", xy_swap),
 223         AXIS_DMI_MATCH("NC854xx", "HP EliteBook 854", y_inverted),
 224         AXIS_DMI_MATCH("NC273xx", "HP EliteBook 273", y_inverted),
 225         /* Intel-based HP Pavilion dv5 */
 226         AXIS_DMI_MATCH2("HPDV5_I",
 227                         PRODUCT_NAME, "HP Pavilion dv5",
 228                         BOARD_NAME, "3603",
 229                         x_inverted),
 230         /* AMD-based HP Pavilion dv5 */
 231         AXIS_DMI_MATCH2("HPDV5_A",
 232                         PRODUCT_NAME, "HP Pavilion dv5",
 233                         BOARD_NAME, "3600",
 234                         y_inverted),
 235         AXIS_DMI_MATCH("DV7", "HP Pavilion dv7", x_inverted),
 236         AXIS_DMI_MATCH("HP8710", "HP Compaq 8710", y_inverted),
 237         AXIS_DMI_MATCH("HDX18", "HP HDX 18", x_inverted),
 238         AXIS_DMI_MATCH("HPB432x", "HP ProBook 432", xy_rotated_left),
 239         AXIS_DMI_MATCH("HPB442x", "HP ProBook 442", xy_rotated_left),
 240         AXIS_DMI_MATCH("HPB452x", "HP ProBook 452", y_inverted),
 241         AXIS_DMI_MATCH("HPB522x", "HP ProBook 522", xy_swap),
 242         AXIS_DMI_MATCH("HPB532x", "HP ProBook 532", y_inverted),
 243         AXIS_DMI_MATCH("HPB655x", "HP ProBook 655", xy_swap_inverted),
 244         AXIS_DMI_MATCH("Mini510x", "HP Mini 510", xy_rotated_left_usd),
 245         AXIS_DMI_MATCH("HPB63xx", "HP ProBook 63", xy_swap),
 246         AXIS_DMI_MATCH("HPB64xx", "HP ProBook 64", xy_swap),
 247         AXIS_DMI_MATCH("HPB64xx", "HP EliteBook 84", xy_swap),
 248         AXIS_DMI_MATCH("HPB65xx", "HP ProBook 65", x_inverted),
 249         { NULL, }
 250 /* Laptop models without axis info (yet):
 251  * "NC6910" "HP Compaq 6910"
 252  * "NC2400" "HP Compaq nc2400"
 253  * "NX74x0" "HP Compaq nx74"
 254  * "NX6325" "HP Compaq nx6325"
 255  * "NC4400" "HP Compaq nc4400"
 256  */
 257 };
 258
 259 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
 260 {
 261         struct acpi_device *dev = lis3_dev.bus_priv;
 262         unsigned long long ret; /* Not used when writing */
 263         union acpi_object in_obj[1];
 264         struct acpi_object_list args = { 1, in_obj };
 265
 266         in_obj[0].type          = ACPI_TYPE_INTEGER;
 267         in_obj[0].integer.value = !!value;
 268
 269         acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
 270 }
 271
 272 static struct delayed_led_classdev hpled_led = {
 273         .led_classdev = {
 274                 .name                   = "hp::hddprotect",
 275                 .default_trigger        = "none",
 276                 .brightness_set         = delayed_sysfs_set,
 277                 .flags                  = LED_CORE_SUSPENDRESUME,
 278         },
 279         .set_brightness = hpled_set,
 280 };
 281
 282 static acpi_status
 283 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
 284 {
 285         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
 286                 struct acpi_resource_extended_irq *irq;
 287                 u32 *device_irq = context;
 288
 289                 irq = &resource->data.extended_irq;
 290                 *device_irq = irq->interrupts[0];
 291         }
 292
 293         return AE_OK;
 294 }
 295
 296 static void lis3lv02d_enum_resources(struct acpi_device *device)
 297 {
 298         acpi_status status;
 299
 300         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 301                                         lis3lv02d_get_resource, &lis3_dev.irq);
 302         if (ACPI_FAILURE(status))
 303                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
 304 }
 305
 306 static bool hp_accel_i8042_filter(unsigned char data, unsigned char str,
 307                                   struct serio *port)
 308 {
 309         static bool extended;
 310
 311         if (str & I8042_STR_AUXDATA)
 312                 return false;
 313
 314         if (data == 0xe0) {
 315                 extended = true;
 316                 return true;
 317         } else if (unlikely(extended)) {
 318                 extended = false;
 319
 320                 switch (data) {
 321                 case ACCEL_1:
 322                 case ACCEL_2:
 323                 case ACCEL_3:
 324                 case ACCEL_4:
 325                         return true;
 326                 default:
 327                         serio_interrupt(port, 0xe0, 0);
 328                         return false;
 329                 }
 330         }
 331
 332         return false;
 333 }
 334
 335 static int lis3lv02d_add(struct acpi_device *device)
 336 {
 337         int ret;
 338
 339         if (!device)
 340                 return -EINVAL;
 341
 342         lis3_dev.bus_priv = device;
 343         lis3_dev.init = lis3lv02d_acpi_init;
 344         lis3_dev.read = lis3lv02d_acpi_read;
 345         lis3_dev.write = lis3lv02d_acpi_write;
 346         strcpy(acpi_device_name(device), DRIVER_NAME);
 347         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
 348         device->driver_data = &lis3_dev;
 349
 350         /* obtain IRQ number of our device from ACPI */
 351         lis3lv02d_enum_resources(device);
 352
 353         /* If possible use a "standard" axes order */
 354         if (lis3_dev.ac.x && lis3_dev.ac.y && lis3_dev.ac.z) {
 355                 pr_info("Using custom axes %d,%d,%d\n",
 356                         lis3_dev.ac.x, lis3_dev.ac.y, lis3_dev.ac.z);
 357         } else if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
 358                 pr_info("laptop model unknown, using default axes configuration\n");
 359                 lis3_dev.ac = lis3lv02d_axis_normal;
 360         }
 361
 362         /* call the core layer do its init */
 363         ret = lis3lv02d_init_device(&lis3_dev);
 364         if (ret)
 365                 return ret;
 366
 367         /* filter to remove HPQ6000 accelerometer data
 368          * from keyboard bus stream */
 369         if (strstr(dev_name(&device->dev), "HPQ6000"))
 370                 i8042_install_filter(hp_accel_i8042_filter);
 371
 372         INIT_WORK(&hpled_led.work, delayed_set_status_worker);
 373         ret = led_classdev_register(NULL, &hpled_led.led_classdev);
 374         if (ret) {
 375                 lis3lv02d_joystick_disable(&lis3_dev);
 376                 lis3lv02d_poweroff(&lis3_dev);
 377                 flush_work(&hpled_led.work);
 378                 return ret;
 379         }
 380
 381         return ret;
 382 }
 383
 384 static int lis3lv02d_remove(struct acpi_device *device)
 385 {
 386         if (!device)
 387                 return -EINVAL;
 388
 389         i8042_remove_filter(hp_accel_i8042_filter);
 390         lis3lv02d_joystick_disable(&lis3_dev);
 391         lis3lv02d_poweroff(&lis3_dev);
 392
 393         led_classdev_unregister(&hpled_led.led_classdev);
 394         flush_work(&hpled_led.work);
 395
 396         return lis3lv02d_remove_fs(&lis3_dev);
 397 }
 398
 399
 400 #ifdef CONFIG_PM_SLEEP
 401 static int lis3lv02d_suspend(struct device *dev)
 402 {
 403         /* make sure the device is off when we suspend */
 404         lis3lv02d_poweroff(&lis3_dev);
 405         return 0;
 406 }
 407
 408 static int lis3lv02d_resume(struct device *dev)
 409 {
 410         lis3lv02d_poweron(&lis3_dev);
 411         return 0;
 412 }
 413
 414 static SIMPLE_DEV_PM_OPS(hp_accel_pm, lis3lv02d_suspend, lis3lv02d_resume);
 415 #define HP_ACCEL_PM (&hp_accel_pm)
 416 #else
 417 #define HP_ACCEL_PM NULL
 418 #endif
 419
 420 /* For the HP MDPS aka 3D Driveguard */
 421 static struct acpi_driver lis3lv02d_driver = {
 422         .name  = DRIVER_NAME,
 423         .class = ACPI_MDPS_CLASS,
 424         .ids   = lis3lv02d_device_ids,
 425         .ops = {
 426                 .add     = lis3lv02d_add,
 427                 .remove  = lis3lv02d_remove,
 428         },
 429         .drv.pm = HP_ACCEL_PM,
 430 };
 431 module_acpi_driver(lis3lv02d_driver);
 432
 433 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
 434 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
 435 MODULE_LICENSE("GPL");