From nobody Tue Dec 9 15:58:12 2025 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4dQk5w74kWz6KpZ4 for ; Tue, 09 Dec 2025 15:58:12 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4dQk5w5tjlz453V for ; Tue, 09 Dec 2025 15:58:12 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1765295892; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=eKriZpqbIrSWhu/k9ft3VFuTbb1GRtVTLpujoxoJqWY=; b=lRkBpPmFqVjIC9z/l3Ts8XglO/Kt4iG6ZvAU4hpaum7abQ203unVb2T2iLDDlHf5Q1ckga 8+BpOedfTn3mIUjcDwk0IFSW7WfnykUkPsb7gB1G2jfreEtd9gJYrqoK0TDXiUVAi8bVUw Q54aOK6jGijpoC2BqSSYvlK3dGy0zmbKiTQjbg/w2WwnfQNdx2s+3PL1ZrE6BGYS7xVymv p63pyPqtP0dYGTQSE7hgSh+gD29Rq4949R9GHb7p6NKQhsQjoGQN69EqHw6ARZdY9ELriW +EZHd+dBTqFmB6DDUUwPEj0HPxo6guaQqquDszFzDgV5m47dtADVv2sHbq41DA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1765295892; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=eKriZpqbIrSWhu/k9ft3VFuTbb1GRtVTLpujoxoJqWY=; b=D1xUY6IMK4bLlB/Skzmqbi52ACVqXL/ec4roBva+MI94CaVriS4Ftld0dPY+dD3C3shnAP JYVjfKRhDY8D4Zd23hB3WsYyO+CMFXQaNqoZhSNyl2CavReFZoH6HSnHLYT6mgYQyh80Vv 658SoE8PKEkuc1rJh+uHcYByU1esX53Rgu4Kiaz382VJV69KmbJMCETpwyrEZJ2OYMM7DX XTyl1d/qU035YQMlY1a3U+0dTTmeQgA/6k55zWfMzTxQ3R1oezcqwwl629cWBpgXBRYc3s T68wUE7BJikhVXEsoYdHk6Ig1rNGhz1T2XBUSWB1hYX/jwA5d2Wo2PojXijdeg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1765295892; a=rsa-sha256; cv=none; b=XQ16sRR7BsnZKkjBuDjmyb9rzIwgI5QEETJOjDjnlADBOLXsrPFqQpb8ZtB7p9XJFlJyjO 93TO7WNb66/k3dxyjd8ZmDkVmSJQ4noxEDecPtV4+qxDaaw3DLMd0K8WkFlMkSFZBy0/49 RGvbwm4+fvdvTPv2ubXFPnQrerXC9DZa2V26OvJrY07ew5rkMZcyL6dWJ/k3nk7xBHV/bW IEQUsQ7o+3mdaGCOHzDtbKHD6QaQzPNXibnX+yabeFF+nIiJ360ewwa+TqWqAQyfiexHcK 3uKFG1nM0ys/ZyY7uWWCrZaFgeiSGOKKqEpYetyvjtwpQk+GomuFW2XSYVRqbA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4dQk5w57hxz14q4 for ; Tue, 09 Dec 2025 15:58:12 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 35ba6 by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Tue, 09 Dec 2025 15:58:12 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: John Baldwin Subject: git: e2b8be511e90 - main - nvmf_che: Add a manual page for the Chelsio NVMe/TCP PDU offload driver List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jhb X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e2b8be511e9064de29a847e7c1cfc9200e69394b Auto-Submitted: auto-generated Date: Tue, 09 Dec 2025 15:58:12 +0000 Message-Id: <69384714.35ba6.6608b41c@gitrepo.freebsd.org> The branch main has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=e2b8be511e9064de29a847e7c1cfc9200e69394b commit e2b8be511e9064de29a847e7c1cfc9200e69394b Author: John Baldwin AuthorDate: 2025-12-09 15:57:44 +0000 Commit: John Baldwin CommitDate: 2025-12-09 15:57:44 +0000 nvmf_che: Add a manual page for the Chelsio NVMe/TCP PDU offload driver Sponsored by: Chelsio Communications Differential Revision: https://reviews.freebsd.org/D53764 --- share/man/man4/Makefile | 1 + share/man/man4/nvmf_che.4 | 80 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+) diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 722ee2bc9334..4084fa55dc69 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -442,6 +442,7 @@ MAN= aac.4 \ ${_nvdimm.4} \ nvme.4 \ nvmf.4 \ + nvmf_che.4 \ nvmf_tcp.4 \ nvmft.4 \ ${_nvram.4} \ diff --git a/share/man/man4/nvmf_che.4 b/share/man/man4/nvmf_che.4 new file mode 100644 index 000000000000..8960cda9c506 --- /dev/null +++ b/share/man/man4/nvmf_che.4 @@ -0,0 +1,80 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2025 Chelsio Communications, Inc. +.\" +.Dd November 14, 2025 +.Dt NVMF_CHE 4 +.Os +.Sh NAME +.Nm nvmf_che +.Nd TCP transport for NVM Express over Fabrics on Chelsio NICs +.Sh SYNOPSIS +In +.Xr loader.conf 5 : +.Bd -literal -offset indent +nvmf_che_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +module implements the a TCP/IP transport for NVM Express over Fabrics +using PDU offload on Chelsio T7 adapters. +It can be used by either the in-kernel NVMeoF host driver or controller. +In order to use PDU offload, +the initial socket connection must be using the TCP offload engine (TOE) +on a supported network interface. +In addition, +controller connections must negotiate a suitable +.Dv MAXH2CDATA +limit to ensure that received PDUs do not exceeed the maximum size +supported by the adapter. +.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.che.max_transmit_pdu +The maximum size of a transmitted PDU including all headers, payload, +and checksums. +This is an upper limit enforced when queues are created. +Individual adapters may empose a smaller limit. +The default size is 32 kilobytes. +.It Va kern.nvmf.che.max_receive_pdu +As above, but for received PDUs. +.It Va kern.nvmf.che.use_dsgl +Enable the use of a S/G list for large writes into adapter memory when +writing control structures for DDP (not used for PDU payload data). +S/G lists are enabled by default. +.It Va kern.nvmf.che.inline_threshold +Writes of control structures into adapter memory use a S/G list instead +of immediate data placed in work requests. +The default threshold is 256 bytes. +.It Va kern.nvmf.che.ddp_tags_per_qp +The number of STAGs reserved for use by DDP buffers for each queue pair. +Each command sent on a queue that requests data from the remote peer can +use DDP to place received data directly into the associated data buffer. +Each buffer requires a STAG to enable DDP. +If an STAG is not available when command requesting remote data is sent, +the data will be received in free list buffers and copied into the data +buffer by the driver instead. +The default size is 256 kilobytes. +.El +.Sh SEE ALSO +.Xr cxgbe 4 , +.Xr nvmf 4 , +.Xr nvmf_tcp 4 , +.Xr nvmft 4 +.Sh HISTORY +The +.Nm +module first appeared in +.Fx 16.0 . +.Sh AUTHORS +The +.Nm +module was developed by +.An John Baldwin Aq Mt jhb@FreeBSD.org +under sponsorship from Chelsio Communications, Inc.