arduino master i2c in plain c code More...

#include "ci2c.h"

Include dependency graph for ci2c.c:

Macros
#define	START 0x08

#define	REPEATED_START 0x10

#define	MT_SLA_ACK 0x18

#define	MT_SLA_NACK 0x20

#define	MT_DATA_ACK 0x28

#define	MT_DATA_NACK 0x30

#define	MR_SLA_ACK 0x40

#define	MR_SLA_NACK 0x48

#define	MR_DATA_ACK 0x50

#define	MR_DATA_NACK 0x58

#define	LOST_ARBTRTN 0x38

#define	TWI_STATUS (TWSR & 0xF8)

#define	setRegBit(r, b)
	set bit b in register r

#define	clrRegBit(r, b)
	clear bit b in register r

#define	invRegBit(r, b)
	invert bit b in register r

Functions
void	I2C_slave_init (I2C_SLAVE *slave, const uint8_t sl_addr, const I2C_INT_SIZE reg_sz)
	Init an I2C slave structure for cMI2C communication.

void	I2C_slave_set_rw_func (I2C_SLAVE *slave, const ci2c_fct_ptr func, const I2C_RW rw)
	Redirect slave I2C read/write function (if needed for advanced use)

bool	I2C_slave_set_addr (I2C_SLAVE *slave, const uint8_t sl_addr)
	Change I2C slave address.

bool	I2C_slave_set_reg_size (I2C_SLAVE *slave, const I2C_INT_SIZE reg_sz)
	Change I2C registers map size (for access)

void	I2C_init (const uint16_t speed)
	Enable I2c module on arduino board (including pull-ups, enabling of ACK, and setting clock frequency)

void	I2C_uninit ()
	Disable I2c module on arduino board (releasing pull-ups, and TWI control)

void	I2C_reset (void)
	I2C bus reset (Release SCL and SDA lines and re-enable module)

uint16_t	I2C_set_speed (const uint16_t speed)
	Change I2C frequency.

uint16_t	I2C_set_timeout (const uint16_t timeout)
	Change I2C ack timeout.

uint8_t	I2C_set_retries (const uint8_t retries)
	Change I2C message retries (in case of failure)

bool	I2C_is_busy (void)
	Get I2C busy status.

I2C_STATUS	I2C_write (I2C_SLAVE slave, const uint16_t reg_addr, uint8_t data, const uint16_t bytes)
	This function writes the provided data to the address specified.

I2C_STATUS	I2C_read (I2C_SLAVE slave, const uint16_t reg_addr, uint8_t data, const uint16_t bytes)
	This function reads data from the address specified and stores this data in the area provided by the pointer.

bool	I2C_start (void)
	Send start condition.

bool	I2C_stop (void)
	Send stop condition.

bool	I2C_wr8 (const uint8_t dat)
	Send byte on bus.

uint8_t	I2C_rd8 (const bool ack)
	Receive byte from bus.

bool	I2C_sndAddr (I2C_SLAVE *slave, const I2C_RW rw)
	Send I2C address.

Detailed Description

arduino master i2c in plain c code

Author: SMFSW

Copyright: MIT SMFSW (2017-2018)

Warning: Don't access (r/w) last 16b internal address byte alone right after init, this would lead to hazardous result (in such case, make a dummy read of addr 0 before)

Macro Definition Documentation

◆ clrRegBit

#define clrRegBit	(		r,
			b )

Value:

r &= (uint8_t) (~(1 << b))

clear bit b in register r

◆ invRegBit

#define invRegBit	(		r,
			b )

Value:

r ^= (1 << b)

invert bit b in register r

◆ LOST_ARBTRTN

#define LOST_ARBTRTN 0x38

◆ MR_DATA_ACK

#define MR_DATA_ACK 0x50

◆ MR_DATA_NACK

#define MR_DATA_NACK 0x58

◆ MR_SLA_ACK

#define MR_SLA_ACK 0x40

◆ MR_SLA_NACK

#define MR_SLA_NACK 0x48

◆ MT_DATA_ACK

#define MT_DATA_ACK 0x28

◆ MT_DATA_NACK

#define MT_DATA_NACK 0x30

◆ MT_SLA_ACK

#define MT_SLA_ACK 0x18

◆ MT_SLA_NACK

#define MT_SLA_NACK 0x20

◆ REPEATED_START

#define REPEATED_START 0x10

◆ setRegBit

#define setRegBit	(		r,
			b )

Value:

r |= (1 << b)

set bit b in register r

◆ START

#define START 0x08

◆ TWI_STATUS

#define TWI_STATUS (TWSR & 0xF8)

Function Documentation

◆ I2C_init()

void I2C_init ( const uint16_t speed )

Enable I2c module on arduino board (including pull-ups, enabling of ACK, and setting clock frequency)

Parameters

[in] speed - I2C bus speed in KHz

Returns: nothing

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_is_busy()

bool I2C_is_busy ( void )

Get I2C busy status.

Returns: true if busy

◆ I2C_rd8()

uint8_t I2C_rd8 ( const bool ack )

Receive byte from bus.

Parameters

[in] ack - true if wait for ack

Returns: true if data reception acknowledged (false otherwise)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_read()

I2C_STATUS I2C_read	(	I2C_SLAVE *	slave,
		const uint16_t	reg_addr,
		uint8_t *	data,
		const uint16_t	bytes )

This function reads data from the address specified and stores this data in the area provided by the pointer.

Parameters

[in,out]	slave	- pointer to the I2C slave structure
[in]	reg_addr	- register address in register map
[in,out]	data	- pointer to the first byte of a block of data to read
[in]	bytes	- indicates how many bytes of data to read

