Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
comparator.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_
8#define ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_
9
25#include <zephyr/device.h>
26#include <errno.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
43
50typedef void (*comparator_callback_t)(const struct device *dev, void *user_data);
51
54typedef int (*comparator_api_get_output)(const struct device *dev);
55typedef int (*comparator_api_set_trigger)(const struct device *dev,
56 enum comparator_trigger trigger);
57typedef int (*comparator_api_set_trigger_callback)(const struct device *dev,
58 comparator_callback_t callback,
59 void *user_data);
60typedef int (*comparator_api_trigger_is_pending)(const struct device *dev);
61
62__subsystem struct comparator_driver_api {
63 comparator_api_get_output get_output;
64 comparator_api_set_trigger set_trigger;
65 comparator_api_set_trigger_callback set_trigger_callback;
66 comparator_api_trigger_is_pending trigger_is_pending;
67};
68
80__syscall int comparator_get_output(const struct device *dev);
81
82static inline int z_impl_comparator_get_output(const struct device *dev)
83{
84 return DEVICE_API_GET(comparator, dev)->get_output(dev);
85}
86
96__syscall int comparator_set_trigger(const struct device *dev,
97 enum comparator_trigger trigger);
98
99static inline int z_impl_comparator_set_trigger(const struct device *dev,
100 enum comparator_trigger trigger)
101{
102 return DEVICE_API_GET(comparator, dev)->set_trigger(dev, trigger);
103}
104
118static inline int comparator_set_trigger_callback(const struct device *dev,
119 comparator_callback_t callback,
120 void *user_data)
121{
122 return DEVICE_API_GET(comparator, dev)->set_trigger_callback(dev, callback, user_data);
123}
124
134__syscall int comparator_trigger_is_pending(const struct device *dev);
135
136static inline int z_impl_comparator_trigger_is_pending(const struct device *dev)
137{
138 return DEVICE_API_GET(comparator, dev)->trigger_is_pending(dev);
139}
140
141#ifdef __cplusplus
142}
143#endif
144
147#include <zephyr/syscalls/comparator.h>
148
149#endif /* ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_ */
#define DEVICE_API_GET(_class, _dev)
Expands to the pointer of a device's API for a given class.
Definition device.h:1350
System error numbers.
static int comparator_set_trigger_callback(const struct device *dev, comparator_callback_t callback, void *user_data)
Set comparator's trigger callback.
Definition comparator.h:118
int comparator_trigger_is_pending(const struct device *dev)
Check if comparator's trigger is pending and clear it.
void(* comparator_callback_t)(const struct device *dev, void *user_data)
Comparator callback template.
Definition comparator.h:50
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.
comparator_trigger
Comparator trigger enumerations.
Definition comparator.h:33
@ COMPARATOR_TRIGGER_RISING_EDGE
Trigger on rising edge of comparator output.
Definition comparator.h:37
@ COMPARATOR_TRIGGER_BOTH_EDGES
Trigger on both edges of comparator output.
Definition comparator.h:41
@ COMPARATOR_TRIGGER_FALLING_EDGE
Trigger on falling edge of comparator output.
Definition comparator.h:39
@ COMPARATOR_TRIGGER_NONE
No trigger.
Definition comparator.h:35
Runtime device structure (in ROM) per driver instance.
Definition device.h:510