sys/dev/misc/spic/spic.c

   1 /*
   2  * Copyright (c) 2000  Nick Sayer
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  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
  24  * SUCH DAMAGE.
  25  *
  26  * spic -- the Sony Programmable I/O Controller
  27  *
  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.
  30  *
  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.
  38  *
  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
  45  *
  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.
  49  *
  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.15 2006/10/25 20:55:55 dillon Exp $
  52  */
  53
  54 #include <sys/param.h>
  55 #include <sys/systm.h>
  56 #include <sys/kernel.h>
  57 #include <sys/bus.h>
  58 #include <sys/rman.h>
  59 #include <sys/poll.h>
  60 #include <sys/tty.h>
  61 #include <sys/conf.h>
  62 #include <sys/fcntl.h>
  63 #include <sys/dkstat.h>
  64 #include <sys/malloc.h>
  65 #include <sys/sysctl.h>
  66 #include <sys/uio.h>
  67 #include <sys/proc.h>
  68 #include <sys/thread2.h>
  69
  70 #include <bus/isa/isavar.h>
  71
  72 #include <machine/pci_cfgreg.h>
  73 #include <machine/clock.h>
  74
  75 #include "spicreg.h"
  76
  77 static int spic_pollrate;
  78
  79 SYSCTL_INT(_machdep, OID_AUTO, spic_pollrate, CTLFLAG_RW, &spic_pollrate, 0, "")
  80 ;
  81
  82 devclass_t spic_devclass;
  83
  84 static d_open_t         spicopen;
  85 static d_close_t        spicclose;
  86 static d_read_t         spicread;
  87 static d_ioctl_t        spicioctl;
  88 static d_poll_t         spicpoll;
  89
  90 static struct dev_ops spic_ops = {
  91         { "spic", CDEV_MAJOR, 0 },
  92         .d_open =       spicopen,
  93         .d_close =      spicclose,
  94         .d_read =       spicread,
  95         .d_ioctl =      spicioctl,
  96         .d_poll =       spicpoll,
  97 };
  98
  99 #define SCBUFLEN 128
 100
 101 struct spic_softc {
 102         u_short sc_port_addr;
 103         u_char sc_intr;
 104         struct resource *sc_port_res,*sc_intr_res;
 105         int     sc_port_rid,sc_intr_rid;
 106         int sc_opened;
 107         int sc_sleeping;
 108         int sc_buttonlast;
 109         struct callout  sc_timeout_ch;
 110         device_t sc_dev;
 111         struct selinfo sc_rsel;
 112         u_char sc_buf[SCBUFLEN];
 113         int sc_count;
 114         int sc_model;
 115 };
 116
 117 static void
 118 write_port1(struct spic_softc *sc, u_char val)
 119 {
 120         DELAY(10);
 121         outb(sc->sc_port_addr, val);
 122 }
 123
 124 static void
 125 write_port2(struct spic_softc *sc, u_char val)
 126 {
 127         DELAY(10);
 128         outb(sc->sc_port_addr + 4, val);
 129 }
 130
 131 static u_char
 132 read_port1(struct spic_softc *sc)
 133 {
 134         DELAY(10);
 135         return inb(sc->sc_port_addr);
 136 }
 137
 138 static u_char
 139 read_port2(struct spic_softc *sc)
 140 {
 141         DELAY(10);
 142         return inb(sc->sc_port_addr + 4);
 143 }
 144
 145 static u_char
 146 read_port_cst(struct spic_softc *sc)
 147 {
 148         DELAY(10);
 149         return inb(SPIC_CST_IOPORT);
 150 }
 151
 152 static void
 153 busy_wait(struct spic_softc *sc)
 154 {
 155         int i=0;
 156
 157         while(read_port2(sc) & 2) {
 158                 DELAY(10);
 159                 if (i++>10000) {
 160                         printf("spic busy wait abort\n");
 161                         return;
 162                 }
 163         }
 164 }
 165
 166 static void
 167 busy_wait_cst(struct spic_softc *sc, int mask)
 168 {
 169         int i=0;
 170
 171         while(read_port_cst(sc) & mask) {
 172                 DELAY(10);
 173                 if (i++>10000) {
 174                         printf("spic busy wait abort\n");
 175                         return;
 176                 }
 177         }
 178 }
 179
 180 static u_char
 181 spic_call1(struct spic_softc *sc, u_char dev) {
 182         busy_wait(sc);
 183         write_port2(sc, dev);
 184         read_port2(sc);
 185         return read_port1(sc);
 186 }
 187
 188 static u_char
 189 spic_call2(struct spic_softc *sc, u_char dev, u_char fn)
 190 {
 191         busy_wait(sc);
 192         write_port2(sc, dev);
 193         busy_wait(sc);
 194         write_port1(sc, fn);
 195         return read_port1(sc);
 196 }
 197
 198 static void
 199 spic_ecrset(struct spic_softc *sc, u_int16_t addr, u_int16_t value)
 200 {
 201         busy_wait_cst(sc, 3);
 202         outb(SPIC_CST_IOPORT, 0x81);
 203         busy_wait_cst(sc, 2);
 204         outb(SPIC_DATA_IOPORT, addr);
 205         busy_wait_cst(sc, 2);
 206         outb(SPIC_DATA_IOPORT, value);
 207         busy_wait_cst(sc, 2);
 208 }
 209
 210 static void
 211 spic_type2_srs(struct spic_softc *sc)
 212 {
 213         spic_ecrset(sc, SPIC_SHIB, (sc->sc_port_addr & 0xFF00) >> 8);
 214         spic_ecrset(sc, SPIC_SLOB,  sc->sc_port_addr & 0x00FF);
 215         spic_ecrset(sc, SPIC_SIRQ,  0x00); /* using polling mode (IRQ=0)*/
 216         DELAY(10);
 217 }
 218
 219 static int
 220 spic_probe(device_t dev)
 221 {
 222         struct spic_softc *sc;
 223         u_char t, spic_irq;
 224
 225         sc = device_get_softc(dev);
 226
 227         /*
 228          * We can only have 1 of these. Attempting to probe for a unit 1
 229          * will destroy the work we did for unit 0
 230          */
 231         if (device_get_unit(dev))
 232                 return ENXIO;
 233
 234
 235         bzero(sc, sizeof(struct spic_softc));
 236
 237         if (!(sc->sc_port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
 238                 &sc->sc_port_rid, 0, ~0, 5, RF_ACTIVE))) {
 239                 device_printf(dev,"Couldn't map I/O\n");
 240                 return ENXIO;
 241         }
 242         sc->sc_port_addr = (u_short)rman_get_start(sc->sc_port_res);
 243
 244 #ifdef notyet
 245         if (!(sc->sc_intr_res = bus_alloc_resource(dev, SYS_RES_IRQ,
 246                 &sc->sc_intr_rid, 0, ~0, 1, RF_ACTIVE))) {
 247                 device_printf(dev,"Couldn't map IRQ\n");
 248                 bus_release_resource(dev, SYS_RES_IOPORT,
 249                         sc->sc_port_rid, sc->sc_port_res);
 250                 return ENXIO;
 251         }
 252         sc->sc_intr = (u_short)rman_get_start(sc->sc_intr_res);
 253
 254         switch (sc->sc_intr) {
 255                 case 0: spic_irq = 3; break;
 256                 case 5: spic_irq = 0; break;
 257                 case 0xa: spic_irq = 1; break;
 258                 case 0xb: spic_irq = 2; break;
 259                 default: device_printf(dev,"Invalid IRQ\n");
 260                         bus_release_resource(dev, SYS_RES_IOPORT,
 261                                 sc->sc_port_rid, sc->sc_port_res);
 262                         bus_release_resource(dev, SYS_RES_IRQ,
 263                                 sc->sc_intr_rid, sc->sc_intr_res);
 264                         return ENXIO;
 265         }
 266 #else
 267         spic_irq = 3;
 268 #endif
 269
 270 #if 0
 271         if (sc->sc_port_addr != 0x10A0) {
 272                 bus_release_resource(dev, SYS_RES_IOPORT,
 273                         sc->sc_port_rid, sc->sc_port_res);
 274                 bus_release_resource(dev, SYS_RES_IRQ,
 275                         sc->sc_intr_rid, sc->sc_intr_res);
 276                 return ENXIO;
 277         }
 278 #endif
 279
 280         /* PIIX4 chipset at least? */
 281         if (pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, 0, 4) ==
 282                 PIIX4_DEVID) {
 283                 sc->sc_model = SPIC_DEVICE_MODEL_TYPE1;
 284         } else {
 285                 /* For newer VAIOs (R505, SRX7, ...) */
 286                 sc->sc_model = SPIC_DEVICE_MODEL_TYPE2;
 287         }
 288
 289         /*
 290          * This is an ugly hack. It is necessary until ACPI works correctly.
 291          *
 292          * The SPIC consists of 2 registers. They are mapped onto I/O by the
 293          * PIIX4's General Device 10 function. There is also an interrupt
 294          * control port at a somewhat magic location, but this first pass is
 295          * polled.
 296          *
 297          * So the first thing we need to do is map the G10 space in.
 298          *
 299          */
 300
 301         /* Enable ACPI mode to get Fn key events */
 302         /* XXX This may slow down your VAIO if ACPI is not supported in the kernel.
 303         outb(0xb2, 0xf0);
 304          */
 305
 306         device_printf(dev,"device model type = %d\n", sc->sc_model);
 307
 308         if(sc->sc_model == SPIC_DEVICE_MODEL_TYPE1) {
 309                 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10A,
 310                                 sc->sc_port_addr, 2);
 311                 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
 312                 t &= 0xf0;
 313                 t |= 4;
 314                 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
 315                 outw(SPIC_IRQ_PORT, (inw(SPIC_IRQ_PORT) & ~(0x3 << SPIC_IRQ_SHIFT)) | (spic_irq << SPIC_IRQ_SHIFT));
 316                 t = pci_cfgregread(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, 1);
 317                 t &= 0x1f;
 318                 t |= 0xc0;
 319                 pci_cfgregwrite(PIIX4_BUS, PIIX4_SLOT, PIIX4_FUNC, G10L, t, 1);
 320         } else {
 321                 spic_type2_srs(sc);
 322         }
 323
 324         /*
 325          * XXX: Should try and see if there's anything actually there.
 326          */
 327
 328         device_set_desc(dev, "Sony Programmable I/O Controller");
 329
 330         return 0;
 331 }
 332
 333 static int
 334 spic_attach(device_t dev)
 335 {
 336         struct spic_softc *sc;
 337
 338         sc = device_get_softc(dev);
 339
 340         sc->sc_dev = dev;
 341         callout_init(&sc->sc_timeout_ch);
 342
 343         spic_pollrate = (hz/50); /* Every 50th of a second */
 344
 345         spic_call1(sc, 0x82);
 346         spic_call2(sc, 0x81, 0xff);
 347         spic_call1(sc, 0x92);
 348
 349         /* There can be only one */
 350         dev_ops_add(&spic_ops, -1, device_get_unit(dev));
 351         make_dev(&spic_ops, device_get_unit(dev), 0, 0, 0600, "jogdial");
 352
 353         return 0;
 354 }
 355
 356 static void
 357 spictimeout(void *arg)
 358 {
 359         struct spic_softc *sc = arg;
 360         u_char b, event, param;
 361         int j;
 362
 363         if (!sc->sc_opened) {
 364                 device_printf(sc->sc_dev, "timeout called while closed!\n");
 365                 return;
 366         }
 367
 368         event = read_port2(sc);
 369         param = read_port1(sc);
 370
 371         if ((event != 4) && (!(event & 0x1)))
 372                 switch(event) {
 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++] =
 379                                                         b?'d':'u';
 380                                         }
 381                                         j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
 382                                         if (j<0)
 383                                                 while(j++!=0) {
 384                                                         sc->sc_buf[sc->sc_count++] =
 385                                                                 'l';
 386                                                 }
 387                                         else if (j>0)
 388                                                 while(j--!=0) {
 389                                                         sc->sc_buf[sc->sc_count++] =
 390                                                                 'r';
 391                                                 }
 392                                 }
 393                                 break;
 394                         case 0x08: /* jog wheel event (type2) */
 395                         case 0x00:
 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++] =
 402                                                         b?'d':'u';
 403                                         }
 404                                         j = (param & 0xf) | ((param & 0x10)? ~0xf:0);
 405                                         if (j<0)
 406                                                 while(j++!=0) {
 407                                                         sc->sc_buf[sc->sc_count++] =
 408                                                                 'l';
 409                                                 }
 410                                         else if (j>0)
 411                                                 while(j--!=0) {
 412                                                         sc->sc_buf[sc->sc_count++] =
 413                                                                 'r';
 414                                                 }
 415                                 }
 416                                 break;
 417                         case 0x60: /* Capture button */
 418                                 printf("Capture button event: %x\n",param);
 419                                 break;
 420                         case 0x30: /* Lid switch */
 421                                 printf("Lid switch event: %x\n",param);
 422                                 break;
 423                         default:
 424                                 printf("Unknown event: event %02x param %02x\n", event, param);
 425                                 break;
 426                 }
 427         else {
 428                 /* No event. Wait some more */
 429                 callout_reset(&sc->sc_timeout_ch, spic_pollrate,
 430                                 spictimeout, sc);
 431                 return;
 432         }
 433
 434         if (sc->sc_count) {
 435                 if (sc->sc_sleeping) {
 436                         sc->sc_sleeping = 0;
 437                         wakeup((caddr_t) sc);
 438                 }
 439                 selwakeup(&sc->sc_rsel);
 440         }
 441         spic_call2(sc, 0x81, 0xff); /* Clear event */
 442
 443         callout_reset(&sc->sc_timeout_ch, spic_pollrate, spictimeout, sc);
 444 }
 445
 446 static int
 447 spicopen(struct dev_open_args *ap)
 448 {
 449         struct spic_softc *sc;
 450
 451         sc = devclass_get_softc(spic_devclass, 0);
 452
 453         if (sc->sc_opened)
 454                 return EBUSY;
 455
 456         sc->sc_opened++;
 457         sc->sc_count=0;
 458
 459         /* Start the polling */
 460         callout_reset(&sc->sc_timeout_ch, spic_pollrate, spictimeout, sc);
 461         return 0;
 462 }
 463
 464 static int
 465 spicclose(struct dev_close_args *ap)
 466 {
 467         struct spic_softc *sc;
 468
 469         sc = devclass_get_softc(spic_devclass, 0);
 470
 471         /* Stop polling */
 472         callout_stop(&sc->sc_timeout_ch);
 473         sc->sc_opened = 0;
 474         return 0;
 475 }
 476
 477 static int
 478 spicread(struct dev_read_args *ap)
 479 {
 480         struct uio *uio = ap->a_uio;
 481         struct spic_softc *sc;
 482         int l, error;
 483         u_char buf[SCBUFLEN];
 484
 485         sc = devclass_get_softc(spic_devclass, 0);
 486
 487         if (uio->uio_resid <= 0) /* What kind of a read is this?! */
 488                 return 0;
 489
 490         crit_enter();
 491         while (!(sc->sc_count)) {
 492                 sc->sc_sleeping=1;
 493                 error = tsleep((caddr_t) sc, PCATCH, "jogrea", 0);
 494                 sc->sc_sleeping=0;
 495                 if (error) {
 496                         crit_exit();
 497                         return error;
 498                 }
 499         }
 500         crit_exit();
 501
 502         crit_enter();
 503         l = min(uio->uio_resid, sc->sc_count);
 504         bcopy(sc->sc_buf, buf, l);
 505         sc->sc_count -= l;
 506         bcopy(sc->sc_buf + l, sc->sc_buf, l);
 507         crit_exit();
 508         return uiomove(buf, l, uio);
 509
 510 }
 511
 512 static int
 513 spicioctl(struct dev_ioctl_args *ap)
 514 {
 515         struct spic_softc *sc;
 516
 517         sc = devclass_get_softc(spic_devclass, 0);
 518
 519         return EIO;
 520 }
 521
 522 static int
 523 spicpoll(struct dev_poll_args *ap)
 524 {
 525         struct spic_softc *sc;
 526         int revents = 0;
 527
 528         sc = devclass_get_softc(spic_devclass, 0);
 529         crit_enter();
 530         if (ap->a_events & (POLLIN | POLLRDNORM)) {
 531                 if (sc->sc_count) {
 532                         revents |= ap->a_events & (POLLIN | POLLRDNORM);
 533                 } else {
 534                         selrecord(curthread, &sc->sc_rsel);
 535                 }
 536         }
 537         crit_exit();
 538         ap->a_events = revents;
 539         return(0);
 540 }
 541
 542
 543 static device_method_t spic_methods[] = {
 544         DEVMETHOD(device_probe,         spic_probe),
 545         DEVMETHOD(device_attach,        spic_attach),
 546
 547         { 0, 0 }
 548 };
 549
 550 static driver_t spic_driver = {
 551         "spic",
 552         spic_methods,
 553         sizeof(struct spic_softc),
 554 };
 555
 556 DRIVER_MODULE(spic, isa, spic_driver, spic_devclass, 0, 0);
 557