NVIDIA DRIVE OS Linux SDK API Reference

5.1.15.0 Release
For Test and Development only
NvMediaICPSettings Struct Reference

Detailed Description

Holds image capture settings for the CSI format.

Definition at line 255 of file nvmedia_icp.h.

Collaboration diagram for NvMediaICPSettings:

Data Fields

NvMediaICPInterfaceType interfaceType
 Holds the interface type. More...
 
NvMediaICPInputFormat inputFormat
 Holds the input format. More...
 
NvMediaSurfaceType surfaceType
 Holds the capture surface type. More...
 
uint16_t width
 Holds the capture width in pixels. More...
 
uint16_t height
 Holds the capture height in pixels. More...
 
uint16_t startX
 Holds the horizontal start position. More...
 
uint16_t startY
 Holds the vertical start position. More...
 
uint16_t embeddedDataLines
 Holds the embedded data lines. More...
 
uint32_t interfaceLanes
 Holds the number of CSI interface lanes active. More...
 
uint32_t pixelFrequency
 Holds the pixel clock frequency. More...
 
uint32_t mipiSpeed
 For DPHY mode, holds the mipi data rate in kbps. More...
 
uint16_t thsSettle
 Holds the MIPI THS-SETTLE time. More...
 
NvMediaBool embeddedDataType
 Holds an indicator of embedded data type. More...
 
uint8_t tpgEnable
 Holds a Boolean; indicates whether TPG is enabled. More...
 
NvMediaICPCsiPhyMode phyMode
 Holds the CSI phy mode. More...
 
uint32_t frameRate
 Holds the capture frame rate in frames per second. More...
 

Field Documentation

◆ embeddedDataLines

uint16_t NvMediaICPSettings::embeddedDataLines

Holds the embedded data lines.

Definition at line 275 of file nvmedia_icp.h.

◆ embeddedDataType

NvMediaBool NvMediaICPSettings::embeddedDataType

Holds an indicator of embedded data type.

true means embedded lines come with embedded data type in CSI packets.

Definition at line 296 of file nvmedia_icp.h.

◆ frameRate

uint32_t NvMediaICPSettings::frameRate

Holds the capture frame rate in frames per second.

If the actual frame rate is slower than this value, a frame completion timeout error occurs. Set the frame rate to zero to disable the frameout timer.

Definition at line 306 of file nvmedia_icp.h.

◆ height

uint16_t NvMediaICPSettings::height

Holds the capture height in pixels.

Definition at line 267 of file nvmedia_icp.h.

◆ inputFormat

NvMediaICPInputFormat NvMediaICPSettings::inputFormat

Holds the input format.

Definition at line 261 of file nvmedia_icp.h.

◆ interfaceLanes

uint32_t NvMediaICPSettings::interfaceLanes

Holds the number of CSI interface lanes active.

This parameter will be ignored. Please set interfaceLanes in NvMediaICPSettingsEx

Definition at line 279 of file nvmedia_icp.h.

◆ interfaceType

NvMediaICPInterfaceType NvMediaICPSettings::interfaceType

Holds the interface type.

This parameter will be ignored. Please set interfaceType in NvMediaICPSettingsEx

Definition at line 259 of file nvmedia_icp.h.

◆ mipiSpeed

uint32_t NvMediaICPSettings::mipiSpeed

For DPHY mode, holds the mipi data rate in kbps.

For CPHY mode, holds the mipi data rate in ksps. This is used to program CSI WDT(watch dog timer) for a long packet(a line), it helps to detect incomplete line packet early as much as a line cycle. if it is zero, CSI WDT won't be enabled

Definition at line 290 of file nvmedia_icp.h.

◆ phyMode

NvMediaICPCsiPhyMode NvMediaICPSettings::phyMode

Holds the CSI phy mode.

This parameter will be ignored. Please use phyMode in NvMediaICPSettingsEx

Definition at line 302 of file nvmedia_icp.h.

◆ pixelFrequency

uint32_t NvMediaICPSettings::pixelFrequency

Holds the pixel clock frequency.

If pixelFrequency is lower then mipiSpeed, mipiSpeed is required instead of pixelFrequency. It can be calculated from the expression HTS * VTS * framerate, with framerate in Hertz.

Definition at line 284 of file nvmedia_icp.h.

◆ startX

uint16_t NvMediaICPSettings::startX

Holds the horizontal start position.

This feature is not supported, this parameter will be ignored.

Definition at line 270 of file nvmedia_icp.h.

◆ startY

uint16_t NvMediaICPSettings::startY

Holds the vertical start position.

This feature is not supported, this parameter will be ignored.

Definition at line 273 of file nvmedia_icp.h.

◆ surfaceType

NvMediaSurfaceType NvMediaICPSettings::surfaceType

Holds the capture surface type.

Definition at line 263 of file nvmedia_icp.h.

◆ thsSettle

uint16_t NvMediaICPSettings::thsSettle

Holds the MIPI THS-SETTLE time.

The meaning of the value is SOC-specific.

Definition at line 293 of file nvmedia_icp.h.

◆ tpgEnable

uint8_t NvMediaICPSettings::tpgEnable

Holds a Boolean; indicates whether TPG is enabled.

Definition at line 298 of file nvmedia_icp.h.

◆ width

uint16_t NvMediaICPSettings::width

Holds the capture width in pixels.

Definition at line 265 of file nvmedia_icp.h.


The documentation for this struct was generated from the following file: