MMALIB User Guide
MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX.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 MMALIB_LINALG_MATRIXMATRIXMULTIPLY_IXX_IXX_OXX_H_
82 #define MMALIB_LINALG_MATRIXMATRIXMULTIPLY_IXX_IXX_OXX_H_
83 
84 #include "../../common/MMALIB_types.h"
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
110  typedef enum
111  {
115 
116  typedef enum
117  {
121 
122 
131  typedef struct
132  {
133  int8_t funcStyle;
134  int8_t shift;
135  int8_t bTranspose;
137 
138 
151 
152 
175  const MMALIB_bufParams2D_t * src0_addr,
176  const MMALIB_bufParams2D_t * src1_addr,
177  const MMALIB_bufParams2D_t * dst_addr,
179 
180 
202  const MMALIB_bufParams2D_t * src0_addr,
203  const MMALIB_bufParams2D_t * src1_addr,
204  const MMALIB_bufParams2D_t * dst_addr,
206 
207 
241  const void *src0,
242  const void *src1,
243  void *dst);
244 
265  const void *src0,
266  const void *src1,
267  const void * dst);
268 
269 
295  const MMALIB_bufParams2D_t *src0_addr,
296  const MMALIB_bufParams2D_t *src1_addr,
297  const MMALIB_bufParams2D_t *dst_addr,
298  uint64_t *archCycles,
299  uint64_t *estCycles,
300  int32_t *caseNumber);
301 
304 #ifdef __cplusplus
305 }
306 #endif
307 
308 #endif /* MMALIB_LINALG_MATRIXMATRIXMULTIPLY_IXX_IXX_OXX_H_ */
309 
310 /* ======================================================================== */
311 /* End of file: MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX.h */
312 /* ======================================================================== */
MMALIB_STATUS_NAME
The enumeration of all status codes.
Definition: MMALIB_types.h:152
void * MMALIB_kernelHandle
Handle type for MMALIB operations.
Definition: MMALIB_types.h:262
@ MMALIB_ERROR_MAX
Definition: MMALIB_types.h:167
MMALIB_LINALG_MATRIXMATRIXMULTIPLY_IXX_IXX_OXX_STATUS_NAME
Enumeration of different error codes for the MMALIB_LINALG_MATRIXMATRIXMULTIPLY kernel.
MMALIB_STATUS MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_exec_checkParams(MMALIB_kernelHandle handle, const void *src0, const void *src1, const void *dst)
This function checks the parameters and should be called before kernel executuon. It can be called on...
MMALIB_STATUS MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_init(MMALIB_kernelHandle handle, const MMALIB_bufParams2D_t *src0_addr, const MMALIB_bufParams2D_t *src1_addr, const MMALIB_bufParams2D_t *dst_addr, const MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_InitArgs *pKerInitArgs)
This function call is required to initialize the handle. In this function most of the one time operat...
MMALIB_STATUS MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_exec(MMALIB_kernelHandle handle, const void *src0, const void *src1, void *dst)
This function is the main compute function, and performs matrix-matrix multiplication.
void MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_perfEst(MMALIB_kernelHandle handle, const MMALIB_bufParams2D_t *src0_addr, const MMALIB_bufParams2D_t *src1_addr, const MMALIB_bufParams2D_t *dst_addr, uint64_t *archCycles, uint64_t *estCycles, int32_t *caseNumber)
This function estimates the cycles consumed for the kernel execution.
MMALIB_STATUS MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_init_checkParams(MMALIB_kernelHandle handle, const MMALIB_bufParams2D_t *src0_addr, const MMALIB_bufParams2D_t *src1_addr, const MMALIB_bufParams2D_t *dst_addr, const MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_InitArgs *pKerInitArgs)
This function checks the parameters and should be called before kernel executuon. It can be called on...
int32_t MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_getHandleSize(MMALIB_LINALG_matrixMatrixMultiply_ixX_ixX_oxX_InitArgs *pKerInitArgs)
This is a query function to return the size of internal handle.
@ MMALIB_LINALG_MATRIXMATRIXMULTIPLY_IXX_IXX_OXX_B_NON_TRANSPOSED
This structure holds all the initialization parameters for matrix- matrix multiplication.
int8_t funcStyle
Variant of the function; refer to MMALIB_FUNCTION_STYLE.
int8_t bTranspose
Flag to indicate B transposed or not; refer to MMALIB_LINALG_MATRIXMATRIXMULTIPLY_IXX_IXX_OXX_B_TRANS...
A structure for a 2 dimensional buffer descriptor.