DSPLIB User Guide
DSPLIB_mat_submat_copy.h
Go to the documentation of this file.
1 /*******************************************************************************
2 **+--------------------------------------------------------------------------+**
3 **| **** |**
4 **| **** |**
5 **| ******o*** |**
6 **| ********_///_**** |**
7 **| ***** /_//_/ **** |**
8 **| ** ** (__/ **** |**
9 **| ********* |**
10 **| **** |**
11 **| *** |**
12 **| |**
13 **| Copyright (c) 2016 Texas Instruments Incorporated |**
14 **| |**
15 **| All rights reserved not granted herein. |**
16 **| |**
17 **| Limited License. |**
18 **| |**
19 **| Texas Instruments Incorporated grants a world-wide, royalty-free, |**
20 **| non-exclusive license under copyrights and patents it now or |**
21 **| hereafter owns or controls to make, have made, use, import, offer to |**
22 **| sell and sell ("Utilize") this software subject to the terms herein. |**
23 **| With respect to the foregoing patent license, such license is granted |**
24 **| solely to the extent that any such patent is necessary to Utilize the |**
25 **| software alone. The patent license shall not apply to any |**
26 **| combinations which include this software, other than combinations |**
27 **| with devices manufactured by or for TI ("TI Devices"). No hardware |**
28 **| patent is licensed hereunder. |**
29 **| |**
30 **| Redistributions must preserve existing copyright notices and |**
31 **| reproduce this license (including the above copyright notice and the |**
32 **| disclaimer and (if applicable) source code license limitations below) |**
33 **| in the documentation and/or other materials provided with the |**
34 **| distribution |**
35 **| |**
36 **| Redistribution and use in binary form, without modification, are |**
37 **| permitted provided that the following conditions are met: |**
38 **| |**
39 **| * No reverse engineering, decompilation, or disassembly of this |**
40 **| software is permitted with respect to any software provided in binary |**
41 **| form. |**
42 **| |**
43 **| * any redistribution and use are licensed by TI for use only with |**
44 **| TI Devices. |**
45 **| |**
46 **| * Nothing shall obligate TI to provide you with source code for |**
47 **| the software licensed and provided to you in object code. |**
48 **| |**
49 **| If software source code is provided to you, modification and |**
50 **| redistribution of the source code are permitted provided that the |**
51 **| following conditions are met: |**
52 **| |**
53 **| * any redistribution and use of the source code, including any |**
54 **| resulting derivative works, are licensed by TI for use only with TI |**
55 **| Devices. |**
56 **| |**
57 **| * any redistribution and use of any object code compiled from the |**
58 **| source code and any resulting derivative works, are licensed by TI |**
59 **| for use only with TI Devices. |**
60 **| |**
61 **| Neither the name of Texas Instruments Incorporated nor the names of |**
62 **| its suppliers may be used to endorse or promote products derived from |**
63 **| this software without specific prior written permission. |**
64 **| |**
65 **| DISCLAIMER. |**
66 **| |**
67 **| THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY |**
68 **| EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |**
69 **| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |**
70 **| PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI'S LICENSORS BE |**
71 **| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |**
72 **| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |**
73 **| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |**
74 **| BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |**
75 **| WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE |**
76 **| OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |**
77 **| EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |**
78 **+--------------------------------------------------------------------------+**
79 *******************************************************************************/
80 
81 #ifndef DSPLIB_MAT_SUBMAT_COP_IXX_IXX_OXX_H_
82 #define DSPLIB_MAT_SUBMAT_COP_IXX_IXX_OXX_H_
83 
84 #include "../common/DSPLIB_types.h"
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
117 typedef struct {
119  int8_t funcStyle;
121  uint32_t dimX;
123  uint32_t dimY;
125  uint32_t dir;
127  uint32_t stRow;
129  uint32_t stCol;
131  uint32_t nRows;
133  uint32_t nCols;
134 } DSPLIB_mat_submat_copyInitArgs;
135 
144 int32_t DSPLIB_mat_submat_copy_getHandleSize(DSPLIB_mat_submat_copyInitArgs *pKerInitArgs);
145 
165 DSPLIB_STATUS DSPLIB_mat_submat_copy_init(DSPLIB_kernelHandle handle,
166  DSPLIB_bufParams2D_t *bufParamsX,
167  DSPLIB_bufParams2D_t *bufParamsY,
168  const DSPLIB_mat_submat_copyInitArgs *pKerInitArgs);
169 
189 DSPLIB_STATUS DSPLIB_mat_submat_copy_init_checkParams(DSPLIB_kernelHandle handle,
190  const DSPLIB_bufParams2D_t *bufParamsX,
191  const DSPLIB_bufParams2D_t *bufParamsY,
192  const DSPLIB_mat_submat_copyInitArgs *pKerInitArgs);
193 
210 DSPLIB_STATUS
211 DSPLIB_mat_submat_copy_exec_checkParams(DSPLIB_kernelHandle handle, const void *restrict pX, const void *restrict pY);
212 
248 DSPLIB_STATUS DSPLIB_mat_submat_copy_exec(DSPLIB_kernelHandle handle, void *restrict pX, void *restrict pY);
249 
252 #ifdef __cplusplus
253 }
254 #endif
255 
256 #endif /* DSPLIB_MAT_SUBMAT_COP_IXX_IXX_OXX_H_ */
257 
258 /* ======================================================================== */
259 /* End of file: DSPLIB_mat_submat_copy.h */
260 /* ======================================================================== */
DSPLIB_STATUS_NAME
DSPLIB_STATUS_NAME
The enumeration of all status codes.
Definition: DSPLIB_types.h:151
DSPLIB_kernelHandle
void * DSPLIB_kernelHandle
Handle type for DSPLIB operations.
Definition: DSPLIB_types.h:172
DSPLIB_mat_submat_copy_init
DSPLIB_STATUS DSPLIB_mat_submat_copy_init(DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsX, DSPLIB_bufParams2D_t *bufParamsY, const DSPLIB_mat_submat_copyInitArgs *pKerInitArgs)
This function should be called before the DSPLIB_mat_submat_copy_exec function is called....
Definition: DSPLIB_mat_submat_copy.cpp:88
DSPLIB_mat_submat_copy_exec
DSPLIB_STATUS DSPLIB_mat_submat_copy_exec(DSPLIB_kernelHandle handle, void *restrict pX, void *restrict pY)
This function is the main kernel compute function.
Definition: DSPLIB_mat_submat_copy.cpp:211
DSPLIB_mat_submat_copy_exec_checkParams
DSPLIB_STATUS DSPLIB_mat_submat_copy_exec_checkParams(DSPLIB_kernelHandle handle, const void *restrict pX, const void *restrict pY)
This function checks the validity of the parameters passed to DSPLIB_mat_submat_copy_exec function....
Definition: DSPLIB_mat_submat_copy.cpp:71
DSPLIB_mat_submat_copy_getHandleSize
int32_t DSPLIB_mat_submat_copy_getHandleSize(DSPLIB_mat_submat_copyInitArgs *pKerInitArgs)
This is a query function to calculate the size of internal handle.
Definition: DSPLIB_mat_submat_copy.cpp:25
DSPLIB_mat_submat_copy_init_checkParams
DSPLIB_STATUS DSPLIB_mat_submat_copy_init_checkParams(DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsX, const DSPLIB_bufParams2D_t *bufParamsY, const DSPLIB_mat_submat_copyInitArgs *pKerInitArgs)
This function checks the validity of the parameters passed to DSPLIB_mat_submat_copy_init function....
Definition: DSPLIB_mat_submat_copy.cpp:34
DSPLIB_bufParams2D_t
A structure for a 2 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:78
DSPLIB_mat_submat_copyInitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_mat_submat_copy.h:117
DSPLIB_mat_submat_copyInitArgs::nCols
uint32_t nCols
The number of coulmns to be copied
Definition: DSPLIB_mat_submat_copy.h:133
DSPLIB_mat_submat_copyInitArgs::dimY
uint32_t dimY
The number of rows in X matrix.
Definition: DSPLIB_mat_submat_copy.h:123
DSPLIB_mat_submat_copyInitArgs::stCol
uint32_t stCol
Copying starting from stCol column of matrix
Definition: DSPLIB_mat_submat_copy.h:129
DSPLIB_mat_submat_copyInitArgs::stRow
uint32_t stRow
Copying starting from stRow row of matrix
Definition: DSPLIB_mat_submat_copy.h:127
DSPLIB_mat_submat_copyInitArgs::funcStyle
int8_t funcStyle
Variant of the function refer to DSPLIB_FUNCTION_STYLE
Definition: DSPLIB_mat_submat_copy.h:119
DSPLIB_mat_submat_copyInitArgs::dir
uint32_t dir
Direction of the data flow
Definition: DSPLIB_mat_submat_copy.h:125
DSPLIB_mat_submat_copyInitArgs::nRows
uint32_t nRows
The number of rows to be copied
Definition: DSPLIB_mat_submat_copy.h:131
DSPLIB_mat_submat_copyInitArgs::dimX
uint32_t dimX
The number of columns in X matrix.
Definition: DSPLIB_mat_submat_copy.h:121