Enumerated Types

group group_i2s_enums

Enums

enum cy_en_i2s_status_t

cy_en_i2s_status_t: I2S status definitions.

Values:

enumerator CY_I2S_SUCCESS

Successful.

enumerator CY_I2S_BAD_PARAM

One or more invalid parameters.

enum cy_en_i2s_alignment_t

cy_en_i2s_alignment_t: I2S data alignment.

Values:

enumerator CY_I2S_LEFT_JUSTIFIED

Left justified.

enumerator CY_I2S_I2S_MODE

I2S mode.

enumerator CY_I2S_TDM_MODE_A

TDM mode A.

enumerator CY_I2S_TDM_MODE_B

TDM mode B.

enum cy_en_i2s_len_t

cy_en_i2s_len_t: I2S channel/word length.

Values:

enumerator CY_I2S_LEN8

Channel/word length: 8 bit.

enumerator CY_I2S_LEN16

Channel/Word length: 16 bit.

enumerator CY_I2S_LEN18

Channel/Word length: 18 bit.

enumerator CY_I2S_LEN20

Channel/Word length: 20 bit.

enumerator CY_I2S_LEN24

Channel/Word length: 24 bit.

enumerator CY_I2S_LEN32

Channel/Word length: 32 bit.

enum cy_en_i2s_overhead_t

cy_en_i2s_overhead_t: I2S TX overhead value.

Values:

enumerator CY_I2S_OVHDATA_ZERO

Fill overhead bits by zeroes.

enumerator CY_I2S_OVHDATA_ONE

Fill overhead bits by ones.

enum cy_en_i2s_ws_pw_t

cy_en_i2s_ws_pw_t: I2S WS pulse width.

Values:

enumerator CY_I2S_WS_ONE_SCK_CYCLE

WS pulse width is one SCK cycle.

enumerator CY_I2S_WS_ONE_CHANNEL_LENGTH

WS pulse width is one channel length.