add tools/chkmoddeps
[dragonfly.git] / share / man / man4 / age.4
blobf69b7976c89a2a2330f4b4349fbe56f748480849
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 .\" $FreeBSD: src/share/man/man4/age.4,v 1.3 2008/09/18 05:08:17 yongari Exp $
26 .\"
27 .Dd January 2, 2009
28 .Dt AGE 4
29 .Os
30 .Sh NAME
31 .Nm age
32 .Nd Attansic/Atheros L1 Gigabit Ethernet driver
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device miibus"
39 .Cd "device age"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 if_age_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 device driver provides support for Attansic/Atheros L1 PCI Express
52 Gigabit Ethernet controllers.
53 .Pp
54 All LOMs supported by the
55 .Nm
56 driver have TCP/UDP/IP checksum offload for both transmit and receive,
57 hardware VLAN tag stripping/insertion features and
58 an interrupt moderation mechanism as well as
59 a 64-bit multicast hash filter.
60 .Pp
61 The L1 also supports Jumbo Frames (up to 10240 bytes),
62 which can be configured via the interface MTU setting.
63 Selecting an MTU larger than 1500 bytes with the
64 .Xr ifconfig 8
65 utility configures the adapter to receive and transmit Jumbo Frames.
66 .Pp
67 The
68 .Nm
69 driver supports the following media types:
70 .Bl -tag -width ".Cm 10baseT/UTP"
71 .It Cm autoselect
72 Enable autoselection of the media type and options.
73 The user can manually override
74 the autoselected mode by adding media options to
75 .Xr rc.conf 5 .
76 .It Cm 10baseT/UTP
77 Set 10Mbps operation.
78 .It Cm 100baseTX
79 Set 100Mbps (Fast Ethernet) operation.
80 .It Cm 1000baseT
81 Set 1000baseT operation over twisted pair.
82 .El
83 .Pp
84 The
85 .Nm
86 driver supports the following media options:
87 .Bl -tag -width ".Cm full-duplex"
88 .It Cm full-duplex
89 Force full duplex operation.
90 .It Cm half-duplex
91 Force half duplex operation.
92 .El
93 .Pp
94 For more information on configuring this device, see
95 .Xr ifconfig 8 .
96 .Sh HARDWARE
97 The
98 .Nm
99 driver provides support for LOMs based on
100 Attansic/Atheros L1 Gigabit Ethernet controller chips, including:
102 .Bl -bullet -compact
104 ASUS M2N8-VMX
106 ASUS M2V
108 ASUS M3A
110 ASUS P2-M2A590G
112 ASUS P5B-E
114 ASUS P5B-MX/WIFI-AP
116 ASUS P5B-VMSE
118 ASUS P5K
120 ASUS P5KC
122 ASUS P5KPL-C
124 ASUS P5KPL-VM
126 ASUS P5K-SE
128 ASUS P5K-V
130 ASUS P5L-MX
132 ASUS P5DL2-VM
134 ASUS P5L-VM 1394
136 ASUS G2S
138 .Sh SYSCTL VARIABLES
139 The following variables are available as
140 .Xr sysctl 8
141 variables:
142 .Bl -tag -width "xxxxxx"
143 .It Va dev.age%d.int_mod
144 Maximum amount of time to delay interrupt processing in units of 2us.
145 The accepted range is 0 to 65000, the default is 50 (100us).
146 Value 0 completely disables the interrupt moderation.
147 .It Va dev.age%d.stats
148 Display lots of useful MAC counters maintained in the driver.
150 .Sh SEE ALSO
151 .Xr altq 4 ,
152 .Xr arp 4 ,
153 .Xr ifmedia 4 ,
154 .Xr miibus 4 ,
155 .Xr netintro 4 ,
156 .Xr ng_ether 4 ,
157 .Xr vlan 4 ,
158 .Xr ifconfig 8
159 .Sh HISTORY
162 driver was written by
163 .An Pyun YongHyeon
164 .Aq yongari@FreeBSD.org .
165 It first appeared in
166 .Fx 7.1 .