We add DT bindings document for RISC-V advanced platform level interrupt
controller (APLIC) defined by the RISC-V advanced interrupt architecture
(AIA) specification.
Signed-off-by: Anup Patel <[email protected]>
---
.../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
1 file changed, 136 insertions(+)
create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
new file mode 100644
index 000000000000..0aa48571f3bc
--- /dev/null
+++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
@@ -0,0 +1,136 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
+
+maintainers:
+ - Anup Patel <[email protected]>
+
+description:
+ The RISC-V advanced interrupt architecture (AIA) defines advanced platform
+ level interrupt controller (APLIC) for handling wired interrupts in a
+ RISC-V platform. The RISC-V AIA specification can be found at
+ https://github.com/riscv/riscv-aia.
+
+ The RISC-V APLIC is implemented as hierarchical APLIC domains where all
+ interrupt sources connect to the root domain which can further delegate
+ interrupts to child domains. We have one device tree node for each APLIC
+ domain.
+
+allOf:
+ - $ref: /schemas/interrupt-controller.yaml#
+
+properties:
+ compatible:
+ items:
+ - enum:
+ - vendor,chip-aplic
+ - const: riscv,aplic
+
+ reg:
+ maxItems: 1
+
+ interrupt-controller: true
+
+ "#interrupt-cells":
+ const: 2
+
+ interrupts-extended:
+ minItems: 1
+ maxItems: 16384
+ description:
+ The presence of this property implies that given APLIC domain directly
+ injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
+ node pointed to should be a riscv,cpu-intc node, which has a riscv node
+ (i.e. RISC-V HART) as parent.
+
+ msi-parent:
+ description:
+ The presence of this property implies that given APLIC domain forwards
+ wired interrupts as MSIs to a AIA incoming message signaled interrupt
+ controller (IMSIC). This property should be considered only when the
+ interrupts-extended property is absent.
+
+ riscv,num-sources:
+ $ref: "/schemas/types.yaml#/definitions/uint32"
+ minimum: 1
+ maximum: 1023
+ description:
+ Specifies how many wired interrupts are supported by this APLIC domain.
+
+ riscv,children:
+ $ref: '/schemas/types.yaml#/definitions/phandle-array'
+ minItems: 1
+ maxItems: 1024
+ description:
+ This property represents a list of child APLIC domains for the given
+ APLIC domain. Each child APLIC domain is assigned child index in
+ increasing order with the first child APLIC domain assigned child
+ index 0. The APLIC domain child index is used by firmware to delegate
+ interrupts from the given APLIC domain to a particular child APLIC
+ domain.
+
+ riscv,delegate:
+ $ref: '/schemas/types.yaml#/definitions/phandle-array'
+ minItems: 1
+ maxItems: 1024
+ description:
+ This property represents a interrupt delegation list where each entry
+ is a triple consisting of child APLIC domain phandle, first interrupt
+ number, and last interrupt number. The firmware will configure interrupt
+ delegation registers based on interrupt delegation list.
+
+additionalProperties: false
+
+required:
+ - compatible
+ - reg
+ - interrupt-controller
+ - "#interrupt-cells"
+ - riscv,num-sources
+
+examples:
+ - |
+ // Example 1 (APIC domain directly injecting interrupt to HARTs):
+
+ aplic0: interrupt-controller@c000000 {
+ compatible = "vendor,chip-aplic", "riscv,aplic";
+ interrupts-extended = <&cpu1_intc 11>,
+ <&cpu2_intc 11>,
+ <&cpu3_intc 11>,
+ <&cpu4_intc 11>;
+ reg = <0xc000000 0x4080>;
+ interrupt-controller;
+ #interrupt-cells = <2>;
+ riscv,num-sources = <63>;
+ riscv,children = <&aplic1>;
+ riscv,delegate = <&aplic1 1 63>;
+ };
+
+ aplic1: interrupt-controller@d000000 {
+ compatible = "vendor,chip-aplic", "riscv,aplic";
+ interrupts-extended = <&cpu1_intc 9>,
+ <&cpu2_intc 9>,
+ <&cpu3_intc 9>,
+ <&cpu4_intc 9>;
+ reg = <0xd000000 0x4080>;
+ interrupt-controller;
+ #interrupt-cells = <2>;
+ riscv,num-sources = <63>;
+ };
+
+ - |
+ // Example 2 (APIC domain forwarding interrupts as MSIs):
+
+ interrupt-controller@d000000 {
+ compatible = "vendor,chip-aplic", "riscv,aplic";
+ msi-parent = <&imsics>;
+ reg = <0xd000000 0x4000>;
+ interrupt-controller;
+ #interrupt-cells = <2>;
+ riscv,num-sources = <63>;
+ };
+...
--
2.34.1
Hey Anup,
Ditto the $subject nit here.
On Fri, Nov 11, 2022 at 10:12:04AM +0530, Anup Patel wrote:
> We add DT bindings document for RISC-V advanced platform level interrupt
> controller (APLIC) defined by the RISC-V advanced interrupt architecture
> (AIA) specification.
>
> Signed-off-by: Anup Patel <[email protected]>
> ---
> .../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
> 1 file changed, 136 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
>
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> new file mode 100644
> index 000000000000..0aa48571f3bc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> @@ -0,0 +1,136 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
Typo: Advanced
> +
> +maintainers:
> + - Anup Patel <[email protected]>
> +
> +description:
> + The RISC-V advanced interrupt architecture (AIA) defines advanced platform
^
Missing an article here?
> + level interrupt controller (APLIC) for handling wired interrupts in a
> + RISC-V platform. The RISC-V AIA specification can be found at
> + https://github.com/riscv/riscv-aia.
> +
> + The RISC-V APLIC is implemented as hierarchical APLIC domains where all
> + interrupt sources connect to the root domain which can further delegate
> + interrupts to child domains. We have one device tree node for each APLIC
While I am nitpicking, s/We have/There is/ ?
> + domain.
> +
> +allOf:
> + - $ref: /schemas/interrupt-controller.yaml#
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - vendor,chip-aplic
Same comment here about the validity of this placeholder.
> + - const: riscv,aplic
> +
> + reg:
> + maxItems: 1
> +
> + interrupt-controller: true
> +
> + "#interrupt-cells":
> + const: 2
> +
> + interrupts-extended:
> + minItems: 1
> + maxItems: 16384
> + description:
> + The presence of this property implies that given APLIC domain directly
^
Missing indefinite article here (and in msi-parent)?
> + injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
> + node pointed to should be a riscv,cpu-intc node, which has a riscv node
> + (i.e. RISC-V HART) as parent.
> +
> + msi-parent:
> + description:
> + The presence of this property implies that given APLIC domain forwards
> + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> + controller (IMSIC). This property should be considered only when the
> + interrupts-extended property is absent.
This mutual exclusion can be represented, can't it?
IIRC it is some sort of oneOf thing, somewhat like below:
oneOf:
- required:
- msi-parent
- required:
- interrupts-extended
AFAIR from doing the i2c ocores binding, this will force the addition of
one, but not both, to a node.
Or is this not actually mutually exclusive & the msi-parent property is
permitted but just left unused if interrupts-extended is present?
> + riscv,num-sources:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + minimum: 1
> + maximum: 1023
> + description:
> + Specifies how many wired interrupts are supported by this APLIC domain.
> +
> + riscv,children:
> + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> + minItems: 1
> + maxItems: 1024
> + description:
> + This property represents a list of child APLIC domains for the given
> + APLIC domain. Each child APLIC domain is assigned child index in
> + increasing order with the first child APLIC domain assigned child
> + index 0. The APLIC domain child index is used by firmware to delegate
> + interrupts from the given APLIC domain to a particular child APLIC
> + domain.
> +
> + riscv,delegate:
> + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> + minItems: 1
> + maxItems: 1024
> + description:
> + This property represents a interrupt delegation list where each entry
> + is a triple consisting of child APLIC domain phandle, first interrupt
> + number, and last interrupt number. The firmware will configure interrupt
> + delegation registers based on interrupt delegation list.
What is the inter dependence of the children and delegate?
Is it valid to have a delegate property without children?
Can the firmware delegate interrupts without the delegation list, based
on the children property alone? Or is it effectively useless without a
children property?
In your examples, the second has msi-parent but neither of these custom
properties. Do the children/delegate properties have a meaning in the
msi-parent case?
I think the binding should enforce whatever dependency exists there.
Thanks,
Conor.
> +
> +additionalProperties: false
> +
> +required:
> + - compatible
> + - reg
> + - interrupt-controller
> + - "#interrupt-cells"
> + - riscv,num-sources
> +
> +examples:
> + - |
> + // Example 1 (APIC domain directly injecting interrupt to HARTs):
> +
> + aplic0: interrupt-controller@c000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + interrupts-extended = <&cpu1_intc 11>,
> + <&cpu2_intc 11>,
> + <&cpu3_intc 11>,
> + <&cpu4_intc 11>;
> + reg = <0xc000000 0x4080>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + riscv,children = <&aplic1>;
> + riscv,delegate = <&aplic1 1 63>;
> + };
> +
> + aplic1: interrupt-controller@d000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + interrupts-extended = <&cpu1_intc 9>,
> + <&cpu2_intc 9>,
> + <&cpu3_intc 9>,
> + <&cpu4_intc 9>;
> + reg = <0xd000000 0x4080>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + };
> +
> + - |
> + // Example 2 (APIC domain forwarding interrupts as MSIs):
> +
> + interrupt-controller@d000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + msi-parent = <&imsics>;
> + reg = <0xd000000 0x4000>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + };
> +...
> --
> 2.34.1
>
>
> _______________________________________________
> linux-riscv mailing list
> [email protected]
> http://lists.infradead.org/mailman/listinfo/linux-riscv
On 11/11/2022 05:42, Anup Patel wrote:
> We add DT bindings document for RISC-V advanced platform level interrupt
> controller (APLIC) defined by the RISC-V advanced interrupt architecture
> (AIA) specification.
>
> Signed-off-by: Anup Patel <[email protected]>
> ---
> .../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
> 1 file changed, 136 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
>
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> new file mode 100644
> index 000000000000..0aa48571f3bc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> @@ -0,0 +1,136 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
> +
> +maintainers:
> + - Anup Patel <[email protected]>
> +
> +description:
> + The RISC-V advanced interrupt architecture (AIA) defines advanced platform
> + level interrupt controller (APLIC) for handling wired interrupts in a
> + RISC-V platform. The RISC-V AIA specification can be found at
> + https://github.com/riscv/riscv-aia.
> +
> + The RISC-V APLIC is implemented as hierarchical APLIC domains where all
> + interrupt sources connect to the root domain which can further delegate
> + interrupts to child domains. We have one device tree node for each APLIC
> + domain.
> +
> +allOf:
> + - $ref: /schemas/interrupt-controller.yaml#
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - vendor,chip-aplic
> + - const: riscv,aplic
> +
> + reg:
> + maxItems: 1
> +
> + interrupt-controller: true
> +
> + "#interrupt-cells":
> + const: 2
> +
> + interrupts-extended:
> + minItems: 1
> + maxItems: 16384
> + description:
> + The presence of this property implies that given APLIC domain directly
> + injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
> + node pointed to should be a riscv,cpu-intc node, which has a riscv node
> + (i.e. RISC-V HART) as parent.
> +
> + msi-parent:
> + description:
> + The presence of this property implies that given APLIC domain forwards
Drop "The presence of this property" and make it a proper sentence
describing hardware.
> + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> + controller (IMSIC). This property should be considered only when the
> + interrupts-extended property is absent.
> +
> + riscv,num-sources:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
Drop quotes.
> + minimum: 1
> + maximum: 1023
> + description:
> + Specifies how many wired interrupts are supported by this APLIC domain.
> +
> + riscv,children:
> + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> + minItems: 1
> + maxItems: 1024
> + description:
> + This property represents a list of child APLIC domains for the given
> + APLIC domain. Each child APLIC domain is assigned child index in
> + increasing order with the first child APLIC domain assigned child
> + index 0. The APLIC domain child index is used by firmware to delegate
> + interrupts from the given APLIC domain to a particular child APLIC
> + domain.
> +
> + riscv,delegate:
> + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> + minItems: 1
> + maxItems: 1024
> + description:
> + This property represents a interrupt delegation list where each entry
Drop "This property represents".
> + is a triple consisting of child APLIC domain phandle, first interrupt
> + number, and last interrupt number. The firmware will configure interrupt
> + delegation registers based on interrupt delegation list.
> +
> +additionalProperties: false
Same comments as in previous patch,
> +
> +required:
> + - compatible
> + - reg
> + - interrupt-controller
> + - "#interrupt-cells"
> + - riscv,num-sources
> +
> +examples:
> + - |
> + // Example 1 (APIC domain directly injecting interrupt to HARTs):
> +
> + aplic0: interrupt-controller@c000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + interrupts-extended = <&cpu1_intc 11>,
> + <&cpu2_intc 11>,
> + <&cpu3_intc 11>,
> + <&cpu4_intc 11>;
> + reg = <0xc000000 0x4080>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + riscv,children = <&aplic1>;
> + riscv,delegate = <&aplic1 1 63>;
> + };
> +
> + aplic1: interrupt-controller@d000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + interrupts-extended = <&cpu1_intc 9>,
> + <&cpu2_intc 9>,
> + <&cpu3_intc 9>,
> + <&cpu4_intc 9>;
> + reg = <0xd000000 0x4080>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + };
> +
> + - |
> + // Example 2 (APIC domain forwarding interrupts as MSIs):
> +
> + interrupt-controller@d000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + msi-parent = <&imsics>;
> + reg = <0xd000000 0x4000>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
It's almost the same as previous... don't add unnecessary examples
(difference in one property usually does not mean you need new example).
> + };
> +...
Best regards,
Krzysztof
On Mon, Nov 14, 2022 at 3:21 PM Krzysztof Kozlowski
<[email protected]> wrote:
>
> On 11/11/2022 05:42, Anup Patel wrote:
> > We add DT bindings document for RISC-V advanced platform level interrupt
> > controller (APLIC) defined by the RISC-V advanced interrupt architecture
> > (AIA) specification.
> >
> > Signed-off-by: Anup Patel <[email protected]>
> > ---
> > .../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
> > 1 file changed, 136 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> > new file mode 100644
> > index 000000000000..0aa48571f3bc
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> > @@ -0,0 +1,136 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
> > +
> > +maintainers:
> > + - Anup Patel <[email protected]>
> > +
> > +description:
> > + The RISC-V advanced interrupt architecture (AIA) defines advanced platform
> > + level interrupt controller (APLIC) for handling wired interrupts in a
> > + RISC-V platform. The RISC-V AIA specification can be found at
> > + https://github.com/riscv/riscv-aia.
> > +
> > + The RISC-V APLIC is implemented as hierarchical APLIC domains where all
> > + interrupt sources connect to the root domain which can further delegate
> > + interrupts to child domains. We have one device tree node for each APLIC
> > + domain.
> > +
> > +allOf:
> > + - $ref: /schemas/interrupt-controller.yaml#
> > +
> > +properties:
> > + compatible:
> > + items:
> > + - enum:
> > + - vendor,chip-aplic
> > + - const: riscv,aplic
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + interrupt-controller: true
> > +
> > + "#interrupt-cells":
> > + const: 2
> > +
> > + interrupts-extended:
> > + minItems: 1
> > + maxItems: 16384
> > + description:
> > + The presence of this property implies that given APLIC domain directly
> > + injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
> > + node pointed to should be a riscv,cpu-intc node, which has a riscv node
> > + (i.e. RISC-V HART) as parent.
> > +
> > + msi-parent:
> > + description:
> > + The presence of this property implies that given APLIC domain forwards
>
> Drop "The presence of this property" and make it a proper sentence
> describing hardware.
Okay, I will update.
>
> > + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> > + controller (IMSIC). This property should be considered only when the
> > + interrupts-extended property is absent.
> > +
> > + riscv,num-sources:
> > + $ref: "/schemas/types.yaml#/definitions/uint32"
>
> Drop quotes.
Okay, I will update.
>
> > + minimum: 1
> > + maximum: 1023
> > + description:
> > + Specifies how many wired interrupts are supported by this APLIC domain.
> > +
> > + riscv,children:
> > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > + minItems: 1
> > + maxItems: 1024
> > + description:
> > + This property represents a list of child APLIC domains for the given
> > + APLIC domain. Each child APLIC domain is assigned child index in
> > + increasing order with the first child APLIC domain assigned child
> > + index 0. The APLIC domain child index is used by firmware to delegate
> > + interrupts from the given APLIC domain to a particular child APLIC
> > + domain.
> > +
> > + riscv,delegate:
> > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > + minItems: 1
> > + maxItems: 1024
> > + description:
> > + This property represents a interrupt delegation list where each entry
>
> Drop "This property represents".
Okay, I will update.
>
> > + is a triple consisting of child APLIC domain phandle, first interrupt
> > + number, and last interrupt number. The firmware will configure interrupt
> > + delegation registers based on interrupt delegation list.
> > +
> > +additionalProperties: false
>
> Same comments as in previous patch,
Okay, I will update.
>
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - interrupt-controller
> > + - "#interrupt-cells"
> > + - riscv,num-sources
> > +
> > +examples:
> > + - |
> > + // Example 1 (APIC domain directly injecting interrupt to HARTs):
> > +
> > + aplic0: interrupt-controller@c000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + interrupts-extended = <&cpu1_intc 11>,
> > + <&cpu2_intc 11>,
> > + <&cpu3_intc 11>,
> > + <&cpu4_intc 11>;
> > + reg = <0xc000000 0x4080>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + riscv,children = <&aplic1>;
> > + riscv,delegate = <&aplic1 1 63>;
> > + };
> > +
> > + aplic1: interrupt-controller@d000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + interrupts-extended = <&cpu1_intc 9>,
> > + <&cpu2_intc 9>,
> > + <&cpu3_intc 9>,
> > + <&cpu4_intc 9>;
> > + reg = <0xd000000 0x4080>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + };
> > +
> > + - |
> > + // Example 2 (APIC domain forwarding interrupts as MSIs):
> > +
> > + interrupt-controller@d000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + msi-parent = <&imsics>;
> > + reg = <0xd000000 0x4000>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
>
> It's almost the same as previous... don't add unnecessary examples
> (difference in one property usually does not mean you need new example).
The second example shows the DT node of an APLIC in MSI-mode.
Most noteworthy part of this node is presence of "msi-parent" DT
property instead of "interrupts-extended" DT property to describe
an APLIC in MSI mode.
>
> > + };
> > +...
>
Best Regards,
Anup
On Fri, Nov 11, 2022 at 10:12:04AM +0530, Anup Patel wrote:
> We add DT bindings document for RISC-V advanced platform level interrupt
> controller (APLIC) defined by the RISC-V advanced interrupt architecture
> (AIA) specification.
>
> Signed-off-by: Anup Patel <[email protected]>
> ---
> .../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
> 1 file changed, 136 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
>
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> new file mode 100644
> index 000000000000..0aa48571f3bc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> @@ -0,0 +1,136 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
> +
> +maintainers:
> + - Anup Patel <[email protected]>
> +
> +description:
> + The RISC-V advanced interrupt architecture (AIA) defines advanced platform
> + level interrupt controller (APLIC) for handling wired interrupts in a
> + RISC-V platform. The RISC-V AIA specification can be found at
> + https://github.com/riscv/riscv-aia.
> +
> + The RISC-V APLIC is implemented as hierarchical APLIC domains where all
> + interrupt sources connect to the root domain which can further delegate
> + interrupts to child domains. We have one device tree node for each APLIC
> + domain.
> +
> +allOf:
> + - $ref: /schemas/interrupt-controller.yaml#
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - vendor,chip-aplic
> + - const: riscv,aplic
> +
> + reg:
> + maxItems: 1
> +
> + interrupt-controller: true
> +
> + "#interrupt-cells":
> + const: 2
> +
> + interrupts-extended:
> + minItems: 1
> + maxItems: 16384
> + description:
> + The presence of this property implies that given APLIC domain directly
> + injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
> + node pointed to should be a riscv,cpu-intc node, which has a riscv node
> + (i.e. RISC-V HART) as parent.
> +
> + msi-parent:
> + description:
> + The presence of this property implies that given APLIC domain forwards
> + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> + controller (IMSIC). This property should be considered only when the
> + interrupts-extended property is absent.
> +
> + riscv,num-sources:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + minimum: 1
> + maximum: 1023
> + description:
> + Specifies how many wired interrupts are supported by this APLIC domain.
> +
> + riscv,children:
> + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> + minItems: 1
> + maxItems: 1024
As each entry is a single phandle:
items:
maxItems: 1
> + description:
> + This property represents a list of child APLIC domains for the given
> + APLIC domain. Each child APLIC domain is assigned child index in
> + increasing order with the first child APLIC domain assigned child
> + index 0. The APLIC domain child index is used by firmware to delegate
> + interrupts from the given APLIC domain to a particular child APLIC
> + domain.
> +
> + riscv,delegate:
> + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> + minItems: 1
> + maxItems: 1024
items:
items:
- description: child APLIC domain phandle
- description: ...
- description: ...
> + description:
> + This property represents a interrupt delegation list where each entry
> + is a triple consisting of child APLIC domain phandle, first interrupt
> + number, and last interrupt number. The firmware will configure interrupt
> + delegation registers based on interrupt delegation list.
First and last are inclusive?
Couldn't riscv,children and riscv,delegate be combined? How would they
be different? If some children don't have any delegated interrupts, you
could use -1 for the cells for example.
An example showing the need would be nice.
> +
> +additionalProperties: false
> +
> +required:
> + - compatible
> + - reg
> + - interrupt-controller
> + - "#interrupt-cells"
> + - riscv,num-sources
> +
> +examples:
> + - |
> + // Example 1 (APIC domain directly injecting interrupt to HARTs):
Is than an x86 APIC or a typo?
> +
> + aplic0: interrupt-controller@c000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + interrupts-extended = <&cpu1_intc 11>,
> + <&cpu2_intc 11>,
> + <&cpu3_intc 11>,
> + <&cpu4_intc 11>;
> + reg = <0xc000000 0x4080>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + riscv,children = <&aplic1>;
> + riscv,delegate = <&aplic1 1 63>;
> + };
> +
> + aplic1: interrupt-controller@d000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + interrupts-extended = <&cpu1_intc 9>,
> + <&cpu2_intc 9>,
> + <&cpu3_intc 9>,
> + <&cpu4_intc 9>;
> + reg = <0xd000000 0x4080>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + };
> +
> + - |
> + // Example 2 (APIC domain forwarding interrupts as MSIs):
> +
> + interrupt-controller@d000000 {
> + compatible = "vendor,chip-aplic", "riscv,aplic";
> + msi-parent = <&imsics>;
> + reg = <0xd000000 0x4000>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + riscv,num-sources = <63>;
> + };
> +...
> --
> 2.34.1
>
>
On Sun, Nov 13, 2022 at 9:14 PM Conor Dooley <[email protected]> wrote:
>
> Hey Anup,
>
> Ditto the $subject nit here.
Adding "interrupt-controller:" to subject makes it longer than 80 characters.
>
> On Fri, Nov 11, 2022 at 10:12:04AM +0530, Anup Patel wrote:
> > We add DT bindings document for RISC-V advanced platform level interrupt
> > controller (APLIC) defined by the RISC-V advanced interrupt architecture
> > (AIA) specification.
> >
> > Signed-off-by: Anup Patel <[email protected]>
> > ---
> > .../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
> > 1 file changed, 136 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> > new file mode 100644
> > index 000000000000..0aa48571f3bc
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> > @@ -0,0 +1,136 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
>
> Typo: Advanced
Okay, I will update.
>
> > +
> > +maintainers:
> > + - Anup Patel <[email protected]>
> > +
> > +description:
> > + The RISC-V advanced interrupt architecture (AIA) defines advanced platform
> ^
> Missing an article here?
Okay, I will update.
>
> > + level interrupt controller (APLIC) for handling wired interrupts in a
> > + RISC-V platform. The RISC-V AIA specification can be found at
> > + https://github.com/riscv/riscv-aia.
> > +
> > + The RISC-V APLIC is implemented as hierarchical APLIC domains where all
> > + interrupt sources connect to the root domain which can further delegate
> > + interrupts to child domains. We have one device tree node for each APLIC
>
> While I am nitpicking, s/We have/There is/ ?
Okay, I will update.
>
> > + domain.
> > +
> > +allOf:
> > + - $ref: /schemas/interrupt-controller.yaml#
> > +
> > +properties:
> > + compatible:
> > + items:
> > + - enum:
> > + - vendor,chip-aplic
>
> Same comment here about the validity of this placeholder.
Okay, I will add "riscv,qemu-aplic" as QEMU specific compatible string.
>
> > + - const: riscv,aplic
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + interrupt-controller: true
> > +
> > + "#interrupt-cells":
> > + const: 2
> > +
> > + interrupts-extended:
> > + minItems: 1
> > + maxItems: 16384
> > + description:
> > + The presence of this property implies that given APLIC domain directly
> ^
> Missing indefinite article here (and in msi-parent)?
>
> > + injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
> > + node pointed to should be a riscv,cpu-intc node, which has a riscv node
> > + (i.e. RISC-V HART) as parent.
> > +
> > + msi-parent:
> > + description:
> > + The presence of this property implies that given APLIC domain forwards
> > + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> > + controller (IMSIC). This property should be considered only when the
> > + interrupts-extended property is absent.
>
> This mutual exclusion can be represented, can't it?
> IIRC it is some sort of oneOf thing, somewhat like below:
> oneOf:
> - required:
> - msi-parent
> - required:
> - interrupts-extended
>
> AFAIR from doing the i2c ocores binding, this will force the addition of
> one, but not both, to a node.
>
> Or is this not actually mutually exclusive & the msi-parent property is
> permitted but just left unused if interrupts-extended is present?
If both are present then interrupts-extended is preferred.
>
> > + riscv,num-sources:
> > + $ref: "/schemas/types.yaml#/definitions/uint32"
> > + minimum: 1
> > + maximum: 1023
> > + description:
> > + Specifies how many wired interrupts are supported by this APLIC domain.
> > +
> > + riscv,children:
> > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > + minItems: 1
> > + maxItems: 1024
> > + description:
> > + This property represents a list of child APLIC domains for the given
> > + APLIC domain. Each child APLIC domain is assigned child index in
> > + increasing order with the first child APLIC domain assigned child
> > + index 0. The APLIC domain child index is used by firmware to delegate
> > + interrupts from the given APLIC domain to a particular child APLIC
> > + domain.
> > +
> > + riscv,delegate:
> > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > + minItems: 1
> > + maxItems: 1024
> > + description:
> > + This property represents a interrupt delegation list where each entry
> > + is a triple consisting of child APLIC domain phandle, first interrupt
> > + number, and last interrupt number. The firmware will configure interrupt
> > + delegation registers based on interrupt delegation list.
>
> What is the inter dependence of the children and delegate?
> Is it valid to have a delegate property without children?
> Can the firmware delegate interrupts without the delegation list, based
> on the children property alone? Or is it effectively useless without a
> children property?
Both properties convey different information. The "riscv,childen" describes
the association of child indexes with child APLIC domains whereas the
"riscv,delegate" describes the interrupt delegation to few of the child
APLIC domains.
>
> In your examples, the second has msi-parent but neither of these custom
> properties. Do the children/delegate properties have a meaning in the
> msi-parent case?
The "riscv,childern" and "riscv,delegate" are only useful when we have
hierarchy of multiple APLIC domains. The second example only has
one APLIC domain hence these custom properties are absent.
>
> I think the binding should enforce whatever dependency exists there.
> Thanks,
> Conor.
>
> > +
> > +additionalProperties: false
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - interrupt-controller
> > + - "#interrupt-cells"
> > + - riscv,num-sources
> > +
> > +examples:
> > + - |
> > + // Example 1 (APIC domain directly injecting interrupt to HARTs):
> > +
> > + aplic0: interrupt-controller@c000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + interrupts-extended = <&cpu1_intc 11>,
> > + <&cpu2_intc 11>,
> > + <&cpu3_intc 11>,
> > + <&cpu4_intc 11>;
> > + reg = <0xc000000 0x4080>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + riscv,children = <&aplic1>;
> > + riscv,delegate = <&aplic1 1 63>;
> > + };
> > +
> > + aplic1: interrupt-controller@d000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + interrupts-extended = <&cpu1_intc 9>,
> > + <&cpu2_intc 9>,
> > + <&cpu3_intc 9>,
> > + <&cpu4_intc 9>;
> > + reg = <0xd000000 0x4080>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + };
> > +
> > + - |
> > + // Example 2 (APIC domain forwarding interrupts as MSIs):
> > +
> > + interrupt-controller@d000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + msi-parent = <&imsics>;
> > + reg = <0xd000000 0x4000>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + };
> > +...
> > --
> > 2.34.1
> >
> >
> > _______________________________________________
> > linux-riscv mailing list
> > [email protected]
> > http://lists.infradead.org/mailman/listinfo/linux-riscv
Regards,
Anup
On Thu, Nov 17, 2022 at 12:57 AM Rob Herring <[email protected]> wrote:
>
> On Fri, Nov 11, 2022 at 10:12:04AM +0530, Anup Patel wrote:
> > We add DT bindings document for RISC-V advanced platform level interrupt
> > controller (APLIC) defined by the RISC-V advanced interrupt architecture
> > (AIA) specification.
> >
> > Signed-off-by: Anup Patel <[email protected]>
> > ---
> > .../interrupt-controller/riscv,aplic.yaml | 136 ++++++++++++++++++
> > 1 file changed, 136 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> > new file mode 100644
> > index 000000000000..0aa48571f3bc
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/interrupt-controller/riscv,aplic.yaml
> > @@ -0,0 +1,136 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/interrupt-controller/riscv,aplic.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: RISC-V Advancded Platform Level Interrupt Controller (APLIC)
> > +
> > +maintainers:
> > + - Anup Patel <[email protected]>
> > +
> > +description:
> > + The RISC-V advanced interrupt architecture (AIA) defines advanced platform
> > + level interrupt controller (APLIC) for handling wired interrupts in a
> > + RISC-V platform. The RISC-V AIA specification can be found at
> > + https://github.com/riscv/riscv-aia.
> > +
> > + The RISC-V APLIC is implemented as hierarchical APLIC domains where all
> > + interrupt sources connect to the root domain which can further delegate
> > + interrupts to child domains. We have one device tree node for each APLIC
> > + domain.
> > +
> > +allOf:
> > + - $ref: /schemas/interrupt-controller.yaml#
> > +
> > +properties:
> > + compatible:
> > + items:
> > + - enum:
> > + - vendor,chip-aplic
> > + - const: riscv,aplic
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + interrupt-controller: true
> > +
> > + "#interrupt-cells":
> > + const: 2
> > +
> > + interrupts-extended:
> > + minItems: 1
> > + maxItems: 16384
> > + description:
> > + The presence of this property implies that given APLIC domain directly
> > + injects external interrupts to a set of RISC-V HARTS (or CPUs). Each
> > + node pointed to should be a riscv,cpu-intc node, which has a riscv node
> > + (i.e. RISC-V HART) as parent.
> > +
> > + msi-parent:
> > + description:
> > + The presence of this property implies that given APLIC domain forwards
> > + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> > + controller (IMSIC). This property should be considered only when the
> > + interrupts-extended property is absent.
> > +
> > + riscv,num-sources:
> > + $ref: "/schemas/types.yaml#/definitions/uint32"
> > + minimum: 1
> > + maximum: 1023
> > + description:
> > + Specifies how many wired interrupts are supported by this APLIC domain.
> > +
> > + riscv,children:
> > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > + minItems: 1
> > + maxItems: 1024
>
> As each entry is a single phandle:
>
> items:
> maxItems: 1
Okay, I will update.
>
> > + description:
> > + This property represents a list of child APLIC domains for the given
> > + APLIC domain. Each child APLIC domain is assigned child index in
> > + increasing order with the first child APLIC domain assigned child
> > + index 0. The APLIC domain child index is used by firmware to delegate
> > + interrupts from the given APLIC domain to a particular child APLIC
> > + domain.
> > +
> > + riscv,delegate:
> > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > + minItems: 1
> > + maxItems: 1024
>
> items:
> items:
> - description: child APLIC domain phandle
> - description: ...
> - description: ...
Okay, I will update.
>
> > + description:
> > + This property represents a interrupt delegation list where each entry
> > + is a triple consisting of child APLIC domain phandle, first interrupt
> > + number, and last interrupt number. The firmware will configure interrupt
> > + delegation registers based on interrupt delegation list.
>
> First and last are inclusive?
Yes, first and last are inclusive. I will clarify this in the description.
>
> Couldn't riscv,children and riscv,delegate be combined? How would they
> be different? If some children don't have any delegated interrupts, you
> could use -1 for the cells for example.
The "riscv,children" describes the hierarchy of APLIC domains in HW
whereas "riscv,delegate" describes the system choices of delegating
interrupts from a parent APLIC domain to one of its children. I feel
it's not natural to combine these two properties.
>
> An example showing the need would be nice.
>
> > +
> > +additionalProperties: false
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - interrupt-controller
> > + - "#interrupt-cells"
> > + - riscv,num-sources
> > +
> > +examples:
> > + - |
> > + // Example 1 (APIC domain directly injecting interrupt to HARTs):
>
> Is than an x86 APIC or a typo?
>
> > +
> > + aplic0: interrupt-controller@c000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + interrupts-extended = <&cpu1_intc 11>,
> > + <&cpu2_intc 11>,
> > + <&cpu3_intc 11>,
> > + <&cpu4_intc 11>;
> > + reg = <0xc000000 0x4080>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + riscv,children = <&aplic1>;
> > + riscv,delegate = <&aplic1 1 63>;
> > + };
> > +
> > + aplic1: interrupt-controller@d000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + interrupts-extended = <&cpu1_intc 9>,
> > + <&cpu2_intc 9>,
> > + <&cpu3_intc 9>,
> > + <&cpu4_intc 9>;
> > + reg = <0xd000000 0x4080>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + };
> > +
> > + - |
> > + // Example 2 (APIC domain forwarding interrupts as MSIs):
> > +
> > + interrupt-controller@d000000 {
> > + compatible = "vendor,chip-aplic", "riscv,aplic";
> > + msi-parent = <&imsics>;
> > + reg = <0xd000000 0x4000>;
> > + interrupt-controller;
> > + #interrupt-cells = <2>;
> > + riscv,num-sources = <63>;
> > + };
> > +...
> > --
> > 2.34.1
> >
> >
Regards,
Anup
On Mon, Jan 02, 2023 at 10:20:48PM +0530, Anup Patel wrote:
> On Sun, Nov 13, 2022 at 9:14 PM Conor Dooley <[email protected]> wrote:
> > > + domain.
> > > +
> > > +allOf:
> > > + - $ref: /schemas/interrupt-controller.yaml#
> > > +
> > > +properties:
> > > + compatible:
> > > + items:
> > > + - enum:
> > > + - vendor,chip-aplic
> >
> > Same comment here about the validity of this placeholder.
>
> Okay, I will add "riscv,qemu-aplic" as QEMU specific compatible string.
Ah neat. I think that's a fair compromise.
> > > + - const: riscv,aplic
> > > + msi-parent:
> > > + description:
> > > + The presence of this property implies that given APLIC domain forwards
> > > + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> > > + controller (IMSIC). This property should be considered only when the
> > > + interrupts-extended property is absent.
> >
> > This mutual exclusion can be represented, can't it?
> > IIRC it is some sort of oneOf thing, somewhat like below:
> > oneOf:
> > - required:
> > - msi-parent
> > - required:
> > - interrupts-extended
> >
> > AFAIR from doing the i2c ocores binding, this will force the addition of
> > one, but not both, to a node.
> >
> > Or is this not actually mutually exclusive & the msi-parent property is
> > permitted but just left unused if interrupts-extended is present?
>
> If both are present then interrupts-extended is preferred.
Perhaps I am making a fool of myself here, but why would someone include
both of them at once, if only one is going to be used?
It would appear that making them explicitly mutually exclusive would
make the binding easier to understand.
What am I missing?
> > > + riscv,children:
> > > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > > + minItems: 1
> > > + maxItems: 1024
> > > + description:
> > > + This property represents a list of child APLIC domains for the given
> > > + APLIC domain. Each child APLIC domain is assigned child index in
> > > + increasing order with the first child APLIC domain assigned child
> > > + index 0. The APLIC domain child index is used by firmware to delegate
> > > + interrupts from the given APLIC domain to a particular child APLIC
> > > + domain.
> > > +
> > > + riscv,delegate:
> > > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > > + minItems: 1
> > > + maxItems: 1024
> > > + description:
> > > + This property represents a interrupt delegation list where each entry
> > > + is a triple consisting of child APLIC domain phandle, first interrupt
> > > + number, and last interrupt number. The firmware will configure interrupt
> > > + delegation registers based on interrupt delegation list.
> >
> > What is the inter dependence of the children and delegate?
> > Is it valid to have a delegate property without children?
> > Can the firmware delegate interrupts without the delegation list, based
> > on the children property alone? Or is it effectively useless without a
> > children property?
>
> Both properties convey different information. The "riscv,childen" describes
> the association of child indexes with child APLIC domains whereas the
> "riscv,delegate" describes the interrupt delegation to few of the child
> APLIC domains.
>
>
> >
> > In your examples, the second has msi-parent but neither of these custom
> > properties. Do the children/delegate properties have a meaning in the
> > msi-parent case?
>
> The "riscv,childern" and "riscv,delegate" are only useful when we have
> hierarchy of multiple APLIC domains. The second example only has
> one APLIC domain hence these custom properties are absent.
It'd be great if you could include an example that explains the
difference as, IIRC, both Rob and I both were kinda confused as to how
the properties differ.
Thanks,
Conor.
On Mon, Jan 2, 2023 at 11:48 PM Conor Dooley <[email protected]> wrote:
>
> On Mon, Jan 02, 2023 at 10:20:48PM +0530, Anup Patel wrote:
> > On Sun, Nov 13, 2022 at 9:14 PM Conor Dooley <[email protected]> wrote:
>
> > > > + domain.
> > > > +
> > > > +allOf:
> > > > + - $ref: /schemas/interrupt-controller.yaml#
> > > > +
> > > > +properties:
> > > > + compatible:
> > > > + items:
> > > > + - enum:
> > > > + - vendor,chip-aplic
> > >
> > > Same comment here about the validity of this placeholder.
> >
> > Okay, I will add "riscv,qemu-aplic" as QEMU specific compatible string.
>
> Ah neat. I think that's a fair compromise.
>
> > > > + - const: riscv,aplic
>
> > > > + msi-parent:
> > > > + description:
> > > > + The presence of this property implies that given APLIC domain forwards
> > > > + wired interrupts as MSIs to a AIA incoming message signaled interrupt
> > > > + controller (IMSIC). This property should be considered only when the
> > > > + interrupts-extended property is absent.
> > >
> > > This mutual exclusion can be represented, can't it?
> > > IIRC it is some sort of oneOf thing, somewhat like below:
> > > oneOf:
> > > - required:
> > > - msi-parent
> > > - required:
> > > - interrupts-extended
> > >
> > > AFAIR from doing the i2c ocores binding, this will force the addition of
> > > one, but not both, to a node.
> > >
> > > Or is this not actually mutually exclusive & the msi-parent property is
> > > permitted but just left unused if interrupts-extended is present?
> >
> > If both are present then interrupts-extended is preferred.
>
> Perhaps I am making a fool of myself here, but why would someone include
> both of them at once, if only one is going to be used?
> It would appear that making them explicitly mutually exclusive would
> make the binding easier to understand.
> What am I missing?
If both "interrupts-extended" and "msi-parent" are present then it means
the APLIC domain supports both MSI mode and Direct mode in HW. In this
case, the APLIC driver has to choose between MSI mode or Direct mode.
>
> > > > + riscv,children:
> > > > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > > > + minItems: 1
> > > > + maxItems: 1024
> > > > + description:
> > > > + This property represents a list of child APLIC domains for the given
> > > > + APLIC domain. Each child APLIC domain is assigned child index in
> > > > + increasing order with the first child APLIC domain assigned child
> > > > + index 0. The APLIC domain child index is used by firmware to delegate
> > > > + interrupts from the given APLIC domain to a particular child APLIC
> > > > + domain.
> > > > +
> > > > + riscv,delegate:
> > > > + $ref: '/schemas/types.yaml#/definitions/phandle-array'
> > > > + minItems: 1
> > > > + maxItems: 1024
> > > > + description:
> > > > + This property represents a interrupt delegation list where each entry
> > > > + is a triple consisting of child APLIC domain phandle, first interrupt
> > > > + number, and last interrupt number. The firmware will configure interrupt
> > > > + delegation registers based on interrupt delegation list.
> > >
> > > What is the inter dependence of the children and delegate?
> > > Is it valid to have a delegate property without children?
> > > Can the firmware delegate interrupts without the delegation list, based
> > > on the children property alone? Or is it effectively useless without a
> > > children property?
> >
> > Both properties convey different information. The "riscv,childen" describes
> > the association of child indexes with child APLIC domains whereas the
> > "riscv,delegate" describes the interrupt delegation to few of the child
> > APLIC domains.
> >
> >
> > >
> > > In your examples, the second has msi-parent but neither of these custom
> > > properties. Do the children/delegate properties have a meaning in the
> > > msi-parent case?
> >
> > The "riscv,childern" and "riscv,delegate" are only useful when we have
> > hierarchy of multiple APLIC domains. The second example only has
> > one APLIC domain hence these custom properties are absent.
>
> It'd be great if you could include an example that explains the
> difference as, IIRC, both Rob and I both were kinda confused as to how
> the properties differ.
Okay, I will try to improve the examples.
Regards,
Anup
On 02/01/2023 17:50, Anup Patel wrote:
> On Sun, Nov 13, 2022 at 9:14 PM Conor Dooley <[email protected]> wrote:
>>
>> Hey Anup,
>>
>> Ditto the $subject nit here.
>
> Adding "interrupt-controller:" to subject makes it longer than 80 characters.
Because you added redundant double "bindings". Subject line is precious,
so do not add useless words.
Best regards,
Krzysztof
On Tue, Jan 3, 2023 at 2:29 PM Krzysztof Kozlowski
<[email protected]> wrote:
>
> On 02/01/2023 17:50, Anup Patel wrote:
> > On Sun, Nov 13, 2022 at 9:14 PM Conor Dooley <[email protected]> wrote:
> >>
> >> Hey Anup,
> >>
> >> Ditto the $subject nit here.
> >
> > Adding "interrupt-controller:" to subject makes it longer than 80 characters.
>
> Because you added redundant double "bindings". Subject line is precious,
> so do not add useless words.
Okay, I will update the patch subject based on your suggestion.
Regards,
Anup