# Sensor information nodes Source: [https://docs.qualcomm.com/doc/80-88500-1/topic/60_Sensor_information_nodes.html](https://docs.qualcomm.com/doc/80-88500-1/topic/60_Sensor_information_nodes.html) ## slaveInfo This node specifies the information that the sensor driver uses while probing the sensor. The following table lists the fields available in the `slaveInfo` node: Table : Sensor slave information node | Field | Description | | --- | --- | | `slaveInfo` | Contains the sensor slave information and power settings. | | `sensorName` | Specifies name of the sensor.



Example: imx230 | | `slaveAddress` | Specifies slave address (8‑bit or 10‑bit)



Example: For 0x20 slave address, the field value is 32. | | `regAddrType` | Specifies register address size in bytes.



Example:
| | `regDataType` | Specifies register data size in bytes.



Example:
| | `sensorIdRegAddr` | Specifies register address for sensor ID.



Example: 22 | | `sensorId` | Specifies ID of the sensor ID.



Example: 560 | | `sensorIDMask` | Specifies mask for sensor ID.



Example: 4294967295 | | `i2cFrequencyMode` | Specifies I^2^C frequency mode of slave.



The supported frequency modes are:


Example: FAST | | `powerUpSequence` | Contains the power-up configuration sequence required to control the power to the device while turning it on.



Example:






RESET
0
0

Copy to clipboard | | `powerSetting` | Contains power configuration details such as power configuration type, configuration value, and delay. | | `configType` | Specifies power configuration type. Example: MCLK



Supported configuration types are:
| | `configValue` | Specifies power configuration value. Example: 19200000



The recommended value for MCLK is 19200000 (19.2 MHz). | | `delayMs` | Specifies delay in milliseconds.



Example: 1 | | `powerDownSequence` | Contains the power-down configuration sequence that is required to control the power while turning off the device.



Example:




RESET
0
0

Copy to clipboard | | `moduleType` | Specifies the type of sensor module. The supported sensor module types are:
| ## regAddrInfo node This node specifies the configuration of register addresses for various sensor features such as to set gain, frame length lines, and test pattern generation. The following table lists the fields available in the `regAddrInfo` node: Table : regAddrInfo node | Field | Description | | --- | --- | | `regAddrInfo` | Contains the information about the register addresses for various sensor settings. | | `xOutput` | Controls the program width.



Example: If the register address is 0x34C, then the value of this field is 844. | | `yOutput` | Controls the program height.



Example: 846 | | `frameLengthLines` | Programs the frame length lines.



Example: 832 | | `lineLengthPixelClock` | Programs the line length pixel clock.



Example: 834 | | `coarseIntgTimeAddr` | Programs the coarse integration time.



Example: 514 | | `middleCoarseIntgTimeAddr` | Programs the coarse integration time of the middle exposure frame.



Example: 400 | | `shortCoarseIntgTimeAddr` | Programs the coarse integration time of the short exposure frame.



Example: 350 | | `globalGainAddr` | Programs the gain channel.



Example: 516 | | `middleGlobalGainAddr` | Programs the gain channel corresponding to the middle exposure.



Example: 14 | | `shortGlobalGainAddr` | Programs the gain channel corresponding to the short exposure.



Example: 10 | | `digitalGlobalGainAddr` | Programs the digital gain channel.



Example: 3 | | `middleDigitalGlobalGainAddr` | Programs the digital gain channel corresponding to the middle exposure.



Example: 2 | | `shortDigitalGlobalGainAddr` | Programs the digital gain channel corresponding to the short exposure.



Example: 1 | | `digitalGainRedAddr` | Programs the digital gain for the red channel.



This address is optional but is required if supported by the sensor. Example: 528 | | `digitalGainGreenRedAddr` | Programs the digital gain for the green-red channel.



This address is optional but is required if supported by the sensor. Example: 526 | | `digitalGainBlueAddr` | Programs the digital gain for the blue channel.



This address is optional but is required when supported by the sensor.



Example: 530 | | `digitalGainGreenBlueAddr` | Programs the digital gain for the green-blue channel.



The address is optional but is required when supported by the sensor. Example: 532 | | `testPatternRAddr` | Programs the manual test pattern value for the red channel.



