This is my patched version of a busmouse driver originally by Rick Macklem

(rick@snowhite.cis.uoguelph.ca).  I am currently using it with a Microsoft
InPort busmouse, under FreeBSD Epsilon.  I hadn't planned on supporting it,
but I have patched it a few times, and I guess this is now the de facto
reference version, so send me any problems or improvements.

                                                        - Gene Stark
                                                          stark@cs.sunysb.edu
                                                          October 9, 1993

1 files changed, 493 insertions, 0 deletions

diff --git a/sys/dev/mse/mse.c b/sys/dev/mse/mse.c
new file mode 100644
index 0000000..60621cc
--- /dev/null
+++ b/sys/dev/mse/mse.c
@@ -0,0 +1,493 @@
+/*
+ * Copyright 1992 by the University of Guelph
+ *
+ * Permission to use, copy and modify this
+ * software and its documentation for any purpose and without
+ * fee is hereby granted, provided that the above copyright
+ * notice appear in all copies and that both that copyright
+ * notice and this permission notice appear in supporting
+ * documentation.
+ * University of Guelph makes no representations about the suitability of
+ * this software for any purpose.  It is provided "as is"
+ * without express or implied warranty.
+ */
+/*
+ * Driver for the Logitech and ATI Inport Bus mice for use with 386bsd and
+ * the X386 port, courtesy of
+ * Rick Macklem, rick@snowhite.cis.uoguelph.ca
+ * Caveats: The driver currently uses spltty(), but doesn't use any
+ * generic tty code. It could use splmse() (that only masks off the
+ * bus mouse interrupt, but that would require hacking in i386/isa/icu.s.
+ * (This may be worth the effort, since the Logitech generates 30/60
+ * interrupts/sec continuously while it is open.)
+ * NB: The ATI has NOT been tested yet!
+ */
+
+/*
+ * Modification history:
+ *
+ * Oct 19, 1992 -- E. Stark (stark@cs.sunysb.edu)
+ *   fixes to make it work with Microsoft InPort busmouse
+ *
+ * Jan, 1993 -- E. Stark (stark@cs.sunysb.edu)
+ *   added patches for new "select" interface
+ *
+ * May 4, 1993 -- E. Stark (stark@cs.sunysb.edu)
+ *   changed position of some spl()'s in mseread
+ *
+ * October 8, 1993 -- E. Stark (stark@cs.sunysb.edu)
+ *   limit maximum negative x/y value to -127 to work around XFree problem
+ *   that causes spurious button pushes.
+ */
+
+#include "mse.h"
+#if NMSE > 0
+#include "param.h"
+#include "proc.h"
+#include "user.h"
+#include "buf.h"
+#include "systm.h"
+#include "kernel.h"
+#include "ioctl.h"
+#include "tty.h"
+#include "uio.h"
+
+#include "i386/isa/isa_device.h"
+#include "i386/isa/icu.h"
+
+int 	mseprobe(), mseattach(), mseintr();
+
+struct	isa_driver msedriver = {
+	mseprobe, mseattach, "mse"
+};
+
+/*
+ * Software control structure for mouse. The sc_enablemouse(),
+ * sc_disablemouse() and sc_getmouse() routines must be called spl'd().
+ */
+#define	PROTOBYTES	5
+struct mse_softc {
+	int	sc_flags;
+	int	sc_mousetype;
+	pid_t	sc_selp;
+	u_int	sc_port;
+	void	(*sc_enablemouse)();
+	void	(*sc_disablemouse)();
+	void	(*sc_getmouse)();
+	int	sc_deltax;
+	int	sc_deltay;
+	int	sc_obuttons;
+	int	sc_buttons;
+	int	sc_bytesread;
+	u_char	sc_bytes[PROTOBYTES];
+} mse_sc[NMSE];
+
+/* Flags */
+#define	MSESC_OPEN	0x1
+#define	MSESC_WANT	0x2
+
+/* and Mouse Types */
+#define	MSE_LOGITECH	0x1
+#define	MSE_ATIINPORT	0x2
+
+#define	MSE_PORTA	0
+#define	MSE_PORTB	1
+#define	MSE_PORTC	2
+#define	MSE_PORTD	3
+
+#define	MSE_UNIT(dev)		(minor(dev) >> 1)
+#define	MSE_NBLOCKIO(dev)	(minor(dev) & 0x1)
+
+/*
+ * Logitech bus mouse definitions
+ */
+#define	MSE_SETUP	0x91	/* What does this mean? */
+#define	MSE_HOLD	0x80
+#define	MSE_RXLOW	0x00
+#define	MSE_RXHIGH	0x20
+#define	MSE_RYLOW	0x40
+#define	MSE_RYHIGH	0x60
+#define	MSE_DISINTR	0x10
+#define MSE_INTREN	0x00
+
+static int mse_probelogi();
+static void mse_enablelogi(), mse_disablelogi(), mse_getlogi();
+
+/*
+ * ATI Inport mouse definitions
+ */
+#define	MSE_INPORT_RESET	0x80
+#define	MSE_INPORT_STATUS	0x00
+#define	MSE_INPORT_DX		0x01
+#define	MSE_INPORT_DY		0x02
+#define	MSE_INPORT_MODE		0x07
+#define	MSE_INPORT_HOLD		0x20
+#define	MSE_INPORT_INTREN	0x09
+
+static int mse_probeati();
+static void mse_enableati(), mse_disableati(), mse_getati();
+
+#define	MSEPRI	(PZERO + 3)
+
+/*
+ * Table of mouse types.
+ * Keep the Logitech last, since I haven't figured out how to probe it
+ * properly yet. (Someday I'll have the documentation.)
+ */
+struct mse_types {
+	int	m_type;		/* Type of bus mouse */
+	int	(*m_probe)();	/* Probe routine to test for it */
+	void	(*m_enable)();	/* Start routine */
+	void	(*m_disable)();	/* Disable interrupts routine */
+	void	(*m_get)();	/* and get mouse status */
+} mse_types[] = {
+	{ MSE_ATIINPORT, mse_probeati, mse_enableati, mse_disableati, mse_getati },
+	{ MSE_LOGITECH, mse_probelogi, mse_enablelogi, mse_disablelogi, mse_getlogi },
+	{ 0, },
+};
+
+mseprobe(idp)
+	register struct isa_device *idp;
+{
+	register struct mse_softc *sc = &mse_sc[idp->id_unit];
+	register int i;
+
+	/*
+	 * Check for each mouse type in the table.
+	 */
+	i = 0;
+	while (mse_types[i].m_type) {
+		if ((*mse_types[i].m_probe)(idp)) {
+			sc->sc_mousetype = mse_types[i].m_type;
+			sc->sc_enablemouse = mse_types[i].m_enable;
+			sc->sc_disablemouse = mse_types[i].m_disable;
+			sc->sc_getmouse = mse_types[i].m_get;
+			return (1);
+		}
+		i++;
+	}
+	return (0);
+}
+
+mseattach(idp)
+	struct isa_device *idp;
+{
+	struct mse_softc *sc = &mse_sc[idp->id_unit];
+
+	sc->sc_port = idp->id_iobase;
+	return (1);
+}
+
+/*
+ * Exclusive open the mouse, initialize it and enable interrupts.
+ */
+mseopen(dev, flag)
+	dev_t dev;
+	int flag;
+{
+	register struct mse_softc *sc;
+	int s;
+
+	if (MSE_UNIT(dev) >= NMSE)
+		return (ENXIO);
+	sc = &mse_sc[MSE_UNIT(dev)];
+	if (sc->sc_flags & MSESC_OPEN)
+		return (EBUSY);
+	sc->sc_flags |= MSESC_OPEN;
+	sc->sc_obuttons = sc->sc_buttons = 0x7;
+	sc->sc_deltax = sc->sc_deltay = 0;
+	sc->sc_bytesread = PROTOBYTES;
+
+	/*
+	 * Initialize mouse interface and enable interrupts.
+	 */
+	s = spltty();
+	(*sc->sc_enablemouse)(sc->sc_port);
+	splx(s);
+	return (0);
+}
+
+/*
+ * mseclose: just turn off mouse innterrupts.
+ */
+mseclose(dev, flag)
+	int flag;
+{
+	struct mse_softc *sc = &mse_sc[MSE_UNIT(dev)];
+	int s;
+
+	s = spltty();
+	(*sc->sc_disablemouse)(sc->sc_port);
+	sc->sc_flags &= ~MSESC_OPEN;
+	splx(s);
+	return(0);
+}
+
+/* 
+ * mseread: return mouse info using the MSC serial protocol, but without
+ * using bytes 4 and 5.
+ * (Yes this is cheesy, but it makes the X386 server happy, so...)
+ */
+mseread(dev, uio)
+	dev_t dev;
+	struct uio *uio;
+{
+	register struct mse_softc *sc = &mse_sc[MSE_UNIT(dev)];
+	int xfer, s, error;
+
+	/*
+	 * If there are no protocol bytes to be read, set up a new protocol
+	 * packet.
+	 */
+	s = spltty(); /* XXX Should be its own spl, but where is imlXX() */
+	if (sc->sc_bytesread >= PROTOBYTES) {
+		while (sc->sc_deltax == 0 && sc->sc_deltay == 0 &&
+		       (sc->sc_obuttons ^ sc->sc_buttons) == 0) {
+			if (MSE_NBLOCKIO(dev)) {
+				splx(s);
+				return (0);
+			}
+			sc->sc_flags |= MSESC_WANT;
+			if (error = tsleep((caddr_t)sc, MSEPRI | PCATCH,
+				"mseread", 0)) {
+				splx(s);
+				return (error);
+			}
+		}
+
+		/*
+		 * Generate protocol bytes.
+		 * For some reason X386 expects 5 bytes but never uses
+		 * the fourth or fifth?
+		 */
+		sc->sc_bytes[0] = 0x80 | (sc->sc_buttons & ~0xf8);
+		if (sc->sc_deltax > 127)
+			sc->sc_deltax = 127;
+		if (sc->sc_deltax < -127)
+			sc->sc_deltax = -127;
+		sc->sc_deltay = -sc->sc_deltay;	/* Otherwise mousey goes wrong way */
+		if (sc->sc_deltay > 127)
+			sc->sc_deltay = 127;
+		if (sc->sc_deltay < -127)
+			sc->sc_deltay = -127;
+		sc->sc_bytes[1] = sc->sc_deltax;
+		sc->sc_bytes[2] = sc->sc_deltay;
+		sc->sc_bytes[3] = sc->sc_bytes[4] = 0;
+		sc->sc_obuttons = sc->sc_buttons;
+		sc->sc_deltax = sc->sc_deltay = 0;
+		sc->sc_bytesread = 0;
+	}
+	splx(s);
+	xfer = MIN(uio->uio_resid, PROTOBYTES - sc->sc_bytesread);
+	if (error = uiomove(&sc->sc_bytes[sc->sc_bytesread], xfer, uio))
+		return (error);
+	sc->sc_bytesread += xfer;
+	return(0);
+}
+
+/*
+ * mseselect: check for mouse input to be processed.
+ */
+mseselect(dev, rw, p)
+	dev_t dev;
+	int rw;
+	struct proc *p;
+{
+	register struct mse_softc *sc = &mse_sc[MSE_UNIT(dev)];
+	int s;
+
+	s = spltty();
+	if (sc->sc_bytesread != PROTOBYTES || sc->sc_deltax != 0 ||
+	    sc->sc_deltay != 0 || (sc->sc_obuttons ^ sc->sc_buttons) != 0) {
+		splx(s);
+		return (1);
+	}
+
+	/*
+	 * Since this is an exclusive open device, any previous proc.
+	 * pointer is trash now, so we can just assign it.
+	 */
+	sc->sc_selp = p->p_pid;
+	splx(s);
+	return (0);
+}
+
+/*
+ * mseintr: update mouse status. sc_deltax and sc_deltay are accumulative.
+ */
+mseintr(unit)
+	int unit;
+{
+	register struct mse_softc *sc = &mse_sc[unit];
+	pid_t p;
+
+#ifdef DEBUG
+	static int mse_intrcnt = 0;
+	if((mse_intrcnt++ % 10000) == 0)
+		printf("mseintr\n");
+#endif /* DEBUG */
+	if ((sc->sc_flags & MSESC_OPEN) == 0)
+		return;
+
+	(*sc->sc_getmouse)(sc->sc_port, &sc->sc_deltax, &sc->sc_deltay, &sc->sc_buttons);
+
+	/*
+	 * If mouse state has changed, wake up anyone wanting to know.
+	 */
+	if (sc->sc_deltax != 0 || sc->sc_deltay != 0 ||
+	    (sc->sc_obuttons ^ sc->sc_buttons) != 0) {
+		if (sc->sc_flags & MSESC_WANT) {	
+			sc->sc_flags &= ~MSESC_WANT;	
+			wakeup((caddr_t)sc);	
+		}	
+		if (sc->sc_selp) {	
+			p = sc->sc_selp;	
+			sc->sc_selp = (pid_t)0;	
+			selwakeup(p, 0);	
+		}	
+	}
+}
+
+/*
+ * Routines for the Logitech mouse.
+ */
+/*
+ * Test for a Logitech bus mouse and return 1 if it is.
+ * (until I know how to use the signature port properly, just disable
+ *  interrupts and return 1)
+ */
+static int
+mse_probelogi(idp)
+	register struct isa_device *idp;
+{
+
+	outb(idp->id_iobase + MSE_PORTB, 0x55);
+	if (inb(idp->id_iobase + MSE_PORTB) == 0x55) {
+		outb(idp->id_iobase + MSE_PORTB, 0xaa);
+		if (inb(idp->id_iobase + MSE_PORTB) == 0xaa)
+			return (1);
+	}
+	return (0);
+}
+
+/*
+ * Initialize Logitech mouse and enable interrupts.
+ */
+static void
+mse_enablelogi(port)
+	register u_int port;
+{
+	int dx, dy, but;
+
+	outb(port + MSE_PORTD, MSE_SETUP);
+	mse_getlogi(port, &dx, &dy, &but);
+}
+
+/*
+ * Disable interrupts for Logitech mouse.
+ */
+static void
+mse_disablelogi(port)
+	register u_int port;
+{
+
+	outb(port + MSE_PORTC, MSE_DISINTR);
+}
+
+/*
+ * Get the current dx, dy and button up/down state.
+ */
+static void
+mse_getlogi(port, dx, dy, but)
+	register u_int port;
+	int *dx;
+	int *dy;
+	int *but;
+{
+	register char x, y;
+
+	outb(port + MSE_PORTC, MSE_HOLD | MSE_RXLOW);
+	x = inb(port + MSE_PORTA);
+	*but = (x >> 5) & 0x7;
+	x &= 0xf;
+	outb(port + MSE_PORTC, MSE_HOLD | MSE_RXHIGH);
+	x |= (inb(port + MSE_PORTA) << 4);
+	outb(port + MSE_PORTC, MSE_HOLD | MSE_RYLOW);
+	y = (inb(port + MSE_PORTA) & 0xf);
+	outb(port + MSE_PORTC, MSE_HOLD | MSE_RYHIGH);
+	y |= (inb(port + MSE_PORTA) << 4);
+	*dx += x;
+	*dy += y;
+	outb(port + MSE_PORTC, MSE_INTREN);
+}
+
+/*
+ * Routines for the ATI Inport bus mouse.
+ */
+/*
+ * Test for a ATI Inport bus mouse and return 1 if it is.
+ * (do not enable interrupts)
+ */
+static int
+mse_probeati(idp)
+	register struct isa_device *idp;
+{
+	int i;
+
+	for (i = 0; i < 2; i++)
+		if (inb(idp->id_iobase + MSE_PORTC) == 0xde)
+			return (1);
+	return (0);
+}
+
+/*
+ * Initialize ATI Inport mouse and enable interrupts.
+ */
+static void
+mse_enableati(port)
+	register u_int port;
+{
+
+	outb(port + MSE_PORTA, MSE_INPORT_RESET);
+	outb(port + MSE_PORTA, MSE_INPORT_MODE);
+	outb(port + MSE_PORTB, MSE_INPORT_INTREN);
+}
+
+/*
+ * Disable interrupts for ATI Inport mouse.
+ */
+static void
+mse_disableati(port)
+	register u_int port;
+{
+
+	outb(port + MSE_PORTA, MSE_INPORT_MODE);
+	outb(port + MSE_PORTB, 0);
+}
+
+/*
+ * Get current dx, dy and up/down button state.
+ */
+static void
+mse_getati(port, dx, dy, but)
+	register u_int port;
+	int *dx;
+	int *dy;
+	int *but;
+{
+	register char byte;
+
+	outb(port + MSE_PORTA, MSE_INPORT_MODE);
+	outb(port + MSE_PORTB, MSE_INPORT_HOLD);
+	outb(port + MSE_PORTA, MSE_INPORT_STATUS);
+	*but = ~(inb(port + MSE_PORTB) & 0x7);
+	outb(port + MSE_PORTA, MSE_INPORT_DX);
+	byte = inb(port + MSE_PORTB);
+	*dx += byte;
+	outb(port + MSE_PORTA, MSE_INPORT_DY);
+	byte = inb(port + MSE_PORTB);
+	*dy += byte;
+	outb(port + MSE_PORTA, MSE_INPORT_MODE);
+	outb(port + MSE_PORTB, MSE_INPORT_INTREN);
+}
+#endif /* NMSE */