From nobody Mon Sep 21 16:14:13 2026 X-Original-To: dev-commits-src-main@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 4hpSwQ0Rmnz6sqNr for ; Mon, 21 Sep 2026 16:14:14 +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 "YR2" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4hpSwQ017xz4lGQ for ; Mon, 21 Sep 2026 16:14:14 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1790007254; 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=c82lHP5lzBXjnme0BhWzPHgY+U/D2WmbuaCPXCxYn5c=; b=JYKCPnzEc2i/25UKgSAxqpGItv0oDw/PL2gC+KrGp8wfJrLxRrrE8s59q8/7ozf5e012yQ EcDKBina3qR0UVqF1QS2bvyY1AoVsxTudIBiWUMAmU/SbrjwisSOhIJ2lnLdA9niKb7eX3 Qcm2zhNLcwDhPFETkBbIrDSFvaDSjeMKSQZp1y5lSCWCxrYt7FqfmxK27ovlnriiAX4EUK Uo27OexnaD13vO0KNOXKDaKykXVFYhrxLl4yN5VDQW5n9GwV6IzVSKUJBAWgJidIOpbczX 7j5v3XHFXHbNA8XwErJCiAUUGTDiW7yzps/gu25S0XqeyINPQkvMVeLhP5Vy8w== ARC-Seal: i=1; a=rsa-sha256; d=freebsd.org; s=dkim; cv=none; t=1790007254; b=kaFQsoSCvaHmFEg9MLDg7o0tw5sI4mD/w5xk0PqJunq65ac70cXnzN4/UnwpmR9qeA77nR dtuV8lOP4O0ORysayj3RZt9K7SICs47Uq+Gmpdf7HzU1B2C82B1ZFuhvznLmEhnv19EwJO nDSJGImtubp/eL9C3zgXLsG/PiDdwRgQS/6x40YvxDyXiUDbtZc0Da7r1km4tI/hr3dlJw PxEksV3dAHD8/ax8bT/DVUNL+oUcPeduPvS5nJyfbKMZnZwwF9sL8IlrGDvKLZLnn+O0n2 Ftljs0mRO+MWw+MWQeEYByOue87GmErdh7Qn7UkDnooOIuNVqif61WwVK0z7fQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1790007254; 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=c82lHP5lzBXjnme0BhWzPHgY+U/D2WmbuaCPXCxYn5c=; b=a90pGHl01VxJTCZZveawxKZREVakVUK5q1gGwXCVbldWSNdTsh+kv3yaQZai7SEahhEQu9 QxW2YQoZKK9YdZdtJG2UxScPBFwKAqoRHna3QI+S9eJkc/dRbIy967zlmE2Z0I3D/KACiI 1NazSNBegSFKODMaAtYbKyPzv0pwPKBlTofAo1boEa3DabmGyYyGgyHXYIbErMRzBjL22f EBJ4tWu72ARZ24nd8XosZoPwzqMDuuoglqinut16wxOmlMtkr4DMgjLq9xBCGIJcaPjvJu A+KOjF4c3iwpkgqPeaL2FPmLRrBmoWssdm3LWnd1fA00W5cRjE2izGziybYCIg== 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 4hpSwP5tg2zRqB for ; Mon, 21 Sep 2026 16:14:13 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 3780c by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Mon, 21 Sep 2026 16:14:13 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Alexander Ziaee Subject: git: 0a81077f432d - main - ufshci.4: Canonicalize SYNOPSIS, LOADER TUNABLES List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 0a81077f432d74dd2d064fb5f2b1b2a546be5347 Auto-Submitted: auto-generated Date: Mon, 21 Sep 2026 16:14:13 +0000 Message-Id: <6ab157d5.3780c.28251038@gitrepo.freebsd.org> The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=0a81077f432d74dd2d064fb5f2b1b2a546be5347 commit 0a81077f432d74dd2d064fb5f2b1b2a546be5347 Author: Alexander Ziaee AuthorDate: 2026-09-21 16:06:59 +0000 Commit: Alexander Ziaee CommitDate: 2026-09-21 16:13:42 +0000 ufshci.4: Canonicalize SYNOPSIS, LOADER TUNABLES + Update SYNOPSIS to the new standard format + Rename CONFIGURATION to the usual LOADER TUNABLES + Adjust tunable markup for inclusion in the search index + Editorial nit: Unwind a parenthetical MFC after: 3 days --- share/man/man4/ufshci.4 | 46 ++++++++++++++++++---------------------------- 1 file changed, 18 insertions(+), 28 deletions(-) diff --git a/share/man/man4/ufshci.4 b/share/man/man4/ufshci.4 index f9de9b39a449..47992440134f 100644 --- a/share/man/man4/ufshci.4 +++ b/share/man/man4/ufshci.4 @@ -14,17 +14,11 @@ .Nm ufshci .Nd Universal Flash Storage Host Controller Interface driver .Sh SYNOPSIS -To compile this driver into the kernel, -place the following line in the kernel configuration file: -.Bd -ragged -offset indent -.Cd "device ufshci" -.Ed +.Cd device ufshci .Pp -Or, to load the driver as a module at boot, place the following line in +In .Xr loader.conf 5 : -.Bd -literal -offset indent -ufshci_load="YES" -.Ed +.Cd ufshci_load="YES" .Sh DESCRIPTION Universal Flash Storage (UFS) is a low-power, high-performance storage standard composed of a host controller and a single target device. @@ -58,7 +52,7 @@ The .Nm driver supports both host controllers and devices implementing the Universal Flash Storage Host Controller Interface 4.1 and earlier. -.Sh CONFIGURATION +.Sh LOADER TUNABLES The .Nm driver currently operates with a single doorbell (one I/O-queue), so any @@ -68,37 +62,33 @@ become available, the following queue count tunable values will take effect: .Pp To force a single I/O queue pair shared by all CPUs, set the following tunable value in loader.conf(5): -.Bd -literal -offset indent -hw.ufshci.per_cpu_io_queues=0 -.Ed +.Pp +.Dl Va hw.ufshci.per_cpu_io_queues=0 .Pp To assign more than one CPU per I/O queue pair, thereby reducing the number of MSI-X vectors consumed by the device, set the following tunable value in loader.conf(5): -.Bd -literal -offset indent -hw.ufshci.min_cpus_per_ioq=X -.Ed +.Pp +.Dl Va hw.ufshci.min_cpus_per_ioq=X .Pp To change the I/O command timeout value (in seconds), set the following tunable value in loader.conf(5): -.Bd -literal -offset indent -hw.ufshci.timeout_period=X -.Ed +.Pp +.Dl Va hw.ufshci.timeout_period=X .Pp To change the I/O command retry count, set the following tunable value in loader.conf(5): -.Bd -literal -offset indent -hw.ufshci.retry_count=X -.Ed +.Pp +.Dl Va hw.ufshci.retry_count=X .Pp To force the driver to use legacy INTx interrupts, set the following tunable value in loader.conf(5): -.br -(Note: until MCQ support is available the driver always uses legacy INTx, so -this value effectively remains 1) -.Bd -literal -offset indent -hw.ufshci.force_intx=1 -.Ed +.Pp +.Dl Va hw.ufshci.force_intx=1 +.Pp +.Sy Note: +until MCQ support is available the driver always uses legacy INTx, +so this value effectively remains 1. .Sh SYSCTL VARIABLES The following controller-level .Xr sysctl 8