Skip to contentSkip to conversation

dt-bindings: mtd: partitions: u-boot: allow dynamic subpartitions

PATCH Applied Rafał Miłecki 3 participants 7 messages Oct 18, 2022 – Oct 31, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v3 1/2 dt-bindings: mtd: partitions: u-boot: allow dynamic subpartitions

From: Rafał Miłecki <[email protected]>

U-Boot partition may contain subpartitions. For example Broadcom includes environment data block in the middle of its U-Boot partition.

This allows describing Broadcom's U-Boot env data and will allow referencing its NVMEM cell in the future.

Reg: 118f3fbe517f4 ("dt-bindings: mtd: partitions: support label/name only partition")
Ref: dd638202dfb65 ("dt-bindings: mtd: partitions: add additional example for qcom,smem-part")

---
V3: Add this patch as pre-requirement for u-boot,env.yaml & brcm,env

---
 .../devicetree/bindings/mtd/partitions/u-boot.yaml         | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/devicetree/bindings/mtd/partitions/u-boot.yaml +7 -0
index 8a88e7d16524..3c56efe48efd 100644
@@ -27,6 +27,10 @@ properties:
           Broadcom stores environment variables inside a U-Boot partition. They
           can be identified by a custom header with magic value.
 
+patternProperties:
+  "^partition-.*$":
+    $ref: partition.yaml#
+
 unevaluatedProperties: false
 
 examples:
@@ -40,6 +44,9 @@ examples:
             compatible = "brcm,u-boot";
             reg = <0x0 0x100000>;
             label = "u-boot";
+
+            partition-u-boot-env {
+            };
         };
 
         partition@100000 {
Signature · 1 line
2.34.1
#1 lore raw

PATCH v3 2/2 dt-bindings: nvmem: u-boot,env: add Broadcom's variant binding

From: Rafał Miłecki <[email protected]>

Broadcom uses U-Boot for a lot of their bcmbca familiy chipsets. U-Boot stores its configuration in an environment data block.

Such blocks are usually stored on flash as a separated partition at hardcoded address. Broadcom however decided to:
1. Store env data block inside U-Boot partition
2. Avoid sticking to hardcoded offsets
3. Use custom header with "uEnv" magic and env data length

Example (length 0x4000):

$ hexdump -n 32 -C -s 0x40000 /dev/mtdblock0
00040000  76 6e 45 75 00 40 00 00  34 89 7a 82 49 4d 41 47  |[email protected]|
00040010  45 3d 4e 41 4e 44 3a 31  4d 2c 31 30 32 34 4d 00  |E=NAND:1M,1024M.|
(0x40000 offset is unit specific and can change)

Starting with the commit 118f3fbe517f4 ("dt-bindings: mtd: partitions:
support label/name only partition") DT can describe partitions matching them by a name (without specifying actual address). With that feature and this binding change it's possible to:
1. Specify DT node for Broadcom's U-Boot env data subpartition
2. Add nodes for specific environment data variables
3. Reference them as NVMEM cells

This binding is unlikely to help Broadcom's U-Boot. U-Boot SPL needs to find environment data early (before it accesses DTB) and it does that by looking for an "uEnv" magic. Dirty way.

This binding can however be used by operating systems. It allows describing cleanly U-Boot, its env data and variables. It tells operating system about Broadcom-specific env data so it can parse it.

---
V2: Work on better commit body & add example
V3: Avoid duplicated "mac" label

---
 .../devicetree/bindings/nvmem/u-boot,env.yaml | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)
Documentation/devicetree/bindings/nvmem/u-boot,env.yaml +21 -0
index e96bca99f2d9..cbc5c69fd405 100644
@@ -38,6 +38,8 @@ properties:
         const: u-boot,env-redundant-bool
       - description: Two redundant blocks with active having higher counter
         const: u-boot,env-redundant-count
+      - description: Broadcom's variant with custom header
+        const: brcm,env
 
   reg:
     maxItems: 1
@@ -73,3 +75,22 @@ examples:
             };
         };
     };
+  - |
+    partitions {
+        compatible = "fixed-partitions";
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        partition@0 {
+            reg = <0x0 0x100000>;
+            compatible = "brcm,u-boot";
+            label = "u-boot";
+
+            partition-u-boot-env {
+                compatible = "brcm,env";
+
+                ethaddr {
+                };
+            };
+        };
+    };
Signature · 1 line
2.34.1
maintainer Applied
#2 lore raw

Re: [PATCH V3 2/2] dt-bindings: nvmem: u-boot,env: add Broadcom's variant binding

Quoted 33 lines · Rafał Miłecki

From: Rafał Miłecki <[email protected]>

Broadcom uses U-Boot for a lot of their bcmbca familiy chipsets. U-Boot stores its configuration in an environment data block.

Such blocks are usually stored on flash as a separated partition at hardcoded address. Broadcom however decided to:
1. Store env data block inside U-Boot partition
2. Avoid sticking to hardcoded offsets
3. Use custom header with "uEnv" magic and env data length

Example (length 0x4000):

$ hexdump -n 32 -C -s 0x40000 /dev/mtdblock0
00040000  76 6e 45 75 00 40 00 00  34 89 7a 82 49 4d 41 47  |[email protected]|
00040010  45 3d 4e 41 4e 44 3a 31  4d 2c 31 30 32 34 4d 00  |E=NAND:1M,1024M.|
(0x40000 offset is unit specific and can change)

