From mboxrd@z Thu Jan 1 00:00:00 1970 From: lee.jones@linaro.org (Lee Jones) Date: Wed, 4 Dec 2013 11:20:39 +0000 Subject: [PATCH v6 3/3] mfd: max14577: Add device tree bindings document In-Reply-To: <1386153615-25456-4-git-send-email-k.kozlowski@samsung.com> References: <1386153615-25456-1-git-send-email-k.kozlowski@samsung.com> <1386153615-25456-4-git-send-email-k.kozlowski@samsung.com> Message-ID: <20131204112039.GC907@lee--X1> To: linux-arm-kernel@lists.infradead.org List-Id: linux-arm-kernel.lists.infradead.org > Add document describing device tree bindings for MAX14577 MFD driver. > > Signed-off-by: Krzysztof Kozlowski > Signed-off-by: Kyungmin Park > --- > Documentation/devicetree/bindings/mfd/max14577.txt | 48 ++++++++++++++++++++ > 1 file changed, 48 insertions(+) > create mode 100644 Documentation/devicetree/bindings/mfd/max14577.txt > > diff --git a/Documentation/devicetree/bindings/mfd/max14577.txt b/Documentation/devicetree/bindings/mfd/max14577.txt > new file mode 100644 > index 000000000000..f4fd16360b6b > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/max14577.txt > @@ -0,0 +1,48 @@ > +MAXIM MAX14577 multi-function device Why is Maxim capitalised in such a way? If you're going to use the term Multi-Function Device, please capitalise it. > +MAX14577 is a Multi-function device with Micro-USB Interface Circuit, Li+ Same here. > +Battery Charger and SFOUT LDO output for powering USB devices. It is > +interfaced to host controller using I2C. > + > +Required properties: > +- compatible : Must be "maxim,max14577". > +- reg : I2C slave address for the max14577 chip. > +- interrupts : IRQ line for the max14577 chip. > +- interrupt-parent : The parent interrupt controller. > + > +Optional nodes: > +- regulators : > + Required child node properties: > + - compatible : "maxim,max14577-regulator" > + > + Optional child nodes: > + Each child node representing a regulator, following standard regulator > + bindings. Valid names for a regulator are: "CHARGER" and "SAFEOUT". > + The SAFEOUT is a constant voltage regulator so there is no need s/constant/fixed > + to specify voltages for it. The whole of the "Optional nodes" explaination isn't as clear as it could otherwise be. > + [*] refer Documentation/devicetree/bindings/regulator/regulator.txt > + > +Example: > + max14577 at 25 { > + compatible = "maxim,max14577"; > + reg = <0x25>; > + interrupt-parent = <&gpx1>; > + interrupts = <5 0>; I'm gussing this is IRQ5 and the 0 is flags? If so, please use #defines for the flags. > + regulators { > + compatible = "maxim,max14577-regulator"; > + > + safeout_reg: safeout at 1 { The name of the node (not the label:safeout_reg) usually depicts the type of device, so 'regulator at 0' and 'regulator at 1'. However, I'm unsure how this works when these nodes are encapsulated by an overarching 'regulators' parent node. Perhaps Mark can answer this? > + regulator-compatible = "SAFEOUT"; > + regulator-name = "SAFEOUT"; > + }; > + charger_reg: charger at 0 { > + regulator-compatible = "CHARGER"; > + regulator-name = "CHARGER"; > + regulator-min-microamp = <90000>; > + regulator-max-microamp = <950000>; > + regulator-boot-on; > + }; > + }; > + }; -- Lee Jones Linaro STMicroelectronics Landing Team Lead Linaro.org ? Open source software for ARM SoCs Follow Linaro: Facebook | Twitter | Blog From mboxrd@z Thu Jan 1 00:00:00 1970 From: Lee Jones Subject: Re: [PATCH v6 3/3] mfd: max14577: Add device tree bindings document Date: Wed, 4 Dec 2013 11:20:39 +0000 Message-ID: <20131204112039.GC907@lee--X1> References: <1386153615-25456-1-git-send-email-k.kozlowski@samsung.com> <1386153615-25456-4-git-send-email-k.kozlowski@samsung.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: QUOTED-PRINTABLE Return-path: Content-Disposition: inline In-Reply-To: <1386153615-25456-4-git-send-email-k.kozlowski-Sze3O3UU22JBDgjK7y7TUQ@public.gmane.org> Sender: devicetree-owner-u79uwXL29TY76Z2rM5mHXA@public.gmane.org To: Krzysztof Kozlowski Cc: Rob Herring , Pawel Moll , Mark Rutland , Stephen Warren , Ian Campbell , Rob Landley , Anton Vorontsov , David Woodhouse , Liam Girdwood , Mark Brown , Kyungmin Park , devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, Bartlomiej Zolnierkiewicz , Marek Szyprowski , Chanwoo Choi List-Id: devicetree@vger.kernel.org > Add document describing device tree bindings for MAX14577 MFD driver. >=20 > Signed-off-by: Krzysztof Kozlowski > Signed-off-by: Kyungmin Park > --- > Documentation/devicetree/bindings/mfd/max14577.txt | 48 ++++++++++= ++++++++++ > 1 file changed, 48 insertions(+) > create mode 100644 Documentation/devicetree/bindings/mfd/max14577.tx= t >=20 > diff --git a/Documentation/devicetree/bindings/mfd/max14577.txt b/Doc= umentation/devicetree/bindings/mfd/max14577.txt > new file mode 100644 > index 000000000000..f4fd16360b6b > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/max14577.txt > @@ -0,0 +1,48 @@ > +MAXIM MAX14577 multi-function device Why is Maxim capitalised in such a way? If you're going to use the term Multi-Function Device, please capitalise it. > +MAX14577 is a Multi-function device with Micro-USB Interface Circuit= , Li+ Same here. > +Battery Charger and SFOUT LDO output for powering USB devices. It is > +interfaced to host controller using I2C. > + > +Required properties: > +- compatible : Must be "maxim,max14577". > +- reg : I2C slave address for the max14577 chip. > +- interrupts : IRQ line for the max14577 chip. > +- interrupt-parent : The parent interrupt controller. > + > +Optional nodes: > +- regulators : > + Required child node properties: > + - compatible : "maxim,max14577-regulator" > + > + Optional child nodes: > + Each child node representing a regulator, following standard reg= ulator > + bindings. Valid names for a regulator are: "CHARGER" and "SAFEOU= T". > + The SAFEOUT is a constant voltage regulator so there is no need s/constant/fixed > + to specify voltages for it. The whole of the "Optional nodes" explaination isn't as clear as it could otherwise be.=20 > + [*] refer Documentation/devicetree/bindings/regulator/regulator.txt > + > +Example: > + max14577@25 { > + compatible =3D "maxim,max14577"; > + reg =3D <0x25>; > + interrupt-parent =3D <&gpx1>; > + interrupts =3D <5 0>; I'm gussing this is IRQ5 and the 0 is flags? If so, please use #defines for the flags. > + regulators { > + compatible =3D "maxim,max14577-regulator"; > + > + safeout_reg: safeout@1 { The name of the node (not the label:safeout_reg) usually depicts the type of device, so 'regulator@0' and 'regulator@1'. However, I'm unsure how this works when these nodes are encapsulated by an overarching 'regulators' parent node. Perhaps Mark can answer this? > + regulator-compatible =3D "SAFEOUT"; > + regulator-name =3D "SAFEOUT"; > + }; > + charger_reg: charger@0 { > + regulator-compatible =3D "CHARGER"; > + regulator-name =3D "CHARGER"; > + regulator-min-microamp =3D <90000>; > + regulator-max-microamp =3D <950000>; > + regulator-boot-on; > + }; > + }; > + }; --=20 Lee Jones Linaro STMicroelectronics Landing Team Lead Linaro.org =E2=94=82 Open source software for ARM SoCs =46ollow Linaro: Facebook | Twitter | Blog -- To unsubscribe from this list: send the line "unsubscribe devicetree" i= n the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755733Ab3LDLUu (ORCPT ); Wed, 4 Dec 2013 06:20:50 -0500 Received: from mail-yh0-f44.google.com ([209.85.213.44]:64302 "EHLO mail-yh0-f44.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755493Ab3LDLUr (ORCPT ); Wed, 4 Dec 2013 06:20:47 -0500 Date: Wed, 4 Dec 2013 11:20:39 +0000 From: Lee Jones To: Krzysztof Kozlowski Cc: Rob Herring , Pawel Moll , Mark Rutland , Stephen Warren , Ian Campbell , Rob Landley , Anton Vorontsov , David Woodhouse , Liam Girdwood , Mark Brown , Kyungmin Park , devicetree@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Bartlomiej Zolnierkiewicz , Marek Szyprowski , Chanwoo Choi Subject: Re: [PATCH v6 3/3] mfd: max14577: Add device tree bindings document Message-ID: <20131204112039.GC907@lee--X1> References: <1386153615-25456-1-git-send-email-k.kozlowski@samsung.com> <1386153615-25456-4-git-send-email-k.kozlowski@samsung.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <1386153615-25456-4-git-send-email-k.kozlowski@samsung.com> User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org > Add document describing device tree bindings for MAX14577 MFD driver. > > Signed-off-by: Krzysztof Kozlowski > Signed-off-by: Kyungmin Park > --- > Documentation/devicetree/bindings/mfd/max14577.txt | 48 ++++++++++++++++++++ > 1 file changed, 48 insertions(+) > create mode 100644 Documentation/devicetree/bindings/mfd/max14577.txt > > diff --git a/Documentation/devicetree/bindings/mfd/max14577.txt b/Documentation/devicetree/bindings/mfd/max14577.txt > new file mode 100644 > index 000000000000..f4fd16360b6b > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/max14577.txt > @@ -0,0 +1,48 @@ > +MAXIM MAX14577 multi-function device Why is Maxim capitalised in such a way? If you're going to use the term Multi-Function Device, please capitalise it. > +MAX14577 is a Multi-function device with Micro-USB Interface Circuit, Li+ Same here. > +Battery Charger and SFOUT LDO output for powering USB devices. It is > +interfaced to host controller using I2C. > + > +Required properties: > +- compatible : Must be "maxim,max14577". > +- reg : I2C slave address for the max14577 chip. > +- interrupts : IRQ line for the max14577 chip. > +- interrupt-parent : The parent interrupt controller. > + > +Optional nodes: > +- regulators : > + Required child node properties: > + - compatible : "maxim,max14577-regulator" > + > + Optional child nodes: > + Each child node representing a regulator, following standard regulator > + bindings. Valid names for a regulator are: "CHARGER" and "SAFEOUT". > + The SAFEOUT is a constant voltage regulator so there is no need s/constant/fixed > + to specify voltages for it. The whole of the "Optional nodes" explaination isn't as clear as it could otherwise be. > + [*] refer Documentation/devicetree/bindings/regulator/regulator.txt > + > +Example: > + max14577@25 { > + compatible = "maxim,max14577"; > + reg = <0x25>; > + interrupt-parent = <&gpx1>; > + interrupts = <5 0>; I'm gussing this is IRQ5 and the 0 is flags? If so, please use #defines for the flags. > + regulators { > + compatible = "maxim,max14577-regulator"; > + > + safeout_reg: safeout@1 { The name of the node (not the label:safeout_reg) usually depicts the type of device, so 'regulator@0' and 'regulator@1'. However, I'm unsure how this works when these nodes are encapsulated by an overarching 'regulators' parent node. Perhaps Mark can answer this? > + regulator-compatible = "SAFEOUT"; > + regulator-name = "SAFEOUT"; > + }; > + charger_reg: charger@0 { > + regulator-compatible = "CHARGER"; > + regulator-name = "CHARGER"; > + regulator-min-microamp = <90000>; > + regulator-max-microamp = <950000>; > + regulator-boot-on; > + }; > + }; > + }; -- Lee Jones Linaro STMicroelectronics Landing Team Lead Linaro.org │ Open source software for ARM SoCs Follow Linaro: Facebook | Twitter | Blog