Common helper functions for I2C driver

Collaboration diagram for Common helper functions for I2C driver:

Functions
void	I2CSupport_controllerFinish (I2C_HWAttrs const *hwAttrs)
	Function to send a finish command to the controller module. More...
void	I2CSupport_powerSetConstraint (void)
	Function to set power constraint.
void	I2CSupport_powerRelConstraint (void)
	Function to release power constraint.
int_fast16_t	I2CSupport_primeTransfer (I2C_Handle handle, I2C_Transaction *transaction)
	Function to initialize transfers. More...

Detailed Description

Overview

Refer to ti_drivers_I2C_Overview for a complete description of APIs and examples of use.

Function Documentation

I2CSupport_controllerFinish()

void I2CSupport_controllerFinish

(

I2C_HWAttrs const *

hwAttrs

)

Function to send a finish command to the controller module.

Parameters

[in]

hwAttrs

A pointer to an I2C_HWAttrs structure.

I2CSupport_primeTransfer()

int_fast16_t I2CSupport_primeTransfer	(	I2C_Handle	handle,
		I2C_Transaction *	transaction
	)

Function to initialize transfers.

Parameters

[in]	handle	An I2C_Handle returned from I2C_open().
[in]	transaction	A pointer to an I2C_Transaction.

Returns

Returns a status indicating success or failure of the transfer.

Return values

I2C_STATUS_SUCCESS	The transfer was successful.
I2C_STATUS_INCOMPLETE	I2C transaction is in progress or returned without completing.
I2C_STATUS_BUS_BUSY	I2C bus already in use by another I2C Controller.