All of lore.kernel.org
 help / color / mirror / Atom feed
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Mark Brown <broonie@kernel.org>, <linux-spi@vger.kernel.org>,
	Richard Weinberger <richard@nod.at>,
	Vignesh Raghavendra <vigneshr@ti.com>,
	Tudor Ambarus <Tudor.Ambarus@microchip.com>,
	Pratyush Yadav <p.yadav@ti.com>, Michael Walle <michael@walle.cc>,
	<linux-mtd@lists.infradead.org>, Rob Herring <robh+dt@kernel.org>,
	<devicetree@vger.kernel.org>
Cc: Julien Su <juliensu@mxic.com.tw>,
	Jaime Liao <jaimeliao@mxic.com.tw>,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	Miquel Raynal <miquel.raynal@bootlin.com>
Subject: [PATCH v6 03/28] dt-bindings: mtd: nand-controller: Harmonize the property types
Date: Thu, 16 Dec 2021 12:16:29 +0100	[thread overview]
Message-ID: <20211216111654.238086-4-miquel.raynal@bootlin.com> (raw)
In-Reply-To: <20211216111654.238086-1-miquel.raynal@bootlin.com>

Harmonize the different properties in this file by:
* dropping the non-necessary allOf's
* always defining the keywords in the following order:
    - first the "description" (when relevant),
    - then the "type"/"$ref" and the other generic keywords ("enum",
      "default", etc).

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 .../bindings/mtd/nand-controller.yaml         | 26 +++++++++----------
 1 file changed, 12 insertions(+), 14 deletions(-)

diff --git a/Documentation/devicetree/bindings/mtd/nand-controller.yaml b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
index 5cd144a9ec99..a4fa65e872a5 100644
--- a/Documentation/devicetree/bindings/mtd/nand-controller.yaml
+++ b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
@@ -39,8 +39,6 @@ properties:
   ranges: true
 
   cs-gpios:
-    minItems: 1
-    maxItems: 8
     description:
       Array of chip-select available to the controller. The first
       entries are a 1:1 mapping of the available chip-select on the
@@ -48,6 +46,8 @@ properties:
       chip-select as needed may follow and should be phandles of GPIO
       lines. 'reg' entries of the NAND chip subnodes become indexes of
       this array when this property is present.
+    minItems: 1
+    maxItems: 8
 
 patternProperties:
   "^nand@[a-f0-9]$":
@@ -58,8 +58,6 @@ patternProperties:
           Contains the chip-select IDs.
 
       nand-ecc-engine:
-        allOf:
-          - $ref: /schemas/types.yaml#/definitions/phandle
         description: |
           A phandle on the hardware ECC engine if any. There are
           basically three possibilities:
@@ -69,24 +67,24 @@ patternProperties:
           case the phandle should reference the node itself.
           3/ The ECC engine is external, in this case the phandle should
           reference the specific ECC engine node.
+        $ref: /schemas/types.yaml#/definitions/phandle
 
       nand-use-soft-ecc-engine:
-        type: boolean
         description: Use a software ECC engine.
+        type: boolean
 
       nand-no-ecc-engine:
-        type: boolean
         description: Do not use any ECC correction.
+        type: boolean
 
       nand-ecc-placement:
-        allOf:
-          - $ref: /schemas/types.yaml#/definitions/string
-          - enum: [ oob, interleaved ]
         description:
           Location of the ECC bytes. This location is unknown by default
           but can be explicitly set to "oob", if all ECC bytes are
           known to be stored in the OOB area, or "interleaved" if ECC
           bytes will be interleaved with regular data in the main area.
+        $ref: /schemas/types.yaml#/definitions/string
+        enum: [ oob, interleaved ]
 
       nand-ecc-algo:
         description:
@@ -102,7 +100,6 @@ patternProperties:
         default: 8
 
       nand-on-flash-bbt:
-        $ref: /schemas/types.yaml#/definitions/flag
         description:
           With this property, the OS will search the device for a Bad
           Block Table (BBT). If not found, it will create one, reserve
@@ -111,6 +108,7 @@ patternProperties:
           few pages of all the blocks will be scanned at boot time to
           find Bad Block Markers (BBM). These markers will help to
           build a volatile BBT in RAM.
+        $ref: /schemas/types.yaml#/definitions/flag
 
       nand-ecc-strength:
         description:
@@ -125,7 +123,6 @@ patternProperties:
         minimum: 1
 
       nand-ecc-maximize:
-        $ref: /schemas/types.yaml#/definitions/flag
         description:
           Whether or not the ECC strength should be maximized. The
           maximum ECC strength is both controller and chip
@@ -134,18 +131,19 @@ patternProperties:
           constraint into account. This is particularly useful when
           only the in-band area is used by the upper layers, and you
           want to make your NAND as reliable as possible.
+        $ref: /schemas/types.yaml#/definitions/flag
 
       nand-is-boot-medium:
-        $ref: /schemas/types.yaml#/definitions/flag
         description:
           Whether or not the NAND chip is a boot medium. Drivers might
           use this information to select ECC algorithms supported by
           the boot ROM or similar restrictions.
+        $ref: /schemas/types.yaml#/definitions/flag
 
       nand-rb:
-        $ref: /schemas/types.yaml#/definitions/uint32-array
         description:
           Contains the native Ready/Busy IDs.
+        $ref: /schemas/types.yaml#/definitions/uint32-array
 
       rb-gpios:
         description:
@@ -155,11 +153,11 @@ patternProperties:
           should be set to GPIOD_ACTIVE_HIGH unless the signal is inverted.
 
       secure-regions:
-        $ref: /schemas/types.yaml#/definitions/uint64-matrix
         description:
           Regions in the NAND chip which are protected using a secure element
           like Trustzone. This property contains the start address and size of
           the secure regions present.
+        $ref: /schemas/types.yaml#/definitions/uint64-matrix
 
     required:
       - reg
-- 
2.27.0


WARNING: multiple messages have this Message-ID (diff)
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Mark Brown <broonie@kernel.org>, <linux-spi@vger.kernel.org>,
	Richard Weinberger <richard@nod.at>,
	Vignesh Raghavendra <vigneshr@ti.com>,
	Tudor Ambarus <Tudor.Ambarus@microchip.com>,
	Pratyush Yadav <p.yadav@ti.com>, Michael Walle <michael@walle.cc>,
	<linux-mtd@lists.infradead.org>, Rob Herring <robh+dt@kernel.org>,
	<devicetree@vger.kernel.org>
Cc: Julien Su <juliensu@mxic.com.tw>,
	Jaime Liao <jaimeliao@mxic.com.tw>,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	Miquel Raynal <miquel.raynal@bootlin.com>
Subject: [PATCH v6 03/28] dt-bindings: mtd: nand-controller: Harmonize the property types
Date: Thu, 16 Dec 2021 12:16:29 +0100	[thread overview]
Message-ID: <20211216111654.238086-4-miquel.raynal@bootlin.com> (raw)
In-Reply-To: <20211216111654.238086-1-miquel.raynal@bootlin.com>

Harmonize the different properties in this file by:
* dropping the non-necessary allOf's
* always defining the keywords in the following order:
    - first the "description" (when relevant),
    - then the "type"/"$ref" and the other generic keywords ("enum",
      "default", etc).

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 .../bindings/mtd/nand-controller.yaml         | 26 +++++++++----------
 1 file changed, 12 insertions(+), 14 deletions(-)

diff --git a/Documentation/devicetree/bindings/mtd/nand-controller.yaml b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
index 5cd144a9ec99..a4fa65e872a5 100644
--- a/Documentation/devicetree/bindings/mtd/nand-controller.yaml
+++ b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
@@ -39,8 +39,6 @@ properties:
   ranges: true
 
   cs-gpios:
-    minItems: 1
-    maxItems: 8
     description:
       Array of chip-select available to the controller. The first
       entries are a 1:1 mapping of the available chip-select on the
@@ -48,6 +46,8 @@ properties:
       chip-select as needed may follow and should be phandles of GPIO
       lines. 'reg' entries of the NAND chip subnodes become indexes of
       this array when this property is present.
+    minItems: 1
+    maxItems: 8
 
 patternProperties:
   "^nand@[a-f0-9]$":
@@ -58,8 +58,6 @@ patternProperties:
           Contains the chip-select IDs.
 
       nand-ecc-engine:
-        allOf:
-          - $ref: /schemas/types.yaml#/definitions/phandle
         description: |
           A phandle on the hardware ECC engine if any. There are
           basically three possibilities:
@@ -69,24 +67,24 @@ patternProperties:
           case the phandle should reference the node itself.
           3/ The ECC engine is external, in this case the phandle should
           reference the specific ECC engine node.
+        $ref: /schemas/types.yaml#/definitions/phandle
 
       nand-use-soft-ecc-engine:
-        type: boolean
         description: Use a software ECC engine.
+        type: boolean
 
       nand-no-ecc-engine:
-        type: boolean
         description: Do not use any ECC correction.
+        type: boolean
 
       nand-ecc-placement:
-        allOf:
-          - $ref: /schemas/types.yaml#/definitions/string
-          - enum: [ oob, interleaved ]
         description:
           Location of the ECC bytes. This location is unknown by default
           but can be explicitly set to "oob", if all ECC bytes are
           known to be stored in the OOB area, or "interleaved" if ECC
           bytes will be interleaved with regular data in the main area.
+        $ref: /schemas/types.yaml#/definitions/string
+        enum: [ oob, interleaved ]
 
       nand-ecc-algo:
         description:
@@ -102,7 +100,6 @@ patternProperties:
         default: 8
 
       nand-on-flash-bbt:
-        $ref: /schemas/types.yaml#/definitions/flag
         description:
           With this property, the OS will search the device for a Bad
           Block Table (BBT). If not found, it will create one, reserve
@@ -111,6 +108,7 @@ patternProperties:
           few pages of all the blocks will be scanned at boot time to
           find Bad Block Markers (BBM). These markers will help to
           build a volatile BBT in RAM.
+        $ref: /schemas/types.yaml#/definitions/flag
 
       nand-ecc-strength:
         description:
@@ -125,7 +123,6 @@ patternProperties:
         minimum: 1
 
       nand-ecc-maximize:
-        $ref: /schemas/types.yaml#/definitions/flag
         description:
           Whether or not the ECC strength should be maximized. The
           maximum ECC strength is both controller and chip
@@ -134,18 +131,19 @@ patternProperties:
           constraint into account. This is particularly useful when
           only the in-band area is used by the upper layers, and you
           want to make your NAND as reliable as possible.
+        $ref: /schemas/types.yaml#/definitions/flag
 
       nand-is-boot-medium:
-        $ref: /schemas/types.yaml#/definitions/flag
         description:
           Whether or not the NAND chip is a boot medium. Drivers might
           use this information to select ECC algorithms supported by
           the boot ROM or similar restrictions.
+        $ref: /schemas/types.yaml#/definitions/flag
 
       nand-rb:
-        $ref: /schemas/types.yaml#/definitions/uint32-array
         description:
           Contains the native Ready/Busy IDs.
+        $ref: /schemas/types.yaml#/definitions/uint32-array
 
       rb-gpios:
         description:
@@ -155,11 +153,11 @@ patternProperties:
           should be set to GPIOD_ACTIVE_HIGH unless the signal is inverted.
 
       secure-regions:
-        $ref: /schemas/types.yaml#/definitions/uint64-matrix
         description:
           Regions in the NAND chip which are protected using a secure element
           like Trustzone. This property contains the start address and size of
           the secure regions present.
+        $ref: /schemas/types.yaml#/definitions/uint64-matrix
 
     required:
       - reg
-- 
2.27.0


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

  parent reply	other threads:[~2021-12-16 11:17 UTC|newest]

