[PATCH] dt-bindings: fsl: convert fsl,layerscape-scfg to YAML

[PATCH] dt-bindings: fsl: convert fsl,layerscape-scfg to YAML

[Michael Walle]

Convert the fsl,layerscape-scfg binding to the new YAML format.

Added, compared to the original binding, is the interrupt-controller
subnode as used in arch/arm/boot/dts/ls1021a.dtsi as well as the
litte-endian and big-endian properties.

Signed-off-by: Michael Walle <michael@walle.cc>
---
 .../arm/freescale/fsl,layerscape-scfg.txt     | 19 ------
 .../arm/freescale/fsl,layerscape-scfg.yaml    | 58 +++++++++++++++++++
 2 files changed, 58 insertions(+), 19 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.txt
 create mode 100644 Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.yaml

diff --git a/Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.txt b/Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.txt
deleted file mode 100644
index 0ab67b0b216d..000000000000
--- a/Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-Freescale SCFG
-
-SCFG is the supplemental configuration unit, that provides SoC specific
-configuration and status registers for the chip. Such as getting PEX port
-status.
-
-Required properties:
-  - compatible: Should contain a chip-specific compatible string,
-	Chip-specific strings are of the form "fsl,<chip>-scfg",
-	The following <chip>s are known to be supported:
-	ls1012a, ls1021a, ls1043a, ls1046a, ls2080a.
-
-  - reg: should contain base address and length of SCFG memory-mapped registers
-
-Example:
-	scfg: scfg@1570000 {
-		compatible = "fsl,ls1021a-scfg";
-		reg = <0x0 0x1570000 0x0 0x10000>;
-	};
diff --git a/Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.yaml b/Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.yaml
new file mode 100644
index 000000000000..b68a9bc68860
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.yaml
@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/arm/freescale/fsl,layerscape-scfg.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale Layerscape Supplemental Configuration Unit
+
+maintainers:
+  - Shawn Guo <shawnguo@kernel.org>
+  - Li Yang <leoyang.li@nxp.com>
+
+description: |
+  SCFG is the supplemental configuration unit, that provides SoC specific
+  configuration and status registers for the chip. Such as getting PEX port
+  status.
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - fsl,ls1012a-scfg
+          - fsl,ls1021a-scfg
+          - fsl,ls1028a-scfg
+          - fsl,ls1043a-scfg
+          - fsl,ls1046a-scfg
+      - const: syscon
+
+  reg:
+    maxItems: 1
+
+  little-endian: true
+  big-endian: true
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 1
+
+  ranges: true
+
+patternProperties:
+  "^interrupt-controller@[a-z0-9]+$":
+    $ref: /schemas/interrupt-controller.yaml#
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    scfg@1570000 {
+        compatible = "fsl,ls1021a-scfg", "syscon";
+        reg = <0x1570000 0x10000>;
+    };
-- 
2.30.2

Re: [PATCH] dt-bindings: fsl: convert fsl,layerscape-scfg to YAML

[Krzysztof Kozlowski]

On 21/04/2022 17:31, Michael Walle wrote:
> Convert the fsl,layerscape-scfg binding to the new YAML format.
> 
> Added, compared to the original binding, is the interrupt-controller
> subnode as used in arch/arm/boot/dts/ls1021a.dtsi as well as the
> litte-endian and big-endian properties.
> 
> Signed-off-by: Michael Walle <michael@walle.cc>
> ---
>  .../arm/freescale/fsl,layerscape-scfg.txt     | 19 ------
>  .../arm/freescale/fsl,layerscape-scfg.yaml    | 58 +++++++++++++++++++
>  2 files changed, 58 insertions(+), 19 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.txt
>  create mode 100644 Documentation/devicetree/bindings/arm/freescale/fsl,layerscape-scfg.yaml

This should be moved to bindings/soc/freescale. Arm directory is only
for top-level stuff.

(...)

> +description: |
> +  SCFG is the supplemental configuration unit, that provides SoC specific
> +  configuration and status registers for the chip. Such as getting PEX port
> +  status.
> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - fsl,ls1012a-scfg
> +          - fsl,ls1021a-scfg
> +          - fsl,ls1028a-scfg
> +          - fsl,ls1043a-scfg
> +          - fsl,ls1046a-scfg
> +      - const: syscon

This was not present in old bindings, so please mention it in commit msg.

> +
> +  reg:
> +    maxItems: 1
> +
> +  little-endian: true
> +  big-endian: true
> +
> +  '#address-cells':
> +    const: 1
> +
> +  '#size-cells':
> +    const: 1
> +
> +  ranges: true
> +
> +patternProperties:
> +  "^interrupt-controller@[a-z0-9]+$":
> +    $ref: /schemas/interrupt-controller.yaml#

Do you have a specific FSL schema (bindings) for the child?

> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    scfg@1570000 {

Generic node name, so I guess here it would be a "syscon".

> +        compatible = "fsl,ls1021a-scfg", "syscon";
> +        reg = <0x1570000 0x10000>;
> +    };


Best regards,
Krzysztof

Re: [PATCH] dt-bindings: fsl: convert fsl,layerscape-scfg to YAML

[Michael Walle]

Am 2022-04-23 12:17, schrieb Krzysztof Kozlowski:

>> +patternProperties:
>> +  "^interrupt-controller@[a-z0-9]+$":
>> +    $ref: /schemas/interrupt-controller.yaml#
> 
> Do you have a specific FSL schema (bindings) for the child?

Mh, indeed there is the following binding which I didn't notice
earlier
Documentation/devicetree/bindings/interrupt-controller/fsl,ls-extirq.txt

So I guess it has to be converted before this schema?

-michael

Re: [PATCH] dt-bindings: fsl: convert fsl,layerscape-scfg to YAML

[Krzysztof Kozlowski]

On 23/04/2022 16:05, Michael Walle wrote:
> Am 2022-04-23 12:17, schrieb Krzysztof Kozlowski:
> 
>>> +patternProperties:
>>> +  "^interrupt-controller@[a-z0-9]+$":
>>> +    $ref: /schemas/interrupt-controller.yaml#
>>
>> Do you have a specific FSL schema (bindings) for the child?
> 
> Mh, indeed there is the following binding which I didn't notice
> earlier
> Documentation/devicetree/bindings/interrupt-controller/fsl,ls-extirq.txt
> 
> So I guess it has to be converted before this schema?

That would be awesome! :) Skipping the conversion is not a blocker, but
it is easy later to forget to update the reference.


Best regards,
Krzysztof