diff mbox series

[1/3] dt-bindings: rtc-2127: Add bindings for nxp,rtc-2127.txt

Message ID 20200827091441.12972-1-qiang.zhao@nxp.com
State Changes Requested
Headers show
Series [1/3] dt-bindings: rtc-2127: Add bindings for nxp,rtc-2127.txt | expand

Commit Message

Qiang Zhao Aug. 27, 2020, 9:14 a.m. UTC
From: Zhao Qiang <qiang.zhao@nxp.com>

Add bindings for nxp,rtc-2127

Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com>
---
 Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt

Comments

Rob Herring (Arm) Sept. 9, 2020, 8:24 p.m. UTC | #1
On Thu, Aug 27, 2020 at 05:14:39PM +0800, Qiang Zhao wrote:
> From: Zhao Qiang <qiang.zhao@nxp.com>
> 
> Add bindings for nxp,rtc-2127
> 
> Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com>
> ---
>  Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt

Bindings should be in DT schema format now.
Qiang Zhao Sept. 10, 2020, 3:16 a.m. UTC | #2
On Thu, Sep 10, 2020 at 04:25AM, Rob Herring <robh@kernel.org> wrote:
> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: 2020年9月10日 4:25
> To: Qiang Zhao <qiang.zhao@nxp.com>
> Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> linux-kernel@vger.kernel.org
> Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> nxp,rtc-2127.txt
> 
> On Thu, Aug 27, 2020 at 05:14:39PM +0800, Qiang Zhao wrote:
> > From: Zhao Qiang <qiang.zhao@nxp.com>
> >
> > Add bindings for nxp,rtc-2127
> >
> > Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com>
> > ---
> >  Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt | 18
> ++++++++++++++++++
> >  1 file changed, 18 insertions(+)
> >  create mode 100644
> Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt
> 
> Bindings should be in DT schema format now.

Is there any doc description for DT schema format or example 
So that I can take as a reference. Thank you!

Best Regards
Qiang Zhao
Rob Herring (Arm) Sept. 11, 2020, 2:03 p.m. UTC | #3
On Wed, Sep 9, 2020 at 9:16 PM Qiang Zhao <qiang.zhao@nxp.com> wrote:
>
> On Thu, Sep 10, 2020 at 04:25AM, Rob Herring <robh@kernel.org> wrote:
> > -----Original Message-----
> > From: Rob Herring <robh@kernel.org>
> > Sent: 2020年9月10日 4:25
> > To: Qiang Zhao <qiang.zhao@nxp.com>
> > Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> > linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> > linux-kernel@vger.kernel.org
> > Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> > nxp,rtc-2127.txt
> >
> > On Thu, Aug 27, 2020 at 05:14:39PM +0800, Qiang Zhao wrote:
> > > From: Zhao Qiang <qiang.zhao@nxp.com>
> > >
> > > Add bindings for nxp,rtc-2127
> > >
> > > Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com>
> > > ---
> > >  Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt | 18
> > ++++++++++++++++++
> > >  1 file changed, 18 insertions(+)
> > >  create mode 100644
> > Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt
> >
> > Bindings should be in DT schema format now.
>
> Is there any doc description for DT schema format or example
> So that I can take as a reference. Thank you!

Documentation/devicetree/writing-schema.rst and about 1000 examples in
the kernel tree.

Rob
Alexandre Belloni Sept. 11, 2020, 9:34 p.m. UTC | #4
Hi,

The correct subject prefix is dt-bindings: rtc: pcf2127

On 27/08/2020 17:14:39+0800, Qiang Zhao wrote:
> From: Zhao Qiang <qiang.zhao@nxp.com>
> 
> Add bindings for nxp,rtc-2127
> 
> Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com>
> ---
>  Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt b/Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt
> new file mode 100644
> index 0000000..c822e10
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt

The proper filename is nxp,pcf2127.

> @@ -0,0 +1,18 @@
> +NXP PCF2127 SPI Real Time Clock
> +
> +Required properties:
> +- compatible: should be: "nxp,pcf2127"
> +                      or "nxp,pcf2129"
> +- reg: should be the SPI slave chipselect address
> +
> +Optional properties:
> +- no-watchdog: PCF2127 is not used as watchdog
> +

Please Cc the watchdog maintainers as this should probably end up being
a common watchdog binding.

> +Example:
> +
> +pcf2127: rtc@51 {
> +	compatible = "nxp,pcf2127";
> +	reg = <0x51>;
> +	interrupts = <0 150 0x4>;
> +	no-watchdog;
> +};
> -- 
> 2.7.4
>
Qiang Zhao Sept. 14, 2020, 7:08 a.m. UTC | #5
On Fri, Sep 11, 2020 at 22:03, Rob Herring <robh@kernel.org> wrote:

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: 2020年9月11日 22:03
> To: Qiang Zhao <qiang.zhao@nxp.com>
> Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> linux-kernel@vger.kernel.org
> Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> nxp,rtc-2127.txt
> 
> On Wed, Sep 9, 2020 at 9:16 PM Qiang Zhao <qiang.zhao@nxp.com> wrote:
> >
> > On Thu, Sep 10, 2020 at 04:25AM, Rob Herring <robh@kernel.org> wrote:
> > > -----Original Message-----
> > > From: Rob Herring <robh@kernel.org>
> > > Sent: 2020年9月10日 4:25
> > > To: Qiang Zhao <qiang.zhao@nxp.com>
> > > Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> > > linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> > > linux-kernel@vger.kernel.org
> > > Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> > > nxp,rtc-2127.txt
> > >
> > > On Thu, Aug 27, 2020 at 05:14:39PM +0800, Qiang Zhao wrote:
> > > > From: Zhao Qiang <qiang.zhao@nxp.com>
> > > >

