Loading...
Note: File does not exist in v6.8.
1/*
2 * TXx9 NAND flash memory controller driver
3 * Based on RBTX49xx patch from CELF patch archive.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 *
9 * (C) Copyright TOSHIBA CORPORATION 2004-2007
10 * All Rights Reserved.
11 */
12#include <linux/err.h>
13#include <linux/init.h>
14#include <linux/slab.h>
15#include <linux/module.h>
16#include <linux/platform_device.h>
17#include <linux/delay.h>
18#include <linux/mtd/mtd.h>
19#include <linux/mtd/nand.h>
20#include <linux/mtd/nand_ecc.h>
21#include <linux/mtd/partitions.h>
22#include <linux/io.h>
23#include <asm/txx9/ndfmc.h>
24
25/* TXX9 NDFMC Registers */
26#define TXX9_NDFDTR 0x00
27#define TXX9_NDFMCR 0x04
28#define TXX9_NDFSR 0x08
29#define TXX9_NDFISR 0x0c
30#define TXX9_NDFIMR 0x10
31#define TXX9_NDFSPR 0x14
32#define TXX9_NDFRSTR 0x18 /* not TX4939 */
33
34/* NDFMCR : NDFMC Mode Control */
35#define TXX9_NDFMCR_WE 0x80
36#define TXX9_NDFMCR_ECC_ALL 0x60
37#define TXX9_NDFMCR_ECC_RESET 0x60
38#define TXX9_NDFMCR_ECC_READ 0x40
39#define TXX9_NDFMCR_ECC_ON 0x20
40#define TXX9_NDFMCR_ECC_OFF 0x00
41#define TXX9_NDFMCR_CE 0x10
42#define TXX9_NDFMCR_BSPRT 0x04 /* TX4925/TX4926 only */
43#define TXX9_NDFMCR_ALE 0x02
44#define TXX9_NDFMCR_CLE 0x01
45/* TX4939 only */
46#define TXX9_NDFMCR_X16 0x0400
47#define TXX9_NDFMCR_DMAREQ_MASK 0x0300
48#define TXX9_NDFMCR_DMAREQ_NODMA 0x0000
49#define TXX9_NDFMCR_DMAREQ_128 0x0100
50#define TXX9_NDFMCR_DMAREQ_256 0x0200
51#define TXX9_NDFMCR_DMAREQ_512 0x0300
52#define TXX9_NDFMCR_CS_MASK 0x0c
53#define TXX9_NDFMCR_CS(ch) ((ch) << 2)
54
55/* NDFMCR : NDFMC Status */
56#define TXX9_NDFSR_BUSY 0x80
57/* TX4939 only */
58#define TXX9_NDFSR_DMARUN 0x40
59
60/* NDFMCR : NDFMC Reset */
61#define TXX9_NDFRSTR_RST 0x01
62
63struct txx9ndfmc_priv {
64 struct platform_device *dev;
65 struct nand_chip chip;
66 int cs;
67 const char *mtdname;
68};
69
70#define MAX_TXX9NDFMC_DEV 4
71struct txx9ndfmc_drvdata {
72 struct mtd_info *mtds[MAX_TXX9NDFMC_DEV];
73 void __iomem *base;
74 unsigned char hold; /* in gbusclock */
75 unsigned char spw; /* in gbusclock */
76 struct nand_hw_control hw_control;
77};
78
79static struct platform_device *mtd_to_platdev(struct mtd_info *mtd)
80{
81 struct nand_chip *chip = mtd_to_nand(mtd);
82 struct txx9ndfmc_priv *txx9_priv = nand_get_controller_data(chip);
83 return txx9_priv->dev;
84}
85
86static void __iomem *ndregaddr(struct platform_device *dev, unsigned int reg)
87{
88 struct txx9ndfmc_drvdata *drvdata = platform_get_drvdata(dev);
89 struct txx9ndfmc_platform_data *plat = dev_get_platdata(&dev->dev);
90
91 return drvdata->base + (reg << plat->shift);
92}
93
94static u32 txx9ndfmc_read(struct platform_device *dev, unsigned int reg)
95{
96 return __raw_readl(ndregaddr(dev, reg));
97}
98
99static void txx9ndfmc_write(struct platform_device *dev,
100 u32 val, unsigned int reg)
101{
102 __raw_writel(val, ndregaddr(dev, reg));
103}
104
105static uint8_t txx9ndfmc_read_byte(struct mtd_info *mtd)
106{
107 struct platform_device *dev = mtd_to_platdev(mtd);
108
109 return txx9ndfmc_read(dev, TXX9_NDFDTR);
110}
111
112static void txx9ndfmc_write_buf(struct mtd_info *mtd, const uint8_t *buf,
113 int len)
114{
115 struct platform_device *dev = mtd_to_platdev(mtd);
116 void __iomem *ndfdtr = ndregaddr(dev, TXX9_NDFDTR);
117 u32 mcr = txx9ndfmc_read(dev, TXX9_NDFMCR);
118
119 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_WE, TXX9_NDFMCR);
120 while (len--)
121 __raw_writel(*buf++, ndfdtr);
122 txx9ndfmc_write(dev, mcr, TXX9_NDFMCR);
123}
124
125static void txx9ndfmc_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
126{
127 struct platform_device *dev = mtd_to_platdev(mtd);
128 void __iomem *ndfdtr = ndregaddr(dev, TXX9_NDFDTR);
129
130 while (len--)
131 *buf++ = __raw_readl(ndfdtr);
132}
133
134static void txx9ndfmc_cmd_ctrl(struct mtd_info *mtd, int cmd,
135 unsigned int ctrl)
136{
137 struct nand_chip *chip = mtd_to_nand(mtd);
138 struct txx9ndfmc_priv *txx9_priv = nand_get_controller_data(chip);
139 struct platform_device *dev = txx9_priv->dev;
140 struct txx9ndfmc_platform_data *plat = dev_get_platdata(&dev->dev);
141
142 if (ctrl & NAND_CTRL_CHANGE) {
143 u32 mcr = txx9ndfmc_read(dev, TXX9_NDFMCR);
144
145 mcr &= ~(TXX9_NDFMCR_CLE | TXX9_NDFMCR_ALE | TXX9_NDFMCR_CE);
146 mcr |= ctrl & NAND_CLE ? TXX9_NDFMCR_CLE : 0;
147 mcr |= ctrl & NAND_ALE ? TXX9_NDFMCR_ALE : 0;
148 /* TXX9_NDFMCR_CE bit is 0:high 1:low */
149 mcr |= ctrl & NAND_NCE ? TXX9_NDFMCR_CE : 0;
150 if (txx9_priv->cs >= 0 && (ctrl & NAND_NCE)) {
151 mcr &= ~TXX9_NDFMCR_CS_MASK;
152 mcr |= TXX9_NDFMCR_CS(txx9_priv->cs);
153 }
154 txx9ndfmc_write(dev, mcr, TXX9_NDFMCR);
155 }
156 if (cmd != NAND_CMD_NONE)
157 txx9ndfmc_write(dev, cmd & 0xff, TXX9_NDFDTR);
158 if (plat->flags & NDFMC_PLAT_FLAG_DUMMYWRITE) {
159 /* dummy write to update external latch */
160 if ((ctrl & NAND_CTRL_CHANGE) && cmd == NAND_CMD_NONE)
161 txx9ndfmc_write(dev, 0, TXX9_NDFDTR);
162 }
163 mmiowb();
164}
165
166static int txx9ndfmc_dev_ready(struct mtd_info *mtd)
167{
168 struct platform_device *dev = mtd_to_platdev(mtd);
169
170 return !(txx9ndfmc_read(dev, TXX9_NDFSR) & TXX9_NDFSR_BUSY);
171}
172
173static int txx9ndfmc_calculate_ecc(struct mtd_info *mtd, const uint8_t *dat,
174 uint8_t *ecc_code)
175{
176 struct platform_device *dev = mtd_to_platdev(mtd);
177 struct nand_chip *chip = mtd_to_nand(mtd);
178 int eccbytes;
179 u32 mcr = txx9ndfmc_read(dev, TXX9_NDFMCR);
180
181 mcr &= ~TXX9_NDFMCR_ECC_ALL;
182 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_ECC_OFF, TXX9_NDFMCR);
183 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_ECC_READ, TXX9_NDFMCR);
184 for (eccbytes = chip->ecc.bytes; eccbytes > 0; eccbytes -= 3) {
185 ecc_code[1] = txx9ndfmc_read(dev, TXX9_NDFDTR);
186 ecc_code[0] = txx9ndfmc_read(dev, TXX9_NDFDTR);
187 ecc_code[2] = txx9ndfmc_read(dev, TXX9_NDFDTR);
188 ecc_code += 3;
189 }
190 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_ECC_OFF, TXX9_NDFMCR);
191 return 0;
192}
193
194static int txx9ndfmc_correct_data(struct mtd_info *mtd, unsigned char *buf,
195 unsigned char *read_ecc, unsigned char *calc_ecc)
196{
197 struct nand_chip *chip = mtd_to_nand(mtd);
198 int eccsize;
199 int corrected = 0;
200 int stat;
201
202 for (eccsize = chip->ecc.size; eccsize > 0; eccsize -= 256) {
203 stat = __nand_correct_data(buf, read_ecc, calc_ecc, 256);
204 if (stat < 0)
205 return stat;
206 corrected += stat;
207 buf += 256;
208 read_ecc += 3;
209 calc_ecc += 3;
210 }
211 return corrected;
212}
213
214static void txx9ndfmc_enable_hwecc(struct mtd_info *mtd, int mode)
215{
216 struct platform_device *dev = mtd_to_platdev(mtd);
217 u32 mcr = txx9ndfmc_read(dev, TXX9_NDFMCR);
218
219 mcr &= ~TXX9_NDFMCR_ECC_ALL;
220 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_ECC_RESET, TXX9_NDFMCR);
221 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_ECC_OFF, TXX9_NDFMCR);
222 txx9ndfmc_write(dev, mcr | TXX9_NDFMCR_ECC_ON, TXX9_NDFMCR);
223}
224
225static void txx9ndfmc_initialize(struct platform_device *dev)
226{
227 struct txx9ndfmc_platform_data *plat = dev_get_platdata(&dev->dev);
228 struct txx9ndfmc_drvdata *drvdata = platform_get_drvdata(dev);
229 int tmout = 100;
230
231 if (plat->flags & NDFMC_PLAT_FLAG_NO_RSTR)
232 ; /* no NDFRSTR. Write to NDFSPR resets the NDFMC. */
233 else {
234 /* reset NDFMC */
235 txx9ndfmc_write(dev,
236 txx9ndfmc_read(dev, TXX9_NDFRSTR) |
237 TXX9_NDFRSTR_RST,
238 TXX9_NDFRSTR);
239 while (txx9ndfmc_read(dev, TXX9_NDFRSTR) & TXX9_NDFRSTR_RST) {
240 if (--tmout == 0) {
241 dev_err(&dev->dev, "reset failed.\n");
242 break;
243 }
244 udelay(1);
245 }
246 }
247 /* setup Hold Time, Strobe Pulse Width */
248 txx9ndfmc_write(dev, (drvdata->hold << 4) | drvdata->spw, TXX9_NDFSPR);
249 txx9ndfmc_write(dev,
250 (plat->flags & NDFMC_PLAT_FLAG_USE_BSPRT) ?
251 TXX9_NDFMCR_BSPRT : 0, TXX9_NDFMCR);
252}
253
254#define TXX9NDFMC_NS_TO_CYC(gbusclk, ns) \
255 DIV_ROUND_UP((ns) * DIV_ROUND_UP(gbusclk, 1000), 1000000)
256
257static int txx9ndfmc_nand_scan(struct mtd_info *mtd)
258{
259 struct nand_chip *chip = mtd_to_nand(mtd);
260 int ret;
261
262 ret = nand_scan_ident(mtd, 1, NULL);
263 if (!ret) {
264 if (mtd->writesize >= 512) {
265 /* Hardware ECC 6 byte ECC per 512 Byte data */
266 chip->ecc.size = 512;
267 chip->ecc.bytes = 6;
268 }
269 ret = nand_scan_tail(mtd);
270 }
271 return ret;
272}
273
274static int __init txx9ndfmc_probe(struct platform_device *dev)
275{
276 struct txx9ndfmc_platform_data *plat = dev_get_platdata(&dev->dev);
277 int hold, spw;
278 int i;
279 struct txx9ndfmc_drvdata *drvdata;
280 unsigned long gbusclk = plat->gbus_clock;
281 struct resource *res;
282
283 drvdata = devm_kzalloc(&dev->dev, sizeof(*drvdata), GFP_KERNEL);
284 if (!drvdata)
285 return -ENOMEM;
286 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
287 drvdata->base = devm_ioremap_resource(&dev->dev, res);
288 if (IS_ERR(drvdata->base))
289 return PTR_ERR(drvdata->base);
290
291 hold = plat->hold ?: 20; /* tDH */
292 spw = plat->spw ?: 90; /* max(tREADID, tWP, tRP) */
293
294 hold = TXX9NDFMC_NS_TO_CYC(gbusclk, hold);
295 spw = TXX9NDFMC_NS_TO_CYC(gbusclk, spw);
296 if (plat->flags & NDFMC_PLAT_FLAG_HOLDADD)
297 hold -= 2; /* actual hold time : (HOLD + 2) BUSCLK */
298 spw -= 1; /* actual wait time : (SPW + 1) BUSCLK */
299 hold = clamp(hold, 1, 15);
300 drvdata->hold = hold;
301 spw = clamp(spw, 1, 15);
302 drvdata->spw = spw;
303 dev_info(&dev->dev, "CLK:%ldMHz HOLD:%d SPW:%d\n",
304 (gbusclk + 500000) / 1000000, hold, spw);
305
306 nand_hw_control_init(&drvdata->hw_control);
307
308 platform_set_drvdata(dev, drvdata);
309 txx9ndfmc_initialize(dev);
310
311 for (i = 0; i < MAX_TXX9NDFMC_DEV; i++) {
312 struct txx9ndfmc_priv *txx9_priv;
313 struct nand_chip *chip;
314 struct mtd_info *mtd;
315
316 if (!(plat->ch_mask & (1 << i)))
317 continue;
318 txx9_priv = kzalloc(sizeof(struct txx9ndfmc_priv),
319 GFP_KERNEL);
320 if (!txx9_priv)
321 continue;
322 chip = &txx9_priv->chip;
323 mtd = nand_to_mtd(chip);
324 mtd->dev.parent = &dev->dev;
325
326 chip->read_byte = txx9ndfmc_read_byte;
327 chip->read_buf = txx9ndfmc_read_buf;
328 chip->write_buf = txx9ndfmc_write_buf;
329 chip->cmd_ctrl = txx9ndfmc_cmd_ctrl;
330 chip->dev_ready = txx9ndfmc_dev_ready;
331 chip->ecc.calculate = txx9ndfmc_calculate_ecc;
332 chip->ecc.correct = txx9ndfmc_correct_data;
333 chip->ecc.hwctl = txx9ndfmc_enable_hwecc;
334 chip->ecc.mode = NAND_ECC_HW;
335 /* txx9ndfmc_nand_scan will overwrite ecc.size and ecc.bytes */
336 chip->ecc.size = 256;
337 chip->ecc.bytes = 3;
338 chip->ecc.strength = 1;
339 chip->chip_delay = 100;
340 chip->controller = &drvdata->hw_control;
341
342 nand_set_controller_data(chip, txx9_priv);
343 txx9_priv->dev = dev;
344
345 if (plat->ch_mask != 1) {
346 txx9_priv->cs = i;
347 txx9_priv->mtdname = kasprintf(GFP_KERNEL, "%s.%u",
348 dev_name(&dev->dev), i);
349 } else {
350 txx9_priv->cs = -1;
351 txx9_priv->mtdname = kstrdup(dev_name(&dev->dev),
352 GFP_KERNEL);
353 }
354 if (!txx9_priv->mtdname) {
355 kfree(txx9_priv);
356 dev_err(&dev->dev, "Unable to allocate MTD name.\n");
357 continue;
358 }
359 if (plat->wide_mask & (1 << i))
360 chip->options |= NAND_BUSWIDTH_16;
361
362 if (txx9ndfmc_nand_scan(mtd)) {
363 kfree(txx9_priv->mtdname);
364 kfree(txx9_priv);
365 continue;
366 }
367 mtd->name = txx9_priv->mtdname;
368
369 mtd_device_parse_register(mtd, NULL, NULL, NULL, 0);
370 drvdata->mtds[i] = mtd;
371 }
372
373 return 0;
374}
375
376static int __exit txx9ndfmc_remove(struct platform_device *dev)
377{
378 struct txx9ndfmc_drvdata *drvdata = platform_get_drvdata(dev);
379 int i;
380
381 if (!drvdata)
382 return 0;
383 for (i = 0; i < MAX_TXX9NDFMC_DEV; i++) {
384 struct mtd_info *mtd = drvdata->mtds[i];
385 struct nand_chip *chip;
386 struct txx9ndfmc_priv *txx9_priv;
387
388 if (!mtd)
389 continue;
390 chip = mtd_to_nand(mtd);
391 txx9_priv = nand_get_controller_data(chip);
392
393 nand_release(mtd);
394 kfree(txx9_priv->mtdname);
395 kfree(txx9_priv);
396 }
397 return 0;
398}
399
400#ifdef CONFIG_PM
401static int txx9ndfmc_resume(struct platform_device *dev)
402{
403 if (platform_get_drvdata(dev))
404 txx9ndfmc_initialize(dev);
405 return 0;
406}
407#else
408#define txx9ndfmc_resume NULL
409#endif
410
411static struct platform_driver txx9ndfmc_driver = {
412 .remove = __exit_p(txx9ndfmc_remove),
413 .resume = txx9ndfmc_resume,
414 .driver = {
415 .name = "txx9ndfmc",
416 },
417};
418
419module_platform_driver_probe(txx9ndfmc_driver, txx9ndfmc_probe);
420
421MODULE_LICENSE("GPL");
422MODULE_DESCRIPTION("TXx9 SoC NAND flash controller driver");
423MODULE_ALIAS("platform:txx9ndfmc");