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; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17  */
  18
  19 #ifndef _AO_DEBOUNCE_H_
  20 #define _AO_DEBOUNCE_H_
  21
  22 struct ao_debounce {
  23         struct ao_debounce      *next;
  24
  25         /* time that pin value must be stable before accepting */
  26         uint8_t                 hold;
  27
  28         /* last value reported to app; don't report it twice */
  29         uint8_t                 value;
  30
  31         /* current value received from pins */
  32         uint8_t                 current;
  33
  34         /* current count of intervals pin value has been stable */
  35         uint8_t                 count;
  36
  37         /* This pin is running */
  38         uint8_t                 running;
  39
  40         /* Get the current pin value */
  41         uint8_t                 (*_get)(struct ao_debounce *debounce);
  42
  43         /* The stable value has changed */
  44         void                    (*_set)(struct ao_debounce *debounce, uint8_t value);
  45 };
  46
  47 static inline void
  48 ao_debounce_config(struct ao_debounce *debounce,
  49                    uint8_t (*_get)(struct ao_debounce *debounce),
  50                    void (*_set)(struct ao_debounce *debounce, uint8_t value),
  51                    uint8_t hold)
  52 {
  53         debounce->next = 0;
  54         debounce->hold = hold;
  55         debounce->value = 0xff;
  56         debounce->current = 0xff;
  57         debounce->count = 0;
  58         debounce->running = 0;
  59         debounce->_get = _get;
  60         debounce->_set = _set;
  61 }
  62
  63 void
  64 _ao_debounce_start(struct ao_debounce *debounce);
  65
  66 void
  67 _ao_debounce_stop(struct ao_debounce *debounce);
  68
  69 void
  70 ao_debounce_init(void);
  71
  72 void
  73 ao_debounce_dump(void);
  74
  75 #endif /* _AO_DEBOUNCE_H_ */