ADC#

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

sl_adc_ext_trigger_type_t

Enumeration for ADC external trigger type.

sl_adc_ext_trigger_num_t#

sl_adc_ext_trigger_num_t

Enumeration for ADC external trigger number.

sl_adc_ext_trigger_edge_t#

sl_adc_ext_trigger_edge_t

Enumeration for ADC external trigger edge selection.

sl_adc_ext_trigger_sel_t#

sl_adc_ext_trigger_sel_t

Enumeration for ADC external trigger 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_external_config_t#

typedef adc_extr_config_t sl_adc_external_config_t

Renamed ADC external trigger 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 the function pointer of the callback function.

sl_si91x_adc_configure_clock#

sl_status_t sl_si91x_adc_configure_clock (sl_adc_clock_config_t * clock_configuration)

Configure the ADC clock.

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.

• Pre-conditions:

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

Configure ADC channel parameters.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

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

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.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

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

• Pre-conditions:

  • sl_si91x_adc_register_event_callback

Returns

• none

sl_si91x_adc_configure_external_trigger#

sl_status_t sl_si91x_adc_configure_external_trigger (sl_adc_external_config_t adc_external_trigger)

Configure the ADC external trigger.

This API is used to mux select to choose between ulp_timer, ulp_gpio, M4_timer based on this detection edge and channel trigger will interrupt.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

  • sl_si91x_adc_start

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_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 ADC channels.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

Returns

• sl_status_t : Returns 'SL_STATUS_OK' on successful execution.

sl_si91x_adc_get_external_trigger_status#

sl_status_t sl_si91x_adc_get_external_trigger_status (sl_adc_external_config_t adc_external_trigger, uint8_t * ext_trigger)

Read the ADC external trigger status.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

  • sl_si91x_adc_start

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

sl_status_t sl_si91x_adc_clear_external_trigger (sl_adc_external_config_t adc_external_trigger)

Clear the ADC external trigger status.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

  • sl_si91x_adc_start

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_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.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

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

sl_status_t sl_si91x_adc_enable_ping_pong (uint8_t channel_num)

Enable ping pong for corresponding ADC channels.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • 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 corresponding ADC channels.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_configure_ping_pong_memory_address

• Pre-conditions:

  • sl_si91x_adc_enable_ping_pong

• Pre-conditions:

  • 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 internal DMA for corresponding ADC channels.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • 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 internal dma channel for corresponding ADC channels.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_channel_enable

• Pre-conditions:

  • sl_si91x_adc_internal_per_channel_dma_enable

• Pre-conditions:

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

Configure the ADC in Static Mode.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_configure_ping_pong_memory_address

• Pre-conditions:

  • sl_si91x_adc_enable_ping_pong

• Pre-conditions:

  • sl_si91x_adc_channel_enable

• Pre-conditions:

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

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_configure_ping_pong_memory_address

• Pre-conditions:

  • sl_si91x_adc_enable_ping_pong

• Pre-conditions:

  • sl_si91x_adc_channel_enable

• Pre-conditions:

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

Enable the ADC channel.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

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

sl_status_t sl_si91x_adc_channel_disable (uint8_t channel_num)

Disable the ADC channel.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_channel_enable

• Pre-conditions:

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

Set to Power On and off for ADC.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • 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 Noise averaging mode.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_power_mode

Returns

• Returns 'SL_STATUS_OK' on successful execution.

sl_si91x_adc_temperature_sensor_enable#

sl_status_t sl_si91x_adc_temperature_sensor_enable (void )

Enable temp-sensor for ADC.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

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.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

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

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

  • sl_si91x_adc_start

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 when ulp memories are used.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

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

Read the ADC samples when static mode is enabled.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

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

Read the ADC sampling rate when static mode is enabled.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

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

De-initialize the ADC.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

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

Start the ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

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

sl_status_t sl_si91x_adc_stop (sl_adc_config_t adc_config)

Stop the ADC operation.

• Pre-conditions:

  • sl_si91x_adc_configure_clock

• Pre-conditions:

  • sl_si91x_adc_init

• Pre-conditions:

  • sl_si91x_adc_set_channel_configuration

• Pre-conditions:

  • 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 release, sqa and dev version of ADC.

Returns

• (sl_adc_version_t) type structure