Returns: I2C_STATUS status of read attempt

Here is the caller graph for this function:

◆ I2C_reset()

void I2C_reset ( void )

I2C bus reset (Release SCL and SDA lines and re-enable module)

Returns: nothing

Here is the caller graph for this function:

◆ I2C_set_retries()

uint8_t I2C_set_retries ( const uint8_t retries )

Change I2C message retries (in case of failure)

Parameters

[in] retries - I2C number of retries (max of 8)

Returns: Configured number of retries

◆ I2C_set_speed()

uint16_t I2C_set_speed ( const uint16_t speed )

Change I2C frequency.

Parameters

[in] speed - I2C speed in KHz (max 400KHz on avr)

Returns: Configured bus speed

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_set_timeout()

uint16_t I2C_set_timeout ( const uint16_t timeout )

Change I2C ack timeout.

Parameters

[in] timeout - I2C ack timeout (500 ms max)

Returns: Configured timeout

◆ I2C_slave_init()

void I2C_slave_init	(	I2C_SLAVE *	slave,
		const uint8_t	sl_addr,
		const I2C_INT_SIZE	reg_sz )

Init an I2C slave structure for cMI2C communication.

Parameters

[in]	slave	- pointer to the I2C slave structure to init
[in]	sl_addr	- I2C slave address
[in]	reg_sz	- internal register map size

Returns: nothing

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_slave_set_addr()

bool I2C_slave_set_addr	(	I2C_SLAVE *	slave,
		const uint8_t	sl_addr )

Change I2C slave address.

Parameters

[in,out]	slave	- pointer to the I2C slave structure to init
[in]	sl_addr	- I2C slave address

Returns: true if new address set (false if address is >7Fh)

Here is the caller graph for this function:

◆ I2C_slave_set_reg_size()

bool I2C_slave_set_reg_size	(	I2C_SLAVE *	slave,
		const I2C_INT_SIZE	reg_sz )

Change I2C registers map size (for access)

Parameters

[in,out]	slave	- pointer to the I2C slave structure
[in]	reg_sz	- internal register map size

Returns: true if new size is correct (false otherwise and set to 16bit by default)

Here is the caller graph for this function:

◆ I2C_slave_set_rw_func()

void I2C_slave_set_rw_func	(	I2C_SLAVE *	slave,
		const ci2c_fct_ptr	func,
		const I2C_RW	rw )

Redirect slave I2C read/write function (if needed for advanced use)

Parameters

[in]	slave	- pointer to the I2C slave structure to init
[in]	func	- pointer to read/write function to affect
[in]	rw	- 0 = write function, 1 = read function

Returns: nothing

Here is the caller graph for this function:

◆ I2C_sndAddr()

bool I2C_sndAddr	(	I2C_SLAVE *	slave,
		const I2C_RW	rw )

Send I2C address.

Parameters

[in]	slave	- pointer to the I2C slave structure
[in]	rw	- read/write transaction

Returns: true if I2C chip address sent acknowledged (false otherwise)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_start()

bool I2C_start ( void )

Send start condition.

Returns: true if start condition acknowledged (false otherwise)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_stop()

bool I2C_stop ( void )

Send stop condition.

Returns: true if stop condition acknowledged (false otherwise)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_uninit()

void I2C_uninit ( )

Disable I2c module on arduino board (releasing pull-ups, and TWI control)

Returns: nothing

◆ I2C_wr8()

bool I2C_wr8 ( const uint8_t dat )

Send byte on bus.

Parameters

[in] dat - data to be sent

Returns: true if data sent acknowledged (false otherwise)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I2C_write()

I2C_STATUS I2C_write	(	I2C_SLAVE *	slave,
		const uint16_t	reg_addr,
		uint8_t *	data,
		const uint16_t	bytes )

This function writes the provided data to the address specified.

Parameters

[in,out]	slave	- pointer to the I2C slave structure
[in]	reg_addr	- register address in register map
[in]	data	- pointer to the first byte of a block of data to write
[in]	bytes	- indicates how many bytes of data to write

Returns: I2C_STATUS status of write attempt

Here is the caller graph for this function:

Variable Documentation

◆ busy

bool busy

true if already busy (in case of interrupts implementation)

◆ [struct]

struct { ... } cfg

◆ retries

uint8_t retries

i2c message retries when fail

◆ speed

I2C_SPEED speed

i2c bus speed

◆ start_wait

uint16_t start_wait

time start waiting for acknowledge

◆ timeout

uint16_t timeout

i2c timeout (ms)

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ clrRegBit

◆ invRegBit

◆ LOST_ARBTRTN

◆ MR_DATA_ACK

◆ MR_DATA_NACK

◆ MR_SLA_ACK

◆ MR_SLA_NACK

◆ MT_DATA_ACK

◆ MT_DATA_NACK

◆ MT_SLA_ACK

◆ MT_SLA_NACK

◆ REPEATED_START

◆ setRegBit

◆ START

◆ TWI_STATUS

Function Documentation

◆ I2C_init()

◆ I2C_is_busy()

◆ I2C_rd8()

◆ I2C_read()

◆ I2C_reset()

◆ I2C_set_retries()

◆ I2C_set_speed()

◆ I2C_set_timeout()

◆ I2C_slave_init()

◆ I2C_slave_set_addr()

◆ I2C_slave_set_reg_size()

◆ I2C_slave_set_rw_func()

◆ I2C_sndAddr()

◆ I2C_start()

◆ I2C_stop()

◆ I2C_uninit()

◆ I2C_wr8()

◆ I2C_write()

Variable Documentation

◆ busy

◆ [struct]

◆ retries

◆ speed

◆ start_wait

◆ timeout