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