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: head/share/man/man4/kue.4 267938 2014-06-26 21:46:14Z bapt $
  32 .\"
  33 .Dd November 16, 2018
  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 uether"
  48 .Cd "device kue"
  49 .Ed
  50 .Pp
  51 Alternatively, to load the driver as a
  52 module at boot time, place the following line in
  53 .Xr loader.conf 5 :
  54 .Bd -literal -offset indent
  55 if_kue_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for USB Ethernet adapters based on the Kawasaki
  61 LSI KL5KLUSB101B chipset.
  62 .Pp
  63 The KL5KLUSB101B supports a 128-entry multicast filter, single perfect
  64 filter entry for the station address and promiscuous mode.
  65 Packets are
  66 received and transmitted over separate USB bulk transfer endpoints.
  67 .Pp
  68 The Kawasaki chipset supports only 10Mbps half-duplex mode, hence there
  69 are no
  70 .Xr ifmedia 4
  71 modes to select.
  72 .Pp
  73 For more information on configuring this device, see
  74 .Xr ifconfig 8 .
  75 .Sh HARDWARE
  76 The
  77 .Nm
  78 driver supports Kawasaki LSI KL5KLUSB101B based USB Ethernet
  79 adapters including:
  80 .Pp
  81 .Bl -bullet -compact
  82 .It
  83 3Com 3c19250
  84 .It
  85 3Com 3c460 HomeConnect Ethernet USB Adapter
  86 .It
  87 ADS Technologies USB-10BT
  88 .It
  89 AOX USB101
  90 .It
  91 ATen UC10T
  92 .It
  93 Abocom URE 450
  94 .It
  95 Corega USB-T
  96 .It
  97 D-Link DSB-650C
  98 .It
  99 Entrega NET-USB-E45, NET-HUB-3U1E
 100 .It
 101 I/O Data USB ETT
 102 .It
 103 Kawasaki DU-H3E
 104 .It
 105 LinkSys USB10T
 106 .It
 107 Netgear EA101
 108 .It
 109 Peracom USB Ethernet Adapter
 110 .It
 111 Psion Gold Port USB Ethernet adapter
 112 .It
 113 SMC 2102USB, 2104USB
 114 .El
 115 .Sh DIAGNOSTICS
 116 .Bl -diag
 117 .It "kue%d: watchdog timeout"
 118 A packet was queued for transmission and a transmit command was
 119 issued, however the device failed to acknowledge the transmission
 120 before a timeout expired.
 121 .It "kue%d: no memory for rx list"
 122 The driver failed to allocate an mbuf for the receiver ring.
 123 .El
 124 .Sh SEE ALSO
 125 .Xr arp 4 ,
 126 .Xr ifmedia 4 ,
 127 .Xr netintro 4 ,
 128 .Xr ng_ether 4 ,
 129 .Xr ifconfig 8
 130 .Sh HISTORY
 131 The
 132 .Nm
 133 device driver first appeared in
 134 .Fx 4.0 .
 135 .Sh AUTHORS
 136 The
 137 .Nm
 138 driver was written by
 139 .An Bill Paul Aq Mt wpaul@ee.columbia.edu .
 140 .Sh BUGS
 141 The
 142 .Nm
 143 driver does not accumulate Ethernet collisions statistics because the
 144 Kawasaki firmware does not appear to maintain any internal statistics.