i2cfuncs.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _I2CFUNCS_H_
#define _I2CFUNCS_H_
 
#ifdef SUPPORTED_I2C_PLATFORM
 
#if (defined NANO54415 || defined MOD5441X || defined SB800EX)
#include <multichanneli2c.h>
#elif (defined SAME70)
#include <i2c.h>
#include <bb_i2c.h>
#else
#warning I2C features not supported for this platform
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define I2C_MODULE_NUM 0         // use I2C0/TW0
#define I2C_BUS_SPEED (100000)   // bus speed of 100kHz
 
#define MAX_I2C_BUS_SPEED (400000)  // SAME70 specific value. Max bus speed for the TWI is 400 kHz in Fast Mode
#define I2C_LOW_ADDR_LIMIT (0x07)
#define I2C_HIGH_ADDR_LIMIT (0x78)
 
#define I2C_MAX_BUF_SIZE (64)          // Size allocated to input and output buffers in slave mode I2C
#define I2C_SLAVE_TX_TERM_CHAR (0)     // Terminating char to be sent when Slave TX buffer is empty
#define NB_FACTORY_I2C_ERR_VALUE (0)   // Error value if there is a failure to extract webpage form data
 
/* defined I2C Timeout values will be used if user does not include the 'ticks_to_wait'
   parameter when calling I2C functions                                                  */
#define I2C_RX_TX_TIMEOUT (5)    // Ticks allowed before timeout of a single byte transmission
#define I2C_START_TIMEOUT (20)   // Ticks allowed before timeout when attempting start on I2C bus
 
#define I2C_MAX_WRITE_LEN (255)
#define I2C_MAX_READ_LEN (255)
// *2 to account for inputting values in a 2-digit hex format
#define MAX_BUFFER_LEN ((I2C_MAX_WRITE_LEN > I2C_MAX_READ_LEN) ? I2C_MAX_WRITE_LEN * 2 : I2C_MAX_READ_LEN * 2)
#define MAX_I2C_DEVICES (128)
 
// These are the values the NetBurner I2C functions will return
#define I2C_OK (0)               // Last instruction terminated correctly
#define I2C_NEXT_WRITE_OK (1)    // I2C bus is OK for a write
#define I2C_NEXT_READ_OK (2)     // I2C bus is OK for a read
#define I2C_MASTER_OK (3)        // I2C finished transmission but still owns but (need to stop or restart)
#define I2C_TIMEOUT (4)          // A timeout occurred while trying communicate on I2C bus
#define I2C_BUS_NOT_AVAIL (5)    // A timeout occurred while trying gain I2C bus control
#define I2C_NOT_READY (6)        // A read or write was attempted before I2C ready or during a slave transmission
#define I2C_LOST_ARB (7)         // Lost arbitration during start
#define I2C_LOST_ARB_ADD (8)     // Lost arbitration and then winner addressed our slave address
#define I2C_NO_LINK_RX_ACK (9)   // We are in Master TX mode and received no ACK from slave device, possibly during start
 
 
    struct ModuleI2CAddress_Struct
    {
        unsigned char byteAddress;
        unsigned char asciiAddress[3];
    };
 
    // This structure stores the I2C address retrieved from Non-volatile memory
    // typedef struct NVSettings_Struct
    //{
    //    char slaveI2CAddress[3];
    //};
 
    // Stores ascii and byte versions of I2C parameters
    struct I2CParam_Struct
    {
        char asciiAddress[3];
        char asciiData[MAX_BUFFER_LEN];
        char asciiLength[3];
        unsigned char byteAddress;
        unsigned char byteData;
        unsigned char byteBuffer[MAX_BUFFER_LEN];
        int length;
    };
 
    // Used for handling the web I2C functions
    struct I2CWebFuncs_Struct
    {
        I2CParam_Struct WriteReadByteParams;
        I2CParam_Struct WriteReadBufferParams;
        I2CParam_Struct WriteByteParams;
        I2CParam_Struct ReadByteParams;
        I2CParam_Struct WriteBufferParams;
        I2CParam_Struct ReadBufferParams;
    };
 
    // Used for handling the serial I2C functions
    struct SerialParams_Struct
    {
        // int strLen;
        unsigned char buf[3];
        unsigned char byteData;
        unsigned char length;
        unsigned char addr;
        unsigned char byteToWrite;
        unsigned char commBuffer[MAX_BUFFER_LEN];
    };
 
    struct I2CBusStatus_Struct
    {
        volatile uint8_t status;
        const char *statusMsgs[7];
    };
 
#if (defined SAME70)
extern BBI2C bbI2C;
void InitI2C(uint32_t busSpeed = 0);
void bbInitI2C(uint32_t busSpeed = 0);
int bbI2CScan(bool *discovered);
#else
#error Multi_I2CInit declaration missing for defined platform
#endif
 
    unsigned char Ascii2Byte(char *buf);
    int I2CScan(bool *discovered, unsigned char slaveAddress);
    void I2CStatus();
 
#ifdef __cplusplus
}
 
#endif   // __cplusplus
#endif   // SUPPORTED_I2C_PLATFORM
#endif   // _I2CFUNCS_H_