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.10 2004/05/19 22:52:52 dillon 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>
76 #include <bus/usb/usb.h>
77 #include <bus/usb/usbdi.h>
78 #include <bus/usb/usbdi_util.h>
80 #include <bus/usb/usbdevs.h>
81 #include <bus/usb/rio500_usb.h>
84 #define DPRINTF(x) if (uriodebug) logprintf x
85 #define DPRINTFN(n,x) if (uriodebug>(n)) logprintf x
87 SYSCTL_NODE(_hw_usb, OID_AUTO, urio, CTLFLAG_RW, 0, "USB urio");
88 SYSCTL_INT(_hw_usb_urio, OID_AUTO, debug, CTLFLAG_RW,
89 &uriodebug, 0, "urio debug level");
95 /* difference of usbd interface */
102 #if defined(__NetBSD__)
103 int urioopen(dev_t, int, int, struct proc *);
104 int urioclose(dev_t, int, int, struct proc *p);
105 int urioread(dev_t, struct uio *uio, int);
106 int uriowrite(dev_t, struct uio *uio, int);
107 int urioioctl(dev_t, u_long, caddr_t, int, struct proc *);
110 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
111 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
113 #elif defined(__FreeBSD__) || defined(__DragonFly__)
120 #define URIO_CDEV_MAJOR 143
122 Static struct cdevsw urio_cdevsw = {
124 /* cmaj */ URIO_CDEV_MAJOR,
128 urioopen, urioclose, urioread, uriowrite,
129 urioioctl, nopoll, nommap, nostrategy,
132 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
133 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
135 #endif /*defined(__FreeBSD__)*/
137 #define URIO_BBSIZE 1024
140 USBBASEDEVICE sc_dev;
141 usbd_device_handle sc_udev;
142 usbd_interface_handle sc_iface;
145 usbd_pipe_handle sc_pipeh_in;
146 usbd_pipe_handle sc_pipeh_out;
150 #if defined(__NetBSD__) || defined(__OpenBSD__)
155 #define URIOUNIT(n) (minor(n))
157 #define RIO_RW_TIMEOUT 4000 /* ms */
159 USB_DECLARE_DRIVER(urio);
163 USB_MATCH_START(urio, uaa);
164 usb_device_descriptor_t *dd;
166 DPRINTFN(10,("urio_match\n"));
170 dd = usbd_get_device_descriptor(uaa->device);
173 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
174 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
175 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
176 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
177 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
178 return UMATCH_VENDOR_PRODUCT;
185 USB_ATTACH_START(urio, sc, uaa);
187 usbd_device_handle udev;
188 usbd_interface_handle iface;
190 #if defined(__NetBSD__) || defined(__OpenBSD__)
194 char * ermsg = "<none>";
197 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
198 usbd_devinfo(uaa->device, 0, devinfo);
200 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
202 sc->sc_udev = udev = uaa->device;
204 #if defined(__FreeBSD__) || defined(__DragonFly__)
205 if ((!uaa->device) || (!uaa->iface)) {
206 ermsg = "device or iface";
209 sc->sc_iface = iface = uaa->iface;
210 #elif defined(__NetBSD__) || defined(__OpenBSD__)
215 r = usbd_interface_count(udev, &niface);
220 r = usbd_device2interface_handle(udev, 0, &iface);
225 sc->sc_iface = iface;
229 sc->sc_pipeh_out = 0;
232 r = usbd_endpoint_count(iface, &epcount);
233 if (r != USBD_NORMAL_COMPLETION) {
238 sc->sc_epaddr[RIO_OUT] = 0xff;
239 sc->sc_epaddr[RIO_IN] = 0x00;
241 for (i = 0; i < epcount; i++) {
242 usb_endpoint_descriptor_t *edesc =
243 usbd_interface2endpoint_descriptor(iface, i);
247 ermsg = "interface endpoint";
251 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
253 sc->sc_epaddr[d] = edesc->bEndpointAddress;
255 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
256 sc->sc_epaddr[RIO_IN] == 0x00) {
261 #if defined(__FreeBSD__) || defined(__DragonFly__)
262 cdevsw_add(&urio_cdevsw, -1, device_get_unit(self));
263 make_dev(&urio_cdevsw, device_get_unit(self),
264 UID_ROOT, GID_OPERATOR,
265 0644, "urio%d", device_get_unit(self));
266 #elif defined(__NetBSD__) || defined(__OpenBSD__)
267 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
271 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
273 USB_ATTACH_SUCCESS_RETURN;
276 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
277 USB_ATTACH_ERROR_RETURN;
282 urioopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
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",
296 if ((flag & (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(dev_t dev, int flag, int mode, usb_proc_ptr p)
325 struct urio_softc * sc;
327 int unit = URIOUNIT(dev);
328 USB_GET_SC(urio, unit, sc);
330 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
332 usbd_close_pipe(sc->sc_pipeh_in);
334 if (sc->sc_pipeh_out)
335 usbd_close_pipe(sc->sc_pipeh_out);
338 sc->sc_pipeh_out = 0;
345 urioread(dev_t dev, struct uio *uio, int flag)
348 struct urio_softc * sc;
349 usbd_xfer_handle reqh;
351 usbd_request_handle reqh;
352 usbd_private_handle r_priv;
354 usbd_status r_status;
356 int unit = URIOUNIT(dev);
358 char buf[URIO_BBSIZE];
362 USB_GET_SC(urio, unit, sc);
364 DPRINTFN(5, ("urioread: %d\n", unit));
370 reqh = usbd_alloc_xfer(sc->sc_udev);
372 reqh = usbd_alloc_request();
376 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
377 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
380 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
381 0, RIO_RW_TIMEOUT, 0);
383 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
384 0, RIO_RW_TIMEOUT, 0);
385 if (r != USBD_NORMAL_COMPLETION) {
390 r = usbd_sync_transfer(reqh);
391 if (r != USBD_NORMAL_COMPLETION) {
392 DPRINTFN(1, ("urioread: error=%d\n", r));
393 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
399 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
401 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
404 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
405 error = uiomove(buf, tn, uio);
410 usbd_free_xfer(reqh);
412 usbd_free_request(reqh);
419 uriowrite(dev_t dev, struct uio *uio, int flag)
422 struct urio_softc * sc;
423 usbd_xfer_handle reqh;
425 usbd_request_handle reqh;
427 int unit = URIOUNIT(dev);
429 char buf[URIO_BBSIZE];
433 USB_GET_SC(urio, unit, sc);
435 DPRINTFN(5, ("uriowrite: %d\n", unit));
441 reqh = usbd_alloc_xfer(sc->sc_udev);
443 reqh = usbd_alloc_request();
447 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
448 error = uiomove(buf, n, uio);
451 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
453 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
454 0, RIO_RW_TIMEOUT, 0);
456 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
457 0, RIO_RW_TIMEOUT, 0);
458 if (r != USBD_NORMAL_COMPLETION) {
463 r = usbd_sync_transfer(reqh);
464 if (r != USBD_NORMAL_COMPLETION) {
465 DPRINTFN(1, ("uriowrite: error=%d\n", r));
466 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
471 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
476 usbd_free_xfer(reqh);
478 usbd_free_request(reqh);
486 urioioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
489 struct urio_softc * sc;
491 int unit = URIOUNIT(dev);
492 struct RioCommand *rio_cmd;
493 int requesttype, len;
496 usb_device_request_t req;
497 int req_flags = 0, req_actlen = 0;
502 USB_GET_SC(urio, unit, sc);
505 case RIO_RECV_COMMAND:
506 if (!(flag & FWRITE))
508 rio_cmd = (struct RioCommand *)addr;
511 len = rio_cmd->length;
513 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
514 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
515 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
518 case RIO_SEND_COMMAND:
519 if (!(flag & FWRITE))
521 rio_cmd = (struct RioCommand *)addr;
524 len = rio_cmd->length;
526 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
527 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
528 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
536 /* Send rio control message */
537 req.bmRequestType = requesttype;
538 req.bRequest = rio_cmd->request;
539 USETW(req.wValue, rio_cmd->value);
540 USETW(req.wIndex, rio_cmd->index);
541 USETW(req.wLength, len);
543 if (len < 0 || len > 32767)
546 iov.iov_base = (caddr_t)rio_cmd->buffer;
552 uio.uio_segflg = UIO_USERSPACE;
554 req.bmRequestType & UT_READ ?
555 UIO_READ : UIO_WRITE;
557 ptr = malloc(len, M_TEMP, M_WAITOK);
558 if (uio.uio_rw == UIO_WRITE) {
559 error = uiomove(ptr, len, &uio);
565 r = usbd_do_request_flags(sc->sc_udev, &req,
566 ptr, req_flags, &req_actlen,
567 USBD_DEFAULT_TIMEOUT);
568 if (r == USBD_NORMAL_COMPLETION) {
571 if (uio.uio_rw == UIO_READ) {
572 error = uiomove(ptr, len, &uio);
586 #if defined(__NetBSD__) || defined(__OpenBSD__)
588 urio_activate(device_ptr_t self, enum devact act)
590 struct urio_softc *sc = (struct urio_softc *)self;
597 case DVACT_DEACTIVATE:
606 USB_DETACH_START(urio, sc);
607 struct urio_endpoint *sce;
610 #if defined(__NetBSD__) || defined(__OpenBSD__)
613 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
614 #elif defined(__FreeBSD__) || defined(__DragonFly__)
615 DPRINTF(("urio_detach: sc=%p\n", sc));
619 /* Abort all pipes. Causes processes waiting for transfer to wake. */
621 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
622 for (dir = OUT; dir <= IN; dir++) {
623 sce = &sc->sc_endpoints[i][dir];
624 if (sce && sce->pipeh)
625 usbd_abort_pipe(sce->pipeh);
630 if (--sc->sc_refcnt >= 0) {
632 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
633 wakeup(&sc->sc_endpoints[i][IN]);
634 /* Wait for processes to go away. */
635 usb_detach_wait(USBDEV(sc->sc_dev));
640 usbd_abort_pipe(sc->sc_pipeh_in);
642 if (sc->sc_pipeh_out)
643 usbd_abort_pipe(sc->sc_pipeh_out);
646 if (--sc->sc_refcnt >= 0) {
647 /* Wait for processes to go away. */
648 usb_detach_wait(USBDEV(sc->sc_dev));
653 #if defined(__NetBSD__) || defined(__OpenBSD__)
654 /* locate the major number */
655 for (maj = 0; maj < nchrdev; maj++)
656 if (cdevsw[maj].d_open == urioopen)
659 /* Nuke the vnodes for any open instances (calls close). */
660 mn = self->dv_unit * USB_MAX_ENDPOINTS;
661 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
664 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
669 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
671 #if defined(__FreeBSD__) || defined(__DragonFly__)
673 urio_detach(device_t self)
675 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
676 cdevsw_remove(&urio_cdevsw, -1, device_get_unit(self));
677 /* XXX not implemented yet */
678 device_set_desc(self, NULL);
682 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);