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