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