xref: /linux/drivers/input/mouse/psmouse-base.c (revision 273b281fa22c293963ee3e6eec418f5dda2dbc83)
1 /*
2  * PS/2 mouse driver
3  *
4  * Copyright (c) 1999-2002 Vojtech Pavlik
5  * Copyright (c) 2003-2004 Dmitry Torokhov
6  */
7 
8 /*
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU General Public License version 2 as published by
11  * the Free Software Foundation.
12  */
13 
14 #include <linux/delay.h>
15 #include <linux/module.h>
16 #include <linux/slab.h>
17 #include <linux/interrupt.h>
18 #include <linux/input.h>
19 #include <linux/serio.h>
20 #include <linux/init.h>
21 #include <linux/libps2.h>
22 #include <linux/mutex.h>
23 
24 #include "psmouse.h"
25 #include "synaptics.h"
26 #include "logips2pp.h"
27 #include "alps.h"
28 #include "hgpk.h"
29 #include "lifebook.h"
30 #include "trackpoint.h"
31 #include "touchkit_ps2.h"
32 #include "elantech.h"
33 #include "sentelic.h"
34 
35 #define DRIVER_DESC	"PS/2 mouse driver"
36 
37 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
38 MODULE_DESCRIPTION(DRIVER_DESC);
39 MODULE_LICENSE("GPL");
40 
41 static unsigned int psmouse_max_proto = PSMOUSE_AUTO;
42 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp);
43 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp);
44 #define param_check_proto_abbrev(name, p)	__param_check(name, p, unsigned int)
45 #define param_set_proto_abbrev			psmouse_set_maxproto
46 #define param_get_proto_abbrev			psmouse_get_maxproto
47 module_param_named(proto, psmouse_max_proto, proto_abbrev, 0644);
48 MODULE_PARM_DESC(proto, "Highest protocol extension to probe (bare, imps, exps, any). Useful for KVM switches.");
49 
50 static unsigned int psmouse_resolution = 200;
51 module_param_named(resolution, psmouse_resolution, uint, 0644);
52 MODULE_PARM_DESC(resolution, "Resolution, in dpi.");
53 
54 static unsigned int psmouse_rate = 100;
55 module_param_named(rate, psmouse_rate, uint, 0644);
56 MODULE_PARM_DESC(rate, "Report rate, in reports per second.");
57 
58 static unsigned int psmouse_smartscroll = 1;
59 module_param_named(smartscroll, psmouse_smartscroll, bool, 0644);
60 MODULE_PARM_DESC(smartscroll, "Logitech Smartscroll autorepeat, 1 = enabled (default), 0 = disabled.");
61 
62 static unsigned int psmouse_resetafter = 5;
63 module_param_named(resetafter, psmouse_resetafter, uint, 0644);
64 MODULE_PARM_DESC(resetafter, "Reset device after so many bad packets (0 = never).");
65 
66 static unsigned int psmouse_resync_time;
67 module_param_named(resync_time, psmouse_resync_time, uint, 0644);
68 MODULE_PARM_DESC(resync_time, "How long can mouse stay idle before forcing resync (in seconds, 0 = never).");
69 
70 PSMOUSE_DEFINE_ATTR(protocol, S_IWUSR | S_IRUGO,
71 			NULL,
72 			psmouse_attr_show_protocol, psmouse_attr_set_protocol);
73 PSMOUSE_DEFINE_ATTR(rate, S_IWUSR | S_IRUGO,
74 			(void *) offsetof(struct psmouse, rate),
75 			psmouse_show_int_attr, psmouse_attr_set_rate);
76 PSMOUSE_DEFINE_ATTR(resolution, S_IWUSR | S_IRUGO,
77 			(void *) offsetof(struct psmouse, resolution),
78 			psmouse_show_int_attr, psmouse_attr_set_resolution);
79 PSMOUSE_DEFINE_ATTR(resetafter, S_IWUSR | S_IRUGO,
80 			(void *) offsetof(struct psmouse, resetafter),
81 			psmouse_show_int_attr, psmouse_set_int_attr);
82 PSMOUSE_DEFINE_ATTR(resync_time, S_IWUSR | S_IRUGO,
83 			(void *) offsetof(struct psmouse, resync_time),
84 			psmouse_show_int_attr, psmouse_set_int_attr);
85 
86 static struct attribute *psmouse_attributes[] = {
87 	&psmouse_attr_protocol.dattr.attr,
88 	&psmouse_attr_rate.dattr.attr,
89 	&psmouse_attr_resolution.dattr.attr,
90 	&psmouse_attr_resetafter.dattr.attr,
91 	&psmouse_attr_resync_time.dattr.attr,
92 	NULL
93 };
94 
95 static struct attribute_group psmouse_attribute_group = {
96 	.attrs	= psmouse_attributes,
97 };
98 
99 /*
100  * psmouse_mutex protects all operations changing state of mouse
101  * (connecting, disconnecting, changing rate or resolution via
102  * sysfs). We could use a per-device semaphore but since there
103  * rarely more than one PS/2 mouse connected and since semaphore
104  * is taken in "slow" paths it is not worth it.
105  */
106 static DEFINE_MUTEX(psmouse_mutex);
107 
108 static struct workqueue_struct *kpsmoused_wq;
109 
110 struct psmouse_protocol {
111 	enum psmouse_type type;
112 	bool maxproto;
113 	const char *name;
114 	const char *alias;
115 	int (*detect)(struct psmouse *, bool);
116 	int (*init)(struct psmouse *);
117 };
118 
119 /*
120  * psmouse_process_byte() analyzes the PS/2 data stream and reports
121  * relevant events to the input module once full packet has arrived.
122  */
123 
124 static psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse)
125 {
126 	struct input_dev *dev = psmouse->dev;
127 	unsigned char *packet = psmouse->packet;
128 
129 	if (psmouse->pktcnt < psmouse->pktsize)
130 		return PSMOUSE_GOOD_DATA;
131 
132 /*
133  * Full packet accumulated, process it
134  */
135 
136 /*
137  * Scroll wheel on IntelliMice, scroll buttons on NetMice
138  */
139 
140 	if (psmouse->type == PSMOUSE_IMPS || psmouse->type == PSMOUSE_GENPS)
141 		input_report_rel(dev, REL_WHEEL, -(signed char) packet[3]);
142 
143 /*
144  * Scroll wheel and buttons on IntelliMouse Explorer
145  */
146 
147 	if (psmouse->type == PSMOUSE_IMEX) {
148 		switch (packet[3] & 0xC0) {
149 			case 0x80: /* vertical scroll on IntelliMouse Explorer 4.0 */
150 				input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 32) - (int) (packet[3] & 31));
151 				break;
152 			case 0x40: /* horizontal scroll on IntelliMouse Explorer 4.0 */
153 				input_report_rel(dev, REL_HWHEEL, (int) (packet[3] & 32) - (int) (packet[3] & 31));
154 				break;
155 			case 0x00:
156 			case 0xC0:
157 				input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 8) - (int) (packet[3] & 7));
158 				input_report_key(dev, BTN_SIDE, (packet[3] >> 4) & 1);
159 				input_report_key(dev, BTN_EXTRA, (packet[3] >> 5) & 1);
160 				break;
161 		}
162 	}
163 
164 /*
165  * Extra buttons on Genius NewNet 3D
166  */
167 
168 	if (psmouse->type == PSMOUSE_GENPS) {
169 		input_report_key(dev, BTN_SIDE, (packet[0] >> 6) & 1);
170 		input_report_key(dev, BTN_EXTRA, (packet[0] >> 7) & 1);
171 	}
172 
173 /*
174  * Extra button on ThinkingMouse
175  */
176 	if (psmouse->type == PSMOUSE_THINKPS) {
177 		input_report_key(dev, BTN_EXTRA, (packet[0] >> 3) & 1);
178 		/* Without this bit of weirdness moving up gives wildly high Y changes. */
179 		packet[1] |= (packet[0] & 0x40) << 1;
180 	}
181 
182 /*
183  * Cortron PS2 Trackball reports SIDE button on the 4th bit of the first
184  * byte.
185  */
186 	if (psmouse->type == PSMOUSE_CORTRON) {
187 		input_report_key(dev, BTN_SIDE, (packet[0] >> 3) & 1);
188 		packet[0] |= 0x08;
189 	}
190 
191 /*
192  * Generic PS/2 Mouse
193  */
194 
195 	input_report_key(dev, BTN_LEFT,    packet[0]       & 1);
196 	input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
197 	input_report_key(dev, BTN_RIGHT,  (packet[0] >> 1) & 1);
198 
199 	input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
200 	input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
201 
202 	input_sync(dev);
203 
204 	return PSMOUSE_FULL_PACKET;
205 }
206 
207 void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
208 		unsigned long delay)
209 {
210 	queue_delayed_work(kpsmoused_wq, work, delay);
211 }
212 
213 /*
214  * __psmouse_set_state() sets new psmouse state and resets all flags.
215  */
216 
217 static inline void __psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
218 {
219 	psmouse->state = new_state;
220 	psmouse->pktcnt = psmouse->out_of_sync_cnt = 0;
221 	psmouse->ps2dev.flags = 0;
222 	psmouse->last = jiffies;
223 }
224 
225 
226 /*
227  * psmouse_set_state() sets new psmouse state and resets all flags and
228  * counters while holding serio lock so fighting with interrupt handler
229  * is not a concern.
230  */
231 
232 void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
233 {
234 	serio_pause_rx(psmouse->ps2dev.serio);
235 	__psmouse_set_state(psmouse, new_state);
236 	serio_continue_rx(psmouse->ps2dev.serio);
237 }
238 
239 /*
240  * psmouse_handle_byte() processes one byte of the input data stream
241  * by calling corresponding protocol handler.
242  */
243 
244 static int psmouse_handle_byte(struct psmouse *psmouse)
245 {
246 	psmouse_ret_t rc = psmouse->protocol_handler(psmouse);
247 
248 	switch (rc) {
249 		case PSMOUSE_BAD_DATA:
250 			if (psmouse->state == PSMOUSE_ACTIVATED) {
251 				printk(KERN_WARNING "psmouse.c: %s at %s lost sync at byte %d\n",
252 					psmouse->name, psmouse->phys, psmouse->pktcnt);
253 				if (++psmouse->out_of_sync_cnt == psmouse->resetafter) {
254 					__psmouse_set_state(psmouse, PSMOUSE_IGNORE);
255 					printk(KERN_NOTICE "psmouse.c: issuing reconnect request\n");
256 					serio_reconnect(psmouse->ps2dev.serio);
257 					return -1;
258 				}
259 			}
260 			psmouse->pktcnt = 0;
261 			break;
262 
263 		case PSMOUSE_FULL_PACKET:
264 			psmouse->pktcnt = 0;
265 			if (psmouse->out_of_sync_cnt) {
266 				psmouse->out_of_sync_cnt = 0;
267 				printk(KERN_NOTICE "psmouse.c: %s at %s - driver resynched.\n",
268 					psmouse->name, psmouse->phys);
269 			}
270 			break;
271 
272 		case PSMOUSE_GOOD_DATA:
273 			break;
274 	}
275 	return 0;
276 }
277 
278 /*
279  * psmouse_interrupt() handles incoming characters, either passing them
280  * for normal processing or gathering them as command response.
281  */
282 
283 static irqreturn_t psmouse_interrupt(struct serio *serio,
284 		unsigned char data, unsigned int flags)
285 {
286 	struct psmouse *psmouse = serio_get_drvdata(serio);
287 
288 	if (psmouse->state == PSMOUSE_IGNORE)
289 		goto out;
290 
291 	if (flags & (SERIO_PARITY|SERIO_TIMEOUT)) {
292 		if (psmouse->state == PSMOUSE_ACTIVATED)
293 			printk(KERN_WARNING "psmouse.c: bad data from KBC -%s%s\n",
294 				flags & SERIO_TIMEOUT ? " timeout" : "",
295 				flags & SERIO_PARITY ? " bad parity" : "");
296 		ps2_cmd_aborted(&psmouse->ps2dev);
297 		goto out;
298 	}
299 
300 	if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_ACK))
301 		if  (ps2_handle_ack(&psmouse->ps2dev, data))
302 			goto out;
303 
304 	if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_CMD))
305 		if  (ps2_handle_response(&psmouse->ps2dev, data))
306 			goto out;
307 
308 	if (psmouse->state <= PSMOUSE_RESYNCING)
309 		goto out;
310 
311 	if (psmouse->state == PSMOUSE_ACTIVATED &&
312 	    psmouse->pktcnt && time_after(jiffies, psmouse->last + HZ/2)) {
313 		printk(KERN_INFO "psmouse.c: %s at %s lost synchronization, throwing %d bytes away.\n",
314 		       psmouse->name, psmouse->phys, psmouse->pktcnt);
315 		psmouse->badbyte = psmouse->packet[0];
316 		__psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
317 		psmouse_queue_work(psmouse, &psmouse->resync_work, 0);
318 		goto out;
319 	}
320 
321 	psmouse->packet[psmouse->pktcnt++] = data;
322 /*
323  * Check if this is a new device announcement (0xAA 0x00)
324  */
325 	if (unlikely(psmouse->packet[0] == PSMOUSE_RET_BAT && psmouse->pktcnt <= 2)) {
326 		if (psmouse->pktcnt == 1) {
327 			psmouse->last = jiffies;
328 			goto out;
329 		}
330 
331 		if (psmouse->packet[1] == PSMOUSE_RET_ID ||
332 		    (psmouse->type == PSMOUSE_HGPK &&
333 		     psmouse->packet[1] == PSMOUSE_RET_BAT)) {
334 			__psmouse_set_state(psmouse, PSMOUSE_IGNORE);
335 			serio_reconnect(serio);
336 			goto out;
337 		}
338 /*
339  * Not a new device, try processing first byte normally
340  */
341 		psmouse->pktcnt = 1;
342 		if (psmouse_handle_byte(psmouse))
343 			goto out;
344 
345 		psmouse->packet[psmouse->pktcnt++] = data;
346 	}
347 
348 /*
349  * See if we need to force resync because mouse was idle for too long
350  */
351 	if (psmouse->state == PSMOUSE_ACTIVATED &&
352 	    psmouse->pktcnt == 1 && psmouse->resync_time &&
353 	    time_after(jiffies, psmouse->last + psmouse->resync_time * HZ)) {
354 		psmouse->badbyte = psmouse->packet[0];
355 		__psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
356 		psmouse_queue_work(psmouse, &psmouse->resync_work, 0);
357 		goto out;
358 	}
359 
360 	psmouse->last = jiffies;
361 	psmouse_handle_byte(psmouse);
362 
363  out:
364 	return IRQ_HANDLED;
365 }
366 
367 
368 /*
369  * psmouse_sliced_command() sends an extended PS/2 command to the mouse
370  * using sliced syntax, understood by advanced devices, such as Logitech
371  * or Synaptics touchpads. The command is encoded as:
372  * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
373  * is the command.
374  */
375 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command)
376 {
377 	int i;
378 
379 	if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11))
380 		return -1;
381 
382 	for (i = 6; i >= 0; i -= 2) {
383 		unsigned char d = (command >> i) & 3;
384 		if (ps2_command(&psmouse->ps2dev, &d, PSMOUSE_CMD_SETRES))
385 			return -1;
386 	}
387 
388 	return 0;
389 }
390 
391 
392 /*
393  * psmouse_reset() resets the mouse into power-on state.
394  */
395 int psmouse_reset(struct psmouse *psmouse)
396 {
397 	unsigned char param[2];
398 
399 	if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_RESET_BAT))
400 		return -1;
401 
402 	if (param[0] != PSMOUSE_RET_BAT && param[1] != PSMOUSE_RET_ID)
403 		return -1;
404 
405 	return 0;
406 }
407 
408 
409 /*
410  * Genius NetMouse magic init.
411  */
412 static int genius_detect(struct psmouse *psmouse, bool set_properties)
413 {
414 	struct ps2dev *ps2dev = &psmouse->ps2dev;
415 	unsigned char param[4];
416 
417 	param[0] = 3;
418 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
419 	ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
420 	ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
421 	ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
422 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
423 
424 	if (param[0] != 0x00 || param[1] != 0x33 || param[2] != 0x55)
425 		return -1;
426 
427 	if (set_properties) {
428 		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
429 		__set_bit(BTN_EXTRA, psmouse->dev->keybit);
430 		__set_bit(BTN_SIDE, psmouse->dev->keybit);
431 		__set_bit(REL_WHEEL, psmouse->dev->relbit);
432 
433 		psmouse->vendor = "Genius";
434 		psmouse->name = "Mouse";
435 		psmouse->pktsize = 4;
436 	}
437 
438 	return 0;
439 }
440 
441 /*
442  * IntelliMouse magic init.
443  */
444 static int intellimouse_detect(struct psmouse *psmouse, bool set_properties)
445 {
446 	struct ps2dev *ps2dev = &psmouse->ps2dev;
447 	unsigned char param[2];
448 
449 	param[0] = 200;
450 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
451 	param[0] = 100;
452 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
453 	param[0] =  80;
454 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
455 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
456 
457 	if (param[0] != 3)
458 		return -1;
459 
460 	if (set_properties) {
461 		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
462 		__set_bit(REL_WHEEL, psmouse->dev->relbit);
463 
464 		if (!psmouse->vendor)
465 			psmouse->vendor = "Generic";
466 		if (!psmouse->name)
467 			psmouse->name = "Wheel Mouse";
468 		psmouse->pktsize = 4;
469 	}
470 
471 	return 0;
472 }
473 
474 /*
475  * Try IntelliMouse/Explorer magic init.
476  */
477 static int im_explorer_detect(struct psmouse *psmouse, bool set_properties)
478 {
479 	struct ps2dev *ps2dev = &psmouse->ps2dev;
480 	unsigned char param[2];
481 
482 	intellimouse_detect(psmouse, 0);
483 
484 	param[0] = 200;
485 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
486 	param[0] = 200;
487 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
488 	param[0] =  80;
489 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
490 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
491 
492 	if (param[0] != 4)
493 		return -1;
494 
495 /* Magic to enable horizontal scrolling on IntelliMouse 4.0 */
496 	param[0] = 200;
497 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
498 	param[0] =  80;
499 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
500 	param[0] =  40;
501 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
502 
503 	if (set_properties) {
504 		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
505 		__set_bit(REL_WHEEL, psmouse->dev->relbit);
506 		__set_bit(REL_HWHEEL, psmouse->dev->relbit);
507 		__set_bit(BTN_SIDE, psmouse->dev->keybit);
508 		__set_bit(BTN_EXTRA, psmouse->dev->keybit);
509 
510 		if (!psmouse->vendor)
511 			psmouse->vendor = "Generic";
512 		if (!psmouse->name)
513 			psmouse->name = "Explorer Mouse";
514 		psmouse->pktsize = 4;
515 	}
516 
517 	return 0;
518 }
519 
520 /*
521  * Kensington ThinkingMouse / ExpertMouse magic init.
522  */
523 static int thinking_detect(struct psmouse *psmouse, bool set_properties)
524 {
525 	struct ps2dev *ps2dev = &psmouse->ps2dev;
526 	unsigned char param[2];
527 	static const unsigned char seq[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
528 	int i;
529 
530 	param[0] = 10;
531 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
532 	param[0] = 0;
533 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
534 	for (i = 0; i < ARRAY_SIZE(seq); i++) {
535 		param[0] = seq[i];
536 		ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
537 	}
538 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
539 
540 	if (param[0] != 2)
541 		return -1;
542 
543 	if (set_properties) {
544 		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
545 		__set_bit(BTN_EXTRA, psmouse->dev->keybit);
546 
547 		psmouse->vendor = "Kensington";
548 		psmouse->name = "ThinkingMouse";
549 	}
550 
551 	return 0;
552 }
553 
554 /*
555  * Bare PS/2 protocol "detection". Always succeeds.
556  */
557 static int ps2bare_detect(struct psmouse *psmouse, bool set_properties)
558 {
559 	if (set_properties) {
560 		if (!psmouse->vendor)
561 			psmouse->vendor = "Generic";
562 		if (!psmouse->name)
563 			psmouse->name = "Mouse";
564 
565 /*
566  * We have no way of figuring true number of buttons so let's
567  * assume that the device has 3.
568  */
569 		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
570 	}
571 
572 	return 0;
573 }
574 
575 /*
576  * Cortron PS/2 protocol detection. There's no special way to detect it, so it
577  * must be forced by sysfs protocol writing.
578  */
579 static int cortron_detect(struct psmouse *psmouse, bool set_properties)
580 {
581 	if (set_properties) {
582 		psmouse->vendor = "Cortron";
583 		psmouse->name = "PS/2 Trackball";
584 
585 		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
586 		__set_bit(BTN_SIDE, psmouse->dev->keybit);
587 	}
588 
589 	return 0;
590 }
591 
592 /*
593  * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
594  * the mouse may have.
595  */
596 
597 static int psmouse_extensions(struct psmouse *psmouse,
598 			      unsigned int max_proto, bool set_properties)
599 {
600 	bool synaptics_hardware = false;
601 
602 /*
603  * We always check for lifebook because it does not disturb mouse
604  * (it only checks DMI information).
605  */
606 	if (lifebook_detect(psmouse, set_properties) == 0) {
607 		if (max_proto > PSMOUSE_IMEX) {
608 			if (!set_properties || lifebook_init(psmouse) == 0)
609 				return PSMOUSE_LIFEBOOK;
610 		}
611 	}
612 
613 /*
614  * Try Kensington ThinkingMouse (we try first, because synaptics probe
615  * upsets the thinkingmouse).
616  */
617 
618 	if (max_proto > PSMOUSE_IMEX && thinking_detect(psmouse, set_properties) == 0)
619 		return PSMOUSE_THINKPS;
620 
621 /*
622  * Try Synaptics TouchPad. Note that probing is done even if Synaptics protocol
623  * support is disabled in config - we need to know if it is synaptics so we
624  * can reset it properly after probing for intellimouse.
625  */
626 	if (max_proto > PSMOUSE_PS2 && synaptics_detect(psmouse, set_properties) == 0) {
627 		synaptics_hardware = true;
628 
629 		if (max_proto > PSMOUSE_IMEX) {
630 			if (!set_properties || synaptics_init(psmouse) == 0)
631 				return PSMOUSE_SYNAPTICS;
632 /*
633  * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
634  * Unfortunately Logitech/Genius probes confuse some firmware versions so
635  * we'll have to skip them.
636  */
637 			max_proto = PSMOUSE_IMEX;
638 		}
639 /*
640  * Make sure that touchpad is in relative mode, gestures (taps) are enabled
641  */
642 		synaptics_reset(psmouse);
643 	}
644 
645 /*
646  * Try ALPS TouchPad
647  */
648 	if (max_proto > PSMOUSE_IMEX) {
649 		ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
650 		if (alps_detect(psmouse, set_properties) == 0) {
651 			if (!set_properties || alps_init(psmouse) == 0)
652 				return PSMOUSE_ALPS;
653 /*
654  * Init failed, try basic relative protocols
655  */
656 			max_proto = PSMOUSE_IMEX;
657 		}
658 	}
659 
660 /*
661  * Try OLPC HGPK touchpad.
662  */
663 	if (max_proto > PSMOUSE_IMEX &&
664 			hgpk_detect(psmouse, set_properties) == 0) {
665 		if (!set_properties || hgpk_init(psmouse) == 0)
666 			return PSMOUSE_HGPK;
667 /*
668  * Init failed, try basic relative protocols
669  */
670 		max_proto = PSMOUSE_IMEX;
671 	}
672 
673 /*
674  * Try Elantech touchpad.
675  */
676 	if (max_proto > PSMOUSE_IMEX &&
677 			elantech_detect(psmouse, set_properties) == 0) {
678 		if (!set_properties || elantech_init(psmouse) == 0)
679 			return PSMOUSE_ELANTECH;
680 /*
681  * Init failed, try basic relative protocols
682  */
683 		max_proto = PSMOUSE_IMEX;
684 	}
685 
686 /*
687  * Try Finger Sensing Pad
688  */
689 	if (max_proto > PSMOUSE_IMEX) {
690 		if (fsp_detect(psmouse, set_properties) == 0) {
691 			if (!set_properties || fsp_init(psmouse) == 0)
692 				return PSMOUSE_FSP;
693 /*
694  * Init failed, try basic relative protocols
695  */
696 			max_proto = PSMOUSE_IMEX;
697 		}
698 	}
699 
700 	if (max_proto > PSMOUSE_IMEX) {
701 		if (genius_detect(psmouse, set_properties) == 0)
702 			return PSMOUSE_GENPS;
703 
704 		if (ps2pp_init(psmouse, set_properties) == 0)
705 			return PSMOUSE_PS2PP;
706 
707 		if (trackpoint_detect(psmouse, set_properties) == 0)
708 			return PSMOUSE_TRACKPOINT;
709 
710 		if (touchkit_ps2_detect(psmouse, set_properties) == 0)
711 			return PSMOUSE_TOUCHKIT_PS2;
712 	}
713 
714 /*
715  * Reset to defaults in case the device got confused by extended
716  * protocol probes. Note that we follow up with full reset because
717  * some mice put themselves to sleep when they see PSMOUSE_RESET_DIS.
718  */
719 	ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
720 	psmouse_reset(psmouse);
721 
722 	if (max_proto >= PSMOUSE_IMEX && im_explorer_detect(psmouse, set_properties) == 0)
723 		return PSMOUSE_IMEX;
724 
725 	if (max_proto >= PSMOUSE_IMPS && intellimouse_detect(psmouse, set_properties) == 0)
726 		return PSMOUSE_IMPS;
727 
728 /*
729  * Okay, all failed, we have a standard mouse here. The number of the buttons
730  * is still a question, though. We assume 3.
731  */
732 	ps2bare_detect(psmouse, set_properties);
733 
734 	if (synaptics_hardware) {
735 /*
736  * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
737  * We need to reset the touchpad because if there is a track point on the
738  * pass through port it could get disabled while probing for protocol
739  * extensions.
740  */
741 		psmouse_reset(psmouse);
742 	}
743 
744 	return PSMOUSE_PS2;
745 }
746 
747 static const struct psmouse_protocol psmouse_protocols[] = {
748 	{
749 		.type		= PSMOUSE_PS2,
750 		.name		= "PS/2",
751 		.alias		= "bare",
752 		.maxproto	= true,
753 		.detect		= ps2bare_detect,
754 	},
755 #ifdef CONFIG_MOUSE_PS2_LOGIPS2PP
756 	{
757 		.type		= PSMOUSE_PS2PP,
758 		.name		= "PS2++",
759 		.alias		= "logitech",
760 		.detect		= ps2pp_init,
761 	},
762 #endif
763 	{
764 		.type		= PSMOUSE_THINKPS,
765 		.name		= "ThinkPS/2",
766 		.alias		= "thinkps",
767 		.detect		= thinking_detect,
768 	},
769 	{
770 		.type		= PSMOUSE_GENPS,
771 		.name		= "GenPS/2",
772 		.alias		= "genius",
773 		.detect		= genius_detect,
774 	},
775 	{
776 		.type		= PSMOUSE_IMPS,
777 		.name		= "ImPS/2",
778 		.alias		= "imps",
779 		.maxproto	= true,
780 		.detect		= intellimouse_detect,
781 	},
782 	{
783 		.type		= PSMOUSE_IMEX,
784 		.name		= "ImExPS/2",
785 		.alias		= "exps",
786 		.maxproto	= true,
787 		.detect		= im_explorer_detect,
788 	},
789 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
790 	{
791 		.type		= PSMOUSE_SYNAPTICS,
792 		.name		= "SynPS/2",
793 		.alias		= "synaptics",
794 		.detect		= synaptics_detect,
795 		.init		= synaptics_init,
796 	},
797 #endif
798 #ifdef CONFIG_MOUSE_PS2_ALPS
799 	{
800 		.type		= PSMOUSE_ALPS,
801 		.name		= "AlpsPS/2",
802 		.alias		= "alps",
803 		.detect		= alps_detect,
804 		.init		= alps_init,
805 	},
806 #endif
807 #ifdef CONFIG_MOUSE_PS2_LIFEBOOK
808 	{
809 		.type		= PSMOUSE_LIFEBOOK,
810 		.name		= "LBPS/2",
811 		.alias		= "lifebook",
812 		.init		= lifebook_init,
813 	},
814 #endif
815 #ifdef CONFIG_MOUSE_PS2_TRACKPOINT
816 	{
817 		.type		= PSMOUSE_TRACKPOINT,
818 		.name		= "TPPS/2",
819 		.alias		= "trackpoint",
820 		.detect		= trackpoint_detect,
821 	},
822 #endif
823 #ifdef CONFIG_MOUSE_PS2_TOUCHKIT
824 	{
825 		.type		= PSMOUSE_TOUCHKIT_PS2,
826 		.name		= "touchkitPS/2",
827 		.alias		= "touchkit",
828 		.detect		= touchkit_ps2_detect,
829 	},
830 #endif
831 #ifdef CONFIG_MOUSE_PS2_OLPC
832 	{
833 		.type		= PSMOUSE_HGPK,
834 		.name		= "OLPC HGPK",
835 		.alias		= "hgpk",
836 		.detect		= hgpk_detect,
837 	},
838 #endif
839 #ifdef CONFIG_MOUSE_PS2_ELANTECH
840 	{
841 		.type		= PSMOUSE_ELANTECH,
842 		.name		= "ETPS/2",
843 		.alias		= "elantech",
844 		.detect		= elantech_detect,
845 		.init		= elantech_init,
846 	},
847 #endif
848 #ifdef CONFIG_MOUSE_PS2_SENTELIC
849 	{
850 		.type		= PSMOUSE_FSP,
851 		.name		= "FSPPS/2",
852 		.alias		= "fsp",
853 		.detect		= fsp_detect,
854 		.init		= fsp_init,
855 	},
856 #endif
857 	{
858 		.type		= PSMOUSE_CORTRON,
859 		.name		= "CortronPS/2",
860 		.alias		= "cortps",
861 		.detect		= cortron_detect,
862 	},
863 	{
864 		.type		= PSMOUSE_AUTO,
865 		.name		= "auto",
866 		.alias		= "any",
867 		.maxproto	= true,
868 	},
869 };
870 
871 static const struct psmouse_protocol *psmouse_protocol_by_type(enum psmouse_type type)
872 {
873 	int i;
874 
875 	for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++)
876 		if (psmouse_protocols[i].type == type)
877 			return &psmouse_protocols[i];
878 
879 	WARN_ON(1);
880 	return &psmouse_protocols[0];
881 }
882 
883 static const struct psmouse_protocol *psmouse_protocol_by_name(const char *name, size_t len)
884 {
885 	const struct psmouse_protocol *p;
886 	int i;
887 
888 	for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++) {
889 		p = &psmouse_protocols[i];
890 
891 		if ((strlen(p->name) == len && !strncmp(p->name, name, len)) ||
892 		    (strlen(p->alias) == len && !strncmp(p->alias, name, len)))
893 			return &psmouse_protocols[i];
894 	}
895 
896 	return NULL;
897 }
898 
899 
900 /*
901  * psmouse_probe() probes for a PS/2 mouse.
902  */
903 
904 static int psmouse_probe(struct psmouse *psmouse)
905 {
906 	struct ps2dev *ps2dev = &psmouse->ps2dev;
907 	unsigned char param[2];
908 
909 /*
910  * First, we check if it's a mouse. It should send 0x00 or 0x03
911  * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
912  * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
913  * ID queries, probably due to a firmware bug.
914  */
915 
916 	param[0] = 0xa5;
917 	if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
918 		return -1;
919 
920 	if (param[0] != 0x00 && param[0] != 0x03 &&
921 	    param[0] != 0x04 && param[0] != 0xff)
922 		return -1;
923 
924 /*
925  * Then we reset and disable the mouse so that it doesn't generate events.
926  */
927 
928 	if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS))
929 		printk(KERN_WARNING "psmouse.c: Failed to reset mouse on %s\n", ps2dev->serio->phys);
930 
931 	return 0;
932 }
933 
934 /*
935  * Here we set the mouse resolution.
936  */
937 
938 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution)
939 {
940 	static const unsigned char params[] = { 0, 1, 2, 2, 3 };
941 	unsigned char p;
942 
943 	if (resolution == 0 || resolution > 200)
944 		resolution = 200;
945 
946 	p = params[resolution / 50];
947 	ps2_command(&psmouse->ps2dev, &p, PSMOUSE_CMD_SETRES);
948 	psmouse->resolution = 25 << p;
949 }
950 
951 /*
952  * Here we set the mouse report rate.
953  */
954 
955 static void psmouse_set_rate(struct psmouse *psmouse, unsigned int rate)
956 {
957 	static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
958 	unsigned char r;
959 	int i = 0;
960 
961 	while (rates[i] > rate) i++;
962 	r = rates[i];
963 	ps2_command(&psmouse->ps2dev, &r, PSMOUSE_CMD_SETRATE);
964 	psmouse->rate = r;
965 }
966 
967 /*
968  * psmouse_initialize() initializes the mouse to a sane state.
969  */
970 
971 static void psmouse_initialize(struct psmouse *psmouse)
972 {
973 /*
974  * We set the mouse report rate, resolution and scaling.
975  */
976 
977 	if (psmouse_max_proto != PSMOUSE_PS2) {
978 		psmouse->set_rate(psmouse, psmouse->rate);
979 		psmouse->set_resolution(psmouse, psmouse->resolution);
980 		ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
981 	}
982 }
983 
984 /*
985  * psmouse_activate() enables the mouse so that we get motion reports from it.
986  */
987 
988 static void psmouse_activate(struct psmouse *psmouse)
989 {
990 	if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE))
991 		printk(KERN_WARNING "psmouse.c: Failed to enable mouse on %s\n",
992 			psmouse->ps2dev.serio->phys);
993 
994 	psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
995 }
996 
997 
998 /*
999  * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
1000  * reports from it unless we explicitly request it.
1001  */
1002 
1003 static void psmouse_deactivate(struct psmouse *psmouse)
1004 {
1005 	if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1006 		printk(KERN_WARNING "psmouse.c: Failed to deactivate mouse on %s\n",
1007 			psmouse->ps2dev.serio->phys);
1008 
1009 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1010 }
1011 
1012 /*
1013  * psmouse_poll() - default poll hanlder. Everyone except for ALPS uses it.
1014  */
1015 
1016 static int psmouse_poll(struct psmouse *psmouse)
1017 {
1018 	return ps2_command(&psmouse->ps2dev, psmouse->packet,
1019 			   PSMOUSE_CMD_POLL | (psmouse->pktsize << 8));
1020 }
1021 
1022 
1023 /*
1024  * psmouse_resync() attempts to re-validate current protocol.
1025  */
1026 
1027 static void psmouse_resync(struct work_struct *work)
1028 {
1029 	struct psmouse *parent = NULL, *psmouse =
1030 		container_of(work, struct psmouse, resync_work.work);
1031 	struct serio *serio = psmouse->ps2dev.serio;
1032 	psmouse_ret_t rc = PSMOUSE_GOOD_DATA;
1033 	bool failed = false, enabled = false;
1034 	int i;
1035 
1036 	mutex_lock(&psmouse_mutex);
1037 
1038 	if (psmouse->state != PSMOUSE_RESYNCING)
1039 		goto out;
1040 
1041 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1042 		parent = serio_get_drvdata(serio->parent);
1043 		psmouse_deactivate(parent);
1044 	}
1045 
1046 /*
1047  * Some mice don't ACK commands sent while they are in the middle of
1048  * transmitting motion packet. To avoid delay we use ps2_sendbyte()
1049  * instead of ps2_command() which would wait for 200ms for an ACK
1050  * that may never come.
1051  * As an additional quirk ALPS touchpads may not only forget to ACK
1052  * disable command but will stop reporting taps, so if we see that
1053  * mouse at least once ACKs disable we will do full reconnect if ACK
1054  * is missing.
1055  */
1056 	psmouse->num_resyncs++;
1057 
1058 	if (ps2_sendbyte(&psmouse->ps2dev, PSMOUSE_CMD_DISABLE, 20)) {
1059 		if (psmouse->num_resyncs < 3 || psmouse->acks_disable_command)
1060 			failed = true;
1061 	} else
1062 		psmouse->acks_disable_command = true;
1063 
1064 /*
1065  * Poll the mouse. If it was reset the packet will be shorter than
1066  * psmouse->pktsize and ps2_command will fail. We do not expect and
1067  * do not handle scenario when mouse "upgrades" its protocol while
1068  * disconnected since it would require additional delay. If we ever
1069  * see a mouse that does it we'll adjust the code.
1070  */
1071 	if (!failed) {
1072 		if (psmouse->poll(psmouse))
1073 			failed = true;
1074 		else {
1075 			psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1076 			for (i = 0; i < psmouse->pktsize; i++) {
1077 				psmouse->pktcnt++;
1078 				rc = psmouse->protocol_handler(psmouse);
1079 				if (rc != PSMOUSE_GOOD_DATA)
1080 					break;
1081 			}
1082 			if (rc != PSMOUSE_FULL_PACKET)
1083 				failed = true;
1084 			psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
1085 		}
1086 	}
1087 /*
1088  * Now try to enable mouse. We try to do that even if poll failed and also
1089  * repeat our attempts 5 times, otherwise we may be left out with disabled
1090  * mouse.
1091  */
1092 	for (i = 0; i < 5; i++) {
1093 		if (!ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
1094 			enabled = true;
1095 			break;
1096 		}
1097 		msleep(200);
1098 	}
1099 
1100 	if (!enabled) {
1101 		printk(KERN_WARNING "psmouse.c: failed to re-enable mouse on %s\n",
1102 			psmouse->ps2dev.serio->phys);
1103 		failed = true;
1104 	}
1105 
1106 	if (failed) {
1107 		psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1108 		printk(KERN_INFO "psmouse.c: resync failed, issuing reconnect request\n");
1109 		serio_reconnect(serio);
1110 	} else
1111 		psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
1112 
1113 	if (parent)
1114 		psmouse_activate(parent);
1115  out:
1116 	mutex_unlock(&psmouse_mutex);
1117 }
1118 
1119 /*
1120  * psmouse_cleanup() resets the mouse into power-on state.
1121  */
1122 
1123 static void psmouse_cleanup(struct serio *serio)
1124 {
1125 	struct psmouse *psmouse = serio_get_drvdata(serio);
1126 	struct psmouse *parent = NULL;
1127 
1128 	mutex_lock(&psmouse_mutex);
1129 
1130 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1131 		parent = serio_get_drvdata(serio->parent);
1132 		psmouse_deactivate(parent);
1133 	}
1134 
1135 	psmouse_deactivate(psmouse);
1136 
1137 	if (psmouse->cleanup)
1138 		psmouse->cleanup(psmouse);
1139 
1140 	psmouse_reset(psmouse);
1141 
1142 /*
1143  * Some boxes, such as HP nx7400, get terribly confused if mouse
1144  * is not fully enabled before suspending/shutting down.
1145  */
1146 	ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE);
1147 
1148 	if (parent) {
1149 		if (parent->pt_deactivate)
1150 			parent->pt_deactivate(parent);
1151 
1152 		psmouse_activate(parent);
1153 	}
1154 
1155 	mutex_unlock(&psmouse_mutex);
1156 }
1157 
1158 /*
1159  * psmouse_disconnect() closes and frees.
1160  */
1161 
1162 static void psmouse_disconnect(struct serio *serio)
1163 {
1164 	struct psmouse *psmouse, *parent = NULL;
1165 
1166 	psmouse = serio_get_drvdata(serio);
1167 
1168 	sysfs_remove_group(&serio->dev.kobj, &psmouse_attribute_group);
1169 
1170 	mutex_lock(&psmouse_mutex);
1171 
1172 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1173 
1174 	/* make sure we don't have a resync in progress */
1175 	mutex_unlock(&psmouse_mutex);
1176 	flush_workqueue(kpsmoused_wq);
1177 	mutex_lock(&psmouse_mutex);
1178 
1179 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1180 		parent = serio_get_drvdata(serio->parent);
1181 		psmouse_deactivate(parent);
1182 	}
1183 
1184 	if (psmouse->disconnect)
1185 		psmouse->disconnect(psmouse);
1186 
1187 	if (parent && parent->pt_deactivate)
1188 		parent->pt_deactivate(parent);
1189 
1190 	psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1191 
1192 	serio_close(serio);
1193 	serio_set_drvdata(serio, NULL);
1194 	input_unregister_device(psmouse->dev);
1195 	kfree(psmouse);
1196 
1197 	if (parent)
1198 		psmouse_activate(parent);
1199 
1200 	mutex_unlock(&psmouse_mutex);
1201 }
1202 
1203 static int psmouse_switch_protocol(struct psmouse *psmouse,
1204 				   const struct psmouse_protocol *proto)
1205 {
1206 	struct input_dev *input_dev = psmouse->dev;
1207 
1208 	input_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1209 
1210 	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1211 	input_dev->keybit[BIT_WORD(BTN_MOUSE)] =
1212 				BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
1213 	input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1214 
1215 	psmouse->set_rate = psmouse_set_rate;
1216 	psmouse->set_resolution = psmouse_set_resolution;
1217 	psmouse->poll = psmouse_poll;
1218 	psmouse->protocol_handler = psmouse_process_byte;
1219 	psmouse->pktsize = 3;
1220 
1221 	if (proto && (proto->detect || proto->init)) {
1222 		if (proto->detect && proto->detect(psmouse, 1) < 0)
1223 			return -1;
1224 
1225 		if (proto->init && proto->init(psmouse) < 0)
1226 			return -1;
1227 
1228 		psmouse->type = proto->type;
1229 	} else
1230 		psmouse->type = psmouse_extensions(psmouse,
1231 						   psmouse_max_proto, true);
1232 
1233 	/*
1234 	 * If mouse's packet size is 3 there is no point in polling the
1235 	 * device in hopes to detect protocol reset - we won't get less
1236 	 * than 3 bytes response anyhow.
1237 	 */
1238 	if (psmouse->pktsize == 3)
1239 		psmouse->resync_time = 0;
1240 
1241 	/*
1242 	 * Some smart KVMs fake response to POLL command returning just
1243 	 * 3 bytes and messing up our resync logic, so if initial poll
1244 	 * fails we won't try polling the device anymore. Hopefully
1245 	 * such KVM will maintain initially selected protocol.
1246 	 */
1247 	if (psmouse->resync_time && psmouse->poll(psmouse))
1248 		psmouse->resync_time = 0;
1249 
1250 	snprintf(psmouse->devname, sizeof(psmouse->devname), "%s %s %s",
1251 		 psmouse_protocol_by_type(psmouse->type)->name, psmouse->vendor, psmouse->name);
1252 
1253 	input_dev->name = psmouse->devname;
1254 	input_dev->phys = psmouse->phys;
1255 	input_dev->id.bustype = BUS_I8042;
1256 	input_dev->id.vendor = 0x0002;
1257 	input_dev->id.product = psmouse->type;
1258 	input_dev->id.version = psmouse->model;
1259 
1260 	return 0;
1261 }
1262 
1263 /*
1264  * psmouse_connect() is a callback from the serio module when
1265  * an unhandled serio port is found.
1266  */
1267 static int psmouse_connect(struct serio *serio, struct serio_driver *drv)
1268 {
1269 	struct psmouse *psmouse, *parent = NULL;
1270 	struct input_dev *input_dev;
1271 	int retval = 0, error = -ENOMEM;
1272 
1273 	mutex_lock(&psmouse_mutex);
1274 
1275 	/*
1276 	 * If this is a pass-through port deactivate parent so the device
1277 	 * connected to this port can be successfully identified
1278 	 */
1279 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1280 		parent = serio_get_drvdata(serio->parent);
1281 		psmouse_deactivate(parent);
1282 	}
1283 
1284 	psmouse = kzalloc(sizeof(struct psmouse), GFP_KERNEL);
1285 	input_dev = input_allocate_device();
1286 	if (!psmouse || !input_dev)
1287 		goto err_free;
1288 
1289 	ps2_init(&psmouse->ps2dev, serio);
1290 	INIT_DELAYED_WORK(&psmouse->resync_work, psmouse_resync);
1291 	psmouse->dev = input_dev;
1292 	snprintf(psmouse->phys, sizeof(psmouse->phys), "%s/input0", serio->phys);
1293 
1294 	psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1295 
1296 	serio_set_drvdata(serio, psmouse);
1297 
1298 	error = serio_open(serio, drv);
1299 	if (error)
1300 		goto err_clear_drvdata;
1301 
1302 	if (psmouse_probe(psmouse) < 0) {
1303 		error = -ENODEV;
1304 		goto err_close_serio;
1305 	}
1306 
1307 	psmouse->rate = psmouse_rate;
1308 	psmouse->resolution = psmouse_resolution;
1309 	psmouse->resetafter = psmouse_resetafter;
1310 	psmouse->resync_time = parent ? 0 : psmouse_resync_time;
1311 	psmouse->smartscroll = psmouse_smartscroll;
1312 
1313 	psmouse_switch_protocol(psmouse, NULL);
1314 
1315 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1316 	psmouse_initialize(psmouse);
1317 
1318 	error = input_register_device(psmouse->dev);
1319 	if (error)
1320 		goto err_protocol_disconnect;
1321 
1322 	if (parent && parent->pt_activate)
1323 		parent->pt_activate(parent);
1324 
1325 	error = sysfs_create_group(&serio->dev.kobj, &psmouse_attribute_group);
1326 	if (error)
1327 		goto err_pt_deactivate;
1328 
1329 	psmouse_activate(psmouse);
1330 
1331  out:
1332 	/* If this is a pass-through port the parent needs to be re-activated */
1333 	if (parent)
1334 		psmouse_activate(parent);
1335 
1336 	mutex_unlock(&psmouse_mutex);
1337 	return retval;
1338 
1339  err_pt_deactivate:
1340 	if (parent && parent->pt_deactivate)
1341 		parent->pt_deactivate(parent);
1342 	input_unregister_device(psmouse->dev);
1343 	input_dev = NULL; /* so we don't try to free it below */
1344  err_protocol_disconnect:
1345 	if (psmouse->disconnect)
1346 		psmouse->disconnect(psmouse);
1347 	psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1348  err_close_serio:
1349 	serio_close(serio);
1350  err_clear_drvdata:
1351 	serio_set_drvdata(serio, NULL);
1352  err_free:
1353 	input_free_device(input_dev);
1354 	kfree(psmouse);
1355 
1356 	retval = error;
1357 	goto out;
1358 }
1359 
1360 
1361 static int psmouse_reconnect(struct serio *serio)
1362 {
1363 	struct psmouse *psmouse = serio_get_drvdata(serio);
1364 	struct psmouse *parent = NULL;
1365 	struct serio_driver *drv = serio->drv;
1366 	int rc = -1;
1367 
1368 	if (!drv || !psmouse) {
1369 		printk(KERN_DEBUG "psmouse: reconnect request, but serio is disconnected, ignoring...\n");
1370 		return -1;
1371 	}
1372 
1373 	mutex_lock(&psmouse_mutex);
1374 
1375 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1376 		parent = serio_get_drvdata(serio->parent);
1377 		psmouse_deactivate(parent);
1378 	}
1379 
1380 	psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1381 
1382 	if (psmouse->reconnect) {
1383 		if (psmouse->reconnect(psmouse))
1384 			goto out;
1385 	} else if (psmouse_probe(psmouse) < 0 ||
1386 		   psmouse->type != psmouse_extensions(psmouse,
1387 						psmouse_max_proto, false)) {
1388 		goto out;
1389 	}
1390 
1391 	/* ok, the device type (and capabilities) match the old one,
1392 	 * we can continue using it, complete intialization
1393 	 */
1394 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1395 
1396 	psmouse_initialize(psmouse);
1397 
1398 	if (parent && parent->pt_activate)
1399 		parent->pt_activate(parent);
1400 
1401 	psmouse_activate(psmouse);
1402 	rc = 0;
1403 
1404 out:
1405 	/* If this is a pass-through port the parent waits to be activated */
1406 	if (parent)
1407 		psmouse_activate(parent);
1408 
1409 	mutex_unlock(&psmouse_mutex);
1410 	return rc;
1411 }
1412 
1413 static struct serio_device_id psmouse_serio_ids[] = {
1414 	{
1415 		.type	= SERIO_8042,
1416 		.proto	= SERIO_ANY,
1417 		.id	= SERIO_ANY,
1418 		.extra	= SERIO_ANY,
1419 	},
1420 	{
1421 		.type	= SERIO_PS_PSTHRU,
1422 		.proto	= SERIO_ANY,
1423 		.id	= SERIO_ANY,
1424 		.extra	= SERIO_ANY,
1425 	},
1426 	{ 0 }
1427 };
1428 
1429 MODULE_DEVICE_TABLE(serio, psmouse_serio_ids);
1430 
1431 static struct serio_driver psmouse_drv = {
1432 	.driver		= {
1433 		.name	= "psmouse",
1434 	},
1435 	.description	= DRIVER_DESC,
1436 	.id_table	= psmouse_serio_ids,
1437 	.interrupt	= psmouse_interrupt,
1438 	.connect	= psmouse_connect,
1439 	.reconnect	= psmouse_reconnect,
1440 	.disconnect	= psmouse_disconnect,
1441 	.cleanup	= psmouse_cleanup,
1442 };
1443 
1444 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *devattr,
1445 				 char *buf)
1446 {
1447 	struct serio *serio = to_serio_port(dev);
1448 	struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1449 	struct psmouse *psmouse;
1450 	int retval;
1451 
1452 	retval = serio_pin_driver(serio);
1453 	if (retval)
1454 		return retval;
1455 
1456 	if (serio->drv != &psmouse_drv) {
1457 		retval = -ENODEV;
1458 		goto out;
1459 	}
1460 
1461 	psmouse = serio_get_drvdata(serio);
1462 
1463 	retval = attr->show(psmouse, attr->data, buf);
1464 
1465 out:
1466 	serio_unpin_driver(serio);
1467 	return retval;
1468 }
1469 
1470 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *devattr,
1471 				const char *buf, size_t count)
1472 {
1473 	struct serio *serio = to_serio_port(dev);
1474 	struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1475 	struct psmouse *psmouse, *parent = NULL;
1476 	int retval;
1477 
1478 	retval = serio_pin_driver(serio);
1479 	if (retval)
1480 		return retval;
1481 
1482 	if (serio->drv != &psmouse_drv) {
1483 		retval = -ENODEV;
1484 		goto out_unpin;
1485 	}
1486 
1487 	retval = mutex_lock_interruptible(&psmouse_mutex);
1488 	if (retval)
1489 		goto out_unpin;
1490 
1491 	psmouse = serio_get_drvdata(serio);
1492 
1493 	if (attr->protect) {
1494 		if (psmouse->state == PSMOUSE_IGNORE) {
1495 			retval = -ENODEV;
1496 			goto out_unlock;
1497 		}
1498 
1499 		if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1500 			parent = serio_get_drvdata(serio->parent);
1501 			psmouse_deactivate(parent);
1502 		}
1503 
1504 		psmouse_deactivate(psmouse);
1505 	}
1506 
1507 	retval = attr->set(psmouse, attr->data, buf, count);
1508 
1509 	if (attr->protect) {
1510 		if (retval != -ENODEV)
1511 			psmouse_activate(psmouse);
1512 
1513 		if (parent)
1514 			psmouse_activate(parent);
1515 	}
1516 
1517  out_unlock:
1518 	mutex_unlock(&psmouse_mutex);
1519  out_unpin:
1520 	serio_unpin_driver(serio);
1521 	return retval;
1522 }
1523 
1524 static ssize_t psmouse_show_int_attr(struct psmouse *psmouse, void *offset, char *buf)
1525 {
1526 	unsigned int *field = (unsigned int *)((char *)psmouse + (size_t)offset);
1527 
1528 	return sprintf(buf, "%u\n", *field);
1529 }
1530 
1531 static ssize_t psmouse_set_int_attr(struct psmouse *psmouse, void *offset, const char *buf, size_t count)
1532 {
1533 	unsigned int *field = (unsigned int *)((char *)psmouse + (size_t)offset);
1534 	unsigned long value;
1535 
1536 	if (strict_strtoul(buf, 10, &value))
1537 		return -EINVAL;
1538 
1539 	if ((unsigned int)value != value)
1540 		return -EINVAL;
1541 
1542 	*field = value;
1543 
1544 	return count;
1545 }
1546 
1547 static ssize_t psmouse_attr_show_protocol(struct psmouse *psmouse, void *data, char *buf)
1548 {
1549 	return sprintf(buf, "%s\n", psmouse_protocol_by_type(psmouse->type)->name);
1550 }
1551 
1552 static ssize_t psmouse_attr_set_protocol(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1553 {
1554 	struct serio *serio = psmouse->ps2dev.serio;
1555 	struct psmouse *parent = NULL;
1556 	struct input_dev *old_dev, *new_dev;
1557 	const struct psmouse_protocol *proto, *old_proto;
1558 	int error;
1559 	int retry = 0;
1560 
1561 	proto = psmouse_protocol_by_name(buf, count);
1562 	if (!proto)
1563 		return -EINVAL;
1564 
1565 	if (psmouse->type == proto->type)
1566 		return count;
1567 
1568 	new_dev = input_allocate_device();
1569 	if (!new_dev)
1570 		return -ENOMEM;
1571 
1572 	while (serio->child) {
1573 		if (++retry > 3) {
1574 			printk(KERN_WARNING
1575 				"psmouse: failed to destroy child port, "
1576 				"protocol change aborted.\n");
1577 			input_free_device(new_dev);
1578 			return -EIO;
1579 		}
1580 
1581 		mutex_unlock(&psmouse_mutex);
1582 		serio_unpin_driver(serio);
1583 		serio_unregister_child_port(serio);
1584 		serio_pin_driver_uninterruptible(serio);
1585 		mutex_lock(&psmouse_mutex);
1586 
1587 		if (serio->drv != &psmouse_drv) {
1588 			input_free_device(new_dev);
1589 			return -ENODEV;
1590 		}
1591 
1592 		if (psmouse->type == proto->type) {
1593 			input_free_device(new_dev);
1594 			return count; /* switched by other thread */
1595 		}
1596 	}
1597 
1598 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1599 		parent = serio_get_drvdata(serio->parent);
1600 		if (parent->pt_deactivate)
1601 			parent->pt_deactivate(parent);
1602 	}
1603 
1604 	old_dev = psmouse->dev;
1605 	old_proto = psmouse_protocol_by_type(psmouse->type);
1606 
1607 	if (psmouse->disconnect)
1608 		psmouse->disconnect(psmouse);
1609 
1610 	psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1611 
1612 	psmouse->dev = new_dev;
1613 	psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1614 
1615 	if (psmouse_switch_protocol(psmouse, proto) < 0) {
1616 		psmouse_reset(psmouse);
1617 		/* default to PSMOUSE_PS2 */
1618 		psmouse_switch_protocol(psmouse, &psmouse_protocols[0]);
1619 	}
1620 
1621 	psmouse_initialize(psmouse);
1622 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1623 
1624 	error = input_register_device(psmouse->dev);
1625 	if (error) {
1626 		if (psmouse->disconnect)
1627 			psmouse->disconnect(psmouse);
1628 
1629 		psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1630 		input_free_device(new_dev);
1631 		psmouse->dev = old_dev;
1632 		psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1633 		psmouse_switch_protocol(psmouse, old_proto);
1634 		psmouse_initialize(psmouse);
1635 		psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1636 
1637 		return error;
1638 	}
1639 
1640 	input_unregister_device(old_dev);
1641 
1642 	if (parent && parent->pt_activate)
1643 		parent->pt_activate(parent);
1644 
1645 	return count;
1646 }
1647 
1648 static ssize_t psmouse_attr_set_rate(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1649 {
1650 	unsigned long value;
1651 
1652 	if (strict_strtoul(buf, 10, &value))
1653 		return -EINVAL;
1654 
1655 	psmouse->set_rate(psmouse, value);
1656 	return count;
1657 }
1658 
1659 static ssize_t psmouse_attr_set_resolution(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1660 {
1661 	unsigned long value;
1662 
1663 	if (strict_strtoul(buf, 10, &value))
1664 		return -EINVAL;
1665 
1666 	psmouse->set_resolution(psmouse, value);
1667 	return count;
1668 }
1669 
1670 
1671 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp)
1672 {
1673 	const struct psmouse_protocol *proto;
1674 
1675 	if (!val)
1676 		return -EINVAL;
1677 
1678 	proto = psmouse_protocol_by_name(val, strlen(val));
1679 
1680 	if (!proto || !proto->maxproto)
1681 		return -EINVAL;
1682 
1683 	*((unsigned int *)kp->arg) = proto->type;
1684 
1685 	return 0;
1686 }
1687 
1688 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp)
1689 {
1690 	int type = *((unsigned int *)kp->arg);
1691 
1692 	return sprintf(buffer, "%s", psmouse_protocol_by_type(type)->name);
1693 }
1694 
1695 static int __init psmouse_init(void)
1696 {
1697 	int err;
1698 
1699 	lifebook_module_init();
1700 	synaptics_module_init();
1701 
1702 	kpsmoused_wq = create_singlethread_workqueue("kpsmoused");
1703 	if (!kpsmoused_wq) {
1704 		printk(KERN_ERR "psmouse: failed to create kpsmoused workqueue\n");
1705 		return -ENOMEM;
1706 	}
1707 
1708 	err = serio_register_driver(&psmouse_drv);
1709 	if (err)
1710 		destroy_workqueue(kpsmoused_wq);
1711 
1712 	return err;
1713 }
1714 
1715 static void __exit psmouse_exit(void)
1716 {
1717 	serio_unregister_driver(&psmouse_drv);
1718 	destroy_workqueue(kpsmoused_wq);
1719 }
1720 
1721 module_init(psmouse_init);
1722 module_exit(psmouse_exit);
1723