CDI Device

Detailed Description

An CDI device represents a device that is attached or linked to the root I2C port.

Data Structures
struct	DevBlkCDIAdvancedConfig
	Holds the description of the target I2C device. More...
struct	DevBlkCDISensorControl
	Holds the sensor control structure. More...

Typedefs
typedef struct DevBlkCDISensorControl	DevBlkCDISensorControl
	Holds the sensor control structure. More...

Functions
NvMediaStatus	DevBlkCDIDeviceRead (DevBlkCDIDevice const *device, uint32_t deviceIndex, uint32_t regLength, uint8_t *regData, uint32_t dataLength, uint8_t *data)
	Usage considerations More...
NvMediaStatus	DevBlkCDIDeviceWrite (DevBlkCDIDevice const *device, uint32_t deviceIndex, uint32_t dataLength, const uint8_t *data)
	Performs a write operation over I2C. More...
NvMediaStatus	DevBlkCDIGetSensorAttributes (DevBlkCDIDevice *device, DevBlkCDISensorAttributes *sensorAttr, const size_t sensorAttrStructSize)
	Queries the sensor attributes. More...
NvMediaStatus	DevBlkCDISetSensorControls (DevBlkCDIDevice *device, const DevBlkCDISensorControl *sensorControl, const size_t sensrCtrlStructSize)
	Sets sensor control parameters. More...
NvMediaStatus	DevBlkCDIParseTopEmbDataInfo (DevBlkCDIDevice *device, const DevBlkCDIEmbeddedDataChunk *embeddedTopDataChunk, const size_t embeddedDataChunkStructSize, DevBlkCDIEmbeddedDataInfo *embeddedDataInfo, const size_t dataInfoStructSize)
	Parses sensor embedded data info and provides sensor image settings information for the captured frame. More...
NvMediaStatus	DevBlkCDIParseBotEmbDataInfo (DevBlkCDIDevice *device, const DevBlkCDIEmbeddedDataChunk *embeddedBotDataChunk, const size_t embeddedDataChunkStructSize, DevBlkCDIEmbeddedDataInfo *embeddedDataInfo, const size_t dataInfoStructSize)
NvMediaStatus	DevBlkCDIEnableErrorReport (DevBlkCDIRootDevice const *device)
	Enable the error report. More...
NvMediaStatus	DevBlkCDIGetDesPowerControlInfo (DevBlkCDIDevice *device, DevBlkCDIPowerControlInfo *desPwrControlInfo)
	Get the deserialzer's power control information. More...
NvMediaStatus	DevBlkCDIGetCamPowerControlInfo (DevBlkCDIDevice *device, DevBlkCDIPowerControlInfo *camPwrControlInfo)
	Get the camera's power control information. More...

Typedef Documentation

DevBlkCDISensorControl

typedef struct DevBlkCDISensorControl DevBlkCDISensorControl

Holds the sensor control structure.

Note

To activate a sensor control block, set the corresponding valid flag to TRUE and populate the control settings to be set.

To disable a sensor control block, set the corresponding valid flag to FALSE.

For example, to activate the white balance control block, set the wbValid flag in the wbControl structure to TRUE and populate the white balance settings to be programmed. To disable white balance control block, set the wbValid flag to FALSE.

Function Documentation

DevBlkCDIDeviceRead()

NvMediaStatus DevBlkCDIDeviceRead	(	DevBlkCDIDevice const *	device,
		uint32_t	deviceIndex,
		uint32_t	regLength,
		uint8_t *	regData,
		uint32_t	dataLength,
		uint8_t *	data
	)

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: No
  • 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
• API group
  • Init: Yes
  • Runtime: No
  • De-Init: No

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: No
  • 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
• API group
  • Init: No
  • Runtime: No
  • De-Init: Yes

Performs a read operation over I2C.

For safety use cases, application software shall call DevBlkCDIDeviceRead() 2 times to read the contents of the same register location. If a register value is not expected to change, return values of the two reads must match.

Parameters

[in]	device	A pointer to the device to use.
[in]	deviceIndex	Index of the sub-device to use
[in]	regLength	Length of the register address, in bytes.
[in]	regData	A pointer to the register address.
[in]	dataLength	Length of data to be read, in bytes.
[out]	data	A pointer to the location for storing the read data.

