Jetson Linux API Reference

39.2 Release
nvsipl Namespace Reference

Detailed Description

Contains the classes and variables for implementation of SIPL.

Namespaces

 sensorconfig
 

Data Structures

struct  CameraDeviceInfoList
 Defines a list of all external image devices supported by SIPL. More...
 
struct  CameraModuleInfo
 Defines information for the camera module. More...
 
class  CryptoKeyInfo
 Describes a single globally-visible crypto key object. More...
 
struct  DeserInfo
 Defines the deserializer information. More...
 
struct  DeviceBlockInfo
 Defines the DeviceBlock information. More...
 
struct  DeviceInfoList
 Defines a list of all external image devices supported by NvSIPL Query and SIPL Device Block drivers. More...
 
struct  EEPROMInfo
 Defines the EEPROM information. More...
 
class  IInterfaceProvider
 Class providing access to device interfaces. More...
 
class  Interface
 Top-level interface class implementable for a particular device. More...
 
struct  IntrGpioInfo
 Describes an Interrupt GPIO configuration. More...
 
class  INvSIPLCamera
 The top-level API for SIPL. More...
 
class  INvSIPLCameraQuery
 Defines the public data structures and describes the interfaces for NvSIPLCameraQuery. More...
 
class  INvSIPLClient
 Defines the public data structures and describes the interfaces for NvSIPL Client. More...
 
class  INvSIPLFrameCompletionQueue
 The interface to the frame completion queue. More...
 
class  INvSIPLISPStatCustomInterface
 Custom interface to be implemented by the Tegra SIPL Pipeline HAL. More...
 
class  INvSIPLNotificationQueue
 The interface to the notification queue. More...
 
class  INvSIPLQuery
 Defines the public data structures and describes the interfaces for NvSIPLQuery. More...
 
class  INvSIPLQueryTrace
 
class  INvSIPLTrace
 Defines the public interfaces to control the logging/tracing of SIPL. More...
 
class  ISiplControlAuto
 Defines SIPL Control Auto Interface Class. More...
 
struct  IspBlcOverrideSettings
 Structure containing override control settings for ISP black level correction block. More...
 
struct  IspGtmOverrideSettings
 Structure containing override control settings for ISP GTM block. More...
 
struct  IspHistogramOverrideSettings
 Structure containing override control settings for ISP Histogram statistics block. More...
 
struct  IspLscOverrideSettings
 Structure containing override control settings for ISP Lens Shading Correction(LSC) block. More...
 
struct  IspNrOverrideSettings
 Structure to hold ISP noise reduction override settings. More...
 
struct  IspStatsData
 ISP statistics container for data attributes. More...
 
struct  IspStatsInfo
 ISP statistics container for settings and data. More...
 
struct  IspStatsSettings
 ISP statistics container for settings attributes. More...
 
class  NonCopyable
 A class to prevent drivers being copied and duplicating state. More...
 
struct  NvIspStatsHeaderInfo
 ISP decoded stats including the stats header info. More...
 
struct  NvSiplControlInfo
 Defines the control info. More...
 
struct  NvSIPLDeviceBlockQueues
 Holds the queues used by the client to receive device block event notifications. More...
 
struct  NvSIPLDownscaleCropCfg
 Downscale and crop configuration. More...
 
class  NvSIPLImageGroupWriter
 Describes the interfaces of SIPL pipeline feeder. More...
 
struct  NvSiplISPBadPixelStats
 Holds controls for bad pixel statistics (BP Stats). More...
 
struct  NvSiplISPBadPixelStatsData
 Holds bad pixel statistics (BP Stats). More...
 
struct  NvSiplISPDeadPixelCorrectionStatsData
 Holds dead pixel correction statistics (DPC Stats). More...
 
struct  NvSiplISPDeadPixelCorrectionStatsROIData
 Holds dead pixel correction statistics (DPC Stats) metrics. More...
 
struct  NvSiplISPEllipse
 Defines an ellipse. More...
 
struct  NvSiplISPGlobalToneMapInfo
 Defines the global tone map spline. More...
 
struct  NvSiplISPHistogramStats
 Holds controls for histogram statistics (HIST Stats). More...
 
struct  NvSiplISPHistogramStatsData
 Holds histogram statistics (HIST Stats). More...
 
struct  NvSiplISPHistogramStatsOverride
 SIPL ISP Histogram Statistics Override Params. More...
 
struct  NvSiplISPLocalAvgClipStats
 Holds controls for local average and clip statistics (LAC Stats). More...
 
struct  NvSiplISPLocalAvgClipStatsData
 Holds local average and clip statistics block (LAC Stats). More...
 
struct  NvSiplISPLocalAvgClipStatsROIData
 Holds local average and clip statistics data for a region of interest. More...
 
struct  NvSiplISPRadialTF
 Defines a radial transform. More...
 
struct  NvSiplISPSplineControlPoint
 Defines a spline control point. More...
 
struct  NvSiplISPStatisticsWindows
 Defines the windows used in ISP LAC stats calculations. More...
 
struct  NvSIPLIspStatsOverrideSetting
 SIPL ISP Statistics Override Parameters. More...
 
struct  NvSIPLNitoMetadata
 NvSIPLNitoMetadata defines the 3-tuple returned by a successful call to GetNitoMetadataFromMemory(). More...
 
struct  NvSIPLPipelineBufferCfg
 Data structure to define the camera pipeline buffer configuration. More...
 
struct  NvSIPLPipelineConfiguration
 Defines the camera pipeline configuration. More...
 
class  NvSIPLPipelineNotifier
 Describes the interfaces of the SIPL pipeline notification handler. More...
 
struct  NvSIPLPipelineQueues
 This is the output structure for INvSIPLCamera::SetPipelineCfg(). More...
 
struct  NvSiplPoint
 Defines the location of a point on a two-dimensional object. More...
 
struct  NvSiplPointFloat
 Defines the float-precision location of a point on a two-dimensional object. More...
 
struct  NvSiplRect
 Holds a rectangular region of a surface. More...
 
struct  NvSIPLVersion
 Holds the version information of NvSIPL Camera and NvSIPL Client. More...
 
struct  PlatformCfg
 Defines the camera platform configuration. More...
 
struct  SensorInfo
 Defines the image sensor information. More...
 
struct  SerdesGPIOPinMap
 Defines GPIO mapping from the serializer to the deserializer. More...
 
struct  SerInfo
 Defines the serializer information. More...
 
struct  SiplControlAutoAwbGain
 Color Gains assuming order RGGB, RCCB, RCCC. More...
 
struct  SiplControlAutoAwbSetting
 Automatic white balance settings. More...
 
struct  SiplControlAutoInputParam
 Input parameters for processing AE/AWB. More...
 
struct  SiplControlAutoMetadata
 Structure containing metadata info for processing AE/AWB algorithm. More...
 
struct  SiplControlAutoOutputParam
 AE/AWB Output parameters. More...
 
struct  SiplControlAutoSensorSetting
 Sensor settings. More...
 
struct  SiplControlEmbedData
 Embedded data and parsed information. More...
 
struct  SiplControlEmbedInfo
 Parsed frame embedded information. More...
 
struct  SiplControlIspOverrideSetting
 Structure containing dynamic override ISP block settings to be applied during runtime. More...
 
struct  SiplControlIspStatsInfo
 Structure containing ISP Stats information. More...
 
struct  SIPLErrorDetails
 Error details for a particular device. More...
 
class  UUID
 A universally unique identifier. More...
 

Typedefs

using NvSiplGlobalTime = uint64_t
 Media global time, measured in microseconds. More...
 
using NvSiplBool = uint32_t
 A boolean value, holding SIPL_TRUE or SIPL_FALSE. More...
 
using IspLacOverrideSettings = nvsipl::NvSiplISPLocalAvgClipStats
 

Enumerations

enum  NvSiplTimeBase : std::uint8_t {
  NVSIPL_TIME_BASE_CLOCK_PTP,
  NVSIPL_TIME_BASE_CLOCK_MONOTONIC,
  NVSIPL_TIME_BASE_CLOCK_USER_DEFINED
}
 Defines clock base for NvSiplTime. More...
 
enum  SIPLStatus : std::uint8_t {
  NVSIPL_STATUS_OK = 0,
  NVSIPL_STATUS_BAD_ARGUMENT,
  NVSIPL_STATUS_NOT_SUPPORTED,
  NVSIPL_STATUS_OUT_OF_MEMORY,
  NVSIPL_STATUS_RESOURCE_ERROR,
  NVSIPL_STATUS_TIMED_OUT,
  NVSIPL_STATUS_INVALID_STATE,
  NVSIPL_STATUS_EOF,
  NVSIPL_STATUS_NOT_INITIALIZED,
  NVSIPL_STATUS_FAULT_STATE,
  NVSIPL_STATUS_ERROR
}
 Defines the status codes returned by functions in SIPL modules. More...
 
enum  SIPLGpioEvent : std::uint8_t {
  NVSIPL_GPIO_EVENT_NOTHING = 0,
  NVSIPL_GPIO_EVENT_INTR,
  NVSIPL_GPIO_EVENT_INTR_TIMEOUT,
  NVSIPL_GPIO_EVENT_ERROR_CAMGPIO,
  NVSIPL_GPIO_EVENT_ERROR_BACKEND,
  NVSIPL_GPIO_EVENT_ERROR_UNKNOWN
}
 CDAC GPIO event codes. More...
 
enum  SIPLModuleErrorReadFlag : std::uint8_t {
  NVSIPL_MODULE_ERROR_READ_SENSOR,
  NVSIPL_MODULE_ERROR_READ_SERIALIZER,
  NVSIPL_MODULE_ERROR_READ_ALL
}
 Flag indicating which module errors to read. More...
 
enum  PluginType : std::uint8_t {
  NV_PLUGIN = 0,
  CUSTOM_PLUGIN0,
  MAX_NUM_PLUGINS
}
 Defines types of SIPL Control Auto plug-ins. More...
 
enum  SerdesDataTransmissionMode : uint8_t {
  SerdesDataTransmissionMode::PIXEL_MODE = 0U,
  SerdesDataTransmissionMode::TUNNELING_MODE = 1U
}
 Defines the data transmission mode for serializer-deserializer link. More...
 
enum  InitErrorCode : uint32_t {
  InitErrorCode::DEFAULT_INIT_ERROR_CODE_NONE = 0U,
  InitErrorCode::PIPELINE_RECOVERED_FROM_INIT_ERROR_ON_RETRY = 1U,
  InitErrorCode::CBA_FAILURE = 10U,
  InitErrorCode::DESER_POWER_FAILURE = 100U,
  InitErrorCode::DESER_INIT_FAILURE = 101U,
  InitErrorCode::DESER_EN_LINK_FAILURE = 102U,
  InitErrorCode::DESER_START_FAILURE = 103U,
  InitErrorCode::DESER_CHECK_LINK_LOCK_FAILURE = 104U,
  InitErrorCode::CAMERA_POWER_FAILURE = 200U,
  InitErrorCode::CAMERA_INIT_FAILURE = 201U,
  InitErrorCode::CAMERA_EN_LINK_DETECT_FAILURE = 202U,
  InitErrorCode::CAMERA_AUTH_FAILURE = 203U,
  InitErrorCode::CAMERA_POST_INIT_FAILURE = 204U,
  InitErrorCode::CAMERA_START_FAILURE = 205U,
  InitErrorCode::CAMERA_POST_START_FAILURE = 206U,
  InitErrorCode::CAMERA_OVER_VOLTAGE = 300U,
  InitErrorCode::CAMERA_UNDER_VOLTAGE = 301U,
  InitErrorCode::CAMERA_LINE_TO_LINE_FAULT = 302U,
  InitErrorCode::CAMERA_OVER_CURRENT = 303U,
  InitErrorCode::CAMERA_THERMAL_SHUTDOWN = 304U,
  InitErrorCode::CAMERA_CIRCUIT_OPEN_DISCONNECTION = 305U,
  InitErrorCode::CAMERA_INCORRECT_IMPEDANCE = 306U
}
 Init Error Codes. More...
 
