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