Jetson Linux API Reference

39.2 Release
NvSIPLQuery.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2019-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 #ifndef NVSIPLQUERY_HPP
13 #define NVSIPLQUERY_HPP
14 
15 #include "NvSIPLCommon.hpp"
16 #include "NvSIPLPlatformCfg.hpp"
17 
18 #include <string>
19 #include <cstdint>
20 #include <memory>
21 #include <vector>
22 
30 namespace nvsipl
31 {
32 
36 {
38  std::vector<SensorInfo> sensorInfoList;
40  std::vector<EEPROMInfo> eepromInfoList;
42  std::vector<SerInfo> serInfoList;
44  std::vector<CameraModuleInfo> cameraModuleList;
46  std::vector<DeserInfo> deserInfoList;
47 };
48 
69 {
70 public:
71 
72  static constexpr uint32_t MAJOR_VER = 1u;
73  static constexpr uint32_t MINOR_VER = 0u;
74  static constexpr uint32_t PATCH_VER = 0u;
82  struct Version
83  {
84  uint32_t uMajor = MAJOR_VER;
85  uint32_t uMinor = MINOR_VER;
86  uint32_t uPatch = PATCH_VER;
87  };
88 
113  static void GetVersion(Version& version);
114 
143  static std::unique_ptr <INvSIPLQuery> GetInstance(void);
144 
170  virtual SIPLStatus ParseDatabase(void) = 0;
171 
201  virtual SIPLStatus ParseJsonFile(std::string fileName) = 0;
202 
227  const virtual DeviceInfoList* GetDeviceInfoList() const = 0;
228 
253  virtual std::vector <const PlatformCfg*> GetPlatformCfgList() const = 0;
254 
278  virtual SIPLStatus GetPlatformCfg(std::string name,
279  PlatformCfg& oConfig) const = 0;
280 
288  {
289  LINK_0 = 0x0001,
290  LINK_1 = 0x0010,
291  LINK_2 = 0x0100,
292  LINK_3 = 0x1000
293  };
294 
325  virtual SIPLStatus ApplyMask(PlatformCfg& platCfg,
326  const std::vector <uint32_t>& vMasks) const = 0;
327 
329  virtual ~INvSIPLQuery() = default;
330 
331 }; //INvSIPLQuery
332 
335 }// namespace nvsipl
336 
337 
338 
339 #endif //NVSIPLQUERY_HPP
nvsipl::INvSIPLQuery::GetPlatformCfg
virtual SIPLStatus GetPlatformCfg(std::string name, PlatformCfg &oConfig) const =0
Returns a PlatformCfg object by name.
nvsipl::DeviceInfoList::sensorInfoList
std::vector< SensorInfo > sensorInfoList
Holds a vector of SensorInfo objects.
Definition: NvSIPLQuery.hpp:38
nvsipl::INvSIPLQuery
Defines the public data structures and describes the interfaces for NvSIPLQuery.
Definition: NvSIPLQuery.hpp:68
nvsipl::INvSIPLQuery::GetInstance
static std::unique_ptr< INvSIPLQuery > GetInstance(void)
Gets a handle to an instance of INvSIPLQuery.
nvsipl::INvSIPLQuery::GetDeviceInfoList
const virtual DeviceInfoList * GetDeviceInfoList() const =0
Returns a pointer to the list of all external image devices supported by NvSIPL Query and SIPL Device...
nvsipl::INvSIPLQuery::Version
Defines the version information for NvSIPLQuery_API.
Definition: NvSIPLQuery.hpp:82
NvSIPLCommon.hpp
NVIDIA SIPL: Common Data Structures - SIPL
NvSIPLPlatformCfg.hpp
NVIDIA SIPL: Camera Platform Configuration
nvsipl::INvSIPLQuery::EnableMask
EnableMask
Defines link enable masks for deserializers.
Definition: NvSIPLQuery.hpp:287
nvsipl::INvSIPLQuery::Version::uMinor
uint32_t uMinor
Holds a minor revision.
Definition: NvSIPLQuery.hpp:85
nvsipl::INvSIPLQuery::Version::uPatch
uint32_t uPatch
Holds a patch revision.
Definition: NvSIPLQuery.hpp:86
nvsipl::INvSIPLQuery::MAJOR_VER
static constexpr uint32_t MAJOR_VER
Indicates a major revision.
Definition: NvSIPLQuery.hpp:72
nvsipl::INvSIPLQuery::MINOR_VER
static constexpr uint32_t MINOR_VER
Indicates a minor revision.
Definition: NvSIPLQuery.hpp:73
nvsipl::SIPLStatus
SIPLStatus
Defines the status codes returned by functions in SIPL modules.
Definition: NvSIPLCommon.hpp:153
nvsipl::PlatformCfg
Defines the camera platform configuration.
Definition: NvSIPLPlatformCfg.hpp:39
nvsipl::DeviceInfoList::deserInfoList
std::vector< DeserInfo > deserInfoList
Holds a vector of DeserInfo objects.
Definition: NvSIPLQuery.hpp:46
nvsipl::INvSIPLQuery::LINK_1
@ LINK_1
2nd Link
Definition: NvSIPLQuery.hpp:290
nvsipl::INvSIPLQuery::GetVersion
static void GetVersion(Version &version)
Returns the library version.
nvsipl::INvSIPLQuery::ParseDatabase
virtual SIPLStatus ParseDatabase(void)=0
Parses the built-in JSON database and updates the internal state of the implementation class.
nvsipl::DeviceInfoList::eepromInfoList
std::vector< EEPROMInfo > eepromInfoList
Holds a vector of EEPROMInfo objects.
Definition: NvSIPLQuery.hpp:40
nvsipl::INvSIPLQuery::ParseJsonFile
virtual SIPLStatus ParseJsonFile(std::string fileName)=0
Parses the input JSON file containing a list of user-specified camera platform configuration.
nvsipl::DeviceInfoList::serInfoList
std::vector< SerInfo > serInfoList
Holds a vector of SerInfo objects.
Definition: NvSIPLQuery.hpp:42
nvsipl::INvSIPLQuery::ApplyMask
virtual SIPLStatus ApplyMask(PlatformCfg &platCfg, const std::vector< uint32_t > &vMasks) const =0
Applies masks to the input platform configuration.
nvsipl::DeviceInfoList
Defines a list of all external image devices supported by NvSIPL Query and SIPL Device Block drivers.
Definition: NvSIPLQuery.hpp:35
nvsipl::INvSIPLQuery::PATCH_VER
static constexpr uint32_t PATCH_VER
Indicates a patch revision.
Definition: NvSIPLQuery.hpp:74
nvsipl::INvSIPLQuery::GetPlatformCfgList
virtual std::vector< const PlatformCfg * > GetPlatformCfgList() const =0
Returns a list of camera platform configurations supported by NvSIPL Query and NvSIPL Camera.
nvsipl::INvSIPLQuery::LINK_2
@ LINK_2
3rd Link
Definition: NvSIPLQuery.hpp:291
nvsipl::DeviceInfoList::cameraModuleList
std::vector< CameraModuleInfo > cameraModuleList
Holds a vector of CameraModuleInfo objects.
Definition: NvSIPLQuery.hpp:44
nvsipl::INvSIPLQuery::Version::uMajor
uint32_t uMajor
Holds a major revision.
Definition: NvSIPLQuery.hpp:84
nvsipl
Contains the classes and variables for implementation of SIPL.
Definition: NvSIPLCameraQuery.hpp:22
nvsipl::INvSIPLQuery::LINK_0
@ LINK_0
1st Link
Definition: NvSIPLQuery.hpp:289
nvsipl::INvSIPLQuery::LINK_3
@ LINK_3
4th Link
Definition: NvSIPLQuery.hpp:292
nvsipl::INvSIPLQuery::~INvSIPLQuery
virtual ~INvSIPLQuery()=default
Default destructor.