Add support for nuvoton ma35 nand controller
Subsystems (4)
v6 cover Add support for nuvoton ma35 nand controller
This patch series adds the mtd nand driver for the nuvoton ma35 ARMv8 SoC. It includes DT binding documentation and the ma35 mtd nand driver.
v6:
- Update ma35d1 mtd nand driver
- Remove extra blank lines and add comments.
v5:
- Update ma35d1 mtd nand driver
- Remove unnecessary definitions and comments.
- Modified DMA API call sequence.
- Move the ECC check out of the interrupt handler. Check it after reading a page.
v4:
- Update nuvoton,ma35d1-nand.yaml
- rename 'nuvoton,ma35d1-nand' to 'nuvoton,ma35d1-nand-controller'.
- Update ma35d1 mtd nand driver
- Rewrite the NAND driver using the exec_op API.
v3:
- Update ma35d1 mtd nand driver
- Release IRQ handler.
- Remove unused functions.
- Remove '.owner'.
v2:
- Update nuvoton,ma35d1-nand.yaml
- Adjust the order and remove any unnecessary items.
- Add 'nand-ecc-step-size' and 'nand-ecc-strength' to the required list.
- Update ma35d1 mtd nand driver
- Fix coding style.
- Use 'devm_clk_get' instead of 'of_clk_get'.
- Use 'dev_err_probe' instead of 'dev_err'.
- Remove 'pr_info' and 'of_match_ptr'.
- Remove 'module_init' and 'module_exit'.
Hui-Ping Chen (2):
dt-bindings: mtd: nuvoton,ma35d1-nand: add new bindings
mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
.../bindings/mtd/nuvoton,ma35d1-nand.yaml | 93 ++ drivers/mtd/nand/raw/Kconfig | 8 + drivers/mtd/nand/raw/Makefile | 1 + drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c | 862 ++++++++++++++++++ 4 files changed, 964 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml create mode 100644 drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c
Signature · 1 line
2.25.1
PATCH v6 1/2 dt-bindings: mtd: nuvoton,ma35d1-nand: add new bindings
Add dt-bindings for the Nuvoton MA35 SoC NAND Controller.
--- .../bindings/mtd/nuvoton,ma35d1-nand.yaml | 93 +++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +93 -0
@@ -0,0 +1,93 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mtd/nuvoton,ma35d1-nand.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Nuvoton MA35D1 NAND Flash Interface (NFI) Controller + +maintainers: + - Hui-Ping Chen <[email protected]> + +allOf: + - $ref: nand-controller.yaml# + +properties: + compatible: + enum: + - nuvoton,ma35d1-nand-controller + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + +patternProperties: + "^nand@[a-f0-9]$": + type: object + $ref: raw-nand-chip.yaml + properties: + nand-ecc-step-size: + enum: [512, 1024] + + nand-ecc-strength: + enum: [8, 12, 24] + + required: + - nand-ecc-step-size + - nand-ecc-strength + + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + - clocks + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + #include <dt-bindings/clock/nuvoton,ma35d1-clk.h> + + soc { + #address-cells = <2>; + #size-cells = <2>; + + nand-controller@401A0000 { + compatible = "nuvoton,ma35d1-nand-controller"; + reg = <0x0 0x401A0000 0x0 0x1000>; + interrupts = <GIC_SPI 38 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&clk NAND_GATE>; + #address-cells = <1>; + #size-cells = <0>; + + nand@0 { + reg = <0>; + + nand-on-flash-bbt; + nand-ecc-step-size = <512>; + nand-ecc-strength = <8>; + + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + uboot@0 { + label = "nand-uboot"; + read-only; + reg = <0x0 0x300000>; + }; + }; + }; + }; + }; + +...
Signature · 1 line
2.25.1
Miquel Raynal
maintainerRe: [PATCH v6 1/2] dt-bindings: mtd: nuvoton,ma35d1-nand: add new bindings
Hi Hui-Ping,
[email protected] wrote on Fri, 27 Sep 2024 02:07:48 +0000:
Quoted 47 lines
Add dt-bindings for the Nuvoton MA35 SoC NAND Controller.
Signed-off-by Hui-Ping Chen <[email protected]>Reviewed-by Krzysztof Kozlowski <[email protected]>--- .../bindings/mtd/nuvoton,ma35d1-nand.yaml | 93 +++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yamlDocumentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +32
-0@@ -0,0 +1,93 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mtd/nuvoton,ma35d1-nand.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Nuvoton MA35D1 NAND Flash Interface (NFI) Controller + +maintainers: + - Hui-Ping Chen <[email protected]> + +allOf: + - $ref: nand-controller.yaml# + +properties: + compatible: + enum: + - nuvoton,ma35d1-nand-controller + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + +patternProperties: + "^nand@[a-f0-9]$": + type: object + $ref: raw-nand-chip.yaml
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml line 42
Quoted 10 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +10
-0+ properties: + nand-ecc-step-size: + enum: [512, 1024] + + nand-ecc-strength: + enum: [8, 12, 24] + + required: + - nand-ecc-step-size + - nand-ecc-strength
No, they should not be required, unless there is a good reason to do so. Optimal strength is discoverable, stop forcing it by default.
Quoted 41 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +41
-0+ + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + - clocks + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + #include <dt-bindings/clock/nuvoton,ma35d1-clk.h> + + soc { + #address-cells = <2>; + #size-cells = <2>; + + nand-controller@401A0000 { + compatible = "nuvoton,ma35d1-nand-controller"; + reg = <0x0 0x401A0000 0x0 0x1000>; + interrupts = <GIC_SPI 38 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&clk NAND_GATE>; + #address-cells = <1>; + #size-cells = <0>; + + nand@0 { + reg = <0>; + + nand-on-flash-bbt; + nand-ecc-step-size = <512>; + nand-ecc-strength = <8>; + + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + uboot@0 {
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml line 93
Quoted 10 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +10
-0+ label = "nand-uboot"; + read-only; + reg = <0x0 0x300000>; + }; + }; + }; + }; + }; + +...
Thanks,
Miquèl
Re: [PATCH v6 1/2] dt-bindings: mtd: nuvoton,ma35d1-nand: add new bindings
Dear Miquel,
Thank you for your reply.
Quoted 55 lines · Miquel Raynal
Hi Hui-Ping,
[email protected] wrote on Fri, 27 Sep 2024 02:07:48 +0000:
Quoted 51 lines
Add dt-bindings for the Nuvoton MA35 SoC NAND Controller.
Signed-off-by Hui-Ping Chen <[email protected]>Reviewed-by Krzysztof Kozlowski <[email protected]>--- .../bindings/mtd/nuvoton,ma35d1-nand.yaml | 93 +++++++++++++++++++ 1 file changed, 93 insertions(+)create mode 100644
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yamlDocumentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +36
-0@@ -0,0 +1,93 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mtd/nuvoton,ma35d1-nand.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Nuvoton MA35D1 NAND Flash Interface (NFI) Controller + +maintainers: + - Hui-Ping Chen <[email protected]> + +allOf: + - $ref: nand-controller.yaml# + +properties: + compatible: + enum: + - nuvoton,ma35d1-nand-controller + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + +patternProperties: + "^nand@[a-f0-9]$": + type: object + $ref: raw-nand-chip.yaml + properties: + nand-ecc-step-size: + enum: [512, 1024] +
Quoted 8 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml line 42
Quoted 6 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +6
-0+ nand-ecc-strength: + enum: [8, 12, 24] + + required: + - nand-ecc-step-size + - nand-ecc-strengthNo, they should not be required, unless there is a good reason to do so. Optimal strength is discoverable, stop forcing it by default.
I will remove this required.
Quoted 46 lines
Quoted 46 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +46
-0+ + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + - clocks + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + #include <dt-bindings/clock/nuvoton,ma35d1-clk.h> + + soc { + #address-cells = <2>; + #size-cells = <2>; + + nand-controller@401A0000 { + compatible = "nuvoton,ma35d1-nand-controller"; + reg = <0x0 0x401A0000 0x0 0x1000>; + interrupts = <GIC_SPI 38 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&clk NAND_GATE>; + #address-cells = <1>; + #size-cells = <0>; + + nand@0 { + reg = <0>; + + nand-on-flash-bbt; + nand-ecc-step-size = <512>; + nand-ecc-strength = <8>; + + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + uboot@0 { + label = "nand-uboot"; + read-only; + reg = <0x0 0x300000>; + }; + };
Quoted 8 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml line 93
Quoted 5 lines
Documentation/devicetree/bindings/mtd/nuvoton,ma35d1-nand.yaml new file +5
-0+ }; + }; + }; + +...Thanks,
Miquèl
Best regards,
Hui-Ping Chen
PATCH v6 2/2 mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
In reply to Hui-Ping ChenNuvoton MA35 SoCs NAND Flash Interface Controller supports 2kiB, 4kiB and 8kiB page size, and up to 8-bit, 12-bit, and 24-bit hardware ECC calculation circuit to protect data.
--- drivers/mtd/nand/raw/Kconfig | 8 + drivers/mtd/nand/raw/Makefile | 1 + drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c | 862 +++++++++++++++++++++ 3 files changed, 871 insertions(+) create mode 100644 drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c
drivers/mtd/nand/raw/Kconfig +8 -0
@@ -454,6 +454,14 @@ config MTD_NAND_TS72XX help Enables support for NAND controller on ts72xx SBCs. +config MTD_NAND_NUVOTON_MA35 + tristate "Nuvoton MA35 SoC NAND controller" + depends on ARCH_MA35 || COMPILE_TEST + depends on OF + help + Enables support for the NAND controller found on + the Nuvoton MA35 series SoCs. + comment "Misc" config MTD_SM_COMMON
drivers/mtd/nand/raw/Makefile +1 -0
@@ -58,6 +58,7 @@ obj-$(CONFIG_MTD_NAND_INTEL_LGM) += intel-nand-controller.o obj-$(CONFIG_MTD_NAND_ROCKCHIP) += rockchip-nand-controller.o obj-$(CONFIG_MTD_NAND_PL35X) += pl35x-nand-controller.o obj-$(CONFIG_MTD_NAND_RENESAS) += renesas-nand-controller.o +obj-$(CONFIG_MTD_NAND_NUVOTON_MA35) += nuvoton_ma35d1_nand.o nand-objs := nand_base.o nand_legacy.o nand_bbt.o nand_timings.o nand_ids.o nand-objs += nand_onfi.o
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +862 -0
862 lines not on this page · raw message
Signature · 1 line
2.25.1
Miquel Raynal
maintainerRe: [PATCH v6 2/2] mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
Hi Hui-Ping,
[email protected] wrote on Fri, 27 Sep 2024 02:07:49 +0000:
Quoted 174 lines
Nuvoton MA35 SoCs NAND Flash Interface Controller supports 2kiB, 4kiB and 8kiB page size, and up to 8-bit, 12-bit, and 24-bit hardware ECC calculation circuit to protect data.
Signed-off-by Hui-Ping Chen <[email protected]>--- drivers/mtd/nand/raw/Kconfig | 8 + drivers/mtd/nand/raw/Makefile | 1 + drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c | 862 +++++++++++++++++++++ 3 files changed, 871 insertions(+) create mode 100644 drivers/mtd/nand/raw/nuvoton_ma35d1_nand.cdrivers/mtd/nand/raw/Kconfig +8
-0@@ -454,6 +454,14 @@ config MTD_NAND_TS72XX help Enables support for NAND controller on ts72xx SBCs. +config MTD_NAND_NUVOTON_MA35 + tristate "Nuvoton MA35 SoC NAND controller" + depends on ARCH_MA35 || COMPILE_TEST + depends on OF + help + Enables support for the NAND controller found on + the Nuvoton MA35 series SoCs. + comment "Misc" config MTD_SM_COMMONdrivers/mtd/nand/raw/Makefile +1
-0@@ -58,6 +58,7 @@ obj-$(CONFIG_MTD_NAND_INTEL_LGM) += intel-nand-controller.o obj-$(CONFIG_MTD_NAND_ROCKCHIP) += rockchip-nand-controller.o obj-$(CONFIG_MTD_NAND_PL35X) += pl35x-nand-controller.o obj-$(CONFIG_MTD_NAND_RENESAS) += renesas-nand-controller.o +obj-$(CONFIG_MTD_NAND_NUVOTON_MA35) += nuvoton_ma35d1_nand.o nand-objs := nand_base.o nand_legacy.o nand_bbt.o nand_timings.o nand_ids.o nand-objs += nand_onfi.odrivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +124
-0@@ -0,0 +1,862 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Copyright (C) 2024 Nuvoton Technology Corp. +*/ +#include <linux/clk.h> +#include <linux/dma-mapping.h> +#include <linux/err.h> +#include <linux/init.h> +#include <linux/interrupt.h> +#include <linux/io.h> +#include <linux/iopoll.h> +#include <linux/module.h> +#include <linux/mtd/mtd.h> +#include <linux/mtd/partitions.h> +#include <linux/mtd/rawnand.h> +#include <linux/of.h> +#include <linux/platform_device.h> +#include <linux/slab.h> + +/* NFI Registers */ +#define MA35_NFI_REG_DMACTL 0x400 +#define DMA_EN BIT(0) +#define DMA_RST BIT(1) +#define DMA_BUSY BIT(9) + +#define MA35_NFI_REG_DMASA 0x408 +#define MA35_NFI_REG_GCTL 0x800 +#define NAND_EN BIT(3) + +#define MA35_NFI_REG_NANDCTL 0x8A0 +#define SWRST BIT(0) +#define DMA_R_EN BIT(1) +#define DMA_W_EN BIT(2) +#define ECC_CHK BIT(7) +#define PROT3BEN BIT(8) +#define PSIZE_2K BIT(16) +#define PSIZE_4K BIT(17) +#define PSIZE_8K GENMASK(17, 16) +#define PSIZE_MASK GENMASK(17, 16) +#define BCH_T24 BIT(18) +#define BCH_T8 BIT(20) +#define BCH_T12 BIT(21) +#define BCH_NONE (0x0) +#define BCH_MASK GENMASK(22, 18) +#define ECC_EN BIT(23) +#define DISABLE_CS0 BIT(25) + +#define MA35_NFI_REG_NANDINTEN 0x8A8 +#define MA35_NFI_REG_NANDINTSTS 0x8AC +#define INT_DMA BIT(0) +#define INT_ECC BIT(2) +#define INT_RB0 BIT(10) +#define INT_RB0_STS BIT(18) + +#define MA35_NFI_REG_NANDCMD 0x8B0 +#define MA35_NFI_REG_NANDADDR 0x8B4 +#define ENDADDR BIT(31) + +#define MA35_NFI_REG_NANDDATA 0x8B8 +#define MA35_NFI_REG_NANDRACTL 0x8BC +#define MA35_NFI_REG_NANDECTL 0x8C0 +#define ENABLE_WP 0x0 +#define DISABLE_WP BIT(0) + +#define MA35_NFI_REG_NANDECCES0 0x8D0 +#define ECC_STATUS_MASK GENMASK(1, 0) +#define ECC_ERR_CNT_MASK GENMASK(4, 0) + +#define MA35_NFI_REG_NANDECCEA0 0x900 +#define MA35_NFI_REG_NANDECCED0 0x960 +#define MA35_NFI_REG_NANDRA0 0xA00 + +/* Define for the BCH hardware ECC engine */ +/* define the total padding bytes for 512/1024 data segment */ +#define MA35_BCH_PADDING_512 32 +#define MA35_BCH_PADDING_1024 64 +/* define the BCH parity code length for 512 bytes data pattern */ +#define MA35_PARITY_BCH8 15 +#define MA35_PARITY_BCH12 23 +/* define the BCH parity code length for 1024 bytes data pattern */ +#define MA35_PARITY_BCH24 45 + +struct ma35_nand_info { +struct nand_controller controller; +struct nand_chip chip; +struct device *dev; +void __iomem *regs; +int irq; +struct clk *clk; +struct completion complete; +u32 bch; +u32 bitflips; +u8 *ecc_buf; +}; + +static int ma35_ooblayout_ecc (struct mtd_info *mtd,int section, +struct mtd_oob_region *oobregion) +{ +struct nand_chip *chip =mtd_to_nand (mtd); + +if (section) +return -ERANGE ; + + oobregion->length = chip->ecc.total; + oobregion->offset = mtd->oobsize - oobregion->length; + +return 0 ; +} + +static int ma35_ooblayout_free (struct mtd_info *mtd,int section, +struct mtd_oob_region *oobregion) +{ +struct nand_chip *chip =mtd_to_nand (mtd); + +if (section) +return -ERANGE ; + + oobregion->length = mtd->oobsize - chip->ecc.total -2 ; + oobregion->offset =2 ; + +return 0 ; +} + +static const struct mtd_ooblayout_ops ma35_ooblayout_ops = {
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 134
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ .free = ma35_ooblayout_free, + .ecc = ma35_ooblayout_ecc, +}; + +static inline void ma35_clear_spare (struct nand_chip *chip,int size) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +int i; + +for (i =0 ; i < size/4 ; i++)
Spacing ^
Quoted 72 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +72
-0+writel (0xff , nand->regs +MA35_NFI_REG_NANDRA0 ); +} + +static inline void read_remaining_bytes (struct ma35_nand_info *nand,u32 *buf, +u32 offset,int size) +{ +u32 value =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset); +u8 *ptr = (u8 *)buf; +int i; + +for (i =0 ; i < size; i++) + ptr[i] = (value >> (i *8 )) &0xff ; +} + +static inline void ma35_read_spare (struct nand_chip *chip,int size,u32 *buf,u32 offset) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +int i, j; + +if ((offset %4 ) ==0 ) { +for (i =0 , j =0 ; i < size /4 ; i++, j +=4 ) + *buf++ =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset + j); + +read_remaining_bytes (nand, buf, offset + j, size %4 ); + }else { +read_remaining_bytes (nand, buf, offset,4 - (offset %4 )); + offset +=4 ; + size -= (4 - (offset %4 )); + +for (i =0 , j =0 ; i < size /4 ; i++, j +=4 ) + *buf++ =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset + j); + +read_remaining_bytes (nand, buf, offset + j, size %4 ); + } +} + +static inline void ma35_write_spare (struct nand_chip *chip,int size,u32 *buf) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +u32 value; +int i, j; +u8 *ptr; + +for (i =0 , j =0 ; i < size /4 ; i++, j +=4 ) +writel (*buf++, nand->regs +MA35_NFI_REG_NANDRA0 + j); + + ptr = (u8 *)buf; +switch (size %4 ) { +case 1 : +writel (*ptr, nand->regs +MA35_NFI_REG_NANDRA0 + j); +break ; +case 2 : + value = *ptr | (*(ptr+1 ) <<8 ); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 + j); +break ; +case 3 : + value = *ptr | (*(ptr+1 ) <<8 ) | (*(ptr+2 ) <<16 ); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 + j); +break ; +default : +break ; + } +} + +static inline void ma35_nand_target_enable (struct ma35_nand_info *nand) +{ +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~DISABLE_CS0 ), + nand->regs+MA35_NFI_REG_NANDCTL ); +} + +static inline void ma35_nand_target_disable (struct ma35_nand_info *nand) +{
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 216
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DISABLE_CS0 , + nand->regs +MA35_NFI_REG_NANDCTL ); +} + +static void ma35_nand_hwecc_init (struct ma35_nand_info *nand) +{ +struct mtd_info *mtd =nand_to_mtd (&nand->chip); +u32 reg; + +/* resets the internal state machine and counters
Please check the style in all you comments.
/* * Reset the
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 221
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+* This bit will be auto cleared after a few clock cycles. +*/ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ); + reg |=SWRST ; +writel (reg, nand->regs +MA35_NFI_REG_NANDCTL );
This has a way wider impact than just configuring the hw ECC engine, no? Are you sure you want to do this now? I believe it should be in its own helper, and you want to do it earlier than that, like before the discovery step (and also in the resume path).
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 223
Quoted 2 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +2
-0+while (readl (nand->regs +MA35_NFI_REG_NANDCTL ) &SWRST ) + ;
cpu_relax()
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 233
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* Redundant area size */ +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +/* Protect redundant 3 bytes */ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ); + reg |= (PROT3BEN |ECC_CHK ); +writel (reg, nand->regs +MA35_NFI_REG_NANDCTL ); + +if (nand->bch ==BCH_NONE ) {
Please use the definitions/constants from the core.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 236
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+/* Disable H/W ECC, ECC parity check enable bit during read page */ +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~ECC_EN ), + nand->regs +MA35_NFI_REG_NANDCTL );
Move the readl before the if and save it in the reg variable.
In general please do not overload the lines like that when it's not needed.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 239
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+ }else { +/* Set BCH algorithm */ + writel((readl(nand->regs + MA35_NFI_REG_NANDCTL) & (~BCH_MASK)) |
Parenthesis are not needed ^
Quoted 129 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +129
-0+ nand->bch, nand->regs + MA35_NFI_REG_NANDCTL); + +/* Enable H/W ECC, ECC parity check enable bit during read page */ +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |ECC_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + } +} + +/* Correct data by BCH alrogithm */ +static void ma35_nfi_correct (struct ma35_nand_info *nand,u8 index, +u8 err_cnt,u8 *addr) +{ +u32 temp_data[24 ], temp_addr[24 ]; +u32 padding_len, parity_len; +u32 value, offset, remain; +u32 err_data[6 ]; +u8 i, j; + +/* configurations */ +switch (nand->bch) { +case BCH_T24 : + parity_len =MA35_PARITY_BCH24 ; + padding_len =MA35_BCH_PADDING_1024 ; +break ; +case BCH_T12 : + parity_len =MA35_PARITY_BCH12 ; + padding_len =MA35_BCH_PADDING_512 ; +break ; +case BCH_T8 : + parity_len =MA35_PARITY_BCH8 ; + padding_len =MA35_BCH_PADDING_512 ; +break ; +default : +dev_warn (nand->dev,"NAND ERROR: invalid SMCR_BCH_TSEL = 0x%08X\n" , + (u32)(readl (nand->regs +MA35_NFI_REG_NANDCTL ) &BCH_MASK )); +return ; + } + +/* got valid BCH_ECC_DATAx and parse them to temp_data[] +* got the valid register number of BCH_ECC_DATAx since +* one register include 4 error bytes +*/ + j = (err_cnt +3 ) /4 ; + j = (j >6 ) ?6 : j; +for (i =0 ; i < j; i++) + err_data[i] =readl (nand->regs +MA35_NFI_REG_NANDECCED0 + i *4 ); + +for (i =0 ; i < j; i++) { + temp_data[i*4 +0 ] = err_data[i] &0xff ; + temp_data[i*4 +1 ] = (err_data[i] >>8 ) &0xff ; + temp_data[i*4 +2 ] = (err_data[i] >>16 ) &0xff ; + temp_data[i*4 +3 ] = (err_data[i] >>24 ) &0xff ; + } + +/* got valid REG_BCH_ECC_ADDRx and parse them to temp_addr[] +* got the valid register number of REG_BCH_ECC_ADDRx since +* one register include 2 error addresses +*/ + j = (err_cnt +1 ) /2 ; + j = (j >12 ) ?12 : j; +for (i =0 ; i < j; i++) { + temp_addr[i*2 +0 ] =readl (nand->regs +MA35_NFI_REG_NANDECCEA0 + i *4 ) + &0x07ff ; + temp_addr[i*2 +1 ] = (readl (nand->regs +MA35_NFI_REG_NANDECCEA0 + i *4 ) + >>16 ) &0x07ff ; + } + +/* pointer to begin address of field that with data error */ + addr += index * nand->chip.ecc.steps; + +/* correct each error bytes */ +for (i =0 ; i < err_cnt; i++) { +u32 corrected_index = temp_addr[i]; + +/* for wrong data in field */ +if (corrected_index < nand->chip.ecc.steps) + *(addr + corrected_index) ^= temp_data[i]; + +/* for wrong first-3-bytes in redundancy area */ +else if (corrected_index < (nand->chip.ecc.steps +3 )) { + corrected_index -= nand->chip.ecc.steps; + temp_addr[i] += (parity_len * index);/* field offset */ + + value =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); + value ^= temp_data[i] << (8 * corrected_index); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 ); + } +/* for wrong parity code in redundancy area +* BCH_ERR_ADDRx = [data in field] + [3 bytes] + [xx] + [parity code] +* |<-- padding bytes -->| +* The BCH_ERR_ADDRx for last parity code always = field size + padding size. +* So, the first parity code = field size + padding size - parity code length. +* For example, for BCH T12, the first parity code = 512 + 32 - 23 = 521. +* That is, error byte address offset within field is +*/ +else { + corrected_index -= (nand->chip.ecc.steps + padding_len - parity_len); + +/* final address = first parity code of first field + +* offset of fields + +* offset within field +*/ + offset = (readl (nand->regs +MA35_NFI_REG_NANDRACTL ) &0x1ff ) - + (parity_len * nand->chip.ecc.steps) + + (parity_len * index) + corrected_index; + + remain = offset %4 ; + value =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset - remain); + value ^= temp_data[i] << (8 * remain); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 + offset - remain); + } + } +} + +static int ma35_nfi_ecc_check (struct nand_chip *chip,u8 *addr) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +int i, j, nchunks =0 ; +int report_err =0 ; +int err_cnt =0 ; +u32 status; + + nchunks = mtd->writesize / chip->ecc.steps; +if (nchunks <4 ) + nchunks =1 ; +else + nchunks /=4 ; +
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 378
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+for (j =0 ; j < nchunks; j++) { + status =readl (nand->regs +MA35_NFI_REG_NANDECCES0 + j *4 ); +if (!status) +continue ; + +for (i =0 ; i <4 ; i++) { +if (!(status &ECC_STATUS_MASK )) { +/* No error */ + status >>=8 ; +continue ;
Remove this block, it will do the same and be more clear.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 382
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ }else if ((status &ECC_STATUS_MASK ) ==0x01 ) { +/* Correctable error */ + err_cnt = (status >>2 ) &ECC_ERR_CNT_MASK ; +ma35_nfi_correct (nand, j*4 +i, err_cnt, addr);
Spacing ^^^^^^
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 387
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ report_err += err_cnt; + }else { +/* uncorrectable error */ +dev_warn (nand->dev,"uncorrectable error! 0x%4x\n" , status); +return -1 ;
Not a valid error code
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ } + status >>=8 ; + } + } +return report_err; +} +
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 404
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+static void ma35_nand_dmac_init (struct ma35_nand_info *nand) +{ +/* DMAC reset and enable */ +writel (DMA_RST |DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); +writel (DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); + +/* Clear DMA finished flag */ +writel (INT_DMA |INT_ECC , nand->regs +MA35_NFI_REG_NANDINTSTS ); + +init_completion (&nand->complete);
You're gonna call init_completion more than once during suspend/resume cycles, this is unsafe.
Quoted 49 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +49
-0+} + +static int ma35_nand_do_write (struct nand_chip *chip,const u8 *addr,u32 len) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +dma_addr_t dma_addr; +int ret =0 , i; +u32 reg; + +if (len != mtd->writesize) { +for (i =0 ; i < len; i++) +writel (addr[i], nand->regs +MA35_NFI_REG_NANDDATA ); +return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +writel (INT_DMA , nand->regs +MA35_NFI_REG_NANDINTEN ); +/* To mark this page as dirty. */ + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) +writel (reg &0xffff , nand->regs +MA35_NFI_REG_NANDRA0 ); + + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_TO_DEVICE ); + ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } +dma_sync_single_for_device (nand->dev, dma_addr, len,DMA_TO_DEVICE ); + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA ); +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DMA_W_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + ret =wait_for_completion_timeout (&nand->complete,msecs_to_jiffies (1000 )); +if (!ret) { +dev_err (nand->dev,"write timeout\n" ); + ret = -ETIMEDOUT ; + } + +dma_unmap_single (nand->dev, dma_addr, len,DMA_TO_DEVICE ); + +return ret; +} + +static int ma35_nand_do_read (struct nand_chip *chip,u8 *addr,u32 len)
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 463
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +int ret =0 , cnt =0 , i; +dma_addr_t dma_addr; +u32 reg; + +if (len != mtd->writesize) { +for (i =0 ; i < len; i++) + *(addr+i) = (u8 )readl (nand->regs +MA35_NFI_REG_NANDDATA );
Mmh, that line is strange. Please don't do that.
addr[i] = readb() ?
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL );
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 479
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* setup and start DMA using dma_addr */ + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_FROM_DEVICE ); + ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA );
Please enforce a dma mask of 32 (even though it might be the fault).
Quoted 52 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +52
-0+writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DMA_R_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + ret =wait_for_completion_timeout (&nand->complete,msecs_to_jiffies (1000 )); +if (!ret) { +dev_err (nand->dev,"read timeout\n" ); + ret = -ETIMEDOUT ; + } + +dma_unmap_single (nand->dev, dma_addr, len,DMA_FROM_DEVICE ); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (reg &INT_ECC ) { + cnt =ma35_nfi_ecc_check (&nand->chip, addr); +if (cnt <0 ) { + mtd->ecc_stats.failed++; +writel (DMA_RST |DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |SWRST , + nand->regs +MA35_NFI_REG_NANDCTL ); + }else { + mtd->ecc_stats.corrected += cnt; + nand->bitflips = cnt; + } +writel (INT_ECC , nand->regs +MA35_NFI_REG_NANDINTSTS ); + } + +return ret; +} + +static int ma35_nand_write_page_hwecc (struct nand_chip *chip,const u8 *buf, +int oob_required,int page) +{ +struct mtd_info *mtd =nand_to_mtd (chip); +void *ecc_calc = chip->ecc.calc_buf; + +ma35_clear_spare (chip, mtd->oobsize); +ma35_write_spare (chip, mtd->oobsize - chip->ecc.total, + (u32 *)chip->oob_poi); + +nand_prog_page_begin_op (chip, page,0 , buf, mtd->writesize); +nand_prog_page_end_op (chip); + +/* Copy parity code in NANDRA to calc */ +ma35_read_spare (chip, chip->ecc.total, (u32 *)ecc_calc, + mtd->oobsize - chip->ecc.total); + +/* Copy parity code in calc to oob_poi */ +memcpy (chip->oob_poi + (mtd->oobsize - chip->ecc.total), + ecc_calc, chip->ecc.total); + +return 0 ; +} +
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 541
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+static int ma35_nand_read_page_hwecc (struct nand_chip *chip,u8 *buf, +int oob_required,int page) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +/* read the OOB area */ +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + nand->bitflips =0 ;
Why storing this value in your structure?
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 551
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* copy OOB data to NANDRA for page read */ +ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) { +memset ((void *)buf,0xff , mtd->writesize); + }else { +/* read data from nand */ +nand_read_page_op (chip, page,0 , buf, mtd->writesize);
ret =
if (ret)
...
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 554
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+ +/* restore OOB data from SMRA */ +ma35_read_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi,0 );
same
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ } + +return nand->bitflips; +}
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 568
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +static int ma35_nand_read_oob_hwecc (struct nand_chip *chip,int page) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + +/* copy OOB data to NANDRA for page read */
What is NANDRA? does not mean anything to me.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 573
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) +memset ((void *)chip->oob_poi,0xff , mtd->oobsize);
What does this mean?
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ +return 0 ; +} +
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 587
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+static irqreturn_t ma35_nand_irq (int irq,void *id) +{ +struct ma35_nand_info *nand = (struct ma35_nand_info *)id; +u32 isr; + + isr =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (isr &INT_DMA ) { +writel (INT_DMA , nand->regs +MA35_NFI_REG_NANDINTSTS ); +complete (&nand->complete); + }
I guess a more future proof implementation would always writel(isr); to silence the interrupt. Otherwise of course you must call complete() only upon isr & INT_DMA.
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+ +return IRQ_HANDLED ; +} + +static int ma35_nand_attach_chip (struct nand_chip *chip) +{
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 603
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +unsigned int reg; + +if (chip->options &NAND_BUSWIDTH_16 ) { +dev_err (nand->dev,"16 bits bus width not supported" ); +return -EINVAL ; + } + +/* support only ecc hw mode */
Why ? Please don't.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 613
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+if (chip->ecc.engine_type !=NAND_ECC_ENGINE_TYPE_ON_HOST ) { +dev_err (nand->dev,"ecc.engine_type not supported\n" ); +return -EINVAL ; + } + + nand->ecc_buf =devm_kzalloc (nand->dev, mtd->writesize + mtd->oobsize, +GFP_KERNEL ); +if (!nand->ecc_buf) +return -ENOMEM ; + chip->ecc.calc_buf = nand->ecc_buf;
Are you sure you need this? I don't see the point.
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+ +/* Set PSize */ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~PSIZE_MASK ); +if (mtd->writesize ==2048 ) +writel (reg |PSIZE_2K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==4096 )
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 629
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+writel (reg |PSIZE_4K , nand->regs +MA35_NFI_REG_NANDCTL ); + else if (mtd->writesize == 8192) + writel(reg | PSIZE_8K, nand->regs + MA35_NFI_REG_NANDCTL); + + chip->ecc.steps = mtd->writesize / chip->ecc.size; +if (chip->ecc.strength ==0 ) { + nand->bch =BCH_NONE ;/* No ECC */ + chip->ecc.total =0 ; + }else if (chip->ecc.strength <=8 ) { + nand->bch =BCH_T8 ;/* T8 */
bch is probably a bad name, and in general I don't see the point of saving this value. Just check the ECC strength in the above switch cases and don't use this intermediate variable.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 639
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH8 ; + }else if (chip->ecc.strength <=12 ) { + nand->bch =BCH_T12 ;/* T12 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH12 ; + }else if (chip->ecc.strength <=24 ) { + nand->bch =BCH_T24 ;/* T24 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH24 ; + }else { +dev_warn (nand->dev,"NAND Controller is not support this flash. (%d, %d)\n" , + mtd->writesize, mtd->oobsize);
This must be a dev_err() and return an error immediately.
Also the string is not correct.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 646
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ } + + chip->ecc.bytes = chip->ecc.total / chip->ecc.steps; +mtd_set_ooblayout (mtd, &ma35_ooblayout_ops); + +/* add mtd-id. The string should same as uboot definition */ + mtd->name ="nand0" ;
No! There are DT labels for that and mtd->name will automatically be set when calling nand_set_flash_node().
Quoted 29 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +29
-0+ +ma35_nand_hwecc_init (nand); + +writel (DISABLE_WP , nand->regs +MA35_NFI_REG_NANDECTL ); + +return 0 ; +} + +static int ma35_nfc_exec_instr (struct nand_chip *chip, +const struct nand_op_instr *instr) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +unsigned int i; +u32 status; + +switch (instr->type) { +case NAND_OP_CMD_INSTR : +writel (instr->ctx.cmd.opcode, nand->regs +MA35_NFI_REG_NANDCMD ); +return 0 ; +case NAND_OP_ADDR_INSTR : +for (i =0 ; i < instr->ctx.addr.naddrs; i++) { +if (i == (instr->ctx.addr.naddrs -1 )) +writel (instr->ctx.addr.addrs[i] |ENDADDR , + nand->regs +MA35_NFI_REG_NANDADDR ); +else +writel (instr->ctx.addr.addrs[i], + nand->regs +MA35_NFI_REG_NANDADDR ); + } +return 0 ;
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 685
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+case NAND_OP_DATA_IN_INSTR : +ma35_nand_do_read (chip, instr->ctx.data.buf.in, instr->ctx.data.len); +return 0 ; +case NAND_OP_DATA_OUT_INSTR : +ma35_nand_do_write (chip, instr->ctx.data.buf.out, instr->ctx.data.len); +return 0 ; +case NAND_OP_WAITRDY_INSTR : +return readl_poll_timeout (nand->regs +MA35_NFI_REG_NANDINTSTS , status, + status &INT_RB0 ,20 , + instr->ctx.waitrdy.timeout_ms *1000 );
MSEC_PER_SEC
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 691
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+default : +break ; + } + +return -EINVAL ; +}
This is much better than the legacy hooks!
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+ +static int ma35_nfc_exec_op (struct nand_chip *chip, +const struct nand_operation *op, +bool check_only) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip);
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 707
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+int ret =0 ; +u32 i, reg; + +if (check_only) +return 0 ; + +ma35_nand_target_enable (nand); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); + reg |=INT_RB0 ;
This RB pin looks like something hardcoded, whereas it should not :-)
If you have several RB, it means you have several CS as well!
Quoted 35 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +35
-0+writel (reg, nand->regs +MA35_NFI_REG_NANDINTSTS ); + +for (i =0 ; i < op->ninstrs; i++) { + ret =ma35_nfc_exec_instr (chip, &op->instrs[i]); +if (ret) +break ; + } + +ma35_nand_target_disable (nand); + +return ret; +} + +static const struct nand_controller_ops ma35_nfc_ops = { + .attach_chip = ma35_nand_attach_chip, + .exec_op = ma35_nfc_exec_op, +}; + +static int ma35_nand_probe (struct platform_device *pdev) +{ +struct ma35_nand_info *nand; +struct nand_chip *chip; +struct mtd_info *mtd; +int ret =0 ; + + nand =devm_kzalloc (&pdev->dev,sizeof (*nand),GFP_KERNEL ); +if (!nand) +return -ENOMEM ; + +nand_controller_init (&nand->controller); + nand->controller.ops = &ma35_nfc_ops; + + nand->regs =devm_platform_ioremap_resource (pdev,0 ); +if (IS_ERR (nand->regs)) +return PTR_ERR (nand->regs);
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 752
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ + nand->dev = &pdev->dev; + chip = &nand->chip; +nand_set_controller_data (chip, nand); +nand_set_flash_node (chip, pdev->dev.of_node); + + nand->clk =devm_clk_get_enabled (&pdev->dev,"nand_gate" ); +if (IS_ERR (nand->clk)) +return dev_err_probe (&pdev->dev,PTR_ERR (nand->clk), +"failed to find nand clock\n" );
NAND
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +12
-0+ + nand->irq =platform_get_irq (pdev,0 ); +if (nand->irq <0 ) +return dev_err_probe (&pdev->dev, nand->irq, +"failed to get platform irq\n" ); + + ret =devm_request_irq (&pdev->dev, nand->irq, ma35_nand_irq, +IRQF_TRIGGER_HIGH ,"ma35d1-nand" , nand); +if (ret) { +dev_err (&pdev->dev,"failed to request NAND irq\n" ); +return -ENXIO ; + }
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 774
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ + nand->chip.controller = &nand->controller; +platform_set_drvdata (pdev, nand); + + chip->options |=NAND_NO_SUBPAGE_WRITE |NAND_USES_DMA ; + + chip->ecc.engine_type =NAND_ECC_ENGINE_TYPE_ON_HOST ; + chip->ecc.write_page = ma35_nand_write_page_hwecc; + chip->ecc.read_page = ma35_nand_read_page_hwecc; + chip->ecc.read_oob = ma35_nand_read_oob_hwecc;
You support to disable the ECC engine, so you must support software corrections as well. Please don't force hw ECC use. Please look at other implementations, there is usually a helper with a switch case which supports various ECC configurations.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 781
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ + mtd =nand_to_mtd (chip); + mtd->priv = chip; + mtd->owner =THIS_MODULE ; + mtd->dev.parent = &pdev->dev; + +writel (NAND_EN , nand->regs +MA35_NFI_REG_GCTL );
I would expect your reset bit to be set before this writel.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 793
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +12
-0+ + ret =nand_scan (chip,1 ); +if (ret) +return ret; + + ret =mtd_device_register (mtd,NULL ,0 ); +if (ret) { +nand_cleanup (chip); +return ret; + } + +return ret;
return 0; then
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+} + +static void ma35_nand_remove (struct platform_device *pdev) +{ +struct ma35_nand_info *nand =platform_get_drvdata (pdev); +int ret; + + ret =mtd_device_unregister (nand_to_mtd (&nand->chip)); +WARN_ON (ret); +nand_cleanup (&nand->chip); +}
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 814
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* PM Support */ +#ifdef CONFIG_PM +static int ma35_nand_suspend (struct platform_device *pdev,pm_message_t pm) +{ +struct ma35_nand_info *nand =platform_get_drvdata (pdev); +int ret =0 ; +u32 val; + +/* wait DMAC to ready */
be
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 818
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ ret =readl_poll_timeout (nand->regs +MA35_NFI_REG_DMACTL , val, + !(val &DMA_BUSY ),50 ,HZ /2 ); +if (ret) +dev_warn (&pdev->dev,"dma busy\n" );
DMA
And please make a sentence.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 820
Quoted 2 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +2
-0+ +clk_disable (nand->clk);
If you decide to return ret != 0, shall you really disable this clock ?
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 830
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +return ret; +} + +static int ma35_nand_resume (struct platform_device *pdev) +{ +struct ma35_nand_info *nand =platform_get_drvdata (pdev); + +clk_enable (nand->clk); +ma35_nand_hwecc_init (nand);
The naming is wrong. This init is not just the hw ECC controller.
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 841
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+ma35_nand_dmac_init (nand); + +return 0 ; +} + +#else +#define ma35_nand_suspend NULL +#define ma35_nand_resume NULL +#endif + +static const struct of_device_id ma35_nfi_of_match[] = {
ma35_nfi or ma35_nand, take one and please stick to it.
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+ { .compatible = "nuvoton,ma35d1-nand" }, + {}, +}; +MODULE_DEVICE_TABLE (of, ma35_nfi_of_match); + +static struct platform_driver ma35_nand_driver = { + .driver = { + .name ="ma35d1-nand" , + .of_match_table = ma35_nfi_of_match, + }, + .probe = ma35_nand_probe,
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 862
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ .remove = ma35_nand_remove, + .suspend = ma35_nand_suspend, + .resume = ma35_nand_resume, +}; + +module_platform_driver (ma35_nand_driver); + +MODULE_DESCRIPTION ("Nuvoton ma35 NAND driver" ); +MODULE_AUTHOR ("Hui-Ping Chen <[email protected]>" ); +MODULE_LICENSE ("GPL" );
Thanks,
Miquèl
Re: [PATCH v6 2/2] mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
Dear Miquel,
Thank you for your reply.
Quoted 181 lines · Miquel Raynal
Hi Hui-Ping,
[email protected] wrote on Fri, 27 Sep 2024 02:07:49 +0000:
Quoted 177 lines
Nuvoton MA35 SoCs NAND Flash Interface Controller supports 2kiB, 4kiB and 8kiB page size, and up to 8-bit, 12-bit, and 24-bit hardware ECC calculation circuit to protect data.
Signed-off-by Hui-Ping Chen <[email protected]>--- drivers/mtd/nand/raw/Kconfig | 8 + drivers/mtd/nand/raw/Makefile | 1 + drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c | 862 +++++++++++++++++++++ 3 files changed, 871 insertions(+)create mode 100644
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.cdrivers/mtd/nand/raw/Kconfig +8
-0@@ -454,6 +454,14 @@ config MTD_NAND_TS72XX help Enables support for NAND controller on ts72xx SBCs. +config MTD_NAND_NUVOTON_MA35 + tristate "Nuvoton MA35 SoC NAND controller" + depends on ARCH_MA35 || COMPILE_TEST + depends on OF + help + Enables support for the NAND controller found on + the Nuvoton MA35 series SoCs. + comment "Misc" config MTD_SM_COMMONdrivers/mtd/nand/raw/Makefile +1
-0@@ -58,6 +58,7 @@ obj-$(CONFIG_MTD_NAND_INTEL_LGM) += intel-nand-controller.o obj-$(CONFIG_MTD_NAND_ROCKCHIP) += rockchip-nand-controller.o obj-$(CONFIG_MTD_NAND_PL35X) += pl35x-nand-controller.o obj-$(CONFIG_MTD_NAND_RENESAS) += renesas-nand-controller.o +obj-$(CONFIG_MTD_NAND_NUVOTON_MA35) += nuvoton_ma35d1_nand.o nand-objs := nand_base.o nand_legacy.o nand_bbt.o nand_timings.o nand_ids.o nand-objs += nand_onfi.odrivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +127
-0@@ -0,0 +1,862 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Copyright (C) 2024 Nuvoton Technology Corp. +*/ +#include <linux/clk.h> +#include <linux/dma-mapping.h> +#include <linux/err.h> +#include <linux/init.h> +#include <linux/interrupt.h> +#include <linux/io.h> +#include <linux/iopoll.h> +#include <linux/module.h> +#include <linux/mtd/mtd.h> +#include <linux/mtd/partitions.h> +#include <linux/mtd/rawnand.h> +#include <linux/of.h> +#include <linux/platform_device.h> +#include <linux/slab.h> + +/* NFI Registers */ +#define MA35_NFI_REG_DMACTL 0x400 +#define DMA_EN BIT(0) +#define DMA_RST BIT(1) +#define DMA_BUSY BIT(9) + +#define MA35_NFI_REG_DMASA 0x408 +#define MA35_NFI_REG_GCTL 0x800 +#define NAND_EN BIT(3) + +#define MA35_NFI_REG_NANDCTL 0x8A0 +#define SWRST BIT(0) +#define DMA_R_EN BIT(1) +#define DMA_W_EN BIT(2) +#define ECC_CHK BIT(7) +#define PROT3BEN BIT(8) +#define PSIZE_2K BIT(16) +#define PSIZE_4K BIT(17) +#define PSIZE_8K GENMASK(17, 16) +#define PSIZE_MASK GENMASK(17, 16) +#define BCH_T24 BIT(18) +#define BCH_T8 BIT(20) +#define BCH_T12 BIT(21) +#define BCH_NONE (0x0) +#define BCH_MASK GENMASK(22, 18) +#define ECC_EN BIT(23) +#define DISABLE_CS0 BIT(25) + +#define MA35_NFI_REG_NANDINTEN 0x8A8 +#define MA35_NFI_REG_NANDINTSTS 0x8AC +#define INT_DMA BIT(0) +#define INT_ECC BIT(2) +#define INT_RB0 BIT(10) +#define INT_RB0_STS BIT(18) + +#define MA35_NFI_REG_NANDCMD 0x8B0 +#define MA35_NFI_REG_NANDADDR 0x8B4 +#define ENDADDR BIT(31) + +#define MA35_NFI_REG_NANDDATA 0x8B8 +#define MA35_NFI_REG_NANDRACTL 0x8BC +#define MA35_NFI_REG_NANDECTL 0x8C0 +#define ENABLE_WP 0x0 +#define DISABLE_WP BIT(0) + +#define MA35_NFI_REG_NANDECCES0 0x8D0 +#define ECC_STATUS_MASK GENMASK(1, 0) +#define ECC_ERR_CNT_MASK GENMASK(4, 0) + +#define MA35_NFI_REG_NANDECCEA0 0x900 +#define MA35_NFI_REG_NANDECCED0 0x960 +#define MA35_NFI_REG_NANDRA0 0xA00 + +/* Define for the BCH hardware ECC engine */ +/* define the total padding bytes for 512/1024 data segment */ +#define MA35_BCH_PADDING_512 32 +#define MA35_BCH_PADDING_1024 64 +/* define the BCH parity code length for 512 bytes data pattern */ +#define MA35_PARITY_BCH8 15 +#define MA35_PARITY_BCH12 23 +/* define the BCH parity code length for 1024 bytes data pattern */ +#define MA35_PARITY_BCH24 45 + +struct ma35_nand_info { +struct nand_controller controller; +struct nand_chip chip; +struct device *dev; +void __iomem *regs; +int irq; +struct clk *clk; +struct completion complete; +u32 bch; +u32 bitflips; +u8 *ecc_buf; +}; + +static int ma35_ooblayout_ecc (struct mtd_info *mtd,int section, +struct mtd_oob_region *oobregion) +{ +struct nand_chip *chip =mtd_to_nand (mtd); + +if (section) +return -ERANGE ; + + oobregion->length = chip->ecc.total; + oobregion->offset = mtd->oobsize - oobregion->length; + +return 0 ; +} + +static int ma35_ooblayout_free (struct mtd_info *mtd,int section, +struct mtd_oob_region *oobregion) +{ +struct nand_chip *chip =mtd_to_nand (mtd); + +if (section) +return -ERANGE ; + + oobregion->length = mtd->oobsize - chip->ecc.total -2 ; + oobregion->offset =2 ; + +return 0 ; +} + +static const struct mtd_ooblayout_ops ma35_ooblayout_ops = { + .free = ma35_ooblayout_free, + .ecc = ma35_ooblayout_ecc, +};
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 134
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ +static inline void ma35_clear_spare (struct nand_chip *chip,int size) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +int i; + +for (i =0 ; i < size/4 ; i++)Spacing ^
I will check and fix it.
Quoted 84 lines
Quoted 72 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +72
-0+writel (0xff , nand->regs +MA35_NFI_REG_NANDRA0 ); +} + +static inline void read_remaining_bytes (struct ma35_nand_info *nand,u32 *buf, +u32 offset,int size) +{ +u32 value =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset); +u8 *ptr = (u8 *)buf; +int i; + +for (i =0 ; i < size; i++) + ptr[i] = (value >> (i *8 )) &0xff ; +} + +static inline void ma35_read_spare (struct nand_chip *chip,int size,u32 *buf,u32 offset) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +int i, j; + +if ((offset %4 ) ==0 ) { +for (i =0 , j =0 ; i < size /4 ; i++, j +=4 ) + *buf++ =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset + j); + +read_remaining_bytes (nand, buf, offset + j, size %4 ); + }else { +read_remaining_bytes (nand, buf, offset,4 - (offset %4 )); + offset +=4 ; + size -= (4 - (offset %4 )); + +for (i =0 , j =0 ; i < size /4 ; i++, j +=4 ) + *buf++ =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset + j); + +read_remaining_bytes (nand, buf, offset + j, size %4 ); + } +} + +static inline void ma35_write_spare (struct nand_chip *chip,int size,u32 *buf) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +u32 value; +int i, j; +u8 *ptr; + +for (i =0 , j =0 ; i < size /4 ; i++, j +=4 ) +writel (*buf++, nand->regs +MA35_NFI_REG_NANDRA0 + j); + + ptr = (u8 *)buf; +switch (size %4 ) { +case 1 : +writel (*ptr, nand->regs +MA35_NFI_REG_NANDRA0 + j); +break ; +case 2 : + value = *ptr | (*(ptr+1 ) <<8 ); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 + j); +break ; +case 3 : + value = *ptr | (*(ptr+1 ) <<8 ) | (*(ptr+2 ) <<16 ); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 + j); +break ; +default : +break ; + } +} + +static inline void ma35_nand_target_enable (struct ma35_nand_info *nand) +{ +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~DISABLE_CS0 ), + nand->regs+MA35_NFI_REG_NANDCTL ); +} + +static inline void ma35_nand_target_disable (struct ma35_nand_info *nand) +{drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 216
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DISABLE_CS0 , + nand->regs +MA35_NFI_REG_NANDCTL ); +} + +static void ma35_nand_hwecc_init (struct ma35_nand_info *nand) +{ +struct mtd_info *mtd =nand_to_mtd (&nand->chip); +u32 reg; + +/* resets the internal state machine and counters Please check the style in all you comments.
Quoted 2 lines
/* * Reset the
I will check and fix all.
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 221
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+* This bit will be auto cleared after a few clock cycles. +*/ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ); + reg |=SWRST ; +writel (reg, nand->regs +MA35_NFI_REG_NANDCTL );This has a way wider impact than just configuring the hw ECC engine, no? Are you sure you want to do this now? I believe it should be in its own helper, and you want to do it earlier than that, like before the discovery step (and also in the resume path).
I carefully examined our NAND controller and found that this action is unnecessary.
I will remove it.
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 223
Quoted 2 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +2
-0+while (readl (nand->regs +MA35_NFI_REG_NANDCTL ) &SWRST ) + ;
cpu_relax()
I will remove this while-loop, so this API will not be added.
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 233
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* Redundant area size */ +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +/* Protect redundant 3 bytes */ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ); + reg |= (PROT3BEN |ECC_CHK ); +writel (reg, nand->regs +MA35_NFI_REG_NANDCTL ); + +if (nand->bch ==BCH_NONE ) {Please use the definitions/constants from the core.
Will use ecc.strength instead.
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 236
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+/* Disable H/W ECC, ECC parity check enable bit during read page */ +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~ECC_EN ), + nand->regs +MA35_NFI_REG_NANDCTL );Move the readl before the if and save it in the reg variable.
In general please do not overload the lines like that when it's not needed.
It will be changed to:
reg = readl();
writel(...);
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 239
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+ }else { +/* Set BCH algorithm */ + writel((readl(nand->regs + MA35_NFI_REG_NANDCTL) & (~BCH_MASK)) |Parenthesis are not needed ^
I will remove the parentheses.
Quoted 132 lines
Quoted 132 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +132
-0+ nand->bch, nand->regs + MA35_NFI_REG_NANDCTL); + +/* Enable H/W ECC, ECC parity check enable bit during read page */ +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |ECC_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + } +} + +/* Correct data by BCH alrogithm */ +static void ma35_nfi_correct (struct ma35_nand_info *nand,u8 index, +u8 err_cnt,u8 *addr) +{ +u32 temp_data[24 ], temp_addr[24 ]; +u32 padding_len, parity_len; +u32 value, offset, remain; +u32 err_data[6 ]; +u8 i, j; + +/* configurations */ +switch (nand->bch) { +case BCH_T24 : + parity_len =MA35_PARITY_BCH24 ; + padding_len =MA35_BCH_PADDING_1024 ; +break ; +case BCH_T12 : + parity_len =MA35_PARITY_BCH12 ; + padding_len =MA35_BCH_PADDING_512 ; +break ; +case BCH_T8 : + parity_len =MA35_PARITY_BCH8 ; + padding_len =MA35_BCH_PADDING_512 ; +break ; +default : +dev_warn (nand->dev,"NAND ERROR: invalid SMCR_BCH_TSEL = 0x%08X\n" , + (u32)(readl (nand->regs +MA35_NFI_REG_NANDCTL ) &BCH_MASK )); +return ; + } + +/* got valid BCH_ECC_DATAx and parse them to temp_data[] +* got the valid register number of BCH_ECC_DATAx since +* one register include 4 error bytes +*/ + j = (err_cnt +3 ) /4 ; + j = (j >6 ) ?6 : j; +for (i =0 ; i < j; i++) + err_data[i] =readl (nand->regs +MA35_NFI_REG_NANDECCED0 + i *4 ); + +for (i =0 ; i < j; i++) { + temp_data[i*4 +0 ] = err_data[i] &0xff ; + temp_data[i*4 +1 ] = (err_data[i] >>8 ) &0xff ; + temp_data[i*4 +2 ] = (err_data[i] >>16 ) &0xff ; + temp_data[i*4 +3 ] = (err_data[i] >>24 ) &0xff ; + } + +/* got valid REG_BCH_ECC_ADDRx and parse them to temp_addr[] +* got the valid register number of REG_BCH_ECC_ADDRx since +* one register include 2 error addresses +*/ + j = (err_cnt +1 ) /2 ; + j = (j >12 ) ?12 : j; +for (i =0 ; i < j; i++) { + temp_addr[i*2 +0 ] =readl (nand->regs +MA35_NFI_REG_NANDECCEA0 + i *4 ) + &0x07ff ; + temp_addr[i*2 +1 ] = (readl (nand->regs +MA35_NFI_REG_NANDECCEA0 + i *4 ) + >>16 ) &0x07ff ; + } + +/* pointer to begin address of field that with data error */ + addr += index * nand->chip.ecc.steps; + +/* correct each error bytes */ +for (i =0 ; i < err_cnt; i++) { +u32 corrected_index = temp_addr[i]; + +/* for wrong data in field */ +if (corrected_index < nand->chip.ecc.steps) + *(addr + corrected_index) ^= temp_data[i]; + +/* for wrong first-3-bytes in redundancy area */ +else if (corrected_index < (nand->chip.ecc.steps +3 )) { + corrected_index -= nand->chip.ecc.steps; + temp_addr[i] += (parity_len * index);/* field offset */ + + value =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); + value ^= temp_data[i] << (8 * corrected_index); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 ); + } +/* for wrong parity code in redundancy area +* BCH_ERR_ADDRx = [data in field] + [3 bytes] + [xx] + [parity code] +* |<-- padding bytes -->| +* The BCH_ERR_ADDRx for last parity code always = field size + padding size. +* So, the first parity code = field size + padding size - parity code length. +* For example, for BCH T12, the first parity code = 512 + 32 - 23 = 521. +* That is, error byte address offset within field is +*/ +else { + corrected_index -= (nand->chip.ecc.steps + padding_len - parity_len); + +/* final address = first parity code of first field + +* offset of fields + +* offset within field +*/ + offset = (readl (nand->regs +MA35_NFI_REG_NANDRACTL ) &0x1ff ) - + (parity_len * nand->chip.ecc.steps) + + (parity_len * index) + corrected_index; + + remain = offset %4 ; + value =readl (nand->regs +MA35_NFI_REG_NANDRA0 + offset - remain); + value ^= temp_data[i] << (8 * remain); +writel (value, nand->regs +MA35_NFI_REG_NANDRA0 + offset - remain); + } + } +} + +static int ma35_nfi_ecc_check (struct nand_chip *chip,u8 *addr) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +int i, j, nchunks =0 ; +int report_err =0 ; +int err_cnt =0 ; +u32 status; + + nchunks = mtd->writesize / chip->ecc.steps; +if (nchunks <4 ) + nchunks =1 ; +else + nchunks /=4 ; + +for (j =0 ; j < nchunks; j++) { + status =readl (nand->regs +MA35_NFI_REG_NANDECCES0 + j *4 ); +if (!status)
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 378
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+continue ; + +for (i =0 ; i <4 ; i++) { +if (!(status &ECC_STATUS_MASK )) { +/* No error */ + status >>=8 ; +continue ;Remove this block, it will do the same and be more clear.
Indeed, this is unnecessary. I will remove it.
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 382
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ }else if ((status &ECC_STATUS_MASK ) ==0x01 ) { +/* Correctable error */ + err_cnt = (status >>2 ) &ECC_ERR_CNT_MASK ; +ma35_nfi_correct (nand, j*4 +i, err_cnt, addr);Spacing ^^^^^^
I will check and fix it.
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 387
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ report_err += err_cnt; + }else { +/* uncorrectable error */ +dev_warn (nand->dev,"uncorrectable error! 0x%4x\n" , status); +return -1 ;Not a valid error code
I will change it to return -EBADMSG;
Quoted 11 lines
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+ } + status >>=8 ; + } + } +return report_err; +} + +static void ma35_nand_dmac_init (struct ma35_nand_info *nand) +{ +/* DMAC reset and enable */ +writel (DMA_RST |DMA_EN , nand->regs +MA35_NFI_REG_DMACTL );
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 404
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+writel (DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); + +/* Clear DMA finished flag */ +writel (INT_DMA |INT_ECC , nand->regs +MA35_NFI_REG_NANDINTSTS ); + +init_completion (&nand->complete);You're gonna call
init_completionmore than once during suspend/resume cycles, this is unsafe.
I will move init_completion to probe, and then add reinit_completion in the read/write page.
Quoted 61 lines
Quoted 49 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +49
-0+} + +static int ma35_nand_do_write (struct nand_chip *chip,const u8 *addr,u32 len) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +dma_addr_t dma_addr; +int ret =0 , i; +u32 reg; + +if (len != mtd->writesize) { +for (i =0 ; i < len; i++) +writel (addr[i], nand->regs +MA35_NFI_REG_NANDDATA ); +return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +writel (INT_DMA , nand->regs +MA35_NFI_REG_NANDINTEN ); +/* To mark this page as dirty. */ + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) +writel (reg &0xffff , nand->regs +MA35_NFI_REG_NANDRA0 ); + + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_TO_DEVICE ); + ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } +dma_sync_single_for_device (nand->dev, dma_addr, len,DMA_TO_DEVICE ); + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA ); +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DMA_W_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + ret =wait_for_completion_timeout (&nand->complete,msecs_to_jiffies (1000 )); +if (!ret) { +dev_err (nand->dev,"write timeout\n" ); + ret = -ETIMEDOUT ; + } + +dma_unmap_single (nand->dev, dma_addr, len,DMA_TO_DEVICE ); + +return ret; +} + +static int ma35_nand_do_read (struct nand_chip *chip,u8 *addr,u32 len)drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 463
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +int ret =0 , cnt =0 , i; +dma_addr_t dma_addr; +u32 reg; + +if (len != mtd->writesize) { +for (i =0 ; i < len; i++) + *(addr+i) = (u8 )readl (nand->regs +MA35_NFI_REG_NANDDATA );Mmh, that line is strange. Please don't do that.
Quoted 1 line
addr[i] = readb() ?
It will be fixed to readb().
Quoted 9 lines
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +/* setup and start DMA using dma_addr */ + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_FROM_DEVICE );
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 439
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA );Please enforce a dma mask of 32 (even though it might be the fault).
I will change it to dma_addr & 0xffffffff.
Quoted 55 lines
Quoted 55 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +55
-0+writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DMA_R_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + ret =wait_for_completion_timeout (&nand->complete,msecs_to_jiffies (1000 )); +if (!ret) { +dev_err (nand->dev,"read timeout\n" ); + ret = -ETIMEDOUT ; + } + +dma_unmap_single (nand->dev, dma_addr, len,DMA_FROM_DEVICE ); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (reg &INT_ECC ) { + cnt =ma35_nfi_ecc_check (&nand->chip, addr); +if (cnt <0 ) { + mtd->ecc_stats.failed++; +writel (DMA_RST |DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |SWRST , + nand->regs +MA35_NFI_REG_NANDCTL ); + }else { + mtd->ecc_stats.corrected += cnt; + nand->bitflips = cnt; + } +writel (INT_ECC , nand->regs +MA35_NFI_REG_NANDINTSTS ); + } + +return ret; +} + +static int ma35_nand_write_page_hwecc (struct nand_chip *chip,const u8 *buf, +int oob_required,int page) +{ +struct mtd_info *mtd =nand_to_mtd (chip); +void *ecc_calc = chip->ecc.calc_buf; + +ma35_clear_spare (chip, mtd->oobsize); +ma35_write_spare (chip, mtd->oobsize - chip->ecc.total, + (u32 *)chip->oob_poi); + +nand_prog_page_begin_op (chip, page,0 , buf, mtd->writesize); +nand_prog_page_end_op (chip); + +/* Copy parity code in NANDRA to calc */ +ma35_read_spare (chip, chip->ecc.total, (u32 *)ecc_calc, + mtd->oobsize - chip->ecc.total); + +/* Copy parity code in calc to oob_poi */ +memcpy (chip->oob_poi + (mtd->oobsize - chip->ecc.total), + ecc_calc, chip->ecc.total); + +return 0 ; +} + +static int ma35_nand_read_page_hwecc (struct nand_chip *chip,u8 *buf, +int oob_required,int page) +{
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 541
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +/* read the OOB area */ +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + nand->bitflips =0 ;Why storing this value in your structure?
Because ecc.read_page needs to return bit flips, it is necessary to log them.
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 551
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* copy OOB data to NANDRA for page read */ +ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) { +memset ((void *)buf,0xff , mtd->writesize); + }else { +/* read data from nand */ +nand_read_page_op (chip, page,0 , buf, mtd->writesize);ret =
if (ret)
Quoted 1 line
...
I will add a return value here.
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 554
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+ +/* restore OOB data from SMRA */ +ma35_read_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi,0 );same
ma35_read_spare() is declared as void, with no return value.
SMRA will be changed to NANDRA registers.
Quoted 7 lines
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ } + +return nand->bitflips; +} + +static int ma35_nand_read_oob_hwecc (struct nand_chip *chip,int page) +{
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 543
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + +/* copy OOB data to NANDRA for page read */ What is NANDRA? does not mean anything to me.
NANDRA is the Redundant Area Word of the MA35 NAND controller.
The controller reads ECC parity from this area for calculations or uses the information for check.
I will change NANDRA to NANDRA registers.
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 573
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) +memset ((void *)chip->oob_poi,0xff , mtd->oobsize);What does this mean?
MA35 NAND controller checks oob bytes 2 and 3.
If this page has been written, oob bytes 2 and 3 will be set to 0.
Therefore, if bytes 2 and 3 are not 0, it indicates an empty page, and it will return 0xff.
Quoted 9 lines
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+ +return 0 ; +} + +static irqreturn_t ma35_nand_irq (int irq,void *id) +{ +struct ma35_nand_info *nand = (struct ma35_nand_info *)id; +u32 isr; +
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 587
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ isr =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (isr &INT_DMA ) { +writel (INT_DMA , nand->regs +MA35_NFI_REG_NANDINTSTS ); +complete (&nand->complete); + }I guess a more future proof implementation would always writel(isr); to silence the interrupt. Otherwise of course you must call
complete()only upon isr &INT_DMA.
This part can remove the if(), but writel(isr) is not feasible.
The isr may contain the ECC flag, and clearing it could cause a miss in ECC handling.
I will change it to:
writel(INT_DMA, nand->regs + MA35_NFI_REG_NANDINTSTS); complete(&nand->complete);
Quoted 9 lines
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+ +return IRQ_HANDLED ; +} + +static int ma35_nand_attach_chip (struct nand_chip *chip) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +unsigned int reg;
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 603
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ +if (chip->options &NAND_BUSWIDTH_16 ) { +dev_err (nand->dev,"16 bits bus width not supported" ); +return -EINVAL ; + } + +/* support only ecc hw mode */ Why ? Please don't.
I will add handling for other cases.
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 613
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+if (chip->ecc.engine_type !=NAND_ECC_ENGINE_TYPE_ON_HOST ) { +dev_err (nand->dev,"ecc.engine_type not supported\n" ); +return -EINVAL ; + } + + nand->ecc_buf =devm_kzalloc (nand->dev, mtd->writesize + mtd->oobsize, +GFP_KERNEL ); +if (!nand->ecc_buf) +return -ENOMEM ; + chip->ecc.calc_buf = nand->ecc_buf;Are you sure you need this? I don't see the point.
This is unnecessary; I will remove it.
Quoted 11 lines
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+ +/* Set PSize */ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~PSIZE_MASK ); +if (mtd->writesize ==2048 ) +writel (reg |PSIZE_2K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==4096 ) +writel (reg |PSIZE_4K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==8192 ) +writel (reg |PSIZE_8K , nand->regs +MA35_NFI_REG_NANDCTL ); + + chip->ecc.steps = mtd->writesize / chip->ecc.size;
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 629
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+if (chip->ecc.strength ==0 ) { + nand->bch =BCH_NONE ;/* No ECC */ + chip->ecc.total =0 ; + }else if (chip->ecc.strength <=8 ) { + nand->bch =BCH_T8 ;/* T8 */ bch is probably a bad name, and in general I don't see the point of saving this value. Just check the ECC strength in the above switch cases and don't use this intermediate variable.
I will change it to directly use ecc.strength for the check.
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 639
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH8 ; + }else if (chip->ecc.strength <=12 ) { + nand->bch =BCH_T12 ;/* T12 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH12 ; + }else if (chip->ecc.strength <=24 ) { + nand->bch =BCH_T24 ;/* T24 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH24 ; + }else { +dev_warn (nand->dev,"NAND Controller is not support this flash. (%d, %d)\n" , + mtd->writesize, mtd->oobsize);This must be a
dev_err()and return an error immediately.
Quoted 1 line
Also the string is not correct.
I will change it to:
dev_err(nand->dev, "ECC strength error\n"); return -EINVAL;
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 646
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ } + + chip->ecc.bytes = chip->ecc.total / chip->ecc.steps; +mtd_set_ooblayout (mtd, &ma35_ooblayout_ops); + +/* add mtd-id. The string should same as uboot definition */ + mtd->name ="nand0" ;No! There are DT labels for that and
mtd->namewill automatically be set when callingnand_set_flash_node().
I will remove it.
Quoted 32 lines
Quoted 32 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +32
-0+ +ma35_nand_hwecc_init (nand); + +writel (DISABLE_WP , nand->regs +MA35_NFI_REG_NANDECTL ); + +return 0 ; +} + +static int ma35_nfc_exec_instr (struct nand_chip *chip, +const struct nand_op_instr *instr) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +unsigned int i; +u32 status; + +switch (instr->type) { +case NAND_OP_CMD_INSTR : +writel (instr->ctx.cmd.opcode, nand->regs +MA35_NFI_REG_NANDCMD ); +return 0 ; +case NAND_OP_ADDR_INSTR : +for (i =0 ; i < instr->ctx.addr.naddrs; i++) { +if (i == (instr->ctx.addr.naddrs -1 )) +writel (instr->ctx.addr.addrs[i] |ENDADDR , + nand->regs +MA35_NFI_REG_NANDADDR ); +else +writel (instr->ctx.addr.addrs[i], + nand->regs +MA35_NFI_REG_NANDADDR ); + } +return 0 ; +case NAND_OP_DATA_IN_INSTR : +ma35_nand_do_read (chip, instr->ctx.data.buf.in, instr->ctx.data.len); +return 0 ;
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 685
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+case NAND_OP_DATA_OUT_INSTR : +ma35_nand_do_write (chip, instr->ctx.data.buf.out, instr->ctx.data.len); +return 0 ; +case NAND_OP_WAITRDY_INSTR : +return readl_poll_timeout (nand->regs +MA35_NFI_REG_NANDINTSTS , status, + status &INT_RB0 ,20 , + instr->ctx.waitrdy.timeout_ms *1000 );
MSEC_PER_SEC
I will change it to instr->ctx.waitrdy.timeout_ms * MSEC_PER_SEC.
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 691
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+default : +break ; + } + +return -EINVAL ; +}This is much better than the legacy hooks!
Thanks.
Quoted 18 lines
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+ +static int ma35_nfc_exec_op (struct nand_chip *chip, +const struct nand_operation *op, +bool check_only) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip);drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 707
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+int ret =0 ; +u32 i, reg; + +if (check_only) +return 0 ; + +ma35_nand_target_enable (nand); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); + reg |=INT_RB0 ;This RB pin looks like something hardcoded, whereas it should not :-)
Quoted 1 line
If you have several RB, it means you have several CS as well!
The MA35 NAND controller is indeed expected to support two sets of CS and RB.
However, currently, the MA35 series only supports one set, so this name will be changed to RB.
Quoted 38 lines
Quoted 38 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +38
-0+writel (reg, nand->regs +MA35_NFI_REG_NANDINTSTS ); + +for (i =0 ; i < op->ninstrs; i++) { + ret =ma35_nfc_exec_instr (chip, &op->instrs[i]); +if (ret) +break ; + } + +ma35_nand_target_disable (nand); + +return ret; +} + +static const struct nand_controller_ops ma35_nfc_ops = { + .attach_chip = ma35_nand_attach_chip, + .exec_op = ma35_nfc_exec_op, +}; + +static int ma35_nand_probe (struct platform_device *pdev) +{ +struct ma35_nand_info *nand; +struct nand_chip *chip; +struct mtd_info *mtd; +int ret =0 ; + + nand =devm_kzalloc (&pdev->dev,sizeof (*nand),GFP_KERNEL ); +if (!nand) +return -ENOMEM ; + +nand_controller_init (&nand->controller); + nand->controller.ops = &ma35_nfc_ops; + + nand->regs =devm_platform_ioremap_resource (pdev,0 ); +if (IS_ERR (nand->regs)) +return PTR_ERR (nand->regs); + + nand->dev = &pdev->dev; + chip = &nand->chip;
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 752
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+nand_set_controller_data (chip, nand); +nand_set_flash_node (chip, pdev->dev.of_node); + + nand->clk =devm_clk_get_enabled (&pdev->dev,"nand_gate" ); +if (IS_ERR (nand->clk)) +return dev_err_probe (&pdev->dev,PTR_ERR (nand->clk), +"failed to find nand clock\n" );NAND
I will fix it.
Quoted 18 lines
Quoted 18 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +18
-0+ + nand->irq =platform_get_irq (pdev,0 ); +if (nand->irq <0 ) +return dev_err_probe (&pdev->dev, nand->irq, +"failed to get platform irq\n" ); + + ret =devm_request_irq (&pdev->dev, nand->irq, ma35_nand_irq, +IRQF_TRIGGER_HIGH ,"ma35d1-nand" , nand); +if (ret) { +dev_err (&pdev->dev,"failed to request NAND irq\n" ); +return -ENXIO ; + } + + nand->chip.controller = &nand->controller; +platform_set_drvdata (pdev, nand); + + chip->options |=NAND_NO_SUBPAGE_WRITE |NAND_USES_DMA ; +
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 774
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ chip->ecc.engine_type =NAND_ECC_ENGINE_TYPE_ON_HOST ; + chip->ecc.write_page = ma35_nand_write_page_hwecc; + chip->ecc.read_page = ma35_nand_read_page_hwecc; + chip->ecc.read_oob = ma35_nand_read_oob_hwecc;You support to disable the ECC engine, so you must support software corrections as well. Please don't force hw ECC use. Please look at other implementations, there is usually a helper with a switch case which supports various ECC configurations.
I will refer to other implementations and will add handling for other cases.
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 781
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ + mtd =nand_to_mtd (chip); + mtd->priv = chip; + mtd->owner =THIS_MODULE ; + mtd->dev.parent = &pdev->dev; + +writel (NAND_EN , nand->regs +MA35_NFI_REG_GCTL );I would expect your reset bit to be set before this writel.
Are you referring to SWRST? I will call the reset engine before enabling it.
Quoted 5 lines
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ + ret =nand_scan (chip,1 ); +if (ret) +return ret; +
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 793
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ ret =mtd_device_register (mtd,NULL ,0 ); +if (ret) { +nand_cleanup (chip); +return ret; + } + +return ret;return 0; then
I will change it to return 0;
Quoted 14 lines
Quoted 14 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +14
-0+} + +static void ma35_nand_remove (struct platform_device *pdev) +{ +struct ma35_nand_info *nand =platform_get_drvdata (pdev); +int ret; + + ret =mtd_device_unregister (nand_to_mtd (&nand->chip)); +WARN_ON (ret); +nand_cleanup (&nand->chip); +} + +/* PM Support */ +#ifdef CONFIG_PM
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 814
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+static int ma35_nand_suspend (struct platform_device *pdev,pm_message_t pm) +{ +struct ma35_nand_info *nand =platform_get_drvdata (pdev); +int ret =0 ; +u32 val; + +/* wait DMAC to ready */ be
I will fix it.
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 818
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ ret =readl_poll_timeout (nand->regs +MA35_NFI_REG_DMACTL , val, + !(val &DMA_BUSY ),50 ,HZ /2 ); +if (ret) +dev_warn (&pdev->dev,"dma busy\n" );DMA
And please make a sentence.
I will fix it.
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 820
Quoted 2 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +2
-0+ +clk_disable (nand->clk);If you decide to return ret != 0, shall you really disable this clock ?
I will change it to:
/* wait DMAC to be ready */
ret = readl_poll_timeout(nand->regs + MA35_NFI_REG_DMACTL, val, !(val & DMA_BUSY), 50, HZ/2);
if (ret) {
dev_warn(&pdev->dev, "wait DMA done timeout.\n"); return ret;
}
clk_disable(nand->clk);
return 0;
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 830
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +return ret; +} + +static int ma35_nand_resume (struct platform_device *pdev) +{ +struct ma35_nand_info *nand =platform_get_drvdata (pdev); + +clk_enable (nand->clk); +ma35_nand_hwecc_init (nand);The naming is wrong. This init is not just the hw ECC controller.
This will be changed to handle the initialization of the NAND controller and ECC controller.
It will also call nand_reset().
Quoted 4 lines
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ma35_nand_dmac_init (nand); + +return 0 ; +}
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 841
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ +#else +#define ma35_nand_suspend NULL +#define ma35_nand_resume NULL +#endif + +static const struct of_device_id ma35_nfi_of_match[] = {
ma35_nfiorma35_nand, take one and please stick to it.
Will be unified into ma35_nand.
Quoted 16 lines
Quoted 16 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +16
-0+ { .compatible = "nuvoton,ma35d1-nand" }, + {}, +}; +MODULE_DEVICE_TABLE (of, ma35_nfi_of_match); + +static struct platform_driver ma35_nand_driver = { + .driver = { + .name ="ma35d1-nand" , + .of_match_table = ma35_nfi_of_match, + }, + .probe = ma35_nand_probe, + .remove = ma35_nand_remove, + .suspend = ma35_nand_suspend, + .resume = ma35_nand_resume, +}; +
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 862
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+module_platform_driver (ma35_nand_driver); + +MODULE_DESCRIPTION ("Nuvoton ma35 NAND driver" ); +MODULE_AUTHOR ("Hui-Ping Chen <[email protected]>" ); +MODULE_LICENSE ("GPL" );Thanks,
Miquèl
Best regards,
Hui-Ping Chen
Miquel Raynal
maintainerRe: [PATCH v6 2/2] mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
Hi Hui-Ping,
Quoted 18 lines
Quoted 9 lines
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +/* setup and start DMA using dma_addr */ + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_FROM_DEVICE );Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 439
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA );Please enforce a dma mask of 32 (even though it might be the fault).
Quoted 1 line
I will change it to
dma_addr&0xffffffff.
That's not what I mean, I believe you should use the dma API to ask for a mapping within the accessible 32-bit address range. The dma_mapping_error() check should return an error if that's not the case. Then you can safely write the value.
Quoted 64 lines
Quoted 55 lines
Quoted 55 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +55
-0+writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DMA_R_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + ret =wait_for_completion_timeout (&nand->complete,msecs_to_jiffies (1000 )); +if (!ret) { +dev_err (nand->dev,"read timeout\n" ); + ret = -ETIMEDOUT ; + } + +dma_unmap_single (nand->dev, dma_addr, len,DMA_FROM_DEVICE ); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (reg &INT_ECC ) { + cnt =ma35_nfi_ecc_check (&nand->chip, addr); +if (cnt <0 ) { + mtd->ecc_stats.failed++; +writel (DMA_RST |DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |SWRST , + nand->regs +MA35_NFI_REG_NANDCTL ); + }else { + mtd->ecc_stats.corrected += cnt; + nand->bitflips = cnt; + } +writel (INT_ECC , nand->regs +MA35_NFI_REG_NANDINTSTS ); + } + +return ret; +} + +static int ma35_nand_write_page_hwecc (struct nand_chip *chip,const u8 *buf, +int oob_required,int page) +{ +struct mtd_info *mtd =nand_to_mtd (chip); +void *ecc_calc = chip->ecc.calc_buf; + +ma35_clear_spare (chip, mtd->oobsize); +ma35_write_spare (chip, mtd->oobsize - chip->ecc.total, + (u32 *)chip->oob_poi); + +nand_prog_page_begin_op (chip, page,0 , buf, mtd->writesize); +nand_prog_page_end_op (chip); + +/* Copy parity code in NANDRA to calc */ +ma35_read_spare (chip, chip->ecc.total, (u32 *)ecc_calc, + mtd->oobsize - chip->ecc.total); + +/* Copy parity code in calc to oob_poi */ +memcpy (chip->oob_poi + (mtd->oobsize - chip->ecc.total), + ecc_calc, chip->ecc.total); + +return 0 ; +} + +static int ma35_nand_read_page_hwecc (struct nand_chip *chip,u8 *buf, +int oob_required,int page) +{Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 541
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +/* read the OOB area */ +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + nand->bitflips =0 ;Why storing this value in your structure?
Quoted 1 line
Because ecc.read_page needs to return bit flips, it is necessary to log them.
I believe you don't need bitflips to be part of the ma35_nand_info structure.
Quoted 44 lines
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 551
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* copy OOB data to NANDRA for page read */ +ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) { +memset ((void *)buf,0xff , mtd->writesize); + }else { +/* read data from nand */ +nand_read_page_op (chip, page,0 , buf, mtd->writesize);ret =
if (ret)Quoted 1 line
...I will add a return value here.
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 554
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+ +/* restore OOB data from SMRA */ +ma35_read_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi,0 );same
ma35_read_spare()is declared as void, with no return value.SMRA will be changed to NANDRA registers.
Quoted 7 lines
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ } + +return nand->bitflips; +} + +static int ma35_nand_read_oob_hwecc (struct nand_chip *chip,int page) +{Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 543
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + +/* copy OOB data to NANDRA for page read */ What is NANDRA? does not mean anything to me.
Quoted 1 line
NANDRA is the Redundant Area Word of the MA35 NAND controller.
NANDRA is specific to your controller. "redundant area" is already more understandable.
Quoted 2 lines
The controller reads ECC parity from this area for calculations or uses the information for check.
This is what we generically call the "ECC bytes/area" I guess?
Quoted 11 lines
I will change NANDRA to NANDRA registers.
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 573
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) +memset ((void *)chip->oob_poi,0xff , mtd->oobsize);What does this mean?
Quoted 5 lines
MA35 NAND controller checks oob bytes 2 and 3.
If this page has been written, oob bytes 2 and 3 will be set to 0.
Therefore, if bytes 2 and 3 are not 0, it indicates an empty page, and it will return
0xff.
Ok, please define a macro for that, something along:
#define PREFIX_RA_HAS_BEEN_WRITTEN(reg) FIELD_GET(GENMASK(..), (reg))
if (!PREFIX_RA_HAS_BEEN_WRITTEN(reg))
memset();
Quoted 20 lines
Quoted 11 lines
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+ +return 0 ; +} + +static irqreturn_t ma35_nand_irq (int irq,void *id) +{ +struct ma35_nand_info *nand = (struct ma35_nand_info *)id; +u32 isr; +Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 587
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ isr =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (isr &INT_DMA ) { +writel (INT_DMA , nand->regs +MA35_NFI_REG_NANDINTSTS ); +complete (&nand->complete); + }I guess a more future proof implementation would always writel(isr); to silence the interrupt. Otherwise of course you must call
complete()only upon isr &INT_DMA.
Quoted 8 lines
This part can remove the
if(), but writel(isr) is not feasible.The isr may contain the ECC flag, and clearing it could cause a miss in ECC handling.
I will change it to:
writel(INT_DMA, nand->regs + MA35_NFI_REG_NANDINTSTS);complete(&nand->complete);
In this case keep the if() but be sure to handle the timeout correctly.
Quoted 73 lines
Quoted 11 lines
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+ +return IRQ_HANDLED ; +} + +static int ma35_nand_attach_chip (struct nand_chip *chip) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +unsigned int reg;Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 603
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ +if (chip->options &NAND_BUSWIDTH_16 ) { +dev_err (nand->dev,"16 bits bus width not supported" ); +return -EINVAL ; + } + +/* support only ecc hw mode */ Why ? Please don't.
I will add handling for other cases.
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 613
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+if (chip->ecc.engine_type !=NAND_ECC_ENGINE_TYPE_ON_HOST ) { +dev_err (nand->dev,"ecc.engine_type not supported\n" ); +return -EINVAL ; + } + + nand->ecc_buf =devm_kzalloc (nand->dev, mtd->writesize + mtd->oobsize, +GFP_KERNEL ); +if (!nand->ecc_buf) +return -ENOMEM ; + chip->ecc.calc_buf = nand->ecc_buf;Are you sure you need this? I don't see the point.
This is unnecessary; I will remove it.
Quoted 11 lines
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+ +/* Set PSize */ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~PSIZE_MASK ); +if (mtd->writesize ==2048 ) +writel (reg |PSIZE_2K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==4096 ) +writel (reg |PSIZE_4K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==8192 ) +writel (reg |PSIZE_8K , nand->regs +MA35_NFI_REG_NANDCTL ); + + chip->ecc.steps = mtd->writesize / chip->ecc.size;Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 629
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+if (chip->ecc.strength ==0 ) { + nand->bch =BCH_NONE ;/* No ECC */ + chip->ecc.total =0 ; + }else if (chip->ecc.strength <=8 ) { + nand->bch =BCH_T8 ;/* T8 */ bch is probably a bad name, and in general I don't see the point of saving this value. Just check the ECC strength in the above switch cases and don't use this intermediate variable.
I will change it to directly use ecc.strength for the check.
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 639
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH8 ; + }else if (chip->ecc.strength <=12 ) { + nand->bch =BCH_T12 ;/* T12 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH12 ; + }else if (chip->ecc.strength <=24 ) { + nand->bch =BCH_T24 ;/* T24 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH24 ; + }else { +dev_warn (nand->dev,"NAND Controller is not support this flash. (%d, %d)\n" , + mtd->writesize, mtd->oobsize);This must be a
dev_err()and return an error immediately.
Quoted 5 lines
Quoted 1 line
Also the string is not correct.
I will change it to:
dev_err(nand->dev, "ECC strength error\n");
unsupported
Quoted 3 lines
return
-EINVAL;
...
Quoted 19 lines
Quoted 19 lines
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+ +static int ma35_nfc_exec_op (struct nand_chip *chip, +const struct nand_operation *op, +bool check_only) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip);drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 707
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+int ret =0 ; +u32 i, reg; + +if (check_only) +return 0 ; + +ma35_nand_target_enable (nand); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); + reg |=INT_RB0 ;This RB pin looks like something hardcoded, whereas it should not :-)
Quoted 5 lines
Quoted 1 line
If you have several RB, it means you have several CS as well!
The MA35 NAND controller is indeed expected to support two sets of CS and RB.
However, currently, the MA35 series only supports one set, so this name will be changed to RB.
No, please use the correct names for RB and CS, but please read the value of the right RB and right CS from the DT (reg and nand-rb). These properties are standard and can be used to use eg CS1 and RB1. In this case the whole driver logic is the same, there is a single CS supported, but it becomes correct because you don't silently assume CS0 and RB0 will always be used (you would be surprised by the number of designs not using the first CS/RB). It's just a bit of additional logic, nothing complex here.
...
Quoted 10 lines
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 781
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ + mtd =nand_to_mtd (chip); + mtd->priv = chip; + mtd->owner =THIS_MODULE ; + mtd->dev.parent = &pdev->dev; + +writel (NAND_EN , nand->regs +MA35_NFI_REG_GCTL );I would expect your reset bit to be set before this writel.
Are you referring to SWRST? I will call the reset engine before enabling it.
Yes, thanks.
Thanks,
Miquèl
Re: [PATCH v6 2/2] mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
Dear Miquel,
Thank you for your reply.
Quoted 19 lines · Miquel Raynal
Hi Hui-Ping,
Quoted 17 lines
Quoted 17 lines
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL );drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 479
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* setup and start DMA using dma_addr */ + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_FROM_DEVICE ); + ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA );Please enforce a dma mask of 32 (even though it might be the fault).
Quoted 5 lines
Quoted 1 line
I will change it to
dma_addr&0xffffffff.That's not what I mean, I believe you should use the dma API to ask for a mapping within the accessible 32-bit address range. The
dma_mapping_error()check should return an error if that's not the case. Then you can safely write the value.
Here is my misunderstanding: just fill in the dma_addr directly,
no type conversion is needed. I have already tested it.
Quoted 63 lines
Quoted 63 lines
Quoted 63 lines
Quoted 52 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +52
-0+writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |DMA_R_EN , + nand->regs +MA35_NFI_REG_NANDCTL ); + ret =wait_for_completion_timeout (&nand->complete,msecs_to_jiffies (1000 )); +if (!ret) { +dev_err (nand->dev,"read timeout\n" ); + ret = -ETIMEDOUT ; + } + +dma_unmap_single (nand->dev, dma_addr, len,DMA_FROM_DEVICE ); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (reg &INT_ECC ) { + cnt =ma35_nfi_ecc_check (&nand->chip, addr); +if (cnt <0 ) { + mtd->ecc_stats.failed++; +writel (DMA_RST |DMA_EN , nand->regs +MA35_NFI_REG_DMACTL ); +writel (readl (nand->regs +MA35_NFI_REG_NANDCTL ) |SWRST , + nand->regs +MA35_NFI_REG_NANDCTL ); + }else { + mtd->ecc_stats.corrected += cnt; + nand->bitflips = cnt; + } +writel (INT_ECC , nand->regs +MA35_NFI_REG_NANDINTSTS ); + } + +return ret; +} + +static int ma35_nand_write_page_hwecc (struct nand_chip *chip,const u8 *buf, +int oob_required,int page) +{ +struct mtd_info *mtd =nand_to_mtd (chip); +void *ecc_calc = chip->ecc.calc_buf; + +ma35_clear_spare (chip, mtd->oobsize); +ma35_write_spare (chip, mtd->oobsize - chip->ecc.total, + (u32 *)chip->oob_poi); + +nand_prog_page_begin_op (chip, page,0 , buf, mtd->writesize); +nand_prog_page_end_op (chip); + +/* Copy parity code in NANDRA to calc */ +ma35_read_spare (chip, chip->ecc.total, (u32 *)ecc_calc, + mtd->oobsize - chip->ecc.total); + +/* Copy parity code in calc to oob_poi */ +memcpy (chip->oob_poi + (mtd->oobsize - chip->ecc.total), + ecc_calc, chip->ecc.total); + +return 0 ; +} +drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 541
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+static int ma35_nand_read_page_hwecc (struct nand_chip *chip,u8 *buf, +int oob_required,int page) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +/* read the OOB area */ +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + nand->bitflips =0 ;Why storing this value in your structure?
Quoted 3 lines
Quoted 1 line
Because ecc.read_page needs to return bit flips, it is necessary to log them.
I believe you don't need bitflips to be part of the
ma35_nand_infostructure.
I will remove this variable and then investigate where to obtain the information from.
Quoted 40 lines
Quoted 40 lines
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 551
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +/* copy OOB data to NANDRA for page read */ +ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) { +memset ((void *)buf,0xff , mtd->writesize); + }else { +/* read data from nand */ +nand_read_page_op (chip, page,0 , buf, mtd->writesize);ret =
if (ret)Quoted 1 line
...I will add a return value here.
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 554
Quoted 3 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +3
-0+ +/* restore OOB data from SMRA */ +ma35_read_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi,0 );same
ma35_read_spare()is declared as void, with no return value.SMRA will be changed to NANDRA registers.
Quoted 15 lines
Quoted 4 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +4
-0+ } + +return nand->bitflips; +}drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 568
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ +static int ma35_nand_read_oob_hwecc (struct nand_chip *chip,int page) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +u32 reg; + +nand_read_oob_op (chip, page,0 , chip->oob_poi, mtd->oobsize); + +/* copy OOB data to NANDRA for page read */ What is NANDRA? does not mean anything to me.
Quoted 3 lines
Quoted 1 line
NANDRA is the Redundant Area Word of the MA35 NAND controller.
NANDRA is specific to your controller. "redundant area" is already more understandable.
I will change the comment to
/* copy oob data to controller redundant area for page read */
Quoted 2 lines
Quoted 1 line
The controller reads ECC parity from this area for calculations or uses the information for check.
This is what we generically call the "ECC bytes/area" I guess?
Yes
Quoted 13 lines
Quoted 13 lines
I will change NANDRA to NANDRA registers.
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 573
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ma35_write_spare (chip, mtd->oobsize, (u32 *)chip->oob_poi); + + reg =readl (nand->regs +MA35_NFI_REG_NANDRA0 ); +if (reg &0xffff0000 ) +memset ((void *)chip->oob_poi,0xff , mtd->oobsize);What does this mean?
MA35 NAND controller checks oob bytes 2 and 3.
If this page has been written, oob bytes 2 and 3 will be set to 0.
Quoted 7 lines
Quoted 1 line
Therefore, if bytes 2 and 3 are not 0, it indicates an empty page, and it will return
0xff.Ok, please define a macro for that, something along:
#define
PREFIX_RA_HAS_BEEN_WRITTEN(reg)FIELD_GET(GENMASK(..), (reg))if (!PREFIX_RA_HAS_BEEN_WRITTEN(reg))
memset();
I will define a macro. Thank you.
Quoted 20 lines
Quoted 20 lines
Quoted 10 lines
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+ +return 0 ; +} + +static irqreturn_t ma35_nand_irq (int irq,void *id) +{ +struct ma35_nand_info *nand = (struct ma35_nand_info *)id; +u32 isr; +Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 587
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+ isr =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); +if (isr &INT_DMA ) { +writel (INT_DMA , nand->regs +MA35_NFI_REG_NANDINTSTS ); +complete (&nand->complete); + }I guess a more future proof implementation would always writel(isr); to silence the interrupt. Otherwise of course you must call
complete()only upon isr &INT_DMA.This part can remove the
if(), but writel(isr) is not feasible.
Quoted 7 lines
Quoted 6 lines
The isr may contain the ECC flag, and clearing it could cause a miss in ECC handling.
I will change it to:
writel(INT_DMA, nand->regs + MA35_NFI_REG_NANDINTSTS); complete(&nand->complete);In this case keep the
if()but be sure to handle the timeout correctly.
OK.
Quoted 69 lines
Quoted 69 lines
Quoted 10 lines
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+ +return IRQ_HANDLED ; +} + +static int ma35_nand_attach_chip (struct nand_chip *chip) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip); +struct mtd_info *mtd =nand_to_mtd (chip); +unsigned int reg;Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 603
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ +if (chip->options &NAND_BUSWIDTH_16 ) { +dev_err (nand->dev,"16 bits bus width not supported" ); +return -EINVAL ; + } + +/* support only ecc hw mode */ Why ? Please don't.
I will add handling for other cases.
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 613
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+if (chip->ecc.engine_type !=NAND_ECC_ENGINE_TYPE_ON_HOST ) { +dev_err (nand->dev,"ecc.engine_type not supported\n" ); +return -EINVAL ; + } + + nand->ecc_buf =devm_kzalloc (nand->dev, mtd->writesize + mtd->oobsize, +GFP_KERNEL ); +if (!nand->ecc_buf) +return -ENOMEM ; + chip->ecc.calc_buf = nand->ecc_buf;Are you sure you need this? I don't see the point.
This is unnecessary; I will remove it.
Quoted 11 lines
Quoted 11 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +11
-0+ +/* Set PSize */ + reg =readl (nand->regs +MA35_NFI_REG_NANDCTL ) & (~PSIZE_MASK ); +if (mtd->writesize ==2048 ) +writel (reg |PSIZE_2K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==4096 ) +writel (reg |PSIZE_4K , nand->regs +MA35_NFI_REG_NANDCTL ); +else if (mtd->writesize ==8192 ) +writel (reg |PSIZE_8K , nand->regs +MA35_NFI_REG_NANDCTL ); + + chip->ecc.steps = mtd->writesize / chip->ecc.size;Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 629
Quoted 5 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +5
-0+if (chip->ecc.strength ==0 ) { + nand->bch =BCH_NONE ;/* No ECC */ + chip->ecc.total =0 ; + }else if (chip->ecc.strength <=8 ) { + nand->bch =BCH_T8 ;/* T8 */ bch is probably a bad name, and in general I don't see the point of saving this value. Just check the ECC strength in the above switch cases and don't use this intermediate variable.
I will change it to directly use ecc.strength for the check.
Quoted 12 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 639
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+ chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH8 ; + }else if (chip->ecc.strength <=12 ) { + nand->bch =BCH_T12 ;/* T12 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH12 ; + }else if (chip->ecc.strength <=24 ) { + nand->bch =BCH_T24 ;/* T24 */ + chip->ecc.total = chip->ecc.steps *MA35_PARITY_BCH24 ; + }else { +dev_warn (nand->dev,"NAND Controller is not support this flash. (%d, %d)\n" , + mtd->writesize, mtd->oobsize);This must be a
dev_err()and return an error immediately.
Quoted 5 lines
Quoted 4 lines
Quoted 1 line
Also the string is not correct.
I will change it to:
dev_err(nand->dev, "ECC strength error\n");unsupported
I will fix it.
Quoted 27 lines
Quoted 3 lines
return
-EINVAL;...
Quoted 18 lines
Quoted 18 lines
Quoted 6 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +6
-0+ +static int ma35_nfc_exec_op (struct nand_chip *chip, +const struct nand_operation *op, +bool check_only) +{ +struct ma35_nand_info *nand =nand_get_controller_data (chip);drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 707
Quoted 10 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +10
-0+int ret =0 ; +u32 i, reg; + +if (check_only) +return 0 ; + +ma35_nand_target_enable (nand); + + reg =readl (nand->regs +MA35_NFI_REG_NANDINTSTS ); + reg |=INT_RB0 ;This RB pin looks like something hardcoded, whereas it should not :-)
Quoted 4 lines
Quoted 1 line
If you have several RB, it means you have several CS as well!
The MA35 NAND controller is indeed expected to support two sets of CS and RB.
However, currently, the MA35 series only supports one set, so this name will be changed to RB.
Quoted 9 lines
No, please use the correct names for RB and CS, but please read the value of the right RB and right CS from the DT (reg and nand-rb). These properties are standard and can be used to use eg CS1 and RB1. In this case the whole driver logic is the same, there is a single CS supported, but it becomes correct because you don't silently assume CS0 and RB0 will always be used (you would be surprised by the number of designs not using the first CS/RB). It's just a bit of additional logic, nothing complex here.
Okay. I'll look into how to make the modifications.
Quoted 10 lines
...
Quoted 8 lines
Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 781
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ + mtd =nand_to_mtd (chip); + mtd->priv = chip; + mtd->owner =THIS_MODULE ; + mtd->dev.parent = &pdev->dev; + +writel (NAND_EN , nand->regs +MA35_NFI_REG_GCTL );I would expect your reset bit to be set before this writel.
Quoted 2 lines
Quoted 1 line
Are you referring to SWRST? I will call the reset engine before enabling it.
Yes, thanks.
Thank you.
Quoted 3 lines
Thanks,
Miquèl
Best regards,
Hui-Ping Chen
Miquel Raynal
maintainerRe: [PATCH v6 2/2] mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
Hi Hui-Ping,
Quoted 18 lines
Quoted 18 lines
Quoted 18 lines
Quoted 9 lines
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +/* setup and start DMA using dma_addr */ + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_FROM_DEVICE );Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 439
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA );Please enforce a dma mask of 32 (even though it might be the fault).
I will change it to
dma_addr&0xffffffff.
Quoted 8 lines
Quoted 4 lines
That's not what I mean, I believe you should use the dma API to ask for a mapping within the accessible 32-bit address range. The
dma_mapping_error()check should return an error if that's not the case. Then you can safely write the value.Here is my misunderstanding: just fill in the
dma_addrdirectly,no type conversion is needed. I have already tested it.
FYI, it only works because the default DMA mask for your device is gonna be 32 bits. If the reality (what your peripheral DMA can do) was different than this, you would have to set a different mask explicitly to make sure the dma-mapping step would not provide buffers which are out of reach.
Thanks,
Miquèl
Re: [PATCH v6 2/2] mtd: rawnand: nuvoton: add new driver for the Nuvoton MA35 SoC
Dear Miquel,
Thank you for your reply.
Quoted 24 lines · Miquel Raynal
Hi Hui-Ping,
Quoted 22 lines
Quoted 22 lines
Quoted 17 lines
Quoted 9 lines
Quoted 9 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +9
-0+return 0 ; + } + +ma35_nand_dmac_init (nand); + +writel (mtd->oobsize, nand->regs +MA35_NFI_REG_NANDRACTL ); + +/* setup and start DMA using dma_addr */ + dma_addr =dma_map_single (nand->dev, (void *)addr, len,DMA_FROM_DEVICE );Quoted 8 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c line 439
Quoted 7 lines
drivers/mtd/nand/raw/nuvoton_ma35d1_nand.c new file +7
-0+ ret =dma_mapping_error (nand->dev, dma_addr); +if (ret) { +dev_err (nand->dev,"dma mapping error\n" ); +return -EINVAL ; + } + +writel ((unsigned long )dma_addr, nand->regs +MA35_NFI_REG_DMASA );Please enforce a dma mask of 32 (even though it might be the fault).
Quoted 1 line
I will change it to
dma_addr&0xffffffff.That's not what I mean, I believe you should use the dma API to ask for a mapping within the accessible 32-bit address range. The
dma_mapping_error()check should return an error if that's not the case. Then you can safely write the value.
Quoted 8 lines
Quoted 3 lines
Here is my misunderstanding: just fill in the
dma_addrdirectly,no type conversion is needed. I have already tested it.
FYI, it only works because the default DMA mask for your device is gonna be 32 bits. If the reality (what your peripheral DMA can do) was different than this, you would have to set a different mask explicitly to make sure the dma-mapping step would not provide buffers which are out of reach.
Sure, I will keep that in mind. However, due to the memory architecture of the MA35,
which is designed for a maximum of 4GB, there won’t be any situation exceeding 32 bits.
Thank you.
Quoted 2 lines
Thanks,
Miquèl
Best regards,
Hui-Ping Chen