tcapture.h

#ifndef _AVRIO_TCAPTURE_H_
#define _AVRIO_TCAPTURE_H_
#include <avrio/mutex.h>
#include <avr/interrupt.h>

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

/* constants ================================================================ */
typedef enum {
  eTCaptureFalling  = 0, 
  eTCaptureRising   = 1, 
} eTCaptureEvent;

typedef enum {
  eTCaptureDivStop  = 0, 
  eTCaptureDiv1  = 1, 
  eTCaptureDiv8  = 2, 
  eTCaptureDiv64  = 3, 
  eTCaptureDiv256  = 4, 
  eTCaptureDiv1024  = 5, 
  eTCaptureDivExtFall  = 6, 
  eTCaptureDivExtRise  = 7, 
} eTCapturePrescaler;

#define TCAPTURE1  0 
#define TCAPTURE3  1 
#define TCAPTURE4  2 
#define TCAPTURE5  3 
/* types ==================================================================== */

typedef int8_t xTCaptureHandle;

/* internal public functions ================================================ */
void vTCaptureInit(void);

void vTCaptureSetPrescaler (xTCaptureHandle t, eTCapturePrescaler ePrescaler);

void vTCaptureStart (xTCaptureHandle t);

bool bTCaptureIsComplete (xTCaptureHandle t);

void vTCaptureWaitForComplete (xTCaptureHandle t);

uint16_t usTCaptureValue (xTCaptureHandle t);

double dTCaptureValueToTime (xTCaptureHandle t, uint16_t usValue);

double dTCaptureValueToFreq (xTCaptureHandle t, uint16_t usValue);

void vTCaptureSetNoiseFilter (xTCaptureHandle t, bool bEnable);

void vTCaptureSetEvent (xTCaptureHandle t, eTCaptureEvent eEvent);

#if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */
inline double dTCaptureTime (xTCaptureHandle t);

inline double dTCaptureFreq (xTCaptureHandle t);
#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */

// -----------------------------------------------------------------------------
INLINE double
dTCaptureTime (xTCaptureHandle t) {
  return dTCaptureValueToTime (t, usTCaptureValue (t));
}

// -----------------------------------------------------------------------------
INLINE double
dTCaptureFreq (xTCaptureHandle t) {
  return dTCaptureValueToFreq (t, usTCaptureValue (t));
}

#endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_TCAPTURE_H_ */