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
21 * $Id: s3c2410.c,v 1.14 2005/07/06 20:05:06 bjd Exp $
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program; if not, write to the Free Software
35 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
38 #include <config/mtd/nand/s3c2410/hwecc.h>
39 #include <config/mtd/nand/s3c2410/debug.h>
41 #ifdef CONFIG_MTD_NAND_S3C2410_DEBUG
45 #include <linux/module.h>
46 #include <linux/types.h>
47 #include <linux/init.h>
48 #include <linux/kernel.h>
49 #include <linux/string.h>
50 #include <linux/ioport.h>
51 #include <linux/device.h>
52 #include <linux/delay.h>
53 #include <linux/err.h>
55 #include <linux/mtd/mtd.h>
56 #include <linux/mtd/nand.h>
57 #include <linux/mtd/nand_ecc.h>
58 #include <linux/mtd/partitions.h>
61 #include <asm/mach-types.h>
62 #include <asm/hardware/clock.h>
64 #include <asm/arch/regs-nand.h>
65 #include <asm/arch/nand.h>
67 #define PFX "s3c2410-nand: "
69 #ifdef CONFIG_MTD_NAND_S3C2410_HWECC
70 static int hardware_ecc
= 1;
72 static int hardware_ecc
= 0;
75 /* new oob placement block for use with hardware ecc generation
78 static struct nand_oobinfo nand_hw_eccoob
= {
79 .useecc
= MTD_NANDECC_AUTOPLACE
,
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 device
*dev
)
129 return dev_get_drvdata(dev
);
132 static struct s3c2410_platform_nand
*to_nand_plat(struct device
*dev
)
134 return dev
->platform_data
;
137 /* timing calculations */
139 #define NS_IN_KHZ 10000000
141 static int s3c2410_nand_calc_rate(int wanted
, unsigned long clk
, int max
)
145 result
= (wanted
* NS_IN_KHZ
) / clk
;
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",
162 #define to_ns(ticks,clk) (((clk) * (ticks)) / NS_IN_KHZ)
164 /* controller setup */
166 static int s3c2410_nand_inithw(struct s3c2410_nand_info
*info
,
169 struct s3c2410_platform_nand
*plat
= to_nand_plat(dev
);
170 unsigned int tacls
, twrph0
, twrph1
;
171 unsigned long clkrate
= clk_get_rate(info
->clk
);
174 /* calculate the timing information for the controller */
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
"timing: Tacls %ldns, Twrph0 %ldns, Twrph1 %ldns\n",
193 to_ns(tacls
, clkrate
),
194 to_ns(twrph0
, clkrate
),
195 to_ns(twrph1
, clkrate
));
197 if (!info
->is_s3c2440
) {
198 cfg
= S3C2410_NFCONF_EN
;
199 cfg
|= S3C2410_NFCONF_TACLS(tacls
-1);
200 cfg
|= S3C2410_NFCONF_TWRPH0(twrph0
-1);
201 cfg
|= S3C2410_NFCONF_TWRPH1(twrph1
-1);
203 cfg
= S3C2440_NFCONF_TACLS(tacls
-1);
204 cfg
|= S3C2440_NFCONF_TWRPH0(twrph0
-1);
205 cfg
|= S3C2440_NFCONF_TWRPH1(twrph1
-1);
208 pr_debug(PFX
"NF_CONF is 0x%lx\n", cfg
);
210 writel(cfg
, info
->regs
+ S3C2410_NFCONF
);
216 static void s3c2410_nand_select_chip(struct mtd_info
*mtd
, int chip
)
218 struct s3c2410_nand_info
*info
;
219 struct s3c2410_nand_mtd
*nmtd
;
220 struct nand_chip
*this = mtd
->priv
;
228 bit
= (info
->is_s3c2440
) ? S3C2440_NFCONT_nFCE
: S3C2410_NFCONF_nFCE
;
229 reg
= info
->regs
+((info
->is_s3c2440
) ? S3C2440_NFCONT
:S3C2410_NFCONF
);
236 if (nmtd
->set
!= NULL
&& chip
> nmtd
->set
->nr_chips
) {
237 printk(KERN_ERR PFX
"chip %d out of range\n", chip
);
241 if (info
->platform
!= NULL
) {
242 if (info
->platform
->select_chip
!= NULL
)
243 (info
->platform
->select_chip
)(nmtd
->set
, chip
);
252 /* command and control functions
254 * Note, these all use tglx's method of changing the IO_ADDR_W field
255 * to make the code simpler, and use the nand layer's code to issue the
256 * command and address sequences via the proper IO ports.
260 static void s3c2410_nand_hwcontrol(struct mtd_info
*mtd
, int cmd
)
262 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
263 struct nand_chip
*chip
= mtd
->priv
;
266 case NAND_CTL_SETNCE
:
267 case NAND_CTL_CLRNCE
:
268 printk(KERN_ERR
"%s: called for NCE\n", __FUNCTION__
);
271 case NAND_CTL_SETCLE
:
272 chip
->IO_ADDR_W
= info
->regs
+ S3C2410_NFCMD
;
275 case NAND_CTL_SETALE
:
276 chip
->IO_ADDR_W
= info
->regs
+ S3C2410_NFADDR
;
279 /* NAND_CTL_CLRCLE: */
280 /* NAND_CTL_CLRALE: */
282 chip
->IO_ADDR_W
= info
->regs
+ S3C2410_NFDATA
;
287 /* command and control functions */
289 static void s3c2440_nand_hwcontrol(struct mtd_info
*mtd
, int cmd
)
291 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
292 struct nand_chip
*chip
= mtd
->priv
;
295 case NAND_CTL_SETNCE
:
296 case NAND_CTL_CLRNCE
:
297 printk(KERN_ERR
"%s: called for NCE\n", __FUNCTION__
);
300 case NAND_CTL_SETCLE
:
301 chip
->IO_ADDR_W
= info
->regs
+ S3C2440_NFCMD
;
304 case NAND_CTL_SETALE
:
305 chip
->IO_ADDR_W
= info
->regs
+ S3C2440_NFADDR
;
308 /* NAND_CTL_CLRCLE: */
309 /* NAND_CTL_CLRALE: */
311 chip
->IO_ADDR_W
= info
->regs
+ S3C2440_NFDATA
;
316 /* s3c2410_nand_devready()
318 * returns 0 if the nand is busy, 1 if it is ready
321 static int s3c2410_nand_devready(struct mtd_info
*mtd
)
323 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
325 if (info
->is_s3c2440
)
326 return readb(info
->regs
+ S3C2440_NFSTAT
) & S3C2440_NFSTAT_READY
;
327 return readb(info
->regs
+ S3C2410_NFSTAT
) & S3C2410_NFSTAT_BUSY
;
331 /* ECC handling functions */
333 static int s3c2410_nand_correct_data(struct mtd_info
*mtd
, u_char
*dat
,
334 u_char
*read_ecc
, u_char
*calc_ecc
)
336 pr_debug("s3c2410_nand_correct_data(%p,%p,%p,%p)\n",
337 mtd
, dat
, read_ecc
, calc_ecc
);
339 pr_debug("eccs: read %02x,%02x,%02x vs calc %02x,%02x,%02x\n",
340 read_ecc
[0], read_ecc
[1], read_ecc
[2],
341 calc_ecc
[0], calc_ecc
[1], calc_ecc
[2]);
343 if (read_ecc
[0] == calc_ecc
[0] &&
344 read_ecc
[1] == calc_ecc
[1] &&
345 read_ecc
[2] == calc_ecc
[2])
348 /* we curently have no method for correcting the error */
355 * These allow the s3c2410 and s3c2440 to use the controller's ECC
356 * generator block to ECC the data as it passes through]
359 static void s3c2410_nand_enable_hwecc(struct mtd_info
*mtd
, int mode
)
361 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
364 ctrl
= readl(info
->regs
+ S3C2410_NFCONF
);
365 ctrl
|= S3C2410_NFCONF_INITECC
;
366 writel(ctrl
, info
->regs
+ S3C2410_NFCONF
);
369 static void s3c2440_nand_enable_hwecc(struct mtd_info
*mtd
, int mode
)
371 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
374 ctrl
= readl(info
->regs
+ S3C2440_NFCONT
);
375 writel(ctrl
| S3C2440_NFCONT_INITECC
, info
->regs
+ S3C2440_NFCONT
);
378 static int s3c2410_nand_calculate_ecc(struct mtd_info
*mtd
,
379 const u_char
*dat
, u_char
*ecc_code
)
381 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
383 ecc_code
[0] = readb(info
->regs
+ S3C2410_NFECC
+ 0);
384 ecc_code
[1] = readb(info
->regs
+ S3C2410_NFECC
+ 1);
385 ecc_code
[2] = readb(info
->regs
+ S3C2410_NFECC
+ 2);
387 pr_debug("calculate_ecc: returning ecc %02x,%02x,%02x\n",
388 ecc_code
[0], ecc_code
[1], ecc_code
[2]);
394 static int s3c2440_nand_calculate_ecc(struct mtd_info
*mtd
,
395 const u_char
*dat
, u_char
*ecc_code
)
397 struct s3c2410_nand_info
*info
= s3c2410_nand_mtd_toinfo(mtd
);
398 unsigned long ecc
= readl(info
->regs
+ S3C2440_NFMECC0
);
401 ecc_code
[1] = ecc
>> 8;
402 ecc_code
[2] = ecc
>> 16;
404 pr_debug("calculate_ecc: returning ecc %02x,%02x,%02x\n",
405 ecc_code
[0], ecc_code
[1], ecc_code
[2]);
411 /* over-ride the standard functions for a little more speed. We can
412 * use read/write block to move the data buffers to/from the controller
415 static void s3c2410_nand_read_buf(struct mtd_info
*mtd
, u_char
*buf
, int len
)
417 struct nand_chip
*this = mtd
->priv
;
418 readsb(this->IO_ADDR_R
, buf
, len
);
421 static void s3c2410_nand_write_buf(struct mtd_info
*mtd
,
422 const u_char
*buf
, int len
)
424 struct nand_chip
*this = mtd
->priv
;
425 writesb(this->IO_ADDR_W
, buf
, len
);
428 /* device management functions */
430 static int s3c2410_nand_remove(struct device
*dev
)
432 struct s3c2410_nand_info
*info
= to_nand_info(dev
);
434 dev_set_drvdata(dev
, NULL
);
439 /* first thing we need to do is release all our mtds
440 * and their partitions, then go through freeing the
444 if (info
->mtds
!= NULL
) {
445 struct s3c2410_nand_mtd
*ptr
= info
->mtds
;
448 for (mtdno
= 0; mtdno
< info
->mtd_count
; mtdno
++, ptr
++) {
449 pr_debug("releasing mtd %d (%p)\n", mtdno
, ptr
);
450 nand_release(&ptr
->mtd
);
456 /* free the common resources */
458 if (info
->clk
!= NULL
&& !IS_ERR(info
->clk
)) {
459 clk_disable(info
->clk
);
460 clk_unuse(info
->clk
);
464 if (info
->regs
!= NULL
) {
469 if (info
->area
!= NULL
) {
470 release_resource(info
->area
);
480 #ifdef CONFIG_MTD_PARTITIONS
481 static int s3c2410_nand_add_partition(struct s3c2410_nand_info
*info
,
482 struct s3c2410_nand_mtd
*mtd
,
483 struct s3c2410_nand_set
*set
)
486 return add_mtd_device(&mtd
->mtd
);
488 if (set
->nr_partitions
> 0 && set
->partitions
!= NULL
) {
489 return add_mtd_partitions(&mtd
->mtd
,
494 return add_mtd_device(&mtd
->mtd
);
497 static int s3c2410_nand_add_partition(struct s3c2410_nand_info
*info
,
498 struct s3c2410_nand_mtd
*mtd
,
499 struct s3c2410_nand_set
*set
)
501 return add_mtd_device(&mtd
->mtd
);
505 /* s3c2410_nand_init_chip
507 * init a single instance of an chip
510 static void s3c2410_nand_init_chip(struct s3c2410_nand_info
*info
,
511 struct s3c2410_nand_mtd
*nmtd
,
512 struct s3c2410_nand_set
*set
)
514 struct nand_chip
*chip
= &nmtd
->chip
;
516 chip
->IO_ADDR_R
= info
->regs
+ S3C2410_NFDATA
;
517 chip
->IO_ADDR_W
= info
->regs
+ S3C2410_NFDATA
;
518 chip
->hwcontrol
= s3c2410_nand_hwcontrol
;
519 chip
->dev_ready
= s3c2410_nand_devready
;
520 chip
->write_buf
= s3c2410_nand_write_buf
;
521 chip
->read_buf
= s3c2410_nand_read_buf
;
522 chip
->select_chip
= s3c2410_nand_select_chip
;
523 chip
->chip_delay
= 50;
526 chip
->controller
= &info
->controller
;
528 if (info
->is_s3c2440
) {
529 chip
->IO_ADDR_R
= info
->regs
+ S3C2440_NFDATA
;
530 chip
->IO_ADDR_W
= info
->regs
+ S3C2440_NFDATA
;
531 chip
->hwcontrol
= s3c2440_nand_hwcontrol
;
535 nmtd
->mtd
.priv
= chip
;
539 chip
->correct_data
= s3c2410_nand_correct_data
;
540 chip
->enable_hwecc
= s3c2410_nand_enable_hwecc
;
541 chip
->calculate_ecc
= s3c2410_nand_calculate_ecc
;
542 chip
->eccmode
= NAND_ECC_HW3_512
;
543 chip
->autooob
= &nand_hw_eccoob
;
545 if (info
->is_s3c2440
) {
546 chip
->enable_hwecc
= s3c2440_nand_enable_hwecc
;
547 chip
->calculate_ecc
= s3c2440_nand_calculate_ecc
;
550 chip
->eccmode
= NAND_ECC_SOFT
;
554 /* s3c2410_nand_probe
556 * called by device layer when it finds a device matching
557 * one our driver can handled. This code checks to see if
558 * it can allocate all necessary resources then calls the
559 * nand layer to look for devices
562 static int s3c24xx_nand_probe(struct device
*dev
, int is_s3c2440
)
564 struct platform_device
*pdev
= to_platform_device(dev
);
565 struct s3c2410_platform_nand
*plat
= to_nand_plat(dev
);
566 struct s3c2410_nand_info
*info
;
567 struct s3c2410_nand_mtd
*nmtd
;
568 struct s3c2410_nand_set
*sets
;
569 struct resource
*res
;
575 pr_debug("s3c2410_nand_probe(%p)\n", dev
);
577 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
579 printk(KERN_ERR PFX
"no memory for flash info\n");
584 memzero(info
, sizeof(*info
));
585 dev_set_drvdata(dev
, info
);
587 spin_lock_init(&info
->controller
.lock
);
588 init_waitqueue_head(&info
->controller
.wq
);
590 /* get the clock source and enable it */
592 info
->clk
= clk_get(dev
, "nand");
593 if (IS_ERR(info
->clk
)) {
594 printk(KERN_ERR PFX
"failed to get clock");
600 clk_enable(info
->clk
);
602 /* allocate and map the resource */
604 /* currently we assume we have the one resource */
605 res
= pdev
->resource
;
606 size
= res
->end
- res
->start
+ 1;
608 info
->area
= request_mem_region(res
->start
, size
, pdev
->name
);
610 if (info
->area
== NULL
) {
611 printk(KERN_ERR PFX
"cannot reserve register region\n");
617 info
->platform
= plat
;
618 info
->regs
= ioremap(res
->start
, size
);
619 info
->is_s3c2440
= is_s3c2440
;
621 if (info
->regs
== NULL
) {
622 printk(KERN_ERR PFX
"cannot reserve register region\n");
627 printk(KERN_INFO PFX
"mapped registers at %p\n", info
->regs
);
629 /* initialise the hardware */
631 err
= s3c2410_nand_inithw(info
, dev
);
635 sets
= (plat
!= NULL
) ? plat
->sets
: NULL
;
636 nr_sets
= (plat
!= NULL
) ? plat
->nr_sets
: 1;
638 info
->mtd_count
= nr_sets
;
640 /* allocate our information */
642 size
= nr_sets
* sizeof(*info
->mtds
);
643 info
->mtds
= kmalloc(size
, GFP_KERNEL
);
644 if (info
->mtds
== NULL
) {
645 printk(KERN_ERR PFX
"failed to allocate mtd storage\n");
650 memzero(info
->mtds
, size
);
652 /* initialise all possible chips */
656 for (setno
= 0; setno
< nr_sets
; setno
++, nmtd
++) {
657 pr_debug("initialising set %d (%p, info %p)\n",
660 s3c2410_nand_init_chip(info
, nmtd
, sets
);
662 nmtd
->scan_res
= nand_scan(&nmtd
->mtd
,
663 (sets
) ? sets
->nr_chips
: 1);
665 if (nmtd
->scan_res
== 0) {
666 s3c2410_nand_add_partition(info
, nmtd
, sets
);
673 pr_debug("initialised ok\n");
677 s3c2410_nand_remove(dev
);
684 /* driver device registration */
686 static int s3c2410_nand_probe(struct device
*dev
)
688 return s3c24xx_nand_probe(dev
, 0);
691 static int s3c2440_nand_probe(struct device
*dev
)
693 return s3c24xx_nand_probe(dev
, 1);
696 static struct device_driver s3c2410_nand_driver
= {
697 .name
= "s3c2410-nand",
698 .bus
= &platform_bus_type
,
699 .probe
= s3c2410_nand_probe
,
700 .remove
= s3c2410_nand_remove
,
703 static struct device_driver s3c2440_nand_driver
= {
704 .name
= "s3c2440-nand",
705 .bus
= &platform_bus_type
,
706 .probe
= s3c2440_nand_probe
,
707 .remove
= s3c2410_nand_remove
,
710 static int __init
s3c2410_nand_init(void)
712 printk("S3C24XX NAND Driver, (c) 2004 Simtec Electronics\n");
714 driver_register(&s3c2440_nand_driver
);
715 return driver_register(&s3c2410_nand_driver
);
718 static void __exit
s3c2410_nand_exit(void)
720 driver_unregister(&s3c2440_nand_driver
);
721 driver_unregister(&s3c2410_nand_driver
);
724 module_init(s3c2410_nand_init
);
725 module_exit(s3c2410_nand_exit
);
727 MODULE_LICENSE("GPL");
728 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
729 MODULE_DESCRIPTION("S3C24XX MTD NAND driver");