[25/28] dt-bindings: rtc: Convert sa1100-rtc to json-schema
diff mbox series

Message ID 20200317093922.20785-26-lkundrak@v3.sk
State New
Headers show
Series
  • DT: Improve validation for Marvell SoCs
Related show

Commit Message

Lubomir Rintel March 17, 2020, 9:39 a.m. UTC
Convert the sa1100-rtc binding to DT schema format using json-schema.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 .../devicetree/bindings/rtc/sa1100-rtc.txt    | 17 ------
 .../devicetree/bindings/rtc/sa1100-rtc.yaml   | 55 +++++++++++++++++++
 2 files changed, 55 insertions(+), 17 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
 create mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml

Comments

Rob Herring March 27, 2020, 7:49 p.m. UTC | #1
On Tue, Mar 17, 2020 at 10:39:19AM +0100, Lubomir Rintel wrote:
> Convert the sa1100-rtc binding to DT schema format using json-schema.
> 
> Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> ---
>  .../devicetree/bindings/rtc/sa1100-rtc.txt    | 17 ------
>  .../devicetree/bindings/rtc/sa1100-rtc.yaml   | 55 +++++++++++++++++++
>  2 files changed, 55 insertions(+), 17 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
>  create mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt b/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> deleted file mode 100644
> index 968ac820254bb..0000000000000
> --- a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> +++ /dev/null
> @@ -1,17 +0,0 @@
> -* Marvell Real Time Clock controller
> -
> -Required properties:
> -- compatible: should be "mrvl,sa1100-rtc"
> -- reg: physical base address of the controller and length of memory mapped
> -  region.
> -- interrupts: Should be two. The first interrupt number is the rtc alarm
> -  interrupt and the second interrupt number is the rtc hz interrupt.
> -- interrupt-names: Assign name of irq resource.
> -
> -Example:
> -	rtc: rtc@d4010000 {
> -		compatible = "mrvl,mmp-rtc";
> -		reg = <0xd4010000 0x1000>;
> -		interrupts = <5>, <6>;
> -		interrupt-names = "rtc 1Hz", "rtc alarm";
> -	};
> diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> new file mode 100644
> index 0000000000000..53a8b72df9f34
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> @@ -0,0 +1,55 @@

License

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/sa1100-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell Real Time Clock controller bindings
> +
> +allOf:
> +  - $ref: rtc.yaml#
> +
> +maintainers:
> +  - devicetree@vger.kernel.org

Real person

> +
> +properties:
> +  compatible:
> +    enum:
> +      - mrvl,sa1100-rtc
> +      - mrvl,mmp-rtc
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1

clocks and resets weren't documented before. Fine to add here, but add 
that to the commit msg.

> +
> +  interrupts:
> +    minItems: 2
> +    maxItems: 2

Drop minItems.

> +
> +  interrupt-names:
> +    items:
> +      - const: 'rtc 1Hz'
> +      - const: 'rtc alarm'
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    rtc: rtc@d4010000 {
> +        compatible = "mrvl,mmp-rtc";
> +        reg = <0xd4010000 0x1000>;
> +        interrupts = <5>, <6>;
> +        interrupt-names = "rtc 1Hz", "rtc alarm";
> +    };
> +
> +...
> -- 
> 2.25.1
>
Lubomir Rintel May 17, 2020, 7:25 p.m. UTC | #2
On Fri, Mar 27, 2020 at 01:49:02PM -0600, Rob Herring wrote:
> On Tue, Mar 17, 2020 at 10:39:19AM +0100, Lubomir Rintel wrote:
> > Convert the sa1100-rtc binding to DT schema format using json-schema.
> > 
> > Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> > ---
> >  .../devicetree/bindings/rtc/sa1100-rtc.txt    | 17 ------
> >  .../devicetree/bindings/rtc/sa1100-rtc.yaml   | 55 +++++++++++++++++++
> >  2 files changed, 55 insertions(+), 17 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> >  create mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt b/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> > deleted file mode 100644
> > index 968ac820254bb..0000000000000
> > --- a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> > +++ /dev/null
> > @@ -1,17 +0,0 @@
> > -* Marvell Real Time Clock controller
> > -
> > -Required properties:
> > -- compatible: should be "mrvl,sa1100-rtc"
> > -- reg: physical base address of the controller and length of memory mapped
> > -  region.
> > -- interrupts: Should be two. The first interrupt number is the rtc alarm
> > -  interrupt and the second interrupt number is the rtc hz interrupt.
> > -- interrupt-names: Assign name of irq resource.
> > -
> > -Example:
> > -	rtc: rtc@d4010000 {
> > -		compatible = "mrvl,mmp-rtc";
> > -		reg = <0xd4010000 0x1000>;
> > -		interrupts = <5>, <6>;
> > -		interrupt-names = "rtc 1Hz", "rtc alarm";
> > -	};
> > diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> > new file mode 100644
> > index 0000000000000..53a8b72df9f34
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> > @@ -0,0 +1,55 @@
> 
> License

The original file lacked one. Should I just go with GPL-2.0?

> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/rtc/sa1100-rtc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Marvell Real Time Clock controller bindings
> > +
> > +allOf:
> > +  - $ref: rtc.yaml#
> > +
> > +maintainers:
> > +  - devicetree@vger.kernel.org
> 
> Real person

