Analog to Digital Converter#

sl_adc_input_type_typedef_t#

sl_adc_input_type_typedef_t

Enumeration for ADC input types.

sl_adc_operation_mode_typedef_t#

sl_adc_operation_mode_typedef_t

Enumeration for ADC operation mode.

sl_adc_dma_type_typedef_t#

sl_adc_dma_type_typedef_t

Enumeration for ADC DMA type.

sl_adc_channel_type_typedef_t#

sl_adc_channel_type_typedef_t

Enumeration for ADC channel selection modes.

sl_adc_channel_id_t#

sl_adc_channel_id_t

Enumeration for ADC channels.

sl_adc_channel_config_t#

typedef adc_ch_config_t sl_adc_channel_config_t

Renamed ADC channel configuration structure.

sl_adc_config_t#

typedef adc_config_t sl_adc_config_t

Renamed ADC configuration structure.

sl_adc_internal_config_t#

typedef adc_inter_config_t sl_adc_internal_config_t

Renamed ADC internal configuration structure.

sl_adc_callback_t#

typedef void(* sl_adc_callback_t) (uint8_t channel, uint8_t event) )(uint8_t channel, uint8_t event)

Typedef for a user-provided callback function that is invoked upon the completion of an ADC sample.

sl_si91x_adc_configure_clock#

sl_status_t sl_si91x_adc_configure_clock (sl_adc_clock_config_t * clock_configuration)

To set the ADC peripheral clock and configure the PLL clock based on user-specified values in the clock configuration structure.

This API configures the ADC clock. The ADC clock configurations include:

• soc_pll_clock (Frequency range from 1 MHz to 180 MHz)

• soc_pll_reference_clock (Frequency range from 15 MHz to 65 MHz)

• division_factor (0 to 1023)

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured the clock.

  • SL_STATUS_FAIL (0x0001) - Function failed.

  • SL_STATUS_NOT_INITIALIZED (0x0011) - Clock is not initialized.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

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

sl_si91x_adc_init#

sl_status_t sl_si91x_adc_init (sl_adc_channel_config_t adc_channel_config, sl_adc_config_t adc_config, float vref_value)

To initialize the ADC peripheral.

This API initializes the ADC by:

• Setting the clock source.

• Configuring the reference voltage.

• Powering on the ADC block.

• Calibrating the ADC offset and gain.

• Pre-condition:

  • sl_si91x_adc_configure_clock - Required only for FIFO mode on PS4 (Power State) state.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully initialized the ADC.

  • SL_STATUS_BUSY (0x0004) - The function is already active.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

  • SL_STATUS_INVALID_COUNT (0x002B) - Mismatch count.

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

sl_si91x_adc_set_channel_configuration#

sl_status_t sl_si91x_adc_set_channel_configuration (sl_adc_channel_config_t adc_channel_config, sl_adc_config_t adc_config)

To configure the ADC channel parameters.

This API configures the following parameters:

• Number of channels

• ADC operation mode (Static mode/FIFO mode)

• Sample length

• Input type (Single-ended/differential type)

• Sampling rate (1 - 2.5 Msps (megasamples per second))

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured the ADC channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

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

Note

• If Static mode is configured, the sample length should be '1'.

sl_si91x_adc_register_event_callback#

sl_status_t sl_si91x_adc_register_event_callback (sl_adc_callback_t callback_event)

To register the user callback function.

This API registers a user-provided callback function that is invoked when an event occurs.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully registered the callback.

  • SL_STATUS_BUSY (0x0004) - Driver is busy.

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

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

Note

• Before calling this function again, it is mandatory to call the sl_si91x_adc_unregister_event_callback function to unregister the callback; otherwise, it returns the SL_STATUS_BUSY error code.

sl_si91x_adc_unregister_event_callback#

void sl_si91x_adc_unregister_event_callback (void )

To unregister the user callback function.

This API unregisters the callback function registered using sl_si91x_adc_register_event_callback. This function must be called before registering the callback again.

• Pre-condition:

  • sl_si91x_adc_register_event_callback

sl_si91x_adc_configure_channel_sampling_rate#

sl_status_t sl_si91x_adc_configure_channel_sampling_rate (sl_adc_internal_config_t adc_internal_config, uint8_t channel_num)

To configure the ADC sampling rate for the ADC channels.

