tty/serial: atmel: enforce tasklet init and termination sequences
[cascardo/linux.git] / drivers / input / touchscreen / wacom_w8001.c
1 /*
2  * Wacom W8001 penabled serial touchscreen driver
3  *
4  * Copyright (c) 2008 Jaya Kumar
5  * Copyright (c) 2010 Red Hat, Inc.
6  * Copyright (c) 2010 - 2011 Ping Cheng, Wacom. <pingc@wacom.com>
7  *
8  * This file is subject to the terms and conditions of the GNU General Public
9  * License. See the file COPYING in the main directory of this archive for
10  * more details.
11  *
12  * Layout based on Elo serial touchscreen driver by Vojtech Pavlik
13  */
14
15 #include <linux/errno.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/input/mt.h>
20 #include <linux/serio.h>
21 #include <linux/ctype.h>
22 #include <linux/delay.h>
23
24 #define DRIVER_DESC     "Wacom W8001 serial touchscreen driver"
25
26 MODULE_AUTHOR("Jaya Kumar <jayakumar.lkml@gmail.com>");
27 MODULE_DESCRIPTION(DRIVER_DESC);
28 MODULE_LICENSE("GPL");
29
30 #define W8001_MAX_LENGTH        11
31 #define W8001_LEAD_MASK         0x80
32 #define W8001_LEAD_BYTE         0x80
33 #define W8001_TAB_MASK          0x40
34 #define W8001_TAB_BYTE          0x40
35 /* set in first byte of touch data packets */
36 #define W8001_TOUCH_MASK        (0x10 | W8001_LEAD_MASK)
37 #define W8001_TOUCH_BYTE        (0x10 | W8001_LEAD_BYTE)
38
39 #define W8001_QUERY_PACKET      0x20
40
41 #define W8001_CMD_STOP          '0'
42 #define W8001_CMD_START         '1'
43 #define W8001_CMD_QUERY         '*'
44 #define W8001_CMD_TOUCHQUERY    '%'
45
46 /* length of data packets in bytes, depends on device. */
47 #define W8001_PKTLEN_TOUCH93    5
48 #define W8001_PKTLEN_TOUCH9A    7
49 #define W8001_PKTLEN_TPCPEN     9
50 #define W8001_PKTLEN_TPCCTL     11      /* control packet */
51 #define W8001_PKTLEN_TOUCH2FG   13
52
53 /* resolution in points/mm */
54 #define W8001_PEN_RESOLUTION    100
55 #define W8001_TOUCH_RESOLUTION  10
56
57 struct w8001_coord {
58         u8 rdy;
59         u8 tsw;
60         u8 f1;
61         u8 f2;
62         u16 x;
63         u16 y;
64         u16 pen_pressure;
65         u8 tilt_x;
66         u8 tilt_y;
67 };
68
69 /* touch query reply packet */
70 struct w8001_touch_query {
71         u16 x;
72         u16 y;
73         u8 panel_res;
74         u8 capacity_res;
75         u8 sensor_id;
76 };
77
78 /*
79  * Per-touchscreen data.
80  */
81
82 struct w8001 {
83         struct input_dev *pen_dev;
84         struct input_dev *touch_dev;
85         struct serio *serio;
86         struct completion cmd_done;
87         int id;
88         int idx;
89         unsigned char response_type;
90         unsigned char response[W8001_MAX_LENGTH];
91         unsigned char data[W8001_MAX_LENGTH];
92         char phys[32];
93         int type;
94         unsigned int pktlen;
95         u16 max_touch_x;
96         u16 max_touch_y;
97         u16 max_pen_x;
98         u16 max_pen_y;
99         char pen_name[64];
100         char touch_name[64];
101         int open_count;
102         struct mutex mutex;
103 };
104
105 static void parse_pen_data(u8 *data, struct w8001_coord *coord)
106 {
107         memset(coord, 0, sizeof(*coord));
108
109         coord->rdy = data[0] & 0x20;
110         coord->tsw = data[0] & 0x01;
111         coord->f1 = data[0] & 0x02;
112         coord->f2 = data[0] & 0x04;
113
114         coord->x = (data[1] & 0x7F) << 9;
115         coord->x |= (data[2] & 0x7F) << 2;
116         coord->x |= (data[6] & 0x60) >> 5;
117
118         coord->y = (data[3] & 0x7F) << 9;
119         coord->y |= (data[4] & 0x7F) << 2;
120         coord->y |= (data[6] & 0x18) >> 3;
121
122         coord->pen_pressure = data[5] & 0x7F;
123         coord->pen_pressure |= (data[6] & 0x07) << 7 ;
124
125         coord->tilt_x = data[7] & 0x7F;
126         coord->tilt_y = data[8] & 0x7F;
127 }
128
129 static void parse_single_touch(u8 *data, struct w8001_coord *coord)
130 {
131         coord->x = (data[1] << 7) | data[2];
132         coord->y = (data[3] << 7) | data[4];
133         coord->tsw = data[0] & 0x01;
134 }
135
136 static void scale_touch_coordinates(struct w8001 *w8001,
137                                     unsigned int *x, unsigned int *y)
138 {
139         if (w8001->max_pen_x && w8001->max_touch_x)
140                 *x = *x * w8001->max_pen_x / w8001->max_touch_x;
141
142         if (w8001->max_pen_y && w8001->max_touch_y)
143                 *y = *y * w8001->max_pen_y / w8001->max_touch_y;
144 }
145
146 static void parse_multi_touch(struct w8001 *w8001)
147 {
148         struct input_dev *dev = w8001->touch_dev;
149         unsigned char *data = w8001->data;
150         unsigned int x, y;
151         int i;
152         int count = 0;
153
154         for (i = 0; i < 2; i++) {
155                 bool touch = data[0] & (1 << i);
156
157                 input_mt_slot(dev, i);
158                 if (touch) {
159                         x = (data[6 * i + 1] << 7) | data[6 * i + 2];
160                         y = (data[6 * i + 3] << 7) | data[6 * i + 4];
161                         /* data[5,6] and [11,12] is finger capacity */
162
163                         /* scale to pen maximum */
164                         scale_touch_coordinates(w8001, &x, &y);
165
166                         input_report_abs(dev, ABS_MT_POSITION_X, x);
167                         input_report_abs(dev, ABS_MT_POSITION_Y, y);
168                         count++;
169                 }
170         }
171
172         /* emulate single touch events when stylus is out of proximity.
173          * This is to make single touch backward support consistent
174          * across all Wacom single touch devices.
175          */
176         if (w8001->type != BTN_TOOL_PEN &&
177                             w8001->type != BTN_TOOL_RUBBER) {
178                 w8001->type = count == 1 ? BTN_TOOL_FINGER : KEY_RESERVED;
179                 input_mt_report_pointer_emulation(dev, true);
180         }
181
182         input_sync(dev);
183 }
184
185 static void parse_touchquery(u8 *data, struct w8001_touch_query *query)
186 {
187         memset(query, 0, sizeof(*query));
188
189         query->panel_res = data[1];
190         query->sensor_id = data[2] & 0x7;
191         query->capacity_res = data[7];
192
193         query->x = data[3] << 9;
194         query->x |= data[4] << 2;
195         query->x |= (data[2] >> 5) & 0x3;
196
197         query->y = data[5] << 9;
198         query->y |= data[6] << 2;
199         query->y |= (data[2] >> 3) & 0x3;
200
201         /* Early days' single-finger touch models need the following defaults */
202         if (!query->x && !query->y) {
203                 query->x = 1024;
204                 query->y = 1024;
205                 if (query->panel_res)
206                         query->x = query->y = (1 << query->panel_res);
207                 query->panel_res = W8001_TOUCH_RESOLUTION;
208         }
209 }
210
211 static void report_pen_events(struct w8001 *w8001, struct w8001_coord *coord)
212 {
213         struct input_dev *dev = w8001->pen_dev;
214
215         /*
216          * We have 1 bit for proximity (rdy) and 3 bits for tip, side,
217          * side2/eraser. If rdy && f2 are set, this can be either pen + side2,
218          * or eraser. Assume:
219          * - if dev is already in proximity and f2 is toggled â†’ pen + side2
220          * - if dev comes into proximity with f2 set â†’ eraser
221          * If f2 disappears after assuming eraser, fake proximity out for
222          * eraser and in for pen.
223          */
224
225         switch (w8001->type) {
226         case BTN_TOOL_RUBBER:
227                 if (!coord->f2) {
228                         input_report_abs(dev, ABS_PRESSURE, 0);
229                         input_report_key(dev, BTN_TOUCH, 0);
230                         input_report_key(dev, BTN_STYLUS, 0);
231                         input_report_key(dev, BTN_STYLUS2, 0);
232                         input_report_key(dev, BTN_TOOL_RUBBER, 0);
233                         input_sync(dev);
234                         w8001->type = BTN_TOOL_PEN;
235                 }
236                 break;
237
238         case BTN_TOOL_FINGER:
239         case KEY_RESERVED:
240                 w8001->type = coord->f2 ? BTN_TOOL_RUBBER : BTN_TOOL_PEN;
241                 break;
242
243         default:
244                 input_report_key(dev, BTN_STYLUS2, coord->f2);
245                 break;
246         }
247
248         input_report_abs(dev, ABS_X, coord->x);
249         input_report_abs(dev, ABS_Y, coord->y);
250         input_report_abs(dev, ABS_PRESSURE, coord->pen_pressure);
251         input_report_key(dev, BTN_TOUCH, coord->tsw);
252         input_report_key(dev, BTN_STYLUS, coord->f1);
253         input_report_key(dev, w8001->type, coord->rdy);
254         input_sync(dev);
255
256         if (!coord->rdy)
257                 w8001->type = KEY_RESERVED;
258 }
259
260 static void report_single_touch(struct w8001 *w8001, struct w8001_coord *coord)
261 {
262         struct input_dev *dev = w8001->touch_dev;
263         unsigned int x = coord->x;
264         unsigned int y = coord->y;
265
266         /* scale to pen maximum */
267         scale_touch_coordinates(w8001, &x, &y);
268
269         input_report_abs(dev, ABS_X, x);
270         input_report_abs(dev, ABS_Y, y);
271         input_report_key(dev, BTN_TOUCH, coord->tsw);
272
273         input_sync(dev);
274
275         w8001->type = coord->tsw ? BTN_TOOL_FINGER : KEY_RESERVED;
276 }
277
278 static irqreturn_t w8001_interrupt(struct serio *serio,
279                                    unsigned char data, unsigned int flags)
280 {
281         struct w8001 *w8001 = serio_get_drvdata(serio);
282         struct w8001_coord coord;
283         unsigned char tmp;
284
285         w8001->data[w8001->idx] = data;
286         switch (w8001->idx++) {
287         case 0:
288                 if ((data & W8001_LEAD_MASK) != W8001_LEAD_BYTE) {
289                         pr_debug("w8001: unsynchronized data: 0x%02x\n", data);
290                         w8001->idx = 0;
291                 }
292                 break;
293
294         case W8001_PKTLEN_TOUCH93 - 1:
295         case W8001_PKTLEN_TOUCH9A - 1:
296                 tmp = w8001->data[0] & W8001_TOUCH_BYTE;
297                 if (tmp != W8001_TOUCH_BYTE)
298                         break;
299
300                 if (w8001->pktlen == w8001->idx) {
301                         w8001->idx = 0;
302                         if (w8001->type != BTN_TOOL_PEN &&
303                             w8001->type != BTN_TOOL_RUBBER) {
304                                 parse_single_touch(w8001->data, &coord);
305                                 report_single_touch(w8001, &coord);
306                         }
307                 }
308                 break;
309
310         /* Pen coordinates packet */
311         case W8001_PKTLEN_TPCPEN - 1:
312                 tmp = w8001->data[0] & W8001_TAB_MASK;
313                 if (unlikely(tmp == W8001_TAB_BYTE))
314                         break;
315
316                 tmp = w8001->data[0] & W8001_TOUCH_BYTE;
317                 if (tmp == W8001_TOUCH_BYTE)
318                         break;
319
320                 w8001->idx = 0;
321                 parse_pen_data(w8001->data, &coord);
322                 report_pen_events(w8001, &coord);
323                 break;
324
325         /* control packet */
326         case W8001_PKTLEN_TPCCTL - 1:
327                 tmp = w8001->data[0] & W8001_TOUCH_MASK;
328                 if (tmp == W8001_TOUCH_BYTE)
329                         break;
330
331                 w8001->idx = 0;
332                 memcpy(w8001->response, w8001->data, W8001_MAX_LENGTH);
333                 w8001->response_type = W8001_QUERY_PACKET;
334                 complete(&w8001->cmd_done);
335                 break;
336
337         /* 2 finger touch packet */
338         case W8001_PKTLEN_TOUCH2FG - 1:
339                 w8001->idx = 0;
340                 parse_multi_touch(w8001);
341                 break;
342         }
343
344         return IRQ_HANDLED;
345 }
346
347 static int w8001_command(struct w8001 *w8001, unsigned char command,
348                          bool wait_response)
349 {
350         int rc;
351
352         w8001->response_type = 0;
353         init_completion(&w8001->cmd_done);
354
355         rc = serio_write(w8001->serio, command);
356         if (rc == 0 && wait_response) {
357
358                 wait_for_completion_timeout(&w8001->cmd_done, HZ);
359                 if (w8001->response_type != W8001_QUERY_PACKET)
360                         rc = -EIO;
361         }
362
363         return rc;
364 }
365
366 static int w8001_open(struct input_dev *dev)
367 {
368         struct w8001 *w8001 = input_get_drvdata(dev);
369         int err;
370
371         err = mutex_lock_interruptible(&w8001->mutex);
372         if (err)
373                 return err;
374
375         if (w8001->open_count++ == 0) {
376                 err = w8001_command(w8001, W8001_CMD_START, false);
377                 if (err)
378                         w8001->open_count--;
379         }
380
381         mutex_unlock(&w8001->mutex);
382         return err;
383 }
384
385 static void w8001_close(struct input_dev *dev)
386 {
387         struct w8001 *w8001 = input_get_drvdata(dev);
388
389         mutex_lock(&w8001->mutex);
390
391         if (--w8001->open_count == 0)
392                 w8001_command(w8001, W8001_CMD_STOP, false);
393
394         mutex_unlock(&w8001->mutex);
395 }
396
397 static int w8001_detect(struct w8001 *w8001)
398 {
399         int error;
400
401         error = w8001_command(w8001, W8001_CMD_STOP, false);
402         if (error)
403                 return error;
404
405         msleep(250);    /* wait 250ms before querying the device */
406
407         return 0;
408 }
409
410 static int w8001_setup_pen(struct w8001 *w8001, char *basename,
411                            size_t basename_sz)
412 {
413         struct input_dev *dev = w8001->pen_dev;
414         struct w8001_coord coord;
415         int error;
416
417         /* penabled? */
418         error = w8001_command(w8001, W8001_CMD_QUERY, true);
419         if (error)
420                 return error;
421
422         __set_bit(EV_KEY, dev->evbit);
423         __set_bit(EV_ABS, dev->evbit);
424         __set_bit(BTN_TOUCH, dev->keybit);
425         __set_bit(BTN_TOOL_PEN, dev->keybit);
426         __set_bit(BTN_TOOL_RUBBER, dev->keybit);
427         __set_bit(BTN_STYLUS, dev->keybit);
428         __set_bit(BTN_STYLUS2, dev->keybit);
429         __set_bit(INPUT_PROP_DIRECT, dev->propbit);
430
431         parse_pen_data(w8001->response, &coord);
432         w8001->max_pen_x = coord.x;
433         w8001->max_pen_y = coord.y;
434
435         input_set_abs_params(dev, ABS_X, 0, coord.x, 0, 0);
436         input_set_abs_params(dev, ABS_Y, 0, coord.y, 0, 0);
437         input_abs_set_res(dev, ABS_X, W8001_PEN_RESOLUTION);
438         input_abs_set_res(dev, ABS_Y, W8001_PEN_RESOLUTION);
439         input_set_abs_params(dev, ABS_PRESSURE, 0, coord.pen_pressure, 0, 0);
440         if (coord.tilt_x && coord.tilt_y) {
441                 input_set_abs_params(dev, ABS_TILT_X, 0, coord.tilt_x, 0, 0);
442                 input_set_abs_params(dev, ABS_TILT_Y, 0, coord.tilt_y, 0, 0);
443         }
444
445         w8001->id = 0x90;
446         strlcat(basename, " Penabled", basename_sz);
447
448         return 0;
449 }
450
451 static int w8001_setup_touch(struct w8001 *w8001, char *basename,
452                              size_t basename_sz)
453 {
454         struct input_dev *dev = w8001->touch_dev;
455         struct w8001_touch_query touch;
456         int error;
457
458
459         /* Touch enabled? */
460         error = w8001_command(w8001, W8001_CMD_TOUCHQUERY, true);
461         if (error)
462                 return error;
463         /*
464          * Some non-touch devices may reply to the touch query. But their
465          * second byte is empty, which indicates touch is not supported.
466          */
467         if (!w8001->response[1])
468                 return -ENXIO;
469
470         __set_bit(EV_KEY, dev->evbit);
471         __set_bit(EV_ABS, dev->evbit);
472         __set_bit(BTN_TOUCH, dev->keybit);
473         __set_bit(INPUT_PROP_DIRECT, dev->propbit);
474
475         parse_touchquery(w8001->response, &touch);
476         w8001->max_touch_x = touch.x;
477         w8001->max_touch_y = touch.y;
478
479         if (w8001->max_pen_x && w8001->max_pen_y) {
480                 /* if pen is supported scale to pen maximum */
481                 touch.x = w8001->max_pen_x;
482                 touch.y = w8001->max_pen_y;
483                 touch.panel_res = W8001_PEN_RESOLUTION;
484         }
485
486         input_set_abs_params(dev, ABS_X, 0, touch.x, 0, 0);
487         input_set_abs_params(dev, ABS_Y, 0, touch.y, 0, 0);
488         input_abs_set_res(dev, ABS_X, touch.panel_res);
489         input_abs_set_res(dev, ABS_Y, touch.panel_res);
490
491         switch (touch.sensor_id) {
492         case 0:
493         case 2:
494                 w8001->pktlen = W8001_PKTLEN_TOUCH93;
495                 w8001->id = 0x93;
496                 strlcat(basename, " 1FG", basename_sz);
497                 break;
498
499         case 1:
500         case 3:
501         case 4:
502                 w8001->pktlen = W8001_PKTLEN_TOUCH9A;
503                 strlcat(basename, " 1FG", basename_sz);
504                 w8001->id = 0x9a;
505                 break;
506
507         case 5:
508                 w8001->pktlen = W8001_PKTLEN_TOUCH2FG;
509
510                 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
511                 input_mt_init_slots(dev, 2, 0);
512                 input_set_abs_params(dev, ABS_MT_POSITION_X,
513                                         0, touch.x, 0, 0);
514                 input_set_abs_params(dev, ABS_MT_POSITION_Y,
515                                         0, touch.y, 0, 0);
516
517                 strlcat(basename, " 2FG", basename_sz);
518                 if (w8001->max_pen_x && w8001->max_pen_y)
519                         w8001->id = 0xE3;
520                 else
521                         w8001->id = 0xE2;
522                 break;
523         }
524
525         strlcat(basename, " Touchscreen", basename_sz);
526
527         return 0;
528 }
529
530 static void w8001_set_devdata(struct input_dev *dev, struct w8001 *w8001,
531                               struct serio *serio)
532 {
533         dev->phys = w8001->phys;
534         dev->id.bustype = BUS_RS232;
535         dev->id.product = w8001->id;
536         dev->id.vendor = 0x056a;
537         dev->id.version = 0x0100;
538         dev->open = w8001_open;
539         dev->close = w8001_close;
540
541         dev->dev.parent = &serio->dev;
542
543         input_set_drvdata(dev, w8001);
544 }
545
546 /*
547  * w8001_disconnect() is the opposite of w8001_connect()
548  */
549
550 static void w8001_disconnect(struct serio *serio)
551 {
552         struct w8001 *w8001 = serio_get_drvdata(serio);
553
554         serio_close(serio);
555
556         if (w8001->pen_dev)
557                 input_unregister_device(w8001->pen_dev);
558         if (w8001->touch_dev)
559                 input_unregister_device(w8001->touch_dev);
560         kfree(w8001);
561
562         serio_set_drvdata(serio, NULL);
563 }
564
565 /*
566  * w8001_connect() is the routine that is called when someone adds a
567  * new serio device that supports the w8001 protocol and registers it as
568  * an input device.
569  */
570
571 static int w8001_connect(struct serio *serio, struct serio_driver *drv)
572 {
573         struct w8001 *w8001;
574         struct input_dev *input_dev_pen;
575         struct input_dev *input_dev_touch;
576         char basename[64];
577         int err, err_pen, err_touch;
578
579         w8001 = kzalloc(sizeof(struct w8001), GFP_KERNEL);
580         input_dev_pen = input_allocate_device();
581         input_dev_touch = input_allocate_device();
582         if (!w8001 || !input_dev_pen || !input_dev_touch) {
583                 err = -ENOMEM;
584                 goto fail1;
585         }
586
587         w8001->serio = serio;
588         w8001->pen_dev = input_dev_pen;
589         w8001->touch_dev = input_dev_touch;
590         mutex_init(&w8001->mutex);
591         init_completion(&w8001->cmd_done);
592         snprintf(w8001->phys, sizeof(w8001->phys), "%s/input0", serio->phys);
593
594         serio_set_drvdata(serio, w8001);
595         err = serio_open(serio, drv);
596         if (err)
597                 goto fail2;
598
599         err = w8001_detect(w8001);
600         if (err)
601                 goto fail3;
602
603         /* For backwards-compatibility we compose the basename based on
604          * capabilities and then just append the tool type
605          */
606         strlcpy(basename, "Wacom Serial", sizeof(basename));
607
608         err_pen = w8001_setup_pen(w8001, basename, sizeof(basename));
609         err_touch = w8001_setup_touch(w8001, basename, sizeof(basename));
610         if (err_pen && err_touch) {
611                 err = -ENXIO;
612                 goto fail3;
613         }
614
615         if (!err_pen) {
616                 strlcpy(w8001->pen_name, basename, sizeof(w8001->pen_name));
617                 strlcat(w8001->pen_name, " Pen", sizeof(w8001->pen_name));
618                 input_dev_pen->name = w8001->pen_name;
619
620                 w8001_set_devdata(input_dev_pen, w8001, serio);
621
622                 err = input_register_device(w8001->pen_dev);
623                 if (err)
624                         goto fail3;
625         } else {
626                 input_free_device(input_dev_pen);
627                 input_dev_pen = NULL;
628                 w8001->pen_dev = NULL;
629         }
630
631         if (!err_touch) {
632                 strlcpy(w8001->touch_name, basename, sizeof(w8001->touch_name));
633                 strlcat(w8001->touch_name, " Finger",
634                         sizeof(w8001->touch_name));
635                 input_dev_touch->name = w8001->touch_name;
636
637                 w8001_set_devdata(input_dev_touch, w8001, serio);
638
639                 err = input_register_device(w8001->touch_dev);
640                 if (err)
641                         goto fail4;
642         } else {
643                 input_free_device(input_dev_touch);
644                 input_dev_touch = NULL;
645                 w8001->touch_dev = NULL;
646         }
647
648         return 0;
649
650 fail4:
651         if (w8001->pen_dev)
652                 input_unregister_device(w8001->pen_dev);
653 fail3:
654         serio_close(serio);
655 fail2:
656         serio_set_drvdata(serio, NULL);
657 fail1:
658         input_free_device(input_dev_pen);
659         input_free_device(input_dev_touch);
660         kfree(w8001);
661         return err;
662 }
663
664 static struct serio_device_id w8001_serio_ids[] = {
665         {
666                 .type   = SERIO_RS232,
667                 .proto  = SERIO_W8001,
668                 .id     = SERIO_ANY,
669                 .extra  = SERIO_ANY,
670         },
671         { 0 }
672 };
673
674 MODULE_DEVICE_TABLE(serio, w8001_serio_ids);
675
676 static struct serio_driver w8001_drv = {
677         .driver         = {
678                 .name   = "w8001",
679         },
680         .description    = DRIVER_DESC,
681         .id_table       = w8001_serio_ids,
682         .interrupt      = w8001_interrupt,
683         .connect        = w8001_connect,
684         .disconnect     = w8001_disconnect,
685 };
686
687 module_serio_driver(w8001_drv);