summaryrefslogtreecommitdiffstats
path: root/README-DEVELOPERS.lyx
diff options
context:
space:
mode:
authorMichael Buesch <mb@bu3sch.de>2011-01-08 22:50:07 +0100
committerMichael Buesch <mb@bu3sch.de>2011-01-08 22:50:07 +0100
commitd52ba369193baed9abd135d0afbd69be84841c85 (patch)
treec951fed31410531beb79d7fb92cb3b071b98acef /README-DEVELOPERS.lyx
parent2db507b4eccbd4fad34e156a5a72ace417a9af17 (diff)
downloadtoprammer-d52ba369193baed9abd135d0afbd69be84841c85.tar.xz
toprammer-d52ba369193baed9abd135d0afbd69be84841c85.zip
Rewrite delay mechanisms
Signed-off-by: Michael Buesch <mb@bu3sch.de>
Diffstat (limited to 'README-DEVELOPERS.lyx')
-rw-r--r--README-DEVELOPERS.lyx20
1 files changed, 12 insertions, 8 deletions
diff --git a/README-DEVELOPERS.lyx b/README-DEVELOPERS.lyx
index bf54bc8..525117d 100644
--- a/README-DEVELOPERS.lyx
+++ b/README-DEVELOPERS.lyx
@@ -299,18 +299,21 @@ This is a shortcut to cmdFPGAReadRaw(0x10).
\end_layout
\begin_layout Subsection
-cmdFlush()
+cmdDelay(seconds)
\end_layout
\begin_layout Standard
-Is believed to be kind of a flush command.
- However, there also are suspections that it has certain delay semantics,
- too.
- You usually don't have to call this directly.
+Send a delay command to the programmer.
+ The Programmer will perform the delay.
+ A value up to 0.5 seconds is possible.
+ Note that the actual value will be rounded up to the next possible wait
+ interval value.
+ Use this for short (microsecond or low millisecond) delays.
+ Note that this does _not_ flush the command queue.
\end_layout
\begin_layout Subsection
-delay(seconds)
+hostDelay(seconds)
\end_layout
\begin_layout Standard
@@ -332,6 +335,8 @@ seconds
\end_inset
is a floating point number.
+ The delay is performed on the host computer by simply not sending commands
+ to the programmer for the time specified after flushing the command queue.
\end_layout
\begin_layout Section
@@ -363,8 +368,7 @@ class TOP
\end_inset
.
- Note that this is not to be confused with cmdFlush(), which does some flushing
- tasks inside of the microcontroller.
+
\end_layout
\begin_layout Itemize
bues.ch cgit interface