altos: Add debounce helper. Use in button and quadrature drivers for TeleLCO
[fw/altos] / src / core / ao_debounce.h
1 /*
2  * Copyright © 2013 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #ifndef _AO_DEBOUNCE_H_
19 #define _AO_DEBOUNCE_H_
20
21 struct ao_debounce {
22         struct ao_debounce      *next;
23
24         /* time that pin value must be stable before accepting */
25         int8_t                  hold;
26
27         /* last value reported to app; don't report it twice */
28         uint8_t                 value;
29
30         /* current count of intervals pin value has been stable */
31         int8_t                  count;
32
33         /* This pin is running */
34         uint8_t                 running;
35
36         /* Get the current pin value */
37         uint8_t                 (*_get)(struct ao_debounce *debounce);
38
39         /* The stable value has changed */
40         void                    (*_set)(struct ao_debounce *debounce, uint8_t value);
41 };
42
43 void
44 _ao_debounce_start(struct ao_debounce *debounce);
45
46 void
47 _ao_debounce_stop(struct ao_debounce *debounce);
48
49 void
50 ao_debounce_init(void);
51
52 #endif /* _AO_DEBOUNCE_H_ */