NVIDIA DRIVE OS Linux SDK API Reference

5.1.12.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

Detailed Description

The Image Sensor Control API provides common ISC processing functions.

Macros

#define NVMEDIA_ISC_VERSION_MAJOR   3
 Major version number. More...
 
#define NVMEDIA_ISC_VERSION_MINOR   2
 Minor Version number. More...
 
#define NVMEDIA_ISC_SIMULATOR_ADDRESS   0xFF1u
 Device address to use for an ISC simulator device. More...
 
#define RDEV_CFG_I2C_BITS   8
 Bits reserved for the I2C bus number in ISC_RDEV_CFG(csi, i2c). More...
 
#define RDEV_CFG_CSI_BITS   (RDEV_CFG_I2C_BITS + 8)
 Bits reserved for the CSI port in ISC_SLV_RDEV_CFG(csi, i2c). More...
 
#define RDEV_CFG_SLV_BIT   (RDEV_CFG_CSI_BITS + 1)
 Bit reserved for the slave mode flag in ISC_SLV_RDEV_CFG(csi, i2c). More...
 
#define ISC_RDEV_CFG(csi, i2c)   (((uint32_t)(csi) << RDEV_CFG_I2C_BITS) | (i2c))
 Macro to create root device configuration with the connected CSI port and I2C bus. More...
 
#define ISC_RDEV_CFG_EX(csi, i2c, disPwrCtrl)
 Extended macro to create root device configuration with the connected CSI port, I2C bus, and an option to disable power control from root device. More...
 
#define ISC_SLV_RDEV_CFG(csi, i2c)   ((i2c) | ((uint32_t)(csi) << RDEV_CFG_I2C_BITS) | ((uint32_t)(1u) << RDEV_CFG_CSI_BITS))
 Macro to create a slave root device configuration with the connected CSI port and I2C bus when the application is run on a slave SoC. More...
 
#define ADV_CONFIG_INIT(cfg, ctx)
 Macro to initialize an NvMediaISCAdvancedConfig object. More...
 
#define NVMEDIA_ISC_MAX_EXPOSURES   (8u)
 Maximum number of exposures. More...
 
#define NVM_ISC_MAX_COLOR_COMPONENT   (4u)
 Maximum number of color components. More...
 
#define NVMEDIA_ISC_MAX_SENSOR_CONTEXTS   (4u)
 Maximum number of sensor contexts. More...
 
#define NVMEDIA_ISC_MAX_PWL_KNEEPOINTS   (64u)
 Maximum number of sensor companding piecewise linear (PWL) curve knee points. More...
 
#define NVMEDIA_ISC_MAX_FRAME_REPORT_BYTES   (4u)
 Maximum number of frame report bytes. More...
 
#define NVMEDIA_ISC_MAX_NUM_TEMPERATURES   (4u)
 Maximum number of sensor temperature values. More...
 
#define NVMEDIA_ISC_MAX_SENSOR_NAME_LENGTH   (32u)
 Maximum possible length of sensor name. More...
 
#define NVMEDIA_ISC_MAX_FUSE_ID_LENGTH   (32u)
 Maximum possible length of sensor fuse id. More...
 

Macro Definition Documentation

#define ADV_CONFIG_INIT (   cfg,
  ctx 
)
Value:
do { \
memset(&cfg, 0, sizeof(cfg)); \
cfg.clientContext = (void *)(ctx); \
} while (0)

Macro to initialize an NvMediaISCAdvancedConfig object.

Clears the parameter and updates with the NvMediaISCAdvancedConfig::clientContext pointer.

Parameters
[in]cfgThe configuration to initialize.
[in]ctxThe clientContext pointer to be updated.

Definition at line 107 of file nvmedia_isc.h.

#define ISC_RDEV_CFG (   csi,
  i2c 
)    (((uint32_t)(csi) << RDEV_CFG_I2C_BITS) | (i2c))

Macro to create root device configuration with the connected CSI port and I2C bus.

Parameters
[in]csiThe CSI port number defined in NvMediaICPInterfaceType.
[in]i2cThe I2C bus number defined in NvMediaISC_I2CPort.

Definition at line 68 of file nvmedia_isc.h.

