summaryrefslogtreecommitdiff
path: root/hw/dmx/input/lnx-ms.c
blob: 6df4e80d3b7b47088f9237ff2cd20750ac592c28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/* $XFree86$ */
/* Portions of this file were derived from the following files:
 *
 **********************************************************************
 *
 * Xserver/hw/kdrive/linux/ms.c
 *
 * Copyright (c) 2001 by Juliusz Chroboczek
 * Copyright (c) 1999 by Keith Packard
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

/*
 * Copyright 2001-2003 Red Hat Inc., Durham, North Carolina.
 *
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation on the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/*
 * Authors:
 *   Rickard E. (Rik) Faith <faith@redhat.com>
 *
 */

/** \file
 *
 * This code implements a low-level device driver for a serial MS mouse.
 * The code is derived from code by Juliusz Chroboczek and Keith Packard
 * (see the source code for complete references). */

#ifdef HAVE_DMX_CONFIG_H
#include <dmx-config.h>
#endif

#include "inputstr.h"
#include <X11/Xos.h>
#include <errno.h>
#include <termios.h>

/*****************************************************************************/
/* Define some macros to make it easier to move this file to another
 * part of the Xserver tree.  All calls to the dmx* layer are #defined
 * here for the .c file.  The .h file will also have to be edited. */
#include "dmxinputinit.h"
#include "lnx-ms.h"

#define GETPRIV       myPrivate *priv                            \
                      = ((DMXLocalInputInfoPtr)(pDev->devicePrivate))->private

#define LOG0(f)       dmxLog(dmxDebug,f)
#define LOG1(f,a)     dmxLog(dmxDebug,f,a)
#define LOG2(f,a,b)   dmxLog(dmxDebug,f,a,b)
#define LOG3(f,a,b,c) dmxLog(dmxDebug,f,a,b,c)
#define FATAL0(f)     dmxLog(dmxFatal,f)
#define FATAL1(f,a)   dmxLog(dmxFatal,f,a)
#define FATAL2(f,a,b) dmxLog(dmxFatal,f,a,b)
#define MOTIONPROC    dmxMotionProcPtr
#define ENQUEUEPROC   dmxEnqueueProcPtr
#define CHECKPROC     dmxCheckSpecialProcPtr
#define BLOCK         DMXBlockType

/* End of interface definitions. */
/*****************************************************************************/

/* Private area for MS mouse devices. */
typedef struct _myPrivate {
    DeviceIntPtr   pMouse;
    int            fd;
    struct termios tty;
    enum {
        button1 = 0x0001,
        button2 = 0x0002,
        button3 = 0x0004,
        button4 = 0x0008,
        button5 = 0x0010
    }              buttons;
} myPrivate;

static int msLinuxReadBytes(int fd, unsigned char *buf, int len, int min)
{
    int		    n, tot;
    fd_set	    set;
    struct timeval  tv;
    
    tot = 0;
    while (len) {
        n = read(fd, buf, len);
        if (n > 0) {
            tot += n;
	    buf += n;
	    len -= n;
	}
	if (tot % min == 0) break;
	FD_ZERO(&set);
	FD_SET(fd, &set);
	tv.tv_sec = 0;
	tv.tv_usec = 100 * 1000;
	n = select(fd + 1, &set, 0, 0, &tv);
	if (n <= 0) break;
    }
    return tot;
}

static void msLinuxButton(DevicePtr pDev, ENQUEUEPROC enqueue, int buttons,
                          BLOCK block)
{
    GETPRIV;

#define PRESS(b)                                         \
    do {                                                 \
        enqueue(pDev, ButtonPress, 0, 0, NULL, block);   \
    } while (0)

#define RELEASE(b)                                       \
    do {                                                 \
        enqueue(pDev, ButtonRelease, 0, 0, NULL, block); \
    } while (0)
          
    if ((buttons & button1) && !(priv->buttons & button1)) PRESS(1);
    if (!(buttons & button1) && (priv->buttons & button1)) RELEASE(1);

    if ((buttons & button2) && !(priv->buttons & button2)) PRESS(2);
    if (!(buttons & button2) && (priv->buttons & button2)) RELEASE(2);

    if ((buttons & button3) && !(priv->buttons & button3)) PRESS(3);
    if (!(buttons & button3) && (priv->buttons & button3)) RELEASE(3);

    if ((buttons & button4) && !(priv->buttons & button4)) PRESS(4);
    if (!(buttons & button4) && (priv->buttons & button4)) RELEASE(4);
    
    if ((buttons & button5) && !(priv->buttons & button5)) PRESS(5);
    if (!(buttons & button5) && (priv->buttons & button5)) RELEASE(5);

    priv->buttons = buttons;
}

/** Read an event from the \a pDev device.  If the event is a motion
 * event, enqueue it with the \a motion function.  Otherwise, check for
 * special keys with the \a checkspecial function and enqueue the event
 * with the \a enqueue function.  The \a block type is passed to the
 * functions so that they may block SIGIO handling as appropriate to the
 * caller of this function. */
