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 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
36 * 2000/3/24 added NetBSD/OpenBSD support (from Alex Nemirovsky)
37 * 2000/3/07 use two bulk-pipe handles for read and write (Dirk)
38 * 2000/3/06 change major number(143), and copyright header
39 * some fix for 4.0 (Dirk)
40 * 2000/3/05 codes for FreeBSD 4.x - CURRENT (Thanks to Dirk-Willem van Gulik)
41 * 2000/3/01 remove retry code from urioioctl()
42 * change method of bulk transfer (no interrupt)
43 * 2000/2/28 small fixes for new rio_usb.h
44 * 2000/2/24 first version.
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #if defined(__NetBSD__)
52 #include <sys/device.h>
53 #include <sys/ioctl.h>
54 #elif defined(__FreeBSD__)
55 #include <sys/module.h>
57 #include <sys/ioccom.h>
59 #include <sys/fcntl.h>
60 #include <sys/filio.h>
65 #if __FreeBSD_version >= 500014
66 #include <sys/selinfo.h>
68 #include <sys/select.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>
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 */
100 #if defined(__NetBSD__)
101 int urioopen(dev_t, int, int, struct proc *);
102 int urioclose(dev_t, int, int, struct proc *p);
103 int urioread(dev_t, struct uio *uio, int);
104 int uriowrite(dev_t, struct uio *uio, int);
105 int urioioctl(dev_t, u_long, caddr_t, int, struct proc *);
108 #define RIO_UE_GET_DIR(p) ((UE_GET_DIR(p) == UE_DIR_IN) ? RIO_IN :\
109 ((UE_GET_DIR(p) == UE_DIR_OUT) ? RIO_OUT :\
111 #elif defined(__FreeBSD__)
119 Static struct cdevsw urio_cdevsw = {
120 .d_version = D_VERSION,
121 .d_flags = D_NEEDGIANT,
123 .d_close = urioclose,
125 .d_write = uriowrite,
126 .d_ioctl = urioioctl,
128 #if __FreeBSD_version < 500014
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__)
151 struct cdev *sc_dev_t;
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);
204 sc->sc_udev = udev = uaa->device;
206 #if defined(__FreeBSD__)
207 if ((!uaa->device) || (!uaa->iface)) {
208 ermsg = "device or iface";
211 sc->sc_iface = iface = uaa->iface;
212 #elif defined(__NetBSD__) || defined(__OpenBSD__)
217 r = usbd_interface_count(udev, &niface);
222 r = usbd_device2interface_handle(udev, 0, &iface);
227 sc->sc_iface = iface;
231 sc->sc_pipeh_out = 0;
234 r = usbd_endpoint_count(iface, &epcount);
235 if (r != USBD_NORMAL_COMPLETION) {
240 sc->sc_epaddr[RIO_OUT] = 0xff;
241 sc->sc_epaddr[RIO_IN] = 0x00;
243 for (i = 0; i < epcount; i++) {
244 usb_endpoint_descriptor_t *edesc =
245 usbd_interface2endpoint_descriptor(iface, i);
249 ermsg = "interface endpoint";
253 d = RIO_UE_GET_DIR(edesc->bEndpointAddress);
255 sc->sc_epaddr[d] = edesc->bEndpointAddress;
257 if ( sc->sc_epaddr[RIO_OUT] == 0xff ||
258 sc->sc_epaddr[RIO_IN] == 0x00) {
263 #if defined(__FreeBSD__)
264 /* XXX no error trapping, no storing of struct cdev **/
265 sc->sc_dev_t = make_dev(&urio_cdevsw, device_get_unit(self),
266 UID_ROOT, GID_OPERATOR,
267 0644, "urio%d", device_get_unit(self));
268 #elif defined(__NetBSD__) || defined(__OpenBSD__)
269 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
273 DPRINTFN(10, ("urio_attach: %p\n", sc->sc_udev));
275 USB_ATTACH_SUCCESS_RETURN;
278 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
279 USB_ATTACH_ERROR_RETURN;
284 urioopen(struct cdev *dev, int flag, int mode, usb_proc_ptr p)
287 struct urio_softc * sc;
289 int unit = URIOUNIT(dev);
290 USB_GET_SC_OPEN(urio, unit, sc);
292 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
298 if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
303 sc->sc_pipeh_out = 0;
304 if (usbd_open_pipe(sc->sc_iface,
305 sc->sc_epaddr[RIO_IN], 0, &sc->sc_pipeh_in)
306 != USBD_NORMAL_COMPLETION)
311 if (usbd_open_pipe(sc->sc_iface,
312 sc->sc_epaddr[RIO_OUT], 0, &sc->sc_pipeh_out)
313 != USBD_NORMAL_COMPLETION)
315 usbd_close_pipe(sc->sc_pipeh_in);
317 sc->sc_pipeh_out = 0;
324 urioclose(struct cdev *dev, int flag, int mode, usb_proc_ptr p)
327 struct urio_softc * sc;
329 int unit = URIOUNIT(dev);
330 USB_GET_SC(urio, unit, sc);
332 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n", flag, mode, 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 cdev *dev, struct uio *uio, int flag)
350 struct urio_softc * sc;
351 usbd_xfer_handle reqh;
353 usbd_request_handle reqh;
354 usbd_private_handle r_priv;
356 usbd_status r_status;
358 int unit = URIOUNIT(dev);
360 char buf[URIO_BBSIZE];
364 USB_GET_SC(urio, unit, sc);
366 DPRINTFN(5, ("urioread: %d\n", unit));
372 reqh = usbd_alloc_xfer(sc->sc_udev);
374 reqh = usbd_alloc_request();
378 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
379 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n));
382 usbd_setup_xfer(reqh, sc->sc_pipeh_in, 0, buf, tn,
383 0, RIO_RW_TIMEOUT, 0);
385 r = usbd_setup_request(reqh, sc->sc_pipeh_in, 0, buf, tn,
386 0, RIO_RW_TIMEOUT, 0);
387 if (r != USBD_NORMAL_COMPLETION) {
392 r = usbd_sync_transfer(reqh);
393 if (r != USBD_NORMAL_COMPLETION) {
394 DPRINTFN(1, ("urioread: error=%d\n", r));
395 usbd_clear_endpoint_stall(sc->sc_pipeh_in);
401 usbd_get_xfer_status(reqh, 0, 0, &tn, 0);
403 usbd_get_request_status(reqh, &r_priv, &r_buff, &tn, &r_status);
406 DPRINTFN(1, ("urioread: got %d bytes\n", tn));
407 error = uiomove(buf, tn, uio);
412 usbd_free_xfer(reqh);
414 usbd_free_request(reqh);
421 uriowrite(struct cdev *dev, struct uio *uio, int flag)
424 struct urio_softc * sc;
425 usbd_xfer_handle reqh;
427 usbd_request_handle reqh;
429 int unit = URIOUNIT(dev);
431 char buf[URIO_BBSIZE];
435 USB_GET_SC(urio, unit, sc);
437 DPRINTFN(5, ("uriowrite: %d\n", unit));
443 reqh = usbd_alloc_xfer(sc->sc_udev);
445 reqh = usbd_alloc_request();
449 while ((n = min(URIO_BBSIZE, uio->uio_resid)) != 0) {
450 error = uiomove(buf, n, uio);
453 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n));
455 usbd_setup_xfer(reqh, sc->sc_pipeh_out, 0, buf, n,
456 0, RIO_RW_TIMEOUT, 0);
458 r = usbd_setup_request(reqh, sc->sc_pipeh_out, 0, buf, n,
459 0, RIO_RW_TIMEOUT, 0);
460 if (r != USBD_NORMAL_COMPLETION) {
465 r = usbd_sync_transfer(reqh);
466 if (r != USBD_NORMAL_COMPLETION) {
467 DPRINTFN(1, ("uriowrite: error=%d\n", r));
468 usbd_clear_endpoint_stall(sc->sc_pipeh_out);
473 usbd_get_xfer_status(reqh, 0, 0, 0, 0);
478 usbd_free_xfer(reqh);
480 usbd_free_request(reqh);
488 urioioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
491 struct urio_softc * sc;
493 int unit = URIOUNIT(dev);
494 struct RioCommand *rio_cmd;
495 int requesttype, len;
498 usb_device_request_t req;
499 int req_flags = 0, req_actlen = 0;
504 USB_GET_SC(urio, unit, sc);
507 case RIO_RECV_COMMAND:
508 if (!(flag & FWRITE))
510 rio_cmd = (struct RioCommand *)addr;
513 len = rio_cmd->length;
515 requesttype = rio_cmd->requesttype | UT_READ_VENDOR_DEVICE;
516 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
517 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
520 case RIO_SEND_COMMAND:
521 if (!(flag & FWRITE))
523 rio_cmd = (struct RioCommand *)addr;
526 len = rio_cmd->length;
528 requesttype = rio_cmd->requesttype | UT_WRITE_VENDOR_DEVICE;
529 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
530 requesttype, rio_cmd->request, rio_cmd->value, rio_cmd->index, len));
538 /* Send rio control message */
539 req.bmRequestType = requesttype;
540 req.bRequest = rio_cmd->request;
541 USETW(req.wValue, rio_cmd->value);
542 USETW(req.wIndex, rio_cmd->index);
543 USETW(req.wLength, len);
545 if (len < 0 || len > 32767)
548 iov.iov_base = (caddr_t)rio_cmd->buffer;
554 uio.uio_segflg = UIO_USERSPACE;
556 req.bmRequestType & UT_READ ?
557 UIO_READ : UIO_WRITE;
559 ptr = malloc(len, M_TEMP, M_WAITOK);
560 if (uio.uio_rw == UIO_WRITE) {
561 error = uiomove(ptr, len, &uio);
567 r = usbd_do_request_flags(sc->sc_udev, &req,
568 ptr, req_flags, &req_actlen,
569 USBD_DEFAULT_TIMEOUT);
570 if (r == USBD_NORMAL_COMPLETION) {
573 if (uio.uio_rw == UIO_READ) {
574 error = uiomove(ptr, len, &uio);
588 #if defined(__NetBSD__) || defined(__OpenBSD__)
590 urio_activate(device_ptr_t self, enum devact act)
592 struct urio_softc *sc = (struct urio_softc *)self;
599 case DVACT_DEACTIVATE:
608 USB_DETACH_START(urio, sc);
609 struct urio_endpoint *sce;
612 #if defined(__NetBSD__) || defined(__OpenBSD__)
615 DPRINTF(("urio_detach: sc=%p flags=%d\n", sc, flags));
616 #elif defined(__FreeBSD__)
617 DPRINTF(("urio_detach: sc=%p\n", sc));
621 /* Abort all pipes. Causes processes waiting for transfer to wake. */
623 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
624 for (dir = OUT; dir <= IN; dir++) {
625 sce = &sc->sc_endpoints[i][dir];
626 if (sce && sce->pipeh)
627 usbd_abort_pipe(sce->pipeh);
632 if (--sc->sc_refcnt >= 0) {
634 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
635 wakeup(&sc->sc_endpoints[i][IN]);
636 /* Wait for processes to go away. */
637 usb_detach_wait(USBDEV(sc->sc_dev));
642 usbd_abort_pipe(sc->sc_pipeh_in);
644 if (sc->sc_pipeh_out)
645 usbd_abort_pipe(sc->sc_pipeh_out);
648 if (--sc->sc_refcnt >= 0) {
649 /* Wait for processes to go away. */
650 usb_detach_wait(USBDEV(sc->sc_dev));
655 #if defined(__NetBSD__) || defined(__OpenBSD__)
656 /* locate the major number */
657 for (maj = 0; maj < nchrdev; maj++)
658 if (cdevsw[maj].d_open == urioopen)
661 /* Nuke the vnodes for any open instances (calls close). */
662 mn = self->dv_unit * USB_MAX_ENDPOINTS;
663 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
666 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
671 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
673 #if defined(__FreeBSD__)
675 urio_detach(device_t self)
677 struct urio_softc *sc = device_get_softc(self);
679 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
680 destroy_dev(sc->sc_dev_t);
681 /* XXX not implemented yet */
682 device_set_desc(self, NULL);
686 DRIVER_MODULE(urio, uhub, urio_driver, urio_devclass, usbd_driver_load, 0);