runner.h

Go to the documentation of this file.

 
#ifndef INFUSE_SDK_INCLUDE_INFUSE_ALGORITHM_RUNNER_RUNNER_H_
#define INFUSE_SDK_INCLUDE_INFUSE_ALGORITHM_RUNNER_RUNNER_H_
 
#include <stdint.h>
 
#include <zephyr/toolchain.h>
#include <zephyr/sys/slist.h>
#include <zephyr/zbus/zbus.h>
 
#include <infuse/fs/kv_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
struct algorithm_runner_common_config {
        /* Unique algorithm identifier */
        uint32_t algorithm_id;
        /* Primary channel that triggers algorithm run */
        uint32_t zbus_channel;
        /* Size of the arguments structure */
        uint16_t arguments_size;
        /* Required runtime state size */
        uint16_t state_size;
        /* KV Store key holding @a arguments (If > 0) */
        uint16_t arguments_kv_key;
} __packed;

typedef void (*algorithm_run_fn)(const struct zbus_channel *chan,
                                 const struct algorithm_runner_common_config *common,
                                 const void *args, void *data);
 
struct algorithm_runner_algorithm {
        /* Function that implements the algorithm */
        algorithm_run_fn impl;
        /* Algorithm configuration */
        const struct algorithm_runner_common_config *config;
        /* Algorithm arguments */
        void *arguments;
        /* Algorithm runtime state */
        void *runtime_state;
        /* Internal state: new data on channel */
        const struct zbus_channel *_changed;
        /* Internal state: configuration has changed */
        bool _reload;
        /* Internal state: list node object*/
        sys_snode_t _node;
};

void algorithm_runner_init(void);

void algorithm_runner_register(struct algorithm_runner_algorithm *algorithm);

bool algorithm_runner_unregister(struct algorithm_runner_algorithm *algorithm);

void algorithm_runner_tdf_log(const struct kv_algorithm_logging *logging, uint8_t tdf_mask,
                              uint16_t tdf_id, uint8_t tdf_len, uint64_t time, const void *data);

 
#ifdef __cplusplus
}
#endif
 
#endif /* INFUSE_SDK_INCLUDE_INFUSE_ALGORITHM_RUNNER_RUNNER_H_ */