xref: /freebsd/share/man/man4/rue.4 (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1.\"
2.\" Copyright (c) 2001-2003, Shunsuke Akiyama <akiyama@FreeBSD.org>.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd November 24, 2015
29.Dt RUE 4
30.Os
31.Sh NAME
32.Nm rue
33.Nd "RealTek RTL8150 USB to Fast Ethernet controller driver"
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device uhci"
40.Cd "device ohci"
41.Cd "device usb"
42.Cd "device miibus"
43.Cd "device uether"
44.Cd "device rue"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51if_rue_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for USB Ethernet adapters based on the RealTek
57RTL8150 USB to Fast Ethernet controller chip.
58.Pp
59The RTL8150 contains an integrated Fast Ethernet MAC, which supports
60both 10 and 100Mbps speeds in either full or half duplex.
61Although designed to interface with
62100Mbps peripheral, the existing USB standard specifies a maximum
63transfer speed of 12Mbps.
64Users should therefore not expect to actually
65achieve 100Mbps speeds with this device.
66.Pp
67The
68.Nm
69driver supports the following media types:
70.Bl -tag -width ".Cm 10baseT/UTP"
71.It Cm autoselect
72Enable auto selection of the media type and options.
73The user can manually override
74the auto selected mode by adding media options to the
75.Pa /etc/rc.conf
76file.
77.It Cm 10baseT/UTP
78Set 10Mbps operation.
79The
80.Cm mediaopt
81option can also be used to select either
82.Cm full-duplex
83or
84.Cm half-duplex
85modes.
86.It Cm 100baseTX
87Set 100Mbps (Fast Ethernet) operation.
88The
89.Cm mediaopt
90option can also be used to select either
91.Cm full-duplex
92or
93.Cm half-duplex
94modes.
95.El
96.Pp
97The
98.Nm
99driver supports the following media options:
100.Bl -tag -width ".Cm 10baseT/UTP"
101.It Cm full-duplex
102Force full duplex operation.
103.It Cm half-duplex
104Force half duplex operation.
105.El
106.Pp
107For more information on configuring this device, see
108.Xr ifconfig 8 .
109.Sh HARDWARE
110The
111.Nm
112driver supports RealTek RTL8150 based USB Ethernet
113adapters including:
114.Pp
115.Bl -bullet -compact
116.It
117Buffalo (Melco Inc.) LUA-KTX
118.It
119Green House GH-USB100B
120.It
121LinkSys USB100M
122.It
123Billionton 10/100 FastEthernet USBKR2
124.El
125.Sh DIAGNOSTICS
126.Bl -diag
127.It "rue%d: watchdog timeout"
128A packet was queued for transmission and a transmit command was
129issued, however the device failed to acknowledge the transmission
130before a timeout expired.
131.It "rue%d: rx list init failed"
132The driver failed to allocate an mbuf for the transmitter ring.
133.It "rue%d: no memory for rx list"
134The driver failed to allocate an mbuf for the receiver ring.
135.El
136.Sh SEE ALSO
137.Xr arp 4 ,
138.Xr miibus 4 ,
139.Xr netintro 4 ,
140.Xr ng_ether 4 ,
141.Xr ifconfig 8
142.Rs
143.%T "RealTek RTL8150 data sheet"
144.%U http://pdf.seekdatasheet.com/2008714/200807142333305235.pdf
145.Re
146.Sh HISTORY
147The
148.Nm
149device driver first appeared in
150.Fx 5.1 .
151.Sh AUTHORS
152The
153.Nm
154driver was written by
155.An Shunsuke Akiyama Aq Mt akiyama@FreeBSD.org .
156