1. Patchew
  2. linux
  3. View series

[PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example

Rob Herring posted 1 patch 3 years, 11 months ago 
Documentation/devicetree/bindings/mtd/mxc-nand.yaml | 2 --
1 file changed, 2 deletions(-)
[PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example
Posted by Rob Herring 3 years, 11 months ago 
With unevaluatedProperties issues fixed, 'nand-bus-width' and
'nand-ecc-mode' are flagged as undocumented. Removing them from the example
is the easiest solution to silence the warnings.

Signed-off-by: Rob Herring <robh@kernel.org>
---
These properties may be deprecated, but they are still widely used in
bindings. They either need to be documented (and marked deprecated) or
removed from current users (i.e. dts files).
---
 Documentation/devicetree/bindings/mtd/mxc-nand.yaml | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
index 73b86f2226c7..66da1b476ab7 100644
--- a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
+++ b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
@@ -37,6 +37,4 @@ examples:
         compatible = "fsl,imx27-nand";
         reg = <0xd8000000 0x1000>;
         interrupts = <29>;
-        nand-bus-width = <8>;
-        nand-ecc-mode = "hw";
     };
-- 
2.34.1
Re: [PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example
Posted by Miquel Raynal 3 years, 10 months ago 
On Wed, 2022-05-25 at 20:59:46 UTC, Rob Herring wrote:
> With unevaluatedProperties issues fixed, 'nand-bus-width' and
> 'nand-ecc-mode' are flagged as undocumented. Removing them from the example
> is the easiest solution to silence the warnings.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next, thanks.

Miquel
Re: [PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example
Posted by Uwe Kleine-König 3 years, 11 months ago 
On Wed, May 25, 2022 at 03:59:46PM -0500, Rob Herring wrote:
> With unevaluatedProperties issues fixed, 'nand-bus-width' and
> 'nand-ecc-mode' are flagged as undocumented. Removing them from the example
> is the easiest solution to silence the warnings.

It's not clear to me, what has to be done to see this warning. Can you
tell me how to reproduce?

My current WIP patch is:

diff --git a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
index 73b86f2226c7..6e3e346e4448 100644
--- a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
+++ b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
@@ -14,7 +14,18 @@ allOf:
 
 properties:
   compatible:
-    const: fsl,imx27-nand
+    oneOf:
+      - const: fsl,imx21-nand
+      - const: fsl,imx25-nand
+      - const: fsl,imx27-nand
+      - items:
+          - const: fsl,imx31-nand
+          - const: fsl,imx27-nand
+      - items:
+          - const: fsl,imx35-nand
+          - const: fsl,imx27-nand
+      - const: fsl,imx51-nand
+      - const: fsl,imx53-nand
 
   reg:
     maxItems: 1

which I think is right, but obviously doesn't fix the problem you
pointed out :-)

> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
> These properties may be deprecated, but they are still widely used in
> bindings. They either need to be documented (and marked deprecated) or
> removed from current users (i.e. dts files).

Or documented and not marked deprecated?

Best regards
Uwe

> diff --git a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> index 73b86f2226c7..66da1b476ab7 100644
> --- a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> +++ b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> @@ -37,6 +37,4 @@ examples:
>          compatible = "fsl,imx27-nand";
>          reg = <0xd8000000 0x1000>;
>          interrupts = <29>;
> -        nand-bus-width = <8>;
> -        nand-ecc-mode = "hw";
>      };

-- 
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |
Re: [PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example
Posted by Marc Kleine-Budde 3 years, 11 months ago 
On 25.05.2022 15:59:46, Rob Herring wrote:
> With unevaluatedProperties issues fixed, 'nand-bus-width' and
> 'nand-ecc-mode' are flagged as undocumented. Removing them from the example
> is the easiest solution to silence the warnings.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>

At least the 'nand-bus-width' property is described in
"nand-controller.yaml" and the "mxc-nand.yaml" refers to it.

| allOf:
|   - $ref: "nand-controller.yaml"

Is this ref broken?

regards,
Marc

> ---
> These properties may be deprecated, but they are still widely used in
> bindings. They either need to be documented (and marked deprecated) or
> removed from current users (i.e. dts files).
> ---
>  Documentation/devicetree/bindings/mtd/mxc-nand.yaml | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> index 73b86f2226c7..66da1b476ab7 100644
> --- a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> +++ b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> @@ -37,6 +37,4 @@ examples:
>          compatible = "fsl,imx27-nand";
>          reg = <0xd8000000 0x1000>;
>          interrupts = <29>;
> -        nand-bus-width = <8>;
> -        nand-ecc-mode = "hw";
>      };
> -- 
> 2.34.1
> 
> 

-- 
Pengutronix e.K.                 | Marc Kleine-Budde           |
Embedded Linux                   | https://www.pengutronix.de  |
Vertretung West/Dortmund         | Phone: +49-231-2826-924     |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-5555 |
Re: [PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example
Posted by Rob Herring 3 years, 11 months ago 
On Fri, May 27, 2022 at 11:38:39AM +0200, Marc Kleine-Budde wrote:
> On 25.05.2022 15:59:46, Rob Herring wrote:
> > With unevaluatedProperties issues fixed, 'nand-bus-width' and
> > 'nand-ecc-mode' are flagged as undocumented. Removing them from the example
> > is the easiest solution to silence the warnings.
> > 
> > Signed-off-by: Rob Herring <robh@kernel.org>
> 
> At least the 'nand-bus-width' property is described in
> "nand-controller.yaml" and the "mxc-nand.yaml" refers to it.
> 
> | allOf:
> |   - $ref: "nand-controller.yaml"
> 
> Is this ref broken?

Nope, read my note below. 'nand-bus-width' is documented as a nand chip 
(child node) property, not a nand controller property.


> regards,
> Marc
> 
> > ---
> > These properties may be deprecated, but they are still widely used in
> > bindings. They either need to be documented (and marked deprecated) or
> > removed from current users (i.e. dts files).


^^^^

> > ---
> >  Documentation/devicetree/bindings/mtd/mxc-nand.yaml | 2 --
> >  1 file changed, 2 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> > index 73b86f2226c7..66da1b476ab7 100644
> > --- a/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> > +++ b/Documentation/devicetree/bindings/mtd/mxc-nand.yaml
> > @@ -37,6 +37,4 @@ examples:
> >          compatible = "fsl,imx27-nand";
> >          reg = <0xd8000000 0x1000>;
> >          interrupts = <29>;
> > -        nand-bus-width = <8>;
> > -        nand-ecc-mode = "hw";
> >      };
> > -- 
> > 2.34.1
> > 
> > 
> 
> -- 
> Pengutronix e.K.                 | Marc Kleine-Budde           |
> Embedded Linux                   | https://www.pengutronix.de  |
> Vertretung West/Dortmund         | Phone: +49-231-2826-924     |
> Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-5555 |
Re: [PATCH] dt-bindings: mtd: mxc-nand: Drop undocumented properties from example
Posted by Miquel Raynal 3 years, 11 months ago 
Hi Rob, Marc,

robh@kernel.org wrote on Tue, 31 May 2022 10:05:15 -0500:

> On Fri, May 27, 2022 at 11:38:39AM +0200, Marc Kleine-Budde wrote:
> > On 25.05.2022 15:59:46, Rob Herring wrote:  
> > > With unevaluatedProperties issues fixed, 'nand-bus-width' and
> > > 'nand-ecc-mode' are flagged as undocumented. Removing them from the example
> > > is the easiest solution to silence the warnings.
> > > 
> > > Signed-off-by: Rob Herring <robh@kernel.org>  
> > 
> > At least the 'nand-bus-width' property is described in
> > "nand-controller.yaml" and the "mxc-nand.yaml" refers to it.
> > 
> > | allOf:
> > |   - $ref: "nand-controller.yaml"
> > 
> > Is this ref broken?  
> 
> Nope, read my note below. 'nand-bus-width' is documented as a nand chip 
> (child node) property, not a nand controller property.
> 
> 
> > regards,
> > Marc
> >   
> > > ---
> > > These properties may be deprecated, but they are still widely used in
> > > bindings. They either need to be documented (and marked deprecated) or
> > > removed from current users (i.e. dts files).  

I don't mind keeping them undocumented to encourage people to migrate
to a better description. For the record, in the past controllers and
devices where not separated in the description, hence we had NAND chip
specific properties landing in to the NAND controller description.

So I'm fine with the current approach.

Thanks,
Miquèl

Patchew 2.1-devel-ea86937

© 2016 - 2026 Red Hat, Inc.