Document the bindings used by the Macronix NAND device.
Signed-off-by: Mason Yang <masonccyang@xxxxxxxxxxx>
Reviewed-by: Rob Herring <robh@xxxxxxxxxx>
---
.../devicetree/bindings/mtd/nand-macronix.txt | 28 ++++++++++++++++++++++
1 file changed, 28 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..1d7a895
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/nand-macronix.txt
@@ -0,0 +1,28 @@
+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 are
+subpage accesses prohibited and more time period is needed in program
+operation, i.e., tPROG 300us to 340us(randomizer enabled).
+Randomizer enabled is a one time persistent and non reversible operatoin.
+
+For more high-reliability concern, if subpage write not available with
+hardware ECC and filesystem and then to enable randomizer is recommended
+by default.
+
+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;
+ };
+ };
--
1.9.1
