/* * 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. * * $Id: mse.c,v 1.21 1995/12/08 23:20:35 phk Exp $ */ /* * 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: * Sep 6, 1994 -- Lars Fredriksen(fredriks@mcs.com) * improved probe based on input from Logitech. * * 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 #include #include #include #include #include #include #include #include #include #ifdef DEVFS #include #endif /*DEVFS*/ #include #include #include static int mseprobe(struct isa_device *); static int mseattach(struct isa_device *); struct isa_driver msedriver = { mseprobe, mseattach, "mse" }; static d_open_t mseopen; static d_close_t mseclose; static d_read_t mseread; static d_select_t mseselect; #define CDEV_MAJOR 27 static struct cdevsw mse_cdevsw = { mseopen, mseclose, mseread, nowrite, /*27*/ noioc, nostop, nullreset, nodevtotty,/* mse */ mseselect, nommap, NULL, "mse", NULL, -1 }; /* * Software control structure for mouse. The sc_enablemouse(), * sc_disablemouse() and sc_getmouse() routines must be called spl'd(). */ #define PROTOBYTES 5 static struct mse_softc { int sc_flags; int sc_mousetype; struct selinfo 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]; #ifdef DEVFS void *devfs_token; void *n_devfs_token; #endif } 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_LOGI_SIG 0xA5 #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? */ /* The definition for the control port */ /* is as follows: */ /* D7 = Mode set flag (1 = active) */ /* D6,D5 = Mode selection (port A) */ /* 00 = Mode 0 = Basic I/O */ /* 01 = Mode 1 = Strobed I/O */ /* 10 = Mode 2 = Bi-dir bus */ /* D4 = Port A direction (1 = input)*/ /* D3 = Port C (upper 4 bits) */ /* direction. (1 = input) */ /* D2 = Mode selection (port B & C) */ /* 0 = Mode 0 = Basic I/O */ /* 1 = Mode 1 = Strobed I/O */ /* D1 = Port B direction (1 = input)*/ /* D0 = Port C (lower 4 bits) */ /* direction. (1 = input) */ /* So 91 means Basic I/O on all 3 ports,*/ /* Port A is an input port, B is an */ /* output port, C is split with upper */ /* 4 bits being an output port and lower*/ /* 4 bits an input port, and enable the */ /* sucker. */ /* Courtesy Intel 8255 databook. Lars */ #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.) */ static 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, }, }; static struct kern_devconf kdc_mse[NMSE] = { { 0, 0, 0, /* filled in by dev_attach */ "mse", 0, { MDDT_ISA, 0, "tty" }, isa_generic_externalize, 0, 0, ISA_EXTERNALLEN, &kdc_isa0, /* parent */ 0, /* parentdata */ DC_UNCONFIGURED, /* state */ "ATI or Logitech bus mouse adapter", DC_CLS_MISC /* class */ } }; static inline void mse_registerdev(struct isa_device *id) { if(id->id_unit) kdc_mse[id->id_unit] = kdc_mse[0]; kdc_mse[id->id_unit].kdc_unit = id->id_unit; kdc_mse[id->id_unit].kdc_isa = id; dev_attach(&kdc_mse[id->id_unit]); } int mseprobe(idp) register struct isa_device *idp; { register struct mse_softc *sc = &mse_sc[idp->id_unit]; register int i; mse_registerdev(idp); /* * 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); } int mseattach(idp) struct isa_device *idp; { char name[32]; int unit = idp->id_unit; struct mse_softc *sc = &mse_sc[unit]; sc->sc_port = idp->id_iobase; kdc_mse[unit].kdc_state = DC_IDLE; #ifdef DEVFS sprintf(name,"mse%d", unit); /* path name devsw minor */ sc->devfs_token = devfs_add_devsw( "/", name, &mse_cdevsw, unit << 1, /*type uid gid perm*/ DV_CHR, 0, 0, 0600); sprintf(name,"nmse%d", unit); /* path name devsw minor */ sc->n_devfs_token = devfs_add_devsw("/", name, &mse_cdevsw, (unit<<1)+1, /*type uid gid perm*/ DV_CHR, 0, 0, 0600); #endif return (1); } /* * Exclusive open the mouse, initialize it and enable interrupts. */ static int mseopen(dev, flags, fmt, p) dev_t dev; int flags; int fmt; struct proc *p; { 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; kdc_mse[MSE_UNIT(dev)].kdc_state = DC_BUSY; 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. */ static int mseclose(dev, flags, fmt, p) dev_t dev; int flags; int fmt; struct proc *p; { struct mse_softc *sc = &mse_sc[MSE_UNIT(dev)]; int s; s = spltty(); (*sc->sc_disablemouse)(sc->sc_port); sc->sc_flags &= ~MSESC_OPEN; kdc_mse[MSE_UNIT(dev)].kdc_state = DC_IDLE; 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...) */ static int mseread(dev, uio, ioflag) dev_t dev; struct uio *uio; int ioflag; { 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. */ static int 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. */ selrecord(p, &sc->sc_selp); splx(s); return (0); } /* * mseintr: update mouse status. sc_deltax and sc_deltay are accumulative. */ void mseintr(unit) int unit; { register struct mse_softc *sc = &mse_sc[unit]; #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); } selwakeup(&sc->sc_selp); } } /* * 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; { int sig; outb(idp->id_iobase + MSE_PORTD, MSE_SETUP); /* set the signature port */ outb(idp->id_iobase + MSE_PORTB, MSE_LOGI_SIG); DELAY(30000); /* 30 ms delay */ sig = inb(idp->id_iobase + MSE_PORTB) & 0xFF; if (sig == MSE_LOGI_SIG) { outb(idp->id_iobase + MSE_PORTC, MSE_DISINTR); return(1); } else { printf("mse%d: wrong signature %x\n",idp->id_unit,sig); 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); } static mse_devsw_installed = 0; static void mse_drvinit(void *unused) { dev_t dev; if( ! mse_devsw_installed ) { dev = makedev(CDEV_MAJOR, 0); cdevsw_add(&dev,&mse_cdevsw, NULL); mse_devsw_installed = 1; } } SYSINIT(msedev,SI_SUB_DRIVERS,SI_ORDER_MIDDLE+CDEV_MAJOR,mse_drvinit,NULL) #endif /* NMSE */