I2S#

i2s_event_typedef_t#

i2s_event_typedef_t

Enumeration for different I2S callback events.

sl_i2s_power_state_t#

sl_i2s_power_state_t

Enumeration for I2S power state.

sl_i2s_mode_t#

sl_i2s_mode_t

Enumeration for I2S Primary and Secondary modes.

sl_sai_protocol_t#

sl_sai_protocol_t

Enumeration for SAI protocol type.

sl_i2s_sync_t#

sl_i2s_sync_t

Enumeration for I2S SYNC/ASYNC modes.

sl_i2s_xfer_type_t#

sl_i2s_xfer_type_t

Enumeration for I2S transfer type.

sl_i2s_xfer_size_t#

sl_i2s_xfer_size_t

Enumeration for I2S transfer data size.

sl_i2s_data_resolution_t#

sl_i2s_data_resolution_t

Enumeration for I2S audio data resolutions.

sl_i2s_sampling_rate_t#

sl_i2s_sampling_rate_t

Enumeration for I2S sample rates.

sl_i2s_signal_event_t#

typedef ARM_SAI_SignalEvent_t sl_i2s_signal_event_t

Renamed signal event structure.

sl_i2s_status_t#

typedef ARM_SAI_STATUS sl_i2s_status_t

Renamed status structure.

sl_i2s_driver_t#

typedef ARM_DRIVER_SAI sl_i2s_driver_t

Renamed I2S driver structure.

sl_i2s_handle_t#

typedef const void* sl_i2s_handle_t

Created I2S handle type.

release#

uint8_t sl_i2s_version_t::release

Release version number.

major#

uint8_t sl_i2s_version_t::major

sqa version number

minor#

uint8_t sl_i2s_version_t::minor

dev version number

mode#

uint16_t sl_i2s_xfer_config_t::mode

Primary/Secondary mode.

sync#

uint16_t sl_i2s_xfer_config_t::sync

SYNC/ASYNC mode.

protocol#

uint16_t sl_i2s_xfer_config_t::protocol

I2S/PCM (currently only I2S is supported)

resolution#

uint16_t sl_i2s_xfer_config_t::resolution

Audio data resolutions.

data_size#

uint32_t sl_i2s_xfer_config_t::data_size

data size

sampling_rate#

uint32_t sl_i2s_xfer_config_t::sampling_rate

Audio sampling rate.

transfer_type#

uint32_t sl_i2s_xfer_config_t::transfer_type

Tx/Rx.

sl_si91x_i2s_init#

sl_status_t sl_si91x_i2s_init (uint32_t i2s_instance, sl_i2s_handle_t * i2s_handle)

This API Initializes the I2S peripheral.

This API enable clock for I2S peripheral and configure SCLK, WSCLK, DIN and DOUT pins. Pass the address of the pointer for storing the I2S handle, which can be used in the future for other function calls.

• Pre-condition:

  • none

Returns

• status 0 if successful, else error code is as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_i2s_deinit#

sl_status_t sl_si91x_i2s_deinit (sl_i2s_handle_t * i2s_handle)

This API uninitialize I2S peripheral.

This API disable the DMA instance used for I2S transfer and power down I2S peripheral by disabling the clock supply to I2S

• Pre-condition:

  • sl_si91x_i2s_init

Returns

• status 0 if successful, else error code is as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

Note

• When the I2S module is used in combination with other peripherals, while de-initializing in the application, refer to the notes below:

  1. Whenever sl_si91x_i2s_deinit() gets called, it will power down the domain (PERI_EFUSE), which contains different peripherals, as mentioned below: USART, UART, I2C, SSI Master, SSI Slave, Generic-SPI Master, I2S Master, I2S Slave, Micro-DMA Controller, Config Timer, Random-Number Generator, CRC Accelerator, SIO, QEI, MCPWM and EFUSE. Since deinit power downs the PERI_EFUSE doamin, it's recommended to call the sl_si91x_i2s_deinit() API at the end of the application.

  2. Few peripherals (ULP Peripherals, UULP Peripherals, GPDMA and SDIO-SPI) have seperate domains that can be powered down indepedently. For additional details, refer to the Power architecture section in the Hardware Reference Manual e.g., To power down ULP I2S, use the API below: RSI_PS_M4ssPeriPowerDown(ULPSS_PWRGATE_ULP_I2S); Here, ULP_I2S has seperate power domain ULPSS_PWRGATE_ULP_I2S, which can be power down indepedently. Refer to the rsi_power_save.h file for all power gates definitions.

sl_si91x_i2s_configure_power_mode#

sl_status_t sl_si91x_i2s_configure_power_mode (sl_i2s_handle_t i2s_handle, sl_i2s_power_state_t state)

This API configure I2S power mode.

The supported modes are POWER_OFF - I2S peripheral clocks and I2S DMA channel is disabled. FULL_POWER - Enable I2S peripheral clocks and configure I2S DMA channel.

