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 the types of 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.

Note

• Values of the enumerator are calculated using VBAT = 3.5066 volts and these values vary from board to board.

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 )

To initialize the Analog Comparator and configure the necessary clocks and reference voltage.

This API enables the system core clock and auxiliary clock with a 32MHz RC clock. It also configures the reference LDO voltage to 3.3V.

Note

• This function must be called before using any other analog comparator functions.

• The system core clock must be properly configured.

sl_si91x_analog_comparator_set_configurations#

sl_status_t sl_si91x_analog_comparator_set_configurations (sl_analog_comparator_config_t * comparator_config_ptr)

To configure the analog comparator settings and initialize the selected comparator.

This API configures the analog comparator by selecting the comparator number, non-inverting and inverting inputs, enabling or disabling hysteresis, and enabling or disabling the filter for comparator outputs. It also configures the input pins.

• Pre-condition:

  • sl_si91x_analog_comparator_init()

Returns

• sl_status_t Status code indicating the result:

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

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

For more information on the status documentation, see SL STATUS DOCUMENTATION.

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)

To register the Analog Comparator interrupt callback and enable its interrupts as per comparator number.

This API registers a callback function to be invoked when a comparator interrupt occurs and enables the interrupts for the specified 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

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully registered comparator interrupt callback.

  • SL_STATUS_BUSY (0x0004) - The callback is already registered. Unregister the existing callback before registering a new one.

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

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

For more information on the status documentation, see SL STATUS DOCUMENTATION.

sl_si91x_analog_comparator_unregister_callback#

sl_status_t sl_si91x_analog_comparator_unregister_callback (sl_analog_comparator_number_t comp_number)

To unregister the Analog Comparator interrupt callback and disable its interrupts as per comparator number.

This API disables the interrupts for the specified comparator number and unregisters the callback function.

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_register_callback()

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully unregistered comparator interrupt callback.

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

For more information on the status documentation, see SL STATUS DOCUMENTATION.

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)

To configure the Analog Comparator resistor bank threshold.

This API configures the resistor bank output voltage based on the specified threshold value. Use this input when one of the comparator inputs is the resistor bank output.

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_register_callback()

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured the resistor bank threshold.

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

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

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)

To configure the reference scaler for the Analog Comparator and set the scale factor.

This API sets the scale factor for the analog comparator module's reference scaler. As per this scale factor, the reference scaler output voltage will be set. Use this input when one of the comparator inputs is the reference scaler output.

• Pre-conditions:

  • sl_si91x_analog_comparator_init()

  • sl_si91x_analog_comparator_set_configurations()

  • sl_si91x_analog_comparator_register_callback()

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully configured the reference scaler output. For more information on the status documentation, see SL STATUS DOCUMENTATION.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - scale_factor_value parameter has an invalid value. For more information on the status documentation, see SL STATUS DOCUMENTATION.

sl_si91x_analog_comparator_deinit#

void sl_si91x_analog_comparator_deinit (void )

To de-initialize the Analog Comparator.

This API de-initializes the analog comparator by disabling the peripheral clock & comparator interrupts.

• Pre-conditions:

  • sl_si91x_analog_comparator_init()