share/man/man4/liquidio.4

   1 .\"  BSD LICENSE
   2 .\"
   3 .\"  Copyright(c) 2017 Cavium, Inc.. All rights reserved.
   4 .\"  All rights reserved.
   5 .\"
   6 .\"  Redistribution and use in source and binary forms, with or without
   7 .\"  modification, are permitted provided that the following conditions
   8 .\"  are met:
   9 .\"
  10 .\"    * Redistributions of source code must retain the above copyright
  11 .\"      notice, this list of conditions and the following disclaimer.
  12 .\"    * Redistributions in binary form must reproduce the above copyright
  13 .\"      notice, this list of conditions and the following disclaimer in
  14 .\"      the documentation and/or other materials provided with the
  15 .\"      distribution.
  16 .\"    * Neither the name of Cavium, Inc. nor the names of its
  17 .\"      contributors may be used to endorse or promote products derived
  18 .\"      from this software without specific prior written permission.
  19 .\"
  20 .\"  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\"  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\"  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23 .\"  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24 .\"  OWNER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 .\"  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 .\"  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 .\"  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 .\"  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\"  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30 .\"  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd August 17, 2017
  34 .Dt LIQUIDIO 4
  35 .Os
  36 .Sh NAME
  37 .Nm liquidio
  38 .Nd "Cavium 10Gb/25Gb Ethernet driver for the FreeBSD operating system"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following line in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device lio"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_lio_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for 23XX 10Gb/25Gb Ethernet adapters.
  57 The driver supports Jumbo Frames, Transmit/Receive checksum
  58 offload, TCP segmentation offload (TSO), Large Receive Offload (LRO),
  59 VLAN tag insertion/extraction, VLAN checksum offload,
  60 VLAN TSO, and Receive Side Steering (RSS)
  61 .Pp
  62 Support for Jumbo Frames is provided via the interface MTU setting.
  63 Selecting an MTU larger than 1500 bytes with the
  64 .Xr ifconfig 8
  65 utility configures the adapter to receive and transmit Jumbo Frames.
  66 The maximum MTU size for Jumbo Frames is 16000.
  67 .Pp
  68 For more information on configuring this device, see ifconfig(8).
  69 .Sh HARDWARE
  70 The
  71 .Nm
  72 driver supports the following cards:
  73 .Pp
  74 .Bl -bullet -compact
  75 .It
  76 LiquidIO II CN2350 210SV/225SV
  77 .It
  78 LiquidIO II CN2360 210SV/225SV
  79 .El
  80 .Sh LOADER TUBABLES
  81 Tunables can be set at the
  82 .Xr loader 8
  83 prompt before booting the kernel or stored in
  84 .Xr loader.conf 5 .
  85 .Pp
  86 .Bl -tag -width indent
  87 .It Va hw.lio.fw_type
  88 .Pp
  89 String that specifies type of firmware to be loaded.
  90 Default is "nic". Use "none" to load firmware from flash.
  91 .It Va hw.lio.num_queues_per_pf0
  92 .Pp
  93 Unsigned integers that specify number of queues per PF0.
  94 Valid range is 0 to 64.
  95 Use 0 to derive autoconfigures based on the number of
  96 cpus with a max of 8
  97 .It Va hw.lio.num_queues_per_pf1
  98 .Pp
  99 Unsigned integers that specify number of queues per PF1.
 100 Valid range is 0 to 64.
 101 Use 0 to derive autoconfigures based on the number of
 102 cpus with a max of 8
 103 .It Va hw.lio.console_bitmask
 104 .Pp
 105 Bitmask indicating which consoles have debug output
 106 redirected to syslog.
 107 .It Va hw.lio.rss
 108 .Pp
 109 To enable/disable driver RSS support
 110 .It Va hw.lio.hwlro
 111 .Pp
 112 To enable/disable hardware LRO
 113 .El
 114 .Sh SUPPORT
 115 For general information and support,
 116 go to the Cavium support website at:
 117 .Pa http://support.cavium.com .
 118 .Sh SEE ALSO
 119 .Xr altq 4 ,
 120 .Xr arp 4 ,
 121 .Xr netintro 4 ,
 122 .Xr ng_ether 4 ,
 123 .Xr vlan 4 ,
 124 .Xr ifconfig 8
 125 .Sh HISTORY
 126 The
 127 .Nm
 128 device driver first appeared in
 129 .Fx 12.0 .
 130 .Sh AUTHORS
 131 The
 132 .Nm
 133 driver was written by
 134 .An Derek Chickles Aq Mt derek.chickles@cavium.com .