2021-05-21 03:00:51

by Corentin LABBE

Subject: [PATCH] dt_bindings: mtd: partitions: redboot: convert to YAML

Converts mtd/partitions/redboot-fis.txt to YAML.

Signed-off-by: Corentin Labbe <[email protected]>
---
.../bindings/mtd/partitions/redboot-fis.txt | 27 ------------
.../bindings/mtd/partitions/redboot-fis.yaml | 42 +++++++++++++++++++
2 files changed, 42 insertions(+), 27 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/mtd/partitions/redboot-fis.txt
create mode 100644 Documentation/devicetree/bindings/mtd/partitions/redboot-fis.yaml

diff --git a/Documentation/devicetree/bindings/mtd/partitions/redboot-fis.txt b/Documentation/devicetree/bindings/mtd/partitions/redboot-fis.txt
deleted file mode 100644
index fd0ebe4e3415..000000000000
--- a/Documentation/devicetree/bindings/mtd/partitions/redboot-fis.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-RedBoot FLASH Image System (FIS) Partitions
-===========================================
-
-The FLASH Image System (FIS) directory is a flash description
-format closely associated with the RedBoot boot loader.
-
-It uses one single flash eraseblock in the flash to store an index of
-all images in the flash.
-
-This block size will vary depending on flash but is typically
-32 KB in size.
-
-Required properties:
-- compatible : (required) must be "redboot-fis"
-- fis-index-block : (required) a index to the eraseblock containing
- the FIS directory on this device. On a flash memory with 32KB
- eraseblocks, 0 means the first eraseblock at 0x00000000, 1 means the
- second eraseblock at 0x00008000 and so on.
-
-Example:
-
-flash@0 {
- partitions {
- compatible = "redboot-fis";
- fis-index-block = <0>;
- };
-};
diff --git a/Documentation/devicetree/bindings/mtd/partitions/redboot-fis.yaml b/Documentation/devicetree/bindings/mtd/partitions/redboot-fis.yaml
new file mode 100644
index 000000000000..61e08be984b0
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/partitions/redboot-fis.yaml
@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/redboot-fis.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RedBoot FLASH Image System (FIS) Partitions
+
+description: The FLASH Image System (FIS) directory is a flash description
+ format closely associated with the RedBoot boot loader.
+ It uses one single flash eraseblock in the flash to store an index of
+ all images in the flash.
+ This block size will vary depending on flash but is typically
+ 32 KB in size.
+
+maintainers:
+ - Linus Walleij <[email protected]>
+
+properties:
+ compatible:
+ const: redboot-fis
+
+ fis-index-block:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: a index to the eraseblock containing the FIS directory on this
+ device. On a flash memory with 32KB eraseblocks, 0 means the first
+ eraseblock at 0x00000000, 1 means the second eraseblock at 0x00008000 and so on.
+
+required:
+ - compatible
+ - fis-index-block
+
+additionalProperties: false
+
+examples:
+ - |
+ flash@0 {
+ partitions {
+ compatible = "redboot-fis";
+ fis-index-block = <0>;
+ };
+ };
--
2.26.3

2021-05-21 07:26:42

by Rob Herring

Subject: Re: [PATCH] dt_bindings: mtd: partitions: redboot: convert to YAML

On Thu, 20 May 2021 11:57:32 +0000, Corentin Labbe wrote:
> Converts mtd/partitions/redboot-fis.txt to YAML.
>
> Signed-off-by: Corentin Labbe <[email protected]>
> ---
> .../bindings/mtd/partitions/redboot-fis.txt | 27 ------------
> .../bindings/mtd/partitions/redboot-fis.yaml | 42 +++++++++++++++++++
> 2 files changed, 42 insertions(+), 27 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/mtd/partitions/redboot-fis.txt
> create mode 100644 Documentation/devicetree/bindings/mtd/partitions/redboot-fis.yaml
>

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/mtd/partitions/redboot-fis.example.dts:19.17-24.11: Warning (unit_address_vs_reg): /example-0/flash@0: node has a unit name, but no reg or ranges property

See https://patchwork.ozlabs.org/patch/1481605

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.