git: 8225ed665eea - main - ix.4: Document E610 debug dump

From: Alexander Ziaee <ziaee_at_FreeBSD.org>
Date: Wed, 12 Nov 2025 13:40:33 UTC
The branch main has been updated by ziaee:

URL: https://cgit.FreeBSD.org/src/commit/?id=8225ed665eea69b3df3ea57009cf8fe61863c1fc

commit 8225ed665eea69b3df3ea57009cf8fe61863c1fc
Author:     Yogesh Bhosale <yogesh.bhosale@intel.com>
AuthorDate: 2025-11-10 18:03:54 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-11-12 13:38:41 +0000

    ix.4: Document E610 debug dump
    
    Explain how to collect E610 device debug dump data with sysctl for
    troubleshooting with Intel Customer Support.
    
    Fixes:                  2170400142b9 (Add support for debug dump)
    Reviewed by:            bcr, erj (previous version), ziaee
    Signed-off-by:          Yogesh Bhosale <yogesh.bhosale@intel.com>
    Differential Revision:  https://reviews.freebsd.org/D52990
---
 share/man/man4/ix.4 | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/share/man/man4/ix.4 b/share/man/man4/ix.4
index e6f4276e1a77..09af85f5c4a7 100644
--- a/share/man/man4/ix.4
+++ b/share/man/man4/ix.4
@@ -132,6 +132,35 @@ Enable Adaptive Interrupt Moderation (AIM).
 Vary the interrupt rate over time based on the traffic for
 that interrupt vector.
 .El
+.Sh SYSCTL VARIABLES
+The
+.Nm
+driver supports the following
+.Xr sysctl 8
+variables:
+.Bl -tag -width "dev.ix.?.debug.dump.clusters"
+.It Va dev.ix.?.debug.dump.clusters
+Specify a bitmask to select firmware event clusters
+to be included in the debug dump.
+Possible values include:
+.Pp
+.Bl -tag -compact
+.It 0
+All clusters excluding Manageability Transactions
+.It 0x1
+Link cluster
+.It 0x2
+Full CSR Space excluding RCW registers
+.El
+.Pp
+This feature is only supported on E610 devices.
+.It Va dev.ix.?.debug.dump.dump
+Specify 1 to generate a per-device debugging snapshot.
+Output must be redirected to a file
+and decoded by Intel Customer Support.
+.Pp
+This feature is only supported on E610.
+.El
 .Sh DIAGNOSTICS
 .Bl -diag
 .It "ix%d: Unable to allocate bus resource: memory"