From: Yash Shah <yash.shah@sifive.com>
To: palmer@sifive.com, linux-pwm@vger.kernel.org,
linux-riscv@lists.infradead.org
Cc: thierry.reding@gmail.com, robh+dt@kernel.org,
mark.rutland@arm.com, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, sachin.ghadi@sifive.com,
paul.walmsley@sifive.com, Yash Shah <yash.shah@sifive.com>
Subject: [RFC v2 1/2] pwm: sifive: Add DT documentation for SiFive PWM Controller
Date: Fri, 14 Dec 2018 11:50:41 +0530 [thread overview]
Message-ID: <1544768442-12530-2-git-send-email-yash.shah@sifive.com> (raw)
In-Reply-To: <1544768442-12530-1-git-send-email-yash.shah@sifive.com>
DT documentation for PWM controller added with updated compatible
string.
Signed-off-by: Wesley W. Terpstra <wesley@sifive.com>
[Atish: Compatible string update]
Signed-off-by: Atish Patra <atish.patra@wdc.com>
Signed-off-by: Yash Shah <yash.shah@sifive.com>
---
.../devicetree/bindings/pwm/pwm-sifive.txt | 44 ++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 Documentation/devicetree/bindings/pwm/pwm-sifive.txt
diff --git a/Documentation/devicetree/bindings/pwm/pwm-sifive.txt b/Documentation/devicetree/bindings/pwm/pwm-sifive.txt
new file mode 100644
index 0000000..250d8ee
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/pwm-sifive.txt
@@ -0,0 +1,44 @@
+SiFive PWM controller
+
+Unlike most other PWM controllers, the SiFive PWM controller currently only
+supports one period for all channels in the PWM. This is set globally in DTS.
+The period also has significant restrictions on the values it can achieve,
+which the driver rounds to the nearest achievable frequency.
+
+Required properties:
+- compatible: should be something similar to "sifive,<chip>-pwm" for
+ the PWM as integrated on a particular chip, and
+ "sifive,pwm<version>" for the general PWM IP block
+ programming model. Supported compatible strings are:
+ "sifive,fu540-c000-pwm" for the SiFive PWM v0 as
+ integrated onto the SiFive FU540 chip, and "sifive,pwm0"
+ for the SiFive PWM v0 IP block with no chip integration
+ tweaks.
+- reg: physical base address and length of the controller's registers
+- clocks: The frequency the controller runs at
+- #pwm-cells: Should be 2.
+ The first cell is the PWM channel number
+ The second cell is the PWM polarity
+- sifive,approx-period: the driver will get as close to this period as it can
+- interrupts: one interrupt per PWM channel
+
+PWM RTL that corresponds to the IP block version numbers can be found
+here:
+
+https://github.com/sifive/sifive-blocks/tree/master/src/main/scala/devices/pwm
+
+Further information on the format of the IP
+block-specific version numbers can be found in
+Documentation/devicetree/bindings/sifive/sifive-blocks-ip-versioning.txt
+
+Examples:
+
+pwm: pwm@10020000 {
+ compatible = "sifive,fu540-c000-pwm","sifive,pwm0";
+ reg = <0x0 0x10020000 0x0 0x1000>;
+ clocks = <&tlclk>;
+ interrupt-parent = <&plic>;
+ interrupts = <42 43 44 45>;
+ #pwm-cells = <2>;
+ sifive,approx-period = <1000000>;
+};
--
1.9.1
next prev parent reply other threads:[~2018-12-14 6:21 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-14 6:20 [RFC v2 0/2] PWM support for HiFive Unleashed Yash Shah
2018-12-14 6:20 ` Yash Shah [this message]
2018-12-17 21:16 ` [RFC v2 1/2] pwm: sifive: Add DT documentation for SiFive PWM Controller Uwe Kleine-König
2019-01-04 5:09 ` Yash Shah
2018-12-18 17:20 ` Rob Herring
2019-01-04 5:03 ` Yash Shah
2018-12-14 6:20 ` [RFC v2 2/2] pwm: sifive: Add a driver for SiFive SoC PWM Yash Shah
2018-12-17 22:11 ` Uwe Kleine-König
2019-01-04 5:14 ` Yash Shah
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=1544768442-12530-2-git-send-email-yash.shah@sifive.com \
--to=yash.shah@sifive.com \
--cc=devicetree@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=mark.rutland@arm.com \
--cc=palmer@sifive.com \
--cc=paul.walmsley@sifive.com \
--cc=robh+dt@kernel.org \
--cc=sachin.ghadi@sifive.com \
--cc=thierry.reding@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).