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 input_report_rel(dev
, REL_WHEEL
, (int) (packet
[3] & 8) - (int) (packet
[3] & 7));
154 input_report_key(dev
, BTN_SIDE
, (packet
[3] >> 4) & 1);
155 input_report_key(dev
, BTN_EXTRA
, (packet
[3] >> 5) & 1);
159 * Extra buttons on Genius NewNet 3D
162 if (psmouse
->type
== PSMOUSE_GENPS
) {
163 input_report_key(dev
, BTN_SIDE
, (packet
[0] >> 6) & 1);
164 input_report_key(dev
, BTN_EXTRA
, (packet
[0] >> 7) & 1);
168 * Extra button on ThinkingMouse
170 if (psmouse
->type
== PSMOUSE_THINKPS
) {
171 input_report_key(dev
, BTN_EXTRA
, (packet
[0] >> 3) & 1);
172 /* Without this bit of weirdness moving up gives wildly high Y changes. */
173 packet
[1] |= (packet
[0] & 0x40) << 1;
180 input_report_key(dev
, BTN_LEFT
, packet
[0] & 1);
181 input_report_key(dev
, BTN_MIDDLE
, (packet
[0] >> 2) & 1);
182 input_report_key(dev
, BTN_RIGHT
, (packet
[0] >> 1) & 1);
184 input_report_rel(dev
, REL_X
, packet
[1] ? (int) packet
[1] - (int) ((packet
[0] << 4) & 0x100) : 0);
185 input_report_rel(dev
, REL_Y
, packet
[2] ? (int) ((packet
[0] << 3) & 0x100) - (int) packet
[2] : 0);
189 return PSMOUSE_FULL_PACKET
;
193 * __psmouse_set_state() sets new psmouse state and resets all flags.
196 static inline void __psmouse_set_state(struct psmouse
*psmouse
, enum psmouse_state new_state
)
198 psmouse
->state
= new_state
;
199 psmouse
->pktcnt
= psmouse
->out_of_sync
= 0;
200 psmouse
->ps2dev
.flags
= 0;
201 psmouse
->last
= jiffies
;
206 * psmouse_set_state() sets new psmouse state and resets all flags and
207 * counters while holding serio lock so fighting with interrupt handler
211 static void psmouse_set_state(struct psmouse
*psmouse
, enum psmouse_state new_state
)
213 serio_pause_rx(psmouse
->ps2dev
.serio
);
214 __psmouse_set_state(psmouse
, new_state
);
215 serio_continue_rx(psmouse
->ps2dev
.serio
);
219 * psmouse_handle_byte() processes one byte of the input data stream
220 * by calling corresponding protocol handler.
223 static int psmouse_handle_byte(struct psmouse
*psmouse
, struct pt_regs
*regs
)
225 psmouse_ret_t rc
= psmouse
->protocol_handler(psmouse
, regs
);
228 case PSMOUSE_BAD_DATA
:
229 if (psmouse
->state
== PSMOUSE_ACTIVATED
) {
230 printk(KERN_WARNING
"psmouse.c: %s at %s lost sync at byte %d\n",
231 psmouse
->name
, psmouse
->phys
, psmouse
->pktcnt
);
232 if (++psmouse
->out_of_sync
== psmouse
->resetafter
) {
233 __psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
234 printk(KERN_NOTICE
"psmouse.c: issuing reconnect request\n");
235 serio_reconnect(psmouse
->ps2dev
.serio
);
242 case PSMOUSE_FULL_PACKET
:
244 if (psmouse
->out_of_sync
) {
245 psmouse
->out_of_sync
= 0;
246 printk(KERN_NOTICE
"psmouse.c: %s at %s - driver resynched.\n",
247 psmouse
->name
, psmouse
->phys
);
251 case PSMOUSE_GOOD_DATA
:
258 * psmouse_interrupt() handles incoming characters, either passing them
259 * for normal processing or gathering them as command response.
262 static irqreturn_t
psmouse_interrupt(struct serio
*serio
,
263 unsigned char data
, unsigned int flags
, struct pt_regs
*regs
)
265 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
267 if (psmouse
->state
== PSMOUSE_IGNORE
)
270 if (flags
& (SERIO_PARITY
|SERIO_TIMEOUT
)) {
271 if (psmouse
->state
== PSMOUSE_ACTIVATED
)
272 printk(KERN_WARNING
"psmouse.c: bad data from KBC -%s%s\n",
273 flags
& SERIO_TIMEOUT
? " timeout" : "",
274 flags
& SERIO_PARITY
? " bad parity" : "");
275 ps2_cmd_aborted(&psmouse
->ps2dev
);
279 if (unlikely(psmouse
->ps2dev
.flags
& PS2_FLAG_ACK
))
280 if (ps2_handle_ack(&psmouse
->ps2dev
, data
))
283 if (unlikely(psmouse
->ps2dev
.flags
& PS2_FLAG_CMD
))
284 if (ps2_handle_response(&psmouse
->ps2dev
, data
))
287 if (psmouse
->state
<= PSMOUSE_RESYNCING
)
290 if (psmouse
->state
== PSMOUSE_ACTIVATED
&&
291 psmouse
->pktcnt
&& time_after(jiffies
, psmouse
->last
+ HZ
/2)) {
292 printk(KERN_INFO
"psmouse.c: %s at %s lost synchronization, throwing %d bytes away.\n",
293 psmouse
->name
, psmouse
->phys
, psmouse
->pktcnt
);
294 psmouse
->badbyte
= psmouse
->packet
[0];
295 __psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
296 queue_work(kpsmoused_wq
, &psmouse
->resync_work
);
300 psmouse
->packet
[psmouse
->pktcnt
++] = data
;
302 * Check if this is a new device announcement (0xAA 0x00)
304 if (unlikely(psmouse
->packet
[0] == PSMOUSE_RET_BAT
&& psmouse
->pktcnt
<= 2)) {
305 if (psmouse
->pktcnt
== 1)
308 if (psmouse
->packet
[1] == PSMOUSE_RET_ID
) {
309 __psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
310 serio_reconnect(serio
);
314 * Not a new device, try processing first byte normally
317 if (psmouse_handle_byte(psmouse
, regs
))
320 psmouse
->packet
[psmouse
->pktcnt
++] = data
;
324 * See if we need to force resync because mouse was idle for too long
326 if (psmouse
->state
== PSMOUSE_ACTIVATED
&&
327 psmouse
->pktcnt
== 1 && psmouse
->resync_time
&&
328 time_after(jiffies
, psmouse
->last
+ psmouse
->resync_time
* HZ
)) {
329 psmouse
->badbyte
= psmouse
->packet
[0];
330 __psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
331 queue_work(kpsmoused_wq
, &psmouse
->resync_work
);
335 psmouse
->last
= jiffies
;
336 psmouse_handle_byte(psmouse
, regs
);
344 * psmouse_sliced_command() sends an extended PS/2 command to the mouse
345 * using sliced syntax, understood by advanced devices, such as Logitech
346 * or Synaptics touchpads. The command is encoded as:
347 * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
350 int psmouse_sliced_command(struct psmouse
*psmouse
, unsigned char command
)
354 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
))
357 for (i
= 6; i
>= 0; i
-= 2) {
358 unsigned char d
= (command
>> i
) & 3;
359 if (ps2_command(&psmouse
->ps2dev
, &d
, PSMOUSE_CMD_SETRES
))
368 * psmouse_reset() resets the mouse into power-on state.
370 int psmouse_reset(struct psmouse
*psmouse
)
372 unsigned char param
[2];
374 if (ps2_command(&psmouse
->ps2dev
, param
, PSMOUSE_CMD_RESET_BAT
))
377 if (param
[0] != PSMOUSE_RET_BAT
&& param
[1] != PSMOUSE_RET_ID
)
385 * Genius NetMouse magic init.
387 static int genius_detect(struct psmouse
*psmouse
, int set_properties
)
389 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
390 unsigned char param
[4];
393 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
);
394 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
395 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
396 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
397 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
);
399 if (param
[0] != 0x00 || param
[1] != 0x33 || param
[2] != 0x55)
402 if (set_properties
) {
403 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
404 set_bit(BTN_SIDE
, psmouse
->dev
->keybit
);
405 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
407 psmouse
->vendor
= "Genius";
408 psmouse
->name
= "Mouse";
409 psmouse
->pktsize
= 4;
416 * IntelliMouse magic init.
418 static int intellimouse_detect(struct psmouse
*psmouse
, int set_properties
)
420 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
421 unsigned char param
[2];
424 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
426 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
428 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
429 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
434 if (set_properties
) {
435 set_bit(BTN_MIDDLE
, psmouse
->dev
->keybit
);
436 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
438 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
439 if (!psmouse
->name
) psmouse
->name
= "Wheel Mouse";
440 psmouse
->pktsize
= 4;
447 * Try IntelliMouse/Explorer magic init.
449 static int im_explorer_detect(struct psmouse
*psmouse
, int set_properties
)
451 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
452 unsigned char param
[2];
454 intellimouse_detect(psmouse
, 0);
457 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
459 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
461 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
462 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
467 if (set_properties
) {
468 set_bit(BTN_MIDDLE
, psmouse
->dev
->keybit
);
469 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
470 set_bit(BTN_SIDE
, psmouse
->dev
->keybit
);
471 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
473 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
474 if (!psmouse
->name
) psmouse
->name
= "Explorer Mouse";
475 psmouse
->pktsize
= 4;
482 * Kensington ThinkingMouse / ExpertMouse magic init.
484 static int thinking_detect(struct psmouse
*psmouse
, int set_properties
)
486 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
487 unsigned char param
[2];
488 unsigned char seq
[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20, 0 };
492 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
494 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
);
495 for (i
= 0; seq
[i
]; i
++)
496 ps2_command(ps2dev
, seq
+ i
, PSMOUSE_CMD_SETRATE
);
497 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
502 if (set_properties
) {
503 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
505 psmouse
->vendor
= "Kensington";
506 psmouse
->name
= "ThinkingMouse";
513 * Bare PS/2 protocol "detection". Always succeeds.
515 static int ps2bare_detect(struct psmouse
*psmouse
, int set_properties
)
517 if (set_properties
) {
518 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
519 if (!psmouse
->name
) psmouse
->name
= "Mouse";
527 * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
528 * the mouse may have.
531 static int psmouse_extensions(struct psmouse
*psmouse
,
532 unsigned int max_proto
, int set_properties
)
534 int synaptics_hardware
= 0;
537 * We always check for lifebook because it does not disturb mouse
538 * (it only checks DMI information).
540 if (lifebook_detect(psmouse
, set_properties
) == 0) {
541 if (max_proto
> PSMOUSE_IMEX
) {
542 if (!set_properties
|| lifebook_init(psmouse
) == 0)
543 return PSMOUSE_LIFEBOOK
;
548 * Try Kensington ThinkingMouse (we try first, because synaptics probe
549 * upsets the thinkingmouse).
552 if (max_proto
> PSMOUSE_IMEX
&& thinking_detect(psmouse
, set_properties
) == 0)
553 return PSMOUSE_THINKPS
;
556 * Try Synaptics TouchPad
558 if (max_proto
> PSMOUSE_PS2
&& synaptics_detect(psmouse
, set_properties
) == 0) {
559 synaptics_hardware
= 1;
561 if (max_proto
> PSMOUSE_IMEX
) {
562 if (!set_properties
|| synaptics_init(psmouse
) == 0)
563 return PSMOUSE_SYNAPTICS
;
565 * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
566 * Unfortunately Logitech/Genius probes confuse some firmware versions so
567 * we'll have to skip them.
569 max_proto
= PSMOUSE_IMEX
;
572 * Make sure that touchpad is in relative mode, gestures (taps) are enabled
574 synaptics_reset(psmouse
);
580 if (max_proto
> PSMOUSE_IMEX
) {
581 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
);
582 if (alps_detect(psmouse
, set_properties
) == 0) {
583 if (!set_properties
|| alps_init(psmouse
) == 0)
586 * Init failed, try basic relative protocols
588 max_proto
= PSMOUSE_IMEX
;
592 if (max_proto
> PSMOUSE_IMEX
&& genius_detect(psmouse
, set_properties
) == 0)
593 return PSMOUSE_GENPS
;
595 if (max_proto
> PSMOUSE_IMEX
&& ps2pp_init(psmouse
, set_properties
) == 0)
596 return PSMOUSE_PS2PP
;
598 if (max_proto
> PSMOUSE_IMEX
&& trackpoint_detect(psmouse
, set_properties
) == 0)
599 return PSMOUSE_TRACKPOINT
;
602 * Reset to defaults in case the device got confused by extended
603 * protocol probes. Note that we do full reset becuase some mice
604 * put themselves to sleep when see PSMOUSE_RESET_DIS.
606 psmouse_reset(psmouse
);
608 if (max_proto
>= PSMOUSE_IMEX
&& im_explorer_detect(psmouse
, set_properties
) == 0)
611 if (max_proto
>= PSMOUSE_IMPS
&& intellimouse_detect(psmouse
, set_properties
) == 0)
615 * Okay, all failed, we have a standard mouse here. The number of the buttons
616 * is still a question, though. We assume 3.
618 ps2bare_detect(psmouse
, set_properties
);
620 if (synaptics_hardware
) {
622 * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
623 * We need to reset the touchpad because if there is a track point on the
624 * pass through port it could get disabled while probing for protocol
627 psmouse_reset(psmouse
);
633 static struct psmouse_protocol psmouse_protocols
[] = {
639 .detect
= ps2bare_detect
,
642 .type
= PSMOUSE_PS2PP
,
645 .detect
= ps2pp_init
,
648 .type
= PSMOUSE_THINKPS
,
651 .detect
= thinking_detect
,
654 .type
= PSMOUSE_GENPS
,
657 .detect
= genius_detect
,
660 .type
= PSMOUSE_IMPS
,
664 .detect
= intellimouse_detect
,
667 .type
= PSMOUSE_IMEX
,
671 .detect
= im_explorer_detect
,
674 .type
= PSMOUSE_SYNAPTICS
,
676 .alias
= "synaptics",
677 .detect
= synaptics_detect
,
678 .init
= synaptics_init
,
681 .type
= PSMOUSE_ALPS
,
684 .detect
= alps_detect
,
688 .type
= PSMOUSE_LIFEBOOK
,
691 .init
= lifebook_init
,
694 .type
= PSMOUSE_TRACKPOINT
,
696 .alias
= "trackpoint",
697 .detect
= trackpoint_detect
,
700 .type
= PSMOUSE_AUTO
,
707 static struct psmouse_protocol
*psmouse_protocol_by_type(enum psmouse_type type
)
711 for (i
= 0; i
< ARRAY_SIZE(psmouse_protocols
); i
++)
712 if (psmouse_protocols
[i
].type
== type
)
713 return &psmouse_protocols
[i
];
716 return &psmouse_protocols
[0];
719 static struct psmouse_protocol
*psmouse_protocol_by_name(const char *name
, size_t len
)
721 struct psmouse_protocol
*p
;
724 for (i
= 0; i
< ARRAY_SIZE(psmouse_protocols
); i
++) {
725 p
= &psmouse_protocols
[i
];
727 if ((strlen(p
->name
) == len
&& !strncmp(p
->name
, name
, len
)) ||
728 (strlen(p
->alias
) == len
&& !strncmp(p
->alias
, name
, len
)))
729 return &psmouse_protocols
[i
];
737 * psmouse_probe() probes for a PS/2 mouse.
740 static int psmouse_probe(struct psmouse
*psmouse
)
742 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
743 unsigned char param
[2];
746 * First, we check if it's a mouse. It should send 0x00 or 0x03
747 * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
748 * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
749 * ID queries, probably due to a firmware bug.
753 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
))
756 if (param
[0] != 0x00 && param
[0] != 0x03 &&
757 param
[0] != 0x04 && param
[0] != 0xff)
761 * Then we reset and disable the mouse so that it doesn't generate events.
764 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
))
765 printk(KERN_WARNING
"psmouse.c: Failed to reset mouse on %s\n", ps2dev
->serio
->phys
);
771 * Here we set the mouse resolution.
774 void psmouse_set_resolution(struct psmouse
*psmouse
, unsigned int resolution
)
776 unsigned char params
[] = { 0, 1, 2, 2, 3 };
778 if (resolution
== 0 || resolution
> 200)
781 ps2_command(&psmouse
->ps2dev
, ¶ms
[resolution
/ 50], PSMOUSE_CMD_SETRES
);
782 psmouse
->resolution
= 25 << params
[resolution
/ 50];
786 * Here we set the mouse report rate.
789 static void psmouse_set_rate(struct psmouse
*psmouse
, unsigned int rate
)
791 unsigned char rates
[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
794 while (rates
[i
] > rate
) i
++;
795 ps2_command(&psmouse
->ps2dev
, &rates
[i
], PSMOUSE_CMD_SETRATE
);
796 psmouse
->rate
= rates
[i
];
800 * psmouse_initialize() initializes the mouse to a sane state.
803 static void psmouse_initialize(struct psmouse
*psmouse
)
806 * We set the mouse into streaming mode.
809 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSTREAM
);
812 * We set the mouse report rate, resolution and scaling.
815 if (psmouse_max_proto
!= PSMOUSE_PS2
) {
816 psmouse
->set_rate(psmouse
, psmouse
->rate
);
817 psmouse
->set_resolution(psmouse
, psmouse
->resolution
);
818 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
823 * psmouse_activate() enables the mouse so that we get motion reports from it.
826 static void psmouse_activate(struct psmouse
*psmouse
)
828 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
))
829 printk(KERN_WARNING
"psmouse.c: Failed to enable mouse on %s\n",
830 psmouse
->ps2dev
.serio
->phys
);
832 psmouse_set_state(psmouse
, PSMOUSE_ACTIVATED
);
837 * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
838 * reports from it unless we explicitely request it.
841 static void psmouse_deactivate(struct psmouse
*psmouse
)
843 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
))
844 printk(KERN_WARNING
"psmouse.c: Failed to deactivate mouse on %s\n",
845 psmouse
->ps2dev
.serio
->phys
);
847 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
851 * psmouse_poll() - default poll hanlder. Everyone except for ALPS uses it.
854 static int psmouse_poll(struct psmouse
*psmouse
)
856 return ps2_command(&psmouse
->ps2dev
, psmouse
->packet
,
857 PSMOUSE_CMD_POLL
| (psmouse
->pktsize
<< 8));
862 * psmouse_resync() attempts to re-validate current protocol.
865 static void psmouse_resync(void *p
)
867 struct psmouse
*psmouse
= p
, *parent
= NULL
;
868 struct serio
*serio
= psmouse
->ps2dev
.serio
;
869 psmouse_ret_t rc
= PSMOUSE_GOOD_DATA
;
870 int failed
= 0, enabled
= 0;
873 mutex_lock(&psmouse_mutex
);
875 if (psmouse
->state
!= PSMOUSE_RESYNCING
)
878 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
879 parent
= serio_get_drvdata(serio
->parent
);
880 psmouse_deactivate(parent
);
884 * Some mice don't ACK commands sent while they are in the middle of
885 * transmitting motion packet. To avoid delay we use ps2_sendbyte()
886 * instead of ps2_command() which would wait for 200ms for an ACK
887 * that may never come.
888 * As an additional quirk ALPS touchpads may not only forget to ACK
889 * disable command but will stop reporting taps, so if we see that
890 * mouse at least once ACKs disable we will do full reconnect if ACK
893 psmouse
->num_resyncs
++;
895 if (ps2_sendbyte(&psmouse
->ps2dev
, PSMOUSE_CMD_DISABLE
, 20)) {
896 if (psmouse
->num_resyncs
< 3 || psmouse
->acks_disable_command
)
899 psmouse
->acks_disable_command
= 1;
902 * Poll the mouse. If it was reset the packet will be shorter than
903 * psmouse->pktsize and ps2_command will fail. We do not expect and
904 * do not handle scenario when mouse "upgrades" its protocol while
905 * disconnected since it would require additional delay. If we ever
906 * see a mouse that does it we'll adjust the code.
909 if (psmouse
->poll(psmouse
))
912 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
913 for (i
= 0; i
< psmouse
->pktsize
; i
++) {
915 rc
= psmouse
->protocol_handler(psmouse
, NULL
);
916 if (rc
!= PSMOUSE_GOOD_DATA
)
919 if (rc
!= PSMOUSE_FULL_PACKET
)
921 psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
925 * Now try to enable mouse. We try to do that even if poll failed and also
926 * repeat our attempts 5 times, otherwise we may be left out with disabled
929 for (i
= 0; i
< 5; i
++) {
930 if (!ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
)) {
938 printk(KERN_WARNING
"psmouse.c: failed to re-enable mouse on %s\n",
939 psmouse
->ps2dev
.serio
->phys
);
944 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
945 printk(KERN_INFO
"psmouse.c: resync failed, issuing reconnect request\n");
946 serio_reconnect(serio
);
948 psmouse_set_state(psmouse
, PSMOUSE_ACTIVATED
);
951 psmouse_activate(parent
);
953 mutex_unlock(&psmouse_mutex
);
957 * psmouse_cleanup() resets the mouse into power-on state.
960 static void psmouse_cleanup(struct serio
*serio
)
962 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
964 psmouse_reset(psmouse
);
968 * psmouse_disconnect() closes and frees.
971 static void psmouse_disconnect(struct serio
*serio
)
973 struct psmouse
*psmouse
, *parent
= NULL
;
975 psmouse
= serio_get_drvdata(serio
);
977 sysfs_remove_group(&serio
->dev
.kobj
, &psmouse_attribute_group
);
979 mutex_lock(&psmouse_mutex
);
981 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
983 /* make sure we don't have a resync in progress */
984 mutex_unlock(&psmouse_mutex
);
985 flush_workqueue(kpsmoused_wq
);
986 mutex_lock(&psmouse_mutex
);
988 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
989 parent
= serio_get_drvdata(serio
->parent
);
990 psmouse_deactivate(parent
);
993 if (psmouse
->disconnect
)
994 psmouse
->disconnect(psmouse
);
996 if (parent
&& parent
->pt_deactivate
)
997 parent
->pt_deactivate(parent
);
999 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
1002 serio_set_drvdata(serio
, NULL
);
1003 input_unregister_device(psmouse
->dev
);
1007 psmouse_activate(parent
);
1009 mutex_unlock(&psmouse_mutex
);
1012 static int psmouse_switch_protocol(struct psmouse
*psmouse
, struct psmouse_protocol
*proto
)
1014 struct input_dev
*input_dev
= psmouse
->dev
;
1016 input_dev
->private = psmouse
;
1017 input_dev
->cdev
.dev
= &psmouse
->ps2dev
.serio
->dev
;
1019 input_dev
->evbit
[0] = BIT(EV_KEY
) | BIT(EV_REL
);
1020 input_dev
->keybit
[LONG(BTN_MOUSE
)] = BIT(BTN_LEFT
) | BIT(BTN_MIDDLE
) | BIT(BTN_RIGHT
);
1021 input_dev
->relbit
[0] = BIT(REL_X
) | BIT(REL_Y
);
1023 psmouse
->set_rate
= psmouse_set_rate
;
1024 psmouse
->set_resolution
= psmouse_set_resolution
;
1025 psmouse
->poll
= psmouse_poll
;
1026 psmouse
->protocol_handler
= psmouse_process_byte
;
1027 psmouse
->pktsize
= 3;
1029 if (proto
&& (proto
->detect
|| proto
->init
)) {
1030 if (proto
->detect
&& proto
->detect(psmouse
, 1) < 0)
1033 if (proto
->init
&& proto
->init(psmouse
) < 0)
1036 psmouse
->type
= proto
->type
;
1039 psmouse
->type
= psmouse_extensions(psmouse
, psmouse_max_proto
, 1);
1042 * If mouse's packet size is 3 there is no point in polling the
1043 * device in hopes to detect protocol reset - we won't get less
1044 * than 3 bytes response anyhow.
1046 if (psmouse
->pktsize
== 3)
1047 psmouse
->resync_time
= 0;
1050 * Some smart KVMs fake response to POLL command returning just
1051 * 3 bytes and messing up our resync logic, so if initial poll
1052 * fails we won't try polling the device anymore. Hopefully
1053 * such KVM will maintain initially selected protocol.
1055 if (psmouse
->resync_time
&& psmouse
->poll(psmouse
))
1056 psmouse
->resync_time
= 0;
1058 sprintf(psmouse
->devname
, "%s %s %s",
1059 psmouse_protocol_by_type(psmouse
->type
)->name
, psmouse
->vendor
, psmouse
->name
);
1061 input_dev
->name
= psmouse
->devname
;
1062 input_dev
->phys
= psmouse
->phys
;
1063 input_dev
->id
.bustype
= BUS_I8042
;
1064 input_dev
->id
.vendor
= 0x0002;
1065 input_dev
->id
.product
= psmouse
->type
;
1066 input_dev
->id
.version
= psmouse
->model
;
1072 * psmouse_connect() is a callback from the serio module when
1073 * an unhandled serio port is found.
1075 static int psmouse_connect(struct serio
*serio
, struct serio_driver
*drv
)
1077 struct psmouse
*psmouse
, *parent
= NULL
;
1078 struct input_dev
*input_dev
;
1079 int retval
= -ENOMEM
;
1081 mutex_lock(&psmouse_mutex
);
1084 * If this is a pass-through port deactivate parent so the device
1085 * connected to this port can be successfully identified
1087 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1088 parent
= serio_get_drvdata(serio
->parent
);
1089 psmouse_deactivate(parent
);
1092 psmouse
= kzalloc(sizeof(struct psmouse
), GFP_KERNEL
);
1093 input_dev
= input_allocate_device();
1094 if (!psmouse
|| !input_dev
)
1097 ps2_init(&psmouse
->ps2dev
, serio
);
1098 INIT_WORK(&psmouse
->resync_work
, psmouse_resync
, psmouse
);
1099 psmouse
->dev
= input_dev
;
1100 sprintf(psmouse
->phys
, "%s/input0", serio
->phys
);
1102 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1104 serio_set_drvdata(serio
, psmouse
);
1106 retval
= serio_open(serio
, drv
);
1110 if (psmouse_probe(psmouse
) < 0) {
1116 psmouse
->rate
= psmouse_rate
;
1117 psmouse
->resolution
= psmouse_resolution
;
1118 psmouse
->resetafter
= psmouse_resetafter
;
1119 psmouse
->resync_time
= parent
? 0 : psmouse_resync_time
;
1120 psmouse
->smartscroll
= psmouse_smartscroll
;
1122 psmouse_switch_protocol(psmouse
, NULL
);
1124 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1125 psmouse_initialize(psmouse
);
1127 input_register_device(psmouse
->dev
);
1129 if (parent
&& parent
->pt_activate
)
1130 parent
->pt_activate(parent
);
1132 sysfs_create_group(&serio
->dev
.kobj
, &psmouse_attribute_group
);
1134 psmouse_activate(psmouse
);
1140 serio_set_drvdata(serio
, NULL
);
1141 input_free_device(input_dev
);
1145 /* If this is a pass-through port the parent needs to be re-activated */
1147 psmouse_activate(parent
);
1149 mutex_unlock(&psmouse_mutex
);
1154 static int psmouse_reconnect(struct serio
*serio
)
1156 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
1157 struct psmouse
*parent
= NULL
;
1158 struct serio_driver
*drv
= serio
->drv
;
1161 if (!drv
|| !psmouse
) {
1162 printk(KERN_DEBUG
"psmouse: reconnect request, but serio is disconnected, ignoring...\n");
1166 mutex_lock(&psmouse_mutex
);
1168 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1169 parent
= serio_get_drvdata(serio
->parent
);
1170 psmouse_deactivate(parent
);
1173 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1175 if (psmouse
->reconnect
) {
1176 if (psmouse
->reconnect(psmouse
))
1178 } else if (psmouse_probe(psmouse
) < 0 ||
1179 psmouse
->type
!= psmouse_extensions(psmouse
, psmouse_max_proto
, 0))
1182 /* ok, the device type (and capabilities) match the old one,
1183 * we can continue using it, complete intialization
1185 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1187 psmouse_initialize(psmouse
);
1189 if (parent
&& parent
->pt_activate
)
1190 parent
->pt_activate(parent
);
1192 psmouse_activate(psmouse
);
1196 /* If this is a pass-through port the parent waits to be activated */
1198 psmouse_activate(parent
);
1200 mutex_unlock(&psmouse_mutex
);
1204 static struct serio_device_id psmouse_serio_ids
[] = {
1212 .type
= SERIO_PS_PSTHRU
,
1220 MODULE_DEVICE_TABLE(serio
, psmouse_serio_ids
);
1222 static struct serio_driver psmouse_drv
= {
1226 .description
= DRIVER_DESC
,
1227 .id_table
= psmouse_serio_ids
,
1228 .interrupt
= psmouse_interrupt
,
1229 .connect
= psmouse_connect
,
1230 .reconnect
= psmouse_reconnect
,
1231 .disconnect
= psmouse_disconnect
,
1232 .cleanup
= psmouse_cleanup
,
1235 ssize_t
psmouse_attr_show_helper(struct device
*dev
, struct device_attribute
*devattr
,
1238 struct serio
*serio
= to_serio_port(dev
);
1239 struct psmouse_attribute
*attr
= to_psmouse_attr(devattr
);
1240 struct psmouse
*psmouse
;
1243 retval
= serio_pin_driver(serio
);
1247 if (serio
->drv
!= &psmouse_drv
) {
1252 psmouse
= serio_get_drvdata(serio
);
1254 retval
= attr
->show(psmouse
, attr
->data
, buf
);
1257 serio_unpin_driver(serio
);
1261 ssize_t
psmouse_attr_set_helper(struct device
*dev
, struct device_attribute
*devattr
,
1262 const char *buf
, size_t count
)
1264 struct serio
*serio
= to_serio_port(dev
);
1265 struct psmouse_attribute
*attr
= to_psmouse_attr(devattr
);
1266 struct psmouse
*psmouse
, *parent
= NULL
;
1269 retval
= serio_pin_driver(serio
);
1273 if (serio
->drv
!= &psmouse_drv
) {
1278 retval
= mutex_lock_interruptible(&psmouse_mutex
);
1282 psmouse
= serio_get_drvdata(serio
);
1284 if (psmouse
->state
== PSMOUSE_IGNORE
) {
1289 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1290 parent
= serio_get_drvdata(serio
->parent
);
1291 psmouse_deactivate(parent
);
1294 psmouse_deactivate(psmouse
);
1296 retval
= attr
->set(psmouse
, attr
->data
, buf
, count
);
1298 if (retval
!= -ENODEV
)
1299 psmouse_activate(psmouse
);
1302 psmouse_activate(parent
);
1305 mutex_unlock(&psmouse_mutex
);
1307 serio_unpin_driver(serio
);
1311 static ssize_t
psmouse_show_int_attr(struct psmouse
*psmouse
, void *offset
, char *buf
)
1313 unsigned long *field
= (unsigned long *)((char *)psmouse
+ (size_t)offset
);
1315 return sprintf(buf
, "%lu\n", *field
);
1318 static ssize_t
psmouse_set_int_attr(struct psmouse
*psmouse
, void *offset
, const char *buf
, size_t count
)
1320 unsigned long *field
= (unsigned long *)((char *)psmouse
+ (size_t)offset
);
1321 unsigned long value
;
1324 value
= simple_strtoul(buf
, &rest
, 10);
1333 static ssize_t
psmouse_attr_show_protocol(struct psmouse
*psmouse
, void *data
, char *buf
)
1335 return sprintf(buf
, "%s\n", psmouse_protocol_by_type(psmouse
->type
)->name
);
1338 static ssize_t
psmouse_attr_set_protocol(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1340 struct serio
*serio
= psmouse
->ps2dev
.serio
;
1341 struct psmouse
*parent
= NULL
;
1342 struct input_dev
*new_dev
;
1343 struct psmouse_protocol
*proto
;
1346 if (!(proto
= psmouse_protocol_by_name(buf
, count
)))
1349 if (psmouse
->type
== proto
->type
)
1352 if (!(new_dev
= input_allocate_device()))
1355 while (serio
->child
) {
1357 printk(KERN_WARNING
"psmouse: failed to destroy child port, protocol change aborted.\n");
1358 input_free_device(new_dev
);
1362 mutex_unlock(&psmouse_mutex
);
1363 serio_unpin_driver(serio
);
1364 serio_unregister_child_port(serio
);
1365 serio_pin_driver_uninterruptible(serio
);
1366 mutex_lock(&psmouse_mutex
);
1368 if (serio
->drv
!= &psmouse_drv
) {
1369 input_free_device(new_dev
);
1373 if (psmouse
->type
== proto
->type
) {
1374 input_free_device(new_dev
);
1375 return count
; /* switched by other thread */
1379 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1380 parent
= serio_get_drvdata(serio
->parent
);
1381 if (parent
->pt_deactivate
)
1382 parent
->pt_deactivate(parent
);
1385 if (psmouse
->disconnect
)
1386 psmouse
->disconnect(psmouse
);
1388 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
1389 input_unregister_device(psmouse
->dev
);
1391 psmouse
->dev
= new_dev
;
1392 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1394 if (psmouse_switch_protocol(psmouse
, proto
) < 0) {
1395 psmouse_reset(psmouse
);
1396 /* default to PSMOUSE_PS2 */
1397 psmouse_switch_protocol(psmouse
, &psmouse_protocols
[0]);
1400 psmouse_initialize(psmouse
);
1401 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1403 input_register_device(psmouse
->dev
);
1405 if (parent
&& parent
->pt_activate
)
1406 parent
->pt_activate(parent
);
1411 static ssize_t
psmouse_attr_set_rate(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1413 unsigned long value
;
1416 value
= simple_strtoul(buf
, &rest
, 10);
1420 psmouse
->set_rate(psmouse
, value
);
1424 static ssize_t
psmouse_attr_set_resolution(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1426 unsigned long value
;
1429 value
= simple_strtoul(buf
, &rest
, 10);
1433 psmouse
->set_resolution(psmouse
, value
);
1438 static int psmouse_set_maxproto(const char *val
, struct kernel_param
*kp
)
1440 struct psmouse_protocol
*proto
;
1445 proto
= psmouse_protocol_by_name(val
, strlen(val
));
1447 if (!proto
|| !proto
->maxproto
)
1450 *((unsigned int *)kp
->arg
) = proto
->type
;
1455 static int psmouse_get_maxproto(char *buffer
, struct kernel_param
*kp
)
1457 int type
= *((unsigned int *)kp
->arg
);
1459 return sprintf(buffer
, "%s\n", psmouse_protocol_by_type(type
)->name
);
1462 static int __init
psmouse_init(void)
1464 kpsmoused_wq
= create_singlethread_workqueue("kpsmoused");
1465 if (!kpsmoused_wq
) {
1466 printk(KERN_ERR
"psmouse: failed to create kpsmoused workqueue\n");
1470 serio_register_driver(&psmouse_drv
);
1475 static void __exit
psmouse_exit(void)
1477 serio_unregister_driver(&psmouse_drv
);
1478 destroy_workqueue(kpsmoused_wq
);
1481 module_init(psmouse_init
);
1482 module_exit(psmouse_exit
);