linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [RFC PATCH 0/4] mtd: core: OTP nvmem provider support
@ 2021-03-22 18:19 Michael Walle
  2021-03-22 18:19 ` [RFC PATCH 1/4] nvmem: core: allow specifying of_node Michael Walle
                   ` (4 more replies)
  0 siblings, 5 replies; 11+ messages in thread
From: Michael Walle @ 2021-03-22 18:19 UTC (permalink / raw)
  To: linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Srinivas Kandagatla, Rafał Miłecki,
	Michael Walle

The goal is to fetch a (base) MAC address from the OTP region of a SPI NOR
flash.

This is the first part, where I try to add the nvmem provider support to
the MTD core.

I'm not sure about the device tree bindings. Consider the following two
variants:

(1)
    flash@0 {
        ..

        otp {
            compatible = "mtd-user-otp";
            #address-cells = <1>;
            #size-cells = <1>;

            serial-number@0 {
                reg = <0x0 0x8>;
            };
        };
    };

(2)
    flash@0 {
        ..

        otp {
            compatible = "mtd-user-otp";
            #address-cells = <1>;
            #size-cells = <1>;

			some-useful-name {
                compatible = "nvmem-cells";

                serial-number@0 {
                    reg = <0x0 0x8>;
                };
			};
        };
    };

Both bindings use a subnode "opt[-N]". We cannot have the nvmem cells as
children to the flash node because of the legacy partition binding.

(1) seems to be the form which is used almost everywhere in the kernel.
That is, the nvmem cells are just children of the parent node.

(2) seem to be more natural, because there might also be other properties
inside the otp subnode and might be more future-proof.

At the moment this patch implements (1).

Michael Walle (4):
  nvmem: core: allow specifying of_node
  dt-bindings: mtd: add YAML schema for the generic MTD bindings
  dt-bindings: mtd: add OTP bindings
  mtd: core: add OTP nvmem provider support

 .../devicetree/bindings/mtd/common.txt        |  16 +-
 .../devicetree/bindings/mtd/mtd.yaml          | 110 +++++++++++++
 drivers/mtd/mtdcore.c                         | 149 ++++++++++++++++++
 drivers/nvmem/core.c                          |   4 +-
 include/linux/mtd/mtd.h                       |   2 +
 include/linux/nvmem-provider.h                |   2 +
 6 files changed, 267 insertions(+), 16 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mtd/mtd.yaml

-- 
2.20.1


^ permalink raw reply	[flat|nested] 11+ messages in thread

* [RFC PATCH 1/4] nvmem: core: allow specifying of_node
  2021-03-22 18:19 [RFC PATCH 0/4] mtd: core: OTP nvmem provider support Michael Walle
@ 2021-03-22 18:19 ` Michael Walle
  2021-03-30 10:35   ` Srinivas Kandagatla
  2021-03-22 18:19 ` [RFC PATCH 2/4] dt-bindings: mtd: add YAML schema for the generic MTD bindings Michael Walle
                   ` (3 subsequent siblings)
  4 siblings, 1 reply; 11+ messages in thread
From: Michael Walle @ 2021-03-22 18:19 UTC (permalink / raw)
  To: linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Srinivas Kandagatla, Rafał Miłecki,
	Michael Walle

Until now, the of_node of the parent device is used. Some devices
provide more than just the nvmem provider. To avoid name space clashes,
add a way to allow specifying the nvmem cells in subnodes. Consider the
following example:

    flash@0 {
        compatible = "jedec,spi-nor";

        partitions {
            compatible = "fixed-partitions";
            #address-cells = <1>;
            #size-cells = <1>;

            partition@0 {
                reg = <0x000000 0x010000>;
            };
        };

        otp {
            compatible = "mtd-user-otp";
            #address-cells = <1>;
            #size-cells = <1>;

            serial-number@0 {
                reg = <0x0 0x8>;
            };
        };
    };

There the nvmem provider might be the MTD partition or the OTP region of
the flash.

Add a new config->of_node parameter, which if set, will be used instead
of the parent's of_node.

Signed-off-by: Michael Walle <michael@walle.cc>
---
 drivers/nvmem/core.c           | 4 +++-
 include/linux/nvmem-provider.h | 2 ++
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c
index bca671ff4e54..62d363a399d3 100644
--- a/drivers/nvmem/core.c
+++ b/drivers/nvmem/core.c
@@ -789,7 +789,9 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)
 	nvmem->reg_write = config->reg_write;
 	nvmem->keepout = config->keepout;
 	nvmem->nkeepout = config->nkeepout;