Please help to review as below, if it is ok, I will send the new version patch. Thank you!

diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
new file mode 100644
index 0000000..809dd59
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/nxp,pcf2127.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: PCF RTCs
+
+maintainers:
+  - Qiang Zhao <qiang.zhao@nxp.com>
+
+allOf:
+  - $ref: "rtc.yaml#"
+
+properties:
+  compatible:
+    enum:
+      - nxp,pcf2127
+      - nxp,pcf2129
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  no-watchdog:
+    maxItems: 1
+
+  start-year: true
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+...

> 
> Documentation/devicetree/writing-schema.rst and about 1000 examples in the
> kernel tree.
> 
> Rob
Rob Herring (Arm) Sept. 14, 2020, 2:36 p.m. UTC | #6
On Mon, Sep 14, 2020 at 1:08 AM Qiang Zhao <qiang.zhao@nxp.com> wrote:
>
> On Fri, Sep 11, 2020 at 22:03, Rob Herring <robh@kernel.org> wrote:
>
> > -----Original Message-----
> > From: Rob Herring <robh@kernel.org>
> > Sent: 2020年9月11日 22:03
> > To: Qiang Zhao <qiang.zhao@nxp.com>
> > Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> > linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> > linux-kernel@vger.kernel.org
> > Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> > nxp,rtc-2127.txt
> >
> > On Wed, Sep 9, 2020 at 9:16 PM Qiang Zhao <qiang.zhao@nxp.com> wrote:
> > >
> > > On Thu, Sep 10, 2020 at 04:25AM, Rob Herring <robh@kernel.org> wrote:
> > > > -----Original Message-----
> > > > From: Rob Herring <robh@kernel.org>
> > > > Sent: 2020年9月10日 4:25
> > > > To: Qiang Zhao <qiang.zhao@nxp.com>
> > > > Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> > > > linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> > > > linux-kernel@vger.kernel.org
> > > > Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> > > > nxp,rtc-2127.txt
> > > >
> > > > On Thu, Aug 27, 2020 at 05:14:39PM +0800, Qiang Zhao wrote:
> > > > > From: Zhao Qiang <qiang.zhao@nxp.com>
> > > > >
>
> Please help to review as below, if it is ok, I will send the new version patch. Thank you!
>
> diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> new file mode 100644
> index 0000000..809dd59
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license new bindings please:

(GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/nxp,pcf2127.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PCF RTCs
> +
> +maintainers:
> +  - Qiang Zhao <qiang.zhao@nxp.com>
> +
> +allOf:
> +  - $ref: "rtc.yaml#"
> +
> +properties:
> +  compatible:
> +    enum:
> +      - nxp,pcf2127
> +      - nxp,pcf2129
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  no-watchdog:
> +    maxItems: 1

maxItems is for arrays. What's the type here? It should have a description too.

> +
> +  start-year: true
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +...
>
> >
> > Documentation/devicetree/writing-schema.rst and about 1000 examples in the
> > kernel tree.
> >
> > Rob
Qiang Zhao Sept. 15, 2020, 3:26 a.m. UTC | #7
On Thu, Sep 14, 2020 at 22:36, Rob Herring <robh@kernel.org> wrote:

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: 2020年9月14日 22:36
> To: Qiang Zhao <qiang.zhao@nxp.com>
> Cc: a.zummo@towertech.it; alexandre.belloni@bootlin.com;
> linux-rtc@vger.kernel.org; devicetree@vger.kernel.org;
> linux-kernel@vger.kernel.org
> Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> nxp,rtc-2127.txt
> 
> > > > > >
> >
> > Please help to review as below, if it is ok, I will send the new version patch.
> Thank you!
> >
> > diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> > b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> > new file mode 100644
> > index 0000000..809dd59
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> > @@ -0,0 +1,38 @@
> > +# SPDX-License-Identifier: GPL-2.0
> 
> Dual license new bindings please:
> > +
> > +title: PCF RTCs
> > +
> > +maintainers:
> > +  - Qiang Zhao <qiang.zhao@nxp.com>
> > +
> > +
> > +  no-watchdog:
> > +    maxItems: 1
> 
> maxItems is for arrays. What's the type here? It should have a description too.

Is it ok as below?
  no-watchdog:
    $ref: /schemas/types.yaml#/definitions/flag
    description:
      With this property, the device will not registered as a watchdog device.

> > >
> > > Documentation/devicetree/writing-schema.rst and about 1000 examples
> > > in the kernel tree.
> > >
> > > Rob
Best Regards
Qiang Zhao
Bruno Thomsen Sept. 17, 2020, 7:29 p.m. UTC | #8
Den man. 14. sep. 2020 kl. 09.08 skrev Qiang Zhao <qiang.zhao@nxp.com>:
>
> On Fri, Sep 11, 2020 at 22:03, Rob Herring <robh@kernel.org> wrote:

> Please help to review as below, if it is ok, I will send the new version patch. Thank you!
>
> diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> new file mode 100644
> index 0000000..809dd59
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/nxp,pcf2127.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PCF RTCs
> +
> +maintainers:
> +  - Qiang Zhao <qiang.zhao@nxp.com>
> +
> +allOf:
> +  - $ref: "rtc.yaml#"
> +
> +properties:
> +  compatible:
> +    enum:
> +      - nxp,pcf2127
> +      - nxp,pcf2129

The device driver have 3 compatible strings, "nxp,pca2129" is missing.

/Bruno

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  no-watchdog:
> +    maxItems: 1
> +
> +  start-year: true
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +...
>
> >
> > Documentation/devicetree/writing-schema.rst and about 1000 examples in the
> > kernel tree.
> >
> > Rob
Qiang Zhao Sept. 18, 2020, 1:45 a.m. UTC | #9
On Fri, Sep 18, 2020 at 03:29, Bruno Thomsen <bruno.thomsen@gmail.com> wrote:

> -----Original Message-----
> From: Bruno Thomsen <bruno.thomsen@gmail.com>
> Sent: 2020年9月18日 3:29
> To: Qiang Zhao <qiang.zhao@nxp.com>
> Cc: Rob Herring <robh@kernel.org>; a.zummo@towertech.it;
> alexandre.belloni@bootlin.com; linux-rtc@vger.kernel.org;
> devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH 1/3] dt-bindings: rtc-2127: Add bindings for
> nxp,rtc-2127.txt
> 
> Den man. 14. sep. 2020 kl. 09.08 skrev Qiang Zhao <qiang.zhao@nxp.com>:
> >
> > On Fri, Sep 11, 2020 at 22:03, Rob Herring <robh@kernel.org> wrote:
> 
> > Please help to review as below, if it is ok, I will send the new version patch.
> Thank you!
> >
> > diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> > b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> > new file mode 100644
> > index 0000000..809dd59
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/nxp,pcf2127.yaml
> > @@ -0,0 +1,38 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id:
> > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> >
> +cetree.org%2Fschemas%2Frtc%2Fnxp%2Cpcf2127.yaml%23&amp;data=02%7
> C01%7
> >
> +Cqiang.zhao%40nxp.com%7C5a271aa3d1ed46ea578108d85b3ff9f6%7C686e
> a1d3bc
> >
> +2b4c6fa92cd99c5c301635%7C0%7C0%7C637359677624002617&amp;sdata
> =UGZ9B6E
> > +xteIMvxc3zvPfr%2FjZVQuPD6DJ6b2kZ%2BOO%2BIA%3D&amp;reserved=0
> > +$schema:
> > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> >
> +cetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=02%7C01%7Cqiang
> .zha
> >
> +o%40nxp.com%7C5a271aa3d1ed46ea578108d85b3ff9f6%7C686ea1d3bc2b4
> c6fa92c
> >
> +d99c5c301635%7C0%7C0%7C637359677624002617&amp;sdata=7P2m9OvIs
> FS6Q2By9
> > +DNmK9Oq5Ff6B%2BNSEA4F7otTT8g%3D&amp;reserved=0
> > +
> > +title: PCF RTCs
> > +
> > +maintainers:
> > +  - Qiang Zhao <qiang.zhao@nxp.com>
> > +
> > +allOf:
> > +  - $ref: "rtc.yaml#"
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - nxp,pcf2127
> > +      - nxp,pcf2129
> 
> The device driver have 3 compatible strings, "nxp,pca2129" is missing.

Thank you for your reminder, I will add in next version.

> 
> /Bruno
> 
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  no-watchdog:
> > +    maxItems: 1
> > +
> > +  start-year: true
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +additionalProperties: false
> > +
> > +...
> >
> > >
> > > Documentation/devicetree/writing-schema.rst and about 1000 examples
> > > in the kernel tree.
> > >
> > > Rob
Best Regards
Qiang Zhao
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt b/Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt
new file mode 100644
index 0000000..c822e10
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/nxp,rtc-2127.txt
@@ -0,0 +1,18 @@ 
+NXP PCF2127 SPI Real Time Clock
+
+Required properties:
+- compatible: should be: "nxp,pcf2127"
+                      or "nxp,pcf2129"
+- reg: should be the SPI slave chipselect address
+
+Optional properties:
+- no-watchdog: PCF2127 is not used as watchdog
+
+Example:
+
+pcf2127: rtc@51 {
+	compatible = "nxp,pcf2127";
+	reg = <0x51>;
+	interrupts = <0 150 0x4>;
+	no-watchdog;
+};