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