Skip to content

Commit d9c53aa

Browse files
lsgunthjonmason
authored andcommitted
NTB: Describe the ntb_msi_test client in the documentation.
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 <[email protected]> Signed-off-by: Jon Mason <[email protected]>
1 parent 2b0569b commit d9c53aa

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

Documentation/ntb.txt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,33 @@ Debugfs Files:
200200
This file is used to read and write peer scratchpads. See
201201
*spad* for details.
202202

203+
NTB MSI Test Client (ntb\_msi\_test)
204+
------------------------------------
205+
206+
The MSI test client serves to test and debug the MSI library which
207+
allows for passing MSI interrupts across NTB memory windows. The
208+
test client is interacted with through the debugfs filesystem:
209+
210+
* *debugfs*/ntb\_tool/*hw*/
211+
A directory in debugfs will be created for each
212+
NTB device probed by the tool. This directory is shortened to *hw*
213+
below.
214+
* *hw*/port
215+
This file describes the local port number
216+
* *hw*/irq*_occurrences
217+
One occurrences file exists for each interrupt and, when read,
218+
returns the number of times the interrupt has been triggered.
219+
* *hw*/peer*/port
220+
This file describes the port number for each peer
221+
* *hw*/peer*/count
222+
This file describes the number of interrupts that can be
223+
triggered on each peer
224+
* *hw*/peer*/trigger
225+
Writing an interrupt number (any number less than the value
226+
specified in count) will trigger the interrupt on the
227+
specified peer. That peer's interrupt's occurrence file
228+
should be incremented.
229+
203230
NTB Hardware Drivers
204231
====================
205232

0 commit comments

Comments
 (0)