diff mbox series

dt-bindings: rtc: convert MT7622 RTC to the json-schema

Message ID 20240123125043.27192-1-zajec5@gmail.com
State New
Headers show
Series dt-bindings: rtc: convert MT7622 RTC to the json-schema | expand

Commit Message

Rafał Miłecki Jan. 23, 2024, 12:50 p.m. UTC
From: Rafał Miłecki <rafal@milecki.pl>

This helps validating DTS files. Introduced changes:
1. Reworded title
2. Dropper redundant properties descriptions
3. Added required #include-s and adjusted "reg" in example

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---
 .../bindings/rtc/mediatek,mt7622-rtc.yaml     | 52 +++++++++++++++++++
 .../devicetree/bindings/rtc/rtc-mt7622.txt    | 21 --------
 2 files changed, 52 insertions(+), 21 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml
 delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-mt7622.txt

Comments

Conor Dooley Jan. 24, 2024, 5:33 p.m. UTC | #1
On Tue, Jan 23, 2024 at 01:50:43PM +0100, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@milecki.pl>
> 
> This helps validating DTS files. Introduced changes:
> 1. Reworded title
> 2. Dropper redundant properties descriptions
> 3. Added required #include-s and adjusted "reg" in example
> 
> Signed-off-by: Rafał Miłecki <rafal@milecki.pl>

Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.

> ---
>  .../bindings/rtc/mediatek,mt7622-rtc.yaml     | 52 +++++++++++++++++++
>  .../devicetree/bindings/rtc/rtc-mt7622.txt    | 21 --------
>  2 files changed, 52 insertions(+), 21 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml
>  delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-mt7622.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml b/Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml
> new file mode 100644
> index 000000000000..e74dfc161cfc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/mediatek,mt7622-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MediaTek MT7622 on-SoC RTC
> +
> +allOf:
> +  - $ref: rtc.yaml#
> +
> +maintainers:
> +  - Sean Wang <sean.wang@mediatek.com>
> +
> +properties:
> +  compatible:
> +    items:
> +      - const: mediatek,mt7622-rtc
> +      - const: mediatek,soc-rtc
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    const: rtc
> +
> +required:
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/mt7622-clk.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    rtc@10212800 {
> +        compatible = "mediatek,mt7622-rtc", "mediatek,soc-rtc";
> +        reg = <0x10212800 0x200>;
> +        interrupts = <GIC_SPI 129 IRQ_TYPE_LEVEL_LOW>;
> +        clocks = <&topckgen CLK_TOP_RTC>;
> +        clock-names = "rtc";
> +    };
> diff --git a/Documentation/devicetree/bindings/rtc/rtc-mt7622.txt b/Documentation/devicetree/bindings/rtc/rtc-mt7622.txt
> deleted file mode 100644
> index 09fe8f51476f..000000000000
> --- a/Documentation/devicetree/bindings/rtc/rtc-mt7622.txt
> +++ /dev/null
> @@ -1,21 +0,0 @@
> -Device-Tree bindings for MediaTek SoC based RTC
> -
> -Required properties:
> -- compatible	    : Should be
> -			"mediatek,mt7622-rtc", "mediatek,soc-rtc" : for MT7622 SoC
> -- reg 		    : Specifies base physical address and size of the registers;
> -- interrupts	    : Should contain the interrupt for RTC alarm;
> -- clocks	    : Specifies list of clock specifiers, corresponding to
> -		      entries in clock-names property;
> -- clock-names	    : Should contain "rtc" entries
> -
> -Example:
> -
> -rtc: rtc@10212800 {
> -	compatible = "mediatek,mt7622-rtc",
> -		     "mediatek,soc-rtc";
> -	reg = <0 0x10212800 0 0x200>;
> -	interrupts = <GIC_SPI 129 IRQ_TYPE_LEVEL_LOW>;
> -	clocks = <&topckgen CLK_TOP_RTC>;
> -	clock-names = "rtc";
> -};
> -- 
> 2.35.3
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml b/Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml
new file mode 100644
index 000000000000..e74dfc161cfc
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/mediatek,mt7622-rtc.yaml
@@ -0,0 +1,52 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/mediatek,mt7622-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MediaTek MT7622 on-SoC RTC
+
+allOf:
+  - $ref: rtc.yaml#
+
+maintainers:
+  - Sean Wang <sean.wang@mediatek.com>
+
+properties:
+  compatible:
+    items:
+      - const: mediatek,mt7622-rtc
+      - const: mediatek,soc-rtc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: rtc
+
+required:
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/mt7622-clk.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    rtc@10212800 {
+        compatible = "mediatek,mt7622-rtc", "mediatek,soc-rtc";
+        reg = <0x10212800 0x200>;
+        interrupts = <GIC_SPI 129 IRQ_TYPE_LEVEL_LOW>;
+        clocks = <&topckgen CLK_TOP_RTC>;
+        clock-names = "rtc";
+    };
diff --git a/Documentation/devicetree/bindings/rtc/rtc-mt7622.txt b/Documentation/devicetree/bindings/rtc/rtc-mt7622.txt
deleted file mode 100644
index 09fe8f51476f..000000000000
--- a/Documentation/devicetree/bindings/rtc/rtc-mt7622.txt
+++ /dev/null
@@ -1,21 +0,0 @@ 
-Device-Tree bindings for MediaTek SoC based RTC
-
-Required properties:
-- compatible	    : Should be
-			"mediatek,mt7622-rtc", "mediatek,soc-rtc" : for MT7622 SoC
-- reg 		    : Specifies base physical address and size of the registers;
-- interrupts	    : Should contain the interrupt for RTC alarm;
-- clocks	    : Specifies list of clock specifiers, corresponding to
-		      entries in clock-names property;
-- clock-names	    : Should contain "rtc" entries
-
-Example:
-
-rtc: rtc@10212800 {
-	compatible = "mediatek,mt7622-rtc",
-		     "mediatek,soc-rtc";
-	reg = <0 0x10212800 0 0x200>;
-	interrupts = <GIC_SPI 129 IRQ_TYPE_LEVEL_LOW>;
-	clocks = <&topckgen CLK_TOP_RTC>;
-	clock-names = "rtc";
-};