xref: /freebsd/share/man/man4/nvmf_tcp.4 (revision 5d0498db478253c42b5e4140b9aff8596a797464)
159144db3SJohn Baldwin.\"
259144db3SJohn Baldwin.\" SPDX-License-Identifier: BSD-2-Clause
359144db3SJohn Baldwin.\"
459144db3SJohn Baldwin.\" Copyright (c) 2024 Chelsio Communications, Inc.
559144db3SJohn Baldwin.\"
6*5d0498dbSJohn Baldwin.Dd July 25, 2024
759144db3SJohn Baldwin.Dt NVMF_TCP 4
859144db3SJohn Baldwin.Os
959144db3SJohn Baldwin.Sh NAME
1059144db3SJohn Baldwin.Nm nvmf_tcp
1159144db3SJohn Baldwin.Nd "TCP transport for NVM Express over Fabrics"
1259144db3SJohn Baldwin.Sh SYNOPSIS
1359144db3SJohn BaldwinTo compile the module into the kernel,
1459144db3SJohn Baldwinplace the following line in the
1559144db3SJohn Baldwinkernel configuration file:
1659144db3SJohn Baldwin.Bd -ragged -offset indent
1759144db3SJohn Baldwin.Cd "device nvmf_tcp"
1859144db3SJohn Baldwin.Ed
1959144db3SJohn Baldwin.Pp
2059144db3SJohn BaldwinAlternatively, to load the
2159144db3SJohn Baldwinmodule at boot time, place the following line in
2259144db3SJohn Baldwin.Xr loader.conf 5 :
2359144db3SJohn Baldwin.Bd -literal -offset indent
2459144db3SJohn Baldwinnvmf_tcp_load="YES"
2559144db3SJohn Baldwin.Ed
2659144db3SJohn Baldwin.Sh DESCRIPTION
2759144db3SJohn BaldwinThe
2859144db3SJohn Baldwin.Nm
2959144db3SJohn Baldwinmodule implements the software TCP/IP transport for NVM Express over Fabrics.
3059144db3SJohn BaldwinIt can be used by either the in-kernel NVMeoF host driver or controller.
3159144db3SJohn Baldwin.Sh SYSCTL VARIABLES
3259144db3SJohn BaldwinThe following variables are available as both
3359144db3SJohn Baldwin.Xr sysctl 8
3459144db3SJohn Baldwinvariables and
3559144db3SJohn Baldwin.Xr loader 8
3659144db3SJohn Baldwintunables:
3759144db3SJohn Baldwin.Bl -tag -width indent
38*5d0498dbSJohn Baldwin.It Va kern.nvmf.tcp.max_transmit_data
39*5d0498dbSJohn BaldwinThe maximum data payload size of
4059144db3SJohn Baldwin.Va C2H_DATA
41*5d0498dbSJohn Baldwinand
42*5d0498dbSJohn Baldwin.Va H2C_DATA
43*5d0498dbSJohn BaldwinPDUs.
44*5d0498dbSJohn BaldwinA remote controller may enforce a lower limit on the size of
45*5d0498dbSJohn Baldwin.Va H2C_DATA
46*5d0498dbSJohn BaldwinPDUs via the
47*5d0498dbSJohn Baldwin.Va MAXH2CDATA
48*5d0498dbSJohn Baldwinparameter.
4959144db3SJohn BaldwinThe default size is 256 kilobytes.
5059144db3SJohn Baldwin.El
5159144db3SJohn Baldwin.Sh SEE ALSO
5259144db3SJohn Baldwin.Xr nvmf 4 ,
5359144db3SJohn Baldwin.Xr nvmft 4
5459144db3SJohn Baldwin.Sh HISTORY
5559144db3SJohn BaldwinThe
5659144db3SJohn Baldwin.Nm
5759144db3SJohn Baldwinmodule first appeared in
5859144db3SJohn Baldwin.Fx 15.0 .
5959144db3SJohn Baldwin.Sh AUTHORS
6059144db3SJohn BaldwinThe
6159144db3SJohn Baldwin.Nm
6259144db3SJohn Baldwinmodule was developed by
6359144db3SJohn Baldwin.An John Baldwin Aq Mt jhb@FreeBSD.org
6459144db3SJohn Baldwinunder sponsorship from Chelsio Communications, Inc.
65