share/man/man4/et.4

   1 .\"
   2 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\"
   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
  12 .\"    the documentation and/or other materials provided with the
  13 .\"    distribution.
  14 .\" 3. Neither the name of The DragonFly Project nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific, prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd July 14, 2008
  34 .Dt ET 4
  35 .Os
  36 .Sh NAME
  37 .Nm et
  38 .Nd "Agere ET1310 10/100/Gigabit Ethernet driver"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following lines in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device miibus"
  45 .Cd "device et"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_et_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver supports PCI Express Ethernet adapters based on the Agere ET1310 chip.
  58 .\".Pp
  59 .\"Support for Jumbo Frames is provided via the interface MTU setting.
  60 .\"Selecting an MTU larger than 1500 bytes with the
  61 .\".Xr ifconfig 8
  62 .\"utility configures the adapter to receive and transmit Jumbo Frames.
  63 .\"The maximum MTU setting for Jumbo Frames is 15572.
  64 .\"This value coincides with the maximum Jumbo Frames size of 15594.
  65 .Pp
  66 The
  67 .Nm
  68 driver supports the following media types:
  69 .Pp
  70 .Bl -tag -width 10baseT/UTP -compact
  71 .It autoselect
  72 Enable autoselection of the media types and options.
  73 The user can manually override
  74 the autoselected mode by adding media options to the
  75 .Pa /etc/rc.conf
  76 file.
  77 .Pp
  78 .It 10baseT/UTP
  79 Set 10Mbps operation.
  80 The
  81 .Ar mediaopt
  82 option can also be used to select either
  83 .Ar full-duplex
  84 or
  85 .Ar half-duplex
  86 modes.
  87 .Pp
  88 .It 100baseTX
  89 Set 100Mbps (Fast Ethernet) operation.
  90 The
  91 .Ar mediaopt
  92 option can also be used to select either
  93 .Ar full-duplex
  94 or
  95 .Ar half-duplex
  96 modes.
  97 .Pp
  98 .It 1000baseT
  99 Set 1000Mbps (Gigabit Ethernet) operation.
 100 The
 101 .Ar mediaopt
 102 option can only be set to
 103 .Ar full-duplex
 104 mode.
 105 .El
 106 .Pp
 107 The
 108 .Nm
 109 driver supports the following
 110 .Ar media
 111 options:
 112 .Pp
 113 .Bl -tag -width full-duplex -compact
 114 .It full-duplex
 115 Force full-duplex operation.
 116 .Pp
 117 .It half-duplex
 118 Force half-duplex operation.
 119 .El
 120 .Pp
 121 Note that the 1000baseT media type is only available
 122 if it is supported by the adapter.
 123 For more information on configuring this device, see
 124 .Xr ifconfig 8 .
 125 .Sh TUNABLES
 126 .Bl -tag -width ".Va hw.et.rx_intr_npkts"
 127 .It Va hw.et.rx_intr_npkts
 128 This value controls how many packets should be received
 129 before a receive interrupt is generated.
 130 The default value is 32.
 131 It is recommended to set this value above 38 to prevent the host from being
 132 livelocked under a high degree of stress.
 133 .It Va hw.et.rx_intr_delay
 134 This value delays the generation of receive interrupts
 135 in units of ~4 microseconds.
 136 It is used together with
 137 .Va hw.et.rx_intr_npkts
 138 to achieve RX interrupt moderation.
 139 The default value is 20.
 140 .It Va hw.et.tx_intr_nsegs
 141 This value controls how many segments (not packets) should be transmitted
 142 before a transmit interrupt is generated.
 143 The default value is 126.
 144 It is recommended to set this value below 280 to prevent
 145 the TX ring from underflowing.
 146 .It Va hw.et.timer
 147 This value controls how often a timer interrupt should be generated.
 148 It is used together with
 149 .Va hw.et.tx_intr_nsegs
 150 to achieve TX interrupt moderation.
 151 The default value is 1000000000 (nanoseconds).
 152 .El
 153 .Sh SEE ALSO
 154 .Xr arp 4 ,
 155 .Xr miibus 4 ,
 156 .Xr netintro 4 ,
 157 .Xr ng_ether 4 ,
 158 .Xr vlan 4 ,
 159 .Xr ifconfig 8
 160 .Sh HISTORY
 161 The
 162 .Nm
 163 device driver first appeared in
 164 .Dx 1.11 .
 165 The first
 166 .Fx
 167 release to include it was
 168 .Fx 8.0 .
 169 .Sh AUTHORS
 170 .An -nosplit
 171 The
 172 .Nm
 173 driver was written by
 174 .An Sepherosa Ziehau Aq sepherosa@gmail.com
 175 for
 176 .Dx .
 177 It was ported to
 178 .Fx
 179 by
 180 .An Xin LI Aq delphij@FreeBSD.org .