blyss.h

#ifndef _AVRIO_BLYSS_H_
#define _AVRIO_BLYSS_H_

#include <avrio/defs.h>
__BEGIN_C_DECLS
/* ========================================================================== */
#include <stdio.h>
#include <avr/interrupt.h>

/* constants ================================================================ */
#define BLYSS_BROADCAST 0 /***< Canal d'appel général */

/* macros =================================================================== */
#define vBlyssPrintFrame(f) vBlyssPrintFrameToFile (f, stdout)

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

struct xBlyssFrame {

  uint8_t raw[7];
};


/* types ==================================================================== */
typedef struct xBlyss xBlyss;

typedef struct xBlyssFrame xBlyssFrame;

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

void vBlyssSend (xBlyssFrame * frame, uint8_t repeat);

bool bBlyssReceive (xBlyssFrame * frame);

void vBlyssFrameInit (xBlyssFrame * frame, const uint8_t * tx_id);

void vBlyssFrameSetChannel (xBlyssFrame * frame, uint8_t channel);

uint8_t ucBlyssFrameChannel (const xBlyssFrame * frame);

bool bBlyssIsValidFrame (const void * buffer);

bool bBlyssIsValidChannel (uint8_t channel);

void vBlyssPrintFrameToFile (const xBlyssFrame * frame, FILE * out);


#if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * ===========================================================================*/
static inline void vBlyssFrameSetState (xBlyssFrame * frame, bool state);

static inline bool bBlyssFrameState (const xBlyssFrame * frame);

static inline uint8_t ucBlyssFrameGlobalChannel (const xBlyssFrame * frame);

static inline uint16_t usBlyssFrameAddress (const xBlyssFrame * frame);

static inline bool bBlyssFrameMatch (const xBlyssFrame * f1, const xBlyssFrame * f2);

static inline void vBlyssFrameCopy (xBlyssFrame * dest, const xBlyssFrame * src);

/* ========================================================================== */
#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
#include <string.h>

/* constants ================================================================ */
#define BLYSS_IDX_FLAG  0
#define BLYSS_IDX_GCHAN 8
#define BLYSS_IDX_ADDR  12
#define BLYSS_IDX_CHAN  28
#define BLYSS_IDX_STATE 32
#define BLYSS_IDX_ROLL  36
#define BLYSS_IDX_TOKEN 44

/* internal private functions ================================================ */
void vBlyssFrameSetBits (xBlyssFrame * f, uint8_t index, uint8_t len, uint16_t value);
uint16_t vBlyssFrameGetBits (const xBlyssFrame * f, uint8_t index, uint8_t len);

/* internal inline functions ================================================ */
// -----------------------------------------------------------------------------
INLINE void
vBlyssFrameSetState (xBlyssFrame * f, bool state) {

  vBlyssFrameSetBits (f, BLYSS_IDX_STATE, 4, ! state);
}

// -----------------------------------------------------------------------------
INLINE uint8_t
ucBlyssFrameGlobalChannel (const xBlyssFrame * f) {

  return vBlyssFrameGetBits (f, BLYSS_IDX_GCHAN, 4);
}

// -----------------------------------------------------------------------------
INLINE uint16_t
usBlyssFrameAddress (const xBlyssFrame * f) {

  return vBlyssFrameGetBits (f, BLYSS_IDX_ADDR, 16);
}

// -----------------------------------------------------------------------------
INLINE bool
bBlyssFrameState (const xBlyssFrame * f) {

  return ! vBlyssFrameGetBits (f, BLYSS_IDX_STATE, 4);
}

// -----------------------------------------------------------------------------
INLINE bool
bBlyssFrameMatch (const xBlyssFrame * f1, const xBlyssFrame * f2) {

  return memcmp (f1, f2, sizeof(xBlyssFrame)) == 0;
}

// -----------------------------------------------------------------------------
INLINE void
vBlyssFrameCopy (xBlyssFrame * dest, const xBlyssFrame * src) {

   memcpy (dest, src, sizeof(xBlyssFrame));
}

/* ========================================================================== */
#endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /*_AVRIO_BLYSS_H_ defined */