[v1,29/43] dt-bindings: rtc: Add ST M48T86

Message ID 20230601054549.10843-11-nikita.shubin@maquefel.me
State New
Headers
Series None |

Commit Message

Nikita Shubin June 1, 2023, 5:45 a.m. UTC
  Add YAML bindings for ST M48T86 / Dallas DS12887 RTC.

Signed-off-by: Nikita Shubin <nikita.shubin@maquefel.me>
---

Notes:
    v0 -> v1:
    
    - s/dallas/st/
    - description for regs
    - s/additionalProperties/unevaluatedProperties/
    - add ref rtc.yaml
    - changed compatible to st,m48t86
    - dropped label in example
    - replaced Alessandro Alessandro to Alexandre Belloni

 .../bindings/rtc/st,m48t86-rtc.yaml           | 38 +++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
  

Comments

Krzysztof Kozlowski June 1, 2023, 8:18 a.m. UTC | #1
On 01/06/2023 07:45, Nikita Shubin wrote:
> Add YAML bindings for ST M48T86 / Dallas DS12887 RTC.
> 
> Signed-off-by: Nikita Shubin <nikita.shubin@maquefel.me>
> ---
> 
> Notes:
>     v0 -> v1:
>     
>     - s/dallas/st/
>     - description for regs
>     - s/additionalProperties/unevaluatedProperties/
>     - add ref rtc.yaml
>     - changed compatible to st,m48t86
>     - dropped label in example
>     - replaced Alessandro Alessandro to Alexandre Belloni
> 
>  .../bindings/rtc/st,m48t86-rtc.yaml           | 38 +++++++++++++++++++
>  1 file changed, 38 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml b/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
> new file mode 100644
> index 000000000000..eb8e6451d7c8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml

Filename based on compatible, so drop "rtc".

> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/st,m48t86-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ST M48T86 / Dallas DS12887 RTC wirh SRAM

typo: with

> +
> +maintainers:
> +  - Alexandre Belloni <alexandre.belloni@bootlin.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - st,m48t86
> +
> +  reg:
> +    items:
> +      - description: index register
> +      - description: data register
> +
> +allOf:
> +  - $ref: rtc.yaml
> +
> +unevaluatedProperties: false
> +
> +required:
> +  - compatible
> +  - reg

required goes after properties:

Keep the same order in all your patches.

> +
> +examples:
> +  - |
> +    rtc@10800000 {
> +      compatible = "st,m48t86";
> +      reg = <0x10800000 0x1>, <0x11700000 0x1>;

One byte long? Not a word?

> +    };
> +
> +...

Best regards,
Krzysztof
  
Nikita Shubin June 20, 2023, 7:30 a.m. UTC | #2
Hello Krzysztof!

On Thu, 2023-06-01 at 10:18 +0200, Krzysztof Kozlowski wrote:
> On 01/06/2023 07:45, Nikita Shubin wrote:
> > Add YAML bindings for ST M48T86 / Dallas DS12887 RTC.
> > 
> > Signed-off-by: Nikita Shubin <nikita.shubin@maquefel.me>
> > ---
> > 
> > Notes:
> >     v0 -> v1:
> >     
> >     - s/dallas/st/
> >     - description for regs
> >     - s/additionalProperties/unevaluatedProperties/
> >     - add ref rtc.yaml
> >     - changed compatible to st,m48t86
> >     - dropped label in example
> >     - replaced Alessandro Alessandro to Alexandre Belloni
> > 
> >  .../bindings/rtc/st,m48t86-rtc.yaml           | 38
> > +++++++++++++++++++
> >  1 file changed, 38 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/rtc/st,m48t86-
> > rtc.yaml b/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
> > new file mode 100644
> > index 000000000000..eb8e6451d7c8
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
> 
> Filename based on compatible, so drop "rtc".
> 
> > @@ -0,0 +1,38 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/rtc/st,m48t86-rtc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: ST M48T86 / Dallas DS12887 RTC wirh SRAM
> 
> typo: with
> 
> > +
> > +maintainers:
> > +  - Alexandre Belloni <alexandre.belloni@bootlin.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - st,m48t86
> > +
> > +  reg:
> > +    items:
> > +      - description: index register
> > +      - description: data register
> > +
> > +allOf:
> > +  - $ref: rtc.yaml
> > +
> > +unevaluatedProperties: false
> > +
> > +required:
> > +  - compatible
> > +  - reg
> 
> required goes after properties:
> 
> Keep the same order in all your patches.
> 
> > +
> > +examples:
> > +  - |
> > +    rtc@10800000 {
> > +      compatible = "st,m48t86";
> > +      reg = <0x10800000 0x1>, <0x11700000 0x1>;
> 
> One byte long? Not a word?

They are indeed one byte long:

https://elixir.bootlin.com/linux/v6.4-rc7/source/drivers/rtc/rtc-m48t86.c#L46

> 
> > +    };
> > +
> > +...
> 
> Best regards,
> Krzysztof
>
  

Patch

diff --git a/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml b/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
new file mode 100644
index 000000000000..eb8e6451d7c8
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/st,m48t86-rtc.yaml
@@ -0,0 +1,38 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/st,m48t86-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ST M48T86 / Dallas DS12887 RTC wirh SRAM
+
+maintainers:
+  - Alexandre Belloni <alexandre.belloni@bootlin.com>
+
+properties:
+  compatible:
+    enum:
+      - st,m48t86
+
+  reg:
+    items:
+      - description: index register
+      - description: data register
+
+allOf:
+  - $ref: rtc.yaml
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    rtc@10800000 {
+      compatible = "st,m48t86";
+      reg = <0x10800000 0x1>, <0x11700000 0x1>;
+    };
+
+...