Merge tag 'ntb-5.3' of git://github.com/jonmason/ntb

[linux-2.6-microblaze.git] / Documentation / driver-api / ntb.rst

diff --git a/Documentation/driver-api/ntb.rst b/Documentation/driver-api/ntb.rst
index 074a423..87d1372 100644 (file)
--- a/Documentation/driver-api/ntb.rst
+++ b/Documentation/driver-api/ntb.rst
@@ -200,6 +200,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
 ====================