[PATCH v2] dt-bindings: rtc: pcf8523: Convert to YAML

[PATCH v2] dt-bindings: rtc: pcf8523: Convert to YAML

[Fabio Estevam]

From: Fabio Estevam <festevam@denx.de>

Convert the PCF8523 bindings from text format to YAML.

The YAML format is preferred as it allows validation.

Signed-off-by: Fabio Estevam <festevam@denx.de>
---
Changes since v1:
- Add the default value for quartz-load-femtofarads. (Krzysztof)
- Pass unevaluatedProperties: false. (Krzysztof)
- Fixed a typo on Sam's email address.

 .../devicetree/bindings/rtc/nxp,pcf8523.txt   | 18 --------
 .../devicetree/bindings/rtc/nxp,pcf8523.yaml  | 45 +++++++++++++++++++
 2 files changed, 45 insertions(+), 18 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt
 create mode 100644 Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml

diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt b/Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt
deleted file mode 100644
index 0b1080c60f63..000000000000
--- a/Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-* NXP PCF8523 Real Time Clock
-
-Required properties:
-- compatible: Should contain "nxp,pcf8523".
-- reg: I2C address for chip.
-
-Optional property:
-- quartz-load-femtofarads: The capacitive load of the quartz(x-tal),
-  expressed in femto Farad (fF). Valid values are 7000 and 12500.
-  Default value (if no value is specified) is 12500fF.
-
-Example:
-
-pcf8523: rtc@68 {
-	compatible = "nxp,pcf8523";
-	reg = <0x68>;
-	quartz-load-femtofarads = <7000>;
-};
diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml b/Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml
new file mode 100644
index 000000000000..8d17b89fef5e
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml
@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/nxp,pcf8523.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP PCF8523 Real Time Clock
+
+maintainers:
+  - Sam Ravnborg <sam@ravnborg.org>
+
+allOf:
+  - $ref: rtc.yaml#
+
+properties:
+  compatible:
+    const: nxp,pcf8523
+
+  reg:
+    maxItems: 1
+
+  quartz-load-femtofarads:
+    description:
+      The capacitive load of the crystal, expressed in femto Farad (fF).
+    enum: [ 7000, 12500 ]
+    default: 7000
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        rtc@68 {
+            compatible = "nxp,pcf8523";
+            reg = <0x68>;
+            quartz-load-femtofarads = <7000>;
+        };
+    };
-- 
2.34.1

Re: [PATCH v2] dt-bindings: rtc: pcf8523: Convert to YAML

[Javier Carrasco]

Hi Fabio,

On 05.09.23 22:28, Fabio Estevam wrote:
> From: Fabio Estevam <festevam@denx.de>
> 
> Convert the PCF8523 bindings from text format to YAML.
> 
> The YAML format is preferred as it allows validation.
> 
> Signed-off-by: Fabio Estevam <festevam@denx.de>
> ---
> Changes since v1:
> - Add the default value for quartz-load-femtofarads. (Krzysztof)
> - Pass unevaluatedProperties: false. (Krzysztof)
> - Fixed a typo on Sam's email address.
> 
>  .../devicetree/bindings/rtc/nxp,pcf8523.txt   | 18 --------
>  .../devicetree/bindings/rtc/nxp,pcf8523.yaml  | 45 +++++++++++++++++++
>  2 files changed, 45 insertions(+), 18 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt
>  create mode 100644 Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt b/Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt
> deleted file mode 100644
> index 0b1080c60f63..000000000000
> --- a/Documentation/devicetree/bindings/rtc/nxp,pcf8523.txt
> +++ /dev/null
> @@ -1,18 +0,0 @@
> -* NXP PCF8523 Real Time Clock
> -
> -Required properties:
> -- compatible: Should contain "nxp,pcf8523".
> -- reg: I2C address for chip.
> -
> -Optional property:
> -- quartz-load-femtofarads: The capacitive load of the quartz(x-tal),
> -  expressed in femto Farad (fF). Valid values are 7000 and 12500.
> -  Default value (if no value is specified) is 12500fF.
> -
> -Example:
> -
> -pcf8523: rtc@68 {
> -	compatible = "nxp,pcf8523";
> -	reg = <0x68>;
> -	quartz-load-femtofarads = <7000>;
> -};
> diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml b/Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml
> new file mode 100644
> index 000000000000..8d17b89fef5e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/nxp,pcf8523.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/nxp,pcf8523.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP PCF8523 Real Time Clock
> +
> +maintainers:
> +  - Sam Ravnborg <sam@ravnborg.org>
> +
> +allOf:
> +  - $ref: rtc.yaml#
> +
> +properties:
> +  compatible:
> +    const: nxp,pcf8523
> +
> +  reg:
> +    maxItems: 1
> +
> +  quartz-load-femtofarads:
> +    description:
> +      The capacitive load of the crystal, expressed in femto Farad (fF).
> +    enum: [ 7000, 12500 ]
> +    default: 7000
isn't the default value 12500 anymore? it used to be and the driver
still uses 12500fF as the default value.
> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        rtc@68 {
> +            compatible = "nxp,pcf8523";
> +            reg = <0x68>;
> +            quartz-load-femtofarads = <7000>;
> +        };
> +    };
Best regards,
Javier Carrasco

Re: [PATCH v2] dt-bindings: rtc: pcf8523: Convert to YAML

[Fabio Estevam]

Hi Javier,

On 05/09/2023 19:03, Javier Carrasco wrote:

> isn't the default value 12500 anymore? it used to be and the driver
> still uses 12500fF as the default value.

You are right.

I will fix it in v3.

Thanks,

Fabio Estevam