xref: /freebsd/share/man/man4/rgephy.4 (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
1.\"
2.\" Copyright (c) 2011 Marius Strobl <marius@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 January 16, 2011
27.Dt RGEPHY 4
28.Os
29.Sh NAME
30.Nm rgephy
31.Nd RealTek RTL8168/8169/8110/8211 series 10/100/1000 Gigabit Ethernet PHY driver
32.Sh SYNOPSIS
33To compile all available PHY drivers into the kernel,
34place the following line in your kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device miibus"
37.Ed
38.Pp
39Alternatively, to selectively compile this driver into the kernel,
40place the following lines in your kernel configuration file instead:
41.Bd -ragged -offset indent
42.Cd "device mii"
43.Cd "device rgephy"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48driver supports the RealTek RTL8168, RTL8169, RTL8110 and RTL8211 series
49integrated 10/100/1000 Gigabit Ethernet PHYs.
50.Pp
51In order to get a list of media types and options supported by a specific
52instance of the
53.Nm
54driver, run
55.Li ifconfig -m
56on the instance of its parent MAC driver.
57.Pp
58Additionally,
59the
60.Nm
61driver supports the following special media option:
62.Bl -tag -width ".Cm flag0"
63.It Cm flag0
64When manually setting media type and options via
65.Xr ifconfig 8 ,
66the
67.Nm
68driver by default also triggers an autonegotiation advertising the selected
69media.
70This is done in order to work around hardware issues in certain scenarios.
71It is believed that this behavior does not cause harm in general but in fact
72can have an adverse effect in edge cases.
73In order to manually set the media type and options without also triggering
74an autonegotiation,
75the
76.Nm
77driver allows to turn this behavior off via the
78.Cm flag0
79media option.
80.El
81.Pp
82Note that this special media option will not show up in the output of
83.Xr ifconfig 8 ,
84even when set.
85.Sh EXAMPLES
86Manually set 100BASE-TX full-duplex without also triggering an
87autonegotiation:
88.Pp
89.Dl "ifconfig re0 media 100baseTX mediaopt full-duplex,flag0"
90.Sh SEE ALSO
91.Xr intro 4 ,
92.Xr miibus 4 ,
93.Xr ifconfig 8
94