1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<table class="head">
<tr>
<td class="head-ltitle">MXGE(4)</td>
<td class="head-vol">Device Drivers Manual</td>
<td class="head-rtitle">MXGE(4)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">mxge</code> — <span class="Nd">Myricom
Myri10GE 10 Gigabit Ethernet adapter driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device firmware</code>
<br/>
<code class="Cd">device mxge</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
the following lines in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_mxge_load="YES"
mxge_ethp_z8e_load="YES"
mxge_eth_z8e_load="YES"
mxge_rss_ethp_z8e_load="YES"
mxge_rss_eth_z8e_load="YES"</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">mxge</code> driver provides support for PCI
Express 10 Gigabit Ethernet adapters based on the Myricom LANai Z8E chip.
The driver supports Transmit/Receive checksum offload, Jumbo Frames, TCP
segmentation offload (TSO) as well as Large Receive Offload (LRO). For
further hardware information, see
<span class="Pa">http://www.myri.com/</span>.</p>
<p class="Pp">For questions related to hardware requirements, refer to the
documentation supplied with your Myri10GE adapter. All hardware requirements
listed apply to use with <span class="Ux">FreeBSD</span>.</p>
<p class="Pp">Support for Jumbo Frames is provided via the interface MTU
setting. Selecting an MTU larger than 1500 bytes with the
<a class="Xr">ifconfig(8)</a> utility configures the adapter to receive and
transmit Jumbo Frames. The maximum MTU size for Jumbo Frames is 9000.</p>
<p class="Pp">For more information on configuring this device, see
<a class="Xr">ifconfig(8)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">mxge</code> driver supports 10 Gigabit
Ethernet adapters based on the Myricom LANai Z8E chips:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
<li>Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C)</li>
<li>Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R)</li>
<li>Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="LOADER_TUNABLES"><a class="permalink" href="#LOADER_TUNABLES">LOADER
TUNABLES</a></h1>
<p class="Pp">Tunables can be set at the <a class="Xr">loader(8)</a> prompt
before booting the kernel or stored in <a class="Xr">loader.conf(5)</a>.</p>
<dl class="Bl-tag">
<dt id="hw.mxge.flow_control_enabled"><var class="Va">hw.mxge.flow_control_enabled</var></dt>
<dd>Whether or not hardware flow control is enabled on the adapter. The
default value is 1.</dd>
<dt id="hw.mxge.intr_coal_delay"><var class="Va">hw.mxge.intr_coal_delay</var></dt>
<dd>This value delays the generation of all interrupts in units of 1
microsecond. The default value is 30.</dd>
<dt id="hw.mxge.skip_pio_read"><var class="Va">hw.mxge.skip_pio_read</var></dt>
<dd>This value determines whether or not the driver may omit doing a PIO read
in the interrupt handler which ensures that the interrupt line has been
deasserted when using xPIC interrupts. A non-zero value may result in
lower CPU overhead, however it may also result in spurious interrupts. The
default value is 0. This tunable has no effect when the device is using
MSI or MSI-X interrupts.</dd>
<dt id="hw.mxge.max_slices"><var class="Va">hw.mxge.max_slices</var></dt>
<dd>This value determines the maximum number of slices the driver will attempt
to use. The default value is 1. A slice is comprised of a set of receive
queues and an associated interrupt thread. When using multiple slices, the
NIC hashes traffic to different slices based on the value of
<var class="Va">hw.mxge.rss_hashtype</var>. Using multiple slices requires
that your motherboard and Myri10GE NIC both be capable of MSI-X. Older
Myri10GE NICs can be field upgraded to add MSI-X using the "10G NIC
Tool Kit" for FreeBSD which is available from
<span class="Pa">http://www.myri.com/scs/download-10g-tools.html</span>.</dd>
<dt id="hw.mxge.rss_hashtype"><var class="Va">hw.mxge.rss_hashtype</var></dt>
<dd>This value determines how incoming traffic is steered to different slices.
This tunable is ignored when using just a single slice. The legal values
for this tunable are:
<dl class="Bl-tag">
<dt>1</dt>
<dd>Hash on the source and destination IPv4 addresses.</dd>
<dt>2</dt>
<dd>Hash on source and destination IPv4 addresses and if the packet is
TCP, then also hash on the TCP source and destination ports.</dd>
<dt>4</dt>
<dd>Hash on the TCP or UDP source ports. This is the default value.</dd>
</dl>
</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
<dl class="Bl-diag">
<dt>mxge%d: Unable to allocate bus resource: memory</dt>
<dd>A fatal initialization error has occurred.</dd>
<dt>mxge%d: Unable to allocate bus resource: interrupt</dt>
<dd>A fatal initialization error has occurred.</dd>
<dt>mxge%d: Could not find firmware image %s</dt>
<dd>The appropriate firmware kld module was not installed. This is a non-fatal
initialization error, but will result in running in a reduced performance
mode.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SUPPORT"><a class="permalink" href="#SUPPORT">SUPPORT</a></h1>
<p class="Pp">For general information and support, go to the Myricom support
website at: <span class="Pa">http://www.myri.com/scs/</span>.</p>
<p class="Pp">If an issue is identified with the released source code on the
supported kernel with a supported adapter, email the specific information
related to the issue to
<<a class="Mt" href="mailto:help@myri.com">help@myri.com</a>>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr">altq(4)</a>, <a class="Xr">arp(4)</a>,
<a class="Xr">netintro(4)</a>, <a class="Xr">ng_ether(4)</a>,
<a class="Xr">ifconfig(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">mxge</code> device driver first appeared in
<span class="Ux">FreeBSD 6.3</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">mxge</code> driver was written by
<span class="An">Andrew Gallatin</span>
<<a class="Mt" href="mailto:gallatin@FreeBSD.org">gallatin@FreeBSD.org</a>>.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">February 13, 2008</td>
<td class="foot-os">FreeBSD 15.0</td>
</tr>
</table>
|
