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