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