xref: /dragonfly/sys/dev/misc/syscons/sysmouse.c (revision dcd37f7d)
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: src/sys/dev/syscons/sysmouse.c,v 1.2.2.2 2001/07/16 05:21:24 yokota Exp $
27  * $DragonFly: src/sys/dev/misc/syscons/sysmouse.c,v 1.12 2006/09/10 01:26:35 dillon Exp $
28  */
29 
30 #include "opt_syscons.h"
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/conf.h>
35 #include <sys/proc.h>
36 #include <sys/priv.h>
37 #include <sys/tty.h>
38 #include <sys/kernel.h>
39 #include <sys/thread2.h>
40 
41 #include <machine/console.h>
42 #include <machine/mouse.h>
43 
44 #include "syscons.h"
45 
46 #ifndef SC_NO_SYSMOUSE
47 
48 #define	CDEV_MAJOR	12		/* major number, shared with syscons */
49 #define SC_MOUSE 	128		/* minor number */
50 
51 static d_open_t		smopen;
52 static d_close_t	smclose;
53 static d_ioctl_t	smioctl;
54 
55 static struct dev_ops sm_ops = {
56 	{ "sysmouse", CDEV_MAJOR, D_TTY | D_KQFILTER },
57 	.d_open =	smopen,
58 	.d_close =	smclose,
59 	.d_read =	ttyread,
60 	.d_ioctl =	smioctl,
61 	.d_kqfilter =	ttykqfilter,
62 	.d_revoke =	ttyrevoke
63 };
64 
65 /* local variables */
66 static struct tty	*sysmouse_tty;
67 static int		mouse_level;	/* sysmouse protocol level */
68 static mousestatus_t	mouse_status;
69 
70 static void		smstart(struct tty *tp);
71 static int		smparam(struct tty *tp, struct termios *t);
72 
73 static int
74 smopen(struct dev_open_args *ap)
75 {
76 	cdev_t dev = ap->a_head.a_dev;
77 	struct tty *tp;
78 
79 	DPRINTF(5, ("smopen: dev:%d,%d, vty:%d\n",
80 		major(dev), minor(dev), SC_VTY(dev)));
81 
82 #if 0
83 	if (SC_VTY(dev) != SC_MOUSE)
84 		return ENXIO;
85 #endif
86 
87 	tp = dev->si_tty = ttymalloc(dev->si_tty);
88 	if (!(tp->t_state & TS_ISOPEN)) {
89 		sysmouse_tty = tp;
90 		tp->t_oproc = smstart;
91 		tp->t_param = smparam;
92 		tp->t_stop = nottystop;
93 		tp->t_dev = dev;
94 		ttychars(tp);
95 		tp->t_iflag = 0;
96 		tp->t_oflag = 0;
97 		tp->t_lflag = 0;
98 		tp->t_cflag = TTYDEF_CFLAG;
99 		tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
100 		smparam(tp, &tp->t_termios);
101 		(*linesw[tp->t_line].l_modem)(tp, 1);
102 	} else if (tp->t_state & TS_XCLUDE && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
103 		return EBUSY;
104 	}
105 
106 	return (*linesw[tp->t_line].l_open)(dev, tp);
107 }
108 
109 static int
110 smclose(struct dev_close_args *ap)
111 {
112 	cdev_t dev = ap->a_head.a_dev;
113 	struct tty *tp;
114 
115 	tp = dev->si_tty;
116 	crit_enter();
117 	mouse_level = 0;
118 	(*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
119 	ttyclose(tp);
120 	crit_exit();
121 
122 	return 0;
123 }
124 
125 static void
126 smstart(struct tty *tp)
127 {
128 	struct clist *rbp;
129 	u_char buf[PCBURST];
130 
131 	crit_enter();
132 	if (!(tp->t_state & (TS_TIMEOUT | TS_BUSY | TS_TTSTOP))) {
133 		tp->t_state |= TS_BUSY;
134 		rbp = &tp->t_outq;
135 		while (rbp->c_cc)
136 			q_to_b(rbp, buf, PCBURST);
137 		tp->t_state &= ~TS_BUSY;
138 		ttwwakeup(tp);
139 	}
140 	crit_exit();
141 }
142 
143 static int
144 smparam(struct tty *tp, struct termios *t)
145 {
146 	tp->t_ispeed = t->c_ispeed;
147 	tp->t_ospeed = t->c_ospeed;
148 	tp->t_cflag = t->c_cflag;
149 	return 0;
150 }
151 
152 static int
153 smioctl(struct dev_ioctl_args *ap)
154 {
155 	cdev_t dev = ap->a_head.a_dev;
156 	struct tty *tp;
157 	mousehw_t *hw;
158 	mousemode_t *mode;
159 	int error;
160 
161 	tp = dev->si_tty;
162 
163 	switch (ap->a_cmd) {
164 	case MOUSE_GETHWINFO:	/* get device information */
165 		hw = (mousehw_t *)ap->a_data;
166 		hw->buttons = 10;		/* XXX unknown */
167 		hw->iftype = MOUSE_IF_SYSMOUSE;
168 		hw->type = MOUSE_MOUSE;
169 		hw->model = MOUSE_MODEL_GENERIC;
170 		hw->hwid = 0;
171 		return 0;
172 
173 	case MOUSE_GETMODE:	/* get protocol/mode */
174 		mode = (mousemode_t *)ap->a_data;
175 		mode->level = mouse_level;
176 		switch (mode->level) {
177 		case 0: /* emulate MouseSystems protocol */
178 			mode->protocol = MOUSE_PROTO_MSC;
179 			mode->rate = -1;		/* unknown */
180 			mode->resolution = -1;	/* unknown */
181 			mode->accelfactor = 0;	/* disabled */
182 			mode->packetsize = MOUSE_MSC_PACKETSIZE;
183 			mode->syncmask[0] = MOUSE_MSC_SYNCMASK;
184 			mode->syncmask[1] = MOUSE_MSC_SYNC;
185 			break;
186 
187 		case 1: /* sysmouse protocol */
188 			mode->protocol = MOUSE_PROTO_SYSMOUSE;
189 			mode->rate = -1;
190 			mode->resolution = -1;
191 			mode->accelfactor = 0;
192 			mode->packetsize = MOUSE_SYS_PACKETSIZE;
193 			mode->syncmask[0] = MOUSE_SYS_SYNCMASK;
194 			mode->syncmask[1] = MOUSE_SYS_SYNC;
195 			break;
196 		}
197 		return 0;
198 
199 	case MOUSE_SETMODE:	/* set protocol/mode */
200 		mode = (mousemode_t *)ap->a_data;
201 		if (mode->level == -1)
202 			; 	/* don't change the current setting */
203 		else if ((mode->level < 0) || (mode->level > 1))
204 			return EINVAL;
205 		else
206 			mouse_level = mode->level;
207 		return 0;
208 
209 	case MOUSE_GETLEVEL:	/* get operation level */
210 		*(int *)ap->a_data = mouse_level;
211 		return 0;
212 
213 	case MOUSE_SETLEVEL:	/* set operation level */
214 		if ((*(int *)ap->a_data  < 0) || (*(int *)ap->a_data > 1))
215 			return EINVAL;
216 		mouse_level = *(int *)ap->a_data;
217 		return 0;
218 
219 	case MOUSE_GETSTATUS:	/* get accumulated mouse events */
220 		crit_enter();
221 		*(mousestatus_t *)ap->a_data = mouse_status;
222 		mouse_status.flags = 0;
223 		mouse_status.obutton = mouse_status.button;
224 		mouse_status.dx = 0;
225 		mouse_status.dy = 0;
226 		mouse_status.dz = 0;
227 		crit_exit();
228 		return 0;
229 
230 #if notyet
231 	case MOUSE_GETVARS:	/* get internal mouse variables */
232 	case MOUSE_SETVARS:	/* set internal mouse variables */
233 		return ENODEV;
234 #endif
235 
236 	case MOUSE_READSTATE:	/* read status from the device */
237 	case MOUSE_READDATA:	/* read data from the device */
238 		return ENODEV;
239 	}
240 
241 	error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
242 	if (error != ENOIOCTL)
243 		return error;
244 	error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
245 	if (error != ENOIOCTL)
246 		return error;
247 	return ENOTTY;
248 }
249 
250 static void
251 sm_attach_mouse(void *unused)
252 {
253 	cdev_t dev;
254 
255 	dev = make_dev(&sm_ops, SC_MOUSE, UID_ROOT, GID_WHEEL,
256 		       0600, "sysmouse");
257 	/* sysmouse doesn't have scr_stat */
258 }
259 
260 SYSINIT(sysmouse, SI_SUB_DRIVERS, SI_ORDER_MIDDLE + CDEV_MAJOR,
261 	sm_attach_mouse, NULL)
262 
263 int
264 sysmouse_event(mouse_info_t *info)
265 {
266 	/* MOUSE_BUTTON?DOWN -> MOUSE_MSC_BUTTON?UP */
267 	static int butmap[8] = {
268 	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
269 	    MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
270 	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
271 	    MOUSE_MSC_BUTTON3UP,
272 	    MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
273 	    MOUSE_MSC_BUTTON2UP,
274 	    MOUSE_MSC_BUTTON1UP,
275 	    0,
276 	};
277 	u_char buf[8];
278 	int x, y, z;
279 	int i;
280 
281 	switch (info->operation) {
282 	case MOUSE_ACTION:
283         	mouse_status.button = info->u.data.buttons;
284 		/* FALL THROUGH */
285 	case MOUSE_MOTION_EVENT:
286 		x = info->u.data.x;
287 		y = info->u.data.y;
288 		z = info->u.data.z;
289 		break;
290 	case MOUSE_BUTTON_EVENT:
291 		x = y = z = 0;
292 		if (info->u.event.value > 0)
293 			mouse_status.button |= info->u.event.id;
294 		else
295 			mouse_status.button &= ~info->u.event.id;
296 		break;
297 	default:
298 		return 0;
299 	}
300 
301 	mouse_status.dx += x;
302 	mouse_status.dy += y;
303 	mouse_status.dz += z;
304 	mouse_status.flags |= ((x || y || z) ? MOUSE_POSCHANGED : 0)
305 			      | (mouse_status.obutton ^ mouse_status.button);
306 	if (mouse_status.flags == 0)
307 		return 0;
308 
309 	if ((sysmouse_tty == NULL) || !(sysmouse_tty->t_state & TS_ISOPEN))
310 		return mouse_status.flags;
311 
312 	/* the first five bytes are compatible with MouseSystems' */
313 	buf[0] = MOUSE_MSC_SYNC
314 		 | butmap[mouse_status.button & MOUSE_STDBUTTONS];
315 	x = imax(imin(x, 255), -256);
316 	buf[1] = x >> 1;
317 	buf[3] = x - buf[1];
318 	y = -imax(imin(y, 255), -256);
319 	buf[2] = y >> 1;
320 	buf[4] = y - buf[2];
321 	for (i = 0; i < MOUSE_MSC_PACKETSIZE; ++i)
322 		(*linesw[sysmouse_tty->t_line].l_rint)(buf[i], sysmouse_tty);
323 	if (mouse_level >= 1) {
324 		/* extended part */
325         	z = imax(imin(z, 127), -128);
326         	buf[5] = (z >> 1) & 0x7f;
327         	buf[6] = (z - (z >> 1)) & 0x7f;
328         	/* buttons 4-10 */
329         	buf[7] = (~mouse_status.button >> 3) & 0x7f;
330         	for (i = MOUSE_MSC_PACKETSIZE; i < MOUSE_SYS_PACKETSIZE; ++i)
331 			(*linesw[sysmouse_tty->t_line].l_rint)(buf[i],
332 							       sysmouse_tty);
333 	}
334 
335 	return mouse_status.flags;
336 }
337 
338 #endif /* !SC_NO_SYSMOUSE */
339