[v2,2/8] dt-bindings: rtc: realtek: Convert RTD119x to schema
diff mbox series

Message ID 20191020040817.16882-3-afaerber@suse.de
State Changes Requested
Headers show
Series
  • arm64: dts: Initial RTD1293/RTD1296 and DS418j/DS418 support
Related show

Checks

Context Check Description
robh/dt-meta-schema fail build log
robh/checkpatch warning "total: 0 errors, 2 warnings, 38 lines checked"

Commit Message

Andreas Färber Oct. 20, 2019, 4:08 a.m. UTC
Convert the RTD119x binding to a YAML schema.

Signed-off-by: Andreas Färber <afaerber@suse.de>
---
 v2: New
 
 .../devicetree/bindings/rtc/realtek,rtd119x.txt    | 16 ---------
 .../devicetree/bindings/rtc/realtek,rtd119x.yaml   | 38 ++++++++++++++++++++++
 2 files changed, 38 insertions(+), 16 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt
 create mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml

Comments

Rob Herring Oct. 25, 2019, 9:20 p.m. UTC | #1
On Sun, Oct 20, 2019 at 06:08:11AM +0200, Andreas Färber wrote:
> Convert the RTD119x binding to a YAML schema.
> 
> Signed-off-by: Andreas Färber <afaerber@suse.de>
> ---
>  v2: New
>  
>  .../devicetree/bindings/rtc/realtek,rtd119x.txt    | 16 ---------
>  .../devicetree/bindings/rtc/realtek,rtd119x.yaml   | 38 ++++++++++++++++++++++
>  2 files changed, 38 insertions(+), 16 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt
>  create mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml


> diff --git a/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
> new file mode 100644
> index 000000000000..71b7396bd469
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause

Missing ()

Though I'm not sure it matters other than consistency.

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/realtek,rtd119x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Realtek RTD129x Real-Time Clock
> +
> +allOf:
> +  - $ref: "rtc.yaml#"
> +
> +maintainers:
> +  - Andreas Färber <afaerber@suse.de>
> +
> +properties:
> +  compatible:
> +    const: realtek,rtd1295-rtc
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +    description: Specifies the clock gate
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +examples:
> +  - |
> +	rtc@9801b600 {
> +		compatible = "realtek,rtd1295-clk";
> +		reg = <0x9801b600 0x100>;
> +		clocks = <&clkc RTD1295_CLK_EN_MISC_RTC>;

You need the include file here or the example won't build (run 'make 
dt_binding_check').

> +	};
> +...
> -- 
> 2.16.4
>
Andreas Färber Oct. 28, 2019, 10:46 a.m. UTC | #2
Am 25.10.19 um 23:20 schrieb Rob Herring:
> On Sun, Oct 20, 2019 at 06:08:11AM +0200, Andreas Färber wrote:
>> Convert the RTD119x binding to a YAML schema.
>>
>> Signed-off-by: Andreas Färber <afaerber@suse.de>
>> ---
>>  v2: New
>>  
>>  .../devicetree/bindings/rtc/realtek,rtd119x.txt    | 16 ---------
>>  .../devicetree/bindings/rtc/realtek,rtd119x.yaml   | 38 ++++++++++++++++++++++
>>  2 files changed, 38 insertions(+), 16 deletions(-)
>>  delete mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt
>>  create mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
> 
> 
>> diff --git a/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
>> new file mode 100644
>> index 000000000000..71b7396bd469
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml

While renaming the file to .yaml I would like to also rename it to 1195.
It would need to be 1x9x to cover RTD1195 and e.g. RTD1296, and looking
forward the wildcard may need to be 1xxx to cover also RTD1619, which
quickly becomes unrecognizable.

>> @@ -0,0 +1,38 @@
>> +# SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause
> 
> Missing ()

Fixed.

