Re: [PATCH 23/28] dt-bindings: interrupt-controller: Convert mrvl,intc to json-schema

[Lubomir Rintel]

On Fri, Mar 27, 2020 at 01:42:07PM -0600, Rob Herring wrote:
> On Tue, Mar 17, 2020 at 10:39:17AM +0100, Lubomir Rintel wrote:
> > Convert the mrvl,intc binding to DT schema format using json-schema.
> > 
> > Signed-off-by: Lubomir Rintel <lkundrak@xxxxx>
> > ---
> >  .../interrupt-controller/mrvl,intc.txt        |  64 --------
> >  .../interrupt-controller/mrvl,intc.yaml       | 144 ++++++++++++++++++
> >  2 files changed, 144 insertions(+), 64 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.txt
> >  create mode 100644 Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.txt b/Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.txt
> > deleted file mode 100644
> > index a0ed02725a9d7..0000000000000
> > --- a/Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.txt
> > +++ /dev/null
> > @@ -1,64 +0,0 @@
> > -* Marvell MMP Interrupt controller
> > -
> > -Required properties:
> > -- compatible : Should be
> > -               "mrvl,mmp-intc" on Marvel MMP,
> > -               "mrvl,mmp2-intc" along with "mrvl,mmp2-mux-intc" on MMP2 or
> > -               "marvell,mmp3-intc" with "mrvl,mmp2-mux-intc" on MMP3
> > -- reg : Address and length of the register set of the interrupt controller.
> > -  If the interrupt controller is intc, address and length means the range
> > -  of the whole interrupt controller. The "marvell,mmp3-intc" controller
> > -  also has a secondary range for the second CPU core.  If the interrupt
> > -  controller is mux-intc, address and length means one register. Since
> > -  address of mux-intc is in the range of intc. mux-intc is secondary
> > -  interrupt controller.
> > -- reg-names : Name of the register set of the interrupt controller. It's
> > -  only required in mux-intc interrupt controller.
> > -- interrupts : Should be the port interrupt shared by mux interrupts. It's
> > -  only required in mux-intc interrupt controller.
> > -- interrupt-controller : Identifies the node as an interrupt controller.
> > -- #interrupt-cells : Specifies the number of cells needed to encode an
> > -  interrupt source.
> > -- mrvl,intc-nr-irqs : Specifies the number of interrupts in the interrupt
> > -  controller.
> > -- mrvl,clr-mfp-irq : Specifies the interrupt that needs to clear MFP edge
> > -  detection first.
> > -
> > -Example:
> > -	intc: interrupt-controller@d4282000 {
> > -		compatible = "mrvl,mmp2-intc";
> > -		interrupt-controller;
> > -		#interrupt-cells = <1>;
> > -		reg = <0xd4282000 0x1000>;
> > -		mrvl,intc-nr-irqs = <64>;
> > -	};
> > -
> > -	intcmux4@d4282150 {
> > -		compatible = "mrvl,mmp2-mux-intc";
> > -		interrupts = <4>;
> > -		interrupt-controller;
> > -		#interrupt-cells = <1>;
> > -		reg = <0x150 0x4>, <0x168 0x4>;
> > -		reg-names = "mux status", "mux mask";
> > -		mrvl,intc-nr-irqs = <2>;
> > -	};
> > -
> > -* Marvell Orion Interrupt controller
> > -
> > -Required properties
> > -- compatible :  Should be "marvell,orion-intc".
> > -- #interrupt-cells: Specifies the number of cells needed to encode an
> > -  interrupt source. Supported value is <1>.
> > -- interrupt-controller : Declare this node to be an interrupt controller.
> > -- reg : Interrupt mask address. A list of 4 byte ranges, one per controller.
> > -        One entry in the list represents 32 interrupts.
> > -
> > -Example:
> > -
> > -	intc: interrupt-controller {
> > -        	compatible = "marvell,orion-intc", "marvell,intc";
> > -		interrupt-controller;
> > -		#interrupt-cells = <1>;
> > -                reg = <0xfed20204 0x04>,
> > -		      <0xfed20214 0x04>;
> > -        };
> > diff --git a/Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.yaml b/Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.yaml
> > new file mode 100644
> > index 0000000000000..f0644f7d7e1d2
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/interrupt-controller/mrvl,intc.yaml
> > @@ -0,0 +1,144 @@
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/interrupt-controller/mrvl,intc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Marvell MMP/Orion Interrupt controller bindings
> > +
> > +maintainers:
> > +  - devicetree@xxxxxxxxxxxxxxx
> > +
> > +allOf:
> > +  - $ref: /schemas/interrupt-controller.yaml#
> 
> Drop this. It is already applied based on matching on the node name.
> 
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          not:
> > +            contains:
> > +              const: marvell,orion-intc
> > +    then:
> > +      required:
> > +        - mrvl,intc-nr-irqs
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            enum:
> > +              - mrvl,mmp-intc
> > +              - mrvl,mmp2-intc
> > +    then:
> > +      properties:
> > +        reg:
> > +          minItems: 1
> > +          maxItems: 1
> 
> Drop minItems, as just 'maxItems: 1' is enough.
> 
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            enum:
> > +              - marvell,mmp3-intc
> > +              - mrvl,mmp2-mux-intc
> > +    then:
> > +      properties:
> > +        reg:
> > +          minItems: 2
> > +          maxItems: 2
> 
> Just 'minItems: 2'.
> 
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            const: marvell,orion-intc
> > +    then:
> > +      properties:
> > +        reg:
> > +          minItems: 1
> > +          maxItems: 2
> 
> Normally, for a compatible this would not vary...
> 
> In any case, move this to the main section and drop this if.
> 
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            const: mrvl,mmp2-mux-intc
> > +    then:
> > +      properties:
> > +        interrupts:
> > +          minItems: 1
> > +          maxItems: 1
> 
> Just 'maxItems'
> 
> > +        reg-names:
> > +          minItems: 2
> > +          maxItems: 2
> 
> These are redundant as 'items' size implies this.
> 
> > +          items:
> > +            - const: 'mux status'
> > +            - const: 'mux mask'
> 
> Move this to the main section.
> 
> > +      required:
> > +        - interrupts
> > +    else:
> > +      properties:
> > +        interrupts: false
> > +
> > +properties:
> > +  '#interrupt-cells':
> > +    const: 1
> > +
> > +  compatible:
> > +    enum:
> > +      - mrvl,mmp-intc
> > +      - mrvl,mmp2-intc
> > +      - marvell,mmp3-intc
> > +      - marvell,orion-intc
> > +      - mrvl,mmp2-mux-intc
> > +
> > +  reg: true
> > +
> > +  reg-names: true
> > +
> > +  interrupts: true
> > +
> > +  interrupt-controller: true
> > +
> > +  mrvl,intc-nr-irqs:
> > +    description: |
> > +      Specifies the number of interrupts in the interrupt controller.
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> 
> Is there a max number?

