Jetson Linux API Reference

39.2 Release
nvsipl::SensorInfo Struct Reference

Detailed Description

Defines the image sensor information.

Definition at line 105 of file NvSIPLDeviceBlockInfo.hpp.

Collaboration diagram for nvsipl::SensorInfo:

Data Structures

struct  Resolution
 Defines the image resolution. More...
 
struct  UserDefDTCaptureSetting
 Defines the user defined datatype capture settings. More...
 
struct  VirtualChannelInfo
 Defines the information of a virtual channel/single exposure. More...
 

Data Fields

uint32_t id = UINT32_MAX
 Holds the identification of the pipeline index in the platform configuration. More...
 
std::string name = ""
 Holds the name of the image sensor, for example, "AR0231". More...
 
std::string description = ""
 Holds the description of the image sensor. More...
 
uint8_t i2cAddress {static_cast<uint8_t>UINT8_MAX}
 Holds the native I2C address of the image sensor. More...
 
VirtualChannelInfo vcInfo
 Holds virtual channel information. More...
 
bool useVcInfoList {false}
 Holds a flag which indicates whether to use vcInfoList instead of vcInfo. More...
 
uint32_t numVCs {1U}
 Holds the number of virtual channels enabled for a sensor. More...
 
VirtualChannelInfo vcInfoList [MAX_VIRTUAL_CHANNELS_PER_SENSOR]
 Holds an array of virtual channel information per sensor. More...
 
bool isTriggerModeEnabled {false}
 Holds a flag which indicates whether trigger mode is enabled. More...
 
std::vector< IntrGpioInfo > errGpios {}
 Holds Interrupt GPIO configurations for the sensor. More...
 
bool useCDIv2API {false}
 Holds a flag which indicates whether CDI (Camera Device Interface) is using the new version 2 API for device. More...
 
bool isAuthEnabled {false}
 Holds a flag which indicates whether sensor itself and all data exchange with sensor (image data and i2c communication) must be cryptographically authenticated. More...
 
bool isTPGEnabled {false}
 Holds a flag which indicates whether the sensor requires configuration in Test Pattern Generator (TPG) mode. More...
 
uint32_t patternMode {0U}
 Holds the Test Pattern Generator (TPG) pattern mode. More...
 
uint8_t virtualI2CAddress {static_cast<uint8_t>UINT8_MAX}
 Holds the requested virtual I2C address of the image sensor. More...
 
uint16_t numContext {1U}
 Holds the number of capture contexts a sensor supports. More...
 

Field Documentation

◆ description

std::string nvsipl::SensorInfo::description = ""

Holds the description of the image sensor.

Definition at line 282 of file NvSIPLDeviceBlockInfo.hpp.

◆ errGpios

std::vector<IntrGpioInfo> nvsipl::SensorInfo::errGpios {}

Holds Interrupt GPIO configurations for the sensor.

Definition at line 317 of file NvSIPLDeviceBlockInfo.hpp.

◆ i2cAddress

uint8_t nvsipl::SensorInfo::i2cAddress {static_cast<uint8_t>UINT8_MAX}

Holds the native I2C address of the image sensor.

Valid value: [0, UINT8_MAX]

Definition at line 289 of file NvSIPLDeviceBlockInfo.hpp.

◆ id

uint32_t nvsipl::SensorInfo::id = UINT32_MAX

Holds the identification of the pipeline index in the platform configuration.

Valid value: [0, MAX_CAMERAMODULES_PER_PLATFORM - 1]

Definition at line 277 of file NvSIPLDeviceBlockInfo.hpp.

◆ isAuthEnabled

bool nvsipl::SensorInfo::isAuthEnabled {false}

Holds a flag which indicates whether sensor itself and all data exchange with sensor (image data and i2c communication) must be cryptographically authenticated.

Note
This flag has no effect; authentication is not supported on Non-Embedded platforms.

Definition at line 344 of file NvSIPLDeviceBlockInfo.hpp.

◆ isTPGEnabled

bool nvsipl::SensorInfo::isTPGEnabled {false}

Holds a flag which indicates whether the sensor requires configuration in Test Pattern Generator (TPG) mode.

The default value is false.

Definition at line 353 of file NvSIPLDeviceBlockInfo.hpp.

◆ isTriggerModeEnabled

bool nvsipl::SensorInfo::isTriggerModeEnabled {false}

Holds a flag which indicates whether trigger mode is enabled.

The default value is false.

Definition at line 315 of file NvSIPLDeviceBlockInfo.hpp.

◆ name

std::string nvsipl::SensorInfo::name = ""

Holds the name of the image sensor, for example, "AR0231".

Definition at line 279 of file NvSIPLDeviceBlockInfo.hpp.

◆ numContext

uint16_t nvsipl::SensorInfo::numContext {1U}

Holds the number of capture contexts a sensor supports.

Valid value: [1U, 4U]

Definition at line 374 of file NvSIPLDeviceBlockInfo.hpp.

◆ numVCs

uint32_t nvsipl::SensorInfo::numVCs {1U}

Holds the number of virtual channels enabled for a sensor.

Valid value: [1, MAX_VIRTUAL_CHANNELS_PER_SENSOR]

Definition at line 307 of file NvSIPLDeviceBlockInfo.hpp.

◆ patternMode

uint32_t nvsipl::SensorInfo::patternMode {0U}

Holds the Test Pattern Generator (TPG) pattern mode.

Definition at line 355 of file NvSIPLDeviceBlockInfo.hpp.

◆ useCDIv2API

bool nvsipl::SensorInfo::useCDIv2API {false}

Holds a flag which indicates whether CDI (Camera Device Interface) is using the new version 2 API for device.

The default value is false for version 1 API.

Note
The flag is only used for non-Safety build. For Safety build, CDI is always using version 2 API.

Definition at line 327 of file NvSIPLDeviceBlockInfo.hpp.

◆ useVcInfoList

bool nvsipl::SensorInfo::useVcInfoList {false}

Holds a flag which indicates whether to use vcInfoList instead of vcInfo.

Note
Default value is false, this flag will be deprecated with vcInfo.

Definition at line 301 of file NvSIPLDeviceBlockInfo.hpp.

◆ vcInfo

VirtualChannelInfo nvsipl::SensorInfo::vcInfo

Holds virtual channel information.

Note
This will be deprecated. Use vcInfoList instead.

Definition at line 295 of file NvSIPLDeviceBlockInfo.hpp.

◆ vcInfoList

VirtualChannelInfo nvsipl::SensorInfo::vcInfoList[MAX_VIRTUAL_CHANNELS_PER_SENSOR]

Holds an array of virtual channel information per sensor.

Definition at line 309 of file NvSIPLDeviceBlockInfo.hpp.

◆ virtualI2CAddress

uint8_t nvsipl::SensorInfo::virtualI2CAddress {static_cast<uint8_t>UINT8_MAX}

Holds the requested virtual I2C address of the image sensor.

Note
: By default (e.g. left unset), SIPL will choose the virtual address.
: On QNX, this address must be from the virtual address pool. Consult the Device Block Device Tree configuration SDK section for address ranges.

Valid value: [0, UINT8_MAX]. Must be different from the SensorInfo::i2cAddress value.

Definition at line 367 of file NvSIPLDeviceBlockInfo.hpp.


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