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