This API adjusts the channel offset and frequency for each channel to determine the sample rate. This API ensures that the Nyquist sampling rate criteria are met by setting the channel swallow factor to no less than '3'.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured the sampling rate.

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

sl_si91x_adc_configure_ping_pong_memory_address#

sl_status_t sl_si91x_adc_configure_ping_pong_memory_address (sl_adc_internal_config_t adc_internal_config, uint8_t channel_num)

To configure the ADC ping and pong memory location and length.

This API configures the ping and pong memory locations, as well as the ping and pong memory lengths. Applicable only for FIFO mode of ADC operation. FIFO mode has a dual-buffer cyclic mode that prevents data loss when the buffer is full. In dual-buffer cyclic mode, if the Ping buffer for a given channel is full, incoming sampled data is written into the Pong buffer, allowing the controller to read back samples from the Ping buffer during this period.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured ping and pong memory address and length.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_enable_ping_pong#

sl_status_t sl_si91x_adc_enable_ping_pong (uint8_t channel_num)

To enable ping-pong for the corresponding ADC channels.

This API enables the ping-pong mode for the specified ADC channel. Ping-pong mode is applicable only for FIFO mode of ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_configure_ping_pong_memory_address

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully enabled ping-pong for the given channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_disable_ping_pong#

sl_status_t sl_si91x_adc_disable_ping_pong (uint8_t channel_num)

To disable ping-pong for the corresponding ADC channels.

This API disables the ping-pong mode for the specified ADC channel. Ping-pong mode is applicable only for FIFO mode of ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_configure_ping_pong_memory_address

  • sl_si91x_adc_enable_ping_pong

  • sl_si91x_adc_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully disabled the ping-pong for the given channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_internal_per_channel_dma_enable#

sl_status_t sl_si91x_adc_internal_per_channel_dma_enable (uint8_t channel_num)

To enable DMA for the corresponding ADC channels.

This API enables DMA for the specified ADC channel. This is applicable only for FIFO mode of ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_channel_enable

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully enabled DMA for the given channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_internal_per_channel_dma_disable#

sl_status_t sl_si91x_adc_internal_per_channel_dma_disable (uint8_t channel_num)

To disable DMA for the corresponding ADC channels.

This API disables DMA for the specified ADC channel. This is applicable only for FIFO mode of ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_channel_enable

  • sl_si91x_adc_internal_per_channel_dma_enable

  • sl_si91x_adc_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully disabled DMA for the given channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_configure_static_mode#

sl_status_t sl_si91x_adc_configure_static_mode (sl_adc_channel_config_t adc_channel_config, uint8_t channel_num)

To configure the ADC in Static Mode.

This API configures the ADC to static mode with the specified positive and negative input channels and input type.

Note

• Applicable only for static mode of ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured to static mode.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

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

sl_si91x_adc_configure_fifo_mode#

sl_status_t sl_si91x_adc_configure_fifo_mode (sl_adc_channel_config_t adc_channel_config, uint8_t channel_num)

To configure the ADC in FIFO Mode.

This API configures the ADC for FIFO mode, where it samples data from the ADC input and writes it to the FIFO buffer.

Note

• Applicable only for FIFO mode of ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_configure_ping_pong_memory_address

  • sl_si91x_adc_enable_ping_pong

  • sl_si91x_adc_channel_enable

  • sl_si91x_adc_internal_per_channel_dma_enable

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured to FIFO mode.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

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

sl_si91x_adc_channel_enable#

sl_status_t sl_si91x_adc_channel_enable (uint8_t channel_num)

To enable the ADC channel.

This API enables the ADC channel. Data will be sampled from the ADC only when the corresponding channel is enabled.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully enabled the given channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_channel_disable#

sl_status_t sl_si91x_adc_channel_disable (uint8_t channel_num)

To disable the ADC channel.

This API stops data sampling when the corresponding channel is disabled.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_channel_enable

  • sl_si91x_adc_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully disabled the given channel.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_set_power_mode#

sl_status_t sl_si91x_adc_set_power_mode (POWER_STATE state)

To power on or off the ADC.

This API powers up or powers down the ADC power gates based on the provided state.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully set the power mode.

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

sl_si91x_adc_set_noise_average_mode#

sl_status_t sl_si91x_adc_set_noise_average_mode (boolean_t state)

To enable or disable the noise averaging mode for ADC.