Example: 1538 | | `testPatternGRAddr` | Programs the manual test pattern value for the green-red channel.



Example: 1540 | | `testPatternBAddr` | Programs the manual test pattern value for the blue channel.



Example: 1542 | | `testPatternGBAddr` | Programs the manual test pattern value for the green-blue channel.



Example: 1544 | ## resolutionInfo node This node specifies the resolution configuration information. Table : resolutionInfo node | Field | Description | | --- | --- | | `resolutionInfo` | Specifies the configuration and settings for all the resolutions. | | `resolutionData` | Specifies the configuration data for one resolution.



The number of sensor-supported resolutions is equal to the number of `resolutionData` nodes.

Note: First node of the `resolutionData` should always point to the full resolution configuration of the sensor. | | `colorFilterArrangement` | Specifies the color filter arrangement of the sensor.



The supported filter arrangements are:
| | `numPixelsPerColor` | Specifies the number of pixels per color in the color filter arrangement.



The default value is 1. Set this field to 4 for quadra color filter arrangement (QCFA) modes. | | `streamInfo` | Specifies the stream configuration information.



For example:




0
43


0
0
4608
2592

10
IMAGE

Copy to clipboard



Note: The `frameDimension` in each resolution should not be larger than the `activeDimension`. | | `streamConfiguration` | Specifies the stream data information. | | `vc` | Specifies the virtual channel of the data. Valid value range for the virtual channel is from 0 to 31.



The maximum of two virtual channels per stream can be defined, one even and one odd.



These virtual channels must be defined for modes that support the seamless mode switch.



When supporting multiple virtual channels for seamless mode switch as well as staggered high dynamic range (SHDR) or QCFA, add even and odd values for virtual channel.



For details, see the sensor-specific documentation. | | `dt` | Specifies the `DT` of the stream.



Default value is 0x2B (10 bit RAW). | | `frameDimension` | Specifies the frame dimensions. Contains X and Y start coordinates, and the total width and height of the image. | | `xStart` | Specifies the X coordinate of start of the image. | | `yStart` | Specifies the Y coordinate of start of the image. | | `width` | Specifies the width of the image. | | `height` | Specifies the height of the image. | | `bitWidth` | Specifies the bit width of the data. | | `type` | Specifies the stream type. For example: IMAGE.



The supported stream types are:
| | `lineLengthPixelClock` | Specifies line length pixel clock of the frame. Typically, this value is sum of the active width and blanking width. | | `frameLengthLines` | Specifies frame length lines of the frame. Typically, this value is the sum of active height and blanking height. | | `minHorizontalBlanking` | Specifies the minimum horizontal blanking interval in pixels. | | `minVerticalBlanking` | Specifies the minimum vertical blanking interval in lines. | | `outputPixelClock` | This value should be obtained from the sensor vendor for a given mode of operation.

Note: The incorrect setting can cause issues such as PHY/CSID errors, incorrect IFE resource/clock selection. | | `horizontalBinning` | Specifies the horizontal binning value. | | `verticalBinning` | Specifies the vertical binning value. | | `framerate` | Specifies the maximum frame rate. | | `laneCount` | Specifies the number of data lanes on which the sensor sends output data for a given mode of operation. The maximum datalane capability (given in the datasheet) of the sensor along with the sensor register settings configured in the driver determines the value. | | `settleTimeNs` | Specifies the settle time in nanoseconds. This field is configured based on the output characteristics of the sensor to ensure that the PHY transmitter of the sensor does not have synchronization issues with the PHY receiver of the device.


| | `Is3Phase` | Indicates if the sensor is a 3-phase sensor (C-PHY) or 1-phase sensor (D-PHY). | | `resSettings` | Specifies register settings to configure the device for a particular resolution.



Note: Do not add `streamOn` settings for the sensor in the initialization settings, as this setting enables the sensor streaming before the actual software stream is turned on and may cause PHY to miss the LP sequence.



For example:




0x114
0x3
2
1
WRITE
0x0

