diff options
Diffstat (limited to 'static/netbsd/man4/cdce.4')
| -rw-r--r-- | static/netbsd/man4/cdce.4 | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/static/netbsd/man4/cdce.4 b/static/netbsd/man4/cdce.4 new file mode 100644 index 00000000..fafa9b5f --- /dev/null +++ b/static/netbsd/man4/cdce.4 @@ -0,0 +1,145 @@ +.\" $NetBSD: cdce.4,v 1.19 2023/11/05 17:52:09 mrg Exp $ +.\" +.\" Copyright (c) 2004 Daniel Hartmeier +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" - Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" - Redistributions in binary form must reproduce the above +.\" copyright notice, this list of conditions and the following +.\" disclaimer in the documentation and/or other materials provided +.\" with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd November 5, 2023 +.Dt CDCE 4 +.Os +.Sh NAME +.Nm cdce +.Nd USB Communication Device Class Ethernet driver +.Sh SYNOPSIS +.Cd "cdce* at uhub? port ?" +.Sh DESCRIPTION +The +.Nm +driver provides support for USB Host-to-Host (aka USB-to-USB) bridges +and USB-to-Ethernet adapters based on the USB Communication Device Class (CDC) +and Ethernet subclass, +including the following: +.Pp +.Bl -bullet -compact +.It +Acer Labs USB 2.0 Data Link +.It +Anker A7611 +.It +Club 3D Adapter LAN-Adapter (CAC-1420) +.It +DIEWU USB-DW8152 +.It +G.Mate YP3X00 +.It +Huawei E5573s-320s +.It +Motorola USBNET +.It +NetChip EthernetGadget +.It +Prolific PL-2501 +.It +Realtek RTL8152B, RTL8156, and RTL8156B Ethernet controllers +.It +Sharp Zaurus +.El +.Pp +The USB bridge appears as a regular network interface on both sides, +transporting Ethernet frames. +.Pp +For more information on configuring this device, see +.Xr ifconfig 8 . +.Pp +USB 1.x bridges support speeds of up to 12Mbps, USB 2.0 speeds of +up to 480Mbps, and USB 3.0 speeds of up to 5Gbps. +.Pp +Packets are +received and transmitted over separate USB bulk transfer endpoints. +.Pp +The +.Nm +driver does not support different media types or options. +.Sh DIAGNOSTICS +.Bl -diag +.It "cdce%d: no union descriptor" +The driver couldn't fetch an interface descriptor from the USB +device. +For a manually added USB vendor/product, the CDCE_NO_UNION flag +can be tried to work around the missing descriptor. +.It "cdce%d: no data interface" +.It "cdce%d: could not read endpoint descriptor" +.It "cdce%d: unexpected endpoint" +.It "cdce%d: could not find data bulk in/out" +For a manually added USB vendor/product, these errors indicate +that the bridge is not compatible with the driver. +.El +.Pp +Also see +.Xr usbnet 4 +for diagnostics. +.Sh SEE ALSO +.Xr arp 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr usbnet 4 , +.Xr ifconfig.if 5 , +.Xr ifconfig 8 +.Rs +.%T "Universal Serial Bus Class Definitions for Communication Devices" +.%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf +.Re +.Rs +.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller" +.%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530 +.Re +.Sh HISTORY +The +.Nm +device driver first appeared in +.Ox 3.6 +and +.Nx 3.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Craig Boston Aq Mt craig@tobuj.gank.org +based on the +.Xr aue 4 +driver written by +.An Bill Paul Aq Mt wpaul@windriver.com +and ported to +.Ox +by +.An Daniel Hartmeier Aq Mt dhartmei@openbsd.org . +.Sh CAVEATS +Many USB devices notoriously fail to report their class and interfaces +correctly. +Undetected products might work flawlessly when their vendor and product IDs +are added to the driver manually. |
