drivers/hwmon/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 #include <linux/kernel.h>
  24 #include <linux/init.h>
  25 #include <linux/dmi.h>
  26 #include <linux/module.h>
  27 #include <linux/types.h>
  28 #include <linux/platform_device.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/delay.h>
  31 #include <linux/wait.h>
  32 #include <linux/poll.h>
  33 #include <linux/freezer.h>
  34 #include <linux/uaccess.h>
  35 #include <linux/leds.h>
  36 #include <acpi/acpi_drivers.h>
  37 #include <asm/atomic.h>
  38 #include "lis3lv02d.h"
  39
  40 #define DRIVER_NAME     "lis3lv02d"
  41 #define ACPI_MDPS_CLASS "accelerometer"
  42
  43 /* Delayed LEDs infrastructure ------------------------------------ */
  44
  45 /* Special LED class that can defer work */
  46 struct delayed_led_classdev {
  47         struct led_classdev led_classdev;
  48         struct work_struct work;
  49         enum led_brightness new_brightness;
  50
  51         unsigned int led;               /* For driver */
  52         void (*set_brightness)(struct delayed_led_classdev *data, enum led_brightness value);
  53 };
  54
  55 static inline void delayed_set_status_worker(struct work_struct *work)
  56 {
  57         struct delayed_led_classdev *data =
  58                         container_of(work, struct delayed_led_classdev, work);
  59
  60         data->set_brightness(data, data->new_brightness);
  61 }
  62
  63 static inline void delayed_sysfs_set(struct led_classdev *led_cdev,
  64                               enum led_brightness brightness)
  65 {
  66         struct delayed_led_classdev *data = container_of(led_cdev,
  67                              struct delayed_led_classdev, led_classdev);
  68         data->new_brightness = brightness;
  69         schedule_work(&data->work);
  70 }
  71
  72 /* HP-specific accelerometer driver ------------------------------------ */
  73
  74 /* For automatic insertion of the module */
  75 static struct acpi_device_id lis3lv02d_device_ids[] = {
  76         {"HPQ0004", 0}, /* HP Mobile Data Protection System PNP */
  77         {"", 0},
  78 };
  79 MODULE_DEVICE_TABLE(acpi, lis3lv02d_device_ids);
  80
  81
  82 /**
  83  * lis3lv02d_acpi_init - ACPI _INI method: initialize the device.
  84  * @lis3: pointer to the device struct
  85  *
  86  * Returns 0 on success.
  87  */
  88 int lis3lv02d_acpi_init(struct lis3lv02d *lis3)
  89 {
  90         struct acpi_device *dev = lis3->bus_priv;
  91         if (acpi_evaluate_object(dev->handle, METHOD_NAME__INI,
  92                                  NULL, NULL) != AE_OK)
  93                 return -EINVAL;
  94
  95         return 0;
  96 }
  97
  98 /**
  99  * lis3lv02d_acpi_read - ACPI ALRD method: read a register
 100  * @lis3: pointer to the device struct
 101  * @reg:    the register to read
 102  * @ret:    result of the operation
 103  *
 104  * Returns 0 on success.
 105  */
 106 int lis3lv02d_acpi_read(struct lis3lv02d *lis3, int reg, u8 *ret)
 107 {
 108         struct acpi_device *dev = lis3->bus_priv;
 109         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
 110         struct acpi_object_list args = { 1, &arg0 };
 111         unsigned long long lret;
 112         acpi_status status;
 113
 114         arg0.integer.value = reg;
 115
 116         status = acpi_evaluate_integer(dev->handle, "ALRD", &args, &lret);
 117         *ret = lret;
 118         return (status != AE_OK) ? -EINVAL : 0;
 119 }
 120
 121 /**
 122  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
 123  * @lis3: pointer to the device struct
 124  * @reg:    the register to write to
 125  * @val:    the value to write
 126  *
 127  * Returns 0 on success.
 128  */
 129 int lis3lv02d_acpi_write(struct lis3lv02d *lis3, int reg, u8 val)
 130 {
 131         struct acpi_device *dev = lis3->bus_priv;
 132         unsigned long long ret; /* Not used when writting */
 133         union acpi_object in_obj[2];
 134         struct acpi_object_list args = { 2, in_obj };
 135
 136         in_obj[0].type          = ACPI_TYPE_INTEGER;
 137         in_obj[0].integer.value = reg;
 138         in_obj[1].type          = ACPI_TYPE_INTEGER;
 139         in_obj[1].integer.value = val;
 140
 141         if (acpi_evaluate_integer(dev->handle, "ALWR", &args, &ret) != AE_OK)
 142                 return -EINVAL;
 143
 144         return 0;
 145 }
 146
 147 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
 148 {
 149         lis3_dev.ac = *((union axis_conversion *)dmi->driver_data);
 150         printk(KERN_INFO DRIVER_NAME ": hardware type %s found.\n", dmi->ident);
 151
 152         return 1;
 153 }
 154
 155 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
 156  * If the value is negative, the opposite of the hw value is used. */
 157 #define DEFINE_CONV(name, x, y, z)                            \
 158         static union axis_conversion lis3lv02d_axis_##name = \
 159                 { .as_array = { x, y, z } }
 160 DEFINE_CONV(normal, 1, 2, 3);
 161 DEFINE_CONV(y_inverted, 1, -2, 3);
 162 DEFINE_CONV(x_inverted, -1, 2, 3);
 163 DEFINE_CONV(z_inverted, 1, 2, -3);
 164 DEFINE_CONV(xy_swap, 2, 1, 3);
 165 DEFINE_CONV(xy_rotated_left, -2, 1, 3);
 166 DEFINE_CONV(xy_rotated_left_usd, -2, 1, -3);
 167 DEFINE_CONV(xy_swap_inverted, -2, -1, 3);
 168 DEFINE_CONV(xy_rotated_right, 2, -1, 3);
 169 DEFINE_CONV(xy_swap_yz_inverted, 2, -1, -3);
 170
 171 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
 172         .ident = _ident,                                \
 173         .callback = lis3lv02d_dmi_matched,              \
 174         .matches = {                                    \
 175                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
 176         },                                              \
 177         .driver_data = &lis3lv02d_axis_##_axis          \
 178 }
 179
 180 #define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
 181                                 _class2, _name2,        \
 182                                 _axis) {                \
 183         .ident = _ident,                                \
 184         .callback = lis3lv02d_dmi_matched,              \
 185         .matches = {                                    \
 186                 DMI_MATCH(DMI_##_class1, _name1),       \
 187                 DMI_MATCH(DMI_##_class2, _name2),       \
 188         },                                              \
 189         .driver_data = &lis3lv02d_axis_##_axis          \
 190 }
 191 static struct dmi_system_id lis3lv02d_dmi_ids[] = {
 192         /* product names are truncated to match all kinds of a same model */
 193         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
 194         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
 195         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
 196         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
 197         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
 198         AXIS_DMI_MATCH("NC2710", "HP Compaq 2710", xy_swap),
 199         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
 200         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
 201         AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
 202         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
 203         AXIS_DMI_MATCH("NC6730b", "HP Compaq 6730b", xy_rotated_left_usd),
 204         AXIS_DMI_MATCH("NC6730s", "HP Compaq 6730s", xy_swap),
 205         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
 206         AXIS_DMI_MATCH("NC6710x", "HP Compaq 6710", xy_swap_yz_inverted),
 207         AXIS_DMI_MATCH("NC6715x", "HP Compaq 6715", y_inverted),
 208         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 693", xy_rotated_right),
 209         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 853", xy_swap),
 210         /* Intel-based HP Pavilion dv5 */
 211         AXIS_DMI_MATCH2("HPDV5_I",
 212                         PRODUCT_NAME, "HP Pavilion dv5",
 213                         BOARD_NAME, "3603",
 214                         x_inverted),
 215         /* AMD-based HP Pavilion dv5 */
 216         AXIS_DMI_MATCH2("HPDV5_A",
 217                         PRODUCT_NAME, "HP Pavilion dv5",
 218                         BOARD_NAME, "3600",
 219                         y_inverted),
 220         AXIS_DMI_MATCH("DV7", "HP Pavilion dv7", x_inverted),
 221         AXIS_DMI_MATCH("HP8710", "HP Compaq 8710", y_inverted),
 222         AXIS_DMI_MATCH("HDX18", "HP HDX 18", x_inverted),
 223         AXIS_DMI_MATCH("HPB432x", "HP ProBook 432", xy_rotated_left),
 224         AXIS_DMI_MATCH("HPB442x", "HP ProBook 442", xy_rotated_left),
 225         AXIS_DMI_MATCH("HPB452x", "HP ProBook 452", y_inverted),
 226         AXIS_DMI_MATCH("HPB522x", "HP ProBook 522", xy_swap),
 227         AXIS_DMI_MATCH("HPB532x", "HP ProBook 532", y_inverted),
 228         AXIS_DMI_MATCH("Mini510x", "HP Mini 510", xy_rotated_left_usd),
 229         { NULL, }
 230 /* Laptop models without axis info (yet):
 231  * "NC6910" "HP Compaq 6910"
 232  * "NC2400" "HP Compaq nc2400"
 233  * "NX74x0" "HP Compaq nx74"
 234  * "NX6325" "HP Compaq nx6325"
 235  * "NC4400" "HP Compaq nc4400"
 236  */
 237 };
 238
 239 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
 240 {
 241         struct acpi_device *dev = lis3_dev.bus_priv;
 242         unsigned long long ret; /* Not used when writing */
 243         union acpi_object in_obj[1];
 244         struct acpi_object_list args = { 1, in_obj };
 245
 246         in_obj[0].type          = ACPI_TYPE_INTEGER;
 247         in_obj[0].integer.value = !!value;
 248
 249         acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
 250 }
 251
 252 static struct delayed_led_classdev hpled_led = {
 253         .led_classdev = {
 254                 .name                   = "hp::hddprotect",
 255                 .default_trigger        = "none",
 256                 .brightness_set         = delayed_sysfs_set,
 257                 .flags                  = LED_CORE_SUSPENDRESUME,
 258         },
 259         .set_brightness = hpled_set,
 260 };
 261
 262 static acpi_status
 263 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
 264 {
 265         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
 266                 struct acpi_resource_extended_irq *irq;
 267                 u32 *device_irq = context;
 268
 269                 irq = &resource->data.extended_irq;
 270                 *device_irq = irq->interrupts[0];
 271         }
 272
 273         return AE_OK;
 274 }
 275
 276 static void lis3lv02d_enum_resources(struct acpi_device *device)
 277 {
 278         acpi_status status;
 279
 280         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 281                                         lis3lv02d_get_resource, &lis3_dev.irq);
 282         if (ACPI_FAILURE(status))
 283                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
 284 }
 285
 286 static int lis3lv02d_add(struct acpi_device *device)
 287 {
 288         int ret;
 289
 290         if (!device)
 291                 return -EINVAL;
 292
 293         lis3_dev.bus_priv = device;
 294         lis3_dev.init = lis3lv02d_acpi_init;
 295         lis3_dev.read = lis3lv02d_acpi_read;
 296         lis3_dev.write = lis3lv02d_acpi_write;
 297         strcpy(acpi_device_name(device), DRIVER_NAME);
 298         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
 299         device->driver_data = &lis3_dev;
 300
 301         /* obtain IRQ number of our device from ACPI */
 302         lis3lv02d_enum_resources(device);
 303
 304         /* If possible use a "standard" axes order */
 305         if (lis3_dev.ac.x && lis3_dev.ac.y && lis3_dev.ac.z) {
 306                 printk(KERN_INFO DRIVER_NAME ": Using custom axes %d,%d,%d\n",
 307                        lis3_dev.ac.x, lis3_dev.ac.y, lis3_dev.ac.z);
 308         } else if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
 309                 printk(KERN_INFO DRIVER_NAME ": laptop model unknown, "
 310                                  "using default axes configuration\n");
 311                 lis3_dev.ac = lis3lv02d_axis_normal;
 312         }
 313
 314         /* call the core layer do its init */
 315         ret = lis3lv02d_init_device(&lis3_dev);
 316         if (ret)
 317                 return ret;
 318
 319         INIT_WORK(&hpled_led.work, delayed_set_status_worker);
 320         ret = led_classdev_register(NULL, &hpled_led.led_classdev);
 321         if (ret) {
 322                 lis3lv02d_joystick_disable();
 323                 lis3lv02d_poweroff(&lis3_dev);
 324                 flush_work(&hpled_led.work);
 325                 return ret;
 326         }
 327
 328         return ret;
 329 }
 330
 331 static int lis3lv02d_remove(struct acpi_device *device, int type)
 332 {
 333         if (!device)
 334                 return -EINVAL;
 335
 336         lis3lv02d_joystick_disable();
 337         lis3lv02d_poweroff(&lis3_dev);
 338
 339         led_classdev_unregister(&hpled_led.led_classdev);
 340         flush_work(&hpled_led.work);
 341
 342         return lis3lv02d_remove_fs(&lis3_dev);
 343 }
 344
 345
 346 #ifdef CONFIG_PM
 347 static int lis3lv02d_suspend(struct acpi_device *device, pm_message_t state)
 348 {
 349         /* make sure the device is off when we suspend */
 350         lis3lv02d_poweroff(&lis3_dev);
 351         return 0;
 352 }
 353
 354 static int lis3lv02d_resume(struct acpi_device *device)
 355 {
 356         lis3lv02d_poweron(&lis3_dev);
 357         return 0;
 358 }
 359 #else
 360 #define lis3lv02d_suspend NULL
 361 #define lis3lv02d_resume NULL
 362 #endif
 363
 364 /* For the HP MDPS aka 3D Driveguard */
 365 static struct acpi_driver lis3lv02d_driver = {
 366         .name  = DRIVER_NAME,
 367         .class = ACPI_MDPS_CLASS,
 368         .ids   = lis3lv02d_device_ids,
 369         .ops = {
 370                 .add     = lis3lv02d_add,
 371                 .remove  = lis3lv02d_remove,
 372                 .suspend = lis3lv02d_suspend,
 373                 .resume  = lis3lv02d_resume,
 374         }
 375 };
 376
 377 static int __init lis3lv02d_init_module(void)
 378 {
 379         int ret;
 380
 381         if (acpi_disabled)
 382                 return -ENODEV;
 383
 384         ret = acpi_bus_register_driver(&lis3lv02d_driver);
 385         if (ret < 0)
 386                 return ret;
 387
 388         printk(KERN_INFO DRIVER_NAME " driver loaded.\n");
 389
 390         return 0;
 391 }
 392
 393 static void __exit lis3lv02d_exit_module(void)
 394 {
 395         acpi_bus_unregister_driver(&lis3lv02d_driver);
 396 }
 397
 398 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
 399 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
 400 MODULE_LICENSE("GPL");
 401
 402 module_init(lis3lv02d_init_module);
 403 module_exit(lis3lv02d_exit_module);
 404