[v2] dt-bindings: interrupt-controller: add Ralink SoCs interrupt controller

Message ID 20230622110451.1504823-1-sergio.paracuellos@gmail.com
State New
Headers
Series [v2] dt-bindings: interrupt-controller: add Ralink SoCs interrupt controller |

Commit Message

Sergio Paracuellos June 22, 2023, 11:04 a.m. UTC
  Add YAML doc for the interrupt controller which is present on Ralink SoCs.

Signed-off-by: Sergio Paracuellos <sergio.paracuellos@gmail.com>
---
Changes in v2:
 - Drop label from the example.

 .../ralink,rt2880-intc.yaml                   | 54 +++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
  

Comments

Conor Dooley June 22, 2023, 7:14 p.m. UTC | #1
On Thu, Jun 22, 2023 at 01:04:51PM +0200, Sergio Paracuellos wrote:
> Add YAML doc for the interrupt controller which is present on Ralink SoCs.
> 
> Signed-off-by: Sergio Paracuellos <sergio.paracuellos@gmail.com>
> ---
> Changes in v2:
>  - Drop label from the example.
> 
>  .../ralink,rt2880-intc.yaml                   | 54 +++++++++++++++++++
>  1 file changed, 54 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml b/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
> new file mode 100644
> index 000000000000..533d6d03aa75
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/interrupt-controller/ralink,rt2880-intc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Ralink SoCs Interrupt Controller
> +
> +maintainers:
> +  - Sergio Paracuellos <sergio.paracuellos@gmail.com>
> +
> +allOf:
> +  - $ref: /schemas/interrupt-controller.yaml#
> +
> +description: |

FWIW, you don't need a | unless you have some formatting to preserve.

> +  This interrupt controller support a central point for interrupt aggregation
> +  for platform related blocks.
> +
> +properties:
> +  compatible:
> +    const: ralink,rt2880-intc
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  interrupt-controller: true
> +
> +  '#interrupt-cells':
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-controller
> +  - '#interrupt-cells'
> +
> +unevaluatedProperties: false

You explicitly allow two properties from interrupt-controller.yaml, so
it seems like this should actually be additionalProperties: false to
block things like interrupt-map etc?

If your intention was only to allow interrupt-controller, with
s/unevaluated/additional/ you can add
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.

> +
> +examples:
> +  - |
> +    interrupt-controller@200 {
> +      compatible = "ralink,rt2880-intc";
> +      reg = <0x200 0x100>;
> +      interrupt-controller;
> +      #interrupt-cells = <1>;
> +
> +      interrupt-parent = <&cpuintc>;
> +      interrupts = <2>;
> +    };
> +...
> -- 
> 2.25.1
>
  
Sergio Paracuellos June 23, 2023, 3:54 a.m. UTC | #2
Hi Conor,

On Thu, Jun 22, 2023 at 9:14 PM Conor Dooley <conor@kernel.org> wrote:
>
> On Thu, Jun 22, 2023 at 01:04:51PM +0200, Sergio Paracuellos wrote:
> > Add YAML doc for the interrupt controller which is present on Ralink SoCs.
> >
> > Signed-off-by: Sergio Paracuellos <sergio.paracuellos@gmail.com>
> > ---
> > Changes in v2:
> >  - Drop label from the example.
> >
> >  .../ralink,rt2880-intc.yaml                   | 54 +++++++++++++++++++
> >  1 file changed, 54 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml b/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
> > new file mode 100644
> > index 000000000000..533d6d03aa75
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
> > @@ -0,0 +1,54 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/interrupt-controller/ralink,rt2880-intc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Ralink SoCs Interrupt Controller
> > +
> > +maintainers:
> > +  - Sergio Paracuellos <sergio.paracuellos@gmail.com>
> > +
> > +allOf:
> > +  - $ref: /schemas/interrupt-controller.yaml#
> > +
> > +description: |
>
> FWIW, you don't need a | unless you have some formatting to preserve.

True. Will drop, then.

>
> > +  This interrupt controller support a central point for interrupt aggregation
> > +  for platform related blocks.
> > +
> > +properties:
> > +  compatible:
> > +    const: ralink,rt2880-intc
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  interrupt-controller: true
> > +
> > +  '#interrupt-cells':
> > +    const: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - interrupt-controller
> > +  - '#interrupt-cells'
> > +
> > +unevaluatedProperties: false
>
> You explicitly allow two properties from interrupt-controller.yaml, so
> it seems like this should actually be additionalProperties: false to
> block things like interrupt-map etc?

Yes, this should be additionalProperties.
>
> If your intention was only to allow interrupt-controller, with
> s/unevaluated/additional/ you can add
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

I will fix these two minor things and send v3 with your Reviewed-by
added, thanks.

Best regards,
    Sergio Paracuellos
>
> Cheers,
> Conor.
>
> > +
> > +examples:
> > +  - |
> > +    interrupt-controller@200 {
> > +      compatible = "ralink,rt2880-intc";
> > +      reg = <0x200 0x100>;
> > +      interrupt-controller;
> > +      #interrupt-cells = <1>;
> > +
> > +      interrupt-parent = <&cpuintc>;
> > +      interrupts = <2>;
> > +    };
> > +...
> > --
> > 2.25.1
> >
  

Patch

diff --git a/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml b/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
new file mode 100644
index 000000000000..533d6d03aa75
--- /dev/null
+++ b/Documentation/devicetree/bindings/interrupt-controller/ralink,rt2880-intc.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/interrupt-controller/ralink,rt2880-intc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Ralink SoCs Interrupt Controller
+
+maintainers:
+  - Sergio Paracuellos <sergio.paracuellos@gmail.com>
+
+allOf:
+  - $ref: /schemas/interrupt-controller.yaml#
+
+description: |
+  This interrupt controller support a central point for interrupt aggregation
+  for platform related blocks.
+
+properties:
+  compatible:
+    const: ralink,rt2880-intc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  interrupt-controller: true
+
+  '#interrupt-cells':
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-controller
+  - '#interrupt-cells'
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    interrupt-controller@200 {
+      compatible = "ralink,rt2880-intc";
+      reg = <0x200 0x100>;
+      interrupt-controller;
+      #interrupt-cells = <1>;
+
+      interrupt-parent = <&cpuintc>;
+      interrupts = <2>;
+    };
+...