[PATCH v2 0/2] dt-bindings: Remove alt_ref for versal

[PATCH v2 0/2] dt-bindings: Remove alt_ref for versal

[Shubhrajyoti Datta]

alt_ref is there only for Versal Net. Remove the alt_ref
for versal.


Changes in v2:
- Have specific constraints for versal and versal net.

Shubhrajyoti Datta (2):
  dt-bindings: clock: versal: Make alt_ref optional
  dt-bindings: firmware: Remove alt_ref from versal example

 .../bindings/clock/xlnx,versal-clk.yaml       | 31 +++++++++++++++----
 .../firmware/xilinx/xlnx,zynqmp-firmware.yaml |  4 +--
 2 files changed, 27 insertions(+), 8 deletions(-)

-- 
2.17.1

[PATCH v2 1/2] dt-bindings: clock: versal: Make alt_ref optional

[Shubhrajyoti Datta]

The alt_ref is present only in Versal-net devices.
Other versal devices do not have it. Update the binding
accordingly.

Fixes: 352546805a44 ("dt-bindings: clock: Add bindings for versal clock driver")
Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>

---

Changes in v2:
- Have specific constraints for versal and versal net.

 .../bindings/clock/xlnx,versal-clk.yaml       | 31 +++++++++++++++----
 1 file changed, 25 insertions(+), 6 deletions(-)

diff --git a/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml b/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml
index 1ba687d433b1..bef109d163a8 100644
--- a/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml
+++ b/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml
@@ -31,11 +31,11 @@ properties:
   clocks:
     description: List of clock specifiers which are external input
       clocks to the given clock controller.
-    minItems: 3
+    minItems: 2
     maxItems: 8
 
   clock-names:
-    minItems: 3
+    minItems: 2
     maxItems: 8
 
 required:
@@ -59,15 +59,34 @@ allOf:
         clocks:
           items:
             - description: reference clock
-            - description: alternate reference clock
             - description: alternate reference clock for programmable logic
 
         clock-names:
           items:
             - const: ref
-            - const: alt_ref
             - const: pl_alt_ref
 
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - xlnx,versal-net-clk
+
+    then:
+      properties:
+        clocks:
+          items:
+            - description: reference clock
+            - description: alternate reference clock for programmable logic
+            - description: alternate reference clock
+
+        clock-names:
+          items:
+            - const: ref
+            - const: pl_alt_ref
+            - const: alt_ref
+
   - if:
       properties:
         compatible:
@@ -110,8 +129,8 @@ examples:
         versal_clk: clock-controller {
           #clock-cells = <1>;
           compatible = "xlnx,versal-clk";
-          clocks = <&ref>, <&alt_ref>, <&pl_alt_ref>;
-          clock-names = "ref", "alt_ref", "pl_alt_ref";
+          clocks = <&ref>,  <&pl_alt_ref>;
+          clock-names = "ref", "pl_alt_ref";
         };
       };
     };
-- 
2.17.1

[PATCH v2 2/2] dt-bindings: firmware: Remove alt_ref from versal example

[Shubhrajyoti Datta]

In the previous commit (dt-bindings: clock: versal: Make alt_ref
optional) the alt_ref is removed from the veral-clk. Update the example
accordingly.

Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
---

Changes in v2:
new patch addition

 .../bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml        | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
index 822864488dcb..8e584857ddd4 100644
--- a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
+++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
@@ -95,8 +95,8 @@ examples:
       versal_clk: clock-controller {
         #clock-cells = <1>;
         compatible = "xlnx,versal-clk";
-        clocks = <&ref>, <&alt_ref>, <&pl_alt_ref>;
-        clock-names = "ref", "alt_ref", "pl_alt_ref";
+        clocks = <&ref>, <&pl_alt_ref>;
+        clock-names = "ref", "pl_alt_ref";
       };
     };
 
-- 
2.17.1

Re: [PATCH v2 2/2] dt-bindings: firmware: Remove alt_ref from versal example

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 1395 bytes --]

On Mon, Nov 27, 2023 at 12:52:04PM +0530, Shubhrajyoti Datta wrote:
> In the previous commit (dt-bindings: clock: versal: Make alt_ref
> optional) the alt_ref is removed from the veral-clk. Update the example
> accordingly.
> 
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>

TBH, I'd rather you squashed this into patch one than introduced a
warning in one patch, only to remove it in another.

> ---
> 
> Changes in v2:
> new patch addition
> 
>  .../bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml        | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
> index 822864488dcb..8e584857ddd4 100644
> --- a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
> +++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
> @@ -95,8 +95,8 @@ examples:
>        versal_clk: clock-controller {
>          #clock-cells = <1>;
>          compatible = "xlnx,versal-clk";
> -        clocks = <&ref>, <&alt_ref>, <&pl_alt_ref>;
> -        clock-names = "ref", "alt_ref", "pl_alt_ref";
> +        clocks = <&ref>, <&pl_alt_ref>;
> +        clock-names = "ref", "pl_alt_ref";
>        };
>      };
>  
> -- 
> 2.17.1
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2 1/2] dt-bindings: clock: versal: Make alt_ref optional

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 2849 bytes --]

On Mon, Nov 27, 2023 at 12:52:03PM +0530, Shubhrajyoti Datta wrote:
> The alt_ref is present only in Versal-net devices.
> Other versal devices do not have it. Update the binding
> accordingly.

$subject is not accurate btw, "alt_ref" is not an option, its not
present on !versal-net devices. Could you rephrase that please?

Thanks,
Conor.

> 
> Fixes: 352546805a44 ("dt-bindings: clock: Add bindings for versal clock driver")
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
> 
> ---
> 
> Changes in v2:
> - Have specific constraints for versal and versal net.
> 
>  .../bindings/clock/xlnx,versal-clk.yaml       | 31 +++++++++++++++----
>  1 file changed, 25 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml b/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml
> index 1ba687d433b1..bef109d163a8 100644
> --- a/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml
> +++ b/Documentation/devicetree/bindings/clock/xlnx,versal-clk.yaml
> @@ -31,11 +31,11 @@ properties:
>    clocks:
>      description: List of clock specifiers which are external input
>        clocks to the given clock controller.
> -    minItems: 3
> +    minItems: 2
>      maxItems: 8
>  
>    clock-names:
> -    minItems: 3
> +    minItems: 2
>      maxItems: 8
>  
>  required:
> @@ -59,15 +59,34 @@ allOf:
>          clocks:
>            items:
>              - description: reference clock
> -            - description: alternate reference clock
>              - description: alternate reference clock for programmable logic
>  
>          clock-names:
>            items:
>              - const: ref
> -            - const: alt_ref
>              - const: pl_alt_ref
>  
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - xlnx,versal-net-clk
> +
> +    then:
> +      properties:
> +        clocks:
> +          items:
> +            - description: reference clock
> +            - description: alternate reference clock for programmable logic
> +            - description: alternate reference clock
> +
> +        clock-names:
> +          items:
> +            - const: ref
> +            - const: pl_alt_ref
> +            - const: alt_ref
> +
>    - if:
>        properties:
>          compatible:
> @@ -110,8 +129,8 @@ examples:
>          versal_clk: clock-controller {
>            #clock-cells = <1>;
>            compatible = "xlnx,versal-clk";
> -          clocks = <&ref>, <&alt_ref>, <&pl_alt_ref>;
> -          clock-names = "ref", "alt_ref", "pl_alt_ref";
> +          clocks = <&ref>,  <&pl_alt_ref>;
> +          clock-names = "ref", "pl_alt_ref";
>          };
>        };
>      };
> -- 
> 2.17.1
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2 1/2] dt-bindings: clock: versal: Make alt_ref optional

[Rob Herring]

On Mon, 27 Nov 2023 12:52:03 +0530, Shubhrajyoti Datta wrote:
> The alt_ref is present only in Versal-net devices.
> Other versal devices do not have it. Update the binding
> accordingly.
> 
> Fixes: 352546805a44 ("dt-bindings: clock: Add bindings for versal clock driver")
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
> 
> ---
> 
> Changes in v2:
> - Have specific constraints for versal and versal net.
> 
>  .../bindings/clock/xlnx,versal-clk.yaml       | 31 +++++++++++++++----
>  1 file changed, 25 insertions(+), 6 deletions(-)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: versal-firmware: clock-controller:clocks: [[4294967295], [4294967295], [4294967295]] is too long
	from schema $id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: versal-firmware: clock-controller:clock-names:1: 'pl_alt_ref' was expected
	from schema $id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: versal-firmware: clock-controller:clock-names: ['ref', 'alt_ref', 'pl_alt_ref'] is too long
	from schema $id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: clock-controller: clocks: [[4294967295], [4294967295], [4294967295]] is too long
	from schema $id: http://devicetree.org/schemas/clock/xlnx,versal-clk.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: clock-controller: clock-names:1: 'pl_alt_ref' was expected
	from schema $id: http://devicetree.org/schemas/clock/xlnx,versal-clk.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: clock-controller: clock-names: ['ref', 'alt_ref', 'pl_alt_ref'] is too long
	from schema $id: http://devicetree.org/schemas/clock/xlnx,versal-clk.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231127072204.25879-2-shubhrajyoti.datta@amd.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.