Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Sun, 24 Jul 2022 12:01:28 +0100
Message-ID: <8735eqdbav.wl-maz@kernel.org>
From:   Marc Zyngier <maz@kernel.org>
To:     Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
Cc:     Geert Uytterhoeven <geert+renesas@glider.be>,
        Thomas Gleixner <tglx@linutronix.de>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Magnus Damm <magnus.damm@gmail.com>,
        linux-renesas-soc@vger.kernel.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Prabhakar <prabhakar.csengg@gmail.com>,
        Biju Das <biju.das.jz@bp.renesas.com>
Subject: Re: [PATCH v3 2/3] dt-bindings: interrupt-controller: renesas,rzg2l-irqc: Update description for '#interrupt-cells' property
In-Reply-To: <20220722151155.21100-3-prabhakar.mahadev-lad.rj@bp.renesas.com>
References: <20220722151155.21100-1-prabhakar.mahadev-lad.rj@bp.renesas.com>
        <20220722151155.21100-3-prabhakar.mahadev-lad.rj@bp.renesas.com>
User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI-EPG/1.14.7 (Harue)
 FLIM-LB/1.14.9 (=?UTF-8?B?R29qxY0=?=) APEL-LB/10.8 EasyPG/1.0.0 Emacs/27.1
 (x86_64-pc-linux-gnu) MULE/6.0 (HANACHIRUSATO)
MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue")
Content-Type: text/plain; charset=US-ASCII
Precedence: bulk

On Fri, 22 Jul 2022 16:11:54 +0100,
Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com> wrote:
> 
> Update description for '#interrupt-cells' property to utilize the
> RZG2L_{NMI,IRQX} for the first cell defined in the
> include/dt-bindings/interrupt-controller/irqc-rzg2l.h file.
> 
> Signed-off-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
> ---
> v3:
> * New patch
> ---
>  .../bindings/interrupt-controller/renesas,rzg2l-irqc.yaml    | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/renesas,rzg2l-irqc.yaml b/Documentation/devicetree/bindings/interrupt-controller/renesas,rzg2l-irqc.yaml
> index 33b90e975e33..ea7db3618b23 100644
> --- a/Documentation/devicetree/bindings/interrupt-controller/renesas,rzg2l-irqc.yaml
> +++ b/Documentation/devicetree/bindings/interrupt-controller/renesas,rzg2l-irqc.yaml
> @@ -31,8 +31,9 @@ properties:
>        - const: renesas,rzg2l-irqc
>  
>    '#interrupt-cells':
> -    description: The first cell should contain external interrupt number (IRQ0-7) and the
> -                 second cell is used to specify the flag.
> +    description: The first cell should contain a macro RZG2L_{NMI,IRQX} included in the
> +                 include/dt-bindings/interrupt-controller/irqc-rzg2l.h and the second
> +                 cell is used to specify the flag.

I think a binding should be self describing, and not rely on an opaque
macro. Mentioning that there is a macro that encodes it is fine, but
the values are what matter, specially when considering that other OSs
could (and should be able to) write their own DTs from scratch without
depending on something that is very much Linux-specific.

Thanks,

	M.

-- 
Without deviation from the norm, progress is not possible.