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 = *((struct 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 static struct axis_conversion lis3lv02d_axis_normal = {1, 2, 3};
 158 static struct axis_conversion lis3lv02d_axis_y_inverted = {1, -2, 3};
 159 static struct axis_conversion lis3lv02d_axis_x_inverted = {-1, 2, 3};
 160 static struct axis_conversion lis3lv02d_axis_z_inverted = {1, 2, -3};
 161 static struct axis_conversion lis3lv02d_axis_xy_swap = {2, 1, 3};
 162 static struct axis_conversion lis3lv02d_axis_xy_rotated_left = {-2, 1, 3};
 163 static struct axis_conversion lis3lv02d_axis_xy_rotated_left_usd = {-2, 1, -3};
 164 static struct axis_conversion lis3lv02d_axis_xy_swap_inverted = {-2, -1, 3};
 165 static struct axis_conversion lis3lv02d_axis_xy_rotated_right = {2, -1, 3};
 166 static struct axis_conversion lis3lv02d_axis_xy_swap_yz_inverted = {2, -1, -3};
 167
 168 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
 169         .ident = _ident,                                \
 170         .callback = lis3lv02d_dmi_matched,              \
 171         .matches = {                                    \
 172                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
 173         },                                              \
 174         .driver_data = &lis3lv02d_axis_##_axis          \
 175 }
 176
 177 #define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
 178                                 _class2, _name2,        \
 179                                 _axis) {                \
 180         .ident = _ident,                                \
 181         .callback = lis3lv02d_dmi_matched,              \
 182         .matches = {                                    \
 183                 DMI_MATCH(DMI_##_class1, _name1),       \
 184                 DMI_MATCH(DMI_##_class2, _name2),       \
 185         },                                              \
 186         .driver_data = &lis3lv02d_axis_##_axis          \
 187 }
 188 static struct dmi_system_id lis3lv02d_dmi_ids[] = {
 189         /* product names are truncated to match all kinds of a same model */
 190         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
 191         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
 192         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
 193         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
 194         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
 195         AXIS_DMI_MATCH("NC2710", "HP Compaq 2710", xy_swap),
 196         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
 197         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
 198         AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
 199         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
 200         AXIS_DMI_MATCH("NC673x", "HP Compaq 673", xy_rotated_left_usd),
 201         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
 202         AXIS_DMI_MATCH("NC6710x", "HP Compaq 6710", xy_swap_yz_inverted),
 203         AXIS_DMI_MATCH("NC6715x", "HP Compaq 6715", y_inverted),
 204         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 693", xy_rotated_right),
 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  * "NC2400" "HP Compaq nc2400"
 221  * "NX74x0" "HP Compaq nx74"
 222  * "NX6325" "HP Compaq nx6325"
 223  * "NC4400" "HP Compaq nc4400"
 224  */
 225 };
 226
 227 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
 228 {
 229         struct acpi_device *dev = lis3_dev.bus_priv;
 230         unsigned long long ret; /* Not used when writing */
 231         union acpi_object in_obj[1];
 232         struct acpi_object_list args = { 1, in_obj };
 233
 234         in_obj[0].type          = ACPI_TYPE_INTEGER;
 235         in_obj[0].integer.value = !!value;
 236
 237         acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
 238 }
 239
 240 static struct delayed_led_classdev hpled_led = {
 241         .led_classdev = {
 242                 .name                   = "hp::hddprotect",
 243                 .default_trigger        = "none",
 244                 .brightness_set         = delayed_sysfs_set,
 245                 .flags                  = LED_CORE_SUSPENDRESUME,
 246         },
 247         .set_brightness = hpled_set,
 248 };
 249
 250 static acpi_status
 251 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
 252 {
 253         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
 254                 struct acpi_resource_extended_irq *irq;
 255                 u32 *device_irq = context;
 256
 257                 irq = &resource->data.extended_irq;
 258                 *device_irq = irq->interrupts[0];
 259         }
 260
 261         return AE_OK;
 262 }
 263
 264 static void lis3lv02d_enum_resources(struct acpi_device *device)
 265 {
 266         acpi_status status;
 267
 268         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 269                                         lis3lv02d_get_resource, &lis3_dev.irq);
 270         if (ACPI_FAILURE(status))
 271                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
 272 }
 273
 274 static int lis3lv02d_add(struct acpi_device *device)
 275 {
 276         int ret;
 277
 278         if (!device)
 279                 return -EINVAL;
 280
 281         lis3_dev.bus_priv = device;
 282         lis3_dev.init = lis3lv02d_acpi_init;
 283         lis3_dev.read = lis3lv02d_acpi_read;
 284         lis3_dev.write = lis3lv02d_acpi_write;
 285         strcpy(acpi_device_name(device), DRIVER_NAME);
 286         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
 287         device->driver_data = &lis3_dev;
 288
 289         /* obtain IRQ number of our device from ACPI */
 290         lis3lv02d_enum_resources(device);
 291
 292         /* If possible use a "standard" axes order */
 293         if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
 294                 printk(KERN_INFO DRIVER_NAME ": laptop model unknown, "
 295                                  "using default axes configuration\n");
 296                 lis3_dev.ac = lis3lv02d_axis_normal;
 297         }
 298
 299         /* call the core layer do its init */
 300         ret = lis3lv02d_init_device(&lis3_dev);
 301         if (ret)
 302                 return ret;
 303
 304         INIT_WORK(&hpled_led.work, delayed_set_status_worker);
 305         ret = led_classdev_register(NULL, &hpled_led.led_classdev);
 306         if (ret) {
 307                 lis3lv02d_joystick_disable();
 308                 lis3lv02d_poweroff(&lis3_dev);
 309                 flush_work(&hpled_led.work);
 310                 return ret;
 311         }
 312
 313         return ret;
 314 }
 315
 316 static int lis3lv02d_remove(struct acpi_device *device, int type)
 317 {
 318         if (!device)
 319                 return -EINVAL;
 320
 321         lis3lv02d_joystick_disable();
 322         lis3lv02d_poweroff(&lis3_dev);
 323
 324         flush_work(&hpled_led.work);
 325         led_classdev_unregister(&hpled_led.led_classdev);
 326
 327         return lis3lv02d_remove_fs(&lis3_dev);
 328 }
 329
 330
 331 #ifdef CONFIG_PM
 332 static int lis3lv02d_suspend(struct acpi_device *device, pm_message_t state)
 333 {
 334         /* make sure the device is off when we suspend */
 335         lis3lv02d_poweroff(&lis3_dev);
 336         return 0;
 337 }
 338
 339 static int lis3lv02d_resume(struct acpi_device *device)
 340 {
 341         lis3lv02d_poweron(&lis3_dev);
 342         return 0;
 343 }
 344 #else
 345 #define lis3lv02d_suspend NULL
 346 #define lis3lv02d_resume NULL
 347 #endif
 348
 349 /* For the HP MDPS aka 3D Driveguard */
 350 static struct acpi_driver lis3lv02d_driver = {
 351         .name  = DRIVER_NAME,
 352         .class = ACPI_MDPS_CLASS,
 353         .ids   = lis3lv02d_device_ids,
 354         .ops = {
 355                 .add     = lis3lv02d_add,
 356                 .remove  = lis3lv02d_remove,
 357                 .suspend = lis3lv02d_suspend,
 358                 .resume  = lis3lv02d_resume,
 359         }
 360 };
 361
 362 static int __init lis3lv02d_init_module(void)
 363 {
 364         int ret;
 365
 366         if (acpi_disabled)
 367                 return -ENODEV;
 368
 369         ret = acpi_bus_register_driver(&lis3lv02d_driver);
 370         if (ret < 0)
 371                 return ret;
 372
 373         printk(KERN_INFO DRIVER_NAME " driver loaded.\n");
 374
 375         return 0;
 376 }
 377
 378 static void __exit lis3lv02d_exit_module(void)
 379 {
 380         acpi_bus_unregister_driver(&lis3lv02d_driver);
 381 }
 382
 383 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
 384 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
 385 MODULE_LICENSE("GPL");
 386
 387 module_init(lis3lv02d_init_module);
 388 module_exit(lis3lv02d_exit_module);
 389