Add demo-irq doc

708189b9 · Jorge Machado · 0d746603 · 708189b9
Commit 708189b9 authored Sep 18, 2020 by Jorge Machado
Hide whitespace changes
Inline Side-by-side

Showing with 32 additions and 0 deletions

fmc-dio.in doc/fmc-dio.in +32 -0

No files found.
--- a/doc/fmc-dio.in
+++ b/doc/fmc-dio.in
@@ -785,6 +785,38 @@ with a delay of 1ms. The input events in this case are from a @i{pulse-per-secon
   ch 4,       388.001000000
 @end smallexample

+@c ##########################################################################
+@node Interrupt Demo
+@chapter Interrupt Demo
+
+The interrupt demo software can be found in the root directoy of the wr-starting-kit 
+repository. 
+This demo sofware disables the interrupts of all channel except the new one, only 
+dedicated to interrupts. 
+By default, it setups the interrupt with 100 milliseconds between them.
+
+The tool provides the total number of interrupts, the interrupts per second and 
+some statistic information calculated with the difference between OS time and 
+WR time.
+
+This is the general syntax of the command:
+
+@table @code
+
+@item demo-irq <dio-device> [<period in ns>]
+
+@end table
+
+Example uses of the tool follow:
+
+@example
+   # Generate one interrupt each 100 ms
+   demo-irq /dev/fmc-dio-1:0
+
+   # Generate one interrupt each 10 ms
+   demo-irq /dev/fmc-dio-1:0 10000000
+@end example
+
 @c ##########################################################################
 @node Bugs and Missing Features
 @chapter Bugs and Missing Features