xref: /dflybsd-src/sys/dev/misc/syscons/sysmouse.c (revision 095f0dab393e9460c772f589858779f7bf10c3ac)
1 /*-
2  * (MPSAFE)
3  *
4  * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer as
12  *    the first lines of this file unmodified.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD: src/sys/dev/syscons/sysmouse.c,v 1.2.2.2 2001/07/16 05:21:24 yokota Exp $
29  */
30 
31 /* MPSAFE NOTE: This file uses the tty_token mostly for the linesw access and
32  *		for the internal mouse structures. The latter ones could be protected
33  *		by a local lock.
34  */
35 #include "opt_syscons.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/conf.h>
40 #include <sys/proc.h>
41 #include <sys/priv.h>
42 #include <sys/tty.h>
43 #include <sys/kernel.h>
44 #include <sys/thread2.h>
45 
46 #include <machine/console.h>
47 #include <sys/mouse.h>
48 
49 #include "syscons.h"
50 
51 #ifndef SC_NO_SYSMOUSE
52 
53 static d_open_t		smopen;
54 static d_close_t	smclose;
55 static d_ioctl_t	smioctl;
56 
57 static struct dev_ops sm_ops = {
58 	{ "sysmouse", 0, D_TTY | D_MPSAFE },
59 	.d_open =	smopen,
60 	.d_close =	smclose,
61 	.d_read =	ttyread,
62 	.d_ioctl =	smioctl,
63 	.d_kqfilter =	ttykqfilter,
64 	.d_revoke =	ttyrevoke
65 };
66 
67 /* local variables */
68 static struct tty	*sysmouse_tty;
69 static int		mouse_level;	/* sysmouse protocol level */
70 static mousestatus_t	mouse_status;
71 
72 static void		smstart(struct tty *tp);
73 static int		smparam(struct tty *tp, struct termios *t);
74 
75 static int
76 smopen(struct dev_open_args *ap)
77 {
78 	cdev_t dev = ap->a_head.a_dev;
79 	struct tty *tp;
80 	int ret;
81 
82 	DPRINTF(5, ("smopen: dev:%d,%d, vty:%d\n",
83 		major(dev), minor(dev), SC_VTY(dev)));
84 
85 	lwkt_gettoken(&tty_token);
86 	tp = dev->si_tty = ttymalloc(dev->si_tty);
87 	if (!(tp->t_state & TS_ISOPEN)) {
88 		sysmouse_tty = tp;
89 		tp->t_oproc = smstart;
90 		tp->t_param = smparam;
91 		tp->t_stop = nottystop;
92 		tp->t_dev = dev;
93 		ttychars(tp);
94 		tp->t_iflag = 0;
95 		tp->t_oflag = 0;
96 		tp->t_lflag = 0;
97 		tp->t_cflag = TTYDEF_CFLAG;
98 		tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
99 		smparam(tp, &tp->t_termios);
100 		(*linesw[tp->t_line].l_modem)(tp, 1);
101 	} else if (tp->t_state & TS_XCLUDE && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
102 		lwkt_reltoken(&tty_token);
103 		return EBUSY;
104 	}
105 
106 	ret = (*linesw[tp->t_line].l_open)(dev, tp);
107 	lwkt_reltoken(&tty_token);
108 	return ret;
109 }
110 
111 static int
112 smclose(struct dev_close_args *ap)
113 {
114 	cdev_t dev = ap->a_head.a_dev;
115 	struct tty *tp;
116 
117 	tp = dev->si_tty;
118 	crit_enter();
119 	lwkt_gettoken(&tty_token);
120 	mouse_level = 0;
121 	(*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
122 	ttyclose(tp);
123 	lwkt_reltoken(&tty_token);
124 	crit_exit();
125 
126 	return 0;
127 }
128 
129 static void
130 smstart(struct tty *tp)
131 {
132 	struct clist *rbp;
133 	u_char buf[PCBURST];
134 
135 	crit_enter();
136 	lwkt_gettoken(&tty_token);
137 	if (!(tp->t_state & (TS_TIMEOUT | TS_BUSY | TS_TTSTOP))) {
138 		tp->t_state |= TS_BUSY;
139 		rbp = &tp->t_outq;
140 		while (rbp->c_cc)
141 			q_to_b(rbp, buf, PCBURST);
142 		tp->t_state &= ~TS_BUSY;
143 		ttwwakeup(tp);
144 	}
145 	lwkt_reltoken(&tty_token);
146 	crit_exit();
147 }
148 
149 static int
150 smparam(struct tty *tp, struct termios *t)
151 {
152 	lwkt_gettoken(&tty_token);
153 	tp->t_ispeed = t->c_ispeed;
154 	tp->t_ospeed = t->c_ospeed;
155 	tp->t_cflag = t->c_cflag;
156 	lwkt_reltoken(&tty_token);
157 	return 0;
158 }
159 
160 static int
161 smioctl(struct dev_ioctl_args *ap)
162 {
163 	cdev_t dev = ap->a_head.a_dev;
164 	struct tty *tp;
165 	mousehw_t *hw;
166 	mousemode_t *mode;
167 	int error;
168 
169 	lwkt_gettoken(&tty_token);
170 	tp = dev->si_tty;
171 
172 	switch (ap->a_cmd) {
173 	case MOUSE_GETHWINFO:	/* get device information */
174 		hw = (mousehw_t *)ap->a_data;
175 		hw->buttons = 10;		/* XXX unknown */
176 		hw->iftype = MOUSE_IF_SYSMOUSE;
177 		hw->type = MOUSE_MOUSE;
178 		hw->model = MOUSE_MODEL_GENERIC;
179 		hw->hwid = 0;
180 		lwkt_reltoken(&tty_token);
181 		return 0;
182 
183 	case MOUSE_GETMODE:	/* get protocol/mode */
184 		mode = (mousemode_t *)ap->a_data;
185 		mode->level = mouse_level;
186 		switch (mode->level) {
187 		case 0: /* emulate MouseSystems protocol */
188 			mode->protocol = MOUSE_PROTO_MSC;
189 			mode->rate = -1;		/* unknown */
190 			mode->resolution = -1;	/* unknown */
191 			mode->accelfactor = 0;	/* disabled */
192 			mode->packetsize = MOUSE_MSC_PACKETSIZE;
193 			mode->syncmask[0] = MOUSE_MSC_SYNCMASK;
194 			mode->syncmask[1] = MOUSE_MSC_SYNC;
195 			break;
196 
197 		case 1: /* sysmouse protocol */
198 			mode->protocol = MOUSE_PROTO_SYSMOUSE;
199 			mode->rate = -1;
200 			mode->resolution = -1;
201 			mode->accelfactor = 0;
202 			mode->packetsize = MOUSE_SYS_PACKETSIZE;
203 			mode->syncmask[0] = MOUSE_SYS_SYNCMASK;
204 			mode->syncmask[1] = MOUSE_SYS_SYNC;
205 			break;
206 		}
207 		lwkt_reltoken(&tty_token);
208 		return 0;
209 
210 	case MOUSE_SETMODE:	/* set protocol/mode */
211 		mode = (mousemode_t *)ap->a_data;
212 		if (mode->level == -1)
213 			; 	/* don't change the current setting */
214 		else if ((mode->level < 0) || (mode->level > 1)) {
215 			lwkt_reltoken(&tty_token);
216 			return EINVAL;
217 		} else {
218 			mouse_level = mode->level;
219 		}
220 		lwkt_reltoken(&tty_token);
221 		return 0;
222 
223 	case MOUSE_GETLEVEL:	/* get operation level */
224 		*(int *)ap->a_data = mouse_level;
225 		lwkt_reltoken(&tty_token);
226 		return 0;
227 
228 	case MOUSE_SETLEVEL:	/* set operation level */
229 		if ((*(int *)ap->a_data  < 0) || (*(int *)ap->a_data > 1)) {
230 			lwkt_reltoken(&tty_token);
231 			return EINVAL;
232 		}
233 		mouse_level = *(int *)ap->a_data;
234 		lwkt_reltoken(&tty_token);
235 		return 0;
236 
237 	case MOUSE_GETSTATUS:	/* get accumulated mouse events */
238 		crit_enter();
239 		*(mousestatus_t *)ap->a_data = mouse_status;
240 		mouse_status.flags = 0;
241 		mouse_status.obutton = mouse_status.button;
242 		mouse_status.dx = 0;
243 		mouse_status.dy = 0;
244 		mouse_status.dz = 0;
245 		crit_exit();
246 		lwkt_reltoken(&tty_token);
247 		return 0;
248 
249 #if 0 /* notyet */
250 	case MOUSE_GETVARS:	/* get internal mouse variables */
251 	case MOUSE_SETVARS:	/* set internal mouse variables */
252 		lwkt_reltoken(&tty_token);
253 		return ENODEV;
254 #endif
255 
256 	case MOUSE_READSTATE:	/* read status from the device */
257 	case MOUSE_READDATA:	/* read data from the device */
258 		lwkt_reltoken(&tty_token);
259 		return ENODEV;
260 	}
261 
262 	error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
263 	if (error != ENOIOCTL) {
264 		lwkt_reltoken(&tty_token);
265 		return error;
266 	}
267 	error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
268 	if (error != ENOIOCTL) {
269 		lwkt_reltoken(&tty_token);
270 		return error;
271 	}
272 	lwkt_reltoken(&tty_token);
273 	return ENOTTY;
274 }
275 
276 static void
277 sm_attach_mouse(void *unused)
278 {
279 	cdev_t dev;
280 
281 	dev = make_dev(&sm_ops, 0, UID_ROOT, GID_WHEEL, 0600, "sysmouse");
282 	/* sysmouse doesn't have scr_stat */
283 }
284 
285 SYSINIT(sysmouse, SI_SUB_DRIVERS, SI_ORDER_ANY, sm_attach_mouse, NULL);
286 
287 int
288 sysmouse_event(mouse_info_t *info)
289 {
290 	/* MOUSE_BUTTON?DOWN -> MOUSE_MSC_BUTTON?UP */
291 	static int butmap[8] = {
292 	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
293 	    MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
294 	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
295 	    MOUSE_MSC_BUTTON3UP,
296 	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
297 	    MOUSE_MSC_BUTTON2UP,
298 	    MOUSE_MSC_BUTTON1UP,
299 	    0,
300 	};
301 	u_char buf[8];
302 	int x, y, z;
303 	int i;
304 
305 	lwkt_gettoken(&tty_token);
306 	switch (info->operation) {
307 	case MOUSE_ACTION:
308         	mouse_status.button = info->u.data.buttons;
309 		/* FALL THROUGH */
310 	case MOUSE_MOTION_EVENT:
311 		x = info->u.data.x;
312 		y = info->u.data.y;
313 		z = info->u.data.z;
314 		break;
315 	case MOUSE_BUTTON_EVENT:
316 		x = y = z = 0;
317 		if (info->u.event.value > 0)
318 			mouse_status.button |= info->u.event.id;
319 		else
320 			mouse_status.button &= ~info->u.event.id;
321 		break;
322 	default:
323 		lwkt_reltoken(&tty_token);
324 		return 0;
325 	}
326 
327 	mouse_status.dx += x;
328 	mouse_status.dy += y;
329 	mouse_status.dz += z;
330 	mouse_status.flags |= ((x || y || z) ? MOUSE_POSCHANGED : 0)
331 			      | (mouse_status.obutton ^ mouse_status.button);
332 	if (mouse_status.flags == 0) {
333 		lwkt_reltoken(&tty_token);
334 		return 0;
335 	}
336 
337 	if ((sysmouse_tty == NULL) || !(sysmouse_tty->t_state & TS_ISOPEN)) {
338 		lwkt_reltoken(&tty_token);
339 		return mouse_status.flags;
340 	}
341 
342 	/* the first five bytes are compatible with MouseSystems' */
343 	buf[0] = MOUSE_MSC_SYNC
344 		 | butmap[mouse_status.button & MOUSE_STDBUTTONS];
345 	x = imax(imin(x, 255), -256);
346 	buf[1] = x >> 1;
347 	buf[3] = x - buf[1];
348 	y = -imax(imin(y, 255), -256);
349 	buf[2] = y >> 1;
350 	buf[4] = y - buf[2];
351 	for (i = 0; i < MOUSE_MSC_PACKETSIZE; ++i)
352 		(*linesw[sysmouse_tty->t_line].l_rint)(buf[i], sysmouse_tty);
353 	if (mouse_level >= 1) {
354 		/* extended part */
355         	z = imax(imin(z, 127), -128);
356         	buf[5] = (z >> 1) & 0x7f;
357         	buf[6] = (z - (z >> 1)) & 0x7f;
358         	/* buttons 4-10 */
359         	buf[7] = (~mouse_status.button >> 3) & 0x7f;
360         	for (i = MOUSE_MSC_PACKETSIZE; i < MOUSE_SYS_PACKETSIZE; ++i)
361 			(*linesw[sysmouse_tty->t_line].l_rint)(buf[i],
362 							       sysmouse_tty);
363 	}
364 
365 	lwkt_reltoken(&tty_token);
366 	return mouse_status.flags;
367 }
368 
369 #endif /* !SC_NO_SYSMOUSE */
370