MMALIB_bufParams.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 MMALIB_BUFPARAMS_H_
#define MMALIB_BUFPARAMS_H_
 
#ifndef __OPENCL_VERSION__
#include <stdint.h>
#endif
 
 
static inline int32_t MMALIB_sizeof(uint32_t type);
 
typedef enum _MMALIB_data_type_e
{
   /* Standard fixed point data types */
   MMALIB_INT8    = 0,  
   MMALIB_INT16   = 1,  
   MMALIB_INT32   = 2,  
   MMALIB_INT64   = 3,  
   MMALIB_INT128  = 4,  
   MMALIB_UINT8   = 5,  
   MMALIB_UINT16  = 6,  
   MMALIB_UINT24  = 7,  
   MMALIB_UINT32  = 8,  
   MMALIB_UINT64  = 9,  
   MMALIB_UINT128 = 10, 
   /* Standard floating point data types */
   MMALIB_FLOAT16 = 11,  
   MMALIB_FLOAT32 = 12,  
   MMALIB_FLOAT64 = 13   
} MMALIB_data_type_e;
 
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed                                                 */
/* ---------------------------------------------------------------- */  
// MACRO for determining signedness of MMALIB data types; fragile in that it depends on ordering of MMALIB_data_type_e
#define MMALIB_ISSIGNED(type) ((type) < MMALIB_UINT8 || (type) > MMALIB_UINT128)
#define MMALIB_SIGNEDNESS(type) (MMALIB_ISSIGNED((type)) ? "signed" : "unsigned")
 
typedef enum _MMALIB_dimension_e {
   MMALIB_2D= 0,   
   MMALIB_3D= 1,   
   MMALIB_4D= 2,   
   MMALIB_5D= 3,   
   MMALIB_6D= 4    
} MMALIB_dimension_e;
 
typedef struct
{
   uint32_t data_type;    
   uint32_t dim_x;        
} MMALIB_bufParams1D_t;
 
typedef struct
{
   uint32_t data_type;     
   uint32_t dim_x;        
   uint32_t dim_y;        
   int32_t  stride_y;     
} MMALIB_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;     
} MMALIB_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;    
} MMALIB_bufParamsND_t;
 
 
static const int32_t size_of_type[] = {
1,  // MMALIB_INT8
2,  // MMALIB_INT16
4,  // MMALIB_INT32
8,  // MMALIB_INT64
16, // MMALIB_INT128
1,  // MMALIB_UINT8
2,  // MMALIB_UINT16
3,  // MMALIB_UINT24
4,  // MMALIB_UINT32
8,  // MMALIB_UINT64
16, // MMALIB_UINT128
2,  // MMALIB_FLOAT16
4,  // MMALIB_FLOAT32
8   // MMALIB_FLOAT64
};
 
static inline int32_t MMALIB_sizeof(uint32_t type)
{
 
   return 
   /* LDRA_JUSTIFY_START
<metric start> statement branch <metric end>
<justification start> Passing only valid types to MMALIB_sizeofsizeof function. The type never goes beyond 13.
<justification end> */
(type > (uint32_t) 13) ? 1 : 
/* LDRA_JUSTIFY_END */
size_of_type[type];
 
}
 
#endif /* MMALIB_BUFPARAMS_H_ */