Copy to clipboard | | `regSetting` | Holds one register configuration and forms a unit of large-resolution register settings sequence. | | `registerAddr` | Specifies the register address that is accessed. | | `registerData` | Specifies the size of data to be read or written.

  • If the operation is WRITE, this field specifies the data value to be written into the specified register address.


  • If the operation is READ, this field specifies the number of bytes to be read from the specified register address.


| | `regAddrType` | Specifies the type of register address. | | `regDataType` | Specifies the type of register data. | | `operation` | Specifies the type of operation. The supported values are:



  • WRITE


  • READ


  • POLL


| | `delayUs` | Specifies the delay in microseconds. If not explicitly specified, the delay is zero. | | `cropInfo` | Specifies the crop information of the frame. For example:





0
0
0
0
Copy to clipboard | | `Left` | Specifies the left crop pixel information. | | `Right` | Specifies the right crop pixel information. | | `Top` | Specifies the top crop pixel information. | | `Bottom` | Specifies the bottom crop pixel information. | | `exposureInfo` | Specifies the resolution-specific exposure control information. Update this field if the resolution-specific exposure control is different from the common resolution exposure control information. If this information is not available, then information from the common exposure control is used. | | `exposureType` | Specifies the information about the exposure type for which the exposure control information is being provided. The supported values are:

  • DEFAULT: corresponds to the long exposure when there are multiple exposures and default exposure for a single exposure mode.


  • SHORT: corresponds to the short exposure when there are multiple exposures.


  • MIDDLE: corresponds to the middle exposure when there are multiple exposures.


| | `coarseIntgTimeAddr` | Specifies register address to program the coarse integration time for this exposure type. | | `globalGainAddr` | Specifies register address to program the gain channel for this exposure type. | | `digitalGlobalGainAddr` | Specifies register address to program the digital gain channel for this exposure type. | | `maxAnalogGain` | Specifies maximum analog gain supported by the sensor. | | `minAnalogGain` | Specifies minimum analog gain supported by the sensor. | | `maxDigitalGain` | Specifies maximum digital gain supported by the sensor. | | `minDigitalGain` | Specifies minimum digital gain supported by the sensor. | | `maxLineCount` | Specifies maximum line count supported by the sensor. | | `minLineCount` | Specifies minimum line count supported by the sensor. | | `verticalOffset` | Specifies minimum offset to be maintained between the line count and frame length lines. | | `frameOffsetInfo` | Holds addresses of various frame offset registers. | | `middleFrameOffsetRegister` | Specifies register address to program the frame-offset value of the middle exposure frame. | | `shortFrameOffsetRegister` | Specifies register address to program the frame-offset value of the short exposure frame. | | `HDRExposureType` | Specifies information about the HDR exposure type of this resolution.



**Note:** This value must be provided for the HDR resolution.



The supported values are:

  • ONEEXPOSURE: indicates that one exposure is used in the HDR mode.


  • TWOEXPOSURE: indicates that both long and short exposures are used in the
    HDR mode.


  • THREEEXPOSURE: indicates that long, middle and short exposures are used in
    the HDR mode.


| | `ZZHDRInfo` | zzHDR color pattern and first exposure information. The supported values are:

  • ZZHDRPattern: represents the zzHDR pattern such as P0P1P0P0


  • ZZHDRFirstExposure: represents whether the short exposure or long exposure field comes first such as SHORTEXPOSURE


| | `HDR3ExposureInfo` | Information of in-sensor HDR 3 exposure.



  • HDR3ExposureType: Exposure type for 3HDR nonseamless mode.


  • numberOfLTCRatioRegCount: Number of LTC ratio registers.


  • sensorLTCRatioAddr: Register address to program LTC ratio.


  • InSensorHDR3ExpLineLengthPixelClock: LineLengthPixelClock for seamless in-sensor HDR 3 exposure mode switching.


  • InSensorHDR3ExpFrameLengthLines: FrameLengthLines for seamless in-sensor HDR 3 exposure mode switching.





  • InSensorHDR3ExpMaxAnalogGain: MaxAnalogGain for seamless in-sensor HDR 3 exposure mode switching.


  • InSensorHDR3ExpStartSettings: StartSetting sequence for seamless in-sensor HDR 3 exposure mode switching.


  • InSensorHDR3ExpStopSettings: StopSetting sequence for seamless in-sensor HDR3 exposure mode switching.


