xref: /linux/drivers/input/mouse/synaptics.c (revision 9d14070f656addddce3d63fd483de46930b51850)
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/delay.h>
28 #include <linux/dmi.h>
29 #include <linux/input/mt.h>
30 #include <linux/serio.h>
31 #include <linux/libps2.h>
32 #include <linux/slab.h>
33 #include "psmouse.h"
34 #include "synaptics.h"
35 
36 /*
37  * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
38  * section 2.3.2, which says that they should be valid regardless of the
39  * actual size of the sensor.
40  * Note that newer firmware allows querying device for maximum useable
41  * coordinates.
42  */
43 #define XMIN_NOMINAL 1472
44 #define XMAX_NOMINAL 5472
45 #define YMIN_NOMINAL 1408
46 #define YMAX_NOMINAL 4448
47 
48 /*
49  * Synaptics touchpads report the y coordinate from bottom to top, which is
50  * opposite from what userspace expects.
51  * This function is used to invert y before reporting.
52  */
53 static int synaptics_invert_y(int y)
54 {
55 	return YMAX_NOMINAL + YMIN_NOMINAL - y;
56 }
57 
58 
59 /*****************************************************************************
60  *	Stuff we need even when we do not want native Synaptics support
61  ****************************************************************************/
62 
63 /*
64  * Set the synaptics touchpad mode byte by special commands
65  */
66 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
67 {
68 	unsigned char param[1];
69 
70 	if (psmouse_sliced_command(psmouse, mode))
71 		return -1;
72 	param[0] = SYN_PS_SET_MODE2;
73 	if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
74 		return -1;
75 	return 0;
76 }
77 
78 int synaptics_detect(struct psmouse *psmouse, bool set_properties)
79 {
80 	struct ps2dev *ps2dev = &psmouse->ps2dev;
81 	unsigned char param[4];
82 
83 	param[0] = 0;
84 
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_SETRES);
89 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
90 
91 	if (param[1] != 0x47)
92 		return -ENODEV;
93 
94 	if (set_properties) {
95 		psmouse->vendor = "Synaptics";
96 		psmouse->name = "TouchPad";
97 	}
98 
99 	return 0;
100 }
101 
102 void synaptics_reset(struct psmouse *psmouse)
103 {
104 	/* reset touchpad back to relative mode, gestures enabled */
105 	synaptics_mode_cmd(psmouse, 0);
106 }
107 
108 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
109 
110 /*****************************************************************************
111  *	Synaptics communications functions
112  ****************************************************************************/
113 
114 /*
115  * Send a command to the synpatics touchpad by special commands
116  */
117 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
118 {
119 	if (psmouse_sliced_command(psmouse, c))
120 		return -1;
121 	if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
122 		return -1;
123 	return 0;
124 }
125 
126 /*
127  * Read the model-id bytes from the touchpad
128  * see also SYN_MODEL_* macros
129  */
130 static int synaptics_model_id(struct psmouse *psmouse)
131 {
132 	struct synaptics_data *priv = psmouse->private;
133 	unsigned char mi[3];
134 
135 	if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
136 		return -1;
137 	priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
138 	return 0;
139 }
140 
141 /*
142  * Read the capability-bits from the touchpad
143  * see also the SYN_CAP_* macros
144  */
145 static int synaptics_capability(struct psmouse *psmouse)
146 {
147 	struct synaptics_data *priv = psmouse->private;
148 	unsigned char cap[3];
149 
150 	if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
151 		return -1;
152 	priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
153 	priv->ext_cap = priv->ext_cap_0c = 0;
154 
155 	/*
156 	 * Older firmwares had submodel ID fixed to 0x47
157 	 */
158 	if (SYN_ID_FULL(priv->identity) < 0x705 &&
159 	    SYN_CAP_SUBMODEL_ID(priv->capabilities) != 0x47) {
160 		return -1;
161 	}
162 
163 	/*
164 	 * Unless capExtended is set the rest of the flags should be ignored
165 	 */
166 	if (!SYN_CAP_EXTENDED(priv->capabilities))
167 		priv->capabilities = 0;
168 
169 	if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
170 		if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
171 			psmouse_warn(psmouse,
172 				     "device claims to have extended capabilities, but I'm not able to read them.\n");
173 		} else {
174 			priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
175 
176 			/*
177 			 * if nExtBtn is greater than 8 it should be considered
178 			 * invalid and treated as 0
179 			 */
180 			if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
181 				priv->ext_cap &= 0xff0fff;
182 		}
183 	}
184 
185 	if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 4) {
186 		if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB_0C, cap)) {
187 			psmouse_warn(psmouse,
188 				     "device claims to have extended capability 0x0c, but I'm not able to read it.\n");
189 		} else {
190 			priv->ext_cap_0c = (cap[0] << 16) | (cap[1] << 8) | cap[2];
191 		}
192 	}
193 
194 	return 0;
195 }
196 
197 /*
198  * Identify Touchpad
199  * See also the SYN_ID_* macros
200  */
201 static int synaptics_identify(struct psmouse *psmouse)
202 {
203 	struct synaptics_data *priv = psmouse->private;
204 	unsigned char id[3];
205 
206 	if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
207 		return -1;
208 	priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
209 	if (SYN_ID_IS_SYNAPTICS(priv->identity))
210 		return 0;
211 	return -1;
212 }
213 
214 /*
215  * Read touchpad resolution and maximum reported coordinates
216  * Resolution is left zero if touchpad does not support the query
217  */
218 static int synaptics_resolution(struct psmouse *psmouse)
219 {
220 	struct synaptics_data *priv = psmouse->private;
221 	unsigned char resp[3];
222 
223 	if (SYN_ID_MAJOR(priv->identity) < 4)
224 		return 0;
225 
226 	if (synaptics_send_cmd(psmouse, SYN_QUE_RESOLUTION, resp) == 0) {
227 		if (resp[0] != 0 && (resp[1] & 0x80) && resp[2] != 0) {
228 			priv->x_res = resp[0]; /* x resolution in units/mm */
229 			priv->y_res = resp[2]; /* y resolution in units/mm */
230 		}
231 	}
232 
233 	if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 5 &&
234 	    SYN_CAP_MAX_DIMENSIONS(priv->ext_cap_0c)) {
235 		if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MAX_COORDS, resp)) {
236 			psmouse_warn(psmouse,
237 				     "device claims to have max coordinates query, but I'm not able to read it.\n");
238 		} else {
239 			priv->x_max = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
240 			priv->y_max = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
241 		}
242 	}
243 
244 	if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 7 &&
245 	    SYN_CAP_MIN_DIMENSIONS(priv->ext_cap_0c)) {
246 		if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_MIN_COORDS, resp)) {
247 			psmouse_warn(psmouse,
248 				     "device claims to have min coordinates query, but I'm not able to read it.\n");
249 		} else {
250 			priv->x_min = (resp[0] << 5) | ((resp[1] & 0x0f) << 1);
251 			priv->y_min = (resp[2] << 5) | ((resp[1] & 0xf0) >> 3);
252 		}
253 	}
254 
255 	return 0;
256 }
257 
258 static int synaptics_query_hardware(struct psmouse *psmouse)
259 {
260 	if (synaptics_identify(psmouse))
261 		return -1;
262 	if (synaptics_model_id(psmouse))
263 		return -1;
264 	if (synaptics_capability(psmouse))
265 		return -1;
266 	if (synaptics_resolution(psmouse))
267 		return -1;
268 
269 	return 0;
270 }
271 
272 static int synaptics_set_absolute_mode(struct psmouse *psmouse)
273 {
274 	struct synaptics_data *priv = psmouse->private;
275 
276 	priv->mode = SYN_BIT_ABSOLUTE_MODE;
277 	if (SYN_ID_MAJOR(priv->identity) >= 4)
278 		priv->mode |= SYN_BIT_DISABLE_GESTURE;
279 	if (SYN_CAP_EXTENDED(priv->capabilities))
280 		priv->mode |= SYN_BIT_W_MODE;
281 
282 	if (synaptics_mode_cmd(psmouse, priv->mode))
283 		return -1;
284 
285 	return 0;
286 }
287 
288 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
289 {
290 	struct synaptics_data *priv = psmouse->private;
291 
292 	if (rate >= 80) {
293 		priv->mode |= SYN_BIT_HIGH_RATE;
294 		psmouse->rate = 80;
295 	} else {
296 		priv->mode &= ~SYN_BIT_HIGH_RATE;
297 		psmouse->rate = 40;
298 	}
299 
300 	synaptics_mode_cmd(psmouse, priv->mode);
301 }
302 
303 static int synaptics_set_advanced_gesture_mode(struct psmouse *psmouse)
304 {
305 	static unsigned char param = 0xc8;
306 	struct synaptics_data *priv = psmouse->private;
307 
308 	if (!(SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
309 			SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)))
310 		return 0;
311 
312 	if (psmouse_sliced_command(psmouse, SYN_QUE_MODEL))
313 		return -1;
314 	if (ps2_command(&psmouse->ps2dev, &param, PSMOUSE_CMD_SETRATE))
315 		return -1;
316 
317 	/* Advanced gesture mode also sends multi finger data */
318 	priv->capabilities |= BIT(1);
319 
320 	return 0;
321 }
322 
323 /*****************************************************************************
324  *	Synaptics pass-through PS/2 port support
325  ****************************************************************************/
326 static int synaptics_pt_write(struct serio *serio, unsigned char c)
327 {
328 	struct psmouse *parent = serio_get_drvdata(serio->parent);
329 	char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
330 
331 	if (psmouse_sliced_command(parent, c))
332 		return -1;
333 	if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
334 		return -1;
335 	return 0;
336 }
337 
338 static int synaptics_pt_start(struct serio *serio)
339 {
340 	struct psmouse *parent = serio_get_drvdata(serio->parent);
341 	struct synaptics_data *priv = parent->private;
342 
343 	serio_pause_rx(parent->ps2dev.serio);
344 	priv->pt_port = serio;
345 	serio_continue_rx(parent->ps2dev.serio);
346 
347 	return 0;
348 }
349 
350 static void synaptics_pt_stop(struct serio *serio)
351 {
352 	struct psmouse *parent = serio_get_drvdata(serio->parent);
353 	struct synaptics_data *priv = parent->private;
354 
355 	serio_pause_rx(parent->ps2dev.serio);
356 	priv->pt_port = NULL;
357 	serio_continue_rx(parent->ps2dev.serio);
358 }
359 
360 static int synaptics_is_pt_packet(unsigned char *buf)
361 {
362 	return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
363 }
364 
365 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
366 {
367 	struct psmouse *child = serio_get_drvdata(ptport);
368 
369 	if (child && child->state == PSMOUSE_ACTIVATED) {
370 		serio_interrupt(ptport, packet[1], 0);
371 		serio_interrupt(ptport, packet[4], 0);
372 		serio_interrupt(ptport, packet[5], 0);
373 		if (child->pktsize == 4)
374 			serio_interrupt(ptport, packet[2], 0);
375 	} else
376 		serio_interrupt(ptport, packet[1], 0);
377 }
378 
379 static void synaptics_pt_activate(struct psmouse *psmouse)
380 {
381 	struct synaptics_data *priv = psmouse->private;
382 	struct psmouse *child = serio_get_drvdata(priv->pt_port);
383 
384 	/* adjust the touchpad to child's choice of protocol */
385 	if (child) {
386 		if (child->pktsize == 4)
387 			priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
388 		else
389 			priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
390 
391 		if (synaptics_mode_cmd(psmouse, priv->mode))
392 			psmouse_warn(psmouse,
393 				     "failed to switch guest protocol\n");
394 	}
395 }
396 
397 static void synaptics_pt_create(struct psmouse *psmouse)
398 {
399 	struct serio *serio;
400 
401 	serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
402 	if (!serio) {
403 		psmouse_err(psmouse,
404 			    "not enough memory for pass-through port\n");
405 		return;
406 	}
407 
408 	serio->id.type = SERIO_PS_PSTHRU;
409 	strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
410 	strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
411 	serio->write = synaptics_pt_write;
412 	serio->start = synaptics_pt_start;
413 	serio->stop = synaptics_pt_stop;
414 	serio->parent = psmouse->ps2dev.serio;
415 
416 	psmouse->pt_activate = synaptics_pt_activate;
417 
418 	psmouse_info(psmouse, "serio: %s port at %s\n",
419 		     serio->name, psmouse->phys);
420 	serio_register_port(serio);
421 }
422 
423 /*****************************************************************************
424  *	Functions to interpret the absolute mode packets
425  ****************************************************************************/
426 
427 static void synaptics_mt_state_set(struct synaptics_mt_state *state, int count,
428 				   int sgm, int agm)
429 {
430 	state->count = count;
431 	state->sgm = sgm;
432 	state->agm = agm;
433 }
434 
435 static void synaptics_parse_agm(const unsigned char buf[],
436 				struct synaptics_data *priv,
437 				struct synaptics_hw_state *hw)
438 {
439 	struct synaptics_hw_state *agm = &priv->agm;
440 	int agm_packet_type;
441 
442 	agm_packet_type = (buf[5] & 0x30) >> 4;
443 	switch (agm_packet_type) {
444 	case 1:
445 		/* Gesture packet: (x, y, z) half resolution */
446 		agm->w = hw->w;
447 		agm->x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
448 		agm->y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
449 		agm->z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
450 		break;
451 
452 	case 2:
453 		/* AGM-CONTACT packet: (count, sgm, agm) */
454 		synaptics_mt_state_set(&agm->mt_state, buf[1], buf[2], buf[4]);
455 		break;
456 
457 	default:
458 		break;
459 	}
460 
461 	/* Record that at least one AGM has been received since last SGM */
462 	priv->agm_pending = true;
463 }
464 
465 static int synaptics_parse_hw_state(const unsigned char buf[],
466 				    struct synaptics_data *priv,
467 				    struct synaptics_hw_state *hw)
468 {
469 	memset(hw, 0, sizeof(struct synaptics_hw_state));
470 
471 	if (SYN_MODEL_NEWABS(priv->model_id)) {
472 		hw->w = (((buf[0] & 0x30) >> 2) |
473 			 ((buf[0] & 0x04) >> 1) |
474 			 ((buf[3] & 0x04) >> 2));
475 
476 		hw->left  = (buf[0] & 0x01) ? 1 : 0;
477 		hw->right = (buf[0] & 0x02) ? 1 : 0;
478 
479 		if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
480 			/*
481 			 * Clickpad's button is transmitted as middle button,
482 			 * however, since it is primary button, we will report
483 			 * it as BTN_LEFT.
484 			 */
485 			hw->left = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
486 
487 		} else if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
488 			hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
489 			if (hw->w == 2)
490 				hw->scroll = (signed char)(buf[1]);
491 		}
492 
493 		if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
494 			hw->up   = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
495 			hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
496 		}
497 
498 		if ((SYN_CAP_ADV_GESTURE(priv->ext_cap_0c) ||
499 			SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) &&
500 		    hw->w == 2) {
501 			synaptics_parse_agm(buf, priv, hw);
502 			return 1;
503 		}
504 
505 		hw->x = (((buf[3] & 0x10) << 8) |
506 			 ((buf[1] & 0x0f) << 8) |
507 			 buf[4]);
508 		hw->y = (((buf[3] & 0x20) << 7) |
509 			 ((buf[1] & 0xf0) << 4) |
510 			 buf[5]);
511 		hw->z = buf[2];
512 
513 		if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
514 		    ((buf[0] ^ buf[3]) & 0x02)) {
515 			switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
516 			default:
517 				/*
518 				 * if nExtBtn is greater than 8 it should be
519 				 * considered invalid and treated as 0
520 				 */
521 				break;
522 			case 8:
523 				hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
524 				hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
525 			case 6:
526 				hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
527 				hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
528 			case 4:
529 				hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
530 				hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
531 			case 2:
532 				hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
533 				hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
534 			}
535 		}
536 	} else {
537 		hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
538 		hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
539 
540 		hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
541 		hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
542 
543 		hw->left  = (buf[0] & 0x01) ? 1 : 0;
544 		hw->right = (buf[0] & 0x02) ? 1 : 0;
545 	}
546 
547 	return 0;
548 }
549 
550 static void synaptics_report_semi_mt_slot(struct input_dev *dev, int slot,
551 					  bool active, int x, int y)
552 {
553 	input_mt_slot(dev, slot);
554 	input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
555 	if (active) {
556 		input_report_abs(dev, ABS_MT_POSITION_X, x);
557 		input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(y));
558 	}
559 }
560 
561 static void synaptics_report_semi_mt_data(struct input_dev *dev,
562 					  const struct synaptics_hw_state *a,
563 					  const struct synaptics_hw_state *b,
564 					  int num_fingers)
565 {
566 	if (num_fingers >= 2) {
567 		synaptics_report_semi_mt_slot(dev, 0, true, min(a->x, b->x),
568 					      min(a->y, b->y));
569 		synaptics_report_semi_mt_slot(dev, 1, true, max(a->x, b->x),
570 					      max(a->y, b->y));
571 	} else if (num_fingers == 1) {
572 		synaptics_report_semi_mt_slot(dev, 0, true, a->x, a->y);
573 		synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
574 	} else {
575 		synaptics_report_semi_mt_slot(dev, 0, false, 0, 0);
576 		synaptics_report_semi_mt_slot(dev, 1, false, 0, 0);
577 	}
578 }
579 
580 static void synaptics_report_buttons(struct psmouse *psmouse,
581 				     const struct synaptics_hw_state *hw)
582 {
583 	struct input_dev *dev = psmouse->dev;
584 	struct synaptics_data *priv = psmouse->private;
585 	int i;
586 
587 	input_report_key(dev, BTN_LEFT, hw->left);
588 	input_report_key(dev, BTN_RIGHT, hw->right);
589 
590 	if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
591 		input_report_key(dev, BTN_MIDDLE, hw->middle);
592 
593 	if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
594 		input_report_key(dev, BTN_FORWARD, hw->up);
595 		input_report_key(dev, BTN_BACK, hw->down);
596 	}
597 
598 	for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
599 		input_report_key(dev, BTN_0 + i, hw->ext_buttons & (1 << i));
600 }
601 
602 static void synaptics_report_slot(struct input_dev *dev, int slot,
603 				  const struct synaptics_hw_state *hw)
604 {
605 	input_mt_slot(dev, slot);
606 	input_mt_report_slot_state(dev, MT_TOOL_FINGER, (hw != NULL));
607 	if (!hw)
608 		return;
609 
610 	input_report_abs(dev, ABS_MT_POSITION_X, hw->x);
611 	input_report_abs(dev, ABS_MT_POSITION_Y, synaptics_invert_y(hw->y));
612 	input_report_abs(dev, ABS_MT_PRESSURE, hw->z);
613 }
614 
615 static void synaptics_report_mt_data(struct psmouse *psmouse,
616 				     struct synaptics_mt_state *mt_state,
617 				     const struct synaptics_hw_state *sgm)
618 {
619 	struct input_dev *dev = psmouse->dev;
620 	struct synaptics_data *priv = psmouse->private;
621 	struct synaptics_hw_state *agm = &priv->agm;
622 	struct synaptics_mt_state *old = &priv->mt_state;
623 
624 	switch (mt_state->count) {
625 	case 0:
626 		synaptics_report_slot(dev, 0, NULL);
627 		synaptics_report_slot(dev, 1, NULL);
628 		break;
629 	case 1:
630 		if (mt_state->sgm == -1) {
631 			synaptics_report_slot(dev, 0, NULL);
632 			synaptics_report_slot(dev, 1, NULL);
633 		} else if (mt_state->sgm == 0) {
634 			synaptics_report_slot(dev, 0, sgm);
635 			synaptics_report_slot(dev, 1, NULL);
636 		} else {
637 			synaptics_report_slot(dev, 0, NULL);
638 			synaptics_report_slot(dev, 1, sgm);
639 		}
640 		break;
641 	default:
642 		/*
643 		 * If the finger slot contained in SGM is valid, and either
644 		 * hasn't changed, or is new, then report SGM in MTB slot 0.
645 		 * Otherwise, empty MTB slot 0.
646 		 */
647 		if (mt_state->sgm != -1 &&
648 		    (mt_state->sgm == old->sgm || old->sgm == -1))
649 			synaptics_report_slot(dev, 0, sgm);
650 		else
651 			synaptics_report_slot(dev, 0, NULL);
652 
653 		/*
654 		 * If the finger slot contained in AGM is valid, and either
655 		 * hasn't changed, or is new, then report AGM in MTB slot 1.
656 		 * Otherwise, empty MTB slot 1.
657 		 */
658 		if (mt_state->agm != -1 &&
659 		    (mt_state->agm == old->agm || old->agm == -1))
660 			synaptics_report_slot(dev, 1, agm);
661 		else
662 			synaptics_report_slot(dev, 1, NULL);
663 		break;
664 	}
665 
666 	/* Don't use active slot count to generate BTN_TOOL events. */
667 	input_mt_report_pointer_emulation(dev, false);
668 
669 	/* Send the number of fingers reported by touchpad itself. */
670 	input_mt_report_finger_count(dev, mt_state->count);
671 
672 	synaptics_report_buttons(psmouse, sgm);
673 
674 	input_sync(dev);
675 }
676 
677 /* Handle case where mt_state->count = 0 */
678 static void synaptics_image_sensor_0f(struct synaptics_data *priv,
679 				      struct synaptics_mt_state *mt_state)
680 {
681 	synaptics_mt_state_set(mt_state, 0, -1, -1);
682 	priv->mt_state_lost = false;
683 }
684 
685 /* Handle case where mt_state->count = 1 */
686 static void synaptics_image_sensor_1f(struct synaptics_data *priv,
687 				      struct synaptics_mt_state *mt_state)
688 {
689 	struct synaptics_hw_state *agm = &priv->agm;
690 	struct synaptics_mt_state *old = &priv->mt_state;
691 
692 	/*
693 	 * If the last AGM was (0,0,0), and there is only one finger left,
694 	 * then we absolutely know that SGM contains slot 0, and all other
695 	 * fingers have been removed.
696 	 */
697 	if (priv->agm_pending && agm->z == 0) {
698 		synaptics_mt_state_set(mt_state, 1, 0, -1);
699 		priv->mt_state_lost = false;
700 		return;
701 	}
702 
703 	switch (old->count) {
704 	case 0:
705 		synaptics_mt_state_set(mt_state, 1, 0, -1);
706 		break;
707 	case 1:
708 		/*
709 		 * If mt_state_lost, then the previous transition was 3->1,
710 		 * and SGM now contains either slot 0 or 1, but we don't know
711 		 * which.  So, we just assume that the SGM now contains slot 1.
712 		 *
713 		 * If pending AGM and either:
714 		 *   (a) the previous SGM slot contains slot 0, or
715 		 *   (b) there was no SGM slot
716 		 * then, the SGM now contains slot 1
717 		 *
718 		 * Case (a) happens with very rapid "drum roll" gestures, where
719 		 * slot 0 finger is lifted and a new slot 1 finger touches
720 		 * within one reporting interval.
721 		 *
722 		 * Case (b) happens if initially two or more fingers tap
723 		 * briefly, and all but one lift before the end of the first
724 		 * reporting interval.
725 		 *
726 		 * (In both these cases, slot 0 will becomes empty, so SGM
727 		 * contains slot 1 with the new finger)
728 		 *
729 		 * Else, if there was no previous SGM, it now contains slot 0.
730 		 *
731 		 * Otherwise, SGM still contains the same slot.
732 		 */
733 		if (priv->mt_state_lost ||
734 		    (priv->agm_pending && old->sgm <= 0))
735 			synaptics_mt_state_set(mt_state, 1, 1, -1);
736 		else if (old->sgm == -1)
737 			synaptics_mt_state_set(mt_state, 1, 0, -1);
738 		break;
739 	case 2:
740 		/*
741 		 * If mt_state_lost, we don't know which finger SGM contains.
742 		 *
743 		 * So, report 1 finger, but with both slots empty.
744 		 * We will use slot 1 on subsequent 1->1
745 		 */
746 		if (priv->mt_state_lost) {
747 			synaptics_mt_state_set(mt_state, 1, -1, -1);
748 			break;
749 		}
750 		/*
751 		 * Since the last AGM was NOT (0,0,0), it was the finger in
752 		 * slot 0 that has been removed.
753 		 * So, SGM now contains previous AGM's slot, and AGM is now
754 		 * empty.
755 		 */
756 		synaptics_mt_state_set(mt_state, 1, old->agm, -1);
757 		break;
758 	case 3:
759 		/*
760 		 * Since last AGM was not (0,0,0), we don't know which finger
761 		 * is left.
762 		 *
763 		 * So, report 1 finger, but with both slots empty.
764 		 * We will use slot 1 on subsequent 1->1
765 		 */
766 		synaptics_mt_state_set(mt_state, 1, -1, -1);
767 		priv->mt_state_lost = true;
768 		break;
769 	case 4:
770 	case 5:
771 		/* mt_state was updated by AGM-CONTACT packet */
772 		break;
773 	}
774 }
775 
776 /* Handle case where mt_state->count = 2 */
777 static void synaptics_image_sensor_2f(struct synaptics_data *priv,
778 				      struct synaptics_mt_state *mt_state)
779 {
780 	struct synaptics_mt_state *old = &priv->mt_state;
781 
782 	switch (old->count) {
783 	case 0:
784 		synaptics_mt_state_set(mt_state, 2, 0, 1);
785 		break;
786 	case 1:
787 		/*
788 		 * If previous SGM contained slot 1 or higher, SGM now contains
789 		 * slot 0 (the newly touching finger) and AGM contains SGM's
790 		 * previous slot.
791 		 *
792 		 * Otherwise, SGM still contains slot 0 and AGM now contains
793 		 * slot 1.
794 		 */
795 		if (old->sgm >= 1)
796 			synaptics_mt_state_set(mt_state, 2, 0, old->sgm);
797 		else
798 			synaptics_mt_state_set(mt_state, 2, 0, 1);
799 		break;
800 	case 2:
801 		/*
802 		 * If mt_state_lost, SGM now contains either finger 1 or 2, but
803 		 * we don't know which.
804 		 * So, we just assume that the SGM contains slot 0 and AGM 1.
805 		 */
806 		if (priv->mt_state_lost)
807 			synaptics_mt_state_set(mt_state, 2, 0, 1);
808 		/*
809 		 * Otherwise, use the same mt_state, since it either hasn't
810 		 * changed, or was updated by a recently received AGM-CONTACT
811 		 * packet.
812 		 */
813 		break;
814 	case 3:
815 		/*
816 		 * 3->2 transitions have two unsolvable problems:
817 		 *  1) no indication is given which finger was removed
818 		 *  2) no way to tell if agm packet was for finger 3
819 		 *     before 3->2, or finger 2 after 3->2.
820 		 *
821 		 * So, report 2 fingers, but empty all slots.
822 		 * We will guess slots [0,1] on subsequent 2->2.
823 		 */
824 		synaptics_mt_state_set(mt_state, 2, -1, -1);
825 		priv->mt_state_lost = true;
826 		break;
827 	case 4:
828 	case 5:
829 		/* mt_state was updated by AGM-CONTACT packet */
830 		break;
831 	}
832 }
833 
834 /* Handle case where mt_state->count = 3 */
835 static void synaptics_image_sensor_3f(struct synaptics_data *priv,
836 				      struct synaptics_mt_state *mt_state)
837 {
838 	struct synaptics_mt_state *old = &priv->mt_state;
839 
840 	switch (old->count) {
841 	case 0:
842 		synaptics_mt_state_set(mt_state, 3, 0, 2);
843 		break;
844 	case 1:
845 		/*
846 		 * If previous SGM contained slot 2 or higher, SGM now contains
847 		 * slot 0 (one of the newly touching fingers) and AGM contains
848 		 * SGM's previous slot.
849 		 *
850 		 * Otherwise, SGM now contains slot 0 and AGM contains slot 2.
851 		 */
852 		if (old->sgm >= 2)
853 			synaptics_mt_state_set(mt_state, 3, 0, old->sgm);
854 		else
855 			synaptics_mt_state_set(mt_state, 3, 0, 2);
856 		break;
857 	case 2:
858 		/*
859 		 * If the AGM previously contained slot 3 or higher, then the
860 		 * newly touching finger is in the lowest available slot.
861 		 *
862 		 * If SGM was previously 1 or higher, then the new SGM is
863 		 * now slot 0 (with a new finger), otherwise, the new finger
864 		 * is now in a hidden slot between 0 and AGM's slot.
865 		 *
866 		 * In all such cases, the SGM now contains slot 0, and the AGM
867 		 * continues to contain the same slot as before.
868 		 */
869 		if (old->agm >= 3) {
870 			synaptics_mt_state_set(mt_state, 3, 0, old->agm);
871 			break;
872 		}
873 
874 		/*
875 		 * After some 3->1 and all 3->2 transitions, we lose track
876 		 * of which slot is reported by SGM and AGM.
877 		 *
878 		 * For 2->3 in this state, report 3 fingers, but empty all
879 		 * slots, and we will guess (0,2) on a subsequent 0->3.
880 		 *
881 		 * To userspace, the resulting transition will look like:
882 		 *    2:[0,1] -> 3:[-1,-1] -> 3:[0,2]
883 		 */
884 		if (priv->mt_state_lost) {
885 			synaptics_mt_state_set(mt_state, 3, -1, -1);
886 			break;
887 		}
888 
889 		/*
890 		 * If the (SGM,AGM) really previously contained slots (0, 1),
891 		 * then we cannot know what slot was just reported by the AGM,
892 		 * because the 2->3 transition can occur either before or after
893 		 * the AGM packet. Thus, this most recent AGM could contain
894 		 * either the same old slot 1 or the new slot 2.
895 		 * Subsequent AGMs will be reporting slot 2.
896 		 *
897 		 * To userspace, the resulting transition will look like:
898 		 *    2:[0,1] -> 3:[0,-1] -> 3:[0,2]
899 		 */
900 		synaptics_mt_state_set(mt_state, 3, 0, -1);
901 		break;
902 	case 3:
903 		/*
904 		 * If, for whatever reason, the previous agm was invalid,
905 		 * Assume SGM now contains slot 0, AGM now contains slot 2.
906 		 */
907 		if (old->agm <= 2)
908 			synaptics_mt_state_set(mt_state, 3, 0, 2);
909 		/*
910 		 * mt_state either hasn't changed, or was updated by a recently
911 		 * received AGM-CONTACT packet.
912 		 */
913 		break;
914 
915 	case 4:
916 	case 5:
917 		/* mt_state was updated by AGM-CONTACT packet */
918 		break;
919 	}
920 }
921 
922 /* Handle case where mt_state->count = 4, or = 5 */
923 static void synaptics_image_sensor_45f(struct synaptics_data *priv,
924 				       struct synaptics_mt_state *mt_state)
925 {
926 	/* mt_state was updated correctly by AGM-CONTACT packet */
927 	priv->mt_state_lost = false;
928 }
929 
930 static void synaptics_image_sensor_process(struct psmouse *psmouse,
931 					   struct synaptics_hw_state *sgm)
932 {
933 	struct synaptics_data *priv = psmouse->private;
934 	struct synaptics_hw_state *agm = &priv->agm;
935 	struct synaptics_mt_state mt_state;
936 
937 	/* Initialize using current mt_state (as updated by last agm) */
938 	mt_state = agm->mt_state;
939 
940 	/*
941 	 * Update mt_state using the new finger count and current mt_state.
942 	 */
943 	if (sgm->z == 0)
944 		synaptics_image_sensor_0f(priv, &mt_state);
945 	else if (sgm->w >= 4)
946 		synaptics_image_sensor_1f(priv, &mt_state);
947 	else if (sgm->w == 0)
948 		synaptics_image_sensor_2f(priv, &mt_state);
949 	else if (sgm->w == 1 && mt_state.count <= 3)
950 		synaptics_image_sensor_3f(priv, &mt_state);
951 	else
952 		synaptics_image_sensor_45f(priv, &mt_state);
953 
954 	/* Send resulting input events to user space */
955 	synaptics_report_mt_data(psmouse, &mt_state, sgm);
956 
957 	/* Store updated mt_state */
958 	priv->mt_state = agm->mt_state = mt_state;
959 	priv->agm_pending = false;
960 }
961 
962 /*
963  *  called for each full received packet from the touchpad
964  */
965 static void synaptics_process_packet(struct psmouse *psmouse)
966 {
967 	struct input_dev *dev = psmouse->dev;
968 	struct synaptics_data *priv = psmouse->private;
969 	struct synaptics_hw_state hw;
970 	int num_fingers;
971 	int finger_width;
972 
973 	if (synaptics_parse_hw_state(psmouse->packet, priv, &hw))
974 		return;
975 
976 	if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
977 		synaptics_image_sensor_process(psmouse, &hw);
978 		return;
979 	}
980 
981 	if (hw.scroll) {
982 		priv->scroll += hw.scroll;
983 
984 		while (priv->scroll >= 4) {
985 			input_report_key(dev, BTN_BACK, !hw.down);
986 			input_sync(dev);
987 			input_report_key(dev, BTN_BACK, hw.down);
988 			input_sync(dev);
989 			priv->scroll -= 4;
990 		}
991 		while (priv->scroll <= -4) {
992 			input_report_key(dev, BTN_FORWARD, !hw.up);
993 			input_sync(dev);
994 			input_report_key(dev, BTN_FORWARD, hw.up);
995 			input_sync(dev);
996 			priv->scroll += 4;
997 		}
998 		return;
999 	}
1000 
1001 	if (hw.z > 0 && hw.x > 1) {
1002 		num_fingers = 1;
1003 		finger_width = 5;
1004 		if (SYN_CAP_EXTENDED(priv->capabilities)) {
1005 			switch (hw.w) {
1006 			case 0 ... 1:
1007 				if (SYN_CAP_MULTIFINGER(priv->capabilities))
1008 					num_fingers = hw.w + 2;
1009 				break;
1010 			case 2:
1011 				if (SYN_MODEL_PEN(priv->model_id))
1012 					;   /* Nothing, treat a pen as a single finger */
1013 				break;
1014 			case 4 ... 15:
1015 				if (SYN_CAP_PALMDETECT(priv->capabilities))
1016 					finger_width = hw.w;
1017 				break;
1018 			}
1019 		}
1020 	} else {
1021 		num_fingers = 0;
1022 		finger_width = 0;
1023 	}
1024 
1025 	if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c))
1026 		synaptics_report_semi_mt_data(dev, &hw, &priv->agm,
1027 					      num_fingers);
1028 
1029 	/* Post events
1030 	 * BTN_TOUCH has to be first as mousedev relies on it when doing
1031 	 * absolute -> relative conversion
1032 	 */
1033 	if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
1034 	if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
1035 
1036 	if (num_fingers > 0) {
1037 		input_report_abs(dev, ABS_X, hw.x);
1038 		input_report_abs(dev, ABS_Y, synaptics_invert_y(hw.y));
1039 	}
1040 	input_report_abs(dev, ABS_PRESSURE, hw.z);
1041 
1042 	if (SYN_CAP_PALMDETECT(priv->capabilities))
1043 		input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
1044 
1045 	input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
1046 	if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1047 		input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
1048 		input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
1049 	}
1050 
1051 	synaptics_report_buttons(psmouse, &hw);
1052 
1053 	input_sync(dev);
1054 }
1055 
1056 static int synaptics_validate_byte(struct psmouse *psmouse,
1057 				   int idx, unsigned char pkt_type)
1058 {
1059 	static const unsigned char newabs_mask[]	= { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
1060 	static const unsigned char newabs_rel_mask[]	= { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
1061 	static const unsigned char newabs_rslt[]	= { 0x80, 0x00, 0x00, 0xC0, 0x00 };
1062 	static const unsigned char oldabs_mask[]	= { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
1063 	static const unsigned char oldabs_rslt[]	= { 0xC0, 0x00, 0x00, 0x80, 0x00 };
1064 	const char *packet = psmouse->packet;
1065 
1066 	if (idx < 0 || idx > 4)
1067 		return 0;
1068 
1069 	switch (pkt_type) {
1070 
1071 	case SYN_NEWABS:
1072 	case SYN_NEWABS_RELAXED:
1073 		return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
1074 
1075 	case SYN_NEWABS_STRICT:
1076 		return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
1077 
1078 	case SYN_OLDABS:
1079 		return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
1080 
1081 	default:
1082 		psmouse_err(psmouse, "unknown packet type %d\n", pkt_type);
1083 		return 0;
1084 	}
1085 }
1086 
1087 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
1088 {
1089 	int i;
1090 
1091 	for (i = 0; i < 5; i++)
1092 		if (!synaptics_validate_byte(psmouse, i, SYN_NEWABS_STRICT)) {
1093 			psmouse_info(psmouse, "using relaxed packet validation\n");
1094 			return SYN_NEWABS_RELAXED;
1095 		}
1096 
1097 	return SYN_NEWABS_STRICT;
1098 }
1099 
1100 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
1101 {
1102 	struct synaptics_data *priv = psmouse->private;
1103 
1104 	if (psmouse->pktcnt >= 6) { /* Full packet received */
1105 		if (unlikely(priv->pkt_type == SYN_NEWABS))
1106 			priv->pkt_type = synaptics_detect_pkt_type(psmouse);
1107 
1108 		if (SYN_CAP_PASS_THROUGH(priv->capabilities) &&
1109 		    synaptics_is_pt_packet(psmouse->packet)) {
1110 			if (priv->pt_port)
1111 				synaptics_pass_pt_packet(priv->pt_port, psmouse->packet);
1112 		} else
1113 			synaptics_process_packet(psmouse);
1114 
1115 		return PSMOUSE_FULL_PACKET;
1116 	}
1117 
1118 	return synaptics_validate_byte(psmouse, psmouse->pktcnt - 1, priv->pkt_type) ?
1119 		PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
1120 }
1121 
1122 /*****************************************************************************
1123  *	Driver initialization/cleanup functions
1124  ****************************************************************************/
1125 static void set_abs_position_params(struct input_dev *dev,
1126 				    struct synaptics_data *priv, int x_code,
1127 				    int y_code)
1128 {
1129 	int x_min = priv->x_min ?: XMIN_NOMINAL;
1130 	int x_max = priv->x_max ?: XMAX_NOMINAL;
1131 	int y_min = priv->y_min ?: YMIN_NOMINAL;
1132 	int y_max = priv->y_max ?: YMAX_NOMINAL;
1133 	int fuzz = SYN_CAP_REDUCED_FILTERING(priv->ext_cap_0c) ?
1134 			SYN_REDUCED_FILTER_FUZZ : 0;
1135 
1136 	input_set_abs_params(dev, x_code, x_min, x_max, fuzz, 0);
1137 	input_set_abs_params(dev, y_code, y_min, y_max, fuzz, 0);
1138 	input_abs_set_res(dev, x_code, priv->x_res);
1139 	input_abs_set_res(dev, y_code, priv->y_res);
1140 }
1141 
1142 static void set_input_params(struct input_dev *dev, struct synaptics_data *priv)
1143 {
1144 	int i;
1145 
1146 	__set_bit(INPUT_PROP_POINTER, dev->propbit);
1147 
1148 	__set_bit(EV_ABS, dev->evbit);
1149 	set_abs_position_params(dev, priv, ABS_X, ABS_Y);
1150 	input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
1151 
1152 	if (SYN_CAP_IMAGE_SENSOR(priv->ext_cap_0c)) {
1153 		input_mt_init_slots(dev, 2);
1154 		set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1155 					ABS_MT_POSITION_Y);
1156 		/* Image sensors can report per-contact pressure */
1157 		input_set_abs_params(dev, ABS_MT_PRESSURE, 0, 255, 0, 0);
1158 
1159 		/* Image sensors can signal 4 and 5 finger clicks */
1160 		__set_bit(BTN_TOOL_QUADTAP, dev->keybit);
1161 		__set_bit(BTN_TOOL_QUINTTAP, dev->keybit);
1162 	} else if (SYN_CAP_ADV_GESTURE(priv->ext_cap_0c)) {
1163 		/* Non-image sensors with AGM use semi-mt */
1164 		__set_bit(INPUT_PROP_SEMI_MT, dev->propbit);
1165 		input_mt_init_slots(dev, 2);
1166 		set_abs_position_params(dev, priv, ABS_MT_POSITION_X,
1167 					ABS_MT_POSITION_Y);
1168 	}
1169 
1170 	if (SYN_CAP_PALMDETECT(priv->capabilities))
1171 		input_set_abs_params(dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
1172 
1173 	__set_bit(EV_KEY, dev->evbit);
1174 	__set_bit(BTN_TOUCH, dev->keybit);
1175 	__set_bit(BTN_TOOL_FINGER, dev->keybit);
1176 	__set_bit(BTN_LEFT, dev->keybit);
1177 	__set_bit(BTN_RIGHT, dev->keybit);
1178 
1179 	if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
1180 		__set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
1181 		__set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
1182 	}
1183 
1184 	if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
1185 		__set_bit(BTN_MIDDLE, dev->keybit);
1186 
1187 	if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
1188 	    SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
1189 		__set_bit(BTN_FORWARD, dev->keybit);
1190 		__set_bit(BTN_BACK, dev->keybit);
1191 	}
1192 
1193 	for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
1194 		__set_bit(BTN_0 + i, dev->keybit);
1195 
1196 	__clear_bit(EV_REL, dev->evbit);
1197 	__clear_bit(REL_X, dev->relbit);
1198 	__clear_bit(REL_Y, dev->relbit);
1199 
1200 	if (SYN_CAP_CLICKPAD(priv->ext_cap_0c)) {
1201 		__set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
1202 		/* Clickpads report only left button */
1203 		__clear_bit(BTN_RIGHT, dev->keybit);
1204 		__clear_bit(BTN_MIDDLE, dev->keybit);
1205 	}
1206 }
1207 
1208 static void synaptics_disconnect(struct psmouse *psmouse)
1209 {
1210 	synaptics_reset(psmouse);
1211 	kfree(psmouse->private);
1212 	psmouse->private = NULL;
1213 }
1214 
1215 static int synaptics_reconnect(struct psmouse *psmouse)
1216 {
1217 	struct synaptics_data *priv = psmouse->private;
1218 	struct synaptics_data old_priv = *priv;
1219 	int retry = 0;
1220 	int error;
1221 
1222 	do {
1223 		psmouse_reset(psmouse);
1224 		if (retry) {
1225 			/*
1226 			 * On some boxes, right after resuming, the touchpad
1227 			 * needs some time to finish initializing (I assume
1228 			 * it needs time to calibrate) and start responding
1229 			 * to Synaptics-specific queries, so let's wait a
1230 			 * bit.
1231 			 */
1232 			ssleep(1);
1233 		}
1234 		error = synaptics_detect(psmouse, 0);
1235 	} while (error && ++retry < 3);
1236 
1237 	if (error)
1238 		return -1;
1239 
1240 	if (retry > 1)
1241 		psmouse_dbg(psmouse, "reconnected after %d tries\n", retry);
1242 
1243 	if (synaptics_query_hardware(psmouse)) {
1244 		psmouse_err(psmouse, "Unable to query device.\n");
1245 		return -1;
1246 	}
1247 
1248 	if (synaptics_set_absolute_mode(psmouse)) {
1249 		psmouse_err(psmouse, "Unable to initialize device.\n");
1250 		return -1;
1251 	}
1252 
1253 	if (synaptics_set_advanced_gesture_mode(psmouse)) {
1254 		psmouse_err(psmouse,
1255 			    "Advanced gesture mode reconnect failed.\n");
1256 		return -1;
1257 	}
1258 
1259 	if (old_priv.identity != priv->identity ||
1260 	    old_priv.model_id != priv->model_id ||
1261 	    old_priv.capabilities != priv->capabilities ||
1262 	    old_priv.ext_cap != priv->ext_cap) {
1263 		psmouse_err(psmouse,
1264 			    "hardware appears to be different: id(%ld-%ld), model(%ld-%ld), caps(%lx-%lx), ext(%lx-%lx).\n",
1265 			    old_priv.identity, priv->identity,
1266 			    old_priv.model_id, priv->model_id,
1267 			    old_priv.capabilities, priv->capabilities,
1268 			    old_priv.ext_cap, priv->ext_cap);
1269 		return -1;
1270 	}
1271 
1272 	return 0;
1273 }
1274 
1275 static bool impaired_toshiba_kbc;
1276 
1277 static const struct dmi_system_id __initconst toshiba_dmi_table[] = {
1278 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1279 	{
1280 		/* Toshiba Satellite */
1281 		.matches = {
1282 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1283 			DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
1284 		},
1285 	},
1286 	{
1287 		/* Toshiba Dynabook */
1288 		.matches = {
1289 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1290 			DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
1291 		},
1292 	},
1293 	{
1294 		/* Toshiba Portege M300 */
1295 		.matches = {
1296 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1297 			DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
1298 		},
1299 
1300 	},
1301 	{
1302 		/* Toshiba Portege M300 */
1303 		.matches = {
1304 			DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1305 			DMI_MATCH(DMI_PRODUCT_NAME, "Portable PC"),
1306 			DMI_MATCH(DMI_PRODUCT_VERSION, "Version 1.0"),
1307 		},
1308 
1309 	},
1310 #endif
1311 	{ }
1312 };
1313 
1314 static bool broken_olpc_ec;
1315 
1316 static const struct dmi_system_id __initconst olpc_dmi_table[] = {
1317 #if defined(CONFIG_DMI) && defined(CONFIG_OLPC)
1318 	{
1319 		/* OLPC XO-1 or XO-1.5 */
1320 		.matches = {
1321 			DMI_MATCH(DMI_SYS_VENDOR, "OLPC"),
1322 			DMI_MATCH(DMI_PRODUCT_NAME, "XO"),
1323 		},
1324 	},
1325 #endif
1326 	{ }
1327 };
1328 
1329 void __init synaptics_module_init(void)
1330 {
1331 	impaired_toshiba_kbc = dmi_check_system(toshiba_dmi_table);
1332 	broken_olpc_ec = dmi_check_system(olpc_dmi_table);
1333 }
1334 
1335 int synaptics_init(struct psmouse *psmouse)
1336 {
1337 	struct synaptics_data *priv;
1338 
1339 	/*
1340 	 * The OLPC XO has issues with Synaptics' absolute mode; similarly to
1341 	 * the HGPK, it quickly degrades and the hardware becomes jumpy and
1342 	 * overly sensitive.  Not only that, but the constant packet spew
1343 	 * (even at a lowered 40pps rate) overloads the EC such that key
1344 	 * presses on the keyboard are missed.  Given all of that, don't
1345 	 * even attempt to use Synaptics mode.  Relative mode seems to work
1346 	 * just fine.
1347 	 */
1348 	if (broken_olpc_ec) {
1349 		psmouse_info(psmouse,
1350 			     "OLPC XO detected, not enabling Synaptics protocol.\n");
1351 		return -ENODEV;
1352 	}
1353 
1354 	psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
1355 	if (!priv)
1356 		return -ENOMEM;
1357 
1358 	psmouse_reset(psmouse);
1359 
1360 	if (synaptics_query_hardware(psmouse)) {
1361 		psmouse_err(psmouse, "Unable to query device.\n");
1362 		goto init_fail;
1363 	}
1364 
1365 	if (synaptics_set_absolute_mode(psmouse)) {
1366 		psmouse_err(psmouse, "Unable to initialize device.\n");
1367 		goto init_fail;
1368 	}
1369 
1370 	if (synaptics_set_advanced_gesture_mode(psmouse)) {
1371 		psmouse_err(psmouse, "Advanced gesture mode init failed.\n");
1372 		goto init_fail;
1373 	}
1374 
1375 	priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
1376 
1377 	psmouse_info(psmouse,
1378 		     "Touchpad model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx/%#lx\n",
1379 		     SYN_ID_MODEL(priv->identity),
1380 		     SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
1381 		     priv->model_id,
1382 		     priv->capabilities, priv->ext_cap, priv->ext_cap_0c);
1383 
1384 	set_input_params(psmouse->dev, priv);
1385 
1386 	/*
1387 	 * Encode touchpad model so that it can be used to set
1388 	 * input device->id.version and be visible to userspace.
1389 	 * Because version is __u16 we have to drop something.
1390 	 * Hardware info bits seem to be good candidates as they
1391 	 * are documented to be for Synaptics corp. internal use.
1392 	 */
1393 	psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
1394 			  (priv->model_id & 0x000000ff);
1395 
1396 	psmouse->protocol_handler = synaptics_process_byte;
1397 	psmouse->set_rate = synaptics_set_rate;
1398 	psmouse->disconnect = synaptics_disconnect;
1399 	psmouse->reconnect = synaptics_reconnect;
1400 	psmouse->cleanup = synaptics_reset;
1401 	psmouse->pktsize = 6;
1402 	/* Synaptics can usually stay in sync without extra help */
1403 	psmouse->resync_time = 0;
1404 
1405 	if (SYN_CAP_PASS_THROUGH(priv->capabilities))
1406 		synaptics_pt_create(psmouse);
1407 
1408 	/*
1409 	 * Toshiba's KBC seems to have trouble handling data from
1410 	 * Synaptics at full rate.  Switch to a lower rate (roughly
1411 	 * the same rate as a standard PS/2 mouse).
1412 	 */
1413 	if (psmouse->rate >= 80 && impaired_toshiba_kbc) {
1414 		psmouse_info(psmouse,
1415 			     "Toshiba %s detected, limiting rate to 40pps.\n",
1416 			     dmi_get_system_info(DMI_PRODUCT_NAME));
1417 		psmouse->rate = 40;
1418 	}
1419 
1420 	return 0;
1421 
1422  init_fail:
1423 	kfree(priv);
1424 	return -1;
1425 }
1426 
1427 bool synaptics_supported(void)
1428 {
1429 	return true;
1430 }
1431 
1432 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
1433 
1434 void __init synaptics_module_init(void)
1435 {
1436 }
1437 
1438 int synaptics_init(struct psmouse *psmouse)
1439 {
1440 	return -ENOSYS;
1441 }
1442 
1443 bool synaptics_supported(void)
1444 {
1445 	return false;
1446 }
1447 
1448 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */
1449