Hi Rob,

On Tue, 24 Oct 2023 at 09:16, Rob Herring robh@kernel.org wrote:

On Mon, Oct 09, 2023 at 04:04:14PM -0600, Simon Glass wrote:

...

Add two compatible 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.

Signed-off-by: Simon Glass sjg@chromium.org

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

.../mtd/partitions/binman-partition.yaml | 49 +++++++++++++++++++ 1 file changed, 49 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..35a320359ec1 --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.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-partition.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#

+title: Binman partition

+maintainers:

• • Simon Glass sjg@chromium.org

+select: false

So this schema is never used. 'select: false' is only useful if something else if referencing the schema.

OK. Is there a user guide to this somewhere? I really don't understand it very well.

...

+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:

• compatible:
• oneOf:

•  - const: binman,entry     # generic binman entry
  

'binman' is not a vendor. You could add it if you think that's useful. Probably not with only 1 case...

I think it is best to use this for generic things implemented by binman, rather than some other project. For example, binman supports a 'fill' region. It also supports sections which are groups of sub-entries. So we will likely start with half a dozen of these and it will likely grow: binman,fill, binman,section, binman,files

If we don't use 'binman', what do you suggest?

...

•  - items:
  

•      - const: u-boot       # u-boot.bin from U-Boot project
  

•      - const: atf-bl31     # bl31.bin or bl31.elf from TF-A project
  

Probably should use the new 'tfa' rather than old 'atf'. Is this the only binary for TFA? The naming seems inconsistent in that every image goes in (or can go in) a bl?? section. Why does TFA have it but u-boot doesn't? Perhaps BL?? is orthogonal to defining what is in each partition. Perhaps someone more familar with all this than I am can comment.

From what I can tell TF-A can produce all sorts of binaries, of which

bl31 is one. U-Boot can also produce lots of binaries, but its naming is different (u-boot, u-boot-spl, etc.). Bear in mind that U-Boot is used on ARM, where this terminology is defined, and on x86 (for example), where it is not.

Once you actually test this, you'll find you are specifying:

compatible = "u-boot", "atf-bl31";

I don't understand that, sorry. I'll send a v5 and see if the problem goes away.

...

+additionalProperties: false

+examples:

• • |
• partitions {

•    compatible = "binman";
  

•    #address-cells = <1>;
  

•    #size-cells = <1>;
  

•    partition@100000 {
  

•        compatible = "u-boot";
  

•        reg = <0x100000 0xf00000>;
  

•    };
  

•    partition@200000 {
  

•        compatible = "atf-bl31";
  

•        reg = <0x200000 0x100000>;
  

•    };
  

• };

-- 2.42.0.609.gbb76f46606-goog

Regards, Simon

Hi Miquel,

On Wed, 25 Oct 2023 at 08:11, Miquel Raynal miquel.raynal@bootlin.com wrote:

Hi Simon,

sjg@chromium.org wrote on Tue, 24 Oct 2023 14:40:54 -0700:

...

Hi Rob,

On Tue, 24 Oct 2023 at 09:16, Rob Herring robh@kernel.org wrote:

...

On Mon, Oct 09, 2023 at 04:04:14PM -0600, Simon Glass wrote:

...

Add two compatible 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.

Signed-off-by: Simon Glass sjg@chromium.org

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

.../mtd/partitions/binman-partition.yaml | 49 +++++++++++++++++++ 1 file changed, 49 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..35a320359ec1 --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.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-partition.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#

+title: Binman partition

+maintainers:

• • Simon Glass sjg@chromium.org

+select: false

So this schema is never used. 'select: false' is only useful if something else if referencing the schema.

OK. Is there a user guide to this somewhere? I really don't understand it very well.

The example-schema.yaml at the root of the dt-bindings directory is well commented.

OK I had forgotten about that, thank you.

...

...

...

+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:

• compatible:
• oneOf:

•  - const: binman,entry     # generic binman entry
  

'binman' is not a vendor. You could add it if you think that's useful. Probably not with only 1 case...

I think it is best to use this for generic things implemented by binman, rather than some other project. For example, binman supports a 'fill' region. It also supports sections which are groups of sub-entries. So we will likely start with half a dozen of these and it will likely grow: binman,fill, binman,section, binman,files

If we don't use 'binman', what do you suggest?

...

...

•  - items:
  

•      - const: u-boot       # u-boot.bin from U-Boot project
  

•      - const: atf-bl31     # bl31.bin or bl31.elf from TF-A project
  

Probably should use the new 'tfa' rather than old 'atf'. Is this the only binary for TFA? The naming seems inconsistent in that every image goes in (or can go in) a bl?? section. Why does TFA have it but u-boot doesn't? Perhaps BL?? is orthogonal to defining what is in each partition. Perhaps someone more familar with all this than I am can comment.

