Analog to Digital Converter#

sl_adc_input_type_typedef_t#

sl_adc_input_type_typedef_t

Enumeration for ADC input type.

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 multiple channel selection.

sl_adc_channel_id_t#

sl_adc_channel_id_t

Enumeration for ADC channel.

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 user supplied callback function, which is called when ADC sample completes.

threshold1#

uint16_t sl_adc_threshold_config_t::threshold1

Threshold_1.

threshold2#

uint16_t sl_adc_threshold_config_t::threshold2

Threshold_2.

threshold1_cond#

uint8_t* sl_adc_threshold_config_t::threshold1_cond

Threshold_1 condition like Equal, Grater, Lesser.

threshold2_cond#

uint8_t* sl_adc_threshold_config_t::threshold2_cond

Threshold_2 condition like Equal, Grater, Lesser.

range#

uint8_t sl_adc_threshold_config_t::range

num_of_channel_en#

uint8_t sl_adc_fifo_thrld_config_t::num_of_channel_en

Number of channel enable.

a_empty_threshold#

uint8_t sl_adc_fifo_thrld_config_t::a_empty_threshold

AEMPTY Threshold.

a_full_threshold#

uint8_t sl_adc_fifo_thrld_config_t::a_full_threshold

AFULL Threshold.

dma_type#

uint8_t sl_adc_fifo_thrld_config_t::dma_type

Internal or External DMA.

division_factor#

uint16_t sl_adc_clock_config_t::division_factor

Division Factor.

soc_pll_clock#

uint32_t sl_adc_clock_config_t::soc_pll_clock

SoC PLL clock frequency.

soc_pll_reference_clock#

uint32_t sl_adc_clock_config_t::soc_pll_reference_clock

SoC PLL reference clock frequency.

release#

uint8_t sl_adc_version_t::release

Release version number.

major#

uint8_t sl_adc_version_t::major

sqa version number

minor#

uint8_t sl_adc_version_t::minor

dev version number

sl_si91x_adc_configure_clock#

sl_status_t sl_si91x_adc_configure_clock (sl_adc_clock_config_t * clock_configuration)

Set the clock for the ADC peripheral and configure the PLL clock to the value specified by the user in the clock configuration structure.

This API will set the clock for ADC controller.

• The ADC clock configurations are listed below:

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

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

  • division_factor (0 to 63). Returns

    • status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_FAIL (0x0001) - The function is failed

  • SL_STATUS_NOT_INITIALIZED (0x0011) - Clock is not initialized

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)

Initialize the ADC peripheral.

The ADC clock source sets and passes the Vref value to set the reference voltage for the ADC, based on the sampling rate. Power on the ADC block and calibrate the ADC offset and gain.

• Pre-condition:

  • sl_si91x_adc_configure_clock - Only for FIFO mode on M4 state

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_INVALID_PARAMETER (0x0021) - Parameters are invalid

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

  • SL_STATUS_INVALID_COUNT (0x002B) - Mismatch count

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch Range

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)

Configures the ADC channel parameters.

• The configurations are listed below:

  • Number of channel

  • ADC operation mode (Static mode/FIFO mode)

  • Sample Length

  • Input Type (Single ended/ differential type)

  • Sampling Rate (1 - 2.5 Ms/Sec).

    • Pre-conditions:

sl_si91x_adc_configure_clock

• sl_si91x_adc_initReturns

  • 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_INVALID_PARAMETER (0x0021) - Parameters are invalid

    • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch Range

  Note

  • if Static mode is configured, 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)

Register the user callback function.

When an event occurs, the function with the specified parameter is invoked. To unregister the callback, use the sl_si91x_adc_unregister_event_callback function before invoking this function again; otherwise, the error code SL_STATUS_BUSY will be returned.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

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_adc_unregister_event_callback#

void sl_si91x_adc_unregister_event_callback (void )

Un-register the user callback function.

It is mandatory to call this function before registering the callback again.

• Pre-condition:

  • sl_si91x_adc_register_event_callback

Returns

• none

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)

Configure the ADC sampling rate for the ADC channels.

It adjusts the channel offset and frequency for each channel to determine the sample rate. To meet the Nyquist sampling rate criteria, the channel swallow factor must be not less than '3'.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• sl_status_t : Returns 'SL_STATUS_OK' on successful execution.

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)

Configure the ADC ping and pong memory location and length.

Configure the ping and pong memory locations, as well as the ping and pong memory lengths. It is only applicable for the 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. This explains why each channel has two start addresses, two buffer lengths, and two valid signals.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_enable_ping_pong#

sl_status_t sl_si91x_adc_enable_ping_pong (uint8_t channel_num)

