The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Akhila YS <akhilayalmati@gmail.com>
To: Miquel Raynal <miquel.raynal@bootlin.com>,
	 Richard Weinberger <richard@nod.at>,
	Vignesh Raghavendra <vigneshr@ti.com>,
	 Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	 Conor Dooley <conor+dt@kernel.org>
Cc: linux-mtd@lists.infradead.org, devicetree@vger.kernel.org,
	 linux-kernel@vger.kernel.org,
	Akhila YS <akhilayalmati@gmail.com>
Subject: [PATCH] dt-bindings: mtd: nand-micronix: convert to DT schema
Date: Tue, 30 Dec 2025 07:20:21 +0000	[thread overview]
Message-ID: <20251230-macronix-v1-1-ff2aaab43644@gmail.com> (raw)

Convert Macronix NAND Randomizer OTP Enable Property binding to YAML format.

Signed-off-by: Akhila YS <akhilayalmati@gmail.com>
---
 .../devicetree/bindings/mtd/nand-macronix.txt      | 27 --------------
 .../devicetree/bindings/mtd/nand-macronix.yaml     | 41 ++++++++++++++++++++++
 2 files changed, 41 insertions(+), 27 deletions(-)

diff --git a/Documentation/devicetree/bindings/mtd/nand-macronix.txt b/Documentation/devicetree/bindings/mtd/nand-macronix.txt
deleted file mode 100644
index ffab28a2c4d1..000000000000
--- a/Documentation/devicetree/bindings/mtd/nand-macronix.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-Macronix NANDs Device Tree Bindings
------------------------------------
-
-Macronix NANDs support randomizer operation for scrambling user data,
-which can be enabled with a SET_FEATURE. The penalty when using the
-randomizer are subpage accesses prohibited and more time period needed
-for program operation, i.e., tPROG 300us to 340us (randomizer enabled).
-Enabling the randomizer is a one time persistent and non reversible
-operation.
-
-For more high-reliability concern, if subpage write is not available
-with hardware ECC and not enabled at UBI level, then enabling the
-randomizer is recommended by default by adding a new specific property
-in children nodes.
-
-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;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/mtd/nand-macronix.yaml b/Documentation/devicetree/bindings/mtd/nand-macronix.yaml
new file mode 100644
index 000000000000..10f1d58adcef
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/nand-macronix.yaml
@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/nand-macronix.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Macronix NAND Randomizer OTP Enable Property
+
+maintainers:
+  - Miquel Raynal <miquel.raynal@bootlin.com>
+  - Richard Weinberger <richard@nod.at>
+
+description:
+  Macronix NAND chips support an optional one-time programmable (OTP)
+  data randomizer that scrambles user data to improve reliability.
+  Enabling it is irreversible, prohibits subpage accesses, and slightly
+  increases program time. This property requests the driver to enable
+  the randomizer if not already set.
+
+properties:
+  mxic,enable-randomizer-otp:
+    type: boolean
+    description:
+      Presence of this property indicates that the data randomizer should
+      be enabled in OTP mode on the NAND chip.
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    nand-controller {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        nand@0 {
+            reg = <0>;
+            mxic,enable-randomizer-otp;
+        };
+    };
+
+...

---
base-commit: cc3aa43b44bdb43dfbac0fcb51c56594a11338a8
change-id: 20251229-macronix-c9d8b32c00cf

Best regards,
-- 
Akhila YS <akhilayalmati@gmail.com>


             reply	other threads:[~2025-12-30  7:20 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-30  7:20 Akhila YS [this message]
2025-12-30 18:23 ` [PATCH] dt-bindings: mtd: nand-micronix: convert to DT schema Rob Herring

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=20251230-macronix-v1-1-ff2aaab43644@gmail.com \
    --to=akhilayalmati@gmail.com \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=miquel.raynal@bootlin.com \
    --cc=richard@nod.at \
    --cc=robh@kernel.org \
    --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