Zephyr API Documentation 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
18
19#include <zephyr/device.h>
20#include <errno.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
37
44typedef void (*comparator_callback_t)(const struct device *dev, void *user_data);
45
47
48typedef int (*comparator_api_get_output)(const struct device *dev);
49typedef int (*comparator_api_set_trigger)(const struct device *dev,
50 enum comparator_trigger trigger);
51typedef int (*comparator_api_set_trigger_callback)(const struct device *dev,
52 comparator_callback_t callback,
53 void *user_data);
54typedef int (*comparator_api_trigger_is_pending)(const struct device *dev);
55
56__subsystem struct comparator_driver_api {
57 comparator_api_get_output get_output;
58 comparator_api_set_trigger set_trigger;
59 comparator_api_set_trigger_callback set_trigger_callback;
60 comparator_api_trigger_is_pending trigger_is_pending;
61};
62
64
74__syscall int comparator_get_output(const struct device *dev);
75
76static inline int z_impl_comparator_get_output(const struct device *dev)
77{
78 return DEVICE_API_GET(comparator, dev)->get_output(dev);
79}
80
90__syscall int comparator_set_trigger(const struct device *dev,
91 enum comparator_trigger trigger);
92
93static inline int z_impl_comparator_set_trigger(const struct device *dev,
94 enum comparator_trigger trigger)
95{
96 return DEVICE_API_GET(comparator, dev)->set_trigger(dev, trigger);
97}
98
112static inline int comparator_set_trigger_callback(const struct device *dev,
113 comparator_callback_t callback,
114 void *user_data)
115{
116 return DEVICE_API_GET(comparator, dev)->set_trigger_callback(dev, callback, user_data);
117}
118
128__syscall int comparator_trigger_is_pending(const struct device *dev);
129
130static inline int z_impl_comparator_trigger_is_pending(const struct device *dev)
131{
132 return DEVICE_API_GET(comparator, dev)->trigger_is_pending(dev);
133}
134
135#ifdef __cplusplus
136}
137#endif
138
140
141#include <zephyr/syscalls/comparator.h>
142
143#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:112
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:44
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:27
@ COMPARATOR_TRIGGER_RISING_EDGE
Trigger on rising edge of comparator output.
Definition comparator.h:31
@ COMPARATOR_TRIGGER_BOTH_EDGES
Trigger on both edges of comparator output.
Definition comparator.h:35
@ COMPARATOR_TRIGGER_FALLING_EDGE
Trigger on falling edge of comparator output.
Definition comparator.h:33
@ COMPARATOR_TRIGGER_NONE
No trigger.
Definition comparator.h:29
Runtime device structure (in ROM) per driver instance.
Definition device.h:510