From patchwork Fri Jul 4 09:55:17 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Javier Martinez Canillas X-Patchwork-Id: 4479931 Return-Path: X-Original-To: patchwork-linux-arm@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 8B80F9F26C for ; Fri, 4 Jul 2014 10:01:28 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id A749220222 for ; Fri, 4 Jul 2014 10:01:27 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.9]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B41922021A for ; Fri, 4 Jul 2014 10:01:25 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.80.1 #2 (Red Hat Linux)) id 1X30H8-0008Iw-4t; Fri, 04 Jul 2014 09:59:26 +0000 Received: from bhuna.collabora.co.uk ([93.93.135.160]) by bombadil.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1X30Ed-0004NX-88 for linux-arm-kernel@lists.infradead.org; Fri, 04 Jul 2014 09:56:52 +0000 Received: from [127.0.0.1] (localhost [127.0.0.1]) (Authenticated sender: javier) with ESMTPSA id E25796007C7 From: Javier Martinez Canillas To: Lee Jones Subject: [PATCH v6 18/23] mfd: max77802: Add DT binding documentation Date: Fri, 4 Jul 2014 11:55:17 +0200 Message-Id: <1404467722-26687-19-git-send-email-javier.martinez@collabora.co.uk> X-Mailer: git-send-email 2.0.0.rc2 In-Reply-To: <1404467722-26687-1-git-send-email-javier.martinez@collabora.co.uk> References: <1404467722-26687-1-git-send-email-javier.martinez@collabora.co.uk> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20140704_025651_662261_6E610250 X-CRM114-Status: GOOD ( 14.89 ) X-Spam-Score: -0.0 (/) Cc: Alessandro Zummo , Krzysztof Kozlowski , Kukjin Kim , Mike Turquette , Tomeu Vizoso , devicetree@vger.kernel.org, Yadwinder Singh Brar , linux-kernel@vger.kernel.org, Liam Girdwood , Javier Martinez Canillas , Doug Anderson , Tushar Behera , Mark Brown , linux-samsung-soc@vger.kernel.org, Olof Johansson , Andreas Farber , linux-arm-kernel@lists.infradead.org X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.18-1 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add Device Tree binding documentation for Maxim 77802 PMIC. Signed-off-by: Javier Martinez Canillas --- Changes since v5: - Use max77686,* properties instead of max77802,* since the support is now in the max77686 driver and that IP defined the properties first. - Fix issues in DT binding documentation. Suggested by Andreas Farber. Changes since v4: None Changes since v3: None Changes since v2: - Explain better the Dynamic Voltage Scaling (DVS) support in some Buck regulators and the max77802,pmic-buck-{dvs,selb}-gpios properties. Suggested by Mark Brown. --- Documentation/devicetree/bindings/mfd/max77802.txt | 95 ++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 Documentation/devicetree/bindings/mfd/max77802.txt diff --git a/Documentation/devicetree/bindings/mfd/max77802.txt b/Documentation/devicetree/bindings/mfd/max77802.txt new file mode 100644 index 0000000..5460e20 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/max77802.txt @@ -0,0 +1,95 @@ +Maxim MAX77802 multi-function device + +MAX77802 is a Multifunction device with PMIC, RTC and Charger on chip. It is +interfaced to host controller using i2c interface. PMIC, Charger and RTC +submodules are addressed using same i2c slave address. + +Buck regulators 1, 2, 3, 4 and 6 include Dynamic Voltage Scaling (DVS) that +allows each output voltage to change dynamically. Each Buck output voltage +is selected using a set of external inputs: DVS1-3 and SELB1, 2, 3, 4 and 6. + +There are 8 DVS registers that can be used to configure the output voltage +for each Buck regulator and which one is active is controled by DVSx lines. + +SELBx lines are used to control if individual Buck lines are ON or OFF. + +This document describes the binding for mfd device and PMIC submodule. + +Binding for the built-in 32k clock generator block is defined separately +in bindings/clk/maxim,max77802.txt file. + +Required properties: +- compatible : Must be "maxim,max77802"; +- reg : Specifies the i2c slave address of PMIC block. +- interrupts : This i2c device has an IRQ line connected to the main SoC. +- interrupt-parent : The parent interrupt controller. + +Optional properties: +- max77686,pmic-buck-default-dvs-idx: We'll always write this DVS index in the + PMIC for Bucks with DVS. + NOTE: at the moment these bindings don't include enough details for actual + GPIO-DVS--this just lets you choose which single slot to use. + +- max77686,pmic-buck-dvs-gpios: A GPIO array where each GPIO is connected to a + DVS line. We'll try to set these GPIOs to match pmic-buck-default-dvs-idx at + probe time if they are defined. If some or all of these GPIOs are not defined + it's assumed that the board has any missing GPIOs hardwired to match + pmic-buck-default-dvs-idx. + +- max77686,pmic-buck-selb-gpios: A GPIO array where each GPIO is connected to a + SELBx line. Should be five values: 1, 2, 3, 4, 6. It is strongly suggested to + include these GPIOs if there's any chance that changing DVS GPIOs one line at + a time might glitch your DVS values. + +Optional node: +- regulators : The regulators of max77802 have to be instantiated + under subnode named "regulators" using the following format. + + regulator-name { + standard regulator constraints.... + }; + refer Documentation/devicetree/bindings/regulator/regulator.txt + + The regulator node name should be initialized with a string +to get matched with their hardware counterparts as follow. The valid names are: + + -LDOn : for LDOs, where n can lie in range 1 to 35. + example: LDO1, LDO2, LDO35. + -BUCKn : for BUCKs, where n can lie in range 1 to 10. + example: BUCK1, BUCK5, BUCK10. +Example: + + max77802@09 { + compatible = "maxim,max77802"; + interrupt-parent = <&wakeup_eint>; + interrupts = <26 0>; + reg = <0x09>; + #address-cells = <1>; + #size-cells = <0>; + + max77686,pmic-buck-default-dvs-idx = <1>; + max77686,pmic-buck-dvs-gpios = <&gpy7 6 0>, + <&gpj4 2 0>, + <&gpj4 3 0>; + max77686,pmic-buck-selb-gpios = <&gph0 2 0>, + <&gph0 3 0>, + <&gph0 4 0>, + <&gph0 5 0>, + <&gph0 6 0>; + + regulators { + ldo11_reg: LDO11 { + regulator-name = "vdd_ldo11"; + regulator-min-microvolt = <1900000>; + regulator-max-microvolt = <1900000>; + regulator-always-on; + }; + + buck1_reg: BUCK1 { + regulator-name = "vdd_mif"; + regulator-min-microvolt = <950000>; + regulator-max-microvolt = <1300000>; + regulator-always-on; + regulator-boot-on; + }; + };