-	if (!config->no_of_node)
+	if (config->of_node)
+		nvmem->dev.of_node = config->of_node;
+	else if (!config->no_of_node)
 		nvmem->dev.of_node = config->dev->of_node;
 
 	switch (config->id) {
diff --git a/include/linux/nvmem-provider.h b/include/linux/nvmem-provider.h
index e162b757b6d5..471cb7b9e896 100644
--- a/include/linux/nvmem-provider.h
+++ b/include/linux/nvmem-provider.h
@@ -57,6 +57,7 @@ struct nvmem_keepout {
  * @type:	Type of the nvmem storage
  * @read_only:	Device is read-only.
  * @root_only:	Device is accessibly to root only.
+ * @of_node:	If given, this will be used instead of the parent's of_node.
  * @no_of_node:	Device should not use the parent's of_node even if it's !NULL.
  * @reg_read:	Callback to read data.
  * @reg_write:	Callback to write data.
@@ -86,6 +87,7 @@ struct nvmem_config {
 	enum nvmem_type		type;
 	bool			read_only;
 	bool			root_only;
+	struct device_node	*of_node;
 	bool			no_of_node;
 	nvmem_reg_read_t	reg_read;
 	nvmem_reg_write_t	reg_write;
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* [RFC PATCH 2/4] dt-bindings: mtd: add YAML schema for the generic MTD bindings
  2021-03-22 18:19 [RFC PATCH 0/4] mtd: core: OTP nvmem provider support Michael Walle
  2021-03-22 18:19 ` [RFC PATCH 1/4] nvmem: core: allow specifying of_node Michael Walle
@ 2021-03-22 18:19 ` Michael Walle
  2021-03-27 17:04   ` Rob Herring
  2021-03-22 18:19 ` [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings Michael Walle
                   ` (2 subsequent siblings)
  4 siblings, 1 reply; 11+ messages in thread
From: Michael Walle @ 2021-03-22 18:19 UTC (permalink / raw)
  To: linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Srinivas Kandagatla, Rafał Miłecki,
	Michael Walle

Convert MTD's common.txt to mtd.yaml.

Signed-off-by: Michael Walle <michael@walle.cc>
---
Btw, I've asked Miquel if I can add it as the maintainer.

 .../devicetree/bindings/mtd/common.txt        | 16 +-------
 .../devicetree/bindings/mtd/mtd.yaml          | 39 +++++++++++++++++++
 2 files changed, 40 insertions(+), 15 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mtd/mtd.yaml

diff --git a/Documentation/devicetree/bindings/mtd/common.txt b/Documentation/devicetree/bindings/mtd/common.txt
index fc068b923d7a..ae16f9ea8606 100644
--- a/Documentation/devicetree/bindings/mtd/common.txt
+++ b/Documentation/devicetree/bindings/mtd/common.txt
@@ -1,15 +1 @@
-* Common properties of all MTD devices
-
-Optional properties:
-- label: user-defined MTD device name. Can be used to assign user
-  friendly names to MTD devices (instead of the flash model or flash
-  controller based name) in order to ease flash device identification
-  and/or describe what they are used for.
-
-Example:
-
-	flash@0 {
-		label = "System-firmware";
-
-		/* flash type specific properties */
-	};
+This file has been moved to mtd.yaml.
diff --git a/Documentation/devicetree/bindings/mtd/mtd.yaml b/Documentation/devicetree/bindings/mtd/mtd.yaml
new file mode 100644
index 000000000000..321259aab0f6
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/mtd.yaml
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/mtd.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MTD (Memory Technology Device) Device Tree Bindings
+
+maintainers:
+  - Miquel Raynal <miquel.raynal@bootlin.com>
+  - Richard Weinberger <richard@nod.at>
+
+properties:
+  $nodename:
+    pattern: "^flash(@.*)?$"
+
+  label:
+    description:
+      User-defined MTD device name. Can be used to assign user friendly
+      names to MTD devices (instead of the flash model or flash controller
+      based name) in order to ease flash device identification and/or
+      describe what they are used for.
+
+additionalProperties: true
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        flash@0 {
+            reg = <0>;
+            compatible = "some,flash";
+            label = "System-firmware";
+        };
+    };
+
+...
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings
  2021-03-22 18:19 [RFC PATCH 0/4] mtd: core: OTP nvmem provider support Michael Walle
  2021-03-22 18:19 ` [RFC PATCH 1/4] nvmem: core: allow specifying of_node Michael Walle
  2021-03-22 18:19 ` [RFC PATCH 2/4] dt-bindings: mtd: add YAML schema for the generic MTD bindings Michael Walle
@ 2021-03-22 18:19 ` Michael Walle
  2021-03-27 17:09   ` Rob Herring
  2021-03-22 18:19 ` [RFC PATCH 4/4] mtd: core: add OTP nvmem provider support Michael Walle
  2021-03-30  9:42 ` [RFC PATCH 0/4] mtd: core: " Srinivas Kandagatla
  4 siblings, 1 reply; 11+ messages in thread
From: Michael Walle @ 2021-03-22 18:19 UTC (permalink / raw)
  To: linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Srinivas Kandagatla, Rafał Miłecki,
	Michael Walle

Flash devices can have one-time-programmable regions. Add a nvmem
binding so they can be used as a nvmem provider.

Signed-off-by: Michael Walle <michael@walle.cc>
---
 .../devicetree/bindings/mtd/mtd.yaml          | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/Documentation/devicetree/bindings/mtd/mtd.yaml b/Documentation/devicetree/bindings/mtd/mtd.yaml
index 321259aab0f6..2b852f91a6a9 100644
--- a/Documentation/devicetree/bindings/mtd/mtd.yaml
+++ b/Documentation/devicetree/bindings/mtd/mtd.yaml
@@ -21,6 +21,25 @@ properties:
       based name) in order to ease flash device identification and/or
       describe what they are used for.
 
+patternProperties:
+  "^otp(-[0-9]+)?":
+    type: object
+    $ref: ../nvmem/nvmem.yaml#
+
+    description: |
+      An OTP memory region. Some flashes provide a one-time-programmable
+      memory whose content can either be programmed by a user or is already
+      pre-programmed by the factory. Some flashes might provide both.
+
+    properties:
+      compatible:
+        enum:
+          - mtd-user-otp
+          - mtd-factory-otp
+
+    required:
+      - compatible
+
 additionalProperties: true
 
 examples:
@@ -36,4 +55,56 @@ examples:
         };
     };
 
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        flash@0 {
+            reg = <0>;
+            compatible = "some,flash";
+
+            otp {
+                compatible = "mtd-user-otp";
+                #address-cells = <1>;
+                #size-cells = <1>;
+
+                serial-number@0 {
+                    reg = <0 16>;
+                };
+            };
+        };
+    };
+
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        flash@0 {
+            reg = <0>;
+            compatible = "some,flash";
+
+            otp-1 {
+                compatible = "mtd-factory-otp";
+                #address-cells = <1>;
+                #size-cells = <1>;
+
+                electronic-serial-number@0 {
+                    reg = <0 8>;
+                };
+            };
+
+            otp-2 {
+                compatible = "mtd-user-otp";
+                #address-cells = <1>;
+                #size-cells = <1>;
+
+                mac-address@0 {
+                    reg = <0 6>;
+                };
+            };
+        };
+    };
+
 ...
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* [RFC PATCH 4/4] mtd: core: add OTP nvmem provider support
  2021-03-22 18:19 [RFC PATCH 0/4] mtd: core: OTP nvmem provider support Michael Walle
                   ` (2 preceding siblings ...)
  2021-03-22 18:19 ` [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings Michael Walle
@ 2021-03-22 18:19 ` Michael Walle
  2021-03-30  9:42 ` [RFC PATCH 0/4] mtd: core: " Srinivas Kandagatla
  4 siblings, 0 replies; 11+ messages in thread
From: Michael Walle @ 2021-03-22 18:19 UTC (permalink / raw)
  To: linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Srinivas Kandagatla, Rafał Miłecki,
	Michael Walle

Flash OTP regions can already be read via user space. Some boards have
their serial number or MAC addresses stored in the OTP regions. Add
support for them being a (read-only) nvmem provider.

The API to read the OTP data is already in place. It distinguishes
between factory and user OTP, thus there are up to two different
providers.

Signed-off-by: Michael Walle <michael@walle.cc>
---
 drivers/mtd/mtdcore.c   | 149 ++++++++++++++++++++++++++++++++++++++++
 include/linux/mtd/mtd.h |   2 +
 2 files changed, 151 insertions(+)

diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c
index 432769caae04..300340973561 100644
--- a/drivers/mtd/mtdcore.c
+++ b/drivers/mtd/mtdcore.c
@@ -776,6 +776,147 @@ static void mtd_set_dev_defaults(struct mtd_info *mtd)
 	mutex_init(&mtd->master.chrdev_lock);
 }
 
+static ssize_t mtd_otp_size(struct mtd_info *mtd, bool is_user)
+{
+	struct otp_info *info = kmalloc(PAGE_SIZE, GFP_KERNEL);
+	ssize_t size = 0;
+	unsigned int i;
+	size_t retlen;
+	int ret;
+
+	if (is_user)
+		ret = mtd_get_user_prot_info(mtd, PAGE_SIZE, &retlen, info);
+	else
+		ret = mtd_get_fact_prot_info(mtd, PAGE_SIZE, &retlen, info);
+	if (ret)
+		goto err;
+
+	for (i = 0; i < retlen / sizeof(*info); i++) {
+		size += info->length;
+		info++;
+	}
+
+	kfree(info);
+	return size;
+
+err:
+	kfree(info);
+	return ret;
+}
+
+static struct nvmem_device *mtd_otp_nvmem_register(struct mtd_info *mtd,
+						   const char *name, int size,
+						   nvmem_reg_read_t reg_read,
+						   const char *compatible)
+{
+	struct nvmem_device *nvmem = NULL;
+	struct nvmem_config config = {};
+	struct device_node *np;
+
+	/* DT binding is optional */
+	np = of_get_compatible_child(mtd->dev.of_node, compatible);
+
+	/* OTP nvmem will be registered on the physical device */
+	config.dev = mtd->dev.parent;
+	config.name = name;
+	config.id = NVMEM_DEVID_NONE;
+	config.owner = THIS_MODULE;
+	config.type = NVMEM_TYPE_OTP;
+	config.root_only = true;
+	config.reg_read = reg_read;
+	config.size = size;
+	config.of_node = np;
+	config.priv = mtd;
+
+	nvmem = nvmem_register(&config);
+	/* Just ignore if there is no NVMEM support in the kernel */
+	if (IS_ERR(nvmem) && PTR_ERR(nvmem) == -EOPNOTSUPP)
+		nvmem = NULL;
+
+	of_node_put(np);
+
+	return nvmem;
+}
+
+static int mtd_nvmem_user_otp_reg_read(void *priv, unsigned int offset,
+				       void *val, size_t bytes)
+{
+	struct mtd_info *mtd = priv;
+	size_t retlen;
+	int ret;
+
+	ret = mtd_read_user_prot_reg(mtd, offset, bytes, &retlen, val);
+	if (ret)
+		return ret;
+
+	return retlen == bytes ? 0 : -EIO;
+}
+
+static int mtd_nvmem_fact_otp_reg_read(void *priv, unsigned int offset,
+				       void *val, size_t bytes)
+{
+	struct mtd_info *mtd = priv;
+	size_t retlen;
+	int ret;
+
+	ret = mtd_read_fact_prot_reg(mtd, offset, bytes, &retlen, val);
+	if (ret)
+		return ret;
+
+	return retlen == bytes ? 0 : -EIO;
+}
+
+static int mtd_otp_nvmem_add(struct mtd_info *mtd)
+{
+	struct nvmem_device *nvmem;
+	ssize_t size;
+	int err;
+
+	if (mtd->_get_user_prot_info && mtd->_read_user_prot_reg) {
+		size = mtd_otp_size(mtd, true);
+		if (size < 0)
+			return size;
+
+		if (size > 0) {
+			nvmem = mtd_otp_nvmem_register(mtd, "user-otp", size,
+						       mtd_nvmem_user_otp_reg_read,
+						       "mtd-user-otp");
+			if (IS_ERR(nvmem)) {
+				dev_err(&mtd->dev, "Failed to register OTP NVMEM device\n");
+				return PTR_ERR(nvmem);
+			}
+			mtd->otp_user_nvmem = nvmem;
+		}
+	}
+
+	if (mtd->_get_fact_prot_info && mtd->_read_fact_prot_reg) {
+		size = mtd_otp_size(mtd, false);
+		if (size < 0) {
+			err = size;
+			goto err;
+		}
+
+		if (size > 0) {
+			nvmem = mtd_otp_nvmem_register(mtd, "factory-otp", size,
+						       mtd_nvmem_fact_otp_reg_read,
+						       "mtd-factory-otp");
+			if (IS_ERR(nvmem)) {
+				dev_err(&mtd->dev, "Failed to register OTP NVMEM device\n");
+				err = PTR_ERR(nvmem);
+				goto err;
+			}
+			mtd->otp_factory_nvmem = nvmem;
+		}
+	}
+
+	return 0;
+
+err:
+	if (mtd->otp_user_nvmem)
+		nvmem_unregister(mtd->otp_user_nvmem);
+	return err;
+}
+
 /**
  * mtd_device_parse_register - parse partitions and register an MTD device.
  *
@@ -851,6 +992,8 @@ int mtd_device_parse_register(struct mtd_info *mtd, const char * const *types,
 		register_reboot_notifier(&mtd->reboot_notifier);
 	}
 
+	ret = mtd_otp_nvmem_add(mtd);
+
 out:
 	if (ret && device_is_registered(&mtd->dev))
 		del_mtd_device(mtd);
@@ -872,6 +1015,12 @@ int mtd_device_unregister(struct mtd_info *master)
 	if (master->_reboot)
 		unregister_reboot_notifier(&master->reboot_notifier);
 
+	if (master->otp_user_nvmem)
+		nvmem_unregister(master->otp_user_nvmem);
+
+	if (master->otp_factory_nvmem)
+		nvmem_unregister(master->otp_factory_nvmem);
+
 	err = del_mtd_partitions(master);
 	if (err)
 		return err;
diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index 4aac200ca8b5..71e751d18c22 100644
--- a/include/linux/mtd/mtd.h
+++ b/include/linux/mtd/mtd.h
@@ -379,6 +379,8 @@ struct mtd_info {
 	int usecount;
 	struct mtd_debug_info dbg;
 	struct nvmem_device *nvmem;
+	struct nvmem_device *otp_user_nvmem;
+	struct nvmem_device *otp_factory_nvmem;
 
 	/*
 	 * Parent device from the MTD partition point of view.
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 11+ messages in thread

* Re: [RFC PATCH 2/4] dt-bindings: mtd: add YAML schema for the generic MTD bindings
  2021-03-22 18:19 ` [RFC PATCH 2/4] dt-bindings: mtd: add YAML schema for the generic MTD bindings Michael Walle
@ 2021-03-27 17:04   ` Rob Herring
  0 siblings, 0 replies; 11+ messages in thread
From: Rob Herring @ 2021-03-27 17:04 UTC (permalink / raw)
  To: Michael Walle
  Cc: devicetree, Rafał Miłecki, Vignesh Raghavendra,
	Miquel Raynal, Srinivas Kandagatla, linux-mtd, Rob Herring,
	Richard Weinberger, linux-kernel

On Mon, 22 Mar 2021 19:19:47 +0100, Michael Walle wrote:
> Convert MTD's common.txt to mtd.yaml.
> 
> Signed-off-by: Michael Walle <michael@walle.cc>
> ---
> Btw, I've asked Miquel if I can add it as the maintainer.
> 
>  .../devicetree/bindings/mtd/common.txt        | 16 +-------
>  .../devicetree/bindings/mtd/mtd.yaml          | 39 +++++++++++++++++++
>  2 files changed, 40 insertions(+), 15 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/mtd/mtd.yaml
> 

Reviewed-by: Rob Herring <robh@kernel.org>

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings
  2021-03-22 18:19 ` [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings Michael Walle
@ 2021-03-27 17:09   ` Rob Herring
  2021-03-30 10:07     ` Michael Walle
  0 siblings, 1 reply; 11+ messages in thread
From: Rob Herring @ 2021-03-27 17:09 UTC (permalink / raw)
  To: Michael Walle
  Cc: linux-mtd, devicetree, linux-kernel, Miquel Raynal,
	Richard Weinberger, Vignesh Raghavendra, Srinivas Kandagatla,
	Rafał Miłecki

On Mon, Mar 22, 2021 at 07:19:48PM +0100, Michael Walle wrote:
> Flash devices can have one-time-programmable regions. Add a nvmem
> binding so they can be used as a nvmem provider.
> 
> Signed-off-by: Michael Walle <michael@walle.cc>
> ---
>  .../devicetree/bindings/mtd/mtd.yaml          | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/mtd/mtd.yaml b/Documentation/devicetree/bindings/mtd/mtd.yaml
> index 321259aab0f6..2b852f91a6a9 100644
> --- a/Documentation/devicetree/bindings/mtd/mtd.yaml
> +++ b/Documentation/devicetree/bindings/mtd/mtd.yaml
> @@ -21,6 +21,25 @@ properties:
>        based name) in order to ease flash device identification and/or
>        describe what they are used for.
>  
> +patternProperties:
> +  "^otp(-[0-9]+)?":

Needs '$' on the end.

> +    type: object
> +    $ref: ../nvmem/nvmem.yaml#
> +
> +    description: |
> +      An OTP memory region. Some flashes provide a one-time-programmable
> +      memory whose content can either be programmed by a user or is already
> +      pre-programmed by the factory. Some flashes might provide both.
> +
> +    properties:
> +      compatible:
> +        enum:
> +          - mtd-user-otp
> +          - mtd-factory-otp
> +
> +    required:
> +      - compatible
> +
>  additionalProperties: true
>  
>  examples:
> @@ -36,4 +55,56 @@ examples:
>          };
>      };
>  
> +  - |
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        flash@0 {
> +            reg = <0>;
> +            compatible = "some,flash";

Soon (in linux-next, but off by default) this will be a warning for 
undocumented compatible string. Use a real device.

> +
> +            otp {
> +                compatible = "mtd-user-otp";
> +                #address-cells = <1>;
> +                #size-cells = <1>;
> +
> +                serial-number@0 {
> +                    reg = <0 16>;
> +                };
> +            };
> +        };
> +    };
> +
> +  - |
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        flash@0 {
> +            reg = <0>;
> +            compatible = "some,flash";
> +
> +            otp-1 {
> +                compatible = "mtd-factory-otp";
> +                #address-cells = <1>;
> +                #size-cells = <1>;
> +
> +                electronic-serial-number@0 {
> +                    reg = <0 8>;
> +                };
> +            };
> +
> +            otp-2 {
> +                compatible = "mtd-user-otp";
> +                #address-cells = <1>;
> +                #size-cells = <1>;
> +
> +                mac-address@0 {
> +                    reg = <0 6>;
> +                };
> +            };
> +        };
> +    };