Starting with the commit 118f3fbe517f4 ("dt-bindings: mtd: partitions:
support label/name only partition") DT can describe partitions matching them by a name (without specifying actual address). With that feature and this binding change it's possible to:
1. Specify DT node for Broadcom's U-Boot env data subpartition
2. Add nodes for specific environment data variables
3. Reference them as NVMEM cells

This binding is unlikely to help Broadcom's U-Boot. U-Boot SPL needs to find environment data early (before it accesses DTB) and it does that by looking for an "uEnv" magic. Dirty way.

This binding can however be used by operating systems. It allows describing cleanly U-Boot, its env data and variables. It tells operating system about Broadcom-specific env data so it can parse it.

Quoted 8 lines

---
V2: Work on better commit body & add example
V3: Avoid duplicated "mac" label

---
 .../devicetree/bindings/nvmem/u-boot,env.yaml | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)

Applied, thanks!

#3 lore raw
In reply to Rafał Miłecki
Quoted 9 lines · Rafał Miłecki

From: Rafał Miłecki <[email protected]>

U-Boot partition may contain subpartitions. For example Broadcom includes environment data block in the middle of its U-Boot partition.

This allows describing Broadcom's U-Boot env data and will allow referencing its NVMEM cell in the future.

Reg: 118f3fbe517f4 ("dt-bindings: mtd: partitions: support label/name only partition")

Pardon my ignorance here, but what is the significance of a "Reg" tag? Thanks,
Conor.

Quoted 36 lines

Ref: dd638202dfb65 ("dt-bindings: mtd: partitions: add additional example for qcom,smem-part")

---
V3: Add this patch as pre-requirement for u-boot,env.yaml & brcm,env

---
 .../devicetree/bindings/mtd/partitions/u-boot.yaml         | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/devicetree/bindings/mtd/partitions/u-boot.yaml +7 -0
index 8a88e7d16524..3c56efe48efd 100644
@@ -27,6 +27,10 @@ properties:
           Broadcom stores environment variables inside a U-Boot partition. They
           can be identified by a custom header with magic value.
 
+patternProperties:
+  "^partition-.*$":
+    $ref: partition.yaml#
+
 unevaluatedProperties: false
 
 examples:
@@ -40,6 +44,9 @@ examples:
             compatible = "brcm,u-boot";
             reg = <0x0 0x100000>;
             label = "u-boot";
+
+            partition-u-boot-env {
+            };
         };
 
         partition@100000 {
Signature · 1 line
2.34.1

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

#4 lore raw
Quoted 6 lines · Conor Dooley
Quoted 5 lines · Rafał Miłecki

From: Rafał Miłecki <[email protected]>

U-Boot partition may contain subpartitions. For example Broadcom includes environment data block in the middle of its U-Boot partition.

Quoted 6 lines
Quoted 4 lines

This allows describing Broadcom's U-Boot env data and will allow referencing its NVMEM cell in the future.

Reg: 118f3fbe517f4 ("dt-bindings: mtd: partitions: support label/name only partition")

Pardon my ignorance here, but what is the significance of a "Reg" tag?

That was meant to be "Ref:" and was meant to show commit that introduced concept of dynamic partitions. I thought it's a new feature not everyone may be familiar with yet. I thought it may help to review this patch.

If that is pointless though could you Rob just drop those tags while applying, please? I guess I'll just let you decide.

Quoted 2 lines
Quoted 2 lines

Ref: dd638202dfb65 ("dt-bindings: mtd: partitions: add additional example for qcom,smem-part")

#5 lore raw
Quoted 10 lines · Rafał Miłecki
Quoted 9 lines · Conor Dooley
Quoted 8 lines · Rafał Miłecki

From: Rafał Miłecki <[email protected]>

U-Boot partition may contain subpartitions. For example Broadcom includes environment data block in the middle of its U-Boot partition.

This allows describing Broadcom's U-Boot env data and will allow referencing its NVMEM cell in the future.

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

Reg: 118f3fbe517f4 ("dt-bindings: mtd: partitions: support label/name only partition")

Pardon my ignorance here, but what is the significance of a "Reg" tag?

That was meant to be "Ref:" and was meant to show commit that introduced concept of dynamic partitions. I thought it's a new feature not everyone may be familiar with yet. I thought it may help to review this patch.

Ah nw, I wasn't sure if it ws a typo or "Reg" short for regression.

Quoted 8 lines

If that is pointless though could you Rob just drop those tags while applying, please? I guess I'll just let you decide.

Quoted 2 lines
Quoted 2 lines

Ref: dd638202dfb65 ("dt-bindings: mtd: partitions: add additional example for qcom,smem-part")

maintainer Applied
#6 lore raw
In reply to Rafał Miłecki
Quoted 8 lines · Rafał Miłecki

From: Rafał Miłecki <[email protected]>

U-Boot partition may contain subpartitions. For example Broadcom includes environment data block in the middle of its U-Boot partition.

This allows describing Broadcom's U-Boot env data and will allow referencing its NVMEM cell in the future.

Quoted 9 lines

Reg: 118f3fbe517f4 ("dt-bindings: mtd: partitions: support label/name only partition")
Ref: dd638202dfb65 ("dt-bindings: mtd: partitions: add additional example for qcom,smem-part")

---
V3: Add this patch as pre-requirement for u-boot,env.yaml & brcm,env

---
 .../devicetree/bindings/mtd/partitions/u-boot.yaml         | 7 +++++++
 1 file changed, 7 insertions(+)

Applied, thanks!