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
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.23 2007/08/07 10:42:41 hasso Exp $
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.
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>
54 #include <sys/ioccom.h>
55 #include <sys/fcntl.h>
56 #include <sys/filio.h>
61 #include <sys/select.h>
63 #include <sys/sysctl.h>
65 #include <sys/thread2.h>
67 #include <bus/usb/usb.h>
68 #include <bus/usb/usbdi.h>
69 #include <bus/usb/usbdi_util.h>
71 #include <bus/usb/usbdevs.h>
72 #include <bus/usb/rio500_usb.h>
75 #define DPRINTF(x) if (uriodebug) kprintf x
76 #define DPRINTFN(n,x) if (uriodebug>(n)) kprintf x
78 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
79 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
80 &uriodebug, 0, "urio debug level");
86 /* difference of usbd interface */
99 #define URIO_CDEV_MAJOR 143
101 static struct dev_ops urio_ops = {
102 { "urio", URIO_CDEV_MAJOR, 0 },
104 .d_close = urioclose,
106 .d_write = uriowrite,
107 .d_ioctl = urioioctl,
109 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
110 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
113 #define URIO_BBSIZE 1024
117 usbd_device_handle sc_udev;
118 usbd_interface_handle sc_iface;
121 usbd_pipe_handle sc_pipeh_in;
122 usbd_pipe_handle sc_pipeh_out;
128 #define URIOUNIT(n) (minor(n))
130 #define RIO_RW_TIMEOUT 4000 /* ms */
132 static device_probe_t urio_match;
133 static device_attach_t urio_attach;
134 static device_detach_t urio_detach;
136 static devclass_t urio_devclass;
138 static kobj_method_t urio_methods[] = {
139 DEVMETHOD(device_probe, urio_match),
140 DEVMETHOD(device_attach, urio_attach),
141 DEVMETHOD(device_detach, urio_detach),
145 static driver_t urio_driver = {
148 sizeof(struct urio_softc)
151 MODULE_DEPEND(urio, usb, 1, 1, 1);
154 urio_match(device_t self)
156 struct usb_attach_arg *uaa = device_get_ivars(self);
157 usb_device_descriptor_t *dd;
159 DPRINTFN(10,("urio_match\n"));
163 dd = usbd_get_device_descriptor(uaa->device);
166 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
167 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
168 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
169 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
170 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
171 return UMATCH_VENDOR_PRODUCT;
177 urio_attach(device_t self)
179 struct urio_softc *sc = device_get_softc(self);
180 struct usb_attach_arg *uaa = device_get_ivars(self);
182 usbd_device_handle udev;
183 usbd_interface_handle iface;
186 char * ermsg = "<none>";
189 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
190 usbd_devinfo(uaa->device, 0, devinfo);
192 device_set_desc_copy(self, devinfo);
193 kprintf("%s: %s\n", device_get_nameunit(sc->sc_dev), devinfo);
195 sc->sc_udev = udev = uaa->device;
197 if ((!uaa->device) || (!uaa->iface)) {
198 ermsg = "device or iface";
201 sc->sc_iface = iface = uaa->iface;
204 sc->sc_pipeh_out = 0;
207 r = usbd_endpoint_count(iface, &epcount);
208 if (r != USBD_NORMAL_COMPLETION) {
213 sc->sc_epaddr[RIO_OUT] = 0xff;
214 sc->sc_epaddr[RIO_IN] = 0x00;
216 for (i = 0; i < epcount; i++) {
217 usb_endpoint_descriptor_t *edesc =
218 usbd_interface2endpoint_descriptor(iface, i);
222 ermsg = "interface endpoint";
226 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
228 sc->sc_epaddr[d] = edesc->bEndpointAddress;
230 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
231 sc->sc_epaddr[RIO_IN] == 0x00) {
236 dev_ops_add(&urio_ops, -1, device_get_unit(self));
237 make_dev(&urio_ops, device_get_unit(self),
238 UID_ROOT, GID_OPERATOR,
239 0644, "urio%d", device_get_unit(self));
241 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
246 kprintf("%s: could not find %s\n", device_get_nameunit(sc->sc_dev),ermsg);
252 urioopen(struct dev_open_args *ap)
254 cdev_t dev = ap->a_head.a_dev;
256 struct urio_softc * sc;
258 int unit = URIOUNIT(dev);
259 sc = devclass_get_softc(urio_devclass, unit);
263 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
264 ap->a_oflags, ap->a_devtype, unit));
269 if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
274 sc->sc_pipeh_out = 0;
275 if (usbd_open_pipe(sc->sc_iface,
276 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
277 != USBD_NORMAL_COMPLETION)
282 if (usbd_open_pipe(sc->sc_iface,
283 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
284 != USBD_NORMAL_COMPLETION)
286 usbd_close_pipe(sc->sc_pipeh_in);
288 sc->sc_pipeh_out = 0;
295 urioclose(struct dev_close_args *ap)
297 cdev_t dev = ap->a_head.a_dev;
299 struct urio_softc * sc;
301 int unit = URIOUNIT(dev);
302 sc = devclass_get_softc(urio_devclass, unit);
304 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n",
305 ap->a_fflag, ap->a_devtype, unit));
307 usbd_close_pipe(sc->sc_pipeh_in);
309 if (sc->sc_pipeh_out)
310 usbd_close_pipe(sc->sc_pipeh_out);
313 sc->sc_pipeh_out = 0;
320 urioread(struct dev_read_args *ap)
322 cdev_t dev = ap->a_head.a_dev;
323 struct uio *uio = ap->a_uio;
325 struct urio_softc * sc;
326 usbd_xfer_handle reqh;
328 usbd_request_handle reqh;
329 usbd_private_handle r_priv;
331 usbd_status r_status;
333 int unit = URIOUNIT(dev);
335 char buf[URIO_BBSIZE];
339 sc = devclass_get_softc(urio_devclass, unit);
341 DPRINTFN(5, ("urioread: %d\n", unit));
347 reqh = usbd_alloc_xfer(sc->sc_udev);
349 reqh = usbd_alloc_request();
353 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
354 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
357 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
358 0, RIO_RW_TIMEOUT, 0);
360 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
361 0, RIO_RW_TIMEOUT, 0);
362 if (r != USBD_NORMAL_COMPLETION) {
367 r = usbd_sync_transfer(reqh);
368 if (r != USBD_NORMAL_COMPLETION) {
369 DPRINTFN(1, ("urioread: error=%d\n", r));
370 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
376 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
378 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
381 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
382 error = uiomove(buf, tn, uio);
387 usbd_free_xfer(reqh);
389 usbd_free_request(reqh);
396 uriowrite(struct dev_write_args *ap)
398 cdev_t dev = ap->a_head.a_dev;
399 struct uio *uio = ap->a_uio;
401 struct urio_softc * sc;
402 usbd_xfer_handle reqh;
404 usbd_request_handle reqh;
406 int unit = URIOUNIT(dev);
408 char buf[URIO_BBSIZE];
412 sc = devclass_get_softc(urio_devclass, unit);
414 DPRINTFN(5, ("uriowrite: %d\n", unit));
420 reqh = usbd_alloc_xfer(sc->sc_udev);
422 reqh = usbd_alloc_request();
426 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
427 error = uiomove(buf, n, uio);
430 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
432 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
433 0, RIO_RW_TIMEOUT, 0);
435 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
436 0, RIO_RW_TIMEOUT, 0);
437 if (r != USBD_NORMAL_COMPLETION) {
442 r = usbd_sync_transfer(reqh);
443 if (r != USBD_NORMAL_COMPLETION) {
444 DPRINTFN(1, ("uriowrite: error=%d\n", r));
445 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
450 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
455 usbd_free_xfer(reqh);
457 usbd_free_request(reqh);
465 urioioctl(struct dev_ioctl_args *ap)
467 cdev_t dev = ap->a_head.a_dev;
469 struct urio_softc * sc;
471 int unit = URIOUNIT(dev);
472 struct RioCommand *rio_cmd;
473 int requesttype, len;
476 usb_device_request_t req;
477 int req_flags = 0, req_actlen = 0;
482 sc = devclass_get_softc(urio_devclass, unit);
485 case RIO_RECV_COMMAND:
486 if (!(ap->a_fflag & FWRITE))
488 rio_cmd = (struct RioCommand *)ap->a_data;
491 len = rio_cmd->length;
493 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
494 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
495 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
498 case RIO_SEND_COMMAND:
499 if (!(ap->a_fflag & FWRITE))
501 rio_cmd = (struct RioCommand *)ap->a_data;
504 len = rio_cmd->length;
506 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
507 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
508 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
516 /* Send rio control message */
517 req.bmRequestType = requesttype;
518 req.bRequest = rio_cmd->request;
519 USETW(req.wValue, rio_cmd->value);
520 USETW(req.wIndex, rio_cmd->index);
521 USETW(req.wLength, len);
523 if (len < 0 || len > 32767)
526 iov.iov_base = (caddr_t)rio_cmd->buffer;
532 uio.uio_segflg = UIO_USERSPACE;
534 req.bmRequestType & UT_READ ?
535 UIO_READ : UIO_WRITE;
536 uio.uio_td = curthread;
537 ptr = kmalloc(len, M_TEMP, M_WAITOK);
538 if (uio.uio_rw == UIO_WRITE) {
539 error = uiomove(ptr, len, &uio);
545 r = usbd_do_request_flags(sc->sc_udev, &req,
546 ptr, req_flags, &req_actlen,
547 USBD_DEFAULT_TIMEOUT);
548 if (r == USBD_NORMAL_COMPLETION) {
551 if (uio.uio_rw == UIO_READ) {
552 error = uiomove(ptr, len, &uio);
566 urio_detach(device_t self)
568 DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
569 dev_ops_remove(&urio_ops, -1, device_get_unit(self));
570 /* XXX not implemented yet */
571 device_set_desc(self, NULL);
575 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);