summaryrefslogtreecommitdiffhomepage
path: root/digital/io/src/gutter.h
diff options
context:
space:
mode:
authorJérémy Dufour2008-04-23 13:31:14 +0200
committerJérémy Dufour2008-04-23 13:31:14 +0200
commitb37be4dc387ff573c5d6baca14472a56c682c537 (patch)
tree46914d3a7680e9b8a428bd8b7e7fac4ba79c8238 /digital/io/src/gutter.h
parent3e87ad74d0dabecee698f3acefa6f38b159484c3 (diff)
* digital/io/src
- integrate gutter FSM into the main loop.
Diffstat (limited to 'digital/io/src/gutter.h')
-rw-r--r--digital/io/src/gutter.h17
1 files changed, 16 insertions, 1 deletions
diff --git a/digital/io/src/gutter.h b/digital/io/src/gutter.h
index 32d0b226..c84a9e40 100644
--- a/digital/io/src/gutter.h
+++ b/digital/io/src/gutter.h
@@ -25,8 +25,23 @@
*
* }}} */
-/* gutter start */
+/**
+ * Start the gutter FSM.
+ */
void
gutter_start (void);
+/**
+ * Do we need to generate a wait_finished event?
+ * You need to call this function in the main loop in order to ensure we
+ * generate a wait_finished event when the gutter FSM need one.
+ * The purpose is to let the gutter FSM wait a specific number of cycle it
+ * wants.
+ * @return
+ * - 0 if you do need to generate a wait_finished event
+ * - 1 if you need to generate a wait_finished event for the gutter FSM.
+ */
+uint8_t
+gutter_generate_wait_finished_event (void);
+
#endif /* gutter_h */