FFTLIB_bufParams.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 FFTLIB_BUFPARAMS_H_
#define FFTLIB_BUFPARAMS_H_
 
#ifndef __OPENCL_VERSION__
#include <stdint.h>
#endif
 
 
/* @{ */
 
static inline int32_t FFTLIB_sizeof(uint32_t type);
 
typedef enum _FFTLIB_data_type_e
{
   /* Standard fixed point data types */
   FFTLIB_INT8    = 0,  
   FFTLIB_INT16   = 1,  
   FFTLIB_INT32   = 2,  
   FFTLIB_INT64   = 3,  
   FFTLIB_INT128  = 4,  
   FFTLIB_UINT8   = 5,  
   FFTLIB_UINT16  = 6,  
   FFTLIB_UINT24  = 7,  
   FFTLIB_UINT32  = 8,  
   FFTLIB_UINT64  = 9,  
   FFTLIB_UINT128 = 10, 
   /* Standard floating point data types */
   FFTLIB_FLOAT16 = 11,  
   FFTLIB_FLOAT32 = 12,  
   FFTLIB_FLOAT64 = 13   
} FFTLIB_data_type_e;
 
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed                                                 */
/* ---------------------------------------------------------------- */
// MACRO for determining signedness of FFTLIB data types; fragile in that it depends on ordering of FFTLIB_data_type_e
#define FFTLIB_ISSIGNED(type) ((type) < FFTLIB_UINT8 || (type) > FFTLIB_UINT128)
#define FFTLIB_SIGNEDNESS(type) (FFTLIB_ISSIGNED((type)) ? "signed" : "unsigned")
 
typedef enum _FFTLIB_dimension_e {
   FFTLIB_2D= 0,   
   FFTLIB_3D= 1,   
   FFTLIB_4D= 2,   
   FFTLIB_5D= 3,   
   FFTLIB_6D= 4    
} FFTLIB_dimension_e;
 
typedef struct
{
   uint32_t data_type;    
   uint32_t dim_x;        
} FFTLIB_bufParams1D_t;
 
typedef struct
{
   uint32_t data_type;     
   uint32_t dim_x;        
   uint32_t dim_y;        
   int32_t  stride_y;     
} FFTLIB_bufParams2D_t;
 
typedef struct
{
   uint32_t data_type;     
   uint32_t dim_x;        
   uint32_t dim_y;        
   int32_t  stride_y;     
   uint32_t dim_z;        
   int32_t  stride_z;     
} FFTLIB_bufParams3D_t;
 
typedef struct
{
    uint32_t data_type;     
    uint32_t dim_0;
 
    uint32_t dim_1;
    int32_t  stride_1; 
    uint32_t dim_2;  
    int32_t  stride_2; 
    uint32_t dim_3;  
    int32_t  stride_3; 
    uint32_t dim_4;  
    int32_t  stride_4; 
    uint32_t dim_5;  
    int32_t  stride_5; 
    uint32_t dimension;    
} FFTLIB_bufParamsND_t;
 
 
static inline int32_t FFTLIB_sizeof(uint32_t type)
{
 
   int32_t size = 1;
 
   if((type == (uint32_t)FFTLIB_INT8)  ||
      (type == (uint32_t)FFTLIB_UINT8))
   {
      size = 1;
   }
   else if((type == (uint32_t)FFTLIB_INT16)  ||
       (type == (uint32_t)FFTLIB_UINT16) ||
       (type == (uint32_t)FFTLIB_FLOAT16))
   {
      size = 2;
   }
   else if(type == (uint32_t)FFTLIB_UINT24)
   {
      size = 3;
   }
   else if((type == (uint32_t)FFTLIB_INT32)  ||
       (type == (uint32_t)FFTLIB_UINT32) ||
       (type == (uint32_t)FFTLIB_FLOAT32))
   {
      size = 4;
   }
   else if((type == (uint32_t)FFTLIB_INT64)  ||
       (type == (uint32_t)FFTLIB_UINT64) ||
       (type == (uint32_t)FFTLIB_FLOAT64))
   {
      size = 8;
   }
   else if((type == (uint32_t)FFTLIB_INT128)  ||
       (type == (uint32_t)FFTLIB_UINT128))
   {
      size = 16;
   }
   else {
      size = 1;
   }
 
   return size;
}
 
/* @} */
#endif /* FFTLIB_BUFPARAMS_H_ */