2 * Copyright (c) 2000 Nick Sayer
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
26 * spic -- the Sony Programmable I/O Controller
28 * This device exists on most recent Sony laptops. It is the means by which
29 * you can watch the Jog Dial and some other functions.
31 * At the moment, this driver merely tries to turn the jog dial into a
32 * device that moused can park on, with the intent of supplying a Z axis
33 * and mouse button out of the jog dial. I suspect that this device will
34 * end up having to support at least 2 different minor devices: One to be
35 * the jog wheel device for moused to camp out on and the other to perform
36 * all of the other miscelaneous functions of this device. But for now,
37 * the jog wheel is all you get.
39 * At the moment, the data sent back by the device is rather primitive.
40 * It sends a single character per event:
41 * u = up, d = down -- that's the jog button
42 * l = left, r = right -- that's the dial.
43 * "left" and "right" are rather caprecious. They actually represent
44 * ccw and cw, respectively
46 * What documentation exists is thanks to Andrew Tridge, and his page at
47 * http://samba.org/picturebook/ Special thanks also to Ian Dowse, who
48 * also provided sample code upon which this driver was based.
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/kernel.h>
57 #include <machine/bus.h>
59 #include <machine/resource.h>
60 #include <isa/isavar.h>
62 #include <machine/pci_cfgreg.h>
63 #include <machine/clock.h>
66 #include <sys/fcntl.h>
67 #include <sys/dkstat.h>
68 #include <sys/malloc.h>
69 #include <sys/sysctl.h>
72 #include <i386/isa/spicreg.h>
74 static int spic_pollrate;
76 SYSCTL_INT(_machdep, OID_AUTO, spic_pollrate, CTLFLAG_RW, &spic_pollrate, 0, "")
79 devclass_t spic_devclass;
81 static d_open_t spicopen;
82 static d_close_t spicclose;
83 static d_read_t spicread;
84 static d_ioctl_t spicioctl;
85 static d_poll_t spicpoll;
87 static struct cdevsw spic_cdevsw = {
89 /* close */ spicclose,
92 /* ioctl */ spicioctl,
95 /* strategy */ nostrategy,
107 u_short sc_port_addr;
109 struct resource *sc_port_res,*sc_intr_res;
110 int sc_port_rid,sc_intr_rid;
114 struct callout_handle sc_timeout_ch;
116 struct selinfo sc_rsel;
117 u_char sc_buf[SCBUFLEN];
122 write_port1(struct spic_softc *sc, u_char val)
125 outb(sc->sc_port_addr, val);
129 write_port2(struct spic_softc *sc, u_char val)
132 outb(sc->sc_port_addr + 4, val);
136 read_port1(struct spic_softc *sc)
139 return inb(sc->sc_port_addr);
143 read_port2(struct spic_softc *sc)
146 return inb(sc->sc_port_addr + 4);
150 busy_wait(struct spic_softc *sc)
154 while(read_port2(sc) & 2) {
157 printf("spic busy wait abort\n");
164 spic_call1(struct spic_softc *sc, u_char dev) {
166 write_port2(sc, dev);
168 return read_port1(sc);
172 spic_call2(struct spic_softc *sc, u_char dev, u_char fn)
175 write_port2(sc, dev);
178 return read_port1(sc);
182 spic_probe(device_t dev)
184 struct spic_softc *sc;
187 sc = device_get_softc(dev);
190 * We can only have 1 of these. Attempting to probe for a unit 1
191 * will destroy the work we did for unit 0
193 if (device_get_unit(dev))
196 bzero(sc, sizeof(struct spic_softc));
198 if (!(sc->sc_port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
199 &sc->sc_port_rid, 0, ~0, 5, RF_ACTIVE))) {
200 device_printf(dev,"Couldn't map I/O\n");
203 sc->sc_port_addr = (u_short)rman_get_start(sc->sc_port_res);
206 if (!(sc->sc_intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
207 &sc->sc_intr_rid, 0, ~0, 1, RF_ACTIVE))) {
208 device_printf(dev,"Couldn't map IRQ\n");
209 bus_release_resource(dev, SYS_RES_IOPORT,
210 sc->sc_port_rid, sc->sc_port_res);
213 sc->sc_intr = (u_short)rman_get_start(sc->sc_intr_res);
215 switch (sc->sc_intr) {
216 case 0: spic_irq = 3; break;
217 case 5: spic_irq = 0; break;
218 case 0xa: spic_irq = 1; break;
219 case 0xb: spic_irq = 2; break;
220 default: device_printf(dev,"Invalid IRQ\n");
221 bus_release_resource(dev, SYS_RES_IOPORT,
222 sc->sc_port_rid, sc->sc_port_res);
223 bus_release_resource(dev, SYS_RES_IRQ,
224 sc->sc_intr_rid, sc->sc_intr_res);
232 if (sc->sc_port_addr != 0x10A0) {
233 bus_release_resource(dev, SYS_RES_IOPORT,
234 sc->sc_port_rid, sc->sc_port_res);
235 bus_release_resource(dev, SYS_RES_IRQ,
236 sc->sc_intr_rid, sc->sc_intr_res);
241 /* PIIX4 chipset at least? */
242 if (pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, 0, 4) !=
247 * This is an ugly hack. It is necessary until ACPI works correctly.
249 * The SPIC consists of 2 registers. They are mapped onto I/O by the
250 * PIIX4's General Device 10 function. There is also an interrupt
251 * control port at a somewhat magic location, but this first pass is
254 * So the first thing we need to do is map the G10 space in.
258 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10A,
259 sc->sc_port_addr, 2);
260 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
263 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
264 outw(SPIC_IRQ_PORT, (inw(SPIC_IRQ_PORT) & ~(0x3 << SPIC_IRQ_SHIFT)) | (spic_irq << SPIC_IRQ_SHIFT));
265 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
268 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
271 * XXX: Should try and see if there's anything actually there.
274 device_set_desc(dev, "Sony Programmable I/O Controller");
280 spic_attach(device_t dev)
282 struct spic_softc *sc;
284 sc = device_get_softc(dev);
288 spic_pollrate = (hz/50); /* Every 50th of a second */
290 spic_call1(sc, 0x82);
291 spic_call2(sc, 0x81, 0xff);
292 spic_call1(sc, 0x92);
294 /* There can be only one */
295 make_dev(&spic_cdevsw, 0, 0, 0, 0600, "jogdial");
301 spictimeout(void *arg)
303 struct spic_softc *sc = arg;
304 u_char b, event, param;
307 if (!sc->sc_opened) {
308 device_printf(sc->sc_dev, "timeout called while closed!\n");
312 event = read_port2(sc);
313 param = read_port1(sc);
315 if ((event != 4) && (!(event & 0x1)))
317 case 0x10: /* jog wheel event */
318 b = !!(param & 0x40);
319 if (b != sc->sc_buttonlast) {
320 sc->sc_buttonlast = b;
321 sc->sc_buf[sc->sc_count++] =
324 j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
327 sc->sc_buf[sc->sc_count++] =
332 sc->sc_buf[sc->sc_count++] =
336 case 0x60: /* Capture button */
337 printf("Capture button event: %x\n",param);
339 case 0x30: /* Lid switch */
340 printf("Lid switch event: %x\n",param);
343 printf("Unknown event: %x %x\n", event, param);
347 /* No event. Wait some more */
348 sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate);
353 if (sc->sc_sleeping) {
355 wakeup((caddr_t) sc);
357 selwakeup(&sc->sc_rsel);
360 spic_call2(sc, 0x81, 0xff); /* Clear event */
362 sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate);
366 spicopen(dev_t dev, int flag, int fmt, struct proc *p)
368 struct spic_softc *sc;
370 sc = devclass_get_softc(spic_devclass, 0);
378 /* Start the polling */
379 timeout(spictimeout, sc, spic_pollrate);
384 spicclose(dev_t dev, int flag, int fmt, struct proc *p)
386 struct spic_softc *sc;
388 sc = devclass_get_softc(spic_devclass, 0);
391 untimeout(spictimeout, sc, sc->sc_timeout_ch);
397 spicread(dev_t dev, struct uio *uio, int flag)
399 struct spic_softc *sc;
401 u_char buf[SCBUFLEN];
403 sc = devclass_get_softc(spic_devclass, 0);
405 if (uio->uio_resid <= 0) /* What kind of a read is this?! */
409 while (!(sc->sc_count)) {
411 error = tsleep((caddr_t) sc, PZERO | PCATCH, "jogrea", 0);
421 l = min(uio->uio_resid, sc->sc_count);
422 bcopy(sc->sc_buf, buf, l);
424 bcopy(sc->sc_buf + l, sc->sc_buf, l);
426 return uiomove(buf, l, uio);
431 spicioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct proc *p)
433 struct spic_softc *sc;
435 sc = devclass_get_softc(spic_devclass, 0);
441 spicpoll(dev_t dev, int events, struct proc *p)
443 struct spic_softc *sc;
446 sc = devclass_get_softc(spic_devclass, 0);
448 if (events & (POLLIN | POLLRDNORM)) {
450 revents |= events & (POLLIN | POLLRDNORM);
452 selrecord(p, &sc->sc_rsel); /* Who shall we wake? */
460 static device_method_t spic_methods[] = {
461 DEVMETHOD(device_probe, spic_probe),
462 DEVMETHOD(device_attach, spic_attach),
467 static driver_t spic_driver = {
470 sizeof(struct spic_softc),
473 DRIVER_MODULE(spic, isa, spic_driver, spic_devclass, 0, 0);