Input: psmouse - attempt to re-synchronize mouse every 5 seconds
[linux-2.6/zen-sources.git] / drivers / input / mouse / psmouse-base.c
blob7665fd9ce559c49a153289bd64e19d6255134c11
1 /*
2 * PS/2 mouse driver
4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 * Copyright (c) 2003-2004 Dmitry Torokhov
6 */
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.
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 #include "trackpoint.h"
30 #define DRIVER_DESC "PS/2 mouse driver"
32 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
33 MODULE_DESCRIPTION(DRIVER_DESC);
34 MODULE_LICENSE("GPL");
36 static unsigned int psmouse_max_proto = PSMOUSE_AUTO;
37 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp);
38 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp);
39 #define param_check_proto_abbrev(name, p) __param_check(name, p, unsigned int)
40 #define param_set_proto_abbrev psmouse_set_maxproto
41 #define param_get_proto_abbrev psmouse_get_maxproto
42 module_param_named(proto, psmouse_max_proto, proto_abbrev, 0644);
43 MODULE_PARM_DESC(proto, "Highest protocol extension to probe (bare, imps, exps, any). Useful for KVM switches.");
45 static unsigned int psmouse_resolution = 200;
46 module_param_named(resolution, psmouse_resolution, uint, 0644);
47 MODULE_PARM_DESC(resolution, "Resolution, in dpi.");
49 static unsigned int psmouse_rate = 100;
50 module_param_named(rate, psmouse_rate, uint, 0644);
51 MODULE_PARM_DESC(rate, "Report rate, in reports per second.");
53 static unsigned int psmouse_smartscroll = 1;
54 module_param_named(smartscroll, psmouse_smartscroll, bool, 0644);
55 MODULE_PARM_DESC(smartscroll, "Logitech Smartscroll autorepeat, 1 = enabled (default), 0 = disabled.");
57 static unsigned int psmouse_resetafter = 5;
58 module_param_named(resetafter, psmouse_resetafter, uint, 0644);
59 MODULE_PARM_DESC(resetafter, "Reset device after so many bad packets (0 = never).");
61 static unsigned int psmouse_resync_time = 5;
62 module_param_named(resync_time, psmouse_resync_time, uint, 0644);
63 MODULE_PARM_DESC(resync_time, "How long can mouse stay idle before forcing resync (in seconds, 0 = never).");
65 PSMOUSE_DEFINE_ATTR(protocol, S_IWUSR | S_IRUGO,
66 NULL,
67 psmouse_attr_show_protocol, psmouse_attr_set_protocol);
68 PSMOUSE_DEFINE_ATTR(rate, S_IWUSR | S_IRUGO,
69 (void *) offsetof(struct psmouse, rate),
70 psmouse_show_int_attr, psmouse_attr_set_rate);
71 PSMOUSE_DEFINE_ATTR(resolution, S_IWUSR | S_IRUGO,
72 (void *) offsetof(struct psmouse, resolution),
73 psmouse_show_int_attr, psmouse_attr_set_resolution);
74 PSMOUSE_DEFINE_ATTR(resetafter, S_IWUSR | S_IRUGO,
75 (void *) offsetof(struct psmouse, resetafter),
76 psmouse_show_int_attr, psmouse_set_int_attr);
77 PSMOUSE_DEFINE_ATTR(resync_time, S_IWUSR | S_IRUGO,
78 (void *) offsetof(struct psmouse, resync_time),
79 psmouse_show_int_attr, psmouse_set_int_attr);
81 static struct attribute *psmouse_attributes[] = {
82 &psmouse_attr_protocol.dattr.attr,
83 &psmouse_attr_rate.dattr.attr,
84 &psmouse_attr_resolution.dattr.attr,
85 &psmouse_attr_resetafter.dattr.attr,
86 &psmouse_attr_resync_time.dattr.attr,
87 NULL
90 static struct attribute_group psmouse_attribute_group = {
91 .attrs = psmouse_attributes,
94 __obsolete_setup("psmouse_noext");
95 __obsolete_setup("psmouse_resolution=");
96 __obsolete_setup("psmouse_smartscroll=");
97 __obsolete_setup("psmouse_resetafter=");
98 __obsolete_setup("psmouse_rate=");
101 * psmouse_sem protects all operations changing state of mouse
102 * (connecting, disconnecting, changing rate or resolution via
103 * sysfs). We could use a per-device semaphore but since there
104 * rarely more than one PS/2 mouse connected and since semaphore
105 * is taken in "slow" paths it is not worth it.
107 static DECLARE_MUTEX(psmouse_sem);
109 static struct workqueue_struct *kpsmoused_wq;
111 struct psmouse_protocol {
112 enum psmouse_type type;
113 char *name;
114 char *alias;
115 int maxproto;
116 int (*detect)(struct psmouse *, int);
117 int (*init)(struct psmouse *);
121 * psmouse_process_byte() analyzes the PS/2 data stream and reports
122 * relevant events to the input module once full packet has arrived.
125 static psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
127 struct input_dev *dev = psmouse->dev;
128 unsigned char *packet = psmouse->packet;
130 if (psmouse->pktcnt < psmouse->pktsize)
131 return PSMOUSE_GOOD_DATA;
134 * Full packet accumulated, process it
137 input_regs(dev, regs);
140 * Scroll wheel on IntelliMice, scroll buttons on NetMice
143 if (psmouse->type == PSMOUSE_IMPS || psmouse->type == PSMOUSE_GENPS)
144 input_report_rel(dev, REL_WHEEL, -(signed char) packet[3]);
147 * Scroll wheel and buttons on IntelliMouse Explorer
150 if (psmouse->type == PSMOUSE_IMEX) {
151 input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 8) - (int) (packet[3] & 7));
152 input_report_key(dev, BTN_SIDE, (packet[3] >> 4) & 1);
153 input_report_key(dev, BTN_EXTRA, (packet[3] >> 5) & 1);
157 * Extra buttons on Genius NewNet 3D
160 if (psmouse->type == PSMOUSE_GENPS) {
161 input_report_key(dev, BTN_SIDE, (packet[0] >> 6) & 1);
162 input_report_key(dev, BTN_EXTRA, (packet[0] >> 7) & 1);
166 * Extra button on ThinkingMouse
168 if (psmouse->type == PSMOUSE_THINKPS) {
169 input_report_key(dev, BTN_EXTRA, (packet[0] >> 3) & 1);
170 /* Without this bit of weirdness moving up gives wildly high Y changes. */
171 packet[1] |= (packet[0] & 0x40) << 1;
175 * Generic PS/2 Mouse
178 input_report_key(dev, BTN_LEFT, packet[0] & 1);
179 input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
180 input_report_key(dev, BTN_RIGHT, (packet[0] >> 1) & 1);
182 input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
183 input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
185 input_sync(dev);
187 return PSMOUSE_FULL_PACKET;
191 * __psmouse_set_state() sets new psmouse state and resets all flags.
194 static inline void __psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
196 psmouse->state = new_state;
197 psmouse->pktcnt = psmouse->out_of_sync = 0;
198 psmouse->ps2dev.flags = 0;
199 psmouse->last = jiffies;
204 * psmouse_set_state() sets new psmouse state and resets all flags and
205 * counters while holding serio lock so fighting with interrupt handler
206 * is not a concern.
209 static void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
211 serio_pause_rx(psmouse->ps2dev.serio);
212 __psmouse_set_state(psmouse, new_state);
213 serio_continue_rx(psmouse->ps2dev.serio);
217 * psmouse_handle_byte() processes one byte of the input data stream
218 * by calling corresponding protocol handler.
221 static int psmouse_handle_byte(struct psmouse *psmouse, struct pt_regs *regs)
223 psmouse_ret_t rc = psmouse->protocol_handler(psmouse, regs);
225 switch (rc) {
226 case PSMOUSE_BAD_DATA:
227 if (psmouse->state == PSMOUSE_ACTIVATED) {
228 printk(KERN_WARNING "psmouse.c: %s at %s lost sync at byte %d\n",
229 psmouse->name, psmouse->phys, psmouse->pktcnt);
230 if (++psmouse->out_of_sync == psmouse->resetafter) {
231 __psmouse_set_state(psmouse, PSMOUSE_IGNORE);
232 printk(KERN_NOTICE "psmouse.c: issuing reconnect request\n");
233 serio_reconnect(psmouse->ps2dev.serio);
234 return -1;
237 psmouse->pktcnt = 0;
238 break;
240 case PSMOUSE_FULL_PACKET:
241 psmouse->pktcnt = 0;
242 if (psmouse->out_of_sync) {
243 psmouse->out_of_sync = 0;
244 printk(KERN_NOTICE "psmouse.c: %s at %s - driver resynched.\n",
245 psmouse->name, psmouse->phys);
247 break;
249 case PSMOUSE_GOOD_DATA:
250 break;
252 return 0;
256 * psmouse_interrupt() handles incoming characters, either passing them
257 * for normal processing or gathering them as command response.
260 static irqreturn_t psmouse_interrupt(struct serio *serio,
261 unsigned char data, unsigned int flags, struct pt_regs *regs)
263 struct psmouse *psmouse = serio_get_drvdata(serio);
265 if (psmouse->state == PSMOUSE_IGNORE)
266 goto out;
268 if (flags & (SERIO_PARITY|SERIO_TIMEOUT)) {
269 if (psmouse->state == PSMOUSE_ACTIVATED)
270 printk(KERN_WARNING "psmouse.c: bad data from KBC -%s%s\n",
271 flags & SERIO_TIMEOUT ? " timeout" : "",
272 flags & SERIO_PARITY ? " bad parity" : "");
273 ps2_cmd_aborted(&psmouse->ps2dev);
274 goto out;
277 if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_ACK))
278 if (ps2_handle_ack(&psmouse->ps2dev, data))
279 goto out;
281 if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_CMD))
282 if (ps2_handle_response(&psmouse->ps2dev, data))
283 goto out;
285 if (psmouse->state <= PSMOUSE_RESYNCING)
286 goto out;
288 if (psmouse->state == PSMOUSE_ACTIVATED &&
289 psmouse->pktcnt && time_after(jiffies, psmouse->last + HZ/2)) {
290 printk(KERN_INFO "psmouse.c: %s at %s lost synchronization, throwing %d bytes away.\n",
291 psmouse->name, psmouse->phys, psmouse->pktcnt);
292 psmouse->badbyte = psmouse->packet[0];
293 __psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
294 queue_work(kpsmoused_wq, &psmouse->resync_work);
295 goto out;
298 psmouse->packet[psmouse->pktcnt++] = data;
300 * Check if this is a new device announcement (0xAA 0x00)
302 if (unlikely(psmouse->packet[0] == PSMOUSE_RET_BAT && psmouse->pktcnt <= 2)) {
303 if (psmouse->pktcnt == 1)
304 goto out;
306 if (psmouse->packet[1] == PSMOUSE_RET_ID) {
307 __psmouse_set_state(psmouse, PSMOUSE_IGNORE);
308 serio_reconnect(serio);
309 goto out;
312 * Not a new device, try processing first byte normally
314 psmouse->pktcnt = 1;
315 if (psmouse_handle_byte(psmouse, regs))
316 goto out;
318 psmouse->packet[psmouse->pktcnt++] = data;
322 * See if we need to force resync because mouse was idle for too long
324 if (psmouse->state == PSMOUSE_ACTIVATED &&
325 psmouse->pktcnt == 1 && psmouse->resync_time &&
326 time_after(jiffies, psmouse->last + psmouse->resync_time * HZ)) {
327 psmouse->badbyte = psmouse->packet[0];
328 __psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
329 queue_work(kpsmoused_wq, &psmouse->resync_work);
330 goto out;
333 psmouse->last = jiffies;
334 psmouse_handle_byte(psmouse, regs);
336 out:
337 return IRQ_HANDLED;
342 * psmouse_sliced_command() sends an extended PS/2 command to the mouse
343 * using sliced syntax, understood by advanced devices, such as Logitech
344 * or Synaptics touchpads. The command is encoded as:
345 * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
346 * is the command.
348 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command)
350 int i;
352 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11))
353 return -1;
355 for (i = 6; i >= 0; i -= 2) {
356 unsigned char d = (command >> i) & 3;
357 if (ps2_command(&psmouse->ps2dev, &d, PSMOUSE_CMD_SETRES))
358 return -1;
361 return 0;
366 * psmouse_reset() resets the mouse into power-on state.
368 int psmouse_reset(struct psmouse *psmouse)
370 unsigned char param[2];
372 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_RESET_BAT))
373 return -1;
375 if (param[0] != PSMOUSE_RET_BAT && param[1] != PSMOUSE_RET_ID)
376 return -1;
378 return 0;
383 * Genius NetMouse magic init.
385 static int genius_detect(struct psmouse *psmouse, int set_properties)
387 struct ps2dev *ps2dev = &psmouse->ps2dev;
388 unsigned char param[4];
390 param[0] = 3;
391 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
392 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
393 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
394 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
395 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
397 if (param[0] != 0x00 || param[1] != 0x33 || param[2] != 0x55)
398 return -1;
400 if (set_properties) {
401 set_bit(BTN_EXTRA, psmouse->dev->keybit);
402 set_bit(BTN_SIDE, psmouse->dev->keybit);
403 set_bit(REL_WHEEL, psmouse->dev->relbit);
405 psmouse->vendor = "Genius";
406 psmouse->pktsize = 4;
409 return 0;
413 * IntelliMouse magic init.
415 static int intellimouse_detect(struct psmouse *psmouse, int set_properties)
417 struct ps2dev *ps2dev = &psmouse->ps2dev;
418 unsigned char param[2];
420 param[0] = 200;
421 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
422 param[0] = 100;
423 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
424 param[0] = 80;
425 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
426 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
428 if (param[0] != 3)
429 return -1;
431 if (set_properties) {
432 set_bit(BTN_MIDDLE, psmouse->dev->keybit);
433 set_bit(REL_WHEEL, psmouse->dev->relbit);
435 if (!psmouse->vendor) psmouse->vendor = "Generic";
436 if (!psmouse->name) psmouse->name = "Wheel Mouse";
437 psmouse->pktsize = 4;
440 return 0;
444 * Try IntelliMouse/Explorer magic init.
446 static int im_explorer_detect(struct psmouse *psmouse, int set_properties)
448 struct ps2dev *ps2dev = &psmouse->ps2dev;
449 unsigned char param[2];
451 intellimouse_detect(psmouse, 0);
453 param[0] = 200;
454 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
455 param[0] = 200;
456 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
457 param[0] = 80;
458 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
459 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
461 if (param[0] != 4)
462 return -1;
464 if (set_properties) {
465 set_bit(BTN_MIDDLE, psmouse->dev->keybit);
466 set_bit(REL_WHEEL, psmouse->dev->relbit);
467 set_bit(BTN_SIDE, psmouse->dev->keybit);
468 set_bit(BTN_EXTRA, psmouse->dev->keybit);
470 if (!psmouse->vendor) psmouse->vendor = "Generic";
471 if (!psmouse->name) psmouse->name = "Explorer Mouse";
472 psmouse->pktsize = 4;
475 return 0;
479 * Kensington ThinkingMouse / ExpertMouse magic init.
481 static int thinking_detect(struct psmouse *psmouse, int set_properties)
483 struct ps2dev *ps2dev = &psmouse->ps2dev;
484 unsigned char param[2];
485 unsigned char seq[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20, 0 };
486 int i;
488 param[0] = 10;
489 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
490 param[0] = 0;
491 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
492 for (i = 0; seq[i]; i++)
493 ps2_command(ps2dev, seq + i, PSMOUSE_CMD_SETRATE);
494 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
496 if (param[0] != 2)
497 return -1;
499 if (set_properties) {
500 set_bit(BTN_EXTRA, psmouse->dev->keybit);
502 psmouse->vendor = "Kensington";
503 psmouse->name = "ThinkingMouse";
506 return 0;
510 * Bare PS/2 protocol "detection". Always succeeds.
512 static int ps2bare_detect(struct psmouse *psmouse, int set_properties)
514 if (set_properties) {
515 if (!psmouse->vendor) psmouse->vendor = "Generic";
516 if (!psmouse->name) psmouse->name = "Mouse";
519 return 0;
524 * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
525 * the mouse may have.
528 static int psmouse_extensions(struct psmouse *psmouse,
529 unsigned int max_proto, int set_properties)
531 int synaptics_hardware = 0;
534 * We always check for lifebook because it does not disturb mouse
535 * (it only checks DMI information).
537 if (lifebook_detect(psmouse, set_properties) == 0) {
538 if (max_proto > PSMOUSE_IMEX) {
539 if (!set_properties || lifebook_init(psmouse) == 0)
540 return PSMOUSE_LIFEBOOK;
545 * Try Kensington ThinkingMouse (we try first, because synaptics probe
546 * upsets the thinkingmouse).
549 if (max_proto > PSMOUSE_IMEX && thinking_detect(psmouse, set_properties) == 0)
550 return PSMOUSE_THINKPS;
553 * Try Synaptics TouchPad
555 if (max_proto > PSMOUSE_PS2 && synaptics_detect(psmouse, set_properties) == 0) {
556 synaptics_hardware = 1;
558 if (max_proto > PSMOUSE_IMEX) {
559 if (!set_properties || synaptics_init(psmouse) == 0)
560 return PSMOUSE_SYNAPTICS;
562 * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
563 * Unfortunately Logitech/Genius probes confuse some firmware versions so
564 * we'll have to skip them.
566 max_proto = PSMOUSE_IMEX;
569 * Make sure that touchpad is in relative mode, gestures (taps) are enabled
571 synaptics_reset(psmouse);
575 * Try ALPS TouchPad
577 if (max_proto > PSMOUSE_IMEX) {
578 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
579 if (alps_detect(psmouse, set_properties) == 0) {
580 if (!set_properties || alps_init(psmouse) == 0)
581 return PSMOUSE_ALPS;
583 * Init failed, try basic relative protocols
585 max_proto = PSMOUSE_IMEX;
589 if (max_proto > PSMOUSE_IMEX && genius_detect(psmouse, set_properties) == 0)
590 return PSMOUSE_GENPS;
592 if (max_proto > PSMOUSE_IMEX && ps2pp_init(psmouse, set_properties) == 0)
593 return PSMOUSE_PS2PP;
595 if (max_proto > PSMOUSE_IMEX && trackpoint_detect(psmouse, set_properties) == 0)
596 return PSMOUSE_TRACKPOINT;
599 * Reset to defaults in case the device got confused by extended
600 * protocol probes. Note that we do full reset becuase some mice
601 * put themselves to sleep when see PSMOUSE_RESET_DIS.
603 psmouse_reset(psmouse);
605 if (max_proto >= PSMOUSE_IMEX && im_explorer_detect(psmouse, set_properties) == 0)
606 return PSMOUSE_IMEX;
608 if (max_proto >= PSMOUSE_IMPS && intellimouse_detect(psmouse, set_properties) == 0)
609 return PSMOUSE_IMPS;
612 * Okay, all failed, we have a standard mouse here. The number of the buttons
613 * is still a question, though. We assume 3.
615 ps2bare_detect(psmouse, set_properties);
617 if (synaptics_hardware) {
619 * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
620 * We need to reset the touchpad because if there is a track point on the
621 * pass through port it could get disabled while probing for protocol
622 * extensions.
624 psmouse_reset(psmouse);
627 return PSMOUSE_PS2;
630 static struct psmouse_protocol psmouse_protocols[] = {
632 .type = PSMOUSE_PS2,
633 .name = "PS/2",
634 .alias = "bare",
635 .maxproto = 1,
636 .detect = ps2bare_detect,
639 .type = PSMOUSE_PS2PP,
640 .name = "PS2++",
641 .alias = "logitech",
642 .detect = ps2pp_init,
645 .type = PSMOUSE_THINKPS,
646 .name = "ThinkPS/2",
647 .alias = "thinkps",
648 .detect = thinking_detect,
651 .type = PSMOUSE_GENPS,
652 .name = "GenPS/2",
653 .alias = "genius",
654 .detect = genius_detect,
657 .type = PSMOUSE_IMPS,
658 .name = "ImPS/2",
659 .alias = "imps",
660 .maxproto = 1,
661 .detect = intellimouse_detect,
664 .type = PSMOUSE_IMEX,
665 .name = "ImExPS/2",
666 .alias = "exps",
667 .maxproto = 1,
668 .detect = im_explorer_detect,
671 .type = PSMOUSE_SYNAPTICS,
672 .name = "SynPS/2",
673 .alias = "synaptics",
674 .detect = synaptics_detect,
675 .init = synaptics_init,
678 .type = PSMOUSE_ALPS,
679 .name = "AlpsPS/2",
680 .alias = "alps",
681 .detect = alps_detect,
682 .init = alps_init,
685 .type = PSMOUSE_LIFEBOOK,
686 .name = "LBPS/2",
687 .alias = "lifebook",
688 .init = lifebook_init,
691 .type = PSMOUSE_TRACKPOINT,
692 .name = "TPPS/2",
693 .alias = "trackpoint",
694 .detect = trackpoint_detect,
697 .type = PSMOUSE_AUTO,
698 .name = "auto",
699 .alias = "any",
700 .maxproto = 1,
704 static struct psmouse_protocol *psmouse_protocol_by_type(enum psmouse_type type)
706 int i;
708 for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++)
709 if (psmouse_protocols[i].type == type)
710 return &psmouse_protocols[i];
712 WARN_ON(1);
713 return &psmouse_protocols[0];
716 static struct psmouse_protocol *psmouse_protocol_by_name(const char *name, size_t len)
718 struct psmouse_protocol *p;
719 int i;
721 for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++) {
722 p = &psmouse_protocols[i];
724 if ((strlen(p->name) == len && !strncmp(p->name, name, len)) ||
725 (strlen(p->alias) == len && !strncmp(p->alias, name, len)))
726 return &psmouse_protocols[i];
729 return NULL;
734 * psmouse_probe() probes for a PS/2 mouse.
737 static int psmouse_probe(struct psmouse *psmouse)
739 struct ps2dev *ps2dev = &psmouse->ps2dev;
740 unsigned char param[2];
743 * First, we check if it's a mouse. It should send 0x00 or 0x03
744 * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
745 * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
746 * ID queries, probably due to a firmware bug.
749 param[0] = 0xa5;
750 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
751 return -1;
753 if (param[0] != 0x00 && param[0] != 0x03 &&
754 param[0] != 0x04 && param[0] != 0xff)
755 return -1;
758 * Then we reset and disable the mouse so that it doesn't generate events.
761 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS))
762 printk(KERN_WARNING "psmouse.c: Failed to reset mouse on %s\n", ps2dev->serio->phys);
764 return 0;
768 * Here we set the mouse resolution.
771 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution)
773 unsigned char params[] = { 0, 1, 2, 2, 3 };
775 if (resolution == 0 || resolution > 200)
776 resolution = 200;
778 ps2_command(&psmouse->ps2dev, &params[resolution / 50], PSMOUSE_CMD_SETRES);
779 psmouse->resolution = 25 << params[resolution / 50];
783 * Here we set the mouse report rate.
786 static void psmouse_set_rate(struct psmouse *psmouse, unsigned int rate)
788 unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
789 int i = 0;
791 while (rates[i] > rate) i++;
792 ps2_command(&psmouse->ps2dev, &rates[i], PSMOUSE_CMD_SETRATE);
793 psmouse->rate = rates[i];
797 * psmouse_initialize() initializes the mouse to a sane state.
800 static void psmouse_initialize(struct psmouse *psmouse)
803 * We set the mouse into streaming mode.
806 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM);
809 * We set the mouse report rate, resolution and scaling.
812 if (psmouse_max_proto != PSMOUSE_PS2) {
813 psmouse->set_rate(psmouse, psmouse->rate);
814 psmouse->set_resolution(psmouse, psmouse->resolution);
815 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
820 * psmouse_activate() enables the mouse so that we get motion reports from it.
823 static void psmouse_activate(struct psmouse *psmouse)
825 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE))
826 printk(KERN_WARNING "psmouse.c: Failed to enable mouse on %s\n",
827 psmouse->ps2dev.serio->phys);
829 psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
834 * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
835 * reports from it unless we explicitely request it.
838 static void psmouse_deactivate(struct psmouse *psmouse)
840 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_DISABLE))
841 printk(KERN_WARNING "psmouse.c: Failed to deactivate mouse on %s\n",
842 psmouse->ps2dev.serio->phys);
844 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
848 * psmouse_poll() - default poll hanlder. Everyone except for ALPS uses it.
851 static int psmouse_poll(struct psmouse *psmouse)
853 return ps2_command(&psmouse->ps2dev, psmouse->packet,
854 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8));
859 * psmouse_resync() attempts to re-validate current protocol.
862 static void psmouse_resync(void *p)
864 struct psmouse *psmouse = p, *parent = NULL;
865 struct serio *serio = psmouse->ps2dev.serio;
866 psmouse_ret_t rc = PSMOUSE_GOOD_DATA;
867 int failed = 0, enabled = 0;
868 int i;
870 down(&psmouse_sem);
872 if (psmouse->state != PSMOUSE_RESYNCING)
873 goto out;
875 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
876 parent = serio_get_drvdata(serio->parent);
877 psmouse_deactivate(parent);
881 * Some mice don't ACK commands sent while they are in the middle of
882 * transmitting motion packet. To avoid delay we use ps2_sendbyte()
883 * instead of ps2_command() which would wait for 200ms for an ACK
884 * that may never come.
885 * As an additional quirk ALPS touchpads may not only forget to ACK
886 * disable command but will stop reporting taps, so if we see that
887 * mouse at least once ACKs disable we will do full reconnect if ACK
888 * is missing.
890 psmouse->num_resyncs++;
892 if (ps2_sendbyte(&psmouse->ps2dev, PSMOUSE_CMD_DISABLE, 20)) {
893 if (psmouse->num_resyncs < 3 || psmouse->acks_disable_command)
894 failed = 1;
895 } else
896 psmouse->acks_disable_command = 1;
899 * Poll the mouse. If it was reset the packet will be shorter than
900 * psmouse->pktsize and ps2_command will fail. We do not expect and
901 * do not handle scenario when mouse "upgrades" its protocol while
902 * disconnected since it would require additional delay. If we ever
903 * see a mouse that does it we'll adjust the code.
905 if (!failed) {
906 if (psmouse->poll(psmouse))
907 failed = 1;
908 else {
909 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
910 for (i = 0; i < psmouse->pktsize; i++) {
911 psmouse->pktcnt++;
912 rc = psmouse->protocol_handler(psmouse, NULL);
913 if (rc != PSMOUSE_GOOD_DATA)
914 break;
916 if (rc != PSMOUSE_FULL_PACKET)
917 failed = 1;
918 psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
922 * Now try to enable mouse. We try to do that even if poll failed and also
923 * repeat our attempts 5 times, otherwise we may be left out with disabled
924 * mouse.
926 for (i = 0; i < 5; i++) {
927 if (!ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
928 enabled = 1;
929 break;
931 msleep(200);
934 if (!enabled) {
935 printk(KERN_WARNING "psmouse.c: failed to re-enable mouse on %s\n",
936 psmouse->ps2dev.serio->phys);
937 failed = 1;
940 if (failed) {
941 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
942 printk(KERN_INFO "psmouse.c: resync failed, issuing reconnect request\n");
943 serio_reconnect(serio);
944 } else
945 psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
947 if (parent)
948 psmouse_activate(parent);
949 out:
950 up(&psmouse_sem);
954 * psmouse_cleanup() resets the mouse into power-on state.
957 static void psmouse_cleanup(struct serio *serio)
959 struct psmouse *psmouse = serio_get_drvdata(serio);
961 psmouse_reset(psmouse);
965 * psmouse_disconnect() closes and frees.
968 static void psmouse_disconnect(struct serio *serio)
970 struct psmouse *psmouse, *parent = NULL;
972 psmouse = serio_get_drvdata(serio);
974 sysfs_remove_group(&serio->dev.kobj, &psmouse_attribute_group);
976 down(&psmouse_sem);
978 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
980 /* make sure we don't have a resync in progress */
981 up(&psmouse_sem);
982 flush_workqueue(kpsmoused_wq);
983 down(&psmouse_sem);
985 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
986 parent = serio_get_drvdata(serio->parent);
987 psmouse_deactivate(parent);
990 if (psmouse->disconnect)
991 psmouse->disconnect(psmouse);
993 if (parent && parent->pt_deactivate)
994 parent->pt_deactivate(parent);
996 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
998 serio_close(serio);
999 serio_set_drvdata(serio, NULL);
1000 input_unregister_device(psmouse->dev);
1001 kfree(psmouse);
1003 if (parent)
1004 psmouse_activate(parent);
1006 up(&psmouse_sem);
1009 static int psmouse_switch_protocol(struct psmouse *psmouse, struct psmouse_protocol *proto)
1011 struct input_dev *input_dev = psmouse->dev;
1013 input_dev->private = psmouse;
1014 input_dev->cdev.dev = &psmouse->ps2dev.serio->dev;
1016 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
1017 input_dev->keybit[LONG(BTN_MOUSE)] = BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
1018 input_dev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
1020 psmouse->set_rate = psmouse_set_rate;
1021 psmouse->set_resolution = psmouse_set_resolution;
1022 psmouse->poll = psmouse_poll;
1023 psmouse->protocol_handler = psmouse_process_byte;
1024 psmouse->pktsize = 3;
1026 if (proto && (proto->detect || proto->init)) {
1027 if (proto->detect && proto->detect(psmouse, 1) < 0)
1028 return -1;
1030 if (proto->init && proto->init(psmouse) < 0)
1031 return -1;
1033 psmouse->type = proto->type;
1035 else
1036 psmouse->type = psmouse_extensions(psmouse, psmouse_max_proto, 1);
1039 * If mouse's packet size is 3 there is no point in polling the
1040 * device in hopes to detect protocol reset - we won't get less
1041 * than 3 bytes response anyhow.
1043 if (psmouse->pktsize == 3)
1044 psmouse->resync_time = 0;
1047 * Some smart KVMs fake response to POLL command returning just
1048 * 3 bytes and messing up our resync logic, so if initial poll
1049 * fails we won't try polling the device anymore. Hopefully
1050 * such KVM will maintain initially selected protocol.
1052 if (psmouse->resync_time && psmouse->poll(psmouse))
1053 psmouse->resync_time = 0;
1055 sprintf(psmouse->devname, "%s %s %s",
1056 psmouse_protocol_by_type(psmouse->type)->name, psmouse->vendor, psmouse->name);
1058 input_dev->name = psmouse->devname;
1059 input_dev->phys = psmouse->phys;
1060 input_dev->id.bustype = BUS_I8042;
1061 input_dev->id.vendor = 0x0002;
1062 input_dev->id.product = psmouse->type;
1063 input_dev->id.version = psmouse->model;
1065 return 0;
1069 * psmouse_connect() is a callback from the serio module when
1070 * an unhandled serio port is found.
1072 static int psmouse_connect(struct serio *serio, struct serio_driver *drv)
1074 struct psmouse *psmouse, *parent = NULL;
1075 struct input_dev *input_dev;
1076 int retval = -ENOMEM;
1078 down(&psmouse_sem);
1081 * If this is a pass-through port deactivate parent so the device
1082 * connected to this port can be successfully identified
1084 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1085 parent = serio_get_drvdata(serio->parent);
1086 psmouse_deactivate(parent);
1089 psmouse = kzalloc(sizeof(struct psmouse), GFP_KERNEL);
1090 input_dev = input_allocate_device();
1091 if (!psmouse || !input_dev)
1092 goto out;
1094 ps2_init(&psmouse->ps2dev, serio);
1095 INIT_WORK(&psmouse->resync_work, psmouse_resync, psmouse);
1096 psmouse->dev = input_dev;
1097 sprintf(psmouse->phys, "%s/input0", serio->phys);
1099 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1101 serio_set_drvdata(serio, psmouse);
1103 retval = serio_open(serio, drv);
1104 if (retval)
1105 goto out;
1107 if (psmouse_probe(psmouse) < 0) {
1108 serio_close(serio);
1109 retval = -ENODEV;
1110 goto out;
1113 psmouse->rate = psmouse_rate;
1114 psmouse->resolution = psmouse_resolution;
1115 psmouse->resetafter = psmouse_resetafter;
1116 psmouse->resync_time = parent ? 0 : psmouse_resync_time;
1117 psmouse->smartscroll = psmouse_smartscroll;
1119 psmouse_switch_protocol(psmouse, NULL);
1121 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1122 psmouse_initialize(psmouse);
1124 input_register_device(psmouse->dev);
1126 if (parent && parent->pt_activate)
1127 parent->pt_activate(parent);
1129 sysfs_create_group(&serio->dev.kobj, &psmouse_attribute_group);
1131 psmouse_activate(psmouse);
1133 retval = 0;
1135 out:
1136 if (retval) {
1137 serio_set_drvdata(serio, NULL);
1138 input_free_device(input_dev);
1139 kfree(psmouse);
1142 /* If this is a pass-through port the parent needs to be re-activated */
1143 if (parent)
1144 psmouse_activate(parent);
1146 up(&psmouse_sem);
1147 return retval;
1151 static int psmouse_reconnect(struct serio *serio)
1153 struct psmouse *psmouse = serio_get_drvdata(serio);
1154 struct psmouse *parent = NULL;
1155 struct serio_driver *drv = serio->drv;
1156 int rc = -1;
1158 if (!drv || !psmouse) {
1159 printk(KERN_DEBUG "psmouse: reconnect request, but serio is disconnected, ignoring...\n");
1160 return -1;
1163 down(&psmouse_sem);
1165 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1166 parent = serio_get_drvdata(serio->parent);
1167 psmouse_deactivate(parent);
1170 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1172 if (psmouse->reconnect) {
1173 if (psmouse->reconnect(psmouse))
1174 goto out;
1175 } else if (psmouse_probe(psmouse) < 0 ||
1176 psmouse->type != psmouse_extensions(psmouse, psmouse_max_proto, 0))
1177 goto out;
1179 /* ok, the device type (and capabilities) match the old one,
1180 * we can continue using it, complete intialization
1182 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1184 psmouse_initialize(psmouse);
1186 if (parent && parent->pt_activate)
1187 parent->pt_activate(parent);
1189 psmouse_activate(psmouse);
1190 rc = 0;
1192 out:
1193 /* If this is a pass-through port the parent waits to be activated */
1194 if (parent)
1195 psmouse_activate(parent);
1197 up(&psmouse_sem);
1198 return rc;
1201 static struct serio_device_id psmouse_serio_ids[] = {
1203 .type = SERIO_8042,
1204 .proto = SERIO_ANY,
1205 .id = SERIO_ANY,
1206 .extra = SERIO_ANY,
1209 .type = SERIO_PS_PSTHRU,
1210 .proto = SERIO_ANY,
1211 .id = SERIO_ANY,
1212 .extra = SERIO_ANY,
1214 { 0 }
1217 MODULE_DEVICE_TABLE(serio, psmouse_serio_ids);
1219 static struct serio_driver psmouse_drv = {
1220 .driver = {
1221 .name = "psmouse",
1223 .description = DRIVER_DESC,
1224 .id_table = psmouse_serio_ids,
1225 .interrupt = psmouse_interrupt,
1226 .connect = psmouse_connect,
1227 .reconnect = psmouse_reconnect,
1228 .disconnect = psmouse_disconnect,
1229 .cleanup = psmouse_cleanup,
1232 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *devattr,
1233 char *buf)
1235 struct serio *serio = to_serio_port(dev);
1236 struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1237 struct psmouse *psmouse;
1238 int retval;
1240 retval = serio_pin_driver(serio);
1241 if (retval)
1242 return retval;
1244 if (serio->drv != &psmouse_drv) {
1245 retval = -ENODEV;
1246 goto out;
1249 psmouse = serio_get_drvdata(serio);
1251 retval = attr->show(psmouse, attr->data, buf);
1253 out:
1254 serio_unpin_driver(serio);
1255 return retval;
1258 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *devattr,
1259 const char *buf, size_t count)
1261 struct serio *serio = to_serio_port(dev);
1262 struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1263 struct psmouse *psmouse, *parent = NULL;
1264 int retval;
1266 retval = serio_pin_driver(serio);
1267 if (retval)
1268 return retval;
1270 if (serio->drv != &psmouse_drv) {
1271 retval = -ENODEV;
1272 goto out_unpin;
1275 retval = down_interruptible(&psmouse_sem);
1276 if (retval)
1277 goto out_unpin;
1279 psmouse = serio_get_drvdata(serio);
1281 if (psmouse->state == PSMOUSE_IGNORE) {
1282 retval = -ENODEV;
1283 goto out_up;
1286 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1287 parent = serio_get_drvdata(serio->parent);
1288 psmouse_deactivate(parent);
1291 psmouse_deactivate(psmouse);
1293 retval = attr->set(psmouse, attr->data, buf, count);
1295 if (retval != -ENODEV)
1296 psmouse_activate(psmouse);
1298 if (parent)
1299 psmouse_activate(parent);
1301 out_up:
1302 up(&psmouse_sem);
1303 out_unpin:
1304 serio_unpin_driver(serio);
1305 return retval;
1308 static ssize_t psmouse_show_int_attr(struct psmouse *psmouse, void *offset, char *buf)
1310 unsigned long *field = (unsigned long *)((char *)psmouse + (size_t)offset);
1312 return sprintf(buf, "%lu\n", *field);
1315 static ssize_t psmouse_set_int_attr(struct psmouse *psmouse, void *offset, const char *buf, size_t count)
1317 unsigned long *field = (unsigned long *)((char *)psmouse + (size_t)offset);
1318 unsigned long value;
1319 char *rest;
1321 value = simple_strtoul(buf, &rest, 10);
1322 if (*rest)
1323 return -EINVAL;
1325 *field = value;
1327 return count;
1330 static ssize_t psmouse_attr_show_protocol(struct psmouse *psmouse, void *data, char *buf)
1332 return sprintf(buf, "%s\n", psmouse_protocol_by_type(psmouse->type)->name);
1335 static ssize_t psmouse_attr_set_protocol(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1337 struct serio *serio = psmouse->ps2dev.serio;
1338 struct psmouse *parent = NULL;
1339 struct input_dev *new_dev;
1340 struct psmouse_protocol *proto;
1341 int retry = 0;
1343 if (!(proto = psmouse_protocol_by_name(buf, count)))
1344 return -EINVAL;
1346 if (psmouse->type == proto->type)
1347 return count;
1349 if (!(new_dev = input_allocate_device()))
1350 return -ENOMEM;
1352 while (serio->child) {
1353 if (++retry > 3) {
1354 printk(KERN_WARNING "psmouse: failed to destroy child port, protocol change aborted.\n");
1355 input_free_device(new_dev);
1356 return -EIO;
1359 up(&psmouse_sem);
1360 serio_unpin_driver(serio);
1361 serio_unregister_child_port(serio);
1362 serio_pin_driver_uninterruptible(serio);
1363 down(&psmouse_sem);
1365 if (serio->drv != &psmouse_drv) {
1366 input_free_device(new_dev);
1367 return -ENODEV;
1370 if (psmouse->type == proto->type) {
1371 input_free_device(new_dev);
1372 return count; /* switched by other thread */
1376 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1377 parent = serio_get_drvdata(serio->parent);
1378 if (parent->pt_deactivate)
1379 parent->pt_deactivate(parent);
1382 if (psmouse->disconnect)
1383 psmouse->disconnect(psmouse);
1385 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1386 input_unregister_device(psmouse->dev);
1388 psmouse->dev = new_dev;
1389 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1391 if (psmouse_switch_protocol(psmouse, proto) < 0) {
1392 psmouse_reset(psmouse);
1393 /* default to PSMOUSE_PS2 */
1394 psmouse_switch_protocol(psmouse, &psmouse_protocols[0]);
1397 psmouse_initialize(psmouse);
1398 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1400 input_register_device(psmouse->dev);
1402 if (parent && parent->pt_activate)
1403 parent->pt_activate(parent);
1405 return count;
1408 static ssize_t psmouse_attr_set_rate(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1410 unsigned long value;
1411 char *rest;
1413 value = simple_strtoul(buf, &rest, 10);
1414 if (*rest)
1415 return -EINVAL;
1417 psmouse->set_rate(psmouse, value);
1418 return count;
1421 static ssize_t psmouse_attr_set_resolution(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1423 unsigned long value;
1424 char *rest;
1426 value = simple_strtoul(buf, &rest, 10);
1427 if (*rest)
1428 return -EINVAL;
1430 psmouse->set_resolution(psmouse, value);
1431 return count;
1435 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp)
1437 struct psmouse_protocol *proto;
1439 if (!val)
1440 return -EINVAL;
1442 proto = psmouse_protocol_by_name(val, strlen(val));
1444 if (!proto || !proto->maxproto)
1445 return -EINVAL;
1447 *((unsigned int *)kp->arg) = proto->type;
1449 return 0;
1452 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp)
1454 int type = *((unsigned int *)kp->arg);
1456 return sprintf(buffer, "%s\n", psmouse_protocol_by_type(type)->name);
1459 static int __init psmouse_init(void)
1461 kpsmoused_wq = create_singlethread_workqueue("kpsmoused");
1462 if (!kpsmoused_wq) {
1463 printk(KERN_ERR "psmouse: failed to create kpsmoused workqueue\n");
1464 return -ENOMEM;
1467 serio_register_driver(&psmouse_drv);
1469 return 0;
1472 static void __exit psmouse_exit(void)
1474 serio_unregister_driver(&psmouse_drv);
1475 destroy_workqueue(kpsmoused_wq);
1478 module_init(psmouse_init);
1479 module_exit(psmouse_exit);