devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Boris BREZILLON <brezillonboris@gmail.com>
To: Nicolas Ferre <nicolas.ferre@atmel.com>,
	Mike Turquette <mturquette@linaro.org>,
	Alexandre Belloni <alexandre.belloni@free-electrons.com>,
	Jean-Jacques Hiblot <jjhiblot@traphandler.com>
Cc: devicetree@vger.kernel.org,
	Boris BREZILLON <b.brezillon.dev@gmail.com>,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org
Subject: [PATCH 02/11] clk: at91: update main clk documentation
Date: Tue, 18 Mar 2014 21:18:35 +0100	[thread overview]
Message-ID: <1395173924-3648-3-git-send-email-b.brezillon.dev@gmail.com> (raw)
In-Reply-To: <1395173924-3648-1-git-send-email-b.brezillon.dev@gmail.com>

Update main clk documentation to match main clk implementation rework.

Signed-off-by: Boris BREZILLON <b.brezillon.dev@gmail.com>
---
 .../devicetree/bindings/clock/at91-clock.txt       |   56 ++++++++++++++++----
 1 file changed, 47 insertions(+), 9 deletions(-)

diff --git a/Documentation/devicetree/bindings/clock/at91-clock.txt b/Documentation/devicetree/bindings/clock/at91-clock.txt
index cd5e239..9a7025b 100644
--- a/Documentation/devicetree/bindings/clock/at91-clock.txt
+++ b/Documentation/devicetree/bindings/clock/at91-clock.txt
@@ -15,8 +15,13 @@ Required properties:
 		All at91 specific clocks (clocks defined below) must be child
 		node of the PMC node.
 
+	"atmel,at91rm9200-clk-main-osc"
+	"atmel,at91sam9x5-clk-main-rc-osc"
+		at91 main clk sources
+
+	"atmel,at91sam9x5-clk-main"
 	"atmel,at91rm9200-clk-main":
-		at91 main oscillator
+		at91 main clock
 
 	"atmel,at91rm9200-clk-master" or
 	"atmel,at91sam9x5-clk-master":
@@ -85,24 +90,57 @@ For example:
 		/* put at91 clocks here */
 	};
 
+Required properties for main clock oscillator:
+- interrupt-parent : must reference the PMC node.
+- interrupts : shall be set to "<0>".
+- clock-frequency : define the internal RC oscillator frequency.
+
+Optional properties:
+- clock-accuracy : define the internal RC oscillator accuracy.
+
+For example:
+	main_rc_osc: main_rc_osc {
+		compatible = "atmel,at91sam9x5-clk-main-rc-osc";
+		interrupt-parent = <&pmc>;
+		interrupts = <0>;
+		clock-frequency = <12000000>;
+		clock-accuracy = <50000000>;
+	};
+
+Required properties for main clock internal RC oscillator:
+- interrupt-parent : must reference the PMC node.
+- interrupts : shall be set to "<0>".
+- #clock-cells : from common clock binding; shall be set to 0.
+- clocks : shall encode the main osc source clk sources (see atmel datasheet).
+
+Optional properties:
+- atmel,osc-bypass : boolean property. Specified if a clock signal is provided
+  on XIN.
+
+  clock signal is directly provided on XIN pin.
+
+For example:
+	main_osc: main_osc {
+		compatible = "atmel,at91rm9200-clk-main-osc";
+		interrupt-parent = <&pmc>;
+		interrupts = <0>;
+		#clock-cells = <0>;
+		clocks = <&main_xtal>;
+	};
+
 Required properties for main clock:
 - interrupt-parent : must reference the PMC node.
 - interrupts : shall be set to "<0>".
 - #clock-cells : from common clock binding; shall be set to 0.
-- clocks (optional if clock-frequency is provided) : shall be the slow clock
-	phandle. This clock is used to calculate the main clock rate if
-	"clock-frequency" is not provided.
-- clock-frequency : the main oscillator frequency.Prefer the use of
-	"clock-frequency" over automatic clock rate calculation.
+- clocks : shall encode the main clk sources (see atmel datasheet).
 
 For example:
 	main: mainck {
-		compatible = "atmel,at91rm9200-clk-main";
+		compatible = "atmel,at91sam9x5-clk-main";
 		interrupt-parent = <&pmc>;
 		interrupts = <0>;
 		#clock-cells = <0>;
-		clocks = <&ck32k>;
-		clock-frequency = <18432000>;
+		clocks = <&main_rc_osc &main_osc>;
 	};
 
 Required properties for master clock:
-- 
1.7.9.5

  parent reply	other threads:[~2014-03-18 20:18 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-18 20:18 [PATCH 00/11] ARM: at91: rework main and slow clk implementation Boris BREZILLON
2014-03-18 20:18 ` [PATCH 01/11] clk: at91: rework main " Boris BREZILLON
2014-03-18 20:18 ` Boris BREZILLON [this message]
2014-03-18 20:18 ` [PATCH 03/11] clk: at91: add slow clks driver Boris BREZILLON
2014-03-18 20:18 ` [PATCH 04/11] clk: at91: add slow clk documentation Boris BREZILLON
2014-03-18 20:18 ` [PATCH 05/11] ARM: at91/dt: move sama5d3 SoC to the new main/slow clk model Boris BREZILLON
2014-03-18 20:18 ` [PATCH 06/11] ARM: at91/dt: add xtal frequencies to sama5d3xcm boards Boris BREZILLON
2014-03-18 20:18 ` [PATCH 07/11] ARM: at91/dt: add xtal frequencies to sama5d3 xplained board Boris BREZILLON
2014-03-18 20:18 ` [PATCH 08/11] ARM: at91/dt: move at91sam9261 SoC to the new main clock model Boris BREZILLON
     [not found]   ` <1395173924-3648-9-git-send-email-b.brezillon.dev-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-03-20  9:22     ` Jean-Jacques Hiblot
2014-03-18 20:18 ` [PATCH 09/11] ARM: at91/dt: define main xtal frequency of the at91sam9261ek board Boris BREZILLON
2014-03-20  9:24   ` Jean-Jacques Hiblot
2014-03-20  9:50     ` Boris BREZILLON
2014-03-20 10:09       ` Jean-Jacques Hiblot
2014-03-18 20:18 ` [PATCH 10/11] ARM: at91/dt: move at91sam9rl SoC to the new slow/main clock models Boris BREZILLON
     [not found]   ` <1395173924-3648-11-git-send-email-b.brezillon.dev-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-03-19 15:39     ` Alexandre Belloni
2014-03-18 20:18 ` [PATCH 11/11] ARM: at91/dt: define sam9rlek crystal frequencies Boris BREZILLON
2014-03-19 15:40   ` Alexandre Belloni
2014-03-19  8:19 ` [PATCH 00/11] ARM: at91: rework main and slow clk implementation Jean-Jacques Hiblot
     [not found] ` <3485B87A-1832-4EE3-8613-B5165C282397@jcrosoft.com>
2014-03-19  9:48   ` Boris BREZILLON

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=1395173924-3648-3-git-send-email-b.brezillon.dev@gmail.com \
    --to=brezillonboris@gmail.com \
    --cc=alexandre.belloni@free-electrons.com \
    --cc=b.brezillon.dev@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=jjhiblot@traphandler.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mturquette@linaro.org \
    --cc=nicolas.ferre@atmel.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).