1 // SPDX-License-Identifier: GPL-2.0 OR MIT
3 * MTK ECC controller driver.
4 * Copyright (C) 2016 MediaTek Inc.
5 * Authors: Xiaolei Li <xiaolei.li@mediatek.com>
6 * Jorge Ramirez-Ortiz <jorge.ramirez-ortiz@linaro.org>
9 #include <linux/platform_device.h>
10 #include <linux/dma-mapping.h>
11 #include <linux/interrupt.h>
12 #include <linux/clk.h>
13 #include <linux/module.h>
14 #include <linux/iopoll.h>
16 #include <linux/of_platform.h>
17 #include <linux/mutex.h>
21 #define ECC_IDLE_MASK BIT(0)
22 #define ECC_IRQ_EN BIT(0)
23 #define ECC_PG_IRQ_SEL BIT(1)
24 #define ECC_OP_ENABLE (1)
25 #define ECC_OP_DISABLE (0)
27 #define ECC_ENCCON (0x00)
28 #define ECC_ENCCNFG (0x04)
29 #define ECC_MS_SHIFT (16)
30 #define ECC_ENCDIADDR (0x08)
31 #define ECC_ENCIDLE (0x0C)
32 #define ECC_DECCON (0x100)
33 #define ECC_DECCNFG (0x104)
34 #define DEC_EMPTY_EN BIT(31)
35 #define DEC_CNFG_CORRECT (0x3 << 12)
36 #define ECC_DECIDLE (0x10C)
37 #define ECC_DECENUM0 (0x114)
39 #define ECC_TIMEOUT (500000)
41 #define ECC_IDLE_REG(op) ((op) == ECC_ENCODE ? ECC_ENCIDLE : ECC_DECIDLE)
42 #define ECC_CTL_REG(op) ((op) == ECC_ENCODE ? ECC_ENCCON : ECC_DECCON)
47 const u8 *ecc_strength;
57 const struct mtk_ecc_caps *caps;
61 struct completion done;
68 /* ecc strength that each IP supports */
69 static const u8 ecc_strength_mt2701[] = {
70 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 28, 32, 36,
71 40, 44, 48, 52, 56, 60
74 static const u8 ecc_strength_mt2712[] = {
75 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 28, 32, 36,
76 40, 44, 48, 52, 56, 60, 68, 72, 80
79 static const u8 ecc_strength_mt7622[] = {
92 static int mt2701_ecc_regs[] = {
93 [ECC_ENCPAR00] = 0x10,
94 [ECC_ENCIRQ_EN] = 0x80,
95 [ECC_ENCIRQ_STA] = 0x84,
96 [ECC_DECDONE] = 0x124,
97 [ECC_DECIRQ_EN] = 0x200,
98 [ECC_DECIRQ_STA] = 0x204,
101 static int mt2712_ecc_regs[] = {
102 [ECC_ENCPAR00] = 0x300,
103 [ECC_ENCIRQ_EN] = 0x80,
104 [ECC_ENCIRQ_STA] = 0x84,
105 [ECC_DECDONE] = 0x124,
106 [ECC_DECIRQ_EN] = 0x200,
107 [ECC_DECIRQ_STA] = 0x204,
110 static int mt7622_ecc_regs[] = {
111 [ECC_ENCPAR00] = 0x10,
112 [ECC_ENCIRQ_EN] = 0x30,
113 [ECC_ENCIRQ_STA] = 0x34,
114 [ECC_DECDONE] = 0x11c,
115 [ECC_DECIRQ_EN] = 0x140,
116 [ECC_DECIRQ_STA] = 0x144,
119 static inline void mtk_ecc_wait_idle(struct mtk_ecc *ecc,
120 enum mtk_ecc_operation op)
122 struct device *dev = ecc->dev;
126 ret = readl_poll_timeout_atomic(ecc->regs + ECC_IDLE_REG(op), val,
130 dev_warn(dev, "%s NOT idle\n",
131 op == ECC_ENCODE ? "encoder" : "decoder");
134 static irqreturn_t mtk_ecc_irq(int irq, void *id)
136 struct mtk_ecc *ecc = id;
139 dec = readw(ecc->regs + ecc->caps->ecc_regs[ECC_DECIRQ_STA])
142 dec = readw(ecc->regs + ecc->caps->ecc_regs[ECC_DECDONE]);
143 if (dec & ecc->sectors) {
145 * Clear decode IRQ status once again to ensure that
146 * there will be no extra IRQ.
148 readw(ecc->regs + ecc->caps->ecc_regs[ECC_DECIRQ_STA]);
150 complete(&ecc->done);
155 enc = readl(ecc->regs + ecc->caps->ecc_regs[ECC_ENCIRQ_STA])
158 complete(&ecc->done);
166 static int mtk_ecc_config(struct mtk_ecc *ecc, struct mtk_ecc_config *config)
168 u32 ecc_bit, dec_sz, enc_sz;
171 for (i = 0; i < ecc->caps->num_ecc_strength; i++) {
172 if (ecc->caps->ecc_strength[i] == config->strength)
176 if (i == ecc->caps->num_ecc_strength) {
177 dev_err(ecc->dev, "invalid ecc strength %d\n",
184 if (config->op == ECC_ENCODE) {
185 /* configure ECC encoder (in bits) */
186 enc_sz = config->len << 3;
188 reg = ecc_bit | (config->mode << ecc->caps->ecc_mode_shift);
189 reg |= (enc_sz << ECC_MS_SHIFT);
190 writel(reg, ecc->regs + ECC_ENCCNFG);
192 if (config->mode != ECC_NFI_MODE)
193 writel(lower_32_bits(config->addr),
194 ecc->regs + ECC_ENCDIADDR);
197 /* configure ECC decoder (in bits) */
198 dec_sz = (config->len << 3) +
199 config->strength * ecc->caps->parity_bits;
201 reg = ecc_bit | (config->mode << ecc->caps->ecc_mode_shift);
202 reg |= (dec_sz << ECC_MS_SHIFT) | DEC_CNFG_CORRECT;
204 writel(reg, ecc->regs + ECC_DECCNFG);
207 ecc->sectors = 1 << (config->sectors - 1);
213 void mtk_ecc_get_stats(struct mtk_ecc *ecc, struct mtk_ecc_stats *stats,
219 stats->corrected = 0;
222 for (i = 0; i < sectors; i++) {
223 offset = (i >> 2) << 2;
224 err = readl(ecc->regs + ECC_DECENUM0 + offset);
225 err = err >> ((i % 4) * ecc->caps->err_shift);
226 err &= ecc->caps->err_mask;
227 if (err == ecc->caps->err_mask) {
228 /* uncorrectable errors */
233 stats->corrected += err;
234 bitflips = max_t(u32, bitflips, err);
237 stats->bitflips = bitflips;
239 EXPORT_SYMBOL(mtk_ecc_get_stats);
241 void mtk_ecc_release(struct mtk_ecc *ecc)
243 clk_disable_unprepare(ecc->clk);
244 put_device(ecc->dev);
246 EXPORT_SYMBOL(mtk_ecc_release);
248 static void mtk_ecc_hw_init(struct mtk_ecc *ecc)
250 mtk_ecc_wait_idle(ecc, ECC_ENCODE);
251 writew(ECC_OP_DISABLE, ecc->regs + ECC_ENCCON);
253 mtk_ecc_wait_idle(ecc, ECC_DECODE);
254 writel(ECC_OP_DISABLE, ecc->regs + ECC_DECCON);
257 static struct mtk_ecc *mtk_ecc_get(struct device_node *np)
259 struct platform_device *pdev;
262 pdev = of_find_device_by_node(np);
264 return ERR_PTR(-EPROBE_DEFER);
266 ecc = platform_get_drvdata(pdev);
268 put_device(&pdev->dev);
269 return ERR_PTR(-EPROBE_DEFER);
272 clk_prepare_enable(ecc->clk);
273 mtk_ecc_hw_init(ecc);
278 struct mtk_ecc *of_mtk_ecc_get(struct device_node *of_node)
280 struct mtk_ecc *ecc = NULL;
281 struct device_node *np;
283 np = of_parse_phandle(of_node, "ecc-engine", 0);
285 ecc = mtk_ecc_get(np);
291 EXPORT_SYMBOL(of_mtk_ecc_get);
293 int mtk_ecc_enable(struct mtk_ecc *ecc, struct mtk_ecc_config *config)
295 enum mtk_ecc_operation op = config->op;
299 ret = mutex_lock_interruptible(&ecc->lock);
301 dev_err(ecc->dev, "interrupted when attempting to lock\n");
305 mtk_ecc_wait_idle(ecc, op);
307 ret = mtk_ecc_config(ecc, config);
309 mutex_unlock(&ecc->lock);
313 if (config->mode != ECC_NFI_MODE || op != ECC_ENCODE) {
314 init_completion(&ecc->done);
315 reg_val = ECC_IRQ_EN;
317 * For ECC_NFI_MODE, if ecc->caps->pg_irq_sel is 1, then it
318 * means this chip can only generate one ecc irq during page
319 * read / write. If is 0, generate one ecc irq each ecc step.
321 if (ecc->caps->pg_irq_sel && config->mode == ECC_NFI_MODE)
322 reg_val |= ECC_PG_IRQ_SEL;
323 if (op == ECC_ENCODE)
324 writew(reg_val, ecc->regs +
325 ecc->caps->ecc_regs[ECC_ENCIRQ_EN]);
327 writew(reg_val, ecc->regs +
328 ecc->caps->ecc_regs[ECC_DECIRQ_EN]);
331 writew(ECC_OP_ENABLE, ecc->regs + ECC_CTL_REG(op));
335 EXPORT_SYMBOL(mtk_ecc_enable);
337 void mtk_ecc_disable(struct mtk_ecc *ecc)
339 enum mtk_ecc_operation op = ECC_ENCODE;
341 /* find out the running operation */
342 if (readw(ecc->regs + ECC_CTL_REG(op)) != ECC_OP_ENABLE)
346 mtk_ecc_wait_idle(ecc, op);
347 if (op == ECC_DECODE) {
349 * Clear decode IRQ status in case there is a timeout to wait
352 readw(ecc->regs + ecc->caps->ecc_regs[ECC_DECDONE]);
353 writew(0, ecc->regs + ecc->caps->ecc_regs[ECC_DECIRQ_EN]);
355 writew(0, ecc->regs + ecc->caps->ecc_regs[ECC_ENCIRQ_EN]);
358 writew(ECC_OP_DISABLE, ecc->regs + ECC_CTL_REG(op));
360 mutex_unlock(&ecc->lock);
362 EXPORT_SYMBOL(mtk_ecc_disable);
364 int mtk_ecc_wait_done(struct mtk_ecc *ecc, enum mtk_ecc_operation op)
368 ret = wait_for_completion_timeout(&ecc->done, msecs_to_jiffies(500));
370 dev_err(ecc->dev, "%s timeout - interrupt did not arrive)\n",
371 (op == ECC_ENCODE) ? "encoder" : "decoder");
377 EXPORT_SYMBOL(mtk_ecc_wait_done);
379 int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
386 addr = dma_map_single(ecc->dev, data, bytes, DMA_TO_DEVICE);
387 ret = dma_mapping_error(ecc->dev, addr);
389 dev_err(ecc->dev, "dma mapping error\n");
393 config->op = ECC_ENCODE;
395 ret = mtk_ecc_enable(ecc, config);
397 dma_unmap_single(ecc->dev, addr, bytes, DMA_TO_DEVICE);
401 ret = mtk_ecc_wait_done(ecc, ECC_ENCODE);
405 mtk_ecc_wait_idle(ecc, ECC_ENCODE);
407 /* Program ECC bytes to OOB: per sector oob = FDM + ECC + SPARE */
408 len = (config->strength * ecc->caps->parity_bits + 7) >> 3;
410 /* write the parity bytes generated by the ECC back to temp buffer */
411 __ioread32_copy(ecc->eccdata,
412 ecc->regs + ecc->caps->ecc_regs[ECC_ENCPAR00],
415 /* copy into possibly unaligned OOB region with actual length */
416 memcpy(data + bytes, ecc->eccdata, len);
419 dma_unmap_single(ecc->dev, addr, bytes, DMA_TO_DEVICE);
420 mtk_ecc_disable(ecc);
424 EXPORT_SYMBOL(mtk_ecc_encode);
426 void mtk_ecc_adjust_strength(struct mtk_ecc *ecc, u32 *p)
428 const u8 *ecc_strength = ecc->caps->ecc_strength;
431 for (i = 0; i < ecc->caps->num_ecc_strength; i++) {
432 if (*p <= ecc_strength[i]) {
434 *p = ecc_strength[i];
435 else if (*p != ecc_strength[i])
436 *p = ecc_strength[i - 1];
441 *p = ecc_strength[ecc->caps->num_ecc_strength - 1];
443 EXPORT_SYMBOL(mtk_ecc_adjust_strength);
445 unsigned int mtk_ecc_get_parity_bits(struct mtk_ecc *ecc)
447 return ecc->caps->parity_bits;
449 EXPORT_SYMBOL(mtk_ecc_get_parity_bits);
451 static const struct mtk_ecc_caps mtk_ecc_caps_mt2701 = {
454 .ecc_strength = ecc_strength_mt2701,
455 .ecc_regs = mt2701_ecc_regs,
456 .num_ecc_strength = 20,
462 static const struct mtk_ecc_caps mtk_ecc_caps_mt2712 = {
465 .ecc_strength = ecc_strength_mt2712,
466 .ecc_regs = mt2712_ecc_regs,
467 .num_ecc_strength = 23,
473 static const struct mtk_ecc_caps mtk_ecc_caps_mt7622 = {
476 .ecc_strength = ecc_strength_mt7622,
477 .ecc_regs = mt7622_ecc_regs,
478 .num_ecc_strength = 5,
484 static const struct of_device_id mtk_ecc_dt_match[] = {
486 .compatible = "mediatek,mt2701-ecc",
487 .data = &mtk_ecc_caps_mt2701,
489 .compatible = "mediatek,mt2712-ecc",
490 .data = &mtk_ecc_caps_mt2712,
492 .compatible = "mediatek,mt7622-ecc",
493 .data = &mtk_ecc_caps_mt7622,
498 static int mtk_ecc_probe(struct platform_device *pdev)
500 struct device *dev = &pdev->dev;
502 struct resource *res;
503 u32 max_eccdata_size;
506 ecc = devm_kzalloc(dev, sizeof(*ecc), GFP_KERNEL);
510 ecc->caps = of_device_get_match_data(dev);
512 max_eccdata_size = ecc->caps->num_ecc_strength - 1;
513 max_eccdata_size = ecc->caps->ecc_strength[max_eccdata_size];
514 max_eccdata_size = (max_eccdata_size * ecc->caps->parity_bits + 7) >> 3;
515 max_eccdata_size = round_up(max_eccdata_size, 4);
516 ecc->eccdata = devm_kzalloc(dev, max_eccdata_size, GFP_KERNEL);
520 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
521 ecc->regs = devm_ioremap_resource(dev, res);
522 if (IS_ERR(ecc->regs)) {
523 dev_err(dev, "failed to map regs: %ld\n", PTR_ERR(ecc->regs));
524 return PTR_ERR(ecc->regs);
527 ecc->clk = devm_clk_get(dev, NULL);
528 if (IS_ERR(ecc->clk)) {
529 dev_err(dev, "failed to get clock: %ld\n", PTR_ERR(ecc->clk));
530 return PTR_ERR(ecc->clk);
533 irq = platform_get_irq(pdev, 0);
537 ret = dma_set_mask(dev, DMA_BIT_MASK(32));
539 dev_err(dev, "failed to set DMA mask\n");
543 ret = devm_request_irq(dev, irq, mtk_ecc_irq, 0x0, "mtk-ecc", ecc);
545 dev_err(dev, "failed to request irq\n");
550 mutex_init(&ecc->lock);
551 platform_set_drvdata(pdev, ecc);
552 dev_info(dev, "probed\n");
557 #ifdef CONFIG_PM_SLEEP
558 static int mtk_ecc_suspend(struct device *dev)
560 struct mtk_ecc *ecc = dev_get_drvdata(dev);
562 clk_disable_unprepare(ecc->clk);
567 static int mtk_ecc_resume(struct device *dev)
569 struct mtk_ecc *ecc = dev_get_drvdata(dev);
572 ret = clk_prepare_enable(ecc->clk);
574 dev_err(dev, "failed to enable clk\n");
581 static SIMPLE_DEV_PM_OPS(mtk_ecc_pm_ops, mtk_ecc_suspend, mtk_ecc_resume);
584 MODULE_DEVICE_TABLE(of, mtk_ecc_dt_match);
586 static struct platform_driver mtk_ecc_driver = {
587 .probe = mtk_ecc_probe,
590 .of_match_table = of_match_ptr(mtk_ecc_dt_match),
591 #ifdef CONFIG_PM_SLEEP
592 .pm = &mtk_ecc_pm_ops,
597 module_platform_driver(mtk_ecc_driver);
599 MODULE_AUTHOR("Xiaolei Li <xiaolei.li@mediatek.com>");
600 MODULE_DESCRIPTION("MTK Nand ECC Driver");
601 MODULE_LICENSE("Dual MIT/GPL");