enum  InterruptCode : uint32_t {
  InterruptCode::INTR_STATUS_DES_FAILURE = 0U,
  InterruptCode::INTR_STATUS_DES_TIMEOUT = 1U,
  InterruptCode::INTR_STATUS_DES_ERRB_ERR = 10U,
  InterruptCode::INTR_STATUS_DES_LOCK_ERR = 11U,
  InterruptCode::INTR_STATUS_PWR_FAILURE = 100U,
  InterruptCode::INTR_STATUS_PWR_TIMEOUT = 101U,
  InterruptCode::INTR_STATUS_PWR_OVERVOLTAGE = 102U,
  InterruptCode::INTR_STATUS_PWR_UNDERVOLTAGE = 103U,
  InterruptCode::INTR_STATUS_PWR_LINE_TO_LINE_FAULT = 104U,
  InterruptCode::INTR_STATUS_PWR_OVERCURRENT = 105U,
  InterruptCode::INTR_STATUS_PWR_THERMAL_SHUTDOWN = 106U,
  InterruptCode::INTR_STATUS_PWR_CIRCUIT_OPEN_DISCONNECT = 107U,
  InterruptCode::INTR_STATUS_PWR_INCORRECT_IMPEDANCE = 108U,
  InterruptCode::INTR_STATUS_PWR_ISET_OPEN = 109U,
  InterruptCode::INTR_STATUS_PWR_UNDERVOLTAGE_INPUT = 110U,
  InterruptCode::INTR_STATUS_PWR_OVERVOLTAGE_INPUT = 111U,
  InterruptCode::INTR_STATUS_PWR_UNDERVOLTAGE_VDD = 112U,
  InterruptCode::INTR_STATUS_PWR_OVERVOLTAGE_VDD = 113U,
  InterruptCode::INTR_STATUS_SER_FAILURE = 1000U,
  InterruptCode::INTR_STATUS_SER_TIMEOUT = 1001U,
  InterruptCode::INTR_STATUS_SERDES_LINK_ERR = 1002U,
  InterruptCode::INTR_STATUS_SEN_FAILURE = 1100U,
  InterruptCode::INTR_STATUS_SEN_TIMEOUT = 1101U,
  InterruptCode::INTR_STATUS_PMIC_FAILURE = 1200U,
  InterruptCode::INTR_STATUS_PMIC_TIMEOUT = 1201U,
  InterruptCode::INTR_STATUS_EEPROM_FAILURE = 1300U,
  InterruptCode::INTR_STATUS_EEPROM_TIMEOUT = 1301U,
  InterruptCode::INTR_STATUS_LED_FAILURE = 1400U,
  InterruptCode::INTR_STATUS_LED_TIMEOUT = 1401U,
  InterruptCode::INTR_STATUS_SPURIOUS_NO_ERROR = 9000U,
  InterruptCode::INTR_STATUS_FAILURE = 10000U,
  InterruptCode::INTR_STATUS_TIMEOUT = 10001U,
  InterruptCode::INTR_STATUS_LOCALIZATION_FAILURE = 10002U,
  InterruptCode::INTR_STATUS_ERROR_RECOVERY = 10003U
}
 Interrupt Status Codes. More...
 
enum  CapturePathType : uint8_t { CapturePathType::VI = 0 }
 Defines the capture path type for the pipeline. More...
 

Functions

void NvSIPLGetVersion (NvSIPLVersion &rVersion)
 Indicates the patch revision. More...
 

Variables

constexpr UUID NVSIPLISPSTAT_CUSTOM_INTERFACE_ID
 Custom interface ID for INvSIPLISPStatCustomInterface. More...
 
constexpr uint32_t ISP_GTM_PLUGIN_OVERRIDE_MIN_CTRLPOINTS = 2U
 Defines the minimum number of control points for Global Tone Map(GTM) plugin override settings. More...
 
constexpr uint32_t ISP_GTM_PLUGIN_OVERRIDE_MAX_CTRLPOINTS = 200U
 Defines the maximum number of control points for Global Tone Map(GTM) plugin override settings. More...
 
static constexpr uint32_t MAX_DEVICEBLOCKS_PER_PLATFORM {6U}
 Indicates the maximum number of device blocks per platform. More...
 
static constexpr uint32_t MAX_CAMERAMODULES_PER_BLOCK {8U}
 Indicates the maximum number of camera modules per device block. More...
 
static constexpr uint32_t MAX_VIRTUAL_CHANNELS_PER_SENSOR {4U}
 Indicates the maximum number of virtual channels per sensor. More...
 
static constexpr uint32_t MAX_CAMERAMODULES_PER_PLATFORM {MAX_DEVICEBLOCKS_PER_PLATFORM * MAX_CAMERAMODULES_PER_BLOCK}
 Indicates the maximum number of camera modules per platform. More...
 
static constexpr uint32_t MAX_SENSORS_PER_PLATFORM {MAX_CAMERAMODULES_PER_PLATFORM}
 Indicates the maximum number of sensors per platform. More...
 