Enable ping pong for the corresponding ADC channels.

Note

• This will be 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_disable_ping_pong#

sl_status_t sl_si91x_adc_disable_ping_pong (uint8_t channel_num)

Disable ping pong for the corresponding ADC channels.

• 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_internal_per_channel_dma_enable#

sl_status_t sl_si91x_adc_internal_per_channel_dma_enable (uint8_t channel_num)

Enable DMA for the corresponding ADC channels.

Note

• This will be 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_internal_per_channel_dma_disable#

sl_status_t sl_si91x_adc_internal_per_channel_dma_disable (uint8_t channel_num)

Disable DMA for the corresponding ADC channels.

• 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

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)

This API will configure the ADC in Static Mode.

It could be configured to choose positive and negative input channels, as well as input type. Note

• This will be 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch Range

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)

Configure the ADC in FIFO Mode.

ADC data input will be sampled and written to the ADC FIFO in this mode. Note

• This will be 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch Range

sl_si91x_adc_channel_enable#

sl_status_t sl_si91x_adc_channel_enable (uint8_t channel_num)

This API will enables the ADC channel.

Data will be sampled from ADC only when corresponding channel is enabled.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_channel_disable#

sl_status_t sl_si91x_adc_channel_disable (uint8_t channel_num)

Disable the ADC channel.

Data sampling will be stoped when 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_set_power_mode#

sl_status_t sl_si91x_adc_set_power_mode (POWER_STATE state)

This API will Power On and off for ADC.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

Returns

• status 0 if successful,

  • SL_STATUS_OK (0x0000) - Success

sl_si91x_adc_set_noise_average_mode#

sl_status_t sl_si91x_adc_set_noise_average_mode (boolean_t state)

Enable or Disable the Noise averaging mode to ADC.

If bypass noise averaging is enabled, the sampled data will be more accurate. If bypass the noise averaging disable would cause '1' additional clock cycle Latency.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

Returns

• Returns 'SL_STATUS_OK' on successful execution.

sl_si91x_adc_temperature_sensor_enable#

sl_status_t sl_si91x_adc_temperature_sensor_enable (void )

This API will enable the temperature sensor.

Enable BJT based Temperature sensor as an input to ADC. Note

• - Operation mode of 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

• Returns 'SL_STATUS_OK' on successful execution.

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)

Configuring ADC fifo threshold.

The maximum FIFO depth is 16, and the threshold value may be configured.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

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_INVALID_RANGE (0x0028) - Mismatch Range

sl_si91x_adc_threshold_configuration#

sl_status_t sl_si91x_adc_threshold_configuration (sl_adc_threshold_config_t adc_threshold)

Configure the ADC threshold to compare threshold value with ADC data.

Note

• 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

• Returns 'SL_STATUS_OK' on successful execution.

sl_si91x_adc_read_data#

sl_status_t sl_si91x_adc_read_data (sl_adc_channel_config_t adcchconfig, uint8_t channel_num)

Read the ADC samples data for FIFO mode of operation.

• 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch Range

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)

This API will read the ADC sampled data for static mode of operation.

• 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

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

  • SL_STATUS_INVALID_RANGE (0x0028) - Mismatch Range

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 which is configured to ADC.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_init

  • sl_si91x_adc_set_channel_configuration

  • sl_si91x_adc_start

Returns

• Returns sampling rate what it get from register

sl_si91x_adc_deinit#

sl_status_t sl_si91x_adc_deinit (sl_adc_config_t adc_config)

Uninitialize the ADC.

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

• Pre-conditions:

  • sl_si91x_adc_configure_clock

  • sl_si91x_adc_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_si91x_adc_start#

sl_status_t sl_si91x_adc_start (sl_adc_config_t adc_config)

Enable the signal to ADC controller and enable the dynamic mode 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_register_event_callback

Returns

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_stop#

sl_status_t sl_si91x_adc_stop (sl_adc_config_t adc_config)

Stop the signal for ADC controller and disable the dynamic mode if 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_register_event_callback

  • sl_si91x_adc_start

Returns

• status 0 if successful, else error code as follow

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid

sl_si91x_adc_get_version#

sl_adc_version_t sl_si91x_adc_get_version (void )

Get the ADC version.

Note

• It returns the API version of ADC.

Returns

• (sl_adc_version_t) type structure

SL_INTERNAL_DMA#

#define SL_INTERNAL_DMA

INTERNAL_DMA

SL_ADC_STATIC_MODE_EVENT#

#define SL_ADC_STATIC_MODE_EVENT

ADC_STATIC_MODE_CALLBACK

SIGN_BIT#

#define SIGN_BIT

BIT(11)