]> Pileus Git - ~andy/linux/blob - drivers/input/mouse/synaptics.c
Input: synaptics - refactor agm packet parsing
[~andy/linux] / drivers / input / mouse / synaptics.c
1 /*
2  * Synaptics TouchPad PS/2 mouse driver
3  *
4  *   2003 Dmitry Torokhov <dtor@mail.ru>
5  *     Added support for pass-through port. Special thanks to Peter Berg Larsen
6  *     for explaining various Synaptics quirks.
7  *
8  *   2003 Peter Osterlund <petero2@telia.com>
9  *     Ported to 2.5 input device infrastructure.
10  *
11  *   Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
12  *     start merging tpconfig and gpm code to a xfree-input module
13  *     adding some changes and extensions (ex. 3rd and 4th button)
14  *
15  *   Copyright (c) 1997 C. Scott Ananian <cananian@alumni.priceton.edu>
16  *   Copyright (c) 1998-2000 Bruce Kalk <kall@compass.com>
17  *     code for the special synaptics commands (from the tpconfig-source)
18  *
19  * This program is free software; you can redistribute it and/or modify it
20  * under the terms of the GNU General Public License version 2 as published by
21  * the Free Software Foundation.
22  *
23  * Trademarks are the property of their respective owners.
24  */
25
26 #include <linux/module.h>
27 #include <linux/dmi.h>
28 #include <linux/input/mt.h>
29 #include <linux/serio.h>
30 #include <linux/libps2.h>
31 #include <linux/slab.h>
32 #include "psmouse.h"
33 #include "synaptics.h"
34
35 /*
36  * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
37  * section 2.3.2, which says that they should be valid regardless of the
38  * actual size of the sensor.
39  * Note that newer firmware allows querying device for maximum useable
40  * coordinates.
41  */
42 #define XMIN_NOMINAL 1472
43 #define XMAX_NOMINAL 5472
44 #define YMIN_NOMINAL 1408
45 #define YMAX_NOMINAL 4448
46
47 /*
48  * Synaptics touchpads report the y coordinate from bottom to top, which is
49  * opposite from what userspace expects.
50  * This function is used to invert y before reporting.
51  */
52 static int synaptics_invert_y(int y)
53 {
54         return YMAX_NOMINAL + YMIN_NOMINAL - y;
55 }
56
57
58 /*****************************************************************************
59  *      Stuff we need even when we do not want native Synaptics support
60  ****************************************************************************/
61
62 /*
63  * Set the synaptics touchpad mode byte by special commands
64  */
65 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
66 {
67         unsigned char param[1];
68
69         if (psmouse_sliced_command(psmouse, mode))
70                 return -1;
71         param[0] = SYN_PS_SET_MODE2;
72         if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
73                 return -1;
74         return 0;
75 }
76
77 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
78 {
79         struct ps2dev *ps2dev = &psmouse->ps2dev;
80         unsigned char param[4];
81
82         param[0] = 0;
83
84         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
85         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
86         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
87         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
88         ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
89
90         if (param[1] != 0x47)
91                 return -ENODEV;
92
93         if (set_properties) {
94                 psmouse->vendor = "Synaptics";
95                 psmouse->name = "TouchPad";
96         }
97
98         return 0;
99 }
100
101 void synaptics_reset(struct psmouse *psmouse)
102 {
103         /* reset touchpad back to relative mode, gestures enabled */
104         synaptics_mode_cmd(psmouse, 0);
105 }
106
107 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
108
109 /*****************************************************************************
110  *      Synaptics communications functions
111  ****************************************************************************/
112
113 /*
114  * Send a command to the synpatics touchpad by special commands
115  */
116 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
117 {
118         if (psmouse_sliced_command(psmouse, c))
119                 return -1;
120         if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
121                 return -1;
122         return 0;
123 }
124
125 /*
126  * Read the model-id bytes from the touchpad
127  * see also SYN_MODEL_* macros
128  */
129 static int synaptics_model_id(struct psmouse *psmouse)
130 {
131         struct synaptics_data *priv = psmouse->private;
132         unsigned char mi[3];
133
134         if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
135                 return -1;
136         priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
137         return 0;
138 }
139
140 /*
141  * Read the capability-bits from the touchpad
142  * see also the SYN_CAP_* macros
143  */
144 static int synaptics_capability(struct psmouse *psmouse)
145 {
146         struct synaptics_data *priv = psmouse->private;
147         unsigned char cap[3];
148
149         if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
150                 return -1;
151         priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
152         priv->ext_cap = priv->ext_cap_0c = 0;
153
154         /*
155          * Older firmwares had submodel ID fixed to 0x47
156          */
157         if (SYN_ID_FULL(priv->identity) < 0x705 &&
158             SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
159                 return -1;
160         }
161
162         /*
163          * Unless capExtended is set the rest of the flags should be ignored
164          */
165         if (!SYN_CAP_EXTENDED(priv->capabilities))
166                 priv->capabilities = 0;
167
168         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
169                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
170                         printk(KERN_ERR "Synaptics claims to have extended capabilities,"
171                                " but I'm not able to read them.\n");
172                 } else {
173                         priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
174
175                         /*
176                          * if nExtBtn is greater than 8 it should be considered
177                          * invalid and treated as 0
178                          */
179                         if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
180                                 priv->ext_cap &= 0xff0fff;
181                 }
182         }
183
184         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
185                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
186                         printk(KERN_ERR "Synaptics claims to have extended capability 0x0c,"
187                                " but I'm not able to read it.\n");
188                 } else {
189                         priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
190                 }
191         }
192
193         return 0;
194 }
195
196 /*
197  * Identify Touchpad
198  * See also the SYN_ID_* macros
199  */
200 static int synaptics_identify(struct psmouse *psmouse)
201 {
202         struct synaptics_data *priv = psmouse->private;
203         unsigned char id[3];
204
205         if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
206                 return -1;
207         priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
208         if (SYN_ID_IS_SYNAPTICS(priv->identity))
209                 return 0;
210         return -1;
211 }
212
213 /*
214  * Read touchpad resolution and maximum reported coordinates
215  * Resolution is left zero if touchpad does not support the query
216  */
217 static int synaptics_resolution(struct psmouse *psmouse)
218 {
219         struct synaptics_data *priv = psmouse->private;
220         unsigned char resp[3];
221
222         if (SYN_ID_MAJOR(priv->identity) < 4)
223                 return 0;
224
225         if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
226                 if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
227                         priv->x_res = resp[0]; /* x resolution in units/mm */
228                         priv->y_res = resp[2]; /* y resolution in units/mm */
229                 }
230         }
231
232         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
233             SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
234                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
235                         printk(KERN_ERR "Synaptics claims to have max coordinates"
236                                " query, but I'm not able to read it.\n");
237                 } else {
238                         priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
239                         priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
240                 }
241         }
242
243         if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
244             SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
245                 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
246                         printk(KERN_ERR "Synaptics claims to have min coordinates"
247                                " query, but I'm not able to read it.\n");
248                 } else {
249                         priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
250                         priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
251                 }
252         }
253
254         return 0;
255 }
256
257 static int synaptics_query_hardware(struct psmouse *psmouse)
258 {
259         if (synaptics_identify(psmouse))
260                 return -1;
261         if (synaptics_model_id(psmouse))
262                 return -1;
263         if (synaptics_capability(psmouse))
264                 return -1;
265         if (synaptics_resolution(psmouse))
266                 return -1;
267
268         return 0;
269 }
270
271 static int synaptics_set_absolute_mode(struct psmouse *psmouse)
272 {
273         struct synaptics_data *priv = psmouse->private;
274
275         priv->mode = SYN_BIT_ABSOLUTE_MODE;
276         if (SYN_ID_MAJOR(priv->identity) >= 4)
277                 priv->mode |= SYN_BIT_DISABLE_GESTURE;
278         if (SYN_CAP_EXTENDED(priv->capabilities))
279                 priv->mode |= SYN_BIT_W_MODE;
280
281         if (synaptics_mode_cmd(psmouse, priv->mode))
282                 return -1;
283
284         return 0;
285 }
286
287 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
288 {
289         struct synaptics_data *priv = psmouse->private;
290
291         if (rate >= 80) {
292                 priv->mode |= SYN_BIT_HIGH_RATE;
293                 psmouse->rate = 80;
294         } else {
295                 priv->mode &= ~SYN_BIT_HIGH_RATE;
296                 psmouse->rate = 40;
297         }
298
299         synaptics_mode_cmd(psmouse, priv->mode);
300 }
301
302 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
303 {
304         static unsigned char param = 0xc8;
305         struct synaptics_data *priv = psmouse->private;
306
307         if (!SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
308                 return 0;
309
310         if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
311                 return -1;
312         if (ps2_command(&psmouse->ps2dev, &param, PSMOUSE_CMD_SETRATE))
313                 return -1;
314
315         /* Advanced gesture mode also sends multi finger data */
316         priv->capabilities |= BIT(1);
317
318         return 0;
319 }
320
321 /*****************************************************************************
322  *      Synaptics pass-through PS/2 port support
323  ****************************************************************************/
324 static int synaptics_pt_write(struct serio *serio, unsigned char c)
325 {
326         struct psmouse *parent = serio_get_drvdata(serio->parent);
327         char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
328
329         if (psmouse_sliced_command(parent, c))
330                 return -1;
331         if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
332                 return -1;
333         return 0;
334 }
335
336 static int synaptics_pt_start(struct serio *serio)
337 {
338         struct psmouse *parent = serio_get_drvdata(serio->parent);
339         struct synaptics_data *priv = parent->private;
340
341         serio_pause_rx(parent->ps2dev.serio);
342         priv->pt_port = serio;
343         serio_continue_rx(parent->ps2dev.serio);
344
345         return 0;
346 }
347
348 static void synaptics_pt_stop(struct serio *serio)
349 {
350         struct psmouse *parent = serio_get_drvdata(serio->parent);
351         struct synaptics_data *priv = parent->private;
352
353         serio_pause_rx(parent->ps2dev.serio);
354         priv->pt_port = NULL;
355         serio_continue_rx(parent->ps2dev.serio);
356 }
357
358 static int synaptics_is_pt_packet(unsigned char *buf)
359 {
360         return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
361 }
362
363 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
364 {
365         struct psmouse *child = serio_get_drvdata(ptport);
366
367         if (child && child->state == PSMOUSE_ACTIVATED) {
368                 serio_interrupt(ptport, packet[1], 0);
369                 serio_interrupt(ptport, packet[4], 0);
370                 serio_interrupt(ptport, packet[5], 0);
371                 if (child->pktsize == 4)
372                         serio_interrupt(ptport, packet[2], 0);
373         } else
374                 serio_interrupt(ptport, packet[1], 0);
375 }
376
377 static void synaptics_pt_activate(struct psmouse *psmouse)
378 {
379         struct synaptics_data *priv = psmouse->private;
380         struct psmouse *child = serio_get_drvdata(priv->pt_port);
381
382         /* adjust the touchpad to child's choice of protocol */
383         if (child) {
384                 if (child->pktsize == 4)
385                         priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
386                 else
387                         priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
388
389                 if (synaptics_mode_cmd(psmouse, priv->mode))
390                         printk(KERN_INFO "synaptics: failed to switch guest protocol\n");
391         }
392 }
393
394 static void synaptics_pt_create(struct psmouse *psmouse)
395 {
396         struct serio *serio;
397
398         serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
399         if (!serio) {
400                 printk(KERN_ERR "synaptics: not enough memory to allocate pass-through port\n");
401                 return;
402         }
403
404         serio->id.type = SERIO_PS_PSTHRU;
405         strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
406         strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
407         serio->write = synaptics_pt_write;
408         serio->start = synaptics_pt_start;
409         serio->stop = synaptics_pt_stop;
410         serio->parent = psmouse->ps2dev.serio;
411
412         psmouse->pt_activate = synaptics_pt_activate;
413
414         printk(KERN_INFO "serio: %s port at %s\n", serio->name, psmouse->phys);
415         serio_register_port(serio);
416 }
417
418 /*****************************************************************************
419  *      Functions to interpret the absolute mode packets
420  ****************************************************************************/
421
422 static void synaptics_parse_agm(const unsigned char buf[],
423                                 struct synaptics_data *priv)
424 {
425         struct synaptics_hw_state *agm = &priv->agm;
426
427         /* Gesture packet: (x, y, z) at half resolution */
428         agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
429         agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
430         agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
431 }
432
433 static int synaptics_parse_hw_state(const unsigned char buf[],
434                                     struct synaptics_data *priv,
435                                     struct synaptics_hw_state *hw)
436 {
437         memset(hw, 0, sizeof(struct synaptics_hw_state));
438
439         if (SYN_MODEL_NEWABS(priv->model_id)) {
440                 hw->w = (((buf[0] & 0x30) >> 2) |
441                          ((buf[0] & 0x04) >> 1) |
442                          ((buf[3] & 0x04) >> 2));
443
444                 hw->left  = (buf[0] & 0x01) ? 1 : 0;
445                 hw->right = (buf[0] & 0x02) ? 1 : 0;
446
447                 if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
448                         /*
449                          * Clickpad's button is transmitted as middle button,
450                          * however, since it is primary button, we will report
451                          * it as BTN_LEFT.
452                          */
453                         hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
454
455                 } else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
456                         hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
457                         if (hw->w == 2)
458                                 hw->scroll = (signed char)(buf[1]);
459                 }
460
461                 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
462                         hw->up   = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
463                         hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
464                 }
465
466                 if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) && hw->w == 2) {
467                         synaptics_parse_agm(buf, priv);
468                         return 1;
469                 }
470
471                 hw->x = (((buf[3] & 0x10) << 8) |
472                          ((buf[1] & 0x0f) << 8) |
473                          buf[4]);
474                 hw->y = (((buf[3] & 0x20) << 7) |
475                          ((buf[1] & 0xf0) << 4) |
476                          buf[5]);
477                 hw->z = buf[2];
478
479                 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
480                     ((buf[0] ^ buf[3]) & 0x02)) {
481                         switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
482                         default:
483                                 /*
484                                  * if nExtBtn is greater than 8 it should be
485                                  * considered invalid and treated as 0
486                                  */
487                                 break;
488                         case 8:
489                                 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
490                                 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
491                         case 6:
492                                 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
493                                 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
494                         case 4:
495                                 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
496                                 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
497                         case 2:
498                                 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
499                                 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
500                         }
501                 }
502         } else {
503                 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
504                 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
505
506                 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
507                 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
508
509                 hw->left  = (buf[0] & 0x01) ? 1 : 0;
510                 hw->right = (buf[0] & 0x02) ? 1 : 0;
511         }
512
513         return 0;
514 }
515
516 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
517                                           bool active, int x, int y)
518 {
519         input_mt_slot(dev, slot);
520         input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
521         if (active) {
522                 input_report_abs(dev, ABS_MT_POSITION_X, x);
523                 input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
524         }
525 }
526
527 static void synaptics_report_semi_mt_data(struct input_dev *dev,
528                                           const struct synaptics_hw_state *a,
529                                           const struct synaptics_hw_state *b,
530                                           int num_fingers)
531 {
532         if (num_fingers >= 2) {
533                 synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
534                                               min(a->y, b->y));
535                 synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
536                                               max(a->y, b->y));
537         } else if (num_fingers == 1) {
538                 synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
539                 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
540         } else {
541                 synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
542                 synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
543         }
544 }
545
546 /*
547  *  called for each full received packet from the touchpad
548  */
549 static void synaptics_process_packet(struct psmouse *psmouse)
550 {
551         struct input_dev *dev = psmouse->dev;
552         struct synaptics_data *priv = psmouse->private;
553         struct synaptics_hw_state hw;
554         int num_fingers;
555         int finger_width;
556         int i;
557
558         if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
559                 return;
560
561         if (hw.scroll) {
562                 priv->scroll += hw.scroll;
563
564                 while (priv->scroll >= 4) {
565                         input_report_key(dev, BTN_BACK, !hw.down);
566                         input_sync(dev);
567                         input_report_key(dev, BTN_BACK, hw.down);
568                         input_sync(dev);
569                         priv->scroll -= 4;
570                 }
571                 while (priv->scroll <= -4) {
572                         input_report_key(dev, BTN_FORWARD, !hw.up);
573                         input_sync(dev);
574                         input_report_key(dev, BTN_FORWARD, hw.up);
575                         input_sync(dev);
576                         priv->scroll += 4;
577                 }
578                 return;
579         }
580
581         if (hw.z > 0 && hw.x > 1) {
582                 num_fingers = 1;
583                 finger_width = 5;
584                 if (SYN_CAP_EXTENDED(priv->capabilities)) {
585                         switch (hw.w) {
586                         case 0 ... 1:
587                                 if (SYN_CAP_MULTIFINGER(priv->capabilities))
588                                         num_fingers = hw.w + 2;
589                                 break;
590                         case 2:
591                                 if (SYN_MODEL_PEN(priv->model_id))
592                                         ;   /* Nothing, treat a pen as a single finger */
593                                 break;
594                         case 4 ... 15:
595                                 if (SYN_CAP_PALMDETECT(priv->capabilities))
596                                         finger_width = hw.w;
597                                 break;
598                         }
599                 }
600         } else {
601                 num_fingers = 0;
602                 finger_width = 0;
603         }
604
605         if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
606                 synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
607                                               num_fingers);
608
609         /* Post events
610          * BTN_TOUCH has to be first as mousedev relies on it when doing
611          * absolute -> relative conversion
612          */
613         if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
614         if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
615
616         if (num_fingers > 0) {
617                 input_report_abs(dev, ABS_X, hw.x);
618                 input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
619         }
620         input_report_abs(dev, ABS_PRESSURE, hw.z);
621
622         if (SYN_CAP_PALMDETECT(priv->capabilities))
623                 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
624
625         input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
626         input_report_key(dev, BTN_LEFT, hw.left);
627         input_report_key(dev, BTN_RIGHT, hw.right);
628
629         if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
630                 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
631                 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
632         }
633
634         if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
635                 input_report_key(dev, BTN_MIDDLE, hw.middle);
636
637         if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
638                 input_report_key(dev, BTN_FORWARD, hw.up);
639                 input_report_key(dev, BTN_BACK, hw.down);
640         }
641
642         for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
643                 input_report_key(dev, BTN_0 + i, hw.ext_buttons & (1 << i));
644
645         input_sync(dev);
646 }
647
648 static int synaptics_validate_byte(unsigned char packet[], int idx, unsigned char pkt_type)
649 {
650         static const unsigned char newabs_mask[]        = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
651         static const unsigned char newabs_rel_mask[]    = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
652         static const unsigned char newabs_rslt[]        = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
653         static const unsigned char oldabs_mask[]        = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
654         static const unsigned char oldabs_rslt[]        = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
655
656         if (idx < 0 || idx > 4)
657                 return 0;
658
659         switch (pkt_type) {
660
661         case SYN_NEWABS:
662         case SYN_NEWABS_RELAXED:
663                 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
664
665         case SYN_NEWABS_STRICT:
666                 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
667
668         case SYN_OLDABS:
669                 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
670
671         default:
672                 printk(KERN_ERR "synaptics: unknown packet type %d\n", pkt_type);
673                 return 0;
674         }
675 }
676
677 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
678 {
679         int i;
680
681         for (i = 0; i < 5; i++)
682                 if (!synaptics_validate_byte(psmouse->packet, i, SYN_NEWABS_STRICT)) {
683                         printk(KERN_INFO "synaptics: using relaxed packet validation\n");
684                         return SYN_NEWABS_RELAXED;
685                 }
686
687         return SYN_NEWABS_STRICT;
688 }
689
690 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
691 {
692         struct synaptics_data *priv = psmouse->private;
693
694         if (psmouse->pktcnt >= 6) { /* Full packet received */
695                 if (unlikely(priv->pkt_type == SYN_NEWABS))
696                         priv->pkt_type = synaptics_detect_pkt_type(psmouse);
697
698                 if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
699                     synaptics_is_pt_packet(psmouse->packet)) {
700                         if (priv->pt_port)
701                                 synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
702                 } else
703                         synaptics_process_packet(psmouse);
704
705                 return PSMOUSE_FULL_PACKET;
706         }
707
708         return synaptics_validate_byte(psmouse->packet, psmouse->pktcnt - 1, priv->pkt_type) ?
709                 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
710 }
711
712 /*****************************************************************************
713  *      Driver initialization/cleanup functions
714  ****************************************************************************/
715 static void set_input_params(struct input_dev *dev, struct synaptics_data *priv)
716 {
717         int i;
718         int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
719                         SYN_REDUCED_FILTER_FUZZ : 0;
720
721         __set_bit(INPUT_PROP_POINTER, dev->propbit);
722
723         __set_bit(EV_ABS, dev->evbit);
724         input_set_abs_params(dev, ABS_X,
725                              priv->x_min ?: XMIN_NOMINAL,
726                              priv->x_max ?: XMAX_NOMINAL,
727                              fuzz, 0);
728         input_set_abs_params(dev, ABS_Y,
729                              priv->y_min ?: YMIN_NOMINAL,
730                              priv->y_max ?: YMAX_NOMINAL,
731                              fuzz, 0);
732         input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
733
734         if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
735                 __set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
736                 input_mt_init_slots(dev, 2);
737                 input_set_abs_params(dev, ABS_MT_POSITION_X,
738                                      priv->x_min ?: XMIN_NOMINAL,
739                                      priv->x_max ?: XMAX_NOMINAL,
740                                      fuzz, 0);
741                 input_set_abs_params(dev, ABS_MT_POSITION_Y,
742                                      priv->y_min ?: YMIN_NOMINAL,
743                                      priv->y_max ?: YMAX_NOMINAL,
744                                      fuzz, 0);
745
746                 input_abs_set_res(dev, ABS_MT_POSITION_X, priv->x_res);
747                 input_abs_set_res(dev, ABS_MT_POSITION_Y, priv->y_res);
748         }
749
750         if (SYN_CAP_PALMDETECT(priv->capabilities))
751                 input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
752
753         __set_bit(EV_KEY, dev->evbit);
754         __set_bit(BTN_TOUCH, dev->keybit);
755         __set_bit(BTN_TOOL_FINGER, dev->keybit);
756         __set_bit(BTN_LEFT, dev->keybit);
757         __set_bit(BTN_RIGHT, dev->keybit);
758
759         if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
760                 __set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
761                 __set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
762         }
763
764         if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
765                 __set_bit(BTN_MIDDLE, dev->keybit);
766
767         if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
768             SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
769                 __set_bit(BTN_FORWARD, dev->keybit);
770                 __set_bit(BTN_BACK, dev->keybit);
771         }
772
773         for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
774                 __set_bit(BTN_0 + i, dev->keybit);
775
776         __clear_bit(EV_REL, dev->evbit);
777         __clear_bit(REL_X, dev->relbit);
778         __clear_bit(REL_Y, dev->relbit);
779
780         input_abs_set_res(dev, ABS_X, priv->x_res);
781         input_abs_set_res(dev, ABS_Y, priv->y_res);
782
783         if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
784                 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
785                 /* Clickpads report only left button */
786                 __clear_bit(BTN_RIGHT, dev->keybit);
787                 __clear_bit(BTN_MIDDLE, dev->keybit);
788         }
789 }
790
791 static void synaptics_disconnect(struct psmouse *psmouse)
792 {
793         synaptics_reset(psmouse);
794         kfree(psmouse->private);
795         psmouse->private = NULL;
796 }
797
798 static int synaptics_reconnect(struct psmouse *psmouse)
799 {
800         struct synaptics_data *priv = psmouse->private;
801         struct synaptics_data old_priv = *priv;
802         int retry = 0;
803         int error;
804
805         do {
806                 psmouse_reset(psmouse);
807                 error = synaptics_detect(psmouse, 0);
808         } while (error && ++retry < 3);
809
810         if (error)
811                 return -1;
812
813         if (retry > 1)
814                 printk(KERN_DEBUG "Synaptics reconnected after %d tries\n",
815                         retry);
816
817         if (synaptics_query_hardware(psmouse)) {
818                 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
819                 return -1;
820         }
821
822         if (synaptics_set_absolute_mode(psmouse)) {
823                 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
824                 return -1;
825         }
826
827         if (synaptics_set_advanced_gesture_mode(psmouse)) {
828                 printk(KERN_ERR "Advanced gesture mode reconnect failed.\n");
829                 return -1;
830         }
831
832         if (old_priv.identity != priv->identity ||
833             old_priv.model_id != priv->model_id ||
834             old_priv.capabilities != priv->capabilities ||
835             old_priv.ext_cap != priv->ext_cap) {
836                 printk(KERN_ERR "Synaptics hardware appears to be different: "
837                         "id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
838                         old_priv.identity, priv->identity,
839                         old_priv.model_id, priv->model_id,
840                         old_priv.capabilities, priv->capabilities,
841                         old_priv.ext_cap, priv->ext_cap);
842                 return -1;
843         }
844
845         return 0;
846 }
847
848 static bool impaired_toshiba_kbc;
849
850 static const struct dmi_system_id __initconst toshiba_dmi_table[] = {
851 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
852         {
853                 /* Toshiba Satellite */
854                 .matches = {
855                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
856                         DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
857                 },
858         },
859         {
860                 /* Toshiba Dynabook */
861                 .matches = {
862                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
863                         DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
864                 },
865         },
866         {
867                 /* Toshiba Portege M300 */
868                 .matches = {
869                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
870                         DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
871                 },
872
873         },
874         {
875                 /* Toshiba Portege M300 */
876                 .matches = {
877                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
878                         DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
879                         DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
880                 },
881
882         },
883 #endif
884         { }
885 };
886
887 static bool broken_olpc_ec;
888
889 static const struct dmi_system_id __initconst olpc_dmi_table[] = {
890 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
891         {
892                 /* OLPC XO-1 or XO-1.5 */
893                 .matches = {
894                         DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
895                         DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
896                 },
897         },
898 #endif
899         { }
900 };
901
902 void __init synaptics_module_init(void)
903 {
904         impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
905         broken_olpc_ec = dmi_check_system(olpc_dmi_table);
906 }
907
908 int synaptics_init(struct psmouse *psmouse)
909 {
910         struct synaptics_data *priv;
911
912         /*
913          * The OLPC XO has issues with Synaptics' absolute mode; similarly to
914          * the HGPK, it quickly degrades and the hardware becomes jumpy and
915          * overly sensitive.  Not only that, but the constant packet spew
916          * (even at a lowered 40pps rate) overloads the EC such that key
917          * presses on the keyboard are missed.  Given all of that, don't
918          * even attempt to use Synaptics mode.  Relative mode seems to work
919          * just fine.
920          */
921         if (broken_olpc_ec) {
922                 printk(KERN_INFO "synaptics: OLPC XO detected, not enabling Synaptics protocol.\n");
923                 return -ENODEV;
924         }
925
926         psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
927         if (!priv)
928                 return -ENOMEM;
929
930         psmouse_reset(psmouse);
931
932         if (synaptics_query_hardware(psmouse)) {
933                 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
934                 goto init_fail;
935         }
936
937         if (synaptics_set_absolute_mode(psmouse)) {
938                 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
939                 goto init_fail;
940         }
941
942         if (synaptics_set_advanced_gesture_mode(psmouse)) {
943                 printk(KERN_ERR "Advanced gesture mode init failed.\n");
944                 goto init_fail;
945         }
946
947         priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
948
949         printk(KERN_INFO "Synaptics Touchpad, model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx\n",
950                 SYN_ID_MODEL(priv->identity),
951                 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
952                 priv->model_id, priv->capabilities, priv->ext_cap, priv->ext_cap_0c);
953
954         set_input_params(psmouse->dev, priv);
955
956         /*
957          * Encode touchpad model so that it can be used to set
958          * input device->id.version and be visible to userspace.
959          * Because version is __u16 we have to drop something.
960          * Hardware info bits seem to be good candidates as they
961          * are documented to be for Synaptics corp. internal use.
962          */
963         psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
964                           (priv->model_id & 0x000000ff);
965
966         psmouse->protocol_handler = synaptics_process_byte;
967         psmouse->set_rate = synaptics_set_rate;
968         psmouse->disconnect = synaptics_disconnect;
969         psmouse->reconnect = synaptics_reconnect;
970         psmouse->cleanup = synaptics_reset;
971         psmouse->pktsize = 6;
972         /* Synaptics can usually stay in sync without extra help */
973         psmouse->resync_time = 0;
974
975         if (SYN_CAP_PASS_THROUGH(priv->capabilities))
976                 synaptics_pt_create(psmouse);
977
978         /*
979          * Toshiba's KBC seems to have trouble handling data from
980          * Synaptics at full rate.  Switch to a lower rate (roughly
981          * the same rate as a standard PS/2 mouse).
982          */
983         if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
984                 printk(KERN_INFO "synaptics: Toshiba %s detected, limiting rate to 40pps.\n",
985                         dmi_get_system_info(DMI_PRODUCT_NAME));
986                 psmouse->rate = 40;
987         }
988
989         return 0;
990
991  init_fail:
992         kfree(priv);
993         return -1;
994 }
995
996 bool synaptics_supported(void)
997 {
998         return true;
999 }
1000
1001 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1002
1003 void __init synaptics_module_init(void)
1004 {
1005 }
1006
1007 int synaptics_init(struct psmouse *psmouse)
1008 {
1009         return -ENOSYS;
1010 }
1011
1012 bool synaptics_supported(void)
1013 {
1014         return false;
1015 }
1016
1017 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */