c7524f/MMALIB_types.h

Go to the documentation of this file.

/******************************************************************************
 *                                                                             *
 * module name       :MMALIB                                                   *
 *                                                                             *
 * module descripton :Matrix Multiply Accelerator Library module for C7x+MMA   *
 *                                                                             *
 * Copyright (C) 2017-2018 Texas Instruments Incorporated - https://www.ti.com/ *
 * ALL RIGHTS RESERVED                                                         *
 *                                                                             *
 ******************************************************************************/
 
#ifndef C75x4_MMALIB_TYPES_H_
#define C75x4_MMALIB_TYPES_H_ 1
 
#include <c7x.h> // for streaming engine, streaming address gen.
//#include <c7x_scalable.h> // for device scalability
 
//using namespace c7x;
 
 
 
 
#ifdef __cplusplus
#include <c7x_scalable.h> // for device scalability
 
/******************************************************************************
 *
 * PREDEFINED VECTORS
 *
 ******************************************************************************/
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_1;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_2;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_3;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_4;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_5;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_6;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_scale_No_7;
 
// permutation register values for 32-bit bias
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec0_32bit_No_1;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec1_32bit_No_1;
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec0_32bit_No_2;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec1_32bit_No_2;
 
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec0_32bit_No_3;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec1_32bit_No_3;
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec0_32bit_No_4;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec1_32bit_No_4;
 
// permutation register values for 64-bit bias
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec0_64bit_No_1;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_biasVec1_64bit_No_1;
 
// split groups
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_1;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_2;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_3;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_4;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_5;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_6;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_scale_No_7;
 
// permutation register values for 32-bit bias, split groups
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_1;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_1;
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_2;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_2;
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_3;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_3;
 
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_4;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_4;
 
 
// permutation register values for 64-bit bias, split groups
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec0_64bit_No_1;
extern const c7x::uchar_vec MMALIB_vperm_convolve_col_splitGroups_biasVec1_64bit_No_1;
 
 
extern "C" {
#endif /* __cplusplus */
 
/*******************************************************************************
 *
 * TYPEDEFS
 *
 ******************************************************************************/
 
   typedef enum {
      MMALIB_NONE = 0,   
      MMALIB_RELU,       
      MMALIB_SATURATION, 
      MMALIB_ROUNDING,   
      MMALIB_PSAT,       
   } MMALIB_activation_type_e; // formerly eMMAActivationType
   typedef MMALIB_activation_type_e MMALIB_activation_type;
 
   typedef enum {
      MMALIB_DYNAMIC_RANGE_DISABLE = 0,          
      MMALIB_DYNAMIC_RANGE_ENABLE  = 1,          
   } MMALIB_enableDynamicRange_type_e;
 
   typedef enum {
      MMALIB_DYNAMIC_RANGE_NOINIT = 0,          
      MMALIB_DYNAMIC_RANGE_INIT   = 1,          
   } MMALIB_initDynamicRange_type_e;
 
   typedef MMALIB_enableDynamicRange_type_e MMALIB_enableDynamicRange_type; 
   typedef MMALIB_initDynamicRange_type_e MMALIB_initDynamicRange_type; 
 
   typedef enum {
      MMALIB_QUANT_PER_KERNEL = 0,
      MMALIB_QUANT_PER_CHANNEL   = 1,
   } MMALIB_quantMethod_type_e;
   typedef MMALIB_quantMethod_type_e MMALIB_quantMethod_type; 
 
 
   /*******************************************************************************
    *
    * DEFINES
    *
    ******************************************************************************/
 
/* #define MMALIB_BYTE_WIDTH 32  //!< MMA width in bytes */
 
 
 
  /* ---------------------------------------------------------------- */
   /*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
   /*  being addressed                                                 */
   /* ---------------------------------------------------------------- */
   #define MMALIB_CALC_STRIDE(BYTES, ALIGN_SHIFT)                                 \
     (((((BYTES)-1) >> (ALIGN_SHIFT)) + 1) << (ALIGN_SHIFT))
 
#define MMALIB_MMA_SIZE_8_BIT_SHIFT   5 
#define MMALIB_MMA_SIZE_16_BIT_SHIFT  4 
#define MMALIB_MMA_SIZE_32_BIT_SHIFT  3 
 
 
   /* /\*! @brief MMA size as a function of precision *\/ */
   /* //#define MMALIB_MMA_SIZE_1_BYTE    1 */
   /* #define MMALIB_MMA_SIZE_8_BIT                                              \ */
   /*   ((uint32_t)(((uint32_t)1)                                                     \ */
   /*              << MMALIB_MMA_SIZE_8_BIT_SHIFT)) //!< Shift for MMA size when data */
   /*                                               //!< type is 8-bit integers */
   /* #define MMALIB_MMA_SIZE_16_BIT                                                 \ */
   /*   ((uint32_t)(((uint32_t)1)                                                     \ */
   /*              << MMALIB_MMA_SIZE_16_BIT_SHIFT)) //!< Shift for MMA size when data */
   /*                                                //!< type is 16-bit integers */
   /* #define MMALIB_MMA_SIZE_32_BIT                                                 \ */
   /*   ((int32_t)(((uint32_t)1)                                                     \ */
   /*              << MMALIB_MMA_SIZE_32_BIT_SHIFT)) //!< Shift for MMA size when data */
   /*                                                //!< type is 32-bit integers */
 
 
/*******************************************************************************
 *
 * DEFINES
 *
 ******************************************************************************/
 
#define MMALIB_ILUT_SUPPORT 1
#define MMALIB_ILUT_NUM_BYTES 256
 
 
/*******************************************************************************
 *
 * Macros
 *
 ******************************************************************************/
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* C75x4_MMALIB_TYPES_H_ */
 
/* ======================================================================== */
/*  End of file:  MMALIB_types.h                                             */
/* ======================================================================== */