Camera Device Interface

Detailed Description

The Camera Device Interface API encompasses all DevBlk I2C control related functions, including programming of all I2C controlled components such as deserializers, serializers, EEPROMs, and image sensors.

DevBlkCDI needs a device driver for each attached device. This provides the flexibility of adding new devices easily.

Data Structures
struct	DevBlkCDIDevice
	Holds the handles for an DevBlkCDIDevice object. More...
struct	DevBlkCDIModuleConfig
	Holds the CDI Module ISP configuration. More...

Modules
	Basic CDI Types
	The Camera Device Interface API provides common CDI processing functions.
	CDI Device
	An CDI device represents a device that is attached or linked to the root I2C port.
	CDI Device Driver
	Program elements related to DevBlkCDIDeviceDriver, which defines a device driver. The core DevBlkCDI calls the driver when the client calls the related public DevBlkCDI function.
	CDI Root Device
	Manage DevBlkCDIRootDevice objects, which represent the root of the SIPL device block.

Typedefs
typedef struct DevBlkCDIModuleConfig	DevBlkCDIModuleConfig
	Holds the CDI Module ISP configuration. More...

Enumerations
enum	DevBlkCDIPowerItems {   DEVBLK_CDI_PWR_AGGREGATOR,   DEVBLK_CDI_PWR_LINK_0,   DEVBLK_CDI_PWR_LINK_1,   DEVBLK_CDI_PWR_LINK_2,   DEVBLK_CDI_PWR_LINK_3 }
	CDI Power control items. More...

Functions
NvMediaStatus	DevBlkCDISetSensorCharMode (DevBlkCDIDevice *device, uint8_t expNo)
	Set sensor in characterization mode. More...
NvMediaStatus	DevBlkCDIGetModuleConfig (DevBlkCDIDevice *device, DevBlkCDIModuleConfig *moduleConfig)
	Gets the Module ISP configuration. More...

Typedef Documentation

DevBlkCDIModuleConfig

typedef struct DevBlkCDIModuleConfig DevBlkCDIModuleConfig

Holds the CDI Module ISP configuration.

Enumeration Type Documentation

DevBlkCDIPowerItems

enum DevBlkCDIPowerItems

CDI Power control items.

Enumerator
DEVBLK_CDI_PWR_AGGREGATOR	Aggregator Power.
DEVBLK_CDI_PWR_LINK_0	LINK 0 Power.
DEVBLK_CDI_PWR_LINK_1	LINK 1 PWR.
DEVBLK_CDI_PWR_LINK_2	LINK 2 PWR.
DEVBLK_CDI_PWR_LINK_3	LINK 3 PWR.

Definition at line 2268 of file devblk_cdi.h.

Function Documentation

DevBlkCDIGetModuleConfig()

NvMediaStatus DevBlkCDIGetModuleConfig	(	DevBlkCDIDevice *	device,
		DevBlkCDIModuleConfig *	moduleConfig
	)

Gets the Module ISP configuration.

Precondition

device must be valid DevBlkCDIDevice handle created with DevBlkCDIDeviceCreate().

Parameters

[in]	device	A pointer to the device to use.
[out]	moduleConfig	A pointer to the module ISP configuration.

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.
• NVMEDIA_STATUS_NOT_SUPPORTED if the functionality is not supported by the device driver.
• NVMEDIA_STATUS_ERROR if 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

DevBlkCDISetSensorCharMode()

NvMediaStatus DevBlkCDISetSensorCharMode	(	DevBlkCDIDevice *	device,
		uint8_t	expNo
	)

Set sensor in characterization mode.

Description

DevBlkCDISetSensorCharMode API provides ability for the user to configure the sensor for characterization. Sensor characterization provides optimal parameters, corresponding to sensor physical and functional characteristics, for image processing.
Sensor characterization for High Dynamic Range (HDR) sensors with multiple exposures (T1, T2, … , Tn ) involves characterizing individual exposures separately, if required by the sensor. This API provides the ability to configure sensor to capture each exposure separately, if required by sensor characterization. This function re-configures the sensor i.e. changes the sensor static attributes like numActiveExposures, sensorExpRange, sensorGainRange and hence, should be called during sensor initialization time. In order to characterize the sensor exposure number ‘n’, where n = {1,2,3, … , N} for N-exposure HDR sensor, the input parameter ‘expNo’ should be set to ‘n’.
For a non-HDR sensor, the input parameter ‘expNo’ should always be set to ‘1’.

Precondition

device must be valid DevBlkCDIDevice handle created with DevBlkCDIDeviceCreate().

Parameters

[in]	device	A pointer to the sensor control device in use.
[in]	expNo	Sensor exposure number to be used for characterization. Valid range for expNo : [0, (DEVBLK_CDI_MAX_EXPOSURES-1)] For Non-HDR sensor, this should be set to '1'

Returns

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

• NVMEDIA_STATUS_OK if successful.
• NVMEDIA_STATUS_BAD_PARAMETER if an input parameter is NULL or invalid.
• NVMEDIA_STATUS_NOT_SUPPORTED if the functionality is not supported by the device driver.
• NVMEDIA_STATUS_ERROR if some 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