dunedaq::timing::I2CSlave Class Reference

#include <I2CSlave.hpp>

Inheritance diagram for dunedaq::timing::I2CSlave:

Collaboration diagram for dunedaq::timing::I2CSlave:

Public Member Functions
virtual	~I2CSlave ()
uint8_t	get_i2c_address () const
uint8_t	read_i2c (uint32_t i2c_device_address, uint32_t i2c_reg_address) const
	comodity functions
uint8_t	read_i2c (uint32_t i2c_reg_address) const
void	write_i2c (uint32_t i2c_device_address, uint32_t i2c_reg_address, uint8_t data, bool send_stop=true) const
void	write_i2c (uint32_t i2c_reg_address, uint8_t data, bool send_stop=true) const
std::vector< uint8_t >	read_i2cArray (uint32_t i2c_device_address, uint32_t i2c_reg_address, uint32_t number_of_words) const
std::vector< uint8_t >	read_i2cArray (uint32_t i2c_reg_address, uint32_t number_of_words) const
void	write_i2cArray (uint32_t i2c_device_address, uint32_t i2c_reg_address, std::vector< uint8_t > data, bool send_stop=true) const
void	write_i2cArray (uint32_t i2c_reg_address, std::vector< uint8_t > data, bool send_stop=true) const
std::vector< uint8_t >	read_i2cPrimitive (uint32_t number_of_bytes) const
void	write_i2cPrimitive (const std::vector< uint8_t > &data, bool send_stop=true) const
bool	ping () const
std::string	get_master_id () const

Protected Member Functions
	I2CSlave (const I2CMasterNode *i2c_master, uint8_t i2c_device_address)

Private Attributes
const I2CMasterNode *	m_i2c_master
uint8_t	m_i2c_device_address

Friends
class	I2CMasterNode

Detailed Description

Definition at line 41 of file I2CSlave.hpp.

Constructor & Destructor Documentation

~I2CSlave()

I2CSlave::~I2CSlave ( )

virtual

Definition at line 40 of file I2CSlave.cpp.

{}

I2CSlave()

I2CSlave::I2CSlave ( const I2CMasterNode * i2c_master, uint8_t i2c_device_address )

protected

Definition at line 33 of file I2CSlave.cpp.

  : m_i2c_master(i2c_master)
  , m_i2c_device_address(i2c_device_address)
{}

Member Function Documentation

get_i2c_address()

uint8_t dunedaq::timing::I2CSlave::get_i2c_address ( ) const

inline

Definition at line 47 of file I2CSlave.hpp.

{ return m_i2c_device_address; } // NOLINT(build/unsigned)

get_master_id()

std::string I2CSlave::get_master_id

(

)

const

Definition at line 145 of file I2CSlave.cpp.

{
  return m_i2c_master->getId();
}

ping()

bool I2CSlave::ping

(

)

const

Definition at line 137 of file I2CSlave.cpp.

{
  return m_i2c_master->ping(m_i2c_device_address);
}

read_i2c() [1/2]

uint8_t I2CSlave::read_i2c	(	uint32_t	i2c_device_address,
		uint32_t	i2c_reg_address ) const

comodity functions

Definition at line 46 of file I2CSlave.cpp.

{
  return m_i2c_master->read_i2c(i2c_device_address, i2c_reg_address);
}

read_i2c() [2/2]

uint8_t I2CSlave::read_i2c

(

uint32_t

i2c_reg_address

)

const

Definition at line 54 of file I2CSlave.cpp.

{
  return m_i2c_master->read_i2c(m_i2c_device_address, i2c_reg_address);
}

read_i2cArray() [1/2]

std::vector< uint8_t > I2CSlave::read_i2cArray	(	uint32_t	i2c_device_address,
		uint32_t	i2c_reg_address,
		uint32_t	number_of_words ) const

Definition at line 81 of file I2CSlave.cpp.

{
  return m_i2c_master->read_i2cArray(i2c_device_address, i2c_reg_address, number_of_words);
}

read_i2cArray() [2/2]

std::vector< uint8_t > I2CSlave::read_i2cArray	(	uint32_t	i2c_reg_address,
		uint32_t	number_of_words ) const

Definition at line 91 of file I2CSlave.cpp.

{
  return m_i2c_master->read_i2cArray(m_i2c_device_address, i2c_reg_address, number_of_words);
}

read_i2cPrimitive()

std::vector< uint8_t > I2CSlave::read_i2cPrimitive

(

uint32_t

number_of_bytes

)

const

Definition at line 121 of file I2CSlave.cpp.

{
  return m_i2c_master->read_i2cPrimitive(m_i2c_device_address, number_of_bytes);
}

write_i2c() [1/2]

void I2CSlave::write_i2c	(	uint32_t	i2c_device_address,
		uint32_t	i2c_reg_address,
		uint8_t	data,
		bool	send_stop = true ) const

Definition at line 62 of file I2CSlave.cpp.

{
  m_i2c_master->write_i2c(i2c_device_address, i2c_reg_address, data, send_stop);
}

write_i2c() [2/2]

void I2CSlave::write_i2c	(	uint32_t	i2c_reg_address,
		uint8_t	data,
		bool	send_stop = true ) const

Definition at line 73 of file I2CSlave.cpp.

{
  m_i2c_master->write_i2c(m_i2c_device_address, i2c_reg_address, data, send_stop);
}

write_i2cArray() [1/2]

void I2CSlave::write_i2cArray	(	uint32_t	i2c_device_address,
		uint32_t	i2c_reg_address,
		std::vector< uint8_t >	data,
		bool	send_stop = true ) const

Definition at line 99 of file I2CSlave.cpp.

{
  m_i2c_master->write_i2cArray(i2c_device_address, i2c_reg_address, data, send_stop);
}

write_i2cArray() [2/2]

void I2CSlave::write_i2cArray	(	uint32_t	i2c_reg_address,
		std::vector< uint8_t >	data,
		bool	send_stop = true ) const

Definition at line 110 of file I2CSlave.cpp.

{
  m_i2c_master->write_i2cArray(m_i2c_device_address, i2c_reg_address, data, send_stop);
}

write_i2cPrimitive()

void I2CSlave::write_i2cPrimitive	(	const std::vector< uint8_t > &	data,
		bool	send_stop = true ) const

Definition at line 129 of file I2CSlave.cpp.

{
  m_i2c_master->write_i2cPrimitive(m_i2c_device_address, data, send_stop);
}

Friends And Related Symbol Documentation

I2CMasterNode

friend class I2CMasterNode

friend

Definition at line 90 of file I2CSlave.hpp.

Member Data Documentation

m_i2c_device_address

uint8_t dunedaq::timing::I2CSlave::m_i2c_device_address

private

Definition at line 88 of file I2CSlave.hpp.

m_i2c_master

const I2CMasterNode* dunedaq::timing::I2CSlave::m_i2c_master

private

Definition at line 85 of file I2CSlave.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/timing/include/timing/I2CSlave.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/I2CSlave.cpp