linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Chen-Yu Tsai <wens@csie.org>
To: Maxime Ripard <maxime.ripard@bootlin.com>,
	Alexandre Belloni <alexandre.belloni@bootlin.com>,
	Alessandro Zummo <a.zummo@towertech.it>,
	Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>, Rob Herring <robh+dt@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>
Cc: Chen-Yu Tsai <wens@csie.org>,
	linux-arm-kernel@lists.infradead.org, linux-rtc@vger.kernel.org,
	linux-clk@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-sunxi@googlegroups.com
Subject: [PATCH 01/15] dt-bindings: rtc: sun6i-rtc: Rewrite clock outputs as a list
Date: Wed, 28 Nov 2018 17:29:58 +0800	[thread overview]
Message-ID: <20181128093013.24442-2-wens@csie.org> (raw)
In-Reply-To: <20181128093013.24442-1-wens@csie.org>

The clock output section for this binding describes the two outputs in
the descriptions for both the #clock-cells and clock-output-names
properties.

Instead of overlapping information that is hard to read, rewrite the
clock outputs as a list of indices and descriptions. The properies
can reference this list instead. This will also make it easier to
add notes or conditions to the clocks, and also for adding new outputs.

Signed-off-by: Chen-Yu Tsai <wens@csie.org>
---
 Documentation/devicetree/bindings/rtc/sun6i-rtc.txt | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/rtc/sun6i-rtc.txt b/Documentation/devicetree/bindings/rtc/sun6i-rtc.txt
index 12c083c1140a..d3e96459fc66 100644
--- a/Documentation/devicetree/bindings/rtc/sun6i-rtc.txt
+++ b/Documentation/devicetree/bindings/rtc/sun6i-rtc.txt
@@ -10,10 +10,12 @@ Required properties:
 
 Required properties for new device trees
 - clocks	: phandle to the 32kHz external oscillator
-- clock-output-names : names of the LOSC and its external output clocks created
-- #clock-cells  : must be equals to 1. The RTC provides two clocks: the
-		  LOSC and its external output, with index 0 and 1
-		  respectively.
+- clock-output-names : names of the two clock outputs. See below.
+- #clock-cells  : must be equal to 1.
+
+The RTC provides the following clocks at the given indices:
+- 0: LOSC
+- 1: LOSC external output, known as X32KFOUT in the datasheet.
 
 Example:
 
-- 
2.20.0.rc1


  reply	other threads:[~2018-11-28  9:30 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-28  9:29 [PATCH 00/15] rtc: sun6i: clock rework and pre-H6 SoC support Chen-Yu Tsai
2018-11-28  9:29 ` Chen-Yu Tsai [this message]
2018-11-28 10:17   ` [PATCH 01/15] dt-bindings: rtc: sun6i-rtc: Rewrite clock outputs as a list Maxime Ripard
2018-11-28  9:29 ` [PATCH 02/15] dt-bindings: rtc: sun6i-rtc: Add compatible strings for pre-H6 variants Chen-Yu Tsai
2018-11-28 10:19   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 03/15] dt-bindings: rtc: sun6i-rtc: Deprecate external clock output for A31 Chen-Yu Tsai
2018-11-28 10:20   ` Maxime Ripard
2018-11-28 11:15     ` Chen-Yu Tsai
2018-11-28  9:30 ` [PATCH 04/15] dt-bindings: rtc: sun6i-rtc: Export internal RC oscillator Chen-Yu Tsai
2018-11-28 10:32   ` Maxime Ripard
2018-11-28 11:18     ` Chen-Yu Tsai
2018-12-03  9:06       ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 05/15] rtc: sun6i: Add default clock name for LOSC Chen-Yu Tsai
2018-11-28 10:21   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 06/15] rtc: sun6i: Add support for different variants Chen-Yu Tsai
2018-11-28 10:22   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 07/15] rtc: sun6i: Add support for all known pre-H6 variants Chen-Yu Tsai
2018-11-28 10:24   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 07/15] rtc: sun6i: Add support for all known variants Chen-Yu Tsai
2018-11-28  9:44   ` [linux-sunxi] " Chen-Yu Tsai
2018-11-28  9:30 ` [PATCH 08/15] rtc: sun6i: Expose internal oscillator through device tree Chen-Yu Tsai
2018-11-28 10:33   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 09/15] clk: sunxi-ng: r40: Force LOSC parent to RTC LOSC output Chen-Yu Tsai
2018-11-28 10:25   ` Maxime Ripard
2018-11-28 21:29   ` Stephen Boyd
2018-11-30  3:55     ` Chen-Yu Tsai
2018-11-28  9:30 ` [PATCH 10/15] ARM: dts: sun8i: a23/a33: Fix up RTC device node Chen-Yu Tsai
2018-11-28 10:26   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 11/15] ARM: dts: sunxi: h3/h5: Add clock accuracy for external oscillators Chen-Yu Tsai
2018-11-28 10:26   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 12/15] ARM: dts: sunxi: h3/h5: Fix up RTC device node and clock references Chen-Yu Tsai
2018-11-28 10:27   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 13/15] ARM: dts: sun8i: r40: Add clock accuracy for external oscillators Chen-Yu Tsai
2018-11-28 10:28   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 14/15] ARM: dts: sun8i: r40: Add RTC device node Chen-Yu Tsai
2018-11-28 10:28   ` Maxime Ripard
2018-11-28  9:30 ` [PATCH 15/15] arm64: dts: allwinner: a64: Fix up RTC device node and clock references Chen-Yu Tsai
2018-11-28 10:28   ` Maxime Ripard
2018-11-28 18:45 ` [linux-sunxi] [PATCH 00/15] rtc: sun6i: clock rework and pre-H6 SoC support Corentin Labbe

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=20181128093013.24442-2-wens@csie.org \
    --to=wens@csie.org \
    --cc=a.zummo@towertech.it \
    --cc=alexandre.belloni@bootlin.com \
    --cc=devicetree@vger.kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rtc@vger.kernel.org \
    --cc=linux-sunxi@googlegroups.com \
    --cc=mark.rutland@arm.com \
    --cc=maxime.ripard@bootlin.com \
    --cc=mturquette@baylibre.com \
    --cc=robh+dt@kernel.org \
    --cc=sboyd@kernel.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).