The 2nd example is a superset of the 1st, so drop the first one.

Rob

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [RFC PATCH 0/4] mtd: core: OTP nvmem provider support
  2021-03-22 18:19 [RFC PATCH 0/4] mtd: core: OTP nvmem provider support Michael Walle
                   ` (3 preceding siblings ...)
  2021-03-22 18:19 ` [RFC PATCH 4/4] mtd: core: add OTP nvmem provider support Michael Walle
@ 2021-03-30  9:42 ` Srinivas Kandagatla
  2021-03-30  9:49   ` Michael Walle
  4 siblings, 1 reply; 11+ messages in thread
From: Srinivas Kandagatla @ 2021-03-30  9:42 UTC (permalink / raw)
  To: Michael Walle, linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Rafał Miłecki

Hi Michael,

On 22/03/2021 18:19, Michael Walle wrote:
> The goal is to fetch a (base) MAC address from the OTP region of a SPI NOR
> flash.
> 
> This is the first part, where I try to add the nvmem provider support to
> the MTD core.
> 
> I'm not sure about the device tree bindings. Consider the following two
> variants:
> 
> (1)
>      flash@0 {
>          ..
> 
>          otp {
>              compatible = "mtd-user-otp";
>              #address-cells = <1>;
>              #size-cells = <1>;
> 
>              serial-number@0 {
>                  reg = <0x0 0x8>;
>              };
>          };
>      };
> 
> (2)
>      flash@0 {
>          ..
> 
>          otp {
>              compatible = "mtd-user-otp";
>              #address-cells = <1>;
>              #size-cells = <1>;
> 
> 			some-useful-name {
>                  compatible = "nvmem-cells";
> 
>                  serial-number@0 {
>                      reg = <0x0 0x8>;
>                  };
> 			};
>          };
>      };
> 
> Both bindings use a subnode "opt[-N]". We cannot have the nvmem cells as
> children to the flash node because of the legacy partition binding.
> 
> (1) seems to be the form which is used almost everywhere in the kernel.
> That is, the nvmem cells are just children of the parent node.
> 
> (2) seem to be more natural, because there might also be other properties
> inside the otp subnode and might be more future-proof.
> 
> At the moment this patch implements (1).
> 


