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: head/share/man/man4/cdce.4 147432 2005-06-16 18:46:17Z ru $
|
29.\" $FreeBSD: head/share/man/man4/cdce.4 148145 2005-07-19 00:26:30Z trhodes $ |
30.\"
|
31.Dd October 22, 2004
|
31.Dd July 16, 2005 |
32.Dt CDCE 4 33.Os 34.Sh NAME 35.Nm cdce
|
36.Nd USB Communication Device Class Ethernet driver
|
36.Nd "USB Communication Device Class Ethernet driver" |
37.Sh SYNOPSIS
|
38To compile support for the 39.Nm 40driver into your kernel, place the following lines in your kernel configuration 41file: 42.Bd -ragged -offset indent |
43.Cd "device uhci" 44.Cd "device ohci" 45.Cd "device usb" 46.Cd "device cdce"
|
47.Ed 48.Pp 49Alternatively, to load the 50.Nm 51driver at boot time, place the following line in 52.Xr loader.conf 5 : 53.Bd -literal -offset indent 54if_cdce_load="YES" 55.Ed |
56.Sh DESCRIPTION 57The 58.Nm 59driver provides support for USB Host-to-Host (aka USB-to-USB) and 60USB-to-Ethernet bridges based on the USB Communication Device Class 61(CDC) and Ethernet subclass, including the following: 62.Pp 63.Bl -bullet -compact 64.It 65Prolific PL-2501 Host-to-Host Bridge Controller 66.It 67Sharp Zaurus PDA 68.It 69Terayon TJ-715 DOCSIS Cable Modem 70.El 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.Sh DIAGNOSTICS 88.Bl -diag 89.It "cdce%d: no union descriptor" 90The driver could not fetch an interface descriptor from the USB 91device. 92For a manually added USB vendor/product, the CDCE_NO_UNION flag 93can be tried to work around the missing descriptor. 94.It "cdce%d: no data interface" 95.It "cdce%d: could not read endpoint descriptor" 96.It "cdce%d: unexpected endpoint" 97.It "cdce%d: could not find data bulk in/out" 98For a manually added USB vendor/product, these errors indicate 99that the bridge is not compatible with the driver. 100.It "cdce%d: watchdog timeout" 101A packet was queued for transmission and a transmit command was 102issued, however the device failed to acknowledge the transmission 103before a timeout expired. 104.It "cdce%d: no memory for rx list -- packet dropped!" 105Memory allocation through MGETHDR or MCLGET failed, the system 106is running low on mbufs. 107.It "cdce%d: abort/close rx/tx pipe failed" 108.It "cdce%d: rx/tx list init failed" 109.It "cdce%d: open rx/tx pipe failed" 110.It "cdce%d: usb error on rx/tx" 111.El 112.Sh SEE ALSO 113.Xr arp 4 , 114.Xr intro 4 , 115.Xr netintro 4 , 116.Xr usb 4 , 117.\" .Xr hostname.if 5 , 118.Xr ifconfig 8 119.Rs 120.%T "Universal Serial Bus Class Definitions for Communication Devices" 121.%O http://www.usb.org/developers/devclass_docs/usbcdc11.pdf 122.Re 123.Rs 124.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller" 125.%O http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530 126.Re 127.Sh HISTORY 128The 129.Nm 130device driver first appeared in 131.Ox 3.6 , 132.Nx 3.0 133and 134.Fx 6.0 . 135.Sh AUTHORS 136.An -nosplit 137The 138.Nm 139driver was written by 140.An Craig Boston Aq craig@tobuj.gank.org 141based on the 142.Xr aue 4 143driver written by 144.An Bill Paul Aq wpaul@windriver.com 145and ported to 146.Ox 147by 148.An Daniel Hartmeier Aq dhartmei@openbsd.org . 149.Sh CAVEATS 150Many USB devices notoriously fail to report their class and interfaces 151correctly. 152Undetected products might work flawlessly when their vendor and product IDs 153are added to the driver manually.
|