qcom: Add SMEM MTD parser

Add one new node to the ipq806x.dtsi file to declare & register the hardware spinlock devices. This mechanism is required to be used by other drivers such as SMEM.

Signed-off-by Mathieu Olivari <[email protected]>

---
  arch/arm/boot/dts/qcom-ipq8064.dtsi | 12 ++++++++++++
  1 file changed, 12 insertions(+)

arch/arm/boot/dts/qcom-ipq8064.dtsi +0 -0

index 9f727d8..ea7b959 100644

arch/arm/boot/dts/qcom-ipq8064.dtsi +0 -0

  	};
 
  	soc: soc {

Quoted 14 lines · Mathieu Olivari

Add one new node to the ipq806x.dtsi file to declare & register the hardware spinlock devices. This mechanism is required to be used by other drivers such as SMEM.

Signed-off-by Mathieu Olivari <[email protected]>

---
 arch/arm/boot/dts/qcom-ipq8064.dtsi | 12 ++++++++++++
 1 file changed, 12 insertions(+)

arch/arm/boot/dts/qcom-ipq8064.dtsi +0 -0

index 9f727d8..ea7b959 100644

arch/arm/boot/dts/qcom-ipq8064.dtsi line 71

Quoted 5 lines

arch/arm/boot/dts/qcom-ipq8064.dtsi +2 -0

@@ -67,6 +67,18 @@
 			clock-frequency = <32768>;
 			#clock-cells = <0>;
 		};
+
+		sfpb_mutex_block: syscon at 01200600 {

I think you can drop the leading 0 here. Also this should be moved into the soc node.

arch/arm/boot/dts/qcom-ipq8064.dtsi line 81

Quoted 10 lines

arch/arm/boot/dts/qcom-ipq8064.dtsi +10 -0

+			compatible = "syscon";
+			reg = <0x01200600 0x100>;
+		};
+
+		sfpb_mutex: sfpb-mutex {
+			compatible = "qcom,sfpb-mutex";
+			syscon = <&sfpb_mutex_block 4 4>;
+
+			#hwlock-cells = <1>;
+		};

And this node should be moved to the root /.

Quoted 2 lines

arch/arm/boot/dts/qcom-ipq8064.dtsi +0 -0

 	};
 	soc: soc {

Signature · 3 lines

-- 
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project

arch/arm/boot/dts/qcom-ipq8064.dtsi line 86

Quoted 9 lines · Mathieu Olivari

arch/arm/boot/dts/qcom-ipq8064.dtsi +6 -0

@@ -79,6 +79,15 @@
 			#hwlock-cells = <1>;
 		};
