[PATCH v2 1/2] dt-bindings: rtc: m41t80: Convert text schema to YAML one

[PATCH v2 1/2] dt-bindings: rtc: m41t80: Convert text schema to YAML one

[Marek Vasut]

Convert the m41t80 text schema to YAML schema.

Add "#clock-cells" requirement, which is required by clock-output-names.

Signed-off-by: Marek Vasut <marex@denx.de>
---
Cc: Alessandro Zummo <a.zummo@towertech.it>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Cc: linux-rtc@vger.kernel.org
To: devicetree@vger.kernel.org
---
V2: - Add maxItems:1 to clock-output-names
    - Skip wakeup-source property, comes from rtc.yaml
    - Mention the new clock-cells requirement coming from
      clock-output-names property.
    - Rename rtc-m41t80.txt to st,m41t80.yaml
---
 .../devicetree/bindings/rtc/rtc-m41t80.txt    | 39 ----------
 .../devicetree/bindings/rtc/st,m41t80.yaml    | 73 +++++++++++++++++++
 2 files changed, 73 insertions(+), 39 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
 create mode 100644 Documentation/devicetree/bindings/rtc/st,m41t80.yaml

diff --git a/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt b/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
deleted file mode 100644
index cdd196b1e9bdb..0000000000000
--- a/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-ST M41T80 family of RTC and compatible
-
-Required properties:
-- compatible: should be one of:
-	"st,m41t62",
-	"st,m41t65",
-	"st,m41t80",
-	"st,m41t81",
-	"st,m41t81s",
-	"st,m41t82",
-	"st,m41t83",
-	"st,m41t84",
-	"st,m41t85",
-	"st,m41t87",
-	"microcrystal,rv4162",
-- reg: I2C bus address of the device
-
-Optional properties:
-- interrupts: rtc alarm interrupt.
-- clock-output-names: From common clock binding to override the default output
-                      clock name
-- wakeup-source: Enables wake up of host system on alarm
-
-Optional child node:
-- clock: Provide this if the square wave pin is used as boot-enabled fixed clock.
-
-Example:
-	rtc@68 {
-		compatible = "st,m41t80";
-		reg = <0x68>;
-		interrupt-parent = <&UIC0>;
-		interrupts = <0x9 0x8>;
-
-		clock {
-			compatible = "fixed-clock";
-			#clock-cells = <0>;
-			clock-frequency = <32768>;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/rtc/st,m41t80.yaml b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
new file mode 100644
index 0000000000000..9977c8954307e
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/st,m41t80.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ST M41T80 family of RTC and compatible
+
+maintainers:
+  - Alexandre Belloni <alexandre.belloni@bootlin.com>
+
+properties:
+  compatible:
+    enum:
+      - st,m41t62
+      - st,m41t65
+      - st,m41t80
+      - st,m41t81
+      - st,m41t81s
+      - st,m41t82
+      - st,m41t83
+      - st,m41t84
+      - st,m41t85
+      - st,m41t87
+      - microcrystal,rv4162
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  "#clock-cells":
+    const: 1
+
+  clock-output-names:
+    maxItems: 1
+    description: From common clock binding to override the default output clock name.
+
+  clock:
+    type: object
+    $ref: /schemas/clock/fixed-clock.yaml#
+    properties:
+      clock-frequency:
+        const: 32768
+
+allOf:
+  - $ref: rtc.yaml
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      rtc@68 {
+        compatible = "st,m41t80";
+        reg = <0x68>;
+        interrupt-parent = <&UIC0>;
+        interrupts = <0x9 0x8>;
+
+        clock {
+          compatible = "fixed-clock";
+          #clock-cells = <0>;
+          clock-frequency = <32768>;
+        };
+      };
+    };
-- 
2.35.1

[PATCH v2 2/2] dt-bindings: rtc: m41t80: Mark the clock: subnode as deprecated

[Marek Vasut]

The clock {} subnode seems like it is describing an always-on clock
generated by the PMIC. This should rather be modeled by consumer of
the clock taking phandle to the RTC node itself, since it already
does have clock-cells and all. Since there are no users of the clock
subnode in tree anyway, mark it as deprecated to avoid proliferation
of this approach.

Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Marek Vasut <marex@denx.de>
---
Cc: Alessandro Zummo <a.zummo@towertech.it>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Cc: linux-rtc@vger.kernel.org
To: devicetree@vger.kernel.org
---
V2: - Add AB from Krzysztof
---
 Documentation/devicetree/bindings/rtc/st,m41t80.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/devicetree/bindings/rtc/st,m41t80.yaml b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
index 9977c8954307e..98a6da4083897 100644
--- a/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
+++ b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
@@ -40,6 +40,7 @@ properties:
   clock:
     type: object
     $ref: /schemas/clock/fixed-clock.yaml#
+    deprecated: true
     properties:
       clock-frequency:
         const: 32768
-- 
2.35.1

Re: [PATCH v2 1/2] dt-bindings: rtc: m41t80: Convert text schema to YAML one

[Krzysztof Kozlowski]

On 11/12/2022 04:00, Marek Vasut wrote:
> Convert the m41t80 text schema to YAML schema.
> 
> Add "#clock-cells" requirement, which is required by clock-output-names.
> 
> Signed-off-by: Marek Vasut <marex@denx.de>
> ---
> Cc: Alessandro Zummo <a.zummo@towertech.it>
> Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
> Cc: linux-rtc@vger.kernel.org
> To: devicetree@vger.kernel.org
> ---
> V2: - Add maxItems:1 to clock-output-names
>     - Skip wakeup-source property, comes from rtc.yaml
>     - Mention the new clock-cells requirement coming from
>       clock-output-names property.
>     - Rename rtc-m41t80.txt to st,m41t80.yaml
> ---
>  .../devicetree/bindings/rtc/rtc-m41t80.txt    | 39 ----------
>  .../devicetree/bindings/rtc/st,m41t80.yaml    | 73 +++++++++++++++++++
>  2 files changed, 73 insertions(+), 39 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
>  create mode 100644 Documentation/devicetree/bindings/rtc/st,m41t80.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt b/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
> deleted file mode 100644
> index cdd196b1e9bdb..0000000000000
> --- a/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
> +++ /dev/null
> @@ -1,39 +0,0 @@
> -ST M41T80 family of RTC and compatible
> -
> -Required properties:
> -- compatible: should be one of:
> -	"st,m41t62",
> -	"st,m41t65",
> -	"st,m41t80",
> -	"st,m41t81",
> -	"st,m41t81s",
> -	"st,m41t82",
> -	"st,m41t83",
> -	"st,m41t84",
> -	"st,m41t85",
> -	"st,m41t87",
> -	"microcrystal,rv4162",
> -- reg: I2C bus address of the device
> -
> -Optional properties:
> -- interrupts: rtc alarm interrupt.
> -- clock-output-names: From common clock binding to override the default output
> -                      clock name
> -- wakeup-source: Enables wake up of host system on alarm
> -
> -Optional child node:
> -- clock: Provide this if the square wave pin is used as boot-enabled fixed clock.
> -
> -Example:
> -	rtc@68 {
> -		compatible = "st,m41t80";
> -		reg = <0x68>;
> -		interrupt-parent = <&UIC0>;
> -		interrupts = <0x9 0x8>;
> -
> -		clock {
> -			compatible = "fixed-clock";
> -			#clock-cells = <0>;
> -			clock-frequency = <32768>;
> -		};
> -	};
> diff --git a/Documentation/devicetree/bindings/rtc/st,m41t80.yaml b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
> new file mode 100644
> index 0000000000000..9977c8954307e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
> @@ -0,0 +1,73 @@
> +# SPDX-License-Identifier: GPL-2.0

I missed that one during previous review - why not dual license? I do
not see here any text (hardware description) being copied. Is it because
of DTS example?

Best regards,
Krzysztof

Re: [PATCH v2 1/2] dt-bindings: rtc: m41t80: Convert text schema to YAML one

[Marek Vasut]

On 12/11/22 21:21, Krzysztof Kozlowski wrote:
> On 11/12/2022 04:00, Marek Vasut wrote:
>> Convert the m41t80 text schema to YAML schema.
>>
>> Add "#clock-cells" requirement, which is required by clock-output-names.
>>
>> Signed-off-by: Marek Vasut <marex@denx.de>
>> ---
>> Cc: Alessandro Zummo <a.zummo@towertech.it>
>> Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
>> Cc: Rob Herring <robh+dt@kernel.org>
>> Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
>> Cc: linux-rtc@vger.kernel.org
>> To: devicetree@vger.kernel.org
>> ---
>> V2: - Add maxItems:1 to clock-output-names
>>      - Skip wakeup-source property, comes from rtc.yaml
>>      - Mention the new clock-cells requirement coming from
>>        clock-output-names property.
>>      - Rename rtc-m41t80.txt to st,m41t80.yaml
>> ---
>>   .../devicetree/bindings/rtc/rtc-m41t80.txt    | 39 ----------
>>   .../devicetree/bindings/rtc/st,m41t80.yaml    | 73 +++++++++++++++++++
>>   2 files changed, 73 insertions(+), 39 deletions(-)
>>   delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
>>   create mode 100644 Documentation/devicetree/bindings/rtc/st,m41t80.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt b/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
>> deleted file mode 100644
>> index cdd196b1e9bdb..0000000000000
>> --- a/Documentation/devicetree/bindings/rtc/rtc-m41t80.txt
>> +++ /dev/null
>> @@ -1,39 +0,0 @@
>> -ST M41T80 family of RTC and compatible
>> -
>> -Required properties:
>> -- compatible: should be one of:
>> -	"st,m41t62",
>> -	"st,m41t65",
>> -	"st,m41t80",
>> -	"st,m41t81",
>> -	"st,m41t81s",
>> -	"st,m41t82",
>> -	"st,m41t83",
>> -	"st,m41t84",
>> -	"st,m41t85",
>> -	"st,m41t87",
>> -	"microcrystal,rv4162",
>> -- reg: I2C bus address of the device
>> -
>> -Optional properties:
>> -- interrupts: rtc alarm interrupt.
>> -- clock-output-names: From common clock binding to override the default output
>> -                      clock name
>> -- wakeup-source: Enables wake up of host system on alarm
>> -
>> -Optional child node:
>> -- clock: Provide this if the square wave pin is used as boot-enabled fixed clock.
>> -
>> -Example:
>> -	rtc@68 {
>> -		compatible = "st,m41t80";
>> -		reg = <0x68>;
>> -		interrupt-parent = <&UIC0>;
>> -		interrupts = <0x9 0x8>;
>> -
>> -		clock {
>> -			compatible = "fixed-clock";
>> -			#clock-cells = <0>;
>> -			clock-frequency = <32768>;
>> -		};
>> -	};
>> diff --git a/Documentation/devicetree/bindings/rtc/st,m41t80.yaml b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
>> new file mode 100644
>> index 0000000000000..9977c8954307e
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
>> @@ -0,0 +1,73 @@
>> +# SPDX-License-Identifier: GPL-2.0
> 
> I missed that one during previous review - why not dual license? I do
> not see here any text (hardware description) being copied. Is it because
> of DTS example?

Copy paste from -- likely --
Documentation/devicetree/bindings/rtc/rtc-ds1307.yaml:# 
SPDX-License-Identifier: GPL-2.0

Would you prefer

(GPL-2.0-only OR BSD-2-Clause)

?

Re: [PATCH v2 1/2] dt-bindings: rtc: m41t80: Convert text schema to YAML one

[Krzysztof Kozlowski]

On 11/12/2022 21:26, Marek Vasut wrote:
>>> diff --git a/Documentation/devicetree/bindings/rtc/st,m41t80.yaml b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
>>> new file mode 100644
>>> index 0000000000000..9977c8954307e
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/rtc/st,m41t80.yaml
>>> @@ -0,0 +1,73 @@
>>> +# SPDX-License-Identifier: GPL-2.0
>>
>> I missed that one during previous review - why not dual license? I do
>> not see here any text (hardware description) being copied. Is it because
>> of DTS example?
> 
> Copy paste from -- likely --
> Documentation/devicetree/bindings/rtc/rtc-ds1307.yaml:# 
> SPDX-License-Identifier: GPL-2.0
> 
> Would you prefer
> 
> (GPL-2.0-only OR BSD-2-Clause)
> 
> ?


Yes, please.

Best regards,
Krzysztof