blob: e604a458c8a6dc5e0d123caa520b714545ab00e3 [file] [log] [blame]
Vimal Singh67ce04b2009-05-12 13:47:03 -07001/*
2 * Copyright © 2004 Texas Instruments, Jian Zhang <jzhang@ti.com>
3 * Copyright © 2004 Micron Technology Inc.
4 * Copyright © 2004 David Brownell
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
10
11#include <linux/platform_device.h>
Russell King763e7352012-04-25 00:16:00 +010012#include <linux/dmaengine.h>
Vimal Singh67ce04b2009-05-12 13:47:03 -070013#include <linux/dma-mapping.h>
14#include <linux/delay.h>
Paul Gortmakera0e5cc52011-07-03 15:17:31 -040015#include <linux/module.h>
Sukumar Ghorai4e070372011-01-28 15:42:06 +053016#include <linux/interrupt.h>
vimal singhc276aca2009-06-27 11:07:06 +053017#include <linux/jiffies.h>
18#include <linux/sched.h>
Vimal Singh67ce04b2009-05-12 13:47:03 -070019#include <linux/mtd/mtd.h>
20#include <linux/mtd/nand.h>
21#include <linux/mtd/partitions.h>
Russell King763e7352012-04-25 00:16:00 +010022#include <linux/omap-dma.h>
Vimal Singh67ce04b2009-05-12 13:47:03 -070023#include <linux/io.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
Vimal Singh67ce04b2009-05-12 13:47:03 -070025
Ivan Djelic0e618ef2012-04-30 12:17:18 +020026#ifdef CONFIG_MTD_NAND_OMAP_BCH
27#include <linux/bch.h>
28#endif
29
Tony Lindgrence491cf2009-10-20 09:40:47 -070030#include <plat/dma.h>
31#include <plat/gpmc.h>
32#include <plat/nand.h>
Vimal Singh67ce04b2009-05-12 13:47:03 -070033
Vimal Singh67ce04b2009-05-12 13:47:03 -070034#define DRIVER_NAME "omap2-nand"
Sukumar Ghorai4e070372011-01-28 15:42:06 +053035#define OMAP_NAND_TIMEOUT_MS 5000
Vimal Singh67ce04b2009-05-12 13:47:03 -070036
Vimal Singh67ce04b2009-05-12 13:47:03 -070037#define NAND_Ecc_P1e (1 << 0)
38#define NAND_Ecc_P2e (1 << 1)
39#define NAND_Ecc_P4e (1 << 2)
40#define NAND_Ecc_P8e (1 << 3)
41#define NAND_Ecc_P16e (1 << 4)
42#define NAND_Ecc_P32e (1 << 5)
43#define NAND_Ecc_P64e (1 << 6)
44#define NAND_Ecc_P128e (1 << 7)
45#define NAND_Ecc_P256e (1 << 8)
46#define NAND_Ecc_P512e (1 << 9)
47#define NAND_Ecc_P1024e (1 << 10)
48#define NAND_Ecc_P2048e (1 << 11)
49
50#define NAND_Ecc_P1o (1 << 16)
51#define NAND_Ecc_P2o (1 << 17)
52#define NAND_Ecc_P4o (1 << 18)
53#define NAND_Ecc_P8o (1 << 19)
54#define NAND_Ecc_P16o (1 << 20)
55#define NAND_Ecc_P32o (1 << 21)
56#define NAND_Ecc_P64o (1 << 22)
57#define NAND_Ecc_P128o (1 << 23)
58#define NAND_Ecc_P256o (1 << 24)
59#define NAND_Ecc_P512o (1 << 25)
60#define NAND_Ecc_P1024o (1 << 26)
61#define NAND_Ecc_P2048o (1 << 27)
62
63#define TF(value) (value ? 1 : 0)
64
65#define P2048e(a) (TF(a & NAND_Ecc_P2048e) << 0)
66#define P2048o(a) (TF(a & NAND_Ecc_P2048o) << 1)
67#define P1e(a) (TF(a & NAND_Ecc_P1e) << 2)
68#define P1o(a) (TF(a & NAND_Ecc_P1o) << 3)
69#define P2e(a) (TF(a & NAND_Ecc_P2e) << 4)
70#define P2o(a) (TF(a & NAND_Ecc_P2o) << 5)
71#define P4e(a) (TF(a & NAND_Ecc_P4e) << 6)
72#define P4o(a) (TF(a & NAND_Ecc_P4o) << 7)
73
74#define P8e(a) (TF(a & NAND_Ecc_P8e) << 0)
75#define P8o(a) (TF(a & NAND_Ecc_P8o) << 1)
76#define P16e(a) (TF(a & NAND_Ecc_P16e) << 2)
77#define P16o(a) (TF(a & NAND_Ecc_P16o) << 3)
78#define P32e(a) (TF(a & NAND_Ecc_P32e) << 4)
79#define P32o(a) (TF(a & NAND_Ecc_P32o) << 5)
80#define P64e(a) (TF(a & NAND_Ecc_P64e) << 6)
81#define P64o(a) (TF(a & NAND_Ecc_P64o) << 7)
82
83#define P128e(a) (TF(a & NAND_Ecc_P128e) << 0)
84#define P128o(a) (TF(a & NAND_Ecc_P128o) << 1)
85#define P256e(a) (TF(a & NAND_Ecc_P256e) << 2)
86#define P256o(a) (TF(a & NAND_Ecc_P256o) << 3)
87#define P512e(a) (TF(a & NAND_Ecc_P512e) << 4)
88#define P512o(a) (TF(a & NAND_Ecc_P512o) << 5)
89#define P1024e(a) (TF(a & NAND_Ecc_P1024e) << 6)
90#define P1024o(a) (TF(a & NAND_Ecc_P1024o) << 7)
91
92#define P8e_s(a) (TF(a & NAND_Ecc_P8e) << 0)
93#define P8o_s(a) (TF(a & NAND_Ecc_P8o) << 1)
94#define P16e_s(a) (TF(a & NAND_Ecc_P16e) << 2)
95#define P16o_s(a) (TF(a & NAND_Ecc_P16o) << 3)
96#define P1e_s(a) (TF(a & NAND_Ecc_P1e) << 4)
97#define P1o_s(a) (TF(a & NAND_Ecc_P1o) << 5)
98#define P2e_s(a) (TF(a & NAND_Ecc_P2e) << 6)
99#define P2o_s(a) (TF(a & NAND_Ecc_P2o) << 7)
100
101#define P4e_s(a) (TF(a & NAND_Ecc_P4e) << 0)
102#define P4o_s(a) (TF(a & NAND_Ecc_P4o) << 1)
103
Sukumar Ghoraif040d332011-01-28 15:42:09 +0530104/* oob info generated runtime depending on ecc algorithm and layout selected */
105static struct nand_ecclayout omap_oobinfo;
106/* Define some generic bad / good block scan pattern which are used
107 * while scanning a device for factory marked good / bad blocks
108 */
109static uint8_t scan_ff_pattern[] = { 0xff };
110static struct nand_bbt_descr bb_descrip_flashbased = {
111 .options = NAND_BBT_SCANEMPTY | NAND_BBT_SCANALLPAGES,
112 .offs = 0,
113 .len = 1,
114 .pattern = scan_ff_pattern,
115};
vimal singh59e9c5a2009-07-13 16:26:24 +0530116
vimal singh59e9c5a2009-07-13 16:26:24 +0530117
Vimal Singh67ce04b2009-05-12 13:47:03 -0700118struct omap_nand_info {
119 struct nand_hw_control controller;
120 struct omap_nand_platform_data *pdata;
121 struct mtd_info mtd;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700122 struct nand_chip nand;
123 struct platform_device *pdev;
124
125 int gpmc_cs;
126 unsigned long phys_base;
vimal singhdfe32892009-07-13 16:29:16 +0530127 struct completion comp;
Russell King763e7352012-04-25 00:16:00 +0100128 struct dma_chan *dma;
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530129 int gpmc_irq;
130 enum {
131 OMAP_NAND_IO_READ = 0, /* read */
132 OMAP_NAND_IO_WRITE, /* write */
133 } iomode;
134 u_char *buf;
135 int buf_len;
Ivan Djelic0e618ef2012-04-30 12:17:18 +0200136
137#ifdef CONFIG_MTD_NAND_OMAP_BCH
138 struct bch_control *bch;
139 struct nand_ecclayout ecclayout;
140#endif
Vimal Singh67ce04b2009-05-12 13:47:03 -0700141};
142
143/**
Vimal Singh67ce04b2009-05-12 13:47:03 -0700144 * omap_hwcontrol - hardware specific access to control-lines
145 * @mtd: MTD device structure
146 * @cmd: command to device
147 * @ctrl:
148 * NAND_NCE: bit 0 -> don't care
149 * NAND_CLE: bit 1 -> Command Latch
150 * NAND_ALE: bit 2 -> Address Latch
151 *
152 * NOTE: boards may use different bits for these!!
153 */
154static void omap_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int ctrl)
155{
156 struct omap_nand_info *info = container_of(mtd,
157 struct omap_nand_info, mtd);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700158
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000159 if (cmd != NAND_CMD_NONE) {
160 if (ctrl & NAND_CLE)
161 gpmc_nand_write(info->gpmc_cs, GPMC_NAND_COMMAND, cmd);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700162
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000163 else if (ctrl & NAND_ALE)
164 gpmc_nand_write(info->gpmc_cs, GPMC_NAND_ADDRESS, cmd);
165
166 else /* NAND_NCE */
167 gpmc_nand_write(info->gpmc_cs, GPMC_NAND_DATA, cmd);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700168 }
Vimal Singh67ce04b2009-05-12 13:47:03 -0700169}
170
171/**
vimal singh59e9c5a2009-07-13 16:26:24 +0530172 * omap_read_buf8 - read data from NAND controller into buffer
173 * @mtd: MTD device structure
174 * @buf: buffer to store date
175 * @len: number of bytes to read
176 */
177static void omap_read_buf8(struct mtd_info *mtd, u_char *buf, int len)
178{
179 struct nand_chip *nand = mtd->priv;
180
181 ioread8_rep(nand->IO_ADDR_R, buf, len);
182}
183
184/**
185 * omap_write_buf8 - write buffer to NAND controller
186 * @mtd: MTD device structure
187 * @buf: data buffer
188 * @len: number of bytes to write
189 */
190static void omap_write_buf8(struct mtd_info *mtd, const u_char *buf, int len)
191{
192 struct omap_nand_info *info = container_of(mtd,
193 struct omap_nand_info, mtd);
194 u_char *p = (u_char *)buf;
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000195 u32 status = 0;
vimal singh59e9c5a2009-07-13 16:26:24 +0530196
197 while (len--) {
198 iowrite8(*p++, info->nand.IO_ADDR_W);
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000199 /* wait until buffer is available for write */
200 do {
201 status = gpmc_read_status(GPMC_STATUS_BUFFER);
202 } while (!status);
vimal singh59e9c5a2009-07-13 16:26:24 +0530203 }
204}
205
206/**
Vimal Singh67ce04b2009-05-12 13:47:03 -0700207 * omap_read_buf16 - read data from NAND controller into buffer
208 * @mtd: MTD device structure
209 * @buf: buffer to store date
210 * @len: number of bytes to read
211 */
212static void omap_read_buf16(struct mtd_info *mtd, u_char *buf, int len)
213{
214 struct nand_chip *nand = mtd->priv;
215
vimal singh59e9c5a2009-07-13 16:26:24 +0530216 ioread16_rep(nand->IO_ADDR_R, buf, len / 2);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700217}
218
219/**
220 * omap_write_buf16 - write buffer to NAND controller
221 * @mtd: MTD device structure
222 * @buf: data buffer
223 * @len: number of bytes to write
224 */
225static void omap_write_buf16(struct mtd_info *mtd, const u_char * buf, int len)
226{
227 struct omap_nand_info *info = container_of(mtd,
228 struct omap_nand_info, mtd);
229 u16 *p = (u16 *) buf;
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000230 u32 status = 0;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700231 /* FIXME try bursts of writesw() or DMA ... */
232 len >>= 1;
233
234 while (len--) {
vimal singh59e9c5a2009-07-13 16:26:24 +0530235 iowrite16(*p++, info->nand.IO_ADDR_W);
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000236 /* wait until buffer is available for write */
237 do {
238 status = gpmc_read_status(GPMC_STATUS_BUFFER);
239 } while (!status);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700240 }
241}
vimal singh59e9c5a2009-07-13 16:26:24 +0530242
243/**
244 * omap_read_buf_pref - read data from NAND controller into buffer
245 * @mtd: MTD device structure
246 * @buf: buffer to store date
247 * @len: number of bytes to read
248 */
249static void omap_read_buf_pref(struct mtd_info *mtd, u_char *buf, int len)
250{
251 struct omap_nand_info *info = container_of(mtd,
252 struct omap_nand_info, mtd);
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000253 uint32_t r_count = 0;
vimal singh59e9c5a2009-07-13 16:26:24 +0530254 int ret = 0;
255 u32 *p = (u32 *)buf;
256
257 /* take care of subpage reads */
Vimal Singhc3341d02010-01-07 12:16:26 +0530258 if (len % 4) {
259 if (info->nand.options & NAND_BUSWIDTH_16)
260 omap_read_buf16(mtd, buf, len % 4);
261 else
262 omap_read_buf8(mtd, buf, len % 4);
263 p = (u32 *) (buf + len % 4);
264 len -= len % 4;
vimal singh59e9c5a2009-07-13 16:26:24 +0530265 }
vimal singh59e9c5a2009-07-13 16:26:24 +0530266
267 /* configure and start prefetch transfer */
Sukumar Ghorai317379a2011-01-28 15:42:07 +0530268 ret = gpmc_prefetch_enable(info->gpmc_cs,
269 PREFETCH_FIFOTHRESHOLD_MAX, 0x0, len, 0x0);
vimal singh59e9c5a2009-07-13 16:26:24 +0530270 if (ret) {
271 /* PFPW engine is busy, use cpu copy method */
272 if (info->nand.options & NAND_BUSWIDTH_16)
Kishore Kadiyalac5d8c0c2011-05-11 21:17:27 +0530273 omap_read_buf16(mtd, (u_char *)p, len);
vimal singh59e9c5a2009-07-13 16:26:24 +0530274 else
Kishore Kadiyalac5d8c0c2011-05-11 21:17:27 +0530275 omap_read_buf8(mtd, (u_char *)p, len);
vimal singh59e9c5a2009-07-13 16:26:24 +0530276 } else {
277 do {
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000278 r_count = gpmc_read_status(GPMC_PREFETCH_FIFO_CNT);
279 r_count = r_count >> 2;
280 ioread32_rep(info->nand.IO_ADDR_R, p, r_count);
vimal singh59e9c5a2009-07-13 16:26:24 +0530281 p += r_count;
282 len -= r_count << 2;
283 } while (len);
vimal singh59e9c5a2009-07-13 16:26:24 +0530284 /* disable and stop the PFPW engine */
Sukumar Ghorai948d38e2010-07-09 09:14:44 +0000285 gpmc_prefetch_reset(info->gpmc_cs);
vimal singh59e9c5a2009-07-13 16:26:24 +0530286 }
287}
288
289/**
290 * omap_write_buf_pref - write buffer to NAND controller
291 * @mtd: MTD device structure
292 * @buf: data buffer
293 * @len: number of bytes to write
294 */
295static void omap_write_buf_pref(struct mtd_info *mtd,
296 const u_char *buf, int len)
297{
298 struct omap_nand_info *info = container_of(mtd,
299 struct omap_nand_info, mtd);
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530300 uint32_t w_count = 0;
vimal singh59e9c5a2009-07-13 16:26:24 +0530301 int i = 0, ret = 0;
Kishore Kadiyalac5d8c0c2011-05-11 21:17:27 +0530302 u16 *p = (u16 *)buf;
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530303 unsigned long tim, limit;
vimal singh59e9c5a2009-07-13 16:26:24 +0530304
305 /* take care of subpage writes */
306 if (len % 2 != 0) {
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000307 writeb(*buf, info->nand.IO_ADDR_W);
vimal singh59e9c5a2009-07-13 16:26:24 +0530308 p = (u16 *)(buf + 1);
309 len--;
310 }
311
312 /* configure and start prefetch transfer */
Sukumar Ghorai317379a2011-01-28 15:42:07 +0530313 ret = gpmc_prefetch_enable(info->gpmc_cs,
314 PREFETCH_FIFOTHRESHOLD_MAX, 0x0, len, 0x1);
vimal singh59e9c5a2009-07-13 16:26:24 +0530315 if (ret) {
316 /* PFPW engine is busy, use cpu copy method */
317 if (info->nand.options & NAND_BUSWIDTH_16)
Kishore Kadiyalac5d8c0c2011-05-11 21:17:27 +0530318 omap_write_buf16(mtd, (u_char *)p, len);
vimal singh59e9c5a2009-07-13 16:26:24 +0530319 else
Kishore Kadiyalac5d8c0c2011-05-11 21:17:27 +0530320 omap_write_buf8(mtd, (u_char *)p, len);
vimal singh59e9c5a2009-07-13 16:26:24 +0530321 } else {
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000322 while (len) {
323 w_count = gpmc_read_status(GPMC_PREFETCH_FIFO_CNT);
324 w_count = w_count >> 1;
vimal singh59e9c5a2009-07-13 16:26:24 +0530325 for (i = 0; (i < w_count) && len; i++, len -= 2)
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000326 iowrite16(*p++, info->nand.IO_ADDR_W);
vimal singh59e9c5a2009-07-13 16:26:24 +0530327 }
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000328 /* wait for data to flushed-out before reset the prefetch */
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530329 tim = 0;
330 limit = (loops_per_jiffy *
331 msecs_to_jiffies(OMAP_NAND_TIMEOUT_MS));
332 while (gpmc_read_status(GPMC_PREFETCH_COUNT) && (tim++ < limit))
333 cpu_relax();
334
vimal singh59e9c5a2009-07-13 16:26:24 +0530335 /* disable and stop the PFPW engine */
Sukumar Ghorai948d38e2010-07-09 09:14:44 +0000336 gpmc_prefetch_reset(info->gpmc_cs);
vimal singh59e9c5a2009-07-13 16:26:24 +0530337 }
338}
339
vimal singhdfe32892009-07-13 16:29:16 +0530340/*
Russell King2df41d02012-04-25 00:19:39 +0100341 * omap_nand_dma_callback: callback on the completion of dma transfer
vimal singhdfe32892009-07-13 16:29:16 +0530342 * @data: pointer to completion data structure
343 */
Russell King763e7352012-04-25 00:16:00 +0100344static void omap_nand_dma_callback(void *data)
345{
346 complete((struct completion *) data);
347}
vimal singhdfe32892009-07-13 16:29:16 +0530348
349/*
Peter Meerwald4cacbe22012-07-19 13:21:04 +0200350 * omap_nand_dma_transfer: configure and start dma transfer
vimal singhdfe32892009-07-13 16:29:16 +0530351 * @mtd: MTD device structure
352 * @addr: virtual address in RAM of source/destination
353 * @len: number of data bytes to be transferred
354 * @is_write: flag for read/write operation
355 */
356static inline int omap_nand_dma_transfer(struct mtd_info *mtd, void *addr,
357 unsigned int len, int is_write)
358{
359 struct omap_nand_info *info = container_of(mtd,
360 struct omap_nand_info, mtd);
Russell King2df41d02012-04-25 00:19:39 +0100361 struct dma_async_tx_descriptor *tx;
vimal singhdfe32892009-07-13 16:29:16 +0530362 enum dma_data_direction dir = is_write ? DMA_TO_DEVICE :
363 DMA_FROM_DEVICE;
Russell King2df41d02012-04-25 00:19:39 +0100364 struct scatterlist sg;
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530365 unsigned long tim, limit;
Russell King2df41d02012-04-25 00:19:39 +0100366 unsigned n;
367 int ret;
vimal singhdfe32892009-07-13 16:29:16 +0530368
369 if (addr >= high_memory) {
370 struct page *p1;
371
372 if (((size_t)addr & PAGE_MASK) !=
373 ((size_t)(addr + len - 1) & PAGE_MASK))
374 goto out_copy;
375 p1 = vmalloc_to_page(addr);
376 if (!p1)
377 goto out_copy;
378 addr = page_address(p1) + ((size_t)addr & ~PAGE_MASK);
379 }
380
Russell King2df41d02012-04-25 00:19:39 +0100381 sg_init_one(&sg, addr, len);
382 n = dma_map_sg(info->dma->device->dev, &sg, 1, dir);
383 if (n == 0) {
vimal singhdfe32892009-07-13 16:29:16 +0530384 dev_err(&info->pdev->dev,
385 "Couldn't DMA map a %d byte buffer\n", len);
386 goto out_copy;
387 }
388
Russell King2df41d02012-04-25 00:19:39 +0100389 tx = dmaengine_prep_slave_sg(info->dma, &sg, n,
390 is_write ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM,
391 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
392 if (!tx)
393 goto out_copy_unmap;
394
395 tx->callback = omap_nand_dma_callback;
396 tx->callback_param = &info->comp;
397 dmaengine_submit(tx);
398
399 /* configure and start prefetch transfer */
Sukumar Ghorai317379a2011-01-28 15:42:07 +0530400 ret = gpmc_prefetch_enable(info->gpmc_cs,
Russell King2df41d02012-04-25 00:19:39 +0100401 PREFETCH_FIFOTHRESHOLD_MAX, 0x1, len, is_write);
vimal singhdfe32892009-07-13 16:29:16 +0530402 if (ret)
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530403 /* PFPW engine is busy, use cpu copy method */
Grazvydas Ignotasd7efe222012-04-11 04:04:34 +0300404 goto out_copy_unmap;
vimal singhdfe32892009-07-13 16:29:16 +0530405
406 init_completion(&info->comp);
Russell King2df41d02012-04-25 00:19:39 +0100407 dma_async_issue_pending(info->dma);
vimal singhdfe32892009-07-13 16:29:16 +0530408
409 /* setup and start DMA using dma_addr */
410 wait_for_completion(&info->comp);
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530411 tim = 0;
412 limit = (loops_per_jiffy * msecs_to_jiffies(OMAP_NAND_TIMEOUT_MS));
413 while (gpmc_read_status(GPMC_PREFETCH_COUNT) && (tim++ < limit))
414 cpu_relax();
vimal singhdfe32892009-07-13 16:29:16 +0530415
vimal singhdfe32892009-07-13 16:29:16 +0530416 /* disable and stop the PFPW engine */
Daniel J Bluemanf12f6622010-09-29 21:01:55 +0100417 gpmc_prefetch_reset(info->gpmc_cs);
vimal singhdfe32892009-07-13 16:29:16 +0530418
Russell King2df41d02012-04-25 00:19:39 +0100419 dma_unmap_sg(info->dma->device->dev, &sg, 1, dir);
vimal singhdfe32892009-07-13 16:29:16 +0530420 return 0;
421
Grazvydas Ignotasd7efe222012-04-11 04:04:34 +0300422out_copy_unmap:
Russell King2df41d02012-04-25 00:19:39 +0100423 dma_unmap_sg(info->dma->device->dev, &sg, 1, dir);
vimal singhdfe32892009-07-13 16:29:16 +0530424out_copy:
425 if (info->nand.options & NAND_BUSWIDTH_16)
426 is_write == 0 ? omap_read_buf16(mtd, (u_char *) addr, len)
427 : omap_write_buf16(mtd, (u_char *) addr, len);
428 else
429 is_write == 0 ? omap_read_buf8(mtd, (u_char *) addr, len)
430 : omap_write_buf8(mtd, (u_char *) addr, len);
431 return 0;
432}
vimal singhdfe32892009-07-13 16:29:16 +0530433
434/**
435 * omap_read_buf_dma_pref - read data from NAND controller into buffer
436 * @mtd: MTD device structure
437 * @buf: buffer to store date
438 * @len: number of bytes to read
439 */
440static void omap_read_buf_dma_pref(struct mtd_info *mtd, u_char *buf, int len)
441{
442 if (len <= mtd->oobsize)
443 omap_read_buf_pref(mtd, buf, len);
444 else
445 /* start transfer in DMA mode */
446 omap_nand_dma_transfer(mtd, buf, len, 0x0);
447}
448
449/**
450 * omap_write_buf_dma_pref - write buffer to NAND controller
451 * @mtd: MTD device structure
452 * @buf: data buffer
453 * @len: number of bytes to write
454 */
455static void omap_write_buf_dma_pref(struct mtd_info *mtd,
456 const u_char *buf, int len)
457{
458 if (len <= mtd->oobsize)
459 omap_write_buf_pref(mtd, buf, len);
460 else
461 /* start transfer in DMA mode */
Vimal Singhbdaefc42010-01-05 12:49:24 +0530462 omap_nand_dma_transfer(mtd, (u_char *) buf, len, 0x1);
vimal singhdfe32892009-07-13 16:29:16 +0530463}
464
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530465/*
Peter Meerwald4cacbe22012-07-19 13:21:04 +0200466 * omap_nand_irq - GPMC irq handler
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530467 * @this_irq: gpmc irq number
468 * @dev: omap_nand_info structure pointer is passed here
469 */
470static irqreturn_t omap_nand_irq(int this_irq, void *dev)
471{
472 struct omap_nand_info *info = (struct omap_nand_info *) dev;
473 u32 bytes;
474 u32 irq_stat;
475
476 irq_stat = gpmc_read_status(GPMC_GET_IRQ_STATUS);
477 bytes = gpmc_read_status(GPMC_PREFETCH_FIFO_CNT);
478 bytes = bytes & 0xFFFC; /* io in multiple of 4 bytes */
479 if (info->iomode == OMAP_NAND_IO_WRITE) { /* checks for write io */
480 if (irq_stat & 0x2)
481 goto done;
482
483 if (info->buf_len && (info->buf_len < bytes))
484 bytes = info->buf_len;
485 else if (!info->buf_len)
486 bytes = 0;
487 iowrite32_rep(info->nand.IO_ADDR_W,
488 (u32 *)info->buf, bytes >> 2);
489 info->buf = info->buf + bytes;
490 info->buf_len -= bytes;
491
492 } else {
493 ioread32_rep(info->nand.IO_ADDR_R,
494 (u32 *)info->buf, bytes >> 2);
495 info->buf = info->buf + bytes;
496
497 if (irq_stat & 0x2)
498 goto done;
499 }
500 gpmc_cs_configure(info->gpmc_cs, GPMC_SET_IRQ_STATUS, irq_stat);
501
502 return IRQ_HANDLED;
503
504done:
505 complete(&info->comp);
506 /* disable irq */
507 gpmc_cs_configure(info->gpmc_cs, GPMC_ENABLE_IRQ, 0);
508
509 /* clear status */
510 gpmc_cs_configure(info->gpmc_cs, GPMC_SET_IRQ_STATUS, irq_stat);
511
512 return IRQ_HANDLED;
513}
514
515/*
516 * omap_read_buf_irq_pref - read data from NAND controller into buffer
517 * @mtd: MTD device structure
518 * @buf: buffer to store date
519 * @len: number of bytes to read
520 */
521static void omap_read_buf_irq_pref(struct mtd_info *mtd, u_char *buf, int len)
522{
523 struct omap_nand_info *info = container_of(mtd,
524 struct omap_nand_info, mtd);
525 int ret = 0;
526
527 if (len <= mtd->oobsize) {
528 omap_read_buf_pref(mtd, buf, len);
529 return;
530 }
531
532 info->iomode = OMAP_NAND_IO_READ;
533 info->buf = buf;
534 init_completion(&info->comp);
535
536 /* configure and start prefetch transfer */
Sukumar Ghorai317379a2011-01-28 15:42:07 +0530537 ret = gpmc_prefetch_enable(info->gpmc_cs,
538 PREFETCH_FIFOTHRESHOLD_MAX/2, 0x0, len, 0x0);
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530539 if (ret)
540 /* PFPW engine is busy, use cpu copy method */
541 goto out_copy;
542
543 info->buf_len = len;
544 /* enable irq */
545 gpmc_cs_configure(info->gpmc_cs, GPMC_ENABLE_IRQ,
546 (GPMC_IRQ_FIFOEVENTENABLE | GPMC_IRQ_COUNT_EVENT));
547
548 /* waiting for read to complete */
549 wait_for_completion(&info->comp);
550
551 /* disable and stop the PFPW engine */
552 gpmc_prefetch_reset(info->gpmc_cs);
553 return;
554
555out_copy:
556 if (info->nand.options & NAND_BUSWIDTH_16)
557 omap_read_buf16(mtd, buf, len);
558 else
559 omap_read_buf8(mtd, buf, len);
560}
561
562/*
563 * omap_write_buf_irq_pref - write buffer to NAND controller
564 * @mtd: MTD device structure
565 * @buf: data buffer
566 * @len: number of bytes to write
567 */
568static void omap_write_buf_irq_pref(struct mtd_info *mtd,
569 const u_char *buf, int len)
570{
571 struct omap_nand_info *info = container_of(mtd,
572 struct omap_nand_info, mtd);
573 int ret = 0;
574 unsigned long tim, limit;
575
576 if (len <= mtd->oobsize) {
577 omap_write_buf_pref(mtd, buf, len);
578 return;
579 }
580
581 info->iomode = OMAP_NAND_IO_WRITE;
582 info->buf = (u_char *) buf;
583 init_completion(&info->comp);
584
Sukumar Ghorai317379a2011-01-28 15:42:07 +0530585 /* configure and start prefetch transfer : size=24 */
586 ret = gpmc_prefetch_enable(info->gpmc_cs,
587 (PREFETCH_FIFOTHRESHOLD_MAX * 3) / 8, 0x0, len, 0x1);
Sukumar Ghorai4e070372011-01-28 15:42:06 +0530588 if (ret)
589 /* PFPW engine is busy, use cpu copy method */
590 goto out_copy;
591
592 info->buf_len = len;
593 /* enable irq */
594 gpmc_cs_configure(info->gpmc_cs, GPMC_ENABLE_IRQ,
595 (GPMC_IRQ_FIFOEVENTENABLE | GPMC_IRQ_COUNT_EVENT));
596
597 /* waiting for write to complete */
598 wait_for_completion(&info->comp);
599 /* wait for data to flushed-out before reset the prefetch */
600 tim = 0;
601 limit = (loops_per_jiffy * msecs_to_jiffies(OMAP_NAND_TIMEOUT_MS));
602 while (gpmc_read_status(GPMC_PREFETCH_COUNT) && (tim++ < limit))
603 cpu_relax();
604
605 /* disable and stop the PFPW engine */
606 gpmc_prefetch_reset(info->gpmc_cs);
607 return;
608
609out_copy:
610 if (info->nand.options & NAND_BUSWIDTH_16)
611 omap_write_buf16(mtd, buf, len);
612 else
613 omap_write_buf8(mtd, buf, len);
614}
615
Vimal Singh67ce04b2009-05-12 13:47:03 -0700616/**
Vimal Singh67ce04b2009-05-12 13:47:03 -0700617 * gen_true_ecc - This function will generate true ECC value
618 * @ecc_buf: buffer to store ecc code
619 *
620 * This generated true ECC value can be used when correcting
621 * data read from NAND flash memory core
622 */
623static void gen_true_ecc(u8 *ecc_buf)
624{
625 u32 tmp = ecc_buf[0] | (ecc_buf[1] << 16) |
626 ((ecc_buf[2] & 0xF0) << 20) | ((ecc_buf[2] & 0x0F) << 8);
627
628 ecc_buf[0] = ~(P64o(tmp) | P64e(tmp) | P32o(tmp) | P32e(tmp) |
629 P16o(tmp) | P16e(tmp) | P8o(tmp) | P8e(tmp));
630 ecc_buf[1] = ~(P1024o(tmp) | P1024e(tmp) | P512o(tmp) | P512e(tmp) |
631 P256o(tmp) | P256e(tmp) | P128o(tmp) | P128e(tmp));
632 ecc_buf[2] = ~(P4o(tmp) | P4e(tmp) | P2o(tmp) | P2e(tmp) | P1o(tmp) |
633 P1e(tmp) | P2048o(tmp) | P2048e(tmp));
634}
635
636/**
637 * omap_compare_ecc - Detect (2 bits) and correct (1 bit) error in data
638 * @ecc_data1: ecc code from nand spare area
639 * @ecc_data2: ecc code from hardware register obtained from hardware ecc
640 * @page_data: page data
641 *
642 * This function compares two ECC's and indicates if there is an error.
643 * If the error can be corrected it will be corrected to the buffer.
John Ogness74f1b722011-02-28 13:12:46 +0100644 * If there is no error, %0 is returned. If there is an error but it
645 * was corrected, %1 is returned. Otherwise, %-1 is returned.
Vimal Singh67ce04b2009-05-12 13:47:03 -0700646 */
647static int omap_compare_ecc(u8 *ecc_data1, /* read from NAND memory */
648 u8 *ecc_data2, /* read from register */
649 u8 *page_data)
650{
651 uint i;
652 u8 tmp0_bit[8], tmp1_bit[8], tmp2_bit[8];
653 u8 comp0_bit[8], comp1_bit[8], comp2_bit[8];
654 u8 ecc_bit[24];
655 u8 ecc_sum = 0;
656 u8 find_bit = 0;
657 uint find_byte = 0;
658 int isEccFF;
659
660 isEccFF = ((*(u32 *)ecc_data1 & 0xFFFFFF) == 0xFFFFFF);
661
662 gen_true_ecc(ecc_data1);
663 gen_true_ecc(ecc_data2);
664
665 for (i = 0; i <= 2; i++) {
666 *(ecc_data1 + i) = ~(*(ecc_data1 + i));
667 *(ecc_data2 + i) = ~(*(ecc_data2 + i));
668 }
669
670 for (i = 0; i < 8; i++) {
671 tmp0_bit[i] = *ecc_data1 % 2;
672 *ecc_data1 = *ecc_data1 / 2;
673 }
674
675 for (i = 0; i < 8; i++) {
676 tmp1_bit[i] = *(ecc_data1 + 1) % 2;
677 *(ecc_data1 + 1) = *(ecc_data1 + 1) / 2;
678 }
679
680 for (i = 0; i < 8; i++) {
681 tmp2_bit[i] = *(ecc_data1 + 2) % 2;
682 *(ecc_data1 + 2) = *(ecc_data1 + 2) / 2;
683 }
684
685 for (i = 0; i < 8; i++) {
686 comp0_bit[i] = *ecc_data2 % 2;
687 *ecc_data2 = *ecc_data2 / 2;
688 }
689
690 for (i = 0; i < 8; i++) {
691 comp1_bit[i] = *(ecc_data2 + 1) % 2;
692 *(ecc_data2 + 1) = *(ecc_data2 + 1) / 2;
693 }
694
695 for (i = 0; i < 8; i++) {
696 comp2_bit[i] = *(ecc_data2 + 2) % 2;
697 *(ecc_data2 + 2) = *(ecc_data2 + 2) / 2;
698 }
699
700 for (i = 0; i < 6; i++)
701 ecc_bit[i] = tmp2_bit[i + 2] ^ comp2_bit[i + 2];
702
703 for (i = 0; i < 8; i++)
704 ecc_bit[i + 6] = tmp0_bit[i] ^ comp0_bit[i];
705
706 for (i = 0; i < 8; i++)
707 ecc_bit[i + 14] = tmp1_bit[i] ^ comp1_bit[i];
708
709 ecc_bit[22] = tmp2_bit[0] ^ comp2_bit[0];
710 ecc_bit[23] = tmp2_bit[1] ^ comp2_bit[1];
711
712 for (i = 0; i < 24; i++)
713 ecc_sum += ecc_bit[i];
714
715 switch (ecc_sum) {
716 case 0:
717 /* Not reached because this function is not called if
718 * ECC values are equal
719 */
720 return 0;
721
722 case 1:
723 /* Uncorrectable error */
Brian Norris289c0522011-07-19 10:06:09 -0700724 pr_debug("ECC UNCORRECTED_ERROR 1\n");
Vimal Singh67ce04b2009-05-12 13:47:03 -0700725 return -1;
726
727 case 11:
728 /* UN-Correctable error */
Brian Norris289c0522011-07-19 10:06:09 -0700729 pr_debug("ECC UNCORRECTED_ERROR B\n");
Vimal Singh67ce04b2009-05-12 13:47:03 -0700730 return -1;
731
732 case 12:
733 /* Correctable error */
734 find_byte = (ecc_bit[23] << 8) +
735 (ecc_bit[21] << 7) +
736 (ecc_bit[19] << 6) +
737 (ecc_bit[17] << 5) +
738 (ecc_bit[15] << 4) +
739 (ecc_bit[13] << 3) +
740 (ecc_bit[11] << 2) +
741 (ecc_bit[9] << 1) +
742 ecc_bit[7];
743
744 find_bit = (ecc_bit[5] << 2) + (ecc_bit[3] << 1) + ecc_bit[1];
745
Brian Norris0a32a102011-07-19 10:06:10 -0700746 pr_debug("Correcting single bit ECC error at offset: "
747 "%d, bit: %d\n", find_byte, find_bit);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700748
749 page_data[find_byte] ^= (1 << find_bit);
750
John Ogness74f1b722011-02-28 13:12:46 +0100751 return 1;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700752 default:
753 if (isEccFF) {
754 if (ecc_data2[0] == 0 &&
755 ecc_data2[1] == 0 &&
756 ecc_data2[2] == 0)
757 return 0;
758 }
Brian Norris289c0522011-07-19 10:06:09 -0700759 pr_debug("UNCORRECTED_ERROR default\n");
Vimal Singh67ce04b2009-05-12 13:47:03 -0700760 return -1;
761 }
762}
763
764/**
765 * omap_correct_data - Compares the ECC read with HW generated ECC
766 * @mtd: MTD device structure
767 * @dat: page data
768 * @read_ecc: ecc read from nand flash
769 * @calc_ecc: ecc read from HW ECC registers
770 *
771 * Compares the ecc read from nand spare area with ECC registers values
John Ogness74f1b722011-02-28 13:12:46 +0100772 * and if ECC's mismatched, it will call 'omap_compare_ecc' for error
773 * detection and correction. If there are no errors, %0 is returned. If
774 * there were errors and all of the errors were corrected, the number of
775 * corrected errors is returned. If uncorrectable errors exist, %-1 is
776 * returned.
Vimal Singh67ce04b2009-05-12 13:47:03 -0700777 */
778static int omap_correct_data(struct mtd_info *mtd, u_char *dat,
779 u_char *read_ecc, u_char *calc_ecc)
780{
781 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
782 mtd);
783 int blockCnt = 0, i = 0, ret = 0;
John Ogness74f1b722011-02-28 13:12:46 +0100784 int stat = 0;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700785
786 /* Ex NAND_ECC_HW12_2048 */
787 if ((info->nand.ecc.mode == NAND_ECC_HW) &&
788 (info->nand.ecc.size == 2048))
789 blockCnt = 4;
790 else
791 blockCnt = 1;
792
793 for (i = 0; i < blockCnt; i++) {
794 if (memcmp(read_ecc, calc_ecc, 3) != 0) {
795 ret = omap_compare_ecc(read_ecc, calc_ecc, dat);
796 if (ret < 0)
797 return ret;
John Ogness74f1b722011-02-28 13:12:46 +0100798 /* keep track of the number of corrected errors */
799 stat += ret;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700800 }
801 read_ecc += 3;
802 calc_ecc += 3;
803 dat += 512;
804 }
John Ogness74f1b722011-02-28 13:12:46 +0100805 return stat;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700806}
807
808/**
809 * omap_calcuate_ecc - Generate non-inverted ECC bytes.
810 * @mtd: MTD device structure
811 * @dat: The pointer to data on which ecc is computed
812 * @ecc_code: The ecc_code buffer
813 *
814 * Using noninverted ECC can be considered ugly since writing a blank
815 * page ie. padding will clear the ECC bytes. This is no problem as long
816 * nobody is trying to write data on the seemingly unused page. Reading
817 * an erased page will produce an ECC mismatch between generated and read
818 * ECC bytes that has to be dealt with separately.
819 */
820static int omap_calculate_ecc(struct mtd_info *mtd, const u_char *dat,
821 u_char *ecc_code)
822{
823 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
824 mtd);
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000825 return gpmc_calculate_ecc(info->gpmc_cs, dat, ecc_code);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700826}
827
828/**
829 * omap_enable_hwecc - This function enables the hardware ecc functionality
830 * @mtd: MTD device structure
831 * @mode: Read/Write mode
832 */
833static void omap_enable_hwecc(struct mtd_info *mtd, int mode)
834{
835 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
836 mtd);
837 struct nand_chip *chip = mtd->priv;
838 unsigned int dev_width = (chip->options & NAND_BUSWIDTH_16) ? 1 : 0;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700839
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000840 gpmc_enable_hwecc(info->gpmc_cs, mode, dev_width, info->nand.ecc.size);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700841}
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000842
Vimal Singh67ce04b2009-05-12 13:47:03 -0700843/**
844 * omap_wait - wait until the command is done
845 * @mtd: MTD device structure
846 * @chip: NAND Chip structure
847 *
848 * Wait function is called during Program and erase operations and
849 * the way it is called from MTD layer, we should wait till the NAND
850 * chip is ready after the programming/erase operation has completed.
851 *
852 * Erase can take up to 400ms and program up to 20ms according to
853 * general NAND and SmartMedia specs
854 */
855static int omap_wait(struct mtd_info *mtd, struct nand_chip *chip)
856{
857 struct nand_chip *this = mtd->priv;
858 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
859 mtd);
860 unsigned long timeo = jiffies;
Ivan Djelica9c465f2012-04-17 13:11:53 +0200861 int status, state = this->state;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700862
863 if (state == FL_ERASING)
864 timeo += (HZ * 400) / 1000;
865 else
866 timeo += (HZ * 20) / 1000;
867
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000868 gpmc_nand_write(info->gpmc_cs,
869 GPMC_NAND_COMMAND, (NAND_CMD_STATUS & 0xFF));
Vimal Singh67ce04b2009-05-12 13:47:03 -0700870 while (time_before(jiffies, timeo)) {
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000871 status = gpmc_nand_read(info->gpmc_cs, GPMC_NAND_DATA);
vimal singhc276aca2009-06-27 11:07:06 +0530872 if (status & NAND_STATUS_READY)
Vimal Singh67ce04b2009-05-12 13:47:03 -0700873 break;
vimal singhc276aca2009-06-27 11:07:06 +0530874 cond_resched();
Vimal Singh67ce04b2009-05-12 13:47:03 -0700875 }
Ivan Djelica9c465f2012-04-17 13:11:53 +0200876
877 status = gpmc_nand_read(info->gpmc_cs, GPMC_NAND_DATA);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700878 return status;
879}
880
881/**
882 * omap_dev_ready - calls the platform specific dev_ready function
883 * @mtd: MTD device structure
884 */
885static int omap_dev_ready(struct mtd_info *mtd)
886{
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000887 unsigned int val = 0;
Vimal Singh67ce04b2009-05-12 13:47:03 -0700888 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
889 mtd);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700890
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000891 val = gpmc_read_status(GPMC_GET_IRQ_STATUS);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700892 if ((val & 0x100) == 0x100) {
893 /* Clear IRQ Interrupt */
894 val |= 0x100;
895 val &= ~(0x0);
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000896 gpmc_cs_configure(info->gpmc_cs, GPMC_SET_IRQ_STATUS, val);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700897 } else {
898 unsigned int cnt = 0;
899 while (cnt++ < 0x1FF) {
900 if ((val & 0x100) == 0x100)
901 return 0;
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +0000902 val = gpmc_read_status(GPMC_GET_IRQ_STATUS);
Vimal Singh67ce04b2009-05-12 13:47:03 -0700903 }
904 }
905
906 return 1;
907}
908
Ivan Djelic0e618ef2012-04-30 12:17:18 +0200909#ifdef CONFIG_MTD_NAND_OMAP_BCH
910
911/**
912 * omap3_enable_hwecc_bch - Program OMAP3 GPMC to perform BCH ECC correction
913 * @mtd: MTD device structure
914 * @mode: Read/Write mode
915 */
916static void omap3_enable_hwecc_bch(struct mtd_info *mtd, int mode)
917{
918 int nerrors;
919 unsigned int dev_width;
920 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
921 mtd);
922 struct nand_chip *chip = mtd->priv;
923
924 nerrors = (info->nand.ecc.bytes == 13) ? 8 : 4;
925 dev_width = (chip->options & NAND_BUSWIDTH_16) ? 1 : 0;
926 /*
927 * Program GPMC to perform correction on one 512-byte sector at a time.
928 * Using 4 sectors at a time (i.e. ecc.size = 2048) is also possible and
929 * gives a slight (5%) performance gain (but requires additional code).
930 */
931 (void)gpmc_enable_hwecc_bch(info->gpmc_cs, mode, dev_width, 1, nerrors);
932}
933
934/**
935 * omap3_calculate_ecc_bch4 - Generate 7 bytes of ECC bytes
936 * @mtd: MTD device structure
937 * @dat: The pointer to data on which ecc is computed
938 * @ecc_code: The ecc_code buffer
939 */
940static int omap3_calculate_ecc_bch4(struct mtd_info *mtd, const u_char *dat,
941 u_char *ecc_code)
942{
943 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
944 mtd);
945 return gpmc_calculate_ecc_bch4(info->gpmc_cs, dat, ecc_code);
946}
947
948/**
949 * omap3_calculate_ecc_bch8 - Generate 13 bytes of ECC bytes
950 * @mtd: MTD device structure
951 * @dat: The pointer to data on which ecc is computed
952 * @ecc_code: The ecc_code buffer
953 */
954static int omap3_calculate_ecc_bch8(struct mtd_info *mtd, const u_char *dat,
955 u_char *ecc_code)
956{
957 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
958 mtd);
959 return gpmc_calculate_ecc_bch8(info->gpmc_cs, dat, ecc_code);
960}
961
962/**
963 * omap3_correct_data_bch - Decode received data and correct errors
964 * @mtd: MTD device structure
965 * @data: page data
966 * @read_ecc: ecc read from nand flash
967 * @calc_ecc: ecc read from HW ECC registers
968 */
969static int omap3_correct_data_bch(struct mtd_info *mtd, u_char *data,
970 u_char *read_ecc, u_char *calc_ecc)
971{
972 int i, count;
973 /* cannot correct more than 8 errors */
974 unsigned int errloc[8];
975 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
976 mtd);
977
978 count = decode_bch(info->bch, NULL, 512, read_ecc, calc_ecc, NULL,
979 errloc);
980 if (count > 0) {
981 /* correct errors */
982 for (i = 0; i < count; i++) {
983 /* correct data only, not ecc bytes */
984 if (errloc[i] < 8*512)
985 data[errloc[i]/8] ^= 1 << (errloc[i] & 7);
986 pr_debug("corrected bitflip %u\n", errloc[i]);
987 }
988 } else if (count < 0) {
989 pr_err("ecc unrecoverable error\n");
990 }
991 return count;
992}
993
994/**
995 * omap3_free_bch - Release BCH ecc resources
996 * @mtd: MTD device structure
997 */
998static void omap3_free_bch(struct mtd_info *mtd)
999{
1000 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
1001 mtd);
1002 if (info->bch) {
1003 free_bch(info->bch);
1004 info->bch = NULL;
1005 }
1006}
1007
1008/**
1009 * omap3_init_bch - Initialize BCH ECC
1010 * @mtd: MTD device structure
1011 * @ecc_opt: OMAP ECC mode (OMAP_ECC_BCH4_CODE_HW or OMAP_ECC_BCH8_CODE_HW)
1012 */
1013static int omap3_init_bch(struct mtd_info *mtd, int ecc_opt)
1014{
1015 int ret, max_errors;
1016 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
1017 mtd);
1018#ifdef CONFIG_MTD_NAND_OMAP_BCH8
1019 const int hw_errors = 8;
1020#else
1021 const int hw_errors = 4;
1022#endif
1023 info->bch = NULL;
1024
1025 max_errors = (ecc_opt == OMAP_ECC_BCH8_CODE_HW) ? 8 : 4;
1026 if (max_errors != hw_errors) {
1027 pr_err("cannot configure %d-bit BCH ecc, only %d-bit supported",
1028 max_errors, hw_errors);
1029 goto fail;
1030 }
1031
1032 /* initialize GPMC BCH engine */
1033 ret = gpmc_init_hwecc_bch(info->gpmc_cs, 1, max_errors);
1034 if (ret)
1035 goto fail;
1036
1037 /* software bch library is only used to detect and locate errors */
1038 info->bch = init_bch(13, max_errors, 0x201b /* hw polynomial */);
1039 if (!info->bch)
1040 goto fail;
1041
1042 info->nand.ecc.size = 512;
1043 info->nand.ecc.hwctl = omap3_enable_hwecc_bch;
1044 info->nand.ecc.correct = omap3_correct_data_bch;
1045 info->nand.ecc.mode = NAND_ECC_HW;
1046
1047 /*
1048 * The number of corrected errors in an ecc block that will trigger
1049 * block scrubbing defaults to the ecc strength (4 or 8).
1050 * Set mtd->bitflip_threshold here to define a custom threshold.
1051 */
1052
1053 if (max_errors == 8) {
1054 info->nand.ecc.strength = 8;
1055 info->nand.ecc.bytes = 13;
1056 info->nand.ecc.calculate = omap3_calculate_ecc_bch8;
1057 } else {
1058 info->nand.ecc.strength = 4;
1059 info->nand.ecc.bytes = 7;
1060 info->nand.ecc.calculate = omap3_calculate_ecc_bch4;
1061 }
1062
1063 pr_info("enabling NAND BCH ecc with %d-bit correction\n", max_errors);
1064 return 0;
1065fail:
1066 omap3_free_bch(mtd);
1067 return -1;
1068}
1069
1070/**
1071 * omap3_init_bch_tail - Build an oob layout for BCH ECC correction.
1072 * @mtd: MTD device structure
1073 */
1074static int omap3_init_bch_tail(struct mtd_info *mtd)
1075{
1076 int i, steps;
1077 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
1078 mtd);
1079 struct nand_ecclayout *layout = &info->ecclayout;
1080
1081 /* build oob layout */
1082 steps = mtd->writesize/info->nand.ecc.size;
1083 layout->eccbytes = steps*info->nand.ecc.bytes;
1084
1085 /* do not bother creating special oob layouts for small page devices */
1086 if (mtd->oobsize < 64) {
1087 pr_err("BCH ecc is not supported on small page devices\n");
1088 goto fail;
1089 }
1090
1091 /* reserve 2 bytes for bad block marker */
1092 if (layout->eccbytes+2 > mtd->oobsize) {
1093 pr_err("no oob layout available for oobsize %d eccbytes %u\n",
1094 mtd->oobsize, layout->eccbytes);
1095 goto fail;
1096 }
1097
1098 /* put ecc bytes at oob tail */
1099 for (i = 0; i < layout->eccbytes; i++)
1100 layout->eccpos[i] = mtd->oobsize-layout->eccbytes+i;
1101
1102 layout->oobfree[0].offset = 2;
1103 layout->oobfree[0].length = mtd->oobsize-2-layout->eccbytes;
1104 info->nand.ecc.layout = layout;
1105
1106 if (!(info->nand.options & NAND_BUSWIDTH_16))
1107 info->nand.badblock_pattern = &bb_descrip_flashbased;
1108 return 0;
1109fail:
1110 omap3_free_bch(mtd);
1111 return -1;
1112}
1113
1114#else
1115static int omap3_init_bch(struct mtd_info *mtd, int ecc_opt)
1116{
1117 pr_err("CONFIG_MTD_NAND_OMAP_BCH is not enabled\n");
1118 return -1;
1119}
1120static int omap3_init_bch_tail(struct mtd_info *mtd)
1121{
1122 return -1;
1123}
1124static void omap3_free_bch(struct mtd_info *mtd)
1125{
1126}
1127#endif /* CONFIG_MTD_NAND_OMAP_BCH */
1128
Vimal Singh67ce04b2009-05-12 13:47:03 -07001129static int __devinit omap_nand_probe(struct platform_device *pdev)
1130{
1131 struct omap_nand_info *info;
1132 struct omap_nand_platform_data *pdata;
1133 int err;
Sukumar Ghoraif040d332011-01-28 15:42:09 +05301134 int i, offset;
Russell King763e7352012-04-25 00:16:00 +01001135 dma_cap_mask_t mask;
1136 unsigned sig;
Vimal Singh67ce04b2009-05-12 13:47:03 -07001137
1138 pdata = pdev->dev.platform_data;
1139 if (pdata == NULL) {
1140 dev_err(&pdev->dev, "platform data missing\n");
1141 return -ENODEV;
1142 }
1143
1144 info = kzalloc(sizeof(struct omap_nand_info), GFP_KERNEL);
1145 if (!info)
1146 return -ENOMEM;
1147
1148 platform_set_drvdata(pdev, info);
1149
1150 spin_lock_init(&info->controller.lock);
1151 init_waitqueue_head(&info->controller.wq);
1152
1153 info->pdev = pdev;
1154
1155 info->gpmc_cs = pdata->cs;
Vimal Singh2f70a1e2010-02-15 10:03:33 -08001156 info->phys_base = pdata->phys_base;
Vimal Singh67ce04b2009-05-12 13:47:03 -07001157
1158 info->mtd.priv = &info->nand;
1159 info->mtd.name = dev_name(&pdev->dev);
1160 info->mtd.owner = THIS_MODULE;
1161
Sukumar Ghoraid5ce2b62011-01-28 15:42:03 +05301162 info->nand.options = pdata->devsize;
Vimal Singh2f70a1e2010-02-15 10:03:33 -08001163 info->nand.options |= NAND_SKIP_BBTSCAN;
Vimal Singh67ce04b2009-05-12 13:47:03 -07001164
1165 /* NAND write protect off */
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +00001166 gpmc_cs_configure(info->gpmc_cs, GPMC_CONFIG_WP, 0);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001167
1168 if (!request_mem_region(info->phys_base, NAND_IO_SIZE,
1169 pdev->dev.driver->name)) {
1170 err = -EBUSY;
Vimal Singh2f70a1e2010-02-15 10:03:33 -08001171 goto out_free_info;
Vimal Singh67ce04b2009-05-12 13:47:03 -07001172 }
1173
1174 info->nand.IO_ADDR_R = ioremap(info->phys_base, NAND_IO_SIZE);
1175 if (!info->nand.IO_ADDR_R) {
1176 err = -ENOMEM;
1177 goto out_release_mem_region;
1178 }
vimal singh59e9c5a2009-07-13 16:26:24 +05301179
Vimal Singh67ce04b2009-05-12 13:47:03 -07001180 info->nand.controller = &info->controller;
1181
1182 info->nand.IO_ADDR_W = info->nand.IO_ADDR_R;
1183 info->nand.cmd_ctrl = omap_hwcontrol;
1184
Vimal Singh67ce04b2009-05-12 13:47:03 -07001185 /*
1186 * If RDY/BSY line is connected to OMAP then use the omap ready
Peter Meerwald4cacbe22012-07-19 13:21:04 +02001187 * function and the generic nand_wait function which reads the status
1188 * register after monitoring the RDY/BSY line. Otherwise use a standard
Vimal Singh67ce04b2009-05-12 13:47:03 -07001189 * chip delay which is slightly more than tR (AC Timing) of the NAND
1190 * device and read status register until you get a failure or success
1191 */
1192 if (pdata->dev_ready) {
1193 info->nand.dev_ready = omap_dev_ready;
1194 info->nand.chip_delay = 0;
1195 } else {
1196 info->nand.waitfunc = omap_wait;
1197 info->nand.chip_delay = 50;
1198 }
1199
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301200 switch (pdata->xfer_type) {
1201 case NAND_OMAP_PREFETCH_POLLED:
vimal singh59e9c5a2009-07-13 16:26:24 +05301202 info->nand.read_buf = omap_read_buf_pref;
1203 info->nand.write_buf = omap_write_buf_pref;
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301204 break;
vimal singhdfe32892009-07-13 16:29:16 +05301205
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301206 case NAND_OMAP_POLLED:
vimal singh59e9c5a2009-07-13 16:26:24 +05301207 if (info->nand.options & NAND_BUSWIDTH_16) {
1208 info->nand.read_buf = omap_read_buf16;
1209 info->nand.write_buf = omap_write_buf16;
1210 } else {
1211 info->nand.read_buf = omap_read_buf8;
1212 info->nand.write_buf = omap_write_buf8;
1213 }
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301214 break;
1215
1216 case NAND_OMAP_PREFETCH_DMA:
Russell King763e7352012-04-25 00:16:00 +01001217 dma_cap_zero(mask);
1218 dma_cap_set(DMA_SLAVE, mask);
1219 sig = OMAP24XX_DMA_GPMC;
1220 info->dma = dma_request_channel(mask, omap_dma_filter_fn, &sig);
1221 if (!info->dma) {
Russell King2df41d02012-04-25 00:19:39 +01001222 dev_err(&pdev->dev, "DMA engine request failed\n");
1223 err = -ENXIO;
1224 goto out_release_mem_region;
Russell King763e7352012-04-25 00:16:00 +01001225 } else {
1226 struct dma_slave_config cfg;
Russell King763e7352012-04-25 00:16:00 +01001227
1228 memset(&cfg, 0, sizeof(cfg));
1229 cfg.src_addr = info->phys_base;
1230 cfg.dst_addr = info->phys_base;
1231 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
1232 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
1233 cfg.src_maxburst = 16;
1234 cfg.dst_maxburst = 16;
Arnd Bergmannd680e2c2012-08-04 11:05:25 +00001235 err = dmaengine_slave_config(info->dma, &cfg);
1236 if (err) {
Russell King763e7352012-04-25 00:16:00 +01001237 dev_err(&pdev->dev, "DMA engine slave config failed: %d\n",
Arnd Bergmannd680e2c2012-08-04 11:05:25 +00001238 err);
Russell King763e7352012-04-25 00:16:00 +01001239 goto out_release_mem_region;
1240 }
1241 info->nand.read_buf = omap_read_buf_dma_pref;
1242 info->nand.write_buf = omap_write_buf_dma_pref;
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301243 }
1244 break;
1245
Sukumar Ghorai4e070372011-01-28 15:42:06 +05301246 case NAND_OMAP_PREFETCH_IRQ:
1247 err = request_irq(pdata->gpmc_irq,
1248 omap_nand_irq, IRQF_SHARED, "gpmc-nand", info);
1249 if (err) {
1250 dev_err(&pdev->dev, "requesting irq(%d) error:%d",
1251 pdata->gpmc_irq, err);
1252 goto out_release_mem_region;
1253 } else {
1254 info->gpmc_irq = pdata->gpmc_irq;
1255 info->nand.read_buf = omap_read_buf_irq_pref;
1256 info->nand.write_buf = omap_write_buf_irq_pref;
1257 }
1258 break;
1259
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301260 default:
1261 dev_err(&pdev->dev,
1262 "xfer_type(%d) not supported!\n", pdata->xfer_type);
1263 err = -EINVAL;
1264 goto out_release_mem_region;
vimal singh59e9c5a2009-07-13 16:26:24 +05301265 }
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301266
Peter Meerwald4cacbe22012-07-19 13:21:04 +02001267 /* select the ecc type */
Sukumar Ghoraif3d73f32011-01-28 15:42:08 +05301268 if (pdata->ecc_opt == OMAP_ECC_HAMMING_CODE_DEFAULT)
1269 info->nand.ecc.mode = NAND_ECC_SOFT;
Sukumar Ghoraif040d332011-01-28 15:42:09 +05301270 else if ((pdata->ecc_opt == OMAP_ECC_HAMMING_CODE_HW) ||
1271 (pdata->ecc_opt == OMAP_ECC_HAMMING_CODE_HW_ROMCODE)) {
Sukumar Ghoraif3d73f32011-01-28 15:42:08 +05301272 info->nand.ecc.bytes = 3;
1273 info->nand.ecc.size = 512;
Mike Dunn6a918ba2012-03-11 14:21:11 -07001274 info->nand.ecc.strength = 1;
Sukumar Ghoraif3d73f32011-01-28 15:42:08 +05301275 info->nand.ecc.calculate = omap_calculate_ecc;
1276 info->nand.ecc.hwctl = omap_enable_hwecc;
1277 info->nand.ecc.correct = omap_correct_data;
1278 info->nand.ecc.mode = NAND_ECC_HW;
Ivan Djelic0e618ef2012-04-30 12:17:18 +02001279 } else if ((pdata->ecc_opt == OMAP_ECC_BCH4_CODE_HW) ||
1280 (pdata->ecc_opt == OMAP_ECC_BCH8_CODE_HW)) {
1281 err = omap3_init_bch(&info->mtd, pdata->ecc_opt);
1282 if (err) {
1283 err = -EINVAL;
1284 goto out_release_mem_region;
1285 }
Sukumar Ghoraif3d73f32011-01-28 15:42:08 +05301286 }
Vimal Singh67ce04b2009-05-12 13:47:03 -07001287
1288 /* DIP switches on some boards change between 8 and 16 bit
1289 * bus widths for flash. Try the other width if the first try fails.
1290 */
Jan Weitzela80f1c12011-04-19 16:15:34 +02001291 if (nand_scan_ident(&info->mtd, 1, NULL)) {
Vimal Singh67ce04b2009-05-12 13:47:03 -07001292 info->nand.options ^= NAND_BUSWIDTH_16;
Jan Weitzela80f1c12011-04-19 16:15:34 +02001293 if (nand_scan_ident(&info->mtd, 1, NULL)) {
Vimal Singh67ce04b2009-05-12 13:47:03 -07001294 err = -ENXIO;
1295 goto out_release_mem_region;
1296 }
1297 }
1298
Sukumar Ghoraif040d332011-01-28 15:42:09 +05301299 /* rom code layout */
1300 if (pdata->ecc_opt == OMAP_ECC_HAMMING_CODE_HW_ROMCODE) {
1301
1302 if (info->nand.options & NAND_BUSWIDTH_16)
1303 offset = 2;
1304 else {
1305 offset = 1;
1306 info->nand.badblock_pattern = &bb_descrip_flashbased;
1307 }
1308 omap_oobinfo.eccbytes = 3 * (info->mtd.oobsize/16);
1309 for (i = 0; i < omap_oobinfo.eccbytes; i++)
1310 omap_oobinfo.eccpos[i] = i+offset;
1311
1312 omap_oobinfo.oobfree->offset = offset + omap_oobinfo.eccbytes;
1313 omap_oobinfo.oobfree->length = info->mtd.oobsize -
1314 (offset + omap_oobinfo.eccbytes);
1315
1316 info->nand.ecc.layout = &omap_oobinfo;
Ivan Djelic0e618ef2012-04-30 12:17:18 +02001317 } else if ((pdata->ecc_opt == OMAP_ECC_BCH4_CODE_HW) ||
1318 (pdata->ecc_opt == OMAP_ECC_BCH8_CODE_HW)) {
1319 /* build OOB layout for BCH ECC correction */
1320 err = omap3_init_bch_tail(&info->mtd);
1321 if (err) {
1322 err = -EINVAL;
1323 goto out_release_mem_region;
1324 }
Sukumar Ghoraif040d332011-01-28 15:42:09 +05301325 }
Sukumar Ghorai1b0b323c2011-01-28 15:42:04 +05301326
Jan Weitzela80f1c12011-04-19 16:15:34 +02001327 /* second phase scan */
1328 if (nand_scan_tail(&info->mtd)) {
1329 err = -ENXIO;
1330 goto out_release_mem_region;
1331 }
1332
Artem Bityutskiy42d7fbe2012-03-09 19:24:26 +02001333 mtd_device_parse_register(&info->mtd, NULL, NULL, pdata->parts,
1334 pdata->nr_parts);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001335
1336 platform_set_drvdata(pdev, &info->mtd);
1337
1338 return 0;
1339
1340out_release_mem_region:
Russell King763e7352012-04-25 00:16:00 +01001341 if (info->dma)
1342 dma_release_channel(info->dma);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001343 release_mem_region(info->phys_base, NAND_IO_SIZE);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001344out_free_info:
1345 kfree(info);
1346
1347 return err;
1348}
1349
1350static int omap_nand_remove(struct platform_device *pdev)
1351{
1352 struct mtd_info *mtd = platform_get_drvdata(pdev);
Vimal Singhf35b6ed2010-01-05 16:01:08 +05301353 struct omap_nand_info *info = container_of(mtd, struct omap_nand_info,
1354 mtd);
Ivan Djelic0e618ef2012-04-30 12:17:18 +02001355 omap3_free_bch(&info->mtd);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001356
1357 platform_set_drvdata(pdev, NULL);
Russell King763e7352012-04-25 00:16:00 +01001358 if (info->dma)
1359 dma_release_channel(info->dma);
1360
Sukumar Ghorai4e070372011-01-28 15:42:06 +05301361 if (info->gpmc_irq)
1362 free_irq(info->gpmc_irq, info);
1363
Vimal Singh67ce04b2009-05-12 13:47:03 -07001364 /* Release NAND device, its internal structures and partitions */
1365 nand_release(&info->mtd);
Sukumar Ghorai2c01946c2010-07-09 09:14:45 +00001366 iounmap(info->nand.IO_ADDR_R);
Andreas Bießmann7d9b1102012-08-31 13:35:41 +02001367 kfree(info);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001368 return 0;
1369}
1370
1371static struct platform_driver omap_nand_driver = {
1372 .probe = omap_nand_probe,
1373 .remove = omap_nand_remove,
1374 .driver = {
1375 .name = DRIVER_NAME,
1376 .owner = THIS_MODULE,
1377 },
1378};
1379
Axel Linf99640d2011-11-27 20:45:03 +08001380module_platform_driver(omap_nand_driver);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001381
Axel Linc804c732011-03-07 11:04:24 +08001382MODULE_ALIAS("platform:" DRIVER_NAME);
Vimal Singh67ce04b2009-05-12 13:47:03 -07001383MODULE_LICENSE("GPL");
1384MODULE_DESCRIPTION("Glue layer for NAND flash on TI OMAP boards");