1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2014 Panasonic Corporation
4 * Copyright (C) 2013-2014, Altera Corporation <www.altera.com>
5 * Copyright (C) 2009-2010, Intel Corporation and its suppliers.
12 #include <asm/cache.h>
13 #include <asm/dma-mapping.h>
14 #include <dm/device_compat.h>
15 #include <dm/devres.h>
16 #include <linux/bitfield.h>
17 #include <linux/bitops.h>
18 #include <linux/delay.h>
19 #include <linux/dma-direction.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/err.h>
22 #include <linux/errno.h>
24 #include <linux/mtd/mtd.h>
25 #include <linux/mtd/rawnand.h>
29 #define DENALI_NAND_NAME "denali-nand"
31 /* for Indexed Addressing */
32 #define DENALI_INDEXED_CTRL 0x00
33 #define DENALI_INDEXED_DATA 0x10
35 #define DENALI_MAP00 (0 << 26) /* direct access to buffer */
36 #define DENALI_MAP01 (1 << 26) /* read/write pages in PIO */
37 #define DENALI_MAP10 (2 << 26) /* high-level control plane */
38 #define DENALI_MAP11 (3 << 26) /* direct controller access */
40 /* MAP11 access cycle type */
41 #define DENALI_MAP11_CMD ((DENALI_MAP11) | 0) /* command cycle */
42 #define DENALI_MAP11_ADDR ((DENALI_MAP11) | 1) /* address cycle */
43 #define DENALI_MAP11_DATA ((DENALI_MAP11) | 2) /* data cycle */
46 #define DENALI_ERASE 0x01
48 #define DENALI_BANK(denali) ((denali)->active_bank << 24)
50 #define DENALI_INVALID_BANK -1
51 #define DENALI_NR_BANKS 4
53 static inline struct denali_nand_info *mtd_to_denali(struct mtd_info *mtd)
55 return container_of(mtd_to_nand(mtd), struct denali_nand_info, nand);
59 * Direct Addressing - the slave address forms the control information (command
60 * type, bank, block, and page address). The slave data is the actual data to
61 * be transferred. This mode requires 28 bits of address region allocated.
63 static u32 denali_direct_read(struct denali_nand_info *denali, u32 addr)
65 return ioread32(denali->host + addr);
68 static void denali_direct_write(struct denali_nand_info *denali, u32 addr,
71 iowrite32(data, denali->host + addr);
75 * Indexed Addressing - address translation module intervenes in passing the
76 * control information. This mode reduces the required address range. The
77 * control information and transferred data are latched by the registers in
78 * the translation module.
80 static u32 denali_indexed_read(struct denali_nand_info *denali, u32 addr)
82 iowrite32(addr, denali->host + DENALI_INDEXED_CTRL);
83 return ioread32(denali->host + DENALI_INDEXED_DATA);
86 static void denali_indexed_write(struct denali_nand_info *denali, u32 addr,
89 iowrite32(addr, denali->host + DENALI_INDEXED_CTRL);
90 iowrite32(data, denali->host + DENALI_INDEXED_DATA);
94 * Use the configuration feature register to determine the maximum number of
95 * banks that the hardware supports.
97 static void denali_detect_max_banks(struct denali_nand_info *denali)
99 uint32_t features = ioread32(denali->reg + FEATURES);
101 denali->max_banks = 1 << FIELD_GET(FEATURES__N_BANKS, features);
103 /* the encoding changed from rev 5.0 to 5.1 */
104 if (denali->revision < 0x0501)
105 denali->max_banks <<= 1;
108 static void __maybe_unused denali_enable_irq(struct denali_nand_info *denali)
112 for (i = 0; i < DENALI_NR_BANKS; i++)
113 iowrite32(U32_MAX, denali->reg + INTR_EN(i));
114 iowrite32(GLOBAL_INT_EN_FLAG, denali->reg + GLOBAL_INT_ENABLE);
117 static void __maybe_unused denali_disable_irq(struct denali_nand_info *denali)
121 for (i = 0; i < DENALI_NR_BANKS; i++)
122 iowrite32(0, denali->reg + INTR_EN(i));
123 iowrite32(0, denali->reg + GLOBAL_INT_ENABLE);
126 static void denali_clear_irq(struct denali_nand_info *denali,
127 int bank, uint32_t irq_status)
129 /* write one to clear bits */
130 iowrite32(irq_status, denali->reg + INTR_STATUS(bank));
133 static void denali_clear_irq_all(struct denali_nand_info *denali)
137 for (i = 0; i < DENALI_NR_BANKS; i++)
138 denali_clear_irq(denali, i, U32_MAX);
141 static void __denali_check_irq(struct denali_nand_info *denali)
146 for (i = 0; i < DENALI_NR_BANKS; i++) {
147 irq_status = ioread32(denali->reg + INTR_STATUS(i));
148 denali_clear_irq(denali, i, irq_status);
150 if (i != denali->active_bank)
153 denali->irq_status |= irq_status;
157 static void denali_reset_irq(struct denali_nand_info *denali)
159 denali->irq_status = 0;
160 denali->irq_mask = 0;
163 static uint32_t denali_wait_for_irq(struct denali_nand_info *denali,
166 unsigned long time_left = 1000000;
169 __denali_check_irq(denali);
171 if (irq_mask & denali->irq_status)
172 return denali->irq_status;
178 dev_err(denali->dev, "timeout while waiting for irq 0x%x\n",
183 return denali->irq_status;
186 static uint32_t denali_check_irq(struct denali_nand_info *denali)
188 __denali_check_irq(denali);
190 return denali->irq_status;
193 static void denali_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
195 struct denali_nand_info *denali = mtd_to_denali(mtd);
196 u32 addr = DENALI_MAP11_DATA | DENALI_BANK(denali);
199 for (i = 0; i < len; i++)
200 buf[i] = denali->host_read(denali, addr);
203 static void denali_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
205 struct denali_nand_info *denali = mtd_to_denali(mtd);
206 u32 addr = DENALI_MAP11_DATA | DENALI_BANK(denali);
209 for (i = 0; i < len; i++)
210 denali->host_write(denali, addr, buf[i]);
213 static void denali_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
215 struct denali_nand_info *denali = mtd_to_denali(mtd);
216 u32 addr = DENALI_MAP11_DATA | DENALI_BANK(denali);
217 uint16_t *buf16 = (uint16_t *)buf;
220 for (i = 0; i < len / 2; i++)
221 buf16[i] = denali->host_read(denali, addr);
224 static void denali_write_buf16(struct mtd_info *mtd, const uint8_t *buf,
227 struct denali_nand_info *denali = mtd_to_denali(mtd);
228 u32 addr = DENALI_MAP11_DATA | DENALI_BANK(denali);
229 const uint16_t *buf16 = (const uint16_t *)buf;
232 for (i = 0; i < len / 2; i++)
233 denali->host_write(denali, addr, buf16[i]);
236 static uint8_t denali_read_byte(struct mtd_info *mtd)
240 denali_read_buf(mtd, &byte, 1);
245 static void denali_write_byte(struct mtd_info *mtd, uint8_t byte)
247 denali_write_buf(mtd, &byte, 1);
250 static uint16_t denali_read_word(struct mtd_info *mtd)
254 denali_read_buf16(mtd, (uint8_t *)&word, 2);
259 static void denali_cmd_ctrl(struct mtd_info *mtd, int dat, unsigned int ctrl)
261 struct denali_nand_info *denali = mtd_to_denali(mtd);
265 type = DENALI_MAP11_CMD;
266 else if (ctrl & NAND_ALE)
267 type = DENALI_MAP11_ADDR;
272 * Some commands are followed by chip->dev_ready or chip->waitfunc.
273 * irq_status must be cleared here to catch the R/B# interrupt later.
275 if (ctrl & NAND_CTRL_CHANGE)
276 denali_reset_irq(denali);
278 denali->host_write(denali, DENALI_BANK(denali) | type, dat);
281 static int denali_dev_ready(struct mtd_info *mtd)
283 struct denali_nand_info *denali = mtd_to_denali(mtd);
285 return !!(denali_check_irq(denali) & INTR__INT_ACT);
288 static int denali_check_erased_page(struct mtd_info *mtd,
289 struct nand_chip *chip, uint8_t *buf,
290 unsigned long uncor_ecc_flags,
291 unsigned int max_bitflips)
293 uint8_t *ecc_code = chip->buffers->ecccode;
294 int ecc_steps = chip->ecc.steps;
295 int ecc_size = chip->ecc.size;
296 int ecc_bytes = chip->ecc.bytes;
299 ret = mtd_ooblayout_get_eccbytes(mtd, ecc_code, chip->oob_poi, 0,
304 for (i = 0; i < ecc_steps; i++) {
305 if (!(uncor_ecc_flags & BIT(i)))
308 stat = nand_check_erased_ecc_chunk(buf, ecc_size,
313 mtd->ecc_stats.failed++;
315 mtd->ecc_stats.corrected += stat;
316 max_bitflips = max_t(unsigned int, max_bitflips, stat);
320 ecc_code += ecc_bytes;
326 static int denali_hw_ecc_fixup(struct mtd_info *mtd,
327 struct denali_nand_info *denali,
328 unsigned long *uncor_ecc_flags)
330 struct nand_chip *chip = mtd_to_nand(mtd);
331 int bank = denali->active_bank;
333 unsigned int max_bitflips;
335 ecc_cor = ioread32(denali->reg + ECC_COR_INFO(bank));
336 ecc_cor >>= ECC_COR_INFO__SHIFT(bank);
338 if (ecc_cor & ECC_COR_INFO__UNCOR_ERR) {
340 * This flag is set when uncorrectable error occurs at least in
341 * one ECC sector. We can not know "how many sectors", or
342 * "which sector(s)". We need erase-page check for all sectors.
344 *uncor_ecc_flags = GENMASK(chip->ecc.steps - 1, 0);
348 max_bitflips = FIELD_GET(ECC_COR_INFO__MAX_ERRORS, ecc_cor);
351 * The register holds the maximum of per-sector corrected bitflips.
352 * This is suitable for the return value of the ->read_page() callback.
353 * Unfortunately, we can not know the total number of corrected bits in
354 * the page. Increase the stats by max_bitflips. (compromised solution)
356 mtd->ecc_stats.corrected += max_bitflips;
361 static int denali_sw_ecc_fixup(struct mtd_info *mtd,
362 struct denali_nand_info *denali,
363 unsigned long *uncor_ecc_flags, uint8_t *buf)
365 unsigned int ecc_size = denali->nand.ecc.size;
366 unsigned int bitflips = 0;
367 unsigned int max_bitflips = 0;
368 uint32_t err_addr, err_cor_info;
369 unsigned int err_byte, err_sector, err_device;
370 uint8_t err_cor_value;
371 unsigned int prev_sector = 0;
374 denali_reset_irq(denali);
377 err_addr = ioread32(denali->reg + ECC_ERROR_ADDRESS);
378 err_sector = FIELD_GET(ECC_ERROR_ADDRESS__SECTOR, err_addr);
379 err_byte = FIELD_GET(ECC_ERROR_ADDRESS__OFFSET, err_addr);
381 err_cor_info = ioread32(denali->reg + ERR_CORRECTION_INFO);
382 err_cor_value = FIELD_GET(ERR_CORRECTION_INFO__BYTE,
384 err_device = FIELD_GET(ERR_CORRECTION_INFO__DEVICE,
387 /* reset the bitflip counter when crossing ECC sector */
388 if (err_sector != prev_sector)
391 if (err_cor_info & ERR_CORRECTION_INFO__UNCOR) {
393 * Check later if this is a real ECC error, or
396 *uncor_ecc_flags |= BIT(err_sector);
397 } else if (err_byte < ecc_size) {
399 * If err_byte is larger than ecc_size, means error
400 * happened in OOB, so we ignore it. It's no need for
401 * us to correct it err_device is represented the NAND
402 * error bits are happened in if there are more than
403 * one NAND connected.
406 unsigned int flips_in_byte;
408 offset = (err_sector * ecc_size + err_byte) *
409 denali->devs_per_cs + err_device;
411 /* correct the ECC error */
412 flips_in_byte = hweight8(buf[offset] ^ err_cor_value);
413 buf[offset] ^= err_cor_value;
414 mtd->ecc_stats.corrected += flips_in_byte;
415 bitflips += flips_in_byte;
417 max_bitflips = max(max_bitflips, bitflips);
420 prev_sector = err_sector;
421 } while (!(err_cor_info & ERR_CORRECTION_INFO__LAST_ERR));
424 * Once handle all ECC errors, controller will trigger an
425 * ECC_TRANSACTION_DONE interrupt.
427 irq_status = denali_wait_for_irq(denali, INTR__ECC_TRANSACTION_DONE);
428 if (!(irq_status & INTR__ECC_TRANSACTION_DONE))
434 static void denali_setup_dma64(struct denali_nand_info *denali,
435 dma_addr_t dma_addr, int page, int write)
438 const int page_count = 1;
440 mode = DENALI_MAP10 | DENALI_BANK(denali) | page;
442 /* DMA is a three step process */
445 * 1. setup transfer type, interrupt when complete,
446 * burst len = 64 bytes, the number of pages
448 denali->host_write(denali, mode,
449 0x01002000 | (64 << 16) | (write << 8) | page_count);
451 /* 2. set memory low address */
452 denali->host_write(denali, mode, lower_32_bits(dma_addr));
454 /* 3. set memory high address */
455 denali->host_write(denali, mode, upper_32_bits(dma_addr));
458 static void denali_setup_dma32(struct denali_nand_info *denali,
459 dma_addr_t dma_addr, int page, int write)
462 const int page_count = 1;
464 mode = DENALI_MAP10 | DENALI_BANK(denali);
466 /* DMA is a four step process */
468 /* 1. setup transfer type and # of pages */
469 denali->host_write(denali, mode | page,
470 0x2000 | (write << 8) | page_count);
472 /* 2. set memory high address bits 23:8 */
473 denali->host_write(denali, mode | ((dma_addr >> 16) << 8), 0x2200);
475 /* 3. set memory low address bits 23:8 */
476 denali->host_write(denali, mode | ((dma_addr & 0xffff) << 8), 0x2300);
478 /* 4. interrupt when complete, burst len = 64 bytes */
479 denali->host_write(denali, mode | 0x14000, 0x2400);
482 static int denali_pio_read(struct denali_nand_info *denali, void *buf,
483 size_t size, int page, int raw)
485 u32 addr = DENALI_MAP01 | DENALI_BANK(denali) | page;
486 uint32_t *buf32 = (uint32_t *)buf;
487 uint32_t irq_status, ecc_err_mask;
490 if (denali->caps & DENALI_CAP_HW_ECC_FIXUP)
491 ecc_err_mask = INTR__ECC_UNCOR_ERR;
493 ecc_err_mask = INTR__ECC_ERR;
495 denali_reset_irq(denali);
497 for (i = 0; i < size / 4; i++)
498 *buf32++ = denali->host_read(denali, addr);
500 irq_status = denali_wait_for_irq(denali, INTR__PAGE_XFER_INC);
501 if (!(irq_status & INTR__PAGE_XFER_INC))
504 if (irq_status & INTR__ERASED_PAGE)
505 memset(buf, 0xff, size);
507 return irq_status & ecc_err_mask ? -EBADMSG : 0;
510 static int denali_pio_write(struct denali_nand_info *denali,
511 const void *buf, size_t size, int page, int raw)
513 u32 addr = DENALI_MAP01 | DENALI_BANK(denali) | page;
514 const uint32_t *buf32 = (uint32_t *)buf;
518 denali_reset_irq(denali);
520 for (i = 0; i < size / 4; i++)
521 denali->host_write(denali, addr, *buf32++);
523 irq_status = denali_wait_for_irq(denali,
524 INTR__PROGRAM_COMP | INTR__PROGRAM_FAIL);
525 if (!(irq_status & INTR__PROGRAM_COMP))
531 static int denali_pio_xfer(struct denali_nand_info *denali, void *buf,
532 size_t size, int page, int raw, int write)
535 return denali_pio_write(denali, buf, size, page, raw);
537 return denali_pio_read(denali, buf, size, page, raw);
540 static int denali_dma_xfer(struct denali_nand_info *denali, void *buf,
541 size_t size, int page, int raw, int write)
544 uint32_t irq_mask, irq_status, ecc_err_mask;
545 enum dma_data_direction dir = write ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
548 dma_addr = dma_map_single(buf, size, dir);
549 if (dma_mapping_error(denali->dev, dma_addr)) {
550 dev_dbg(denali->dev, "Failed to DMA-map buffer. Trying PIO.\n");
551 return denali_pio_xfer(denali, buf, size, page, raw, write);
556 * INTR__PROGRAM_COMP is never asserted for the DMA transfer.
557 * We can use INTR__DMA_CMD_COMP instead. This flag is asserted
558 * when the page program is completed.
560 irq_mask = INTR__DMA_CMD_COMP | INTR__PROGRAM_FAIL;
562 } else if (denali->caps & DENALI_CAP_HW_ECC_FIXUP) {
563 irq_mask = INTR__DMA_CMD_COMP;
564 ecc_err_mask = INTR__ECC_UNCOR_ERR;
566 irq_mask = INTR__DMA_CMD_COMP;
567 ecc_err_mask = INTR__ECC_ERR;
570 iowrite32(DMA_ENABLE__FLAG, denali->reg + DMA_ENABLE);
572 * The ->setup_dma() hook kicks DMA by using the data/command
573 * interface, which belongs to a different AXI port from the
574 * register interface. Read back the register to avoid a race.
576 ioread32(denali->reg + DMA_ENABLE);
578 denali_reset_irq(denali);
579 denali->setup_dma(denali, dma_addr, page, write);
581 irq_status = denali_wait_for_irq(denali, irq_mask);
582 if (!(irq_status & INTR__DMA_CMD_COMP))
584 else if (irq_status & ecc_err_mask)
587 iowrite32(0, denali->reg + DMA_ENABLE);
589 dma_unmap_single(dma_addr, size, dir);
591 if (irq_status & INTR__ERASED_PAGE)
592 memset(buf, 0xff, size);
597 static int denali_data_xfer(struct denali_nand_info *denali, void *buf,
598 size_t size, int page, int raw, int write)
600 iowrite32(raw ? 0 : ECC_ENABLE__FLAG, denali->reg + ECC_ENABLE);
601 iowrite32(raw ? TRANSFER_SPARE_REG__FLAG : 0,
602 denali->reg + TRANSFER_SPARE_REG);
604 if (denali->dma_avail)
605 return denali_dma_xfer(denali, buf, size, page, raw, write);
607 return denali_pio_xfer(denali, buf, size, page, raw, write);
610 static void denali_oob_xfer(struct mtd_info *mtd, struct nand_chip *chip,
613 struct denali_nand_info *denali = mtd_to_denali(mtd);
614 unsigned int start_cmd = write ? NAND_CMD_SEQIN : NAND_CMD_READ0;
615 unsigned int rnd_cmd = write ? NAND_CMD_RNDIN : NAND_CMD_RNDOUT;
616 int writesize = mtd->writesize;
617 int oobsize = mtd->oobsize;
618 uint8_t *bufpoi = chip->oob_poi;
619 int ecc_steps = chip->ecc.steps;
620 int ecc_size = chip->ecc.size;
621 int ecc_bytes = chip->ecc.bytes;
622 int oob_skip = denali->oob_skip_bytes;
623 size_t size = writesize + oobsize;
626 /* BBM at the beginning of the OOB area */
627 chip->cmdfunc(mtd, start_cmd, writesize, page);
629 chip->write_buf(mtd, bufpoi, oob_skip);
631 chip->read_buf(mtd, bufpoi, oob_skip);
635 for (i = 0; i < ecc_steps; i++) {
636 pos = ecc_size + i * (ecc_size + ecc_bytes);
639 if (pos >= writesize)
641 else if (pos + len > writesize)
642 len = writesize - pos;
644 chip->cmdfunc(mtd, rnd_cmd, pos, -1);
646 chip->write_buf(mtd, bufpoi, len);
648 chip->read_buf(mtd, bufpoi, len);
650 if (len < ecc_bytes) {
651 len = ecc_bytes - len;
652 chip->cmdfunc(mtd, rnd_cmd, writesize + oob_skip, -1);
654 chip->write_buf(mtd, bufpoi, len);
656 chip->read_buf(mtd, bufpoi, len);
662 len = oobsize - (bufpoi - chip->oob_poi);
663 chip->cmdfunc(mtd, rnd_cmd, size - len, -1);
665 chip->write_buf(mtd, bufpoi, len);
667 chip->read_buf(mtd, bufpoi, len);
670 static int denali_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
671 uint8_t *buf, int oob_required, int page)
673 struct denali_nand_info *denali = mtd_to_denali(mtd);
674 int writesize = mtd->writesize;
675 int oobsize = mtd->oobsize;
676 int ecc_steps = chip->ecc.steps;
677 int ecc_size = chip->ecc.size;
678 int ecc_bytes = chip->ecc.bytes;
679 void *tmp_buf = denali->buf;
680 int oob_skip = denali->oob_skip_bytes;
681 size_t size = writesize + oobsize;
682 int ret, i, pos, len;
684 ret = denali_data_xfer(denali, tmp_buf, size, page, 1, 0);
688 /* Arrange the buffer for syndrome payload/ecc layout */
690 for (i = 0; i < ecc_steps; i++) {
691 pos = i * (ecc_size + ecc_bytes);
694 if (pos >= writesize)
696 else if (pos + len > writesize)
697 len = writesize - pos;
699 memcpy(buf, tmp_buf + pos, len);
701 if (len < ecc_size) {
702 len = ecc_size - len;
703 memcpy(buf, tmp_buf + writesize + oob_skip,
711 uint8_t *oob = chip->oob_poi;
713 /* BBM at the beginning of the OOB area */
714 memcpy(oob, tmp_buf + writesize, oob_skip);
718 for (i = 0; i < ecc_steps; i++) {
719 pos = ecc_size + i * (ecc_size + ecc_bytes);
722 if (pos >= writesize)
724 else if (pos + len > writesize)
725 len = writesize - pos;
727 memcpy(oob, tmp_buf + pos, len);
729 if (len < ecc_bytes) {
730 len = ecc_bytes - len;
731 memcpy(oob, tmp_buf + writesize + oob_skip,
738 len = oobsize - (oob - chip->oob_poi);
739 memcpy(oob, tmp_buf + size - len, len);
745 static int denali_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
748 denali_oob_xfer(mtd, chip, page, 0);
753 static int denali_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
756 struct denali_nand_info *denali = mtd_to_denali(mtd);
759 denali_reset_irq(denali);
761 denali_oob_xfer(mtd, chip, page, 1);
763 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
764 status = chip->waitfunc(mtd, chip);
766 return status & NAND_STATUS_FAIL ? -EIO : 0;
769 static int denali_read_page(struct mtd_info *mtd, struct nand_chip *chip,
770 uint8_t *buf, int oob_required, int page)
772 struct denali_nand_info *denali = mtd_to_denali(mtd);
773 unsigned long uncor_ecc_flags = 0;
777 ret = denali_data_xfer(denali, buf, mtd->writesize, page, 0, 0);
778 if (ret && ret != -EBADMSG)
781 if (denali->caps & DENALI_CAP_HW_ECC_FIXUP)
782 stat = denali_hw_ecc_fixup(mtd, denali, &uncor_ecc_flags);
783 else if (ret == -EBADMSG)
784 stat = denali_sw_ecc_fixup(mtd, denali, &uncor_ecc_flags, buf);
789 if (uncor_ecc_flags) {
790 ret = denali_read_oob(mtd, chip, page);
794 stat = denali_check_erased_page(mtd, chip, buf,
795 uncor_ecc_flags, stat);
801 static int denali_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
802 const uint8_t *buf, int oob_required, int page)
804 struct denali_nand_info *denali = mtd_to_denali(mtd);
805 int writesize = mtd->writesize;
806 int oobsize = mtd->oobsize;
807 int ecc_steps = chip->ecc.steps;
808 int ecc_size = chip->ecc.size;
809 int ecc_bytes = chip->ecc.bytes;
810 void *tmp_buf = denali->buf;
811 int oob_skip = denali->oob_skip_bytes;
812 size_t size = writesize + oobsize;
816 * Fill the buffer with 0xff first except the full page transfer.
817 * This simplifies the logic.
819 if (!buf || !oob_required)
820 memset(tmp_buf, 0xff, size);
822 /* Arrange the buffer for syndrome payload/ecc layout */
824 for (i = 0; i < ecc_steps; i++) {
825 pos = i * (ecc_size + ecc_bytes);
828 if (pos >= writesize)
830 else if (pos + len > writesize)
831 len = writesize - pos;
833 memcpy(tmp_buf + pos, buf, len);
835 if (len < ecc_size) {
836 len = ecc_size - len;
837 memcpy(tmp_buf + writesize + oob_skip, buf,
845 const uint8_t *oob = chip->oob_poi;
847 /* BBM at the beginning of the OOB area */
848 memcpy(tmp_buf + writesize, oob, oob_skip);
852 for (i = 0; i < ecc_steps; i++) {
853 pos = ecc_size + i * (ecc_size + ecc_bytes);
856 if (pos >= writesize)
858 else if (pos + len > writesize)
859 len = writesize - pos;
861 memcpy(tmp_buf + pos, oob, len);
863 if (len < ecc_bytes) {
864 len = ecc_bytes - len;
865 memcpy(tmp_buf + writesize + oob_skip, oob,
872 len = oobsize - (oob - chip->oob_poi);
873 memcpy(tmp_buf + size - len, oob, len);
876 return denali_data_xfer(denali, tmp_buf, size, page, 1, 1);
879 static int denali_write_page(struct mtd_info *mtd, struct nand_chip *chip,
880 const uint8_t *buf, int oob_required, int page)
882 struct denali_nand_info *denali = mtd_to_denali(mtd);
884 return denali_data_xfer(denali, (void *)buf, mtd->writesize,
888 static void denali_select_chip(struct mtd_info *mtd, int chip)
890 struct denali_nand_info *denali = mtd_to_denali(mtd);
892 denali->active_bank = chip;
895 static int denali_waitfunc(struct mtd_info *mtd, struct nand_chip *chip)
897 struct denali_nand_info *denali = mtd_to_denali(mtd);
900 /* R/B# pin transitioned from low to high? */
901 irq_status = denali_wait_for_irq(denali, INTR__INT_ACT);
903 return irq_status & INTR__INT_ACT ? 0 : NAND_STATUS_FAIL;
906 static int denali_erase(struct mtd_info *mtd, int page)
908 struct denali_nand_info *denali = mtd_to_denali(mtd);
911 denali_reset_irq(denali);
913 denali->host_write(denali, DENALI_MAP10 | DENALI_BANK(denali) | page,
916 /* wait for erase to complete or failure to occur */
917 irq_status = denali_wait_for_irq(denali,
918 INTR__ERASE_COMP | INTR__ERASE_FAIL);
920 return irq_status & INTR__ERASE_COMP ? 0 : NAND_STATUS_FAIL;
923 static int denali_setup_data_interface(struct mtd_info *mtd, int chipnr,
924 const struct nand_data_interface *conf)
926 struct denali_nand_info *denali = mtd_to_denali(mtd);
927 const struct nand_sdr_timings *timings;
928 unsigned long t_x, mult_x;
929 int acc_clks, re_2_we, re_2_re, we_2_re, addr_2_data;
930 int rdwr_en_lo, rdwr_en_hi, rdwr_en_lo_hi, cs_setup;
931 int addr_2_data_mask;
934 timings = nand_get_sdr_timings(conf);
936 return PTR_ERR(timings);
938 /* clk_x period in picoseconds */
939 t_x = DIV_ROUND_DOWN_ULL(1000000000000ULL, denali->clk_x_rate);
944 * The bus interface clock, clk_x, is phase aligned with the core clock.
945 * The clk_x is an integral multiple N of the core clk. The value N is
946 * configured at IP delivery time, and its available value is 4, 5, 6.
948 mult_x = DIV_ROUND_CLOSEST_ULL(denali->clk_x_rate, denali->clk_rate);
949 if (mult_x < 4 || mult_x > 6)
952 if (chipnr == NAND_DATA_IFACE_CHECK_ONLY)
955 /* tREA -> ACC_CLKS */
956 acc_clks = DIV_ROUND_UP(timings->tREA_max, t_x);
957 acc_clks = min_t(int, acc_clks, ACC_CLKS__VALUE);
959 tmp = ioread32(denali->reg + ACC_CLKS);
960 tmp &= ~ACC_CLKS__VALUE;
961 tmp |= FIELD_PREP(ACC_CLKS__VALUE, acc_clks);
962 iowrite32(tmp, denali->reg + ACC_CLKS);
964 /* tRWH -> RE_2_WE */
965 re_2_we = DIV_ROUND_UP(timings->tRHW_min, t_x);
966 re_2_we = min_t(int, re_2_we, RE_2_WE__VALUE);
968 tmp = ioread32(denali->reg + RE_2_WE);
969 tmp &= ~RE_2_WE__VALUE;
970 tmp |= FIELD_PREP(RE_2_WE__VALUE, re_2_we);
971 iowrite32(tmp, denali->reg + RE_2_WE);
973 /* tRHZ -> RE_2_RE */
974 re_2_re = DIV_ROUND_UP(timings->tRHZ_max, t_x);
975 re_2_re = min_t(int, re_2_re, RE_2_RE__VALUE);
977 tmp = ioread32(denali->reg + RE_2_RE);
978 tmp &= ~RE_2_RE__VALUE;
979 tmp |= FIELD_PREP(RE_2_RE__VALUE, re_2_re);
980 iowrite32(tmp, denali->reg + RE_2_RE);
983 * tCCS, tWHR -> WE_2_RE
985 * With WE_2_RE properly set, the Denali controller automatically takes
986 * care of the delay; the driver need not set NAND_WAIT_TCCS.
988 we_2_re = DIV_ROUND_UP(max(timings->tCCS_min, timings->tWHR_min), t_x);
989 we_2_re = min_t(int, we_2_re, TWHR2_AND_WE_2_RE__WE_2_RE);
991 tmp = ioread32(denali->reg + TWHR2_AND_WE_2_RE);
992 tmp &= ~TWHR2_AND_WE_2_RE__WE_2_RE;
993 tmp |= FIELD_PREP(TWHR2_AND_WE_2_RE__WE_2_RE, we_2_re);
994 iowrite32(tmp, denali->reg + TWHR2_AND_WE_2_RE);
996 /* tADL -> ADDR_2_DATA */
998 /* for older versions, ADDR_2_DATA is only 6 bit wide */
999 addr_2_data_mask = TCWAW_AND_ADDR_2_DATA__ADDR_2_DATA;
1000 if (denali->revision < 0x0501)
1001 addr_2_data_mask >>= 1;
1003 addr_2_data = DIV_ROUND_UP(timings->tADL_min, t_x);
1004 addr_2_data = min_t(int, addr_2_data, addr_2_data_mask);
1006 tmp = ioread32(denali->reg + TCWAW_AND_ADDR_2_DATA);
1007 tmp &= ~TCWAW_AND_ADDR_2_DATA__ADDR_2_DATA;
1008 tmp |= FIELD_PREP(TCWAW_AND_ADDR_2_DATA__ADDR_2_DATA, addr_2_data);
1009 iowrite32(tmp, denali->reg + TCWAW_AND_ADDR_2_DATA);
1011 /* tREH, tWH -> RDWR_EN_HI_CNT */
1012 rdwr_en_hi = DIV_ROUND_UP(max(timings->tREH_min, timings->tWH_min),
1014 rdwr_en_hi = min_t(int, rdwr_en_hi, RDWR_EN_HI_CNT__VALUE);
1016 tmp = ioread32(denali->reg + RDWR_EN_HI_CNT);
1017 tmp &= ~RDWR_EN_HI_CNT__VALUE;
1018 tmp |= FIELD_PREP(RDWR_EN_HI_CNT__VALUE, rdwr_en_hi);
1019 iowrite32(tmp, denali->reg + RDWR_EN_HI_CNT);
1021 /* tRP, tWP -> RDWR_EN_LO_CNT */
1022 rdwr_en_lo = DIV_ROUND_UP(max(timings->tRP_min, timings->tWP_min), t_x);
1023 rdwr_en_lo_hi = DIV_ROUND_UP(max(timings->tRC_min, timings->tWC_min),
1025 rdwr_en_lo_hi = max_t(int, rdwr_en_lo_hi, mult_x);
1026 rdwr_en_lo = max(rdwr_en_lo, rdwr_en_lo_hi - rdwr_en_hi);
1027 rdwr_en_lo = min_t(int, rdwr_en_lo, RDWR_EN_LO_CNT__VALUE);
1029 tmp = ioread32(denali->reg + RDWR_EN_LO_CNT);
1030 tmp &= ~RDWR_EN_LO_CNT__VALUE;
1031 tmp |= FIELD_PREP(RDWR_EN_LO_CNT__VALUE, rdwr_en_lo);
1032 iowrite32(tmp, denali->reg + RDWR_EN_LO_CNT);
1034 /* tCS, tCEA -> CS_SETUP_CNT */
1035 cs_setup = max3((int)DIV_ROUND_UP(timings->tCS_min, t_x) - rdwr_en_lo,
1036 (int)DIV_ROUND_UP(timings->tCEA_max, t_x) - acc_clks,
1038 cs_setup = min_t(int, cs_setup, CS_SETUP_CNT__VALUE);
1040 tmp = ioread32(denali->reg + CS_SETUP_CNT);
1041 tmp &= ~CS_SETUP_CNT__VALUE;
1042 tmp |= FIELD_PREP(CS_SETUP_CNT__VALUE, cs_setup);
1043 iowrite32(tmp, denali->reg + CS_SETUP_CNT);
1048 static void denali_reset_banks(struct denali_nand_info *denali)
1053 for (i = 0; i < denali->max_banks; i++) {
1054 denali->active_bank = i;
1056 denali_reset_irq(denali);
1058 iowrite32(DEVICE_RESET__BANK(i),
1059 denali->reg + DEVICE_RESET);
1061 irq_status = denali_wait_for_irq(denali,
1062 INTR__RST_COMP | INTR__INT_ACT | INTR__TIME_OUT);
1063 if (!(irq_status & INTR__INT_ACT))
1067 dev_dbg(denali->dev, "%d chips connected\n", i);
1068 denali->max_banks = i;
1071 static void denali_hw_init(struct denali_nand_info *denali)
1074 * The REVISION register may not be reliable. Platforms are allowed to
1077 if (!denali->revision)
1078 denali->revision = swab16(ioread32(denali->reg + REVISION));
1081 * Set how many bytes should be skipped before writing data in OOB.
1082 * If a platform requests a non-zero value, set it to the register.
1083 * Otherwise, read the value out, expecting it has already been set up
1086 if (denali->oob_skip_bytes)
1087 iowrite32(denali->oob_skip_bytes,
1088 denali->reg + SPARE_AREA_SKIP_BYTES);
1090 denali->oob_skip_bytes = ioread32(denali->reg +
1091 SPARE_AREA_SKIP_BYTES);
1093 denali_detect_max_banks(denali);
1094 iowrite32(0x0F, denali->reg + RB_PIN_ENABLED);
1095 iowrite32(CHIP_EN_DONT_CARE__FLAG, denali->reg + CHIP_ENABLE_DONT_CARE);
1097 iowrite32(0xffff, denali->reg + SPARE_AREA_MARKER);
1098 iowrite32(WRITE_PROTECT__FLAG, denali->reg + WRITE_PROTECT);
1101 int denali_calc_ecc_bytes(int step_size, int strength)
1103 /* BCH code. Denali requires ecc.bytes to be multiple of 2 */
1104 return DIV_ROUND_UP(strength * fls(step_size * 8), 16) * 2;
1106 EXPORT_SYMBOL(denali_calc_ecc_bytes);
1108 static int denali_ecc_setup(struct mtd_info *mtd, struct nand_chip *chip,
1109 struct denali_nand_info *denali)
1111 int oobavail = mtd->oobsize - denali->oob_skip_bytes;
1115 * If .size and .strength are already set (usually by DT),
1116 * check if they are supported by this controller.
1118 if (chip->ecc.size && chip->ecc.strength)
1119 return nand_check_ecc_caps(chip, denali->ecc_caps, oobavail);
1122 * We want .size and .strength closest to the chip's requirement
1123 * unless NAND_ECC_MAXIMIZE is requested.
1125 if (!(chip->ecc.options & NAND_ECC_MAXIMIZE)) {
1126 ret = nand_match_ecc_req(chip, denali->ecc_caps, oobavail);
1131 /* Max ECC strength is the last thing we can do */
1132 return nand_maximize_ecc(chip, denali->ecc_caps, oobavail);
1135 static struct nand_ecclayout nand_oob;
1137 static int denali_ooblayout_ecc(struct mtd_info *mtd, int section,
1138 struct mtd_oob_region *oobregion)
1140 struct denali_nand_info *denali = mtd_to_denali(mtd);
1141 struct nand_chip *chip = mtd_to_nand(mtd);
1146 oobregion->offset = denali->oob_skip_bytes;
1147 oobregion->length = chip->ecc.total;
1152 static int denali_ooblayout_free(struct mtd_info *mtd, int section,
1153 struct mtd_oob_region *oobregion)
1155 struct denali_nand_info *denali = mtd_to_denali(mtd);
1156 struct nand_chip *chip = mtd_to_nand(mtd);
1161 oobregion->offset = chip->ecc.total + denali->oob_skip_bytes;
1162 oobregion->length = mtd->oobsize - oobregion->offset;
1167 static const struct mtd_ooblayout_ops denali_ooblayout_ops = {
1168 .ecc = denali_ooblayout_ecc,
1169 .rfree = denali_ooblayout_free,
1172 static int denali_multidev_fixup(struct denali_nand_info *denali)
1174 struct nand_chip *chip = &denali->nand;
1175 struct mtd_info *mtd = nand_to_mtd(chip);
1178 * Support for multi device:
1179 * When the IP configuration is x16 capable and two x8 chips are
1180 * connected in parallel, DEVICES_CONNECTED should be set to 2.
1181 * In this case, the core framework knows nothing about this fact,
1182 * so we should tell it the _logical_ pagesize and anything necessary.
1184 denali->devs_per_cs = ioread32(denali->reg + DEVICES_CONNECTED);
1187 * On some SoCs, DEVICES_CONNECTED is not auto-detected.
1188 * For those, DEVICES_CONNECTED is left to 0. Set 1 if it is the case.
1190 if (denali->devs_per_cs == 0) {
1191 denali->devs_per_cs = 1;
1192 iowrite32(1, denali->reg + DEVICES_CONNECTED);
1195 if (denali->devs_per_cs == 1)
1198 if (denali->devs_per_cs != 2) {
1199 dev_err(denali->dev, "unsupported number of devices %d\n",
1200 denali->devs_per_cs);
1204 /* 2 chips in parallel */
1206 mtd->erasesize <<= 1;
1207 mtd->writesize <<= 1;
1209 chip->chipsize <<= 1;
1210 chip->page_shift += 1;
1211 chip->phys_erase_shift += 1;
1212 chip->bbt_erase_shift += 1;
1213 chip->chip_shift += 1;
1214 chip->pagemask <<= 1;
1215 chip->ecc.size <<= 1;
1216 chip->ecc.bytes <<= 1;
1217 chip->ecc.strength <<= 1;
1218 denali->oob_skip_bytes <<= 1;
1223 int denali_wait_reset_complete(struct denali_nand_info *denali)
1227 irq_status = denali_wait_for_irq(denali, INTR__RST_COMP);
1228 if (!(irq_status & INTR__RST_COMP))
1234 int denali_init(struct denali_nand_info *denali)
1236 struct nand_chip *chip = &denali->nand;
1237 struct mtd_info *mtd = nand_to_mtd(chip);
1238 u32 features = ioread32(denali->reg + FEATURES);
1241 denali_hw_init(denali);
1243 denali_clear_irq_all(denali);
1245 denali_reset_banks(denali);
1247 denali->active_bank = DENALI_INVALID_BANK;
1249 chip->flash_node = dev_ofnode(denali->dev);
1250 /* Fallback to the default name if DT did not give "label" property */
1252 mtd->name = "denali-nand";
1254 chip->select_chip = denali_select_chip;
1255 chip->read_byte = denali_read_byte;
1256 chip->write_byte = denali_write_byte;
1257 chip->read_word = denali_read_word;
1258 chip->cmd_ctrl = denali_cmd_ctrl;
1259 chip->dev_ready = denali_dev_ready;
1260 chip->waitfunc = denali_waitfunc;
1262 if (features & FEATURES__INDEX_ADDR) {
1263 denali->host_read = denali_indexed_read;
1264 denali->host_write = denali_indexed_write;
1266 denali->host_read = denali_direct_read;
1267 denali->host_write = denali_direct_write;
1270 /* clk rate info is needed for setup_data_interface */
1271 if (denali->clk_x_rate)
1272 chip->setup_data_interface = denali_setup_data_interface;
1274 ret = nand_scan_ident(mtd, denali->max_banks, NULL);
1278 if (ioread32(denali->reg + FEATURES) & FEATURES__DMA)
1279 denali->dma_avail = 1;
1281 if (denali->dma_avail) {
1282 chip->buf_align = ARCH_DMA_MINALIGN;
1283 if (denali->caps & DENALI_CAP_DMA_64BIT)
1284 denali->setup_dma = denali_setup_dma64;
1286 denali->setup_dma = denali_setup_dma32;
1288 chip->buf_align = 4;
1291 chip->options |= NAND_USE_BOUNCE_BUFFER;
1292 chip->bbt_options |= NAND_BBT_USE_FLASH;
1293 chip->bbt_options |= NAND_BBT_NO_OOB;
1294 denali->nand.ecc.mode = NAND_ECC_HW_SYNDROME;
1296 /* no subpage writes on denali */
1297 chip->options |= NAND_NO_SUBPAGE_WRITE;
1299 ret = denali_ecc_setup(mtd, chip, denali);
1301 dev_err(denali->dev, "Failed to setup ECC settings.\n");
1305 dev_dbg(denali->dev,
1306 "chosen ECC settings: step=%d, strength=%d, bytes=%d\n",
1307 chip->ecc.size, chip->ecc.strength, chip->ecc.bytes);
1309 iowrite32(FIELD_PREP(ECC_CORRECTION__ERASE_THRESHOLD, 1) |
1310 FIELD_PREP(ECC_CORRECTION__VALUE, chip->ecc.strength),
1311 denali->reg + ECC_CORRECTION);
1312 iowrite32(mtd->erasesize / mtd->writesize,
1313 denali->reg + PAGES_PER_BLOCK);
1314 iowrite32(chip->options & NAND_BUSWIDTH_16 ? 1 : 0,
1315 denali->reg + DEVICE_WIDTH);
1316 iowrite32(chip->options & NAND_ROW_ADDR_3 ? 0 : TWO_ROW_ADDR_CYCLES__FLAG,
1317 denali->reg + TWO_ROW_ADDR_CYCLES);
1318 iowrite32(mtd->writesize, denali->reg + DEVICE_MAIN_AREA_SIZE);
1319 iowrite32(mtd->oobsize, denali->reg + DEVICE_SPARE_AREA_SIZE);
1321 iowrite32(chip->ecc.size, denali->reg + CFG_DATA_BLOCK_SIZE);
1322 iowrite32(chip->ecc.size, denali->reg + CFG_LAST_DATA_BLOCK_SIZE);
1323 /* chip->ecc.steps is set by nand_scan_tail(); not available here */
1324 iowrite32(mtd->writesize / chip->ecc.size,
1325 denali->reg + CFG_NUM_DATA_BLOCKS);
1327 mtd_set_ooblayout(mtd, &denali_ooblayout_ops);
1329 nand_oob.eccbytes = denali->nand.ecc.bytes;
1330 denali->nand.ecc.layout = &nand_oob;
1332 if (chip->options & NAND_BUSWIDTH_16) {
1333 chip->read_buf = denali_read_buf16;
1334 chip->write_buf = denali_write_buf16;
1336 chip->read_buf = denali_read_buf;
1337 chip->write_buf = denali_write_buf;
1339 chip->ecc.options |= NAND_ECC_CUSTOM_PAGE_ACCESS;
1340 chip->ecc.read_page = denali_read_page;
1341 chip->ecc.read_page_raw = denali_read_page_raw;
1342 chip->ecc.write_page = denali_write_page;
1343 chip->ecc.write_page_raw = denali_write_page_raw;
1344 chip->ecc.read_oob = denali_read_oob;
1345 chip->ecc.write_oob = denali_write_oob;
1346 chip->erase = denali_erase;
1348 ret = denali_multidev_fixup(denali);
1353 * This buffer is DMA-mapped by denali_{read,write}_page_raw. Do not
1354 * use devm_kmalloc() because the memory allocated by devm_ does not
1355 * guarantee DMA-safe alignment.
1357 denali->buf = kmalloc(mtd->writesize + mtd->oobsize, GFP_KERNEL);
1361 ret = nand_scan_tail(mtd);
1365 ret = nand_register(0, mtd);
1367 dev_err(denali->dev, "Failed to register MTD: %d\n", ret);