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.

sl_si91x_i2s_init#

sl_status_t sl_si91x_i2s_init (uint32_t i2s_instance, sl_i2s_handle_t * i2s_handle)

Initialize the I2S.

Pass the address of the pointer for storing the I2S handle, which can be used in future for other function calls.

• Pre-conditions:

  • none

Returns

• status 0 if successful, else error code 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)

Uninitialize I2S peripheral.

This will also disable the DMA instance used for I2S transfer. This API needs to be called only if the I2S peripheral is initialized before using sl_si91x_i2s_init().

• Pre-conditions:

  • sl_si91x_i2s_init

Returns

• status 0 if successful, else error code 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_configure_power_mode#

sl_status_t sl_si91x_i2s_configure_power_mode (sl_i2s_handle_t i2s_handle, sl_i2s_power_state_t state)

Change the power mode of I2S, 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 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)

Configure transmitter/Receiver parameters for I2S transfer.

DMA transmit and receive configurations. Configuring transfer_type to SL_I2S_TRANSMIT will configure Tx channel and SL_I2S_RECEIVE will configure Rx channel. receiving data.

• Pre-conditions:

  • sl_si91x_i2s_init

  • sl_si91x_i2s_configure_power_mode

Returns

• status 0 if successful, else error code 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)

Configure 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 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)

Configure I2S rx DMA channel descriptors and enable dma channel to recieve 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 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)

Register the user callback function.

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

• Pre-conditions:

  • none

Returns

• status 0 if successful, else error code as follow

  • 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)

Un-register the user callback function.

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

• Pre-conditions:

  • 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)

Get the transmit data count of I2S.

If an active I2S transfer is started, this function can be used to get number of data bytes transfered.

• 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)

Get the receive data count of I2S.

If I2S is configured for receive, this function can be used to get number of 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-conditions:

  • 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)

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)

Abort I2S Tx/Rx operations.

Disable I2S clocks and DMA channel. This function need to be called after completion of I2S transmit/receive.

• 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 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