• Pre-conditions:

  • sl_si91x_i2s_init

Returns

• status 0 if successful, else error code is as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

sl_si91x_i2s_config_transmit_receive#

sl_status_t sl_si91x_i2s_config_transmit_receive (sl_i2s_handle_t i2s_handle, sl_i2s_xfer_config_t * xfer_config)

This API configures transmitter/Receiver parameters for I2S transfer.

This API configures I2S DMA transmit and receive channels. Configuring transfer_type to SL_I2S_TRANSMIT will configure Tx channel and SL_I2S_RECEIVE will configure the Rx channel.

• Pre-condition:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

Returns

• status 0 if successful, else error code is as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

sl_si91x_i2s_transmit_data#

sl_status_t sl_si91x_i2s_transmit_data (sl_i2s_handle_t i2s_handle, const void * data, uint32_t size)

This API transmit I2S data.

This API configures I2S tx DMA channel descriptors and trigger DMA transfer. sl_si91x_i2s_config_transmit_receive() should be called with transfer_type set to SL_I2S_TRANSMIT before sending data.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

  • sl_si91x_i2s_config_transmit_receive

Returns

• status 0 if successful, else error code is as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

sl_si91x_i2s_receive_data#

sl_status_t sl_si91x_i2s_receive_data (sl_i2s_handle_t i2s_handle, const void * data, uint32_t size)

This API receive I2S data.

This API configures I2S rx DMA channel descriptors and enables DMA channel to receive data. sl_si91x_i2s_config_transmit_receive() should be called with transfer_type set to SL_I2S_RECEIVE before receiving data.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

  • sl_si91x_i2s_config_transmit_receive

Returns

• status 0 if successful, else error code is as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

sl_si91x_i2s_register_event_callback#

sl_status_t sl_si91x_i2s_register_event_callback (sl_i2s_handle_t i2s_handle, sl_i2s_signal_event_t callback_event)

This API Registers the user callback function.

Transfer complete event can be notified using this callback. Callbacks should be registered before starting the I2S transfer.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

Returns

• status 0 if successful, else error code as follows

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_NULL_POINTER (0x0022) - The parameter is a null pointer

  • SL_STATUS_BUSY (0x0004) - Driver is busy

sl_si91x_i2s_unregister_event_callback#

sl_status_t sl_si91x_i2s_unregister_event_callback (sl_i2s_handle_t i2s_handle)

This API un-registers the user callback function.

This function can be used only if callbacks are registered before using sl_si91x_i2s_register_event_callback()

• Pre-condition:

  • sl_si91x_i2s_register_event_callback

Returns

• status 0 if successful, else error code SL_STATUS_OK (0x0000) - Success SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument

sl_si91x_i2s_get_transmit_data_count#

uint32_t sl_si91x_i2s_get_transmit_data_count (sl_i2s_handle_t i2s_handle)

This API returns the transmitted data count.

Get the transmit data count of I2S. If an active I2S transfer is started, this function can be used to get several data bytes transferred.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

  • sl_si91x_i2s_config_transmit_receive

  • sl_si91x_i2s_transmit_data

Returns

• uint32_t value of the tx data count

sl_si91x_i2s_get_receive_data_count#

uint32_t sl_si91x_i2s_get_receive_data_count (sl_i2s_handle_t i2s_handle)

This API return receives data count.

Get the received data count of I2S. If I2S is configured for receive, this function can be used to get several data bytes received.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

  • sl_si91x_i2s_config_transmit_receive

  • sl_si91x_i2s_receive_data

Returns

• uint32_t value of the RX data count

sl_si91x_i2s_get_version#

sl_i2s_version_t sl_si91x_i2s_get_version (void )

Get the release, sqa, and dev version of I2S.

• Pre-condition:

  • none

Returns

• (sl_i2s_version_t) type structure

sl_si91x_i2s_get_status#

sl_i2s_status_t sl_si91x_i2s_get_status (sl_i2s_handle_t i2s_handle)

This API return I2S peripheral status.

Get following transfer status of I2S,

1. Frame error

2. Rx busy

3. Rx overflow

4. Tx busy

5. Tx underflow

   • Pre-conditions:

     • sl_si91x_i2s_init

     • sl_si91x_i2s_configure_power_mode

     • sl_si91x_i2s_config_transmit_receive

   Returns

   • (sl_i2s_status_t) type structure

sl_si91x_i2s_end_transfer#

sl_status_t sl_si91x_i2s_end_transfer (sl_i2s_handle_t i2s_handle, sl_i2s_xfer_type_t abort_type)

This API aborts I2S transfer.

This API disable I2S clocks and DMA channel. This API also stops WSCLK generation.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

  • sl_si91x_i2s_config_transmit_receive

  • sl_si91x_i2s_transmit_data/sl_si91x_i2s_receive_data

Returns

• status 0 if successful, else error code is as follows

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_NULL_POINTER (0x0022) - Invalid null pointer received as argument