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