xref: /freebsd/share/man/man4/nvmf_tcp.4 (revision 87b759f0fa1f7554d50ce640c40138512bbded44)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2024 Chelsio Communications, Inc.
5.\"
6.Dd July 25, 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_transmit_data
39The maximum data payload size of
40.Va C2H_DATA
41and
42.Va H2C_DATA
43PDUs.
44A remote controller may enforce a lower limit on the size of
45.Va H2C_DATA
46PDUs via the
47.Va MAXH2CDATA
48parameter.
49The default size is 256 kilobytes.
50.El
51.Sh SEE ALSO
52.Xr nvmf 4 ,
53.Xr nvmft 4
54.Sh HISTORY
55The
56.Nm
57module first appeared in
58.Fx 15.0 .
59.Sh AUTHORS
60The
61.Nm
62module was developed by
63.An John Baldwin Aq Mt jhb@FreeBSD.org
64under sponsorship from Chelsio Communications, Inc.
65