xref: /freebsd/usr.sbin/moused/moused.c (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
1 /**
2  ** Copyright (c) 1995 Michael Smith, All rights reserved.
3  **
4  ** Redistribution and use in source and binary forms, with or without
5  ** modification, are permitted provided that the following conditions
6  ** are met:
7  ** 1. Redistributions of source code must retain the above copyright
8  **    notice, this list of conditions and the following disclaimer as
9  **    the first lines of this file unmodified.
10  ** 2. Redistributions in binary form must reproduce the above copyright
11  **    notice, this list of conditions and the following disclaimer in the
12  **    documentation and/or other materials provided with the distribution.
13  ** 3. All advertising materials mentioning features or use of this software
14  **    must display the following acknowledgment:
15  **      This product includes software developed by Michael Smith.
16  ** 4. The name of the author may not be used to endorse or promote products
17  **    derived from this software without specific prior written permission.
18  **
19  **
20  ** THIS SOFTWARE IS PROVIDED BY Michael Smith ``AS IS'' AND ANY
21  ** EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  ** PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Michael Smith BE LIABLE FOR
24  ** ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  ** CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  ** SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27  ** BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  ** WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29  ** OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  ** EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  **
32  **/
33 
34 /**
35  ** MOUSED.C
36  **
37  ** Mouse daemon : listens to a serial port, the bus mouse interface, or
38  ** the PS/2 mouse port for mouse data stream, interprets data and passes
39  ** ioctls off to the console driver.
40  **
41  ** The mouse interface functions are derived closely from the mouse
42  ** handler in the XFree86 X server.  Many thanks to the XFree86 people
43  ** for their great work!
44  **
45  **/
46 
47 #include <sys/cdefs.h>
48 __FBSDID("$FreeBSD$");
49 
50 #include <sys/param.h>
51 #include <sys/consio.h>
52 #include <sys/linker.h>
53 #include <sys/module.h>
54 #include <sys/mouse.h>
55 #include <sys/socket.h>
56 #include <sys/stat.h>
57 #include <sys/time.h>
58 #include <sys/un.h>
59 
60 #include <ctype.h>
61 #include <err.h>
62 #include <errno.h>
63 #include <fcntl.h>
64 #include <limits.h>
65 #include <setjmp.h>
66 #include <signal.h>
67 #include <stdarg.h>
68 #include <stdio.h>
69 #include <stdlib.h>
70 #include <string.h>
71 #include <syslog.h>
72 #include <termios.h>
73 #include <unistd.h>
74 
75 #define MAX_CLICKTHRESHOLD	2000	/* 2 seconds */
76 #define MAX_BUTTON2TIMEOUT	2000	/* 2 seconds */
77 #define DFLT_CLICKTHRESHOLD	 500	/* 0.5 second */
78 #define DFLT_BUTTON2TIMEOUT	 100	/* 0.1 second */
79 #define DFLT_SCROLLTHRESHOLD	   3	/* 3 pixels */
80 
81 /* Abort 3-button emulation delay after this many movement events. */
82 #define BUTTON2_MAXMOVE	3
83 
84 #define TRUE		1
85 #define FALSE		0
86 
87 #define MOUSE_XAXIS	(-1)
88 #define MOUSE_YAXIS	(-2)
89 
90 /* Logitech PS2++ protocol */
91 #define MOUSE_PS2PLUS_CHECKBITS(b)	\
92 			((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
93 #define MOUSE_PS2PLUS_PACKET_TYPE(b)	\
94 			(((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
95 
96 #define	ChordMiddle	0x0001
97 #define Emulate3Button	0x0002
98 #define ClearDTR	0x0004
99 #define ClearRTS	0x0008
100 #define NoPnP		0x0010
101 #define VirtualScroll	0x0020
102 
103 #define ID_NONE		0
104 #define ID_PORT		1
105 #define ID_IF		2
106 #define ID_TYPE		4
107 #define ID_MODEL	8
108 #define ID_ALL		(ID_PORT | ID_IF | ID_TYPE | ID_MODEL)
109 
110 #define debug(fmt, args...) do {				\
111 	if (debug && nodaemon)					\
112 		warnx(fmt, ##args);				\
113 } while (0)
114 
115 #define logerr(e, fmt, args...) do {				\
116 	log_or_warn(LOG_DAEMON | LOG_ERR, errno, fmt, ##args);	\
117 	exit(e);						\
118 } while (0)
119 
120 #define logerrx(e, fmt, args...) do {				\
121 	log_or_warn(LOG_DAEMON | LOG_ERR, 0, fmt, ##args);	\
122 	exit(e);						\
123 } while (0)
124 
125 #define logwarn(fmt, args...)					\
126 	log_or_warn(LOG_DAEMON | LOG_WARNING, errno, fmt, ##args)
127 
128 #define logwarnx(fmt, args...)					\
129 	log_or_warn(LOG_DAEMON | LOG_WARNING, 0, fmt, ##args)
130 
131 /* structures */
132 
133 /* symbol table entry */
134 typedef struct {
135     char *name;
136     int val;
137     int val2;
138 } symtab_t;
139 
140 /* serial PnP ID string */
141 typedef struct {
142     int revision;	/* PnP revision, 100 for 1.00 */
143     char *eisaid;	/* EISA ID including mfr ID and product ID */
144     char *serial;	/* serial No, optional */
145     char *class;	/* device class, optional */
146     char *compat;	/* list of compatible drivers, optional */
147     char *description;	/* product description, optional */
148     int neisaid;	/* length of the above fields... */
149     int nserial;
150     int nclass;
151     int ncompat;
152     int ndescription;
153 } pnpid_t;
154 
155 /* global variables */
156 
157 int	debug = 0;
158 int	nodaemon = FALSE;
159 int	background = FALSE;
160 int	identify = ID_NONE;
161 int	extioctl = FALSE;
162 char	*pidfile = "/var/run/moused.pid";
163 
164 #define SCROLL_NOTSCROLLING	0
165 #define SCROLL_PREPARE		1
166 #define SCROLL_SCROLLING	2
167 
168 static int	scroll_state;
169 static int	scroll_movement;
170 
171 /* local variables */
172 
173 /* interface (the table must be ordered by MOUSE_IF_XXX in mouse.h) */
174 static symtab_t rifs[] = {
175     { "serial",		MOUSE_IF_SERIAL },
176     { "bus",		MOUSE_IF_BUS },
177     { "inport",		MOUSE_IF_INPORT },
178     { "ps/2",		MOUSE_IF_PS2 },
179     { "sysmouse",	MOUSE_IF_SYSMOUSE },
180     { "usb",		MOUSE_IF_USB },
181     { NULL,		MOUSE_IF_UNKNOWN },
182 };
183 
184 /* types (the table must be ordered by MOUSE_PROTO_XXX in mouse.h) */
185 static char *rnames[] = {
186     "microsoft",
187     "mousesystems",
188     "logitech",
189     "mmseries",
190     "mouseman",
191     "busmouse",
192     "inportmouse",
193     "ps/2",
194     "mmhitab",
195     "glidepoint",
196     "intellimouse",
197     "thinkingmouse",
198     "sysmouse",
199     "x10mouseremote",
200     "kidspad",
201     "versapad",
202     "jogdial",
203 #if notyet
204     "mariqua",
205 #endif
206     NULL
207 };
208 
209 /* models */
210 static symtab_t	rmodels[] = {
211     { "NetScroll",		MOUSE_MODEL_NETSCROLL },
212     { "NetMouse/NetScroll Optical", MOUSE_MODEL_NET },
213     { "GlidePoint",		MOUSE_MODEL_GLIDEPOINT },
214     { "ThinkingMouse",		MOUSE_MODEL_THINK },
215     { "IntelliMouse",		MOUSE_MODEL_INTELLI },
216     { "EasyScroll/SmartScroll",	MOUSE_MODEL_EASYSCROLL },
217     { "MouseMan+",		MOUSE_MODEL_MOUSEMANPLUS },
218     { "Kidspad",		MOUSE_MODEL_KIDSPAD },
219     { "VersaPad",		MOUSE_MODEL_VERSAPAD },
220     { "IntelliMouse Explorer",	MOUSE_MODEL_EXPLORER },
221     { "4D Mouse",		MOUSE_MODEL_4D },
222     { "4D+ Mouse",		MOUSE_MODEL_4DPLUS },
223     { "Synaptics Touchpad",	MOUSE_MODEL_SYNAPTICS },
224     { "generic",		MOUSE_MODEL_GENERIC },
225     { NULL,			MOUSE_MODEL_UNKNOWN },
226 };
227 
228 /* PnP EISA/product IDs */
229 static symtab_t pnpprod[] = {
230     /* Kensignton ThinkingMouse */
231     { "KML0001",	MOUSE_PROTO_THINK,	MOUSE_MODEL_THINK },
232     /* MS IntelliMouse */
233     { "MSH0001",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_INTELLI },
234     /* MS IntelliMouse TrackBall */
235     { "MSH0004",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_INTELLI },
236     /* Tremon Wheel Mouse MUSD */
237     { "HTK0001",        MOUSE_PROTO_INTELLI,    MOUSE_MODEL_INTELLI },
238     /* Genius PnP Mouse */
239     { "KYE0001",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
240     /* MouseSystems SmartScroll Mouse (OEM from Genius?) */
241     { "KYE0002",	MOUSE_PROTO_MS,		MOUSE_MODEL_EASYSCROLL },
242     /* Genius NetMouse */
243     { "KYE0003",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_NET },
244     /* Genius Kidspad, Easypad and other tablets */
245     { "KYE0005",	MOUSE_PROTO_KIDSPAD,	MOUSE_MODEL_KIDSPAD },
246     /* Genius EZScroll */
247     { "KYEEZ00",	MOUSE_PROTO_MS,		MOUSE_MODEL_EASYSCROLL },
248     /* Logitech Cordless MouseMan Wheel */
249     { "LGI8033",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_MOUSEMANPLUS },
250     /* Logitech MouseMan (new 4 button model) */
251     { "LGI800C",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_MOUSEMANPLUS },
252     /* Logitech MouseMan+ */
253     { "LGI8050",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_MOUSEMANPLUS },
254     /* Logitech FirstMouse+ */
255     { "LGI8051",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_MOUSEMANPLUS },
256     /* Logitech serial */
257     { "LGI8001",	MOUSE_PROTO_LOGIMOUSEMAN, MOUSE_MODEL_GENERIC },
258     /* A4 Tech 4D/4D+ Mouse */
259     { "A4W0005",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_4D },
260     /* 8D Scroll Mouse */
261     { "PEC9802",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_INTELLI },
262     /* Mitsumi Wireless Scroll Mouse */
263     { "MTM6401",	MOUSE_PROTO_INTELLI,	MOUSE_MODEL_INTELLI },
264 
265     /* MS bus */
266     { "PNP0F00",	MOUSE_PROTO_BUS,	MOUSE_MODEL_GENERIC },
267     /* MS serial */
268     { "PNP0F01",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
269     /* MS InPort */
270     { "PNP0F02",	MOUSE_PROTO_INPORT,	MOUSE_MODEL_GENERIC },
271     /* MS PS/2 */
272     { "PNP0F03",	MOUSE_PROTO_PS2,	MOUSE_MODEL_GENERIC },
273     /*
274      * EzScroll returns PNP0F04 in the compatible device field; but it
275      * doesn't look compatible... XXX
276      */
277     /* MouseSystems */
278     { "PNP0F04",	MOUSE_PROTO_MSC,	MOUSE_MODEL_GENERIC },
279     /* MouseSystems */
280     { "PNP0F05",	MOUSE_PROTO_MSC,	MOUSE_MODEL_GENERIC },
281 #if notyet
282     /* Genius Mouse */
283     { "PNP0F06",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
284     /* Genius Mouse */
285     { "PNP0F07",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
286 #endif
287     /* Logitech serial */
288     { "PNP0F08",	MOUSE_PROTO_LOGIMOUSEMAN, MOUSE_MODEL_GENERIC },
289     /* MS BallPoint serial */
290     { "PNP0F09",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
291     /* MS PnP serial */
292     { "PNP0F0A",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
293     /* MS PnP BallPoint serial */
294     { "PNP0F0B",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
295     /* MS serial comatible */
296     { "PNP0F0C",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
297     /* MS InPort comatible */
298     { "PNP0F0D",	MOUSE_PROTO_INPORT,	MOUSE_MODEL_GENERIC },
299     /* MS PS/2 comatible */
300     { "PNP0F0E",	MOUSE_PROTO_PS2,	MOUSE_MODEL_GENERIC },
301     /* MS BallPoint comatible */
302     { "PNP0F0F",	MOUSE_PROTO_MS,		MOUSE_MODEL_GENERIC },
303 #if notyet
304     /* TI QuickPort */
305     { "PNP0F10",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
306 #endif
307     /* MS bus comatible */
308     { "PNP0F11",	MOUSE_PROTO_BUS,	MOUSE_MODEL_GENERIC },
309     /* Logitech PS/2 */
310     { "PNP0F12",	MOUSE_PROTO_PS2,	MOUSE_MODEL_GENERIC },
311     /* PS/2 */
312     { "PNP0F13",	MOUSE_PROTO_PS2,	MOUSE_MODEL_GENERIC },
313 #if notyet
314     /* MS Kids Mouse */
315     { "PNP0F14",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
316 #endif
317     /* Logitech bus */
318     { "PNP0F15",	MOUSE_PROTO_BUS,	MOUSE_MODEL_GENERIC },
319 #if notyet
320     /* Logitech SWIFT */
321     { "PNP0F16",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
322 #endif
323     /* Logitech serial compat */
324     { "PNP0F17",	MOUSE_PROTO_LOGIMOUSEMAN, MOUSE_MODEL_GENERIC },
325     /* Logitech bus compatible */
326     { "PNP0F18",	MOUSE_PROTO_BUS,	MOUSE_MODEL_GENERIC },
327     /* Logitech PS/2 compatible */
328     { "PNP0F19",	MOUSE_PROTO_PS2,	MOUSE_MODEL_GENERIC },
329 #if notyet
330     /* Logitech SWIFT compatible */
331     { "PNP0F1A",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
332     /* HP Omnibook */
333     { "PNP0F1B",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
334     /* Compaq LTE TrackBall PS/2 */
335     { "PNP0F1C",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
336     /* Compaq LTE TrackBall serial */
337     { "PNP0F1D",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
338     /* MS Kidts Trackball */
339     { "PNP0F1E",	MOUSE_PROTO_XXX,	MOUSE_MODEL_GENERIC },
340 #endif
341     /* Interlink VersaPad */
342     { "LNK0001",	MOUSE_PROTO_VERSAPAD,	MOUSE_MODEL_VERSAPAD },
343 
344     { NULL,		MOUSE_PROTO_UNKNOWN,	MOUSE_MODEL_GENERIC },
345 };
346 
347 /* the table must be ordered by MOUSE_PROTO_XXX in mouse.h */
348 static unsigned short rodentcflags[] =
349 {
350     (CS7	           | CREAD | CLOCAL | HUPCL),	/* MicroSoft */
351     (CS8 | CSTOPB	   | CREAD | CLOCAL | HUPCL),	/* MouseSystems */
352     (CS8 | CSTOPB	   | CREAD | CLOCAL | HUPCL),	/* Logitech */
353     (CS8 | PARENB | PARODD | CREAD | CLOCAL | HUPCL),	/* MMSeries */
354     (CS7		   | CREAD | CLOCAL | HUPCL),	/* MouseMan */
355     0,							/* Bus */
356     0,							/* InPort */
357     0,							/* PS/2 */
358     (CS8		   | CREAD | CLOCAL | HUPCL),	/* MM HitTablet */
359     (CS7	           | CREAD | CLOCAL | HUPCL),	/* GlidePoint */
360     (CS7                   | CREAD | CLOCAL | HUPCL),	/* IntelliMouse */
361     (CS7                   | CREAD | CLOCAL | HUPCL),	/* Thinking Mouse */
362     (CS8 | CSTOPB	   | CREAD | CLOCAL | HUPCL),	/* sysmouse */
363     (CS7	           | CREAD | CLOCAL | HUPCL),	/* X10 MouseRemote */
364     (CS8 | PARENB | PARODD | CREAD | CLOCAL | HUPCL),	/* kidspad etc. */
365     (CS8		   | CREAD | CLOCAL | HUPCL),	/* VersaPad */
366     0,							/* JogDial */
367 #if notyet
368     (CS8 | CSTOPB	   | CREAD | CLOCAL | HUPCL),	/* Mariqua */
369 #endif
370 };
371 
372 static struct rodentparam {
373     int flags;
374     char *portname;		/* /dev/XXX */
375     int rtype;			/* MOUSE_PROTO_XXX */
376     int level;			/* operation level: 0 or greater */
377     int baudrate;
378     int rate;			/* report rate */
379     int resolution;		/* MOUSE_RES_XXX or a positive number */
380     int zmap[4];		/* MOUSE_{X|Y}AXIS or a button number */
381     int wmode;			/* wheel mode button number */
382     int mfd;			/* mouse file descriptor */
383     int cfd;			/* /dev/consolectl file descriptor */
384     int mremsfd;		/* mouse remote server file descriptor */
385     int mremcfd;		/* mouse remote client file descriptor */
386     long clickthreshold;	/* double click speed in msec */
387     long button2timeout;	/* 3 button emulation timeout */
388     mousehw_t hw;		/* mouse device hardware information */
389     mousemode_t mode;		/* protocol information */
390     float accelx;		/* Acceleration in the X axis */
391     float accely;		/* Acceleration in the Y axis */
392     int scrollthreshold;	/* Movement distance before virtual scrolling */
393 } rodent = {
394     .flags = 0,
395     .portname = NULL,
396     .rtype = MOUSE_PROTO_UNKNOWN,
397     .level = -1,
398     .baudrate = 1200,
399     .rate = 0,
400     .resolution = MOUSE_RES_UNKNOWN,
401     .zmap = { 0, 0, 0, 0 },
402     .wmode = 0,
403     .mfd = -1,
404     .cfd = -1,
405     .mremsfd = -1,
406     .mremcfd = -1,
407     .clickthreshold = DFLT_CLICKTHRESHOLD,
408     .button2timeout = DFLT_BUTTON2TIMEOUT,
409     .accelx = 1.0,
410     .accely = 1.0,
411     .scrollthreshold = DFLT_SCROLLTHRESHOLD,
412 };
413 
414 /* button status */
415 struct button_state {
416     int count;		/* 0: up, 1: single click, 2: double click,... */
417     struct timeval tv;	/* timestamp on the last button event */
418 };
419 static struct button_state	bstate[MOUSE_MAXBUTTON]; /* button state */
420 static struct button_state	*mstate[MOUSE_MAXBUTTON];/* mapped button st.*/
421 static struct button_state	zstate[4];		 /* Z/W axis state */
422 
423 /* state machine for 3 button emulation */
424 
425 #define S0	0	/* start */
426 #define S1	1	/* button 1 delayed down */
427 #define S2	2	/* button 3 delayed down */
428 #define S3	3	/* both buttons down -> button 2 down */
429 #define S4	4	/* button 1 delayed up */
430 #define S5	5	/* button 1 down */
431 #define S6	6	/* button 3 down */
432 #define S7	7	/* both buttons down */
433 #define S8	8	/* button 3 delayed up */
434 #define S9	9	/* button 1 or 3 up after S3 */
435 
436 #define A(b1, b3)	(((b1) ? 2 : 0) | ((b3) ? 1 : 0))
437 #define A_TIMEOUT	4
438 #define S_DELAYED(st)	(states[st].s[A_TIMEOUT] != (st))
439 
440 static struct {
441     int s[A_TIMEOUT + 1];
442     int buttons;
443     int mask;
444     int timeout;
445 } states[10] = {
446     /* S0 */
447     { { S0, S2, S1, S3, S0 }, 0, ~(MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN), FALSE },
448     /* S1 */
449     { { S4, S2, S1, S3, S5 }, 0, ~MOUSE_BUTTON1DOWN, FALSE },
450     /* S2 */
451     { { S8, S2, S1, S3, S6 }, 0, ~MOUSE_BUTTON3DOWN, FALSE },
452     /* S3 */
453     { { S0, S9, S9, S3, S3 }, MOUSE_BUTTON2DOWN, ~0, FALSE },
454     /* S4 */
455     { { S0, S2, S1, S3, S0 }, MOUSE_BUTTON1DOWN, ~0, TRUE },
456     /* S5 */
457     { { S0, S2, S5, S7, S5 }, MOUSE_BUTTON1DOWN, ~0, FALSE },
458     /* S6 */
459     { { S0, S6, S1, S7, S6 }, MOUSE_BUTTON3DOWN, ~0, FALSE },
460     /* S7 */
461     { { S0, S6, S5, S7, S7 }, MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN, ~0, FALSE },
462     /* S8 */
463     { { S0, S2, S1, S3, S0 }, MOUSE_BUTTON3DOWN, ~0, TRUE },
464     /* S9 */
465     { { S0, S9, S9, S3, S9 }, 0, ~(MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN), FALSE },
466 };
467 static int		mouse_button_state;
468 static struct timeval	mouse_button_state_tv;
469 static int		mouse_move_delayed;
470 
471 static jmp_buf env;
472 
473 /* function prototypes */
474 
475 static void	moused(void);
476 static void	hup(int sig);
477 static void	cleanup(int sig);
478 static void	usage(void);
479 static void	log_or_warn(int log_pri, int errnum, const char *fmt, ...)
480 		    __printflike(3, 4);
481 
482 static int	r_identify(void);
483 static char	*r_if(int type);
484 static char	*r_name(int type);
485 static char	*r_model(int model);
486 static void	r_init(void);
487 static int	r_protocol(u_char b, mousestatus_t *act);
488 static int	r_statetrans(mousestatus_t *a1, mousestatus_t *a2, int trans);
489 static int	r_installmap(char *arg);
490 static void	r_map(mousestatus_t *act1, mousestatus_t *act2);
491 static void	r_timestamp(mousestatus_t *act);
492 static int	r_timeout(void);
493 static void	r_click(mousestatus_t *act);
494 static void	setmousespeed(int old, int new, unsigned cflag);
495 
496 static int	pnpwakeup1(void);
497 static int	pnpwakeup2(void);
498 static int	pnpgets(char *buf);
499 static int	pnpparse(pnpid_t *id, char *buf, int len);
500 static symtab_t	*pnpproto(pnpid_t *id);
501 
502 static symtab_t	*gettoken(symtab_t *tab, char *s, int len);
503 static char	*gettokenname(symtab_t *tab, int val);
504 
505 static void	mremote_serversetup();
506 static void	mremote_clientchg(int add);
507 
508 static int	kidspad(u_char rxc, mousestatus_t *act);
509 
510 static int	usbmodule(void);
511 
512 int
513 main(int argc, char *argv[])
514 {
515     int c;
516     int	i;
517     int	j;
518     int retry;
519 
520     for (i = 0; i < MOUSE_MAXBUTTON; ++i)
521 	mstate[i] = &bstate[i];
522 
523     while ((c = getopt(argc, argv, "3C:DE:F:I:PRS:VU:a:cdfhi:l:m:p:r:st:w:z:")) != -1)
524 	switch(c) {
525 
526 	case '3':
527 	    rodent.flags |= Emulate3Button;
528 	    break;
529 
530 	case 'E':
531 	    rodent.button2timeout = atoi(optarg);
532 	    if ((rodent.button2timeout < 0) ||
533 		(rodent.button2timeout > MAX_BUTTON2TIMEOUT)) {
534 		warnx("invalid argument `%s'", optarg);
535 		usage();
536 	    }
537 	    break;
538 
539 	case 'a':
540 	    i = sscanf(optarg, "%f,%f", &rodent.accelx, &rodent.accely);
541 	    if (i == 0) {
542 		warnx("invalid acceleration argument '%s'", optarg);
543 		usage();
544 	    }
545 
546 	    if (i == 1)
547 		rodent.accely = rodent.accelx;
548 
549 	    break;
550 
551 	case 'c':
552 	    rodent.flags |= ChordMiddle;
553 	    break;
554 
555 	case 'd':
556 	    ++debug;
557 	    break;
558 
559 	case 'f':
560 	    nodaemon = TRUE;
561 	    break;
562 
563 	case 'i':
564 	    if (strcmp(optarg, "all") == 0)
565 		identify = ID_ALL;
566 	    else if (strcmp(optarg, "port") == 0)
567 		identify = ID_PORT;
568 	    else if (strcmp(optarg, "if") == 0)
569 		identify = ID_IF;
570 	    else if (strcmp(optarg, "type") == 0)
571 		identify = ID_TYPE;
572 	    else if (strcmp(optarg, "model") == 0)
573 		identify = ID_MODEL;
574 	    else {
575 		warnx("invalid argument `%s'", optarg);
576 		usage();
577 	    }
578 	    nodaemon = TRUE;
579 	    break;
580 
581 	case 'l':
582 	    rodent.level = atoi(optarg);
583 	    if ((rodent.level < 0) || (rodent.level > 4)) {
584 		warnx("invalid argument `%s'", optarg);
585 		usage();
586 	    }
587 	    break;
588 
589 	case 'm':
590 	    if (!r_installmap(optarg)) {
591 		warnx("invalid argument `%s'", optarg);
592 		usage();
593 	    }
594 	    break;
595 
596 	case 'p':
597 	    rodent.portname = optarg;
598 	    break;
599 
600 	case 'r':
601 	    if (strcmp(optarg, "high") == 0)
602 		rodent.resolution = MOUSE_RES_HIGH;
603 	    else if (strcmp(optarg, "medium-high") == 0)
604 		rodent.resolution = MOUSE_RES_HIGH;
605 	    else if (strcmp(optarg, "medium-low") == 0)
606 		rodent.resolution = MOUSE_RES_MEDIUMLOW;
607 	    else if (strcmp(optarg, "low") == 0)
608 		rodent.resolution = MOUSE_RES_LOW;
609 	    else if (strcmp(optarg, "default") == 0)
610 		rodent.resolution = MOUSE_RES_DEFAULT;
611 	    else {
612 		rodent.resolution = atoi(optarg);
613 		if (rodent.resolution <= 0) {
614 		    warnx("invalid argument `%s'", optarg);
615 		    usage();
616 		}
617 	    }
618 	    break;
619 
620 	case 's':
621 	    rodent.baudrate = 9600;
622 	    break;
623 
624 	case 'w':
625 	    i = atoi(optarg);
626 	    if ((i <= 0) || (i > MOUSE_MAXBUTTON)) {
627 		warnx("invalid argument `%s'", optarg);
628 		usage();
629 	    }
630 	    rodent.wmode = 1 << (i - 1);
631 	    break;
632 
633 	case 'z':
634 	    if (strcmp(optarg, "x") == 0)
635 		rodent.zmap[0] = MOUSE_XAXIS;
636 	    else if (strcmp(optarg, "y") == 0)
637 		rodent.zmap[0] = MOUSE_YAXIS;
638 	    else {
639 		i = atoi(optarg);
640 		/*
641 		 * Use button i for negative Z axis movement and
642 		 * button (i + 1) for positive Z axis movement.
643 		 */
644 		if ((i <= 0) || (i > MOUSE_MAXBUTTON - 1)) {
645 		    warnx("invalid argument `%s'", optarg);
646 		    usage();
647 		}
648 		rodent.zmap[0] = i;
649 		rodent.zmap[1] = i + 1;
650 		debug("optind: %d, optarg: '%s'", optind, optarg);
651 		for (j = 1; j < 4; ++j) {
652 		    if ((optind >= argc) || !isdigit(*argv[optind]))
653 			break;
654 		    i = atoi(argv[optind]);
655 		    if ((i <= 0) || (i > MOUSE_MAXBUTTON - 1)) {
656 			warnx("invalid argument `%s'", argv[optind]);
657 			usage();
658 		    }
659 		    rodent.zmap[j] = i;
660 		    ++optind;
661 		}
662 		if ((rodent.zmap[2] != 0) && (rodent.zmap[3] == 0))
663 		    rodent.zmap[3] = rodent.zmap[2] + 1;
664 	    }
665 	    break;
666 
667 	case 'C':
668 	    rodent.clickthreshold = atoi(optarg);
669 	    if ((rodent.clickthreshold < 0) ||
670 		(rodent.clickthreshold > MAX_CLICKTHRESHOLD)) {
671 		warnx("invalid argument `%s'", optarg);
672 		usage();
673 	    }
674 	    break;
675 
676 	case 'D':
677 	    rodent.flags |= ClearDTR;
678 	    break;
679 
680 	case 'F':
681 	    rodent.rate = atoi(optarg);
682 	    if (rodent.rate <= 0) {
683 		warnx("invalid argument `%s'", optarg);
684 		usage();
685 	    }
686 	    break;
687 
688 	case 'I':
689 	    pidfile = optarg;
690 	    break;
691 
692 	case 'P':
693 	    rodent.flags |= NoPnP;
694 	    break;
695 
696 	case 'R':
697 	    rodent.flags |= ClearRTS;
698 	    break;
699 
700 	case 'S':
701 	    rodent.baudrate = atoi(optarg);
702 	    if (rodent.baudrate <= 0) {
703 		warnx("invalid argument `%s'", optarg);
704 		usage();
705 	    }
706 	    debug("rodent baudrate %d", rodent.baudrate);
707 	    break;
708 
709 	case 't':
710 	    if (strcmp(optarg, "auto") == 0) {
711 		rodent.rtype = MOUSE_PROTO_UNKNOWN;
712 		rodent.flags &= ~NoPnP;
713 		rodent.level = -1;
714 		break;
715 	    }
716 	    for (i = 0; rnames[i]; i++)
717 		if (strcmp(optarg, rnames[i]) == 0) {
718 		    rodent.rtype = i;
719 		    rodent.flags |= NoPnP;
720 		    rodent.level = (i == MOUSE_PROTO_SYSMOUSE) ? 1 : 0;
721 		    break;
722 		}
723 	    if (rnames[i])
724 		break;
725 	    warnx("no such mouse type `%s'", optarg);
726 	    usage();
727 
728 	case 'V':
729 	    rodent.flags |= VirtualScroll;
730 	    break;
731 	case 'U':
732 	    rodent.scrollthreshold = atoi(optarg);
733 	    if (rodent.scrollthreshold < 0) {
734 		warnx("invalid argument `%s'", optarg);
735 		usage();
736 	    }
737 	    break;
738 
739 	case 'h':
740 	case '?':
741 	default:
742 	    usage();
743 	}
744 
745     /* fix Z axis mapping */
746     for (i = 0; i < 4; ++i) {
747 	if (rodent.zmap[i] > 0) {
748 	    for (j = 0; j < MOUSE_MAXBUTTON; ++j) {
749 		if (mstate[j] == &bstate[rodent.zmap[i] - 1])
750 		    mstate[j] = &zstate[i];
751 	    }
752 	    rodent.zmap[i] = 1 << (rodent.zmap[i] - 1);
753 	}
754     }
755 
756     /* the default port name */
757     switch(rodent.rtype) {
758 
759     case MOUSE_PROTO_INPORT:
760 	/* INPORT and BUS are the same... */
761 	rodent.rtype = MOUSE_PROTO_BUS;
762 	/* FALLTHROUGH */
763     case MOUSE_PROTO_BUS:
764 	if (!rodent.portname)
765 	    rodent.portname = "/dev/mse0";
766 	break;
767 
768     case MOUSE_PROTO_PS2:
769 	if (!rodent.portname)
770 	    rodent.portname = "/dev/psm0";
771 	break;
772 
773     default:
774 	if (rodent.portname)
775 	    break;
776 	warnx("no port name specified");
777 	usage();
778     }
779 
780     retry = 1;
781     if (strncmp(rodent.portname, "/dev/ums", 8) == 0) {
782 	if (usbmodule() != 0)
783 	    retry = 5;
784     }
785 
786     for (;;) {
787 	if (setjmp(env) == 0) {
788 	    signal(SIGHUP, hup);
789 	    signal(SIGINT , cleanup);
790 	    signal(SIGQUIT, cleanup);
791 	    signal(SIGTERM, cleanup);
792 	    for (i = 0; i < retry; ++i) {
793 		if (i > 0)
794 		    sleep(2);
795 		rodent.mfd = open(rodent.portname, O_RDWR | O_NONBLOCK);
796 		if (rodent.mfd != -1 || errno != ENOENT)
797 		    break;
798 	    }
799 	    if (rodent.mfd == -1)
800 		logerr(1, "unable to open %s", rodent.portname);
801 	    if (r_identify() == MOUSE_PROTO_UNKNOWN) {
802 		logwarnx("cannot determine mouse type on %s", rodent.portname);
803 		close(rodent.mfd);
804 		rodent.mfd = -1;
805 	    }
806 
807 	    /* print some information */
808 	    if (identify != ID_NONE) {
809 		if (identify == ID_ALL)
810 		    printf("%s %s %s %s\n",
811 			rodent.portname, r_if(rodent.hw.iftype),
812 			r_name(rodent.rtype), r_model(rodent.hw.model));
813 		else if (identify & ID_PORT)
814 		    printf("%s\n", rodent.portname);
815 		else if (identify & ID_IF)
816 		    printf("%s\n", r_if(rodent.hw.iftype));
817 		else if (identify & ID_TYPE)
818 		    printf("%s\n", r_name(rodent.rtype));
819 		else if (identify & ID_MODEL)
820 		    printf("%s\n", r_model(rodent.hw.model));
821 		exit(0);
822 	    } else {
823 		debug("port: %s  interface: %s  type: %s  model: %s",
824 		    rodent.portname, r_if(rodent.hw.iftype),
825 		    r_name(rodent.rtype), r_model(rodent.hw.model));
826 	    }
827 
828 	    if (rodent.mfd == -1) {
829 		/*
830 		 * We cannot continue because of error.  Exit if the
831 		 * program has not become a daemon.  Otherwise, block
832 		 * until the the user corrects the problem and issues SIGHUP.
833 		 */
834 		if (!background)
835 		    exit(1);
836 		sigpause(0);
837 	    }
838 
839 	    r_init();			/* call init function */
840 	    moused();
841 	}
842 
843 	if (rodent.mfd != -1)
844 	    close(rodent.mfd);
845 	if (rodent.cfd != -1)
846 	    close(rodent.cfd);
847 	rodent.mfd = rodent.cfd = -1;
848     }
849     /* NOT REACHED */
850 
851     exit(0);
852 }
853 
854 static int
855 usbmodule(void)
856 {
857     struct kld_file_stat fstat;
858     struct module_stat mstat;
859     int fileid, modid;
860     int loaded;
861 
862     for (loaded = 0, fileid = kldnext(0); !loaded && fileid > 0;
863 	 fileid = kldnext(fileid)) {
864 	fstat.version = sizeof(fstat);
865 	if (kldstat(fileid, &fstat) < 0)
866 	    continue;
867 	if (strncmp(fstat.name, "uhub/ums", 8) == 0) {
868 	    loaded = 1;
869 	    break;
870 	}
871 	for (modid = kldfirstmod(fileid); modid > 0;
872 	     modid = modfnext(modid)) {
873 	    mstat.version = sizeof(mstat);
874 	    if (modstat(modid, &mstat) < 0)
875 		continue;
876 	    if (strncmp(mstat.name, "uhub/ums", 8) == 0) {
877 		loaded = 1;
878 		break;
879 	    }
880 	}
881     }
882     if (!loaded) {
883 	if (kldload("ums") != -1)
884 	    return 1;
885 	if (errno != EEXIST)
886 	    logerr(1, "unable to load USB mouse driver");
887     }
888     return 0;
889 }
890 
891 static void
892 moused(void)
893 {
894     struct mouse_info mouse;
895     mousestatus_t action0;		/* original mouse action */
896     mousestatus_t action;		/* interrim buffer */
897     mousestatus_t action2;		/* mapped action */
898     struct timeval timeout;
899     fd_set fds;
900     u_char b;
901     FILE *fp;
902     int flags;
903     int c;
904     int i;
905 
906     if ((rodent.cfd = open("/dev/consolectl", O_RDWR, 0)) == -1)
907 	logerr(1, "cannot open /dev/consolectl");
908 
909     if (!nodaemon && !background) {
910 	if (daemon(0, 0)) {
911 	    logerr(1, "failed to become a daemon");
912 	} else {
913 	    background = TRUE;
914 	    fp = fopen(pidfile, "w");
915 	    if (fp != NULL) {
916 		fprintf(fp, "%d\n", getpid());
917 		fclose(fp);
918 	    }
919 	}
920     }
921 
922     /* clear mouse data */
923     bzero(&action0, sizeof(action0));
924     bzero(&action, sizeof(action));
925     bzero(&action2, sizeof(action2));
926     bzero(&mouse, sizeof(mouse));
927     mouse_button_state = S0;
928     gettimeofday(&mouse_button_state_tv, NULL);
929     mouse_move_delayed = 0;
930     for (i = 0; i < MOUSE_MAXBUTTON; ++i) {
931 	bstate[i].count = 0;
932 	bstate[i].tv = mouse_button_state_tv;
933     }
934     for (i = 0; i < sizeof(zstate)/sizeof(zstate[0]); ++i) {
935 	zstate[i].count = 0;
936 	zstate[i].tv = mouse_button_state_tv;
937     }
938 
939     /* choose which ioctl command to use */
940     mouse.operation = MOUSE_MOTION_EVENT;
941     extioctl = (ioctl(rodent.cfd, CONS_MOUSECTL, &mouse) == 0);
942 
943     /* process mouse data */
944     timeout.tv_sec = 0;
945     timeout.tv_usec = 20000;		/* 20 msec */
946     for (;;) {
947 
948 	FD_ZERO(&fds);
949 	FD_SET(rodent.mfd, &fds);
950 	if (rodent.mremsfd >= 0)
951 	    FD_SET(rodent.mremsfd, &fds);
952 	if (rodent.mremcfd >= 0)
953 	    FD_SET(rodent.mremcfd, &fds);
954 
955 	c = select(FD_SETSIZE, &fds, NULL, NULL,
956 		   (rodent.flags & Emulate3Button) ? &timeout : NULL);
957 	if (c < 0) {                    /* error */
958 	    logwarn("failed to read from mouse");
959 	    continue;
960 	} else if (c == 0) {            /* timeout */
961 	    /* assert(rodent.flags & Emulate3Button) */
962 	    action0.button = action0.obutton;
963 	    action0.dx = action0.dy = action0.dz = 0;
964 	    action0.flags = flags = 0;
965 	    if (r_timeout() && r_statetrans(&action0, &action, A_TIMEOUT)) {
966 		if (debug > 2)
967 		    debug("flags:%08x buttons:%08x obuttons:%08x",
968 			  action.flags, action.button, action.obutton);
969 	    } else {
970 		action0.obutton = action0.button;
971 		continue;
972 	    }
973 	} else {
974 	    /*  MouseRemote client connect/disconnect  */
975 	    if ((rodent.mremsfd >= 0) && FD_ISSET(rodent.mremsfd, &fds)) {
976 		mremote_clientchg(TRUE);
977 		continue;
978 	    }
979 	    if ((rodent.mremcfd >= 0) && FD_ISSET(rodent.mremcfd, &fds)) {
980 		mremote_clientchg(FALSE);
981 		continue;
982 	    }
983 	    /* mouse movement */
984 	    if (read(rodent.mfd, &b, 1) == -1) {
985 		if (errno == EWOULDBLOCK)
986 		    continue;
987 		else
988 		    return;
989 	    }
990 	    if ((flags = r_protocol(b, &action0)) == 0)
991 		continue;
992 
993 	    if (rodent.flags & VirtualScroll) {
994 		/* Allow middle button drags to scroll up and down */
995 		if (action0.button == MOUSE_BUTTON2DOWN) {
996 		    if (scroll_state == SCROLL_NOTSCROLLING) {
997 			scroll_state = SCROLL_PREPARE;
998 			debug("PREPARING TO SCROLL");
999 		    }
1000 		    debug("[BUTTON2] flags:%08x buttons:%08x obuttons:%08x",
1001 			  action.flags, action.button, action.obutton);
1002 		} else {
1003 		    debug("[NOTBUTTON2] flags:%08x buttons:%08x obuttons:%08x",
1004 			  action.flags, action.button, action.obutton);
1005 
1006 		    /* This isn't a middle button down... move along... */
1007 		    if (scroll_state == SCROLL_SCROLLING) {
1008 			/*
1009 			 * We were scrolling, someone let go of button 2.
1010 			 * Now turn autoscroll off.
1011 			 */
1012 			scroll_state = SCROLL_NOTSCROLLING;
1013 			debug("DONE WITH SCROLLING / %d", scroll_state);
1014 		    } else if (scroll_state == SCROLL_PREPARE) {
1015 			mousestatus_t newaction = action0;
1016 
1017 			/* We were preparing to scroll, but we never moved... */
1018 			r_timestamp(&action0);
1019 			r_statetrans(&action0, &newaction,
1020 				     A(newaction.button & MOUSE_BUTTON1DOWN,
1021 				       action0.button & MOUSE_BUTTON3DOWN));
1022 
1023 			/* Send middle down */
1024 			newaction.button = MOUSE_BUTTON2DOWN;
1025 			r_click(&newaction);
1026 
1027 			/* Send middle up */
1028 			r_timestamp(&newaction);
1029 			newaction.obutton = newaction.button;
1030 			newaction.button = action0.button;
1031 			r_click(&newaction);
1032 		    }
1033 		}
1034 	    }
1035 
1036 	    r_timestamp(&action0);
1037 	    r_statetrans(&action0, &action,
1038 			 A(action0.button & MOUSE_BUTTON1DOWN,
1039 			   action0.button & MOUSE_BUTTON3DOWN));
1040 	    debug("flags:%08x buttons:%08x obuttons:%08x", action.flags,
1041 		  action.button, action.obutton);
1042 	}
1043 	action0.obutton = action0.button;
1044 	flags &= MOUSE_POSCHANGED;
1045 	flags |= action.obutton ^ action.button;
1046 	action.flags = flags;
1047 
1048 	if (flags) {			/* handler detected action */
1049 	    r_map(&action, &action2);
1050 	    debug("activity : buttons 0x%08x  dx %d  dy %d  dz %d",
1051 		action2.button, action2.dx, action2.dy, action2.dz);
1052 
1053 	    if (rodent.flags & VirtualScroll) {
1054 		/*
1055 		 * If *only* the middle button is pressed AND we are moving
1056 		 * the stick/trackpoint/nipple, scroll!
1057 		 */
1058 		if (scroll_state == SCROLL_PREPARE) {
1059 		    /* Ok, Set we're really scrolling now.... */
1060 		    if (action2.dy || action2.dx)
1061 			scroll_state = SCROLL_SCROLLING;
1062 		}
1063 		if (scroll_state == SCROLL_SCROLLING) {
1064 		    scroll_movement += action2.dy;
1065 		    debug("SCROLL: %d", scroll_movement);
1066 
1067 		    if (scroll_movement < -rodent.scrollthreshold) {
1068 			/* Scroll down */
1069 			action2.dz = -1;
1070 			scroll_movement = 0;
1071 		    }
1072 		    else if (scroll_movement > rodent.scrollthreshold) {
1073 			/* Scroll up */
1074 			action2.dz = 1;
1075 			scroll_movement = 0;
1076 		    }
1077 
1078 		    /* Don't move while scrolling */
1079 		    action2.dx = action2.dy = 0;
1080 		}
1081 	    }
1082 
1083 	    if (extioctl) {
1084 		/* Defer clicks until we aren't VirtualScroll'ing. */
1085 		if (scroll_state == SCROLL_NOTSCROLLING)
1086 		    r_click(&action2);
1087 
1088 		if (action2.flags & MOUSE_POSCHANGED) {
1089 		    mouse.operation = MOUSE_MOTION_EVENT;
1090 		    mouse.u.data.buttons = action2.button;
1091 		    mouse.u.data.x = action2.dx * rodent.accelx;
1092 		    mouse.u.data.y = action2.dy * rodent.accely;
1093 		    mouse.u.data.z = action2.dz;
1094 		    if (debug < 2)
1095 			ioctl(rodent.cfd, CONS_MOUSECTL, &mouse);
1096 		}
1097 	    } else {
1098 		mouse.operation = MOUSE_ACTION;
1099 		mouse.u.data.buttons = action2.button;
1100 		mouse.u.data.x = action2.dx * rodent.accelx;
1101 		mouse.u.data.y = action2.dy * rodent.accely;
1102 		mouse.u.data.z = action2.dz;
1103 		if (debug < 2)
1104 		    ioctl(rodent.cfd, CONS_MOUSECTL, &mouse);
1105 	    }
1106 
1107 	    /*
1108 	     * If the Z axis movement is mapped to an imaginary physical
1109 	     * button, we need to cook up a corresponding button `up' event
1110 	     * after sending a button `down' event.
1111 	     */
1112 	    if ((rodent.zmap[0] > 0) && (action.dz != 0)) {
1113 		action.obutton = action.button;
1114 		action.dx = action.dy = action.dz = 0;
1115 		r_map(&action, &action2);
1116 		debug("activity : buttons 0x%08x  dx %d  dy %d  dz %d",
1117 		    action2.button, action2.dx, action2.dy, action2.dz);
1118 
1119 		if (extioctl) {
1120 		    r_click(&action2);
1121 		} else {
1122 		    mouse.operation = MOUSE_ACTION;
1123 		    mouse.u.data.buttons = action2.button;
1124 		    mouse.u.data.x = mouse.u.data.y = mouse.u.data.z = 0;
1125 		    if (debug < 2)
1126 			ioctl(rodent.cfd, CONS_MOUSECTL, &mouse);
1127 		}
1128 	    }
1129 	}
1130     }
1131     /* NOT REACHED */
1132 }
1133 
1134 static void
1135 hup(int sig)
1136 {
1137     longjmp(env, 1);
1138 }
1139 
1140 static void
1141 cleanup(int sig)
1142 {
1143     if (rodent.rtype == MOUSE_PROTO_X10MOUSEREM)
1144 	unlink(_PATH_MOUSEREMOTE);
1145     exit(0);
1146 }
1147 
1148 /**
1149  ** usage
1150  **
1151  ** Complain, and free the CPU for more worthy tasks
1152  **/
1153 static void
1154 usage(void)
1155 {
1156     fprintf(stderr, "%s\n%s\n%s\n%s\n",
1157 	"usage: moused [-DRcdfs] [-I file] [-F rate] [-r resolution] [-S baudrate]",
1158 	"              [-V [-U threshold]] [-a X [,Y]] [-C threshold] [-m N=M] [-w N]",
1159 	"              [-z N] [-t <mousetype>] [-l level] [-3 [-E timeout]] -p <port>",
1160 	"       moused [-d] -i <port|if|type|model|all> -p <port>");
1161     exit(1);
1162 }
1163 
1164 /*
1165  * Output an error message to syslog or stderr as appropriate. If
1166  * `errnum' is non-zero, append its string form to the message.
1167  */
1168 static void
1169 log_or_warn(int log_pri, int errnum, const char *fmt, ...)
1170 {
1171 	va_list ap;
1172 	char buf[256];
1173 
1174 	va_start(ap, fmt);
1175 	vsnprintf(buf, sizeof(buf), fmt, ap);
1176 	va_end(ap);
1177 	if (errnum) {
1178 		strlcat(buf, ": ", sizeof(buf));
1179 		strlcat(buf, strerror(errnum), sizeof(buf));
1180 	}
1181 
1182 	if (background)
1183 		syslog(log_pri, "%s", buf);
1184 	else
1185 		warnx("%s", buf);
1186 }
1187 
1188 /**
1189  ** Mouse interface code, courtesy of XFree86 3.1.2.
1190  **
1191  ** Note: Various bits have been trimmed, and in my shortsighted enthusiasm
1192  ** to clean, reformat and rationalise naming, it's quite possible that
1193  ** some things in here have been broken.
1194  **
1195  ** I hope not 8)
1196  **
1197  ** The following code is derived from a module marked :
1198  **/
1199 
1200 /* $XConsortium: xf86_Mouse.c,v 1.2 94/10/12 20:33:21 kaleb Exp $ */
1201 /* $XFree86: xc/programs/Xserver/hw/xfree86/common/xf86_Mouse.c,v 3.2 1995/01/28
1202  17:03:40 dawes Exp $ */
1203 /*
1204  *
1205  * Copyright 1990,91 by Thomas Roell, Dinkelscherben, Germany.
1206  * Copyright 1993 by David Dawes <dawes@physics.su.oz.au>
1207  *
1208  * Permission to use, copy, modify, distribute, and sell this software and its
1209  * documentation for any purpose is hereby granted without fee, provided that
1210  * the above copyright notice appear in all copies and that both that
1211  * copyright notice and this permission notice appear in supporting
1212  * documentation, and that the names of Thomas Roell and David Dawes not be
1213  * used in advertising or publicity pertaining to distribution of the
1214  * software without specific, written prior permission.  Thomas Roell
1215  * and David Dawes makes no representations about the suitability of this
1216  * software for any purpose.  It is provided "as is" without express or
1217  * implied warranty.
1218  *
1219  * THOMAS ROELL AND DAVID DAWES DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
1220  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
1221  * FITNESS, IN NO EVENT SHALL THOMAS ROELL OR DAVID DAWES BE LIABLE FOR ANY
1222  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
1223  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
1224  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
1225  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1226  *
1227  */
1228 
1229 /**
1230  ** GlidePoint support from XFree86 3.2.
1231  ** Derived from the module:
1232  **/
1233 
1234 /* $XFree86: xc/programs/Xserver/hw/xfree86/common/xf86_Mouse.c,v 3.19 1996/10/16 14:40:51 dawes Exp $ */
1235 /* $XConsortium: xf86_Mouse.c /main/10 1996/01/30 15:16:12 kaleb $ */
1236 
1237 /* the following table must be ordered by MOUSE_PROTO_XXX in mouse.h */
1238 static unsigned char proto[][7] = {
1239     /*  hd_mask hd_id   dp_mask dp_id   bytes b4_mask b4_id */
1240     {	0x40,	0x40,	0x40,	0x00,	3,   ~0x23,  0x00 }, /* MicroSoft */
1241     {	0xf8,	0x80,	0x00,	0x00,	5,    0x00,  0xff }, /* MouseSystems */
1242     {	0xe0,	0x80,	0x80,	0x00,	3,    0x00,  0xff }, /* Logitech */
1243     {	0xe0,	0x80,	0x80,	0x00,	3,    0x00,  0xff }, /* MMSeries */
1244     {	0x40,	0x40,	0x40,	0x00,	3,   ~0x33,  0x00 }, /* MouseMan */
1245     {	0xf8,	0x80,	0x00,	0x00,	5,    0x00,  0xff }, /* Bus */
1246     {	0xf8,	0x80,	0x00,	0x00,	5,    0x00,  0xff }, /* InPort */
1247     {	0xc0,	0x00,	0x00,	0x00,	3,    0x00,  0xff }, /* PS/2 mouse */
1248     {	0xe0,	0x80,	0x80,	0x00,	3,    0x00,  0xff }, /* MM HitTablet */
1249     {	0x40,	0x40,	0x40,	0x00,	3,   ~0x33,  0x00 }, /* GlidePoint */
1250     {	0x40,	0x40,	0x40,	0x00,	3,   ~0x3f,  0x00 }, /* IntelliMouse */
1251     {	0x40,	0x40,	0x40,	0x00,	3,   ~0x33,  0x00 }, /* ThinkingMouse */
1252     {	0xf8,	0x80,	0x00,	0x00,	5,    0x00,  0xff }, /* sysmouse */
1253     {	0x40,	0x40,	0x40,	0x00,	3,   ~0x23,  0x00 }, /* X10 MouseRem */
1254     {	0x80,	0x80,	0x00,	0x00,	5,    0x00,  0xff }, /* KIDSPAD */
1255     {	0xc3,	0xc0,	0x00,	0x00,	6,    0x00,  0xff }, /* VersaPad */
1256     {	0x00,	0x00,	0x00,	0x00,	1,    0x00,  0xff }, /* JogDial */
1257 #if notyet
1258     {	0xf8,	0x80,	0x00,	0x00,	5,   ~0x2f,  0x10 }, /* Mariqua */
1259 #endif
1260 };
1261 static unsigned char cur_proto[7];
1262 
1263 static int
1264 r_identify(void)
1265 {
1266     char pnpbuf[256];	/* PnP identifier string may be up to 256 bytes long */
1267     pnpid_t pnpid;
1268     symtab_t *t;
1269     int level;
1270     int len;
1271 
1272     /* set the driver operation level, if applicable */
1273     if (rodent.level < 0)
1274 	rodent.level = 1;
1275     ioctl(rodent.mfd, MOUSE_SETLEVEL, &rodent.level);
1276     rodent.level = (ioctl(rodent.mfd, MOUSE_GETLEVEL, &level) == 0) ? level : 0;
1277 
1278     /*
1279      * Interrogate the driver and get some intelligence on the device...
1280      * The following ioctl functions are not always supported by device
1281      * drivers.  When the driver doesn't support them, we just trust the
1282      * user to supply valid information.
1283      */
1284     rodent.hw.iftype = MOUSE_IF_UNKNOWN;
1285     rodent.hw.model = MOUSE_MODEL_GENERIC;
1286     ioctl(rodent.mfd, MOUSE_GETHWINFO, &rodent.hw);
1287 
1288     if (rodent.rtype != MOUSE_PROTO_UNKNOWN)
1289 	bcopy(proto[rodent.rtype], cur_proto, sizeof(cur_proto));
1290     rodent.mode.protocol = MOUSE_PROTO_UNKNOWN;
1291     rodent.mode.rate = -1;
1292     rodent.mode.resolution = MOUSE_RES_UNKNOWN;
1293     rodent.mode.accelfactor = 0;
1294     rodent.mode.level = 0;
1295     if (ioctl(rodent.mfd, MOUSE_GETMODE, &rodent.mode) == 0) {
1296 	if ((rodent.mode.protocol == MOUSE_PROTO_UNKNOWN)
1297 	    || (rodent.mode.protocol >= sizeof(proto)/sizeof(proto[0]))) {
1298 	    logwarnx("unknown mouse protocol (%d)", rodent.mode.protocol);
1299 	    return MOUSE_PROTO_UNKNOWN;
1300 	} else {
1301 	    /* INPORT and BUS are the same... */
1302 	    if (rodent.mode.protocol == MOUSE_PROTO_INPORT)
1303 		rodent.mode.protocol = MOUSE_PROTO_BUS;
1304 	    if (rodent.mode.protocol != rodent.rtype) {
1305 		/* Hmm, the driver doesn't agree with the user... */
1306 		if (rodent.rtype != MOUSE_PROTO_UNKNOWN)
1307 		    logwarnx("mouse type mismatch (%s != %s), %s is assumed",
1308 			r_name(rodent.mode.protocol), r_name(rodent.rtype),
1309 			r_name(rodent.mode.protocol));
1310 		rodent.rtype = rodent.mode.protocol;
1311 		bcopy(proto[rodent.rtype], cur_proto, sizeof(cur_proto));
1312 	    }
1313 	}
1314 	cur_proto[4] = rodent.mode.packetsize;
1315 	cur_proto[0] = rodent.mode.syncmask[0];	/* header byte bit mask */
1316 	cur_proto[1] = rodent.mode.syncmask[1];	/* header bit pattern */
1317     }
1318 
1319     /* maybe this is a PnP mouse... */
1320     if (rodent.mode.protocol == MOUSE_PROTO_UNKNOWN) {
1321 
1322 	if (rodent.flags & NoPnP)
1323 	    return rodent.rtype;
1324 	if (((len = pnpgets(pnpbuf)) <= 0) || !pnpparse(&pnpid, pnpbuf, len))
1325 	    return rodent.rtype;
1326 
1327 	debug("PnP serial mouse: '%*.*s' '%*.*s' '%*.*s'",
1328 	    pnpid.neisaid, pnpid.neisaid, pnpid.eisaid,
1329 	    pnpid.ncompat, pnpid.ncompat, pnpid.compat,
1330 	    pnpid.ndescription, pnpid.ndescription, pnpid.description);
1331 
1332 	/* we have a valid PnP serial device ID */
1333 	rodent.hw.iftype = MOUSE_IF_SERIAL;
1334 	t = pnpproto(&pnpid);
1335 	if (t != NULL) {
1336 	    rodent.mode.protocol = t->val;
1337 	    rodent.hw.model = t->val2;
1338 	} else {
1339 	    rodent.mode.protocol = MOUSE_PROTO_UNKNOWN;
1340 	}
1341 	if (rodent.mode.protocol == MOUSE_PROTO_INPORT)
1342 	    rodent.mode.protocol = MOUSE_PROTO_BUS;
1343 
1344 	/* make final adjustment */
1345 	if (rodent.mode.protocol != MOUSE_PROTO_UNKNOWN) {
1346 	    if (rodent.mode.protocol != rodent.rtype) {
1347 		/* Hmm, the device doesn't agree with the user... */
1348 		if (rodent.rtype != MOUSE_PROTO_UNKNOWN)
1349 		    logwarnx("mouse type mismatch (%s != %s), %s is assumed",
1350 			r_name(rodent.mode.protocol), r_name(rodent.rtype),
1351 			r_name(rodent.mode.protocol));
1352 		rodent.rtype = rodent.mode.protocol;
1353 		bcopy(proto[rodent.rtype], cur_proto, sizeof(cur_proto));
1354 	    }
1355 	}
1356     }
1357 
1358     debug("proto params: %02x %02x %02x %02x %d %02x %02x",
1359 	cur_proto[0], cur_proto[1], cur_proto[2], cur_proto[3],
1360 	cur_proto[4], cur_proto[5], cur_proto[6]);
1361 
1362     return rodent.rtype;
1363 }
1364 
1365 static char *
1366 r_if(int iftype)
1367 {
1368     char *s;
1369 
1370     s = gettokenname(rifs, iftype);
1371     return (s == NULL) ? "unknown" : s;
1372 }
1373 
1374 static char *
1375 r_name(int type)
1376 {
1377     return ((type == MOUSE_PROTO_UNKNOWN)
1378 	|| (type > sizeof(rnames)/sizeof(rnames[0]) - 1))
1379 	? "unknown" : rnames[type];
1380 }
1381 
1382 static char *
1383 r_model(int model)
1384 {
1385     char *s;
1386 
1387     s = gettokenname(rmodels, model);
1388     return (s == NULL) ? "unknown" : s;
1389 }
1390 
1391 static void
1392 r_init(void)
1393 {
1394     unsigned char buf[16];	/* scrach buffer */
1395     fd_set fds;
1396     char *s;
1397     char c;
1398     int i;
1399 
1400     /**
1401      ** This comment is a little out of context here, but it contains
1402      ** some useful information...
1403      ********************************************************************
1404      **
1405      ** The following lines take care of the Logitech MouseMan protocols.
1406      **
1407      ** NOTE: There are different versions of both MouseMan and TrackMan!
1408      **       Hence I add another protocol P_LOGIMAN, which the user can
1409      **       specify as MouseMan in his XF86Config file. This entry was
1410      **       formerly handled as a special case of P_MS. However, people
1411      **       who don't have the middle button problem, can still specify
1412      **       Microsoft and use P_MS.
1413      **
1414      ** By default, these mice should use a 3 byte Microsoft protocol
1415      ** plus a 4th byte for the middle button. However, the mouse might
1416      ** have switched to a different protocol before we use it, so I send
1417      ** the proper sequence just in case.
1418      **
1419      ** NOTE: - all commands to (at least the European) MouseMan have to
1420      **         be sent at 1200 Baud.
1421      **       - each command starts with a '*'.
1422      **       - whenever the MouseMan receives a '*', it will switch back
1423      **	 to 1200 Baud. Hence I have to select the desired protocol
1424      **	 first, then select the baud rate.
1425      **
1426      ** The protocols supported by the (European) MouseMan are:
1427      **   -  5 byte packed binary protocol, as with the Mouse Systems
1428      **      mouse. Selected by sequence "*U".
1429      **   -  2 button 3 byte MicroSoft compatible protocol. Selected
1430      **      by sequence "*V".
1431      **   -  3 button 3+1 byte MicroSoft compatible protocol (default).
1432      **      Selected by sequence "*X".
1433      **
1434      ** The following baud rates are supported:
1435      **   -  1200 Baud (default). Selected by sequence "*n".
1436      **   -  9600 Baud. Selected by sequence "*q".
1437      **
1438      ** Selecting a sample rate is no longer supported with the MouseMan!
1439      ** Some additional lines in xf86Config.c take care of ill configured
1440      ** baud rates and sample rates. (The user will get an error.)
1441      */
1442 
1443     switch (rodent.rtype) {
1444 
1445     case MOUSE_PROTO_LOGI:
1446 	/*
1447 	 * The baud rate selection command must be sent at the current
1448 	 * baud rate; try all likely settings
1449 	 */
1450 	setmousespeed(9600, rodent.baudrate, rodentcflags[rodent.rtype]);
1451 	setmousespeed(4800, rodent.baudrate, rodentcflags[rodent.rtype]);
1452 	setmousespeed(2400, rodent.baudrate, rodentcflags[rodent.rtype]);
1453 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1454 	/* select MM series data format */
1455 	write(rodent.mfd, "S", 1);
1456 	setmousespeed(rodent.baudrate, rodent.baudrate,
1457 		      rodentcflags[MOUSE_PROTO_MM]);
1458 	/* select report rate/frequency */
1459 	if      (rodent.rate <= 0)   write(rodent.mfd, "O", 1);
1460 	else if (rodent.rate <= 15)  write(rodent.mfd, "J", 1);
1461 	else if (rodent.rate <= 27)  write(rodent.mfd, "K", 1);
1462 	else if (rodent.rate <= 42)  write(rodent.mfd, "L", 1);
1463 	else if (rodent.rate <= 60)  write(rodent.mfd, "R", 1);
1464 	else if (rodent.rate <= 85)  write(rodent.mfd, "M", 1);
1465 	else if (rodent.rate <= 125) write(rodent.mfd, "Q", 1);
1466 	else			     write(rodent.mfd, "N", 1);
1467 	break;
1468 
1469     case MOUSE_PROTO_LOGIMOUSEMAN:
1470 	/* The command must always be sent at 1200 baud */
1471 	setmousespeed(1200, 1200, rodentcflags[rodent.rtype]);
1472 	write(rodent.mfd, "*X", 2);
1473 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1474 	break;
1475 
1476     case MOUSE_PROTO_HITTAB:
1477 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1478 
1479 	/*
1480 	 * Initialize Hitachi PUMA Plus - Model 1212E to desired settings.
1481 	 * The tablet must be configured to be in MM mode, NO parity,
1482 	 * Binary Format.  xf86Info.sampleRate controls the sensativity
1483 	 * of the tablet.  We only use this tablet for it's 4-button puck
1484 	 * so we don't run in "Absolute Mode"
1485 	 */
1486 	write(rodent.mfd, "z8", 2);	/* Set Parity = "NONE" */
1487 	usleep(50000);
1488 	write(rodent.mfd, "zb", 2);	/* Set Format = "Binary" */
1489 	usleep(50000);
1490 	write(rodent.mfd, "@", 1);	/* Set Report Mode = "Stream" */
1491 	usleep(50000);
1492 	write(rodent.mfd, "R", 1);	/* Set Output Rate = "45 rps" */
1493 	usleep(50000);
1494 	write(rodent.mfd, "I\x20", 2);	/* Set Incrememtal Mode "20" */
1495 	usleep(50000);
1496 	write(rodent.mfd, "E", 1);	/* Set Data Type = "Relative */
1497 	usleep(50000);
1498 
1499 	/* Resolution is in 'lines per inch' on the Hitachi tablet */
1500 	if      (rodent.resolution == MOUSE_RES_LOW)		c = 'g';
1501 	else if (rodent.resolution == MOUSE_RES_MEDIUMLOW)	c = 'e';
1502 	else if (rodent.resolution == MOUSE_RES_MEDIUMHIGH)	c = 'h';
1503 	else if (rodent.resolution == MOUSE_RES_HIGH)		c = 'd';
1504 	else if (rodent.resolution <=   40)			c = 'g';
1505 	else if (rodent.resolution <=  100)			c = 'd';
1506 	else if (rodent.resolution <=  200)			c = 'e';
1507 	else if (rodent.resolution <=  500)			c = 'h';
1508 	else if (rodent.resolution <= 1000)			c = 'j';
1509 	else			c = 'd';
1510 	write(rodent.mfd, &c, 1);
1511 	usleep(50000);
1512 
1513 	write(rodent.mfd, "\021", 1);	/* Resume DATA output */
1514 	break;
1515 
1516     case MOUSE_PROTO_THINK:
1517 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1518 	/* the PnP ID string may be sent again, discard it */
1519 	usleep(200000);
1520 	i = FREAD;
1521 	ioctl(rodent.mfd, TIOCFLUSH, &i);
1522 	/* send the command to initialize the beast */
1523 	for (s = "E5E5"; *s; ++s) {
1524 	    write(rodent.mfd, s, 1);
1525 	    FD_ZERO(&fds);
1526 	    FD_SET(rodent.mfd, &fds);
1527 	    if (select(FD_SETSIZE, &fds, NULL, NULL, NULL) <= 0)
1528 		break;
1529 	    read(rodent.mfd, &c, 1);
1530 	    debug("%c", c);
1531 	    if (c != *s)
1532 		break;
1533 	}
1534 	break;
1535 
1536     case MOUSE_PROTO_JOGDIAL:
1537 	break;
1538     case MOUSE_PROTO_MSC:
1539 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1540 	if (rodent.flags & ClearDTR) {
1541 	   i = TIOCM_DTR;
1542 	   ioctl(rodent.mfd, TIOCMBIC, &i);
1543 	}
1544 	if (rodent.flags & ClearRTS) {
1545 	   i = TIOCM_RTS;
1546 	   ioctl(rodent.mfd, TIOCMBIC, &i);
1547 	}
1548 	break;
1549 
1550     case MOUSE_PROTO_SYSMOUSE:
1551 	if (rodent.hw.iftype == MOUSE_IF_SYSMOUSE)
1552 	    setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1553 	/* FALLTHROUGH */
1554 
1555     case MOUSE_PROTO_BUS:
1556     case MOUSE_PROTO_INPORT:
1557     case MOUSE_PROTO_PS2:
1558 	if (rodent.rate >= 0)
1559 	    rodent.mode.rate = rodent.rate;
1560 	if (rodent.resolution != MOUSE_RES_UNKNOWN)
1561 	    rodent.mode.resolution = rodent.resolution;
1562 	ioctl(rodent.mfd, MOUSE_SETMODE, &rodent.mode);
1563 	break;
1564 
1565     case MOUSE_PROTO_X10MOUSEREM:
1566 	mremote_serversetup();
1567 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1568 	break;
1569 
1570 
1571     case MOUSE_PROTO_VERSAPAD:
1572 	tcsendbreak(rodent.mfd, 0);	/* send break for 400 msec */
1573 	i = FREAD;
1574 	ioctl(rodent.mfd, TIOCFLUSH, &i);
1575 	for (i = 0; i < 7; ++i) {
1576 	    FD_ZERO(&fds);
1577 	    FD_SET(rodent.mfd, &fds);
1578 	    if (select(FD_SETSIZE, &fds, NULL, NULL, NULL) <= 0)
1579 		break;
1580 	    read(rodent.mfd, &c, 1);
1581 	    buf[i] = c;
1582 	}
1583 	debug("%s\n", buf);
1584 	if ((buf[0] != 'V') || (buf[1] != 'P')|| (buf[7] != '\r'))
1585 	    break;
1586 	setmousespeed(9600, rodent.baudrate, rodentcflags[rodent.rtype]);
1587 	tcsendbreak(rodent.mfd, 0);	/* send break for 400 msec again */
1588 	for (i = 0; i < 7; ++i) {
1589 	    FD_ZERO(&fds);
1590 	    FD_SET(rodent.mfd, &fds);
1591 	    if (select(FD_SETSIZE, &fds, NULL, NULL, NULL) <= 0)
1592 		break;
1593 	    read(rodent.mfd, &c, 1);
1594 	    debug("%c", c);
1595 	    if (c != buf[i])
1596 		break;
1597 	}
1598 	i = FREAD;
1599 	ioctl(rodent.mfd, TIOCFLUSH, &i);
1600 	break;
1601 
1602     default:
1603 	setmousespeed(1200, rodent.baudrate, rodentcflags[rodent.rtype]);
1604 	break;
1605     }
1606 }
1607 
1608 static int
1609 r_protocol(u_char rBuf, mousestatus_t *act)
1610 {
1611     /* MOUSE_MSS_BUTTON?DOWN -> MOUSE_BUTTON?DOWN */
1612     static int butmapmss[4] = {	/* Microsoft, MouseMan, GlidePoint,
1613 				   IntelliMouse, Thinking Mouse */
1614 	0,
1615 	MOUSE_BUTTON3DOWN,
1616 	MOUSE_BUTTON1DOWN,
1617 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1618     };
1619     static int butmapmss2[4] = { /* Microsoft, MouseMan, GlidePoint,
1620 				    Thinking Mouse */
1621 	0,
1622 	MOUSE_BUTTON4DOWN,
1623 	MOUSE_BUTTON2DOWN,
1624 	MOUSE_BUTTON2DOWN | MOUSE_BUTTON4DOWN,
1625     };
1626     /* MOUSE_INTELLI_BUTTON?DOWN -> MOUSE_BUTTON?DOWN */
1627     static int butmapintelli[4] = { /* IntelliMouse, NetMouse, Mie Mouse,
1628 				       MouseMan+ */
1629 	0,
1630 	MOUSE_BUTTON2DOWN,
1631 	MOUSE_BUTTON4DOWN,
1632 	MOUSE_BUTTON2DOWN | MOUSE_BUTTON4DOWN,
1633     };
1634     /* MOUSE_MSC_BUTTON?UP -> MOUSE_BUTTON?DOWN */
1635     static int butmapmsc[8] = {	/* MouseSystems, MMSeries, Logitech,
1636 				   Bus, sysmouse */
1637 	0,
1638 	MOUSE_BUTTON3DOWN,
1639 	MOUSE_BUTTON2DOWN,
1640 	MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
1641 	MOUSE_BUTTON1DOWN,
1642 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1643 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
1644 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
1645     };
1646     /* MOUSE_PS2_BUTTON?DOWN -> MOUSE_BUTTON?DOWN */
1647     static int butmapps2[8] = {	/* PS/2 */
1648 	0,
1649 	MOUSE_BUTTON1DOWN,
1650 	MOUSE_BUTTON3DOWN,
1651 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1652 	MOUSE_BUTTON2DOWN,
1653 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
1654 	MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
1655 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
1656     };
1657     /* for Hitachi tablet */
1658     static int butmaphit[8] = {	/* MM HitTablet */
1659 	0,
1660 	MOUSE_BUTTON3DOWN,
1661 	MOUSE_BUTTON2DOWN,
1662 	MOUSE_BUTTON1DOWN,
1663 	MOUSE_BUTTON4DOWN,
1664 	MOUSE_BUTTON5DOWN,
1665 	MOUSE_BUTTON6DOWN,
1666 	MOUSE_BUTTON7DOWN,
1667     };
1668     /* for serial VersaPad */
1669     static int butmapversa[8] = { /* VersaPad */
1670 	0,
1671 	0,
1672 	MOUSE_BUTTON3DOWN,
1673 	MOUSE_BUTTON3DOWN,
1674 	MOUSE_BUTTON1DOWN,
1675 	MOUSE_BUTTON1DOWN,
1676 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1677 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1678     };
1679     /* for PS/2 VersaPad */
1680     static int butmapversaps2[8] = { /* VersaPad */
1681 	0,
1682 	MOUSE_BUTTON3DOWN,
1683 	0,
1684 	MOUSE_BUTTON3DOWN,
1685 	MOUSE_BUTTON1DOWN,
1686 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1687 	MOUSE_BUTTON1DOWN,
1688 	MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1689     };
1690     static int           pBufP = 0;
1691     static unsigned char pBuf[8];
1692     static int		 prev_x, prev_y;
1693     static int		 on = FALSE;
1694     int			 x, y;
1695 
1696     debug("received char 0x%x",(int)rBuf);
1697     if (rodent.rtype == MOUSE_PROTO_KIDSPAD)
1698 	return kidspad(rBuf, act) ;
1699 
1700     /*
1701      * Hack for resyncing: We check here for a package that is:
1702      *  a) illegal (detected by wrong data-package header)
1703      *  b) invalid (0x80 == -128 and that might be wrong for MouseSystems)
1704      *  c) bad header-package
1705      *
1706      * NOTE: b) is a voilation of the MouseSystems-Protocol, since values of
1707      *       -128 are allowed, but since they are very seldom we can easily
1708      *       use them as package-header with no button pressed.
1709      * NOTE/2: On a PS/2 mouse any byte is valid as a data byte. Furthermore,
1710      *         0x80 is not valid as a header byte. For a PS/2 mouse we skip
1711      *         checking data bytes.
1712      *         For resyncing a PS/2 mouse we require the two most significant
1713      *         bits in the header byte to be 0. These are the overflow bits,
1714      *         and in case of an overflow we actually lose sync. Overflows
1715      *         are very rare, however, and we quickly gain sync again after
1716      *         an overflow condition. This is the best we can do. (Actually,
1717      *         we could use bit 0x08 in the header byte for resyncing, since
1718      *         that bit is supposed to be always on, but nobody told
1719      *         Microsoft...)
1720      */
1721 
1722     if (pBufP != 0 && rodent.rtype != MOUSE_PROTO_PS2 &&
1723 	((rBuf & cur_proto[2]) != cur_proto[3] || rBuf == 0x80))
1724     {
1725 	pBufP = 0;		/* skip package */
1726     }
1727 
1728     if (pBufP == 0 && (rBuf & cur_proto[0]) != cur_proto[1])
1729 	return 0;
1730 
1731     /* is there an extra data byte? */
1732     if (pBufP >= cur_proto[4] && (rBuf & cur_proto[0]) != cur_proto[1])
1733     {
1734 	/*
1735 	 * Hack for Logitech MouseMan Mouse - Middle button
1736 	 *
1737 	 * Unfortunately this mouse has variable length packets: the standard
1738 	 * Microsoft 3 byte packet plus an optional 4th byte whenever the
1739 	 * middle button status changes.
1740 	 *
1741 	 * We have already processed the standard packet with the movement
1742 	 * and button info.  Now post an event message with the old status
1743 	 * of the left and right buttons and the updated middle button.
1744 	 */
1745 
1746 	/*
1747 	 * Even worse, different MouseMen and TrackMen differ in the 4th
1748 	 * byte: some will send 0x00/0x20, others 0x01/0x21, or even
1749 	 * 0x02/0x22, so I have to strip off the lower bits.
1750 	 *
1751 	 * [JCH-96/01/21]
1752 	 * HACK for ALPS "fourth button". (It's bit 0x10 of the "fourth byte"
1753 	 * and it is activated by tapping the glidepad with the finger! 8^)
1754 	 * We map it to bit bit3, and the reverse map in xf86Events just has
1755 	 * to be extended so that it is identified as Button 4. The lower
1756 	 * half of the reverse-map may remain unchanged.
1757 	 */
1758 
1759 	/*
1760 	 * [KY-97/08/03]
1761 	 * Receive the fourth byte only when preceding three bytes have
1762 	 * been detected (pBufP >= cur_proto[4]).  In the previous
1763 	 * versions, the test was pBufP == 0; thus, we may have mistakingly
1764 	 * received a byte even if we didn't see anything preceding
1765 	 * the byte.
1766 	 */
1767 
1768 	if ((rBuf & cur_proto[5]) != cur_proto[6]) {
1769 	    pBufP = 0;
1770 	    return 0;
1771 	}
1772 
1773 	switch (rodent.rtype) {
1774 #if notyet
1775 	case MOUSE_PROTO_MARIQUA:
1776 	    /*
1777 	     * This mouse has 16! buttons in addition to the standard
1778 	     * three of them.  They return 0x10 though 0x1f in the
1779 	     * so-called `ten key' mode and 0x30 though 0x3f in the
1780 	     * `function key' mode.  As there are only 31 bits for
1781 	     * button state (including the standard three), we ignore
1782 	     * the bit 0x20 and don't distinguish the two modes.
1783 	     */
1784 	    act->dx = act->dy = act->dz = 0;
1785 	    act->obutton = act->button;
1786 	    rBuf &= 0x1f;
1787 	    act->button = (1 << (rBuf - 13))
1788 		| (act->obutton & (MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN));
1789 	    /*
1790 	     * FIXME: this is a button "down" event. There needs to be
1791 	     * a corresponding button "up" event... XXX
1792 	     */
1793 	    break;
1794 #endif /* notyet */
1795 	case MOUSE_PROTO_JOGDIAL:
1796 	    break;
1797 
1798 	/*
1799 	 * IntelliMouse, NetMouse (including NetMouse Pro) and Mie Mouse
1800 	 * always send the fourth byte, whereas the fourth byte is
1801 	 * optional for GlidePoint and ThinkingMouse. The fourth byte
1802 	 * is also optional for MouseMan+ and FirstMouse+ in their
1803 	 * native mode. It is always sent if they are in the IntelliMouse
1804 	 * compatible mode.
1805 	 */
1806 	case MOUSE_PROTO_INTELLI:	/* IntelliMouse, NetMouse, Mie Mouse,
1807 					   MouseMan+ */
1808 	    act->dx = act->dy = 0;
1809 	    act->dz = (rBuf & 0x08) ? (rBuf & 0x0f) - 16 : (rBuf & 0x0f);
1810 	    if ((act->dz >= 7) || (act->dz <= -7))
1811 		act->dz = 0;
1812 	    act->obutton = act->button;
1813 	    act->button = butmapintelli[(rBuf & MOUSE_MSS_BUTTONS) >> 4]
1814 		| (act->obutton & (MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN));
1815 	    break;
1816 
1817 	default:
1818 	    act->dx = act->dy = act->dz = 0;
1819 	    act->obutton = act->button;
1820 	    act->button = butmapmss2[(rBuf & MOUSE_MSS_BUTTONS) >> 4]
1821 		| (act->obutton & (MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN));
1822 	    break;
1823 	}
1824 
1825 	act->flags = ((act->dx || act->dy || act->dz) ? MOUSE_POSCHANGED : 0)
1826 	    | (act->obutton ^ act->button);
1827 	pBufP = 0;
1828 	return act->flags;
1829     }
1830 
1831     if (pBufP >= cur_proto[4])
1832 	pBufP = 0;
1833     pBuf[pBufP++] = rBuf;
1834     if (pBufP != cur_proto[4])
1835 	return 0;
1836 
1837     /*
1838      * assembly full package
1839      */
1840 
1841     debug("assembled full packet (len %d) %x,%x,%x,%x,%x,%x,%x,%x",
1842 	cur_proto[4],
1843 	pBuf[0], pBuf[1], pBuf[2], pBuf[3],
1844 	pBuf[4], pBuf[5], pBuf[6], pBuf[7]);
1845 
1846     act->dz = 0;
1847     act->obutton = act->button;
1848     switch (rodent.rtype)
1849     {
1850     case MOUSE_PROTO_MS:		/* Microsoft */
1851     case MOUSE_PROTO_LOGIMOUSEMAN:	/* MouseMan/TrackMan */
1852     case MOUSE_PROTO_X10MOUSEREM:	/* X10 MouseRemote */
1853 	act->button = act->obutton & MOUSE_BUTTON4DOWN;
1854 	if (rodent.flags & ChordMiddle)
1855 	    act->button |= ((pBuf[0] & MOUSE_MSS_BUTTONS) == MOUSE_MSS_BUTTONS)
1856 		? MOUSE_BUTTON2DOWN
1857 		: butmapmss[(pBuf[0] & MOUSE_MSS_BUTTONS) >> 4];
1858 	else
1859 	    act->button |= (act->obutton & MOUSE_BUTTON2DOWN)
1860 		| butmapmss[(pBuf[0] & MOUSE_MSS_BUTTONS) >> 4];
1861 
1862 	/* Send X10 btn events to remote client (ensure -128-+127 range) */
1863 	if ((rodent.rtype == MOUSE_PROTO_X10MOUSEREM) &&
1864 	    ((pBuf[0] & 0xFC) == 0x44) && (pBuf[2] == 0x3F)) {
1865 	    if (rodent.mremcfd >= 0) {
1866 		unsigned char key = (signed char)(((pBuf[0] & 0x03) << 6) |
1867 						  (pBuf[1] & 0x3F));
1868 		write(rodent.mremcfd, &key, 1);
1869 	    }
1870 	    return 0;
1871 	}
1872 
1873 	act->dx = (signed char)(((pBuf[0] & 0x03) << 6) | (pBuf[1] & 0x3F));
1874 	act->dy = (signed char)(((pBuf[0] & 0x0C) << 4) | (pBuf[2] & 0x3F));
1875 	break;
1876 
1877     case MOUSE_PROTO_GLIDEPOINT:	/* GlidePoint */
1878     case MOUSE_PROTO_THINK:		/* ThinkingMouse */
1879     case MOUSE_PROTO_INTELLI:		/* IntelliMouse, NetMouse, Mie Mouse,
1880 					   MouseMan+ */
1881 	act->button = (act->obutton & (MOUSE_BUTTON2DOWN | MOUSE_BUTTON4DOWN))
1882 	    | butmapmss[(pBuf[0] & MOUSE_MSS_BUTTONS) >> 4];
1883 	act->dx = (signed char)(((pBuf[0] & 0x03) << 6) | (pBuf[1] & 0x3F));
1884 	act->dy = (signed char)(((pBuf[0] & 0x0C) << 4) | (pBuf[2] & 0x3F));
1885 	break;
1886 
1887     case MOUSE_PROTO_MSC:		/* MouseSystems Corp */
1888 #if notyet
1889     case MOUSE_PROTO_MARIQUA:		/* Mariqua */
1890 #endif
1891 	act->button = butmapmsc[(~pBuf[0]) & MOUSE_MSC_BUTTONS];
1892 	act->dx =    (signed char)(pBuf[1]) + (signed char)(pBuf[3]);
1893 	act->dy = - ((signed char)(pBuf[2]) + (signed char)(pBuf[4]));
1894 	break;
1895 
1896     case MOUSE_PROTO_JOGDIAL:		/* JogDial */
1897 	    if (rBuf == 0x6c)
1898 	      act->dz = -1;
1899 	    if (rBuf == 0x72)
1900 	      act->dz = 1;
1901 	    if (rBuf == 0x64)
1902 	      act->button = MOUSE_BUTTON1DOWN;
1903 	    if (rBuf == 0x75)
1904 	      act->button = 0;
1905 	break;
1906 
1907     case MOUSE_PROTO_HITTAB:		/* MM HitTablet */
1908 	act->button = butmaphit[pBuf[0] & 0x07];
1909 	act->dx = (pBuf[0] & MOUSE_MM_XPOSITIVE) ?   pBuf[1] : - pBuf[1];
1910 	act->dy = (pBuf[0] & MOUSE_MM_YPOSITIVE) ? - pBuf[2] :   pBuf[2];
1911 	break;
1912 
1913     case MOUSE_PROTO_MM:		/* MM Series */
1914     case MOUSE_PROTO_LOGI:		/* Logitech Mice */
1915 	act->button = butmapmsc[pBuf[0] & MOUSE_MSC_BUTTONS];
1916 	act->dx = (pBuf[0] & MOUSE_MM_XPOSITIVE) ?   pBuf[1] : - pBuf[1];
1917 	act->dy = (pBuf[0] & MOUSE_MM_YPOSITIVE) ? - pBuf[2] :   pBuf[2];
1918 	break;
1919 
1920     case MOUSE_PROTO_VERSAPAD:		/* VersaPad */
1921 	act->button = butmapversa[(pBuf[0] & MOUSE_VERSA_BUTTONS) >> 3];
1922 	act->button |= (pBuf[0] & MOUSE_VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
1923 	act->dx = act->dy = 0;
1924 	if (!(pBuf[0] & MOUSE_VERSA_IN_USE)) {
1925 	    on = FALSE;
1926 	    break;
1927 	}
1928 	x = (pBuf[2] << 6) | pBuf[1];
1929 	if (x & 0x800)
1930 	    x -= 0x1000;
1931 	y = (pBuf[4] << 6) | pBuf[3];
1932 	if (y & 0x800)
1933 	    y -= 0x1000;
1934 	if (on) {
1935 	    act->dx = prev_x - x;
1936 	    act->dy = prev_y - y;
1937 	} else {
1938 	    on = TRUE;
1939 	}
1940 	prev_x = x;
1941 	prev_y = y;
1942 	break;
1943 
1944     case MOUSE_PROTO_BUS:		/* Bus */
1945     case MOUSE_PROTO_INPORT:		/* InPort */
1946 	act->button = butmapmsc[(~pBuf[0]) & MOUSE_MSC_BUTTONS];
1947 	act->dx =   (signed char)pBuf[1];
1948 	act->dy = - (signed char)pBuf[2];
1949 	break;
1950 
1951     case MOUSE_PROTO_PS2:		/* PS/2 */
1952 	act->button = butmapps2[pBuf[0] & MOUSE_PS2_BUTTONS];
1953 	act->dx = (pBuf[0] & MOUSE_PS2_XNEG) ?    pBuf[1] - 256  :  pBuf[1];
1954 	act->dy = (pBuf[0] & MOUSE_PS2_YNEG) ?  -(pBuf[2] - 256) : -pBuf[2];
1955 	/*
1956 	 * Moused usually operates the psm driver at the operation level 1
1957 	 * which sends mouse data in MOUSE_PROTO_SYSMOUSE protocol.
1958 	 * The following code takes effect only when the user explicitly
1959 	 * requets the level 2 at which wheel movement and additional button
1960 	 * actions are encoded in model-dependent formats. At the level 0
1961 	 * the following code is no-op because the psm driver says the model
1962 	 * is MOUSE_MODEL_GENERIC.
1963 	 */
1964 	switch (rodent.hw.model) {
1965 	case MOUSE_MODEL_EXPLORER:
1966 	    /* wheel and additional button data is in the fourth byte */
1967 	    act->dz = (pBuf[3] & MOUSE_EXPLORER_ZNEG)
1968 		? (pBuf[3] & 0x0f) - 16 : (pBuf[3] & 0x0f);
1969 	    act->button |= (pBuf[3] & MOUSE_EXPLORER_BUTTON4DOWN)
1970 		? MOUSE_BUTTON4DOWN : 0;
1971 	    act->button |= (pBuf[3] & MOUSE_EXPLORER_BUTTON5DOWN)
1972 		? MOUSE_BUTTON5DOWN : 0;
1973 	    break;
1974 	case MOUSE_MODEL_INTELLI:
1975 	case MOUSE_MODEL_NET:
1976 	    /* wheel data is in the fourth byte */
1977 	    act->dz = (signed char)pBuf[3];
1978 	    if ((act->dz >= 7) || (act->dz <= -7))
1979 		act->dz = 0;
1980 	    /* some compatible mice may have additional buttons */
1981 	    act->button |= (pBuf[0] & MOUSE_PS2INTELLI_BUTTON4DOWN)
1982 		? MOUSE_BUTTON4DOWN : 0;
1983 	    act->button |= (pBuf[0] & MOUSE_PS2INTELLI_BUTTON5DOWN)
1984 		? MOUSE_BUTTON5DOWN : 0;
1985 	    break;
1986 	case MOUSE_MODEL_MOUSEMANPLUS:
1987 	    if (((pBuf[0] & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC)
1988 		    && (abs(act->dx) > 191)
1989 		    && MOUSE_PS2PLUS_CHECKBITS(pBuf)) {
1990 		/* the extended data packet encodes button and wheel events */
1991 		switch (MOUSE_PS2PLUS_PACKET_TYPE(pBuf)) {
1992 		case 1:
1993 		    /* wheel data packet */
1994 		    act->dx = act->dy = 0;
1995 		    if (pBuf[2] & 0x80) {
1996 			/* horizontal roller count - ignore it XXX*/
1997 		    } else {
1998 			/* vertical roller count */
1999 			act->dz = (pBuf[2] & MOUSE_PS2PLUS_ZNEG)
2000 			    ? (pBuf[2] & 0x0f) - 16 : (pBuf[2] & 0x0f);
2001 		    }
2002 		    act->button |= (pBuf[2] & MOUSE_PS2PLUS_BUTTON4DOWN)
2003 			? MOUSE_BUTTON4DOWN : 0;
2004 		    act->button |= (pBuf[2] & MOUSE_PS2PLUS_BUTTON5DOWN)
2005 			? MOUSE_BUTTON5DOWN : 0;
2006 		    break;
2007 		case 2:
2008 		    /* this packet type is reserved by Logitech */
2009 		    /*
2010 		     * IBM ScrollPoint Mouse uses this packet type to
2011 		     * encode both vertical and horizontal scroll movement.
2012 		     */
2013 		    act->dx = act->dy = 0;
2014 		    /* horizontal roller count */
2015 		    if (pBuf[2] & 0x0f)
2016 			act->dz = (pBuf[2] & MOUSE_SPOINT_WNEG) ? -2 : 2;
2017 		    /* vertical roller count */
2018 		    if (pBuf[2] & 0xf0)
2019 			act->dz = (pBuf[2] & MOUSE_SPOINT_ZNEG) ? -1 : 1;
2020 #if 0
2021 		    /* vertical roller count */
2022 		    act->dz = (pBuf[2] & MOUSE_SPOINT_ZNEG)
2023 			? ((pBuf[2] >> 4) & 0x0f) - 16
2024 			: ((pBuf[2] >> 4) & 0x0f);
2025 		    /* horizontal roller count */
2026 		    act->dw = (pBuf[2] & MOUSE_SPOINT_WNEG)
2027 			? (pBuf[2] & 0x0f) - 16 : (pBuf[2] & 0x0f);
2028 #endif
2029 		    break;
2030 		case 0:
2031 		    /* device type packet - shouldn't happen */
2032 		    /* FALLTHROUGH */
2033 		default:
2034 		    act->dx = act->dy = 0;
2035 		    act->button = act->obutton;
2036 		    debug("unknown PS2++ packet type %d: 0x%02x 0x%02x 0x%02x\n",
2037 			  MOUSE_PS2PLUS_PACKET_TYPE(pBuf),
2038 			  pBuf[0], pBuf[1], pBuf[2]);
2039 		    break;
2040 		}
2041 	    } else {
2042 		/* preserve button states */
2043 		act->button |= act->obutton & MOUSE_EXTBUTTONS;
2044 	    }
2045 	    break;
2046 	case MOUSE_MODEL_GLIDEPOINT:
2047 	    /* `tapping' action */
2048 	    act->button |= ((pBuf[0] & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2049 	    break;
2050 	case MOUSE_MODEL_NETSCROLL:
2051 	    /* three addtional bytes encode buttons and wheel events */
2052 	    act->button |= (pBuf[3] & MOUSE_PS2_BUTTON3DOWN)
2053 		? MOUSE_BUTTON4DOWN : 0;
2054 	    act->button |= (pBuf[3] & MOUSE_PS2_BUTTON1DOWN)
2055 		? MOUSE_BUTTON5DOWN : 0;
2056 	    act->dz = (pBuf[3] & MOUSE_PS2_XNEG) ? pBuf[4] - 256 : pBuf[4];
2057 	    break;
2058 	case MOUSE_MODEL_THINK:
2059 	    /* the fourth button state in the first byte */
2060 	    act->button |= (pBuf[0] & MOUSE_PS2_TAP) ? MOUSE_BUTTON4DOWN : 0;
2061 	    break;
2062 	case MOUSE_MODEL_VERSAPAD:
2063 	    act->button = butmapversaps2[pBuf[0] & MOUSE_PS2VERSA_BUTTONS];
2064 	    act->button |=
2065 		(pBuf[0] & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
2066 	    act->dx = act->dy = 0;
2067 	    if (!(pBuf[0] & MOUSE_PS2VERSA_IN_USE)) {
2068 		on = FALSE;
2069 		break;
2070 	    }
2071 	    x = ((pBuf[4] << 8) & 0xf00) | pBuf[1];
2072 	    if (x & 0x800)
2073 		x -= 0x1000;
2074 	    y = ((pBuf[4] << 4) & 0xf00) | pBuf[2];
2075 	    if (y & 0x800)
2076 		y -= 0x1000;
2077 	    if (on) {
2078 		act->dx = prev_x - x;
2079 		act->dy = prev_y - y;
2080 	    } else {
2081 		on = TRUE;
2082 	    }
2083 	    prev_x = x;
2084 	    prev_y = y;
2085 	    break;
2086 	case MOUSE_MODEL_4D:
2087 	    act->dx = (pBuf[1] & 0x80) ?    pBuf[1] - 256  :  pBuf[1];
2088 	    act->dy = (pBuf[2] & 0x80) ?  -(pBuf[2] - 256) : -pBuf[2];
2089 	    switch (pBuf[0] & MOUSE_4D_WHEELBITS) {
2090 	    case 0x10:
2091 		act->dz = 1;
2092 		break;
2093 	    case 0x30:
2094 		act->dz = -1;
2095 		break;
2096 	    case 0x40:	/* 2nd wheel rolling right XXX */
2097 		act->dz = 2;
2098 		break;
2099 	    case 0xc0:	/* 2nd wheel rolling left XXX */
2100 		act->dz = -2;
2101 		break;
2102 	    }
2103 	    break;
2104 	case MOUSE_MODEL_4DPLUS:
2105 	    if ((act->dx < 16 - 256) && (act->dy > 256 - 16)) {
2106 		act->dx = act->dy = 0;
2107 		if (pBuf[2] & MOUSE_4DPLUS_BUTTON4DOWN)
2108 		    act->button |= MOUSE_BUTTON4DOWN;
2109 		act->dz = (pBuf[2] & MOUSE_4DPLUS_ZNEG)
2110 			      ? ((pBuf[2] & 0x07) - 8) : (pBuf[2] & 0x07);
2111 	    } else {
2112 		/* preserve previous button states */
2113 		act->button |= act->obutton & MOUSE_EXTBUTTONS;
2114 	    }
2115 	    break;
2116 	case MOUSE_MODEL_GENERIC:
2117 	default:
2118 	    break;
2119 	}
2120 	break;
2121 
2122     case MOUSE_PROTO_SYSMOUSE:		/* sysmouse */
2123 	act->button = butmapmsc[(~pBuf[0]) & MOUSE_SYS_STDBUTTONS];
2124 	act->dx =    (signed char)(pBuf[1]) + (signed char)(pBuf[3]);
2125 	act->dy = - ((signed char)(pBuf[2]) + (signed char)(pBuf[4]));
2126 	if (rodent.level == 1) {
2127 	    act->dz = ((signed char)(pBuf[5] << 1) + (signed char)(pBuf[6] << 1)) >> 1;
2128 	    act->button |= ((~pBuf[7] & MOUSE_SYS_EXTBUTTONS) << 3);
2129 	}
2130 	break;
2131 
2132     default:
2133 	return 0;
2134     }
2135     /*
2136      * We don't reset pBufP here yet, as there may be an additional data
2137      * byte in some protocols. See above.
2138      */
2139 
2140     /* has something changed? */
2141     act->flags = ((act->dx || act->dy || act->dz) ? MOUSE_POSCHANGED : 0)
2142 	| (act->obutton ^ act->button);
2143 
2144     return act->flags;
2145 }
2146 
2147 static int
2148 r_statetrans(mousestatus_t *a1, mousestatus_t *a2, int trans)
2149 {
2150     int changed;
2151     int flags;
2152 
2153     a2->dx = a1->dx;
2154     a2->dy = a1->dy;
2155     a2->dz = a1->dz;
2156     a2->obutton = a2->button;
2157     a2->button = a1->button;
2158     a2->flags = a1->flags;
2159     changed = FALSE;
2160 
2161     if (rodent.flags & Emulate3Button) {
2162 	if (debug > 2)
2163 	    debug("state:%d, trans:%d -> state:%d",
2164 		  mouse_button_state, trans,
2165 		  states[mouse_button_state].s[trans]);
2166 	/*
2167 	 * Avoid re-ordering button and movement events. While a button
2168 	 * event is deferred, throw away up to BUTTON2_MAXMOVE movement
2169 	 * events to allow for mouse jitter. If more movement events
2170 	 * occur, then complete the deferred button events immediately.
2171 	 */
2172 	if ((a2->dx != 0 || a2->dy != 0) &&
2173 	    S_DELAYED(states[mouse_button_state].s[trans])) {
2174 		if (++mouse_move_delayed > BUTTON2_MAXMOVE) {
2175 			mouse_move_delayed = 0;
2176 			mouse_button_state =
2177 			    states[mouse_button_state].s[A_TIMEOUT];
2178 			changed = TRUE;
2179 		} else
2180 			a2->dx = a2->dy = 0;
2181 	} else
2182 		mouse_move_delayed = 0;
2183 	if (mouse_button_state != states[mouse_button_state].s[trans])
2184 		changed = TRUE;
2185 	if (changed)
2186 		gettimeofday(&mouse_button_state_tv, NULL);
2187 	mouse_button_state = states[mouse_button_state].s[trans];
2188 	a2->button &=
2189 	    ~(MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN);
2190 	a2->button &= states[mouse_button_state].mask;
2191 	a2->button |= states[mouse_button_state].buttons;
2192 	flags = a2->flags & MOUSE_POSCHANGED;
2193 	flags |= a2->obutton ^ a2->button;
2194 	if (flags & MOUSE_BUTTON2DOWN) {
2195 	    a2->flags = flags & MOUSE_BUTTON2DOWN;
2196 	    r_timestamp(a2);
2197 	}
2198 	a2->flags = flags;
2199     }
2200     return changed;
2201 }
2202 
2203 /* phisical to logical button mapping */
2204 static int p2l[MOUSE_MAXBUTTON] = {
2205     MOUSE_BUTTON1DOWN, MOUSE_BUTTON2DOWN, MOUSE_BUTTON3DOWN, MOUSE_BUTTON4DOWN,
2206     MOUSE_BUTTON5DOWN, MOUSE_BUTTON6DOWN, MOUSE_BUTTON7DOWN, MOUSE_BUTTON8DOWN,
2207     0x00000100,        0x00000200,        0x00000400,        0x00000800,
2208     0x00001000,        0x00002000,        0x00004000,        0x00008000,
2209     0x00010000,        0x00020000,        0x00040000,        0x00080000,
2210     0x00100000,        0x00200000,        0x00400000,        0x00800000,
2211     0x01000000,        0x02000000,        0x04000000,        0x08000000,
2212     0x10000000,        0x20000000,        0x40000000,
2213 };
2214 
2215 static char *
2216 skipspace(char *s)
2217 {
2218     while(isspace(*s))
2219 	++s;
2220     return s;
2221 }
2222 
2223 static int
2224 r_installmap(char *arg)
2225 {
2226     int pbutton;
2227     int lbutton;
2228     char *s;
2229 
2230     while (*arg) {
2231 	arg = skipspace(arg);
2232 	s = arg;
2233 	while (isdigit(*arg))
2234 	    ++arg;
2235 	arg = skipspace(arg);
2236 	if ((arg <= s) || (*arg != '='))
2237 	    return FALSE;
2238 	lbutton = atoi(s);
2239 
2240 	arg = skipspace(++arg);
2241 	s = arg;
2242 	while (isdigit(*arg))
2243 	    ++arg;
2244 	if ((arg <= s) || (!isspace(*arg) && (*arg != '\0')))
2245 	    return FALSE;
2246 	pbutton = atoi(s);
2247 
2248 	if ((lbutton <= 0) || (lbutton > MOUSE_MAXBUTTON))
2249 	    return FALSE;
2250 	if ((pbutton <= 0) || (pbutton > MOUSE_MAXBUTTON))
2251 	    return FALSE;
2252 	p2l[pbutton - 1] = 1 << (lbutton - 1);
2253 	mstate[lbutton - 1] = &bstate[pbutton - 1];
2254     }
2255 
2256     return TRUE;
2257 }
2258 
2259 static void
2260 r_map(mousestatus_t *act1, mousestatus_t *act2)
2261 {
2262     register int pb;
2263     register int pbuttons;
2264     int lbuttons;
2265 
2266     pbuttons = act1->button;
2267     lbuttons = 0;
2268 
2269     act2->obutton = act2->button;
2270     if (pbuttons & rodent.wmode) {
2271 	pbuttons &= ~rodent.wmode;
2272 	act1->dz = act1->dy;
2273 	act1->dx = 0;
2274 	act1->dy = 0;
2275     }
2276     act2->dx = act1->dx;
2277     act2->dy = act1->dy;
2278     act2->dz = act1->dz;
2279 
2280     switch (rodent.zmap[0]) {
2281     case 0:	/* do nothing */
2282 	break;
2283     case MOUSE_XAXIS:
2284 	if (act1->dz != 0) {
2285 	    act2->dx = act1->dz;
2286 	    act2->dz = 0;
2287 	}
2288 	break;
2289     case MOUSE_YAXIS:
2290 	if (act1->dz != 0) {
2291 	    act2->dy = act1->dz;
2292 	    act2->dz = 0;
2293 	}
2294 	break;
2295     default:	/* buttons */
2296 	pbuttons &= ~(rodent.zmap[0] | rodent.zmap[1]
2297 		    | rodent.zmap[2] | rodent.zmap[3]);
2298 	if ((act1->dz < -1) && rodent.zmap[2]) {
2299 	    pbuttons |= rodent.zmap[2];
2300 	    zstate[2].count = 1;
2301 	} else if (act1->dz < 0) {
2302 	    pbuttons |= rodent.zmap[0];
2303 	    zstate[0].count = 1;
2304 	} else if ((act1->dz > 1) && rodent.zmap[3]) {
2305 	    pbuttons |= rodent.zmap[3];
2306 	    zstate[3].count = 1;
2307 	} else if (act1->dz > 0) {
2308 	    pbuttons |= rodent.zmap[1];
2309 	    zstate[1].count = 1;
2310 	}
2311 	act2->dz = 0;
2312 	break;
2313     }
2314 
2315     for (pb = 0; (pb < MOUSE_MAXBUTTON) && (pbuttons != 0); ++pb) {
2316 	lbuttons |= (pbuttons & 1) ? p2l[pb] : 0;
2317 	pbuttons >>= 1;
2318     }
2319     act2->button = lbuttons;
2320 
2321     act2->flags = ((act2->dx || act2->dy || act2->dz) ? MOUSE_POSCHANGED : 0)
2322 	| (act2->obutton ^ act2->button);
2323 }
2324 
2325 static void
2326 r_timestamp(mousestatus_t *act)
2327 {
2328     struct timeval tv;
2329     struct timeval tv1;
2330     struct timeval tv2;
2331     struct timeval tv3;
2332     int button;
2333     int mask;
2334     int i;
2335 
2336     mask = act->flags & MOUSE_BUTTONS;
2337 #if 0
2338     if (mask == 0)
2339 	return;
2340 #endif
2341 
2342     gettimeofday(&tv1, NULL);
2343 
2344     /* double click threshold */
2345     tv2.tv_sec = rodent.clickthreshold/1000;
2346     tv2.tv_usec = (rodent.clickthreshold%1000)*1000;
2347     timersub(&tv1, &tv2, &tv);
2348     debug("tv:  %ld %ld", tv.tv_sec, tv.tv_usec);
2349 
2350     /* 3 button emulation timeout */
2351     tv2.tv_sec = rodent.button2timeout/1000;
2352     tv2.tv_usec = (rodent.button2timeout%1000)*1000;
2353     timersub(&tv1, &tv2, &tv3);
2354 
2355     button = MOUSE_BUTTON1DOWN;
2356     for (i = 0; (i < MOUSE_MAXBUTTON) && (mask != 0); ++i) {
2357 	if (mask & 1) {
2358 	    if (act->button & button) {
2359 		/* the button is down */
2360 		debug("  :  %ld %ld",
2361 		    bstate[i].tv.tv_sec, bstate[i].tv.tv_usec);
2362 		if (timercmp(&tv, &bstate[i].tv, >)) {
2363 		    bstate[i].count = 1;
2364 		} else {
2365 		    ++bstate[i].count;
2366 		}
2367 		bstate[i].tv = tv1;
2368 	    } else {
2369 		/* the button is up */
2370 		bstate[i].tv = tv1;
2371 	    }
2372 	} else {
2373 	    if (act->button & button) {
2374 		/* the button has been down */
2375 		if (timercmp(&tv3, &bstate[i].tv, >)) {
2376 		    bstate[i].count = 1;
2377 		    bstate[i].tv = tv1;
2378 		    act->flags |= button;
2379 		    debug("button %d timeout", i + 1);
2380 		}
2381 	    } else {
2382 		/* the button has been up */
2383 	    }
2384 	}
2385 	button <<= 1;
2386 	mask >>= 1;
2387     }
2388 }
2389 
2390 static int
2391 r_timeout(void)
2392 {
2393     struct timeval tv;
2394     struct timeval tv1;
2395     struct timeval tv2;
2396 
2397     if (states[mouse_button_state].timeout)
2398 	return TRUE;
2399     gettimeofday(&tv1, NULL);
2400     tv2.tv_sec = rodent.button2timeout/1000;
2401     tv2.tv_usec = (rodent.button2timeout%1000)*1000;
2402     timersub(&tv1, &tv2, &tv);
2403     return timercmp(&tv, &mouse_button_state_tv, >);
2404 }
2405 
2406 static void
2407 r_click(mousestatus_t *act)
2408 {
2409     struct mouse_info mouse;
2410     int button;
2411     int mask;
2412     int i;
2413 
2414     mask = act->flags & MOUSE_BUTTONS;
2415     if (mask == 0)
2416 	return;
2417 
2418     button = MOUSE_BUTTON1DOWN;
2419     for (i = 0; (i < MOUSE_MAXBUTTON) && (mask != 0); ++i) {
2420 	if (mask & 1) {
2421 	    debug("mstate[%d]->count:%d", i, mstate[i]->count);
2422 	    if (act->button & button) {
2423 		/* the button is down */
2424 		mouse.u.event.value = mstate[i]->count;
2425 	    } else {
2426 		/* the button is up */
2427 		mouse.u.event.value = 0;
2428 	    }
2429 	    mouse.operation = MOUSE_BUTTON_EVENT;
2430 	    mouse.u.event.id = button;
2431 	    if (debug < 2)
2432 		ioctl(rodent.cfd, CONS_MOUSECTL, &mouse);
2433 	    debug("button %d  count %d", i + 1, mouse.u.event.value);
2434 	}
2435 	button <<= 1;
2436 	mask >>= 1;
2437     }
2438 }
2439 
2440 /* $XConsortium: posix_tty.c,v 1.3 95/01/05 20:42:55 kaleb Exp $ */
2441 /* $XFree86: xc/programs/Xserver/hw/xfree86/os-support/shared/posix_tty.c,v 3.4 1995/01/28 17:05:03 dawes Exp $ */
2442 /*
2443  * Copyright 1993 by David Dawes <dawes@physics.su.oz.au>
2444  *
2445  * Permission to use, copy, modify, distribute, and sell this software and its
2446  * documentation for any purpose is hereby granted without fee, provided that
2447  * the above copyright notice appear in all copies and that both that
2448  * copyright notice and this permission notice appear in supporting
2449  * documentation, and that the name of David Dawes
2450  * not be used in advertising or publicity pertaining to distribution of
2451  * the software without specific, written prior permission.
2452  * David Dawes makes no representations about the suitability of this
2453  * software for any purpose.  It is provided "as is" without express or
2454  * implied warranty.
2455  *
2456  * DAVID DAWES DISCLAIMS ALL WARRANTIES WITH REGARD TO
2457  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
2458  * FITNESS, IN NO EVENT SHALL DAVID DAWES BE LIABLE FOR
2459  * ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
2460  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
2461  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
2462  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2463  *
2464  */
2465 
2466 
2467 static void
2468 setmousespeed(int old, int new, unsigned cflag)
2469 {
2470 	struct termios tty;
2471 	char *c;
2472 
2473 	if (tcgetattr(rodent.mfd, &tty) < 0)
2474 	{
2475 		logwarn("unable to get status of mouse fd");
2476 		return;
2477 	}
2478 
2479 	tty.c_iflag = IGNBRK | IGNPAR;
2480 	tty.c_oflag = 0;
2481 	tty.c_lflag = 0;
2482 	tty.c_cflag = (tcflag_t)cflag;
2483 	tty.c_cc[VTIME] = 0;
2484 	tty.c_cc[VMIN] = 1;
2485 
2486 	switch (old)
2487 	{
2488 	case 9600:
2489 		cfsetispeed(&tty, B9600);
2490 		cfsetospeed(&tty, B9600);
2491 		break;
2492 	case 4800:
2493 		cfsetispeed(&tty, B4800);
2494 		cfsetospeed(&tty, B4800);
2495 		break;
2496 	case 2400:
2497 		cfsetispeed(&tty, B2400);
2498 		cfsetospeed(&tty, B2400);
2499 		break;
2500 	case 1200:
2501 	default:
2502 		cfsetispeed(&tty, B1200);
2503 		cfsetospeed(&tty, B1200);
2504 	}
2505 
2506 	if (tcsetattr(rodent.mfd, TCSADRAIN, &tty) < 0)
2507 	{
2508 		logwarn("unable to set status of mouse fd");
2509 		return;
2510 	}
2511 
2512 	switch (new)
2513 	{
2514 	case 9600:
2515 		c = "*q";
2516 		cfsetispeed(&tty, B9600);
2517 		cfsetospeed(&tty, B9600);
2518 		break;
2519 	case 4800:
2520 		c = "*p";
2521 		cfsetispeed(&tty, B4800);
2522 		cfsetospeed(&tty, B4800);
2523 		break;
2524 	case 2400:
2525 		c = "*o";
2526 		cfsetispeed(&tty, B2400);
2527 		cfsetospeed(&tty, B2400);
2528 		break;
2529 	case 1200:
2530 	default:
2531 		c = "*n";
2532 		cfsetispeed(&tty, B1200);
2533 		cfsetospeed(&tty, B1200);
2534 	}
2535 
2536 	if (rodent.rtype == MOUSE_PROTO_LOGIMOUSEMAN
2537 	    || rodent.rtype == MOUSE_PROTO_LOGI)
2538 	{
2539 		if (write(rodent.mfd, c, 2) != 2)
2540 		{
2541 			logwarn("unable to write to mouse fd");
2542 			return;
2543 		}
2544 	}
2545 	usleep(100000);
2546 
2547 	if (tcsetattr(rodent.mfd, TCSADRAIN, &tty) < 0)
2548 		logwarn("unable to set status of mouse fd");
2549 }
2550 
2551 /*
2552  * PnP COM device support
2553  *
2554  * It's a simplistic implementation, but it works :-)
2555  * KY, 31/7/97.
2556  */
2557 
2558 /*
2559  * Try to elicit a PnP ID as described in
2560  * Microsoft, Hayes: "Plug and Play External COM Device Specification,
2561  * rev 1.00", 1995.
2562  *
2563  * The routine does not fully implement the COM Enumerator as par Section
2564  * 2.1 of the document.  In particular, we don't have idle state in which
2565  * the driver software monitors the com port for dynamic connection or
2566  * removal of a device at the port, because `moused' simply quits if no
2567  * device is found.
2568  *
2569  * In addition, as PnP COM device enumeration procedure slightly has
2570  * changed since its first publication, devices which follow earlier
2571  * revisions of the above spec. may fail to respond if the rev 1.0
2572  * procedure is used. XXX
2573  */
2574 static int
2575 pnpwakeup1(void)
2576 {
2577     struct timeval timeout;
2578     fd_set fds;
2579     int i;
2580 
2581     /*
2582      * This is the procedure described in rev 1.0 of PnP COM device spec.
2583      * Unfortunately, some devices which comform to earlier revisions of
2584      * the spec gets confused and do not return the ID string...
2585      */
2586     debug("PnP COM device rev 1.0 probe...");
2587 
2588     /* port initialization (2.1.2) */
2589     ioctl(rodent.mfd, TIOCMGET, &i);
2590     i |= TIOCM_DTR;		/* DTR = 1 */
2591     i &= ~TIOCM_RTS;		/* RTS = 0 */
2592     ioctl(rodent.mfd, TIOCMSET, &i);
2593     usleep(240000);
2594 
2595     /*
2596      * The PnP COM device spec. dictates that the mouse must set DSR
2597      * in response to DTR (by hardware or by software) and that if DSR is
2598      * not asserted, the host computer should think that there is no device
2599      * at this serial port.  But some mice just don't do that...
2600      */
2601     ioctl(rodent.mfd, TIOCMGET, &i);
2602     debug("modem status 0%o", i);
2603     if ((i & TIOCM_DSR) == 0)
2604 	return FALSE;
2605 
2606     /* port setup, 1st phase (2.1.3) */
2607     setmousespeed(1200, 1200, (CS7 | CREAD | CLOCAL | HUPCL));
2608     i = TIOCM_DTR | TIOCM_RTS;	/* DTR = 0, RTS = 0 */
2609     ioctl(rodent.mfd, TIOCMBIC, &i);
2610     usleep(240000);
2611     i = TIOCM_DTR;		/* DTR = 1, RTS = 0 */
2612     ioctl(rodent.mfd, TIOCMBIS, &i);
2613     usleep(240000);
2614 
2615     /* wait for response, 1st phase (2.1.4) */
2616     i = FREAD;
2617     ioctl(rodent.mfd, TIOCFLUSH, &i);
2618     i = TIOCM_RTS;		/* DTR = 1, RTS = 1 */
2619     ioctl(rodent.mfd, TIOCMBIS, &i);
2620 
2621     /* try to read something */
2622     FD_ZERO(&fds);
2623     FD_SET(rodent.mfd, &fds);
2624     timeout.tv_sec = 0;
2625     timeout.tv_usec = 240000;
2626     if (select(FD_SETSIZE, &fds, NULL, NULL, &timeout) > 0) {
2627 	debug("pnpwakeup1(): valid response in first phase.");
2628 	return TRUE;
2629     }
2630 
2631     /* port setup, 2nd phase (2.1.5) */
2632     i = TIOCM_DTR | TIOCM_RTS;	/* DTR = 0, RTS = 0 */
2633     ioctl(rodent.mfd, TIOCMBIC, &i);
2634     usleep(240000);
2635 
2636     /* wait for respose, 2nd phase (2.1.6) */
2637     i = FREAD;
2638     ioctl(rodent.mfd, TIOCFLUSH, &i);
2639     i = TIOCM_DTR | TIOCM_RTS;	/* DTR = 1, RTS = 1 */
2640     ioctl(rodent.mfd, TIOCMBIS, &i);
2641 
2642     /* try to read something */
2643     FD_ZERO(&fds);
2644     FD_SET(rodent.mfd, &fds);
2645     timeout.tv_sec = 0;
2646     timeout.tv_usec = 240000;
2647     if (select(FD_SETSIZE, &fds, NULL, NULL, &timeout) > 0) {
2648 	debug("pnpwakeup1(): valid response in second phase.");
2649 	return TRUE;
2650     }
2651 
2652     return FALSE;
2653 }
2654 
2655 static int
2656 pnpwakeup2(void)
2657 {
2658     struct timeval timeout;
2659     fd_set fds;
2660     int i;
2661 
2662     /*
2663      * This is a simplified procedure; it simply toggles RTS.
2664      */
2665     debug("alternate probe...");
2666 
2667     ioctl(rodent.mfd, TIOCMGET, &i);
2668     i |= TIOCM_DTR;		/* DTR = 1 */
2669     i &= ~TIOCM_RTS;		/* RTS = 0 */
2670     ioctl(rodent.mfd, TIOCMSET, &i);
2671     usleep(240000);
2672 
2673     setmousespeed(1200, 1200, (CS7 | CREAD | CLOCAL | HUPCL));
2674 
2675     /* wait for respose */
2676     i = FREAD;
2677     ioctl(rodent.mfd, TIOCFLUSH, &i);
2678     i = TIOCM_DTR | TIOCM_RTS;	/* DTR = 1, RTS = 1 */
2679     ioctl(rodent.mfd, TIOCMBIS, &i);
2680 
2681     /* try to read something */
2682     FD_ZERO(&fds);
2683     FD_SET(rodent.mfd, &fds);
2684     timeout.tv_sec = 0;
2685     timeout.tv_usec = 240000;
2686     if (select(FD_SETSIZE, &fds, NULL, NULL, &timeout) > 0) {
2687 	debug("pnpwakeup2(): valid response.");
2688 	return TRUE;
2689     }
2690 
2691     return FALSE;
2692 }
2693 
2694 static int
2695 pnpgets(char *buf)
2696 {
2697     struct timeval timeout;
2698     fd_set fds;
2699     int begin;
2700     int i;
2701     char c;
2702 
2703     if (!pnpwakeup1() && !pnpwakeup2()) {
2704 	/*
2705 	 * According to PnP spec, we should set DTR = 1 and RTS = 0 while
2706 	 * in idle state.  But, `moused' shall set DTR = RTS = 1 and proceed,
2707 	 * assuming there is something at the port even if it didn't
2708 	 * respond to the PnP enumeration procedure.
2709 	 */
2710 	i = TIOCM_DTR | TIOCM_RTS;		/* DTR = 1, RTS = 1 */
2711 	ioctl(rodent.mfd, TIOCMBIS, &i);
2712 	return 0;
2713     }
2714 
2715     /* collect PnP COM device ID (2.1.7) */
2716     begin = -1;
2717     i = 0;
2718     usleep(240000);	/* the mouse must send `Begin ID' within 200msec */
2719     while (read(rodent.mfd, &c, 1) == 1) {
2720 	/* we may see "M", or "M3..." before `Begin ID' */
2721 	buf[i++] = c;
2722 	if ((c == 0x08) || (c == 0x28)) {	/* Begin ID */
2723 	    debug("begin-id %02x", c);
2724 	    begin = i - 1;
2725 	    break;
2726 	}
2727 	debug("%c %02x", c, c);
2728 	if (i >= 256)
2729 	    break;
2730     }
2731     if (begin < 0) {
2732 	/* we haven't seen `Begin ID' in time... */
2733 	goto connect_idle;
2734     }
2735 
2736     ++c;			/* make it `End ID' */
2737     for (;;) {
2738 	FD_ZERO(&fds);
2739 	FD_SET(rodent.mfd, &fds);
2740 	timeout.tv_sec = 0;
2741 	timeout.tv_usec = 240000;
2742 	if (select(FD_SETSIZE, &fds, NULL, NULL, &timeout) <= 0)
2743 	    break;
2744 
2745 	read(rodent.mfd, &buf[i], 1);
2746 	if (buf[i++] == c)	/* End ID */
2747 	    break;
2748 	if (i >= 256)
2749 	    break;
2750     }
2751     if (begin > 0) {
2752 	i -= begin;
2753 	bcopy(&buf[begin], &buf[0], i);
2754     }
2755     /* string may not be human readable... */
2756     debug("len:%d, '%-*.*s'", i, i, i, buf);
2757 
2758     if (buf[i - 1] == c)
2759 	return i;		/* a valid PnP string */
2760 
2761     /*
2762      * According to PnP spec, we should set DTR = 1 and RTS = 0 while
2763      * in idle state.  But, `moused' shall leave the modem control lines
2764      * as they are. See above.
2765      */
2766 connect_idle:
2767 
2768     /* we may still have something in the buffer */
2769     return ((i > 0) ? i : 0);
2770 }
2771 
2772 static int
2773 pnpparse(pnpid_t *id, char *buf, int len)
2774 {
2775     char s[3];
2776     int offset;
2777     int sum = 0;
2778     int i, j;
2779 
2780     id->revision = 0;
2781     id->eisaid = NULL;
2782     id->serial = NULL;
2783     id->class = NULL;
2784     id->compat = NULL;
2785     id->description = NULL;
2786     id->neisaid = 0;
2787     id->nserial = 0;
2788     id->nclass = 0;
2789     id->ncompat = 0;
2790     id->ndescription = 0;
2791 
2792     if ((buf[0] != 0x28) && (buf[0] != 0x08)) {
2793 	/* non-PnP mice */
2794 	switch(buf[0]) {
2795 	default:
2796 	    return FALSE;
2797 	case 'M': /* Microsoft */
2798 	    id->eisaid = "PNP0F01";
2799 	    break;
2800 	case 'H': /* MouseSystems */
2801 	    id->eisaid = "PNP0F04";
2802 	    break;
2803 	}
2804 	id->neisaid = strlen(id->eisaid);
2805 	id->class = "MOUSE";
2806 	id->nclass = strlen(id->class);
2807 	debug("non-PnP mouse '%c'", buf[0]);
2808 	return TRUE;
2809     }
2810 
2811     /* PnP mice */
2812     offset = 0x28 - buf[0];
2813 
2814     /* calculate checksum */
2815     for (i = 0; i < len - 3; ++i) {
2816 	sum += buf[i];
2817 	buf[i] += offset;
2818     }
2819     sum += buf[len - 1];
2820     for (; i < len; ++i)
2821 	buf[i] += offset;
2822     debug("PnP ID string: '%*.*s'", len, len, buf);
2823 
2824     /* revision */
2825     buf[1] -= offset;
2826     buf[2] -= offset;
2827     id->revision = ((buf[1] & 0x3f) << 6) | (buf[2] & 0x3f);
2828     debug("PnP rev %d.%02d", id->revision / 100, id->revision % 100);
2829 
2830     /* EISA vender and product ID */
2831     id->eisaid = &buf[3];
2832     id->neisaid = 7;
2833 
2834     /* option strings */
2835     i = 10;
2836     if (buf[i] == '\\') {
2837 	/* device serial # */
2838 	for (j = ++i; i < len; ++i) {
2839 	    if (buf[i] == '\\')
2840 		break;
2841 	}
2842 	if (i >= len)
2843 	    i -= 3;
2844 	if (i - j == 8) {
2845 	    id->serial = &buf[j];
2846 	    id->nserial = 8;
2847 	}
2848     }
2849     if (buf[i] == '\\') {
2850 	/* PnP class */
2851 	for (j = ++i; i < len; ++i) {
2852 	    if (buf[i] == '\\')
2853 		break;
2854 	}
2855 	if (i >= len)
2856 	    i -= 3;
2857 	if (i > j + 1) {
2858 	    id->class = &buf[j];
2859 	    id->nclass = i - j;
2860 	}
2861     }
2862     if (buf[i] == '\\') {
2863 	/* compatible driver */
2864 	for (j = ++i; i < len; ++i) {
2865 	    if (buf[i] == '\\')
2866 		break;
2867 	}
2868 	/*
2869 	 * PnP COM spec prior to v0.96 allowed '*' in this field,
2870 	 * it's not allowed now; just igore it.
2871 	 */
2872 	if (buf[j] == '*')
2873 	    ++j;
2874 	if (i >= len)
2875 	    i -= 3;
2876 	if (i > j + 1) {
2877 	    id->compat = &buf[j];
2878 	    id->ncompat = i - j;
2879 	}
2880     }
2881     if (buf[i] == '\\') {
2882 	/* product description */
2883 	for (j = ++i; i < len; ++i) {
2884 	    if (buf[i] == ';')
2885 		break;
2886 	}
2887 	if (i >= len)
2888 	    i -= 3;
2889 	if (i > j + 1) {
2890 	    id->description = &buf[j];
2891 	    id->ndescription = i - j;
2892 	}
2893     }
2894 
2895     /* checksum exists if there are any optional fields */
2896     if ((id->nserial > 0) || (id->nclass > 0)
2897 	|| (id->ncompat > 0) || (id->ndescription > 0)) {
2898 	debug("PnP checksum: 0x%X", sum);
2899 	sprintf(s, "%02X", sum & 0x0ff);
2900 	if (strncmp(s, &buf[len - 3], 2) != 0) {
2901 #if 0
2902 	    /*
2903 	     * I found some mice do not comply with the PnP COM device
2904 	     * spec regarding checksum... XXX
2905 	     */
2906 	    logwarnx("PnP checksum error", 0);
2907 	    return FALSE;
2908 #endif
2909 	}
2910     }
2911 
2912     return TRUE;
2913 }
2914 
2915 static symtab_t *
2916 pnpproto(pnpid_t *id)
2917 {
2918     symtab_t *t;
2919     int i, j;
2920 
2921     if (id->nclass > 0)
2922 	if (strncmp(id->class, "MOUSE", id->nclass) != 0 &&
2923 	    strncmp(id->class, "TABLET", id->nclass) != 0)
2924 	    /* this is not a mouse! */
2925 	    return NULL;
2926 
2927     if (id->neisaid > 0) {
2928 	t = gettoken(pnpprod, id->eisaid, id->neisaid);
2929 	if (t->val != MOUSE_PROTO_UNKNOWN)
2930 	    return t;
2931     }
2932 
2933     /*
2934      * The 'Compatible drivers' field may contain more than one
2935      * ID separated by ','.
2936      */
2937     if (id->ncompat <= 0)
2938 	return NULL;
2939     for (i = 0; i < id->ncompat; ++i) {
2940 	for (j = i; id->compat[i] != ','; ++i)
2941 	    if (i >= id->ncompat)
2942 		break;
2943 	if (i > j) {
2944 	    t = gettoken(pnpprod, id->compat + j, i - j);
2945 	    if (t->val != MOUSE_PROTO_UNKNOWN)
2946 		return t;
2947 	}
2948     }
2949 
2950     return NULL;
2951 }
2952 
2953 /* name/val mapping */
2954 
2955 static symtab_t *
2956 gettoken(symtab_t *tab, char *s, int len)
2957 {
2958     int i;
2959 
2960     for (i = 0; tab[i].name != NULL; ++i) {
2961 	if (strncmp(tab[i].name, s, len) == 0)
2962 	    break;
2963     }
2964     return &tab[i];
2965 }
2966 
2967 static char *
2968 gettokenname(symtab_t *tab, int val)
2969 {
2970     int i;
2971 
2972     for (i = 0; tab[i].name != NULL; ++i) {
2973 	if (tab[i].val == val)
2974 	    return tab[i].name;
2975     }
2976     return NULL;
2977 }
2978 
2979 
2980 /*
2981  * code to read from the Genius Kidspad tablet.
2982 
2983 The tablet responds to the COM PnP protocol 1.0 with EISA-ID KYE0005,
2984 and to pre-pnp probes (RTS toggle) with 'T' (tablet ?)
2985 9600, 8 bit, parity odd.
2986 
2987 The tablet puts out 5 bytes. b0 (mask 0xb8, value 0xb8) contains
2988 the proximity, tip and button info:
2989    (byte0 & 0x1)	true = tip pressed
2990    (byte0 & 0x2)	true = button pressed
2991    (byte0 & 0x40)	false = pen in proximity of tablet.
2992 
2993 The next 4 bytes are used for coordinates xl, xh, yl, yh (7 bits valid).
2994 
2995 Only absolute coordinates are returned, so we use the following approach:
2996 we store the last coordinates sent when the pen went out of the tablet,
2997 
2998 
2999  *
3000  */
3001 
3002 typedef enum {
3003     S_IDLE, S_PROXY, S_FIRST, S_DOWN, S_UP
3004 } k_status ;
3005 
3006 static int
3007 kidspad(u_char rxc, mousestatus_t *act)
3008 {
3009     static int buf[5];
3010     static int buflen = 0, b_prev = 0 , x_prev = -1, y_prev = -1 ;
3011     static k_status status = S_IDLE ;
3012     static struct timeval old, now ;
3013 
3014     int x, y ;
3015 
3016     if (buflen > 0 && (rxc & 0x80)) {
3017 	fprintf(stderr, "invalid code %d 0x%x\n", buflen, rxc);
3018 	buflen = 0 ;
3019     }
3020     if (buflen == 0 && (rxc & 0xb8) != 0xb8) {
3021 	fprintf(stderr, "invalid code 0 0x%x\n", rxc);
3022 	return 0 ; /* invalid code, no action */
3023     }
3024     buf[buflen++] = rxc ;
3025     if (buflen < 5)
3026 	return 0 ;
3027 
3028     buflen = 0 ; /* for next time... */
3029 
3030     x = buf[1]+128*(buf[2] - 7) ;
3031     if (x < 0) x = 0 ;
3032     y = 28*128 - (buf[3] + 128* (buf[4] - 7)) ;
3033     if (y < 0) y = 0 ;
3034 
3035     x /= 8 ;
3036     y /= 8 ;
3037 
3038     act->flags = 0 ;
3039     act->obutton = act->button ;
3040     act->dx = act->dy = act->dz = 0 ;
3041     gettimeofday(&now, NULL);
3042     if (buf[0] & 0x40) /* pen went out of reach */
3043 	status = S_IDLE ;
3044     else if (status == S_IDLE) { /* pen is newly near the tablet */
3045 	act->flags |= MOUSE_POSCHANGED ; /* force update */
3046 	status = S_PROXY ;
3047 	x_prev = x ;
3048 	y_prev = y ;
3049     }
3050     old = now ;
3051     act->dx = x - x_prev ;
3052     act->dy = y - y_prev ;
3053     if (act->dx || act->dy)
3054 	act->flags |= MOUSE_POSCHANGED ;
3055     x_prev = x ;
3056     y_prev = y ;
3057     if (b_prev != 0 && b_prev != buf[0]) { /* possibly record button change */
3058 	act->button = 0 ;
3059 	if (buf[0] & 0x01) /* tip pressed */
3060 	    act->button |= MOUSE_BUTTON1DOWN ;
3061 	if (buf[0] & 0x02) /* button pressed */
3062 	    act->button |= MOUSE_BUTTON2DOWN ;
3063 	act->flags |= MOUSE_BUTTONSCHANGED ;
3064     }
3065     b_prev = buf[0] ;
3066     return act->flags ;
3067 }
3068 
3069 static void
3070 mremote_serversetup()
3071 {
3072     struct sockaddr_un ad;
3073 
3074     /* Open a UNIX domain stream socket to listen for mouse remote clients */
3075     unlink(_PATH_MOUSEREMOTE);
3076 
3077     if ((rodent.mremsfd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0)
3078 	logerrx(1, "unable to create unix domain socket %s",_PATH_MOUSEREMOTE);
3079 
3080     umask(0111);
3081 
3082     bzero(&ad, sizeof(ad));
3083     ad.sun_family = AF_UNIX;
3084     strcpy(ad.sun_path, _PATH_MOUSEREMOTE);
3085 #ifndef SUN_LEN
3086 #define SUN_LEN(unp) (((char *)(unp)->sun_path - (char *)(unp)) + \
3087 		       strlen((unp)->path))
3088 #endif
3089     if (bind(rodent.mremsfd, (struct sockaddr *) &ad, SUN_LEN(&ad)) < 0)
3090 	logerrx(1, "unable to bind unix domain socket %s", _PATH_MOUSEREMOTE);
3091 
3092     listen(rodent.mremsfd, 1);
3093 }
3094 
3095 static void
3096 mremote_clientchg(int add)
3097 {
3098     struct sockaddr_un ad;
3099     int ad_len, fd;
3100 
3101     if (rodent.rtype != MOUSE_PROTO_X10MOUSEREM)
3102 	return;
3103 
3104     if (add) {
3105 	/*  Accept client connection, if we don't already have one  */
3106 	ad_len = sizeof(ad);
3107 	fd = accept(rodent.mremsfd, (struct sockaddr *) &ad, &ad_len);
3108 	if (fd < 0)
3109 	    logwarnx("failed accept on mouse remote socket");
3110 
3111 	if (rodent.mremcfd < 0) {
3112 	    rodent.mremcfd = fd;
3113 	    debug("remote client connect...accepted");
3114 	}
3115 	else {
3116 	    close(fd);
3117 	    debug("another remote client connect...disconnected");
3118 	}
3119     }
3120     else {
3121 	/* Client disconnected */
3122 	debug("remote client disconnected");
3123 	close(rodent.mremcfd);
3124 	rodent.mremcfd = -1;
3125     }
3126 }
3127