Comparator

Interfaces for comparators. More...

Topics
	Comparator Driver Backend API

Files
file	comparator.h
	Main header file for comparator driver API.

Typedefs
typedef void(*	comparator_callback_t) (const struct device *dev, void *user_data)
	Comparator callback template.

Enumerations
enum	comparator_trigger { COMPARATOR_TRIGGER_NONE = 0 , COMPARATOR_TRIGGER_RISING_EDGE , COMPARATOR_TRIGGER_FALLING_EDGE , COMPARATOR_TRIGGER_BOTH_EDGES }
	Comparator trigger enumerations. More...

Functions
int	comparator_get_output (const struct device *dev)
	Get comparator's output state.
int	comparator_set_trigger (const struct device *dev, enum comparator_trigger trigger)
	Set comparator's trigger.
static int	comparator_set_trigger_callback (const struct device *dev, comparator_callback_t callback, void *user_data)
	Set comparator's trigger callback.
int	comparator_trigger_is_pending (const struct device *dev)
	Check if comparator's trigger is pending and clear it.

Detailed Description

Interfaces for comparators.

Since

4.0

Version

0.8.0

Typedef Documentation

comparator_callback_t

typedef void(* comparator_callback_t) (const struct device *dev, void *user_data)

#include <zephyr/drivers/comparator.h>

Comparator callback template.

Parameters

dev	Comparator device
user_data	Pointer to the user data that was provided when the trigger callback was set

Enumeration Type Documentation

comparator_trigger

enum comparator_trigger

#include <zephyr/drivers/comparator.h>

Comparator trigger enumerations.

Enumerator
COMPARATOR_TRIGGER_NONE	No trigger.
COMPARATOR_TRIGGER_RISING_EDGE	Trigger on rising edge of comparator output.
COMPARATOR_TRIGGER_FALLING_EDGE	Trigger on falling edge of comparator output.
COMPARATOR_TRIGGER_BOTH_EDGES	Trigger on both edges of comparator output.

Function Documentation

comparator_get_output()

int comparator_get_output

(

const struct device *

dev

)

#include <zephyr/drivers/comparator.h>

Get comparator's output state.

Parameters

dev	Comparator device

Return values

1	Output state is high.
0	Output state is low.

Returns

Negative errno value on failure.

comparator_set_trigger()

int comparator_set_trigger	(	const struct device *	dev,
		enum comparator_trigger	trigger )

#include <zephyr/drivers/comparator.h>

Set comparator's trigger.

Parameters

dev	Comparator device
trigger	Trigger for signal and callback

Returns

0 on success, negative errno value on failure.

comparator_set_trigger_callback()

int comparator_set_trigger_callback ( const struct device * dev, comparator_callback_t callback, void * user_data )

inlinestatic

#include <zephyr/drivers/comparator.h>

Set comparator's trigger callback.

Parameters

dev	Comparator device
callback	Trigger callback
user_data	User data passed to callback

Returns

0 on success, negative errno value on failure.

Note

Set callback to NULL to disable callback

Callback is called immediately if trigger is pending

comparator_trigger_is_pending()

int comparator_trigger_is_pending

(

const struct device *

dev

)

#include <zephyr/drivers/comparator.h>

Check if comparator's trigger is pending and clear it.

Parameters

dev	Comparator device

Return values

1	Trigger was pending
0	Trigger was cleared

Returns

Negative errno value on failure.