Detailed Description

The class of custom interfaces in Sensor AR0820.

Definition at line 29 of file AR0820_CUST1_CustomInterface.hpp.

Inheritance diagram for nvsipl::AR0820_CUST1_CustomInterface:

Collaboration diagram for nvsipl::AR0820_CUST1_CustomInterface:

Public Member Functions
virtual SIPLStatus	DetectFifoOverflow (uint16_t &overflowStatus) const =0
	Detect MAX9295A serializer video pipe FIFO overflow. More...

virtual SIPLStatus	GetSerializerTemperature (float_t &tmon) const =0
	Get MAX9295A Serializer Temperature data. More...

virtual SIPLStatus	DetectVideoPCLK (uint16_t &pclkStatus) const =0
	Detect MAX9295A Serializer PCLK. More...

virtual SIPLStatus	AssertMax9295Errb (void) const =0
	Assert MAX9295A ERRB. More...

virtual SIPLStatus	setDeserData (uint32_t const deviceIndex, uint32_t const registerNum, uint32_t const dataLength, uint8_t *const dataBuff) const =0

virtual SIPLStatus	getDeserData (uint32_t const deviceIndex, uint32_t const registerNum, uint32_t const dataLength, uint8_t *const dataBuff) const =0

virtual SIPLStatus	readRegisterMax9295 (uint16_t const registerAddr, uint16_t const dataLength, uint8_t *const dataBuff) const =0

virtual SIPLStatus	writeRegisterMax9295 (uint16_t const registerAddr, uint16_t const dataLength, uint8_t *const dataBuff) const =0

virtual SIPLStatus	GetPowerUpSMErr (uint16_t *const errorstatus) const =0
	Get sensor startup error status. More...

virtual SIPLStatus	GetPDIData (AR0820PDIList const pdiraw, uint16_t const pdicount) const =0
	Get sensor defective pixel list. More...

virtual SIPLStatus	ParseCustomEmbeddedData (uint8_t const const embeddedBufTop, uint32_t const embeddedBufTopSize, uint8_t const const embeddedBufBottom, uint32_t const embeddedBufBottomSize, AR0820CustomEmbeddedData *const embeddedData) const =0
	Parse the Custom Embedded Data from the passed raw embedded data. More...

virtual SIPLStatus	GetPMICStartupACK (TPS650332CustomStartupAck *const ack) const =0
	Get TPS650332 Startup ACK status. More...

virtual SIPLStatus	SetImageOrientation (uint8_t const hMirror, uint8_t const vFlip, uint32_t *const cfa) const =0
	Set Imager Orientation. More...

virtual SIPLStatus	AssertImagerSysCheck (void) const =0
	Assert Imager SYS_CHECK. More...

virtual SIPLStatus	GetSensorTemperature (float_t *const temp) const =0
	Get Sensor temperature. More...

virtual SIPLStatus	readRegisterAR820 (uint16_t const registerAddr, uint16_t dataBuff[]) const =0

virtual SIPLStatus	writeRegisterAR820 (uint16_t const registerAddr, uint16_t const dataBuff[]) const =0

virtual const UUID &	getInstanceInterfaceID () const noexcept=0
	A call to get the ID from the instance of the class inheriting this interface. More...

Member Function Documentation

◆ AssertImagerSysCheck()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::AssertImagerSysCheck ( void ) const

pure virtual

Assert Imager SYS_CHECK.

This function is used by the application to assert imager SYS_CHECK before streaming to guarantee the functionality of SYS_CHECK

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_ERROR	Failed to assert SYS_CHECK

◆ AssertMax9295Errb()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::AssertMax9295Errb ( void ) const

pure virtual

Assert MAX9295A ERRB.

This function is used by the application to assert serializer MAX9295A ERRB before streaming to guarantee the functionality of ERRB

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_ERROR	Failed to assert serializer ERRB

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ DetectFifoOverflow()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::DetectFifoOverflow ( uint16_t & overflowStatus ) const

pure virtual

Detect MAX9295A serializer video pipe FIFO overflow.

This fuction is used by the application to detect MAX9295A serializer video pipe FIFO overflow. The caller of this function needs to allocate the memory.

Parameters

[out] overflowStatus video pipe FIFO overflow status from MAX9295A.

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed
NVSIPL_STATUS_ERROR	Get FIFO overflow info call failed.

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ DetectVideoPCLK()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::DetectVideoPCLK ( uint16_t & pclkStatus ) const

pure virtual

Detect MAX9295A Serializer PCLK.

This function is to get MAX9295A Serializer PLCK from register.

Parameters

[out] pclkStatus video transmit PCLK status . bit0: PCLKDET for VID_TX X bit1: PCLKDET for VID_TX Y bit2: PCLKDET for VID_TX Z bit3: PCLKDET for VID_TX U

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	upSerializer is NULL
NVSIPL_STATUS_ERROR	any system error.

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ getDeserData()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::getDeserData	(	uint32_t const	deviceIndex,
		uint32_t const	registerNum,
		uint32_t const	dataLength,
		uint8_t *const	dataBuff
	)		const

pure virtual

◆ getInstanceInterfaceID()

virtual const UUID& nvsipl::Interface::getInstanceInterfaceID ( ) const

pure virtualnoexceptinherited

A call to get the ID from the instance of the class inheriting this interface.

Return values

Unique identifier for the interface instance

Implemented in nvsipl::IMX728_CustomInterface, nvsipl::IMX623_CustomInterface, nvsipl::AR0820NonFuSaCustomInterface, and nvsipl::OV2311NonFuSaCustomInterface.

