icounter.h

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

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

/* constants ================================================================ */
typedef enum eICounterMode {
  eICounterSingle      = 0, 
  eICounterFreeRunning = 1, 
} eICounterMode;

/* structures =============================================================== */

struct xICounter;

/* types ==================================================================== */

/* internal public functions ================================================ */
void vICounterInit (struct xICounter * c, xIrqHandle i);

void vICounterStart (struct xICounter * c);

void vICounterSetMode (struct xICounter * c, eICounterMode m);

void vICounterSetWindow (struct xICounter * c, uint16_t usWindowMs);

bool bICounterIsComplete (struct xICounter * c);

void vICounterWaitForComplete (struct xICounter * c);

double dICounterFreq (struct xICounter * c);

uint16_t usICounterCount (struct xICounter * c);

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

inline uint16_t usICounterGetWindow (struct xICounter * c);
#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
typedef struct xICounter {
  xTaskHandle xTask;      
  xMutex xReady;          
  xIrqHandle xInt;        
  eICounterMode eMode;   
  volatile uint16_t usCounter; 
  uint16_t usLastValue;   
  uint16_t usWindow;      
} xICounter;

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

// -----------------------------------------------------------------------------
INLINE eICounterMode 
eICounterGetMode (struct xICounter * c) {
  return c->eMode;
}

// -----------------------------------------------------------------------------
INLINE uint16_t 
usICounterGetWindow (struct xICounter * c) {
  return c->usWindow;
}
#endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_ICOUNTER_H_ */