sys/dev/usbmisc/ums/ums.c

   1 /*
   2  * $FreeBSD: src/sys/dev/usb/ums.c,v 1.64 2003/11/09 09:17:22 tanimura Exp $
   3  * $DragonFly: src/sys/dev/usbmisc/ums/ums.c,v 1.31 2008/08/14 20:55:54 hasso Exp $
   4  */
   5
   6 /*
   7  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   8  * All rights reserved.
   9  *
  10  * This code is derived from software contributed to The NetBSD Foundation
  11  * by Lennart Augustsson (lennart@augustsson.net) at
  12  * Carlstedt Research & Technology.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  * 3. All advertising materials mentioning features or use of this software
  23  *    must display the following acknowledgement:
  24  *        This product includes software developed by the NetBSD
  25  *        Foundation, Inc. and its contributors.
  26  * 4. Neither the name of The NetBSD Foundation nor the names of its
  27  *    contributors may be used to endorse or promote products derived
  28  *    from this software without specific prior written permission.
  29  *
  30  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  31  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  32  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  33  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  34  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40  * POSSIBILITY OF SUCH DAMAGE.
  41  */
  42
  43 /*
  44  * HID spec: http://www.usb.org/developers/data/devclass/hid1_1.pdf
  45  */
  46
  47 #include <sys/param.h>
  48 #include <sys/systm.h>
  49 #include <sys/kernel.h>
  50 #include <sys/malloc.h>
  51 #include <sys/module.h>
  52 #include <sys/bus.h>
  53 #include <sys/ioccom.h>
  54 #include <sys/conf.h>
  55 #include <sys/tty.h>
  56 #include <sys/file.h>
  57 #include <sys/select.h>
  58 #include <sys/vnode.h>
  59 #include <sys/poll.h>
  60 #include <sys/sysctl.h>
  61 #include <sys/thread2.h>
  62
  63 #include <bus/usb/usb.h>
  64 #include <bus/usb/usbhid.h>
  65
  66 #include <bus/usb/usbdi.h>
  67 #include <bus/usb/usbdi_util.h>
  68 #include <bus/usb/usb_quirks.h>
  69 #include <bus/usb/hid.h>
  70
  71 #include <machine/mouse.h>
  72
  73 #ifdef USB_DEBUG
  74 #define DPRINTF(x)      if (umsdebug) kprintf x
  75 #define DPRINTFN(n,x)   if (umsdebug>(n)) kprintf x
  76 int     umsdebug = 0;
  77 SYSCTL_NODE(_hw_usb, OID_AUTO, ums, CTLFLAG_RW, 0, "USB ums");
  78 SYSCTL_INT(_hw_usb_ums, OID_AUTO, debug, CTLFLAG_RW,
  79            &umsdebug, 0, "ums debug level");
  80 #else
  81 #define DPRINTF(x)
  82 #define DPRINTFN(n,x)
  83 #endif
  84
  85 #define UMSUNIT(s)      (minor(s)&0x1f)
  86
  87 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
  88
  89 #define QUEUE_BUFSIZE   400     /* MUST be divisible by 5 _and_ 8 */
  90
  91 struct ums_softc {
  92         device_t sc_dev;                /* base device */
  93         usbd_interface_handle sc_iface; /* interface */
  94         usbd_pipe_handle sc_intrpipe;   /* interrupt pipe */
  95         int sc_ep_addr;
  96
  97         u_char *sc_ibuf;
  98         u_int8_t sc_iid;
  99         int sc_isize;
 100         struct hid_location sc_loc_x, sc_loc_y, sc_loc_z;
 101         struct hid_location *sc_loc_btn;
 102
 103         struct callout sc_timeout;      /* for spurious button ups */
 104
 105         int sc_enabled;
 106         int sc_disconnected;    /* device is gone */
 107
 108         int flags;              /* device configuration */
 109 #define UMS_Z           0x01    /* z direction available */
 110 #define UMS_SPUR_BUT_UP 0x02    /* spurious button up events */
 111         int nbuttons;
 112 #define MAX_BUTTONS     31      /* must not exceed size of sc_buttons */
 113
 114         u_char          qbuf[QUEUE_BUFSIZE];    /* must be divisable by 3&4 */
 115         u_char          dummy[100];     /* XXX just for safety and for now */
 116         int             qcount, qhead, qtail;
 117         mousehw_t       hw;
 118         mousemode_t     mode;
 119         mousestatus_t   status;
 120
 121         int             state;
 122 #         define        UMS_ASLEEP      0x01    /* readFromDevice is waiting */
 123 #         define        UMS_SELECT      0x02    /* select is waiting */
 124         struct selinfo  rsel;           /* process waiting in select */
 125 };
 126
 127 #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
 128 #define MOUSE_FLAGS (HIO_RELATIVE)
 129
 130 static void ums_intr(usbd_xfer_handle xfer,
 131                           usbd_private_handle priv, usbd_status status);
 132
 133 static void ums_add_to_queue(struct ums_softc *sc,
 134                                 int dx, int dy, int dz, int buttons);
 135 static void ums_add_to_queue_timeout(void *priv);
 136
 137 static int  ums_enable(void *);
 138 static void ums_disable(void *);
 139
 140 static d_open_t  ums_open;
 141 static d_close_t ums_close;
 142 static d_read_t  ums_read;
 143 static d_ioctl_t ums_ioctl;
 144 static d_poll_t  ums_poll;
 145
 146 #define UMS_CDEV_MAJOR  111
 147
 148 static struct dev_ops ums_ops = {
 149         { "ums", UMS_CDEV_MAJOR, 0 },
 150         .d_open =       ums_open,
 151         .d_close =      ums_close,
 152         .d_read =       ums_read,
 153         .d_ioctl =      ums_ioctl,
 154         .d_poll =       ums_poll,
 155 };
 156
 157 static device_probe_t ums_match;
 158 static device_attach_t ums_attach;
 159 static device_detach_t ums_detach;
 160
 161 static devclass_t ums_devclass;
 162
 163 static kobj_method_t ums_methods[] = {
 164         DEVMETHOD(device_probe, ums_match),
 165         DEVMETHOD(device_attach, ums_attach),
 166         DEVMETHOD(device_detach, ums_detach),
 167         {0,0}
 168 };
 169
 170 static driver_t ums_driver = {
 171         "ums",
 172         ums_methods,
 173         sizeof(struct ums_softc)
 174 };
 175
 176 MODULE_DEPEND(ums, usb, 1, 1, 1);
 177
 178 static int
 179 ums_match(device_t self)
 180 {
 181         struct usb_attach_arg *uaa = device_get_ivars(self);
 182         usb_interface_descriptor_t *id;
 183         int size, ret;
 184         void *desc;
 185         usbd_status err;
 186
 187         if (!uaa->iface)
 188                 return (UMATCH_NONE);
 189         id = usbd_get_interface_descriptor(uaa->iface);
 190         if (!id || id->bInterfaceClass != UICLASS_HID)
 191                 return (UMATCH_NONE);
 192
 193         err = usbd_read_report_desc(uaa->iface, &desc, &size, M_TEMP);
 194         if (err)
 195                 return (UMATCH_NONE);
 196
 197         if (hid_is_collection(desc, size,
 198                               HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
 199                 ret = UMATCH_IFACECLASS;
 200         else
 201                 ret = UMATCH_NONE;
 202
 203         kfree(desc, M_TEMP);
 204         return (ret);
 205 }
 206
 207 static int
 208 ums_attach(device_t self)
 209 {
 210         struct ums_softc *sc = device_get_softc(self);
 211         struct usb_attach_arg *uaa = device_get_ivars(self);
 212         usbd_interface_handle iface = uaa->iface;
 213         usb_endpoint_descriptor_t *ed;
 214         int size;
 215         void *desc;
 216         usbd_status err;
 217         u_int32_t flags;
 218         int i;
 219         struct hid_location loc_btn;
 220
 221         sc->sc_disconnected = 1;
 222         sc->sc_iface = iface;
 223         sc->sc_dev = self;
 224         ed = usbd_interface2endpoint_descriptor(iface, 0);
 225         if (!ed) {
 226                 kprintf("%s: could not read endpoint descriptor\n",
 227                        device_get_nameunit(sc->sc_dev));
 228                 return ENXIO;
 229         }
 230
 231         DPRINTFN(10,("ums_attach: bLength=%d bDescriptorType=%d "
 232                      "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
 233                      " bInterval=%d\n",
 234                      ed->bLength, ed->bDescriptorType,
 235                      UE_GET_ADDR(ed->bEndpointAddress),
 236                      UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN ? "in":"out",
 237                      UE_GET_XFERTYPE(ed->bmAttributes),
 238                      UGETW(ed->wMaxPacketSize), ed->bInterval));
 239
 240         if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
 241             UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) {
 242                 kprintf("%s: unexpected endpoint\n",
 243                        device_get_nameunit(sc->sc_dev));
 244                 return ENXIO;
 245         }
 246
 247         err = usbd_read_report_desc(uaa->iface, &desc, &size, M_TEMP);
 248         if (err)
 249                 return ENXIO;
 250
 251         if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
 252                        hid_input, &sc->sc_loc_x, &flags)) {
 253                 kprintf("%s: mouse has no X report\n", device_get_nameunit(sc->sc_dev));
 254                 return ENXIO;
 255         }
 256         if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
 257                 kprintf("%s: X report 0x%04x not supported\n",
 258                        device_get_nameunit(sc->sc_dev), flags);
 259                 return ENXIO;
 260         }
 261
 262         if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
 263                        hid_input, &sc->sc_loc_y, &flags)) {
 264                 kprintf("%s: mouse has no Y report\n", device_get_nameunit(sc->sc_dev));
 265                 return ENXIO;
 266         }
 267         if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
 268                 kprintf("%s: Y report 0x%04x not supported\n",
 269                        device_get_nameunit(sc->sc_dev), flags);
 270                 return ENXIO;
 271         }
 272
 273         /* try to guess the Z activator: first check Z, then WHEEL */
 274         if (hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Z),
 275                        hid_input, &sc->sc_loc_z, &flags) ||
 276             hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_WHEEL),
 277                        hid_input, &sc->sc_loc_z, &flags)) {
 278                 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
 279                         sc->sc_loc_z.size = 0;  /* Bad Z coord, ignore it */
 280                 } else {
 281                         sc->flags |= UMS_Z;
 282                 }
 283         }
 284
 285         /* figure out the number of buttons */
 286         for (i = 1; i <= MAX_BUTTONS; i++)
 287                 if (!hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
 288                                 hid_input, &loc_btn, 0))
 289                         break;
 290         sc->nbuttons = i - 1;
 291         sc->sc_loc_btn = kmalloc(sizeof(struct hid_location)*sc->nbuttons,
 292                                 M_USBDEV, M_INTWAIT);
 293
 294         kprintf("%s: %d buttons%s\n", device_get_nameunit(sc->sc_dev),
 295                sc->nbuttons, sc->flags & UMS_Z? " and Z dir." : "");
 296
 297         for (i = 1; i <= sc->nbuttons; i++)
 298                 hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
 299                                 hid_input, &sc->sc_loc_btn[i-1], 0);
 300
 301         sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
 302         sc->sc_ibuf = kmalloc(sc->sc_isize, M_USB, M_INTWAIT);
 303         sc->sc_ep_addr = ed->bEndpointAddress;
 304         sc->sc_disconnected = 0;
 305         kfree(desc, M_TEMP);
 306
 307 #ifdef USB_DEBUG
 308         DPRINTF(("ums_attach: sc=%p\n", sc));
 309         DPRINTF(("ums_attach: X\t%d/%d\n",
 310                  sc->sc_loc_x.pos, sc->sc_loc_x.size));
 311         DPRINTF(("ums_attach: Y\t%d/%d\n",
 312                  sc->sc_loc_y.pos, sc->sc_loc_y.size));
 313         if (sc->flags & UMS_Z)
 314                 DPRINTF(("ums_attach: Z\t%d/%d\n",
 315                          sc->sc_loc_z.pos, sc->sc_loc_z.size));
 316         for (i = 1; i <= sc->nbuttons; i++) {
 317                 DPRINTF(("ums_attach: B%d\t%d/%d\n",
 318                          i, sc->sc_loc_btn[i-1].pos,sc->sc_loc_btn[i-1].size));
 319         }
 320         DPRINTF(("ums_attach: size=%d, id=%d\n", sc->sc_isize, sc->sc_iid));
 321 #endif
 322
 323         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
 324                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
 325         else
 326                 sc->hw.buttons = sc->nbuttons;
 327         sc->hw.iftype = MOUSE_IF_USB;
 328         sc->hw.type = MOUSE_MOUSE;
 329         sc->hw.model = MOUSE_MODEL_GENERIC;
 330         sc->hw.hwid = 0;
 331         sc->mode.protocol = MOUSE_PROTO_MSC;
 332         sc->mode.rate = -1;
 333         sc->mode.resolution = MOUSE_RES_UNKNOWN;
 334         sc->mode.accelfactor = 0;
 335         sc->mode.level = 0;
 336         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
 337         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 338         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
 339
 340         sc->status.flags = 0;
 341         sc->status.button = sc->status.obutton = 0;
 342         sc->status.dx = sc->status.dy = sc->status.dz = 0;
 343
 344         dev_ops_add(&ums_ops, -1, device_get_unit(self));
 345         make_dev(&ums_ops, device_get_unit(self),
 346                 UID_ROOT, GID_OPERATOR,
 347                 0644, "ums%d", device_get_unit(self));
 348
 349         if (usbd_get_quirks(uaa->device)->uq_flags & UQ_SPUR_BUT_UP) {
 350                 DPRINTF(("%s: Spurious button up events\n",
 351                         device_get_nameunit(sc->sc_dev)));
 352                 sc->flags |= UMS_SPUR_BUT_UP;
 353         }
 354
 355         return 0;
 356 }
 357
 358
 359 static int
 360 ums_detach(device_t self)
 361 {
 362         struct ums_softc *sc = device_get_softc(self);
 363
 364         if (sc->sc_enabled)
 365                 ums_disable(sc);
 366
 367         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
 368
 369         kfree(sc->sc_loc_btn, M_USB);
 370         kfree(sc->sc_ibuf, M_USB);
 371
 372         /* someone waiting for data */
 373         /*
 374          * XXX If we wakeup the process here, the device will be gone by
 375          * the time the process gets a chance to notice. *_close and friends
 376          * should be fixed to handle this case.
 377          * Or we should do a delayed detach for this.
 378          * Does this delay now force tsleep to exit with an error?
 379          */
 380         if (sc->state & UMS_ASLEEP) {
 381                 sc->state &= ~UMS_ASLEEP;
 382                 wakeup(sc);
 383         }
 384         if (sc->state & UMS_SELECT) {
 385                 sc->state &= ~UMS_SELECT;
 386                 selwakeup(&sc->rsel);
 387         }
 388         dev_ops_remove(&ums_ops, -1, device_get_unit(self));
 389
 390         return 0;
 391 }
 392
 393 void
 394 ums_intr(usbd_xfer_handle xfer, usbd_private_handle addr,
 395          usbd_status status)
 396 {
 397         struct ums_softc *sc = addr;
 398         u_char *ibuf;
 399         int dx, dy, dz;
 400         u_char buttons = 0;
 401         int i;
 402
 403 #define UMS_BUT(i) ((i) < 3 ? (((i) + 2) % 3) : (i))
 404
 405         DPRINTFN(5, ("ums_intr: sc=%p status=%d\n", sc, status));
 406         DPRINTFN(5, ("ums_intr: data = %02x %02x %02x\n",
 407                      sc->sc_ibuf[0], sc->sc_ibuf[1], sc->sc_ibuf[2]));
 408
 409         if (status == USBD_CANCELLED)
 410                 return;
 411
 412         if (status != USBD_NORMAL_COMPLETION) {
 413                 DPRINTF(("ums_intr: status=%d\n", status));
 414                 if (status == USBD_STALLED)
 415                     usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
 416                 return;
 417         }
 418
 419         ibuf = sc->sc_ibuf;
 420         if (sc->sc_iid) {
 421                 if (*ibuf++ != sc->sc_iid)
 422                         return;
 423         }
 424
 425         dx =  hid_get_data(ibuf, &sc->sc_loc_x);
 426         dy = -hid_get_data(ibuf, &sc->sc_loc_y);
 427         dz = -hid_get_data(ibuf, &sc->sc_loc_z);
 428         for (i = 0; i < sc->nbuttons; i++)
 429                 if (hid_get_data(ibuf, &sc->sc_loc_btn[i]))
 430                         buttons |= (1 << UMS_BUT(i));
 431
 432         if (dx || dy || dz || (sc->flags & UMS_Z)
 433             || buttons != sc->status.button) {
 434                 DPRINTFN(5, ("ums_intr: x:%d y:%d z:%d buttons:0x%x\n",
 435                         dx, dy, dz, buttons));
 436
 437                 sc->status.button = buttons;
 438                 sc->status.dx += dx;
 439                 sc->status.dy += dy;
 440                 sc->status.dz += dz;
 441
 442                 /* Discard data in case of full buffer */
 443                 if (sc->qcount == sizeof(sc->qbuf)) {
 444                         DPRINTF(("Buffer full, discarded packet"));
 445                         return;
 446                 }
 447
 448                 /*
 449                  * The Qtronix keyboard has a built in PS/2 port for a mouse.
 450                  * The firmware once in a while posts a spurious button up
 451                  * event. This event we ignore by doing a timeout for 50 msecs.
 452                  * If we receive dx=dy=dz=buttons=0 before we add the event to
 453                  * the queue.
 454                  * In any other case we delete the timeout event.
 455                  */
 456                 if (sc->flags & UMS_SPUR_BUT_UP &&
 457                     dx == 0 && dy == 0 && dz == 0 && buttons == 0) {
 458                         callout_reset(&sc->sc_timeout, MS_TO_TICKS(50),
 459                                     ums_add_to_queue_timeout, (void *) sc);
 460                 } else {
 461                         callout_stop(&sc->sc_timeout);
 462                         ums_add_to_queue(sc, dx, dy, dz, buttons);
 463                 }
 464         }
 465 }
 466
 467 static void
 468 ums_add_to_queue_timeout(void *priv)
 469 {
 470         struct ums_softc *sc = priv;
 471
 472         crit_enter();
 473         ums_add_to_queue(sc, 0, 0, 0, 0);
 474         crit_exit();
 475 }
 476
 477 static void
 478 ums_add_to_queue(struct ums_softc *sc, int dx, int dy, int dz, int buttons)
 479 {
 480         /* Discard data in case of full buffer */
 481         if (sc->qhead+sc->mode.packetsize > sizeof(sc->qbuf)) {
 482                 DPRINTF(("Buffer full, discarded packet"));
 483                 return;
 484         }
 485
 486         if (dx >  254)          dx =  254;
 487         if (dx < -256)          dx = -256;
 488         if (dy >  254)          dy =  254;
 489         if (dy < -256)          dy = -256;
 490         if (dz >  126)          dz =  126;
 491         if (dz < -128)          dz = -128;
 492
 493         sc->qbuf[sc->qhead] = sc->mode.syncmask[1];
 494         sc->qbuf[sc->qhead] |= ~buttons & MOUSE_MSC_BUTTONS;
 495         sc->qbuf[sc->qhead+1] = dx >> 1;
 496         sc->qbuf[sc->qhead+2] = dy >> 1;
 497         sc->qbuf[sc->qhead+3] = dx - (dx >> 1);
 498         sc->qbuf[sc->qhead+4] = dy - (dy >> 1);
 499
 500         if (sc->mode.level == 1) {
 501                 sc->qbuf[sc->qhead+5] = dz >> 1;
 502                 sc->qbuf[sc->qhead+6] = dz - (dz >> 1);
 503                 sc->qbuf[sc->qhead+7] = ((~buttons >> 3)
 504                                          & MOUSE_SYS_EXTBUTTONS);
 505         }
 506
 507         sc->qhead += sc->mode.packetsize;
 508         sc->qcount += sc->mode.packetsize;
 509         /* wrap round at end of buffer */
 510         if (sc->qhead >= sizeof(sc->qbuf))
 511                 sc->qhead = 0;
 512
 513         /* someone waiting for data */
 514         if (sc->state & UMS_ASLEEP) {
 515                 sc->state &= ~UMS_ASLEEP;
 516                 wakeup(sc);
 517         }
 518         if (sc->state & UMS_SELECT) {
 519                 sc->state &= ~UMS_SELECT;
 520                 selwakeup(&sc->rsel);
 521         }
 522 }
 523
 524 static int
 525 ums_enable(void *v)
 526 {
 527         struct ums_softc *sc = v;
 528
 529         usbd_status err;
 530
 531         if (sc->sc_enabled)
 532                 return EBUSY;
 533
 534         sc->sc_enabled = 1;
 535         sc->qcount = 0;
 536         sc->qhead = sc->qtail = 0;
 537         sc->status.flags = 0;
 538         sc->status.button = sc->status.obutton = 0;
 539         sc->status.dx = sc->status.dy = sc->status.dz = 0;
 540
 541         callout_init(&sc->sc_timeout);
 542
 543         /* Set up interrupt pipe. */
 544         err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
 545                                 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
 546                                 sc->sc_ibuf, sc->sc_isize, ums_intr,
 547                                 USBD_DEFAULT_INTERVAL);
 548         if (err) {
 549                 DPRINTF(("ums_enable: usbd_open_pipe_intr failed, error=%d\n",
 550                          err));
 551                 sc->sc_enabled = 0;
 552                 return (EIO);
 553         }
 554         return (0);
 555 }
 556
 557 static void
 558 ums_disable(void *priv)
 559 {
 560         struct ums_softc *sc = priv;
 561
 562         callout_stop(&sc->sc_timeout);
 563
 564         /* Disable interrupts. */
 565         usbd_abort_pipe(sc->sc_intrpipe);
 566         usbd_close_pipe(sc->sc_intrpipe);
 567
 568         sc->sc_enabled = 0;
 569
 570         if (sc->qcount != 0)
 571                 DPRINTF(("Discarded %d bytes in queue\n", sc->qcount));
 572 }
 573
 574 static int
 575 ums_open(struct dev_open_args *ap)
 576 {
 577         cdev_t dev = ap->a_head.a_dev;
 578         struct ums_softc *sc;
 579
 580         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 581         if (sc == NULL)
 582                 return (ENXIO);
 583
 584         return ums_enable(sc);
 585 }
 586
 587 static int
 588 ums_close(struct dev_close_args *ap)
 589 {
 590         cdev_t dev = ap->a_head.a_dev;
 591         struct ums_softc *sc;
 592
 593         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 594
 595         if (!sc)
 596                 return 0;
 597
 598         if (sc->sc_enabled)
 599                 ums_disable(sc);
 600
 601         return 0;
 602 }
 603
 604 static int
 605 ums_read(struct dev_read_args *ap)
 606 {
 607         cdev_t dev = ap->a_head.a_dev;
 608         struct uio *uio = ap->a_uio;
 609         struct ums_softc *sc;
 610         char buf[sizeof(sc->qbuf)];
 611         int l = 0;
 612         int error;
 613
 614         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 615
 616         crit_enter();
 617         if (!sc) {
 618                 crit_exit();
 619                 return EIO;
 620         }
 621
 622         while (sc->qcount == 0 )  {
 623                 if (ap->a_ioflag & IO_NDELAY) {         /* non-blocking I/O */
 624                         crit_exit();
 625                         return EWOULDBLOCK;
 626                 }
 627
 628                 sc->state |= UMS_ASLEEP;        /* blocking I/O */
 629                 error = tsleep(sc, PCATCH, "umsrea", 0);
 630                 if (error) {
 631                         crit_exit();
 632                         return error;
 633                 } else if (!sc->sc_enabled) {
 634                         crit_exit();
 635                         return EINTR;
 636                 }
 637                 /* check whether the device is still there */
 638
 639                 sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 640                 if (!sc) {
 641                         crit_exit();
 642                         return EIO;
 643                 }
 644         }
 645
 646         /*
 647          * The writer process only extends qcount and qtail. We could copy
 648          * them and use the copies to do the copying out of the queue.
 649          */
 650
 651         while ((sc->qcount > 0) && (uio->uio_resid > 0)) {
 652                 l = (sc->qcount < uio->uio_resid? sc->qcount:uio->uio_resid);
 653                 if (l > sizeof(buf))
 654                         l = sizeof(buf);
 655                 if (l > sizeof(sc->qbuf) - sc->qtail)           /* transfer till end of buf */
 656                         l = sizeof(sc->qbuf) - sc->qtail;
 657
 658                 crit_exit();
 659                 uiomove(&sc->qbuf[sc->qtail], l, uio);
 660                 crit_enter();
 661
 662                 if ( sc->qcount - l < 0 ) {
 663                         DPRINTF(("qcount below 0, count=%d l=%d\n", sc->qcount, l));
 664                         sc->qcount = l;
 665                 }
 666                 sc->qcount -= l;        /* remove the bytes from the buffer */
 667                 sc->qtail = (sc->qtail + l) % sizeof(sc->qbuf);
 668         }
 669         crit_exit();
 670
 671         return 0;
 672 }
 673
 674 static int
 675 ums_poll(struct dev_poll_args *ap)
 676 {
 677         cdev_t dev = ap->a_head.a_dev;
 678         struct ums_softc *sc;
 679         int revents = 0;
 680
 681         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 682
 683         if (!sc) {
 684                 ap->a_events = 0;
 685                 return 0;
 686         }
 687
 688         crit_enter();
 689         if (ap->a_events & (POLLIN | POLLRDNORM)) {
 690                 if (sc->qcount) {
 691                         revents = ap->a_events & (POLLIN | POLLRDNORM);
 692                 } else {
 693                         sc->state |= UMS_SELECT;
 694                         selrecord(curthread, &sc->rsel);
 695                 }
 696         }
 697         crit_exit();
 698         ap->a_events = revents;
 699         return (0);
 700 }
 701
 702 int
 703 ums_ioctl(struct dev_ioctl_args *ap)
 704 {
 705         cdev_t dev = ap->a_head.a_dev;
 706         struct ums_softc *sc;
 707         int error = 0;
 708         mousemode_t mode;
 709
 710         sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 711
 712         if (!sc)
 713                 return EIO;
 714
 715         switch(ap->a_cmd) {
 716         case MOUSE_GETHWINFO:
 717                 *(mousehw_t *)ap->a_data = sc->hw;
 718                 break;
 719         case MOUSE_GETMODE:
 720                 *(mousemode_t *)ap->a_data = sc->mode;
 721                 break;
 722         case MOUSE_SETMODE:
 723                 mode = *(mousemode_t *)ap->a_data;
 724
 725                 if (mode.level == -1)
 726                         /* don't change the current setting */
 727                         ;
 728                 else if ((mode.level < 0) || (mode.level > 1))
 729                         return (EINVAL);
 730
 731                 crit_enter();
 732                 sc->mode.level = mode.level;
 733
 734                 if (sc->mode.level == 0) {
 735                         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
 736                                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
 737                         else
 738                                 sc->hw.buttons = sc->nbuttons;
 739                         sc->mode.protocol = MOUSE_PROTO_MSC;
 740                         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
 741                         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 742                         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
 743                 } else if (sc->mode.level == 1) {
 744                         if (sc->nbuttons > MOUSE_SYS_MAXBUTTON)
 745                                 sc->hw.buttons = MOUSE_SYS_MAXBUTTON;
 746                         else
 747                                 sc->hw.buttons = sc->nbuttons;
 748                         sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
 749                         sc->mode.packetsize = MOUSE_SYS_PACKETSIZE;
 750                         sc->mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 751                         sc->mode.syncmask[1] = MOUSE_SYS_SYNC;
 752                 }
 753
 754                 bzero(sc->qbuf, sizeof(sc->qbuf));
 755                 sc->qhead = sc->qtail = sc->qcount = 0;
 756                 crit_exit();
 757
 758                 break;
 759         case MOUSE_GETLEVEL:
 760                 *(int *)ap->a_data = sc->mode.level;
 761                 break;
 762         case MOUSE_SETLEVEL:
 763                 if (*(int *)ap->a_data < 0 || *(int *)ap->a_data > 1)
 764                         return (EINVAL);
 765
 766                 crit_enter();
 767                 sc->mode.level = *(int *)ap->a_data;
 768
 769                 if (sc->mode.level == 0) {
 770                         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
 771                                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
 772                         else
 773                                 sc->hw.buttons = sc->nbuttons;
 774                         sc->mode.protocol = MOUSE_PROTO_MSC;
 775                         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
 776                         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 777                         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
 778                 } else if (sc->mode.level == 1) {
 779                         if (sc->nbuttons > MOUSE_SYS_MAXBUTTON)
 780                                 sc->hw.buttons = MOUSE_SYS_MAXBUTTON;
 781                         else
 782                                 sc->hw.buttons = sc->nbuttons;
 783                         sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
 784                         sc->mode.packetsize = MOUSE_SYS_PACKETSIZE;
 785                         sc->mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 786                         sc->mode.syncmask[1] = MOUSE_SYS_SYNC;
 787                 }
 788
 789                 bzero(sc->qbuf, sizeof(sc->qbuf));
 790                 sc->qhead = sc->qtail = sc->qcount = 0;
 791                 crit_exit();
 792
 793                 break;
 794         case MOUSE_GETSTATUS: {
 795                 mousestatus_t *status = (mousestatus_t *) ap->a_data;
 796
 797                 crit_enter();
 798                 *status = sc->status;
 799                 sc->status.obutton = sc->status.button;
 800                 sc->status.button = 0;
 801                 sc->status.dx = sc->status.dy = sc->status.dz = 0;
 802                 crit_exit();
 803
 804                 if (status->dx || status->dy || status->dz)
 805                         status->flags |= MOUSE_POSCHANGED;
 806                 if (status->button != status->obutton)
 807                         status->flags |= MOUSE_BUTTONSCHANGED;
 808                 break;
 809                 }
 810         default:
 811                 error = ENOTTY;
 812         }
 813
 814         return error;
 815 }
 816
 817 DRIVER_MODULE(ums, uhub, ums_driver, ums_devclass, usbd_driver_load, 0);