nz_serI2C.h

Go to the documentation of this file.

//  I2C - documentation module

#ifndef NZ_SERI2C_H
#define NZ_SERI2C_H

#if defined(HAS_SERPORT_I2C)

#include "nz_circularBuffer.h"



#ifndef I2C_BAUD_62K
#define I2C_BAUD_62K   255  /* This is the slowest possible BAUD rate! */
#endif

#ifndef I2C_BAUD_100K
#define I2C_BAUD_100K   157
#endif

#ifndef I2C_BAUD_200K
#define I2C_BAUD_200K   77
#endif

#ifndef I2C_BAUD_300K
#define I2C_BAUD_300K   51
#endif

#ifndef I2C_BAUD_400K
#define I2C_BAUD_400K   37
#endif

#ifndef I2C_BAUD_506K
#define I2C_BAUD_506K   24
#endif

#ifndef I2C_BAUD_600K
#define I2C_BAUD_600K   24
#endif

#ifndef I2C_BAUD_708K
#define I2C_BAUD_708K   20
#endif

#ifndef I2C_BAUD_909K
#define I2C_BAUD_909K   15
#endif

#ifndef I2C_BAUD_970K
#define I2C_BAUD_970K   12
#endif

//1.03 mbits/sec Baud rate */
#ifndef I2C_BAUD_1M
#define I2C_BAUD_1M   13
#endif

#ifndef I2C_ALWAYS_ADD_WHOLE_MESSAGE
#define I2C_ALWAYS_ADD_WHOLE_MESSAGE 0
#endif
#ifndef I2C2_ALWAYS_ADD_WHOLE_MESSAGE
#define I2C2_ALWAYS_ADD_WHOLE_MESSAGE 0
#endif
#ifndef I2C3_ALWAYS_ADD_WHOLE_MESSAGE
#define I2C3_ALWAYS_ADD_WHOLE_MESSAGE 0
#endif

//Transmit and Receive buffer sizes
#if !defined(I2C1_RXBUF_SIZE)
#define    I2C1_RXBUF_SIZE  64
#endif
#if !defined(I2C1_TXBUF_SIZE)
#define    I2C1_TXBUF_SIZE  256
#endif
#if !defined(I2C2_RXBUF_SIZE)
#define    I2C2_RXBUF_SIZE  32
#endif
#if !defined(I2C2_TXBUF_SIZE)
#define    I2C2_TXBUF_SIZE  128
#endif
#if !defined(I2C3_RXBUF_SIZE)
#define    I2C3_RXBUF_SIZE  32
#endif
#if !defined(I2C3_TXBUF_SIZE)
#define    I2C3_TXBUF_SIZE  128
#endif



//I2C_TXION_STATUS_xx defines, 0=OK, 1=Added to Buffer, 0x80-0x8F=Error, 0xFF=Status Not Available
#define I2C_TXION_STATUS_OK            0    //Currently OK, have not finished adding whole message to buffer
#define I2C_TXION_STATUS_ADDED_TO_BUF  1    //Successfully added whole message to the buffer (from start to stop)
#define I2C_TXION_STATUS_ERROR         4    //No space in buffer to add message
#define I2C_TXION_STATUS_ERR_NOSPACE   5    //No space in buffer to add message
#define I2C_TXION_STATUS_ERR_ADR_NOACK 6    //Slave did not ACK address we sent
#define I2C_TXION_STATUS_ERR_DAT_NOACK 7    //Slave did not ACK data we sent
#define I2C_TXION_STATUS_ERR_BUF_FRMT  8    //Buffer format error
#define I2C_TXION_STATUS_ERR_TIMEOUT   9    //Timeout
#define I2C_TXION_STATUS_NOT_AVAILABLE 0xFF //Status not available

//I2C "Serial Data Port"
#if (defined(HAS_SERPORT_I2C1) || defined(HAS_SERPORT_I2C2) || defined(HAS_SERPORT_I2C3))
    #if !defined(HAS_A_SERPORT)
    #define HAS_A_SERPORT
    #endif
#endif



//If "Power of 2" buffer used, size must by a power of 2
#if defined(CIRBUF_USE_CIRCULAR_BUFFER_PWR2)
#if defined(HAS_SERPORT_I2C1)
    //Ensure size is power of 2
    #if ((I2C1_TXBUF_SIZE & ~(I2C1_TXBUF_SIZE-1))!=I2C1_TXBUF_SIZE)
    #error "I2C1 I2C1_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((I2C1_RXBUF_SIZE & ~(I2C1_RXBUF_SIZE-1))!=I2C1_RXBUF_SIZE)
    #error "I2C1 I2C1_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#if defined(HAS_SERPORT_I2C2)
    //Ensure size is power of 2
    #if ((I2C2_TXBUF_SIZE & ~(I2C2_TXBUF_SIZE-1))!=I2C2_TXBUF_SIZE)
    #error "I2C2 I2C2_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((I2C2_RXBUF_SIZE & ~(I2C2_RXBUF_SIZE-1))!=I2C2_RXBUF_SIZE)
    #error "I2C2 I2C2_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#if defined(HAS_SERPORT_I2C3)
    //Ensure size is power of 2
    #if ((I2C3_TXBUF_SIZE & ~(I2C3_TXBUF_SIZE-1))!=I2C3_TXBUF_SIZE)
    #error "I2C3 I2C3_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((I2C3_RXBUF_SIZE & ~(I2C3_RXBUF_SIZE-1))!=I2C3_RXBUF_SIZE)
    #error "I2C3 I2C3_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#endif



