From: Jamie Lentin <jm@lentin.co.uk>
To: Arnd Bergmann <arnd@arndb.de>, Jason <jason@lakedaemon.net>
Cc: devicetree-discuss@lists.ozlabs.org,
Jamie Lentin <jm@lentin.co.uk>,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH V3 5/5] mtd: Move fdt partition documentation to a seperate file
Date: Tue, 27 Mar 2012 22:54:15 +0100 [thread overview]
Message-ID: <1332885255-8304-6-git-send-email-jm@lentin.co.uk> (raw)
In-Reply-To: <1332885255-8304-1-git-send-email-jm@lentin.co.uk>
Partitions are described in the same way for all mtd devices when using
devicetree, move the documentation to a separate file and add references
to it.
Signed-off-by: Jamie Lentin <jm@lentin.co.uk>
---
.../devicetree/bindings/mtd/arm-versatile.txt | 4 +-
.../devicetree/bindings/mtd/atmel-dataflash.txt | 3 ++
.../devicetree/bindings/mtd/fsl-upm-nand.txt | 4 ++
.../devicetree/bindings/mtd/gpio-control-nand.txt | 3 ++
.../devicetree/bindings/mtd/mtd-physmap.txt | 23 +-----------
.../devicetree/bindings/mtd/orion-nand.txt | 3 ++
.../devicetree/bindings/mtd/partition.txt | 38 ++++++++++++++++++++
7 files changed, 55 insertions(+), 23 deletions(-)
create mode 100644 Documentation/devicetree/bindings/mtd/partition.txt
diff --git a/Documentation/devicetree/bindings/mtd/arm-versatile.txt b/Documentation/devicetree/bindings/mtd/arm-versatile.txt
index 476845d..beace4b 100644
--- a/Documentation/devicetree/bindings/mtd/arm-versatile.txt
+++ b/Documentation/devicetree/bindings/mtd/arm-versatile.txt
@@ -4,5 +4,5 @@ Required properties:
- compatible : must be "arm,versatile-flash";
- bank-width : width in bytes of flash interface.
-Optional properties:
-- Subnode partition map from mtd flash binding
+The device tree may optionally contain sub-nodes describing partitions of the
+address space. See partition.txt for more detail.
diff --git a/Documentation/devicetree/bindings/mtd/atmel-dataflash.txt b/Documentation/devicetree/bindings/mtd/atmel-dataflash.txt
index ef66ddd..1889a4d 100644
--- a/Documentation/devicetree/bindings/mtd/atmel-dataflash.txt
+++ b/Documentation/devicetree/bindings/mtd/atmel-dataflash.txt
@@ -3,6 +3,9 @@
Required properties:
- compatible : "atmel,<model>", "atmel,<series>", "atmel,dataflash".
+The device tree may optionally contain sub-nodes describing partitions of the
+address space. See partition.txt for more detail.
+
Example:
flash@1 {
diff --git a/Documentation/devicetree/bindings/mtd/fsl-upm-nand.txt b/Documentation/devicetree/bindings/mtd/fsl-upm-nand.txt
index 00f1f54..fce4894 100644
--- a/Documentation/devicetree/bindings/mtd/fsl-upm-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/fsl-upm-nand.txt
@@ -19,6 +19,10 @@ Optional properties:
read registers (tR). Required if property "gpios" is not used
(R/B# pins not connected).
+Each flash chip described may optionally contain additional sub-nodes
+describing partitions of the address space. See partition.txt for more
+detail.
+
Examples:
upm@1,0 {
diff --git a/Documentation/devicetree/bindings/mtd/gpio-control-nand.txt b/Documentation/devicetree/bindings/mtd/gpio-control-nand.txt
index 719f4dc..36ef07d 100644
--- a/Documentation/devicetree/bindings/mtd/gpio-control-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/gpio-control-nand.txt
@@ -25,6 +25,9 @@ Optional properties:
GPIO state and before and after command byte writes, this register will be
read to ensure that the GPIO accesses have completed.
+The device tree may optionally contain sub-nodes describing partitions of the
+address space. See partition.txt for more detail.
+
Examples:
gpio-nand@1,0 {
diff --git a/Documentation/devicetree/bindings/mtd/mtd-physmap.txt b/Documentation/devicetree/bindings/mtd/mtd-physmap.txt
index 80152cb..a63c2bd7 100644
--- a/Documentation/devicetree/bindings/mtd/mtd-physmap.txt
+++ b/Documentation/devicetree/bindings/mtd/mtd-physmap.txt
@@ -23,27 +23,8 @@ are defined:
- vendor-id : Contains the flash chip's vendor id (1 byte).
- device-id : Contains the flash chip's device id (1 byte).
-In addition to the information on the mtd bank itself, the
-device tree may optionally contain additional information
-describing partitions of the address space. This can be
-used on platforms which have strong conventions about which
-portions of a flash are used for what purposes, but which don't
-use an on-flash partition table such as RedBoot.
-
-Each partition is represented as a sub-node of the mtd device.
-Each node's name represents the name of the corresponding
-partition of the mtd device.
-
-Flash partitions
- - reg : The partition's offset and size within the mtd bank.
- - label : (optional) The label / name for this partition.
- If omitted, the label is taken from the node name (excluding
- the unit address).
- - read-only : (optional) This parameter, if present, is a hint to
- Linux that this partition should only be mounted
- read-only. This is usually used for flash partitions
- containing early-boot firmware images or data which should not
- be clobbered.
+The device tree may optionally contain sub-nodes describing partitions of the
+address space. See partition.txt for more detail.
Example:
diff --git a/Documentation/devicetree/bindings/mtd/orion-nand.txt b/Documentation/devicetree/bindings/mtd/orion-nand.txt
index 22c7438..d606009 100644
--- a/Documentation/devicetree/bindings/mtd/orion-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/orion-nand.txt
@@ -11,6 +11,9 @@ Optional properties:
- bank-width :
- chip-delay :
+The device tree may optionally contain sub-nodes describing partitions of the
+address space. See partition.txt for more detail.
+
Examples:
nand@f4000000 {
diff --git a/Documentation/devicetree/bindings/mtd/partition.txt b/Documentation/devicetree/bindings/mtd/partition.txt
new file mode 100644
index 0000000..f114ce1
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/partition.txt
@@ -0,0 +1,38 @@
+Representing flash partitions in devicetree
+
+Partitions can be represented by sub-nodes of an mtd device. This can be used
+on platforms which have strong conventions about which portions of a flash are
+used for what purposes, but which don't use an on-flash partition table such
+as RedBoot.
+
+#address-cells & #size-cells must both be present in the mtd device and be
+equal to 1.
+
+Required properties:
+- reg : The partition's offset and size within the mtd bank.
+
+Optional properties:
+- label : The label / name for this partition. If omitted, the label is taken
+ from the node name (excluding the unit address).
+- read-only : This parameter, if present, is a hint to Linux that this
+ partition should only be mounted read-only. This is usually used for flash
+ partitions containing early-boot firmware images or data which should not be
+ clobbered.
+
+Examples:
+
+
+flash@0 {
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ partition@0 {
+ label = "u-boot";
+ reg = <0x0000000 0x100000>;
+ read-only;
+ };
+
+ uimage@100000 {
+ reg = <0x0100000 0x200000>;
+ };
+];
--
1.7.9.1
next prev parent reply other threads:[~2012-03-27 21:54 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-27 21:54 [PATCH V3 0/5] Add support for DNS-320 and DNS-325 using devicetree Jamie Lentin
2012-03-27 21:54 ` [PATCH V3 1/5] ARM: kirkwood: Basic support for DNS-320 and DNS-325 Jamie Lentin
[not found] ` <1332885255-8304-2-git-send-email-jm-Pj/HzkgeCk7QXOPxS62xeg@public.gmane.org>
2012-03-28 8:19 ` Arnd Bergmann
2012-04-06 23:43 ` Grant Likely
2012-04-09 14:09 ` Arnd Bergmann
[not found] ` <201204091409.04927.arnd-r2nGTMty4D4@public.gmane.org>
2012-04-09 14:20 ` Jamie Lentin
[not found] ` <alpine.DEB.2.00.1204091513250.23719-5X291BYdrx55rAo4AelP/Ydd74u8MsAO@public.gmane.org>
2012-04-09 15:01 ` Arnd Bergmann
2012-03-31 1:30 ` Jason Cooper
2012-04-06 23:49 ` Grant Likely
2012-04-09 13:20 ` Jamie Lentin
[not found] ` <alpine.DEB.2.00.1204091418400.23719-5X291BYdrx55rAo4AelP/Ydd74u8MsAO@public.gmane.org>
2012-04-09 14:14 ` Arnd Bergmann
2012-04-11 0:43 ` Jason Cooper
[not found] ` <20120411004324.GB14790-u4khhh1J0LxI1Ri9qeTfzeTW4wlIGRCZ@public.gmane.org>
2012-04-11 13:32 ` Jamie Lentin
[not found] ` <op.wclrwkqi4cuzmg-x9DHNcFvAEtNwP/n92qj9LVCufUGDwFn@public.gmane.org>
2012-04-11 14:11 ` Jason Cooper
[not found] ` <20120411141118.GG14790-u4khhh1J0LxI1Ri9qeTfzeTW4wlIGRCZ@public.gmane.org>
2012-04-11 15:08 ` Arnd Bergmann
2012-04-09 21:27 ` Russell King - ARM Linux
2012-04-11 0:35 ` Jason Cooper
2012-03-27 21:54 ` [PATCH V3 2/5] mtd: Add orion_nand devicetree bindings Jamie Lentin
2012-03-28 23:04 ` Grant Likely
[not found] ` <1332885255-8304-1-git-send-email-jm-Pj/HzkgeCk7QXOPxS62xeg@public.gmane.org>
2012-03-27 21:54 ` [PATCH V3 3/5] ARM: kirkwood: Allow nand to be configured via. devicetree Jamie Lentin
2012-03-27 21:54 ` [PATCH V3 4/5] ARM: kirkwood: Define DNS-320/DNS-325 NAND in fdt Jamie Lentin
2012-03-27 21:54 ` Jamie Lentin [this message]
2012-03-28 8:17 ` [PATCH V3 5/5] mtd: Move fdt partition documentation to a seperate file Arnd Bergmann
2012-03-28 23:08 ` Grant Likely
[not found] ` <1332885255-8304-6-git-send-email-jm-Pj/HzkgeCk7QXOPxS62xeg@public.gmane.org>
2012-03-28 14:41 ` Jason Cooper
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=1332885255-8304-6-git-send-email-jm@lentin.co.uk \
--to=jm@lentin.co.uk \
--cc=arnd@arndb.de \
--cc=devicetree-discuss@lists.ozlabs.org \
--cc=jason@lakedaemon.net \
--cc=linux-arm-kernel@lists.infradead.org \
/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).