diff mbox series

[V3] dt-bindings: reset: convert the xlnx,zynqmp-reset.txt to yaml

Message ID 20230613123048.2935502-1-piyush.mehta@amd.com
State Not Applicable, archived
Headers show
Series [V3] dt-bindings: reset: convert the xlnx,zynqmp-reset.txt to yaml | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 2 warnings, 52 lines checked
robh/patch-applied success
robh/dt-meta-schema fail build log

Commit Message

Mehta, Piyush June 13, 2023, 12:30 p.m. UTC 
Convert the binding to DT schema format. It also updates the
reset-controller description.

Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
---
Changes in V2:
- Addressed the Krzysztof review comment:
 - Update DT binding to fix the dt_binding_check warning.
 - Removed 2/2 - xlnx,zynqmp-firmware.yaml binding patch: Will send after
   xlnx,zynqmp-reset.yaml binding merge.

Link: https://lore.kernel.org/lkml/168612336438.2153757.6000360498539992409.robh@kernel.org/T/#m4abfe6287177d5fd09f781d298dd19d56aae5e27

Changes in V3:
- Addressed the Krzysztof review comment:
 - Removed 2/2 - xlnx,zynqmp-firmware.yaml binding patch: Will send after
   xlnx,zynqmp-reset.yaml binding merge.
 - Update title: Removed "binding".
 - Update Example:
  - Removed header file.
  - Dropped three levels of indentations: firmware and zynqmp_firmware.
  - Removed the sata example.

Link: https://lore.kernel.org/all/22e3c25e-487b-c02f-46f3-6d2ab2be8813@linaro.org/
---
 .../bindings/reset/xlnx,zynqmp-reset.txt      | 55 -------------------
 .../bindings/reset/xlnx,zynqmp-reset.yaml     | 52 ++++++++++++++++++
 2 files changed, 52 insertions(+), 55 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.txt
 create mode 100644 Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.yaml

Comments

Rob Herring June 13, 2023, 1:19 p.m. UTC | #1 
On Tue, 13 Jun 2023 18:00:48 +0530, Piyush Mehta wrote:
> Convert the binding to DT schema format. It also updates the
> reset-controller description.
> 
> Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
> ---
> Changes in V2:
> - Addressed the Krzysztof review comment:
>  - Update DT binding to fix the dt_binding_check warning.
>  - Removed 2/2 - xlnx,zynqmp-firmware.yaml binding patch: Will send after
>    xlnx,zynqmp-reset.yaml binding merge.
> 
> Link: https://lore.kernel.org/lkml/168612336438.2153757.6000360498539992409.robh@kernel.org/T/#m4abfe6287177d5fd09f781d298dd19d56aae5e27
> 
> Changes in V3:
> - Addressed the Krzysztof review comment:
>  - Removed 2/2 - xlnx,zynqmp-firmware.yaml binding patch: Will send after
>    xlnx,zynqmp-reset.yaml binding merge.
>  - Update title: Removed "binding".
>  - Update Example:
>   - Removed header file.
>   - Dropped three levels of indentations: firmware and zynqmp_firmware.
>   - Removed the sata example.
> 
> Link: https://lore.kernel.org/all/22e3c25e-487b-c02f-46f3-6d2ab2be8813@linaro.org/
> ---
>  .../bindings/reset/xlnx,zynqmp-reset.txt      | 55 -------------------
>  .../bindings/reset/xlnx,zynqmp-reset.yaml     | 52 ++++++++++++++++++
>  2 files changed, 52 insertions(+), 55 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.txt
>  create mode 100644 Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.yaml
> 

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/pinctrl/qcom,pmic-mpp.yaml: $defs:qcom-pmic-mpp-state:properties:qcom,paired: [{'description': 'Indicates that the pin should be operating in paired mode.'}] is not of type 'object', 'boolean'
	from schema $id: http://devicetree.org/meta-schemas/core.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230613123048.2935502-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.
