I2C.h File Reference

I2C function to read-write the I2C bus, based on DRAMCO code. More...

#include <stdbool.h>

Include dependency graph for I2C.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	IIC_Init (void)
	Setup I2C functionality. More...
void	IIC_Reset (void)
	Resets the I2C interface. More...
bool	IIC_WriteBuffer (uint8_t iicAddress, uint8_t *wBuffer, uint8_t wLength)
	I2C write functionality. More...
bool	IIC_ReadBuffer (uint8_t iicAddress, uint8_t *rBuffer, uint8_t rLength)
	I2C read functionality. More...
bool	IIC_WriteReadBuffer (uint8_t iicAddress, uint8_t *wBuffer, uint8_t wLength, uint8_t *rBuffer, uint8_t rLength)
	I2C read/write functionality, to read and write at the same time. More...
void	IIC_Enable (bool enable)

Detailed Description

I2C function to read-write the I2C bus, based on DRAMCO code.

Version

1.0

Author

Jona Cappelle

Definition in file I2C.h.

Function Documentation

IIC_Enable()

void IIC_Enable

(

bool

enable

)

Definition at line 71 of file I2C.c.

{
    if (enable)
    {
        GPIO_PinModeSet(ICM_20948_SDA_PORT, ICM_20948_SDA_PIN, gpioModeWiredAndPullUp, 1);
        GPIO_PinModeSet(ICM_20948_SCL_PORT, ICM_20948_SCL_PIN, gpioModeWiredAndPullUp, 1);
    }
    else
    {
        GPIO_PinModeSet(ICM_20948_SDA_PORT, ICM_20948_SDA_PIN, gpioModeDisabled, 1);
        GPIO_PinModeSet(ICM_20948_SCL_PORT, ICM_20948_SCL_PIN, gpioModeDisabled, 1);
    }
}

References ICM_20948_SCL_PIN, ICM_20948_SCL_PORT, ICM_20948_SDA_PIN, and ICM_20948_SDA_PORT.

IIC_Init()

void IIC_Init

(

void

)

Setup I2C functionality.

Definition at line 52 of file I2C.c.

                   {
 
    /* We use the standard I2C pins and ports, so no need to adjust */
    /*
    i2cInit.port = I2C0;
    i2cInit.sclPort = gpioPortD;
    i2cInit.sclPin = 7;
    i2cInit.sdaPort = gpioPortD;
    i2cInit.sdaPin = 6;
    i2cInit.i2cClhr = i2cClockHLRStandard;
    i2cInit.i2cRefFreq = 0 ;
    i2cInit.i2cMaxFreq = I2C_FREQ_STANDARD_MAX;
    i2cInit.portLocation = I2C_PORT_LOCATION; //zie datasheet �controller (hashtag getal in pinout)
*/
//i2cInit.i2cMaxFreq = I2C_FREQ_FAST_MAX;
 
    I2CSPM_Init(&i2cInit);
}

References i2cInit.

Referenced by ICM_20948_Init().

IIC_ReadBuffer()

bool IIC_ReadBuffer	(	uint8_t	iicAddress,
		uint8_t *	rBuffer,
		uint8_t	rLength
	)

I2C read functionality.

Parameters

[in]	iicAddress	10bit I2C address
[in]	regCommand	Address that needs to be read
[in]	rBuffer	Address where the read data needs to be stored
[in]	rLength	Length of the data that has to be read

Definition at line 152 of file I2C.c.

                                                                           {
    I2C_TransferSeq_TypeDef seq;
    I2C_TransferReturn_TypeDef ret;
 
    seq.addr  = iicAddress;
    seq.flags = I2C_FLAG_READ;
 
    /* Select location/length of data to be read */
    seq.buf[0].data = rBuffer;
    seq.buf[0].len  = rLength;
 
    ret = I2CSPM_Transfer(i2cInit.port, &seq);
 
    if (ret != i2cTransferDone) {
        *rBuffer = 0;
        return false;
    }
    return true;
}

References i2cInit.

IIC_Reset()

void IIC_Reset

(

void

)

Resets the I2C interface.

Note

Normally not needed, just in case

Parameters

[in]

void

Definition at line 94 of file I2C.c.

                    {
    I2C_Reset(i2cInit.port);
}

References i2cInit.

IIC_WriteBuffer()

bool IIC_WriteBuffer	(	uint8_t	iicAddress,
		uint8_t *	wBuffer,
		uint8_t	wLength
	)

I2C write functionality.

Parameters

[in]	iicAddress	10bit I2C address
[in]	wBuffer	Address where the data is that needs to be written
[in]	wLength	Length of the data that has to be written

Definition at line 112 of file I2C.c.

                                                                            {
    I2C_TransferSeq_TypeDef seq;
    I2C_TransferReturn_TypeDef ret;
    uint8_t i2c_read_data[0];
 
    seq.addr  = iicAddress;
    seq.flags = I2C_FLAG_WRITE;
    /* Point to write buffer (contains command & data) */
    seq.buf[0].data   = wBuffer;
    seq.buf[0].len    = wLength;
    /* Select location/length of data to be read */
    seq.buf[1].data = i2c_read_data;
    seq.buf[1].len  = 0;
 
    ret = I2CSPM_Transfer(i2cInit.port, &seq);
 
    if (ret != i2cTransferDone) {
        return false;
    }
 
    return true;
}

References i2cInit.

Referenced by ICM_20948_bankSelect(), ICM_20948_registerWrite(), and ICM_20948_write_mag_register().

IIC_WriteReadBuffer()

bool IIC_WriteReadBuffer	(	uint8_t	iicAddress,
		uint8_t *	wBuffer,
		uint8_t	wLength,
		uint8_t *	rBuffer,
		uint8_t	rLength
	)

I2C read/write functionality, to read and write at the same time.

Parameters

[in]	iicAddress	10bit I2C address
[in]	regCommand	Address that needs to be read
[in]	rBuffer	Address where the read data needs to be stored
[in]	rLength	Length of the data that has to be read

Definition at line 190 of file I2C.c.

                                                                                                                   {
    I2C_TransferSeq_TypeDef seq;
    I2C_TransferReturn_TypeDef ret;
 
    seq.addr  = iicAddress;
    seq.flags = I2C_FLAG_WRITE_READ;
    /* Point to write buffer (contains command & data) */
    seq.buf[0].data   = wBuffer;
    seq.buf[0].len    = wLength;
 
    /* Select location/length of data to be read */
    seq.buf[1].data = rBuffer;
    seq.buf[1].len  = rLength;
 
    ret = I2CSPM_Transfer(i2cInit.port, &seq);
 
    if (ret != i2cTransferDone) {
        *rBuffer = 0;
        return false;
    }
 
    return true;
}

References i2cInit.

Referenced by ICM_20948_read_mag_register(), and ICM_20948_registerRead().