spic.c revision 83366
169873Snsayer/* 269873Snsayer * Copyright (c) 2000 Nick Sayer 369873Snsayer * All rights reserved. 469873Snsayer * 569873Snsayer * Redistribution and use in source and binary forms, with or without 669873Snsayer * modification, are permitted provided that the following conditions 769873Snsayer * are met: 869873Snsayer * 1. Redistributions of source code must retain the above copyright 969873Snsayer * notice, this list of conditions and the following disclaimer. 1069873Snsayer * 2. Redistributions in binary form must reproduce the above copyright 1169873Snsayer * notice, this list of conditions and the following disclaimer in the 1269873Snsayer * documentation and/or other materials provided with the distribution. 1369873Snsayer * 1469873Snsayer * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1569873Snsayer * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1669873Snsayer * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1769873Snsayer * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1869873Snsayer * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1969873Snsayer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2069873Snsayer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2169873Snsayer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2269873Snsayer * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2369873Snsayer * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2469873Snsayer * SUCH DAMAGE. 2569873Snsayer * 2669873Snsayer * spic -- the Sony Programmable I/O Controller 2769873Snsayer * 2869873Snsayer * This device exists on most recent Sony laptops. It is the means by which 2969873Snsayer * you can watch the Jog Dial and some other functions. 3069873Snsayer * 3169873Snsayer * At the moment, this driver merely tries to turn the jog dial into a 3269873Snsayer * device that moused can park on, with the intent of supplying a Z axis 3369873Snsayer * and mouse button out of the jog dial. I suspect that this device will 3469873Snsayer * end up having to support at least 2 different minor devices: One to be 3569873Snsayer * the jog wheel device for moused to camp out on and the other to perform 3669873Snsayer * all of the other miscelaneous functions of this device. But for now, 3769873Snsayer * the jog wheel is all you get. 3869873Snsayer * 3969873Snsayer * At the moment, the data sent back by the device is rather primitive. 4069873Snsayer * It sends a single character per event: 4169873Snsayer * u = up, d = down -- that's the jog button 4269873Snsayer * l = left, r = right -- that's the dial. 4369873Snsayer * "left" and "right" are rather caprecious. They actually represent 4469873Snsayer * ccw and cw, respectively 4569873Snsayer * 4669873Snsayer * What documentation exists is thanks to Andrew Tridge, and his page at 4769873Snsayer * http://samba.org/picturebook/ Special thanks also to Ian Dowse, who 4869873Snsayer * also provided sample code upon which this driver was based. 4969873Snsayer * 5069873Snsayer * $FreeBSD: head/sys/i386/isa/spic.c 83366 2001-09-12 08:38:13Z julian $ 5169873Snsayer */ 5269873Snsayer 5369873Snsayer#include <sys/param.h> 5469873Snsayer#include <sys/systm.h> 5569873Snsayer#include <sys/kernel.h> 5669873Snsayer#include <sys/bus.h> 5769873Snsayer#include <machine/bus.h> 5869873Snsayer#include <sys/rman.h> 5969873Snsayer#include <machine/resource.h> 6069873Snsayer#include <isa/isavar.h> 6169873Snsayer#include <sys/poll.h> 6269873Snsayer#include <machine/pci_cfgreg.h> 6369873Snsayer#include <machine/clock.h> 6469873Snsayer#include <sys/tty.h> 6569873Snsayer#include <sys/conf.h> 6669873Snsayer#include <sys/fcntl.h> 6769873Snsayer#include <sys/dkstat.h> 6869873Snsayer#include <sys/malloc.h> 6969873Snsayer#include <sys/sysctl.h> 7069873Snsayer#include <sys/uio.h> 7169873Snsayer 7269873Snsayer#include <i386/isa/spicreg.h> 7369873Snsayer 7469873Snsayerstatic int spic_pollrate; 7569873Snsayer 7669873SnsayerSYSCTL_INT(_machdep, OID_AUTO, spic_pollrate, CTLFLAG_RW, &spic_pollrate, 0, "") 7769873Snsayer; 7869873Snsayer 7969873Snsayerdevclass_t spic_devclass; 8069873Snsayer 8169873Snsayerstatic d_open_t spicopen; 8269873Snsayerstatic d_close_t spicclose; 8369873Snsayerstatic d_read_t spicread; 8469873Snsayerstatic d_ioctl_t spicioctl; 8569873Snsayerstatic d_poll_t spicpoll; 8669873Snsayer 8769873Snsayerstatic struct cdevsw spic_cdevsw = { 8869873Snsayer /* open */ spicopen, 8969873Snsayer /* close */ spicclose, 9069873Snsayer /* read */ spicread, 9169873Snsayer /* write */ nowrite, 9269873Snsayer /* ioctl */ spicioctl, 9369873Snsayer /* poll */ spicpoll, 9469873Snsayer /* mmap */ nommap, 9569873Snsayer /* strategy */ nostrategy, 9669873Snsayer /* name */ "spic", 9769873Snsayer /* maj */ CDEV_MAJOR, 9869873Snsayer /* dump */ nodump, 9969873Snsayer /* psize */ nopsize, 10069873Snsayer /* flags */ 0, 10169873Snsayer}; 10269873Snsayer 10369873Snsayer#define SCBUFLEN 128 10469873Snsayer 10569873Snsayerstruct spic_softc { 10669873Snsayer u_short sc_port_addr; 10769873Snsayer u_char sc_intr; 10869873Snsayer struct resource *sc_port_res,*sc_intr_res; 10969873Snsayer int sc_port_rid,sc_intr_rid; 11069873Snsayer int sc_opened; 11169873Snsayer int sc_sleeping; 11269873Snsayer int sc_buttonlast; 11369873Snsayer struct callout_handle sc_timeout_ch; 11469873Snsayer device_t sc_dev; 11569873Snsayer struct selinfo sc_rsel; 11669873Snsayer u_char sc_buf[SCBUFLEN]; 11769873Snsayer int sc_count; 11869873Snsayer}; 11969873Snsayer 12069873Snsayerstatic void 12169873Snsayerwrite_port1(struct spic_softc *sc, u_char val) 12269873Snsayer{ 12369873Snsayer DELAY(10); 12469873Snsayer outb(sc->sc_port_addr, val); 12569873Snsayer} 12669873Snsayer 12769873Snsayerstatic void 12869873Snsayerwrite_port2(struct spic_softc *sc, u_char val) 12969873Snsayer{ 13069873Snsayer DELAY(10); 13169873Snsayer outb(sc->sc_port_addr + 4, val); 13269873Snsayer} 13369873Snsayer 13469873Snsayerstatic u_char 13569873Snsayerread_port1(struct spic_softc *sc) 13669873Snsayer{ 13769873Snsayer DELAY(10); 13869873Snsayer return inb(sc->sc_port_addr); 13969873Snsayer} 14069873Snsayer 14169873Snsayerstatic u_char 14269873Snsayerread_port2(struct spic_softc *sc) 14369873Snsayer{ 14469873Snsayer DELAY(10); 14569873Snsayer return inb(sc->sc_port_addr + 4); 14669873Snsayer} 14769873Snsayer 14869873Snsayerstatic void 14969873Snsayerbusy_wait(struct spic_softc *sc) 15069873Snsayer{ 15169873Snsayer int i=0; 15269873Snsayer 15369873Snsayer while(read_port2(sc) & 2) { 15469873Snsayer DELAY(10); 15569873Snsayer if (i++>10000) { 15669873Snsayer printf("spic busy wait abort\n"); 15769873Snsayer return; 15869873Snsayer } 15969873Snsayer } 16069873Snsayer} 16169873Snsayer 16269873Snsayerstatic u_char 16369873Snsayerspic_call1(struct spic_softc *sc, u_char dev) { 16469873Snsayer busy_wait(sc); 16569873Snsayer write_port2(sc, dev); 16669873Snsayer read_port2(sc); 16769873Snsayer return read_port1(sc); 16869873Snsayer} 16969873Snsayer 17069873Snsayerstatic u_char 17169873Snsayerspic_call2(struct spic_softc *sc, u_char dev, u_char fn) 17269873Snsayer{ 17369873Snsayer busy_wait(sc); 17469873Snsayer write_port2(sc, dev); 17569873Snsayer busy_wait(sc); 17669873Snsayer write_port1(sc, fn); 17769873Snsayer return read_port1(sc); 17869873Snsayer} 17969873Snsayer 18069873Snsayerstatic int 18169873Snsayerspic_probe(device_t dev) 18269873Snsayer{ 18369873Snsayer struct spic_softc *sc; 18469873Snsayer u_char t, spic_irq; 18569873Snsayer 18669873Snsayer sc = device_get_softc(dev); 18769873Snsayer 18869873Snsayer /* 18969873Snsayer * We can only have 1 of these. Attempting to probe for a unit 1 19069873Snsayer * will destroy the work we did for unit 0 19169873Snsayer */ 19269873Snsayer if (device_get_unit(dev)) 19369873Snsayer return ENXIO; 19469873Snsayer 19569873Snsayer bzero(sc, sizeof(struct spic_softc)); 19669873Snsayer 19769873Snsayer if (!(sc->sc_port_res = bus_alloc_resource(dev, SYS_RES_IOPORT, 19869873Snsayer &sc->sc_port_rid, 0, ~0, 5, RF_ACTIVE))) { 19969873Snsayer device_printf(dev,"Couldn't map I/O\n"); 20069873Snsayer return ENXIO; 20169873Snsayer } 20269873Snsayer sc->sc_port_addr = (u_short)rman_get_start(sc->sc_port_res); 20369873Snsayer 20469873Snsayer#ifdef notyet 20569873Snsayer if (!(sc->sc_intr_res = bus_alloc_resource(dev, SYS_RES_IRQ, 20669873Snsayer &sc->sc_intr_rid, 0, ~0, 1, RF_ACTIVE))) { 20769873Snsayer device_printf(dev,"Couldn't map IRQ\n"); 20869873Snsayer bus_release_resource(dev, SYS_RES_IOPORT, 20969873Snsayer sc->sc_port_rid, sc->sc_port_res); 21069873Snsayer return ENXIO; 21169873Snsayer } 21269873Snsayer sc->sc_intr = (u_short)rman_get_start(sc->sc_intr_res); 21369873Snsayer 21469873Snsayer switch (sc->sc_intr) { 21569873Snsayer case 0: spic_irq = 3; break; 21669873Snsayer case 5: spic_irq = 0; break; 21769873Snsayer case 0xa: spic_irq = 1; break; 21869873Snsayer case 0xb: spic_irq = 2; break; 21969873Snsayer default: device_printf(dev,"Invalid IRQ\n"); 22069873Snsayer bus_release_resource(dev, SYS_RES_IOPORT, 22169873Snsayer sc->sc_port_rid, sc->sc_port_res); 22269873Snsayer bus_release_resource(dev, SYS_RES_IRQ, 22369873Snsayer sc->sc_intr_rid, sc->sc_intr_res); 22469873Snsayer return ENXIO; 22569873Snsayer } 22669873Snsayer#else 22769873Snsayer spic_irq = 3; 22869873Snsayer#endif 22969873Snsayer 23069873Snsayer#if 0 23169873Snsayer if (sc->sc_port_addr != 0x10A0) { 23269873Snsayer bus_release_resource(dev, SYS_RES_IOPORT, 23369873Snsayer sc->sc_port_rid, sc->sc_port_res); 23469873Snsayer bus_release_resource(dev, SYS_RES_IRQ, 23569873Snsayer sc->sc_intr_rid, sc->sc_intr_res); 23669873Snsayer return ENXIO; 23769873Snsayer } 23869873Snsayer#endif 23969873Snsayer 24069873Snsayer /* PIIX4 chipset at least? */ 24169873Snsayer if (pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, 0, 4) != 24269873Snsayer PIIX4_DEVID) 24369873Snsayer return ENXIO; 24469873Snsayer 24569873Snsayer /* 24669873Snsayer * This is an ugly hack. It is necessary until ACPI works correctly. 24769873Snsayer * 24869873Snsayer * The SPIC consists of 2 registers. They are mapped onto I/O by the 24969873Snsayer * PIIX4's General Device 10 function. There is also an interrupt 25069873Snsayer * control port at a somewhat magic location, but this first pass is 25169873Snsayer * polled. 25269873Snsayer * 25369873Snsayer * So the first thing we need to do is map the G10 space in. 25469873Snsayer * 25569873Snsayer */ 25669873Snsayer 25769873Snsayer pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10A, 25869873Snsayer sc->sc_port_addr, 2); 25969873Snsayer t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1); 26069873Snsayer t &= 0xf0; 26169873Snsayer t |= 4; 26269873Snsayer pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1); 26369873Snsayer outw(SPIC_IRQ_PORT, (inw(SPIC_IRQ_PORT) & ~(0x3 << SPIC_IRQ_SHIFT)) | (spic_irq << SPIC_IRQ_SHIFT)); 26469873Snsayer t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1); 26569873Snsayer t &= 0x1f; 26669873Snsayer t |= 0xc0; 26769873Snsayer pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1); 26869873Snsayer 26969873Snsayer /* 27069873Snsayer * XXX: Should try and see if there's anything actually there. 27169873Snsayer */ 27269873Snsayer 27369873Snsayer device_set_desc(dev, "Sony Programmable I/O Controller"); 27469873Snsayer 27569873Snsayer return 0; 27669873Snsayer} 27769873Snsayer 27869873Snsayerstatic int 27969873Snsayerspic_attach(device_t dev) 28069873Snsayer{ 28169873Snsayer struct spic_softc *sc; 28269873Snsayer 28369873Snsayer sc = device_get_softc(dev); 28469873Snsayer 28569873Snsayer sc->sc_dev = dev; 28669873Snsayer 28769873Snsayer spic_pollrate = (hz/50); /* Every 50th of a second */ 28869873Snsayer 28969873Snsayer spic_call1(sc, 0x82); 29069873Snsayer spic_call2(sc, 0x81, 0xff); 29169873Snsayer spic_call1(sc, 0x92); 29269873Snsayer 29369873Snsayer /* There can be only one */ 29469873Snsayer make_dev(&spic_cdevsw, 0, 0, 0, 0600, "jogdial"); 29569873Snsayer 29669873Snsayer return 0; 29769873Snsayer} 29869873Snsayer 29969873Snsayerstatic void 30069873Snsayerspictimeout(void *arg) 30169873Snsayer{ 30269873Snsayer struct spic_softc *sc = arg; 30369873Snsayer u_char b, event, param; 30469873Snsayer int j; 30569873Snsayer 30669873Snsayer if (!sc->sc_opened) { 30769873Snsayer device_printf(sc->sc_dev, "timeout called while closed!\n"); 30869873Snsayer return; 30969873Snsayer } 31069873Snsayer 31169873Snsayer event = read_port2(sc); 31269873Snsayer param = read_port1(sc); 31369873Snsayer 31469873Snsayer if ((event != 4) && (!(event & 0x1))) 31569873Snsayer switch(event) { 31669873Snsayer case 0x10: /* jog wheel event */ 31769873Snsayer b = !!(param & 0x40); 31869873Snsayer if (b != sc->sc_buttonlast) { 31969873Snsayer sc->sc_buttonlast = b; 32069873Snsayer sc->sc_buf[sc->sc_count++] = 32169873Snsayer b?'d':'u'; 32269873Snsayer } 32369873Snsayer j = (param & 0xf) | ((param & 0x10)? ~0xf:0); 32469873Snsayer if (j<0) 32569873Snsayer while(j++!=0) { 32669873Snsayer sc->sc_buf[sc->sc_count++] = 32769873Snsayer 'l'; 32869873Snsayer } 32969873Snsayer else if (j>0) 33069873Snsayer while(j--!=0) { 33169873Snsayer sc->sc_buf[sc->sc_count++] = 33269873Snsayer 'r'; 33369873Snsayer } 33469873Snsayer break; 33569873Snsayer case 0x60: /* Capture button */ 33669873Snsayer printf("Capture button event: %x\n",param); 33769873Snsayer break; 33869873Snsayer case 0x30: /* Lid switch */ 33969873Snsayer printf("Lid switch event: %x\n",param); 34069873Snsayer break; 34169873Snsayer default: 34269873Snsayer printf("Unknown event: %x %x\n", event, param); 34369873Snsayer break; 34469873Snsayer } 34569873Snsayer else { 34669873Snsayer /* No event. Wait some more */ 34769873Snsayer sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate); 34869873Snsayer return; 34969873Snsayer } 35069873Snsayer 35169873Snsayer if (sc->sc_count) { 35269873Snsayer if (sc->sc_sleeping) { 35369873Snsayer sc->sc_sleeping = 0; 35469873Snsayer wakeup((caddr_t) sc); 35569873Snsayer } 35669873Snsayer selwakeup(&sc->sc_rsel); 35769873Snsayer } 35869873Snsayer 35969873Snsayer spic_call2(sc, 0x81, 0xff); /* Clear event */ 36069873Snsayer 36169873Snsayer sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate); 36269873Snsayer} 36369873Snsayer 36469873Snsayerstatic int 36583366Sjulianspicopen(dev_t dev, int flag, int fmt, struct thread *td) 36669873Snsayer{ 36769873Snsayer struct spic_softc *sc; 36869873Snsayer 36969873Snsayer sc = devclass_get_softc(spic_devclass, 0); 37069873Snsayer 37169873Snsayer if (sc->sc_opened) 37269873Snsayer return EBUSY; 37369873Snsayer 37469873Snsayer sc->sc_opened++; 37569873Snsayer sc->sc_count=0; 37669873Snsayer 37769873Snsayer /* Start the polling */ 37869873Snsayer timeout(spictimeout, sc, spic_pollrate); 37969873Snsayer return 0; 38069873Snsayer} 38169873Snsayer 38269873Snsayerstatic int 38383366Sjulianspicclose(dev_t dev, int flag, int fmt, struct thread *td) 38469873Snsayer{ 38569873Snsayer struct spic_softc *sc; 38669873Snsayer 38769873Snsayer sc = devclass_get_softc(spic_devclass, 0); 38869873Snsayer 38969873Snsayer /* Stop polling */ 39069873Snsayer untimeout(spictimeout, sc, sc->sc_timeout_ch); 39169873Snsayer sc->sc_opened = 0; 39269873Snsayer return 0; 39369873Snsayer} 39469873Snsayer 39569873Snsayerstatic int 39669873Snsayerspicread(dev_t dev, struct uio *uio, int flag) 39769873Snsayer{ 39869873Snsayer struct spic_softc *sc; 39969873Snsayer int l, s, error; 40069873Snsayer u_char buf[SCBUFLEN]; 40169873Snsayer 40269873Snsayer sc = devclass_get_softc(spic_devclass, 0); 40369873Snsayer 40469873Snsayer if (uio->uio_resid <= 0) /* What kind of a read is this?! */ 40569873Snsayer return 0; 40669873Snsayer 40769873Snsayer s = spltty(); 40869873Snsayer while (!(sc->sc_count)) { 40969873Snsayer sc->sc_sleeping=1; 41069873Snsayer error = tsleep((caddr_t) sc, PZERO | PCATCH, "jogrea", 0); 41169873Snsayer sc->sc_sleeping=0; 41269873Snsayer if (error) { 41369873Snsayer splx(s); 41469873Snsayer return error; 41569873Snsayer } 41669873Snsayer } 41769873Snsayer splx(s); 41869873Snsayer 41969873Snsayer s = spltty(); 42069873Snsayer l = min(uio->uio_resid, sc->sc_count); 42169873Snsayer bcopy(sc->sc_buf, buf, l); 42269873Snsayer sc->sc_count -= l; 42369873Snsayer bcopy(sc->sc_buf + l, sc->sc_buf, l); 42469873Snsayer splx(s); 42569873Snsayer return uiomove(buf, l, uio); 42669873Snsayer 42769873Snsayer} 42869873Snsayer 42969873Snsayerstatic int 43083366Sjulianspicioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td) 43169873Snsayer{ 43269873Snsayer struct spic_softc *sc; 43369873Snsayer 43469873Snsayer sc = devclass_get_softc(spic_devclass, 0); 43569873Snsayer 43669873Snsayer return EIO; 43769873Snsayer} 43869873Snsayer 43969873Snsayerstatic int 44083366Sjulianspicpoll(dev_t dev, int events, struct thread *td) 44169873Snsayer{ 44269873Snsayer struct spic_softc *sc; 44369873Snsayer int revents = 0, s; 44469873Snsayer 44569873Snsayer sc = devclass_get_softc(spic_devclass, 0); 44669873Snsayer s = spltty(); 44769873Snsayer if (events & (POLLIN | POLLRDNORM)) { 44869873Snsayer if (sc->sc_count) 44969873Snsayer revents |= events & (POLLIN | POLLRDNORM); 45069873Snsayer else 45183366Sjulian selrecord(td, &sc->sc_rsel); /* Who shall we wake? */ 45269873Snsayer } 45369873Snsayer splx(s); 45469873Snsayer 45569873Snsayer return revents; 45669873Snsayer} 45769873Snsayer 45869873Snsayer 45969873Snsayerstatic device_method_t spic_methods[] = { 46069873Snsayer DEVMETHOD(device_probe, spic_probe), 46169873Snsayer DEVMETHOD(device_attach, spic_attach), 46269873Snsayer 46369873Snsayer { 0, 0 } 46469873Snsayer}; 46569873Snsayer 46669873Snsayerstatic driver_t spic_driver = { 46769873Snsayer "spic", 46869873Snsayer spic_methods, 46969873Snsayer sizeof(struct spic_softc), 47069873Snsayer}; 47169873Snsayer 47269873SnsayerDRIVER_MODULE(spic, isa, spic_driver, spic_devclass, 0, 0); 47369873Snsayer 474