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.15 2006/12/22 23:26:26 swildner 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 #if defined(__NetBSD__)
53 #include <sys/device.h>
54 #include <sys/ioctl.h>
55 #elif defined(__FreeBSD__) || defined(__DragonFly__)
56 #include <sys/module.h>
58 #include <sys/ioccom.h>
60 #include <sys/fcntl.h>
61 #include <sys/filio.h>
66 #if defined(__FreeBSD__) && __FreeBSD_version >= 500014
67 #include <sys/selinfo.h>
69 #include <sys/select.h>
71 #include <sys/vnode.h>
73 #include <sys/sysctl.h>
75 #include <sys/thread2.h>
77 #include <bus/usb/usb.h>
78 #include <bus/usb/usbdi.h>
79 #include <bus/usb/usbdi_util.h>
81 #include <bus/usb/usbdevs.h>
82 #include <bus/usb/rio500_usb.h>
85 #define DPRINTF(x) if (uriodebug) logprintf x
86 #define DPRINTFN(n,x) if (uriodebug>(n)) logprintf x
88 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
89 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
90 &uriodebug, 0, "urio debug level");
96 /* difference of usbd interface */
103 #if defined(__NetBSD__)
104 int urioopen(cdev_t, int, int, struct proc *);
105 int urioclose(cdev_t, int, int, struct proc *p);
106 int urioread(cdev_t, struct uio *uio, int);
107 int uriowrite(cdev_t, struct uio *uio, int);
108 int urioioctl(cdev_t, u_long, caddr_t, int, struct proc *);
111 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
112 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
114 #elif defined(__FreeBSD__) || defined(__DragonFly__)
121 #define URIO_CDEV_MAJOR 143
123 Static struct dev_ops urio_ops = {
124 { "urio", URIO_CDEV_MAJOR, 0 },
126 .d_close = urioclose,
128 .d_write = uriowrite,
129 .d_ioctl = urioioctl,
131 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
132 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
134 #endif /*defined(__FreeBSD__)*/
136 #define URIO_BBSIZE 1024
139 USBBASEDEVICE sc_dev;
140 usbd_device_handle sc_udev;
141 usbd_interface_handle sc_iface;
144 usbd_pipe_handle sc_pipeh_in;
145 usbd_pipe_handle sc_pipeh_out;
149 #if defined(__NetBSD__) || defined(__OpenBSD__)
154 #define URIOUNIT(n) (minor(n))
156 #define RIO_RW_TIMEOUT 4000 /* ms */
158 USB_DECLARE_DRIVER(urio);
162 USB_MATCH_START(urio, uaa);
163 usb_device_descriptor_t *dd;
165 DPRINTFN(10,("urio_match\n"));
169 dd = usbd_get_device_descriptor(uaa->device);
172 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
173 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
174 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
175 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
176 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
177 return UMATCH_VENDOR_PRODUCT;
184 USB_ATTACH_START(urio, sc, uaa);
186 usbd_device_handle udev;
187 usbd_interface_handle iface;
189 #if defined(__NetBSD__) || defined(__OpenBSD__)
193 char * ermsg = "<none>";
196 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
197 usbd_devinfo(uaa->device, 0, devinfo);
199 kprintf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
201 sc->sc_udev = udev = uaa->device;
203 #if defined(__FreeBSD__) || defined(__DragonFly__)
204 if ((!uaa->device) || (!uaa->iface)) {
205 ermsg = "device or iface";
208 sc->sc_iface = iface = uaa->iface;
209 #elif defined(__NetBSD__) || defined(__OpenBSD__)
214 r = usbd_interface_count(udev, &niface);
219 r = usbd_device2interface_handle(udev, 0, &iface);
224 sc->sc_iface = iface;
228 sc->sc_pipeh_out = 0;
231 r = usbd_endpoint_count(iface, &epcount);
232 if (r != USBD_NORMAL_COMPLETION) {
237 sc->sc_epaddr[RIO_OUT] = 0xff;
238 sc->sc_epaddr[RIO_IN] = 0x00;
240 for (i = 0; i < epcount; i++) {
241 usb_endpoint_descriptor_t *edesc =
242 usbd_interface2endpoint_descriptor(iface, i);
246 ermsg = "interface endpoint";
250 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
252 sc->sc_epaddr[d] = edesc->bEndpointAddress;
254 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
255 sc->sc_epaddr[RIO_IN] == 0x00) {
260 #if defined(__FreeBSD__) || defined(__DragonFly__)
261 dev_ops_add(&urio_ops, -1, device_get_unit(self));
262 make_dev(&urio_ops, device_get_unit(self),
263 UID_ROOT, GID_OPERATOR,
264 0644, "urio%d", device_get_unit(self));
265 #elif defined(__NetBSD__) || defined(__OpenBSD__)
266 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
270 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
272 USB_ATTACH_SUCCESS_RETURN;
275 kprintf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
276 USB_ATTACH_ERROR_RETURN;
281 urioopen(struct dev_open_args *ap)
283 cdev_t dev = ap->a_head.a_dev;
285 struct urio_softc * sc;
287 int unit = URIOUNIT(dev);
288 USB_GET_SC_OPEN(urio, unit, sc);
290 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
291 ap->a_oflags, ap->a_devtype, unit));
296 if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
301 sc->sc_pipeh_out = 0;
302 if (usbd_open_pipe(sc->sc_iface,
303 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
304 != USBD_NORMAL_COMPLETION)
309 if (usbd_open_pipe(sc->sc_iface,
310 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
311 != USBD_NORMAL_COMPLETION)
313 usbd_close_pipe(sc->sc_pipeh_in);
315 sc->sc_pipeh_out = 0;
322 urioclose(struct dev_close_args *ap)
324 cdev_t dev = ap->a_head.a_dev;
326 struct urio_softc * sc;
328 int unit = URIOUNIT(dev);
329 USB_GET_SC(urio, unit, sc);
331 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n",
332 ap->a_fflag, ap->a_devtype, unit));
334 usbd_close_pipe(sc->sc_pipeh_in);
336 if (sc->sc_pipeh_out)
337 usbd_close_pipe(sc->sc_pipeh_out);
340 sc->sc_pipeh_out = 0;
347 urioread(struct dev_read_args *ap)
349 cdev_t dev = ap->a_head.a_dev;
350 struct uio *uio = ap->a_uio;
352 struct urio_softc * sc;
353 usbd_xfer_handle reqh;
355 usbd_request_handle reqh;
356 usbd_private_handle r_priv;
358 usbd_status r_status;
360 int unit = URIOUNIT(dev);
362 char buf[URIO_BBSIZE];
366 USB_GET_SC(urio, unit, sc);
368 DPRINTFN(5, ("urioread: %d\n", unit));
374 reqh = usbd_alloc_xfer(sc->sc_udev);
376 reqh = usbd_alloc_request();
380 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
381 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
384 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
385 0, RIO_RW_TIMEOUT, 0);
387 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
388 0, RIO_RW_TIMEOUT, 0);
389 if (r != USBD_NORMAL_COMPLETION) {
394 r = usbd_sync_transfer(reqh);
395 if (r != USBD_NORMAL_COMPLETION) {
396 DPRINTFN(1, ("urioread: error=%d\n", r));
397 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
403 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
405 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
408 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
409 error = uiomove(buf, tn, uio);
414 usbd_free_xfer(reqh);
416 usbd_free_request(reqh);
423 uriowrite(struct dev_write_args *ap)
425 cdev_t dev = ap->a_head.a_dev;
426 struct uio *uio = ap->a_uio;
428 struct urio_softc * sc;
429 usbd_xfer_handle reqh;
431 usbd_request_handle reqh;
433 int unit = URIOUNIT(dev);
435 char buf[URIO_BBSIZE];
439 USB_GET_SC(urio, unit, sc);
441 DPRINTFN(5, ("uriowrite: %d\n", unit));
447 reqh = usbd_alloc_xfer(sc->sc_udev);
449 reqh = usbd_alloc_request();
453 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
454 error = uiomove(buf, n, uio);
457 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
459 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
460 0, RIO_RW_TIMEOUT, 0);
462 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
463 0, RIO_RW_TIMEOUT, 0);
464 if (r != USBD_NORMAL_COMPLETION) {
469 r = usbd_sync_transfer(reqh);
470 if (r != USBD_NORMAL_COMPLETION) {
471 DPRINTFN(1, ("uriowrite: error=%d\n", r));
472 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
477 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
482 usbd_free_xfer(reqh);
484 usbd_free_request(reqh);
492 urioioctl(struct dev_ioctl_args *ap)
494 cdev_t dev = ap->a_head.a_dev;
496 struct urio_softc * sc;
498 int unit = URIOUNIT(dev);
499 struct RioCommand *rio_cmd;
500 int requesttype, len;
503 usb_device_request_t req;
504 int req_flags = 0, req_actlen = 0;
509 USB_GET_SC(urio, unit, sc);
512 case RIO_RECV_COMMAND:
513 if (!(ap->a_fflag & FWRITE))
515 rio_cmd = (struct RioCommand *)ap->a_data;
518 len = rio_cmd->length;
520 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
521 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
522 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
525 case RIO_SEND_COMMAND:
526 if (!(ap->a_fflag & FWRITE))
528 rio_cmd = (struct RioCommand *)ap->a_data;
531 len = rio_cmd->length;
533 requesttype = rio_cmd->requesttype | UT_WRITE_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));
543 /* Send rio control message */
544 req.bmRequestType = requesttype;
545 req.bRequest = rio_cmd->request;
546 USETW(req.wValue, rio_cmd->value);
547 USETW(req.wIndex, rio_cmd->index);
548 USETW(req.wLength, len);
550 if (len < 0 || len > 32767)
553 iov.iov_base = (caddr_t)rio_cmd->buffer;
559 uio.uio_segflg = UIO_USERSPACE;
561 req.bmRequestType & UT_READ ?
562 UIO_READ : UIO_WRITE;
563 uio.uio_td = curthread;
564 ptr = kmalloc(len, M_TEMP, M_WAITOK);
565 if (uio.uio_rw == UIO_WRITE) {
566 error = uiomove(ptr, len, &uio);
572 r = usbd_do_request_flags(sc->sc_udev, &req,
573 ptr, req_flags, &req_actlen,
574 USBD_DEFAULT_TIMEOUT);
575 if (r == USBD_NORMAL_COMPLETION) {
578 if (uio.uio_rw == UIO_READ) {
579 error = uiomove(ptr, len, &uio);
593 #if defined(__NetBSD__) || defined(__OpenBSD__)
595 urio_activate(device_ptr_t self, enum devact act)
597 struct urio_softc *sc = (struct urio_softc *)self;
604 case DVACT_DEACTIVATE:
613 USB_DETACH_START(urio, sc);
614 struct urio_endpoint *sce;
617 #if defined(__NetBSD__) || defined(__OpenBSD__)
620 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
621 #elif defined(__FreeBSD__) || defined(__DragonFly__)
622 DPRINTF(("urio_detach: sc=%p\n", sc));
626 /* Abort all pipes. Causes processes waiting for transfer to wake. */
628 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
629 for (dir = OUT; dir <= IN; dir++) {
630 sce = &sc->sc_endpoints[i][dir];
631 if (sce && sce->pipeh)
632 usbd_abort_pipe(sce->pipeh);
637 if (--sc->sc_refcnt >= 0) {
639 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
640 wakeup(&sc->sc_endpoints[i][IN]);
641 /* Wait for processes to go away. */
642 usb_detach_wait(USBDEV(sc->sc_dev));
647 usbd_abort_pipe(sc->sc_pipeh_in);
649 if (sc->sc_pipeh_out)
650 usbd_abort_pipe(sc->sc_pipeh_out);
653 if (--sc->sc_refcnt >= 0) {
654 /* Wait for processes to go away. */
655 usb_detach_wait(USBDEV(sc->sc_dev));
660 #if defined(__NetBSD__) || defined(__OpenBSD__)
661 /* locate the major number */
662 for (maj = 0; maj < nchrdev; maj++)
663 if (cdevsw[maj].d_open == urioopen)
666 /* Nuke the vnodes for any open instances (calls close). */
667 mn = self->dv_unit * USB_MAX_ENDPOINTS;
668 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
671 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
676 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
678 #if defined(__FreeBSD__) || defined(__DragonFly__)
680 urio_detach(device_t self)
682 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
683 dev_ops_remove(&urio_ops, -1, device_get_unit(self));
684 /* XXX not implemented yet */
685 device_set_desc(self, NULL);
689 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);