devicetree: bindings: Document qcom board compatible format
authorStephen Boyd <sboyd@codeaurora.org>
Fri, 20 Nov 2015 23:31:16 +0000 (15:31 -0800)
committerAndy Gross <andy.gross@linaro.org>
Wed, 24 Feb 2016 05:48:29 +0000 (23:48 -0600)
commitb32e592d3c28f10dc4fd2d55dd14d47deb5f8532
treed852017060077e1fd57a955f6c511e9cb1f39f6f
parent46fb5280a0c88a7cf66333cd67a0159bd732ce3b
devicetree: bindings: Document qcom board compatible format

Some qcom based bootloaders identify the dtb blob based on a set
of device properties like SoC, platform, PMIC, and revisions of
those components. In downstream kernels, these values are added
to the different component dtsi files (i.e. pmic dtsi file, SoC
dtsi file, board dtsi file, etc.) via qcom specific DT
properties. The dtb files are parsed by a program called dtbTool
that picks out these properties and creates a table of contents
binary blob with the property information and some offsets into
the concatenation of all the dtbs (termed a QCDT image).

The suggestion is to do this via the board compatible string
instead, because these qcom specific properties are never used by
the kernel. Add a document describing the format of the
compatible string that encodes all this information that's
currently encoded in the qcom,{msm-id,board-id,pmic-id}
properties in downstream devicetrees. Future bootloaders may be
updated to look at the compatible field instead of looking for
the table of contents image. For non-updateable bootloaders, a
new dtbTool program will parse the compatible string and generate
a QCDT image from it.

Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Andy Gross <andy.gross@linaro.org>
Documentation/devicetree/bindings/arm/qcom.txt [new file with mode: 0644]