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 .\" $DragonFly: src/share/man/man4/et.4,v 1.5 2008/07/09 18:15:09 thomas Exp $
  32 .\"
  33 .Dd July 9, 2008
  34 .Dt ET 4
  35 .Os
  36 .Sh NAME
  37 .Nm et
  38 .Nd "Agere ET1310 10/100/Gigabit Ethernet device"
  39 .Sh SYNOPSIS
  40 .Cd "device miibus"
  41 .Cd "device et"
  42 .Pp
  43 Alternatively, to load the driver as a module at boot time, place the
  44 following line in
  45 .Pa /boot/loader.conf :
  46 .Bd -literal -offset indent
  47 if_et_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver supports the PCIe Ethernet adapters based on Agere ET1310.
  53 .Pp
  54 Support for Jumbo Frames is provided via the interface MTU setting.
  55 Selecting an MTU larger than 1500 bytes with the
  56 .Xr ifconfig 8
  57 utility configures the adapter to receive and transmit Jumbo Frames.
  58 The maximum MTU setting for Jumbo Frames is 15572.
  59 This value coincides with the maximum Jumbo Frames size of 15594.
  60 .Pp
  61 The
  62 .Nm
  63 driver supports the following
  64 .Ar media
  65 types:
  66 .Pp
  67 .Bl -tag -width 10baseT/UTP -compact
  68 .It Cm autoselect
  69 Enable autoselection of the media types and options
  70 .Pp
  71 .It Cm 10baseT/UTP
  72 Set 10Mbps operation.
  73 The
  74 .Ar mediaopt
  75 option can also be used to select either
  76 .Ar full-duplex
  77 or
  78 .Ar half-duplex
  79 modes.
  80 .Pp
  81 .It Cm 100baseTX
  82 Set 100Mbps (Fast Ethernet) operation.
  83 The
  84 .Ar mediaopt
  85 option can also be used to select either
  86 .Ar full-duplex
  87 or
  88 .Ar half-duplex
  89 modes.
  90 .Pp
  91 .It Cm 1000baseT
  92 Set 1000Mbps (Gigabit Ethernet) operation.
  93 The
  94 .Ar mediaopt
  95 option can only be set
  96 .Ar full-duplex
  97 mode.
  98 .El
  99 .Pp
 100 The
 101 .Nm
 102 driver supports the following
 103 .Ar media
 104 options:
 105 .Pp
 106 .Bl -tag -width full-duplex -compact
 107 .It Cm full-duplex
 108 Force full duplex operation.
 109 .Pp
 110 .It Cm half-duplex
 111 Force half duplex operation.
 112 .El
 113 .Pp
 114 Note that the 1000baseT media type is only available
 115 if it is supported by the adapter.
 116 For more information on configuring this device,
 117 see
 118 .Xr ifconfig 8 .
 119 .Sh TUNABLES
 120 .Bl -tag -width ".Va hw.et.rx_intr_npkts"
 121 .It Va hw.et.rx_intr_npkts
 122 This value controls how many packets should be received
 123 before a receive interrupt is generated.
 124 The default value is 129.
 125 It is recommended to set this value above 38 to prevent host from being
 126 livelocked under a high degree of stress.
 127 .It Va hw.et.rx_intr_delay
 128 This value delays the generation of receive interrupts
 129 in units of ~4 microseconds.
 130 It is used together with
 131 .Va hw.et.rx_intr_npkts
 132 to achieve RX interrupt moderation.
 133 The default value is 25.
 134 .It Va hw.et.tx_intr_nsegs
 135 This value controls how many segments (not packets) should be transmitted
 136 before a transmit interrupt is generated.
 137 The default value is 256.
 138 It is recommended to set this value below 280 to prevent TX ring from underflow.
 139 .It Va hw.et.timer
 140 This value controls how often the a timer interrupt should be generated.
 141 It is used together with
 142 .Va hw.et.tx_intr_nsegs
 143 to achieve TX interrupt moderation.
 144 The default value is 1000000000 (nanoseconds).
 145 .El
 146 .Sh SEE ALSO
 147 .Xr arp 4 ,
 148 .Xr ifmedia 4 ,
 149 .Xr miibus 4 ,
 150 .Xr netintro 4 ,
 151 .Xr ng_ether 4 ,
 152 .Xr vlan 4 ,
 153 .Xr ifconfig 8
 154 .Sh HISTORY
 155 The
 156 .Nm
 157 device driver first appeared in
 158 .Dx 1.11 .
 159 .Sh AUTHORS
 160 .An -nosplit
 161 The
 162 .Nm
 163 driver was written by
 164 .An Sepherosa Ziehau
 165 .Aq sepherosa@gmail.com .