From: Javier Martinez Canillas <javier.martinez@collabora.co.uk> To: Lee Jones <lee.jones@linaro.org> Cc: Samuel Ortiz <sameo@linux.intel.com>, Mark Brown <broonie@kernel.org>, Mike Turquette <mturquette@linaro.org>, Liam Girdwood <lgirdwood@gmail.com>, Alessandro Zummo <a.zummo@towertech.it>, Kukjin Kim <kgene.kim@samsung.com>, Doug Anderson <dianders@chromium.org>, Olof Johansson <olof@lixom.net>, Sjoerd Simons <sjoerd.simons@collabora.co.uk>, Daniel Stone <daniels@collabora.com>, Tomeu Vizoso <tomeu.vizoso@collabora.com>, Krzysztof Kozlowski <k.kozlowski@samsung.com>, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, linux-samsung-soc@vger.kernel.org, linux-kernel@vger.kernel.org, Javier Martinez Canillas <javier.martinez@collabora.co.uk> Subject: [PATCH v2 03/10] Documentation: dt: improve Maxim 77686 PMIC clocks binding Date: Mon, 16 Jun 2014 20:02:31 +0200 [thread overview] Message-ID: <1402941758-11216-4-git-send-email-javier.martinez@collabora.co.uk> (raw) In-Reply-To: <1402941758-11216-1-git-send-email-javier.martinez@collabora.co.uk> Like most clock drivers, the Maxim 77686 PMIC clock binding follows the convention that the "#clock-cells" property is used to specify the number of cells in a clock provider. But the binding document is not clear enough that it shall be set to 1 since the PMIC support multiple clocks outputs. Also, explain that the clocks identifiers are defined in a header file that can be included by Device Tree source with client nodes to avoid using magic numbers. Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk> --- .../devicetree/bindings/clock/maxim,max77686.txt | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/Documentation/devicetree/bindings/clock/maxim,max77686.txt b/Documentation/devicetree/bindings/clock/maxim,max77686.txt index 96ce71b..8dea305 100644 --- a/Documentation/devicetree/bindings/clock/maxim,max77686.txt +++ b/Documentation/devicetree/bindings/clock/maxim,max77686.txt @@ -9,13 +9,18 @@ The MAX77686 contains three 32.768khz clock outputs that can be controlled Following properties should be presend in main device node of the MFD chip. Required properties: -- #clock-cells: simple one-cell clock specifier format is used, where the - only cell is used as an index of the clock inside the provider. Following - indices are allowed: + +- #clock-cells: from common clock binding; shall be set to 1. + +Each clock is assigned an identifier and client nodes can use this identifier +to specify the clock which they consume. Following indices are allowed: - 0: 32khz_ap clock, - 1: 32khz_cp clock, - 2: 32khz_pmic clock. +Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max77686.h +header and can be used in device tree sources. + Example: Node of the MFD chip max77686: max77686@09 { @@ -33,6 +38,6 @@ Example: Clock consumer node foo@0 { compatible = "bar,foo"; /* ... */ - clock-names = "my-clock"; - clocks = <&max77686 2>; + clock-names = "32khz_pmic"; + clocks = <&max77686 MAX77686_CLK_PMIC>; }; -- 2.0.0.rc2
WARNING: multiple messages have this Message-ID (diff)
From: javier.martinez@collabora.co.uk (Javier Martinez Canillas) To: linux-arm-kernel@lists.infradead.org Subject: [PATCH v2 03/10] Documentation: dt: improve Maxim 77686 PMIC clocks binding Date: Mon, 16 Jun 2014 20:02:31 +0200 [thread overview] Message-ID: <1402941758-11216-4-git-send-email-javier.martinez@collabora.co.uk> (raw) In-Reply-To: <1402941758-11216-1-git-send-email-javier.martinez@collabora.co.uk> Like most clock drivers, the Maxim 77686 PMIC clock binding follows the convention that the "#clock-cells" property is used to specify the number of cells in a clock provider. But the binding document is not clear enough that it shall be set to 1 since the PMIC support multiple clocks outputs. Also, explain that the clocks identifiers are defined in a header file that can be included by Device Tree source with client nodes to avoid using magic numbers. Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk> --- .../devicetree/bindings/clock/maxim,max77686.txt | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/Documentation/devicetree/bindings/clock/maxim,max77686.txt b/Documentation/devicetree/bindings/clock/maxim,max77686.txt index 96ce71b..8dea305 100644 --- a/Documentation/devicetree/bindings/clock/maxim,max77686.txt +++ b/Documentation/devicetree/bindings/clock/maxim,max77686.txt @@ -9,13 +9,18 @@ The MAX77686 contains three 32.768khz clock outputs that can be controlled Following properties should be presend in main device node of the MFD chip. Required properties: -- #clock-cells: simple one-cell clock specifier format is used, where the - only cell is used as an index of the clock inside the provider. Following - indices are allowed: + +- #clock-cells: from common clock binding; shall be set to 1. + +Each clock is assigned an identifier and client nodes can use this identifier +to specify the clock which they consume. Following indices are allowed: - 0: 32khz_ap clock, - 1: 32khz_cp clock, - 2: 32khz_pmic clock. +Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max77686.h +header and can be used in device tree sources. + Example: Node of the MFD chip max77686: max77686 at 09 { @@ -33,6 +38,6 @@ Example: Clock consumer node foo at 0 { compatible = "bar,foo"; /* ... */ - clock-names = "my-clock"; - clocks = <&max77686 2>; + clock-names = "32khz_pmic"; + clocks = <&max77686 MAX77686_CLK_PMIC>; }; -- 2.0.0.rc2
next prev parent reply other threads:[~2014-06-16 18:03 UTC|newest] Thread overview: 67+ messages / expand[flat|nested] mbox.gz Atom feed top 2014-06-16 18:02 [PATCH v2 00/10] Add Maxim 77802 PMIC support Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 01/10] mfd: max77686: Convert to use regmap_irq Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-17 20:32 ` Lee Jones 2014-06-17 20:32 ` Lee Jones 2014-06-17 20:57 ` Doug Anderson 2014-06-17 20:57 ` Doug Anderson 2014-06-17 20:57 ` Doug Anderson 2014-06-18 9:21 ` Javier Martinez Canillas 2014-06-18 9:21 ` Javier Martinez Canillas 2014-06-18 9:21 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 02/10] clk: max77686: add DT include for MAX77686 PMIC clock Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas [this message] 2014-06-16 18:02 ` [PATCH v2 03/10] Documentation: dt: improve Maxim 77686 PMIC clocks binding Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 04/10] clk: Add generic driver for Maxim PMIC clocks Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 05/10] clk: max77686: convert to the generic max clock driver Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 06/10] mfd: Add driver for Maxim 77802 Power Management IC Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 19:27 ` Mark Brown 2014-06-16 19:27 ` Mark Brown 2014-06-17 10:57 ` Javier Martinez Canillas 2014-06-17 10:57 ` Javier Martinez Canillas 2014-06-18 8:32 ` Lee Jones 2014-06-18 8:32 ` Lee Jones 2014-06-18 9:50 ` Javier Martinez Canillas 2014-06-18 9:50 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 07/10] regulator: Add driver for Maxim 77802 PMIC regulators Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 19:25 ` Mark Brown 2014-06-16 19:25 ` Mark Brown 2014-06-17 10:49 ` Javier Martinez Canillas 2014-06-17 10:49 ` Javier Martinez Canillas 2014-06-17 10:49 ` Javier Martinez Canillas 2014-06-17 14:12 ` Mark Brown 2014-06-17 14:12 ` Mark Brown 2014-06-17 16:05 ` Javier Martinez Canillas 2014-06-17 16:05 ` Javier Martinez Canillas 2014-06-21 20:40 ` Mark Brown 2014-06-21 20:40 ` Mark Brown 2014-06-23 9:28 ` Javier Martinez Canillas 2014-06-23 9:28 ` Javier Martinez Canillas 2014-06-23 9:47 ` Mark Brown 2014-06-23 9:47 ` Mark Brown 2014-06-23 9:47 ` Mark Brown 2014-06-24 16:43 ` Javier Martinez Canillas 2014-06-24 16:43 ` Javier Martinez Canillas 2014-06-17 21:17 ` Lee Jones 2014-06-17 21:17 ` Lee Jones 2014-06-17 21:17 ` Lee Jones 2014-06-18 9:47 ` Javier Martinez Canillas 2014-06-18 9:47 ` Javier Martinez Canillas 2014-06-18 14:10 ` Lee Jones 2014-06-18 14:10 ` Lee Jones 2014-06-19 13:32 ` Alessandro Zummo 2014-06-19 13:32 ` Alessandro Zummo 2014-06-16 18:02 ` [PATCH v2 08/10] clk: Add driver for Maxim 77802 PMIC clocks Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 09/10] rtc: Add driver for Maxim 77802 PMIC Real-Time-Clock Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas 2014-06-16 18:02 ` [PATCH v2 10/10] ARM: dts: Add max77802 device node for exynos5420-peach-pit Javier Martinez Canillas 2014-06-16 18:02 ` Javier Martinez Canillas
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1402941758-11216-4-git-send-email-javier.martinez@collabora.co.uk \ --to=javier.martinez@collabora.co.uk \ --cc=a.zummo@towertech.it \ --cc=broonie@kernel.org \ --cc=daniels@collabora.com \ --cc=devicetree@vger.kernel.org \ --cc=dianders@chromium.org \ --cc=k.kozlowski@samsung.com \ --cc=kgene.kim@samsung.com \ --cc=lee.jones@linaro.org \ --cc=lgirdwood@gmail.com \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-samsung-soc@vger.kernel.org \ --cc=mturquette@linaro.org \ --cc=olof@lixom.net \ --cc=sameo@linux.intel.com \ --cc=sjoerd.simons@collabora.co.uk \ --cc=tomeu.vizoso@collabora.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.