Thread overview: 119+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-16 11:16 [PATCH v6 00/28] External ECC engines & Macronix support Miquel Raynal
2021-12-16 11:16 ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 01/28] dt-bindings: mtd: nand-controller: Fix the reg property description Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:54   ` Miquel Raynal
2021-12-17 15:54     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 02/28] dt-bindings: mtd: nand-controller: Fix a comment in the examples Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:54   ` Miquel Raynal
2021-12-17 15:54     ` Miquel Raynal
2021-12-16 11:16 ` Miquel Raynal [this message]
2021-12-16 11:16   ` [PATCH v6 03/28] dt-bindings: mtd: nand-controller: Harmonize the property types Miquel Raynal
2021-12-16 21:09   ` Rob Herring
2021-12-16 21:09     ` Rob Herring
2021-12-17 15:54   ` Miquel Raynal
2021-12-17 15:54     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 04/28] dt-bindings: mtd: nand-chip: Create a NAND chip description Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:54   ` Miquel Raynal
2021-12-17 15:54     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 05/28] dt-bindings: mtd: spi-nand: Convert spi-nand description file to yaml Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:54   ` Miquel Raynal
2021-12-17 15:54     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 06/28] dt-bindings: vendor-prefixes: Clarify Macronix prefix Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:54   ` Miquel Raynal
2021-12-17 15:54     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 07/28] dt-bindings: spi: mxic: The interrupt property is not mandatory Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 08/28] dt-bindings: spi: mxic: Convert to yaml Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 09/28] dt-bindings: spi: mxic: Document the nand-ecc-engine property Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 10/28] dt-bindings: mtd: Describe Macronix NAND ECC engine Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 11/28] mtd: spinand: macronix: Use random program load Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 12/28] mtd: nand: ecc: Add infrastructure to support hardware engines Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 13/28] mtd: nand: Add a new helper to retrieve the ECC context Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 14/28] mtd: nand: mxic-ecc: Add Macronix external ECC engine support Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:53   ` Miquel Raynal
2021-12-17 15:53     ` Miquel Raynal
2022-02-22 10:39   ` Geert Uytterhoeven
2022-02-22 10:39     ` Geert Uytterhoeven
2022-02-22 10:41     ` Miquel Raynal
2022-02-22 10:41       ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 15/28] mtd: nand: ecc: Provide a helper to retrieve a pilelined engine device Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:52   ` Miquel Raynal
2021-12-17 15:52     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 16/28] mtd: nand: mxic-ecc: Support SPI pipelined mode Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-17 15:52   ` Miquel Raynal
2021-12-17 15:52     ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 17/28] mtd: spinand: Delay a little bit the dirmap creation Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 18/28] spi: spi-mem: Fix a DTR related check in spi_mem_dtr_supports_op() Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 19/28] spi: spi-mem: Introduce a capability structure Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 20/28] spi: spi-mem: Fill the spi-mem controller capabilities of all the drivers Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 15:52   ` Miquel Raynal
2021-12-16 15:52     ` Miquel Raynal
2021-12-16 18:00   ` kernel test robot
2021-12-16 18:00     ` kernel test robot
2021-12-16 18:00     ` kernel test robot
2021-12-16 18:21   ` kernel test robot
2021-12-16 18:21     ` kernel test robot
2021-12-16 18:21     ` kernel test robot
2021-12-16 18:52   ` kernel test robot
2021-12-16 18:52     ` kernel test robot
2021-12-16 18:52     ` kernel test robot
2021-12-16 20:10   ` [RFC PATCH] spi: spi-mem: mxic_spi_mem_caps can be static kernel test robot
2021-12-16 20:10     ` kernel test robot
2021-12-16 20:10     ` kernel test robot
2021-12-16 20:14   ` [PATCH v6 20/28] spi: spi-mem: Fill the spi-mem controller capabilities of all the drivers kernel test robot
2021-12-16 20:14     ` kernel test robot
2021-12-16 20:14     ` kernel test robot
2021-12-16 20:14   ` [RFC PATCH] spi: spi-mem: cqspi_mem_caps can be static kernel test robot
2021-12-16 20:14     ` kernel test robot
2021-12-16 20:14     ` kernel test robot
2021-12-16 20:24   ` [PATCH v6 20/28] spi: spi-mem: Fill the spi-mem controller capabilities of all the drivers kernel test robot
2021-12-16 20:24     ` kernel test robot
2021-12-16 20:24     ` kernel test robot
2021-12-16 11:16 ` [PATCH v6 21/28] spi: spi-mem: Kill the spi_mem_dtr_supports_op() helper Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 22/28] spi: spi-mem: Add an ecc_en parameter to the spi_mem_op structure Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 23/28] mtd: spinand: Create direct mapping descriptors for ECC operations Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 24/28] spi: mxic: Fix the transmit path Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 25/28] spi: mxic: Create a helper to configure the controller before an operation Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 26/28] spi: mxic: Create a helper to ease the start of " Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 27/28] spi: mxic: Add support for direct mapping Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal
2021-12-16 11:16 ` [PATCH v6 28/28] spi: mxic: Add support for pipelined ECC operations Miquel Raynal
2021-12-16 11:16   ` Miquel Raynal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211216111654.238086-4-miquel.raynal@bootlin.com \
    --to=miquel.raynal@bootlin.com \
    --cc=Tudor.Ambarus@microchip.com \
    --cc=broonie@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=jaimeliao@mxic.com.tw \
    --cc=juliensu@mxic.com.tw \
    --cc=linux-mtd@lists.infradead.org \
    --cc=linux-spi@vger.kernel.org \
    --cc=michael@walle.cc \
    --cc=p.yadav@ti.com \
    --cc=richard@nod.at \
    --cc=robh+dt@kernel.org \
    --cc=thomas.petazzoni@bootlin.com \
    --cc=vigneshr@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.