xref: /freebsd/share/man/man4/rue.4 (revision cf02bf2407cb217c99cc82f78b7a2e7f0703c9ee)
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 May 3, 2003
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, including the following:
45.Pp
46.Bl -bullet -compact
47.It
48Buffalo (Melco Inc.) LUA-KTX
49.It
50Green House GH-USB100B
51.It
52LinkSys USB100M
53.It
54Billionton 10/100 FastEthernet USBKR2
55.It
56Wiretek UBRJ4
57.El
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 DIAGNOSTICS
110.Bl -diag
111.It "rue%d: watchdog timeout"
112A packet was queued for transmission and a transmit command was
113issued, however the device failed to acknowledge the transmission
114before a timeout expired.
115.It "rue%d: rx list init failed"
116The driver failed to allocate an mbuf for the transmitter ring.
117.It "rue%d: no memory for rx list"
118The driver failed to allocate an mbuf for the receiver ring.
119.El
120.Sh SEE ALSO
121.Xr arp 4 ,
122.Xr miibus 4 ,
123.Xr netintro 4 ,
124.Xr ng_ether 4 ,
125.Xr ifconfig 8
126.Rs
127.%T "ReakTek RTL8150 data sheet"
128.%O ftp://ftp.realtek.com.tw/lancard/data_sheet/8150/
129.Re
130.Sh HISTORY
131The
132.Nm
133device driver first appeared in
134.Fx 5.1 .
135.Sh AUTHORS
136The
137.Nm
138driver was written by
139.An Shunsuke Akiyama Aq akiyama@FreeBSD.org .
140