share/man/man4/kue.4

   1 .\" Copyright (c) 1997, 1998, 1999, 2000
   2 .\"     Bill Paul <wpaul@ee.columbia.edu>. 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 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd October 7, 2006
  34 .Dt KUE 4
  35 .Os
  36 .Sh NAME
  37 .Nm kue
  38 .Nd "Kawasaki LSI KL5KUSB101B USB Ethernet driver"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following lines in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device uhci"
  45 .Cd "device ohci"
  46 .Cd "device usb"
  47 .Cd "device kue"
  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_kue_load="YES"
  55 .Ed
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 driver provides support for USB Ethernet adapters based on the Kawasaki
  60 LSI KL5KLUSB101B chipset.
  61 .Pp
  62 The KL5KLUSB101B supports a 128-entry multicast filter, single perfect
  63 filter entry for the station address and promiscuous mode.
  64 Packets are
  65 received and transmitted over separate USB bulk transfer endpoints.
  66 .Pp
  67 The Kawasaki chipset supports only 10Mbps half-duplex mode, hence there
  68 are no
  69 .Xr ifmedia 4
  70 modes to select.
  71 .Pp
  72 For more information on configuring this device, see
  73 .Xr ifconfig 8 .
  74 .Sh HARDWARE
  75 The
  76 .Nm
  77 driver supports Kawasaki LSI KL5KLUSB101B based USB Ethernet
  78 adapters including:
  79 .Pp
  80 .Bl -bullet -compact
  81 .It
  82 3Com 3c19250
  83 .It
  84 3Com 3c460 HomeConnect Ethernet USB Adapter
  85 .It
  86 ADS Technologies USB-10BT
  87 .It
  88 AOX USB101
  89 .It
  90 ATen UC10T
  91 .It
  92 Abocom URE 450
  93 .It
  94 Corega USB-T
  95 .It
  96 D-Link DSB-650C
  97 .It
  98 Entrega NET-USB-E45, NET-HUB-3U1E
  99 .It
 100 I/O Data USB ETT
 101 .It
 102 Kawasaki DU-H3E
 103 .It
 104 LinkSys USB10T
 105 .It
 106 Netgear EA101
 107 .It
 108 Peracom USB Ethernet Adapter
 109 .It
 110 Psion Gold Port USB Ethernet adapter
 111 .It
 112 SMC 2102USB, 2104USB
 113 .El
 114 .Sh DIAGNOSTICS
 115 .Bl -diag
 116 .It "kue%d: watchdog timeout"
 117 A packet was queued for transmission and a transmit command was
 118 issued, however the device failed to acknowledge the transmission
 119 before a timeout expired.
 120 .It "kue%d: no memory for rx list"
 121 The driver failed to allocate an mbuf for the receiver ring.
 122 .El
 123 .Sh SEE ALSO
 124 .Xr arp 4 ,
 125 .Xr netintro 4 ,
 126 .Xr ng_ether 4 ,
 127 .Xr ifconfig 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 device driver first appeared in
 132 .Fx 4.0 .
 133 .Sh AUTHORS
 134 The
 135 .Nm
 136 driver was written by
 137 .An Bill Paul Aq wpaul@ee.columbia.edu .
 138 .Sh BUGS
 139 The
 140 .Nm
 141 driver does not accumulate Ethernet collisions statistics because the
 142 Kawasaki firmware does not appear to maintain any internal statistics.