#include <modm/driver/storage/cat24aa.hpp>

Inheritance diagram for modm::Cat24Aa< I2cMaster >:

Public Member Functions
modm::ResumableResult< bool >	writeByte (uint32_t address, uint8_t data)

modm::ResumableResult< bool >	write (uint32_t address, const uint8_t *data, std::size_t length)

template<typename T >
modm::ResumableResult< bool >	write (uint32_t address, const T &data)

modm::ResumableResult< bool >	readByte (uint32_t address, uint8_t &data)
	Read byte.

modm::ResumableResult< bool >	read (uint32_t address, uint8_t *data, std::size_t length)
	Read block.

template<typename T >
modm::ResumableResult< bool >	read (uint16_t address, T &data)

void	attachConfigurationHandler (I2c::ConfigurationHandler handler)

modm::ResumableResult< bool >	ping ()

void	setAddress (uint8_t address)

Protected Member Functions
modm::ResumableResult< ReturnType > resumable	function (...)

int8_t	getResumableDepth () const

bool	isResumableRunning () const

bool	isTransactionRunning ()

modm::ResumableResult< bool >	runTransaction ()
	Starts our own transaction and waits until finished.

bool	startRead (uint8_t *buffer, std::size_t size)
	Configures the transaction with a read operation and starts it.

bool	startTransaction ()
	Starts the transaction with our own transaction object.

bool	startTransaction (modm::I2cTransaction *transaction)
	Starts the transaction with a seperate transaction object.

bool	startWrite (const uint8_t *buffer, std::size_t size)
	Configures the transaction with a write operation and starts it.

bool	startWriteRead (const uint8_t writeBuffer, std::size_t writeSize, uint8_t readBuffer, std::size_t readSize)
	Configures the transaction with a write/read operation and starts it.

void	stopResumable ()
	Force all resumable functions to stop running at the current nesting level.

bool	wasTransactionSuccessful ()

Protected Attributes
cat24Aa::DataTransmissionAdapter	transaction

Detailed Description

template<typename I2cMaster>
class modm::Cat24Aa< I2cMaster >

I2C Eeprom CAT24AA

Driver for OnSemi CAT24AA Eeprom. I2C eeprom with an 11-bit address pointer, encoded in 3 bits of the device slave address plus the address byte. Base address is fixed to 0x50.

Author: Mike Wolfram

Member Function Documentation

void modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::attachConfigurationHandler ( I2c::ConfigurationHandler handler )

inheritedinline

Attaches a configuration handler, which is called before a transaction, whenever the configuration has to be changed.

modm::ResumableResult< ReturnType > resumable modm::NestedResumable< 1 >::function ( ... )

inherited

Run the resumable function.

You need to implement this method in you subclass yourself.

Returns: >NestingError if still running, <=NestingError if it has finished.

int8_t modm::NestedResumable< 1 >::getResumableDepth ( ) const

inheritedinline

Returns: the nesting depth in the current resumable function, or -1 if called outside any resumable function

bool modm::NestedResumable< 1 >::isResumableRunning ( ) const

inheritedinline

Returns: true if a resumable function is running at the current nesting level, else false

bool modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::isTransactionRunning ( )

inheritedinlineprotected

Returns: true when transaction is busy.

modm::ResumableResult<bool> modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::ping ( )

inheritedinline

Return Values

true	device responds to address
false	no device with address found

template<typename I2cMaster >

template<typename T >

modm::ResumableResult<bool> modm::Cat24Aa< I2cMaster >::read	(	uint16_t	address,
		T &	data
	)

inline

Convenience function

Shortcut for:

return read(address, static_cast<uint8_t *>(&data), sizeof(T));

void modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::setAddress ( uint8_t address )

inheritedinline

Sets a new address of the slave device.

Parameters

address the slave address not yet shifted left (address < 128).

bool modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::wasTransactionSuccessful ( )

inheritedinlineprotected

Returns: true when transaction did not return an error.

template<typename I2cMaster >

template<typename T >

modm::ResumableResult<bool> modm::Cat24Aa< I2cMaster >::write	(	uint32_t	address,
		const T &	data
	)

inline

Convenience function

Shortcut for:

return write(address, static_cast<const uint8_t *>(&data), sizeof(T));

template<typename I2cMaster >

modm::ResumableResult<bool> modm::Cat24Aa< I2cMaster >::write	(	uint32_t	address,
		const uint8_t *	data,
		std::size_t	length
	)

Write block

Parameters

address	Address
data	Data block
length	Number of bytes to be written

Returns: true if the data could be written, false otherwise

template<typename I2cMaster >

modm::ResumableResult<bool> modm::Cat24Aa< I2cMaster >::writeByte	(	uint32_t	address,
		uint8_t	data
	)

inline

Write byte

Parameters

address	Address
data	Data byte

Returns: true if the data could be written, false otherwise

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

cat24aa.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename I2cMaster> class modm::Cat24Aa< I2cMaster >

Member Function Documentation

template<typename I2cMaster>
class modm::Cat24Aa< I2cMaster >