static constexpr std::uint32_t MAX_CSI_LANE_CONFIGURATION {2U}
 Indicates the maximum number of CSI lane configurations. More...
 
static constexpr std::uint32_t X2_CSI_LANE_CONFIGURATION {0U}
 Indicates the index for CSI 2 lanes. More...
 
static constexpr std::uint32_t X4_CSI_LANE_CONFIGURATION {1U}
 Indicates the index for CSI 4 lanes. More...
 
constexpr uint32_t NUM_GTM_SPLINE_POINTS = 18U
 Defines the number of global tone map spline points. More...
 
constexpr uint32_t NVSIPL_LUMINANCE_CALIB_MATRIX_SIZE {4U}
 Defines the length(M) of a MxM luminance calibration matrix. More...
 
constexpr uint32_t NVSIPL_CCM_MATRIX_SIZE {3U}
 Defines the length(M) of a MxM color correction matrix(ccm). More...
 
static constexpr uint16_t DEFAULT_SET_CAPTURE_BUFFER_COUNT {40U}
 The default number of capture buffers configured for a given pipeline. More...
 
static constexpr uint16_t DEFAULT_SET_ISP_BUFFER_COUNT {64U}
 The default number of ISP buffers configured for a given pipeline. More...
 
constexpr uint32_t NVSIPL_MAJOR_VER = 1U
 
constexpr uint32_t NVSIPL_MINOR_VER = 0U
 Indicates the major revision. More...
 
constexpr uint32_t NVSIPL_PATCH_VER = 0U
 Indicates the minor revision. More...
 
enum  NvSiplNvSciSyncClientType : std::uint8_t {
  SIPL_SIGNALER,
  SIPL_WAITER
}
 Defines SIPL NvSciSync client types. More...
 
enum  NvSiplNvSciSyncObjType : std::uint8_t {
  NVSIPL_PRESYNCOBJ,
  NVSIPL_EOFSYNCOBJ
}
 Defines SIPL NvSciSyncObj types. More...
 
enum  FrameProcessingRate : std::uint8_t {
  FULL_RATE = 0U,
  HALF_RATE,
  THIRD_RATE,
  AWB_HALF_RATE,
  AWB_THIRD_RATE
}
 Defines Auto Control and ISP processing rate options. More...
 
static constexpr size_t NITO_PARAMETER_SET_ID_SIZE {16U}
 Size of the NITO Parameters set ID. More...
 
static constexpr size_t NITO_SCHEMA_HASH_SIZE {32U}
 Size of the NITO Schema Hash. More...
 
static constexpr size_t NITO_DATA_HASH_SIZE {32U}
 Size of the NITO Data Hash. More...
 
SIPLStatus GetNitoMetadataFromMemory (uint8_t const *const nitoMem, size_t const nitoMemLength, NvSIPLNitoMetadata *const metadataArray, size_t const metadataArrayLength, size_t *const metadataCount)
 Get NITO Metadata (knobset UUID, schema hash, data hash) from a NITO memory buffer. More...
 

Enumeration Type Documentation

◆ FrameProcessingRate

enum nvsipl::FrameProcessingRate : std::uint8_t

Defines Auto Control and ISP processing rate options.

This enum specifies the relative processing rates for Auto Control (AE-AWB) and ISP.

Enumerator
FULL_RATE 

Process Auto Control (AE-AWB) and ISP every frame (default).

HALF_RATE 

Process Auto Control (AE-AWB) and ISP every 2nd frame (half rate).

THIRD_RATE 

Process Auto Control (AE-AWB) and ISP every 3rd frame (third rate).

AWB_HALF_RATE 

Process AE and ISP every frame, AWB every 2nd frame.

AWB_THIRD_RATE 

Process AE and ISP every frame, AWB every 3rd frame.

Definition at line 151 of file NvSIPLCamera.hpp.

◆ InterruptCode

enum nvsipl::InterruptCode : uint32_t
strong

Interrupt Status Codes.

Enumerator
INTR_STATUS_DES_FAILURE 

Device Block-level event, indicates general deserializer failure.

INTR_STATUS_DES_TIMEOUT 

Device Block-level event, indicates deserializer response timeout or read failure.

INTR_STATUS_DES_ERRB_ERR 

Device Block or Camera Link-level event, indicates deserializer failure.

