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