xref: /freebsd/share/man/man4/nvmf_tcp.4 (revision 59144db3fca192c4637637dfe6b5a5d98632cd47)
1*59144db3SJohn Baldwin.\"
2*59144db3SJohn Baldwin.\" SPDX-License-Identifier: BSD-2-Clause
3*59144db3SJohn Baldwin.\"
4*59144db3SJohn Baldwin.\" Copyright (c) 2024 Chelsio Communications, Inc.
5*59144db3SJohn Baldwin.\"
6*59144db3SJohn Baldwin.Dd May 2, 2024
7*59144db3SJohn Baldwin.Dt NVMF_TCP 4
8*59144db3SJohn Baldwin.Os
9*59144db3SJohn Baldwin.Sh NAME
10*59144db3SJohn Baldwin.Nm nvmf_tcp
11*59144db3SJohn Baldwin.Nd "TCP transport for NVM Express over Fabrics"
12*59144db3SJohn Baldwin.Sh SYNOPSIS
13*59144db3SJohn BaldwinTo compile the module into the kernel,
14*59144db3SJohn Baldwinplace the following line in the
15*59144db3SJohn Baldwinkernel configuration file:
16*59144db3SJohn Baldwin.Bd -ragged -offset indent
17*59144db3SJohn Baldwin.Cd "device nvmf_tcp"
18*59144db3SJohn Baldwin.Ed
19*59144db3SJohn Baldwin.Pp
20*59144db3SJohn BaldwinAlternatively, to load the
21*59144db3SJohn Baldwinmodule at boot time, place the following line in
22*59144db3SJohn Baldwin.Xr loader.conf 5 :
23*59144db3SJohn Baldwin.Bd -literal -offset indent
24*59144db3SJohn Baldwinnvmf_tcp_load="YES"
25*59144db3SJohn Baldwin.Ed
26*59144db3SJohn Baldwin.Sh DESCRIPTION
27*59144db3SJohn BaldwinThe
28*59144db3SJohn Baldwin.Nm
29*59144db3SJohn Baldwinmodule implements the software TCP/IP transport for NVM Express over Fabrics.
30*59144db3SJohn BaldwinIt can be used by either the in-kernel NVMeoF host driver or controller.
31*59144db3SJohn Baldwin.Sh SYSCTL VARIABLES
32*59144db3SJohn BaldwinThe following variables are available as both
33*59144db3SJohn Baldwin.Xr sysctl 8
34*59144db3SJohn Baldwinvariables and
35*59144db3SJohn Baldwin.Xr loader 8
36*59144db3SJohn Baldwintunables:
37*59144db3SJohn Baldwin.Bl -tag -width indent
38*59144db3SJohn Baldwin.It Va kern.nvmf.tcp.max_c2hdata
39*59144db3SJohn BaldwinThe maximum data payload size of a
40*59144db3SJohn Baldwin.Va C2H_DATA
41*59144db3SJohn BaldwinPDU sent by the controller to a remote host.
42*59144db3SJohn BaldwinThe default size is 256 kilobytes.
43*59144db3SJohn Baldwin.El
44*59144db3SJohn Baldwin.Sh SEE ALSO
45*59144db3SJohn Baldwin.Xr nvmf 4 ,
46*59144db3SJohn Baldwin.Xr nvmft 4
47*59144db3SJohn Baldwin.Sh HISTORY
48*59144db3SJohn BaldwinThe
49*59144db3SJohn Baldwin.Nm
50*59144db3SJohn Baldwinmodule first appeared in
51*59144db3SJohn Baldwin.Fx 15.0 .
52*59144db3SJohn Baldwin.Sh AUTHORS
53*59144db3SJohn BaldwinThe
54*59144db3SJohn Baldwin.Nm
55*59144db3SJohn Baldwinmodule was developed by
56*59144db3SJohn Baldwin.An John Baldwin Aq Mt jhb@FreeBSD.org
57*59144db3SJohn Baldwinunder sponsorship from Chelsio Communications, Inc.
58