Page MenuHomeFreeBSD
Differential D52990

ix(4): Document E610 hardware and debug dump feature
Needs ReviewPublic
Actions

Authored by Yogesh.Bhosale_intel.com on Oct 9 2025, 10:16 AM.
Tags
None
Referenced Files
F135594792: D52990.id164380.diff
Tue, Nov 11, 3:43 AM
Unknown Object (File)
Sat, Nov 8, 10:10 PM
Unknown Object (File)
Wed, Nov 5, 1:39 AM
Unknown Object (File)
Thu, Oct 30, 2:44 AM
Unknown Object (File)
Thu, Oct 23, 12:30 PM
Unknown Object (File)
Thu, Oct 23, 1:36 AM
Unknown Object (File)
Fri, Oct 17, 10:19 PM
Unknown Object (File)
Fri, Oct 17, 6:31 PM
View All 21 Files
Subscribers
ae
andrew_tao173.riddles.org.uk
asomers
bcr
bcran
bdrewery
dab
View All 26 Subscribers

Details

Reviewers
erj
ziaee
bcr
Group Reviewers
Intel Networking
manpages
Restricted Owners Package(Owns No Changed Paths)
Commits
rGabd53b16c03f: ix.4: Add E610 to HARDWARE section
Summary

This update adds Intel E610 Ethernet Controller devices to the ix(4) manual
page hardware list and documents the debug dump feature.

Hardware section changes:

  • Add E610 family devices to the supported hardware list

Debug dump documentation:

  • Explains how to use sysctl commands to collect device data for troubleshooting
  • Lists the available options for selecting data clusters
  • Notes that the output is not readable without help from Customer Support
  • Feature is specific to E610 devices

Signed-off-by: Yogesh Bhosale yogesh.bhosale@intel.com

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
No Test Coverage
Build Status
Buildable 67856
Build 64739: arc lint + arc unit

Event Timeline

Yogesh.Bhosale_intel.com created this revision.Oct 9 2025, 10:16 AM
Herald added subscribers: ziaee, imp. · View Herald TranscriptOct 9 2025, 10:16 AM
Yogesh.Bhosale_intel.com requested review of this revision.Oct 9 2025, 10:16 AM
Harbormaster completed remote builds in B67659: Diff 163806.Oct 9 2025, 10:16 AM
Yogesh.Bhosale_intel.com mentioned this in D50934: ix(4): Add support for debug dump for E610 adapters.Oct 9 2025, 11:01 AM
ziaee added reviewers: Intel Networking, manpages.Oct 9 2025, 12:35 PM

Thanks for this! Wow cool, 2x10G @ 5w!

share/man/man4/ix.4
79–98

Keep this list sorted reverse chronologically.

135

Roff shouldn't have blank lines (check the linter with mandoc -Tlint share/man/man4/ix.4), if you really want to do this, you can use an empty comment with .\". Ditto for the others.

169–172

We want sysctl nodes to be marked up with Va that way people can search the manual for them, e.g. apropos Va=debug.dump.clusters. Ditto for the others.

erj accepted this revision as: erj.Oct 9 2025, 4:20 PM
This revision is now accepted and ready to land.Oct 9 2025, 4:20 PM
erj added a comment.Oct 9 2025, 4:21 PM

