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 December 9, 2011 34.Dt ET 4 35.Os 36.Sh NAME 37.Nm et 38.Nd "Agere ET1310 10/100/Gigabit Ethernet driver" 39.Sh SYNOPSIS 40To compile this driver into the kernel, 41place the following lines in your 42kernel configuration file: 43.Bd -ragged -offset indent 44.Cd "device miibus" 45.Cd "device et" 46.Ed 47.Pp 48Alternatively, to load the driver as a 49module at boot time, place the following line in 50.Xr loader.conf 5 : 51.Bd -literal -offset indent 52if_et_load="YES" 53.Ed 54.Sh DESCRIPTION 55The 56.Nm 57driver 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 66The 67.Nm 68driver supports the following media types: 69.Pp 70.Bl -tag -width 10baseT/UTP -compact 71.It autoselect 72Enable autoselection of the media types and options. 73The user can manually override 74the autoselected mode by adding media options to the 75.Pa /etc/rc.conf 76file. 77.Pp 78.It 10baseT/UTP 79Set 10Mbps operation. 80The 81.Ar mediaopt 82option can also be used to select either 83.Ar full-duplex 84or 85.Ar half-duplex 86modes. 87.Pp 88.It 100baseTX 89Set 100Mbps (Fast Ethernet) operation. 90The 91.Ar mediaopt 92option can also be used to select either 93.Ar full-duplex 94or 95.Ar half-duplex 96modes. 97.Pp 98.It 1000baseT 99Set 1000Mbps (Gigabit Ethernet) operation. 100The 101.Ar mediaopt 102option can only be set to 103.Ar full-duplex 104mode. 105.El 106.Pp 107The 108.Nm 109driver supports the following 110.Ar media 111options: 112.Pp 113.Bl -tag -width full-duplex -compact 114.It full-duplex 115Force full-duplex operation. 116.Pp 117.It half-duplex 118Force half-duplex operation. 119.El 120.Pp 121Note that the 1000baseT media type is only available 122if it is supported by the adapter. 123For more information on configuring this device, see 124.Xr ifconfig 8 . 125.Sh HARDWARE 126The 127.Nm 128driver supports Agere ET1310 10/100/Gigabit 129Ethernet adapters. 130.Sh TUNABLES 131.Bl -tag -width ".Va hw.et.rx_intr_npkts" 132.It Va hw.et.rx_intr_npkts 133This value controls how many packets should be received 134before a receive interrupt is generated. 135The default value is 32. 136It is recommended to set this value above 38 to prevent the host from being 137livelocked under a high degree of stress. 138.It Va hw.et.rx_intr_delay 139This value delays the generation of receive interrupts 140in units of ~4 microseconds. 141It is used together with 142.Va hw.et.rx_intr_npkts 143to achieve RX interrupt moderation. 144The default value is 20. 145.It Va hw.et.tx_intr_nsegs 146This value controls how many segments (not packets) should be transmitted 147before a transmit interrupt is generated. 148The default value is 126. 149It is recommended to set this value below 280 to prevent 150the TX ring from underflowing. 151.It Va hw.et.timer 152This value controls how often a timer interrupt should be generated. 153It is used together with 154.Va hw.et.tx_intr_nsegs 155to achieve TX interrupt moderation. 156The default value is 1000000000 (nanoseconds). 157.El 158.Sh SEE ALSO 159.Xr altq 4 , 160.Xr arp 4 , 161.Xr miibus 4 , 162.Xr netintro 4 , 163.Xr ng_ether 4 , 164.Xr vlan 4 , 165.Xr ifconfig 8 166.Sh HISTORY 167The 168.Nm 169device driver first appeared in 170.Dx 1.11 . 171The first 172.Fx 173release to include it was 174.Fx 8.0 . 175.Sh AUTHORS 176.An -nosplit 177The 178.Nm 179driver was written by 180.An Sepherosa Ziehau Aq Mt sepherosa@gmail.com 181for 182.Dx . 183It was ported to 184.Fx 185by 186.An Xin LI Aq Mt delphij@FreeBSD.org . 187