xref: /freebsd/share/man/man4/kue.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1dfd1e98eSBill Paul.\" Copyright (c) 1997, 1998, 1999, 2000
2dfd1e98eSBill Paul.\"	Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
3dfd1e98eSBill Paul.\"
4dfd1e98eSBill Paul.\" Redistribution and use in source and binary forms, with or without
5dfd1e98eSBill Paul.\" modification, are permitted provided that the following conditions
6dfd1e98eSBill Paul.\" are met:
7dfd1e98eSBill Paul.\" 1. Redistributions of source code must retain the above copyright
8dfd1e98eSBill Paul.\"    notice, this list of conditions and the following disclaimer.
9dfd1e98eSBill Paul.\" 2. Redistributions in binary form must reproduce the above copyright
10dfd1e98eSBill Paul.\"    notice, this list of conditions and the following disclaimer in the
11dfd1e98eSBill Paul.\"    documentation and/or other materials provided with the distribution.
12dfd1e98eSBill Paul.\" 3. All advertising materials mentioning features or use of this software
13dfd1e98eSBill Paul.\"    must display the following acknowledgement:
14dfd1e98eSBill Paul.\"	This product includes software developed by Bill Paul.
15dfd1e98eSBill Paul.\" 4. Neither the name of the author nor the names of any co-contributors
16dfd1e98eSBill Paul.\"    may be used to endorse or promote products derived from this software
17dfd1e98eSBill Paul.\"   without specific prior written permission.
18dfd1e98eSBill Paul.\"
19dfd1e98eSBill Paul.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20dfd1e98eSBill Paul.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21dfd1e98eSBill Paul.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22dfd1e98eSBill Paul.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23dfd1e98eSBill Paul.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24dfd1e98eSBill Paul.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25dfd1e98eSBill Paul.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26dfd1e98eSBill Paul.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27dfd1e98eSBill Paul.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28dfd1e98eSBill Paul.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29dfd1e98eSBill Paul.\" THE POSSIBILITY OF SUCH DAMAGE.
30dfd1e98eSBill Paul.\"
31*2bb78c17SKevin Lo.Dd July 24, 2019
324c574bfdSRuslan Ermilov.Dt KUE 4
333d45e180SRuslan Ermilov.Os
34dfd1e98eSBill Paul.Sh NAME
35dfd1e98eSBill Paul.Nm kue
3686e3186eSTom Rhodes.Nd "Kawasaki LSI KL5KUSB101B USB Ethernet driver"
37dfd1e98eSBill Paul.Sh SYNOPSIS
3816d78bb8STom RhodesTo compile this driver into the kernel,
3916d78bb8STom Rhodesplace the following lines in your
4090296834STom Rhodeskernel configuration file:
4186e3186eSTom Rhodes.Bd -ragged -offset indent
42a376b5ffSChristian Brueffer.Cd "device uhci"
436b713d58SJeroen Ruigrok van der Werven.Cd "device ohci"
446b713d58SJeroen Ruigrok van der Werven.Cd "device usb"
45ff6b30b9SKevin Lo.Cd "device miibus"
46ff6b30b9SKevin Lo.Cd "device uether"
476b713d58SJeroen Ruigrok van der Werven.Cd "device kue"
4886e3186eSTom Rhodes.Ed
4986e3186eSTom Rhodes.Pp
5016d78bb8STom RhodesAlternatively, to load the driver as a
5116d78bb8STom Rhodesmodule at boot time, place the following line in
5286e3186eSTom Rhodes.Xr loader.conf 5 :
5386e3186eSTom Rhodes.Bd -literal -offset indent
5486e3186eSTom Rhodesif_kue_load="YES"
5586e3186eSTom Rhodes.Ed
56dfd1e98eSBill Paul.Sh DESCRIPTION
57dfd1e98eSBill PaulThe
58dfd1e98eSBill Paul.Nm
59117c4d64SChristian Bruefferdriver provides support for USB Ethernet adapters based on the Kawasaki
60117c4d64SChristian BruefferLSI KL5KLUSB101B chipset.
61117c4d64SChristian Brueffer.Pp
62117c4d64SChristian BruefferThe KL5KLUSB101B supports a 128-entry multicast filter, single perfect
63117c4d64SChristian Bruefferfilter entry for the station address and promiscuous mode.
64117c4d64SChristian BruefferPackets are
65117c4d64SChristian Bruefferreceived and transmitted over separate USB bulk transfer endpoints.
66117c4d64SChristian Brueffer.Pp
67117c4d64SChristian BruefferThe Kawasaki chipset supports only 10Mbps half-duplex mode, hence there
68117c4d64SChristian Bruefferare no
69*2bb78c17SKevin Lo.Fn ifmedia
70117c4d64SChristian Brueffermodes to select.
71117c4d64SChristian Brueffer.Pp
72117c4d64SChristian BruefferFor more information on configuring this device, see
73117c4d64SChristian Brueffer.Xr ifconfig 8 .
74117c4d64SChristian Brueffer.Sh HARDWARE
75117c4d64SChristian BruefferThe
76117c4d64SChristian Brueffer.Nm
77117c4d64SChristian Bruefferdriver supports Kawasaki LSI KL5KLUSB101B based USB Ethernet
78117c4d64SChristian Bruefferadapters including:
79dbcefa3fSPeter Pentchev.Pp
80bf7f20c2SRuslan Ermilov.Bl -bullet -compact
81dbcefa3fSPeter Pentchev.It
82dbcefa3fSPeter Pentchev3Com 3c19250
83dbcefa3fSPeter Pentchev.It
84117c4d64SChristian Brueffer3Com 3c460 HomeConnect Ethernet USB Adapter
85dbcefa3fSPeter Pentchev.It
86dbcefa3fSPeter PentchevADS Technologies USB-10BT
87dbcefa3fSPeter Pentchev.It
88117c4d64SChristian BruefferAOX USB101
89117c4d64SChristian Brueffer.It
90dbcefa3fSPeter PentchevATen UC10T
91dbcefa3fSPeter Pentchev.It
92117c4d64SChristian BruefferAbocom URE 450
93117c4d64SChristian Brueffer.It
94dbcefa3fSPeter PentchevCorega USB-T
95dbcefa3fSPeter Pentchev.It
96dbcefa3fSPeter PentchevD-Link DSB-650C
97dbcefa3fSPeter Pentchev.It
98dbcefa3fSPeter PentchevEntrega NET-USB-E45, NET-HUB-3U1E
99dbcefa3fSPeter Pentchev.It
100dbcefa3fSPeter PentchevI/O Data USB ETT
101dbcefa3fSPeter Pentchev.It
102dbcefa3fSPeter PentchevKawasaki DU-H3E
103dbcefa3fSPeter Pentchev.It
104dbcefa3fSPeter PentchevLinkSys USB10T
105dbcefa3fSPeter Pentchev.It
106dbcefa3fSPeter PentchevNetgear EA101
107dbcefa3fSPeter Pentchev.It
108dbcefa3fSPeter PentchevPeracom USB Ethernet Adapter
109dbcefa3fSPeter Pentchev.It
110cfa3f4d8SFlorent ThoumiePsion Gold Port USB Ethernet adapter
111cfa3f4d8SFlorent Thoumie.It
112dbcefa3fSPeter PentchevSMC 2102USB, 2104USB
113dbcefa3fSPeter Pentchev.El
114dfd1e98eSBill Paul.Sh DIAGNOSTICS
115dfd1e98eSBill Paul.Bl -diag
116dfd1e98eSBill Paul.It "kue%d: watchdog timeout"
117dfd1e98eSBill PaulA packet was queued for transmission and a transmit command was
118dfd1e98eSBill Paulissued, however the device failed to acknowledge the transmission
119dfd1e98eSBill Paulbefore a timeout expired.
120dfd1e98eSBill Paul.It "kue%d: no memory for rx list"
121dfd1e98eSBill PaulThe driver failed to allocate an mbuf for the receiver ring.
122dfd1e98eSBill Paul.El
123dfd1e98eSBill Paul.Sh SEE ALSO
124dfd1e98eSBill Paul.Xr arp 4 ,
125dfd1e98eSBill Paul.Xr netintro 4 ,
12695d7878cSArchie Cobbs.Xr ng_ether 4 ,
12795d7878cSArchie Cobbs.Xr ifconfig 8
128dfd1e98eSBill Paul.Sh HISTORY
129dfd1e98eSBill PaulThe
130dfd1e98eSBill Paul.Nm
131dfd1e98eSBill Pauldevice driver first appeared in
132dfd1e98eSBill Paul.Fx 4.0 .
133dfd1e98eSBill Paul.Sh AUTHORS
134dfd1e98eSBill PaulThe
135dfd1e98eSBill Paul.Nm
136dfd1e98eSBill Pauldriver was written by
1376c899950SBaptiste Daroussin.An Bill Paul Aq Mt wpaul@ee.columbia.edu .
138dfd1e98eSBill Paul.Sh BUGS
139dfd1e98eSBill PaulThe
140dfd1e98eSBill Paul.Nm
141117c4d64SChristian Bruefferdriver does not accumulate Ethernet collisions statistics because the
142dfd1e98eSBill PaulKawasaki firmware does not appear to maintain any internal statistics.
143