Status Codes

Collaboration diagram for Status Codes:

Macros
#define	I2C_STATUS_SUCCESS   0
	Successful status code returned by I2C_control(). More...
#define	I2C_STATUS_ERROR   -1
	Generic error status code returned by I2C_control(). More...
#define	I2C_STATUS_UNDEFINEDCMD   -2
	An error status code returned by I2C_control() for undefined command codes. More...

Detailed Description

I2C_STATUS_* macros are general status codes returned by I2C_control()

I2CCC26XX_STATUS_* macros are command codes only defined in the I2CCC26XX.h driver implementation and need to:

#include <ti/drivers/i2c/I2CCC26XX.h>

I2CCC3200_STATUS_* macros are command codes only defined in the I2CCC3200.h driver implementation and need to:

#include <ti/drivers/i2c/I2CCC3200.h>

I2CEUSCIB_STATUS_* macros are command codes only defined in the I2CEUSCIB.h driver implementation and need to:

#include <ti/drivers/i2c/I2CEUSCIB.h>

I2CMSP432_STATUS_* macros are command codes only defined in the I2CMSP432.h driver implementation and need to:

#include <ti/drivers/i2c/I2CMSP432.h>

I2CTiva_STATUS_* macros are command codes only defined in the I2CTiva.h driver implementation and need to:

#include <ti/drivers/i2c/I2CTiva.h>

I2CUSCIB_STATUS_* macros are command codes only defined in the I2CUSCIB.h driver implementation and need to:

#include <ti/drivers/i2c/I2CUSCIB.h>

Macro Definition Documentation

#define I2C_STATUS_SUCCESS   0

Successful status code returned by I2C_control().

I2C_control() returns I2C_STATUS_SUCCESS if the control code was executed successfully.

#define I2C_STATUS_ERROR   -1

Generic error status code returned by I2C_control().

I2C_control() returns I2C_STATUS_ERROR if the control code was not executed successfully.

#define I2C_STATUS_UNDEFINEDCMD   -2

An error status code returned by I2C_control() for undefined command codes.

I2C_control() returns I2C_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.