(approval for the functionality; you should make @ziaee's suggested changes to the documentation)

bcr added a subscriber: bcr.Oct 9 2025, 5:57 PM

Thanks for the documentation. I made some suggestion on language improvements.

share/man/man4/ix.4
139

We try to avoid the use of "you" in the documentation.
You can rephrase the sentence like this:

Intel(R) E610 Ethernet Controller devices support debug dump, which allows obtaining runtime register ...

152

Rephrase to avoi "you" in here like this (suggestions):

"Work with customer support ..."

or

"Contact customer support ..."

209

Avoiding "you":
When a cluster is not specified, the driver will ...

222

Avoiding "you":
Setting the sysctl to 1 will make the driver not receive the command.

226

... with the desired file name.

228

Avoiding "you":
If no clusters were specified, the dump file will ...

Yogesh.Bhosale_intel.com updated this revision to Diff 164380.Fri, Oct 17, 8:46 AM
Yogesh.Bhosale_intel.com marked 9 inline comments as done.

ix(4): Document E610 hardware and debug dump feature

This update adds Intel E610 Ethernet Controller devices to the ix(4) manual
page hardware list and documents the debug dump feature.

Hardware section changes:

Add E610 family devices to the supported hardware list
Debug dump documentation:

Explains how to use sysctl commands to collect device data for troubleshooting
Lists the available options for selecting data clusters
Notes that the output is not readable without help from Customer Support
Feature is specific to E610 devices
Signed-off-by: Yogesh Bhosale yogesh.bhosale@intel.com

This revision now requires review to proceed.Fri, Oct 17, 8:46 AM
Owners added a reviewer: Restricted Owners Package.Fri, Oct 17, 8:46 AM
Herald added a reviewer: andrew. · View Herald TranscriptFri, Oct 17, 8:46 AM
Herald added a reviewer: andrew. · View Herald Transcript
Herald added a reviewer: jilles. · View Herald Transcript
Herald added a reviewer: slm. · View Herald Transcript
Herald added a reviewer: shurd. · View Herald Transcript
Herald added a reviewer: manu. · View Herald Transcript
Herald added a reviewer: manu. · View Herald Transcript
Herald added a reviewer: cy. · View Herald Transcript
Herald added a reviewer: manu. · View Herald Transcript
Herald added a reviewer: melifaro. · View Herald Transcript
Herald added a reviewer: melifaro. · View Herald Transcript
Herald added a reviewer: olce. · View Herald Transcript
Herald added a reviewer: transport. · View Herald Transcript
Herald added a reviewer: bhyve. · View Herald Transcript
Herald added a reviewer: iflib. · View Herald Transcript
Herald added a reviewer: cam. · View Herald Transcript
Herald added subscribers: riscv, linuxkpi, ivy and 19 others. · View Herald Transcript
Harbormaster completed remote builds in B67855: Diff 164380.Fri, Oct 17, 8:46 AM
Yogesh.Bhosale_intel.com updated this revision to Diff 164381.Fri, Oct 17, 8:50 AM

ix(4): Document E610 hardware and debug dump feature

This update adds Intel E610 Ethernet Controller devices to the ix(4) manual
page hardware list and documents the debug dump feature.

Hardware section changes:

Add E610 family devices to the supported hardware list
Debug dump documentation:

Explains how to use sysctl commands to collect device data for troubleshooting
Lists the available options for selecting data clusters
Notes that the output is not readable without help from Customer Support
Feature is specific to E610 devices
Signed-off-by: Yogesh Bhosale yogesh.bhosale@intel.com

Harbormaster completed remote builds in B67856: Diff 164381.Fri, Oct 17, 8:50 AM
Yogesh.Bhosale_intel.com added a comment.Fri, Oct 17, 8:50 AM

@ziaee @bcr

Thanks for reviewing the changes. I have addressed your comments.

Yogesh.Bhosale_intel.com added a comment.Fri, Oct 17, 8:52 AM

My last commit accidentally picked up a lot of files. Please ignore it. I have fixed this in the current one.

kgalazka edited reviewers, added: ziaee, bcr; removed: andrew, jilles, slm, shurd, manu, cy, melifaro, olce, transport, bhyve, iflib, cam.Fri, Oct 24, 8:13 PM
kgalazka added a subscriber: kgalazka.

Fix reviewers list.

ehem_freebsd_m5p.com removed a subscriber: ehem_freebsd_m5p.com.Tue, Oct 28, 12:15 AM
Yogesh.Bhosale_intel.com added a comment.Tue, Nov 4, 4:25 AM

@ziaee @bcr
I have addressed your review comments. I would appreciate it if you could take another look and approve if it looks good.

Yogesh.Bhosale_intel.com added a comment.Mon, Nov 10, 5:38 AM
In D52990#1223023, @Yogesh.Bhosale_intel.com wrote:

@ziaee @bcr
I have addressed your review comments. I would appreciate it if you could take another look and approve if it looks good.

Just a gentle reminder about this.

This revision was not accepted when it landed; it landed in state Needs Review.Mon, Nov 10, 8:07 PM
Closed by commit rGabd53b16c03f: ix.4: Add E610 to HARDWARE section (authored by Yogesh.Bhosale_intel.com, committed by ziaee). · Explain Why
This revision was automatically updated to reflect the committed changes.
ziaee added a commit: rGabd53b16c03f: ix.4: Add E610 to HARDWARE section.
ziaee reopened this revision.Mon, Nov 10, 8:10 PM
ziaee added a subscriber: kbowling.

I split this into two commits because E610 support is apppearing in FreeBSD 15 and must be documented there, but debug dump has not been mfc'ed yet.

share/man/man4/ix.4
152

Roff requires one sentence per line (newline after period). You can check the linter with mandoc -T lint /here/is/ice.4.

ziaee added inline comments.Mon, Nov 10, 9:05 PM
share/man/man4/ix.4
134–242

Sorry phabricator was unable to cope with splitting the commits. What if we wrote the debug dump section more traditionally for the FreeBSD system manual, like this?

Yogesh.Bhosale_intel.com updated this revision to Diff 166196.Tue, Nov 11, 6:51 AM
Yogesh.Bhosale_intel.com marked an inline comment as done.

ix(4): Document E610 hardware and debug dump feature

Added Intel E610 Ethernet Controller to the supported hardware list
and documented the debug dump functionality in the SYSCTL VARIABLES
section. The debug dump feature allows collecting device data for
troubleshooting using sysctl commands.

Signed-off-by: Yogesh Bhosale <yogesh.bhosale@intel.com>

Harbormaster completed remote builds in B68535: Diff 166196.Tue, Nov 11, 6:51 AM
Yogesh.Bhosale_intel.com marked an inline comment as done.Tue, Nov 11, 6:54 AM

@ziaee
I have updated to follow traditional FreeBSD manual style as suggested - please review.

ziaee added a comment.Tue, Nov 11, 1:56 PM

Thanks Yogesh! I have some editorial suggestions to hopefully improve the clarity, if these are okay with you, just say so, and I will commit this with them applied.

share/man/man4/ix.4
135

I really recommend not using these. It just wastes lines, and is usually a sign of structure errors in the manual. If you want something to grep for to find the beginning and end of sections, you can use "Sh".

144
  1. "Specify a bitmask" because the sysctl is not the bitmask, the sysctl accepts a bitmask. This matches what we generally do elsewhere.
  2. Saying "to be included in" makes it clear that when you debug dump, this is the setting that will be included. "For" is less specific and makes it a bit harder if the reader doesn't already know what they're looking at.
149

Anytime you can write a statement without parenthesis, that's usually much clearer. Parenthesis are like adding a sub statement in the brain, changing a simple 2d sentence to require a 3d space.

153

Ditto for above

158

"Specify" is just for consistency with above to make it look nice.

This looses "per-device", as opposed to per-VF, which in the previous draft you were extremely specific about, I think you want that?

163

Ditto for above

Revision Contents
Changeset List

PathSize
share/
man/
man4/
110 lines

Diff 164381

View Options

share/man/man4/ix.4

Loading...