DSPLIB User Guide
DSPLIB_types.h File Reference

Go to the source code of this file.

Macros

#define DSPLIB_DEBUGPRINT   0
 Enable debug printf statements. More...
 
#define DSPLIB_const   const
 
#define __PRAGMA(x)   _Pragma(#x)
 
#define __INLINE_FUNC(x)   __PRAGMA(FUNC_ALWAYS_INLINE(x))
 
#define DSPLIB_DEBUGPRINTFN(N, fmt, ...)
 
#define DSPLIB_PRINTF(fmt, ...)
 
#define DSPLIB_MESG(fmt, ...)
 
#define DSPLIB_SOFT_MMA_RESET   0
 
#define DSPLIB_STATIC_INLINE   static inline
 
#define DSPLIB_PARAM_SIZE   128
 Parameter structure size in bytes. More...
 
#define DSPLIB_ALIGN_SHIFT_64BYTES   6
 Number of bits to shift for 64-byte memory alignment. More...
 
#define DSPLIB_ALIGN_SHIFT_128BYTES   7
 Number of bits to shift for 128-byte memory alignment. More...
 
#define DSPLIB_ALIGN_SHIFT_256BYTES   8
 Number of bits to shift for 256-byte memory alignment. More...
 
#define DSPLIB_ALIGN_64BYTES   (1 << DSPLIB_ALIGN_SHIFT_64BYTES)
 Align by 64-byte memory alignment. More...
 
#define DSPLIB_ALIGN_128BYTES   (1 << DSPLIB_ALIGN_SHIFT_128BYTES)
 Align by 128-byte memory alignment. More...
 
#define DSPLIB_ALIGN_256BYTES   (1 << DSPLIB_ALIGN_SHIFT_256BYTES)
 Align by 256-byte memory alignment. More...
 
#define DSPLIB_L2DATA_ALIGN_SHIFT   DSPLIB_ALIGN_SHIFT_64BYTES
 Set the default L2 data alignment. More...
 
#define DSPLIB_L2DATA_ALIGNMENT   (((uint32_t) 1) << ((uint32_t) DSPLIB_L2DATA_ALIGN_SHIFT))
 Macro that specifies the alignment of data buffers in L2 memory for optimal performance. More...
 

Typedefs

typedef double DSPLIB_D64
 Double precision floating point. More...
 
typedef float DSPLIB_F32
 Single precision floating point. More...
 
typedef DSPLIB_STATUS_NAME DSPLIB_STATUS
 Return value for DSPLIB functions. More...
 
typedef void * DSPLIB_kernelHandle
 Handle type for DSPLIB operations. More...
 

Enumerations

enum  DSPLIB_STATUS_NAME {
  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
}
 The enumeration of all status codes. More...
 
enum  DSPLIB_FUNCTION_STYLE { DSPLIB_FUNCTION_NATC = 0 , DSPLIB_FUNCTION_OPTIMIZED , DSPLIB_FUNCTION_MAX = 128 }
 Enumeration for the style of function implementation. More...
 

Macro Definition Documentation

◆ DSPLIB_DEBUGPRINT

#define DSPLIB_DEBUGPRINT   0

Enable debug printf statements.

Definition at line 33 of file DSPLIB_types.h.

◆ DSPLIB_const

#define DSPLIB_const   const

Definition at line 39 of file DSPLIB_types.h.

◆ __PRAGMA

#define __PRAGMA (   x)    _Pragma(#x)

Definition at line 42 of file DSPLIB_types.h.

◆ __INLINE_FUNC

#define __INLINE_FUNC (   x)    __PRAGMA(FUNC_ALWAYS_INLINE(x))

Definition at line 46 of file DSPLIB_types.h.

◆ DSPLIB_DEBUGPRINTFN

#define DSPLIB_DEBUGPRINTFN (   N,
  fmt,
  ... 
)

Definition at line 83 of file DSPLIB_types.h.

◆ DSPLIB_PRINTF

#define DSPLIB_PRINTF (   fmt,
  ... 
)

Definition at line 84 of file DSPLIB_types.h.

◆ DSPLIB_MESG

#define DSPLIB_MESG (   fmt,
  ... 
)

Definition at line 95 of file DSPLIB_types.h.

◆ DSPLIB_SOFT_MMA_RESET

#define DSPLIB_SOFT_MMA_RESET   0

Definition at line 116 of file DSPLIB_types.h.

◆ DSPLIB_STATIC_INLINE

#define DSPLIB_STATIC_INLINE   static inline

Definition at line 120 of file DSPLIB_types.h.