Return values

NVMEDIA_STATUS_OK	Indicates that the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER	Indicates that one or more pointer parameters was NULL.
NVMEDIA_STATUS_NOT_SUPPORTED	Indicates that the device driver does not support this functionality.
NVMEDIA_STATUS_ERROR	Indicates that any other error occurred.

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: Yes
  • 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
• API group
  • Init: Yes
  • Runtime: Yes
  • De-Init: Yes

DevBlkCDIDeviceWrite()

NvMediaStatus DevBlkCDIDeviceWrite	(	DevBlkCDIDevice const *	device,
		uint32_t	deviceIndex,
		uint32_t	dataLength,
		const uint8_t *	data
	)

Performs a write operation over I2C.

For safety use cases, application software shall call DevBlkCDIDeviceRead() after calling DevBlkCDIDeviceWrite() to verify whether the write operation was successful. If a register value is not expected to change, read value must match the value written.

Parameters

[in]	device	A pointer to the device to use.
[in]	deviceIndex	Index of the sub-device to use.
[in]	dataLength	Length of data to be written, in bytes.
[in]	data	A pointer to data to be written to device via I2C.

Returns

NvMediaStatus The completion status of the operation.

Return values

NVMEDIA_STATUS_OK	Indicates that the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER	Indicates that one or more pointer parameters was NULL.
NVMEDIA_STATUS_NOT_SUPPORTED	Indicates that the device driver does not support this functionality.
NVMEDIA_STATUS_ERROR	Indicates that any other error occurred.

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: Yes
  • 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
• API group
  • Init: Yes
  • Runtime: Yes
  • De-Init: Yes

DevBlkCDIEnableErrorReport()

NvMediaStatus DevBlkCDIEnableErrorReport

(

DevBlkCDIRootDevice const *

device

)

Enable the error report.

Parameters

[in]

device

A pointer to the device to use.

Returns

NvMediaStatus The completion status of the operation. Possible values are:

• NVMEDIA_STATUS_OK
• NVMEDIA_STATUS_BAD_PARAMETER if any of the input parameter is NULL. by the device driver.
• NVMEDIA_STATUS_ERROR if any other error occurred.

DevBlkCDIGetCamPowerControlInfo()

NvMediaStatus DevBlkCDIGetCamPowerControlInfo	(	DevBlkCDIDevice *	device,
		DevBlkCDIPowerControlInfo *	camPwrControlInfo
	)

Get the camera's power control information.

Parameters

[in]	device	A pointer to the device to use.
[out]	camPwrControlInfo	A structure that holds the power control information for camera module.

Returns

NvMediaStatus The completion status of the operation. Possible values are:

• NVMEDIA_STATUS_OK
• NVMEDIA_STATUS_BAD_PARAMETER if any of the input parameter is NULL. by the device driver.
• NVMEDIA_STATUS_ERROR if any other error occurred.

DevBlkCDIGetDesPowerControlInfo()

NvMediaStatus DevBlkCDIGetDesPowerControlInfo	(	DevBlkCDIDevice *	device,
		DevBlkCDIPowerControlInfo *	desPwrControlInfo
	)

Get the deserialzer's power control information.

Parameters

[in]	device	A pointer to the device to use.
[out]	desPwrControlInfo	A structure that holds the power control information for deserializer.

Returns

NvMediaStatus The completion status of the operation. Possible values are:

• NVMEDIA_STATUS_OK
• NVMEDIA_STATUS_BAD_PARAMETER if any of the input parameter is NULL. by the device driver.
• NVMEDIA_STATUS_ERROR if any other error occurred.

DevBlkCDIGetSensorAttributes()

NvMediaStatus DevBlkCDIGetSensorAttributes	(	DevBlkCDIDevice *	device,
		DevBlkCDISensorAttributes *	sensorAttr,
		const size_t	sensorAttrStructSize
	)

Queries the sensor attributes.

Sensor attributes are static properties like sensor name, exposure-gain ranges supported, and number of active exposures.

Note

This function invokes the device driver function specified by the call to GetSensorAttributes().

Parameters

[in]	device	A pointer to the device to use; Valid value: [non-NULL].
[out]	sensorAttr	A pointer to the sensor attributes structure; Valid value: [non-NULL].
[in]	sensorAttrStructSize	Size of the sensorAttr, in bytes; The size must > 0.