INTR_STATUS_DES_LOCK_ERR 

Camera Link-level event, indicates deserializer-serializer link failure.

INTR_STATUS_PWR_FAILURE 

Device Block-level event, indicates general power load switch failure.

INTR_STATUS_PWR_TIMEOUT 

Device Block-level event, indicates power load switch response timeout or read failure.

INTR_STATUS_PWR_OVERVOLTAGE 

Camera Link-level event, indicates power load switch overvoltage failure on the corresponding output.

INTR_STATUS_PWR_UNDERVOLTAGE 

Camera Link-level event, indicates power load switch undervoltage failure on the corresponding output.

INTR_STATUS_PWR_LINE_TO_LINE_FAULT 

Device Block or Camera Link-level event, indicates power load switch line2line fault on more than one outputs.

INTR_STATUS_PWR_OVERCURRENT 

Camera Link-level event, indicates power load switch overcurrent failure on the corresponding output.

INTR_STATUS_PWR_THERMAL_SHUTDOWN 

Camera Link-level event, indicates power load switch thermal shutdown failure on the corresponding output.

The corresponding output is forced shutdown and remains off until the temperature drops below the thermal-shutdown hysteresis temperature.

INTR_STATUS_PWR_CIRCUIT_OPEN_DISCONNECT 

Camera Link-level event, indicates power load switch circuit open disconnect on the corresponding output.

INTR_STATUS_PWR_INCORRECT_IMPEDANCE 

Camera Link-level event, indicates power load switch incorrect impedance on the corresponding output.

INTR_STATUS_PWR_ISET_OPEN 

Device Block level event, indicates power load switch ISET pin is open.

The ISET pin of powerload switch is open, could be due to a short to ground or open circuit or incorrect resistance value.

INTR_STATUS_PWR_UNDERVOLTAGE_INPUT 

Device Block level event, indicates power load switch input voltage is below the minimum operating voltage.

The outputs are forced off in this condition.

INTR_STATUS_PWR_OVERVOLTAGE_INPUT 

Device Block level event, indicates power load switch input voltage is above the maximum operating voltage.

The outputs are forced off in this condition.

INTR_STATUS_PWR_UNDERVOLTAGE_VDD 

Device Block level event, indicates power load switch VDD voltage is below the minimum operating voltage.

The outputs are forced off in this condition.

INTR_STATUS_PWR_OVERVOLTAGE_VDD 

Device Block level event, indicates power load switch VDD voltage is above the maximum operating voltage.

The outputs are forced off in this condition.

INTR_STATUS_SER_FAILURE 

Camera Link-level event, indicates general Camera Module serializer failure.

INTR_STATUS_SER_TIMEOUT 

Camera Link-level event, indicates Camera Module serializer response timeout or read failure.

INTR_STATUS_SERDES_LINK_ERR 

Camera Link-level event, indicates serializer-deserializer link error reported by Camera Module driver.

INTR_STATUS_SEN_FAILURE 

Camera Link-level event, indicates general Camera Module sensor failure.

INTR_STATUS_SEN_TIMEOUT 

Camera Link-level event, indicates Camera Module sensor reponse timeout or read failure.

INTR_STATUS_PMIC_FAILURE 

Camera Link-level event, indicates general Camera Module PMIC failure.

INTR_STATUS_PMIC_TIMEOUT 

Camera Link-level event, indicates Camera Module PMIC response timeout or read failure.

INTR_STATUS_EEPROM_FAILURE 

Camera Link-level event, indicates general Camera Module EEPROM failure.

INTR_STATUS_EEPROM_TIMEOUT 

Camera Link-level event, indicates Camera Module EEPROM response timeout or read failure.

INTR_STATUS_LED_FAILURE 

Camera Link-level event, indicates general Camera Module LED Driver failure.

INTR_STATUS_LED_TIMEOUT 

Camera Link-level event, indicates Camera Module LED Driver response timeout.

INTR_STATUS_SPURIOUS_NO_ERROR 

Camera Link-level event, indicates a Camera Module spurious interrupt with no associated error cause.

If a driver issues this notification a. It precludes the SIPL error handling thread from automatically entering error state and sending INTR_STATUS_LOCALIZATION_FAILURE, if no other errors are reported. b. Masks interrupts for any devices whose status cannot be queried.

INTR_STATUS_FAILURE 

