Skip to contentSkip to conversation

mtd: core: add nvmem-cells compatible to parse mtd as nvmem cells

PATCH Superseded Ansuel Smith 2 participants 7 messages Mar 10, 2021 – Mar 11, 2021

Subsystems (3)

v4 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/3 mtd: core: add nvmem-cells compatible to parse mtd as nvmem cells

Partitions that contains the nvmem-cells compatible will register their direct subonodes as nvmem cells and the node will be treated as a nvmem provider.

---
 drivers/mtd/mtdcore.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/mtd/mtdcore.c +2 -1
index 2d6423d89a17..ac1b4f176a17 100644
@@ -531,6 +531,7 @@ static int mtd_nvmem_reg_read(void *priv, unsigned int offset,
 
 static int mtd_nvmem_add(struct mtd_info *mtd)
 {
+	struct device_node *node = mtd_get_of_node(mtd);
 	struct nvmem_config config = {};
 
 	config.id = -1;
@@ -543,7 +544,7 @@ static int mtd_nvmem_add(struct mtd_info *mtd)
 	config.stride = 1;
 	config.read_only = true;
 	config.root_only = true;
-	config.no_of_node = true;
+	config.no_of_node = !of_device_is_compatible(node, "nvmem-cells");
 	config.priv = mtd;
 
 	mtd->nvmem = nvmem_register(&config);
Signature · 1 line
2.30.0
#1 lore raw

PATCH v4 2/3 dt-bindings: mtd: Document use of nvmem-cells compatible

Document nvmem-cells compatible used to treat mtd partitions as a nvmem provider.

---
 .../bindings/mtd/partitions/nvmem-cells.yaml  | 96 +++++++++++++++++++
 1 file changed, 96 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +96 -0
new file mode 100644
index 000000000000..f70d7597a6b0
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/nvmem-cells.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nvmem cells
+
+description: |
+  Any partition containing the compatible "nvmem-cells" will register as a
+  nvmem provider.
+  Each direct subnodes represents a nvmem cell following the nvmem binding.
+  Nvmem binding to declare nvmem-cells can be found in:
+  Documentation/devicetree/bindings/nvmem/nvmem.yaml
+
+maintainers:
+  - Ansuel Smith <[email protected]>
+
+properties:
+  compatible:
+    const: nvmem-cells
+
+required:
+  - compatible
+
+additionalProperties: true
+
+examples:
+  - |
+    partitions {
+      compatible = "fixed-partitions";
+      #address-cells = <1>;
+      #size-cells = <1>;
+
+      /* ... */
+
+      };
+      art: art@1200000 {
+        compatible = "nvmem-cells";
+        reg = <0x1200000 0x0140000>;
+        label = "art";
+        read-only;
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        macaddr_gmac1: macaddr_gmac1@0 {
+          reg = <0x0 0x6>;
+        };
+
+        macaddr_gmac2: macaddr_gmac2@6 {
+          reg = <0x6 0x6>;
+        };
+
+        pre_cal_24g: pre_cal_24g@1000 {
+          reg = <0x1000 0x2f20>;
+        };
+
+        pre_cal_5g: pre_cal_5g@5000{
+          reg = <0x5000 0x2f20>;
+        };
+      };
+  - |
+    partitions {
+        compatible = "fixed-partitions";
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        partition@0 {
+            label = "bootloader";
+            reg = <0x000000 0x100000>;
+            read-only;
+        };
+
+        firmware@100000 {
+            compatible = "brcm,trx";
+            label = "firmware";
+            reg = <0x100000 0xe00000>;
+        };
+
+        calibration@f00000 {
+            compatible = "nvmem-cells";
+            label = "calibration";
+            reg = <0xf00000 0x100000>;
+            ranges = <0 0xf00000 0x100000>;
+            #address-cells = <1>;
+            #size-cells = <1>;
+
+            wifi0@0 {
+                reg = <0x000000 0x080000>;
+            };
+
+            wifi1@80000 {
+                reg = <0x080000 0x080000>;
+            };
+        };
+    };
Signature · 1 line
2.30.0
#2 lore raw

Re: [PATCH v4 2/3] dt-bindings: mtd: Document use of nvmem-cells compatible

See inline

Quoted 22 lines · Ansuel Smith

Document nvmem-cells compatible used to treat mtd partitions as a nvmem provider.

---
  .../bindings/mtd/partitions/nvmem-cells.yaml  | 96 +++++++++++++++++++
  1 file changed, 96 insertions(+)

create mode 100644 Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +7 -0
new file mode 100644
index 000000000000..f70d7597a6b0
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/nvmem-cells.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nvmem cells

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +10 -0
+
+description: |
+  Any partition containing the compatible "nvmem-cells" will register as a
+  nvmem provider.
+  Each direct subnodes represents a nvmem cell following the nvmem binding.
+  Nvmem binding to declare nvmem-cells can be found in:
+  Documentation/devicetree/bindings/nvmem/nvmem.yaml
+
+maintainers:
+  - Ansuel Smith <[email protected]>

I think that when Rob wrote:

Quoted 1 line · Rob Herring

I think this should reference nvmem.yaml.

he meant you using:

allOf:
- $ref: "nvmem.yaml#"

(you'll need to adjust binding path).

Please check how it's done in Documentation/devicetree/bindings/nvmem/*.yaml files

Quoted 3 lines
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +3 -0
+properties:
+  compatible:
+    const: nvmem-cells
#3 lore raw

Re: [PATCH v4 2/3] dt-bindings: mtd: Document use of nvmem-cells compatible

Quoted 41 lines · Rafał Miłecki

See inline

Quoted 22 lines · Ansuel Smith

Document nvmem-cells compatible used to treat mtd partitions as a nvmem provider.

---
  .../bindings/mtd/partitions/nvmem-cells.yaml  | 96 +++++++++++++++++++
  1 file changed, 96 insertions(+)

create mode 100644 Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +7 -0
new file mode 100644
index 000000000000..f70d7597a6b0
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/nvmem-cells.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nvmem cells

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +10 -0
+
+description: |
+  Any partition containing the compatible "nvmem-cells" will register as a
+  nvmem provider.
+  Each direct subnodes represents a nvmem cell following the nvmem binding.
+  Nvmem binding to declare nvmem-cells can be found in:
+  Documentation/devicetree/bindings/nvmem/nvmem.yaml
+
+maintainers:
+  - Ansuel Smith <[email protected]>

I think that when Rob wrote:

Quoted 1 line · Rob Herring

I think this should reference nvmem.yaml.

Quoted 10 lines

he meant you using:

allOf:
- $ref: "nvmem.yaml#"

(you'll need to adjust binding path).

Please check how it's done in Documentation/devicetree/bindings/nvmem/*.yaml files

Aside from that, should I readd the old properties or I can keep the compatible as the only one required?

Thanks for the suggestion.

Quoted 3 lines
Quoted 3 lines
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +3 -0
+properties:
+  compatible:
+    const: nvmem-cells
#4 lore raw

Re: [PATCH v4 2/3] dt-bindings: mtd: Document use of nvmem-cells compatible

Quoted 47 lines · Ansuel Smith
Quoted 46 lines · Rafał Miłecki

See inline

Quoted 22 lines · Ansuel Smith

Document nvmem-cells compatible used to treat mtd partitions as a nvmem provider.

---
   .../bindings/mtd/partitions/nvmem-cells.yaml  | 96 +++++++++++++++++++
   1 file changed, 96 insertions(+)

create mode 100644 Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +7 -0
new file mode 100644
index 000000000000..f70d7597a6b0
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/nvmem-cells.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nvmem cells

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +10 -0
+
+description: |
+  Any partition containing the compatible "nvmem-cells" will register as a
+  nvmem provider.
+  Each direct subnodes represents a nvmem cell following the nvmem binding.
+  Nvmem binding to declare nvmem-cells can be found in:
+  Documentation/devicetree/bindings/nvmem/nvmem.yaml
+
+maintainers:
+  - Ansuel Smith <[email protected]>

I think that when Rob wrote:

Quoted 1 line · Rob Herring

I think this should reference nvmem.yaml.

he meant you using:

allOf:
- $ref: "nvmem.yaml#"

Quoted 8 lines
Quoted 5 lines

(you'll need to adjust binding path).

Please check how it's done in Documentation/devicetree/bindings/nvmem/*.yaml files

Aside from that, should I readd the old properties or I can keep the compatible as the only one required?

What old properties do you mean?

You shouldn't need to add anything to the list of "required" I think.

Some NVMEM providers add "#address-cells" and "#size-cells". That makes sense if NVMEM provider must provide at least 1 cell. I'm not sure if we need that for MTD.

Even "compatible" is actually redundant but most YAML files list it for convenience. Source:

Quoted 2 lines · Rob Herring

And drop 'compatible' as required. It's redundant anyways because the schema will only be applied if compatible matches.

http://lists.infradead.org/pipermail/linux-mtd/2020-December/084574.html
https://patchwork.ozlabs.org/comment/2597326/

#5 lore raw

Re: [PATCH v4 2/3] dt-bindings: mtd: Document use of nvmem-cells compatible

Quoted 59 lines · Rafał Miłecki
Quoted 47 lines · Ansuel Smith
Quoted 46 lines · Rafał Miłecki

See inline

Quoted 22 lines · Ansuel Smith

Document nvmem-cells compatible used to treat mtd partitions as a nvmem provider.

---
   .../bindings/mtd/partitions/nvmem-cells.yaml  | 96 +++++++++++++++++++
   1 file changed, 96 insertions(+)

create mode 100644 Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +7 -0
new file mode 100644
index 000000000000..f70d7597a6b0
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/partitions/nvmem-cells.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nvmem cells

Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/mtd/partitions/nvmem-cells.yaml new file +10 -0
+
+description: |
+  Any partition containing the compatible "nvmem-cells" will register as a
+  nvmem provider.
+  Each direct subnodes represents a nvmem cell following the nvmem binding.
+  Nvmem binding to declare nvmem-cells can be found in:
+  Documentation/devicetree/bindings/nvmem/nvmem.yaml
+
+maintainers:
+  - Ansuel Smith <[email protected]>

I think that when Rob wrote:

Quoted 1 line · Rob Herring

I think this should reference nvmem.yaml.

he meant you using:

allOf:
- $ref: "nvmem.yaml#"

Quoted 8 lines
Quoted 5 lines

(you'll need to adjust binding path).

Please check how it's done in Documentation/devicetree/bindings/nvmem/*.yaml files

Aside from that, should I readd the old properties or I can keep the compatible as the only one required?

What old properties do you mean?

Quoted 9 lines

You shouldn't need to add anything to the list of "required" I think.

Some NVMEM providers add "#address-cells" and "#size-cells". That makes sense if NVMEM provider must provide at least 1 cell. I'm not sure if we need that for MTD.

Even "compatible" is actually redundant but most YAML files list it for convenience. Source:

Thanks for the clarification, I sent the new version hoping the yaml documentation is now correct.

Quoted 6 lines · Rob Herring
Quoted 2 lines

And drop 'compatible' as required. It's redundant anyways because the schema will only be applied if compatible matches.

http://lists.infradead.org/pipermail/linux-mtd/2020-December/084574.html
https://patchwork.ozlabs.org/comment/2597326/

#6 lore raw

PATCH v4 3/3 devicetree: nvmem: nvmem: drop $nodename restriction

In reply to Ansuel Smith

Drop $nodename restriction as now mtd partition can also be used as nvmem provider.

---
 Documentation/devicetree/bindings/nvmem/nvmem.yaml | 3 ---
 1 file changed, 3 deletions(-)
Documentation/devicetree/bindings/nvmem/nvmem.yaml +0 -3
index 7481a9e48f19..b8dc3d2b6e92 100644
@@ -20,9 +20,6 @@ description: |
   storage device.
 
 properties:
-  $nodename:
-    pattern: "^(eeprom|efuse|nvram)(@.*|-[0-9a-f])*$"
-
   "#address-cells":
     const: 1
 
Signature · 1 line
2.30.0