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$ 30.\" 31.Dd February 10, 2023 32.Dt CDCE 4 33.Os 34.Sh NAME 35.Nm cdce 36.Nd "USB Communication Device Class Ethernet (CDC ECM/NCM) driver" 37.Sh SYNOPSIS 38To compile this driver into the kernel, 39place the following lines in your 40kernel configuration file: 41.Bd -ragged -offset indent 42.Cd "device uhci" 43.Cd "device ohci" 44.Cd "device usb" 45.Cd "device miibus" 46.Cd "device uether" 47.Cd "device cdce" 48.Ed 49.Pp 50Mobile Devices (eg. Huawei E3372, E5573 and others) 51may need additionally the u3g command port: 52.Bd -ragged -offset indent 53.Cd "device ucom" 54.Cd "device u3g" 55.Ed 56.Pp 57Alternatively, to load the driver as a 58module at boot time, place the following line in 59.Xr loader.conf 5 : 60.Bd -literal -offset indent 61if_cdce_load="YES" 62.Ed 63.Sh DESCRIPTION 64The 65.Nm 66driver provides support for USB Host-to-Host (aka USB-to-USB) and 67USB-to-Ethernet bridges based on the USB Communication Device Class 68Ethernet Control Model (CDC ECM) and Network Control Model (CDC NCM) 69specifications. 70It also provides device-side CDC ECM support. 71.Pp 72The USB bridge appears as a regular network interface on both sides, 73transporting Ethernet frames. 74.Pp 75For more information on configuring this device, see 76.Xr ifconfig 8 . 77.Pp 78USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of 79up to 480Mbps. 80.Pp 81Packets are 82received and transmitted over separate USB bulk transfer endpoints. 83.Pp 84The 85.Nm 86driver does not support different media types or options. 87.Pp 88Mobile 89.Nm 90Network Devices may need a connect command sequence via u3g 91serial command port before they activate the NCM/ECM/ACM network 92interface. 93For example: 94.Dl echo 'AT^NDISUP=1,1,"internet"' > /dev/cuaU[0].0 95where 96.Dq internet 97is your providers apn name. 98.Sh HARDWARE 99The following devices are supported by the 100.Nm 101driver: 102.Pp 103.Bl -bullet -compact 104.It 105Prolific PL-2501 Host-to-Host Bridge Controller 106.It 107Sharp Zaurus PDA 108.It 109Terayon TJ-715 DOCSIS Cable Modem 110.It 111Realtek RTL8156 USB GBE/2.5G Ethernet Family Controller 112.It 113Planex USB-LAN2500R 114.It 115Huawei 3G/4G LTE (eg. E3372, E5573) and other mobile network devices 116.El 117.Sh DIAGNOSTICS 118.Bl -diag 119.It "cdce%d: no union descriptor" 120The driver could not fetch an interface descriptor from the USB 121device. 122For a manually added USB vendor/product, the CDCE_NO_UNION flag 123can 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" 128For a manually added USB vendor/product, these errors indicate 129that the bridge is not compatible with the driver. 130.It "cdce%d: watchdog timeout" 131A packet was queued for transmission and a transmit command was 132issued, however the device failed to acknowledge the transmission 133before a timeout expired. 134.It "cdce%d: no memory for rx list -- packet dropped!" 135Memory allocation through MGETHDR or MCLGET failed, the system 136is 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" 141.El 142.Sh SEE ALSO 143.Xr arp 4 , 144.Xr cdceem 4 , 145.Xr intro 4 , 146.Xr ipheth 4 , 147.Xr netintro 4 , 148.Xr urndis 4 , 149.Xr usb 4 , 150.Xr ucom 4 , 151.Xr u3g 4 , 152.Xr ifconfig 8 153.Rs 154.%T "Universal Serial Bus Class Definitions for Communication Devices" 155.%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf 156.Re 157.Rs 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 160.Re 161.Sh HISTORY 162The 163.Nm 164device driver first appeared in 165.Ox 3.6 , 166.Nx 3.0 167and 168.Fx 6.0 . 169.Sh AUTHORS 170.An -nosplit 171The 172.Nm 173driver was written by 174.An Craig Boston Aq Mt craig@tobuj.gank.org 175based on the 176.Xr aue 4 177driver written by 178.An Bill Paul Aq Mt wpaul@windriver.com 179and ported to 180.Ox 181by 182.An Daniel Hartmeier Aq Mt dhartmei@openbsd.org . 183.Sh CAVEATS 184Many USB devices notoriously fail to report their class and interfaces 185correctly. 186Undetected products might work flawlessly when their vendor and product IDs 187are added to the driver manually. 188