2023-01-20 14:21:59

by Yann Sionneau

Subject: [RFC PATCH v2 05/31] Documentation: Add binding for kalray,coolidge-itgen

From: Jules Maselbas <[email protected]>

Add documentation for `kalray,coolidge-itgen` binding.

Co-developed-by: Jules Maselbas <[email protected]>
Signed-off-by: Jules Maselbas <[email protected]>
Signed-off-by: Yann Sionneau <[email protected]>
---

Notes:
V1 -> V2: new patch

.../kalray,coolidge-itgen.yaml | 48 +++++++++++++++++++
1 file changed, 48 insertions(+)
create mode 100644 Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml

diff --git a/Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml b/Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml
new file mode 100644
index 000000000000..47b503bff1d9
--- /dev/null
+++ b/Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/interrupt-controller/kalray,coolidge-itgen#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Kalray Coolidge SoC Interrupt Generator (ITGEN)
+
+description: |
+ The Interrupt Generator (ITGEN) is an interrupt controller block.
+ It's purpose is to convert IRQ lines coming from SoC peripherals into writes
+ on the AXI bus. The ITGEN intended purpose is to write into the APIC mailboxes.
+
+allOf:
+ - $ref: /schemas/interrupt-controller.yaml#
+
+properties:
+ compatible:
+ const: kalray,coolidge-itgen
+
+ "#interrupt-cells":
+ const: 2
+ description: |
+ - 1st cell is for the IRQ number
+ - 2nd cell is for the trigger type as defined dt-bindings/interrupt-controller/irq.h
+
+ interrupt-controller: true
+
+ msi-parent: true
+
+required:
+ - compatible
+ - reg
+ - "#interrupt-cells"
+ - interrupt-controller
+ - msi-parent
+
+examples:
+ - |
+ itgen: interrupt-controller@27000000 {
+ compatible = "kalray,coolidge-itgen";
+ reg = <0 0x27000000 0 0x1104>;
+ #interrupt-cells = <2>;
+ interrupt-controller;
+ msi-parent = <&apic_mailbox>;
+ };
+
+...
--
2.37.2

2023-01-22 12:17:18

by Krzysztof Kozlowski

Subject: Re: [RFC PATCH v2 05/31] Documentation: Add binding for kalray,coolidge-itgen

On 20/01/2023 15:09, Yann Sionneau wrote:
> From: Jules Maselbas <[email protected]>
>
> Add documentation for `kalray,coolidge-itgen` binding.
>
> Co-developed-by: Jules Maselbas <[email protected]>
> Signed-off-by: Jules Maselbas <[email protected]>
> Signed-off-by: Yann Sionneau <[email protected]>

The same comments apply plus more...

> ---
>
> Notes:
> V1 -> V2: new patch
>
> .../kalray,coolidge-itgen.yaml | 48 +++++++++++++++++++
> 1 file changed, 48 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml
>
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml b/Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml
> new file mode 100644
> index 000000000000..47b503bff1d9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/interrupt-controller/kalray,coolidge-itgen.yaml
> @@ -0,0 +1,48 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license. Checkpatch should complain about this - did you run it?

This applies to all your other patches (both, run checkpatch and use
proper license).


> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/interrupt-controller/kalray,coolidge-itgen#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Kalray Coolidge SoC Interrupt Generator (ITGEN)
> +
> +description: |
> + The Interrupt Generator (ITGEN) is an interrupt controller block.
> + It's purpose is to convert IRQ lines coming from SoC peripherals into writes
> + on the AXI bus. The ITGEN intended purpose is to write into the APIC mailboxes.
> +
> +allOf:
> + - $ref: /schemas/interrupt-controller.yaml#
> +
> +properties:
> + compatible:
> + const: kalray,coolidge-itgen
> +

So why suddenly this patch has proper blank lines...

Missing reg.

> + "#interrupt-cells":
> + const: 2
> + description: |
> + - 1st cell is for the IRQ number
> + - 2nd cell is for the trigger type as defined dt-bindings/interrupt-controller/irq.h
> +
> + interrupt-controller: true
> +
> + msi-parent: true
> +
> +required:
> + - compatible
> + - reg
> + - "#interrupt-cells"
> + - interrupt-controller
> + - msi-parent
> +
> +examples:
> + - |
> + itgen: interrupt-controller@27000000 {
> + compatible = "kalray,coolidge-itgen";
> + reg = <0 0x27000000 0 0x1104>;
> + #interrupt-cells = <2>;
> + interrupt-controller;
> + msi-parent = <&apic_mailbox>;
> + };
> +
> +...

Best regards,
Krzysztof