It's not clear who would that be.

> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - mrvl,sa1100-rtc
> > +      - mrvl,mmp-rtc
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  resets:
> > +    maxItems: 1
> 
> clocks and resets weren't documented before. Fine to add here, but add 
> that to the commit msg.
> 
> > +
> > +  interrupts:
> > +    minItems: 2
> > +    maxItems: 2
> 
> Drop minItems.

It needs to be exactly 2. I suppose for that I should drop maxItems
instead?

> > +
> > +  interrupt-names:
> > +    items:
> > +      - const: 'rtc 1Hz'
> > +      - const: 'rtc alarm'
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - interrupt-names
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    rtc: rtc@d4010000 {
> > +        compatible = "mrvl,mmp-rtc";
> > +        reg = <0xd4010000 0x1000>;
> > +        interrupts = <5>, <6>;
> > +        interrupt-names = "rtc 1Hz", "rtc alarm";
> > +    };
> > +
> > +...
> > -- 
> > 2.25.1
> >
Rob Herring May 18, 2020, 3:12 p.m. UTC | #3
On Sun, May 17, 2020 at 1:26 PM Lubomir Rintel <lkundrak@v3.sk> wrote:
>
> On Fri, Mar 27, 2020 at 01:49:02PM -0600, Rob Herring wrote:
> > On Tue, Mar 17, 2020 at 10:39:19AM +0100, Lubomir Rintel wrote:
> > > Convert the sa1100-rtc binding to DT schema format using json-schema.
> > >
> > > Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> > > ---
> > >  .../devicetree/bindings/rtc/sa1100-rtc.txt    | 17 ------
> > >  .../devicetree/bindings/rtc/sa1100-rtc.yaml   | 55 +++++++++++++++++++
> > >  2 files changed, 55 insertions(+), 17 deletions(-)
> > >  delete mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> > >  create mode 100644 Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> > >
> > > diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt b/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> > > deleted file mode 100644
> > > index 968ac820254bb..0000000000000
> > > --- a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
> > > +++ /dev/null
> > > @@ -1,17 +0,0 @@
> > > -* Marvell Real Time Clock controller
> > > -
> > > -Required properties:
> > > -- compatible: should be "mrvl,sa1100-rtc"
> > > -- reg: physical base address of the controller and length of memory mapped
> > > -  region.
> > > -- interrupts: Should be two. The first interrupt number is the rtc alarm
> > > -  interrupt and the second interrupt number is the rtc hz interrupt.
> > > -- interrupt-names: Assign name of irq resource.
> > > -
> > > -Example:
> > > -   rtc: rtc@d4010000 {
> > > -           compatible = "mrvl,mmp-rtc";
> > > -           reg = <0xd4010000 0x1000>;
> > > -           interrupts = <5>, <6>;
> > > -           interrupt-names = "rtc 1Hz", "rtc alarm";
> > > -   };
> > > diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> > > new file mode 100644
> > > index 0000000000000..53a8b72df9f34
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
> > > @@ -0,0 +1,55 @@
> >
> > License
>
> The original file lacked one. Should I just go with GPL-2.0?

Yes, that is what files in the kernel with no license default to. Or
figure out the authors and get permission to dual-license.

Rob

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt b/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
deleted file mode 100644
index 968ac820254bb..0000000000000
--- a/Documentation/devicetree/bindings/rtc/sa1100-rtc.txt
+++ /dev/null
@@ -1,17 +0,0 @@ 
-* Marvell Real Time Clock controller
-
-Required properties:
-- compatible: should be "mrvl,sa1100-rtc"
-- reg: physical base address of the controller and length of memory mapped
-  region.
-- interrupts: Should be two. The first interrupt number is the rtc alarm
-  interrupt and the second interrupt number is the rtc hz interrupt.
-- interrupt-names: Assign name of irq resource.
-
-Example:
-	rtc: rtc@d4010000 {
-		compatible = "mrvl,mmp-rtc";
-		reg = <0xd4010000 0x1000>;
-		interrupts = <5>, <6>;
-		interrupt-names = "rtc 1Hz", "rtc alarm";
-	};
diff --git a/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
new file mode 100644
index 0000000000000..53a8b72df9f34
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/sa1100-rtc.yaml
@@ -0,0 +1,55 @@ 
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/sa1100-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell Real Time Clock controller bindings
+
+allOf:
+  - $ref: rtc.yaml#
+
+maintainers:
+  - devicetree@vger.kernel.org
+
+properties:
+  compatible:
+    enum:
+      - mrvl,sa1100-rtc
+      - mrvl,mmp-rtc
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  interrupts:
+    minItems: 2
+    maxItems: 2
+
+  interrupt-names:
+    items:
+      - const: 'rtc 1Hz'
+      - const: 'rtc alarm'
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+
+additionalProperties: false
+
+examples:
+  - |
+    rtc: rtc@d4010000 {
+        compatible = "mrvl,mmp-rtc";
+        reg = <0xd4010000 0x1000>;
+        interrupts = <5>, <6>;
+        interrupt-names = "rtc 1Hz", "rtc alarm";
+    };
+
+...