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 and hardware vlan
61 .\"Support for Jumbo frames is not yet implemented, while support for TCP
62 .\"Segmentation Offload (TSO) as well as Large Receive Offload (LRO) is not
64 For further hardware information, see
65 .Pa http://www.myri.com/ .
67 For questions related to hardware requirements,
68 refer to the documentation supplied with your Myri10GE adapter.
69 All hardware requirements listed apply to use with
74 driver supports 10 Gigabit Ethernet adapters based on the
75 Myricom LANai Z8E chips:
79 Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C)
81 Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R)
83 Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)
86 Tunables can be set at the
88 prompt before booting the kernel or stored in
90 .Bl -tag -width indent
91 .It Va hw.mxge.flow_control_enabled
92 Whether or not hardware flow control is enabled on the adapter.
93 The default value is 1.
94 .It Va hw.mxge.intr_coal_delay
95 This value delays the generation of all interrupts in units of
97 The default value is 30.
98 .It Va hw.mxge.skip_pio_read
99 This value determines whether or not the driver may omit doing a
100 PIO read in the interrupt handler which ensures that the interrupt
101 line has been deasserted when using xPIC interrupts.
103 may result in lower CPU overhead, however it may also result in
105 The default value is 0.
106 This tunable has no effect when the device is
107 using MSI or MSI-X interrupts.
108 .It Va hw.mxge.max_slices
109 This value determines the maximum number of slices the driver
111 The default value is 1.
113 of a set of receive queues and an associated interrupt thread.
114 When using multiple slices, the NIC hashes traffic to different slices
115 based on the value of
116 .Va hw.mxge.rss_hash_type .
117 Using multiple slices requires that your motherboard and Myri10GE NIC
118 both be capable of MSI-X.
119 Older Myri10GE NICs can be field upgraded to add
120 MSI-X using the "10G NIC Tool Kit" for
122 which is available from
123 .Pa http://www.myri.com/scs/download-10g-tools.html .
125 .It Va hw.mxge.rss_hash_type
126 This value determines how incoming traffic is steered to different
128 This tunable is ignored when using just a single slice.
129 The legal values for this tunable are:
130 .Bl -tag -width "XXXX"
132 Hash on the source and destination IPv4 addresses.
134 Hash on source and destination IPv4 addresses and if the packet
135 is TCP, then also hash on the TCP source and destination ports.
137 Hash on the TCP or UDP source ports.
138 This is the default value.
143 .It "mxge%d: Unable to allocate bus resource: memory"
144 A fatal initialization error has occurred.
145 .It "mxge%d: Unable to allocate bus resource: interrupt"
146 A fatal initialization error has occurred.
147 .It "mxge%d: Could not find firmware image %s"
148 The appropriate firmware kld module was not installed.
149 This is a non-fatal initialization error, but will
150 result in running in a reduced performance mode.
153 For general information and support,
154 go to the Myricom support website at:
155 .Pa http://www.myri.com/scs/ .
167 device driver first appeared in
169 It was first ported to
174 driver was written by
175 .An Andrew Gallatin Aq Mt gallatin@FreeBSD.org .