Have you looked at this series[1], are you both trying to do the same thing?

[1] 
https://lore.kernel.org/linux-mtd/20210312062830.20548-2-ansuelsmth@gmail.com/T/

--srini


> Michael Walle (4):
>    nvmem: core: allow specifying of_node
>    dt-bindings: mtd: add YAML schema for the generic MTD bindings
>    dt-bindings: mtd: add OTP bindings
>    mtd: core: add OTP nvmem provider support
> 
>   .../devicetree/bindings/mtd/common.txt        |  16 +-
>   .../devicetree/bindings/mtd/mtd.yaml          | 110 +++++++++++++
>   drivers/mtd/mtdcore.c                         | 149 ++++++++++++++++++
>   drivers/nvmem/core.c                          |   4 +-
>   include/linux/mtd/mtd.h                       |   2 +
>   include/linux/nvmem-provider.h                |   2 +
>   6 files changed, 267 insertions(+), 16 deletions(-)
>   create mode 100644 Documentation/devicetree/bindings/mtd/mtd.yaml
> 

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [RFC PATCH 0/4] mtd: core: OTP nvmem provider support
  2021-03-30  9:42 ` [RFC PATCH 0/4] mtd: core: " Srinivas Kandagatla
@ 2021-03-30  9:49   ` Michael Walle
  0 siblings, 0 replies; 11+ messages in thread
