From: Logan Gunthorpe <logang@deltatee.com>
To: linux-kernel@vger.kernel.org, linux-ntb@googlegroups.com,
linux-pci@vger.kernel.org, iommu@lists.linux-foundation.org,
linux-kselftest@vger.kernel.org, Jon Mason <jdmason@kudzu.us>,
Joerg Roedel <joro@8bytes.org>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
Allen Hubbe <allenbh@gmail.com>,
Dave Jiang <dave.jiang@intel.com>,
Serge Semin <fancer.lancer@gmail.com>,
Eric Pilmore <epilmore@gigaio.com>,
Logan Gunthorpe <logang@deltatee.com>
Subject: [PATCH v5 10/10] NTB: Describe the ntb_msi_test client in the documentation.
Date: Thu, 23 May 2019 16:31:00 -0600 [thread overview]
Message-ID: <20190523223100.5526-11-logang@deltatee.com> (raw)
In-Reply-To: <20190523223100.5526-1-logang@deltatee.com>
Add a blurb in Documentation/ntb.txt to describe the ntb_msi_test tool's
debugfs interface. Similar to the (out of date) ntb_tool description.
Signed-off-by: Logan Gunthorpe <logang@deltatee.com>
---
Documentation/ntb.txt | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/Documentation/ntb.txt b/Documentation/ntb.txt
index a043854d28df..802a539f1592 100644
--- a/Documentation/ntb.txt
+++ b/Documentation/ntb.txt
@@ -194,6 +194,33 @@ Debugfs Files:
This file is used to read and write peer scratchpads. See
*spad* for details.
+NTB MSI Test Client (ntb\_msi\_test)
+------------------------------------
+
+The MSI test client serves to test and debug the MSI library which
+allows for passing MSI interrupts across NTB memory windows. The
+test client is interacted with through the debugfs filesystem:
+
+* *debugfs*/ntb\_tool/*hw*/
+ A directory in debugfs will be created for each
+ NTB device probed by the tool. This directory is shortened to *hw*
+ below.
+* *hw*/port
+ This file describes the local port number
+* *hw*/irq*_occurrences
+ One occurrences file exists for each interrupt and, when read,
+ returns the number of times the interrupt has been triggered.
+* *hw*/peer*/port
+ This file describes the port number for each peer
+* *hw*/peer*/count
+ This file describes the number of interrupts that can be
+ triggered on each peer
+* *hw*/peer*/trigger
+ Writing an interrupt number (any number less than the value
+ specified in count) will trigger the interrupt on the
+ specified peer. That peer's interrupt's occurrence file
+ should be incremented.
+
NTB Hardware Drivers
====================
--
2.20.1
next prev parent reply other threads:[~2019-05-23 22:31 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-23 22:30 [PATCH v5 00/10] Support using MSI interrupts in ntb_transport Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 01/10] PCI/MSI: Support allocating virtual MSI interrupts Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 02/10] PCI/switchtec: Add module parameter to request more interrupts Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 03/10] NTB: Introduce helper functions to calculate logical port number Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 04/10] NTB: Introduce functions to calculate multi-port resource index Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 05/10] NTB: Rename ntb.c to support multiple source files in the module Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 06/10] NTB: Introduce MSI library Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 07/10] NTB: Introduce NTB MSI Test Client Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 08/10] NTB: Add ntb_msi_test support to ntb_test Logan Gunthorpe
2019-05-23 22:30 ` [PATCH v5 09/10] NTB: Add MSI interrupt support to ntb_transport Logan Gunthorpe
2019-05-23 22:31 ` Logan Gunthorpe [this message]
2019-06-13 13:30 ` [PATCH v5 00/10] Support using MSI interrupts in ntb_transport Jon Mason
2019-06-13 15:46 ` Logan Gunthorpe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190523223100.5526-11-logang@deltatee.com \
--to=logang@deltatee.com \
--cc=allenbh@gmail.com \
--cc=bhelgaas@google.com \
--cc=dave.jiang@intel.com \
--cc=epilmore@gigaio.com \
--cc=fancer.lancer@gmail.com \
--cc=iommu@lists.linux-foundation.org \
--cc=jdmason@kudzu.us \
--cc=joro@8bytes.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=linux-ntb@googlegroups.com \
--cc=linux-pci@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).