hwa_vpac_ldc.h

Go to the documentation of this file.

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

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

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_KERNEL_VPAC_LDC_NAME     "com.ti.hwa.vpac_ldc"

#define TIVX_KERNEL_VPAC_LDC2_NAME     "com.ti.hwa.vpac_ldc2"


/*********************************
 *      VPAC_LDC Control Commands
 *********************************/

#define TIVX_VPAC_LDC_CMD_SET_READ_BW_LIMIT_PARAMS         (0x10000000u)

#define TIVX_VPAC_LDC_CMD_SET_BIT_DEPTH_CONV_LUT_PARAMS     (0x10000001u)

#define TIVX_VPAC_LDC_CMD_GET_ERR_STATUS                    (0x10000002u)

#define TIVX_VPAC_LDC_CMD_SET_LDC_PARAMS                    (0x10000003u)

#define TIVX_VPAC_LDC_CMD_GET_PSA_STATUS                    (0x10000004u)

#define TIVX_VPAC_LDC_CMD_SET_LDC_DCC_PARAMS                  (0x30000000u)

/*********************************
 *      VPAC_LDC Defines
 *********************************/

#define TIVX_VPAC_LDC_ALIGN_LSB        (0U)

#define TIVX_VPAC_LDC_ALIGN_MSB        (1U)

#define TIVX_VPAC_LDC_INTERPOLATION_BICUBIC        (0U)

#define TIVX_VPAC_LDC_INTERPOLATION_BILINEAR       (1U)

#define TIVX_VPAC_LDC_MODE_LUMA_ONLY        (0U)

#define TIVX_VPAC_LDC_MODE_CHROMA_ONLY      (1U)

#define TIVX_VPAC_LDC_CALC_MESH_LINE_OFFSET(width, subsample_factor)      \
    ((((((width)/(subsample_factor))+1) + 15U) & ~15U) * (4U))

#define TIVX_VPAC_LDC_BIT_DEPTH_CONV_LUT_SIZE           (513u)

#define TIVX_VPAC_LDC_PIX_BLK_OUTOFBOUND_ERR_STATUS    (0x1u)

#define TIVX_VPAC_LDC_MESH_BLK_OUTOFBOUND_ERR_STATUS   (0x2u)

#define TIVX_VPAC_LDC_PIX_MEM_OVF_ERR_STATUS           (0x4u)

#define TIVX_VPAC_LDC_MESH_MEM_OVF_ERR_STATUS          (0x8u)

#define TIVX_VPAC_LDC_PIX_FRM_OUTOFBOUND_ERR_STATUS    (0x10u)

#define TIVX_VPAC_LDC_SZ_OVF_ERR_STATUS                (0x20u)

#define TIVX_VPAC_LDC_SL2_WR_ERR_STATUS                (0x80u)

#define TIVX_VPAC_LDC_RD_ERR_STATUS                    (0x100u)

#define TIVX_VPAC_LDC_WDTIMER_ERR                      (0x40000000U)

#define TIVX_VPAC_LDC_SET_PARAMS_WARP_MATRIX_IDX        (0u)

#define TIVX_VPAC_LDC_DEF_BLOCK_WIDTH                  (64u)
#define TIVX_VPAC_LDC_DEF_BLOCK_HEIGHT                 (64u)
#define TIVX_VPAC_LDC_DEF_PIXEL_PAD                    (0u)

/* Maximum number of outputs supported in LDC */
#define TIVX_VPAC_LDC_MAX_OUTPUT                        (2u)

/*********************************
 *      VPAC_LDC STRUCTURES
 *********************************/

typedef struct {
    uint32_t                                enable;
    uint32_t                                out_block_width;
    uint32_t                                out_block_height;
    uint32_t                                pixel_pad;
} tivx_vpac_ldc_region_params_t;

typedef struct {
    uint32_t                                reg_width[3];
    uint32_t                                reg_height[3];
    tivx_vpac_ldc_region_params_t           reg_params[3][3];
} tivx_vpac_ldc_multi_region_params_t;

typedef struct {

    uint32_t                                mesh_frame_width;
    uint32_t                                mesh_frame_height;

    uint32_t                                subsample_factor;
} tivx_vpac_ldc_mesh_params_t;

typedef struct {
    uint32_t                                input_align_12bit;
    uint32_t                                luma_interpolation_type;

    uint32_t                                init_x;
    uint32_t                                init_y;

    uint32_t                                yc_mode;

    uint32_t                                dcc_camera_id;
    #if defined(VPAC3) || defined(VPAC3L)

    uint32_t in_img0_yc_mode;
    uint32_t in_img1_yc_mode;
    #endif

    uint32_t                            enable_error_events;
    uint32_t                            enable_psa;
} tivx_vpac_ldc_params_t;


typedef struct {
    uint32_t                                bandwidth_control;
    uint32_t                                tag_count;
    uint32_t                                max_burst_length;
} tivx_vpac_ldc_bandwidth_params_t;

typedef struct {
    uint32_t                                input_bits;
    uint32_t                                output_bits;
    uint16_t                                lut[TIVX_VPAC_LDC_BIT_DEPTH_CONV_LUT_SIZE];
} tivx_vpac_ldc_bit_depth_conv_lut_params_t;

typedef struct {
    uint32_t psa_values[TIVX_VPAC_LDC_MAX_OUTPUT];

    uint64_t timestamp;
} tivx_vpac_ldc_psa_timestamp_data_t;

/*********************************
 *      Function Prototypes
 *********************************/

void tivxRegisterHwaTargetVpacLdcKernels(void);


void tivxUnRegisterHwaTargetVpacLdcKernels(void);


VX_API_ENTRY vx_node VX_API_CALL tivxVpacLdcNode(vx_graph graph,
                                      vx_user_data_object  configuration,
                                      vx_matrix            warp_matrix,
                                      vx_user_data_object  region_prms,
                                      vx_user_data_object  mesh_prms,
                                      vx_image             mesh_img,
                                      vx_user_data_object  dcc_db,
                                      vx_image             in_img,
                                      vx_image             out0_img,
                                      vx_image             out1_img);
VX_API_ENTRY vx_node VX_API_CALL tivxVpacLdcNode2(vx_graph graph,
                                      vx_user_data_object  configuration,
                                      vx_matrix            warp_matrix,
                                      vx_user_data_object  region_prms,
                                      vx_user_data_object  mesh_prms,
                                      vx_image             mesh_img,
                                      vx_user_data_object  dcc_db,
                                      vx_image             in0_img,
                                      vx_image             out0_img,
                                      vx_image             out1_img,
                                      vx_image             in1_img,
                                      vx_image             out2_img,
                                      vx_image             out3_img);
void tivx_vpac_ldc_region_params_init(tivx_vpac_ldc_region_params_t *prms);

void tivx_vpac_ldc_multi_region_params_init(tivx_vpac_ldc_multi_region_params_t *prms);

void tivx_vpac_ldc_mesh_params_init(tivx_vpac_ldc_mesh_params_t *prms);

void tivx_vpac_ldc_bandwidth_params_init(
    tivx_vpac_ldc_bandwidth_params_t *prms);

void tivx_vpac_ldc_params_init(tivx_vpac_ldc_params_t *prms);

#ifdef __cplusplus
}
#endif

#endif /* HWA_VPAC_LDC_H_ */