From: Rob Herring <robh@kernel.org>
To: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: 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, Mark Brown <broonie@kernel.org>,
linux-spi@vger.kernel.org, devicetree@vger.kernel.org,
Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Xiangsheng Hou <Xiangsheng.Hou@mediatek.com>,
Julien Su <juliensu@mxic.com.tw>,
Jaime Liao <jaimeliao@mxic.com.tw>,
Boris Brezillon <boris.brezillon@collabora.com>
Subject: Re: [PATCH v3 03/22] dt-bindings: mtd: nand-controller: Harmonize the property types
Date: Tue, 14 Dec 2021 11:45:25 -0600 [thread overview]
Message-ID: <YbjYNVOVL/sLda9H@robh.at.kernel.org> (raw)
In-Reply-To: <20211207093422.166934-4-miquel.raynal@bootlin.com>
On Tue, Dec 07, 2021 at 10:34:03AM +0100, Miquel Raynal wrote:
> Harmonize the different properties in this file by:
> * dropping the non-necessary allOf's
> * always defining the keywords in the following order:
> - first: "type"/"$ref",
> - second: "description" (when relevant),
If we're going to muck with this, really I prefer description first or
last and everything else together.
> - then the other generic keywords ("enum", "default", etc).
>
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
> .../devicetree/bindings/mtd/nand-controller.yaml | 16 +++++++---------
> 1 file changed, 7 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/mtd/nand-controller.yaml b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
> index 5cd144a9ec99..7024ca24c2e2 100644
> --- a/Documentation/devicetree/bindings/mtd/nand-controller.yaml
> +++ b/Documentation/devicetree/bindings/mtd/nand-controller.yaml
> @@ -58,8 +58,7 @@ patternProperties:
> Contains the chip-select IDs.
>
> nand-ecc-engine:
> - allOf:
> - - $ref: /schemas/types.yaml#/definitions/phandle
> + $ref: /schemas/types.yaml#/definitions/phandle
> description: |
> A phandle on the hardware ECC engine if any. There are
> basically three possibilities:
> @@ -79,25 +78,24 @@ patternProperties:
> description: Do not use any ECC correction.
>
> nand-ecc-placement:
> - allOf:
> - - $ref: /schemas/types.yaml#/definitions/string
> - - enum: [ oob, interleaved ]
> + $ref: /schemas/types.yaml#/definitions/string
> 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.
> + enum: [ oob, interleaved ]
>
> nand-ecc-algo:
> + $ref: /schemas/types.yaml#/definitions/string
> description:
> Desired ECC algorithm.
> - $ref: /schemas/types.yaml#/definitions/string
> enum: [hamming, bch, rs]
>
> nand-bus-width:
> + $ref: /schemas/types.yaml#/definitions/uint32
> description:
> Bus width to the NAND chip
> - $ref: /schemas/types.yaml#/definitions/uint32
> enum: [8, 16]
> default: 8
>
> @@ -113,15 +111,15 @@ patternProperties:
> build a volatile BBT in RAM.
>
> nand-ecc-strength:
> + $ref: /schemas/types.yaml#/definitions/uint32
> description:
> Maximum number of bits that can be corrected per ECC step.
> - $ref: /schemas/types.yaml#/definitions/uint32
> minimum: 1
>
> nand-ecc-step-size:
> + $ref: /schemas/types.yaml#/definitions/uint32
> description:
> Number of data bytes covered by a single ECC step.
> - $ref: /schemas/types.yaml#/definitions/uint32
> minimum: 1
>
> nand-ecc-maximize:
> --
> 2.27.0
>
>
next prev parent reply other threads:[~2021-12-14 17:45 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-07 9:34 [PATCH v3 00/22] External ECC engines & Macronix support Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 01/22] dt-bindings: mtd: nand-controller: Fix the reg property description Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 02/22] dt-bindings: mtd: nand-controller: Fix a comment in the examples Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 03/22] dt-bindings: mtd: nand-controller: Harmonize the property types Miquel Raynal
2021-12-14 17:45 ` Rob Herring [this message]
2021-12-15 15:50 ` Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 04/22] dt-bindings: mtd: nand-chip: Create a NAND chip description Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 05/22] dt-bindings: mtd: spi-nand: Convert spi-nand description file to yaml Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 06/22] dt-bindings: vendor-prefixes: Clarify Macronix prefix Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 07/22] dt-bindings: spi: mxic: The interrupt property is not mandatory Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 08/22] dt-bindings: spi: mxic: Convert to yaml Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 09/22] dt-bindings: spi: mxic: Document the nand-ecc-engine property Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 10/22] dt-bindings: mtd: Describe Macronix NAND ECC engine Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 11/22] mtd: spinand: macronix: Use random program load Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 12/22] mtd: nand: ecc: Add infrastructure to support hardware engines Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 13/22] mtd: nand: Add a new helper to retrieve the ECC context Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 14/22] mtd: nand: mxic-ecc: Add Macronix external ECC engine support Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 15/22] mtd: nand: mxic-ecc: Support SPI pipelined mode Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 16/22] mtd: spinand: Delay a little bit dirmap creation Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 17/22] mtd: spinand: Create direct mapping descriptors for ECC operations Miquel Raynal
2021-12-07 9:46 ` Boris Brezillon
2021-12-07 10:53 ` Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 18/22] spi: mxic: Fix the transmit path Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 19/22] spi: mxic: Create a helper to configure the controller before an operation Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 20/22] spi: mxic: Create a helper to ease the start of " Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 21/22] spi: mxic: Add support for direct mapping Miquel Raynal
2021-12-07 9:34 ` [PATCH v3 22/22] spi: mxic: Add support for pipelined ECC operations 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=YbjYNVOVL/sLda9H@robh.at.kernel.org \
--to=robh@kernel.org \
--cc=Tudor.Ambarus@microchip.com \
--cc=Xiangsheng.Hou@mediatek.com \
--cc=boris.brezillon@collabora.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=miquel.raynal@bootlin.com \
--cc=p.yadav@ti.com \
--cc=richard@nod.at \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).