xref: /openbsd/share/man/man4/cdce.4 (revision 898184e3)
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.\" $OpenBSD: cdce.4,v 1.16 2012/08/18 08:44:25 jmc Exp $
29.\"
30.Dd $Mdocdate: August 18 2012 $
31.Dt CDCE 4
32.Os
33.Sh NAME
34.Nm cdce
35.Nd USB Communication Device Class Ethernet device
36.Sh SYNOPSIS
37.Cd "cdce*  at uhub?"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides support for USB Host-to-Host (aka USB-to-USB) bridges
42based on the USB Communication Device Class (CDC) and Ethernet subclass,
43including the following:
44.Pp
45.Bl -bullet -compact -offset indent
46.It
47Acer Labs USB 2.0 Data Link
48.It
49Dell Wireless 5530
50.It
51Dell Wireless 5540
52.It
53FRITZ!Box Fon ata 1020
54.It
55G.Mate YP3X00
56.It
57Motorola USBNET
58.It
59NetChip EthernetGadget
60.It
61Prolific PL-2501
62.It
63Sharp Zaurus
64.It
65Sony Ericsson K610i
66.It
67Sony Ericsson F3705g
68.It
69Zyxel P-971M
70.El
71.Pp
72The USB bridge appears as a regular network interface on both sides,
73transporting Ethernet frames.
74USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of
75up to 480Mbps.
76Packets are
77received and transmitted over separate USB bulk transfer endpoints.
78.Pp
79The
80.Nm
81driver does not support different media types or options.
82For more information on configuring this device, see
83.Xr ifconfig 8 .
84.Sh DIAGNOSTICS
85.Bl -diag
86.It "cdce%d: extra ethernet descriptor"
87There is more than one Ethernet descriptor.
88.It "cdce%d: no data interface"
89The data interface announced by the union descriptor cannot be found.
90.It "cdce%d: no descriptor for interrupt endpoint %d"
91.It "cdce%d: interface alternate setting %d failed"
92.It "cdce%d: no descriptor for bulk endpoint %d"
93.It "cdce%d: could not find data bulk in/out"
94For a manually added USB vendor/product, these errors indicate
95that the bridge is not compatible with the driver.
96.It "cdce%d: watchdog timeout"
97A packet was queued for transmission and a transmit command was
98issued, however the device failed to acknowledge the transmission
99before a timeout expired.
100.It "cdce%d: no memory for rx list -- packet dropped!"
101Memory allocation through MGETHDR or MCLGET failed, the system
102is running low on mbufs.
103.It "cdce%d: abort/close rx/tx/interrupt pipe failed"
104.It "cdce%d: rx/tx list init failed"
105.It "cdce%d: open rx/tx/interrupt pipe failed"
106.It "cdce%d: usb error on rx/tx"
107.El
108.Sh SEE ALSO
109.Xr arp 4 ,
110.Xr cdcef 4 ,
111.Xr intro 4 ,
112.Xr netintro 4 ,
113.Xr usb 4 ,
114.Xr hostname.if 5 ,
115.Xr ifconfig 8
116.Rs
117.%T "Universal Serial Bus Class Definitions for Communication Devices"
118.%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
119.Re
120.Rs
121.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller"
122.Re
123.Sh HISTORY
124The
125.Nm
126device driver first appeared in
127.Ox 3.6 .
128.Sh AUTHORS
129.An -nosplit
130The
131.Nm
132driver was written by
133.An Craig Boston Aq craig@tobuj.gank.org
134based on the
135.Xr aue 4
136driver written by
137.An Bill Paul Aq wpaul@windriver.com
138and ported to
139.Ox
140by
141.An Daniel Hartmeier Aq dhartmei@openbsd.org .
142.Sh CAVEATS
143Many USB devices notoriously fail to report their class and interfaces
144correctly.
145Undetected products might work flawlessly when their vendor and product IDs
146are added to the driver manually.
147