counter.h

#ifndef _AVRIO_COUNTER_H_
#define _AVRIO_COUNTER_H_
#include <avrio/task.h>
#include <avrio/mutex.h>

__BEGIN_C_DECLS
/* ========================================================================== */

/* constants ================================================================ */
typedef enum eCounterMode {
  eCounterSingle      = 0, 
  eCounterFreeRunning = 1, 
} eCounterMode;

/* structures =============================================================== */
struct xCounterOps {
  void (*init) (void);  /***< Initialisation du comptage */
  uint16_t (*read) (void); 
  void (*clear) (void); 
  void (*enable) (bool); 
};

struct xCounter;

/* types ==================================================================== */
typedef struct xCounterOps xCounterOps;

/* internal public functions ================================================ */
void vCounterInit (struct xCounter * c, xCounterOps * o);

void vCounterStart (struct xCounter * c);

void vCounterSetMode (struct xCounter * c, eCounterMode m);

void vCounterSetWindow (struct xCounter * c, uint16_t usWindowMs);

bool bCounterIsComplete (struct xCounter * c);

void vCounterWaitForComplete (struct xCounter * c);

double dCounterFreq (struct xCounter * c);

uint16_t usCounterCount (struct xCounter * c);

#if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */
inline eCounterMode eCounterGetMode (struct xCounter * c);

inline uint16_t usCounterGetWindow (struct xCounter * c);
#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
typedef struct xCounter {
  xTaskHandle xTask;      
  xMutex xReady;          
  eCounterMode eMode;     
  uint16_t usLastValue;   
  uint16_t usWindow;      
  xCounterOps * xOps;       
} xCounter;

/* inline public functions ================================================== */

// -----------------------------------------------------------------------------
INLINE eCounterMode 
eCounterGetMode (struct xCounter * c) {
  return c->eMode;
}

// -----------------------------------------------------------------------------
INLINE uint16_t 
usCounterGetWindow (struct xCounter * c) {
  return c->usWindow;
}

#endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_COUNTER_H_ */