From what I can tell TF-A can produce all sorts of binaries, of which bl31 is one. U-Boot can also produce lots of binaries, but its naming is different (u-boot, u-boot-spl, etc.). Bear in mind that U-Boot is used on ARM, where this terminology is defined, and on x86 (for example), where it is not.

...

Once you actually test this, you'll find you are specifying:

compatible = "u-boot", "atf-bl31";

I don't understand that, sorry. I'll send a v5 and see if the problem goes away.

For me this means the partition contains U-Boot and TF-A, which is probably not what you want. I believe Rob is saying that how you define the compatible property above does not match the examples below. Did you run make dt_binding_check?

Yes, but I have not been able to install the correct version with 'pip install'. So the check about not being an object did not appear for me.

I have now figured out how to run the latest version locally with the Linux validation, so will fix these problems in v6.

Also, do you really need to say which software project provides a component? Would using "bl31", "bl33", etc be enough? Or maybe you could have eg. "bl31-tf-a" and "bl31-u-boot-spl" (in this order) for clarity? This way one knows which stage a partition contains and also the software project which provided it.

The software project tells binman the filename to pick up and any processing it might need to use. It is quite an important element of this schema. Bear in mind that Binman assembles the image...so it must read in the various files that are needed.

The bl31 terminology is used by ARM but not x86. So using bl31 in the context of U-Boot would be quite confusing on non-ARM SoCs.

For the stage (or what I call Phase), I have not considered that yet. The purpose of adding 'bl31' is because TF-A (like U-Boot) produces a few binaries so we need to specify which one is wanted, which in turn leads to the filename. We do have the concept of a boot phase in DT (bootph-pre-ram for example), so I hope to integrate that at some point, for runtime use. But for the purposes of assembling the image, it doesn't matter when the phase runs...all that matters is being able to read in the files which need to be assembled into the image.

To be honest I still don't fully get where you want to go and I believe a more complete schema would probably help, with different examples, to catch what you need and why.

The full schema is described at [1] and [2]. Note that this may need to change as I slowly upstream it. The top of [1] describes the motivation for binman and there is a more detailed talk at [3].

So far I am just trying to describe two things:

- U-Boot (u-boot.bin) - TF-A BL31 (bl31.elf)

I am doing things in baby steps because even that is quite a challenge. But I think the linked docs should help explain where it is heading.

...

...

...

+additionalProperties: false

+examples:

• • |
• partitions {

•    compatible = "binman";
  

•    #address-cells = <1>;
  

•    #size-cells = <1>;
  

•    partition@100000 {
  

•        compatible = "u-boot";
  

•        reg = <0x100000 0xf00000>;
  

•    };
  

•    partition@200000 {
  

•        compatible = "atf-bl31";
  

•        reg = <0x200000 0x100000>;
  

•    };
  

• };

-- 2.42.0.609.gbb76f46606-goog

Regards, SImon

[1] https://u-boot.readthedocs.io/en/latest/develop/package/binman.html#image-de... [2] https://u-boot.readthedocs.io/en/latest/develop/package/binman.html#entry-do... [3] https://elinux.org/Boot_Loaders#U-Boot

On Mon, Oct 09, 2023 at 04:04:15PM -0600, Simon Glass wrote:

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 'binman' 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 are provided as part of the schema.

Signed-off-by: Simon Glass sjg@chromium.org

(no changes since v2)

Changes in v2:

• Fix 'a' typo in commit message

.../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 35a320359ec1..8e8a3b6d4d14 100644 --- a/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml +++ b/Documentation/devicetree/bindings/mtd/partitions/binman-partition.yaml @@ -28,6 +28,42 @@ properties: - const: u-boot # u-boot.bin from U-Boot project - const: 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
  

Only your example defines that alignment is in bytes.

•  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.
  

Would be nice to have some constraints. Unfortunately, no way to say 'power of 2' in json-schema (we could add something possibly), so the only way is:

enum: [ 2, 4, 8, 16, 32, 64, ... ]

Kind of verbose if we add all 31 possibilities...

Could also do this:

minium: 2 maximum: 0x80000000 multipleOf: 2

• 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: @@ -40,10 +76,13 @@ examples: partition@100000 { compatible = "u-boot"; reg = <0x100000 0xf00000>;

•        align-size = <0x1000>;
  

•        align-end = <0x10000>;
     };
  
     partition@200000 {
         compatible = "atf-bl31";
         reg = <0x200000 0x100000>;
  

•        align = <0x4000>;
     };
  

  };

-- 2.42.0.609.gbb76f46606-goog