2024-03-08 09:18:44

by Md Sadre Alam

[permalink] [raw]
Subject: [PATCH v4 0/5] Add QPIC SPI NAND driver

v4:
* In this patch series fixes kernel doc for all the cmmon api
* Also fixes dm-binding commit message
* Fix qpic_common.c compilation based on config

v3:
* In this patch series fixes multiple things like
added clock-name, added _alloc_controller api instead
of alloc_master, made common apis more generic etc.

* Addressed all the comment from v2 patch series

v2:
* https://lore.kernel.org/linux-arm-msm/[email protected]/
* In this series of patchs we have added basic working QPIC SPI NAND
driver with READ, WRITE, ERASE etc functionality

* Addressed all the comments given in RFC [v1] patch

v1:
* https://lore.kernel.org/linux-arm-msm/[email protected]/
* Initial set of patches for handling QPIC SPI NAND.


Md Sadre Alam (5):
spi: dt-bindings: Introduce qcom,spi-qpic-snand
drivers: mtd: nand: Add qpic_common API file
spi: spi-qpic: Add qpic spi nand driver support
arm64: dts: qcom: ipq9574: Add SPI nand support
arm64: dts: qcom: ipq9574: Disable eMMC node

.../bindings/spi/qcom,spi-qpic-snand.yaml | 83 +
.../boot/dts/qcom/ipq9574-rdp-common.dtsi | 43 +
arch/arm64/boot/dts/qcom/ipq9574-rdp433.dts | 2 +-
arch/arm64/boot/dts/qcom/ipq9574.dtsi | 27 +
drivers/mtd/nand/Kconfig | 7 +
drivers/mtd/nand/Makefile | 1 +
drivers/mtd/nand/qpic_common.c | 834 ++++++++++
drivers/mtd/nand/raw/Kconfig | 1 +
drivers/mtd/nand/raw/qcom_nandc.c | 1440 ++---------------
drivers/spi/Kconfig | 8 +
drivers/spi/Makefile | 1 +
drivers/spi/spi-qpic-snand.c | 1041 ++++++++++++
include/linux/mtd/nand-qpic-common.h | 547 +++++++
13 files changed, 2729 insertions(+), 1306 deletions(-)
create mode 100644 Documentation/devicetree/bindings/spi/qcom,spi-qpic-snand.yaml
create mode 100644 drivers/mtd/nand/qpic_common.c
create mode 100644 drivers/spi/spi-qpic-snand.c
create mode 100644 include/linux/mtd/nand-qpic-common.h

--
2.34.1



2024-03-08 09:18:45

by Md Sadre Alam

[permalink] [raw]
Subject: [PATCH v4 4/5] arm64: dts: qcom: ipq9574: Add SPI nand support

Add SPI NAND support for ipq9574 SoC.

Signed-off-by: Md Sadre Alam <[email protected]>
---
Change in [v4]

* No change

Change in [v3]

* Updated gpio number as per pin control driver

* Fixed alignment issue

Change in [v2]

* Added initial enablement for spi-nand

Change in [v1]

* Posted as RFC patch for design review


.../boot/dts/qcom/ipq9574-rdp-common.dtsi | 43 +++++++++++++++++++
arch/arm64/boot/dts/qcom/ipq9574.dtsi | 27 ++++++++++++
2 files changed, 70 insertions(+)

diff --git a/arch/arm64/boot/dts/qcom/ipq9574-rdp-common.dtsi b/arch/arm64/boot/dts/qcom/ipq9574-rdp-common.dtsi
index 91e104b0f865..6429a6b3b903 100644
--- a/arch/arm64/boot/dts/qcom/ipq9574-rdp-common.dtsi
+++ b/arch/arm64/boot/dts/qcom/ipq9574-rdp-common.dtsi
@@ -139,6 +139,49 @@ gpio_leds_default: gpio-leds-default-state {
drive-strength = <8>;
bias-pull-up;
};
+
+ qpic_snand_default_state: qpic-snand-default-state {
+ clock-pins {
+ pins = "gpio5";
+ function = "qspi_clk";
+ drive-strength = <8>;
+ bias-disable;
+ };
+
+ cs-pins {
+ pins = "gpio4";
+ function = "qspi_cs";
+ drive-strength = <8>;
+ bias-disable;
+ };
+
+ data-pins {
+ pins = "gpio0", "gpio1", "gpio2", "gpio3";
+ function = "qspi_data";
+ drive-strength = <8>;
+ bias-disable;
+ };
+ };
+};
+
+&qpic_bam {
+ status = "okay";
+};
+
+&qpic_nand {
+ pinctrl-0 = <&qpic_snand_default_state>;
+ pinctrl-names = "default";
+ status = "okay";
+
+ flash@0 {
+ compatible = "spi-nand";
+ reg = <0>;
+ #address-cells = <1>;
+ #size-cells = <1>;
+ nand-ecc-engine = <&qpic_nand>;
+ nand-ecc-strength = <4>;
+ nand-ecc-step-size = <512>;
+ };
};

&usb_0_dwc3 {
diff --git a/arch/arm64/boot/dts/qcom/ipq9574.dtsi b/arch/arm64/boot/dts/qcom/ipq9574.dtsi
index 7f2e5cbf3bbb..786bb3540d6c 100644
--- a/arch/arm64/boot/dts/qcom/ipq9574.dtsi
+++ b/arch/arm64/boot/dts/qcom/ipq9574.dtsi
@@ -319,6 +319,33 @@ tcsr: syscon@1937000 {
reg = <0x01937000 0x21000>;
};

+ qpic_bam: dma-controller@7984000 {
+ compatible = "qcom,bam-v1.7.0";
+ reg = <0x7984000 0x1c000>;
+ interrupts = <GIC_SPI 146 IRQ_TYPE_LEVEL_HIGH>;
+ clocks = <&gcc GCC_QPIC_AHB_CLK>;
+ clock-names = "bam_clk";
+ #dma-cells = <1>;
+ qcom,ee = <0>;
+ status = "disabled";
+ };
+
+ qpic_nand: spi@79b0000 {
+ compatible = "qcom,spi-qpic-snand";
+ reg = <0x79b0000 0x10000>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+ clocks = <&gcc GCC_QPIC_CLK>,
+ <&gcc GCC_QPIC_AHB_CLK>,
+ <&gcc GCC_QPIC_IO_MACRO_CLK>;
+ clock-names = "core", "aon", "iom";
+ dmas = <&qpic_bam 0>,
+ <&qpic_bam 1>,
+ <&qpic_bam 2>;
+ dma-names = "tx", "rx", "cmd";
+ status = "disabled";
+ };
+
sdhc_1: mmc@7804000 {
compatible = "qcom,ipq9574-sdhci", "qcom,sdhci-msm-v5";
reg = <0x07804000 0x1000>,
--
2.34.1


2024-03-08 09:19:03

by Md Sadre Alam

[permalink] [raw]
Subject: [PATCH v4 1/5] spi: dt-bindings: Introduce qcom,spi-qpic-snand

Document the QPIC-SPI-NAND flash controller present in the IPQ SoCs.
It can work both in serial and parallel mode and supports typical
SPI-NAND page cache operations.

Signed-off-by: Md Sadre Alam <[email protected]>
---
Change in [v4]

* Fix spelling mistake in HW description

* Added commit message

* Removed '|' from description

* Removed minItems in clock

* Added blank line

* Removed co-developed by

Change in [v3]

* Updated commit message, removed "dt-bindings" from commit
message

* Updated compatible name as file name

* Added hardware description

* Documented clock-name

* Moved dma-names property to top

* Droped unused label "qpic_nand"

* Fixed indentation in example dt node

Change in [v2]

* Added initial support for dt-bindings

Change in [v1]

* This patch was not included in [v1]

.../bindings/spi/qcom,spi-qpic-snand.yaml | 83 +++++++++++++++++++
1 file changed, 83 insertions(+)
create mode 100644 Documentation/devicetree/bindings/spi/qcom,spi-qpic-snand.yaml

diff --git a/Documentation/devicetree/bindings/spi/qcom,spi-qpic-snand.yaml b/Documentation/devicetree/bindings/spi/qcom,spi-qpic-snand.yaml
new file mode 100644
index 000000000000..f0d9f7643849
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/qcom,spi-qpic-snand.yaml
@@ -0,0 +1,83 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/qcom,spi-qpic-snand.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm QPIC NAND controller
+
+maintainers:
+ - Md sadre Alam <[email protected]>
+
+description:
+ The QCOM QPIC-SPI-NAND flash controller is an extended version of
+ the QCOM QPIC NAND flash controller. It can work both in serial
+ and parallel mode. It supports typical SPI-NAND page cache
+ operations in single, dual or quad IO mode with pipelined ECC
+ encoding/decoding using the QPIC ECC HW engine.
+
+allOf:
+ - $ref: /schemas/spi/spi-controller.yaml#
+
+properties:
+ compatible:
+ enum:
+ - qcom,spi-qpic-snand
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 3
+
+ clock-names:
+ items:
+ - const: core
+ - const: aon
+ - const: iom
+
+ dmas:
+ items:
+ - description: tx DMA channel
+ - description: rx DMA channel
+ - description: cmd DMA channel
+
+ dma-names:
+ items:
+ - const: tx
+ - const: rx
+ - const: cmd
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/clock/qcom,ipq9574-gcc.h>
+ spi@79b0000 {
+ compatible = "qcom,spi-qpic-snand";
+ reg = <0x1ac00000 0x800>;
+
+ clocks = <&gcc GCC_QPIC_CLK>,
+ <&gcc GCC_QPIC_AHB_CLK>,
+ <&gcc GCC_QPIC_IO_MACRO_CLK>;
+ clock-names = "core", "aon", "iom";
+
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ flash@0 {
+ compatible = "spi-nand";
+ reg = <0>;
+ #address-cells = <1>;
+ #size-cells = <1>;
+ nand-ecc-engine = <&qpic_nand>;
+ nand-ecc-strength = <4>;
+ nand-ecc-step-size = <512>;
+ };
+ };
--
2.34.1


2024-03-08 09:19:35

by Md Sadre Alam

[permalink] [raw]
Subject: [PATCH v4 5/5] arm64: dts: qcom: ipq9574: Disable eMMC node

Disable eMMC node

Signed-off-by: Md Sadre Alam <[email protected]>
---
Change in [v4]

* No change

Change in [v3]

* Removed co-developed by

Change in [v2]

* Posted as initial eMMC disable patch

Change in [v1]

* This patch was not included in v1


arch/arm64/boot/dts/qcom/ipq9574-rdp433.dts | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm64/boot/dts/qcom/ipq9574-rdp433.dts b/arch/arm64/boot/dts/qcom/ipq9574-rdp433.dts
index 1bb8d96c9a82..e33e7fafd695 100644
--- a/arch/arm64/boot/dts/qcom/ipq9574-rdp433.dts
+++ b/arch/arm64/boot/dts/qcom/ipq9574-rdp433.dts
@@ -24,7 +24,7 @@ &sdhc_1 {
mmc-hs400-enhanced-strobe;
max-frequency = <384000000>;
bus-width = <8>;
- status = "okay";
+ status = "disabled";
};

&tlmm {
--
2.34.1


2024-03-08 09:19:38

by Md Sadre Alam

[permalink] [raw]
Subject: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support

Add qpic spi nand driver support. The spi nand
driver currently supported the below commands.

-- RESET
-- READ ID
-- SET FEATURE
-- GET FEATURE
-- READ PAGE
-- WRITE PAGE
-- ERASE PAGE

Co-developed-by: Sricharan Ramabadhran <[email protected]>
Signed-off-by: Sricharan Ramabadhran <[email protected]>
Co-developed-by: Varadarajan Narayanan <[email protected]>
Signed-off-by: Varadarajan Narayanan <[email protected]>
Signed-off-by: Md Sadre Alam <[email protected]>
---
Change in [v4]

* No change

Change in [v3]

* Set SPI_QPIC_SNAND to n and added COMPILE_TEST in Kconfig

* Made driver name sorted in Make file

* Made comment like c++

* Changed macro to functions, snandc_set_read_loc_last()
and snandc_set_read_loc_first()

* Added error handling in snandc_set_reg()

* Changed into normal conditional statement for
return snandc->ecc_stats.failed ? -EBADMSG :
snandc->ecc_stats.bitflips;

* Remove cast of wbuf in qpic_snand_program_execute()
function

* Made num_cw variable instead hardcoded value

* changed if..else condition of function qpic_snand_io_op()
to switch..case statement

* Added __devm_spi_alloc_controller() api instead of
devm_spi_alloc_master()

* Disabling clock in remove path

Change in [v2]

* Added initial support for SPI-NAND driver

Change in [v1]

* Added RFC patch for design review

drivers/mtd/nand/qpic_common.c | 8 +
drivers/spi/Kconfig | 8 +
drivers/spi/Makefile | 1 +
drivers/spi/spi-qpic-snand.c | 1041 ++++++++++++++++++++++++++
include/linux/mtd/nand-qpic-common.h | 61 ++
5 files changed, 1119 insertions(+)
create mode 100644 drivers/spi/spi-qpic-snand.c

diff --git a/drivers/mtd/nand/qpic_common.c b/drivers/mtd/nand/qpic_common.c
index 5b7c0d119d9a..67ccb3d05f20 100644
--- a/drivers/mtd/nand/qpic_common.c
+++ b/drivers/mtd/nand/qpic_common.c
@@ -134,6 +134,14 @@ __le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
return &regs->read_location_last2;
case NAND_READ_LOCATION_LAST_CW_3:
return &regs->read_location_last3;
+ case NAND_FLASH_SPI_CFG:
+ return &regs->spi_cfg;
+ case NAND_NUM_ADDR_CYCLES:
+ return &regs->num_addr_cycle;
+ case NAND_BUSY_CHECK_WAIT_CNT:
+ return &regs->busy_wait_cnt;
+ case NAND_FLASH_FEATURES:
+ return &regs->flash_feature;
default:
return NULL;
}
diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
index bc7021da2fe9..63764e943d82 100644
--- a/drivers/spi/Kconfig
+++ b/drivers/spi/Kconfig
@@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
help
QSPI(Quad SPI) driver for Qualcomm QSPI controller.

+config SPI_QPIC_SNAND
+ tristate "QPIC SNAND controller"
+ depends on ARCH_QCOM || COMPILE_TEST
+ help
+ QPIC_SNAND (QPIC SPI NAND) driver for Qualcomm QPIC controller.
+ QPIC controller supports both parallel nand and serial nand.
+ This config will enable serial nand driver for QPIC controller.
+
config SPI_QUP
tristate "Qualcomm SPI controller with QUP interface"
depends on ARCH_QCOM || COMPILE_TEST
diff --git a/drivers/spi/Makefile b/drivers/spi/Makefile
index 4ff8d725ba5e..9015368f8c73 100644
--- a/drivers/spi/Makefile
+++ b/drivers/spi/Makefile
@@ -111,6 +111,7 @@ obj-$(CONFIG_SPI_PXA2XX) += spi-pxa2xx-platform.o
obj-$(CONFIG_SPI_PXA2XX_PCI) += spi-pxa2xx-pci.o
obj-$(CONFIG_SPI_QCOM_GENI) += spi-geni-qcom.o
obj-$(CONFIG_SPI_QCOM_QSPI) += spi-qcom-qspi.o
+obj-$(CONFIG_SPI_QPIC_SNAND) += spi-qpic-snand.o
obj-$(CONFIG_SPI_QUP) += spi-qup.o
obj-$(CONFIG_SPI_ROCKCHIP) += spi-rockchip.o
obj-$(CONFIG_SPI_ROCKCHIP_SFC) += spi-rockchip-sfc.o
diff --git a/drivers/spi/spi-qpic-snand.c b/drivers/spi/spi-qpic-snand.c
new file mode 100644
index 000000000000..df7d5d8d4db2
--- /dev/null
+++ b/drivers/spi/spi-qpic-snand.c
@@ -0,0 +1,1041 @@
+/*
+ * SPDX-License-Identifier: GPL-2.0
+ *
+ * Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved.
+ *
+ * Authors:
+ * Md Sadre Alam <[email protected]>
+ * Sricharan R <[email protected]>
+ * Varadarajan Narayanan <[email protected]>
+ */
+
+#include <linux/mtd/spinand.h>
+#include <linux/mtd/nand-qpic-common.h>
+
+/* QSPI NAND config reg bits */
+#define LOAD_CLK_CNTR_INIT_EN BIT(28)
+#define CLK_CNTR_INIT_VAL_VEC 0x924
+#define FEA_STATUS_DEV_ADDR 0xc0
+#define SPI_CFG BIT(0)
+#define SPI_NUM_ADDR 0xDA4DB
+#define SPI_WAIT_CNT 0x10
+#define QPIC_QSPI_NUM_CS 1
+#define SPI_TRANSFER_MODE_x1 BIT(29)
+#define SPI_TRANSFER_MODE_x4 (3 << 29)
+#define SPI_WP BIT(28)
+#define SPI_HOLD BIT(27)
+#define QPIC_SET_FEATURE BIT(31)
+
+#define SPINAND_RESET 0xff
+#define SPINAND_READID 0x9f
+#define SPINAND_GET_FEATURE 0x0f
+#define SPINAND_SET_FEATURE 0x1f
+#define SPINAND_READ 0x13
+#define SPINAND_ERASE 0xd8
+#define SPINAND_WRITE_EN 0x06
+#define SPINAND_PROGRAM_EXECUTE 0x10
+#define SPINAND_PROGRAM_LOAD 0x84
+
+struct qpic_snand_op {
+ u32 cmd_reg;
+ u32 addr1_reg;
+ u32 addr2_reg;
+};
+
+struct snandc_read_status {
+ __le32 snandc_flash;
+ __le32 snandc_buffer;
+ __le32 snandc_erased_cw;
+};
+
+static void snandc_set_reg(struct qcom_nand_controller *snandc, int offset, u32 val)
+{
+ struct nandc_regs *regs = snandc->regs;
+ __le32 *reg;
+
+ reg = qcom_offset_to_nandc_reg(regs, offset);
+
+ if (reg)
+ *reg = cpu_to_le32(val);
+
+ if (WARN_ON(!reg))
+ return;
+}
+
+static void snandc_set_read_loc_first(struct qcom_nand_controller *snandc,
+ int reg, int cw_offset, int read_size,
+ int is_last_read_loc)
+{
+ snandc_set_reg(snandc, reg, ((cw_offset) << READ_LOCATION_OFFSET) |
+ ((read_size) << READ_LOCATION_SIZE) | ((is_last_read_loc)
+ << READ_LOCATION_LAST));
+}
+
+static void snandc_set_read_loc_last(struct qcom_nand_controller *snandc,
+ int reg, int cw_offset, int read_size,
+ int is_last_read_loc)
+{
+ snandc_set_reg(snandc, reg, ((cw_offset) << READ_LOCATION_OFFSET) |
+ ((read_size) << READ_LOCATION_SIZE) | ((is_last_read_loc)
+ << READ_LOCATION_LAST));
+}
+
+static struct qcom_nand_controller *nand_to_qcom_snand(struct nand_device *nand)
+{
+ struct nand_ecc_engine *eng = nand->ecc.engine;
+
+ return container_of(eng, struct qcom_nand_controller, ecc_eng);
+}
+
+static int qcom_snand_init(struct qcom_nand_controller *snandc)
+{
+ u32 snand_cfg_val = 0x0;
+ int ret;
+
+ snand_cfg_val |= (LOAD_CLK_CNTR_INIT_EN | (CLK_CNTR_INIT_VAL_VEC << 16)
+ | (FEA_STATUS_DEV_ADDR << 8) | SPI_CFG);
+
+ snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, 0);
+ snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, snand_cfg_val);
+ snandc_set_reg(snandc, NAND_NUM_ADDR_CYCLES, SPI_NUM_ADDR);
+ snandc_set_reg(snandc, NAND_BUSY_CHECK_WAIT_CNT, SPI_WAIT_CNT);
+
+ qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
+ qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
+
+ snand_cfg_val &= ~LOAD_CLK_CNTR_INIT_EN;
+ snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, snand_cfg_val);
+
+ qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
+
+ qcom_write_reg_dma(snandc, NAND_NUM_ADDR_CYCLES, 1, 0);
+ qcom_write_reg_dma(snandc, NAND_BUSY_CHECK_WAIT_CNT, 1, NAND_BAM_NEXT_SGL);
+
+ ret = qcom_submit_descs(snandc);
+ if (ret)
+ dev_err(snandc->dev, "failure in sbumitting spiinit descriptor\n");
+
+ return 0;
+}
+
+static int qcom_snand_ooblayout_ecc(struct mtd_info *mtd, int section,
+ struct mtd_oob_region *oobregion)
+{
+ struct nand_device *nand = mtd_to_nanddev(mtd);
+ struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
+ struct qpic_ecc *qecc = snandc->ecc;
+
+ if (section > 1)
+ return -ERANGE;
+
+ if (!section) {
+ oobregion->length = (qecc->bytes * (qecc->steps - 1)) + qecc->bbm_size;
+ oobregion->offset = 0;
+ } else {
+ oobregion->length = qecc->ecc_bytes_hw + qecc->spare_bytes;
+ oobregion->offset = mtd->oobsize - oobregion->length;
+ }
+
+ return 0;
+}
+
+static int qcom_snand_ooblayout_free(struct mtd_info *mtd, int section,
+ struct mtd_oob_region *oobregion)
+{
+ struct nand_device *nand = mtd_to_nanddev(mtd);
+ struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
+ struct qpic_ecc *qecc = snandc->ecc;
+
+ if (section)
+ return -ERANGE;
+
+ oobregion->length = qecc->steps * 4;
+ oobregion->offset = ((qecc->steps - 1) * qecc->bytes) + qecc->bbm_size;
+
+ return 0;
+}
+
+static const struct mtd_ooblayout_ops qcom_snand_ooblayout = {
+ .ecc = qcom_snand_ooblayout_ecc,
+ .free = qcom_snand_ooblayout_free,
+};
+
+static int qpic_snand_ecc_init_ctx_pipelined(struct nand_device *nand)
+{
+ struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
+ struct nand_ecc_props *conf = &nand->ecc.ctx.conf;
+ struct nand_ecc_props *reqs = &nand->ecc.requirements;
+ struct nand_ecc_props *user = &nand->ecc.user_conf;
+ struct mtd_info *mtd = nanddev_to_mtd(nand);
+ int step_size = 0, strength = 0, steps;
+ int cwperpage, bad_block_byte;
+ struct qpic_ecc *ecc_cfg;
+
+ cwperpage = mtd->writesize / NANDC_STEP_SIZE;
+ snandc->num_cw = cwperpage;
+
+ ecc_cfg = kzalloc(sizeof(*ecc_cfg), GFP_KERNEL);
+ if (!ecc_cfg)
+ return -ENOMEM;
+
+ nand->ecc.ctx.priv = ecc_cfg;
+
+ if (user->step_size && user->strength) {
+ step_size = user->step_size;
+ strength = user->strength;
+ } else if (reqs->step_size && reqs->strength) {
+ step_size = reqs->step_size;
+ strength = reqs->strength;
+ }
+
+ if (step_size && strength)
+ steps = mtd->writesize / step_size;
+
+ ecc_cfg->ecc_bytes_hw = 7;
+ ecc_cfg->spare_bytes = 4;
+ ecc_cfg->bbm_size = 1;
+ ecc_cfg->bch_enabled = true;
+ ecc_cfg->bytes = ecc_cfg->ecc_bytes_hw + ecc_cfg->spare_bytes + ecc_cfg->bbm_size;
+
+ ecc_cfg->steps = 4;
+ ecc_cfg->strength = 4;
+ ecc_cfg->step_size = 512;
+
+ mtd_set_ooblayout(mtd, &qcom_snand_ooblayout);
+
+ ecc_cfg->cw_data = 516;
+ ecc_cfg->cw_size = ecc_cfg->cw_data + ecc_cfg->bytes;
+ bad_block_byte = mtd->writesize - ecc_cfg->cw_size * (cwperpage - 1) + 1;
+
+ ecc_cfg->cfg0 = (cwperpage - 1) << CW_PER_PAGE
+ | ecc_cfg->cw_data << UD_SIZE_BYTES
+ | 1 << DISABLE_STATUS_AFTER_WRITE
+ | 3 << NUM_ADDR_CYCLES
+ | ecc_cfg->ecc_bytes_hw << ECC_PARITY_SIZE_BYTES_RS
+ | 0 << STATUS_BFR_READ
+ | 1 << SET_RD_MODE_AFTER_STATUS
+ | ecc_cfg->spare_bytes << SPARE_SIZE_BYTES;
+
+ ecc_cfg->cfg1 = 0 << NAND_RECOVERY_CYCLES
+ | 0 << CS_ACTIVE_BSY
+ | bad_block_byte << BAD_BLOCK_BYTE_NUM
+ | 0 << BAD_BLOCK_IN_SPARE_AREA
+ | 20 << WR_RD_BSY_GAP
+ | 0 << WIDE_FLASH
+ | ecc_cfg->bch_enabled << ENABLE_BCH_ECC;
+
+ ecc_cfg->cfg0_raw = (cwperpage - 1) << CW_PER_PAGE
+ | ecc_cfg->cw_size << UD_SIZE_BYTES
+ | 3 << NUM_ADDR_CYCLES
+ | 0 << SPARE_SIZE_BYTES;
+
+ ecc_cfg->cfg1_raw = 0 << NAND_RECOVERY_CYCLES
+ | 0 << CS_ACTIVE_BSY
+ | 17 << BAD_BLOCK_BYTE_NUM
+ | 1 << BAD_BLOCK_IN_SPARE_AREA
+ | 20 << WR_RD_BSY_GAP
+ | 0 << WIDE_FLASH
+ | 1 << DEV0_CFG1_ECC_DISABLE;
+
+ ecc_cfg->ecc_bch_cfg = !ecc_cfg->bch_enabled << ECC_CFG_ECC_DISABLE
+ | 0 << ECC_SW_RESET
+ | ecc_cfg->cw_data << ECC_NUM_DATA_BYTES
+ | 1 << ECC_FORCE_CLK_OPEN
+ | 0 << ECC_MODE
+ | ecc_cfg->ecc_bytes_hw << ECC_PARITY_SIZE_BYTES_BCH;
+
+ ecc_cfg->ecc_buf_cfg = 0x203 << NUM_STEPS;
+ ecc_cfg->clrflashstatus = FS_READY_BSY_N;
+ ecc_cfg->clrreadstatus = 0xc0;
+
+ conf->step_size = ecc_cfg->step_size;
+ conf->strength = ecc_cfg->strength;
+
+ if (ecc_cfg->strength < strength)
+ dev_warn(snandc->dev, "Unable to fulfill ECC requirements of %u bits.\n", strength);
+
+ dev_info(snandc->dev, "ECC strength: %u bits per %u bytes\n",
+ ecc_cfg->strength, ecc_cfg->step_size);
+
+ return 0;
+}
+
+static void qpic_snand_ecc_cleanup_ctx_pipelined(struct nand_device *nand)
+{
+ struct qpic_ecc *ecc_cfg = nand_to_ecc_ctx(nand);
+
+ kfree(ecc_cfg);
+}
+
+static int qpic_snand_ecc_prepare_io_req_pipelined(struct nand_device *nand,
+ struct nand_page_io_req *req)
+{
+ struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
+ struct qpic_ecc *ecc_cfg = nand_to_ecc_ctx(nand);
+
+ snandc->ecc = ecc_cfg;
+ snandc->raw = false;
+ snandc->oob_read = false;
+
+ if (req->mode == MTD_OPS_RAW) {
+ if (req->ooblen)
+ snandc->oob_read = true;
+ snandc->raw = true;
+ }
+
+ return 0;
+}
+
+static int qpic_snand_ecc_finish_io_req_pipelined(struct nand_device *nand,
+ struct nand_page_io_req *req)
+{
+ struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
+ struct mtd_info *mtd = nanddev_to_mtd(nand);
+
+ if (req->mode == MTD_OPS_RAW || req->type != NAND_PAGE_READ)
+ return 0;
+
+ if (snandc->ecc_stats.failed)
+ mtd->ecc_stats.failed += snandc->ecc_stats.failed;
+ mtd->ecc_stats.corrected += snandc->ecc_stats.corrected;
+
+ if (snandc->ecc_stats.failed)
+ return -EBADMSG;
+ else
+ return snandc->ecc_stats.bitflips;
+}
+
+static struct nand_ecc_engine_ops qcom_snand_ecc_engine_ops_pipelined = {
+ .init_ctx = qpic_snand_ecc_init_ctx_pipelined,
+ .cleanup_ctx = qpic_snand_ecc_cleanup_ctx_pipelined,
+ .prepare_io_req = qpic_snand_ecc_prepare_io_req_pipelined,
+ .finish_io_req = qpic_snand_ecc_finish_io_req_pipelined,
+};
+
+/* helper to configure location register values */
+static void snandc_set_read_loc(struct qcom_nand_controller *snandc, int cw, int reg,
+ int cw_offset, int read_size, int is_last_read_loc)
+{
+ int reg_base = NAND_READ_LOCATION_0;
+
+ if (cw == 3)
+ reg_base = NAND_READ_LOCATION_LAST_CW_0;
+
+ reg_base += reg * 4;
+
+ if (cw == 3)
+ return snandc_set_read_loc_last(snandc, reg_base, cw_offset,
+ read_size, is_last_read_loc);
+ else
+ return snandc_set_read_loc_first(snandc, reg_base, cw_offset,
+ read_size, is_last_read_loc);
+}
+
+static void
+snandc_config_cw_read(struct qcom_nand_controller *snandc, bool use_ecc, int cw)
+{
+ int reg = NAND_READ_LOCATION_0;
+
+ if (cw == 3)
+ reg = NAND_READ_LOCATION_LAST_CW_0;
+
+ if (snandc->props->is_bam)
+ qcom_write_reg_dma(snandc, reg, 4, NAND_BAM_NEXT_SGL);
+
+ qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+
+ qcom_read_reg_dma(snandc, NAND_FLASH_STATUS, 2, 0);
+ qcom_read_reg_dma(snandc, NAND_ERASED_CW_DETECT_STATUS, 1,
+ NAND_BAM_NEXT_SGL);
+}
+
+static int qpic_snand_block_erase(struct qcom_nand_controller *snandc)
+{
+ struct qpic_ecc *ecc_cfg = snandc->ecc;
+ int ret;
+
+ snandc->buf_count = 0;
+ snandc->buf_start = 0;
+ qcom_clear_read_regs(snandc);
+ qcom_clear_bam_transaction(snandc);
+
+ snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
+ snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
+ snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
+ snandc_set_reg(snandc, NAND_DEV0_CFG0, ecc_cfg->cfg0_raw & ~(7 << CW_PER_PAGE));
+ snandc_set_reg(snandc, NAND_DEV0_CFG1, ecc_cfg->cfg1_raw);
+ snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
+
+ qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 3, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 2, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+
+ ret = qcom_submit_descs(snandc);
+ if (ret) {
+ dev_err(snandc->dev, "failure to erase block\n");
+ return ret;
+ }
+
+ return 0;
+}
+
+static void config_snand_single_cw_page_read(struct qcom_nand_controller *snandc,
+ bool use_ecc, int cw)
+{
+ int reg;
+
+ qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
+ qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
+ qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
+ qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1,
+ NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
+
+ reg = NAND_READ_LOCATION_0;
+ if (cw == 3)
+ reg = NAND_READ_LOCATION_LAST_CW_0;
+ qcom_write_reg_dma(snandc, reg, 4, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+
+ qcom_read_reg_dma(snandc, NAND_FLASH_STATUS, 2, 0);
+ qcom_read_reg_dma(snandc, NAND_ERASED_CW_DETECT_STATUS, 1, NAND_BAM_NEXT_SGL);
+}
+
+static int qpic_snand_read_oob(struct qcom_nand_controller *snandc,
+ const struct spi_mem_op *op)
+{
+ struct qpic_ecc *ecc_cfg = snandc->ecc;
+ int size, ret;
+ int col, bbpos;
+ u32 cfg0, cfg1, ecc_bch_cfg;
+ u32 num_cw = snandc->num_cw;
+
+ qcom_clear_bam_transaction(snandc);
+ qcom_clear_read_regs(snandc);
+
+ size = ecc_cfg->cw_size;
+ col = ecc_cfg->cw_size * (num_cw - 1);
+
+ /* prepare a clean read buffer */
+ memset(snandc->data_buffer, 0xff, size);
+ snandc_set_reg(snandc, NAND_ADDR0, (snandc->addr1 | col));
+ snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
+
+ cfg0 = (ecc_cfg->cfg0_raw & ~(7U << CW_PER_PAGE)) |
+ 0 << CW_PER_PAGE;
+ cfg1 = ecc_cfg->cfg1_raw;
+ ecc_bch_cfg = 1 << ECC_CFG_ECC_DISABLE;
+
+ snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
+ snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
+ snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
+ snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
+ snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
+
+ config_snand_single_cw_page_read(snandc, false, num_cw - 1);
+
+ qcom_read_data_dma(snandc, FLASH_BUF_ACC, snandc->data_buffer, size, 0);
+
+ ret = qcom_submit_descs(snandc);
+ if (ret)
+ dev_err(snandc->dev, "failed to read oob\n");
+
+ qcom_nandc_read_buffer_sync(snandc, true);
+ u32 flash = le32_to_cpu(snandc->reg_read_buf[0]);
+
+ if (flash & (FS_OP_ERR | FS_MPU_ERR))
+ return -EIO;
+
+ bbpos = 2048 - ecc_cfg->cw_size * (num_cw - 1);
+ memcpy(op->data.buf.in, snandc->data_buffer + bbpos, op->data.nbytes);
+
+ return ret;
+}
+
+static int snandc_check_error(struct qcom_nand_controller *snandc)
+{
+ struct snandc_read_status *buf;
+ int i, num_cw = snandc->num_cw;
+ bool serial_op_err = false, erased;
+
+ qcom_nandc_read_buffer_sync(snandc, true);
+ buf = (struct snandc_read_status *)snandc->reg_read_buf;
+
+ for (i = 0; i < num_cw; i++, buf++) {
+ u32 flash, buffer, erased_cw;
+
+ flash = le32_to_cpu(buf->snandc_flash);
+ buffer = le32_to_cpu(buf->snandc_buffer);
+ erased_cw = le32_to_cpu(buf->snandc_erased_cw);
+
+ if ((flash & FS_OP_ERR) && (buffer & BS_UNCORRECTABLE_BIT)) {
+ erased = (erased_cw & ERASED_CW) == ERASED_CW ?
+ true : false;
+ } else if (flash & (FS_OP_ERR | FS_MPU_ERR)) {
+ serial_op_err = true;
+ }
+ }
+
+ if (serial_op_err)
+ return -EIO;
+
+ return 0;
+}
+
+static int qpic_snand_read_page_cache(struct qcom_nand_controller *snandc,
+ const struct spi_mem_op *op)
+{
+ struct qpic_ecc *ecc_cfg = snandc->ecc;
+ u8 *data_buf;
+ int ret, i;
+ u32 cfg0, cfg1, ecc_bch_cfg, num_cw = snandc->num_cw;
+
+ data_buf = op->data.buf.in;
+
+ if (snandc->oob_read) {
+ return qpic_snand_read_oob(snandc, op);
+ snandc->oob_read = false;
+ }
+
+ snandc->buf_count = 0;
+ snandc->buf_start = 0;
+ qcom_clear_read_regs(snandc);
+
+ cfg0 = (ecc_cfg->cfg0 & ~(7U << CW_PER_PAGE)) |
+ (num_cw - 1) << CW_PER_PAGE;
+ cfg1 = ecc_cfg->cfg1;
+ ecc_bch_cfg = ecc_cfg->ecc_bch_cfg;
+
+ snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
+ snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
+ snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
+ snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
+ snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
+ snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
+ snandc_set_reg(snandc, NAND_FLASH_STATUS, ecc_cfg->clrflashstatus);
+ snandc_set_reg(snandc, NAND_READ_STATUS, ecc_cfg->clrreadstatus);
+ snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
+ snandc_set_read_loc(snandc, 0, 0, 0, ecc_cfg->cw_data, 1);
+
+ qcom_clear_bam_transaction(snandc);
+
+ qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
+ qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
+ qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
+ qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1,
+ NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
+
+ for (i = 0; i < num_cw; i++) {
+ int data_size;
+
+ if (i == (num_cw - 1))
+ data_size = 512 - ((num_cw - 1) << 2);
+ else
+ data_size = ecc_cfg->cw_data;
+
+ if (data_buf)
+ snandc_set_read_loc(snandc, i, 0, 0, data_size, 1);
+
+ snandc_config_cw_read(snandc, true, i);
+
+ if (data_buf)
+ qcom_read_data_dma(snandc, FLASH_BUF_ACC, data_buf,
+ data_size, 0);
+
+ if (data_buf)
+ data_buf += data_size;
+ }
+
+ ret = qcom_submit_descs(snandc);
+ if (ret) {
+ dev_err(snandc->dev, "failure to read page/oob\n");
+ return ret;
+ }
+
+ return snandc_check_error(snandc);
+}
+
+static void config_snand_page_write(struct qcom_nand_controller *snandc)
+{
+ qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
+ qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
+ qcom_write_reg_dma(snandc, NAND_EBI2_ECC_BUF_CFG, 1, NAND_BAM_NEXT_SGL);
+}
+
+static void config_snand_cw_write(struct qcom_nand_controller *snandc)
+{
+ qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+}
+
+static int qpic_snand_program_execute(struct qcom_nand_controller *snandc,
+ const struct spi_mem_op *op)
+{
+ struct qpic_ecc *ecc_cfg = snandc->ecc;
+ u8 *data_buf;
+ int i, ret;
+ int num_cw = snandc->num_cw;
+ u32 cfg0, cfg1, ecc_bch_cfg, ecc_buf_cfg;
+
+ cfg0 = (ecc_cfg->cfg0 & ~(7U << CW_PER_PAGE)) |
+ (num_cw - 1) << CW_PER_PAGE;
+ cfg1 = ecc_cfg->cfg1;
+ ecc_bch_cfg = ecc_cfg->ecc_bch_cfg;
+ ecc_buf_cfg = ecc_cfg->ecc_buf_cfg;
+
+ data_buf = snandc->wbuf;
+
+ snandc->buf_count = 0;
+ snandc->buf_start = 0;
+ qcom_clear_read_regs(snandc);
+ qcom_clear_bam_transaction(snandc);
+
+ snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
+ snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
+ snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
+
+ snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
+ snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
+ snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
+
+ snandc_set_reg(snandc, NAND_EBI2_ECC_BUF_CFG, ecc_buf_cfg);
+
+ snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
+
+ config_snand_page_write(snandc);
+
+ for (i = 0; i < num_cw; i++) {
+ int data_size;
+
+ if (i == (num_cw - 1))
+ data_size = NANDC_STEP_SIZE - ((num_cw - 1) << 2);
+ else
+ data_size = ecc_cfg->cw_data;
+
+ qcom_write_data_dma(snandc, FLASH_BUF_ACC, data_buf, data_size,
+ i == (num_cw - 1) ? NAND_BAM_NO_EOT : 0);
+
+ config_snand_cw_write(snandc);
+ if (data_buf)
+ data_buf += data_size;
+ }
+
+ ret = qcom_submit_descs(snandc);
+ if (ret) {
+ dev_err(snandc->dev, "failure to write page\n");
+ return ret;
+ }
+
+ return 0;
+}
+
+static u32 qpic_snand_cmd_mapping(struct qcom_nand_controller *snandc, u32 opcode)
+{
+ u32 cmd = 0x0;
+
+ switch (opcode) {
+ case SPINAND_RESET:
+ cmd = (SPI_WP | SPI_HOLD | SPI_TRANSFER_MODE_x1 | OP_RESET_DEVICE);
+ break;
+ case SPINAND_READID:
+ cmd = (SPI_WP | SPI_HOLD | SPI_TRANSFER_MODE_x1 | OP_FETCH_ID);
+ break;
+ case SPINAND_GET_FEATURE:
+ cmd = (SPI_TRANSFER_MODE_x1 | SPI_WP | SPI_HOLD | ACC_FEATURE);
+ break;
+ case SPINAND_SET_FEATURE:
+ cmd = (SPI_TRANSFER_MODE_x1 | SPI_WP | SPI_HOLD | ACC_FEATURE |
+ QPIC_SET_FEATURE);
+ break;
+ case SPINAND_READ:
+ if (snandc->raw)
+ cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
+ SPI_WP | SPI_HOLD | OP_PAGE_READ);
+ else
+ cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
+ SPI_WP | SPI_HOLD | OP_PAGE_READ_WITH_ECC);
+ break;
+ case SPINAND_ERASE:
+ cmd = OP_BLOCK_ERASE | PAGE_ACC | LAST_PAGE | SPI_WP |
+ SPI_HOLD | SPI_TRANSFER_MODE_x1;
+ break;
+ case SPINAND_WRITE_EN:
+ cmd = SPINAND_WRITE_EN;
+ break;
+ case SPINAND_PROGRAM_EXECUTE:
+ cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
+ SPI_WP | SPI_HOLD | OP_PROGRAM_PAGE);
+ break;
+ case SPINAND_PROGRAM_LOAD:
+ cmd = SPINAND_PROGRAM_LOAD;
+ break;
+ default:
+ break;
+ }
+
+ return cmd;
+}
+
+static int qpic_snand_write_page_cache(struct qcom_nand_controller *snandc,
+ const struct spi_mem_op *op)
+{
+ struct qpic_snand_op s_op = {};
+ u32 cmd;
+
+ cmd = qpic_snand_cmd_mapping(snandc, op->cmd.opcode);
+ s_op.cmd_reg = cmd;
+
+ if (op->cmd.opcode == SPINAND_PROGRAM_LOAD) {
+ snandc->wbuf = (u8 *)op->data.buf.out;
+ snandc->wlen = op->data.nbytes;
+ }
+
+ return 0;
+}
+
+static int qpic_snand_send_cmdaddr(struct qcom_nand_controller *snandc,
+ const struct spi_mem_op *op)
+{
+ struct qpic_snand_op s_op = {};
+ u32 cmd;
+ int ret;
+
+ cmd = qpic_snand_cmd_mapping(snandc, op->cmd.opcode);
+
+ s_op.cmd_reg = cmd;
+ s_op.addr1_reg = op->addr.val;
+ s_op.addr2_reg = 0;
+
+ if (op->cmd.opcode == SPINAND_WRITE_EN)
+ return 0;
+
+ if (op->cmd.opcode == SPINAND_PROGRAM_EXECUTE) {
+ s_op.addr1_reg = op->addr.val << 16;
+ s_op.addr2_reg = op->addr.val >> 16 & 0xff;
+ snandc->addr1 = s_op.addr1_reg;
+ snandc->addr2 = s_op.addr2_reg;
+ snandc->cmd = cmd;
+ return qpic_snand_program_execute(snandc, op);
+ }
+
+ if (op->cmd.opcode == SPINAND_READ) {
+ s_op.addr1_reg = (op->addr.val << 16);
+ s_op.addr2_reg = op->addr.val >> 16 & 0xff;
+ snandc->addr1 = s_op.addr1_reg;
+ snandc->addr2 = s_op.addr2_reg;
+ snandc->cmd = cmd;
+ return 0;
+ }
+
+ if (op->cmd.opcode == SPINAND_ERASE) {
+ s_op.addr2_reg = (op->addr.val >> 16) & 0xffff;
+ s_op.addr1_reg = op->addr.val;
+ snandc->addr1 = s_op.addr1_reg;
+ snandc->addr1 <<= 16;
+ snandc->addr2 = s_op.addr2_reg;
+ snandc->cmd = cmd;
+ qpic_snand_block_erase(snandc);
+ return 0;
+ }
+
+ snandc->buf_count = 0;
+ snandc->buf_start = 0;
+ qcom_clear_read_regs(snandc);
+ qcom_clear_bam_transaction(snandc);
+
+ snandc_set_reg(snandc, NAND_FLASH_CMD, s_op.cmd_reg);
+ snandc_set_reg(snandc, NAND_EXEC_CMD, 0x1);
+ snandc_set_reg(snandc, NAND_ADDR0, s_op.addr1_reg);
+ snandc_set_reg(snandc, NAND_ADDR1, s_op.addr2_reg);
+
+ qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 3, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+
+ ret = qcom_submit_descs(snandc);
+ if (ret)
+ dev_err(snandc->dev, "failure in sbumitting cmd descriptor\n");
+
+ return ret;
+}
+
+static int qpic_snand_io_op(struct qcom_nand_controller *snandc, const struct spi_mem_op *op)
+{
+ int ret, val, opcode;
+ bool copy = false, copy_ftr = false;
+
+ ret = qpic_snand_send_cmdaddr(snandc, op);
+ if (ret)
+ return ret;
+
+ snandc->buf_count = 0;
+ snandc->buf_start = 0;
+ qcom_clear_read_regs(snandc);
+ qcom_clear_bam_transaction(snandc);
+ opcode = op->cmd.opcode;
+
+ switch (opcode) {
+ case SPINAND_READID:
+ snandc->buf_count = 4;
+ qcom_read_reg_dma(snandc, NAND_READ_ID, 1, NAND_BAM_NEXT_SGL);
+ copy = true;
+ break;
+ case SPINAND_GET_FEATURE:
+ snandc->buf_count = 4;
+ qcom_read_reg_dma(snandc, NAND_FLASH_FEATURES, 1, NAND_BAM_NEXT_SGL);
+ copy_ftr = true;
+ break;
+ case SPINAND_SET_FEATURE:
+ snandc_set_reg(snandc, NAND_FLASH_FEATURES, *(u32 *)op->data.buf.out);
+ qcom_write_reg_dma(snandc, NAND_FLASH_FEATURES, 1, NAND_BAM_NEXT_SGL);
+ break;
+ default:
+ return 0;
+ }
+
+ ret = qcom_submit_descs(snandc);
+ if (ret)
+ dev_err(snandc->dev, "failure in submitting descriptor for:%d\n", opcode);
+
+ if (copy) {
+ qcom_nandc_read_buffer_sync(snandc, true);
+ memcpy(op->data.buf.in, snandc->reg_read_buf, snandc->buf_count);
+ }
+
+ if (copy_ftr) {
+ qcom_nandc_read_buffer_sync(snandc, true);
+ val = le32_to_cpu(*(__le32 *)snandc->reg_read_buf);
+ val >>= 8;
+ memcpy(op->data.buf.in, &val, snandc->buf_count);
+ }
+
+ return ret;
+}
+
+static bool qpic_snand_is_page_op(const struct spi_mem_op *op)
+{
+ if (op->addr.buswidth != 1 && op->addr.buswidth != 2 && op->addr.buswidth != 4)
+ return false;
+
+ if (op->data.dir == SPI_MEM_DATA_IN) {
+ if (op->addr.buswidth == 4 && op->data.buswidth == 4)
+ return true;
+
+ if (op->addr.nbytes == 2 && op->addr.buswidth == 1)
+ return true;
+
+ } else if (op->data.dir == SPI_MEM_DATA_OUT) {
+ if (op->data.buswidth == 4)
+ return true;
+ if (op->addr.nbytes == 2 && op->addr.buswidth == 1)
+ return true;
+ }
+
+ return false;
+}
+
+static bool qpic_snand_supports_op(struct spi_mem *mem, const struct spi_mem_op *op)
+{
+ if (!spi_mem_default_supports_op(mem, op))
+ return false;
+
+ if (op->cmd.nbytes != 1 || op->cmd.buswidth != 1)
+ return false;
+
+ if (qpic_snand_is_page_op(op))
+ return true;
+
+ return ((op->addr.nbytes == 0 || op->addr.buswidth == 1) &&
+ (op->dummy.nbytes == 0 || op->dummy.buswidth == 1) &&
+ (op->data.nbytes == 0 || op->data.buswidth == 1));
+}
+
+static int qpic_snand_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
+{
+ struct qcom_nand_controller *snandc = spi_controller_get_devdata(mem->spi->controller);
+
+ dev_dbg(snandc->dev, "OP %02x ADDR %08llX@%d:%u DATA %d:%u", op->cmd.opcode,
+ op->addr.val, op->addr.buswidth, op->addr.nbytes,
+ op->data.buswidth, op->data.nbytes);
+
+ if (qpic_snand_is_page_op(op)) {
+ if (op->data.dir == SPI_MEM_DATA_IN)
+ return qpic_snand_read_page_cache(snandc, op);
+ if (op->data.dir == SPI_MEM_DATA_OUT)
+ return qpic_snand_write_page_cache(snandc, op);
+ } else {
+ return qpic_snand_io_op(snandc, op);
+ }
+
+ return 0;
+}
+
+static const struct spi_controller_mem_ops qcom_spi_mem_ops = {
+ .supports_op = qpic_snand_supports_op,
+ .exec_op = qpic_snand_exec_op,
+};
+
+static const struct spi_controller_mem_caps qcom_snand_mem_caps = {
+ .ecc = true,
+};
+
+static int qcom_snand_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct spi_controller *ctlr;
+ struct qcom_nand_controller *snandc;
+ struct resource *res;
+ const void *dev_data;
+ struct qpic_ecc *ecc;
+ int ret;
+
+ ecc = devm_kzalloc(dev, sizeof(*ecc), GFP_KERNEL);
+ if (!ecc)
+ return -ENOMEM;
+
+ ctlr = __devm_spi_alloc_controller(dev, sizeof(*snandc), false);
+ if (!ctlr)
+ return -ENOMEM;
+
+ platform_set_drvdata(pdev, ctlr);
+
+ snandc = spi_controller_get_devdata(ctlr);
+
+ snandc->ctlr = ctlr;
+ snandc->dev = dev;
+ snandc->ecc = ecc;
+
+ dev_data = of_device_get_match_data(dev);
+ if (!dev_data) {
+ dev_err(&pdev->dev, "failed to get device data\n");
+ return -ENODEV;
+ }
+
+ snandc->props = dev_data;
+ snandc->dev = &pdev->dev;
+
+ snandc->core_clk = devm_clk_get(dev, "core");
+ if (IS_ERR(snandc->core_clk))
+ return PTR_ERR(snandc->core_clk);
+
+ snandc->aon_clk = devm_clk_get(dev, "aon");
+ if (IS_ERR(snandc->aon_clk))
+ return PTR_ERR(snandc->aon_clk);
+
+ snandc->iomacro_clk = devm_clk_get(dev, "iom");
+ if (IS_ERR(snandc->iomacro_clk))
+ return PTR_ERR(snandc->iomacro_clk);
+
+ snandc->base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
+ if (IS_ERR(snandc->base))
+ return PTR_ERR(snandc->base);
+
+ snandc->base_phys = res->start;
+ snandc->base_dma = dma_map_resource(dev, res->start, resource_size(res),
+ DMA_BIDIRECTIONAL, 0);
+ if (dma_mapping_error(dev, snandc->base_dma))
+ return -ENXIO;
+
+ ret = clk_prepare_enable(snandc->core_clk);
+ if (ret)
+ goto err_core_clk;
+
+ ret = clk_prepare_enable(snandc->aon_clk);
+ if (ret)
+ goto err_aon_clk;
+
+ ret = clk_prepare_enable(snandc->iomacro_clk);
+ if (ret)
+ goto err_snandc_alloc;
+
+ ret = qcom_nandc_alloc(snandc);
+ if (ret)
+ goto err_snandc_alloc;
+
+ ret = qcom_snand_init(snandc);
+ if (ret)
+ goto err_init;
+
+ /* setup ECC engine */
+ snandc->ecc_eng.dev = &pdev->dev;
+ snandc->ecc_eng.integration = NAND_ECC_ENGINE_INTEGRATION_PIPELINED;
+ snandc->ecc_eng.ops = &qcom_snand_ecc_engine_ops_pipelined;
+ snandc->ecc_eng.priv = snandc;
+
+ ret = nand_ecc_register_on_host_hw_engine(&snandc->ecc_eng);
+ if (ret) {
+ dev_err(&pdev->dev, "failed to register ecc engine.\n");
+ goto err_init;
+ }
+
+ ctlr->num_chipselect = QPIC_QSPI_NUM_CS;
+ ctlr->mem_ops = &qcom_spi_mem_ops;
+ ctlr->mem_caps = &qcom_snand_mem_caps;
+ ctlr->dev.of_node = pdev->dev.of_node;
+ ctlr->mode_bits = SPI_TX_DUAL | SPI_RX_DUAL |
+ SPI_TX_QUAD | SPI_RX_QUAD;
+
+ ret = spi_register_controller(ctlr);
+ if (ret) {
+ dev_err(&pdev->dev, "spi_register_controller failed.\n");
+ goto err_init;
+ }
+
+ return 0;
+
+err_init:
+ qcom_nandc_unalloc(snandc);
+err_snandc_alloc:
+ clk_disable_unprepare(snandc->aon_clk);
+err_aon_clk:
+ clk_disable_unprepare(snandc->core_clk);
+err_core_clk:
+ dma_unmap_resource(dev, res->start, resource_size(res),
+ DMA_BIDIRECTIONAL, 0);
+ return ret;
+}
+
+static int qcom_snand_remove(struct platform_device *pdev)
+{
+ struct spi_controller *ctlr = platform_get_drvdata(pdev);
+ struct qcom_nand_controller *snandc = spi_controller_get_devdata(ctlr);
+ struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+
+ spi_unregister_controller(ctlr);
+
+ clk_disable_unprepare(snandc->aon_clk);
+ clk_disable_unprepare(snandc->core_clk);
+ clk_disable_unprepare(snandc->iomacro_clk);
+
+ dma_unmap_resource(&pdev->dev, snandc->base_dma, resource_size(res),
+ DMA_BIDIRECTIONAL, 0);
+ return 0;
+}
+
+static const struct qcom_nandc_props ipq9574_snandc_props = {
+ .dev_cmd_reg_start = 0x7000,
+ .is_bam = true,
+};
+
+static const struct of_device_id qcom_snandc_of_match[] = {
+ {
+ .compatible = "qcom,spi-qpic-snand",
+ .data = &ipq9574_snandc_props,
+ },
+ {}
+}
+MODULE_DEVICE_TABLE(of, qcom_snandc_of_match);
+
+static struct platform_driver qcom_snand_driver = {
+ .driver = {
+ .name = "qcom_snand",
+ .of_match_table = qcom_snandc_of_match,
+ },
+ .probe = qcom_snand_probe,
+ .remove = qcom_snand_remove,
+};
+module_platform_driver(qcom_snand_driver);
+
+MODULE_DESCRIPTION("SPI driver for QPIC QSPI cores");
+MODULE_AUTHOR("Md Sadre Alam <[email protected]>");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
index aced15866627..4673cd36ff0a 100644
--- a/include/linux/mtd/nand-qpic-common.h
+++ b/include/linux/mtd/nand-qpic-common.h
@@ -45,6 +45,9 @@
#define NAND_DEV_CMD1 0xa4
#define NAND_DEV_CMD2 0xa8
#define NAND_DEV_CMD_VLD 0xac
+#define NAND_FLASH_SPI_CFG 0xc0
+#define NAND_NUM_ADDR_CYCLES 0xc4
+#define NAND_BUSY_CHECK_WAIT_CNT 0xc8
#define SFLASHC_BURST_CFG 0xe0
#define NAND_ERASED_CW_DETECT_CFG 0xe8
#define NAND_ERASED_CW_DETECT_STATUS 0xec
@@ -61,6 +64,7 @@
#define NAND_READ_LOCATION_LAST_CW_1 0xf44
#define NAND_READ_LOCATION_LAST_CW_2 0xf48
#define NAND_READ_LOCATION_LAST_CW_3 0xf4c
+#define NAND_FLASH_FEATURES 0xf64

/* dummy register offsets, used by write_reg_dma */
#define NAND_DEV_CMD1_RESTORE 0xdead
@@ -169,6 +173,7 @@
#define OP_CHECK_STATUS 0xc
#define OP_FETCH_ID 0xb
#define OP_RESET_DEVICE 0xd
+#define ACC_FEATURE 0xe

/* Default Value for NAND_DEV_CMD_VLD */
#define NAND_DEV_CMD_VLD_VAL (READ_START_VLD | WRITE_START_VLD | \
@@ -329,11 +334,53 @@ struct nandc_regs {
__le32 read_location_last1;
__le32 read_location_last2;
__le32 read_location_last3;
+ __le32 spi_cfg;
+ __le32 num_addr_cycle;
+ __le32 busy_wait_cnt;
+ __le32 flash_feature;

__le32 erased_cw_detect_cfg_clr;
__le32 erased_cw_detect_cfg_set;
};

+struct qcom_ecc_stats {
+ u32 corrected;
+ u32 bitflips;
+ u32 failed;
+};
+
+/*
+ * QPIC ECC data struct
+ *
+ */
+struct qpic_ecc {
+ struct device *dev;
+ const struct qpic_ecc_caps *caps;
+ struct completion done;
+ u32 sectors;
+ u8 *eccdata;
+ bool use_ecc;
+ u32 ecc_modes;
+ int ecc_bytes_hw;
+ int spare_bytes;
+ int bbm_size;
+ int ecc_mode;
+ int bytes;
+ int steps;
+ int step_size;
+ int strength;
+ int cw_size;
+ int cw_data;
+ u32 cfg0, cfg1;
+ u32 cfg0_raw, cfg1_raw;
+ u32 ecc_buf_cfg;
+ u32 ecc_bch_cfg;
+ u32 clrflashstatus;
+ u32 clrreadstatus;
+ bool bch_enabled;
+};
+
+struct qpic_ecc;
/*
* NAND controller data struct
*
@@ -352,6 +399,7 @@ struct nandc_regs {
* initialized via DT match data
*
* @controller: base controller structure
+ * @ctlr: spi controller structure
* @host_list: list containing all the chips attached to the
* controller
*
@@ -389,6 +437,7 @@ struct qcom_nand_controller {

struct clk *core_clk;
struct clk *aon_clk;
+ struct clk *iomacro_clk;

struct nandc_regs *regs;
struct bam_transaction *bam_txn;
@@ -396,6 +445,7 @@ struct qcom_nand_controller {
const struct qcom_nandc_props *props;

struct nand_controller controller;
+ struct spi_controller *ctlr;
struct list_head host_list;

union {
@@ -432,6 +482,17 @@ struct qcom_nand_controller {

u32 cmd1, vld;
bool exec_opwrite;
+ struct qpic_ecc *ecc;
+ struct qcom_ecc_stats ecc_stats;
+ struct nand_ecc_engine ecc_eng;
+ u8 *wbuf;
+ u32 wlen;
+ u32 addr1;
+ u32 addr2;
+ u32 cmd;
+ u32 num_cw;
+ bool oob_read;
+ bool raw;
};

/*
--
2.34.1


2024-03-08 09:20:17

by Md Sadre Alam

[permalink] [raw]
Subject: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file

Add qpic_common.c file which hold all the common
qpic APIs which will be used by both qpic raw nand
driver and qpic spi nand driver.

Co-developed-by: Sricharan Ramabadhran <[email protected]>
Signed-off-by: Sricharan Ramabadhran <[email protected]>
Co-developed-by: Varadarajan Narayanan <[email protected]>
Signed-off-by: Varadarajan Narayanan <[email protected]>
Signed-off-by: Md Sadre Alam <[email protected]>
---
Change in [v4]

* Added kernel doc for all common api as per kernel doc
standard

* Added QPIC_COMMON config to build qpic_common.c

Change in [v3]

* Added original copy right

* Removed all EXPORT_SYMBOL()

* Made this common api file more generic

* Added qcom_ prefix to all api in this file

* Removed devm_kfree and added kfree

* Moved to_qcom_nand_controller() to raw nand driver
since it was only used by raw nand driver, so not needed
as common

* Added kernel doc for all api

* made reverse tree of variable declaration in
prep_adm_dma_desc() function

* Added if(!ret) condition in prep_adm_dma_desc()
function

* Initialized slave_conf as 0 while declaration

Change in [v2]

* Posted initial support for common api file

Change in [v1]

* Posted as RFC patch for design review

drivers/mtd/nand/Kconfig | 7 +
drivers/mtd/nand/Makefile | 1 +
drivers/mtd/nand/qpic_common.c | 826 +++++++++++++++
drivers/mtd/nand/raw/Kconfig | 1 +
drivers/mtd/nand/raw/qcom_nandc.c | 1440 +++-----------------------
include/linux/mtd/nand-qpic-common.h | 486 +++++++++
6 files changed, 1456 insertions(+), 1305 deletions(-)
create mode 100644 drivers/mtd/nand/qpic_common.c
create mode 100644 include/linux/mtd/nand-qpic-common.h

diff --git a/drivers/mtd/nand/Kconfig b/drivers/mtd/nand/Kconfig
index 5b0c2c95f10c..609072c5fd9e 100644
--- a/drivers/mtd/nand/Kconfig
+++ b/drivers/mtd/nand/Kconfig
@@ -61,6 +61,13 @@ config MTD_NAND_ECC_MEDIATEK
help
This enables support for the hardware ECC engine from Mediatek.

+config QPIC_COMMON
+ tristate "QPIC common api file"
+ depends on ARCH_QCOM || COMPILE_TEST
+ help
+ This enables support for common api for qpic nand controller.
+ common apis will be used by both raw nand driver and serial nand
+ driver.
endmenu

endmenu
diff --git a/drivers/mtd/nand/Makefile b/drivers/mtd/nand/Makefile
index 19e1291ac4d5..c0c1f8bd0220 100644
--- a/drivers/mtd/nand/Makefile
+++ b/drivers/mtd/nand/Makefile
@@ -3,6 +3,7 @@
nandcore-objs := core.o bbt.o
obj-$(CONFIG_MTD_NAND_CORE) += nandcore.o
obj-$(CONFIG_MTD_NAND_ECC_MEDIATEK) += ecc-mtk.o
+obj-$(CONFIG_QPIC_COMMON) += qpic_common.o

obj-y += onenand/
obj-y += raw/
diff --git a/drivers/mtd/nand/qpic_common.c b/drivers/mtd/nand/qpic_common.c
new file mode 100644
index 000000000000..5b7c0d119d9a
--- /dev/null
+++ b/drivers/mtd/nand/qpic_common.c
@@ -0,0 +1,826 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright (c) 2016, The Linux Foundation. All rights reserved.
+ */
+#include <linux/mtd/nand-qpic-common.h>
+
+
+/**
+ * qcom_free_bam_transaction() - Frees the BAM transaction memory
+ * @nandc: qpic nand controller
+ *
+ * This function frees the bam transaction memory
+ */
+void qcom_free_bam_transaction(struct qcom_nand_controller *nandc)
+{
+ struct bam_transaction *bam_txn = nandc->bam_txn;
+
+ kfree(bam_txn);
+}
+
+/**
+ * qcom_clear_read_regs() - reset the read register buffer
+ * @nandc: qpic nand controller
+ *
+ * This function reset the register read buffer for next NAND operation
+ */
+void qcom_clear_read_regs(struct qcom_nand_controller *nandc)
+{
+ nandc->reg_read_pos = 0;
+ qcom_nandc_read_buffer_sync(nandc, false);
+}
+
+/**
+ * qcom_qpic_bam_dma_done() - Callback for DMA descriptor completion
+ * @data: data pointer
+ *
+ * This function is a callback for DMA descriptor completion
+ */
+void qcom_qpic_bam_dma_done(void *data)
+{
+ struct bam_transaction *bam_txn = data;
+
+ /*
+ * In case of data transfer with NAND, 2 callbacks will be generated.
+ * One for command channel and another one for data channel.
+ * If current transaction has data descriptors
+ * (i.e. wait_second_completion is true), then set this to false
+ * and wait for second DMA descriptor completion.
+ */
+ if (bam_txn->wait_second_completion)
+ bam_txn->wait_second_completion = false;
+ else
+ complete(&bam_txn->txn_done);
+}
+
+/**
+ * qcom_nandc_read_buffer_sync() - Check for dma sync for cpu or device
+ * @nandc: qpic nand controller
+ * @is_cpu: cpu or Device
+ *
+ * This function will check for dma sync for cpu or device
+ */
+void qcom_nandc_read_buffer_sync(struct qcom_nand_controller *nandc,
+ bool is_cpu)
+{
+ if (!nandc->props->is_bam)
+ return;
+
+ if (is_cpu)
+ dma_sync_single_for_cpu(nandc->dev, nandc->reg_read_dma,
+ MAX_REG_RD *
+ sizeof(*nandc->reg_read_buf),
+ DMA_FROM_DEVICE);
+ else
+ dma_sync_single_for_device(nandc->dev, nandc->reg_read_dma,
+ MAX_REG_RD *
+ sizeof(*nandc->reg_read_buf),
+ DMA_FROM_DEVICE);
+}
+
+/**
+ * qcom_offset_to_nandc_reg() - Get the actual offset
+ * @regs: pointer to nandc_reg structure
+ * @offset: register offset
+ *
+ * This function will reurn the actual offset for qpic controller register
+ */
+__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
+{
+ switch (offset) {
+ case NAND_FLASH_CMD:
+ return &regs->cmd;
+ case NAND_ADDR0:
+ return &regs->addr0;
+ case NAND_ADDR1:
+ return &regs->addr1;
+ case NAND_FLASH_CHIP_SELECT:
+ return &regs->chip_sel;
+ case NAND_EXEC_CMD:
+ return &regs->exec;
+ case NAND_FLASH_STATUS:
+ return &regs->clrflashstatus;
+ case NAND_DEV0_CFG0:
+ return &regs->cfg0;
+ case NAND_DEV0_CFG1:
+ return &regs->cfg1;
+ case NAND_DEV0_ECC_CFG:
+ return &regs->ecc_bch_cfg;
+ case NAND_READ_STATUS:
+ return &regs->clrreadstatus;
+ case NAND_DEV_CMD1:
+ return &regs->cmd1;
+ case NAND_DEV_CMD1_RESTORE:
+ return &regs->orig_cmd1;
+ case NAND_DEV_CMD_VLD:
+ return &regs->vld;
+ case NAND_DEV_CMD_VLD_RESTORE:
+ return &regs->orig_vld;
+ case NAND_EBI2_ECC_BUF_CFG:
+ return &regs->ecc_buf_cfg;
+ case NAND_READ_LOCATION_0:
+ return &regs->read_location0;
+ case NAND_READ_LOCATION_1:
+ return &regs->read_location1;
+ case NAND_READ_LOCATION_2:
+ return &regs->read_location2;
+ case NAND_READ_LOCATION_3:
+ return &regs->read_location3;
+ case NAND_READ_LOCATION_LAST_CW_0:
+ return &regs->read_location_last0;
+ case NAND_READ_LOCATION_LAST_CW_1:
+ return &regs->read_location_last1;
+ case NAND_READ_LOCATION_LAST_CW_2:
+ return &regs->read_location_last2;
+ case NAND_READ_LOCATION_LAST_CW_3:
+ return &regs->read_location_last3;
+ default:
+ return NULL;
+ }
+}
+
+/**
+ * qcom_prep_adm_dma_desc() - Prepare descriptor for adma
+ * @nandc: qpic nand controller
+ * @read: read or write type
+ * @reg_off: offset within the controller's data buffer
+ * @vaddr: virtual address of the buffer we want to write to
+ * @size: adm dma transaction size in bytes
+ * @flow_control: flow controller
+ *
+ * This function will prepare descriptor for adma
+ */
+int qcom_prep_adm_dma_desc(struct qcom_nand_controller *nandc, bool read,
+ int reg_off, const void *vaddr, int size,
+ bool flow_control)
+{
+ struct qcom_adm_peripheral_config periph_conf = {};
+ struct dma_async_tx_descriptor *dma_desc;
+ struct dma_slave_config slave_conf = {0};
+ enum dma_transfer_direction dir_eng;
+ struct scatterlist *sgl;
+ struct desc_info *desc;
+ int ret;
+
+ desc = kzalloc(sizeof(*desc), GFP_KERNEL);
+ if (!desc)
+ return -ENOMEM;
+
+ sgl = &desc->adm_sgl;
+
+ sg_init_one(sgl, vaddr, size);
+
+ if (read) {
+ dir_eng = DMA_DEV_TO_MEM;
+ desc->dir = DMA_FROM_DEVICE;
+ } else {
+ dir_eng = DMA_MEM_TO_DEV;
+ desc->dir = DMA_TO_DEVICE;
+ }
+
+ ret = dma_map_sg(nandc->dev, sgl, 1, desc->dir);
+ if (!ret) {
+ ret = -ENOMEM;
+ goto err;
+ }
+
+ slave_conf.device_fc = flow_control;
+ if (read) {
+ slave_conf.src_maxburst = 16;
+ slave_conf.src_addr = nandc->base_dma + reg_off;
+ if (nandc->data_crci) {
+ periph_conf.crci = nandc->data_crci;
+ slave_conf.peripheral_config = &periph_conf;
+ slave_conf.peripheral_size = sizeof(periph_conf);
+ }
+ } else {
+ slave_conf.dst_maxburst = 16;
+ slave_conf.dst_addr = nandc->base_dma + reg_off;
+ if (nandc->cmd_crci) {
+ periph_conf.crci = nandc->cmd_crci;
+ slave_conf.peripheral_config = &periph_conf;
+ slave_conf.peripheral_size = sizeof(periph_conf);
+ }
+ }
+
+ ret = dmaengine_slave_config(nandc->chan, &slave_conf);
+ if (ret) {
+ dev_err(nandc->dev, "failed to configure dma channel\n");
+ goto err;
+ }
+
+ dma_desc = dmaengine_prep_slave_sg(nandc->chan, sgl, 1, dir_eng, 0);
+ if (!dma_desc) {
+ dev_err(nandc->dev, "failed to prepare desc\n");
+ ret = -EINVAL;
+ goto err;
+ }
+
+ desc->dma_desc = dma_desc;
+
+ list_add_tail(&desc->node, &nandc->desc_list);
+
+ return 0;
+err:
+ kfree(desc);
+
+ return ret;
+}
+
+/**
+ * qcom_submit_descs() - submit dma descriptor
+ * @nandc: qpic nand controller
+ *
+ * This function will submit all the prepared dma descriptor
+ * cmd or data descriptor
+ */
+int qcom_submit_descs(struct qcom_nand_controller *nandc)
+{
+ struct desc_info *desc, *n;
+ dma_cookie_t cookie = 0;
+ struct bam_transaction *bam_txn = nandc->bam_txn;
+ int ret = 0;
+
+ if (nandc->props->is_bam) {
+ if (bam_txn->rx_sgl_pos > bam_txn->rx_sgl_start) {
+ ret = qcom_prepare_bam_async_desc(nandc, nandc->rx_chan, 0);
+ if (ret)
+ goto err_unmap_free_desc;
+ }
+
+ if (bam_txn->tx_sgl_pos > bam_txn->tx_sgl_start) {
+ ret = qcom_prepare_bam_async_desc(nandc, nandc->tx_chan,
+ DMA_PREP_INTERRUPT);
+ if (ret)
+ goto err_unmap_free_desc;
+ }
+
+ if (bam_txn->cmd_sgl_pos > bam_txn->cmd_sgl_start) {
+ ret = qcom_prepare_bam_async_desc(nandc, nandc->cmd_chan,
+ DMA_PREP_CMD);
+ if (ret)
+ goto err_unmap_free_desc;
+ }
+ }
+
+ list_for_each_entry(desc, &nandc->desc_list, node)
+ cookie = dmaengine_submit(desc->dma_desc);
+
+ if (nandc->props->is_bam) {
+ bam_txn->last_cmd_desc->callback = qcom_qpic_bam_dma_done;
+ bam_txn->last_cmd_desc->callback_param = bam_txn;
+ if (bam_txn->last_data_desc) {
+ bam_txn->last_data_desc->callback = qcom_qpic_bam_dma_done;
+ bam_txn->last_data_desc->callback_param = bam_txn;
+ bam_txn->wait_second_completion = true;
+ }
+
+ dma_async_issue_pending(nandc->tx_chan);
+ dma_async_issue_pending(nandc->rx_chan);
+ dma_async_issue_pending(nandc->cmd_chan);
+
+ if (!wait_for_completion_timeout(&bam_txn->txn_done,
+ QPIC_NAND_COMPLETION_TIMEOUT))
+ ret = -ETIMEDOUT;
+ } else {
+ if (dma_sync_wait(nandc->chan, cookie) != DMA_COMPLETE)
+ ret = -ETIMEDOUT;
+ }
+
+err_unmap_free_desc:
+ /*
+ * Unmap the dma sg_list and free the desc allocated by both
+ * prepare_bam_async_desc() and prep_adm_dma_desc() functions.
+ */
+ list_for_each_entry_safe(desc, n, &nandc->desc_list, node) {
+ list_del(&desc->node);
+
+ if (nandc->props->is_bam)
+ dma_unmap_sg(nandc->dev, desc->bam_sgl,
+ desc->sgl_cnt, desc->dir);
+ else
+ dma_unmap_sg(nandc->dev, &desc->adm_sgl, 1,
+ desc->dir);
+
+ kfree(desc);
+ }
+
+ return ret;
+}
+
+/**
+ * qcom_prepare_bam_async_desc() - Prepare DMA descriptor
+ * @nandc: qpic nand controller
+ * @chan: dma channel
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function maps the scatter gather list for DMA transfer and forms the
+ * DMA descriptor for BAM.This descriptor will be added in the NAND DMA
+ * descriptor queue which will be submitted to DMA engine.
+ */
+int qcom_prepare_bam_async_desc(struct qcom_nand_controller *nandc,
+ struct dma_chan *chan,
+ unsigned long flags)
+{
+ struct desc_info *desc;
+ struct scatterlist *sgl;
+ unsigned int sgl_cnt;
+ int ret;
+ struct bam_transaction *bam_txn = nandc->bam_txn;
+ enum dma_transfer_direction dir_eng;
+ struct dma_async_tx_descriptor *dma_desc;
+
+ desc = kzalloc(sizeof(*desc), GFP_KERNEL);
+ if (!desc)
+ return -ENOMEM;
+
+ if (chan == nandc->cmd_chan) {
+ sgl = &bam_txn->cmd_sgl[bam_txn->cmd_sgl_start];
+ sgl_cnt = bam_txn->cmd_sgl_pos - bam_txn->cmd_sgl_start;
+ bam_txn->cmd_sgl_start = bam_txn->cmd_sgl_pos;
+ dir_eng = DMA_MEM_TO_DEV;
+ desc->dir = DMA_TO_DEVICE;
+ } else if (chan == nandc->tx_chan) {
+ sgl = &bam_txn->data_sgl[bam_txn->tx_sgl_start];
+ sgl_cnt = bam_txn->tx_sgl_pos - bam_txn->tx_sgl_start;
+ bam_txn->tx_sgl_start = bam_txn->tx_sgl_pos;
+ dir_eng = DMA_MEM_TO_DEV;
+ desc->dir = DMA_TO_DEVICE;
+ } else {
+ sgl = &bam_txn->data_sgl[bam_txn->rx_sgl_start];
+ sgl_cnt = bam_txn->rx_sgl_pos - bam_txn->rx_sgl_start;
+ bam_txn->rx_sgl_start = bam_txn->rx_sgl_pos;
+ dir_eng = DMA_DEV_TO_MEM;
+ desc->dir = DMA_FROM_DEVICE;
+ }
+
+ sg_mark_end(sgl + sgl_cnt - 1);
+ ret = dma_map_sg(nandc->dev, sgl, sgl_cnt, desc->dir);
+ if (ret == 0) {
+ dev_err(nandc->dev, "failure in mapping desc\n");
+ kfree(desc);
+ return -ENOMEM;
+ }
+
+ desc->sgl_cnt = sgl_cnt;
+ desc->bam_sgl = sgl;
+
+ dma_desc = dmaengine_prep_slave_sg(chan, sgl, sgl_cnt, dir_eng,
+ flags);
+
+ if (!dma_desc) {
+ dev_err(nandc->dev, "failure in prep desc\n");
+ dma_unmap_sg(nandc->dev, sgl, sgl_cnt, desc->dir);
+ kfree(desc);
+ return -EINVAL;
+ }
+
+ desc->dma_desc = dma_desc;
+
+ /* update last data/command descriptor */
+ if (chan == nandc->cmd_chan)
+ bam_txn->last_cmd_desc = dma_desc;
+ else
+ bam_txn->last_data_desc = dma_desc;
+
+ list_add_tail(&desc->node, &nandc->desc_list);
+
+ return 0;
+}
+
+/**
+ * qcom_prep_bam_dma_desc_cmd() - Prepares the command descriptor for BAM DMA
+ * @nandc: qpic nand controller
+ * @read: read or write type
+ * @reg_off: offset within the controller's data buffer
+ * @vaddr: virtual address of the buffer we want to write to
+ * @size: DMA transaction size in bytes
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function will prepares the command descriptor for BAM DMA
+ * which will be used for NAND register reads and writes.
+ */
+int qcom_prep_bam_dma_desc_cmd(struct qcom_nand_controller *nandc, bool read,
+ int reg_off, const void *vaddr,
+ int size, unsigned int flags)
+{
+ int bam_ce_size;
+ int i, ret;
+ struct bam_cmd_element *bam_ce_buffer;
+ struct bam_transaction *bam_txn = nandc->bam_txn;
+
+ bam_ce_buffer = &bam_txn->bam_ce[bam_txn->bam_ce_pos];
+
+ /* fill the command desc */
+ for (i = 0; i < size; i++) {
+ if (read)
+ bam_prep_ce(&bam_ce_buffer[i],
+ nandc_reg_phys(nandc, reg_off + 4 * i),
+ BAM_READ_COMMAND,
+ reg_buf_dma_addr(nandc,
+ (__le32 *)vaddr + i));
+ else
+ bam_prep_ce_le32(&bam_ce_buffer[i],
+ nandc_reg_phys(nandc, reg_off + 4 * i),
+ BAM_WRITE_COMMAND,
+ *((__le32 *)vaddr + i));
+ }
+
+ bam_txn->bam_ce_pos += size;
+
+ /* use the separate sgl after this command */
+ if (flags & NAND_BAM_NEXT_SGL) {
+ bam_ce_buffer = &bam_txn->bam_ce[bam_txn->bam_ce_start];
+ bam_ce_size = (bam_txn->bam_ce_pos -
+ bam_txn->bam_ce_start) *
+ sizeof(struct bam_cmd_element);
+ sg_set_buf(&bam_txn->cmd_sgl[bam_txn->cmd_sgl_pos],
+ bam_ce_buffer, bam_ce_size);
+ bam_txn->cmd_sgl_pos++;
+ bam_txn->bam_ce_start = bam_txn->bam_ce_pos;
+
+ if (flags & NAND_BAM_NWD) {
+ ret = qcom_prepare_bam_async_desc(nandc, nandc->cmd_chan,
+ DMA_PREP_FENCE |
+ DMA_PREP_CMD);
+ if (ret)
+ return ret;
+ }
+ }
+
+ return 0;
+}
+
+/**
+ * qcom_prep_bam_dma_desc_data() - Prepares the data descriptor for BAM DMA
+ * @nandc: qpic nand controller
+ * @read: read or write type
+ * @vaddr: virtual address of the buffer we want to write to
+ * @size: DMA transaction size in bytes
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function will prepares the data descriptor for BAM DMA which
+ * will be used for NAND data reads and writes.
+ */
+int qcom_prep_bam_dma_desc_data(struct qcom_nand_controller *nandc, bool read,
+ const void *vaddr,
+ int size, unsigned int flags)
+{
+ int ret;
+ struct bam_transaction *bam_txn = nandc->bam_txn;
+
+ if (read) {
+ sg_set_buf(&bam_txn->data_sgl[bam_txn->rx_sgl_pos],
+ vaddr, size);
+ bam_txn->rx_sgl_pos++;
+ } else {
+ sg_set_buf(&bam_txn->data_sgl[bam_txn->tx_sgl_pos],
+ vaddr, size);
+ bam_txn->tx_sgl_pos++;
+
+ /*
+ * BAM will only set EOT for DMA_PREP_INTERRUPT so if this flag
+ * is not set, form the DMA descriptor
+ */
+ if (!(flags & NAND_BAM_NO_EOT)) {
+ ret = qcom_prepare_bam_async_desc(nandc, nandc->tx_chan,
+ DMA_PREP_INTERRUPT);
+ if (ret)
+ return ret;
+ }
+ }
+
+ return 0;
+}
+
+/**
+ * qcom_read_reg_dma() - read a given number of registers to the reg_read_buf pointer
+ * @nandc: qpic nand controller
+ * @first: offset of the first register in the contiguous block
+ * @num_regs: number of registers to read
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function will prepares a descriptor to read a given number of
+ * contiguous registers to the reg_read_buf pointer.
+ */
+int qcom_read_reg_dma(struct qcom_nand_controller *nandc, int first,
+ int num_regs, unsigned int flags)
+{
+ bool flow_control = false;
+ void *vaddr;
+
+ vaddr = nandc->reg_read_buf + nandc->reg_read_pos;
+ nandc->reg_read_pos += num_regs;
+
+ if (first == NAND_DEV_CMD_VLD || first == NAND_DEV_CMD1)
+ first = dev_cmd_reg_addr(nandc, first);
+
+ if (nandc->props->is_bam)
+ return qcom_prep_bam_dma_desc_cmd(nandc, true, first, vaddr,
+ num_regs, flags);
+
+ if (first == NAND_READ_ID || first == NAND_FLASH_STATUS)
+ flow_control = true;
+
+ return qcom_prep_adm_dma_desc(nandc, true, first, vaddr,
+ num_regs * sizeof(u32), flow_control);
+}
+
+/**
+ * qcom_write_reg_dma() - write a given number of registers
+ * @nandc: qpic nand controller
+ * @first: offset of the first register in the contiguous block
+ * @num_regs: number of registers to write
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function will prepares a descriptor to write a given number of
+ * contiguous registers
+ */
+int qcom_write_reg_dma(struct qcom_nand_controller *nandc, int first,
+ int num_regs, unsigned int flags)
+{
+ bool flow_control = false;
+ struct nandc_regs *regs = nandc->regs;
+ void *vaddr;
+
+ vaddr = qcom_offset_to_nandc_reg(regs, first);
+
+ if (first == NAND_ERASED_CW_DETECT_CFG) {
+ if (flags & NAND_ERASED_CW_SET)
+ vaddr = &regs->erased_cw_detect_cfg_set;
+ else
+ vaddr = &regs->erased_cw_detect_cfg_clr;
+ }
+
+ if (first == NAND_EXEC_CMD)
+ flags |= NAND_BAM_NWD;
+
+ if (first == NAND_DEV_CMD1_RESTORE || first == NAND_DEV_CMD1)
+ first = dev_cmd_reg_addr(nandc, NAND_DEV_CMD1);
+
+ if (first == NAND_DEV_CMD_VLD_RESTORE || first == NAND_DEV_CMD_VLD)
+ first = dev_cmd_reg_addr(nandc, NAND_DEV_CMD_VLD);
+
+ if (nandc->props->is_bam)
+ return qcom_prep_bam_dma_desc_cmd(nandc, false, first, vaddr,
+ num_regs, flags);
+
+ if (first == NAND_FLASH_CMD)
+ flow_control = true;
+
+ return qcom_prep_adm_dma_desc(nandc, false, first, vaddr,
+ num_regs * sizeof(u32), flow_control);
+}
+
+/**
+ * qcom_read_data_dma() - transfer data
+ * @nandc: qpic nand controller
+ * @reg_off: offset within the controller's data buffer
+ * @vaddr: virtual address of the buffer we want to write to
+ * @size: DMA transaction size in bytes
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function will prepares a DMA descriptor to transfer data from the
+ * controller's internal buffer to the buffer 'vaddr'
+ */
+int qcom_read_data_dma(struct qcom_nand_controller *nandc, int reg_off,
+ const u8 *vaddr, int size, unsigned int flags)
+{
+ if (nandc->props->is_bam)
+ return qcom_prep_bam_dma_desc_data(nandc, true, vaddr, size, flags);
+
+ return qcom_prep_adm_dma_desc(nandc, true, reg_off, vaddr, size, false);
+}
+
+/**
+ * qcom_write_data_dma() - transfer data
+ * @nandc: qpic nand controller
+ * @reg_off: offset within the controller's data buffer
+ * @vaddr: virtual address of the buffer we want to read from
+ * @size: DMA transaction size in bytes
+ * @flags: flags to control DMA descriptor preparation
+ *
+ * This function will prepares a DMA descriptor to transfer data from
+ * 'vaddr' to the controller's internal buffer
+ */
+int qcom_write_data_dma(struct qcom_nand_controller *nandc, int reg_off,
+ const u8 *vaddr, int size, unsigned int flags)
+{
+ if (nandc->props->is_bam)
+ return qcom_prep_bam_dma_desc_data(nandc, false, vaddr, size, flags);
+
+ return qcom_prep_adm_dma_desc(nandc, false, reg_off, vaddr, size, false);
+}
+
+/**
+ * qcom_alloc_bam_transaction() - allocate BAM transaction
+ * @nandc: qpic nand controller
+ *
+ * This function will allocate and initialize the BAM transaction structure
+ */
+struct bam_transaction *
+qcom_alloc_bam_transaction(struct qcom_nand_controller *nandc)
+{
+ struct bam_transaction *bam_txn;
+ size_t bam_txn_size;
+ unsigned int num_cw = nandc->max_cwperpage;
+ void *bam_txn_buf;
+
+ bam_txn_size =
+ sizeof(*bam_txn) + num_cw *
+ ((sizeof(*bam_txn->bam_ce) * QPIC_PER_CW_CMD_ELEMENTS) +
+ (sizeof(*bam_txn->cmd_sgl) * QPIC_PER_CW_CMD_SGL) +
+ (sizeof(*bam_txn->data_sgl) * QPIC_PER_CW_DATA_SGL));
+
+ bam_txn_buf = kzalloc(bam_txn_size, GFP_KERNEL);
+ if (!bam_txn_buf)
+ return NULL;
+
+ bam_txn = bam_txn_buf;
+ bam_txn_buf += sizeof(*bam_txn);
+
+ bam_txn->bam_ce = bam_txn_buf;
+ bam_txn_buf +=
+ sizeof(*bam_txn->bam_ce) * QPIC_PER_CW_CMD_ELEMENTS * num_cw;
+
+ bam_txn->cmd_sgl = bam_txn_buf;
+ bam_txn_buf +=
+ sizeof(*bam_txn->cmd_sgl) * QPIC_PER_CW_CMD_SGL * num_cw;
+
+ bam_txn->data_sgl = bam_txn_buf;
+
+ init_completion(&bam_txn->txn_done);
+
+ return bam_txn;
+}
+
+/**
+ * qcom_clear_bam_transaction() - Clears the BAM transaction
+ * @nandc: qpic nand controller
+ *
+ * This function will clear the BAM transaction indexes.
+ */
+void qcom_clear_bam_transaction(struct qcom_nand_controller *nandc)
+{
+ struct bam_transaction *bam_txn = nandc->bam_txn;
+
+ if (!nandc->props->is_bam)
+ return;
+
+ bam_txn->bam_ce_pos = 0;
+ bam_txn->bam_ce_start = 0;
+ bam_txn->cmd_sgl_pos = 0;
+ bam_txn->cmd_sgl_start = 0;
+ bam_txn->tx_sgl_pos = 0;
+ bam_txn->tx_sgl_start = 0;
+ bam_txn->rx_sgl_pos = 0;
+ bam_txn->rx_sgl_start = 0;
+ bam_txn->last_data_desc = NULL;
+ bam_txn->wait_second_completion = false;
+
+ sg_init_table(bam_txn->cmd_sgl, nandc->max_cwperpage *
+ QPIC_PER_CW_CMD_SGL);
+ sg_init_table(bam_txn->data_sgl, nandc->max_cwperpage *
+ QPIC_PER_CW_DATA_SGL);
+
+ reinit_completion(&bam_txn->txn_done);
+}
+
+/**
+ * qcom_nandc_unalloc() - unallocate qpic nand controller
+ * @nandc: qpic nand controller
+ *
+ * This function will unallocate memory alloacted for qpic nand controller
+ */
+void qcom_nandc_unalloc(struct qcom_nand_controller *nandc)
+{
+ if (nandc->props->is_bam) {
+ if (!dma_mapping_error(nandc->dev, nandc->reg_read_dma))
+ dma_unmap_single(nandc->dev, nandc->reg_read_dma,
+ MAX_REG_RD *
+ sizeof(*nandc->reg_read_buf),
+ DMA_FROM_DEVICE);
+
+ if (nandc->tx_chan)
+ dma_release_channel(nandc->tx_chan);
+
+ if (nandc->rx_chan)
+ dma_release_channel(nandc->rx_chan);
+
+ if (nandc->cmd_chan)
+ dma_release_channel(nandc->cmd_chan);
+ } else {
+ if (nandc->chan)
+ dma_release_channel(nandc->chan);
+ }
+}
+
+/**
+ * qcom_nandc_alloc() - Allocate qpic nand controller
+ * @nandc: qpic nand controller
+ *
+ * This function will allocate memory for qpic nand controller
+ */
+int qcom_nandc_alloc(struct qcom_nand_controller *nandc)
+{
+ int ret;
+
+ ret = dma_set_coherent_mask(nandc->dev, DMA_BIT_MASK(32));
+ if (ret) {
+ dev_err(nandc->dev, "failed to set DMA mask\n");
+ return ret;
+ }
+
+ /*
+ * we use the internal buffer for reading ONFI params, reading small
+ * data like ID and status, and preforming read-copy-write operations
+ * when writing to a codeword partially. 532 is the maximum possible
+ * size of a codeword for our nand controller
+ */
+ nandc->buf_size = 532;
+
+ nandc->data_buffer = devm_kzalloc(nandc->dev, nandc->buf_size, GFP_KERNEL);
+ if (!nandc->data_buffer)
+ return -ENOMEM;
+
+ nandc->regs = devm_kzalloc(nandc->dev, sizeof(*nandc->regs), GFP_KERNEL);
+ if (!nandc->regs)
+ return -ENOMEM;
+
+ nandc->reg_read_buf = devm_kcalloc(nandc->dev, MAX_REG_RD,
+ sizeof(*nandc->reg_read_buf),
+ GFP_KERNEL);
+ if (!nandc->reg_read_buf)
+ return -ENOMEM;
+
+ if (nandc->props->is_bam) {
+ nandc->reg_read_dma =
+ dma_map_single(nandc->dev, nandc->reg_read_buf,
+ MAX_REG_RD *
+ sizeof(*nandc->reg_read_buf),
+ DMA_FROM_DEVICE);
+ if (dma_mapping_error(nandc->dev, nandc->reg_read_dma)) {
+ dev_err(nandc->dev, "failed to DMA MAP reg buffer\n");
+ return -EIO;
+ }
+
+ nandc->tx_chan = dma_request_chan(nandc->dev, "tx");
+ if (IS_ERR(nandc->tx_chan)) {
+ ret = PTR_ERR(nandc->tx_chan);
+ nandc->tx_chan = NULL;
+ dev_err_probe(nandc->dev, ret,
+ "tx DMA channel request failed\n");
+ goto unalloc;
+ }
+
+ nandc->rx_chan = dma_request_chan(nandc->dev, "rx");
+ if (IS_ERR(nandc->rx_chan)) {
+ ret = PTR_ERR(nandc->rx_chan);
+ nandc->rx_chan = NULL;
+ dev_err_probe(nandc->dev, ret,
+ "rx DMA channel request failed\n");
+ goto unalloc;
+ }
+
+ nandc->cmd_chan = dma_request_chan(nandc->dev, "cmd");
+ if (IS_ERR(nandc->cmd_chan)) {
+ ret = PTR_ERR(nandc->cmd_chan);
+ nandc->cmd_chan = NULL;
+ dev_err_probe(nandc->dev, ret,
+ "cmd DMA channel request failed\n");
+ goto unalloc;
+ }
+
+ /*
+ * Initially allocate BAM transaction to read ONFI param page.
+ * After detecting all the devices, this BAM transaction will
+ * be freed and the next BAM transaction will be allocated with
+ * maximum codeword size
+ */
+ nandc->max_cwperpage = 1;
+ nandc->bam_txn = qcom_alloc_bam_transaction(nandc);
+ if (!nandc->bam_txn) {
+ dev_err(nandc->dev,
+ "failed to allocate bam transaction\n");
+ ret = -ENOMEM;
+ goto unalloc;
+ }
+ } else {
+ nandc->chan = dma_request_chan(nandc->dev, "rxtx");
+ if (IS_ERR(nandc->chan)) {
+ ret = PTR_ERR(nandc->chan);
+ nandc->chan = NULL;
+ dev_err_probe(nandc->dev, ret,
+ "rxtx DMA channel request failed\n");
+ return ret;
+ }
+ }
+
+ INIT_LIST_HEAD(&nandc->desc_list);
+ INIT_LIST_HEAD(&nandc->host_list);
+
+ return 0;
+unalloc:
+ qcom_nandc_unalloc(nandc);
+ return ret;
+}
diff --git a/drivers/mtd/nand/raw/Kconfig b/drivers/mtd/nand/raw/Kconfig
index cbf8ae85e1ae..3aa000f877a4 100644
--- a/drivers/mtd/nand/raw/Kconfig
+++ b/drivers/mtd/nand/raw/Kconfig
@@ -334,6 +334,7 @@ config MTD_NAND_QCOM
tristate "QCOM NAND controller"
depends on ARCH_QCOM || COMPILE_TEST
depends on HAS_IOMEM
+ select QPIC_COMMON
help
Enables support for NAND flash chips on SoCs containing the EBI2 NAND
controller. This controller is found on IPQ806x SoC.
diff --git a/drivers/mtd/nand/raw/qcom_nandc.c b/drivers/mtd/nand/raw/qcom_nandc.c
index b079605c84d3..d4faabc8244f 100644
--- a/drivers/mtd/nand/raw/qcom_nandc.c
+++ b/drivers/mtd/nand/raw/qcom_nandc.c
@@ -2,186 +2,7 @@
/*
* Copyright (c) 2016, The Linux Foundation. All rights reserved.
*/
-#include <linux/bitops.h>
-#include <linux/clk.h>
-#include <linux/delay.h>
-#include <linux/dmaengine.h>
-#include <linux/dma-mapping.h>
-#include <linux/dma/qcom_adm.h>
-#include <linux/dma/qcom_bam_dma.h>
-#include <linux/module.h>
-#include <linux/mtd/partitions.h>
-#include <linux/mtd/rawnand.h>
-#include <linux/of.h>
-#include <linux/platform_device.h>
-#include <linux/slab.h>
-
-/* NANDc reg offsets */
-#define NAND_FLASH_CMD 0x00
-#define NAND_ADDR0 0x04
-#define NAND_ADDR1 0x08
-#define NAND_FLASH_CHIP_SELECT 0x0c
-#define NAND_EXEC_CMD 0x10
-#define NAND_FLASH_STATUS 0x14
-#define NAND_BUFFER_STATUS 0x18
-#define NAND_DEV0_CFG0 0x20
-#define NAND_DEV0_CFG1 0x24
-#define NAND_DEV0_ECC_CFG 0x28
-#define NAND_AUTO_STATUS_EN 0x2c
-#define NAND_DEV1_CFG0 0x30
-#define NAND_DEV1_CFG1 0x34
-#define NAND_READ_ID 0x40
-#define NAND_READ_STATUS 0x44
-#define NAND_DEV_CMD0 0xa0
-#define NAND_DEV_CMD1 0xa4
-#define NAND_DEV_CMD2 0xa8
-#define NAND_DEV_CMD_VLD 0xac
-#define SFLASHC_BURST_CFG 0xe0
-#define NAND_ERASED_CW_DETECT_CFG 0xe8
-#define NAND_ERASED_CW_DETECT_STATUS 0xec
-#define NAND_EBI2_ECC_BUF_CFG 0xf0
-#define FLASH_BUF_ACC 0x100
-
-#define NAND_CTRL 0xf00
-#define NAND_VERSION 0xf08
-#define NAND_READ_LOCATION_0 0xf20
-#define NAND_READ_LOCATION_1 0xf24
-#define NAND_READ_LOCATION_2 0xf28
-#define NAND_READ_LOCATION_3 0xf2c
-#define NAND_READ_LOCATION_LAST_CW_0 0xf40
-#define NAND_READ_LOCATION_LAST_CW_1 0xf44
-#define NAND_READ_LOCATION_LAST_CW_2 0xf48
-#define NAND_READ_LOCATION_LAST_CW_3 0xf4c
-
-/* dummy register offsets, used by write_reg_dma */
-#define NAND_DEV_CMD1_RESTORE 0xdead
-#define NAND_DEV_CMD_VLD_RESTORE 0xbeef
-
-/* NAND_FLASH_CMD bits */
-#define PAGE_ACC BIT(4)
-#define LAST_PAGE BIT(5)
-
-/* NAND_FLASH_CHIP_SELECT bits */
-#define NAND_DEV_SEL 0
-#define DM_EN BIT(2)
-
-/* NAND_FLASH_STATUS bits */
-#define FS_OP_ERR BIT(4)
-#define FS_READY_BSY_N BIT(5)
-#define FS_MPU_ERR BIT(8)
-#define FS_DEVICE_STS_ERR BIT(16)
-#define FS_DEVICE_WP BIT(23)
-
-/* NAND_BUFFER_STATUS bits */
-#define BS_UNCORRECTABLE_BIT BIT(8)
-#define BS_CORRECTABLE_ERR_MSK 0x1f
-
-/* NAND_DEVn_CFG0 bits */
-#define DISABLE_STATUS_AFTER_WRITE 4
-#define CW_PER_PAGE 6
-#define UD_SIZE_BYTES 9
-#define UD_SIZE_BYTES_MASK GENMASK(18, 9)
-#define ECC_PARITY_SIZE_BYTES_RS 19
-#define SPARE_SIZE_BYTES 23
-#define SPARE_SIZE_BYTES_MASK GENMASK(26, 23)
-#define NUM_ADDR_CYCLES 27
-#define STATUS_BFR_READ 30
-#define SET_RD_MODE_AFTER_STATUS 31
-
-/* NAND_DEVn_CFG0 bits */
-#define DEV0_CFG1_ECC_DISABLE 0
-#define WIDE_FLASH 1
-#define NAND_RECOVERY_CYCLES 2
-#define CS_ACTIVE_BSY 5
-#define BAD_BLOCK_BYTE_NUM 6
-#define BAD_BLOCK_IN_SPARE_AREA 16
-#define WR_RD_BSY_GAP 17
-#define ENABLE_BCH_ECC 27
-
-/* NAND_DEV0_ECC_CFG bits */
-#define ECC_CFG_ECC_DISABLE 0
-#define ECC_SW_RESET 1
-#define ECC_MODE 4
-#define ECC_PARITY_SIZE_BYTES_BCH 8
-#define ECC_NUM_DATA_BYTES 16
-#define ECC_NUM_DATA_BYTES_MASK GENMASK(25, 16)
-#define ECC_FORCE_CLK_OPEN 30
-
-/* NAND_DEV_CMD1 bits */
-#define READ_ADDR 0
-
-/* NAND_DEV_CMD_VLD bits */
-#define READ_START_VLD BIT(0)
-#define READ_STOP_VLD BIT(1)
-#define WRITE_START_VLD BIT(2)
-#define ERASE_START_VLD BIT(3)
-#define SEQ_READ_START_VLD BIT(4)
-
-/* NAND_EBI2_ECC_BUF_CFG bits */
-#define NUM_STEPS 0
-
-/* NAND_ERASED_CW_DETECT_CFG bits */
-#define ERASED_CW_ECC_MASK 1
-#define AUTO_DETECT_RES 0
-#define MASK_ECC BIT(ERASED_CW_ECC_MASK)
-#define RESET_ERASED_DET BIT(AUTO_DETECT_RES)
-#define ACTIVE_ERASED_DET (0 << AUTO_DETECT_RES)
-#define CLR_ERASED_PAGE_DET (RESET_ERASED_DET | MASK_ECC)
-#define SET_ERASED_PAGE_DET (ACTIVE_ERASED_DET | MASK_ECC)
-
-/* NAND_ERASED_CW_DETECT_STATUS bits */
-#define PAGE_ALL_ERASED BIT(7)
-#define CODEWORD_ALL_ERASED BIT(6)
-#define PAGE_ERASED BIT(5)
-#define CODEWORD_ERASED BIT(4)
-#define ERASED_PAGE (PAGE_ALL_ERASED | PAGE_ERASED)
-#define ERASED_CW (CODEWORD_ALL_ERASED | CODEWORD_ERASED)
-
-/* NAND_READ_LOCATION_n bits */
-#define READ_LOCATION_OFFSET 0
-#define READ_LOCATION_SIZE 16
-#define READ_LOCATION_LAST 31
-
-/* Version Mask */
-#define NAND_VERSION_MAJOR_MASK 0xf0000000
-#define NAND_VERSION_MAJOR_SHIFT 28
-#define NAND_VERSION_MINOR_MASK 0x0fff0000
-#define NAND_VERSION_MINOR_SHIFT 16
-
-/* NAND OP_CMDs */
-#define OP_PAGE_READ 0x2
-#define OP_PAGE_READ_WITH_ECC 0x3
-#define OP_PAGE_READ_WITH_ECC_SPARE 0x4
-#define OP_PAGE_READ_ONFI_READ 0x5
-#define OP_PROGRAM_PAGE 0x6
-#define OP_PAGE_PROGRAM_WITH_ECC 0x7
-#define OP_PROGRAM_PAGE_SPARE 0x9
-#define OP_BLOCK_ERASE 0xa
-#define OP_CHECK_STATUS 0xc
-#define OP_FETCH_ID 0xb
-#define OP_RESET_DEVICE 0xd
-
-/* Default Value for NAND_DEV_CMD_VLD */
-#define NAND_DEV_CMD_VLD_VAL (READ_START_VLD | WRITE_START_VLD | \
- ERASE_START_VLD | SEQ_READ_START_VLD)
-
-/* NAND_CTRL bits */
-#define BAM_MODE_EN BIT(0)
-
-/*
- * the NAND controller performs reads/writes with ECC in 516 byte chunks.
- * the driver calls the chunks 'step' or 'codeword' interchangeably
- */
-#define NANDC_STEP_SIZE 512
-
-/*
- * the largest page size we support is 8K, this will have 16 steps/codewords
- * of 512 bytes each
- */
-#define MAX_NUM_STEPS (SZ_8K / NANDC_STEP_SIZE)
-
-/* we read at most 3 registers per codeword scan */
-#define MAX_REG_RD (3 * MAX_NUM_STEPS)
+#include <linux/mtd/nand-qpic-common.h>

/* ECC modes supported by the controller */
#define ECC_NONE BIT(0)
@@ -200,247 +21,6 @@ nandc_set_reg(chip, reg, \
((cw_offset) << READ_LOCATION_OFFSET) | \
((read_size) << READ_LOCATION_SIZE) | \
((is_last_read_loc) << READ_LOCATION_LAST))
-/*
- * Returns the actual register address for all NAND_DEV_ registers
- * (i.e. NAND_DEV_CMD0, NAND_DEV_CMD1, NAND_DEV_CMD2 and NAND_DEV_CMD_VLD)
- */
-#define dev_cmd_reg_addr(nandc, reg) ((nandc)->props->dev_cmd_reg_start + (reg))
-
-/* Returns the NAND register physical address */
-#define nandc_reg_phys(chip, offset) ((chip)->base_phys + (offset))
-
-/* Returns the dma address for reg read buffer */
-#define reg_buf_dma_addr(chip, vaddr) \
- ((chip)->reg_read_dma + \
- ((u8 *)(vaddr) - (u8 *)(chip)->reg_read_buf))
-
-#define QPIC_PER_CW_CMD_ELEMENTS 32
-#define QPIC_PER_CW_CMD_SGL 32
-#define QPIC_PER_CW_DATA_SGL 8
-
-#define QPIC_NAND_COMPLETION_TIMEOUT msecs_to_jiffies(2000)
-
-/*
- * Flags used in DMA descriptor preparation helper functions
- * (i.e. read_reg_dma/write_reg_dma/read_data_dma/write_data_dma)
- */
-/* Don't set the EOT in current tx BAM sgl */
-#define NAND_BAM_NO_EOT BIT(0)
-/* Set the NWD flag in current BAM sgl */
-#define NAND_BAM_NWD BIT(1)
-/* Finish writing in the current BAM sgl and start writing in another BAM sgl */
-#define NAND_BAM_NEXT_SGL BIT(2)
-/*
- * Erased codeword status is being used two times in single transfer so this
- * flag will determine the current value of erased codeword status register
- */
-#define NAND_ERASED_CW_SET BIT(4)
-
-#define MAX_ADDRESS_CYCLE 5
-
-/*
- * This data type corresponds to the BAM transaction which will be used for all
- * NAND transfers.
- * @bam_ce - the array of BAM command elements
- * @cmd_sgl - sgl for NAND BAM command pipe
- * @data_sgl - sgl for NAND BAM consumer/producer pipe
- * @last_data_desc - last DMA desc in data channel (tx/rx).
- * @last_cmd_desc - last DMA desc in command channel.
- * @txn_done - completion for NAND transfer.
- * @bam_ce_pos - the index in bam_ce which is available for next sgl
- * @bam_ce_start - the index in bam_ce which marks the start position ce
- * for current sgl. It will be used for size calculation
- * for current sgl
- * @cmd_sgl_pos - current index in command sgl.
- * @cmd_sgl_start - start index in command sgl.
- * @tx_sgl_pos - current index in data sgl for tx.
- * @tx_sgl_start - start index in data sgl for tx.
- * @rx_sgl_pos - current index in data sgl for rx.
- * @rx_sgl_start - start index in data sgl for rx.
- * @wait_second_completion - wait for second DMA desc completion before making
- * the NAND transfer completion.
- */
-struct bam_transaction {
- struct bam_cmd_element *bam_ce;
- struct scatterlist *cmd_sgl;
- struct scatterlist *data_sgl;
- struct dma_async_tx_descriptor *last_data_desc;
- struct dma_async_tx_descriptor *last_cmd_desc;
- struct completion txn_done;
- u32 bam_ce_pos;
- u32 bam_ce_start;
- u32 cmd_sgl_pos;
- u32 cmd_sgl_start;
- u32 tx_sgl_pos;
- u32 tx_sgl_start;
- u32 rx_sgl_pos;
- u32 rx_sgl_start;
- bool wait_second_completion;
-};
-
-/*
- * This data type corresponds to the nand dma descriptor
- * @dma_desc - low level DMA engine descriptor
- * @list - list for desc_info
- *
- * @adm_sgl - sgl which will be used for single sgl dma descriptor. Only used by
- * ADM
- * @bam_sgl - sgl which will be used for dma descriptor. Only used by BAM
- * @sgl_cnt - number of SGL in bam_sgl. Only used by BAM
- * @dir - DMA transfer direction
- */
-struct desc_info {
- struct dma_async_tx_descriptor *dma_desc;
- struct list_head node;
-
- union {
- struct scatterlist adm_sgl;
- struct {
- struct scatterlist *bam_sgl;
- int sgl_cnt;
- };
- };
- enum dma_data_direction dir;
-};
-
-/*
- * holds the current register values that we want to write. acts as a contiguous
- * chunk of memory which we use to write the controller registers through DMA.
- */
-struct nandc_regs {
- __le32 cmd;
- __le32 addr0;
- __le32 addr1;
- __le32 chip_sel;
- __le32 exec;
-
- __le32 cfg0;
- __le32 cfg1;
- __le32 ecc_bch_cfg;
-
- __le32 clrflashstatus;
- __le32 clrreadstatus;
-
- __le32 cmd1;
- __le32 vld;
-
- __le32 orig_cmd1;
- __le32 orig_vld;
-
- __le32 ecc_buf_cfg;
- __le32 read_location0;
- __le32 read_location1;
- __le32 read_location2;
- __le32 read_location3;
- __le32 read_location_last0;
- __le32 read_location_last1;
- __le32 read_location_last2;
- __le32 read_location_last3;
-
- __le32 erased_cw_detect_cfg_clr;
- __le32 erased_cw_detect_cfg_set;
-};
-
-/*
- * NAND controller data struct
- *
- * @dev: parent device
- *
- * @base: MMIO base
- *
- * @core_clk: controller clock
- * @aon_clk: another controller clock
- *
- * @regs: a contiguous chunk of memory for DMA register
- * writes. contains the register values to be
- * written to controller
- *
- * @props: properties of current NAND controller,
- * initialized via DT match data
- *
- * @controller: base controller structure
- * @host_list: list containing all the chips attached to the
- * controller
- *
- * @chan: dma channel
- * @cmd_crci: ADM DMA CRCI for command flow control
- * @data_crci: ADM DMA CRCI for data flow control
- *
- * @desc_list: DMA descriptor list (list of desc_infos)
- *
- * @data_buffer: our local DMA buffer for page read/writes,
- * used when we can't use the buffer provided
- * by upper layers directly
- * @reg_read_buf: local buffer for reading back registers via DMA
- *
- * @base_phys: physical base address of controller registers
- * @base_dma: dma base address of controller registers
- * @reg_read_dma: contains dma address for register read buffer
- *
- * @buf_size/count/start: markers for chip->legacy.read_buf/write_buf
- * functions
- * @max_cwperpage: maximum QPIC codewords required. calculated
- * from all connected NAND devices pagesize
- *
- * @reg_read_pos: marker for data read in reg_read_buf
- *
- * @cmd1/vld: some fixed controller register values
- *
- * @exec_opwrite: flag to select correct number of code word
- * while reading status
- */
-struct qcom_nand_controller {
- struct device *dev;
-
- void __iomem *base;
-
- struct clk *core_clk;
- struct clk *aon_clk;
-
- struct nandc_regs *regs;
- struct bam_transaction *bam_txn;
-
- const struct qcom_nandc_props *props;
-
- struct nand_controller controller;
- struct list_head host_list;
-
- union {
- /* will be used only by QPIC for BAM DMA */
- struct {
- struct dma_chan *tx_chan;
- struct dma_chan *rx_chan;
- struct dma_chan *cmd_chan;
- };
-
- /* will be used only by EBI2 for ADM DMA */
- struct {
- struct dma_chan *chan;
- unsigned int cmd_crci;
- unsigned int data_crci;
- };
- };
-
- struct list_head desc_list;
-
- u8 *data_buffer;
- __le32 *reg_read_buf;
-
- phys_addr_t base_phys;
- dma_addr_t base_dma;
- dma_addr_t reg_read_dma;
-
- int buf_size;
- int buf_count;
- int buf_start;
- unsigned int max_cwperpage;
-
- int reg_read_pos;
-
- u32 cmd1, vld;
- bool exec_opwrite;
-};
-
/*
* NAND special boot partitions
*
@@ -544,113 +124,24 @@ struct qcom_nand_host {
bool bch_enabled;
};

-/*
- * This data type corresponds to the NAND controller properties which varies
- * among different NAND controllers.
- * @ecc_modes - ecc mode for NAND
- * @dev_cmd_reg_start - NAND_DEV_CMD_* registers starting offset
- * @is_bam - whether NAND controller is using BAM
- * @is_qpic - whether NAND CTRL is part of qpic IP
- * @qpic_v2 - flag to indicate QPIC IP version 2
- * @use_codeword_fixup - whether NAND has different layout for boot partitions
- */
-struct qcom_nandc_props {
- u32 ecc_modes;
- u32 dev_cmd_reg_start;
- bool is_bam;
- bool is_qpic;
- bool qpic_v2;
- bool use_codeword_fixup;
-};
-
-/* Frees the BAM transaction memory */
-static void free_bam_transaction(struct qcom_nand_controller *nandc)
-{
- struct bam_transaction *bam_txn = nandc->bam_txn;
-
- devm_kfree(nandc->dev, bam_txn);
-}
-
-/* Allocates and Initializes the BAM transaction */
-static struct bam_transaction *
-alloc_bam_transaction(struct qcom_nand_controller *nandc)
+struct qcom_nand_controller *
+get_qcom_nand_controller(struct nand_chip *chip)
{
- struct bam_transaction *bam_txn;
- size_t bam_txn_size;
- unsigned int num_cw = nandc->max_cwperpage;
- void *bam_txn_buf;
-
- bam_txn_size =
- sizeof(*bam_txn) + num_cw *
- ((sizeof(*bam_txn->bam_ce) * QPIC_PER_CW_CMD_ELEMENTS) +
- (sizeof(*bam_txn->cmd_sgl) * QPIC_PER_CW_CMD_SGL) +
- (sizeof(*bam_txn->data_sgl) * QPIC_PER_CW_DATA_SGL));
-
- bam_txn_buf = devm_kzalloc(nandc->dev, bam_txn_size, GFP_KERNEL);
- if (!bam_txn_buf)
- return NULL;
-
- bam_txn = bam_txn_buf;
- bam_txn_buf += sizeof(*bam_txn);
-
- bam_txn->bam_ce = bam_txn_buf;
- bam_txn_buf +=
- sizeof(*bam_txn->bam_ce) * QPIC_PER_CW_CMD_ELEMENTS * num_cw;
-
- bam_txn->cmd_sgl = bam_txn_buf;
- bam_txn_buf +=
- sizeof(*bam_txn->cmd_sgl) * QPIC_PER_CW_CMD_SGL * num_cw;
-
- bam_txn->data_sgl = bam_txn_buf;
-
- init_completion(&bam_txn->txn_done);
-
- return bam_txn;
+ return container_of(chip->controller, struct qcom_nand_controller,
+ controller);
}

-/* Clears the BAM transaction indexes */
-static void clear_bam_transaction(struct qcom_nand_controller *nandc)
+static void nandc_set_reg(struct nand_chip *chip, int offset,
+ u32 val)
{
- struct bam_transaction *bam_txn = nandc->bam_txn;
-
- if (!nandc->props->is_bam)
- return;
-
- bam_txn->bam_ce_pos = 0;
- bam_txn->bam_ce_start = 0;
- bam_txn->cmd_sgl_pos = 0;
- bam_txn->cmd_sgl_start = 0;
- bam_txn->tx_sgl_pos = 0;
- bam_txn->tx_sgl_start = 0;
- bam_txn->rx_sgl_pos = 0;
- bam_txn->rx_sgl_start = 0;
- bam_txn->last_data_desc = NULL;
- bam_txn->wait_second_completion = false;
-
- sg_init_table(bam_txn->cmd_sgl, nandc->max_cwperpage *
- QPIC_PER_CW_CMD_SGL);
- sg_init_table(bam_txn->data_sgl, nandc->max_cwperpage *
- QPIC_PER_CW_DATA_SGL);
-
- reinit_completion(&bam_txn->txn_done);
-}
+ struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);
+ struct nandc_regs *regs = nandc->regs;
+ __le32 *reg;

-/* Callback for DMA descriptor completion */
-static void qpic_bam_dma_done(void *data)
-{
- struct bam_transaction *bam_txn = data;
+ reg = qcom_offset_to_nandc_reg(regs, offset);

- /*
- * In case of data transfer with NAND, 2 callbacks will be generated.
- * One for command channel and another one for data channel.
- * If current transaction has data descriptors
- * (i.e. wait_second_completion is true), then set this to false
- * and wait for second DMA descriptor completion.
- */
- if (bam_txn->wait_second_completion)
- bam_txn->wait_second_completion = false;
- else
- complete(&bam_txn->txn_done);
+ if (reg)
+ *reg = cpu_to_le32(val);
}

static inline struct qcom_nand_host *to_qcom_nand_host(struct nand_chip *chip)
@@ -658,13 +149,6 @@ static inline struct qcom_nand_host *to_qcom_nand_host(struct nand_chip *chip)
return container_of(chip, struct qcom_nand_host, chip);
}

-static inline struct qcom_nand_controller *
-get_qcom_nand_controller(struct nand_chip *chip)
-{
- return container_of(chip->controller, struct qcom_nand_controller,
- controller);
-}
-
static inline u32 nandc_read(struct qcom_nand_controller *nandc, int offset)
{
return ioread32(nandc->base + offset);
@@ -676,91 +160,6 @@ static inline void nandc_write(struct qcom_nand_controller *nandc, int offset,
iowrite32(val, nandc->base + offset);
}

-static inline void nandc_read_buffer_sync(struct qcom_nand_controller *nandc,
- bool is_cpu)
-{
- if (!nandc->props->is_bam)
- return;
-
- if (is_cpu)
- dma_sync_single_for_cpu(nandc->dev, nandc->reg_read_dma,
- MAX_REG_RD *
- sizeof(*nandc->reg_read_buf),
- DMA_FROM_DEVICE);
- else
- dma_sync_single_for_device(nandc->dev, nandc->reg_read_dma,
- MAX_REG_RD *
- sizeof(*nandc->reg_read_buf),
- DMA_FROM_DEVICE);
-}
-
-static __le32 *offset_to_nandc_reg(struct nandc_regs *regs, int offset)
-{
- switch (offset) {
- case NAND_FLASH_CMD:
- return &regs->cmd;
- case NAND_ADDR0:
- return &regs->addr0;
- case NAND_ADDR1:
- return &regs->addr1;
- case NAND_FLASH_CHIP_SELECT:
- return &regs->chip_sel;
- case NAND_EXEC_CMD:
- return &regs->exec;
- case NAND_FLASH_STATUS:
- return &regs->clrflashstatus;
- case NAND_DEV0_CFG0:
- return &regs->cfg0;
- case NAND_DEV0_CFG1:
- return &regs->cfg1;
- case NAND_DEV0_ECC_CFG:
- return &regs->ecc_bch_cfg;
- case NAND_READ_STATUS:
- return &regs->clrreadstatus;
- case NAND_DEV_CMD1:
- return &regs->cmd1;
- case NAND_DEV_CMD1_RESTORE:
- return &regs->orig_cmd1;
- case NAND_DEV_CMD_VLD:
- return &regs->vld;
- case NAND_DEV_CMD_VLD_RESTORE:
- return &regs->orig_vld;
- case NAND_EBI2_ECC_BUF_CFG:
- return &regs->ecc_buf_cfg;
- case NAND_READ_LOCATION_0:
- return &regs->read_location0;
- case NAND_READ_LOCATION_1:
- return &regs->read_location1;
- case NAND_READ_LOCATION_2:
- return &regs->read_location2;
- case NAND_READ_LOCATION_3:
- return &regs->read_location3;
- case NAND_READ_LOCATION_LAST_CW_0:
- return &regs->read_location_last0;
- case NAND_READ_LOCATION_LAST_CW_1:
- return &regs->read_location_last1;
- case NAND_READ_LOCATION_LAST_CW_2:
- return &regs->read_location_last2;
- case NAND_READ_LOCATION_LAST_CW_3:
- return &regs->read_location_last3;
- default:
- return NULL;
- }
-}
-
-static void nandc_set_reg(struct nand_chip *chip, int offset,
- u32 val)
-{
- struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);
- struct nandc_regs *regs = nandc->regs;
- __le32 *reg;
-
- reg = offset_to_nandc_reg(regs, offset);
-
- if (reg)
- *reg = cpu_to_le32(val);
-}
-
/* Helper to check the code word, whether it is last cw or not */
static bool qcom_nandc_is_last_cw(struct nand_ecc_ctrl *ecc, int cw)
{
@@ -852,383 +251,6 @@ static void update_rw_regs(struct qcom_nand_host *host, int num_cw, bool read, i
host->cw_data : host->cw_size, 1);
}

-/*
- * Maps the scatter gather list for DMA transfer and forms the DMA descriptor
- * for BAM. This descriptor will be added in the NAND DMA descriptor queue
- * which will be submitted to DMA engine.
- */
-static int prepare_bam_async_desc(struct qcom_nand_controller *nandc,
- struct dma_chan *chan,
- unsigned long flags)
-{
- struct desc_info *desc;
- struct scatterlist *sgl;
- unsigned int sgl_cnt;
- int ret;
- struct bam_transaction *bam_txn = nandc->bam_txn;
- enum dma_transfer_direction dir_eng;
- struct dma_async_tx_descriptor *dma_desc;
-
- desc = kzalloc(sizeof(*desc), GFP_KERNEL);
- if (!desc)
- return -ENOMEM;
-
- if (chan == nandc->cmd_chan) {
- sgl = &bam_txn->cmd_sgl[bam_txn->cmd_sgl_start];
- sgl_cnt = bam_txn->cmd_sgl_pos - bam_txn->cmd_sgl_start;
- bam_txn->cmd_sgl_start = bam_txn->cmd_sgl_pos;
- dir_eng = DMA_MEM_TO_DEV;
- desc->dir = DMA_TO_DEVICE;
- } else if (chan == nandc->tx_chan) {
- sgl = &bam_txn->data_sgl[bam_txn->tx_sgl_start];
- sgl_cnt = bam_txn->tx_sgl_pos - bam_txn->tx_sgl_start;
- bam_txn->tx_sgl_start = bam_txn->tx_sgl_pos;
- dir_eng = DMA_MEM_TO_DEV;
- desc->dir = DMA_TO_DEVICE;
- } else {
- sgl = &bam_txn->data_sgl[bam_txn->rx_sgl_start];
- sgl_cnt = bam_txn->rx_sgl_pos - bam_txn->rx_sgl_start;
- bam_txn->rx_sgl_start = bam_txn->rx_sgl_pos;
- dir_eng = DMA_DEV_TO_MEM;
- desc->dir = DMA_FROM_DEVICE;
- }
-
- sg_mark_end(sgl + sgl_cnt - 1);
- ret = dma_map_sg(nandc->dev, sgl, sgl_cnt, desc->dir);
- if (ret == 0) {
- dev_err(nandc->dev, "failure in mapping desc\n");
- kfree(desc);
- return -ENOMEM;
- }
-
- desc->sgl_cnt = sgl_cnt;
- desc->bam_sgl = sgl;
-
- dma_desc = dmaengine_prep_slave_sg(chan, sgl, sgl_cnt, dir_eng,
- flags);
-
- if (!dma_desc) {
- dev_err(nandc->dev, "failure in prep desc\n");
- dma_unmap_sg(nandc->dev, sgl, sgl_cnt, desc->dir);
- kfree(desc);
- return -EINVAL;
- }
-
- desc->dma_desc = dma_desc;
-
- /* update last data/command descriptor */
- if (chan == nandc->cmd_chan)
- bam_txn->last_cmd_desc = dma_desc;
- else
- bam_txn->last_data_desc = dma_desc;
-
- list_add_tail(&desc->node, &nandc->desc_list);
-
- return 0;
-}
-
-/*
- * Prepares the command descriptor for BAM DMA which will be used for NAND
- * register reads and writes. The command descriptor requires the command
- * to be formed in command element type so this function uses the command
- * element from bam transaction ce array and fills the same with required
- * data. A single SGL can contain multiple command elements so
- * NAND_BAM_NEXT_SGL will be used for starting the separate SGL
- * after the current command element.
- */
-static int prep_bam_dma_desc_cmd(struct qcom_nand_controller *nandc, bool read,
- int reg_off, const void *vaddr,
- int size, unsigned int flags)
-{
- int bam_ce_size;
- int i, ret;
- struct bam_cmd_element *bam_ce_buffer;
- struct bam_transaction *bam_txn = nandc->bam_txn;
-
- bam_ce_buffer = &bam_txn->bam_ce[bam_txn->bam_ce_pos];
-
- /* fill the command desc */
- for (i = 0; i < size; i++) {
- if (read)
- bam_prep_ce(&bam_ce_buffer[i],
- nandc_reg_phys(nandc, reg_off + 4 * i),
- BAM_READ_COMMAND,
- reg_buf_dma_addr(nandc,
- (__le32 *)vaddr + i));
- else
- bam_prep_ce_le32(&bam_ce_buffer[i],
- nandc_reg_phys(nandc, reg_off + 4 * i),
- BAM_WRITE_COMMAND,
- *((__le32 *)vaddr + i));
- }
-
- bam_txn->bam_ce_pos += size;
-
- /* use the separate sgl after this command */
- if (flags & NAND_BAM_NEXT_SGL) {
- bam_ce_buffer = &bam_txn->bam_ce[bam_txn->bam_ce_start];
- bam_ce_size = (bam_txn->bam_ce_pos -
- bam_txn->bam_ce_start) *
- sizeof(struct bam_cmd_element);
- sg_set_buf(&bam_txn->cmd_sgl[bam_txn->cmd_sgl_pos],
- bam_ce_buffer, bam_ce_size);
- bam_txn->cmd_sgl_pos++;
- bam_txn->bam_ce_start = bam_txn->bam_ce_pos;
-
- if (flags & NAND_BAM_NWD) {
- ret = prepare_bam_async_desc(nandc, nandc->cmd_chan,
- DMA_PREP_FENCE |
- DMA_PREP_CMD);
- if (ret)
- return ret;
- }
- }
-
- return 0;
-}
-
-/*
- * Prepares the data descriptor for BAM DMA which will be used for NAND
- * data reads and writes.
- */
-static int prep_bam_dma_desc_data(struct qcom_nand_controller *nandc, bool read,
- const void *vaddr,
- int size, unsigned int flags)
-{
- int ret;
- struct bam_transaction *bam_txn = nandc->bam_txn;
-
- if (read) {
- sg_set_buf(&bam_txn->data_sgl[bam_txn->rx_sgl_pos],
- vaddr, size);
- bam_txn->rx_sgl_pos++;
- } else {
- sg_set_buf(&bam_txn->data_sgl[bam_txn->tx_sgl_pos],
- vaddr, size);
- bam_txn->tx_sgl_pos++;
-
- /*
- * BAM will only set EOT for DMA_PREP_INTERRUPT so if this flag
- * is not set, form the DMA descriptor
- */
- if (!(flags & NAND_BAM_NO_EOT)) {
- ret = prepare_bam_async_desc(nandc, nandc->tx_chan,
- DMA_PREP_INTERRUPT);
- if (ret)
- return ret;
- }
- }
-
- return 0;
-}
-
-static int prep_adm_dma_desc(struct qcom_nand_controller *nandc, bool read,
- int reg_off, const void *vaddr, int size,
- bool flow_control)
-{
- struct desc_info *desc;
- struct dma_async_tx_descriptor *dma_desc;
- struct scatterlist *sgl;
- struct dma_slave_config slave_conf;
- struct qcom_adm_peripheral_config periph_conf = {};
- enum dma_transfer_direction dir_eng;
- int ret;
-
- desc = kzalloc(sizeof(*desc), GFP_KERNEL);
- if (!desc)
- return -ENOMEM;
-
- sgl = &desc->adm_sgl;
-
- sg_init_one(sgl, vaddr, size);
-
- if (read) {
- dir_eng = DMA_DEV_TO_MEM;
- desc->dir = DMA_FROM_DEVICE;
- } else {
- dir_eng = DMA_MEM_TO_DEV;
- desc->dir = DMA_TO_DEVICE;
- }
-
- ret = dma_map_sg(nandc->dev, sgl, 1, desc->dir);
- if (ret == 0) {
- ret = -ENOMEM;
- goto err;
- }
-
- memset(&slave_conf, 0x00, sizeof(slave_conf));
-
- slave_conf.device_fc = flow_control;
- if (read) {
- slave_conf.src_maxburst = 16;
- slave_conf.src_addr = nandc->base_dma + reg_off;
- if (nandc->data_crci) {
- periph_conf.crci = nandc->data_crci;
- slave_conf.peripheral_config = &periph_conf;
- slave_conf.peripheral_size = sizeof(periph_conf);
- }
- } else {
- slave_conf.dst_maxburst = 16;
- slave_conf.dst_addr = nandc->base_dma + reg_off;
- if (nandc->cmd_crci) {
- periph_conf.crci = nandc->cmd_crci;
- slave_conf.peripheral_config = &periph_conf;
- slave_conf.peripheral_size = sizeof(periph_conf);
- }
- }
-
- ret = dmaengine_slave_config(nandc->chan, &slave_conf);
- if (ret) {
- dev_err(nandc->dev, "failed to configure dma channel\n");
- goto err;
- }
-
- dma_desc = dmaengine_prep_slave_sg(nandc->chan, sgl, 1, dir_eng, 0);
- if (!dma_desc) {
- dev_err(nandc->dev, "failed to prepare desc\n");
- ret = -EINVAL;
- goto err;
- }
-
- desc->dma_desc = dma_desc;
-
- list_add_tail(&desc->node, &nandc->desc_list);
-
- return 0;
-err:
- kfree(desc);
-
- return ret;
-}
-
-/*
- * read_reg_dma: prepares a descriptor to read a given number of
- * contiguous registers to the reg_read_buf pointer
- *
- * @first: offset of the first register in the contiguous block
- * @num_regs: number of registers to read
- * @flags: flags to control DMA descriptor preparation
- */
-static int read_reg_dma(struct qcom_nand_controller *nandc, int first,
- int num_regs, unsigned int flags)
-{
- bool flow_control = false;
- void *vaddr;
-
- vaddr = nandc->reg_read_buf + nandc->reg_read_pos;
- nandc->reg_read_pos += num_regs;
-
- if (first == NAND_DEV_CMD_VLD || first == NAND_DEV_CMD1)
- first = dev_cmd_reg_addr(nandc, first);
-
- if (nandc->props->is_bam)
- return prep_bam_dma_desc_cmd(nandc, true, first, vaddr,
- num_regs, flags);
-
- if (first == NAND_READ_ID || first == NAND_FLASH_STATUS)
- flow_control = true;
-
- return prep_adm_dma_desc(nandc, true, first, vaddr,
- num_regs * sizeof(u32), flow_control);
-}
-
-/*
- * write_reg_dma: prepares a descriptor to write a given number of
- * contiguous registers
- *
- * @first: offset of the first register in the contiguous block
- * @num_regs: number of registers to write
- * @flags: flags to control DMA descriptor preparation
- */
-static int write_reg_dma(struct qcom_nand_controller *nandc, int first,
- int num_regs, unsigned int flags)
-{
- bool flow_control = false;
- struct nandc_regs *regs = nandc->regs;
- void *vaddr;
-
- vaddr = offset_to_nandc_reg(regs, first);
-
- if (first == NAND_ERASED_CW_DETECT_CFG) {
- if (flags & NAND_ERASED_CW_SET)
- vaddr = &regs->erased_cw_detect_cfg_set;
- else
- vaddr = &regs->erased_cw_detect_cfg_clr;
- }
-
- if (first == NAND_EXEC_CMD)
- flags |= NAND_BAM_NWD;
-
- if (first == NAND_DEV_CMD1_RESTORE || first == NAND_DEV_CMD1)
- first = dev_cmd_reg_addr(nandc, NAND_DEV_CMD1);
-
- if (first == NAND_DEV_CMD_VLD_RESTORE || first == NAND_DEV_CMD_VLD)
- first = dev_cmd_reg_addr(nandc, NAND_DEV_CMD_VLD);
-
- if (nandc->props->is_bam)
- return prep_bam_dma_desc_cmd(nandc, false, first, vaddr,
- num_regs, flags);
-
- if (first == NAND_FLASH_CMD)
- flow_control = true;
-
- return prep_adm_dma_desc(nandc, false, first, vaddr,
- num_regs * sizeof(u32), flow_control);
-}
-
-/*
- * read_data_dma: prepares a DMA descriptor to transfer data from the
- * controller's internal buffer to the buffer 'vaddr'
- *
- * @reg_off: offset within the controller's data buffer
- * @vaddr: virtual address of the buffer we want to write to
- * @size: DMA transaction size in bytes
- * @flags: flags to control DMA descriptor preparation
- */
-static int read_data_dma(struct qcom_nand_controller *nandc, int reg_off,
- const u8 *vaddr, int size, unsigned int flags)
-{
- if (nandc->props->is_bam)
- return prep_bam_dma_desc_data(nandc, true, vaddr, size, flags);
-
- return prep_adm_dma_desc(nandc, true, reg_off, vaddr, size, false);
-}
-
-/*
- * write_data_dma: prepares a DMA descriptor to transfer data from
- * 'vaddr' to the controller's internal buffer
- *
- * @reg_off: offset within the controller's data buffer
- * @vaddr: virtual address of the buffer we want to read from
- * @size: DMA transaction size in bytes
- * @flags: flags to control DMA descriptor preparation
- */
-static int write_data_dma(struct qcom_nand_controller *nandc, int reg_off,
- const u8 *vaddr, int size, unsigned int flags)
-{
- if (nandc->props->is_bam)
- return prep_bam_dma_desc_data(nandc, false, vaddr, size, flags);
-
- return prep_adm_dma_desc(nandc, false, reg_off, vaddr, size, false);
-}
-
-/*
- * Helper to prepare DMA descriptors for configuring registers
- * before reading a NAND page.
- */
-static void config_nand_page_read(struct nand_chip *chip)
-{
- struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);
-
- write_reg_dma(nandc, NAND_ADDR0, 2, 0);
- write_reg_dma(nandc, NAND_DEV0_CFG0, 3, 0);
- if (!nandc->props->qpic_v2)
- write_reg_dma(nandc, NAND_EBI2_ECC_BUF_CFG, 1, 0);
- write_reg_dma(nandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
- write_reg_dma(nandc, NAND_ERASED_CW_DETECT_CFG, 1,
- NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
-}
-
/*
* Helper to prepare DMA descriptors for configuring registers
* before reading each codeword in NAND page.
@@ -1245,20 +267,37 @@ config_nand_cw_read(struct nand_chip *chip, bool use_ecc, int cw)
reg = NAND_READ_LOCATION_LAST_CW_0;

if (nandc->props->is_bam)
- write_reg_dma(nandc, reg, 4, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, reg, 4, NAND_BAM_NEXT_SGL);

- write_reg_dma(nandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
- write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);

if (use_ecc) {
- read_reg_dma(nandc, NAND_FLASH_STATUS, 2, 0);
- read_reg_dma(nandc, NAND_ERASED_CW_DETECT_STATUS, 1,
- NAND_BAM_NEXT_SGL);
+ qcom_read_reg_dma(nandc, NAND_FLASH_STATUS, 2, 0);
+ qcom_read_reg_dma(nandc, NAND_ERASED_CW_DETECT_STATUS, 1,
+ NAND_BAM_NEXT_SGL);
} else {
- read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);
+ qcom_read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);
}
}

+/*
+ * Helper to prepare DMA descriptors for configuring registers
+ * before reading a NAND page.
+ */
+void config_nand_page_read(struct nand_chip *chip)
+{
+ struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);
+
+ qcom_write_reg_dma(nandc, NAND_ADDR0, 2, 0);
+ qcom_write_reg_dma(nandc, NAND_DEV0_CFG0, 3, 0);
+ if (!nandc->props->qpic_v2)
+ qcom_write_reg_dma(nandc, NAND_EBI2_ECC_BUF_CFG, 1, 0);
+ qcom_write_reg_dma(nandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
+ qcom_write_reg_dma(nandc, NAND_ERASED_CW_DETECT_CFG, 1,
+ NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
+}
+
/*
* Helper to prepare dma descriptors to configure registers needed for reading a
* single codeword in page
@@ -1279,11 +318,11 @@ static void config_nand_page_write(struct nand_chip *chip)
{
struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);

- write_reg_dma(nandc, NAND_ADDR0, 2, 0);
- write_reg_dma(nandc, NAND_DEV0_CFG0, 3, 0);
+ qcom_write_reg_dma(nandc, NAND_ADDR0, 2, 0);
+ qcom_write_reg_dma(nandc, NAND_DEV0_CFG0, 3, 0);
if (!nandc->props->qpic_v2)
- write_reg_dma(nandc, NAND_EBI2_ECC_BUF_CFG, 1,
- NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_EBI2_ECC_BUF_CFG, 1,
+ NAND_BAM_NEXT_SGL);
}

/*
@@ -1294,95 +333,13 @@ static void config_nand_cw_write(struct nand_chip *chip)
{
struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);

- write_reg_dma(nandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
- write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);

- read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);
+ qcom_read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);

- write_reg_dma(nandc, NAND_FLASH_STATUS, 1, 0);
- write_reg_dma(nandc, NAND_READ_STATUS, 1, NAND_BAM_NEXT_SGL);
-}
-
-/* helpers to submit/free our list of dma descriptors */
-static int submit_descs(struct qcom_nand_controller *nandc)
-{
- struct desc_info *desc, *n;
- dma_cookie_t cookie = 0;
- struct bam_transaction *bam_txn = nandc->bam_txn;
- int ret = 0;
-
- if (nandc->props->is_bam) {
- if (bam_txn->rx_sgl_pos > bam_txn->rx_sgl_start) {
- ret = prepare_bam_async_desc(nandc, nandc->rx_chan, 0);
- if (ret)
- goto err_unmap_free_desc;
- }
-
- if (bam_txn->tx_sgl_pos > bam_txn->tx_sgl_start) {
- ret = prepare_bam_async_desc(nandc, nandc->tx_chan,
- DMA_PREP_INTERRUPT);
- if (ret)
- goto err_unmap_free_desc;
- }
-
- if (bam_txn->cmd_sgl_pos > bam_txn->cmd_sgl_start) {
- ret = prepare_bam_async_desc(nandc, nandc->cmd_chan,
- DMA_PREP_CMD);
- if (ret)
- goto err_unmap_free_desc;
- }
- }
-
- list_for_each_entry(desc, &nandc->desc_list, node)
- cookie = dmaengine_submit(desc->dma_desc);
-
- if (nandc->props->is_bam) {
- bam_txn->last_cmd_desc->callback = qpic_bam_dma_done;
- bam_txn->last_cmd_desc->callback_param = bam_txn;
- if (bam_txn->last_data_desc) {
- bam_txn->last_data_desc->callback = qpic_bam_dma_done;
- bam_txn->last_data_desc->callback_param = bam_txn;
- bam_txn->wait_second_completion = true;
- }
-
- dma_async_issue_pending(nandc->tx_chan);
- dma_async_issue_pending(nandc->rx_chan);
- dma_async_issue_pending(nandc->cmd_chan);
-
- if (!wait_for_completion_timeout(&bam_txn->txn_done,
- QPIC_NAND_COMPLETION_TIMEOUT))
- ret = -ETIMEDOUT;
- } else {
- if (dma_sync_wait(nandc->chan, cookie) != DMA_COMPLETE)
- ret = -ETIMEDOUT;
- }
-
-err_unmap_free_desc:
- /*
- * Unmap the dma sg_list and free the desc allocated by both
- * prepare_bam_async_desc() and prep_adm_dma_desc() functions.
- */
- list_for_each_entry_safe(desc, n, &nandc->desc_list, node) {
- list_del(&desc->node);
-
- if (nandc->props->is_bam)
- dma_unmap_sg(nandc->dev, desc->bam_sgl,
- desc->sgl_cnt, desc->dir);
- else
- dma_unmap_sg(nandc->dev, &desc->adm_sgl, 1,
- desc->dir);
-
- kfree(desc);
- }
-
- return ret;
-}
-
-/* reset the register read buffer for next NAND operation */
-static void clear_read_regs(struct qcom_nand_controller *nandc)
-{
- nandc->reg_read_pos = 0;
- nandc_read_buffer_sync(nandc, false);
+ qcom_write_reg_dma(nandc, NAND_FLASH_STATUS, 1, 0);
+ qcom_write_reg_dma(nandc, NAND_READ_STATUS, 1, NAND_BAM_NEXT_SGL);
}

/*
@@ -1446,7 +403,7 @@ static int check_flash_errors(struct qcom_nand_host *host, int cw_cnt)
struct qcom_nand_controller *nandc = get_qcom_nand_controller(chip);
int i;

- nandc_read_buffer_sync(nandc, true);
+ qcom_nandc_read_buffer_sync(nandc, true);

for (i = 0; i < cw_cnt; i++) {
u32 flash = le32_to_cpu(nandc->reg_read_buf[i]);
@@ -1473,13 +430,13 @@ qcom_nandc_read_cw_raw(struct mtd_info *mtd, struct nand_chip *chip,
nand_read_page_op(chip, page, 0, NULL, 0);
nandc->buf_count = 0;
nandc->buf_start = 0;
- clear_read_regs(nandc);
+ qcom_clear_read_regs(nandc);
host->use_ecc = false;

if (nandc->props->qpic_v2)
raw_cw = ecc->steps - 1;

- clear_bam_transaction(nandc);
+ qcom_clear_bam_transaction(nandc);
set_address(host, host->cw_size * cw, page);
update_rw_regs(host, 1, true, raw_cw);
config_nand_page_read(chip);
@@ -1512,18 +469,18 @@ qcom_nandc_read_cw_raw(struct mtd_info *mtd, struct nand_chip *chip,

config_nand_cw_read(chip, false, raw_cw);

- read_data_dma(nandc, reg_off, data_buf, data_size1, 0);
+ qcom_read_data_dma(nandc, reg_off, data_buf, data_size1, 0);
reg_off += data_size1;

- read_data_dma(nandc, reg_off, oob_buf, oob_size1, 0);
+ qcom_read_data_dma(nandc, reg_off, oob_buf, oob_size1, 0);
reg_off += oob_size1;

- read_data_dma(nandc, reg_off, data_buf + data_size1, data_size2, 0);
+ qcom_read_data_dma(nandc, reg_off, data_buf + data_size1, data_size2, 0);
reg_off += data_size2;

- read_data_dma(nandc, reg_off, oob_buf + oob_size1, oob_size2, 0);
+ qcom_read_data_dma(nandc, reg_off, oob_buf + oob_size1, oob_size2, 0);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure to read raw cw %d\n", cw);
return ret;
@@ -1621,7 +578,7 @@ static int parse_read_errors(struct qcom_nand_host *host, u8 *data_buf,
u8 *data_buf_start = data_buf, *oob_buf_start = oob_buf;

buf = (struct read_stats *)nandc->reg_read_buf;
- nandc_read_buffer_sync(nandc, true);
+ qcom_nandc_read_buffer_sync(nandc, true);

for (i = 0; i < ecc->steps; i++, buf++) {
u32 flash, buffer, erased_cw;
@@ -1750,8 +707,8 @@ static int read_page_ecc(struct qcom_nand_host *host, u8 *data_buf,
config_nand_cw_read(chip, true, i);

if (data_buf)
- read_data_dma(nandc, FLASH_BUF_ACC, data_buf,
- data_size, 0);
+ qcom_read_data_dma(nandc, FLASH_BUF_ACC, data_buf,
+ data_size, 0);

/*
* when ecc is enabled, the controller doesn't read the real
@@ -1766,8 +723,8 @@ static int read_page_ecc(struct qcom_nand_host *host, u8 *data_buf,
for (j = 0; j < host->bbm_size; j++)
*oob_buf++ = 0xff;

- read_data_dma(nandc, FLASH_BUF_ACC + data_size,
- oob_buf, oob_size, 0);
+ qcom_read_data_dma(nandc, FLASH_BUF_ACC + data_size,
+ oob_buf, oob_size, 0);
}

if (data_buf)
@@ -1776,7 +733,7 @@ static int read_page_ecc(struct qcom_nand_host *host, u8 *data_buf,
oob_buf += oob_size;
}

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure to read page/oob\n");
return ret;
@@ -1797,7 +754,7 @@ static int copy_last_cw(struct qcom_nand_host *host, int page)
int size;
int ret;

- clear_read_regs(nandc);
+ qcom_clear_read_regs(nandc);

size = host->use_ecc ? host->cw_data : host->cw_size;

@@ -1809,9 +766,9 @@ static int copy_last_cw(struct qcom_nand_host *host, int page)

config_nand_single_cw_page_read(chip, host->use_ecc, ecc->steps - 1);

- read_data_dma(nandc, FLASH_BUF_ACC, nandc->data_buffer, size, 0);
+ qcom_read_data_dma(nandc, FLASH_BUF_ACC, nandc->data_buffer, size, 0);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret)
dev_err(nandc->dev, "failed to copy last codeword\n");

@@ -1897,14 +854,14 @@ static int qcom_nandc_read_page(struct nand_chip *chip, u8 *buf,
nandc->buf_count = 0;
nandc->buf_start = 0;
host->use_ecc = true;
- clear_read_regs(nandc);
+ qcom_clear_read_regs(nandc);
set_address(host, 0, page);
update_rw_regs(host, ecc->steps, true, 0);

data_buf = buf;
oob_buf = oob_required ? chip->oob_poi : NULL;

- clear_bam_transaction(nandc);
+ qcom_clear_bam_transaction(nandc);

return read_page_ecc(host, data_buf, oob_buf, page);
}
@@ -1945,8 +902,8 @@ static int qcom_nandc_read_oob(struct nand_chip *chip, int page)
if (host->nr_boot_partitions)
qcom_nandc_codeword_fixup(host, page);

- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

host->use_ecc = true;
set_address(host, 0, page);
@@ -1973,8 +930,8 @@ static int qcom_nandc_write_page(struct nand_chip *chip, const u8 *buf,
set_address(host, 0, page);
nandc->buf_count = 0;
nandc->buf_start = 0;
- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

data_buf = (u8 *)buf;
oob_buf = chip->oob_poi;
@@ -1995,8 +952,8 @@ static int qcom_nandc_write_page(struct nand_chip *chip, const u8 *buf,
oob_size = ecc->bytes;
}

- write_data_dma(nandc, FLASH_BUF_ACC, data_buf, data_size,
- i == (ecc->steps - 1) ? NAND_BAM_NO_EOT : 0);
+ qcom_write_data_dma(nandc, FLASH_BUF_ACC, data_buf, data_size,
+ i == (ecc->steps - 1) ? NAND_BAM_NO_EOT : 0);

/*
* when ECC is enabled, we don't really need to write anything
@@ -2008,8 +965,8 @@ static int qcom_nandc_write_page(struct nand_chip *chip, const u8 *buf,
if (qcom_nandc_is_last_cw(ecc, i)) {
oob_buf += host->bbm_size;

- write_data_dma(nandc, FLASH_BUF_ACC + data_size,
- oob_buf, oob_size, 0);
+ qcom_write_data_dma(nandc, FLASH_BUF_ACC + data_size,
+ oob_buf, oob_size, 0);
}

config_nand_cw_write(chip);
@@ -2018,7 +975,7 @@ static int qcom_nandc_write_page(struct nand_chip *chip, const u8 *buf,
oob_buf += oob_size;
}

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure to write page\n");
return ret;
@@ -2043,8 +1000,8 @@ static int qcom_nandc_write_page_raw(struct nand_chip *chip,
qcom_nandc_codeword_fixup(host, page);

nand_prog_page_begin_op(chip, page, 0, NULL, 0);
- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

data_buf = (u8 *)buf;
oob_buf = chip->oob_poi;
@@ -2070,28 +1027,28 @@ static int qcom_nandc_write_page_raw(struct nand_chip *chip,
oob_size2 = host->ecc_bytes_hw + host->spare_bytes;
}

- write_data_dma(nandc, reg_off, data_buf, data_size1,
- NAND_BAM_NO_EOT);
+ qcom_write_data_dma(nandc, reg_off, data_buf, data_size1,
+ NAND_BAM_NO_EOT);
reg_off += data_size1;
data_buf += data_size1;

- write_data_dma(nandc, reg_off, oob_buf, oob_size1,
- NAND_BAM_NO_EOT);
+ qcom_write_data_dma(nandc, reg_off, oob_buf, oob_size1,
+ NAND_BAM_NO_EOT);
reg_off += oob_size1;
oob_buf += oob_size1;

- write_data_dma(nandc, reg_off, data_buf, data_size2,
- NAND_BAM_NO_EOT);
+ qcom_write_data_dma(nandc, reg_off, data_buf, data_size2,
+ NAND_BAM_NO_EOT);
reg_off += data_size2;
data_buf += data_size2;

- write_data_dma(nandc, reg_off, oob_buf, oob_size2, 0);
+ qcom_write_data_dma(nandc, reg_off, oob_buf, oob_size2, 0);
oob_buf += oob_size2;

config_nand_cw_write(chip);
}

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure to write raw page\n");
return ret;
@@ -2121,7 +1078,7 @@ static int qcom_nandc_write_oob(struct nand_chip *chip, int page)
qcom_nandc_codeword_fixup(host, page);

host->use_ecc = true;
- clear_bam_transaction(nandc);
+ qcom_clear_bam_transaction(nandc);

/* calculate the data and oob size for the last codeword/step */
data_size = ecc->size - ((ecc->steps - 1) << 2);
@@ -2136,11 +1093,11 @@ static int qcom_nandc_write_oob(struct nand_chip *chip, int page)
update_rw_regs(host, 1, false, 0);

config_nand_page_write(chip);
- write_data_dma(nandc, FLASH_BUF_ACC,
- nandc->data_buffer, data_size + oob_size, 0);
+ qcom_write_data_dma(nandc, FLASH_BUF_ACC,
+ nandc->data_buffer, data_size + oob_size, 0);
config_nand_cw_write(chip);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure to write oob\n");
return ret;
@@ -2167,7 +1124,7 @@ static int qcom_nandc_block_bad(struct nand_chip *chip, loff_t ofs)
*/
host->use_ecc = false;

- clear_bam_transaction(nandc);
+ qcom_clear_bam_transaction(nandc);
ret = copy_last_cw(host, page);
if (ret)
goto err;
@@ -2194,8 +1151,8 @@ static int qcom_nandc_block_markbad(struct nand_chip *chip, loff_t ofs)
struct nand_ecc_ctrl *ecc = &chip->ecc;
int page, ret;

- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

/*
* to mark the BBM as bad, we flash the entire last codeword with 0s.
@@ -2212,11 +1169,11 @@ static int qcom_nandc_block_markbad(struct nand_chip *chip, loff_t ofs)
update_rw_regs(host, 1, false, ecc->steps - 1);

config_nand_page_write(chip);
- write_data_dma(nandc, FLASH_BUF_ACC,
- nandc->data_buffer, host->cw_size, 0);
+ qcom_write_data_dma(nandc, FLASH_BUF_ACC,
+ nandc->data_buffer, host->cw_size, 0);
config_nand_cw_write(chip);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure to update BBM\n");
return ret;
@@ -2456,14 +1413,14 @@ static int qcom_nand_attach_chip(struct nand_chip *chip)
mtd_set_ooblayout(mtd, &qcom_nand_ooblayout_ops);
/* Free the initially allocated BAM transaction for reading the ONFI params */
if (nandc->props->is_bam)
- free_bam_transaction(nandc);
+ qcom_free_bam_transaction(nandc);

nandc->max_cwperpage = max_t(unsigned int, nandc->max_cwperpage,
cwperpage);

/* Now allocate the BAM transaction based on updated max_cwperpage */
if (nandc->props->is_bam) {
- nandc->bam_txn = alloc_bam_transaction(nandc);
+ nandc->bam_txn = qcom_alloc_bam_transaction(nandc);
if (!nandc->bam_txn) {
dev_err(nandc->dev,
"failed to allocate bam transaction\n");
@@ -2663,7 +1620,7 @@ static int qcom_wait_rdy_poll(struct nand_chip *chip, unsigned int time_ms)
unsigned long start = jiffies + msecs_to_jiffies(time_ms);
u32 flash;

- nandc_read_buffer_sync(nandc, true);
+ qcom_nandc_read_buffer_sync(nandc, true);

do {
flash = le32_to_cpu(nandc->reg_read_buf[0]);
@@ -2703,23 +1660,23 @@ static int qcom_read_status_exec(struct nand_chip *chip,
nandc->buf_start = 0;
host->use_ecc = false;

- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

nandc_set_reg(chip, NAND_FLASH_CMD, q_op.cmd_reg);
nandc_set_reg(chip, NAND_EXEC_CMD, 1);

- write_reg_dma(nandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
- write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
- read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure in submitting status descriptor\n");
goto err_out;
}

- nandc_read_buffer_sync(nandc, true);
+ qcom_nandc_read_buffer_sync(nandc, true);

for (i = 0; i < num_cw; i++) {
flash_status = le32_to_cpu(nandc->reg_read_buf[i]);
@@ -2760,8 +1717,8 @@ static int qcom_read_id_type_exec(struct nand_chip *chip, const struct nand_subo
nandc->buf_start = 0;
host->use_ecc = false;

- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

nandc_set_reg(chip, NAND_FLASH_CMD, q_op.cmd_reg);
nandc_set_reg(chip, NAND_ADDR0, q_op.addr1_reg);
@@ -2771,12 +1728,12 @@ static int qcom_read_id_type_exec(struct nand_chip *chip, const struct nand_subo

nandc_set_reg(chip, NAND_EXEC_CMD, 1);

- write_reg_dma(nandc, NAND_FLASH_CMD, 4, NAND_BAM_NEXT_SGL);
- write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_FLASH_CMD, 4, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);

- read_reg_dma(nandc, NAND_READ_ID, 1, NAND_BAM_NEXT_SGL);
+ qcom_read_reg_dma(nandc, NAND_READ_ID, 1, NAND_BAM_NEXT_SGL);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure in submitting read id descriptor\n");
goto err_out;
@@ -2786,7 +1743,7 @@ static int qcom_read_id_type_exec(struct nand_chip *chip, const struct nand_subo
op_id = q_op.data_instr_idx;
len = nand_subop_get_data_len(subop, op_id);

- nandc_read_buffer_sync(nandc, true);
+ qcom_nandc_read_buffer_sync(nandc, true);
memcpy(instr->ctx.data.buf.in, nandc->reg_read_buf, len);

err_out:
@@ -2823,21 +1780,21 @@ static int qcom_misc_cmd_type_exec(struct nand_chip *chip, const struct nand_sub
nandc->buf_start = 0;
host->use_ecc = false;

- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

nandc_set_reg(chip, NAND_FLASH_CMD, q_op.cmd_reg);
nandc_set_reg(chip, NAND_EXEC_CMD, 1);

- write_reg_dma(nandc, NAND_FLASH_CMD, instrs, NAND_BAM_NEXT_SGL);
- (q_op.cmd_reg == OP_BLOCK_ERASE) ? write_reg_dma(nandc, NAND_DEV0_CFG0,
- 2, NAND_BAM_NEXT_SGL) : read_reg_dma(nandc,
+ qcom_write_reg_dma(nandc, NAND_FLASH_CMD, instrs, NAND_BAM_NEXT_SGL);
+ (q_op.cmd_reg == OP_BLOCK_ERASE) ? qcom_write_reg_dma(nandc, NAND_DEV0_CFG0,
+ 2, NAND_BAM_NEXT_SGL) : qcom_read_reg_dma(nandc,
NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);

- write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
- read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
+ qcom_read_reg_dma(nandc, NAND_FLASH_STATUS, 1, NAND_BAM_NEXT_SGL);

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure in submitting misc descriptor\n");
goto err_out;
@@ -2870,8 +1827,8 @@ static int qcom_param_page_type_exec(struct nand_chip *chip, const struct nand_
nandc->buf_count = 0;
nandc->buf_start = 0;
host->use_ecc = false;
- clear_read_regs(nandc);
- clear_bam_transaction(nandc);
+ qcom_clear_read_regs(nandc);
+ qcom_clear_bam_transaction(nandc);

nandc_set_reg(chip, NAND_FLASH_CMD, q_op.cmd_reg);

@@ -2914,8 +1871,8 @@ static int qcom_param_page_type_exec(struct nand_chip *chip, const struct nand_
nandc_set_read_loc(chip, 0, 0, 0, len, 1);

if (!nandc->props->qpic_v2) {
- write_reg_dma(nandc, NAND_DEV_CMD_VLD, 1, 0);
- write_reg_dma(nandc, NAND_DEV_CMD1, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_DEV_CMD_VLD, 1, 0);
+ qcom_write_reg_dma(nandc, NAND_DEV_CMD1, 1, NAND_BAM_NEXT_SGL);
}

nandc->buf_count = len;
@@ -2923,16 +1880,16 @@ static int qcom_param_page_type_exec(struct nand_chip *chip, const struct nand_

config_nand_single_cw_page_read(chip, false, 0);

- read_data_dma(nandc, FLASH_BUF_ACC, nandc->data_buffer,
- nandc->buf_count, 0);
+ qcom_read_data_dma(nandc, FLASH_BUF_ACC, nandc->data_buffer,
+ nandc->buf_count, 0);

/* restore CMD1 and VLD regs */
if (!nandc->props->qpic_v2) {
- write_reg_dma(nandc, NAND_DEV_CMD1_RESTORE, 1, 0);
- write_reg_dma(nandc, NAND_DEV_CMD_VLD_RESTORE, 1, NAND_BAM_NEXT_SGL);
+ qcom_write_reg_dma(nandc, NAND_DEV_CMD1_RESTORE, 1, 0);
+ qcom_write_reg_dma(nandc, NAND_DEV_CMD_VLD_RESTORE, 1, NAND_BAM_NEXT_SGL);
}

- ret = submit_descs(nandc);
+ ret = qcom_submit_descs(nandc);
if (ret) {
dev_err(nandc->dev, "failure in submitting param page descriptor\n");
goto err_out;
@@ -3016,136 +1973,6 @@ static const struct nand_controller_ops qcom_nandc_ops = {
.exec_op = qcom_nand_exec_op,
};

-static void qcom_nandc_unalloc(struct qcom_nand_controller *nandc)
-{
- if (nandc->props->is_bam) {
- if (!dma_mapping_error(nandc->dev, nandc->reg_read_dma))
- dma_unmap_single(nandc->dev, nandc->reg_read_dma,
- MAX_REG_RD *
- sizeof(*nandc->reg_read_buf),
- DMA_FROM_DEVICE);
-
- if (nandc->tx_chan)
- dma_release_channel(nandc->tx_chan);
-
- if (nandc->rx_chan)
- dma_release_channel(nandc->rx_chan);
-
- if (nandc->cmd_chan)
- dma_release_channel(nandc->cmd_chan);
- } else {
- if (nandc->chan)
- dma_release_channel(nandc->chan);
- }
-}
-
-static int qcom_nandc_alloc(struct qcom_nand_controller *nandc)
-{
- int ret;
-
- ret = dma_set_coherent_mask(nandc->dev, DMA_BIT_MASK(32));
- if (ret) {
- dev_err(nandc->dev, "failed to set DMA mask\n");
- return ret;
- }
-
- /*
- * we use the internal buffer for reading ONFI params, reading small
- * data like ID and status, and preforming read-copy-write operations
- * when writing to a codeword partially. 532 is the maximum possible
- * size of a codeword for our nand controller
- */
- nandc->buf_size = 532;
-
- nandc->data_buffer = devm_kzalloc(nandc->dev, nandc->buf_size, GFP_KERNEL);
- if (!nandc->data_buffer)
- return -ENOMEM;
-
- nandc->regs = devm_kzalloc(nandc->dev, sizeof(*nandc->regs), GFP_KERNEL);
- if (!nandc->regs)
- return -ENOMEM;
-
- nandc->reg_read_buf = devm_kcalloc(nandc->dev, MAX_REG_RD,
- sizeof(*nandc->reg_read_buf),
- GFP_KERNEL);
- if (!nandc->reg_read_buf)
- return -ENOMEM;
-
- if (nandc->props->is_bam) {
- nandc->reg_read_dma =
- dma_map_single(nandc->dev, nandc->reg_read_buf,
- MAX_REG_RD *
- sizeof(*nandc->reg_read_buf),
- DMA_FROM_DEVICE);
- if (dma_mapping_error(nandc->dev, nandc->reg_read_dma)) {
- dev_err(nandc->dev, "failed to DMA MAP reg buffer\n");
- return -EIO;
- }
-
- nandc->tx_chan = dma_request_chan(nandc->dev, "tx");
- if (IS_ERR(nandc->tx_chan)) {
- ret = PTR_ERR(nandc->tx_chan);
- nandc->tx_chan = NULL;
- dev_err_probe(nandc->dev, ret,
- "tx DMA channel request failed\n");
- goto unalloc;
- }
-
- nandc->rx_chan = dma_request_chan(nandc->dev, "rx");
- if (IS_ERR(nandc->rx_chan)) {
- ret = PTR_ERR(nandc->rx_chan);
- nandc->rx_chan = NULL;
- dev_err_probe(nandc->dev, ret,
- "rx DMA channel request failed\n");
- goto unalloc;
- }
-
- nandc->cmd_chan = dma_request_chan(nandc->dev, "cmd");
- if (IS_ERR(nandc->cmd_chan)) {
- ret = PTR_ERR(nandc->cmd_chan);
- nandc->cmd_chan = NULL;
- dev_err_probe(nandc->dev, ret,
- "cmd DMA channel request failed\n");
- goto unalloc;
- }
-
- /*
- * Initially allocate BAM transaction to read ONFI param page.
- * After detecting all the devices, this BAM transaction will
- * be freed and the next BAM transaction will be allocated with
- * maximum codeword size
- */
- nandc->max_cwperpage = 1;
- nandc->bam_txn = alloc_bam_transaction(nandc);
- if (!nandc->bam_txn) {
- dev_err(nandc->dev,
- "failed to allocate bam transaction\n");
- ret = -ENOMEM;
- goto unalloc;
- }
- } else {
- nandc->chan = dma_request_chan(nandc->dev, "rxtx");
- if (IS_ERR(nandc->chan)) {
- ret = PTR_ERR(nandc->chan);
- nandc->chan = NULL;
- dev_err_probe(nandc->dev, ret,
- "rxtx DMA channel request failed\n");
- return ret;
- }
- }
-
- INIT_LIST_HEAD(&nandc->desc_list);
- INIT_LIST_HEAD(&nandc->host_list);
-
- nand_controller_init(&nandc->controller);
- nandc->controller.ops = &qcom_nandc_ops;
-
- return 0;
-unalloc:
- qcom_nandc_unalloc(nandc);
- return ret;
-}
-
/* one time setup of a few nand controller registers */
static int qcom_nandc_setup(struct qcom_nand_controller *nandc)
{
@@ -3427,6 +2254,9 @@ static int qcom_nandc_probe(struct platform_device *pdev)
if (ret)
goto err_nandc_alloc;

+ nand_controller_init(&nandc->controller);
+ nandc->controller.ops = &qcom_nandc_ops;
+
ret = qcom_nandc_setup(nandc);
if (ret)
goto err_setup;
@@ -3473,28 +2303,28 @@ static void qcom_nandc_remove(struct platform_device *pdev)
DMA_BIDIRECTIONAL, 0);
}

-static const struct qcom_nandc_props ipq806x_nandc_props = {
+static struct qcom_nandc_props ipq806x_nandc_props = {
.ecc_modes = (ECC_RS_4BIT | ECC_BCH_8BIT),
.is_bam = false,
.use_codeword_fixup = true,
.dev_cmd_reg_start = 0x0,
};

-static const struct qcom_nandc_props ipq4019_nandc_props = {
+static struct qcom_nandc_props ipq4019_nandc_props = {
.ecc_modes = (ECC_BCH_4BIT | ECC_BCH_8BIT),
.is_bam = true,
.is_qpic = true,
.dev_cmd_reg_start = 0x0,
};

-static const struct qcom_nandc_props ipq8074_nandc_props = {
+static struct qcom_nandc_props ipq8074_nandc_props = {
.ecc_modes = (ECC_BCH_4BIT | ECC_BCH_8BIT),
.is_bam = true,
.is_qpic = true,
.dev_cmd_reg_start = 0x7000,
};

-static const struct qcom_nandc_props sdx55_nandc_props = {
+static struct qcom_nandc_props sdx55_nandc_props = {
.ecc_modes = (ECC_BCH_4BIT | ECC_BCH_8BIT),
.is_bam = true,
.is_qpic = true,
diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
new file mode 100644
index 000000000000..aced15866627
--- /dev/null
+++ b/include/linux/mtd/nand-qpic-common.h
@@ -0,0 +1,486 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * QCOM QPIC common APIs header file
+ *
+ * Copyright (c) 2023 Qualcomm Inc.
+ * Authors: Md sadre Alam <[email protected]>
+ * Sricharan R <[email protected]>
+ * Varadarajan Narayanan <[email protected]>
+ *
+ */
+#ifndef __MTD_NAND_QPIC_COMMON_H__
+#define __MTD_NAND_QPIC_COMMON_H__
+
+#include <linux/bitops.h>
+#include <linux/clk.h>
+#include <linux/delay.h>
+#include <linux/dmaengine.h>
+#include <linux/dma-mapping.h>
+#include <linux/dma/qcom_adm.h>
+#include <linux/dma/qcom_bam_dma.h>
+#include <linux/module.h>
+#include <linux/mtd/partitions.h>
+#include <linux/mtd/rawnand.h>
+#include <linux/of.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+
+/* NANDc reg offsets */
+#define NAND_FLASH_CMD 0x00
+#define NAND_ADDR0 0x04
+#define NAND_ADDR1 0x08
+#define NAND_FLASH_CHIP_SELECT 0x0c
+#define NAND_EXEC_CMD 0x10
+#define NAND_FLASH_STATUS 0x14
+#define NAND_BUFFER_STATUS 0x18
+#define NAND_DEV0_CFG0 0x20
+#define NAND_DEV0_CFG1 0x24
+#define NAND_DEV0_ECC_CFG 0x28
+#define NAND_AUTO_STATUS_EN 0x2c
+#define NAND_DEV1_CFG0 0x30
+#define NAND_DEV1_CFG1 0x34
+#define NAND_READ_ID 0x40
+#define NAND_READ_STATUS 0x44
+#define NAND_DEV_CMD0 0xa0
+#define NAND_DEV_CMD1 0xa4
+#define NAND_DEV_CMD2 0xa8
+#define NAND_DEV_CMD_VLD 0xac
+#define SFLASHC_BURST_CFG 0xe0
+#define NAND_ERASED_CW_DETECT_CFG 0xe8
+#define NAND_ERASED_CW_DETECT_STATUS 0xec
+#define NAND_EBI2_ECC_BUF_CFG 0xf0
+#define FLASH_BUF_ACC 0x100
+
+#define NAND_CTRL 0xf00
+#define NAND_VERSION 0xf08
+#define NAND_READ_LOCATION_0 0xf20
+#define NAND_READ_LOCATION_1 0xf24
+#define NAND_READ_LOCATION_2 0xf28
+#define NAND_READ_LOCATION_3 0xf2c
+#define NAND_READ_LOCATION_LAST_CW_0 0xf40
+#define NAND_READ_LOCATION_LAST_CW_1 0xf44
+#define NAND_READ_LOCATION_LAST_CW_2 0xf48
+#define NAND_READ_LOCATION_LAST_CW_3 0xf4c
+
+/* dummy register offsets, used by write_reg_dma */
+#define NAND_DEV_CMD1_RESTORE 0xdead
+#define NAND_DEV_CMD_VLD_RESTORE 0xbeef
+
+/* NAND_FLASH_CMD bits */
+#define PAGE_ACC BIT(4)
+#define LAST_PAGE BIT(5)
+
+/* NAND_FLASH_CHIP_SELECT bits */
+#define NAND_DEV_SEL 0
+#define DM_EN BIT(2)
+
+/* NAND_FLASH_STATUS bits */
+#define FS_OP_ERR BIT(4)
+#define FS_READY_BSY_N BIT(5)
+#define FS_MPU_ERR BIT(8)
+#define FS_DEVICE_STS_ERR BIT(16)
+#define FS_DEVICE_WP BIT(23)
+
+/* NAND_BUFFER_STATUS bits */
+#define BS_UNCORRECTABLE_BIT BIT(8)
+#define BS_CORRECTABLE_ERR_MSK 0x1f
+
+/* NAND_DEVn_CFG0 bits */
+#define DISABLE_STATUS_AFTER_WRITE 4
+#define CW_PER_PAGE 6
+#define UD_SIZE_BYTES 9
+#define UD_SIZE_BYTES_MASK GENMASK(18, 9)
+#define ECC_PARITY_SIZE_BYTES_RS 19
+#define SPARE_SIZE_BYTES 23
+#define SPARE_SIZE_BYTES_MASK GENMASK(26, 23)
+#define NUM_ADDR_CYCLES 27
+#define STATUS_BFR_READ 30
+#define SET_RD_MODE_AFTER_STATUS 31
+
+/* NAND_DEVn_CFG0 bits */
+#define DEV0_CFG1_ECC_DISABLE 0
+#define WIDE_FLASH 1
+#define NAND_RECOVERY_CYCLES 2
+#define CS_ACTIVE_BSY 5
+#define BAD_BLOCK_BYTE_NUM 6
+#define BAD_BLOCK_IN_SPARE_AREA 16
+#define WR_RD_BSY_GAP 17
+#define ENABLE_BCH_ECC 27
+
+/* NAND_DEV0_ECC_CFG bits */
+#define ECC_CFG_ECC_DISABLE 0
+#define ECC_SW_RESET 1
+#define ECC_MODE 4
+#define ECC_PARITY_SIZE_BYTES_BCH 8
+#define ECC_NUM_DATA_BYTES 16
+#define ECC_NUM_DATA_BYTES_MASK GENMASK(25, 16)
+#define ECC_FORCE_CLK_OPEN 30
+
+/* NAND_DEV_CMD1 bits */
+#define READ_ADDR 0
+
+/* NAND_DEV_CMD_VLD bits */
+#define READ_START_VLD BIT(0)
+#define READ_STOP_VLD BIT(1)
+#define WRITE_START_VLD BIT(2)
+#define ERASE_START_VLD BIT(3)
+#define SEQ_READ_START_VLD BIT(4)
+
+/* NAND_EBI2_ECC_BUF_CFG bits */
+#define NUM_STEPS 0
+
+/* NAND_ERASED_CW_DETECT_CFG bits */
+#define ERASED_CW_ECC_MASK 1
+#define AUTO_DETECT_RES 0
+#define MASK_ECC BIT(ERASED_CW_ECC_MASK)
+#define RESET_ERASED_DET BIT(AUTO_DETECT_RES)
+#define ACTIVE_ERASED_DET (0 << AUTO_DETECT_RES)
+#define CLR_ERASED_PAGE_DET (RESET_ERASED_DET | MASK_ECC)
+#define SET_ERASED_PAGE_DET (ACTIVE_ERASED_DET | MASK_ECC)
+
+/* NAND_ERASED_CW_DETECT_STATUS bits */
+#define PAGE_ALL_ERASED BIT(7)
+#define CODEWORD_ALL_ERASED BIT(6)
+#define PAGE_ERASED BIT(5)
+#define CODEWORD_ERASED BIT(4)
+#define ERASED_PAGE (PAGE_ALL_ERASED | PAGE_ERASED)
+#define ERASED_CW (CODEWORD_ALL_ERASED | CODEWORD_ERASED)
+
+/* NAND_READ_LOCATION_n bits */
+#define READ_LOCATION_OFFSET 0
+#define READ_LOCATION_SIZE 16
+#define READ_LOCATION_LAST 31
+
+/* Version Mask */
+#define NAND_VERSION_MAJOR_MASK 0xf0000000
+#define NAND_VERSION_MAJOR_SHIFT 28
+#define NAND_VERSION_MINOR_MASK 0x0fff0000
+#define NAND_VERSION_MINOR_SHIFT 16
+
+/* NAND OP_CMDs */
+#define OP_PAGE_READ 0x2
+#define OP_PAGE_READ_WITH_ECC 0x3
+#define OP_PAGE_READ_WITH_ECC_SPARE 0x4
+#define OP_PAGE_READ_ONFI_READ 0x5
+#define OP_PROGRAM_PAGE 0x6
+#define OP_PAGE_PROGRAM_WITH_ECC 0x7
+#define OP_PROGRAM_PAGE_SPARE 0x9
+#define OP_BLOCK_ERASE 0xa
+#define OP_CHECK_STATUS 0xc
+#define OP_FETCH_ID 0xb
+#define OP_RESET_DEVICE 0xd
+
+/* Default Value for NAND_DEV_CMD_VLD */
+#define NAND_DEV_CMD_VLD_VAL (READ_START_VLD | WRITE_START_VLD | \
+ ERASE_START_VLD | SEQ_READ_START_VLD)
+
+/* NAND_CTRL bits */
+#define BAM_MODE_EN BIT(0)
+
+/*
+ * the NAND controller performs reads/writes with ECC in 516 byte chunks.
+ * the driver calls the chunks 'step' or 'codeword' interchangeably
+ */
+#define NANDC_STEP_SIZE 512
+
+/*
+ * the largest page size we support is 8K, this will have 16 steps/codewords
+ * of 512 bytes each
+ */
+#define MAX_NUM_STEPS (SZ_8K / NANDC_STEP_SIZE)
+
+/* we read at most 3 registers per codeword scan */
+#define MAX_REG_RD (3 * MAX_NUM_STEPS)
+
+#define QPIC_PER_CW_CMD_ELEMENTS 32
+#define QPIC_PER_CW_CMD_SGL 32
+#define QPIC_PER_CW_DATA_SGL 8
+
+#define QPIC_NAND_COMPLETION_TIMEOUT msecs_to_jiffies(2000)
+
+/*
+ * Flags used in DMA descriptor preparation helper functions
+ * (i.e. read_reg_dma/write_reg_dma/read_data_dma/write_data_dma)
+ */
+/* Don't set the EOT in current tx BAM sgl */
+#define NAND_BAM_NO_EOT BIT(0)
+/* Set the NWD flag in current BAM sgl */
+#define NAND_BAM_NWD BIT(1)
+/* Finish writing in the current BAM sgl and start writing in another BAM sgl */
+#define NAND_BAM_NEXT_SGL BIT(2)
+
+/*
+ * Returns the actual register address for all NAND_DEV_ registers
+ * (i.e. NAND_DEV_CMD0, NAND_DEV_CMD1, NAND_DEV_CMD2 and NAND_DEV_CMD_VLD)
+ */
+#define dev_cmd_reg_addr(nandc, reg) ((nandc)->props->dev_cmd_reg_start + (reg))
+
+/* Returns the NAND register physical address */
+#define nandc_reg_phys(chip, offset) ((chip)->base_phys + (offset))
+
+/* Returns the dma address for reg read buffer */
+#define reg_buf_dma_addr(chip, vaddr) \
+ ((chip)->reg_read_dma + \
+ ((u8 *)(vaddr) - (u8 *)(chip)->reg_read_buf))
+
+/*
+ * Erased codeword status is being used two times in single transfer so this
+ * flag will determine the current value of erased codeword status register
+ */
+#define NAND_ERASED_CW_SET BIT(4)
+
+#define MAX_ADDRESS_CYCLE 5
+
+/*
+ * This data type corresponds to the BAM transaction which will be used for all
+ * NAND transfers.
+ * @bam_ce - the array of BAM command elements
+ * @cmd_sgl - sgl for NAND BAM command pipe
+ * @data_sgl - sgl for NAND BAM consumer/producer pipe
+ * @last_data_desc - last DMA desc in data channel (tx/rx).
+ * @last_cmd_desc - last DMA desc in command channel.
+ * @txn_done - completion for NAND transfer.
+ * @bam_ce_pos - the index in bam_ce which is available for next sgl
+ * @bam_ce_start - the index in bam_ce which marks the start position ce
+ * for current sgl. It will be used for size calculation
+ * for current sgl
+ * @cmd_sgl_pos - current index in command sgl.
+ * @cmd_sgl_start - start index in command sgl.
+ * @tx_sgl_pos - current index in data sgl for tx.
+ * @tx_sgl_start - start index in data sgl for tx.
+ * @rx_sgl_pos - current index in data sgl for rx.
+ * @rx_sgl_start - start index in data sgl for rx.
+ * @wait_second_completion - wait for second DMA desc completion before making
+ * the NAND transfer completion.
+ */
+struct bam_transaction {
+ struct bam_cmd_element *bam_ce;
+ struct scatterlist *cmd_sgl;
+ struct scatterlist *data_sgl;
+ struct dma_async_tx_descriptor *last_data_desc;
+ struct dma_async_tx_descriptor *last_cmd_desc;
+ struct completion txn_done;
+ u32 bam_ce_pos;
+ u32 bam_ce_start;
+ u32 cmd_sgl_pos;
+ u32 cmd_sgl_start;
+ u32 tx_sgl_pos;
+ u32 tx_sgl_start;
+ u32 rx_sgl_pos;
+ u32 rx_sgl_start;
+ bool wait_second_completion;
+};
+
+/*
+ * This data type corresponds to the nand dma descriptor
+ * @dma_desc - low level DMA engine descriptor
+ * @list - list for desc_info
+ *
+ * @adm_sgl - sgl which will be used for single sgl dma descriptor. Only used by
+ * ADM
+ * @bam_sgl - sgl which will be used for dma descriptor. Only used by BAM
+ * @sgl_cnt - number of SGL in bam_sgl. Only used by BAM
+ * @dir - DMA transfer direction
+ */
+struct desc_info {
+ struct dma_async_tx_descriptor *dma_desc;
+ struct list_head node;
+
+ union {
+ struct scatterlist adm_sgl;
+ struct {
+ struct scatterlist *bam_sgl;
+ int sgl_cnt;
+ };
+ };
+ enum dma_data_direction dir;
+};
+
+/*
+ * holds the current register values that we want to write. acts as a contiguous
+ * chunk of memory which we use to write the controller registers through DMA.
+ */
+struct nandc_regs {
+ __le32 cmd;
+ __le32 addr0;
+ __le32 addr1;
+ __le32 chip_sel;
+ __le32 exec;
+
+ __le32 cfg0;
+ __le32 cfg1;
+ __le32 ecc_bch_cfg;
+
+ __le32 clrflashstatus;
+ __le32 clrreadstatus;
+
+ __le32 cmd1;
+ __le32 vld;
+
+ __le32 orig_cmd1;
+ __le32 orig_vld;
+
+ __le32 ecc_buf_cfg;
+ __le32 read_location0;
+ __le32 read_location1;
+ __le32 read_location2;
+ __le32 read_location3;
+ __le32 read_location_last0;
+ __le32 read_location_last1;
+ __le32 read_location_last2;
+ __le32 read_location_last3;
+
+ __le32 erased_cw_detect_cfg_clr;
+ __le32 erased_cw_detect_cfg_set;
+};
+
+/*
+ * NAND controller data struct
+ *
+ * @dev: parent device
+ *
+ * @base: MMIO base
+ *
+ * @core_clk: controller clock
+ * @aon_clk: another controller clock
+ *
+ * @regs: a contiguous chunk of memory for DMA register
+ * writes. contains the register values to be
+ * written to controller
+ *
+ * @props: properties of current NAND controller,
+ * initialized via DT match data
+ *
+ * @controller: base controller structure
+ * @host_list: list containing all the chips attached to the
+ * controller
+ *
+ * @chan: dma channel
+ * @cmd_crci: ADM DMA CRCI for command flow control
+ * @data_crci: ADM DMA CRCI for data flow control
+ *
+ * @desc_list: DMA descriptor list (list of desc_infos)
+ *
+ * @data_buffer: our local DMA buffer for page read/writes,
+ * used when we can't use the buffer provided
+ * by upper layers directly
+ * @reg_read_buf: local buffer for reading back registers via DMA
+ *
+ * @base_phys: physical base address of controller registers
+ * @base_dma: dma base address of controller registers
+ * @reg_read_dma: contains dma address for register read buffer
+ *
+ * @buf_size/count/start: markers for chip->legacy.read_buf/write_buf
+ * functions
+ * @max_cwperpage: maximum QPIC codewords required. calculated
+ * from all connected NAND devices pagesize
+ *
+ * @reg_read_pos: marker for data read in reg_read_buf
+ *
+ * @cmd1/vld: some fixed controller register values
+ *
+ * @exec_opwrite: flag to select correct number of code word
+ * while reading status
+ */
+struct qcom_nand_controller {
+ struct device *dev;
+
+ void __iomem *base;
+
+ struct clk *core_clk;
+ struct clk *aon_clk;
+
+ struct nandc_regs *regs;
+ struct bam_transaction *bam_txn;
+
+ const struct qcom_nandc_props *props;
+
+ struct nand_controller controller;
+ struct list_head host_list;
+
+ union {
+ /* will be used only by QPIC for BAM DMA */
+ struct {
+ struct dma_chan *tx_chan;
+ struct dma_chan *rx_chan;
+ struct dma_chan *cmd_chan;
+ };
+
+ /* will be used only by EBI2 for ADM DMA */
+ struct {
+ struct dma_chan *chan;
+ unsigned int cmd_crci;
+ unsigned int data_crci;
+ };
+ };
+
+ struct list_head desc_list;
+
+ u8 *data_buffer;
+ __le32 *reg_read_buf;
+
+ phys_addr_t base_phys;
+ dma_addr_t base_dma;
+ dma_addr_t reg_read_dma;
+
+ int buf_size;
+ int buf_count;
+ int buf_start;
+ unsigned int max_cwperpage;
+
+ int reg_read_pos;
+
+ u32 cmd1, vld;
+ bool exec_opwrite;
+};
+
+/*
+ * This data type corresponds to the NAND controller properties which varies
+ * among different NAND controllers.
+ * @ecc_modes - ecc mode for NAND
+ * @dev_cmd_reg_start - NAND_DEV_CMD_* registers starting offset
+ * @is_bam - whether NAND controller is using BAM
+ * @is_qpic - whether NAND CTRL is part of qpic IP
+ * @qpic_v2 - flag to indicate QPIC IP version 2
+ * @use_codeword_fixup - whether NAND has different layout for boot partitions
+ */
+struct qcom_nandc_props {
+ u32 ecc_modes;
+ u32 dev_cmd_reg_start;
+ bool is_bam;
+ bool is_qpic;
+ bool qpic_v2;
+ bool use_codeword_fixup;
+};
+
+void config_nand_page_read(struct nand_chip *chip);
+void qcom_qpic_bam_dma_done(void *data);
+void qcom_nandc_read_buffer_sync(struct qcom_nand_controller *nandc, bool is_cpu);
+__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset);
+int qcom_prep_adm_dma_desc(struct qcom_nand_controller *nandc, bool read,
+ int reg_off, const void *vaddr, int size,
+ bool flow_control);
+int qcom_submit_descs(struct qcom_nand_controller *nandc);
+int qcom_prepare_bam_async_desc(struct qcom_nand_controller *nandc,
+ struct dma_chan *chan, unsigned long flags);
+int qcom_prep_bam_dma_desc_cmd(struct qcom_nand_controller *nandc, bool read,
+ int reg_off, const void *vaddr,
+ int size, unsigned int flags);
+int qcom_prep_bam_dma_desc_data(struct qcom_nand_controller *nandc, bool read,
+ const void *vaddr,
+ int size, unsigned int flags);
+int qcom_read_reg_dma(struct qcom_nand_controller *nandc, int first,
+ int num_regs, unsigned int flags);
+int qcom_write_reg_dma(struct qcom_nand_controller *nandc, int first,
+ int num_regs, unsigned int flags);
+int qcom_read_data_dma(struct qcom_nand_controller *nandc, int reg_off,
+ const u8 *vaddr, int size, unsigned int flags);
+int qcom_write_data_dma(struct qcom_nand_controller *nandc, int reg_off,
+ const u8 *vaddr, int size, unsigned int flags);
+struct bam_transaction *qcom_alloc_bam_transaction(struct qcom_nand_controller *nandc);
+void qcom_clear_bam_transaction(struct qcom_nand_controller *nandc);
+void qcom_nandc_unalloc(struct qcom_nand_controller *nandc);
+int qcom_nandc_alloc(struct qcom_nand_controller *nandc);
+void qcom_clear_read_regs(struct qcom_nand_controller *nandc);
+void qcom_free_bam_transaction(struct qcom_nand_controller *nandc);
+#endif
--
2.34.1


2024-03-08 10:34:25

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH v4 1/5] spi: dt-bindings: Introduce qcom,spi-qpic-snand

On 08/03/2024 10:17, Md Sadre Alam wrote:
> Document the QPIC-SPI-NAND flash controller present in the IPQ SoCs.
> It can work both in serial and parallel mode and supports typical
> SPI-NAND page cache operations.
>
> Signed-off-by: Md Sadre Alam <[email protected]>
> ---
> Change in [v4]
>


Reviewed-by: Krzysztof Kozlowski <[email protected]>

Best regards,
Krzysztof


2024-03-15 12:08:55

by Miquel Raynal

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support

Hi,

[email protected] wrote on Fri, 8 Mar 2024 14:47:50 +0530:

> Add qpic spi nand driver support. The spi nand
> driver currently supported the below commands.
>
> -- RESET
> -- READ ID
> -- SET FEATURE
> -- GET FEATURE
> -- READ PAGE
> -- WRITE PAGE
> -- ERASE PAGE
>
> Co-developed-by: Sricharan Ramabadhran <[email protected]>
> Signed-off-by: Sricharan Ramabadhran <[email protected]>
> Co-developed-by: Varadarajan Narayanan <[email protected]>
> Signed-off-by: Varadarajan Narayanan <[email protected]>
> Signed-off-by: Md Sadre Alam <[email protected]>

I don't like the "spi nand driver" wording here. It is a spi
controller, for spi-memories.

Plus, I'd expect some kind of check to see whether you support the
requested operation, I don't see any in the code.


> ---
> Change in [v4]
>
> * No change
>
> Change in [v3]
>
> * Set SPI_QPIC_SNAND to n and added COMPILE_TEST in Kconfig
>
> * Made driver name sorted in Make file
>
> * Made comment like c++
>
> * Changed macro to functions, snandc_set_read_loc_last()
> and snandc_set_read_loc_first()
>
> * Added error handling in snandc_set_reg()
>
> * Changed into normal conditional statement for
> return snandc->ecc_stats.failed ? -EBADMSG :
> snandc->ecc_stats.bitflips;
>
> * Remove cast of wbuf in qpic_snand_program_execute()
> function
>
> * Made num_cw variable instead hardcoded value
>
> * changed if..else condition of function qpic_snand_io_op()
> to switch..case statement
>
> * Added __devm_spi_alloc_controller() api instead of
> devm_spi_alloc_master()
>
> * Disabling clock in remove path
>
> Change in [v2]
>
> * Added initial support for SPI-NAND driver
>
> Change in [v1]
>
> * Added RFC patch for design review
>
> drivers/mtd/nand/qpic_common.c | 8 +
> drivers/spi/Kconfig | 8 +
> drivers/spi/Makefile | 1 +
> drivers/spi/spi-qpic-snand.c | 1041 ++++++++++++++++++++++++++
> include/linux/mtd/nand-qpic-common.h | 61 ++
> 5 files changed, 1119 insertions(+)
> create mode 100644 drivers/spi/spi-qpic-snand.c
>
> diff --git a/drivers/mtd/nand/qpic_common.c b/drivers/mtd/nand/qpic_common.c
> index 5b7c0d119d9a..67ccb3d05f20 100644
> --- a/drivers/mtd/nand/qpic_common.c
> +++ b/drivers/mtd/nand/qpic_common.c
> @@ -134,6 +134,14 @@ __le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
> return &regs->read_location_last2;
> case NAND_READ_LOCATION_LAST_CW_3:
> return &regs->read_location_last3;
> + case NAND_FLASH_SPI_CFG:
> + return &regs->spi_cfg;
> + case NAND_NUM_ADDR_CYCLES:
> + return &regs->num_addr_cycle;
> + case NAND_BUSY_CHECK_WAIT_CNT:
> + return &regs->busy_wait_cnt;
> + case NAND_FLASH_FEATURES:
> + return &regs->flash_feature;

I am still not convinced about these. I don't understand who you have
this indirection.

> default:
> return NULL;
> }
> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
> index bc7021da2fe9..63764e943d82 100644
> --- a/drivers/spi/Kconfig
> +++ b/drivers/spi/Kconfig
> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
> help
> QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>
> +config SPI_QPIC_SNAND
> + tristate "QPIC SNAND controller"
> + depends on ARCH_QCOM || COMPILE_TEST
> + help
> + QPIC_SNAND (QPIC SPI NAND) driver for Qualcomm QPIC controller.
> + QPIC controller supports both parallel nand and serial nand.
> + This config will enable serial nand driver for QPIC controller.
> +
> config SPI_QUP
> tristate "Qualcomm SPI controller with QUP interface"
> depends on ARCH_QCOM || COMPILE_TEST
> diff --git a/drivers/spi/Makefile b/drivers/spi/Makefile
> index 4ff8d725ba5e..9015368f8c73 100644
> --- a/drivers/spi/Makefile
> +++ b/drivers/spi/Makefile
> @@ -111,6 +111,7 @@ obj-$(CONFIG_SPI_PXA2XX) += spi-pxa2xx-platform.o
> obj-$(CONFIG_SPI_PXA2XX_PCI) += spi-pxa2xx-pci.o
> obj-$(CONFIG_SPI_QCOM_GENI) += spi-geni-qcom.o
> obj-$(CONFIG_SPI_QCOM_QSPI) += spi-qcom-qspi.o
> +obj-$(CONFIG_SPI_QPIC_SNAND) += spi-qpic-snand.o
> obj-$(CONFIG_SPI_QUP) += spi-qup.o
> obj-$(CONFIG_SPI_ROCKCHIP) += spi-rockchip.o
> obj-$(CONFIG_SPI_ROCKCHIP_SFC) += spi-rockchip-sfc.o
> diff --git a/drivers/spi/spi-qpic-snand.c b/drivers/spi/spi-qpic-snand.c
> new file mode 100644
> index 000000000000..df7d5d8d4db2
> --- /dev/null
> +++ b/drivers/spi/spi-qpic-snand.c
> @@ -0,0 +1,1041 @@
> +/*
> + * SPDX-License-Identifier: GPL-2.0
> + *
> + * Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved.
> + *
> + * Authors:
> + * Md Sadre Alam <[email protected]>
> + * Sricharan R <[email protected]>
> + * Varadarajan Narayanan <[email protected]>
> + */
> +
> +#include <linux/mtd/spinand.h>
> +#include <linux/mtd/nand-qpic-common.h>
> +
> +/* QSPI NAND config reg bits */
> +#define LOAD_CLK_CNTR_INIT_EN BIT(28)
> +#define CLK_CNTR_INIT_VAL_VEC 0x924
> +#define FEA_STATUS_DEV_ADDR 0xc0
> +#define SPI_CFG BIT(0)
> +#define SPI_NUM_ADDR 0xDA4DB
> +#define SPI_WAIT_CNT 0x10
> +#define QPIC_QSPI_NUM_CS 1
> +#define SPI_TRANSFER_MODE_x1 BIT(29)
> +#define SPI_TRANSFER_MODE_x4 (3 << 29)
> +#define SPI_WP BIT(28)
> +#define SPI_HOLD BIT(27)
> +#define QPIC_SET_FEATURE BIT(31)
> +
> +#define SPINAND_RESET 0xff
> +#define SPINAND_READID 0x9f
> +#define SPINAND_GET_FEATURE 0x0f
> +#define SPINAND_SET_FEATURE 0x1f
> +#define SPINAND_READ 0x13
> +#define SPINAND_ERASE 0xd8
> +#define SPINAND_WRITE_EN 0x06
> +#define SPINAND_PROGRAM_EXECUTE 0x10
> +#define SPINAND_PROGRAM_LOAD 0x84
> +
> +struct qpic_snand_op {
> + u32 cmd_reg;
> + u32 addr1_reg;
> + u32 addr2_reg;
> +};
> +
> +struct snandc_read_status {
> + __le32 snandc_flash;
> + __le32 snandc_buffer;
> + __le32 snandc_erased_cw;
> +};
> +
> +static void snandc_set_reg(struct qcom_nand_controller *snandc, int offset, u32 val)

qcom_spi_ would be a better prefix maybe?

> +{
> + struct nandc_regs *regs = snandc->regs;
> + __le32 *reg;
> +
> + reg = qcom_offset_to_nandc_reg(regs, offset);
> +
> + if (reg)
> + *reg = cpu_to_le32(val);
> +
> + if (WARN_ON(!reg))
> + return;

This whole logic really seems suboptimal.

> +}
> +
> +static void snandc_set_read_loc_first(struct qcom_nand_controller *snandc,
> + int reg, int cw_offset, int read_size,
> + int is_last_read_loc)
> +{
> + snandc_set_reg(snandc, reg, ((cw_offset) << READ_LOCATION_OFFSET) |
> + ((read_size) << READ_LOCATION_SIZE) | ((is_last_read_loc)
> + << READ_LOCATION_LAST));

FIELD_GET, FIELD_PREP ?

> +}
> +
> +static void snandc_set_read_loc_last(struct qcom_nand_controller *snandc,
> + int reg, int cw_offset, int read_size,
> + int is_last_read_loc)
> +{
> + snandc_set_reg(snandc, reg, ((cw_offset) << READ_LOCATION_OFFSET) |
> + ((read_size) << READ_LOCATION_SIZE) | ((is_last_read_loc)
> + << READ_LOCATION_LAST));
> +}
> +
> +static struct qcom_nand_controller *nand_to_qcom_snand(struct nand_device *nand)
> +{
> + struct nand_ecc_engine *eng = nand->ecc.engine;
> +
> + return container_of(eng, struct qcom_nand_controller, ecc_eng);
> +}
> +
> +static int qcom_snand_init(struct qcom_nand_controller *snandc)
> +{
> + u32 snand_cfg_val = 0x0;
> + int ret;
> +
> + snand_cfg_val |= (LOAD_CLK_CNTR_INIT_EN | (CLK_CNTR_INIT_VAL_VEC << 16)
> + | (FEA_STATUS_DEV_ADDR << 8) | SPI_CFG);

^
the | should be on the previous line.

> +
> + snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, 0);
> + snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, snand_cfg_val);
> + snandc_set_reg(snandc, NAND_NUM_ADDR_CYCLES, SPI_NUM_ADDR);
> + snandc_set_reg(snandc, NAND_BUSY_CHECK_WAIT_CNT, SPI_WAIT_CNT);
> +
> + qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
> + qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
> +
> + snand_cfg_val &= ~LOAD_CLK_CNTR_INIT_EN;
> + snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, snand_cfg_val);
> +
> + qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
> +
> + qcom_write_reg_dma(snandc, NAND_NUM_ADDR_CYCLES, 1, 0);
> + qcom_write_reg_dma(snandc, NAND_BUSY_CHECK_WAIT_CNT, 1, NAND_BAM_NEXT_SGL);
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret)
> + dev_err(snandc->dev, "failure in sbumitting spiinit descriptor\n");

Typos...

> +
> + return 0;

return ret ?

> +}
> +
> +static int qcom_snand_ooblayout_ecc(struct mtd_info *mtd, int section,
> + struct mtd_oob_region *oobregion)
> +{
> + struct nand_device *nand = mtd_to_nanddev(mtd);
> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
> + struct qpic_ecc *qecc = snandc->ecc;
> +
> + if (section > 1)
> + return -ERANGE;
> +
> + if (!section) {
> + oobregion->length = (qecc->bytes * (qecc->steps - 1)) + qecc->bbm_size;
> + oobregion->offset = 0;

No BBM?

> + } else {
> + oobregion->length = qecc->ecc_bytes_hw + qecc->spare_bytes;
> + oobregion->offset = mtd->oobsize - oobregion->length;
> + }
> +
> + return 0;
> +}
> +
> +static int qcom_snand_ooblayout_free(struct mtd_info *mtd, int section,
> + struct mtd_oob_region *oobregion)
> +{
> + struct nand_device *nand = mtd_to_nanddev(mtd);
> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
> + struct qpic_ecc *qecc = snandc->ecc;
> +
> + if (section)
> + return -ERANGE;
> +
> + oobregion->length = qecc->steps * 4;
> + oobregion->offset = ((qecc->steps - 1) * qecc->bytes) + qecc->bbm_size;
> +

Using the same order would be easier to compare with the above version

> + return 0;
> +}
> +
> +static const struct mtd_ooblayout_ops qcom_snand_ooblayout = {
> + .ecc = qcom_snand_ooblayout_ecc,
> + .free = qcom_snand_ooblayout_free,
> +};
> +
> +static int qpic_snand_ecc_init_ctx_pipelined(struct nand_device *nand)
> +{
> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
> + struct nand_ecc_props *conf = &nand->ecc.ctx.conf;
> + struct nand_ecc_props *reqs = &nand->ecc.requirements;
> + struct nand_ecc_props *user = &nand->ecc.user_conf;
> + struct mtd_info *mtd = nanddev_to_mtd(nand);
> + int step_size = 0, strength = 0, steps;
> + int cwperpage, bad_block_byte;
> + struct qpic_ecc *ecc_cfg;
> +
> + cwperpage = mtd->writesize / NANDC_STEP_SIZE;
> + snandc->num_cw = cwperpage;
> +
> + ecc_cfg = kzalloc(sizeof(*ecc_cfg), GFP_KERNEL);
> + if (!ecc_cfg)
> + return -ENOMEM;
> +
> + nand->ecc.ctx.priv = ecc_cfg;
> +
> + if (user->step_size && user->strength) {
> + step_size = user->step_size;
> + strength = user->strength;
> + } else if (reqs->step_size && reqs->strength) {
> + step_size = reqs->step_size;
> + strength = reqs->strength;
> + }
> +
> + if (step_size && strength)
> + steps = mtd->writesize / step_size;
> +
> + ecc_cfg->ecc_bytes_hw = 7;
> + ecc_cfg->spare_bytes = 4;
> + ecc_cfg->bbm_size = 1;
> + ecc_cfg->bch_enabled = true;
> + ecc_cfg->bytes = ecc_cfg->ecc_bytes_hw + ecc_cfg->spare_bytes + ecc_cfg->bbm_size;
> +
> + ecc_cfg->steps = 4;
> + ecc_cfg->strength = 4;
> + ecc_cfg->step_size = 512;
> +
> + mtd_set_ooblayout(mtd, &qcom_snand_ooblayout);
> +
> + ecc_cfg->cw_data = 516;
> + ecc_cfg->cw_size = ecc_cfg->cw_data + ecc_cfg->bytes;
> + bad_block_byte = mtd->writesize - ecc_cfg->cw_size * (cwperpage - 1) + 1;
> +
> + ecc_cfg->cfg0 = (cwperpage - 1) << CW_PER_PAGE
> + | ecc_cfg->cw_data << UD_SIZE_BYTES
> + | 1 << DISABLE_STATUS_AFTER_WRITE
> + | 3 << NUM_ADDR_CYCLES
> + | ecc_cfg->ecc_bytes_hw << ECC_PARITY_SIZE_BYTES_RS
> + | 0 << STATUS_BFR_READ
> + | 1 << SET_RD_MODE_AFTER_STATUS
> + | ecc_cfg->spare_bytes << SPARE_SIZE_BYTES;
> +
> + ecc_cfg->cfg1 = 0 << NAND_RECOVERY_CYCLES
> + | 0 << CS_ACTIVE_BSY
> + | bad_block_byte << BAD_BLOCK_BYTE_NUM
> + | 0 << BAD_BLOCK_IN_SPARE_AREA
> + | 20 << WR_RD_BSY_GAP
> + | 0 << WIDE_FLASH
> + | ecc_cfg->bch_enabled << ENABLE_BCH_ECC;
> +
> + ecc_cfg->cfg0_raw = (cwperpage - 1) << CW_PER_PAGE
> + | ecc_cfg->cw_size << UD_SIZE_BYTES
> + | 3 << NUM_ADDR_CYCLES
> + | 0 << SPARE_SIZE_BYTES;
> +
> + ecc_cfg->cfg1_raw = 0 << NAND_RECOVERY_CYCLES
> + | 0 << CS_ACTIVE_BSY
> + | 17 << BAD_BLOCK_BYTE_NUM
> + | 1 << BAD_BLOCK_IN_SPARE_AREA
> + | 20 << WR_RD_BSY_GAP
> + | 0 << WIDE_FLASH
> + | 1 << DEV0_CFG1_ECC_DISABLE;
> +
> + ecc_cfg->ecc_bch_cfg = !ecc_cfg->bch_enabled << ECC_CFG_ECC_DISABLE
> + | 0 << ECC_SW_RESET
> + | ecc_cfg->cw_data << ECC_NUM_DATA_BYTES
> + | 1 << ECC_FORCE_CLK_OPEN
> + | 0 << ECC_MODE
> + | ecc_cfg->ecc_bytes_hw << ECC_PARITY_SIZE_BYTES_BCH;
> +
> + ecc_cfg->ecc_buf_cfg = 0x203 << NUM_STEPS;
> + ecc_cfg->clrflashstatus = FS_READY_BSY_N;
> + ecc_cfg->clrreadstatus = 0xc0;
> +
> + conf->step_size = ecc_cfg->step_size;
> + conf->strength = ecc_cfg->strength;
> +
> + if (ecc_cfg->strength < strength)
> + dev_warn(snandc->dev, "Unable to fulfill ECC requirements of %u bits.\n", strength);

Not needed I guess. Somewhat redundant with the core?

> +
> + dev_info(snandc->dev, "ECC strength: %u bits per %u bytes\n",
> + ecc_cfg->strength, ecc_cfg->step_size);

Debug?

> +
> + return 0;
> +}
> +
> +static void qpic_snand_ecc_cleanup_ctx_pipelined(struct nand_device *nand)
> +{
> + struct qpic_ecc *ecc_cfg = nand_to_ecc_ctx(nand);
> +
> + kfree(ecc_cfg);
> +}
> +
> +static int qpic_snand_ecc_prepare_io_req_pipelined(struct nand_device *nand,
> + struct nand_page_io_req *req)
> +{
> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
> + struct qpic_ecc *ecc_cfg = nand_to_ecc_ctx(nand);
> +
> + snandc->ecc = ecc_cfg;
> + snandc->raw = false;
> + snandc->oob_read = false;
> +
> + if (req->mode == MTD_OPS_RAW) {
> + if (req->ooblen)
> + snandc->oob_read = true;
> + snandc->raw = true;
> + }
> +
> + return 0;
> +}
> +
> +static int qpic_snand_ecc_finish_io_req_pipelined(struct nand_device *nand,
> + struct nand_page_io_req *req)
> +{
> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
> + struct mtd_info *mtd = nanddev_to_mtd(nand);
> +
> + if (req->mode == MTD_OPS_RAW || req->type != NAND_PAGE_READ)
> + return 0;
> +
> + if (snandc->ecc_stats.failed)
> + mtd->ecc_stats.failed += snandc->ecc_stats.failed;
> + mtd->ecc_stats.corrected += snandc->ecc_stats.corrected;
> +
> + if (snandc->ecc_stats.failed)

I hope you reset this counter at some point.

Did you run nandbiterrs -i ?

> + return -EBADMSG;
> + else
> + return snandc->ecc_stats.bitflips;
> +}
> +
> +static struct nand_ecc_engine_ops qcom_snand_ecc_engine_ops_pipelined = {
> + .init_ctx = qpic_snand_ecc_init_ctx_pipelined,
> + .cleanup_ctx = qpic_snand_ecc_cleanup_ctx_pipelined,
> + .prepare_io_req = qpic_snand_ecc_prepare_io_req_pipelined,
> + .finish_io_req = qpic_snand_ecc_finish_io_req_pipelined,
> +};
> +
> +/* helper to configure location register values */
> +static void snandc_set_read_loc(struct qcom_nand_controller *snandc, int cw, int reg,
> + int cw_offset, int read_size, int is_last_read_loc)
> +{
> + int reg_base = NAND_READ_LOCATION_0;
> +
> + if (cw == 3)
> + reg_base = NAND_READ_LOCATION_LAST_CW_0;
> +
> + reg_base += reg * 4;
> +
> + if (cw == 3)
> + return snandc_set_read_loc_last(snandc, reg_base, cw_offset,
> + read_size, is_last_read_loc);

Alignments are still wrong, again.

> + else
> + return snandc_set_read_loc_first(snandc, reg_base, cw_offset,
> + read_size, is_last_read_loc);
> +}
> +
> +static void
> +snandc_config_cw_read(struct qcom_nand_controller *snandc, bool use_ecc, int cw)
> +{
> + int reg = NAND_READ_LOCATION_0;
> +
> + if (cw == 3)
> + reg = NAND_READ_LOCATION_LAST_CW_0;
> +
> + if (snandc->props->is_bam)
> + qcom_write_reg_dma(snandc, reg, 4, NAND_BAM_NEXT_SGL);
> +
> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
> +
> + qcom_read_reg_dma(snandc, NAND_FLASH_STATUS, 2, 0);
> + qcom_read_reg_dma(snandc, NAND_ERASED_CW_DETECT_STATUS, 1,
> + NAND_BAM_NEXT_SGL);
> +}
> +
> +static int qpic_snand_block_erase(struct qcom_nand_controller *snandc)
> +{
> + struct qpic_ecc *ecc_cfg = snandc->ecc;
> + int ret;
> +
> + snandc->buf_count = 0;
> + snandc->buf_start = 0;
> + qcom_clear_read_regs(snandc);
> + qcom_clear_bam_transaction(snandc);
> +
> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
> + snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
> + snandc_set_reg(snandc, NAND_DEV0_CFG0, ecc_cfg->cfg0_raw & ~(7 << CW_PER_PAGE));
> + snandc_set_reg(snandc, NAND_DEV0_CFG1, ecc_cfg->cfg1_raw);
> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
> +
> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 3, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 2, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret) {
> + dev_err(snandc->dev, "failure to erase block\n");
> + return ret;
> + }
> +
> + return 0;
> +}
> +
> +static void config_snand_single_cw_page_read(struct qcom_nand_controller *snandc,
> + bool use_ecc, int cw)
> +{
> + int reg;
> +
> + qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1,
> + NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
> +
> + reg = NAND_READ_LOCATION_0;
> + if (cw == 3)

This is hardcoded everywhere, I am not a big fan.

> + reg = NAND_READ_LOCATION_LAST_CW_0;
> + qcom_write_reg_dma(snandc, reg, 4, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
> +
> + qcom_read_reg_dma(snandc, NAND_FLASH_STATUS, 2, 0);
> + qcom_read_reg_dma(snandc, NAND_ERASED_CW_DETECT_STATUS, 1, NAND_BAM_NEXT_SGL);
> +}
> +
> +static int qpic_snand_read_oob(struct qcom_nand_controller *snandc,
> + const struct spi_mem_op *op)
> +{
> + struct qpic_ecc *ecc_cfg = snandc->ecc;
> + int size, ret;
> + int col, bbpos;
> + u32 cfg0, cfg1, ecc_bch_cfg;
> + u32 num_cw = snandc->num_cw;
> +
> + qcom_clear_bam_transaction(snandc);
> + qcom_clear_read_regs(snandc);
> +
> + size = ecc_cfg->cw_size;
> + col = ecc_cfg->cw_size * (num_cw - 1);
> +
> + /* prepare a clean read buffer */
> + memset(snandc->data_buffer, 0xff, size);
> + snandc_set_reg(snandc, NAND_ADDR0, (snandc->addr1 | col));
> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
> +
> + cfg0 = (ecc_cfg->cfg0_raw & ~(7U << CW_PER_PAGE)) |
> + 0 << CW_PER_PAGE;
> + cfg1 = ecc_cfg->cfg1_raw;
> + ecc_bch_cfg = 1 << ECC_CFG_ECC_DISABLE;
> +
> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
> + snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
> + snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
> + snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
> +
> + config_snand_single_cw_page_read(snandc, false, num_cw - 1);
> +
> + qcom_read_data_dma(snandc, FLASH_BUF_ACC, snandc->data_buffer, size, 0);
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret)
> + dev_err(snandc->dev, "failed to read oob\n");

Why don't you return here?

> +
> + qcom_nandc_read_buffer_sync(snandc, true);
> + u32 flash = le32_to_cpu(snandc->reg_read_buf[0]);

No compiler warning here?

> +
> + if (flash & (FS_OP_ERR | FS_MPU_ERR))
> + return -EIO;
> +
> + bbpos = 2048 - ecc_cfg->cw_size * (num_cw - 1);

Why is this size hardcoded?! That cannot work!

> + memcpy(op->data.buf.in, snandc->data_buffer + bbpos, op->data.nbytes);
> +
> + return ret;
> +}
> +
> +static int snandc_check_error(struct qcom_nand_controller *snandc)
> +{
> + struct snandc_read_status *buf;
> + int i, num_cw = snandc->num_cw;
> + bool serial_op_err = false, erased;
> +
> + qcom_nandc_read_buffer_sync(snandc, true);
> + buf = (struct snandc_read_status *)snandc->reg_read_buf;
> +
> + for (i = 0; i < num_cw; i++, buf++) {
> + u32 flash, buffer, erased_cw;
> +
> + flash = le32_to_cpu(buf->snandc_flash);
> + buffer = le32_to_cpu(buf->snandc_buffer);
> + erased_cw = le32_to_cpu(buf->snandc_erased_cw);
> +
> + if ((flash & FS_OP_ERR) && (buffer & BS_UNCORRECTABLE_BIT)) {
> + erased = (erased_cw & ERASED_CW) == ERASED_CW ?
> + true : false;

This ternary operation is useless

> + } else if (flash & (FS_OP_ERR | FS_MPU_ERR)) {
> + serial_op_err = true;
> + }
> + }
> +
> + if (serial_op_err)
> + return -EIO;
> +
> + return 0;
> +}
> +
> +static int qpic_snand_read_page_cache(struct qcom_nand_controller *snandc,
> + const struct spi_mem_op *op)
> +{
> + struct qpic_ecc *ecc_cfg = snandc->ecc;
> + u8 *data_buf;
> + int ret, i;
> + u32 cfg0, cfg1, ecc_bch_cfg, num_cw = snandc->num_cw;
> +
> + data_buf = op->data.buf.in;
> +
> + if (snandc->oob_read) {
> + return qpic_snand_read_oob(snandc, op);
> + snandc->oob_read = false;
> + }
> +
> + snandc->buf_count = 0;
> + snandc->buf_start = 0;
> + qcom_clear_read_regs(snandc);
> +
> + cfg0 = (ecc_cfg->cfg0 & ~(7U << CW_PER_PAGE)) |
> + (num_cw - 1) << CW_PER_PAGE;
> + cfg1 = ecc_cfg->cfg1;
> + ecc_bch_cfg = ecc_cfg->ecc_bch_cfg;
> +
> + snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
> + snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
> + snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
> + snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
> + snandc_set_reg(snandc, NAND_FLASH_STATUS, ecc_cfg->clrflashstatus);
> + snandc_set_reg(snandc, NAND_READ_STATUS, ecc_cfg->clrreadstatus);
> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
> + snandc_set_read_loc(snandc, 0, 0, 0, ecc_cfg->cw_data, 1);
> +
> + qcom_clear_bam_transaction(snandc);
> +
> + qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1,
> + NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
> +
> + for (i = 0; i < num_cw; i++) {
> + int data_size;
> +
> + if (i == (num_cw - 1))
> + data_size = 512 - ((num_cw - 1) << 2);
> + else
> + data_size = ecc_cfg->cw_data;
> +
> + if (data_buf)
> + snandc_set_read_loc(snandc, i, 0, 0, data_size, 1);
> +
> + snandc_config_cw_read(snandc, true, i);
> +
> + if (data_buf)
> + qcom_read_data_dma(snandc, FLASH_BUF_ACC, data_buf,
> + data_size, 0);
> +
> + if (data_buf)
> + data_buf += data_size;
> + }
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret) {
> + dev_err(snandc->dev, "failure to read page/oob\n");
> + return ret;
> + }
> +
> + return snandc_check_error(snandc);
> +}
> +
> +static void config_snand_page_write(struct qcom_nand_controller *snandc)
> +{
> + qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
> + qcom_write_reg_dma(snandc, NAND_EBI2_ECC_BUF_CFG, 1, NAND_BAM_NEXT_SGL);
> +}
> +
> +static void config_snand_cw_write(struct qcom_nand_controller *snandc)
> +{
> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
> +}
> +
> +static int qpic_snand_program_execute(struct qcom_nand_controller *snandc,
> + const struct spi_mem_op *op)
> +{
> + struct qpic_ecc *ecc_cfg = snandc->ecc;
> + u8 *data_buf;
> + int i, ret;
> + int num_cw = snandc->num_cw;
> + u32 cfg0, cfg1, ecc_bch_cfg, ecc_buf_cfg;
> +
> + cfg0 = (ecc_cfg->cfg0 & ~(7U << CW_PER_PAGE)) |
> + (num_cw - 1) << CW_PER_PAGE;
> + cfg1 = ecc_cfg->cfg1;
> + ecc_bch_cfg = ecc_cfg->ecc_bch_cfg;
> + ecc_buf_cfg = ecc_cfg->ecc_buf_cfg;
> +
> + data_buf = snandc->wbuf;
> +
> + snandc->buf_count = 0;
> + snandc->buf_start = 0;
> + qcom_clear_read_regs(snandc);
> + qcom_clear_bam_transaction(snandc);
> +
> + snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
> +
> + snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
> + snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
> + snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
> +
> + snandc_set_reg(snandc, NAND_EBI2_ECC_BUF_CFG, ecc_buf_cfg);
> +
> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
> +
> + config_snand_page_write(snandc);
> +
> + for (i = 0; i < num_cw; i++) {
> + int data_size;
> +
> + if (i == (num_cw - 1))
> + data_size = NANDC_STEP_SIZE - ((num_cw - 1) << 2);
> + else
> + data_size = ecc_cfg->cw_data;
> +
> + qcom_write_data_dma(snandc, FLASH_BUF_ACC, data_buf, data_size,
> + i == (num_cw - 1) ? NAND_BAM_NO_EOT : 0);
> +
> + config_snand_cw_write(snandc);
> + if (data_buf)
> + data_buf += data_size;
> + }
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret) {
> + dev_err(snandc->dev, "failure to write page\n");
> + return ret;
> + }
> +
> + return 0;
> +}
> +
> +static u32 qpic_snand_cmd_mapping(struct qcom_nand_controller *snandc, u32 opcode)
> +{
> + u32 cmd = 0x0;
> +
> + switch (opcode) {
> + case SPINAND_RESET:
> + cmd = (SPI_WP | SPI_HOLD | SPI_TRANSFER_MODE_x1 | OP_RESET_DEVICE);
> + break;
> + case SPINAND_READID:
> + cmd = (SPI_WP | SPI_HOLD | SPI_TRANSFER_MODE_x1 | OP_FETCH_ID);
> + break;
> + case SPINAND_GET_FEATURE:
> + cmd = (SPI_TRANSFER_MODE_x1 | SPI_WP | SPI_HOLD | ACC_FEATURE);
> + break;
> + case SPINAND_SET_FEATURE:
> + cmd = (SPI_TRANSFER_MODE_x1 | SPI_WP | SPI_HOLD | ACC_FEATURE |
> + QPIC_SET_FEATURE);
> + break;
> + case SPINAND_READ:
> + if (snandc->raw)
> + cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
> + SPI_WP | SPI_HOLD | OP_PAGE_READ);
> + else
> + cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
> + SPI_WP | SPI_HOLD | OP_PAGE_READ_WITH_ECC);
> + break;
> + case SPINAND_ERASE:
> + cmd = OP_BLOCK_ERASE | PAGE_ACC | LAST_PAGE | SPI_WP |
> + SPI_HOLD | SPI_TRANSFER_MODE_x1;
> + break;
> + case SPINAND_WRITE_EN:
> + cmd = SPINAND_WRITE_EN;
> + break;
> + case SPINAND_PROGRAM_EXECUTE:
> + cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
> + SPI_WP | SPI_HOLD | OP_PROGRAM_PAGE);
> + break;
> + case SPINAND_PROGRAM_LOAD:
> + cmd = SPINAND_PROGRAM_LOAD;
> + break;
> + default:
> + break;

No, no, no and no again. You've been sending NAND contributions for
years, and you still continue to assume all the commands are defined
and we will never check for supported ops. Please.

> + }
> +
> + return cmd;
> +}
> +
> +static int qpic_snand_write_page_cache(struct qcom_nand_controller *snandc,
> + const struct spi_mem_op *op)
> +{
> + struct qpic_snand_op s_op = {};
> + u32 cmd;
> +
> + cmd = qpic_snand_cmd_mapping(snandc, op->cmd.opcode);
> + s_op.cmd_reg = cmd;
> +
> + if (op->cmd.opcode == SPINAND_PROGRAM_LOAD) {
> + snandc->wbuf = (u8 *)op->data.buf.out;
> + snandc->wlen = op->data.nbytes;
> + }
> +
> + return 0;
> +}
> +
> +static int qpic_snand_send_cmdaddr(struct qcom_nand_controller *snandc,
> + const struct spi_mem_op *op)
> +{
> + struct qpic_snand_op s_op = {};
> + u32 cmd;
> + int ret;
> +
> + cmd = qpic_snand_cmd_mapping(snandc, op->cmd.opcode);
> +
> + s_op.cmd_reg = cmd;
> + s_op.addr1_reg = op->addr.val;
> + s_op.addr2_reg = 0;
> +
Would a switch case be more appropriate?

> + if (op->cmd.opcode == SPINAND_WRITE_EN)
> + return 0;
> +
> + if (op->cmd.opcode == SPINAND_PROGRAM_EXECUTE) {
> + s_op.addr1_reg = op->addr.val << 16;
> + s_op.addr2_reg = op->addr.val >> 16 & 0xff;
> + snandc->addr1 = s_op.addr1_reg;
> + snandc->addr2 = s_op.addr2_reg;
> + snandc->cmd = cmd;
> + return qpic_snand_program_execute(snandc, op);
> + }
> +
> + if (op->cmd.opcode == SPINAND_READ) {
> + s_op.addr1_reg = (op->addr.val << 16);
> + s_op.addr2_reg = op->addr.val >> 16 & 0xff;
> + snandc->addr1 = s_op.addr1_reg;
> + snandc->addr2 = s_op.addr2_reg;
> + snandc->cmd = cmd;
> + return 0;
> + }
> +
> + if (op->cmd.opcode == SPINAND_ERASE) {
> + s_op.addr2_reg = (op->addr.val >> 16) & 0xffff;
> + s_op.addr1_reg = op->addr.val;
> + snandc->addr1 = s_op.addr1_reg;
> + snandc->addr1 <<= 16;
> + snandc->addr2 = s_op.addr2_reg;
> + snandc->cmd = cmd;
> + qpic_snand_block_erase(snandc);
> + return 0;
> + }
> +
> + snandc->buf_count = 0;
> + snandc->buf_start = 0;
> + qcom_clear_read_regs(snandc);
> + qcom_clear_bam_transaction(snandc);
> +
> + snandc_set_reg(snandc, NAND_FLASH_CMD, s_op.cmd_reg);
> + snandc_set_reg(snandc, NAND_EXEC_CMD, 0x1);
> + snandc_set_reg(snandc, NAND_ADDR0, s_op.addr1_reg);
> + snandc_set_reg(snandc, NAND_ADDR1, s_op.addr2_reg);
> +
> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 3, NAND_BAM_NEXT_SGL);
> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret)
> + dev_err(snandc->dev, "failure in sbumitting cmd descriptor\n");
> +
> + return ret;
> +}
> +
> +static int qpic_snand_io_op(struct qcom_nand_controller *snandc, const struct spi_mem_op *op)
> +{
> + int ret, val, opcode;
> + bool copy = false, copy_ftr = false;
> +
> + ret = qpic_snand_send_cmdaddr(snandc, op);
> + if (ret)
> + return ret;
> +
> + snandc->buf_count = 0;
> + snandc->buf_start = 0;
> + qcom_clear_read_regs(snandc);
> + qcom_clear_bam_transaction(snandc);
> + opcode = op->cmd.opcode;
> +
> + switch (opcode) {
> + case SPINAND_READID:
> + snandc->buf_count = 4;
> + qcom_read_reg_dma(snandc, NAND_READ_ID, 1, NAND_BAM_NEXT_SGL);
> + copy = true;
> + break;
> + case SPINAND_GET_FEATURE:
> + snandc->buf_count = 4;
> + qcom_read_reg_dma(snandc, NAND_FLASH_FEATURES, 1, NAND_BAM_NEXT_SGL);
> + copy_ftr = true;
> + break;
> + case SPINAND_SET_FEATURE:
> + snandc_set_reg(snandc, NAND_FLASH_FEATURES, *(u32 *)op->data.buf.out);
> + qcom_write_reg_dma(snandc, NAND_FLASH_FEATURES, 1, NAND_BAM_NEXT_SGL);
> + break;
> + default:
> + return 0;
> + }
> +
> + ret = qcom_submit_descs(snandc);
> + if (ret)
> + dev_err(snandc->dev, "failure in submitting descriptor for:%d\n", opcode);
> +
> + if (copy) {
> + qcom_nandc_read_buffer_sync(snandc, true);
> + memcpy(op->data.buf.in, snandc->reg_read_buf, snandc->buf_count);
> + }
> +
> + if (copy_ftr) {
> + qcom_nandc_read_buffer_sync(snandc, true);
> + val = le32_to_cpu(*(__le32 *)snandc->reg_read_buf);
> + val >>= 8;
> + memcpy(op->data.buf.in, &val, snandc->buf_count);
> + }
> +
> + return ret;
> +}
> +
> +static bool qpic_snand_is_page_op(const struct spi_mem_op *op)
> +{
> + if (op->addr.buswidth != 1 && op->addr.buswidth != 2 && op->addr.buswidth != 4)
> + return false;
> +
> + if (op->data.dir == SPI_MEM_DATA_IN) {
> + if (op->addr.buswidth == 4 && op->data.buswidth == 4)
> + return true;
> +
> + if (op->addr.nbytes == 2 && op->addr.buswidth == 1)
> + return true;
> +
> + } else if (op->data.dir == SPI_MEM_DATA_OUT) {
> + if (op->data.buswidth == 4)
> + return true;
> + if (op->addr.nbytes == 2 && op->addr.buswidth == 1)
> + return true;
> + }
> +
> + return false;
> +}
> +
> +static bool qpic_snand_supports_op(struct spi_mem *mem, const struct spi_mem_op *op)
> +{
> + if (!spi_mem_default_supports_op(mem, op))
> + return false;
> +
> + if (op->cmd.nbytes != 1 || op->cmd.buswidth != 1)
> + return false;
> +
> + if (qpic_snand_is_page_op(op))
> + return true;
> +
> + return ((op->addr.nbytes == 0 || op->addr.buswidth == 1) &&

!op->addr.nbytes and so on

> + (op->dummy.nbytes == 0 || op->dummy.buswidth == 1) &&
> + (op->data.nbytes == 0 || op->data.buswidth == 1));
> +}
> +
> +static int qpic_snand_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
> +{
> + struct qcom_nand_controller *snandc = spi_controller_get_devdata(mem->spi->controller);
> +
> + dev_dbg(snandc->dev, "OP %02x ADDR %08llX@%d:%u DATA %d:%u", op->cmd.opcode,
> + op->addr.val, op->addr.buswidth, op->addr.nbytes,
> + op->data.buswidth, op->data.nbytes);
> +
> + if (qpic_snand_is_page_op(op)) {
> + if (op->data.dir == SPI_MEM_DATA_IN)
> + return qpic_snand_read_page_cache(snandc, op);
> + if (op->data.dir == SPI_MEM_DATA_OUT)
> + return qpic_snand_write_page_cache(snandc, op);
> + } else {
> + return qpic_snand_io_op(snandc, op);
> + }
> +
> + return 0;
> +}
> +
> +static const struct spi_controller_mem_ops qcom_spi_mem_ops = {
> + .supports_op = qpic_snand_supports_op,
> + .exec_op = qpic_snand_exec_op,
> +};
> +
> +static const struct spi_controller_mem_caps qcom_snand_mem_caps = {
> + .ecc = true,
> +};
> +
> +static int qcom_snand_probe(struct platform_device *pdev)
> +{
> + struct device *dev = &pdev->dev;
> + struct spi_controller *ctlr;
> + struct qcom_nand_controller *snandc;
> + struct resource *res;
> + const void *dev_data;
> + struct qpic_ecc *ecc;
> + int ret;
> +
> + ecc = devm_kzalloc(dev, sizeof(*ecc), GFP_KERNEL);
> + if (!ecc)
> + return -ENOMEM;
> +
> + ctlr = __devm_spi_alloc_controller(dev, sizeof(*snandc), false);

I don't know if that is legitimate, why using __devm?

> + if (!ctlr)
> + return -ENOMEM;
> +
> + platform_set_drvdata(pdev, ctlr);
> +
> + snandc = spi_controller_get_devdata(ctlr);
> +
> + snandc->ctlr = ctlr;
> + snandc->dev = dev;
> + snandc->ecc = ecc;
> +
> + dev_data = of_device_get_match_data(dev);
> + if (!dev_data) {
> + dev_err(&pdev->dev, "failed to get device data\n");
> + return -ENODEV;
> + }
> +
> + snandc->props = dev_data;
> + snandc->dev = &pdev->dev;
> +
> + snandc->core_clk = devm_clk_get(dev, "core");
> + if (IS_ERR(snandc->core_clk))
> + return PTR_ERR(snandc->core_clk);
> +
> + snandc->aon_clk = devm_clk_get(dev, "aon");
> + if (IS_ERR(snandc->aon_clk))
> + return PTR_ERR(snandc->aon_clk);
> +
> + snandc->iomacro_clk = devm_clk_get(dev, "iom");
> + if (IS_ERR(snandc->iomacro_clk))
> + return PTR_ERR(snandc->iomacro_clk);
> +
> + snandc->base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
> + if (IS_ERR(snandc->base))
> + return PTR_ERR(snandc->base);
> +
> + snandc->base_phys = res->start;
> + snandc->base_dma = dma_map_resource(dev, res->start, resource_size(res),
> + DMA_BIDIRECTIONAL, 0);
> + if (dma_mapping_error(dev, snandc->base_dma))
> + return -ENXIO;
> +
> + ret = clk_prepare_enable(snandc->core_clk);
> + if (ret)
> + goto err_core_clk;
> +
> + ret = clk_prepare_enable(snandc->aon_clk);
> + if (ret)
> + goto err_aon_clk;
> +
> + ret = clk_prepare_enable(snandc->iomacro_clk);
> + if (ret)
> + goto err_snandc_alloc;
> +
> + ret = qcom_nandc_alloc(snandc);
> + if (ret)
> + goto err_snandc_alloc;
> +
> + ret = qcom_snand_init(snandc);
> + if (ret)
> + goto err_init;
> +
> + /* setup ECC engine */
> + snandc->ecc_eng.dev = &pdev->dev;
> + snandc->ecc_eng.integration = NAND_ECC_ENGINE_INTEGRATION_PIPELINED;
> + snandc->ecc_eng.ops = &qcom_snand_ecc_engine_ops_pipelined;
> + snandc->ecc_eng.priv = snandc;
> +
> + ret = nand_ecc_register_on_host_hw_engine(&snandc->ecc_eng);
> + if (ret) {
> + dev_err(&pdev->dev, "failed to register ecc engine.\n");
> + goto err_init;
> + }
> +
> + ctlr->num_chipselect = QPIC_QSPI_NUM_CS;
> + ctlr->mem_ops = &qcom_spi_mem_ops;
> + ctlr->mem_caps = &qcom_snand_mem_caps;
> + ctlr->dev.of_node = pdev->dev.of_node;
> + ctlr->mode_bits = SPI_TX_DUAL | SPI_RX_DUAL |
> + SPI_TX_QUAD | SPI_RX_QUAD;
> +
> + ret = spi_register_controller(ctlr);
> + if (ret) {
> + dev_err(&pdev->dev, "spi_register_controller failed.\n");
> + goto err_init;
> + }
> +
> + return 0;
> +
> +err_init:
> + qcom_nandc_unalloc(snandc);
> +err_snandc_alloc:
> + clk_disable_unprepare(snandc->aon_clk);
> +err_aon_clk:
> + clk_disable_unprepare(snandc->core_clk);

Don't you miss one clock ?

> +err_core_clk:
> + dma_unmap_resource(dev, res->start, resource_size(res),
> + DMA_BIDIRECTIONAL, 0);
> + return ret;
> +}
> +
> +static int qcom_snand_remove(struct platform_device *pdev)
> +{
> + struct spi_controller *ctlr = platform_get_drvdata(pdev);
> + struct qcom_nand_controller *snandc = spi_controller_get_devdata(ctlr);
> + struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> +
> + spi_unregister_controller(ctlr);
> +
> + clk_disable_unprepare(snandc->aon_clk);
> + clk_disable_unprepare(snandc->core_clk);
> + clk_disable_unprepare(snandc->iomacro_clk);
> +
> + dma_unmap_resource(&pdev->dev, snandc->base_dma, resource_size(res),
> + DMA_BIDIRECTIONAL, 0);
> + return 0;
> +}
> +
> +static const struct qcom_nandc_props ipq9574_snandc_props = {
> + .dev_cmd_reg_start = 0x7000,
> + .is_bam = true,

Same comment about "is_bam"

> +};
> +
> +static const struct of_device_id qcom_snandc_of_match[] = {
> + {
> + .compatible = "qcom,spi-qpic-snand",
> + .data = &ipq9574_snandc_props,
> + },
> + {}
> +}
> +MODULE_DEVICE_TABLE(of, qcom_snandc_of_match);
> +
> +static struct platform_driver qcom_snand_driver = {
> + .driver = {
> + .name = "qcom_snand",
> + .of_match_table = qcom_snandc_of_match,
> + },
> + .probe = qcom_snand_probe,
> + .remove = qcom_snand_remove,
> +};
> +module_platform_driver(qcom_snand_driver);
> +
> +MODULE_DESCRIPTION("SPI driver for QPIC QSPI cores");
> +MODULE_AUTHOR("Md Sadre Alam <[email protected]>");
> +MODULE_LICENSE("GPL");
> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
> index aced15866627..4673cd36ff0a 100644
> --- a/include/linux/mtd/nand-qpic-common.h
> +++ b/include/linux/mtd/nand-qpic-common.h
> @@ -45,6 +45,9 @@
> #define NAND_DEV_CMD1 0xa4
> #define NAND_DEV_CMD2 0xa8
> #define NAND_DEV_CMD_VLD 0xac
> +#define NAND_FLASH_SPI_CFG 0xc0
> +#define NAND_NUM_ADDR_CYCLES 0xc4
> +#define NAND_BUSY_CHECK_WAIT_CNT 0xc8

If this is specific to the spi-nand implementation, then it's not
common and has no reason to be shared here. Same for the other
definitions of course.

> #define SFLASHC_BURST_CFG 0xe0
> #define NAND_ERASED_CW_DETECT_CFG 0xe8
> #define NAND_ERASED_CW_DETECT_STATUS 0xec
> @@ -61,6 +64,7 @@
> #define NAND_READ_LOCATION_LAST_CW_1 0xf44
> #define NAND_READ_LOCATION_LAST_CW_2 0xf48
> #define NAND_READ_LOCATION_LAST_CW_3 0xf4c
> +#define NAND_FLASH_FEATURES 0xf64
>
> /* dummy register offsets, used by write_reg_dma */
> #define NAND_DEV_CMD1_RESTORE 0xdead
> @@ -169,6 +173,7 @@
> #define OP_CHECK_STATUS 0xc
> #define OP_FETCH_ID 0xb
> #define OP_RESET_DEVICE 0xd
> +#define ACC_FEATURE 0xe
>
> /* Default Value for NAND_DEV_CMD_VLD */
> #define NAND_DEV_CMD_VLD_VAL (READ_START_VLD | WRITE_START_VLD | \
> @@ -329,11 +334,53 @@ struct nandc_regs {
> __le32 read_location_last1;
> __le32 read_location_last2;
> __le32 read_location_last3;
> + __le32 spi_cfg;
> + __le32 num_addr_cycle;
> + __le32 busy_wait_cnt;
> + __le32 flash_feature;
>
> __le32 erased_cw_detect_cfg_clr;
> __le32 erased_cw_detect_cfg_set;
> };
>
> +struct qcom_ecc_stats {
> + u32 corrected;
> + u32 bitflips;
> + u32 failed;
> +};
> +
> +/*
> + * QPIC ECC data struct
> + *
> + */
> +struct qpic_ecc {
> + struct device *dev;
> + const struct qpic_ecc_caps *caps;
> + struct completion done;
> + u32 sectors;
> + u8 *eccdata;
> + bool use_ecc;
> + u32 ecc_modes;
> + int ecc_bytes_hw;
> + int spare_bytes;
> + int bbm_size;
> + int ecc_mode;
> + int bytes;
> + int steps;
> + int step_size;
> + int strength;
> + int cw_size;
> + int cw_data;
> + u32 cfg0, cfg1;
> + u32 cfg0_raw, cfg1_raw;
> + u32 ecc_buf_cfg;
> + u32 ecc_bch_cfg;
> + u32 clrflashstatus;
> + u32 clrreadstatus;
> + bool bch_enabled;
> +};
> +
> +struct qpic_ecc;
> /*
> * NAND controller data struct
> *
> @@ -352,6 +399,7 @@ struct nandc_regs {
> * initialized via DT match data
> *
> * @controller: base controller structure
> + * @ctlr: spi controller structure
> * @host_list: list containing all the chips attached to the
> * controller
> *
> @@ -389,6 +437,7 @@ struct qcom_nand_controller {
>
> struct clk *core_clk;
> struct clk *aon_clk;
> + struct clk *iomacro_clk;
>
> struct nandc_regs *regs;
> struct bam_transaction *bam_txn;
> @@ -396,6 +445,7 @@ struct qcom_nand_controller {
> const struct qcom_nandc_props *props;
>
> struct nand_controller controller;
> + struct spi_controller *ctlr;
> struct list_head host_list;
>
> union {
> @@ -432,6 +482,17 @@ struct qcom_nand_controller {
>
> u32 cmd1, vld;
> bool exec_opwrite;
> + struct qpic_ecc *ecc;
> + struct qcom_ecc_stats ecc_stats;
> + struct nand_ecc_engine ecc_eng;
> + u8 *wbuf;
> + u32 wlen;
> + u32 addr1;
> + u32 addr2;
> + u32 cmd;
> + u32 num_cw;
> + bool oob_read;
> + bool raw;
> };
>
> /*


Thanks,
Miquèl

2024-03-19 10:29:15

by Md Sadre Alam

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support



On 3/15/2024 5:38 PM, Miquel Raynal wrote:
> Hi,
>
> [email protected] wrote on Fri, 8 Mar 2024 14:47:50 +0530:
>
>> Add qpic spi nand driver support. The spi nand
>> driver currently supported the below commands.
>>
>> -- RESET
>> -- READ ID
>> -- SET FEATURE
>> -- GET FEATURE
>> -- READ PAGE
>> -- WRITE PAGE
>> -- ERASE PAGE
>>
>> Co-developed-by: Sricharan Ramabadhran <[email protected]>
>> Signed-off-by: Sricharan Ramabadhran <[email protected]>
>> Co-developed-by: Varadarajan Narayanan <[email protected]>
>> Signed-off-by: Varadarajan Narayanan <[email protected]>
>> Signed-off-by: Md Sadre Alam <[email protected]>
>
> I don't like the "spi nand driver" wording here. It is a spi
> controller, for spi-memories.
Ok
>
> Plus, I'd expect some kind of check to see whether you support the
> requested operation, I don't see any in the code.
Ok, will add in next patch.
>
>
>> ---
>> Change in [v4]
>>
>> * No change
>>
>> Change in [v3]
>>
>> * Set SPI_QPIC_SNAND to n and added COMPILE_TEST in Kconfig
>>
>> * Made driver name sorted in Make file
>>
>> * Made comment like c++
>>
>> * Changed macro to functions, snandc_set_read_loc_last()
>> and snandc_set_read_loc_first()
>>
>> * Added error handling in snandc_set_reg()
>>
>> * Changed into normal conditional statement for
>> return snandc->ecc_stats.failed ? -EBADMSG :
>> snandc->ecc_stats.bitflips;
>>
>> * Remove cast of wbuf in qpic_snand_program_execute()
>> function
>>
>> * Made num_cw variable instead hardcoded value
>>
>> * changed if..else condition of function qpic_snand_io_op()
>> to switch..case statement
>>
>> * Added __devm_spi_alloc_controller() api instead of
>> devm_spi_alloc_master()
>>
>> * Disabling clock in remove path
>>
>> Change in [v2]
>>
>> * Added initial support for SPI-NAND driver
>>
>> Change in [v1]
>>
>> * Added RFC patch for design review
>>
>> drivers/mtd/nand/qpic_common.c | 8 +
>> drivers/spi/Kconfig | 8 +
>> drivers/spi/Makefile | 1 +
>> drivers/spi/spi-qpic-snand.c | 1041 ++++++++++++++++++++++++++
>> include/linux/mtd/nand-qpic-common.h | 61 ++
>> 5 files changed, 1119 insertions(+)
>> create mode 100644 drivers/spi/spi-qpic-snand.c
>>
>> diff --git a/drivers/mtd/nand/qpic_common.c b/drivers/mtd/nand/qpic_common.c
>> index 5b7c0d119d9a..67ccb3d05f20 100644
>> --- a/drivers/mtd/nand/qpic_common.c
>> +++ b/drivers/mtd/nand/qpic_common.c
>> @@ -134,6 +134,14 @@ __le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
>> return &regs->read_location_last2;
>> case NAND_READ_LOCATION_LAST_CW_3:
>> return &regs->read_location_last3;
>> + case NAND_FLASH_SPI_CFG:
>> + return &regs->spi_cfg;
>> + case NAND_NUM_ADDR_CYCLES:
>> + return &regs->num_addr_cycle;
>> + case NAND_BUSY_CHECK_WAIT_CNT:
>> + return &regs->busy_wait_cnt;
>> + case NAND_FLASH_FEATURES:
>> + return &regs->flash_feature;
>
> I am still not convinced about these. I don't understand who you have
> this indirection.
This indirection I believe is needed by the write_reg_dma function, wherein a
bunch of registers are modified based on a starting register.Can I change this
in a separate cleanup series as a follow up to this?
>
>> default:
>> return NULL;
>> }
>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>> index bc7021da2fe9..63764e943d82 100644
>> --- a/drivers/spi/Kconfig
>> +++ b/drivers/spi/Kconfig
>> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
>> help
>> QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>>
>> +config SPI_QPIC_SNAND
>> + tristate "QPIC SNAND controller"
>> + depends on ARCH_QCOM || COMPILE_TEST
>> + help
>> + QPIC_SNAND (QPIC SPI NAND) driver for Qualcomm QPIC controller.
>> + QPIC controller supports both parallel nand and serial nand.
>> + This config will enable serial nand driver for QPIC controller.
>> +
>> config SPI_QUP
>> tristate "Qualcomm SPI controller with QUP interface"
>> depends on ARCH_QCOM || COMPILE_TEST
>> diff --git a/drivers/spi/Makefile b/drivers/spi/Makefile
>> index 4ff8d725ba5e..9015368f8c73 100644
>> --- a/drivers/spi/Makefile
>> +++ b/drivers/spi/Makefile
>> @@ -111,6 +111,7 @@ obj-$(CONFIG_SPI_PXA2XX) += spi-pxa2xx-platform.o
>> obj-$(CONFIG_SPI_PXA2XX_PCI) += spi-pxa2xx-pci.o
>> obj-$(CONFIG_SPI_QCOM_GENI) += spi-geni-qcom.o
>> obj-$(CONFIG_SPI_QCOM_QSPI) += spi-qcom-qspi.o
>> +obj-$(CONFIG_SPI_QPIC_SNAND) += spi-qpic-snand.o
>> obj-$(CONFIG_SPI_QUP) += spi-qup.o
>> obj-$(CONFIG_SPI_ROCKCHIP) += spi-rockchip.o
>> obj-$(CONFIG_SPI_ROCKCHIP_SFC) += spi-rockchip-sfc.o
>> diff --git a/drivers/spi/spi-qpic-snand.c b/drivers/spi/spi-qpic-snand.c
>> new file mode 100644
>> index 000000000000..df7d5d8d4db2
>> --- /dev/null
>> +++ b/drivers/spi/spi-qpic-snand.c
>> @@ -0,0 +1,1041 @@
>> +/*
>> + * SPDX-License-Identifier: GPL-2.0
>> + *
>> + * Copyright (c) 2023, Qualcomm Innovation Center, Inc. All rights reserved.
>> + *
>> + * Authors:
>> + * Md Sadre Alam <[email protected]>
>> + * Sricharan R <[email protected]>
>> + * Varadarajan Narayanan <[email protected]>
>> + */
>> +
>> +#include <linux/mtd/spinand.h>
>> +#include <linux/mtd/nand-qpic-common.h>
>> +
>> +/* QSPI NAND config reg bits */
>> +#define LOAD_CLK_CNTR_INIT_EN BIT(28)
>> +#define CLK_CNTR_INIT_VAL_VEC 0x924
>> +#define FEA_STATUS_DEV_ADDR 0xc0
>> +#define SPI_CFG BIT(0)
>> +#define SPI_NUM_ADDR 0xDA4DB
>> +#define SPI_WAIT_CNT 0x10
>> +#define QPIC_QSPI_NUM_CS 1
>> +#define SPI_TRANSFER_MODE_x1 BIT(29)
>> +#define SPI_TRANSFER_MODE_x4 (3 << 29)
>> +#define SPI_WP BIT(28)
>> +#define SPI_HOLD BIT(27)
>> +#define QPIC_SET_FEATURE BIT(31)
>> +
>> +#define SPINAND_RESET 0xff
>> +#define SPINAND_READID 0x9f
>> +#define SPINAND_GET_FEATURE 0x0f
>> +#define SPINAND_SET_FEATURE 0x1f
>> +#define SPINAND_READ 0x13
>> +#define SPINAND_ERASE 0xd8
>> +#define SPINAND_WRITE_EN 0x06
>> +#define SPINAND_PROGRAM_EXECUTE 0x10
>> +#define SPINAND_PROGRAM_LOAD 0x84
>> +
>> +struct qpic_snand_op {
>> + u32 cmd_reg;
>> + u32 addr1_reg;
>> + u32 addr2_reg;
>> +};
>> +
>> +struct snandc_read_status {
>> + __le32 snandc_flash;
>> + __le32 snandc_buffer;
>> + __le32 snandc_erased_cw;
>> +};
>> +
>> +static void snandc_set_reg(struct qcom_nand_controller *snandc, int offset, u32 val)
>
> qcom_spi_ would be a better prefix maybe?
Ok
>
>> +{
>> + struct nandc_regs *regs = snandc->regs;
>> + __le32 *reg;
>> +
>> + reg = qcom_offset_to_nandc_reg(regs, offset);
>> +
>> + if (reg)
>> + *reg = cpu_to_le32(val);
>> +
>> + if (WARN_ON(!reg))
>> + return;
>
> This whole logic really seems suboptimal.
>
>> +}
>> +
>> +static void snandc_set_read_loc_first(struct qcom_nand_controller *snandc,
>> + int reg, int cw_offset, int read_size,
>> + int is_last_read_loc)
>> +{
>> + snandc_set_reg(snandc, reg, ((cw_offset) << READ_LOCATION_OFFSET) |
>> + ((read_size) << READ_LOCATION_SIZE) | ((is_last_read_loc)
>> + << READ_LOCATION_LAST));
>
> FIELD_GET, FIELD_PREP ?
Ok
>
>> +}
>> +
>> +static void snandc_set_read_loc_last(struct qcom_nand_controller *snandc,
>> + int reg, int cw_offset, int read_size,
>> + int is_last_read_loc)
>> +{
>> + snandc_set_reg(snandc, reg, ((cw_offset) << READ_LOCATION_OFFSET) |
>> + ((read_size) << READ_LOCATION_SIZE) | ((is_last_read_loc)
>> + << READ_LOCATION_LAST));
>> +}
>> +
>> +static struct qcom_nand_controller *nand_to_qcom_snand(struct nand_device *nand)
>> +{
>> + struct nand_ecc_engine *eng = nand->ecc.engine;
>> +
>> + return container_of(eng, struct qcom_nand_controller, ecc_eng);
>> +}
>> +
>> +static int qcom_snand_init(struct qcom_nand_controller *snandc)
>> +{
>> + u32 snand_cfg_val = 0x0;
>> + int ret;
>> +
>> + snand_cfg_val |= (LOAD_CLK_CNTR_INIT_EN | (CLK_CNTR_INIT_VAL_VEC << 16)
>> + | (FEA_STATUS_DEV_ADDR << 8) | SPI_CFG);
>
> ^
> the | should be on the previous line.
Ok
>
>> +
>> + snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, 0);
>> + snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, snand_cfg_val);
>> + snandc_set_reg(snandc, NAND_NUM_ADDR_CYCLES, SPI_NUM_ADDR);
>> + snandc_set_reg(snandc, NAND_BUSY_CHECK_WAIT_CNT, SPI_WAIT_CNT);
>> +
>> + qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
>> + qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
>> +
>> + snand_cfg_val &= ~LOAD_CLK_CNTR_INIT_EN;
>> + snandc_set_reg(snandc, NAND_FLASH_SPI_CFG, snand_cfg_val);
>> +
>> + qcom_write_reg_dma(snandc, NAND_FLASH_SPI_CFG, 1, 0);
>> +
>> + qcom_write_reg_dma(snandc, NAND_NUM_ADDR_CYCLES, 1, 0);
>> + qcom_write_reg_dma(snandc, NAND_BUSY_CHECK_WAIT_CNT, 1, NAND_BAM_NEXT_SGL);
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret)
>> + dev_err(snandc->dev, "failure in sbumitting spiinit descriptor\n");
>
> Typos...
Ok
>
>> +
>> + return 0;
>
> return ret ?
Ok
>
>> +}
>> +
>> +static int qcom_snand_ooblayout_ecc(struct mtd_info *mtd, int section,
>> + struct mtd_oob_region *oobregion)
>> +{
>> + struct nand_device *nand = mtd_to_nanddev(mtd);
>> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
>> + struct qpic_ecc *qecc = snandc->ecc;
>> +
>> + if (section > 1)
>> + return -ERANGE;
>> +
>> + if (!section) {
>> + oobregion->length = (qecc->bytes * (qecc->steps - 1)) + qecc->bbm_size;
>> + oobregion->offset = 0;
>
> No BBM?
Ok
>
>> + } else {
>> + oobregion->length = qecc->ecc_bytes_hw + qecc->spare_bytes;
>> + oobregion->offset = mtd->oobsize - oobregion->length;
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static int qcom_snand_ooblayout_free(struct mtd_info *mtd, int section,
>> + struct mtd_oob_region *oobregion)
>> +{
>> + struct nand_device *nand = mtd_to_nanddev(mtd);
>> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
>> + struct qpic_ecc *qecc = snandc->ecc;
>> +
>> + if (section)
>> + return -ERANGE;
>> +
>> + oobregion->length = qecc->steps * 4;
>> + oobregion->offset = ((qecc->steps - 1) * qecc->bytes) + qecc->bbm_size;
>> +
>
> Using the same order would be easier to compare with the above version

Not able to understand. Could you please elaborate order of what has to be change
Will change it in the next version.

>> + return 0;
>> +}
>> +
>> +static const struct mtd_ooblayout_ops qcom_snand_ooblayout = {
>> + .ecc = qcom_snand_ooblayout_ecc,
>> + .free = qcom_snand_ooblayout_free,
>> +};
>> +
>> +static int qpic_snand_ecc_init_ctx_pipelined(struct nand_device *nand)
>> +{
>> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
>> + struct nand_ecc_props *conf = &nand->ecc.ctx.conf;
>> + struct nand_ecc_props *reqs = &nand->ecc.requirements;
>> + struct nand_ecc_props *user = &nand->ecc.user_conf;
>> + struct mtd_info *mtd = nanddev_to_mtd(nand);
>> + int step_size = 0, strength = 0, steps;
>> + int cwperpage, bad_block_byte;
>> + struct qpic_ecc *ecc_cfg;
>> +
>> + cwperpage = mtd->writesize / NANDC_STEP_SIZE;
>> + snandc->num_cw = cwperpage;
>> +
>> + ecc_cfg = kzalloc(sizeof(*ecc_cfg), GFP_KERNEL);
>> + if (!ecc_cfg)
>> + return -ENOMEM;
>> +
>> + nand->ecc.ctx.priv = ecc_cfg;
>> +
>> + if (user->step_size && user->strength) {
>> + step_size = user->step_size;
>> + strength = user->strength;
>> + } else if (reqs->step_size && reqs->strength) {
>> + step_size = reqs->step_size;
>> + strength = reqs->strength;
>> + }
>> +
>> + if (step_size && strength)
>> + steps = mtd->writesize / step_size;
>> +
>> + ecc_cfg->ecc_bytes_hw = 7;
>> + ecc_cfg->spare_bytes = 4;
>> + ecc_cfg->bbm_size = 1;
>> + ecc_cfg->bch_enabled = true;
>> + ecc_cfg->bytes = ecc_cfg->ecc_bytes_hw + ecc_cfg->spare_bytes + ecc_cfg->bbm_size;
>> +
>> + ecc_cfg->steps = 4;
>> + ecc_cfg->strength = 4;
>> + ecc_cfg->step_size = 512;
>> +
>> + mtd_set_ooblayout(mtd, &qcom_snand_ooblayout);
>> +
>> + ecc_cfg->cw_data = 516;
>> + ecc_cfg->cw_size = ecc_cfg->cw_data + ecc_cfg->bytes;
>> + bad_block_byte = mtd->writesize - ecc_cfg->cw_size * (cwperpage - 1) + 1;
>> +
>> + ecc_cfg->cfg0 = (cwperpage - 1) << CW_PER_PAGE
>> + | ecc_cfg->cw_data << UD_SIZE_BYTES
>> + | 1 << DISABLE_STATUS_AFTER_WRITE
>> + | 3 << NUM_ADDR_CYCLES
>> + | ecc_cfg->ecc_bytes_hw << ECC_PARITY_SIZE_BYTES_RS
>> + | 0 << STATUS_BFR_READ
>> + | 1 << SET_RD_MODE_AFTER_STATUS
>> + | ecc_cfg->spare_bytes << SPARE_SIZE_BYTES;
>> +
>> + ecc_cfg->cfg1 = 0 << NAND_RECOVERY_CYCLES
>> + | 0 << CS_ACTIVE_BSY
>> + | bad_block_byte << BAD_BLOCK_BYTE_NUM
>> + | 0 << BAD_BLOCK_IN_SPARE_AREA
>> + | 20 << WR_RD_BSY_GAP
>> + | 0 << WIDE_FLASH
>> + | ecc_cfg->bch_enabled << ENABLE_BCH_ECC;
>> +
>> + ecc_cfg->cfg0_raw = (cwperpage - 1) << CW_PER_PAGE
>> + | ecc_cfg->cw_size << UD_SIZE_BYTES
>> + | 3 << NUM_ADDR_CYCLES
>> + | 0 << SPARE_SIZE_BYTES;
>> +
>> + ecc_cfg->cfg1_raw = 0 << NAND_RECOVERY_CYCLES
>> + | 0 << CS_ACTIVE_BSY
>> + | 17 << BAD_BLOCK_BYTE_NUM
>> + | 1 << BAD_BLOCK_IN_SPARE_AREA
>> + | 20 << WR_RD_BSY_GAP
>> + | 0 << WIDE_FLASH
>> + | 1 << DEV0_CFG1_ECC_DISABLE;
>> +
>> + ecc_cfg->ecc_bch_cfg = !ecc_cfg->bch_enabled << ECC_CFG_ECC_DISABLE
>> + | 0 << ECC_SW_RESET
>> + | ecc_cfg->cw_data << ECC_NUM_DATA_BYTES
>> + | 1 << ECC_FORCE_CLK_OPEN
>> + | 0 << ECC_MODE
>> + | ecc_cfg->ecc_bytes_hw << ECC_PARITY_SIZE_BYTES_BCH;
>> +
>> + ecc_cfg->ecc_buf_cfg = 0x203 << NUM_STEPS;
>> + ecc_cfg->clrflashstatus = FS_READY_BSY_N;
>> + ecc_cfg->clrreadstatus = 0xc0;
>> +
>> + conf->step_size = ecc_cfg->step_size;
>> + conf->strength = ecc_cfg->strength;
>> +
>> + if (ecc_cfg->strength < strength)
>> + dev_warn(snandc->dev, "Unable to fulfill ECC requirements of %u bits.\n", strength);
>
> Not needed I guess. Somewhat redundant with the core?
Ok
>
>> +
>> + dev_info(snandc->dev, "ECC strength: %u bits per %u bytes\n",
>> + ecc_cfg->strength, ecc_cfg->step_size);
>
> Debug?
Ok
>
>> +
>> + return 0;
>> +}
>> +
>> +static void qpic_snand_ecc_cleanup_ctx_pipelined(struct nand_device *nand)
>> +{
>> + struct qpic_ecc *ecc_cfg = nand_to_ecc_ctx(nand);
>> +
>> + kfree(ecc_cfg);
>> +}
>> +
>> +static int qpic_snand_ecc_prepare_io_req_pipelined(struct nand_device *nand,
>> + struct nand_page_io_req *req)
>> +{
>> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
>> + struct qpic_ecc *ecc_cfg = nand_to_ecc_ctx(nand);
>> +
>> + snandc->ecc = ecc_cfg;
>> + snandc->raw = false;
>> + snandc->oob_read = false;
>> +
>> + if (req->mode == MTD_OPS_RAW) {
>> + if (req->ooblen)
>> + snandc->oob_read = true;
>> + snandc->raw = true;
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static int qpic_snand_ecc_finish_io_req_pipelined(struct nand_device *nand,
>> + struct nand_page_io_req *req)
>> +{
>> + struct qcom_nand_controller *snandc = nand_to_qcom_snand(nand);
>> + struct mtd_info *mtd = nanddev_to_mtd(nand);
>> +
>> + if (req->mode == MTD_OPS_RAW || req->type != NAND_PAGE_READ)
>> + return 0;
>> +
>> + if (snandc->ecc_stats.failed)
>> + mtd->ecc_stats.failed += snandc->ecc_stats.failed;
>> + mtd->ecc_stats.corrected += snandc->ecc_stats.corrected;
>> +
>> + if (snandc->ecc_stats.failed)
>
> I hope you reset this counter at some point.
Yes
>
> Did you run nandbiterrs -i ?

No. I tested with mtd write/erase and dd commands etc. Will include nandbiterrs from next version.

>
>> + return -EBADMSG;
>> + else
>> + return snandc->ecc_stats.bitflips;
>> +}
>> +
>> +static struct nand_ecc_engine_ops qcom_snand_ecc_engine_ops_pipelined = {
>> + .init_ctx = qpic_snand_ecc_init_ctx_pipelined,
>> + .cleanup_ctx = qpic_snand_ecc_cleanup_ctx_pipelined,
>> + .prepare_io_req = qpic_snand_ecc_prepare_io_req_pipelined,
>> + .finish_io_req = qpic_snand_ecc_finish_io_req_pipelined,
>> +};
>> +
>> +/* helper to configure location register values */
>> +static void snandc_set_read_loc(struct qcom_nand_controller *snandc, int cw, int reg,
>> + int cw_offset, int read_size, int is_last_read_loc)
>> +{
>> + int reg_base = NAND_READ_LOCATION_0;
>> +
>> + if (cw == 3)
>> + reg_base = NAND_READ_LOCATION_LAST_CW_0;
>> +
>> + reg_base += reg * 4;
>> +
>> + if (cw == 3)
>> + return snandc_set_read_loc_last(snandc, reg_base, cw_offset,
>> + read_size, is_last_read_loc);
>
> Alignments are still wrong, again.
Ok
>
>> + else
>> + return snandc_set_read_loc_first(snandc, reg_base, cw_offset,
>> + read_size, is_last_read_loc);
>> +}
>> +
>> +static void
>> +snandc_config_cw_read(struct qcom_nand_controller *snandc, bool use_ecc, int cw)
>> +{
>> + int reg = NAND_READ_LOCATION_0;
>> +
>> + if (cw == 3)
>> + reg = NAND_READ_LOCATION_LAST_CW_0;
>> +
>> + if (snandc->props->is_bam)
>> + qcom_write_reg_dma(snandc, reg, 4, NAND_BAM_NEXT_SGL);
>> +
>> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
>> +
>> + qcom_read_reg_dma(snandc, NAND_FLASH_STATUS, 2, 0);
>> + qcom_read_reg_dma(snandc, NAND_ERASED_CW_DETECT_STATUS, 1,
>> + NAND_BAM_NEXT_SGL);
>> +}
>> +
>> +static int qpic_snand_block_erase(struct qcom_nand_controller *snandc)
>> +{
>> + struct qpic_ecc *ecc_cfg = snandc->ecc;
>> + int ret;
>> +
>> + snandc->buf_count = 0;
>> + snandc->buf_start = 0;
>> + qcom_clear_read_regs(snandc);
>> + qcom_clear_bam_transaction(snandc);
>> +
>> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
>> + snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
>> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
>> + snandc_set_reg(snandc, NAND_DEV0_CFG0, ecc_cfg->cfg0_raw & ~(7 << CW_PER_PAGE));
>> + snandc_set_reg(snandc, NAND_DEV0_CFG1, ecc_cfg->cfg1_raw);
>> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
>> +
>> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 3, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 2, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret) {
>> + dev_err(snandc->dev, "failure to erase block\n");
>> + return ret;
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static void config_snand_single_cw_page_read(struct qcom_nand_controller *snandc,
>> + bool use_ecc, int cw)
>> +{
>> + int reg;
>> +
>> + qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
>> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
>> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
>> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1,
>> + NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
>> +
>> + reg = NAND_READ_LOCATION_0;
>> + if (cw == 3)
>
> This is hardcoded everywhere, I am not a big fan.
Ok will fix in next patch.
>
>> + reg = NAND_READ_LOCATION_LAST_CW_0;
>> + qcom_write_reg_dma(snandc, reg, 4, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
>> +
>> + qcom_read_reg_dma(snandc, NAND_FLASH_STATUS, 2, 0);
>> + qcom_read_reg_dma(snandc, NAND_ERASED_CW_DETECT_STATUS, 1, NAND_BAM_NEXT_SGL);
>> +}
>> +
>> +static int qpic_snand_read_oob(struct qcom_nand_controller *snandc,
>> + const struct spi_mem_op *op)
>> +{
>> + struct qpic_ecc *ecc_cfg = snandc->ecc;
>> + int size, ret;
>> + int col, bbpos;
>> + u32 cfg0, cfg1, ecc_bch_cfg;
>> + u32 num_cw = snandc->num_cw;
>> +
>> + qcom_clear_bam_transaction(snandc);
>> + qcom_clear_read_regs(snandc);
>> +
>> + size = ecc_cfg->cw_size;
>> + col = ecc_cfg->cw_size * (num_cw - 1);
>> +
>> + /* prepare a clean read buffer */
>> + memset(snandc->data_buffer, 0xff, size);
>> + snandc_set_reg(snandc, NAND_ADDR0, (snandc->addr1 | col));
>> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
>> +
>> + cfg0 = (ecc_cfg->cfg0_raw & ~(7U << CW_PER_PAGE)) |
>> + 0 << CW_PER_PAGE;
>> + cfg1 = ecc_cfg->cfg1_raw;
>> + ecc_bch_cfg = 1 << ECC_CFG_ECC_DISABLE;
>> +
>> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
>> + snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
>> + snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
>> + snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
>> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
>> +
>> + config_snand_single_cw_page_read(snandc, false, num_cw - 1);
>> +
>> + qcom_read_data_dma(snandc, FLASH_BUF_ACC, snandc->data_buffer, size, 0);
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret)
>> + dev_err(snandc->dev, "failed to read oob\n");
>
> Why don't you return here?
Ok
>
>> +
>> + qcom_nandc_read_buffer_sync(snandc, true);
>> + u32 flash = le32_to_cpu(snandc->reg_read_buf[0]);
>
> No compiler warning here?
Ok will check and fix in next patch.
>
>> +
>> + if (flash & (FS_OP_ERR | FS_MPU_ERR))
>> + return -EIO;
>> +
>> + bbpos = 2048 - ecc_cfg->cw_size * (num_cw - 1);
>
> Why is this size hardcoded?! That cannot work!
Ok will fix in next patch.
>
>> + memcpy(op->data.buf.in, snandc->data_buffer + bbpos, op->data.nbytes);
>> +
>> + return ret;
>> +}
>> +
>> +static int snandc_check_error(struct qcom_nand_controller *snandc)
>> +{
>> + struct snandc_read_status *buf;
>> + int i, num_cw = snandc->num_cw;
>> + bool serial_op_err = false, erased;
>> +
>> + qcom_nandc_read_buffer_sync(snandc, true);
>> + buf = (struct snandc_read_status *)snandc->reg_read_buf;
>> +
>> + for (i = 0; i < num_cw; i++, buf++) {
>> + u32 flash, buffer, erased_cw;
>> +
>> + flash = le32_to_cpu(buf->snandc_flash);
>> + buffer = le32_to_cpu(buf->snandc_buffer);
>> + erased_cw = le32_to_cpu(buf->snandc_erased_cw);
>> +
>> + if ((flash & FS_OP_ERR) && (buffer & BS_UNCORRECTABLE_BIT)) {
>> + erased = (erased_cw & ERASED_CW) == ERASED_CW ?
>> + true : false;
>
> This ternary operation is useless
Ok
>
>> + } else if (flash & (FS_OP_ERR | FS_MPU_ERR)) {
>> + serial_op_err = true;
>> + }
>> + }
>> +
>> + if (serial_op_err)
>> + return -EIO;
>> +
>> + return 0;
>> +}
>> +
>> +static int qpic_snand_read_page_cache(struct qcom_nand_controller *snandc,
>> + const struct spi_mem_op *op)
>> +{
>> + struct qpic_ecc *ecc_cfg = snandc->ecc;
>> + u8 *data_buf;
>> + int ret, i;
>> + u32 cfg0, cfg1, ecc_bch_cfg, num_cw = snandc->num_cw;
>> +
>> + data_buf = op->data.buf.in;
>> +
>> + if (snandc->oob_read) {
>> + return qpic_snand_read_oob(snandc, op);
>> + snandc->oob_read = false;
>> + }
>> +
>> + snandc->buf_count = 0;
>> + snandc->buf_start = 0;
>> + qcom_clear_read_regs(snandc);
>> +
>> + cfg0 = (ecc_cfg->cfg0 & ~(7U << CW_PER_PAGE)) |
>> + (num_cw - 1) << CW_PER_PAGE;
>> + cfg1 = ecc_cfg->cfg1;
>> + ecc_bch_cfg = ecc_cfg->ecc_bch_cfg;
>> +
>> + snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
>> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
>> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
>> + snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
>> + snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
>> + snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
>> + snandc_set_reg(snandc, NAND_FLASH_STATUS, ecc_cfg->clrflashstatus);
>> + snandc_set_reg(snandc, NAND_READ_STATUS, ecc_cfg->clrreadstatus);
>> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
>> + snandc_set_read_loc(snandc, 0, 0, 0, ecc_cfg->cw_data, 1);
>> +
>> + qcom_clear_bam_transaction(snandc);
>> +
>> + qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
>> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
>> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1, 0);
>> + qcom_write_reg_dma(snandc, NAND_ERASED_CW_DETECT_CFG, 1,
>> + NAND_ERASED_CW_SET | NAND_BAM_NEXT_SGL);
>> +
>> + for (i = 0; i < num_cw; i++) {
>> + int data_size;
>> +
>> + if (i == (num_cw - 1))
>> + data_size = 512 - ((num_cw - 1) << 2);
>> + else
>> + data_size = ecc_cfg->cw_data;
>> +
>> + if (data_buf)
>> + snandc_set_read_loc(snandc, i, 0, 0, data_size, 1);
>> +
>> + snandc_config_cw_read(snandc, true, i);
>> +
>> + if (data_buf)
>> + qcom_read_data_dma(snandc, FLASH_BUF_ACC, data_buf,
>> + data_size, 0);
>> +
>> + if (data_buf)
>> + data_buf += data_size;
>> + }
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret) {
>> + dev_err(snandc->dev, "failure to read page/oob\n");
>> + return ret;
>> + }
>> +
>> + return snandc_check_error(snandc);
>> +}
>> +
>> +static void config_snand_page_write(struct qcom_nand_controller *snandc)
>> +{
>> + qcom_write_reg_dma(snandc, NAND_ADDR0, 2, 0);
>> + qcom_write_reg_dma(snandc, NAND_DEV0_CFG0, 3, 0);
>> + qcom_write_reg_dma(snandc, NAND_EBI2_ECC_BUF_CFG, 1, NAND_BAM_NEXT_SGL);
>> +}
>> +
>> +static void config_snand_cw_write(struct qcom_nand_controller *snandc)
>> +{
>> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 1, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
>> +}
>> +
>> +static int qpic_snand_program_execute(struct qcom_nand_controller *snandc,
>> + const struct spi_mem_op *op)
>> +{
>> + struct qpic_ecc *ecc_cfg = snandc->ecc;
>> + u8 *data_buf;
>> + int i, ret;
>> + int num_cw = snandc->num_cw;
>> + u32 cfg0, cfg1, ecc_bch_cfg, ecc_buf_cfg;
>> +
>> + cfg0 = (ecc_cfg->cfg0 & ~(7U << CW_PER_PAGE)) |
>> + (num_cw - 1) << CW_PER_PAGE;
>> + cfg1 = ecc_cfg->cfg1;
>> + ecc_bch_cfg = ecc_cfg->ecc_bch_cfg;
>> + ecc_buf_cfg = ecc_cfg->ecc_buf_cfg;
>> +
>> + data_buf = snandc->wbuf;
>> +
>> + snandc->buf_count = 0;
>> + snandc->buf_start = 0;
>> + qcom_clear_read_regs(snandc);
>> + qcom_clear_bam_transaction(snandc);
>> +
>> + snandc_set_reg(snandc, NAND_ADDR0, snandc->addr1);
>> + snandc_set_reg(snandc, NAND_ADDR1, snandc->addr2);
>> + snandc_set_reg(snandc, NAND_FLASH_CMD, snandc->cmd);
>> +
>> + snandc_set_reg(snandc, NAND_DEV0_CFG0, cfg0);
>> + snandc_set_reg(snandc, NAND_DEV0_CFG1, cfg1);
>> + snandc_set_reg(snandc, NAND_DEV0_ECC_CFG, ecc_bch_cfg);
>> +
>> + snandc_set_reg(snandc, NAND_EBI2_ECC_BUF_CFG, ecc_buf_cfg);
>> +
>> + snandc_set_reg(snandc, NAND_EXEC_CMD, 1);
>> +
>> + config_snand_page_write(snandc);
>> +
>> + for (i = 0; i < num_cw; i++) {
>> + int data_size;
>> +
>> + if (i == (num_cw - 1))
>> + data_size = NANDC_STEP_SIZE - ((num_cw - 1) << 2);
>> + else
>> + data_size = ecc_cfg->cw_data;
>> +
>> + qcom_write_data_dma(snandc, FLASH_BUF_ACC, data_buf, data_size,
>> + i == (num_cw - 1) ? NAND_BAM_NO_EOT : 0);
>> +
>> + config_snand_cw_write(snandc);
>> + if (data_buf)
>> + data_buf += data_size;
>> + }
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret) {
>> + dev_err(snandc->dev, "failure to write page\n");
>> + return ret;
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static u32 qpic_snand_cmd_mapping(struct qcom_nand_controller *snandc, u32 opcode)
>> +{
>> + u32 cmd = 0x0;
>> +
>> + switch (opcode) {
>> + case SPINAND_RESET:
>> + cmd = (SPI_WP | SPI_HOLD | SPI_TRANSFER_MODE_x1 | OP_RESET_DEVICE);
>> + break;
>> + case SPINAND_READID:
>> + cmd = (SPI_WP | SPI_HOLD | SPI_TRANSFER_MODE_x1 | OP_FETCH_ID);
>> + break;
>> + case SPINAND_GET_FEATURE:
>> + cmd = (SPI_TRANSFER_MODE_x1 | SPI_WP | SPI_HOLD | ACC_FEATURE);
>> + break;
>> + case SPINAND_SET_FEATURE:
>> + cmd = (SPI_TRANSFER_MODE_x1 | SPI_WP | SPI_HOLD | ACC_FEATURE |
>> + QPIC_SET_FEATURE);
>> + break;
>> + case SPINAND_READ:
>> + if (snandc->raw)
>> + cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
>> + SPI_WP | SPI_HOLD | OP_PAGE_READ);
>> + else
>> + cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
>> + SPI_WP | SPI_HOLD | OP_PAGE_READ_WITH_ECC);
>> + break;
>> + case SPINAND_ERASE:
>> + cmd = OP_BLOCK_ERASE | PAGE_ACC | LAST_PAGE | SPI_WP |
>> + SPI_HOLD | SPI_TRANSFER_MODE_x1;
>> + break;
>> + case SPINAND_WRITE_EN:
>> + cmd = SPINAND_WRITE_EN;
>> + break;
>> + case SPINAND_PROGRAM_EXECUTE:
>> + cmd = (PAGE_ACC | LAST_PAGE | SPI_TRANSFER_MODE_x1 |
>> + SPI_WP | SPI_HOLD | OP_PROGRAM_PAGE);
>> + break;
>> + case SPINAND_PROGRAM_LOAD:
>> + cmd = SPINAND_PROGRAM_LOAD;
>> + break;
>> + default:
>> + break;
>
> No, no, no and no again. You've been sending NAND contributions for
> years, and you still continue to assume all the commands are defined
> and we will never check for supported ops. Please.
Sorry, I missed that check for unsupported command. Will fix in next patch.
>
>> + }
>> +
>> + return cmd;
>> +}
>> +
>> +static int qpic_snand_write_page_cache(struct qcom_nand_controller *snandc,
>> + const struct spi_mem_op *op)
>> +{
>> + struct qpic_snand_op s_op = {};
>> + u32 cmd;
>> +
>> + cmd = qpic_snand_cmd_mapping(snandc, op->cmd.opcode);
>> + s_op.cmd_reg = cmd;
>> +
>> + if (op->cmd.opcode == SPINAND_PROGRAM_LOAD) {
>> + snandc->wbuf = (u8 *)op->data.buf.out;
>> + snandc->wlen = op->data.nbytes;
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static int qpic_snand_send_cmdaddr(struct qcom_nand_controller *snandc,
>> + const struct spi_mem_op *op)
>> +{
>> + struct qpic_snand_op s_op = {};
>> + u32 cmd;
>> + int ret;
>> +
>> + cmd = qpic_snand_cmd_mapping(snandc, op->cmd.opcode);
>> +
>> + s_op.cmd_reg = cmd;
>> + s_op.addr1_reg = op->addr.val;
>> + s_op.addr2_reg = 0;
>> +
> Would a switch case be more appropriate?
Ok
>
>> + if (op->cmd.opcode == SPINAND_WRITE_EN)
>> + return 0;
>> +
>> + if (op->cmd.opcode == SPINAND_PROGRAM_EXECUTE) {
>> + s_op.addr1_reg = op->addr.val << 16;
>> + s_op.addr2_reg = op->addr.val >> 16 & 0xff;
>> + snandc->addr1 = s_op.addr1_reg;
>> + snandc->addr2 = s_op.addr2_reg;
>> + snandc->cmd = cmd;
>> + return qpic_snand_program_execute(snandc, op);
>> + }
>> +
>> + if (op->cmd.opcode == SPINAND_READ) {
>> + s_op.addr1_reg = (op->addr.val << 16);
>> + s_op.addr2_reg = op->addr.val >> 16 & 0xff;
>> + snandc->addr1 = s_op.addr1_reg;
>> + snandc->addr2 = s_op.addr2_reg;
>> + snandc->cmd = cmd;
>> + return 0;
>> + }
>> +
>> + if (op->cmd.opcode == SPINAND_ERASE) {
>> + s_op.addr2_reg = (op->addr.val >> 16) & 0xffff;
>> + s_op.addr1_reg = op->addr.val;
>> + snandc->addr1 = s_op.addr1_reg;
>> + snandc->addr1 <<= 16;
>> + snandc->addr2 = s_op.addr2_reg;
>> + snandc->cmd = cmd;
>> + qpic_snand_block_erase(snandc);
>> + return 0;
>> + }
>> +
>> + snandc->buf_count = 0;
>> + snandc->buf_start = 0;
>> + qcom_clear_read_regs(snandc);
>> + qcom_clear_bam_transaction(snandc);
>> +
>> + snandc_set_reg(snandc, NAND_FLASH_CMD, s_op.cmd_reg);
>> + snandc_set_reg(snandc, NAND_EXEC_CMD, 0x1);
>> + snandc_set_reg(snandc, NAND_ADDR0, s_op.addr1_reg);
>> + snandc_set_reg(snandc, NAND_ADDR1, s_op.addr2_reg);
>> +
>> + qcom_write_reg_dma(snandc, NAND_FLASH_CMD, 3, NAND_BAM_NEXT_SGL);
>> + qcom_write_reg_dma(snandc, NAND_EXEC_CMD, 1, NAND_BAM_NEXT_SGL);
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret)
>> + dev_err(snandc->dev, "failure in sbumitting cmd descriptor\n");
>> +
>> + return ret;
>> +}
>> +
>> +static int qpic_snand_io_op(struct qcom_nand_controller *snandc, const struct spi_mem_op *op)
>> +{
>> + int ret, val, opcode;
>> + bool copy = false, copy_ftr = false;
>> +
>> + ret = qpic_snand_send_cmdaddr(snandc, op);
>> + if (ret)
>> + return ret;
>> +
>> + snandc->buf_count = 0;
>> + snandc->buf_start = 0;
>> + qcom_clear_read_regs(snandc);
>> + qcom_clear_bam_transaction(snandc);
>> + opcode = op->cmd.opcode;
>> +
>> + switch (opcode) {
>> + case SPINAND_READID:
>> + snandc->buf_count = 4;
>> + qcom_read_reg_dma(snandc, NAND_READ_ID, 1, NAND_BAM_NEXT_SGL);
>> + copy = true;
>> + break;
>> + case SPINAND_GET_FEATURE:
>> + snandc->buf_count = 4;
>> + qcom_read_reg_dma(snandc, NAND_FLASH_FEATURES, 1, NAND_BAM_NEXT_SGL);
>> + copy_ftr = true;
>> + break;
>> + case SPINAND_SET_FEATURE:
>> + snandc_set_reg(snandc, NAND_FLASH_FEATURES, *(u32 *)op->data.buf.out);
>> + qcom_write_reg_dma(snandc, NAND_FLASH_FEATURES, 1, NAND_BAM_NEXT_SGL);
>> + break;
>> + default:
>> + return 0;
>> + }
>> +
>> + ret = qcom_submit_descs(snandc);
>> + if (ret)
>> + dev_err(snandc->dev, "failure in submitting descriptor for:%d\n", opcode);
>> +
>> + if (copy) {
>> + qcom_nandc_read_buffer_sync(snandc, true);
>> + memcpy(op->data.buf.in, snandc->reg_read_buf, snandc->buf_count);
>> + }
>> +
>> + if (copy_ftr) {
>> + qcom_nandc_read_buffer_sync(snandc, true);
>> + val = le32_to_cpu(*(__le32 *)snandc->reg_read_buf);
>> + val >>= 8;
>> + memcpy(op->data.buf.in, &val, snandc->buf_count);
>> + }
>> +
>> + return ret;
>> +}
>> +
>> +static bool qpic_snand_is_page_op(const struct spi_mem_op *op)
>> +{
>> + if (op->addr.buswidth != 1 && op->addr.buswidth != 2 && op->addr.buswidth != 4)
>> + return false;
>> +
>> + if (op->data.dir == SPI_MEM_DATA_IN) {
>> + if (op->addr.buswidth == 4 && op->data.buswidth == 4)
>> + return true;
>> +
>> + if (op->addr.nbytes == 2 && op->addr.buswidth == 1)
>> + return true;
>> +
>> + } else if (op->data.dir == SPI_MEM_DATA_OUT) {
>> + if (op->data.buswidth == 4)
>> + return true;
>> + if (op->addr.nbytes == 2 && op->addr.buswidth == 1)
>> + return true;
>> + }
>> +
>> + return false;
>> +}
>> +
>> +static bool qpic_snand_supports_op(struct spi_mem *mem, const struct spi_mem_op *op)
>> +{
>> + if (!spi_mem_default_supports_op(mem, op))
>> + return false;
>> +
>> + if (op->cmd.nbytes != 1 || op->cmd.buswidth != 1)
>> + return false;
>> +
>> + if (qpic_snand_is_page_op(op))
>> + return true;
>> +
>> + return ((op->addr.nbytes == 0 || op->addr.buswidth == 1) &&
>
> !op->addr.nbytes and so on
Ok
>
>> + (op->dummy.nbytes == 0 || op->dummy.buswidth == 1) &&
>> + (op->data.nbytes == 0 || op->data.buswidth == 1));
>> +}
>> +
>> +static int qpic_snand_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)
>> +{
>> + struct qcom_nand_controller *snandc = spi_controller_get_devdata(mem->spi->controller);
>> +
>> + dev_dbg(snandc->dev, "OP %02x ADDR %08llX@%d:%u DATA %d:%u", op->cmd.opcode,
>> + op->addr.val, op->addr.buswidth, op->addr.nbytes,
>> + op->data.buswidth, op->data.nbytes);
>> +
>> + if (qpic_snand_is_page_op(op)) {
>> + if (op->data.dir == SPI_MEM_DATA_IN)
>> + return qpic_snand_read_page_cache(snandc, op);
>> + if (op->data.dir == SPI_MEM_DATA_OUT)
>> + return qpic_snand_write_page_cache(snandc, op);
>> + } else {
>> + return qpic_snand_io_op(snandc, op);
>> + }
>> +
>> + return 0;
>> +}
>> +
>> +static const struct spi_controller_mem_ops qcom_spi_mem_ops = {
>> + .supports_op = qpic_snand_supports_op,
>> + .exec_op = qpic_snand_exec_op,
>> +};
>> +
>> +static const struct spi_controller_mem_caps qcom_snand_mem_caps = {
>> + .ecc = true,
>> +};
>> +
>> +static int qcom_snand_probe(struct platform_device *pdev)
>> +{
>> + struct device *dev = &pdev->dev;
>> + struct spi_controller *ctlr;
>> + struct qcom_nand_controller *snandc;
>> + struct resource *res;
>> + const void *dev_data;
>> + struct qpic_ecc *ecc;
>> + int ret;
>> +
>> + ecc = devm_kzalloc(dev, sizeof(*ecc), GFP_KERNEL);
>> + if (!ecc)
>> + return -ENOMEM;
>> +
>> + ctlr = __devm_spi_alloc_controller(dev, sizeof(*snandc), false);
>
> I don't know if that is legitimate, why using __devm?
This one I have added as per Mark's comment.
>
>> + if (!ctlr)
>> + return -ENOMEM;
>> +
>> + platform_set_drvdata(pdev, ctlr);
>> +
>> + snandc = spi_controller_get_devdata(ctlr);
>> +
>> + snandc->ctlr = ctlr;
>> + snandc->dev = dev;
>> + snandc->ecc = ecc;
>> +
>> + dev_data = of_device_get_match_data(dev);
>> + if (!dev_data) {
>> + dev_err(&pdev->dev, "failed to get device data\n");
>> + return -ENODEV;
>> + }
>> +
>> + snandc->props = dev_data;
>> + snandc->dev = &pdev->dev;
>> +
>> + snandc->core_clk = devm_clk_get(dev, "core");
>> + if (IS_ERR(snandc->core_clk))
>> + return PTR_ERR(snandc->core_clk);
>> +
>> + snandc->aon_clk = devm_clk_get(dev, "aon");
>> + if (IS_ERR(snandc->aon_clk))
>> + return PTR_ERR(snandc->aon_clk);
>> +
>> + snandc->iomacro_clk = devm_clk_get(dev, "iom");
>> + if (IS_ERR(snandc->iomacro_clk))
>> + return PTR_ERR(snandc->iomacro_clk);
>> +
>> + snandc->base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
>> + if (IS_ERR(snandc->base))
>> + return PTR_ERR(snandc->base);
>> +
>> + snandc->base_phys = res->start;
>> + snandc->base_dma = dma_map_resource(dev, res->start, resource_size(res),
>> + DMA_BIDIRECTIONAL, 0);
>> + if (dma_mapping_error(dev, snandc->base_dma))
>> + return -ENXIO;
>> +
>> + ret = clk_prepare_enable(snandc->core_clk);
>> + if (ret)
>> + goto err_core_clk;
>> +
>> + ret = clk_prepare_enable(snandc->aon_clk);
>> + if (ret)
>> + goto err_aon_clk;
>> +
>> + ret = clk_prepare_enable(snandc->iomacro_clk);
>> + if (ret)
>> + goto err_snandc_alloc;
>> +
>> + ret = qcom_nandc_alloc(snandc);
>> + if (ret)
>> + goto err_snandc_alloc;
>> +
>> + ret = qcom_snand_init(snandc);
>> + if (ret)
>> + goto err_init;
>> +
>> + /* setup ECC engine */
>> + snandc->ecc_eng.dev = &pdev->dev;
>> + snandc->ecc_eng.integration = NAND_ECC_ENGINE_INTEGRATION_PIPELINED;
>> + snandc->ecc_eng.ops = &qcom_snand_ecc_engine_ops_pipelined;
>> + snandc->ecc_eng.priv = snandc;
>> +
>> + ret = nand_ecc_register_on_host_hw_engine(&snandc->ecc_eng);
>> + if (ret) {
>> + dev_err(&pdev->dev, "failed to register ecc engine.\n");
>> + goto err_init;
>> + }
>> +
>> + ctlr->num_chipselect = QPIC_QSPI_NUM_CS;
>> + ctlr->mem_ops = &qcom_spi_mem_ops;
>> + ctlr->mem_caps = &qcom_snand_mem_caps;
>> + ctlr->dev.of_node = pdev->dev.of_node;
>> + ctlr->mode_bits = SPI_TX_DUAL | SPI_RX_DUAL |
>> + SPI_TX_QUAD | SPI_RX_QUAD;
>> +
>> + ret = spi_register_controller(ctlr);
>> + if (ret) {
>> + dev_err(&pdev->dev, "spi_register_controller failed.\n");
>> + goto err_init;
>> + }
>> +
>> + return 0;
>> +
>> +err_init:
>> + qcom_nandc_unalloc(snandc);
>> +err_snandc_alloc:
>> + clk_disable_unprepare(snandc->aon_clk);
>> +err_aon_clk:
>> + clk_disable_unprepare(snandc->core_clk);
>
> Don't you miss one clock ?
Ok will fix in next patch
>
>> +err_core_clk:
>> + dma_unmap_resource(dev, res->start, resource_size(res),
>> + DMA_BIDIRECTIONAL, 0);
>> + return ret;
>> +}
>> +
>> +static int qcom_snand_remove(struct platform_device *pdev)
>> +{
>> + struct spi_controller *ctlr = platform_get_drvdata(pdev);
>> + struct qcom_nand_controller *snandc = spi_controller_get_devdata(ctlr);
>> + struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
>> +
>> + spi_unregister_controller(ctlr);
>> +
>> + clk_disable_unprepare(snandc->aon_clk);
>> + clk_disable_unprepare(snandc->core_clk);
>> + clk_disable_unprepare(snandc->iomacro_clk);
>> +
>> + dma_unmap_resource(&pdev->dev, snandc->base_dma, resource_size(res),
>> + DMA_BIDIRECTIONAL, 0);
>> + return 0;
>> +}
>> +
>> +static const struct qcom_nandc_props ipq9574_snandc_props = {
>> + .dev_cmd_reg_start = 0x7000,
>> + .is_bam = true,
>
> Same comment about "is_bam"
Ok
>
>> +};
>> +
>> +static const struct of_device_id qcom_snandc_of_match[] = {
>> + {
>> + .compatible = "qcom,spi-qpic-snand",
>> + .data = &ipq9574_snandc_props,
>> + },
>> + {}
>> +}
>> +MODULE_DEVICE_TABLE(of, qcom_snandc_of_match);
>> +
>> +static struct platform_driver qcom_snand_driver = {
>> + .driver = {
>> + .name = "qcom_snand",
>> + .of_match_table = qcom_snandc_of_match,
>> + },
>> + .probe = qcom_snand_probe,
>> + .remove = qcom_snand_remove,
>> +};
>> +module_platform_driver(qcom_snand_driver);
>> +
>> +MODULE_DESCRIPTION("SPI driver for QPIC QSPI cores");
>> +MODULE_AUTHOR("Md Sadre Alam <[email protected]>");
>> +MODULE_LICENSE("GPL");
>> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
>> index aced15866627..4673cd36ff0a 100644
>> --- a/include/linux/mtd/nand-qpic-common.h
>> +++ b/include/linux/mtd/nand-qpic-common.h
>> @@ -45,6 +45,9 @@
>> #define NAND_DEV_CMD1 0xa4
>> #define NAND_DEV_CMD2 0xa8
>> #define NAND_DEV_CMD_VLD 0xac
>> +#define NAND_FLASH_SPI_CFG 0xc0
>> +#define NAND_NUM_ADDR_CYCLES 0xc4
>> +#define NAND_BUSY_CHECK_WAIT_CNT 0xc8
>
> If this is specific to the spi-nand implementation, then it's not
> common and has no reason to be shared here. Same for the other
> definitions of course.
Ok
>
>> #define SFLASHC_BURST_CFG 0xe0
>> #define NAND_ERASED_CW_DETECT_CFG 0xe8
>> #define NAND_ERASED_CW_DETECT_STATUS 0xec
>> @@ -61,6 +64,7 @@
>> #define NAND_READ_LOCATION_LAST_CW_1 0xf44
>> #define NAND_READ_LOCATION_LAST_CW_2 0xf48
>> #define NAND_READ_LOCATION_LAST_CW_3 0xf4c
>> +#define NAND_FLASH_FEATURES 0xf64
>>
>> /* dummy register offsets, used by write_reg_dma */
>> #define NAND_DEV_CMD1_RESTORE 0xdead
>> @@ -169,6 +173,7 @@
>> #define OP_CHECK_STATUS 0xc
>> #define OP_FETCH_ID 0xb
>> #define OP_RESET_DEVICE 0xd
>> +#define ACC_FEATURE 0xe
>>
>> /* Default Value for NAND_DEV_CMD_VLD */
>> #define NAND_DEV_CMD_VLD_VAL (READ_START_VLD | WRITE_START_VLD | \
>> @@ -329,11 +334,53 @@ struct nandc_regs {
>> __le32 read_location_last1;
>> __le32 read_location_last2;
>> __le32 read_location_last3;
>> + __le32 spi_cfg;
>> + __le32 num_addr_cycle;
>> + __le32 busy_wait_cnt;
>> + __le32 flash_feature;
>>
>> __le32 erased_cw_detect_cfg_clr;
>> __le32 erased_cw_detect_cfg_set;
>> };
>>
>> +struct qcom_ecc_stats {
>> + u32 corrected;
>> + u32 bitflips;
>> + u32 failed;
>> +};
>> +
>> +/*
>> + * QPIC ECC data struct
>> + *
>> + */
>> +struct qpic_ecc {
>> + struct device *dev;
>> + const struct qpic_ecc_caps *caps;
>> + struct completion done;
>> + u32 sectors;
>> + u8 *eccdata;
>> + bool use_ecc;
>> + u32 ecc_modes;
>> + int ecc_bytes_hw;
>> + int spare_bytes;
>> + int bbm_size;
>> + int ecc_mode;
>> + int bytes;
>> + int steps;
>> + int step_size;
>> + int strength;
>> + int cw_size;
>> + int cw_data;
>> + u32 cfg0, cfg1;
>> + u32 cfg0_raw, cfg1_raw;
>> + u32 ecc_buf_cfg;
>> + u32 ecc_bch_cfg;
>> + u32 clrflashstatus;
>> + u32 clrreadstatus;
>> + bool bch_enabled;
>> +};
>> +
>> +struct qpic_ecc;
>> /*
>> * NAND controller data struct
>> *
>> @@ -352,6 +399,7 @@ struct nandc_regs {
>> * initialized via DT match data
>> *
>> * @controller: base controller structure
>> + * @ctlr: spi controller structure
>> * @host_list: list containing all the chips attached to the
>> * controller
>> *
>> @@ -389,6 +437,7 @@ struct qcom_nand_controller {
>>
>> struct clk *core_clk;
>> struct clk *aon_clk;
>> + struct clk *iomacro_clk;
>>
>> struct nandc_regs *regs;
>> struct bam_transaction *bam_txn;
>> @@ -396,6 +445,7 @@ struct qcom_nand_controller {
>> const struct qcom_nandc_props *props;
>>
>> struct nand_controller controller;
>> + struct spi_controller *ctlr;
>> struct list_head host_list;
>>
>> union {
>> @@ -432,6 +482,17 @@ struct qcom_nand_controller {
>>
>> u32 cmd1, vld;
>> bool exec_opwrite;
>> + struct qpic_ecc *ecc;
>> + struct qcom_ecc_stats ecc_stats;
>> + struct nand_ecc_engine ecc_eng;
>> + u8 *wbuf;
>> + u32 wlen;
>> + u32 addr1;
>> + u32 addr2;
>> + u32 cmd;
>> + u32 num_cw;
>> + bool oob_read;
>> + bool raw;
>> };
>>
>> /*
>
>
> Thanks,
> Miquèl

Thanks for reviewing. Will address all the comments in next patch series.

Regards,
Alam.

2024-03-19 10:43:45

by Miquel Raynal

[permalink] [raw]
Subject: Re: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file

Hi,

> >> +/**
> >> + * qcom_offset_to_nandc_reg() - Get the actual offset
> >> + * @regs: pointer to nandc_reg structure
> >> + * @offset: register offset
> >> + *
> >> + * This function will reurn the actual offset for qpic controller register
> >> + */
> >> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
> >> +{
> >> + switch (offset) {
> >> + case NAND_FLASH_CMD:
> >> + return &regs->cmd;
> >> + case NAND_ADDR0:
> >> + return &regs->addr0;
> >> + case NAND_ADDR1:
> >> + return &regs->addr1;
> >> + case NAND_FLASH_CHIP_SELECT:
> >> + return &regs->chip_sel;
> >> + case NAND_EXEC_CMD:
> >> + return &regs->exec;
> >> + case NAND_FLASH_STATUS:
> >> + return &regs->clrflashstatus;
> >> + case NAND_DEV0_CFG0:
> >> + return &regs->cfg0;
> >> + case NAND_DEV0_CFG1:
> >> + return &regs->cfg1;
> >> + case NAND_DEV0_ECC_CFG:
> >> + return &regs->ecc_bch_cfg;
> >> + case NAND_READ_STATUS:
> >> + return &regs->clrreadstatus;
> >> + case NAND_DEV_CMD1:
> >> + return &regs->cmd1;
> >> + case NAND_DEV_CMD1_RESTORE:
> >> + return &regs->orig_cmd1;
> >> + case NAND_DEV_CMD_VLD:
> >> + return &regs->vld;
> >> + case NAND_DEV_CMD_VLD_RESTORE:
> >> + return &regs->orig_vld;
> >> + case NAND_EBI2_ECC_BUF_CFG:
> >> + return &regs->ecc_buf_cfg;
> >> + case NAND_READ_LOCATION_0:
> >> + return &regs->read_location0;
> >> + case NAND_READ_LOCATION_1:
> >> + return &regs->read_location1;
> >> + case NAND_READ_LOCATION_2:
> >> + return &regs->read_location2;
> >> + case NAND_READ_LOCATION_3:
> >> + return &regs->read_location3;
> >> + case NAND_READ_LOCATION_LAST_CW_0:
> >> + return &regs->read_location_last0;
> >> + case NAND_READ_LOCATION_LAST_CW_1:
> >> + return &regs->read_location_last1;
> >> + case NAND_READ_LOCATION_LAST_CW_2:
> >> + return &regs->read_location_last2;
> >> + case NAND_READ_LOCATION_LAST_CW_3:
> >> + return &regs->read_location_last3;
> >
> > Why do you need this indirection?
>
> This indirection I believe is needed by the write_reg_dma function,
> wherein a bunch of registers are modified based on a starting register.
> Can I change this in a separate cleanup series as a follow up to this?

I think it would be cleaner to make the changes I requested first and
then make a copy. I understand it is more work on your side, so if you
really prefer you can (1) make the copy and then (2) clean it all. But
please do it all in this series.

> >> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
> >> new file mode 100644
> >> index 000000000000..aced15866627
> >> --- /dev/null
> >> +++ b/include/linux/mtd/nand-qpic-common.h
> >> @@ -0,0 +1,486 @@
> >> +/* SPDX-License-Identifier: GPL-2.0 */
> >> +/*
> >> + * QCOM QPIC common APIs header file
> >> + *
> >> + * Copyright (c) 2023 Qualcomm Inc.
> >> + * Authors: Md sadre Alam <[email protected]>
> >> + * Sricharan R <[email protected]>
> >> + * Varadarajan Narayanan <[email protected]>
> >> + *
> >> + */
> >> +#ifndef __MTD_NAND_QPIC_COMMON_H__
> >> +#define __MTD_NAND_QPIC_COMMON_H__
> >> +
> >> +#include <linux/bitops.h>
> >> +#include <linux/clk.h>
> >> +#include <linux/delay.h>
> >> +#include <linux/dmaengine.h>
> >> +#include <linux/dma-mapping.h>
> >> +#include <linux/dma/qcom_adm.h>
> >> +#include <linux/dma/qcom_bam_dma.h>
> >> +#include <linux/module.h>
> >> +#include <linux/mtd/partitions.h>
> >> +#include <linux/mtd/rawnand.h>
> >
> > You really need this?
> Yes , since some generic structure used here.

Which ones? If this is a common file, you probably should not.

Thanks,
Miquèl

2024-03-19 13:15:36

by Miquel Raynal

[permalink] [raw]
Subject: Re: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file

Hi,

[email protected] wrote on Tue, 19 Mar 2024 17:46:05 +0530:

> On 3/19/2024 4:13 PM, Miquel Raynal wrote:
> > Hi,
> >
> >>>> +/**
> >>>> + * qcom_offset_to_nandc_reg() - Get the actual offset
> >>>> + * @regs: pointer to nandc_reg structure
> >>>> + * @offset: register offset
> >>>> + *
> >>>> + * This function will reurn the actual offset for qpic controller register
> >>>> + */
> >>>> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
> >>>> +{
> >>>> + switch (offset) {
> >>>> + case NAND_FLASH_CMD:
> >>>> + return &regs->cmd;
> >>>> + case NAND_ADDR0:
> >>>> + return &regs->addr0;
> >>>> + case NAND_ADDR1:
> >>>> + return &regs->addr1;
> >>>> + case NAND_FLASH_CHIP_SELECT:
> >>>> + return &regs->chip_sel;
> >>>> + case NAND_EXEC_CMD:
> >>>> + return &regs->exec;
> >>>> + case NAND_FLASH_STATUS:
> >>>> + return &regs->clrflashstatus;
> >>>> + case NAND_DEV0_CFG0:
> >>>> + return &regs->cfg0;
> >>>> + case NAND_DEV0_CFG1:
> >>>> + return &regs->cfg1;
> >>>> + case NAND_DEV0_ECC_CFG:
> >>>> + return &regs->ecc_bch_cfg;
> >>>> + case NAND_READ_STATUS:
> >>>> + return &regs->clrreadstatus;
> >>>> + case NAND_DEV_CMD1:
> >>>> + return &regs->cmd1;
> >>>> + case NAND_DEV_CMD1_RESTORE:
> >>>> + return &regs->orig_cmd1;
> >>>> + case NAND_DEV_CMD_VLD:
> >>>> + return &regs->vld;
> >>>> + case NAND_DEV_CMD_VLD_RESTORE:
> >>>> + return &regs->orig_vld;
> >>>> + case NAND_EBI2_ECC_BUF_CFG:
> >>>> + return &regs->ecc_buf_cfg;
> >>>> + case NAND_READ_LOCATION_0:
> >>>> + return &regs->read_location0;
> >>>> + case NAND_READ_LOCATION_1:
> >>>> + return &regs->read_location1;
> >>>> + case NAND_READ_LOCATION_2:
> >>>> + return &regs->read_location2;
> >>>> + case NAND_READ_LOCATION_3:
> >>>> + return &regs->read_location3;
> >>>> + case NAND_READ_LOCATION_LAST_CW_0:
> >>>> + return &regs->read_location_last0;
> >>>> + case NAND_READ_LOCATION_LAST_CW_1:
> >>>> + return &regs->read_location_last1;
> >>>> + case NAND_READ_LOCATION_LAST_CW_2:
> >>>> + return &regs->read_location_last2;
> >>>> + case NAND_READ_LOCATION_LAST_CW_3:
> >>>> + return &regs->read_location_last3;
> >>>
> >>> Why do you need this indirection?
> >>
> >> This indirection I believe is needed by the write_reg_dma function,
> >> wherein a bunch of registers are modified based on a starting register.
> >> Can I change this in a separate cleanup series as a follow up to this?
> >
> > I think it would be cleaner to make the changes I requested first and
> > then make a copy. I understand it is more work on your side, so if you
> > really prefer you can (1) make the copy and then (2) clean it all. But
> > please do it all in this series.
> Ok
> >
> >>>> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
> >>>> new file mode 100644
> >>>> index 000000000000..aced15866627
> >>>> --- /dev/null
> >>>> +++ b/include/linux/mtd/nand-qpic-common.h
> >>>> @@ -0,0 +1,486 @@
> >>>> +/* SPDX-License-Identifier: GPL-2.0 */
> >>>> +/*
> >>>> + * QCOM QPIC common APIs header file
> >>>> + *
> >>>> + * Copyright (c) 2023 Qualcomm Inc.
> >>>> + * Authors: Md sadre Alam <[email protected]>
> >>>> + * Sricharan R <[email protected]>
> >>>> + * Varadarajan Narayanan <[email protected]>
> >>>> + *
> >>>> + */
> >>>> +#ifndef __MTD_NAND_QPIC_COMMON_H__
> >>>> +#define __MTD_NAND_QPIC_COMMON_H__
> >>>> +
> >>>> +#include <linux/bitops.h>
> >>>> +#include <linux/clk.h>
> >>>> +#include <linux/delay.h>
> >>>> +#include <linux/dmaengine.h>
> >>>> +#include <linux/dma-mapping.h>
> >>>> +#include <linux/dma/qcom_adm.h>
> >>>> +#include <linux/dma/qcom_bam_dma.h>
> >>>> +#include <linux/module.h>
> >>>> +#include <linux/mtd/partitions.h>
> >>>> +#include <linux/mtd/rawnand.h>
> >>>
> >>> You really need this?
> >> Yes , since some generic structure used here.
> >
> > Which ones? If this is a common file, you probably should not.
> Since we are using this struct qcom_nand_controller { }
> for both SPI nand as well as raw nand. In this we are having this
> struct nand_controller controller member.

Maybe we should not expose qcom_nand_controller at all and just share
the minimum bits which are really common.

Thanks,
Miquèl

2024-03-20 06:35:14

by Md Sadre Alam

[permalink] [raw]
Subject: Re: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file



On 3/19/2024 6:39 PM, Miquel Raynal wrote:
> Hi,
>
> [email protected] wrote on Tue, 19 Mar 2024 17:46:05 +0530:
>
>> On 3/19/2024 4:13 PM, Miquel Raynal wrote:
>>> Hi,
>>>
>>>>>> +/**
>>>>>> + * qcom_offset_to_nandc_reg() - Get the actual offset
>>>>>> + * @regs: pointer to nandc_reg structure
>>>>>> + * @offset: register offset
>>>>>> + *
>>>>>> + * This function will reurn the actual offset for qpic controller register
>>>>>> + */
>>>>>> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
>>>>>> +{
>>>>>> + switch (offset) {
>>>>>> + case NAND_FLASH_CMD:
>>>>>> + return &regs->cmd;
>>>>>> + case NAND_ADDR0:
>>>>>> + return &regs->addr0;
>>>>>> + case NAND_ADDR1:
>>>>>> + return &regs->addr1;
>>>>>> + case NAND_FLASH_CHIP_SELECT:
>>>>>> + return &regs->chip_sel;
>>>>>> + case NAND_EXEC_CMD:
>>>>>> + return &regs->exec;
>>>>>> + case NAND_FLASH_STATUS:
>>>>>> + return &regs->clrflashstatus;
>>>>>> + case NAND_DEV0_CFG0:
>>>>>> + return &regs->cfg0;
>>>>>> + case NAND_DEV0_CFG1:
>>>>>> + return &regs->cfg1;
>>>>>> + case NAND_DEV0_ECC_CFG:
>>>>>> + return &regs->ecc_bch_cfg;
>>>>>> + case NAND_READ_STATUS:
>>>>>> + return &regs->clrreadstatus;
>>>>>> + case NAND_DEV_CMD1:
>>>>>> + return &regs->cmd1;
>>>>>> + case NAND_DEV_CMD1_RESTORE:
>>>>>> + return &regs->orig_cmd1;
>>>>>> + case NAND_DEV_CMD_VLD:
>>>>>> + return &regs->vld;
>>>>>> + case NAND_DEV_CMD_VLD_RESTORE:
>>>>>> + return &regs->orig_vld;
>>>>>> + case NAND_EBI2_ECC_BUF_CFG:
>>>>>> + return &regs->ecc_buf_cfg;
>>>>>> + case NAND_READ_LOCATION_0:
>>>>>> + return &regs->read_location0;
>>>>>> + case NAND_READ_LOCATION_1:
>>>>>> + return &regs->read_location1;
>>>>>> + case NAND_READ_LOCATION_2:
>>>>>> + return &regs->read_location2;
>>>>>> + case NAND_READ_LOCATION_3:
>>>>>> + return &regs->read_location3;
>>>>>> + case NAND_READ_LOCATION_LAST_CW_0:
>>>>>> + return &regs->read_location_last0;
>>>>>> + case NAND_READ_LOCATION_LAST_CW_1:
>>>>>> + return &regs->read_location_last1;
>>>>>> + case NAND_READ_LOCATION_LAST_CW_2:
>>>>>> + return &regs->read_location_last2;
>>>>>> + case NAND_READ_LOCATION_LAST_CW_3:
>>>>>> + return &regs->read_location_last3;
>>>>>
>>>>> Why do you need this indirection?
>>>>
>>>> This indirection I believe is needed by the write_reg_dma function,
>>>> wherein a bunch of registers are modified based on a starting register.
>>>> Can I change this in a separate cleanup series as a follow up to this?
>>>
>>> I think it would be cleaner to make the changes I requested first and
>>> then make a copy. I understand it is more work on your side, so if you
>>> really prefer you can (1) make the copy and then (2) clean it all. But
>>> please do it all in this series.
>> Ok
>>>
>>>>>> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
>>>>>> new file mode 100644
>>>>>> index 000000000000..aced15866627
>>>>>> --- /dev/null
>>>>>> +++ b/include/linux/mtd/nand-qpic-common.h
>>>>>> @@ -0,0 +1,486 @@
>>>>>> +/* SPDX-License-Identifier: GPL-2.0 */
>>>>>> +/*
>>>>>> + * QCOM QPIC common APIs header file
>>>>>> + *
>>>>>> + * Copyright (c) 2023 Qualcomm Inc.
>>>>>> + * Authors: Md sadre Alam <[email protected]>
>>>>>> + * Sricharan R <[email protected]>
>>>>>> + * Varadarajan Narayanan <[email protected]>
>>>>>> + *
>>>>>> + */
>>>>>> +#ifndef __MTD_NAND_QPIC_COMMON_H__
>>>>>> +#define __MTD_NAND_QPIC_COMMON_H__
>>>>>> +
>>>>>> +#include <linux/bitops.h>
>>>>>> +#include <linux/clk.h>
>>>>>> +#include <linux/delay.h>
>>>>>> +#include <linux/dmaengine.h>
>>>>>> +#include <linux/dma-mapping.h>
>>>>>> +#include <linux/dma/qcom_adm.h>
>>>>>> +#include <linux/dma/qcom_bam_dma.h>
>>>>>> +#include <linux/module.h>
>>>>>> +#include <linux/mtd/partitions.h>
>>>>>> +#include <linux/mtd/rawnand.h>
>>>>>
>>>>> You really need this?
>>>> Yes , since some generic structure used here.
>>>
>>> Which ones? If this is a common file, you probably should not.
>> Since we are using this struct qcom_nand_controller { }
>> for both SPI nand as well as raw nand. In this we are having this
>> struct nand_controller controller member.
>
> Maybe we should not expose qcom_nand_controller at all and just share
> the minimum bits which are really common.

Will move all the header files to .c file from nand-qpic-common.h

>
> Thanks,
> Miquèl

Thanks,
Alam.


2024-03-19 12:16:58

by Md Sadre Alam

[permalink] [raw]
Subject: Re: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file



On 3/19/2024 4:13 PM, Miquel Raynal wrote:
> Hi,
>
>>>> +/**
>>>> + * qcom_offset_to_nandc_reg() - Get the actual offset
>>>> + * @regs: pointer to nandc_reg structure
>>>> + * @offset: register offset
>>>> + *
>>>> + * This function will reurn the actual offset for qpic controller register
>>>> + */
>>>> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
>>>> +{
>>>> + switch (offset) {
>>>> + case NAND_FLASH_CMD:
>>>> + return &regs->cmd;
>>>> + case NAND_ADDR0:
>>>> + return &regs->addr0;
>>>> + case NAND_ADDR1:
>>>> + return &regs->addr1;
>>>> + case NAND_FLASH_CHIP_SELECT:
>>>> + return &regs->chip_sel;
>>>> + case NAND_EXEC_CMD:
>>>> + return &regs->exec;
>>>> + case NAND_FLASH_STATUS:
>>>> + return &regs->clrflashstatus;
>>>> + case NAND_DEV0_CFG0:
>>>> + return &regs->cfg0;
>>>> + case NAND_DEV0_CFG1:
>>>> + return &regs->cfg1;
>>>> + case NAND_DEV0_ECC_CFG:
>>>> + return &regs->ecc_bch_cfg;
>>>> + case NAND_READ_STATUS:
>>>> + return &regs->clrreadstatus;
>>>> + case NAND_DEV_CMD1:
>>>> + return &regs->cmd1;
>>>> + case NAND_DEV_CMD1_RESTORE:
>>>> + return &regs->orig_cmd1;
>>>> + case NAND_DEV_CMD_VLD:
>>>> + return &regs->vld;
>>>> + case NAND_DEV_CMD_VLD_RESTORE:
>>>> + return &regs->orig_vld;
>>>> + case NAND_EBI2_ECC_BUF_CFG:
>>>> + return &regs->ecc_buf_cfg;
>>>> + case NAND_READ_LOCATION_0:
>>>> + return &regs->read_location0;
>>>> + case NAND_READ_LOCATION_1:
>>>> + return &regs->read_location1;
>>>> + case NAND_READ_LOCATION_2:
>>>> + return &regs->read_location2;
>>>> + case NAND_READ_LOCATION_3:
>>>> + return &regs->read_location3;
>>>> + case NAND_READ_LOCATION_LAST_CW_0:
>>>> + return &regs->read_location_last0;
>>>> + case NAND_READ_LOCATION_LAST_CW_1:
>>>> + return &regs->read_location_last1;
>>>> + case NAND_READ_LOCATION_LAST_CW_2:
>>>> + return &regs->read_location_last2;
>>>> + case NAND_READ_LOCATION_LAST_CW_3:
>>>> + return &regs->read_location_last3;
>>>
>>> Why do you need this indirection?
>>
>> This indirection I believe is needed by the write_reg_dma function,
>> wherein a bunch of registers are modified based on a starting register.
>> Can I change this in a separate cleanup series as a follow up to this?
>
> I think it would be cleaner to make the changes I requested first and
> then make a copy. I understand it is more work on your side, so if you
> really prefer you can (1) make the copy and then (2) clean it all. But
> please do it all in this series.
Ok
>
>>>> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
>>>> new file mode 100644
>>>> index 000000000000..aced15866627
>>>> --- /dev/null
>>>> +++ b/include/linux/mtd/nand-qpic-common.h
>>>> @@ -0,0 +1,486 @@
>>>> +/* SPDX-License-Identifier: GPL-2.0 */
>>>> +/*
>>>> + * QCOM QPIC common APIs header file
>>>> + *
>>>> + * Copyright (c) 2023 Qualcomm Inc.
>>>> + * Authors: Md sadre Alam <[email protected]>
>>>> + * Sricharan R <[email protected]>
>>>> + * Varadarajan Narayanan <[email protected]>
>>>> + *
>>>> + */
>>>> +#ifndef __MTD_NAND_QPIC_COMMON_H__
>>>> +#define __MTD_NAND_QPIC_COMMON_H__
>>>> +
>>>> +#include <linux/bitops.h>
>>>> +#include <linux/clk.h>
>>>> +#include <linux/delay.h>
>>>> +#include <linux/dmaengine.h>
>>>> +#include <linux/dma-mapping.h>
>>>> +#include <linux/dma/qcom_adm.h>
>>>> +#include <linux/dma/qcom_bam_dma.h>
>>>> +#include <linux/module.h>
>>>> +#include <linux/mtd/partitions.h>
>>>> +#include <linux/mtd/rawnand.h>
>>>
>>> You really need this?
>> Yes , since some generic structure used here.
>
> Which ones? If this is a common file, you probably should not.
Since we are using this struct qcom_nand_controller { }
for both SPI nand as well as raw nand. In this we are having this
struct nand_controller controller member.
>
> Thanks,
> Miquèl

Thanks,
Alam.

2024-03-19 10:26:37

by Md Sadre Alam

[permalink] [raw]
Subject: Re: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file



On 3/15/2024 5:15 PM, Miquel Raynal wrote:
> Hello,
>
>> +/**
>> + * qcom_qpic_bam_dma_done() - Callback for DMA descriptor completion
>> + * @data: data pointer
>> + *
>> + * This function is a callback for DMA descriptor completion
>> + */
>> +void qcom_qpic_bam_dma_done(void *data)
>> +{
>> + struct bam_transaction *bam_txn = data;
>> +
>> + /*
>> + * In case of data transfer with NAND, 2 callbacks will be generated.
>> + * One for command channel and another one for data channel.
>> + * If current transaction has data descriptors
>> + * (i.e. wait_second_completion is true), then set this to false
>> + * and wait for second DMA descriptor completion.
>> + */
>> + if (bam_txn->wait_second_completion)
>> + bam_txn->wait_second_completion = false;
>> + else
>> + complete(&bam_txn->txn_done);
>
> Can't you just call "wait" and "complete" twice? It's supposed to be
> handled by the API. This is totally racy.
Ok
>
>> +}
>> +
>> +/**
>> + * qcom_nandc_read_buffer_sync() - Check for dma sync for cpu or device
>> + * @nandc: qpic nand controller
>> + * @is_cpu: cpu or Device
>
> ? the naming is really strange dev_to_mem or something like that would
> probably be more helpful.
Ok
>
>> + *
>> + * This function will check for dma sync for cpu or device
>> + */
>> +void qcom_nandc_read_buffer_sync(struct qcom_nand_controller *nandc,
>> + bool is_cpu)
>> +{
>> + if (!nandc->props->is_bam)
>> + return;
>> +
>> + if (is_cpu)
>> + dma_sync_single_for_cpu(nandc->dev, nandc->reg_read_dma,
>> + MAX_REG_RD *
>> + sizeof(*nandc->reg_read_buf),
>> + DMA_FROM_DEVICE);
>> + else
>> + dma_sync_single_for_device(nandc->dev, nandc->reg_read_dma,
>> + MAX_REG_RD *
>> + sizeof(*nandc->reg_read_buf),
>> + DMA_FROM_DEVICE);
>> +}
>> +
>> +/**
>> + * qcom_offset_to_nandc_reg() - Get the actual offset
>> + * @regs: pointer to nandc_reg structure
>> + * @offset: register offset
>> + *
>> + * This function will reurn the actual offset for qpic controller register
>> + */
>> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
>> +{
>> + switch (offset) {
>> + case NAND_FLASH_CMD:
>> + return &regs->cmd;
>> + case NAND_ADDR0:
>> + return &regs->addr0;
>> + case NAND_ADDR1:
>> + return &regs->addr1;
>> + case NAND_FLASH_CHIP_SELECT:
>> + return &regs->chip_sel;
>> + case NAND_EXEC_CMD:
>> + return &regs->exec;
>> + case NAND_FLASH_STATUS:
>> + return &regs->clrflashstatus;
>> + case NAND_DEV0_CFG0:
>> + return &regs->cfg0;
>> + case NAND_DEV0_CFG1:
>> + return &regs->cfg1;
>> + case NAND_DEV0_ECC_CFG:
>> + return &regs->ecc_bch_cfg;
>> + case NAND_READ_STATUS:
>> + return &regs->clrreadstatus;
>> + case NAND_DEV_CMD1:
>> + return &regs->cmd1;
>> + case NAND_DEV_CMD1_RESTORE:
>> + return &regs->orig_cmd1;
>> + case NAND_DEV_CMD_VLD:
>> + return &regs->vld;
>> + case NAND_DEV_CMD_VLD_RESTORE:
>> + return &regs->orig_vld;
>> + case NAND_EBI2_ECC_BUF_CFG:
>> + return &regs->ecc_buf_cfg;
>> + case NAND_READ_LOCATION_0:
>> + return &regs->read_location0;
>> + case NAND_READ_LOCATION_1:
>> + return &regs->read_location1;
>> + case NAND_READ_LOCATION_2:
>> + return &regs->read_location2;
>> + case NAND_READ_LOCATION_3:
>> + return &regs->read_location3;
>> + case NAND_READ_LOCATION_LAST_CW_0:
>> + return &regs->read_location_last0;
>> + case NAND_READ_LOCATION_LAST_CW_1:
>> + return &regs->read_location_last1;
>> + case NAND_READ_LOCATION_LAST_CW_2:
>> + return &regs->read_location_last2;
>> + case NAND_READ_LOCATION_LAST_CW_3:
>> + return &regs->read_location_last3;
>
> Why do you need this indirection?

This indirection I believe is needed by the write_reg_dma function,
wherein a bunch of registers are modified based on a starting register.
Can I change this in a separate cleanup series as a follow up to this?

>
>> + default:
>> + return NULL;
>> + }
>> +}
>> +
>
> ...
>
>> +/**
>> + * qcom_clear_bam_transaction() - Clears the BAM transaction
>> + * @nandc: qpic nand controller
>> + *
>> + * This function will clear the BAM transaction indexes.
>> + */
>> +void qcom_clear_bam_transaction(struct qcom_nand_controller *nandc)
>> +{
>> + struct bam_transaction *bam_txn = nandc->bam_txn;
>> +
>> + if (!nandc->props->is_bam)
>> + return;
>> +
>> + bam_txn->bam_ce_pos = 0;
>> + bam_txn->bam_ce_start = 0;
>> + bam_txn->cmd_sgl_pos = 0;
>> + bam_txn->cmd_sgl_start = 0;
>> + bam_txn->tx_sgl_pos = 0;
>> + bam_txn->tx_sgl_start = 0;
>> + bam_txn->rx_sgl_pos = 0;
>> + bam_txn->rx_sgl_start = 0;
>> + bam_txn->last_data_desc = NULL;
>> + bam_txn->wait_second_completion = false;
>
> What about using memset here?
Ok
>
>> +
>> + sg_init_table(bam_txn->cmd_sgl, nandc->max_cwperpage *
>> + QPIC_PER_CW_CMD_SGL);
>> + sg_init_table(bam_txn->data_sgl, nandc->max_cwperpage *
>> + QPIC_PER_CW_DATA_SGL);
>> +
>> + reinit_completion(&bam_txn->txn_done);
>> +}
>
> ...
>
>> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
>> new file mode 100644
>> index 000000000000..aced15866627
>> --- /dev/null
>> +++ b/include/linux/mtd/nand-qpic-common.h
>> @@ -0,0 +1,486 @@
>> +/* SPDX-License-Identifier: GPL-2.0 */
>> +/*
>> + * QCOM QPIC common APIs header file
>> + *
>> + * Copyright (c) 2023 Qualcomm Inc.
>> + * Authors: Md sadre Alam <[email protected]>
>> + * Sricharan R <[email protected]>
>> + * Varadarajan Narayanan <[email protected]>
>> + *
>> + */
>> +#ifndef __MTD_NAND_QPIC_COMMON_H__
>> +#define __MTD_NAND_QPIC_COMMON_H__
>> +
>> +#include <linux/bitops.h>
>> +#include <linux/clk.h>
>> +#include <linux/delay.h>
>> +#include <linux/dmaengine.h>
>> +#include <linux/dma-mapping.h>
>> +#include <linux/dma/qcom_adm.h>
>> +#include <linux/dma/qcom_bam_dma.h>
>> +#include <linux/module.h>
>> +#include <linux/mtd/partitions.h>
>> +#include <linux/mtd/rawnand.h>
>
> You really need this?
Yes , since some generic structure used here.
>
>> +#include <linux/of.h>
>> +#include <linux/platform_device.h>
>> +#include <linux/slab.h>
>> +
>> +/* NANDc reg offsets */
>> +#define NAND_FLASH_CMD 0x00
>> +#define NAND_ADDR0 0x04
>> +#define NAND_ADDR1 0x08
>> +#define NAND_FLASH_CHIP_SELECT 0x0c
>> +#define NAND_EXEC_CMD 0x10
>> +#define NAND_FLASH_STATUS 0x14
>> +#define NAND_BUFFER_STATUS 0x18
>> +#define NAND_DEV0_CFG0 0x20
>> +#define NAND_DEV0_CFG1 0x24
>> +#define NAND_DEV0_ECC_CFG 0x28
>> +#define NAND_AUTO_STATUS_EN 0x2c
>> +#define NAND_DEV1_CFG0 0x30
>> +#define NAND_DEV1_CFG1 0x34
>> +#define NAND_READ_ID 0x40
>> +#define NAND_READ_STATUS 0x44
>> +#define NAND_DEV_CMD0 0xa0
>> +#define NAND_DEV_CMD1 0xa4
>> +#define NAND_DEV_CMD2 0xa8
>> +#define NAND_DEV_CMD_VLD 0xac
>> +#define SFLASHC_BURST_CFG 0xe0
>> +#define NAND_ERASED_CW_DETECT_CFG 0xe8
>> +#define NAND_ERASED_CW_DETECT_STATUS 0xec
>> +#define NAND_EBI2_ECC_BUF_CFG 0xf0
>> +#define FLASH_BUF_ACC 0x100
>> +
>
> ...
>
>> +/*
>> + * This data type corresponds to the NAND controller properties which varies
>> + * among different NAND controllers.
>> + * @ecc_modes - ecc mode for NAND
>
> Should this member be an enum?
Ok , Will fix in next patch
>
>> + * @dev_cmd_reg_start - NAND_DEV_CMD_* registers starting offset
>> + * @is_bam - whether NAND controller is using BAM
>
> has_bam_support? supports_bam?
Ok
>
>> + * @is_qpic - whether NAND CTRL is part of qpic IP
>
> CTRL? do you mean controller?
Yes.
>
>> + * @qpic_v2 - flag to indicate QPIC IP version 2
>> + * @use_codeword_fixup - whether NAND has different layout for boot partitions
>
> The doc is clear but the member name is terrible. Please clarify the
> naming.
Ok
>
>> + */
>> +struct qcom_nandc_props {
>> + u32 ecc_modes;
>> + u32 dev_cmd_reg_start;
>> + bool is_bam;
>> + bool is_qpic;
>> + bool qpic_v2;
>> + bool use_codeword_fixup;
>> +};
>> +
>> +void config_nand_page_read(struct nand_chip *chip);
>> +void qcom_qpic_bam_dma_done(void *data);
>> +void qcom_nandc_read_buffer_sync(struct qcom_nand_controller *nandc, bool is_cpu);
>> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset);
>> +int qcom_prep_adm_dma_desc(struct qcom_nand_controller *nandc, bool read,
>> + int reg_off, const void *vaddr, int size,
>> + bool flow_control);
>> +int qcom_submit_descs(struct qcom_nand_controller *nandc);
>> +int qcom_prepare_bam_async_desc(struct qcom_nand_controller *nandc,
>> + struct dma_chan *chan, unsigned long flags);
>> +int qcom_prep_bam_dma_desc_cmd(struct qcom_nand_controller *nandc, bool read,
>> + int reg_off, const void *vaddr,
>> + int size, unsigned int flags);
>> +int qcom_prep_bam_dma_desc_data(struct qcom_nand_controller *nandc, bool read,
>> + const void *vaddr,
>> + int size, unsigned int flags);
>> +int qcom_read_reg_dma(struct qcom_nand_controller *nandc, int first,
>> + int num_regs, unsigned int flags);
>> +int qcom_write_reg_dma(struct qcom_nand_controller *nandc, int first,
>> + int num_regs, unsigned int flags);
>> +int qcom_read_data_dma(struct qcom_nand_controller *nandc, int reg_off,
>> + const u8 *vaddr, int size, unsigned int flags);
>> +int qcom_write_data_dma(struct qcom_nand_controller *nandc, int reg_off,
>> + const u8 *vaddr, int size, unsigned int flags);
>> +struct bam_transaction *qcom_alloc_bam_transaction(struct qcom_nand_controller *nandc);
>> +void qcom_clear_bam_transaction(struct qcom_nand_controller *nandc);
>> +void qcom_nandc_unalloc(struct qcom_nand_controller *nandc);
>> +int qcom_nandc_alloc(struct qcom_nand_controller *nandc);
>> +void qcom_clear_read_regs(struct qcom_nand_controller *nandc);
>> +void qcom_free_bam_transaction(struct qcom_nand_controller *nandc);
>> +#endif
>
> I made several requests on code that already exists, please add these
> changes to your series.
ok
>
>
> Also, this patching being big, please split:
> 1- rename your all your symbols to start with the same prefix
> (qcom_nand_ instead of nothing or just qcom)
Ok
> 2- then perform the move, which should not require changing the names
> of all the functions everywhere.
Ok
>
> Thanks,
> Miquèl

Thanks for reviewing. Will address all the comments in next patch series.

Reagrds,
Alam.

2024-03-15 11:45:39

by Miquel Raynal

[permalink] [raw]
Subject: Re: [PATCH v4 2/5] drivers: mtd: nand: Add qpic_common API file

Hello,

> +/**
> + * qcom_qpic_bam_dma_done() - Callback for DMA descriptor completion
> + * @data: data pointer
> + *
> + * This function is a callback for DMA descriptor completion
> + */
> +void qcom_qpic_bam_dma_done(void *data)
> +{
> + struct bam_transaction *bam_txn = data;
> +
> + /*
> + * In case of data transfer with NAND, 2 callbacks will be generated.
> + * One for command channel and another one for data channel.
> + * If current transaction has data descriptors
> + * (i.e. wait_second_completion is true), then set this to false
> + * and wait for second DMA descriptor completion.
> + */
> + if (bam_txn->wait_second_completion)
> + bam_txn->wait_second_completion = false;
> + else
> + complete(&bam_txn->txn_done);

Can't you just call "wait" and "complete" twice? It's supposed to be
handled by the API. This is totally racy.

> +}
> +
> +/**
> + * qcom_nandc_read_buffer_sync() - Check for dma sync for cpu or device
> + * @nandc: qpic nand controller
> + * @is_cpu: cpu or Device

? the naming is really strange dev_to_mem or something like that would
probably be more helpful.

> + *
> + * This function will check for dma sync for cpu or device
> + */
> +void qcom_nandc_read_buffer_sync(struct qcom_nand_controller *nandc,
> + bool is_cpu)
> +{
> + if (!nandc->props->is_bam)
> + return;
> +
> + if (is_cpu)
> + dma_sync_single_for_cpu(nandc->dev, nandc->reg_read_dma,
> + MAX_REG_RD *
> + sizeof(*nandc->reg_read_buf),
> + DMA_FROM_DEVICE);
> + else
> + dma_sync_single_for_device(nandc->dev, nandc->reg_read_dma,
> + MAX_REG_RD *
> + sizeof(*nandc->reg_read_buf),
> + DMA_FROM_DEVICE);
> +}
> +
> +/**
> + * qcom_offset_to_nandc_reg() - Get the actual offset
> + * @regs: pointer to nandc_reg structure
> + * @offset: register offset
> + *
> + * This function will reurn the actual offset for qpic controller register
> + */
> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset)
> +{
> + switch (offset) {
> + case NAND_FLASH_CMD:
> + return &regs->cmd;
> + case NAND_ADDR0:
> + return &regs->addr0;
> + case NAND_ADDR1:
> + return &regs->addr1;
> + case NAND_FLASH_CHIP_SELECT:
> + return &regs->chip_sel;
> + case NAND_EXEC_CMD:
> + return &regs->exec;
> + case NAND_FLASH_STATUS:
> + return &regs->clrflashstatus;
> + case NAND_DEV0_CFG0:
> + return &regs->cfg0;
> + case NAND_DEV0_CFG1:
> + return &regs->cfg1;
> + case NAND_DEV0_ECC_CFG:
> + return &regs->ecc_bch_cfg;
> + case NAND_READ_STATUS:
> + return &regs->clrreadstatus;
> + case NAND_DEV_CMD1:
> + return &regs->cmd1;
> + case NAND_DEV_CMD1_RESTORE:
> + return &regs->orig_cmd1;
> + case NAND_DEV_CMD_VLD:
> + return &regs->vld;
> + case NAND_DEV_CMD_VLD_RESTORE:
> + return &regs->orig_vld;
> + case NAND_EBI2_ECC_BUF_CFG:
> + return &regs->ecc_buf_cfg;
> + case NAND_READ_LOCATION_0:
> + return &regs->read_location0;
> + case NAND_READ_LOCATION_1:
> + return &regs->read_location1;
> + case NAND_READ_LOCATION_2:
> + return &regs->read_location2;
> + case NAND_READ_LOCATION_3:
> + return &regs->read_location3;
> + case NAND_READ_LOCATION_LAST_CW_0:
> + return &regs->read_location_last0;
> + case NAND_READ_LOCATION_LAST_CW_1:
> + return &regs->read_location_last1;
> + case NAND_READ_LOCATION_LAST_CW_2:
> + return &regs->read_location_last2;
> + case NAND_READ_LOCATION_LAST_CW_3:
> + return &regs->read_location_last3;

Why do you need this indirection?

> + default:
> + return NULL;
> + }
> +}
> +

..

> +/**
> + * qcom_clear_bam_transaction() - Clears the BAM transaction
> + * @nandc: qpic nand controller
> + *
> + * This function will clear the BAM transaction indexes.
> + */
> +void qcom_clear_bam_transaction(struct qcom_nand_controller *nandc)
> +{
> + struct bam_transaction *bam_txn = nandc->bam_txn;
> +
> + if (!nandc->props->is_bam)
> + return;
> +
> + bam_txn->bam_ce_pos = 0;
> + bam_txn->bam_ce_start = 0;
> + bam_txn->cmd_sgl_pos = 0;
> + bam_txn->cmd_sgl_start = 0;
> + bam_txn->tx_sgl_pos = 0;
> + bam_txn->tx_sgl_start = 0;
> + bam_txn->rx_sgl_pos = 0;
> + bam_txn->rx_sgl_start = 0;
> + bam_txn->last_data_desc = NULL;
> + bam_txn->wait_second_completion = false;

What about using memset here?

> +
> + sg_init_table(bam_txn->cmd_sgl, nandc->max_cwperpage *
> + QPIC_PER_CW_CMD_SGL);
> + sg_init_table(bam_txn->data_sgl, nandc->max_cwperpage *
> + QPIC_PER_CW_DATA_SGL);
> +
> + reinit_completion(&bam_txn->txn_done);
> +}

..

> diff --git a/include/linux/mtd/nand-qpic-common.h b/include/linux/mtd/nand-qpic-common.h
> new file mode 100644
> index 000000000000..aced15866627
> --- /dev/null
> +++ b/include/linux/mtd/nand-qpic-common.h
> @@ -0,0 +1,486 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +/*
> + * QCOM QPIC common APIs header file
> + *
> + * Copyright (c) 2023 Qualcomm Inc.
> + * Authors: Md sadre Alam <[email protected]>
> + * Sricharan R <[email protected]>
> + * Varadarajan Narayanan <[email protected]>
> + *
> + */
> +#ifndef __MTD_NAND_QPIC_COMMON_H__
> +#define __MTD_NAND_QPIC_COMMON_H__
> +
> +#include <linux/bitops.h>
> +#include <linux/clk.h>
> +#include <linux/delay.h>
> +#include <linux/dmaengine.h>
> +#include <linux/dma-mapping.h>
> +#include <linux/dma/qcom_adm.h>
> +#include <linux/dma/qcom_bam_dma.h>
> +#include <linux/module.h>
> +#include <linux/mtd/partitions.h>
> +#include <linux/mtd/rawnand.h>

You really need this?

> +#include <linux/of.h>
> +#include <linux/platform_device.h>
> +#include <linux/slab.h>
> +
> +/* NANDc reg offsets */
> +#define NAND_FLASH_CMD 0x00
> +#define NAND_ADDR0 0x04
> +#define NAND_ADDR1 0x08
> +#define NAND_FLASH_CHIP_SELECT 0x0c
> +#define NAND_EXEC_CMD 0x10
> +#define NAND_FLASH_STATUS 0x14
> +#define NAND_BUFFER_STATUS 0x18
> +#define NAND_DEV0_CFG0 0x20
> +#define NAND_DEV0_CFG1 0x24
> +#define NAND_DEV0_ECC_CFG 0x28
> +#define NAND_AUTO_STATUS_EN 0x2c
> +#define NAND_DEV1_CFG0 0x30
> +#define NAND_DEV1_CFG1 0x34
> +#define NAND_READ_ID 0x40
> +#define NAND_READ_STATUS 0x44
> +#define NAND_DEV_CMD0 0xa0
> +#define NAND_DEV_CMD1 0xa4
> +#define NAND_DEV_CMD2 0xa8
> +#define NAND_DEV_CMD_VLD 0xac
> +#define SFLASHC_BURST_CFG 0xe0
> +#define NAND_ERASED_CW_DETECT_CFG 0xe8
> +#define NAND_ERASED_CW_DETECT_STATUS 0xec
> +#define NAND_EBI2_ECC_BUF_CFG 0xf0
> +#define FLASH_BUF_ACC 0x100
> +

..

> +/*
> + * This data type corresponds to the NAND controller properties which varies
> + * among different NAND controllers.
> + * @ecc_modes - ecc mode for NAND

Should this member be an enum?

> + * @dev_cmd_reg_start - NAND_DEV_CMD_* registers starting offset
> + * @is_bam - whether NAND controller is using BAM

has_bam_support? supports_bam?

> + * @is_qpic - whether NAND CTRL is part of qpic IP

CTRL? do you mean controller?

> + * @qpic_v2 - flag to indicate QPIC IP version 2
> + * @use_codeword_fixup - whether NAND has different layout for boot partitions

The doc is clear but the member name is terrible. Please clarify the
naming.

> + */
> +struct qcom_nandc_props {
> + u32 ecc_modes;
> + u32 dev_cmd_reg_start;
> + bool is_bam;
> + bool is_qpic;
> + bool qpic_v2;
> + bool use_codeword_fixup;
> +};
> +
> +void config_nand_page_read(struct nand_chip *chip);
> +void qcom_qpic_bam_dma_done(void *data);
> +void qcom_nandc_read_buffer_sync(struct qcom_nand_controller *nandc, bool is_cpu);
> +__le32 *qcom_offset_to_nandc_reg(struct nandc_regs *regs, int offset);
> +int qcom_prep_adm_dma_desc(struct qcom_nand_controller *nandc, bool read,
> + int reg_off, const void *vaddr, int size,
> + bool flow_control);
> +int qcom_submit_descs(struct qcom_nand_controller *nandc);
> +int qcom_prepare_bam_async_desc(struct qcom_nand_controller *nandc,
> + struct dma_chan *chan, unsigned long flags);
> +int qcom_prep_bam_dma_desc_cmd(struct qcom_nand_controller *nandc, bool read,
> + int reg_off, const void *vaddr,
> + int size, unsigned int flags);
> +int qcom_prep_bam_dma_desc_data(struct qcom_nand_controller *nandc, bool read,
> + const void *vaddr,
> + int size, unsigned int flags);
> +int qcom_read_reg_dma(struct qcom_nand_controller *nandc, int first,
> + int num_regs, unsigned int flags);
> +int qcom_write_reg_dma(struct qcom_nand_controller *nandc, int first,
> + int num_regs, unsigned int flags);
> +int qcom_read_data_dma(struct qcom_nand_controller *nandc, int reg_off,
> + const u8 *vaddr, int size, unsigned int flags);
> +int qcom_write_data_dma(struct qcom_nand_controller *nandc, int reg_off,
> + const u8 *vaddr, int size, unsigned int flags);
> +struct bam_transaction *qcom_alloc_bam_transaction(struct qcom_nand_controller *nandc);
> +void qcom_clear_bam_transaction(struct qcom_nand_controller *nandc);
> +void qcom_nandc_unalloc(struct qcom_nand_controller *nandc);
> +int qcom_nandc_alloc(struct qcom_nand_controller *nandc);
> +void qcom_clear_read_regs(struct qcom_nand_controller *nandc);
> +void qcom_free_bam_transaction(struct qcom_nand_controller *nandc);
> +#endif

I made several requests on code that already exists, please add these
changes to your series.


Also, this patching being big, please split:
1- rename your all your symbols to start with the same prefix
(qcom_nand_ instead of nothing or just qcom)
2- then perform the move, which should not require changing the names
of all the functions everywhere.

Thanks,
Miquèl

2024-04-07 17:48:53

by Alexandru Gagniuc

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support

On 3/8/24 03:17, Md Sadre Alam wrote:
> Add qpic spi nand driver support. The spi nand
> driver currently supported the below commands.
>
> -- RESET
> -- READ ID
> -- SET FEATURE
> -- GET FEATURE
> -- READ PAGE
> -- WRITE PAGE
> -- ERASE PAGE
>
> Co-developed-by: Sricharan Ramabadhran <[email protected]>
> Signed-off-by: Sricharan Ramabadhran <[email protected]>
> Co-developed-by: Varadarajan Narayanan <[email protected]>
> Signed-off-by: Varadarajan Narayanan <[email protected]>
> Signed-off-by: Md Sadre Alam <[email protected]>
> ---

For the entire series:

Tested-by: Alexandru Gagniuc <[email protected]>

> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
> index bc7021da2fe9..63764e943d82 100644
> --- a/drivers/spi/Kconfig
> +++ b/drivers/spi/Kconfig
> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
> help
> QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>
> +config SPI_QPIC_SNAND
> + tristate "QPIC SNAND controller"
> + depends on ARCH_QCOM || COMPILE_TEST

Here, it needs to 'select QPIC_COMMON`. Otherwise it can run into
unresolved symbols:

: drivers/spi/spi-qpic-snand.o: in function `snandc_set_reg':
drivers/spi/spi-qpic-snand.c:56:(.text+0x484): undefined reference to
`qcom_offset_to_nandc_reg'
..

> + help
> + QPIC_SNAND (QPIC SPI NAND) driver for Qualcomm QPIC controller.
> + QPIC controller supports both parallel nand and serial nand.
> + This config will enable serial nand driver for QPIC controller.
> +
> config SPI_QUP
> tristate "Qualcomm SPI controller with QUP interface"
> depends on ARCH_QCOM || COMPILE_TEST

Alex

2024-04-07 18:40:34

by Alexandru Gagniuc

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support



On 4/7/24 12:48, Alex G. wrote:
> On 3/8/24 03:17, Md Sadre Alam wrote:
>> Add qpic spi nand driver support. The spi nand
>> driver currently supported the below commands.
>>
>> -- RESET
>> -- READ ID
>> -- SET FEATURE
>> -- GET FEATURE
>> -- READ PAGE
>> -- WRITE PAGE
>> -- ERASE PAGE
>>
>> Co-developed-by: Sricharan Ramabadhran <[email protected]>
>> Signed-off-by: Sricharan Ramabadhran <[email protected]>
>> Co-developed-by: Varadarajan Narayanan <[email protected]>
>> Signed-off-by: Varadarajan Narayanan <[email protected]>
>> Signed-off-by: Md Sadre Alam <[email protected]>
>> ---
>
> For the entire series:
>
> Tested-by: Alexandru Gagniuc <[email protected]>
>
>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>> index bc7021da2fe9..63764e943d82 100644
>> --- a/drivers/spi/Kconfig
>> +++ b/drivers/spi/Kconfig
>> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
>>       help
>>         QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>> +config SPI_QPIC_SNAND
>> +    tristate "QPIC SNAND controller"

Also, don't tristate this. It can be set as CONFIG_QPIC_COMMON=m, which
will cause the build to fail because you don't have a MODULE_LICENSE().

>> +    depends on ARCH_QCOM || COMPILE_TEST
>
> Here, it needs to 'select QPIC_COMMON`. Otherwise it can run into
> unresolved symbols:
>
> : drivers/spi/spi-qpic-snand.o: in function `snandc_set_reg':
>  drivers/spi/spi-qpic-snand.c:56:(.text+0x484): undefined reference to
> `qcom_offset_to_nandc_reg'
> ...
>
>> +    help
>> +      QPIC_SNAND (QPIC SPI NAND) driver for Qualcomm QPIC controller.
>> +      QPIC controller supports both parallel nand and serial nand.
>> +      This config will enable serial nand driver for QPIC controller.
>> +
>>   config SPI_QUP
>>       tristate "Qualcomm SPI controller with QUP interface"
>>       depends on ARCH_QCOM || COMPILE_TEST
>
> Alex
Alex

2024-04-07 18:46:06

by Alexandru Gagniuc

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support



On 4/7/24 13:40, Alex G. wrote:
>
>
> On 4/7/24 12:48, Alex G. wrote:
>> On 3/8/24 03:17, Md Sadre Alam wrote:
>>> Add qpic spi nand driver support. The spi nand
>>> driver currently supported the below commands.
>>>
>>> -- RESET
>>> -- READ ID
>>> -- SET FEATURE
>>> -- GET FEATURE
>>> -- READ PAGE
>>> -- WRITE PAGE
>>> -- ERASE PAGE
>>>
>>> Co-developed-by: Sricharan Ramabadhran <[email protected]>
>>> Signed-off-by: Sricharan Ramabadhran <[email protected]>
>>> Co-developed-by: Varadarajan Narayanan <[email protected]>
>>> Signed-off-by: Varadarajan Narayanan <[email protected]>
>>> Signed-off-by: Md Sadre Alam <[email protected]>
>>> ---
>>
>> For the entire series:
>>
>> Tested-by: Alexandru Gagniuc <[email protected]>
>>
>>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>>> index bc7021da2fe9..63764e943d82 100644
>>> --- a/drivers/spi/Kconfig
>>> +++ b/drivers/spi/Kconfig
>>> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
>>>       help
>>>         QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>>> +config SPI_QPIC_SNAND
>>> +    tristate "QPIC SNAND controller"
>
> Also, don't tristate this. It can be set as CONFIG_QPIC_COMMON=m, which
> will cause the build to fail because you don't have a MODULE_LICENSE().

Please disregard my idiotic suggestion here. I meant to make this
comment on the previous patch.

>>> +    depends on ARCH_QCOM || COMPILE_TEST
>>
>> Here, it needs to 'select QPIC_COMMON`. Otherwise it can run into
>> unresolved symbols:
>>
>> : drivers/spi/spi-qpic-snand.o: in function `snandc_set_reg':
>>   drivers/spi/spi-qpic-snand.c:56:(.text+0x484): undefined reference
>> to `qcom_offset_to_nandc_reg'
>> ...
>>
>>> +    help
>>> +      QPIC_SNAND (QPIC SPI NAND) driver for Qualcomm QPIC controller.
>>> +      QPIC controller supports both parallel nand and serial nand.
>>> +      This config will enable serial nand driver for QPIC controller.
>>> +
>>>   config SPI_QUP
>>>       tristate "Qualcomm SPI controller with QUP interface"
>>>       depends on ARCH_QCOM || COMPILE_TEST
>>
>> Alex
> Alex

2024-04-07 18:55:05

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support

On 07/04/2024 19:48, Alex G. wrote:
> On 3/8/24 03:17, Md Sadre Alam wrote:
>> Add qpic spi nand driver support. The spi nand
>> driver currently supported the below commands.
>>
>> -- RESET
>> -- READ ID
>> -- SET FEATURE
>> -- GET FEATURE
>> -- READ PAGE
>> -- WRITE PAGE
>> -- ERASE PAGE
>>
>> Co-developed-by: Sricharan Ramabadhran <[email protected]>
>> Signed-off-by: Sricharan Ramabadhran <[email protected]>
>> Co-developed-by: Varadarajan Narayanan <[email protected]>
>> Signed-off-by: Varadarajan Narayanan <[email protected]>
>> Signed-off-by: Md Sadre Alam <[email protected]>
>> ---
>
> For the entire series:
>
> Tested-by: Alexandru Gagniuc <[email protected]>
>
>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>> index bc7021da2fe9..63764e943d82 100644
>> --- a/drivers/spi/Kconfig
>> +++ b/drivers/spi/Kconfig
>> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
>> help
>> QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>>
>> +config SPI_QPIC_SNAND
>> + tristate "QPIC SNAND controller"
>> + depends on ARCH_QCOM || COMPILE_TEST
>
> Here, it needs to 'select QPIC_COMMON`. Otherwise it can run into
> unresolved symbols:
>
> : drivers/spi/spi-qpic-snand.o: in function `snandc_set_reg':
> drivers/spi/spi-qpic-snand.c:56:(.text+0x484): undefined reference to
> `qcom_offset_to_nandc_reg'

No, do not select user-visible symbols. If you observe such issues then
either stubs are missing or depends on.

Best regards,
Krzysztof


2024-04-07 18:55:47

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support

On 07/04/2024 20:45, Alex G. wrote:
>
>
> On 4/7/24 13:40, Alex G. wrote:
>>
>>
>> On 4/7/24 12:48, Alex G. wrote:
>>> On 3/8/24 03:17, Md Sadre Alam wrote:
>>>> Add qpic spi nand driver support. The spi nand
>>>> driver currently supported the below commands.
>>>>
>>>> -- RESET
>>>> -- READ ID
>>>> -- SET FEATURE
>>>> -- GET FEATURE
>>>> -- READ PAGE
>>>> -- WRITE PAGE
>>>> -- ERASE PAGE
>>>>
>>>> Co-developed-by: Sricharan Ramabadhran <[email protected]>
>>>> Signed-off-by: Sricharan Ramabadhran <[email protected]>
>>>> Co-developed-by: Varadarajan Narayanan <[email protected]>
>>>> Signed-off-by: Varadarajan Narayanan <[email protected]>
>>>> Signed-off-by: Md Sadre Alam <[email protected]>
>>>> ---
>>>
>>> For the entire series:
>>>
>>> Tested-by: Alexandru Gagniuc <[email protected]>
>>>
>>>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>>>> index bc7021da2fe9..63764e943d82 100644
>>>> --- a/drivers/spi/Kconfig
>>>> +++ b/drivers/spi/Kconfig
>>>> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
>>>>       help
>>>>         QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>>>> +config SPI_QPIC_SNAND
>>>> +    tristate "QPIC SNAND controller"
>>
>> Also, don't tristate this. It can be set as CONFIG_QPIC_COMMON=m, which
>> will cause the build to fail because you don't have a MODULE_LICENSE().
>
> Please disregard my idiotic suggestion here. I meant to make this
> comment on the previous patch.
>

Also not. All of these must be allowed to be a module. If you need
dependency between modules, then use documented syntax in the kernel
(foo || !foo).

Best regards,
Krzysztof


2024-04-07 18:58:54

by Alexandru Gagniuc

[permalink] [raw]
Subject: Re: [PATCH v4 3/5] spi: spi-qpic: Add qpic spi nand driver support



On 4/7/24 13:54, Krzysztof Kozlowski wrote:
> On 07/04/2024 19:48, Alex G. wrote:
>> On 3/8/24 03:17, Md Sadre Alam wrote:
>>> Add qpic spi nand driver support. The spi nand
>>> driver currently supported the below commands.
>>>
>>> -- RESET
>>> -- READ ID
>>> -- SET FEATURE
>>> -- GET FEATURE
>>> -- READ PAGE
>>> -- WRITE PAGE
>>> -- ERASE PAGE
>>>
>>> Co-developed-by: Sricharan Ramabadhran <[email protected]>
>>> Signed-off-by: Sricharan Ramabadhran <[email protected]>
>>> Co-developed-by: Varadarajan Narayanan <[email protected]>
>>> Signed-off-by: Varadarajan Narayanan <[email protected]>
>>> Signed-off-by: Md Sadre Alam <[email protected]>
>>> ---
>>
>> For the entire series:
>>
>> Tested-by: Alexandru Gagniuc <[email protected]>
>>
>>> diff --git a/drivers/spi/Kconfig b/drivers/spi/Kconfig
>>> index bc7021da2fe9..63764e943d82 100644
>>> --- a/drivers/spi/Kconfig
>>> +++ b/drivers/spi/Kconfig
>>> @@ -882,6 +882,14 @@ config SPI_QCOM_QSPI
>>> help
>>> QSPI(Quad SPI) driver for Qualcomm QSPI controller.
>>>
>>> +config SPI_QPIC_SNAND
>>> + tristate "QPIC SNAND controller"
>>> + depends on ARCH_QCOM || COMPILE_TEST
>>
>> Here, it needs to 'select QPIC_COMMON`. Otherwise it can run into
>> unresolved symbols:
>>
>> : drivers/spi/spi-qpic-snand.o: in function `snandc_set_reg':
>> drivers/spi/spi-qpic-snand.c:56:(.text+0x484): undefined reference to
>> `qcom_offset_to_nandc_reg'
>
> No, do not select user-visible symbols. If you observe such issues then
> either stubs are missing or depends on.

I apologize for making a bad suggestion. Thank you for pointing it out.

Alex