NVIDIA DRIVE OS Linux SDK API Reference

5.1.15.2 Release
For Test and Development only

Detailed Description

Manage NvMediaISCRootDevice objects, which represent the root of the Nvmedia ISC object system.

The NvMediaISCRootDevice object manages an I2C port on the host hardware device.

Typedefs

typedef void NvMediaISCRootDevice
 An opaque handle for an NvMediaISCRootDevice object. More...
 

Enumerations

enum  NvMediaISC_I2CPort {
  NVMEDIA_ISC_I2C_BUS_0 = 0,
  NVMEDIA_ISC_I2C_BUS_1 = 1,
  NVMEDIA_ISC_I2C_BUS_2 = 2,
  NVMEDIA_ISC_I2C_BUS_3 = 3,
  NVMEDIA_ISC_I2C_BUS_4 = 4,
  NVMEDIA_ISC_I2C_BUS_5 = 5,
  NVMEDIA_ISC_I2C_BUS_6 = 6,
  NVMEDIA_ISC_I2C_BUS_7 = 7,
  NVMEDIA_ISC_I2C_BUS_8 = 8,
  NVMEDIA_ISC_I2C_BUS_9 = 9,
  NVMEDIA_ISC_I2C_BUS_10 = 10,
  NVMEDIA_ISC_I2C_BUS_11 = 11,
  NVMEDIA_ISC_I2C_SIMULATOR = 255
}
 Defines the I2C buses on the host hardware device. More...
 

Functions

NvMediaISCRootDeviceNvMediaISCRootDeviceCreate (uint32_t portCfg)
 Creates an NvMediaISCRootDevice object. More...
 
void NvMediaISCRootDeviceDestroy (NvMediaISCRootDevice *device)
 Destroys an NvMediaISCRootDevice object. More...
 
NvMediaStatus NvMediaISCRootDeviceWaitForError (NvMediaISCRootDevice *device)
 Waits until an error condition is reported or NvMediaISCRootDeviceAbortWaitForError() is called. More...
 
NvMediaStatus NvMediaISCRootDeviceAbortWaitForError (NvMediaISCRootDevice *device)
 Aborts a call to NvMediaISCRootDeviceWaitForError(). More...
 

Typedef Documentation

◆ NvMediaISCRootDevice

typedef void NvMediaISCRootDevice

An opaque handle for an NvMediaISCRootDevice object.

Definition at line 218 of file nvmedia_isc.h.

Enumeration Type Documentation

◆ NvMediaISC_I2CPort

Defines the I2C buses on the host hardware device.

Enumerator
NVMEDIA_ISC_I2C_BUS_0 

Specifies i2c-0.

NVMEDIA_ISC_I2C_BUS_1 

Specifies i2c-1.

NVMEDIA_ISC_I2C_BUS_2 

Specifies i2c-2.

NVMEDIA_ISC_I2C_BUS_3 

Specifies i2c-3.

NVMEDIA_ISC_I2C_BUS_4 

Specifies i2c-4.

NVMEDIA_ISC_I2C_BUS_5 

Specifies i2c-5.

NVMEDIA_ISC_I2C_BUS_6 

Specifies i2c-6.

NVMEDIA_ISC_I2C_BUS_7 

Specifies i2c-7.

NVMEDIA_ISC_I2C_BUS_8 

Specifies i2c-8.

NVMEDIA_ISC_I2C_BUS_9 

Specifies i2c-9.

NVMEDIA_ISC_I2C_BUS_10 

Specifies i2c-10.

NVMEDIA_ISC_I2C_BUS_11 

Specifies i2c-11.

NVMEDIA_ISC_I2C_SIMULATOR 

Port SIMPULATOR (20)

Definition at line 199 of file nvmedia_isc.h.

Function Documentation

◆ NvMediaISCRootDeviceAbortWaitForError()

NvMediaStatus NvMediaISCRootDeviceAbortWaitForError ( NvMediaISCRootDevice device)

Aborts a call to NvMediaISCRootDeviceWaitForError().

Parameters
[in]deviceThe root device to use.
Return values
NVMEDIA_STATUS_OKto indicate that the operatrion was successful.
NVMEDIA_STATUS_BAD_PARAMETERto indicate that device was NULL.
NVMEDIA_STATUS_ERRORto indicate that some other error occurred.

◆ NvMediaISCRootDeviceCreate()

◆ NvMediaISCRootDeviceDestroy()

void NvMediaISCRootDeviceDestroy ( NvMediaISCRootDevice device)

Destroys an NvMediaISCRootDevice object.

Parameters
[in]deviceHandle of the device to be destroyed.

◆ NvMediaISCRootDeviceWaitForError()

NvMediaStatus NvMediaISCRootDeviceWaitForError ( NvMediaISCRootDevice device)

Waits until an error condition is reported or NvMediaISCRootDeviceAbortWaitForError() is called.

For safety use cases, application software shall verify the successful reception of camera error GPIO interrupt as a first step of programming the deserializer. This can be implemented by calling NvMediaISCRootDeviceWaitForError() followed by programming the deserializer to toggle the camera error GPIO pin which would cause NvMediaISCRootDeviceWaitForError() to return.

Parameters
[in]deviceThe root device to use.
Return values
NVMEDIA_STATUS_OKindicates that the call was successful.
NVMEDIA_STATUS_BAD_PARAMETERindicates that device was NULL.
NVMEDIA_STATUS_ERRORindicate that some other error occurred.