I2S#

i2s_event_typedef_t#

i2s_event_typedef_t

Enumeration for different I2S callback events.

This enumeration defines the various events that can trigger I2S callbacks. These events are used to notify the application of different I2S operation statuses.

sl_i2s_power_state_t#

sl_i2s_power_state_t

Enumeration for I2S power states.

This enumeration defines the different power states for the I2S peripheral. These states are used to manage the power consumption of the I2S module.

sl_i2s_mode_t#

sl_i2s_mode_t

Enumeration for I2S primary and secondary modes.

This enumeration defines the modes for the I2S peripheral, specifying whether it operates as a master or a slave. The master mode controls the clock generation, while the slave mode relies on an external clock.

sl_sai_protocol_t#

sl_sai_protocol_t

Enumeration for SAI protocol type.

This enumeration defines the protocol types for the SAI (Serial Audio Interface). It specifies whether the I2S or PCM protocol is used. Note that the PCM protocol is currently not supported in the driver.

sl_i2s_sync_t#

sl_i2s_sync_t

Enumeration for I2S SYNC/ASYNC modes.

This enumeration defines the synchronization modes for the I2S peripheral. It specifies whether the I2S operates in synchronous or asynchronous mode.

sl_i2s_xfer_type_t#

sl_i2s_xfer_type_t

Enumeration for I2S transfer types.

This enumeration defines the various transfer types for the I2S peripheral. It specifies whether the I2S is configured for transmitting, receiving, or aborting ongoing transfers.

sl_i2s_xfer_size_t#

sl_i2s_xfer_size_t

Enumeration for I2S transfer data size.

This enumeration defines the data sizes for I2S transfers. It specifies the number of bits per data word that can be transferred.

sl_i2s_data_resolution_t#

sl_i2s_data_resolution_t

Enumeration for I2S audio data resolutions.

This enumeration defines the various audio data resolutions for the I2S peripheral. It specifies the number of bits per audio sample that can be used.

sl_i2s_sampling_rate_t#

sl_i2s_sampling_rate_t

Enumeration for I2S sample rates.

This enumeration defines the various sample rates for the I2S peripheral. It specifies the number of samples per second (in Hz) that can be used.

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)

To initialize the I2S peripheral.

This API enables the clock for the I2S peripheral and configures the SCLK, WSCLK, DIN, and DOUT pins. It also requires the address of a pointer for storing the I2S handle, which can be used for other function calls.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Operation successful.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

  • SL_STATUS_BUSY - Driver is busy.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_i2s_deinit#

sl_status_t sl_si91x_i2s_deinit (sl_i2s_handle_t * i2s_handle)

To uninitialize the I2S peripheral.

This API disables the DMA instance used for I2S transfer and powers down the I2S peripheral by disabling the clock supply to I2S.

• Pre-condition:

  • sl_si91x_i2s_init must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Operation successful.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

Note

• When the I2S module is used in combination with other peripherals, see the notes below while deinitializing in the application:

  1. Whenever sl_si91x_i2s_deinit() is called, it will disable the clock for the peripheral. To power off the peripheral, you have to power down the power domain (PERI_EFUSE) which contains the following peripherals: 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. Use the following API to power down the particular power domain if other peripherals are not being used: sl_si91x_peri_efuse_power_down()

  2. Some peripherals (ULP Peripherals, UULP Peripherals, GPDMA, and SDIO-SPI) have separate domains and can be powered down independently. For additional details, see the Power Architecture section in the Hardware Reference Manual. The ULP_UART has a separate power domain, ULPSS_PWRGATE_ULP_UART, which can be powered down independently. See the rsi_power_save.h file for all power gate 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)

To configure the I2S power mode.

This API configures the power mode of the I2S peripheral. The supported modes are:

• SL_I2S_POWER_OFF: I2S peripheral clocks and I2S DMA channel are disabled.

