2 * drivers/mtd/nand/pxa3xx_nand.c
4 * Copyright © 2005 Intel Corporation
5 * Copyright © 2006 Marvell International Ltd.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * See Documentation/mtd/nand/pxa3xx-nand.txt for more details.
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/interrupt.h>
17 #include <linux/platform_device.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/delay.h>
20 #include <linux/clk.h>
21 #include <linux/mtd/mtd.h>
22 #include <linux/mtd/nand.h>
23 #include <linux/mtd/partitions.h>
25 #include <linux/irq.h>
26 #include <linux/slab.h>
28 #include <linux/of_device.h>
30 #if defined(CONFIG_ARCH_PXA) || defined(CONFIG_ARCH_MMP)
38 #include <linux/platform_data/mtd-nand-pxa3xx.h>
40 #define CHIP_DELAY_TIMEOUT (2 * HZ/10)
41 #define NAND_STOP_DELAY (2 * HZ/50)
42 #define PAGE_CHUNK_SIZE (2048)
45 * Define a buffer size for the initial command that detects the flash device:
46 * STATUS, READID and PARAM. The largest of these is the PARAM command,
49 #define INIT_BUFFER_SIZE 256
51 /* registers and bit definitions */
52 #define NDCR (0x00) /* Control register */
53 #define NDTR0CS0 (0x04) /* Timing Parameter 0 for CS0 */
54 #define NDTR1CS0 (0x0C) /* Timing Parameter 1 for CS0 */
55 #define NDSR (0x14) /* Status Register */
56 #define NDPCR (0x18) /* Page Count Register */
57 #define NDBDR0 (0x1C) /* Bad Block Register 0 */
58 #define NDBDR1 (0x20) /* Bad Block Register 1 */
59 #define NDDB (0x40) /* Data Buffer */
60 #define NDCB0 (0x48) /* Command Buffer0 */
61 #define NDCB1 (0x4C) /* Command Buffer1 */
62 #define NDCB2 (0x50) /* Command Buffer2 */
64 #define NDCR_SPARE_EN (0x1 << 31)
65 #define NDCR_ECC_EN (0x1 << 30)
66 #define NDCR_DMA_EN (0x1 << 29)
67 #define NDCR_ND_RUN (0x1 << 28)
68 #define NDCR_DWIDTH_C (0x1 << 27)
69 #define NDCR_DWIDTH_M (0x1 << 26)
70 #define NDCR_PAGE_SZ (0x1 << 24)
71 #define NDCR_NCSX (0x1 << 23)
72 #define NDCR_ND_MODE (0x3 << 21)
73 #define NDCR_NAND_MODE (0x0)
74 #define NDCR_CLR_PG_CNT (0x1 << 20)
75 #define NDCR_STOP_ON_UNCOR (0x1 << 19)
76 #define NDCR_RD_ID_CNT_MASK (0x7 << 16)
77 #define NDCR_RD_ID_CNT(x) (((x) << 16) & NDCR_RD_ID_CNT_MASK)
79 #define NDCR_RA_START (0x1 << 15)
80 #define NDCR_PG_PER_BLK (0x1 << 14)
81 #define NDCR_ND_ARB_EN (0x1 << 12)
82 #define NDCR_INT_MASK (0xFFF)
84 #define NDSR_MASK (0xfff)
85 #define NDSR_RDY (0x1 << 12)
86 #define NDSR_FLASH_RDY (0x1 << 11)
87 #define NDSR_CS0_PAGED (0x1 << 10)
88 #define NDSR_CS1_PAGED (0x1 << 9)
89 #define NDSR_CS0_CMDD (0x1 << 8)
90 #define NDSR_CS1_CMDD (0x1 << 7)
91 #define NDSR_CS0_BBD (0x1 << 6)
92 #define NDSR_CS1_BBD (0x1 << 5)
93 #define NDSR_DBERR (0x1 << 4)
94 #define NDSR_SBERR (0x1 << 3)
95 #define NDSR_WRDREQ (0x1 << 2)
96 #define NDSR_RDDREQ (0x1 << 1)
97 #define NDSR_WRCMDREQ (0x1)
99 #define NDCB0_LEN_OVRD (0x1 << 28)
100 #define NDCB0_ST_ROW_EN (0x1 << 26)
101 #define NDCB0_AUTO_RS (0x1 << 25)
102 #define NDCB0_CSEL (0x1 << 24)
103 #define NDCB0_CMD_TYPE_MASK (0x7 << 21)
104 #define NDCB0_CMD_TYPE(x) (((x) << 21) & NDCB0_CMD_TYPE_MASK)
105 #define NDCB0_NC (0x1 << 20)
106 #define NDCB0_DBC (0x1 << 19)
107 #define NDCB0_ADDR_CYC_MASK (0x7 << 16)
108 #define NDCB0_ADDR_CYC(x) (((x) << 16) & NDCB0_ADDR_CYC_MASK)
109 #define NDCB0_CMD2_MASK (0xff << 8)
110 #define NDCB0_CMD1_MASK (0xff)
111 #define NDCB0_ADDR_CYC_SHIFT (16)
113 /* macros for registers read/write */
114 #define nand_writel(info, off, val) \
115 __raw_writel((val), (info)->mmio_base + (off))
117 #define nand_readl(info, off) \
118 __raw_readl((info)->mmio_base + (off))
120 /* error code and state */
143 enum pxa3xx_nand_variant {
144 PXA3XX_NAND_VARIANT_PXA,
145 PXA3XX_NAND_VARIANT_ARMADA370,
148 struct pxa3xx_nand_host {
149 struct nand_chip chip;
150 struct mtd_info *mtd;
153 /* page size of attached chip */
154 unsigned int page_size;
158 /* calculated from pxa3xx_nand_flash data */
159 unsigned int col_addr_cycles;
160 unsigned int row_addr_cycles;
161 size_t read_id_bytes;
165 struct pxa3xx_nand_info {
166 struct nand_hw_control controller;
167 struct platform_device *pdev;
170 void __iomem *mmio_base;
171 unsigned long mmio_phys;
172 struct completion cmd_complete;
174 unsigned int buf_start;
175 unsigned int buf_count;
176 unsigned int buf_size;
178 /* DMA information */
182 unsigned char *data_buff;
183 unsigned char *oob_buff;
184 dma_addr_t data_buff_phys;
186 struct pxa_dma_desc *data_desc;
187 dma_addr_t data_desc_addr;
189 struct pxa3xx_nand_host *host[NUM_CHIP_SELECT];
193 * This driver supports NFCv1 (as found in PXA SoC)
194 * and NFCv2 (as found in Armada 370/XP SoC).
196 enum pxa3xx_nand_variant variant;
199 int use_ecc; /* use HW ECC ? */
200 int use_dma; /* use DMA ? */
201 int use_spare; /* use spare ? */
204 unsigned int page_size; /* page size of attached chip */
205 unsigned int data_size; /* data size in FIFO */
206 unsigned int oob_size;
209 /* cached register value */
214 /* generated NDCBx register values */
221 static bool use_dma = 1;
222 module_param(use_dma, bool, 0444);
223 MODULE_PARM_DESC(use_dma, "enable DMA for data transferring to/from NAND HW");
225 static struct pxa3xx_nand_timing timing[] = {
226 { 40, 80, 60, 100, 80, 100, 90000, 400, 40, },
227 { 10, 0, 20, 40, 30, 40, 11123, 110, 10, },
228 { 10, 25, 15, 25, 15, 30, 25000, 60, 10, },
229 { 10, 35, 15, 25, 15, 25, 25000, 60, 10, },
232 static struct pxa3xx_nand_flash builtin_flash_types[] = {
233 { "DEFAULT FLASH", 0, 0, 2048, 8, 8, 0, &timing[0] },
234 { "64MiB 16-bit", 0x46ec, 32, 512, 16, 16, 4096, &timing[1] },
235 { "256MiB 8-bit", 0xdaec, 64, 2048, 8, 8, 2048, &timing[1] },
236 { "4GiB 8-bit", 0xd7ec, 128, 4096, 8, 8, 8192, &timing[1] },
237 { "128MiB 8-bit", 0xa12c, 64, 2048, 8, 8, 1024, &timing[2] },
238 { "128MiB 16-bit", 0xb12c, 64, 2048, 16, 16, 1024, &timing[2] },
239 { "512MiB 8-bit", 0xdc2c, 64, 2048, 8, 8, 4096, &timing[2] },
240 { "512MiB 16-bit", 0xcc2c, 64, 2048, 16, 16, 4096, &timing[2] },
241 { "256MiB 16-bit", 0xba20, 64, 2048, 16, 16, 2048, &timing[3] },
244 /* Define a default flash type setting serve as flash detecting only */
245 #define DEFAULT_FLASH_TYPE (&builtin_flash_types[0])
247 #define NDTR0_tCH(c) (min((c), 7) << 19)
248 #define NDTR0_tCS(c) (min((c), 7) << 16)
249 #define NDTR0_tWH(c) (min((c), 7) << 11)
250 #define NDTR0_tWP(c) (min((c), 7) << 8)
251 #define NDTR0_tRH(c) (min((c), 7) << 3)
252 #define NDTR0_tRP(c) (min((c), 7) << 0)
254 #define NDTR1_tR(c) (min((c), 65535) << 16)
255 #define NDTR1_tWHR(c) (min((c), 15) << 4)
256 #define NDTR1_tAR(c) (min((c), 15) << 0)
258 /* convert nano-seconds to nand flash controller clock cycles */
259 #define ns2cycle(ns, clk) (int)((ns) * (clk / 1000000) / 1000)
261 static void pxa3xx_nand_set_timing(struct pxa3xx_nand_host *host,
262 const struct pxa3xx_nand_timing *t)
264 struct pxa3xx_nand_info *info = host->info_data;
265 unsigned long nand_clk = clk_get_rate(info->clk);
266 uint32_t ndtr0, ndtr1;
268 ndtr0 = NDTR0_tCH(ns2cycle(t->tCH, nand_clk)) |
269 NDTR0_tCS(ns2cycle(t->tCS, nand_clk)) |
270 NDTR0_tWH(ns2cycle(t->tWH, nand_clk)) |
271 NDTR0_tWP(ns2cycle(t->tWP, nand_clk)) |
272 NDTR0_tRH(ns2cycle(t->tRH, nand_clk)) |
273 NDTR0_tRP(ns2cycle(t->tRP, nand_clk));
275 ndtr1 = NDTR1_tR(ns2cycle(t->tR, nand_clk)) |
276 NDTR1_tWHR(ns2cycle(t->tWHR, nand_clk)) |
277 NDTR1_tAR(ns2cycle(t->tAR, nand_clk));
279 info->ndtr0cs0 = ndtr0;
280 info->ndtr1cs0 = ndtr1;
281 nand_writel(info, NDTR0CS0, ndtr0);
282 nand_writel(info, NDTR1CS0, ndtr1);
285 static void pxa3xx_set_datasize(struct pxa3xx_nand_info *info)
287 struct pxa3xx_nand_host *host = info->host[info->cs];
288 int oob_enable = info->reg_ndcr & NDCR_SPARE_EN;
290 info->data_size = host->page_size;
296 switch (host->page_size) {
298 info->oob_size = (info->use_ecc) ? 40 : 64;
301 info->oob_size = (info->use_ecc) ? 8 : 16;
307 * NOTE: it is a must to set ND_RUN firstly, then write
308 * command buffer, otherwise, it does not work.
309 * We enable all the interrupt at the same time, and
310 * let pxa3xx_nand_irq to handle all logic.
312 static void pxa3xx_nand_start(struct pxa3xx_nand_info *info)
316 ndcr = info->reg_ndcr;
321 ndcr &= ~NDCR_ECC_EN;
326 ndcr &= ~NDCR_DMA_EN;
329 ndcr |= NDCR_SPARE_EN;
331 ndcr &= ~NDCR_SPARE_EN;
335 /* clear status bits and run */
336 nand_writel(info, NDCR, 0);
337 nand_writel(info, NDSR, NDSR_MASK);
338 nand_writel(info, NDCR, ndcr);
341 static void pxa3xx_nand_stop(struct pxa3xx_nand_info *info)
344 int timeout = NAND_STOP_DELAY;
346 /* wait RUN bit in NDCR become 0 */
347 ndcr = nand_readl(info, NDCR);
348 while ((ndcr & NDCR_ND_RUN) && (timeout-- > 0)) {
349 ndcr = nand_readl(info, NDCR);
354 ndcr &= ~NDCR_ND_RUN;
355 nand_writel(info, NDCR, ndcr);
357 /* clear status bits */
358 nand_writel(info, NDSR, NDSR_MASK);
361 static void __maybe_unused
362 enable_int(struct pxa3xx_nand_info *info, uint32_t int_mask)
366 ndcr = nand_readl(info, NDCR);
367 nand_writel(info, NDCR, ndcr & ~int_mask);
370 static void disable_int(struct pxa3xx_nand_info *info, uint32_t int_mask)
374 ndcr = nand_readl(info, NDCR);
375 nand_writel(info, NDCR, ndcr | int_mask);
378 static void handle_data_pio(struct pxa3xx_nand_info *info)
380 switch (info->state) {
381 case STATE_PIO_WRITING:
382 __raw_writesl(info->mmio_base + NDDB, info->data_buff,
383 DIV_ROUND_UP(info->data_size, 4));
384 if (info->oob_size > 0)
385 __raw_writesl(info->mmio_base + NDDB, info->oob_buff,
386 DIV_ROUND_UP(info->oob_size, 4));
388 case STATE_PIO_READING:
389 __raw_readsl(info->mmio_base + NDDB, info->data_buff,
390 DIV_ROUND_UP(info->data_size, 4));
391 if (info->oob_size > 0)
392 __raw_readsl(info->mmio_base + NDDB, info->oob_buff,
393 DIV_ROUND_UP(info->oob_size, 4));
396 dev_err(&info->pdev->dev, "%s: invalid state %d\n", __func__,
403 static void start_data_dma(struct pxa3xx_nand_info *info)
405 struct pxa_dma_desc *desc = info->data_desc;
406 int dma_len = ALIGN(info->data_size + info->oob_size, 32);
408 desc->ddadr = DDADR_STOP;
409 desc->dcmd = DCMD_ENDIRQEN | DCMD_WIDTH4 | DCMD_BURST32 | dma_len;
411 switch (info->state) {
412 case STATE_DMA_WRITING:
413 desc->dsadr = info->data_buff_phys;
414 desc->dtadr = info->mmio_phys + NDDB;
415 desc->dcmd |= DCMD_INCSRCADDR | DCMD_FLOWTRG;
417 case STATE_DMA_READING:
418 desc->dtadr = info->data_buff_phys;
419 desc->dsadr = info->mmio_phys + NDDB;
420 desc->dcmd |= DCMD_INCTRGADDR | DCMD_FLOWSRC;
423 dev_err(&info->pdev->dev, "%s: invalid state %d\n", __func__,
428 DRCMR(info->drcmr_dat) = DRCMR_MAPVLD | info->data_dma_ch;
429 DDADR(info->data_dma_ch) = info->data_desc_addr;
430 DCSR(info->data_dma_ch) |= DCSR_RUN;
433 static void pxa3xx_nand_data_dma_irq(int channel, void *data)
435 struct pxa3xx_nand_info *info = data;
438 dcsr = DCSR(channel);
439 DCSR(channel) = dcsr;
441 if (dcsr & DCSR_BUSERR) {
442 info->retcode = ERR_DMABUSERR;
445 info->state = STATE_DMA_DONE;
446 enable_int(info, NDCR_INT_MASK);
447 nand_writel(info, NDSR, NDSR_WRDREQ | NDSR_RDDREQ);
450 static void start_data_dma(struct pxa3xx_nand_info *info)
454 static irqreturn_t pxa3xx_nand_irq(int irq, void *devid)
456 struct pxa3xx_nand_info *info = devid;
457 unsigned int status, is_completed = 0;
458 unsigned int ready, cmd_done;
461 ready = NDSR_FLASH_RDY;
462 cmd_done = NDSR_CS0_CMDD;
465 cmd_done = NDSR_CS1_CMDD;
468 status = nand_readl(info, NDSR);
470 if (status & NDSR_DBERR)
471 info->retcode = ERR_DBERR;
472 if (status & NDSR_SBERR)
473 info->retcode = ERR_SBERR;
474 if (status & (NDSR_RDDREQ | NDSR_WRDREQ)) {
475 /* whether use dma to transfer data */
477 disable_int(info, NDCR_INT_MASK);
478 info->state = (status & NDSR_RDDREQ) ?
479 STATE_DMA_READING : STATE_DMA_WRITING;
480 start_data_dma(info);
481 goto NORMAL_IRQ_EXIT;
483 info->state = (status & NDSR_RDDREQ) ?
484 STATE_PIO_READING : STATE_PIO_WRITING;
485 handle_data_pio(info);
488 if (status & cmd_done) {
489 info->state = STATE_CMD_DONE;
492 if (status & ready) {
494 info->state = STATE_READY;
497 if (status & NDSR_WRCMDREQ) {
498 nand_writel(info, NDSR, NDSR_WRCMDREQ);
499 status &= ~NDSR_WRCMDREQ;
500 info->state = STATE_CMD_HANDLE;
503 * Command buffer registers NDCB{0-2} (and optionally NDCB3)
504 * must be loaded by writing directly either 12 or 16
505 * bytes directly to NDCB0, four bytes at a time.
507 * Direct write access to NDCB1, NDCB2 and NDCB3 is ignored
508 * but each NDCBx register can be read.
510 nand_writel(info, NDCB0, info->ndcb0);
511 nand_writel(info, NDCB0, info->ndcb1);
512 nand_writel(info, NDCB0, info->ndcb2);
514 /* NDCB3 register is available in NFCv2 (Armada 370/XP SoC) */
515 if (info->variant == PXA3XX_NAND_VARIANT_ARMADA370)
516 nand_writel(info, NDCB0, info->ndcb3);
519 /* clear NDSR to let the controller exit the IRQ */
520 nand_writel(info, NDSR, status);
522 complete(&info->cmd_complete);
527 static inline int is_buf_blank(uint8_t *buf, size_t len)
529 for (; len > 0; len--)
535 static int prepare_command_pool(struct pxa3xx_nand_info *info, int command,
536 uint16_t column, int page_addr)
538 int addr_cycle, exec_cmd;
539 struct pxa3xx_nand_host *host;
540 struct mtd_info *mtd;
542 host = info->host[info->cs];
547 /* reset data and oob column point to handle data */
554 info->retcode = ERR_NONE;
556 info->ndcb0 = NDCB0_CSEL;
562 case NAND_CMD_PAGEPROG:
564 case NAND_CMD_READOOB:
565 pxa3xx_set_datasize(info);
580 addr_cycle = NDCB0_ADDR_CYC(host->row_addr_cycles
581 + host->col_addr_cycles);
584 case NAND_CMD_READOOB:
586 info->buf_start = column;
587 info->ndcb0 |= NDCB0_CMD_TYPE(0)
591 if (command == NAND_CMD_READOOB)
592 info->buf_start += mtd->writesize;
594 /* Second command setting for large pages */
595 if (host->page_size >= PAGE_CHUNK_SIZE)
596 info->ndcb0 |= NDCB0_DBC | (NAND_CMD_READSTART << 8);
599 /* small page addr setting */
600 if (unlikely(host->page_size < PAGE_CHUNK_SIZE)) {
601 info->ndcb1 = ((page_addr & 0xFFFFFF) << 8)
606 info->ndcb1 = ((page_addr & 0xFFFF) << 16)
609 if (page_addr & 0xFF0000)
610 info->ndcb2 = (page_addr & 0xFF0000) >> 16;
615 info->buf_count = mtd->writesize + mtd->oobsize;
616 memset(info->data_buff, 0xFF, info->buf_count);
620 case NAND_CMD_PAGEPROG:
621 if (is_buf_blank(info->data_buff,
622 (mtd->writesize + mtd->oobsize))) {
627 info->ndcb0 |= NDCB0_CMD_TYPE(0x1)
631 | (NAND_CMD_PAGEPROG << 8)
637 info->buf_count = 256;
638 info->ndcb0 |= NDCB0_CMD_TYPE(0)
642 info->ndcb1 = (column & 0xFF);
644 info->data_size = 256;
647 case NAND_CMD_READID:
648 info->buf_count = host->read_id_bytes;
649 info->ndcb0 |= NDCB0_CMD_TYPE(3)
652 info->ndcb1 = (column & 0xFF);
656 case NAND_CMD_STATUS:
658 info->ndcb0 |= NDCB0_CMD_TYPE(4)
665 case NAND_CMD_ERASE1:
666 info->ndcb0 |= NDCB0_CMD_TYPE(2)
670 | (NAND_CMD_ERASE2 << 8)
672 info->ndcb1 = page_addr;
677 info->ndcb0 |= NDCB0_CMD_TYPE(5)
682 case NAND_CMD_ERASE2:
688 dev_err(&info->pdev->dev, "non-supported command %x\n",
696 static void pxa3xx_nand_cmdfunc(struct mtd_info *mtd, unsigned command,
697 int column, int page_addr)
699 struct pxa3xx_nand_host *host = mtd->priv;
700 struct pxa3xx_nand_info *info = host->info_data;
704 * if this is a x16 device ,then convert the input
705 * "byte" address into a "word" address appropriate
706 * for indexing a word-oriented device
708 if (info->reg_ndcr & NDCR_DWIDTH_M)
712 * There may be different NAND chip hooked to
713 * different chip select, so check whether
714 * chip select has been changed, if yes, reset the timing
716 if (info->cs != host->cs) {
718 nand_writel(info, NDTR0CS0, info->ndtr0cs0);
719 nand_writel(info, NDTR1CS0, info->ndtr1cs0);
722 info->state = STATE_PREPARED;
723 exec_cmd = prepare_command_pool(info, command, column, page_addr);
725 init_completion(&info->cmd_complete);
726 pxa3xx_nand_start(info);
728 ret = wait_for_completion_timeout(&info->cmd_complete,
731 dev_err(&info->pdev->dev, "Wait time out!!!\n");
732 /* Stop State Machine for next command cycle */
733 pxa3xx_nand_stop(info);
736 info->state = STATE_IDLE;
739 static int pxa3xx_nand_write_page_hwecc(struct mtd_info *mtd,
740 struct nand_chip *chip, const uint8_t *buf, int oob_required)
742 chip->write_buf(mtd, buf, mtd->writesize);
743 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
748 static int pxa3xx_nand_read_page_hwecc(struct mtd_info *mtd,
749 struct nand_chip *chip, uint8_t *buf, int oob_required,
752 struct pxa3xx_nand_host *host = mtd->priv;
753 struct pxa3xx_nand_info *info = host->info_data;
755 chip->read_buf(mtd, buf, mtd->writesize);
756 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
758 if (info->retcode == ERR_SBERR) {
759 switch (info->use_ecc) {
761 mtd->ecc_stats.corrected++;
767 } else if (info->retcode == ERR_DBERR) {
769 * for blank page (all 0xff), HW will calculate its ECC as
770 * 0, which is different from the ECC information within
771 * OOB, ignore such double bit errors
773 if (is_buf_blank(buf, mtd->writesize))
774 info->retcode = ERR_NONE;
776 mtd->ecc_stats.failed++;
782 static uint8_t pxa3xx_nand_read_byte(struct mtd_info *mtd)
784 struct pxa3xx_nand_host *host = mtd->priv;
785 struct pxa3xx_nand_info *info = host->info_data;
788 if (info->buf_start < info->buf_count)
789 /* Has just send a new command? */
790 retval = info->data_buff[info->buf_start++];
795 static u16 pxa3xx_nand_read_word(struct mtd_info *mtd)
797 struct pxa3xx_nand_host *host = mtd->priv;
798 struct pxa3xx_nand_info *info = host->info_data;
801 if (!(info->buf_start & 0x01) && info->buf_start < info->buf_count) {
802 retval = *((u16 *)(info->data_buff+info->buf_start));
803 info->buf_start += 2;
808 static void pxa3xx_nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
810 struct pxa3xx_nand_host *host = mtd->priv;
811 struct pxa3xx_nand_info *info = host->info_data;
812 int real_len = min_t(size_t, len, info->buf_count - info->buf_start);
814 memcpy(buf, info->data_buff + info->buf_start, real_len);
815 info->buf_start += real_len;
818 static void pxa3xx_nand_write_buf(struct mtd_info *mtd,
819 const uint8_t *buf, int len)
821 struct pxa3xx_nand_host *host = mtd->priv;
822 struct pxa3xx_nand_info *info = host->info_data;
823 int real_len = min_t(size_t, len, info->buf_count - info->buf_start);
825 memcpy(info->data_buff + info->buf_start, buf, real_len);
826 info->buf_start += real_len;
829 static void pxa3xx_nand_select_chip(struct mtd_info *mtd, int chip)
834 static int pxa3xx_nand_waitfunc(struct mtd_info *mtd, struct nand_chip *this)
836 struct pxa3xx_nand_host *host = mtd->priv;
837 struct pxa3xx_nand_info *info = host->info_data;
839 /* pxa3xx_nand_send_command has waited for command complete */
840 if (this->state == FL_WRITING || this->state == FL_ERASING) {
841 if (info->retcode == ERR_NONE)
845 * any error make it return 0x01 which will tell
846 * the caller the erase and write fail
855 static int pxa3xx_nand_config_flash(struct pxa3xx_nand_info *info,
856 const struct pxa3xx_nand_flash *f)
858 struct platform_device *pdev = info->pdev;
859 struct pxa3xx_nand_platform_data *pdata = dev_get_platdata(&pdev->dev);
860 struct pxa3xx_nand_host *host = info->host[info->cs];
861 uint32_t ndcr = 0x0; /* enable all interrupts */
863 if (f->page_size != 2048 && f->page_size != 512) {
864 dev_err(&pdev->dev, "Current only support 2048 and 512 size\n");
868 if (f->flash_width != 16 && f->flash_width != 8) {
869 dev_err(&pdev->dev, "Only support 8bit and 16 bit!\n");
873 /* calculate flash information */
874 host->page_size = f->page_size;
875 host->read_id_bytes = (f->page_size == 2048) ? 4 : 2;
877 /* calculate addressing information */
878 host->col_addr_cycles = (f->page_size == 2048) ? 2 : 1;
880 if (f->num_blocks * f->page_per_block > 65536)
881 host->row_addr_cycles = 3;
883 host->row_addr_cycles = 2;
885 ndcr |= (pdata->enable_arbiter) ? NDCR_ND_ARB_EN : 0;
886 ndcr |= (host->col_addr_cycles == 2) ? NDCR_RA_START : 0;
887 ndcr |= (f->page_per_block == 64) ? NDCR_PG_PER_BLK : 0;
888 ndcr |= (f->page_size == 2048) ? NDCR_PAGE_SZ : 0;
889 ndcr |= (f->flash_width == 16) ? NDCR_DWIDTH_M : 0;
890 ndcr |= (f->dfc_width == 16) ? NDCR_DWIDTH_C : 0;
892 ndcr |= NDCR_RD_ID_CNT(host->read_id_bytes);
893 ndcr |= NDCR_SPARE_EN; /* enable spare by default */
895 info->reg_ndcr = ndcr;
897 pxa3xx_nand_set_timing(host, f->timing);
901 static int pxa3xx_nand_detect_config(struct pxa3xx_nand_info *info)
904 * We set 0 by hard coding here, for we don't support keep_config
905 * when there is more than one chip attached to the controller
907 struct pxa3xx_nand_host *host = info->host[0];
908 uint32_t ndcr = nand_readl(info, NDCR);
910 if (ndcr & NDCR_PAGE_SZ) {
911 host->page_size = 2048;
912 host->read_id_bytes = 4;
914 host->page_size = 512;
915 host->read_id_bytes = 2;
918 info->reg_ndcr = ndcr & ~NDCR_INT_MASK;
919 info->ndtr0cs0 = nand_readl(info, NDTR0CS0);
920 info->ndtr1cs0 = nand_readl(info, NDTR1CS0);
925 static int pxa3xx_nand_init_buff(struct pxa3xx_nand_info *info)
927 struct platform_device *pdev = info->pdev;
928 int data_desc_offset = info->buf_size - sizeof(struct pxa_dma_desc);
931 info->data_buff = kmalloc(info->buf_size, GFP_KERNEL);
932 if (info->data_buff == NULL)
937 info->data_buff = dma_alloc_coherent(&pdev->dev, info->buf_size,
938 &info->data_buff_phys, GFP_KERNEL);
939 if (info->data_buff == NULL) {
940 dev_err(&pdev->dev, "failed to allocate dma buffer\n");
944 info->data_desc = (void *)info->data_buff + data_desc_offset;
945 info->data_desc_addr = info->data_buff_phys + data_desc_offset;
947 info->data_dma_ch = pxa_request_dma("nand-data", DMA_PRIO_LOW,
948 pxa3xx_nand_data_dma_irq, info);
949 if (info->data_dma_ch < 0) {
950 dev_err(&pdev->dev, "failed to request data dma\n");
951 dma_free_coherent(&pdev->dev, info->buf_size,
952 info->data_buff, info->data_buff_phys);
953 return info->data_dma_ch;
957 * Now that DMA buffers are allocated we turn on
958 * DMA proper for I/O operations.
964 static void pxa3xx_nand_free_buff(struct pxa3xx_nand_info *info)
966 struct platform_device *pdev = info->pdev;
968 pxa_free_dma(info->data_dma_ch);
969 dma_free_coherent(&pdev->dev, info->buf_size,
970 info->data_buff, info->data_buff_phys);
972 kfree(info->data_buff);
976 static int pxa3xx_nand_init_buff(struct pxa3xx_nand_info *info)
978 info->data_buff = kmalloc(info->buf_size, GFP_KERNEL);
979 if (info->data_buff == NULL)
984 static void pxa3xx_nand_free_buff(struct pxa3xx_nand_info *info)
986 kfree(info->data_buff);
990 static int pxa3xx_nand_sensing(struct pxa3xx_nand_info *info)
992 struct mtd_info *mtd;
994 mtd = info->host[info->cs]->mtd;
995 /* use the common timing to make a try */
996 ret = pxa3xx_nand_config_flash(info, &builtin_flash_types[0]);
1000 pxa3xx_nand_cmdfunc(mtd, NAND_CMD_RESET, 0, 0);
1007 static int pxa3xx_nand_scan(struct mtd_info *mtd)
1009 struct pxa3xx_nand_host *host = mtd->priv;
1010 struct pxa3xx_nand_info *info = host->info_data;
1011 struct platform_device *pdev = info->pdev;
1012 struct pxa3xx_nand_platform_data *pdata = dev_get_platdata(&pdev->dev);
1013 struct nand_flash_dev pxa3xx_flash_ids[2], *def = NULL;
1014 const struct pxa3xx_nand_flash *f = NULL;
1015 struct nand_chip *chip = mtd->priv;
1020 if (pdata->keep_config && !pxa3xx_nand_detect_config(info))
1023 ret = pxa3xx_nand_sensing(info);
1025 dev_info(&info->pdev->dev, "There is no chip on cs %d!\n",
1031 chip->cmdfunc(mtd, NAND_CMD_READID, 0, 0);
1032 id = *((uint16_t *)(info->data_buff));
1034 dev_info(&info->pdev->dev, "Detect a flash id %x\n", id);
1036 dev_warn(&info->pdev->dev,
1037 "Read out ID 0, potential timing set wrong!!\n");
1042 num = ARRAY_SIZE(builtin_flash_types) + pdata->num_flash - 1;
1043 for (i = 0; i < num; i++) {
1044 if (i < pdata->num_flash)
1045 f = pdata->flash + i;
1047 f = &builtin_flash_types[i - pdata->num_flash + 1];
1049 /* find the chip in default list */
1050 if (f->chip_id == id)
1054 if (i >= (ARRAY_SIZE(builtin_flash_types) + pdata->num_flash - 1)) {
1055 dev_err(&info->pdev->dev, "ERROR!! flash not defined!!!\n");
1060 ret = pxa3xx_nand_config_flash(info, f);
1062 dev_err(&info->pdev->dev, "ERROR! Configure failed\n");
1066 pxa3xx_flash_ids[0].name = f->name;
1067 pxa3xx_flash_ids[0].dev_id = (f->chip_id >> 8) & 0xffff;
1068 pxa3xx_flash_ids[0].pagesize = f->page_size;
1069 chipsize = (uint64_t)f->num_blocks * f->page_per_block * f->page_size;
1070 pxa3xx_flash_ids[0].chipsize = chipsize >> 20;
1071 pxa3xx_flash_ids[0].erasesize = f->page_size * f->page_per_block;
1072 if (f->flash_width == 16)
1073 pxa3xx_flash_ids[0].options = NAND_BUSWIDTH_16;
1074 pxa3xx_flash_ids[1].name = NULL;
1075 def = pxa3xx_flash_ids;
1077 chip->ecc.mode = NAND_ECC_HW;
1078 chip->ecc.size = host->page_size;
1079 chip->ecc.strength = 1;
1081 if (info->reg_ndcr & NDCR_DWIDTH_M)
1082 chip->options |= NAND_BUSWIDTH_16;
1084 if (nand_scan_ident(mtd, 1, def))
1086 /* calculate addressing information */
1087 if (mtd->writesize >= 2048)
1088 host->col_addr_cycles = 2;
1090 host->col_addr_cycles = 1;
1092 /* release the initial buffer */
1093 kfree(info->data_buff);
1095 /* allocate the real data + oob buffer */
1096 info->buf_size = mtd->writesize + mtd->oobsize;
1097 ret = pxa3xx_nand_init_buff(info);
1100 info->oob_buff = info->data_buff + mtd->writesize;
1102 if ((mtd->size >> chip->page_shift) > 65536)
1103 host->row_addr_cycles = 3;
1105 host->row_addr_cycles = 2;
1106 return nand_scan_tail(mtd);
1109 static int alloc_nand_resource(struct platform_device *pdev)
1111 struct pxa3xx_nand_platform_data *pdata;
1112 struct pxa3xx_nand_info *info;
1113 struct pxa3xx_nand_host *host;
1114 struct nand_chip *chip = NULL;
1115 struct mtd_info *mtd;
1119 pdata = dev_get_platdata(&pdev->dev);
1120 info = devm_kzalloc(&pdev->dev, sizeof(*info) + (sizeof(*mtd) +
1121 sizeof(*host)) * pdata->num_cs, GFP_KERNEL);
1126 for (cs = 0; cs < pdata->num_cs; cs++) {
1127 mtd = (struct mtd_info *)((unsigned int)&info[1] +
1128 (sizeof(*mtd) + sizeof(*host)) * cs);
1129 chip = (struct nand_chip *)(&mtd[1]);
1130 host = (struct pxa3xx_nand_host *)chip;
1131 info->host[cs] = host;
1134 host->info_data = info;
1136 mtd->owner = THIS_MODULE;
1138 chip->ecc.read_page = pxa3xx_nand_read_page_hwecc;
1139 chip->ecc.write_page = pxa3xx_nand_write_page_hwecc;
1140 chip->controller = &info->controller;
1141 chip->waitfunc = pxa3xx_nand_waitfunc;
1142 chip->select_chip = pxa3xx_nand_select_chip;
1143 chip->cmdfunc = pxa3xx_nand_cmdfunc;
1144 chip->read_word = pxa3xx_nand_read_word;
1145 chip->read_byte = pxa3xx_nand_read_byte;
1146 chip->read_buf = pxa3xx_nand_read_buf;
1147 chip->write_buf = pxa3xx_nand_write_buf;
1150 spin_lock_init(&chip->controller->lock);
1151 init_waitqueue_head(&chip->controller->wq);
1152 info->clk = devm_clk_get(&pdev->dev, NULL);
1153 if (IS_ERR(info->clk)) {
1154 dev_err(&pdev->dev, "failed to get nand clock\n");
1155 return PTR_ERR(info->clk);
1157 ret = clk_prepare_enable(info->clk);
1163 * This is a dirty hack to make this driver work from
1164 * devicetree bindings. It can be removed once we have
1165 * a prober DMA controller framework for DT.
1167 if (pdev->dev.of_node &&
1168 of_machine_is_compatible("marvell,pxa3xx")) {
1169 info->drcmr_dat = 97;
1170 info->drcmr_cmd = 99;
1172 r = platform_get_resource(pdev, IORESOURCE_DMA, 0);
1175 "no resource defined for data DMA\n");
1177 goto fail_disable_clk;
1179 info->drcmr_dat = r->start;
1181 r = platform_get_resource(pdev, IORESOURCE_DMA, 1);
1184 "no resource defined for cmd DMA\n");
1186 goto fail_disable_clk;
1188 info->drcmr_cmd = r->start;
1192 irq = platform_get_irq(pdev, 0);
1194 dev_err(&pdev->dev, "no IRQ resource defined\n");
1196 goto fail_disable_clk;
1199 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1200 info->mmio_base = devm_ioremap_resource(&pdev->dev, r);
1201 if (IS_ERR(info->mmio_base)) {
1202 ret = PTR_ERR(info->mmio_base);
1203 goto fail_disable_clk;
1205 info->mmio_phys = r->start;
1207 /* Allocate a buffer to allow flash detection */
1208 info->buf_size = INIT_BUFFER_SIZE;
1209 info->data_buff = kmalloc(info->buf_size, GFP_KERNEL);
1210 if (info->data_buff == NULL) {
1212 goto fail_disable_clk;
1215 /* initialize all interrupts to be disabled */
1216 disable_int(info, NDSR_MASK);
1218 ret = request_irq(irq, pxa3xx_nand_irq, 0, pdev->name, info);
1220 dev_err(&pdev->dev, "failed to request IRQ\n");
1224 platform_set_drvdata(pdev, info);
1229 free_irq(irq, info);
1230 kfree(info->data_buff);
1232 clk_disable_unprepare(info->clk);
1236 static int pxa3xx_nand_remove(struct platform_device *pdev)
1238 struct pxa3xx_nand_info *info = platform_get_drvdata(pdev);
1239 struct pxa3xx_nand_platform_data *pdata;
1245 pdata = dev_get_platdata(&pdev->dev);
1247 irq = platform_get_irq(pdev, 0);
1249 free_irq(irq, info);
1250 pxa3xx_nand_free_buff(info);
1252 clk_disable_unprepare(info->clk);
1254 for (cs = 0; cs < pdata->num_cs; cs++)
1255 nand_release(info->host[cs]->mtd);
1259 static struct of_device_id pxa3xx_nand_dt_ids[] = {
1261 .compatible = "marvell,pxa3xx-nand",
1262 .data = (void *)PXA3XX_NAND_VARIANT_PXA,
1266 MODULE_DEVICE_TABLE(of, pxa3xx_nand_dt_ids);
1268 static enum pxa3xx_nand_variant
1269 pxa3xx_nand_get_variant(struct platform_device *pdev)
1271 const struct of_device_id *of_id =
1272 of_match_device(pxa3xx_nand_dt_ids, &pdev->dev);
1274 return PXA3XX_NAND_VARIANT_PXA;
1275 return (enum pxa3xx_nand_variant)of_id->data;
1278 static int pxa3xx_nand_probe_dt(struct platform_device *pdev)
1280 struct pxa3xx_nand_platform_data *pdata;
1281 struct device_node *np = pdev->dev.of_node;
1282 const struct of_device_id *of_id =
1283 of_match_device(pxa3xx_nand_dt_ids, &pdev->dev);
1288 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
1292 if (of_get_property(np, "marvell,nand-enable-arbiter", NULL))
1293 pdata->enable_arbiter = 1;
1294 if (of_get_property(np, "marvell,nand-keep-config", NULL))
1295 pdata->keep_config = 1;
1296 of_property_read_u32(np, "num-cs", &pdata->num_cs);
1298 pdev->dev.platform_data = pdata;
1303 static int pxa3xx_nand_probe(struct platform_device *pdev)
1305 struct pxa3xx_nand_platform_data *pdata;
1306 struct mtd_part_parser_data ppdata = {};
1307 struct pxa3xx_nand_info *info;
1308 int ret, cs, probe_success;
1310 #ifndef ARCH_HAS_DMA
1313 dev_warn(&pdev->dev,
1314 "This platform can't do DMA on this device\n");
1317 ret = pxa3xx_nand_probe_dt(pdev);
1321 pdata = dev_get_platdata(&pdev->dev);
1323 dev_err(&pdev->dev, "no platform data defined\n");
1327 ret = alloc_nand_resource(pdev);
1329 dev_err(&pdev->dev, "alloc nand resource failed\n");
1333 info = platform_get_drvdata(pdev);
1334 info->variant = pxa3xx_nand_get_variant(pdev);
1336 for (cs = 0; cs < pdata->num_cs; cs++) {
1337 struct mtd_info *mtd = info->host[cs]->mtd;
1340 * The mtd name matches the one used in 'mtdparts' kernel
1341 * parameter. This name cannot be changed or otherwise
1342 * user's mtd partitions configuration would get broken.
1344 mtd->name = "pxa3xx_nand-0";
1346 ret = pxa3xx_nand_scan(mtd);
1348 dev_warn(&pdev->dev, "failed to scan nand at cs %d\n",
1353 ppdata.of_node = pdev->dev.of_node;
1354 ret = mtd_device_parse_register(mtd, NULL,
1355 &ppdata, pdata->parts[cs],
1356 pdata->nr_parts[cs]);
1361 if (!probe_success) {
1362 pxa3xx_nand_remove(pdev);
1370 static int pxa3xx_nand_suspend(struct platform_device *pdev, pm_message_t state)
1372 struct pxa3xx_nand_info *info = platform_get_drvdata(pdev);
1373 struct pxa3xx_nand_platform_data *pdata;
1374 struct mtd_info *mtd;
1377 pdata = dev_get_platdata(&pdev->dev);
1379 dev_err(&pdev->dev, "driver busy, state = %d\n", info->state);
1383 for (cs = 0; cs < pdata->num_cs; cs++) {
1384 mtd = info->host[cs]->mtd;
1391 static int pxa3xx_nand_resume(struct platform_device *pdev)
1393 struct pxa3xx_nand_info *info = platform_get_drvdata(pdev);
1394 struct pxa3xx_nand_platform_data *pdata;
1395 struct mtd_info *mtd;
1398 pdata = dev_get_platdata(&pdev->dev);
1399 /* We don't want to handle interrupt without calling mtd routine */
1400 disable_int(info, NDCR_INT_MASK);
1403 * Directly set the chip select to a invalid value,
1404 * then the driver would reset the timing according
1405 * to current chip select at the beginning of cmdfunc
1410 * As the spec says, the NDSR would be updated to 0x1800 when
1411 * doing the nand_clk disable/enable.
1412 * To prevent it damaging state machine of the driver, clear
1413 * all status before resume
1415 nand_writel(info, NDSR, NDSR_MASK);
1416 for (cs = 0; cs < pdata->num_cs; cs++) {
1417 mtd = info->host[cs]->mtd;
1424 #define pxa3xx_nand_suspend NULL
1425 #define pxa3xx_nand_resume NULL
1428 static struct platform_driver pxa3xx_nand_driver = {
1430 .name = "pxa3xx-nand",
1431 .of_match_table = pxa3xx_nand_dt_ids,
1433 .probe = pxa3xx_nand_probe,
1434 .remove = pxa3xx_nand_remove,
1435 .suspend = pxa3xx_nand_suspend,
1436 .resume = pxa3xx_nand_resume,
1439 module_platform_driver(pxa3xx_nand_driver);
1441 MODULE_LICENSE("GPL");
1442 MODULE_DESCRIPTION("PXA3xx NAND controller driver");