Device Block or Camera Link-level event, indicates general failure.

INTR_STATUS_TIMEOUT 

Device Block or Camera Link-level event, indicates general response timeout.

INTR_STATUS_LOCALIZATION_FAILURE 

Device Block or Camera Link-level event, indicates general localization failure.

INTR_STATUS_ERROR_RECOVERY 

Device Block-level event, indicates recovery from error state for all links.

This event is generated when all links that previously reported errors (e.g., via GPIO interrupts) have fully recovered, indicating that the device block camera subsystem is no longer in a degraded state.

Definition at line 29 of file NvSIPLInterrupts.hpp.

◆ NvSiplNvSciSyncClientType

enum nvsipl::NvSiplNvSciSyncClientType : std::uint8_t

Defines SIPL NvSciSync client types.

Enumerator
SIPL_SIGNALER 

For a given NvSciSyncObj SIPL acts as a signaler.

This type corresponds to postfences from SIPL

SIPL_WAITER 

For a given NvSciSyncObj SIPL acts as a waiter.

This type corresponds to prefences to SIPL

Definition at line 124 of file NvSIPLCamera.hpp.

◆ NvSiplNvSciSyncObjType

enum nvsipl::NvSiplNvSciSyncObjType : std::uint8_t

Defines SIPL NvSciSyncObj types.

Enumerator
NVSIPL_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which SIPL acts as a waiter.

NVSIPL_EOFSYNCOBJ 

Specifies an NvSciSyncObj type for which SIPL acts as a signaler, signaling EOFFence.

Definition at line 139 of file NvSIPLCamera.hpp.

Function Documentation

◆ GetNitoMetadataFromMemory()

SIPLStatus nvsipl::GetNitoMetadataFromMemory ( uint8_t const *const  nitoMem,
size_t const  nitoMemLength,
NvSIPLNitoMetadata *const  metadataArray,
size_t const  metadataArrayLength,
size_t *const  metadataCount 
)

Get NITO Metadata (knobset UUID, schema hash, data hash) from a NITO memory buffer.

Precondition
None.

The possible return values from this functions are:

  • NVSIPL_STATUS_OK
  • NVSIPL_STATUS_BAD_ARGUMENT
  • NVSIPL_STATUS_INVALID_STATE
  • NVSIPL_STATUS_OUT_OF_MEMORY
  • NVSIPL_STATUS_ERROR
Parameters
[in]nitoMemPointer to location of memory to load from.
[in]nitoMemLengthSize of memory pointed to by nitoMem. This value must be in the range [1, 6MB (6UL * 1024UL * 1024UL)].
[in,out]metadataArrayAn array of NvSIPLNitoMetadata tuples to store the result.
[in]metadataArrayLengthThe size of array metadataArray
[out]metadataCountThe number of tuples stored in metadataArray on success.
Returns
SIPLStatus the completion status of the operation.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: Yes, with the following conditions:
      • Two threads are not using the same metadata array.
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: Yes, with the following conditions:
    • Grants: nonroot, allow
    • Abilities: public_channel
    • Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

Variable Documentation

◆ NITO_DATA_HASH_SIZE

constexpr size_t nvsipl::NITO_DATA_HASH_SIZE {32U}
staticconstexpr

Size of the NITO Data Hash.

Definition at line 58 of file NvSIPLCamera.hpp.

◆ NITO_SCHEMA_HASH_SIZE

constexpr size_t nvsipl::NITO_SCHEMA_HASH_SIZE {32U}
staticconstexpr

Size of the NITO Schema Hash.

Definition at line 56 of file NvSIPLCamera.hpp.

◆ NVSIPLISPSTAT_CUSTOM_INTERFACE_ID

constexpr UUID nvsipl::NVSIPLISPSTAT_CUSTOM_INTERFACE_ID
constexpr
Initial value:
{ 0xB19E80D0U, 0x1333U, 0x4B4DU, 0xB5A9U,
0x8CU, 0xCFU, 0x19U, 0x43U, 0xE2U, 0x37U }

Custom interface ID for INvSIPLISPStatCustomInterface.

Definition at line 28 of file INvSIPLISPStatCustomInterface.hpp.

Referenced by nvsipl::INvSIPLISPStatCustomInterface::getClassInterfaceID(), and nvsipl::INvSIPLISPStatCustomInterface::getInstanceInterfaceID().