I2CSlave.hpp

Go to the documentation of this file.

 
#ifndef TIMING_INCLUDE_TIMING_I2CSLAVE_HPP_
#define TIMING_INCLUDE_TIMING_I2CSLAVE_HPP_
 
#include "TimingIssues.hpp"
 
#include "ers/Issue.hpp"
 
// uHal Headers
#include "uhal/DerivedNode.hpp"
 
#include <boost/core/noncopyable.hpp>
 
#include <string>
#include <vector>
 
namespace dunedaq {
namespace timing {
 
class I2CMasterNode;
 
class I2CSlave : boost::noncopyable
{
 
public:
  virtual ~I2CSlave();
 
  uint8_t get_i2c_address() const { return m_i2c_device_address; } // NOLINT(build/unsigned)
 
  uint8_t read_i2c(uint32_t i2c_device_address, uint32_t i2c_reg_address) const; // NOLINT(build/unsigned)
  uint8_t read_i2c(uint32_t i2c_reg_address) const;                              // NOLINT(build/unsigned)
 
  uint8_t read_i2c_atomic(uint32_t i2c_device_address, uint32_t i2c_reg_address) const; // NOLINT(build/unsigned)
  uint8_t read_i2c_atomic(uint32_t i2c_reg_address) const;                              // NOLINT(build/unsigned)
 
  void write_i2c(uint32_t i2c_device_address, // NOLINT(build/unsigned)
                 uint32_t i2c_reg_address,    // NOLINT(build/unsigned)
                 uint8_t data,                // NOLINT(build/unsigned)
                 bool send_stop = true) const;
  void write_i2c(uint32_t i2c_reg_address, uint8_t data, bool send_stop = true) const; // NOLINT(build/unsigned)
 
  std::vector<uint8_t> read_i2cArray(uint32_t i2c_device_address,     // NOLINT(build/unsigned)
                                     uint32_t i2c_reg_address,        // NOLINT(build/unsigned)
                                     uint32_t number_of_words) const; // NOLINT(build/unsigned)
  std::vector<uint8_t> read_i2cArray(uint32_t i2c_reg_address,        // NOLINT(build/unsigned)
                                     uint32_t number_of_words) const; // NOLINT(build/unsigned)
  std::vector<uint8_t> read_i2cArray_atomic(uint32_t i2c_reg_address,        // NOLINT(build/unsigned)
                                            uint32_t number_of_words) const; // NOLINT(build/unsigned)
  std::vector<uint8_t> read_i2cArray_atomic(uint32_t i2c_device_address,     // NOLINT(build/unsigned)
                                            uint32_t i2c_reg_address,        // NOLINT(build/unsigned)
                                            uint32_t number_of_words) const; // NOLINT(build/unsigned)
  void write_i2cArray(uint32_t i2c_device_address, // NOLINT(build/unsigned)
                      uint32_t i2c_reg_address,    // NOLINT(build/unsigned)
                      std::vector<uint8_t> data,   // NOLINT(build/unsigned)
                      bool send_stop = true) const;
  void write_i2cArray(uint32_t i2c_reg_address,  // NOLINT(build/unsigned)
                      std::vector<uint8_t> data, // NOLINT(build/unsigned)
                      bool send_stop = true) const;
 
  std::vector<uint8_t> read_i2cPrimitive(uint32_t number_of_bytes) const;                 // NOLINT(build/unsigned)
  void write_i2cPrimitive(const std::vector<uint8_t>& data, bool send_stop = true) const; // NOLINT(build/unsigned)
 
  bool ping() const;
 
  std::string get_master_id() const;
 
protected:
  // Private constructor, accessible to I2CMaster
  I2CSlave(const I2CMasterNode* i2c_master, uint8_t i2c_device_address); // NOLINT(build/unsigned)
 
private:
  const I2CMasterNode* m_i2c_master;
 
  // slave address
  uint8_t m_i2c_device_address; // NOLINT(build/unsigned)
 
  friend class I2CMasterNode;
};
 
} // namespace timing
} // namespace dunedaq
 
#endif // TIMING_INCLUDE_TIMING_I2CSLAVE_HPP_