Enumerated Types

General Description

Enumerations
enum	cy_en_i2s_status_t {   CY_I2S_SUCCESS = 0x00UL,   CY_I2S_BAD_PARAM = CY_I2S_ID | CY_PDL_STATUS_ERROR | 0x01UL }
	I2S status definitions. More...
enum	cy_en_i2s_alignment_t {   CY_I2S_LEFT_JUSTIFIED = 0U,   CY_I2S_I2S_MODE = 1U,   CY_I2S_TDM_MODE_A = 2U,   CY_I2S_TDM_MODE_B = 3U }
	I2S data alignment. More...
enum	cy_en_i2s_len_t {   CY_I2S_LEN8 = 0U,   CY_I2S_LEN16 = 1U,   CY_I2S_LEN18 = 2U,   CY_I2S_LEN20 = 3U,   CY_I2S_LEN24 = 4U,   CY_I2S_LEN32 = 5U }
	I2S channel/word length. More...
enum	cy_en_i2s_overhead_t {   CY_I2S_OVHDATA_ZERO = 0U,   CY_I2S_OVHDATA_ONE = 1U }
	I2S TX overhead value. More...
enum	cy_en_i2s_ws_pw_t {   CY_I2S_WS_ONE_SCK_CYCLE = 0U,   CY_I2S_WS_ONE_CHANNEL_LENGTH = 1U }
	I2S WS pulse width. More...

Enumeration Type Documentation

cy_en_i2s_status_t

enum cy_en_i2s_status_t

I2S status definitions.

Enumerator
CY_I2S_SUCCESS	Successful.
CY_I2S_BAD_PARAM	One or more invalid parameters.

cy_en_i2s_alignment_t

enum cy_en_i2s_alignment_t

I2S data alignment.

Enumerator
CY_I2S_LEFT_JUSTIFIED	Left justified.
CY_I2S_I2S_MODE	I2S mode.
CY_I2S_TDM_MODE_A	TDM mode A.
CY_I2S_TDM_MODE_B	TDM mode B.

cy_en_i2s_len_t

enum cy_en_i2s_len_t

I2S channel/word length.

Enumerator
CY_I2S_LEN8	Channel/word length: 8 bit.
CY_I2S_LEN16	Channel/Word length: 16 bit.
CY_I2S_LEN18	Channel/Word length: 18 bit.
CY_I2S_LEN20	Channel/Word length: 20 bit.
CY_I2S_LEN24	Channel/Word length: 24 bit.
CY_I2S_LEN32	Channel/Word length: 32 bit.

cy_en_i2s_overhead_t

enum cy_en_i2s_overhead_t

I2S TX overhead value.

Enumerator
CY_I2S_OVHDATA_ZERO	Fill overhead bits by zeroes.
CY_I2S_OVHDATA_ONE	Fill overhead bits by ones.

cy_en_i2s_ws_pw_t

enum cy_en_i2s_ws_pw_t

I2S WS pulse width.

Enumerator
CY_I2S_WS_ONE_SCK_CYCLE	WS pulse width is one SCK cycle.
CY_I2S_WS_ONE_CHANNEL_LENGTH	WS pulse width is one channel length.