OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/sensing/sensor_mgmt.h

135 lines
3.4 KiB
C
Raw Normal View History

sensing: add Sensing Subsystem skeleton Add Sensing Subsystem skeleton. Signed-off-by: Guangfu Hu <guangfu.hu@intel.com> Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-02-06 16:43:11 +08:00
/*
* Copyright (c) 2023 Intel Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef SENSOR_MGMT_H_
#define SENSOR_MGMT_H_
#include <zephyr/sensing/sensing_datatypes.h>
#include <zephyr/sensing/sensing_sensor.h>
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
#include <zephyr/kernel.h>
#include <zephyr/sys/slist.h>
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
#include <zephyr/sys/ring_buffer.h>
#include <string.h>
sensing: add Sensing Subsystem skeleton Add Sensing Subsystem skeleton. Signed-off-by: Guangfu Hu <guangfu.hu@intel.com> Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-02-06 16:43:11 +08:00
#ifdef __cplusplus
extern "C" {
#endif
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
#define for_each_sensor(sensor) \
STRUCT_SECTION_FOREACH(sensing_sensor, sensor)
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
#define for_each_sensor_reverse(sensor) \
STRUCT_SECTION_START_EXTERN(sensing_sensor); \
STRUCT_SECTION_END_EXTERN(sensing_sensor); \
for (struct sensing_sensor *sensor = STRUCT_SECTION_END(sensing_sensor) \
- 1; \
sensing: Fix build warning on invalid array index The assert was verifying that the current sensor address was greater or equal than the start of the iterable section - 1 which isn't quite right as the start is inclusive. Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2024-06-06 22:30:36 +08:00
({ __ASSERT(sensor >= STRUCT_SECTION_START(sensing_sensor), \
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
"unexpected list start location"); \
sensor >= STRUCT_SECTION_START(sensing_sensor); }); \
sensor--)
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
#define for_each_client_conn(sensor, client) \
SYS_SLIST_FOR_EACH_CONTAINER(&sensor->client_list, client, snode)
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
#define EXEC_TIME_INIT 0
#define EXEC_TIME_OFF UINT64_MAX
extern struct rtio sensing_rtio_ctx;
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
/**
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
* @struct sensing_context
* @brief sensing subsystem context to include global variables
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
*/
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
struct sensing_context {
bool sensing_initialized;
struct k_sem event_sem;
atomic_t event_flag;
sensing: add Sensing Subsystem skeleton Add Sensing Subsystem skeleton. Signed-off-by: Guangfu Hu <guangfu.hu@intel.com> Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-02-06 16:43:11 +08:00
};
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
int open_sensor(struct sensing_sensor *sensor, struct sensing_connection **conn);
int close_sensor(struct sensing_connection **conn);
int sensing_register_callback(struct sensing_connection *conn,
sensing: Fix initializer compile-time constant Initializers must be compile time constants (not expressions!) for clang to be happy. Clang rightfully pointed out that the callback_list member of sensing_connection was being initialized using an expression that was not compile-time constant. The macros passed along a pointer created by taking the address of a global constant and then at initialization time attempting to dereference it using the * operator. So in the end the compiler has identifier its trying to first take the address of and then later dereference in an initializer. Clang didn't appreciate this, though gcc seemed to be just fine. Actually clang 17 might work just fine with this as well, but clang 16 (the clang I tried) didn't like it at all. Instead store the pointer to the callback list rather than copying the struct. This could be done the other way and not passing a pointer through the macros perhaps. Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2023-12-02 03:40:25 +08:00
struct sensing_callback_list *cb_list);
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
int set_interval(struct sensing_connection *conn, uint32_t interval);
int get_interval(struct sensing_connection *con, uint32_t *sensitivity);
int set_sensitivity(struct sensing_connection *conn, int8_t index, uint32_t interval);
int get_sensitivity(struct sensing_connection *con, int8_t index, uint32_t *sensitivity);
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
static inline struct sensing_sensor *get_sensor_by_dev(const struct device *dev)
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
{
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
STRUCT_SECTION_FOREACH(sensing_sensor, sensor) {
if (sensor->dev == dev) {
return sensor;
}
}
__ASSERT(true, "device %s is not a sensing sensor", dev->name);
return NULL;
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
}
static inline struct sensing_sensor *get_reporter_sensor(struct sensing_sensor *sensor, int index)
{
if (!sensor || index >= sensor->reporter_num) {
return NULL;
}
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
return sensor->conns[index].source;
sensing: initial sensor list and enumerate each sensor Implement sensing_init(): 1) create sensors from device tree 2) sequence sensors following node dependency ordering rule generated by Zephyr DTS 3) initial each sensor, includes: a) creating sensor connection between reporter and client, b) calling sensor init callback, c) setting sensor state Implement sensing_open_sensor(): 1) malloc connection from reporter to application 2) bind connection Implement sensing_close_sensr(): 1) unbind connection 2) free connection from reporter to application Implement sensing_set_config(): 1) call set_interval 2) cann set_sensitivity Implement sensing_get_config(): 1) call get_interval 2) call get_sensitivity Signed-off-by: Guangfu Hu <guangfu.hu@intel.com>
2023-05-19 10:26:13 +08:00
}
static inline const struct sensing_sensor_info *get_sensor_info(struct sensing_connection *conn)
{
__ASSERT(conn, "get sensor info, connection not be NULL");
__ASSERT(conn->source, "get sensor info, sensing_sensor is NULL");
return conn->source->info;
}
sensing: unified the sensing sensor api 1. use the sensor_driver_api instead of the sensing_sensor_api. 2. clean up the sensing_sensor.h after using the unified api. 3. select RTIO while CONFIG_SENSING is enabled. 4. remove the sensing_sensor_post_data and sensing_sensor_xxx_data_ready by introducing the RTIO Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-10-23 15:30:57 +08:00
/* check if client has requested data from reporter */
static inline bool is_client_request_data(struct sensing_connection *conn)
{
return conn->interval != 0;
}
static inline uint64_t get_us(void)
{
return k_ticks_to_us_floor64(k_uptime_ticks());
}
static inline bool is_sensor_state_ready(struct sensing_sensor *sensor)
{
return (sensor->state == SENSING_SENSOR_STATE_READY);
}
/* this function is used to decide whether filtering sensitivity checking
* for example: filter sensitivity checking if sensitivity value is 0.
*/
static inline bool is_filtering_sensitivity(int *sensitivity)
{
bool filtering = false;
__ASSERT(sensitivity, "sensitivity should not be NULL");
for (int i = 0; i < CONFIG_SENSING_MAX_SENSITIVITY_COUNT; i++) {
if (sensitivity[i] != 0) {
filtering = true;
break;
}
}
return filtering;
}
sensing: add Sensing Subsystem skeleton Add Sensing Subsystem skeleton. Signed-off-by: Guangfu Hu <guangfu.hu@intel.com> Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
2023-02-06 16:43:11 +08:00
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* SENSOR_MGMT_H_ */