Re: [v2,2/2] Documentation: dt: binding: rtc: add binding for ftm alarm driver

From: Rob Herring
Date: Wed Jul 10 2019 - 16:26:25 EST


On Wed, Jul 10, 2019 at 1:46 PM Li Yang <leoyang.li@xxxxxxx> wrote:
>
> On Wed, Jul 10, 2019 at 6:35 AM Biwen Li <biwen.li@xxxxxxx> wrote:
> >
> > The patch adds binding for ftm alarm driver
> >
> > Signed-off-by: Biwen Li <biwen.li@xxxxxxx>
>
> Looks like I commented the older version just now. Adding Rob to this
> version too.

More importantly, re-send the patch to the DT list so patchwork tracks it.

>
> > ---
> > Change in v2:
> > - replace ls1043a with ls1088a as example
> > - add rcpm node and fsl,rcpm-wakeup property
> >
> > .../devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt | 40 ++++++++++++++++++++++
> > 1 file changed, 40 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> >
> > diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> > new file mode 100644
> > index 0000000..010984a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> > @@ -0,0 +1,40 @@
> > +Freescale FlexTimer Module (FTM) Alarm
> > +
> > +Note: The driver need work with RCPM driver to wake up system in sleep.
> > +
> > +Required properties:
> > +
> > +- compatible : Should be "fsl,ftm-alarm" or "fsl,<chip>-ftm-alarm", the

fsl,ftm-alarm should be a fallback, not on its own.

> > + supported chips include
> > + "fsl,ls1012a-ftm-alarm"
> > + "fsl,ls1021a-ftm-alarm"
> > + "fsl,ls1028a-ftm-alarm"
> > + "fsl,ls1043a-ftm-alarm"
> > + "fsl,ls1046a-ftm-alarm"
> > + "fsl,ls1088a-ftm-alarm"
> > + "fsl,ls208xa-ftm-alarm"
> > +- reg : Specifies base physical address and size of the register sets for the
> > + FlexTimer Module and base physical address of IP Powerdown Exception Control
> > + Register.
> > +- reg-names: names of the mapped memory regions listed in regs property.
> > + should include the following entries:
> > + "ftm": Address of the register sets for FlexTimer Module

Says required, but not in the example. I'd just remove this as -names
is pointless when there is only 1 entry.

> > +- interrupts : Should be the FlexTimer Module interrupt.
> > +- fsl,rcpm-wakeup property and rcpm node : Please refer
> > + Documentation/devicetree/bindings/soc/fsl/rcpm.txt
>
> Looks better.
>
> > +- big-endian: If the host controller is big-endian mode, specify this property.
> > + The default endian mode is little-endian.
>
> Same comment about optional property.
>
> > +
> > +Example:
> > +rcpm: rcpm@1e34050 {
> > + compatible = "fsl,ls1088a-rcpm", "fsl,qoriq-rcpm-2.1+";
> > + reg = <0x0 0x1e34050 0x0 0x4>;
> > + fsl,#rcpm-wakeup-cells = <1>;

1 cell here...

> > +}
> > +
> > +ftm_alarm0: timer@2800000 {
> > + compatible = "fsl,ftm-alarm";
> > + reg = <0x0 0x2800000 0x0 0x10000>;
> > + fsl,rcpm-wakeup = <&rcpm 0x0 0x4000>;

...and 2 cells here.

> > + interrupts = <0 44 4>;
> > +}
> > --
> > 2.7.4
> >