DSPLIB_types.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 COMMON_DSPLIB_TYPES_H_
#define COMMON_DSPLIB_TYPES_H_ 1
 
/* This header is needed to be included in OpenCL programs which link
 * against DSPLIB, but OpenCL doesn't need the following headers */
#ifndef __OPENCL_VERSION__
#include <inttypes.h>
#include <stddef.h> // for NULL
#include <stdint.h>
#include <stdio.h> // for printf
#include <stdlib.h>
#endif
#include <c7x.h> // for streaming engine, streaming address gen.
 
#include "DSPLIB_bufParams.h"
#include "TI_platforms.h"
 
#if !defined(DSPLIB_DEBUGPRINT)
#define DSPLIB_DEBUGPRINT 0 
#endif
 
#if (defined(_HOST_BUILD) && (DSPLIB_COMPILER_VERSION < 1003999))
#define DSPLIB_const
#else
#define DSPLIB_const const
#endif
 
#define __PRAGMA(x) _Pragma(#x)
#ifdef __cplusplus
#define __INLINE_FUNC(x) __PRAGMA(FUNC_ALWAYS_INLINE)
#else
#define __INLINE_FUNC(x) __PRAGMA(FUNC_ALWAYS_INLINE(x))
#endif
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The following two       */
/*  function-like macros do not have equivalent function            */
/*  implementations.                                                */
/* ---------------------------------------------------------------- */
#if defined(EVM_TEST)
#define DSPLIB_PRINTF(fmt, ...) fprintf(stdout, fmt, __VA_ARGS__);
 
#if DSPLIB_DEBUGPRINT > 0
#define DSPLIB_DEBUGPRINTFN(N, fmt, ...)                                                                               \
   do {                                                                                                                \
      if (DSPLIB_DEBUGPRINT >= (N)) {                                                                                  \
         fprintf(stdout, "DSPLIB debug %s - %d: " fmt, __FUNCTION__, __LINE__, __VA_ARGS__);                           \
      }                                                                                                                \
   } while (0)
 
#else // DSPLIB_DEBUGPRINT == 0
 
#define DSPLIB_DEBUGPRINTFN(N, fmt, ...)
//#define DSPLIB_PRINTF(fmt, ...)
#endif // #if DSPLIB_DEBUGPRINT
 
#else
 
#if DSPLIB_DEBUGPRINT > 0
#define DSPLIB_DEBUGPRINTFN(N, fmt, ...)                                                                               \
   if (DSPLIB_DEBUGPRINT >= (N)) {                                                                                     \
      fprintf(stdout, "DSPLIB debug %s - %d: " fmt, __FUNCTION__, __LINE__, __VA_ARGS__);                              \
   }
 
#define DSPLIB_PRINTF(fmt, ...) fprintf(stdout, fmt, __VA_ARGS__)
 
#else // DSPLIB_DEBUGPRINT == 0
 
#define DSPLIB_DEBUGPRINTFN(N, fmt, ...)
#define DSPLIB_PRINTF(fmt, ...)
 
#endif // #if DSPLIB_DEBUGPRINT
#endif // #if defined(EVM_TEST)
 
#if defined(DSPLIB_MESSAGES)
// if enabled, display messages to the library user
// DSPLIB_MESSAGES should only be defined when TARGET_BUILD=debug or
// CHECKPARAMS=1
#define DSPLIB_MESG(fmt, ...) fprintf(stdout, fmt, __VA_ARGS__)
#else
#define DSPLIB_MESG(fmt, ...)
#endif //#if defined(DSPLIB_MESSAGES)
 
/* Original implementation that had the benefit of always being compiled and
thus receiving error checking.  However, the fprintf generates a MISRA-C
violation.
#define DSPLIB_DEBUGPRINTFN(N, fmt, ...)                                       \
  do {                                                                         \
    if (DSPLIB_DEBUGPRINT >= (N)) {                                            \
      fprintf(stdout, "DSPLIB debug %s - %d: " fmt, __FUNCTION__, __LINE__,    \
              __VA_ARGS__);                                                    \
    }                                                                          \
  } while (0)
 
#define DSPLIB_PRINTF(fmt, ...)                                                \
   do {                                                                        \
       fprintf(stdout, fmt, __VA_ARGS__);                                      \
   } while (0)
#endif
 */
 
