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/dmaengine.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/dma/pxa-dma.h>
21 #include <linux/delay.h>
22 #include <linux/clk.h>
23 #include <linux/mtd/mtd.h>
24 #include <linux/mtd/nand.h>
25 #include <linux/mtd/partitions.h>
27 #include <linux/iopoll.h>
28 #include <linux/irq.h>
29 #include <linux/slab.h>
31 #include <linux/of_device.h>
32 #include <linux/platform_data/mtd-nand-pxa3xx.h>
34 #define CHIP_DELAY_TIMEOUT msecs_to_jiffies(200)
35 #define NAND_STOP_DELAY msecs_to_jiffies(40)
36 #define PAGE_CHUNK_SIZE (2048)
39 * Define a buffer size for the initial command that detects the flash device:
40 * STATUS, READID and PARAM.
41 * ONFI param page is 256 bytes, and there are three redundant copies
42 * to be read. JEDEC param page is 512 bytes, and there are also three
43 * redundant copies to be read.
44 * Hence this buffer should be at least 512 x 3. Let's pick 2048.
46 #define INIT_BUFFER_SIZE 2048
48 /* registers and bit definitions */
49 #define NDCR (0x00) /* Control register */
50 #define NDTR0CS0 (0x04) /* Timing Parameter 0 for CS0 */
51 #define NDTR1CS0 (0x0C) /* Timing Parameter 1 for CS0 */
52 #define NDSR (0x14) /* Status Register */
53 #define NDPCR (0x18) /* Page Count Register */
54 #define NDBDR0 (0x1C) /* Bad Block Register 0 */
55 #define NDBDR1 (0x20) /* Bad Block Register 1 */
56 #define NDECCCTRL (0x28) /* ECC control */
57 #define NDDB (0x40) /* Data Buffer */
58 #define NDCB0 (0x48) /* Command Buffer0 */
59 #define NDCB1 (0x4C) /* Command Buffer1 */
60 #define NDCB2 (0x50) /* Command Buffer2 */
62 #define NDCR_SPARE_EN (0x1 << 31)
63 #define NDCR_ECC_EN (0x1 << 30)
64 #define NDCR_DMA_EN (0x1 << 29)
65 #define NDCR_ND_RUN (0x1 << 28)
66 #define NDCR_DWIDTH_C (0x1 << 27)
67 #define NDCR_DWIDTH_M (0x1 << 26)
68 #define NDCR_PAGE_SZ (0x1 << 24)
69 #define NDCR_NCSX (0x1 << 23)
70 #define NDCR_ND_MODE (0x3 << 21)
71 #define NDCR_NAND_MODE (0x0)
72 #define NDCR_CLR_PG_CNT (0x1 << 20)
73 #define NFCV1_NDCR_ARB_CNTL (0x1 << 19)
74 #define NFCV2_NDCR_STOP_ON_UNCOR (0x1 << 19)
75 #define NDCR_RD_ID_CNT_MASK (0x7 << 16)
76 #define NDCR_RD_ID_CNT(x) (((x) << 16) & NDCR_RD_ID_CNT_MASK)
78 #define NDCR_RA_START (0x1 << 15)
79 #define NDCR_PG_PER_BLK (0x1 << 14)
80 #define NDCR_ND_ARB_EN (0x1 << 12)
81 #define NDCR_INT_MASK (0xFFF)
83 #define NDSR_MASK (0xfff)
84 #define NDSR_ERR_CNT_OFF (16)
85 #define NDSR_ERR_CNT_MASK (0x1f)
86 #define NDSR_ERR_CNT(sr) ((sr >> NDSR_ERR_CNT_OFF) & NDSR_ERR_CNT_MASK)
87 #define NDSR_RDY (0x1 << 12)
88 #define NDSR_FLASH_RDY (0x1 << 11)
89 #define NDSR_CS0_PAGED (0x1 << 10)
90 #define NDSR_CS1_PAGED (0x1 << 9)
91 #define NDSR_CS0_CMDD (0x1 << 8)
92 #define NDSR_CS1_CMDD (0x1 << 7)
93 #define NDSR_CS0_BBD (0x1 << 6)
94 #define NDSR_CS1_BBD (0x1 << 5)
95 #define NDSR_UNCORERR (0x1 << 4)
96 #define NDSR_CORERR (0x1 << 3)
97 #define NDSR_WRDREQ (0x1 << 2)
98 #define NDSR_RDDREQ (0x1 << 1)
99 #define NDSR_WRCMDREQ (0x1)
101 #define NDCB0_LEN_OVRD (0x1 << 28)
102 #define NDCB0_ST_ROW_EN (0x1 << 26)
103 #define NDCB0_AUTO_RS (0x1 << 25)
104 #define NDCB0_CSEL (0x1 << 24)
105 #define NDCB0_EXT_CMD_TYPE_MASK (0x7 << 29)
106 #define NDCB0_EXT_CMD_TYPE(x) (((x) << 29) & NDCB0_EXT_CMD_TYPE_MASK)
107 #define NDCB0_CMD_TYPE_MASK (0x7 << 21)
108 #define NDCB0_CMD_TYPE(x) (((x) << 21) & NDCB0_CMD_TYPE_MASK)
109 #define NDCB0_NC (0x1 << 20)
110 #define NDCB0_DBC (0x1 << 19)
111 #define NDCB0_ADDR_CYC_MASK (0x7 << 16)
112 #define NDCB0_ADDR_CYC(x) (((x) << 16) & NDCB0_ADDR_CYC_MASK)
113 #define NDCB0_CMD2_MASK (0xff << 8)
114 #define NDCB0_CMD1_MASK (0xff)
115 #define NDCB0_ADDR_CYC_SHIFT (16)
117 #define EXT_CMD_TYPE_DISPATCH 6 /* Command dispatch */
118 #define EXT_CMD_TYPE_NAKED_RW 5 /* Naked read or Naked write */
119 #define EXT_CMD_TYPE_READ 4 /* Read */
120 #define EXT_CMD_TYPE_DISP_WR 4 /* Command dispatch with write */
121 #define EXT_CMD_TYPE_FINAL 3 /* Final command */
122 #define EXT_CMD_TYPE_LAST_RW 1 /* Last naked read/write */
123 #define EXT_CMD_TYPE_MONO 0 /* Monolithic read/write */
126 * This should be large enough to read 'ONFI' and 'JEDEC'.
127 * Let's use 7 bytes, which is the maximum ID count supported
128 * by the controller (see NDCR_RD_ID_CNT_MASK).
130 #define READ_ID_BYTES 7
132 /* macros for registers read/write */
133 #define nand_writel(info, off, val) \
135 dev_vdbg(&info->pdev->dev, \
136 "%s():%d nand_writel(0x%x, 0x%04x)\n", \
137 __func__, __LINE__, (val), (off)); \
138 writel_relaxed((val), (info)->mmio_base + (off)); \
141 #define nand_readl(info, off) \
144 _v = readl_relaxed((info)->mmio_base + (off)); \
145 dev_vdbg(&info->pdev->dev, \
146 "%s():%d nand_readl(0x%04x) = 0x%x\n", \
147 __func__, __LINE__, (off), _v); \
151 /* error code and state */
174 enum pxa3xx_nand_variant
{
175 PXA3XX_NAND_VARIANT_PXA
,
176 PXA3XX_NAND_VARIANT_ARMADA370
,
179 struct pxa3xx_nand_host
{
180 struct nand_chip chip
;
183 /* page size of attached chip */
187 /* calculated from pxa3xx_nand_flash data */
188 unsigned int col_addr_cycles
;
189 unsigned int row_addr_cycles
;
192 struct pxa3xx_nand_info
{
193 struct nand_hw_control controller
;
194 struct platform_device
*pdev
;
197 void __iomem
*mmio_base
;
198 unsigned long mmio_phys
;
199 struct completion cmd_complete
, dev_ready
;
201 unsigned int buf_start
;
202 unsigned int buf_count
;
203 unsigned int buf_size
;
204 unsigned int data_buff_pos
;
205 unsigned int oob_buff_pos
;
207 /* DMA information */
208 struct scatterlist sg
;
209 enum dma_data_direction dma_dir
;
210 struct dma_chan
*dma_chan
;
211 dma_cookie_t dma_cookie
;
214 unsigned char *data_buff
;
215 unsigned char *oob_buff
;
216 dma_addr_t data_buff_phys
;
219 struct pxa3xx_nand_host
*host
[NUM_CHIP_SELECT
];
223 * This driver supports NFCv1 (as found in PXA SoC)
224 * and NFCv2 (as found in Armada 370/XP SoC).
226 enum pxa3xx_nand_variant variant
;
229 int use_ecc
; /* use HW ECC ? */
230 int ecc_bch
; /* using BCH ECC? */
231 int use_dma
; /* use DMA ? */
232 int use_spare
; /* use spare ? */
235 /* Amount of real data per full chunk */
236 unsigned int chunk_size
;
238 /* Amount of spare data per full chunk */
239 unsigned int spare_size
;
241 /* Number of full chunks (i.e chunk_size + spare_size) */
242 unsigned int nfullchunks
;
245 * Total number of chunks. If equal to nfullchunks, then there
246 * are only full chunks. Otherwise, there is one last chunk of
247 * size (last_chunk_size + last_spare_size)
249 unsigned int ntotalchunks
;
251 /* Amount of real data in the last chunk */
252 unsigned int last_chunk_size
;
254 /* Amount of spare data in the last chunk */
255 unsigned int last_spare_size
;
257 unsigned int ecc_size
;
258 unsigned int ecc_err_cnt
;
259 unsigned int max_bitflips
;
263 * Variables only valid during command
264 * execution. step_chunk_size and step_spare_size is the
265 * amount of real data and spare data in the current
266 * chunk. cur_chunk is the current chunk being
269 unsigned int step_chunk_size
;
270 unsigned int step_spare_size
;
271 unsigned int cur_chunk
;
273 /* cached register value */
278 /* generated NDCBx register values */
285 static bool use_dma
= 1;
286 module_param(use_dma
, bool, 0444);
287 MODULE_PARM_DESC(use_dma
, "enable DMA for data transferring to/from NAND HW");
289 struct pxa3xx_nand_timing
{
290 unsigned int tCH
; /* Enable signal hold time */
291 unsigned int tCS
; /* Enable signal setup time */
292 unsigned int tWH
; /* ND_nWE high duration */
293 unsigned int tWP
; /* ND_nWE pulse time */
294 unsigned int tRH
; /* ND_nRE high duration */
295 unsigned int tRP
; /* ND_nRE pulse width */
296 unsigned int tR
; /* ND_nWE high to ND_nRE low for read */
297 unsigned int tWHR
; /* ND_nWE high to ND_nRE low for status read */
298 unsigned int tAR
; /* ND_ALE low to ND_nRE low delay */
301 struct pxa3xx_nand_flash
{
303 unsigned int flash_width
; /* Width of Flash memory (DWIDTH_M) */
304 unsigned int dfc_width
; /* Width of flash controller(DWIDTH_C) */
305 struct pxa3xx_nand_timing
*timing
; /* NAND Flash timing */
308 static struct pxa3xx_nand_timing timing
[] = {
309 { 40, 80, 60, 100, 80, 100, 90000, 400, 40, },
310 { 10, 0, 20, 40, 30, 40, 11123, 110, 10, },
311 { 10, 25, 15, 25, 15, 30, 25000, 60, 10, },
312 { 10, 35, 15, 25, 15, 25, 25000, 60, 10, },
315 static struct pxa3xx_nand_flash builtin_flash_types
[] = {
316 { 0x46ec, 16, 16, &timing
[1] },
317 { 0xdaec, 8, 8, &timing
[1] },
318 { 0xd7ec, 8, 8, &timing
[1] },
319 { 0xa12c, 8, 8, &timing
[2] },
320 { 0xb12c, 16, 16, &timing
[2] },
321 { 0xdc2c, 8, 8, &timing
[2] },
322 { 0xcc2c, 16, 16, &timing
[2] },
323 { 0xba20, 16, 16, &timing
[3] },
326 static int pxa3xx_ooblayout_ecc(struct mtd_info
*mtd
, int section
,
327 struct mtd_oob_region
*oobregion
)
329 struct nand_chip
*chip
= mtd_to_nand(mtd
);
330 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
331 struct pxa3xx_nand_info
*info
= host
->info_data
;
332 int nchunks
= mtd
->writesize
/ info
->chunk_size
;
334 if (section
>= nchunks
)
337 oobregion
->offset
= ((info
->ecc_size
+ info
->spare_size
) * section
) +
339 oobregion
->length
= info
->ecc_size
;
344 static int pxa3xx_ooblayout_free(struct mtd_info
*mtd
, int section
,
345 struct mtd_oob_region
*oobregion
)
347 struct nand_chip
*chip
= mtd_to_nand(mtd
);
348 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
349 struct pxa3xx_nand_info
*info
= host
->info_data
;
350 int nchunks
= mtd
->writesize
/ info
->chunk_size
;
352 if (section
>= nchunks
)
355 if (!info
->spare_size
)
358 oobregion
->offset
= section
* (info
->ecc_size
+ info
->spare_size
);
359 oobregion
->length
= info
->spare_size
;
362 * Bootrom looks in bytes 0 & 5 for bad blocks for the
363 * 4KB page / 4bit BCH combination.
365 if (mtd
->writesize
== 4096 && info
->chunk_size
== 2048) {
366 oobregion
->offset
+= 6;
367 oobregion
->length
-= 6;
369 oobregion
->offset
+= 2;
370 oobregion
->length
-= 2;
377 static const struct mtd_ooblayout_ops pxa3xx_ooblayout_ops
= {
378 .ecc
= pxa3xx_ooblayout_ecc
,
379 .free
= pxa3xx_ooblayout_free
,
382 static u8 bbt_pattern
[] = {'M', 'V', 'B', 'b', 't', '0' };
383 static u8 bbt_mirror_pattern
[] = {'1', 't', 'b', 'B', 'V', 'M' };
385 static struct nand_bbt_descr bbt_main_descr
= {
386 .options
= NAND_BBT_LASTBLOCK
| NAND_BBT_CREATE
| NAND_BBT_WRITE
387 | NAND_BBT_2BIT
| NAND_BBT_VERSION
,
391 .maxblocks
= 8, /* Last 8 blocks in each chip */
392 .pattern
= bbt_pattern
395 static struct nand_bbt_descr bbt_mirror_descr
= {
396 .options
= NAND_BBT_LASTBLOCK
| NAND_BBT_CREATE
| NAND_BBT_WRITE
397 | NAND_BBT_2BIT
| NAND_BBT_VERSION
,
401 .maxblocks
= 8, /* Last 8 blocks in each chip */
402 .pattern
= bbt_mirror_pattern
405 #define NDTR0_tCH(c) (min((c), 7) << 19)
406 #define NDTR0_tCS(c) (min((c), 7) << 16)
407 #define NDTR0_tWH(c) (min((c), 7) << 11)
408 #define NDTR0_tWP(c) (min((c), 7) << 8)
409 #define NDTR0_tRH(c) (min((c), 7) << 3)
410 #define NDTR0_tRP(c) (min((c), 7) << 0)
412 #define NDTR1_tR(c) (min((c), 65535) << 16)
413 #define NDTR1_tWHR(c) (min((c), 15) << 4)
414 #define NDTR1_tAR(c) (min((c), 15) << 0)
416 /* convert nano-seconds to nand flash controller clock cycles */
417 #define ns2cycle(ns, clk) (int)((ns) * (clk / 1000000) / 1000)
419 static const struct of_device_id pxa3xx_nand_dt_ids
[] = {
421 .compatible
= "marvell,pxa3xx-nand",
422 .data
= (void *)PXA3XX_NAND_VARIANT_PXA
,
425 .compatible
= "marvell,armada370-nand",
426 .data
= (void *)PXA3XX_NAND_VARIANT_ARMADA370
,
430 MODULE_DEVICE_TABLE(of
, pxa3xx_nand_dt_ids
);
432 static enum pxa3xx_nand_variant
433 pxa3xx_nand_get_variant(struct platform_device
*pdev
)
435 const struct of_device_id
*of_id
=
436 of_match_device(pxa3xx_nand_dt_ids
, &pdev
->dev
);
438 return PXA3XX_NAND_VARIANT_PXA
;
439 return (enum pxa3xx_nand_variant
)of_id
->data
;
442 static void pxa3xx_nand_set_timing(struct pxa3xx_nand_host
*host
,
443 const struct pxa3xx_nand_timing
*t
)
445 struct pxa3xx_nand_info
*info
= host
->info_data
;
446 unsigned long nand_clk
= clk_get_rate(info
->clk
);
447 uint32_t ndtr0
, ndtr1
;
449 ndtr0
= NDTR0_tCH(ns2cycle(t
->tCH
, nand_clk
)) |
450 NDTR0_tCS(ns2cycle(t
->tCS
, nand_clk
)) |
451 NDTR0_tWH(ns2cycle(t
->tWH
, nand_clk
)) |
452 NDTR0_tWP(ns2cycle(t
->tWP
, nand_clk
)) |
453 NDTR0_tRH(ns2cycle(t
->tRH
, nand_clk
)) |
454 NDTR0_tRP(ns2cycle(t
->tRP
, nand_clk
));
456 ndtr1
= NDTR1_tR(ns2cycle(t
->tR
, nand_clk
)) |
457 NDTR1_tWHR(ns2cycle(t
->tWHR
, nand_clk
)) |
458 NDTR1_tAR(ns2cycle(t
->tAR
, nand_clk
));
460 info
->ndtr0cs0
= ndtr0
;
461 info
->ndtr1cs0
= ndtr1
;
462 nand_writel(info
, NDTR0CS0
, ndtr0
);
463 nand_writel(info
, NDTR1CS0
, ndtr1
);
466 static void pxa3xx_nand_set_sdr_timing(struct pxa3xx_nand_host
*host
,
467 const struct nand_sdr_timings
*t
)
469 struct pxa3xx_nand_info
*info
= host
->info_data
;
470 struct nand_chip
*chip
= &host
->chip
;
471 unsigned long nand_clk
= clk_get_rate(info
->clk
);
472 uint32_t ndtr0
, ndtr1
;
474 u32 tCH_min
= DIV_ROUND_UP(t
->tCH_min
, 1000);
475 u32 tCS_min
= DIV_ROUND_UP(t
->tCS_min
, 1000);
476 u32 tWH_min
= DIV_ROUND_UP(t
->tWH_min
, 1000);
477 u32 tWP_min
= DIV_ROUND_UP(t
->tWC_min
- t
->tWH_min
, 1000);
478 u32 tREH_min
= DIV_ROUND_UP(t
->tREH_min
, 1000);
479 u32 tRP_min
= DIV_ROUND_UP(t
->tRC_min
- t
->tREH_min
, 1000);
480 u32 tR
= chip
->chip_delay
* 1000;
481 u32 tWHR_min
= DIV_ROUND_UP(t
->tWHR_min
, 1000);
482 u32 tAR_min
= DIV_ROUND_UP(t
->tAR_min
, 1000);
484 /* fallback to a default value if tR = 0 */
488 ndtr0
= NDTR0_tCH(ns2cycle(tCH_min
, nand_clk
)) |
489 NDTR0_tCS(ns2cycle(tCS_min
, nand_clk
)) |
490 NDTR0_tWH(ns2cycle(tWH_min
, nand_clk
)) |
491 NDTR0_tWP(ns2cycle(tWP_min
, nand_clk
)) |
492 NDTR0_tRH(ns2cycle(tREH_min
, nand_clk
)) |
493 NDTR0_tRP(ns2cycle(tRP_min
, nand_clk
));
495 ndtr1
= NDTR1_tR(ns2cycle(tR
, nand_clk
)) |
496 NDTR1_tWHR(ns2cycle(tWHR_min
, nand_clk
)) |
497 NDTR1_tAR(ns2cycle(tAR_min
, nand_clk
));
499 info
->ndtr0cs0
= ndtr0
;
500 info
->ndtr1cs0
= ndtr1
;
501 nand_writel(info
, NDTR0CS0
, ndtr0
);
502 nand_writel(info
, NDTR1CS0
, ndtr1
);
505 static int pxa3xx_nand_init_timings_compat(struct pxa3xx_nand_host
*host
,
506 unsigned int *flash_width
,
507 unsigned int *dfc_width
)
509 struct nand_chip
*chip
= &host
->chip
;
510 struct pxa3xx_nand_info
*info
= host
->info_data
;
511 const struct pxa3xx_nand_flash
*f
= NULL
;
512 struct mtd_info
*mtd
= nand_to_mtd(&host
->chip
);
515 ntypes
= ARRAY_SIZE(builtin_flash_types
);
517 chip
->cmdfunc(mtd
, NAND_CMD_READID
, 0x00, -1);
519 id
= chip
->read_byte(mtd
);
520 id
|= chip
->read_byte(mtd
) << 0x8;
522 for (i
= 0; i
< ntypes
; i
++) {
523 f
= &builtin_flash_types
[i
];
525 if (f
->chip_id
== id
)
530 dev_err(&info
->pdev
->dev
, "Error: timings not found\n");
534 pxa3xx_nand_set_timing(host
, f
->timing
);
536 *flash_width
= f
->flash_width
;
537 *dfc_width
= f
->dfc_width
;
542 static int pxa3xx_nand_init_timings_onfi(struct pxa3xx_nand_host
*host
,
545 const struct nand_sdr_timings
*timings
;
547 mode
= fls(mode
) - 1;
551 timings
= onfi_async_timing_mode_to_sdr_timings(mode
);
553 return PTR_ERR(timings
);
555 pxa3xx_nand_set_sdr_timing(host
, timings
);
560 static int pxa3xx_nand_init(struct pxa3xx_nand_host
*host
)
562 struct nand_chip
*chip
= &host
->chip
;
563 struct pxa3xx_nand_info
*info
= host
->info_data
;
564 unsigned int flash_width
= 0, dfc_width
= 0;
567 mode
= onfi_get_async_timing_mode(chip
);
568 if (mode
== ONFI_TIMING_MODE_UNKNOWN
) {
569 err
= pxa3xx_nand_init_timings_compat(host
, &flash_width
,
574 if (flash_width
== 16) {
575 info
->reg_ndcr
|= NDCR_DWIDTH_M
;
576 chip
->options
|= NAND_BUSWIDTH_16
;
579 info
->reg_ndcr
|= (dfc_width
== 16) ? NDCR_DWIDTH_C
: 0;
581 err
= pxa3xx_nand_init_timings_onfi(host
, mode
);
590 * NOTE: it is a must to set ND_RUN firstly, then write
591 * command buffer, otherwise, it does not work.
592 * We enable all the interrupt at the same time, and
593 * let pxa3xx_nand_irq to handle all logic.
595 static void pxa3xx_nand_start(struct pxa3xx_nand_info
*info
)
599 ndcr
= info
->reg_ndcr
;
604 nand_writel(info
, NDECCCTRL
, 0x1);
606 ndcr
&= ~NDCR_ECC_EN
;
608 nand_writel(info
, NDECCCTRL
, 0x0);
614 ndcr
&= ~NDCR_DMA_EN
;
617 ndcr
|= NDCR_SPARE_EN
;
619 ndcr
&= ~NDCR_SPARE_EN
;
623 /* clear status bits and run */
624 nand_writel(info
, NDSR
, NDSR_MASK
);
625 nand_writel(info
, NDCR
, 0);
626 nand_writel(info
, NDCR
, ndcr
);
629 static void pxa3xx_nand_stop(struct pxa3xx_nand_info
*info
)
632 int timeout
= NAND_STOP_DELAY
;
634 /* wait RUN bit in NDCR become 0 */
635 ndcr
= nand_readl(info
, NDCR
);
636 while ((ndcr
& NDCR_ND_RUN
) && (timeout
-- > 0)) {
637 ndcr
= nand_readl(info
, NDCR
);
642 ndcr
&= ~NDCR_ND_RUN
;
643 nand_writel(info
, NDCR
, ndcr
);
646 dmaengine_terminate_all(info
->dma_chan
);
648 /* clear status bits */
649 nand_writel(info
, NDSR
, NDSR_MASK
);
652 static void __maybe_unused
653 enable_int(struct pxa3xx_nand_info
*info
, uint32_t int_mask
)
657 ndcr
= nand_readl(info
, NDCR
);
658 nand_writel(info
, NDCR
, ndcr
& ~int_mask
);
661 static void disable_int(struct pxa3xx_nand_info
*info
, uint32_t int_mask
)
665 ndcr
= nand_readl(info
, NDCR
);
666 nand_writel(info
, NDCR
, ndcr
| int_mask
);
669 static void drain_fifo(struct pxa3xx_nand_info
*info
, void *data
, int len
)
676 * According to the datasheet, when reading from NDDB
677 * with BCH enabled, after each 32 bytes reads, we
678 * have to make sure that the NDSR.RDDREQ bit is set.
680 * Drain the FIFO 8 32 bits reads at a time, and skip
681 * the polling on the last read.
684 ioread32_rep(info
->mmio_base
+ NDDB
, data
, 8);
686 ret
= readl_relaxed_poll_timeout(info
->mmio_base
+ NDSR
, val
,
687 val
& NDSR_RDDREQ
, 1000, 5000);
689 dev_err(&info
->pdev
->dev
,
690 "Timeout on RDDREQ while draining the FIFO\n");
699 ioread32_rep(info
->mmio_base
+ NDDB
, data
, len
);
702 static void handle_data_pio(struct pxa3xx_nand_info
*info
)
704 switch (info
->state
) {
705 case STATE_PIO_WRITING
:
706 if (info
->step_chunk_size
)
707 writesl(info
->mmio_base
+ NDDB
,
708 info
->data_buff
+ info
->data_buff_pos
,
709 DIV_ROUND_UP(info
->step_chunk_size
, 4));
711 if (info
->step_spare_size
)
712 writesl(info
->mmio_base
+ NDDB
,
713 info
->oob_buff
+ info
->oob_buff_pos
,
714 DIV_ROUND_UP(info
->step_spare_size
, 4));
716 case STATE_PIO_READING
:
717 if (info
->step_chunk_size
)
719 info
->data_buff
+ info
->data_buff_pos
,
720 DIV_ROUND_UP(info
->step_chunk_size
, 4));
722 if (info
->step_spare_size
)
724 info
->oob_buff
+ info
->oob_buff_pos
,
725 DIV_ROUND_UP(info
->step_spare_size
, 4));
728 dev_err(&info
->pdev
->dev
, "%s: invalid state %d\n", __func__
,
733 /* Update buffer pointers for multi-page read/write */
734 info
->data_buff_pos
+= info
->step_chunk_size
;
735 info
->oob_buff_pos
+= info
->step_spare_size
;
738 static void pxa3xx_nand_data_dma_irq(void *data
)
740 struct pxa3xx_nand_info
*info
= data
;
741 struct dma_tx_state state
;
742 enum dma_status status
;
744 status
= dmaengine_tx_status(info
->dma_chan
, info
->dma_cookie
, &state
);
745 if (likely(status
== DMA_COMPLETE
)) {
746 info
->state
= STATE_DMA_DONE
;
748 dev_err(&info
->pdev
->dev
, "DMA error on data channel\n");
749 info
->retcode
= ERR_DMABUSERR
;
751 dma_unmap_sg(info
->dma_chan
->device
->dev
, &info
->sg
, 1, info
->dma_dir
);
753 nand_writel(info
, NDSR
, NDSR_WRDREQ
| NDSR_RDDREQ
);
754 enable_int(info
, NDCR_INT_MASK
);
757 static void start_data_dma(struct pxa3xx_nand_info
*info
)
759 enum dma_transfer_direction direction
;
760 struct dma_async_tx_descriptor
*tx
;
762 switch (info
->state
) {
763 case STATE_DMA_WRITING
:
764 info
->dma_dir
= DMA_TO_DEVICE
;
765 direction
= DMA_MEM_TO_DEV
;
767 case STATE_DMA_READING
:
768 info
->dma_dir
= DMA_FROM_DEVICE
;
769 direction
= DMA_DEV_TO_MEM
;
772 dev_err(&info
->pdev
->dev
, "%s: invalid state %d\n", __func__
,
776 info
->sg
.length
= info
->chunk_size
;
778 info
->sg
.length
+= info
->spare_size
+ info
->ecc_size
;
779 dma_map_sg(info
->dma_chan
->device
->dev
, &info
->sg
, 1, info
->dma_dir
);
781 tx
= dmaengine_prep_slave_sg(info
->dma_chan
, &info
->sg
, 1, direction
,
784 dev_err(&info
->pdev
->dev
, "prep_slave_sg() failed\n");
787 tx
->callback
= pxa3xx_nand_data_dma_irq
;
788 tx
->callback_param
= info
;
789 info
->dma_cookie
= dmaengine_submit(tx
);
790 dma_async_issue_pending(info
->dma_chan
);
791 dev_dbg(&info
->pdev
->dev
, "%s(dir=%d cookie=%x size=%u)\n",
792 __func__
, direction
, info
->dma_cookie
, info
->sg
.length
);
795 static irqreturn_t
pxa3xx_nand_irq_thread(int irq
, void *data
)
797 struct pxa3xx_nand_info
*info
= data
;
799 handle_data_pio(info
);
801 info
->state
= STATE_CMD_DONE
;
802 nand_writel(info
, NDSR
, NDSR_WRDREQ
| NDSR_RDDREQ
);
807 static irqreturn_t
pxa3xx_nand_irq(int irq
, void *devid
)
809 struct pxa3xx_nand_info
*info
= devid
;
810 unsigned int status
, is_completed
= 0, is_ready
= 0;
811 unsigned int ready
, cmd_done
;
812 irqreturn_t ret
= IRQ_HANDLED
;
815 ready
= NDSR_FLASH_RDY
;
816 cmd_done
= NDSR_CS0_CMDD
;
819 cmd_done
= NDSR_CS1_CMDD
;
822 status
= nand_readl(info
, NDSR
);
824 if (status
& NDSR_UNCORERR
)
825 info
->retcode
= ERR_UNCORERR
;
826 if (status
& NDSR_CORERR
) {
827 info
->retcode
= ERR_CORERR
;
828 if (info
->variant
== PXA3XX_NAND_VARIANT_ARMADA370
&&
830 info
->ecc_err_cnt
= NDSR_ERR_CNT(status
);
832 info
->ecc_err_cnt
= 1;
835 * Each chunk composing a page is corrected independently,
836 * and we need to store maximum number of corrected bitflips
837 * to return it to the MTD layer in ecc.read_page().
839 info
->max_bitflips
= max_t(unsigned int,
843 if (status
& (NDSR_RDDREQ
| NDSR_WRDREQ
)) {
844 /* whether use dma to transfer data */
846 disable_int(info
, NDCR_INT_MASK
);
847 info
->state
= (status
& NDSR_RDDREQ
) ?
848 STATE_DMA_READING
: STATE_DMA_WRITING
;
849 start_data_dma(info
);
850 goto NORMAL_IRQ_EXIT
;
852 info
->state
= (status
& NDSR_RDDREQ
) ?
853 STATE_PIO_READING
: STATE_PIO_WRITING
;
854 ret
= IRQ_WAKE_THREAD
;
855 goto NORMAL_IRQ_EXIT
;
858 if (status
& cmd_done
) {
859 info
->state
= STATE_CMD_DONE
;
862 if (status
& ready
) {
863 info
->state
= STATE_READY
;
868 * Clear all status bit before issuing the next command, which
869 * can and will alter the status bits and will deserve a new
870 * interrupt on its own. This lets the controller exit the IRQ
872 nand_writel(info
, NDSR
, status
);
874 if (status
& NDSR_WRCMDREQ
) {
875 status
&= ~NDSR_WRCMDREQ
;
876 info
->state
= STATE_CMD_HANDLE
;
879 * Command buffer registers NDCB{0-2} (and optionally NDCB3)
880 * must be loaded by writing directly either 12 or 16
881 * bytes directly to NDCB0, four bytes at a time.
883 * Direct write access to NDCB1, NDCB2 and NDCB3 is ignored
884 * but each NDCBx register can be read.
886 nand_writel(info
, NDCB0
, info
->ndcb0
);
887 nand_writel(info
, NDCB0
, info
->ndcb1
);
888 nand_writel(info
, NDCB0
, info
->ndcb2
);
890 /* NDCB3 register is available in NFCv2 (Armada 370/XP SoC) */
891 if (info
->variant
== PXA3XX_NAND_VARIANT_ARMADA370
)
892 nand_writel(info
, NDCB0
, info
->ndcb3
);
896 complete(&info
->cmd_complete
);
898 complete(&info
->dev_ready
);
903 static inline int is_buf_blank(uint8_t *buf
, size_t len
)
905 for (; len
> 0; len
--)
911 static void set_command_address(struct pxa3xx_nand_info
*info
,
912 unsigned int page_size
, uint16_t column
, int page_addr
)
914 /* small page addr setting */
915 if (page_size
< PAGE_CHUNK_SIZE
) {
916 info
->ndcb1
= ((page_addr
& 0xFFFFFF) << 8)
921 info
->ndcb1
= ((page_addr
& 0xFFFF) << 16)
924 if (page_addr
& 0xFF0000)
925 info
->ndcb2
= (page_addr
& 0xFF0000) >> 16;
931 static void prepare_start_command(struct pxa3xx_nand_info
*info
, int command
)
933 struct pxa3xx_nand_host
*host
= info
->host
[info
->cs
];
934 struct mtd_info
*mtd
= nand_to_mtd(&host
->chip
);
936 /* reset data and oob column point to handle data */
939 info
->data_buff_pos
= 0;
940 info
->oob_buff_pos
= 0;
941 info
->step_chunk_size
= 0;
942 info
->step_spare_size
= 0;
946 info
->retcode
= ERR_NONE
;
947 info
->ecc_err_cnt
= 0;
953 case NAND_CMD_PAGEPROG
:
966 * If we are about to issue a read command, or about to set
967 * the write address, then clean the data buffer.
969 if (command
== NAND_CMD_READ0
||
970 command
== NAND_CMD_READOOB
||
971 command
== NAND_CMD_SEQIN
) {
973 info
->buf_count
= mtd
->writesize
+ mtd
->oobsize
;
974 memset(info
->data_buff
, 0xFF, info
->buf_count
);
979 static int prepare_set_command(struct pxa3xx_nand_info
*info
, int command
,
980 int ext_cmd_type
, uint16_t column
, int page_addr
)
982 int addr_cycle
, exec_cmd
;
983 struct pxa3xx_nand_host
*host
;
984 struct mtd_info
*mtd
;
986 host
= info
->host
[info
->cs
];
987 mtd
= nand_to_mtd(&host
->chip
);
992 info
->ndcb0
= NDCB0_CSEL
;
996 if (command
== NAND_CMD_SEQIN
)
999 addr_cycle
= NDCB0_ADDR_CYC(host
->row_addr_cycles
1000 + host
->col_addr_cycles
);
1003 case NAND_CMD_READOOB
:
1004 case NAND_CMD_READ0
:
1005 info
->buf_start
= column
;
1006 info
->ndcb0
|= NDCB0_CMD_TYPE(0)
1010 if (command
== NAND_CMD_READOOB
)
1011 info
->buf_start
+= mtd
->writesize
;
1013 if (info
->cur_chunk
< info
->nfullchunks
) {
1014 info
->step_chunk_size
= info
->chunk_size
;
1015 info
->step_spare_size
= info
->spare_size
;
1017 info
->step_chunk_size
= info
->last_chunk_size
;
1018 info
->step_spare_size
= info
->last_spare_size
;
1022 * Multiple page read needs an 'extended command type' field,
1023 * which is either naked-read or last-read according to the
1026 if (mtd
->writesize
== PAGE_CHUNK_SIZE
) {
1027 info
->ndcb0
|= NDCB0_DBC
| (NAND_CMD_READSTART
<< 8);
1028 } else if (mtd
->writesize
> PAGE_CHUNK_SIZE
) {
1029 info
->ndcb0
|= NDCB0_DBC
| (NAND_CMD_READSTART
<< 8)
1031 | NDCB0_EXT_CMD_TYPE(ext_cmd_type
);
1032 info
->ndcb3
= info
->step_chunk_size
+
1033 info
->step_spare_size
;
1036 set_command_address(info
, mtd
->writesize
, column
, page_addr
);
1039 case NAND_CMD_SEQIN
:
1041 info
->buf_start
= column
;
1042 set_command_address(info
, mtd
->writesize
, 0, page_addr
);
1045 * Multiple page programming needs to execute the initial
1046 * SEQIN command that sets the page address.
1048 if (mtd
->writesize
> PAGE_CHUNK_SIZE
) {
1049 info
->ndcb0
|= NDCB0_CMD_TYPE(0x1)
1050 | NDCB0_EXT_CMD_TYPE(ext_cmd_type
)
1057 case NAND_CMD_PAGEPROG
:
1058 if (is_buf_blank(info
->data_buff
,
1059 (mtd
->writesize
+ mtd
->oobsize
))) {
1064 if (info
->cur_chunk
< info
->nfullchunks
) {
1065 info
->step_chunk_size
= info
->chunk_size
;
1066 info
->step_spare_size
= info
->spare_size
;
1068 info
->step_chunk_size
= info
->last_chunk_size
;
1069 info
->step_spare_size
= info
->last_spare_size
;
1072 /* Second command setting for large pages */
1073 if (mtd
->writesize
> PAGE_CHUNK_SIZE
) {
1075 * Multiple page write uses the 'extended command'
1076 * field. This can be used to issue a command dispatch
1077 * or a naked-write depending on the current stage.
1079 info
->ndcb0
|= NDCB0_CMD_TYPE(0x1)
1081 | NDCB0_EXT_CMD_TYPE(ext_cmd_type
);
1082 info
->ndcb3
= info
->step_chunk_size
+
1083 info
->step_spare_size
;
1086 * This is the command dispatch that completes a chunked
1087 * page program operation.
1089 if (info
->cur_chunk
== info
->ntotalchunks
) {
1090 info
->ndcb0
= NDCB0_CMD_TYPE(0x1)
1091 | NDCB0_EXT_CMD_TYPE(ext_cmd_type
)
1098 info
->ndcb0
|= NDCB0_CMD_TYPE(0x1)
1102 | (NAND_CMD_PAGEPROG
<< 8)
1108 case NAND_CMD_PARAM
:
1109 info
->buf_count
= INIT_BUFFER_SIZE
;
1110 info
->ndcb0
|= NDCB0_CMD_TYPE(0)
1114 info
->ndcb1
= (column
& 0xFF);
1115 info
->ndcb3
= INIT_BUFFER_SIZE
;
1116 info
->step_chunk_size
= INIT_BUFFER_SIZE
;
1119 case NAND_CMD_READID
:
1120 info
->buf_count
= READ_ID_BYTES
;
1121 info
->ndcb0
|= NDCB0_CMD_TYPE(3)
1124 info
->ndcb1
= (column
& 0xFF);
1126 info
->step_chunk_size
= 8;
1128 case NAND_CMD_STATUS
:
1129 info
->buf_count
= 1;
1130 info
->ndcb0
|= NDCB0_CMD_TYPE(4)
1134 info
->step_chunk_size
= 8;
1137 case NAND_CMD_ERASE1
:
1138 info
->ndcb0
|= NDCB0_CMD_TYPE(2)
1142 | (NAND_CMD_ERASE2
<< 8)
1144 info
->ndcb1
= page_addr
;
1148 case NAND_CMD_RESET
:
1149 info
->ndcb0
|= NDCB0_CMD_TYPE(5)
1154 case NAND_CMD_ERASE2
:
1160 dev_err(&info
->pdev
->dev
, "non-supported command %x\n",
1168 static void nand_cmdfunc(struct mtd_info
*mtd
, unsigned command
,
1169 int column
, int page_addr
)
1171 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1172 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1173 struct pxa3xx_nand_info
*info
= host
->info_data
;
1177 * if this is a x16 device ,then convert the input
1178 * "byte" address into a "word" address appropriate
1179 * for indexing a word-oriented device
1181 if (info
->reg_ndcr
& NDCR_DWIDTH_M
)
1185 * There may be different NAND chip hooked to
1186 * different chip select, so check whether
1187 * chip select has been changed, if yes, reset the timing
1189 if (info
->cs
!= host
->cs
) {
1190 info
->cs
= host
->cs
;
1191 nand_writel(info
, NDTR0CS0
, info
->ndtr0cs0
);
1192 nand_writel(info
, NDTR1CS0
, info
->ndtr1cs0
);
1195 prepare_start_command(info
, command
);
1197 info
->state
= STATE_PREPARED
;
1198 exec_cmd
= prepare_set_command(info
, command
, 0, column
, page_addr
);
1201 init_completion(&info
->cmd_complete
);
1202 init_completion(&info
->dev_ready
);
1203 info
->need_wait
= 1;
1204 pxa3xx_nand_start(info
);
1206 if (!wait_for_completion_timeout(&info
->cmd_complete
,
1207 CHIP_DELAY_TIMEOUT
)) {
1208 dev_err(&info
->pdev
->dev
, "Wait time out!!!\n");
1209 /* Stop State Machine for next command cycle */
1210 pxa3xx_nand_stop(info
);
1213 info
->state
= STATE_IDLE
;
1216 static void nand_cmdfunc_extended(struct mtd_info
*mtd
,
1217 const unsigned command
,
1218 int column
, int page_addr
)
1220 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1221 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1222 struct pxa3xx_nand_info
*info
= host
->info_data
;
1223 int exec_cmd
, ext_cmd_type
;
1226 * if this is a x16 device then convert the input
1227 * "byte" address into a "word" address appropriate
1228 * for indexing a word-oriented device
1230 if (info
->reg_ndcr
& NDCR_DWIDTH_M
)
1234 * There may be different NAND chip hooked to
1235 * different chip select, so check whether
1236 * chip select has been changed, if yes, reset the timing
1238 if (info
->cs
!= host
->cs
) {
1239 info
->cs
= host
->cs
;
1240 nand_writel(info
, NDTR0CS0
, info
->ndtr0cs0
);
1241 nand_writel(info
, NDTR1CS0
, info
->ndtr1cs0
);
1244 /* Select the extended command for the first command */
1246 case NAND_CMD_READ0
:
1247 case NAND_CMD_READOOB
:
1248 ext_cmd_type
= EXT_CMD_TYPE_MONO
;
1250 case NAND_CMD_SEQIN
:
1251 ext_cmd_type
= EXT_CMD_TYPE_DISPATCH
;
1253 case NAND_CMD_PAGEPROG
:
1254 ext_cmd_type
= EXT_CMD_TYPE_NAKED_RW
;
1261 prepare_start_command(info
, command
);
1264 * Prepare the "is ready" completion before starting a command
1265 * transaction sequence. If the command is not executed the
1266 * completion will be completed, see below.
1268 * We can do that inside the loop because the command variable
1269 * is invariant and thus so is the exec_cmd.
1271 info
->need_wait
= 1;
1272 init_completion(&info
->dev_ready
);
1274 info
->state
= STATE_PREPARED
;
1276 exec_cmd
= prepare_set_command(info
, command
, ext_cmd_type
,
1279 info
->need_wait
= 0;
1280 complete(&info
->dev_ready
);
1284 init_completion(&info
->cmd_complete
);
1285 pxa3xx_nand_start(info
);
1287 if (!wait_for_completion_timeout(&info
->cmd_complete
,
1288 CHIP_DELAY_TIMEOUT
)) {
1289 dev_err(&info
->pdev
->dev
, "Wait time out!!!\n");
1290 /* Stop State Machine for next command cycle */
1291 pxa3xx_nand_stop(info
);
1295 /* Only a few commands need several steps */
1296 if (command
!= NAND_CMD_PAGEPROG
&&
1297 command
!= NAND_CMD_READ0
&&
1298 command
!= NAND_CMD_READOOB
)
1303 /* Check if the sequence is complete */
1304 if (info
->cur_chunk
== info
->ntotalchunks
&& command
!= NAND_CMD_PAGEPROG
)
1308 * After a splitted program command sequence has issued
1309 * the command dispatch, the command sequence is complete.
1311 if (info
->cur_chunk
== (info
->ntotalchunks
+ 1) &&
1312 command
== NAND_CMD_PAGEPROG
&&
1313 ext_cmd_type
== EXT_CMD_TYPE_DISPATCH
)
1316 if (command
== NAND_CMD_READ0
|| command
== NAND_CMD_READOOB
) {
1317 /* Last read: issue a 'last naked read' */
1318 if (info
->cur_chunk
== info
->ntotalchunks
- 1)
1319 ext_cmd_type
= EXT_CMD_TYPE_LAST_RW
;
1321 ext_cmd_type
= EXT_CMD_TYPE_NAKED_RW
;
1324 * If a splitted program command has no more data to transfer,
1325 * the command dispatch must be issued to complete.
1327 } else if (command
== NAND_CMD_PAGEPROG
&&
1328 info
->cur_chunk
== info
->ntotalchunks
) {
1329 ext_cmd_type
= EXT_CMD_TYPE_DISPATCH
;
1333 info
->state
= STATE_IDLE
;
1336 static int pxa3xx_nand_write_page_hwecc(struct mtd_info
*mtd
,
1337 struct nand_chip
*chip
, const uint8_t *buf
, int oob_required
,
1340 chip
->write_buf(mtd
, buf
, mtd
->writesize
);
1341 chip
->write_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
1346 static int pxa3xx_nand_read_page_hwecc(struct mtd_info
*mtd
,
1347 struct nand_chip
*chip
, uint8_t *buf
, int oob_required
,
1350 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1351 struct pxa3xx_nand_info
*info
= host
->info_data
;
1353 chip
->read_buf(mtd
, buf
, mtd
->writesize
);
1354 chip
->read_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
1356 if (info
->retcode
== ERR_CORERR
&& info
->use_ecc
) {
1357 mtd
->ecc_stats
.corrected
+= info
->ecc_err_cnt
;
1359 } else if (info
->retcode
== ERR_UNCORERR
) {
1361 * for blank page (all 0xff), HW will calculate its ECC as
1362 * 0, which is different from the ECC information within
1363 * OOB, ignore such uncorrectable errors
1365 if (is_buf_blank(buf
, mtd
->writesize
))
1366 info
->retcode
= ERR_NONE
;
1368 mtd
->ecc_stats
.failed
++;
1371 return info
->max_bitflips
;
1374 static uint8_t pxa3xx_nand_read_byte(struct mtd_info
*mtd
)
1376 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1377 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1378 struct pxa3xx_nand_info
*info
= host
->info_data
;
1381 if (info
->buf_start
< info
->buf_count
)
1382 /* Has just send a new command? */
1383 retval
= info
->data_buff
[info
->buf_start
++];
1388 static u16
pxa3xx_nand_read_word(struct mtd_info
*mtd
)
1390 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1391 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1392 struct pxa3xx_nand_info
*info
= host
->info_data
;
1393 u16 retval
= 0xFFFF;
1395 if (!(info
->buf_start
& 0x01) && info
->buf_start
< info
->buf_count
) {
1396 retval
= *((u16
*)(info
->data_buff
+info
->buf_start
));
1397 info
->buf_start
+= 2;
1402 static void pxa3xx_nand_read_buf(struct mtd_info
*mtd
, uint8_t *buf
, int len
)
1404 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1405 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1406 struct pxa3xx_nand_info
*info
= host
->info_data
;
1407 int real_len
= min_t(size_t, len
, info
->buf_count
- info
->buf_start
);
1409 memcpy(buf
, info
->data_buff
+ info
->buf_start
, real_len
);
1410 info
->buf_start
+= real_len
;
1413 static void pxa3xx_nand_write_buf(struct mtd_info
*mtd
,
1414 const uint8_t *buf
, int len
)
1416 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1417 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1418 struct pxa3xx_nand_info
*info
= host
->info_data
;
1419 int real_len
= min_t(size_t, len
, info
->buf_count
- info
->buf_start
);
1421 memcpy(info
->data_buff
+ info
->buf_start
, buf
, real_len
);
1422 info
->buf_start
+= real_len
;
1425 static void pxa3xx_nand_select_chip(struct mtd_info
*mtd
, int chip
)
1430 static int pxa3xx_nand_waitfunc(struct mtd_info
*mtd
, struct nand_chip
*this)
1432 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1433 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1434 struct pxa3xx_nand_info
*info
= host
->info_data
;
1436 if (info
->need_wait
) {
1437 info
->need_wait
= 0;
1438 if (!wait_for_completion_timeout(&info
->dev_ready
,
1439 CHIP_DELAY_TIMEOUT
)) {
1440 dev_err(&info
->pdev
->dev
, "Ready time out!!!\n");
1441 return NAND_STATUS_FAIL
;
1445 /* pxa3xx_nand_send_command has waited for command complete */
1446 if (this->state
== FL_WRITING
|| this->state
== FL_ERASING
) {
1447 if (info
->retcode
== ERR_NONE
)
1450 return NAND_STATUS_FAIL
;
1453 return NAND_STATUS_READY
;
1456 static int pxa3xx_nand_config_ident(struct pxa3xx_nand_info
*info
)
1458 struct pxa3xx_nand_host
*host
= info
->host
[info
->cs
];
1459 struct platform_device
*pdev
= info
->pdev
;
1460 struct pxa3xx_nand_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
1461 const struct nand_sdr_timings
*timings
;
1463 /* Configure default flash values */
1464 info
->chunk_size
= PAGE_CHUNK_SIZE
;
1465 info
->reg_ndcr
= 0x0; /* enable all interrupts */
1466 info
->reg_ndcr
|= (pdata
->enable_arbiter
) ? NDCR_ND_ARB_EN
: 0;
1467 info
->reg_ndcr
|= NDCR_RD_ID_CNT(READ_ID_BYTES
);
1468 info
->reg_ndcr
|= NDCR_SPARE_EN
;
1470 /* use the common timing to make a try */
1471 timings
= onfi_async_timing_mode_to_sdr_timings(0);
1472 if (IS_ERR(timings
))
1473 return PTR_ERR(timings
);
1475 pxa3xx_nand_set_sdr_timing(host
, timings
);
1479 static void pxa3xx_nand_config_tail(struct pxa3xx_nand_info
*info
)
1481 struct pxa3xx_nand_host
*host
= info
->host
[info
->cs
];
1482 struct nand_chip
*chip
= &host
->chip
;
1483 struct mtd_info
*mtd
= nand_to_mtd(chip
);
1485 info
->reg_ndcr
|= (host
->col_addr_cycles
== 2) ? NDCR_RA_START
: 0;
1486 info
->reg_ndcr
|= (chip
->page_shift
== 6) ? NDCR_PG_PER_BLK
: 0;
1487 info
->reg_ndcr
|= (mtd
->writesize
== 2048) ? NDCR_PAGE_SZ
: 0;
1490 static void pxa3xx_nand_detect_config(struct pxa3xx_nand_info
*info
)
1492 struct platform_device
*pdev
= info
->pdev
;
1493 struct pxa3xx_nand_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
1494 uint32_t ndcr
= nand_readl(info
, NDCR
);
1496 /* Set an initial chunk size */
1497 info
->chunk_size
= ndcr
& NDCR_PAGE_SZ
? 2048 : 512;
1498 info
->reg_ndcr
= ndcr
&
1499 ~(NDCR_INT_MASK
| NDCR_ND_ARB_EN
| NFCV1_NDCR_ARB_CNTL
);
1500 info
->reg_ndcr
|= (pdata
->enable_arbiter
) ? NDCR_ND_ARB_EN
: 0;
1501 info
->ndtr0cs0
= nand_readl(info
, NDTR0CS0
);
1502 info
->ndtr1cs0
= nand_readl(info
, NDTR1CS0
);
1505 static int pxa3xx_nand_init_buff(struct pxa3xx_nand_info
*info
)
1507 struct platform_device
*pdev
= info
->pdev
;
1508 struct dma_slave_config config
;
1509 dma_cap_mask_t mask
;
1510 struct pxad_param param
;
1513 info
->data_buff
= kmalloc(info
->buf_size
, GFP_KERNEL
);
1514 if (info
->data_buff
== NULL
)
1519 ret
= dma_set_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
1523 sg_init_one(&info
->sg
, info
->data_buff
, info
->buf_size
);
1525 dma_cap_set(DMA_SLAVE
, mask
);
1526 param
.prio
= PXAD_PRIO_LOWEST
;
1527 param
.drcmr
= info
->drcmr_dat
;
1528 info
->dma_chan
= dma_request_slave_channel_compat(mask
, pxad_filter_fn
,
1531 if (!info
->dma_chan
) {
1532 dev_err(&pdev
->dev
, "unable to request data dma channel\n");
1536 memset(&config
, 0, sizeof(config
));
1537 config
.src_addr_width
= DMA_SLAVE_BUSWIDTH_4_BYTES
;
1538 config
.dst_addr_width
= DMA_SLAVE_BUSWIDTH_4_BYTES
;
1539 config
.src_addr
= info
->mmio_phys
+ NDDB
;
1540 config
.dst_addr
= info
->mmio_phys
+ NDDB
;
1541 config
.src_maxburst
= 32;
1542 config
.dst_maxburst
= 32;
1543 ret
= dmaengine_slave_config(info
->dma_chan
, &config
);
1545 dev_err(&info
->pdev
->dev
,
1546 "dma channel configuration failed: %d\n",
1552 * Now that DMA buffers are allocated we turn on
1553 * DMA proper for I/O operations.
1559 static void pxa3xx_nand_free_buff(struct pxa3xx_nand_info
*info
)
1561 if (info
->use_dma
) {
1562 dmaengine_terminate_all(info
->dma_chan
);
1563 dma_release_channel(info
->dma_chan
);
1565 kfree(info
->data_buff
);
1568 static int pxa_ecc_init(struct pxa3xx_nand_info
*info
,
1569 struct mtd_info
*mtd
,
1570 int strength
, int ecc_stepsize
, int page_size
)
1572 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1573 struct nand_ecc_ctrl
*ecc
= &chip
->ecc
;
1575 if (strength
== 1 && ecc_stepsize
== 512 && page_size
== 2048) {
1576 info
->nfullchunks
= 1;
1577 info
->ntotalchunks
= 1;
1578 info
->chunk_size
= 2048;
1579 info
->spare_size
= 40;
1580 info
->ecc_size
= 24;
1581 ecc
->mode
= NAND_ECC_HW
;
1585 } else if (strength
== 1 && ecc_stepsize
== 512 && page_size
== 512) {
1586 info
->nfullchunks
= 1;
1587 info
->ntotalchunks
= 1;
1588 info
->chunk_size
= 512;
1589 info
->spare_size
= 8;
1591 ecc
->mode
= NAND_ECC_HW
;
1596 * Required ECC: 4-bit correction per 512 bytes
1597 * Select: 16-bit correction per 2048 bytes
1599 } else if (strength
== 4 && ecc_stepsize
== 512 && page_size
== 2048) {
1601 info
->nfullchunks
= 1;
1602 info
->ntotalchunks
= 1;
1603 info
->chunk_size
= 2048;
1604 info
->spare_size
= 32;
1605 info
->ecc_size
= 32;
1606 ecc
->mode
= NAND_ECC_HW
;
1607 ecc
->size
= info
->chunk_size
;
1608 mtd_set_ooblayout(mtd
, &pxa3xx_ooblayout_ops
);
1611 } else if (strength
== 4 && ecc_stepsize
== 512 && page_size
== 4096) {
1613 info
->nfullchunks
= 2;
1614 info
->ntotalchunks
= 2;
1615 info
->chunk_size
= 2048;
1616 info
->spare_size
= 32;
1617 info
->ecc_size
= 32;
1618 ecc
->mode
= NAND_ECC_HW
;
1619 ecc
->size
= info
->chunk_size
;
1620 mtd_set_ooblayout(mtd
, &pxa3xx_ooblayout_ops
);
1624 * Required ECC: 8-bit correction per 512 bytes
1625 * Select: 16-bit correction per 1024 bytes
1627 } else if (strength
== 8 && ecc_stepsize
== 512 && page_size
== 4096) {
1629 info
->nfullchunks
= 4;
1630 info
->ntotalchunks
= 5;
1631 info
->chunk_size
= 1024;
1632 info
->spare_size
= 0;
1633 info
->last_chunk_size
= 0;
1634 info
->last_spare_size
= 64;
1635 info
->ecc_size
= 32;
1636 ecc
->mode
= NAND_ECC_HW
;
1637 ecc
->size
= info
->chunk_size
;
1638 mtd_set_ooblayout(mtd
, &pxa3xx_ooblayout_ops
);
1641 dev_err(&info
->pdev
->dev
,
1642 "ECC strength %d at page size %d is not supported\n",
1643 strength
, page_size
);
1647 dev_info(&info
->pdev
->dev
, "ECC strength %d, ECC step size %d\n",
1648 ecc
->strength
, ecc
->size
);
1652 static int pxa3xx_nand_scan(struct mtd_info
*mtd
)
1654 struct nand_chip
*chip
= mtd_to_nand(mtd
);
1655 struct pxa3xx_nand_host
*host
= nand_get_controller_data(chip
);
1656 struct pxa3xx_nand_info
*info
= host
->info_data
;
1657 struct platform_device
*pdev
= info
->pdev
;
1658 struct pxa3xx_nand_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
1660 uint16_t ecc_strength
, ecc_step
;
1662 if (pdata
->keep_config
) {
1663 pxa3xx_nand_detect_config(info
);
1665 ret
= pxa3xx_nand_config_ident(info
);
1670 if (info
->reg_ndcr
& NDCR_DWIDTH_M
)
1671 chip
->options
|= NAND_BUSWIDTH_16
;
1673 /* Device detection must be done with ECC disabled */
1674 if (info
->variant
== PXA3XX_NAND_VARIANT_ARMADA370
)
1675 nand_writel(info
, NDECCCTRL
, 0x0);
1677 if (pdata
->flash_bbt
)
1678 chip
->bbt_options
|= NAND_BBT_USE_FLASH
;
1680 chip
->ecc
.strength
= pdata
->ecc_strength
;
1681 chip
->ecc
.size
= pdata
->ecc_step_size
;
1683 if (nand_scan_ident(mtd
, 1, NULL
))
1686 if (!pdata
->keep_config
) {
1687 ret
= pxa3xx_nand_init(host
);
1689 dev_err(&info
->pdev
->dev
, "Failed to init nand: %d\n",
1695 if (chip
->bbt_options
& NAND_BBT_USE_FLASH
) {
1697 * We'll use a bad block table stored in-flash and don't
1698 * allow writing the bad block marker to the flash.
1700 chip
->bbt_options
|= NAND_BBT_NO_OOB_BBM
;
1701 chip
->bbt_td
= &bbt_main_descr
;
1702 chip
->bbt_md
= &bbt_mirror_descr
;
1706 * If the page size is bigger than the FIFO size, let's check
1707 * we are given the right variant and then switch to the extended
1708 * (aka splitted) command handling,
1710 if (mtd
->writesize
> PAGE_CHUNK_SIZE
) {
1711 if (info
->variant
== PXA3XX_NAND_VARIANT_ARMADA370
) {
1712 chip
->cmdfunc
= nand_cmdfunc_extended
;
1714 dev_err(&info
->pdev
->dev
,
1715 "unsupported page size on this variant\n");
1720 ecc_strength
= chip
->ecc
.strength
;
1721 ecc_step
= chip
->ecc
.size
;
1722 if (!ecc_strength
|| !ecc_step
) {
1723 ecc_strength
= chip
->ecc_strength_ds
;
1724 ecc_step
= chip
->ecc_step_ds
;
1727 /* Set default ECC strength requirements on non-ONFI devices */
1728 if (ecc_strength
< 1 && ecc_step
< 1) {
1733 ret
= pxa_ecc_init(info
, mtd
, ecc_strength
,
1734 ecc_step
, mtd
->writesize
);
1738 /* calculate addressing information */
1739 if (mtd
->writesize
>= 2048)
1740 host
->col_addr_cycles
= 2;
1742 host
->col_addr_cycles
= 1;
1744 /* release the initial buffer */
1745 kfree(info
->data_buff
);
1747 /* allocate the real data + oob buffer */
1748 info
->buf_size
= mtd
->writesize
+ mtd
->oobsize
;
1749 ret
= pxa3xx_nand_init_buff(info
);
1752 info
->oob_buff
= info
->data_buff
+ mtd
->writesize
;
1754 if ((mtd
->size
>> chip
->page_shift
) > 65536)
1755 host
->row_addr_cycles
= 3;
1757 host
->row_addr_cycles
= 2;
1759 if (!pdata
->keep_config
)
1760 pxa3xx_nand_config_tail(info
);
1762 return nand_scan_tail(mtd
);
1765 static int alloc_nand_resource(struct platform_device
*pdev
)
1767 struct device_node
*np
= pdev
->dev
.of_node
;
1768 struct pxa3xx_nand_platform_data
*pdata
;
1769 struct pxa3xx_nand_info
*info
;
1770 struct pxa3xx_nand_host
*host
;
1771 struct nand_chip
*chip
= NULL
;
1772 struct mtd_info
*mtd
;
1776 pdata
= dev_get_platdata(&pdev
->dev
);
1777 if (pdata
->num_cs
<= 0)
1779 info
= devm_kzalloc(&pdev
->dev
,
1780 sizeof(*info
) + sizeof(*host
) * pdata
->num_cs
,
1786 info
->variant
= pxa3xx_nand_get_variant(pdev
);
1787 for (cs
= 0; cs
< pdata
->num_cs
; cs
++) {
1788 host
= (void *)&info
[1] + sizeof(*host
) * cs
;
1790 nand_set_controller_data(chip
, host
);
1791 mtd
= nand_to_mtd(chip
);
1792 info
->host
[cs
] = host
;
1794 host
->info_data
= info
;
1795 mtd
->dev
.parent
= &pdev
->dev
;
1796 /* FIXME: all chips use the same device tree partitions */
1797 nand_set_flash_node(chip
, np
);
1799 nand_set_controller_data(chip
, host
);
1800 chip
->ecc
.read_page
= pxa3xx_nand_read_page_hwecc
;
1801 chip
->ecc
.write_page
= pxa3xx_nand_write_page_hwecc
;
1802 chip
->controller
= &info
->controller
;
1803 chip
->waitfunc
= pxa3xx_nand_waitfunc
;
1804 chip
->select_chip
= pxa3xx_nand_select_chip
;
1805 chip
->read_word
= pxa3xx_nand_read_word
;
1806 chip
->read_byte
= pxa3xx_nand_read_byte
;
1807 chip
->read_buf
= pxa3xx_nand_read_buf
;
1808 chip
->write_buf
= pxa3xx_nand_write_buf
;
1809 chip
->options
|= NAND_NO_SUBPAGE_WRITE
;
1810 chip
->cmdfunc
= nand_cmdfunc
;
1813 nand_hw_control_init(chip
->controller
);
1814 info
->clk
= devm_clk_get(&pdev
->dev
, NULL
);
1815 if (IS_ERR(info
->clk
)) {
1816 dev_err(&pdev
->dev
, "failed to get nand clock\n");
1817 return PTR_ERR(info
->clk
);
1819 ret
= clk_prepare_enable(info
->clk
);
1823 if (!np
&& use_dma
) {
1824 r
= platform_get_resource(pdev
, IORESOURCE_DMA
, 0);
1827 "no resource defined for data DMA\n");
1829 goto fail_disable_clk
;
1831 info
->drcmr_dat
= r
->start
;
1834 irq
= platform_get_irq(pdev
, 0);
1836 dev_err(&pdev
->dev
, "no IRQ resource defined\n");
1838 goto fail_disable_clk
;
1841 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1842 info
->mmio_base
= devm_ioremap_resource(&pdev
->dev
, r
);
1843 if (IS_ERR(info
->mmio_base
)) {
1844 ret
= PTR_ERR(info
->mmio_base
);
1845 goto fail_disable_clk
;
1847 info
->mmio_phys
= r
->start
;
1849 /* Allocate a buffer to allow flash detection */
1850 info
->buf_size
= INIT_BUFFER_SIZE
;
1851 info
->data_buff
= kmalloc(info
->buf_size
, GFP_KERNEL
);
1852 if (info
->data_buff
== NULL
) {
1854 goto fail_disable_clk
;
1857 /* initialize all interrupts to be disabled */
1858 disable_int(info
, NDSR_MASK
);
1860 ret
= request_threaded_irq(irq
, pxa3xx_nand_irq
,
1861 pxa3xx_nand_irq_thread
, IRQF_ONESHOT
,
1864 dev_err(&pdev
->dev
, "failed to request IRQ\n");
1868 platform_set_drvdata(pdev
, info
);
1873 free_irq(irq
, info
);
1874 kfree(info
->data_buff
);
1876 clk_disable_unprepare(info
->clk
);
1880 static int pxa3xx_nand_remove(struct platform_device
*pdev
)
1882 struct pxa3xx_nand_info
*info
= platform_get_drvdata(pdev
);
1883 struct pxa3xx_nand_platform_data
*pdata
;
1889 pdata
= dev_get_platdata(&pdev
->dev
);
1891 irq
= platform_get_irq(pdev
, 0);
1893 free_irq(irq
, info
);
1894 pxa3xx_nand_free_buff(info
);
1897 * In the pxa3xx case, the DFI bus is shared between the SMC and NFC.
1898 * In order to prevent a lockup of the system bus, the DFI bus
1899 * arbitration is granted to SMC upon driver removal. This is done by
1900 * setting the x_ARB_CNTL bit, which also prevents the NAND to have
1901 * access to the bus anymore.
1903 nand_writel(info
, NDCR
,
1904 (nand_readl(info
, NDCR
) & ~NDCR_ND_ARB_EN
) |
1905 NFCV1_NDCR_ARB_CNTL
);
1906 clk_disable_unprepare(info
->clk
);
1908 for (cs
= 0; cs
< pdata
->num_cs
; cs
++)
1909 nand_release(nand_to_mtd(&info
->host
[cs
]->chip
));
1913 static int pxa3xx_nand_probe_dt(struct platform_device
*pdev
)
1915 struct pxa3xx_nand_platform_data
*pdata
;
1916 struct device_node
*np
= pdev
->dev
.of_node
;
1917 const struct of_device_id
*of_id
=
1918 of_match_device(pxa3xx_nand_dt_ids
, &pdev
->dev
);
1923 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
1927 if (of_get_property(np
, "marvell,nand-enable-arbiter", NULL
))
1928 pdata
->enable_arbiter
= 1;
1929 if (of_get_property(np
, "marvell,nand-keep-config", NULL
))
1930 pdata
->keep_config
= 1;
1931 of_property_read_u32(np
, "num-cs", &pdata
->num_cs
);
1933 pdev
->dev
.platform_data
= pdata
;
1938 static int pxa3xx_nand_probe(struct platform_device
*pdev
)
1940 struct pxa3xx_nand_platform_data
*pdata
;
1941 struct pxa3xx_nand_info
*info
;
1942 int ret
, cs
, probe_success
, dma_available
;
1944 dma_available
= IS_ENABLED(CONFIG_ARM
) &&
1945 (IS_ENABLED(CONFIG_ARCH_PXA
) || IS_ENABLED(CONFIG_ARCH_MMP
));
1946 if (use_dma
&& !dma_available
) {
1948 dev_warn(&pdev
->dev
,
1949 "This platform can't do DMA on this device\n");
1952 ret
= pxa3xx_nand_probe_dt(pdev
);
1956 pdata
= dev_get_platdata(&pdev
->dev
);
1958 dev_err(&pdev
->dev
, "no platform data defined\n");
1962 ret
= alloc_nand_resource(pdev
);
1964 dev_err(&pdev
->dev
, "alloc nand resource failed\n");
1968 info
= platform_get_drvdata(pdev
);
1970 for (cs
= 0; cs
< pdata
->num_cs
; cs
++) {
1971 struct mtd_info
*mtd
= nand_to_mtd(&info
->host
[cs
]->chip
);
1974 * The mtd name matches the one used in 'mtdparts' kernel
1975 * parameter. This name cannot be changed or otherwise
1976 * user's mtd partitions configuration would get broken.
1978 mtd
->name
= "pxa3xx_nand-0";
1980 ret
= pxa3xx_nand_scan(mtd
);
1982 dev_warn(&pdev
->dev
, "failed to scan nand at cs %d\n",
1987 ret
= mtd_device_register(mtd
, pdata
->parts
[cs
],
1988 pdata
->nr_parts
[cs
]);
1993 if (!probe_success
) {
1994 pxa3xx_nand_remove(pdev
);
2002 static int pxa3xx_nand_suspend(struct device
*dev
)
2004 struct pxa3xx_nand_info
*info
= dev_get_drvdata(dev
);
2007 dev_err(dev
, "driver busy, state = %d\n", info
->state
);
2011 clk_disable(info
->clk
);
2015 static int pxa3xx_nand_resume(struct device
*dev
)
2017 struct pxa3xx_nand_info
*info
= dev_get_drvdata(dev
);
2020 ret
= clk_enable(info
->clk
);
2024 /* We don't want to handle interrupt without calling mtd routine */
2025 disable_int(info
, NDCR_INT_MASK
);
2028 * Directly set the chip select to a invalid value,
2029 * then the driver would reset the timing according
2030 * to current chip select at the beginning of cmdfunc
2035 * As the spec says, the NDSR would be updated to 0x1800 when
2036 * doing the nand_clk disable/enable.
2037 * To prevent it damaging state machine of the driver, clear
2038 * all status before resume
2040 nand_writel(info
, NDSR
, NDSR_MASK
);
2045 #define pxa3xx_nand_suspend NULL
2046 #define pxa3xx_nand_resume NULL
2049 static const struct dev_pm_ops pxa3xx_nand_pm_ops
= {
2050 .suspend
= pxa3xx_nand_suspend
,
2051 .resume
= pxa3xx_nand_resume
,
2054 static struct platform_driver pxa3xx_nand_driver
= {
2056 .name
= "pxa3xx-nand",
2057 .of_match_table
= pxa3xx_nand_dt_ids
,
2058 .pm
= &pxa3xx_nand_pm_ops
,
2060 .probe
= pxa3xx_nand_probe
,
2061 .remove
= pxa3xx_nand_remove
,
2064 module_platform_driver(pxa3xx_nand_driver
);
2066 MODULE_LICENSE("GPL");
2067 MODULE_DESCRIPTION("PXA3xx NAND controller driver");