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.13 2016/12/19 15:03:59 ryoon Exp $ 29.\" 30.Dd December 19, 2016 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 56Motorola USBNET 57.It 58NetChip EthernetGadget 59.It 60Prolific PL-2501 61.It 62Realtek RTL8152B Ethernet controller 63.It 64Sharp Zaurus 65.El 66.Pp 67The USB bridge appears as a regular network interface on both sides, 68transporting Ethernet frames. 69.Pp 70For more information on configuring this device, see 71.Xr ifconfig 8 . 72.Pp 73USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of 74up to 480Mbps. 75.Pp 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. 82.Sh DIAGNOSTICS 83.Bl -diag 84.It "cdce%d: no union descriptor" 85The driver couldn't fetch an interface descriptor from the USB 86device. 87For a manually added USB vendor/product, the CDCE_NO_UNION flag 88can be tried to work around the missing descriptor. 89.It "cdce%d: no data interface" 90.It "cdce%d: could not read endpoint descriptor" 91.It "cdce%d: unexpected endpoint" 92.It "cdce%d: could not find data bulk in/out" 93For a manually added USB vendor/product, these errors indicate 94that the bridge is not compatible with the driver. 95.It "cdce%d: watchdog timeout" 96A packet was queued for transmission and a transmit command was 97issued, however the device failed to acknowledge the transmission 98before a timeout expired. 99.It "cdce%d: no memory for rx list -- packet dropped!" 100Memory allocation through MGETHDR or MCLGET failed, the system 101is running low on mbufs. 102.It "cdce%d: abort/close rx/tx pipe failed" 103.It "cdce%d: rx/tx list init failed" 104.It "cdce%d: open rx/tx pipe failed" 105.It "cdce%d: usb error on rx/tx" 106.El 107.Sh SEE ALSO 108.Xr arp 4 , 109.Xr intro 4 , 110.Xr netintro 4 , 111.Xr usb 4 , 112.\" .Xr hostname.if 5 , 113.Xr ifconfig 8 114.Rs 115.%T "Universal Serial Bus Class Definitions for Communication Devices" 116.%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf 117.Re 118.Rs 119.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller" 120.%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530 121.Re 122.Sh HISTORY 123The 124.Nm 125device driver first appeared in 126.Ox 3.6 127and 128.Nx 3.0 . 129.Sh AUTHORS 130.An -nosplit 131The 132.Nm 133driver was written by 134.An Craig Boston Aq Mt craig@tobuj.gank.org 135based on the 136.Xr aue 4 137driver written by 138.An Bill Paul Aq Mt wpaul@windriver.com 139and ported to 140.Ox 141by 142.An Daniel Hartmeier Aq Mt dhartmei@openbsd.org . 143.Sh CAVEATS 144Many USB devices notoriously fail to report their class and interfaces 145correctly. 146Undetected products might work flawlessly when their vendor and product IDs 147are added to the driver manually. 148