1 // SPDX-License-Identifier: GPL-2.0+
3 * LPC32xx SLC NAND flash controller driver
5 * (C) Copyright 2015-2018 Vladimir Zapolskiy <vz@mleia.com>
6 * Copyright (c) 2015 Tyco Fire Protection Products.
8 * Hardware ECC support original source code
9 * Copyright (C) 2008 by NXP Semiconductors
16 #include <linux/bug.h>
17 #include <linux/mtd/nand_ecc.h>
18 #include <linux/mtd/rawnand.h>
19 #include <linux/errno.h>
21 #include <asm/arch/config.h>
22 #include <asm/arch/clk.h>
23 #include <asm/arch/sys_proto.h>
24 #include <asm/arch/dma.h>
25 #include <asm/arch/cpu.h>
27 struct lpc32xx_nand_slc_regs {
46 #define CFG_CE_LOW (1 << 5)
47 #define CFG_DMA_ECC (1 << 4) /* Enable DMA ECC bit */
48 #define CFG_ECC_EN (1 << 3) /* ECC enable bit */
49 #define CFG_DMA_BURST (1 << 2) /* DMA burst bit */
50 #define CFG_DMA_DIR (1 << 1) /* DMA write(0)/read(1) bit */
53 #define CTRL_SW_RESET (1 << 2)
54 #define CTRL_ECC_CLEAR (1 << 1) /* Reset ECC bit */
55 #define CTRL_DMA_START (1 << 0) /* Start DMA channel bit */
58 #define STAT_DMA_FIFO (1 << 2) /* DMA FIFO has data bit */
59 #define STAT_NAND_READY (1 << 0)
61 /* INT_STAT register */
62 #define INT_STAT_TC (1 << 1)
63 #define INT_STAT_RDY (1 << 0)
65 /* TAC register bits, be aware of overflows */
66 #define TAC_W_RDY(n) (max_t(uint32_t, (n), 0xF) << 28)
67 #define TAC_W_WIDTH(n) (max_t(uint32_t, (n), 0xF) << 24)
68 #define TAC_W_HOLD(n) (max_t(uint32_t, (n), 0xF) << 20)
69 #define TAC_W_SETUP(n) (max_t(uint32_t, (n), 0xF) << 16)
70 #define TAC_R_RDY(n) (max_t(uint32_t, (n), 0xF) << 12)
71 #define TAC_R_WIDTH(n) (max_t(uint32_t, (n), 0xF) << 8)
72 #define TAC_R_HOLD(n) (max_t(uint32_t, (n), 0xF) << 4)
73 #define TAC_R_SETUP(n) (max_t(uint32_t, (n), 0xF) << 0)
75 /* NAND ECC Layout for small page NAND devices
76 * Note: For large page devices, the default layouts are used. */
77 static struct nand_ecclayout lpc32xx_nand_oob_16 = {
79 .eccpos = { 10, 11, 12, 13, 14, 15, },
81 { .offset = 0, .length = 4, },
82 { .offset = 6, .length = 4, },
86 #if defined(CONFIG_DMA_LPC32XX) && !defined(CONFIG_SPL_BUILD)
87 #define ECCSTEPS (CONFIG_SYS_NAND_PAGE_SIZE / CONFIG_SYS_NAND_ECCSIZE)
91 * For Large Block: 17 descriptors = ((16 Data and ECC Read) + 1 Spare Area)
92 * For Small Block: 5 descriptors = ((4 Data and ECC Read) + 1 Spare Area)
94 static struct lpc32xx_dmac_ll dmalist[ECCSTEPS * 2 + 1];
95 static u32 ecc_buffer[8]; /* MAX ECC size */
96 static unsigned int dmachan = (unsigned int)-1; /* Invalid channel */
99 * Helper macro for the DMA client (i.e. NAND SLC):
100 * - to write the next DMA linked list item address
101 * (see arch/include/asm/arch-lpc32xx/dma.h).
102 * - to assign the DMA data register to DMA source or destination address.
103 * - to assign the ECC register to DMA source or destination address.
105 #define lpc32xx_dmac_next_lli(x) ((u32)x)
106 #define lpc32xx_dmac_set_dma_data() ((u32)&lpc32xx_nand_slc_regs->dma_data)
107 #define lpc32xx_dmac_set_ecc() ((u32)&lpc32xx_nand_slc_regs->ecc)
110 static struct lpc32xx_nand_slc_regs __iomem *lpc32xx_nand_slc_regs
111 = (struct lpc32xx_nand_slc_regs __iomem *)SLC_NAND_BASE;
113 static void lpc32xx_nand_init(void)
115 uint32_t hclk = get_hclk_clk_rate();
117 /* Reset SLC NAND controller */
118 writel(CTRL_SW_RESET, &lpc32xx_nand_slc_regs->ctrl);
120 /* 8-bit bus, no DMA, no ECC, ordinary CE signal */
121 writel(0, &lpc32xx_nand_slc_regs->cfg);
123 /* Interrupts disabled and cleared */
124 writel(0, &lpc32xx_nand_slc_regs->ien);
125 writel(INT_STAT_TC | INT_STAT_RDY,
126 &lpc32xx_nand_slc_regs->icr);
128 /* Configure NAND flash timings */
129 writel(TAC_W_RDY(CONFIG_LPC32XX_NAND_SLC_WDR_CLKS) |
130 TAC_W_WIDTH(hclk / CONFIG_LPC32XX_NAND_SLC_WWIDTH) |
131 TAC_W_HOLD(hclk / CONFIG_LPC32XX_NAND_SLC_WHOLD) |
132 TAC_W_SETUP(hclk / CONFIG_LPC32XX_NAND_SLC_WSETUP) |
133 TAC_R_RDY(CONFIG_LPC32XX_NAND_SLC_RDR_CLKS) |
134 TAC_R_WIDTH(hclk / CONFIG_LPC32XX_NAND_SLC_RWIDTH) |
135 TAC_R_HOLD(hclk / CONFIG_LPC32XX_NAND_SLC_RHOLD) |
136 TAC_R_SETUP(hclk / CONFIG_LPC32XX_NAND_SLC_RSETUP),
137 &lpc32xx_nand_slc_regs->tac);
140 static void lpc32xx_nand_cmd_ctrl(struct mtd_info *mtd,
141 int cmd, unsigned int ctrl)
143 debug("ctrl: 0x%08x, cmd: 0x%08x\n", ctrl, cmd);
146 setbits_le32(&lpc32xx_nand_slc_regs->cfg, CFG_CE_LOW);
148 clrbits_le32(&lpc32xx_nand_slc_regs->cfg, CFG_CE_LOW);
150 if (cmd == NAND_CMD_NONE)
154 writel(cmd & 0xFF, &lpc32xx_nand_slc_regs->cmd);
155 else if (ctrl & NAND_ALE)
156 writel(cmd & 0xFF, &lpc32xx_nand_slc_regs->addr);
159 static int lpc32xx_nand_dev_ready(struct mtd_info *mtd)
161 return readl(&lpc32xx_nand_slc_regs->stat) & STAT_NAND_READY;
164 #if defined(CONFIG_DMA_LPC32XX) && !defined(CONFIG_SPL_BUILD)
166 * Prepares DMA descriptors for NAND RD/WR operations
167 * If the size is < 256 Bytes then it is assumed to be
170 static void lpc32xx_nand_dma_configure(struct nand_chip *chip,
171 const u8 *buffer, int size,
174 u32 i, dmasrc, ctrl, ecc_ctrl, oob_ctrl, dmadst;
175 struct lpc32xx_dmac_ll *dmalist_cur;
176 struct lpc32xx_dmac_ll *dmalist_cur_ecc;
179 * CTRL descriptor entry for reading ECC
180 * Copy Multiple times to sync DMA with Flash Controller
183 DMAC_CHAN_SRC_BURST_1 |
184 DMAC_CHAN_DEST_BURST_1 |
185 DMAC_CHAN_SRC_WIDTH_32 |
186 DMAC_CHAN_DEST_WIDTH_32 |
189 /* CTRL descriptor entry for reading/writing Data */
190 ctrl = (CONFIG_SYS_NAND_ECCSIZE / 4) |
191 DMAC_CHAN_SRC_BURST_4 |
192 DMAC_CHAN_DEST_BURST_4 |
193 DMAC_CHAN_SRC_WIDTH_32 |
194 DMAC_CHAN_DEST_WIDTH_32 |
197 /* CTRL descriptor entry for reading/writing Spare Area */
198 oob_ctrl = (CONFIG_SYS_NAND_OOBSIZE / 4) |
199 DMAC_CHAN_SRC_BURST_4 |
200 DMAC_CHAN_DEST_BURST_4 |
201 DMAC_CHAN_SRC_WIDTH_32 |
202 DMAC_CHAN_DEST_WIDTH_32 |
206 dmasrc = lpc32xx_dmac_set_dma_data();
207 dmadst = (u32)buffer;
208 ctrl |= DMAC_CHAN_DEST_AUTOINC;
210 dmadst = lpc32xx_dmac_set_dma_data();
211 dmasrc = (u32)buffer;
212 ctrl |= DMAC_CHAN_SRC_AUTOINC;
216 * Write Operation Sequence for Small Block NAND
217 * ----------------------------------------------------------
218 * 1. X'fer 256 bytes of data from Memory to Flash.
219 * 2. Copy generated ECC data from Register to Spare Area
220 * 3. X'fer next 256 bytes of data from Memory to Flash.
221 * 4. Copy generated ECC data from Register to Spare Area.
222 * 5. X'fer 16 byets of Spare area from Memory to Flash.
223 * Read Operation Sequence for Small Block NAND
224 * ----------------------------------------------------------
225 * 1. X'fer 256 bytes of data from Flash to Memory.
226 * 2. Copy generated ECC data from Register to ECC calc Buffer.
227 * 3. X'fer next 256 bytes of data from Flash to Memory.
228 * 4. Copy generated ECC data from Register to ECC calc Buffer.
229 * 5. X'fer 16 bytes of Spare area from Flash to Memory.
230 * Write Operation Sequence for Large Block NAND
231 * ----------------------------------------------------------
232 * 1. Steps(1-4) of Write Operations repeate for four times
233 * which generates 16 DMA descriptors to X'fer 2048 bytes of
234 * data & 32 bytes of ECC data.
235 * 2. X'fer 64 bytes of Spare area from Memory to Flash.
236 * Read Operation Sequence for Large Block NAND
237 * ----------------------------------------------------------
238 * 1. Steps(1-4) of Read Operations repeate for four times
239 * which generates 16 DMA descriptors to X'fer 2048 bytes of
240 * data & 32 bytes of ECC data.
241 * 2. X'fer 64 bytes of Spare area from Flash to Memory.
244 for (i = 0; i < size/CONFIG_SYS_NAND_ECCSIZE; i++) {
245 dmalist_cur = &dmalist[i * 2];
246 dmalist_cur_ecc = &dmalist[(i * 2) + 1];
248 dmalist_cur->dma_src = (read ? (dmasrc) : (dmasrc + (i*256)));
249 dmalist_cur->dma_dest = (read ? (dmadst + (i*256)) : dmadst);
250 dmalist_cur->next_lli = lpc32xx_dmac_next_lli(dmalist_cur_ecc);
251 dmalist_cur->next_ctrl = ctrl;
253 dmalist_cur_ecc->dma_src = lpc32xx_dmac_set_ecc();
254 dmalist_cur_ecc->dma_dest = (u32)&ecc_buffer[i];
255 dmalist_cur_ecc->next_lli =
256 lpc32xx_dmac_next_lli(&dmalist[(i * 2) + 2]);
257 dmalist_cur_ecc->next_ctrl = ecc_ctrl;
260 if (i) { /* Data only transfer */
261 dmalist_cur_ecc = &dmalist[(i * 2) - 1];
262 dmalist_cur_ecc->next_lli = 0;
263 dmalist_cur_ecc->next_ctrl |= DMAC_CHAN_INT_TC_EN;
267 /* OOB only transfer */
269 dmasrc = lpc32xx_dmac_set_dma_data();
270 dmadst = (u32)buffer;
271 oob_ctrl |= DMAC_CHAN_DEST_AUTOINC;
273 dmadst = lpc32xx_dmac_set_dma_data();
274 dmasrc = (u32)buffer;
275 oob_ctrl |= DMAC_CHAN_SRC_AUTOINC;
278 /* Read/ Write Spare Area Data To/From Flash */
279 dmalist_cur = &dmalist[i * 2];
280 dmalist_cur->dma_src = dmasrc;
281 dmalist_cur->dma_dest = dmadst;
282 dmalist_cur->next_lli = 0;
283 dmalist_cur->next_ctrl = (oob_ctrl | DMAC_CHAN_INT_TC_EN);
286 static void lpc32xx_nand_xfer(struct mtd_info *mtd, const u8 *buf,
289 struct nand_chip *chip = mtd_to_nand(mtd);
293 /* DMA Channel Configuration */
294 config = (read ? DMAC_CHAN_FLOW_D_P2M : DMAC_CHAN_FLOW_D_M2P) |
295 (read ? DMAC_DEST_PERIP(0) : DMAC_DEST_PERIP(DMA_PERID_NAND1)) |
296 (read ? DMAC_SRC_PERIP(DMA_PERID_NAND1) : DMAC_SRC_PERIP(0)) |
299 /* Prepare DMA descriptors */
300 lpc32xx_nand_dma_configure(chip, buf, len, read);
302 /* Setup SLC controller and start transfer */
304 setbits_le32(&lpc32xx_nand_slc_regs->cfg, CFG_DMA_DIR);
305 else /* NAND_ECC_WRITE */
306 clrbits_le32(&lpc32xx_nand_slc_regs->cfg, CFG_DMA_DIR);
307 setbits_le32(&lpc32xx_nand_slc_regs->cfg, CFG_DMA_BURST);
309 /* Write length for new transfers */
310 if (!((readl(&lpc32xx_nand_slc_regs->stat) & STAT_DMA_FIFO) |
311 readl(&lpc32xx_nand_slc_regs->tc))) {
312 int tmp = (len != mtd->oobsize) ? mtd->oobsize : 0;
313 writel(len + tmp, &lpc32xx_nand_slc_regs->tc);
316 setbits_le32(&lpc32xx_nand_slc_regs->ctrl, CTRL_DMA_START);
318 /* Start DMA transfers */
319 ret = lpc32xx_dma_start_xfer(dmachan, dmalist, config);
320 if (unlikely(ret < 0))
323 /* Wait for NAND to be ready */
324 while (!lpc32xx_nand_dev_ready(mtd))
327 /* Wait till DMA transfer is DONE */
328 if (lpc32xx_dma_wait_status(dmachan))
329 pr_err("NAND DMA transfer error!\r\n");
331 /* Stop DMA & HW ECC */
332 clrbits_le32(&lpc32xx_nand_slc_regs->ctrl, CTRL_DMA_START);
333 clrbits_le32(&lpc32xx_nand_slc_regs->cfg,
334 CFG_DMA_DIR | CFG_DMA_BURST | CFG_ECC_EN | CFG_DMA_ECC);
337 static u32 slc_ecc_copy_to_buffer(u8 *spare, const u32 *ecc, int count)
340 for (i = 0; i < (count * CONFIG_SYS_NAND_ECCBYTES);
341 i += CONFIG_SYS_NAND_ECCBYTES) {
342 u32 ce = ecc[i / CONFIG_SYS_NAND_ECCBYTES];
343 ce = ~(ce << 2) & 0xFFFFFF;
344 spare[i+2] = (u8)(ce & 0xFF); ce >>= 8;
345 spare[i+1] = (u8)(ce & 0xFF); ce >>= 8;
346 spare[i] = (u8)(ce & 0xFF);
351 static int lpc32xx_ecc_calculate(struct mtd_info *mtd, const uint8_t *dat,
354 return slc_ecc_copy_to_buffer(ecc_code, ecc_buffer, ECCSTEPS);
358 * Enables and prepares SLC NAND controller
359 * for doing data transfers with H/W ECC enabled.
361 static void lpc32xx_hwecc_enable(struct mtd_info *mtd, int mode)
364 writel(CTRL_ECC_CLEAR, &lpc32xx_nand_slc_regs->ctrl);
366 /* Setup SLC controller for H/W ECC operations */
367 setbits_le32(&lpc32xx_nand_slc_regs->cfg, CFG_ECC_EN | CFG_DMA_ECC);
371 * lpc32xx_correct_data - [NAND Interface] Detect and correct bit error(s)
372 * mtd: MTD block structure
373 * dat: raw data read from the chip
374 * read_ecc: ECC from the chip
375 * calc_ecc: the ECC calculated from raw data
377 * Detect and correct a 1 bit error for 256 byte block
379 int lpc32xx_correct_data(struct mtd_info *mtd, u_char *dat,
380 u_char *read_ecc, u_char *calc_ecc)
384 u_char *r = read_ecc;
385 u_char *c = calc_ecc;
388 for (i = 0 ; i < ECCSTEPS ; i++) {
389 r += CONFIG_SYS_NAND_ECCBYTES;
390 c += CONFIG_SYS_NAND_ECCBYTES;
391 data_offset += CONFIG_SYS_NAND_ECCSIZE;
393 ret1 = nand_correct_data(mtd, dat + data_offset, r, c);
403 static void lpc32xx_dma_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
405 lpc32xx_nand_xfer(mtd, buf, len, 1);
408 static void lpc32xx_dma_write_buf(struct mtd_info *mtd, const uint8_t *buf,
411 lpc32xx_nand_xfer(mtd, buf, len, 0);
414 /* Reuse the logic from "nand_read_page_hwecc()" */
415 static int lpc32xx_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
416 uint8_t *buf, int oob_required, int page)
421 uint8_t *ecc_calc = chip->buffers->ecccalc;
422 uint8_t *ecc_code = chip->buffers->ecccode;
423 uint32_t *eccpos = chip->ecc.layout->eccpos;
424 unsigned int max_bitflips = 0;
427 * As per the "LPC32x0 and LPC32x0/01 User manual" table 173 notes
428 * and section 9.7, the NAND SLC & DMA allowed single DMA transaction
429 * of a page size using DMA controller scatter/gather mode through
430 * linked list; the ECC read is done without any software intervention.
433 lpc32xx_hwecc_enable(mtd, NAND_ECC_READ);
434 lpc32xx_dma_read_buf(mtd, p, chip->ecc.size * chip->ecc.steps);
435 lpc32xx_ecc_calculate(mtd, p, &ecc_calc[0]);
436 lpc32xx_dma_read_buf(mtd, chip->oob_poi, mtd->oobsize);
438 for (i = 0; i < chip->ecc.total; i++)
439 ecc_code[i] = chip->oob_poi[eccpos[i]];
441 stat = chip->ecc.correct(mtd, p, &ecc_code[0], &ecc_calc[0]);
443 mtd->ecc_stats.failed++;
445 mtd->ecc_stats.corrected += stat;
446 max_bitflips = max_t(unsigned int, max_bitflips, stat);
452 /* Reuse the logic from "nand_write_page_hwecc()" */
453 static int lpc32xx_write_page_hwecc(struct mtd_info *mtd,
454 struct nand_chip *chip,
455 const uint8_t *buf, int oob_required,
459 uint8_t *ecc_calc = chip->buffers->ecccalc;
460 const uint8_t *p = buf;
461 uint32_t *eccpos = chip->ecc.layout->eccpos;
464 * As per the "LPC32x0 and LPC32x0/01 User manual" table 173 notes
465 * and section 9.7, the NAND SLC & DMA allowed single DMA transaction
466 * of a page size using DMA controller scatter/gather mode through
467 * linked list; the ECC read is done without any software intervention.
470 lpc32xx_hwecc_enable(mtd, NAND_ECC_WRITE);
471 lpc32xx_dma_write_buf(mtd, p, chip->ecc.size * chip->ecc.steps);
472 lpc32xx_ecc_calculate(mtd, p, &ecc_calc[0]);
474 for (i = 0; i < chip->ecc.total; i++)
475 chip->oob_poi[eccpos[i]] = ecc_calc[i];
477 lpc32xx_dma_write_buf(mtd, chip->oob_poi, mtd->oobsize);
482 static void lpc32xx_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
485 *buf++ = readl(&lpc32xx_nand_slc_regs->data);
488 static void lpc32xx_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
491 writel(*buf++, &lpc32xx_nand_slc_regs->data);
495 static uint8_t lpc32xx_read_byte(struct mtd_info *mtd)
497 return readl(&lpc32xx_nand_slc_regs->data);
500 static void lpc32xx_write_byte(struct mtd_info *mtd, uint8_t byte)
502 writel(byte, &lpc32xx_nand_slc_regs->data);
506 * LPC32xx has only one SLC NAND controller, don't utilize
507 * CONFIG_SYS_NAND_SELF_INIT to be able to reuse this function
508 * both in SPL NAND and U-Boot images.
510 int board_nand_init(struct nand_chip *lpc32xx_chip)
512 #if defined(CONFIG_DMA_LPC32XX) && !defined(CONFIG_SPL_BUILD)
515 /* Acquire a channel for our use */
516 ret = lpc32xx_dma_get_channel();
517 if (unlikely(ret < 0)) {
518 pr_info("Unable to get free DMA channel for NAND transfers\n");
521 dmachan = (unsigned int)ret;
524 lpc32xx_chip->cmd_ctrl = lpc32xx_nand_cmd_ctrl;
525 lpc32xx_chip->dev_ready = lpc32xx_nand_dev_ready;
528 * The implementation of these functions is quite common, but
529 * they MUST be defined, because access to data register
530 * is strictly 32-bit aligned.
532 lpc32xx_chip->read_byte = lpc32xx_read_byte;
533 lpc32xx_chip->write_byte = lpc32xx_write_byte;
535 #if defined(CONFIG_DMA_LPC32XX) && !defined(CONFIG_SPL_BUILD)
536 /* Hardware ECC calculation is supported when DMA driver is selected */
537 lpc32xx_chip->ecc.mode = NAND_ECC_HW;
539 lpc32xx_chip->read_buf = lpc32xx_dma_read_buf;
540 lpc32xx_chip->write_buf = lpc32xx_dma_write_buf;
542 lpc32xx_chip->ecc.calculate = lpc32xx_ecc_calculate;
543 lpc32xx_chip->ecc.correct = lpc32xx_correct_data;
544 lpc32xx_chip->ecc.hwctl = lpc32xx_hwecc_enable;
545 lpc32xx_chip->chip_delay = 2000;
547 lpc32xx_chip->ecc.read_page = lpc32xx_read_page_hwecc;
548 lpc32xx_chip->ecc.write_page = lpc32xx_write_page_hwecc;
549 lpc32xx_chip->options |= NAND_NO_SUBPAGE_WRITE;
552 * Hardware ECC calculation is not supported by the driver,
553 * because it requires DMA support, see LPC32x0 User Manual,
554 * note after SLC_ECC register description (UM10326, p.198)
556 lpc32xx_chip->ecc.mode = NAND_ECC_SOFT;
559 * The implementation of these functions is quite common, but
560 * they MUST be defined, because access to data register
561 * is strictly 32-bit aligned.
563 lpc32xx_chip->read_buf = lpc32xx_read_buf;
564 lpc32xx_chip->write_buf = lpc32xx_write_buf;
568 * These values are predefined
569 * for both small and large page NAND flash devices.
571 lpc32xx_chip->ecc.size = CONFIG_SYS_NAND_ECCSIZE;
572 lpc32xx_chip->ecc.bytes = CONFIG_SYS_NAND_ECCBYTES;
573 lpc32xx_chip->ecc.strength = 1;
575 if (CONFIG_SYS_NAND_PAGE_SIZE != NAND_LARGE_BLOCK_PAGE_SIZE)
576 lpc32xx_chip->ecc.layout = &lpc32xx_nand_oob_16;
578 #if defined(CONFIG_SYS_NAND_USE_FLASH_BBT)
579 lpc32xx_chip->bbt_options |= NAND_BBT_USE_FLASH;
582 /* Initialize NAND interface */