Macros
Status Codes

Macros

#define I2S_ALL_TRANSACTIONS_SUCCESS   (0x0001U)
 Successful status code returned by I2S driver functions. More...
 
#define I2S_TRANSACTION_SUCCESS   (0x0002U)
 Successful status code returned by I2S driver functions. More...
 
#define I2S_TIMEOUT_ERROR   (0x0100U)
 Error status code returned by I2S driver functions. More...
 
#define I2S_BUS_ERROR   (0x0200U)
 Error status code returned by I2S driver functions. More...
 
#define I2S_WS_ERROR   (0x0400U)
 Error status code returned by I2S driver functions. More...
 
#define I2S_PTR_READ_ERROR   (0x0800U)
 Error status code returned by I2S driver functions. More...
 
#define I2S_PTR_WRITE_ERROR   (0x1000U)
 Error status code returned by I2S driver functions. More...
 

Detailed Description

I2S_STATUS_* macros are general status codes used when user callback is called

Macro Definition Documentation

§ I2S_ALL_TRANSACTIONS_SUCCESS

#define I2S_ALL_TRANSACTIONS_SUCCESS   (0x0001U)

Successful status code returned by I2S driver functions.

I2S driver functions return I2S_ALL_TRANSACTION_SUCCESS if ALL the queued transactions were executed successfully.

§ I2S_TRANSACTION_SUCCESS

#define I2S_TRANSACTION_SUCCESS   (0x0002U)

Successful status code returned by I2S driver functions.

I2S driver functions return I2S_TRANSACTION_SUCCESS if ONE queued transaction was executed successfully.

§ I2S_TIMEOUT_ERROR

#define I2S_TIMEOUT_ERROR   (0x0100U)

Error status code returned by I2S driver functions.

I2S driver functions return I2S_TIMEOUT_ERROR if I2S module lost the audio clock. If this error has been raised, I2S module must be reseted and restarted.

§ I2S_BUS_ERROR

#define I2S_BUS_ERROR   (0x0200U)

Error status code returned by I2S driver functions.

I2S driver functions return I2S_BUS_ERROR if I2S module faced problem with the DMA bus (DMA transfer not completed in time). If this error has been raised, I2S module must be reseted and restarted.

§ I2S_WS_ERROR

#define I2S_WS_ERROR   (0x0400U)

Error status code returned by I2S driver functions.

I2S driver functions return I2S_WS_ERROR if I2S module detect noise on the WS signal. If this error has been raised, I2S module must be reseted and restarted.

§ I2S_PTR_READ_ERROR

#define I2S_PTR_READ_ERROR   (0x0800U)

Error status code returned by I2S driver functions.

I2S driver functions return I2S_PTR_READ_ERROR if I2S module ran out of data on the read interface (DMA pointer not loaded in time). If this error has been raised, I2S module must be reseted and restarted.

§ I2S_PTR_WRITE_ERROR

#define I2S_PTR_WRITE_ERROR   (0x1000U)

Error status code returned by I2S driver functions.

I2S driver functions return I2S_PTR_WRITE_ERROR if I2S module ran out of data on the write interface (DMA pointer not loaded in time). If this error has been raised, I2S module must be reseted and restarted.

© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale