Skip to contentSkip to conversation

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

PATCH Applied Rob Herring 4 participants 6 messages May 25, 2022 – Jun 9, 2022

Subsystems (3)
Device tree bindings Arm i.MX and Layerscape Memory technology devices (MTD)
lore
Share & tools
lore

Rob Herring

author maintainer
#0 lore raw

PATCH 1/1 dt-bindings: mtd: mxc-nand: Drop undocumented properties from example

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 <[email protected]>

---
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(-)
Documentation/devicetree/bindings/mtd/mxc-nand.yaml +0 -2
index 73b86f2226c7..66da1b476ab7 100644
@@ -37,6 +37,4 @@ examples:
         compatible = "fsl,imx27-nand";
         reg = <0xd8000000 0x1000>;
         interrupts = <29>;
-        nand-bus-width = <8>;
-        nand-ecc-mode = "hw";
     };
Signature · 1 line
2.34.1
#1 lore raw
Quoted 5 lines · Rob Herring

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 <[email protected]>

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

Quoted 23 lines

---
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(-)
Documentation/devicetree/bindings/mtd/mxc-nand.yaml +0 -2
index 73b86f2226c7..66da1b476ab7 100644
@@ -37,6 +37,4 @@ examples:
         compatible = "fsl,imx27-nand";
         reg = <0xd8000000 0x1000>;
         interrupts = <29>;
-        nand-bus-width = <8>;
-        nand-ecc-mode = "hw";
     };
Signature · 1 line
2.34.1
Signature · 4 lines
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 |
author maintainer
#2 lore raw
Quoted 7 lines · Marc Kleine-Budde
Quoted 5 lines · Rob Herring

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 <[email protected]>
Quoted 7 lines

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.

Quoted 7 lines

regards,
Marc

Quoted 4 lines

---
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).

^^^^

Quoted 25 lines
Quoted 19 lines
---
 Documentation/devicetree/bindings/mtd/mxc-nand.yaml | 2 --
 1 file changed, 2 deletions(-)
Documentation/devicetree/bindings/mtd/mxc-nand.yaml +0 -2
index 73b86f2226c7..66da1b476ab7 100644
@@ -37,6 +37,4 @@ examples:
         compatible = "fsl,imx27-nand";
         reg = <0xd8000000 0x1000>;
         interrupts = <29>;
-        nand-bus-width = <8>;
-        nand-ecc-mode = "hw";
     };
Signature · 1 line
2.34.1
Signature · 4 lines
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 |
maintainer
#3 lore raw

Hi Rob, Marc,

[email protected] wrote on Tue, 31 May 2022 10:05:15 -0500:

Quoted 11 lines · Marc Kleine-Budde
Quoted 10 lines · Rob Herring
Quoted 5 lines

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 <[email protected]>

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

Quoted 16 lines
Quoted 4 lines

| 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.

Quoted 7 lines

regards,
Marc

Quoted 4 lines

---
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

#4 lore raw
In reply to Rob Herring
Quoted 3 lines · Rob Herring

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:

Documentation/devicetree/bindings/mtd/mxc-nand.yaml +12 -1
index 73b86f2226c7..6e3e346e4448 100644
@@ -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 :-)

Quoted 5 lines
Signed-off-by Rob Herring <[email protected]>

---
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

Quoted 11 lines
Documentation/devicetree/bindings/mtd/mxc-nand.yaml +0 -2
index 73b86f2226c7..66da1b476ab7 100644
@@ -37,6 +37,4 @@ examples:
         compatible = "fsl,imx27-nand";
         reg = <0xd8000000 0x1000>;
         interrupts = <29>;
-        nand-bus-width = <8>;
-        nand-ecc-mode = "hw";
     };
Signature · 2 lines
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |
maintainer Applied
#5 lore raw
In reply to Rob Herring
Quoted 5 lines · Rob Herring

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 <[email protected]>

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

Miquel

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/