blob: 8b3203571eeb3e0d7afbb36bc9c8b092ff49b840 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* linux/drivers/mtd/nand/s3c2410.c
2 *
Ben Dooksa4f957f2005-06-20 12:48:25 +01003 * Copyright (c) 2004,2005 Simtec Electronics
Ben Dooksfdf2fd52005-02-18 14:46:15 +00004 * http://www.simtec.co.uk/products/SWLINUX/
5 * Ben Dooks <ben@simtec.co.uk>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
Ben Dooksa4f957f2005-06-20 12:48:25 +01007 * Samsung S3C2410/S3C240 NAND driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Changelog:
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
Ben Dooks3e4ef3b2005-03-17 11:31:30 +000014 * 18-Feb-2005 BJD Fix sparse errors
15 * 14-Mar-2005 BJD Applied tglx's code reduction patch
Ben Dooksa4f957f2005-06-20 12:48:25 +010016 * 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
Ben Dooksfb8d82a2005-07-06 21:05:10 +010019 * 08-Jul-2005 BJD Fix OOPS when no platform data supplied
Ben Dookscfd320f2005-10-20 22:22:58 +010020 * 20-Oct-2005 BJD Fix timing calculation bug
Ben Dooksd1fef3c2006-06-19 09:29:38 +010021 * 14-Jan-2006 BJD Allow clock to be stopped when idle
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 *
Ben Dooksd1fef3c2006-06-19 09:29:38 +010023 * $Id: s3c2410.c,v 1.23 2006/04/01 18:06:29 bjd Exp $
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 *
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
29 *
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
34 *
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
38*/
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#ifdef CONFIG_MTD_NAND_S3C2410_DEBUG
41#define DEBUG
42#endif
43
44#include <linux/module.h>
45#include <linux/types.h>
46#include <linux/init.h>
47#include <linux/kernel.h>
48#include <linux/string.h>
49#include <linux/ioport.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010050#include <linux/platform_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/delay.h>
52#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080053#include <linux/slab.h>
Russell Kingf8ce2542006-01-07 16:15:52 +000054#include <linux/clk.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56#include <linux/mtd/mtd.h>
57#include <linux/mtd/nand.h>
58#include <linux/mtd/nand_ecc.h>
59#include <linux/mtd/partitions.h>
60
61#include <asm/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63#include <asm/arch/regs-nand.h>
64#include <asm/arch/nand.h>
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#ifdef CONFIG_MTD_NAND_S3C2410_HWECC
67static int hardware_ecc = 1;
68#else
69static int hardware_ecc = 0;
70#endif
71
Ben Dooksd1fef3c2006-06-19 09:29:38 +010072#ifdef CONFIG_MTD_NAND_S3C2410_CLKSTOP
73static int clock_stop = 1;
74#else
75static const int clock_stop = 0;
76#endif
77
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079/* new oob placement block for use with hardware ecc generation
80 */
81
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020082static struct nand_ecclayout nand_hw_eccoob = {
David Woodhousee0c7d762006-05-13 18:07:53 +010083 .eccbytes = 3,
84 .eccpos = {0, 1, 2},
85 .oobfree = {{8, 8}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070086};
87
88/* controller and mtd information */
89
90struct s3c2410_nand_info;
91
92struct s3c2410_nand_mtd {
93 struct mtd_info mtd;
94 struct nand_chip chip;
95 struct s3c2410_nand_set *set;
96 struct s3c2410_nand_info *info;
97 int scan_res;
98};
99
Ben Dooks2c06a082006-06-27 14:35:46 +0100100enum s3c_cpu_type {
101 TYPE_S3C2410,
102 TYPE_S3C2412,
103 TYPE_S3C2440,
104};
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106/* overview of the s3c2410 nand state */
107
108struct s3c2410_nand_info {
109 /* mtd info */
110 struct nand_hw_control controller;
111 struct s3c2410_nand_mtd *mtds;
112 struct s3c2410_platform_nand *platform;
113
114 /* device info */
115 struct device *device;
116 struct resource *area;
117 struct clk *clk;
Ben Dooksfdf2fd52005-02-18 14:46:15 +0000118 void __iomem *regs;
Ben Dooks2c06a082006-06-27 14:35:46 +0100119 void __iomem *sel_reg;
120 int sel_bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 int mtd_count;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100122
Ben Dooks2c06a082006-06-27 14:35:46 +0100123 enum s3c_cpu_type cpu_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
126/* conversion functions */
127
128static struct s3c2410_nand_mtd *s3c2410_nand_mtd_toours(struct mtd_info *mtd)
129{
130 return container_of(mtd, struct s3c2410_nand_mtd, mtd);
131}
132
133static struct s3c2410_nand_info *s3c2410_nand_mtd_toinfo(struct mtd_info *mtd)
134{
135 return s3c2410_nand_mtd_toours(mtd)->info;
136}
137
Russell King3ae5eae2005-11-09 22:32:44 +0000138static struct s3c2410_nand_info *to_nand_info(struct platform_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139{
Russell King3ae5eae2005-11-09 22:32:44 +0000140 return platform_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
142
Russell King3ae5eae2005-11-09 22:32:44 +0000143static struct s3c2410_platform_nand *to_nand_plat(struct platform_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
Russell King3ae5eae2005-11-09 22:32:44 +0000145 return dev->dev.platform_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100148static inline int allow_clk_stop(struct s3c2410_nand_info *info)
149{
150 return clock_stop;
151}
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153/* timing calculations */
154
Ben Dookscfd320f2005-10-20 22:22:58 +0100155#define NS_IN_KHZ 1000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Ben Dooks2c06a082006-06-27 14:35:46 +0100157static int s3c_nand_calc_rate(int wanted, unsigned long clk, int max)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
159 int result;
160
Ben Dookscfd320f2005-10-20 22:22:58 +0100161 result = (wanted * clk) / NS_IN_KHZ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 result++;
163
164 pr_debug("result %d from %ld, %d\n", result, clk, wanted);
165
166 if (result > max) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100167 printk("%d ns is too big for current clock rate %ld\n", wanted, clk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 return -1;
169 }
170
171 if (result < 1)
172 result = 1;
173
174 return result;
175}
176
Ben Dookscfd320f2005-10-20 22:22:58 +0100177#define to_ns(ticks,clk) (((ticks) * NS_IN_KHZ) / (unsigned int)(clk))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179/* controller setup */
180
Ben Dooks2c06a082006-06-27 14:35:46 +0100181static int s3c2410_nand_inithw(struct s3c2410_nand_info *info,
182 struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
Russell King3ae5eae2005-11-09 22:32:44 +0000184 struct s3c2410_platform_nand *plat = to_nand_plat(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 unsigned long clkrate = clk_get_rate(info->clk);
Ben Dooks2c06a082006-06-27 14:35:46 +0100186 int tacls_max = (info->cpu_type == TYPE_S3C2412) ? 8 : 4;
Ben Dookscfd320f2005-10-20 22:22:58 +0100187 int tacls, twrph0, twrph1;
Ben Dooks2c06a082006-06-27 14:35:46 +0100188 unsigned long cfg = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190 /* calculate the timing information for the controller */
191
Ben Dookscfd320f2005-10-20 22:22:58 +0100192 clkrate /= 1000; /* turn clock into kHz for ease of use */
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 if (plat != NULL) {
Ben Dooks2c06a082006-06-27 14:35:46 +0100195 tacls = s3c_nand_calc_rate(plat->tacls, clkrate, tacls_max);
196 twrph0 = s3c_nand_calc_rate(plat->twrph0, clkrate, 8);
197 twrph1 = s3c_nand_calc_rate(plat->twrph1, clkrate, 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 } else {
199 /* default timings */
Ben Dooks2c06a082006-06-27 14:35:46 +0100200 tacls = tacls_max;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 twrph0 = 8;
202 twrph1 = 8;
203 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 if (tacls < 0 || twrph0 < 0 || twrph1 < 0) {
Ben Dooks99974c62006-06-21 15:43:05 +0100206 dev_err(info->device, "cannot get suitable timings\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 return -EINVAL;
208 }
209
Ben Dooks99974c62006-06-21 15:43:05 +0100210 dev_info(info->device, "Tacls=%d, %dns Twrph0=%d %dns, Twrph1=%d %dns\n",
David Woodhousee0c7d762006-05-13 18:07:53 +0100211 tacls, to_ns(tacls, clkrate), twrph0, to_ns(twrph0, clkrate), twrph1, to_ns(twrph1, clkrate));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Ben Dooks2c06a082006-06-27 14:35:46 +0100213 switch (info->cpu_type) {
214 case TYPE_S3C2410:
David Woodhousee0c7d762006-05-13 18:07:53 +0100215 cfg = S3C2410_NFCONF_EN;
216 cfg |= S3C2410_NFCONF_TACLS(tacls - 1);
217 cfg |= S3C2410_NFCONF_TWRPH0(twrph0 - 1);
218 cfg |= S3C2410_NFCONF_TWRPH1(twrph1 - 1);
Ben Dooks2c06a082006-06-27 14:35:46 +0100219 break;
220
221 case TYPE_S3C2440:
222 case TYPE_S3C2412:
David Woodhousee0c7d762006-05-13 18:07:53 +0100223 cfg = S3C2440_NFCONF_TACLS(tacls - 1);
224 cfg |= S3C2440_NFCONF_TWRPH0(twrph0 - 1);
225 cfg |= S3C2440_NFCONF_TWRPH1(twrph1 - 1);
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100226
227 /* enable the controller and de-assert nFCE */
228
Ben Dooks2c06a082006-06-27 14:35:46 +0100229 writel(S3C2440_NFCONT_ENABLE, info->regs + S3C2440_NFCONT);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100230 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Ben Dooks99974c62006-06-21 15:43:05 +0100232 dev_dbg(info->device, "NF_CONF is 0x%lx\n", cfg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
234 writel(cfg, info->regs + S3C2410_NFCONF);
235 return 0;
236}
237
238/* select chip */
239
240static void s3c2410_nand_select_chip(struct mtd_info *mtd, int chip)
241{
242 struct s3c2410_nand_info *info;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000243 struct s3c2410_nand_mtd *nmtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct nand_chip *this = mtd->priv;
245 unsigned long cur;
246
247 nmtd = this->priv;
248 info = nmtd->info;
249
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100250 if (chip != -1 && allow_clk_stop(info))
251 clk_enable(info->clk);
252
Ben Dooks2c06a082006-06-27 14:35:46 +0100253 cur = readl(info->sel_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255 if (chip == -1) {
Ben Dooks2c06a082006-06-27 14:35:46 +0100256 cur |= info->sel_bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 } else {
Ben Dooksfb8d82a2005-07-06 21:05:10 +0100258 if (nmtd->set != NULL && chip > nmtd->set->nr_chips) {
Ben Dooks99974c62006-06-21 15:43:05 +0100259 dev_err(info->device, "invalid chip %d\n", chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 return;
261 }
262
263 if (info->platform != NULL) {
264 if (info->platform->select_chip != NULL)
David Woodhousee0c7d762006-05-13 18:07:53 +0100265 (info->platform->select_chip) (nmtd->set, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 }
267
Ben Dooks2c06a082006-06-27 14:35:46 +0100268 cur &= ~info->sel_bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 }
270
Ben Dooks2c06a082006-06-27 14:35:46 +0100271 writel(cur, info->sel_reg);
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100272
273 if (chip == -1 && allow_clk_stop(info))
274 clk_disable(info->clk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275}
276
Ben Dooksad3b5fb2006-06-19 09:43:23 +0100277/* s3c2410_nand_hwcontrol
Ben Dooksa4f957f2005-06-20 12:48:25 +0100278 *
Ben Dooksad3b5fb2006-06-19 09:43:23 +0100279 * Issue command and address cycles to the chip
Ben Dooksa4f957f2005-06-20 12:48:25 +0100280*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200282static void s3c2410_nand_hwcontrol(struct mtd_info *mtd, int cmd,
David Woodhousef9068872006-06-10 00:53:16 +0100283 unsigned int ctrl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
David Woodhousec9ac5972006-11-30 08:17:38 +0000286
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200287 if (cmd == NAND_CMD_NONE)
288 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
David Woodhousef9068872006-06-10 00:53:16 +0100290 if (ctrl & NAND_CLE)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200291 writeb(cmd, info->regs + S3C2410_NFCMD);
292 else
293 writeb(cmd, info->regs + S3C2410_NFADDR);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100294}
295
296/* command and control functions */
297
David Woodhousef9068872006-06-10 00:53:16 +0100298static void s3c2440_nand_hwcontrol(struct mtd_info *mtd, int cmd,
299 unsigned int ctrl)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100300{
301 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100302
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200303 if (cmd == NAND_CMD_NONE)
304 return;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100305
David Woodhousef9068872006-06-10 00:53:16 +0100306 if (ctrl & NAND_CLE)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200307 writeb(cmd, info->regs + S3C2440_NFCMD);
308 else
309 writeb(cmd, info->regs + S3C2440_NFADDR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312/* s3c2410_nand_devready()
313 *
314 * returns 0 if the nand is busy, 1 if it is ready
315*/
316
317static int s3c2410_nand_devready(struct mtd_info *mtd)
318{
319 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 return readb(info->regs + S3C2410_NFSTAT) & S3C2410_NFSTAT_BUSY;
321}
322
Ben Dooks2c06a082006-06-27 14:35:46 +0100323static int s3c2440_nand_devready(struct mtd_info *mtd)
324{
325 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
326 return readb(info->regs + S3C2440_NFSTAT) & S3C2440_NFSTAT_READY;
327}
328
329static int s3c2412_nand_devready(struct mtd_info *mtd)
330{
331 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
332 return readb(info->regs + S3C2412_NFSTAT) & S3C2412_NFSTAT_READY;
333}
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335/* ECC handling functions */
336
Ben Dooks2c06a082006-06-27 14:35:46 +0100337static int s3c2410_nand_correct_data(struct mtd_info *mtd, u_char *dat,
338 u_char *read_ecc, u_char *calc_ecc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339{
David Woodhousee0c7d762006-05-13 18:07:53 +0100340 pr_debug("s3c2410_nand_correct_data(%p,%p,%p,%p)\n", mtd, dat, read_ecc, calc_ecc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
342 pr_debug("eccs: read %02x,%02x,%02x vs calc %02x,%02x,%02x\n",
David Woodhousee0c7d762006-05-13 18:07:53 +0100343 read_ecc[0], read_ecc[1], read_ecc[2], calc_ecc[0], calc_ecc[1], calc_ecc[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
David Woodhousee0c7d762006-05-13 18:07:53 +0100345 if (read_ecc[0] == calc_ecc[0] && read_ecc[1] == calc_ecc[1] && read_ecc[2] == calc_ecc[2])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 return 0;
347
348 /* we curently have no method for correcting the error */
349
350 return -1;
351}
352
Ben Dooksa4f957f2005-06-20 12:48:25 +0100353/* ECC functions
354 *
355 * These allow the s3c2410 and s3c2440 to use the controller's ECC
356 * generator block to ECC the data as it passes through]
357*/
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359static void s3c2410_nand_enable_hwecc(struct mtd_info *mtd, int mode)
360{
361 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
362 unsigned long ctrl;
363
364 ctrl = readl(info->regs + S3C2410_NFCONF);
365 ctrl |= S3C2410_NFCONF_INITECC;
366 writel(ctrl, info->regs + S3C2410_NFCONF);
367}
368
Ben Dooksa4f957f2005-06-20 12:48:25 +0100369static void s3c2440_nand_enable_hwecc(struct mtd_info *mtd, int mode)
370{
371 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
372 unsigned long ctrl;
373
374 ctrl = readl(info->regs + S3C2440_NFCONT);
375 writel(ctrl | S3C2440_NFCONT_INITECC, info->regs + S3C2440_NFCONT);
376}
377
David Woodhousee0c7d762006-05-13 18:07:53 +0100378static int s3c2410_nand_calculate_ecc(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379{
380 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
381
382 ecc_code[0] = readb(info->regs + S3C2410_NFECC + 0);
383 ecc_code[1] = readb(info->regs + S3C2410_NFECC + 1);
384 ecc_code[2] = readb(info->regs + S3C2410_NFECC + 2);
385
David Woodhousee0c7d762006-05-13 18:07:53 +0100386 pr_debug("calculate_ecc: returning ecc %02x,%02x,%02x\n", ecc_code[0], ecc_code[1], ecc_code[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388 return 0;
389}
390
David Woodhousee0c7d762006-05-13 18:07:53 +0100391static int s3c2440_nand_calculate_ecc(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100392{
393 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
394 unsigned long ecc = readl(info->regs + S3C2440_NFMECC0);
395
396 ecc_code[0] = ecc;
397 ecc_code[1] = ecc >> 8;
398 ecc_code[2] = ecc >> 16;
399
David Woodhousee0c7d762006-05-13 18:07:53 +0100400 pr_debug("calculate_ecc: returning ecc %02x,%02x,%02x\n", ecc_code[0], ecc_code[1], ecc_code[2]);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100401
402 return 0;
403}
404
Ben Dooksa4f957f2005-06-20 12:48:25 +0100405/* over-ride the standard functions for a little more speed. We can
406 * use read/write block to move the data buffers to/from the controller
407*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
409static void s3c2410_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
410{
411 struct nand_chip *this = mtd->priv;
412 readsb(this->IO_ADDR_R, buf, len);
413}
414
David Woodhousee0c7d762006-05-13 18:07:53 +0100415static void s3c2410_nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
417 struct nand_chip *this = mtd->priv;
418 writesb(this->IO_ADDR_W, buf, len);
419}
420
421/* device management functions */
422
Russell King3ae5eae2005-11-09 22:32:44 +0000423static int s3c2410_nand_remove(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
Russell King3ae5eae2005-11-09 22:32:44 +0000425 struct s3c2410_nand_info *info = to_nand_info(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Russell King3ae5eae2005-11-09 22:32:44 +0000427 platform_set_drvdata(pdev, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000429 if (info == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 return 0;
431
432 /* first thing we need to do is release all our mtds
433 * and their partitions, then go through freeing the
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000434 * resources used
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 if (info->mtds != NULL) {
438 struct s3c2410_nand_mtd *ptr = info->mtds;
439 int mtdno;
440
441 for (mtdno = 0; mtdno < info->mtd_count; mtdno++, ptr++) {
442 pr_debug("releasing mtd %d (%p)\n", mtdno, ptr);
443 nand_release(&ptr->mtd);
444 }
445
446 kfree(info->mtds);
447 }
448
449 /* free the common resources */
450
451 if (info->clk != NULL && !IS_ERR(info->clk)) {
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100452 if (!allow_clk_stop(info))
453 clk_disable(info->clk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 clk_put(info->clk);
455 }
456
457 if (info->regs != NULL) {
458 iounmap(info->regs);
459 info->regs = NULL;
460 }
461
462 if (info->area != NULL) {
463 release_resource(info->area);
464 kfree(info->area);
465 info->area = NULL;
466 }
467
468 kfree(info);
469
470 return 0;
471}
472
473#ifdef CONFIG_MTD_PARTITIONS
474static int s3c2410_nand_add_partition(struct s3c2410_nand_info *info,
475 struct s3c2410_nand_mtd *mtd,
476 struct s3c2410_nand_set *set)
477{
478 if (set == NULL)
479 return add_mtd_device(&mtd->mtd);
480
481 if (set->nr_partitions > 0 && set->partitions != NULL) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100482 return add_mtd_partitions(&mtd->mtd, set->partitions, set->nr_partitions);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
484
485 return add_mtd_device(&mtd->mtd);
486}
487#else
488static int s3c2410_nand_add_partition(struct s3c2410_nand_info *info,
489 struct s3c2410_nand_mtd *mtd,
490 struct s3c2410_nand_set *set)
491{
492 return add_mtd_device(&mtd->mtd);
493}
494#endif
495
496/* s3c2410_nand_init_chip
497 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000498 * init a single instance of an chip
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499*/
500
501static void s3c2410_nand_init_chip(struct s3c2410_nand_info *info,
502 struct s3c2410_nand_mtd *nmtd,
503 struct s3c2410_nand_set *set)
504{
505 struct nand_chip *chip = &nmtd->chip;
Ben Dooks2c06a082006-06-27 14:35:46 +0100506 void __iomem *regs = info->regs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 chip->write_buf = s3c2410_nand_write_buf;
509 chip->read_buf = s3c2410_nand_read_buf;
510 chip->select_chip = s3c2410_nand_select_chip;
511 chip->chip_delay = 50;
512 chip->priv = nmtd;
513 chip->options = 0;
514 chip->controller = &info->controller;
515
Ben Dooks2c06a082006-06-27 14:35:46 +0100516 switch (info->cpu_type) {
517 case TYPE_S3C2410:
518 chip->IO_ADDR_W = regs + S3C2410_NFDATA;
519 info->sel_reg = regs + S3C2410_NFCONF;
520 info->sel_bit = S3C2410_NFCONF_nFCE;
521 chip->cmd_ctrl = s3c2410_nand_hwcontrol;
522 chip->dev_ready = s3c2410_nand_devready;
523 break;
524
525 case TYPE_S3C2440:
526 chip->IO_ADDR_W = regs + S3C2440_NFDATA;
527 info->sel_reg = regs + S3C2440_NFCONT;
528 info->sel_bit = S3C2440_NFCONT_nFCE;
529 chip->cmd_ctrl = s3c2440_nand_hwcontrol;
530 chip->dev_ready = s3c2440_nand_devready;
531 break;
532
533 case TYPE_S3C2412:
534 chip->IO_ADDR_W = regs + S3C2440_NFDATA;
535 info->sel_reg = regs + S3C2440_NFCONT;
536 info->sel_bit = S3C2412_NFCONT_nFCE0;
537 chip->cmd_ctrl = s3c2440_nand_hwcontrol;
538 chip->dev_ready = s3c2412_nand_devready;
539
540 if (readl(regs + S3C2410_NFCONF) & S3C2412_NFCONF_NANDBOOT)
541 dev_info(info->device, "System booted from NAND\n");
542
543 break;
544 }
545
546 chip->IO_ADDR_R = chip->IO_ADDR_W;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 nmtd->info = info;
549 nmtd->mtd.priv = chip;
David Woodhouse552d9202006-05-14 01:20:46 +0100550 nmtd->mtd.owner = THIS_MODULE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 nmtd->set = set;
552
553 if (hardware_ecc) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200554 chip->ecc.calculate = s3c2410_nand_calculate_ecc;
Ben Dooks2c06a082006-06-27 14:35:46 +0100555 chip->ecc.correct = s3c2410_nand_correct_data;
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200556 chip->ecc.mode = NAND_ECC_HW;
557 chip->ecc.size = 512;
558 chip->ecc.bytes = 3;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200559 chip->ecc.layout = &nand_hw_eccoob;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100560
Ben Dooks2c06a082006-06-27 14:35:46 +0100561 switch (info->cpu_type) {
562 case TYPE_S3C2410:
563 chip->ecc.hwctl = s3c2410_nand_enable_hwecc;
564 chip->ecc.calculate = s3c2410_nand_calculate_ecc;
565 break;
566
567 case TYPE_S3C2412:
568 case TYPE_S3C2440:
569 chip->ecc.hwctl = s3c2440_nand_enable_hwecc;
570 chip->ecc.calculate = s3c2440_nand_calculate_ecc;
571 break;
572
Ben Dooksa4f957f2005-06-20 12:48:25 +0100573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 } else {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200575 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 }
577}
578
579/* s3c2410_nand_probe
580 *
581 * called by device layer when it finds a device matching
582 * one our driver can handled. This code checks to see if
583 * it can allocate all necessary resources then calls the
584 * nand layer to look for devices
585*/
586
Ben Dooks2c06a082006-06-27 14:35:46 +0100587static int s3c24xx_nand_probe(struct platform_device *pdev,
588 enum s3c_cpu_type cpu_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Russell King3ae5eae2005-11-09 22:32:44 +0000590 struct s3c2410_platform_nand *plat = to_nand_plat(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 struct s3c2410_nand_info *info;
592 struct s3c2410_nand_mtd *nmtd;
593 struct s3c2410_nand_set *sets;
594 struct resource *res;
595 int err = 0;
596 int size;
597 int nr_sets;
598 int setno;
599
Russell King3ae5eae2005-11-09 22:32:44 +0000600 pr_debug("s3c2410_nand_probe(%p)\n", pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602 info = kmalloc(sizeof(*info), GFP_KERNEL);
603 if (info == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000604 dev_err(&pdev->dev, "no memory for flash info\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 err = -ENOMEM;
606 goto exit_error;
607 }
608
609 memzero(info, sizeof(*info));
Russell King3ae5eae2005-11-09 22:32:44 +0000610 platform_set_drvdata(pdev, info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612 spin_lock_init(&info->controller.lock);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100613 init_waitqueue_head(&info->controller.wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615 /* get the clock source and enable it */
616
Russell King3ae5eae2005-11-09 22:32:44 +0000617 info->clk = clk_get(&pdev->dev, "nand");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 if (IS_ERR(info->clk)) {
Russell King3ae5eae2005-11-09 22:32:44 +0000619 dev_err(&pdev->dev, "failed to get clock");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 err = -ENOENT;
621 goto exit_error;
622 }
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 clk_enable(info->clk);
625
626 /* allocate and map the resource */
627
Ben Dooksa4f957f2005-06-20 12:48:25 +0100628 /* currently we assume we have the one resource */
629 res = pdev->resource;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 size = res->end - res->start + 1;
631
632 info->area = request_mem_region(res->start, size, pdev->name);
633
634 if (info->area == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000635 dev_err(&pdev->dev, "cannot reserve register region\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 err = -ENOENT;
637 goto exit_error;
638 }
639
Russell King3ae5eae2005-11-09 22:32:44 +0000640 info->device = &pdev->dev;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100641 info->platform = plat;
642 info->regs = ioremap(res->start, size);
Ben Dooks2c06a082006-06-27 14:35:46 +0100643 info->cpu_type = cpu_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
645 if (info->regs == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000646 dev_err(&pdev->dev, "cannot reserve register region\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 err = -EIO;
648 goto exit_error;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000649 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Russell King3ae5eae2005-11-09 22:32:44 +0000651 dev_dbg(&pdev->dev, "mapped registers at %p\n", info->regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
653 /* initialise the hardware */
654
Russell King3ae5eae2005-11-09 22:32:44 +0000655 err = s3c2410_nand_inithw(info, pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 if (err != 0)
657 goto exit_error;
658
659 sets = (plat != NULL) ? plat->sets : NULL;
660 nr_sets = (plat != NULL) ? plat->nr_sets : 1;
661
662 info->mtd_count = nr_sets;
663
664 /* allocate our information */
665
666 size = nr_sets * sizeof(*info->mtds);
667 info->mtds = kmalloc(size, GFP_KERNEL);
668 if (info->mtds == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000669 dev_err(&pdev->dev, "failed to allocate mtd storage\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 err = -ENOMEM;
671 goto exit_error;
672 }
673
674 memzero(info->mtds, size);
675
676 /* initialise all possible chips */
677
678 nmtd = info->mtds;
679
680 for (setno = 0; setno < nr_sets; setno++, nmtd++) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100681 pr_debug("initialising set %d (%p, info %p)\n", setno, nmtd, info);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 s3c2410_nand_init_chip(info, nmtd, sets);
684
David Woodhousee0c7d762006-05-13 18:07:53 +0100685 nmtd->scan_res = nand_scan(&nmtd->mtd, (sets) ? sets->nr_chips : 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
687 if (nmtd->scan_res == 0) {
688 s3c2410_nand_add_partition(info, nmtd, sets);
689 }
690
691 if (sets != NULL)
692 sets++;
693 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000694
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100695 if (allow_clk_stop(info)) {
696 dev_info(&pdev->dev, "clock idle support enabled\n");
697 clk_disable(info->clk);
698 }
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 pr_debug("initialised ok\n");
701 return 0;
702
703 exit_error:
Russell King3ae5eae2005-11-09 22:32:44 +0000704 s3c2410_nand_remove(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
706 if (err == 0)
707 err = -EINVAL;
708 return err;
709}
710
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100711/* PM Support */
712#ifdef CONFIG_PM
713
714static int s3c24xx_nand_suspend(struct platform_device *dev, pm_message_t pm)
715{
716 struct s3c2410_nand_info *info = platform_get_drvdata(dev);
717
718 if (info) {
719 if (!allow_clk_stop(info))
720 clk_disable(info->clk);
721 }
722
723 return 0;
724}
725
726static int s3c24xx_nand_resume(struct platform_device *dev)
727{
728 struct s3c2410_nand_info *info = platform_get_drvdata(dev);
729
730 if (info) {
731 clk_enable(info->clk);
732 s3c2410_nand_inithw(info, dev);
733
734 if (allow_clk_stop(info))
735 clk_disable(info->clk);
736 }
737
738 return 0;
739}
740
741#else
742#define s3c24xx_nand_suspend NULL
743#define s3c24xx_nand_resume NULL
744#endif
745
Ben Dooksa4f957f2005-06-20 12:48:25 +0100746/* driver device registration */
747
Russell King3ae5eae2005-11-09 22:32:44 +0000748static int s3c2410_nand_probe(struct platform_device *dev)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100749{
Ben Dooks2c06a082006-06-27 14:35:46 +0100750 return s3c24xx_nand_probe(dev, TYPE_S3C2410);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100751}
752
Russell King3ae5eae2005-11-09 22:32:44 +0000753static int s3c2440_nand_probe(struct platform_device *dev)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100754{
Ben Dooks2c06a082006-06-27 14:35:46 +0100755 return s3c24xx_nand_probe(dev, TYPE_S3C2440);
756}
757
758static int s3c2412_nand_probe(struct platform_device *dev)
759{
760 return s3c24xx_nand_probe(dev, TYPE_S3C2412);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100761}
762
Russell King3ae5eae2005-11-09 22:32:44 +0000763static struct platform_driver s3c2410_nand_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 .probe = s3c2410_nand_probe,
765 .remove = s3c2410_nand_remove,
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100766 .suspend = s3c24xx_nand_suspend,
767 .resume = s3c24xx_nand_resume,
Russell King3ae5eae2005-11-09 22:32:44 +0000768 .driver = {
769 .name = "s3c2410-nand",
770 .owner = THIS_MODULE,
771 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772};
773
Russell King3ae5eae2005-11-09 22:32:44 +0000774static struct platform_driver s3c2440_nand_driver = {
Ben Dooksa4f957f2005-06-20 12:48:25 +0100775 .probe = s3c2440_nand_probe,
776 .remove = s3c2410_nand_remove,
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100777 .suspend = s3c24xx_nand_suspend,
778 .resume = s3c24xx_nand_resume,
Russell King3ae5eae2005-11-09 22:32:44 +0000779 .driver = {
780 .name = "s3c2440-nand",
781 .owner = THIS_MODULE,
782 },
Ben Dooksa4f957f2005-06-20 12:48:25 +0100783};
784
Ben Dooks2c06a082006-06-27 14:35:46 +0100785static struct platform_driver s3c2412_nand_driver = {
786 .probe = s3c2412_nand_probe,
787 .remove = s3c2410_nand_remove,
788 .suspend = s3c24xx_nand_suspend,
789 .resume = s3c24xx_nand_resume,
790 .driver = {
791 .name = "s3c2412-nand",
792 .owner = THIS_MODULE,
793 },
794};
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796static int __init s3c2410_nand_init(void)
797{
Ben Dooksa4f957f2005-06-20 12:48:25 +0100798 printk("S3C24XX NAND Driver, (c) 2004 Simtec Electronics\n");
799
Ben Dooks2c06a082006-06-27 14:35:46 +0100800 platform_driver_register(&s3c2412_nand_driver);
Russell King3ae5eae2005-11-09 22:32:44 +0000801 platform_driver_register(&s3c2440_nand_driver);
802 return platform_driver_register(&s3c2410_nand_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
805static void __exit s3c2410_nand_exit(void)
806{
Ben Dooks2c06a082006-06-27 14:35:46 +0100807 platform_driver_unregister(&s3c2412_nand_driver);
Russell King3ae5eae2005-11-09 22:32:44 +0000808 platform_driver_unregister(&s3c2440_nand_driver);
809 platform_driver_unregister(&s3c2410_nand_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
812module_init(s3c2410_nand_init);
813module_exit(s3c2410_nand_exit);
814
815MODULE_LICENSE("GPL");
816MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
Ben Dooksa4f957f2005-06-20 12:48:25 +0100817MODULE_DESCRIPTION("S3C24XX MTD NAND driver");