sys/dev/usb/storage/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 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34
  35 /*
  36  * 2000/3/24  added NetBSD/OpenBSD support (from Alex Nemirovsky)
  37  * 2000/3/07  use two bulk-pipe handles for read and write (Dirk)
  38  * 2000/3/06  change major number(143), and copyright header
  39  *            some fix for 4.0 (Dirk)
  40  * 2000/3/05  codes for FreeBSD 4.x - CURRENT (Thanks to Dirk-Willem van Gulik)
  41  * 2000/3/01  remove retry code from urioioctl()
  42  *            change method of bulk transfer (no interrupt)
  43  * 2000/2/28  small fixes for new rio_usb.h
  44  * 2000/2/24  first version.
  45  */
  46
  47 #include <sys/stdint.h>
  48 #include <sys/stddef.h>
  49 #include <sys/param.h>
  50 #include <sys/queue.h>
  51 #include <sys/types.h>
  52 #include <sys/systm.h>
  53 #include <sys/kernel.h>
  54 #include <sys/bus.h>
  55 #include <sys/module.h>
  56 #include <sys/lock.h>
  57 #include <sys/mutex.h>
  58 #include <sys/condvar.h>
  59 #include <sys/sysctl.h>
  60 #include <sys/sx.h>
  61 #include <sys/unistd.h>
  62 #include <sys/callout.h>
  63 #include <sys/malloc.h>
  64 #include <sys/priv.h>
  65 #include <sys/conf.h>
  66 #include <sys/fcntl.h>
  67
  68 #include <dev/usb/usb.h>
  69 #include <dev/usb/usbdi.h>
  70 #include "usbdevs.h"
  71
  72 #include <dev/usb/usb_ioctl.h>
  73 #include <dev/usb/usb_generic.h>
  74
  75 #define USB_DEBUG_VAR urio_debug
  76 #include <dev/usb/usb_debug.h>
  77
  78 #include <dev/usb/storage/rio500_usb.h>
  79
  80 #ifdef USB_DEBUG
  81 static int urio_debug = 0;
  82
  83 static SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
  84 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RWTUN,
  85     &urio_debug, 0, "urio debug level");
  86 #endif
  87
  88 #define URIO_T_WR     0
  89 #define URIO_T_RD     1
  90 #define URIO_T_WR_CS  2
  91 #define URIO_T_RD_CS  3
  92 #define URIO_T_MAX    4
  93
  94 #define URIO_BSIZE      (1<<12)         /* bytes */
  95 #define URIO_IFQ_MAXLEN      2          /* units */
  96
  97 struct urio_softc {
  98         struct usb_fifo_sc sc_fifo;
  99         struct mtx sc_mtx;
 100
 101         struct usb_device *sc_udev;
 102         struct usb_xfer *sc_xfer[URIO_T_MAX];
 103
 104         uint8_t sc_flags;
 105 #define URIO_FLAG_READ_STALL    0x01    /* read transfer stalled */
 106 #define URIO_FLAG_WRITE_STALL   0x02    /* write transfer stalled */
 107
 108         uint8_t sc_name[16];
 109 };
 110
 111 /* prototypes */
 112
 113 static device_probe_t urio_probe;
 114 static device_attach_t urio_attach;
 115 static device_detach_t urio_detach;
 116
 117 static usb_callback_t urio_write_callback;
 118 static usb_callback_t urio_write_clear_stall_callback;
 119 static usb_callback_t urio_read_callback;
 120 static usb_callback_t urio_read_clear_stall_callback;
 121
 122 static usb_fifo_close_t urio_close;
 123 static usb_fifo_cmd_t urio_start_read;
 124 static usb_fifo_cmd_t urio_start_write;
 125 static usb_fifo_cmd_t urio_stop_read;
 126 static usb_fifo_cmd_t urio_stop_write;
 127 static usb_fifo_ioctl_t urio_ioctl;
 128 static usb_fifo_open_t urio_open;
 129
 130 static struct usb_fifo_methods urio_fifo_methods = {
 131         .f_close = &urio_close,
 132         .f_ioctl = &urio_ioctl,
 133         .f_open = &urio_open,
 134         .f_start_read = &urio_start_read,
 135         .f_start_write = &urio_start_write,
 136         .f_stop_read = &urio_stop_read,
 137         .f_stop_write = &urio_stop_write,
 138         .basename[0] = "urio",
 139 };
 140
 141 static const struct usb_config urio_config[URIO_T_MAX] = {
 142         [URIO_T_WR] = {
 143                 .type = UE_BULK,
 144                 .endpoint = UE_ADDR_ANY,
 145                 .direction = UE_DIR_OUT,
 146                 .bufsize = URIO_BSIZE,
 147                 .flags = {.pipe_bof = 1,.force_short_xfer = 1,.proxy_buffer = 1,},
 148                 .callback = &urio_write_callback,
 149         },
 150
 151         [URIO_T_RD] = {
 152                 .type = UE_BULK,
 153                 .endpoint = UE_ADDR_ANY,
 154                 .direction = UE_DIR_IN,
 155                 .bufsize = URIO_BSIZE,
 156                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,.proxy_buffer = 1,},
 157                 .callback = &urio_read_callback,
 158         },
 159
 160         [URIO_T_WR_CS] = {
 161                 .type = UE_CONTROL,
 162                 .endpoint = 0x00,       /* Control pipe */
 163                 .direction = UE_DIR_ANY,
 164                 .bufsize = sizeof(struct usb_device_request),
 165                 .callback = &urio_write_clear_stall_callback,
 166                 .timeout = 1000,        /* 1 second */
 167                 .interval = 50, /* 50ms */
 168         },
 169
 170         [URIO_T_RD_CS] = {
 171                 .type = UE_CONTROL,
 172                 .endpoint = 0x00,       /* Control pipe */
 173                 .direction = UE_DIR_ANY,
 174                 .bufsize = sizeof(struct usb_device_request),
 175                 .callback = &urio_read_clear_stall_callback,
 176                 .timeout = 1000,        /* 1 second */
 177                 .interval = 50, /* 50ms */
 178         },
 179 };
 180
 181 static devclass_t urio_devclass;
 182
 183 static device_method_t urio_methods[] = {
 184         /* Device interface */
 185         DEVMETHOD(device_probe, urio_probe),
 186         DEVMETHOD(device_attach, urio_attach),
 187         DEVMETHOD(device_detach, urio_detach),
 188
 189         DEVMETHOD_END
 190 };
 191
 192 static driver_t urio_driver = {
 193         .name = "urio",
 194         .methods = urio_methods,
 195         .size = sizeof(struct urio_softc),
 196 };
 197
 198 static const STRUCT_USB_HOST_ID urio_devs[] = {
 199         {USB_VPI(USB_VENDOR_DIAMOND, USB_PRODUCT_DIAMOND_RIO500USB, 0)},
 200         {USB_VPI(USB_VENDOR_DIAMOND2, USB_PRODUCT_DIAMOND2_RIO600USB, 0)},
 201         {USB_VPI(USB_VENDOR_DIAMOND2, USB_PRODUCT_DIAMOND2_RIO800USB, 0)},
 202 };
 203
 204 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, NULL, 0);
 205 MODULE_DEPEND(urio, usb, 1, 1, 1);
 206 MODULE_VERSION(urio, 1);
 207 USB_PNP_HOST_INFO(urio_devs);
 208
 209 static int
 210 urio_probe(device_t dev)
 211 {
 212         struct usb_attach_arg *uaa = device_get_ivars(dev);
 213
 214         if (uaa->usb_mode != USB_MODE_HOST)
 215                 return (ENXIO);
 216         if (uaa->info.bConfigIndex != 0)
 217                 return (ENXIO);
 218         if (uaa->info.bIfaceIndex != 0)
 219                 return (ENXIO);
 220
 221         return (usbd_lookup_id_by_uaa(urio_devs, sizeof(urio_devs), uaa));
 222 }
 223
 224 static int
 225 urio_attach(device_t dev)
 226 {
 227         struct usb_attach_arg *uaa = device_get_ivars(dev);
 228         struct urio_softc *sc = device_get_softc(dev);
 229         int error;
 230
 231         device_set_usb_desc(dev);
 232
 233         sc->sc_udev = uaa->device;
 234
 235         mtx_init(&sc->sc_mtx, "urio lock", NULL, MTX_DEF | MTX_RECURSE);
 236
 237         snprintf(sc->sc_name, sizeof(sc->sc_name),
 238             "%s", device_get_nameunit(dev));
 239
 240         error = usbd_transfer_setup(uaa->device,
 241             &uaa->info.bIfaceIndex, sc->sc_xfer,
 242             urio_config, URIO_T_MAX, sc, &sc->sc_mtx);
 243
 244         if (error) {
 245                 DPRINTF("error=%s\n", usbd_errstr(error));
 246                 goto detach;
 247         }
 248
 249         error = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx,
 250             &urio_fifo_methods, &sc->sc_fifo,
 251             device_get_unit(dev), -1, uaa->info.bIfaceIndex,
 252             UID_ROOT, GID_OPERATOR, 0644);
 253         if (error) {
 254                 goto detach;
 255         }
 256         return (0);                     /* success */
 257
 258 detach:
 259         urio_detach(dev);
 260         return (ENOMEM);                /* failure */
 261 }
 262
 263 static void
 264 urio_write_callback(struct usb_xfer *xfer, usb_error_t error)
 265 {
 266         struct urio_softc *sc = usbd_xfer_softc(xfer);
 267         struct usb_fifo *f = sc->sc_fifo.fp[USB_FIFO_TX];
 268         struct usb_page_cache *pc;
 269         uint32_t actlen;
 270
 271         switch (USB_GET_STATE(xfer)) {
 272         case USB_ST_TRANSFERRED:
 273         case USB_ST_SETUP:
 274                 if (sc->sc_flags & URIO_FLAG_WRITE_STALL) {
 275                         usbd_transfer_start(sc->sc_xfer[URIO_T_WR_CS]);
 276                         return;
 277                 }
 278                 pc = usbd_xfer_get_frame(xfer, 0);
 279                 if (usb_fifo_get_data(f, pc, 0,
 280                     usbd_xfer_max_len(xfer), &actlen, 0)) {
 281
 282                         usbd_xfer_set_frame_len(xfer, 0, actlen);
 283                         usbd_transfer_submit(xfer);
 284                 }
 285                 return;
 286
 287         default:                        /* Error */
 288                 if (error != USB_ERR_CANCELLED) {
 289                         /* try to clear stall first */
 290                         sc->sc_flags |= URIO_FLAG_WRITE_STALL;
 291                         usbd_transfer_start(sc->sc_xfer[URIO_T_WR_CS]);
 292                 }
 293                 return;
 294         }
 295 }
 296
 297 static void
 298 urio_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
 299 {
 300         struct urio_softc *sc = usbd_xfer_softc(xfer);
 301         struct usb_xfer *xfer_other = sc->sc_xfer[URIO_T_WR];
 302
 303         if (usbd_clear_stall_callback(xfer, xfer_other)) {
 304                 DPRINTF("stall cleared\n");
 305                 sc->sc_flags &= ~URIO_FLAG_WRITE_STALL;
 306                 usbd_transfer_start(xfer_other);
 307         }
 308 }
 309
 310 static void
 311 urio_read_callback(struct usb_xfer *xfer, usb_error_t error)
 312 {
 313         struct urio_softc *sc = usbd_xfer_softc(xfer);
 314         struct usb_fifo *f = sc->sc_fifo.fp[USB_FIFO_RX];
 315         struct usb_page_cache *pc;
 316         int actlen;
 317
 318         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 319
 320         switch (USB_GET_STATE(xfer)) {
 321         case USB_ST_TRANSFERRED:
 322                 pc = usbd_xfer_get_frame(xfer, 0);
 323                 usb_fifo_put_data(f, pc, 0, actlen, 1);
 324
 325         case USB_ST_SETUP:
 326                 if (sc->sc_flags & URIO_FLAG_READ_STALL) {
 327                         usbd_transfer_start(sc->sc_xfer[URIO_T_RD_CS]);
 328                         return;
 329                 }
 330                 if (usb_fifo_put_bytes_max(f) != 0) {
 331                         usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 332                         usbd_transfer_submit(xfer);
 333                 }
 334                 return;
 335
 336         default:                        /* Error */
 337                 if (error != USB_ERR_CANCELLED) {
 338                         /* try to clear stall first */
 339                         sc->sc_flags |= URIO_FLAG_READ_STALL;
 340                         usbd_transfer_start(sc->sc_xfer[URIO_T_RD_CS]);
 341                 }
 342                 return;
 343         }
 344 }
 345
 346 static void
 347 urio_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
 348 {
 349         struct urio_softc *sc = usbd_xfer_softc(xfer);
 350         struct usb_xfer *xfer_other = sc->sc_xfer[URIO_T_RD];
 351
 352         if (usbd_clear_stall_callback(xfer, xfer_other)) {
 353                 DPRINTF("stall cleared\n");
 354                 sc->sc_flags &= ~URIO_FLAG_READ_STALL;
 355                 usbd_transfer_start(xfer_other);
 356         }
 357 }
 358
 359 static void
 360 urio_start_read(struct usb_fifo *fifo)
 361 {
 362         struct urio_softc *sc = usb_fifo_softc(fifo);
 363
 364         usbd_transfer_start(sc->sc_xfer[URIO_T_RD]);
 365 }
 366
 367 static void
 368 urio_stop_read(struct usb_fifo *fifo)
 369 {
 370         struct urio_softc *sc = usb_fifo_softc(fifo);
 371
 372         usbd_transfer_stop(sc->sc_xfer[URIO_T_RD_CS]);
 373         usbd_transfer_stop(sc->sc_xfer[URIO_T_RD]);
 374 }
 375
 376 static void
 377 urio_start_write(struct usb_fifo *fifo)
 378 {
 379         struct urio_softc *sc = usb_fifo_softc(fifo);
 380
 381         usbd_transfer_start(sc->sc_xfer[URIO_T_WR]);
 382 }
 383
 384 static void
 385 urio_stop_write(struct usb_fifo *fifo)
 386 {
 387         struct urio_softc *sc = usb_fifo_softc(fifo);
 388
 389         usbd_transfer_stop(sc->sc_xfer[URIO_T_WR_CS]);
 390         usbd_transfer_stop(sc->sc_xfer[URIO_T_WR]);
 391 }
 392
 393 static int
 394 urio_open(struct usb_fifo *fifo, int fflags)
 395 {
 396         struct urio_softc *sc = usb_fifo_softc(fifo);
 397
 398         if (fflags & FREAD) {
 399                 /* clear stall first */
 400                 mtx_lock(&sc->sc_mtx);
 401                 sc->sc_flags |= URIO_FLAG_READ_STALL;
 402                 mtx_unlock(&sc->sc_mtx);
 403
 404                 if (usb_fifo_alloc_buffer(fifo,
 405                     usbd_xfer_max_len(sc->sc_xfer[URIO_T_RD]),
 406                     URIO_IFQ_MAXLEN)) {
 407                         return (ENOMEM);
 408                 }
 409         }
 410         if (fflags & FWRITE) {
 411                 /* clear stall first */
 412                 sc->sc_flags |= URIO_FLAG_WRITE_STALL;
 413
 414                 if (usb_fifo_alloc_buffer(fifo,
 415                     usbd_xfer_max_len(sc->sc_xfer[URIO_T_WR]),
 416                     URIO_IFQ_MAXLEN)) {
 417                         return (ENOMEM);
 418                 }
 419         }
 420         return (0);                     /* success */
 421 }
 422
 423 static void
 424 urio_close(struct usb_fifo *fifo, int fflags)
 425 {
 426         if (fflags & (FREAD | FWRITE)) {
 427                 usb_fifo_free_buffer(fifo);
 428         }
 429 }
 430
 431 static int
 432 urio_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr,
 433     int fflags)
 434 {
 435         struct usb_ctl_request ur;
 436         struct RioCommand *rio_cmd;
 437         int error;
 438
 439         switch (cmd) {
 440         case RIO_RECV_COMMAND:
 441                 if (!(fflags & FWRITE)) {
 442                         error = EPERM;
 443                         goto done;
 444                 }
 445                 memset(&ur, 0, sizeof(ur));
 446                 rio_cmd = addr;
 447                 ur.ucr_request.bmRequestType =
 448                     rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
 449                 break;
 450
 451         case RIO_SEND_COMMAND:
 452                 if (!(fflags & FWRITE)) {
 453                         error = EPERM;
 454                         goto done;
 455                 }
 456                 memset(&ur, 0, sizeof(ur));
 457                 rio_cmd = addr;
 458                 ur.ucr_request.bmRequestType =
 459                     rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
 460                 break;
 461
 462         default:
 463                 error = EINVAL;
 464                 goto done;
 465         }
 466
 467         DPRINTFN(2, "Sending command\n");
 468
 469         /* Send rio control message */
 470         ur.ucr_request.bRequest = rio_cmd->request;
 471         USETW(ur.ucr_request.wValue, rio_cmd->value);
 472         USETW(ur.ucr_request.wIndex, rio_cmd->index);
 473         USETW(ur.ucr_request.wLength, rio_cmd->length);
 474         ur.ucr_data = rio_cmd->buffer;
 475
 476         /* reuse generic USB code */
 477         error = ugen_do_request(fifo, &ur);
 478
 479 done:
 480         return (error);
 481 }
 482
 483 static int
 484 urio_detach(device_t dev)
 485 {
 486         struct urio_softc *sc = device_get_softc(dev);
 487
 488         DPRINTF("\n");
 489
 490         usb_fifo_detach(&sc->sc_fifo);
 491
 492         usbd_transfer_unsetup(sc->sc_xfer, URIO_T_MAX);
 493
 494         mtx_destroy(&sc->sc_mtx);
 495
 496         return (0);
 497 }