[PATCHv5 4/4] Documentation: Add device tree bindings for Freescale FTM PWM.

[Grant Likely]

On Sat, 26 Oct 2013 09:02:25 -0400, Matt Porter <matt.porter at linaro.org> wrote:
> On Fri, Oct 25, 2013 at 09:12:11PM +0100, Grant Likely wrote:
> > On Mon, 30 Sep 2013 14:13:31 +0800, Xiubo Li <Li.Xiubo at freescale.com> wrote:
> > > This adds the Document for Freescale FTM PWM driver under
> > > Documentation/devicetree/bindings/pwm/.
> > > 
> > > Signed-off-by: Xiubo Li <Li.Xiubo at freescale.com>
> > > ---
> > >  .../devicetree/bindings/pwm/pwm-fsl-ftm.txt        | 33 ++++++++++++++++++++++
> > >  1 file changed, 33 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt
> > > 
> > > diff --git a/Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt b/Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt
> > > new file mode 100644
> > > index 0000000..2c6969a
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/pwm/pwm-fsl-ftm.txt
> > > @@ -0,0 +1,33 @@
> > > +Freescale FTM PWM controller
> > > +
> > > +Required properties:
> > > +- compatible: Should be "fsl,vf610-ftm-pwm"
> > > +- reg: Physical base address and length of the controller's registers
> > > +- #pwm-cells: Should be 3. See pwm.txt in this directory for a description of
> > > +  the cells format.
> > > +- clock-names : Includes the following module clock source entries:
> > > +    "ftm0" (system clock),
> > > +    "ftm0_fix_sel" (fixed frequency clock),
> > > +    "ftm0_ext_sel" (external clock)
> > > +- clocks : Must contain a clock specifier for each entry in clock-names.
> > > +- fsl,pwm-counter-clk: The FTM PWM counter clock source, should be one of the
> > > +  entries in clock-names.
> > > +- pinctrl-names: must contain a "default" entry.
> > > +- pinctrl-NNN: One property must exist for each entry in pinctrl-names.
> > > +  See ../pinctrl/pinctrl-bindings.txt for details of the property values.
> > 
> > Looks okay to me.
> 
> For consistency, shouldn't it also have:
> 
> "See ../clock/clock-bindings.txt for details of the property values"
> 
> where appropriate like is done under the pwm/pinctrl uses?
> 
> IMHO, referencing parent bindings all of the time should be a documented
> best practice / requirement.

I agree. In fact, it should be part of the requirements on schema
tooling that we discussed last week at ksummit (email summary will be
provided)

g.