hwa_vpac_msc.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_MSC_H_
#define HWA_VPAC_MSC_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_KERNEL_VPAC_MSC_MULTI_SCALE_NAME "com.ti.hwa.vpac_msc_multi_scale"

#define TIVX_KERNEL_VPAC_MSC_PYRAMID_NAME   "com.ti.hwa.vpac_msc_pyramid"

#define TIVX_KERNEL_VPAC_MSC_MULTI_SCALE2_NAME "com.ti.hwa.vpac_msc_multi_scale2"

/*********************************
 *      VPAC_MSC Control Commands
 *********************************/

#define TIVX_VPAC_MSC_CMD_SET_COEFF                    (0x20000000u)

#define TIVX_VPAC_MSC_CMD_SET_INPUT_PARAMS             (0x20000001u)

#define TIVX_VPAC_MSC_CMD_SET_OUTPUT_PARAMS            (0x20000002u)

#define TIVX_VPAC_MSC_CMD_SET_CROP_PARAMS            (0x20000003u)

#define TIVX_VPAC_MSC_CMD_GET_ERR_STATUS                    (0x20000004u)

#define TIVX_VPAC_MSC_CMD_GET_PSA_STATUS                    (0x20000005u)

#define TIVX_VPAC_MSC_CMD_ENABLE_ERROR_EVENTS               (0x20000006u)

/* MSC: Add command for enabling safety mechanism */
#define TIVX_VPAC_MSC_CMD_ENABLE_SAFETY_MECHANISM           (0x20000007u)

/*********************************
 *      VPAC_MSC Defines
 *********************************/

#define TIVX_VPAC_MSC_MAX_MP_COEFF_SET                (4U)

#define TIVX_VPAC_MSC_MAX_SP_COEFF_SET                (2U)

#define TIVX_VPAC_MSC_MAX_OUTPUT                      (10U)

#define TIVX_VPAC_MSC_MAX_TAP                         (5U)

#define TIVX_VPAC_MSC_32_PHASE_COEFF                  (32U)

#define TIVX_VPAC_MSC_AUTOCOMPUTE                     (0xFFFFFFFFU)

#define TIVX_VPAC_MSC_INTERPOLATION_GAUSSIAN_32_PHASE (0)

#define TIVX_VPAC_MSC_MODE_LUMA_ONLY        (0U)

#define TIVX_VPAC_MSC_MODE_CHROMA_ONLY      (1U)

#define TIVX_VPAC_MSC_MODE_420SP_UV_CHROMA_ONLY      (1U)

#define TIVX_VPAC_MSC_MODE_420SP_VU_CHROMA_ONLY      (2U)

#define TIVX_VPAC_MSC_MODE_422SP_UV_CHROMA_ONLY      (3U)

#define TIVX_VPAC_MSC_MODE_422SP_VU_CHROMA_ONLY      (4U)

#define TIVX_VPAC_MSC_INIT_DIV_FACTOR       (1U)

#define TIVX_VPAC_MSC_DEFAULT_MAX_DS_FACTOR       (2U)

#define TIVX_VPAC_MSC_VBUSM_RD_ERR                   (0x4U)

#define TIVX_VPAC_MSC_SL2_WR_ERR                     (0x8U)

#define TIVX_VPAC_MSC0_WDTIMER_ERR                   (0x40000000U)

#define TIVX_VPAC_MSC1_WDTIMER_ERR                   (0x80000000U)

#define TIVX_VPAC_MSC0_ALL_ERR_EVENTS ( \
    TIVX_VPAC_MSC_VBUSM_RD_ERR | \
    TIVX_VPAC_MSC_SL2_WR_ERR | \
    TIVX_VPAC_MSC0_WDTIMER_ERR \
)

#define TIVX_VPAC_MSC1_ALL_ERR_EVENTS ( \
    TIVX_VPAC_MSC_VBUSM_RD_ERR | \
    TIVX_VPAC_MSC_SL2_WR_ERR | \
    TIVX_VPAC_MSC1_WDTIMER_ERR \
)

#define TIVX_VPAC_MSC_WDTIMER_DISABLE                (0u)

#define TIVX_VPAC_MSC_WDTIMER_ENABLE                 (1u)

#define TIVX_VPAC_MSC_WDTIMER_64K_CYCLES             (0u)

#define TIVX_VPAC_MSC_WDTIMER_128K_CYCLES            (1u)

#define TIVX_VPAC_MSC_MAX_COMP                   (2u)

/*********************************
 *      VPAC_MSC STRUCTURES
 *********************************/

typedef struct {
    int32_t  single_phase[TIVX_VPAC_MSC_MAX_SP_COEFF_SET][TIVX_VPAC_MSC_MAX_TAP];
    int32_t  multi_phase[TIVX_VPAC_MSC_MAX_MP_COEFF_SET]
        [TIVX_VPAC_MSC_MAX_TAP*TIVX_VPAC_MSC_32_PHASE_COEFF];
} tivx_vpac_msc_coefficients_t;

