GNU Linux-libre 4.9.328-gnu1
[releases.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 <linux/acpi.h>
40 #include <linux/i8042.h>
41 #include <linux/serio.h>
42 #include "../../misc/lis3lv02d/lis3lv02d.h"
43
44 #define DRIVER_NAME     "hp_accel"
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 /* e0 25, e0 26, e0 27, e0 28 are scan codes that the accelerometer with acpi id
79  * HPQ6000 sends through the keyboard bus */
80 #define ACCEL_1 0x25
81 #define ACCEL_2 0x26
82 #define ACCEL_3 0x27
83 #define ACCEL_4 0x28
84
85 /* For automatic insertion of the module */
86 static const struct acpi_device_id lis3lv02d_device_ids[] = {
87         {"HPQ0004", 0}, /* HP Mobile Data Protection System PNP */
88         {"HPQ6000", 0}, /* HP Mobile Data Protection System PNP */
89         {"HPQ6007", 0}, /* HP Mobile Data Protection System PNP */
90         {"", 0},
91 };
92 MODULE_DEVICE_TABLE(acpi, lis3lv02d_device_ids);
93
94
95 /**
96  * lis3lv02d_acpi_init - ACPI _INI method: initialize the device.
97  * @lis3: pointer to the device struct
98  *
99  * Returns 0 on success.
100  */
101 static int lis3lv02d_acpi_init(struct lis3lv02d *lis3)
102 {
103         struct acpi_device *dev = lis3->bus_priv;
104         if (!lis3->init_required)
105                 return 0;
106
107         if (acpi_evaluate_object(dev->handle, METHOD_NAME__INI,
108                                  NULL, NULL) != AE_OK)
109                 return -EINVAL;
110
111         return 0;
112 }
113
114 /**
115  * lis3lv02d_acpi_read - ACPI ALRD method: read a register
116  * @lis3: pointer to the device struct
117  * @reg:    the register to read
118  * @ret:    result of the operation
119  *
120  * Returns 0 on success.
121  */
122 static int lis3lv02d_acpi_read(struct lis3lv02d *lis3, int reg, u8 *ret)
123 {
124         struct acpi_device *dev = lis3->bus_priv;
125         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
126         struct acpi_object_list args = { 1, &arg0 };
127         unsigned long long lret;
128         acpi_status status;
129
130         arg0.integer.value = reg;
131
132         status = acpi_evaluate_integer(dev->handle, "ALRD", &args, &lret);
133         if (ACPI_FAILURE(status))
134                 return -EINVAL;
135         *ret = lret;
136         return 0;
137 }
138
139 /**
140  * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
141  * @lis3: pointer to the device struct
142  * @reg:    the register to write to
143  * @val:    the value to write
144  *
145  * Returns 0 on success.
146  */
147 static int lis3lv02d_acpi_write(struct lis3lv02d *lis3, int reg, u8 val)
148 {
149         struct acpi_device *dev = lis3->bus_priv;
150         unsigned long long ret; /* Not used when writting */
151         union acpi_object in_obj[2];
152         struct acpi_object_list args = { 2, in_obj };
153
154         in_obj[0].type          = ACPI_TYPE_INTEGER;
155         in_obj[0].integer.value = reg;
156         in_obj[1].type          = ACPI_TYPE_INTEGER;
157         in_obj[1].integer.value = val;
158
159         if (acpi_evaluate_integer(dev->handle, "ALWR", &args, &ret) != AE_OK)
160                 return -EINVAL;
161
162         return 0;
163 }
164
165 static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
166 {
167         lis3_dev.ac = *((union axis_conversion *)dmi->driver_data);
168         pr_info("hardware type %s found\n", dmi->ident);
169
170         return 1;
171 }
172
173 /* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
174  * If the value is negative, the opposite of the hw value is used. */
175 #define DEFINE_CONV(name, x, y, z)                            \
176         static union axis_conversion lis3lv02d_axis_##name = \
177                 { .as_array = { x, y, z } }
178 DEFINE_CONV(normal, 1, 2, 3);
179 DEFINE_CONV(y_inverted, 1, -2, 3);
180 DEFINE_CONV(x_inverted, -1, 2, 3);
181 DEFINE_CONV(x_inverted_usd, -1, 2, -3);
182 DEFINE_CONV(z_inverted, 1, 2, -3);
183 DEFINE_CONV(xy_swap, 2, 1, 3);
184 DEFINE_CONV(xy_rotated_left, -2, 1, 3);
185 DEFINE_CONV(xy_rotated_left_usd, -2, 1, -3);
186 DEFINE_CONV(xy_swap_inverted, -2, -1, 3);
187 DEFINE_CONV(xy_rotated_right, 2, -1, 3);
188 DEFINE_CONV(xy_swap_yz_inverted, 2, -1, -3);
189
190 #define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
191         .ident = _ident,                                \
192         .callback = lis3lv02d_dmi_matched,              \
193         .matches = {                                    \
194                 DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
195         },                                              \
196         .driver_data = &lis3lv02d_axis_##_axis          \
197 }
198
199 #define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
200                                 _class2, _name2,        \
201                                 _axis) {                \
202         .ident = _ident,                                \
203         .callback = lis3lv02d_dmi_matched,              \
204         .matches = {                                    \
205                 DMI_MATCH(DMI_##_class1, _name1),       \
206                 DMI_MATCH(DMI_##_class2, _name2),       \
207         },                                              \
208         .driver_data = &lis3lv02d_axis_##_axis          \
209 }
210 static const struct dmi_system_id lis3lv02d_dmi_ids[] = {
211         /* product names are truncated to match all kinds of a same model */
212         AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
213         AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
214         AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
215         AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
216         AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
217         AXIS_DMI_MATCH("NC2710", "HP Compaq 2710", xy_swap),
218         AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
219         AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
220         AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
221         AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
222         AXIS_DMI_MATCH("NC6730b", "HP Compaq 6730b", xy_rotated_left_usd),
223         AXIS_DMI_MATCH("NC6730s", "HP Compaq 6730s", xy_swap),
224         AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
225         AXIS_DMI_MATCH("NC6710x", "HP Compaq 6710", xy_swap_yz_inverted),
226         AXIS_DMI_MATCH("NC6715x", "HP Compaq 6715", y_inverted),
227         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 693", xy_rotated_right),
228         AXIS_DMI_MATCH("NC693xx", "HP EliteBook 853", xy_swap),
229         AXIS_DMI_MATCH("NC854xx", "HP EliteBook 854", y_inverted),
230         AXIS_DMI_MATCH("NC273xx", "HP EliteBook 273", y_inverted),
231         /* Intel-based HP Pavilion dv5 */
232         AXIS_DMI_MATCH2("HPDV5_I",
233                         PRODUCT_NAME, "HP Pavilion dv5",
234                         BOARD_NAME, "3603",
235                         x_inverted),
236         /* AMD-based HP Pavilion dv5 */
237         AXIS_DMI_MATCH2("HPDV5_A",
238                         PRODUCT_NAME, "HP Pavilion dv5",
239                         BOARD_NAME, "3600",
240                         y_inverted),
241         AXIS_DMI_MATCH("DV7", "HP Pavilion dv7", x_inverted),
242         AXIS_DMI_MATCH("HP8710", "HP Compaq 8710", y_inverted),
243         AXIS_DMI_MATCH("HDX18", "HP HDX 18", x_inverted),
244         AXIS_DMI_MATCH("HPB432x", "HP ProBook 432", xy_rotated_left),
245         AXIS_DMI_MATCH("HPB440G3", "HP ProBook 440 G3", x_inverted_usd),
246         AXIS_DMI_MATCH("HPB440G4", "HP ProBook 440 G4", x_inverted),
247         AXIS_DMI_MATCH("HPB442x", "HP ProBook 442", xy_rotated_left),
248         AXIS_DMI_MATCH("HPB452x", "HP ProBook 452", y_inverted),
249         AXIS_DMI_MATCH("HPB522x", "HP ProBook 522", xy_swap),
250         AXIS_DMI_MATCH("HPB532x", "HP ProBook 532", y_inverted),
251         AXIS_DMI_MATCH("HPB655x", "HP ProBook 655", xy_swap_inverted),
252         AXIS_DMI_MATCH("Mini510x", "HP Mini 510", xy_rotated_left_usd),
253         AXIS_DMI_MATCH("HPB63xx", "HP ProBook 63", xy_swap),
254         AXIS_DMI_MATCH("HPB64xx", "HP ProBook 64", xy_swap),
255         AXIS_DMI_MATCH("HPB64xx", "HP EliteBook 84", xy_swap),
256         AXIS_DMI_MATCH("HPB65xx", "HP ProBook 65", x_inverted),
257         AXIS_DMI_MATCH("HPZBook15", "HP ZBook 15", x_inverted),
258         { NULL, }
259 /* Laptop models without axis info (yet):
260  * "NC6910" "HP Compaq 6910"
261  * "NC2400" "HP Compaq nc2400"
262  * "NX74x0" "HP Compaq nx74"
263  * "NX6325" "HP Compaq nx6325"
264  * "NC4400" "HP Compaq nc4400"
265  */
266 };
267
268 static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
269 {
270         struct acpi_device *dev = lis3_dev.bus_priv;
271         unsigned long long ret; /* Not used when writing */
272         union acpi_object in_obj[1];
273         struct acpi_object_list args = { 1, in_obj };
274
275         in_obj[0].type          = ACPI_TYPE_INTEGER;
276         in_obj[0].integer.value = !!value;
277
278         acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
279 }
280
281 static struct delayed_led_classdev hpled_led = {
282         .led_classdev = {
283                 .name                   = "hp::hddprotect",
284                 .default_trigger        = "none",
285                 .brightness_set         = delayed_sysfs_set,
286                 .flags                  = LED_CORE_SUSPENDRESUME,
287         },
288         .set_brightness = hpled_set,
289 };
290
291 static acpi_status
292 lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
293 {
294         if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
295                 struct acpi_resource_extended_irq *irq;
296                 u32 *device_irq = context;
297
298                 irq = &resource->data.extended_irq;
299                 *device_irq = irq->interrupts[0];
300         }
301
302         return AE_OK;
303 }
304
305 static void lis3lv02d_enum_resources(struct acpi_device *device)
306 {
307         acpi_status status;
308
309         status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
310                                         lis3lv02d_get_resource, &lis3_dev.irq);
311         if (ACPI_FAILURE(status))
312                 printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
313 }
314
315 static bool hp_accel_i8042_filter(unsigned char data, unsigned char str,
316                                   struct serio *port)
317 {
318         static bool extended;
319
320         if (str & I8042_STR_AUXDATA)
321                 return false;
322
323         if (data == 0xe0) {
324                 extended = true;
325                 return true;
326         } else if (unlikely(extended)) {
327                 extended = false;
328
329                 switch (data) {
330                 case ACCEL_1:
331                 case ACCEL_2:
332                 case ACCEL_3:
333                 case ACCEL_4:
334                         return true;
335                 default:
336                         serio_interrupt(port, 0xe0, 0);
337                         return false;
338                 }
339         }
340
341         return false;
342 }
343
344 static int lis3lv02d_add(struct acpi_device *device)
345 {
346         int ret;
347
348         if (!device)
349                 return -EINVAL;
350
351         lis3_dev.bus_priv = device;
352         lis3_dev.init = lis3lv02d_acpi_init;
353         lis3_dev.read = lis3lv02d_acpi_read;
354         lis3_dev.write = lis3lv02d_acpi_write;
355         strcpy(acpi_device_name(device), DRIVER_NAME);
356         strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
357         device->driver_data = &lis3_dev;
358
359         /* obtain IRQ number of our device from ACPI */
360         lis3lv02d_enum_resources(device);
361
362         /* If possible use a "standard" axes order */
363         if (lis3_dev.ac.x && lis3_dev.ac.y && lis3_dev.ac.z) {
364                 pr_info("Using custom axes %d,%d,%d\n",
365                         lis3_dev.ac.x, lis3_dev.ac.y, lis3_dev.ac.z);
366         } else if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
367                 pr_info("laptop model unknown, using default axes configuration\n");
368                 lis3_dev.ac = lis3lv02d_axis_normal;
369         }
370
371         /* call the core layer do its init */
372         lis3_dev.init_required = true;
373         ret = lis3lv02d_init_device(&lis3_dev);
374         if (ret)
375                 return ret;
376
377         /* filter to remove HPQ6000 accelerometer data
378          * from keyboard bus stream */
379         if (strstr(dev_name(&device->dev), "HPQ6000"))
380                 i8042_install_filter(hp_accel_i8042_filter);
381
382         INIT_WORK(&hpled_led.work, delayed_set_status_worker);
383         ret = led_classdev_register(NULL, &hpled_led.led_classdev);
384         if (ret) {
385                 i8042_remove_filter(hp_accel_i8042_filter);
386                 lis3lv02d_joystick_disable(&lis3_dev);
387                 lis3lv02d_poweroff(&lis3_dev);
388                 flush_work(&hpled_led.work);
389                 lis3lv02d_remove_fs(&lis3_dev);
390                 return ret;
391         }
392
393         return ret;
394 }
395
396 static int lis3lv02d_remove(struct acpi_device *device)
397 {
398         if (!device)
399                 return -EINVAL;
400
401         i8042_remove_filter(hp_accel_i8042_filter);
402         lis3lv02d_joystick_disable(&lis3_dev);
403         lis3lv02d_poweroff(&lis3_dev);
404
405         led_classdev_unregister(&hpled_led.led_classdev);
406         flush_work(&hpled_led.work);
407
408         return lis3lv02d_remove_fs(&lis3_dev);
409 }
410
411
412 #ifdef CONFIG_PM_SLEEP
413 static int lis3lv02d_suspend(struct device *dev)
414 {
415         /* make sure the device is off when we suspend */
416         lis3lv02d_poweroff(&lis3_dev);
417         return 0;
418 }
419
420 static int lis3lv02d_resume(struct device *dev)
421 {
422         lis3_dev.init_required = false;
423         lis3lv02d_poweron(&lis3_dev);
424         return 0;
425 }
426
427 static int lis3lv02d_restore(struct device *dev)
428 {
429         lis3_dev.init_required = true;
430         lis3lv02d_poweron(&lis3_dev);
431         return 0;
432 }
433
434 static const struct dev_pm_ops hp_accel_pm = {
435         .suspend = lis3lv02d_suspend,
436         .resume = lis3lv02d_resume,
437         .freeze = lis3lv02d_suspend,
438         .thaw = lis3lv02d_resume,
439         .poweroff = lis3lv02d_suspend,
440         .restore = lis3lv02d_restore,
441 };
442
443 #define HP_ACCEL_PM (&hp_accel_pm)
444 #else
445 #define HP_ACCEL_PM NULL
446 #endif
447
448 /* For the HP MDPS aka 3D Driveguard */
449 static struct acpi_driver lis3lv02d_driver = {
450         .name  = DRIVER_NAME,
451         .class = ACPI_MDPS_CLASS,
452         .ids   = lis3lv02d_device_ids,
453         .ops = {
454                 .add     = lis3lv02d_add,
455                 .remove  = lis3lv02d_remove,
456         },
457         .drv.pm = HP_ACCEL_PM,
458 };
459 module_acpi_driver(lis3lv02d_driver);
460
461 MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
462 MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
463 MODULE_LICENSE("GPL");