| | `RemosaicTypeInfo` | Specifies the remosaic type. The supported types are:

  • SWRemosaic


  • HWRemosaic


  • NoRemosaic


| | `capability` | Specifies the features or capabilities supported by the sensor. The supported features are:

  • ONFD


  • AONFDMIPI


  • AONMD


  • DEPTH


  • FASTAEC


  • FS


  • HFR


  • IHDR


  • INSENSORZOOM


  • INTERNAL


  • NORMAL


  • PDAF


  • QHDR


  • QUADCFA


  • SHDR


  • ZZHDR


| | `ADCReadoutTime` | Specifies analog-to-digital conversion duration for the sensor. The value is specified in milliseconds. Example: 2. | | `mipiFlags` | Defines any extra MIPI parameters that the receiver should take care of. The supported flags are:



  • EPDEnabled


  • DSKEWCalibEnabled


  • PN9PatternEnabled


| | `maxAnalogGain` | Specifies maximum analog gain supported by current sensor mode. | | `QHDRInfo` | Specifies QCFAHDR feature information.



  • QHDRType:

    • PIXELINTERLEAVED: QCFA format like native pixel arrangement.


    • ROWINTERLEAVED: Each exposure on different line through the same VC-DT.


    • OWINLINEINTERLEAVED: Each exposure on different line through the different VC-DT.






  • QHDRPattern: Valid patterns are MLSM, SMML, MSLM, LMMS, MLMS, SMLM, MSML, and LMSM.

    In direction of readout: first exposure, second exposure, third exposure, fourth exposure.








Note: L is long exposure, M is middle exposure, and S is short exposure. | | `transitionGroups` | Specifies list of seamless mode switch use cases that the sensor mode can support.



The supported modes are:



  • NONE


  • BINCROP43


  • BINQCFA43


  • BINHDR43


  • BINCROP169


  • BINQCFA169


  • BINHDR169


  • SHDR1SHDR2


  • SHDR2SHDR3


  • SHDR1SHDR3


  • SHDRALL


  • TRANSITIONGROUPMAX





For more details, see the imx686 sensor XML file.



`BINCROP43BINCROP169` | If `INSENSORZOOM` is defined, then the resolution information should be the same. For example, assuming Mode 0 `resolutionInfo` is 8000 \* 6000 and Mode 9 is the corresponding mode with `INSENSORZOOM`. So, the Mode 9 `resolutionInfo` should be the same as Mode 0 as there is no sensor reconfiguration during the mode switch, which means the sensor hardware PLL clock settings remain the same in both the modes. The `frameDimension` is based on the sensor full output resolution. For example,`frameDim` = (0,517,4208,2104), `fullResolutionWidth`=4208, and `fullResolutionHeight`=3120. Then, 517 is an invalid value, as 517 \* 2 + 2104 is larger than the frame boundary that is 3120. ## exposureControlInfo node This node specifies the exposure details such as maximum gain, maximum line count, and conversion formulas for gain manipulation. Table : exposureControlInfo node | **Field** | **Description** | | --- | --- | | `exposureControlInfo` | This node holds the information about the exposure details such as maximum gain, maximum line count, and conversion formulas for gain manipulation. Example:





8
2
20
65515
512-(512/realGain)
512/(512-regGain)
Copy to clipboard | | `maxAnalogGain` | Maximum analog gain supported by the sensor. | | `maxDigitalGain` | Maximum digital gain supported by the sensor. | | `verticalOffset` | Minimum offset to be maintained between the line count and frame length lines. | | `maxLineCount` | Maximum line count supported by the sensor. | | `minLineCount` | Minimum line count supported by the sensor. | | `middleMaxLineCount` | Maximum line count supported by the sensor for middle exposure. | | `middleMinLineCount` | Minimum line count supported by the sensor for middle exposure. | | `shortMaxLineCount` | Maximum line count supported by the sensor for short exposure. | | `shortMinLineCount` | Minimum line count supported by the sensor for short exposure. | | `realToRegGain` | Specifies the real gain to register gain equation. The equation must contain real gain. | | `regToRealGain` | Specifies the register gain to real gain equation. The equation must contain register gain in the equation. | ## streamOnSettings node This node specifies the register settings required to start streaming. | **Field** | **Description** | | --- | --- | | `streamOnSettings` | Specifies the sequence of register settings to configure the device to start streaming. Do the following configuration and take the clock and data lanes from LP11 to HS TxState:






