linux-mips.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Paul Cercueil <paul@crapouillou.net>
To: rtc-linux@googlegroups.com,
	Alessandro Zummo <a.zummo@towertech.it>,
	Alexandre Belloni <alexandre.belloni@free-electrons.com>,
	Rob Herring <robh+dt@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Ralf Baechle <ralf@linux-mips.org>,
	Maarten ter Huurne <maarten@treewalker.org>,
	Lars-Peter Clausen <lars@metafoo.de>,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-mips@linux-mips.org
Cc: Paul Cercueil <paul@crapouillou.net>
Subject: [PATCH v2 2/7] Documentation: dt: Add binding info for jz4740-rtc driver
Date: Mon, 31 Oct 2016 00:02:42 +0100	[thread overview]
Message-ID: <20161030230247.20538-3-paul@crapouillou.net> (raw)
In-Reply-To: <20161030230247.20538-1-paul@crapouillou.net>

This commit adds documentation for the device-tree bindings of the
jz4740-rtc driver, which supports the RTC unit present in the JZ4740 and
JZ4780 SoCs from Ingenic.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
Acked-by: Maarten ter Huurne <maarten@treewalker.org>
---
 .../devicetree/bindings/rtc/ingenic,jz4740-rtc.txt | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/ingenic,jz4740-rtc.txt

v2:
- Remove 'interrupt-parent' of the list of required properties
- Add the -msec suffix for the DT entries that represent time

diff --git a/Documentation/devicetree/bindings/rtc/ingenic,jz4740-rtc.txt b/Documentation/devicetree/bindings/rtc/ingenic,jz4740-rtc.txt
new file mode 100644
index 0000000..df97594
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/ingenic,jz4740-rtc.txt
@@ -0,0 +1,37 @@
+JZ4740 and similar SoCs real-time clock driver
+
+Required properties:
+
+- compatible: One of:
+  - "ingenic,jz4740-rtc" - for use with the JZ4740 SoC
+  - "ingenic,jz4780-rtc" - for use with the JZ4780 SoC
+- reg: Address range of rtc register set
+- interrupts: IRQ number for the alarm interrupt
+- clocks: phandle to the "rtc" clock
+- clock-names: must be "rtc"
+
+Optional properties:
+- system-power-controller: To use this component as the
+  system power controller
+- reset-pin-assert-time-msec: Reset pin low-level assertion
+  time after wakeup (default 60ms; range 0-125ms if RTC clock
+  at 32 kHz)
+- min-wakeup-pin-assert-time-msec: Minimum wakeup pin assertion
+  time (default 100ms; range 0-2s if RTC clock at 32 kHz)
+
+Example:
+
+rtc@10003000 {
+	compatible = "ingenic,jz4740-rtc";
+	reg = <0x10003000 0x3F>;
+
+	interrupt-parent = <&intc>;
+	interrupts = <32>;
+
+	clocks = <&rtc_clock>;
+	clock-names = "rtc";
+
+	system-power-controller;
+	reset-pin-assert-time-msec = <60>;
+	min-wakeup-pin-assert-time-msec = <100>;
+};
-- 
2.9.3

  parent reply	other threads:[~2016-10-30 23:03 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-30 23:02 [PATCH v2 0/7] DT bindings for the jz4740-rtc driver Paul Cercueil
2016-10-30 23:02 ` [PATCH v2 1/7] rtc: rtc-jz4740: Add support for the RTC in the jz4780 SoC Paul Cercueil
2016-10-30 23:02 ` Paul Cercueil [this message]
2016-10-31  6:39   ` [PATCH v2 2/7] Documentation: dt: Add binding info for jz4740-rtc driver Rob Herring
2016-10-31  9:48   ` Sergei Shtylyov
2016-10-30 23:02 ` [PATCH v2 3/7] rtc: rtc-jz4740: Add support for devicetree Paul Cercueil
2016-10-30 23:02 ` [PATCH v2 4/7] rtc: jz4740_rtc: Add support for acting as the system power controller Paul Cercueil
2016-10-30 23:02 ` [PATCH v2 5/7] MIPS: jz4740: DTS: Probe the jz4740-rtc driver from devicetree Paul Cercueil
2016-10-31  9:50   ` Sergei Shtylyov
2016-10-30 23:02 ` [PATCH v2 6/7] MIPS: qi_lb60: Probe RTC driver from DT and use it as power controller Paul Cercueil
2016-10-30 23:02 ` [PATCH v2 7/7] MIPS: jz4740: Remove obsolete code Paul Cercueil
2016-10-31 20:39 ` [PATCH v3 1/7] rtc: rtc-jz4740: Add support for the RTC in the jz4780 SoC Paul Cercueil
2016-10-31 20:39   ` [PATCH v3 2/7] Documentation: dt: Add binding info for jz4740-rtc driver Paul Cercueil
2016-10-31 21:16     ` Rob Herring
2016-10-31 21:16       ` Rob Herring
2016-10-31 20:39   ` [PATCH v3 3/7] rtc: rtc-jz4740: Add support for devicetree Paul Cercueil
2016-10-31 20:39   ` [PATCH v3 4/7] rtc: jz4740_rtc: Add support for acting as the system power controller Paul Cercueil
2016-10-31 20:39   ` [PATCH v3 5/7] MIPS: jz4740: DTS: Probe the jz4740-rtc driver from devicetree Paul Cercueil
2016-10-31 20:39   ` [PATCH v3 6/7] MIPS: qi_lb60: Probe RTC driver from DT and use it as power controller Paul Cercueil
2016-10-31 20:39   ` [PATCH v3 7/7] MIPS: jz4740: Remove obsolete code Paul Cercueil
2016-11-04 23:08   ` [PATCH v3 1/7] rtc: rtc-jz4740: Add support for the RTC in the jz4780 SoC Alexandre Belloni

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=20161030230247.20538-3-paul@crapouillou.net \
    --to=paul@crapouillou.net \
    --cc=a.zummo@towertech.it \
    --cc=alexandre.belloni@free-electrons.com \
    --cc=devicetree@vger.kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mips@linux-mips.org \
    --cc=maarten@treewalker.org \
    --cc=mark.rutland@arm.com \
    --cc=ralf@linux-mips.org \
    --cc=robh+dt@kernel.org \
    --cc=rtc-linux@googlegroups.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).