DSPLIB User Guide
DSPLIB_dotprod.cpp
Go to the documentation of this file.
1 /******************************************************************************
2  * *
3  * module name :DSPLIB *
4  * *
5  * module descripton :Matrix Multiply Accelerator Library module for C7x+MMA *
6  * *
7  * Copyright (C) 2017-2018 Texas Instruments Incorporated - https://www.ti.com/ *
8  * ALL RIGHTS RESERVED *
9  * *
10  ******************************************************************************/
11 
23 #include "DSPLIB_dotprod_priv.h"
24 
26 {
27  int32_t privBufSize = sizeof(DSPLIB_dotprod_PrivArgs);
28  return privBufSize;
29 }
30 
33  const DSPLIB_bufParams1D_t *bufParamsIn,
34  const DSPLIB_bufParams1D_t *bufParamsOut,
35  const DSPLIB_dotprod_InitArgs *pKerInitArgs)
36 {
38 
39 #if DSPLIB_DEBUGPRINT
40  printf("Enter DSPLIB_dotprod_init_checkParams\n");
41 #endif
42  if (handle == NULL) {
43  status = DSPLIB_ERR_NULL_POINTER;
44  }
45 
46  if (status == DSPLIB_SUCCESS) {
47  if ((bufParamsIn->data_type != DSPLIB_INT16) && (bufParamsIn->data_type != DSPLIB_INT32) &&
48  (bufParamsIn->data_type != DSPLIB_INT8) && (bufParamsIn->data_type != DSPLIB_FLOAT32)) {
49  status = DSPLIB_ERR_INVALID_TYPE;
50  }
51  else if (bufParamsIn->data_type != bufParamsOut->data_type) {
52  status = DSPLIB_ERR_INVALID_TYPE;
53  }
54  else {
55  status = DSPLIB_SUCCESS;
56  /* Nothing to do here */
57  }
58  }
59 
60  return status;
61 }
62 
64  const void *restrict pIn1,
65  const void *restrict pIn2,
66  const void *restrict pOut)
67 {
68  DSPLIB_STATUS status;
69 
70 #if DSPLIB_DEBUGPRINT
71  printf("Enter DSPLIB_dotprod_exec_checkParams\n");
72 #endif
73  if ((pIn1 == NULL) || (pIn2 == NULL) || (pOut == NULL)) {
74  status = DSPLIB_ERR_NULL_POINTER;
75  }
76  else {
77  status = DSPLIB_SUCCESS;
78  }
79 
80  return status;
81 }
82 
84  DSPLIB_bufParams1D_t *bufParamsIn,
85  DSPLIB_bufParams1D_t *bufParamsOut,
86  const DSPLIB_dotprod_InitArgs *pKerInitArgs)
87 {
89  DSPLIB_dotprod_PrivArgs *pKerPrivArgs = (DSPLIB_dotprod_PrivArgs *) handle;
90 
91 #if DSPLIB_DEBUGPRINT
92  printf("DSPLIB_DEBUGPRINT Enter DSPLIB_dotprod_init\n");
93 #endif
94  pKerPrivArgs->blockSize = pKerInitArgs->dataSize;
95 
96 #if DSPLIB_DEBUGPRINT
97  printf("DSPLIB_DEBUGPRINT DSPLIB_dotprod_init pKerPrivArgs->blockSize %d "
98  "bufParamsIn->data_type %d\n",
99  pKerPrivArgs->blockSize, bufParamsIn->data_type);
100 #endif
101 
102  if (pKerInitArgs->funcStyle == DSPLIB_FUNCTION_NATC) {
103  if (bufParamsIn->data_type == DSPLIB_FLOAT32) {
104  pKerPrivArgs->execute = DSPLIB_dotprod_exec_cn<float>;
105  }
106  else if (bufParamsIn->data_type == DSPLIB_FLOAT64) {
107  pKerPrivArgs->execute = DSPLIB_dotprod_exec_cn<double>;
108  }
109  else if (bufParamsIn->data_type == DSPLIB_INT8) {
110  pKerPrivArgs->execute = DSPLIB_dotprod_exec_cn<int8_t>;
111  }
112  else if (bufParamsIn->data_type == DSPLIB_UINT8) {
114  }
115  else if (bufParamsIn->data_type == DSPLIB_INT16) {
117  }
118  else if (bufParamsIn->data_type == DSPLIB_UINT16) {
120  }
121  else if (bufParamsIn->data_type == DSPLIB_INT32) {
123  }
124  else if (bufParamsIn->data_type == DSPLIB_UINT32) {
126  }
127  else {
128  status = DSPLIB_ERR_INVALID_TYPE;
129 #if DSPLIB_DEBUGPRINT
130  printf("DSPLIB_DEBUGPRINT CP 2 status %d\n", status);
131 #endif
132  }
133  }
134  else {
135  if (bufParamsIn->data_type == DSPLIB_FLOAT32) {
136 #if DSPLIB_DEBUGPRINT
137  printf("DSPLIB_DEBUGPRINT bufParamsIn->data_type == DSPLIB_FLOAT32\n");
138 #endif
139  pKerPrivArgs->execute = DSPLIB_dotprod_exec_ci<float>;
140  status = DSPLIB_dotprod_init_ci<float>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
141  }
142  else if (bufParamsIn->data_type == DSPLIB_FLOAT64) {
143  pKerPrivArgs->execute = DSPLIB_dotprod_exec_ci<double>;
144  status = DSPLIB_dotprod_init_ci<double>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
145  }
146  else if (bufParamsIn->data_type == DSPLIB_INT8) {
147  pKerPrivArgs->execute = DSPLIB_dotprod_exec_ci<int8_t>;
148  status = DSPLIB_dotprod_init_ci<int8_t>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
149  }
150  else if (bufParamsIn->data_type == DSPLIB_UINT8) {
152  status = DSPLIB_dotprod_init_ci<uint8_t>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
153  }
154  else if (bufParamsIn->data_type == DSPLIB_INT16) {
156  status = DSPLIB_dotprod_init_ci<int16_t>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
157  }
158  else if (bufParamsIn->data_type == DSPLIB_UINT16) {
160  status = DSPLIB_dotprod_init_ci<uint16_t>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
161  }
162  else if (bufParamsIn->data_type == DSPLIB_INT32) {
164  status = DSPLIB_dotprod_init_ci<int32_t>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
165  }
166  else if (bufParamsIn->data_type == DSPLIB_UINT32) {
168  status = DSPLIB_dotprod_init_ci<uint32_t>(handle, bufParamsIn, bufParamsOut, pKerInitArgs);
169  }
170  else {
171  status = DSPLIB_ERR_INVALID_TYPE;
172  }
173  }
174 #if DSPLIB_DEBUGPRINT
175  printf("DSPLIB_DEBUGPRINT CP 3 status %d\n", status);
176 #endif
177  return status;
178 }
179 
181 DSPLIB_dotprod_exec(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
182 {
183  DSPLIB_STATUS status;
184 
185 #if DSPLIB_DEBUGPRINT
186  printf("DSPLIB_DEBUGPRINT Enter DSPLIB_dotprod_exec\n");
187 #endif
188 
189  DSPLIB_dotprod_PrivArgs *pKerPrivArgs = (DSPLIB_dotprod_PrivArgs *) handle;
190 
191 #if DSPLIB_DEBUGPRINT
192  printf("DSPLIB_DEBUGPRINT pKerPrivArgs->blockSize %d\n", pKerPrivArgs->blockSize);
193 #endif
194 
195  status = pKerPrivArgs->execute(handle, pIn1, pIn2, pOut);
196 
197  return status;
198 }
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< int16_t >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< double >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
template DSPLIB_STATUS DSPLIB_dotprod_exec_ci< float >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< uint32_t >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
DSPLIB_STATUS DSPLIB_dotprod_exec_ci< int16_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_ci< uint8_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_ci< uint32_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_init_ci< int8_t >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
DSPLIB_STATUS DSPLIB_dotprod_exec_ci< int32_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_ci< uint16_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
template DSPLIB_STATUS DSPLIB_dotprod_exec_ci< double >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_ci< int8_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< uint8_t >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< float >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< uint16_t >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
template DSPLIB_STATUS DSPLIB_dotprod_init_ci< int32_t >(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
DSPLIB_STATUS DSPLIB_dotprod_exec_cn< int8_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_cn< uint32_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_cn< int32_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
template DSPLIB_STATUS DSPLIB_dotprod_exec_cn< double >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_cn< uint16_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
template DSPLIB_STATUS DSPLIB_dotprod_exec_cn< float >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_cn< uint8_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
DSPLIB_STATUS DSPLIB_dotprod_exec_cn< int16_t >(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
Header file for kernel's internal use. For the kernel's interface, please see DSPLIB_dotprod.
DSPLIB_STATUS_NAME
The enumeration of all status codes.
Definition: DSPLIB_types.h:151
void * DSPLIB_kernelHandle
Handle type for DSPLIB operations.
Definition: DSPLIB_types.h:172
@ DSPLIB_FUNCTION_NATC
Definition: DSPLIB_types.h:176
@ DSPLIB_UINT8
@ DSPLIB_UINT16
@ DSPLIB_INT32
@ DSPLIB_INT16
@ DSPLIB_FLOAT32
@ DSPLIB_FLOAT64
@ DSPLIB_UINT32
@ DSPLIB_INT8
@ DSPLIB_SUCCESS
Definition: DSPLIB_types.h:152
@ DSPLIB_ERR_NULL_POINTER
Definition: DSPLIB_types.h:157
@ DSPLIB_ERR_INVALID_TYPE
Definition: DSPLIB_types.h:155
DSPLIB_STATUS DSPLIB_dotprod_exec(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
This function is the main kernel compute function.
int32_t DSPLIB_dotprod_getHandleSize(DSPLIB_dotprod_InitArgs *pKerInitArgs)
This is a query function to calculate the size of internal handle.
DSPLIB_STATUS DSPLIB_dotprod_exec_checkParams(DSPLIB_kernelHandle handle, const void *restrict pIn1, const void *restrict pIn2, const void *restrict pOut)
This function checks the validity of the parameters passed to DSPLIB_dotprod_exec function....
DSPLIB_STATUS DSPLIB_dotprod_init(DSPLIB_kernelHandle handle, DSPLIB_bufParams1D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
This function should be called before the DSPLIB_dotprod_exec function is called. This function takes...
DSPLIB_STATUS DSPLIB_dotprod_init_checkParams(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
This function checks the validity of the parameters passed to DSPLIB_dotprod_init function....
A structure for a 1 dimensional buffer descriptor.
uint32_t data_type
Values are of type DSPLIB_data_type_e.
Structure containing the parameters to initialize the kernel.
uint32_t dataSize
Size of input data
int8_t funcStyle
Variant of the function refer to DSPLIB_FUNCTION_STYLE
Structure that is reserved for internal use by the kernel.
pFxnDSPLIB_dotprod_exec execute
Function pointer to point to the right execution variant between DSPLIB_dotprod_exec_cn and DSPLIB_do...
int32_t blockSize
Size of input buffer for different batches DSPLIB_dotprod_init that will be retrieved and used by DSP...