xref: /freebsd/share/man/man4/alc.4 (revision a2f733abcff64628b7771a47089628b7327a88bd)
1.\" Copyright (c) 2009 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 August 22, 2016
26.Dt ALC 4
27.Os
28.Sh NAME
29.Nm alc
30.Nd Atheros AR813x/AR815x/AR816x/AR817x Gigabit/Fast 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 alc"
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_alc_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49device driver provides support for Atheros AR813x, AR815x, AR816x
50and AR817x PCI Express Gigabit/Fast Ethernet controllers.
51.Pp
52All LOMs supported by the
53.Nm
54driver have TCP/UDP/IP checksum offload for transmit, TCP
55segmentation offload (TSO), hardware VLAN tag stripping/insertion
56features, Wake On Lan (WOL) and an interrupt moderation mechanism
57as well as a 64-bit multicast hash filter.
58.Pp
59The AR813x, AR815x, AR816x and AR817x supports Jumbo Frames (up to
609216, 6144, 9216 and 9216 bytes, respectively), which can be
61configured via the interface MTU setting.
62Selecting an MTU larger than 1500 bytes with the
63.Xr ifconfig 8
64utility configures the adapter to receive and transmit Jumbo Frames.
65.Pp
66The
67.Nm
68driver supports the following media types:
69.Bl -tag -width ".Cm 10baseT/UTP"
70.It Cm autoselect
71Enable autoselection of the media type and options.
72The user can manually override
73the autoselected mode by adding media options to
74.Xr rc.conf 5 .
75.It Cm 10baseT/UTP
76Set 10Mbps operation.
77.It Cm 100baseTX
78Set 100Mbps (Fast Ethernet) operation.
79.It Cm 1000baseTX
80Set 1000baseTX operation over twisted pair.
81.El
82.Pp
83The
84.Nm
85driver supports the following media options:
86.Bl -tag -width ".Cm full-duplex"
87.It Cm full-duplex
88Force full duplex operation.
89.It Cm half-duplex
90Force half duplex operation.
91.El
92.Pp
93For more information on configuring this device, see
94.Xr ifconfig 8 .
95.Sh HARDWARE
96The
97.Nm
98device driver provides support for the following Ethernet controllers:
99.Pp
100.Bl -bullet -compact
101.It
102Atheros AR8131 PCI Express Gigabit Ethernet controller
103.It
104Atheros AR8132 PCI Express Fast Ethernet controller
105.It
106Atheros AR8151 v1.0 PCI Express Gigabit Ethernet controller
107.It
108Atheros AR8151 v2.0 PCI Express Gigabit Ethernet controller
109.It
110Atheros AR8152 v1.1 PCI Express Fast Ethernet controller
111.It
112Atheros AR8152 v2.0 PCI Express Fast Ethernet controller
113.It
114Atheros AR8161 PCI Express Gigabit Ethernet controller
115.It
116Atheros AR8162 PCI Express Fast Ethernet controller
117.It
118Atheros AR8171 PCI Express Gigabit Ethernet controller
119.It
120Atheros AR8172 PCI Express Fast Ethernet controller
121.It
122Killer E2200 Gigabit Ethernet controller
123.It
124Killer E2400 Gigabit Ethernet controller
125.It
126Killer E2500 Gigabit Ethernet controller
127.El
128.Sh LOADER TUNABLES
129Tunables can be set at the
130.Xr loader 8
131prompt before booting the kernel or stored in
132.Xr loader.conf 5 .
133.Bl -tag -width "xxxxxx"
134.It Va hw.alc.msi_disable
135This tunable disables MSI support on the Ethernet hardware.
136The default value is 0.
137.It Va hw.alc.msix_disable
138This tunable disables MSI-X support on the Ethernet hardware.
139The default value is 0.
140.El
141.Sh SYSCTL VARIABLES
142The following variables are available as both
143.Xr sysctl 8
144variables and
145.Xr loader 8
146tunables:
147.Bl -tag -width "xxxxxx"
148.It Va dev.alc.%d.int_rx_mod
149Maximum amount of time to delay receive interrupt processing in
150units of 1us.
151The accepted range is 0 to 130000, the default is 100(100us).
152Value 0 completely disables the interrupt moderation.
153.It Va dev.alc.%d.int_tx_mod
154Maximum amount of time to delay transmit interrupt processing in
155units of 1us.
156The accepted range is 0 to 130000, the default is 1000(1ms).
157Value 0 completely disables the interrupt moderation.
158.It Va dev.alc.%d.process_limit
159Maximum amount of Rx frames to be processed in the event loop before
160rescheduling a taskqueue.
161The accepted range is 32 to 255, the default value is 64 events.
162The interface does not need to be brought down and up again before
163a change takes effect.
164.El
165.Sh SEE ALSO
166.Xr altq 4 ,
167.Xr arp 4 ,
168.Xr miibus 4 ,
169.Xr netintro 4 ,
170.Xr ng_ether 4 ,
171.Xr vlan 4 ,
172.Xr ifconfig 8
173.Sh HISTORY
174The
175.Nm
176driver was written by
177.An Pyun YongHyeon Aq Mt yongari@FreeBSD.org .
178It first appeared in
179.Fx 8.0 .
180