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.9 2004/05/13 23:49:22 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(__FreeBSD__) || defined(__DragonFly__)
152 #endif /* defined(__FreeBSD__) */
153 #if defined(__NetBSD__) || defined(__OpenBSD__)
158 #define URIOUNIT(n) (minor(n))
160 #define RIO_RW_TIMEOUT 4000 /* ms */
162 USB_DECLARE_DRIVER(urio);
166 USB_MATCH_START(urio, uaa);
167 usb_device_descriptor_t *dd;
169 DPRINTFN(10,("urio_match\n"));
173 dd = usbd_get_device_descriptor(uaa->device);
176 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
177 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
178 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
179 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
180 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
181 return UMATCH_VENDOR_PRODUCT;
188 USB_ATTACH_START(urio, sc, uaa);
190 usbd_device_handle udev;
191 usbd_interface_handle iface;
193 #if defined(__NetBSD__) || defined(__OpenBSD__)
197 char * ermsg = "<none>";
200 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
201 usbd_devinfo(uaa->device, 0, devinfo);
203 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
205 sc->sc_udev = udev = uaa->device;
207 #if defined(__FreeBSD__) || defined(__DragonFly__)
208 if ((!uaa->device) || (!uaa->iface)) {
209 ermsg = "device or iface";
212 sc->sc_iface = iface = uaa->iface;
213 #elif defined(__NetBSD__) || defined(__OpenBSD__)
218 r = usbd_interface_count(udev, &niface);
223 r = usbd_device2interface_handle(udev, 0, &iface);
228 sc->sc_iface = iface;
232 sc->sc_pipeh_out = 0;
235 r = usbd_endpoint_count(iface, &epcount);
236 if (r != USBD_NORMAL_COMPLETION) {
241 sc->sc_epaddr[RIO_OUT] = 0xff;
242 sc->sc_epaddr[RIO_IN] = 0x00;
244 for (i = 0; i < epcount; i++) {
245 usb_endpoint_descriptor_t *edesc =
246 usbd_interface2endpoint_descriptor(iface, i);
250 ermsg = "interface endpoint";
254 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
256 sc->sc_epaddr[d] = edesc->bEndpointAddress;
258 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
259 sc->sc_epaddr[RIO_IN] == 0x00) {
264 #if defined(__FreeBSD__) || defined(__DragonFly__)
265 /* XXX no error trapping, no storing of dev_t */
266 sc->sc_dev_t = make_dev(&urio_cdevsw, device_get_unit(self),
267 UID_ROOT, GID_OPERATOR,
268 0644, "urio%d", device_get_unit(self));
269 #elif defined(__NetBSD__) || defined(__OpenBSD__)
270 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
274 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
276 USB_ATTACH_SUCCESS_RETURN;
279 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
280 USB_ATTACH_ERROR_RETURN;
285 urioopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
288 struct urio_softc * sc;
290 int unit = URIOUNIT(dev);
291 USB_GET_SC_OPEN(urio, unit, sc);
293 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
299 if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
304 sc->sc_pipeh_out = 0;
305 if (usbd_open_pipe(sc->sc_iface,
306 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
307 != USBD_NORMAL_COMPLETION)
312 if (usbd_open_pipe(sc->sc_iface,
313 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
314 != USBD_NORMAL_COMPLETION)
316 usbd_close_pipe(sc->sc_pipeh_in);
318 sc->sc_pipeh_out = 0;
325 urioclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
328 struct urio_softc * sc;
330 int unit = URIOUNIT(dev);
331 USB_GET_SC(urio, unit, sc);
333 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
335 usbd_close_pipe(sc->sc_pipeh_in);
337 if (sc->sc_pipeh_out)
338 usbd_close_pipe(sc->sc_pipeh_out);
341 sc->sc_pipeh_out = 0;
348 urioread(dev_t dev, struct uio *uio, int flag)
351 struct urio_softc * sc;
352 usbd_xfer_handle reqh;
354 usbd_request_handle reqh;
355 usbd_private_handle r_priv;
357 usbd_status r_status;
359 int unit = URIOUNIT(dev);
361 char buf[URIO_BBSIZE];
365 USB_GET_SC(urio, unit, sc);
367 DPRINTFN(5, ("urioread: %d\n", unit));
373 reqh = usbd_alloc_xfer(sc->sc_udev);
375 reqh = usbd_alloc_request();
379 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
380 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
383 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
384 0, RIO_RW_TIMEOUT, 0);
386 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
387 0, RIO_RW_TIMEOUT, 0);
388 if (r != USBD_NORMAL_COMPLETION) {
393 r = usbd_sync_transfer(reqh);
394 if (r != USBD_NORMAL_COMPLETION) {
395 DPRINTFN(1, ("urioread: error=%d\n", r));
396 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
402 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
404 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
407 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
408 error = uiomove(buf, tn, uio);
413 usbd_free_xfer(reqh);
415 usbd_free_request(reqh);
422 uriowrite(dev_t dev, struct uio *uio, int flag)
425 struct urio_softc * sc;
426 usbd_xfer_handle reqh;
428 usbd_request_handle reqh;
430 int unit = URIOUNIT(dev);
432 char buf[URIO_BBSIZE];
436 USB_GET_SC(urio, unit, sc);
438 DPRINTFN(5, ("uriowrite: %d\n", unit));
444 reqh = usbd_alloc_xfer(sc->sc_udev);
446 reqh = usbd_alloc_request();
450 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
451 error = uiomove(buf, n, uio);
454 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
456 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
457 0, RIO_RW_TIMEOUT, 0);
459 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
460 0, RIO_RW_TIMEOUT, 0);
461 if (r != USBD_NORMAL_COMPLETION) {
466 r = usbd_sync_transfer(reqh);
467 if (r != USBD_NORMAL_COMPLETION) {
468 DPRINTFN(1, ("uriowrite: error=%d\n", r));
469 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
474 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
479 usbd_free_xfer(reqh);
481 usbd_free_request(reqh);
489 urioioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
492 struct urio_softc * sc;
494 int unit = URIOUNIT(dev);
495 struct RioCommand *rio_cmd;
496 int requesttype, len;
499 usb_device_request_t req;
500 int req_flags = 0, req_actlen = 0;
505 USB_GET_SC(urio, unit, sc);
508 case RIO_RECV_COMMAND:
509 if (!(flag & FWRITE))
511 rio_cmd = (struct RioCommand *)addr;
514 len = rio_cmd->length;
516 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
517 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
518 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
521 case RIO_SEND_COMMAND:
522 if (!(flag & FWRITE))
524 rio_cmd = (struct RioCommand *)addr;
527 len = rio_cmd->length;
529 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
530 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
531 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
539 /* Send rio control message */
540 req.bmRequestType = requesttype;
541 req.bRequest = rio_cmd->request;
542 USETW(req.wValue, rio_cmd->value);
543 USETW(req.wIndex, rio_cmd->index);
544 USETW(req.wLength, len);
546 if (len < 0 || len > 32767)
549 iov.iov_base = (caddr_t)rio_cmd->buffer;
555 uio.uio_segflg = UIO_USERSPACE;
557 req.bmRequestType & UT_READ ?
558 UIO_READ : UIO_WRITE;
560 ptr = malloc(len, M_TEMP, M_WAITOK);
561 if (uio.uio_rw == UIO_WRITE) {
562 error = uiomove(ptr, len, &uio);
568 r = usbd_do_request_flags(sc->sc_udev, &req,
569 ptr, req_flags, &req_actlen,
570 USBD_DEFAULT_TIMEOUT);
571 if (r == USBD_NORMAL_COMPLETION) {
574 if (uio.uio_rw == UIO_READ) {
575 error = uiomove(ptr, len, &uio);
589 #if defined(__NetBSD__) || defined(__OpenBSD__)
591 urio_activate(device_ptr_t self, enum devact act)
593 struct urio_softc *sc = (struct urio_softc *)self;
600 case DVACT_DEACTIVATE:
609 USB_DETACH_START(urio, sc);
610 struct urio_endpoint *sce;
613 #if defined(__NetBSD__) || defined(__OpenBSD__)
616 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
617 #elif defined(__FreeBSD__) || defined(__DragonFly__)
618 DPRINTF(("urio_detach: sc=%p\n", sc));
622 /* Abort all pipes. Causes processes waiting for transfer to wake. */
624 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
625 for (dir = OUT; dir <= IN; dir++) {
626 sce = &sc->sc_endpoints[i][dir];
627 if (sce && sce->pipeh)
628 usbd_abort_pipe(sce->pipeh);
633 if (--sc->sc_refcnt >= 0) {
635 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
636 wakeup(&sc->sc_endpoints[i][IN]);
637 /* Wait for processes to go away. */
638 usb_detach_wait(USBDEV(sc->sc_dev));
643 usbd_abort_pipe(sc->sc_pipeh_in);
645 if (sc->sc_pipeh_out)
646 usbd_abort_pipe(sc->sc_pipeh_out);
649 if (--sc->sc_refcnt >= 0) {
650 /* Wait for processes to go away. */
651 usb_detach_wait(USBDEV(sc->sc_dev));
656 #if defined(__NetBSD__) || defined(__OpenBSD__)
657 /* locate the major number */
658 for (maj = 0; maj < nchrdev; maj++)
659 if (cdevsw[maj].d_open == urioopen)
662 /* Nuke the vnodes for any open instances (calls close). */
663 mn = self->dv_unit * USB_MAX_ENDPOINTS;
664 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
667 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
672 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
674 #if defined(__FreeBSD__) || defined(__DragonFly__)
676 urio_detach(device_t self)
678 struct urio_softc *sc = device_get_softc(self);
680 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
681 destroy_dev(sc->sc_dev_t);
682 /* XXX not implemented yet */
683 device_set_desc(self, NULL);
687 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);