xref: /freebsd/share/man/man4/rue.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
111e04b05SShunsuke Akiyama.\"
211e04b05SShunsuke Akiyama.\" Copyright (c) 2001-2003, Shunsuke Akiyama <akiyama@FreeBSD.org>.
311e04b05SShunsuke Akiyama.\" All rights reserved.
411e04b05SShunsuke Akiyama.\"
511e04b05SShunsuke Akiyama.\" Redistribution and use in source and binary forms, with or without
611e04b05SShunsuke Akiyama.\" modification, are permitted provided that the following conditions
711e04b05SShunsuke Akiyama.\" are met:
811e04b05SShunsuke Akiyama.\" 1. Redistributions of source code must retain the above copyright
911e04b05SShunsuke Akiyama.\"    notice, this list of conditions and the following disclaimer.
1011e04b05SShunsuke Akiyama.\" 2. Redistributions in binary form must reproduce the above copyright
1111e04b05SShunsuke Akiyama.\"    notice, this list of conditions and the following disclaimer in the
1211e04b05SShunsuke Akiyama.\"    documentation and/or other materials provided with the distribution.
1311e04b05SShunsuke Akiyama.\"
1411e04b05SShunsuke Akiyama.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1511e04b05SShunsuke Akiyama.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1611e04b05SShunsuke Akiyama.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1711e04b05SShunsuke Akiyama.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1811e04b05SShunsuke Akiyama.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1911e04b05SShunsuke Akiyama.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2011e04b05SShunsuke Akiyama.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2111e04b05SShunsuke Akiyama.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2211e04b05SShunsuke Akiyama.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2311e04b05SShunsuke Akiyama.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2411e04b05SShunsuke Akiyama.\" SUCH DAMAGE.
2511e04b05SShunsuke Akiyama.\"
26*ff6b30b9SKevin Lo.Dd November 24, 2015
2711e04b05SShunsuke Akiyama.Dt RUE 4
28bc9a9cb4SRuslan Ermilov.Os
2911e04b05SShunsuke Akiyama.Sh NAME
3011e04b05SShunsuke Akiyama.Nm rue
3125122f37SChristian Brueffer.Nd "RealTek RTL8150 USB to Fast Ethernet controller driver"
3211e04b05SShunsuke Akiyama.Sh SYNOPSIS
3316d78bb8STom RhodesTo compile this driver into the kernel,
3416d78bb8STom Rhodesplace the following lines in your
3590296834STom Rhodeskernel configuration file:
3686e3186eSTom Rhodes.Bd -ragged -offset indent
3711e04b05SShunsuke Akiyama.Cd "device uhci"
3811e04b05SShunsuke Akiyama.Cd "device ohci"
3911e04b05SShunsuke Akiyama.Cd "device usb"
4011e04b05SShunsuke Akiyama.Cd "device miibus"
41*ff6b30b9SKevin Lo.Cd "device uether"
4211e04b05SShunsuke Akiyama.Cd "device rue"
4386e3186eSTom Rhodes.Ed
4486e3186eSTom Rhodes.Pp
4516d78bb8STom RhodesAlternatively, to load the driver as a
4616d78bb8STom Rhodesmodule at boot time, place the following line in
4786e3186eSTom Rhodes.Xr loader.conf 5 :
4886e3186eSTom Rhodes.Bd -literal -offset indent
4986e3186eSTom Rhodesif_rue_load="YES"
5086e3186eSTom Rhodes.Ed
5111e04b05SShunsuke Akiyama.Sh DESCRIPTION
5211e04b05SShunsuke AkiyamaThe
5311e04b05SShunsuke Akiyama.Nm
5411e04b05SShunsuke Akiyamadriver provides support for USB Ethernet adapters based on the RealTek
5525122f37SChristian BruefferRTL8150 USB to Fast Ethernet controller chip.
5611e04b05SShunsuke Akiyama.Pp
57bc9a9cb4SRuslan ErmilovThe RTL8150 contains an integrated Fast Ethernet MAC, which supports
5811e04b05SShunsuke Akiyamaboth 10 and 100Mbps speeds in either full or half duplex.
5911e04b05SShunsuke AkiyamaAlthough designed to interface with
6011e04b05SShunsuke Akiyama100Mbps peripheral, the existing USB standard specifies a maximum
6111e04b05SShunsuke Akiyamatransfer speed of 12Mbps.
6211e04b05SShunsuke AkiyamaUsers should therefore not expect to actually
6311e04b05SShunsuke Akiyamaachieve 100Mbps speeds with this device.
6411e04b05SShunsuke Akiyama.Pp
6511e04b05SShunsuke AkiyamaThe
6611e04b05SShunsuke Akiyama.Nm
6711e04b05SShunsuke Akiyamadriver supports the following media types:
68bc9a9cb4SRuslan Ermilov.Bl -tag -width ".Cm 10baseT/UTP"
69bc9a9cb4SRuslan Ermilov.It Cm autoselect
7011e04b05SShunsuke AkiyamaEnable auto selection of the media type and options.
7111e04b05SShunsuke AkiyamaThe user can manually override
7211e04b05SShunsuke Akiyamathe auto selected mode by adding media options to the
7311e04b05SShunsuke Akiyama.Pa /etc/rc.conf
7411e04b05SShunsuke Akiyamafile.
75bc9a9cb4SRuslan Ermilov.It Cm 10baseT/UTP
7611e04b05SShunsuke AkiyamaSet 10Mbps operation.
7711e04b05SShunsuke AkiyamaThe
78bc9a9cb4SRuslan Ermilov.Cm mediaopt
7911e04b05SShunsuke Akiyamaoption can also be used to select either
80bc9a9cb4SRuslan Ermilov.Cm full-duplex
8111e04b05SShunsuke Akiyamaor
82bc9a9cb4SRuslan Ermilov.Cm half-duplex
8311e04b05SShunsuke Akiyamamodes.
84bc9a9cb4SRuslan Ermilov.It Cm 100baseTX
8511e04b05SShunsuke AkiyamaSet 100Mbps (Fast Ethernet) operation.
8611e04b05SShunsuke AkiyamaThe
87bc9a9cb4SRuslan Ermilov.Cm mediaopt
8811e04b05SShunsuke Akiyamaoption can also be used to select either
89bc9a9cb4SRuslan Ermilov.Cm full-duplex
9011e04b05SShunsuke Akiyamaor
91bc9a9cb4SRuslan Ermilov.Cm half-duplex
9211e04b05SShunsuke Akiyamamodes.
9311e04b05SShunsuke Akiyama.El
9411e04b05SShunsuke Akiyama.Pp
9511e04b05SShunsuke AkiyamaThe
9611e04b05SShunsuke Akiyama.Nm
9711e04b05SShunsuke Akiyamadriver supports the following media options:
98bc9a9cb4SRuslan Ermilov.Bl -tag -width ".Cm 10baseT/UTP"
99bc9a9cb4SRuslan Ermilov.It Cm full-duplex
10011e04b05SShunsuke AkiyamaForce full duplex operation.
101bc9a9cb4SRuslan Ermilov.It Cm half-duplex
10211e04b05SShunsuke AkiyamaForce half duplex operation.
10311e04b05SShunsuke Akiyama.El
10411e04b05SShunsuke Akiyama.Pp
10511e04b05SShunsuke AkiyamaFor more information on configuring this device, see
10611e04b05SShunsuke Akiyama.Xr ifconfig 8 .
10725122f37SChristian Brueffer.Sh HARDWARE
10825122f37SChristian BruefferThe
10925122f37SChristian Brueffer.Nm
11025122f37SChristian Bruefferdriver supports RealTek RTL8150 based USB Ethernet
11125122f37SChristian Bruefferadapters including:
11225122f37SChristian Brueffer.Pp
11325122f37SChristian Brueffer.Bl -bullet -compact
11425122f37SChristian Brueffer.It
11525122f37SChristian BruefferBuffalo (Melco Inc.) LUA-KTX
11625122f37SChristian Brueffer.It
11725122f37SChristian BruefferGreen House GH-USB100B
11825122f37SChristian Brueffer.It
11925122f37SChristian BruefferLinkSys USB100M
12025122f37SChristian Brueffer.It
12125122f37SChristian BruefferBillionton 10/100 FastEthernet USBKR2
12225122f37SChristian Brueffer.El
12311e04b05SShunsuke Akiyama.Sh DIAGNOSTICS
12411e04b05SShunsuke Akiyama.Bl -diag
12511e04b05SShunsuke Akiyama.It "rue%d: watchdog timeout"
12611e04b05SShunsuke AkiyamaA packet was queued for transmission and a transmit command was
12711e04b05SShunsuke Akiyamaissued, however the device failed to acknowledge the transmission
12811e04b05SShunsuke Akiyamabefore a timeout expired.
12911e04b05SShunsuke Akiyama.It "rue%d: rx list init failed"
13011e04b05SShunsuke AkiyamaThe driver failed to allocate an mbuf for the transmitter ring.
13111e04b05SShunsuke Akiyama.It "rue%d: no memory for rx list"
13211e04b05SShunsuke AkiyamaThe driver failed to allocate an mbuf for the receiver ring.
133bc9a9cb4SRuslan Ermilov.El
13411e04b05SShunsuke Akiyama.Sh SEE ALSO
13511e04b05SShunsuke Akiyama.Xr arp 4 ,
136130b84f5SChristian Brueffer.Xr miibus 4 ,
13711e04b05SShunsuke Akiyama.Xr netintro 4 ,
13811e04b05SShunsuke Akiyama.Xr ng_ether 4 ,
13911e04b05SShunsuke Akiyama.Xr ifconfig 8
14011e04b05SShunsuke Akiyama.Rs
1415d514028SGlen Barber.%T "RealTek RTL8150 data sheet"
1425d514028SGlen Barber.%U http://pdf.seekdatasheet.com/2008714/200807142333305235.pdf
14311e04b05SShunsuke Akiyama.Re
14411e04b05SShunsuke Akiyama.Sh HISTORY
14511e04b05SShunsuke AkiyamaThe
14611e04b05SShunsuke Akiyama.Nm
14711e04b05SShunsuke Akiyamadevice driver first appeared in
14811e04b05SShunsuke Akiyama.Fx 5.1 .
14911e04b05SShunsuke Akiyama.Sh AUTHORS
15011e04b05SShunsuke AkiyamaThe
15111e04b05SShunsuke Akiyama.Nm
15211e04b05SShunsuke Akiyamadriver was written by
1536c899950SBaptiste Daroussin.An Shunsuke Akiyama Aq Mt akiyama@FreeBSD.org .
154