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.12 2015/01/05 10:48:40 jmcneill Exp $ 29.\" 30.Dd January 5, 2015 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 50G.Mate YP3X00 51.It 52Motorola USBNET 53.It 54NetChip EthernetGadget 55.It 56Prolific PL-2501 57.It 58Realtek RTL8152B Ethernet controller 59.It 60Sharp Zaurus 61.El 62.Pp 63The USB bridge appears as a regular network interface on both sides, 64transporting Ethernet frames. 65.Pp 66For more information on configuring this device, see 67.Xr ifconfig 8 . 68.Pp 69USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of 70up to 480Mbps. 71.Pp 72Packets are 73received and transmitted over separate USB bulk transfer endpoints. 74.Pp 75The 76.Nm 77driver does not support different media types or options. 78.Sh DIAGNOSTICS 79.Bl -diag 80.It "cdce%d: no union descriptor" 81The driver couldn't fetch an interface descriptor from the USB 82device. 83For a manually added USB vendor/product, the CDCE_NO_UNION flag 84can be tried to work around the missing descriptor. 85.It "cdce%d: no data interface" 86.It "cdce%d: could not read endpoint descriptor" 87.It "cdce%d: unexpected endpoint" 88.It "cdce%d: could not find data bulk in/out" 89For a manually added USB vendor/product, these errors indicate 90that the bridge is not compatible with the driver. 91.It "cdce%d: watchdog timeout" 92A packet was queued for transmission and a transmit command was 93issued, however the device failed to acknowledge the transmission 94before a timeout expired. 95.It "cdce%d: no memory for rx list -- packet dropped!" 96Memory allocation through MGETHDR or MCLGET failed, the system 97is running low on mbufs. 98.It "cdce%d: abort/close rx/tx pipe failed" 99.It "cdce%d: rx/tx list init failed" 100.It "cdce%d: open rx/tx pipe failed" 101.It "cdce%d: usb error on rx/tx" 102.El 103.Sh SEE ALSO 104.Xr arp 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.%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