Received-SPF: pass (google.com: domain of linux-crypto+bounces-2922-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Date: Tue, 26 Mar 2024 16:41:48 -0500
From: Rob Herring <robh@kernel.org>
To: Conor Dooley <conor@kernel.org>
Cc: Animesh Agarwal <animeshagarwal28@gmail.com>,
	Herbert Xu <herbert@gondor.apana.org.au>,
	"David S. Miller" <davem@davemloft.net>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Conor Dooley <conor+dt@kernel.org>, linux-crypto@vger.kernel.org,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] dt-bindings: crypto: ti,omap-sham: Convert to dtschema
Message-ID: <20240326214148.GA3709211-robh@kernel.org>
References: <20240326120107.13442-1-animeshagarwal28@gmail.com>
 <20240326-spectrum-talon-0fc977c32c5c@spud>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20240326-spectrum-talon-0fc977c32c5c@spud>

On Tue, Mar 26, 2024 at 06:20:05PM +0000, Conor Dooley wrote:
> On Tue, Mar 26, 2024 at 05:31:00PM +0530, Animesh Agarwal wrote:
> > Convert the OMAP SoC SHA crypto Module bindings to DT Schema.
> > 
> > Signed-off-by: Animesh Agarwal <animeshagarwal28@gmail.com>
> > ---
> >  .../devicetree/bindings/crypto/omap-sham.txt  | 28 ----------
> >  .../bindings/crypto/ti,omap-sham.yaml         | 56 +++++++++++++++++++
> >  2 files changed, 56 insertions(+), 28 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/crypto/omap-sham.txt
> >  create mode 100644 Documentation/devicetree/bindings/crypto/ti,omap-sham.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/crypto/omap-sham.txt b/Documentation/devicetree/bindings/crypto/omap-sham.txt
> > deleted file mode 100644
> > index ad9115569611..000000000000
> > --- a/Documentation/devicetree/bindings/crypto/omap-sham.txt
> > +++ /dev/null
> > @@ -1,28 +0,0 @@
> > -OMAP SoC SHA crypto Module
> > -
> > -Required properties:
> > -
> > -- compatible : Should contain entries for this and backward compatible
> > -  SHAM versions:
> > -  - "ti,omap2-sham" for OMAP2 & OMAP3.
> > -  - "ti,omap4-sham" for OMAP4 and AM33XX.
> > -  - "ti,omap5-sham" for OMAP5, DRA7 and AM43XX.
> > -- ti,hwmods: Name of the hwmod associated with the SHAM module
> > -- reg : Offset and length of the register set for the module
> > -- interrupts : the interrupt-specifier for the SHAM module.
> > -
> > -Optional properties:
> > -- dmas: DMA specifiers for the rx dma. See the DMA client binding,
> > -	Documentation/devicetree/bindings/dma/dma.txt
> > -- dma-names: DMA request name. Should be "rx" if a dma is present.
> > -
> > -Example:
> > -	/* AM335x */
> > -	sham: sham@53100000 {
> > -		compatible = "ti,omap4-sham";
> > -		ti,hwmods = "sham";
> > -		reg = <0x53100000 0x200>;
> > -		interrupts = <109>;
> > -		dmas = <&edma 36>;
> > -		dma-names = "rx";
> > -	};
> > diff --git a/Documentation/devicetree/bindings/crypto/ti,omap-sham.yaml b/Documentation/devicetree/bindings/crypto/ti,omap-sham.yaml
> > new file mode 100644
> > index 000000000000..7a2529cc4cae
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/crypto/ti,omap-sham.yaml
> > @@ -0,0 +1,56 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/crypto/ti,omap-sham.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: OMAP SoC SHA crypto Module
> > +
> > +maintainers:
> > +  - Animesh Agarwal <animeshagarwal28@gmail.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - ti,omap2-sham
> > +      - ti,omap4-sham
> > +      - ti,omap5-sham
> > +
> > +  ti,hwmods:
> > +    description: Name of the hwmod associated with the SHAM module
> > +    $ref: /schemas/types.yaml#/definitions/string
> > +    enum: [sham]
> 
> Is there really only one value possible here?
> Also, the convention is to put vendor properties like this after more
> common properties like reg, interrupts etc.
> 
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  dmas:
> > +    maxItems: 1
> > +
> > +  dma-names:
> > +    const: rx
> > +
> > +dependencies:
> > +  dmas: [dma-names]
> 
> Is this needed? Unless I'm sorely mistaken dt-schema enforces this itself
> (and same for any $foo-names).

dtschema does not. It does do the other way around. This seems fine.

Rob