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.6 2003/08/07 21:17:15 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>
74 #include <bus/usb/usb.h>
75 #include <bus/usb/usbdi.h>
76 #include <bus/usb/usbdi_util.h>
78 #include <bus/usb/usbdevs.h>
79 #include <bus/usb/rio500_usb.h>
82 #define DPRINTF(x) if (uriodebug) logprintf x
83 #define DPRINTFN(n,x) if (uriodebug>(n)) logprintf x
85 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
86 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
87 &uriodebug, 0, "urio debug level");
93 /* difference of usbd interface */
94 #if defined(__FreeBSD__)
95 #if (__FreeBSD__ >= 4)
100 #elif defined(__NetBSD__) || defined(__OpenBSD__)
108 #if defined(__NetBSD__)
109 int urioopen(dev_t, int, int, usb_proc_ptr);
110 int urioclose(dev_t, int, int, usb_proc_ptr);
111 int urioread(dev_t, struct uio *uio, int);
112 int uriowrite(dev_t, struct uio *uio, int);
113 int urioioctl(dev_t, u_long, caddr_t, int, usb_proc_ptr);
116 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
117 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
119 #elif defined(__FreeBSD__)
126 #define URIO_CDEV_MAJOR 143
128 #if (__FreeBSD__ >= 4)
129 Static struct cdevsw urio_cdevsw = {
131 /* cmaj */ URIO_CDEV_MAJOR,
135 urioopen, urioclose, urioread, uriowrite,
136 urioioctl, nopoll, nommap, nostrategy,
139 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
140 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
143 Static struct cdevsw urio_cdevsw = {
144 urioopen, urioclose, urioread, uriowrite,
145 urioioctl, nostop, nullreset, nodevtotty,
146 seltrue, nommap, nostrat,
149 #define USBBASEDEVICE bdevice
150 #define RIO_UE_GET_DIR(p) UE_GET_IN(p)
153 #endif /*defined(__FreeBSD__)*/
155 #define URIO_BBSIZE 1024
158 USBBASEDEVICE sc_dev;
159 usbd_device_handle sc_udev;
160 usbd_interface_handle sc_iface;
163 usbd_pipe_handle sc_pipeh_in;
164 usbd_pipe_handle sc_pipeh_out;
168 #if defined(__NetBSD__) || defined(__OpenBSD__)
173 #define URIOUNIT(n) (minor(n))
175 #define RIO_RW_TIMEOUT 4000 /* ms */
177 USB_DECLARE_DRIVER(urio);
181 USB_MATCH_START(urio, uaa);
182 usb_device_descriptor_t *dd;
184 DPRINTFN(10,("urio_match\n"));
188 dd = usbd_get_device_descriptor(uaa->device);
191 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
192 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
193 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
194 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
195 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
196 return UMATCH_VENDOR_PRODUCT;
203 USB_ATTACH_START(urio, sc, uaa);
205 usbd_device_handle udev;
206 usbd_interface_handle iface;
208 #if defined(__NetBSD__) || defined(__OpenBSD__)
212 char * ermsg = "<none>";
215 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
216 usbd_devinfo(uaa->device, 0, devinfo);
218 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
220 sc->sc_udev = udev = uaa->device;
222 #if defined(__FreeBSD__)
223 if ((!uaa->device) || (!uaa->iface)) {
224 ermsg = "device or iface";
227 sc->sc_iface = iface = uaa->iface;
228 #elif defined(__NetBSD__) || defined(__OpenBSD__)
233 r = usbd_interface_count(udev, &niface);
238 r = usbd_device2interface_handle(udev, 0, &iface);
243 sc->sc_iface = iface;
247 sc->sc_pipeh_out = 0;
250 r = usbd_endpoint_count(iface, &epcount);
251 if (r != USBD_NORMAL_COMPLETION) {
256 sc->sc_epaddr[RIO_OUT] = 0xff;
257 sc->sc_epaddr[RIO_IN] = 0x00;
259 for (i = 0; i < epcount; i++) {
260 usb_endpoint_descriptor_t *edesc =
261 usbd_interface2endpoint_descriptor(iface, i);
265 ermsg = "interface endpoint";
269 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
271 sc->sc_epaddr[d] = edesc->bEndpointAddress;
273 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
274 sc->sc_epaddr[RIO_IN] == 0x00) {
279 #if defined(__FreeBSD__)
280 #if (__FreeBSD__ >= 4)
281 /* XXX no error trapping, no storing of dev_t */
282 (void) make_dev(&urio_cdevsw, device_get_unit(self),
283 UID_ROOT, GID_OPERATOR,
284 0644, "urio%d", device_get_unit(self));
286 #elif defined(__NetBSD__) || defined(__OpenBSD__)
287 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
291 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
293 USB_ATTACH_SUCCESS_RETURN;
296 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
297 USB_ATTACH_ERROR_RETURN;
302 urioopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
305 struct urio_softc * sc;
307 int unit = URIOUNIT(dev);
308 USB_GET_SC_OPEN(urio, unit, sc);
310 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
316 if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
321 sc->sc_pipeh_out = 0;
322 if (usbd_open_pipe(sc->sc_iface,
323 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
324 != USBD_NORMAL_COMPLETION)
329 if (usbd_open_pipe(sc->sc_iface,
330 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
331 != USBD_NORMAL_COMPLETION)
333 usbd_close_pipe(sc->sc_pipeh_in);
335 sc->sc_pipeh_out = 0;
342 urioclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
345 struct urio_softc * sc;
347 int unit = URIOUNIT(dev);
348 USB_GET_SC(urio, unit, sc);
350 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
352 usbd_close_pipe(sc->sc_pipeh_in);
354 if (sc->sc_pipeh_out)
355 usbd_close_pipe(sc->sc_pipeh_out);
358 sc->sc_pipeh_out = 0;
365 urioread(dev_t dev, struct uio *uio, int flag)
368 struct urio_softc * sc;
369 usbd_xfer_handle reqh;
371 usbd_request_handle reqh;
372 usbd_private_handle r_priv;
374 usbd_status r_status;
376 int unit = URIOUNIT(dev);
378 char buf[URIO_BBSIZE];
382 USB_GET_SC(urio, unit, sc);
384 DPRINTFN(5, ("urioread: %d\n", unit));
390 reqh = usbd_alloc_xfer(sc->sc_udev);
392 reqh = usbd_alloc_request();
396 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
397 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
400 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
401 0, RIO_RW_TIMEOUT, 0);
403 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
404 0, RIO_RW_TIMEOUT, 0);
405 if (r != USBD_NORMAL_COMPLETION) {
410 r = usbd_sync_transfer(reqh);
411 if (r != USBD_NORMAL_COMPLETION) {
412 DPRINTFN(1, ("urioread: error=%d\n", r));
413 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
419 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
421 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
424 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
425 error = uiomove(buf, tn, uio);
430 usbd_free_xfer(reqh);
432 usbd_free_request(reqh);
439 uriowrite(dev_t dev, struct uio *uio, int flag)
442 struct urio_softc * sc;
443 usbd_xfer_handle reqh;
445 usbd_request_handle reqh;
447 int unit = URIOUNIT(dev);
449 char buf[URIO_BBSIZE];
453 USB_GET_SC(urio, unit, sc);
455 DPRINTFN(5, ("uriowrite: %d\n", unit));
461 reqh = usbd_alloc_xfer(sc->sc_udev);
463 reqh = usbd_alloc_request();
467 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
468 error = uiomove(buf, n, uio);
471 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
473 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
474 0, RIO_RW_TIMEOUT, 0);
476 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
477 0, RIO_RW_TIMEOUT, 0);
478 if (r != USBD_NORMAL_COMPLETION) {
483 r = usbd_sync_transfer(reqh);
484 if (r != USBD_NORMAL_COMPLETION) {
485 DPRINTFN(1, ("uriowrite: error=%d\n", r));
486 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
491 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
496 usbd_free_xfer(reqh);
498 usbd_free_request(reqh);
506 urioioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
509 struct urio_softc * sc;
511 int unit = URIOUNIT(dev);
512 struct RioCommand *rio_cmd;
513 int requesttype, len;
516 usb_device_request_t req;
517 int req_flags = 0, req_actlen = 0;
522 USB_GET_SC(urio, unit, sc);
525 case RIO_RECV_COMMAND:
526 if (!(flag & FWRITE))
528 rio_cmd = (struct RioCommand *)addr;
531 len = rio_cmd->length;
533 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
534 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
535 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
538 case RIO_SEND_COMMAND:
539 if (!(flag & FWRITE))
541 rio_cmd = (struct RioCommand *)addr;
544 len = rio_cmd->length;
546 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
547 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
548 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
556 /* Send rio control message */
557 req.bmRequestType = requesttype;
558 req.bRequest = rio_cmd->request;
559 USETW(req.wValue, rio_cmd->value);
560 USETW(req.wIndex, rio_cmd->index);
561 USETW(req.wLength, len);
563 if (len < 0 || len > 32767)
566 iov.iov_base = (caddr_t)rio_cmd->buffer;
572 uio.uio_segflg = UIO_USERSPACE;
574 req.bmRequestType & UT_READ ?
575 UIO_READ : UIO_WRITE;
577 ptr = malloc(len, M_TEMP, M_WAITOK);
578 if (uio.uio_rw == UIO_WRITE) {
579 error = uiomove(ptr, len, &uio);
585 r = usbd_do_request_flags(sc->sc_udev, &req,
586 ptr, req_flags, &req_actlen);
587 if (r == USBD_NORMAL_COMPLETION) {
590 if (uio.uio_rw == UIO_READ) {
591 error = uiomove(ptr, len, &uio);
605 #if defined(__NetBSD__) || defined(__OpenBSD__)
607 urio_activate(device_ptr_t self, enum devact act)
609 struct urio_softc *sc = (struct urio_softc *)self;
616 case DVACT_DEACTIVATE:
625 USB_DETACH_START(urio, sc);
626 struct urio_endpoint *sce;
629 #if defined(__NetBSD__) || defined(__OpenBSD__)
632 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
633 #elif defined(__FreeBSD__)
634 DPRINTF(("urio_detach: sc=%p\n", sc));
638 /* Abort all pipes. Causes processes waiting for transfer to wake. */
640 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
641 for (dir = OUT; dir <= IN; dir++) {
642 sce = &sc->sc_endpoints[i][dir];
643 if (sce && sce->pipeh)
644 usbd_abort_pipe(sce->pipeh);
649 if (--sc->sc_refcnt >= 0) {
651 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
652 wakeup(&sc->sc_endpoints[i][IN]);
653 /* Wait for processes to go away. */
654 usb_detach_wait(USBDEV(sc->sc_dev));
659 usbd_abort_pipe(sc->sc_pipeh_in);
661 if (sc->sc_pipeh_out)
662 usbd_abort_pipe(sc->sc_pipeh_out);
665 if (--sc->sc_refcnt >= 0) {
666 /* Wait for processes to go away. */
667 usb_detach_wait(USBDEV(sc->sc_dev));
672 #if defined(__NetBSD__) || defined(__OpenBSD__)
673 /* locate the major number */
674 for (maj = 0; maj < nchrdev; maj++)
675 if (cdevsw[maj].d_open == urioopen)
678 /* Nuke the vnodes for any open instances (calls close). */
679 mn = self->dv_unit * USB_MAX_ENDPOINTS;
680 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
681 #elif defined(__FreeBSD__)
682 /* XXX not implemented yet */
685 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
690 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
692 #if defined(__FreeBSD__)
694 urio_detach(device_t self)
696 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
697 device_set_desc(self, NULL);
701 #if (__FreeBSD__ >= 4)
702 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);
704 CDEV_DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass,
705 URIO_CDEV_MAJOR, urio_cdevsw, usbd_driver_load, 0);