I2CSlave.h

Go to the documentation of this file.

//*****************************************************************************
// I2CSlave.h
//
//
//
//
//*****************************************************************************
//*****************************************************************************
//*****************************************************************************

#ifndef CAPT_I2C_H_
#define CAPT_I2C_H_

#include "I2CSlave_Definitions.h"

#if (I2CSLAVE__ENABLE==true)

#if (I2CSLAVE__TIMEOUT_ENABLE==true)
#include "FunctionTimer.h"
#endif

//*****************************************************************************
//
//
//
//*****************************************************************************
#if (I2CSLAVE__EUSCI_B_PERIPHERAL == EUSCI_B0_BASE)
#define I2CSLAVE__EUSCI_VECTOR          (USCI_B0_VECTOR)
#define I2CSLAVE__EUSCI_IV              (UCB0IV)
#else
#error INVALID_EUSCI_B_SELECTION
#endif

//*****************************************************************************
//
//
//*****************************************************************************
#define I2CSLAVE__INT_MASK              (0x0F)

//*****************************************************************************
//
//
//*****************************************************************************
#define I2C__INIT_REQ_SIGNAL            (I2CSLAVE__REQ_POUT &= ~I2CSLAVE__REQ_MASK)

//*****************************************************************************
//
//
//*****************************************************************************
#define I2C__PULL_REQ_SIGNAL            (I2CSLAVE__REQ_PDIR |= I2CSLAVE__REQ_MASK)

//*****************************************************************************
//
//
//*****************************************************************************
#define I2C__RELEASE_REQ_SIGNAL         (I2CSLAVE__REQ_PDIR &= ~I2CSLAVE__REQ_MASK)

//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{
        //
        //
        bool (*pbReceiveCallback)(uint16_t);

        //
        //
        void (*pvErrorCallback)(uint8_t);

        //
        //
        uint16_t ui16ReceiveBufferSize;

        //
        //
        uint8_t *pReceiveBuffer;

        //
        //
        bool bSendReadLengthFirst;

} tI2CSlavePort;

//*****************************************************************************
//
//
//*****************************************************************************
enum tI2CSlaveStates {
        eI2CSlaveIsClosed = 0x00,
        eI2CSlaveIsIdle = 0x01,
        eI2CSlaveIsBeingRead = 0x02,
        eI2CSlaveIsBeingWrittenTo = 0x03
};

//*****************************************************************************
//
//
//*****************************************************************************
enum tI2CSlaveErrors {
        eI2CSlaveTransmitRequestTimeout,
        eI2CSlaveTransactionTimeout,
        eI2CSlaveReceiveBufferFull,
        eI2CSlaveWasReadBeyondTransmitBuffer
};

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void I2CSlave_openPort(const tI2CSlavePort *pPort);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void I2CSlave_closePort(void);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern uint8_t I2CSlave_getPortStatus(void);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void I2CSlave_setTransmitBuffer(uint8_t *pBuffer, uint16_t ui16Length);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void I2CSlave_setRequestFlag(void);

#endif /* I2CSLAVE__ENABLE==true */

#endif /* CAPT_I2C_H_ */
//*****************************************************************************
//*****************************************************************************