mtb_ml_model.h

/***************************************************************************/
#if !defined(__MTB_ML_MODEL_H__)
#define __MTB_ML_MODEL_H__

#include "mtb_ml_common.h"
#include "mtb_ml_model_defs.h"

#if defined(__cplusplus)
extern "C" {
#endif

/******************************************************************************
 * Macros
 *****************************************************************************/
#define MEM_FLAG_SHIFT_PERSISTENT       (0)
#define MEM_FLAG_SHIFT_SCRATCH          (1)

#define MTB_ML_MEM_DYNAMIC_PERSISTENT   (1 << MEM_FLAG_SHIFT_PERSISTENT)
#define MTB_ML_MEM_DYNAMIC_SCRATCH      (1 << MEM_FLAG_SHIFT_SCRATCH)

#define MTB_ML_MODEL_NAME_LEN           64
/******************************************************************************
 * Typedefs
 *****************************************************************************/

/******************************************************************************
* Public definitions
******************************************************************************/

/******************************************************************************
* Structures
******************************************************************************/
typedef struct
{

    uint8_t* tensor_arena;              
    size_t tensor_arena_size;           
} mtb_ml_model_buffer_t;

typedef struct
{
    char name[MTB_ML_MODEL_NAME_LEN];   
#if defined(COMPONENT_ML_TFLM)

    const uint8_t *      model_bin;     
    const unsigned int   model_size;    
    const int            arena_size;    
#endif
#if defined(COMPONENT_ML_TFLM_LESS)

    tflm_rmf_apis_t      rmf_bin;     
#endif
} mtb_ml_model_bin_t;

typedef struct
{
    char name[MTB_ML_MODEL_NAME_LEN];   
    int model_size;                     
    int buffer_size;                    
    int input_size;                     
    int output_size;                    
    int lib_error;                      
    MTB_ML_DATA_T *output;              
    MTB_ML_DATA_T *input;               
    void *tflm_obj;                     
    int model_time_steps;               /*< number of model time steps */
    int recurrent_ts_size;              
    int input_zero_point;               
    float input_scale;                  
    int output_zero_point;              
    float output_scale;                 
    mtb_ml_profile_config_t profiling;  
    uint64_t m_cpu_cycles;              
    uint32_t m_sum_frames;              
    uint64_t m_cpu_sum_cycles;          
    uint32_t m_cpu_peak_frame;          
    uint64_t m_cpu_peak_cycles;         
    bool is_rnn_streaming;              
#if defined(COMPONENT_U55) || \
    defined(COMPONENT_NNLITE2)

    uint64_t m_npu_cycles;          
    uint64_t m_npu_sum_cycles;      
    uint32_t m_npu_peak_frame;      
    uint64_t m_npu_peak_cycles;     
#endif
#if defined(COMPONENT_ML_TFLM)

    uint8_t *arena_buffer;              
#endif
#if defined(COMPONENT_ML_TFLM_LESS)

    tflm_rmf_apis_t rmf_apis;           
#endif
} mtb_ml_model_t;

/******************************************************************************
* Function prototype
******************************************************************************/
cy_rslt_t mtb_ml_model_init(const mtb_ml_model_bin_t *bin, const mtb_ml_model_buffer_t *buffer, mtb_ml_model_t **object);

cy_rslt_t mtb_ml_model_deinit(mtb_ml_model_t *object);

cy_rslt_t mtb_ml_model_run(mtb_ml_model_t *object, MTB_ML_DATA_T *input);

int mtb_ml_model_get_input_size(const mtb_ml_model_t *object);

cy_rslt_t mtb_ml_model_get_output(const mtb_ml_model_t *object, MTB_ML_DATA_T **out_pptr, int* size_ptr);

cy_rslt_t mtb_ml_model_rnn_reset_all_parameters(mtb_ml_model_t *object);

void* mtb_ml_model_get_inference_object(const mtb_ml_model_t *object);

int mtb_ml_model_profile_get_tsc(uint64_t *val);

cy_rslt_t mtb_ml_model_profile_config(mtb_ml_model_t *object, mtb_ml_profile_config_t config);

cy_rslt_t mtb_ml_model_profile_log(mtb_ml_model_t *object);

#if defined(__cplusplus)
}
#endif

#endif /* __MTB_ML_MODEL_H__ */