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