emul_sensor.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

 
#include <zephyr/drivers/emul.h>
#include <zephyr/drivers/sensor.h>
#include <zephyr/drivers/sensor_attribute_types.h>
 
#include <stdint.h>



__subsystem struct emul_sensor_driver_api {
        int (*set_channel)(const struct emul *target, struct sensor_chan_spec ch,
                           const q31_t *value, int8_t shift);
        int (*get_sample_range)(const struct emul *target, struct sensor_chan_spec ch, q31_t *lower,
                                q31_t *upper, q31_t *epsilon, int8_t *shift);
        int (*set_attribute)(const struct emul *target, struct sensor_chan_spec ch,
                             enum sensor_attribute attribute, const void *value);
        int (*get_attribute_metadata)(const struct emul *target, struct sensor_chan_spec ch,
                                      enum sensor_attribute attribute, q31_t *min, q31_t *max,
                                      q31_t *increment, int8_t *shift);
};

static inline bool emul_sensor_backend_is_supported(const struct emul *target)
{
        return target && target->backend_api;
}

static inline int emul_sensor_backend_set_channel(const struct emul *target,
                                                  struct sensor_chan_spec ch, const q31_t *value,
                                                  int8_t shift)
{
        if (!target || !target->backend_api) {
                return -ENOTSUP;
        }
 
        struct emul_sensor_driver_api *api = (struct emul_sensor_driver_api *)target->backend_api;
 
        if (api->set_channel) {
                return api->set_channel(target, ch, value, shift);
        }
        return -ENOTSUP;
}

static inline int emul_sensor_backend_get_sample_range(const struct emul *target,
                                                       struct sensor_chan_spec ch, q31_t *lower,
                                                       q31_t *upper, q31_t *epsilon, int8_t *shift)
{
        if (!target || !target->backend_api) {
                return -ENOTSUP;
        }
 
        struct emul_sensor_driver_api *api = (struct emul_sensor_driver_api *)target->backend_api;
 
        if (api->get_sample_range) {
                return api->get_sample_range(target, ch, lower, upper, epsilon, shift);
        }
        return -ENOTSUP;
}

static inline int emul_sensor_backend_set_attribute(const struct emul *target,
                                                    struct sensor_chan_spec ch,
                                                    enum sensor_attribute attribute,
                                                    const void *value)
{
        if (!target || !target->backend_api) {
                return -ENOTSUP;
        }
 
        struct emul_sensor_driver_api *api = (struct emul_sensor_driver_api *)target->backend_api;
 
        if (api->set_attribute == NULL) {
                return -ENOTSUP;
        }
        return api->set_attribute(target, ch, attribute, value);
}

static inline int emul_sensor_backend_get_attribute_metadata(const struct emul *target,
                                                             struct sensor_chan_spec ch,
                                                             enum sensor_attribute attribute,
                                                             q31_t *min, q31_t *max,
                                                             q31_t *increment, int8_t *shift)
{
        if (!target || !target->backend_api) {
                return -ENOTSUP;
        }
 
        struct emul_sensor_driver_api *api = (struct emul_sensor_driver_api *)target->backend_api;
 
        if (api->get_attribute_metadata == NULL) {
                return -ENOTSUP;
        }
        return api->get_attribute_metadata(target, ch, attribute, min, max, increment, shift);
}