2 * $Id: sermouse.c,v 1.17 2002/03/13 10:03:43 vojtech Exp $
4 * Copyright (c) 1999-2001 Vojtech Pavlik
8 * Serial mouse driver for Linux
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * Should you need to contact me, the author, you can do so either by
27 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
28 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
31 #include <linux/delay.h>
32 #include <linux/module.h>
33 #include <linux/slab.h>
34 #include <linux/interrupt.h>
35 #include <linux/input.h>
36 #include <linux/serio.h>
37 #include <linux/init.h>
39 #define DRIVER_DESC "Serial mouse driver"
41 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
42 MODULE_DESCRIPTION(DRIVER_DESC
);
43 MODULE_LICENSE("GPL");
45 static char *sermouse_protocols
[] = { "None", "Mouse Systems Mouse", "Sun Mouse", "Microsoft Mouse",
46 "Logitech M+ Mouse", "Microsoft MZ Mouse", "Logitech MZ+ Mouse",
47 "Logitech MZ++ Mouse"};
50 struct input_dev
*dev
;
59 * sermouse_process_msc() analyzes the incoming MSC/Sun bytestream and
60 * applies some prediction to the data, resulting in 96 updates per
61 * second, which is as good as a PS/2 or USB mouse.
64 static void sermouse_process_msc(struct sermouse
*sermouse
, signed char data
, struct pt_regs
*regs
)
66 struct input_dev
*dev
= sermouse
->dev
;
67 signed char *buf
= sermouse
->buf
;
69 input_regs(dev
, regs
);
71 switch (sermouse
->count
) {
74 if ((data
& 0xf8) != 0x80) return;
75 input_report_key(dev
, BTN_LEFT
, !(data
& 4));
76 input_report_key(dev
, BTN_RIGHT
, !(data
& 1));
77 input_report_key(dev
, BTN_MIDDLE
, !(data
& 2));
82 input_report_rel(dev
, REL_X
, data
/ 2);
83 input_report_rel(dev
, REL_Y
, -buf
[1]);
84 buf
[0] = data
- data
/ 2;
89 input_report_rel(dev
, REL_X
, buf
[0]);
90 input_report_rel(dev
, REL_Y
, buf
[1] - data
);
97 if (++sermouse
->count
== 5)
102 * sermouse_process_ms() anlyzes the incoming MS(Z/+/++) bytestream and
103 * generates events. With prediction it gets 80 updates/sec, assuming
104 * standard 3-byte packets and 1200 bps.
107 static void sermouse_process_ms(struct sermouse
*sermouse
, signed char data
, struct pt_regs
*regs
)
109 struct input_dev
*dev
= sermouse
->dev
;
110 signed char *buf
= sermouse
->buf
;
112 if (data
& 0x40) sermouse
->count
= 0;
114 input_regs(dev
, regs
);
116 switch (sermouse
->count
) {
120 input_report_key(dev
, BTN_LEFT
, (data
>> 5) & 1);
121 input_report_key(dev
, BTN_RIGHT
, (data
>> 4) & 1);
126 data
= (signed char) (((buf
[1] << 6) & 0xc0) | (data
& 0x3f));
127 input_report_rel(dev
, REL_X
, data
/ 2);
128 input_report_rel(dev
, REL_Y
, buf
[4]);
129 buf
[3] = data
- data
/ 2;
133 /* Guessing the state of the middle button on 3-button MS-protocol mice - ugly. */
134 if ((sermouse
->type
== SERIO_MS
) && !data
&& !buf
[2] && !((buf
[0] & 0xf0) ^ buf
[1]))
135 input_report_key(dev
, BTN_MIDDLE
, !test_bit(BTN_MIDDLE
, dev
->key
));
138 data
= (signed char) (((buf
[1] << 4) & 0xc0) | (data
& 0x3f));
139 input_report_rel(dev
, REL_X
, buf
[3]);
140 input_report_rel(dev
, REL_Y
, data
- buf
[4]);
146 switch (sermouse
->type
) {
149 sermouse
->type
= SERIO_MP
;
152 if ((data
>> 2) & 3) break; /* M++ Wireless Extension packet. */
153 input_report_key(dev
, BTN_MIDDLE
, (data
>> 5) & 1);
154 input_report_key(dev
, BTN_SIDE
, (data
>> 4) & 1);
159 input_report_key(dev
, BTN_SIDE
, (data
>> 5) & 1);
162 input_report_key(dev
, BTN_MIDDLE
, (data
>> 4) & 1);
163 input_report_rel(dev
, REL_WHEEL
, (data
& 8) - (data
& 7));
170 case 6: /* MZ++ packet type. We can get these bytes for M++ too but we ignore them later. */
171 buf
[1] = (data
>> 2) & 0x0f;
175 case 7: /* Ignore anything besides MZ++ */
176 if (sermouse
->type
!= SERIO_MZPP
) break;
180 case 1: /* Extra mouse info */
182 input_report_key(dev
, BTN_SIDE
, (data
>> 4) & 1);
183 input_report_key(dev
, BTN_EXTRA
, (data
>> 5) & 1);
184 input_report_rel(dev
, data
& 0x80 ? REL_HWHEEL
: REL_WHEEL
, (data
& 7) - (data
& 8));
188 default: /* We don't decode anything else yet. */
191 "sermouse.c: Received MZ++ packet %x, don't know how to handle.\n", buf
[1]);
204 * sermouse_interrupt() handles incoming characters, either gathering them into
205 * packets or passing them to the command routine as command output.
208 static irqreturn_t
sermouse_interrupt(struct serio
*serio
,
209 unsigned char data
, unsigned int flags
, struct pt_regs
*regs
)
211 struct sermouse
*sermouse
= serio_get_drvdata(serio
);
213 if (time_after(jiffies
, sermouse
->last
+ HZ
/10)) sermouse
->count
= 0;
214 sermouse
->last
= jiffies
;
216 if (sermouse
->type
> SERIO_SUN
)
217 sermouse_process_ms(sermouse
, data
, regs
);
219 sermouse_process_msc(sermouse
, data
, regs
);
224 * sermouse_disconnect() cleans up after we don't want talk
225 * to the mouse anymore.
228 static void sermouse_disconnect(struct serio
*serio
)
230 struct sermouse
*sermouse
= serio_get_drvdata(serio
);
233 serio_set_drvdata(serio
, NULL
);
234 input_unregister_device(sermouse
->dev
);
239 * sermouse_connect() is a callback form the serio module when
240 * an unhandled serio port is found.
243 static int sermouse_connect(struct serio
*serio
, struct serio_driver
*drv
)
245 struct sermouse
*sermouse
;
246 struct input_dev
*input_dev
;
247 unsigned char c
= serio
->id
.extra
;
250 sermouse
= kzalloc(sizeof(struct sermouse
), GFP_KERNEL
);
251 input_dev
= input_allocate_device();
252 if (!sermouse
|| !input_dev
)
255 sermouse
->dev
= input_dev
;
256 snprintf(sermouse
->phys
, sizeof(sermouse
->phys
), "%s/input0", serio
->phys
);
257 sermouse
->type
= serio
->id
.proto
;
259 input_dev
->name
= sermouse_protocols
[sermouse
->type
];
260 input_dev
->phys
= sermouse
->phys
;
261 input_dev
->id
.bustype
= BUS_RS232
;
262 input_dev
->id
.vendor
= sermouse
->type
;
263 input_dev
->id
.product
= c
;
264 input_dev
->id
.version
= 0x0100;
265 input_dev
->cdev
.dev
= &serio
->dev
;
267 input_dev
->evbit
[0] = BIT(EV_KEY
) | BIT(EV_REL
);
268 input_dev
->keybit
[LONG(BTN_MOUSE
)] = BIT(BTN_LEFT
) | BIT(BTN_RIGHT
);
269 input_dev
->relbit
[0] = BIT(REL_X
) | BIT(REL_Y
);
270 input_dev
->private = sermouse
;
272 if (c
& 0x01) set_bit(BTN_MIDDLE
, input_dev
->keybit
);
273 if (c
& 0x02) set_bit(BTN_SIDE
, input_dev
->keybit
);
274 if (c
& 0x04) set_bit(BTN_EXTRA
, input_dev
->keybit
);
275 if (c
& 0x10) set_bit(REL_WHEEL
, input_dev
->relbit
);
276 if (c
& 0x20) set_bit(REL_HWHEEL
, input_dev
->relbit
);
278 serio_set_drvdata(serio
, sermouse
);
280 err
= serio_open(serio
, drv
);
284 input_register_device(sermouse
->dev
);
288 fail
: serio_set_drvdata(serio
, NULL
);
289 input_free_device(input_dev
);
294 static struct serio_device_id sermouse_serio_ids
[] = {
340 MODULE_DEVICE_TABLE(serio
, sermouse_serio_ids
);
342 static struct serio_driver sermouse_drv
= {
346 .description
= DRIVER_DESC
,
347 .id_table
= sermouse_serio_ids
,
348 .interrupt
= sermouse_interrupt
,
349 .connect
= sermouse_connect
,
350 .disconnect
= sermouse_disconnect
,
353 static int __init
sermouse_init(void)
355 serio_register_driver(&sermouse_drv
);
359 static void __exit
sermouse_exit(void)
361 serio_unregister_driver(&sermouse_drv
);
364 module_init(sermouse_init
);
365 module_exit(sermouse_exit
);