typedef struct __attribute__((aligned(2), packed))
{
    union {
        struct
        {
            unsigned int bFill : 16;        //Fill to ensure flags take up a 16-bit WORD
        } flags;
        WORD flagsVal;
    };

    // Not all values for I2C1CON are possible, only following can be set:
    WORD    config1;

    //for RTC. This is the value for I2C1BRG register of PIC, see PIC datasheet for details. Some values are:
    //157=100kHz, 75=200kHz, 37=400kHz, 12=970kHz, 11=1.03Mhz, 8=1.28Mhz
    WORD    baud;

} SERPORT_I2C_CONFIG;

//DON'T change! Code that checks wrDstType.bit0 and wrDstType.bit1 assumes there values!
#define RD_DEST_TYPE_LISTENERS 0
#define RD_DEST_TYPE_POINTER   2
#define RD_DEST_TYPE_CIRBUF    3

typedef struct __attribute__((__packed__)) I2C_ISR_SMFLAGS_
{
    union {
        struct
        {
            unsigned int sm : 4;            
            unsigned int sAddress : 1;      
            unsigned int b : 1;             
            unsigned int wrDstType : 2;     
            unsigned int isrTxionStatus: 4; 
            unsigned int fill12 : 4;
        } bits;
        struct
        {
            unsigned int fill0to5 : 6;      
            unsigned int bit0 : 1;          
            unsigned int bit1 : 1;          
            unsigned int fill8to15 : 8;     
        } wrDstType;
        WORD val;                           
    };
} I2C_ISR_SMFLAGS;

//Must be a power of two value: 4,8,16,32,64
#define I2C_STATUS_BUF_SIZE 8

typedef struct I2C_INFO_
//typedef struct __attribute__((__packed__)) I2C_INFO_
//typedef struct __attribute__((aligned(2), packed)) I2C_INFO_
{
    //Buffer containing status. Two bytes are used for each entry, the LSB=Address (0=empty), and MSB=Status.
    BYTE            bufStat[I2C_STATUS_BUF_SIZE];
    //BYTE            putStat;    //Put pointer to bufStat. Points to last entry added.
    BYTE            adr;        //Used by non-ISR functions to remember current slave address
    BYTE            taskSm;     //ISR State machine. 0 is idle.
    BYTE            isrAdr;     //Used in ISR - address of slave
    BYTE            isrCnt;     //Incremented in ISR each time a STOP condition is put on the bus
    BYTE            isrRead;    //Used in ISR - number of bytes to to read
    BYTE            fillByte;
    
    WORD            isrRdDest;  //Destination for read, meaning depends on value of i2c1.isr.bits.wrDstType
                                // - When 0, bits 0-15 indicates which "Circular Buffer" listeners are destinations (0=default)
                                // - When 1, contains pointer to destination BYTE array
    WORD            timeout;    //Used in task to check for a timeout
    CIRBUF*         pCbufTx;
    CIRBUF*         pCbufRx;
    I2C_ISR_SMFLAGS isr;        //ISR State machine AND flags.
    union {
        struct
        {
            BYTE ch;
            BYTE currTxionStatus;
//            unsigned int ch                 : 3;    //Channel Offset = number - 1: 0=I2C1, 1=I2C2, 2=I2C3
//            unsigned int bFill3to7          : 5;    //Fill bytes
//            unsigned int currTxionStatus    : 4;    //Status of current Transmission
//            unsigned int bFill12to15        : 4;    //Fill bytes
        } flags;
        WORD flagsVal;
    };
} I2C_INFO;



//I2C Functions for all ports

void serI2CInit(void);

void serI2CTask(I2C_INFO* objI2C);


BYTE serI2CRegisterListener(CIRBUF* pBuf);


I2C_INFO* i2cGetInfoForBus(BYTE i2cBus);

BYTE i2cGetStatus(I2C_INFO* objI2C, BYTE adr);


BYTE i2cGetStatusWait(I2C_INFO* objI2C, BYTE adr);

BYTE i2cIsBusy(I2C_INFO* objI2C);


BYTE i2cWriteMessage(I2C_INFO* objI2C, BYTE adr, BYTE* msg, WORD size);


BYTE i2cBeginTransmission(I2C_INFO* objI2C, BYTE adr);


BYTE i2cEndTransmission(I2C_INFO* objI2C);


BYTE i2cWrite(I2C_INFO* objI2C, BYTE b);