#define ISC_RDEV_CFG_EX (   csi,
  i2c,
  disPwrCtrl 
)
Value:
((i2c & 0xffu) | \
((uint32_t)(csi & 0xffu) << RDEV_CFG_I2C_BITS) | \
((uint32_t)(disPwrCtrl & 1u) << RDEV_CFG_SLV_BIT))
#define RDEV_CFG_SLV_BIT
Bit reserved for the slave mode flag in ISC_SLV_RDEV_CFG(csi, i2c).
Definition: nvmedia_isc.h:61
#define RDEV_CFG_I2C_BITS
Bits reserved for the I2C bus number in ISC_RDEV_CFG(csi, i2c).
Definition: nvmedia_isc.h:57

Extended macro to create root device configuration with the connected CSI port, I2C bus, and an option to disable power control from root device.

Parameters
[in]csiThe CSI port number defined in NvMediaICPInterfaceType.
[in]i2cThe I2C bus number defined in NvMediaISC_I2CPort.
[in]disPwrCtrlA flag to disable power control. Value may be 0 (root device turns on power for devices in NvMediaISCRootDeviceCreate() and turns off power for devices in NvMediaISCRootDeviceDestroy()) or 1 (root device does not control power for devices in NvMediaISCRootDeviceCreate() and NvMediaISCRootDeviceDestroy()).

Definition at line 85 of file nvmedia_isc.h.

#define ISC_SLV_RDEV_CFG (   csi,
  i2c 
)    ((i2c) | ((uint32_t)(csi) << RDEV_CFG_I2C_BITS) | ((uint32_t)(1u) << RDEV_CFG_CSI_BITS))

Macro to create a slave root device configuration with the connected CSI port and I2C bus when the application is run on a slave SoC.

Parameters
[in]csiThe CSI port number defined in NvMediaICPInterfaceType.
[in]i2cThe I2C bus number defined in NvMediaISC_I2CPort.

Definition at line 97 of file nvmedia_isc.h.

#define NVM_ISC_MAX_COLOR_COMPONENT   (4u)

Maximum number of color components.

Definition at line 117 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_EXPOSURES   (8u)

Maximum number of exposures.

Definition at line 114 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_FRAME_REPORT_BYTES   (4u)

Maximum number of frame report bytes.

Definition at line 129 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_FUSE_ID_LENGTH   (32u)

Maximum possible length of sensor fuse id.

Definition at line 138 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_NUM_TEMPERATURES   (4u)

Maximum number of sensor temperature values.

Definition at line 132 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_PWL_KNEEPOINTS   (64u)

Maximum number of sensor companding piecewise linear (PWL) curve knee points.

Definition at line 126 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_SENSOR_CONTEXTS   (4u)

Maximum number of sensor contexts.

Definition at line 120 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_SENSOR_NAME_LENGTH   (32u)

Maximum possible length of sensor name.

Definition at line 135 of file nvmedia_isc.h.

#define NVMEDIA_ISC_SIMULATOR_ADDRESS   0xFF1u

Device address to use for an ISC simulator device.

Select the NVMEDIA_ISC_I2C_SIMULATOR port to use simulator mode for all devices.

Definition at line 55 of file nvmedia_isc.h.

#define NVMEDIA_ISC_VERSION_MAJOR   3

Major version number.

Definition at line 48 of file nvmedia_isc.h.

#define NVMEDIA_ISC_VERSION_MINOR   2

Minor Version number.

Definition at line 50 of file nvmedia_isc.h.

#define RDEV_CFG_CSI_BITS   (RDEV_CFG_I2C_BITS + 8)

Bits reserved for the CSI port in ISC_SLV_RDEV_CFG(csi, i2c).

Definition at line 59 of file nvmedia_isc.h.

#define RDEV_CFG_I2C_BITS   8

Bits reserved for the I2C bus number in ISC_RDEV_CFG(csi, i2c).

Definition at line 57 of file nvmedia_isc.h.

#define RDEV_CFG_SLV_BIT   (RDEV_CFG_CSI_BITS + 1)

Bit reserved for the slave mode flag in ISC_SLV_RDEV_CFG(csi, i2c).

Definition at line 61 of file nvmedia_isc.h.