xref: /netbsd-src/sys/arch/arc/dev/opms.c (revision 4b71a66d0f279143147d63ebfcfd8a59499a3684)
1 /*	$NetBSD: opms.c,v 1.17 2008/03/01 14:16:49 rmind Exp $	*/
2 /*	$OpenBSD: pccons.c,v 1.22 1999/01/30 22:39:37 imp Exp $	*/
3 /*	NetBSD: pms.c,v 1.21 1995/04/18 02:25:18 mycroft Exp	*/
4 
5 /*-
6  * Copyright (c) 1990 The Regents of the University of California.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to Berkeley by
10  * William Jolitz and Don Ahn.
11  *
12  * Copyright (c) 1994 Charles M. Hannum.
13  * Copyright (c) 1992, 1993 Erik Forsberg.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  * 3. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)pccons.c	5.11 (Berkeley) 5/21/91
40  */
41 
42 /*-
43  * Copyright (c) 1993, 1994, 1995 Charles M. Hannum.  All rights reserved.
44  *
45  * This code is derived from software contributed to Berkeley by
46  * William Jolitz and Don Ahn.
47  *
48  * Copyright (c) 1994 Charles M. Hannum.
49  * Copyright (c) 1992, 1993 Erik Forsberg.
50  *
51  * Redistribution and use in source and binary forms, with or without
52  * modification, are permitted provided that the following conditions
53  * are met:
54  * 1. Redistributions of source code must retain the above copyright
55  *    notice, this list of conditions and the following disclaimer.
56  * 2. Redistributions in binary form must reproduce the above copyright
57  *    notice, this list of conditions and the following disclaimer in the
58  *    documentation and/or other materials provided with the distribution.
59  * 3. All advertising materials mentioning features or use of this software
60  *    must display the following acknowledgement:
61  *	This product includes software developed by the University of
62  *	California, Berkeley and its contributors.
63  * 4. Neither the name of the University nor the names of its contributors
64  *    may be used to endorse or promote products derived from this software
65  *    without specific prior written permission.
66  *
67  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
68  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
69  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
70  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
71  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
72  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
73  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
74  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
75  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
76  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
77  * SUCH DAMAGE.
78  *
79  *	@(#)pccons.c	5.11 (Berkeley) 5/21/91
80  */
81 
82 #include <sys/cdefs.h>
83 __KERNEL_RCSID(0, "$NetBSD: opms.c,v 1.17 2008/03/01 14:16:49 rmind Exp $");
84 
85 #include <sys/param.h>
86 #include <sys/systm.h>
87 #include <sys/vnode.h>
88 #include <sys/poll.h>
89 #include <sys/tty.h>
90 #include <sys/device.h>
91 #include <sys/proc.h>
92 #include <sys/conf.h>
93 
94 #include <machine/bus.h>
95 #include <machine/kbdreg.h>
96 #include <machine/mouse.h>
97 
98 #include <arc/dev/pcconsvar.h>
99 #include <arc/dev/opmsvar.h>
100 
101 #include "ioconf.h"
102 
103 #define	PMSUNIT(dev)	(minor(dev))
104 
105 /* status bits */
106 #define	PMS_OBUF_FULL	0x01
107 #define	PMS_IBUF_FULL	0x02
108 
109 /* controller commands */
110 #define	PMS_INT_ENABLE	0x47	/* enable controller interrupts */
111 #define	PMS_INT_DISABLE	0x65	/* disable controller interrupts */
112 #define	PMS_AUX_ENABLE	0xa7	/* enable auxiliary port */
113 #define	PMS_AUX_DISABLE	0xa8	/* disable auxiliary port */
114 #define	PMS_MAGIC_1	0xa9	/* XXX */
115 
116 #define	PMS_8042_CMD	0x65
117 
118 /* mouse commands */
119 #define	PMS_SET_SCALE11	0xe6	/* set scaling 1:1 */
120 #define	PMS_SET_SCALE21 0xe7	/* set scaling 2:1 */
121 #define	PMS_SET_RES	0xe8	/* set resolution */
122 #define	PMS_GET_SCALE	0xe9	/* get scaling factor */
123 #define	PMS_SET_STREAM	0xea	/* set streaming mode */
124 #define	PMS_SET_SAMPLE	0xf3	/* set sampling rate */
125 #define	PMS_DEV_ENABLE	0xf4	/* mouse on */
126 #define	PMS_DEV_DISABLE	0xf5	/* mouse off */
127 #define	PMS_RESET	0xff	/* reset */
128 
129 #define	PMS_CHUNK	128	/* chunk size for read */
130 #define	PMS_BSIZE	1020	/* buffer size */
131 
132 #define	FLUSHQ(q) { if((q)->c_cc) ndflush(q, (q)->c_cc); }
133 
134 dev_type_open(opmsopen);
135 dev_type_close(opmsclose);
136 dev_type_read(opmsread);
137 dev_type_ioctl(opmsioctl);
138 dev_type_poll(opmspoll);
139 dev_type_kqfilter(opmskqfilter);
140 
141 const struct cdevsw opms_cdevsw = {
142 	opmsopen, opmsclose, opmsread, nowrite, opmsioctl,
143 	nostop, notty, opmspoll, nommap, opmskqfilter,
144 };
145 
146 static inline void pms_dev_cmd(uint8_t);
147 static inline void pms_aux_cmd(uint8_t);
148 static inline void pms_pit_cmd(uint8_t);
149 
150 static inline void
151 pms_dev_cmd(uint8_t value)
152 {
153 
154 	kbd_flush_input();
155 	kbd_cmd_write_1(0xd4);
156 	kbd_flush_input();
157 	kbd_data_write_1(value);
158 }
159 
160 static inline void
161 pms_aux_cmd(uint8_t value)
162 {
163 
164 	kbd_flush_input();
165 	kbd_cmd_write_1(value);
166 }
167 
168 static inline void
169 pms_pit_cmd(uint8_t value)
170 {
171 
172 	kbd_flush_input();
173 	kbd_cmd_write_1(0x60);
174 	kbd_flush_input();
175 	kbd_data_write_1(value);
176 }
177 
178 int opms_common_match(bus_space_tag_t kbd_iot, struct pccons_config *config)
179 {
180 	uint8_t x;
181 
182 	kbd_context_init(kbd_iot, config);
183 
184 	pms_dev_cmd(KBC_RESET);
185 	pms_aux_cmd(PMS_MAGIC_1);
186 	delay(10000);
187 	x = kbd_data_read_1();
188 	pms_pit_cmd(PMS_INT_DISABLE);
189 	if (x & 0x04)
190 		return 0;
191 
192 	return 1;
193 }
194 
195 void
196 opms_common_attach(struct opms_softc *sc, bus_space_tag_t opms_iot,
197     struct pccons_config *config)
198 {
199 
200 	kbd_context_init(opms_iot, config);
201 	selinit(&sc->sc_rsel);
202 
203 	/* Other initialization was done by opmsprobe. */
204 	sc->sc_state = 0;
205 }
206 
207 int
208 opmsopen(dev_t dev, int flag, int mode, struct lwp *l)
209 {
210 	int unit = PMSUNIT(dev);
211 	struct opms_softc *sc;
212 
213 	if (unit >= opms_cd.cd_ndevs)
214 		return ENXIO;
215 	sc = opms_cd.cd_devs[unit];
216 	if (!sc)
217 		return ENXIO;
218 
219 	if (sc->sc_state & PMS_OPEN)
220 		return EBUSY;
221 
222 	if (clalloc(&sc->sc_q, PMS_BSIZE, 0) == -1)
223 		return ENOMEM;
224 
225 	sc->sc_state |= PMS_OPEN;
226 	sc->sc_status = 0;
227 	sc->sc_x = sc->sc_y = 0;
228 
229 	/* Enable interrupts. */
230 	pms_dev_cmd(PMS_DEV_ENABLE);
231 	pms_aux_cmd(PMS_AUX_ENABLE);
232 	pms_dev_cmd(PMS_SET_RES);
233 	pms_dev_cmd(3);		/* 8 counts/mm */
234 	pms_dev_cmd(PMS_SET_SCALE21);
235 #if 0
236 	pms_dev_cmd(PMS_SET_SAMPLE);
237 	pms_dev_cmd(100);	/* 100 samples/sec */
238 	pms_dev_cmd(PMS_SET_STREAM);
239 #endif
240 	pms_pit_cmd(PMS_INT_ENABLE);
241 
242 	return 0;
243 }
244 
245 int
246 opmsclose(dev_t dev, int flag, int mode, struct lwp *l)
247 {
248 	struct opms_softc *sc = opms_cd.cd_devs[PMSUNIT(dev)];
249 
250 	/* Disable interrupts. */
251 	pms_dev_cmd(PMS_DEV_DISABLE);
252 	pms_pit_cmd(PMS_INT_DISABLE);
253 	pms_aux_cmd(PMS_AUX_DISABLE);
254 
255 	sc->sc_state &= ~PMS_OPEN;
256 
257 	clfree(&sc->sc_q);
258 
259 	return 0;
260 }
261 
262 int
263 opmsread(dev_t dev, struct uio *uio, int flag)
264 {
265 	struct opms_softc *sc = opms_cd.cd_devs[PMSUNIT(dev)];
266 	int s;
267 	int error = 0;
268 	size_t length;
269 	u_char buffer[PMS_CHUNK];
270 
271 	/* Block until mouse activity occurred. */
272 
273 	s = spltty();
274 	while (sc->sc_q.c_cc == 0) {
275 		if (flag & IO_NDELAY) {
276 			splx(s);
277 			return EWOULDBLOCK;
278 		}
279 		sc->sc_state |= PMS_ASLP;
280 		error = tsleep((void *)sc, PZERO | PCATCH, "pmsrea", 0);
281 		if (error) {
282 			sc->sc_state &= ~PMS_ASLP;
283 			splx(s);
284 			return error;
285 		}
286 	}
287 	splx(s);
288 
289 	/* Transfer as many chunks as possible. */
290 
291 	while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0) {
292 		length = min(sc->sc_q.c_cc, uio->uio_resid);
293 		if (length > sizeof(buffer))
294 			length = sizeof(buffer);
295 
296 		/* Remove a small chunk from the input queue. */
297 		(void) q_to_b(&sc->sc_q, buffer, length);
298 
299 		/* Copy the data to the user process. */
300 		error = uiomove(buffer, length, uio);
301 		if (error)
302 			break;
303 	}
304 
305 	return error;
306 }
307 
308 int
309 opmsioctl(dev_t dev, u_long cmd, void *addr, int flag, struct lwp *l)
310 {
311 	struct opms_softc *sc = opms_cd.cd_devs[PMSUNIT(dev)];
312 	struct mouseinfo info;
313 	int s;
314 	int error;
315 
316 	switch (cmd) {
317 	case MOUSEIOCREAD:
318 		s = spltty();
319 
320 		info.status = sc->sc_status;
321 		if (sc->sc_x || sc->sc_y)
322 			info.status |= MOVEMENT;
323 
324 		if (sc->sc_x > 127)
325 			info.xmotion = 127;
326 		else if (sc->sc_x < -127)
327 			/* Bounding at -127 avoids a bug in XFree86. */
328 			info.xmotion = -127;
329 		else
330 			info.xmotion = sc->sc_x;
331 
332 		if (sc->sc_y > 127)
333 			info.ymotion = 127;
334 		else if (sc->sc_y < -127)
335 			info.ymotion = -127;
336 		else
337 			info.ymotion = sc->sc_y;
338 
339 		/* Reset historical information. */
340 		sc->sc_x = sc->sc_y = 0;
341 		sc->sc_status &= ~BUTCHNGMASK;
342 		ndflush(&sc->sc_q, sc->sc_q.c_cc);
343 
344 		splx(s);
345 		error = copyout(&info, addr, sizeof(struct mouseinfo));
346 		break;
347 	default:
348 		error = EINVAL;
349 		break;
350 	}
351 
352 	return error;
353 }
354 
355 /* Masks for the first byte of a packet */
356 #define PS2LBUTMASK 0x01
357 #define PS2RBUTMASK 0x02
358 #define PS2MBUTMASK 0x04
359 
360 int
361 opmsintr(void *arg)
362 {
363 	struct opms_softc *sc = arg;
364 	static int state = 0;
365 	static u_char buttons;
366 	u_char changed;
367 	static char dx, dy;
368 	u_char buffer[5];
369 
370 	if ((sc->sc_state & PMS_OPEN) == 0) {
371 		/* Interrupts are not expected.  Discard the byte. */
372 		kbd_flush_input();
373 		return 0;
374 	}
375 
376 	switch (state) {
377 
378 	case 0:
379 		buttons = kbd_data_read_1();
380 		if ((buttons & 0xc0) == 0)
381 			++state;
382 		break;
383 
384 	case 1:
385 		dx = kbd_data_read_1();
386 		/* Bounding at -127 avoids a bug in XFree86. */
387 		dx = (dx == -128) ? -127 : dx;
388 		++state;
389 		break;
390 
391 	case 2:
392 		dy = kbd_data_read_1();
393 		dy = (dy == -128) ? -127 : dy;
394 		state = 0;
395 
396 		buttons = ((buttons & PS2LBUTMASK) << 2) |
397 		    ((buttons & (PS2RBUTMASK | PS2MBUTMASK)) >> 1);
398 		changed = ((buttons ^ sc->sc_status) & BUTSTATMASK) << 3;
399 		sc->sc_status = buttons | (sc->sc_status & ~BUTSTATMASK) |
400 		    changed;
401 
402 		if (dx || dy || changed) {
403 			/* Update accumulated movements. */
404 			sc->sc_x += dx;
405 			sc->sc_y += dy;
406 
407 			/* Add this event to the queue. */
408 			buffer[0] = 0x80 | (buttons & BUTSTATMASK);
409 			if(dx < 0)
410 				buffer[0] |= 0x10;
411 			buffer[1] = dx & 0x7f;
412 			if(dy < 0)
413 				buffer[0] |= 0x20;
414 			buffer[2] = dy & 0x7f;
415 			buffer[3] = buffer[4] = 0;
416 			(void) b_to_q(buffer, sizeof buffer, &sc->sc_q);
417 
418 			if (sc->sc_state & PMS_ASLP) {
419 				sc->sc_state &= ~PMS_ASLP;
420 				wakeup((void *)sc);
421 			}
422 			selnotify(&sc->sc_rsel, 0, 0);
423 		}
424 
425 		break;
426 	}
427 	return -1;
428 }
429 
430 int
431 opmspoll(dev_t dev, int events, struct lwp *l)
432 {
433 	struct opms_softc *sc = opms_cd.cd_devs[PMSUNIT(dev)];
434 	int revents = 0;
435 	int s = spltty();
436 
437 	if (events & (POLLIN | POLLRDNORM)) {
438 		if (sc->sc_q.c_cc > 0)
439 			revents |= events & (POLLIN | POLLRDNORM);
440 		else
441 			selrecord(l, &sc->sc_rsel);
442 	}
443 
444 	splx(s);
445 	return revents;
446 }
447 
448 static void
449 filt_opmsrdetach(struct knote *kn)
450 {
451 	struct opms_softc *sc = kn->kn_hook;
452 	int s;
453 
454 	s = spltty();
455 	SLIST_REMOVE(&sc->sc_rsel.sel_klist, kn, knote, kn_selnext);
456 	splx(s);
457 }
458 
459 static int
460 filt_opmsread(struct knote *kn, long hint)
461 {
462 	struct opms_softc *sc = kn->kn_hook;
463 
464 	kn->kn_data = sc->sc_q.c_cc;
465 	return kn->kn_data > 0;
466 }
467 
468 static const struct filterops opmsread_filtops =
469 	{ 1, NULL, filt_opmsrdetach, filt_opmsread };
470 
471 int
472 opmskqfilter(dev_t dev, struct knote *kn)
473 {
474 	struct opms_softc *sc = opms_cd.cd_devs[PMSUNIT(dev)];
475 	struct klist *klist;
476 	int s;
477 
478 	switch (kn->kn_filter) {
479 	case EVFILT_READ:
480 		klist = &sc->sc_rsel.sel_klist;
481 		kn->kn_fop = &opmsread_filtops;
482 		break;
483 
484 	default:
485 		return 1;
486 	}
487 
488 	kn->kn_hook = sc;
489 
490 	s = spltty();
491 	SLIST_INSERT_HEAD(klist, kn, kn_selnext);
492 	splx(s);
493 
494 	return 0;
495 }
496