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.
50 * $FreeBSD: src/sys/i386/isa/spic.c,v 1.4.2.1 2002/04/15 00:52:12 will Exp $
51 * $DragonFly: src/sys/dev/misc/spic/spic.c,v 1.6 2003/08/07 21:16:58 dillon Exp $
54 #include <sys/param.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
58 #include <machine/bus.h>
60 #include <machine/resource.h>
61 #include <bus/isa/isavar.h>
63 #include <machine/pci_cfgreg.h>
64 #include <machine/clock.h>
67 #include <sys/fcntl.h>
68 #include <sys/dkstat.h>
69 #include <sys/malloc.h>
70 #include <sys/sysctl.h>
76 static int spic_pollrate;
78 SYSCTL_INT(_machdep, OID_AUTO, spic_pollrate, CTLFLAG_RW, &spic_pollrate, 0, "")
81 devclass_t spic_devclass;
83 static d_open_t spicopen;
84 static d_close_t spicclose;
85 static d_read_t spicread;
86 static d_ioctl_t spicioctl;
87 static d_poll_t spicpoll;
89 static struct cdevsw spic_cdevsw = {
97 /* close */ spicclose,
100 /* ioctl */ spicioctl,
103 /* strategy */ nostrategy,
111 u_short sc_port_addr;
113 struct resource *sc_port_res,*sc_intr_res;
114 int sc_port_rid,sc_intr_rid;
118 struct callout_handle sc_timeout_ch;
120 struct selinfo sc_rsel;
121 u_char sc_buf[SCBUFLEN];
127 write_port1(struct spic_softc *sc, u_char val)
130 outb(sc->sc_port_addr, val);
134 write_port2(struct spic_softc *sc, u_char val)
137 outb(sc->sc_port_addr + 4, val);
141 read_port1(struct spic_softc *sc)
144 return inb(sc->sc_port_addr);
148 read_port2(struct spic_softc *sc)
151 return inb(sc->sc_port_addr + 4);
155 read_port_cst(struct spic_softc *sc)
158 return inb(SPIC_CST_IOPORT);
162 busy_wait(struct spic_softc *sc)
166 while(read_port2(sc) & 2) {
169 printf("spic busy wait abort\n");
176 busy_wait_cst(struct spic_softc *sc, int mask)
180 while(read_port_cst(sc) & mask) {
183 printf("spic busy wait abort\n");
190 spic_call1(struct spic_softc *sc, u_char dev) {
192 write_port2(sc, dev);
194 return read_port1(sc);
198 spic_call2(struct spic_softc *sc, u_char dev, u_char fn)
201 write_port2(sc, dev);
204 return read_port1(sc);
208 spic_ecrset(struct spic_softc *sc, u_int16_t addr, u_int16_t value)
210 busy_wait_cst(sc, 3);
211 outb(SPIC_CST_IOPORT, 0x81);
212 busy_wait_cst(sc, 2);
213 outb(SPIC_DATA_IOPORT, addr);
214 busy_wait_cst(sc, 2);
215 outb(SPIC_DATA_IOPORT, value);
216 busy_wait_cst(sc, 2);
220 spic_type2_srs(struct spic_softc *sc)
222 spic_ecrset(sc, SPIC_SHIB, (sc->sc_port_addr & 0xFF00) >> 8);
223 spic_ecrset(sc, SPIC_SLOB, sc->sc_port_addr & 0x00FF);
224 spic_ecrset(sc, SPIC_SIRQ, 0x00); /* using polling mode (IRQ=0)*/
229 spic_probe(device_t dev)
231 struct spic_softc *sc;
234 sc = device_get_softc(dev);
237 * We can only have 1 of these. Attempting to probe for a unit 1
238 * will destroy the work we did for unit 0
240 if (device_get_unit(dev))
244 bzero(sc, sizeof(struct spic_softc));
246 if (!(sc->sc_port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
247 &sc->sc_port_rid, 0, ~0, 5, RF_ACTIVE))) {
248 device_printf(dev,"Couldn't map I/O\n");
251 sc->sc_port_addr = (u_short)rman_get_start(sc->sc_port_res);
254 if (!(sc->sc_intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
255 &sc->sc_intr_rid, 0, ~0, 1, RF_ACTIVE))) {
256 device_printf(dev,"Couldn't map IRQ\n");
257 bus_release_resource(dev, SYS_RES_IOPORT,
258 sc->sc_port_rid, sc->sc_port_res);
261 sc->sc_intr = (u_short)rman_get_start(sc->sc_intr_res);
263 switch (sc->sc_intr) {
264 case 0: spic_irq = 3; break;
265 case 5: spic_irq = 0; break;
266 case 0xa: spic_irq = 1; break;
267 case 0xb: spic_irq = 2; break;
268 default: device_printf(dev,"Invalid IRQ\n");
269 bus_release_resource(dev, SYS_RES_IOPORT,
270 sc->sc_port_rid, sc->sc_port_res);
271 bus_release_resource(dev, SYS_RES_IRQ,
272 sc->sc_intr_rid, sc->sc_intr_res);
280 if (sc->sc_port_addr != 0x10A0) {
281 bus_release_resource(dev, SYS_RES_IOPORT,
282 sc->sc_port_rid, sc->sc_port_res);
283 bus_release_resource(dev, SYS_RES_IRQ,
284 sc->sc_intr_rid, sc->sc_intr_res);
289 /* PIIX4 chipset at least? */
290 if (pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, 0, 4) ==
292 sc->sc_model = SPIC_DEVICE_MODEL_TYPE1;
294 /* For newer VAIOs (R505, SRX7, ...) */
295 sc->sc_model = SPIC_DEVICE_MODEL_TYPE2;
299 * This is an ugly hack. It is necessary until ACPI works correctly.
301 * The SPIC consists of 2 registers. They are mapped onto I/O by the
302 * PIIX4's General Device 10 function. There is also an interrupt
303 * control port at a somewhat magic location, but this first pass is
306 * So the first thing we need to do is map the G10 space in.
310 /* Enable ACPI mode to get Fn key events */
311 /* XXX This may slow down your VAIO if ACPI is not supported in the kernel.
315 device_printf(dev,"device model type = %d\n", sc->sc_model);
317 if(sc->sc_model == SPIC_DEVICE_MODEL_TYPE1) {
318 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10A,
319 sc->sc_port_addr, 2);
320 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
323 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
324 outw(SPIC_IRQ_PORT, (inw(SPIC_IRQ_PORT) & ~(0x3 << SPIC_IRQ_SHIFT)) | (spic_irq << SPIC_IRQ_SHIFT));
325 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
328 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
334 * XXX: Should try and see if there's anything actually there.
337 device_set_desc(dev, "Sony Programmable I/O Controller");
343 spic_attach(device_t dev)
345 struct spic_softc *sc;
347 sc = device_get_softc(dev);
351 spic_pollrate = (hz/50); /* Every 50th of a second */
353 spic_call1(sc, 0x82);
354 spic_call2(sc, 0x81, 0xff);
355 spic_call1(sc, 0x92);
357 /* There can be only one */
358 make_dev(&spic_cdevsw, 0, 0, 0, 0600, "jogdial");
364 spictimeout(void *arg)
366 struct spic_softc *sc = arg;
367 u_char b, event, param;
370 if (!sc->sc_opened) {
371 device_printf(sc->sc_dev, "timeout called while closed!\n");
375 event = read_port2(sc);
376 param = read_port1(sc);
378 if ((event != 4) && (!(event & 0x1)))
380 case 0x10: /* jog wheel event (type1) */
381 if (sc->sc_model == SPIC_DEVICE_MODEL_TYPE1) {
382 b = !!(param & 0x40);
383 if (b != sc->sc_buttonlast) {
384 sc->sc_buttonlast = b;
385 sc->sc_buf[sc->sc_count++] =
388 j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
391 sc->sc_buf[sc->sc_count++] =
396 sc->sc_buf[sc->sc_count++] =
401 case 0x08: /* jog wheel event (type2) */
403 /* SPIC_DEVICE_MODEL_TYPE2 returns jog wheel event=0x00 */
404 if (sc->sc_model == SPIC_DEVICE_MODEL_TYPE2) {
405 b = !!(param & 0x40);
406 if (b != sc->sc_buttonlast) {
407 sc->sc_buttonlast = b;
408 sc->sc_buf[sc->sc_count++] =
411 j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
414 sc->sc_buf[sc->sc_count++] =
419 sc->sc_buf[sc->sc_count++] =
424 case 0x60: /* Capture button */
425 printf("Capture button event: %x\n",param);
427 case 0x30: /* Lid switch */
428 printf("Lid switch event: %x\n",param);
431 printf("Unknown event: event %02x param %02x\n", event, param);
435 /* No event. Wait some more */
436 sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate);
441 if (sc->sc_sleeping) {
443 wakeup((caddr_t) sc);
445 selwakeup(&sc->sc_rsel);
447 spic_call2(sc, 0x81, 0xff); /* Clear event */
449 sc->sc_timeout_ch = timeout(spictimeout, sc, spic_pollrate);
453 spicopen(dev_t dev, int flag, int fmt, struct thread *td)
455 struct spic_softc *sc;
457 sc = devclass_get_softc(spic_devclass, 0);
465 /* Start the polling */
466 timeout(spictimeout, sc, spic_pollrate);
471 spicclose(dev_t dev, int flag, int fmt, struct thread *td)
473 struct spic_softc *sc;
475 sc = devclass_get_softc(spic_devclass, 0);
478 untimeout(spictimeout, sc, sc->sc_timeout_ch);
484 spicread(dev_t dev, struct uio *uio, int flag)
486 struct spic_softc *sc;
488 u_char buf[SCBUFLEN];
490 sc = devclass_get_softc(spic_devclass, 0);
492 if (uio->uio_resid <= 0) /* What kind of a read is this?! */
496 while (!(sc->sc_count)) {
498 error = tsleep((caddr_t) sc, PCATCH, "jogrea", 0);
508 l = min(uio->uio_resid, sc->sc_count);
509 bcopy(sc->sc_buf, buf, l);
511 bcopy(sc->sc_buf + l, sc->sc_buf, l);
513 return uiomove(buf, l, uio);
518 spicioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
520 struct spic_softc *sc;
522 sc = devclass_get_softc(spic_devclass, 0);
528 spicpoll(dev_t dev, int events, struct thread *td)
530 struct spic_softc *sc;
538 sc = devclass_get_softc(spic_devclass, 0);
540 if (events & (POLLIN | POLLRDNORM)) {
542 revents |= events & (POLLIN | POLLRDNORM);
544 if (sc->sc_rsel.si_pid && (p1=pfind(sc->sc_rsel.si_pid))
545 && p1->p_wchan == (caddr_t)&selwait)
546 sc->sc_rsel.si_flags = SI_COLL;
548 sc->sc_rsel.si_pid = p->p_pid;
557 static device_method_t spic_methods[] = {
558 DEVMETHOD(device_probe, spic_probe),
559 DEVMETHOD(device_attach, spic_attach),
564 static driver_t spic_driver = {
567 sizeof(struct spic_softc),
570 DRIVER_MODULE(spic, isa, spic_driver, spic_devclass, 0, 0);