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/input.h>
  31 #include <linux/kthread.h>
  32 #include <linux/semaphore.h>
  33 #include <linux/delay.h>
  34 #include <linux/wait.h>
  35 #include <linux/poll.h>
  36 #include <linux/freezer.h>
  37 #include <linux/version.h>
  38 #include <linux/uaccess.h>
  39 #include <linux/leds.h>
  40 #include <acpi/acpi_drivers.h>
  41 #include <asm/atomic.h>
  42 #include "lis3lv02d.h"
  43
  44 #define DRIVER_NAME     "lis3lv02d"
  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 /* For automatic insertion of the module */
  79 static struct acpi_device_id lis3lv02d_device_ids[] = {
  80         {"HPQ0004", 0}, /* HP Mobile Data Protection System PNP */
  81         {"", 0},
  82 };
  83 MODULE_DEVICE_TABLE(acpi, lis3lv02d_device_ids);
  84
  85
  86 /**
  87  * lis3lv02d_acpi_init - ACPI _INI method: initialize the device.
  88  * @lis3: pointer to the device struct
  89  *
  90  * Returns 0 on success.
  91  */
  92 int lis3lv02d_acpi_init(struct lis3lv02d *lis3)
  93 {
  94         struct acpi_device *dev = lis3->bus_priv;
  95         if (acpi_evaluate_object(dev->handle, METHOD_NAME__INI,
  96                                  NULL, NULL) != AE_OK)
  97                 return -EINVAL;
  98
  99         return 0;
 100 }
 101
 102 /**
 103  * lis3lv02d_acpi_read - ACPI ALRD method: read a register
 104  * @lis3: pointer to the device struct
 105  * @reg:    the register to read
 106  * @ret:    result of the operation
 107  *
 108  * Returns 0 on success.
 109  */
 110 int lis3lv02d_acpi_read(struct lis3lv02d *lis3, int reg, u8 *ret)
 111 {
 112         struct acpi_device *dev = lis3->bus_priv;
 113         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
 114         struct acpi_object_list args = { 1, &arg0 };
 115         unsigned long long lret;
 116         acpi_status status;
 117
 118         arg0.integer.value = reg;
 119
 120         status = acpi_evaluate_integer(dev->handle, "ALRD", &args, &lret);
 121         *ret = lret;
 122         return (status != AE_OK) ? -EINVAL : 0;
 123 }
 124
 125 /**
 126  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
 127  * @lis3: pointer to the device struct
 128  * @reg:    the register to write to
 129  * @val:    the value to write
 130  *
 131  * Returns 0 on success.
 132  */
 133 int lis3lv02d_acpi_write(struct lis3lv02d *lis3, int reg, u8 val)
 134 {
 135         struct acpi_device *dev = lis3->bus_priv;
 136         unsigned long long ret; /* Not used when writting */
 137         union acpi_object in_obj[2];
 138         struct acpi_object_list args = { 2, in_obj };
 139
 140         in_obj[0].type          = ACPI_TYPE_INTEGER;
 141         in_obj[0].integer.value = reg;
 142         in_obj[1].type          = ACPI_TYPE_INTEGER;
 143         in_obj[1].integer.value = val;
 144
 145         if (acpi_evaluate_integer(dev->handle, "ALWR", &args, &ret) != AE_OK)
 146                 return -EINVAL;
 147
 148         return 0;
 149 }
 150
 151 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
 152 {
 153         lis3_dev.ac = *((struct axis_conversion *)dmi->driver_data);
 154         printk(KERN_INFO DRIVER_NAME ": hardware type %s found.\n", dmi->ident);
 155
 156         return 1;
 157 }
 158
 159 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
 160  * If the value is negative, the opposite of the hw value is used. */
 161 static struct axis_conversion lis3lv02d_axis_normal = {1, 2, 3};
 162 static struct axis_conversion lis3lv02d_axis_y_inverted = {1, -2, 3};
 163 static struct axis_conversion lis3lv02d_axis_x_inverted = {-1, 2, 3};
 164 static struct axis_conversion lis3lv02d_axis_z_inverted = {1, 2, -3};
 165 static struct axis_conversion lis3lv02d_axis_xy_rotated_left = {-2, 1, 3};
 166 static struct axis_conversion lis3lv02d_axis_xy_rotated_left_usd = {-2, 1, -3};
 167 static struct axis_conversion lis3lv02d_axis_xy_swap_inverted = {-2, -1, 3};
 168 static struct axis_conversion lis3lv02d_axis_xy_rotated_right = {2, -1, 3};
 169 static struct axis_conversion lis3lv02d_axis_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("NC8510", "HP Compaq 8510", xy_swap_inverted),
 199         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
 200         AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
 201         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
 202         AXIS_DMI_MATCH("NC673x", "HP Compaq 673", xy_rotated_left_usd),
 203         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
 204         AXIS_DMI_MATCH("NC671xx", "HP Compaq 671", xy_swap_yz_inverted),
 205         /* Intel-based HP Pavilion dv5 */
 206         AXIS_DMI_MATCH2("HPDV5_I",
 207                         PRODUCT_NAME, "HP Pavilion dv5",
 208                         BOARD_NAME, "3603",
 209                         x_inverted),
 210         /* AMD-based HP Pavilion dv5 */
 211         AXIS_DMI_MATCH2("HPDV5_A",
 212                         PRODUCT_NAME, "HP Pavilion dv5",
 213                         BOARD_NAME, "3600",
 214                         y_inverted),
 215         AXIS_DMI_MATCH("DV7", "HP Pavilion dv7", x_inverted),
 216         AXIS_DMI_MATCH("HP8710", "HP Compaq 8710", y_inverted),
 217         { NULL, }
 218 /* Laptop models without axis info (yet):
 219  * "NC6910" "HP Compaq 6910"
 220  * HP Compaq 8710x Notebook PC / Mobile Workstation
 221  * "NC2400" "HP Compaq nc2400"
 222  * "NX74x0" "HP Compaq nx74"
 223  * "NX6325" "HP Compaq nx6325"
 224  * "NC4400" "HP Compaq nc4400"
 225  */
 226 };
 227
 228 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
 229 {
 230         struct acpi_device *dev = lis3_dev.bus_priv;
 231         unsigned long long ret; /* Not used when writing */
 232         union acpi_object in_obj[1];
 233         struct acpi_object_list args = { 1, in_obj };
 234
 235         in_obj[0].type          = ACPI_TYPE_INTEGER;
 236         in_obj[0].integer.value = !!value;
 237
 238         acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
 239 }
 240
 241 static struct delayed_led_classdev hpled_led = {
 242         .led_classdev = {
 243                 .name                   = "hp::hddprotect",
 244                 .default_trigger        = "none",
 245                 .brightness_set         = delayed_sysfs_set,
 246                 .flags                  = LED_CORE_SUSPENDRESUME,
 247         },
 248         .set_brightness = hpled_set,
 249 };
 250
 251 static acpi_status
 252 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
 253 {
 254         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
 255                 struct acpi_resource_extended_irq *irq;
 256                 u32 *device_irq = context;
 257
 258                 irq = &resource->data.extended_irq;
 259                 *device_irq = irq->interrupts[0];
 260         }
 261
 262         return AE_OK;
 263 }
 264
 265 static void lis3lv02d_enum_resources(struct acpi_device *device)
 266 {
 267         acpi_status status;
 268
 269         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 270                                         lis3lv02d_get_resource, &lis3_dev.irq);
 271         if (ACPI_FAILURE(status))
 272                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
 273 }
 274
 275 static int lis3lv02d_add(struct acpi_device *device)
 276 {
 277         int ret;
 278
 279         if (!device)
 280                 return -EINVAL;
 281
 282         lis3_dev.bus_priv = device;
 283         lis3_dev.init = lis3lv02d_acpi_init;
 284         lis3_dev.read = lis3lv02d_acpi_read;
 285         lis3_dev.write = lis3lv02d_acpi_write;
 286         strcpy(acpi_device_name(device), DRIVER_NAME);
 287         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
 288         device->driver_data = &lis3_dev;
 289
 290         /* obtain IRQ number of our device from ACPI */
 291         lis3lv02d_enum_resources(device);
 292
 293         /* If possible use a "standard" axes order */
 294         if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
 295                 printk(KERN_INFO DRIVER_NAME ": laptop model unknown, "
 296                                  "using default axes configuration\n");
 297                 lis3_dev.ac = lis3lv02d_axis_normal;
 298         }
 299
 300         /* call the core layer do its init */
 301         ret = lis3lv02d_init_device(&lis3_dev);
 302         if (ret)
 303                 return ret;
 304
 305         INIT_WORK(&hpled_led.work, delayed_set_status_worker);
 306         ret = led_classdev_register(NULL, &hpled_led.led_classdev);
 307         if (ret) {
 308                 lis3lv02d_joystick_disable();
 309                 lis3lv02d_poweroff(&lis3_dev);
 310                 flush_work(&hpled_led.work);
 311                 return ret;
 312         }
 313
 314         return ret;
 315 }
 316
 317 static int lis3lv02d_remove(struct acpi_device *device, int type)
 318 {
 319         if (!device)
 320                 return -EINVAL;
 321
 322         lis3lv02d_joystick_disable();
 323         lis3lv02d_poweroff(&lis3_dev);
 324
 325         flush_work(&hpled_led.work);
 326         led_classdev_unregister(&hpled_led.led_classdev);
 327
 328         return lis3lv02d_remove_fs();
 329 }
 330
 331
 332 #ifdef CONFIG_PM
 333 static int lis3lv02d_suspend(struct acpi_device *device, pm_message_t state)
 334 {
 335         /* make sure the device is off when we suspend */
 336         lis3lv02d_poweroff(&lis3_dev);
 337         return 0;
 338 }
 339
 340 static int lis3lv02d_resume(struct acpi_device *device)
 341 {
 342         /* put back the device in the right state (ACPI might turn it on) */
 343         mutex_lock(&lis3_dev.lock);
 344         if (lis3_dev.usage > 0)
 345                 lis3lv02d_poweron(&lis3_dev);
 346         else
 347                 lis3lv02d_poweroff(&lis3_dev);
 348         mutex_unlock(&lis3_dev.lock);
 349         return 0;
 350 }
 351 #else
 352 #define lis3lv02d_suspend NULL
 353 #define lis3lv02d_resume NULL
 354 #endif
 355
 356 /* For the HP MDPS aka 3D Driveguard */
 357 static struct acpi_driver lis3lv02d_driver = {
 358         .name  = DRIVER_NAME,
 359         .class = ACPI_MDPS_CLASS,
 360         .ids   = lis3lv02d_device_ids,
 361         .ops = {
 362                 .add     = lis3lv02d_add,
 363                 .remove  = lis3lv02d_remove,
 364                 .suspend = lis3lv02d_suspend,
 365                 .resume  = lis3lv02d_resume,
 366         }
 367 };
 368
 369 static int __init lis3lv02d_init_module(void)
 370 {
 371         int ret;
 372
 373         if (acpi_disabled)
 374                 return -ENODEV;
 375
 376         ret = acpi_bus_register_driver(&lis3lv02d_driver);
 377         if (ret < 0)
 378                 return ret;
 379
 380         printk(KERN_INFO DRIVER_NAME " driver loaded.\n");
 381
 382         return 0;
 383 }
 384
 385 static void __exit lis3lv02d_exit_module(void)
 386 {
 387         acpi_bus_unregister_driver(&lis3lv02d_driver);
 388 }
 389
 390 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
 391 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
 392 MODULE_LICENSE("GPL");
 393
 394 module_init(lis3lv02d_init_module);
 395 module_exit(lis3lv02d_exit_module);
 396