xref: /netbsd-src/share/man/man4/cdce.4 (revision 82d56013d7b633d116a93943de88e08335357a7c)
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.17 2019/08/30 09:22:17 wiz Exp $
29.\"
30.Dd August 24, 2019
31.Dt CDCE 4
32.Os
33.Sh NAME
34.Nm cdce
35.Nd USB Communication Device Class Ethernet driver
36.Sh SYNOPSIS
37.Cd "cdce*  at uhub? port ?"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides support for USB Host-to-Host (aka USB-to-USB) bridges
42and USB-to-Ethernet adapters based on the USB Communication Device Class (CDC)
43and Ethernet subclass,
44including the following:
45.Pp
46.Bl -bullet -compact
47.It
48Acer Labs USB 2.0 Data Link
49.It
50Anker A7611
51.It
52DIEWU USB-DW8152
53.It
54G.Mate YP3X00
55.It
56Huawei E5573s-320s
57.It
58Motorola USBNET
59.It
60NetChip EthernetGadget
61.It
62Prolific PL-2501
63.It
64Realtek RTL8152B Ethernet controller
65.It
66Sharp Zaurus
67.El
68.Pp
69The USB bridge appears as a regular network interface on both sides,
70transporting Ethernet frames.
71.Pp
72For more information on configuring this device, see
73.Xr ifconfig 8 .
74.Pp
75USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of
76up to 480Mbps.
77.Pp
78Packets are
79received and transmitted over separate USB bulk transfer endpoints.
80.Pp
81The
82.Nm
83driver does not support different media types or options.
84.Sh DIAGNOSTICS
85.Bl -diag
86.It "cdce%d: no union descriptor"
87The driver couldn't fetch an interface descriptor from the USB
88device.
89For a manually added USB vendor/product, the CDCE_NO_UNION flag
90can be tried to work around the missing descriptor.
91.It "cdce%d: no data interface"
92.It "cdce%d: could not read endpoint descriptor"
93.It "cdce%d: unexpected endpoint"
94.It "cdce%d: could not find data bulk in/out"
95For a manually added USB vendor/product, these errors indicate
96that the bridge is not compatible with the driver.
97.El
98.Pp
99Also see
100.Xr usbnet 4
101for diagnostics.
102.Sh SEE ALSO
103.Xr arp 4 ,
104.Xr intro 4 ,
105.Xr netintro 4 ,
106.Xr usb 4 ,
107.Xr usbnet 4 ,
108.Xr ifconfig.if 5 ,
109.Xr ifconfig 8
110.Rs
111.%T "Universal Serial Bus Class Definitions for Communication Devices"
112.%U 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.%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530
117.Re
118.Sh HISTORY
119The
120.Nm
121device driver first appeared in
122.Ox 3.6
123and
124.Nx 3.0 .
125.Sh AUTHORS
126.An -nosplit
127The
128.Nm
129driver was written by
130.An Craig Boston Aq Mt craig@tobuj.gank.org
131based on the
132.Xr aue 4
133driver written by
134.An Bill Paul Aq Mt wpaul@windriver.com
135and ported to
136.Ox
137by
138.An Daniel Hartmeier Aq Mt dhartmei@openbsd.org .
139.Sh CAVEATS
140Many USB devices notoriously fail to report their class and interfaces
141correctly.
142Undetected products might work flawlessly when their vendor and product IDs
143are added to the driver manually.
144