xref: /freebsd/share/man/man4/age.4 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1.\" Copyright (c) 2008 Pyun YongHyeon
2.\" 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.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd September 18, 2008
26.Dt AGE 4
27.Os
28.Sh NAME
29.Nm age
30.Nd Attansic/Atheros L1 Gigabit Ethernet driver
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following lines in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device miibus"
37.Cd "device age"
38.Ed
39.Pp
40Alternatively, to load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44if_age_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49device driver provides support for Attansic/Atheros L1 PCI Express
50Gigabit Ethernet controllers.
51.Pp
52All LOMs supported by the
53.Nm
54driver have TCP/UDP/IP checksum offload for both transmit and
55receive, TCP segmentation offload (TSO), hardware VLAN tag
56stripping/insertion features and an interrupt moderation mechanism
57as well as a 64-bit multicast hash filter.
58.Pp
59The L1 also supports Jumbo Frames (up to 10240 bytes), which can be
60configured via the interface MTU setting.
61Selecting an MTU larger than 1500 bytes with the
62.Xr ifconfig 8
63utility configures the adapter to receive and transmit Jumbo Frames.
64.Pp
65The
66.Nm
67driver supports the following media types:
68.Bl -tag -width ".Cm 10baseT/UTP"
69.It Cm autoselect
70Enable autoselection of the media type and options.
71The user can manually override
72the autoselected mode by adding media options to
73.Xr rc.conf 5 .
74.It Cm 10baseT/UTP
75Set 10Mbps operation.
76.It Cm 100baseTX
77Set 100Mbps (Fast Ethernet) operation.
78.It Cm 1000baseTX
79Set 1000baseTX operation over twisted pair.
80.El
81.Pp
82The
83.Nm
84driver supports the following media options:
85.Bl -tag -width ".Cm full-duplex"
86.It Cm full-duplex
87Force full duplex operation.
88.It Cm half-duplex
89Force half duplex operation.
90.El
91.Pp
92For more information on configuring this device, see
93.Xr ifconfig 8 .
94.Sh HARDWARE
95The
96.Nm
97driver provides support for LOMs based on
98Attansic/Atheros L1 Gigabit Ethernet controller chips, including:
99.Pp
100.Bl -bullet -compact
101.It
102ASUS M2N8-VMX
103.It
104ASUS M2V
105.It
106ASUS M3A
107.It
108ASUS P2-M2A590G
109.It
110ASUS P5B-E
111.It
112ASUS P5B-MX/WIFI-AP
113.It
114ASUS P5B-VMSE
115.It
116ASUS P5K
117.It
118ASUS P5KC
119.It
120ASUS P5KPL-C
121.It
122ASUS P5KPL-VM
123.It
124ASUS P5K-SE
125.It
126ASUS P5K-V
127.It
128ASUS P5L-MX
129.It
130ASUS P5DL2-VM
131.It
132ASUS P5L-VM 1394
133.It
134ASUS G2S
135.El
136.Sh LOADER TUNABLES
137Tunables can be set at the
138.Xr loader 8
139prompt before booting the kernel or stored in
140.Xr loader.conf 5 .
141.Bl -tag -width "xxxxxx"
142.It Va hw.age.msi_disable
143This tunable disables MSI support on the Ethernet hardware.
144The default value is 0.
145.It Va hw.age.msix_disable
146This tunable disables MSI-X support on the Ethernet hardware.
147The default value is 0.
148.El
149.Sh SYSCTL VARIABLES
150The following variables are available as both
151.Xr sysctl 8
152variables and
153.Xr loader 8
154tunables:
155.Bl -tag -width "xxxxxx"
156.It Va dev.age.%d.int_mod
157Maximum amount of time to delay interrupt processing in units of
1582us.
159The accepted range is 0 to 65000, the default is 50 (100us).
160Value 0 completely disables the interrupt moderation.
161.It Va dev.age.%d.process_limit
162Maximum amount of Rx events to be processed in the event loop before
163rescheduling a taskqueue.
164The accepted range is 30 to 255, the default value is 128 events.
165The interface does not need to be brought down and up again before
166a change takes effect.
167.It Va dev.age.%d.stats
168Display lots of useful MAC counters maintained in the driver.
169.El
170.Sh SEE ALSO
171.Xr altq 4 ,
172.Xr arp 4 ,
173.Xr miibus 4 ,
174.Xr netintro 4 ,
175.Xr ng_ether 4 ,
176.Xr vlan 4 ,
177.Xr ifconfig 8
178.Sh HISTORY
179The
180.Nm
181driver was written by
182.An Pyun YongHyeon Aq Mt yongari@FreeBSD.org .
183It first appeared in
184.Fx 7.1 .
185