TIOVX User Guide
j7_tidl.h
1 /*
2  *
3  * Copyright (c) 2019 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 
63 #ifndef J7_TIDL_H_
64 #define J7_TIDL_H_
65 
66 #include <VX/vx.h>
67 #include <VX/vx_kernels.h>
68 #include <TI/tivx_tensor.h>
69 #include "itidl_ti.h"
70 
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 
75 #define TIVX_TIDL_J7_CHECKSUM_SIZE (64)
76 
77 /* These correspond to parameter indices of the TIDL node
78  * They can be useful to aid in setting replicate parameters if
79  * vxReplicateNode is used. */
80 #define TIVX_KERNEL_TIDL_IN_CONFIG_IDX (0U)
81 #define TIVX_KERNEL_TIDL_IN_NETWORK_IDX (1U)
82 #define TIVX_KERNEL_TIDL_IN_CREATE_PARAMS_IDX (2U)
83 #define TIVX_KERNEL_TIDL_IN_IN_ARGS_IDX (3U)
84 #define TIVX_KERNEL_TIDL_IN_OUT_ARGS_IDX (4U)
85 #define TIVX_KERNEL_TIDL_IN_TRACE_DATA_IDX (5U)
86 #define TIVX_KERNEL_TIDL_IN_FIRST_TENSOR (6U)
87 #define TIVX_KERNEL_TIDL_NUM_BASE_PARAMETERS (6U)
88 #define TIVX_KERNEL_TIDL_NUM_MIN_PARAMETERS (TIVX_KERNEL_TIDL_NUM_BASE_PARAMETERS + 2)
89 
90 #define MAX_TENSOR_DIMS (4u)
91 #define TIDL_MAX_PARAMS (16u) //PC-- need it?
92 
97 typedef struct{
99  vx_uint8 config_checksum[TIVX_TIDL_J7_CHECKSUM_SIZE];
100 
102  vx_uint8 network_checksum[TIVX_TIDL_J7_CHECKSUM_SIZE];
103 
106 
109 
111  sTIDL_IOBufDesc_t ioBufDesc;
112 
115 
117 
122 static inline void tivx_tidl_j7_params_init(tivxTIDLJ7Params *tidlParams)
123 {
124  memset(&tidlParams->config_checksum[0], 0, TIVX_TIDL_J7_CHECKSUM_SIZE);
125  memset(&tidlParams->network_checksum[0], 0, TIVX_TIDL_J7_CHECKSUM_SIZE);
126 
127  tidlParams->compute_config_checksum = 0;
128  tidlParams->compute_network_checksum = 0;
129  tidlParams->optimize_ivision_activation = 0;
130 
131  memset(&tidlParams->ioBufDesc, 0, sizeof(sTIDL_IOBufDesc_t));
132 }
133 
162 VX_API_ENTRY vx_node VX_API_CALL tivxTIDLNode(vx_graph graph,
163  vx_kernel kernel,
164  vx_reference appParams[],
165  vx_tensor input_tensors[],
166  vx_tensor output_tensors[]);
167 
183  uint32_t num_input_tensors,
184  uint32_t num_output_tensors);
185 
186 
187 #ifdef __cplusplus
188 }
189 #endif
190 
191 #endif /* J7_TIDL_H_ */
vx_kernel tivxAddKernelTIDL(vx_context context, uint32_t num_input_tensors, uint32_t num_output_tensors)
Used for the Application to create the tidl kernel from the context.
VX_API_ENTRY vx_node VX_API_CALL tivxTIDLNode(vx_graph graph, vx_kernel kernel, vx_reference appParams[], vx_tensor input_tensors[], vx_tensor output_tensors[])
[Graph] Creates a TIDL Node.
uint8_t vx_uint8
static void tivx_tidl_j7_params_init(tivxTIDLJ7Params *tidlParams)
TIDL params initialization.
Definition: j7_tidl.h:122
Interface to Tensor APIs (modeled after OpenVX 1.2 tensor support)
vx_uint32 optimize_ivision_activation
Definition: j7_tidl.h:114
vx_uint32 compute_config_checksum
Definition: j7_tidl.h:105
struct _vx_context * vx_context
struct _vx_reference * vx_reference
sTIDL_IOBufDesc_t ioBufDesc
Definition: j7_tidl.h:111
struct _vx_kernel * vx_kernel
TIDL params structure.
Definition: j7_tidl.h:97
uint32_t vx_uint32
vx_uint8 network_checksum[TIVX_TIDL_J7_CHECKSUM_SIZE]
Definition: j7_tidl.h:102
struct _vx_graph * vx_graph
vx_uint8 config_checksum[TIVX_TIDL_J7_CHECKSUM_SIZE]
Definition: j7_tidl.h:99
struct _vx_node * vx_node
struct _vx_tensor * vx_tensor
The multidimensional data object (Tensor).
Definition: tivx_tensor.h:83
vx_status(* VX_API_CALL)(vx_reference *ref)
Callback type used to register release callbacks from object dervied from references.
Definition: vx_reference.h:56
vx_uint32 compute_network_checksum
Definition: j7_tidl.h:108