◆ GetPDIData()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::GetPDIData	(	AR0820PDIList *const	pdiraw,
		uint16_t *const	pdicount
	)		const

pure virtual

Get sensor defective pixel list.

This function is used by the application to get ar0820 defective pixel data which is stored in OTPM wintin the senor. The caller of this function needs to allocate the memory. Also this function can ONLY be called before the streaming.

Parameters

[out]	pdiraw	Hold the defective pixel raw data Application needs to parse the data to extract pixel list.
[out]	pdicount	the number of defective pixels

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed
NVSIPL_STATUS_ERROR	I2C access failed

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ GetPMICStartupACK()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::GetPMICStartupACK ( TPS650332CustomStartupAck *const ack ) const

pure virtual

Get TPS650332 Startup ACK status.

This fuction is used by the application to read PMIC TPS650332 startup ACK status. The caller of this function needs to allocate the memory.

Parameters

[out] ack Registers Index and Value.

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed
NVSIPL_STATUS_ERROR	Device access failed.

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ GetPowerUpSMErr()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::GetPowerUpSMErr ( uint16_t *const errorstatus ) const

pure virtual

Get sensor startup error status.

This function is used by the application to retrieve the detailed sensor startup error information. The caller of this function needs to allocate the memory.

Parameters

[out] errorstatus The value of register REG_ASIL_STARTUP_STATUS_00

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed
NVSIPL_STATUS_ERROR	I2C access failed

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ GetSensorTemperature()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::GetSensorTemperature ( float_t *const temp ) const

pure virtual

Get Sensor temperature.

This function is used by the application to get sensor temperature

Parameters

[out] temp : sensor temperature

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed
NVSIPL_STATUS_ERROR	Device access failed.

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ GetSerializerTemperature()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::GetSerializerTemperature ( float_t & tmon ) const

pure virtual

Get MAX9295A Serializer Temperature data.

This function is to get MAX9295A Serializer temperature from ADC register.

Parameters

[out] tmon temperature sensor reading in celsius.

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	upSerializer is NULL
NVSIPL_STATUS_ERROR	any system error.

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ ParseCustomEmbeddedData()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::ParseCustomEmbeddedData	(	uint8_t const *const	embeddedBufTop,
		uint32_t const	embeddedBufTopSize,
		uint8_t const *const	embeddedBufBottom,
		uint32_t const	embeddedBufBottomSize,
		AR0820CustomEmbeddedData *const	embeddedData
	)		const

pure virtual

Parse the Custom Embedded Data from the passed raw embedded data.

This function is used by the application to retrieve the Custom Embedded Data from the passed raw embedded data. The caller of this function needs to allocate the memory.

Parameters

[in]	embeddedBufTop	Buffer pointer to top chunk of embedded data.
[in]	embeddedBufTopSize	Size of top chunk of embedded data.
[in]	embeddedBufBottom	Buffer pointer to bottom chunk of embedded data.
[in]	embeddedBufBottomSize	Size of bottom chunk of embedded data.
[out]	embeddedData	Custom Embedded data from AR0820.

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ readRegisterAR820()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::readRegisterAR820	(	uint16_t const	registerAddr,
		uint16_t	dataBuff[]
	)		const

pure virtual

◆ readRegisterMax9295()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::readRegisterMax9295	(	uint16_t const	registerAddr,
		uint16_t const	dataLength,
		uint8_t *const	dataBuff
	)		const

pure virtual

◆ setDeserData()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::setDeserData	(	uint32_t const	deviceIndex,
		uint32_t const	registerNum,
		uint32_t const	dataLength,
		uint8_t *const	dataBuff
	)		const

pure virtual

◆ SetImageOrientation()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::SetImageOrientation	(	uint8_t const	hMirror,
		uint8_t const	vFlip,
		uint32_t *const	cfa
	)		const

pure virtual

Set Imager Orientation.

This function is used by the application to change imager orientation

Parameters

[in]	hMirror	Horizontal Mirror.
[in]	vFlip	Vertical flip.
[out]	cfa	Color format after rotation.

Return values

NVSIPL_STATUS_OK	Success
NVSIPL_STATUS_BAD_ARGUMENT	Argument validation failed
NVSIPL_STATUS_NOT_SUPPORTED	Invalid in current driver state
NVSIPL_STATUS_ERROR	Device access failed.

Usage considerations

Allowed context for the API call
- Thread-safe: No

◆ writeRegisterAR820()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::writeRegisterAR820	(	uint16_t const	registerAddr,
		uint16_t const	dataBuff[]
	)		const

pure virtual

◆ writeRegisterMax9295()

virtual SIPLStatus nvsipl::AR0820_CUST1_CustomInterface::writeRegisterMax9295	(	uint16_t const	registerAddr,
		uint16_t const	dataLength,
		uint8_t *const	dataBuff
	)		const

pure virtual

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

AR0820_CUST1_CustomInterface.hpp

NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release

Detailed Description

Public Member Functions

Member Function Documentation

◆ AssertImagerSysCheck()

◆ AssertMax9295Errb()

◆ DetectFifoOverflow()

◆ DetectVideoPCLK()

◆ getDeserData()

◆ getInstanceInterfaceID()

◆ GetPDIData()

◆ GetPMICStartupACK()

◆ GetPowerUpSMErr()

◆ GetSensorTemperature()

◆ GetSerializerTemperature()

◆ ParseCustomEmbeddedData()

◆ readRegisterAR820()

◆ readRegisterMax9295()

◆ setDeserData()

◆ SetImageOrientation()

◆ writeRegisterAR820()

◆ writeRegisterMax9295()