Rob Herring June 13, 2023, 1:43 p.m. UTC | #2 
On Tue, Jun 13, 2023 at 07:19:34AM -0600, Rob Herring wrote:
> 
> On Tue, 13 Jun 2023 18:00:48 +0530, Piyush Mehta wrote:
> > Convert the binding to DT schema format. It also updates the
> > reset-controller description.
> > 
> > Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
> > ---
> > Changes in V2:
> > - Addressed the Krzysztof review comment:
> >  - Update DT binding to fix the dt_binding_check warning.
> >  - Removed 2/2 - xlnx,zynqmp-firmware.yaml binding patch: Will send after
> >    xlnx,zynqmp-reset.yaml binding merge.
> > 
> > Link: https://lore.kernel.org/lkml/168612336438.2153757.6000360498539992409.robh@kernel.org/T/#m4abfe6287177d5fd09f781d298dd19d56aae5e27
> > 
> > Changes in V3:
> > - Addressed the Krzysztof review comment:
> >  - Removed 2/2 - xlnx,zynqmp-firmware.yaml binding patch: Will send after
> >    xlnx,zynqmp-reset.yaml binding merge.
> >  - Update title: Removed "binding".
> >  - Update Example:
> >   - Removed header file.
> >   - Dropped three levels of indentations: firmware and zynqmp_firmware.
> >   - Removed the sata example.
> > 
> > Link: https://lore.kernel.org/all/22e3c25e-487b-c02f-46f3-6d2ab2be8813@linaro.org/
> > ---
> >  .../bindings/reset/xlnx,zynqmp-reset.txt      | 55 -------------------
> >  .../bindings/reset/xlnx,zynqmp-reset.yaml     | 52 ++++++++++++++++++
> >  2 files changed, 52 insertions(+), 55 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.txt
> >  create mode 100644 Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.yaml
> > 
> 
> 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/pinctrl/qcom,pmic-mpp.yaml: $defs:qcom-pmic-mpp-state:properties:qcom,paired: [{'description': 'Indicates that the pin should be operating in paired mode.'}] is not of type 'object', 'boolean'
> 	from schema $id: http://devicetree.org/meta-schemas/core.yaml#

Unrelated. This can be ignored.

Rob
Krzysztof Kozlowski June 13, 2023, 6:38 p.m. UTC | #3 
On 13/06/2023 14:30, Piyush Mehta wrote:
> Convert the binding to DT schema format. It also updates the
> reset-controller description.
> 
> Signed-off-by: Piyush Mehta <piyush.mehta@amd.com>
> ---

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.txt b/Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.txt
deleted file mode 100644
index ed836868dbf1..000000000000
--- a/Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.txt
+++ /dev/null
@@ -1,55 +0,0 @@ 
---------------------------------------------------------------------------
- =  Zynq UltraScale+ MPSoC and Versal reset driver binding =
---------------------------------------------------------------------------
-The Zynq UltraScale+ MPSoC and Versal has several different resets.
-
-See Chapter 36 of the Zynq UltraScale+ MPSoC TRM (UG) for more information
-about zynqmp resets.
-
-Please also refer to reset.txt in this directory for common reset
-controller binding usage.
-
-Required Properties:
-- compatible:	"xlnx,zynqmp-reset" for Zynq UltraScale+ MPSoC platform
-		"xlnx,versal-reset" for Versal platform
-- #reset-cells:	Specifies the number of cells needed to encode reset
-		line, should be 1
-
--------
-Example
--------
-
-firmware {
-	zynqmp_firmware: zynqmp-firmware {
-		compatible = "xlnx,zynqmp-firmware";
-		method = "smc";
-
-		zynqmp_reset: reset-controller {
-			compatible = "xlnx,zynqmp-reset";
-			#reset-cells = <1>;
-		};
-	};
-};
-
-Specifying reset lines connected to IP modules
-==============================================
-
-Device nodes that need access to reset lines should
-specify them as a reset phandle in their corresponding node as
-specified in reset.txt.
-
-For list of all valid reset indices for Zynq UltraScale+ MPSoC see
-<dt-bindings/reset/xlnx-zynqmp-resets.h>
-For list of all valid reset indices for Versal see
-<dt-bindings/reset/xlnx-versal-resets.h>
-
-Example:
-
-serdes: zynqmp_phy@fd400000 {
-	...
-
-	resets = <&zynqmp_reset ZYNQMP_RESET_SATA>;
-	reset-names = "sata_rst";
-
-	...
-};
diff --git a/Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.yaml b/Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.yaml
new file mode 100644
index 000000000000..0d50f6a54af3
--- /dev/null
+++ b/Documentation/devicetree/bindings/reset/xlnx,zynqmp-reset.yaml
@@ -0,0 +1,52 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/reset/xlnx,zynqmp-reset.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Zynq UltraScale+ MPSoC and Versal reset
+
+maintainers:
+  - Piyush Mehta <piyush.mehta@amd.com>
+
+description: |
+  The Zynq UltraScale+ MPSoC and Versal has several different resets.
+
+  The PS reset subsystem is responsible for handling the external reset
+  input to the device and that all internal reset requirements are met
+  for the system (as a whole) and for the functional units.
+
+  Please also refer to reset.txt in this directory for common reset
+  controller binding usage. Device nodes that need access to reset
+  lines should specify them as a reset phandle in their corresponding
+  node as specified in reset.txt.
+
+  For list of all valid reset indices for Zynq UltraScale+ MPSoC
+  <dt-bindings/reset/xlnx-zynqmp-resets.h>
+
+  For list of all valid reset indices for Versal
+  <dt-bindings/reset/xlnx-versal-resets.h>
+
+properties:
+  compatible:
+    enum:
+      - xlnx,zynqmp-reset
+      - xlnx,versal-reset
+
+  "#reset-cells":
+    const: 1
+
+required:
+  - compatible
+  - "#reset-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    zynqmp_reset: reset-controller {
+        compatible = "xlnx,zynqmp-reset";
+        #reset-cells = <1>;
+    };
+
+...