Status Codes

Macros
#define	I2S_STATUS_SUCCESS   (0)
	Successful status code returned by I2S_control(). More...
#define	I2S_STATUS_ERROR   (-1)
	Generic error status code returned by I2S_control(). More...
#define	I2S_STATUS_UNDEFINEDCMD   (-2)
	An error status code returned by I2S_control() for undefined command codes. More...

Detailed Description

I2S_STATUS_* macros are general status codes returned by I2S_control()

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

#include <ti/drivers/i2s/I2SCC32XXDMA.h>

Macro Definition Documentation

I2S_STATUS_SUCCESS

#define I2S_STATUS_SUCCESS   (0)

Successful status code returned by I2S_control().

I2S_control() returns I2S_STATUS_SUCCESS if the control code was executed successfully.

I2S_STATUS_ERROR

#define I2S_STATUS_ERROR   (-1)

Generic error status code returned by I2S_control().

I2S_control() returns I2S_STATUS_ERROR if the control code was not executed successfully.

I2S_STATUS_UNDEFINEDCMD

#define I2S_STATUS_UNDEFINEDCMD   (-2)

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

I2S_control() returns I2S_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.