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