tivx_bam_kernel_wrapper.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2017-2019 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 BAM_KERNEL_WRAPPER_H
#define BAM_KERNEL_WRAPPER_H

#include <TI/tivx.h>
#include <TI/tivx_target_kernel.h>
#include <VX/vx.h>
#include "tivx_bam_kernel_database.h"
#include "bam_common.h"
#include "tivx_target_kernel_instance.h"


#define TIVX_BAM_MAX_NODES  (16u)

#define TIVX_BAM_MAX_EDGES  (32u)

#define TIVX_MAX_BUF_PARAMS  (32u)

#define TIVX_IMAGE_NULL_PLANE        (255)

typedef void *tivx_bam_graph_handle;


typedef struct _tivx_bam_kernel_details
{
    BAM_KernelInfo    kernel_info;
    void *compute_kernel_params;
    uint32_t block_width;
    uint32_t block_height;
}tivx_bam_kernel_details_t;


typedef struct _tivx_bam_plugin_def
{
    const BAM_KernelInfo *kernelInfo;                 
    const BAM_KernelHelperFuncDef *kernelHelperFunc;  
    const BAM_KernelExecFuncDef *kernelExecFunc;      
    const char *name;                                 
}tivx_bam_plugin_def;

vx_status tivxBamRegisterPlugin(tivx_bam_plugin_def *plugin, BAM_KernelId *kernelId);

vx_status tivxBamGetKernelIdFromName(const char *name, BAM_KernelId *kernelId);

vx_status tivxBamMemInit(void *ibuf_mem, uint32_t ibuf_size,
                          void *wbuf_mem, uint32_t wbuf_size);

vx_status tivxBamCreateHandleSingleNode(BAM_TI_KernelID kernel_id,
                                        VXLIB_bufParams2D_t *buf_params[],
                                        tivx_bam_kernel_details_t *kernel_details,
                                        tivx_bam_graph_handle *graph_handle);

vx_status tivxBamCreateHandleMultiNode(BAM_NodeParams node_list[],
                                       uint32_t max_nodes,
                                       BAM_EdgeParams edge_list[],
                                       uint32_t max_edges,
                                       VXLIB_bufParams2D_t *buf_params[],
                                       tivx_bam_kernel_details_t kernel_details[],
                                       tivx_bam_graph_handle *g_handle);

vx_status tivxBamUpdatePointers(tivx_bam_graph_handle graph_handle,
                                uint32_t num_inputs,
                                uint32_t num_outputs,
                                void  *ptrs[]);

vx_status tivxBamControlNode(tivx_bam_graph_handle graph_handle,
                             uint32_t node_id,
                             uint32_t cmd,
                             void  *payload);


vx_status tivxBamProcessGraph(tivx_bam_graph_handle graph_handle);

void tivxBamDestroyHandle(tivx_bam_graph_handle graph_handle);

vx_status tivxBamInitKernelDetails(tivx_bam_kernel_details_t *kernel_details,
                                   uint32_t num_bam_nodes,
                                   tivx_target_kernel_instance kernel);

typedef vx_status(VX_CALLBACK *tivx_target_kernel_create_in_bam_graph_f)(tivx_target_kernel_instance kernel,
                                                               tivx_obj_desc_t *obj_desc[],
                                                               uint16_t num_params,
                                                               void *priv_arg,
                                                               BAM_NodeParams node_list[],
                                                               tivx_bam_kernel_details_t kernel_details[],
                                                               int32_t * bam_node_cnt,
                                                               void * scratch,
                                                               int32_t * size);

typedef vx_status(VX_CALLBACK *tivx_target_kernel_get_node_port_f)(tivx_target_kernel_instance kernel,
                                                               uint8_t ovx_port,
                                                               uint8_t plane,
                                                               uint8_t *bam_node,
                                                               uint8_t *bam_port);
typedef vx_status(VX_CALLBACK *tivx_target_kernel_append_internal_edges_f)(tivx_target_kernel_instance kernel,
                                                               BAM_EdgeParams edge_list[],
                                                               int32_t * bam_edge_cnt);
typedef vx_status(VX_CALLBACK *tivx_target_kernel_pre_post_process_f)(tivx_target_kernel_instance kernel,
                                                               tivx_obj_desc_t *obj_desc[],
                                                               uint16_t num_params,
                                                               tivx_bam_graph_handle *graph_handle,
                                                               void *priv_arg);
VX_API_ENTRY vx_status VX_API_CALL tivxEnableKernelForSuperNode(
                             tivx_target_kernel target_kernel,
                             tivx_target_kernel_create_in_bam_graph_f   create_in_bam_func,
                             tivx_target_kernel_get_node_port_f         get_node_port_func,
                             tivx_target_kernel_append_internal_edges_f append_internal_edges_func,
                             tivx_target_kernel_pre_post_process_f      preprocess_func,
                             tivx_target_kernel_pre_post_process_f      postprocess_func,
                             int32_t                                    kernel_params_size,
                             void *priv_arg);


#endif