bb_i2c.h

Go to the documentation of this file.

#ifndef __BB_I2C_H
#define __BB_I2C_H
/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#include <predef.h>
#include <nbrtos.h>
#include <pins.h>
 
#ifndef WIRE_DEFAULT_IINSTACE
#define WIRE_DEFAULT_INSTANCE Wire0
#endif
#define Wire WIRE_DEFAULT_INSTANCE
 
 
class BBI2C {
public:
 enum Result_t {
 I2C_RES_ACK, 
 I2C_RES_NACK, 
 I2C_RES_ARB_LST, 
 I2C_RES_BUSY, 
 I2C_RES_ARG, 
 I2C_RES_IN_PROGRESS,
 I2C_RES_ERR 
 };
 
private:
 enum HwCmd_t {
 CMD_TXD = 0,
 CMD_RXN = 1,
 CMD_STOP = 2,
 CMD_DISCARDN = 3,
 CMD_START = 4,
 CMD_START_NAK = 5,
 CMD_START_HS = 6,
 CMD_START_HS_NAK = 7,
 };
 enum TxnStat {
 TXN_RDY,
 TXN_SETUP,
 TXN_BUS_BUSY,
 TXN_RESTART_FOR_READ,
 TXN_BEGIN_RX,
 TXN_RX_IN_PROGRESS,
 TXN_RX_QUEUED,
 TXN_RX_STOPPING,
 TXN_BEGIN_TX,
 TXN_TX_IN_PROGRESS,
 TXN_TX_QUEUED,
 TXN_IN_PROGRESS,
 TXN_STOPPING,
 TXN_WAITING
 };
#ifdef I2C_DEBUG
 struct IsrLogEntry {
 uint32_t isrNum;
 TxnStat oldState;
 TxnStat newState;
 const uint8_t *buf;
 uint32_t len;
 uint32_t lenToQueue;
 uint32_t tick;
 uint32_t tickFrac;
 int line;
 
 void Log(const I2C &i2c, TxnStat state, int line);
 void Dump();
 };
 friend struct IsrLogEntry;
 struct IsrLog {
 IsrLogEntry entry[ISR_LOG_LEN];
 uint32_t head;
 uint32_t tail;
 IsrLog();
 void Log(const I2C &i2c, TxnStat state, int line);
 void Dump();
 };
 friend struct IsrLog;
#endif
 PinIO scl, sda;
 
 uint32_t delayCount;
 uint8_t *dataBuf;
 uint32_t dataLen;
 uint32_t rxLenToQueue;
 uint16_t maxDelay_ms;
 uint16_t delayCycles_ms;// how many delay counts per millisecond
 uint16_t currPinLowCount;// how many millisecond counts we've been low for
 uint16_t reqPinLowCount;// how many milliseconds counts we need
 TxnStat txnState;
 Result_t txnResult;
 
 OS_SEM txnSem;
 
 uint32_t isrCnt;
#ifdef I2C_DEBUG
 IsrLog log;
#endif
 
 
 uint8_t iadrAddressSize; // Number of address register bytes, 0 - 3
 void isr();
 int isr_rx(uint32_t sr);
 int isr_tx(uint32_t sr);
#ifdef I2C_DEBUG
 void Log(TxnStat state, int line);
 void DumpLog();
#endif
 
 Result_t start(uint8_t deviceAddr);
 Result_t restart(uint8_t deviceAddr);
 
 Result_t stop();
 Result_t write8(uint8_t dat);
 Result_t read8(uint8_t &dat, bool bLast);
 Result_t queueRx();
 
 
public:
 BBI2C(PinIO scl, PinIO sda);
 
 // Copy constructor
 BBI2C(const BBI2C & rhs)
 : scl(rhs.scl), sda(rhs.sda), txnState(rhs.txnState)
 {}
 
 void setup(uint32_t maxBusSpeed);
 
 void resetBus();
 
 inline void setNumAddressBytes(uint8_t numAddressBytes = 1) { iadrAddressSize = numAddressBytes; }
 
 virtual Result_t writeReg8(uint8_t devAddr, uint32_t reg, uint8_t data);
 virtual Result_t writeReg16(uint8_t devAddr, uint32_t reg, uint16_t data, int byteOrder);
 virtual Result_t writeReg32(uint8_t devAddr, uint32_t reg, uint32_t data, int byteOrder);
 
 virtual Result_t readReg8(uint8_t devAddr, uint32_t reg, uint8_t &data);
 virtual Result_t readReg16(uint8_t devAddr, uint32_t reg, uint16_t &data, int byteOrder);
 virtual Result_t readReg32(uint8_t devAddr, uint32_t reg, uint32_t &data, int byteOrder);
 
 virtual Result_t writeRegN(uint8_t devAddr, uint32_t reg, uint8_t *buf, uint32_t blen);
 
 virtual Result_t readRegN(uint8_t devAddr, uint32_t reg, uint8_t *buf, uint32_t blen);
 
 // Static implementations of the C++ class that can be used if you prefer a C style interface
 static Result_t writeReg8(int module, uint8_t devAddr, uint32_t reg, uint8_t dat);
 static Result_t readReg8(int module, uint8_t devAddr, uint32_t reg, uint8_t &dat);
 static Result_t writeRegN(int module, uint8_t devAddr, uint32_t reg, uint8_t *buf, uint32_t blen);
 static Result_t readRegN(int module, uint8_t devAddr, uint32_t reg, uint8_t *buf, uint32_t blen);
 
 // These functions are for internal use only.
 void dump(uint32_t line);
 void SetMaxBusDelay(uint16_t milliseconds);
 uint32_t GetBusSpeed() { return 132000000/delayCount; }
 
 friend void LPI2C1_ISR();
 friend void LPI2C2_ISR();
 friend void LPI2C3_ISR();
 friend void LPI2C4_ISR();
 
 friend class WireIntf;
 
}; // end class I2C
 
#endif /* ----- #ifndef __BB_I2C_H ----- */