xref: /freebsd/share/man/man4/ure.4 (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1.\"
2.\" Copyright (c) 2015-2016 Kevin Lo <kevlo@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 October 31, 2016
27.Dt URE 4
28.Os
29.Sh NAME
30.Nm ure
31.Nd "RealTek RTL8152/RTL8153 USB to 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 ure"
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_ure_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver provides support for USB Ethernet adapters based on the RealTek
55RealTek RTL8152 and RTL8153 USB Ethernet controllers.
56.Pp
57NICs based on the RTL8152 are capable of 10 and 100Mbps speeds.
58NICs based on the RTL8153 are capable of 10, 100 and 1000Mbps operation.
59.Pp
60The
61.Nm
62driver supports the following media types:
63.Bl -tag -width ".Cm 10baseT/UTP"
64.It Cm autoselect
65Enable auto selection of the media type and options.
66The user can manually override
67the auto selected mode by adding media options to the
68.Pa /etc/rc.conf
69file.
70.It Cm 10baseT/UTP
71Set 10Mbps operation.
72The
73.Cm mediaopt
74option can also be used to select either
75.Cm full-duplex
76or
77.Cm half-duplex
78modes.
79.It Cm 100baseTX
80Set 100Mbps (Fast Ethernet) operation.
81The
82.Cm mediaopt
83option can also be used to select either
84.Cm full-duplex
85or
86.Cm half-duplex
87modes.
88.It Cm 1000baseTX
89Set 1000baseTX operation over twisted pair.
90The RealTek gigE chips support 1000Mbps in
91.Cm full-duplex
92mode only.
93.El
94.Pp
95The
96.Nm
97driver supports the following media options:
98.Bl -tag -width ".Cm full-duplex"
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 DIAGNOSTICS
108.Bl -diag
109.It "ure%d: watchdog timeout"
110A packet was queued for transmission and a transmit command was
111issued, however the device failed to acknowledge the transmission
112before a timeout expired.
113.El
114.Sh SEE ALSO
115.Xr arp 4 ,
116.Xr miibus 4 ,
117.Xr netintro 4 ,
118.Xr ng_ether 4 ,
119.Xr ifconfig 8
120.Sh AUTHORS
121The
122.Nm
123driver was written by
124.An Kevin Lo Aq Mt kevlo@FreeBSD.org .
125