diff mbox

[v2,1/3] Documentation: Add documentation for the APM X-Gene SoC RTC DTS binding

Message ID 1396287370-1011-2-git-send-email-lho@apm.com (mailing list archive)
State New, archived
Headers show

Commit Message

Loc Ho March 31, 2014, 5:36 p.m. UTC
This patch adds documentation for the APM X-Gene SoC RTC DTS binding.

Signed-off-by: Rameshwar Prasad Sahu <rsahu@apm.com>
Signed-off-by: Loc Ho <lho@apm.com>
---
 .../devicetree/bindings/rtc/xgene-rtc.txt          |   28 ++++++++++++++++++++
 1 files changed, 28 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/rtc/xgene-rtc.txt

Comments

Rob Herring April 2, 2014, 1:18 a.m. UTC | #1
On Mon, Mar 31, 2014 at 12:36 PM, Loc Ho <lho@apm.com> wrote:
> This patch adds documentation for the APM X-Gene SoC RTC DTS binding.
>
> Signed-off-by: Rameshwar Prasad Sahu <rsahu@apm.com>
> Signed-off-by: Loc Ho <lho@apm.com>
> ---
>  .../devicetree/bindings/rtc/xgene-rtc.txt          |   28 ++++++++++++++++++++
>  1 files changed, 28 insertions(+), 0 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/rtc/xgene-rtc.txt
>
> diff --git a/Documentation/devicetree/bindings/rtc/xgene-rtc.txt b/Documentation/devicetree/bindings/rtc/xgene-rtc.txt
> new file mode 100644
> index 0000000..fd195c3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/xgene-rtc.txt
> @@ -0,0 +1,28 @@
> +* APM X-Gene Real Time Clock
> +
> +RTC controller for the APM X-Gene Real Time Clock
> +
> +Required properties:
> +- compatible : Should be "apm,xgene-rtc"
> +- reg: physical base address of the controller and length of memory mapped
> +  region.
> +- interrupts: IRQ line for the RTC.
> +- #clock-cells: Should be 1.

This does not belong here.

> +- clocks: Reference to the clock entry.
> +
> +Example:
> +
> +rtcclk: rtcclk {
> +       compatible = "fixed-clock";
> +       #clock-cells = <1>;
> +       clock-frequency = <100000000>;
> +       clock-output-names = "rtcclk";
> +};
> +
> +rtc: rtc@10510000 {
> +       compatible = "apm,xgene-rtc";
> +       reg = <0x0 0x10510000 0x0 0x400>;
> +       interrupts = <0x0 0x46 0x4>;
> +       #clock-cells = <1>;
> +       clocks = <&rtcclk 0>;
> +};
> --
> 1.5.5
>
>
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/rtc/xgene-rtc.txt b/Documentation/devicetree/bindings/rtc/xgene-rtc.txt
new file mode 100644
index 0000000..fd195c3
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/xgene-rtc.txt
@@ -0,0 +1,28 @@ 
+* APM X-Gene Real Time Clock
+
+RTC controller for the APM X-Gene Real Time Clock
+
+Required properties:
+- compatible : Should be "apm,xgene-rtc"
+- reg: physical base address of the controller and length of memory mapped
+  region.
+- interrupts: IRQ line for the RTC.
+- #clock-cells: Should be 1.
+- clocks: Reference to the clock entry.
+
+Example:
+
+rtcclk: rtcclk {
+	compatible = "fixed-clock";
+	#clock-cells = <1>;
+	clock-frequency = <100000000>;
+	clock-output-names = "rtcclk";
+};
+
+rtc: rtc@10510000 {
+	compatible = "apm,xgene-rtc";
+	reg = <0x0 0x10510000 0x0 0x400>;
+	interrupts = <0x0 0x46 0x4>;
+	#clock-cells = <1>;
+	clocks = <&rtcclk 0>;
+};