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.13 2004/09/14 23:29:44 dillon 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 #if defined(__FreeBSD__) && __FreeBSD_version >= 500014
  58 #include <sys/selinfo.h>
  59 #else
  60 #include <sys/select.h>
  61 #endif
  62 #include <sys/vnode.h>
  63 #include <sys/poll.h>
  64 #include <sys/sysctl.h>
  65
  66 #include <bus/usb/usb.h>
  67 #include <bus/usb/usbhid.h>
  68
  69 #include <bus/usb/usbdi.h>
  70 #include <bus/usb/usbdi_util.h>
  71 #include <bus/usb/usbdevs.h>
  72 #include <bus/usb/usb_quirks.h>
  73 #include <bus/usb/hid.h>
  74
  75 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
  76 #include <sys/mouse.h>
  77 #else
  78 #include <machine/mouse.h>
  79 #endif
  80
  81 #ifdef USB_DEBUG
  82 #define DPRINTF(x)      if (umsdebug) logprintf x
  83 #define DPRINTFN(n,x)   if (umsdebug>(n)) logprintf x
  84 int     umsdebug = 0;
  85 SYSCTL_NODE(_hw_usb, OID_AUTO, ums, CTLFLAG_RW, 0, "USB ums");
  86 SYSCTL_INT(_hw_usb_ums, OID_AUTO, debug, CTLFLAG_RW,
  87            &umsdebug, 0, "ums debug level");
  88 #else
  89 #define DPRINTF(x)
  90 #define DPRINTFN(n,x)
  91 #endif
  92
  93 #define UMSUNIT(s)      (minor(s)&0x1f)
  94
  95 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
  96
  97 #define QUEUE_BUFSIZE   400     /* MUST be divisible by 5 _and_ 8 */
  98
  99 struct ums_softc {
 100         device_t sc_dev;                /* base device */
 101         usbd_interface_handle sc_iface; /* interface */
 102         usbd_pipe_handle sc_intrpipe;   /* interrupt pipe */
 103         int sc_ep_addr;
 104
 105         u_char *sc_ibuf;
 106         u_int8_t sc_iid;
 107         int sc_isize;
 108         struct hid_location sc_loc_x, sc_loc_y, sc_loc_z;
 109         struct hid_location *sc_loc_btn;
 110
 111         struct callout sc_timeout;      /* for spurious button ups */
 112
 113         int sc_enabled;
 114         int sc_disconnected;    /* device is gone */
 115
 116         int flags;              /* device configuration */
 117 #define UMS_Z           0x01    /* z direction available */
 118 #define UMS_SPUR_BUT_UP 0x02    /* spurious button up events */
 119         int nbuttons;
 120 #define MAX_BUTTONS     7       /* chosen because sc_buttons is u_char */
 121
 122         u_char          qbuf[QUEUE_BUFSIZE];    /* must be divisable by 3&4 */
 123         u_char          dummy[100];     /* XXX just for safety and for now */
 124         int             qcount, qhead, qtail;
 125         mousehw_t       hw;
 126         mousemode_t     mode;
 127         mousestatus_t   status;
 128
 129         int             state;
 130 #         define        UMS_ASLEEP      0x01    /* readFromDevice is waiting */
 131 #         define        UMS_SELECT      0x02    /* select is waiting */
 132         struct selinfo  rsel;           /* process waiting in select */
 133 };
 134
 135 #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
 136 #define MOUSE_FLAGS (HIO_RELATIVE)
 137
 138 Static void ums_intr(usbd_xfer_handle xfer,
 139                           usbd_private_handle priv, usbd_status status);
 140
 141 Static void ums_add_to_queue(struct ums_softc *sc,
 142                                 int dx, int dy, int dz, int buttons);
 143 Static void ums_add_to_queue_timeout(void *priv);
 144
 145 Static int  ums_enable(void *);
 146 Static void ums_disable(void *);
 147
 148 Static d_open_t  ums_open;
 149 Static d_close_t ums_close;
 150 Static d_read_t  ums_read;
 151 Static d_ioctl_t ums_ioctl;
 152 Static d_poll_t  ums_poll;
 153
 154 #define UMS_CDEV_MAJOR  111
 155
 156 Static struct cdevsw ums_cdevsw = {
 157         /* name */      "ums",
 158         /* maj */       UMS_CDEV_MAJOR,
 159         /* flags */     0,
 160         /* port */      NULL,
 161         /* clone */     NULL,
 162
 163         /* open */      ums_open,
 164         /* close */     ums_close,
 165         /* read */      ums_read,
 166         /* write */     nowrite,
 167         /* ioctl */     ums_ioctl,
 168         /* poll */      ums_poll,
 169         /* mmap */      nommap,
 170         /* strategy */  nostrategy,
 171         /* dump */      nodump,
 172         /* psize */     nopsize
 173 };
 174
 175 USB_DECLARE_DRIVER(ums);
 176
 177 USB_MATCH(ums)
 178 {
 179         USB_MATCH_START(ums, uaa);
 180         usb_interface_descriptor_t *id;
 181         int size, ret;
 182         void *desc;
 183         usbd_status err;
 184
 185         if (!uaa->iface)
 186                 return (UMATCH_NONE);
 187         id = usbd_get_interface_descriptor(uaa->iface);
 188         if (!id || id->bInterfaceClass != UICLASS_HID)
 189                 return (UMATCH_NONE);
 190
 191         err = usbd_read_report_desc(uaa->iface, &desc, &size, M_TEMP);
 192         if (err)
 193                 return (UMATCH_NONE);
 194
 195         if (hid_is_collection(desc, size,
 196                               HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
 197                 ret = UMATCH_IFACECLASS;
 198         else
 199                 ret = UMATCH_NONE;
 200
 201         free(desc, M_TEMP);
 202         return (ret);
 203 }
 204
 205 USB_ATTACH(ums)
 206 {
 207         USB_ATTACH_START(ums, sc, uaa);
 208         usbd_interface_handle iface = uaa->iface;
 209         usb_interface_descriptor_t *id;
 210         usb_endpoint_descriptor_t *ed;
 211         int size;
 212         void *desc;
 213         usbd_status err;
 214         char devinfo[1024];
 215         u_int32_t flags;
 216         int i;
 217         struct hid_location loc_btn;
 218
 219         sc->sc_disconnected = 1;
 220         sc->sc_iface = iface;
 221         id = usbd_get_interface_descriptor(iface);
 222         usbd_devinfo(uaa->device, 0, devinfo);
 223         USB_ATTACH_SETUP;
 224         printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
 225                devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
 226         ed = usbd_interface2endpoint_descriptor(iface, 0);
 227         if (!ed) {
 228                 printf("%s: could not read endpoint descriptor\n",
 229                        USBDEVNAME(sc->sc_dev));
 230                 USB_ATTACH_ERROR_RETURN;
 231         }
 232
 233         DPRINTFN(10,("ums_attach: bLength=%d bDescriptorType=%d "
 234                      "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
 235                      " bInterval=%d\n",
 236                      ed->bLength, ed->bDescriptorType,
 237                      UE_GET_ADDR(ed->bEndpointAddress),
 238                      UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN ? "in":"out",
 239                      UE_GET_XFERTYPE(ed->bmAttributes),
 240                      UGETW(ed->wMaxPacketSize), ed->bInterval));
 241
 242         if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
 243             UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) {
 244                 printf("%s: unexpected endpoint\n",
 245                        USBDEVNAME(sc->sc_dev));
 246                 USB_ATTACH_ERROR_RETURN;
 247         }
 248
 249         err = usbd_read_report_desc(uaa->iface, &desc, &size, M_TEMP);
 250         if (err)
 251                 USB_ATTACH_ERROR_RETURN;
 252
 253         if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
 254                        hid_input, &sc->sc_loc_x, &flags)) {
 255                 printf("%s: mouse has no X report\n", USBDEVNAME(sc->sc_dev));
 256                 USB_ATTACH_ERROR_RETURN;
 257         }
 258         if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
 259                 printf("%s: X report 0x%04x not supported\n",
 260                        USBDEVNAME(sc->sc_dev), flags);
 261                 USB_ATTACH_ERROR_RETURN;
 262         }
 263
 264         if (!hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
 265                        hid_input, &sc->sc_loc_y, &flags)) {
 266                 printf("%s: mouse has no Y report\n", USBDEVNAME(sc->sc_dev));
 267                 USB_ATTACH_ERROR_RETURN;
 268         }
 269         if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
 270                 printf("%s: Y report 0x%04x not supported\n",
 271                        USBDEVNAME(sc->sc_dev), flags);
 272                 USB_ATTACH_ERROR_RETURN;
 273         }
 274
 275         /* try to guess the Z activator: first check Z, then WHEEL */
 276         if (hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Z),
 277                        hid_input, &sc->sc_loc_z, &flags) ||
 278             hid_locate(desc, size, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_WHEEL),
 279                        hid_input, &sc->sc_loc_z, &flags)) {
 280                 if ((flags & MOUSE_FLAGS_MASK) != MOUSE_FLAGS) {
 281                         sc->sc_loc_z.size = 0;  /* Bad Z coord, ignore it */
 282                 } else {
 283                         sc->flags |= UMS_Z;
 284                 }
 285         }
 286
 287         /* figure out the number of buttons */
 288         for (i = 1; i <= MAX_BUTTONS; i++)
 289                 if (!hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
 290                                 hid_input, &loc_btn, 0))
 291                         break;
 292         sc->nbuttons = i - 1;
 293         sc->sc_loc_btn = malloc(sizeof(struct hid_location)*sc->nbuttons,
 294                                 M_USBDEV, M_INTWAIT);
 295
 296         printf("%s: %d buttons%s\n", USBDEVNAME(sc->sc_dev),
 297                sc->nbuttons, sc->flags & UMS_Z? " and Z dir." : "");
 298
 299         for (i = 1; i <= sc->nbuttons; i++)
 300                 hid_locate(desc, size, HID_USAGE2(HUP_BUTTON, i),
 301                                 hid_input, &sc->sc_loc_btn[i-1], 0);
 302
 303         sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
 304         sc->sc_ibuf = malloc(sc->sc_isize, M_USB, M_INTWAIT);
 305         sc->sc_ep_addr = ed->bEndpointAddress;
 306         sc->sc_disconnected = 0;
 307         free(desc, M_TEMP);
 308
 309 #ifdef USB_DEBUG
 310         DPRINTF(("ums_attach: sc=%p\n", sc));
 311         DPRINTF(("ums_attach: X\t%d/%d\n",
 312                  sc->sc_loc_x.pos, sc->sc_loc_x.size));
 313         DPRINTF(("ums_attach: Y\t%d/%d\n",
 314                  sc->sc_loc_y.pos, sc->sc_loc_y.size));
 315         if (sc->flags & UMS_Z)
 316                 DPRINTF(("ums_attach: Z\t%d/%d\n",
 317                          sc->sc_loc_z.pos, sc->sc_loc_z.size));
 318         for (i = 1; i <= sc->nbuttons; i++) {
 319                 DPRINTF(("ums_attach: B%d\t%d/%d\n",
 320                          i, sc->sc_loc_btn[i-1].pos,sc->sc_loc_btn[i-1].size));
 321         }
 322         DPRINTF(("ums_attach: size=%d, id=%d\n", sc->sc_isize, sc->sc_iid));
 323 #endif
 324
 325         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
 326                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
 327         else
 328                 sc->hw.buttons = sc->nbuttons;
 329         sc->hw.iftype = MOUSE_IF_USB;
 330         sc->hw.type = MOUSE_MOUSE;
 331         sc->hw.model = MOUSE_MODEL_GENERIC;
 332         sc->hw.hwid = 0;
 333         sc->mode.protocol = MOUSE_PROTO_MSC;
 334         sc->mode.rate = -1;
 335         sc->mode.resolution = MOUSE_RES_UNKNOWN;
 336         sc->mode.accelfactor = 0;
 337         sc->mode.level = 0;
 338         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
 339         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 340         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
 341
 342         sc->status.flags = 0;
 343         sc->status.button = sc->status.obutton = 0;
 344         sc->status.dx = sc->status.dy = sc->status.dz = 0;
 345
 346 #if !defined(__FreeBSD__) && !defined(__DragonFly__)
 347         sc->rsel.si_flags = 0;
 348         sc->rsel.si_pid = 0;
 349 #endif
 350         cdevsw_add(&ums_cdevsw, -1, device_get_unit(self));
 351         make_dev(&ums_cdevsw, device_get_unit(self),
 352                 UID_ROOT, GID_OPERATOR,
 353                 0644, "ums%d", device_get_unit(self));
 354
 355         if (usbd_get_quirks(uaa->device)->uq_flags & UQ_SPUR_BUT_UP) {
 356                 DPRINTF(("%s: Spurious button up events\n",
 357                         USBDEVNAME(sc->sc_dev)));
 358                 sc->flags |= UMS_SPUR_BUT_UP;
 359         }
 360
 361         USB_ATTACH_SUCCESS_RETURN;
 362 }
 363
 364
 365 Static int
 366 ums_detach(device_t self)
 367 {
 368         struct ums_softc *sc = device_get_softc(self);
 369
 370         if (sc->sc_enabled)
 371                 ums_disable(sc);
 372
 373         DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
 374
 375         free(sc->sc_loc_btn, M_USB);
 376         free(sc->sc_ibuf, M_USB);
 377
 378         /* someone waiting for data */
 379         /*
 380          * XXX If we wakeup the process here, the device will be gone by
 381          * the time the process gets a chance to notice. *_close and friends
 382          * should be fixed to handle this case.
 383          * Or we should do a delayed detach for this.
 384          * Does this delay now force tsleep to exit with an error?
 385          */
 386         if (sc->state & UMS_ASLEEP) {
 387                 sc->state &= ~UMS_ASLEEP;
 388                 wakeup(sc);
 389         }
 390         if (sc->state & UMS_SELECT) {
 391                 sc->state &= ~UMS_SELECT;
 392                 selwakeuppri(&sc->rsel, 0);
 393         }
 394         cdevsw_remove(&ums_cdevsw, -1, device_get_unit(self));
 395
 396         return 0;
 397 }
 398
 399 void
 400 ums_intr(xfer, addr, status)
 401         usbd_xfer_handle xfer;
 402         usbd_private_handle addr;
 403         usbd_status status;
 404 {
 405         struct ums_softc *sc = addr;
 406         u_char *ibuf;
 407         int dx, dy, dz;
 408         u_char buttons = 0;
 409         int i;
 410
 411 #define UMS_BUT(i) ((i) < 3 ? (((i) + 2) % 3) : (i))
 412
 413         DPRINTFN(5, ("ums_intr: sc=%p status=%d\n", sc, status));
 414         DPRINTFN(5, ("ums_intr: data = %02x %02x %02x\n",
 415                      sc->sc_ibuf[0], sc->sc_ibuf[1], sc->sc_ibuf[2]));
 416
 417         if (status == USBD_CANCELLED)
 418                 return;
 419
 420         if (status != USBD_NORMAL_COMPLETION) {
 421                 DPRINTF(("ums_intr: status=%d\n", status));
 422                 if (status == USBD_STALLED)
 423                     usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
 424                 return;
 425         }
 426
 427         ibuf = sc->sc_ibuf;
 428         if (sc->sc_iid) {
 429                 if (*ibuf++ != sc->sc_iid)
 430                         return;
 431         }
 432
 433         dx =  hid_get_data(ibuf, &sc->sc_loc_x);
 434         dy = -hid_get_data(ibuf, &sc->sc_loc_y);
 435         dz = -hid_get_data(ibuf, &sc->sc_loc_z);
 436         for (i = 0; i < sc->nbuttons; i++)
 437                 if (hid_get_data(ibuf, &sc->sc_loc_btn[i]))
 438                         buttons |= (1 << UMS_BUT(i));
 439
 440         if (dx || dy || dz || (sc->flags & UMS_Z)
 441             || buttons != sc->status.button) {
 442                 DPRINTFN(5, ("ums_intr: x:%d y:%d z:%d buttons:0x%x\n",
 443                         dx, dy, dz, buttons));
 444
 445                 sc->status.button = buttons;
 446                 sc->status.dx += dx;
 447                 sc->status.dy += dy;
 448                 sc->status.dz += dz;
 449
 450                 /* Discard data in case of full buffer */
 451                 if (sc->qcount == sizeof(sc->qbuf)) {
 452                         DPRINTF(("Buffer full, discarded packet"));
 453                         return;
 454                 }
 455
 456                 /*
 457                  * The Qtronix keyboard has a built in PS/2 port for a mouse.
 458                  * The firmware once in a while posts a spurious button up
 459                  * event. This event we ignore by doing a timeout for 50 msecs.
 460                  * If we receive dx=dy=dz=buttons=0 before we add the event to
 461                  * the queue.
 462                  * In any other case we delete the timeout event.
 463                  */
 464                 if (sc->flags & UMS_SPUR_BUT_UP &&
 465                     dx == 0 && dy == 0 && dz == 0 && buttons == 0) {
 466                         callout_reset(&sc->sc_timeout, MS_TO_TICKS(50),
 467                                     ums_add_to_queue_timeout, (void *) sc);
 468                 } else {
 469                         callout_stop(&sc->sc_timeout);
 470                         ums_add_to_queue(sc, dx, dy, dz, buttons);
 471                 }
 472         }
 473 }
 474
 475 Static void
 476 ums_add_to_queue_timeout(void *priv)
 477 {
 478         struct ums_softc *sc = priv;
 479         int s;
 480
 481         s = splusb();
 482         ums_add_to_queue(sc, 0, 0, 0, 0);
 483         splx(s);
 484 }
 485
 486 Static void
 487 ums_add_to_queue(struct ums_softc *sc, int dx, int dy, int dz, int buttons)
 488 {
 489         /* Discard data in case of full buffer */
 490         if (sc->qhead+sc->mode.packetsize > sizeof(sc->qbuf)) {
 491                 DPRINTF(("Buffer full, discarded packet"));
 492                 return;
 493         }
 494
 495         if (dx >  254)          dx =  254;
 496         if (dx < -256)          dx = -256;
 497         if (dy >  254)          dy =  254;
 498         if (dy < -256)          dy = -256;
 499         if (dz >  126)          dz =  126;
 500         if (dz < -128)          dz = -128;
 501
 502         sc->qbuf[sc->qhead] = sc->mode.syncmask[1];
 503         sc->qbuf[sc->qhead] |= ~buttons & MOUSE_MSC_BUTTONS;
 504         sc->qbuf[sc->qhead+1] = dx >> 1;
 505         sc->qbuf[sc->qhead+2] = dy >> 1;
 506         sc->qbuf[sc->qhead+3] = dx - (dx >> 1);
 507         sc->qbuf[sc->qhead+4] = dy - (dy >> 1);
 508
 509         if (sc->mode.level == 1) {
 510                 sc->qbuf[sc->qhead+5] = dz >> 1;
 511                 sc->qbuf[sc->qhead+6] = dz - (dz >> 1);
 512                 sc->qbuf[sc->qhead+7] = ((~buttons >> 3)
 513                                          & MOUSE_SYS_EXTBUTTONS);
 514         }
 515
 516         sc->qhead += sc->mode.packetsize;
 517         sc->qcount += sc->mode.packetsize;
 518         /* wrap round at end of buffer */
 519         if (sc->qhead >= sizeof(sc->qbuf))
 520                 sc->qhead = 0;
 521
 522         /* someone waiting for data */
 523         if (sc->state & UMS_ASLEEP) {
 524                 sc->state &= ~UMS_ASLEEP;
 525                 wakeup(sc);
 526         }
 527         if (sc->state & UMS_SELECT) {
 528                 sc->state &= ~UMS_SELECT;
 529                 selwakeuppri(&sc->rsel, 0);
 530         }
 531 }
 532 Static int
 533 ums_enable(v)
 534         void *v;
 535 {
 536         struct ums_softc *sc = v;
 537
 538         usbd_status err;
 539
 540         if (sc->sc_enabled)
 541                 return EBUSY;
 542
 543         sc->sc_enabled = 1;
 544         sc->qcount = 0;
 545         sc->qhead = sc->qtail = 0;
 546         sc->status.flags = 0;
 547         sc->status.button = sc->status.obutton = 0;
 548         sc->status.dx = sc->status.dy = sc->status.dz = 0;
 549
 550         callout_init(&sc->sc_timeout);
 551
 552         /* Set up interrupt pipe. */
 553         err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
 554                                 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
 555                                 sc->sc_ibuf, sc->sc_isize, ums_intr,
 556                                 USBD_DEFAULT_INTERVAL);
 557         if (err) {
 558                 DPRINTF(("ums_enable: usbd_open_pipe_intr failed, error=%d\n",
 559                          err));
 560                 sc->sc_enabled = 0;
 561                 return (EIO);
 562         }
 563         return (0);
 564 }
 565
 566 Static void
 567 ums_disable(priv)
 568         void *priv;
 569 {
 570         struct ums_softc *sc = priv;
 571
 572         callout_stop(&sc->sc_timeout);
 573
 574         /* Disable interrupts. */
 575         usbd_abort_pipe(sc->sc_intrpipe);
 576         usbd_close_pipe(sc->sc_intrpipe);
 577
 578         sc->sc_enabled = 0;
 579
 580         if (sc->qcount != 0)
 581                 DPRINTF(("Discarded %d bytes in queue\n", sc->qcount));
 582 }
 583
 584 Static int
 585 ums_open(dev_t dev, int flag, int fmt, usb_proc_ptr p)
 586 {
 587         struct ums_softc *sc;
 588
 589         USB_GET_SC_OPEN(ums, UMSUNIT(dev), sc);
 590
 591         return ums_enable(sc);
 592 }
 593
 594 Static int
 595 ums_close(dev_t dev, int flag, int fmt, usb_proc_ptr p)
 596 {
 597         struct ums_softc *sc;
 598
 599         USB_GET_SC(ums, UMSUNIT(dev), sc);
 600
 601         if (!sc)
 602                 return 0;
 603
 604         if (sc->sc_enabled)
 605                 ums_disable(sc);
 606
 607         return 0;
 608 }
 609
 610 Static int
 611 ums_read(dev_t dev, struct uio *uio, int flag)
 612 {
 613         struct ums_softc *sc;
 614         int s;
 615         char buf[sizeof(sc->qbuf)];
 616         int l = 0;
 617         int error;
 618
 619         USB_GET_SC(ums, UMSUNIT(dev), sc);
 620
 621         s = splusb();
 622         if (!sc) {
 623                 splx(s);
 624                 return EIO;
 625         }
 626
 627         while (sc->qcount == 0 )  {
 628                 if (flag & IO_NDELAY) {         /* non-blocking I/O */
 629                         splx(s);
 630                         return EWOULDBLOCK;
 631                 }
 632
 633                 sc->state |= UMS_ASLEEP;        /* blocking I/O */
 634                 error = tsleep(sc, PCATCH, "umsrea", 0);
 635                 if (error) {
 636                         splx(s);
 637                         return error;
 638                 } else if (!sc->sc_enabled) {
 639                         splx(s);
 640                         return EINTR;
 641                 }
 642                 /* check whether the device is still there */
 643
 644                 sc = devclass_get_softc(ums_devclass, UMSUNIT(dev));
 645                 if (!sc) {
 646                         splx(s);
 647                         return EIO;
 648                 }
 649         }
 650
 651         /*
 652          * XXX we could optimise the use of splx/splusb somewhat. The writer
 653          * process only extends qcount and qtail. We could copy them and use the copies
 654          * to do the copying out of the queue.
 655          */
 656
 657         while ((sc->qcount > 0) && (uio->uio_resid > 0)) {
 658                 l = (sc->qcount < uio->uio_resid? sc->qcount:uio->uio_resid);
 659                 if (l > sizeof(buf))
 660                         l = sizeof(buf);
 661                 if (l > sizeof(sc->qbuf) - sc->qtail)           /* transfer till end of buf */
 662                         l = sizeof(sc->qbuf) - sc->qtail;
 663
 664                 splx(s);
 665                 uiomove(&sc->qbuf[sc->qtail], l, uio);
 666                 s = splusb();
 667
 668                 if ( sc->qcount - l < 0 ) {
 669                         DPRINTF(("qcount below 0, count=%d l=%d\n", sc->qcount, l));
 670                         sc->qcount = l;
 671                 }
 672                 sc->qcount -= l;        /* remove the bytes from the buffer */
 673                 sc->qtail = (sc->qtail + l) % sizeof(sc->qbuf);
 674         }
 675         splx(s);
 676
 677         return 0;
 678 }
 679
 680 Static int
 681 ums_poll(dev_t dev, int events, usb_proc_ptr p)
 682 {
 683         struct ums_softc *sc;
 684         int revents = 0;
 685         int s;
 686
 687         USB_GET_SC(ums, UMSUNIT(dev), sc);
 688
 689         if (!sc)
 690                 return 0;
 691
 692         s = splusb();
 693         if (events & (POLLIN | POLLRDNORM)) {
 694                 if (sc->qcount) {
 695                         revents = events & (POLLIN | POLLRDNORM);
 696                 } else {
 697                         sc->state |= UMS_SELECT;
 698                         selrecord(p, &sc->rsel);
 699                 }
 700         }
 701         splx(s);
 702
 703         return revents;
 704 }
 705
 706 int
 707 ums_ioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
 708 {
 709         struct ums_softc *sc;
 710         int error = 0;
 711         int s;
 712         mousemode_t mode;
 713
 714         USB_GET_SC(ums, UMSUNIT(dev), sc);
 715
 716         if (!sc)
 717                 return EIO;
 718
 719         switch(cmd) {
 720         case MOUSE_GETHWINFO:
 721                 *(mousehw_t *)addr = sc->hw;
 722                 break;
 723         case MOUSE_GETMODE:
 724                 *(mousemode_t *)addr = sc->mode;
 725                 break;
 726         case MOUSE_SETMODE:
 727                 mode = *(mousemode_t *)addr;
 728
 729                 if (mode.level == -1)
 730                         /* don't change the current setting */
 731                         ;
 732                 else if ((mode.level < 0) || (mode.level > 1))
 733                         return (EINVAL);
 734
 735                 s = splusb();
 736                 sc->mode.level = mode.level;
 737
 738                 if (sc->mode.level == 0) {
 739                         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
 740                                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
 741                         else
 742                                 sc->hw.buttons = sc->nbuttons;
 743                         sc->mode.protocol = MOUSE_PROTO_MSC;
 744                         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
 745                         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 746                         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
 747                 } else if (sc->mode.level == 1) {
 748                         if (sc->nbuttons > MOUSE_SYS_MAXBUTTON)
 749                                 sc->hw.buttons = MOUSE_SYS_MAXBUTTON;
 750                         else
 751                                 sc->hw.buttons = sc->nbuttons;
 752                         sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
 753                         sc->mode.packetsize = MOUSE_SYS_PACKETSIZE;
 754                         sc->mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 755                         sc->mode.syncmask[1] = MOUSE_SYS_SYNC;
 756                 }
 757
 758                 bzero(sc->qbuf, sizeof(sc->qbuf));
 759                 sc->qhead = sc->qtail = sc->qcount = 0;
 760                 splx(s);
 761
 762                 break;
 763         case MOUSE_GETLEVEL:
 764                 *(int *)addr = sc->mode.level;
 765                 break;
 766         case MOUSE_SETLEVEL:
 767                 if (*(int *)addr < 0 || *(int *)addr > 1)
 768                         return (EINVAL);
 769
 770                 s = splusb();
 771                 sc->mode.level = *(int *)addr;
 772
 773                 if (sc->mode.level == 0) {
 774                         if (sc->nbuttons > MOUSE_MSC_MAXBUTTON)
 775                                 sc->hw.buttons = MOUSE_MSC_MAXBUTTON;
 776                         else
 777                                 sc->hw.buttons = sc->nbuttons;
 778                         sc->mode.protocol = MOUSE_PROTO_MSC;
 779                         sc->mode.packetsize = MOUSE_MSC_PACKETSIZE;
 780                         sc->mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 781                         sc->mode.syncmask[1] = MOUSE_MSC_SYNC;
 782                 } else if (sc->mode.level == 1) {
 783                         if (sc->nbuttons > MOUSE_SYS_MAXBUTTON)
 784                                 sc->hw.buttons = MOUSE_SYS_MAXBUTTON;
 785                         else
 786                                 sc->hw.buttons = sc->nbuttons;
 787                         sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
 788                         sc->mode.packetsize = MOUSE_SYS_PACKETSIZE;
 789                         sc->mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 790                         sc->mode.syncmask[1] = MOUSE_SYS_SYNC;
 791                 }
 792
 793                 bzero(sc->qbuf, sizeof(sc->qbuf));
 794                 sc->qhead = sc->qtail = sc->qcount = 0;
 795                 splx(s);
 796
 797                 break;
 798         case MOUSE_GETSTATUS: {
 799                 mousestatus_t *status = (mousestatus_t *) addr;
 800
 801                 s = splusb();
 802                 *status = sc->status;
 803                 sc->status.obutton = sc->status.button;
 804                 sc->status.button = 0;
 805                 sc->status.dx = sc->status.dy = sc->status.dz = 0;
 806                 splx(s);
 807
 808                 if (status->dx || status->dy || status->dz)
 809                         status->flags |= MOUSE_POSCHANGED;
 810                 if (status->button != status->obutton)
 811                         status->flags |= MOUSE_BUTTONSCHANGED;
 812                 break;
 813                 }
 814         default:
 815                 error = ENOTTY;
 816         }
 817
 818         return error;
 819 }
 820
 821 DRIVER_MODULE(ums, uhub, ums_driver, ums_devclass, usbd_driver_load, 0);