• SL_I2S_FULL_POWER: Enables I2S peripheral clocks and configures the I2S DMA channel.

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To configure transmit/receive parameters for I2S transfer.

This API configures the I2S DMA transmit and receive channels. Setting the transfer_type to SL_I2S_TRANSMIT will configure the Tx channel, while setting it to SL_I2S_RECEIVE will configure the Rx channel.

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Operation successful.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To transmit I2S data.

This API configures the I2S Tx DMA channel descriptors and triggers the DMA transfer. The function 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 must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

  • sl_si91x_i2s_config_transmit_receive must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To receive I2S data.

This API configures the I2S Rx DMA channel descriptors and enables the DMA channel to receive data. The function 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 must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

  • sl_si91x_i2s_config_transmit_receive must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

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)

To register the event callback function.

This API registers a callback function to notify the application of transfer complete events. Callbacks should be registered before starting the I2S transfer.

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_BUSY - Driver is busy.

  • SL_STATUS_NULL_POINTER - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_i2s_unregister_event_callback#

sl_status_t sl_si91x_i2s_unregister_event_callback (sl_i2s_handle_t i2s_handle)

To unregister the event callback function.

This function unregisters the previously registered callback function. It can be used only if callbacks are registered using sl_si91x_i2s_register_event_callback().

• Pre-condition:

  • sl_si91x_i2s_register_event_callback must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_i2s_get_transmit_data_count#

uint32_t sl_si91x_i2s_get_transmit_data_count (sl_i2s_handle_t i2s_handle)

To get the transmitted data count of I2S.

This function retrieves the count of data bytes that have been transmitted by the I2S peripheral. It can be used to monitor the progress of an ongoing I2S data transfer.

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

  • sl_si91x_i2s_config_transmit_receive must be called before this function.

  • sl_si91x_i2s_transmit_data must be called before this function.

Returns

• uint32_t The number of data bytes transmitted.

sl_si91x_i2s_get_receive_data_count#

uint32_t sl_si91x_i2s_get_receive_data_count (sl_i2s_handle_t i2s_handle)

To get the received data count of I2S.

This function retrieves the count of data bytes that have been received by the I2S peripheral. It can be used to monitor the progress of an ongoing I2S data reception.

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

  • sl_si91x_i2s_config_transmit_receive must be called before this function.

  • sl_si91x_i2s_receive_data must be called before this function.

Returns

• uint32_t The number of data bytes received.

sl_si91x_i2s_get_version#

sl_i2s_version_t sl_si91x_i2s_get_version (void )

To get the release, major, and minor version of the I2S peripheral.

This function retrieves the version information of the I2S peripheral, including the release, major, and minor version numbers.

Returns

• sl_i2s_version_t Structure containing the version information:

  • release: Release version number.

  • major: Major version number.

  • minor: Minor version number.

sl_si91x_i2s_get_status#

sl_i2s_status_t sl_si91x_i2s_get_status (sl_i2s_handle_t i2s_handle)

To get the I2S peripheral status.

This function retrieves the current status of the I2S peripheral, including:

1. Frame error

2. Rx busy

3. Rx overflow

4. Tx busy

5. Tx underflow

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

  • sl_si91x_i2s_config_transmit_receive must be called before this function.

Returns

• sl_i2s_status_t Structure containing the I2S status information.

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)

To abort the I2S transfer.

This function disables the I2S clocks and DMA channel, stopping the WSCLK generation.

• Pre-conditions:

  • sl_si91x_i2s_init must be called before this function.

  • sl_si91x_i2s_configure_power_mode must be called before this function.

  • sl_si91x_i2s_config_transmit_receive must be called before this function.

  • sl_si91x_i2s_transmit_data or sl_si91x_i2s_receive_data must be called before this function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK - Success.

  • SL_STATUS_INVALID_PARAMETER - Parameters are invalid.

  • SL_STATUS_NULL_POINTER - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.