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