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
)
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
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 switch (packet
[3] & 0xC0) {
152 case 0x80: /* vertical scroll on IntelliMouse Explorer 4.0 */
153 input_report_rel(dev
, REL_WHEEL
, (int) (packet
[3] & 32) - (int) (packet
[3] & 31));
155 case 0x40: /* horizontal scroll on IntelliMouse Explorer 4.0 */
156 input_report_rel(dev
, REL_HWHEEL
, (int) (packet
[3] & 32) - (int) (packet
[3] & 31));
160 input_report_rel(dev
, REL_WHEEL
, (int) (packet
[3] & 8) - (int) (packet
[3] & 7));
161 input_report_key(dev
, BTN_SIDE
, (packet
[3] >> 4) & 1);
162 input_report_key(dev
, BTN_EXTRA
, (packet
[3] >> 5) & 1);
168 * Extra buttons on Genius NewNet 3D
171 if (psmouse
->type
== PSMOUSE_GENPS
) {
172 input_report_key(dev
, BTN_SIDE
, (packet
[0] >> 6) & 1);
173 input_report_key(dev
, BTN_EXTRA
, (packet
[0] >> 7) & 1);
177 * Extra button on ThinkingMouse
179 if (psmouse
->type
== PSMOUSE_THINKPS
) {
180 input_report_key(dev
, BTN_EXTRA
, (packet
[0] >> 3) & 1);
181 /* Without this bit of weirdness moving up gives wildly high Y changes. */
182 packet
[1] |= (packet
[0] & 0x40) << 1;
189 input_report_key(dev
, BTN_LEFT
, packet
[0] & 1);
190 input_report_key(dev
, BTN_MIDDLE
, (packet
[0] >> 2) & 1);
191 input_report_key(dev
, BTN_RIGHT
, (packet
[0] >> 1) & 1);
193 input_report_rel(dev
, REL_X
, packet
[1] ? (int) packet
[1] - (int) ((packet
[0] << 4) & 0x100) : 0);
194 input_report_rel(dev
, REL_Y
, packet
[2] ? (int) ((packet
[0] << 3) & 0x100) - (int) packet
[2] : 0);
198 return PSMOUSE_FULL_PACKET
;
202 * __psmouse_set_state() sets new psmouse state and resets all flags.
205 static inline void __psmouse_set_state(struct psmouse
*psmouse
, enum psmouse_state new_state
)
207 psmouse
->state
= new_state
;
208 psmouse
->pktcnt
= psmouse
->out_of_sync
= 0;
209 psmouse
->ps2dev
.flags
= 0;
210 psmouse
->last
= jiffies
;
215 * psmouse_set_state() sets new psmouse state and resets all flags and
216 * counters while holding serio lock so fighting with interrupt handler
220 static void psmouse_set_state(struct psmouse
*psmouse
, enum psmouse_state new_state
)
222 serio_pause_rx(psmouse
->ps2dev
.serio
);
223 __psmouse_set_state(psmouse
, new_state
);
224 serio_continue_rx(psmouse
->ps2dev
.serio
);
228 * psmouse_handle_byte() processes one byte of the input data stream
229 * by calling corresponding protocol handler.
232 static int psmouse_handle_byte(struct psmouse
*psmouse
)
234 psmouse_ret_t rc
= psmouse
->protocol_handler(psmouse
);
237 case PSMOUSE_BAD_DATA
:
238 if (psmouse
->state
== PSMOUSE_ACTIVATED
) {
239 printk(KERN_WARNING
"psmouse.c: %s at %s lost sync at byte %d\n",
240 psmouse
->name
, psmouse
->phys
, psmouse
->pktcnt
);
241 if (++psmouse
->out_of_sync
== psmouse
->resetafter
) {
242 __psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
243 printk(KERN_NOTICE
"psmouse.c: issuing reconnect request\n");
244 serio_reconnect(psmouse
->ps2dev
.serio
);
251 case PSMOUSE_FULL_PACKET
:
253 if (psmouse
->out_of_sync
) {
254 psmouse
->out_of_sync
= 0;
255 printk(KERN_NOTICE
"psmouse.c: %s at %s - driver resynched.\n",
256 psmouse
->name
, psmouse
->phys
);
260 case PSMOUSE_GOOD_DATA
:
267 * psmouse_interrupt() handles incoming characters, either passing them
268 * for normal processing or gathering them as command response.
271 static irqreturn_t
psmouse_interrupt(struct serio
*serio
,
272 unsigned char data
, unsigned int flags
)
274 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
276 if (psmouse
->state
== PSMOUSE_IGNORE
)
279 if (flags
& (SERIO_PARITY
|SERIO_TIMEOUT
)) {
280 if (psmouse
->state
== PSMOUSE_ACTIVATED
)
281 printk(KERN_WARNING
"psmouse.c: bad data from KBC -%s%s\n",
282 flags
& SERIO_TIMEOUT
? " timeout" : "",
283 flags
& SERIO_PARITY
? " bad parity" : "");
284 ps2_cmd_aborted(&psmouse
->ps2dev
);
288 if (unlikely(psmouse
->ps2dev
.flags
& PS2_FLAG_ACK
))
289 if (ps2_handle_ack(&psmouse
->ps2dev
, data
))
292 if (unlikely(psmouse
->ps2dev
.flags
& PS2_FLAG_CMD
))
293 if (ps2_handle_response(&psmouse
->ps2dev
, data
))
296 if (psmouse
->state
<= PSMOUSE_RESYNCING
)
299 if (psmouse
->state
== PSMOUSE_ACTIVATED
&&
300 psmouse
->pktcnt
&& time_after(jiffies
, psmouse
->last
+ HZ
/2)) {
301 printk(KERN_INFO
"psmouse.c: %s at %s lost synchronization, throwing %d bytes away.\n",
302 psmouse
->name
, psmouse
->phys
, psmouse
->pktcnt
);
303 psmouse
->badbyte
= psmouse
->packet
[0];
304 __psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
305 queue_work(kpsmoused_wq
, &psmouse
->resync_work
);
309 psmouse
->packet
[psmouse
->pktcnt
++] = data
;
311 * Check if this is a new device announcement (0xAA 0x00)
313 if (unlikely(psmouse
->packet
[0] == PSMOUSE_RET_BAT
&& psmouse
->pktcnt
<= 2)) {
314 if (psmouse
->pktcnt
== 1) {
315 psmouse
->last
= jiffies
;
319 if (psmouse
->packet
[1] == PSMOUSE_RET_ID
) {
320 __psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
321 serio_reconnect(serio
);
325 * Not a new device, try processing first byte normally
328 if (psmouse_handle_byte(psmouse
))
331 psmouse
->packet
[psmouse
->pktcnt
++] = data
;
335 * See if we need to force resync because mouse was idle for too long
337 if (psmouse
->state
== PSMOUSE_ACTIVATED
&&
338 psmouse
->pktcnt
== 1 && psmouse
->resync_time
&&
339 time_after(jiffies
, psmouse
->last
+ psmouse
->resync_time
* HZ
)) {
340 psmouse
->badbyte
= psmouse
->packet
[0];
341 __psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
342 queue_work(kpsmoused_wq
, &psmouse
->resync_work
);
346 psmouse
->last
= jiffies
;
347 psmouse_handle_byte(psmouse
);
355 * psmouse_sliced_command() sends an extended PS/2 command to the mouse
356 * using sliced syntax, understood by advanced devices, such as Logitech
357 * or Synaptics touchpads. The command is encoded as:
358 * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
361 int psmouse_sliced_command(struct psmouse
*psmouse
, unsigned char command
)
365 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
))
368 for (i
= 6; i
>= 0; i
-= 2) {
369 unsigned char d
= (command
>> i
) & 3;
370 if (ps2_command(&psmouse
->ps2dev
, &d
, PSMOUSE_CMD_SETRES
))
379 * psmouse_reset() resets the mouse into power-on state.
381 int psmouse_reset(struct psmouse
*psmouse
)
383 unsigned char param
[2];
385 if (ps2_command(&psmouse
->ps2dev
, param
, PSMOUSE_CMD_RESET_BAT
))
388 if (param
[0] != PSMOUSE_RET_BAT
&& param
[1] != PSMOUSE_RET_ID
)
396 * Genius NetMouse magic init.
398 static int genius_detect(struct psmouse
*psmouse
, int set_properties
)
400 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
401 unsigned char param
[4];
404 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
);
405 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
406 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
407 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
408 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
);
410 if (param
[0] != 0x00 || param
[1] != 0x33 || param
[2] != 0x55)
413 if (set_properties
) {
414 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
415 set_bit(BTN_SIDE
, psmouse
->dev
->keybit
);
416 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
418 psmouse
->vendor
= "Genius";
419 psmouse
->name
= "Mouse";
420 psmouse
->pktsize
= 4;
427 * IntelliMouse magic init.
429 static int intellimouse_detect(struct psmouse
*psmouse
, int set_properties
)
431 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
432 unsigned char param
[2];
435 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
437 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
439 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
440 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
445 if (set_properties
) {
446 set_bit(BTN_MIDDLE
, psmouse
->dev
->keybit
);
447 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
449 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
450 if (!psmouse
->name
) psmouse
->name
= "Wheel Mouse";
451 psmouse
->pktsize
= 4;
458 * Try IntelliMouse/Explorer magic init.
460 static int im_explorer_detect(struct psmouse
*psmouse
, int set_properties
)
462 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
463 unsigned char param
[2];
465 intellimouse_detect(psmouse
, 0);
468 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
470 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
472 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
473 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
478 /* Magic to enable horizontal scrolling on IntelliMouse 4.0 */
480 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
482 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
484 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
486 if (set_properties
) {
487 set_bit(BTN_MIDDLE
, psmouse
->dev
->keybit
);
488 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
489 set_bit(REL_HWHEEL
, psmouse
->dev
->relbit
);
490 set_bit(BTN_SIDE
, psmouse
->dev
->keybit
);
491 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
493 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
494 if (!psmouse
->name
) psmouse
->name
= "Explorer Mouse";
495 psmouse
->pktsize
= 4;
502 * Kensington ThinkingMouse / ExpertMouse magic init.
504 static int thinking_detect(struct psmouse
*psmouse
, int set_properties
)
506 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
507 unsigned char param
[2];
508 static const unsigned char seq
[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
512 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
514 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
);
515 for (i
= 0; i
< ARRAY_SIZE(seq
); i
++) {
517 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
519 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
524 if (set_properties
) {
525 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
527 psmouse
->vendor
= "Kensington";
528 psmouse
->name
= "ThinkingMouse";
535 * Bare PS/2 protocol "detection". Always succeeds.
537 static int ps2bare_detect(struct psmouse
*psmouse
, int set_properties
)
539 if (set_properties
) {
540 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
541 if (!psmouse
->name
) psmouse
->name
= "Mouse";
549 * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
550 * the mouse may have.
553 static int psmouse_extensions(struct psmouse
*psmouse
,
554 unsigned int max_proto
, int set_properties
)
556 int synaptics_hardware
= 0;
559 * We always check for lifebook because it does not disturb mouse
560 * (it only checks DMI information).
562 if (lifebook_detect(psmouse
, set_properties
) == 0) {
563 if (max_proto
> PSMOUSE_IMEX
) {
564 if (!set_properties
|| lifebook_init(psmouse
) == 0)
565 return PSMOUSE_LIFEBOOK
;
570 * Try Kensington ThinkingMouse (we try first, because synaptics probe
571 * upsets the thinkingmouse).
574 if (max_proto
> PSMOUSE_IMEX
&& thinking_detect(psmouse
, set_properties
) == 0)
575 return PSMOUSE_THINKPS
;
578 * Try Synaptics TouchPad
580 if (max_proto
> PSMOUSE_PS2
&& synaptics_detect(psmouse
, set_properties
) == 0) {
581 synaptics_hardware
= 1;
583 if (max_proto
> PSMOUSE_IMEX
) {
584 if (!set_properties
|| synaptics_init(psmouse
) == 0)
585 return PSMOUSE_SYNAPTICS
;
587 * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
588 * Unfortunately Logitech/Genius probes confuse some firmware versions so
589 * we'll have to skip them.
591 max_proto
= PSMOUSE_IMEX
;
594 * Make sure that touchpad is in relative mode, gestures (taps) are enabled
596 synaptics_reset(psmouse
);
602 if (max_proto
> PSMOUSE_IMEX
) {
603 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
);
604 if (alps_detect(psmouse
, set_properties
) == 0) {
605 if (!set_properties
|| alps_init(psmouse
) == 0)
608 * Init failed, try basic relative protocols
610 max_proto
= PSMOUSE_IMEX
;
614 if (max_proto
> PSMOUSE_IMEX
&& genius_detect(psmouse
, set_properties
) == 0)
615 return PSMOUSE_GENPS
;
617 if (max_proto
> PSMOUSE_IMEX
&& ps2pp_init(psmouse
, set_properties
) == 0)
618 return PSMOUSE_PS2PP
;
620 if (max_proto
> PSMOUSE_IMEX
&& trackpoint_detect(psmouse
, set_properties
) == 0)
621 return PSMOUSE_TRACKPOINT
;
624 * Reset to defaults in case the device got confused by extended
625 * protocol probes. Note that we do full reset becuase some mice
626 * put themselves to sleep when see PSMOUSE_RESET_DIS.
628 psmouse_reset(psmouse
);
630 if (max_proto
>= PSMOUSE_IMEX
&& im_explorer_detect(psmouse
, set_properties
) == 0)
633 if (max_proto
>= PSMOUSE_IMPS
&& intellimouse_detect(psmouse
, set_properties
) == 0)
637 * Okay, all failed, we have a standard mouse here. The number of the buttons
638 * is still a question, though. We assume 3.
640 ps2bare_detect(psmouse
, set_properties
);
642 if (synaptics_hardware
) {
644 * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
645 * We need to reset the touchpad because if there is a track point on the
646 * pass through port it could get disabled while probing for protocol
649 psmouse_reset(psmouse
);
655 static const struct psmouse_protocol psmouse_protocols
[] = {
661 .detect
= ps2bare_detect
,
664 .type
= PSMOUSE_PS2PP
,
667 .detect
= ps2pp_init
,
670 .type
= PSMOUSE_THINKPS
,
673 .detect
= thinking_detect
,
676 .type
= PSMOUSE_GENPS
,
679 .detect
= genius_detect
,
682 .type
= PSMOUSE_IMPS
,
686 .detect
= intellimouse_detect
,
689 .type
= PSMOUSE_IMEX
,
693 .detect
= im_explorer_detect
,
696 .type
= PSMOUSE_SYNAPTICS
,
698 .alias
= "synaptics",
699 .detect
= synaptics_detect
,
700 .init
= synaptics_init
,
703 .type
= PSMOUSE_ALPS
,
706 .detect
= alps_detect
,
710 .type
= PSMOUSE_LIFEBOOK
,
713 .init
= lifebook_init
,
716 .type
= PSMOUSE_TRACKPOINT
,
718 .alias
= "trackpoint",
719 .detect
= trackpoint_detect
,
722 .type
= PSMOUSE_AUTO
,
729 static const struct psmouse_protocol
*psmouse_protocol_by_type(enum psmouse_type type
)
733 for (i
= 0; i
< ARRAY_SIZE(psmouse_protocols
); i
++)
734 if (psmouse_protocols
[i
].type
== type
)
735 return &psmouse_protocols
[i
];
738 return &psmouse_protocols
[0];
741 static const struct psmouse_protocol
*psmouse_protocol_by_name(const char *name
, size_t len
)
743 const struct psmouse_protocol
*p
;
746 for (i
= 0; i
< ARRAY_SIZE(psmouse_protocols
); i
++) {
747 p
= &psmouse_protocols
[i
];
749 if ((strlen(p
->name
) == len
&& !strncmp(p
->name
, name
, len
)) ||
750 (strlen(p
->alias
) == len
&& !strncmp(p
->alias
, name
, len
)))
751 return &psmouse_protocols
[i
];
759 * psmouse_probe() probes for a PS/2 mouse.
762 static int psmouse_probe(struct psmouse
*psmouse
)
764 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
765 unsigned char param
[2];
768 * First, we check if it's a mouse. It should send 0x00 or 0x03
769 * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
770 * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
771 * ID queries, probably due to a firmware bug.
775 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
))
778 if (param
[0] != 0x00 && param
[0] != 0x03 &&
779 param
[0] != 0x04 && param
[0] != 0xff)
783 * Then we reset and disable the mouse so that it doesn't generate events.
786 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
))
787 printk(KERN_WARNING
"psmouse.c: Failed to reset mouse on %s\n", ps2dev
->serio
->phys
);
793 * Here we set the mouse resolution.
796 void psmouse_set_resolution(struct psmouse
*psmouse
, unsigned int resolution
)
798 static const unsigned char params
[] = { 0, 1, 2, 2, 3 };
801 if (resolution
== 0 || resolution
> 200)
804 p
= params
[resolution
/ 50];
805 ps2_command(&psmouse
->ps2dev
, &p
, PSMOUSE_CMD_SETRES
);
806 psmouse
->resolution
= 25 << p
;
810 * Here we set the mouse report rate.
813 static void psmouse_set_rate(struct psmouse
*psmouse
, unsigned int rate
)
815 static const unsigned char rates
[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
819 while (rates
[i
] > rate
) i
++;
821 ps2_command(&psmouse
->ps2dev
, &r
, PSMOUSE_CMD_SETRATE
);
826 * psmouse_initialize() initializes the mouse to a sane state.
829 static void psmouse_initialize(struct psmouse
*psmouse
)
832 * We set the mouse into streaming mode.
835 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSTREAM
);
838 * We set the mouse report rate, resolution and scaling.
841 if (psmouse_max_proto
!= PSMOUSE_PS2
) {
842 psmouse
->set_rate(psmouse
, psmouse
->rate
);
843 psmouse
->set_resolution(psmouse
, psmouse
->resolution
);
844 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
849 * psmouse_activate() enables the mouse so that we get motion reports from it.
852 static void psmouse_activate(struct psmouse
*psmouse
)
854 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
))
855 printk(KERN_WARNING
"psmouse.c: Failed to enable mouse on %s\n",
856 psmouse
->ps2dev
.serio
->phys
);
858 psmouse_set_state(psmouse
, PSMOUSE_ACTIVATED
);
863 * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
864 * reports from it unless we explicitely request it.
867 static void psmouse_deactivate(struct psmouse
*psmouse
)
869 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
))
870 printk(KERN_WARNING
"psmouse.c: Failed to deactivate mouse on %s\n",
871 psmouse
->ps2dev
.serio
->phys
);
873 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
877 * psmouse_poll() - default poll hanlder. Everyone except for ALPS uses it.
880 static int psmouse_poll(struct psmouse
*psmouse
)
882 return ps2_command(&psmouse
->ps2dev
, psmouse
->packet
,
883 PSMOUSE_CMD_POLL
| (psmouse
->pktsize
<< 8));
888 * psmouse_resync() attempts to re-validate current protocol.
891 static void psmouse_resync(void *p
)
893 struct psmouse
*psmouse
= p
, *parent
= NULL
;
894 struct serio
*serio
= psmouse
->ps2dev
.serio
;
895 psmouse_ret_t rc
= PSMOUSE_GOOD_DATA
;
896 int failed
= 0, enabled
= 0;
899 mutex_lock(&psmouse_mutex
);
901 if (psmouse
->state
!= PSMOUSE_RESYNCING
)
904 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
905 parent
= serio_get_drvdata(serio
->parent
);
906 psmouse_deactivate(parent
);
910 * Some mice don't ACK commands sent while they are in the middle of
911 * transmitting motion packet. To avoid delay we use ps2_sendbyte()
912 * instead of ps2_command() which would wait for 200ms for an ACK
913 * that may never come.
914 * As an additional quirk ALPS touchpads may not only forget to ACK
915 * disable command but will stop reporting taps, so if we see that
916 * mouse at least once ACKs disable we will do full reconnect if ACK
919 psmouse
->num_resyncs
++;
921 if (ps2_sendbyte(&psmouse
->ps2dev
, PSMOUSE_CMD_DISABLE
, 20)) {
922 if (psmouse
->num_resyncs
< 3 || psmouse
->acks_disable_command
)
925 psmouse
->acks_disable_command
= 1;
928 * Poll the mouse. If it was reset the packet will be shorter than
929 * psmouse->pktsize and ps2_command will fail. We do not expect and
930 * do not handle scenario when mouse "upgrades" its protocol while
931 * disconnected since it would require additional delay. If we ever
932 * see a mouse that does it we'll adjust the code.
935 if (psmouse
->poll(psmouse
))
938 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
939 for (i
= 0; i
< psmouse
->pktsize
; i
++) {
941 rc
= psmouse
->protocol_handler(psmouse
);
942 if (rc
!= PSMOUSE_GOOD_DATA
)
945 if (rc
!= PSMOUSE_FULL_PACKET
)
947 psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
951 * Now try to enable mouse. We try to do that even if poll failed and also
952 * repeat our attempts 5 times, otherwise we may be left out with disabled
955 for (i
= 0; i
< 5; i
++) {
956 if (!ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
)) {
964 printk(KERN_WARNING
"psmouse.c: failed to re-enable mouse on %s\n",
965 psmouse
->ps2dev
.serio
->phys
);
970 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
971 printk(KERN_INFO
"psmouse.c: resync failed, issuing reconnect request\n");
972 serio_reconnect(serio
);
974 psmouse_set_state(psmouse
, PSMOUSE_ACTIVATED
);
977 psmouse_activate(parent
);
979 mutex_unlock(&psmouse_mutex
);
983 * psmouse_cleanup() resets the mouse into power-on state.
986 static void psmouse_cleanup(struct serio
*serio
)
988 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
990 psmouse_reset(psmouse
);
994 * psmouse_disconnect() closes and frees.
997 static void psmouse_disconnect(struct serio
*serio
)
999 struct psmouse
*psmouse
, *parent
= NULL
;
1001 psmouse
= serio_get_drvdata(serio
);
1003 sysfs_remove_group(&serio
->dev
.kobj
, &psmouse_attribute_group
);
1005 mutex_lock(&psmouse_mutex
);
1007 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1009 /* make sure we don't have a resync in progress */
1010 mutex_unlock(&psmouse_mutex
);
1011 flush_workqueue(kpsmoused_wq
);
1012 mutex_lock(&psmouse_mutex
);
1014 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1015 parent
= serio_get_drvdata(serio
->parent
);
1016 psmouse_deactivate(parent
);
1019 if (psmouse
->disconnect
)
1020 psmouse
->disconnect(psmouse
);
1022 if (parent
&& parent
->pt_deactivate
)
1023 parent
->pt_deactivate(parent
);
1025 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
1028 serio_set_drvdata(serio
, NULL
);
1029 input_unregister_device(psmouse
->dev
);
1033 psmouse_activate(parent
);
1035 mutex_unlock(&psmouse_mutex
);
1038 static int psmouse_switch_protocol(struct psmouse
*psmouse
, const struct psmouse_protocol
*proto
)
1040 struct input_dev
*input_dev
= psmouse
->dev
;
1042 input_dev
->private = psmouse
;
1043 input_dev
->cdev
.dev
= &psmouse
->ps2dev
.serio
->dev
;
1045 input_dev
->evbit
[0] = BIT(EV_KEY
) | BIT(EV_REL
);
1046 input_dev
->keybit
[LONG(BTN_MOUSE
)] = BIT(BTN_LEFT
) | BIT(BTN_MIDDLE
) | BIT(BTN_RIGHT
);
1047 input_dev
->relbit
[0] = BIT(REL_X
) | BIT(REL_Y
);
1049 psmouse
->set_rate
= psmouse_set_rate
;
1050 psmouse
->set_resolution
= psmouse_set_resolution
;
1051 psmouse
->poll
= psmouse_poll
;
1052 psmouse
->protocol_handler
= psmouse_process_byte
;
1053 psmouse
->pktsize
= 3;
1055 if (proto
&& (proto
->detect
|| proto
->init
)) {
1056 if (proto
->detect
&& proto
->detect(psmouse
, 1) < 0)
1059 if (proto
->init
&& proto
->init(psmouse
) < 0)
1062 psmouse
->type
= proto
->type
;
1065 psmouse
->type
= psmouse_extensions(psmouse
, psmouse_max_proto
, 1);
1068 * If mouse's packet size is 3 there is no point in polling the
1069 * device in hopes to detect protocol reset - we won't get less
1070 * than 3 bytes response anyhow.
1072 if (psmouse
->pktsize
== 3)
1073 psmouse
->resync_time
= 0;
1076 * Some smart KVMs fake response to POLL command returning just
1077 * 3 bytes and messing up our resync logic, so if initial poll
1078 * fails we won't try polling the device anymore. Hopefully
1079 * such KVM will maintain initially selected protocol.
1081 if (psmouse
->resync_time
&& psmouse
->poll(psmouse
))
1082 psmouse
->resync_time
= 0;
1084 snprintf(psmouse
->devname
, sizeof(psmouse
->devname
), "%s %s %s",
1085 psmouse_protocol_by_type(psmouse
->type
)->name
, psmouse
->vendor
, psmouse
->name
);
1087 input_dev
->name
= psmouse
->devname
;
1088 input_dev
->phys
= psmouse
->phys
;
1089 input_dev
->id
.bustype
= BUS_I8042
;
1090 input_dev
->id
.vendor
= 0x0002;
1091 input_dev
->id
.product
= psmouse
->type
;
1092 input_dev
->id
.version
= psmouse
->model
;
1098 * psmouse_connect() is a callback from the serio module when
1099 * an unhandled serio port is found.
1101 static int psmouse_connect(struct serio
*serio
, struct serio_driver
*drv
)
1103 struct psmouse
*psmouse
, *parent
= NULL
;
1104 struct input_dev
*input_dev
;
1105 int retval
= -ENOMEM
;
1107 mutex_lock(&psmouse_mutex
);
1110 * If this is a pass-through port deactivate parent so the device
1111 * connected to this port can be successfully identified
1113 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1114 parent
= serio_get_drvdata(serio
->parent
);
1115 psmouse_deactivate(parent
);
1118 psmouse
= kzalloc(sizeof(struct psmouse
), GFP_KERNEL
);
1119 input_dev
= input_allocate_device();
1120 if (!psmouse
|| !input_dev
)
1123 ps2_init(&psmouse
->ps2dev
, serio
);
1124 INIT_WORK(&psmouse
->resync_work
, psmouse_resync
, psmouse
);
1125 psmouse
->dev
= input_dev
;
1126 snprintf(psmouse
->phys
, sizeof(psmouse
->phys
), "%s/input0", serio
->phys
);
1128 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1130 serio_set_drvdata(serio
, psmouse
);
1132 retval
= serio_open(serio
, drv
);
1136 if (psmouse_probe(psmouse
) < 0) {
1142 psmouse
->rate
= psmouse_rate
;
1143 psmouse
->resolution
= psmouse_resolution
;
1144 psmouse
->resetafter
= psmouse_resetafter
;
1145 psmouse
->resync_time
= parent
? 0 : psmouse_resync_time
;
1146 psmouse
->smartscroll
= psmouse_smartscroll
;
1148 psmouse_switch_protocol(psmouse
, NULL
);
1150 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1151 psmouse_initialize(psmouse
);
1153 input_register_device(psmouse
->dev
);
1155 if (parent
&& parent
->pt_activate
)
1156 parent
->pt_activate(parent
);
1158 sysfs_create_group(&serio
->dev
.kobj
, &psmouse_attribute_group
);
1160 psmouse_activate(psmouse
);
1166 serio_set_drvdata(serio
, NULL
);
1167 input_free_device(input_dev
);
1171 /* If this is a pass-through port the parent needs to be re-activated */
1173 psmouse_activate(parent
);
1175 mutex_unlock(&psmouse_mutex
);
1180 static int psmouse_reconnect(struct serio
*serio
)
1182 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
1183 struct psmouse
*parent
= NULL
;
1184 struct serio_driver
*drv
= serio
->drv
;
1187 if (!drv
|| !psmouse
) {
1188 printk(KERN_DEBUG
"psmouse: reconnect request, but serio is disconnected, ignoring...\n");
1192 mutex_lock(&psmouse_mutex
);
1194 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1195 parent
= serio_get_drvdata(serio
->parent
);
1196 psmouse_deactivate(parent
);
1199 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1201 if (psmouse
->reconnect
) {
1202 if (psmouse
->reconnect(psmouse
))
1204 } else if (psmouse_probe(psmouse
) < 0 ||
1205 psmouse
->type
!= psmouse_extensions(psmouse
, psmouse_max_proto
, 0))
1208 /* ok, the device type (and capabilities) match the old one,
1209 * we can continue using it, complete intialization
1211 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1213 psmouse_initialize(psmouse
);
1215 if (parent
&& parent
->pt_activate
)
1216 parent
->pt_activate(parent
);
1218 psmouse_activate(psmouse
);
1222 /* If this is a pass-through port the parent waits to be activated */
1224 psmouse_activate(parent
);
1226 mutex_unlock(&psmouse_mutex
);
1230 static struct serio_device_id psmouse_serio_ids
[] = {
1238 .type
= SERIO_PS_PSTHRU
,
1246 MODULE_DEVICE_TABLE(serio
, psmouse_serio_ids
);
1248 static struct serio_driver psmouse_drv
= {
1252 .description
= DRIVER_DESC
,
1253 .id_table
= psmouse_serio_ids
,
1254 .interrupt
= psmouse_interrupt
,
1255 .connect
= psmouse_connect
,
1256 .reconnect
= psmouse_reconnect
,
1257 .disconnect
= psmouse_disconnect
,
1258 .cleanup
= psmouse_cleanup
,
1261 ssize_t
psmouse_attr_show_helper(struct device
*dev
, struct device_attribute
*devattr
,
1264 struct serio
*serio
= to_serio_port(dev
);
1265 struct psmouse_attribute
*attr
= to_psmouse_attr(devattr
);
1266 struct psmouse
*psmouse
;
1269 retval
= serio_pin_driver(serio
);
1273 if (serio
->drv
!= &psmouse_drv
) {
1278 psmouse
= serio_get_drvdata(serio
);
1280 retval
= attr
->show(psmouse
, attr
->data
, buf
);
1283 serio_unpin_driver(serio
);
1287 ssize_t
psmouse_attr_set_helper(struct device
*dev
, struct device_attribute
*devattr
,
1288 const char *buf
, size_t count
)
1290 struct serio
*serio
= to_serio_port(dev
);
1291 struct psmouse_attribute
*attr
= to_psmouse_attr(devattr
);
1292 struct psmouse
*psmouse
, *parent
= NULL
;
1295 retval
= serio_pin_driver(serio
);
1299 if (serio
->drv
!= &psmouse_drv
) {
1304 retval
= mutex_lock_interruptible(&psmouse_mutex
);
1308 psmouse
= serio_get_drvdata(serio
);
1310 if (psmouse
->state
== PSMOUSE_IGNORE
) {
1315 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1316 parent
= serio_get_drvdata(serio
->parent
);
1317 psmouse_deactivate(parent
);
1320 psmouse_deactivate(psmouse
);
1322 retval
= attr
->set(psmouse
, attr
->data
, buf
, count
);
1324 if (retval
!= -ENODEV
)
1325 psmouse_activate(psmouse
);
1328 psmouse_activate(parent
);
1331 mutex_unlock(&psmouse_mutex
);
1333 serio_unpin_driver(serio
);
1337 static ssize_t
psmouse_show_int_attr(struct psmouse
*psmouse
, void *offset
, char *buf
)
1339 unsigned long *field
= (unsigned long *)((char *)psmouse
+ (size_t)offset
);
1341 return sprintf(buf
, "%lu\n", *field
);
1344 static ssize_t
psmouse_set_int_attr(struct psmouse
*psmouse
, void *offset
, const char *buf
, size_t count
)
1346 unsigned long *field
= (unsigned long *)((char *)psmouse
+ (size_t)offset
);
1347 unsigned long value
;
1350 value
= simple_strtoul(buf
, &rest
, 10);
1359 static ssize_t
psmouse_attr_show_protocol(struct psmouse
*psmouse
, void *data
, char *buf
)
1361 return sprintf(buf
, "%s\n", psmouse_protocol_by_type(psmouse
->type
)->name
);
1364 static ssize_t
psmouse_attr_set_protocol(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1366 struct serio
*serio
= psmouse
->ps2dev
.serio
;
1367 struct psmouse
*parent
= NULL
;
1368 struct input_dev
*new_dev
;
1369 const struct psmouse_protocol
*proto
;
1372 if (!(proto
= psmouse_protocol_by_name(buf
, count
)))
1375 if (psmouse
->type
== proto
->type
)
1378 if (!(new_dev
= input_allocate_device()))
1381 while (serio
->child
) {
1383 printk(KERN_WARNING
"psmouse: failed to destroy child port, protocol change aborted.\n");
1384 input_free_device(new_dev
);
1388 mutex_unlock(&psmouse_mutex
);
1389 serio_unpin_driver(serio
);
1390 serio_unregister_child_port(serio
);
1391 serio_pin_driver_uninterruptible(serio
);
1392 mutex_lock(&psmouse_mutex
);
1394 if (serio
->drv
!= &psmouse_drv
) {
1395 input_free_device(new_dev
);
1399 if (psmouse
->type
== proto
->type
) {
1400 input_free_device(new_dev
);
1401 return count
; /* switched by other thread */
1405 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1406 parent
= serio_get_drvdata(serio
->parent
);
1407 if (parent
->pt_deactivate
)
1408 parent
->pt_deactivate(parent
);
1411 if (psmouse
->disconnect
)
1412 psmouse
->disconnect(psmouse
);
1414 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
1415 input_unregister_device(psmouse
->dev
);
1417 psmouse
->dev
= new_dev
;
1418 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1420 if (psmouse_switch_protocol(psmouse
, proto
) < 0) {
1421 psmouse_reset(psmouse
);
1422 /* default to PSMOUSE_PS2 */
1423 psmouse_switch_protocol(psmouse
, &psmouse_protocols
[0]);
1426 psmouse_initialize(psmouse
);
1427 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1429 input_register_device(psmouse
->dev
);
1431 if (parent
&& parent
->pt_activate
)
1432 parent
->pt_activate(parent
);
1437 static ssize_t
psmouse_attr_set_rate(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1439 unsigned long value
;
1442 value
= simple_strtoul(buf
, &rest
, 10);
1446 psmouse
->set_rate(psmouse
, value
);
1450 static ssize_t
psmouse_attr_set_resolution(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1452 unsigned long value
;
1455 value
= simple_strtoul(buf
, &rest
, 10);
1459 psmouse
->set_resolution(psmouse
, value
);
1464 static int psmouse_set_maxproto(const char *val
, struct kernel_param
*kp
)
1466 const struct psmouse_protocol
*proto
;
1471 proto
= psmouse_protocol_by_name(val
, strlen(val
));
1473 if (!proto
|| !proto
->maxproto
)
1476 *((unsigned int *)kp
->arg
) = proto
->type
;
1481 static int psmouse_get_maxproto(char *buffer
, struct kernel_param
*kp
)
1483 int type
= *((unsigned int *)kp
->arg
);
1485 return sprintf(buffer
, "%s\n", psmouse_protocol_by_type(type
)->name
);
1488 static int __init
psmouse_init(void)
1490 kpsmoused_wq
= create_singlethread_workqueue("kpsmoused");
1491 if (!kpsmoused_wq
) {
1492 printk(KERN_ERR
"psmouse: failed to create kpsmoused workqueue\n");
1496 serio_register_driver(&psmouse_drv
);
1501 static void __exit
psmouse_exit(void)
1503 serio_unregister_driver(&psmouse_drv
);
1504 destroy_workqueue(kpsmoused_wq
);
1507 module_init(psmouse_init
);
1508 module_exit(psmouse_exit
);