2023-09-12 05:57:48

by Kwanghoon Son

Subject: [PATCH 1/3] dt-bindings: reset: Document th1520 reset control

From: Kwanghoon Son <[email protected]>

Add documentation to describe th1520 reset device

Signed-off-by: Kwanghoon Son <[email protected]>
---
.../bindings/reset/thead,th1520-reset.yaml | 47 +++++++++++++++++++
include/dt-bindings/reset/th1520-reset.h | 9 ++++
2 files changed, 56 insertions(+)
create mode 100644 Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml
create mode 100644 include/dt-bindings/reset/th1520-reset.h

diff --git a/Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml b/Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml
new file mode 100644
index 000000000000..6724a9ccdd55
--- /dev/null
+++ b/Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/reset/thead,th1520-reset.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: T-HEAD th1520 SoC Reset Controller
+
+maintainers:
+ - Kwanghoon Son <[email protected]>
+
+allOf:
+ - $ref: /schemas/mfd/syscon.yaml#
+
+properties:
+ compatible:
+ items:
+ - const: thead,th1520-reset
+ - const: syscon
+
+ reg:
+ maxItems: 1
+
+ '#reset-cells':
+ const: 1
+
+required:
+ - compatible
+ - reg
+ - '#reset-cells'
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/reset/th1520-reset.h>
+
+ soc {
+ #address-cells = <2>;
+ #size-cells = <2>;
+
+ reset-controller@ffef014000 {
+ compatible = "thead,th1520-reset", "syscon";
+ reg = <0xff 0xef014000 0x0 0x1000>;
+ #reset-cells = <1>;
+ };
+ };
diff --git a/include/dt-bindings/reset/th1520-reset.h b/include/dt-bindings/reset/th1520-reset.h
new file mode 100644
index 000000000000..ec10751814e5
--- /dev/null
+++ b/include/dt-bindings/reset/th1520-reset.h
@@ -0,0 +1,9 @@
+/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
+
+#ifndef DT_BINDING_RESET_TH1520_H
+#define DT_BINDING_RESET_TH1520_H
+
+#define TH1520_RESET_WDT0 0
+#define TH1520_RESET_WDT1 1
+
+#endif
--
2.34.1

2023-09-12 16:50:02

by Krzysztof Kozlowski

Subject: Re: [PATCH 1/3] dt-bindings: reset: Document th1520 reset control

On 12/09/2023 04:49, [email protected] wrote:
> From: Kwanghoon Son <[email protected]>
>
> Add documentation to describe th1520 reset device

Full stop.

>
> Signed-off-by: Kwanghoon Son <[email protected]>

This is v2, not v1. Please provide changelog after ---.


> ---
> .../bindings/reset/thead,th1520-reset.yaml | 47 +++++++++++++++++++
> include/dt-bindings/reset/th1520-reset.h | 9 ++++
> 2 files changed, 56 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml
> create mode 100644 include/dt-bindings/reset/th1520-reset.h
>
> diff --git a/Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml b/Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml
> new file mode 100644
> index 000000000000..6724a9ccdd55
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/reset/thead,th1520-reset.yaml
> @@ -0,0 +1,47 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/reset/thead,th1520-reset.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: T-HEAD th1520 SoC Reset Controller
> +
> +maintainers:
> + - Kwanghoon Son <[email protected]>
> +
> +allOf:
> + - $ref: /schemas/mfd/syscon.yaml#

Why do you need it? Which existing file suggested such code?

> +
> +properties:
> + compatible:
> + items:
> + - const: thead,th1520-reset
> + - const: syscon
> +
> + reg:
> + maxItems: 1
> +
> + '#reset-cells':
> + const: 1
> +
> +required:
> + - compatible
> + - reg
> + - '#reset-cells'
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/reset/th1520-reset.h>
> +
> + soc {
> + #address-cells = <2>;

Your indentation is messed up. Here two spaces, further four. Just keep
one indentation for the example - 4 spaces.

> + #size-cells = <2>;
> +
> + reset-controller@ffef014000 {
> + compatible = "thead,th1520-reset", "syscon";
> + reg = <0xff 0xef014000 0x0 0x1000>;
> + #reset-cells = <1>;
> + };
> + };
> diff --git a/include/dt-bindings/reset/th1520-reset.h b/include/dt-bindings/reset/th1520-reset.h
> new file mode 100644
> index 000000000000..ec10751814e5
> --- /dev/null
> +++ b/include/dt-bindings/reset/th1520-reset.h

Filename matching bindings/compatible - missing vendor prefix.


Best regards,
Krzysztof