[PATCH v2 1/4] dt-bindings: reset: Add Armada8K reset controller

Wilson Ding posted 4 patches 9 months, 4 weeks ago
There is a newer version of this series
[PATCH v2 1/4] dt-bindings: reset: Add Armada8K reset controller
Posted by Wilson Ding 9 months, 4 weeks ago
Add device-tree binding documentation for the Armada8K reset driver.

Signed-off-by: Wilson Ding <dingwei@marvell.com>
---
 .../reset/marvell,armada8k-reset.yaml         | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml

diff --git a/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml b/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
new file mode 100644
index 000000000000..b9f7f3c24d3c
--- /dev/null
+++ b/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2025 Wilson Ding <dingwei@marvell.com>
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/reset/marvell,armada8k-reset.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell Armada8K reset controller
+
+maintainers:
+  - Wilson Ding <dingwei@marvell.com>
+
+description: The reset controller node must be a sub-node of the system
+  controller node on Armada7K/8K or CN913x SoCs.
+
+properties:
+  compatible:
+    const: marvell,armada8k-reset
+
+  offset:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Offset in the register map for the gpio registers (in bytes)
+
+  "#reset-cells":
+    const: 1
+
+required:
+  - compatible
+  - offset
+  - "#reset-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    syscon0: system-controller@440000 {
+      compatible = "syscon", "simple-mfd";
+      reg = <0x440000 0x2000>;
+
+        unit_swrst: reset-controller@268 {
+            compatible = "marvell,armada8k-reset";
+            offset = <0x268>;
+            #reset-cells = <1>;
+        };
+    };
-- 
2.43.0
Re: [PATCH v2 1/4] dt-bindings: reset: Add Armada8K reset controller
Posted by Krzysztof Kozlowski 9 months, 4 weeks ago
On Thu, Feb 20, 2025 at 03:25:24PM -0800, Wilson Ding wrote:
> Add device-tree binding documentation for the Armada8K reset driver.
> 
> Signed-off-by: Wilson Ding <dingwei@marvell.com>
> ---
>  .../reset/marvell,armada8k-reset.yaml         | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> 
> diff --git a/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml b/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> new file mode 100644
> index 000000000000..b9f7f3c24d3c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2025 Wilson Ding <dingwei@marvell.com>
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/reset/marvell,armada8k-reset.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell Armada8K reset controller
> +
> +maintainers:
> +  - Wilson Ding <dingwei@marvell.com>
> +
> +description: The reset controller node must be a sub-node of the system
> +  controller node on Armada7K/8K or CN913x SoCs.
> +
> +properties:
> +  compatible:
> +    const: marvell,armada8k-reset
> +
> +  offset:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: Offset in the register map for the gpio registers (in bytes)

That's neither correct nor needed. Your device knows ofsset based on the
compatible.

Best regards,
Krzysztof
Re: [PATCH v2 1/4] dt-bindings: reset: Add Armada8K reset controller
Posted by Rob Herring 9 months, 3 weeks ago
On Fri, Feb 21, 2025 at 09:46:01AM +0100, Krzysztof Kozlowski wrote:
> On Thu, Feb 20, 2025 at 03:25:24PM -0800, Wilson Ding wrote:
> > Add device-tree binding documentation for the Armada8K reset driver.
> > 
> > Signed-off-by: Wilson Ding <dingwei@marvell.com>
> > ---
> >  .../reset/marvell,armada8k-reset.yaml         | 45 +++++++++++++++++++
> >  1 file changed, 45 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml b/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> > new file mode 100644
> > index 000000000000..b9f7f3c24d3c
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> > @@ -0,0 +1,45 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +# Copyright 2025 Wilson Ding <dingwei@marvell.com>
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/reset/marvell,armada8k-reset.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Marvell Armada8K reset controller
> > +
> > +maintainers:
> > +  - Wilson Ding <dingwei@marvell.com>
> > +
> > +description: The reset controller node must be a sub-node of the system
> > +  controller node on Armada7K/8K or CN913x SoCs.
> > +
> > +properties:
> > +  compatible:
> > +    const: marvell,armada8k-reset
> > +
> > +  offset:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Offset in the register map for the gpio registers (in bytes)
> 
> That's neither correct nor needed. Your device knows ofsset based on the
> compatible.

Or use 'reg'.

But really, just add #reset-cells to the parent node. There's no need 
for a child node here. The parent needs a specific compatible though.

Rob
Re: [PATCH v2 1/4] dt-bindings: reset: Add Armada8K reset controller
Posted by Rob Herring (Arm) 9 months, 4 weeks ago
On Thu, 20 Feb 2025 15:25:24 -0800, Wilson Ding wrote:
> Add device-tree binding documentation for the Armada8K reset driver.
> 
> Signed-off-by: Wilson Ding <dingwei@marvell.com>
> ---
>  .../reset/marvell,armada8k-reset.yaml         | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/reset/marvell,armada8k-reset.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/reset/marvell,armada8k-reset.example.dts:22.46-26.15: Warning (unit_address_vs_reg): /example-0/system-controller@440000/reset-controller@268: node has a unit name, but no reg or ranges property
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/reset/marvell,armada8k-reset.example.dtb: system-controller@440000: compatible: ['syscon', 'simple-mfd'] is too short
	from schema $id: http://devicetree.org/schemas/mfd/syscon-common.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250220232527.882888-2-dingwei@marvell.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.