# EEPROM software configuration
Source: [https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html](https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html)
The EEPROM has an associated XML configuration file used to define calibration
parameters such as PDAF, lens shading calibration (LSC), autofocus (AF), dual camera, and
white balance data.
The entire settings are enclosed in the
`` node of this XML file.
**Parent Topic:** [EEPROM configuration](https://docs.qualcomm.com/doc/80-88500-1/topic/84_EEPROM_bring_up_guidelines.html)
## slaveInfo node
Source: [https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html](https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html)
The `slaveInfo` node contains the information that is used by the driver to power
on or off the EEPROM device. Configuring this node is optional in kernel probe, as in kernel
probe the EEPROM device tree node contains this information.
Table : EEPROM slaveInfo
| Field | Description |
| --- | --- |
| `slaveInfo` | Contains the sensor slave information and power settings. |
| `EEPROMName` | Name of the EEPROM.
Example: atmel\_at24c32e |
| `slaveAddress` | 8‑bit or 10‑bit slave address. Example: 0xa0 |
| `regAddrType` | Register address or data size in bytes. Example 2:
- 1 = byte address
- 2 = word address
- 3 = 3‑byte address
- 4 = address type max
|
| `regDataType` | Register address or data size in bytes. Example 1:
- 1 = byte data
- 2 = word data
- 3 = double word data
- 4 = Data type max
|
| `i2cFrequencyMode` | I^2^C frequency mode of slave. Example: FAST
The supported modes are:
- STANDARD (100 kHz)
- FAST (400 kHz)
- FAST_PLUS (1 MHz)
- CUSTOM (custom frequency in DTSI)
|
| `powerUpSequence` | Contains the power-up configuration sequence required to control the power to the
device while turning it on.
powerSetting: contains power configuration type, value, and
delay.
configType: Power configuration type. The supported types are:
- MCLK
- VANA
- VDIG
- VIO
- VAF
- RESET
- STANDBY
configValue: value for the specified type or 0, to use the
default value.
delayMs: delay in milliseconds.
Example:
VIO
0
0
Copy to clipboard |
| `moduleType` | Type of sensor module. The supported types are: |
## memoryMap node
Source: [https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html](https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html)
The memory map node contains the information that the driver requires to read the one-time
programmable (OTP) data from EEPROM. Configuring this node is optional in the kernel probe
because this information is available in the EEPROM device tree node. But minimum one set of
nodes must be configured, containing the READ operation and the total size of the data in
`registerData`. To read the total size of the data for multiple sets of
`regSetting` nodes, the information is calculated as the sum off all the
`registerData` values corresponding to the READ operation.
Table : EEPROM memoryMap
| Field | Description |
| --- | --- |
| `memoryMap` | Contains `regSetting` node, which has details for read, write, and
poll operations. This field can contain multiple sets of `regSetting`
nodes. |
| `regSetting` | Contains the
`slaveAddr`,`registerAddr`,`registerData`,`regAddrType`,`regDataType`,`operation`,`delayUS`
fields.
Example:
0xa0
0x00
700
2
1
READ
0
0xa1
0x00
800
2
1
READ
0 Copy to clipboard |
| `slaveAddr` | Slave address to communicate with the device. Supports both 8‑bit and 10‑bit slave
address.
Example: 0xa0 |
| `registerAddr` | The register address that is accessed.
Example: 0x00 |
| `registerData` | Register data to be programmed or read.
- For WRITE operation,
registerData is the data value to be
written into the specified register address. Example: 0x02.
- For READ operation,
registerData is the number of bytes to be
read from the specified register address. Example: 1584.
- For POLL operation,
registerData is the value for which the
poll is being done. Example: 0x01.
|
| `regAddrType` | Register address type or data size in bytes.
Example: 2
- 1 = byte address
- 2 = word address
- 3 = 3‑byte address
- 4 = address type max
|
| `regDataType` | Register data type or data size in bytes. Example: 1
- 1 = byte data
- 2 = word data
- 3 = double word data
- 4 = DT max
|
| `operation` | Operation to be performed on EEPROM. The supported operations are: |
| `delayUs` | Delay in micro seconds.
Example: 100 |
## formatInfo node
Source: [https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html](https://docs.qualcomm.com/doc/80-88500-1/topic/85_EEPROM_software_configuration.html)
The `formatInfo` node contains the information needed to format the OTP data
obtained from EEPROM. It is not necessary to have all the subfields configured as each EEPROM
can have some or all types of OTP data and only those fields, whose data is available can be
configured. In the absence of format data information, raw or unformatted data is published to
the metadata pool and that can be used to format and obtain the required data from individual
modules.
Following information is required for formatting the data buffer read from the EEPROM:
- The position of each field, also known as offset with starting position reference as 0.
- Exact number of bits of data of that specific field, that is, size of the field represented in
the form of mask and endianness to know the byte reading order.
In addition to the raw buffer formatting, this structure can also contain other constants that are not part of the buffer data to be configured.
Table : EEPROM formatInfo
| Field | Description |
| --- | --- |
| `macroMargin` | Margin to be extended towards macro region. Example: 0.3 that is, the new
macro value is:
`macro = macro + DACRange × 0.3`
Where,
`DACRange = macro - infinity` |
| `AF` | The autofocus (AF) data information to format the AF OTP data. |
| `autoFocusData` |
isAvailable: indicates whether the AF data is available or not
in the OTP data buffer and valid values are true or false. If this parameter is
set as false, all the remaining fields under AF node will be ignored.
BIG or LITTLE: indicates type of the
endianness.
|
| `macro` |
- offset – Position of the first byte of macro value in the buffer. Example:
22
- mask – Represents the number of valid bits of the data read from offset.
Example: 0xFFF means 2 bytes of data to be read and in that 12 bits contain the
valid data.
- Mask 0 indicates that particular data is not available in the buffer.
The same is applicable for all other fields, which need offset and mask
information. |
| `infinity` |
- offset – Position of the first byte of infinity value in the buffer.
- mask – Represents the number of valid bits of the data.
|
| `hall` |
- offset – Position of the first byte of hall value in the buffer.
- mask – Represents the number of valid bits of the data.
|
| `hallBias` |
- offset – Position of the first byte of hall bias value in the buffer
- mask – Represents the number of valid bits of the data
|
| `hallRegisterAddr` | Register address for hall and hall bias to be programmed.
Example: 0x28 |
| `verticalMacro` | |
| `horizontalMacro` | |
| `verticalInfinity` | |
| `horizontalInfinity` |
- offset – Position of the first byte of horizontal infinity value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `infinityMargin` | Margin to be extended towards infinity region. Example: 0.15, that is, the new
infinity value is:
`infinity = infinity + DACRange ×
0.15`
Where,
`DACRange = macro - infinity` |
| `WB` | White balance (WB) data information to format WB data |
| `WBData` |
isAvailable: indicates whether the WB data is available or not
in the OTP data buffer and valid values are true or false. If this field is set to
false, all the remaining fields under WBData node are
ignored.
BIG or LITTLE: indicates type of the
endianness.
|
| `dataType` | Indicates whether the WB data is available in the form of RATIO or INDIVIDUAL.
- If the data is available in the form of RATIO, then
rOverGValue,
bOverGValue, grOverGBValue fields must be configured.
- If the data is available in the form of INDIVIDUAL, then
rValue,
grValue, bValue, gbValue fields must be configured.
|
| `lightInfo` | Contains the type of the illuminant and corresponding color values based on the
value of `dataType` field. |
| `illuminantType` | Type of the illuminant for which WB data is available.
Supported illuminants are D65, TL84, A, D50, H. |
| `rValue` |
- offset – Position of the first byte of
rValue value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `grValue` |
- offset – Position of the first byte of
grValue value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `bValue` |
- offset – Position of the first byte of
bValue value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `gbValue` |
- offset – Position of the first byte of
gbValue value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `rOverGValue` |
- offset – Position of the first byte of
rOverGValue value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `bOverGValue` |
- offset – Position of the first byte of
bOverGValue value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `grOverGBValue` |
- offset – Position of the first byte of
grOverGBValue value in
the buffer.
- mask – Represents the number of valid bits of the data.
|
| `mirror` |
- offset – Position of the first byte of mirror value in the buffer.
- mask – Represents the number of valid bits of the data.
|
| `flip` |
- offset – Position of the first byte of flip value in the buffer.
- mask – Represents the number of valid bits of the data.
|
| `qValue` | Factor to convert the obtained real values to the required float values. |
| `isInvertGROverGB` | Set to true if `GRoverGB` must be inverted or else set to false. |
| `LSC` | Lens shading calibration (LSC) data needed to format LSC data. |
| `LSCData` |
isAvailable: Indicates whether the LSC data is available or not
in the OTP data buffer and valid values are true or false. If this field is set to
false, all the remaining fields under LSCData node are
ignored.
BIG or LITTLE: indicates type of the
endianness.
|
| `lightInfo` | Contains the type of the illuminant and corresponding LSC gain values. |
| `illuminantType` | Type of the illuminant for which LSC data is available.
Supported illuminants are D65, TL84, A, D50, and H. |
| `rGainMSB` |
- offset – Position of the MSB of the
rGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `rGainLSB` |
- offset – Position of the LSB of the
rGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `grGainMSB` |
- offset – Position of the MSB of the
grGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `grGainLSB` |
- offset – Position of the LSB of the
grGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `gbGainMSB` |
- offset – Position of the MSB of the
gbGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `gbGainLSB` |
- offset – Position of the LSB of the
gbGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `bGainMSB` |
- offset – Position of the MSB of the
bGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `bGainLSB` |
- offset – Position of the LSB of the
bGain value in the
buffer.
- mask – Represents the number of valid bits of the data.
|
| `meshHWRollOffSize` | Mesh hardware rolloff size. |
| `rIncrement` | Value to be incremented to find the next `rGainMSB` and
`rGainLSB` value Example: 5
- If
rGainMSB offset is 28, then the next
rGainMSB offset will be 28+5 = 33. Same applies to other
increments.
- If
rGainLSB offset is 24, then the next
rGainMSB
increments.
|
| `grIncrement` | Value to be incremented to find next `grGainMSB` and
`grGainLSB` values. |
| `gbIncrement` | Value to be incremented to find next `gbGainMSB` and
`gbGainLSB` values. |
| `bIncrement` | Value to be incremented to find next `bGainMSB` and
`bGainLSB` values. |
Last Published: Aug 18, 2023
[Previous Topic
EEPROM configuration](https://docs.qualcomm.com/bundle/publicresource/80-88500-1/topics/84_EEPROM_bring_up_guidelines.md) [Next Topic
slaveInfo node](https://docs.qualcomm.com/bundle/publicresource/80-88500-1/topics/85_EEPROM_software_configuration.md#slaveInfo_node_87)