Return values

NVMEDIA_STATUS_OK	Indicates that the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER	Indicates that one or more pointer parameters was NULL.
NVMEDIA_STATUS_NOT_SUPPORTED	Indicates that the device driver does not support this functionality.
NVMEDIA_STATUS_ERROR	Indicates that any other error occurred.

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: No
  • 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
• API group
  • Init: Yes
  • Runtime: No
  • De-Init: No

DevBlkCDIParseBotEmbDataInfo()

NvMediaStatus DevBlkCDIParseBotEmbDataInfo	(	DevBlkCDIDevice *	device,
		const DevBlkCDIEmbeddedDataChunk *	embeddedBotDataChunk,
		const size_t	embeddedDataChunkStructSize,
		DevBlkCDIEmbeddedDataInfo *	embeddedDataInfo,
		const size_t	dataInfoStructSize
	)

DevBlkCDIParseTopEmbDataInfo()

NvMediaStatus DevBlkCDIParseTopEmbDataInfo	(	DevBlkCDIDevice *	device,
		const DevBlkCDIEmbeddedDataChunk *	embeddedTopDataChunk,
		const size_t	embeddedDataChunkStructSize,
		DevBlkCDIEmbeddedDataInfo *	embeddedDataInfo,
		const size_t	dataInfoStructSize
	)

Parses sensor embedded data info and provides sensor image settings information for the captured frame.

This function needs to be implemented in the sensor device driver to retrieve sensor image settings like exposure, gain and white balance gain information applied to the frame.

Note

This function invokes the device driver function specified by the call to ParseEmbedDataInfo().

Parameters

[in]	device	A pointer to the device to use; Valid value: [non-NULL].
[in]	embeddedTopDataChunk	A pointer to the top sensor embedded data DevBlkCDIEmbeddedDataChunk structure; Valid value: [non-NULL].
[in]	embeddedBotDataChunk	A pointer to the bottom sensor embedded data DevBlkCDIEmbeddedDataChunk structure; Valid value: [non-NULL].
[in]	embeddedDataChunkStructSize	Size of the embeddedTopDataChunk and embeddedBotDataChunk structures, in bytes; The size must > 0.
[out]	embeddedDataInfo	A pointer to the parsed embedded data info structure; Valid value: [non-NULL].
[in]	dataInfoStructSize	Size of the embeddedDataInfo structure, in bytes; The size must > 0.

Return values

NVMEDIA_STATUS_OK	Indicates that the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER	Indicates that one or more pointer parameters was NULL or invalid.
NVMEDIA_STATUS_NOT_SUPPORTED	Indicates that the device driver does not support this functionality.
NVMEDIA_STATUS_ERROR	Indicates that any other error occurred.

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: Yes
  • 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
• API group
  • Init: No
  • Runtime: Yes
  • De-Init: No

DevBlkCDISetSensorControls()

NvMediaStatus DevBlkCDISetSensorControls	(	DevBlkCDIDevice *	device,
		const DevBlkCDISensorControl *	sensorControl,
		const size_t	sensrCtrlStructSize
	)

Sets sensor control parameters.

This function needs to be implemented in the sensor device driver to control sensor image settings like exposure time, sensor gain, and white balance gain. All parameters provided to this function are applied together at a frame boundary through the "group hold" functionality, if supported by the sensor.

Note

This function invokes the device driver function specified by the call to SetSensorControls().

Parameters

[in]	device	A pointer to the device to use; Valid value: [non-NULL].
[in]	sensorControl	A pointer to a sensor control structure for device; Valid value: [non-NULL].
[in]	sensrCtrlStructSize	Size of the sensorControl structure, in bytes. The size must > 0.

Return values

NVMEDIA_STATUS_OK	Indicates that the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER	Indicates that one or more pointer parameters was NULL.
NVMEDIA_STATUS_NOT_SUPPORTED	Indicates that the device driver does not support this functionality.
NVMEDIA_STATUS_ERROR	Indicates that any other error occurred.

Usage considerations

• Allowed context for the API call
  • Interrupt handler: No
  • Signal handler: No
  • Thread-safe: Yes
  • 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
• API group
  • Init: No
  • Runtime: Yes
  • De-Init: No