xref: /freebsd/share/man/man4/ure.4 (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
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.\" $FreeBSD$
27.\"
28.Dd October 31, 2016
29.Dt URE 4
30.Os
31.Sh NAME
32.Nm ure
33.Nd "RealTek RTL8152/RTL8153 USB to Ethernet controller driver"
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device uhci"
40.Cd "device ohci"
41.Cd "device usb"
42.Cd "device miibus"
43.Cd "device uether"
44.Cd "device ure"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51if_ure_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for USB Ethernet adapters based on the RealTek
57RealTek RTL8152 and RTL8153 USB Ethernet controllers.
58.Pp
59NICs based on the RTL8152 are capable of 10 and 100Mbps speeds.
60NICs based on the RTL8153 are capable of 10, 100 and 1000Mbps operation.
61.Pp
62The
63.Nm
64driver supports the following media types:
65.Bl -tag -width ".Cm 10baseT/UTP"
66.It Cm autoselect
67Enable auto selection of the media type and options.
68The user can manually override
69the auto selected mode by adding media options to the
70.Pa /etc/rc.conf
71file.
72.It Cm 10baseT/UTP
73Set 10Mbps operation.
74The
75.Cm mediaopt
76option can also be used to select either
77.Cm full-duplex
78or
79.Cm half-duplex
80modes.
81.It Cm 100baseTX
82Set 100Mbps (Fast Ethernet) operation.
83The
84.Cm mediaopt
85option can also be used to select either
86.Cm full-duplex
87or
88.Cm half-duplex
89modes.
90.It Cm 1000baseTX
91Set 1000baseTX operation over twisted pair.
92The RealTek gigE chips support 1000Mbps in
93.Cm full-duplex
94mode only.
95.El
96.Pp
97The
98.Nm
99driver supports the following media options:
100.Bl -tag -width ".Cm full-duplex"
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 "ure%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.El
116.Sh SEE ALSO
117.Xr arp 4 ,
118.Xr miibus 4 ,
119.Xr netintro 4 ,
120.Xr ng_ether 4 ,
121.Xr ifconfig 8
122.Sh AUTHORS
123The
124.Nm
125driver was written by
126.An Kevin Lo Aq Mt kevlo@FreeBSD.org .
127