There's none in the original bindings document or enforced by the
driver.

> > +
> > +  mrvl,clr-mfp-irq:
> > +    description: |
> > +      Specifies the interrupt that needs to clear MFP edge detection first.
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> 
> Constraints?

I don't know how should this be constrained and the original bindings
document is not helpful.

> > +
> > +required:
> > +  - '#interrupt-cells'
> > +  - compatible
> > +  - reg
> > +  - interrupt-controller
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    interrupt-controller@d4282000 {
> > +        compatible = "mrvl,mmp2-intc";
> > +        interrupt-controller;
> > +        #interrupt-cells = <1>;
> > +        reg = <0xd4282000 0x1000>;
> > +        mrvl,intc-nr-irqs = <64>;
> > +    };
> > +
> > +    interrupt-controller@d4282150 {
> > +        compatible = "mrvl,mmp2-mux-intc";
> > +        interrupts = <4>;
> > +        interrupt-controller;
> > +        #interrupt-cells = <1>;
> > +        reg = <0x150 0x4>, <0x168 0x4>;
> > +        reg-names = "mux status", "mux mask";
> > +        mrvl,intc-nr-irqs = <2>;
> > +    };
> > +  - |
> > +    interrupt-controller@fed20204 {
> > +        compatible = "marvell,orion-intc";
> > +        interrupt-controller;
> > +        #interrupt-cells = <1>;
> > +        reg = <0xfed20204 0x04>,
> > +              <0xfed20214 0x04>;
> > +    };
> > +
> > +...
> > -- 
> > 2.25.1
> >