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@xxxxxxxxxxxxx> wrote:
> > This adds the Document for Freescale FTM PWM driver under
> > Documentation/devicetree/bindings/pwm/.
> >
> > Signed-off-by: Xiubo Li <Li.Xiubo@xxxxxxxxxxxxx>
> > ---
> > .../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.
-Matt
> > +
> > +
> > +Example:
> > +
> > +pwm0: pwm@40038000 {
> > + compatible = "fsl,vf610-ftm-pwm";
> > + reg = <0x40038000 0x1000>;
> > + #pwm-cells = <3>;
> > + clock-names = "ftm0", "ftm0_fix_sel", "ftm0_ext_sel";
> > + clocks = <&clks VF610_CLK_FTM0>,
> > + <&clks VF610_CLK_FTM0_FIX_SEL>,
> > + <&clks VF610_CLK_FTM0_EXT_SEL>;
> > + pinctrl-names = "default";
> > + pinctrl-0 = <&pinctrl_pwm0_1>;
> > + fsl,pwm-counter-clk = "ftm0_ext_sel";
> > +};
> > --
> > 1.8.0
> >
> >
>
>
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@xxxxxxxxxxxxxxxxxxx
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
