NVIDIA DRIVE OS Linux API Reference

5.1.3.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   2
 Major Version number. More...
 
#define NVMEDIA_ISC_VERSION_MINOR   7
 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 to contain I2C bus number in ISC_RDEV_CFG(csi, i2c). More...
 
#define RDEV_CFG_CSI_BITS   (RDEV_CFG_I2C_BITS + 8)
 Bits reserved to contain CSI port in ISC_SLV_RDEV_CFG(csi, i2c). More...
 
#define RDEV_CFG_SLV_BIT   (RDEV_CFG_CSI_BITS + 1)
 Bit reserved to contain 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 to generate the configuration of the root device by its connected CSI port and I2C bus. More...
 
#define ISC_RDEV_CFG_EX(csi, i2c, disPwrCtrl)
 Extended macro to create root device configuration to generate the configuration of the root device by its connected CSI port and I2C bus with 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 when the application is being run on slave tegra. More...
 
#define ADV_CONFIG_INIT(cfg, ctx)
 Macro to initialize NvMediaISCAdvancedConfig parameter. 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 piece wise 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...
 
#define NVMEDIA_ISC_TIMEOUT_INFINITE
 Infinite time-out. More...
 

Typedefs

typedef void NvMediaISCDevice
 Holds an opaque handle representing a NvMediaISCDevice object. More...
 
typedef void NvMediaISCDriverHandle
 Holds an opaque handle representing an NvMediaISCDevice driver. More...
 
typedef void NvMediaISCTransactionHandle
 Holds an opaque handle representing a device transaction used by the device driver. 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 NvMediaISCAdvancedConfig parameter.

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 105 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 to generate the configuration of the root device by its 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 71 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 to contain slave mode flag in ISC_SLV_RDEV_CFG(csi, i2c).
Definition: nvmedia_isc.h:63
#define RDEV_CFG_I2C_BITS
Bits reserved to contain I2C bus number in ISC_RDEV_CFG(csi, i2c).
Definition: nvmedia_isc.h:59

Extended macro to create root device configuration to generate the configuration of the root device by its connected CSI port and I2C bus with 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]disPwrCtrlThe flag to disable power control, possible values are 0 or 1. If the value is 0, root device will turn on the power of devices in NvMediaISCRootDeviceCreate. If the value is 1, root device won't turn on the power of devices in NvMediaISCRootDeviceCreate.

Definition at line 84 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 when the application is being run on slave tegra.

to generate the configuration of the root device by its 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 96 of file nvmedia_isc.h.

#define NVM_ISC_MAX_COLOR_COMPONENT   (4u)

Maximum number of color components.

Definition at line 119 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 135 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_FUSE_ID_LENGTH   (32u)

Maximum possible length of sensor fuse id.

Definition at line 150 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_NUM_TEMPERATURES   (4u)

Maximum number of sensor temperature values.

Definition at line 140 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_PWL_KNEEPOINTS   (64u)

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

Definition at line 130 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_SENSOR_CONTEXTS   (4u)

Maximum number of sensor contexts.

Definition at line 124 of file nvmedia_isc.h.

#define NVMEDIA_ISC_MAX_SENSOR_NAME_LENGTH   (32u)

Maximum possible length of sensor name.

Definition at line 145 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 57 of file nvmedia_isc.h.

#define NVMEDIA_ISC_TIMEOUT_INFINITE

Infinite time-out.

Definition at line 157 of file nvmedia_isc.h.

#define NVMEDIA_ISC_VERSION_MAJOR   2

Major Version number.

Definition at line 51 of file nvmedia_isc.h.

#define NVMEDIA_ISC_VERSION_MINOR   7

Minor Version number.

Definition at line 53 of file nvmedia_isc.h.

#define RDEV_CFG_CSI_BITS   (RDEV_CFG_I2C_BITS + 8)

Bits reserved to contain CSI port in ISC_SLV_RDEV_CFG(csi, i2c).

Definition at line 61 of file nvmedia_isc.h.

#define RDEV_CFG_I2C_BITS   8

Bits reserved to contain I2C bus number in ISC_RDEV_CFG(csi, i2c).

Definition at line 59 of file nvmedia_isc.h.

#define RDEV_CFG_SLV_BIT   (RDEV_CFG_CSI_BITS + 1)

Bit reserved to contain slave mode flag in ISC_SLV_RDEV_CFG(csi, i2c).

Definition at line 63 of file nvmedia_isc.h.

Typedef Documentation

typedef void NvMediaISCDevice

Holds an opaque handle representing a NvMediaISCDevice object.

Definition at line 173 of file nvmedia_isc.h.

typedef void NvMediaISCDriverHandle

Holds an opaque handle representing an NvMediaISCDevice driver.

Definition at line 183 of file nvmedia_isc.h.

Holds an opaque handle representing a device transaction used by the device driver.

Definition at line 189 of file nvmedia_isc.h.