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