DSPLIB_bufParams.h

Go to the documentation of this file.

/******************************************************************************
 *                                                                             *
 * module name       :DSPLIB                                                   *
 *                                                                             *
 * 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 DSPLIB_BUFPARAMS_H_
#define DSPLIB_BUFPARAMS_H_
 
#ifndef __OPENCL_VERSION__
#include <stdint.h>
#endif
 
static inline int32_t DSPLIB_sizeof(uint32_t type);
 
typedef enum _DSPLIB_data_type_e {
   /* Standard fixed point data types */
   DSPLIB_INT8   = 0, 
   DSPLIB_INT16  = 1, 
   DSPLIB_INT32  = 2, 
   DSPLIB_INT64  = 3, 
   DSPLIB_INT128 = 4, 
   DSPLIB_UINT8   = 5,  
   DSPLIB_UINT16  = 6,  
   DSPLIB_UINT24  = 7,  
   DSPLIB_UINT32  = 8,  
   DSPLIB_UINT64  = 9,  
   DSPLIB_UINT128 = 10, 
   /* Standard floating point data types */
   DSPLIB_FLOAT16 = 11, 
   DSPLIB_FLOAT32 = 12, 
   DSPLIB_FLOAT64 = 13  
} DSPLIB_data_type_e;
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed                                                 */
/* ---------------------------------------------------------------- */
// MACRO for determining signedness of DSPLIB data types; fragile in that it
// depends on ordering of DSPLIB_data_type_e
#define DSPLIB_ISSIGNED(type) ((type) < DSPLIB_UINT8 || (type) > DSPLIB_UINT128)
#define DSPLIB_SIGNEDNESS(type) (DSPLIB_ISSIGNED((type)) ? "signed" : "unsigned")
 
typedef enum _DSPLIB_dimension_e {
   DSPLIB_2D = 0, 
   DSPLIB_3D = 1, 
   DSPLIB_4D = 2, 
   DSPLIB_5D = 3, 
   DSPLIB_6D = 4  
} DSPLIB_dimension_e;
 
typedef struct {
   uint32_t data_type; 
   uint32_t dim_x; 
} DSPLIB_bufParams1D_t;
 
typedef struct {
   uint32_t data_type; 
   uint32_t dim_x; 
   uint32_t dim_y; 
   int32_t stride_y; 
} DSPLIB_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; 
} DSPLIB_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; 
} DSPLIB_bufParamsND_t;
 
static inline int32_t DSPLIB_sizeof(uint32_t type)
{
 
   int32_t size = 1;
 
   if ((type == (uint32_t) DSPLIB_INT8) || (type == (uint32_t) DSPLIB_UINT8)) {
      size = 1;
   }
   else if ((type == (uint32_t) DSPLIB_INT16) || (type == (uint32_t) DSPLIB_UINT16) ||
            (type == (uint32_t) DSPLIB_FLOAT16)) {
      size = 2;
   }
   else if (type == (uint32_t) DSPLIB_UINT24) {
      size = 3;
   }
   else if ((type == (uint32_t) DSPLIB_INT32) || (type == (uint32_t) DSPLIB_UINT32) ||
            (type == (uint32_t) DSPLIB_FLOAT32)) {
      size = 4;
   }
   else if ((type == (uint32_t) DSPLIB_INT64) || (type == (uint32_t) DSPLIB_UINT64) ||
            (type == (uint32_t) DSPLIB_FLOAT64)) {
      size = 8;
   }
   else if ((type == (uint32_t) DSPLIB_INT128) || (type == (uint32_t) DSPLIB_UINT128)) {
      size = 16;
   }
   else {
      size = 1;
   }
 
   return size;
}
 
#endif /* DSPLIB_BUFPARAMS_H_ */