diff mbox

[v2,2/2] devicetree: Add Cadence WDT devicetree bindings documentation

Message ID 1401185895-3677-2-git-send-email-harinik@xilinx.com
State Superseded, archived
Headers show

Commit Message

Harini Katakam May 27, 2014, 10:18 a.m. UTC
Add cadence-wdt bindings documentation.

Signed-off-by: Harini Katakam <harinik@xilinx.com>
---

v2:
No changes

---
 .../devicetree/bindings/watchdog/cadence-wdt.txt   |   26 ++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/watchdog/cadence-wdt.txt

Comments

Mark Rutland May 29, 2014, 9:12 a.m. UTC | #1
On Tue, May 27, 2014 at 11:18:15AM +0100, Harini Katakam wrote:
> Add cadence-wdt bindings documentation.
> 
> Signed-off-by: Harini Katakam <harinik@xilinx.com>
> ---
> 
> v2:
> No changes
> 
> ---
>  .../devicetree/bindings/watchdog/cadence-wdt.txt   |   26 ++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
> new file mode 100644
> index 0000000..1f7a732
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
> @@ -0,0 +1,26 @@
> +Zynq Watchdog Device Tree Bindings
> +-------------------------------------------
> +
> +Required properties:
> +- compatible		: Should be "xlnx,zynq-wdt-r1p2" or "cdns,wdt-r1p2".

What's the difference? Can "cdns,wdt-r1p2" be a fallback for
"xlnx,zynq-wdt-r1p2"?

> +- clocks		: Clock phandles (see clock bindings for details).

Nit: Clocks aren't just phandles.

How many clocks? This implies several, the example shows one.

> +- reg			: Physical base address and size of WDT registers map.
> +- interrupts		: Property with a value describing the interrupt
> +			  number.

We know this is a property with a value. Describe what it logically is
(and optionally, the type is interrupt-sepcifier, though that gets
fuzzier with the interrupts-extended property).

> +- interrupt-parent	: Must be core interrupt controller.
> +
> +Optional properties
> +- reset			: Reset interrupt.

What does this mean? What type is this?

I have no idea if this is a boolean telling the OS to reset the
interrupt initially, or an index describing which interrupt is the reset
interrupt in either the interrupts property or some HW registers.

Cheers,
Mark.

> +- timeout-sec		: Watchdog timeout value (in seconds).
> +
> +Example:
> +
> +		wdt@f8005000 {
> +			compatible = "xlnx,zynq-wdt-r1p2";
> +			clocks = <&clkc 45>;
> +			interrupt-parent = <&intc>;
> +			interrupts = <0 9 1>;
> +			reg = <0xf8005000 0x1000>;
> +			reset = <0>;
> +			timeout-sec = <10>;
> +		} ;
> -- 
> 1.7.9.5
> 
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Harini Katakam May 29, 2014, 9:27 a.m. UTC | #2
Hi Mark,

On Thu, May 29, 2014 at 2:42 PM, Mark Rutland <mark.rutland@arm.com> wrote:
> On Tue, May 27, 2014 at 11:18:15AM +0100, Harini Katakam wrote:
>> Add cadence-wdt bindings documentation.
>>
>> Signed-off-by: Harini Katakam <harinik@xilinx.com>
>> ---
>>
>> v2:
>> No changes

<snip>

>> +Optional properties
>> +- reset                      : Reset interrupt.
>
> What does this mean? What type is this?
>
> I have no idea if this is a boolean telling the OS to reset the
> interrupt initially, or an index describing which interrupt is the reset
> interrupt in either the interrupts property or some HW registers.
>

The watchdog has an option to automatically reset when the counter
reaches zero. This property is an input based on which this automatic
reset is enabled or disabled.
I will improve the description of this property.

Regards,
Harini
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Michal Simek May 29, 2014, 9:37 a.m. UTC | #3
On 05/27/2014 12:18 PM, Harini Katakam wrote:
> Add cadence-wdt bindings documentation.
> 
> Signed-off-by: Harini Katakam <harinik@xilinx.com>
> ---
> 
> v2:
> No changes
> 
> ---
>  .../devicetree/bindings/watchdog/cadence-wdt.txt   |   26 ++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
> new file mode 100644
> index 0000000..1f7a732
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
> @@ -0,0 +1,26 @@
> +Zynq Watchdog Device Tree Bindings
> +-------------------------------------------
> +
> +Required properties:
> +- compatible		: Should be "xlnx,zynq-wdt-r1p2" or "cdns,wdt-r1p2".
> +- clocks		: Clock phandles (see clock bindings for details).
> +- reg			: Physical base address and size of WDT registers map.
> +- interrupts		: Property with a value describing the interrupt
> +			  number.
> +- interrupt-parent	: Must be core interrupt controller.
> +
> +Optional properties
> +- reset			: Reset interrupt.
> +- timeout-sec		: Watchdog timeout value (in seconds).
> +
> +Example:
> +
> +		wdt@f8005000 {

please use watchdog@ here
which is listed in ePAPR

Thanks,
Michal
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
new file mode 100644
index 0000000..1f7a732
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
@@ -0,0 +1,26 @@ 
+Zynq Watchdog Device Tree Bindings
+-------------------------------------------
+
+Required properties:
+- compatible		: Should be "xlnx,zynq-wdt-r1p2" or "cdns,wdt-r1p2".
+- clocks		: Clock phandles (see clock bindings for details).
+- reg			: Physical base address and size of WDT registers map.
+- interrupts		: Property with a value describing the interrupt
+			  number.
+- interrupt-parent	: Must be core interrupt controller.
+
+Optional properties
+- reset			: Reset interrupt.
+- timeout-sec		: Watchdog timeout value (in seconds).
+
+Example:
+
+		wdt@f8005000 {
+			compatible = "xlnx,zynq-wdt-r1p2";
+			clocks = <&clkc 45>;
+			interrupt-parent = <&intc>;
+			interrupts = <0 9 1>;
+			reg = <0xf8005000 0x1000>;
+			reset = <0>;
+			timeout-sec = <10>;
+		} ;