From: Michael Walle @ 2021-03-30  9:49 UTC (permalink / raw)
  To: Srinivas Kandagatla
  Cc: linux-mtd, devicetree, linux-kernel, Miquel Raynal,
	Richard Weinberger, Vignesh Raghavendra, Rob Herring,
	Rafał Miłecki

Hi Srinivas,

Am 2021-03-30 11:42, schrieb Srinivas Kandagatla:
> On 22/03/2021 18:19, Michael Walle wrote:
>> The goal is to fetch a (base) MAC address from the OTP region of a SPI 
>> NOR
>> flash.
>> 
>> This is the first part, where I try to add the nvmem provider support 
>> to
>> the MTD core.
>> 
>> I'm not sure about the device tree bindings. Consider the following 
>> two
>> variants:
>> 
>> (1)
>>      flash@0 {
>>          ..
>> 
>>          otp {
>>              compatible = "mtd-user-otp";
>>              #address-cells = <1>;
>>              #size-cells = <1>;
>> 
>>              serial-number@0 {
>>                  reg = <0x0 0x8>;
>>              };
>>          };
>>      };
>> 
>> (2)
>>      flash@0 {
>>          ..
>> 
>>          otp {
>>              compatible = "mtd-user-otp";
>>              #address-cells = <1>;
>>              #size-cells = <1>;
>> 
>> 			some-useful-name {
>>                  compatible = "nvmem-cells";
>> 
>>                  serial-number@0 {
>>                      reg = <0x0 0x8>;
>>                  };
>> 			};
>>          };
>>      };
>> 
>> Both bindings use a subnode "opt[-N]". We cannot have the nvmem cells 
>> as
>> children to the flash node because of the legacy partition binding.
>> 
>> (1) seems to be the form which is used almost everywhere in the 
>> kernel.
>> That is, the nvmem cells are just children of the parent node.
>> 
>> (2) seem to be more natural, because there might also be other 
>> properties
>> inside the otp subnode and might be more future-proof.
>> 
>> At the moment this patch implements (1).
>> 
> 
> 
> Have you looked at this series[1], are you both trying to do the same 
> thing?

