MMALIB User Guide
MMALIB_DSP_firSmall_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_DSP_FIRSMALL_IXX_IXX_OXX_H_
82 #define MMALIB_DSP_FIRSMALL_IXX_IXX_OXX_H_
83 
84 #include "../../common/MMALIB_types.h"
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
122 typedef struct
123 {
125  int8_t funcStyle;
127  int32_t dataSize;
129  int32_t batchSize;
131  int32_t filterSize;
139  uint32_t shift;
141 
152 
172  const MMALIB_DSP_firSmall_ixX_ixX_oxX_InitArgs * pKerInitArgs,
173  MMALIB_bufParams1D_t * bufParamsIn,
174  MMALIB_bufParams1D_t * bufParamsFilter,
175  MMALIB_bufParams1D_t * bufParamsOut);
176 
199  MMALIB_kernelHandle handle,
200  const MMALIB_bufParams1D_t * bufParamsIn,
201  const MMALIB_bufParams1D_t * bufParamsFilter,
202  const MMALIB_bufParams1D_t * bufParamsOut,
204 
227  MMALIB_kernelHandle handle,
228  const MMALIB_bufParams1D_t * bufParamsIn,
229  const MMALIB_bufParams1D_t * bufParamsFilter,
230  const MMALIB_bufParams1D_t * bufParamsOut,
231  const MMALIB_DSP_firSmall_ixX_ixX_oxX_InitArgs *pKerInitArgs);
232 
261  MMALIB_kernelHandle handle,
262  void *restrict pIn,
263  void *restrict pFilter,
264  void *restrict pOut);
265 
284  MMALIB_kernelHandle handle,
285  const void *restrict pIn,
286  const void *restrict pFilter,
287  const void *restrict pOut);
288 
307  const MMALIB_bufParams1D_t *bufParamsIn,
308  const MMALIB_bufParams1D_t *bufParamsFilter,
309  const MMALIB_bufParams1D_t *bufParamsOut,
310  uint64_t *archCycles,
311  uint64_t *estCycles);
312 
315 #ifdef __cplusplus
316 }
317 #endif
318 
319 #endif /* MMALIB_DSP_FIRSMALL_IXX_IXX_OXX_H_ */
320 
321 /* ======================================================================== */
322 /* End of file: MMALIB_DSP_firSmall_ixX_ixX_oxX.h */
323 /* ======================================================================== */
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_STATUS MMALIB_DSP_firSmall_ixX_ixX_oxX_init(MMALIB_kernelHandle handle, const MMALIB_bufParams1D_t *bufParamsIn, const MMALIB_bufParams1D_t *bufParamsFilter, const MMALIB_bufParams1D_t *bufParamsOut, MMALIB_DSP_firSmall_ixX_ixX_oxX_InitArgs *pKerInitArgs)
This function should be called before the MMALIB_DSP_firSmall_ixX_ixX_oxX_exec function is called....
MMALIB_STATUS MMALIB_DSP_firSmall_ixX_ixX_oxX_init_checkParams(MMALIB_kernelHandle handle, const MMALIB_bufParams1D_t *bufParamsIn, const MMALIB_bufParams1D_t *bufParamsFilter, const MMALIB_bufParams1D_t *bufParamsOut, const MMALIB_DSP_firSmall_ixX_ixX_oxX_InitArgs *pKerInitArgs)
This function checks the validity of the parameters passed to MMALIB_DSP_firSmall_ixX_ixX_oxX_init fu...
void MMALIB_DSP_firSmall_ixX_ixX_oxX_perfEst(MMALIB_kernelHandle handle, const MMALIB_bufParams1D_t *bufParamsIn, const MMALIB_bufParams1D_t *bufParamsFilter, const MMALIB_bufParams1D_t *bufParamsOut, uint64_t *archCycles, uint64_t *estCycles)
This is a utility function that gives an estimate of the cycles consumed for the kernel execution.
MMALIB_STATUS MMALIB_DSP_firSmall_ixX_ixX_oxX_getSizes(const MMALIB_DSP_firSmall_ixX_ixX_oxX_InitArgs *pKerInitArgs, MMALIB_bufParams1D_t *bufParamsIn, MMALIB_bufParams1D_t *bufParamsFilter, MMALIB_bufParams1D_t *bufParamsOut)
This is a query function to calculate the sizes of input, filter and the output buffers.
MMALIB_STATUS MMALIB_DSP_firSmall_ixX_ixX_oxX_exec(MMALIB_kernelHandle handle, void *restrict pIn, void *restrict pFilter, void *restrict pOut)
This function is the main kernel compute function.
int32_t MMALIB_DSP_firSmall_ixX_ixX_oxX_getHandleSize(MMALIB_DSP_firSmall_ixX_ixX_oxX_InitArgs *pKerInitArgs)
This is a query function to calculate the size of internal handle.
MMALIB_STATUS MMALIB_DSP_firSmall_ixX_ixX_oxX_exec_checkParams(MMALIB_kernelHandle handle, const void *restrict pIn, const void *restrict pFilter, const void *restrict pOut)
This function checks the validity of the parameters passed to MMALIB_DSP_firSmall_ixX_ixX_oxX_exec fu...
Structure containing the parameters to initialize the kernel.
uint32_t shift
Bit-shift values to be used for internal computation.
int32_t batchSize
Size of batch in terms of number of channels of input data
int8_t funcStyle
Variant of the function refer to MMALIB_FUNCTION_STYLE
A structure for a 1 dimensional buffer descriptor.