BYTE i2cWriteArray(I2C_INFO* objI2C, BYTE* arr, BYTE size);


BYTE i2cWriteString(I2C_INFO* objI2C, const char* str);


BYTE i2cWriteAsciiEscString(I2C_INFO* objI2C, const char* str);


BYTE i2cRead(I2C_INFO* objI2C, BYTE size);


BYTE i2cReadToArray(I2C_INFO* objI2C, BYTE* buf, BYTE size);


BYTE i2cReadSlaveReg(I2C_INFO* objI2C, BYTE adr, BYTE reg, BYTE* buf, BYTE size);

#define i2cGetByte(objI2C) cbufGetByte(objI2C->pCbufRx)


#define i2cGetArray(objI2C, pDstArr, size) cbufGetArray(objI2C->pCbufRx, pDstArr, size)


//I2C 1
#if defined(HAS_SERPORT_I2C1)

#if !defined(SERPORT_I2C1_CREATE_OWN_CIRBUFS)
#include "nz_serDataPorts.h"
#endif

//Modes
#define SERPORT_I2C1_MODE_ASCII 0

//This is used by others
#ifndef THIS_IS_NZ_SERI2C1_C
extern I2C_INFO i2c1Info;
#endif
#define I2C1_INFO &i2c1Info

//TX and RX "Circular Buffers". Use SERPORT_I2C1_CREATE_OWN_CIRBUFS define to use this
//module without SERPORTs. If NOT defined, this modules requires nz_serDataPorts.c
#if defined(SERPORT_I2C1_CREATE_OWN_CIRBUFS)
    //This is used by others
    #ifndef THIS_IS_NZ_SERI2C1_C
    extern CIRBUF cbufTxI2C1;
    extern CIRBUF cbufRxI2C1;
    #endif

    #define CIRBUF_TX_I2C1 &cbufTxI2C1
    #define CIRBUF_RX_I2C1 &cbufRxI2C1
#endif


void serI2C1Init(void);

//void serI2C1Task(void);

BYTE i2c1GetStatus(BYTE adr);


BYTE i2c1GetStatusWait(BYTE adr);

BYTE i2c1IsBusy(void);

#define i2c1GetTxionCnt()  (i2c1Info.isrCnt)

#define i2c1GetTxionAddress()  (i2c1Info.adr)


BYTE i2c1WriteMessage(BYTE adr, BYTE* msg, WORD size);


BYTE i2c1BeginTransmission(BYTE adr);


BYTE i2c1EndTransmission(void);


BYTE i2c1Write(BYTE b);


BYTE i2c1WriteArray(BYTE* arr, BYTE size);


BYTE i2c1WriteString(const char* str);


BYTE i2c1WriteAsciiEscString(const char* str);


BYTE i2c1Read(BYTE size);


BYTE i2c1ReadToArray(BYTE* buf, BYTE size);


BYTE i2c1ReadSlaveReg(BYTE adr, BYTE reg, BYTE* buf, BYTE size);


/*
#define i2c1EmptyTxBuf()              cbufEmpty(CIRBUF_TX_I2C1)
#define i2c1IsTxBufEmpty()            cbufIsEmpty(CIRBUF_TX_I2C1)
#define i2c1IsTxBufFull()             cbufIsFull(CIRBUF_TX_I2C1)
#define i2c1GetTxBufCount()           cbufGetCount(CIRBUF_TX_I2C1)
#define i2c1PeekTxBuf()               cbufPeekByte(CIRBUF_TX_I2C1)
#define i2c1PeekTxBufAt(offset)       cbufPeekByteAt(CIRBUF_TX_I2C1, offset)
#define i2c1TxBufRemoveByte()         cbufRemoveByte(CIRBUF_TX_I2C1)
#define i2c1TxBufRemoveBytes(n)       cbufRemoveBytes(CIRBUF_TX_I2C1, n)
*/

#define i2c1GetTxBufFree()  cbufGetFree(CIRBUF_TX_I2C1)


#define i2c1EmptyTxBuf() cbufEmpty(CIRBUF_TX_I2C1)


#define i2c1IsTxBufEmpty()  cbufIsEmpty(CIRBUF_TX_I2C1)


#define i2c1IsTxBufFull()   cbufIsFull(CIRBUF_TX_I2C1)


#define i2c1GetRxBufCount() cbufGetCount(CIRBUF_RX_I2C1)


#define i2c1HasData() cbufHasData(CIRBUF_RX_I2C1)


#define i2c1IsRxBufEmpty()  cbufIsEmpty(CIRBUF_RX_I2C1)


#define i2c1GetByte() cbufGetByte(CIRBUF_RX_I2C1)


#define i2c1GetArray(pDstArr, size) cbufGetArray(CIRBUF_RX_I2C1, pDstArr, size)

#endif  //#if defined(HAS_SERPORT_I2C1)

#endif  //#if defined(HAS_SERPORT_I2C)
#endif  //#ifndef NZ_SERI2C_H