summaryrefslogtreecommitdiffhomepage
path: root/digital/io/src/gutter.h
blob: c84a9e400ab1a09e2913dc1db26307e3cc7f3f4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#ifndef gutter_h
#define gutter_h
/* gutter.h */
/* io - Input & Output with Artificial Intelligence (ai) support on AVR. {{{
 *
 * Copyright (C) 2008 NĂ©lio Laranjeiro
 *
 * APBTeam:
 *        Web: http://apbteam.org/
 *      Email: team AT apbteam DOT org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * }}} */

/**
 * 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 */