share/man/man4/mxge.4

   1 .\" Copyright (c) 2006, Myricom Inc
   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 are met:
   6 .\"
   7 .\" 1. Redistributions of source code must retain the above copyright notice,
   8 .\"    this list of conditions and the following disclaimer.
   9 .\"
  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.
  13 .\"
  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.
  17 .\"
  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.
  29 .\"
  30 .\" * Other names and brands may be claimed as the property of others.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd September 15, 2006
  35 .Dt MXGE 4
  36 .Os
  37 .Sh NAME
  38 .Nm mxge
  39 .Nd "Myricom Myri10GE 10 Gigabit Ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device firmware"
  46 .Cd "device mxge"
  47 .Ed
  48 .Pp
  49 Alternatively, to load the driver as a
  50 module at boot time, place the following lines in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 if_mxge_load="YES"
  54 mxge_ethp_z8e_load="YES"
  55 mxge_eth_z8e_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for PCI Express 10 Gigabit Ethernet adapters based on
  61 the Myricom LANai Z8E chip.
  62 The driver supports Transmit/Receive checksum offload,
  63 Jumbo Frames as well as TCP segmentation offload (TSO).
  64 For further hardware information, see
  65 .Pa http://www.myri.com/ .
  66 .Pp
  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
  70 .Fx .
  71 .Pp
  72 Support for Jumbo Frames is provided via the interface MTU setting.
  73 Selecting an MTU larger than 1500 bytes with the
  74 .Xr ifconfig 8
  75 utility configures the adapter to receive and transmit Jumbo Frames.
  76 The maximum MTU size for Jumbo Frames is 9000.
  77 .Pp
  78 For more information on configuring this device, see
  79 .Xr ifconfig 8 .
  80 .Sh HARDWARE
  81 The
  82 .Nm
  83 driver supports 10 Gigabit Ethernet adapters based on the
  84 Myricom LANai Z8E chips:
  85 .Pp
  86 .Bl -bullet -compact
  87 .It
  88 Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C)
  89 .It
  90 Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R)
  91 .It
  92 Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)
  93 .El
  94 .Sh LOADER TUNABLES
  95 Tunables can be set at the
  96 .Xr loader 8
  97 prompt before booting the kernel or stored in
  98 .Xr loader.conf 5 .
  99 .Bl -tag -width indent
 100 .It Va hw.mxge.flow_control_enabled
 101 Whether or not hardware flow control is enabled on the adapter.
 102 The default value is 1.
 103 .It Va hw.mxge.intr_coal_delay
 104 This value delays the generation of all interrupts in units of
 105 1 microsecond.
 106 The default value is 30.
 107 .It Va hw.mxge.skip_pio_read
 108 This value determines whether or not the driver may omit doing a
 109 pio read in the interrupt handler which ensures that the interrupt
 110 line has been deasserted when using xPIC interrupts.
 111 A non-zero value
 112 may result in lower CPU overhead, however it may also result in
 113 spurious interrupts.
 114 The default value is 0.
 115 .El
 116 .Sh DIAGNOSTICS
 117 .Bl -diag
 118 .It "mxge%d: Unable to allocate bus resource: memory"
 119 A fatal initialization error has occurred.
 120 .It "mxge%d: Unable to allocate bus resource: interrupt"
 121 A fatal initialization error has occurred.
 122 .It "mxge%d: Could not find firmware image %s"
 123 The appropriate firmware kld module was not installed.
 124 This is a fatal initialization error.
 125 .El
 126 .Sh SUPPORT
 127 For general information and support,
 128 go to the Myricom support website at:
 129 .Pa http://www.myri.com/scs/ .
 130 .Pp
 131 If an issue is identified with the released source code on the supported kernel
 132 with a supported adapter, email the specific information related to the
 133 issue to
 134 .Aq help@myri.com .
 135 .Sh SEE ALSO
 136 .Xr arp 4 ,
 137 .Xr netintro 4 ,
 138 .Xr ng_ether 4 ,
 139 .Xr ifconfig 8
 140 .Sh HISTORY
 141 The
 142 .Nm
 143 device driver first appeared in
 144 .Fx 7.0 .
 145 .Sh AUTHORS
 146 The
 147 .Nm
 148 driver was written by
 149 .An Andrew Gallatin Aq gallatin@FreeBSD.org .