lkml.org 
[lkml]   [2014]   [Jul]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH v3 2/2] devicetree: Add Cadence WDT devicetree bindings documentation
    On Mon, Jul 14, 2014 at 01:16:09PM +0100, Harini Katakam wrote:
    > Add cadence-wdt bindings documentation.
    >
    > Signed-off-by: Harini Katakam <harinik@xilinx.com>
    > ---
    >
    > v3 changes:
    > - Change reset property type and improve description.
    > - Improve description of clocks and interrupts.
    > - Use watchdog@ in the example.
    > - Use only cdns compatible string for now.
    >
    > v2:
    > No changes
    >
    > ---
    > .../devicetree/bindings/watchdog/cadence-wdt.txt | 27 ++++++++++++++++++++
    > 1 file changed, 27 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..ab23e38
    > --- /dev/null
    > +++ b/Documentation/devicetree/bindings/watchdog/cadence-wdt.txt
    > @@ -0,0 +1,27 @@
    > +Zynq Watchdog Device Tree Bindings
    > +-------------------------------------------
    > +
    > +Required properties:
    > +- compatible : Should be "cdns,wdt-r1p2".
    > +- clocks : Input clock specifier. This should be the ref clk.

    This wording makes it sound like the watchdog block has more than one
    clock input. Does it?

    > +- reg : Physical base address and size of WDT registers map.
    > +- interrupts : Property with a value describing the interrupt
    > + number. This interrupt is used for indication
    > + when the watchdog times out.

    Just say "the watchdog timeout interrupt", or (better) use the name of
    the interrupt from the documentation.

    > +- interrupt-parent : Must be core interrupt controller.
    > +
    > +Optional properties
    > +- reset : If this property exists, then a reset is done
    > + when watchdog times out.

    That's a bit of an ambiguous name (too easy to misconstrue as a reset
    device reference). Do any other watchdogs have similar properties?

    Thanks,
    Mark.

    > +- timeout-sec : Watchdog timeout value (in seconds).
    > +
    > +Example:
    > + watchdog@f8005000 {
    > + compatible = "xlnx,zynq-wdt-r1p2";
    > + clocks = <&clkc 45>;
    > + interrupt-parent = <&intc>;
    > + interrupts = <0 9 1>;
    > + reg = <0xf8005000 0x1000>;
    > + reset;
    > + timeout-sec = <10>;
    > + };
    > --
    > 1.7.9.5
    >
    >


    \
     
     \ /
      Last update: 2014-07-14 17:41    [W:3.746 / U:0.272 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site