cy_ml_inference.h

/******************************************************************************
* File Name: cy_ml_inference.h
*
* Description: This file contains public interface for MTB ML inference engine
*
* Related Document: See README.md
*
*******************************************************************************
* (c) 2019-2021, Cypress Semiconductor Corporation. All rights reserved.
*******************************************************************************
* This software, including source code, documentation and related materials
* ("Software"), is owned by Cypress Semiconductor Corporation or one of its
* subsidiaries ("Cypress") and is protected by and subject to worldwide patent
* protection (United States and foreign), United States copyright laws and
* international treaty provisions. Therefore, you may use this Software only
* as provided in the license agreement accompanying the software package from
* which you obtained this Software ("EULA").
*
* If no EULA applies, Cypress hereby grants you a personal, non-exclusive,
* non-transferable license to copy, modify, and compile the Software source
* code solely for use in connection with Cypress's integrated circuit products.
* Any reproduction, modification, translation, compilation, or representation
* of this Software except as specified above is prohibited without the express
* written permission of Cypress.
*
* Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress
* reserves the right to make changes to the Software without notice. Cypress
* does not assume any liability arising out of the application or use of the
* Software or any product or circuit described in the Software. Cypress does
* not authorize its products for use in any products where a malfunction or
* failure of the Cypress product may reasonably be expected to result in
* significant property damage, injury or death ("High Risk Product"). By
* including Cypress's product in a High Risk Product, the manufacturer of such
* system or application assumes all risk of such use and in doing so agrees to
* indemnify Cypress against all liability.
*******************************************************************************/

/*******************************************************************************
* Include guard
*******************************************************************************/
#ifndef __CY_ML_INFERENCE_H
#define __CY_ML_INFERENCE_H

/*******************************************************************************
* Include header file
*******************************************************************************/
#include <stdint.h>
#include <stdbool.h>
/*******************************************************************************
* Compile-time flags
*******************************************************************************/

/*******************************************************************************
* NN data type
*******************************************************************************/
#if defined(COMPONENT_ML_FLOAT32)
  typedef float CY_ML_DATA_TYPE_T;
#elif defined(COMPONENT_ML_INT16x16) || defined(COMPONENT_ML_INT16x8)
  typedef int16_t CY_ML_DATA_TYPE_T;
#elif defined(COMPONENT_ML_INT8x8)
  typedef int8_t CY_ML_DATA_TYPE_T;
#else
    #error Unsupported data type
#endif

/******************************************************************************
 * Defines
 *****************************************************************************/
#define CY_ML_INFERENCE_VERSION_MAJOR       2
#define CY_ML_INFERENCE_VERSION_MINOR       0
#define CY_ML_INFERENCE_VERSION_PATCH       0
#define CY_ML_INFERENCE_VERSION             200

#define CY_ML_SUCCESS                       (0)

#define CY_ML_LINE_SHIFT                    (16u)
#define CY_ML_LINE_MASK                     (0xFFFF0000)

#define CY_ML_LAYER_ID_SHIFT                (8u)
#define CY_ML_LAYER_ID_MASK                 (0x0000FF00)
#define CY_ML_LAYER_ID_INVALID              (255u)

#define CY_ML_ERR_CODE_MASK                 (0x000000FF)
#define CY_ML_ERR_CORE_TOOL_VERSION         (0x01)
#define CY_ML_ERR_EXCEED_MAX_SCRATCH_MEM    (0x02)
#define CY_ML_ERR_LAYER_NOT_SUPPORTED       (0x03)
#define CY_ML_ERR_ACT_NOT_SUPPORTED         (0x04)
#define CY_ML_ERR_INPUT_DIMENTION           (0x05)
#define CY_ML_ERR_CONNECTION                (0x06)
#define CY_ML_ERR_OTHER_INPUT_MISSING       (0x07)
#define CY_ML_ERR_INVALID_ARGUMENT          (0x08)
#define CY_ML_ERR_MISMATCH_DATA_TYPE        (0x09)
#define CY_ML_ERR_MISMATCH_PARM_CHECKSUM    (0x0A)
#define CY_ML_ERR_INVALID_SCRATCH_MEM_OPT   (0x0B)

