xref: /dragonfly/share/man/man4/et.4 (revision b7367ef6)
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.1 2007/10/12 14:12:42 sephe Exp $
32.\"
33.Dd October 11, 2007
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
43Alternatively, to load the driver as a module at boot time, place the
44following line in
45.Pa /boot/loader.conf :
46.Bd -literal -offset indent
47if_et_load="YES"
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver supports the PCIe Ethernet adapters based on Agere ET1310.
53.Pp
54The
55.Nm
56driver supports the following
57.Ar media
58types:
59.Pp
60.Bl -tag -width 10baseT/UTP -compact
61.It Cm autoselect
62Enable autoselection of the media types and options
63.Pp
64.It Cm 10baseT/UTP
65Set 10Mbps operation.
66The
67.Ar mediaopt
68option can also be used to select either
69.Ar full-duplex
70or
71.Ar half-duplex
72modes.
73.Pp
74.It Cm 100baseTX
75Set 100Mbps (Fast Ethernet) operation.
76The
77.Ar mediaopt
78option can also be used to select either
79.Ar full-duplex
80or
81.Ar half-duplex
82modes.
83.Pp
84.It Cm 1000baseT
85Set 1000Mbps (Gigabit Ethernet) operation.
86The
87.Ar mediaopt
88option can only be set
89.Ar full-duplex
90mode.
91.El
92.Pp
93The
94.Nm
95driver supports the following
96.Ar media
97options:
98.Pp
99.Bl -tag -width full-duplex -compact
100.It Cm full-duplex
101Force full duplex operation.
102.Pp
103.It Cm half-duplex
104Force half duplex operation.
105.El
106.Pp
107Note that the 1000baseT media type is only available
108if it is supported by the adapter.
109For more information on configuring this device,
110see
111.Xr ifconfig 8 .
112.Sh TUNABLES
113.Bl -tag -width ".Va hw.et.rx_intr_npkts"
114.It Va hw.et.rx_intr_npkts
115This value controls how many packets should be recevied
116before a receive interrupt is generated.
117The default value is 32.
118.It Va hw.et.rx_intr_delay
119This value delays the generation of receive interrupts
120in units of 10 microseconds (I guess).
121It is used together with
122.Va hw.et.rx_intr_npkts
123to achieve RX interrupt moderation.
124The default value is 20.
125.It Va hw.et.tx_intr_nsegs
126This value controls how many segments (not packets) should be transmitted
127before a transmit interrupt is generated.
128The default value is 126.
129.It Va hw.et.timer
130This value controls how often the a timer interrupt should be generated.
131It is used together with
132.Va hw.et.tx_intr_nsegs
133to achieve TX interrupt moderation.
134The default value is 1000000000 (nanoseconds).
135.El
136.Sh SEE ALSO
137.Xr arp 4 ,
138.Xr ifmedia 4 ,
139.Xr miibus 4 ,
140.Xr netintro 4 ,
141.Xr ng_ether 4 ,
142.Xr vlan 4 ,
143.Xr ifconfig 8
144.Sh HISTORY
145The
146.Nm
147device driver first appeared in
148.Dx 1.11 .
149.Sh AUTHORS
150.An -nosplit
151The
152.Nm
153driver was written by
154.An Sepherosa Ziehau
155.Aq sepherosa@gmail.com .
156