1 .\" Copyright (c) 2004 Daniel Hartmeier
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
28 .\" $NetBSD: cdce.4,v 1.4 2004/12/08 18:35:56 peter Exp $
36 .Nd "USB Communication Device Class Ethernet (CDC ECM/NCM) driver"
38 To compile this driver into the kernel,
39 place the following lines in your
40 kernel configuration file:
41 .Bd -ragged -offset indent
50 Mobile Devices (eg. Huawei E3372, E5573 and others)
51 may need additionally the u3g command port:
52 .Bd -ragged -offset indent
57 Alternatively, to load the driver as a
58 module at boot time, place the following line in
60 .Bd -literal -offset indent
66 driver provides support for USB Host-to-Host (aka USB-to-USB) and
67 USB-to-Ethernet bridges based on the USB Communication Device Class
68 Ethernet Control Model (CDC ECM) and Network Control Model (CDC NCM)
70 It also provides device-side CDC ECM support.
72 The USB bridge appears as a regular network interface on both sides,
73 transporting Ethernet frames.
75 For more information on configuring this device, see
78 USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of
82 received and transmitted over separate USB bulk transfer endpoints.
86 driver does not support different media types or options.
90 Network Devices may need a connect command sequence via u3g
91 serial command port before they activate the NCM/ECM/ACM network
94 .Dl echo 'AT^NDISUP=1,1,"internet"' > /dev/cuaU[0].0
97 is your providers apn name.
99 The following devices are supported by the
105 Prolific PL-2501 Host-to-Host Bridge Controller
109 Terayon TJ-715 DOCSIS Cable Modem
111 Realtek RTL8156 USB GBE/2.5G Ethernet Family Controller
115 Huawei 3G/4G LTE (eg. E3372, E5573) and other mobile network devices
119 .It "cdce%d: no union descriptor"
120 The driver could not fetch an interface descriptor from the USB
122 For a manually added USB vendor/product, the CDCE_NO_UNION flag
123 can be tried to work around the missing descriptor.
124 .It "cdce%d: no data interface"
125 .It "cdce%d: could not read endpoint descriptor"
126 .It "cdce%d: unexpected endpoint"
127 .It "cdce%d: could not find data bulk in/out"
128 For a manually added USB vendor/product, these errors indicate
129 that the bridge is not compatible with the driver.
130 .It "cdce%d: watchdog timeout"
131 A packet was queued for transmission and a transmit command was
132 issued, however the device failed to acknowledge the transmission
133 before a timeout expired.
134 .It "cdce%d: no memory for rx list -- packet dropped!"
135 Memory allocation through MGETHDR or MCLGET failed, the system
136 is running low on mbufs.
137 .It "cdce%d: abort/close rx/tx pipe failed"
138 .It "cdce%d: rx/tx list init failed"
139 .It "cdce%d: open rx/tx pipe failed"
140 .It "cdce%d: usb error on rx/tx"
154 .%T "Universal Serial Bus Class Definitions for Communication Devices"
155 .%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
158 .%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller"
159 .%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530
164 device driver first appeared in
173 driver was written by
174 .An Craig Boston Aq Mt craig@tobuj.gank.org
178 .An Bill Paul Aq Mt wpaul@windriver.com
182 .An Daniel Hartmeier Aq Mt dhartmei@openbsd.org .
184 Many USB devices notoriously fail to report their class and interfaces
186 Undetected products might work flawlessly when their vendor and product IDs
187 are added to the driver manually.