#define CY_ML_ERROR(x, y)                   ((__LINE__ << CY_ML_LINE_SHIFT) | \
                                            (((x) << CY_ML_LAYER_ID_SHIFT) & CY_ML_LAYER_ID_MASK) | \
                                            ((y) & CY_ML_ERR_CODE_MASK))
#define CY_ML_ERR_CODE(x)                   (uint8_t)((x) & CY_ML_ERR_CODE_MASK)
#define CY_ML_ERR_LAYER_INDEX(x)            (uint8_t)(((x) & CY_ML_LAYER_ID_MASK) >> CY_ML_LAYER_ID_SHIFT)
#define CY_ML_ERR_LINE_NUMBER(x)            (uint16_t)(((x) & CY_ML_LINE_MASK) >> CY_ML_LINE_SHIFT)

#define CY_ML_PROFILE_FRAME                 (0x01)
#define CY_ML_PROFILE_LAYER                 (0x02)
#define CY_ML_PROFILE_MODEL                 (0x04)
#define CY_ML_LOG_MODEL_OUTPUT              (0x10)

#define CY_ML_MODEL_OBJECT_SIZE             (360)
#define CY_ML_RES_CONN_OBJECT_SIZE          (8)
#if defined(COMPONENT_ML_FLOAT32)
  #define CY_ML_LAYER_OBJECT_SIZE           (80)
#else
  #define CY_ML_LAYER_OBJECT_SIZE           (88)
#endif

/*******************************************************************************
* Structures and enumerations
*******************************************************************************/
typedef enum
{
    CY_ML_DATA_UNKNOWN            = 0u,      
    CY_ML_DATA_INT8               = 1u,      
    CY_ML_DATA_INT16              = 2u,      
    CY_ML_DATA_FLOAT              = 3u,      
} cy_en_ml_data_type_t;

typedef enum
{
    CY_ML_PROFILE_DISABLE                     = 0,
    CY_ML_PROFILE_ENABLE_MODEL                = CY_ML_PROFILE_MODEL,
    CY_ML_PROFILE_ENABLE_LAYER                = CY_ML_PROFILE_LAYER,
    CY_ML_PROFILE_ENABLE_MODEL_PER_FRAME      = (CY_ML_PROFILE_MODEL | CY_ML_PROFILE_FRAME),
    CY_ML_PROFILE_ENABLE_LAYER_PER_FRAME      = (CY_ML_PROFILE_LAYER | CY_ML_PROFILE_FRAME),
    CY_ML_LOG_ENABLE_MODEL_LOG  = CY_ML_LOG_MODEL_OUTPUT
} cy_en_ml_profile_config_t;

typedef struct
{
        int output_size;        
        int scratch_mem;        
        int persistent_mem;     
        int input_size;         
        int num_of_layers;      
        int num_of_res_conns;   
        int recurrent_ts_size;  
        int libml_version;                      
        uint32_t ml_coretool_version;           
        cy_en_ml_data_type_t libml_input_type;  
        cy_en_ml_data_type_t libml_weight_type; 
} cy_stc_ml_model_info_t;

/******************************************************************************
* Function prototype
******************************************************************************/

typedef int (*cy_ml_cb_fun) (void* arg, char* buf, cy_en_ml_profile_config_t type);

extern int Cy_ML_Model_Inference(void *modelPt, void *input, void *output,
                                 int* in_out_q);

extern int Cy_ML_Model_Parse(char *fn_prms , cy_stc_ml_model_info_t *mdl_infoPt);

extern int Cy_ML_Model_Init(void **dPt_container
           , char *fn_prms, char *fn_ptr
           ,char *persistent_mem, char* scratch_mem, cy_stc_ml_model_info_t *mdl_infoPt);

extern int Cy_ML_Rnn_State_Control(void* modelPt, int rnn_status, int window_size);

int Cy_ML_Profile_Get_Tsc(uint32_t *val);

int Cy_ML_Profile_Init(void *modelPt, cy_en_ml_profile_config_t config, cy_ml_cb_fun cb_func, void *cb_arg);

int Cy_ML_Profile_Control(void *modelPt, cy_en_ml_profile_config_t config);

int Cy_ML_Profile_Print(void *modelPt);

#endif /*__CY_ML_INFERENCE_H */

/* [] END OF FILE */