sysmouse.c revision 65129
1/*-
2 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3 * 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 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/syscons/sysmouse.c 65129 2000-08-27 12:36:28Z yokota $
27 */
28
29#include "opt_syscons.h"
30
31#include <sys/param.h>
32#include <sys/systm.h>
33#include <sys/conf.h>
34#include <sys/proc.h>
35#include <sys/random.h>
36#include <sys/tty.h>
37#include <sys/kernel.h>
38
39#include <machine/console.h>
40#include <machine/mouse.h>
41
42#include <dev/syscons/syscons.h>
43
44#ifndef SC_NO_SYSMOUSE
45
46#define	CDEV_MAJOR	12		/* major number, shared with syscons */
47#define SC_MOUSE 	128		/* minor number */
48
49static d_open_t		smopen;
50static d_close_t	smclose;
51static d_ioctl_t	smioctl;
52
53static struct cdevsw sm_cdevsw = {
54	/* open */	smopen,
55	/* close */	smclose,
56	/* read */	ttyread,
57	/* write */	nowrite,
58	/* ioctl */	smioctl,
59	/* poll */	ttypoll,
60	/* mmap */	nommap,
61	/* strategy */	nostrategy,
62	/* name */	"sysmouse",
63	/* maj */	CDEV_MAJOR,
64	/* dump */	nodump,
65	/* psize */	nopsize,
66	/* flags */	D_TTY,
67	/* bmaj */	-1
68};
69
70/* local variables */
71static struct tty	*sysmouse_tty;
72static int		mouse_level;	/* sysmouse protocol level */
73static mousestatus_t	mouse_status;
74
75static void		smstart(struct tty *tp);
76static int		smparam(struct tty *tp, struct termios *t);
77
78static int
79smopen(dev_t dev, int flag, int mode, struct proc *p)
80{
81	struct tty *tp;
82
83	DPRINTF(5, ("smopen: dev:%d,%d, vty:%d\n",
84		major(dev), minor(dev), SC_VTY(dev)));
85
86#if 0
87	if (SC_VTY(dev) != SC_MOUSE)
88		return ENXIO;
89#endif
90
91	tp = dev->si_tty = ttymalloc(dev->si_tty);
92	if (!(tp->t_state & TS_ISOPEN)) {
93		tp->t_oproc = smstart;
94		tp->t_param = smparam;
95		tp->t_stop = nottystop;
96		tp->t_dev = dev;
97		ttychars(tp);
98		tp->t_iflag = TTYDEF_IFLAG;
99		tp->t_oflag = TTYDEF_OFLAG;
100		tp->t_cflag = TTYDEF_CFLAG;
101		tp->t_lflag = TTYDEF_LFLAG;
102		tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
103		smparam(tp, &tp->t_termios);
104		(*linesw[tp->t_line].l_modem)(tp, 1);
105	} else if (tp->t_state & TS_XCLUDE && suser(p)) {
106		return EBUSY;
107	}
108
109	return (*linesw[tp->t_line].l_open)(dev, tp);
110}
111
112static int
113smclose(dev_t dev, int flag, int mode, struct proc *p)
114{
115	struct tty *tp;
116	int s;
117
118	tp = dev->si_tty;
119	s = spltty();
120	mouse_level = 0;
121	(*linesw[tp->t_line].l_close)(tp, flag);
122	ttyclose(tp);
123	splx(s);
124
125	return 0;
126}
127
128static void
129smstart(struct tty *tp)
130{
131	struct clist *rbp;
132	u_char buf[PCBURST];
133	int s;
134
135	s = spltty();
136	if (!(tp->t_state & (TS_TIMEOUT | TS_BUSY | TS_TTSTOP))) {
137		tp->t_state |= TS_BUSY;
138		rbp = &tp->t_outq;
139		while (rbp->c_cc)
140			q_to_b(rbp, buf, PCBURST);
141		tp->t_state &= ~TS_BUSY;
142		ttwwakeup(tp);
143	}
144	splx(s);
145}
146
147static int
148smparam(struct tty *tp, struct termios *t)
149{
150	tp->t_ispeed = t->c_ispeed;
151	tp->t_ospeed = t->c_ospeed;
152	tp->t_cflag = t->c_cflag;
153	return 0;
154}
155
156static int
157smioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct proc *p)
158{
159	struct tty *tp;
160	mousehw_t *hw;
161	mousemode_t *mode;
162	int error;
163	int s;
164
165	tp = dev->si_tty;
166	switch (cmd) {
167
168	case MOUSE_GETHWINFO:	/* get device information */
169		hw = (mousehw_t *)data;
170		hw->buttons = 10;		/* XXX unknown */
171		hw->iftype = MOUSE_IF_SYSMOUSE;
172		hw->type = MOUSE_MOUSE;
173		hw->model = MOUSE_MODEL_GENERIC;
174		hw->hwid = 0;
175		return 0;
176
177	case MOUSE_GETMODE:	/* get protocol/mode */
178		mode = (mousemode_t *)data;
179		mode->level = mouse_level;
180		switch (mode->level) {
181		case 0: /* emulate MouseSystems protocol */
182			mode->protocol = MOUSE_PROTO_MSC;
183			mode->rate = -1;		/* unknown */
184			mode->resolution = -1;	/* unknown */
185			mode->accelfactor = 0;	/* disabled */
186			mode->packetsize = MOUSE_MSC_PACKETSIZE;
187			mode->syncmask[0] = MOUSE_MSC_SYNCMASK;
188			mode->syncmask[1] = MOUSE_MSC_SYNC;
189			break;
190
191		case 1: /* sysmouse protocol */
192			mode->protocol = MOUSE_PROTO_SYSMOUSE;
193			mode->rate = -1;
194			mode->resolution = -1;
195			mode->accelfactor = 0;
196			mode->packetsize = MOUSE_SYS_PACKETSIZE;
197			mode->syncmask[0] = MOUSE_SYS_SYNCMASK;
198			mode->syncmask[1] = MOUSE_SYS_SYNC;
199			break;
200		}
201		return 0;
202
203	case MOUSE_SETMODE:	/* set protocol/mode */
204		mode = (mousemode_t *)data;
205		if (mode->level == -1)
206			; 	/* don't change the current setting */
207		else if ((mode->level < 0) || (mode->level > 1))
208			return EINVAL;
209		else
210			mouse_level = mode->level;
211		return 0;
212
213	case MOUSE_GETLEVEL:	/* get operation level */
214		*(int *)data = mouse_level;
215		return 0;
216
217	case MOUSE_SETLEVEL:	/* set operation level */
218		if ((*(int *)data  < 0) || (*(int *)data > 1))
219			return EINVAL;
220		mouse_level = *(int *)data;
221		return 0;
222
223	case MOUSE_GETSTATUS:	/* get accumulated mouse events */
224		s = spltty();
225		*(mousestatus_t *)data = mouse_status;
226		mouse_status.flags = 0;
227		mouse_status.obutton = mouse_status.button;
228		mouse_status.dx = 0;
229		mouse_status.dy = 0;
230		mouse_status.dz = 0;
231		splx(s);
232		return 0;
233
234#if notyet
235	case MOUSE_GETVARS:	/* get internal mouse variables */
236	case MOUSE_SETVARS:	/* set internal mouse variables */
237		return ENODEV;
238#endif
239
240	case MOUSE_READSTATE:	/* read status from the device */
241	case MOUSE_READDATA:	/* read data from the device */
242		return ENODEV;
243	}
244
245	error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, p);
246	if (error != ENOIOCTL)
247		return error;
248	error = ttioctl(tp, cmd, data, flag);
249	if (error != ENOIOCTL)
250		return error;
251	return ENOTTY;
252}
253
254static void
255sm_attach_mouse(void *unused)
256{
257	dev_t dev;
258
259	dev = make_dev(&sm_cdevsw, SC_MOUSE, UID_ROOT, GID_WHEEL, 0600,
260		       "sysmouse");
261	dev->si_tty = sysmouse_tty = ttymalloc(sysmouse_tty);
262	/* sysmouse doesn't have scr_stat */
263}
264
265SYSINIT(sysmouse, SI_SUB_DRIVERS, SI_ORDER_MIDDLE + CDEV_MAJOR,
266	sm_attach_mouse, NULL)
267
268int
269sysmouse_event(mouse_info_t *info)
270{
271	/* MOUSE_BUTTON?DOWN -> MOUSE_MSC_BUTTON?UP */
272	static int butmap[8] = {
273	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
274	    MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
275	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
276	    MOUSE_MSC_BUTTON3UP,
277	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
278	    MOUSE_MSC_BUTTON2UP,
279	    MOUSE_MSC_BUTTON1UP,
280	    0,
281	};
282	u_char buf[8];
283	int x, y, z;
284	int i;
285
286	switch (info->operation) {
287	case MOUSE_ACTION:
288        	mouse_status.button = info->u.data.buttons;
289		/* FALL THROUGH */
290	case MOUSE_MOTION_EVENT:
291		x = info->u.data.x;
292		y = info->u.data.y;
293		z = info->u.data.z;
294		break;
295	case MOUSE_BUTTON_EVENT:
296		x = y = z = 0;
297		if (info->u.event.value > 0)
298			mouse_status.button |= info->u.event.id;
299		else
300			mouse_status.button &= ~info->u.event.id;
301		break;
302	default:
303		return 0;
304	}
305
306	mouse_status.dx += x;
307	mouse_status.dy += y;
308	mouse_status.dz += z;
309	mouse_status.flags |= ((x || y || z) ? MOUSE_POSCHANGED : 0)
310			      | (mouse_status.obutton ^ mouse_status.button);
311	if (mouse_status.flags == 0)
312		return 0;
313
314	if ((sysmouse_tty == NULL) || !(sysmouse_tty->t_state & TS_ISOPEN))
315		return mouse_status.flags;
316
317	/* the first five bytes are compatible with MouseSystems' */
318	buf[0] = MOUSE_MSC_SYNC
319		 | butmap[mouse_status.button & MOUSE_STDBUTTONS];
320	x = imax(imin(x, 255), -256);
321	buf[1] = x >> 1;
322	buf[3] = x - buf[1];
323	y = -imax(imin(y, 255), -256);
324	buf[2] = y >> 1;
325	buf[4] = y - buf[2];
326	for (i = 0; i < MOUSE_MSC_PACKETSIZE; ++i)
327		(*linesw[sysmouse_tty->t_line].l_rint)(buf[i], sysmouse_tty);
328	if (mouse_level >= 1) {
329		/* extended part */
330        	z = imax(imin(z, 127), -128);
331        	buf[5] = (z >> 1) & 0x7f;
332        	buf[6] = (z - (z >> 1)) & 0x7f;
333        	/* buttons 4-10 */
334        	buf[7] = (~mouse_status.button >> 3) & 0x7f;
335        	for (i = MOUSE_MSC_PACKETSIZE; i < MOUSE_SYS_PACKETSIZE; ++i)
336			(*linesw[sysmouse_tty->t_line].l_rint)(buf[i],
337							       sysmouse_tty);
338	}
339
340	random_harvest(buf, sizeof(buf), 2, 0, RANDOM_MOUSE);
341
342	return mouse_status.flags;
343}
344
345#endif /* !SC_NO_SYSMOUSE */
346