MMALIB_CNN_convolve_col_smallNo_highPrecision.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                                                         *
 *                                                                             *
 ******************************************************************************/
 
/********************************************************************************
 *  @file     MMALIB_CNN_convolve_col_smallNo_highPrecision.h
 *
 *  @brief    Public header file for MMALIB_CNN_convolve_col_smallNo_highPrecision
 *            function
 *
 *  @version  0.1 - Feb 2018 : Initial Version
 *
 ********************************************************************************/
 
#ifndef MMALIB_CNN_CONVOLVE_COL_SMALLNO_HIGHPRECISION_H_
#define MMALIB_CNN_CONVOLVE_COL_SMALLNO_HIGHPRECISION_H_
 
#include "../../common/MMALIB_types.h"
#include "MMALIB_CNN_convolve_col_smallNo_highPrecision_reorderWeights.h"
#include "../MMALIB_CNN_convolve_col_smallNo_highPrecision_pointwisePost/MMALIB_CNN_convolve_col_smallNo_highPrecision_pointwisePost.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
   // alias
   typedef MMALIB_CNN_CONVOLVE_COL_SMALLNO_HIGHPRECISION_POINTWISEPOST_STATUS_NAME MMALIB_CNN_CONVOLVE_COL_SMALLNO_HIGHPRECISION_STATUS_NAME;   
   
#define MMALIB_CONVOLVE_COL_SHIFT_PER_GROUP 1   
 
//   typedef struct
//   {
//      int8_t    funcStyle;      //!< Variant of the function; refer to @ref MMALIB_FUNCTION_STYLE
//      int32_t   Ni;             //!< Number of input channels to be processed
//      int32_t   No;             //!< Number of output channels to be processed
//      int32_t   Fr;             //!< Number of kernel rows (height)
//      int32_t   Fc;             //!< Number of kernel columns (width)
//      uint8_t   shift;          //!< Number of bits of right shift parameter for output precision
//      int8_t    shiftMethod;    //!< Control behavior of MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs.shift.  @ref MMALIB_CONVOLVE_COL_SHIFT_PER_GROUP is currently the only supported value.
//      int32_t   strideX;        //!< Stride size across columns (horizontal dimension)
//      int32_t   strideY;        //!< Stride size across rows (vertical dimension)
//      int32_t   dilationX;      //!< Dilation of kernel width
//      int32_t   dilationY;      //!< Dilation of kernel height
//      int32_t   topPad;         //!< pixels of pad to apply to the top side of the input data
//      int32_t   bottomPad;      //!< pixels of pad to apply to the bottom side of the input data
//      int32_t   leftPad;        //!< pixels of pad to apply to the left side of the input data
//      int32_t   rightPad;       //!< pixels of pad to apply to the right side of the input data
//#if defined(__C7100__)
//      int32_t   bias;           //!< Bias value in B matrix
//      int32_t   biasDataType;   //!< Data type of the bias
//      int32_t   numBiasVals;    //!< Number of elements used for the bias (cols in weights, rows in feature maps)
//#endif
//      uint8_t   activationType; //!< Activation of RELU, SAT or none for output
//      int32_t   featureWidth;   //!< Total feature map width, without pad
//      int32_t   blockFeatureHeight; //!< Number of rows from the input feature map to be processed, without pad
//      int32_t   blockFeaturePitch; //!< Pitch between rows of input feature map, in bytes, without pad
//      int32_t   columnOffset;   //!< Distance, in elements, between starting points of even-numbered input feature map block columns (0,2,4,...)
//      int32_t   inPairOffset;   //!< Distance, in elements, between the even- and odd-numbered input feature map block columns (i.e. distance from 0 to 1)
//#if defined(MMALIB_CONVOLVE_COL_IN_KERNEL_PADDING)
//      int32_t   groupOffset;    //!< Distance, in elements, between groups
//#endif
//#if defined(MMALIB_ENABLE_DYNAMIC_RANGE_TRACKING)
//      int32_t   pSatMin;        //!< Minimum value for parameterized saturation 
//      int32_t   pSatMax;        //!< Maximum value for parameterized saturation 
//#endif
//      int32_t   inChOffset;     //!< Distance, in elements, between the input channels
//      int32_t   outPairOffset;  //!< Distance, in elements, between the output of the even- and odd-numbered output feature map block columns
//      int32_t   numGroupsPerKernel; //!< Number of groups to be processed in a single kernel call
//   } MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs ;
 
 
// alias pointwisePost initArgs to this version; this only works if the structures are identical.
// if separate fields are needed, then we either need to add a default initializer or an assignement function (too many cycles of overhead, though)
typedef MMALIB_CNN_convolve_col_smallNo_highPrecision_pointwisePost_InitArgs MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs; 
 
 
 