+
+		smem {
+			compatible = "qcom,smem";
+
+			memory-region = <&smem>;
+			reg = <0x41000000 0x4000>;

Does this reg property do something? I thought we were supposed to leave this out when not using the rpm msg ram. Also, if there's no reg, it should be at the root /.

Signature · 3 lines

-- 
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project

drivers/mtd/qcom_smem_part.c new file +51 -0

+
+	if (ret < 0) {
+		pr_err("Unable to read flash blksz from SMEM\n");
+		return -ENOENT;
+	}
+
+	if (size != sizeof(**smem_blksz)) {
+		pr_err("Invalid flash blksz size in SMEM\n");
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static int qcom_smem_get_flash_type(uint64_t **smem_flash_type)
+{
+	int ret;
+	size_t size;
+
+	ret = qcom_smem_get(SMEM_HOST_APPS, SMEM_BOOT_FLASH_TYPE,
+			    (void **) smem_flash_type, &size);
+
+	if (ret < 0) {
+		pr_err("Unable to read flash type from SMEM\n");
+		return -ENOENT;
+	}
+
+	if (size != sizeof(**smem_flash_type)) {
+		pr_err("Invalid flash type size in SMEM\n");
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static int qcom_smem_get_flash_partitions(struct smem_partition_table **pparts)
+{
+	int ret;
+	size_t size;
+
+	ret = qcom_smem_get(SMEM_HOST_APPS, SMEM_AARM_PARTITION_TABLE,
+			    (void **) pparts, &size);
+
+	if (ret < 0) {
+		pr_err("Unable to read partition table from SMEM\n");
+		return -ENOENT;
+	}
+
+	return 0;
+}
+

drivers/mtd/qcom_smem_part.c new file +41 -0

+	return dev ? true : false;
+}
+
+static int parse_qcom_smem_partitions(struct mtd_info *master,
+				      struct mtd_partition **pparts,
+				      struct mtd_part_parser_data *data)
+{
+	struct smem_partition_table *smem_parts;
+	uint64_t *smem_flash_type, *smem_blksz;
+	struct mtd_partition *mtd_parts;
+	struct device_node *of_node = data->of_node;
+	int i, ret;
+
+	/*
+	 * SMEM will only store the partition table of the boot device.
+	 * If this is not the boot device, do not return any partition.
+	 */
+	ret = qcom_smem_get_flash_type(&smem_flash_type);
+	if (ret < 0)
+		return ret;
+
+	if ((*smem_flash_type == SMEM_FLASH_NAND && !mtd_type_is_nand(master))
+	    || (*smem_flash_type == SMEM_FLASH_SPI && !is_spi_device(of_node)))
+		return 0;
+
+	/*
+	 * Just for sanity purpose, make sure the block size in SMEM matches the
+	 * block size of the MTD device
+	 */
+	ret = qcom_smem_get_flash_blksz(&smem_blksz);
+	if (ret < 0)
+		return ret;
+
+	if (*smem_blksz != master->erasesize) {
+		pr_err("SMEM block size differs from MTD block size\n");
+		return -EINVAL;
+	}
+
+	/* Get partition pointer from SMEM */
+	ret = qcom_smem_get_flash_partitions(&smem_parts);
+	if (ret < 0)

drivers/mtd/qcom_smem_part.c new file +6 -0

+		return -ENOMEM;
+
+	for (i = 0; i < smem_parts->len; i++) {
+		struct smem_partition *part = &smem_parts->parts[i];
+
+		mtd_parts[i].name = part->name;

Quoted 6 lines · Mathieu Olivari

drivers/mtd/qcom_smem_part.c new file +0 -0

new file mode 100644
index 0000000..6cbf610

drivers/mtd/qcom_smem_part.c line 48

Quoted 7 lines

drivers/mtd/qcom_smem_part.c new file +7 -0

+#define SMEM_PARTS_MAX			32
+
+struct smem_partition {
+	char name[SMEM_PART_NAME_SZ];
+	uint32_t start;
+	uint32_t size;
+	uint32_t attr;

Is this little endian? __le32? I think so.

drivers/mtd/qcom_smem_part.c line 54

Quoted 7 lines

drivers/mtd/qcom_smem_part.c new file +6 -0

+};
+
+struct smem_partition_table {
+	uint32_t magic[2];
+	uint32_t version;
+	uint32_t len;

Same for these being little endian. And if so, please make magic into a byte array of size 8 and then do a memcmp with another static byte array.

drivers/mtd/qcom_smem_part.c line 58

Quoted 5 lines

drivers/mtd/qcom_smem_part.c new file +4 -0

+	struct smem_partition parts[SMEM_PARTS_MAX];
+};
+
+static int qcom_smem_get_flash_blksz(uint64_t **smem_blksz)

I don't know, but I prefer u64 because it's short and sweet. But I'm not the maintainer here.

drivers/mtd/qcom_smem_part.c line 64

Quoted 7 lines

drivers/mtd/qcom_smem_part.c new file +6 -0

+{
+	int ret;
+	size_t size;
+
+	ret = qcom_smem_get(SMEM_HOST_APPS, SMEM_BOOT_FLASH_BLOCK_SIZE,
+			    (void **) smem_blksz, &size);

Is the cast necessary?

Quoted 57 lines

drivers/mtd/qcom_smem_part.c new file +56 -0

+
+	if (ret < 0) {
+		pr_err("Unable to read flash blksz from SMEM\n");
+		return -ENOENT;
+	}
+
+	if (size != sizeof(**smem_blksz)) {
+		pr_err("Invalid flash blksz size in SMEM\n");
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static int qcom_smem_get_flash_type(uint64_t **smem_flash_type)
+{
+	int ret;
+	size_t size;
+
+	ret = qcom_smem_get(SMEM_HOST_APPS, SMEM_BOOT_FLASH_TYPE,
+			    (void **) smem_flash_type, &size);
+
+	if (ret < 0) {
+		pr_err("Unable to read flash type from SMEM\n");
+		return -ENOENT;
+	}
+
+	if (size != sizeof(**smem_flash_type)) {
+		pr_err("Invalid flash type size in SMEM\n");
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static int qcom_smem_get_flash_partitions(struct smem_partition_table **pparts)
+{
+	int ret;
+	size_t size;
+
+	ret = qcom_smem_get(SMEM_HOST_APPS, SMEM_AARM_PARTITION_TABLE,
+			    (void **) pparts, &size);
+
+	if (ret < 0) {
+		pr_err("Unable to read partition table from SMEM\n");
+		return -ENOENT;
+	}
+
+	return 0;
+}
+
+static int of_dev_node_match(struct device *dev, void *data)
+{
+	return dev->of_node == data;
+}
+

drivers/mtd/qcom_smem_part.c line 125

Quoted 5 lines

drivers/mtd/qcom_smem_part.c new file +5 -0

+static bool is_spi_device(struct device_node *np)
+{
+	struct device *dev;
+
+	dev = bus_find_device(&spi_bus_type, NULL, np, of_dev_node_match);

I'm pretty sure this holds a reference to the device that needs to be released with put_device().

Quoted 46 lines

drivers/mtd/qcom_smem_part.c new file +45 -0

+	return dev ? true : false;
+}
+
+static int parse_qcom_smem_partitions(struct mtd_info *master,
+				      struct mtd_partition **pparts,
+				      struct mtd_part_parser_data *data)
+{
+	struct smem_partition_table *smem_parts;
+	uint64_t *smem_flash_type, *smem_blksz;
+	struct mtd_partition *mtd_parts;
+	struct device_node *of_node = data->of_node;
+	int i, ret;
+
+	/*
+	 * SMEM will only store the partition table of the boot device.
+	 * If this is not the boot device, do not return any partition.
+	 */
+	ret = qcom_smem_get_flash_type(&smem_flash_type);
+	if (ret < 0)
+		return ret;
+
+	if ((*smem_flash_type == SMEM_FLASH_NAND && !mtd_type_is_nand(master))
+	    || (*smem_flash_type == SMEM_FLASH_SPI && !is_spi_device(of_node)))
+		return 0;
+
+	/*
+	 * Just for sanity purpose, make sure the block size in SMEM matches the
+	 * block size of the MTD device
+	 */
+	ret = qcom_smem_get_flash_blksz(&smem_blksz);
+	if (ret < 0)
+		return ret;
+
+	if (*smem_blksz != master->erasesize) {
+		pr_err("SMEM block size differs from MTD block size\n");
+		return -EINVAL;
+	}
+
+	/* Get partition pointer from SMEM */
+	ret = qcom_smem_get_flash_partitions(&smem_parts);
+	if (ret < 0)
+		return ret;
+
+	if (smem_parts->magic[0] != SMEM_PTABLE_MAGIC_1 ||
+	    smem_parts->magic[1] != SMEM_PTABLE_MAGIC_2) {

drivers/mtd/qcom_smem_part.c line 176

Quoted 6 lines

drivers/mtd/qcom_smem_part.c new file +6 -0

+		pr_err("SMEM partition magic invalid\n");
+		return -EINVAL;
+	}
+
+	/* Allocate and populate the mtd structures */
+	mtd_parts = kcalloc(smem_parts->len, sizeof(struct mtd_partition),

sizeof(*mtd_parts)?

drivers/mtd/qcom_smem_part.c line 178

Quoted 3 lines

drivers/mtd/qcom_smem_part.c new file +2 -0

+			    GFP_KERNEL);
+	if (mtd_parts == NULL)

if (!mtd_parts) is more kernel style.

Quoted 13 lines

drivers/mtd/qcom_smem_part.c new file +12 -0

+		return -ENOMEM;
+
+	for (i = 0; i < smem_parts->len; i++) {
+		struct smem_partition *part = &smem_parts->parts[i];
+
+		mtd_parts[i].name = part->name;
+		mtd_parts[i].size = part->size * (*smem_blksz);
+		mtd_parts[i].offset = part->start * (*smem_blksz);
+
+		/*
+		 * The last SMEM partition may have its size marked as
+		 * something like 0xffffffff, which means "until the end of the

drivers/mtd/qcom_smem_part.c line 194

Quoted 4 lines

drivers/mtd/qcom_smem_part.c new file +4 -0

+		 * flash device". In this case, truncate it.
+		 */
+		if (mtd_parts[i].offset + mtd_parts[i].size > master->size)
+			mtd_parts[i].size = master->size - mtd_parts[i].offset;

That is 7 mtd_parts[i]. instances. Consider making a local variable pointer instead. Actually we could make two pointers for smem_parts->part and mtd_parts and increment both in the loop to make tighter code.

drivers/mtd/qcom_smem_part.c line 197

Quoted 4 lines

drivers/mtd/qcom_smem_part.c new file +3 -0

+	}
+
+	*pparts = mtd_parts;

Oh we already have the pointer, so just do this assignment before iterating.

Signature · 3 lines

-- 
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project