From: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
To: Mike Turquette <mturquette@linaro.org>
Cc: devicetree@vger.kernel.org, linux-samsung-soc@vger.kernel.org,
Yadwinder Singh Brar <yadi.brar01@gmail.com>,
Doug Anderson <dianders@chromium.org>,
linux-kernel@vger.kernel.org, Olof Johansson <olof@lixom.net>,
Javier Martinez Canillas <javier.martinez@collabora.co.uk>,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH v9 6/6] clk: max77802: Add DT binding documentation
Date: Mon, 18 Aug 2014 10:33:04 +0200 [thread overview]
Message-ID: <1408350784-15577-7-git-send-email-javier.martinez@collabora.co.uk> (raw)
In-Reply-To: <1408350784-15577-1-git-send-email-javier.martinez@collabora.co.uk>
Add Device Tree binding documentation for the clocks
outputs in the Maxim 77802 Power Management IC.
Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Acked-by: Mike Turquette <mturquette@linaro.org>
---
Changes since v6: None
Changes since v5:
- Fix typo error in DT binding. Suggested by Andreas Farber.
- Add "clock-output-names" as an optional property since now is supported.
Changes since v4: None
Changes since v3:
- Don't use the same clock driver name in clock-names since it's a consumer
concept and most probably will be different. Suggested by Doug Anderson.
Changes since v2:
- Split the DT binding documentation in a separate patch.
---
.../devicetree/bindings/clock/maxim,max77802.txt | 44 ++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 Documentation/devicetree/bindings/clock/maxim,max77802.txt
diff --git a/Documentation/devicetree/bindings/clock/maxim,max77802.txt b/Documentation/devicetree/bindings/clock/maxim,max77802.txt
new file mode 100644
index 0000000..c6dc783
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/maxim,max77802.txt
@@ -0,0 +1,44 @@
+Binding for Maxim MAX77802 32k clock generator block
+
+This is a part of device tree bindings of MAX77802 multi-function device.
+More information can be found in bindings/mfd/max77802.txt file.
+
+The MAX77802 contains two 32.768khz clock outputs that can be controlled
+(gated/ungated) over I2C.
+
+Following properties should be present in main device node of the MFD chip.
+
+Required properties:
+- #clock-cells: From common clock binding; shall be set to 1.
+
+Optional properties:
+- clock-output-names: From common clock binding.
+
+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.
+
+Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max77802.h
+header and can be used in device tree sources.
+
+Example: Node of the MFD chip
+
+ max77802: max77802@09 {
+ compatible = "maxim,max77802";
+ interrupt-parent = <&wakeup_eint>;
+ interrupts = <26 0>;
+ reg = <0x09>;
+ #clock-cells = <1>;
+
+ /* ... */
+ };
+
+Example: Clock consumer node
+
+ foo@0 {
+ compatible = "bar,foo";
+ /* ... */
+ clock-names = "my-clock";
+ clocks = <&max77802 MAX77802_CLK_32K_AP>;
+ };
--
2.0.1
next prev parent reply other threads:[~2014-08-18 8:33 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-18 8:32 [PATCH v9 0/6] Add Maxim 77802 clocks support Javier Martinez Canillas
2014-08-18 8:32 ` [PATCH v9 1/6] clk: max77686: Add DT include for MAX77686 PMIC clock Javier Martinez Canillas
2014-08-18 8:33 ` [PATCH v9 2/6] clk: Add generic driver for Maxim PMIC clocks Javier Martinez Canillas
2014-08-18 8:33 ` [PATCH v9 3/6] clk: max77686: Convert to the generic max clock driver Javier Martinez Canillas
2014-08-18 8:33 ` [PATCH v9 4/6] clk: max77686: Improve Maxim 77686 PMIC clocks binding Javier Martinez Canillas
2014-08-18 8:33 ` [PATCH v9 5/6] clk: Add driver for Maxim 77802 PMIC clocks Javier Martinez Canillas
2014-08-18 8:33 ` Javier Martinez Canillas [this message]
2014-09-08 6:49 ` [PATCH v9 0/6] Add Maxim 77802 clocks support Javier Martinez Canillas
2014-09-09 20:57 ` Mike Turquette
2014-09-10 7:18 ` 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=1408350784-15577-7-git-send-email-javier.martinez@collabora.co.uk \
--to=javier.martinez@collabora.co.uk \
--cc=devicetree@vger.kernel.org \
--cc=dianders@chromium.org \
--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=yadi.brar01@gmail.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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).