hwa_vpac_nf.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_NF_H_
#define HWA_VPAC_NF_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_KERNEL_VPAC_NF_GENERIC_NAME "com.ti.hwa.vpac_nf_generic"

#define TIVX_KERNEL_VPAC_NF_BILATERAL_NAME     "com.ti.hwa.vpac_nf_bilateral"


/*********************************
 *      VPAC_NF Control Commands
 *********************************/

#define TIVX_VPAC_NF_CMD_SET_HTS_LIMIT                     (0x10000000u)

#define TIVX_VPAC_NF_CMD_SET_COEFF                         (0x10000001u)

#define TIVX_VPAC_NF_CMD_GET_ERR_STATUS                    (0x10000002u)

#define TIVX_VPAC_NF_CMD_GET_PSA_STATUS                    (0x10000003u)

/*********************************
 *      VPAC_NF Defines
 *********************************/

#define TIVX_VPAC_NF_RD_ERR                         (0x400U)

#define TIVX_VPAC_NF_WR_ERR                         (0x200U)

#define TIVX_VPAC_NF_WDTIMER_ERR                    (0x40000000U)

#define TIOVX_VPAC_NF_MAX_COMP                      (2u)

/*********************************
 *      VPAC_NF STRUCTURES
 *********************************/

typedef struct {
    uint16_t  input_interleaved;       
    int16_t   output_downshift;        
    uint16_t  output_offset;           
    uint16_t  output_pixel_skip;       
    uint16_t  output_pixel_skip_odd;   
    uint16_t  kern_ln_offset;          
    uint16_t  kern_sz_height;          
    uint16_t  src_ln_inc_2;            
    uint32_t  enable_error_events;
    uint32_t  enable_psa;
} tivx_vpac_nf_common_params_t;

typedef struct {
    tivx_vpac_nf_common_params_t params;    
    uint16_t  adaptive_mode;
    uint16_t  sub_table_select;                
} tivx_vpac_nf_bilateral_params_t;

typedef struct {
    uint16_t  num_sigmas;
    vx_float64  sigma_space[8];  
    vx_float64  sigma_range[8];  
} tivx_vpac_nf_bilateral_sigmas_t;

typedef struct {
    uint32_t  enable_hts_bw_limit;
    uint32_t  cycle_cnt;
    uint32_t  token_cnt;
} tivx_vpac_nf_hts_bw_limit_params_t;

typedef struct {
    uint32_t psa_values[TIOVX_VPAC_NF_MAX_COMP];

    uint64_t timestamp;
} tivx_vpac_nf_psa_timestamp_data_t;


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

void tivxRegisterHwaTargetVpacNfKernels(void);


void tivxUnRegisterHwaTargetVpacNfKernels(void);


VX_API_ENTRY vx_node VX_API_CALL tivxVpacNfGenericNode(vx_graph graph,
                                      vx_user_data_object  configuration,
                                      vx_image             input,
                                      vx_convolution       conv,
                                      vx_image             output);

VX_API_ENTRY vx_node VX_API_CALL tivxVpacNfBilateralNode(vx_graph graph,
                                      vx_user_data_object  configuration,
                                      vx_image             input,
                                      vx_user_data_object  sigmas,
                                      vx_image             output);

void tivx_vpac_nf_common_params_init(tivx_vpac_nf_common_params_t *prms);

void tivx_vpac_nf_hts_bw_limit_params_init(tivx_vpac_nf_hts_bw_limit_params_t *prms);

void tivx_vpac_nf_bilateral_params_init(tivx_vpac_nf_bilateral_params_t *prms);

void tivx_vpac_nf_bilateral_sigmas_init(tivx_vpac_nf_bilateral_sigmas_t *sigmas);


#ifdef __cplusplus
}
#endif

#endif /* HWA_VPAC_NF_H_ */