[PATCH] dt-bindings: dma: ti: Add missing ti,k3-sci-common.yaml reference

[PATCH] dt-bindings: dma: ti: Add missing ti,k3-sci-common.yaml reference

[Rob Herring]

The TI k3-bcdma and k3-pktdma both use 'ti,sci' and 'ti,sci-dev-id'
properties defined in ti,k3-sci-common.yaml. When 'unevaluatedProperties'
support is enabled, a the follow warning is generated:

Documentation/devicetree/bindings/dma/ti/k3-bcdma.example.dt.yaml: dma-controller@485c0100: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
Documentation/devicetree/bindings/dma/ti/k3-pktdma.example.dt.yaml: dma-controller@485c0000: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)

Add a reference to ti,k3-sci-common.yaml to fix this.

Cc: Peter Ujfalusi <peter.ujfalusi@gmail.com>
Cc: Vinod Koul <vkoul@kernel.org>
Cc: dmaengine@vger.kernel.org
Signed-off-by: Rob Herring <robh@kernel.org>
---
 Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml  | 1 +
 Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml | 1 +
 2 files changed, 2 insertions(+)

diff --git a/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml b/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
index df29d59d13a8..08627d91e607 100644
--- a/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
+++ b/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
@@ -30,6 +30,7 @@ description: |
 
 allOf:
   - $ref: /schemas/dma/dma-controller.yaml#
+  - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml#
 
 properties:
   compatible:
diff --git a/Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml b/Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml
index ea19d12a9337..507d16d84ade 100644
--- a/Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml
+++ b/Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml
@@ -25,6 +25,7 @@ description: |
 
 allOf:
   - $ref: /schemas/dma/dma-controller.yaml#
+  - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml#
 
 properties:
   compatible:
-- 
2.32.0

Re: [PATCH] dt-bindings: dma: ti: Add missing ti,k3-sci-common.yaml reference

[Thierry Reding]

[-- Attachment #1: Type: text/plain, Size: 1907 bytes --]

On Mon, Dec 06, 2021 at 11:42:26AM -0600, Rob Herring wrote:
> The TI k3-bcdma and k3-pktdma both use 'ti,sci' and 'ti,sci-dev-id'
> properties defined in ti,k3-sci-common.yaml. When 'unevaluatedProperties'
> support is enabled, a the follow warning is generated:

s/a the following/the following/

Otherwise looks good:

Reviewed-by: Thierry Reding <treding@nvidia.com>

One question below...

> 
> Documentation/devicetree/bindings/dma/ti/k3-bcdma.example.dt.yaml: dma-controller@485c0100: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
> Documentation/devicetree/bindings/dma/ti/k3-pktdma.example.dt.yaml: dma-controller@485c0000: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
> 
> Add a reference to ti,k3-sci-common.yaml to fix this.
> 
> Cc: Peter Ujfalusi <peter.ujfalusi@gmail.com>
> Cc: Vinod Koul <vkoul@kernel.org>
> Cc: dmaengine@vger.kernel.org
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml  | 1 +
>  Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml | 1 +
>  2 files changed, 2 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml b/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
> index df29d59d13a8..08627d91e607 100644
> --- a/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
> +++ b/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
> @@ -30,6 +30,7 @@ description: |
>  
>  allOf:
>    - $ref: /schemas/dma/dma-controller.yaml#
> +  - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml#

Out of curiosity: is the # at the end necessary, or do you just use it
as a convention? I've seen a mix of both and there also seems to be a
healthy mix of quoted and unquoted paths. Do we want to settle on one
going forward or do we not care enough?

Thierry

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] dt-bindings: dma: ti: Add missing ti,k3-sci-common.yaml reference

[Rob Herring]

