 |
PSoC 6 Peripheral Driver Library
|
|
PSoC 6 Peripheral Driver Library
|
I2S initialization configuration.
Data Fields | |
| bool | txEnabled |
| Enables the I2S TX component: 'false': disabled. More... | |
| bool | rxEnabled |
| Enables the I2S RX component: 'false': disabled. More... | |
| bool | txDmaTrigger |
| 'false': TX DMA trigger disabled, 'true': TX DMA trigger enabled. More... | |
| bool | rxDmaTrigger |
| 'false': RX DMA trigger disabled, 'true': RX DMA trigger enabled. More... | |
| uint8_t | clkDiv |
| CLK_SEL divider: 1: Bypass, 2: 1/2, 3: 1/3, ..., 64: 1/64. More... | |
| bool | extClk |
| 'false': internal clock, 'true': external clock. More... | |
| bool | txMasterMode |
| 'false': TX in slave mode, 'true': TX in master mode. More... | |
| cy_en_i2s_alignment_t | txAlignment |
| TX data alignment, see: cy_en_i2s_alignment_t. More... | |
| cy_en_i2s_ws_pw_t | txWsPulseWidth |
| TX Word Select pulse width. More... | |
| bool | txWatchdogEnable |
| 'false': TX watchdog disabled, 'true': TX watchdog enabled. More... | |
| uint32_t | txWatchdogValue |
| TX watchdog counter value (32 bit). More... | |
| bool | txSdoLatchingTime |
| 'false': SDO bit starts at falling edge (accordingly to the I2S Standard, if txSckoInversion is false), 'true': SDO bit starts at rising edge which goes before the above mentioned falling edge, i.e. More... | |
| bool | txSckoInversion |
| TX SCKO polarity: 'false': When transmitter is in master mode, serial data is transmitted off the falling bit clock edge (accordingly to the I2S Standard); 'true': When transmitter is in master mode, serial data is transmitted off the rising bit clock edge. More... | |
| bool | txSckiInversion |
| TX SCKI polarity: 'false': When transmitter is in slave mode, serial data is transmitted off the falling bit clock edge (accordingly to the I2S Standard); 'true': When transmitter is in slave mode, serial data is transmitted off the rising bit clock edge. More... | |
| uint8_t | txChannels |
| Number of TX channels, valid range is 1...8 for TDM modes. More... | |
| cy_en_i2s_len_t | txChannelLength |
| TX channel length, see cy_en_i2s_len_t, the value of this parameter is ignored in TDM modes, the real channel length is 32 bit in these modes. More... | |
| cy_en_i2s_len_t | txWordLength |
| TX word length, see cy_en_i2s_len_t, must be less or equal to txChannelLength. More... | |
| cy_en_i2s_overhead_t | txOverheadValue |
| TX overhead bits value when the word length is less than the channel length. More... | |
| uint8_t | txFifoTriggerLevel |
| TX FIFO interrupt trigger level (0, 1, ..., 255). More... | |
| bool | rxMasterMode |
| 'false': RX in slave mode, 'true': RX in master mode. More... | |
| cy_en_i2s_alignment_t | rxAlignment |
| RX data alignment, see: cy_en_i2s_alignment_t. More... | |
| cy_en_i2s_ws_pw_t | rxWsPulseWidth |
| RX Word Select pulse width. More... | |
| bool | rxWatchdogEnable |
| 'false': RX watchdog disabled, 'true': RX watchdog enabled. More... | |
| uint32_t | rxWatchdogValue |
| RX watchdog counter value (32 bit). More... | |
| bool | rxSdiLatchingTime |
| 'false': SDI bit starts at falling edge (accordingly to the I2S Standard if rxSckoInversion is false), 'true': SDI bit starts at rising edge that goes after the above mentioned falling edge, i.e. More... | |
| bool | rxSckoInversion |
| RX SCKO polarity: 'false': When receiver is in master mode, serial data is captured by the rising bit clock edge (accordingly to the I2S Standard); 'true': When receiver is in master mode, serial data is captured by the falling bit clock edge. More... | |
| bool | rxSckiInversion |
| RX SCKI polarity: 'false': When receiver is in slave mode, serial data is captured by the rising bit clock edge (accordingly to the I2S Standard); 'true': When receiver is in slave mode, serial data is captured by the falling bit clock edge. More... | |
| uint8_t | rxChannels |
| Number of RX channels, valid range is 1...8 for TDM modes. More... | |
| cy_en_i2s_len_t | rxChannelLength |
| RX channel length, see cy_en_i2s_len_t, the value of this parameter is ignored in TDM modes, the real channel length is 32 bit in these modes. More... | |
| cy_en_i2s_len_t | rxWordLength |
| RX word length, see cy_en_i2s_len_t, must be less or equal to rxChannelLength. More... | |
| bool | rxSignExtension |
| RX value sign extension (when the word length is less than 32 bits), 'false': all MSB are filled by zeroes, 'true': all MSB are filled by the original sign bit value. More... | |
| uint8_t | rxFifoTriggerLevel |
| RX FIFO interrupt trigger level (0, 1, ..., (255 - (number of channels))). More... | |
| bool cy_stc_i2s_config_t::txEnabled |
Enables the I2S TX component: 'false': disabled.
'true': enabled.
| bool cy_stc_i2s_config_t::rxEnabled |
Enables the I2S RX component: 'false': disabled.
'true': enabled.
| bool cy_stc_i2s_config_t::txDmaTrigger |
'false': TX DMA trigger disabled, 'true': TX DMA trigger enabled.
| bool cy_stc_i2s_config_t::rxDmaTrigger |
'false': RX DMA trigger disabled, 'true': RX DMA trigger enabled.
| uint8_t cy_stc_i2s_config_t::clkDiv |
CLK_SEL divider: 1: Bypass, 2: 1/2, 3: 1/3, ..., 64: 1/64.
| bool cy_stc_i2s_config_t::extClk |
'false': internal clock, 'true': external clock.
| bool cy_stc_i2s_config_t::txMasterMode |
'false': TX in slave mode, 'true': TX in master mode.
| cy_en_i2s_alignment_t cy_stc_i2s_config_t::txAlignment |
TX data alignment, see: cy_en_i2s_alignment_t.
| cy_en_i2s_ws_pw_t cy_stc_i2s_config_t::txWsPulseWidth |
TX Word Select pulse width.
The value of this parameter is ignored in I2S and Left Justified modes the WS pulse width is always "one channel length" in these modes.
| bool cy_stc_i2s_config_t::txWatchdogEnable |
'false': TX watchdog disabled, 'true': TX watchdog enabled.
| uint32_t cy_stc_i2s_config_t::txWatchdogValue |
TX watchdog counter value (32 bit).
| bool cy_stc_i2s_config_t::txSdoLatchingTime |
'false': SDO bit starts at falling edge (accordingly to the I2S Standard, if txSckoInversion is false), 'true': SDO bit starts at rising edge which goes before the above mentioned falling edge, i.e.
the SDO signal is advanced by 0.5 SCK period (if txSckoInversion is false). If txSckoInversion is true - the rising/falling edges just swaps in above explanations. Effective only in slave mode, must be false in master mode.
| bool cy_stc_i2s_config_t::txSckoInversion |
TX SCKO polarity: 'false': When transmitter is in master mode, serial data is transmitted off the falling bit clock edge (accordingly to the I2S Standard); 'true': When transmitter is in master mode, serial data is transmitted off the rising bit clock edge.
Effective only in master mode.
| bool cy_stc_i2s_config_t::txSckiInversion |
TX SCKI polarity: 'false': When transmitter is in slave mode, serial data is transmitted off the falling bit clock edge (accordingly to the I2S Standard); 'true': When transmitter is in slave mode, serial data is transmitted off the rising bit clock edge.
Effective only in slave mode.
| uint8_t cy_stc_i2s_config_t::txChannels |
Number of TX channels, valid range is 1...8 for TDM modes.
In the I2S and Left Justified modes the value of this parameter is ignored - the real number of channels is always 2 in these modes.
| cy_en_i2s_len_t cy_stc_i2s_config_t::txChannelLength |
TX channel length, see cy_en_i2s_len_t, the value of this parameter is ignored in TDM modes, the real channel length is 32 bit in these modes.
| cy_en_i2s_len_t cy_stc_i2s_config_t::txWordLength |
TX word length, see cy_en_i2s_len_t, must be less or equal to txChannelLength.
| cy_en_i2s_overhead_t cy_stc_i2s_config_t::txOverheadValue |
TX overhead bits value when the word length is less than the channel length.
| uint8_t cy_stc_i2s_config_t::txFifoTriggerLevel |
TX FIFO interrupt trigger level (0, 1, ..., 255).
| bool cy_stc_i2s_config_t::rxMasterMode |
'false': RX in slave mode, 'true': RX in master mode.
| cy_en_i2s_alignment_t cy_stc_i2s_config_t::rxAlignment |
RX data alignment, see: cy_en_i2s_alignment_t.
| cy_en_i2s_ws_pw_t cy_stc_i2s_config_t::rxWsPulseWidth |
RX Word Select pulse width.
The value of this parameter is ignored in I2S and Left Justified modes the WS pulse width is always "one channel length" in these modes.
| bool cy_stc_i2s_config_t::rxWatchdogEnable |
'false': RX watchdog disabled, 'true': RX watchdog enabled.
| uint32_t cy_stc_i2s_config_t::rxWatchdogValue |
RX watchdog counter value (32 bit).
| bool cy_stc_i2s_config_t::rxSdiLatchingTime |
'false': SDI bit starts at falling edge (accordingly to the I2S Standard if rxSckoInversion is false), 'true': SDI bit starts at rising edge that goes after the above mentioned falling edge, i.e.
the SDI signal is delayed by 0.5 SCK period (if rxSckoInversion is false). If rxSckoInversion is true - the rising/falling edges just swaps in above explanations. Effective only in master mode, must be false in slave mode.
| bool cy_stc_i2s_config_t::rxSckoInversion |
RX SCKO polarity: 'false': When receiver is in master mode, serial data is captured by the rising bit clock edge (accordingly to the I2S Standard); 'true': When receiver is in master mode, serial data is captured by the falling bit clock edge.
Effective only in master mode.
| bool cy_stc_i2s_config_t::rxSckiInversion |
RX SCKI polarity: 'false': When receiver is in slave mode, serial data is captured by the rising bit clock edge (accordingly to the I2S Standard); 'true': When receiver is in slave mode, serial data is captured by the falling bit clock edge.
Effective only in slave mode.
| uint8_t cy_stc_i2s_config_t::rxChannels |
Number of RX channels, valid range is 1...8 for TDM modes.
In the I2S and Left Justified modes the value of this parameter is ignored - the real number of channels is always 2 in these modes.
| cy_en_i2s_len_t cy_stc_i2s_config_t::rxChannelLength |
RX channel length, see cy_en_i2s_len_t, the value of this parameter is ignored in TDM modes, the real channel length is 32 bit in these modes.
| cy_en_i2s_len_t cy_stc_i2s_config_t::rxWordLength |
RX word length, see cy_en_i2s_len_t, must be less or equal to rxChannelLength.
| bool cy_stc_i2s_config_t::rxSignExtension |
RX value sign extension (when the word length is less than 32 bits), 'false': all MSB are filled by zeroes, 'true': all MSB are filled by the original sign bit value.
| uint8_t cy_stc_i2s_config_t::rxFifoTriggerLevel |
RX FIFO interrupt trigger level (0, 1, ..., (255 - (number of channels))).