xref: /linux/drivers/input/mouse/psmouse-base.c (revision d67b569f5f620c0fb95d5212642746b7ba9d29e4)
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/moduleparam.h>
17 #include <linux/slab.h>
18 #include <linux/interrupt.h>
19 #include <linux/input.h>
20 #include <linux/serio.h>
21 #include <linux/init.h>
22 #include <linux/libps2.h>
23 #include "psmouse.h"
24 #include "synaptics.h"
25 #include "logips2pp.h"
26 #include "alps.h"
27 #include "lifebook.h"
28 
29 #define DRIVER_DESC	"PS/2 mouse driver"
30 
31 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
32 MODULE_DESCRIPTION(DRIVER_DESC);
33 MODULE_LICENSE("GPL");
34 
35 static unsigned int psmouse_max_proto = PSMOUSE_AUTO;
36 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp);
37 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp);
38 #define param_check_proto_abbrev(name, p)	__param_check(name, p, unsigned int)
39 #define param_set_proto_abbrev			psmouse_set_maxproto
40 #define param_get_proto_abbrev			psmouse_get_maxproto
41 module_param_named(proto, psmouse_max_proto, proto_abbrev, 0644);
42 MODULE_PARM_DESC(proto, "Highest protocol extension to probe (bare, imps, exps, any). Useful for KVM switches.");
43 
44 static unsigned int psmouse_resolution = 200;
45 module_param_named(resolution, psmouse_resolution, uint, 0644);
46 MODULE_PARM_DESC(resolution, "Resolution, in dpi.");
47 
48 static unsigned int psmouse_rate = 100;
49 module_param_named(rate, psmouse_rate, uint, 0644);
50 MODULE_PARM_DESC(rate, "Report rate, in reports per second.");
51 
52 static unsigned int psmouse_smartscroll = 1;
53 module_param_named(smartscroll, psmouse_smartscroll, bool, 0644);
54 MODULE_PARM_DESC(smartscroll, "Logitech Smartscroll autorepeat, 1 = enabled (default), 0 = disabled.");
55 
56 static unsigned int psmouse_resetafter;
57 module_param_named(resetafter, psmouse_resetafter, uint, 0644);
58 MODULE_PARM_DESC(resetafter, "Reset device after so many bad packets (0 = never).");
59 
60 PSMOUSE_DEFINE_ATTR(protocol);
61 PSMOUSE_DEFINE_ATTR(rate);
62 PSMOUSE_DEFINE_ATTR(resolution);
63 PSMOUSE_DEFINE_ATTR(resetafter);
64 
65 __obsolete_setup("psmouse_noext");
66 __obsolete_setup("psmouse_resolution=");
67 __obsolete_setup("psmouse_smartscroll=");
68 __obsolete_setup("psmouse_resetafter=");
69 __obsolete_setup("psmouse_rate=");
70 
71 /*
72  * psmouse_sem protects all operations changing state of mouse
73  * (connecting, disconnecting, changing rate or resolution via
74  * sysfs). We could use a per-device semaphore but since there
75  * rarely more than one PS/2 mouse connected and since semaphore
76  * is taken in "slow" paths it is not worth it.
77  */
78 static DECLARE_MUTEX(psmouse_sem);
79 
80 struct psmouse_protocol {
81 	enum psmouse_type type;
82 	char *name;
83 	char *alias;
84 	int maxproto;
85 	int (*detect)(struct psmouse *, int);
86 	int (*init)(struct psmouse *);
87 };
88 
89 /*
90  * psmouse_process_byte() analyzes the PS/2 data stream and reports
91  * relevant events to the input module once full packet has arrived.
92  */
93 
94 static psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
95 {
96 	struct input_dev *dev = &psmouse->dev;
97 	unsigned char *packet = psmouse->packet;
98 
99 	if (psmouse->pktcnt < psmouse->pktsize)
100 		return PSMOUSE_GOOD_DATA;
101 
102 /*
103  * Full packet accumulated, process it
104  */
105 
106 	input_regs(dev, regs);
107 
108 /*
109  * Scroll wheel on IntelliMice, scroll buttons on NetMice
110  */
111 
112 	if (psmouse->type == PSMOUSE_IMPS || psmouse->type == PSMOUSE_GENPS)
113 		input_report_rel(dev, REL_WHEEL, -(signed char) packet[3]);
114 
115 /*
116  * Scroll wheel and buttons on IntelliMouse Explorer
117  */
118 
119 	if (psmouse->type == PSMOUSE_IMEX) {
120 		input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 8) - (int) (packet[3] & 7));
121 		input_report_key(dev, BTN_SIDE, (packet[3] >> 4) & 1);
122 		input_report_key(dev, BTN_EXTRA, (packet[3] >> 5) & 1);
123 	}
124 
125 /*
126  * Extra buttons on Genius NewNet 3D
127  */
128 
129 	if (psmouse->type == PSMOUSE_GENPS) {
130 		input_report_key(dev, BTN_SIDE, (packet[0] >> 6) & 1);
131 		input_report_key(dev, BTN_EXTRA, (packet[0] >> 7) & 1);
132 	}
133 
134 /*
135  * Extra button on ThinkingMouse
136  */
137 	if (psmouse->type == PSMOUSE_THINKPS) {
138 		input_report_key(dev, BTN_EXTRA, (packet[0] >> 3) & 1);
139 		/* Without this bit of weirdness moving up gives wildly high Y changes. */
140 		packet[1] |= (packet[0] & 0x40) << 1;
141 	}
142 
143 /*
144  * Generic PS/2 Mouse
145  */
146 
147 	input_report_key(dev, BTN_LEFT,    packet[0]       & 1);
148 	input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
149 	input_report_key(dev, BTN_RIGHT,  (packet[0] >> 1) & 1);
150 
151 	input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
152 	input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
153 
154 	input_sync(dev);
155 
156 	return PSMOUSE_FULL_PACKET;
157 }
158 
159 /*
160  * psmouse_interrupt() handles incoming characters, either gathering them into
161  * packets or passing them to the command routine as command output.
162  */
163 
164 static irqreturn_t psmouse_interrupt(struct serio *serio,
165 		unsigned char data, unsigned int flags, struct pt_regs *regs)
166 {
167 	struct psmouse *psmouse = serio_get_drvdata(serio);
168 	psmouse_ret_t rc;
169 
170 	if (psmouse->state == PSMOUSE_IGNORE)
171 		goto out;
172 
173 	if (flags & (SERIO_PARITY|SERIO_TIMEOUT)) {
174 		if (psmouse->state == PSMOUSE_ACTIVATED)
175 			printk(KERN_WARNING "psmouse.c: bad data from KBC -%s%s\n",
176 				flags & SERIO_TIMEOUT ? " timeout" : "",
177 				flags & SERIO_PARITY ? " bad parity" : "");
178 		ps2_cmd_aborted(&psmouse->ps2dev);
179 		goto out;
180 	}
181 
182 	if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_ACK))
183 		if  (ps2_handle_ack(&psmouse->ps2dev, data))
184 			goto out;
185 
186 	if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_CMD))
187 		if  (ps2_handle_response(&psmouse->ps2dev, data))
188 			goto out;
189 
190 	if (psmouse->state == PSMOUSE_INITIALIZING)
191 		goto out;
192 
193 	if (psmouse->state == PSMOUSE_ACTIVATED &&
194 	    psmouse->pktcnt && time_after(jiffies, psmouse->last + HZ/2)) {
195 		printk(KERN_WARNING "psmouse.c: %s at %s lost synchronization, throwing %d bytes away.\n",
196 		       psmouse->name, psmouse->phys, psmouse->pktcnt);
197 		psmouse->pktcnt = 0;
198 	}
199 
200 	psmouse->last = jiffies;
201 	psmouse->packet[psmouse->pktcnt++] = data;
202 
203 	if (psmouse->packet[0] == PSMOUSE_RET_BAT) {
204 		if (psmouse->pktcnt == 1)
205 			goto out;
206 
207 		if (psmouse->pktcnt == 2) {
208 			if (psmouse->packet[1] == PSMOUSE_RET_ID) {
209 				psmouse->state = PSMOUSE_IGNORE;
210 				serio_reconnect(serio);
211 				goto out;
212 			}
213 			if (psmouse->type == PSMOUSE_SYNAPTICS) {
214 				/* neither 0xAA nor 0x00 are valid first bytes
215 				 * for a packet in absolute mode
216 				 */
217 				psmouse->pktcnt = 0;
218 				goto out;
219 			}
220 		}
221 	}
222 
223 	rc = psmouse->protocol_handler(psmouse, regs);
224 
225 	switch (rc) {
226 		case PSMOUSE_BAD_DATA:
227 			printk(KERN_WARNING "psmouse.c: %s at %s lost sync at byte %d\n",
228 				psmouse->name, psmouse->phys, psmouse->pktcnt);
229 			psmouse->pktcnt = 0;
230 
231 			if (++psmouse->out_of_sync == psmouse->resetafter) {
232 				psmouse->state = PSMOUSE_IGNORE;
233 				printk(KERN_NOTICE "psmouse.c: issuing reconnect request\n");
234 				serio_reconnect(psmouse->ps2dev.serio);
235 			}
236 			break;
237 
238 		case PSMOUSE_FULL_PACKET:
239 			psmouse->pktcnt = 0;
240 			if (psmouse->out_of_sync) {
241 				psmouse->out_of_sync = 0;
242 				printk(KERN_NOTICE "psmouse.c: %s at %s - driver resynched.\n",
243 					psmouse->name, psmouse->phys);
244 			}
245 			break;
246 
247 		case PSMOUSE_GOOD_DATA:
248 			break;
249 	}
250 out:
251 	return IRQ_HANDLED;
252 }
253 
254 
255 /*
256  * psmouse_sliced_command() sends an extended PS/2 command to the mouse
257  * using sliced syntax, understood by advanced devices, such as Logitech
258  * or Synaptics touchpads. The command is encoded as:
259  * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
260  * is the command.
261  */
262 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command)
263 {
264 	int i;
265 
266 	if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11))
267 		return -1;
268 
269 	for (i = 6; i >= 0; i -= 2) {
270 		unsigned char d = (command >> i) & 3;
271 		if (ps2_command(&psmouse->ps2dev, &d, PSMOUSE_CMD_SETRES))
272 			return -1;
273 	}
274 
275 	return 0;
276 }
277 
278 
279 /*
280  * psmouse_reset() resets the mouse into power-on state.
281  */
282 int psmouse_reset(struct psmouse *psmouse)
283 {
284 	unsigned char param[2];
285 
286 	if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_RESET_BAT))
287 		return -1;
288 
289 	if (param[0] != PSMOUSE_RET_BAT && param[1] != PSMOUSE_RET_ID)
290 		return -1;
291 
292 	return 0;
293 }
294 
295 
296 /*
297  * Genius NetMouse magic init.
298  */
299 static int genius_detect(struct psmouse *psmouse, int set_properties)
300 {
301 	struct ps2dev *ps2dev = &psmouse->ps2dev;
302 	unsigned char param[4];
303 
304 	param[0] = 3;
305 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
306 	ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
307 	ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
308 	ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
309 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
310 
311 	if (param[0] != 0x00 || param[1] != 0x33 || param[2] != 0x55)
312 		return -1;
313 
314 	if (set_properties) {
315 		set_bit(BTN_EXTRA, psmouse->dev.keybit);
316 		set_bit(BTN_SIDE, psmouse->dev.keybit);
317 		set_bit(REL_WHEEL, psmouse->dev.relbit);
318 
319 		psmouse->vendor = "Genius";
320 		psmouse->name = "Wheel Mouse";
321 		psmouse->pktsize = 4;
322 	}
323 
324 	return 0;
325 }
326 
327 /*
328  * IntelliMouse magic init.
329  */
330 static int intellimouse_detect(struct psmouse *psmouse, int set_properties)
331 {
332 	struct ps2dev *ps2dev = &psmouse->ps2dev;
333 	unsigned char param[2];
334 
335 	param[0] = 200;
336 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
337 	param[0] = 100;
338 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
339 	param[0] =  80;
340 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
341 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
342 
343 	if (param[0] != 3)
344 		return -1;
345 
346 	if (set_properties) {
347 		set_bit(REL_WHEEL, psmouse->dev.relbit);
348 
349 		if (!psmouse->vendor) psmouse->vendor = "Generic";
350 		if (!psmouse->name) psmouse->name = "Wheel Mouse";
351 		psmouse->pktsize = 4;
352 	}
353 
354 	return 0;
355 }
356 
357 /*
358  * Try IntelliMouse/Explorer magic init.
359  */
360 static int im_explorer_detect(struct psmouse *psmouse, int set_properties)
361 {
362 	struct ps2dev *ps2dev = &psmouse->ps2dev;
363 	unsigned char param[2];
364 
365 	intellimouse_detect(psmouse, 0);
366 
367 	param[0] = 200;
368 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
369 	param[0] = 200;
370 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
371 	param[0] =  80;
372 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
373 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
374 
375 	if (param[0] != 4)
376 		return -1;
377 
378 	if (set_properties) {
379 		set_bit(REL_WHEEL, psmouse->dev.relbit);
380 		set_bit(BTN_SIDE, psmouse->dev.keybit);
381 		set_bit(BTN_EXTRA, psmouse->dev.keybit);
382 
383 		if (!psmouse->vendor) psmouse->vendor = "Generic";
384 		if (!psmouse->name) psmouse->name = "Explorer Mouse";
385 		psmouse->pktsize = 4;
386 	}
387 
388 	return 0;
389 }
390 
391 /*
392  * Kensington ThinkingMouse / ExpertMouse magic init.
393  */
394 static int thinking_detect(struct psmouse *psmouse, int set_properties)
395 {
396 	struct ps2dev *ps2dev = &psmouse->ps2dev;
397 	unsigned char param[2];
398 	unsigned char seq[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20, 0 };
399 	int i;
400 
401 	param[0] = 10;
402 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
403 	param[0] = 0;
404 	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
405 	for (i = 0; seq[i]; i++)
406 		ps2_command(ps2dev, seq + i, PSMOUSE_CMD_SETRATE);
407 	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
408 
409 	if (param[0] != 2)
410 		return -1;
411 
412 	if (set_properties) {
413 		set_bit(BTN_EXTRA, psmouse->dev.keybit);
414 
415 		psmouse->vendor = "Kensington";
416 		psmouse->name = "ThinkingMouse";
417 	}
418 
419 	return 0;
420 }
421 
422 /*
423  * Bare PS/2 protocol "detection". Always succeeds.
424  */
425 static int ps2bare_detect(struct psmouse *psmouse, int set_properties)
426 {
427 	if (set_properties) {
428 		if (!psmouse->vendor) psmouse->vendor = "Generic";
429 		if (!psmouse->name) psmouse->name = "Mouse";
430 	}
431 
432 	return 0;
433 }
434 
435 
436 /*
437  * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
438  * the mouse may have.
439  */
440 
441 static int psmouse_extensions(struct psmouse *psmouse,
442 			      unsigned int max_proto, int set_properties)
443 {
444 	int synaptics_hardware = 0;
445 
446 /*
447  * We always check for lifebook because it does not disturb mouse
448  * (it only checks DMI information).
449  */
450 	if (lifebook_detect(psmouse, set_properties) == 0) {
451 		if (max_proto > PSMOUSE_IMEX) {
452 			if (!set_properties || lifebook_init(psmouse) == 0)
453 				return PSMOUSE_LIFEBOOK;
454 		}
455 	}
456 
457 /*
458  * Try Kensington ThinkingMouse (we try first, because synaptics probe
459  * upsets the thinkingmouse).
460  */
461 
462 	if (max_proto > PSMOUSE_IMEX && thinking_detect(psmouse, set_properties) == 0)
463 		return PSMOUSE_THINKPS;
464 
465 /*
466  * Try Synaptics TouchPad
467  */
468 	if (max_proto > PSMOUSE_PS2 && synaptics_detect(psmouse, set_properties) == 0) {
469 		synaptics_hardware = 1;
470 
471 		if (max_proto > PSMOUSE_IMEX) {
472 			if (!set_properties || synaptics_init(psmouse) == 0)
473 				return PSMOUSE_SYNAPTICS;
474 /*
475  * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
476  * Unfortunately Logitech/Genius probes confuse some firmware versions so
477  * we'll have to skip them.
478  */
479 			max_proto = PSMOUSE_IMEX;
480 		}
481 /*
482  * Make sure that touchpad is in relative mode, gestures (taps) are enabled
483  */
484 		synaptics_reset(psmouse);
485 	}
486 
487 /*
488  * Try ALPS TouchPad
489  */
490 	if (max_proto > PSMOUSE_IMEX) {
491 		ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
492 		if (alps_detect(psmouse, set_properties) == 0) {
493 			if (!set_properties || alps_init(psmouse) == 0)
494 				return PSMOUSE_ALPS;
495 /*
496  * Init failed, try basic relative protocols
497  */
498 			max_proto = PSMOUSE_IMEX;
499 		}
500 	}
501 
502 	if (max_proto > PSMOUSE_IMEX && genius_detect(psmouse, set_properties) == 0)
503 		return PSMOUSE_GENPS;
504 
505 	if (max_proto > PSMOUSE_IMEX && ps2pp_init(psmouse, set_properties) == 0)
506 		return PSMOUSE_PS2PP;
507 
508 /*
509  * Reset to defaults in case the device got confused by extended
510  * protocol probes.
511  */
512 	ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
513 
514 	if (max_proto >= PSMOUSE_IMEX && im_explorer_detect(psmouse, set_properties) == 0)
515 		return PSMOUSE_IMEX;
516 
517 	if (max_proto >= PSMOUSE_IMPS && intellimouse_detect(psmouse, set_properties) == 0)
518 		return PSMOUSE_IMPS;
519 
520 /*
521  * Okay, all failed, we have a standard mouse here. The number of the buttons
522  * is still a question, though. We assume 3.
523  */
524 	ps2bare_detect(psmouse, set_properties);
525 
526 	if (synaptics_hardware) {
527 /*
528  * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
529  * We need to reset the touchpad because if there is a track point on the
530  * pass through port it could get disabled while probing for protocol
531  * extensions.
532  */
533 		psmouse_reset(psmouse);
534 		ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
535 	}
536 
537 	return PSMOUSE_PS2;
538 }
539 
540 static struct psmouse_protocol psmouse_protocols[] = {
541 	{
542 		.type		= PSMOUSE_PS2,
543 		.name		= "PS/2",
544 		.alias		= "bare",
545 		.maxproto	= 1,
546 		.detect		= ps2bare_detect,
547 	},
548 	{
549 		.type		= PSMOUSE_PS2PP,
550 		.name		= "PS2++",
551 		.alias		= "logitech",
552 		.detect		= ps2pp_init,
553 	},
554 	{
555 		.type		= PSMOUSE_THINKPS,
556 		.name		= "ThinkPS/2",
557 		.alias		= "thinkps",
558 		.detect		= thinking_detect,
559 	},
560 	{
561 		.type		= PSMOUSE_GENPS,
562 		.name		= "GenPS/2",
563 		.alias		= "genius",
564 		.detect		= genius_detect,
565 	},
566 	{
567 		.type		= PSMOUSE_IMPS,
568 		.name		= "ImPS/2",
569 		.alias		= "imps",
570 		.maxproto	= 1,
571 		.detect		= intellimouse_detect,
572 	},
573 	{
574 		.type		= PSMOUSE_IMEX,
575 		.name		= "ImExPS/2",
576 		.alias		= "exps",
577 		.maxproto	= 1,
578 		.detect		= im_explorer_detect,
579 	},
580 	{
581 		.type		= PSMOUSE_SYNAPTICS,
582 		.name		= "SynPS/2",
583 		.alias		= "synaptics",
584 		.detect		= synaptics_detect,
585 		.init		= synaptics_init,
586 	},
587 	{
588 		.type		= PSMOUSE_ALPS,
589 		.name		= "AlpsPS/2",
590 		.alias		= "alps",
591 		.detect		= alps_detect,
592 		.init		= alps_init,
593 	},
594 	{
595 		.type		= PSMOUSE_LIFEBOOK,
596 		.name		= "LBPS/2",
597 		.alias		= "lifebook",
598 		.init		= lifebook_init,
599 	},
600 	{
601 		.type		= PSMOUSE_AUTO,
602 		.name		= "auto",
603 		.alias		= "any",
604 		.maxproto	= 1,
605 	},
606 };
607 
608 static struct psmouse_protocol *psmouse_protocol_by_type(enum psmouse_type type)
609 {
610 	int i;
611 
612 	for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++)
613 		if (psmouse_protocols[i].type == type)
614 			return &psmouse_protocols[i];
615 
616 	WARN_ON(1);
617 	return &psmouse_protocols[0];
618 }
619 
620 static struct psmouse_protocol *psmouse_protocol_by_name(const char *name, size_t len)
621 {
622 	struct psmouse_protocol *p;
623 	int i;
624 
625 	for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++) {
626 		p = &psmouse_protocols[i];
627 
628 		if ((strlen(p->name) == len && !strncmp(p->name, name, len)) ||
629 		    (strlen(p->alias) == len && !strncmp(p->alias, name, len)))
630 			return &psmouse_protocols[i];
631 	}
632 
633 	return NULL;
634 }
635 
636 
637 /*
638  * psmouse_probe() probes for a PS/2 mouse.
639  */
640 
641 static int psmouse_probe(struct psmouse *psmouse)
642 {
643 	struct ps2dev *ps2dev = &psmouse->ps2dev;
644 	unsigned char param[2];
645 
646 /*
647  * First, we check if it's a mouse. It should send 0x00 or 0x03
648  * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
649  * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
650  * ID queries, probably due to a firmware bug.
651  */
652 
653 	param[0] = 0xa5;
654 	if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
655 		return -1;
656 
657 	if (param[0] != 0x00 && param[0] != 0x03 &&
658 	    param[0] != 0x04 && param[0] != 0xff)
659 		return -1;
660 
661 /*
662  * Then we reset and disable the mouse so that it doesn't generate events.
663  */
664 
665 	if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS))
666 		printk(KERN_WARNING "psmouse.c: Failed to reset mouse on %s\n", ps2dev->serio->phys);
667 
668 	return 0;
669 }
670 
671 /*
672  * Here we set the mouse resolution.
673  */
674 
675 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution)
676 {
677 	unsigned char params[] = { 0, 1, 2, 2, 3 };
678 
679 	if (resolution == 0 || resolution > 200)
680 		resolution = 200;
681 
682 	ps2_command(&psmouse->ps2dev, &params[resolution / 50], PSMOUSE_CMD_SETRES);
683 	psmouse->resolution = 25 << params[resolution / 50];
684 }
685 
686 /*
687  * Here we set the mouse report rate.
688  */
689 
690 static void psmouse_set_rate(struct psmouse *psmouse, unsigned int rate)
691 {
692 	unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
693 	int i = 0;
694 
695 	while (rates[i] > rate) i++;
696 	ps2_command(&psmouse->ps2dev, &rates[i], PSMOUSE_CMD_SETRATE);
697 	psmouse->rate = rates[i];
698 }
699 
700 /*
701  * psmouse_initialize() initializes the mouse to a sane state.
702  */
703 
704 static void psmouse_initialize(struct psmouse *psmouse)
705 {
706 /*
707  * We set the mouse into streaming mode.
708  */
709 
710 	ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM);
711 
712 /*
713  * We set the mouse report rate, resolution and scaling.
714  */
715 
716 	if (psmouse_max_proto != PSMOUSE_PS2) {
717 		psmouse->set_rate(psmouse, psmouse->rate);
718 		psmouse->set_resolution(psmouse, psmouse->resolution);
719 		ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
720 	}
721 }
722 
723 /*
724  * psmouse_set_state() sets new psmouse state and resets all flags and
725  * counters while holding serio lock so fighting with interrupt handler
726  * is not a concern.
727  */
728 
729 static void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
730 {
731 	serio_pause_rx(psmouse->ps2dev.serio);
732 	psmouse->state = new_state;
733 	psmouse->pktcnt = psmouse->out_of_sync = 0;
734 	psmouse->ps2dev.flags = 0;
735 	serio_continue_rx(psmouse->ps2dev.serio);
736 }
737 
738 /*
739  * psmouse_activate() enables the mouse so that we get motion reports from it.
740  */
741 
742 static void psmouse_activate(struct psmouse *psmouse)
743 {
744 	if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE))
745 		printk(KERN_WARNING "psmouse.c: Failed to enable mouse on %s\n",
746 			psmouse->ps2dev.serio->phys);
747 
748 	psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
749 }
750 
751 
752 /*
753  * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
754  * reports from it unless we explicitely request it.
755  */
756 
757 static void psmouse_deactivate(struct psmouse *psmouse)
758 {
759 	if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_DISABLE))
760 		printk(KERN_WARNING "psmouse.c: Failed to deactivate mouse on %s\n",
761 			psmouse->ps2dev.serio->phys);
762 
763 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
764 }
765 
766 
767 /*
768  * psmouse_cleanup() resets the mouse into power-on state.
769  */
770 
771 static void psmouse_cleanup(struct serio *serio)
772 {
773 	struct psmouse *psmouse = serio_get_drvdata(serio);
774 
775 	psmouse_reset(psmouse);
776 }
777 
778 /*
779  * psmouse_disconnect() closes and frees.
780  */
781 
782 static void psmouse_disconnect(struct serio *serio)
783 {
784 	struct psmouse *psmouse, *parent = NULL;
785 
786 	psmouse = serio_get_drvdata(serio);
787 
788 	device_remove_file(&serio->dev, &psmouse_attr_protocol);
789 	device_remove_file(&serio->dev, &psmouse_attr_rate);
790 	device_remove_file(&serio->dev, &psmouse_attr_resolution);
791 	device_remove_file(&serio->dev, &psmouse_attr_resetafter);
792 
793 	down(&psmouse_sem);
794 
795 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
796 
797 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
798 		parent = serio_get_drvdata(serio->parent);
799 		psmouse_deactivate(parent);
800 	}
801 
802 	if (psmouse->disconnect)
803 		psmouse->disconnect(psmouse);
804 
805 	if (parent && parent->pt_deactivate)
806 		parent->pt_deactivate(parent);
807 
808 	psmouse_set_state(psmouse, PSMOUSE_IGNORE);
809 
810 	input_unregister_device(&psmouse->dev);
811 	serio_close(serio);
812 	serio_set_drvdata(serio, NULL);
813 	kfree(psmouse);
814 
815 	if (parent)
816 		psmouse_activate(parent);
817 
818 	up(&psmouse_sem);
819 }
820 
821 static int psmouse_switch_protocol(struct psmouse *psmouse, struct psmouse_protocol *proto)
822 {
823 	memset(&psmouse->dev, 0, sizeof(struct input_dev));
824 
825 	init_input_dev(&psmouse->dev);
826 
827 	psmouse->dev.private = psmouse;
828 	psmouse->dev.dev = &psmouse->ps2dev.serio->dev;
829 
830 	psmouse->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
831 	psmouse->dev.keybit[LONG(BTN_MOUSE)] = BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
832 	psmouse->dev.relbit[0] = BIT(REL_X) | BIT(REL_Y);
833 
834 	psmouse->set_rate = psmouse_set_rate;
835 	psmouse->set_resolution = psmouse_set_resolution;
836 	psmouse->protocol_handler = psmouse_process_byte;
837 	psmouse->pktsize = 3;
838 
839 	if (proto && (proto->detect || proto->init)) {
840 		if (proto->detect && proto->detect(psmouse, 1) < 0)
841 			return -1;
842 
843 		if (proto->init && proto->init(psmouse) < 0)
844 			return -1;
845 
846 		psmouse->type = proto->type;
847 	}
848 	else
849 		psmouse->type = psmouse_extensions(psmouse, psmouse_max_proto, 1);
850 
851 	sprintf(psmouse->devname, "%s %s %s",
852 		psmouse_protocol_by_type(psmouse->type)->name, psmouse->vendor, psmouse->name);
853 
854 	psmouse->dev.name = psmouse->devname;
855 	psmouse->dev.phys = psmouse->phys;
856 	psmouse->dev.id.bustype = BUS_I8042;
857 	psmouse->dev.id.vendor = 0x0002;
858 	psmouse->dev.id.product = psmouse->type;
859 	psmouse->dev.id.version = psmouse->model;
860 
861 	return 0;
862 }
863 
864 /*
865  * psmouse_connect() is a callback from the serio module when
866  * an unhandled serio port is found.
867  */
868 static int psmouse_connect(struct serio *serio, struct serio_driver *drv)
869 {
870 	struct psmouse *psmouse, *parent = NULL;
871 	int retval;
872 
873 	down(&psmouse_sem);
874 
875 	/*
876 	 * If this is a pass-through port deactivate parent so the device
877 	 * connected to this port can be successfully identified
878 	 */
879 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
880 		parent = serio_get_drvdata(serio->parent);
881 		psmouse_deactivate(parent);
882 	}
883 
884 	if (!(psmouse = kcalloc(1, sizeof(struct psmouse), GFP_KERNEL))) {
885 		retval = -ENOMEM;
886 		goto out;
887 	}
888 
889 	ps2_init(&psmouse->ps2dev, serio);
890 	sprintf(psmouse->phys, "%s/input0", serio->phys);
891 
892 	psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
893 
894 	serio_set_drvdata(serio, psmouse);
895 
896 	retval = serio_open(serio, drv);
897 	if (retval) {
898 		serio_set_drvdata(serio, NULL);
899 		kfree(psmouse);
900 		goto out;
901 	}
902 
903 	if (psmouse_probe(psmouse) < 0) {
904 		serio_close(serio);
905 		serio_set_drvdata(serio, NULL);
906 		kfree(psmouse);
907 		retval = -ENODEV;
908 		goto out;
909 	}
910 
911 	psmouse->rate = psmouse_rate;
912 	psmouse->resolution = psmouse_resolution;
913 	psmouse->resetafter = psmouse_resetafter;
914 	psmouse->smartscroll = psmouse_smartscroll;
915 
916 	psmouse_switch_protocol(psmouse, NULL);
917 
918 	input_register_device(&psmouse->dev);
919 	printk(KERN_INFO "input: %s on %s\n", psmouse->devname, serio->phys);
920 
921 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
922 
923 	psmouse_initialize(psmouse);
924 
925 	if (parent && parent->pt_activate)
926 		parent->pt_activate(parent);
927 
928 	device_create_file(&serio->dev, &psmouse_attr_protocol);
929 	device_create_file(&serio->dev, &psmouse_attr_rate);
930 	device_create_file(&serio->dev, &psmouse_attr_resolution);
931 	device_create_file(&serio->dev, &psmouse_attr_resetafter);
932 
933 	psmouse_activate(psmouse);
934 
935 	retval = 0;
936 
937 out:
938 	/* If this is a pass-through port the parent needs to be re-activated */
939 	if (parent)
940 		psmouse_activate(parent);
941 
942 	up(&psmouse_sem);
943 	return retval;
944 }
945 
946 
947 static int psmouse_reconnect(struct serio *serio)
948 {
949 	struct psmouse *psmouse = serio_get_drvdata(serio);
950 	struct psmouse *parent = NULL;
951 	struct serio_driver *drv = serio->drv;
952 	int rc = -1;
953 
954 	if (!drv || !psmouse) {
955 		printk(KERN_DEBUG "psmouse: reconnect request, but serio is disconnected, ignoring...\n");
956 		return -1;
957 	}
958 
959 	down(&psmouse_sem);
960 
961 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
962 		parent = serio_get_drvdata(serio->parent);
963 		psmouse_deactivate(parent);
964 	}
965 
966 	psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
967 
968 	if (psmouse->reconnect) {
969 		if (psmouse->reconnect(psmouse))
970 			goto out;
971 	} else if (psmouse_probe(psmouse) < 0 ||
972 		   psmouse->type != psmouse_extensions(psmouse, psmouse_max_proto, 0))
973 		goto out;
974 
975 	/* ok, the device type (and capabilities) match the old one,
976 	 * we can continue using it, complete intialization
977 	 */
978 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
979 
980 	psmouse_initialize(psmouse);
981 
982 	if (parent && parent->pt_activate)
983 		parent->pt_activate(parent);
984 
985 	psmouse_activate(psmouse);
986 	rc = 0;
987 
988 out:
989 	/* If this is a pass-through port the parent waits to be activated */
990 	if (parent)
991 		psmouse_activate(parent);
992 
993 	up(&psmouse_sem);
994 	return rc;
995 }
996 
997 static struct serio_device_id psmouse_serio_ids[] = {
998 	{
999 		.type	= SERIO_8042,
1000 		.proto	= SERIO_ANY,
1001 		.id	= SERIO_ANY,
1002 		.extra	= SERIO_ANY,
1003 	},
1004 	{
1005 		.type	= SERIO_PS_PSTHRU,
1006 		.proto	= SERIO_ANY,
1007 		.id	= SERIO_ANY,
1008 		.extra	= SERIO_ANY,
1009 	},
1010 	{ 0 }
1011 };
1012 
1013 MODULE_DEVICE_TABLE(serio, psmouse_serio_ids);
1014 
1015 static struct serio_driver psmouse_drv = {
1016 	.driver		= {
1017 		.name	= "psmouse",
1018 	},
1019 	.description	= DRIVER_DESC,
1020 	.id_table	= psmouse_serio_ids,
1021 	.interrupt	= psmouse_interrupt,
1022 	.connect	= psmouse_connect,
1023 	.reconnect	= psmouse_reconnect,
1024 	.disconnect	= psmouse_disconnect,
1025 	.cleanup	= psmouse_cleanup,
1026 };
1027 
1028 ssize_t psmouse_attr_show_helper(struct device *dev, char *buf,
1029 				 ssize_t (*handler)(struct psmouse *, char *))
1030 {
1031 	struct serio *serio = to_serio_port(dev);
1032 	int retval;
1033 
1034 	retval = serio_pin_driver(serio);
1035 	if (retval)
1036 		return retval;
1037 
1038 	if (serio->drv != &psmouse_drv) {
1039 		retval = -ENODEV;
1040 		goto out;
1041 	}
1042 
1043 	retval = handler(serio_get_drvdata(serio), buf);
1044 
1045 out:
1046 	serio_unpin_driver(serio);
1047 	return retval;
1048 }
1049 
1050 ssize_t psmouse_attr_set_helper(struct device *dev, const char *buf, size_t count,
1051 				ssize_t (*handler)(struct psmouse *, const char *, size_t))
1052 {
1053 	struct serio *serio = to_serio_port(dev);
1054 	struct psmouse *psmouse = serio_get_drvdata(serio);
1055 	struct psmouse *parent = NULL;
1056 	int retval;
1057 
1058 	retval = serio_pin_driver(serio);
1059 	if (retval)
1060 		return retval;
1061 
1062 	if (serio->drv != &psmouse_drv) {
1063 		retval = -ENODEV;
1064 		goto out_unpin;
1065 	}
1066 
1067 	retval = down_interruptible(&psmouse_sem);
1068 	if (retval)
1069 		goto out_unpin;
1070 
1071 	if (psmouse->state == PSMOUSE_IGNORE) {
1072 		retval = -ENODEV;
1073 		goto out_up;
1074 	}
1075 
1076 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1077 		parent = serio_get_drvdata(serio->parent);
1078 		psmouse_deactivate(parent);
1079 	}
1080 
1081 	psmouse_deactivate(psmouse);
1082 
1083 	retval = handler(psmouse, buf, count);
1084 
1085 	if (retval != -ENODEV)
1086 		psmouse_activate(psmouse);
1087 
1088 	if (parent)
1089 		psmouse_activate(parent);
1090 
1091  out_up:
1092 	up(&psmouse_sem);
1093  out_unpin:
1094 	serio_unpin_driver(serio);
1095 	return retval;
1096 }
1097 
1098 static ssize_t psmouse_attr_show_protocol(struct psmouse *psmouse, char *buf)
1099 {
1100 	return sprintf(buf, "%s\n", psmouse_protocol_by_type(psmouse->type)->name);
1101 }
1102 
1103 static ssize_t psmouse_attr_set_protocol(struct psmouse *psmouse, const char *buf, size_t count)
1104 {
1105 	struct serio *serio = psmouse->ps2dev.serio;
1106 	struct psmouse *parent = NULL;
1107 	struct psmouse_protocol *proto;
1108 	int retry = 0;
1109 
1110 	if (!(proto = psmouse_protocol_by_name(buf, count)))
1111 		return -EINVAL;
1112 
1113 	if (psmouse->type == proto->type)
1114 		return count;
1115 
1116 	while (serio->child) {
1117 		if (++retry > 3) {
1118 			printk(KERN_WARNING "psmouse: failed to destroy child port, protocol change aborted.\n");
1119 			return -EIO;
1120 		}
1121 
1122 		up(&psmouse_sem);
1123 		serio_unpin_driver(serio);
1124 		serio_unregister_child_port(serio);
1125 		serio_pin_driver_uninterruptible(serio);
1126 		down(&psmouse_sem);
1127 
1128 		if (serio->drv != &psmouse_drv)
1129 			return -ENODEV;
1130 
1131 		if (psmouse->type == proto->type)
1132 			return count; /* switched by other thread */
1133 	}
1134 
1135 	if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1136 		parent = serio_get_drvdata(serio->parent);
1137 		if (parent->pt_deactivate)
1138 			parent->pt_deactivate(parent);
1139 	}
1140 
1141 	if (psmouse->disconnect)
1142 		psmouse->disconnect(psmouse);
1143 
1144 	psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1145 	input_unregister_device(&psmouse->dev);
1146 
1147 	psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1148 
1149 	if (psmouse_switch_protocol(psmouse, proto) < 0) {
1150 		psmouse_reset(psmouse);
1151 		/* default to PSMOUSE_PS2 */
1152 		psmouse_switch_protocol(psmouse, &psmouse_protocols[0]);
1153 	}
1154 
1155 	psmouse_initialize(psmouse);
1156 	psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1157 
1158 	input_register_device(&psmouse->dev);
1159 	printk(KERN_INFO "input: %s on %s\n", psmouse->devname, serio->phys);
1160 
1161 	if (parent && parent->pt_activate)
1162 		parent->pt_activate(parent);
1163 
1164 	return count;
1165 }
1166 
1167 static ssize_t psmouse_attr_show_rate(struct psmouse *psmouse, char *buf)
1168 {
1169 	return sprintf(buf, "%d\n", psmouse->rate);
1170 }
1171 
1172 static ssize_t psmouse_attr_set_rate(struct psmouse *psmouse, const char *buf, size_t count)
1173 {
1174 	unsigned long value;
1175 	char *rest;
1176 
1177 	value = simple_strtoul(buf, &rest, 10);
1178 	if (*rest)
1179 		return -EINVAL;
1180 
1181 	psmouse->set_rate(psmouse, value);
1182 	return count;
1183 }
1184 
1185 static ssize_t psmouse_attr_show_resolution(struct psmouse *psmouse, char *buf)
1186 {
1187 	return sprintf(buf, "%d\n", psmouse->resolution);
1188 }
1189 
1190 static ssize_t psmouse_attr_set_resolution(struct psmouse *psmouse, const char *buf, size_t count)
1191 {
1192 	unsigned long value;
1193 	char *rest;
1194 
1195 	value = simple_strtoul(buf, &rest, 10);
1196 	if (*rest)
1197 		return -EINVAL;
1198 
1199 	psmouse->set_resolution(psmouse, value);
1200 	return count;
1201 }
1202 
1203 static ssize_t psmouse_attr_show_resetafter(struct psmouse *psmouse, char *buf)
1204 {
1205 	return sprintf(buf, "%d\n", psmouse->resetafter);
1206 }
1207 
1208 static ssize_t psmouse_attr_set_resetafter(struct psmouse *psmouse, const char *buf, size_t count)
1209 {
1210 	unsigned long value;
1211 	char *rest;
1212 
1213 	value = simple_strtoul(buf, &rest, 10);
1214 	if (*rest)
1215 		return -EINVAL;
1216 
1217 	psmouse->resetafter = value;
1218 	return count;
1219 }
1220 
1221 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp)
1222 {
1223 	struct psmouse_protocol *proto;
1224 
1225 	if (!val)
1226 		return -EINVAL;
1227 
1228 	proto = psmouse_protocol_by_name(val, strlen(val));
1229 
1230 	if (!proto || !proto->maxproto)
1231 		return -EINVAL;
1232 
1233 	*((unsigned int *)kp->arg) = proto->type;
1234 
1235 	return 0;					\
1236 }
1237 
1238 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp)
1239 {
1240 	int type = *((unsigned int *)kp->arg);
1241 
1242 	return sprintf(buffer, "%s\n", psmouse_protocol_by_type(type)->name);
1243 }
1244 
1245 static int __init psmouse_init(void)
1246 {
1247 	serio_register_driver(&psmouse_drv);
1248 	return 0;
1249 }
1250 
1251 static void __exit psmouse_exit(void)
1252 {
1253 	serio_unregister_driver(&psmouse_drv);
1254 }
1255 
1256 module_init(psmouse_init);
1257 module_exit(psmouse_exit);
1258