Analog Comparator#

sl_analog_comparator_number_t#

sl_analog_comparator_number_t

Enumeration to represent the analog comparator number.

sl_analog_comparator_inputs_t#

sl_analog_comparator_inputs_t

Enumeration to represent analog comparator inputs.

sl_analog_comparator_hystersis_values_t#

sl_analog_comparator_hystersis_values_t

Enumeration to represent the hysteresis control values.

sl_analog_comparator_threshold_values_t#

sl_analog_comparator_threshold_values_t

Enumeration to represent BOD threshold values for resistor bank output.

sl_analog_comparator_scale_factor_values_t#

sl_analog_comparator_scale_factor_values_t

Enumeration to represent scale factor values for reference scaler output.

sl_analog_comparator_callback_t#

typedef void(* sl_analog_comparator_callback_t) (void) )(void)

Typedef for the function pointer of the callback function.

sl_si91x_analog_comparator_init#

void sl_si91x_analog_comparator_init (void )

Initialize Analog Comparator.

Enables system core clock and Auxiliary clock with 32MHZ RC clock. Configures reference LDO voltage as 2.8v

Returns

• None

sl_si91x_analog_comparator_set_configurations#

sl_status_t sl_si91x_analog_comparator_set_configurations (sl_analog_comparator_config_t * comparator_config_ptr)

Configure Analog Comparator.

Use this function to configure analog comparator number, select non-inverting and inverting inputs, enable or disable hysteresis, and enable or disable filter for comparator outputs. Also configure input pins.

• Pre-condition: sl_si91x_analog_comparator_init()

Returns

• Status 0 if successful, else error code:

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Analog comparator configuration structure member has invalid value.

  • SL_STATUS_OK (0x0000) - Success, analog comparator parameters configured properly.

sl_si91x_analog_comparator_register_callback#

sl_status_t sl_si91x_analog_comparator_register_callback (sl_analog_comparator_number_t comparator_number, sl_analog_comparator_callback_t on_comparator_callback)

Register Analog Comparator interrupt callback.

Enables its interrupts as per comparator number

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_unregister_callback(), if already registered for any interrupt

Returns

• Status 0 if successful, else error code:

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

  • SL_STATUS_BUSY (0x0004) - The callback is already registered, unregister previous callback before registering new one.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - comparator_number parameter has invalid value.

  • SL_STATUS_OK (0x0000) - Successfully registered timer timer-out callback.

sl_si91x_analog_comparator_unregister_callback#

sl_status_t sl_si91x_analog_comparator_unregister_callback (sl_analog_comparator_number_t comp_number)

Unregister Analog Comparator interrupt callback.

Disables its interrupts as per comparator number

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_register_callback()

Returns

• Status 0 if successful, else error code:

  • SL_STATUS_INVALID_PARAMETER (0x0021) - comparator_number parameter has invalid value.

  • SL_STATUS_OK (0x0000) - Successfully registered timer timer-out callback.

sl_si91x_analog_comparator_set_resistor_bank_threshold#

sl_status_t sl_si91x_analog_comparator_set_resistor_bank_threshold (sl_analog_comparator_threshold_values_t threshold_value)

Configure Analog Comparator resistor bank threshold.

As per the threshold value, resistor bank output voltage will be configured. Use this API when any GPIO or external input needs to compare with internal input (resistor bank).

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_register_callback()

Returns

• Status 0 if successful, else error code:

  • SL_STATUS_INVALID_PARAMETER (0x0021) - threshold_value parameter has invalid value.

  • SL_STATUS_OK (0x0000) - Successfully registered timer timer-out callback.

sl_si91x_analog_comparator_set_reference_scaler_output#

sl_status_t sl_si91x_analog_comparator_set_reference_scaler_output (sl_analog_comparator_scale_factor_values_t scale_factor_value)

Configure Analog Comparator reference scaler.

Sets the scale factor for the analog comparator module's reference scaler. As per this scale factor, reference scalar output voltage will be set. Use this API when any GPIO or external input needs to compare with internal input (reference scaler).

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_register_callback()

Returns

• Status 0 if successful, else error code:

  • SL_STATUS_INVALID_PARAMETER (0x0021) - scale_factor_value parameter has invalid value.

  • SL_STATUS_OK (0x0000) - Successfully registered timer timer-out callback.

sl_si91x_analog_comparator_deinit#

void sl_si91x_analog_comparator_deinit (void )

De-Initialize Analog Comparator.

Disables Peripheral clock and interrupts

Returns

• None