#define DSPLIB_SOFT_MMA_RESET 0
 
// switch to enable or disable static inline for DSPLIB functions defined in .c
// files (so not many functions)
#define DSPLIB_STATIC_INLINE static inline
 
#ifdef __cplusplus
#include <c7x_scalable.h> // for device scalability
 
extern const c7x::uchar_vec  DSPLIB_zeroVect_uchar_vec;
extern const c7x::ushort_vec DSPLIB_zeroVect_ushort_vec;
extern const c7x::uchar_vec  DSPLIB_vperm_data_0_63;
 
extern "C" {
#endif /* __cplusplus */
 
/*******************************************************************************
 *
 * TYPEDEFS
 *
 ******************************************************************************/
 
typedef double DSPLIB_D64; 
typedef float  DSPLIB_F32; 
 
typedef enum {
   DSPLIB_SUCCESS                      = 0, 
   DSPLIB_ERR_FAILURE                  = 1, 
   DSPLIB_ERR_INVALID_VALUE            = 2, 
   DSPLIB_ERR_INVALID_TYPE             = 3, 
   DSPLIB_ERR_INVALID_DIMENSION        = 4, 
   DSPLIB_ERR_NULL_POINTER             = 5, 
   DSPLIB_ERR_NOT_IMPLEMENTED          = 6, 
   DSPLIB_ERR_NOT_EQUAL_WIDTH_STRIDE   = 7, 
   DSPLIB_ERR_NOT_ALIGNED_PTRS_STRIDES = 8, 
   DSPLIB_ERR_NOT_ALIGNED_WIDTHS = 9,       
   DSPLIB_ERR_BUFFER_TOO_SMALL   = 10,      
   DSPLIB_ERR_INVALID_ACTIVATION = 11,      
   DSPLIB_ERR_INVALID_SHIFT      = 12,      
   DSPLIB_ERROR_MAX              = 13,
 
} DSPLIB_STATUS_NAME;
 
typedef DSPLIB_STATUS_NAME DSPLIB_STATUS; 
 
typedef void *DSPLIB_kernelHandle; 
 
typedef enum {
   DSPLIB_FUNCTION_NATC = 0,  
   DSPLIB_FUNCTION_OPTIMIZED, 
   DSPLIB_FUNCTION_MAX = 128
} DSPLIB_FUNCTION_STYLE;
 
/*******************************************************************************
 *
 * DEFINES
 *
 ******************************************************************************/
 
#define DSPLIB_PARAM_SIZE 128 
 
/*******************************************************************************
 *
 * Macros
 *
 ******************************************************************************/
 
#define DSPLIB_ALIGN_SHIFT_64BYTES 6  
#define DSPLIB_ALIGN_SHIFT_128BYTES 7 
#define DSPLIB_ALIGN_SHIFT_256BYTES 8 
 
#define DSPLIB_ALIGN_64BYTES (1 << DSPLIB_ALIGN_SHIFT_64BYTES)   
#define DSPLIB_ALIGN_128BYTES (1 << DSPLIB_ALIGN_SHIFT_128BYTES) 
#define DSPLIB_ALIGN_256BYTES (1 << DSPLIB_ALIGN_SHIFT_256BYTES) 
 
#define DSPLIB_L2DATA_ALIGN_SHIFT DSPLIB_ALIGN_SHIFT_64BYTES 
 
#define DSPLIB_L2DATA_ALIGNMENT (((uint32_t) 1) << ((uint32_t) DSPLIB_L2DATA_ALIGN_SHIFT))
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed                                                 */
/* ---------------------------------------------------------------- */
 
/* @} */
 
/******************************************************************************
 *
 *  Do not document these in the User Guide
 ******************************************************************************/
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed                                                 */
/* ---------------------------------------------------------------- */
// remove asm comments for Loki testing as they may add cycles
#if defined(QT_TEST) || defined(RTL_TEST) || defined(EVM_TEST)
#if defined(_HOST_BUILD)
#define DSPLIB_asm(string) ;
#else
#define DSPLIB_asm(string)                                                                                             \
   ;                                                                                                                   \
   asm(string);
#endif // _HOST_BUILD
#else
#define DSPLIB_asm(string) ;
#endif
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed  so as not to lose portability across different */
/*  platforms.                                                      */
/* ---------------------------------------------------------------- */
// cl7x unroll attributes not recognized by gcc/gpp compiler and generate
// warnings. Remove them with macro
#if defined(_HOST_BUILD)
#define str(x) #x
#define xstr(x) str(x)
#ifdef WIN32
#define __attribute__()
#define DSPLIB_UNROLL(count)
#else
#define DSPLIB_UNROLL(count) _Pragma(str(UNROLL(count)))
#endif
#else
#define DSPLIB_UNROLL(COUNT) [[TI::unroll(COUNT)]]
#endif
 
#if defined(_HOST_BUILD)
#ifdef WIN32
#define __attribute__()
#define DSPLIB_MUST_ITERATE(initial, max, multiple)
#else
#define DSPLIB_MUST_ITERATE(initial, max, multiple) _Pragma(str(MUST_ITERATE(initial, max, multiple)))
#endif
#else
#define DSPLIB_MUST_ITERATE(INTIAL, MAX, MULTIPLE) [[TI::must_iterate(INTIAL, MAX, MULTIPLE)]]
#endif
 
#ifndef DSPLIB_NUMBER_RANDOM_DIM_TESTS
#define DSPLIB_NUMBER_RANDOM_DIM_TESTS 25
#endif
 
#if defined(PERFORMANCE_TEST)
#define DSPLIB_PERFORMANCE_TEST_PATTERN SEQUENTIAL
#else
#define DSPLIB_PERFORMANCE_TEST_PATTERN RANDOM_SIGNED
#endif
 
#define DSPLIB_TEST_OUTPUT_HEAP 0
#if defined(_HOST_BUILD)
// Valgrind works better when output is in the heap (it can't track statically
// allocated memory), so in host emulation mode, place test outputs in the heap
// rather than statically allocated MSMC
#define DSPLIB_TEST_OUTPUT_MSMC DSPLIB_TEST_OUTPUT_HEAP
#else
#define DSPLIB_TEST_OUTPUT_MSMC 1
#endif
 
#define STRIDE_OPT_4CYCLE 1
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The advisory is not     */
/*  being addressed                                                 */
/* ---------------------------------------------------------------- */
 
#define DSPLIB_BYTE_WIDTH 32 
#define DSPLIB_CALC_STRIDE(BYTES, ALIGN_SHIFT) (((((BYTES) -1) >> (ALIGN_SHIFT)) + 1) << (ALIGN_SHIFT))
 
/*******************************************************************************
 *
 * MACROS
 *
 ******************************************************************************/
 
/* ---------------------------------------------------------------- */
/*  MISRAC Rule 4.9(DEFINE.FUNC) Deviation: The following           */
/*  function-like macros are intended to be used across different   */
/*  data types.                                                     */
/* ---------------------------------------------------------------- */
#define DSPLIB_min(x, y) (((x) < (y)) ? (x) : (y)) 
#define DSPLIB_max(x, y) (((x) < (y)) ? (y) : (x)) 
#define DSPLIB_ceilingDiv(x, y)                                                                                        \
   (((x) + (y) -1) / (y)) 
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* COMMON_DSPLIB_TYPES_H_ */
 
/* ======================================================================== */
/*  End of file:  DSPLIB_types.h                                             */
/* ======================================================================== */