TIOVX User Guide

Detailed Description

CSITX (Sink Node) Kernels.

Data Structures

struct  tivx_csitx_inst_params_t
 The CSITX DRV instance configuration data structure used by the TIVX_KERNEL_CSITX kernel. More...
 
struct  tivx_csitx_params_t
 The configuration data structure used by the TIVX_KERNEL_CSITX kernel. More...
 
struct  tivx_csitx_statistics_t
 Csitx status structure used to get the current status. More...
 

Defines

#define TIVX_KERNEL_CSITX_NAME   "com.ti.csitx"
 csitx kernel name
 
#define TIVX_CSITX_PRINT_STATISTICS   (0x40000000u)
 Control Command to print csitx statistics No argument is needed to query statistics.
 
#define TIVX_CSITX_GET_STATISTICS   (0x40000001u)
 Control Command to return csitx statistics to application. More...
 
#define TIVX_CSITX_MAX_CH   (4U)
 Maximum number of channels supported in the csitx node.
 
#define TIVX_CSITX_MAX_INST   (1U)
 Maximum number of instances supported in the csitx node.
 
#define TIVX_CSITX_LANE_BAND_SPEED_80_TO_100_MBPS   ((uint32_t) 0x00U)
 Lane Band Speed: 80 Mbps to 100 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_100_TO_120_MBPS   ((uint32_t) 0x01U)
 Lane Band Speed: 100 Mbps to 120 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_120_TO_160_MBPS   ((uint32_t) 0x02U)
 Lane Band Speed: 120 Mbps to 160 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_160_TO_200_MBPS   ((uint32_t) 0x03U)
 Lane Band Speed: 160 Mbps to 200 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_200_TO_240_MBPS   ((uint32_t) 0x04U)
 Lane Band Speed: 200 Mbps to 240 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_240_TO_320_MBPS   ((uint32_t) 0x05U)
 Lane Band Speed: 240 Mbps to 320 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_320_TO_390_MBPS   ((uint32_t) 0x06U)
 Lane Band Speed: 320 Mbps to 390 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_390_TO_450_MBPS   ((uint32_t) 0x07U)
 Lane Band Speed: 390 Mbps to 450 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_450_TO_510_MBPS   ((uint32_t) 0x08U)
 Lane Band Speed: 450 Mbps to 510 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_510_TO_560_MBPS   ((uint32_t) 0x09U)
 Lane Band Speed: 510 Mbps to 560 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_560_TO_640_MBPS   ((uint32_t) 0x0AU)
 Lane Band Speed: 560 Mbps to 640 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_640_TO_690_MBPS   ((uint32_t) 0x0BU)
 Lane Band Speed: 640 Mbps to 690 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_690_TO_770_MBPS   ((uint32_t) 0x0CU)
 Lane Band Speed: 690 Mbps to 770 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_770_TO_870_MBPS   ((uint32_t) 0x0DU)
 Lane Band Speed: 770 Mbps to 870 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_870_TO_950_MBPS   ((uint32_t) 0x0EU)
 Lane Band Speed: 870 Mbps to 950 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_950_TO_1000_MBPS   ((uint32_t) 0x0FU)
 Lane Band Speed: 950 Mbps to 1000 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_1000_TO_1200_MBPS   ((uint32_t) 0x10U)
 Lane Band Speed: 1000 Mbps to 1200 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_1200_TO_1400_MBPS   ((uint32_t) 0x11U)
 Lane Band Speed: 1200 Mbps to 1400 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_1400_TO_1600_MBPS   ((uint32_t) 0x12U)
 Lane Band Speed: 1400 Mbps to 1600 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_1600_TO_1800_MBPS   ((uint32_t) 0x13U)
 Lane Band Speed: 1600 Mbps to 1800 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_1800_TO_2000_MBPS   ((uint32_t) 0x14U)
 Lane Band Speed: 1800 Mbps to 2000 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_2000_TO_2200_MBPS   ((uint32_t) 0x15U)
 Lane Band Speed: 2000 Mbps to 2200 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_2200_TO_2500_MBPS   ((uint32_t) 0x16U)
 Lane Band Speed: 2200 Mbps to 2500 Mbps.
 
#define TIVX_CSITX_LANE_BAND_SPEED_RESERVED   ((uint32_t) 0x17U)
 Lane Band Speed: Reserved.
 
#define TIVX_CSITX_LANE_SPEED_MBPS_RESERVED   ((uint32_t) 0xFFFFFFFFU)
 Lane Speed: Reserved.
 

Functions

VX_API_ENTRY vx_node VX_API_CALL tivxCsitxNode (vx_graph graph, vx_user_data_object configuration, vx_object_array input)
 [Graph] Creates a CSI Tx node. More...
 
void tivx_csitx_params_init (tivx_csitx_params_t *prms)
 Function to initialize Csitx Parameters. More...
 

Macro Definition Documentation

◆ TIVX_CSITX_GET_STATISTICS

#define TIVX_CSITX_GET_STATISTICS   (0x40000001u)

Control Command to return csitx statistics to application.

This control command returns the status of the csitx node. Please refer to tivx_csitx_statistics_t structure.

Definition at line 102 of file video_io_csitx.h.

Function Documentation

◆ tivxCsitxNode()

VX_API_ENTRY vx_node VX_API_CALL tivxCsitxNode ( vx_graph  graph,
vx_user_data_object  configuration,
vx_object_array  input 
)

[Graph] Creates a CSI Tx node.

The csitx node takes in a user data object of type tivx_csitx_params_t to configure one or more csitx channels.The input must be of type vx_object_array, which contain an array of either vx_image or tivx_raw_image data types. vx_image is used for transmitting processed image formats, while tivx_raw_image is used for raw sensor outputs.

Parameters
[in]graphThe reference to the graph.
[in]configurationThe input user data object of a single csitx params structure of type tivx_csitx_params_t.
[in]inputObject array input which has been created from an exemplar of either vx_image or tivx_raw_image. If using vx_image, the image type MUST be one of the following formats: VX_DF_IMAGE_RGBX, VX_DF_IMAGE_U16, VX_DF_IMAGE_UYVY or VX_DF_IMAGE_YUYV.
See also
TIVX_KERNEL_CSITX_NAME
Returns
vx_node.
Return values
vx_nodeA node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus

◆ tivx_csitx_params_init()

void tivx_csitx_params_init ( tivx_csitx_params_t prms)

Function to initialize Csitx Parameters.

Parameters
prms[in] Pointer to csitx params configuration structure