c7120/FFTLIB_types.h

Go to the documentation of this file.

/******************************************************************************
 *                                                                             *
 * module name       :FFTLIB                                                   *
 *                                                                             *
 * 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 C7120_FFTLIB_TYPES_H_
#define C7120_FFTLIB_TYPES_H_ 1
 
#include <c7x.h> // for streaming engine, streaming address gen.
 
 
 
 
#ifdef __cplusplus
#include <c7x_scalable.h> // for device scalability
 
/******************************************************************************
 *
 * PREDEFINED VECTORS
 *
 ******************************************************************************/
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_1;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_2;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_3;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_4;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_5;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_6;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_scale_No_7;
 
// permutation register values for 32-bit bias
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_1;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_1;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_2;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_2;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_3; 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_3; 
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_4; 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_4;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_5;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_5;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_6; 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_6; 
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_32bit_No_7;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_32bit_No_7;
 
// permutation register values for 64-bit bias
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_64bit_No_1;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_64bit_No_1;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_64bit_No_2;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_64bit_No_2;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec0_64bit_No_3;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_biasVec1_64bit_No_3;
 
// split groups
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_1;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_2;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_3;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_4;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_5;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_6;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_scale_No_7;
 
// permutation register values for 32-bit bias, split groups
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_1;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_1;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_2;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_2;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_3;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_3;  
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_4; 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_4; 
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_5;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_5;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_6; 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_6; 
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_32bit_No_7;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_32bit_No_7;
 
// permutation register values for 64-bit bias, split groups
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_64bit_No_1;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_64bit_No_1;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_64bit_No_2;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_64bit_No_2;
 
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec0_64bit_No_3;
extern const c7x::uchar_vec FFTLIB_vperm_convolve_col_splitGroups_biasVec1_64bit_No_3;
 
extern "C" {
#endif /* __cplusplus */
 
/* @{ */
 
/*******************************************************************************
 *
 * TYPEDEFS
 *
 ******************************************************************************/
 
typedef enum {
   FFTLIB_NONE = 0,   
   FFTLIB_RELU,       
   FFTLIB_SATURATION, 
   FFTLIB_ROUNDING,   
   FFTLIB_PSAT,       
} FFTLIB_activation_type_e; // formerly eMMAActivationType;
 
 
   typedef enum {
      FFTLIB_DYNAMIC_RANGE_DISABLE = 0,          
      FFTLIB_DYNAMIC_RANGE_ENABLE  = 1,          
   } FFTLIB_enableDynamicRange_type_e;
 
   typedef enum {
      FFTLIB_DYNAMIC_RANGE_NOINIT = 0,          
      FFTLIB_DYNAMIC_RANGE_INIT   = 1,          
   } FFTLIB_initDynamicRange_type_e;
 
   typedef FFTLIB_enableDynamicRange_type_e FFTLIB_enableDynamicRange_type; 
   typedef FFTLIB_initDynamicRange_type_e FFTLIB_initDynamicRange_type; 
 
   typedef enum {
      FFTLIB_QUANT_PER_KERNEL = 0,
      FFTLIB_QUANT_PER_CHANNEL   = 1,
   } FFTLIB_quantMethod_type_e;
   typedef FFTLIB_quantMethod_type_e FFTLIB_quantMethod_type; 
   /*******************************************************************************
    *
    * DEFINES
    *
    ******************************************************************************/
 
#define FFTLIB_BYTE_WIDTH 64  
 
   /* ---------------------------------------------------------------- */
   /*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
   /*  being addressed                                                 */
   /* ---------------------------------------------------------------- */
   #define FFTLIB_CALC_STRIDE(BYTES, ALIGN_SHIFT)                                 \
     (((((BYTES)-1) >> (ALIGN_SHIFT)) + 1) << (ALIGN_SHIFT))
 
   #define FFTLIB_MMA_SIZE_8_BIT_SHIFT                                            \
     6 
   #define FFTLIB_MMA_SIZE_16_BIT_SHIFT                                           \
     5 
   #define FFTLIB_MMA_SIZE_32_BIT_SHIFT                                           \
     4 
 
   //#define FFTLIB_MMA_SIZE_1_BYTE    1
   #define FFTLIB_MMA_SIZE_8_BIT                                              \
     ((uint32_t)(((uint32_t)1)                                                     \
                << FFTLIB_MMA_SIZE_8_BIT_SHIFT)) 
   #define FFTLIB_MMA_SIZE_16_BIT                                                 \
     ((uint32_t)(((uint32_t)1)                                                     \
                << FFTLIB_MMA_SIZE_16_BIT_SHIFT)) 
   #define FFTLIB_MMA_SIZE_32_BIT                                                 \
     ((int32_t)(((uint32_t)1)                                                     \
                << FFTLIB_MMA_SIZE_32_BIT_SHIFT)) 
 
   /* @} */
 
 
 
/*******************************************************************************
 *
 * DEFINES
 *
 ******************************************************************************/
 
 
/*******************************************************************************
 *
 * Macros
 *
 ******************************************************************************/
 
 
 
/* @} */
 
 
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* C7120_FFTLIB_TYPES_H_ */
 
/* ======================================================================== */
/*  End of file:  FFTLIB_types.h                                             */
/* ======================================================================== */