Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9f0da6ca authored by David Keitel's avatar David Keitel
Browse files

ARM: dts: add qcom,pmic-id documentation 



The qcom,pmic-id property specifies the PMIC chips
used on a given platform.

This property is used to runtime select a given device tree
blob based on which PMICs are present on a platform. Thus
the device tree with the closest matching qcom,pmic-id will be
selected by the bootloader.

The property consists of a list of 4-tuples which each include
four 32-bit integers denoting the given PMICs in the order of
ascending global SPMI slave id.

If less than four PMICs are present any unused entries must
be populated with 0x0.

A given PMIC cell is defined as follows:
	bits 31-24 = unused
	bits 23-16 = PMIC major version
	bits 15-8  = PMIC minor version
	bits 7-0   = PMIC model number

The closest match is determined by first matching the PMIC
model number, if any model number does not match the given
device the dtb under consideration is discarded.

Subsequently the closest matching major version and minor
version are matched respectively.

Change-Id: Ice3998cd34ac8c318d1b0ca5655b43557b1c63f9
Signed-off-by: default avatarDavid Keitel <dkeitel@codeaurora.org>
parent af07c85c

Documentation/devicetree/bindings/arm/msm/pmic-id.txt

0 → 100644
+31 −0
Original line number Diff line number Diff line 
* PMIC-ID



The qcom,pmic-id entry specifies the PMIC chips used on a given MSM platform.



It is expected that the bootloader will use this information at boot-up to

decide which device tree to use when given multiple device trees, some of which

may not be compatible with the actual hardware. It is the bootloader's

responsibility to pass the correct device tree to the kernel.



The cell layout of the qcom,pmic-id property is as follows:



    qcom,pmic-id = <pmic1 pmic2 pmic3 pmic4> [, <pmic1 pmic2 pmic3 pmic4> ...];



where a given "pmic#" cell is a 32-bit integer which is defined as follows:

    bits 31-24 = unused

    bits 23-16 = PMIC major version

    bits 15-8  = PMIC minor version

    bits 7-0   = PMIC model number



The PMIC values in each tuple must be listed in ascending order of their global

SPMI slave id for a given board. Note that any missing entries need to be

denoted by 0x0 to complete a given tuple. The ordering of tuples within the

property is arbitrary.



Examples:

    qcom,pmic-id = <0x10009 0x1000A 0x1000C 0x0>;



    qcom,pmic-id = <0x10009 0x1000C 0x0 0x0>;



    qcom,pmic-id = <0x10009 0x1000A 0x0 0x0>,

                   <0x20109 0x1000A 0x0 0x0>;