![]() |
NVIDIA DRIVE 5.0 Linux SDK API Reference5.0.10.3 Release |
An ISC device represents a device that is attached or linked to the root I2C port.
Data Structures | |
struct | NvMediaISCAdvancedConfig |
Holds the description of the target I2C device. More... | |
struct | NvMediaISCExposureControl |
Exposure control structure. More... | |
struct | NvMediaISCWBGainControl |
Holds the white balance control structure. More... | |
struct | NvMediaISCEmbeddedDataBuffer |
Holds the embedded data buffer structure. More... | |
struct | NvMediaISCEmbeddedData |
Holds the embedded data structure. More... | |
struct | NvMediaISCModuleConfig |
Holds the ISC Module ISP configuration. More... | |
Macros | |
#define | NVMEDIA_ISC_TIMEOUT_INFINITE |
Infinite time-out. More... | |
Typedefs | |
typedef struct NvMediaISCExposureControl | NvMediaISCExposureControl |
Exposure control structure. More... | |
typedef struct NvMediaISCWBGainControl | NvMediaISCWBGainControl |
Holds the white balance control structure. More... | |
typedef struct NvMediaISCEmbeddedData | NvMediaISCEmbeddedData |
Holds the embedded data structure. More... | |
typedef struct NvMediaISCModuleConfig | NvMediaISCModuleConfig |
Holds the ISC Module ISP configuration. More... | |
Enumerations | |
enum | NvMediaISCExposureMode { NVMEDIA_ISC_EXPOSURE_MODE_LONG, NVMEDIA_ISC_EXPOSURE_MODE_SHORT, NVMEDIA_ISC_EXPOSURE_MODE_VERY_SHORT, NVMEDIA_ISC_EXPOSURE_MODE_MAX } |
Exposure mode. More... | |
enum | NvMediaISCPowerItems { NVMEDIA_ISC_PWR_AGGREGATOR, NVMEDIA_ISC_PWR_LINK_0, NVMEDIA_ISC_PWR_LINK_1, NVMEDIA_ISC_PWR_LINK_2, NVMEDIA_ISC_PWR_LINK_3 } |
ISC Power control items. More... | |
Functions | |
NvMediaISCDevice * | NvMediaISCDeviceCreate (NvMediaISCRootDevice *rootDevice, uint32_t *deviceAddressList, uint32_t numDevices, NvMediaISCDeviceDriver *deviceDriver, NvMediaISCAdvancedConfig *advancedConfig) |
Creates an NvMediaISCDevice object. More... | |
void | NvMediaISCDeviceDestroy (NvMediaISCDevice *device) |
Destroys an NvMediaISCDevice device. More... | |
NvMediaStatus | NvMediaISCCheckPresence (NvMediaISCDevice *device) |
Check that the device is present. More... | |
NvMediaStatus | NvMediaISCCheckLink (NvMediaISCDevice *device, uint32_t instanceNumber, uint32_t link) |
check the result of link detection of the numbered instance. More... | |
NvMediaStatus | NvMediaISCSetDefaults (NvMediaISCDevice *device) |
Sets defaults for the device. More... | |
NvMediaStatus | NvMediaISCSetDeviceConfig (NvMediaISCDevice *device, uint32_t enumeratedDeviceConfig) |
Sets enumerated device configuration to the device. More... | |
NvMediaStatus | NvMediaISCReadParameters (NvMediaISCDevice *device, uint32_t parameterType, uint32_t parameterSize, void *parameter) |
Reads device specific parameters. More... | |
NvMediaStatus | NvMediaISCWriteParameters (NvMediaISCDevice *device, uint32_t parameterType, uint32_t parameterSize, void *parameter) |
Writes device specific parameters. More... | |
NvMediaStatus | NvMediaISCParseEmbeddedData (NvMediaISCDevice *device, uint32_t lineCount, uint32_t *lineLength, uint8_t *lineData[], struct NvMediaISCEmbeddedData *parsedInformation) |
Parses embedded data in the captured image. More... | |
NvMediaStatus | NvMediaISCGetSensorFrameId (NvMediaISCDevice *device, uint32_t lineCount, uint32_t *lineLength, uint8_t *lineData[], uint32_t *sensorFrameId) |
Gets sensor frame ID from embedded data. More... | |
NvMediaStatus | NvMediaISCGetTemperature (NvMediaISCDevice *device, float_t *temperature) |
Gets a device temperature. More... | |
NvMediaStatus | NvMediaISCSetExposure (NvMediaISCDevice *device, NvMediaISCExposureControl *exposureControl) |
Sets exposure control parameters. More... | |
NvMediaStatus | NvMediaISCSetWBGain (NvMediaISCDevice *device, NvMediaISCWBGainControl *wbControl) |
Sets white balance control parameters. More... | |
NvMediaStatus | NvMediaISCReadRegister (NvMediaISCDevice *device, uint32_t deviceIndex, uint32_t registerAddress, uint32_t dataByteNumber, uint8_t *dataBuffer) |
Reads a device register. More... | |
NvMediaStatus | NvMediaISCWriteRegister (NvMediaISCDevice *device, uint32_t deviceIndex, uint32_t registerAddress, uint32_t dataByteNumber, uint8_t *dataBuffer) |
Reads a device register. More... | |
NvMediaStatus | NvMediaISCDumpRegisters (NvMediaISCDevice *device) |
Dumps all device register to the standard output. More... | |
NvMediaStatus | NvMediaISCGetErrorStatus (NvMediaISCDevice *device, uint32_t parameterSize, void *parameter) |
Gets error information about an ISC device. More... | |
NvMediaStatus | NvMediaISCRootDeviceRegisterCallback (NvMediaISCRootDevice *device, int32_t sigNum, void(*cbFunc)(void *), void *context) |
Registers a callback function to handle error messages. More... | |
NvMediaStatus | NvMediaISCRootDevicePowerControl (NvMediaISCRootDevice *device, NvMediaISCPowerItems powerItem, NvMediaBool powerOn) |
Turns ON/OFF the power of a specific sub-device. More... | |
NvMediaStatus | NvMediaISCGetSensorAttr (NvMediaISCDevice *device, NvMediaISCSensorAttrType type, uint32_t size, void *attribute) |
Get sensor attribute. More... | |
NvMediaStatus | NvMediaISCGetModuleConfig (NvMediaISCDevice *device, NvMediaISCModuleConfig *moduleConfig) |
Gets the Module ISP configuration. More... | |
NvMediaStatus | NvMediaISCSetBracketedExposure (NvMediaISCDevice *device, uint32_t numExposureControls, NvMediaISCExposureControl *exposureControls) |
Sets bracketed exposure control parameters. More... | |
NvMediaStatus | NvMediaISCSetCompandingCurve (NvMediaISCDevice *device, uint32_t numPoints, NvMediaPoint *kneePoints) |
Sets the companding curve control parameters. More... | |
NvMediaStatus | NvMediaISCRootDeviceGetPowerStatus (NvMediaISCRootDevice *device, NvMediaISCPowerItems powerItem, NvMediaBool *powerStatus) |
Gets the power ON/OFF status of a specific sub-device. More... | |
NvMediaStatus | NvMediaISCRootDeviceEnableSync (NvMediaISCRootDevice *device, NvMediaBool enable) |
Enables or disables PWM for the external synchronization. More... | |
NvMediaStatus | NvMediaISCRootDeviceSetSyncConfig (NvMediaISCRootDevice *device, float_t freq, float_t dutyRatio) |
Sets the PWM frequency and duty. More... | |
NvMediaStatus | NvMediaISCRootDeviceGetSyncConfig (NvMediaISCRootDevice *device, float_t *freq, float_t *dutyRatio) |
Gets the PWM frequency and duty. More... | |
NvMediaStatus | NvMediaISCSetCharacterizationAttr (NvMediaISCDevice *device, NvMediaISCSensorCharAttr type, uint32_t size, void *attribute) |
Set sensor characterization attribute. More... | |
NvMediaStatus | NvMediaISCGetCharacterizationAttr (NvMediaISCDevice *device, NvMediaISCSensorCharAttr type, uint32_t size, void *attribute) |
Get sensor characterization attribute. More... | |
#define NVMEDIA_ISC_TIMEOUT_INFINITE |
Infinite time-out.
Definition at line 669 of file nvmedia_isc.h.
typedef struct NvMediaISCEmbeddedData NvMediaISCEmbeddedData |
Holds the embedded data structure.
typedef struct NvMediaISCExposureControl NvMediaISCExposureControl |
Exposure control structure.
typedef struct NvMediaISCModuleConfig NvMediaISCModuleConfig |
Holds the ISC Module ISP configuration.
typedef struct NvMediaISCWBGainControl NvMediaISCWBGainControl |
Holds the white balance control structure.
Exposure mode.
Definition at line 901 of file nvmedia_isc.h.
enum NvMediaISCPowerItems |
ISC Power control items.
Enumerator | |
---|---|
NVMEDIA_ISC_PWR_AGGREGATOR |
Aggregator Power. |
NVMEDIA_ISC_PWR_LINK_0 |
LINK 0 Power. |
NVMEDIA_ISC_PWR_LINK_1 |
LINK 1 PWR. |
NVMEDIA_ISC_PWR_LINK_2 |
LINK 2 PWR. |
NVMEDIA_ISC_PWR_LINK_3 |
LINK 3 PWR. |
Definition at line 1118 of file nvmedia_isc.h.
NvMediaStatus NvMediaISCCheckLink | ( | NvMediaISCDevice * | device, |
uint32_t | instanceNumber, | ||
uint32_t | link | ||
) |
check the result of link detection of the numbered instance.
[in] | device | The device to use. |
[in] | instanceNumber | The attached device's instance number. |
[in] | link | The specific link defined by the device (optional). |
NvMediaStatus NvMediaISCCheckPresence | ( | NvMediaISCDevice * | device | ) |
Check that the device is present.
[in] | device | The device to use. |
NvMediaISCDevice* NvMediaISCDeviceCreate | ( | NvMediaISCRootDevice * | rootDevice, |
uint32_t * | deviceAddressList, | ||
uint32_t | numDevices, | ||
NvMediaISCDeviceDriver * | deviceDriver, | ||
NvMediaISCAdvancedConfig * | advancedConfig | ||
) |
Creates an NvMediaISCDevice object.
[in] | rootDevice | A pointer to the root device that you created with NvMediaISCRootDeviceCreate(). |
[in] | deviceAddressList | The list of I2C device addresses corresponding to this NvMediaISCDevice object |
[in] | numDevices | The number of I2C addresses in the above list |
[in] | deviceDriver | The driver structure that defines the behavior of the device. |
[in] | advancedConfig | Advanced configuration. |
void NvMediaISCDeviceDestroy | ( | NvMediaISCDevice * | device | ) |
Destroys an NvMediaISCDevice device.
[in] | device | The device to destroy. |
NvMediaStatus NvMediaISCDumpRegisters | ( | NvMediaISCDevice * | device | ) |
Dumps all device register to the standard output.
[in] | device | The device to use. |
NvMediaStatus NvMediaISCGetCharacterizationAttr | ( | NvMediaISCDevice * | device, |
NvMediaISCSensorCharAttr | type, | ||
uint32_t | size, | ||
void * | attribute | ||
) |
Get sensor characterization attribute.
[in] | device | The device to use. |
[in] | type | Sensor characterization attribute type. |
[in] | size | Size of the attribute. |
[out] | attribute | Sensor characterization attribute value. |
NvMediaStatus NvMediaISCGetErrorStatus | ( | NvMediaISCDevice * | device, |
uint32_t | parameterSize, | ||
void * | parameter | ||
) |
Gets error information about an ISC device.
[in] | device | The device to use. |
[in] | parameterSize | Size of the error information structure |
[out] | parameter | Device specific error information structure |
NvMediaStatus NvMediaISCGetModuleConfig | ( | NvMediaISCDevice * | device, |
NvMediaISCModuleConfig * | moduleConfig | ||
) |
Gets the Module ISP configuration.
[in] | device | A pointer to the device to use. |
[out] | moduleConfig | A pointer to the module ISP configuration. |
NvMediaStatus NvMediaISCGetSensorAttr | ( | NvMediaISCDevice * | device, |
NvMediaISCSensorAttrType | type, | ||
uint32_t | size, | ||
void * | attribute | ||
) |
Get sensor attribute.
[in] | device | The device to use. |
[in] | type | Sensor attribute type. |
[in] | size | Size of the attribute. |
[out] | attribute | Sensor attribute value. |
NvMediaStatus NvMediaISCGetSensorFrameId | ( | NvMediaISCDevice * | device, |
uint32_t | lineCount, | ||
uint32_t * | lineLength, | ||
uint8_t * | lineData[], | ||
uint32_t * | sensorFrameId | ||
) |
Gets sensor frame ID from embedded data.
[in] | device | The device to use. |
[in] | lineCount | Number of lines to parse. |
[in] | lineLength | Line length of each line in bytes. |
[in] | lineData | Array of pointers containing the line data. |
[out] | sensorFrameId | The sensor frame ID. This information is device-specific. |
NvMediaStatus NvMediaISCGetTemperature | ( | NvMediaISCDevice * | device, |
float_t * | temperature | ||
) |
Gets a device temperature.
[in] | device | The device to use. |
[out] | temperature | The device's temperature in Celsius. |
NvMediaStatus NvMediaISCParseEmbeddedData | ( | NvMediaISCDevice * | device, |
uint32_t | lineCount, | ||
uint32_t * | lineLength, | ||
uint8_t * | lineData[], | ||
struct NvMediaISCEmbeddedData * | parsedInformation | ||
) |
Parses embedded data in the captured image.
[in] | device | The device to use. |
[in] | lineCount | Number of lines to parse. |
[in] | lineLength | Line length of each line in bytes. |
[in] | lineData | Array of pointers containing the line data. |
[out] | parsedInformation | Pointer to the parsed information structure. This information is device specific. |
NvMediaStatus NvMediaISCReadParameters | ( | NvMediaISCDevice * | device, |
uint32_t | parameterType, | ||
uint32_t | parameterSize, | ||
void * | parameter | ||
) |
Reads device specific parameters.
This read is implemented in the device driver and the device driver's header file contains the definitions for the parameters.
[in] | device | The device to use. |
[in] | parameterType | Device specific parameter type. |
[in] | parameterSize | Size of the parameter structure |
[out] | parameter | Device specific parameter |
NvMediaStatus NvMediaISCReadRegister | ( | NvMediaISCDevice * | device, |
uint32_t | deviceIndex, | ||
uint32_t | registerAddress, | ||
uint32_t | dataByteNumber, | ||
uint8_t * | dataBuffer | ||
) |
Reads a device register.
[in] | device | The device to use. |
[in] | deviceIndex | The index of the device address passed during NvMediaISCDeviceCreate. |
[in] | registerAddress | The register address to read from. |
[in] | dataByteNumber | Number of bytes to read. |
[in] | dataBuffer | The data buffer to read to. |
NvMediaStatus NvMediaISCRootDeviceEnableSync | ( | NvMediaISCRootDevice * | device, |
NvMediaBool | enable | ||
) |
Enables or disables PWM for the external synchronization.
[in] | device | The root device to use. |
[in] | enable | The PWM state. Possible values are: NVMEDIA_TRUE PWM is enabled. NVMEDIA_FALSE PWM is disabled. |
NvMediaStatus NvMediaISCRootDeviceGetPowerStatus | ( | NvMediaISCRootDevice * | device, |
NvMediaISCPowerItems | powerItem, | ||
NvMediaBool * | powerStatus | ||
) |
Gets the power ON/OFF status of a specific sub-device.
[in] | device | The root device to use. |
[in] | powerItem | The power item to get power status in the root device. |
[in] | powerStatus | The power state of the power item provided Possible values are: NVMEDIA_TRUE power is on NVMEDIA_FALSE power is off |
NvMediaStatus NvMediaISCRootDeviceGetSyncConfig | ( | NvMediaISCRootDevice * | device, |
float_t * | freq, | ||
float_t * | dutyRatio | ||
) |
Gets the PWM frequency and duty.
[in] | device | The root device to use. |
[out] | freq | PWM frequency. |
[out] | dutyRatio | High level ratio in one PWM period. |
NvMediaStatus NvMediaISCRootDevicePowerControl | ( | NvMediaISCRootDevice * | device, |
NvMediaISCPowerItems | powerItem, | ||
NvMediaBool | powerOn | ||
) |
Turns ON/OFF the power of a specific sub-device.
[in] | device | The root device to use. |
[in] | powerItem | The power item to control the power in the root device. |
[in] | powerOn | The power state after this call. Possible values are:
|
NvMediaStatus NvMediaISCRootDeviceRegisterCallback | ( | NvMediaISCRootDevice * | device, |
int32_t | sigNum, | ||
void(*)(void *) | cbFunc, | ||
void * | context | ||
) |
Registers a callback function to handle error messages.
[in] | device | The root device to use. |
[in] | sigNum | The signal number to use for notifying errors. |
[in] | cbFunc | The callback function to handle the signal. |
[in] | context | Can be used to store local context. |
NvMediaStatus NvMediaISCRootDeviceSetSyncConfig | ( | NvMediaISCRootDevice * | device, |
float_t | freq, | ||
float_t | dutyRatio | ||
) |
Sets the PWM frequency and duty.
[in] | device | The root device to use. |
[in] | freq | PWM frequency. |
[in] | dutyRatio | High level ratio in one PWM period. |
NvMediaStatus NvMediaISCSetBracketedExposure | ( | NvMediaISCDevice * | device, |
uint32_t | numExposureControls, | ||
NvMediaISCExposureControl * | exposureControls | ||
) |
Sets bracketed exposure control parameters.
[in] | device | A pointer to the device to use. |
[in] | numExposureControls | Number of entries in exposureControls array |
[in] | exposureControls | An array of exposure control parameters. |
NvMediaStatus NvMediaISCSetCharacterizationAttr | ( | NvMediaISCDevice * | device, |
NvMediaISCSensorCharAttr | type, | ||
uint32_t | size, | ||
void * | attribute | ||
) |
Set sensor characterization attribute.
[in] | device | The device to use. |
[in] | type | Sensor characterization attribute type. |
[in] | size | Size of the attribute. |
[out] | attribute | Sensor characterization attribute value. |
NvMediaStatus NvMediaISCSetCompandingCurve | ( | NvMediaISCDevice * | device, |
uint32_t | numPoints, | ||
NvMediaPoint * | kneePoints | ||
) |
Sets the companding curve control parameters.
[in] | device | A pointer to the device to use. |
[in] | numPoints | Number of points in the kneePoints array |
[in] | kneePoints | An array of points |
NvMediaStatus NvMediaISCSetDefaults | ( | NvMediaISCDevice * | device | ) |
Sets defaults for the device.
[in] | device | The device to use. |
NvMediaStatus NvMediaISCSetDeviceConfig | ( | NvMediaISCDevice * | device, |
uint32_t | enumeratedDeviceConfig | ||
) |
Sets enumerated device configuration to the device.
This configuration is device specific and it is defined in the device driver's header file.
[in] | device | The device to use. |
[in] | enumeratedDeviceConfig | Configuration number. |
NvMediaStatus NvMediaISCSetExposure | ( | NvMediaISCDevice * | device, |
NvMediaISCExposureControl * | exposureControl | ||
) |
Sets exposure control parameters.
[in] | device | A pointer to the device to use. |
[out] | exposureControl | A pointer to exposure control parameters. |
NvMediaStatus NvMediaISCSetWBGain | ( | NvMediaISCDevice * | device, |
NvMediaISCWBGainControl * | wbControl | ||
) |
Sets white balance control parameters.
[in] | device | The device to use. |
[out] | wbControl | White Balance control parameters. |
NvMediaStatus NvMediaISCWriteParameters | ( | NvMediaISCDevice * | device, |
uint32_t | parameterType, | ||
uint32_t | parameterSize, | ||
void * | parameter | ||
) |
Writes device specific parameters.
This write is implemented in the device driver and the device driver's header file contains the definitions for the parameters.
[in] | device | The device to use. |
[in] | parameterType | Device specific parameter type. |
[in] | parameterSize | Size of the parameter structure |
[in] | parameter | Device specific parameter. |
NvMediaStatus NvMediaISCWriteRegister | ( | NvMediaISCDevice * | device, |
uint32_t | deviceIndex, | ||
uint32_t | registerAddress, | ||
uint32_t | dataByteNumber, | ||
uint8_t * | dataBuffer | ||
) |
Reads a device register.
[in] | device | The device to use. |
[in] | deviceIndex | The index of the device address passed during NvMediaISCDeviceCreate. |
[in] | registerAddress | The register address to write to. |
[in] | dataByteNumber | Number of bytes to write. |
[in] | dataBuffer | The data buffer to be written to the register. |