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