Yes, I've seen these, but they are for MTD partitions. OTP regions are 
not
MTD partitions (and cannot be mapped to them).

-michael

> 
> [1] 
> https://lore.kernel.org/linux-mtd/20210312062830.20548-2-ansuelsmth@gmail.com/T/
> 
> --srini
> 
> 
>> Michael Walle (4):
>>    nvmem: core: allow specifying of_node
>>    dt-bindings: mtd: add YAML schema for the generic MTD bindings
>>    dt-bindings: mtd: add OTP bindings
>>    mtd: core: add OTP nvmem provider support
>> 
>>   .../devicetree/bindings/mtd/common.txt        |  16 +-
>>   .../devicetree/bindings/mtd/mtd.yaml          | 110 +++++++++++++
>>   drivers/mtd/mtdcore.c                         | 149 
>> ++++++++++++++++++
>>   drivers/nvmem/core.c                          |   4 +-
>>   include/linux/mtd/mtd.h                       |   2 +
>>   include/linux/nvmem-provider.h                |   2 +
>>   6 files changed, 267 insertions(+), 16 deletions(-)
>>   create mode 100644 Documentation/devicetree/bindings/mtd/mtd.yaml
>> 

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings
  2021-03-27 17:09   ` Rob Herring
@ 2021-03-30 10:07     ` Michael Walle
  0 siblings, 0 replies; 11+ messages in thread
