comparator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_
#define ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_
 
#include <zephyr/device.h>
#include <errno.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum comparator_trigger {
        COMPARATOR_TRIGGER_NONE = 0,
        COMPARATOR_TRIGGER_RISING_EDGE,
        COMPARATOR_TRIGGER_FALLING_EDGE,
        COMPARATOR_TRIGGER_BOTH_EDGES
};
 
typedef void (*comparator_callback_t)(const struct device *dev, void *user_data);
 
typedef int (*comparator_api_get_output)(const struct device *dev);
typedef int (*comparator_api_set_trigger)(const struct device *dev,
                                          enum comparator_trigger trigger);
typedef int (*comparator_api_set_trigger_callback)(const struct device *dev,
                                                   comparator_callback_t callback,
                                                   void *user_data);
typedef int (*comparator_api_trigger_is_pending)(const struct device *dev);
 
__subsystem struct comparator_driver_api {
        comparator_api_get_output get_output;
        comparator_api_set_trigger set_trigger;
        comparator_api_set_trigger_callback set_trigger_callback;
        comparator_api_trigger_is_pending trigger_is_pending;
};
 
__syscall int comparator_get_output(const struct device *dev);
 
static inline int z_impl_comparator_get_output(const struct device *dev)
{
        const struct comparator_driver_api *api =
                (const struct comparator_driver_api *)dev->api;
 
        return api->get_output(dev);
}
 
__syscall int comparator_set_trigger(const struct device *dev,
                                     enum comparator_trigger trigger);
 
static inline int z_impl_comparator_set_trigger(const struct device *dev,
                                                enum comparator_trigger trigger)
{
        const struct comparator_driver_api *api =
                (const struct comparator_driver_api *)dev->api;
 
        return api->set_trigger(dev, trigger);
}
 
static inline int comparator_set_trigger_callback(const struct device *dev,
                                                  comparator_callback_t callback,
                                                  void *user_data)
{
        const struct comparator_driver_api *api =
                (const struct comparator_driver_api *)dev->api;
 
        return api->set_trigger_callback(dev, callback, user_data);
}
 
__syscall int comparator_trigger_is_pending(const struct device *dev);
 
static inline int z_impl_comparator_trigger_is_pending(const struct device *dev)
{
        const struct comparator_driver_api *api =
                (const struct comparator_driver_api *)dev->api;
 
        return api->trigger_is_pending(dev);
}
 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/comparator.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_ */