sys/dev/usb/uhid.c

   1 /*      $NetBSD: uhid.c,v 1.46 2001/11/13 06:24:55 lukem Exp $  */
   2
   3 /* Also already merged from NetBSD:
   4  *      $NetBSD: uhid.c,v 1.54 2002/09/23 05:51:21 simonb Exp $
   5  */
   6
   7 #include <sys/cdefs.h>
   8 __FBSDID("$FreeBSD$");
   9
  10 /*-
  11  * Copyright (c) 1998 The NetBSD Foundation, Inc.
  12  * All rights reserved.
  13  *
  14  * This code is derived from software contributed to The NetBSD Foundation
  15  * by Lennart Augustsson (lennart@augustsson.net) at
  16  * Carlstedt Research & Technology.
  17  *
  18  * Redistribution and use in source and binary forms, with or without
  19  * modification, are permitted provided that the following conditions
  20  * are met:
  21  * 1. Redistributions of source code must retain the above copyright
  22  *    notice, this list of conditions and the following disclaimer.
  23  * 2. Redistributions in binary form must reproduce the above copyright
  24  *    notice, this list of conditions and the following disclaimer in the
  25  *    documentation and/or other materials provided with the distribution.
  26  * 3. All advertising materials mentioning features or use of this software
  27  *    must display the following acknowledgement:
  28  *        This product includes software developed by the NetBSD
  29  *        Foundation, Inc. and its contributors.
  30  * 4. Neither the name of The NetBSD Foundation nor the names of its
  31  *    contributors may be used to endorse or promote products derived
  32  *    from this software without specific prior written permission.
  33  *
  34  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  35  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  36  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  37  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  38  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  39  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  40  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  41  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  42  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  43  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  44  * POSSIBILITY OF SUCH DAMAGE.
  45  */
  46
  47 /*
  48  * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
  49  */
  50
  51 #include <sys/param.h>
  52 #include <sys/systm.h>
  53 #include <sys/kernel.h>
  54 #include <sys/lock.h>
  55 #include <sys/malloc.h>
  56 #if __FreeBSD_version >= 500000
  57 #include <sys/mutex.h>
  58 #endif
  59 #include <sys/signalvar.h>
  60 #include <sys/fcntl.h>
  61 #if defined(__NetBSD__) || defined(__OpenBSD__)
  62 #include <sys/device.h>
  63 #include <sys/ioctl.h>
  64 #include <sys/file.h>
  65 #elif defined(__FreeBSD__)
  66 #include <sys/ioccom.h>
  67 #include <sys/filio.h>
  68 #include <sys/module.h>
  69 #include <sys/bus.h>
  70 #include <sys/ioccom.h>
  71 #endif
  72 #include <sys/conf.h>
  73 #include <sys/tty.h>
  74 #if __FreeBSD_version >= 500014
  75 #include <sys/selinfo.h>
  76 #else
  77 #include <sys/select.h>
  78 #endif
  79 #include <sys/proc.h>
  80 #include <sys/poll.h>
  81 #include <sys/sysctl.h>
  82 #include <sys/uio.h>
  83
  84 #include <dev/usb/usb.h>
  85 #include <dev/usb/usbhid.h>
  86
  87 #include "usbdevs.h"
  88 #include <dev/usb/usbdi.h>
  89 #include <dev/usb/usbdi_util.h>
  90 #include <dev/usb/hid.h>
  91
  92 /* Replacement report descriptors for devices shipped with broken ones */
  93 #include <dev/usb/ugraphire_rdesc.h>
  94 #include <dev/usb/uxb360gp_rdesc.h>
  95
  96 /* For hid blacklist quirk */
  97 #include <dev/usb/usb_quirks.h>
  98
  99 #ifdef USB_DEBUG
 100 #define DPRINTF(x)      if (uhiddebug) logprintf x
 101 #define DPRINTFN(n,x)   if (uhiddebug>(n)) logprintf x
 102 int     uhiddebug = 0;
 103 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
 104 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
 105            &uhiddebug, 0, "uhid debug level");
 106 #else
 107 #define DPRINTF(x)
 108 #define DPRINTFN(n,x)
 109 #endif
 110
 111 struct uhid_softc {
 112         device_t sc_dev;                        /* base device */
 113         usbd_device_handle sc_udev;
 114         usbd_interface_handle sc_iface; /* interface */
 115         usbd_pipe_handle sc_intrpipe;   /* interrupt pipe */
 116         int sc_ep_addr;
 117
 118         int sc_isize;
 119         int sc_osize;
 120         int sc_fsize;
 121         u_int8_t sc_iid;
 122         u_int8_t sc_oid;
 123         u_int8_t sc_fid;
 124
 125         u_char *sc_ibuf;
 126         u_char *sc_obuf;
 127
 128         void *sc_repdesc;
 129         int sc_repdesc_size;
 130
 131         struct clist sc_q;
 132         struct selinfo sc_rsel;
 133         struct proc *sc_async;  /* process that wants SIGIO */
 134         u_char sc_state;        /* driver state */
 135 #define UHID_OPEN       0x01    /* device is open */
 136 #define UHID_ASLP       0x02    /* waiting for device data */
 137 #define UHID_NEEDCLEAR  0x04    /* needs clearing endpoint stall */
 138 #define UHID_IMMED      0x08    /* return read data immediately */
 139
 140         int sc_refcnt;
 141         u_char sc_dying;
 142
 143 #if defined(__FreeBSD__)
 144         struct cdev *dev;
 145 #endif
 146 };
 147
 148 #define UHIDUNIT(dev)   (minor(dev))
 149 #define UHID_CHUNK      128     /* chunk size for read */
 150 #define UHID_BSIZE      1020    /* buffer size */
 151
 152 #if defined(__NetBSD__) || defined(__OpenBSD__)
 153 cdev_decl(uhid);
 154 #elif defined(__FreeBSD__)
 155 d_open_t        uhidopen;
 156 d_close_t       uhidclose;
 157 d_read_t        uhidread;
 158 d_write_t       uhidwrite;
 159 d_ioctl_t       uhidioctl;
 160 d_poll_t        uhidpoll;
 161
 162
 163 static struct cdevsw uhid_cdevsw = {
 164         .d_version =    D_VERSION,
 165         .d_flags =      D_NEEDGIANT,
 166         .d_open =       uhidopen,
 167         .d_close =      uhidclose,
 168         .d_read =       uhidread,
 169         .d_write =      uhidwrite,
 170         .d_ioctl =      uhidioctl,
 171         .d_poll =       uhidpoll,
 172         .d_name =       "uhid",
 173 #if __FreeBSD_version < 500014
 174         .d_bmaj         -1
 175 #endif
 176 };
 177 #endif
 178
 179 static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
 180                            usbd_status);
 181
 182 static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
 183 static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
 184 static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int,
 185                               usb_proc_ptr);
 186
 187 USB_DECLARE_DRIVER(uhid);
 188
 189 USB_MATCH(uhid)
 190 {
 191         USB_MATCH_START(uhid, uaa);
 192         usb_interface_descriptor_t *id;
 193
 194         if (uaa->iface == NULL)
 195                 return (UMATCH_NONE);
 196         id = usbd_get_interface_descriptor(uaa->iface);
 197         if (id == NULL)
 198                 return (UMATCH_NONE);
 199         if  (id->bInterfaceClass != UICLASS_HID) {
 200                 /* The Xbox 360 gamepad doesn't use the HID class. */
 201                 if (id->bInterfaceClass != UICLASS_VENDOR ||
 202                     id->bInterfaceSubClass != UISUBCLASS_XBOX360_CONTROLLER ||
 203                     id->bInterfaceProtocol != UIPROTO_XBOX360_GAMEPAD)
 204                         return (UMATCH_NONE);
 205         }
 206         if (usbd_get_quirks(uaa->device)->uq_flags & UQ_HID_IGNORE)
 207                 return (UMATCH_NONE);
 208 #if 0
 209         if (uaa->matchlvl)
 210                 return (uaa->matchlvl);
 211 #endif
 212
 213         return (UMATCH_IFACECLASS_GENERIC);
 214 }
 215
 216 USB_ATTACH(uhid)
 217 {
 218         USB_ATTACH_START(uhid, sc, uaa);
 219         usbd_interface_handle iface = uaa->iface;
 220         usb_interface_descriptor_t *id;
 221         usb_endpoint_descriptor_t *ed;
 222         int size;
 223         void *desc;
 224         const void *descptr;
 225         usbd_status err;
 226         char devinfo[1024];
 227
 228         sc->sc_udev = uaa->device;
 229         sc->sc_iface = iface;
 230         id = usbd_get_interface_descriptor(iface);
 231         usbd_devinfo(uaa->device, USBD_SHOW_INTERFACE_CLASS, devinfo);
 232         USB_ATTACH_SETUP;
 233
 234         ed = usbd_interface2endpoint_descriptor(iface, 0);
 235         if (ed == NULL) {
 236                 printf("%s: could not read endpoint descriptor\n",
 237                        device_get_nameunit(sc->sc_dev));
 238                 sc->sc_dying = 1;
 239                 USB_ATTACH_ERROR_RETURN;
 240         }
 241
 242         DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
 243                      "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
 244                      " bInterval=%d\n",
 245                      ed->bLength, ed->bDescriptorType,
 246                      ed->bEndpointAddress & UE_ADDR,
 247                      UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
 248                      ed->bmAttributes & UE_XFERTYPE,
 249                      UGETW(ed->wMaxPacketSize), ed->bInterval));
 250
 251         if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
 252             (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
 253                 printf("%s: unexpected endpoint\n", device_get_nameunit(sc->sc_dev));
 254                 sc->sc_dying = 1;
 255                 USB_ATTACH_ERROR_RETURN;
 256         }
 257
 258         sc->sc_ep_addr = ed->bEndpointAddress;
 259
 260         descptr = NULL;
 261         if (uaa->vendor == USB_VENDOR_WACOM) {
 262                 /* The report descriptor for the Wacom Graphire is broken. */
 263                 if (uaa->product == USB_PRODUCT_WACOM_GRAPHIRE) {
 264                         size = sizeof uhid_graphire_report_descr;
 265                         descptr = uhid_graphire_report_descr;
 266                 } else if (uaa->product == USB_PRODUCT_WACOM_GRAPHIRE3_4X5) {
 267                         static uByte reportbuf[] = {2, 2, 2};
 268
 269                         /*
 270                          * The Graphire3 needs 0x0202 to be written to
 271                          * feature report ID 2 before it'll start
 272                          * returning digitizer data.
 273                          */
 274                         usbd_set_report(uaa->iface, UHID_FEATURE_REPORT, 2,
 275                             &reportbuf, sizeof reportbuf);
 276
 277                         size = sizeof uhid_graphire3_4x5_report_descr;
 278                         descptr = uhid_graphire3_4x5_report_descr;
 279                 }
 280         } else if (id->bInterfaceClass == UICLASS_VENDOR &&
 281             id->bInterfaceSubClass == UISUBCLASS_XBOX360_CONTROLLER &&
 282             id->bInterfaceProtocol == UIPROTO_XBOX360_GAMEPAD) {
 283                 static uByte reportbuf[] = {1, 3, 0};
 284
 285                 /* The LEDs on the gamepad are blinking by default, turn off. */
 286                 usbd_set_report(uaa->iface, UHID_OUTPUT_REPORT, 0,
 287                     &reportbuf, sizeof reportbuf);
 288
 289                 /* The Xbox 360 gamepad has no report descriptor. */
 290                 size = sizeof uhid_xb360gp_report_descr;
 291                 descptr = uhid_xb360gp_report_descr;
 292         }
 293
 294         if (descptr) {
 295                 desc = malloc(size, M_USBDEV, M_NOWAIT);
 296                 if (desc == NULL)
 297                         err = USBD_NOMEM;
 298                 else {
 299                         err = USBD_NORMAL_COMPLETION;
 300                         memcpy(desc, descptr, size);
 301                 }
 302         } else {
 303                 desc = NULL;
 304                 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
 305         }
 306
 307         if (err) {
 308                 printf("%s: no report descriptor\n", device_get_nameunit(sc->sc_dev));
 309                 sc->sc_dying = 1;
 310                 USB_ATTACH_ERROR_RETURN;
 311         }
 312
 313         (void)usbd_set_idle(iface, 0, 0);
 314
 315         sc->sc_isize = hid_report_size(desc, size, hid_input,   &sc->sc_iid);
 316         sc->sc_osize = hid_report_size(desc, size, hid_output,  &sc->sc_oid);
 317         sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
 318
 319         sc->sc_repdesc = desc;
 320         sc->sc_repdesc_size = size;
 321
 322 #if defined(__FreeBSD__)
 323         sc->dev = make_dev(&uhid_cdevsw, device_get_unit(self),
 324                         UID_ROOT, GID_OPERATOR,
 325                         0644, "uhid%d", device_get_unit(self));
 326 #endif
 327
 328         USB_ATTACH_SUCCESS_RETURN;
 329 }
 330
 331 #if defined(__NetBSD__) || defined(__OpenBSD__)
 332 int
 333 uhid_activate(device_t self, enum devact act)
 334 {
 335         struct uhid_softc *sc = (struct uhid_softc *)self;
 336
 337         switch (act) {
 338         case DVACT_ACTIVATE:
 339                 return (EOPNOTSUPP);
 340
 341         case DVACT_DEACTIVATE:
 342                 sc->sc_dying = 1;
 343                 break;
 344         }
 345         return (0);
 346 }
 347 #endif
 348
 349 USB_DETACH(uhid)
 350 {
 351         USB_DETACH_START(uhid, sc);
 352         int s;
 353 #if defined(__NetBSD__) || defined(__OpenBSD__)
 354         int maj, mn;
 355 #endif
 356
 357 #if defined(__NetBSD__) || defined(__OpenBSD__)
 358         DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
 359 #else
 360         DPRINTF(("uhid_detach: sc=%p\n", sc));
 361 #endif
 362
 363         sc->sc_dying = 1;
 364         if (sc->sc_intrpipe != NULL)
 365                 usbd_abort_pipe(sc->sc_intrpipe);
 366
 367         if (sc->sc_state & UHID_OPEN) {
 368                 s = splusb();
 369                 if (--sc->sc_refcnt >= 0) {
 370                         /* Wake everyone */
 371                         wakeup(&sc->sc_q);
 372                         /* Wait for processes to go away. */
 373                         usb_detach_wait(USBDEV(sc->sc_dev));
 374                 }
 375                 splx(s);
 376         }
 377
 378 #if defined(__NetBSD__) || defined(__OpenBSD__)
 379         /* locate the major number */
 380         for (maj = 0; maj < nchrdev; maj++)
 381                 if (cdevsw[maj].d_open == uhidopen)
 382                         break;
 383
 384         /* Nuke the vnodes for any open instances (calls close). */
 385         mn = self->dv_unit;
 386         vdevgone(maj, mn, mn, VCHR);
 387 #elif defined(__FreeBSD__)
 388         destroy_dev(sc->dev);
 389 #endif
 390
 391         if (sc->sc_repdesc)
 392                 free(sc->sc_repdesc, M_USBDEV);
 393
 394         return (0);
 395 }
 396
 397 void
 398 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
 399 {
 400         struct uhid_softc *sc = addr;
 401
 402 #ifdef USB_DEBUG
 403         if (uhiddebug > 5) {
 404                 u_int32_t cc, i;
 405
 406                 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
 407                 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
 408                 DPRINTF(("uhid_intr: data ="));
 409                 for (i = 0; i < cc; i++)
 410                         DPRINTF((" %02x", sc->sc_ibuf[i]));
 411                 DPRINTF(("\n"));
 412         }
 413 #endif
 414
 415         if (status == USBD_CANCELLED)
 416                 return;
 417
 418         if (status != USBD_NORMAL_COMPLETION) {
 419                 DPRINTF(("uhid_intr: status=%d\n", status));
 420                 if (status == USBD_STALLED)
 421                     sc->sc_state |= UHID_NEEDCLEAR;
 422                 return;
 423         }
 424
 425         (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
 426
 427         if (sc->sc_state & UHID_ASLP) {
 428                 sc->sc_state &= ~UHID_ASLP;
 429                 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
 430                 wakeup(&sc->sc_q);
 431         }
 432         selwakeuppri(&sc->sc_rsel, PZERO);
 433         if (sc->sc_async != NULL) {
 434                 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
 435                 PROC_LOCK(sc->sc_async);
 436                 psignal(sc->sc_async, SIGIO);
 437                 PROC_UNLOCK(sc->sc_async);
 438         }
 439 }
 440
 441 int
 442 uhidopen(struct cdev *dev, int flag, int mode, usb_proc_ptr p)
 443 {
 444         struct uhid_softc *sc;
 445         usbd_status err;
 446
 447         USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
 448
 449         DPRINTF(("uhidopen: sc=%p\n", sc));
 450
 451         if (sc->sc_dying)
 452                 return (ENXIO);
 453
 454         if (sc->sc_state & UHID_OPEN)
 455                 return (EBUSY);
 456         sc->sc_state |= UHID_OPEN;
 457
 458         if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
 459                 sc->sc_state &= ~UHID_OPEN;
 460                 return (ENOMEM);
 461         }
 462
 463         sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
 464         sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
 465
 466         /* Set up interrupt pipe. */
 467         err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
 468                   USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
 469                   sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
 470         if (err) {
 471                 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
 472                          "error=%d\n",err));
 473                 free(sc->sc_ibuf, M_USBDEV);
 474                 free(sc->sc_obuf, M_USBDEV);
 475                 sc->sc_ibuf = sc->sc_obuf = NULL;
 476
 477                 sc->sc_state &= ~UHID_OPEN;
 478                 return (EIO);
 479         }
 480
 481         sc->sc_state &= ~UHID_IMMED;
 482
 483         sc->sc_async = 0;
 484
 485         return (0);
 486 }
 487
 488 int
 489 uhidclose(struct cdev *dev, int flag, int mode, usb_proc_ptr p)
 490 {
 491         struct uhid_softc *sc;
 492
 493         USB_GET_SC(uhid, UHIDUNIT(dev), sc);
 494
 495         DPRINTF(("uhidclose: sc=%p\n", sc));
 496
 497         /* Disable interrupts. */
 498         usbd_abort_pipe(sc->sc_intrpipe);
 499         usbd_close_pipe(sc->sc_intrpipe);
 500         sc->sc_intrpipe = 0;
 501
 502         ndflush(&sc->sc_q, sc->sc_q.c_cc);
 503         clfree(&sc->sc_q);
 504
 505         free(sc->sc_ibuf, M_USBDEV);
 506         free(sc->sc_obuf, M_USBDEV);
 507         sc->sc_ibuf = sc->sc_obuf = NULL;
 508
 509         sc->sc_state &= ~UHID_OPEN;
 510
 511         sc->sc_async = 0;
 512
 513         return (0);
 514 }
 515
 516 int
 517 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
 518 {
 519         int s;
 520         int error = 0;
 521         size_t length;
 522         u_char buffer[UHID_CHUNK];
 523         usbd_status err;
 524
 525         DPRINTFN(1, ("uhidread\n"));
 526         if (sc->sc_state & UHID_IMMED) {
 527                 DPRINTFN(1, ("uhidread immed\n"));
 528
 529                 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
 530                           sc->sc_iid, buffer, sc->sc_isize);
 531                 if (err)
 532                         return (EIO);
 533                 return (uiomove(buffer, sc->sc_isize, uio));
 534         }
 535
 536         s = splusb();
 537         while (sc->sc_q.c_cc == 0) {
 538                 if (flag & O_NONBLOCK) {
 539                         splx(s);
 540                         return (EWOULDBLOCK);
 541                 }
 542                 sc->sc_state |= UHID_ASLP;
 543                 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
 544                 error = tsleep(&sc->sc_q, PZERO | PCATCH, "uhidrea", 0);
 545                 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
 546                 if (sc->sc_dying)
 547                         error = EIO;
 548                 if (error) {
 549                         sc->sc_state &= ~UHID_ASLP;
 550                         break;
 551                 }
 552                 if (sc->sc_state & UHID_NEEDCLEAR) {
 553                         DPRINTFN(-1,("uhidread: clearing stall\n"));
 554                         sc->sc_state &= ~UHID_NEEDCLEAR;
 555                         usbd_clear_endpoint_stall(sc->sc_intrpipe);
 556                 }
 557         }
 558         splx(s);
 559
 560         /* Transfer as many chunks as possible. */
 561         while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
 562                 length = min(sc->sc_q.c_cc, uio->uio_resid);
 563                 if (length > sizeof(buffer))
 564                         length = sizeof(buffer);
 565
 566                 /* Remove a small chunk from the input queue. */
 567                 (void) q_to_b(&sc->sc_q, buffer, length);
 568                 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
 569
 570                 /* Copy the data to the user process. */
 571                 if ((error = uiomove(buffer, length, uio)) != 0)
 572                         break;
 573         }
 574
 575         return (error);
 576 }
 577
 578 int
 579 uhidread(struct cdev *dev, struct uio *uio, int flag)
 580 {
 581         struct uhid_softc *sc;
 582         int error;
 583
 584         USB_GET_SC(uhid, UHIDUNIT(dev), sc);
 585
 586         sc->sc_refcnt++;
 587         error = uhid_do_read(sc, uio, flag);
 588         if (--sc->sc_refcnt < 0)
 589                 usb_detach_wakeup(USBDEV(sc->sc_dev));
 590         return (error);
 591 }
 592
 593 int
 594 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
 595 {
 596         int error;
 597         int size;
 598         usbd_status err;
 599
 600         DPRINTFN(1, ("uhidwrite\n"));
 601
 602         if (sc->sc_dying)
 603                 return (EIO);
 604
 605         size = sc->sc_osize;
 606         error = 0;
 607         if (uio->uio_resid != size)
 608                 return (EINVAL);
 609         error = uiomove(sc->sc_obuf, size, uio);
 610         if (!error) {
 611                 if (sc->sc_oid)
 612                         err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
 613                                   sc->sc_obuf[0], sc->sc_obuf+1, size-1);
 614                 else
 615                         err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
 616                                   0, sc->sc_obuf, size);
 617                 if (err)
 618                         error = EIO;
 619         }
 620
 621         return (error);
 622 }
 623
 624 int
 625 uhidwrite(struct cdev *dev, struct uio *uio, int flag)
 626 {
 627         struct uhid_softc *sc;
 628         int error;
 629
 630         USB_GET_SC(uhid, UHIDUNIT(dev), sc);
 631
 632         sc->sc_refcnt++;
 633         error = uhid_do_write(sc, uio, flag);
 634         if (--sc->sc_refcnt < 0)
 635                 usb_detach_wakeup(USBDEV(sc->sc_dev));
 636         return (error);
 637 }
 638
 639 int
 640 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag,
 641               usb_proc_ptr p)
 642 {
 643         struct usb_ctl_report_desc *rd;
 644         struct usb_ctl_report *re;
 645         int size, id;
 646         usbd_status err;
 647
 648         DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
 649
 650         if (sc->sc_dying)
 651                 return (EIO);
 652
 653         switch (cmd) {
 654         case FIONBIO:
 655                 /* All handled in the upper FS layer. */
 656                 break;
 657
 658         case FIOASYNC:
 659                 if (*(int *)addr) {
 660                         if (sc->sc_async != NULL)
 661                                 return (EBUSY);
 662 #if __FreeBSD_version >= 500000
 663                         sc->sc_async = p->td_proc;
 664 #else
 665                         sc->sc_async = p;
 666 #endif
 667                         DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
 668                 } else
 669                         sc->sc_async = NULL;
 670                 break;
 671
 672         /* XXX this is not the most general solution. */
 673         case TIOCSPGRP:
 674                 if (sc->sc_async == NULL)
 675                         return (EINVAL);
 676                 if (*(int *)addr != sc->sc_async->p_pgid)
 677                         return (EPERM);
 678                 break;
 679
 680         case USB_GET_REPORT_DESC:
 681                 rd = (struct usb_ctl_report_desc *)addr;
 682                 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
 683                 rd->ucrd_size = size;
 684                 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
 685                 break;
 686
 687         case USB_SET_IMMED:
 688                 if (*(int *)addr) {
 689                         /* XXX should read into ibuf, but does it matter? */
 690                         err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
 691                                   sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
 692                         if (err)
 693                                 return (EOPNOTSUPP);
 694
 695                         sc->sc_state |=  UHID_IMMED;
 696                 } else
 697                         sc->sc_state &= ~UHID_IMMED;
 698                 break;
 699
 700         case USB_GET_REPORT:
 701                 re = (struct usb_ctl_report *)addr;
 702                 switch (re->ucr_report) {
 703                 case UHID_INPUT_REPORT:
 704                         size = sc->sc_isize;
 705                         id = sc->sc_iid;
 706                         break;
 707                 case UHID_OUTPUT_REPORT:
 708                         size = sc->sc_osize;
 709                         id = sc->sc_oid;
 710                         break;
 711                 case UHID_FEATURE_REPORT:
 712                         size = sc->sc_fsize;
 713                         id = sc->sc_fid;
 714                         break;
 715                 default:
 716                         return (EINVAL);
 717                 }
 718                 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
 719                           size);
 720                 if (err)
 721                         return (EIO);
 722                 break;
 723
 724         case USB_SET_REPORT:
 725                 re = (struct usb_ctl_report *)addr;
 726                 switch (re->ucr_report) {
 727                 case UHID_INPUT_REPORT:
 728                         size = sc->sc_isize;
 729                         id = sc->sc_iid;
 730                         break;
 731                 case UHID_OUTPUT_REPORT:
 732                         size = sc->sc_osize;
 733                         id = sc->sc_oid;
 734                         break;
 735                 case UHID_FEATURE_REPORT:
 736                         size = sc->sc_fsize;
 737                         id = sc->sc_fid;
 738                         break;
 739                 default:
 740                         return (EINVAL);
 741                 }
 742                 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
 743                           size);
 744                 if (err)
 745                         return (EIO);
 746                 break;
 747
 748         case USB_GET_REPORT_ID:
 749                 *(int *)addr = 0;       /* XXX: we only support reportid 0? */
 750                 break;
 751
 752         default:
 753                 return (EINVAL);
 754         }
 755         return (0);
 756 }
 757
 758 int
 759 uhidioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
 760 {
 761         struct uhid_softc *sc;
 762         int error;
 763
 764         USB_GET_SC(uhid, UHIDUNIT(dev), sc);
 765
 766         sc->sc_refcnt++;
 767         error = uhid_do_ioctl(sc, cmd, addr, flag, p);
 768         if (--sc->sc_refcnt < 0)
 769                 usb_detach_wakeup(USBDEV(sc->sc_dev));
 770         return (error);
 771 }
 772
 773 int
 774 uhidpoll(struct cdev *dev, int events, usb_proc_ptr p)
 775 {
 776         struct uhid_softc *sc;
 777         int revents = 0;
 778         int s;
 779
 780         USB_GET_SC(uhid, UHIDUNIT(dev), sc);
 781
 782         if (sc->sc_dying)
 783                 return (EIO);
 784
 785         s = splusb();
 786         if (events & (POLLOUT | POLLWRNORM))
 787                 revents |= events & (POLLOUT | POLLWRNORM);
 788         if (events & (POLLIN | POLLRDNORM)) {
 789                 if (sc->sc_q.c_cc > 0)
 790                         revents |= events & (POLLIN | POLLRDNORM);
 791                 else
 792                         selrecord(p, &sc->sc_rsel);
 793         }
 794
 795         splx(s);
 796         return (revents);
 797 }
 798
 799 #if defined(__FreeBSD__)
 800 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);
 801 #endif