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