git.gag.com Git - fw/altos/blob - src/kernel/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         uint8_t                 hold;
  26
  27         /* last value reported to app; don't report it twice */
  28         uint8_t                 value;
  29
  30         /* current value received from pins */
  31         uint8_t                 current;
  32
  33         /* current count of intervals pin value has been stable */
  34         uint8_t                 count;
  35
  36         /* This pin is running */
  37         uint8_t                 running;
  38
  39         /* Get the current pin value */
  40         uint8_t                 (*_get)(struct ao_debounce *debounce);
  41
  42         /* The stable value has changed */
  43         void                    (*_set)(struct ao_debounce *debounce, uint8_t value);
  44 };
  45
  46 static inline void
  47 ao_debounce_config(struct ao_debounce *debounce,
  48                    uint8_t (*_get)(struct ao_debounce *debounce),
  49                    void (*_set)(struct ao_debounce *debounce, uint8_t value),
  50                    uint8_t hold)
  51 {
  52         debounce->next = 0;
  53         debounce->hold = hold;
  54         debounce->value = 0xff;
  55         debounce->current = 0xff;
  56         debounce->count = 0;
  57         debounce->running = 0;
  58         debounce->_get = _get;
  59         debounce->_set = _set;
  60 }
  61
  62 void
  63 _ao_debounce_start(struct ao_debounce *debounce);
  64
  65 void
  66 _ao_debounce_stop(struct ao_debounce *debounce);
  67
  68 void
  69 ao_debounce_init(void);
  70
  71 void
  72 ao_debounce_dump(void);
  73
  74 #endif /* _AO_DEBOUNCE_H_ */