dt-bindings: interrupt-controller: Convert Atmel AIC to json-schema
PATCH v3 1/1 dt-bindings: interrupt-controller: Convert Atmel AIC to json-schema
Convert the Atmel AIC binding document to DT schema format using json-schema.
Signed-off-by Dharma Balasubiramani <[email protected]>
Reviewed-by Conor Dooley <[email protected]>
---
Changelog
v2 -> v3
- Add constraints to the "atmel,external-irqs" property.
- Move 'reg' before 'interrupt-controller' in the example.
v1 -> v2
- Drop the '|' as there is no formatting to preserve.
- Remove unnecessary marketing statement from description.
- Drop the description for interrupts and reg, it's obvious.
- Put reg after compatible.
- Drop comment in example.
- Drop the example of device that is wired to an AIC as it's(dma) binding is not yet available.
--- .../interrupt-controller/atmel,aic.txt | 43 --------- .../interrupt-controller/atmel,aic.yaml | 89 +++++++++++++++++++ 2 files changed, 89 insertions(+), 43 deletions(-) delete mode 100644 Documentation/devicetree/bindings/interrupt-controller/atmel,aic.txt create mode 100644 Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.txt deleted +0 -43
@@ -1,43 +0,0 @@ -* Advanced Interrupt Controller (AIC) - -Required properties: -- compatible: Should be: - - "atmel,<chip>-aic" where <chip> can be "at91rm9200", "sama5d2", - "sama5d3" or "sama5d4" - - "microchip,<chip>-aic" where <chip> can be "sam9x60" - -- interrupt-controller: Identifies the node as an interrupt controller. -- #interrupt-cells: The number of cells to define the interrupts. It should be 3. - The first cell is the IRQ number (aka "Peripheral IDentifier" on datasheet). - The second cell is used to specify flags: - bits[3:0] trigger type and level flags: - 1 = low-to-high edge triggered. - 2 = high-to-low edge triggered. - 4 = active high level-sensitive. - 8 = active low level-sensitive. - Valid combinations are 1, 2, 3, 4, 8. - Default flag for internal sources should be set to 4 (active high). - The third cell is used to specify the irq priority from 0 (lowest) to 7 - (highest). -- reg: Should contain AIC registers location and length -- atmel,external-irqs: u32 array of external irqs. - -Examples: - /* - * AIC - */ - aic: interrupt-controller@fffff000 { - compatible = "atmel,at91rm9200-aic"; - interrupt-controller; - #interrupt-cells = <3>; - reg = <0xfffff000 0x200>; - }; - - /* - * An interrupt generating device that is wired to an AIC. - */ - dma: dma-controller@ffffec00 { - compatible = "atmel,at91sam9g45-dma"; - reg = <0xffffec00 0x200>; - interrupts = <21 4 5>; - };
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +89 -0
89 lines not on this page · raw message
base-commit: 4f5e5092fdbf5cec6bedc19fbe69cce4f5f08372
Signature · 1 line
2.25.1
Quoted 31 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +24
-0@@ -0,0 +1,89 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/interrupt-controller/atmel,aic.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Advanced Interrupt Controller (AIC) + +maintainers: + - Nicolas Ferre <[email protected]> + - Dharma balasubiramani <[email protected]> + +description: + The Advanced Interrupt Controller (AIC) is an 8-level priority, individually + maskable, vectored interrupt controller providing handling of up to one + hundred and twenty-eight interrupt sources. + +allOf: + - $ref: /schemas/interrupt-controller.yaml# + - if: + properties: + compatible: + contains: + const: atmel,at91rm9200-aic
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml line 34
Quoted 10 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +10
-0+ then: + properties: + atmel,external-irqs: + minItems: 1 + maxItems: 7 + else: + properties: + atmel,external-irqs: + minItems: 1 + maxItems: 1
When there's property restrictions being applied, move the allof down to...
Quoted 25 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +25
-0+ +properties: + compatible: + enum: + - atmel,at91rm9200-aic + - atmel,sama5d2-aic + - atmel,sama5d3-aic + - atmel,sama5d4-aic + - microchip,sam9x60-aic + + reg: + maxItems: 1 + + interrupt-controller: true + + "#interrupt-cells": + const: 3 + description: | + The 1st cell is the IRQ number (Peripheral IDentifier on datasheet). + The 2nd cell specifies flags: + bits[3:0] trigger type and level flags: + 1 = low-to-high edge triggered. + 2 = high-to-low edge triggered. + 4 = active high level-sensitive. + 8 = active low level-sensitive.
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml line 69
Quoted 10 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +10
-0+ Valid combinations: 1, 2, 3, 4, 8. + Default for internal sources: 4 (active high). + The 3rd cell specifies irq priority from 0 (lowest) to 7 (highest). + + interrupts: + maxItems: 1 + + atmel,external-irqs: + $ref: /schemas/types.yaml#/definitions/uint32-array + description: u32 array of external irqs.
...here. Both work, but seeing the restrictions before you see any of the properties is not the most understandable.
Cheers,
Conor.
Quoted 24 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +19
-0+required: + - compatible + - reg + - interrupt-controller + - "#interrupt-cells" + - atmel,external-irqs + +unevaluatedProperties: false + +examples: + - | + interrupt-controller@fffff000 { + compatible = "atmel,at91rm9200-aic"; + reg = <0xfffff000 0x200>; + interrupt-controller; + #interrupt-cells = <3>; + atmel,external-irqs = <31>; + }; +...base-commit:
4f5e5092fdbf5cec6bedc19fbe69cce4f5f08372Signature · 1 line
2.25.1
Quoted 72 lines · Conor Dooley
Quoted 30 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +24
-0@@ -0,0 +1,89 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id:http://devicetree.org/schemas/interrupt-controller/atmel,aic.yaml# +$schema:http://devicetree.org/meta-schemas/core.yaml# + +title: Advanced Interrupt Controller (AIC) + +maintainers: + - Nicolas Ferre<[email protected]> + - Dharma balasubiramani<[email protected]> + +description: + The Advanced Interrupt Controller (AIC) is an 8-level priority, individually + maskable, vectored interrupt controller providing handling of up to one + hundred and twenty-eight interrupt sources. + +allOf: + - $ref: /schemas/interrupt-controller.yaml# + - if: + properties: + compatible: + contains: + const: atmel,at91rm9200-aicDocumentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml line 34
Quoted 10 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +10
-0+ then: + properties: + atmel,external-irqs: + minItems: 1 + maxItems: 7 + else: + properties: + atmel,external-irqs: + minItems: 1 + maxItems: 1When there's property restrictions being applied, move the allof down to...
Quoted 29 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +29
-0+ +properties: + compatible: + enum: + - atmel,at91rm9200-aic + - atmel,sama5d2-aic + - atmel,sama5d3-aic + - atmel,sama5d4-aic + - microchip,sam9x60-aic + + reg: + maxItems: 1 + + interrupt-controller: true + + "#interrupt-cells": + const: 3 + description: | + The 1st cell is the IRQ number (Peripheral IDentifier on datasheet). + The 2nd cell specifies flags: + bits[3:0] trigger type and level flags: + 1 = low-to-high edge triggered. + 2 = high-to-low edge triggered. + 4 = active high level-sensitive. + 8 = active low level-sensitive. + Valid combinations: 1, 2, 3, 4, 8. + Default for internal sources: 4 (active high). + The 3rd cell specifies irq priority from 0 (lowest) to 7 (highest). +
Quoted 8 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml line 69
Quoted 6 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +6
-0+ interrupts: + maxItems: 1 + + atmel,external-irqs: + $ref: /schemas/types.yaml#/definitions/uint32-array + description: u32 array of external irqs....here. Both work, but seeing the restrictions before you see any of the properties is not the most understandable.
Understood, I will move it here.
Quoted 27 lines
Cheers,
Conor.Quoted 23 lines
Documentation/devicetree/bindings/interrupt-controller/atmel,aic.yaml new file +19
-0+required: + - compatible + - reg + - interrupt-controller + - "#interrupt-cells" + - atmel,external-irqs + +unevaluatedProperties: false + +examples: + - | + interrupt-controller@fffff000 { + compatible = "atmel,at91rm9200-aic"; + reg = <0xfffff000 0x200>; + interrupt-controller; + #interrupt-cells = <3>; + atmel,external-irqs = <31>; + }; +...base-commit:
4f5e5092fdbf5cec6bedc19fbe69cce4f5f08372Signature · 1 line
2.25.1
Signature · 2 lines
With Best Regards, Dharma B.