Merge commit 'v2.6.28-rc7'; branch 'x86/dumpstack' into tracing/ftrace
[linux-2.6] / drivers / hwmon / lis3lv02d.c
1 /*
2  *  lis3lv02d.c - ST LIS3LV02DL accelerometer driver
3  *
4  *  Copyright (C) 2007-2008 Yan Burman
5  *  Copyright (C) 2008 Eric Piel
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/dmi.h>
25 #include <linux/module.h>
26 #include <linux/types.h>
27 #include <linux/platform_device.h>
28 #include <linux/interrupt.h>
29 #include <linux/input.h>
30 #include <linux/kthread.h>
31 #include <linux/semaphore.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 <acpi/acpi_drivers.h>
38 #include <asm/atomic.h>
39 #include "lis3lv02d.h"
40
41 #define DRIVER_NAME     "lis3lv02d"
42 #define ACPI_MDPS_CLASS "accelerometer"
43
44 /* joystick device poll interval in milliseconds */
45 #define MDPS_POLL_INTERVAL 50
46 /*
47  * The sensor can also generate interrupts (DRDY) but it's pretty pointless
48  * because their are generated even if the data do not change. So it's better
49  * to keep the interrupt for the free-fall event. The values are updated at
50  * 40Hz (at the lowest frequency), but as it can be pretty time consuming on
51  * some low processor, we poll the sensor only at 20Hz... enough for the
52  * joystick.
53  */
54
55 /* Maximum value our axis may get for the input device (signed 12 bits) */
56 #define MDPS_MAX_VAL 2048
57
58 struct axis_conversion {
59         s8      x;
60         s8      y;
61         s8      z;
62 };
63
64 struct acpi_lis3lv02d {
65         struct acpi_device      *device;   /* The ACPI device */
66         struct input_dev        *idev;     /* input device */
67         struct task_struct      *kthread;  /* kthread for input */
68         struct mutex            lock;
69         struct platform_device  *pdev;     /* platform device */
70         atomic_t                count;     /* interrupt count after last read */
71         int                     xcalib;    /* calibrated null value for x */
72         int                     ycalib;    /* calibrated null value for y */
73         int                     zcalib;    /* calibrated null value for z */
74         unsigned char           is_on;     /* whether the device is on or off */
75         unsigned char           usage;     /* usage counter */
76         struct axis_conversion  ac;        /* hw -> logical axis */
77 };
78
79 static struct acpi_lis3lv02d adev;
80
81 static int lis3lv02d_remove_fs(void);
82 static int lis3lv02d_add_fs(struct acpi_device *device);
83
84 /* For automatic insertion of the module */
85 static struct acpi_device_id lis3lv02d_device_ids[] = {
86         {"HPQ0004", 0}, /* HP Mobile Data Protection System PNP */
87         {"", 0},
88 };
89 MODULE_DEVICE_TABLE(acpi, lis3lv02d_device_ids);
90
91 /**
92  * lis3lv02d_acpi_init - ACPI _INI method: initialize the device.
93  * @handle: the handle of the device
94  *
95  * Returns AE_OK on success.
96  */
97 static inline acpi_status lis3lv02d_acpi_init(acpi_handle handle)
98 {
99         return acpi_evaluate_object(handle, METHOD_NAME__INI, NULL, NULL);
100 }
101
102 /**
103  * lis3lv02d_acpi_read - ACPI ALRD method: read a register
104  * @handle: the handle of the device
105  * @reg:    the register to read
106  * @ret:    result of the operation
107  *
108  * Returns AE_OK on success.
109  */
110 static acpi_status lis3lv02d_acpi_read(acpi_handle handle, int reg, u8 *ret)
111 {
112         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
113         struct acpi_object_list args = { 1, &arg0 };
114         unsigned long long lret;
115         acpi_status status;
116
117         arg0.integer.value = reg;
118
119         status = acpi_evaluate_integer(handle, "ALRD", &args, &lret);
120         *ret = lret;
121         return status;
122 }
123
124 /**
125  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
126  * @handle: the handle of the device
127  * @reg:    the register to write to
128  * @val:    the value to write
129  *
130  * Returns AE_OK on success.
131  */
132 static acpi_status lis3lv02d_acpi_write(acpi_handle handle, int reg, u8 val)
133 {
134         unsigned long long ret; /* Not used when writting */
135         union acpi_object in_obj[2];
136         struct acpi_object_list args = { 2, in_obj };
137
138         in_obj[0].type          = ACPI_TYPE_INTEGER;
139         in_obj[0].integer.value = reg;
140         in_obj[1].type          = ACPI_TYPE_INTEGER;
141         in_obj[1].integer.value = val;
142
143         return acpi_evaluate_integer(handle, "ALWR", &args, &ret);
144 }
145
146 static s16 lis3lv02d_read_16(acpi_handle handle, int reg)
147 {
148         u8 lo, hi;
149
150         lis3lv02d_acpi_read(handle, reg, &lo);
151         lis3lv02d_acpi_read(handle, reg + 1, &hi);
152         /* In "12 bit right justified" mode, bit 6, bit 7, bit 8 = bit 5 */
153         return (s16)((hi << 8) | lo);
154 }
155
156 /**
157  * lis3lv02d_get_axis - For the given axis, give the value converted
158  * @axis:      1,2,3 - can also be negative
159  * @hw_values: raw values returned by the hardware
160  *
161  * Returns the converted value.
162  */
163 static inline int lis3lv02d_get_axis(s8 axis, int hw_values[3])
164 {
165         if (axis > 0)
166                 return hw_values[axis - 1];
167         else
168                 return -hw_values[-axis - 1];
169 }
170
171 /**
172  * lis3lv02d_get_xyz - Get X, Y and Z axis values from the accelerometer
173  * @handle: the handle to the device
174  * @x:      where to store the X axis value
175  * @y:      where to store the Y axis value
176  * @z:      where to store the Z axis value
177  *
178  * Note that 40Hz input device can eat up about 10% CPU at 800MHZ
179  */
180 static void lis3lv02d_get_xyz(acpi_handle handle, int *x, int *y, int *z)
181 {
182         int position[3];
183
184         position[0] = lis3lv02d_read_16(handle, OUTX_L);
185         position[1] = lis3lv02d_read_16(handle, OUTY_L);
186         position[2] = lis3lv02d_read_16(handle, OUTZ_L);
187
188         *x = lis3lv02d_get_axis(adev.ac.x, position);
189         *y = lis3lv02d_get_axis(adev.ac.y, position);
190         *z = lis3lv02d_get_axis(adev.ac.z, position);
191 }
192
193 static inline void lis3lv02d_poweroff(acpi_handle handle)
194 {
195         adev.is_on = 0;
196         /* disable X,Y,Z axis and power down */
197         lis3lv02d_acpi_write(handle, CTRL_REG1, 0x00);
198 }
199
200 static void lis3lv02d_poweron(acpi_handle handle)
201 {
202         u8 val;
203
204         adev.is_on = 1;
205         lis3lv02d_acpi_init(handle);
206         lis3lv02d_acpi_write(handle, FF_WU_CFG, 0);
207         /*
208          * BDU: LSB and MSB values are not updated until both have been read.
209          *      So the value read will always be correct.
210          * IEN: Interrupt for free-fall and DD, not for data-ready.
211          */
212         lis3lv02d_acpi_read(handle, CTRL_REG2, &val);
213         val |= CTRL2_BDU | CTRL2_IEN;
214         lis3lv02d_acpi_write(handle, CTRL_REG2, val);
215 }
216
217 #ifdef CONFIG_PM
218 static int lis3lv02d_suspend(struct acpi_device *device, pm_message_t state)
219 {
220         /* make sure the device is off when we suspend */
221         lis3lv02d_poweroff(device->handle);
222         return 0;
223 }
224
225 static int lis3lv02d_resume(struct acpi_device *device)
226 {
227         /* put back the device in the right state (ACPI might turn it on) */
228         mutex_lock(&adev.lock);
229         if (adev.usage > 0)
230                 lis3lv02d_poweron(device->handle);
231         else
232                 lis3lv02d_poweroff(device->handle);
233         mutex_unlock(&adev.lock);
234         return 0;
235 }
236 #else
237 #define lis3lv02d_suspend NULL
238 #define lis3lv02d_resume NULL
239 #endif
240
241
242 /*
243  * To be called before starting to use the device. It makes sure that the
244  * device will always be on until a call to lis3lv02d_decrease_use(). Not to be
245  * used from interrupt context.
246  */
247 static void lis3lv02d_increase_use(struct acpi_lis3lv02d *dev)
248 {
249         mutex_lock(&dev->lock);
250         dev->usage++;
251         if (dev->usage == 1) {
252                 if (!dev->is_on)
253                         lis3lv02d_poweron(dev->device->handle);
254         }
255         mutex_unlock(&dev->lock);
256 }
257
258 /*
259  * To be called whenever a usage of the device is stopped.
260  * It will make sure to turn off the device when there is not usage.
261  */
262 static void lis3lv02d_decrease_use(struct acpi_lis3lv02d *dev)
263 {
264         mutex_lock(&dev->lock);
265         dev->usage--;
266         if (dev->usage == 0)
267                 lis3lv02d_poweroff(dev->device->handle);
268         mutex_unlock(&dev->lock);
269 }
270
271 /**
272  * lis3lv02d_joystick_kthread - Kthread polling function
273  * @data: unused - here to conform to threadfn prototype
274  */
275 static int lis3lv02d_joystick_kthread(void *data)
276 {
277         int x, y, z;
278
279         while (!kthread_should_stop()) {
280                 lis3lv02d_get_xyz(adev.device->handle, &x, &y, &z);
281                 input_report_abs(adev.idev, ABS_X, x - adev.xcalib);
282                 input_report_abs(adev.idev, ABS_Y, y - adev.ycalib);
283                 input_report_abs(adev.idev, ABS_Z, z - adev.zcalib);
284
285                 input_sync(adev.idev);
286
287                 try_to_freeze();
288                 msleep_interruptible(MDPS_POLL_INTERVAL);
289         }
290
291         return 0;
292 }
293
294 static int lis3lv02d_joystick_open(struct input_dev *input)
295 {
296         lis3lv02d_increase_use(&adev);
297         adev.kthread = kthread_run(lis3lv02d_joystick_kthread, NULL, "klis3lv02d");
298         if (IS_ERR(adev.kthread)) {
299                 lis3lv02d_decrease_use(&adev);
300                 return PTR_ERR(adev.kthread);
301         }
302
303         return 0;
304 }
305
306 static void lis3lv02d_joystick_close(struct input_dev *input)
307 {
308         kthread_stop(adev.kthread);
309         lis3lv02d_decrease_use(&adev);
310 }
311
312
313 static inline void lis3lv02d_calibrate_joystick(void)
314 {
315         lis3lv02d_get_xyz(adev.device->handle, &adev.xcalib, &adev.ycalib, &adev.zcalib);
316 }
317
318 static int lis3lv02d_joystick_enable(void)
319 {
320         int err;
321
322         if (adev.idev)
323                 return -EINVAL;
324
325         adev.idev = input_allocate_device();
326         if (!adev.idev)
327                 return -ENOMEM;
328
329         lis3lv02d_calibrate_joystick();
330
331         adev.idev->name       = "ST LIS3LV02DL Accelerometer";
332         adev.idev->phys       = DRIVER_NAME "/input0";
333         adev.idev->id.bustype = BUS_HOST;
334         adev.idev->id.vendor  = 0;
335         adev.idev->dev.parent = &adev.pdev->dev;
336         adev.idev->open       = lis3lv02d_joystick_open;
337         adev.idev->close      = lis3lv02d_joystick_close;
338
339         set_bit(EV_ABS, adev.idev->evbit);
340         input_set_abs_params(adev.idev, ABS_X, -MDPS_MAX_VAL, MDPS_MAX_VAL, 3, 3);
341         input_set_abs_params(adev.idev, ABS_Y, -MDPS_MAX_VAL, MDPS_MAX_VAL, 3, 3);
342         input_set_abs_params(adev.idev, ABS_Z, -MDPS_MAX_VAL, MDPS_MAX_VAL, 3, 3);
343
344         err = input_register_device(adev.idev);
345         if (err) {
346                 input_free_device(adev.idev);
347                 adev.idev = NULL;
348         }
349
350         return err;
351 }
352
353 static void lis3lv02d_joystick_disable(void)
354 {
355         if (!adev.idev)
356                 return;
357
358         input_unregister_device(adev.idev);
359         adev.idev = NULL;
360 }
361
362
363 /*
364  * Initialise the accelerometer and the various subsystems.
365  * Should be rather independant of the bus system.
366  */
367 static int lis3lv02d_init_device(struct acpi_lis3lv02d *dev)
368 {
369         mutex_init(&dev->lock);
370         lis3lv02d_add_fs(dev->device);
371         lis3lv02d_increase_use(dev);
372
373         if (lis3lv02d_joystick_enable())
374                 printk(KERN_ERR DRIVER_NAME ": joystick initialization failed\n");
375
376         lis3lv02d_decrease_use(dev);
377         return 0;
378 }
379
380 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
381 {
382         adev.ac = *((struct axis_conversion *)dmi->driver_data);
383         printk(KERN_INFO DRIVER_NAME ": hardware type %s found.\n", dmi->ident);
384
385         return 1;
386 }
387
388 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
389  * If the value is negative, the opposite of the hw value is used. */
390 static struct axis_conversion lis3lv02d_axis_normal = {1, 2, 3};
391 static struct axis_conversion lis3lv02d_axis_y_inverted = {1, -2, 3};
392 static struct axis_conversion lis3lv02d_axis_x_inverted = {-1, 2, 3};
393 static struct axis_conversion lis3lv02d_axis_z_inverted = {1, 2, -3};
394 static struct axis_conversion lis3lv02d_axis_xy_rotated_left = {-2, 1, 3};
395 static struct axis_conversion lis3lv02d_axis_xy_swap_inverted = {-2, -1, 3};
396
397 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
398         .ident = _ident,                                \
399         .callback = lis3lv02d_dmi_matched,              \
400         .matches = {                                    \
401                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
402         },                                              \
403         .driver_data = &lis3lv02d_axis_##_axis          \
404 }
405 static struct dmi_system_id lis3lv02d_dmi_ids[] = {
406         /* product names are truncated to match all kinds of a same model */
407         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
408         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
409         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
410         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
411         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
412         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
413         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
414         { NULL, }
415 /* Laptop models without axis info (yet):
416  * "NC651xx" "HP Compaq 651"
417  * "NC671xx" "HP Compaq 671"
418  * "NC6910" "HP Compaq 6910"
419  * HP Compaq 8710x Notebook PC / Mobile Workstation
420  * "NC2400" "HP Compaq nc2400"
421  * "NX74x0" "HP Compaq nx74"
422  * "NX6325" "HP Compaq nx6325"
423  * "NC4400" "HP Compaq nc4400"
424  */
425 };
426
427 static int lis3lv02d_add(struct acpi_device *device)
428 {
429         u8 val;
430
431         if (!device)
432                 return -EINVAL;
433
434         adev.device = device;
435         strcpy(acpi_device_name(device), DRIVER_NAME);
436         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
437         device->driver_data = &adev;
438
439         lis3lv02d_acpi_read(device->handle, WHO_AM_I, &val);
440         if ((val != LIS3LV02DL_ID) && (val != LIS302DL_ID)) {
441                 printk(KERN_ERR DRIVER_NAME
442                                 ": Accelerometer chip not LIS3LV02D{L,Q}\n");
443         }
444
445         /* If possible use a "standard" axes order */
446         if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
447                 printk(KERN_INFO DRIVER_NAME ": laptop model unknown, "
448                                  "using default axes configuration\n");
449                 adev.ac = lis3lv02d_axis_normal;
450         }
451
452         return lis3lv02d_init_device(&adev);
453 }
454
455 static int lis3lv02d_remove(struct acpi_device *device, int type)
456 {
457         if (!device)
458                 return -EINVAL;
459
460         lis3lv02d_joystick_disable();
461         lis3lv02d_poweroff(device->handle);
462
463         return lis3lv02d_remove_fs();
464 }
465
466
467 /* Sysfs stuff */
468 static ssize_t lis3lv02d_position_show(struct device *dev,
469                                 struct device_attribute *attr, char *buf)
470 {
471         int x, y, z;
472
473         lis3lv02d_increase_use(&adev);
474         lis3lv02d_get_xyz(adev.device->handle, &x, &y, &z);
475         lis3lv02d_decrease_use(&adev);
476         return sprintf(buf, "(%d,%d,%d)\n", x, y, z);
477 }
478
479 static ssize_t lis3lv02d_calibrate_show(struct device *dev,
480                                 struct device_attribute *attr, char *buf)
481 {
482         return sprintf(buf, "(%d,%d,%d)\n", adev.xcalib, adev.ycalib, adev.zcalib);
483 }
484
485 static ssize_t lis3lv02d_calibrate_store(struct device *dev,
486                                 struct device_attribute *attr,
487                                 const char *buf, size_t count)
488 {
489         lis3lv02d_increase_use(&adev);
490         lis3lv02d_calibrate_joystick();
491         lis3lv02d_decrease_use(&adev);
492         return count;
493 }
494
495 /* conversion btw sampling rate and the register values */
496 static int lis3lv02dl_df_val[4] = {40, 160, 640, 2560};
497 static ssize_t lis3lv02d_rate_show(struct device *dev,
498                         struct device_attribute *attr, char *buf)
499 {
500         u8 ctrl;
501         int val;
502
503         lis3lv02d_increase_use(&adev);
504         lis3lv02d_acpi_read(adev.device->handle, CTRL_REG1, &ctrl);
505         lis3lv02d_decrease_use(&adev);
506         val = (ctrl & (CTRL1_DF0 | CTRL1_DF1)) >> 4;
507         return sprintf(buf, "%d\n", lis3lv02dl_df_val[val]);
508 }
509
510 static DEVICE_ATTR(position, S_IRUGO, lis3lv02d_position_show, NULL);
511 static DEVICE_ATTR(calibrate, S_IRUGO|S_IWUSR, lis3lv02d_calibrate_show,
512         lis3lv02d_calibrate_store);
513 static DEVICE_ATTR(rate, S_IRUGO, lis3lv02d_rate_show, NULL);
514
515 static struct attribute *lis3lv02d_attributes[] = {
516         &dev_attr_position.attr,
517         &dev_attr_calibrate.attr,
518         &dev_attr_rate.attr,
519         NULL
520 };
521
522 static struct attribute_group lis3lv02d_attribute_group = {
523         .attrs = lis3lv02d_attributes
524 };
525
526 static int lis3lv02d_add_fs(struct acpi_device *device)
527 {
528         adev.pdev = platform_device_register_simple(DRIVER_NAME, -1, NULL, 0);
529         if (IS_ERR(adev.pdev))
530                 return PTR_ERR(adev.pdev);
531
532         return sysfs_create_group(&adev.pdev->dev.kobj, &lis3lv02d_attribute_group);
533 }
534
535 static int lis3lv02d_remove_fs(void)
536 {
537         sysfs_remove_group(&adev.pdev->dev.kobj, &lis3lv02d_attribute_group);
538         platform_device_unregister(adev.pdev);
539         return 0;
540 }
541
542 /* For the HP MDPS aka 3D Driveguard */
543 static struct acpi_driver lis3lv02d_driver = {
544         .name  = DRIVER_NAME,
545         .class = ACPI_MDPS_CLASS,
546         .ids   = lis3lv02d_device_ids,
547         .ops = {
548                 .add     = lis3lv02d_add,
549                 .remove  = lis3lv02d_remove,
550                 .suspend = lis3lv02d_suspend,
551                 .resume  = lis3lv02d_resume,
552         }
553 };
554
555 static int __init lis3lv02d_init_module(void)
556 {
557         int ret;
558
559         if (acpi_disabled)
560                 return -ENODEV;
561
562         ret = acpi_bus_register_driver(&lis3lv02d_driver);
563         if (ret < 0)
564                 return ret;
565
566         printk(KERN_INFO DRIVER_NAME " driver loaded.\n");
567
568         return 0;
569 }
570
571 static void __exit lis3lv02d_exit_module(void)
572 {
573         acpi_bus_unregister_driver(&lis3lv02d_driver);
574 }
575
576 MODULE_DESCRIPTION("ST LIS3LV02Dx three-axis digital accelerometer driver");
577 MODULE_AUTHOR("Yan Burman and Eric Piel");
578 MODULE_LICENSE("GPL");
579
580 module_init(lis3lv02d_init_module);
581 module_exit(lis3lv02d_exit_module);