blob: 2c262fe03d8af60a93bd6cda681246bf4b7d9ce6 [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
66#define PFX "s3c2410-nand: "
67
68#ifdef CONFIG_MTD_NAND_S3C2410_HWECC
69static int hardware_ecc = 1;
70#else
71static int hardware_ecc = 0;
72#endif
73
Ben Dooksd1fef3c2006-06-19 09:29:38 +010074#ifdef CONFIG_MTD_NAND_S3C2410_CLKSTOP
75static int clock_stop = 1;
76#else
77static const int clock_stop = 0;
78#endif
79
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081/* new oob placement block for use with hardware ecc generation
82 */
83
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020084static struct nand_ecclayout nand_hw_eccoob = {
David Woodhousee0c7d762006-05-13 18:07:53 +010085 .eccbytes = 3,
86 .eccpos = {0, 1, 2},
87 .oobfree = {{8, 8}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070088};
89
90/* controller and mtd information */
91
92struct s3c2410_nand_info;
93
94struct s3c2410_nand_mtd {
95 struct mtd_info mtd;
96 struct nand_chip chip;
97 struct s3c2410_nand_set *set;
98 struct s3c2410_nand_info *info;
99 int scan_res;
100};
101
102/* overview of the s3c2410 nand state */
103
104struct s3c2410_nand_info {
105 /* mtd info */
106 struct nand_hw_control controller;
107 struct s3c2410_nand_mtd *mtds;
108 struct s3c2410_platform_nand *platform;
109
110 /* device info */
111 struct device *device;
112 struct resource *area;
113 struct clk *clk;
Ben Dooksfdf2fd52005-02-18 14:46:15 +0000114 void __iomem *regs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 int mtd_count;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100116
117 unsigned char is_s3c2440;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118};
119
120/* conversion functions */
121
122static struct s3c2410_nand_mtd *s3c2410_nand_mtd_toours(struct mtd_info *mtd)
123{
124 return container_of(mtd, struct s3c2410_nand_mtd, mtd);
125}
126
127static struct s3c2410_nand_info *s3c2410_nand_mtd_toinfo(struct mtd_info *mtd)
128{
129 return s3c2410_nand_mtd_toours(mtd)->info;
130}
131
Russell King3ae5eae2005-11-09 22:32:44 +0000132static struct s3c2410_nand_info *to_nand_info(struct platform_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
Russell King3ae5eae2005-11-09 22:32:44 +0000134 return platform_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135}
136
Russell King3ae5eae2005-11-09 22:32:44 +0000137static struct s3c2410_platform_nand *to_nand_plat(struct platform_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138{
Russell King3ae5eae2005-11-09 22:32:44 +0000139 return dev->dev.platform_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140}
141
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100142static inline int allow_clk_stop(struct s3c2410_nand_info *info)
143{
144 return clock_stop;
145}
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/* timing calculations */
148
Ben Dookscfd320f2005-10-20 22:22:58 +0100149#define NS_IN_KHZ 1000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151static int s3c2410_nand_calc_rate(int wanted, unsigned long clk, int max)
152{
153 int result;
154
Ben Dookscfd320f2005-10-20 22:22:58 +0100155 result = (wanted * clk) / NS_IN_KHZ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 result++;
157
158 pr_debug("result %d from %ld, %d\n", result, clk, wanted);
159
160 if (result > max) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100161 printk("%d ns is too big for current clock rate %ld\n", wanted, clk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 return -1;
163 }
164
165 if (result < 1)
166 result = 1;
167
168 return result;
169}
170
Ben Dookscfd320f2005-10-20 22:22:58 +0100171#define to_ns(ticks,clk) (((ticks) * NS_IN_KHZ) / (unsigned int)(clk))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173/* controller setup */
174
David Woodhousee0c7d762006-05-13 18:07:53 +0100175static int s3c2410_nand_inithw(struct s3c2410_nand_info *info, struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176{
Russell King3ae5eae2005-11-09 22:32:44 +0000177 struct s3c2410_platform_nand *plat = to_nand_plat(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 unsigned long clkrate = clk_get_rate(info->clk);
Ben Dookscfd320f2005-10-20 22:22:58 +0100179 int tacls, twrph0, twrph1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 unsigned long cfg;
181
182 /* calculate the timing information for the controller */
183
Ben Dookscfd320f2005-10-20 22:22:58 +0100184 clkrate /= 1000; /* turn clock into kHz for ease of use */
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 if (plat != NULL) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100187 tacls = s3c2410_nand_calc_rate(plat->tacls, clkrate, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 twrph0 = s3c2410_nand_calc_rate(plat->twrph0, clkrate, 8);
189 twrph1 = s3c2410_nand_calc_rate(plat->twrph1, clkrate, 8);
190 } else {
191 /* default timings */
Ben Dooksa4f957f2005-06-20 12:48:25 +0100192 tacls = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 twrph0 = 8;
194 twrph1 = 8;
195 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 if (tacls < 0 || twrph0 < 0 || twrph1 < 0) {
198 printk(KERN_ERR PFX "cannot get timings suitable for board\n");
199 return -EINVAL;
200 }
201
Ben Dookscfd320f2005-10-20 22:22:58 +0100202 printk(KERN_INFO PFX "Tacls=%d, %dns Twrph0=%d %dns, Twrph1=%d %dns\n",
David Woodhousee0c7d762006-05-13 18:07:53 +0100203 tacls, to_ns(tacls, clkrate), twrph0, to_ns(twrph0, clkrate), twrph1, to_ns(twrph1, clkrate));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Ben Dooksa4f957f2005-06-20 12:48:25 +0100205 if (!info->is_s3c2440) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100206 cfg = S3C2410_NFCONF_EN;
207 cfg |= S3C2410_NFCONF_TACLS(tacls - 1);
208 cfg |= S3C2410_NFCONF_TWRPH0(twrph0 - 1);
209 cfg |= S3C2410_NFCONF_TWRPH1(twrph1 - 1);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100210 } else {
David Woodhousee0c7d762006-05-13 18:07:53 +0100211 cfg = S3C2440_NFCONF_TACLS(tacls - 1);
212 cfg |= S3C2440_NFCONF_TWRPH0(twrph0 - 1);
213 cfg |= S3C2440_NFCONF_TWRPH1(twrph1 - 1);
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100214
215 /* enable the controller and de-assert nFCE */
216
217 writel(S3C2440_NFCONT_ENABLE | S3C2440_NFCONT_ENABLE,
218 info->regs + S3C2440_NFCONT);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221 pr_debug(PFX "NF_CONF is 0x%lx\n", cfg);
222
223 writel(cfg, info->regs + S3C2410_NFCONF);
224 return 0;
225}
226
227/* select chip */
228
229static void s3c2410_nand_select_chip(struct mtd_info *mtd, int chip)
230{
231 struct s3c2410_nand_info *info;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000232 struct s3c2410_nand_mtd *nmtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct nand_chip *this = mtd->priv;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100234 void __iomem *reg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 unsigned long cur;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100236 unsigned long bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 nmtd = this->priv;
239 info = nmtd->info;
240
Ben Dooksa4f957f2005-06-20 12:48:25 +0100241 bit = (info->is_s3c2440) ? S3C2440_NFCONT_nFCE : S3C2410_NFCONF_nFCE;
David Woodhousee0c7d762006-05-13 18:07:53 +0100242 reg = info->regs + ((info->is_s3c2440) ? S3C2440_NFCONT : S3C2410_NFCONF);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100243
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100244 if (chip != -1 && allow_clk_stop(info))
245 clk_enable(info->clk);
246
Ben Dooksa4f957f2005-06-20 12:48:25 +0100247 cur = readl(reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 if (chip == -1) {
Ben Dooksa4f957f2005-06-20 12:48:25 +0100250 cur |= bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 } else {
Ben Dooksfb8d82a2005-07-06 21:05:10 +0100252 if (nmtd->set != NULL && chip > nmtd->set->nr_chips) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 printk(KERN_ERR PFX "chip %d out of range\n", chip);
254 return;
255 }
256
257 if (info->platform != NULL) {
258 if (info->platform->select_chip != NULL)
David Woodhousee0c7d762006-05-13 18:07:53 +0100259 (info->platform->select_chip) (nmtd->set, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 }
261
Ben Dooksa4f957f2005-06-20 12:48:25 +0100262 cur &= ~bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
264
Ben Dooksa4f957f2005-06-20 12:48:25 +0100265 writel(cur, reg);
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100266
267 if (chip == -1 && allow_clk_stop(info))
268 clk_disable(info->clk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269}
270
Ben Dooksad3b5fb2006-06-19 09:43:23 +0100271/* s3c2410_nand_hwcontrol
Ben Dooksa4f957f2005-06-20 12:48:25 +0100272 *
Ben Dooksad3b5fb2006-06-19 09:43:23 +0100273 * Issue command and address cycles to the chip
Ben Dooksa4f957f2005-06-20 12:48:25 +0100274*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200276static void s3c2410_nand_hwcontrol(struct mtd_info *mtd, int cmd,
David Woodhousef9068872006-06-10 00:53:16 +0100277 unsigned int ctrl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
279 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
Ben Dooksad3b5fb2006-06-19 09:43:23 +0100280
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200281 if (cmd == NAND_CMD_NONE)
282 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
David Woodhousef9068872006-06-10 00:53:16 +0100284 if (ctrl & NAND_CLE)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200285 writeb(cmd, info->regs + S3C2410_NFCMD);
286 else
287 writeb(cmd, info->regs + S3C2410_NFADDR);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100288}
289
290/* command and control functions */
291
David Woodhousef9068872006-06-10 00:53:16 +0100292static void s3c2440_nand_hwcontrol(struct mtd_info *mtd, int cmd,
293 unsigned int ctrl)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100294{
295 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100296
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200297 if (cmd == NAND_CMD_NONE)
298 return;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100299
David Woodhousef9068872006-06-10 00:53:16 +0100300 if (ctrl & NAND_CLE)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200301 writeb(cmd, info->regs + S3C2440_NFCMD);
302 else
303 writeb(cmd, info->regs + S3C2440_NFADDR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304}
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306/* s3c2410_nand_devready()
307 *
308 * returns 0 if the nand is busy, 1 if it is ready
309*/
310
311static int s3c2410_nand_devready(struct mtd_info *mtd)
312{
313 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000314
Ben Dooksa4f957f2005-06-20 12:48:25 +0100315 if (info->is_s3c2440)
316 return readb(info->regs + S3C2440_NFSTAT) & S3C2440_NFSTAT_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 return readb(info->regs + S3C2410_NFSTAT) & S3C2410_NFSTAT_BUSY;
318}
319
320/* ECC handling functions */
321
David Woodhousee0c7d762006-05-13 18:07:53 +0100322static int s3c2410_nand_correct_data(struct mtd_info *mtd, u_char *dat, u_char *read_ecc, u_char *calc_ecc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
David Woodhousee0c7d762006-05-13 18:07:53 +0100324 pr_debug("s3c2410_nand_correct_data(%p,%p,%p,%p)\n", mtd, dat, read_ecc, calc_ecc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 pr_debug("eccs: read %02x,%02x,%02x vs calc %02x,%02x,%02x\n",
David Woodhousee0c7d762006-05-13 18:07:53 +0100327 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 -0700328
David Woodhousee0c7d762006-05-13 18:07:53 +0100329 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 -0700330 return 0;
331
332 /* we curently have no method for correcting the error */
333
334 return -1;
335}
336
Ben Dooksa4f957f2005-06-20 12:48:25 +0100337/* ECC functions
338 *
339 * These allow the s3c2410 and s3c2440 to use the controller's ECC
340 * generator block to ECC the data as it passes through]
341*/
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343static void s3c2410_nand_enable_hwecc(struct mtd_info *mtd, int mode)
344{
345 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
346 unsigned long ctrl;
347
348 ctrl = readl(info->regs + S3C2410_NFCONF);
349 ctrl |= S3C2410_NFCONF_INITECC;
350 writel(ctrl, info->regs + S3C2410_NFCONF);
351}
352
Ben Dooksa4f957f2005-06-20 12:48:25 +0100353static void s3c2440_nand_enable_hwecc(struct mtd_info *mtd, int mode)
354{
355 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
356 unsigned long ctrl;
357
358 ctrl = readl(info->regs + S3C2440_NFCONT);
359 writel(ctrl | S3C2440_NFCONT_INITECC, info->regs + S3C2440_NFCONT);
360}
361
David Woodhousee0c7d762006-05-13 18:07:53 +0100362static int s3c2410_nand_calculate_ecc(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363{
364 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
365
366 ecc_code[0] = readb(info->regs + S3C2410_NFECC + 0);
367 ecc_code[1] = readb(info->regs + S3C2410_NFECC + 1);
368 ecc_code[2] = readb(info->regs + S3C2410_NFECC + 2);
369
David Woodhousee0c7d762006-05-13 18:07:53 +0100370 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 -0700371
372 return 0;
373}
374
David Woodhousee0c7d762006-05-13 18:07:53 +0100375static int s3c2440_nand_calculate_ecc(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100376{
377 struct s3c2410_nand_info *info = s3c2410_nand_mtd_toinfo(mtd);
378 unsigned long ecc = readl(info->regs + S3C2440_NFMECC0);
379
380 ecc_code[0] = ecc;
381 ecc_code[1] = ecc >> 8;
382 ecc_code[2] = ecc >> 16;
383
David Woodhousee0c7d762006-05-13 18:07:53 +0100384 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 +0100385
386 return 0;
387}
388
Ben Dooksa4f957f2005-06-20 12:48:25 +0100389/* over-ride the standard functions for a little more speed. We can
390 * use read/write block to move the data buffers to/from the controller
391*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393static void s3c2410_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
394{
395 struct nand_chip *this = mtd->priv;
396 readsb(this->IO_ADDR_R, buf, len);
397}
398
David Woodhousee0c7d762006-05-13 18:07:53 +0100399static void s3c2410_nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
401 struct nand_chip *this = mtd->priv;
402 writesb(this->IO_ADDR_W, buf, len);
403}
404
405/* device management functions */
406
Russell King3ae5eae2005-11-09 22:32:44 +0000407static int s3c2410_nand_remove(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Russell King3ae5eae2005-11-09 22:32:44 +0000409 struct s3c2410_nand_info *info = to_nand_info(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Russell King3ae5eae2005-11-09 22:32:44 +0000411 platform_set_drvdata(pdev, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000413 if (info == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 return 0;
415
416 /* first thing we need to do is release all our mtds
417 * and their partitions, then go through freeing the
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000418 * resources used
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000420
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 if (info->mtds != NULL) {
422 struct s3c2410_nand_mtd *ptr = info->mtds;
423 int mtdno;
424
425 for (mtdno = 0; mtdno < info->mtd_count; mtdno++, ptr++) {
426 pr_debug("releasing mtd %d (%p)\n", mtdno, ptr);
427 nand_release(&ptr->mtd);
428 }
429
430 kfree(info->mtds);
431 }
432
433 /* free the common resources */
434
435 if (info->clk != NULL && !IS_ERR(info->clk)) {
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100436 if (!allow_clk_stop(info))
437 clk_disable(info->clk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 clk_put(info->clk);
439 }
440
441 if (info->regs != NULL) {
442 iounmap(info->regs);
443 info->regs = NULL;
444 }
445
446 if (info->area != NULL) {
447 release_resource(info->area);
448 kfree(info->area);
449 info->area = NULL;
450 }
451
452 kfree(info);
453
454 return 0;
455}
456
457#ifdef CONFIG_MTD_PARTITIONS
458static int s3c2410_nand_add_partition(struct s3c2410_nand_info *info,
459 struct s3c2410_nand_mtd *mtd,
460 struct s3c2410_nand_set *set)
461{
462 if (set == NULL)
463 return add_mtd_device(&mtd->mtd);
464
465 if (set->nr_partitions > 0 && set->partitions != NULL) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100466 return add_mtd_partitions(&mtd->mtd, set->partitions, set->nr_partitions);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 }
468
469 return add_mtd_device(&mtd->mtd);
470}
471#else
472static int s3c2410_nand_add_partition(struct s3c2410_nand_info *info,
473 struct s3c2410_nand_mtd *mtd,
474 struct s3c2410_nand_set *set)
475{
476 return add_mtd_device(&mtd->mtd);
477}
478#endif
479
480/* s3c2410_nand_init_chip
481 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000482 * init a single instance of an chip
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483*/
484
485static void s3c2410_nand_init_chip(struct s3c2410_nand_info *info,
486 struct s3c2410_nand_mtd *nmtd,
487 struct s3c2410_nand_set *set)
488{
489 struct nand_chip *chip = &nmtd->chip;
490
Ben Dooksfdf2fd52005-02-18 14:46:15 +0000491 chip->IO_ADDR_R = info->regs + S3C2410_NFDATA;
492 chip->IO_ADDR_W = info->regs + S3C2410_NFDATA;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200493 chip->cmd_ctrl = s3c2410_nand_hwcontrol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 chip->dev_ready = s3c2410_nand_devready;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 chip->write_buf = s3c2410_nand_write_buf;
496 chip->read_buf = s3c2410_nand_read_buf;
497 chip->select_chip = s3c2410_nand_select_chip;
498 chip->chip_delay = 50;
499 chip->priv = nmtd;
500 chip->options = 0;
501 chip->controller = &info->controller;
502
Ben Dooksa4f957f2005-06-20 12:48:25 +0100503 if (info->is_s3c2440) {
504 chip->IO_ADDR_R = info->regs + S3C2440_NFDATA;
505 chip->IO_ADDR_W = info->regs + S3C2440_NFDATA;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200506 chip->cmd_ctrl = s3c2440_nand_hwcontrol;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100507 }
508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 nmtd->info = info;
510 nmtd->mtd.priv = chip;
David Woodhouse552d9202006-05-14 01:20:46 +0100511 nmtd->mtd.owner = THIS_MODULE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 nmtd->set = set;
513
514 if (hardware_ecc) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200515 chip->ecc.correct = s3c2410_nand_correct_data;
516 chip->ecc.hwctl = s3c2410_nand_enable_hwecc;
517 chip->ecc.calculate = s3c2410_nand_calculate_ecc;
518 chip->ecc.mode = NAND_ECC_HW;
519 chip->ecc.size = 512;
520 chip->ecc.bytes = 3;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200521 chip->ecc.layout = &nand_hw_eccoob;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100522
523 if (info->is_s3c2440) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200524 chip->ecc.hwctl = s3c2440_nand_enable_hwecc;
525 chip->ecc.calculate = s3c2440_nand_calculate_ecc;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100526 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 } else {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200528 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 }
530}
531
532/* s3c2410_nand_probe
533 *
534 * called by device layer when it finds a device matching
535 * one our driver can handled. This code checks to see if
536 * it can allocate all necessary resources then calls the
537 * nand layer to look for devices
538*/
539
Russell King3ae5eae2005-11-09 22:32:44 +0000540static int s3c24xx_nand_probe(struct platform_device *pdev, int is_s3c2440)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Russell King3ae5eae2005-11-09 22:32:44 +0000542 struct s3c2410_platform_nand *plat = to_nand_plat(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 struct s3c2410_nand_info *info;
544 struct s3c2410_nand_mtd *nmtd;
545 struct s3c2410_nand_set *sets;
546 struct resource *res;
547 int err = 0;
548 int size;
549 int nr_sets;
550 int setno;
551
Russell King3ae5eae2005-11-09 22:32:44 +0000552 pr_debug("s3c2410_nand_probe(%p)\n", pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
554 info = kmalloc(sizeof(*info), GFP_KERNEL);
555 if (info == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000556 dev_err(&pdev->dev, "no memory for flash info\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 err = -ENOMEM;
558 goto exit_error;
559 }
560
561 memzero(info, sizeof(*info));
Russell King3ae5eae2005-11-09 22:32:44 +0000562 platform_set_drvdata(pdev, info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
564 spin_lock_init(&info->controller.lock);
Ben Dooksa4f957f2005-06-20 12:48:25 +0100565 init_waitqueue_head(&info->controller.wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
567 /* get the clock source and enable it */
568
Russell King3ae5eae2005-11-09 22:32:44 +0000569 info->clk = clk_get(&pdev->dev, "nand");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 if (IS_ERR(info->clk)) {
Russell King3ae5eae2005-11-09 22:32:44 +0000571 dev_err(&pdev->dev, "failed to get clock");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 err = -ENOENT;
573 goto exit_error;
574 }
575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 clk_enable(info->clk);
577
578 /* allocate and map the resource */
579
Ben Dooksa4f957f2005-06-20 12:48:25 +0100580 /* currently we assume we have the one resource */
581 res = pdev->resource;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 size = res->end - res->start + 1;
583
584 info->area = request_mem_region(res->start, size, pdev->name);
585
586 if (info->area == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000587 dev_err(&pdev->dev, "cannot reserve register region\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 err = -ENOENT;
589 goto exit_error;
590 }
591
Russell King3ae5eae2005-11-09 22:32:44 +0000592 info->device = &pdev->dev;
Ben Dooksa4f957f2005-06-20 12:48:25 +0100593 info->platform = plat;
594 info->regs = ioremap(res->start, size);
595 info->is_s3c2440 = is_s3c2440;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
597 if (info->regs == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000598 dev_err(&pdev->dev, "cannot reserve register region\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 err = -EIO;
600 goto exit_error;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000601 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Russell King3ae5eae2005-11-09 22:32:44 +0000603 dev_dbg(&pdev->dev, "mapped registers at %p\n", info->regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
605 /* initialise the hardware */
606
Russell King3ae5eae2005-11-09 22:32:44 +0000607 err = s3c2410_nand_inithw(info, pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 if (err != 0)
609 goto exit_error;
610
611 sets = (plat != NULL) ? plat->sets : NULL;
612 nr_sets = (plat != NULL) ? plat->nr_sets : 1;
613
614 info->mtd_count = nr_sets;
615
616 /* allocate our information */
617
618 size = nr_sets * sizeof(*info->mtds);
619 info->mtds = kmalloc(size, GFP_KERNEL);
620 if (info->mtds == NULL) {
Russell King3ae5eae2005-11-09 22:32:44 +0000621 dev_err(&pdev->dev, "failed to allocate mtd storage\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 err = -ENOMEM;
623 goto exit_error;
624 }
625
626 memzero(info->mtds, size);
627
628 /* initialise all possible chips */
629
630 nmtd = info->mtds;
631
632 for (setno = 0; setno < nr_sets; setno++, nmtd++) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100633 pr_debug("initialising set %d (%p, info %p)\n", setno, nmtd, info);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 s3c2410_nand_init_chip(info, nmtd, sets);
636
David Woodhousee0c7d762006-05-13 18:07:53 +0100637 nmtd->scan_res = nand_scan(&nmtd->mtd, (sets) ? sets->nr_chips : 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 if (nmtd->scan_res == 0) {
640 s3c2410_nand_add_partition(info, nmtd, sets);
641 }
642
643 if (sets != NULL)
644 sets++;
645 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000646
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100647 if (allow_clk_stop(info)) {
648 dev_info(&pdev->dev, "clock idle support enabled\n");
649 clk_disable(info->clk);
650 }
651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 pr_debug("initialised ok\n");
653 return 0;
654
655 exit_error:
Russell King3ae5eae2005-11-09 22:32:44 +0000656 s3c2410_nand_remove(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
658 if (err == 0)
659 err = -EINVAL;
660 return err;
661}
662
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100663/* PM Support */
664#ifdef CONFIG_PM
665
666static int s3c24xx_nand_suspend(struct platform_device *dev, pm_message_t pm)
667{
668 struct s3c2410_nand_info *info = platform_get_drvdata(dev);
669
670 if (info) {
671 if (!allow_clk_stop(info))
672 clk_disable(info->clk);
673 }
674
675 return 0;
676}
677
678static int s3c24xx_nand_resume(struct platform_device *dev)
679{
680 struct s3c2410_nand_info *info = platform_get_drvdata(dev);
681
682 if (info) {
683 clk_enable(info->clk);
684 s3c2410_nand_inithw(info, dev);
685
686 if (allow_clk_stop(info))
687 clk_disable(info->clk);
688 }
689
690 return 0;
691}
692
693#else
694#define s3c24xx_nand_suspend NULL
695#define s3c24xx_nand_resume NULL
696#endif
697
Ben Dooksa4f957f2005-06-20 12:48:25 +0100698/* driver device registration */
699
Russell King3ae5eae2005-11-09 22:32:44 +0000700static int s3c2410_nand_probe(struct platform_device *dev)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100701{
702 return s3c24xx_nand_probe(dev, 0);
703}
704
Russell King3ae5eae2005-11-09 22:32:44 +0000705static int s3c2440_nand_probe(struct platform_device *dev)
Ben Dooksa4f957f2005-06-20 12:48:25 +0100706{
707 return s3c24xx_nand_probe(dev, 1);
708}
709
Russell King3ae5eae2005-11-09 22:32:44 +0000710static struct platform_driver s3c2410_nand_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 .probe = s3c2410_nand_probe,
712 .remove = s3c2410_nand_remove,
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100713 .suspend = s3c24xx_nand_suspend,
714 .resume = s3c24xx_nand_resume,
Russell King3ae5eae2005-11-09 22:32:44 +0000715 .driver = {
716 .name = "s3c2410-nand",
717 .owner = THIS_MODULE,
718 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719};
720
Russell King3ae5eae2005-11-09 22:32:44 +0000721static struct platform_driver s3c2440_nand_driver = {
Ben Dooksa4f957f2005-06-20 12:48:25 +0100722 .probe = s3c2440_nand_probe,
723 .remove = s3c2410_nand_remove,
Ben Dooksd1fef3c2006-06-19 09:29:38 +0100724 .suspend = s3c24xx_nand_suspend,
725 .resume = s3c24xx_nand_resume,
Russell King3ae5eae2005-11-09 22:32:44 +0000726 .driver = {
727 .name = "s3c2440-nand",
728 .owner = THIS_MODULE,
729 },
Ben Dooksa4f957f2005-06-20 12:48:25 +0100730};
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732static int __init s3c2410_nand_init(void)
733{
Ben Dooksa4f957f2005-06-20 12:48:25 +0100734 printk("S3C24XX NAND Driver, (c) 2004 Simtec Electronics\n");
735
Russell King3ae5eae2005-11-09 22:32:44 +0000736 platform_driver_register(&s3c2440_nand_driver);
737 return platform_driver_register(&s3c2410_nand_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738}
739
740static void __exit s3c2410_nand_exit(void)
741{
Russell King3ae5eae2005-11-09 22:32:44 +0000742 platform_driver_unregister(&s3c2440_nand_driver);
743 platform_driver_unregister(&s3c2410_nand_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
745
746module_init(s3c2410_nand_init);
747module_exit(s3c2410_nand_exit);
748
749MODULE_LICENSE("GPL");
750MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
Ben Dooksa4f957f2005-06-20 12:48:25 +0100751MODULE_DESCRIPTION("S3C24XX MTD NAND driver");