linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Amelie Delaunay <amelie.delaunay@st.com>
To: <a.zummo@towertech.it>, <alexandre.belloni@free-electrons.com>,
	<robh+dt@kernel.org>, <mark.rutland@arm.com>,
	<mcoquelin.stm32@gmail.com>, <alexandre.torgue@st.com>,
	<linux@armlinux.org.uk>
Cc: <rtc-linux@googlegroups.com>, <devicetree@vger.kernel.org>,
	<linux-arm-kernel@lists.infradead.org>,
	<linux-kernel@vger.kernel.org>, <gabriel.fernandez@st.com>,
	<amelie.delaunay@st.com>
Subject: [PATCH 2/8] dt-bindings: document the STM32 RTC bindings
Date: Fri, 2 Dec 2016 15:09:55 +0100	[thread overview]
Message-ID: <1480687801-19525-4-git-send-email-amelie.delaunay@st.com> (raw)
In-Reply-To: <1480687801-19525-2-git-send-email-amelie.delaunay@st.com>

This patch adds documentation of device tree bindings for the STM32 RTC.

Signed-off-by: Amelie Delaunay <amelie.delaunay@st.com>
---
 .../devicetree/bindings/rtc/st,stm32-rtc.txt       | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/st,stm32-rtc.txt

diff --git a/Documentation/devicetree/bindings/rtc/st,stm32-rtc.txt b/Documentation/devicetree/bindings/rtc/st,stm32-rtc.txt
new file mode 100644
index 0000000..4578838
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/st,stm32-rtc.txt
@@ -0,0 +1,31 @@
+STM32 Real Time Clock
+
+Required properties:
+- compatible: "st,stm32-rtc".
+- reg: address range of rtc register set.
+- clocks: reference to the clock entry ck_rtc.
+- clock-names: name of the clock used. Should be "ck_rtc".
+- interrupt-parent: phandle for the interrupt controller.
+- interrupts: rtc alarm interrupt.
+- interrupt-names: rtc alarm interrupt name, should be "alarm".
+- st,syscfg: phandle for pwrcfg, mandatory to disable/enable backup domain
+  (RTC registers) write protection.
+
+Optional properties (to override default ck_rtc parent clock):
+- assigned-clocks: reference to the ck_rtc clock entry.
+- assigned-clock-parents: phandle of the new parent clock of ck_rtc.
+
+Example:
+
+	rtc: rtc@40002800 {
+		compatible = "st,stm32-rtc";
+		reg = <0x40002800 0x400>;
+		clocks = <&rcc 1 CLK_RTC>;
+		clock-names = "ck_rtc";
+		assigned-clocks = <&rcc 1 CLK_RTC>;
+		assigned-clock-parents = <&rcc 1 CLK_LSE>;
+		interrupt-parent = <&exti>;
+		interrupts = <17 1>;
+		interrupt-names = "alarm";
+		st,syscfg = <&pwrcfg>;
+	};
-- 
1.9.1

  parent reply	other threads:[~2016-12-02 14:13 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-02 14:09 [PATCH 0/8] Add support for STM32 RTC Amelie Delaunay
2016-12-02 14:09 ` [PATCH 1/8] ARM: dts: stm32: set HSE_RTC clock frequency to 1 MHz on stm32f429 Amelie Delaunay
2016-12-02 14:09 ` Amelie Delaunay [this message]
2016-12-05 10:06   ` [PATCH 2/8] dt-bindings: document the STM32 RTC bindings Alexandre Belloni
2016-12-05 10:14     ` Amelie DELAUNAY
2016-12-02 14:09 ` [PATCH 3/8] rtc: add STM32 RTC driver Amelie Delaunay
2016-12-02 17:56   ` Mathieu Poirier
2016-12-05  9:43     ` Amelie DELAUNAY
2016-12-05 16:32       ` Mathieu Poirier
2016-12-07 10:16         ` Amelie DELAUNAY
2016-12-07 18:37       ` Alexandre Belloni
2016-12-12  9:59         ` Amelie DELAUNAY
2016-12-02 18:05   ` Mathieu Poirier
2016-12-05  9:45     ` Amelie DELAUNAY
2016-12-07 19:08   ` Alexandre Belloni
2016-12-02 14:09 ` [PATCH 4/8] ARM: dts: stm32: Add STM32 RTC support for STM32F429 MCU Amelie Delaunay
2016-12-02 14:09 ` [PATCH 5/8] ARM: dts: stm32: enable RTC on stm32f429-disco Amelie Delaunay
2016-12-02 14:09 ` [PATCH 6/8] ARM: dts: stm32: enable RTC on stm32f469-disco Amelie Delaunay
2016-12-02 14:10 ` [PATCH 7/8] ARM: dts: stm32: enable RTC on stm32429i-eval Amelie Delaunay
2016-12-02 14:10 ` [PATCH 8/8] ARM: configs: stm32: Add STM32 RTC support in STM32 defconfig Amelie Delaunay

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=1480687801-19525-4-git-send-email-amelie.delaunay@st.com \
    --to=amelie.delaunay@st.com \
    --cc=a.zummo@towertech.it \
    --cc=alexandre.belloni@free-electrons.com \
    --cc=alexandre.torgue@st.com \
    --cc=devicetree@vger.kernel.org \
    --cc=gabriel.fernandez@st.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@armlinux.org.uk \
    --cc=mark.rutland@arm.com \
    --cc=mcoquelin.stm32@gmail.com \
    --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).