lis3lv02d: add axes knowledge of HP Pavilion dv5 models
[linux-2.6.git] / 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  * @handle: the handle of the device
89  *
90  * Returns AE_OK on success.
91  */
92 acpi_status lis3lv02d_acpi_init(acpi_handle handle)
93 {
94         return acpi_evaluate_object(handle, METHOD_NAME__INI, NULL, NULL);
95 }
96
97 /**
98  * lis3lv02d_acpi_read - ACPI ALRD method: read a register
99  * @handle: the handle of the device
100  * @reg:    the register to read
101  * @ret:    result of the operation
102  *
103  * Returns AE_OK on success.
104  */
105 acpi_status lis3lv02d_acpi_read(acpi_handle handle, int reg, u8 *ret)
106 {
107         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
108         struct acpi_object_list args = { 1, &arg0 };
109         unsigned long long lret;
110         acpi_status status;
111
112         arg0.integer.value = reg;
113
114         status = acpi_evaluate_integer(handle, "ALRD", &args, &lret);
115         *ret = lret;
116         return status;
117 }
118
119 /**
120  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
121  * @handle: the handle of the device
122  * @reg:    the register to write to
123  * @val:    the value to write
124  *
125  * Returns AE_OK on success.
126  */
127 acpi_status lis3lv02d_acpi_write(acpi_handle handle, int reg, u8 val)
128 {
129         unsigned long long ret; /* Not used when writting */
130         union acpi_object in_obj[2];
131         struct acpi_object_list args = { 2, in_obj };
132
133         in_obj[0].type          = ACPI_TYPE_INTEGER;
134         in_obj[0].integer.value = reg;
135         in_obj[1].type          = ACPI_TYPE_INTEGER;
136         in_obj[1].integer.value = val;
137
138         return acpi_evaluate_integer(handle, "ALWR", &args, &ret);
139 }
140
141 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
142 {
143         adev.ac = *((struct axis_conversion *)dmi->driver_data);
144         printk(KERN_INFO DRIVER_NAME ": hardware type %s found.\n", dmi->ident);
145
146         return 1;
147 }
148
149 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
150  * If the value is negative, the opposite of the hw value is used. */
151 static struct axis_conversion lis3lv02d_axis_normal = {1, 2, 3};
152 static struct axis_conversion lis3lv02d_axis_y_inverted = {1, -2, 3};
153 static struct axis_conversion lis3lv02d_axis_x_inverted = {-1, 2, 3};
154 static struct axis_conversion lis3lv02d_axis_z_inverted = {1, 2, -3};
155 static struct axis_conversion lis3lv02d_axis_xy_rotated_left = {-2, 1, 3};
156 static struct axis_conversion lis3lv02d_axis_xy_rotated_left_usd = {-2, 1, -3};
157 static struct axis_conversion lis3lv02d_axis_xy_swap_inverted = {-2, -1, 3};
158 static struct axis_conversion lis3lv02d_axis_xy_rotated_right = {2, -1, 3};
159 static struct axis_conversion lis3lv02d_axis_xy_swap_yz_inverted = {2, -1, -3};
160
161 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
162         .ident = _ident,                                \
163         .callback = lis3lv02d_dmi_matched,              \
164         .matches = {                                    \
165                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
166         },                                              \
167         .driver_data = &lis3lv02d_axis_##_axis          \
168 }
169
170 #define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
171                                 _class2, _name2,        \
172                                 _axis) {                \
173         .ident = _ident,                                \
174         .callback = lis3lv02d_dmi_matched,              \
175         .matches = {                                    \
176                 DMI_MATCH(DMI_##_class1, _name1),       \
177                 DMI_MATCH(DMI_##_class2, _name2),       \
178         },                                              \
179         .driver_data = &lis3lv02d_axis_##_axis          \
180 }
181 static struct dmi_system_id lis3lv02d_dmi_ids[] = {
182         /* product names are truncated to match all kinds of a same model */
183         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
184         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
185         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
186         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
187         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
188         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
189         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
190         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
191         AXIS_DMI_MATCH("NC673x", "HP Compaq 673", xy_rotated_left_usd),
192         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
193         AXIS_DMI_MATCH("NC671xx", "HP Compaq 671", xy_swap_yz_inverted),
194         /* Intel-based HP Pavilion dv5 */
195         AXIS_DMI_MATCH2("HPDV5_I",
196                         PRODUCT_NAME, "HP Pavilion dv5",
197                         BOARD_NAME, "3603",
198                         x_inverted),
199         /* AMD-based HP Pavilion dv5 */
200         AXIS_DMI_MATCH2("HPDV5_A",
201                         PRODUCT_NAME, "HP Pavilion dv5",
202                         BOARD_NAME, "3600",
203                         y_inverted),
204         { NULL, }
205 /* Laptop models without axis info (yet):
206  * "NC6910" "HP Compaq 6910"
207  * HP Compaq 8710x Notebook PC / Mobile Workstation
208  * "NC2400" "HP Compaq nc2400"
209  * "NX74x0" "HP Compaq nx74"
210  * "NX6325" "HP Compaq nx6325"
211  * "NC4400" "HP Compaq nc4400"
212  */
213 };
214
215 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
216 {
217         acpi_handle handle = adev.device->handle;
218         unsigned long long ret; /* Not used when writing */
219         union acpi_object in_obj[1];
220         struct acpi_object_list args = { 1, in_obj };
221
222         in_obj[0].type          = ACPI_TYPE_INTEGER;
223         in_obj[0].integer.value = !!value;
224
225         acpi_evaluate_integer(handle, "ALED", &args, &ret);
226 }
227
228 static struct delayed_led_classdev hpled_led = {
229         .led_classdev = {
230                 .name                   = "hp::hddprotect",
231                 .default_trigger        = "none",
232                 .brightness_set         = delayed_sysfs_set,
233                 .flags                  = LED_CORE_SUSPENDRESUME,
234         },
235         .set_brightness = hpled_set,
236 };
237
238 static acpi_status
239 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
240 {
241         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
242                 struct acpi_resource_extended_irq *irq;
243                 u32 *device_irq = context;
244
245                 irq = &resource->data.extended_irq;
246                 *device_irq = irq->interrupts[0];
247         }
248
249         return AE_OK;
250 }
251
252 static void lis3lv02d_enum_resources(struct acpi_device *device)
253 {
254         acpi_status status;
255
256         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
257                                         lis3lv02d_get_resource, &adev.irq);
258         if (ACPI_FAILURE(status))
259                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
260 }
261
262 static s16 lis3lv02d_read_16(acpi_handle handle, int reg)
263 {
264         u8 lo, hi;
265
266         adev.read(handle, reg - 1, &lo);
267         adev.read(handle, reg, &hi);
268         /* In "12 bit right justified" mode, bit 6, bit 7, bit 8 = bit 5 */
269         return (s16)((hi << 8) | lo);
270 }
271
272 static s16 lis3lv02d_read_8(acpi_handle handle, int reg)
273 {
274         s8 lo;
275         adev.read(handle, reg, &lo);
276         return lo;
277 }
278
279 static int lis3lv02d_add(struct acpi_device *device)
280 {
281         int ret;
282
283         if (!device)
284                 return -EINVAL;
285
286         adev.device = device;
287         adev.init = lis3lv02d_acpi_init;
288         adev.read = lis3lv02d_acpi_read;
289         adev.write = lis3lv02d_acpi_write;
290         strcpy(acpi_device_name(device), DRIVER_NAME);
291         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
292         device->driver_data = &adev;
293
294         lis3lv02d_acpi_read(device->handle, WHO_AM_I, &adev.whoami);
295         switch (adev.whoami) {
296         case LIS_DOUBLE_ID:
297                 printk(KERN_INFO DRIVER_NAME ": 2-byte sensor found\n");
298                 adev.read_data = lis3lv02d_read_16;
299                 adev.mdps_max_val = 2048;
300                 break;
301         case LIS_SINGLE_ID:
302                 printk(KERN_INFO DRIVER_NAME ": 1-byte sensor found\n");
303                 adev.read_data = lis3lv02d_read_8;
304                 adev.mdps_max_val = 128;
305                 break;
306         default:
307                 printk(KERN_ERR DRIVER_NAME
308                         ": unknown sensor type 0x%X\n", adev.whoami);
309                 return -EINVAL;
310         }
311
312         /* If possible use a "standard" axes order */
313         if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
314                 printk(KERN_INFO DRIVER_NAME ": laptop model unknown, "
315                                  "using default axes configuration\n");
316                 adev.ac = lis3lv02d_axis_normal;
317         }
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                 return ret;
323
324         /* obtain IRQ number of our device from ACPI */
325         lis3lv02d_enum_resources(adev.device);
326
327         ret = lis3lv02d_init_device(&adev);
328         if (ret) {
329                 flush_work(&hpled_led.work);
330                 led_classdev_unregister(&hpled_led.led_classdev);
331                 return ret;
332         }
333
334         return ret;
335 }
336
337 static int lis3lv02d_remove(struct acpi_device *device, int type)
338 {
339         if (!device)
340                 return -EINVAL;
341
342         lis3lv02d_joystick_disable();
343         lis3lv02d_poweroff(device->handle);
344
345         flush_work(&hpled_led.work);
346         led_classdev_unregister(&hpled_led.led_classdev);
347
348         return lis3lv02d_remove_fs();
349 }
350
351
352 #ifdef CONFIG_PM
353 static int lis3lv02d_suspend(struct acpi_device *device, pm_message_t state)
354 {
355         /* make sure the device is off when we suspend */
356         lis3lv02d_poweroff(device->handle);
357         return 0;
358 }
359
360 static int lis3lv02d_resume(struct acpi_device *device)
361 {
362         /* put back the device in the right state (ACPI might turn it on) */
363         mutex_lock(&adev.lock);
364         if (adev.usage > 0)
365                 lis3lv02d_poweron(device->handle);
366         else
367                 lis3lv02d_poweroff(device->handle);
368         mutex_unlock(&adev.lock);
369         return 0;
370 }
371 #else
372 #define lis3lv02d_suspend NULL
373 #define lis3lv02d_resume NULL
374 #endif
375
376 /* For the HP MDPS aka 3D Driveguard */
377 static struct acpi_driver lis3lv02d_driver = {
378         .name  = DRIVER_NAME,
379         .class = ACPI_MDPS_CLASS,
380         .ids   = lis3lv02d_device_ids,
381         .ops = {
382                 .add     = lis3lv02d_add,
383                 .remove  = lis3lv02d_remove,
384                 .suspend = lis3lv02d_suspend,
385                 .resume  = lis3lv02d_resume,
386         }
387 };
388
389 static int __init lis3lv02d_init_module(void)
390 {
391         int ret;
392
393         if (acpi_disabled)
394                 return -ENODEV;
395
396         ret = acpi_bus_register_driver(&lis3lv02d_driver);
397         if (ret < 0)
398                 return ret;
399
400         printk(KERN_INFO DRIVER_NAME " driver loaded.\n");
401
402         return 0;
403 }
404
405 static void __exit lis3lv02d_exit_module(void)
406 {
407         acpi_bus_unregister_driver(&lis3lv02d_driver);
408 }
409
410 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
411 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
412 MODULE_LICENSE("GPL");
413
414 module_init(lis3lv02d_init_module);
415 module_exit(lis3lv02d_exit_module);
416