urio.c revision 227309
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: head/sys/dev/usb/storage/urio.c 227309 2011-11-07 15:43:11Z ed $"); 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 81static int urio_debug = 0; 82 83static SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio"); 84SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW, 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 97struct 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 113static device_probe_t urio_probe; 114static device_attach_t urio_attach; 115static device_detach_t urio_detach; 116 117static usb_callback_t urio_write_callback; 118static usb_callback_t urio_write_clear_stall_callback; 119static usb_callback_t urio_read_callback; 120static usb_callback_t urio_read_clear_stall_callback; 121 122static usb_fifo_close_t urio_close; 123static usb_fifo_cmd_t urio_start_read; 124static usb_fifo_cmd_t urio_start_write; 125static usb_fifo_cmd_t urio_stop_read; 126static usb_fifo_cmd_t urio_stop_write; 127static usb_fifo_ioctl_t urio_ioctl; 128static usb_fifo_open_t urio_open; 129 130static 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 141static 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 181static devclass_t urio_devclass; 182 183static 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 {0, 0} 189}; 190 191static driver_t urio_driver = { 192 .name = "urio", 193 .methods = urio_methods, 194 .size = sizeof(struct urio_softc), 195}; 196 197DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, NULL, 0); 198MODULE_DEPEND(urio, usb, 1, 1, 1); 199MODULE_VERSION(urio, 1); 200 201static const STRUCT_USB_HOST_ID urio_devs[] = { 202 {USB_VPI(USB_VENDOR_DIAMOND, USB_PRODUCT_DIAMOND_RIO500USB, 0)}, 203 {USB_VPI(USB_VENDOR_DIAMOND2, USB_PRODUCT_DIAMOND2_RIO600USB, 0)}, 204 {USB_VPI(USB_VENDOR_DIAMOND2, USB_PRODUCT_DIAMOND2_RIO800USB, 0)}, 205}; 206 207static int 208urio_probe(device_t dev) 209{ 210 struct usb_attach_arg *uaa = device_get_ivars(dev); 211 212 if (uaa->usb_mode != USB_MODE_HOST) 213 return (ENXIO); 214 if (uaa->info.bConfigIndex != 0) 215 return (ENXIO); 216 if (uaa->info.bIfaceIndex != 0) 217 return (ENXIO); 218 219 return (usbd_lookup_id_by_uaa(urio_devs, sizeof(urio_devs), uaa)); 220} 221 222static int 223urio_attach(device_t dev) 224{ 225 struct usb_attach_arg *uaa = device_get_ivars(dev); 226 struct urio_softc *sc = device_get_softc(dev); 227 int error; 228 229 device_set_usb_desc(dev); 230 231 sc->sc_udev = uaa->device; 232 233 mtx_init(&sc->sc_mtx, "urio lock", NULL, MTX_DEF | MTX_RECURSE); 234 235 snprintf(sc->sc_name, sizeof(sc->sc_name), 236 "%s", device_get_nameunit(dev)); 237 238 error = usbd_transfer_setup(uaa->device, 239 &uaa->info.bIfaceIndex, sc->sc_xfer, 240 urio_config, URIO_T_MAX, sc, &sc->sc_mtx); 241 242 if (error) { 243 DPRINTF("error=%s\n", usbd_errstr(error)); 244 goto detach; 245 } 246 247 error = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx, 248 &urio_fifo_methods, &sc->sc_fifo, 249 device_get_unit(dev), 0 - 1, uaa->info.bIfaceIndex, 250 UID_ROOT, GID_OPERATOR, 0644); 251 if (error) { 252 goto detach; 253 } 254 return (0); /* success */ 255 256detach: 257 urio_detach(dev); 258 return (ENOMEM); /* failure */ 259} 260 261static void 262urio_write_callback(struct usb_xfer *xfer, usb_error_t error) 263{ 264 struct urio_softc *sc = usbd_xfer_softc(xfer); 265 struct usb_fifo *f = sc->sc_fifo.fp[USB_FIFO_TX]; 266 struct usb_page_cache *pc; 267 uint32_t actlen; 268 269 switch (USB_GET_STATE(xfer)) { 270 case USB_ST_TRANSFERRED: 271 case USB_ST_SETUP: 272 if (sc->sc_flags & URIO_FLAG_WRITE_STALL) { 273 usbd_transfer_start(sc->sc_xfer[URIO_T_WR_CS]); 274 return; 275 } 276 pc = usbd_xfer_get_frame(xfer, 0); 277 if (usb_fifo_get_data(f, pc, 0, 278 usbd_xfer_max_len(xfer), &actlen, 0)) { 279 280 usbd_xfer_set_frame_len(xfer, 0, actlen); 281 usbd_transfer_submit(xfer); 282 } 283 return; 284 285 default: /* Error */ 286 if (error != USB_ERR_CANCELLED) { 287 /* try to clear stall first */ 288 sc->sc_flags |= URIO_FLAG_WRITE_STALL; 289 usbd_transfer_start(sc->sc_xfer[URIO_T_WR_CS]); 290 } 291 return; 292 } 293} 294 295static void 296urio_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error) 297{ 298 struct urio_softc *sc = usbd_xfer_softc(xfer); 299 struct usb_xfer *xfer_other = sc->sc_xfer[URIO_T_WR]; 300 301 if (usbd_clear_stall_callback(xfer, xfer_other)) { 302 DPRINTF("stall cleared\n"); 303 sc->sc_flags &= ~URIO_FLAG_WRITE_STALL; 304 usbd_transfer_start(xfer_other); 305 } 306} 307 308static void 309urio_read_callback(struct usb_xfer *xfer, usb_error_t error) 310{ 311 struct urio_softc *sc = usbd_xfer_softc(xfer); 312 struct usb_fifo *f = sc->sc_fifo.fp[USB_FIFO_RX]; 313 struct usb_page_cache *pc; 314 int actlen; 315 316 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 317 318 switch (USB_GET_STATE(xfer)) { 319 case USB_ST_TRANSFERRED: 320 pc = usbd_xfer_get_frame(xfer, 0); 321 usb_fifo_put_data(f, pc, 0, actlen, 1); 322 323 case USB_ST_SETUP: 324 if (sc->sc_flags & URIO_FLAG_READ_STALL) { 325 usbd_transfer_start(sc->sc_xfer[URIO_T_RD_CS]); 326 return; 327 } 328 if (usb_fifo_put_bytes_max(f) != 0) { 329 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 330 usbd_transfer_submit(xfer); 331 } 332 return; 333 334 default: /* Error */ 335 if (error != USB_ERR_CANCELLED) { 336 /* try to clear stall first */ 337 sc->sc_flags |= URIO_FLAG_READ_STALL; 338 usbd_transfer_start(sc->sc_xfer[URIO_T_RD_CS]); 339 } 340 return; 341 } 342} 343 344static void 345urio_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error) 346{ 347 struct urio_softc *sc = usbd_xfer_softc(xfer); 348 struct usb_xfer *xfer_other = sc->sc_xfer[URIO_T_RD]; 349 350 if (usbd_clear_stall_callback(xfer, xfer_other)) { 351 DPRINTF("stall cleared\n"); 352 sc->sc_flags &= ~URIO_FLAG_READ_STALL; 353 usbd_transfer_start(xfer_other); 354 } 355} 356 357static void 358urio_start_read(struct usb_fifo *fifo) 359{ 360 struct urio_softc *sc = usb_fifo_softc(fifo); 361 362 usbd_transfer_start(sc->sc_xfer[URIO_T_RD]); 363} 364 365static void 366urio_stop_read(struct usb_fifo *fifo) 367{ 368 struct urio_softc *sc = usb_fifo_softc(fifo); 369 370 usbd_transfer_stop(sc->sc_xfer[URIO_T_RD_CS]); 371 usbd_transfer_stop(sc->sc_xfer[URIO_T_RD]); 372} 373 374static void 375urio_start_write(struct usb_fifo *fifo) 376{ 377 struct urio_softc *sc = usb_fifo_softc(fifo); 378 379 usbd_transfer_start(sc->sc_xfer[URIO_T_WR]); 380} 381 382static void 383urio_stop_write(struct usb_fifo *fifo) 384{ 385 struct urio_softc *sc = usb_fifo_softc(fifo); 386 387 usbd_transfer_stop(sc->sc_xfer[URIO_T_WR_CS]); 388 usbd_transfer_stop(sc->sc_xfer[URIO_T_WR]); 389} 390 391static int 392urio_open(struct usb_fifo *fifo, int fflags) 393{ 394 struct urio_softc *sc = usb_fifo_softc(fifo); 395 396 if (fflags & FREAD) { 397 /* clear stall first */ 398 mtx_lock(&sc->sc_mtx); 399 sc->sc_flags |= URIO_FLAG_READ_STALL; 400 mtx_unlock(&sc->sc_mtx); 401 402 if (usb_fifo_alloc_buffer(fifo, 403 usbd_xfer_max_len(sc->sc_xfer[URIO_T_RD]), 404 URIO_IFQ_MAXLEN)) { 405 return (ENOMEM); 406 } 407 } 408 if (fflags & FWRITE) { 409 /* clear stall first */ 410 sc->sc_flags |= URIO_FLAG_WRITE_STALL; 411 412 if (usb_fifo_alloc_buffer(fifo, 413 usbd_xfer_max_len(sc->sc_xfer[URIO_T_WR]), 414 URIO_IFQ_MAXLEN)) { 415 return (ENOMEM); 416 } 417 } 418 return (0); /* success */ 419} 420 421static void 422urio_close(struct usb_fifo *fifo, int fflags) 423{ 424 if (fflags & (FREAD | FWRITE)) { 425 usb_fifo_free_buffer(fifo); 426 } 427} 428 429static int 430urio_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, 431 int fflags) 432{ 433 struct usb_ctl_request ur; 434 struct RioCommand *rio_cmd; 435 int error; 436 437 switch (cmd) { 438 case RIO_RECV_COMMAND: 439 if (!(fflags & FWRITE)) { 440 error = EPERM; 441 goto done; 442 } 443 bzero(&ur, sizeof(ur)); 444 rio_cmd = addr; 445 ur.ucr_request.bmRequestType = 446 rio_cmd->requesttype | UT_READ_VENDOR_DEVICE; 447 break; 448 449 case RIO_SEND_COMMAND: 450 if (!(fflags & FWRITE)) { 451 error = EPERM; 452 goto done; 453 } 454 bzero(&ur, sizeof(ur)); 455 rio_cmd = addr; 456 ur.ucr_request.bmRequestType = 457 rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE; 458 break; 459 460 default: 461 error = EINVAL; 462 goto done; 463 } 464 465 DPRINTFN(2, "Sending command\n"); 466 467 /* Send rio control message */ 468 ur.ucr_request.bRequest = rio_cmd->request; 469 USETW(ur.ucr_request.wValue, rio_cmd->value); 470 USETW(ur.ucr_request.wIndex, rio_cmd->index); 471 USETW(ur.ucr_request.wLength, rio_cmd->length); 472 ur.ucr_data = rio_cmd->buffer; 473 474 /* reuse generic USB code */ 475 error = ugen_do_request(fifo, &ur); 476 477done: 478 return (error); 479} 480 481static int 482urio_detach(device_t dev) 483{ 484 struct urio_softc *sc = device_get_softc(dev); 485 486 DPRINTF("\n"); 487 488 usb_fifo_detach(&sc->sc_fifo); 489 490 usbd_transfer_unsetup(sc->sc_xfer, URIO_T_MAX); 491 492 mtx_destroy(&sc->sc_mtx); 493 494 return (0); 495} 496