aruna::driver::I2C_master Class Reference

#include <I2C_master.h>

Inheritance diagram for aruna::driver::I2C_master:

Public Member Functions
	I2C_master ()
	~I2C_master ()
err_t	write (uint8_t address, uint8_t reg, uint8_t *data, size_t data_size)
	Write data to the I²C bus. More...
err_t	write (uint8_t address, uint8_t reg, uint8_t data)
	Write single byte to the I²C bus. More...
err_t	read (uint8_t address, uint8_t reg, uint8_t *buffer, size_t buffer_size)
	Read data from I²C slave. More...
err_t	read (uint8_t address, uint8_t reg, uint8_t &buffer)
	Read single byte from I²C slave. More...
err_t	lock (uint8_t i2c_address)
err_t	try_lock (uint8_t i2c_address)
err_t	unlock (uint8_t i2c_address)

Private Member Functions
virtual err_t	_write (uint8_t address, uint8_t reg, uint8_t *data, size_t data_size)=0
virtual err_t	_read (uint8_t address, uint8_t reg, uint8_t *buffer, size_t buffer_size)=0

Private Attributes
pthread_mutex_t	line_busy
pthread_mutexattr_t	line_busy_attr

Detailed Description

Definition at line 12 of file I2C_master.h.

Constructor & Destructor Documentation

I2C_master()

aruna::driver::I2C_master::I2C_master

(

)

Definition at line 23 of file I2C_master.cpp.

                                  {
    pthread_mutexattr_init(&line_busy_attr);
    pthread_mutex_init(&line_busy, &line_busy_attr);
}

~I2C_master()

aruna::driver::I2C_master::~I2C_master

(

)

Definition at line 28 of file I2C_master.cpp.

                                   {
    pthread_mutex_destroy(&line_busy);
    pthread_mutexattr_destroy(&line_busy_attr);
}

Member Function Documentation

_read()

virtual err_t aruna::driver::I2C_master::_read ( uint8_t  address, uint8_t  reg, uint8_t *  buffer, size_t  buffer_size  )

privatepure virtual

Implemented in aruna::driver::ESP32_I2C_master.

Here is the caller graph for this function:

_write()

virtual err_t aruna::driver::I2C_master::_write ( uint8_t  address, uint8_t  reg, uint8_t *  data, size_t  data_size  )

privatepure virtual

Implemented in aruna::driver::ESP32_I2C_master.

Here is the caller graph for this function:

lock()

aruna::err_t aruna::driver::I2C_master::lock

(

uint8_t

i2c_address

)

Definition at line 41 of file I2C_master.cpp.

                                                          {
//   TODO
    return aruna::err_t::OK;
}

Here is the caller graph for this function:

read() [1/2]

aruna::err_t aruna::driver::I2C_master::read	(	uint8_t	address,
		uint8_t	reg,
		uint8_t *	buffer,
		size_t	buffer_size
	)

Read data from I²C slave.

Parameters

address	slave address
reg	register to write to
buffer	buffer to store read data
buffer_size	amount of bytes to read.

Returns

• err_t::OK success
• err_t::NO_RESPONSE slave doesn't ACK the transfer
• err_t::INVALID_PARAMETERS parameter error
• err_t::HARDWARE_FAILURE I2C driver malfunction

Definition at line 7 of file I2C_master.cpp.

                                                                                                        {
    pthread_mutex_lock(&line_busy);
    err_t ret;
    ret = _read(address, reg, buffer, buffer_size);
    pthread_mutex_unlock(&line_busy);
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

read() [2/2]

aruna::err_t aruna::driver::I2C_master::read	(	uint8_t	address,
		uint8_t	reg,
		uint8_t &	buffer
	)

Read single byte from I²C slave.

Parameters

address	slave address
reg	register to write to
buffer	buffer to store read data

Returns

• err_t::OK success
• err_t::NO_RESPONSE slave doesn't ACK the transfer
• err_t::INVALID_PARAMETERS parameter error
• err_t::HARDWARE_FAILURE I2C driver malfunction

Definition at line 37 of file I2C_master.cpp.

                                                                                    {
    return read(address, reg, &buffer, 1);
}

Here is the call graph for this function:

try_lock()

aruna::err_t aruna::driver::I2C_master::try_lock

(

uint8_t

i2c_address

)

Definition at line 46 of file I2C_master.cpp.

                                                              {
    //   TODO
    return aruna::err_t::OK;
}

unlock()

aruna::err_t aruna::driver::I2C_master::unlock

(

uint8_t

i2c_address

)

Definition at line 51 of file I2C_master.cpp.

                                                            {
    //   TODO
    return aruna::err_t::OK;
}

Here is the caller graph for this function:

write() [1/2]

aruna::err_t aruna::driver::I2C_master::write	(	uint8_t	address,
		uint8_t	reg,
		uint8_t *	data,
		size_t	data_size
	)

Write data to the I²C bus.

Parameters

address	slave address
reg	register to write to
data	data array to be written.
data_size	number of bytes in data

Returns

• err_t::OK success
• err_t::NO_RESPONSE slave doesn't ACK the transfer
• err_t::INVALID_PARAMETERS parameter error
• err_t::HARDWARE_FAILURE I2C driver malfunction

Definition at line 15 of file I2C_master.cpp.

                                                                                                     {
    pthread_mutex_lock(&line_busy);
    err_t ret;
    ret = _write(address, reg, data, data_size);
    pthread_mutex_unlock(&line_busy);
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

write() [2/2]

aruna::err_t aruna::driver::I2C_master::write	(	uint8_t	address,
		uint8_t	reg,
		uint8_t	data
	)

Write single byte to the I²C bus.

Parameters

address	slave address
reg	register to write to
data	8 bits to be written.

Returns

• err_t::OK success
• err_t::NO_RESPONSE slave doesn't ACK the transfer
• err_t::INVALID_PARAMETERS parameter error
• err_t::HARDWARE_FAILURE I2C driver malfunction

Definition at line 33 of file I2C_master.cpp.

                                                                                  {
    return write(address, reg, &data, 1);
}

Here is the call graph for this function:

Member Data Documentation

line_busy

pthread_mutex_t aruna::driver::I2C_master::line_busy

private

Definition at line 14 of file I2C_master.h.

line_busy_attr

pthread_mutexattr_t aruna::driver::I2C_master::line_busy_attr

private

Definition at line 15 of file I2C_master.h.

---

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

• include/aruna/driver/I2C_master.h
• src/driver/I2C_master.cpp