xref: /freebsd/share/man/man4/rue.4 (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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 July 16, 2005
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 support for the
36.Nm
37driver into your kernel, place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device uhci"
41.Cd "device ohci"
42.Cd "device usb"
43.Cd "device miibus"
44.Cd "device rue"
45.Ed
46.Pp
47Alternatively, to load the
48.Nm
49driver at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_rue_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for USB Ethernet adapters based on the RealTek
58RTL8150 USB to Fast Ethernet controller chip.
59.Pp
60The RTL8150 contains an integrated Fast Ethernet MAC, which supports
61both 10 and 100Mbps speeds in either full or half duplex.
62Although designed to interface with
63100Mbps peripheral, the existing USB standard specifies a maximum
64transfer speed of 12Mbps.
65Users should therefore not expect to actually
66achieve 100Mbps speeds with this device.
67.Pp
68The
69.Nm
70driver supports the following media types:
71.Bl -tag -width ".Cm 10baseT/UTP"
72.It Cm autoselect
73Enable auto selection of the media type and options.
74The user can manually override
75the auto selected mode by adding media options to the
76.Pa /etc/rc.conf
77file.
78.It Cm 10baseT/UTP
79Set 10Mbps operation.
80The
81.Cm mediaopt
82option can also be used to select either
83.Cm full-duplex
84or
85.Cm half-duplex
86modes.
87.It Cm 100baseTX
88Set 100Mbps (Fast Ethernet) operation.
89The
90.Cm mediaopt
91option can also be used to select either
92.Cm full-duplex
93or
94.Cm half-duplex
95modes.
96.El
97.Pp
98The
99.Nm
100driver supports the following media options:
101.Bl -tag -width ".Cm 10baseT/UTP"
102.It Cm full-duplex
103Force full duplex operation.
104.It Cm half-duplex
105Force half duplex operation.
106.El
107.Pp
108For more information on configuring this device, see
109.Xr ifconfig 8 .
110.Sh HARDWARE
111The
112.Nm
113driver supports RealTek RTL8150 based USB Ethernet
114adapters including:
115.Pp
116.Bl -bullet -compact
117.It
118Buffalo (Melco Inc.) LUA-KTX
119.It
120Green House GH-USB100B
121.It
122LinkSys USB100M
123.It
124Billionton 10/100 FastEthernet USBKR2
125.El
126.Sh DIAGNOSTICS
127.Bl -diag
128.It "rue%d: watchdog timeout"
129A packet was queued for transmission and a transmit command was
130issued, however the device failed to acknowledge the transmission
131before a timeout expired.
132.It "rue%d: rx list init failed"
133The driver failed to allocate an mbuf for the transmitter ring.
134.It "rue%d: no memory for rx list"
135The driver failed to allocate an mbuf for the receiver ring.
136.El
137.Sh SEE ALSO
138.Xr arp 4 ,
139.Xr miibus 4 ,
140.Xr netintro 4 ,
141.Xr ng_ether 4 ,
142.Xr ifconfig 8
143.Rs
144.%T "ReakTek RTL8150 data sheet"
145.%O ftp://ftp.realtek.com.tw/lancard/data_sheet/8150/
146.Re
147.Sh HISTORY
148The
149.Nm
150device driver first appeared in
151.Fx 5.1 .
152.Sh AUTHORS
153The
154.Nm
155driver was written by
156.An Shunsuke Akiyama Aq akiyama@FreeBSD.org .
157