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) {
306 psmouse
->last
= jiffies
;
310 if (psmouse
->packet
[1] == PSMOUSE_RET_ID
) {
311 __psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
312 serio_reconnect(serio
);
316 * Not a new device, try processing first byte normally
319 if (psmouse_handle_byte(psmouse
, regs
))
322 psmouse
->packet
[psmouse
->pktcnt
++] = data
;
326 * See if we need to force resync because mouse was idle for too long
328 if (psmouse
->state
== PSMOUSE_ACTIVATED
&&
329 psmouse
->pktcnt
== 1 && psmouse
->resync_time
&&
330 time_after(jiffies
, psmouse
->last
+ psmouse
->resync_time
* HZ
)) {
331 psmouse
->badbyte
= psmouse
->packet
[0];
332 __psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
333 queue_work(kpsmoused_wq
, &psmouse
->resync_work
);
337 psmouse
->last
= jiffies
;
338 psmouse_handle_byte(psmouse
, regs
);
346 * psmouse_sliced_command() sends an extended PS/2 command to the mouse
347 * using sliced syntax, understood by advanced devices, such as Logitech
348 * or Synaptics touchpads. The command is encoded as:
349 * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
352 int psmouse_sliced_command(struct psmouse
*psmouse
, unsigned char command
)
356 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
))
359 for (i
= 6; i
>= 0; i
-= 2) {
360 unsigned char d
= (command
>> i
) & 3;
361 if (ps2_command(&psmouse
->ps2dev
, &d
, PSMOUSE_CMD_SETRES
))
370 * psmouse_reset() resets the mouse into power-on state.
372 int psmouse_reset(struct psmouse
*psmouse
)
374 unsigned char param
[2];
376 if (ps2_command(&psmouse
->ps2dev
, param
, PSMOUSE_CMD_RESET_BAT
))
379 if (param
[0] != PSMOUSE_RET_BAT
&& param
[1] != PSMOUSE_RET_ID
)
387 * Genius NetMouse magic init.
389 static int genius_detect(struct psmouse
*psmouse
, int set_properties
)
391 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
392 unsigned char param
[4];
395 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
);
396 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
397 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
398 ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
399 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETINFO
);
401 if (param
[0] != 0x00 || param
[1] != 0x33 || param
[2] != 0x55)
404 if (set_properties
) {
405 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
406 set_bit(BTN_SIDE
, psmouse
->dev
->keybit
);
407 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
409 psmouse
->vendor
= "Genius";
410 psmouse
->name
= "Mouse";
411 psmouse
->pktsize
= 4;
418 * IntelliMouse magic init.
420 static int intellimouse_detect(struct psmouse
*psmouse
, int set_properties
)
422 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
423 unsigned char param
[2];
426 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
428 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
430 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
431 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
436 if (set_properties
) {
437 set_bit(BTN_MIDDLE
, psmouse
->dev
->keybit
);
438 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
440 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
441 if (!psmouse
->name
) psmouse
->name
= "Wheel Mouse";
442 psmouse
->pktsize
= 4;
449 * Try IntelliMouse/Explorer magic init.
451 static int im_explorer_detect(struct psmouse
*psmouse
, int set_properties
)
453 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
454 unsigned char param
[2];
456 intellimouse_detect(psmouse
, 0);
459 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
461 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
463 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
464 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
469 if (set_properties
) {
470 set_bit(BTN_MIDDLE
, psmouse
->dev
->keybit
);
471 set_bit(REL_WHEEL
, psmouse
->dev
->relbit
);
472 set_bit(BTN_SIDE
, psmouse
->dev
->keybit
);
473 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
475 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
476 if (!psmouse
->name
) psmouse
->name
= "Explorer Mouse";
477 psmouse
->pktsize
= 4;
484 * Kensington ThinkingMouse / ExpertMouse magic init.
486 static int thinking_detect(struct psmouse
*psmouse
, int set_properties
)
488 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
489 unsigned char param
[2];
490 unsigned char seq
[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20, 0 };
494 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRATE
);
496 ps2_command(ps2dev
, param
, PSMOUSE_CMD_SETRES
);
497 for (i
= 0; seq
[i
]; i
++)
498 ps2_command(ps2dev
, seq
+ i
, PSMOUSE_CMD_SETRATE
);
499 ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
);
504 if (set_properties
) {
505 set_bit(BTN_EXTRA
, psmouse
->dev
->keybit
);
507 psmouse
->vendor
= "Kensington";
508 psmouse
->name
= "ThinkingMouse";
515 * Bare PS/2 protocol "detection". Always succeeds.
517 static int ps2bare_detect(struct psmouse
*psmouse
, int set_properties
)
519 if (set_properties
) {
520 if (!psmouse
->vendor
) psmouse
->vendor
= "Generic";
521 if (!psmouse
->name
) psmouse
->name
= "Mouse";
529 * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
530 * the mouse may have.
533 static int psmouse_extensions(struct psmouse
*psmouse
,
534 unsigned int max_proto
, int set_properties
)
536 int synaptics_hardware
= 0;
539 * We always check for lifebook because it does not disturb mouse
540 * (it only checks DMI information).
542 if (lifebook_detect(psmouse
, set_properties
) == 0) {
543 if (max_proto
> PSMOUSE_IMEX
) {
544 if (!set_properties
|| lifebook_init(psmouse
) == 0)
545 return PSMOUSE_LIFEBOOK
;
550 * Try Kensington ThinkingMouse (we try first, because synaptics probe
551 * upsets the thinkingmouse).
554 if (max_proto
> PSMOUSE_IMEX
&& thinking_detect(psmouse
, set_properties
) == 0)
555 return PSMOUSE_THINKPS
;
558 * Try Synaptics TouchPad
560 if (max_proto
> PSMOUSE_PS2
&& synaptics_detect(psmouse
, set_properties
) == 0) {
561 synaptics_hardware
= 1;
563 if (max_proto
> PSMOUSE_IMEX
) {
564 if (!set_properties
|| synaptics_init(psmouse
) == 0)
565 return PSMOUSE_SYNAPTICS
;
567 * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
568 * Unfortunately Logitech/Genius probes confuse some firmware versions so
569 * we'll have to skip them.
571 max_proto
= PSMOUSE_IMEX
;
574 * Make sure that touchpad is in relative mode, gestures (taps) are enabled
576 synaptics_reset(psmouse
);
582 if (max_proto
> PSMOUSE_IMEX
) {
583 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
);
584 if (alps_detect(psmouse
, set_properties
) == 0) {
585 if (!set_properties
|| alps_init(psmouse
) == 0)
588 * Init failed, try basic relative protocols
590 max_proto
= PSMOUSE_IMEX
;
594 if (max_proto
> PSMOUSE_IMEX
&& genius_detect(psmouse
, set_properties
) == 0)
595 return PSMOUSE_GENPS
;
597 if (max_proto
> PSMOUSE_IMEX
&& ps2pp_init(psmouse
, set_properties
) == 0)
598 return PSMOUSE_PS2PP
;
600 if (max_proto
> PSMOUSE_IMEX
&& trackpoint_detect(psmouse
, set_properties
) == 0)
601 return PSMOUSE_TRACKPOINT
;
604 * Reset to defaults in case the device got confused by extended
605 * protocol probes. Note that we do full reset becuase some mice
606 * put themselves to sleep when see PSMOUSE_RESET_DIS.
608 psmouse_reset(psmouse
);
610 if (max_proto
>= PSMOUSE_IMEX
&& im_explorer_detect(psmouse
, set_properties
) == 0)
613 if (max_proto
>= PSMOUSE_IMPS
&& intellimouse_detect(psmouse
, set_properties
) == 0)
617 * Okay, all failed, we have a standard mouse here. The number of the buttons
618 * is still a question, though. We assume 3.
620 ps2bare_detect(psmouse
, set_properties
);
622 if (synaptics_hardware
) {
624 * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
625 * We need to reset the touchpad because if there is a track point on the
626 * pass through port it could get disabled while probing for protocol
629 psmouse_reset(psmouse
);
635 static struct psmouse_protocol psmouse_protocols
[] = {
641 .detect
= ps2bare_detect
,
644 .type
= PSMOUSE_PS2PP
,
647 .detect
= ps2pp_init
,
650 .type
= PSMOUSE_THINKPS
,
653 .detect
= thinking_detect
,
656 .type
= PSMOUSE_GENPS
,
659 .detect
= genius_detect
,
662 .type
= PSMOUSE_IMPS
,
666 .detect
= intellimouse_detect
,
669 .type
= PSMOUSE_IMEX
,
673 .detect
= im_explorer_detect
,
676 .type
= PSMOUSE_SYNAPTICS
,
678 .alias
= "synaptics",
679 .detect
= synaptics_detect
,
680 .init
= synaptics_init
,
683 .type
= PSMOUSE_ALPS
,
686 .detect
= alps_detect
,
690 .type
= PSMOUSE_LIFEBOOK
,
693 .init
= lifebook_init
,
696 .type
= PSMOUSE_TRACKPOINT
,
698 .alias
= "trackpoint",
699 .detect
= trackpoint_detect
,
702 .type
= PSMOUSE_AUTO
,
709 static struct psmouse_protocol
*psmouse_protocol_by_type(enum psmouse_type type
)
713 for (i
= 0; i
< ARRAY_SIZE(psmouse_protocols
); i
++)
714 if (psmouse_protocols
[i
].type
== type
)
715 return &psmouse_protocols
[i
];
718 return &psmouse_protocols
[0];
721 static struct psmouse_protocol
*psmouse_protocol_by_name(const char *name
, size_t len
)
723 struct psmouse_protocol
*p
;
726 for (i
= 0; i
< ARRAY_SIZE(psmouse_protocols
); i
++) {
727 p
= &psmouse_protocols
[i
];
729 if ((strlen(p
->name
) == len
&& !strncmp(p
->name
, name
, len
)) ||
730 (strlen(p
->alias
) == len
&& !strncmp(p
->alias
, name
, len
)))
731 return &psmouse_protocols
[i
];
739 * psmouse_probe() probes for a PS/2 mouse.
742 static int psmouse_probe(struct psmouse
*psmouse
)
744 struct ps2dev
*ps2dev
= &psmouse
->ps2dev
;
745 unsigned char param
[2];
748 * First, we check if it's a mouse. It should send 0x00 or 0x03
749 * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
750 * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
751 * ID queries, probably due to a firmware bug.
755 if (ps2_command(ps2dev
, param
, PSMOUSE_CMD_GETID
))
758 if (param
[0] != 0x00 && param
[0] != 0x03 &&
759 param
[0] != 0x04 && param
[0] != 0xff)
763 * Then we reset and disable the mouse so that it doesn't generate events.
766 if (ps2_command(ps2dev
, NULL
, PSMOUSE_CMD_RESET_DIS
))
767 printk(KERN_WARNING
"psmouse.c: Failed to reset mouse on %s\n", ps2dev
->serio
->phys
);
773 * Here we set the mouse resolution.
776 void psmouse_set_resolution(struct psmouse
*psmouse
, unsigned int resolution
)
778 unsigned char params
[] = { 0, 1, 2, 2, 3 };
780 if (resolution
== 0 || resolution
> 200)
783 ps2_command(&psmouse
->ps2dev
, ¶ms
[resolution
/ 50], PSMOUSE_CMD_SETRES
);
784 psmouse
->resolution
= 25 << params
[resolution
/ 50];
788 * Here we set the mouse report rate.
791 static void psmouse_set_rate(struct psmouse
*psmouse
, unsigned int rate
)
793 unsigned char rates
[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
796 while (rates
[i
] > rate
) i
++;
797 ps2_command(&psmouse
->ps2dev
, &rates
[i
], PSMOUSE_CMD_SETRATE
);
798 psmouse
->rate
= rates
[i
];
802 * psmouse_initialize() initializes the mouse to a sane state.
805 static void psmouse_initialize(struct psmouse
*psmouse
)
808 * We set the mouse into streaming mode.
811 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSTREAM
);
814 * We set the mouse report rate, resolution and scaling.
817 if (psmouse_max_proto
!= PSMOUSE_PS2
) {
818 psmouse
->set_rate(psmouse
, psmouse
->rate
);
819 psmouse
->set_resolution(psmouse
, psmouse
->resolution
);
820 ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_SETSCALE11
);
825 * psmouse_activate() enables the mouse so that we get motion reports from it.
828 static void psmouse_activate(struct psmouse
*psmouse
)
830 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
))
831 printk(KERN_WARNING
"psmouse.c: Failed to enable mouse on %s\n",
832 psmouse
->ps2dev
.serio
->phys
);
834 psmouse_set_state(psmouse
, PSMOUSE_ACTIVATED
);
839 * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
840 * reports from it unless we explicitely request it.
843 static void psmouse_deactivate(struct psmouse
*psmouse
)
845 if (ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_DISABLE
))
846 printk(KERN_WARNING
"psmouse.c: Failed to deactivate mouse on %s\n",
847 psmouse
->ps2dev
.serio
->phys
);
849 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
853 * psmouse_poll() - default poll hanlder. Everyone except for ALPS uses it.
856 static int psmouse_poll(struct psmouse
*psmouse
)
858 return ps2_command(&psmouse
->ps2dev
, psmouse
->packet
,
859 PSMOUSE_CMD_POLL
| (psmouse
->pktsize
<< 8));
864 * psmouse_resync() attempts to re-validate current protocol.
867 static void psmouse_resync(void *p
)
869 struct psmouse
*psmouse
= p
, *parent
= NULL
;
870 struct serio
*serio
= psmouse
->ps2dev
.serio
;
871 psmouse_ret_t rc
= PSMOUSE_GOOD_DATA
;
872 int failed
= 0, enabled
= 0;
875 mutex_lock(&psmouse_mutex
);
877 if (psmouse
->state
!= PSMOUSE_RESYNCING
)
880 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
881 parent
= serio_get_drvdata(serio
->parent
);
882 psmouse_deactivate(parent
);
886 * Some mice don't ACK commands sent while they are in the middle of
887 * transmitting motion packet. To avoid delay we use ps2_sendbyte()
888 * instead of ps2_command() which would wait for 200ms for an ACK
889 * that may never come.
890 * As an additional quirk ALPS touchpads may not only forget to ACK
891 * disable command but will stop reporting taps, so if we see that
892 * mouse at least once ACKs disable we will do full reconnect if ACK
895 psmouse
->num_resyncs
++;
897 if (ps2_sendbyte(&psmouse
->ps2dev
, PSMOUSE_CMD_DISABLE
, 20)) {
898 if (psmouse
->num_resyncs
< 3 || psmouse
->acks_disable_command
)
901 psmouse
->acks_disable_command
= 1;
904 * Poll the mouse. If it was reset the packet will be shorter than
905 * psmouse->pktsize and ps2_command will fail. We do not expect and
906 * do not handle scenario when mouse "upgrades" its protocol while
907 * disconnected since it would require additional delay. If we ever
908 * see a mouse that does it we'll adjust the code.
911 if (psmouse
->poll(psmouse
))
914 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
915 for (i
= 0; i
< psmouse
->pktsize
; i
++) {
917 rc
= psmouse
->protocol_handler(psmouse
, NULL
);
918 if (rc
!= PSMOUSE_GOOD_DATA
)
921 if (rc
!= PSMOUSE_FULL_PACKET
)
923 psmouse_set_state(psmouse
, PSMOUSE_RESYNCING
);
927 * Now try to enable mouse. We try to do that even if poll failed and also
928 * repeat our attempts 5 times, otherwise we may be left out with disabled
931 for (i
= 0; i
< 5; i
++) {
932 if (!ps2_command(&psmouse
->ps2dev
, NULL
, PSMOUSE_CMD_ENABLE
)) {
940 printk(KERN_WARNING
"psmouse.c: failed to re-enable mouse on %s\n",
941 psmouse
->ps2dev
.serio
->phys
);
946 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
947 printk(KERN_INFO
"psmouse.c: resync failed, issuing reconnect request\n");
948 serio_reconnect(serio
);
950 psmouse_set_state(psmouse
, PSMOUSE_ACTIVATED
);
953 psmouse_activate(parent
);
955 mutex_unlock(&psmouse_mutex
);
959 * psmouse_cleanup() resets the mouse into power-on state.
962 static void psmouse_cleanup(struct serio
*serio
)
964 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
966 psmouse_reset(psmouse
);
970 * psmouse_disconnect() closes and frees.
973 static void psmouse_disconnect(struct serio
*serio
)
975 struct psmouse
*psmouse
, *parent
= NULL
;
977 psmouse
= serio_get_drvdata(serio
);
979 sysfs_remove_group(&serio
->dev
.kobj
, &psmouse_attribute_group
);
981 mutex_lock(&psmouse_mutex
);
983 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
985 /* make sure we don't have a resync in progress */
986 mutex_unlock(&psmouse_mutex
);
987 flush_workqueue(kpsmoused_wq
);
988 mutex_lock(&psmouse_mutex
);
990 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
991 parent
= serio_get_drvdata(serio
->parent
);
992 psmouse_deactivate(parent
);
995 if (psmouse
->disconnect
)
996 psmouse
->disconnect(psmouse
);
998 if (parent
&& parent
->pt_deactivate
)
999 parent
->pt_deactivate(parent
);
1001 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
1004 serio_set_drvdata(serio
, NULL
);
1005 input_unregister_device(psmouse
->dev
);
1009 psmouse_activate(parent
);
1011 mutex_unlock(&psmouse_mutex
);
1014 static int psmouse_switch_protocol(struct psmouse
*psmouse
, struct psmouse_protocol
*proto
)
1016 struct input_dev
*input_dev
= psmouse
->dev
;
1018 input_dev
->private = psmouse
;
1019 input_dev
->cdev
.dev
= &psmouse
->ps2dev
.serio
->dev
;
1021 input_dev
->evbit
[0] = BIT(EV_KEY
) | BIT(EV_REL
);
1022 input_dev
->keybit
[LONG(BTN_MOUSE
)] = BIT(BTN_LEFT
) | BIT(BTN_MIDDLE
) | BIT(BTN_RIGHT
);
1023 input_dev
->relbit
[0] = BIT(REL_X
) | BIT(REL_Y
);
1025 psmouse
->set_rate
= psmouse_set_rate
;
1026 psmouse
->set_resolution
= psmouse_set_resolution
;
1027 psmouse
->poll
= psmouse_poll
;
1028 psmouse
->protocol_handler
= psmouse_process_byte
;
1029 psmouse
->pktsize
= 3;
1031 if (proto
&& (proto
->detect
|| proto
->init
)) {
1032 if (proto
->detect
&& proto
->detect(psmouse
, 1) < 0)
1035 if (proto
->init
&& proto
->init(psmouse
) < 0)
1038 psmouse
->type
= proto
->type
;
1041 psmouse
->type
= psmouse_extensions(psmouse
, psmouse_max_proto
, 1);
1044 * If mouse's packet size is 3 there is no point in polling the
1045 * device in hopes to detect protocol reset - we won't get less
1046 * than 3 bytes response anyhow.
1048 if (psmouse
->pktsize
== 3)
1049 psmouse
->resync_time
= 0;
1052 * Some smart KVMs fake response to POLL command returning just
1053 * 3 bytes and messing up our resync logic, so if initial poll
1054 * fails we won't try polling the device anymore. Hopefully
1055 * such KVM will maintain initially selected protocol.
1057 if (psmouse
->resync_time
&& psmouse
->poll(psmouse
))
1058 psmouse
->resync_time
= 0;
1060 sprintf(psmouse
->devname
, "%s %s %s",
1061 psmouse_protocol_by_type(psmouse
->type
)->name
, psmouse
->vendor
, psmouse
->name
);
1063 input_dev
->name
= psmouse
->devname
;
1064 input_dev
->phys
= psmouse
->phys
;
1065 input_dev
->id
.bustype
= BUS_I8042
;
1066 input_dev
->id
.vendor
= 0x0002;
1067 input_dev
->id
.product
= psmouse
->type
;
1068 input_dev
->id
.version
= psmouse
->model
;
1074 * psmouse_connect() is a callback from the serio module when
1075 * an unhandled serio port is found.
1077 static int psmouse_connect(struct serio
*serio
, struct serio_driver
*drv
)
1079 struct psmouse
*psmouse
, *parent
= NULL
;
1080 struct input_dev
*input_dev
;
1081 int retval
= -ENOMEM
;
1083 mutex_lock(&psmouse_mutex
);
1086 * If this is a pass-through port deactivate parent so the device
1087 * connected to this port can be successfully identified
1089 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1090 parent
= serio_get_drvdata(serio
->parent
);
1091 psmouse_deactivate(parent
);
1094 psmouse
= kzalloc(sizeof(struct psmouse
), GFP_KERNEL
);
1095 input_dev
= input_allocate_device();
1096 if (!psmouse
|| !input_dev
)
1099 ps2_init(&psmouse
->ps2dev
, serio
);
1100 INIT_WORK(&psmouse
->resync_work
, psmouse_resync
, psmouse
);
1101 psmouse
->dev
= input_dev
;
1102 sprintf(psmouse
->phys
, "%s/input0", serio
->phys
);
1104 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1106 serio_set_drvdata(serio
, psmouse
);
1108 retval
= serio_open(serio
, drv
);
1112 if (psmouse_probe(psmouse
) < 0) {
1118 psmouse
->rate
= psmouse_rate
;
1119 psmouse
->resolution
= psmouse_resolution
;
1120 psmouse
->resetafter
= psmouse_resetafter
;
1121 psmouse
->resync_time
= parent
? 0 : psmouse_resync_time
;
1122 psmouse
->smartscroll
= psmouse_smartscroll
;
1124 psmouse_switch_protocol(psmouse
, NULL
);
1126 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1127 psmouse_initialize(psmouse
);
1129 input_register_device(psmouse
->dev
);
1131 if (parent
&& parent
->pt_activate
)
1132 parent
->pt_activate(parent
);
1134 sysfs_create_group(&serio
->dev
.kobj
, &psmouse_attribute_group
);
1136 psmouse_activate(psmouse
);
1142 serio_set_drvdata(serio
, NULL
);
1143 input_free_device(input_dev
);
1147 /* If this is a pass-through port the parent needs to be re-activated */
1149 psmouse_activate(parent
);
1151 mutex_unlock(&psmouse_mutex
);
1156 static int psmouse_reconnect(struct serio
*serio
)
1158 struct psmouse
*psmouse
= serio_get_drvdata(serio
);
1159 struct psmouse
*parent
= NULL
;
1160 struct serio_driver
*drv
= serio
->drv
;
1163 if (!drv
|| !psmouse
) {
1164 printk(KERN_DEBUG
"psmouse: reconnect request, but serio is disconnected, ignoring...\n");
1168 mutex_lock(&psmouse_mutex
);
1170 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1171 parent
= serio_get_drvdata(serio
->parent
);
1172 psmouse_deactivate(parent
);
1175 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1177 if (psmouse
->reconnect
) {
1178 if (psmouse
->reconnect(psmouse
))
1180 } else if (psmouse_probe(psmouse
) < 0 ||
1181 psmouse
->type
!= psmouse_extensions(psmouse
, psmouse_max_proto
, 0))
1184 /* ok, the device type (and capabilities) match the old one,
1185 * we can continue using it, complete intialization
1187 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1189 psmouse_initialize(psmouse
);
1191 if (parent
&& parent
->pt_activate
)
1192 parent
->pt_activate(parent
);
1194 psmouse_activate(psmouse
);
1198 /* If this is a pass-through port the parent waits to be activated */
1200 psmouse_activate(parent
);
1202 mutex_unlock(&psmouse_mutex
);
1206 static struct serio_device_id psmouse_serio_ids
[] = {
1214 .type
= SERIO_PS_PSTHRU
,
1222 MODULE_DEVICE_TABLE(serio
, psmouse_serio_ids
);
1224 static struct serio_driver psmouse_drv
= {
1228 .description
= DRIVER_DESC
,
1229 .id_table
= psmouse_serio_ids
,
1230 .interrupt
= psmouse_interrupt
,
1231 .connect
= psmouse_connect
,
1232 .reconnect
= psmouse_reconnect
,
1233 .disconnect
= psmouse_disconnect
,
1234 .cleanup
= psmouse_cleanup
,
1237 ssize_t
psmouse_attr_show_helper(struct device
*dev
, struct device_attribute
*devattr
,
1240 struct serio
*serio
= to_serio_port(dev
);
1241 struct psmouse_attribute
*attr
= to_psmouse_attr(devattr
);
1242 struct psmouse
*psmouse
;
1245 retval
= serio_pin_driver(serio
);
1249 if (serio
->drv
!= &psmouse_drv
) {
1254 psmouse
= serio_get_drvdata(serio
);
1256 retval
= attr
->show(psmouse
, attr
->data
, buf
);
1259 serio_unpin_driver(serio
);
1263 ssize_t
psmouse_attr_set_helper(struct device
*dev
, struct device_attribute
*devattr
,
1264 const char *buf
, size_t count
)
1266 struct serio
*serio
= to_serio_port(dev
);
1267 struct psmouse_attribute
*attr
= to_psmouse_attr(devattr
);
1268 struct psmouse
*psmouse
, *parent
= NULL
;
1271 retval
= serio_pin_driver(serio
);
1275 if (serio
->drv
!= &psmouse_drv
) {
1280 retval
= mutex_lock_interruptible(&psmouse_mutex
);
1284 psmouse
= serio_get_drvdata(serio
);
1286 if (psmouse
->state
== PSMOUSE_IGNORE
) {
1291 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1292 parent
= serio_get_drvdata(serio
->parent
);
1293 psmouse_deactivate(parent
);
1296 psmouse_deactivate(psmouse
);
1298 retval
= attr
->set(psmouse
, attr
->data
, buf
, count
);
1300 if (retval
!= -ENODEV
)
1301 psmouse_activate(psmouse
);
1304 psmouse_activate(parent
);
1307 mutex_unlock(&psmouse_mutex
);
1309 serio_unpin_driver(serio
);
1313 static ssize_t
psmouse_show_int_attr(struct psmouse
*psmouse
, void *offset
, char *buf
)
1315 unsigned long *field
= (unsigned long *)((char *)psmouse
+ (size_t)offset
);
1317 return sprintf(buf
, "%lu\n", *field
);
1320 static ssize_t
psmouse_set_int_attr(struct psmouse
*psmouse
, void *offset
, const char *buf
, size_t count
)
1322 unsigned long *field
= (unsigned long *)((char *)psmouse
+ (size_t)offset
);
1323 unsigned long value
;
1326 value
= simple_strtoul(buf
, &rest
, 10);
1335 static ssize_t
psmouse_attr_show_protocol(struct psmouse
*psmouse
, void *data
, char *buf
)
1337 return sprintf(buf
, "%s\n", psmouse_protocol_by_type(psmouse
->type
)->name
);
1340 static ssize_t
psmouse_attr_set_protocol(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1342 struct serio
*serio
= psmouse
->ps2dev
.serio
;
1343 struct psmouse
*parent
= NULL
;
1344 struct input_dev
*new_dev
;
1345 struct psmouse_protocol
*proto
;
1348 if (!(proto
= psmouse_protocol_by_name(buf
, count
)))
1351 if (psmouse
->type
== proto
->type
)
1354 if (!(new_dev
= input_allocate_device()))
1357 while (serio
->child
) {
1359 printk(KERN_WARNING
"psmouse: failed to destroy child port, protocol change aborted.\n");
1360 input_free_device(new_dev
);
1364 mutex_unlock(&psmouse_mutex
);
1365 serio_unpin_driver(serio
);
1366 serio_unregister_child_port(serio
);
1367 serio_pin_driver_uninterruptible(serio
);
1368 mutex_lock(&psmouse_mutex
);
1370 if (serio
->drv
!= &psmouse_drv
) {
1371 input_free_device(new_dev
);
1375 if (psmouse
->type
== proto
->type
) {
1376 input_free_device(new_dev
);
1377 return count
; /* switched by other thread */
1381 if (serio
->parent
&& serio
->id
.type
== SERIO_PS_PSTHRU
) {
1382 parent
= serio_get_drvdata(serio
->parent
);
1383 if (parent
->pt_deactivate
)
1384 parent
->pt_deactivate(parent
);
1387 if (psmouse
->disconnect
)
1388 psmouse
->disconnect(psmouse
);
1390 psmouse_set_state(psmouse
, PSMOUSE_IGNORE
);
1391 input_unregister_device(psmouse
->dev
);
1393 psmouse
->dev
= new_dev
;
1394 psmouse_set_state(psmouse
, PSMOUSE_INITIALIZING
);
1396 if (psmouse_switch_protocol(psmouse
, proto
) < 0) {
1397 psmouse_reset(psmouse
);
1398 /* default to PSMOUSE_PS2 */
1399 psmouse_switch_protocol(psmouse
, &psmouse_protocols
[0]);
1402 psmouse_initialize(psmouse
);
1403 psmouse_set_state(psmouse
, PSMOUSE_CMD_MODE
);
1405 input_register_device(psmouse
->dev
);
1407 if (parent
&& parent
->pt_activate
)
1408 parent
->pt_activate(parent
);
1413 static ssize_t
psmouse_attr_set_rate(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1415 unsigned long value
;
1418 value
= simple_strtoul(buf
, &rest
, 10);
1422 psmouse
->set_rate(psmouse
, value
);
1426 static ssize_t
psmouse_attr_set_resolution(struct psmouse
*psmouse
, void *data
, const char *buf
, size_t count
)
1428 unsigned long value
;
1431 value
= simple_strtoul(buf
, &rest
, 10);
1435 psmouse
->set_resolution(psmouse
, value
);
1440 static int psmouse_set_maxproto(const char *val
, struct kernel_param
*kp
)
1442 struct psmouse_protocol
*proto
;
1447 proto
= psmouse_protocol_by_name(val
, strlen(val
));
1449 if (!proto
|| !proto
->maxproto
)
1452 *((unsigned int *)kp
->arg
) = proto
->type
;
1457 static int psmouse_get_maxproto(char *buffer
, struct kernel_param
*kp
)
1459 int type
= *((unsigned int *)kp
->arg
);
1461 return sprintf(buffer
, "%s\n", psmouse_protocol_by_type(type
)->name
);
1464 static int __init
psmouse_init(void)
1466 kpsmoused_wq
= create_singlethread_workqueue("kpsmoused");
1467 if (!kpsmoused_wq
) {
1468 printk(KERN_ERR
"psmouse: failed to create kpsmoused workqueue\n");
1472 serio_register_driver(&psmouse_drv
);
1477 static void __exit
psmouse_exit(void)
1479 serio_unregister_driver(&psmouse_drv
);
1480 destroy_workqueue(kpsmoused_wq
);
1483 module_init(psmouse_init
);
1484 module_exit(psmouse_exit
);