0x0100
0x1
2
1
WRITE
0

Copy to clipboard | | `regSetting` | This field contains register address, register data, register address type, register DT, operation, and delay in micro seconds. | | `streamOffSettings` | Specifies the sequence of register settings to configure the device to stop streaming. Do the following configuration and take the clock and data lanes to LP11 state:





0x0100
0x0
2
1
WRITE
0

Copy to clipboard | | `regSetting` | This field contains register address, register data, register address type, register DT, operation, and delay in micro seconds. | ## groupHoldOnSettings node This node specifies the register settings to configure the group hold settings of the device. | **Field** | **Description** | | --- | --- | | `groupHoldOnSettings` | Specifies sequence of register settings to configure the device to start group hold settings.



Example:






0x0104
0x1
2
1
WRITE
0

Copy to clipboard | | `regSetting` | Specifies register address, register data, register address type, register data type, operation, and delay in micro seconds. | | `groupHoldOffSettings` | Specifies sequence of register settings to configure the device to stop group hold settings.



Example:






0x0104
0x0
2
1
WRITE
0

Copy to clipboard | ## initSettings node This node specifies the sequence of register settings required to initialize the sensor. | **Field** | **Description** | | --- | --- | | `initSettings` | Sequence of register settings to initialize the sensor.



**Note**: Do not add `stream on` settings for the sensor in the initialization settings, as this setting enables the sensor streaming before the actual software stream turns on and may cause PHY to miss the LP sequence.



Example:






0x136
0x18
2
1
WRITE
0

Copy to clipboard | | `regSetting` | Specifies register settings such as register address, register data, register address type, register data type, operation, and delay in micro seconds. | ## testPatternInfo node This node specifies the information about the register settings required for test pattern generation. | **Field** | **Description** | | --- | --- | | `testPatternInfo` | Contains the register settings information about the test pattern generation
node.



Example:






OFF


0x136
0x18
2
1
WRITE
0



Copy to clipboard | ## testPatternData node This node specifies the information about the test pattern data. | **Field** | **Description** | | --- | --- | | `testPatternData` | This node holds the register and mode settings of a particular test pattern. | | `Mode` | The supported modes are:



  • OFF


  • SOLID_COLOR


  • COLOR_BARS


  • COLOR_BARS_FADE_TO_GRAY


  • PN9


  • CUSTOM1


| | `settings` | Sequence of register settings to configure the test pattern on the sensor. | | `regSetting` | This field contains register address, register data, register address type, register data type, operation, and delay in micro seconds. | ## colorLevelInfo node The node specifies the color level information such as details about the various channels present in complete dark light. Table : colorLevelInfo node | **Field** | **Description** | | --- | --- | | `colorLevelInfo` | Specifies color level information.



Defaults to current values in various channels in complete dark light.



Example:





1023
64
64
64
64
Copy to clipboard | | `whiteLevel` | Specifies value for White level . | | `rPedestal` | Specifies pedestal value for the red channel. | | `grPedestal` | Specifies pedestal value for the green-red channel. | | `bPedestal` | Specifies pedestal value for the blue channel. | | `gbPedestal` | Specifies pedestal value for the green-blue channel. | Table : Black region information | **Field** | **Description** | | --- | --- | | `opticalBlackRegionInfo` | Specifies information about black regions. Multiple black regions are provided, if applicable.



Example:






0
0
4608
2592

Copy to clipboard | | `dimension` | Specifies frame dimension. Contains `xStart`, `yStart`, `width`, and `height` fields. | | `xStart` | Specifies starting coordinate of the region on the X-axis. | | `yStart` | Specifies starting coordinate of the region on the Y-axis. | | `width` | Specifies width of the region. | | `height` | Specifies height of the region. | Table : Pixel array information | **Field** | **Description** | | --- | --- | | `pixelArrayInfo` | Specifies information about the pixel array such as active dimension, dummy pixels width. | | `activeDimension` | Width and height of the frame or subframe.



