Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d9c53aa4 authored by Logan Gunthorpe's avatar Logan Gunthorpe Committed by Jon Mason
Browse files

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: default avatarLogan Gunthorpe <logang@deltatee.com>
Signed-off-by: default avatarJon Mason <jdmason@kudzu.us>
parent 2b0569b3

Documentation/ntb.txt

+27 −0
Original line number Diff line number Diff line
@@ -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

====================