//   typedef struct
//   {
//      int32_t   blockFeatureWidth;                       //!< Width of the input feature map to be processed
//      int32_t   padFillValue;                            //!< Pad fill value, must be zero for C7100 devices
//#if defined(MMALIB_ENABLE_DYNAMIC_RANGE_TRACKING)
//      MMALIB_enableDynamicRange_type enableDynamicRange; //!< Flag indicating whether to enable dynamic range range (min,max) calculation.
//      MMALIB_initDynamicRange_type  initDynamicRange;    //!< Flag indicating whether to reset dynamic range (min,max) calculation at beginning of compute.
//#endif
//   } MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs ;
 
   // alias
   typedef MMALIB_CNN_convolve_col_smallNo_highPrecision_pointwisePost_ExecInArgs MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs ;
 
//   typedef struct
//   {
//      int32_t validColsOut;    //!< Width of buffer C
//#if defined(MMALIB_ENABLE_DYNAMIC_RANGE_TRACKING)
//      int64_t dynamicRangeMin;      //!< Minimum computed value, controlled with MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs.initDynamicRange
//      int64_t dynamicRangeMax;      //!< Maximum computed value, controlled with MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs.initDynamicRange
//#endif
//   } MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecOutArgs ;
   // alias
   typedef MMALIB_CNN_convolve_col_smallNo_highPrecision_pointwisePost_ExecOutArgs MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecOutArgs ;
 
 
   int32_t MMALIB_CNN_convolve_col_smallNo_highPrecision_getHandleSize(MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs *pKerInitArgs);
 
 
MMALIB_STATUS MMALIB_CNN_convolve_col_smallNo_highPrecision_init(MMALIB_kernelHandle handle,
                                                                 const MMALIB_bufParams3D_t * src0_addr,
                                                                 const MMALIB_bufParams2D_t * src1_addr,
                                                                 const MMALIB_bufParams2D_t * src2_addr,
                                                                 const MMALIB_bufParams1D_t * src3_addr,
                                                                 const MMALIB_bufParams3D_t * dst_addr ,
                                                                 const MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs *pKerInitArgs);
 
 
MMALIB_STATUS MMALIB_CNN_convolve_col_smallNo_highPrecision_init_checkParams(MMALIB_kernelHandle handle,
                                                                             const MMALIB_bufParams3D_t * src0_addr,
                                                                             const MMALIB_bufParams2D_t * src1_addr,
                                                                             const MMALIB_bufParams2D_t * src2_addr,
                                                                             const MMALIB_bufParams1D_t * src3_addr,
                                                                             const MMALIB_bufParams3D_t * dst_addr,
                                                                             const MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs *pKerInitArgs);
 
 
   MMALIB_STATUS MMALIB_CNN_convolve_col_smallNo_highPrecision_exec(MMALIB_kernelHandle handle,
                                                                  const void *src0,
                                                                  const void *src1,
                                                                  const void *src2,
                                                                  const void *src3,
                                                                  const uint8_t *shiftValues,
                                                                  void *restrict dst,
                                                                  const MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs *pKerInArgs,
                                                                  MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecOutArgs *pKerOutArgs);
 
 
    MMALIB_STATUS MMALIB_CNN_convolve_col_smallNo_highPrecision_exec_checkParams(MMALIB_kernelHandle handle,
                                                                             const void *src0,
                                                                             const void *src1,
                                                                             const void *src2,
                                                                             const void *src3,
                                                                             const uint8_t *shiftValues,
                                                                             const void *dst,
                                                                             const MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs *pKerInArgs);
 
   
// void MMALIB_CNN_convolve_col_smallNo_highPrecision_perfEst( MMALIB_kernelHandle handle,
//                                                            const MMALIB_bufParams3D_t * src0_addr,
//                                                            const MMALIB_bufParams2D_t * src1_addr,
//                                                            const MMALIB_bufParams2D_t * src2_addr,
//                                                            const MMALIB_bufParams1D_t * src3_addr,
//                                                            const MMALIB_bufParams3D_t * dst_addr,
//                                                            const MMALIB_CNN_convolve_col_smallNo_highPrecision_InitArgs *pKerInitArgs,
//                                                            const MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecInArgs *pExecInArgs,
//                                                            MMALIB_CNN_convolve_col_smallNo_highPrecision_ExecOutArgs *pExecOutArgs,
//                                                            uint64_t *archCycles,  uint64_t *estCycles);
   
#ifdef __cplusplus
}
#endif
#endif /* MMALIB_CNN_CONVOLVE_COL_SMALLNO_HIGHPRECISION_H_ */
 
/* ======================================================================== */
/*  End of file:  MMALIB_CNN_convolve_col_smallNo_highPrecision.h                     */
/* ======================================================================== */