Example:





0
0
4608
2592
Copy to clipboard | | `xStart` | Specifies starting coordinate of the frame on the X-axis. | | `yStart` | Specifies starting coordinate of the frame on the Y-axis. | | `width` | Total width of the frame in pixels. | | `height` | Total height of the frame in pixels. | | `dummyInfo` | Specifies dummy pixels surrounding the active pixel array.



Example:





0
0
0
0
Copy to clipboard | | `left` | Specifies starting coordinate of the left dummy pixel. | | `right` | Specifies starting coordinate of the right dummy pixel. | | `top` | Specifies starting coordinate of the top dummy pixel. | | `bottom` | Specifies starting coordinate of the bottom dummy pixel. | Table : Delay information | **Field** | **Description** | | --- | --- | | `linecount` | Specifies number of frames required to apply the line count. | | `gain` | Specifies number of frames required to apply the gain. | | `maxPipeline` | Specifies maximum pipeline delay in number of frames. | | `frameSkip` | Specifies number of initial bad frames to skip. | | `frameLengthLines` | Specifies number of frames required to apply frame length lines. | | `modeSwitch` | Specifies number of frames required to apply mode switch settings. | | `virtualChannelSwitch` | Specifies number of frames required to apply virtual channel settings. | Table : Sensor property information | **Field** | **Description** | | --- | --- | | `sensorProperty` | Specifies sensor property information. Example:





0
0
ONE_CHIP_COLOR_AREA
Copy to clipboard | | `pixelSize` | Specifies pixel size in micro meters. | | `cropFactor` | Specifies crop factor. | | `sensingMethod` | Specifies sensing method of the sensor. The supported sensing methods are:



  • UNDEFINED


  • ONE_CHIP_COLOR_AREA TWO_CHIP_COLOR_AREA


  • THREE_CHIP_COLOR_AREA


  • COLOR_SEQUENCE_AREA


  • TRILINEAR


  • COLOR_SEQUENCE_LINEAR


| ## frameSyncInfo node This node specifies the frame sync information required to configure or switch sensor in master/slave mode. Table : Frame sync information | **Field** | **Description** | | --- | --- | | `masterSettings` | Specifies sequence of register settings to configure the sensor to hardware master mode. Valid only when hardware sync is enabled. Example:




< masterSettings>

0x0350
0x0
2
1
WRITE
0

Copy to clipboard | | `slaveSettings` | Specifies sequence of register settings to configure the sensor to hardware slave mode. It is similar to master settings. | Table : Mode switch register information | **Field** | **Description** | | --- | --- | | `modeSwitchRegInfo` | Specifies register settings and virtual channel register addresses to be programmed during seamless mode switch for the following data types:



  • PDAFVCAddress


  • ImageLongVCAddress


  • ImageShortVCAddress


  • ImageMiddleVCAddress


  • BlobVCAddress


  • HDRVCAddress


  • MetaVCAddress





Example:



2
1
0x0110
0x3076
Copy to clipboard | Table : Register setting group information | **Field** | **Description** | | --- | --- | | `registerSettings` | Specifies register settings that must be programmed as a part of this group. | | `registerSettingsType` | Specifies the register setting type. The supported values are:



  • StreamOn: Specifies stream on settings for special use cases.


  • StreamOff: Specifies stream off settings for special use cases.


| | `registerSettingsFlag` | Specifies any settings specially applied for certain use cases. The supported value is `PN9Test`. This value indicates settings to be used during PN9 pattern testing case. | **Parent Topic:** [Sensor software configuration](https://docs.qualcomm.com/doc/80-88500-1/topic/59_Sensor_software_configuration.html) Last Published: Aug 18, 2023 [Previous Topic Sensor software configuration](https://docs.qualcomm.com/bundle/publicresource/80-88500-1/topics/59_Sensor_software_configuration.md) [Next Topic Module configuration](https://docs.qualcomm.com/bundle/publicresource/80-88500-1/topics/61_Module_configuration_.md)