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.18 2007/06/28 06:32:33 hasso 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 #include <sys/module.h>
54 #include <sys/ioccom.h>
55 #include <sys/fcntl.h>
56 #include <sys/filio.h>
61 #include <sys/select.h>
62 #include <sys/vnode.h>
64 #include <sys/sysctl.h>
66 #include <sys/thread2.h>
68 #include <bus/usb/usb.h>
69 #include <bus/usb/usbdi.h>
70 #include <bus/usb/usbdi_util.h>
72 #include <bus/usb/usbdevs.h>
73 #include <bus/usb/rio500_usb.h>
76 #define DPRINTF(x) if (uriodebug) logprintf x
77 #define DPRINTFN(n,x) if (uriodebug>(n)) logprintf x
79 SYSCTL_NODE(_hw_usb
, OID_AUTO
, urio
, CTLFLAG_RW
, 0, "USB urio");
80 SYSCTL_INT(_hw_usb_urio
, OID_AUTO
, debug
, CTLFLAG_RW
,
81 &uriodebug
, 0, "urio debug level");
87 /* difference of usbd interface */
100 #define URIO_CDEV_MAJOR 143
102 static struct dev_ops urio_ops
= {
103 { "urio", URIO_CDEV_MAJOR
, 0 },
105 .d_close
= urioclose
,
107 .d_write
= uriowrite
,
108 .d_ioctl
= urioioctl
,
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 :\
114 #define URIO_BBSIZE 1024
118 usbd_device_handle sc_udev
;
119 usbd_interface_handle sc_iface
;
122 usbd_pipe_handle sc_pipeh_in
;
123 usbd_pipe_handle sc_pipeh_out
;
129 #define URIOUNIT(n) (minor(n))
131 #define RIO_RW_TIMEOUT 4000 /* ms */
133 USB_DECLARE_DRIVER(urio
);
137 USB_MATCH_START(urio
, uaa
);
138 usb_device_descriptor_t
*dd
;
140 DPRINTFN(10,("urio_match\n"));
144 dd
= usbd_get_device_descriptor(uaa
->device
);
147 ((UGETW(dd
->idVendor
) == USB_VENDOR_DIAMOND
&&
148 UGETW(dd
->idProduct
) == USB_PRODUCT_DIAMOND_RIO500USB
) ||
149 (UGETW(dd
->idVendor
) == USB_VENDOR_DIAMOND2
&&
150 (UGETW(dd
->idProduct
) == USB_PRODUCT_DIAMOND2_RIO600USB
||
151 UGETW(dd
->idProduct
) == USB_PRODUCT_DIAMOND2_RIO800USB
))))
152 return UMATCH_VENDOR_PRODUCT
;
159 USB_ATTACH_START(urio
, sc
, uaa
);
161 usbd_device_handle udev
;
162 usbd_interface_handle iface
;
165 char * ermsg
= "<none>";
168 DPRINTFN(10,("urio_attach: sc=%p\n", sc
));
169 usbd_devinfo(uaa
->device
, 0, devinfo
);
171 kprintf("%s: %s\n", device_get_nameunit(sc
->sc_dev
), devinfo
);
173 sc
->sc_udev
= udev
= uaa
->device
;
175 if ((!uaa
->device
) || (!uaa
->iface
)) {
176 ermsg
= "device or iface";
179 sc
->sc_iface
= iface
= uaa
->iface
;
182 sc
->sc_pipeh_out
= 0;
185 r
= usbd_endpoint_count(iface
, &epcount
);
186 if (r
!= USBD_NORMAL_COMPLETION
) {
191 sc
->sc_epaddr
[RIO_OUT
] = 0xff;
192 sc
->sc_epaddr
[RIO_IN
] = 0x00;
194 for (i
= 0; i
< epcount
; i
++) {
195 usb_endpoint_descriptor_t
*edesc
=
196 usbd_interface2endpoint_descriptor(iface
, i
);
200 ermsg
= "interface endpoint";
204 d
= RIO_UE_GET_DIR(edesc
->bEndpointAddress
);
206 sc
->sc_epaddr
[d
] = edesc
->bEndpointAddress
;
208 if ( sc
->sc_epaddr
[RIO_OUT
] == 0xff ||
209 sc
->sc_epaddr
[RIO_IN
] == 0x00) {
214 dev_ops_add(&urio_ops
, -1, device_get_unit(self
));
215 make_dev(&urio_ops
, device_get_unit(self
),
216 UID_ROOT
, GID_OPERATOR
,
217 0644, "urio%d", device_get_unit(self
));
219 DPRINTFN(10, ("urio_attach: %p\n", sc
->sc_udev
));
221 USB_ATTACH_SUCCESS_RETURN
;
224 kprintf("%s: could not find %s\n", device_get_nameunit(sc
->sc_dev
),ermsg
);
225 USB_ATTACH_ERROR_RETURN
;
230 urioopen(struct dev_open_args
*ap
)
232 cdev_t dev
= ap
->a_head
.a_dev
;
234 struct urio_softc
* sc
;
236 int unit
= URIOUNIT(dev
);
237 USB_GET_SC_OPEN(urio
, unit
, sc
);
239 DPRINTFN(5, ("urioopen: flag=%d, mode=%d, unit=%d\n",
240 ap
->a_oflags
, ap
->a_devtype
, unit
));
245 if ((ap
->a_oflags
& (FWRITE
|FREAD
)) != (FWRITE
|FREAD
))
250 sc
->sc_pipeh_out
= 0;
251 if (usbd_open_pipe(sc
->sc_iface
,
252 sc
->sc_epaddr
[RIO_IN
], 0, &sc
->sc_pipeh_in
)
253 != USBD_NORMAL_COMPLETION
)
258 if (usbd_open_pipe(sc
->sc_iface
,
259 sc
->sc_epaddr
[RIO_OUT
], 0, &sc
->sc_pipeh_out
)
260 != USBD_NORMAL_COMPLETION
)
262 usbd_close_pipe(sc
->sc_pipeh_in
);
264 sc
->sc_pipeh_out
= 0;
271 urioclose(struct dev_close_args
*ap
)
273 cdev_t dev
= ap
->a_head
.a_dev
;
275 struct urio_softc
* sc
;
277 int unit
= URIOUNIT(dev
);
278 USB_GET_SC(urio
, unit
, sc
);
280 DPRINTFN(5, ("urioclose: flag=%d, mode=%d, unit=%d\n",
281 ap
->a_fflag
, ap
->a_devtype
, unit
));
283 usbd_close_pipe(sc
->sc_pipeh_in
);
285 if (sc
->sc_pipeh_out
)
286 usbd_close_pipe(sc
->sc_pipeh_out
);
289 sc
->sc_pipeh_out
= 0;
296 urioread(struct dev_read_args
*ap
)
298 cdev_t dev
= ap
->a_head
.a_dev
;
299 struct uio
*uio
= ap
->a_uio
;
301 struct urio_softc
* sc
;
302 usbd_xfer_handle reqh
;
304 usbd_request_handle reqh
;
305 usbd_private_handle r_priv
;
307 usbd_status r_status
;
309 int unit
= URIOUNIT(dev
);
311 char buf
[URIO_BBSIZE
];
315 USB_GET_SC(urio
, unit
, sc
);
317 DPRINTFN(5, ("urioread: %d\n", unit
));
323 reqh
= usbd_alloc_xfer(sc
->sc_udev
);
325 reqh
= usbd_alloc_request();
329 while ((n
= min(URIO_BBSIZE
, uio
->uio_resid
)) != 0) {
330 DPRINTFN(1, ("urioread: start transfer %d bytes\n", n
));
333 usbd_setup_xfer(reqh
, sc
->sc_pipeh_in
, 0, buf
, tn
,
334 0, RIO_RW_TIMEOUT
, 0);
336 r
= usbd_setup_request(reqh
, sc
->sc_pipeh_in
, 0, buf
, tn
,
337 0, RIO_RW_TIMEOUT
, 0);
338 if (r
!= USBD_NORMAL_COMPLETION
) {
343 r
= usbd_sync_transfer(reqh
);
344 if (r
!= USBD_NORMAL_COMPLETION
) {
345 DPRINTFN(1, ("urioread: error=%d\n", r
));
346 usbd_clear_endpoint_stall(sc
->sc_pipeh_in
);
352 usbd_get_xfer_status(reqh
, 0, 0, &tn
, 0);
354 usbd_get_request_status(reqh
, &r_priv
, &r_buff
, &tn
, &r_status
);
357 DPRINTFN(1, ("urioread: got %d bytes\n", tn
));
358 error
= uiomove(buf
, tn
, uio
);
363 usbd_free_xfer(reqh
);
365 usbd_free_request(reqh
);
372 uriowrite(struct dev_write_args
*ap
)
374 cdev_t dev
= ap
->a_head
.a_dev
;
375 struct uio
*uio
= ap
->a_uio
;
377 struct urio_softc
* sc
;
378 usbd_xfer_handle reqh
;
380 usbd_request_handle reqh
;
382 int unit
= URIOUNIT(dev
);
384 char buf
[URIO_BBSIZE
];
388 USB_GET_SC(urio
, unit
, sc
);
390 DPRINTFN(5, ("uriowrite: %d\n", unit
));
396 reqh
= usbd_alloc_xfer(sc
->sc_udev
);
398 reqh
= usbd_alloc_request();
402 while ((n
= min(URIO_BBSIZE
, uio
->uio_resid
)) != 0) {
403 error
= uiomove(buf
, n
, uio
);
406 DPRINTFN(1, ("uriowrite: transfer %d bytes\n", n
));
408 usbd_setup_xfer(reqh
, sc
->sc_pipeh_out
, 0, buf
, n
,
409 0, RIO_RW_TIMEOUT
, 0);
411 r
= usbd_setup_request(reqh
, sc
->sc_pipeh_out
, 0, buf
, n
,
412 0, RIO_RW_TIMEOUT
, 0);
413 if (r
!= USBD_NORMAL_COMPLETION
) {
418 r
= usbd_sync_transfer(reqh
);
419 if (r
!= USBD_NORMAL_COMPLETION
) {
420 DPRINTFN(1, ("uriowrite: error=%d\n", r
));
421 usbd_clear_endpoint_stall(sc
->sc_pipeh_out
);
426 usbd_get_xfer_status(reqh
, 0, 0, 0, 0);
431 usbd_free_xfer(reqh
);
433 usbd_free_request(reqh
);
441 urioioctl(struct dev_ioctl_args
*ap
)
443 cdev_t dev
= ap
->a_head
.a_dev
;
445 struct urio_softc
* sc
;
447 int unit
= URIOUNIT(dev
);
448 struct RioCommand
*rio_cmd
;
449 int requesttype
, len
;
452 usb_device_request_t req
;
453 int req_flags
= 0, req_actlen
= 0;
458 USB_GET_SC(urio
, unit
, sc
);
461 case RIO_RECV_COMMAND
:
462 if (!(ap
->a_fflag
& FWRITE
))
464 rio_cmd
= (struct RioCommand
*)ap
->a_data
;
467 len
= rio_cmd
->length
;
469 requesttype
= rio_cmd
->requesttype
| UT_READ_VENDOR_DEVICE
;
470 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
471 requesttype
, rio_cmd
->request
, rio_cmd
->value
, rio_cmd
->index
, len
));
474 case RIO_SEND_COMMAND
:
475 if (!(ap
->a_fflag
& FWRITE
))
477 rio_cmd
= (struct RioCommand
*)ap
->a_data
;
480 len
= rio_cmd
->length
;
482 requesttype
= rio_cmd
->requesttype
| UT_WRITE_VENDOR_DEVICE
;
483 DPRINTFN(1,("sending command:reqtype=%0x req=%0x value=%0x index=%0x len=%0x\n",
484 requesttype
, rio_cmd
->request
, rio_cmd
->value
, rio_cmd
->index
, len
));
492 /* Send rio control message */
493 req
.bmRequestType
= requesttype
;
494 req
.bRequest
= rio_cmd
->request
;
495 USETW(req
.wValue
, rio_cmd
->value
);
496 USETW(req
.wIndex
, rio_cmd
->index
);
497 USETW(req
.wLength
, len
);
499 if (len
< 0 || len
> 32767)
502 iov
.iov_base
= (caddr_t
)rio_cmd
->buffer
;
508 uio
.uio_segflg
= UIO_USERSPACE
;
510 req
.bmRequestType
& UT_READ
?
511 UIO_READ
: UIO_WRITE
;
512 uio
.uio_td
= curthread
;
513 ptr
= kmalloc(len
, M_TEMP
, M_WAITOK
);
514 if (uio
.uio_rw
== UIO_WRITE
) {
515 error
= uiomove(ptr
, len
, &uio
);
521 r
= usbd_do_request_flags(sc
->sc_udev
, &req
,
522 ptr
, req_flags
, &req_actlen
,
523 USBD_DEFAULT_TIMEOUT
);
524 if (r
== USBD_NORMAL_COMPLETION
) {
527 if (uio
.uio_rw
== UIO_READ
) {
528 error
= uiomove(ptr
, len
, &uio
);
542 urio_detach(device_t self
)
544 DPRINTF(("%s: disconnected\n", device_get_nameunit(self
)));
545 dev_ops_remove(&urio_ops
, -1, device_get_unit(self
));
546 /* XXX not implemented yet */
547 device_set_desc(self
, NULL
);
551 DRIVER_MODULE(urio
, uhub
, urio_driver
, urio_devclass
, usbd_driver_load
, 0);