[PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml

[PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml

[niravkumar.l.rabara]

From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>

Convert socfpga-system.txt to altr,sys-mgr.yaml.

Signed-off-by: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
---
 .../bindings/arm/altera/altr,sys-mgr.yaml     | 50 +++++++++++++++++++
 .../bindings/arm/altera/socfpga-system.txt    | 25 ----------
 2 files changed, 50 insertions(+), 25 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
 delete mode 100644 Documentation/devicetree/bindings/arm/altera/socfpga-system.txt

diff --git a/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml b/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
new file mode 100644
index 000000000000..8deb70aef664
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
@@ -0,0 +1,50 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/arm/altera/altr,sys-mgr.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Altera SOCFPGA System Manager
+
+maintainers:
+  - Dinh Nguyen <dinguyen@kernel.org>
+
+properties:
+  compatible:
+    oneOf:
+      - description: Cyclone5/Arria5/Arria10
+        const: altr,sys-mgr
+      - description: Stratix10 SoC
+        items:
+          - const: altr,sys-mgr-s10
+          - const: altr,sys-mgr
+
+  reg:
+    maxItems: 1
+
+  cpu1-start-addr:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: CPU1 start address in hex
+
+required:
+  - compatible
+  - reg
+
+if:
+  properties:
+    compatible:
+      contains:
+        const: altr,sys-mgr-s10
+then:
+  properties:
+    cpu1-start-addr: false
+
+additionalProperties: false
+
+examples:
+  - |
+    sysmgr@ffd08000 {
+      compatible = "altr,sys-mgr";
+      reg = <0xffd08000 0x1000>;
+      cpu1-start-addr = <0xffd080c4>;
+    };
diff --git a/Documentation/devicetree/bindings/arm/altera/socfpga-system.txt b/Documentation/devicetree/bindings/arm/altera/socfpga-system.txt
deleted file mode 100644
index 82edbaaa3f85..000000000000
--- a/Documentation/devicetree/bindings/arm/altera/socfpga-system.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-Altera SOCFPGA System Manager
-
-Required properties:
-- compatible : "altr,sys-mgr"
-- reg : Should contain 1 register ranges(address and length)
-- cpu1-start-addr : CPU1 start address in hex.
-
-Example:
-	 sysmgr@ffd08000 {
-		compatible = "altr,sys-mgr";
-		reg = <0xffd08000 0x1000>;
-		cpu1-start-addr = <0xffd080c4>;
-	};
-
-ARM64 - Stratix10
-Required properties:
-- compatible : "altr,sys-mgr-s10"
-- reg : Should contain 1 register range(address and length)
-        for system manager register.
-
-Example:
-	 sysmgr@ffd12000 {
-		compatible = "altr,sys-mgr-s10";
-		reg = <0xffd12000 0x228>;
-	};
-- 
2.25.1

Re: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml

[Krzysztof Kozlowski]

On 04/10/2023 05:07, niravkumar.l.rabara@intel.com wrote:
> From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
> 
> Convert socfpga-system.txt to altr,sys-mgr.yaml.
> 
> Signed-off-by: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
> ---
>  .../bindings/arm/altera/altr,sys-mgr.yaml     | 50 +++++++++++++++++++
>  .../bindings/arm/altera/socfpga-system.txt    | 25 ----------
>  2 files changed, 50 insertions(+), 25 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml

arm is only for top-level. What is this this device about? FPGA? SoC?


>  delete mode 100644 Documentation/devicetree/bindings/arm/altera/socfpga-system.txt
> 
> diff --git a/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml b/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> new file mode 100644
> index 000000000000..8deb70aef664
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/arm/altera/altr,sys-mgr.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Altera SOCFPGA System Manager
> +
> +maintainers:
> +  - Dinh Nguyen <dinguyen@kernel.org>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - description: Cyclone5/Arria5/Arria10
> +        const: altr,sys-mgr
> +      - description: Stratix10 SoC
> +        items:
> +          - const: altr,sys-mgr-s10
> +          - const: altr,sys-mgr

That's not what old binding was saying. Please describe in the commit
msg differences from pure conversion.

> +
> +  reg:
> +    maxItems: 1
> +
> +  cpu1-start-addr:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: CPU1 start address in hex
> +
> +required:
> +  - compatible
> +  - reg
> +
> +if:

Please keep it here under "allOf:". Will save you one re-indentation on
any new variant.

> +  properties:
> +    compatible:
> +      contains:
> +        const: altr,sys-mgr-s10
> +then:
> +  properties:
> +    cpu1-start-addr: false
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    sysmgr@ffd08000 {
> +      compatible = "altr,sys-mgr";
> +      reg = <0xffd08000 0x1000>;
> +      cpu1-start-addr = <0xffd080c4>;
> +    };
Best regards,
Krzysztof

RE: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml

[Rabara, Niravkumar L]

> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Wednesday, October 4, 2023 2:46 PM
> To: Rabara, Niravkumar L <niravkumar.l.rabara@intel.com>; Rob Herring
> <robh+dt@kernel.org>; Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>;
> Conor Dooley <conor+dt@kernel.org>; Dinh Nguyen <dinguyen@kernel.org>
> Cc: devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml
> 
> On 04/10/2023 05:07, niravkumar.l.rabara@intel.com wrote:
> > From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
> >
> > Convert socfpga-system.txt to altr,sys-mgr.yaml.
> >
> > Signed-off-by: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
> > ---
> >  .../bindings/arm/altera/altr,sys-mgr.yaml     | 50 +++++++++++++++++++
> >  .../bindings/arm/altera/socfpga-system.txt    | 25 ----------
> >  2 files changed, 50 insertions(+), 25 deletions(-)  create mode
> > 100644 Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> 
> arm is only for top-level. What is this this device about? FPGA? SoC?

This is for Altera SoCFPGA System Manager registers, common binding file
for ARM and ARM64 platforms. 
Should I use  "altr,socfpga-sys-mgr.yaml" as per the naming conventions? 

Do you also suggest to move this yaml to different folder instead of 
" Documentation/devicetree/bindings/arm/altera arm/altera/" ?

> 
> 
> >  delete mode 100644
> > Documentation/devicetree/bindings/arm/altera/socfpga-system.txt
> >
> > diff --git
> > a/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> > b/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> > new file mode 100644
> > index 000000000000..8deb70aef664
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> > @@ -0,0 +1,50 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/arm/altera/altr,sys-mgr.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Altera SOCFPGA System Manager
> > +
> > +maintainers:
> > +  - Dinh Nguyen <dinguyen@kernel.org>
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - description: Cyclone5/Arria5/Arria10
> > +        const: altr,sys-mgr
> > +      - description: Stratix10 SoC
> > +        items:
> > +          - const: altr,sys-mgr-s10
> > +          - const: altr,sys-mgr
> 
> That's not what old binding was saying. Please describe in the commit msg
> differences from pure conversion.
> 

Noted. Will update the commit message with below information.

Add platform names in description for clarity. ARM(32-bit) platforms Cyclone5,
Arria5 and Arria10 is using "altr,sys-mgr" compatible, while ARM64 is using
"altr,sys-mgr-s10" compatible.  

Removed "cpu1-start-addr" for ARM64 as it is not required.

> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  cpu1-start-addr:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: CPU1 start address in hex
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +if:
> 
> Please keep it here under "allOf:". Will save you one re-indentation on any new
> variant.

Sure I will update in v2 patch. 

> 
> > +  properties:
> > +    compatible:
> > +      contains:
> > +        const: altr,sys-mgr-s10
> > +then:
> > +  properties:
> > +    cpu1-start-addr: false
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    sysmgr@ffd08000 {
> > +      compatible = "altr,sys-mgr";
> > +      reg = <0xffd08000 0x1000>;
> > +      cpu1-start-addr = <0xffd080c4>;
> > +    };
> Best regards,
> Krzysztof

Thanks,
Nirav

Re: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml

[Krzysztof Kozlowski]

On 04/10/2023 12:32, Rabara, Niravkumar L wrote:
> 
> 
>> -----Original Message-----
>> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> Sent: Wednesday, October 4, 2023 2:46 PM
>> To: Rabara, Niravkumar L <niravkumar.l.rabara@intel.com>; Rob Herring
>> <robh+dt@kernel.org>; Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>;
>> Conor Dooley <conor+dt@kernel.org>; Dinh Nguyen <dinguyen@kernel.org>
>> Cc: devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
>> Subject: Re: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml
>>
>> On 04/10/2023 05:07, niravkumar.l.rabara@intel.com wrote:
>>> From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
>>>
>>> Convert socfpga-system.txt to altr,sys-mgr.yaml.
>>>
>>> Signed-off-by: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
>>> ---
>>>  .../bindings/arm/altera/altr,sys-mgr.yaml     | 50 +++++++++++++++++++
>>>  .../bindings/arm/altera/socfpga-system.txt    | 25 ----------
>>>  2 files changed, 50 insertions(+), 25 deletions(-)  create mode
>>> 100644 Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
>>
>> arm is only for top-level. What is this this device about? FPGA? SoC?
> 
> This is for Altera SoCFPGA System Manager registers, common binding file
> for ARM and ARM64 platforms. 

So SoC part?

> Should I use  "altr,socfpga-sys-mgr.yaml" as per the naming conventions? 
> 
> Do you also suggest to move this yaml to different folder instead of 
> " Documentation/devicetree/bindings/arm/altera arm/altera/" ?

I am suggesting to move it to soc.


Best regards,
Krzysztof

RE: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to yaml

[Rabara, Niravkumar L]

> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Wednesday, October 4, 2023 11:43 PM
> To: Rabara, Niravkumar L <niravkumar.l.rabara@intel.com>; Rob Herring
> <robh+dt@kernel.org>; Krzysztof Kozlowski
> <krzysztof.kozlowski+dt@linaro.org>; Conor Dooley <conor+dt@kernel.org>;
> Dinh Nguyen <dinguyen@kernel.org>
> Cc: devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH] dt-bindings: arm: altera: convert socfpga-system.txt to
> yaml
> 
> On 04/10/2023 12:32, Rabara, Niravkumar L wrote:
> >
> >
> >> -----Original Message-----
> >> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> >> Sent: Wednesday, October 4, 2023 2:46 PM
> >> To: Rabara, Niravkumar L <niravkumar.l.rabara@intel.com>; Rob Herring
> >> <robh+dt@kernel.org>; Krzysztof Kozlowski
> >> <krzysztof.kozlowski+dt@linaro.org>;
> >> Conor Dooley <conor+dt@kernel.org>; Dinh Nguyen
> <dinguyen@kernel.org>
> >> Cc: devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
> >> Subject: Re: [PATCH] dt-bindings: arm: altera: convert
> >> socfpga-system.txt to yaml
> >>
> >> On 04/10/2023 05:07, niravkumar.l.rabara@intel.com wrote:
> >>> From: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
> >>>
> >>> Convert socfpga-system.txt to altr,sys-mgr.yaml.
> >>>
> >>> Signed-off-by: Niravkumar L Rabara <niravkumar.l.rabara@intel.com>
> >>> ---
> >>>  .../bindings/arm/altera/altr,sys-mgr.yaml     | 50 +++++++++++++++++++
> >>>  .../bindings/arm/altera/socfpga-system.txt    | 25 ----------
> >>>  2 files changed, 50 insertions(+), 25 deletions(-)  create mode
> >>> 100644
> >>> Documentation/devicetree/bindings/arm/altera/altr,sys-mgr.yaml
> >>
> >> arm is only for top-level. What is this this device about? FPGA? SoC?
> >
> > This is for Altera SoCFPGA System Manager registers, common binding
> > file for ARM and ARM64 platforms.
> 
> So SoC part?

Yes

> 
> > Should I use  "altr,socfpga-sys-mgr.yaml" as per the naming conventions?
> >
> > Do you also suggest to move this yaml to different folder instead of "
> > Documentation/devicetree/bindings/arm/altera arm/altera/" ?
> 
> I am suggesting to move it to soc.

Alright, I will create a folder "altera" in soc directory and move it there in V2. 
Documentation/devicetree/bindings/soc/altera/altr,socfpga-sys-mgr.yaml

> 
> 
> Best regards,
> Krzysztof

Thanks,
Nirav