diff mbox series

[v2,1/8] dt-bindings: watchdog: realtek: Convert RTD119x to schema

Message ID 20191020040817.16882-2-afaerber@suse.de (mailing list archive)
State New, archived
Headers show
Series arm64: dts: Initial RTD1293/RTD1296 and DS418j/DS418 support | expand

Commit Message

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

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

Comments

Rob Herring (Arm) Oct. 25, 2019, 9:16 p.m. UTC | #1 
On Sun, Oct 20, 2019 at 06:08:10AM +0200, Andreas Färber wrote:
> Convert the Realtek watchdog binding to a YAML schema.
> 
> Signed-off-by: Andreas Färber <afaerber@suse.de>
> ---
>  v2: New
>  
>  .../bindings/watchdog/realtek,rtd119x.txt          | 17 ----------
>  .../bindings/watchdog/realtek,rtd119x.yaml         | 38 ++++++++++++++++++++++
>  2 files changed, 38 insertions(+), 17 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
>  create mode 100644 Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt b/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
> deleted file mode 100644
> index 05653054bd5b..000000000000
> --- a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
> +++ /dev/null
> @@ -1,17 +0,0 @@
> -Realtek RTD1295 Watchdog
> -========================
> -
> -Required properties:
> -
> -- compatible :  Should be "realtek,rtd1295-watchdog"
> -- reg        :  Specifies the physical base address and size of registers
> -- clocks     :  Specifies one clock input
> -
> -
> -Example:
> -
> -	watchdog@98007680 {
> -		compatible = "realtek,rtd1295-watchdog";
> -		reg = <0x98007680 0x100>;
> -		clocks = <&osc27M>;
> -	};
> diff --git a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml
> new file mode 100644
> index 000000000000..5d92cfdfd046
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/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/watchdog/realtek,rtd119x.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Realtek RTD1295 Watchdog
> +
> +maintainers:
> +  - Andreas Färber <afaerber@suse.de>
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: realtek,rtd1295-watchdog

You can drop the 'oneOf' here unless you're planning to add another 
entry with 2 compatible strings.

With that,

Reviewed-by: Rob Herring <robh@kernel.org>

> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +examples:
> +  - |
> +	watchdog@98007680 {
> +		compatible = "realtek,rtd1295-watchdog";
> +		reg = <0x98007680 0x100>;
> +		clocks = <&osc27M>;
> +	};
> +...
> -- 
> 2.16.4
>
Andreas Färber Oct. 25, 2019, 9:24 p.m. UTC | #2 
Am 25.10.19 um 23:16 schrieb Rob Herring:
> On Sun, Oct 20, 2019 at 06:08:10AM +0200, Andreas Färber wrote:
>> Convert the Realtek watchdog binding to a YAML schema.
>>
>> Signed-off-by: Andreas Färber <afaerber@suse.de>
>> ---
>>  v2: New
>>  
>>  .../bindings/watchdog/realtek,rtd119x.txt          | 17 ----------
>>  .../bindings/watchdog/realtek,rtd119x.yaml         | 38 ++++++++++++++++++++++
>>  2 files changed, 38 insertions(+), 17 deletions(-)
>>  delete mode 100644 Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
>>  create mode 100644 Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt b/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
>> deleted file mode 100644
>> index 05653054bd5b..000000000000
>> --- a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
>> +++ /dev/null
>> @@ -1,17 +0,0 @@
>> -Realtek RTD1295 Watchdog
>> -========================
>> -
>> -Required properties:
>> -
>> -- compatible :  Should be "realtek,rtd1295-watchdog"
>> -- reg        :  Specifies the physical base address and size of registers
>> -- clocks     :  Specifies one clock input
>> -
>> -
>> -Example:
>> -
>> -	watchdog@98007680 {
>> -		compatible = "realtek,rtd1295-watchdog";
>> -		reg = <0x98007680 0x100>;
>> -		clocks = <&osc27M>;
>> -	};
>> diff --git a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml
>> new file mode 100644
>> index 000000000000..5d92cfdfd046
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/watchdog/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/watchdog/realtek,rtd119x.yaml#"
>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>> +
>> +title: Realtek RTD1295 Watchdog
>> +
>> +maintainers:
>> +  - Andreas Färber <afaerber@suse.de>
>> +
>> +allOf:
>> +  - $ref: watchdog.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    oneOf:
>> +      - const: realtek,rtd1295-watchdog
> 
> You can drop the 'oneOf' here unless you're planning to add another 
> entry with 2 compatible strings.

It's a preparation for adding rtd1195-watchdog when needed, to make
future diffs smaller. There's also RTD1395 and RTD1619 to be tested.

> 
> With that,
> 
> Reviewed-by: Rob Herring <robh@kernel.org>

Thanks,
Andreas
Andreas Färber Oct. 27, 2019, 2:04 a.m. UTC | #3 
Am 25.10.19 um 23:24 schrieb Andreas Färber:
> Am 25.10.19 um 23:16 schrieb Rob Herring:
>> On Sun, Oct 20, 2019 at 06:08:10AM +0200, Andreas Färber wrote:
>>> +properties:
>>> +  compatible:
>>> +    oneOf:
>>> +      - const: realtek,rtd1295-watchdog
>>
>> You can drop the 'oneOf' here unless you're planning to add another 
>> entry with 2 compatible strings.
> 
> It's a preparation for adding rtd1195-watchdog when needed, to make
> future diffs smaller. There's also RTD1395 and RTD1619 to be tested.
> 
>> With that,
>>
>> Reviewed-by: Rob Herring <robh@kernel.org>

Self-NAK.

The example doesn't pass dt_binding_check: It doesn't like the tabs
retained from the original binding. Replacing them with four spaces
makes it pass. Will post a v3.

As for the compatibles, currently in the rtd1195.dtsi patch I'm reusing
"realtek,rtd1295-watchdog", to avoid a dependency on the watchdog tree.

Long-term that's kind of ugly as it uses a later model number.
That leaves us with two alternatives:

a) "realtek,rtd1195-watchdog", "realtek,rtd1295-watchdog" - this
requires oneOf. Allows to distinguish between RTD1195 and RTD1295 while
remaining compatible with the current driver.

b) "realtek,rtd1195-watchdog" - requires the driver change now and
requires the binding to be merged before I can use it in the DT but
doesn't need oneOf here.

Guenter, any preference here?

Thanks,
Andreas
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt b/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
deleted file mode 100644
index 05653054bd5b..000000000000
--- a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.txt
+++ /dev/null
@@ -1,17 +0,0 @@ 
-Realtek RTD1295 Watchdog
-========================
-
-Required properties:
-
-- compatible :  Should be "realtek,rtd1295-watchdog"
-- reg        :  Specifies the physical base address and size of registers
-- clocks     :  Specifies one clock input
-
-
-Example:
-
-	watchdog@98007680 {
-		compatible = "realtek,rtd1295-watchdog";
-		reg = <0x98007680 0x100>;
-		clocks = <&osc27M>;
-	};
diff --git a/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml b/Documentation/devicetree/bindings/watchdog/realtek,rtd119x.yaml
new file mode 100644
index 000000000000..5d92cfdfd046
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/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/watchdog/realtek,rtd119x.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Realtek RTD1295 Watchdog
+
+maintainers:
+  - Andreas Färber <afaerber@suse.de>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    oneOf:
+      - const: realtek,rtd1295-watchdog
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+examples:
+  - |
+	watchdog@98007680 {
+		compatible = "realtek,rtd1295-watchdog";
+		reg = <0x98007680 0x100>;
+		clocks = <&osc27M>;
+	};
+...