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.3 2003/06/23 17:55:36 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 <dev/usb/usb.h>
75 #include <dev/usb/usbdi.h>
76 #include <dev/usb/usbdi_util.h>
78 #include <dev/usb/usbdevs.h>
79 #include <dev/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 = {
130 urioopen, urioclose, urioread, uriowrite,
131 urioioctl, nopoll, nommap, nostrategy,
132 "urio", URIO_CDEV_MAJOR,nodump, nopsize,
134 #if (__FreeBSD__ < 5)
138 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
139 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
142 Static struct cdevsw urio_cdevsw = {
143 urioopen, urioclose, urioread, uriowrite,
144 urioioctl, nostop, nullreset, nodevtotty,
145 seltrue, nommap, nostrat,
148 #define USBBASEDEVICE bdevice
149 #define RIO_UE_GET_DIR(p) UE_GET_IN(p)
152 #endif /*defined(__FreeBSD__)*/
154 #define URIO_BBSIZE 1024
157 USBBASEDEVICE sc_dev;
158 usbd_device_handle sc_udev;
159 usbd_interface_handle sc_iface;
162 usbd_pipe_handle sc_pipeh_in;
163 usbd_pipe_handle sc_pipeh_out;
167 #if defined(__NetBSD__) || defined(__OpenBSD__)
172 #define URIOUNIT(n) (minor(n))
174 #define RIO_RW_TIMEOUT 4000 /* ms */
176 USB_DECLARE_DRIVER(urio);
180 USB_MATCH_START(urio, uaa);
181 usb_device_descriptor_t *dd;
183 DPRINTFN(10,("urio_match\n"));
187 dd = usbd_get_device_descriptor(uaa->device);
190 ((UGETW(dd->idVendor) == USB_VENDOR_DIAMOND &&
191 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND_RIO500USB) ||
192 (UGETW(dd->idVendor) == USB_VENDOR_DIAMOND2 &&
193 (UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO600USB ||
194 UGETW(dd->idProduct) == USB_PRODUCT_DIAMOND2_RIO800USB))))
195 return UMATCH_VENDOR_PRODUCT;
202 USB_ATTACH_START(urio, sc, uaa);
204 usbd_device_handle udev;
205 usbd_interface_handle iface;
207 #if defined(__NetBSD__) || defined(__OpenBSD__)
211 char * ermsg = "<none>";
214 DPRINTFN(10,("urio_attach: sc=%p\n", sc));
215 usbd_devinfo(uaa->device, 0, devinfo);
217 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
219 sc->sc_udev = udev = uaa->device;
221 #if defined(__FreeBSD__)
222 if ((!uaa->device) || (!uaa->iface)) {
223 ermsg = "device or iface";
226 sc->sc_iface = iface = uaa->iface;
227 #elif defined(__NetBSD__) || defined(__OpenBSD__)
232 r = usbd_interface_count(udev, &niface);
237 r = usbd_device2interface_handle(udev, 0, &iface);
242 sc->sc_iface = iface;
246 sc->sc_pipeh_out = 0;
249 r = usbd_endpoint_count(iface, &epcount);
250 if (r != USBD_NORMAL_COMPLETION) {
255 sc->sc_epaddr[RIO_OUT] = 0xff;
256 sc->sc_epaddr[RIO_IN] = 0x00;
258 for (i = 0; i < epcount; i++) {
259 usb_endpoint_descriptor_t *edesc =
260 usbd_interface2endpoint_descriptor(iface, i);
264 ermsg = "interface endpoint";
268 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
270 sc->sc_epaddr[d] = edesc->bEndpointAddress;
272 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
273 sc->sc_epaddr[RIO_IN] == 0x00) {
278 #if defined(__FreeBSD__)
279 #if (__FreeBSD__ >= 4)
280 /* XXX no error trapping, no storing of dev_t */
281 (void) make_dev(&urio_cdevsw, device_get_unit(self),
282 UID_ROOT, GID_OPERATOR,
283 0644, "urio%d", device_get_unit(self));
285 #elif defined(__NetBSD__) || defined(__OpenBSD__)
286 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
290 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
292 USB_ATTACH_SUCCESS_RETURN;
295 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
296 USB_ATTACH_ERROR_RETURN;
301 urioopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
304 struct urio_softc * sc;
306 int unit = URIOUNIT(dev);
307 USB_GET_SC_OPEN(urio, unit, sc);
309 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
315 if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
320 sc->sc_pipeh_out = 0;
321 if (usbd_open_pipe(sc->sc_iface,
322 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
323 != USBD_NORMAL_COMPLETION)
328 if (usbd_open_pipe(sc->sc_iface,
329 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
330 != USBD_NORMAL_COMPLETION)
332 usbd_close_pipe(sc->sc_pipeh_in);
334 sc->sc_pipeh_out = 0;
341 urioclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
344 struct urio_softc * sc;
346 int unit = URIOUNIT(dev);
347 USB_GET_SC(urio, unit, sc);
349 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
351 usbd_close_pipe(sc->sc_pipeh_in);
353 if (sc->sc_pipeh_out)
354 usbd_close_pipe(sc->sc_pipeh_out);
357 sc->sc_pipeh_out = 0;
364 urioread(dev_t dev, struct uio *uio, int flag)
367 struct urio_softc * sc;
368 usbd_xfer_handle reqh;
370 usbd_request_handle reqh;
371 usbd_private_handle r_priv;
373 usbd_status r_status;
375 int unit = URIOUNIT(dev);
377 char buf[URIO_BBSIZE];
381 USB_GET_SC(urio, unit, sc);
383 DPRINTFN(5, ("urioread: %d\n", unit));
389 reqh = usbd_alloc_xfer(sc->sc_udev);
391 reqh = usbd_alloc_request();
395 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
396 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
399 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
400 0, RIO_RW_TIMEOUT, 0);
402 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
403 0, RIO_RW_TIMEOUT, 0);
404 if (r != USBD_NORMAL_COMPLETION) {
409 r = usbd_sync_transfer(reqh);
410 if (r != USBD_NORMAL_COMPLETION) {
411 DPRINTFN(1, ("urioread: error=%d\n", r));
412 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
418 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
420 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
423 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
424 error = uiomove(buf, tn, uio);
429 usbd_free_xfer(reqh);
431 usbd_free_request(reqh);
438 uriowrite(dev_t dev, struct uio *uio, int flag)
441 struct urio_softc * sc;
442 usbd_xfer_handle reqh;
444 usbd_request_handle reqh;
446 int unit = URIOUNIT(dev);
448 char buf[URIO_BBSIZE];
452 USB_GET_SC(urio, unit, sc);
454 DPRINTFN(5, ("uriowrite: %d\n", unit));
460 reqh = usbd_alloc_xfer(sc->sc_udev);
462 reqh = usbd_alloc_request();
466 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
467 error = uiomove(buf, n, uio);
470 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
472 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
473 0, RIO_RW_TIMEOUT, 0);
475 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
476 0, RIO_RW_TIMEOUT, 0);
477 if (r != USBD_NORMAL_COMPLETION) {
482 r = usbd_sync_transfer(reqh);
483 if (r != USBD_NORMAL_COMPLETION) {
484 DPRINTFN(1, ("uriowrite: error=%d\n", r));
485 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
490 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
495 usbd_free_xfer(reqh);
497 usbd_free_request(reqh);
505 urioioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
508 struct urio_softc * sc;
510 int unit = URIOUNIT(dev);
511 struct RioCommand *rio_cmd;
512 int requesttype, len;
515 usb_device_request_t req;
516 int req_flags = 0, req_actlen = 0;
521 USB_GET_SC(urio, unit, sc);
524 case RIO_RECV_COMMAND:
525 if (!(flag & FWRITE))
527 rio_cmd = (struct RioCommand *)addr;
530 len = rio_cmd->length;
532 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
533 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
534 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
537 case RIO_SEND_COMMAND:
538 if (!(flag & FWRITE))
540 rio_cmd = (struct RioCommand *)addr;
543 len = rio_cmd->length;
545 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
546 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
547 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
555 /* Send rio control message */
556 req.bmRequestType = requesttype;
557 req.bRequest = rio_cmd->request;
558 USETW(req.wValue, rio_cmd->value);
559 USETW(req.wIndex, rio_cmd->index);
560 USETW(req.wLength, len);
562 if (len < 0 || len > 32767)
565 iov.iov_base = (caddr_t)rio_cmd->buffer;
571 uio.uio_segflg = UIO_USERSPACE;
573 req.bmRequestType & UT_READ ?
574 UIO_READ : UIO_WRITE;
575 uio.uio_procp = p->td_proc;
576 ptr = malloc(len, M_TEMP, M_WAITOK);
577 if (uio.uio_rw == UIO_WRITE) {
578 error = uiomove(ptr, len, &uio);
584 r = usbd_do_request_flags(sc->sc_udev, &req,
585 ptr, req_flags, &req_actlen);
586 if (r == USBD_NORMAL_COMPLETION) {
589 if (uio.uio_rw == UIO_READ) {
590 error = uiomove(ptr, len, &uio);
604 #if defined(__NetBSD__) || defined(__OpenBSD__)
606 urio_activate(device_ptr_t self, enum devact act)
608 struct urio_softc *sc = (struct urio_softc *)self;
615 case DVACT_DEACTIVATE:
624 USB_DETACH_START(urio, sc);
625 struct urio_endpoint *sce;
628 #if defined(__NetBSD__) || defined(__OpenBSD__)
631 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
632 #elif defined(__FreeBSD__)
633 DPRINTF(("urio_detach: sc=%p\n", sc));
637 /* Abort all pipes. Causes processes waiting for transfer to wake. */
639 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
640 for (dir = OUT; dir <= IN; dir++) {
641 sce = &sc->sc_endpoints[i][dir];
642 if (sce && sce->pipeh)
643 usbd_abort_pipe(sce->pipeh);
648 if (--sc->sc_refcnt >= 0) {
650 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
651 wakeup(&sc->sc_endpoints[i][IN]);
652 /* Wait for processes to go away. */
653 usb_detach_wait(USBDEV(sc->sc_dev));
658 usbd_abort_pipe(sc->sc_pipeh_in);
660 if (sc->sc_pipeh_out)
661 usbd_abort_pipe(sc->sc_pipeh_out);
664 if (--sc->sc_refcnt >= 0) {
665 /* Wait for processes to go away. */
666 usb_detach_wait(USBDEV(sc->sc_dev));
671 #if defined(__NetBSD__) || defined(__OpenBSD__)
672 /* locate the major number */
673 for (maj = 0; maj < nchrdev; maj++)
674 if (cdevsw[maj].d_open == urioopen)
677 /* Nuke the vnodes for any open instances (calls close). */
678 mn = self->dv_unit * USB_MAX_ENDPOINTS;
679 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
680 #elif defined(__FreeBSD__)
681 /* XXX not implemented yet */
684 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
689 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
691 #if defined(__FreeBSD__)
693 urio_detach(device_t self)
695 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
696 device_set_desc(self, NULL);
700 #if (__FreeBSD__ >= 4)
701 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);
703 CDEV_DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass,
704 URIO_CDEV_MAJOR, urio_cdevsw, usbd_driver_load, 0);