linux-rtc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/2] dt-bindings: rtc: add generic bindings
@ 2018-11-11 19:31 Alexandre Belloni
  2018-11-11 19:31 ` [PATCH 2/2] dt-bindings: rtc: Move trivial RTCs to rtc.txt Alexandre Belloni
  2018-12-06 10:36 ` [PATCH 1/2] dt-bindings: rtc: add generic bindings Geert Uytterhoeven
  0 siblings, 2 replies; 7+ messages in thread
From: Alexandre Belloni @ 2018-11-11 19:31 UTC (permalink / raw)
  To: Rob Herring, linux-rtc; +Cc: devicetree, linux-kernel, Alexandre Belloni

Add generic binding documentation for the RTC subsystem.

Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
---
 Documentation/devicetree/bindings/rtc/rtc.txt | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/rtc.txt

diff --git a/Documentation/devicetree/bindings/rtc/rtc.txt b/Documentation/devicetree/bindings/rtc/rtc.txt
new file mode 100644
index 000000000000..221b7da50aca
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/rtc.txt
@@ -0,0 +1,30 @@
+Generic device tree bindings for Real Time Clock devices
+========================================================
+
+This document describes generic bindings which can be used to describe Real Time
+Clock devices in a device tree.
+
+Required properties
+-------------------
+
+- compatible : name of RTC device following generic names recommended practice.
+
+For other required properties e.g. to describe register sets,
+clocks, etc. check the binding documentation of the specific driver.
+
+Optional properties
+-------------------
+
+- start-year : if provided, the default hardware range supported by the RTC is
+               shifted so the first usable year is the specified one.
+
+The following properties may not be supported by all drivers. However, if a
+driver wants to support one of the below features, it should adapt the bindings
+below.
+- trickle-resistor-ohms : Selected resistor for trickle charger. Should be given
+                          if trickle charger should be enabled
+- trickle-diode-disable : Do not use internal trickle charger diode Should be
+                          given if internal trickle charger diode should be
+                          disabled
+- wakeup-source :         Enables wake up of host system on alarm
+
-- 
2.19.1


^ permalink raw reply related	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2018-12-07  9:47 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-11-11 19:31 [PATCH 1/2] dt-bindings: rtc: add generic bindings Alexandre Belloni
2018-11-11 19:31 ` [PATCH 2/2] dt-bindings: rtc: Move trivial RTCs to rtc.txt Alexandre Belloni
2018-12-03 23:45   ` Rob Herring
2018-12-04  0:04     ` Alexandre Belloni
2018-12-06 10:36 ` [PATCH 1/2] dt-bindings: rtc: add generic bindings Geert Uytterhoeven
2018-12-07  9:33   ` Alexandre Belloni
2018-12-07  9:47     ` Geert Uytterhoeven

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).