Add three properties for controlling alignment of partitions, aka
'entries' in fixed-partition.
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 Binman packaging process, but are
also needed if the firmware is repacked, to ensure that alignment
constraints are not violated. Therefore they are provided as part of
the schema.
Signed-off-by: Simon Glass <[email protected]>
---
Changes in v9:
- Move binding example to next batch to avoid build error
Changes in v7:
- Drop patch 'Add binman compatible'
- Put the alignment properties into the fixed-partition binding
Changes in v6:
- Correct schema-validation errors missed due to older dt-schema
(enum fix and reg addition)
Changes in v5:
- Add value ranges
- Consistently mention alignment must be power-of-2
- Mention that alignment refers to bytes
Changes in v2:
- Fix 'a' typo in commit message
.../bindings/mtd/partitions/partition.yaml | 51 +++++++++++++++++++
1 file changed, 51 insertions(+)
diff --git a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
index 1ebe9e2347ea..39c7d7672783 100644
--- a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
+++ b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
@@ -57,6 +57,57 @@ properties:
user space from
type: boolean
+ align:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 1
+ maximum: 0x80000000
+ multipleOf: 2
+ description:
+ This sets the alignment of the entry in bytes.
+
+ 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
+ must be a power of 2. If ‘align’ is not provided, no alignment is
+ performed.
+
+ align-size:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 1
+ maximum: 0x80000000
+ multipleOf: 2
+ description:
+ This sets the alignment of the entry size in bytes. It must be a power
+ of 2.
+
+ 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
+ minimum: 1
+ maximum: 0x80000000
+ multipleOf: 2
+ description:
+ This sets the alignment (in bytes) of the end of an entry with respect
+ to the containing section. It must be a power of 2.
+
+ 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.
+
if:
not:
required: [ reg ]
--
2.34.1
Add two compatibles for binman entries, as a starting point for the
schema.
Note that, after discussion on v2, we decided to keep the existing
meaning of label so as not to require changes to existing userspace
software when moving to use binman nodes to specify the firmware
layout.
Note also that, after discussion on v6, we decided to use the same
'fixed-partition' schema for the binman features, so this version
adds a new 'binman.yaml' file providing the new compatibles to the
existing partition.yaml binding.
Signed-off-by: Simon Glass <[email protected]>
---
(no changes since v8)
Changes in v8:
- Switch the patch ordering so the partition change comes first
Changes in v7:
- Adjust MAINTAINERS entry
- Put compatible strings into the 'fixed-partition' binding
Changes in v5:
- Add mention of why 'binman' is the vendor
- Drop 'select: false'
- Tidy up the compatible setings
- Use 'tfa-bl31' instead of 'atf-bl31'
Changes in v4:
- Correct selection of multiple compatible strings
Changes in v3:
- Drop fixed-partitions from the example
- Use compatible instead of label
Changes in v2:
- Use plain partition@xxx for the node name
.../bindings/mtd/partitions/binman.yaml | 49 +++++++++++++++++++
.../bindings/mtd/partitions/partition.yaml | 21 ++++++++
MAINTAINERS | 5 ++
3 files changed, 75 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..83417ad5cee9
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/binman.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Binman entries
+
+description: |
+ TBD
+
+maintainers:
+ - Simon Glass <[email protected]>
+
+allOf:
+ - $ref: /schemas/mtd/partitions/partition.yaml#
+
+properties:
+ compatible:
+ enum:
+ - binman,entry # generic binman entry
+ - u-boot # u-boot.bin from U-Boot project
+ - tfa-bl31 # bl31.bin or bl31.elf from TF-A project
+
+required:
+ - compatible
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ partitions {
+ compatible = "fixed-partitions";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ partition@100000 {
+ compatible = "u-boot";
+ reg = <0x100000 0xf00000>;
+ align-size = <0x1000>;
+ align-end = <0x10000>;
+ };
+
+ partition@200000 {
+ compatible = "tfa-bl31";
+ reg = <0x200000 0x100000>;
+ align = <0x4000>;
+ };
+ };
diff --git a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
index 39c7d7672783..3df12df06116 100644
--- a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
+++ b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
@@ -118,3 +118,24 @@ then:
# This is a generic file other binding inherit from and extend
additionalProperties: true
+
+examples:
+ - |
+ partitions {
+ compatible = "fixed-partitions";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ partition@100000 {
+ compatible = "u-boot";
+ reg = <0x100000 0xf00000>;
+ align-size = <0x1000>;
+ align-end = <0x10000>;
+ };
+
+ partition@200000 {
+ compatible = "tfa-bl31";
+ reg = <0x200000 0x100000>;
+ align = <0x4000>;
+ };
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index b43102ca365d..5b08ee363140 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3610,6 +3610,11 @@ F: Documentation/filesystems/bfs.rst
F: fs/bfs/
F: include/uapi/linux/bfs_fs.h
+BINMAN
+M: Simon Glass <[email protected]>
+S: Supported
+F: Documentation/devicetree/bindings/mtd/partitions/binman*
+
BITMAP API
M: Yury Norov <[email protected]>
R: Rasmus Villemoes <[email protected]>
--
2.34.1
On Wed, Mar 20, 2024 at 06:24:48PM +1300, Simon Glass wrote:
> Add three properties for controlling alignment of partitions, aka
> 'entries' in fixed-partition.
>
> 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 Binman packaging process, but are
> also needed if the firmware is repacked, to ensure that alignment
> constraints are not violated. Therefore they are provided as part of
> the schema.
>
> Signed-off-by: Simon Glass <[email protected]>
> ---
>
> Changes in v9:
> - Move binding example to next batch to avoid build error
>
> Changes in v7:
> - Drop patch 'Add binman compatible'
> - Put the alignment properties into the fixed-partition binding
>
> Changes in v6:
> - Correct schema-validation errors missed due to older dt-schema
> (enum fix and reg addition)
>
> Changes in v5:
> - Add value ranges
> - Consistently mention alignment must be power-of-2
> - Mention that alignment refers to bytes
>
> Changes in v2:
> - Fix 'a' typo in commit message
>
> .../bindings/mtd/partitions/partition.yaml | 51 +++++++++++++++++++
> 1 file changed, 51 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
> index 1ebe9e2347ea..39c7d7672783 100644
> --- a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
> +++ b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
> @@ -57,6 +57,57 @@ properties:
> user space from
> type: boolean
>
> + align:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + minimum: 1
Shouldn't this and the others be 2?
Otherwise,
Reviewed-by: Rob Herring <[email protected]>
On Wed, Mar 20, 2024 at 06:24:49PM +1300, Simon Glass wrote:
> Add two compatibles for binman entries, as a starting point for the
> schema.
>
> Note that, after discussion on v2, we decided to keep the existing
> meaning of label so as not to require changes to existing userspace
> software when moving to use binman nodes to specify the firmware
> layout.
>
> Note also that, after discussion on v6, we decided to use the same
> 'fixed-partition' schema for the binman features, so this version
> adds a new 'binman.yaml' file providing the new compatibles to the
> existing partition.yaml binding.
>
> Signed-off-by: Simon Glass <[email protected]>
> ---
>
> (no changes since v8)
>
> Changes in v8:
> - Switch the patch ordering so the partition change comes first
>
> Changes in v7:
> - Adjust MAINTAINERS entry
> - Put compatible strings into the 'fixed-partition' binding
>
> Changes in v5:
> - Add mention of why 'binman' is the vendor
> - Drop 'select: false'
> - Tidy up the compatible setings
> - Use 'tfa-bl31' instead of 'atf-bl31'
>
> Changes in v4:
> - Correct selection of multiple compatible strings
>
> Changes in v3:
> - Drop fixed-partitions from the example
> - Use compatible instead of label
>
> Changes in v2:
> - Use plain partition@xxx for the node name
>
> .../bindings/mtd/partitions/binman.yaml | 49 +++++++++++++++++++
> .../bindings/mtd/partitions/partition.yaml | 21 ++++++++
> MAINTAINERS | 5 ++
> 3 files changed, 75 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..83417ad5cee9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mtd/partitions/binman.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Binman entries
> +
> +description: |
> + TBD
?
> +
> +maintainers:
> + - Simon Glass <[email protected]>
> +
> +allOf:
> + - $ref: /schemas/mtd/partitions/partition.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - binman,entry # generic binman entry
As-is, 'binman' would need to be added to vendor-prefixes.yaml.
However, I think just 'binman' would provide just as much information.
But really, does it provide anything? What would be the difference
between this and no compatible?
Rob
Hi Rob,
On Fri, 22 Mar 2024 at 02:39, Rob Herring <[email protected]> wrote:
>
> On Wed, Mar 20, 2024 at 06:24:48PM +1300, Simon Glass wrote:
> > Add three properties for controlling alignment of partitions, aka
> > 'entries' in fixed-partition.
> >
> > 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 Binman packaging process, but are
> > also needed if the firmware is repacked, to ensure that alignment
> > constraints are not violated. Therefore they are provided as part of
> > the schema.
> >
> > Signed-off-by: Simon Glass <[email protected]>
> > ---
> >
> > Changes in v9:
> > - Move binding example to next batch to avoid build error
> >
> > Changes in v7:
> > - Drop patch 'Add binman compatible'
> > - Put the alignment properties into the fixed-partition binding
> >
> > Changes in v6:
> > - Correct schema-validation errors missed due to older dt-schema
> > (enum fix and reg addition)
> >
> > Changes in v5:
> > - Add value ranges
> > - Consistently mention alignment must be power-of-2
> > - Mention that alignment refers to bytes
> >
> > Changes in v2:
> > - Fix 'a' typo in commit message
> >
> > .../bindings/mtd/partitions/partition.yaml | 51 +++++++++++++++++++
> > 1 file changed, 51 insertions(+)
> >
> > diff --git a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
> > index 1ebe9e2347ea..39c7d7672783 100644
> > --- a/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
> > +++ b/Documentation/devicetree/bindings/mtd/partitions/partition.yaml
> > @@ -57,6 +57,57 @@ properties:
> > user space from
> > type: boolean
> >
> > + align:
> > + $ref: /schemas/types.yaml#/definitions/uint32
> > + minimum: 1
>
> Shouldn't this and the others be 2?
It could be, but 1 means that there is no alignment and is a valid
value. I don't mind changing it if you like.
>
> Otherwise,
>
> Reviewed-by: Rob Herring <[email protected]>
Hi Rob,
On Fri, 22 Mar 2024 at 02:49, Rob Herring <[email protected]> wrote:
>
> On Wed, Mar 20, 2024 at 06:24:49PM +1300, Simon Glass wrote:
> > Add two compatibles for binman entries, as a starting point for the
> > schema.
> >
> > Note that, after discussion on v2, we decided to keep the existing
> > meaning of label so as not to require changes to existing userspace
> > software when moving to use binman nodes to specify the firmware
> > layout.
> >
> > Note also that, after discussion on v6, we decided to use the same
> > 'fixed-partition' schema for the binman features, so this version
> > adds a new 'binman.yaml' file providing the new compatibles to the
> > existing partition.yaml binding.
> >
> > Signed-off-by: Simon Glass <[email protected]>
> > ---
> >
> > (no changes since v8)
> >
> > Changes in v8:
> > - Switch the patch ordering so the partition change comes first
> >
> > Changes in v7:
> > - Adjust MAINTAINERS entry
> > - Put compatible strings into the 'fixed-partition' binding
> >
> > Changes in v5:
> > - Add mention of why 'binman' is the vendor
> > - Drop 'select: false'
> > - Tidy up the compatible setings
> > - Use 'tfa-bl31' instead of 'atf-bl31'
> >
> > Changes in v4:
> > - Correct selection of multiple compatible strings
> >
> > Changes in v3:
> > - Drop fixed-partitions from the example
> > - Use compatible instead of label
> >
> > Changes in v2:
> > - Use plain partition@xxx for the node name
> >
> > .../bindings/mtd/partitions/binman.yaml | 49 +++++++++++++++++++
> > .../bindings/mtd/partitions/partition.yaml | 21 ++++++++
> > MAINTAINERS | 5 ++
> > 3 files changed, 75 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..83417ad5cee9
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mtd/partitions/binman.yaml
> > @@ -0,0 +1,49 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/mtd/partitions/binman.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Binman entries
> > +
> > +description: |
> > + TBD
>
> ?
Oh yes, I forgot to put that back when I reworked all these again.
>
> > +
> > +maintainers:
> > + - Simon Glass <[email protected]>
> > +
> > +allOf:
> > + - $ref: /schemas/mtd/partitions/partition.yaml#
> > +
> > +properties:
> > + compatible:
> > + enum:
> > + - binman,entry # generic binman entry
>
> As-is, 'binman' would need to be added to vendor-prefixes.yaml.
>
> However, I think just 'binman' would provide just as much information.
> But really, does it provide anything? What would be the difference
> between this and no compatible?
In Binman this is the base class ('entry') for all entry types that it
understands. I don't expect we would actually use this since it does
not define what the contents are.
So I can remove this line.
Regards,
Simon