bb_i2c.h

#ifndef  __BB_I2C_H
#define  __BB_I2C_H
/*NB_REVISION*/
 
/*NB_COPYRIGHT*/


 
#include <predef.h>
#include <nbrtos.h>
#include <pins.h>

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 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
    };
 
    PinIO scl, sda;
 
    uint32_t delayCount;        // Half bit period, in the units spinDly() counts
    TxnStat  txnState;
    Result_t txnResult;
    uint8_t  iadrAddressSize;   // Number of address register bytes, 0 - 3
 
public:
    Result_t start();
    Result_t restart();
 
    Result_t stop();
    Result_t write8(uint8_t dat);
    Result_t read8(uint8_t &dat, bool bLast);
 
 
public:
    BBI2C(PinIO scl, PinIO sda);

    BBI2C(const BBI2C & rhs)
        : scl(rhs.scl), sda(rhs.sda), delayCount(rhs.delayCount),
          txnState(rhs.txnState), txnResult(rhs.txnResult),
          iadrAddressSize(rhs.iadrAddressSize)
    {}

    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);
    [[deprecated("SetMaxBusDelay has no effect; bus operations already time out, use resetBus() to recover a hung bus")]]
    void SetMaxBusDelay(uint16_t milliseconds);

    uint32_t GetBusSpeed();
 
    virtual Result_t ping(uint8_t devAddr, bool bAsWrite = false);
 
};  // end class BBI2C
 
#endif   /* ----- #ifndef __BB_I2C_H  ----- */