Re: [PATCH 3/4] watchdog: st_wdt: Provide binding documentation for ST's LPC Watchdog driver

[Lee Jones <lee.jones@linaro.org>]

On Fri, 05 Sep 2014, Guenter Roeck wrote:
> On Thu, Sep 04, 2014 at 03:39:51PM +0100, Lee Jones wrote:
> > Signed-off-by: David Paris <david.paris@st.com>
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> 
> You might want to copy the devicetree mailing list for bindings approval.

This is strange.  There are two emails, exactly the same send 1 second
apart.  Once has the DT ML CC'ed, the other does not.  I think `git
send-email` picked up the *~ file left over by Emacs.  I'll endeavour
to remove those in future.

> > ---
> >  .../devicetree/bindings/watchdog/st-lpc-wdt.txt    | 27 ++++++++++++++++++++++
> >  1 file changed, 27 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/st-lpc-wdt.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/watchdog/st-lpc-wdt.txt b/Documentation/devicetree/bindings/watchdog/st-lpc-wdt.txt
> > new file mode 100644
> > index 0000000..f0e57ba
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/st-lpc-wdt.txt
> > @@ -0,0 +1,27 @@
> > +STMicroelectronics LPC Watchdog
> > +===============================
> > +
> > +Required properties
> > +
> > +- compatible 	: "st,<soc>-watchdog"
> 
> Is this acceptable ? I thought the supported bindings have to be listed
> explicitly.

I can do that.

> > +- reg		: LPC registers base address + range
> > +- reg-names	: Register map "base" and "syscfg-en" are compulsory "type" is
> 
> '.' after compulsory ?

Sure. :)

> > +		  platform dependent and not required for the STiH407.
> > +- clock-names 	: Should be "lpc_wdt"
> > +- clocks	: Clock used by LPC device
> > +- timeout-sec	: Qatchdog timeout in seconds
> 
> Watchdog



> > +- st,syscfg	: Syscfg node used to configure cpu reset type and mask
> > +- st,warm_reset	: If present, reset type will be 'warm'. If not, it will be cold
> 
> s/cold/cold./ ?

There shouldn't be any full stops.

Will change s/STiH407./STiH407/ above.

> > +
> > +Example:
> > +	watchdog@fde05000 {
> > +		compatible	= "st,stih416-lpc-watchdog";
> > +		reg		= <0xfde05000 0x1000> <0x204 0x4>;
> > +		reg-names	= "base", "syscfg-en"
> > +		clock-names	= "lpc_wdt";
> > +		clocks 		= <&clk_s_d3_flexgen CLK_LPC_0>;
> > +		timeout-sec	= <600>;
> > +		st,syscfg	= <&syscfg_core>;
> > +		st,warm_reset;
> > +	};
> > +
> 
> Empty line at the end results in a whitespace error when applying.

Will fix.

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog