share/man/man4/cdce.4

   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 July 10, 2019
  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
  38 To compile this driver into the kernel,
  39 place the following lines in your
  40 kernel 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
  50 Alternatively, to load the driver as a
  51 module at boot time, place the following line in
  52 .Xr loader.conf 5 :
  53 .Bd -literal -offset indent
  54 if_cdce_load="YES"
  55 .Ed
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 driver provides support for USB Host-to-Host (aka USB-to-USB) and
  60 USB-to-Ethernet bridges based on the USB Communication Device Class
  61 Ethernet Control Model (CDC ECM) and Network Control Model (CDC NCM)
  62 specifications.
  63 It also provides device-side CDC ECM support.
  64 .Pp
  65 The USB bridge appears as a regular network interface on both sides,
  66 transporting Ethernet frames.
  67 .Pp
  68 For more information on configuring this device, see
  69 .Xr ifconfig 8 .
  70 .Pp
  71 USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of
  72 up to 480Mbps.
  73 .Pp
  74 Packets are
  75 received and transmitted over separate USB bulk transfer endpoints.
  76 .Pp
  77 The
  78 .Nm
  79 driver does not support different media types or options.
  80 .Sh HARDWARE
  81 The following devices are supported by the
  82 .Nm
  83 driver:
  84 .Pp
  85 .Bl -bullet -compact
  86 .It
  87 Prolific PL-2501 Host-to-Host Bridge Controller
  88 .It
  89 Sharp Zaurus PDA
  90 .It
  91 Terayon TJ-715 DOCSIS Cable Modem
  92 .It
  93 Realtek RTL8156 USB GBE/2.5G Ethernet Family Controller
  94 .It
  95 Planex USB-LAN2500R
  96 .El
  97 .Sh DIAGNOSTICS
  98 .Bl -diag
  99 .It "cdce%d: no union descriptor"
 100 The driver could not fetch an interface descriptor from the USB
 101 device.
 102 For a manually added USB vendor/product, the CDCE_NO_UNION flag
 103 can be tried to work around the missing descriptor.
 104 .It "cdce%d: no data interface"
 105 .It "cdce%d: could not read endpoint descriptor"
 106 .It "cdce%d: unexpected endpoint"
 107 .It "cdce%d: could not find data bulk in/out"
 108 For a manually added USB vendor/product, these errors indicate
 109 that the bridge is not compatible with the driver.
 110 .It "cdce%d: watchdog timeout"
 111 A packet was queued for transmission and a transmit command was
 112 issued, however the device failed to acknowledge the transmission
 113 before a timeout expired.
 114 .It "cdce%d: no memory for rx list -- packet dropped!"
 115 Memory allocation through MGETHDR or MCLGET failed, the system
 116 is running low on mbufs.
 117 .It "cdce%d: abort/close rx/tx pipe failed"
 118 .It "cdce%d: rx/tx list init failed"
 119 .It "cdce%d: open rx/tx pipe failed"
 120 .It "cdce%d: usb error on rx/tx"
 121 .El
 122 .Sh SEE ALSO
 123 .Xr arp 4 ,
 124 .Xr cdceem 4 ,
 125 .Xr intro 4 ,
 126 .Xr ipheth 4 ,
 127 .Xr netintro 4 ,
 128 .Xr urndis 4 ,
 129 .Xr usb 4 ,
 130 .Xr ifconfig 8
 131 .Rs
 132 .%T "Universal Serial Bus Class Definitions for Communication Devices"
 133 .%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
 134 .Re
 135 .Rs
 136 .%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller"
 137 .%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530
 138 .Re
 139 .Sh HISTORY
 140 The
 141 .Nm
 142 device driver first appeared in
 143 .Ox 3.6 ,
 144 .Nx 3.0
 145 and
 146 .Fx 6.0 .
 147 .Sh AUTHORS
 148 .An -nosplit
 149 The
 150 .Nm
 151 driver was written by
 152 .An Craig Boston Aq Mt craig@tobuj.gank.org
 153 based on the
 154 .Xr aue 4
 155 driver written by
 156 .An Bill Paul Aq Mt wpaul@windriver.com
 157 and ported to
 158 .Ox
 159 by
 160 .An Daniel Hartmeier Aq Mt dhartmei@openbsd.org .
 161 .Sh CAVEATS
 162 Many USB devices notoriously fail to report their class and interfaces
 163 correctly.
 164 Undetected products might work flawlessly when their vendor and product IDs
 165 are added to the driver manually.