2019-10-20 04:11:39

by Andreas Färber

[permalink] [raw]
Subject: [PATCH v2 1/8] dt-bindings: watchdog: realtek: Convert RTD119x to schema

Convert the Realtek watchdog binding to a YAML schema.

Signed-off-by: Andreas Färber <[email protected]>
---
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 <[email protected]>
+
+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>;
+ };
+...
--
2.16.4


2019-10-25 21:17:57

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v2 1/8] dt-bindings: watchdog: realtek: Convert RTD119x to schema

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 <[email protected]>
> ---
> 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 <[email protected]>
> +
> +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 <[email protected]>

> +
> + 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
>

2019-10-25 21:28:03

by Andreas Färber

[permalink] [raw]
Subject: Re: [PATCH v2 1/8] dt-bindings: watchdog: realtek: Convert RTD119x to schema

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 <[email protected]>
>> ---
>> 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 <[email protected]>
>> +
>> +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 <[email protected]>

Thanks,
Andreas

--
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Felix Imendörffer
HRB 36809 (AG Nürnberg)

2019-10-27 02:06:57

by Andreas Färber

[permalink] [raw]
Subject: Re: [PATCH v2 1/8] dt-bindings: watchdog: realtek: Convert RTD119x to schema

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 <[email protected]>

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

--
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Felix Imendörffer
HRB 36809 (AG Nürnberg)