sensing.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SENSING_H_
#define ZEPHYR_INCLUDE_SENSING_H_
 
#include <zephyr/sensing/sensing_datatypes.h>
#include <zephyr/sensing/sensing_sensor_types.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
struct sensing_sensor_version {
        union {
                uint32_t value;
                struct {
                        uint8_t major;
                        uint8_t minor;
                        uint8_t hotfix;
                        uint8_t build;
                };
        };
};
 
#define SENSING_SENSOR_VERSION(_major, _minor, _hotfix, _build)         \
                                (FIELD_PREP(GENMASK(31, 24), _major) |  \
                                 FIELD_PREP(GENMASK(23, 16), _minor) |  \
                                 FIELD_PREP(GENMASK(15, 8), _hotfix) |  \
                                 FIELD_PREP(GENMASK(7, 0), _build))
 
 
#define SENSING_SENSOR_FLAG_REPORT_ON_EVENT                     BIT(0)
 
#define SENSING_SENSOR_FLAG_REPORT_ON_CHANGE                    BIT(1)
 
 
enum sensing_sensor_state {
        SENSING_SENSOR_STATE_READY = 0,
        SENSING_SENSOR_STATE_OFFLINE = 1,
};
 
enum sensing_sensor_attribute {
        SENSING_SENSOR_ATTRIBUTE_INTERVAL = 0,
        SENSING_SENSOR_ATTRIBUTE_SENSITIVITY = 1,
        SENSING_SENSOR_ATTRIBUTE_LATENCY = 2,
        SENSING_SENSOR_ATTRIBUTE_MAX,
};
 
 
typedef void *sensing_sensor_handle_t;
 
 
typedef void (*sensing_data_event_t)(
                sensing_sensor_handle_t handle,
                const void *buf);
 
struct sensing_sensor_info {
        const char *name;
 
        const char *friendly_name;
 
        const char *vendor;
 
        const char *model;
 
        const int32_t type;
 
        const uint32_t minimal_interval;
};
 
struct sensing_callback_list {
        sensing_data_event_t on_data_event;
};
struct sensing_sensor_config {
        enum sensing_sensor_attribute attri;
        int8_t data_field;
        union {
                uint32_t interval;
                uint32_t sensitivity;
                uint64_t latency;
        };
};
 
 
int sensing_get_sensors(int *num_sensors, const struct sensing_sensor_info **info);
 
int sensing_open_sensor(
                const struct sensing_sensor_info *info,
                const struct sensing_callback_list *cb_list,
                sensing_sensor_handle_t *handle);
 
int sensing_open_sensor_by_dt(
                const struct device *dev, const struct sensing_callback_list *cb_list,
                sensing_sensor_handle_t *handle);
 
int sensing_close_sensor(
                sensing_sensor_handle_t *handle);
 
int sensing_set_config(
                sensing_sensor_handle_t handle,
                struct sensing_sensor_config *configs, int count);
 
int sensing_get_config(
                sensing_sensor_handle_t handle,
                struct sensing_sensor_config *configs, int count);
 
const struct sensing_sensor_info *sensing_get_sensor_info(
                sensing_sensor_handle_t handle);
 
#ifdef __cplusplus
}
#endif
 
#endif /*ZEPHYR_INCLUDE_SENSING_H_*/