COMPARATOR Interface

Interface for Comparators. More...

Data Structures
struct	comparator_info_t
struct	comparator_status_t
struct	comparator_callback_args_t
struct	comparator_cfg_t
struct	comparator_api_t
struct	comparator_instance_t

Macros
#define	COMPARATOR_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	comparator_ctrl_t

Enumerations
enum	comparator_mode_t { COMPARATOR_MODE_NORMAL = 0, COMPARATOR_MODE_WINDOW = 1 }
enum	comparator_trigger_t { COMPARATOR_TRIGGER_RISING = 1, COMPARATOR_TRIGGER_FALLING = 2, COMPARATOR_TRIGGER_BOTH_EDGE = 3 }
enum	comparator_polarity_invert_t { COMPARATOR_POLARITY_INVERT_OFF = 0, COMPARATOR_POLARITY_INVERT_ON = 1 }
enum	comparator_pin_output_t { COMPARATOR_PIN_OUTPUT_OFF = 0, COMPARATOR_PIN_OUTPUT_ON = 1 }
enum	comparator_filter_t {   COMPARATOR_FILTER_OFF = 0, COMPARATOR_FILTER_1 = 4, COMPARATOR_FILTER_8 = 1, COMPARATOR_FILTER_16 = 2,   COMPARATOR_FILTER_32 = 3 }
enum	comparator_state_t { COMPARATOR_STATE_OUTPUT_DISABLED = 0, COMPARATOR_STATE_OUTPUT_LOW = 1, COMPARATOR_STATE_OUTPUT_HIGH = 2 }

Detailed Description

Interface for Comparators.

Summary

The comparator interface provides standard comparator functionality, including generating an event when the comparator result changes.

Implemented by: High-Speed Analog Comparator Low Power Analog Comparator

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

COMPARATOR Interface description: Comparator Driver on r_acmphs and HALACMPLPModule

Macro Definition Documentation

COMPARATOR_API_VERSION_MAJOR

#define COMPARATOR_API_VERSION_MAJOR   (2U)

Includes board and MCU related header files. Version Number of API.

Typedef Documentation

comparator_ctrl_t

typedef void comparator_ctrl_t

Comparator control block. Allocate an instance specific control block to pass into the comparator API calls.

Implemented as

• acmphs_instance_ctrl_t
• acmplp_instance_ctrl_t

Enumeration Type Documentation

comparator_filter_t

enum comparator_filter_t

Comparator digital filtering sample clock divisor settings.

Enumerator
COMPARATOR_FILTER_OFF	Disable debounce filter.
COMPARATOR_FILTER_1	Filter using PCLK divided by 1, not supported by all implementations.
COMPARATOR_FILTER_8	Filter using PCLK divided by 8.
COMPARATOR_FILTER_16	Filter using PCLK divided by 16, not supported by all implementations.
COMPARATOR_FILTER_32	Filter using PCLK divided by 32.

comparator_mode_t

enum comparator_mode_t

Select whether to invert the polarity of the comparator output.

Enumerator
COMPARATOR_MODE_NORMAL	Normal mode.
COMPARATOR_MODE_WINDOW	Window mode, not supported by all implementations.

comparator_pin_output_t

enum comparator_pin_output_t

Select whether to include the comparator output on the output pin.

Enumerator
COMPARATOR_PIN_OUTPUT_OFF	Do not include comparator output on output pin.
COMPARATOR_PIN_OUTPUT_ON	Include comparator output on output pin.

comparator_polarity_invert_t

enum comparator_polarity_invert_t

Select whether to invert the polarity of the comparator output.

Enumerator
COMPARATOR_POLARITY_INVERT_OFF	Do not invert polarity.
COMPARATOR_POLARITY_INVERT_ON	Invert polarity.

comparator_state_t

enum comparator_state_t

Current comparator state.

Enumerator
COMPARATOR_STATE_OUTPUT_DISABLED	comparator_api_t::outputEnable() has not been called
COMPARATOR_STATE_OUTPUT_LOW	VCMP < VREF if polarity is not inverted, VCMP > VREF if inverted.
COMPARATOR_STATE_OUTPUT_HIGH	VCMP > VREF if polarity is not inverted, VCMP < VREF if inverted.

comparator_trigger_t

enum comparator_trigger_t

Trigger type: rising edge, falling edge, both edges, low level.

Enumerator
COMPARATOR_TRIGGER_RISING	Rising edge trigger.
COMPARATOR_TRIGGER_FALLING	Falling edge trigger.
COMPARATOR_TRIGGER_BOTH_EDGE	Both edges trigger.