1.\" Copyright (c) 2004 Daniel Hartmeier
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" - Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" - Redistributions in binary form must reproduce the above
11.\" copyright notice, this list of conditions and the following
12.\" disclaimer in the documentation and/or other materials provided
13.\" with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26.\" POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $NetBSD: cdce.4,v 1.4 2004/12/08 18:35:56 peter Exp $
29.\" $FreeBSD: head/share/man/man4/cdce.4 147432 2005-06-16 18:46:17Z ru $
30.\"
31.Dd October 22, 2004
32.Dt CDCE 4
33.Os
34.Sh NAME
35.Nm cdce
36.Nd USB Communication Device Class Ethernet driver
37.Sh SYNOPSIS
38.Cd "device uhci"
39.Cd "device ohci"
40.Cd "device usb"
41.Cd "device cdce"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for USB Host-to-Host (aka USB-to-USB) and
46USB-to-Ethernet bridges based on the USB Communication Device Class
47(CDC) and Ethernet subclass, including the following:
48.Pp
49.Bl -bullet -compact
50.It
51Prolific PL-2501 Host-to-Host Bridge Controller
52.It
53Sharp Zaurus PDA
54.It
55Terayon TJ-715 DOCSIS Cable Modem
56.El
57.Pp
58The USB bridge appears as a regular network interface on both sides,
59transporting Ethernet frames.
60.Pp
61For more information on configuring this device, see
62.Xr ifconfig 8 .
63.Pp
64USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of
65up to 480Mbps.
66.Pp
67Packets are
68received and transmitted over separate USB bulk transfer endpoints.
69.Pp
70The
71.Nm
72driver does not support different media types or options.
73.Sh DIAGNOSTICS
74.Bl -diag
75.It "cdce%d: no union descriptor"
76The driver could not fetch an interface descriptor from the USB
77device.
78For a manually added USB vendor/product, the CDCE_NO_UNION flag
79can be tried to work around the missing descriptor.
80.It "cdce%d: no data interface"
81.It "cdce%d: could not read endpoint descriptor"
82.It "cdce%d: unexpected endpoint"
83.It "cdce%d: could not find data bulk in/out"
84For a manually added USB vendor/product, these errors indicate
85that the bridge is not compatible with the driver.
86.It "cdce%d: watchdog timeout"
87A packet was queued for transmission and a transmit command was
88issued, however the device failed to acknowledge the transmission
89before a timeout expired.
90.It "cdce%d: no memory for rx list -- packet dropped!"
91Memory allocation through MGETHDR or MCLGET failed, the system
92is running low on mbufs.
93.It "cdce%d: abort/close rx/tx pipe failed"
94.It "cdce%d: rx/tx list init failed"
95.It "cdce%d: open rx/tx pipe failed"
96.It "cdce%d: usb error on rx/tx"
97.El
98.Sh SEE ALSO
99.Xr arp 4 ,
100.Xr intro 4 ,
101.Xr netintro 4 ,
102.Xr usb 4 ,
103.\" .Xr hostname.if 5 ,
104.Xr ifconfig 8
105.Rs
106.%T "Universal Serial Bus Class Definitions for Communication Devices"
107.%O http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
108.Re
109.Rs
110.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller"
111.%O http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530
112.Re
113.Sh HISTORY
114The
115.Nm
116device driver first appeared in
117.Ox 3.6 ,
118.Nx 3.0
119and
120.Fx 6.0 .
121.Sh AUTHORS
122.An -nosplit
123The
124.Nm
125driver was written by
126.An Craig Boston Aq craig@tobuj.gank.org
127based on the
128.Xr aue 4
129driver written by
130.An Bill Paul Aq wpaul@windriver.com
131and ported to
132.Ox
133by
134.An Daniel Hartmeier Aq dhartmei@openbsd.org .
135.Sh CAVEATS
136Many USB devices notoriously fail to report their class and interfaces
137correctly.
138Undetected products might work flawlessly when their vendor and product IDs
139are added to the driver manually.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" - Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" - Redistributions in binary form must reproduce the above
11.\" copyright notice, this list of conditions and the following
12.\" disclaimer in the documentation and/or other materials provided
13.\" with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26.\" POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $NetBSD: cdce.4,v 1.4 2004/12/08 18:35:56 peter Exp $
29.\" $FreeBSD: head/share/man/man4/cdce.4 147432 2005-06-16 18:46:17Z ru $
30.\"
31.Dd October 22, 2004
32.Dt CDCE 4
33.Os
34.Sh NAME
35.Nm cdce
36.Nd USB Communication Device Class Ethernet driver
37.Sh SYNOPSIS
38.Cd "device uhci"
39.Cd "device ohci"
40.Cd "device usb"
41.Cd "device cdce"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for USB Host-to-Host (aka USB-to-USB) and
46USB-to-Ethernet bridges based on the USB Communication Device Class
47(CDC) and Ethernet subclass, including the following:
48.Pp
49.Bl -bullet -compact
50.It
51Prolific PL-2501 Host-to-Host Bridge Controller
52.It
53Sharp Zaurus PDA
54.It
55Terayon TJ-715 DOCSIS Cable Modem
56.El
57.Pp
58The USB bridge appears as a regular network interface on both sides,
59transporting Ethernet frames.
60.Pp
61For more information on configuring this device, see
62.Xr ifconfig 8 .
63.Pp
64USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of
65up to 480Mbps.
66.Pp
67Packets are
68received and transmitted over separate USB bulk transfer endpoints.
69.Pp
70The
71.Nm
72driver does not support different media types or options.
73.Sh DIAGNOSTICS
74.Bl -diag
75.It "cdce%d: no union descriptor"
76The driver could not fetch an interface descriptor from the USB
77device.
78For a manually added USB vendor/product, the CDCE_NO_UNION flag
79can be tried to work around the missing descriptor.
80.It "cdce%d: no data interface"
81.It "cdce%d: could not read endpoint descriptor"
82.It "cdce%d: unexpected endpoint"
83.It "cdce%d: could not find data bulk in/out"
84For a manually added USB vendor/product, these errors indicate
85that the bridge is not compatible with the driver.
86.It "cdce%d: watchdog timeout"
87A packet was queued for transmission and a transmit command was
88issued, however the device failed to acknowledge the transmission
89before a timeout expired.
90.It "cdce%d: no memory for rx list -- packet dropped!"
91Memory allocation through MGETHDR or MCLGET failed, the system
92is running low on mbufs.
93.It "cdce%d: abort/close rx/tx pipe failed"
94.It "cdce%d: rx/tx list init failed"
95.It "cdce%d: open rx/tx pipe failed"
96.It "cdce%d: usb error on rx/tx"
97.El
98.Sh SEE ALSO
99.Xr arp 4 ,
100.Xr intro 4 ,
101.Xr netintro 4 ,
102.Xr usb 4 ,
103.\" .Xr hostname.if 5 ,
104.Xr ifconfig 8
105.Rs
106.%T "Universal Serial Bus Class Definitions for Communication Devices"
107.%O http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
108.Re
109.Rs
110.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller"
111.%O http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530
112.Re
113.Sh HISTORY
114The
115.Nm
116device driver first appeared in
117.Ox 3.6 ,
118.Nx 3.0
119and
120.Fx 6.0 .
121.Sh AUTHORS
122.An -nosplit
123The
124.Nm
125driver was written by
126.An Craig Boston Aq craig@tobuj.gank.org
127based on the
128.Xr aue 4
129driver written by
130.An Bill Paul Aq wpaul@windriver.com
131and ported to
132.Ox
133by
134.An Daniel Hartmeier Aq dhartmei@openbsd.org .
135.Sh CAVEATS
136Many USB devices notoriously fail to report their class and interfaces
137correctly.
138Undetected products might work flawlessly when their vendor and product IDs
139are added to the driver manually.