hwa_dmpac_sde.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_DMPAC_SDE_H_
#define HWA_DMPAC_SDE_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_KERNEL_DMPAC_SDE_NAME     "com.ti.hwa.dmpac_sde"


/*********************************
 *      DMPAC_SDE Control Commands
 *********************************/

#define TIVX_DMPAC_SDE_CMD_SET_HTS_LIMIT                     (0x10000000u)

#define TIVX_DMPAC_SDE_CMD_GET_ERR_STATUS                    (0x10000001u)

#define TIVX_DMPAC_SDE_CMD_GET_PSA_STATUS                    (0x10000002u)

/*********************************
 *      DMPAC_SDE Defines
 *********************************/

#define TIVX_DMPAC_SDE_RD_ERR                         (0x40000U)

#define TIVX_DMPAC_SDE_WR_ERR                         (0x80000U)

#define TIVX_DMPAC_SDE_FOCO0_SL2_WR_ERR               (0x2000000U)

#define TIVX_DMPAC_SDE_FOCO0_VBUSM_RD_ERR             (0x1000000U)

#define TIVX_DMPAC_SDE_WDTIMER_ERR                    (0x40000000U)

#define TIVX_DMPAC_SDE_FOCO1_WDTIMER_ERR              (0x80000000U)

/*********************************
 *      DMPAC_SDE STRUCTURES
 *********************************/

typedef struct {
    uint16_t  median_filter_enable;         
    uint16_t  reduced_range_search_enable;  
    uint16_t  disparity_min;                
    uint16_t  disparity_max;                
    uint16_t  threshold_left_right;         
    uint16_t  texture_filter_enable;        
    uint16_t  threshold_texture;
    uint16_t  aggregation_penalty_p1;       
    uint16_t  aggregation_penalty_p2;       
    uint16_t  confidence_score_map[8];
    uint32_t  enable_error_events;
    uint32_t  enable_psa;
} tivx_dmpac_sde_params_t;

typedef struct {
    uint32_t psa_values;
    uint64_t timestamp;
} tivx_dmpac_sde_psa_timestamp_data_t;


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

void tivxRegisterHwaTargetDmpacSdeKernels(void);


void tivxUnRegisterHwaTargetDmpacSdeKernels(void);


VX_API_ENTRY vx_node VX_API_CALL tivxDmpacSdeNode(vx_graph graph,
                                      vx_user_data_object  configuration,
                                      vx_image             left,
                                      vx_image             right,
                                      vx_image             output,
                                      vx_distribution      confidence_histogram);

 void tivx_dmpac_sde_params_init(tivx_dmpac_sde_params_t *prms);


#ifdef __cplusplus
}
#endif

#endif /* HWA_DMPAC_SDE_H_ */