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.
12 #include <linux/module.h>
13 #include <linux/interrupt.h>
14 #include <linux/platform_device.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/delay.h>
17 #include <linux/clk.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/mtd/nand.h>
20 #include <linux/mtd/partitions.h>
22 #include <linux/irq.h>
25 #include <mach/pxa3xx_nand.h>
27 #define CHIP_DELAY_TIMEOUT (2 * HZ/10)
29 /* registers and bit definitions */
30 #define NDCR (0x00) /* Control register */
31 #define NDTR0CS0 (0x04) /* Timing Parameter 0 for CS0 */
32 #define NDTR1CS0 (0x0C) /* Timing Parameter 1 for CS0 */
33 #define NDSR (0x14) /* Status Register */
34 #define NDPCR (0x18) /* Page Count Register */
35 #define NDBDR0 (0x1C) /* Bad Block Register 0 */
36 #define NDBDR1 (0x20) /* Bad Block Register 1 */
37 #define NDDB (0x40) /* Data Buffer */
38 #define NDCB0 (0x48) /* Command Buffer0 */
39 #define NDCB1 (0x4C) /* Command Buffer1 */
40 #define NDCB2 (0x50) /* Command Buffer2 */
42 #define NDCR_SPARE_EN (0x1 << 31)
43 #define NDCR_ECC_EN (0x1 << 30)
44 #define NDCR_DMA_EN (0x1 << 29)
45 #define NDCR_ND_RUN (0x1 << 28)
46 #define NDCR_DWIDTH_C (0x1 << 27)
47 #define NDCR_DWIDTH_M (0x1 << 26)
48 #define NDCR_PAGE_SZ (0x1 << 24)
49 #define NDCR_NCSX (0x1 << 23)
50 #define NDCR_ND_MODE (0x3 << 21)
51 #define NDCR_NAND_MODE (0x0)
52 #define NDCR_CLR_PG_CNT (0x1 << 20)
53 #define NDCR_CLR_ECC (0x1 << 19)
54 #define NDCR_RD_ID_CNT_MASK (0x7 << 16)
55 #define NDCR_RD_ID_CNT(x) (((x) << 16) & NDCR_RD_ID_CNT_MASK)
57 #define NDCR_RA_START (0x1 << 15)
58 #define NDCR_PG_PER_BLK (0x1 << 14)
59 #define NDCR_ND_ARB_EN (0x1 << 12)
61 #define NDSR_MASK (0xfff)
62 #define NDSR_RDY (0x1 << 11)
63 #define NDSR_CS0_PAGED (0x1 << 10)
64 #define NDSR_CS1_PAGED (0x1 << 9)
65 #define NDSR_CS0_CMDD (0x1 << 8)
66 #define NDSR_CS1_CMDD (0x1 << 7)
67 #define NDSR_CS0_BBD (0x1 << 6)
68 #define NDSR_CS1_BBD (0x1 << 5)
69 #define NDSR_DBERR (0x1 << 4)
70 #define NDSR_SBERR (0x1 << 3)
71 #define NDSR_WRDREQ (0x1 << 2)
72 #define NDSR_RDDREQ (0x1 << 1)
73 #define NDSR_WRCMDREQ (0x1)
75 #define NDCB0_AUTO_RS (0x1 << 25)
76 #define NDCB0_CSEL (0x1 << 24)
77 #define NDCB0_CMD_TYPE_MASK (0x7 << 21)
78 #define NDCB0_CMD_TYPE(x) (((x) << 21) & NDCB0_CMD_TYPE_MASK)
79 #define NDCB0_NC (0x1 << 20)
80 #define NDCB0_DBC (0x1 << 19)
81 #define NDCB0_ADDR_CYC_MASK (0x7 << 16)
82 #define NDCB0_ADDR_CYC(x) (((x) << 16) & NDCB0_ADDR_CYC_MASK)
83 #define NDCB0_CMD2_MASK (0xff << 8)
84 #define NDCB0_CMD1_MASK (0xff)
85 #define NDCB0_ADDR_CYC_SHIFT (16)
87 /* dma-able I/O address for the NAND data and commands */
88 #define NDCB0_DMA_ADDR (0x43100048)
89 #define NDDB_DMA_ADDR (0x43100040)
91 /* macros for registers read/write */
92 #define nand_writel(info, off, val) \
93 __raw_writel((val), (info)->mmio_base + (off))
95 #define nand_readl(info, off) \
96 __raw_readl((info)->mmio_base + (off))
98 /* error code and state */
118 struct pxa3xx_nand_info
{
119 struct nand_chip nand_chip
;
121 struct platform_device
*pdev
;
122 const struct pxa3xx_nand_flash
*flash_info
;
125 void __iomem
*mmio_base
;
127 unsigned int buf_start
;
128 unsigned int buf_count
;
130 /* DMA information */
134 unsigned char *data_buff
;
135 dma_addr_t data_buff_phys
;
136 size_t data_buff_size
;
138 struct pxa_dma_desc
*data_desc
;
139 dma_addr_t data_desc_addr
;
143 /* saved column/page_addr during CMD_SEQIN */
147 /* relate to the command */
150 int use_ecc
; /* use HW ECC ? */
151 int use_dma
; /* use DMA ? */
153 size_t data_size
; /* data size in FIFO */
155 struct completion cmd_complete
;
157 /* generated NDCBx register values */
162 /* calculated from pxa3xx_nand_flash data */
164 size_t read_id_bytes
;
166 unsigned int col_addr_cycles
;
167 unsigned int row_addr_cycles
;
170 static int use_dma
= 1;
171 module_param(use_dma
, bool, 0444);
172 MODULE_PARM_DESC(use_dma
, "enable DMA for data transfering to/from NAND HW");
175 * Default NAND flash controller configuration setup by the
176 * bootloader. This configuration is used only when pdata->keep_config is set
178 static struct pxa3xx_nand_timing default_timing
;
179 static struct pxa3xx_nand_flash default_flash
;
181 static struct pxa3xx_nand_cmdset smallpage_cmdset
= {
185 .read_status
= 0x0070,
191 .lock_status
= 0x007A,
194 static struct pxa3xx_nand_cmdset largepage_cmdset
= {
198 .read_status
= 0x0070,
204 .lock_status
= 0x007A,
207 #ifdef CONFIG_MTD_NAND_PXA3xx_BUILTIN
208 static struct pxa3xx_nand_timing samsung512MbX16_timing
= {
220 static struct pxa3xx_nand_flash samsung512MbX16
= {
221 .timing
= &samsung512MbX16_timing
,
222 .cmdset
= &smallpage_cmdset
,
223 .page_per_block
= 32,
231 static struct pxa3xx_nand_timing micron_timing
= {
243 static struct pxa3xx_nand_flash micron1GbX8
= {
244 .timing
= µn_timing
,
245 .cmdset
= &largepage_cmdset
,
246 .page_per_block
= 64,
254 static struct pxa3xx_nand_flash micron1GbX16
= {
255 .timing
= µn_timing
,
256 .cmdset
= &largepage_cmdset
,
257 .page_per_block
= 64,
265 static struct pxa3xx_nand_timing stm2GbX16_timing
= {
277 static struct pxa3xx_nand_flash stm2GbX16
= {
278 .timing
= &stm2GbX16_timing
,
279 .cmdset
= &largepage_cmdset
,
280 .page_per_block
= 64,
288 static struct pxa3xx_nand_flash
*builtin_flash_types
[] = {
294 #endif /* CONFIG_MTD_NAND_PXA3xx_BUILTIN */
296 #define NDTR0_tCH(c) (min((c), 7) << 19)
297 #define NDTR0_tCS(c) (min((c), 7) << 16)
298 #define NDTR0_tWH(c) (min((c), 7) << 11)
299 #define NDTR0_tWP(c) (min((c), 7) << 8)
300 #define NDTR0_tRH(c) (min((c), 7) << 3)
301 #define NDTR0_tRP(c) (min((c), 7) << 0)
303 #define NDTR1_tR(c) (min((c), 65535) << 16)
304 #define NDTR1_tWHR(c) (min((c), 15) << 4)
305 #define NDTR1_tAR(c) (min((c), 15) << 0)
307 #define tCH_NDTR0(r) (((r) >> 19) & 0x7)
308 #define tCS_NDTR0(r) (((r) >> 16) & 0x7)
309 #define tWH_NDTR0(r) (((r) >> 11) & 0x7)
310 #define tWP_NDTR0(r) (((r) >> 8) & 0x7)
311 #define tRH_NDTR0(r) (((r) >> 3) & 0x7)
312 #define tRP_NDTR0(r) (((r) >> 0) & 0x7)
314 #define tR_NDTR1(r) (((r) >> 16) & 0xffff)
315 #define tWHR_NDTR1(r) (((r) >> 4) & 0xf)
316 #define tAR_NDTR1(r) (((r) >> 0) & 0xf)
318 /* convert nano-seconds to nand flash controller clock cycles */
319 #define ns2cycle(ns, clk) (int)(((ns) * (clk / 1000000) / 1000) - 1)
321 /* convert nand flash controller clock cycles to nano-seconds */
322 #define cycle2ns(c, clk) ((((c) + 1) * 1000000 + clk / 500) / (clk / 1000))
324 static void pxa3xx_nand_set_timing(struct pxa3xx_nand_info
*info
,
325 const struct pxa3xx_nand_timing
*t
)
327 unsigned long nand_clk
= clk_get_rate(info
->clk
);
328 uint32_t ndtr0
, ndtr1
;
330 ndtr0
= NDTR0_tCH(ns2cycle(t
->tCH
, nand_clk
)) |
331 NDTR0_tCS(ns2cycle(t
->tCS
, nand_clk
)) |
332 NDTR0_tWH(ns2cycle(t
->tWH
, nand_clk
)) |
333 NDTR0_tWP(ns2cycle(t
->tWP
, nand_clk
)) |
334 NDTR0_tRH(ns2cycle(t
->tRH
, nand_clk
)) |
335 NDTR0_tRP(ns2cycle(t
->tRP
, nand_clk
));
337 ndtr1
= NDTR1_tR(ns2cycle(t
->tR
, nand_clk
)) |
338 NDTR1_tWHR(ns2cycle(t
->tWHR
, nand_clk
)) |
339 NDTR1_tAR(ns2cycle(t
->tAR
, nand_clk
));
341 nand_writel(info
, NDTR0CS0
, ndtr0
);
342 nand_writel(info
, NDTR1CS0
, ndtr1
);
345 #define WAIT_EVENT_TIMEOUT 10
347 static int wait_for_event(struct pxa3xx_nand_info
*info
, uint32_t event
)
349 int timeout
= WAIT_EVENT_TIMEOUT
;
353 ndsr
= nand_readl(info
, NDSR
) & NDSR_MASK
;
355 nand_writel(info
, NDSR
, ndsr
);
364 static int prepare_read_prog_cmd(struct pxa3xx_nand_info
*info
,
365 uint16_t cmd
, int column
, int page_addr
)
367 const struct pxa3xx_nand_flash
*f
= info
->flash_info
;
368 const struct pxa3xx_nand_cmdset
*cmdset
= f
->cmdset
;
370 /* calculate data size */
371 switch (f
->page_size
) {
373 info
->data_size
= (info
->use_ecc
) ? 2088 : 2112;
376 info
->data_size
= (info
->use_ecc
) ? 520 : 528;
382 /* generate values for NDCBx registers */
383 info
->ndcb0
= cmd
| ((cmd
& 0xff00) ? NDCB0_DBC
: 0);
386 info
->ndcb0
|= NDCB0_ADDR_CYC(info
->row_addr_cycles
+ info
->col_addr_cycles
);
388 if (info
->col_addr_cycles
== 2) {
389 /* large block, 2 cycles for column address
390 * row address starts from 3rd cycle
392 info
->ndcb1
|= page_addr
<< 16;
393 if (info
->row_addr_cycles
== 3)
394 info
->ndcb2
= (page_addr
>> 16) & 0xff;
396 /* small block, 1 cycles for column address
397 * row address starts from 2nd cycle
399 info
->ndcb1
= page_addr
<< 8;
401 if (cmd
== cmdset
->program
)
402 info
->ndcb0
|= NDCB0_CMD_TYPE(1) | NDCB0_AUTO_RS
;
407 static int prepare_erase_cmd(struct pxa3xx_nand_info
*info
,
408 uint16_t cmd
, int page_addr
)
410 info
->ndcb0
= cmd
| ((cmd
& 0xff00) ? NDCB0_DBC
: 0);
411 info
->ndcb0
|= NDCB0_CMD_TYPE(2) | NDCB0_AUTO_RS
| NDCB0_ADDR_CYC(3);
412 info
->ndcb1
= page_addr
;
417 static int prepare_other_cmd(struct pxa3xx_nand_info
*info
, uint16_t cmd
)
419 const struct pxa3xx_nand_cmdset
*cmdset
= info
->flash_info
->cmdset
;
421 info
->ndcb0
= cmd
| ((cmd
& 0xff00) ? NDCB0_DBC
: 0);
425 if (cmd
== cmdset
->read_id
) {
426 info
->ndcb0
|= NDCB0_CMD_TYPE(3);
428 } else if (cmd
== cmdset
->read_status
) {
429 info
->ndcb0
|= NDCB0_CMD_TYPE(4);
431 } else if (cmd
== cmdset
->reset
|| cmd
== cmdset
->lock
||
432 cmd
== cmdset
->unlock
) {
433 info
->ndcb0
|= NDCB0_CMD_TYPE(5);
440 static void enable_int(struct pxa3xx_nand_info
*info
, uint32_t int_mask
)
444 ndcr
= nand_readl(info
, NDCR
);
445 nand_writel(info
, NDCR
, ndcr
& ~int_mask
);
448 static void disable_int(struct pxa3xx_nand_info
*info
, uint32_t int_mask
)
452 ndcr
= nand_readl(info
, NDCR
);
453 nand_writel(info
, NDCR
, ndcr
| int_mask
);
456 /* NOTE: it is a must to set ND_RUN firstly, then write command buffer
457 * otherwise, it does not work
459 static int write_cmd(struct pxa3xx_nand_info
*info
)
463 /* clear status bits and run */
464 nand_writel(info
, NDSR
, NDSR_MASK
);
466 ndcr
= info
->reg_ndcr
;
468 ndcr
|= info
->use_ecc
? NDCR_ECC_EN
: 0;
469 ndcr
|= info
->use_dma
? NDCR_DMA_EN
: 0;
472 nand_writel(info
, NDCR
, ndcr
);
474 if (wait_for_event(info
, NDSR_WRCMDREQ
)) {
475 printk(KERN_ERR
"timed out writing command\n");
479 nand_writel(info
, NDCB0
, info
->ndcb0
);
480 nand_writel(info
, NDCB0
, info
->ndcb1
);
481 nand_writel(info
, NDCB0
, info
->ndcb2
);
485 static int handle_data_pio(struct pxa3xx_nand_info
*info
)
487 int ret
, timeout
= CHIP_DELAY_TIMEOUT
;
489 switch (info
->state
) {
490 case STATE_PIO_WRITING
:
491 __raw_writesl(info
->mmio_base
+ NDDB
, info
->data_buff
,
492 info
->data_size
<< 2);
494 enable_int(info
, NDSR_CS0_BBD
| NDSR_CS0_CMDD
);
496 ret
= wait_for_completion_timeout(&info
->cmd_complete
, timeout
);
498 printk(KERN_ERR
"program command time out\n");
502 case STATE_PIO_READING
:
503 __raw_readsl(info
->mmio_base
+ NDDB
, info
->data_buff
,
504 info
->data_size
<< 2);
507 printk(KERN_ERR
"%s: invalid state %d\n", __func__
,
512 info
->state
= STATE_READY
;
516 static void start_data_dma(struct pxa3xx_nand_info
*info
, int dir_out
)
518 struct pxa_dma_desc
*desc
= info
->data_desc
;
519 int dma_len
= ALIGN(info
->data_size
, 32);
521 desc
->ddadr
= DDADR_STOP
;
522 desc
->dcmd
= DCMD_ENDIRQEN
| DCMD_WIDTH4
| DCMD_BURST32
| dma_len
;
525 desc
->dsadr
= info
->data_buff_phys
;
526 desc
->dtadr
= NDDB_DMA_ADDR
;
527 desc
->dcmd
|= DCMD_INCSRCADDR
| DCMD_FLOWTRG
;
529 desc
->dtadr
= info
->data_buff_phys
;
530 desc
->dsadr
= NDDB_DMA_ADDR
;
531 desc
->dcmd
|= DCMD_INCTRGADDR
| DCMD_FLOWSRC
;
534 DRCMR(info
->drcmr_dat
) = DRCMR_MAPVLD
| info
->data_dma_ch
;
535 DDADR(info
->data_dma_ch
) = info
->data_desc_addr
;
536 DCSR(info
->data_dma_ch
) |= DCSR_RUN
;
539 static void pxa3xx_nand_data_dma_irq(int channel
, void *data
)
541 struct pxa3xx_nand_info
*info
= data
;
544 dcsr
= DCSR(channel
);
545 DCSR(channel
) = dcsr
;
547 if (dcsr
& DCSR_BUSERR
) {
548 info
->retcode
= ERR_DMABUSERR
;
549 complete(&info
->cmd_complete
);
552 if (info
->state
== STATE_DMA_WRITING
) {
553 info
->state
= STATE_DMA_DONE
;
554 enable_int(info
, NDSR_CS0_BBD
| NDSR_CS0_CMDD
);
556 info
->state
= STATE_READY
;
557 complete(&info
->cmd_complete
);
561 static irqreturn_t
pxa3xx_nand_irq(int irq
, void *devid
)
563 struct pxa3xx_nand_info
*info
= devid
;
566 status
= nand_readl(info
, NDSR
);
568 if (status
& (NDSR_RDDREQ
| NDSR_DBERR
| NDSR_SBERR
)) {
569 if (status
& NDSR_DBERR
)
570 info
->retcode
= ERR_DBERR
;
571 else if (status
& NDSR_SBERR
)
572 info
->retcode
= ERR_SBERR
;
574 disable_int(info
, NDSR_RDDREQ
| NDSR_DBERR
| NDSR_SBERR
);
577 info
->state
= STATE_DMA_READING
;
578 start_data_dma(info
, 0);
580 info
->state
= STATE_PIO_READING
;
581 complete(&info
->cmd_complete
);
583 } else if (status
& NDSR_WRDREQ
) {
584 disable_int(info
, NDSR_WRDREQ
);
586 info
->state
= STATE_DMA_WRITING
;
587 start_data_dma(info
, 1);
589 info
->state
= STATE_PIO_WRITING
;
590 complete(&info
->cmd_complete
);
592 } else if (status
& (NDSR_CS0_BBD
| NDSR_CS0_CMDD
)) {
593 if (status
& NDSR_CS0_BBD
)
594 info
->retcode
= ERR_BBERR
;
596 disable_int(info
, NDSR_CS0_BBD
| NDSR_CS0_CMDD
);
597 info
->state
= STATE_READY
;
598 complete(&info
->cmd_complete
);
600 nand_writel(info
, NDSR
, status
);
604 static int pxa3xx_nand_do_cmd(struct pxa3xx_nand_info
*info
, uint32_t event
)
607 int ret
, timeout
= CHIP_DELAY_TIMEOUT
;
609 if (write_cmd(info
)) {
610 info
->retcode
= ERR_SENDCMD
;
614 info
->state
= STATE_CMD_HANDLE
;
616 enable_int(info
, event
);
618 ret
= wait_for_completion_timeout(&info
->cmd_complete
, timeout
);
620 printk(KERN_ERR
"command execution timed out\n");
621 info
->retcode
= ERR_SENDCMD
;
625 if (info
->use_dma
== 0 && info
->data_size
> 0)
626 if (handle_data_pio(info
))
632 ndcr
= nand_readl(info
, NDCR
);
633 nand_writel(info
, NDCR
, ndcr
& ~NDCR_ND_RUN
);
638 static int pxa3xx_nand_dev_ready(struct mtd_info
*mtd
)
640 struct pxa3xx_nand_info
*info
= mtd
->priv
;
641 return (nand_readl(info
, NDSR
) & NDSR_RDY
) ? 1 : 0;
644 static inline int is_buf_blank(uint8_t *buf
, size_t len
)
646 for (; len
> 0; len
--)
652 static void pxa3xx_nand_cmdfunc(struct mtd_info
*mtd
, unsigned command
,
653 int column
, int page_addr
)
655 struct pxa3xx_nand_info
*info
= mtd
->priv
;
656 const struct pxa3xx_nand_flash
*flash_info
= info
->flash_info
;
657 const struct pxa3xx_nand_cmdset
*cmdset
= flash_info
->cmdset
;
660 info
->use_dma
= (use_dma
) ? 1 : 0;
663 info
->state
= STATE_READY
;
665 init_completion(&info
->cmd_complete
);
668 case NAND_CMD_READOOB
:
669 /* disable HW ECC to get all the OOB data */
670 info
->buf_count
= mtd
->writesize
+ mtd
->oobsize
;
671 info
->buf_start
= mtd
->writesize
+ column
;
673 if (prepare_read_prog_cmd(info
, cmdset
->read1
, column
, page_addr
))
676 pxa3xx_nand_do_cmd(info
, NDSR_RDDREQ
| NDSR_DBERR
| NDSR_SBERR
);
678 /* We only are OOB, so if the data has error, does not matter */
679 if (info
->retcode
== ERR_DBERR
)
680 info
->retcode
= ERR_NONE
;
685 info
->retcode
= ERR_NONE
;
686 info
->buf_start
= column
;
687 info
->buf_count
= mtd
->writesize
+ mtd
->oobsize
;
688 memset(info
->data_buff
, 0xFF, info
->buf_count
);
690 if (prepare_read_prog_cmd(info
, cmdset
->read1
, column
, page_addr
))
693 pxa3xx_nand_do_cmd(info
, NDSR_RDDREQ
| NDSR_DBERR
| NDSR_SBERR
);
695 if (info
->retcode
== ERR_DBERR
) {
696 /* for blank page (all 0xff), HW will calculate its ECC as
697 * 0, which is different from the ECC information within
698 * OOB, ignore such double bit errors
700 if (is_buf_blank(info
->data_buff
, mtd
->writesize
))
701 info
->retcode
= ERR_NONE
;
705 info
->buf_start
= column
;
706 info
->buf_count
= mtd
->writesize
+ mtd
->oobsize
;
707 memset(info
->data_buff
, 0xff, info
->buf_count
);
709 /* save column/page_addr for next CMD_PAGEPROG */
710 info
->seqin_column
= column
;
711 info
->seqin_page_addr
= page_addr
;
713 case NAND_CMD_PAGEPROG
:
714 info
->use_ecc
= (info
->seqin_column
>= mtd
->writesize
) ? 0 : 1;
716 if (prepare_read_prog_cmd(info
, cmdset
->program
,
717 info
->seqin_column
, info
->seqin_page_addr
))
720 pxa3xx_nand_do_cmd(info
, NDSR_WRDREQ
);
722 case NAND_CMD_ERASE1
:
723 if (prepare_erase_cmd(info
, cmdset
->erase
, page_addr
))
726 pxa3xx_nand_do_cmd(info
, NDSR_CS0_BBD
| NDSR_CS0_CMDD
);
728 case NAND_CMD_ERASE2
:
730 case NAND_CMD_READID
:
731 case NAND_CMD_STATUS
:
732 info
->use_dma
= 0; /* force PIO read */
734 info
->buf_count
= (command
== NAND_CMD_READID
) ?
735 info
->read_id_bytes
: 1;
737 if (prepare_other_cmd(info
, (command
== NAND_CMD_READID
) ?
738 cmdset
->read_id
: cmdset
->read_status
))
741 pxa3xx_nand_do_cmd(info
, NDSR_RDDREQ
);
744 if (prepare_other_cmd(info
, cmdset
->reset
))
747 ret
= pxa3xx_nand_do_cmd(info
, NDSR_CS0_CMDD
);
753 if (nand_readl(info
, NDSR
) & NDSR_RDY
)
758 ndcr
= nand_readl(info
, NDCR
);
759 nand_writel(info
, NDCR
, ndcr
& ~NDCR_ND_RUN
);
763 printk(KERN_ERR
"non-supported command.\n");
767 if (info
->retcode
== ERR_DBERR
) {
768 printk(KERN_ERR
"double bit error @ page %08x\n", page_addr
);
769 info
->retcode
= ERR_NONE
;
773 static uint8_t pxa3xx_nand_read_byte(struct mtd_info
*mtd
)
775 struct pxa3xx_nand_info
*info
= mtd
->priv
;
778 if (info
->buf_start
< info
->buf_count
)
779 /* Has just send a new command? */
780 retval
= info
->data_buff
[info
->buf_start
++];
785 static u16
pxa3xx_nand_read_word(struct mtd_info
*mtd
)
787 struct pxa3xx_nand_info
*info
= mtd
->priv
;
790 if (!(info
->buf_start
& 0x01) && info
->buf_start
< info
->buf_count
) {
791 retval
= *((u16
*)(info
->data_buff
+info
->buf_start
));
792 info
->buf_start
+= 2;
797 static void pxa3xx_nand_read_buf(struct mtd_info
*mtd
, uint8_t *buf
, int len
)
799 struct pxa3xx_nand_info
*info
= mtd
->priv
;
800 int real_len
= min_t(size_t, len
, info
->buf_count
- info
->buf_start
);
802 memcpy(buf
, info
->data_buff
+ info
->buf_start
, real_len
);
803 info
->buf_start
+= real_len
;
806 static void pxa3xx_nand_write_buf(struct mtd_info
*mtd
,
807 const uint8_t *buf
, int len
)
809 struct pxa3xx_nand_info
*info
= mtd
->priv
;
810 int real_len
= min_t(size_t, len
, info
->buf_count
- info
->buf_start
);
812 memcpy(info
->data_buff
+ info
->buf_start
, buf
, real_len
);
813 info
->buf_start
+= real_len
;
816 static int pxa3xx_nand_verify_buf(struct mtd_info
*mtd
,
817 const uint8_t *buf
, int len
)
822 static void pxa3xx_nand_select_chip(struct mtd_info
*mtd
, int chip
)
827 static int pxa3xx_nand_waitfunc(struct mtd_info
*mtd
, struct nand_chip
*this)
829 struct pxa3xx_nand_info
*info
= mtd
->priv
;
831 /* pxa3xx_nand_send_command has waited for command complete */
832 if (this->state
== FL_WRITING
|| this->state
== FL_ERASING
) {
833 if (info
->retcode
== ERR_NONE
)
837 * any error make it return 0x01 which will tell
838 * the caller the erase and write fail
847 static void pxa3xx_nand_ecc_hwctl(struct mtd_info
*mtd
, int mode
)
852 static int pxa3xx_nand_ecc_calculate(struct mtd_info
*mtd
,
853 const uint8_t *dat
, uint8_t *ecc_code
)
858 static int pxa3xx_nand_ecc_correct(struct mtd_info
*mtd
,
859 uint8_t *dat
, uint8_t *read_ecc
, uint8_t *calc_ecc
)
861 struct pxa3xx_nand_info
*info
= mtd
->priv
;
863 * Any error include ERR_SEND_CMD, ERR_DBERR, ERR_BUSERR, we
864 * consider it as a ecc error which will tell the caller the
865 * read fail We have distinguish all the errors, but the
866 * nand_read_ecc only check this function return value
868 * Corrected (single-bit) errors must also be noted.
870 if (info
->retcode
== ERR_SBERR
)
872 else if (info
->retcode
!= ERR_NONE
)
878 static int __readid(struct pxa3xx_nand_info
*info
, uint32_t *id
)
880 const struct pxa3xx_nand_flash
*f
= info
->flash_info
;
881 const struct pxa3xx_nand_cmdset
*cmdset
= f
->cmdset
;
885 if (prepare_other_cmd(info
, cmdset
->read_id
)) {
886 printk(KERN_ERR
"failed to prepare command\n");
894 /* Wait for CMDDM(command done successfully) */
895 if (wait_for_event(info
, NDSR_RDDREQ
))
898 __raw_readsl(info
->mmio_base
+ NDDB
, id_buff
, 2);
899 *id
= id_buff
[0] | (id_buff
[1] << 8);
903 ndcr
= nand_readl(info
, NDCR
);
904 nand_writel(info
, NDCR
, ndcr
& ~NDCR_ND_RUN
);
909 static int pxa3xx_nand_config_flash(struct pxa3xx_nand_info
*info
,
910 const struct pxa3xx_nand_flash
*f
)
912 struct platform_device
*pdev
= info
->pdev
;
913 struct pxa3xx_nand_platform_data
*pdata
= pdev
->dev
.platform_data
;
914 uint32_t ndcr
= 0x00000FFF; /* disable all interrupts */
916 if (f
->page_size
!= 2048 && f
->page_size
!= 512)
919 if (f
->flash_width
!= 16 && f
->flash_width
!= 8)
922 /* calculate flash information */
923 info
->oob_size
= (f
->page_size
== 2048) ? 64 : 16;
924 info
->read_id_bytes
= (f
->page_size
== 2048) ? 4 : 2;
926 /* calculate addressing information */
927 info
->col_addr_cycles
= (f
->page_size
== 2048) ? 2 : 1;
929 if (f
->num_blocks
* f
->page_per_block
> 65536)
930 info
->row_addr_cycles
= 3;
932 info
->row_addr_cycles
= 2;
934 ndcr
|= (pdata
->enable_arbiter
) ? NDCR_ND_ARB_EN
: 0;
935 ndcr
|= (info
->col_addr_cycles
== 2) ? NDCR_RA_START
: 0;
936 ndcr
|= (f
->page_per_block
== 64) ? NDCR_PG_PER_BLK
: 0;
937 ndcr
|= (f
->page_size
== 2048) ? NDCR_PAGE_SZ
: 0;
938 ndcr
|= (f
->flash_width
== 16) ? NDCR_DWIDTH_M
: 0;
939 ndcr
|= (f
->dfc_width
== 16) ? NDCR_DWIDTH_C
: 0;
941 ndcr
|= NDCR_RD_ID_CNT(info
->read_id_bytes
);
942 ndcr
|= NDCR_SPARE_EN
; /* enable spare by default */
944 info
->reg_ndcr
= ndcr
;
946 pxa3xx_nand_set_timing(info
, f
->timing
);
947 info
->flash_info
= f
;
951 static void pxa3xx_nand_detect_timing(struct pxa3xx_nand_info
*info
,
952 struct pxa3xx_nand_timing
*t
)
954 unsigned long nand_clk
= clk_get_rate(info
->clk
);
955 uint32_t ndtr0
= nand_readl(info
, NDTR0CS0
);
956 uint32_t ndtr1
= nand_readl(info
, NDTR1CS0
);
958 t
->tCH
= cycle2ns(tCH_NDTR0(ndtr0
), nand_clk
);
959 t
->tCS
= cycle2ns(tCS_NDTR0(ndtr0
), nand_clk
);
960 t
->tWH
= cycle2ns(tWH_NDTR0(ndtr0
), nand_clk
);
961 t
->tWP
= cycle2ns(tWP_NDTR0(ndtr0
), nand_clk
);
962 t
->tRH
= cycle2ns(tRH_NDTR0(ndtr0
), nand_clk
);
963 t
->tRP
= cycle2ns(tRP_NDTR0(ndtr0
), nand_clk
);
965 t
->tR
= cycle2ns(tR_NDTR1(ndtr1
), nand_clk
);
966 t
->tWHR
= cycle2ns(tWHR_NDTR1(ndtr1
), nand_clk
);
967 t
->tAR
= cycle2ns(tAR_NDTR1(ndtr1
), nand_clk
);
970 static int pxa3xx_nand_detect_config(struct pxa3xx_nand_info
*info
)
972 uint32_t ndcr
= nand_readl(info
, NDCR
);
973 struct nand_flash_dev
*type
= NULL
;
977 default_flash
.page_per_block
= ndcr
& NDCR_PG_PER_BLK
? 64 : 32;
978 default_flash
.page_size
= ndcr
& NDCR_PAGE_SZ
? 2048 : 512;
979 default_flash
.flash_width
= ndcr
& NDCR_DWIDTH_M
? 16 : 8;
980 default_flash
.dfc_width
= ndcr
& NDCR_DWIDTH_C
? 16 : 8;
982 if (default_flash
.page_size
== 2048)
983 default_flash
.cmdset
= &largepage_cmdset
;
985 default_flash
.cmdset
= &smallpage_cmdset
;
987 /* set info fields needed to __readid */
988 info
->flash_info
= &default_flash
;
989 info
->read_id_bytes
= (default_flash
.page_size
== 2048) ? 4 : 2;
990 info
->reg_ndcr
= ndcr
;
992 if (__readid(info
, &id
))
995 /* Lookup the flash id */
996 id
= (id
>> 8) & 0xff; /* device id is byte 2 */
997 for (i
= 0; nand_flash_ids
[i
].name
!= NULL
; i
++) {
998 if (id
== nand_flash_ids
[i
].id
) {
999 type
= &nand_flash_ids
[i
];
1007 /* fill the missing flash information */
1008 i
= __ffs(default_flash
.page_per_block
* default_flash
.page_size
);
1009 default_flash
.num_blocks
= type
->chipsize
<< (20 - i
);
1011 info
->oob_size
= (default_flash
.page_size
== 2048) ? 64 : 16;
1013 /* calculate addressing information */
1014 info
->col_addr_cycles
= (default_flash
.page_size
== 2048) ? 2 : 1;
1016 if (default_flash
.num_blocks
* default_flash
.page_per_block
> 65536)
1017 info
->row_addr_cycles
= 3;
1019 info
->row_addr_cycles
= 2;
1021 pxa3xx_nand_detect_timing(info
, &default_timing
);
1022 default_flash
.timing
= &default_timing
;
1027 static int pxa3xx_nand_detect_flash(struct pxa3xx_nand_info
*info
,
1028 const struct pxa3xx_nand_platform_data
*pdata
)
1030 const struct pxa3xx_nand_flash
*f
;
1034 if (pdata
->keep_config
)
1035 if (pxa3xx_nand_detect_config(info
) == 0)
1038 for (i
= 0; i
<pdata
->num_flash
; ++i
) {
1039 f
= pdata
->flash
+ i
;
1041 if (pxa3xx_nand_config_flash(info
, f
))
1044 if (__readid(info
, &id
))
1047 if (id
== f
->chip_id
)
1051 #ifdef CONFIG_MTD_NAND_PXA3xx_BUILTIN
1052 for (i
= 0; i
< ARRAY_SIZE(builtin_flash_types
); i
++) {
1054 f
= builtin_flash_types
[i
];
1056 if (pxa3xx_nand_config_flash(info
, f
))
1059 if (__readid(info
, &id
))
1062 if (id
== f
->chip_id
)
1067 dev_warn(&info
->pdev
->dev
,
1068 "failed to detect configured nand flash; found %04x instead of\n",
1073 /* the maximum possible buffer size for large page with OOB data
1074 * is: 2048 + 64 = 2112 bytes, allocate a page here for both the
1075 * data buffer and the DMA descriptor
1077 #define MAX_BUFF_SIZE PAGE_SIZE
1079 static int pxa3xx_nand_init_buff(struct pxa3xx_nand_info
*info
)
1081 struct platform_device
*pdev
= info
->pdev
;
1082 int data_desc_offset
= MAX_BUFF_SIZE
- sizeof(struct pxa_dma_desc
);
1085 info
->data_buff
= kmalloc(MAX_BUFF_SIZE
, GFP_KERNEL
);
1086 if (info
->data_buff
== NULL
)
1091 info
->data_buff
= dma_alloc_coherent(&pdev
->dev
, MAX_BUFF_SIZE
,
1092 &info
->data_buff_phys
, GFP_KERNEL
);
1093 if (info
->data_buff
== NULL
) {
1094 dev_err(&pdev
->dev
, "failed to allocate dma buffer\n");
1098 info
->data_buff_size
= MAX_BUFF_SIZE
;
1099 info
->data_desc
= (void *)info
->data_buff
+ data_desc_offset
;
1100 info
->data_desc_addr
= info
->data_buff_phys
+ data_desc_offset
;
1102 info
->data_dma_ch
= pxa_request_dma("nand-data", DMA_PRIO_LOW
,
1103 pxa3xx_nand_data_dma_irq
, info
);
1104 if (info
->data_dma_ch
< 0) {
1105 dev_err(&pdev
->dev
, "failed to request data dma\n");
1106 dma_free_coherent(&pdev
->dev
, info
->data_buff_size
,
1107 info
->data_buff
, info
->data_buff_phys
);
1108 return info
->data_dma_ch
;
1114 static struct nand_ecclayout hw_smallpage_ecclayout
= {
1116 .eccpos
= {8, 9, 10, 11, 12, 13 },
1117 .oobfree
= { {2, 6} }
1120 static struct nand_ecclayout hw_largepage_ecclayout
= {
1123 40, 41, 42, 43, 44, 45, 46, 47,
1124 48, 49, 50, 51, 52, 53, 54, 55,
1125 56, 57, 58, 59, 60, 61, 62, 63},
1126 .oobfree
= { {2, 38} }
1129 static void pxa3xx_nand_init_mtd(struct mtd_info
*mtd
,
1130 struct pxa3xx_nand_info
*info
)
1132 const struct pxa3xx_nand_flash
*f
= info
->flash_info
;
1133 struct nand_chip
*this = &info
->nand_chip
;
1135 this->options
= (f
->flash_width
== 16) ? NAND_BUSWIDTH_16
: 0;
1137 this->waitfunc
= pxa3xx_nand_waitfunc
;
1138 this->select_chip
= pxa3xx_nand_select_chip
;
1139 this->dev_ready
= pxa3xx_nand_dev_ready
;
1140 this->cmdfunc
= pxa3xx_nand_cmdfunc
;
1141 this->read_word
= pxa3xx_nand_read_word
;
1142 this->read_byte
= pxa3xx_nand_read_byte
;
1143 this->read_buf
= pxa3xx_nand_read_buf
;
1144 this->write_buf
= pxa3xx_nand_write_buf
;
1145 this->verify_buf
= pxa3xx_nand_verify_buf
;
1147 this->ecc
.mode
= NAND_ECC_HW
;
1148 this->ecc
.hwctl
= pxa3xx_nand_ecc_hwctl
;
1149 this->ecc
.calculate
= pxa3xx_nand_ecc_calculate
;
1150 this->ecc
.correct
= pxa3xx_nand_ecc_correct
;
1151 this->ecc
.size
= f
->page_size
;
1153 if (f
->page_size
== 2048)
1154 this->ecc
.layout
= &hw_largepage_ecclayout
;
1156 this->ecc
.layout
= &hw_smallpage_ecclayout
;
1158 this->chip_delay
= 25;
1161 static int pxa3xx_nand_probe(struct platform_device
*pdev
)
1163 struct pxa3xx_nand_platform_data
*pdata
;
1164 struct pxa3xx_nand_info
*info
;
1165 struct nand_chip
*this;
1166 struct mtd_info
*mtd
;
1170 pdata
= pdev
->dev
.platform_data
;
1173 dev_err(&pdev
->dev
, "no platform data defined\n");
1177 mtd
= kzalloc(sizeof(struct mtd_info
) + sizeof(struct pxa3xx_nand_info
),
1180 dev_err(&pdev
->dev
, "failed to allocate memory\n");
1184 info
= (struct pxa3xx_nand_info
*)(&mtd
[1]);
1187 this = &info
->nand_chip
;
1189 mtd
->owner
= THIS_MODULE
;
1191 info
->clk
= clk_get(&pdev
->dev
, NULL
);
1192 if (IS_ERR(info
->clk
)) {
1193 dev_err(&pdev
->dev
, "failed to get nand clock\n");
1194 ret
= PTR_ERR(info
->clk
);
1197 clk_enable(info
->clk
);
1199 r
= platform_get_resource(pdev
, IORESOURCE_DMA
, 0);
1201 dev_err(&pdev
->dev
, "no resource defined for data DMA\n");
1205 info
->drcmr_dat
= r
->start
;
1207 r
= platform_get_resource(pdev
, IORESOURCE_DMA
, 1);
1209 dev_err(&pdev
->dev
, "no resource defined for command DMA\n");
1213 info
->drcmr_cmd
= r
->start
;
1215 irq
= platform_get_irq(pdev
, 0);
1217 dev_err(&pdev
->dev
, "no IRQ resource defined\n");
1222 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1224 dev_err(&pdev
->dev
, "no IO memory resource defined\n");
1229 r
= request_mem_region(r
->start
, resource_size(r
), pdev
->name
);
1231 dev_err(&pdev
->dev
, "failed to request memory resource\n");
1236 info
->mmio_base
= ioremap(r
->start
, resource_size(r
));
1237 if (info
->mmio_base
== NULL
) {
1238 dev_err(&pdev
->dev
, "ioremap() failed\n");
1243 ret
= pxa3xx_nand_init_buff(info
);
1247 ret
= request_irq(IRQ_NAND
, pxa3xx_nand_irq
, IRQF_DISABLED
,
1250 dev_err(&pdev
->dev
, "failed to request IRQ\n");
1254 ret
= pxa3xx_nand_detect_flash(info
, pdata
);
1256 dev_err(&pdev
->dev
, "failed to detect flash\n");
1261 pxa3xx_nand_init_mtd(mtd
, info
);
1263 platform_set_drvdata(pdev
, mtd
);
1265 if (nand_scan(mtd
, 1)) {
1266 dev_err(&pdev
->dev
, "failed to scan nand\n");
1271 return add_mtd_partitions(mtd
, pdata
->parts
, pdata
->nr_parts
);
1274 free_irq(IRQ_NAND
, info
);
1277 pxa_free_dma(info
->data_dma_ch
);
1278 dma_free_coherent(&pdev
->dev
, info
->data_buff_size
,
1279 info
->data_buff
, info
->data_buff_phys
);
1281 kfree(info
->data_buff
);
1283 iounmap(info
->mmio_base
);
1285 release_mem_region(r
->start
, resource_size(r
));
1287 clk_disable(info
->clk
);
1294 static int pxa3xx_nand_remove(struct platform_device
*pdev
)
1296 struct mtd_info
*mtd
= platform_get_drvdata(pdev
);
1297 struct pxa3xx_nand_info
*info
= mtd
->priv
;
1300 platform_set_drvdata(pdev
, NULL
);
1302 del_mtd_device(mtd
);
1303 del_mtd_partitions(mtd
);
1304 free_irq(IRQ_NAND
, info
);
1306 pxa_free_dma(info
->data_dma_ch
);
1307 dma_free_writecombine(&pdev
->dev
, info
->data_buff_size
,
1308 info
->data_buff
, info
->data_buff_phys
);
1310 kfree(info
->data_buff
);
1312 iounmap(info
->mmio_base
);
1313 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1314 release_mem_region(r
->start
, resource_size(r
));
1316 clk_disable(info
->clk
);
1324 static int pxa3xx_nand_suspend(struct platform_device
*pdev
, pm_message_t state
)
1326 struct mtd_info
*mtd
= (struct mtd_info
*)platform_get_drvdata(pdev
);
1327 struct pxa3xx_nand_info
*info
= mtd
->priv
;
1329 if (info
->state
!= STATE_READY
) {
1330 dev_err(&pdev
->dev
, "driver busy, state = %d\n", info
->state
);
1337 static int pxa3xx_nand_resume(struct platform_device
*pdev
)
1339 struct mtd_info
*mtd
= (struct mtd_info
*)platform_get_drvdata(pdev
);
1340 struct pxa3xx_nand_info
*info
= mtd
->priv
;
1342 clk_enable(info
->clk
);
1344 return pxa3xx_nand_config_flash(info
, info
->flash_info
);
1347 #define pxa3xx_nand_suspend NULL
1348 #define pxa3xx_nand_resume NULL
1351 static struct platform_driver pxa3xx_nand_driver
= {
1353 .name
= "pxa3xx-nand",
1355 .probe
= pxa3xx_nand_probe
,
1356 .remove
= pxa3xx_nand_remove
,
1357 .suspend
= pxa3xx_nand_suspend
,
1358 .resume
= pxa3xx_nand_resume
,
1361 static int __init
pxa3xx_nand_init(void)
1363 return platform_driver_register(&pxa3xx_nand_driver
);
1365 module_init(pxa3xx_nand_init
);
1367 static void __exit
pxa3xx_nand_exit(void)
1369 platform_driver_unregister(&pxa3xx_nand_driver
);
1371 module_exit(pxa3xx_nand_exit
);
1373 MODULE_LICENSE("GPL");
1374 MODULE_DESCRIPTION("PXA3xx NAND controller driver");