video_io_capture.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 VIDEO_IO_CAPTURE_H_
#define VIDEO_IO_CAPTURE_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_KERNEL_CAPTURE_NAME          "com.ti.capture"


/*********************************
 *      Capture Control Commands
 *********************************/

#define TIVX_CAPTURE_PRINT_STATISTICS                    (0x40000000u)

#define TIVX_CAPTURE_GET_STATISTICS                      (0x40000001u)

#define TIVX_CAPTURE_REGISTER_ERROR_FRAME                (0x40000002u)

/* None */

/*********************************
 *      Capture Defines
 *********************************/

#if defined(SOC_AM62A)
#define TIVX_CAPTURE_MAX_CH                                 (4U)
#else
#define TIVX_CAPTURE_MAX_CH                                 (16U)
#endif

#if defined(SOC_J784S4)
#define TIVX_CAPTURE_MAX_INST                               (3U)
#elif defined(SOC_AM62A)
#define TIVX_CAPTURE_MAX_INST                               (1U)
#else
#define TIVX_CAPTURE_MAX_INST                               (2U)
#endif

#if defined(SOC_AM62A)
#define TIVX_CAPTURE_MAX_STRM                               (1U)
#else
#define TIVX_CAPTURE_MAX_STRM                               (4U)
#endif

#define TIVX_CAPTURE_LANE_BAND_SPEED_80_TO_100_MBPS              ((uint32_t) 0x00U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_100_TO_120_MBPS             ((uint32_t) 0x01U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_120_TO_160_MBPS             ((uint32_t) 0x02U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_160_TO_200_MBPS             ((uint32_t) 0x03U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_200_TO_240_MBPS             ((uint32_t) 0x04U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_240_TO_280_MBPS             ((uint32_t) 0x05U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_280_TO_320_MBPS             ((uint32_t) 0x06U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_320_TO_360_MBPS             ((uint32_t) 0x07U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_360_TO_400_MBPS             ((uint32_t) 0x08U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_400_TO_480_MBPS             ((uint32_t) 0x09U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_480_TO_560_MBPS             ((uint32_t) 0x0AU)

#define TIVX_CAPTURE_LANE_BAND_SPEED_560_TO_640_MBPS             ((uint32_t) 0x0BU)

#define TIVX_CAPTURE_LANE_BAND_SPEED_640_TO_720_MBPS             ((uint32_t) 0x0CU)

#define TIVX_CAPTURE_LANE_BAND_SPEED_720_TO_800_MBPS             ((uint32_t) 0x0DU)

#define TIVX_CAPTURE_LANE_BAND_SPEED_800_TO_880_MBPS             ((uint32_t) 0x0EU)

#define TIVX_CAPTURE_LANE_BAND_SPEED_880_TO_1040_MBPS            ((uint32_t) 0x0FU)

#define TIVX_CAPTURE_LANE_BAND_SPEED_1040_TO_1200_MBPS           ((uint32_t) 0x10U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_1200_TO_1350_MBPS           ((uint32_t) 0x11U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_1350_TO_1500_MBPS           ((uint32_t) 0x12U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_1500_TO_1750_MBPS           ((uint32_t) 0x13U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_1750_TO_2000_MBPS           ((uint32_t) 0x14U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_2000_TO_2250_MBPS           ((uint32_t) 0x15U)

#define TIVX_CAPTURE_LANE_BAND_SPEED_2250_TO_2500_MBPS           ((uint32_t) 0x16U)

/*********************************
 *      Capture STRUCTURES
 *********************************/
typedef struct
{
    uint32_t enableCsiv2p0Support;  
    uint32_t numDataLanes;          
    uint32_t dataLanesMap[4];       
    uint32_t laneBandSpeed;         
    uint32_t numPixels;             
} tivx_capture_inst_params_t;

typedef struct
{
    tivx_capture_inst_params_t instCfg[TIVX_CAPTURE_MAX_INST]; 
    uint32_t instId[TIVX_CAPTURE_MAX_INST]; 
    uint32_t numInst; 
    uint32_t numCh; 
    uint32_t chVcNum[TIVX_CAPTURE_MAX_CH]; 
    uint32_t chInstMap[TIVX_CAPTURE_MAX_CH]; 
    uint32_t timeout; 
    uint32_t timeoutInitial; 
} tivx_capture_params_t;

typedef struct
{
    uint32_t queueCount[TIVX_CAPTURE_MAX_INST][TIVX_CAPTURE_MAX_CH];
    uint32_t dequeueCount[TIVX_CAPTURE_MAX_INST][TIVX_CAPTURE_MAX_CH];
    uint32_t dropCount[TIVX_CAPTURE_MAX_INST][TIVX_CAPTURE_MAX_CH];
    uint32_t errorFrameCount[TIVX_CAPTURE_MAX_INST][TIVX_CAPTURE_MAX_CH];
    uint32_t overflowCount[TIVX_CAPTURE_MAX_INST];
    uint32_t spuriousUdmaIntrCount[TIVX_CAPTURE_MAX_INST];
    uint32_t frontFIFOOvflCount[TIVX_CAPTURE_MAX_INST];
    uint32_t crcCount[TIVX_CAPTURE_MAX_INST];
    uint32_t eccCount[TIVX_CAPTURE_MAX_INST];
    uint32_t correctedEccCount[TIVX_CAPTURE_MAX_INST];
    uint32_t dataIdErrorCount[TIVX_CAPTURE_MAX_INST];
    uint32_t invalidAccessCount[TIVX_CAPTURE_MAX_INST];
    uint32_t invalidSpCount[TIVX_CAPTURE_MAX_INST];
    uint32_t strmFIFOOvflCount[TIVX_CAPTURE_MAX_INST][TIVX_CAPTURE_MAX_STRM];
    uint8_t activeChannelMask;
} tivx_capture_statistics_t;


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

void tivxRegisterVideoIOTargetCaptureKernels(void);


void tivxUnRegisterVideoIOTargetCaptureKernels(void);


VX_API_ENTRY vx_node VX_API_CALL tivxCaptureNode(vx_graph graph,
                                      vx_user_data_object  input,
                                      vx_object_array      output);

void tivx_capture_params_init(tivx_capture_params_t *prms);

vx_status tivxCaptureRegisterErrorFrame(vx_node node, vx_reference ref);

#ifdef __cplusplus
}
#endif

#endif /* VIDEO_IO_CAPTURE_H_ */