2 * Copyright (c) 2000 Iwasa Kazmi
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
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.
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>
55 #include <sys/module.h>
57 #include <sys/mutex.h>
58 #include <sys/condvar.h>
59 #include <sys/sysctl.h>
61 #include <sys/unistd.h>
62 #include <sys/callout.h>
63 #include <sys/malloc.h>
66 #include <sys/fcntl.h>
68 #include <dev/usb/usb.h>
69 #include <dev/usb/usbdi.h>
72 #include <dev/usb/usb_ioctl.h>
73 #include <dev/usb/usb_generic.h>
75 #define USB_DEBUG_VAR urio_debug
76 #include <dev/usb/usb_debug.h>
78 #include <dev/usb/storage/rio500_usb.h>
81 static int urio_debug = 0;
83 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
84 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
85 &urio_debug, 0, "urio debug level");
90 #define URIO_T_WR_CS 2
91 #define URIO_T_RD_CS 3
94 #define URIO_BSIZE (1<<12) /* bytes */
95 #define URIO_IFQ_MAXLEN 2 /* units */
98 struct usb_fifo_sc sc_fifo;
101 struct usb_device *sc_udev;
102 struct usb_xfer *sc_xfer[URIO_T_MAX];
105 #define URIO_FLAG_READ_STALL 0x01 /* read transfer stalled */
106 #define URIO_FLAG_WRITE_STALL 0x02 /* write transfer stalled */
113 static device_probe_t urio_probe;
114 static device_attach_t urio_attach;
115 static device_detach_t urio_detach;
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;
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;
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",
141 static const struct usb_config urio_config[URIO_T_MAX] = {
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,
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,
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 */
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 */
181 static devclass_t urio_devclass;
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),
191 static driver_t urio_driver = {
193 .methods = urio_methods,
194 .size = sizeof(struct urio_softc),
197 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, NULL, 0);
198 MODULE_DEPEND(urio, usb, 1, 1, 1);
199 MODULE_VERSION(urio, 1);
201 static 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)},
208 urio_probe(device_t dev)
210 struct usb_attach_arg *uaa = device_get_ivars(dev);
212 if (uaa->usb_mode != USB_MODE_HOST)
214 if (uaa->info.bConfigIndex != 0)
216 if (uaa->info.bIfaceIndex != 0)
219 return (usbd_lookup_id_by_uaa(urio_devs, sizeof(urio_devs), uaa));
223 urio_attach(device_t dev)
225 struct usb_attach_arg *uaa = device_get_ivars(dev);
226 struct urio_softc *sc = device_get_softc(dev);
229 device_set_usb_desc(dev);
231 sc->sc_udev = uaa->device;
233 mtx_init(&sc->sc_mtx, "urio lock", NULL, MTX_DEF | MTX_RECURSE);
235 snprintf(sc->sc_name, sizeof(sc->sc_name),
236 "%s", device_get_nameunit(dev));
238 error = usbd_transfer_setup(uaa->device,
239 &uaa->info.bIfaceIndex, sc->sc_xfer,
240 urio_config, URIO_T_MAX, sc, &sc->sc_mtx);
243 DPRINTF("error=%s\n", usbd_errstr(error));
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);
254 return (0); /* success */
258 return (ENOMEM); /* failure */
262 urio_write_callback(struct usb_xfer *xfer, usb_error_t error)
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;
269 switch (USB_GET_STATE(xfer)) {
270 case USB_ST_TRANSFERRED:
272 if (sc->sc_flags & URIO_FLAG_WRITE_STALL) {
273 usbd_transfer_start(sc->sc_xfer[URIO_T_WR_CS]);
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)) {
280 usbd_xfer_set_frame_len(xfer, 0, actlen);
281 usbd_transfer_submit(xfer);
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]);
296 urio_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
298 struct urio_softc *sc = usbd_xfer_softc(xfer);
299 struct usb_xfer *xfer_other = sc->sc_xfer[URIO_T_WR];
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);
309 urio_read_callback(struct usb_xfer *xfer, usb_error_t error)
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;
316 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
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);
324 if (sc->sc_flags & URIO_FLAG_READ_STALL) {
325 usbd_transfer_start(sc->sc_xfer[URIO_T_RD_CS]);
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);
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]);
345 urio_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
347 struct urio_softc *sc = usbd_xfer_softc(xfer);
348 struct usb_xfer *xfer_other = sc->sc_xfer[URIO_T_RD];
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);
358 urio_start_read(struct usb_fifo *fifo)
360 struct urio_softc *sc = usb_fifo_softc(fifo);
362 usbd_transfer_start(sc->sc_xfer[URIO_T_RD]);
366 urio_stop_read(struct usb_fifo *fifo)
368 struct urio_softc *sc = usb_fifo_softc(fifo);
370 usbd_transfer_stop(sc->sc_xfer[URIO_T_RD_CS]);
371 usbd_transfer_stop(sc->sc_xfer[URIO_T_RD]);
375 urio_start_write(struct usb_fifo *fifo)
377 struct urio_softc *sc = usb_fifo_softc(fifo);
379 usbd_transfer_start(sc->sc_xfer[URIO_T_WR]);
383 urio_stop_write(struct usb_fifo *fifo)
385 struct urio_softc *sc = usb_fifo_softc(fifo);
387 usbd_transfer_stop(sc->sc_xfer[URIO_T_WR_CS]);
388 usbd_transfer_stop(sc->sc_xfer[URIO_T_WR]);
392 urio_open(struct usb_fifo *fifo, int fflags)
394 struct urio_softc *sc = usb_fifo_softc(fifo);
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);
402 if (usb_fifo_alloc_buffer(fifo,
403 usbd_xfer_max_len(sc->sc_xfer[URIO_T_RD]),
408 if (fflags & FWRITE) {
409 /* clear stall first */
410 sc->sc_flags |= URIO_FLAG_WRITE_STALL;
412 if (usb_fifo_alloc_buffer(fifo,
413 usbd_xfer_max_len(sc->sc_xfer[URIO_T_WR]),
418 return (0); /* success */
422 urio_close(struct usb_fifo *fifo, int fflags)
424 if (fflags & (FREAD | FWRITE)) {
425 usb_fifo_free_buffer(fifo);
430 urio_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr,
433 struct usb_ctl_request ur;
434 struct RioCommand *rio_cmd;
438 case RIO_RECV_COMMAND:
439 if (!(fflags & FWRITE)) {
443 bzero(&ur, sizeof(ur));
445 ur.ucr_request.bmRequestType =
446 rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
449 case RIO_SEND_COMMAND:
450 if (!(fflags & FWRITE)) {
454 bzero(&ur, sizeof(ur));
456 ur.ucr_request.bmRequestType =
457 rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
465 DPRINTFN(2, "Sending command\n");
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;
474 /* reuse generic USB code */
475 error = ugen_do_request(fifo, &ur);
482 urio_detach(device_t dev)
484 struct urio_softc *sc = device_get_softc(dev);
488 usb_fifo_detach(&sc->sc_fifo);
490 usbd_transfer_unsetup(sc->sc_xfer, URIO_T_MAX);
492 mtx_destroy(&sc->sc_mtx);