2 * Samsung S3C64XX/S5PC1XX OneNAND driver
4 * Copyright © 2008-2010 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
6 * Marek Szyprowski <m.szyprowski@samsung.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 * S3C64XX: emulate the pseudo BufferRAM
17 #include <linux/module.h>
18 #include <linux/platform_device.h>
19 #include <linux/sched.h>
20 #include <linux/slab.h>
21 #include <linux/mtd/mtd.h>
22 #include <linux/mtd/onenand.h>
23 #include <linux/mtd/partitions.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/interrupt.h>
36 #define ONENAND_ERASE_STATUS 0x00
37 #define ONENAND_MULTI_ERASE_SET 0x01
38 #define ONENAND_ERASE_START 0x03
39 #define ONENAND_UNLOCK_START 0x08
40 #define ONENAND_UNLOCK_END 0x09
41 #define ONENAND_LOCK_START 0x0A
42 #define ONENAND_LOCK_END 0x0B
43 #define ONENAND_LOCK_TIGHT_START 0x0C
44 #define ONENAND_LOCK_TIGHT_END 0x0D
45 #define ONENAND_UNLOCK_ALL 0x0E
46 #define ONENAND_OTP_ACCESS 0x12
47 #define ONENAND_SPARE_ACCESS_ONLY 0x13
48 #define ONENAND_MAIN_ACCESS_ONLY 0x14
49 #define ONENAND_ERASE_VERIFY 0x15
50 #define ONENAND_MAIN_SPARE_ACCESS 0x16
51 #define ONENAND_PIPELINE_READ 0x4000
58 #define S3C64XX_CMD_MAP_SHIFT 24
60 #define S3C6400_FBA_SHIFT 10
61 #define S3C6400_FPA_SHIFT 4
62 #define S3C6400_FSA_SHIFT 2
64 #define S3C6410_FBA_SHIFT 12
65 #define S3C6410_FPA_SHIFT 6
66 #define S3C6410_FSA_SHIFT 4
68 /* S5PC110 specific definitions */
69 #define S5PC110_DMA_SRC_ADDR 0x400
70 #define S5PC110_DMA_SRC_CFG 0x404
71 #define S5PC110_DMA_DST_ADDR 0x408
72 #define S5PC110_DMA_DST_CFG 0x40C
73 #define S5PC110_DMA_TRANS_SIZE 0x414
74 #define S5PC110_DMA_TRANS_CMD 0x418
75 #define S5PC110_DMA_TRANS_STATUS 0x41C
76 #define S5PC110_DMA_TRANS_DIR 0x420
77 #define S5PC110_INTC_DMA_CLR 0x1004
78 #define S5PC110_INTC_ONENAND_CLR 0x1008
79 #define S5PC110_INTC_DMA_MASK 0x1024
80 #define S5PC110_INTC_ONENAND_MASK 0x1028
81 #define S5PC110_INTC_DMA_PEND 0x1044
82 #define S5PC110_INTC_ONENAND_PEND 0x1048
83 #define S5PC110_INTC_DMA_STATUS 0x1064
84 #define S5PC110_INTC_ONENAND_STATUS 0x1068
86 #define S5PC110_INTC_DMA_TD (1 << 24)
87 #define S5PC110_INTC_DMA_TE (1 << 16)
89 #define S5PC110_DMA_CFG_SINGLE (0x0 << 16)
90 #define S5PC110_DMA_CFG_4BURST (0x2 << 16)
91 #define S5PC110_DMA_CFG_8BURST (0x3 << 16)
92 #define S5PC110_DMA_CFG_16BURST (0x4 << 16)
94 #define S5PC110_DMA_CFG_INC (0x0 << 8)
95 #define S5PC110_DMA_CFG_CNT (0x1 << 8)
97 #define S5PC110_DMA_CFG_8BIT (0x0 << 0)
98 #define S5PC110_DMA_CFG_16BIT (0x1 << 0)
99 #define S5PC110_DMA_CFG_32BIT (0x2 << 0)
101 #define S5PC110_DMA_SRC_CFG_READ (S5PC110_DMA_CFG_16BURST | \
102 S5PC110_DMA_CFG_INC | \
103 S5PC110_DMA_CFG_16BIT)
104 #define S5PC110_DMA_DST_CFG_READ (S5PC110_DMA_CFG_16BURST | \
105 S5PC110_DMA_CFG_INC | \
106 S5PC110_DMA_CFG_32BIT)
107 #define S5PC110_DMA_SRC_CFG_WRITE (S5PC110_DMA_CFG_16BURST | \
108 S5PC110_DMA_CFG_INC | \
109 S5PC110_DMA_CFG_32BIT)
110 #define S5PC110_DMA_DST_CFG_WRITE (S5PC110_DMA_CFG_16BURST | \
111 S5PC110_DMA_CFG_INC | \
112 S5PC110_DMA_CFG_16BIT)
114 #define S5PC110_DMA_TRANS_CMD_TDC (0x1 << 18)
115 #define S5PC110_DMA_TRANS_CMD_TEC (0x1 << 16)
116 #define S5PC110_DMA_TRANS_CMD_TR (0x1 << 0)
118 #define S5PC110_DMA_TRANS_STATUS_TD (0x1 << 18)
119 #define S5PC110_DMA_TRANS_STATUS_TB (0x1 << 17)
120 #define S5PC110_DMA_TRANS_STATUS_TE (0x1 << 16)
122 #define S5PC110_DMA_DIR_READ 0x0
123 #define S5PC110_DMA_DIR_WRITE 0x1
126 struct mtd_info
*mtd
;
127 struct platform_device
*pdev
;
130 void __iomem
*ahb_addr
;
134 unsigned int (*mem_addr
)(int fba
, int fpa
, int fsa
);
135 unsigned int (*cmd_map
)(unsigned int type
, unsigned int val
);
136 void __iomem
*dma_addr
;
137 unsigned long phys_base
;
138 struct completion complete
;
141 #define CMD_MAP_00(dev, addr) (dev->cmd_map(MAP_00, ((addr) << 1)))
142 #define CMD_MAP_01(dev, mem_addr) (dev->cmd_map(MAP_01, (mem_addr)))
143 #define CMD_MAP_10(dev, mem_addr) (dev->cmd_map(MAP_10, (mem_addr)))
144 #define CMD_MAP_11(dev, addr) (dev->cmd_map(MAP_11, ((addr) << 2)))
146 static struct s3c_onenand
*onenand
;
148 static inline int s3c_read_reg(int offset
)
150 return readl(onenand
->base
+ offset
);
153 static inline void s3c_write_reg(int value
, int offset
)
155 writel(value
, onenand
->base
+ offset
);
158 static inline int s3c_read_cmd(unsigned int cmd
)
160 return readl(onenand
->ahb_addr
+ cmd
);
163 static inline void s3c_write_cmd(int value
, unsigned int cmd
)
165 writel(value
, onenand
->ahb_addr
+ cmd
);
169 static void s3c_dump_reg(void)
173 for (i
= 0; i
< 0x400; i
+= 0x40) {
174 printk(KERN_INFO
"0x%08X: 0x%08x 0x%08x 0x%08x 0x%08x\n",
175 (unsigned int) onenand
->base
+ i
,
176 s3c_read_reg(i
), s3c_read_reg(i
+ 0x10),
177 s3c_read_reg(i
+ 0x20), s3c_read_reg(i
+ 0x30));
182 static unsigned int s3c64xx_cmd_map(unsigned type
, unsigned val
)
184 return (type
<< S3C64XX_CMD_MAP_SHIFT
) | val
;
187 static unsigned int s3c6400_mem_addr(int fba
, int fpa
, int fsa
)
189 return (fba
<< S3C6400_FBA_SHIFT
) | (fpa
<< S3C6400_FPA_SHIFT
) |
190 (fsa
<< S3C6400_FSA_SHIFT
);
193 static unsigned int s3c6410_mem_addr(int fba
, int fpa
, int fsa
)
195 return (fba
<< S3C6410_FBA_SHIFT
) | (fpa
<< S3C6410_FPA_SHIFT
) |
196 (fsa
<< S3C6410_FSA_SHIFT
);
199 static void s3c_onenand_reset(void)
201 unsigned long timeout
= 0x10000;
204 s3c_write_reg(ONENAND_MEM_RESET_COLD
, MEM_RESET_OFFSET
);
205 while (1 && timeout
--) {
206 stat
= s3c_read_reg(INT_ERR_STAT_OFFSET
);
210 stat
= s3c_read_reg(INT_ERR_STAT_OFFSET
);
211 s3c_write_reg(stat
, INT_ERR_ACK_OFFSET
);
213 /* Clear interrupt */
214 s3c_write_reg(0x0, INT_ERR_ACK_OFFSET
);
215 /* Clear the ECC status */
216 s3c_write_reg(0x0, ECC_ERR_STAT_OFFSET
);
219 static unsigned short s3c_onenand_readw(void __iomem
*addr
)
221 struct onenand_chip
*this = onenand
->mtd
->priv
;
222 struct device
*dev
= &onenand
->pdev
->dev
;
223 int reg
= addr
- this->base
;
224 int word_addr
= reg
>> 1;
227 /* It's used for probing time */
229 case ONENAND_REG_MANUFACTURER_ID
:
230 return s3c_read_reg(MANUFACT_ID_OFFSET
);
231 case ONENAND_REG_DEVICE_ID
:
232 return s3c_read_reg(DEVICE_ID_OFFSET
);
233 case ONENAND_REG_VERSION_ID
:
234 return s3c_read_reg(FLASH_VER_ID_OFFSET
);
235 case ONENAND_REG_DATA_BUFFER_SIZE
:
236 return s3c_read_reg(DATA_BUF_SIZE_OFFSET
);
237 case ONENAND_REG_TECHNOLOGY
:
238 return s3c_read_reg(TECH_OFFSET
);
239 case ONENAND_REG_SYS_CFG1
:
240 return s3c_read_reg(MEM_CFG_OFFSET
);
242 /* Used at unlock all status */
243 case ONENAND_REG_CTRL_STATUS
:
246 case ONENAND_REG_WP_STATUS
:
247 return ONENAND_WP_US
;
253 /* BootRAM access control */
254 if ((unsigned int) addr
< ONENAND_DATARAM
&& onenand
->bootram_command
) {
256 return s3c_read_reg(MANUFACT_ID_OFFSET
);
258 return s3c_read_reg(DEVICE_ID_OFFSET
);
260 return s3c_read_reg(FLASH_VER_ID_OFFSET
);
263 value
= s3c_read_cmd(CMD_MAP_11(onenand
, word_addr
)) & 0xffff;
264 dev_info(dev
, "%s: Illegal access at reg 0x%x, value 0x%x\n", __func__
,
269 static void s3c_onenand_writew(unsigned short value
, void __iomem
*addr
)
271 struct onenand_chip
*this = onenand
->mtd
->priv
;
272 struct device
*dev
= &onenand
->pdev
->dev
;
273 unsigned int reg
= addr
- this->base
;
274 unsigned int word_addr
= reg
>> 1;
276 /* It's used for probing time */
278 case ONENAND_REG_SYS_CFG1
:
279 s3c_write_reg(value
, MEM_CFG_OFFSET
);
282 case ONENAND_REG_START_ADDRESS1
:
283 case ONENAND_REG_START_ADDRESS2
:
286 /* Lock/lock-tight/unlock/unlock_all */
287 case ONENAND_REG_START_BLOCK_ADDRESS
:
294 /* BootRAM access control */
295 if ((unsigned int)addr
< ONENAND_DATARAM
) {
296 if (value
== ONENAND_CMD_READID
) {
297 onenand
->bootram_command
= 1;
300 if (value
== ONENAND_CMD_RESET
) {
301 s3c_write_reg(ONENAND_MEM_RESET_COLD
, MEM_RESET_OFFSET
);
302 onenand
->bootram_command
= 0;
307 dev_info(dev
, "%s: Illegal access at reg 0x%x, value 0x%x\n", __func__
,
310 s3c_write_cmd(value
, CMD_MAP_11(onenand
, word_addr
));
313 static int s3c_onenand_wait(struct mtd_info
*mtd
, int state
)
315 struct device
*dev
= &onenand
->pdev
->dev
;
316 unsigned int flags
= INT_ACT
;
317 unsigned int stat
, ecc
;
318 unsigned long timeout
;
322 flags
|= BLK_RW_CMP
| LOAD_CMP
;
325 flags
|= BLK_RW_CMP
| PGM_CMP
;
328 flags
|= BLK_RW_CMP
| ERS_CMP
;
337 /* The 20 msec is enough */
338 timeout
= jiffies
+ msecs_to_jiffies(20);
339 while (time_before(jiffies
, timeout
)) {
340 stat
= s3c_read_reg(INT_ERR_STAT_OFFSET
);
344 if (state
!= FL_READING
)
347 /* To get correct interrupt status in timeout case */
348 stat
= s3c_read_reg(INT_ERR_STAT_OFFSET
);
349 s3c_write_reg(stat
, INT_ERR_ACK_OFFSET
);
352 * In the Spec. it checks the controller status first
353 * However if you get the correct information in case of
354 * power off recovery (POR) test, it should read ECC status first
356 if (stat
& LOAD_CMP
) {
357 ecc
= s3c_read_reg(ECC_ERR_STAT_OFFSET
);
358 if (ecc
& ONENAND_ECC_4BIT_UNCORRECTABLE
) {
359 dev_info(dev
, "%s: ECC error = 0x%04x\n", __func__
,
361 mtd
->ecc_stats
.failed
++;
366 if (stat
& (LOCKED_BLK
| ERS_FAIL
| PGM_FAIL
| LD_FAIL_ECC_ERR
)) {
367 dev_info(dev
, "%s: controller error = 0x%04x\n", __func__
,
369 if (stat
& LOCKED_BLK
)
370 dev_info(dev
, "%s: it's locked error = 0x%04x\n",
379 static int s3c_onenand_command(struct mtd_info
*mtd
, int cmd
, loff_t addr
,
382 struct onenand_chip
*this = mtd
->priv
;
384 int fba
, fpa
, fsa
= 0;
385 unsigned int mem_addr
, cmd_map_01
, cmd_map_10
;
386 int i
, mcount
, scount
;
389 fba
= (int) (addr
>> this->erase_shift
);
390 fpa
= (int) (addr
>> this->page_shift
);
391 fpa
&= this->page_mask
;
393 mem_addr
= onenand
->mem_addr(fba
, fpa
, fsa
);
394 cmd_map_01
= CMD_MAP_01(onenand
, mem_addr
);
395 cmd_map_10
= CMD_MAP_10(onenand
, mem_addr
);
398 case ONENAND_CMD_READ
:
399 case ONENAND_CMD_READOOB
:
400 case ONENAND_CMD_BUFFERRAM
:
401 ONENAND_SET_NEXT_BUFFERRAM(this);
406 index
= ONENAND_CURRENT_BUFFERRAM(this);
409 * Emulate Two BufferRAMs and access with 4 bytes pointer
411 m
= onenand
->page_buf
;
412 s
= onenand
->oob_buf
;
415 m
+= (this->writesize
>> 2);
416 s
+= (mtd
->oobsize
>> 2);
419 mcount
= mtd
->writesize
>> 2;
420 scount
= mtd
->oobsize
>> 2;
423 case ONENAND_CMD_READ
:
425 for (i
= 0; i
< mcount
; i
++)
426 *m
++ = s3c_read_cmd(cmd_map_01
);
429 case ONENAND_CMD_READOOB
:
430 s3c_write_reg(TSRF
, TRANS_SPARE_OFFSET
);
432 for (i
= 0; i
< mcount
; i
++)
433 *m
++ = s3c_read_cmd(cmd_map_01
);
436 for (i
= 0; i
< scount
; i
++)
437 *s
++ = s3c_read_cmd(cmd_map_01
);
439 s3c_write_reg(0, TRANS_SPARE_OFFSET
);
442 case ONENAND_CMD_PROG
:
444 for (i
= 0; i
< mcount
; i
++)
445 s3c_write_cmd(*m
++, cmd_map_01
);
448 case ONENAND_CMD_PROGOOB
:
449 s3c_write_reg(TSRF
, TRANS_SPARE_OFFSET
);
451 /* Main - dummy write */
452 for (i
= 0; i
< mcount
; i
++)
453 s3c_write_cmd(0xffffffff, cmd_map_01
);
456 for (i
= 0; i
< scount
; i
++)
457 s3c_write_cmd(*s
++, cmd_map_01
);
459 s3c_write_reg(0, TRANS_SPARE_OFFSET
);
462 case ONENAND_CMD_UNLOCK_ALL
:
463 s3c_write_cmd(ONENAND_UNLOCK_ALL
, cmd_map_10
);
466 case ONENAND_CMD_ERASE
:
467 s3c_write_cmd(ONENAND_ERASE_START
, cmd_map_10
);
477 static unsigned char *s3c_get_bufferram(struct mtd_info
*mtd
, int area
)
479 struct onenand_chip
*this = mtd
->priv
;
480 int index
= ONENAND_CURRENT_BUFFERRAM(this);
483 if (area
== ONENAND_DATARAM
) {
484 p
= onenand
->page_buf
;
486 p
+= this->writesize
;
488 p
= onenand
->oob_buf
;
496 static int onenand_read_bufferram(struct mtd_info
*mtd
, int area
,
497 unsigned char *buffer
, int offset
,
502 p
= s3c_get_bufferram(mtd
, area
);
503 memcpy(buffer
, p
+ offset
, count
);
507 static int onenand_write_bufferram(struct mtd_info
*mtd
, int area
,
508 const unsigned char *buffer
, int offset
,
513 p
= s3c_get_bufferram(mtd
, area
);
514 memcpy(p
+ offset
, buffer
, count
);
518 static int (*s5pc110_dma_ops
)(dma_addr_t dst
, dma_addr_t src
, size_t count
, int direction
);
520 static int s5pc110_dma_poll(dma_addr_t dst
, dma_addr_t src
, size_t count
, int direction
)
522 void __iomem
*base
= onenand
->dma_addr
;
524 unsigned long timeout
;
526 writel(src
, base
+ S5PC110_DMA_SRC_ADDR
);
527 writel(dst
, base
+ S5PC110_DMA_DST_ADDR
);
529 if (direction
== S5PC110_DMA_DIR_READ
) {
530 writel(S5PC110_DMA_SRC_CFG_READ
, base
+ S5PC110_DMA_SRC_CFG
);
531 writel(S5PC110_DMA_DST_CFG_READ
, base
+ S5PC110_DMA_DST_CFG
);
533 writel(S5PC110_DMA_SRC_CFG_WRITE
, base
+ S5PC110_DMA_SRC_CFG
);
534 writel(S5PC110_DMA_DST_CFG_WRITE
, base
+ S5PC110_DMA_DST_CFG
);
537 writel(count
, base
+ S5PC110_DMA_TRANS_SIZE
);
538 writel(direction
, base
+ S5PC110_DMA_TRANS_DIR
);
540 writel(S5PC110_DMA_TRANS_CMD_TR
, base
+ S5PC110_DMA_TRANS_CMD
);
543 * There's no exact timeout values at Spec.
544 * In real case it takes under 1 msec.
545 * So 20 msecs are enough.
547 timeout
= jiffies
+ msecs_to_jiffies(20);
550 status
= readl(base
+ S5PC110_DMA_TRANS_STATUS
);
551 if (status
& S5PC110_DMA_TRANS_STATUS_TE
) {
552 writel(S5PC110_DMA_TRANS_CMD_TEC
,
553 base
+ S5PC110_DMA_TRANS_CMD
);
556 } while (!(status
& S5PC110_DMA_TRANS_STATUS_TD
) &&
557 time_before(jiffies
, timeout
));
559 writel(S5PC110_DMA_TRANS_CMD_TDC
, base
+ S5PC110_DMA_TRANS_CMD
);
564 static irqreturn_t
s5pc110_onenand_irq(int irq
, void *data
)
566 void __iomem
*base
= onenand
->dma_addr
;
569 status
= readl(base
+ S5PC110_INTC_DMA_STATUS
);
571 if (likely(status
& S5PC110_INTC_DMA_TD
))
572 cmd
= S5PC110_DMA_TRANS_CMD_TDC
;
574 if (unlikely(status
& S5PC110_INTC_DMA_TE
))
575 cmd
= S5PC110_DMA_TRANS_CMD_TEC
;
577 writel(cmd
, base
+ S5PC110_DMA_TRANS_CMD
);
578 writel(status
, base
+ S5PC110_INTC_DMA_CLR
);
580 if (!onenand
->complete
.done
)
581 complete(&onenand
->complete
);
586 static int s5pc110_dma_irq(dma_addr_t dst
, dma_addr_t src
, size_t count
, int direction
)
588 void __iomem
*base
= onenand
->dma_addr
;
591 status
= readl(base
+ S5PC110_INTC_DMA_MASK
);
593 status
&= ~(S5PC110_INTC_DMA_TD
| S5PC110_INTC_DMA_TE
);
594 writel(status
, base
+ S5PC110_INTC_DMA_MASK
);
597 writel(src
, base
+ S5PC110_DMA_SRC_ADDR
);
598 writel(dst
, base
+ S5PC110_DMA_DST_ADDR
);
600 if (direction
== S5PC110_DMA_DIR_READ
) {
601 writel(S5PC110_DMA_SRC_CFG_READ
, base
+ S5PC110_DMA_SRC_CFG
);
602 writel(S5PC110_DMA_DST_CFG_READ
, base
+ S5PC110_DMA_DST_CFG
);
604 writel(S5PC110_DMA_SRC_CFG_WRITE
, base
+ S5PC110_DMA_SRC_CFG
);
605 writel(S5PC110_DMA_DST_CFG_WRITE
, base
+ S5PC110_DMA_DST_CFG
);
608 writel(count
, base
+ S5PC110_DMA_TRANS_SIZE
);
609 writel(direction
, base
+ S5PC110_DMA_TRANS_DIR
);
611 writel(S5PC110_DMA_TRANS_CMD_TR
, base
+ S5PC110_DMA_TRANS_CMD
);
613 wait_for_completion_timeout(&onenand
->complete
, msecs_to_jiffies(20));
618 static int s5pc110_read_bufferram(struct mtd_info
*mtd
, int area
,
619 unsigned char *buffer
, int offset
, size_t count
)
621 struct onenand_chip
*this = mtd
->priv
;
623 void *buf
= (void *) buffer
;
624 dma_addr_t dma_src
, dma_dst
;
625 int err
, ofs
, page_dma
= 0;
626 struct device
*dev
= &onenand
->pdev
->dev
;
628 p
= this->base
+ area
;
629 if (ONENAND_CURRENT_BUFFERRAM(this)) {
630 if (area
== ONENAND_DATARAM
)
631 p
+= this->writesize
;
636 if (offset
& 3 || (size_t) buf
& 3 ||
637 !onenand
->dma_addr
|| count
!= mtd
->writesize
)
640 /* Handle vmalloc address */
641 if (buf
>= high_memory
) {
644 if (((size_t) buf
& PAGE_MASK
) !=
645 ((size_t) (buf
+ count
- 1) & PAGE_MASK
))
647 page
= vmalloc_to_page(buf
);
652 ofs
= ((size_t) buf
& ~PAGE_MASK
);
656 dma_src
= onenand
->phys_base
+ (p
- this->base
);
657 dma_dst
= dma_map_page(dev
, page
, ofs
, count
, DMA_FROM_DEVICE
);
660 dma_src
= onenand
->phys_base
+ (p
- this->base
);
661 dma_dst
= dma_map_single(dev
, buf
, count
, DMA_FROM_DEVICE
);
663 if (dma_mapping_error(dev
, dma_dst
)) {
664 dev_err(dev
, "Couldn't map a %d byte buffer for DMA\n", count
);
667 err
= s5pc110_dma_ops(dma_dst
, dma_src
,
668 count
, S5PC110_DMA_DIR_READ
);
671 dma_unmap_page(dev
, dma_dst
, count
, DMA_FROM_DEVICE
);
673 dma_unmap_single(dev
, dma_dst
, count
, DMA_FROM_DEVICE
);
679 if (count
!= mtd
->writesize
) {
680 /* Copy the bufferram to memory to prevent unaligned access */
681 memcpy(this->page_buf
, p
, mtd
->writesize
);
682 p
= this->page_buf
+ offset
;
685 memcpy(buffer
, p
, count
);
690 static int s5pc110_chip_probe(struct mtd_info
*mtd
)
692 /* Now just return 0 */
696 static int s3c_onenand_bbt_wait(struct mtd_info
*mtd
, int state
)
698 unsigned int flags
= INT_ACT
| LOAD_CMP
;
700 unsigned long timeout
;
702 /* The 20 msec is enough */
703 timeout
= jiffies
+ msecs_to_jiffies(20);
704 while (time_before(jiffies
, timeout
)) {
705 stat
= s3c_read_reg(INT_ERR_STAT_OFFSET
);
709 /* To get correct interrupt status in timeout case */
710 stat
= s3c_read_reg(INT_ERR_STAT_OFFSET
);
711 s3c_write_reg(stat
, INT_ERR_ACK_OFFSET
);
713 if (stat
& LD_FAIL_ECC_ERR
) {
715 return ONENAND_BBT_READ_ERROR
;
718 if (stat
& LOAD_CMP
) {
719 int ecc
= s3c_read_reg(ECC_ERR_STAT_OFFSET
);
720 if (ecc
& ONENAND_ECC_4BIT_UNCORRECTABLE
) {
722 return ONENAND_BBT_READ_ERROR
;
729 static void s3c_onenand_check_lock_status(struct mtd_info
*mtd
)
731 struct onenand_chip
*this = mtd
->priv
;
732 struct device
*dev
= &onenand
->pdev
->dev
;
733 unsigned int block
, end
;
736 end
= this->chipsize
>> this->erase_shift
;
738 for (block
= 0; block
< end
; block
++) {
739 unsigned int mem_addr
= onenand
->mem_addr(block
, 0, 0);
740 tmp
= s3c_read_cmd(CMD_MAP_01(onenand
, mem_addr
));
742 if (s3c_read_reg(INT_ERR_STAT_OFFSET
) & LOCKED_BLK
) {
743 dev_err(dev
, "block %d is write-protected!\n", block
);
744 s3c_write_reg(LOCKED_BLK
, INT_ERR_ACK_OFFSET
);
749 static void s3c_onenand_do_lock_cmd(struct mtd_info
*mtd
, loff_t ofs
,
752 struct onenand_chip
*this = mtd
->priv
;
753 int start
, end
, start_mem_addr
, end_mem_addr
;
755 start
= ofs
>> this->erase_shift
;
756 start_mem_addr
= onenand
->mem_addr(start
, 0, 0);
757 end
= start
+ (len
>> this->erase_shift
) - 1;
758 end_mem_addr
= onenand
->mem_addr(end
, 0, 0);
760 if (cmd
== ONENAND_CMD_LOCK
) {
761 s3c_write_cmd(ONENAND_LOCK_START
, CMD_MAP_10(onenand
,
763 s3c_write_cmd(ONENAND_LOCK_END
, CMD_MAP_10(onenand
,
766 s3c_write_cmd(ONENAND_UNLOCK_START
, CMD_MAP_10(onenand
,
768 s3c_write_cmd(ONENAND_UNLOCK_END
, CMD_MAP_10(onenand
,
772 this->wait(mtd
, FL_LOCKING
);
775 static void s3c_unlock_all(struct mtd_info
*mtd
)
777 struct onenand_chip
*this = mtd
->priv
;
779 size_t len
= this->chipsize
;
781 if (this->options
& ONENAND_HAS_UNLOCK_ALL
) {
782 /* Write unlock command */
783 this->command(mtd
, ONENAND_CMD_UNLOCK_ALL
, 0, 0);
785 /* No need to check return value */
786 this->wait(mtd
, FL_LOCKING
);
788 /* Workaround for all block unlock in DDP */
789 if (!ONENAND_IS_DDP(this)) {
790 s3c_onenand_check_lock_status(mtd
);
794 /* All blocks on another chip */
795 ofs
= this->chipsize
>> 1;
796 len
= this->chipsize
>> 1;
799 s3c_onenand_do_lock_cmd(mtd
, ofs
, len
, ONENAND_CMD_UNLOCK
);
801 s3c_onenand_check_lock_status(mtd
);
804 static void s3c_onenand_setup(struct mtd_info
*mtd
)
806 struct onenand_chip
*this = mtd
->priv
;
810 if (onenand
->type
== TYPE_S3C6400
) {
811 onenand
->mem_addr
= s3c6400_mem_addr
;
812 onenand
->cmd_map
= s3c64xx_cmd_map
;
813 } else if (onenand
->type
== TYPE_S3C6410
) {
814 onenand
->mem_addr
= s3c6410_mem_addr
;
815 onenand
->cmd_map
= s3c64xx_cmd_map
;
816 } else if (onenand
->type
== TYPE_S5PC110
) {
817 /* Use generic onenand functions */
818 this->read_bufferram
= s5pc110_read_bufferram
;
819 this->chip_probe
= s5pc110_chip_probe
;
825 this->read_word
= s3c_onenand_readw
;
826 this->write_word
= s3c_onenand_writew
;
828 this->wait
= s3c_onenand_wait
;
829 this->bbt_wait
= s3c_onenand_bbt_wait
;
830 this->unlock_all
= s3c_unlock_all
;
831 this->command
= s3c_onenand_command
;
833 this->read_bufferram
= onenand_read_bufferram
;
834 this->write_bufferram
= onenand_write_bufferram
;
837 static int s3c_onenand_probe(struct platform_device
*pdev
)
839 struct onenand_platform_data
*pdata
;
840 struct onenand_chip
*this;
841 struct mtd_info
*mtd
;
845 pdata
= dev_get_platdata(&pdev
->dev
);
846 /* No need to check pdata. the platform data is optional */
848 size
= sizeof(struct mtd_info
) + sizeof(struct onenand_chip
);
849 mtd
= devm_kzalloc(&pdev
->dev
, size
, GFP_KERNEL
);
853 onenand
= devm_kzalloc(&pdev
->dev
, sizeof(struct s3c_onenand
),
858 this = (struct onenand_chip
*) &mtd
[1];
860 mtd
->dev
.parent
= &pdev
->dev
;
861 onenand
->pdev
= pdev
;
862 onenand
->type
= platform_get_device_id(pdev
)->driver_data
;
864 s3c_onenand_setup(mtd
);
866 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
867 onenand
->base
= devm_ioremap_resource(&pdev
->dev
, r
);
868 if (IS_ERR(onenand
->base
))
869 return PTR_ERR(onenand
->base
);
871 onenand
->phys_base
= r
->start
;
873 /* Set onenand_chip also */
874 this->base
= onenand
->base
;
876 /* Use runtime badblock check */
877 this->options
|= ONENAND_SKIP_UNLOCK_CHECK
;
879 if (onenand
->type
!= TYPE_S5PC110
) {
880 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 1);
881 onenand
->ahb_addr
= devm_ioremap_resource(&pdev
->dev
, r
);
882 if (IS_ERR(onenand
->ahb_addr
))
883 return PTR_ERR(onenand
->ahb_addr
);
885 /* Allocate 4KiB BufferRAM */
886 onenand
->page_buf
= devm_kzalloc(&pdev
->dev
, SZ_4K
,
888 if (!onenand
->page_buf
)
891 /* Allocate 128 SpareRAM */
892 onenand
->oob_buf
= devm_kzalloc(&pdev
->dev
, 128, GFP_KERNEL
);
893 if (!onenand
->oob_buf
)
896 /* S3C doesn't handle subpage write */
897 mtd
->subpage_sft
= 0;
898 this->subpagesize
= mtd
->writesize
;
900 } else { /* S5PC110 */
901 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 1);
902 onenand
->dma_addr
= devm_ioremap_resource(&pdev
->dev
, r
);
903 if (IS_ERR(onenand
->dma_addr
))
904 return PTR_ERR(onenand
->dma_addr
);
906 s5pc110_dma_ops
= s5pc110_dma_poll
;
907 /* Interrupt support */
908 r
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
910 init_completion(&onenand
->complete
);
911 s5pc110_dma_ops
= s5pc110_dma_irq
;
912 err
= devm_request_irq(&pdev
->dev
, r
->start
,
914 IRQF_SHARED
, "onenand",
917 dev_err(&pdev
->dev
, "failed to get irq\n");
923 err
= onenand_scan(mtd
, 1);
927 if (onenand
->type
!= TYPE_S5PC110
) {
928 /* S3C doesn't handle subpage write */
929 mtd
->subpage_sft
= 0;
930 this->subpagesize
= mtd
->writesize
;
933 if (s3c_read_reg(MEM_CFG_OFFSET
) & ONENAND_SYS_CFG1_SYNC_READ
)
934 dev_info(&onenand
->pdev
->dev
, "OneNAND Sync. Burst Read enabled\n");
936 err
= mtd_device_parse_register(mtd
, NULL
, NULL
,
937 pdata
? pdata
->parts
: NULL
,
938 pdata
? pdata
->nr_parts
: 0);
940 dev_err(&pdev
->dev
, "failed to parse partitions and register the MTD device\n");
941 onenand_release(mtd
);
945 platform_set_drvdata(pdev
, mtd
);
950 static int s3c_onenand_remove(struct platform_device
*pdev
)
952 struct mtd_info
*mtd
= platform_get_drvdata(pdev
);
954 onenand_release(mtd
);
959 static int s3c_pm_ops_suspend(struct device
*dev
)
961 struct platform_device
*pdev
= to_platform_device(dev
);
962 struct mtd_info
*mtd
= platform_get_drvdata(pdev
);
963 struct onenand_chip
*this = mtd
->priv
;
965 this->wait(mtd
, FL_PM_SUSPENDED
);
969 static int s3c_pm_ops_resume(struct device
*dev
)
971 struct platform_device
*pdev
= to_platform_device(dev
);
972 struct mtd_info
*mtd
= platform_get_drvdata(pdev
);
973 struct onenand_chip
*this = mtd
->priv
;
975 this->unlock_all(mtd
);
979 static const struct dev_pm_ops s3c_pm_ops
= {
980 .suspend
= s3c_pm_ops_suspend
,
981 .resume
= s3c_pm_ops_resume
,
984 static const struct platform_device_id s3c_onenand_driver_ids
[] = {
986 .name
= "s3c6400-onenand",
987 .driver_data
= TYPE_S3C6400
,
989 .name
= "s3c6410-onenand",
990 .driver_data
= TYPE_S3C6410
,
992 .name
= "s5pc110-onenand",
993 .driver_data
= TYPE_S5PC110
,
996 MODULE_DEVICE_TABLE(platform
, s3c_onenand_driver_ids
);
998 static struct platform_driver s3c_onenand_driver
= {
1000 .name
= "samsung-onenand",
1003 .id_table
= s3c_onenand_driver_ids
,
1004 .probe
= s3c_onenand_probe
,
1005 .remove
= s3c_onenand_remove
,
1008 module_platform_driver(s3c_onenand_driver
);
1010 MODULE_LICENSE("GPL");
1011 MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
1012 MODULE_DESCRIPTION("Samsung OneNAND controller support");