On Tue, Dec 7, 2021 at 2:40 AM Thierry Reding <thierry.reding@gmail.com> wrote:
>
> On Mon, Dec 06, 2021 at 11:42:26AM -0600, Rob Herring wrote:
> > The TI k3-bcdma and k3-pktdma both use 'ti,sci' and 'ti,sci-dev-id'
> > properties defined in ti,k3-sci-common.yaml. When 'unevaluatedProperties'
> > support is enabled, a the follow warning is generated:
>
> s/a the following/the following/
>
> Otherwise looks good:
>
> Reviewed-by: Thierry Reding <treding@nvidia.com>

Thanks.

>
> One question below...
>
> >
> > Documentation/devicetree/bindings/dma/ti/k3-bcdma.example.dt.yaml: dma-controller@485c0100: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
> > Documentation/devicetree/bindings/dma/ti/k3-pktdma.example.dt.yaml: dma-controller@485c0000: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
> >
> > Add a reference to ti,k3-sci-common.yaml to fix this.
> >
> > Cc: Peter Ujfalusi <peter.ujfalusi@gmail.com>
> > Cc: Vinod Koul <vkoul@kernel.org>
> > Cc: dmaengine@vger.kernel.org
> > Signed-off-by: Rob Herring <robh@kernel.org>
> > ---
> >  Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml  | 1 +
> >  Documentation/devicetree/bindings/dma/ti/k3-pktdma.yaml | 1 +
> >  2 files changed, 2 insertions(+)
> >
> > diff --git a/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml b/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
> > index df29d59d13a8..08627d91e607 100644
> > --- a/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
> > +++ b/Documentation/devicetree/bindings/dma/ti/k3-bcdma.yaml
> > @@ -30,6 +30,7 @@ description: |
> >
> >  allOf:
> >    - $ref: /schemas/dma/dma-controller.yaml#
> > +  - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml#
>
> Out of curiosity: is the # at the end necessary, or do you just use it
> as a convention?

It is at least convention. The jsonschema module doesn't require it,
but not sure what the spec says.

> I've seen a mix of both and there also seems to be a
> healthy mix of quoted and unquoted paths. Do we want to settle on one
> going forward or do we not care enough?

I don't really want to dictate one way if it can't automatically be
checked. The '#' could be checked easily, but quoting is harder. There
is some tool support for checking quotes actually, but you have to
enable the yaml round trip loader which is noticeably slower. yamllint
might be the better place to add it though getting yaml quoting rules
right in the general case is a bit harder. Also, to enforce it, I have
to first go fix all the existing cases.

Rob

Re: [PATCH] dt-bindings: dma: ti: Add missing ti,k3-sci-common.yaml reference

[Vinod Koul]

On 07-12-21, 09:40, Thierry Reding wrote:
> On Mon, Dec 06, 2021 at 11:42:26AM -0600, Rob Herring wrote:
> > The TI k3-bcdma and k3-pktdma both use 'ti,sci' and 'ti,sci-dev-id'
> > properties defined in ti,k3-sci-common.yaml. When 'unevaluatedProperties'
> > support is enabled, a the follow warning is generated:
> 
> s/a the following/the following/
> 
> Otherwise looks good:

Fixed up while applying..



-- 
~Vinod

Re: [PATCH] dt-bindings: dma: ti: Add missing ti,k3-sci-common.yaml reference

[Vinod Koul]

On 06-12-21, 11:42, Rob Herring wrote:
> The TI k3-bcdma and k3-pktdma both use 'ti,sci' and 'ti,sci-dev-id'
> properties defined in ti,k3-sci-common.yaml. When 'unevaluatedProperties'
> support is enabled, a the follow warning is generated:
> 
> Documentation/devicetree/bindings/dma/ti/k3-bcdma.example.dt.yaml: dma-controller@485c0100: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
> Documentation/devicetree/bindings/dma/ti/k3-pktdma.example.dt.yaml: dma-controller@485c0000: Unevaluated properties are not allowed ('ti,sci', 'ti,sci-dev-id' were unexpected)
> 
> Add a reference to ti,k3-sci-common.yaml to fix this.

Applied, thanks

-- 
~Vinod