I2CMasterNode.hpp

Go to the documentation of this file.

#ifndef MP7_OPENCORESI2CMASTERNODE
#define MP7_OPENCORESI2CMASTERNODE

// uHal Headers
#include "uhal/DerivedNode.hpp"

namespace mp7 {
//TODO: Add a opencores namespace?
namespace opencores {

class I2CSlave; 

class I2CBaseNode : public uhal::Node {
    UHAL_DERIVEDNODE(I2CBaseNode);
public:
    I2CBaseNode(const uhal::Node& aNode);
//    I2CBaseNode(const I2CBaseNode& aOther);
    virtual ~I2CBaseNode();

    virtual uint8_t getI2CClockPrescale() const {
        return mClockPrescale;
    }

    virtual std::vector<std::string>  getSlaves() const;
    virtual uint8_t  getSlaveAddress( const std::string& name ) const;
    virtual uint8_t readI2C(uint8_t aSlaveAddress, uint32_t i2cAddress) const;
    virtual void writeI2C(uint8_t aSlaveAddress, uint32_t i2cAddress, uint32_t data) const;
    
protected:
    // low level i2c functions
    std::vector<uint8_t> virtual readBlockI2C(uint8_t aSlaveAddress, uint32_t numBytes) const;
    void virtual writeBlockI2C(uint8_t aSlaveAddress, const std::vector<uint8_t>& data) const;

    boost::unordered_map<std::string,uint8_t> mSlavesAddresses;

private:
    void constructor();
    
    // low level i2c functions
    void reset() const;
    void waitUntilFinished(bool requireAcknowledgement = true,
            bool requireBusIdleAtEnd = false) const;
    
    static const std::string mPreHi;
    static const std::string mPreLo;
    static const std::string mCtrl;
    static const std::string mTx;
    static const std::string mRx;
    static const std::string mCmd;
    static const std::string mStatus;

    uint16_t mClockPrescale;

    friend class I2CSlave;
};


class I2CSlave : boost::noncopyable {
protected:
    // Private constructor, accessible to I2CMaster
    I2CSlave(const I2CBaseNode* aMaster, uint8_t aSlaveAddress);
public:

    virtual ~I2CSlave();


    uint8_t getI2CAddress() const {
        return mAddress;
    }

    uint8_t readI2C(uint32_t i2cAddress) const;
    void writeI2C(uint32_t i2cAddress, uint32_t data) const;

private:
    const I2CBaseNode* mMaster;

    // slave address
    uint8_t mAddress;

    friend class I2CMasterNode;
};

class I2CMasterNode : public I2CBaseNode {
public:
    I2CMasterNode(const uhal::Node& aNode );
    I2CMasterNode(const I2CMasterNode& aOther );
    virtual ~I2CMasterNode();
    
    virtual const I2CSlave&  getSlave( const std::string& name ) const;
    
private:
    void constructor();
    boost::unordered_map<std::string,I2CSlave*> mSlaves;

};


} // namespace opencores
} // namespace mp7

#endif  /* MP7_OPENCORESI2CMASTERNODE */