void msLinuxRead(DevicePtr pDev,
                 MOTIONPROC motion,
                 ENQUEUEPROC enqueue,
                 CHECKPROC checkspecial,
                 BLOCK block)
{
    GETPRIV;
    unsigned char   buf[3 * 200]; /* RATS: Use ok */
    unsigned char   *b;
    int		    n;
    int		    dx, dy, v[2];

    while ((n = msLinuxReadBytes(priv->fd, buf, sizeof(buf), 3)) > 0) {
	b = buf;
	while (n >= 3) {
	    dx   = (char)(((b[0] & 0x03) << 6) | (b[1] & 0x3f));
	    dy   = (char)(((b[0] & 0x0c) << 4) | (b[2] & 0x3f));
            v[0] = -dx;
            v[1] = -dy;
            
            motion(pDev, v, 0, 2, 1, block);
            msLinuxButton(pDev, enqueue, (((b[0] & 0x10) ? button3 : 0)
                                          | ((b[0] & 0x20) ? button1 : 0)),
                          block);
            n -= 3;
            b += 3;
	}
    }
}

/** Initialize \a pDev. */
void msLinuxInit(DevicePtr pDev)
{
    GETPRIV;
    const char *names[] = { "/dev/serialmouse", "/dev/mouse", NULL };
    int        i;

    if (priv->fd >=0) return;

    for (i = 0; names[i]; i++) {
        if ((priv->fd = open(names[i], O_RDWR | O_NONBLOCK, 0)) >= 0) break;
    }
    if (priv->fd < 0)
        FATAL1("msLinuxInit: Cannot open mouse port (%s)\n",
               strerror(errno));
    
    if (!isatty(priv->fd))
        FATAL1("msLinuxInit: Mouse port %s is not a tty\n", names[i]);

    if (tcgetattr(priv->fd, &priv->tty) < 0)
        FATAL1("msLinuxInit: tcgetattr failed (%s)\n", strerror(errno));

    write(priv->fd, "*n", 2);   /* 1200 baud */
    usleep(100000);
}

/** Turn \a pDev on (i.e., take input from \a pDev). */
int msLinuxOn(DevicePtr pDev)
{
    GETPRIV;
    struct termios nTty;

    if (priv->fd < 0) msLinuxInit(pDev);
    
    nTty             = priv->tty;
    nTty.c_iflag    &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR
                         | IGNCR | ICRNL | IXON | IXOFF);
    nTty.c_oflag    &= ~OPOST;
    nTty.c_lflag    &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
    nTty.c_cflag    &= ~(CSIZE | PARENB);
    nTty.c_cflag    |= CS8 | CLOCAL | CSTOPB;
    nTty.c_cc[VTIME] = 0;
    nTty.c_cc[VMIN]  = 1;
    cfsetispeed (&nTty, B1200);
    cfsetospeed (&nTty, B1200);
    if (tcsetattr(priv->fd, TCSANOW, &nTty) < 0)
        FATAL1("msLinuxInit: tcsetattr failed (%s)\n", strerror(errno));
    write(priv->fd, "*V", 2);   /* 2 button 3 byte protocol */
    return priv->fd;
}

/** Turn \a pDev off (i.e., stop taking input from \a pDev). */
void msLinuxOff(DevicePtr pDev)
{
    GETPRIV;

    tcsetattr(priv->fd, TCSANOW, &priv->tty);
    close(priv->fd);
    priv->fd = -1;
}

static void msLinuxGetMap(DevicePtr pDev, unsigned char *map, int *nButtons)
{
    int i;
    
    if (nButtons) *nButtons = 3;
    if (map) for (i = 0; i <= *nButtons; i++) map[i] = i;
}

/** Currently unused hook called prior to an VT switch. */
void msLinuxVTPreSwitch(pointer p)
{
}

/** Currently unused hook called after returning from a VT switch. */
void msLinuxVTPostSwitch(pointer p)
{
}

/** Create a private structure for use within this file. */
pointer msLinuxCreatePrivate(DeviceIntPtr pMouse)
{
    myPrivate *priv = xalloc(sizeof(*priv));
    memset(priv, 0, sizeof(*priv));
    priv->fd     = -1;
    priv->pMouse = pMouse;
    return priv;
}

/** Destroy a private structure. */
void msLinuxDestroyPrivate(pointer priv)
{
    if (priv) xfree(priv);
}

/** Fill the \a info structure with information needed to initialize \a
 * pDev. */ 
void msLinuxGetInfo(DevicePtr pDev, DMXLocalInitInfoPtr info)
{
    info->buttonClass      = 1;
    msLinuxGetMap(pDev, info->map, &info->numButtons);
    info->valuatorClass    = 1;
    info->numRelAxes       = 2;
    info->minval[0]        = 0;
    info->maxval[0]        = 0;
    info->res[0]           = 1;
    info->minres[0]        = 0;
    info->maxres[0]        = 1;
    info->ptrFeedbackClass = 1;
}