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         if (ACPI_FAILURE(status))
 131                 return -EINVAL;
 132         *ret = lret;
 133         return 0;
 134 }
 135
 136 /**
 137  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
 138  * @lis3: pointer to the device struct
 139  * @reg:    the register to write to
 140  * @val:    the value to write
 141  *
 142  * Returns 0 on success.
 143  */
 144 static int lis3lv02d_acpi_write(struct lis3lv02d *lis3, int reg, u8 val)
 145 {
 146         struct acpi_device *dev = lis3->bus_priv;
 147         unsigned long long ret; /* Not used when writting */
 148         union acpi_object in_obj[2];
 149         struct acpi_object_list args = { 2, in_obj };
 150
 151         in_obj[0].type          = ACPI_TYPE_INTEGER;
 152         in_obj[0].integer.value = reg;
 153         in_obj[1].type          = ACPI_TYPE_INTEGER;
 154         in_obj[1].integer.value = val;
 155
 156         if (acpi_evaluate_integer(dev->handle, "ALWR", &args, &ret) != AE_OK)
 157                 return -EINVAL;
 158
 159         return 0;
 160 }
 161
 162 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
 163 {
 164         lis3_dev.ac = *((union axis_conversion *)dmi->driver_data);
 165         pr_info("hardware type %s found\n", dmi->ident);
 166
 167         return 1;
 168 }
 169
 170 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
 171  * If the value is negative, the opposite of the hw value is used. */
 172 #define DEFINE_CONV(name, x, y, z)                            \
 173         static union axis_conversion lis3lv02d_axis_##name = \
 174                 { .as_array = { x, y, z } }
 175 DEFINE_CONV(normal, 1, 2, 3);
 176 DEFINE_CONV(y_inverted, 1, -2, 3);
 177 DEFINE_CONV(x_inverted, -1, 2, 3);
 178 DEFINE_CONV(x_inverted_usd, -1, 2, -3);
 179 DEFINE_CONV(z_inverted, 1, 2, -3);
 180 DEFINE_CONV(xy_swap, 2, 1, 3);
 181 DEFINE_CONV(xy_rotated_left, -2, 1, 3);
 182 DEFINE_CONV(xy_rotated_left_usd, -2, 1, -3);
 183 DEFINE_CONV(xy_swap_inverted, -2, -1, 3);
 184 DEFINE_CONV(xy_rotated_right, 2, -1, 3);
 185 DEFINE_CONV(xy_swap_yz_inverted, 2, -1, -3);
 186
 187 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
 188         .ident = _ident,                                \
 189         .callback = lis3lv02d_dmi_matched,              \
 190         .matches = {                                    \
 191                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
 192         },                                              \
 193         .driver_data = &lis3lv02d_axis_##_axis          \
 194 }
 195
 196 #define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
 197                                 _class2, _name2,        \
 198                                 _axis) {                \
 199         .ident = _ident,                                \
 200         .callback = lis3lv02d_dmi_matched,              \
 201         .matches = {                                    \
 202                 DMI_MATCH(DMI_##_class1, _name1),       \
 203                 DMI_MATCH(DMI_##_class2, _name2),       \
 204         },                                              \
 205         .driver_data = &lis3lv02d_axis_##_axis          \
 206 }
 207 static const struct dmi_system_id lis3lv02d_dmi_ids[] = {
 208         /* product names are truncated to match all kinds of a same model */
 209         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
 210         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
 211         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
 212         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
 213         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
 214         AXIS_DMI_MATCH("NC2710", "HP Compaq 2710", xy_swap),
 215         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
 216         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
 217         AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
 218         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
 219         AXIS_DMI_MATCH("NC6730b", "HP Compaq 6730b", xy_rotated_left_usd),
 220         AXIS_DMI_MATCH("NC6730s", "HP Compaq 6730s", xy_swap),
 221         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
 222         AXIS_DMI_MATCH("NC6710x", "HP Compaq 6710", xy_swap_yz_inverted),
 223         AXIS_DMI_MATCH("NC6715x", "HP Compaq 6715", y_inverted),
 224         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 693", xy_rotated_right),
 225         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 853", xy_swap),
 226         AXIS_DMI_MATCH("NC854xx", "HP EliteBook 854", y_inverted),
 227         AXIS_DMI_MATCH("NC273xx", "HP EliteBook 273", y_inverted),
 228         /* Intel-based HP Pavilion dv5 */
 229         AXIS_DMI_MATCH2("HPDV5_I",
 230                         PRODUCT_NAME, "HP Pavilion dv5",
 231                         BOARD_NAME, "3603",
 232                         x_inverted),
 233         /* AMD-based HP Pavilion dv5 */
 234         AXIS_DMI_MATCH2("HPDV5_A",
 235                         PRODUCT_NAME, "HP Pavilion dv5",
 236                         BOARD_NAME, "3600",
 237                         y_inverted),
 238         AXIS_DMI_MATCH("DV7", "HP Pavilion dv7", x_inverted),
 239         AXIS_DMI_MATCH("HP8710", "HP Compaq 8710", y_inverted),
 240         AXIS_DMI_MATCH("HDX18", "HP HDX 18", x_inverted),
 241         AXIS_DMI_MATCH("HPB432x", "HP ProBook 432", xy_rotated_left),
 242         AXIS_DMI_MATCH("HPB440G3", "HP ProBook 440 G3", x_inverted_usd),
 243         AXIS_DMI_MATCH("HPB442x", "HP ProBook 442", xy_rotated_left),
 244         AXIS_DMI_MATCH("HPB452x", "HP ProBook 452", y_inverted),
 245         AXIS_DMI_MATCH("HPB522x", "HP ProBook 522", xy_swap),
 246         AXIS_DMI_MATCH("HPB532x", "HP ProBook 532", y_inverted),
 247         AXIS_DMI_MATCH("HPB655x", "HP ProBook 655", xy_swap_inverted),
 248         AXIS_DMI_MATCH("Mini510x", "HP Mini 510", xy_rotated_left_usd),
 249         AXIS_DMI_MATCH("HPB63xx", "HP ProBook 63", xy_swap),
 250         AXIS_DMI_MATCH("HPB64xx", "HP ProBook 64", xy_swap),
 251         AXIS_DMI_MATCH("HPB64xx", "HP EliteBook 84", xy_swap),
 252         AXIS_DMI_MATCH("HPB65xx", "HP ProBook 65", x_inverted),
 253         AXIS_DMI_MATCH("HPZBook15", "HP ZBook 15", x_inverted),
 254         { NULL, }
 255 /* Laptop models without axis info (yet):
 256  * "NC6910" "HP Compaq 6910"
 257  * "NC2400" "HP Compaq nc2400"
 258  * "NX74x0" "HP Compaq nx74"
 259  * "NX6325" "HP Compaq nx6325"
 260  * "NC4400" "HP Compaq nc4400"
 261  */
 262 };
 263
 264 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
 265 {
 266         struct acpi_device *dev = lis3_dev.bus_priv;
 267         unsigned long long ret; /* Not used when writing */
 268         union acpi_object in_obj[1];
 269         struct acpi_object_list args = { 1, in_obj };
 270
 271         in_obj[0].type          = ACPI_TYPE_INTEGER;
 272         in_obj[0].integer.value = !!value;
 273
 274         acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
 275 }
 276
 277 static struct delayed_led_classdev hpled_led = {
 278         .led_classdev = {
 279                 .name                   = "hp::hddprotect",
 280                 .default_trigger        = "none",
 281                 .brightness_set         = delayed_sysfs_set,
 282                 .flags                  = LED_CORE_SUSPENDRESUME,
 283         },
 284         .set_brightness = hpled_set,
 285 };
 286
 287 static acpi_status
 288 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
 289 {
 290         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
 291                 struct acpi_resource_extended_irq *irq;
 292                 u32 *device_irq = context;
 293
 294                 irq = &resource->data.extended_irq;
 295                 *device_irq = irq->interrupts[0];
 296         }
 297
 298         return AE_OK;
 299 }
 300
 301 static void lis3lv02d_enum_resources(struct acpi_device *device)
 302 {
 303         acpi_status status;
 304
 305         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 306                                         lis3lv02d_get_resource, &lis3_dev.irq);
 307         if (ACPI_FAILURE(status))
 308                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
 309 }
 310
 311 static bool hp_accel_i8042_filter(unsigned char data, unsigned char str,
 312                                   struct serio *port)
 313 {
 314         static bool extended;
 315
 316         if (str & I8042_STR_AUXDATA)
 317                 return false;
 318
 319         if (data == 0xe0) {
 320                 extended = true;
 321                 return true;
 322         } else if (unlikely(extended)) {
 323                 extended = false;
 324
 325                 switch (data) {
 326                 case ACCEL_1:
 327                 case ACCEL_2:
 328                 case ACCEL_3:
 329                 case ACCEL_4:
 330                         return true;
 331                 default:
 332                         serio_interrupt(port, 0xe0, 0);
 333                         return false;
 334                 }
 335         }
 336
 337         return false;
 338 }
 339
 340 static int lis3lv02d_add(struct acpi_device *device)
 341 {
 342         int ret;
 343
 344         if (!device)
 345                 return -EINVAL;
 346
 347         lis3_dev.bus_priv = device;
 348         lis3_dev.init = lis3lv02d_acpi_init;
 349         lis3_dev.read = lis3lv02d_acpi_read;
 350         lis3_dev.write = lis3lv02d_acpi_write;
 351         strcpy(acpi_device_name(device), DRIVER_NAME);
 352         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
 353         device->driver_data = &lis3_dev;
 354
 355         /* obtain IRQ number of our device from ACPI */
 356         lis3lv02d_enum_resources(device);
 357
 358         /* If possible use a "standard" axes order */
 359         if (lis3_dev.ac.x && lis3_dev.ac.y && lis3_dev.ac.z) {
 360                 pr_info("Using custom axes %d,%d,%d\n",
 361                         lis3_dev.ac.x, lis3_dev.ac.y, lis3_dev.ac.z);
 362         } else if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
 363                 pr_info("laptop model unknown, using default axes configuration\n");
 364                 lis3_dev.ac = lis3lv02d_axis_normal;
 365         }
 366
 367         /* call the core layer do its init */
 368         ret = lis3lv02d_init_device(&lis3_dev);
 369         if (ret)
 370                 return ret;
 371
 372         /* filter to remove HPQ6000 accelerometer data
 373          * from keyboard bus stream */
 374         if (strstr(dev_name(&device->dev), "HPQ6000"))
 375                 i8042_install_filter(hp_accel_i8042_filter);
 376
 377         INIT_WORK(&hpled_led.work, delayed_set_status_worker);
 378         ret = led_classdev_register(NULL, &hpled_led.led_classdev);
 379         if (ret) {
 380                 lis3lv02d_joystick_disable(&lis3_dev);
 381                 lis3lv02d_poweroff(&lis3_dev);
 382                 flush_work(&hpled_led.work);
 383                 return ret;
 384         }
 385
 386         return ret;
 387 }
 388
 389 static int lis3lv02d_remove(struct acpi_device *device)
 390 {
 391         if (!device)
 392                 return -EINVAL;
 393
 394         i8042_remove_filter(hp_accel_i8042_filter);
 395         lis3lv02d_joystick_disable(&lis3_dev);
 396         lis3lv02d_poweroff(&lis3_dev);
 397
 398         led_classdev_unregister(&hpled_led.led_classdev);
 399         flush_work(&hpled_led.work);
 400
 401         return lis3lv02d_remove_fs(&lis3_dev);
 402 }
 403
 404
 405 #ifdef CONFIG_PM_SLEEP
 406 static int lis3lv02d_suspend(struct device *dev)
 407 {
 408         /* make sure the device is off when we suspend */
 409         lis3lv02d_poweroff(&lis3_dev);
 410         return 0;
 411 }
 412
 413 static int lis3lv02d_resume(struct device *dev)
 414 {
 415         lis3lv02d_poweron(&lis3_dev);
 416         return 0;
 417 }
 418
 419 static SIMPLE_DEV_PM_OPS(hp_accel_pm, lis3lv02d_suspend, lis3lv02d_resume);
 420 #define HP_ACCEL_PM (&hp_accel_pm)
 421 #else
 422 #define HP_ACCEL_PM NULL
 423 #endif
 424
 425 /* For the HP MDPS aka 3D Driveguard */
 426 static struct acpi_driver lis3lv02d_driver = {
 427         .name  = DRIVER_NAME,
 428         .class = ACPI_MDPS_CLASS,
 429         .ids   = lis3lv02d_device_ids,
 430         .ops = {
 431                 .add     = lis3lv02d_add,
 432                 .remove  = lis3lv02d_remove,
 433         },
 434         .drv.pm = HP_ACCEL_PM,
 435 };
 436 module_acpi_driver(lis3lv02d_driver);
 437
 438 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
 439 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
 440 MODULE_LICENSE("GPL");