sys/dev/usbmisc/urio/urio.c

   1 /*
   2  * Copyright (c) 2000 Iwasa Kazmi
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  18  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * This code is based on ugen.c and ulpt.c developed by Lennart Augustsson.
  27  * This code includes software developed by the NetBSD Foundation, Inc. and
  28  * its contributors.
  29  */
  30
  31 /*
  32  * $FreeBSD: src/sys/dev/usb/urio.c,v 1.28 2003/08/25 22:01:06 joe Exp $
  33  * $DragonFly: src/sys/dev/usbmisc/urio/urio.c,v 1.27 2008/08/14 20:55:54 hasso Exp $
  34  */
  35
  36 /*
  37  * 2000/3/24  added NetBSD/OpenBSD support (from Alex Nemirovsky)
  38  * 2000/3/07  use two bulk-pipe handles for read and write (Dirk)
  39  * 2000/3/06  change major number(143), and copyright header
  40  *            some fix for 4.0 (Dirk)
  41  * 2000/3/05  codes for FreeBSD 4.x - CURRENT (Thanks to Dirk-Willem van Gulik)
  42  * 2000/3/01  remove retry code from urioioctl()
  43  *            change method of bulk transfer (no interrupt)
  44  * 2000/2/28  small fixes for new rio_usb.h
  45  * 2000/2/24  first version.
  46  */
  47
  48 #include <sys/param.h>
  49 #include <sys/systm.h>
  50 #include <sys/kernel.h>
  51 #include <sys/malloc.h>
  52 #include <sys/module.h>
  53 #include <sys/bus.h>
  54 #include <sys/fcntl.h>
  55 #include <sys/filio.h>
  56 #include <sys/conf.h>
  57 #include <sys/uio.h>
  58 #include <sys/tty.h>
  59 #include <sys/file.h>
  60 #include <sys/select.h>
  61 #include <sys/poll.h>
  62 #include <sys/sysctl.h>
  63 #include <sys/proc.h>
  64 #include <sys/thread2.h>
  65
  66 #include <bus/usb/usb.h>
  67 #include <bus/usb/usbdi.h>
  68 #include <bus/usb/usbdi_util.h>
  69
  70 #include <bus/usb/rio500_usb.h>
  71
  72 #ifdef USB_DEBUG
  73 #define DPRINTF(x)      if (uriodebug) kprintf x
  74 #define DPRINTFN(n,x)   if (uriodebug>(n)) kprintf x
  75 int     uriodebug = 0;
  76 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
  77 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
  78            &uriodebug, 0, "urio debug level");
  79 #else
  80 #define DPRINTF(x)
  81 #define DPRINTFN(n,x)
  82 #endif
  83
  84 /* difference of usbd interface */
  85 #define USBDI 1
  86
  87 #define RIO_OUT 0
  88 #define RIO_IN  1
  89 #define RIO_NODIR  2
  90
  91 d_open_t  urioopen;
  92 d_close_t urioclose;
  93 d_read_t  urioread;
  94 d_write_t uriowrite;
  95 d_ioctl_t urioioctl;
  96
  97 #define URIO_CDEV_MAJOR 143
  98
  99 static struct dev_ops urio_ops = {
 100         { "urio", URIO_CDEV_MAJOR, 0 },
 101         .d_open =       urioopen,
 102         .d_close =      urioclose,
 103         .d_read =       urioread,
 104         .d_write =      uriowrite,
 105         .d_ioctl =      urioioctl,
 106 };
 107 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
 108                           ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
 109                                                            RIO_NODIR))
 110
 111 #define URIO_BBSIZE     1024
 112
 113 struct urio_softc {
 114         device_t sc_dev;
 115         usbd_device_handle sc_udev;
 116         usbd_interface_handle sc_iface;
 117
 118         int sc_opened;
 119         usbd_pipe_handle sc_pipeh_in;
 120         usbd_pipe_handle sc_pipeh_out;
 121         int sc_epaddr[2];
 122
 123         int sc_refcnt;
 124 };
 125
 126 #define URIOUNIT(n) (minor(n))
 127
 128 #define RIO_RW_TIMEOUT 4000     /* ms */
 129
 130 static device_probe_t urio_match;
 131 static device_attach_t urio_attach;
 132 static device_detach_t urio_detach;
 133
 134 static devclass_t urio_devclass;
 135
 136 static kobj_method_t urio_methods[] = {
 137         DEVMETHOD(device_probe, urio_match),
 138         DEVMETHOD(device_attach, urio_attach),
 139         DEVMETHOD(device_detach, urio_detach),
 140         {0,0}
 141 };
 142
 143 static driver_t urio_driver = {
 144         "urio",
 145         urio_methods,
 146         sizeof(struct urio_softc)
 147 };
 148
 149 static const struct usb_devno urio_devs[] = {
 150         { USB_DEVICE(0x045a, 0x5001) }, /* Diamond Multimedia Rio 600 */
 151         { USB_DEVICE(0x045a, 0x5002) }, /* Diamond Multimedia Rio 800 */
 152         { USB_DEVICE(0x0841, 0x0001) }, /* Diamond Multimedia Rio 500 */
 153 };
 154
 155 MODULE_DEPEND(urio, usb, 1, 1, 1);
 156
 157 static int
 158 urio_match(device_t self)
 159 {
 160         struct usb_attach_arg *uaa = device_get_ivars(self);
 161
 162         DPRINTFN(10,("urio_match\n"));
 163         if (uaa->iface == NULL)
 164                 return (UMATCH_NONE);
 165
 166         return (usb_lookup(urio_devs, uaa->vendor, uaa->product) != NULL ?
 167                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
 168 }
 169
 170 static int
 171 urio_attach(device_t self)
 172 {
 173         struct urio_softc *sc = device_get_softc(self);
 174         struct usb_attach_arg *uaa = device_get_ivars(self);
 175         usbd_interface_handle iface;
 176         u_int8_t epcount;
 177         usbd_status r;
 178         char * ermsg = "<none>";
 179         int i;
 180
 181         DPRINTFN(10,("urio_attach: sc=%p\n", sc));
 182         sc->sc_dev = self;
 183         sc->sc_udev = uaa->device;
 184
 185         if ((!uaa->device) || (!uaa->iface)) {
 186                 ermsg = "device or iface";
 187                 goto nobulk;
 188         }
 189         sc->sc_iface = iface = uaa->iface;
 190         sc->sc_opened = 0;
 191         sc->sc_pipeh_in = 0;
 192         sc->sc_pipeh_out = 0;
 193         sc->sc_refcnt = 0;
 194
 195         r = usbd_endpoint_count(iface, &epcount);
 196         if (r != USBD_NORMAL_COMPLETION) {
 197                 ermsg = "endpoints";
 198                 goto nobulk;
 199         }
 200
 201         sc->sc_epaddr[RIO_OUT] = 0xff;
 202         sc->sc_epaddr[RIO_IN] = 0x00;
 203
 204         for (i = 0; i < epcount; i++) {
 205                 usb_endpoint_descriptor_t *edesc =
 206                         usbd_interface2endpoint_descriptor(iface, i);
 207                 int d;
 208
 209                 if (!edesc) {
 210                         ermsg = "interface endpoint";
 211                         goto nobulk;
 212                 }
 213
 214                 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
 215                 if (d != RIO_NODIR)
 216                         sc->sc_epaddr[d] = edesc->bEndpointAddress;
 217         }
 218         if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
 219              sc->sc_epaddr[RIO_IN] == 0x00) {
 220                 ermsg = "Rio I&O";
 221                 goto nobulk;
 222         }
 223
 224         dev_ops_add(&urio_ops, -1, device_get_unit(self));
 225         make_dev(&urio_ops, device_get_unit(self),
 226                         UID_ROOT, GID_OPERATOR,
 227                         0644, "urio%d", device_get_unit(self));
 228
 229         DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
 230
 231         return 0;
 232
 233  nobulk:
 234         kprintf("%s: could not find %s\n", device_get_nameunit(sc->sc_dev),ermsg);
 235         return ENXIO;
 236 }
 237
 238
 239 int
 240 urioopen(struct dev_open_args *ap)
 241 {
 242         cdev_t dev = ap->a_head.a_dev;
 243 #if (USBDI >= 1)
 244         struct urio_softc * sc;
 245 #endif
 246         int unit = URIOUNIT(dev);
 247         sc = devclass_get_softc(urio_devclass, unit);
 248         if (sc == NULL)
 249                 return (ENXIO);
 250
 251         DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
 252                      ap->a_oflags, ap->a_devtype, unit));
 253
 254         if (sc->sc_opened)
 255                 return EBUSY;
 256
 257         if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
 258                 return EACCES;
 259
 260         sc->sc_opened = 1;
 261         sc->sc_pipeh_in = 0;
 262         sc->sc_pipeh_out = 0;
 263         if (usbd_open_pipe(sc->sc_iface,
 264                 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
 265                         != USBD_NORMAL_COMPLETION)
 266         {
 267                         sc->sc_pipeh_in = 0;
 268                         return EIO;
 269         };
 270         if (usbd_open_pipe(sc->sc_iface,
 271                 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
 272                         != USBD_NORMAL_COMPLETION)
 273         {
 274                         usbd_close_pipe(sc->sc_pipeh_in);
 275                         sc->sc_pipeh_in = 0;
 276                         sc->sc_pipeh_out = 0;
 277                         return EIO;
 278         };
 279         return 0;
 280 }
 281
 282 int
 283 urioclose(struct dev_close_args *ap)
 284 {
 285         cdev_t dev = ap->a_head.a_dev;
 286 #if (USBDI >= 1)
 287         struct urio_softc * sc;
 288 #endif
 289         int unit = URIOUNIT(dev);
 290         sc = devclass_get_softc(urio_devclass, unit);
 291
 292         DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n",
 293                 ap->a_fflag, ap->a_devtype, unit));
 294         if (sc->sc_pipeh_in)
 295                 usbd_close_pipe(sc->sc_pipeh_in);
 296
 297         if (sc->sc_pipeh_out)
 298                 usbd_close_pipe(sc->sc_pipeh_out);
 299
 300         sc->sc_pipeh_in = 0;
 301         sc->sc_pipeh_out = 0;
 302         sc->sc_opened = 0;
 303         sc->sc_refcnt = 0;
 304         return 0;
 305 }
 306
 307 int
 308 urioread(struct dev_read_args *ap)
 309 {
 310         cdev_t dev = ap->a_head.a_dev;
 311         struct uio *uio = ap->a_uio;
 312 #if (USBDI >= 1)
 313         struct urio_softc * sc;
 314         usbd_xfer_handle reqh;
 315 #else
 316         usbd_request_handle reqh;
 317         usbd_private_handle r_priv;
 318         void *r_buff;
 319         usbd_status r_status;
 320 #endif
 321         int unit = URIOUNIT(dev);
 322         usbd_status r;
 323         char buf[URIO_BBSIZE];
 324         u_int32_t n, tn;
 325         int error = 0;
 326
 327         sc = devclass_get_softc(urio_devclass, unit);
 328
 329         DPRINTFN(5, ("urioread: %d\n", unit));
 330         if (!sc->sc_opened)
 331                 return EIO;
 332
 333 #if (USBDI >= 1)
 334         sc->sc_refcnt++;
 335         reqh = usbd_alloc_xfer(sc->sc_udev);
 336 #else
 337         reqh = usbd_alloc_request();
 338 #endif
 339         if (reqh == 0)
 340                 return ENOMEM;
 341         while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
 342                 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
 343                 tn = n;
 344 #if (USBDI >= 1)
 345                 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
 346                                        0, RIO_RW_TIMEOUT, 0);
 347 #else
 348                 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
 349                                        0, RIO_RW_TIMEOUT, 0);
 350                 if (r != USBD_NORMAL_COMPLETION) {
 351                         error = EIO;
 352                         break;
 353                 }
 354 #endif
 355                 r = usbd_sync_transfer(reqh);
 356                 if (r != USBD_NORMAL_COMPLETION) {
 357                         DPRINTFN(1, ("urioread: error=%d\n", r));
 358                         usbd_clear_endpoint_stall(sc->sc_pipeh_in);
 359                         tn = 0;
 360                         error = EIO;
 361                         break;
 362                 }
 363 #if (USBDI >= 1)
 364                 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
 365 #else
 366                 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
 367 #endif
 368
 369                 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
 370                 error = uiomove(buf, tn, uio);
 371                 if (error || tn < n)
 372                         break;
 373         }
 374 #if (USBDI >= 1)
 375         usbd_free_xfer(reqh);
 376 #else
 377         usbd_free_request(reqh);
 378 #endif
 379
 380         return error;
 381 }
 382
 383 int
 384 uriowrite(struct dev_write_args *ap)
 385 {
 386         cdev_t dev = ap->a_head.a_dev;
 387         struct uio *uio = ap->a_uio;
 388 #if (USBDI >= 1)
 389         struct urio_softc * sc;
 390         usbd_xfer_handle reqh;
 391 #else
 392         usbd_request_handle reqh;
 393 #endif
 394         int unit = URIOUNIT(dev);
 395         usbd_status r;
 396         char buf[URIO_BBSIZE];
 397         u_int32_t n;
 398         int error = 0;
 399
 400         sc = devclass_get_softc(urio_devclass, unit);
 401
 402         DPRINTFN(5, ("uriowrite: %d\n", unit));
 403         if (!sc->sc_opened)
 404                 return EIO;
 405
 406 #if (USBDI >= 1)
 407         sc->sc_refcnt++;
 408         reqh = usbd_alloc_xfer(sc->sc_udev);
 409 #else
 410         reqh = usbd_alloc_request();
 411 #endif
 412         if (reqh == 0)
 413                 return EIO;
 414         while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
 415                 error = uiomove(buf, n, uio);
 416                 if (error)
 417                         break;
 418                 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
 419 #if (USBDI >= 1)
 420                 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
 421                                        0, RIO_RW_TIMEOUT, 0);
 422 #else
 423                 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
 424                                        0, RIO_RW_TIMEOUT, 0);
 425                 if (r != USBD_NORMAL_COMPLETION) {
 426                         error = EIO;
 427                         break;
 428                 }
 429 #endif
 430                 r = usbd_sync_transfer(reqh);
 431                 if (r != USBD_NORMAL_COMPLETION) {
 432                         DPRINTFN(1, ("uriowrite: error=%d\n", r));
 433                         usbd_clear_endpoint_stall(sc->sc_pipeh_out);
 434                         error = EIO;
 435                         break;
 436                 }
 437 #if (USBDI >= 1)
 438                 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
 439 #endif
 440         }
 441
 442 #if (USBDI >= 1)
 443         usbd_free_xfer(reqh);
 444 #else
 445         usbd_free_request(reqh);
 446 #endif
 447
 448         return error;
 449 }
 450
 451
 452 int
 453 urioioctl(struct dev_ioctl_args *ap)
 454 {
 455         cdev_t dev = ap->a_head.a_dev;
 456 #if (USBDI >= 1)
 457         struct urio_softc * sc;
 458 #endif
 459         int unit = URIOUNIT(dev);
 460         struct RioCommand *rio_cmd;
 461         int requesttype, len;
 462         struct iovec iov;
 463         struct uio uio;
 464         usb_device_request_t req;
 465         int req_flags = 0, req_actlen = 0;
 466         void *ptr = 0;
 467         int error = 0;
 468         usbd_status r;
 469
 470         sc = devclass_get_softc(urio_devclass, unit);
 471
 472         switch (ap->a_cmd) {
 473         case RIO_RECV_COMMAND:
 474                 if (!(ap->a_fflag & FWRITE))
 475                         return EPERM;
 476                 rio_cmd = (struct RioCommand *)ap->a_data;
 477                 if (rio_cmd == NULL)
 478                         return EINVAL;
 479                 len = rio_cmd->length;
 480
 481                 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
 482                 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
 483                         requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
 484                 break;
 485
 486         case RIO_SEND_COMMAND:
 487                 if (!(ap->a_fflag & FWRITE))
 488                         return EPERM;
 489                 rio_cmd = (struct RioCommand *)ap->a_data;
 490                 if (rio_cmd == NULL)
 491                         return EINVAL;
 492                 len = rio_cmd->length;
 493
 494                 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
 495                 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
 496                         requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
 497                 break;
 498
 499         default:
 500                 return EINVAL;
 501                 break;
 502         }
 503
 504         /* Send rio control message */
 505         req.bmRequestType = requesttype;
 506         req.bRequest = rio_cmd->request;
 507         USETW(req.wValue, rio_cmd->value);
 508         USETW(req.wIndex, rio_cmd->index);
 509         USETW(req.wLength, len);
 510
 511         if (len < 0 || len > 32767)
 512                 return EINVAL;
 513         if (len != 0) {
 514                 iov.iov_base = (caddr_t)rio_cmd->buffer;
 515                 iov.iov_len = len;
 516                 uio.uio_iov = &iov;
 517                 uio.uio_iovcnt = 1;
 518                 uio.uio_resid = len;
 519                 uio.uio_offset = 0;
 520                 uio.uio_segflg = UIO_USERSPACE;
 521                 uio.uio_rw =
 522                         req.bmRequestType & UT_READ ?
 523                         UIO_READ : UIO_WRITE;
 524                 uio.uio_td = curthread;
 525                 ptr = kmalloc(len, M_TEMP, M_WAITOK);
 526                 if (uio.uio_rw == UIO_WRITE) {
 527                         error = uiomove(ptr, len, &uio);
 528                         if (error)
 529                                 goto ret;
 530                 }
 531         }
 532
 533         r = usbd_do_request_flags(sc->sc_udev, &req,
 534                                   ptr, req_flags, &req_actlen,
 535                                   USBD_DEFAULT_TIMEOUT);
 536         if (r == USBD_NORMAL_COMPLETION) {
 537                 error = 0;
 538                 if (len != 0) {
 539                         if (uio.uio_rw == UIO_READ) {
 540                                 error = uiomove(ptr, len, &uio);
 541                         }
 542                 }
 543         } else {
 544                 error = EIO;
 545         }
 546
 547 ret:
 548         if (ptr)
 549                 kfree(ptr, M_TEMP);
 550         return error;
 551 }
 552
 553 static int
 554 urio_detach(device_t self)
 555 {
 556         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
 557         dev_ops_remove(&urio_ops, -1, device_get_unit(self));
 558         /* XXX not implemented yet */
 559         device_set_desc(self, NULL);
 560         return 0;
 561 }
 562
 563 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);
 564