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 /* $FreeBSD: src/sys/dev/usb/urio.c,v 1.11.2.4 2002/11/06 14:41:01 joe Exp $ */
32 /* $DragonFly: src/sys/dev/usbmisc/urio/urio.c,v 1.2 2003/06/17 04:28:32 dillon Exp $ */
35 * 2000/3/24 added NetBSD/OpenBSD support (from Alex Nemirovsky)
36 * 2000/3/07 use two bulk-pipe handles for read and write (Dirk)
37 * 2000/3/06 change major number(143), and copyright header
38 * some fix for 4.0 (Dirk)
39 * 2000/3/05 codes for FreeBSD 4.x - CURRENT (Thanks to Dirk-Willem van Gulik)
40 * 2000/3/01 remove retry code from urioioctl()
41 * change method of bulk transfer (no interrupt)
42 * 2000/2/28 small fixes for new rio_usb.h
43 * 2000/2/24 first version.
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
50 #if defined(__NetBSD__)
51 #include <sys/device.h>
52 #include <sys/ioctl.h>
53 #elif defined(__FreeBSD__)
54 #include <sys/module.h>
56 #include <sys/ioccom.h>
58 #include <sys/fcntl.h>
59 #include <sys/filio.h>
64 #if __FreeBSD_version >= 500014
65 #include <sys/selinfo.h>
67 #include <sys/select.h>
69 #include <sys/vnode.h>
71 #include <sys/sysctl.h>
73 #include <dev/usb/usb.h>
74 #include <dev/usb/usbdi.h>
75 #include <dev/usb/usbdi_util.h>
77 #include <dev/usb/usbdevs.h>
78 #include <dev/usb/rio500_usb.h>
81 #define DPRINTF(x) if (uriodebug) logprintf x
82 #define DPRINTFN(n,x) if (uriodebug>(n)) logprintf x
84 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
85 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
86 &uriodebug, 0, "urio debug level");
92 /* difference of usbd interface */
93 #if defined(__FreeBSD__)
94 #if (__FreeBSD__ >= 4)
99 #elif defined(__NetBSD__) || defined(__OpenBSD__)
107 #if defined(__NetBSD__)
108 int urioopen(dev_t, int, int, usb_proc_ptr);
109 int urioclose(dev_t, int, int, usb_proc_ptr);
110 int urioread(dev_t, struct uio *uio, int);
111 int uriowrite(dev_t, struct uio *uio, int);
112 int urioioctl(dev_t, u_long, caddr_t, int, usb_proc_ptr);
115 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
116 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
118 #elif defined(__FreeBSD__)
125 #define URIO_CDEV_MAJOR 143
127 #if (__FreeBSD__ >= 4)
128 Static struct cdevsw urio_cdevsw = {
129 urioopen, urioclose, urioread, uriowrite,
130 urioioctl, nopoll, nommap, nostrategy,
131 "urio", URIO_CDEV_MAJOR,nodump, nopsize,
133 #if (__FreeBSD__ < 5)
137 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
138 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
141 Static struct cdevsw urio_cdevsw = {
142 urioopen, urioclose, urioread, uriowrite,
143 urioioctl, nostop, nullreset, nodevtotty,
144 seltrue, nommap, nostrat,
147 #define USBBASEDEVICE bdevice
148 #define RIO_UE_GET_DIR(p) UE_GET_IN(p)
151 #endif /*defined(__FreeBSD__)*/
153 #define URIO_BBSIZE 1024
156 USBBASEDEVICE sc_dev;
157 usbd_device_handle sc_udev;
158 usbd_interface_handle sc_iface;
161 usbd_pipe_handle sc_pipeh_in;
162 usbd_pipe_handle sc_pipeh_out;
166 #if defined(__NetBSD__) || defined(__OpenBSD__)
171 #define URIOUNIT(n) (minor(n))
173 #define RIO_RW_TIMEOUT 4000 /* ms */
175 USB_DECLARE_DRIVER(urio);
179 USB_MATCH_START(urio, uaa);
180 usb_device_descriptor_t *dd;
182 DPRINTFN(10,("urio_match\n"));
186 dd = usbd_get_device_descriptor(uaa->device);
189 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
190 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
191 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
192 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
193 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
194 return UMATCH_VENDOR_PRODUCT;
201 USB_ATTACH_START(urio, sc, uaa);
203 usbd_device_handle udev;
204 usbd_interface_handle iface;
206 #if defined(__NetBSD__) || defined(__OpenBSD__)
210 char * ermsg = "<none>";
213 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
214 usbd_devinfo(uaa->device, 0, devinfo);
216 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
218 sc->sc_udev = udev = uaa->device;
220 #if defined(__FreeBSD__)
221 if ((!uaa->device) || (!uaa->iface)) {
222 ermsg = "device or iface";
225 sc->sc_iface = iface = uaa->iface;
226 #elif defined(__NetBSD__) || defined(__OpenBSD__)
231 r = usbd_interface_count(udev, &niface);
236 r = usbd_device2interface_handle(udev, 0, &iface);
241 sc->sc_iface = iface;
245 sc->sc_pipeh_out = 0;
248 r = usbd_endpoint_count(iface, &epcount);
249 if (r != USBD_NORMAL_COMPLETION) {
254 sc->sc_epaddr[RIO_OUT] = 0xff;
255 sc->sc_epaddr[RIO_IN] = 0x00;
257 for (i = 0; i < epcount; i++) {
258 usb_endpoint_descriptor_t *edesc =
259 usbd_interface2endpoint_descriptor(iface, i);
263 ermsg = "interface endpoint";
267 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
269 sc->sc_epaddr[d] = edesc->bEndpointAddress;
271 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
272 sc->sc_epaddr[RIO_IN] == 0x00) {
277 #if defined(__FreeBSD__)
278 #if (__FreeBSD__ >= 4)
279 /* XXX no error trapping, no storing of dev_t */
280 (void) make_dev(&urio_cdevsw, device_get_unit(self),
281 UID_ROOT, GID_OPERATOR,
282 0644, "urio%d", device_get_unit(self));
284 #elif defined(__NetBSD__) || defined(__OpenBSD__)
285 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
289 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
291 USB_ATTACH_SUCCESS_RETURN;
294 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
295 USB_ATTACH_ERROR_RETURN;
300 urioopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
303 struct urio_softc * sc;
305 int unit = URIOUNIT(dev);
306 USB_GET_SC_OPEN(urio, unit, sc);
308 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
314 if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
319 sc->sc_pipeh_out = 0;
320 if (usbd_open_pipe(sc->sc_iface,
321 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
322 != USBD_NORMAL_COMPLETION)
327 if (usbd_open_pipe(sc->sc_iface,
328 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
329 != USBD_NORMAL_COMPLETION)
331 usbd_close_pipe(sc->sc_pipeh_in);
333 sc->sc_pipeh_out = 0;
340 urioclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
343 struct urio_softc * sc;
345 int unit = URIOUNIT(dev);
346 USB_GET_SC(urio, unit, sc);
348 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
350 usbd_close_pipe(sc->sc_pipeh_in);
352 if (sc->sc_pipeh_out)
353 usbd_close_pipe(sc->sc_pipeh_out);
356 sc->sc_pipeh_out = 0;
363 urioread(dev_t dev, struct uio *uio, int flag)
366 struct urio_softc * sc;
367 usbd_xfer_handle reqh;
369 usbd_request_handle reqh;
370 usbd_private_handle r_priv;
372 usbd_status r_status;
374 int unit = URIOUNIT(dev);
376 char buf[URIO_BBSIZE];
380 USB_GET_SC(urio, unit, sc);
382 DPRINTFN(5, ("urioread: %d\n", unit));
388 reqh = usbd_alloc_xfer(sc->sc_udev);
390 reqh = usbd_alloc_request();
394 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
395 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
398 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
399 0, RIO_RW_TIMEOUT, 0);
401 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
402 0, RIO_RW_TIMEOUT, 0);
403 if (r != USBD_NORMAL_COMPLETION) {
408 r = usbd_sync_transfer(reqh);
409 if (r != USBD_NORMAL_COMPLETION) {
410 DPRINTFN(1, ("urioread: error=%d\n", r));
411 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
417 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
419 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
422 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
423 error = uiomove(buf, tn, uio);
428 usbd_free_xfer(reqh);
430 usbd_free_request(reqh);
437 uriowrite(dev_t dev, struct uio *uio, int flag)
440 struct urio_softc * sc;
441 usbd_xfer_handle reqh;
443 usbd_request_handle reqh;
445 int unit = URIOUNIT(dev);
447 char buf[URIO_BBSIZE];
451 USB_GET_SC(urio, unit, sc);
453 DPRINTFN(5, ("uriowrite: %d\n", unit));
459 reqh = usbd_alloc_xfer(sc->sc_udev);
461 reqh = usbd_alloc_request();
465 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
466 error = uiomove(buf, n, uio);
469 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
471 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
472 0, RIO_RW_TIMEOUT, 0);
474 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
475 0, RIO_RW_TIMEOUT, 0);
476 if (r != USBD_NORMAL_COMPLETION) {
481 r = usbd_sync_transfer(reqh);
482 if (r != USBD_NORMAL_COMPLETION) {
483 DPRINTFN(1, ("uriowrite: error=%d\n", r));
484 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
489 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
494 usbd_free_xfer(reqh);
496 usbd_free_request(reqh);
504 urioioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
507 struct urio_softc * sc;
509 int unit = URIOUNIT(dev);
510 struct RioCommand *rio_cmd;
511 int requesttype, len;
514 usb_device_request_t req;
515 int req_flags = 0, req_actlen = 0;
520 USB_GET_SC(urio, unit, sc);
523 case RIO_RECV_COMMAND:
524 if (!(flag & FWRITE))
526 rio_cmd = (struct RioCommand *)addr;
529 len = rio_cmd->length;
531 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
532 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
533 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
536 case RIO_SEND_COMMAND:
537 if (!(flag & FWRITE))
539 rio_cmd = (struct RioCommand *)addr;
542 len = rio_cmd->length;
544 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
545 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
546 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
554 /* Send rio control message */
555 req.bmRequestType = requesttype;
556 req.bRequest = rio_cmd->request;
557 USETW(req.wValue, rio_cmd->value);
558 USETW(req.wIndex, rio_cmd->index);
559 USETW(req.wLength, len);
561 if (len < 0 || len > 32767)
564 iov.iov_base = (caddr_t)rio_cmd->buffer;
570 uio.uio_segflg = UIO_USERSPACE;
572 req.bmRequestType & UT_READ ?
573 UIO_READ : UIO_WRITE;
575 ptr = malloc(len, M_TEMP, M_WAITOK);
576 if (uio.uio_rw == UIO_WRITE) {
577 error = uiomove(ptr, len, &uio);
583 r = usbd_do_request_flags(sc->sc_udev, &req,
584 ptr, req_flags, &req_actlen);
585 if (r == USBD_NORMAL_COMPLETION) {
588 if (uio.uio_rw == UIO_READ) {
589 error = uiomove(ptr, len, &uio);
603 #if defined(__NetBSD__) || defined(__OpenBSD__)
605 urio_activate(device_ptr_t self, enum devact act)
607 struct urio_softc *sc = (struct urio_softc *)self;
614 case DVACT_DEACTIVATE:
623 USB_DETACH_START(urio, sc);
624 struct urio_endpoint *sce;
627 #if defined(__NetBSD__) || defined(__OpenBSD__)
630 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
631 #elif defined(__FreeBSD__)
632 DPRINTF(("urio_detach: sc=%p\n", sc));
636 /* Abort all pipes. Causes processes waiting for transfer to wake. */
638 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
639 for (dir = OUT; dir <= IN; dir++) {
640 sce = &sc->sc_endpoints[i][dir];
641 if (sce && sce->pipeh)
642 usbd_abort_pipe(sce->pipeh);
647 if (--sc->sc_refcnt >= 0) {
649 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
650 wakeup(&sc->sc_endpoints[i][IN]);
651 /* Wait for processes to go away. */
652 usb_detach_wait(USBDEV(sc->sc_dev));
657 usbd_abort_pipe(sc->sc_pipeh_in);
659 if (sc->sc_pipeh_out)
660 usbd_abort_pipe(sc->sc_pipeh_out);
663 if (--sc->sc_refcnt >= 0) {
664 /* Wait for processes to go away. */
665 usb_detach_wait(USBDEV(sc->sc_dev));
670 #if defined(__NetBSD__) || defined(__OpenBSD__)
671 /* locate the major number */
672 for (maj = 0; maj < nchrdev; maj++)
673 if (cdevsw[maj].d_open == urioopen)
676 /* Nuke the vnodes for any open instances (calls close). */
677 mn = self->dv_unit * USB_MAX_ENDPOINTS;
678 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
679 #elif defined(__FreeBSD__)
680 /* XXX not implemented yet */
683 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
688 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
690 #if defined(__FreeBSD__)
692 urio_detach(device_t self)
694 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
695 device_set_desc(self, NULL);
699 #if (__FreeBSD__ >= 4)
700 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);
702 CDEV_DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass,
703 URIO_CDEV_MAJOR, urio_cdevsw, usbd_driver_load, 0);