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