From: Maxime Ripard <maxime.ripard@bootlin.com>
To: Alexandre Belloni <alexandre.belloni@bootlin.com>,
Mark Rutland <mark.rutland@arm.com>,
Rob Herring <robh+dt@kernel.org>,
Frank Rowand <frowand.list@gmail.com>,
Chen-Yu Tsai <wens@csie.org>,
Maxime Ripard <maxime.ripard@bootlin.com>
Cc: devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-rtc@vger.kernel.org
Subject: [PATCH 02/10] dt-bindings: rtc: Add YAML schemas for the generic RTC bindings
Date: Mon, 27 May 2019 14:00:34 +0200 [thread overview]
Message-ID: <3220382f2eb8ba3cda1388882b2f4b53f75414e6.1558958381.git-series.maxime.ripard@bootlin.com> (raw)
In-Reply-To: <290402405a34506997fd2fab2c4c1486dbe6b7e5.1558958381.git-series.maxime.ripard@bootlin.com>
The real time clocks have a bunch of generic properties that are needed in
a device tree. Add a YAML schemas for those.
Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
---
Documentation/devicetree/bindings/rtc/rtc.txt | 34 +-------------
Documentation/devicetree/bindings/rtc/rtc.yaml | 50 +++++++++++++++++++-
2 files changed, 51 insertions(+), 33 deletions(-)
create mode 100644 Documentation/devicetree/bindings/rtc/rtc.yaml
diff --git a/Documentation/devicetree/bindings/rtc/rtc.txt b/Documentation/devicetree/bindings/rtc/rtc.txt
index 234bd2af1830..b8d36fce5e2d 100644
--- a/Documentation/devicetree/bindings/rtc/rtc.txt
+++ b/Documentation/devicetree/bindings/rtc/rtc.txt
@@ -1,33 +1 @@
-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
-- quartz-load-femtofarads : The capacitive load of the quartz(x-tal),
- expressed in femto Farad (fF).
- The default value shall be listed (if optional),
- and likewise all valid values.
+This file has been moved to rtc.yaml.
diff --git a/Documentation/devicetree/bindings/rtc/rtc.yaml b/Documentation/devicetree/bindings/rtc/rtc.yaml
new file mode 100644
index 000000000000..ee237b2ed66a
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/rtc.yaml
@@ -0,0 +1,50 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RTC Generic Binding
+
+maintainers:
+ - Alexandre Belloni <alexandre.belloni@bootlin.com>
+
+description: |
+ This document describes generic bindings which can be used to
+ describe Real Time Clock devices in a device tree.
+
+properties:
+ $nodename:
+ pattern: "^rtc(@.*|-[0-9a-f])*$"
+
+ quartz-load-femtofarads:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ The capacitive load of the quartz(x-tal), expressed in femto
+ Farad (fF). The default value shall be listed (if optional),
+ and likewise all valid values.
+
+ start-year:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ If provided, the default hardware range supported by the RTC is
+ shifted so the first usable year is the specified one.
+
+ trickle-diode-disable:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description:
+ Do not use internal trickle charger diode. Should be given if
+ internal trickle charger diode should be disabled.
+
+ trickle-resistor-ohms:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Selected resistor for trickle charger. Should be given
+ if trickle charger should be enabled.
+
+ wakeup-source:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description:
+ Enables wake up of host system on alarm.
+
+...
--
git-series 0.9.1
next prev parent reply other threads:[~2019-05-27 12:00 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-27 12:00 [PATCH 01/10] dt-bindings: rtc: Move trivial RTC over to trivial devices Maxime Ripard
2019-05-27 12:00 ` Maxime Ripard [this message]
2019-05-27 12:00 ` [PATCH 03/10] dt-bindings: rtc: Convert Allwinner A10 RTC to a schema Maxime Ripard
2019-05-28 3:33 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 04/10] dt-bindings: rtc: Convert Allwinner A31 " Maxime Ripard
2019-05-28 3:37 ` Chen-Yu Tsai
2019-05-28 3:45 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 05/10] dt-bindings: rtc: sun6i: Add the R40 RTC compatible Maxime Ripard
2019-05-28 3:45 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 06/10] rtc: sun6i: Add R40 compatible Maxime Ripard
2019-05-28 3:46 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 07/10] ARM: dts: sun6i: Fix RTC node Maxime Ripard
2019-05-28 3:46 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 08/10] ARM: dts: sun6i: Add external crystals accuracy Maxime Ripard
2019-05-28 3:35 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 09/10] ARM: dts: sun8i: v3s: Fix the RTC node Maxime Ripard
2019-05-28 3:47 ` Chen-Yu Tsai
2019-05-27 12:00 ` [PATCH 10/10] ARM: dts: r40: Change the RTC compatible Maxime Ripard
2019-05-28 3:47 ` Chen-Yu Tsai
2019-05-27 12:06 ` [PATCH 01/10] dt-bindings: rtc: Move trivial RTC over to trivial devices Alexandre Belloni
2019-05-27 12:18 ` Maxime Ripard
2019-05-27 16:06 ` Alexandre Belloni
2019-05-28 12:20 ` Maxime Ripard
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=3220382f2eb8ba3cda1388882b2f4b53f75414e6.1558958381.git-series.maxime.ripard@bootlin.com \
--to=maxime.ripard@bootlin.com \
--cc=alexandre.belloni@bootlin.com \
--cc=devicetree@vger.kernel.org \
--cc=frowand.list@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-rtc@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=robh+dt@kernel.org \
--cc=wens@csie.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).