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 $
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/kernel.h>
58 #include <sys/event.h>
61 #include <sys/fcntl.h>
62 #include <sys/dkstat.h>
63 #include <sys/malloc.h>
64 #include <sys/sysctl.h>
67 #include <sys/thread2.h>
69 #include <bus/isa/isavar.h>
71 #include <bus/pci/pci_cfgreg.h>
72 #include <machine/clock.h>
76 static int spic_pollrate;
78 SYSCTL_INT(_machdep, OID_AUTO, spic_pollrate, CTLFLAG_RW, &spic_pollrate, 0, "");
80 devclass_t spic_devclass;
82 static d_open_t spicopen;
83 static d_close_t spicclose;
84 static d_read_t spicread;
85 static d_ioctl_t spicioctl;
86 static d_kqfilter_t spickqfilter;
88 static void spicfilt_detach(struct knote *);
89 static int spicfilt(struct knote *, long);
91 static struct dev_ops spic_ops = {
97 .d_kqfilter = spickqfilter
103 u_short sc_port_addr;
105 struct resource *sc_port_res,*sc_intr_res;
106 int sc_port_rid,sc_intr_rid;
110 struct callout sc_timeout_ch;
112 struct kqinfo sc_rkq;
113 u_char sc_buf[SCBUFLEN];
119 write_port1(struct spic_softc *sc, u_char val)
122 outb(sc->sc_port_addr, val);
126 write_port2(struct spic_softc *sc, u_char val)
129 outb(sc->sc_port_addr + 4, val);
133 read_port1(struct spic_softc *sc)
136 return inb(sc->sc_port_addr);
140 read_port2(struct spic_softc *sc)
143 return inb(sc->sc_port_addr + 4);
147 read_port_cst(struct spic_softc *sc)
150 return inb(SPIC_CST_IOPORT);
154 busy_wait(struct spic_softc *sc)
158 while(read_port2(sc) & 2) {
161 kprintf("spic busy wait abort\n");
168 busy_wait_cst(struct spic_softc *sc, int mask)
172 while(read_port_cst(sc) & mask) {
175 kprintf("spic busy wait abort\n");
182 spic_call1(struct spic_softc *sc, u_char dev) {
184 write_port2(sc, dev);
186 return read_port1(sc);
190 spic_call2(struct spic_softc *sc, u_char dev, u_char fn)
193 write_port2(sc, dev);
196 return read_port1(sc);
200 spic_ecrset(struct spic_softc *sc, u_int16_t addr, u_int16_t value)
202 busy_wait_cst(sc, 3);
203 outb(SPIC_CST_IOPORT, 0x81);
204 busy_wait_cst(sc, 2);
205 outb(SPIC_DATA_IOPORT, addr);
206 busy_wait_cst(sc, 2);
207 outb(SPIC_DATA_IOPORT, value);
208 busy_wait_cst(sc, 2);
212 spic_type2_srs(struct spic_softc *sc)
214 spic_ecrset(sc, SPIC_SHIB, (sc->sc_port_addr & 0xFF00) >> 8);
215 spic_ecrset(sc, SPIC_SLOB, sc->sc_port_addr & 0x00FF);
216 spic_ecrset(sc, SPIC_SIRQ, 0x00); /* using polling mode (IRQ=0)*/
221 spic_probe(device_t dev)
223 struct spic_softc *sc;
226 sc = device_get_softc(dev);
229 * We can only have 1 of these. Attempting to probe for a unit 1
230 * will destroy the work we did for unit 0
232 if (device_get_unit(dev))
236 bzero(sc, sizeof(struct spic_softc));
238 if (!(sc->sc_port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
239 &sc->sc_port_rid, 0, ~0, 5, RF_ACTIVE))) {
240 device_printf(dev,"Couldn't map I/O\n");
243 sc->sc_port_addr = (u_short)rman_get_start(sc->sc_port_res);
246 if (!(sc->sc_intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
247 &sc->sc_intr_rid, 0, ~0, 1, RF_ACTIVE))) {
248 device_printf(dev,"Couldn't map IRQ\n");
249 bus_release_resource(dev, SYS_RES_IOPORT,
250 sc->sc_port_rid, sc->sc_port_res);
253 sc->sc_intr = (u_short)rman_get_start(sc->sc_intr_res);
255 switch (sc->sc_intr) {
256 case 0: spic_irq = 3; break;
257 case 5: spic_irq = 0; break;
258 case 0xa: spic_irq = 1; break;
259 case 0xb: spic_irq = 2; break;
260 default: device_printf(dev,"Invalid IRQ\n");
261 bus_release_resource(dev, SYS_RES_IOPORT,
262 sc->sc_port_rid, sc->sc_port_res);
263 bus_release_resource(dev, SYS_RES_IRQ,
264 sc->sc_intr_rid, sc->sc_intr_res);
272 if (sc->sc_port_addr != 0x10A0) {
273 bus_release_resource(dev, SYS_RES_IOPORT,
274 sc->sc_port_rid, sc->sc_port_res);
275 bus_release_resource(dev, SYS_RES_IRQ,
276 sc->sc_intr_rid, sc->sc_intr_res);
281 /* PIIX4 chipset at least? */
282 if (pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, 0, 4) ==
284 sc->sc_model = SPIC_DEVICE_MODEL_TYPE1;
286 /* For newer VAIOs (R505, SRX7, ...) */
287 sc->sc_model = SPIC_DEVICE_MODEL_TYPE2;
291 * This is an ugly hack. It is necessary until ACPI works correctly.
293 * The SPIC consists of 2 registers. They are mapped onto I/O by the
294 * PIIX4's General Device 10 function. There is also an interrupt
295 * control port at a somewhat magic location, but this first pass is
298 * So the first thing we need to do is map the G10 space in.
302 /* Enable ACPI mode to get Fn key events */
303 /* XXX This may slow down your VAIO if ACPI is not supported in the kernel.
307 device_printf(dev,"device model type = %d\n", sc->sc_model);
309 if(sc->sc_model == SPIC_DEVICE_MODEL_TYPE1) {
310 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10A,
311 sc->sc_port_addr, 2);
312 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
315 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
316 outw(SPIC_IRQ_PORT, (inw(SPIC_IRQ_PORT) & ~(0x3 << SPIC_IRQ_SHIFT)) | (spic_irq << SPIC_IRQ_SHIFT));
317 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
320 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
326 * XXX: Should try and see if there's anything actually there.
329 device_set_desc(dev, "Sony Programmable I/O Controller");
335 spic_attach(device_t dev)
337 struct spic_softc *sc;
339 sc = device_get_softc(dev);
342 callout_init(&sc->sc_timeout_ch);
344 spic_pollrate = (hz/50); /* Every 50th of a second */
346 spic_call1(sc, 0x82);
347 spic_call2(sc, 0x81, 0xff);
348 spic_call1(sc, 0x92);
350 /* There can be only one */
351 make_dev(&spic_ops, device_get_unit(dev), 0, 0, 0600, "jogdial");
357 spictimeout(void *arg)
359 struct spic_softc *sc = arg;
360 u_char b, event, param;
363 if (!sc->sc_opened) {
364 device_printf(sc->sc_dev, "timeout called while closed!\n");
368 event = read_port2(sc);
369 param = read_port1(sc);
371 if ((event != 4) && (!(event & 0x1)))
373 case 0x10: /* jog wheel event (type1) */
374 if (sc->sc_model == SPIC_DEVICE_MODEL_TYPE1) {
375 b = !!(param & 0x40);
376 if (b != sc->sc_buttonlast) {
377 sc->sc_buttonlast = b;
378 sc->sc_buf[sc->sc_count++] =
381 j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
384 sc->sc_buf[sc->sc_count++] =
389 sc->sc_buf[sc->sc_count++] =
394 case 0x08: /* jog wheel event (type2) */
396 /* SPIC_DEVICE_MODEL_TYPE2 returns jog wheel event=0x00 */
397 if (sc->sc_model == SPIC_DEVICE_MODEL_TYPE2) {
398 b = !!(param & 0x40);
399 if (b != sc->sc_buttonlast) {
400 sc->sc_buttonlast = b;
401 sc->sc_buf[sc->sc_count++] =
404 j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
407 sc->sc_buf[sc->sc_count++] =
412 sc->sc_buf[sc->sc_count++] =
417 case 0x60: /* Capture button */
418 kprintf("Capture button event: %x\n",param);
420 case 0x30: /* Lid switch */
421 kprintf("Lid switch event: %x\n",param);
424 kprintf("Unknown event: event %02x param %02x\n", event, param);
428 /* No event. Wait some more */
429 callout_reset(&sc->sc_timeout_ch, spic_pollrate,
435 if (sc->sc_sleeping) {
437 wakeup((caddr_t) sc);
439 KNOTE(&sc->sc_rkq.ki_note, 0);
441 spic_call2(sc, 0x81, 0xff); /* Clear event */
443 callout_reset(&sc->sc_timeout_ch, spic_pollrate, spictimeout, sc);
447 spicopen(struct dev_open_args *ap)
449 struct spic_softc *sc;
451 sc = devclass_get_softc(spic_devclass, 0);
459 /* Start the polling */
460 callout_reset(&sc->sc_timeout_ch, spic_pollrate, spictimeout, sc);
465 spicclose(struct dev_close_args *ap)
467 struct spic_softc *sc;
469 sc = devclass_get_softc(spic_devclass, 0);
472 callout_stop(&sc->sc_timeout_ch);
478 spicread(struct dev_read_args *ap)
480 struct uio *uio = ap->a_uio;
481 struct spic_softc *sc;
483 u_char buf[SCBUFLEN];
485 sc = devclass_get_softc(spic_devclass, 0);
487 if (uio->uio_resid == 0) /* What kind of a read is this?! */
491 while (!(sc->sc_count)) {
493 error = tsleep((caddr_t) sc, PCATCH, "jogrea", 0);
503 l = (int)szmin(uio->uio_resid, sc->sc_count);
504 bcopy(sc->sc_buf, buf, l);
506 bcopy(sc->sc_buf + l, sc->sc_buf, l);
508 return uiomove(buf, (size_t)l, uio);
513 spicioctl(struct dev_ioctl_args *ap)
515 struct spic_softc *sc;
517 sc = devclass_get_softc(spic_devclass, 0);
522 static struct filterops spicfiltops =
523 { FILTEROP_ISFD, NULL, spicfilt_detach, spicfilt };
526 spickqfilter(struct dev_kqfilter_args *ap)
528 struct knote *kn = ap->a_kn;
530 struct spic_softc *sc;
534 switch (kn->kn_filter) {
536 sc = devclass_get_softc(spic_devclass, 0);
537 kn->kn_fop = &spicfiltops;
538 kn->kn_hook = (caddr_t)sc;
541 ap->a_result = EOPNOTSUPP;
545 klist = &sc->sc_rkq.ki_note;
546 knote_insert(klist, kn);
552 spicfilt_detach(struct knote *kn)
554 struct spic_softc *sc = (struct spic_softc *)kn->kn_hook;
555 struct klist *klist = &sc->sc_rkq.ki_note;
557 knote_remove(klist, kn);
561 spicfilt(struct knote *kn, long hint)
563 struct spic_softc *sc = (struct spic_softc *)kn->kn_hook;
574 static device_method_t spic_methods[] = {
575 DEVMETHOD(device_probe, spic_probe),
576 DEVMETHOD(device_attach, spic_attach),
581 static driver_t spic_driver = {
584 sizeof(struct spic_softc),
587 DRIVER_MODULE(spic, isa, spic_driver, spic_devclass, NULL, NULL);