| Message ID | 20200725163700.20583-6-lokeshvutla@ti.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | irqchip: ti, sci-intr/inta: Update the dt bindings to accept different interrupt parents | expand |
On Sat, Jul 25, 2020 at 10:06:55PM +0530, Lokesh Vutla wrote: > In order to automate the verification of DT nodes convert > ti,sci-intr.txt ti,sci-intr.yaml. > > Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com> > --- > .../interrupt-controller/ti,sci-intr.txt | 83 -------------- > .../interrupt-controller/ti,sci-intr.yaml | 102 ++++++++++++++++++ > MAINTAINERS | 2 +- > 3 files changed, 103 insertions(+), 84 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt > create mode 100644 Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml > > diff --git a/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt b/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt > deleted file mode 100644 > index 8b56b2de1c73..000000000000 > --- a/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt > +++ /dev/null > @@ -1,83 +0,0 @@ > -Texas Instruments K3 Interrupt Router > -===================================== > - > -The Interrupt Router (INTR) module provides a mechanism to mux M > -interrupt inputs to N interrupt outputs, where all M inputs are selectable > -to be driven per N output. An Interrupt Router can either handle edge triggered > -or level triggered interrupts and that is fixed in hardware. > - > - Interrupt Router > - +----------------------+ > - | Inputs Outputs | > - +-------+ | +------+ +-----+ | > - | GPIO |----------->| | irq0 | | 0 | | Host IRQ > - +-------+ | +------+ +-----+ | controller > - | . . | +-------+ > - +-------+ | . . |----->| IRQ | > - | INTA |----------->| . . | +-------+ > - +-------+ | . +-----+ | > - | +------+ | N | | > - | | irqM | +-----+ | > - | +------+ | > - | | > - +----------------------+ > - > -There is one register per output (MUXCNTL_N) that controls the selection. > -Configuration of these MUXCNTL_N registers is done by a system controller > -(like the Device Memory and Security Controller on K3 AM654 SoC). System > -controller will keep track of the used and unused registers within the Router. > -Driver should request the system controller to get the range of GIC IRQs > -assigned to the requesting hosts. It is the drivers responsibility to keep > -track of Host IRQs. > - > -Communication between the host processor running an OS and the system > -controller happens through a protocol called TI System Control Interface > -(TISCI protocol). For more details refer: > -Documentation/devicetree/bindings/arm/keystone/ti,sci.txt > - > -TISCI Interrupt Router Node: > ----------------------------- > -Required Properties: > -- compatible: Must be "ti,sci-intr". > -- ti,intr-trigger-type: Should be one of the following: > - 1: If intr supports edge triggered interrupts. > - 4: If intr supports level triggered interrupts. > -- interrupt-controller: Identifies the node as an interrupt controller > -- #interrupt-cells: Specifies the number of cells needed to encode an > - interrupt source. The value should be 1. > - First cell should contain interrupt router input number > - as specified by hardware. > -- ti,sci: Phandle to TI-SCI compatible System controller node. > -- ti,sci-dev-id: TISCI device id of interrupt controller. > -- ti,interrupt-ranges: Set of triplets containing ranges that convert > - the INTR output interrupt numbers to parent's > - interrupt number. Each triplet has following entries: > - - First entry specifies the base for intr output irq > - - Second entry specifies the base for parent irqs > - - Third entry specifies the limit > - > -For more details on TISCI IRQ resource management refer: > -http://downloads.ti.com/tisci/esd/latest/2_tisci_msgs/rm/rm_irq.html > - > -Example: > --------- > -The following example demonstrates both interrupt router node and the consumer > -node(main gpio) on the AM654 SoC: > - > -main_gpio_intr: interrupt-controller0 { > - compatible = "ti,sci-intr"; > - ti,intr-trigger-type = <1>; > - interrupt-controller; > - interrupt-parent = <&gic500>; > - #interrupt-cells = <1>; > - ti,sci = <&dmsc>; > - ti,sci-dev-id = <131>; > - ti,interrupt-ranges = <0 360 32>; > -}; > - > -main_gpio0: gpio@600000 { > - ... > - interrupt-parent = <&main_gpio_intr>; > - interrupts = <192>, <193>, <194>, <195>, <196>, <197>; > - ... > -}; > diff --git a/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml b/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml > new file mode 100644 > index 000000000000..f7a3e51a5212 > --- /dev/null > +++ b/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml > @@ -0,0 +1,102 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/interrupt-controller/ti,sci-intr.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Texas Instruments K3 Interrupt Router > + > +maintainers: > + - Lokesh Vutla <lokeshvutla@ti.com> > + > +allOf: > + - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml# > + > +description: | > + The Interrupt Router (INTR) module provides a mechanism to mux M > + interrupt inputs to N interrupt outputs, where all M inputs are selectable > + to be driven per N output. An Interrupt Router can either handle edge > + triggered or level triggered interrupts and that is fixed in hardware. > + > + Interrupt Router > + +----------------------+ > + | Inputs Outputs | > + +-------+ | +------+ +-----+ | > + | GPIO |----------->| | irq0 | | 0 | | Host IRQ > + +-------+ | +------+ +-----+ | controller > + | . . | +-------+ > + +-------+ | . . |----->| IRQ | > + | INTA |----------->| . . | +-------+ > + +-------+ | . +-----+ | > + | +------+ | N | | > + | | irqM | +-----+ | > + | +------+ | > + | | > + +----------------------+ > + > + There is one register per output (MUXCNTL_N) that controls the selection. > + Configuration of these MUXCNTL_N registers is done by a system controller > + (like the Device Memory and Security Controller on K3 AM654 SoC). System > + controller will keep track of the used and unused registers within the Router. > + Driver should request the system controller to get the range of GIC IRQs > + assigned to the requesting hosts. It is the drivers responsibility to keep > + track of Host IRQs. > + > + Communication between the host processor running an OS and the system > + controller happens through a protocol called TI System Control Interface > + (TISCI protocol). > + > +properties: > + compatible: > + const: ti,sci-intr > + > + ti,intr-trigger-type: > + $ref: /schemas/types.yaml#/definitions/uint32 > + enum: [1, 4] > + description: | > + Should be one of the following. > + 1 = If intr supports edge triggered interrupts. > + 4 = If intr supports level triggered interrupts. > + > + interrupt-controller: true > + > + '#interrupt-cells': > + const: 1 > + description: | > + The 1st cell should contain interrupt router input hw number. > + > + ti,interrupt-ranges: > + $ref: /schemas/types.yaml#/definitions/uint32-matrix > + description: | > + Interrupt ranges that converts the INTR output hw irq numbers > + to parents's input interrupt numbers. > + - items: > + items: > + - description: | > + "output_irq" specifies the base for intr output irq > + - description: | > + "parent's input irq" specifies the base for parent irq > + - description: | > + "limit" specifies the limit for translation While this kind of looks like a schema, it's all just a description. The first 'items' needs to be at the same indentation as 'description'. > + > +required: > + - compatible > + - ti,intr-trigger-type > + - interrupt-controller > + - '#interrupt-cells' > + - ti,sci > + - ti,sci-dev-id > + - ti,interrupt-ranges > + > +examples: > + - | > + main_gpio_intr: interrupt-controller0 { > + compatible = "ti,sci-intr"; > + ti,intr-trigger-type = <1>; > + interrupt-controller; > + interrupt-parent = <&gic500>; > + #interrupt-cells = <1>; > + ti,sci = <&dmsc>; > + ti,sci-dev-id = <131>; > + ti,interrupt-ranges = <0 360 32>; > + }; > diff --git a/MAINTAINERS b/MAINTAINERS > index c76fd456aaba..bc88886c05c6 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -16919,7 +16919,7 @@ F: Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml > F: Documentation/devicetree/bindings/arm/keystone/ti,sci.txt > F: Documentation/devicetree/bindings/clock/ti,sci-clk.txt > F: Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.txt > -F: Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt > +F: Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml > F: Documentation/devicetree/bindings/reset/ti,sci-reset.txt > F: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt > F: drivers/clk/keystone/sci-clk.c > -- > 2.27.0 >
diff --git a/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt b/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt deleted file mode 100644 index 8b56b2de1c73..000000000000 --- a/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt +++ /dev/null @@ -1,83 +0,0 @@ -Texas Instruments K3 Interrupt Router -===================================== - -The Interrupt Router (INTR) module provides a mechanism to mux M -interrupt inputs to N interrupt outputs, where all M inputs are selectable -to be driven per N output. An Interrupt Router can either handle edge triggered -or level triggered interrupts and that is fixed in hardware. - - Interrupt Router - +----------------------+ - | Inputs Outputs | - +-------+ | +------+ +-----+ | - | GPIO |----------->| | irq0 | | 0 | | Host IRQ - +-------+ | +------+ +-----+ | controller - | . . | +-------+ - +-------+ | . . |----->| IRQ | - | INTA |----------->| . . | +-------+ - +-------+ | . +-----+ | - | +------+ | N | | - | | irqM | +-----+ | - | +------+ | - | | - +----------------------+ - -There is one register per output (MUXCNTL_N) that controls the selection. -Configuration of these MUXCNTL_N registers is done by a system controller -(like the Device Memory and Security Controller on K3 AM654 SoC). System -controller will keep track of the used and unused registers within the Router. -Driver should request the system controller to get the range of GIC IRQs -assigned to the requesting hosts. It is the drivers responsibility to keep -track of Host IRQs. - -Communication between the host processor running an OS and the system -controller happens through a protocol called TI System Control Interface -(TISCI protocol). For more details refer: -Documentation/devicetree/bindings/arm/keystone/ti,sci.txt - -TISCI Interrupt Router Node: ----------------------------- -Required Properties: -- compatible: Must be "ti,sci-intr". -- ti,intr-trigger-type: Should be one of the following: - 1: If intr supports edge triggered interrupts. - 4: If intr supports level triggered interrupts. -- interrupt-controller: Identifies the node as an interrupt controller -- #interrupt-cells: Specifies the number of cells needed to encode an - interrupt source. The value should be 1. - First cell should contain interrupt router input number - as specified by hardware. -- ti,sci: Phandle to TI-SCI compatible System controller node. -- ti,sci-dev-id: TISCI device id of interrupt controller. -- ti,interrupt-ranges: Set of triplets containing ranges that convert - the INTR output interrupt numbers to parent's - interrupt number. Each triplet has following entries: - - First entry specifies the base for intr output irq - - Second entry specifies the base for parent irqs - - Third entry specifies the limit - -For more details on TISCI IRQ resource management refer: -http://downloads.ti.com/tisci/esd/latest/2_tisci_msgs/rm/rm_irq.html - -Example: --------- -The following example demonstrates both interrupt router node and the consumer -node(main gpio) on the AM654 SoC: - -main_gpio_intr: interrupt-controller0 { - compatible = "ti,sci-intr"; - ti,intr-trigger-type = <1>; - interrupt-controller; - interrupt-parent = <&gic500>; - #interrupt-cells = <1>; - ti,sci = <&dmsc>; - ti,sci-dev-id = <131>; - ti,interrupt-ranges = <0 360 32>; -}; - -main_gpio0: gpio@600000 { - ... - interrupt-parent = <&main_gpio_intr>; - interrupts = <192>, <193>, <194>, <195>, <196>, <197>; - ... -}; diff --git a/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml b/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml new file mode 100644 index 000000000000..f7a3e51a5212 --- /dev/null +++ b/Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml @@ -0,0 +1,102 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/interrupt-controller/ti,sci-intr.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Texas Instruments K3 Interrupt Router + +maintainers: + - Lokesh Vutla <lokeshvutla@ti.com> + +allOf: + - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml# + +description: | + The Interrupt Router (INTR) module provides a mechanism to mux M + interrupt inputs to N interrupt outputs, where all M inputs are selectable + to be driven per N output. An Interrupt Router can either handle edge + triggered or level triggered interrupts and that is fixed in hardware. + + Interrupt Router + +----------------------+ + | Inputs Outputs | + +-------+ | +------+ +-----+ | + | GPIO |----------->| | irq0 | | 0 | | Host IRQ + +-------+ | +------+ +-----+ | controller + | . . | +-------+ + +-------+ | . . |----->| IRQ | + | INTA |----------->| . . | +-------+ + +-------+ | . +-----+ | + | +------+ | N | | + | | irqM | +-----+ | + | +------+ | + | | + +----------------------+ + + There is one register per output (MUXCNTL_N) that controls the selection. + Configuration of these MUXCNTL_N registers is done by a system controller + (like the Device Memory and Security Controller on K3 AM654 SoC). System + controller will keep track of the used and unused registers within the Router. + Driver should request the system controller to get the range of GIC IRQs + assigned to the requesting hosts. It is the drivers responsibility to keep + track of Host IRQs. + + Communication between the host processor running an OS and the system + controller happens through a protocol called TI System Control Interface + (TISCI protocol). + +properties: + compatible: + const: ti,sci-intr + + ti,intr-trigger-type: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [1, 4] + description: | + Should be one of the following. + 1 = If intr supports edge triggered interrupts. + 4 = If intr supports level triggered interrupts. + + interrupt-controller: true + + '#interrupt-cells': + const: 1 + description: | + The 1st cell should contain interrupt router input hw number. + + ti,interrupt-ranges: + $ref: /schemas/types.yaml#/definitions/uint32-matrix + description: | + Interrupt ranges that converts the INTR output hw irq numbers + to parents's input interrupt numbers. + - items: + items: + - description: | + "output_irq" specifies the base for intr output irq + - description: | + "parent's input irq" specifies the base for parent irq + - description: | + "limit" specifies the limit for translation + +required: + - compatible + - ti,intr-trigger-type + - interrupt-controller + - '#interrupt-cells' + - ti,sci + - ti,sci-dev-id + - ti,interrupt-ranges + +examples: + - | + main_gpio_intr: interrupt-controller0 { + compatible = "ti,sci-intr"; + ti,intr-trigger-type = <1>; + interrupt-controller; + interrupt-parent = <&gic500>; + #interrupt-cells = <1>; + ti,sci = <&dmsc>; + ti,sci-dev-id = <131>; + ti,interrupt-ranges = <0 360 32>; + }; diff --git a/MAINTAINERS b/MAINTAINERS index c76fd456aaba..bc88886c05c6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16919,7 +16919,7 @@ F: Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml F: Documentation/devicetree/bindings/arm/keystone/ti,sci.txt F: Documentation/devicetree/bindings/clock/ti,sci-clk.txt F: Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.txt -F: Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt +F: Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml F: Documentation/devicetree/bindings/reset/ti,sci-reset.txt F: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt F: drivers/clk/keystone/sci-clk.c
In order to automate the verification of DT nodes convert ti,sci-intr.txt ti,sci-intr.yaml. Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com> --- .../interrupt-controller/ti,sci-intr.txt | 83 -------------- .../interrupt-controller/ti,sci-intr.yaml | 102 ++++++++++++++++++ MAINTAINERS | 2 +- 3 files changed, 103 insertions(+), 84 deletions(-) delete mode 100644 Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt create mode 100644 Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml