twi.h

#ifndef _AVRIO_TWI_H_
#define _AVRIO_TWI_H_

#include <avrio/defs.h>
#include <avrio/queue.h>
#include <avrio/twi_addr.h>

__BEGIN_C_DECLS
  /* ======================================================================== */
  /* constants ============================================================== */
   typedef enum {

  TWI_SUCCESS = 0,          
  /* Codes d'état */
  TWI_STATUS_TX = 1,                
  TWI_STATUS_RX = 2,                
  TWI_STATUS_BUSY = 3,              
  TWI_STATUS_LCALL = 5,             
  TWI_STATUS_GCALL = 4,             
  TWI_STATUS_TXBUFFER_EMPTY = 6,    
  TWI_STATUS_ARB_LOST = 7,          
  /* Codes Erreur */
  TWI_ERROR_DATA_NACK = -1,             
  TWI_ERROR_ADDR_NACK = -2,             
  TWI_ERROR_ILLEGAL_START_STOP = -3,    
  TWI_ERROR_INVALID_SPEED = -4,         
  TWI_ERROR_INVALID_LENGTH = -5,        
  TWI_ERROR_BUFFER_FULL = -6,           
  TWI_ERROR_TIMEOUT = -7,               
  TWI_ERROR_ILLEGAL_CODE = -8,          
  TWI_ERROR_INVALID_DEVICE = -9,        
  TWIMEM_ERROR_READ = -10               
} eTwiStatus;

/* types ==================================================================== */
typedef uint8_t xTwiDeviceAddr;
#define TWI_DEVICE_ADDR_SIZEOF 1

typedef uint8_t xTwiLength;
#define TWI_LENGTH_SIZEOF 1

typedef struct xTwiFrame {
  uint8_t * pxData;     
  xTwiLength xLen;      
  xTwiDeviceAddr xAddr; 
} xTwiFrame;

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

bool bTwiIsBusy (void);

/*-----------------------------Mode Maître------------------------------------*/
/* types ==================================================================== */
typedef int8_t xTwiId;
#define TWI_ID_SIZEOF 1

/* internal public functions ================================================ */

eTwiStatus eTwiSend (xTwiFrame * pxFrame);

eTwiStatus eTwiWrite (xTwiDeviceAddr xDeviceAddr, uint8_t ucByte);

eTwiStatus eTwiReceive (xTwiFrame * pxFrame);

eTwiStatus eTwiRead (xTwiDeviceAddr xDeviceAddr, uint8_t * pucByte);

eTwiStatus eTwiMem8Write (uint8_t ucFisrtByte, xTwiFrame * pxFrame);

eTwiStatus eTwiMem8Read  (uint8_t ucFisrtByte, xTwiFrame * pxFrame);

eTwiStatus eTwiMem16Write (uint16_t usMemAddr, xTwiFrame * pxFrame);

eTwiStatus eTwiMem16Read  (uint16_t usMemAddr, xTwiFrame * pxFrame);

/*=============================================================================
 |                    Sous interruption uniquement                            |
 =============================================================================*/

xTwiId xTwiTrySend (const xTwiFrame * pxFrame);

xTwiId xTwiTryReceive (xTwiFrame * pxFrame);

eTwiStatus eTwiGetStatus (xTwiId xFrameId, xTwiLength * pxLength);

eTwiStatus eTwiGetRxFrame (xTwiFrame * pxFrame);

/*----------------------------Mode Esclave------------------------------------*/
/* constants ================================================================ */
#define TWI_GENCALL 0x01

/* internal public functions ================================================ */
eTwiStatus eTwiSlaveRxCB (xQueue * pxRxPayload, eTwiStatus eStatus);

eTwiStatus eTwiSlaveTxCB (xQueue * pxTxPayload, eTwiStatus eStatus);

#if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */
/* macros =================================================================== */
#define TWIFRAME_DECLARE(xVarName, xBufferSize)

#define TWIFRAME_STATIC_DECLARE(xVarName, xBufferSize)

/* inline public functions ================================================== */
void vTwiSetDeviceAddress (xTwiDeviceAddr xMyDeviceAddr);

/*--------------------------Fin Mode Esclave----------------------------------*/
/*-----------------------------Mode Maître------------------------------------*/
eTwiStatus eTwiSetSpeed (uint16_t usSpeed);

#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
#include "avrio-config.h"

#ifdef AVRIO_TWI_ENABLE
#include "avrio-board-twi.h"

/* macros =================================================================== */
// ----------------------------------------------------------------------------
#define TWIFRAME_DECLARE(__name,__size)               \
    uint8_t __name ##Buffer[__size];                 \
    xTwiFrame __name = {  .pxData = __name ##Buffer, \
                          .xLen   = 0,                \
                          .xAddr  = 0 }
// ----------------------------------------------------------------------------
#define TWIFRAME_STATIC_DECLARE(__name,__size)               \
    static uint8_t __name ##Buffer[__size];                 \
    static xTwiFrame __name = { .pxData = __name ##Buffer }

/* inline public functions ================================================== */
#include <avr/io.h>
  /*----------------------------Mode Maître-----------------------------------*/

  // ----------------------------------------------------------------------------
__STATIC_ALWAYS_INLINE (eTwiStatus eTwiSetSpeed (uint16_t usSpeed)) {
  uint16_t usRatio;

#ifdef TWPS0
  TWSR &= ~(_BV (TWPS0) | _BV (TWPS1));
#endif

  usRatio = ((AVRIO_CPU_FREQ / 1000UL) / usSpeed);
  if ((usRatio < 16) || (usRatio > (255 * 2 + 16))) {

    return TWI_ERROR_INVALID_SPEED;
  }
  TWBR = (uint8_t) (usRatio - 16) / 2;
  return TWI_SUCCESS;
}

  /*---------------------------Mode Esclave-----------------------------------*/

  // ----------------------------------------------------------------------------
__STATIC_ALWAYS_INLINE (void
                        vTwiSetDeviceAddress (xTwiDeviceAddr xMyDeviceAddr)) {

  TWAR = xMyDeviceAddr;
  TWCR = _BV (TWINT) | _BV (TWEN) | _BV (TWIE) | _BV (TWEA);
}
#endif /* AVRIO_TWI_ENABLE defined */

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