Update doc

d37816b8 · Jorge Machado · 38edf888 · d37816b8
Commit d37816b8 authored Oct 05, 2020 by Jorge Machado
Hide whitespace changes
Inline Side-by-side

Showing with 22 additions and 3 deletions

fmc-dio.in doc/fmc-dio.in +22 -3

No files found.
--- a/doc/fmc-dio.in
+++ b/doc/fmc-dio.in
@@ -151,8 +151,26 @@ There is no need to explicitly initialize the FMC-DIO driver.
 @node Interrupts in fmc-dio.ko
 @section Interrupts in fmc-dio.ko

-There is only one interrupt to control the number of pulses that has been generated.
+There are two types of interrupts: 

+@table @file
+
+        @item I/O channel interrupt
+
+                This interrupt is generated when one channel generates an 
+                output pulse or detects an input pulse. The timestamp of the 
+                pulse is stored into the timestamp FIFO queue of the channel.
+        
+        @item Dedicated interrupt channel
+
+                This interrupt is generated only when the interrupt channel
+                is triggered. The timestamp of the interrupt is stored into 
+                the interrupt timestamp FIFO.
+
+@end table
+
+Both interrupt types comes from an unique HW interrupt. The software interrupt 
+handler manages both types.
 @c ==========================================================================
 @node Code Layout
 @section Code Layout
@@ -436,8 +454,9 @@ The current version of the tool supports the following commands:
        (@code{+<seconds>.<fraction>}). In the last case, the current second 
        is added to @code{<seconds>} while the fraction is used unchanged. 
        The @code{+} form is useful for simple checks with visual inspection.  
-        The @code{period} parameter, if specified, requests for a interrupt train, with the 
-        specified time period between interrupts; the @code{count} parameter is the number 
+        The @code{period} parameter, if specified, requests for a interrupt train, 
+        with the specified time period between interrupts. It must be specified in 
+        a range between 1ms and 2s; the @code{count} parameter is the number 
        of times to run interrupt generation (-1 means forever, 0 means ``stop ongoing interrupt generation'').

 @item mode <channel> <mode> [<channel> <mode> ...]