share/man/man4/nxge.4

   1 .\" Copyright (c) 2007, Neterion 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
   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 October 16, 2007
  28 .Dt NXGE 4
  29 .Os
  30 .Sh NAME
  31 .Nm nxge
  32 .Nd "Neterion Xframe 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 nxge"
  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_nxge_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 driver provides support for Neterion Xframe-I and Xframe-II adapters.
  51 The driver supports TCP Segmentation Offload (TSO/LSO),
  52 Large Receive Offload (LRO), Jumbo Frames (5 buffer mode),
  53 Header Separation (Rx 2 buffer mode), VLAN, and Promiscuous mode.
  54 .Pp
  55 For general information and support, please visit the Neterion support page
  56 .Pa http://www.neterion.com/support/support.html .
  57 .Pp
  58 Support for Jumbo Frames is provided via the interface MTU setting.
  59 Selecting an MTU larger than 1500 bytes with the
  60 .Xr ifconfig 8
  61 utility configures the adapter to transmit and receive Jumbo Frames.
  62 Xframe adapters support Jumbo Frames up to 9600 bytes.
  63 .Pp
  64 For Jumbo Frames, the driver will try to allocate physically contiguous buffers.
  65 Failures to do so may degrade the performance.
  66 To resolve such problems, please visit
  67 .Pa http://www.neterion.com
  68 where additional information and a kernel patch can be found.
  69 .Pp
  70 For more information on configuring this device, see
  71 .Xr ifconfig 8 .
  72 .Sh HARDWARE
  73 The
  74 .Nm
  75 driver supports Neterion Xframe 10 Gigabit Ethernet adapters listed in
  76 .Pa http://www.neterion.com/how/pricing.html .
  77 .Sh SUPPORT
  78 For troubleshooting tips and FAQs, please visit
  79 .Pa http://trac.neterion.com/cgi-bin/trac.cgi/wiki/TitleIndex?anonymous .
  80 .Pp
  81 For any issues please send an email to
  82 .Aq support@neterion.com .
  83 .Sh SEE ALSO
  84 .Xr arp 4 ,
  85 .Xr netintro 4 ,
  86 .Xr ifconfig 8
  87 .Sh HISTORY
  88 The
  89 .Nm
  90 device driver first appeared in
  91 .Fx 7.0 .
  92 .Sh AUTHORS
  93 The
  94 .Nm
  95 driver was written by
  96 .An Neterion
  97 .Aq support@neterion.com .