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/ioccom.h>
  55 #include <sys/fcntl.h>
  56 #include <sys/filio.h>
  57 #include <sys/conf.h>
  58 #include <sys/uio.h>
  59 #include <sys/tty.h>
  60 #include <sys/file.h>
  61 #include <sys/select.h>
  62 #include <sys/poll.h>
  63 #include <sys/sysctl.h>
  64 #include <sys/proc.h>
  65 #include <sys/thread2.h>
  66
  67 #include <bus/usb/usb.h>
  68 #include <bus/usb/usbdi.h>
  69 #include <bus/usb/usbdi_util.h>
  70
  71 #include <bus/usb/rio500_usb.h>
  72
  73 #ifdef USB_DEBUG
  74 #define DPRINTF(x)      if (uriodebug) kprintf x
  75 #define DPRINTFN(n,x)   if (uriodebug>(n)) kprintf x
  76 int     uriodebug = 0;
  77 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
  78 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
  79            &uriodebug, 0, "urio debug level");
  80 #else
  81 #define DPRINTF(x)
  82 #define DPRINTFN(n,x)
  83 #endif
  84
  85 /* difference of usbd interface */
  86 #define USBDI 1
  87
  88 #define RIO_OUT 0
  89 #define RIO_IN  1
  90 #define RIO_NODIR  2
  91
  92 d_open_t  urioopen;
  93 d_close_t urioclose;
  94 d_read_t  urioread;
  95 d_write_t uriowrite;
  96 d_ioctl_t urioioctl;
  97
  98 #define URIO_CDEV_MAJOR 143
  99
 100 static struct dev_ops urio_ops = {
 101         { "urio", URIO_CDEV_MAJOR, 0 },
 102         .d_open =       urioopen,
 103         .d_close =      urioclose,
 104         .d_read =       urioread,
 105         .d_write =      uriowrite,
 106         .d_ioctl =      urioioctl,
 107 };
 108 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
 109                           ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
 110                                                            RIO_NODIR))
 111
 112 #define URIO_BBSIZE     1024
 113
 114 struct urio_softc {
 115         device_t sc_dev;
 116         usbd_device_handle sc_udev;
 117         usbd_interface_handle sc_iface;
 118
 119         int sc_opened;
 120         usbd_pipe_handle sc_pipeh_in;
 121         usbd_pipe_handle sc_pipeh_out;
 122         int sc_epaddr[2];
 123
 124         int sc_refcnt;
 125 };
 126
 127 #define URIOUNIT(n) (minor(n))
 128
 129 #define RIO_RW_TIMEOUT 4000     /* ms */
 130
 131 static device_probe_t urio_match;
 132 static device_attach_t urio_attach;
 133 static device_detach_t urio_detach;
 134
 135 static devclass_t urio_devclass;
 136
 137 static kobj_method_t urio_methods[] = {
 138         DEVMETHOD(device_probe, urio_match),
 139         DEVMETHOD(device_attach, urio_attach),
 140         DEVMETHOD(device_detach, urio_detach),
 141         {0,0}
 142 };
 143
 144 static driver_t urio_driver = {
 145         "urio",
 146         urio_methods,
 147         sizeof(struct urio_softc)
 148 };
 149
 150 static const struct usb_devno urio_devs[] = {
 151         { USB_DEVICE(0x045a, 0x5001) }, /* Diamond Multimedia Rio 600 */
 152         { USB_DEVICE(0x045a, 0x5002) }, /* Diamond Multimedia Rio 800 */
 153         { USB_DEVICE(0x0841, 0x0001) }, /* Diamond Multimedia Rio 500 */
 154 };
 155
 156 MODULE_DEPEND(urio, usb, 1, 1, 1);
 157
 158 static int
 159 urio_match(device_t self)
 160 {
 161         struct usb_attach_arg *uaa = device_get_ivars(self);
 162
 163         DPRINTFN(10,("urio_match\n"));
 164         if (uaa->iface == NULL)
 165                 return (UMATCH_NONE);
 166
 167         return (usb_lookup(urio_devs, uaa->vendor, uaa->product) != NULL ?
 168                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
 169 }
 170
 171 static int
 172 urio_attach(device_t self)
 173 {
 174         struct urio_softc *sc = device_get_softc(self);
 175         struct usb_attach_arg *uaa = device_get_ivars(self);
 176         usbd_interface_handle iface;
 177         u_int8_t epcount;
 178         usbd_status r;
 179         char * ermsg = "<none>";
 180         int i;
 181
 182         DPRINTFN(10,("urio_attach: sc=%p\n", sc));
 183         sc->sc_dev = self;
 184         sc->sc_udev = uaa->device;
 185
 186         if ((!uaa->device) || (!uaa->iface)) {
 187                 ermsg = "device or iface";
 188                 goto nobulk;
 189         }
 190         sc->sc_iface = iface = uaa->iface;
 191         sc->sc_opened = 0;
 192         sc->sc_pipeh_in = 0;
 193         sc->sc_pipeh_out = 0;
 194         sc->sc_refcnt = 0;
 195
 196         r = usbd_endpoint_count(iface, &epcount);
 197         if (r != USBD_NORMAL_COMPLETION) {
 198                 ermsg = "endpoints";
 199                 goto nobulk;
 200         }
 201
 202         sc->sc_epaddr[RIO_OUT] = 0xff;
 203         sc->sc_epaddr[RIO_IN] = 0x00;
 204
 205         for (i = 0; i < epcount; i++) {
 206                 usb_endpoint_descriptor_t *edesc =
 207                         usbd_interface2endpoint_descriptor(iface, i);
 208                 int d;
 209
 210                 if (!edesc) {
 211                         ermsg = "interface endpoint";
 212                         goto nobulk;
 213                 }
 214
 215                 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
 216                 if (d != RIO_NODIR)
 217                         sc->sc_epaddr[d] = edesc->bEndpointAddress;
 218         }
 219         if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
 220              sc->sc_epaddr[RIO_IN] == 0x00) {
 221                 ermsg = "Rio I&O";
 222                 goto nobulk;
 223         }
 224
 225         dev_ops_add(&urio_ops, -1, device_get_unit(self));
 226         make_dev(&urio_ops, device_get_unit(self),
 227                         UID_ROOT, GID_OPERATOR,
 228                         0644, "urio%d", device_get_unit(self));
 229
 230         DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
 231
 232         return 0;
 233
 234  nobulk:
 235         kprintf("%s: could not find %s\n", device_get_nameunit(sc->sc_dev),ermsg);
 236         return ENXIO;
 237 }
 238
 239
 240 int
 241 urioopen(struct dev_open_args *ap)
 242 {
 243         cdev_t dev = ap->a_head.a_dev;
 244 #if (USBDI >= 1)
 245         struct urio_softc * sc;
 246 #endif
 247         int unit = URIOUNIT(dev);
 248         sc = devclass_get_softc(urio_devclass, unit);
 249         if (sc == NULL)
 250                 return (ENXIO);
 251
 252         DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
 253                      ap->a_oflags, ap->a_devtype, unit));
 254
 255         if (sc->sc_opened)
 256                 return EBUSY;
 257
 258         if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
 259                 return EACCES;
 260
 261         sc->sc_opened = 1;
 262         sc->sc_pipeh_in = 0;
 263         sc->sc_pipeh_out = 0;
 264         if (usbd_open_pipe(sc->sc_iface,
 265                 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
 266                         != USBD_NORMAL_COMPLETION)
 267         {
 268                         sc->sc_pipeh_in = 0;
 269                         return EIO;
 270         };
 271         if (usbd_open_pipe(sc->sc_iface,
 272                 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
 273                         != USBD_NORMAL_COMPLETION)
 274         {
 275                         usbd_close_pipe(sc->sc_pipeh_in);
 276                         sc->sc_pipeh_in = 0;
 277                         sc->sc_pipeh_out = 0;
 278                         return EIO;
 279         };
 280         return 0;
 281 }
 282
 283 int
 284 urioclose(struct dev_close_args *ap)
 285 {
 286         cdev_t dev = ap->a_head.a_dev;
 287 #if (USBDI >= 1)
 288         struct urio_softc * sc;
 289 #endif
 290         int unit = URIOUNIT(dev);
 291         sc = devclass_get_softc(urio_devclass, unit);
 292
 293         DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n",
 294                 ap->a_fflag, ap->a_devtype, unit));
 295         if (sc->sc_pipeh_in)
 296                 usbd_close_pipe(sc->sc_pipeh_in);
 297
 298         if (sc->sc_pipeh_out)
 299                 usbd_close_pipe(sc->sc_pipeh_out);
 300
 301         sc->sc_pipeh_in = 0;
 302         sc->sc_pipeh_out = 0;
 303         sc->sc_opened = 0;
 304         sc->sc_refcnt = 0;
 305         return 0;
 306 }
 307
 308 int
 309 urioread(struct dev_read_args *ap)
 310 {
 311         cdev_t dev = ap->a_head.a_dev;
 312         struct uio *uio = ap->a_uio;
 313 #if (USBDI >= 1)
 314         struct urio_softc * sc;
 315         usbd_xfer_handle reqh;
 316 #else
 317         usbd_request_handle reqh;
 318         usbd_private_handle r_priv;
 319         void *r_buff;
 320         usbd_status r_status;
 321 #endif
 322         int unit = URIOUNIT(dev);
 323         usbd_status r;
 324         char buf[URIO_BBSIZE];
 325         u_int32_t n, tn;
 326         int error = 0;
 327
 328         sc = devclass_get_softc(urio_devclass, unit);
 329
 330         DPRINTFN(5, ("urioread: %d\n", unit));
 331         if (!sc->sc_opened)
 332                 return EIO;
 333
 334 #if (USBDI >= 1)
 335         sc->sc_refcnt++;
 336         reqh = usbd_alloc_xfer(sc->sc_udev);
 337 #else
 338         reqh = usbd_alloc_request();
 339 #endif
 340         if (reqh == 0)
 341                 return ENOMEM;
 342         while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
 343                 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
 344                 tn = n;
 345 #if (USBDI >= 1)
 346                 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
 347                                        0, RIO_RW_TIMEOUT, 0);
 348 #else
 349                 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
 350                                        0, RIO_RW_TIMEOUT, 0);
 351                 if (r != USBD_NORMAL_COMPLETION) {
 352                         error = EIO;
 353                         break;
 354                 }
 355 #endif
 356                 r = usbd_sync_transfer(reqh);
 357                 if (r != USBD_NORMAL_COMPLETION) {
 358                         DPRINTFN(1, ("urioread: error=%d\n", r));
 359                         usbd_clear_endpoint_stall(sc->sc_pipeh_in);
 360                         tn = 0;
 361                         error = EIO;
 362                         break;
 363                 }
 364 #if (USBDI >= 1)
 365                 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
 366 #else
 367                 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
 368 #endif
 369
 370                 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
 371                 error = uiomove(buf, tn, uio);
 372                 if (error || tn < n)
 373                         break;
 374         }
 375 #if (USBDI >= 1)
 376         usbd_free_xfer(reqh);
 377 #else
 378         usbd_free_request(reqh);
 379 #endif
 380
 381         return error;
 382 }
 383
 384 int
 385 uriowrite(struct dev_write_args *ap)
 386 {
 387         cdev_t dev = ap->a_head.a_dev;
 388         struct uio *uio = ap->a_uio;
 389 #if (USBDI >= 1)
 390         struct urio_softc * sc;
 391         usbd_xfer_handle reqh;
 392 #else
 393         usbd_request_handle reqh;
 394 #endif
 395         int unit = URIOUNIT(dev);
 396         usbd_status r;
 397         char buf[URIO_BBSIZE];
 398         u_int32_t n;
 399         int error = 0;
 400
 401         sc = devclass_get_softc(urio_devclass, unit);
 402
 403         DPRINTFN(5, ("uriowrite: %d\n", unit));
 404         if (!sc->sc_opened)
 405                 return EIO;
 406
 407 #if (USBDI >= 1)
 408         sc->sc_refcnt++;
 409         reqh = usbd_alloc_xfer(sc->sc_udev);
 410 #else
 411         reqh = usbd_alloc_request();
 412 #endif
 413         if (reqh == 0)
 414                 return EIO;
 415         while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
 416                 error = uiomove(buf, n, uio);
 417                 if (error)
 418                         break;
 419                 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
 420 #if (USBDI >= 1)
 421                 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
 422                                        0, RIO_RW_TIMEOUT, 0);
 423 #else
 424                 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
 425                                        0, RIO_RW_TIMEOUT, 0);
 426                 if (r != USBD_NORMAL_COMPLETION) {
 427                         error = EIO;
 428                         break;
 429                 }
 430 #endif
 431                 r = usbd_sync_transfer(reqh);
 432                 if (r != USBD_NORMAL_COMPLETION) {
 433                         DPRINTFN(1, ("uriowrite: error=%d\n", r));
 434                         usbd_clear_endpoint_stall(sc->sc_pipeh_out);
 435                         error = EIO;
 436                         break;
 437                 }
 438 #if (USBDI >= 1)
 439                 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
 440 #endif
 441         }
 442
 443 #if (USBDI >= 1)
 444         usbd_free_xfer(reqh);
 445 #else
 446         usbd_free_request(reqh);
 447 #endif
 448
 449         return error;
 450 }
 451
 452
 453 int
 454 urioioctl(struct dev_ioctl_args *ap)
 455 {
 456         cdev_t dev = ap->a_head.a_dev;
 457 #if (USBDI >= 1)
 458         struct urio_softc * sc;
 459 #endif
 460         int unit = URIOUNIT(dev);
 461         struct RioCommand *rio_cmd;
 462         int requesttype, len;
 463         struct iovec iov;
 464         struct uio uio;
 465         usb_device_request_t req;
 466         int req_flags = 0, req_actlen = 0;
 467         void *ptr = 0;
 468         int error = 0;
 469         usbd_status r;
 470
 471         sc = devclass_get_softc(urio_devclass, unit);
 472
 473         switch (ap->a_cmd) {
 474         case RIO_RECV_COMMAND:
 475                 if (!(ap->a_fflag & FWRITE))
 476                         return EPERM;
 477                 rio_cmd = (struct RioCommand *)ap->a_data;
 478                 if (rio_cmd == NULL)
 479                         return EINVAL;
 480                 len = rio_cmd->length;
 481
 482                 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
 483                 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
 484                         requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
 485                 break;
 486
 487         case RIO_SEND_COMMAND:
 488                 if (!(ap->a_fflag & FWRITE))
 489                         return EPERM;
 490                 rio_cmd = (struct RioCommand *)ap->a_data;
 491                 if (rio_cmd == NULL)
 492                         return EINVAL;
 493                 len = rio_cmd->length;
 494
 495                 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
 496                 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
 497                         requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
 498                 break;
 499
 500         default:
 501                 return EINVAL;
 502                 break;
 503         }
 504
 505         /* Send rio control message */
 506         req.bmRequestType = requesttype;
 507         req.bRequest = rio_cmd->request;
 508         USETW(req.wValue, rio_cmd->value);
 509         USETW(req.wIndex, rio_cmd->index);
 510         USETW(req.wLength, len);
 511
 512         if (len < 0 || len > 32767)
 513                 return EINVAL;
 514         if (len != 0) {
 515                 iov.iov_base = (caddr_t)rio_cmd->buffer;
 516                 iov.iov_len = len;
 517                 uio.uio_iov = &iov;
 518                 uio.uio_iovcnt = 1;
 519                 uio.uio_resid = len;
 520                 uio.uio_offset = 0;
 521                 uio.uio_segflg = UIO_USERSPACE;
 522                 uio.uio_rw =
 523                         req.bmRequestType & UT_READ ?
 524                         UIO_READ : UIO_WRITE;
 525                 uio.uio_td = curthread;
 526                 ptr = kmalloc(len, M_TEMP, M_WAITOK);
 527                 if (uio.uio_rw == UIO_WRITE) {
 528                         error = uiomove(ptr, len, &uio);
 529                         if (error)
 530                                 goto ret;
 531                 }
 532         }
 533
 534         r = usbd_do_request_flags(sc->sc_udev, &req,
 535                                   ptr, req_flags, &req_actlen,
 536                                   USBD_DEFAULT_TIMEOUT);
 537         if (r == USBD_NORMAL_COMPLETION) {
 538                 error = 0;
 539                 if (len != 0) {
 540                         if (uio.uio_rw == UIO_READ) {
 541                                 error = uiomove(ptr, len, &uio);
 542                         }
 543                 }
 544         } else {
 545                 error = EIO;
 546         }
 547
 548 ret:
 549         if (ptr)
 550                 kfree(ptr, M_TEMP);
 551         return error;
 552 }
 553
 554 static int
 555 urio_detach(device_t self)
 556 {
 557         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
 558         dev_ops_remove(&urio_ops, -1, device_get_unit(self));
 559         /* XXX not implemented yet */
 560         device_set_desc(self, NULL);
 561         return 0;
 562 }
 563
 564 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);
 565