1 /* linux/drivers/mtd/nand/s3c2410.c
3 * Copyright (c) 2004,2005 Simtec Electronics
4 * http://www.simtec.co.uk/products/SWLINUX/
5 * Ben Dooks <ben@simtec.co.uk>
7 * Samsung S3C2410/S3C240 NAND driver
10 * 21-Sep-2004 BJD Initial version
11 * 23-Sep-2004 BJD Mulitple device support
12 * 28-Sep-2004 BJD Fixed ECC placement for Hardware mode
13 * 12-Oct-2004 BJD Fixed errors in use of platform data
14 * 18-Feb-2005 BJD Fix sparse errors
15 * 14-Mar-2005 BJD Applied tglx's code reduction patch
16 * 02-May-2005 BJD Fixed s3c2440 support
17 * 02-May-2005 BJD Reduced hwcontrol decode
18 * 20-Jun-2005 BJD Updated s3c2440 support, fixed timing bug
19 * 08-Jul-2005 BJD Fix OOPS when no platform data supplied
20 * 20-Oct-2005 BJD Fix timing calculation bug
22 * $Id: s3c2410.c,v 1.20 2005/11/07 11:14:31 gleixner Exp $
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation; either version 2 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program; if not, write to the Free Software
36 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
39 #include <config/mtd/nand/s3c2410/hwecc.h>
40 #include <config/mtd/nand/s3c2410/debug.h>
42 #ifdef CONFIG_MTD_NAND_S3C2410_DEBUG
46 #include <linux/module.h>
47 #include <linux/types.h>
48 #include <linux/init.h>
49 #include <linux/kernel.h>
50 #include <linux/string.h>
51 #include <linux/ioport.h>
52 #include <linux/platform_device.h>
53 #include <linux/delay.h>
54 #include <linux/err.h>
55 #include <linux/slab.h>
56 #include <linux/clk.h>
58 #include <linux/mtd/mtd.h>
59 #include <linux/mtd/nand.h>
60 #include <linux/mtd/nand_ecc.h>
61 #include <linux/mtd/partitions.h>
65 #include <asm/arch/regs-nand.h>
66 #include <asm/arch/nand.h>
68 #define PFX "s3c2410-nand: "
70 #ifdef CONFIG_MTD_NAND_S3C2410_HWECC
71 static int hardware_ecc
= 1;
73 static int hardware_ecc
= 0;
76 /* new oob placement block for use with hardware ecc generation
79 static struct nand_ecclayout nand_hw_eccoob
= {
85 /* controller and mtd information */
87 struct s3c2410_nand_info
;
89 struct s3c2410_nand_mtd
{
91 struct nand_chip chip
;
92 struct s3c2410_nand_set
*set
;
93 struct s3c2410_nand_info
*info
;
97 /* overview of the s3c2410 nand state */
99 struct s3c2410_nand_info
{
101 struct nand_hw_control controller
;
102 struct s3c2410_nand_mtd
*mtds
;
103 struct s3c2410_platform_nand
*platform
;
106 struct device
*device
;
107 struct resource
*area
;
112 unsigned char is_s3c2440
;
115 /* conversion functions */
117 static struct s3c2410_nand_mtd
*s3c2410_nand_mtd_toours(struct mtd_info
*mtd
)
119 return container_of(mtd
, struct s3c2410_nand_mtd
, mtd
);
122 static struct s3c2410_nand_info
*s3c2410_nand_mtd_toinfo(struct mtd_info
*mtd
)
124 return s3c2410_nand_mtd_toours(mtd
)->info
;
127 static struct s3c2410_nand_info
*to_nand_info(struct platform_device
*dev
)
129 return platform_get_drvdata(dev
);
132 static struct s3c2410_platform_nand
*to_nand_plat(struct platform_device
*dev
)
134 return dev
->dev
.platform_data
;
137 /* timing calculations */
139 #define NS_IN_KHZ 1000000
141 static int s3c2410_nand_calc_rate(int wanted
, unsigned long clk
, int max
)
145 result
= (wanted
* clk
) / NS_IN_KHZ
;
148 pr_debug("result %d from %ld, %d\n", result
, clk
, wanted
);
151 printk("%d ns is too big for current clock rate %ld\n", wanted
, clk
);
161 #define to_ns(ticks,clk) (((ticks) * NS_IN_KHZ) / (unsigned int)(clk))
163 /* controller setup */
165 static int s3c2410_nand_inithw(struct s3c2410_nand_info
*info
, struct platform_device
*pdev
)
167 struct s3c2410_platform_nand
*plat
= to_nand_plat(pdev
);
168 unsigned long clkrate
= clk_get_rate(info
->clk
);
169 int tacls
, twrph0
, twrph1
;
172 /* calculate the timing information for the controller */
174 clkrate
/= 1000; /* turn clock into kHz for ease of use */
177 tacls
= s3c2410_nand_calc_rate(plat
->tacls
, clkrate
, 4);
178 twrph0
= s3c2410_nand_calc_rate(plat
->twrph0
, clkrate
, 8);
179 twrph1
= s3c2410_nand_calc_rate(plat
->twrph1
, clkrate
, 8);
181 /* default timings */
187 if (tacls
< 0 || twrph0
< 0 || twrph1
< 0) {
188 printk(KERN_ERR PFX
"cannot get timings suitable for board\n");
192 printk(KERN_INFO PFX
"Tacls=%d, %dns Twrph0=%d %dns, Twrph1=%d %dns\n",
193 tacls
, to_ns(tacls
, clkrate
), twrph0
, to_ns(twrph0
, clkrate
), twrph1
, to_ns(twrph1
, clkrate
));
195 if (!info
->is_s3c2440
) {
196 cfg
= S3C2410_NFCONF_EN
;
197 cfg
|= S3C2410_NFCONF_TACLS(tacls
- 1);
198 cfg
|= S3C2410_NFCONF_TWRPH0(twrph0
- 1);
199 cfg
|= S3C2410_NFCONF_TWRPH1(twrph1
- 1);
201 cfg
= S3C2440_NFCONF_TACLS(tacls
- 1);
202 cfg
|= S3C2440_NFCONF_TWRPH0(twrph0
- 1);
203 cfg
|= S3C2440_NFCONF_TWRPH1(twrph1
- 1);
206 pr_debug(PFX
"NF_CONF is 0x%lx\n", cfg
);
208 writel(cfg
, info
->regs
+ S3C2410_NFCONF
);
214 static void s3c2410_nand_select_chip(struct mtd_info
*mtd
, int chip
)
216 struct s3c2410_nand_info
*info
;
217 struct s3c2410_nand_mtd
*nmtd
;
218 struct nand_chip
*this = mtd
->priv
;
226 bit
= (info
->is_s3c2440
) ? S3C2440_NFCONT_nFCE
: S3C2410_NFCONF_nFCE
;
227 reg
= info
->regs
+ ((info
->is_s3c2440
) ? S3C2440_NFCONT
: S3C2410_NFCONF
);
234 if (nmtd
->set
!= NULL
&& chip
> nmtd
->set
->nr_chips
) {
235 printk(KERN_ERR PFX
"chip %d out of range\n", chip
);
239 if (info
->platform
!= NULL
) {
240 if (info
->platform
->select_chip
!= NULL
)
241 (info
->platform
->select_chip
) (nmtd
->set
, chip
);
250 /* command and control functions
252 * Note, these all use tglx's method of changing the IO_ADDR_W field
253 * to make the code simpler, and use the nand layer's code to issue the
254 * command and address sequences via the proper IO ports.
258 static void s3c2410_nand_hwcontrol(struct mtd_info
*mtd
, int cmd
,
261 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
262 struct nand_chip
*chip
= mtd
->priv
;
264 if (cmd
== NAND_CMD_NONE
)
268 writeb(cmd
, info
->regs
+ S3C2410_NFCMD
);
270 writeb(cmd
, info
->regs
+ S3C2410_NFADDR
);
273 /* command and control functions */
275 static void s3c2440_nand_hwcontrol(struct mtd_info
*mtd
, int cmd
,
278 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
279 struct nand_chip
*chip
= mtd
->priv
;
281 if (cmd
== NAND_CMD_NONE
)
285 writeb(cmd
, info
->regs
+ S3C2440_NFCMD
);
287 writeb(cmd
, info
->regs
+ S3C2440_NFADDR
);
290 /* s3c2410_nand_devready()
292 * returns 0 if the nand is busy, 1 if it is ready
295 static int s3c2410_nand_devready(struct mtd_info
*mtd
)
297 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
299 if (info
->is_s3c2440
)
300 return readb(info
->regs
+ S3C2440_NFSTAT
) & S3C2440_NFSTAT_READY
;
301 return readb(info
->regs
+ S3C2410_NFSTAT
) & S3C2410_NFSTAT_BUSY
;
304 /* ECC handling functions */
306 static int s3c2410_nand_correct_data(struct mtd_info
*mtd
, u_char
*dat
, u_char
*read_ecc
, u_char
*calc_ecc
)
308 pr_debug("s3c2410_nand_correct_data(%p,%p,%p,%p)\n", mtd
, dat
, read_ecc
, calc_ecc
);
310 pr_debug("eccs: read %02x,%02x,%02x vs calc %02x,%02x,%02x\n",
311 read_ecc
[0], read_ecc
[1], read_ecc
[2], calc_ecc
[0], calc_ecc
[1], calc_ecc
[2]);
313 if (read_ecc
[0] == calc_ecc
[0] && read_ecc
[1] == calc_ecc
[1] && read_ecc
[2] == calc_ecc
[2])
316 /* we curently have no method for correcting the error */
323 * These allow the s3c2410 and s3c2440 to use the controller's ECC
324 * generator block to ECC the data as it passes through]
327 static void s3c2410_nand_enable_hwecc(struct mtd_info
*mtd
, int mode
)
329 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
332 ctrl
= readl(info
->regs
+ S3C2410_NFCONF
);
333 ctrl
|= S3C2410_NFCONF_INITECC
;
334 writel(ctrl
, info
->regs
+ S3C2410_NFCONF
);
337 static void s3c2440_nand_enable_hwecc(struct mtd_info
*mtd
, int mode
)
339 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
342 ctrl
= readl(info
->regs
+ S3C2440_NFCONT
);
343 writel(ctrl
| S3C2440_NFCONT_INITECC
, info
->regs
+ S3C2440_NFCONT
);
346 static int s3c2410_nand_calculate_ecc(struct mtd_info
*mtd
, const u_char
*dat
, u_char
*ecc_code
)
348 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
350 ecc_code
[0] = readb(info
->regs
+ S3C2410_NFECC
+ 0);
351 ecc_code
[1] = readb(info
->regs
+ S3C2410_NFECC
+ 1);
352 ecc_code
[2] = readb(info
->regs
+ S3C2410_NFECC
+ 2);
354 pr_debug("calculate_ecc: returning ecc %02x,%02x,%02x\n", ecc_code
[0], ecc_code
[1], ecc_code
[2]);
359 static int s3c2440_nand_calculate_ecc(struct mtd_info
*mtd
, const u_char
*dat
, u_char
*ecc_code
)
361 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
362 unsigned long ecc
= readl(info
->regs
+ S3C2440_NFMECC0
);
365 ecc_code
[1] = ecc
>> 8;
366 ecc_code
[2] = ecc
>> 16;
368 pr_debug("calculate_ecc: returning ecc %02x,%02x,%02x\n", ecc_code
[0], ecc_code
[1], ecc_code
[2]);
373 /* over-ride the standard functions for a little more speed. We can
374 * use read/write block to move the data buffers to/from the controller
377 static void s3c2410_nand_read_buf(struct mtd_info
*mtd
, u_char
*buf
, int len
)
379 struct nand_chip
*this = mtd
->priv
;
380 readsb(this->IO_ADDR_R
, buf
, len
);
383 static void s3c2410_nand_write_buf(struct mtd_info
*mtd
, const u_char
*buf
, int len
)
385 struct nand_chip
*this = mtd
->priv
;
386 writesb(this->IO_ADDR_W
, buf
, len
);
389 /* device management functions */
391 static int s3c2410_nand_remove(struct platform_device
*pdev
)
393 struct s3c2410_nand_info
*info
= to_nand_info(pdev
);
395 platform_set_drvdata(pdev
, NULL
);
400 /* first thing we need to do is release all our mtds
401 * and their partitions, then go through freeing the
405 if (info
->mtds
!= NULL
) {
406 struct s3c2410_nand_mtd
*ptr
= info
->mtds
;
409 for (mtdno
= 0; mtdno
< info
->mtd_count
; mtdno
++, ptr
++) {
410 pr_debug("releasing mtd %d (%p)\n", mtdno
, ptr
);
411 nand_release(&ptr
->mtd
);
417 /* free the common resources */
419 if (info
->clk
!= NULL
&& !IS_ERR(info
->clk
)) {
420 clk_disable(info
->clk
);
424 if (info
->regs
!= NULL
) {
429 if (info
->area
!= NULL
) {
430 release_resource(info
->area
);
440 #ifdef CONFIG_MTD_PARTITIONS
441 static int s3c2410_nand_add_partition(struct s3c2410_nand_info
*info
,
442 struct s3c2410_nand_mtd
*mtd
,
443 struct s3c2410_nand_set
*set
)
446 return add_mtd_device(&mtd
->mtd
);
448 if (set
->nr_partitions
> 0 && set
->partitions
!= NULL
) {
449 return add_mtd_partitions(&mtd
->mtd
, set
->partitions
, set
->nr_partitions
);
452 return add_mtd_device(&mtd
->mtd
);
455 static int s3c2410_nand_add_partition(struct s3c2410_nand_info
*info
,
456 struct s3c2410_nand_mtd
*mtd
,
457 struct s3c2410_nand_set
*set
)
459 return add_mtd_device(&mtd
->mtd
);
463 /* s3c2410_nand_init_chip
465 * init a single instance of an chip
468 static void s3c2410_nand_init_chip(struct s3c2410_nand_info
*info
,
469 struct s3c2410_nand_mtd
*nmtd
,
470 struct s3c2410_nand_set
*set
)
472 struct nand_chip
*chip
= &nmtd
->chip
;
474 chip
->IO_ADDR_R
= info
->regs
+ S3C2410_NFDATA
;
475 chip
->IO_ADDR_W
= info
->regs
+ S3C2410_NFDATA
;
476 chip
->cmd_ctrl
= s3c2410_nand_hwcontrol
;
477 chip
->dev_ready
= s3c2410_nand_devready
;
478 chip
->write_buf
= s3c2410_nand_write_buf
;
479 chip
->read_buf
= s3c2410_nand_read_buf
;
480 chip
->select_chip
= s3c2410_nand_select_chip
;
481 chip
->chip_delay
= 50;
484 chip
->controller
= &info
->controller
;
486 if (info
->is_s3c2440
) {
487 chip
->IO_ADDR_R
= info
->regs
+ S3C2440_NFDATA
;
488 chip
->IO_ADDR_W
= info
->regs
+ S3C2440_NFDATA
;
489 chip
->cmd_ctrl
= s3c2440_nand_hwcontrol
;
493 nmtd
->mtd
.priv
= chip
;
494 nmtd
->mtd
.owner
= THIS_MODULE
;
498 chip
->ecc
.correct
= s3c2410_nand_correct_data
;
499 chip
->ecc
.hwctl
= s3c2410_nand_enable_hwecc
;
500 chip
->ecc
.calculate
= s3c2410_nand_calculate_ecc
;
501 chip
->ecc
.mode
= NAND_ECC_HW
;
502 chip
->ecc
.size
= 512;
504 chip
->ecc
.layout
= &nand_hw_eccoob
;
506 if (info
->is_s3c2440
) {
507 chip
->ecc
.hwctl
= s3c2440_nand_enable_hwecc
;
508 chip
->ecc
.calculate
= s3c2440_nand_calculate_ecc
;
511 chip
->ecc
.mode
= NAND_ECC_SOFT
;
515 /* s3c2410_nand_probe
517 * called by device layer when it finds a device matching
518 * one our driver can handled. This code checks to see if
519 * it can allocate all necessary resources then calls the
520 * nand layer to look for devices
523 static int s3c24xx_nand_probe(struct platform_device
*pdev
, int is_s3c2440
)
525 struct s3c2410_platform_nand
*plat
= to_nand_plat(pdev
);
526 struct s3c2410_nand_info
*info
;
527 struct s3c2410_nand_mtd
*nmtd
;
528 struct s3c2410_nand_set
*sets
;
529 struct resource
*res
;
535 pr_debug("s3c2410_nand_probe(%p)\n", pdev
);
537 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
539 dev_err(&pdev
->dev
, "no memory for flash info\n");
544 memzero(info
, sizeof(*info
));
545 platform_set_drvdata(pdev
, info
);
547 spin_lock_init(&info
->controller
.lock
);
548 init_waitqueue_head(&info
->controller
.wq
);
550 /* get the clock source and enable it */
552 info
->clk
= clk_get(&pdev
->dev
, "nand");
553 if (IS_ERR(info
->clk
)) {
554 dev_err(&pdev
->dev
, "failed to get clock");
559 clk_enable(info
->clk
);
561 /* allocate and map the resource */
563 /* currently we assume we have the one resource */
564 res
= pdev
->resource
;
565 size
= res
->end
- res
->start
+ 1;
567 info
->area
= request_mem_region(res
->start
, size
, pdev
->name
);
569 if (info
->area
== NULL
) {
570 dev_err(&pdev
->dev
, "cannot reserve register region\n");
575 info
->device
= &pdev
->dev
;
576 info
->platform
= plat
;
577 info
->regs
= ioremap(res
->start
, size
);
578 info
->is_s3c2440
= is_s3c2440
;
580 if (info
->regs
== NULL
) {
581 dev_err(&pdev
->dev
, "cannot reserve register region\n");
586 dev_dbg(&pdev
->dev
, "mapped registers at %p\n", info
->regs
);
588 /* initialise the hardware */
590 err
= s3c2410_nand_inithw(info
, pdev
);
594 sets
= (plat
!= NULL
) ? plat
->sets
: NULL
;
595 nr_sets
= (plat
!= NULL
) ? plat
->nr_sets
: 1;
597 info
->mtd_count
= nr_sets
;
599 /* allocate our information */
601 size
= nr_sets
* sizeof(*info
->mtds
);
602 info
->mtds
= kmalloc(size
, GFP_KERNEL
);
603 if (info
->mtds
== NULL
) {
604 dev_err(&pdev
->dev
, "failed to allocate mtd storage\n");
609 memzero(info
->mtds
, size
);
611 /* initialise all possible chips */
615 for (setno
= 0; setno
< nr_sets
; setno
++, nmtd
++) {
616 pr_debug("initialising set %d (%p, info %p)\n", setno
, nmtd
, info
);
618 s3c2410_nand_init_chip(info
, nmtd
, sets
);
620 nmtd
->scan_res
= nand_scan(&nmtd
->mtd
, (sets
) ? sets
->nr_chips
: 1);
622 if (nmtd
->scan_res
== 0) {
623 s3c2410_nand_add_partition(info
, nmtd
, sets
);
630 pr_debug("initialised ok\n");
634 s3c2410_nand_remove(pdev
);
641 /* driver device registration */
643 static int s3c2410_nand_probe(struct platform_device
*dev
)
645 return s3c24xx_nand_probe(dev
, 0);
648 static int s3c2440_nand_probe(struct platform_device
*dev
)
650 return s3c24xx_nand_probe(dev
, 1);
653 static struct platform_driver s3c2410_nand_driver
= {
654 .probe
= s3c2410_nand_probe
,
655 .remove
= s3c2410_nand_remove
,
657 .name
= "s3c2410-nand",
658 .owner
= THIS_MODULE
,
662 static struct platform_driver s3c2440_nand_driver
= {
663 .probe
= s3c2440_nand_probe
,
664 .remove
= s3c2410_nand_remove
,
666 .name
= "s3c2440-nand",
667 .owner
= THIS_MODULE
,
671 static int __init
s3c2410_nand_init(void)
673 printk("S3C24XX NAND Driver, (c) 2004 Simtec Electronics\n");
675 platform_driver_register(&s3c2440_nand_driver
);
676 return platform_driver_register(&s3c2410_nand_driver
);
679 static void __exit
s3c2410_nand_exit(void)
681 platform_driver_unregister(&s3c2440_nand_driver
);
682 platform_driver_unregister(&s3c2410_nand_driver
);
685 module_init(s3c2410_nand_init
);
686 module_exit(s3c2410_nand_exit
);
688 MODULE_LICENSE("GPL");
689 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
690 MODULE_DESCRIPTION("S3C24XX MTD NAND driver");