1 .\" Copyright (c) 2006, Myricom Inc
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions are met:
7 .\" 1. Redistributions of source code must retain the above copyright notice,
8 .\" 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 the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the Myricom Inc nor the names of its
15 .\" contributors may be used to endorse or promote products derived from
16 .\" this software without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
30 .\" * Other names and brands may be claimed as the property of others.
32 .\" $FreeBSD: src/share/man/man4/mxge.4,v 1.7.4.2.4.1 2009/04/15 03:14:26 kensmith Exp $
39 .Nd "Myricom Myri10GE 10 Gigabit Ethernet adapter driver"
41 To compile this driver into the kernel,
42 place the following lines in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
48 Alternatively, to load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
57 driver provides support for PCI Express 10 Gigabit Ethernet adapters based on
58 the Myricom LANai Z8E chip.
59 The driver supports Transmit/Receive checksum offload,
60 TCP Segmentation Offload (TSO),
61 multiple reception queues,
62 multiple tranmission queues and
63 multiple vector MSI-X.
64 .\"Support for Jumbo frames is not yet implemented, while support for
65 .\"as well as Large Receive Offload (LRO) is not
67 Using multiple vector MSI-X requires that Myri10GE NIC be capable of MSI-X.
68 Older Myri10GE NICs can be field upgraded to add MSI-X using the
69 "Myri-10G Network Adapter Toolkit" for FreeBSD or Linux
70 which is available from
71 .Pa https://www.myricom.com/support/downloads/tools/myri-10g-toolkit.html .
73 For questions related to hardware requirements,
74 refer to the documentation supplied with your Myri10GE adapter.
75 All hardware requirements listed apply to use with
77 For further hardware information, see
78 .Pa http://www.myricom.com .
80 For more information on configuring this device, see
89 driver supports 10 Gigabit Ethernet adapters based on the
90 Myricom LANai Z8E chips:
94 Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C)
96 Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R)
98 Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)
102 is the device unit number.
103 .Bl -tag -width indent
104 .It Va hw.mxge.msix.enable Va hw.mxgeX.msix.enable
106 the driver will use MSI-X
108 This behaviour can be turned off by setting this tunable to 0.
109 .It Va hw.mxgeX.msix.offset
110 If more than 1 slices are enabled,
111 this tunable specifies the leading target CPU for slice's
112 transmission and reception queues processing.
113 The value specificed must be aligned to the number of slices enabled and
114 must be less than the power of 2 number of CPUs.
115 .It Va hw.mxge.msi.enable Va hw.mxgeX.msi.enable
116 If MSI-X is disabled and MSI is supported,
117 the driver will use MSI.
118 This behavior can be turned off by setting this tunable to 0.
119 .It Va hw.mxgeX.msi.cpu
120 If MSI is used, it specifies the MSI's target CPU.
121 .It Va hw.mxge.num_slices Va hw.mxgeX.num_slices
123 this value determines the maximum number of slices the driver
125 Setting this value to 0 allows driver to enable as many slices
126 as allowed by the number of CPUs.
127 Each slice is comprised of one reception queue and one transmission
129 The transmission queue of each slice,
130 except the first slice,
132 The default value is 0.
133 .It Va hw.mxge.multi_tx Va hw.mxgeX.multi_tx
134 If more then 1 slices are enabled,
135 this tunable controls whether the tranmission queue of each
136 slice should be enabled.
137 Setting this tunable to 0 will only enable the transmission queue
139 The default value is 1.
140 .It Va hw.mxge.use_rss
141 This tunable controls whether standard RSS input hash function or
142 chip private input hash function should be used.
143 Using standard RSS input hash function degenerates reception
144 performance significantly.
145 The default value is 0.
146 .It Va hw.mxge.intr_coal_delay
147 This value delays the generation of all interrupts in units of
149 The default value is 150.
150 .It Va hw.mxge.flow_control_enabled
151 Whether or not hardware flow control is enabled on the adapter.
152 The default value is 1.
155 A number of per-interface variables are implemented in the
156 .Va dev.mxge. Ns Em X
160 .Bl -tag -width "flow_control_enabled"
161 .It Va firmware_version
162 The version string of firmware that is currently loaded by the driver.
166 .Va hw.mxge.use_rss .
167 Flipping its value will cause chip reinitialization.
168 .It Va intr_coal_delay
170 .Va hw.mxge.intr_coal_delay .
171 .It Va flow_control_enabled
173 .Va hw.mxge.flow_control_enabled .
176 For general information and support,
177 go to the Myricom support website at:
178 .Pa https://www.myricom.com/support.html .
190 device driver first appeared in
192 It was first ported to
197 driver was written by
198 .An Andrew Gallatin Aq Mt gallatin@FreeBSD.org .