Jetson Linux API Reference

39.2 Release
nvsipl::INvSIPLISPStatCustomInterface Class Referenceabstract

Detailed Description

Custom interface to be implemented by the Tegra SIPL Pipeline HAL.

Definition at line 32 of file INvSIPLISPStatCustomInterface.hpp.

Inheritance diagram for nvsipl::INvSIPLISPStatCustomInterface:
Collaboration diagram for nvsipl::INvSIPLISPStatCustomInterface:

Public Member Functions

const UUID & getInstanceInterfaceID () const noexcept override
 Retrieve the ID from the instance of the class inheriting this interface. More...
 
virtual const IspStatsInfo * GetIspStatsInfo (INvSIPLClient::INvSIPLNvMBuffer const *const &buffer) const noexcept=0
 Helper function to extract IspStatsInfo (Tegra) from the nvsipl::INvSIPLClient::INvSIPLNvMBuffer object. More...
 

Static Public Member Functions

static const UUID & getClassInterfaceID ()
 Retrieve the ID of the class inheriting this interface. More...
 

Member Function Documentation

◆ getClassInterfaceID()

static const UUID& nvsipl::INvSIPLISPStatCustomInterface::getClassInterfaceID ( )
inlinestatic

Retrieve the ID of the class inheriting this interface.

Return values
Uniqueidentifier for the interface class. Valid range: [NVSIPLISPSTAT_CUSTOM_INTERFACE_ID].

Definition at line 40 of file INvSIPLISPStatCustomInterface.hpp.

References nvsipl::NVSIPLISPSTAT_CUSTOM_INTERFACE_ID.

◆ getInstanceInterfaceID()

const UUID& nvsipl::INvSIPLISPStatCustomInterface::getInstanceInterfaceID ( ) const
inlineoverridevirtualnoexcept

Retrieve the ID from the instance of the class inheriting this interface.

Return values
Uniqueidentifier for the interface instance. Valid range: [NVSIPLISPSTAT_CUSTOM_INTERFACE_ID].

Implements nvsipl::Interface.

Definition at line 50 of file INvSIPLISPStatCustomInterface.hpp.

References nvsipl::NVSIPLISPSTAT_CUSTOM_INTERFACE_ID.

◆ GetIspStatsInfo()

virtual const IspStatsInfo* nvsipl::INvSIPLISPStatCustomInterface::GetIspStatsInfo ( INvSIPLClient::INvSIPLNvMBuffer const *const &  buffer) const
pure virtualnoexcept

Helper function to extract IspStatsInfo (Tegra) from the nvsipl::INvSIPLClient::INvSIPLNvMBuffer object.

Precondition
Should hold a reference to the buffer object on which the API is being called
Parameters
[in]bufferPointer to the Tegra Pipeline HAL buffer object from which to extract the Tegra ISP statistics information. Valid values: [non-nullptr]
Return values
IspStatsInfo*if successful
nullptrif buffer does not point to a valid Tegra Pipeline HAL buffer object


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: Yes
    • Re-entrant: Yes
    • 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: No
    • Operational: Yes
    • Reinit/Deinit Preparation: No
    • Maturity: GA

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