[PATCH] dt-bindings: firmware: add reset-controller property

[PATCH] dt-bindings: firmware: add reset-controller property

[Piyush Mehta]

The reset controller is responsible for managing both device-level resets
and individual PMC (Power Management Controller) block resets.

To facilitate this functionality reset-controller property is added to the
firmware device tree binding.

Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
---
 .../firmware/xilinx/xlnx,zynqmp-firmware.yaml         | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
index 910bebe6cfa8..c3a7a5a61d02 100644
--- a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
+++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
@@ -59,6 +59,12 @@ properties:
       controller.
     type: object
 
+  reset-controller:
+    $ref: /schemas/reset/xlnx,zynqmp-reset.yaml#
+    description: The reset-controller has the ability to reset lines connected
+      to different blocks and peripherals in the SoC.
+    type: object
+
 required:
   - compatible
 
@@ -84,6 +90,11 @@ examples:
         clocks = <&ref>, <&alt_ref>, <&pl_alt_ref>;
         clock-names = "ref", "alt_ref", "pl_alt_ref";
       };
+
+      zynqmp_reset: reset-controller {
+        compatible = "xlnx,zynqmp-reset";
+        #reset-cells = <1>;
+      };
     };
 
 ...
-- 
2.25.1

Re: [PATCH] dt-bindings: firmware: add reset-controller property

[Rob Herring]

On Sun, 09 Jul 2023 22:55:42 +0530, Piyush Mehta wrote:
> The reset controller is responsible for managing both device-level resets
> and individual PMC (Power Management Controller) block resets.
> 
> To facilitate this functionality reset-controller property is added to the
> firmware device tree binding.
> 
> Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
> ---
>  .../firmware/xilinx/xlnx,zynqmp-firmware.yaml         | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 

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.yaml:
Error in referenced schema matching $id: http://devicetree.org/schemas/reset/xlnx,zynqmp-reset.yaml
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: versal-firmware: reset-controller: False schema does not allow {'compatible': ['xlnx,zynqmp-reset'], '#reset-cells': [[1]]}
	from schema $id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: /example-0/versal-firmware/reset-controller: failed to match any schema with compatible: ['xlnx,zynqmp-reset']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230709172542.1393828-1-piyush.mehta@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.

Re: [PATCH] dt-bindings: firmware: add reset-controller property

[Conor Dooley]

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

On Sun, Jul 09, 2023 at 12:48:18PM -0600, Rob Herring wrote:
> 
> On Sun, 09 Jul 2023 22:55:42 +0530, Piyush Mehta wrote:
> > The reset controller is responsible for managing both device-level resets
> > and individual PMC (Power Management Controller) block resets.
> > 
> > To facilitate this functionality reset-controller property is added to the
> > firmware device tree binding.
> > 
> > Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
> > ---
> >  .../firmware/xilinx/xlnx,zynqmp-firmware.yaml         | 11 +++++++++++
> >  1 file changed, 11 insertions(+)
> > 
> 
> 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.yaml:
> Error in referenced schema matching $id: http://devicetree.org/schemas/reset/xlnx,zynqmp-reset.yaml
> /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: versal-firmware: reset-controller: False schema does not allow {'compatible': ['xlnx,zynqmp-reset'], '#reset-cells': [[1]]}
> 	from schema $id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
> Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dtb: /example-0/versal-firmware/reset-controller: failed to match any schema with compatible: ['xlnx,zynqmp-reset']
> 
> doc reference errors (make refcheckdocs):
> 
> See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230709172542.1393828-1-piyush.mehta@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.
> 

When you fix this error, please add an indication of the platform in
question to $subject, "dt-bindings: firmware: add reset-controller property"
sounds like it applies to all firmware bindings..

Cheers,
Conor.

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