> 
> Though I'm not sure it matters other than consistency.
> 
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/rtc/realtek,rtd119x.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Realtek RTD129x Real-Time Clock
>> +
>> +allOf:
>> +  - $ref: "rtc.yaml#"
>> +
>> +maintainers:
>> +  - Andreas Färber <afaerber@suse.de>
>> +
>> +properties:
>> +  compatible:
>> +    const: realtek,rtd1295-rtc
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    maxItems: 1
>> +    description: Specifies the clock gate
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +
>> +examples:
>> +  - |
>> +	rtc@9801b600 {
>> +		compatible = "realtek,rtd1295-clk";

This reveals a bug in the original binding example. Fixed to -rtc.

>> +		reg = <0x9801b600 0x100>;
>> +		clocks = <&clkc RTD1295_CLK_EN_MISC_RTC>;
> 
> You need the include file here or the example won't build (run 'make 
> dt_binding_check').

We can't. You acked the clk binding but the driver never got any review,
so it didn't get merged and cannot be depended on here.

I've changed it to an artificial 42 so that dt_binding_check passes.
I've also needed to fix the indentation to 4 spaces.

Regards,
Andreas

> 
>> +	};
>> +...
>> -- 
>> 2.16.4
>>
Alexandre Belloni Oct. 28, 2019, 11:29 a.m. UTC | #3
On 28/10/2019 11:46:48+0100, Andreas Färber wrote:
> Am 25.10.19 um 23:20 schrieb Rob Herring:
> > On Sun, Oct 20, 2019 at 06:08:11AM +0200, Andreas Färber wrote:
> >> Convert the RTD119x binding to a YAML schema.
> >>
> >> Signed-off-by: Andreas Färber <afaerber@suse.de>
> >> ---
> >>  v2: New
> >>  
> >>  .../devicetree/bindings/rtc/realtek,rtd119x.txt    | 16 ---------
> >>  .../devicetree/bindings/rtc/realtek,rtd119x.yaml   | 38 ++++++++++++++++++++++
> >>  2 files changed, 38 insertions(+), 16 deletions(-)
> >>  delete mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt
> >>  create mode 100644 Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
> > 
> > 
> >> diff --git a/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
> >> new file mode 100644
> >> index 000000000000..71b7396bd469
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
> 
> While renaming the file to .yaml I would like to also rename it to 1195.
> It would need to be 1x9x to cover RTD1195 and e.g. RTD1296, and looking
> forward the wildcard may need to be 1xxx to cover also RTD1619, which
> quickly becomes unrecognizable.
> 

I'm fine with removing wildcards as much as possible.

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt
deleted file mode 100644
index bbf1ccb5df31..000000000000
--- a/Documentation/devicetree/bindings/rtc/realtek,rtd119x.txt
+++ /dev/null
@@ -1,16 +0,0 @@ 
-Realtek RTD129x Real-Time Clock
-===============================
-
-Required properties:
-- compatible :  Should be "realtek,rtd1295-rtc"
-- reg        :  Specifies the physical base address and size
-- clocks     :  Specifies the clock gate
-
-
-Example:
-
-	rtc@9801b600 {
-		compatible = "realtek,rtd1295-clk";
-		reg = <0x9801b600 0x100>;
-		clocks = <&clkc RTD1295_CLK_EN_MISC_RTC>;
-	};
diff --git a/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
new file mode 100644
index 000000000000..71b7396bd469
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/realtek,rtd119x.yaml
@@ -0,0 +1,38 @@ 
+# SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/realtek,rtd119x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek RTD129x Real-Time Clock
+
+allOf:
+  - $ref: "rtc.yaml#"
+
+maintainers:
+  - Andreas Färber <afaerber@suse.de>
+
+properties:
+  compatible:
+    const: realtek,rtd1295-rtc
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+    description: Specifies the clock gate
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+examples:
+  - |
+	rtc@9801b600 {
+		compatible = "realtek,rtd1295-clk";
+		reg = <0x9801b600 0x100>;
+		clocks = <&clkc RTD1295_CLK_EN_MISC_RTC>;
+	};
+...