From: Paul Cercueil <paul@crapouillou.net>
To: Thierry Reding <thierry.reding@gmail.com>,
Rob Herring <robh+dt@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Daniel Lezcano <daniel.lezcano@linaro.org>,
Thomas Gleixner <tglx@linutronix.de>,
Wim Van Sebroeck <wim@linux-watchdog.org>,
Guenter Roeck <linux@roeck-us.net>,
Ralf Baechle <ralf@linux-mips.org>,
Paul Burton <paul.burton@mips.com>,
Jonathan Corbet <corbet@lwn.net>,
Michael Turquette <mturquette@baylibre.com>,
Stephen Boyd <sboyd@kernel.org>, Lee Jones <lee.jones@linaro.org>
Cc: Paul Cercueil <paul@crapouillou.net>,
linux-pwm@vger.kernel.org, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-watchdog@vger.kernel.org,
linux-mips@linux-mips.org, linux-doc@vger.kernel.org,
linux-clk@vger.kernel.org
Subject: [PATCH v5 04/21] dt-bindings: Add doc for the Ingenic TCU drivers
Date: Wed, 25 Jul 2018 01:19:41 +0200 [thread overview]
Message-ID: <20180724231958.20659-5-paul@crapouillou.net> (raw)
In-Reply-To: <20180724231958.20659-1-paul@crapouillou.net>
Add documentation about how to properly use the Ingenic TCU
(Timer/Counter Unit) drivers from devicetree.
Signed-off-by: Paul Cercueil <paul@crapouillou.net>
---
.../devicetree/bindings/pwm/ingenic,jz47xx-pwm.txt | 24 +---
.../devicetree/bindings/timer/ingenic,tcu.txt | 147 +++++++++++++++++++++
.../bindings/watchdog/ingenic,jz4740-wdt.txt | 17 +--
3 files changed, 151 insertions(+), 37 deletions(-)
create mode 100644 Documentation/devicetree/bindings/timer/ingenic,tcu.txt
v4: New patch in this series. Corresponds to V2 patches 3-4-5 with
added content.
v5: - Edited PWM/watchdog DT bindings documentation to point to the new
document.
- Moved main document to
Documentation/devicetree/bindings/timer/ingenic,tcu.txt
- Updated documentation to reflect the new devicetree bindings.
diff --git a/Documentation/devicetree/bindings/pwm/ingenic,jz47xx-pwm.txt b/Documentation/devicetree/bindings/pwm/ingenic,jz47xx-pwm.txt
index 7d9d3f90641b..a722cdde3aa7 100644
--- a/Documentation/devicetree/bindings/pwm/ingenic,jz47xx-pwm.txt
+++ b/Documentation/devicetree/bindings/pwm/ingenic,jz47xx-pwm.txt
@@ -1,25 +1,5 @@
Ingenic JZ47xx PWM Controller
=============================
-Required properties:
-- compatible: One of:
- * "ingenic,jz4740-pwm"
- * "ingenic,jz4770-pwm"
- * "ingenic,jz4780-pwm"
-- #pwm-cells: Should be 3. See pwm.txt in this directory for a description
- of the cells format.
-- clocks : phandle to the external clock.
-- clock-names : Should be "ext".
-
-
-Example:
-
- pwm: pwm@10002000 {
- compatible = "ingenic,jz4740-pwm";
- reg = <0x10002000 0x1000>;
-
- #pwm-cells = <3>;
-
- clocks = <&ext>;
- clock-names = "ext";
- };
+This documentation has moved; for a description of the devicetree bindings of
+this driver, please refer to ../timer/ingenic,tcu.txt.
diff --git a/Documentation/devicetree/bindings/timer/ingenic,tcu.txt b/Documentation/devicetree/bindings/timer/ingenic,tcu.txt
new file mode 100644
index 000000000000..65d125b460aa
--- /dev/null
+++ b/Documentation/devicetree/bindings/timer/ingenic,tcu.txt
@@ -0,0 +1,147 @@
+Ingenic JZ47xx SoCs Timer/Counter Unit devicetree bindings
+==========================================================
+
+For a description of the TCU hardware and drivers, have a look at
+Documentation/mips/ingenic-tcu.txt.
+
+Required properties:
+
+- compatible: Must be one of:
+ * ingenic,jz4740-tcu
+ * ingenic,jz4725b-tcu
+ * ingenic,jz4770-tcu
+- reg: Should be the offset/length value corresponding to the TCU registers
+- #address-cells: Should be <1>;
+- #size-cells: Should be <1>;
+- ranges: Should be one range for the full TCU registers area
+- clocks: List of phandle & clock specifiers for clocks external to the TCU.
+ The "pclk", "rtc", "ext" and "tcu" clocks should be provided.
+- clock-names: List of name strings for the external clocks.
+- #clock-cells: Should be <1>;
+ Clock consumers specify this argument to identify a clock. The valid values
+ may be found in <dt-bindings/clock/ingenic,tcu.h>.
+- interrupt-controller : Identifies the node as an interrupt controller
+- #interrupt-cells : Specifies the number of cells needed to encode an
+ interrupt source. The value should be 1.
+- interrupt-parent : phandle of the interrupt controller.
+- interrupts : Specifies the interrupt the controller is connected to.
+
+Optional properties:
+
+- ingenic,timer-channel: Specifies the TCU channel that should be used as
+ system timer. If not provided, the TCU channel 0 is used for the system timer.
+
+- ingenic,clocksource-channel: Specifies the TCU channel that should be used
+ as clocksource and sched_clock. It must be a different channel than the one
+ used as system timer. If not provided, neither a clocksource nor a
+ sched_clock is instantiated.
+
+
+Children nodes
+==========================================================
+
+
+PWM node:
+---------
+
+Required properties:
+
+- compatible: Must be one of:
+ * ingenic,jz4740-pwm
+ * ingenic,jz4725b-pwm
+- #pwm-cells: Should be 3. See ../pwm/pwm.txt for a description of the cell
+ format.
+- clocks: List of phandle & clock specifiers for the TCU clocks.
+- clock-names: List of name strings for the TCU clocks.
+
+
+Watchdog node:
+--------------
+
+Required properties:
+
+- compatible: Must be one of:
+ * ingenic,jz4740-watchdog
+ * ingenic,jz4780-watchdog
+- clocks: phandle to the RTC clock
+- clock-names: should be "rtc"
+
+
+OST node:
+---------
+
+Required properties:
+
+- compatible: Must be one of:
+ * ingenic,jz4725b-ost
+ * ingenic,jz4770-ost
+- clocks: phandle to the OST clock
+- clock-names: should be "ost"
+- interrupts : Specifies the interrupt the OST is connected to.
+
+
+Example
+==========================================================
+
+#include <dt-bindings/clock/jz4770-cgu.h>
+#include <dt-bindings/clock/ingenic,tcu.h>
+
+/ {
+ tcu: timer@10002000 {
+ compatible = "ingenic,jz4770-tcu";
+ reg = <0x10002000 0x1000>;
+ #address-cells = <1>;
+ #size-cells = <1>;
+ ranges = <0x0 0x10002000 0x1000>;
+
+ #clock-cells = <1>;
+
+ clocks = <&cgu JZ4770_CLK_RTC
+ &cgu JZ4770_CLK_EXT
+ &cgu JZ4770_CLK_PCLK
+ &cgu JZ4770_CLK_EXT>;
+ clock-names = "rtc", "ext", "pclk", "tcu";
+
+ interrupt-controller;
+ #interrupt-cells = <1>;
+
+ interrupt-parent = <&intc>;
+ interrupts = <27 26 25>;
+
+ watchdog: watchdog@0 {
+ compatible = "ingenic,jz4740-watchdog";
+ reg = <0x0 0x10>;
+
+ clocks = <&tcu TCU_CLK_WDT>;
+ clock-names = "wdt";
+ };
+
+ pwm: pwm@10 {
+ compatible = "ingenic,jz4740-pwm";
+ reg = <0x10 0xff0>;
+
+ #pwm-cells = <3>;
+
+ clocks = <&tcu TCU_CLK_TIMER0
+ &tcu TCU_CLK_TIMER1
+ &tcu TCU_CLK_TIMER2
+ &tcu TCU_CLK_TIMER3
+ &tcu TCU_CLK_TIMER4
+ &tcu TCU_CLK_TIMER5
+ &tcu TCU_CLK_TIMER6
+ &tcu TCU_CLK_TIMER7>;
+ clock-names = "timer0", "timer1", "timer2", "timer3",
+ "timer4", "timer5", "timer6", "timer7";
+ };
+
+ ost: timer@e0 {
+ compatible = "ingenic,jz4770-ost";
+ reg = <0xe0 0x20>;
+
+ clocks = <&tcu TCU_CLK_OST>;
+ clock-names = "ost";
+
+ interrupts = <15>;
+ };
+ };
+};
diff --git a/Documentation/devicetree/bindings/watchdog/ingenic,jz4740-wdt.txt b/Documentation/devicetree/bindings/watchdog/ingenic,jz4740-wdt.txt
index ce1cb72d5345..b12ddc0c2b00 100644
--- a/Documentation/devicetree/bindings/watchdog/ingenic,jz4740-wdt.txt
+++ b/Documentation/devicetree/bindings/watchdog/ingenic,jz4740-wdt.txt
@@ -1,17 +1,4 @@
Ingenic Watchdog Timer (WDT) Controller for JZ4740 & JZ4780
-Required properties:
-compatible: "ingenic,jz4740-watchdog" or "ingenic,jz4780-watchdog"
-reg: Register address and length for watchdog registers
-clocks: phandle to the RTC clock
-clock-names: should be "rtc"
-
-Example:
-
-watchdog: jz4740-watchdog@10002000 {
- compatible = "ingenic,jz4740-watchdog";
- reg = <0x10002000 0x10>;
-
- clocks = <&cgu JZ4740_CLK_RTC>;
- clock-names = "rtc";
-};
+This documentation has moved; for a description of the devicetree bindings of
+this driver, please refer to ../timer/ingenic,tcu.txt.
--
2.11.0
next prev parent reply other threads:[~2018-07-25 0:36 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-24 23:19 [PATCH v5 00/21] Ingenic JZ47xx TCU patchset v5 Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 01/21] mfd: Add ingenic-tcu.h header Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 02/21] dt-bindings: ingenic: Add DT bindings for TCU clocks Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 03/21] doc: Add doc for the Ingenic TCU hardware Paul Cercueil
2018-07-24 23:19 ` Paul Cercueil [this message]
2018-07-25 15:21 ` [PATCH v5 04/21] dt-bindings: Add doc for the Ingenic TCU drivers Rob Herring
2018-07-30 22:01 ` Paul Cercueil
2018-10-01 8:48 ` Daniel Lezcano
2018-07-24 23:19 ` [PATCH v5 05/21] clocksource: Add a new timer-ingenic driver Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 06/21] clocksource: Add driver for the Ingenic JZ47xx OST Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 07/21] MAINTAINERS: Add myself as maintainer for Ingenic TCU drivers Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 08/21] watchdog: jz4740: Use regmap and WDT clock provided by TCU driver Paul Cercueil
2018-07-25 1:14 ` Guenter Roeck
2018-07-30 21:27 ` Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 09/21] watchdog: jz4740: Drop dependency on MACH_JZ47xx, use COMPILE_TEST Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 10/21] pwm: jz4740: Use regmap and clocks from TCU driver Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 11/21] pwm: jz4740: Drop dependency on MACH_INGENIC, use COMPILE_TEST Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 12/21] pwm: jz4740: Remove unused devicetree compatible strings Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 13/21] pwm: jz4740: Add support for the JZ4725B Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 14/21] clk: jz4740: Add TCU clock Paul Cercueil
2018-07-25 15:22 ` Rob Herring
2018-07-25 23:30 ` Stephen Boyd
2018-07-24 23:19 ` [PATCH v5 15/21] MIPS: Kconfig: Select TCU timer driver when MACH_INGENIC is set Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 16/21] MIPS: jz4740: Add DTS nodes for the TCU drivers Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 17/21] MIPS: qi_lb60: Move PWM devices to devicetree Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 18/21] MIPS: qi_lb60: Use 750 kHz system timer & enable clocksource Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 19/21] MIPS: CI20: Reduce system timer clock to 3 MHz Paul Cercueil
2018-07-24 23:19 ` [PATCH v5 20/21] MIPS: CI20: defconfig: enable OST driver Paul Cercueil
2018-07-24 23:22 ` [PATCH v5 21/21] MIPS: jz4740: Drop obsolete code Paul Cercueil
[not found] <5bb49c78.1c69fb81.4b6a9.fb44SMTPIN_ADDED_MISSING@mx.google.com>
2018-10-03 12:47 ` [PATCH v5 04/21] dt-bindings: Add doc for the Ingenic TCU drivers Daniel Lezcano
[not found] <5bb4bb5d.1c69fb81.ed9a6.adc6SMTPIN_ADDED_MISSING@mx.google.com>
2018-10-03 13:02 ` Daniel Lezcano
[not found] <S23990757AbeJCKjwPaYBe/20181003103952Z+1106@eddie.linux-mips.org>
2018-10-06 9:20 ` Alexandre Belloni
[not found] <5bb4c6ad.1c69fb81.42bb.93ecSMTPIN_ADDED_MISSING@mx.google.com>
2018-10-09 6:36 ` Lee Jones
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=20180724231958.20659-5-paul@crapouillou.net \
--to=paul@crapouillou.net \
--cc=corbet@lwn.net \
--cc=daniel.lezcano@linaro.org \
--cc=devicetree@vger.kernel.org \
--cc=lee.jones@linaro.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mips@linux-mips.org \
--cc=linux-pwm@vger.kernel.org \
--cc=linux-watchdog@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mark.rutland@arm.com \
--cc=mturquette@baylibre.com \
--cc=paul.burton@mips.com \
--cc=ralf@linux-mips.org \
--cc=robh+dt@kernel.org \
--cc=sboyd@kernel.org \
--cc=tglx@linutronix.de \
--cc=thierry.reding@gmail.com \
--cc=wim@linux-watchdog.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).