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