xref: /freebsd/share/man/man4/liquidio.4 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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.\"
32.Dd August 17, 2017
33.Dt LIQUIDIO 4
34.Os
35.Sh NAME
36.Nm liquidio
37.Nd "Cavium 10Gb/25Gb Ethernet driver for the FreeBSD operating system"
38.Sh SYNOPSIS
39To compile this driver into the kernel,
40place the following line in your
41kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device lio"
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50if_lio_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for 23XX 10Gb/25Gb Ethernet adapters.
56The driver supports Jumbo Frames, Transmit/Receive checksum
57offload, TCP segmentation offload (TSO), Large Receive Offload (LRO),
58VLAN tag insertion/extraction, VLAN checksum offload,
59VLAN TSO, and Receive Side Steering (RSS)
60.Pp
61Support for Jumbo Frames is provided via the interface MTU setting.
62Selecting an MTU larger than 1500 bytes with the
63.Xr ifconfig 8
64utility configures the adapter to receive and transmit Jumbo Frames.
65The maximum MTU size for Jumbo Frames is 16000.
66.Pp
67For more information on configuring this device, see ifconfig(8).
68.Sh HARDWARE
69The
70.Nm
71driver supports the following cards:
72.Pp
73.Bl -bullet -compact
74.It
75LiquidIO II CN2350 210SV/225SV
76.It
77LiquidIO II CN2360 210SV/225SV
78.El
79.Sh LOADER TUNABLES
80Tunables can be set at the
81.Xr loader 8
82prompt before booting the kernel or stored in
83.Xr loader.conf 5 .
84.Bl -tag -width indent
85.It Va hw.lio.fw_type
86.Pp
87String that specifies type of firmware to be loaded.
88Default is "nic". Use "none" to load firmware from flash.
89.It Va hw.lio.num_queues_per_pf0
90.Pp
91Unsigned integers that specify number of queues per PF0.
92Valid range is 0 to 64.
93Use 0 to derive autoconfigures based on the number of
94cpus with a max of 8
95.It Va hw.lio.num_queues_per_pf1
96.Pp
97Unsigned integers that specify number of queues per PF1.
98Valid range is 0 to 64.
99Use 0 to derive autoconfigures based on the number of
100cpus with a max of 8
101.It Va hw.lio.console_bitmask
102.Pp
103Bitmask indicating which consoles have debug output
104redirected to syslog.
105.It Va hw.lio.rss
106.Pp
107To enable/disable driver RSS support
108.It Va hw.lio.hwlro
109.Pp
110To enable/disable hardware LRO
111.El
112.Sh SUPPORT
113For general information and support,
114go to the Cavium support website at:
115.Pa http://support.cavium.com .
116.Sh SEE ALSO
117.Xr altq 4 ,
118.Xr arp 4 ,
119.Xr netintro 4 ,
120.Xr ng_ether 4 ,
121.Xr vlan 4 ,
122.Xr ifconfig 8
123.Sh HISTORY
124The
125.Nm
126device driver first appeared in
127.Fx 12.0 .
128.Sh AUTHORS
129The
130.Nm
131driver was written by
132.An Derek Chickles Aq Mt derek.chickles@cavium.com .
133