xref: /freebsd/share/man/man4/ure.4 (revision d0ff5773cefaf3fa41b1be3e44ca35bd9d5f68ee)
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 April 8, 2025
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 supports the Realtek USB Ethernet Controller family.
57.Pp
58The
59.Nm
60driver supports the following media types:
61.Bl -tag -width "10baseT/UTP"
62.It Cm autoselect
63Enable auto selection of the media type and options.
64The user can manually override
65the auto selected mode by adding media options to the
66.Pa /etc/rc.conf
67file.
68.It Cm 10baseT/UTP
69Set 10Mbps operation.
70The
71.Cm mediaopt
72option can also be used to select either
73.Cm full-duplex
74or
75.Cm half-duplex
76modes.
77.It Cm 100baseTX
78Set 100Mbps (Fast Ethernet) 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 1000baseTX
87Set 1000baseTX (Gigabit Ethernet) operation over twisted pair.
88The Realtek gigE chips support 1000Mbps in
89.Cm full-duplex
90mode only.
91.It Cm 2500base-T
92Set 2500Base-T operation over twisted pair.
93The Realtek 8156/8156B chips support 2500Mbps in
94.Cm full-duplex
95mode only.
96.El
97.Pp
98The
99.Nm
100driver supports the following media options for 10/100 operation:
101.Bl -tag -width "full-duplex"
102.It Cm full-duplex
103Force full-duplex operation.
104.It Cm half-duplex
105Force half-duplex operation.
106.El
107.Pp
108For more information on configuring this device, see
109.Xr ifconfig 8 .
110.Sh HARDWARE
111The
112.Nm
113driver supports the following USB Ethernet controllers:
114.Bl -column "Realtek RTL8168/8169/8110/8211 via rgephy(4)" "10, 100, 1000, and 2500"
115.It Model: Ta Speed (Mbps):
116.It Realtek RTL8156/RTL8156B/RTL8156BG Ta 10, 100, 1000, and 2500
117.It Realtek RTL8153/RTL8153B Ta 10, 100, and 1000
118.It Realtek RTL8152 Ta 10 and 100
119.It Realtek RTL8168/8169/8110/8211 via rgephy(4) Ta 10, 100, and 1000
120.El
121.Sh DIAGNOSTICS
122.Bl -diag
123.It "ure%d: watchdog timeout"
124A packet was queued for transmission and a transmit command was
125issued, however the device failed to acknowledge the transmission
126before a timeout expired.
127.El
128.Sh SEE ALSO
129.Xr arp 4 ,
130.Xr miibus 4 ,
131.Xr netintro 4 ,
132.Xr ng_ether 4 ,
133.Xr ifconfig 8
134.Sh AUTHORS
135The
136.Nm
137driver was written by
138.An Kevin Lo Aq Mt kevlo@FreeBSD.org .
139