share/man/man4/rgephy.4

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