From: Paul Walmsley <paul.walmsley@sifive.com>
To: linux-clk@vger.kernel.org, devicetree@vger.kernel.org
Cc: Mark Rutland <mark.rutland@arm.com>,
Paul Walmsley <paul@pwsan.com>, Stephen Boyd <sboyd@kernel.org>,
Megan Wachs <megan@sifive.com>,
Michael Turquette <mturquette@baylibre.com>,
Palmer Dabbelt <palmer@sifive.com>,
linux-kernel@vger.kernel.org, Rob Herring <robh+dt@kernel.org>,
Paul Walmsley <paul.walmsley@sifive.com>,
linux-riscv@lists.infradead.org
Subject: [PATCH v2 2/3] dt-bindings: clk: add documentation for the SiFive PRCI driver
Date: Sat, 20 Oct 2018 06:50:23 -0700 [thread overview]
Message-ID: <20181020135024.28573-3-paul.walmsley@sifive.com> (raw)
Message-ID: <20181020135023.eOYXALkyqJu4gj7yjAQoXgtsBcewxvbBSK4j8YINlI4@z> (raw)
In-Reply-To: <20181020135024.28573-1-paul.walmsley@sifive.com>
Add DT binding documentation for the Linux driver for the SiFive
PRCI clock & reset control IP block, as found on the SiFive
FU540 chip.
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Palmer Dabbelt <palmer@sifive.com>
Cc: Megan Wachs <megan@sifive.com>
Cc: linux-clk@vger.kernel.org
Cc: devicetree@vger.kernel.org
Cc: linux-riscv@lists.infradead.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Paul Walmsley <paul.walmsley@sifive.com>
Signed-off-by: Paul Walmsley <paul@pwsan.com>
---
v2: remove out-of-date example, add documentation for the compatible
string and for the required PCB clock nodes
.../bindings/clock/sifive/fu540-prci.txt | 43 +++++++++++++++++++
1 file changed, 43 insertions(+)
create mode 100644 Documentation/devicetree/bindings/clock/sifive/fu540-prci.txt
diff --git a/Documentation/devicetree/bindings/clock/sifive/fu540-prci.txt b/Documentation/devicetree/bindings/clock/sifive/fu540-prci.txt
new file mode 100644
index 000000000000..d7c1e83fa5ed
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/sifive/fu540-prci.txt
@@ -0,0 +1,43 @@
+SiFive FU540 PRCI bindings
+
+On the FU540 family of SoCs, most system-wide clock and reset integration
+is via the PRCI IP block.
+
+Required properties:
+- compatible: Should be "sifive,<chip>-prci<version>". As of the time this
+ file was written, only one value is supported:
+ "sifive,fu540-c000-prci0"
+- reg: Should describe the PRCI's register target physical address region
+- clocks: Should point to the hfclk device tree node and the rtcclk
+ device tree node. The RTC clock here is not a time-of-day clock,
+ but is instead a high-stability clock source for system timers
+ and cycle counters.
+- #clock-cells: Should be <1>
+
+The clock consumer should specify the desired clock via the clock ID
+macros defined in include/linux/clk/sifive-fu540-prci.h. These macros
+begin with PRCI_CLK_.
+
+The hfclk and rtcclk nodes are required, and represent physical
+crystals or resonators located on the PCB.
+
+Examples:
+
+hfclk: hfclk {
+ #clock-cells = <0>;
+ compatible = "fixed-clock";
+ clock-frequency = <33333333>;
+ clock-output-names = "hfclk";
+};
+rtcclk: rtcclk {
+ #clock-cells = <0>;
+ compatible = "fixed-clock";
+ clock-frequency = <1000000>;
+ clock-output-names = "rtcclk";
+};
+prci0: prci@10000000 {
+ compatible = "sifive,fu540-c000-prci0";
+ reg = <0x0 0x10000000 0x0 0x1000>;
+ clocks = <&hfclk>, <&rtcclk>;
+ #clock-cells = <1>;
+};
--
2.19.1
_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv
next prev parent reply other threads:[~2018-10-20 13:50 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-20 13:50 [PATCH v2 0/3] clk: add driver for the SiFive FU540 PRCI and PLLs it controls Paul Walmsley
2018-10-20 13:50 ` Paul Walmsley
2018-10-20 13:50 ` Paul Walmsley [this message]
2018-10-20 13:50 ` [PATCH v2 2/3] dt-bindings: clk: add documentation for the SiFive PRCI driver Paul Walmsley
2018-10-24 18:47 ` Rob Herring
2018-10-24 18:47 ` Rob Herring
2018-11-16 23:18 ` Paul Walmsley
2018-11-16 23:18 ` Paul Walmsley
2018-11-06 17:33 ` Stephen Boyd
2018-11-06 17:33 ` Stephen Boyd
2018-11-07 2:00 ` Paul Walmsley
2018-11-07 2:00 ` Paul Walmsley
2018-10-20 13:50 ` [PATCH v2 3/3] clk: sifive: add a driver for the SiFive FU540 PRCI IP block Paul Walmsley
2018-10-20 13:50 ` Paul Walmsley
2018-11-21 16:35 ` Stephen Boyd
2018-11-21 16:35 ` Stephen Boyd
2018-11-27 23:24 ` Paul Walmsley
2018-11-27 23:24 ` Paul Walmsley
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=20181020135024.28573-3-paul.walmsley@sifive.com \
--to=paul.walmsley@sifive.com \
--cc=devicetree@vger.kernel.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=mark.rutland@arm.com \
--cc=megan@sifive.com \
--cc=mturquette@baylibre.com \
--cc=palmer@sifive.com \
--cc=paul@pwsan.com \
--cc=robh+dt@kernel.org \
--cc=sboyd@kernel.org \
/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).