From: Michael Walle @ 2021-03-30 10:07 UTC (permalink / raw)
  To: Rob Herring
  Cc: linux-mtd, devicetree, linux-kernel, Miquel Raynal,
	Richard Weinberger, Vignesh Raghavendra, Srinivas Kandagatla,
	Rafał Miłecki

Hi Rob,

Am 2021-03-27 18:09, schrieb Rob Herring:
>> +    spi {
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +
>> +        flash@0 {
>> +            reg = <0>;
>> +            compatible = "some,flash";
> 
> Soon (in linux-next, but off by default) this will be a warning for
> undocumented compatible string. Use a real device.

Two questions:
(1) I guess this is also true for "PATCH 2/4", where you already added
     your Reviewed-by?
(2) I'd add the "jedec,spi-nor" because, that is the one I target. But
     before doing so, I'd need to add the otp subnode to the spi-nor
     schema, correct? Otherwise, the schema validation will fail. Eg.

--- a/Documentation/devicetree/bindings/mtd/jedec,spi-nor.yaml
+++ b/Documentation/devicetree/bindings/mtd/jedec,spi-nor.yaml
@@ -9,6 +9,9 @@ title: SPI NOR flash ST M25Pxx (and similar) serial 
flash chips
  maintainers:
    - Rob Herring <robh@kernel.org>

+allOf:
+  - $ref: "mtd.yaml#"
+
  properties:
    compatible:
      oneOf:
@@ -82,6 +85,9 @@ patternProperties:
    '^partition@':
      type: object

+  "^otp(-[0-9]+)?$":
+    type: object
+
  additionalProperties: false

  examples:

-michael

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [RFC PATCH 1/4] nvmem: core: allow specifying of_node
  2021-03-22 18:19 ` [RFC PATCH 1/4] nvmem: core: allow specifying of_node Michael Walle
@ 2021-03-30 10:35   ` Srinivas Kandagatla
  0 siblings, 0 replies; 11+ messages in thread
From: Srinivas Kandagatla @ 2021-03-30 10:35 UTC (permalink / raw)
  To: Michael Walle, linux-mtd, devicetree, linux-kernel
  Cc: Miquel Raynal, Richard Weinberger, Vignesh Raghavendra,
	Rob Herring, Rafał Miłecki



On 22/03/2021 18:19, Michael Walle wrote:
> Until now, the of_node of the parent device is used. Some devices
> provide more than just the nvmem provider. To avoid name space clashes,
> add a way to allow specifying the nvmem cells in subnodes. Consider the
> following example:
> 
>      flash@0 {
>          compatible = "jedec,spi-nor";
> 
>          partitions {
>              compatible = "fixed-partitions";
>              #address-cells = <1>;
>              #size-cells = <1>;
> 
>              partition@0 {
>                  reg = <0x000000 0x010000>;
>              };
>          };
> 
>          otp {
>              compatible = "mtd-user-otp";

I would have expected this to come up as a proper device, but am not 
100% sure how MTD handles flashes and its partitions.

>              #address-cells = <1>;
>              #size-cells = <1>;
> 
>              serial-number@0 {
>                  reg = <0x0 0x8>;
>              };
>          };
>      };
> 
> There the nvmem provider might be the MTD partition or the OTP region of
> the flash.
> 
> Add a new config->of_node parameter, which if set, will be used instead
> of the parent's of_node.
> 
> Signed-off-by: Michael Walle <michael@walle.cc>
> ---

Patch is fine as it its.
If you plan to take this via mtd tree here is my Ack

Acked-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>


--srini

>   drivers/nvmem/core.c           | 4 +++-
>   include/linux/nvmem-provider.h | 2 ++
>   2 files changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c
> index bca671ff4e54..62d363a399d3 100644
> --- a/drivers/nvmem/core.c
> +++ b/drivers/nvmem/core.c
> @@ -789,7 +789,9 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)
>   	nvmem->reg_write = config->reg_write;
>   	nvmem->keepout = config->keepout;
>   	nvmem->nkeepout = config->nkeepout;
> -	if (!config->no_of_node)
> +	if (config->of_node)
> +		nvmem->dev.of_node = config->of_node;
> +	else if (!config->no_of_node)
>   		nvmem->dev.of_node = config->dev->of_node;
>   
>   	switch (config->id) {
> diff --git a/include/linux/nvmem-provider.h b/include/linux/nvmem-provider.h
> index e162b757b6d5..471cb7b9e896 100644
> --- a/include/linux/nvmem-provider.h
> +++ b/include/linux/nvmem-provider.h
> @@ -57,6 +57,7 @@ struct nvmem_keepout {
>    * @type:	Type of the nvmem storage
>    * @read_only:	Device is read-only.
>    * @root_only:	Device is accessibly to root only.
> + * @of_node:	If given, this will be used instead of the parent's of_node.
>    * @no_of_node:	Device should not use the parent's of_node even if it's !NULL.
>    * @reg_read:	Callback to read data.
>    * @reg_write:	Callback to write data.
> @@ -86,6 +87,7 @@ struct nvmem_config {
>   	enum nvmem_type		type;
>   	bool			read_only;
>   	bool			root_only;
> +	struct device_node	*of_node;
>   	bool			no_of_node;
>   	nvmem_reg_read_t	reg_read;
>   	nvmem_reg_write_t	reg_write;
> 

^ permalink raw reply	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2021-03-30 10:35 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-22 18:19 [RFC PATCH 0/4] mtd: core: OTP nvmem provider support Michael Walle
2021-03-22 18:19 ` [RFC PATCH 1/4] nvmem: core: allow specifying of_node Michael Walle
2021-03-30 10:35   ` Srinivas Kandagatla
2021-03-22 18:19 ` [RFC PATCH 2/4] dt-bindings: mtd: add YAML schema for the generic MTD bindings Michael Walle
2021-03-27 17:04   ` Rob Herring
2021-03-22 18:19 ` [RFC PATCH 3/4] dt-bindings: mtd: add OTP bindings Michael Walle
2021-03-27 17:09   ` Rob Herring
2021-03-30 10:07     ` Michael Walle
2021-03-22 18:19 ` [RFC PATCH 4/4] mtd: core: add OTP nvmem provider support Michael Walle
2021-03-30  9:42 ` [RFC PATCH 0/4] mtd: core: " Srinivas Kandagatla
2021-03-30  9:49   ` Michael Walle

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