This API enables or disables the noise averaging mode for the ADC. If bypass noise averaging is enabled, the sampled data will be more accurate. Disabling bypass noise averaging may cause an additional clock cycle latency.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

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

sl_si91x_adc_temperature_sensor_enable#

sl_status_t sl_si91x_adc_temperature_sensor_enable (void )

To enable the temperature sensor.

This API enables the BJT-based temperature sensor as an input to the ADC.

Note

• The operation mode of the ADC should be Static for this input selection. If the ADC input sample is obtained from a temperature sensor, the positive input selection value must be '23'.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully enabled the ADC temperature sensor.

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

sl_si91x_adc_fifo_threshold_configuration#

sl_status_t sl_si91x_adc_fifo_threshold_configuration (sl_adc_config_t adc_config, sl_adc_fifo_thrld_config_t adc_fifo_threshold)

To configure ADC FIFO Threshold.

This API configures the ADC FIFO threshold. The maximum FIFO depth is 16, and the threshold value can be configured to indicate when the FIFO is almost full or almost empty for ADC operations. This allows for setting either a "FIFO almost full" or "FIFO almost empty" threshold, depending on the specific requirements of ADC configuration.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured FIFO threshold.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

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

sl_si91x_adc_threshold_configuration#

sl_status_t sl_si91x_adc_threshold_configuration (sl_adc_threshold_config_t adc_threshold)

To configure the ADC threshold to compare threshold value with ADC data.

This API configures the ADC threshold values for comparison with ADC data. This API applies when the ADC mode of operation is static.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured ADC threshold.

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

sl_si91x_adc_read_data#

sl_status_t sl_si91x_adc_read_data (sl_adc_channel_config_t adcchconfig, uint8_t channel_num)

To read the ADC sample data for FIFO mode of operation.

This API reads the ADC sample data when the ADC is configured in FIFO mode.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_register_event_callback

  • sl_si91x_adc_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully read the data.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

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

sl_si91x_adc_read_data_static#

sl_status_t sl_si91x_adc_read_data_static (sl_adc_channel_config_t adc_channel_config, sl_adc_config_t adc_config, uint16_t * adc_value)

To read the ADC sampled data for static mode of operation.

This API reads the ADC sampled data when the ADC is configured in static mode.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_register_event_callback

  • sl_si91x_adc_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully read the data.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch range.

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

sl_si91x_adc_get_sampling_rate#

uint32_t sl_si91x_adc_get_sampling_rate (uint8_t channel_num)

To get the channel sampling rate value configured to ADC.

This API retrieves the sampling rate value that is configured for the specified ADC channel.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_start

Returns

• uint32_t Sampling rate retrieved from the register.

sl_si91x_adc_deinit#

sl_status_t sl_si91x_adc_deinit (sl_adc_config_t adc_config)

To deinitialize the ADC.

This API deinitializes the ADC. If the DMA (Direct Memory Access) is enabled, it also deinitializes the DMA. It will power down the ADC block and disable the dynamic mode if FIFO mode of ADC operation is used.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully deinitialized the ADC.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_start#

sl_status_t sl_si91x_adc_start (sl_adc_config_t adc_config)

To start the ADC operation.

This API starts the signal to the ADC controller and enables dynamic mode if FIFO mode of ADC operation is configured.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_register_event_callback

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully started the ADC.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_stop#

sl_status_t sl_si91x_adc_stop (sl_adc_config_t adc_config)

To stop the ADC operation.

This API stops the signal to the ADC controller and disables dynamic mode if FIFO mode of ADC operation is configured.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_register_event_callback

  • sl_si91x_adc_start

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully stopped the ADC operation.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

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

sl_si91x_adc_get_version#

sl_adc_version_t sl_si91x_adc_get_version (void )

To get the ADC version.

This API returns the release, major, and minor version of the ADC.

Note

• Returns the API version of the ADC.

Returns

• sl_adc_version_t Structure containing the version information, see sl_adc_version_t.

SL_INTERNAL_DMA#

#define SL_INTERNAL_DMA

INTERNAL_DMA

Internal DMA event.

SL_ADC_STATIC_MODE_EVENT#

#define SL_ADC_STATIC_MODE_EVENT

ADC_STATIC_MODE_CALLBACK

Static mode event.

SIGN_BIT#

#define SIGN_BIT

BIT(11)

Sign/magnitude bit.