typedef struct {
    uint32_t  horz_coef_src;
    uint32_t  horz_coef_sel;
    uint32_t  vert_coef_src;
    uint32_t  vert_coef_sel;
} tivx_vpac_msc_single_phase_params_t;

typedef struct {
    uint32_t  phase_mode;
    uint32_t  horz_coef_sel;
    uint32_t  vert_coef_sel;
    uint32_t  init_phase_x;
    uint32_t  init_phase_y;
} tivx_vpac_msc_multi_phase_params_t;

typedef struct {
    uint32_t  crop_start_x;
    uint32_t  crop_start_y;
    uint32_t  crop_width;
    uint32_t  crop_height;
} tivx_vpac_msc_crop_params_t;

typedef struct {
    uint32_t  signed_data;
    uint32_t  filter_mode;
    uint32_t  coef_shift;
    uint32_t  saturation_mode;
    uint32_t  offset_x;
    uint32_t  offset_y;
    uint32_t  output_align_12bit;

    tivx_vpac_msc_single_phase_params_t single_phase;
    tivx_vpac_msc_multi_phase_params_t  multi_phase;
} tivx_vpac_msc_output_params_t;

typedef struct {
    uint32_t  kern_sz;
    uint32_t  src_ln_inc_2;
    uint32_t  input_align_12bit;
    uint32_t yc_mode;
    uint32_t max_ds_factor;
    #if defined(VPAC3) || defined(VPAC3L)

    uint32_t is_enable_simul_processing;
    uint32_t in_img0_yc_mode;
    uint32_t in_img1_yc_mode;
    #endif

    uint32_t enable_error_events;
    uint32_t enable_psa;
    uint32_t wdtimer_timeout_cycles;
} tivx_vpac_msc_input_params_t;

typedef struct {
    uint32_t psa_values[TIVX_VPAC_MSC_MAX_COMP][TIVX_VPAC_MSC_MAX_OUTPUT];

    uint64_t timestamp;
} tivx_vpac_msc_psa_timestamp_data_t;

typedef struct {

    /* This flag will be used to control the reconfig of MMR safety mechanism feature */
    /*
     * Note: The user/application must periodically trigger the control command
     * "TIVX_VPAC_MSC_CMD_SET_COEFF" along with "TIVX_VPAC_MSC_CMD_ENABLE_SAFETY_MECHANISM".
     * This ensures that the MSC coefficients are reconfigured for every frame being processed.
     */
    uint32_t enable_reconfig_and_reinit_Reg;

    /* This flag will be used to control the status register validation safety mechanism feature */
    uint32_t enable_status_reg_validation;

    /* This flag will be used to control the readback of configuration registers for safety validation */
    uint32_t enable_readback_config_registers;

} tivx_vpac_msc_safety_mechanism_params_t;

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

void tivxRegisterHwaTargetVpacMscKernels(void);

void tivxUnRegisterHwaTargetVpacMscKernels(void);

VX_API_ENTRY vx_node VX_API_CALL tivxVpacMscScaleNode(vx_graph graph,
                                      vx_image             in_img0,
                                      vx_image             out0_img,
                                      vx_image             out1_img,
                                      vx_image             out2_img,
                                      vx_image             out3_img,
                                      vx_image             out4_img);

VX_API_ENTRY vx_node VX_API_CALL tivxVpacMscScaleNode2(vx_graph graph,
                                      vx_image             in_img0,
                                      vx_image             out0_img,
                                      vx_image             out1_img,
                                      vx_image             out2_img,
                                      vx_image             out3_img,
                                      vx_image             out4_img,
                                      vx_image             in_img1,
                                      vx_image             out5_img,
                                      vx_image             out6_img,
                                      vx_image             out7_img,
                                      vx_image             out8_img,
                                      vx_image             out9_img);

VX_API_ENTRY vx_node VX_API_CALL tivxVpacMscPyramidNode(vx_graph graph,
                                      vx_image             in_img,
                                      vx_pyramid           out_pyramid);


void tivx_vpac_msc_coefficients_params_init(tivx_vpac_msc_coefficients_t *coeff, vx_enum interpolation);

void tivx_vpac_msc_input_params_init(tivx_vpac_msc_input_params_t *prms);

void tivx_vpac_msc_output_params_init(tivx_vpac_msc_output_params_t *prms);

#if !defined(VPAC3L)

void tivx_vpac_msc_safety_mech_prms_init(tivx_vpac_msc_safety_mechanism_params_t *prms);
#endif
#ifdef __cplusplus
}
#endif

#endif /* HWA_VPAC_MSC_H_ */