tivx_kernels_target_utils.h

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

#include <ti/vxlib/src/common/VXLIB_bufParams.h>
#include <tivx_kernels_common_utils.h>
#include <TI/tivx_obj_desc.h>
#include <TI/tivx_debug.h>
#include <TI/tivx_target_kernel.h>

#ifdef __cplusplus
extern "C" {
#endif

#define VX_PRINT_KERNEL(zone, kernel, message, ...) do { tivx_print_object(((vx_enum)zone), tivxGetTargetKernelInstanceDebugZonemask(kernel), "[%s:%u] " message, __FUNCTION__, __LINE__, ## __VA_ARGS__); } while (1 == 0)

#define MAX2(a, b) (((a) > (b)) ? (a) : (b))
#define MAX3(a, b, c) (MAX2((MAX2((a), (b))), (c)))
#define MAX4(a, b, c, d) (MAX2((MAX3((a), (b), (c))), (d)))
#define MAX5(a, b, c, d, e) (MAX2((MAX4((a), (b), (c), (d))), (e)))
#define MAX6(a, b, c, d, e, f) (MAX2((MAX5((a), (b), (c), (d), (e))), (f)))
#define MAX7(a, b, c, d, e, f, g) (MAX2((MAX6((a), (b), (c), (d), (e), (f))), (g)))
#define MAX8(a, b, c, d, e, f, g, h) (MAX2((MAX7((a), (b), (c), (d), (e), (f), (g))), (h)))
#define MAX9(a, b, c, d, e, f, g, h, i) (MAX2((MAX8((a), (b), (c), (d), (e), (f), (g), (h))), (i)))
#define MAX10(a, b, c, d, e, f, g, h, i, j) (MAX2((MAX9((a), (b), (c), (d), (e), (f), (g), (h), (i))), (j)))

typedef void (*tivxTargetKernel_Fxn) (void);

typedef struct  {
    tivxTargetKernel_Fxn    add_kernel;
    tivxTargetKernel_Fxn    remove_kernel;
} Tivx_Target_Kernel_List;

void tivxRegisterTargetKernels(const Tivx_Target_Kernel_List *kernel_list, uint32_t num_kernels);

void tivxUnRegisterTargetKernels(const Tivx_Target_Kernel_List *kernel_list, uint32_t num_kernels);

static inline vx_uint32 tivxComputePatchOffset(
    vx_uint32 x, vx_uint32 y, const vx_imagepatch_addressing_t *addr);

static inline vx_status tivxCheckNullParams(
    tivx_obj_desc_t *obj_desc[], uint16_t num_params,
    uint16_t max_params);

void tivxInitBufParams(
    const tivx_obj_desc_image_t *obj_desc,
    VXLIB_bufParams2D_t buf_params[]);

void tivxSetPointerLocation(
    const tivx_obj_desc_image_t *obj_desc,
    void *target_ptr[],
    uint8_t *addr[]);

#if defined(BUILD_BAM)

void tivxReserveC66xL2MEM(void);
#endif

#if defined(TARGET_DSP) || defined(PC)

void tivxSetTwoPointerLocation(
    const tivx_obj_desc_image_t *obj_desc0,
    const tivx_obj_desc_image_t *obj_desc1,
    void *target_ptr0[],
    void *target_ptr1[],
    uint8_t *addr0[],
    uint8_t *addr1[]);
#endif /* #if defined(TARGET_DSP) || defined(PC) */

vx_status tivxKernelsTargetUtilsAssignTargetNameDsp(char *target_name);

vx_status tivxKernelsTargetUtilsAssignTargetNameC7x(char *target_name);

vx_status tivxKernelsTargetUtilsAssignTargetNameMcu(char *target_name);

vx_status tivxKernelsTargetUtilsAssignTargetNameMpu(char *target_name);

static inline vx_uint32 tivxComputePatchOffset(
    vx_uint32 x, vx_uint32 y, const vx_imagepatch_addressing_t *addr)
{
    return ((vx_uint32)addr->stride_y * (y / addr->step_y)) +
           ((vx_uint32)addr->stride_x * (x / addr->step_x));
}

static inline vx_status tivxCheckNullParams(
    tivx_obj_desc_t *obj_desc[], uint16_t num_params,
    uint16_t max_params)
{
    vx_status status = (vx_status)VX_SUCCESS;
    uint32_t i;

    if (num_params != max_params)
    {
        status = (vx_status)VX_FAILURE;
    }
    else
    {
        for (i = 0U; i < max_params; i ++)
        {
            if (NULL == obj_desc[i])
            {
                status = (vx_status)VX_FAILURE;
                break;
            }
        }
    }
    return status;
}

#ifdef __cplusplus
}
#endif

#endif