[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-Id: <20220217102448.27586-1-zajec5@gmail.com>
Date: Thu, 17 Feb 2022 11:24:48 +0100
From: Rafał Miłecki <zajec5@...il.com>
To: Rob Herring <robh+dt@...nel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski@...onical.com>
Cc: Miquel Raynal <miquel.raynal@...tlin.com>,
Richard Weinberger <richard@....at>,
Vignesh Raghavendra <vigneshr@...com>,
linux-mtd@...ts.infradead.org, devicetree@...r.kernel.org,
linux-kernel@...r.kernel.org, Tom Rini <trini@...sulko.com>,
Ricardo Salveti <ricardo@...ndries.io>,
Michal Simek <michal.simek@...inx.com>,
Jorge Ramirez-Ortiz <jorge@...ndries.io>,
Sean Anderson <seanga2@...il.com>, u-boot@...ts.denx.de,
Rafał Miłecki <rafal@...ecki.pl>
Subject: [PATCH] dt-bindings: mtd: partitions: add UBI binding
From: Rafał Miłecki <rafal@...ecki.pl>
UBI is often used on embedded devices to store UBI volumes with device
configuration / calibration data. Such volumes may need to be documented
and referenced for proper boot & setup.
Some examples:
1. U-Boot environment variables
2. Device calibration data
3. Default setup (e.g. initial password)
Signed-off-by: Rafał Miłecki <rafal@...ecki.pl>
---
.../bindings/mtd/partitions/ubi.yaml | 67 +++++++++++++++++++
1 file changed, 67 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mtd/partitions/ubi.yaml
diff --git a/Documentation/devicetree/bindings/mtd/partitions/ubi.yaml b/Documentation/devicetree/bindings/mtd/partitions/ubi.yaml
new file mode 100644
index 000000000000..cd081f06d4cb
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/partitions/ubi.yaml
@@ -0,0 +1,67 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/ubi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: UBI (Unsorted Block Images) device
+
+description: |
+ UBI is a layer providing logical volumes (consisting of logical blocks) on top
+ of raw flash devices. It deals with low-level flash issues (bit-flips, bad
+ physical eraseblocks, wearing) providing a reliable data storage.
+
+ UBI device is built and stored in a single flash partition.
+
+ Some (usually embedded) devices use UBI volumes of specific names or indexes
+ to store setup / configuration data. This binding allows describing such
+ volumes so they can be identified and referenced by consumers.
+
+maintainers:
+ - Rafał Miłecki <rafal@...ecki.pl>
+
+allOf:
+ - $ref: partition.yaml#
+
+properties:
+ compatible:
+ const: ubi
+
+patternProperties:
+ "^volume-[0-9a-f]+$":
+ type: object
+ description: UBI volume
+ properties:
+ volume-name:
+ $ref: /schemas/types.yaml#/definitions/string
+ volume-id:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ anyOf:
+ - required:
+ - volume-name
+ - required:
+ - volume-id
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ partitions {
+ compatible = "fixed-partitions";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ partition@0 {
+ compatible = "ubi";
+ reg = <0x0000000 0x1000000>;
+ label = "filesystem";
+
+ env: volume-0 {
+ volume-name = "u-boot-env";
+ };
+
+ calibration: volume-1 {
+ volume-id = <99>;
+ };
+ };
+ };
--
2.34.1
Powered by blists - more mailing lists