share/man/man4/sfxge.4

   1 .\" Copyright (c) 2011 Solarflare Communications, 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.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd November 16, 2011
  28 .Dt SFXGE 4
  29 .Os
  30 .Sh NAME
  31 .Nm sfxge
  32 .Nd "Solarflare 10Gb Ethernet adapter driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device sfxge"
  39 .Ed
  40 .Pp
  41 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 sfxge_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 driver provides support for 10Gb Ethernet adapters based on
  51 Solarflare SFC9000 family controllers.  The driver supports jumbo
  52 frames, transmit/receive checksum offload, TCP Segmentation Offload
  53 (TSO), Large Receive Offload (LRO), VLAN checksum offload, VLAN TSO,
  54 and Receive Side Scaling (RSS) using MSI-X interrupts.
  55 .Pp
  56 The driver allocates 1 receive queue, transmit queue, event queue and
  57 IRQ per CPU up to a maximum of 64.  IRQ affinities should be spread
  58 out using
  59 .Xr cpuset 8 .
  60 Interrupt moderation may be controlled through the sysctl
  61 dev.sfxge.\fIindex\fR.int_mod (units are microseconds).
  62 .Pp
  63 For more information on configuring this device, see
  64 .Xr ifconfig 8 .
  65 .Pp
  66 A large number of MAC, PHY and data path statistics are available
  67 under the sysctl dev.sfxge.\fIindex\fR.stats.  The adapter's VPD
  68 fields including its serial number are available under the sysctl
  69 dev.sfxge.\fIindex\fR.vpd.
  70 .Sh HARDWARE
  71 The
  72 .Nm
  73 driver supports all 10Gb Ethernet adapters based on Solarflare SFC9000
  74 family controllers.
  75 .Sh SUPPORT
  76 For general information and support,
  77 go to the Solarflare support website at:
  78 .Pa https://support.solarflare.com .
  79 .Sh SEE ALSO
  80 .Xr arp 4 ,
  81 .Xr netintro 4 ,
  82 .Xr ng_ether 4 ,
  83 .Xr vlan 4 ,
  84 .Xr cpuset 8 ,
  85 .Xr ifconfig 8
  86 .Sh AUTHORS
  87 The
  88 .Nm
  89 driver was written by
  90 .An Philip Paeps
  91 and
  92 .An Solarflare Communications, Inc.