Jetson Linux API Reference

39.2 Release
NvSIPLCameraTypes.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
13 #ifndef NVSIPLCAMERATYPES_HPP
14 #define NVSIPLCAMERATYPES_HPP
15 
16 #include <array>
17 #include <chrono>
18 #include <cmath>
19 #include <cstdint>
20 #include <limits>
21 #include <optional>
22 #include <string>
23 #include <variant>
24 #include <vector>
25 
26 #include "NvSIPLCapStructs.h"
27 
29 
30 using MacAddress = std::array<uint8_t, 6>;
31 
36 {
42  uint32_t idx {UINT32_MAX};
43 
47  bool enableGetStatus {false};
48 
54  std::chrono::milliseconds timeout {0};
55 };
56 
61 {
65  uint8_t sourceGpio {UINT8_MAX};
66 
70  uint8_t destGpio {UINT8_MAX};
71 };
72 
77 {
78  using Address = uint16_t;
79  static constexpr Address INVALID {std::numeric_limits<Address>::max()};
80 
87 
94  std::optional<Address> virtualI2CAddress;
95 };
96 
101 {
103  struct Resolution
104  {
112  uint32_t width {0U};
113 
121  uint32_t height {0U};
122  };
123 
126  {
134  uint32_t lines {0U};
135 
144 
151  };
152 
157  {
165  uint32_t vcIdSrc {UINT32_MAX};
166 
174  uint32_t vcIdDst {UINT32_MAX};
175 
186  uint32_t cfa {0U};
187 
195  uint32_t embeddedTopLines {UINT32_MAX};
196 
204  uint32_t embeddedBottomLines {UINT32_MAX};
205 
214 
219 
227  float_t fps {0.0F};
228 
237 
265  uint32_t embeddedDataOffset {0U};
266 
273  std::optional<UserDataTypeCaptureConfig> userDataTypeCapture;
274  };
275 
281  uint32_t id {UINT32_MAX};
282 
284  std::string name;
285 
287  std::string description;
288 
293 
295  std::vector<VirtualChannelInfo> vcInfoList;
296 
300  bool isTriggerModeEnabled {false};
301 
303  std::vector<InterruptGpioInfo> errGpios;
304 
310  uint16_t numContext {1U};
311 
317  uint32_t sensorGroup {0};
318 
326  uint8_t deviceIndex {0};
327 
328  CommonSensorConfig& operator=(CommonSensorConfig const&) & = default;
329 };
330 
333 {
335  std::string name;
336 
337 #if !NV_IS_SAFETY
338 
339  std::string description;
340 #endif // !NV_IS_SAFETY
341 
346 
347  EEPROMConfig& operator=(EEPROMConfig const&) & = default;
348 };
349 
352 {
354  std::string name;
355 
356 #if !NV_IS_SAFETY
357 
358  std::string description;
359 #endif // !NV_IS_SAFETY
360 
365 
367  std::vector<InterruptGpioInfo> errGpios;
368 
370  std::vector<SerdesGPIOPinMap> serdesGPIOPinMappings;
371 
372  SerializerConfig& operator=(SerializerConfig const&) & = default;
373 };
374 
379 {
386 
394  uint32_t ipAddress {0};
395 
397 };
398 
405 using CoESensorConfig = std::variant<CoECameraSensorConfig>;
406 
410 struct CoEModule
411 {
415  std::vector<CoESensorConfig> sensorConfigs;
416 
425 
426  CoEModule& operator=(CoEModule const&) & = default;
427 };
428 
433 {
435  std::string interfaceName;
436 
440  uint32_t ipAddress {0};
441 
447  bool vlanEnable {false};
448 
452  bool syncSensors {true};
453 
454  CoETransportConfig& operator=(CoETransportConfig const&) & = default;
455 };
456 
461 {
465  struct ModuleInfo
466  {
468  std::string name;
469 
472 
473  ModuleInfo& operator=(ModuleInfo const&) & = default;
474  } moduleInfo;
475 
480  {
482  std::string name;
483 
489  std::optional<uint32_t> gpioPinIndex;
490 
493 
494  DeserializerInfo& operator=(DeserializerInfo const&) & = default;
496 
498 };
499 
503 enum class GmslLinkMode : uint8_t {
504  LINK_MODE_NONE = 0,
510 };
511 
515 enum class GmslFsyncMode : uint8_t {
516  FSYNC_INVALID = 0,
519 };
520 
522 {
524 };
525 
532 using GmslSensorConfig = std::variant<GmslCameraSensorConfig>;
533 
535 {
537  uint32_t linkIndex {UINT32_MAX};
538 
541 
544 
547 
550 
552  std::vector<EEPROMConfig> eepromConfigs;
553 
555  std::vector<GmslSensorConfig> sensorConfigs;
556 
557  GmslModule& operator=(GmslModule const&) & = default;
558 };
559 
561 {
563  std::string name;
564 
567 
569  std::vector<InterruptGpioInfo> errGpios;
570 
572  GmslDeserializerConfig() = default;
573 
576 
579 
582 
585 
587  ~GmslDeserializerConfig() = default;
588 };
589 
591 {
594 
597 
600 
602  uint32_t i2cDevice {UINT32_MAX};
603 
605  uint32_t deserializerI2CPort {UINT32_MAX};
606 
608  uint32_t deserializerTxPort {UINT32_MAX};
609 
611  uint32_t powerPort {UINT32_MAX};
612 
614  bool isPassiveModeEnabled {false};
615 
623  uint32_t srcPhy {UINT32_MAX};
624  uint32_t dstPhy {UINT32_MAX};
625  };
626  std::vector<ReplicationEntry> replicationInfo {};
627 
629  std::string bootAcceleratorTag;
630 
633 
635 };
636 
640 enum class NvSiplMipiPolarity : uint8_t
641 {
642  POLARITY_ABC = 0,
643  POLARITY_ACB = 1,
644  POLARITY_BCA = 2,
645  POLARITY_BAC = 3,
646  POLARITY_CAB = 4,
647  POLARITY_CBA = 5,
648  POLARITY_MAX
649 };
650 
654 enum class NvSiplMipiSwizzle : uint8_t
655 {
663 };
664 
669 {
675  uint8_t lanes {4};
676 
680  bool lpBypassMode {false};
681 
687  uint8_t tClkSettle {0};
688 
695  uint32_t mipiClockRate {0};
696 
707  uint8_t tHsSettle {0};
708 
729  std::array<NvSiplMipiPolarity, 4> lanePolarity {{
734  }};
735 
754 
760  uint32_t dphyRate {0};
761 
767  uint32_t cphyRate {0};
768 
773 };
774 
775 using ModuleType = std::variant<CoEModule, GmslModule>;
776 using TransportType = std::variant<CoETransportConfig, GmslTransportConfig>;
777 
779 {
781  std::string name;
782 
784  std::string description;
785 
787  uint32_t transportId {UINT32_MAX};
788 
791 
794 
796  std::string platform;
797 
799  std::string platformConfig;
800 
801  ModuleConfig& operator=(ModuleConfig const&) & = default;
802 };
803 
805 {
807  std::string name;
808 
810  std::string description;
811 
813  uint32_t transportId {UINT32_MAX};
814 
817 
818  TransportConfig& operator=(TransportConfig const&) & = default;
819 };
820 
825 {
827  std::vector<ModuleConfig> modules;
828 
830  std::vector<TransportConfig> transports;
831 
832  SensorSystemConfig& operator=(SensorSystemConfig const&) & = default;
833 };
834 
835 } // namespace nvsipl::sensorconfig
836 
837 #endif // NVSIPLCAMERATYPES_HPP
nvsipl::sensorconfig::MipiSettings::cphyRate
uint32_t cphyRate
C-PHY symbol rate in ksps.
Definition: NvSIPLCameraTypes.hpp:767
NVSIPL_CAP_CSI_INTERFACE_TYPE_CSI_A
@ NVSIPL_CAP_CSI_INTERFACE_TYPE_CSI_A
Specifies CSI port A.
Definition: NvSIPLCapStructs.h:37
nvsipl::sensorconfig::TransportConfig::operator=
TransportConfig & operator=(TransportConfig const &) &=default
nvsipl::sensorconfig::TransportConfig::name
std::string name
Name of the transport.
Definition: NvSIPLCameraTypes.hpp:807
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::isEmbeddedDataTypeEnabled
bool isEmbeddedDataTypeEnabled
Indicates whether the embedded data is coming in CSI packet with different data.
Definition: NvSIPLCameraTypes.hpp:236
nvsipl::sensorconfig::CommonSensorConfig::name
std::string name
Holds the name of the sensor, for example, "AR0231".
Definition: NvSIPLCameraTypes.hpp:284
nvsipl::sensorconfig::CommonSensorConfig::Resolution
Defines the image resolution.
Definition: NvSIPLCameraTypes.hpp:103
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_ACB
@ POLARITY_ACB
A-C-B polarity configuration for CPHY, swap polarity for DPHY.
nvsipl::sensorconfig::GmslLinkMode::LINK_MODE_GMSL3
@ LINK_MODE_GMSL3
GMSL version 3.
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_CAB
@ POLARITY_CAB
C-A-B polarity configuration for CPHY.
nvsipl::sensorconfig::GmslPowerControlConfig::ModuleInfo::address
I2CAddressInfo address
I2C address information for the module power control device.
Definition: NvSIPLCameraTypes.hpp:471
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_BCA
@ POLARITY_BCA
B-C-A polarity configuration for CPHY.
nvsipl::sensorconfig::ModuleConfig::transportId
uint32_t transportId
ID of the transport that this module is connected to.
Definition: NvSIPLCameraTypes.hpp:787
nvsipl::sensorconfig::GmslModule::eepromConfigs
std::vector< EEPROMConfig > eepromConfigs
EEPROM configurations for this module.
Definition: NvSIPLCameraTypes.hpp:552
nvsipl::sensorconfig::SerializerConfig::errGpios
std::vector< InterruptGpioInfo > errGpios
Holds Interrupt GPIO configurations for the serializer.
Definition: NvSIPLCameraTypes.hpp:367
nvsipl::sensorconfig::MipiSettings::dphyRate
uint32_t dphyRate
D-PHY clock rate in kbps.
Definition: NvSIPLCameraTypes.hpp:760
nvsipl::sensorconfig
Definition: NvSIPLCameraTypes.hpp:28
nvsipl::sensorconfig::GmslLinkMode::LINK_MODE_GMSL2_6GBPS
@ LINK_MODE_GMSL2_6GBPS
GMSL version 2, 6GBPS mode.
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::embeddedDataOffset
uint32_t embeddedDataOffset
Holds the byte offset from the buffer start to the first active pixel.
Definition: NvSIPLCameraTypes.hpp:265
nvsipl::sensorconfig::CoETransportConfig::ipAddress
uint32_t ipAddress
IP address of the HSB.
Definition: NvSIPLCameraTypes.hpp:440
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_A0B1B0A1
@ LANE_SWIZZLE_A0B1B0A1
Lane swizzle pattern A0B1B0A1.
nvsipl::sensorconfig::GmslModule::sensorConfigs
std::vector< GmslSensorConfig > sensorConfigs
Sensor configurations for this module.
Definition: NvSIPLCameraTypes.hpp:555
nvsipl::sensorconfig::SensorSystemConfig::transports
std::vector< TransportConfig > transports
Transport configurations.
Definition: NvSIPLCameraTypes.hpp:830
nvsipl::sensorconfig::SerializerConfig::serdesGPIOPinMappings
std::vector< SerdesGPIOPinMap > serdesGPIOPinMappings
Holds the information about GPIO mapping from the serializer to the deserializer.
Definition: NvSIPLCameraTypes.hpp:370
nvsipl::sensorconfig::MipiSettings::tHsSettle
uint8_t tHsSettle
THS settle time of the MIPI lane, in nanoseconds.
Definition: NvSIPLCameraTypes.hpp:707
nvsipl::sensorconfig::SensorSystemConfig
Combined structure describing module configurations and transport configurations.
Definition: NvSIPLCameraTypes.hpp:824
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::vcIdSrc
uint32_t vcIdSrc
Holds the source virtual channel id.
Definition: NvSIPLCameraTypes.hpp:165
nvsipl::sensorconfig::CoETransportConfig::syncSensors
bool syncSensors
Whether multiple sensors on this HSB should be synchronized.
Definition: NvSIPLCameraTypes.hpp:452
nvsipl::sensorconfig::ModuleConfig::operator=
ModuleConfig & operator=(ModuleConfig const &) &=default
nvsipl::sensorconfig::GmslModule
Definition: NvSIPLCameraTypes.hpp:534
nvsipl::sensorconfig::GmslTransportConfig::csiPort
NvSiplCapInterfaceType csiPort
CSI port connected to this deserializer.
Definition: NvSIPLCameraTypes.hpp:593
nvsipl::sensorconfig::GmslDeserializerConfig::GmslDeserializerConfig
GmslDeserializerConfig()=default
Default constructor.
nvsipl::sensorconfig::MacAddress
std::array< uint8_t, 6 > MacAddress
Definition: NvSIPLCameraTypes.hpp:30
nvsipl::sensorconfig::CommonSensorConfig::UserDataTypeCaptureConfig::inputFormat
NvSiplCapInputFormatType inputFormat
Holds the input format.
Definition: NvSIPLCameraTypes.hpp:143
nvsipl::sensorconfig::MipiSettings::lpBypassMode
bool lpBypassMode
LP bypass mode.
Definition: NvSIPLCameraTypes.hpp:680
nvsipl::sensorconfig::GmslLinkMode::LINK_MODE_GMSL2_3GBPS
@ LINK_MODE_GMSL2_3GBPS
GMSL version 2, 3GBPS mode.
nvsipl::sensorconfig::CoECameraSensorConfig::ipAddress
uint32_t ipAddress
Optional IP address for this sensor's data path.
Definition: NvSIPLCameraTypes.hpp:394
NvSiplBitsPerPixel
NvSiplBitsPerPixel
Specifies bits per pixel.
Definition: NvSIPLCapStructs.h:147
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::embeddedBottomLines
uint32_t embeddedBottomLines
Holds the number of bottom embedded lines.
Definition: NvSIPLCameraTypes.hpp:204
nvsipl::sensorconfig::GmslTransportConfig::i2cDevice
uint32_t i2cDevice
I2C device bus number.
Definition: NvSIPLCameraTypes.hpp:602
nvsipl::sensorconfig::EEPROMConfig::address
I2CAddressInfo address
Holds I2C address information for the EEPROM.
Definition: NvSIPLCameraTypes.hpp:345
NVSIPL_CAP_INPUT_FORMAT_TYPE_USER_DEFINED_8
@ NVSIPL_CAP_INPUT_FORMAT_TYPE_USER_DEFINED_8
Specifies User defined 8 (0x37).
Definition: NvSIPLCapStructs.h:133
nvsipl::sensorconfig::GmslCameraSensorConfig
Definition: NvSIPLCameraTypes.hpp:521
nvsipl::sensorconfig::I2CAddressInfo::i2cAddress
Address i2cAddress
Native I2C address of the device.
Definition: NvSIPLCameraTypes.hpp:86
nvsipl::sensorconfig::CommonSensorConfig
Common information for all sensors.
Definition: NvSIPLCameraTypes.hpp:100
nvsipl::sensorconfig::SensorSystemConfig::modules
std::vector< ModuleConfig > modules
Module configurations.
Definition: NvSIPLCameraTypes.hpp:827
nvsipl::sensorconfig::CoETransportConfig::interfaceName
std::string interfaceName
Ethernet interface name on the host.
Definition: NvSIPLCameraTypes.hpp:435
nvsipl::sensorconfig::EEPROMConfig
Defines the EEPROM information.
Definition: NvSIPLCameraTypes.hpp:332
nvsipl::sensorconfig::MipiSettings
MIPI configuration parameters for camera connections.
Definition: NvSIPLCameraTypes.hpp:668
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::inputFormat
NvSiplCapInputFormatType inputFormat
Holds the input format.
Definition: NvSIPLCameraTypes.hpp:213
nvsipl::sensorconfig::GmslModule::linkIndex
uint32_t linkIndex
Deserializer link index for this module.
Definition: NvSIPLCameraTypes.hpp:537
nvsipl::sensorconfig::GmslLinkMode
GmslLinkMode
Defines GMSL link mode options for deserializer-serializer connections.
Definition: NvSIPLCameraTypes.hpp:503
nvsipl::sensorconfig::InterruptGpioInfo
Describes an Interrupt GPIO configuration.
Definition: NvSIPLCameraTypes.hpp:35
nvsipl::sensorconfig::CoETransportConfig
Settings for the HSB (Holoscan Sensor Bridge).
Definition: NvSIPLCameraTypes.hpp:432
nvsipl::sensorconfig::GmslPowerControlConfig::moduleInfo
struct nvsipl::sensorconfig::GmslPowerControlConfig::ModuleInfo moduleInfo
nvsipl::sensorconfig::CommonSensorConfig::operator=
CommonSensorConfig & operator=(CommonSensorConfig const &) &=default
nvsipl::sensorconfig::GmslFsyncMode::FSYNC_INVALID
@ FSYNC_INVALID
Invalid FSYNC mode.
nvsipl::sensorconfig::GmslTransportConfig::isPassiveModeEnabled
bool isPassiveModeEnabled
Whether passive mode is enabled.
Definition: NvSIPLCameraTypes.hpp:614
nvsipl::sensorconfig::MipiSettings::lanePolarity
std::array< NvSiplMipiPolarity, 4 > lanePolarity
Lane polarity configuration for each lane/trio.
Definition: NvSIPLCameraTypes.hpp:729
nvsipl::sensorconfig::CoECameraSensorConfig::operator=
CoECameraSensorConfig & operator=(CoECameraSensorConfig const &) &=default
nvsipl::sensorconfig::GmslTransportConfig::ReplicationEntry
PHY replication entry for CSI data cloning between TX ports.
Definition: NvSIPLCameraTypes.hpp:622
nvsipl::sensorconfig::GmslDeserializerConfig::address
I2CAddressInfo address
I2C address information for the deserializer.
Definition: NvSIPLCameraTypes.hpp:566
nvsipl::sensorconfig::GmslPowerControlConfig::deserializerInfo
struct nvsipl::sensorconfig::GmslPowerControlConfig::DeserializerInfo deserializerInfo
nvsipl::sensorconfig::MipiSettings::phyMode
NvSiplCapCsiPhyMode phyMode
PHY mode (D-PHY or C-PHY).
Definition: NvSIPLCameraTypes.hpp:772
nvsipl::sensorconfig::SerializerConfig
Defines the serializer information.
Definition: NvSIPLCameraTypes.hpp:351
nvsipl::sensorconfig::SerdesGPIOPinMap::destGpio
uint8_t destGpio
The destination multifunction pin (MFP) number on the deserializer.
Definition: NvSIPLCameraTypes.hpp:70
nvsipl::sensorconfig::GmslTransportConfig
Definition: NvSIPLCameraTypes.hpp:590
nvsipl::sensorconfig::ModuleConfig::moduleType
ModuleType moduleType
Module type configuration.
Definition: NvSIPLCameraTypes.hpp:790
nvsipl::sensorconfig::GmslTransportConfig::powerPort
uint32_t powerPort
Power port number.
Definition: NvSIPLCameraTypes.hpp:611
nvsipl::sensorconfig::GmslTransportConfig::ReplicationEntry::srcPhy
uint32_t srcPhy
Source PHY index.
Definition: NvSIPLCameraTypes.hpp:623
nvsipl::sensorconfig::SerdesGPIOPinMap::sourceGpio
uint8_t sourceGpio
The source multifunction pin (MFP) number on the serializer.
Definition: NvSIPLCameraTypes.hpp:65
nvsipl::sensorconfig::GmslPowerControlConfig::DeserializerInfo::name
std::string name
Name of the deserializer power control device.
Definition: NvSIPLCameraTypes.hpp:482
nvsipl::sensorconfig::CoEModule::isSimulatorModeEnabled
bool isSimulatorModeEnabled
Whether simulator mode is enabled for this module.
Definition: NvSIPLCameraTypes.hpp:424
nvsipl::sensorconfig::CommonSensorConfig::UserDataTypeCaptureConfig
Defines the user defined datatype capture configuration.
Definition: NvSIPLCameraTypes.hpp:125
nvsipl::sensorconfig::I2CAddressInfo::Address
uint16_t Address
Definition: NvSIPLCameraTypes.hpp:78
nvsipl::sensorconfig::SerdesGPIOPinMap
Defines GPIO mapping from the serializer to the deserializer.
Definition: NvSIPLCameraTypes.hpp:60
nvsipl::sensorconfig::ModuleConfig::platform
std::string platform
Platform name this module is associated with (e.g., "ferrix", "kenari").
Definition: NvSIPLCameraTypes.hpp:796
NvSiplCapInterfaceType
NvSiplCapInterfaceType
Specifies the capture interface type for the CSI interface.
Definition: NvSIPLCapStructs.h:35
nvsipl::sensorconfig::SensorSystemConfig::operator=
SensorSystemConfig & operator=(SensorSystemConfig const &) &=default
nvsipl::sensorconfig::CoETransportConfig::operator=
CoETransportConfig & operator=(CoETransportConfig const &) &=default
nvsipl::sensorconfig::GmslTransportConfig::replicationInfo
std::vector< ReplicationEntry > replicationInfo
Optional PHY replication pairs (max 2)
Definition: NvSIPLCameraTypes.hpp:626
nvsipl::sensorconfig::CoECameraSensorConfig::macAddress
MacAddress macAddress
MAC address of the sensor.
Definition: NvSIPLCameraTypes.hpp:385
NvSiplCapCsiPhyMode
NvSiplCapCsiPhyMode
Specifies the CSI PHY mode.
Definition: NvSIPLCapStructs.h:167
nvsipl::sensorconfig::InterruptGpioInfo::enableGetStatus
bool enableGetStatus
Whether to enable driver error localization upon interrupt.
Definition: NvSIPLCameraTypes.hpp:47
nvsipl::sensorconfig::CommonSensorConfig::deviceIndex
uint8_t deviceIndex
Device index of this sensor.
Definition: NvSIPLCameraTypes.hpp:326
NvSIPLCapStructs.h
nvsipl::sensorconfig::CommonSensorConfig::isTriggerModeEnabled
bool isTriggerModeEnabled
Holds a flag which indicates whether trigger mode is enabled.
Definition: NvSIPLCameraTypes.hpp:300
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::resolution
Resolution resolution
Holds the Resolution of the captured frame.
Definition: NvSIPLCameraTypes.hpp:218
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_A0A1B0B1
@ LANE_SWIZZLE_A0A1B0B1
Lane swizzle pattern A0A1B0B1 (default)
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_A0B1A1B0
@ LANE_SWIZZLE_A0B1A1B0
Lane swizzle pattern A0B1A1B0.
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_BAC
@ POLARITY_BAC
B-A-C polarity configuration for CPHY.
nvsipl::sensorconfig::I2CAddressInfo::virtualI2CAddress
std::optional< Address > virtualI2CAddress
Requested virtual I2C address of the device.
Definition: NvSIPLCameraTypes.hpp:94
nvsipl::sensorconfig::TransportConfig::transportType
TransportType transportType
Transport type configuration.
Definition: NvSIPLCameraTypes.hpp:816
nvsipl::sensorconfig::ModuleType
std::variant< CoEModule, GmslModule > ModuleType
Definition: NvSIPLCameraTypes.hpp:775
nvsipl::sensorconfig::MipiSettings::laneSwizzle
NvSiplMipiSwizzle laneSwizzle
Lane swizzle pattern.
Definition: NvSIPLCameraTypes.hpp:753
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::fps
float_t fps
Holds the average number of frames per second.
Definition: NvSIPLCameraTypes.hpp:227
nvsipl::sensorconfig::InterruptGpioInfo::timeout
std::chrono::milliseconds timeout
Error localization timeout duration.
Definition: NvSIPLCameraTypes.hpp:54
nvsipl::sensorconfig::GmslLinkMode::LINK_MODE_NONE
@ LINK_MODE_NONE
No link mode (e.g., TPG mode)
nvsipl::sensorconfig::CommonSensorConfig::description
std::string description
Holds the description of the sensor.
Definition: NvSIPLCameraTypes.hpp:287
nvsipl::sensorconfig::CommonSensorConfig::errGpios
std::vector< InterruptGpioInfo > errGpios
Holds Interrupt GPIO configurations for the sensor.
Definition: NvSIPLCameraTypes.hpp:303
nvsipl::sensorconfig::CoEModule::operator=
CoEModule & operator=(CoEModule const &) &=default
nvsipl::sensorconfig::CommonSensorConfig::UserDataTypeCaptureConfig::bitsPerPixel
NvSiplBitsPerPixel bitsPerPixel
Holds the bits per pixel.
Definition: NvSIPLCameraTypes.hpp:150
nvsipl::sensorconfig::GmslDeserializerConfig
Definition: NvSIPLCameraTypes.hpp:560
nvsipl::sensorconfig::GmslSensorConfig
std::variant< GmslCameraSensorConfig > GmslSensorConfig
Variant type for all GMSL sensor types.
Definition: NvSIPLCameraTypes.hpp:532
nvsipl::sensorconfig::EEPROMConfig::operator=
EEPROMConfig & operator=(EEPROMConfig const &) &=default
nvsipl::sensorconfig::GmslModule::linkMode
GmslLinkMode linkMode
GMSL link mode for serializer communication.
Definition: NvSIPLCameraTypes.hpp:543
nvsipl::sensorconfig::GmslPowerControlConfig::DeserializerInfo
Deserializer power control configuration.
Definition: NvSIPLCameraTypes.hpp:479
nvsipl::sensorconfig::ModuleConfig::description
std::string description
Description of the module.
Definition: NvSIPLCameraTypes.hpp:784
nvsipl::sensorconfig::SerializerConfig::operator=
SerializerConfig & operator=(SerializerConfig const &) &=default
nvsipl::sensorconfig::GmslPowerControlConfig::DeserializerInfo::gpioPinIndex
std::optional< uint32_t > gpioPinIndex
GPIO pin index for direct GPIO power control (optional).
Definition: NvSIPLCameraTypes.hpp:489
nvsipl::sensorconfig::EEPROMConfig::name
std::string name
Holds the name of the EEPROM, for example, "N24C64".
Definition: NvSIPLCameraTypes.hpp:335
nvsipl::sensorconfig::GmslPowerControlConfig::operator=
GmslPowerControlConfig & operator=(GmslPowerControlConfig const &) &=default
nvsipl::sensorconfig::SerializerConfig::name
std::string name
Holds the name of the serializer, for example, "MAX96705".
Definition: NvSIPLCameraTypes.hpp:354
nvsipl::sensorconfig::GmslLinkMode::LINK_MODE_GMSL1
@ LINK_MODE_GMSL1
GMSL version 1.
nvsipl::sensorconfig::GmslCameraSensorConfig::operator=
GmslCameraSensorConfig & operator=(GmslCameraSensorConfig const &) &=default
nvsipl::sensorconfig::GmslPowerControlConfig::ModuleInfo
Module power control configuration.
Definition: NvSIPLCameraTypes.hpp:465
nvsipl::sensorconfig::CommonSensorConfig::numContext
uint16_t numContext
Holds the number of capture contexts a sensor supports.
Definition: NvSIPLCameraTypes.hpp:310
nvsipl::sensorconfig::InterruptGpioInfo::idx
uint32_t idx
The interrupt GPIO index.
Definition: NvSIPLCameraTypes.hpp:42
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::userDataTypeCapture
std::optional< UserDataTypeCaptureConfig > userDataTypeCapture
Optional user defined datatype capture configuration.
Definition: NvSIPLCameraTypes.hpp:273
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::cfa
uint32_t cfa
Holds the Bayer color filter array order of the sensor.
Definition: NvSIPLCameraTypes.hpp:186
nvsipl::sensorconfig::MipiSettings::mipiClockRate
uint32_t mipiClockRate
MIPI clock rate for D-Phy.
Definition: NvSIPLCameraTypes.hpp:695
nvsipl::sensorconfig::GmslFsyncMode::FSYNC_OSC_MANUAL
@ FSYNC_OSC_MANUAL
Oscillator Manual (internal)
nvsipl::sensorconfig::CoEModule
Settings for a camera module connected to an HSB.
Definition: NvSIPLCameraTypes.hpp:410
nvsipl::sensorconfig::NvSiplMipiPolarity
NvSiplMipiPolarity
Enum for MIPI lane polarity options.
Definition: NvSIPLCameraTypes.hpp:640
nvsipl::sensorconfig::CoECameraSensorConfig
Settings for an individual sensor within a camera module.
Definition: NvSIPLCameraTypes.hpp:378
nvsipl::sensorconfig::GmslFsyncMode::FSYNC_EXTERNAL
@ FSYNC_EXTERNAL
External FSYNC from Tegra.
nvsipl::sensorconfig::GmslTransportConfig::deserializerConfig
GmslDeserializerConfig deserializerConfig
Deserializer configuration.
Definition: NvSIPLCameraTypes.hpp:596
nvsipl::sensorconfig::GmslPowerControlConfig::DeserializerInfo::address
I2CAddressInfo address
I2C address information for the deserializer power control device.
Definition: NvSIPLCameraTypes.hpp:492
nvsipl::sensorconfig::GmslFsyncMode
GmslFsyncMode
Defines GMSL frame sync mode options for deserializer.
Definition: NvSIPLCameraTypes.hpp:515
NvSiplCapInputFormatType
NvSiplCapInputFormatType
Specifies the capture input format type.
Definition: NvSIPLCapStructs.h:92
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_MAX
@ POLARITY_MAX
Max enum value (used for bounds checking)
nvsipl::sensorconfig::MipiSettings::tClkSettle
uint8_t tClkSettle
MIPI TCLK-SETTLE timing.
Definition: NvSIPLCameraTypes.hpp:687
nvsipl::sensorconfig::I2CAddressInfo::INVALID
static constexpr Address INVALID
Definition: NvSIPLCameraTypes.hpp:79
nvsipl::sensorconfig::GmslModule::operator=
GmslModule & operator=(GmslModule const &) &=default
nvsipl::sensorconfig::GmslDeserializerConfig::~GmslDeserializerConfig
~GmslDeserializerConfig()=default
Destructor.
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::embeddedTopLines
uint32_t embeddedTopLines
Holds the number of top embedded lines.
Definition: NvSIPLCameraTypes.hpp:195
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_A0B0B1A1
@ LANE_SWIZZLE_A0B0B1A1
Lane swizzle pattern A0B0B1A1.
nvsipl::sensorconfig::GmslModule::isSimulatorModeEnabled
bool isSimulatorModeEnabled
Whether simulator mode is enabled for this module.
Definition: NvSIPLCameraTypes.hpp:540
nvsipl::sensorconfig::CoEModule::sensorConfigs
std::vector< CoESensorConfig > sensorConfigs
Configuration for each sensor in this camera module.
Definition: NvSIPLCameraTypes.hpp:415
nvsipl::sensorconfig::ModuleConfig::name
std::string name
Name of the module.
Definition: NvSIPLCameraTypes.hpp:781
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_ABC
@ POLARITY_ABC
Default polarity configuration (A-B-C for CPHY, no swap for DPHY)
nvsipl::sensorconfig::ModuleConfig::platformConfig
std::string platformConfig
Platform configuration identifier.
Definition: NvSIPLCameraTypes.hpp:799
nvsipl::sensorconfig::GmslPowerControlConfig::ModuleInfo::operator=
ModuleInfo & operator=(ModuleInfo const &) &=default
nvsipl::sensorconfig::GmslLinkMode::LINK_MODE_GMSL3_GMSL2
@ LINK_MODE_GMSL3_GMSL2
GMSL3 in deserializer, GMSL2 in serializer.
nvsipl::sensorconfig::GmslPowerControlConfig::ModuleInfo::name
std::string name
Name of the module power control device.
Definition: NvSIPLCameraTypes.hpp:468
nvsipl::sensorconfig::EEPROMConfig::description
std::string description
Holds the description of the EEPROM.
Definition: NvSIPLCameraTypes.hpp:339
nvsipl::sensorconfig::GmslModule::fsyncMode
GmslFsyncMode fsyncMode
Frame sync mode for this module.
Definition: NvSIPLCameraTypes.hpp:546
nvsipl::sensorconfig::GmslTransportConfig::ReplicationEntry::dstPhy
uint32_t dstPhy
Destination PHY index.
Definition: NvSIPLCameraTypes.hpp:624
NVSIPL_CAP_INPUT_FORMAT_TYPE_RAW12
@ NVSIPL_CAP_INPUT_FORMAT_TYPE_RAW12
Specifies RAW 12.
Definition: NvSIPLCapStructs.h:111
nvsipl::sensorconfig::TransportType
std::variant< CoETransportConfig, GmslTransportConfig > TransportType
Definition: NvSIPLCameraTypes.hpp:776
nvsipl::sensorconfig::GmslPowerControlConfig
Defines GMSL power control information for both module and deserializer power management.
Definition: NvSIPLCameraTypes.hpp:460
nvsipl::sensorconfig::CoETransportConfig::vlanEnable
bool vlanEnable
Flag indicating if VLAN tagging is enabled.
Definition: NvSIPLCameraTypes.hpp:447
nvsipl::sensorconfig::TransportConfig
Definition: NvSIPLCameraTypes.hpp:804
NVSIPL_BITS_PER_PIXEL_8
@ NVSIPL_BITS_PER_PIXEL_8
Specifies 8 bits per pixel.
Definition: NvSIPLCapStructs.h:149
nvsipl::sensorconfig::NvSiplMipiPolarity::POLARITY_CBA
@ POLARITY_CBA
C-B-A polarity configuration for CPHY.
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_A0B0A1B1
@ LANE_SWIZZLE_A0B0A1B1
Lane swizzle pattern A0B0A1B1.
nvsipl::sensorconfig::GmslDeserializerConfig::operator=
GmslDeserializerConfig & operator=(GmslDeserializerConfig const &) &=default
Copy assignment operator.
nvsipl::sensorconfig::CommonSensorConfig::vcInfoList
std::vector< VirtualChannelInfo > vcInfoList
Holds information on all virtual channels per sensor.
Definition: NvSIPLCameraTypes.hpp:295
nvsipl::sensorconfig::MipiSettings::lanes
uint8_t lanes
Number of data lanes used.
Definition: NvSIPLCameraTypes.hpp:675
nvsipl::sensorconfig::GmslPowerControlConfig::DeserializerInfo::operator=
DeserializerInfo & operator=(DeserializerInfo const &) &=default
nvsipl::sensorconfig::I2CAddressInfo
Information about the I2C address of a device.
Definition: NvSIPLCameraTypes.hpp:76
nvsipl::sensorconfig::TransportConfig::description
std::string description
Description of the transport.
Definition: NvSIPLCameraTypes.hpp:810
nvsipl::sensorconfig::GmslTransportConfig::powerControlConfig
GmslPowerControlConfig powerControlConfig
Power control configuration.
Definition: NvSIPLCameraTypes.hpp:599
nvsipl::sensorconfig::SerializerConfig::address
I2CAddressInfo address
Holds I2C address information for the serializer.
Definition: NvSIPLCameraTypes.hpp:364
nvsipl::sensorconfig::GmslTransportConfig::deserializerTxPort
uint32_t deserializerTxPort
Deserializer Tx port number.
Definition: NvSIPLCameraTypes.hpp:608
nvsipl::sensorconfig::SerializerConfig::description
std::string description
Holds the description of the serializer.
Definition: NvSIPLCameraTypes.hpp:358
nvsipl::sensorconfig::GmslDeserializerConfig::errGpios
std::vector< InterruptGpioInfo > errGpios
Interrupt GPIO configurations for the deserializer.
Definition: NvSIPLCameraTypes.hpp:569
nvsipl::sensorconfig::ModuleConfig
Definition: NvSIPLCameraTypes.hpp:778
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_MAX
@ LANE_SWIZZLE_MAX
Max enum value (used for bounds checking)
nvsipl::sensorconfig::GmslTransportConfig::deserializerI2CPort
uint32_t deserializerI2CPort
Deserializer I2C port number.
Definition: NvSIPLCameraTypes.hpp:605
nvsipl::sensorconfig::GmslTransportConfig::operator=
GmslTransportConfig & operator=(GmslTransportConfig const &) &=default
nvsipl::sensorconfig::CommonSensorConfig::address
I2CAddressInfo address
Holds I2C address information for the sensor.
Definition: NvSIPLCameraTypes.hpp:292
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo
Defines the information of a virtual channel/single exposure.
Definition: NvSIPLCameraTypes.hpp:156
nvsipl::sensorconfig::GmslDeserializerConfig::name
std::string name
Name of the deserializer driver (e.g., "Max96724GmslDeserializer").
Definition: NvSIPLCameraTypes.hpp:563
nvsipl::sensorconfig::NvSiplMipiSwizzle::LANE_SWIZZLE_A0A1B1B0
@ LANE_SWIZZLE_A0A1B1B0
Lane swizzle pattern A0A1B1B0.
nvsipl::sensorconfig::NvSiplMipiSwizzle
NvSiplMipiSwizzle
Enum for MIPI lane swizzle patterns.
Definition: NvSIPLCameraTypes.hpp:654
nvsipl::sensorconfig::CommonSensorConfig::VirtualChannelInfo::vcIdDst
uint32_t vcIdDst
Holds the destination virtual channel id.
Definition: NvSIPLCameraTypes.hpp:174
nvsipl::sensorconfig::CommonSensorConfig::Resolution::width
uint32_t width
Holds the width in pixels.
Definition: NvSIPLCameraTypes.hpp:112
nvsipl::sensorconfig::GmslTransportConfig::bootAcceleratorUseStaggeredStart
bool bootAcceleratorUseStaggeredStart
Whether to use staggered start with boot accelerator.
Definition: NvSIPLCameraTypes.hpp:632
nvsipl::sensorconfig::ModuleConfig::mipiSettings
MipiSettings mipiSettings
MIPI settings for this module.
Definition: NvSIPLCameraTypes.hpp:793
nvsipl::sensorconfig::CommonSensorConfig::Resolution::height
uint32_t height
Holds the height in pixels.
Definition: NvSIPLCameraTypes.hpp:121
NVSIPL_CAP_CSI_DPHY_MODE
@ NVSIPL_CAP_CSI_DPHY_MODE
Specifies that CSI is in DPHY mode.
Definition: NvSIPLCapStructs.h:169
nvsipl::sensorconfig::CommonSensorConfig::sensorGroup
uint32_t sensorGroup
Sensors with the same sensorGroup are grouped into one logical camera.
Definition: NvSIPLCameraTypes.hpp:317
nvsipl::sensorconfig::CommonSensorConfig::UserDataTypeCaptureConfig::lines
uint32_t lines
Holds the number of lines of the user defined datatype.
Definition: NvSIPLCameraTypes.hpp:134
nvsipl::sensorconfig::GmslTransportConfig::bootAcceleratorTag
std::string bootAcceleratorTag
Boot accelerator tag.
Definition: NvSIPLCameraTypes.hpp:629
nvsipl::sensorconfig::TransportConfig::transportId
uint32_t transportId
Unique ID for this transport.
Definition: NvSIPLCameraTypes.hpp:813
nvsipl::sensorconfig::GmslModule::serializerConfig
SerializerConfig serializerConfig
Serializer configuration for this module.
Definition: NvSIPLCameraTypes.hpp:549
nvsipl::sensorconfig::CoESensorConfig
std::variant< CoECameraSensorConfig > CoESensorConfig
Variant type for all CoE sensor types.
Definition: NvSIPLCameraTypes.hpp:405