mse_isa.c revision 144783
1/*- 2 * Copyright (c) 2004 M. Warner Losh 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. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD: head/sys/dev/mse/mse_isa.c 144783 2005-04-08 05:22:58Z imp $ 27 */ 28 29/*- 30 * Copyright 1992 by the University of Guelph 31 * 32 * Permission to use, copy and modify this 33 * software and its documentation for any purpose and without 34 * fee is hereby granted, provided that the above copyright 35 * notice appear in all copies and that both that copyright 36 * notice and this permission notice appear in supporting 37 * documentation. 38 * University of Guelph makes no representations about the suitability of 39 * this software for any purpose. It is provided "as is" 40 * without express or implied warranty. 41 */ 42/* 43 * Driver for the Logitech and ATI Inport Bus mice for use with 386bsd and 44 * the X386 port, courtesy of 45 * Rick Macklem, rick@snowhite.cis.uoguelph.ca 46 * Caveats: The driver currently uses spltty(), but doesn't use any 47 * generic tty code. It could use splmse() (that only masks off the 48 * bus mouse interrupt, but that would require hacking in i386/isa/icu.s. 49 * (This may be worth the effort, since the Logitech generates 30/60 50 * interrupts/sec continuously while it is open.) 51 * NB: The ATI has NOT been tested yet! 52 */ 53 54/* 55 * Modification history: 56 * Sep 6, 1994 -- Lars Fredriksen(fredriks@mcs.com) 57 * improved probe based on input from Logitech. 58 * 59 * Oct 19, 1992 -- E. Stark (stark@cs.sunysb.edu) 60 * fixes to make it work with Microsoft InPort busmouse 61 * 62 * Jan, 1993 -- E. Stark (stark@cs.sunysb.edu) 63 * added patches for new "select" interface 64 * 65 * May 4, 1993 -- E. Stark (stark@cs.sunysb.edu) 66 * changed position of some spl()'s in mseread 67 * 68 * October 8, 1993 -- E. Stark (stark@cs.sunysb.edu) 69 * limit maximum negative x/y value to -127 to work around XFree problem 70 * that causes spurious button pushes. 71 */ 72 73#include <sys/param.h> 74#include <sys/systm.h> 75#include <sys/conf.h> 76#include <sys/kernel.h> 77#include <sys/module.h> 78#include <sys/bus.h> 79#include <sys/poll.h> 80#include <sys/selinfo.h> 81#include <sys/uio.h> 82#include <sys/mouse.h> 83 84#include <machine/bus.h> 85#include <machine/clock.h> 86#include <machine/resource.h> 87#include <sys/rman.h> 88 89#include <isa/isavar.h> 90 91#include <dev/mse/msevar.h> 92 93static int mse_isa_probe(device_t dev); 94static int mse_isa_attach(device_t dev); 95static int mse_isa_detach(device_t dev); 96 97static device_method_t mse_methods[] = { 98 DEVMETHOD(device_probe, mse_isa_probe), 99 DEVMETHOD(device_attach, mse_isa_attach), 100 DEVMETHOD(device_detach, mse_isa_detach), 101 { 0, 0 } 102}; 103 104static driver_t mse_driver = { 105 "mse", 106 mse_methods, 107 sizeof(mse_softc_t), 108}; 109 110DRIVER_MODULE(mse, isa, mse_driver, mse_devclass, 0, 0); 111 112static struct isa_pnp_id mse_ids[] = { 113 { 0x000fd041, "Bus mouse" }, /* PNP0F00 */ 114 { 0x020fd041, "InPort mouse" }, /* PNP0F02 */ 115 { 0x0d0fd041, "InPort mouse compatible" }, /* PNP0F0D */ 116 { 0x110fd041, "Bus mouse compatible" }, /* PNP0F11 */ 117 { 0x150fd041, "Logitech bus mouse" }, /* PNP0F15 */ 118 { 0x180fd041, "Logitech bus mouse compatible" },/* PNP0F18 */ 119 { 0 } 120}; 121 122/* 123 * Logitech bus mouse definitions 124 */ 125#define MSE_SETUP 0x91 /* What does this mean? */ 126 /* The definition for the control port */ 127 /* is as follows: */ 128 129 /* D7 = Mode set flag (1 = active) */ 130 /* D6,D5 = Mode selection (port A) */ 131 /* 00 = Mode 0 = Basic I/O */ 132 /* 01 = Mode 1 = Strobed I/O */ 133 /* 10 = Mode 2 = Bi-dir bus */ 134 /* D4 = Port A direction (1 = input)*/ 135 /* D3 = Port C (upper 4 bits) */ 136 /* direction. (1 = input) */ 137 /* D2 = Mode selection (port B & C) */ 138 /* 0 = Mode 0 = Basic I/O */ 139 /* 1 = Mode 1 = Strobed I/O */ 140 /* D1 = Port B direction (1 = input)*/ 141 /* D0 = Port C (lower 4 bits) */ 142 /* direction. (1 = input) */ 143 144 /* So 91 means Basic I/O on all 3 ports,*/ 145 /* Port A is an input port, B is an */ 146 /* output port, C is split with upper */ 147 /* 4 bits being an output port and lower*/ 148 /* 4 bits an input port, and enable the */ 149 /* sucker. */ 150 /* Courtesy Intel 8255 databook. Lars */ 151#define MSE_HOLD 0x80 152#define MSE_RXLOW 0x00 153#define MSE_RXHIGH 0x20 154#define MSE_RYLOW 0x40 155#define MSE_RYHIGH 0x60 156#define MSE_DISINTR 0x10 157#define MSE_INTREN 0x00 158 159static int mse_probelogi(device_t dev, mse_softc_t *sc); 160static void mse_disablelogi(bus_space_tag_t t, 161 bus_space_handle_t h); 162static void mse_getlogi(bus_space_tag_t t, bus_space_handle_t h, 163 int *dx, int *dy, int *but); 164static void mse_enablelogi(bus_space_tag_t t, 165 bus_space_handle_t h); 166 167/* 168 * ATI Inport mouse definitions 169 */ 170#define MSE_INPORT_RESET 0x80 171#define MSE_INPORT_STATUS 0x00 172#define MSE_INPORT_DX 0x01 173#define MSE_INPORT_DY 0x02 174#define MSE_INPORT_MODE 0x07 175#define MSE_INPORT_HOLD 0x20 176#define MSE_INPORT_INTREN 0x09 177 178static int mse_probeati(device_t dev, mse_softc_t *sc); 179static void mse_enableati(bus_space_tag_t t, bus_space_handle_t h); 180static void mse_disableati(bus_space_tag_t t, bus_space_handle_t h); 181static void mse_getati(bus_space_tag_t t, bus_space_handle_t h, 182 int *dx, int *dy, int *but); 183 184static struct mse_types mse_types[] = { 185 { MSE_ATIINPORT, 186 mse_probeati, mse_enableati, mse_disableati, mse_getati, 187 { 2, MOUSE_IF_INPORT, MOUSE_MOUSE, MOUSE_MODEL_GENERIC, 0, }, 188 { MOUSE_PROTO_INPORT, -1, -1, 0, 0, MOUSE_MSC_PACKETSIZE, 189 { MOUSE_MSC_SYNCMASK, MOUSE_MSC_SYNC, }, }, }, 190 { MSE_LOGITECH, 191 mse_probelogi, mse_enablelogi, mse_disablelogi, mse_getlogi, 192 { 2, MOUSE_IF_BUS, MOUSE_MOUSE, MOUSE_MODEL_GENERIC, 0, }, 193 { MOUSE_PROTO_BUS, -1, -1, 0, 0, MOUSE_MSC_PACKETSIZE, 194 { MOUSE_MSC_SYNCMASK, MOUSE_MSC_SYNC, }, }, }, 195 { 0, }, 196}; 197 198static int 199mse_isa_probe(device_t dev) 200{ 201 mse_softc_t *sc; 202 int error; 203 int rid; 204 int i; 205 206 /* check PnP IDs */ 207 error = ISA_PNP_PROBE(device_get_parent(dev), dev, mse_ids); 208 if (error == ENXIO) 209 return error; 210 211 sc = device_get_softc(dev); 212 rid = 0; 213 sc->sc_port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 214 MSE_IOSIZE, RF_ACTIVE); 215 if (sc->sc_port == NULL) 216 return ENXIO; 217 sc->sc_iot = rman_get_bustag(sc->sc_port); 218 sc->sc_ioh = rman_get_bushandle(sc->sc_port); 219 220 /* 221 * Check for each mouse type in the table. 222 */ 223 i = 0; 224 while (mse_types[i].m_type) { 225 if ((*mse_types[i].m_probe)(dev, sc)) { 226 sc->sc_mousetype = mse_types[i].m_type; 227 sc->sc_enablemouse = mse_types[i].m_enable; 228 sc->sc_disablemouse = mse_types[i].m_disable; 229 sc->sc_getmouse = mse_types[i].m_get; 230 sc->hw = mse_types[i].m_hw; 231 sc->mode = mse_types[i].m_mode; 232 bus_release_resource(dev, SYS_RES_IOPORT, rid, 233 sc->sc_port); 234 device_set_desc(dev, "Bus/InPort Mouse"); 235 return 0; 236 } 237 i++; 238 } 239 bus_release_resource(dev, SYS_RES_IOPORT, rid, sc->sc_port); 240 return ENXIO; 241} 242 243static int 244mse_isa_attach(device_t dev) 245{ 246 mse_softc_t *sc; 247 int rid; 248 249 sc = device_get_softc(dev); 250 251 rid = 0; 252 sc->sc_port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 253 MSE_IOSIZE, RF_ACTIVE); 254 if (sc->sc_port == NULL) 255 return ENXIO; 256 sc->sc_iot = rman_get_bustag(sc->sc_port); 257 sc->sc_ioh = rman_get_bushandle(sc->sc_port); 258 259 return (mse_common_attach(dev)); 260} 261 262static int 263mse_isa_detach(device_t dev) 264{ 265 mse_softc_t *sc; 266 int rid; 267 268 sc = device_get_softc(dev); 269 if (sc->sc_flags & MSESC_OPEN) 270 return EBUSY; 271 272 rid = 0; 273 BUS_TEARDOWN_INTR(device_get_parent(dev), dev, sc->sc_intr, sc->sc_ih); 274 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->sc_intr); 275 bus_release_resource(dev, SYS_RES_IOPORT, rid, sc->sc_port); 276 277 destroy_dev(sc->sc_dev); 278 destroy_dev(sc->sc_ndev); 279 280 return 0; 281} 282 283/* 284 * Routines for the Logitech mouse. 285 */ 286/* 287 * Test for a Logitech bus mouse and return 1 if it is. 288 * (until I know how to use the signature port properly, just disable 289 * interrupts and return 1) 290 */ 291static int 292mse_probelogi(device_t dev, mse_softc_t *sc) 293{ 294 295 int sig; 296 297 bus_space_write_1(sc->sc_iot, sc->sc_ioh, MSE_PORTD, MSE_SETUP); 298 /* set the signature port */ 299 bus_space_write_1(sc->sc_iot, sc->sc_ioh, MSE_PORTB, MSE_LOGI_SIG); 300 301 DELAY(30000); /* 30 ms delay */ 302 sig = bus_space_read_1(sc->sc_iot, sc->sc_ioh, MSE_PORTB) & 0xFF; 303 if (sig == MSE_LOGI_SIG) { 304 bus_space_write_1(sc->sc_iot, sc->sc_ioh, MSE_PORTC, 305 MSE_DISINTR); 306 return(1); 307 } else { 308 if (bootverbose) 309 device_printf(dev, "wrong signature %x\n", sig); 310 return(0); 311 } 312} 313 314/* 315 * Initialize Logitech mouse and enable interrupts. 316 */ 317static void 318mse_enablelogi(bus_space_tag_t tag, bus_space_handle_t handle) 319{ 320 int dx, dy, but; 321 322 bus_space_write_1(tag, handle, MSE_PORTD, MSE_SETUP); 323 mse_getlogi(tag, handle, &dx, &dy, &but); 324} 325 326/* 327 * Disable interrupts for Logitech mouse. 328 */ 329static void 330mse_disablelogi(bus_space_tag_t tag, bus_space_handle_t handle) 331{ 332 333 bus_space_write_1(tag, handle, MSE_PORTC, MSE_DISINTR); 334} 335 336/* 337 * Get the current dx, dy and button up/down state. 338 */ 339static void 340mse_getlogi(bus_space_tag_t tag, bus_space_handle_t handle, int *dx, int *dy, 341 int *but) 342{ 343 register char x, y; 344 345 bus_space_write_1(tag, handle, MSE_PORTC, MSE_HOLD | MSE_RXLOW); 346 x = bus_space_read_1(tag, handle, MSE_PORTA); 347 *but = (x >> 5) & MOUSE_MSC_BUTTONS; 348 x &= 0xf; 349 bus_space_write_1(tag, handle, MSE_PORTC, MSE_HOLD | MSE_RXHIGH); 350 x |= (bus_space_read_1(tag, handle, MSE_PORTA) << 4); 351 bus_space_write_1(tag, handle, MSE_PORTC, MSE_HOLD | MSE_RYLOW); 352 y = (bus_space_read_1(tag, handle, MSE_PORTA) & 0xf); 353 bus_space_write_1(tag, handle, MSE_PORTC, MSE_HOLD | MSE_RYHIGH); 354 y |= (bus_space_read_1(tag, handle, MSE_PORTA) << 4); 355 *dx = x; 356 *dy = y; 357 bus_space_write_1(tag, handle, MSE_PORTC, MSE_INTREN); 358} 359 360/* 361 * Routines for the ATI Inport bus mouse. 362 */ 363/* 364 * Test for an ATI Inport bus mouse and return 1 if it is. 365 * (do not enable interrupts) 366 */ 367static int 368mse_probeati(device_t dev, mse_softc_t *sc) 369{ 370 int i; 371 372 for (i = 0; i < 2; i++) 373 if (bus_space_read_1(sc->sc_iot, sc->sc_ioh, MSE_PORTC) == 0xde) 374 return (1); 375 return (0); 376} 377 378/* 379 * Initialize ATI Inport mouse and enable interrupts. 380 */ 381static void 382mse_enableati(bus_space_tag_t tag, bus_space_handle_t handle) 383{ 384 385 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_RESET); 386 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_MODE); 387 bus_space_write_1(tag, handle, MSE_PORTB, MSE_INPORT_INTREN); 388} 389 390/* 391 * Disable interrupts for ATI Inport mouse. 392 */ 393static void 394mse_disableati(bus_space_tag_t tag, bus_space_handle_t handle) 395{ 396 397 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_MODE); 398 bus_space_write_1(tag, handle, MSE_PORTB, 0); 399} 400 401/* 402 * Get current dx, dy and up/down button state. 403 */ 404static void 405mse_getati(bus_space_tag_t tag, bus_space_handle_t handle, int *dx, int *dy, 406 int *but) 407{ 408 char byte; 409 410 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_MODE); 411 bus_space_write_1(tag, handle, MSE_PORTB, MSE_INPORT_HOLD); 412 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_STATUS); 413 *but = ~bus_space_read_1(tag, handle, MSE_PORTB) & MOUSE_MSC_BUTTONS; 414 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_DX); 415 byte = bus_space_read_1(tag, handle, MSE_PORTB); 416 *dx = byte; 417 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_DY); 418 byte = bus_space_read_1(tag, handle, MSE_PORTB); 419 *dy = byte; 420 bus_space_write_1(tag, handle, MSE_PORTA, MSE_INPORT_MODE); 421 bus_space_write_1(tag, handle, MSE_PORTB, MSE_INPORT_INTREN); 422} 423