xref: /freebsd/share/man/man4/ure.4 (revision 4c72525953fdf618a3fc0a45f3ef3f071dcc0c52)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2015-2016 Kevin Lo <kevlo@FreeBSD.org>
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd September 3, 2024
29.Dt URE 4
30.Os
31.Sh NAME
32.Nm ure
33.Nd RealTek RTL8152/RTL8153/RTL8156 USB Ethernet 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
57RTL8152, RTL8153/RTL8153B, and RTL8156/RTL8156B USB Ethernet controllers,
58as well as USB Ethernet PHYs provided by
59.Xr rgephy 4 .
60.Pp
61NICs based on the RTL8152 are capable of 10 and 100Mbps.
62NICs based on the RTL8153 or provided by
63.Xr rgephy 4
64are capable of 10, 100, and 1000Mbps.
65NICs based on the RTL8156 are capable of 10, 100, 1000, and 2500Mbps operation.
66.Pp
67The
68.Nm
69driver supports the following media types:
70.Bl -tag -width "10baseT/UTP"
71.It Cm autoselect
72Enable auto selection of the media type and options.
73The user can manually override
74the auto selected mode by adding media options to the
75.Pa /etc/rc.conf
76file.
77.It Cm 10baseT/UTP
78Set 10Mbps operation.
79The
80.Cm mediaopt
81option can also be used to select either
82.Cm full-duplex
83or
84.Cm half-duplex
85modes.
86.It Cm 100baseTX
87Set 100Mbps (Fast Ethernet) operation.
88The
89.Cm mediaopt
90option can also be used to select either
91.Cm full-duplex
92or
93.Cm half-duplex
94modes.
95.It Cm 1000baseTX
96Set 1000baseTX (Gigabit Ethernet) operation over twisted pair.
97The RealTek gigE chips support 1000Mbps in
98.Cm full-duplex
99mode only.
100.It Cm 2500base-T
101Set 2500Base-T operation over twisted pair.
102The RealTek 8156/8156B chips support 2500Mbps in
103.Cm full-duplex
104mode only.
105.El
106.Pp
107The
108.Nm
109driver supports the following media options for 10/100 operation:
110.Bl -tag -width "full-duplex"
111.It Cm full-duplex
112Force full-duplex operation.
113.It Cm half-duplex
114Force half-duplex operation.
115.El
116.Pp
117For more information on configuring this device, see
118.Xr ifconfig 8 .
119.Sh DIAGNOSTICS
120.Bl -diag
121.It "ure%d: watchdog timeout"
122A packet was queued for transmission and a transmit command was
123issued, however the device failed to acknowledge the transmission
124before a timeout expired.
125.El
126.Sh SEE ALSO
127.Xr arp 4 ,
128.Xr miibus 4 ,
129.Xr netintro 4 ,
130.Xr ng_ether 4 ,
131.Xr ifconfig 8
132.Sh AUTHORS
133The
134.Nm
135driver was written by
136.An Kevin Lo Aq Mt kevlo@FreeBSD.org .
137