* [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible
@ 2023-09-27 20:20 Simon Glass
2023-09-27 20:20 ` [PATCH 2/3] dt-bindings: mtd: binman-partition: Add binman labels Simon Glass
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Simon Glass @ 2023-09-27 20:20 UTC (permalink / raw)
To: devicetree
Cc: linux-mtd, U-Boot Mailing List, Tom Rini, Rob Herring,
Simon Glass, Conor Dooley, Dhruva Gole, Krzysztof Kozlowski,
Miquel Raynal, Pratyush Yadav, Rafał Miłecki,
Richard Weinberger, Rob Herring, Vignesh Raghavendra,
linux-kernel
Add a compatible string for binman, so we can extend fixed-partitions
in various ways.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
.../bindings/mtd/partitions/binman.yaml | 49 +++++++++++++++++++
.../mtd/partitions/fixed-partitions.yaml | 6 +++
.../bindings/mtd/partitions/partitions.yaml | 1 +
MAINTAINERS | 5 ++
4 files changed, 61 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mtd/partitions/binman.yaml
diff --git a/Documentation/devicetree/bindings/mtd/partitions/binman.yaml b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
new file mode 100644
index 000000000000..34fd10c1a318
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Google LLC
+
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/binman.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Binman firmware layout
+
+maintainers:
+ - Simon Glass <sjg@chromium.org>
+
+select: false
+
+description: |
+ The binman node provides a layout for firmware, used when packaging firmware
+ from multiple projects. It is based on fixed-partitions, with some
+ extensions.
+
+ Documentation for Binman is available at:
+
+ https://u-boot.readthedocs.io/en/latest/develop/package/binman.html
+
+ with the current image-description format at:
+
+ https://u-boot.readthedocs.io/en/latest/develop/package/binman.html#image-description-format
+
+allOf:
+ - $ref: /schemas/mtd/partitions/fixed-partitions.yaml#
+
+properties:
+ compatible:
+ const: binman
+
+additionalProperties: false
+
+examples:
+ - |
+ partitions {
+ compatible = "binman", "fixed-partitions";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ partition-u-boot@100000 {
+ label = "u-boot";
+ reg = <0x100000 0xf00000>;
+ };
+ };
diff --git a/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml b/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml
index 331e564f29dc..1c04bc2b95af 100644
--- a/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml
+++ b/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml
@@ -14,6 +14,9 @@ description: |
The partition table should be a node named "partitions". Partitions are then
defined as subnodes.
+ The Binman tool provides some enhanced features, so provides a compatible
+ string to indicate that these are permitted.
+
maintainers:
- Rafał Miłecki <rafal@milecki.pl>
@@ -24,6 +27,9 @@ properties:
- items:
- const: sercomm,sc-partitions
- const: fixed-partitions
+ - items:
+ - const: binman
+ - const: fixed-partitions
"#address-cells": true
diff --git a/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml b/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml
index 1dda2c80747b..849fd15d085c 100644
--- a/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml
+++ b/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml
@@ -15,6 +15,7 @@ maintainers:
oneOf:
- $ref: arm,arm-firmware-suite.yaml
+ - $ref: binman.yaml
- $ref: brcm,bcm4908-partitions.yaml
- $ref: brcm,bcm947xx-cfe-partitions.yaml
- $ref: fixed-partitions.yaml
diff --git a/MAINTAINERS b/MAINTAINERS
index 5f18c6ba3c3c..367c843ec348 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3517,6 +3517,11 @@ F: Documentation/filesystems/bfs.rst
F: fs/bfs/
F: include/uapi/linux/bfs_fs.h
+BINMAN
+M: Simon Glass <sjg@chromium.org>
+S: Supported
+F: Documentation/devicetree/bindings/mtd/partitions/binman*
+
BITMAP API
M: Yury Norov <yury.norov@gmail.com>
R: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
--
2.42.0.515.g380fc7ccd1-goog
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 2/3] dt-bindings: mtd: binman-partition: Add binman labels
2023-09-27 20:20 [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Simon Glass
@ 2023-09-27 20:20 ` Simon Glass
2023-09-27 20:20 ` [PATCH 3/3] dt-bindings: mtd: binman-partitions: Add alignment properties Simon Glass
2023-10-01 17:07 ` [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Miquel Raynal
2 siblings, 0 replies; 4+ messages in thread
From: Simon Glass @ 2023-09-27 20:20 UTC (permalink / raw)
To: devicetree
Cc: linux-mtd, U-Boot Mailing List, Tom Rini, Rob Herring,
Simon Glass, Conor Dooley, Krzysztof Kozlowski, Miquel Raynal,
Richard Weinberger, Rob Herring, Vignesh Raghavendra,
linux-kernel
Add two labels for binman entries, as a starting point for the schema.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
.../mtd/partitions/binman-partition.yaml | 48 +++++++++++++++++++
1 file changed, 48 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml
diff --git a/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml
new file mode 100644
index 000000000000..6ee832cb4c4c
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Google LLC
+
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/binman-partition.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Binman partition
+
+maintainers:
+ - Simon Glass <sjg@chromium.org>
+
+select: false
+
+description: |
+ This corresponds to a binman 'entry'. It is a single partition which holds
+ data of a defined type.
+
+allOf:
+ - $ref: /schemas/mtd/partitions/partition.yaml#
+
+properties:
+ label:
+ items:
+ enum:
+ - u-boot # u-boot.bin from U-Boot projec6t
+ - atf-bl31 # bl31.bin or bl31.elf from TF-A project
+
+additionalProperties: false
+
+examples:
+ - |
+ partitions {
+ compatible = "binman", "fixed-partitions";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ partition-u-boot@100000 {
+ label = "u-boot";
+ reg = <0x100000 0xf00000>;
+ };
+
+ partition-atf-bl31t@200000 {
+ label = "atf-bl31";
+ reg = <0x200000 0x100000>;
+ };
+ };
--
2.42.0.515.g380fc7ccd1-goog
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 3/3] dt-bindings: mtd: binman-partitions: Add alignment properties
2023-09-27 20:20 [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Simon Glass
2023-09-27 20:20 ` [PATCH 2/3] dt-bindings: mtd: binman-partition: Add binman labels Simon Glass
@ 2023-09-27 20:20 ` Simon Glass
2023-10-01 17:07 ` [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Miquel Raynal
2 siblings, 0 replies; 4+ messages in thread
From: Simon Glass @ 2023-09-27 20:20 UTC (permalink / raw)
To: devicetree
Cc: linux-mtd, U-Boot Mailing List, Tom Rini, Rob Herring,
Simon Glass, Conor Dooley, Krzysztof Kozlowski, Miquel Raynal,
Richard Weinberger, Rob Herring, Vignesh Raghavendra,
linux-kernel
Add three properties for controlling alignment of partitions, aka
'entries' in binman.
For now there is no explicit mention of hierarchy, so a 'section' is
just the 'fixed-partitions' node.
These new properties are inputs to the packaging process, but are also
needed if the firmware is repacked, to ensure that alignment
constraints are not violated. Therefore they a provided as part of the
schema.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
.../mtd/partitions/binman-partition.yaml | 39 +++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml
index 6ee832cb4c4c..9cd424447e76 100644
--- a/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml
+++ b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml
@@ -27,6 +27,42 @@ properties:
- u-boot # u-boot.bin from U-Boot projec6t
- atf-bl31 # bl31.bin or bl31.elf from TF-A project
+ align:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ This sets the alignment of the entry. The entry offset is adjusted
+ so that the entry starts on an aligned boundary within the containing
+ section or image. For example ‘align = <16>’ means that the entry will
+ start on a 16-byte boundary. This may mean that padding is added before
+ the entry. The padding is part of the containing section but is not
+ included in the entry, meaning that an empty space may be created before
+ the entry starts. Alignment should be a power of 2. If ‘align’ is not
+ provided, no alignment is performed.
+
+ align-size:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ This sets the alignment of the entry size. For example, to ensure
+ that the size of an entry is a multiple of 64 bytes, set this to 64.
+ While this does not affect the contents of the entry within binman
+ itself (the padding is performed only when its parent section is
+ assembled), the end result is that the entry ends with the padding
+ bytes, so may grow. If ‘align-size’ is not provided, no alignment is
+ performed.
+
+ align-end:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ This sets the alignment of the end of an entry with respect to the
+ containing section. Some entries require that they end on an alignment
+ boundary, regardless of where they start. This does not move the start
+ of the entry, so the contents of the entry will still start at the
+ beginning. But there may be padding at the end. While this does not
+ affect the contents of the entry within binman itself (the padding is
+ performed only when its parent section is assembled), the end result is
+ that the entry ends with the padding bytes, so may grow. If ‘align-end’
+ is not provided, no alignment is performed.
+
additionalProperties: false
examples:
@@ -39,10 +75,13 @@ examples:
partition-u-boot@100000 {
label = "u-boot";
reg = <0x100000 0xf00000>;
+ align-size = <0x1000>;
+ align-end = <0x10000>;
};
partition-atf-bl31t@200000 {
label = "atf-bl31";
reg = <0x200000 0x100000>;
+ align = <0x4000>;
};
};
--
2.42.0.515.g380fc7ccd1-goog
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible
2023-09-27 20:20 [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Simon Glass
2023-09-27 20:20 ` [PATCH 2/3] dt-bindings: mtd: binman-partition: Add binman labels Simon Glass
2023-09-27 20:20 ` [PATCH 3/3] dt-bindings: mtd: binman-partitions: Add alignment properties Simon Glass
@ 2023-10-01 17:07 ` Miquel Raynal
2 siblings, 0 replies; 4+ messages in thread
From: Miquel Raynal @ 2023-10-01 17:07 UTC (permalink / raw)
To: Simon Glass
Cc: devicetree, linux-mtd, U-Boot Mailing List, Tom Rini, Rob Herring,
Conor Dooley, Dhruva Gole, Krzysztof Kozlowski, Pratyush Yadav,
Rafał Miłecki, Richard Weinberger, Rob Herring,
Vignesh Raghavendra, linux-kernel
Hi Simon,
sjg@chromium.org wrote on Wed, 27 Sep 2023 14:20:51 -0600:
> Add a compatible string for binman, so we can extend fixed-partitions
> in various ways.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
> .../bindings/mtd/partitions/binman.yaml | 49 +++++++++++++++++++
> .../mtd/partitions/fixed-partitions.yaml | 6 +++
> .../bindings/mtd/partitions/partitions.yaml | 1 +
> MAINTAINERS | 5 ++
> 4 files changed, 61 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mtd/partitions/binman.yaml
>
> diff --git a/Documentation/devicetree/bindings/mtd/partitions/binman.yaml b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
> new file mode 100644
> index 000000000000..34fd10c1a318
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2023 Google LLC
> +
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mtd/partitions/binman.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Binman firmware layout
> +
> +maintainers:
> + - Simon Glass <sjg@chromium.org>
> +
> +select: false
> +
> +description: |
> + The binman node provides a layout for firmware, used when packaging firmware
> + from multiple projects. It is based on fixed-partitions, with some
> + extensions.
Could you mention the input file vs. output file and which one this
binding describes?
> +
> + Documentation for Binman is available at:
> +
> + https://u-boot.readthedocs.io/en/latest/develop/package/binman.html
> +
> + with the current image-description format at:
> +
> + https://u-boot.readthedocs.io/en/latest/develop/package/binman.html#image-description-format
> +
> +allOf:
> + - $ref: /schemas/mtd/partitions/fixed-partitions.yaml#
> +
> +properties:
> + compatible:
> + const: binman
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + partitions {
> + compatible = "binman", "fixed-partitions";
> + #address-cells = <1>;
> + #size-cells = <1>;
> +
> + partition-u-boot@100000 {
Do you mind if we avoid playing with the node name? I would prefer:
partition@100000 {
label = "foo";
> + label = "u-boot";
> + reg = <0x100000 0xf00000>;
> + };
> + };
> diff --git a/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml b/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml
> index 331e564f29dc..1c04bc2b95af 100644
> --- a/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml
> +++ b/Documentation/devicetree/bindings/mtd/partitions/fixed-partitions.yaml
> @@ -14,6 +14,9 @@ description: |
> The partition table should be a node named "partitions". Partitions are then
> defined as subnodes.
>
> + The Binman tool provides some enhanced features, so provides a compatible
> + string to indicate that these are permitted.
I believe this is not necessary and is implied by the $ref in
partitions.yaml.
> maintainers:
> - Rafał Miłecki <rafal@milecki.pl>
>
> @@ -24,6 +27,9 @@ properties:
> - items:
> - const: sercomm,sc-partitions
> - const: fixed-partitions
> + - items:
> + - const: binman
> + - const: fixed-partitions
>
> "#address-cells": true
>
> diff --git a/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml b/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml
> index 1dda2c80747b..849fd15d085c 100644
> --- a/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml
> +++ b/Documentation/devicetree/bindings/mtd/partitions/partitions.yaml
> @@ -15,6 +15,7 @@ maintainers:
>
> oneOf:
> - $ref: arm,arm-firmware-suite.yaml
> + - $ref: binman.yaml
> - $ref: brcm,bcm4908-partitions.yaml
> - $ref: brcm,bcm947xx-cfe-partitions.yaml
> - $ref: fixed-partitions.yaml
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5f18c6ba3c3c..367c843ec348 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3517,6 +3517,11 @@ F: Documentation/filesystems/bfs.rst
> F: fs/bfs/
> F: include/uapi/linux/bfs_fs.h
>
> +BINMAN
> +M: Simon Glass <sjg@chromium.org>
> +S: Supported
> +F: Documentation/devicetree/bindings/mtd/partitions/binman*
> +
> BITMAP API
> M: Yury Norov <yury.norov@gmail.com>
> R: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
The rest of the series otherwise lgtm.
Thanks,
Miquèl
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-10-01 17:07 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-27 20:20 [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Simon Glass
2023-09-27 20:20 ` [PATCH 2/3] dt-bindings: mtd: binman-partition: Add binman labels Simon Glass
2023-09-27 20:20 ` [PATCH 3/3] dt-bindings: mtd: binman-partitions: Add alignment properties Simon Glass
2023-10-01 17:07 ` [PATCH 1/3] dt-bindings: mtd: fixed-partitions: Add binman compatible Miquel Raynal
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).