DragonFly On-Line Manual Pages


MXGE(4) 	      DragonFly Kernel Interfaces Manual	       MXGE(4)

NAME

mxge -- Myricom Myri10GE 10 Gigabit Ethernet adapter driver

SYNOPSIS

To compile this driver into the kernel, place the following lines in your kernel configuration file: device mxge Alternatively, to load the driver as a module at boot time, place the following line in loader.conf(5): if_mxge_load="YES"

DESCRIPTION

The mxge driver provides support for PCI Express 10 Gigabit Ethernet adapters based on the Myricom LANai Z8E chip. The driver supports Trans- mit/Receive checksum offload, TCP Segmentation Offload (TSO), multiple reception queues, multiple tranmission queues and multiple vector MSI-X. Using multiple vector MSI-X requires that Myri10GE NIC be capable of MSI- X. Older Myri10GE NICs can be field upgraded to add MSI-X using the "Myri-10G Network Adapter Toolkit" for FreeBSD or Linux which is avail- able from https://www.myricom.com/support/downloads/tools/myri-10g-toolkit.html. For questions related to hardware requirements, refer to the documenta- tion supplied with your Myri10GE adapter. All hardware requirements listed apply to use with DragonFly. For further hardware information, see http://www.myricom.com. For more information on configuring this device, see ifconfig(8). The mxge driver supports polling(4).

HARDWARE

The mxge driver supports 10 Gigabit Ethernet adapters based on the Myri- com LANai Z8E chips: * Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C) * Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R) * Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)

TUNABLES

X is the device unit number. hw.mxge.msix.enable hw.mxgeX.msix.enable By default, the driver will use MSI-X if it is supported. This behaviour can be turned off by setting this tunable to 0. hw.mxgeX.msix.offset If more than 1 slices are enabled, this tunable specifies the leading target CPU for slice's transmission and reception queues processing. The value specificed must be aligned to the number of slices enabled and must be less than the power of 2 number of CPUs. hw.mxge.msi.enable hw.mxgeX.msi.enable If MSI-X is disabled and MSI is supported, the driver will use MSI. This behavior can be turned off by setting this tunable to 0. hw.mxgeX.msi.cpu If MSI is used, it specifies the MSI's target CPU. hw.mxge.num_slices hw.mxgeX.num_slices If MSI-X is used, this value determines the maximum number of slices the driver will attempt to use. Setting this value to 0 allows driver to enable as many slices as allowed by the number of CPUs. Each slice is comprised of one reception queue and one transmission queue. The transmission queue of each slice, except the first slice, could be disabled. The default value is 0. hw.mxge.multi_tx hw.mxgeX.multi_tx If more then 1 slices are enabled, this tunable controls whether the tranmission queue of each slice should be enabled. Setting this tunable to 0 will only enable the transmission queue on the first slice. The default value is 1. hw.mxge.use_rss This tunable controls whether standard RSS input hash function or chip private input hash function should be used. Using standard RSS input hash function degenerates reception performance signif- icantly. The default value is 0. hw.mxge.intr_coal_delay This value delays the generation of all interrupts in units of 1 microsecond. The default value is 150. hw.mxge.flow_control_enabled Whether or not hardware flow control is enabled on the adapter. The default value is 1. MIB Variables A number of per-interface variables are implemented in the dev.mxge.X branch of the sysctl(3) MIB. firmware_version The version string of firmware that is currently loaded by the driver. It is read-only. use_rss See tunable hw.mxge.use_rss. Flipping its value will cause chip reinitialization. intr_coal_delay See tunable hw.mxge.intr_coal_delay. flow_control_enabled See tunable hw.mxge.flow_control_enabled.

SUPPORT

For general information and support, go to the Myricom support website at: https://www.myricom.com/support.html.

SEE ALSO

altq(4), arp(4), ifmedia(4), netintro(4), ng_ether(4), ifconfig(8), firmware(9)

HISTORY

The mxge device driver first appeared in FreeBSD 6.3. It was first ported to DragonFly 2.3.

AUTHORS

The mxge driver was written by Andrew Gallatin <gallatin@FreeBSD.org>. DragonFly 4.1 November 28, 2014 DragonFly 4.1