diff options
author | nsayer <nsayer@FreeBSD.org> | 2000-12-11 19:41:48 +0000 |
---|---|---|
committer | nsayer <nsayer@FreeBSD.org> | 2000-12-11 19:41:48 +0000 |
commit | 86b705b83b56a996243970cf50cb5f4aa8e2edf3 (patch) | |
tree | 935ffa4b0ed6aa8a5512fb130c96b2ca08c3f761 /sys/i386/isa/spic.c | |
parent | 5f9e9b2d9d0e8cd0873e100cb221e09f6ada8e38 (diff) | |
download | FreeBSD-src-86b705b83b56a996243970cf50cb5f4aa8e2edf3.zip FreeBSD-src-86b705b83b56a996243970cf50cb5f4aa8e2edf3.tar.gz |
Add the spic driver, which is a simple first attempt at providing access
to the jog dial device.
Diffstat (limited to 'sys/i386/isa/spic.c')
-rw-r--r-- | sys/i386/isa/spic.c | 474 |
1 files changed, 474 insertions, 0 deletions
diff --git a/sys/i386/isa/spic.c b/sys/i386/isa/spic.c new file mode 100644 index 0000000..ebf37ef --- /dev/null +++ b/sys/i386/isa/spic.c @@ -0,0 +1,474 @@ +/* + * Copyright (c) 2000 Nick Sayer + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * spic -- the Sony Programmable I/O Controller + * + * This device exists on most recent Sony laptops. It is the means by which + * you can watch the Jog Dial and some other functions. + * + * At the moment, this driver merely tries to turn the jog dial into a + * device that moused can park on, with the intent of supplying a Z axis + * and mouse button out of the jog dial. I suspect that this device will + * end up having to support at least 2 different minor devices: One to be + * the jog wheel device for moused to camp out on and the other to perform + * all of the other miscelaneous functions of this device. But for now, + * the jog wheel is all you get. + * + * At the moment, the data sent back by the device is rather primitive. + * It sends a single character per event: + * u = up, d = down -- that's the jog button + * l = left, r = right -- that's the dial. + * "left" and "right" are rather caprecious. They actually represent + * ccw and cw, respectively + * + * What documentation exists is thanks to Andrew Tridge, and his page at + * http://samba.org/picturebook/ Special thanks also to Ian Dowse, who + * also provided sample code upon which this driver was based. + * + * $FreeBSD$ + */ + +#include <sys/param.h> +#include <sys/systm.h> +#include <sys/kernel.h> +#include <sys/bus.h> +#include <machine/bus.h> +#include <sys/rman.h> +#include <machine/resource.h> +#include <isa/isavar.h> +#include <sys/poll.h> +#include <machine/pci_cfgreg.h> +#include <machine/clock.h> +#include <sys/tty.h> +#include <sys/conf.h> +#include <sys/fcntl.h> +#include <sys/dkstat.h> +#include <sys/malloc.h> +#include <sys/sysctl.h> +#include <sys/uio.h> + +#include <i386/isa/spicreg.h> + +static int spic_pollrate; + +SYSCTL_INT(_machdep, OID_AUTO, spic_pollrate, CTLFLAG_RW, &spic_pollrate, 0, "") +; + +devclass_t spic_devclass; + +static d_open_t spicopen; +static d_close_t spicclose; +static d_read_t spicread; +static d_ioctl_t spicioctl; +static d_poll_t spicpoll; + +static struct cdevsw spic_cdevsw = { + /* open */ spicopen, + /* close */ spicclose, + /* read */ spicread, + /* write */ nowrite, + /* ioctl */ spicioctl, + /* poll */ spicpoll, + /* mmap */ nommap, + /* strategy */ nostrategy, + /* name */ "spic", + /* maj */ CDEV_MAJOR, + /* dump */ nodump, + /* psize */ nopsize, + /* flags */ 0, + /* bmaj */ -1 +}; + +#define SCBUFLEN 128 + +struct spic_softc { + u_short sc_port_addr; + u_char sc_intr; + struct resource *sc_port_res,*sc_intr_res; + int sc_port_rid,sc_intr_rid; + int sc_opened; + int sc_sleeping; + int sc_buttonlast; + struct callout_handle sc_timeout_ch; + device_t sc_dev; + struct selinfo sc_rsel; + u_char sc_buf[SCBUFLEN]; + int sc_count; +}; + +static void +write_port1(struct spic_softc *sc, u_char val) +{ + DELAY(10); + outb(sc->sc_port_addr, val); +} + +static void +write_port2(struct spic_softc *sc, u_char val) +{ + DELAY(10); + outb(sc->sc_port_addr + 4, val); +} + +static u_char +read_port1(struct spic_softc *sc) +{ + DELAY(10); + return inb(sc->sc_port_addr); +} + +static u_char +read_port2(struct spic_softc *sc) +{ + DELAY(10); + return inb(sc->sc_port_addr + 4); +} + +static void +busy_wait(struct spic_softc *sc) +{ + int i=0; + + while(read_port2(sc) & 2) { + DELAY(10); + if (i++>10000) { + printf("spic busy wait abort\n"); + return; + } + } +} + +static u_char +spic_call1(struct spic_softc *sc, u_char dev) { + busy_wait(sc); + write_port2(sc, dev); + read_port2(sc); + return read_port1(sc); +} + +static u_char +spic_call2(struct spic_softc *sc, u_char dev, u_char fn) +{ + busy_wait(sc); + write_port2(sc, dev); + busy_wait(sc); + write_port1(sc, fn); + return read_port1(sc); +} + +static int +spic_probe(device_t dev) +{ + struct spic_softc *sc; + u_char t, spic_irq; + + sc = device_get_softc(dev); + + /* + * We can only have 1 of these. Attempting to probe for a unit 1 + * will destroy the work we did for unit 0 + */ + if (device_get_unit(dev)) + return ENXIO; + + bzero(sc, sizeof(struct spic_softc)); + + if (!(sc->sc_port_res = bus_alloc_resource(dev, SYS_RES_IOPORT, + &sc->sc_port_rid, 0, ~0, 5, RF_ACTIVE))) { + device_printf(dev,"Couldn't map I/O\n"); + return ENXIO; + } + sc->sc_port_addr = (u_short)rman_get_start(sc->sc_port_res); + +#ifdef notyet + if (!(sc->sc_intr_res = bus_alloc_resource(dev, SYS_RES_IRQ, + &sc->sc_intr_rid, 0, ~0, 1, RF_ACTIVE))) { + device_printf(dev,"Couldn't map IRQ\n"); + bus_release_resource(dev, SYS_RES_IOPORT, + sc->sc_port_rid, sc->sc_port_res); + return ENXIO; + } + sc->sc_intr = (u_short)rman_get_start(sc->sc_intr_res); + + switch (sc->sc_intr) { + case 0: spic_irq = 3; break; + case 5: spic_irq = 0; break; + case 0xa: spic_irq = 1; break; + case 0xb: spic_irq = 2; break; + default: device_printf(dev,"Invalid IRQ\n"); + bus_release_resource(dev, SYS_RES_IOPORT, + sc->sc_port_rid, sc->sc_port_res); + bus_release_resource(dev, SYS_RES_IRQ, + sc->sc_intr_rid, sc->sc_intr_res); + return ENXIO; + } +#else + spic_irq = 3; +#endif + +#if 0 + if (sc->sc_port_addr != 0x10A0) { + bus_release_resource(dev, SYS_RES_IOPORT, + sc->sc_port_rid, sc->sc_port_res); + bus_release_resource(dev, SYS_RES_IRQ, + sc->sc_intr_rid, sc->sc_intr_res); + return ENXIO; + } +#endif + + /* PIIX4 chipset at least? */ + if (pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, 0, 4) != + PIIX4_DEVID) + return ENXIO; + + /* + * This is an ugly hack. It is necessary until ACPI works correctly. + * + * The SPIC consists of 2 registers. They are mapped onto I/O by the + * PIIX4's General Device 10 function. There is also an interrupt + * control port at a somewhat magic location, but this first pass is + * polled. + * + * So the first thing we need to do is map the G10 space in. + * + */ + + pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10A, + sc->sc_port_addr, 2); + t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1); + t &= 0xf0; + t |= 4; + pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1); + outw(SPIC_IRQ_PORT, (inw(SPIC_IRQ_PORT) & ~(0x3 << SPIC_IRQ_SHIFT)) | (spic_irq << SPIC_IRQ_SHIFT)); + t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1); + t &= 0x1f; + t |= 0xc0; + pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1); + + /* + * XXX: Should try and see if there's anything actually there. + */ + + device_set_desc(dev, "Sony Programmable I/O Controller"); + + return 0; +} + +static int +spic_attach(device_t dev) +{ + struct spic_softc *sc; + + sc = device_get_softc(dev); + + sc->sc_dev = dev; + + spic_pollrate = (hz/50); /* Every 50th of a second */ + + spic_call1(sc, 0x82); + spic_call2(sc, 0x81, 0xff); + spic_call1(sc, 0x92); + + /* There can be only one */ + make_dev(&spic_cdevsw, 0, 0, 0, 0600, "jogdial"); + + return 0; +} + +static void +spictimeout(void *arg) +{ + struct spic_softc *sc = arg; + u_char b, event, param; + int j; + + if (!sc->sc_opened) { + device_printf(sc->sc_dev, "timeout called while closed!\n"); + return; + } + + event = read_port2(sc); + param = read_port1(sc); + + if ((event != 4) && (!(event & 0x1))) + switch(event) { + case 0x10: /* jog wheel event */ + b = !!(param & 0x40); + if (b != sc->sc_buttonlast) { + sc->sc_buttonlast = b; + sc->sc_buf[sc->sc_count++] = + b?'d':'u'; + } + j = (param & 0xf) | ((param & 0x10)? ~0xf:0); + if (j<0) + while(j++!=0) { + sc->sc_buf[sc->sc_count++] = + 'l'; + } + else if (j>0) + while(j--!=0) { + sc->sc_buf[sc->sc_count++] = + 'r'; + } + break; + case 0x60: /* Capture button */ + printf("Capture button event: %x\n",param); + break; + case 0x30: /* Lid switch */ + printf("Lid switch event: %x\n",param); + break; + default: + printf("Unknown event: %x %x\n", event, param); + break; + } + else { + /* No event. Wait some more */ + sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate); + return; + } + + if (sc->sc_count) { + if (sc->sc_sleeping) { + sc->sc_sleeping = 0; + wakeup((caddr_t) sc); + } + selwakeup(&sc->sc_rsel); + } + + spic_call2(sc, 0x81, 0xff); /* Clear event */ + + sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate); +} + +static int +spicopen(dev_t dev, int flag, int fmt, struct proc *p) +{ + struct spic_softc *sc; + + sc = devclass_get_softc(spic_devclass, 0); + + if (sc->sc_opened) + return EBUSY; + + sc->sc_opened++; + sc->sc_count=0; + + /* Start the polling */ + timeout(spictimeout, sc, spic_pollrate); + return 0; +} + +static int +spicclose(dev_t dev, int flag, int fmt, struct proc *p) +{ + struct spic_softc *sc; + + sc = devclass_get_softc(spic_devclass, 0); + + /* Stop polling */ + untimeout(spictimeout, sc, sc->sc_timeout_ch); + sc->sc_opened = 0; + return 0; +} + +static int +spicread(dev_t dev, struct uio *uio, int flag) +{ + struct spic_softc *sc; + int l, s, error; + u_char buf[SCBUFLEN]; + + sc = devclass_get_softc(spic_devclass, 0); + + if (uio->uio_resid <= 0) /* What kind of a read is this?! */ + return 0; + + s = spltty(); + while (!(sc->sc_count)) { + sc->sc_sleeping=1; + error = tsleep((caddr_t) sc, PZERO | PCATCH, "jogrea", 0); + sc->sc_sleeping=0; + if (error) { + splx(s); + return error; + } + } + splx(s); + + s = spltty(); + l = min(uio->uio_resid, sc->sc_count); + bcopy(sc->sc_buf, buf, l); + sc->sc_count -= l; + bcopy(sc->sc_buf + l, sc->sc_buf, l); + splx(s); + return uiomove(buf, l, uio); + +} + +static int +spicioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct proc *p) +{ + struct spic_softc *sc; + + sc = devclass_get_softc(spic_devclass, 0); + + return EIO; +} + +static int +spicpoll(dev_t dev, int events, struct proc *p) +{ + struct spic_softc *sc; + int revents = 0, s; + + sc = devclass_get_softc(spic_devclass, 0); + s = spltty(); + if (events & (POLLIN | POLLRDNORM)) { + if (sc->sc_count) + revents |= events & (POLLIN | POLLRDNORM); + else + selrecord(p, &sc->sc_rsel); /* Who shall we wake? */ + } + splx(s); + + return revents; +} + + +static device_method_t spic_methods[] = { + DEVMETHOD(device_probe, spic_probe), + DEVMETHOD(device_attach, spic_attach), + + { 0, 0 } +}; + +static driver_t spic_driver = { + "spic", + spic_methods, + sizeof(struct spic_softc), +}; + +DRIVER_MODULE(spic, isa, spic_driver, spic_devclass, 0, 0); + |