diff mbox series

[v4,2/2] dt-bindings: mtd: Document Macronix NAND device bindings

Message ID 1571902807-10388-3-git-send-email-masonccyang@mxic.com.tw
State Changes Requested
Delegated to: Miquel Raynal
Headers show
Series mtd: rawnand: Add support Macronix NAND randomizer | expand

Commit Message

Mason Yang Oct. 24, 2019, 7:40 a.m. UTC 
Document the bindings used by the Macronix NAND device.

Signed-off-by: Mason Yang <masonccyang@mxic.com.tw>
---
 .../devicetree/bindings/mtd/nand-macronix.txt        | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mtd/nand-macronix.txt

Comments

Rob Herring Oct. 25, 2019, 7:12 p.m. UTC | #1 
On Thu, 24 Oct 2019 15:40:07 +0800, Mason Yang wrote:
> Document the bindings used by the Macronix NAND device.
> 
> Signed-off-by: Mason Yang <masonccyang@mxic.com.tw>
> ---
>  .../devicetree/bindings/mtd/nand-macronix.txt        | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mtd/nand-macronix.txt
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Miquel Raynal Jan. 9, 2020, 4:30 p.m. UTC | #2 
Hi Mason,

Mason Yang <masonccyang@mxic.com.tw> wrote on Thu, 24 Oct 2019 15:40:07
+0800:

> Document the bindings used by the Macronix NAND device.
> 
> Signed-off-by: Mason Yang <masonccyang@mxic.com.tw>
> ---
>  .../devicetree/bindings/mtd/nand-macronix.txt        | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mtd/nand-macronix.txt
> 
> diff --git a/Documentation/devicetree/bindings/mtd/nand-macronix.txt b/Documentation/devicetree/bindings/mtd/nand-macronix.txt
> new file mode 100644
> index 0000000..cb60358
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mtd/nand-macronix.txt
> @@ -0,0 +1,20 @@
> +Macronix NANDs Device Tree Bindings
> +-----------------------------------
> +
> +Macronix NANDs support randomizer operation for user data scrambled,
> +which can be enabled with a SET_FEATURE. The penalty of randomizer
> +is subpage accesses prohibited. By adding a new specific property
> +in children nodes to enable randomizer function.

You don't mention the performance penalty nor the benefits of such
operation.

Please also insist on the fact that this is a one time persistent, non
reversible operation and the use should use this property only if they
know what they are doing!

> +
> +Required NAND chip properties in children mode:
> +- randomizer enable: should be "mxic,enable-randomizer-otp"
> +
> +Example:
> +
> +	nand: nand-controller@unit-address {
> +
> +		nand@0 {
> +			reg = <0>;
> +			mxic,enable-randomizer-otp;
> +		};
> +	};

Thanks,
Miquèl
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mtd/nand-macronix.txt b/Documentation/devicetree/bindings/mtd/nand-macronix.txt
new file mode 100644
index 0000000..cb60358
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/nand-macronix.txt
@@ -0,0 +1,20 @@ 
+Macronix NANDs Device Tree Bindings
+-----------------------------------
+
+Macronix NANDs support randomizer operation for user data scrambled,
+which can be enabled with a SET_FEATURE. The penalty of randomizer
+is subpage accesses prohibited. By adding a new specific property
+in children nodes to enable randomizer function.
+
+Required NAND chip properties in children mode:
+- randomizer enable: should be "mxic,enable-randomizer-otp"
+
+Example:
+
+	nand: nand-controller@unit-address {
+
+		nand@0 {
+			reg = <0>;
+			mxic,enable-randomizer-otp;
+		};
+	};