4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 * Copyright (c) 2003-2004 Dmitry Torokhov
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 <linux/mutex.h>
26 #include "synaptics.h"
27 #include "logips2pp.h"
30 #include "trackpoint.h"
32 #define DRIVER_DESC "PS/2 mouse driver"
34 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
35 MODULE_DESCRIPTION(DRIVER_DESC);
36 MODULE_LICENSE("GPL");
38 static unsigned int psmouse_max_proto = PSMOUSE_AUTO;
39 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp);
40 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp);
41 #define param_check_proto_abbrev(name, p) __param_check(name, p, unsigned int)
42 #define param_set_proto_abbrev psmouse_set_maxproto
43 #define param_get_proto_abbrev psmouse_get_maxproto
44 module_param_named(proto, psmouse_max_proto, proto_abbrev, 0644);
45 MODULE_PARM_DESC(proto, "Highest protocol extension to probe (bare, imps, exps, any). Useful for KVM switches.");
47 static unsigned int psmouse_resolution = 200;
48 module_param_named(resolution, psmouse_resolution, uint, 0644);
49 MODULE_PARM_DESC(resolution, "Resolution, in dpi.");
51 static unsigned int psmouse_rate = 100;
52 module_param_named(rate, psmouse_rate, uint, 0644);
53 MODULE_PARM_DESC(rate, "Report rate, in reports per second.");
55 static unsigned int psmouse_smartscroll = 1;
56 module_param_named(smartscroll, psmouse_smartscroll, bool, 0644);
57 MODULE_PARM_DESC(smartscroll, "Logitech Smartscroll autorepeat, 1 = enabled (default), 0 = disabled.");
59 static unsigned int psmouse_resetafter = 5;
60 module_param_named(resetafter, psmouse_resetafter, uint, 0644);
61 MODULE_PARM_DESC(resetafter, "Reset device after so many bad packets (0 = never).");
63 static unsigned int psmouse_resync_time;
64 module_param_named(resync_time, psmouse_resync_time, uint, 0644);
65 MODULE_PARM_DESC(resync_time, "How long can mouse stay idle before forcing resync (in seconds, 0 = never).");
67 PSMOUSE_DEFINE_ATTR(protocol, S_IWUSR | S_IRUGO,
69 psmouse_attr_show_protocol, psmouse_attr_set_protocol);
70 PSMOUSE_DEFINE_ATTR(rate, S_IWUSR | S_IRUGO,
71 (void *) offsetof(struct psmouse, rate),
72 psmouse_show_int_attr, psmouse_attr_set_rate);
73 PSMOUSE_DEFINE_ATTR(resolution, S_IWUSR | S_IRUGO,
74 (void *) offsetof(struct psmouse, resolution),
75 psmouse_show_int_attr, psmouse_attr_set_resolution);
76 PSMOUSE_DEFINE_ATTR(resetafter, S_IWUSR | S_IRUGO,
77 (void *) offsetof(struct psmouse, resetafter),
78 psmouse_show_int_attr, psmouse_set_int_attr);
79 PSMOUSE_DEFINE_ATTR(resync_time, S_IWUSR | S_IRUGO,
80 (void *) offsetof(struct psmouse, resync_time),
81 psmouse_show_int_attr, psmouse_set_int_attr);
83 static struct attribute *psmouse_attributes[] = {
84 &psmouse_attr_protocol.dattr.attr,
85 &psmouse_attr_rate.dattr.attr,
86 &psmouse_attr_resolution.dattr.attr,
87 &psmouse_attr_resetafter.dattr.attr,
88 &psmouse_attr_resync_time.dattr.attr,
92 static struct attribute_group psmouse_attribute_group = {
93 .attrs = psmouse_attributes,
96 __obsolete_setup("psmouse_noext");
97 __obsolete_setup("psmouse_resolution=");
98 __obsolete_setup("psmouse_smartscroll=");
99 __obsolete_setup("psmouse_resetafter=");
100 __obsolete_setup("psmouse_rate=");
103 * psmouse_mutex protects all operations changing state of mouse
104 * (connecting, disconnecting, changing rate or resolution via
105 * sysfs). We could use a per-device semaphore but since there
106 * rarely more than one PS/2 mouse connected and since semaphore
107 * is taken in "slow" paths it is not worth it.
109 static DEFINE_MUTEX(psmouse_mutex);
111 static struct workqueue_struct *kpsmoused_wq;
113 struct psmouse_protocol {
114 enum psmouse_type type;
118 int (*detect)(struct psmouse *, int);
119 int (*init)(struct psmouse *);
123 * psmouse_process_byte() analyzes the PS/2 data stream and reports
124 * relevant events to the input module once full packet has arrived.
127 static psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
129 struct input_dev *dev = psmouse->dev;
130 unsigned char *packet = psmouse->packet;
132 if (psmouse->pktcnt < psmouse->pktsize)
133 return PSMOUSE_GOOD_DATA;
136 * Full packet accumulated, process it
139 input_regs(dev, regs);
142 * Scroll wheel on IntelliMice, scroll buttons on NetMice
145 if (psmouse->type == PSMOUSE_IMPS || psmouse->type == PSMOUSE_GENPS)
146 input_report_rel(dev, REL_WHEEL, -(signed char) packet[3]);
149 * Scroll wheel and buttons on IntelliMouse Explorer
152 if (psmouse->type == PSMOUSE_IMEX) {
153 switch (packet[3] & 0xC0) {
154 case 0x80: /* vertical scroll on IntelliMouse Explorer 4.0 */
155 input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 32) - (int) (packet[3] & 31));
157 case 0x40: /* horizontal scroll on IntelliMouse Explorer 4.0 */
158 input_report_rel(dev, REL_HWHEEL, (int) (packet[3] & 32) - (int) (packet[3] & 31));
162 input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 8) - (int) (packet[3] & 7));
163 input_report_key(dev, BTN_SIDE, (packet[3] >> 4) & 1);
164 input_report_key(dev, BTN_EXTRA, (packet[3] >> 5) & 1);
170 * Extra buttons on Genius NewNet 3D
173 if (psmouse->type == PSMOUSE_GENPS) {
174 input_report_key(dev, BTN_SIDE, (packet[0] >> 6) & 1);
175 input_report_key(dev, BTN_EXTRA, (packet[0] >> 7) & 1);
179 * Extra button on ThinkingMouse
181 if (psmouse->type == PSMOUSE_THINKPS) {
182 input_report_key(dev, BTN_EXTRA, (packet[0] >> 3) & 1);
183 /* Without this bit of weirdness moving up gives wildly high Y changes. */
184 packet[1] |= (packet[0] & 0x40) << 1;
191 input_report_key(dev, BTN_LEFT, packet[0] & 1);
192 input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
193 input_report_key(dev, BTN_RIGHT, (packet[0] >> 1) & 1);
195 input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
196 input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
200 return PSMOUSE_FULL_PACKET;
204 * __psmouse_set_state() sets new psmouse state and resets all flags.
207 static inline void __psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
209 psmouse->state = new_state;
210 psmouse->pktcnt = psmouse->out_of_sync = 0;
211 psmouse->ps2dev.flags = 0;
212 psmouse->last = jiffies;
217 * psmouse_set_state() sets new psmouse state and resets all flags and
218 * counters while holding serio lock so fighting with interrupt handler
222 static void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
224 serio_pause_rx(psmouse->ps2dev.serio);
225 __psmouse_set_state(psmouse, new_state);
226 serio_continue_rx(psmouse->ps2dev.serio);
230 * psmouse_handle_byte() processes one byte of the input data stream
231 * by calling corresponding protocol handler.
234 static int psmouse_handle_byte(struct psmouse *psmouse, struct pt_regs *regs)
236 psmouse_ret_t rc = psmouse->protocol_handler(psmouse, regs);
239 case PSMOUSE_BAD_DATA:
240 if (psmouse->state == PSMOUSE_ACTIVATED) {
241 printk(KERN_WARNING "psmouse.c: %s at %s lost sync at byte %d\n",
242 psmouse->name, psmouse->phys, psmouse->pktcnt);
243 if (++psmouse->out_of_sync == psmouse->resetafter) {
244 __psmouse_set_state(psmouse, PSMOUSE_IGNORE);
245 printk(KERN_NOTICE "psmouse.c: issuing reconnect request\n");
246 serio_reconnect(psmouse->ps2dev.serio);
253 case PSMOUSE_FULL_PACKET:
255 if (psmouse->out_of_sync) {
256 psmouse->out_of_sync = 0;
257 printk(KERN_NOTICE "psmouse.c: %s at %s - driver resynched.\n",
258 psmouse->name, psmouse->phys);
262 case PSMOUSE_GOOD_DATA:
269 * psmouse_interrupt() handles incoming characters, either passing them
270 * for normal processing or gathering them as command response.
273 static irqreturn_t psmouse_interrupt(struct serio *serio,
274 unsigned char data, unsigned int flags, struct pt_regs *regs)
276 struct psmouse *psmouse = serio_get_drvdata(serio);
278 if (psmouse->state == PSMOUSE_IGNORE)
281 if (flags & (SERIO_PARITY|SERIO_TIMEOUT)) {
282 if (psmouse->state == PSMOUSE_ACTIVATED)
283 printk(KERN_WARNING "psmouse.c: bad data from KBC -%s%s\n",
284 flags & SERIO_TIMEOUT ? " timeout" : "",
285 flags & SERIO_PARITY ? " bad parity" : "");
286 ps2_cmd_aborted(&psmouse->ps2dev);
290 if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_ACK))
291 if (ps2_handle_ack(&psmouse->ps2dev, data))
294 if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_CMD))
295 if (ps2_handle_response(&psmouse->ps2dev, data))
298 if (psmouse->state <= PSMOUSE_RESYNCING)
301 if (psmouse->state == PSMOUSE_ACTIVATED &&
302 psmouse->pktcnt && time_after(jiffies, psmouse->last + HZ/2)) {
303 printk(KERN_INFO "psmouse.c: %s at %s lost synchronization, throwing %d bytes away.\n",
304 psmouse->name, psmouse->phys, psmouse->pktcnt);
305 psmouse->badbyte = psmouse->packet[0];
306 __psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
307 queue_work(kpsmoused_wq, &psmouse->resync_work);
311 psmouse->packet[psmouse->pktcnt++] = data;
313 * Check if this is a new device announcement (0xAA 0x00)
315 if (unlikely(psmouse->packet[0] == PSMOUSE_RET_BAT && psmouse->pktcnt <= 2)) {
316 if (psmouse->pktcnt == 1) {
317 psmouse->last = jiffies;
321 if (psmouse->packet[1] == PSMOUSE_RET_ID) {
322 __psmouse_set_state(psmouse, PSMOUSE_IGNORE);
323 serio_reconnect(serio);
327 * Not a new device, try processing first byte normally
330 if (psmouse_handle_byte(psmouse, regs))
333 psmouse->packet[psmouse->pktcnt++] = data;
337 * See if we need to force resync because mouse was idle for too long
339 if (psmouse->state == PSMOUSE_ACTIVATED &&
340 psmouse->pktcnt == 1 && psmouse->resync_time &&
341 time_after(jiffies, psmouse->last + psmouse->resync_time * HZ)) {
342 psmouse->badbyte = psmouse->packet[0];
343 __psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
344 queue_work(kpsmoused_wq, &psmouse->resync_work);
348 psmouse->last = jiffies;
349 psmouse_handle_byte(psmouse, regs);
357 * psmouse_sliced_command() sends an extended PS/2 command to the mouse
358 * using sliced syntax, understood by advanced devices, such as Logitech
359 * or Synaptics touchpads. The command is encoded as:
360 * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
363 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command)
367 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11))
370 for (i = 6; i >= 0; i -= 2) {
371 unsigned char d = (command >> i) & 3;
372 if (ps2_command(&psmouse->ps2dev, &d, PSMOUSE_CMD_SETRES))
381 * psmouse_reset() resets the mouse into power-on state.
383 int psmouse_reset(struct psmouse *psmouse)
385 unsigned char param[2];
387 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_RESET_BAT))
390 if (param[0] != PSMOUSE_RET_BAT && param[1] != PSMOUSE_RET_ID)
398 * Genius NetMouse magic init.
400 static int genius_detect(struct psmouse *psmouse, int set_properties)
402 struct ps2dev *ps2dev = &psmouse->ps2dev;
403 unsigned char param[4];
406 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
407 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
408 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
409 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
410 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
412 if (param[0] != 0x00 || param[1] != 0x33 || param[2] != 0x55)
415 if (set_properties) {
416 set_bit(BTN_EXTRA, psmouse->dev->keybit);
417 set_bit(BTN_SIDE, psmouse->dev->keybit);
418 set_bit(REL_WHEEL, psmouse->dev->relbit);
420 psmouse->vendor = "Genius";
421 psmouse->name = "Mouse";
422 psmouse->pktsize = 4;
429 * IntelliMouse magic init.
431 static int intellimouse_detect(struct psmouse *psmouse, int set_properties)
433 struct ps2dev *ps2dev = &psmouse->ps2dev;
434 unsigned char param[2];
437 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
439 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
441 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
442 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
447 if (set_properties) {
448 set_bit(BTN_MIDDLE, psmouse->dev->keybit);
449 set_bit(REL_WHEEL, psmouse->dev->relbit);
451 if (!psmouse->vendor) psmouse->vendor = "Generic";
452 if (!psmouse->name) psmouse->name = "Wheel Mouse";
453 psmouse->pktsize = 4;
460 * Try IntelliMouse/Explorer magic init.
462 static int im_explorer_detect(struct psmouse *psmouse, int set_properties)
464 struct ps2dev *ps2dev = &psmouse->ps2dev;
465 unsigned char param[2];
467 intellimouse_detect(psmouse, 0);
470 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
472 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
474 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
475 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
480 /* Magic to enable horizontal scrolling on IntelliMouse 4.0 */
482 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
484 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
486 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
489 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
491 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
493 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
495 if (set_properties) {
496 set_bit(BTN_MIDDLE, psmouse->dev->keybit);
497 set_bit(REL_WHEEL, psmouse->dev->relbit);
498 set_bit(REL_HWHEEL, psmouse->dev->relbit);
499 set_bit(BTN_SIDE, psmouse->dev->keybit);
500 set_bit(BTN_EXTRA, psmouse->dev->keybit);
502 if (!psmouse->vendor) psmouse->vendor = "Generic";
503 if (!psmouse->name) psmouse->name = "Explorer Mouse";
504 psmouse->pktsize = 4;
511 * Kensington ThinkingMouse / ExpertMouse magic init.
513 static int thinking_detect(struct psmouse *psmouse, int set_properties)
515 struct ps2dev *ps2dev = &psmouse->ps2dev;
516 unsigned char param[2];
517 unsigned char seq[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20, 0 };
521 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
523 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
524 for (i = 0; seq[i]; i++)
525 ps2_command(ps2dev, seq + i, PSMOUSE_CMD_SETRATE);
526 ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
531 if (set_properties) {
532 set_bit(BTN_EXTRA, psmouse->dev->keybit);
534 psmouse->vendor = "Kensington";
535 psmouse->name = "ThinkingMouse";
542 * Bare PS/2 protocol "detection". Always succeeds.
544 static int ps2bare_detect(struct psmouse *psmouse, int set_properties)
546 if (set_properties) {
547 if (!psmouse->vendor) psmouse->vendor = "Generic";
548 if (!psmouse->name) psmouse->name = "Mouse";
556 * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
557 * the mouse may have.
560 static int psmouse_extensions(struct psmouse *psmouse,
561 unsigned int max_proto, int set_properties)
563 int synaptics_hardware = 0;
566 * We always check for lifebook because it does not disturb mouse
567 * (it only checks DMI information).
569 if (lifebook_detect(psmouse, set_properties) == 0) {
570 if (max_proto > PSMOUSE_IMEX) {
571 if (!set_properties || lifebook_init(psmouse) == 0)
572 return PSMOUSE_LIFEBOOK;
577 * Try Kensington ThinkingMouse (we try first, because synaptics probe
578 * upsets the thinkingmouse).
581 if (max_proto > PSMOUSE_IMEX && thinking_detect(psmouse, set_properties) == 0)
582 return PSMOUSE_THINKPS;
585 * Try Synaptics TouchPad
587 if (max_proto > PSMOUSE_PS2 && synaptics_detect(psmouse, set_properties) == 0) {
588 synaptics_hardware = 1;
590 if (max_proto > PSMOUSE_IMEX) {
591 if (!set_properties || synaptics_init(psmouse) == 0)
592 return PSMOUSE_SYNAPTICS;
594 * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
595 * Unfortunately Logitech/Genius probes confuse some firmware versions so
596 * we'll have to skip them.
598 max_proto = PSMOUSE_IMEX;
601 * Make sure that touchpad is in relative mode, gestures (taps) are enabled
603 synaptics_reset(psmouse);
609 if (max_proto > PSMOUSE_IMEX) {
610 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
611 if (alps_detect(psmouse, set_properties) == 0) {
612 if (!set_properties || alps_init(psmouse) == 0)
615 * Init failed, try basic relative protocols
617 max_proto = PSMOUSE_IMEX;
621 if (max_proto > PSMOUSE_IMEX && genius_detect(psmouse, set_properties) == 0)
622 return PSMOUSE_GENPS;
624 if (max_proto > PSMOUSE_IMEX && ps2pp_init(psmouse, set_properties) == 0)
625 return PSMOUSE_PS2PP;
627 if (max_proto > PSMOUSE_IMEX && trackpoint_detect(psmouse, set_properties) == 0)
628 return PSMOUSE_TRACKPOINT;
631 * Reset to defaults in case the device got confused by extended
632 * protocol probes. Note that we do full reset becuase some mice
633 * put themselves to sleep when see PSMOUSE_RESET_DIS.
635 psmouse_reset(psmouse);
637 if (max_proto >= PSMOUSE_IMEX && im_explorer_detect(psmouse, set_properties) == 0)
640 if (max_proto >= PSMOUSE_IMPS && intellimouse_detect(psmouse, set_properties) == 0)
644 * Okay, all failed, we have a standard mouse here. The number of the buttons
645 * is still a question, though. We assume 3.
647 ps2bare_detect(psmouse, set_properties);
649 if (synaptics_hardware) {
651 * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
652 * We need to reset the touchpad because if there is a track point on the
653 * pass through port it could get disabled while probing for protocol
656 psmouse_reset(psmouse);
662 static struct psmouse_protocol psmouse_protocols[] = {
668 .detect = ps2bare_detect,
671 .type = PSMOUSE_PS2PP,
674 .detect = ps2pp_init,
677 .type = PSMOUSE_THINKPS,
680 .detect = thinking_detect,
683 .type = PSMOUSE_GENPS,
686 .detect = genius_detect,
689 .type = PSMOUSE_IMPS,
693 .detect = intellimouse_detect,
696 .type = PSMOUSE_IMEX,
700 .detect = im_explorer_detect,
703 .type = PSMOUSE_SYNAPTICS,
705 .alias = "synaptics",
706 .detect = synaptics_detect,
707 .init = synaptics_init,
710 .type = PSMOUSE_ALPS,
713 .detect = alps_detect,
717 .type = PSMOUSE_LIFEBOOK,
720 .init = lifebook_init,
723 .type = PSMOUSE_TRACKPOINT,
725 .alias = "trackpoint",
726 .detect = trackpoint_detect,
729 .type = PSMOUSE_AUTO,
736 static struct psmouse_protocol *psmouse_protocol_by_type(enum psmouse_type type)
740 for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++)
741 if (psmouse_protocols[i].type == type)
742 return &psmouse_protocols[i];
745 return &psmouse_protocols[0];
748 static struct psmouse_protocol *psmouse_protocol_by_name(const char *name, size_t len)
750 struct psmouse_protocol *p;
753 for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++) {
754 p = &psmouse_protocols[i];
756 if ((strlen(p->name) == len && !strncmp(p->name, name, len)) ||
757 (strlen(p->alias) == len && !strncmp(p->alias, name, len)))
758 return &psmouse_protocols[i];
766 * psmouse_probe() probes for a PS/2 mouse.
769 static int psmouse_probe(struct psmouse *psmouse)
771 struct ps2dev *ps2dev = &psmouse->ps2dev;
772 unsigned char param[2];
775 * First, we check if it's a mouse. It should send 0x00 or 0x03
776 * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
777 * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
778 * ID queries, probably due to a firmware bug.
782 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
785 if (param[0] != 0x00 && param[0] != 0x03 &&
786 param[0] != 0x04 && param[0] != 0xff)
790 * Then we reset and disable the mouse so that it doesn't generate events.
793 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS))
794 printk(KERN_WARNING "psmouse.c: Failed to reset mouse on %s\n", ps2dev->serio->phys);
800 * Here we set the mouse resolution.
803 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution)
805 unsigned char params[] = { 0, 1, 2, 2, 3 };
807 if (resolution == 0 || resolution > 200)
810 ps2_command(&psmouse->ps2dev, ¶ms[resolution / 50], PSMOUSE_CMD_SETRES);
811 psmouse->resolution = 25 << params[resolution / 50];
815 * Here we set the mouse report rate.
818 static void psmouse_set_rate(struct psmouse *psmouse, unsigned int rate)
820 unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
823 while (rates[i] > rate) i++;
824 ps2_command(&psmouse->ps2dev, &rates[i], PSMOUSE_CMD_SETRATE);
825 psmouse->rate = rates[i];
829 * psmouse_initialize() initializes the mouse to a sane state.
832 static void psmouse_initialize(struct psmouse *psmouse)
835 * We set the mouse into streaming mode.
838 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM);
841 * We set the mouse report rate, resolution and scaling.
844 if (psmouse_max_proto != PSMOUSE_PS2) {
845 psmouse->set_rate(psmouse, psmouse->rate);
846 psmouse->set_resolution(psmouse, psmouse->resolution);
847 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
852 * psmouse_activate() enables the mouse so that we get motion reports from it.
855 static void psmouse_activate(struct psmouse *psmouse)
857 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE))
858 printk(KERN_WARNING "psmouse.c: Failed to enable mouse on %s\n",
859 psmouse->ps2dev.serio->phys);
861 psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
866 * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
867 * reports from it unless we explicitely request it.
870 static void psmouse_deactivate(struct psmouse *psmouse)
872 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_DISABLE))
873 printk(KERN_WARNING "psmouse.c: Failed to deactivate mouse on %s\n",
874 psmouse->ps2dev.serio->phys);
876 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
880 * psmouse_poll() - default poll hanlder. Everyone except for ALPS uses it.
883 static int psmouse_poll(struct psmouse *psmouse)
885 return ps2_command(&psmouse->ps2dev, psmouse->packet,
886 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8));
891 * psmouse_resync() attempts to re-validate current protocol.
894 static void psmouse_resync(void *p)
896 struct psmouse *psmouse = p, *parent = NULL;
897 struct serio *serio = psmouse->ps2dev.serio;
898 psmouse_ret_t rc = PSMOUSE_GOOD_DATA;
899 int failed = 0, enabled = 0;
902 mutex_lock(&psmouse_mutex);
904 if (psmouse->state != PSMOUSE_RESYNCING)
907 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
908 parent = serio_get_drvdata(serio->parent);
909 psmouse_deactivate(parent);
913 * Some mice don't ACK commands sent while they are in the middle of
914 * transmitting motion packet. To avoid delay we use ps2_sendbyte()
915 * instead of ps2_command() which would wait for 200ms for an ACK
916 * that may never come.
917 * As an additional quirk ALPS touchpads may not only forget to ACK
918 * disable command but will stop reporting taps, so if we see that
919 * mouse at least once ACKs disable we will do full reconnect if ACK
922 psmouse->num_resyncs++;
924 if (ps2_sendbyte(&psmouse->ps2dev, PSMOUSE_CMD_DISABLE, 20)) {
925 if (psmouse->num_resyncs < 3 || psmouse->acks_disable_command)
928 psmouse->acks_disable_command = 1;
931 * Poll the mouse. If it was reset the packet will be shorter than
932 * psmouse->pktsize and ps2_command will fail. We do not expect and
933 * do not handle scenario when mouse "upgrades" its protocol while
934 * disconnected since it would require additional delay. If we ever
935 * see a mouse that does it we'll adjust the code.
938 if (psmouse->poll(psmouse))
941 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
942 for (i = 0; i < psmouse->pktsize; i++) {
944 rc = psmouse->protocol_handler(psmouse, NULL);
945 if (rc != PSMOUSE_GOOD_DATA)
948 if (rc != PSMOUSE_FULL_PACKET)
950 psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
954 * Now try to enable mouse. We try to do that even if poll failed and also
955 * repeat our attempts 5 times, otherwise we may be left out with disabled
958 for (i = 0; i < 5; i++) {
959 if (!ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
967 printk(KERN_WARNING "psmouse.c: failed to re-enable mouse on %s\n",
968 psmouse->ps2dev.serio->phys);
973 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
974 printk(KERN_INFO "psmouse.c: resync failed, issuing reconnect request\n");
975 serio_reconnect(serio);
977 psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
980 psmouse_activate(parent);
982 mutex_unlock(&psmouse_mutex);
986 * psmouse_cleanup() resets the mouse into power-on state.
989 static void psmouse_cleanup(struct serio *serio)
991 struct psmouse *psmouse = serio_get_drvdata(serio);
993 psmouse_reset(psmouse);
997 * psmouse_disconnect() closes and frees.
1000 static void psmouse_disconnect(struct serio *serio)
1002 struct psmouse *psmouse, *parent = NULL;
1004 psmouse = serio_get_drvdata(serio);
1006 sysfs_remove_group(&serio->dev.kobj, &psmouse_attribute_group);
1008 mutex_lock(&psmouse_mutex);
1010 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1012 /* make sure we don't have a resync in progress */
1013 mutex_unlock(&psmouse_mutex);
1014 flush_workqueue(kpsmoused_wq);
1015 mutex_lock(&psmouse_mutex);
1017 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1018 parent = serio_get_drvdata(serio->parent);
1019 psmouse_deactivate(parent);
1022 if (psmouse->disconnect)
1023 psmouse->disconnect(psmouse);
1025 if (parent && parent->pt_deactivate)
1026 parent->pt_deactivate(parent);
1028 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1031 serio_set_drvdata(serio, NULL);
1032 input_unregister_device(psmouse->dev);
1036 psmouse_activate(parent);
1038 mutex_unlock(&psmouse_mutex);
1041 static int psmouse_switch_protocol(struct psmouse *psmouse, struct psmouse_protocol *proto)
1043 struct input_dev *input_dev = psmouse->dev;
1045 input_dev->private = psmouse;
1046 input_dev->cdev.dev = &psmouse->ps2dev.serio->dev;
1048 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
1049 input_dev->keybit[LONG(BTN_MOUSE)] = BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT);
1050 input_dev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
1052 psmouse->set_rate = psmouse_set_rate;
1053 psmouse->set_resolution = psmouse_set_resolution;
1054 psmouse->poll = psmouse_poll;
1055 psmouse->protocol_handler = psmouse_process_byte;
1056 psmouse->pktsize = 3;
1058 if (proto && (proto->detect || proto->init)) {
1059 if (proto->detect && proto->detect(psmouse, 1) < 0)
1062 if (proto->init && proto->init(psmouse) < 0)
1065 psmouse->type = proto->type;
1068 psmouse->type = psmouse_extensions(psmouse, psmouse_max_proto, 1);
1071 * If mouse's packet size is 3 there is no point in polling the
1072 * device in hopes to detect protocol reset - we won't get less
1073 * than 3 bytes response anyhow.
1075 if (psmouse->pktsize == 3)
1076 psmouse->resync_time = 0;
1079 * Some smart KVMs fake response to POLL command returning just
1080 * 3 bytes and messing up our resync logic, so if initial poll
1081 * fails we won't try polling the device anymore. Hopefully
1082 * such KVM will maintain initially selected protocol.
1084 if (psmouse->resync_time && psmouse->poll(psmouse))
1085 psmouse->resync_time = 0;
1087 snprintf(psmouse->devname, sizeof(psmouse->devname), "%s %s %s",
1088 psmouse_protocol_by_type(psmouse->type)->name, psmouse->vendor, psmouse->name);
1090 input_dev->name = psmouse->devname;
1091 input_dev->phys = psmouse->phys;
1092 input_dev->id.bustype = BUS_I8042;
1093 input_dev->id.vendor = 0x0002;
1094 input_dev->id.product = psmouse->type;
1095 input_dev->id.version = psmouse->model;
1101 * psmouse_connect() is a callback from the serio module when
1102 * an unhandled serio port is found.
1104 static int psmouse_connect(struct serio *serio, struct serio_driver *drv)
1106 struct psmouse *psmouse, *parent = NULL;
1107 struct input_dev *input_dev;
1108 int retval = -ENOMEM;
1110 mutex_lock(&psmouse_mutex);
1113 * If this is a pass-through port deactivate parent so the device
1114 * connected to this port can be successfully identified
1116 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1117 parent = serio_get_drvdata(serio->parent);
1118 psmouse_deactivate(parent);
1121 psmouse = kzalloc(sizeof(struct psmouse), GFP_KERNEL);
1122 input_dev = input_allocate_device();
1123 if (!psmouse || !input_dev)
1126 ps2_init(&psmouse->ps2dev, serio);
1127 INIT_WORK(&psmouse->resync_work, psmouse_resync, psmouse);
1128 psmouse->dev = input_dev;
1129 snprintf(psmouse->phys, sizeof(psmouse->phys), "%s/input0", serio->phys);
1131 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1133 serio_set_drvdata(serio, psmouse);
1135 retval = serio_open(serio, drv);
1139 if (psmouse_probe(psmouse) < 0) {
1145 psmouse->rate = psmouse_rate;
1146 psmouse->resolution = psmouse_resolution;
1147 psmouse->resetafter = psmouse_resetafter;
1148 psmouse->resync_time = parent ? 0 : psmouse_resync_time;
1149 psmouse->smartscroll = psmouse_smartscroll;
1151 psmouse_switch_protocol(psmouse, NULL);
1153 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1154 psmouse_initialize(psmouse);
1156 input_register_device(psmouse->dev);
1158 if (parent && parent->pt_activate)
1159 parent->pt_activate(parent);
1161 sysfs_create_group(&serio->dev.kobj, &psmouse_attribute_group);
1163 psmouse_activate(psmouse);
1169 serio_set_drvdata(serio, NULL);
1170 input_free_device(input_dev);
1174 /* If this is a pass-through port the parent needs to be re-activated */
1176 psmouse_activate(parent);
1178 mutex_unlock(&psmouse_mutex);
1183 static int psmouse_reconnect(struct serio *serio)
1185 struct psmouse *psmouse = serio_get_drvdata(serio);
1186 struct psmouse *parent = NULL;
1187 struct serio_driver *drv = serio->drv;
1190 if (!drv || !psmouse) {
1191 printk(KERN_DEBUG "psmouse: reconnect request, but serio is disconnected, ignoring...\n");
1195 mutex_lock(&psmouse_mutex);
1197 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1198 parent = serio_get_drvdata(serio->parent);
1199 psmouse_deactivate(parent);
1202 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1204 if (psmouse->reconnect) {
1205 if (psmouse->reconnect(psmouse))
1207 } else if (psmouse_probe(psmouse) < 0 ||
1208 psmouse->type != psmouse_extensions(psmouse, psmouse_max_proto, 0))
1211 /* ok, the device type (and capabilities) match the old one,
1212 * we can continue using it, complete intialization
1214 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1216 psmouse_initialize(psmouse);
1218 if (parent && parent->pt_activate)
1219 parent->pt_activate(parent);
1221 psmouse_activate(psmouse);
1225 /* If this is a pass-through port the parent waits to be activated */
1227 psmouse_activate(parent);
1229 mutex_unlock(&psmouse_mutex);
1233 static struct serio_device_id psmouse_serio_ids[] = {
1241 .type = SERIO_PS_PSTHRU,
1249 MODULE_DEVICE_TABLE(serio, psmouse_serio_ids);
1251 static struct serio_driver psmouse_drv = {
1255 .description = DRIVER_DESC,
1256 .id_table = psmouse_serio_ids,
1257 .interrupt = psmouse_interrupt,
1258 .connect = psmouse_connect,
1259 .reconnect = psmouse_reconnect,
1260 .disconnect = psmouse_disconnect,
1261 .cleanup = psmouse_cleanup,
1264 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *devattr,
1267 struct serio *serio = to_serio_port(dev);
1268 struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1269 struct psmouse *psmouse;
1272 retval = serio_pin_driver(serio);
1276 if (serio->drv != &psmouse_drv) {
1281 psmouse = serio_get_drvdata(serio);
1283 retval = attr->show(psmouse, attr->data, buf);
1286 serio_unpin_driver(serio);
1290 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *devattr,
1291 const char *buf, size_t count)
1293 struct serio *serio = to_serio_port(dev);
1294 struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1295 struct psmouse *psmouse, *parent = NULL;
1298 retval = serio_pin_driver(serio);
1302 if (serio->drv != &psmouse_drv) {
1307 retval = mutex_lock_interruptible(&psmouse_mutex);
1311 psmouse = serio_get_drvdata(serio);
1313 if (psmouse->state == PSMOUSE_IGNORE) {
1318 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1319 parent = serio_get_drvdata(serio->parent);
1320 psmouse_deactivate(parent);
1323 psmouse_deactivate(psmouse);
1325 retval = attr->set(psmouse, attr->data, buf, count);
1327 if (retval != -ENODEV)
1328 psmouse_activate(psmouse);
1331 psmouse_activate(parent);
1334 mutex_unlock(&psmouse_mutex);
1336 serio_unpin_driver(serio);
1340 static ssize_t psmouse_show_int_attr(struct psmouse *psmouse, void *offset, char *buf)
1342 unsigned long *field = (unsigned long *)((char *)psmouse + (size_t)offset);
1344 return sprintf(buf, "%lu\n", *field);
1347 static ssize_t psmouse_set_int_attr(struct psmouse *psmouse, void *offset, const char *buf, size_t count)
1349 unsigned long *field = (unsigned long *)((char *)psmouse + (size_t)offset);
1350 unsigned long value;
1353 value = simple_strtoul(buf, &rest, 10);
1362 static ssize_t psmouse_attr_show_protocol(struct psmouse *psmouse, void *data, char *buf)
1364 return sprintf(buf, "%s\n", psmouse_protocol_by_type(psmouse->type)->name);
1367 static ssize_t psmouse_attr_set_protocol(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1369 struct serio *serio = psmouse->ps2dev.serio;
1370 struct psmouse *parent = NULL;
1371 struct input_dev *new_dev;
1372 struct psmouse_protocol *proto;
1375 if (!(proto = psmouse_protocol_by_name(buf, count)))
1378 if (psmouse->type == proto->type)
1381 if (!(new_dev = input_allocate_device()))
1384 while (serio->child) {
1386 printk(KERN_WARNING "psmouse: failed to destroy child port, protocol change aborted.\n");
1387 input_free_device(new_dev);
1391 mutex_unlock(&psmouse_mutex);
1392 serio_unpin_driver(serio);
1393 serio_unregister_child_port(serio);
1394 serio_pin_driver_uninterruptible(serio);
1395 mutex_lock(&psmouse_mutex);
1397 if (serio->drv != &psmouse_drv) {
1398 input_free_device(new_dev);
1402 if (psmouse->type == proto->type) {
1403 input_free_device(new_dev);
1404 return count; /* switched by other thread */
1408 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1409 parent = serio_get_drvdata(serio->parent);
1410 if (parent->pt_deactivate)
1411 parent->pt_deactivate(parent);
1414 if (psmouse->disconnect)
1415 psmouse->disconnect(psmouse);
1417 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1418 input_unregister_device(psmouse->dev);
1420 psmouse->dev = new_dev;
1421 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1423 if (psmouse_switch_protocol(psmouse, proto) < 0) {
1424 psmouse_reset(psmouse);
1425 /* default to PSMOUSE_PS2 */
1426 psmouse_switch_protocol(psmouse, &psmouse_protocols[0]);
1429 psmouse_initialize(psmouse);
1430 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1432 input_register_device(psmouse->dev);
1434 if (parent && parent->pt_activate)
1435 parent->pt_activate(parent);
1440 static ssize_t psmouse_attr_set_rate(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1442 unsigned long value;
1445 value = simple_strtoul(buf, &rest, 10);
1449 psmouse->set_rate(psmouse, value);
1453 static ssize_t psmouse_attr_set_resolution(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1455 unsigned long value;
1458 value = simple_strtoul(buf, &rest, 10);
1462 psmouse->set_resolution(psmouse, value);
1467 static int psmouse_set_maxproto(const char *val, struct kernel_param *kp)
1469 struct psmouse_protocol *proto;
1474 proto = psmouse_protocol_by_name(val, strlen(val));
1476 if (!proto || !proto->maxproto)
1479 *((unsigned int *)kp->arg) = proto->type;
1484 static int psmouse_get_maxproto(char *buffer, struct kernel_param *kp)
1486 int type = *((unsigned int *)kp->arg);
1488 return sprintf(buffer, "%s\n", psmouse_protocol_by_type(type)->name);
1491 static int __init psmouse_init(void)
1493 kpsmoused_wq = create_singlethread_workqueue("kpsmoused");
1494 if (!kpsmoused_wq) {
1495 printk(KERN_ERR "psmouse: failed to create kpsmoused workqueue\n");
1499 serio_register_driver(&psmouse_drv);
1504 static void __exit psmouse_exit(void)
1506 serio_unregister_driver(&psmouse_drv);
1507 destroy_workqueue(kpsmoused_wq);
1510 module_init(psmouse_init);
1511 module_exit(psmouse_exit);