diff mbox

[v3,09/10] mfd: pm8x41: document device tree bindings

Message ID 88997d3863f72f8553fcaf66cf67fbf3289df04f.1382985169.git.joshc@codeaurora.org (mailing list archive)
State New, archived
Headers show

Commit Message

Josh Cartwright Oct. 28, 2013, 6:12 p.m. UTC
Document the bindings used to describe the Qualcomm 8x41 PMICs.

Signed-off-by: Josh Cartwright <joshc@codeaurora.org>
---
 Documentation/devicetree/bindings/mfd/pm8x41.txt | 33 ++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/pm8x41.txt

Comments

Ivan T. Ivanov Oct. 29, 2013, 2:18 p.m. UTC | #1
Hi Josh,

On Mon, 2013-10-28 at 13:12 -0500, Josh Cartwright wrote: 
> Document the bindings used to describe the Qualcomm 8x41 PMICs.
> 
> Signed-off-by: Josh Cartwright <joshc@codeaurora.org>
> ---
>  Documentation/devicetree/bindings/mfd/pm8x41.txt | 33 ++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/pm8x41.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/pm8x41.txt b/Documentation/devicetree/bindings/mfd/pm8x41.txt
> new file mode 100644
> index 0000000..6afd4ce
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/pm8x41.txt
> @@ -0,0 +1,33 @@
> +Qualcomm PM8841 and PM8941 PMIC multi-function devices
> +
> +The PM8x41 PMICs are used with the Qualcomm Snapdragon 800 series SoCs, and are
> +interfaced to the chip via the SPMI (System Power Management Interface) bus.
> +Support for  multiple independent functions are implemented by splitting the
> +16-bit SPMI slave address space into 256 smaller fixed-size regions, 256 bytes
> +each.  A function can consume one or more of these fixed-size register regions.
> +
> +Required properties:
> +- compatible: Must be one of:
> +     "qcom,pm8841"
> +     "qcom,pm8941"
> +- reg: Specifies the SPMI USID slave address for this device
> +- #address-cells = <1>
> +- #size-cells = <0>
> +
> +Each child node represents a function of the PM8x41.  Each child 'reg' entry
> +describes an offset within the USID slave address where the region starts.
> +
> +Example:
> +
> +pm8941@0 {
> +	compatible = "qcom,pm8941";
> +	reg = <0x0>;
> +
> +	#address-cells = <1>;
> +	#size-cells = <0>;
> +
> +	rtc {
> +		compatible = "qcom,pm8941-rtc";
> +		reg = <0x6000 0x6100>;

This doesn't look right. Probably #size-cells have to be <1>?

Regards,
Ivan


> +	};
> +}
Josh Cartwright Oct. 29, 2013, 3:05 p.m. UTC | #2
On Tue, Oct 29, 2013 at 04:18:35PM +0200, Ivan T. Ivanov wrote:
> On Mon, 2013-10-28 at 13:12 -0500, Josh Cartwright wrote: 
> > Document the bindings used to describe the Qualcomm 8x41 PMICs.
> > 
> > Signed-off-by: Josh Cartwright <joshc@codeaurora.org>
> > ---
> >  Documentation/devicetree/bindings/mfd/pm8x41.txt | 33 ++++++++++++++++++++++++
> >  1 file changed, 33 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/mfd/pm8x41.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/mfd/pm8x41.txt b/Documentation/devicetree/bindings/mfd/pm8x41.txt
> > new file mode 100644
> > index 0000000..6afd4ce
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mfd/pm8x41.txt
> > @@ -0,0 +1,33 @@
> > +Qualcomm PM8841 and PM8941 PMIC multi-function devices
> > +
> > +The PM8x41 PMICs are used with the Qualcomm Snapdragon 800 series SoCs, and are
> > +interfaced to the chip via the SPMI (System Power Management Interface) bus.
> > +Support for  multiple independent functions are implemented by splitting the
> > +16-bit SPMI slave address space into 256 smaller fixed-size regions, 256 bytes
> > +each.  A function can consume one or more of these fixed-size register regions.
> > +
> > +Required properties:
> > +- compatible: Must be one of:
> > +     "qcom,pm8841"
> > +     "qcom,pm8941"
> > +- reg: Specifies the SPMI USID slave address for this device
> > +- #address-cells = <1>
> > +- #size-cells = <0>
> > +
> > +Each child node represents a function of the PM8x41.  Each child 'reg' entry
> > +describes an offset within the USID slave address where the region starts.
> > +
> > +Example:
> > +
> > +pm8941@0 {
> > +	compatible = "qcom,pm8941";
> > +	reg = <0x0>;
> > +
> > +	#address-cells = <1>;
> > +	#size-cells = <0>;
> > +
> > +	rtc {
> > +		compatible = "qcom,pm8941-rtc";
> > +		reg = <0x6000 0x6100>;
> 
> This doesn't look right. Probably #size-cells have to be <1>?

Some functions of the PMIC actually consume more than one fixed-size
region of the slave address space.  This example is showing one such
peripheral (consuming the region starting at 0x6000 and another at
0x6100).
Ivan T. Ivanov Oct. 29, 2013, 3:31 p.m. UTC | #3
Hi,

On Tue, 2013-10-29 at 10:05 -0500, Josh Cartwright wrote: 
> On Tue, Oct 29, 2013 at 04:18:35PM +0200, Ivan T. Ivanov wrote:
> > On Mon, 2013-10-28 at 13:12 -0500, Josh Cartwright wrote: 
> > > Document the bindings used to describe the Qualcomm 8x41 PMICs.
> > > 
> > > Signed-off-by: Josh Cartwright <joshc@codeaurora.org>
> > > ---
> > >  Documentation/devicetree/bindings/mfd/pm8x41.txt | 33 ++++++++++++++++++++++++
> > >  1 file changed, 33 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/mfd/pm8x41.txt
> > > 
> > > diff --git a/Documentation/devicetree/bindings/mfd/pm8x41.txt b/Documentation/devicetree/bindings/mfd/pm8x41.txt
> > > new file mode 100644
> > > index 0000000..6afd4ce
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/mfd/pm8x41.txt
> > > @@ -0,0 +1,33 @@
> > > +Qualcomm PM8841 and PM8941 PMIC multi-function devices
> > > +
> > > +The PM8x41 PMICs are used with the Qualcomm Snapdragon 800 series SoCs, and are
> > > +interfaced to the chip via the SPMI (System Power Management Interface) bus.
> > > +Support for  multiple independent functions are implemented by splitting the
> > > +16-bit SPMI slave address space into 256 smaller fixed-size regions, 256 bytes
> > > +each.  A function can consume one or more of these fixed-size register regions.
> > > +
> > > +Required properties:
> > > +- compatible: Must be one of:
> > > +     "qcom,pm8841"
> > > +     "qcom,pm8941"
> > > +- reg: Specifies the SPMI USID slave address for this device
> > > +- #address-cells = <1>
> > > +- #size-cells = <0>
> > > +
> > > +Each child node represents a function of the PM8x41.  Each child 'reg' entry
> > > +describes an offset within the USID slave address where the region starts.
> > > +
> > > +Example:
> > > +
> > > +pm8941@0 {
> > > +	compatible = "qcom,pm8941";
> > > +	reg = <0x0>;
> > > +
> > > +	#address-cells = <1>;
> > > +	#size-cells = <0>;
> > > +
> > > +	rtc {
> > > +		compatible = "qcom,pm8941-rtc";
> > > +		reg = <0x6000 0x6100>;
> > 
> > This doesn't look right. Probably #size-cells have to be <1>?
> 
> Some functions of the PMIC actually consume more than one fixed-size
> region of the slave address space.  This example is showing one such
> peripheral (consuming the region starting at 0x6000 and another at
> 0x6100).
> 

Ok. Thanks for clarification.

Regards,
Ivan
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mfd/pm8x41.txt b/Documentation/devicetree/bindings/mfd/pm8x41.txt
new file mode 100644
index 0000000..6afd4ce
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/pm8x41.txt
@@ -0,0 +1,33 @@ 
+Qualcomm PM8841 and PM8941 PMIC multi-function devices
+
+The PM8x41 PMICs are used with the Qualcomm Snapdragon 800 series SoCs, and are
+interfaced to the chip via the SPMI (System Power Management Interface) bus.
+Support for  multiple independent functions are implemented by splitting the
+16-bit SPMI slave address space into 256 smaller fixed-size regions, 256 bytes
+each.  A function can consume one or more of these fixed-size register regions.
+
+Required properties:
+- compatible: Must be one of:
+     "qcom,pm8841"
+     "qcom,pm8941"
+- reg: Specifies the SPMI USID slave address for this device
+- #address-cells = <1>
+- #size-cells = <0>
+
+Each child node represents a function of the PM8x41.  Each child 'reg' entry
+describes an offset within the USID slave address where the region starts.
+
+Example:
+
+pm8941@0 {
+	compatible = "qcom,pm8941";
+	reg = <0x0>;
+
+	#address-cells = <1>;
+	#size-cells = <0>;
+
+	rtc {
+		compatible = "qcom,pm8941-rtc";
+		reg = <0x6000 0x6100>;
+	};
+}