j7_tvm.h

/*
 *
 * Copyright (c) 2021 Texas Instruments Incorporated
 *
 * All rights reserved not granted herein.
 *
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
 * license under copyrights and patents it now or hereafter owns or controls to make,
 * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
 * terms herein.  With respect to the foregoing patent license, such license is granted
 * solely to the extent that any such patent is necessary to Utilize the software alone.
 * The patent license shall not apply to any combinations which include this software,
 * other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license
 * (including the above copyright notice and the disclaimer and (if applicable) source
 * code license limitations below) in the documentation and/or other materials provided
 * with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided
 * that the following conditions are met:
 *
 * *       No reverse engineering, decompilation, or disassembly of this software is
 * permitted with respect to any software provided in binary form.
 *
 * *       any redistribution and use are licensed by TI for use only with TI Devices.
 *
 * *       Nothing shall obligate TI to provide you with source code for the software
 * licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the
 * source code are permitted provided that the following conditions are met:
 *
 * *       any redistribution and use of the source code, including any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * *       any redistribution and use of any object code compiled from the source code
 * and any resulting derivative works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
 *
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef J7_TVM_H_
#define J7_TVM_H_

#include <VX/vx.h>
#include <VX/vx_kernels.h>
#include <TI/tivx_tensor.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_TVM_J7_CHECKSUM_SIZE (64)

/* These correspond to parameter indices of the TVM node
 * They can be useful to aid in setting replicate parameters if
 * vxReplicateNode is used.
 * 0: config: meta data for the kernel call (checksum, num inputs/output, etc)
 * 1: deploy_mod:  tvm c7x deployable module built as shared lib
 * 2: optional trace output
 * 3 - ?: in_tensors, out_tensors
*/
#define TIVX_KERNEL_TVM_IN_CONFIG_IDX                   (0U)
#define TIVX_KERNEL_TVM_IN_DEPLOY_MOD_IDX               (1U)
#define TIVX_KERNEL_TVM_IN_TRACE_DATA_IDX               (2U)
#define TIVX_KERNEL_TVM_IN_FIRST_TENSOR                 (3U)
#define TIVX_KERNEL_TVM_NUM_BASE_PARAMETERS             (3U)
#define TIVX_KERNEL_TVM_NUM_MIN_PARAMETERS             (TIVX_KERNEL_TVM_NUM_BASE_PARAMETERS + 2)

#define TIVX_KERNEL_TVM_MAX_INPUT_TENSORS 16
#define TIVX_KERNEL_TVM_MAX_TOTAL_INPUT_TENSOR_NAMES_SIZE 512
#define TIVX_KERNEL_TVM_MAX_TOTAL_TENSORS 32
#define TIVX_KERNEL_TVM_MAX_TENSOR_DIM    8

typedef struct{
  uint32_t size_in_bytes;
} tivxTVMTensorParams;

typedef struct{
  vx_int32 tvm_rt_debug_level;
  vx_int32 tidl_trace_log_level;
  vx_int32 tidl_trace_write_level;
  vx_float32 max_preempt_delay;
  vx_uint64 tvm_rt_trace_ptr;
  vx_int32  tvm_rt_trace_size;
  vx_int32  tvm_rt_trace_node;
  vx_int32  tvm_rt_target_priority;
  vx_int32  tvm_rt_core_num;
} tvm_tidl_rt_info;

typedef struct{
  vx_uint8 config_checksum[TIVX_TVM_J7_CHECKSUM_SIZE];

  vx_uint8 deploy_mod_checksum[TIVX_TVM_J7_CHECKSUM_SIZE];

  vx_uint32 compute_config_checksum;

  vx_uint32 compute_network_checksum;

  vx_uint32 num_input_tensors;
  vx_uint32 num_output_tensors;

  vx_uint32 input_names_offset[TIVX_KERNEL_TVM_MAX_INPUT_TENSORS];
  vx_uint8  input_names[TIVX_KERNEL_TVM_MAX_TOTAL_INPUT_TENSOR_NAMES_SIZE];

  tivxTVMTensorParams tensors_params[TIVX_KERNEL_TVM_MAX_TOTAL_TENSORS];

  vx_uint32 optimize_ivision_activation;

  tvm_tidl_rt_info rt_info;

} tivxTVMJ7Params;

VX_API_ENTRY vx_node VX_API_CALL tivxTVMNode(vx_graph  graph,
                                             vx_kernel kernel,
                                             vx_reference appParams[],
                                             vx_tensor input_tensors[],
                                             vx_tensor output_tensors[]);

vx_kernel tivxAddKernelTVM(vx_context context,
                           uint32_t num_input_tensors,
                           uint32_t num_output_tensors);

#ifdef __cplusplus
}
#endif

#endif /* J7_TVM_H_ */