share/man/man4/vxge.4

   1 .\" Copyright (c) 2002-2011 Exar Corp.
   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
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified.
  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 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 16, 2011
  28 .Dt VXGE 4
  29 .Os
  30 .Sh NAME
  31 .Nm vxge
  32 .Nd "Neterion X3100 10GbE Server/Storage adapter driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following line in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device vxge"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 if_vxge_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 driver provides support for Neterion X3100 adapters.
  51 The driver supports TCP Segmentation Offload (TSO/LSO),
  52 Large Receive Offload (LRO), Jumbo Frames, Receive Traffic Hash (RTH),
  53 VLAN, Promiscuous mode and Multi function mode.
  54 .Pp
  55 The
  56 .Nm
  57 driver supports the following function modes:
  58 .Bd -ragged -offset indent
  59 .Cd "SF1_VP17 - 1 function with 17 VPATHs"
  60 .Ed
  61 .Bd -ragged -offset indent
  62 .Cd "MF8_VP2 - 8 functions with 2 VPATHs per function"
  63 .Ed
  64 .Bd -ragged -offset indent
  65 .Cd "MF2_VP8 - 2 functions, 8 Paths/Function"
  66 .Ed
  67 .Bd -ragged -offset indent
  68 .Cd "MF4_VP4 - 4 Functions, 4 Paths/Function"
  69 .Ed
  70 .Bd -ragged -offset indent
  71 .Cd "MF8P_VP2 - 8 functions with 2 VPATHs per function required for DirectIO"
  72 .Ed
  73 .Pp
  74 For general information and support, please visit the Neterion support page
  75 .Pa http://www.neterion.com/support/support.html .
  76 .Pp
  77 Support for Jumbo Frames is provided via the interface MTU setting.
  78 Selecting an MTU larger than 1500 bytes with the
  79 .Xr ifconfig 8
  80 utility configures the adapter to transmit and receive Jumbo Frames.
  81 X3100 adapters support Jumbo Frames up to 9600 bytes.
  82 .Pp
  83 For Jumbo Frames, the driver will try to allocate physically contiguous buffers.
  84 Failures to do so may degrade the performance.
  85 To resolve such problems, please visit
  86 .Pa http://www.neterion.com
  87 where additional information and a kernel patch can be found.
  88 .Pp
  89 For more information on configuring this device, see
  90 .Xr ifconfig 8 .
  91 .Sh HARDWARE
  92 The
  93 .Nm
  94 driver supports Neterion X3100 10 Gigabit Ethernet adapters listed in
  95 .Pa http://www.neterion.com .
  96 .Sh SUPPORT
  97 For troubleshooting tips and FAQs, please visit
  98 .Pa http://trac.neterion.com/cgi-bin/trac.cgi/wiki/TitleIndex?anonymous .
  99 .Pp
 100 For any issues please send an email to
 101 .Aq support@neterion.com .
 102 .Sh SEE ALSO
 103 .Xr arp 8 ,
 104 .Xr ifconfig 8
 105 .Sh AUTHORS
 106 The
 107 .Nm
 108 driver was written by
 109 .An Neterion
 110 .Aq support@neterion.com .