blob: 1cc19eb1c3023163c409997f7144e4bda923b04d [file] [log] [blame]
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +09001/*
2 * SuperH FLCTL nand controller
3 *
Magnus Dammb79c7ad2010-02-02 13:01:25 +09004 * Copyright (c) 2008 Renesas Solutions Corp.
5 * Copyright (c) 2008 Atom Create Engineering Co., Ltd.
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +09006 *
Magnus Dammb79c7ad2010-02-02 13:01:25 +09007 * Based on fsl_elbc_nand.c, Copyright (c) 2006-2007 Freescale Semiconductor
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +09008 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23
24#include <linux/module.h>
25#include <linux/kernel.h>
26#include <linux/delay.h>
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +020027#include <linux/interrupt.h>
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090028#include <linux/io.h>
29#include <linux/platform_device.h>
Bastian Hechtcfe78192012-03-18 15:13:20 +010030#include <linux/pm_runtime.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090031#include <linux/slab.h>
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090032
33#include <linux/mtd/mtd.h>
34#include <linux/mtd/nand.h>
35#include <linux/mtd/partitions.h>
36#include <linux/mtd/sh_flctl.h>
37
38static struct nand_ecclayout flctl_4secc_oob_16 = {
39 .eccbytes = 10,
40 .eccpos = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9},
41 .oobfree = {
42 {.offset = 12,
43 . length = 4} },
44};
45
46static struct nand_ecclayout flctl_4secc_oob_64 = {
Bastian Hechtaa32d1f2012-05-14 14:14:42 +020047 .eccbytes = 4 * 10,
48 .eccpos = {
49 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
50 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
51 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,
52 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 },
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090053 .oobfree = {
Bastian Hechtaa32d1f2012-05-14 14:14:42 +020054 {.offset = 2, .length = 4},
55 {.offset = 16, .length = 6},
56 {.offset = 32, .length = 6},
57 {.offset = 48, .length = 6} },
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090058};
59
60static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
61
62static struct nand_bbt_descr flctl_4secc_smallpage = {
63 .options = NAND_BBT_SCAN2NDPAGE,
64 .offs = 11,
65 .len = 1,
66 .pattern = scan_ff_pattern,
67};
68
69static struct nand_bbt_descr flctl_4secc_largepage = {
Yoshihiro Shimodac0e66162009-03-24 18:27:24 +090070 .options = NAND_BBT_SCAN2NDPAGE,
Bastian Hechtaa32d1f2012-05-14 14:14:42 +020071 .offs = 0,
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090072 .len = 2,
73 .pattern = scan_ff_pattern,
74};
75
76static void empty_fifo(struct sh_flctl *flctl)
77{
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +020078 writel(flctl->flintdmacr_base | AC1CLR | AC0CLR, FLINTDMACR(flctl));
79 writel(flctl->flintdmacr_base, FLINTDMACR(flctl));
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090080}
81
82static void start_translation(struct sh_flctl *flctl)
83{
84 writeb(TRSTRT, FLTRCR(flctl));
85}
86
Magnus Dammb79c7ad2010-02-02 13:01:25 +090087static void timeout_error(struct sh_flctl *flctl, const char *str)
88{
Lucas De Marchi25985ed2011-03-30 22:57:33 -030089 dev_err(&flctl->pdev->dev, "Timeout occurred in %s\n", str);
Magnus Dammb79c7ad2010-02-02 13:01:25 +090090}
91
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +090092static void wait_completion(struct sh_flctl *flctl)
93{
94 uint32_t timeout = LOOP_TIMEOUT_MAX;
95
96 while (timeout--) {
97 if (readb(FLTRCR(flctl)) & TREND) {
98 writeb(0x0, FLTRCR(flctl));
99 return;
100 }
101 udelay(1);
102 }
103
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900104 timeout_error(flctl, __func__);
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900105 writeb(0x0, FLTRCR(flctl));
106}
107
108static void set_addr(struct mtd_info *mtd, int column, int page_addr)
109{
110 struct sh_flctl *flctl = mtd_to_flctl(mtd);
111 uint32_t addr = 0;
112
113 if (column == -1) {
114 addr = page_addr; /* ERASE1 */
115 } else if (page_addr != -1) {
116 /* SEQIN, READ0, etc.. */
Magnus Damm010ab822010-01-27 09:17:21 +0000117 if (flctl->chip.options & NAND_BUSWIDTH_16)
118 column >>= 1;
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900119 if (flctl->page_size) {
120 addr = column & 0x0FFF;
121 addr |= (page_addr & 0xff) << 16;
122 addr |= ((page_addr >> 8) & 0xff) << 24;
123 /* big than 128MB */
124 if (flctl->rw_ADRCNT == ADRCNT2_E) {
125 uint32_t addr2;
126 addr2 = (page_addr >> 16) & 0xff;
127 writel(addr2, FLADR2(flctl));
128 }
129 } else {
130 addr = column;
131 addr |= (page_addr & 0xff) << 8;
132 addr |= ((page_addr >> 8) & 0xff) << 16;
133 addr |= ((page_addr >> 16) & 0xff) << 24;
134 }
135 }
136 writel(addr, FLADR(flctl));
137}
138
139static void wait_rfifo_ready(struct sh_flctl *flctl)
140{
141 uint32_t timeout = LOOP_TIMEOUT_MAX;
142
143 while (timeout--) {
144 uint32_t val;
145 /* check FIFO */
146 val = readl(FLDTCNTR(flctl)) >> 16;
147 if (val & 0xFF)
148 return;
149 udelay(1);
150 }
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900151 timeout_error(flctl, __func__);
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900152}
153
154static void wait_wfifo_ready(struct sh_flctl *flctl)
155{
156 uint32_t len, timeout = LOOP_TIMEOUT_MAX;
157
158 while (timeout--) {
159 /* check FIFO */
160 len = (readl(FLDTCNTR(flctl)) >> 16) & 0xFF;
161 if (len >= 4)
162 return;
163 udelay(1);
164 }
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900165 timeout_error(flctl, __func__);
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900166}
167
Yoshihiro Shimodac0e66162009-03-24 18:27:24 +0900168static int wait_recfifo_ready(struct sh_flctl *flctl, int sector_number)
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900169{
170 uint32_t timeout = LOOP_TIMEOUT_MAX;
171 int checked[4];
172 void __iomem *ecc_reg[4];
173 int i;
174 uint32_t data, size;
175
176 memset(checked, 0, sizeof(checked));
177
178 while (timeout--) {
179 size = readl(FLDTCNTR(flctl)) >> 24;
180 if (size & 0xFF)
181 return 0; /* success */
182
183 if (readl(FL4ECCCR(flctl)) & _4ECCFA)
184 return 1; /* can't correct */
185
186 udelay(1);
187 if (!(readl(FL4ECCCR(flctl)) & _4ECCEND))
188 continue;
189
190 /* start error correction */
191 ecc_reg[0] = FL4ECCRESULT0(flctl);
192 ecc_reg[1] = FL4ECCRESULT1(flctl);
193 ecc_reg[2] = FL4ECCRESULT2(flctl);
194 ecc_reg[3] = FL4ECCRESULT3(flctl);
195
196 for (i = 0; i < 3; i++) {
197 data = readl(ecc_reg[i]);
198 if (data != INIT_FL4ECCRESULT_VAL && !checked[i]) {
199 uint8_t org;
200 int index;
201
Yoshihiro Shimodac0e66162009-03-24 18:27:24 +0900202 if (flctl->page_size)
203 index = (512 * sector_number) +
204 (data >> 16);
205 else
206 index = data >> 16;
207
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900208 org = flctl->done_buff[index];
209 flctl->done_buff[index] = org ^ (data & 0xFF);
210 checked[i] = 1;
211 }
212 }
213
214 writel(0, FL4ECCCR(flctl));
215 }
216
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900217 timeout_error(flctl, __func__);
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900218 return 1; /* timeout */
219}
220
221static void wait_wecfifo_ready(struct sh_flctl *flctl)
222{
223 uint32_t timeout = LOOP_TIMEOUT_MAX;
224 uint32_t len;
225
226 while (timeout--) {
227 /* check FLECFIFO */
228 len = (readl(FLDTCNTR(flctl)) >> 24) & 0xFF;
229 if (len >= 4)
230 return;
231 udelay(1);
232 }
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900233 timeout_error(flctl, __func__);
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900234}
235
236static void read_datareg(struct sh_flctl *flctl, int offset)
237{
238 unsigned long data;
239 unsigned long *buf = (unsigned long *)&flctl->done_buff[offset];
240
241 wait_completion(flctl);
242
243 data = readl(FLDATAR(flctl));
244 *buf = le32_to_cpu(data);
245}
246
247static void read_fiforeg(struct sh_flctl *flctl, int rlen, int offset)
248{
249 int i, len_4align;
250 unsigned long *buf = (unsigned long *)&flctl->done_buff[offset];
251 void *fifo_addr = (void *)FLDTFIFO(flctl);
252
253 len_4align = (rlen + 3) / 4;
254
255 for (i = 0; i < len_4align; i++) {
256 wait_rfifo_ready(flctl);
257 buf[i] = readl(fifo_addr);
258 buf[i] = be32_to_cpu(buf[i]);
259 }
260}
261
Yoshihiro Shimodac0e66162009-03-24 18:27:24 +0900262static int read_ecfiforeg(struct sh_flctl *flctl, uint8_t *buff, int sector)
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900263{
264 int i;
265 unsigned long *ecc_buf = (unsigned long *)buff;
266 void *fifo_addr = (void *)FLECFIFO(flctl);
267
268 for (i = 0; i < 4; i++) {
Yoshihiro Shimodac0e66162009-03-24 18:27:24 +0900269 if (wait_recfifo_ready(flctl , sector))
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900270 return 1;
271 ecc_buf[i] = readl(fifo_addr);
272 ecc_buf[i] = be32_to_cpu(ecc_buf[i]);
273 }
274
275 return 0;
276}
277
278static void write_fiforeg(struct sh_flctl *flctl, int rlen, int offset)
279{
280 int i, len_4align;
281 unsigned long *data = (unsigned long *)&flctl->done_buff[offset];
282 void *fifo_addr = (void *)FLDTFIFO(flctl);
283
284 len_4align = (rlen + 3) / 4;
285 for (i = 0; i < len_4align; i++) {
286 wait_wfifo_ready(flctl);
287 writel(cpu_to_be32(data[i]), fifo_addr);
288 }
289}
290
291static void set_cmd_regs(struct mtd_info *mtd, uint32_t cmd, uint32_t flcmcdr_val)
292{
293 struct sh_flctl *flctl = mtd_to_flctl(mtd);
Bastian Hecht0b3f0d12012-03-01 10:48:39 +0100294 uint32_t flcmncr_val = flctl->flcmncr_base & ~SEL_16BIT;
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900295 uint32_t flcmdcr_val, addr_len_bytes = 0;
296
297 /* Set SNAND bit if page size is 2048byte */
298 if (flctl->page_size)
299 flcmncr_val |= SNAND_E;
300 else
301 flcmncr_val &= ~SNAND_E;
302
303 /* default FLCMDCR val */
304 flcmdcr_val = DOCMD1_E | DOADR_E;
305
306 /* Set for FLCMDCR */
307 switch (cmd) {
308 case NAND_CMD_ERASE1:
309 addr_len_bytes = flctl->erase_ADRCNT;
310 flcmdcr_val |= DOCMD2_E;
311 break;
312 case NAND_CMD_READ0:
313 case NAND_CMD_READOOB:
Bastian Hechtdd5ab242012-03-01 10:48:38 +0100314 case NAND_CMD_RNDOUT:
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900315 addr_len_bytes = flctl->rw_ADRCNT;
316 flcmdcr_val |= CDSRC_E;
Magnus Damm010ab822010-01-27 09:17:21 +0000317 if (flctl->chip.options & NAND_BUSWIDTH_16)
318 flcmncr_val |= SEL_16BIT;
Yoshihiro Shimoda6028aa02008-10-14 21:23:26 +0900319 break;
320 case NAND_CMD_SEQIN:
321 /* This case is that cmd is READ0 or READ1 or READ00 */
322 flcmdcr_val &= ~DOADR_E; /* ONLY execute 1st cmd */
323 break;
324 case NAND_CMD_PAGEPROG:
325 addr_len_bytes = flctl->rw_ADRCNT;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900326 flcmdcr_val |= DOCMD2_E | CDSRC_E | SELRW;
Magnus Damm010ab822010-01-27 09:17:21 +0000327 if (flctl->chip.options & NAND_BUSWIDTH_16)
328 flcmncr_val |= SEL_16BIT;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900329 break;
330 case NAND_CMD_READID:
331 flcmncr_val &= ~SNAND_E;
Bastian Hecht7b6b2302012-03-01 10:48:37 +0100332 flcmdcr_val |= CDSRC_E;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900333 addr_len_bytes = ADRCNT_1;
334 break;
335 case NAND_CMD_STATUS:
336 case NAND_CMD_RESET:
337 flcmncr_val &= ~SNAND_E;
338 flcmdcr_val &= ~(DOADR_E | DOSR_E);
339 break;
340 default:
341 break;
342 }
343
344 /* Set address bytes parameter */
345 flcmdcr_val |= addr_len_bytes;
346
347 /* Now actually write */
348 writel(flcmncr_val, FLCMNCR(flctl));
349 writel(flcmdcr_val, FLCMDCR(flctl));
350 writel(flcmcdr_val, FLCMCDR(flctl));
351}
352
353static int flctl_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -0700354 uint8_t *buf, int oob_required, int page)
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900355{
Bastian Hecht50ed3992012-05-14 14:14:44 +0200356 chip->read_buf(mtd, buf, mtd->writesize);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900357 return 0;
358}
359
360static void flctl_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -0700361 const uint8_t *buf, int oob_required)
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900362{
Bastian Hecht50ed3992012-05-14 14:14:44 +0200363 chip->write_buf(mtd, buf, mtd->writesize);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900364}
365
366static void execmd_read_page_sector(struct mtd_info *mtd, int page_addr)
367{
368 struct sh_flctl *flctl = mtd_to_flctl(mtd);
369 int sector, page_sectors;
370
371 if (flctl->page_size)
372 page_sectors = 4;
373 else
374 page_sectors = 1;
375
376 writel(readl(FLCMNCR(flctl)) | ACM_SACCES_MODE | _4ECCCORRECT,
377 FLCMNCR(flctl));
378
379 set_cmd_regs(mtd, NAND_CMD_READ0,
380 (NAND_CMD_READSTART << 8) | NAND_CMD_READ0);
381
382 for (sector = 0; sector < page_sectors; sector++) {
383 int ret;
384
385 empty_fifo(flctl);
386 writel(readl(FLCMDCR(flctl)) | 1, FLCMDCR(flctl));
387 writel(page_addr << 2 | sector, FLADR(flctl));
388
389 start_translation(flctl);
390 read_fiforeg(flctl, 512, 512 * sector);
391
392 ret = read_ecfiforeg(flctl,
Yoshihiro Shimodac0e66162009-03-24 18:27:24 +0900393 &flctl->done_buff[mtd->writesize + 16 * sector],
394 sector);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900395
396 if (ret)
397 flctl->hwecc_cant_correct[sector] = 1;
398
399 writel(0x0, FL4ECCCR(flctl));
400 wait_completion(flctl);
401 }
402 writel(readl(FLCMNCR(flctl)) & ~(ACM_SACCES_MODE | _4ECCCORRECT),
403 FLCMNCR(flctl));
404}
405
406static void execmd_read_oob(struct mtd_info *mtd, int page_addr)
407{
408 struct sh_flctl *flctl = mtd_to_flctl(mtd);
Bastian Hechtef4ce0b2012-05-14 14:14:43 +0200409 int page_sectors = flctl->page_size ? 4 : 1;
410 int i;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900411
412 set_cmd_regs(mtd, NAND_CMD_READ0,
413 (NAND_CMD_READSTART << 8) | NAND_CMD_READ0);
414
415 empty_fifo(flctl);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900416
Bastian Hechtef4ce0b2012-05-14 14:14:43 +0200417 for (i = 0; i < page_sectors; i++) {
418 set_addr(mtd, (512 + 16) * i + 512 , page_addr);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900419 writel(16, FLDTCNTR(flctl));
420
421 start_translation(flctl);
Bastian Hechtef4ce0b2012-05-14 14:14:43 +0200422 read_fiforeg(flctl, 16, 16 * i);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900423 wait_completion(flctl);
424 }
425}
426
427static void execmd_write_page_sector(struct mtd_info *mtd)
428{
429 struct sh_flctl *flctl = mtd_to_flctl(mtd);
430 int i, page_addr = flctl->seqin_page_addr;
431 int sector, page_sectors;
432
433 if (flctl->page_size)
434 page_sectors = 4;
435 else
436 page_sectors = 1;
437
438 writel(readl(FLCMNCR(flctl)) | ACM_SACCES_MODE, FLCMNCR(flctl));
439
440 set_cmd_regs(mtd, NAND_CMD_PAGEPROG,
441 (NAND_CMD_PAGEPROG << 8) | NAND_CMD_SEQIN);
442
443 for (sector = 0; sector < page_sectors; sector++) {
444 empty_fifo(flctl);
445 writel(readl(FLCMDCR(flctl)) | 1, FLCMDCR(flctl));
446 writel(page_addr << 2 | sector, FLADR(flctl));
447
448 start_translation(flctl);
449 write_fiforeg(flctl, 512, 512 * sector);
450
451 for (i = 0; i < 4; i++) {
452 wait_wecfifo_ready(flctl); /* wait for write ready */
453 writel(0xFFFFFFFF, FLECFIFO(flctl));
454 }
455 wait_completion(flctl);
456 }
457
458 writel(readl(FLCMNCR(flctl)) & ~ACM_SACCES_MODE, FLCMNCR(flctl));
459}
460
461static void execmd_write_oob(struct mtd_info *mtd)
462{
463 struct sh_flctl *flctl = mtd_to_flctl(mtd);
464 int page_addr = flctl->seqin_page_addr;
465 int sector, page_sectors;
466
Bastian Hechtef4ce0b2012-05-14 14:14:43 +0200467 page_sectors = flctl->page_size ? 4 : 1;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900468
469 set_cmd_regs(mtd, NAND_CMD_PAGEPROG,
470 (NAND_CMD_PAGEPROG << 8) | NAND_CMD_SEQIN);
471
Bastian Hechtef4ce0b2012-05-14 14:14:43 +0200472 for (sector = 0; sector < page_sectors; sector++) {
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900473 empty_fifo(flctl);
474 set_addr(mtd, sector * 528 + 512, page_addr);
475 writel(16, FLDTCNTR(flctl)); /* set read size */
476
477 start_translation(flctl);
478 write_fiforeg(flctl, 16, 16 * sector);
479 wait_completion(flctl);
480 }
481}
482
483static void flctl_cmdfunc(struct mtd_info *mtd, unsigned int command,
484 int column, int page_addr)
485{
486 struct sh_flctl *flctl = mtd_to_flctl(mtd);
487 uint32_t read_cmd = 0;
488
Bastian Hechtcfe78192012-03-18 15:13:20 +0100489 pm_runtime_get_sync(&flctl->pdev->dev);
490
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900491 flctl->read_bytes = 0;
492 if (command != NAND_CMD_PAGEPROG)
493 flctl->index = 0;
494
495 switch (command) {
496 case NAND_CMD_READ1:
497 case NAND_CMD_READ0:
498 if (flctl->hwecc) {
499 /* read page with hwecc */
500 execmd_read_page_sector(mtd, page_addr);
501 break;
502 }
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900503 if (flctl->page_size)
504 set_cmd_regs(mtd, command, (NAND_CMD_READSTART << 8)
505 | command);
506 else
507 set_cmd_regs(mtd, command, command);
508
509 set_addr(mtd, 0, page_addr);
510
511 flctl->read_bytes = mtd->writesize + mtd->oobsize;
Magnus Damm010ab822010-01-27 09:17:21 +0000512 if (flctl->chip.options & NAND_BUSWIDTH_16)
513 column >>= 1;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900514 flctl->index += column;
515 goto read_normal_exit;
516
517 case NAND_CMD_READOOB:
518 if (flctl->hwecc) {
519 /* read page with hwecc */
520 execmd_read_oob(mtd, page_addr);
521 break;
522 }
523
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900524 if (flctl->page_size) {
525 set_cmd_regs(mtd, command, (NAND_CMD_READSTART << 8)
526 | NAND_CMD_READ0);
527 set_addr(mtd, mtd->writesize, page_addr);
528 } else {
529 set_cmd_regs(mtd, command, command);
530 set_addr(mtd, 0, page_addr);
531 }
532 flctl->read_bytes = mtd->oobsize;
533 goto read_normal_exit;
534
Bastian Hechtdd5ab242012-03-01 10:48:38 +0100535 case NAND_CMD_RNDOUT:
536 if (flctl->hwecc)
537 break;
538
539 if (flctl->page_size)
540 set_cmd_regs(mtd, command, (NAND_CMD_RNDOUTSTART << 8)
541 | command);
542 else
543 set_cmd_regs(mtd, command, command);
544
545 set_addr(mtd, column, 0);
546
547 flctl->read_bytes = mtd->writesize + mtd->oobsize - column;
548 goto read_normal_exit;
549
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900550 case NAND_CMD_READID:
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900551 set_cmd_regs(mtd, command, command);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900552
Bastian Hecht7b6b2302012-03-01 10:48:37 +0100553 /* READID is always performed using an 8-bit bus */
554 if (flctl->chip.options & NAND_BUSWIDTH_16)
555 column <<= 1;
556 set_addr(mtd, column, 0);
557
558 flctl->read_bytes = 8;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900559 writel(flctl->read_bytes, FLDTCNTR(flctl)); /* set read size */
Bastian Hechtabb59ef2012-03-01 10:48:36 +0100560 empty_fifo(flctl);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900561 start_translation(flctl);
Bastian Hecht7b6b2302012-03-01 10:48:37 +0100562 read_fiforeg(flctl, flctl->read_bytes, 0);
563 wait_completion(flctl);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900564 break;
565
566 case NAND_CMD_ERASE1:
567 flctl->erase1_page_addr = page_addr;
568 break;
569
570 case NAND_CMD_ERASE2:
571 set_cmd_regs(mtd, NAND_CMD_ERASE1,
572 (command << 8) | NAND_CMD_ERASE1);
573 set_addr(mtd, -1, flctl->erase1_page_addr);
574 start_translation(flctl);
575 wait_completion(flctl);
576 break;
577
578 case NAND_CMD_SEQIN:
579 if (!flctl->page_size) {
580 /* output read command */
581 if (column >= mtd->writesize) {
582 column -= mtd->writesize;
583 read_cmd = NAND_CMD_READOOB;
584 } else if (column < 256) {
585 read_cmd = NAND_CMD_READ0;
586 } else {
587 column -= 256;
588 read_cmd = NAND_CMD_READ1;
589 }
590 }
591 flctl->seqin_column = column;
592 flctl->seqin_page_addr = page_addr;
593 flctl->seqin_read_cmd = read_cmd;
594 break;
595
596 case NAND_CMD_PAGEPROG:
597 empty_fifo(flctl);
598 if (!flctl->page_size) {
599 set_cmd_regs(mtd, NAND_CMD_SEQIN,
600 flctl->seqin_read_cmd);
601 set_addr(mtd, -1, -1);
602 writel(0, FLDTCNTR(flctl)); /* set 0 size */
603 start_translation(flctl);
604 wait_completion(flctl);
605 }
606 if (flctl->hwecc) {
607 /* write page with hwecc */
608 if (flctl->seqin_column == mtd->writesize)
609 execmd_write_oob(mtd);
610 else if (!flctl->seqin_column)
611 execmd_write_page_sector(mtd);
612 else
613 printk(KERN_ERR "Invalid address !?\n");
614 break;
615 }
616 set_cmd_regs(mtd, command, (command << 8) | NAND_CMD_SEQIN);
617 set_addr(mtd, flctl->seqin_column, flctl->seqin_page_addr);
618 writel(flctl->index, FLDTCNTR(flctl)); /* set write size */
619 start_translation(flctl);
620 write_fiforeg(flctl, flctl->index, 0);
621 wait_completion(flctl);
622 break;
623
624 case NAND_CMD_STATUS:
625 set_cmd_regs(mtd, command, command);
626 set_addr(mtd, -1, -1);
627
628 flctl->read_bytes = 1;
629 writel(flctl->read_bytes, FLDTCNTR(flctl)); /* set read size */
630 start_translation(flctl);
631 read_datareg(flctl, 0); /* read and end */
632 break;
633
634 case NAND_CMD_RESET:
635 set_cmd_regs(mtd, command, command);
636 set_addr(mtd, -1, -1);
637
638 writel(0, FLDTCNTR(flctl)); /* set 0 size */
639 start_translation(flctl);
640 wait_completion(flctl);
641 break;
642
643 default:
644 break;
645 }
Bastian Hechtcfe78192012-03-18 15:13:20 +0100646 goto runtime_exit;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900647
648read_normal_exit:
649 writel(flctl->read_bytes, FLDTCNTR(flctl)); /* set read size */
Bastian Hechtabb59ef2012-03-01 10:48:36 +0100650 empty_fifo(flctl);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900651 start_translation(flctl);
652 read_fiforeg(flctl, flctl->read_bytes, 0);
653 wait_completion(flctl);
Bastian Hechtcfe78192012-03-18 15:13:20 +0100654runtime_exit:
655 pm_runtime_put_sync(&flctl->pdev->dev);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900656 return;
657}
658
659static void flctl_select_chip(struct mtd_info *mtd, int chipnr)
660{
661 struct sh_flctl *flctl = mtd_to_flctl(mtd);
Bastian Hechtcfe78192012-03-18 15:13:20 +0100662 int ret;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900663
664 switch (chipnr) {
665 case -1:
Bastian Hecht0b3f0d12012-03-01 10:48:39 +0100666 flctl->flcmncr_base &= ~CE0_ENABLE;
Bastian Hechtcfe78192012-03-18 15:13:20 +0100667
668 pm_runtime_get_sync(&flctl->pdev->dev);
Bastian Hecht0b3f0d12012-03-01 10:48:39 +0100669 writel(flctl->flcmncr_base, FLCMNCR(flctl));
Bastian Hechtcfe78192012-03-18 15:13:20 +0100670
671 if (flctl->qos_request) {
672 dev_pm_qos_remove_request(&flctl->pm_qos);
673 flctl->qos_request = 0;
674 }
675
676 pm_runtime_put_sync(&flctl->pdev->dev);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900677 break;
678 case 0:
Bastian Hecht0b3f0d12012-03-01 10:48:39 +0100679 flctl->flcmncr_base |= CE0_ENABLE;
Bastian Hechtcfe78192012-03-18 15:13:20 +0100680
681 if (!flctl->qos_request) {
682 ret = dev_pm_qos_add_request(&flctl->pdev->dev,
683 &flctl->pm_qos, 100);
684 if (ret < 0)
685 dev_err(&flctl->pdev->dev,
686 "PM QoS request failed: %d\n", ret);
687 flctl->qos_request = 1;
688 }
689
690 if (flctl->holden) {
691 pm_runtime_get_sync(&flctl->pdev->dev);
Bastian Hecht3f2e9242012-03-01 10:48:40 +0100692 writel(HOLDEN, FLHOLDCR(flctl));
Bastian Hechtcfe78192012-03-18 15:13:20 +0100693 pm_runtime_put_sync(&flctl->pdev->dev);
694 }
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900695 break;
696 default:
697 BUG();
698 }
699}
700
701static void flctl_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
702{
703 struct sh_flctl *flctl = mtd_to_flctl(mtd);
704 int i, index = flctl->index;
705
706 for (i = 0; i < len; i++)
707 flctl->done_buff[index + i] = buf[i];
708 flctl->index += len;
709}
710
711static uint8_t flctl_read_byte(struct mtd_info *mtd)
712{
713 struct sh_flctl *flctl = mtd_to_flctl(mtd);
714 int index = flctl->index;
715 uint8_t data;
716
717 data = flctl->done_buff[index];
718 flctl->index++;
719 return data;
720}
721
Magnus Damm010ab822010-01-27 09:17:21 +0000722static uint16_t flctl_read_word(struct mtd_info *mtd)
723{
724 struct sh_flctl *flctl = mtd_to_flctl(mtd);
725 int index = flctl->index;
726 uint16_t data;
727 uint16_t *buf = (uint16_t *)&flctl->done_buff[index];
728
729 data = *buf;
730 flctl->index += 2;
731 return data;
732}
733
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900734static void flctl_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
735{
736 int i;
737
738 for (i = 0; i < len; i++)
739 buf[i] = flctl_read_byte(mtd);
740}
741
742static int flctl_verify_buf(struct mtd_info *mtd, const u_char *buf, int len)
743{
744 int i;
745
746 for (i = 0; i < len; i++)
747 if (buf[i] != flctl_read_byte(mtd))
748 return -EFAULT;
749 return 0;
750}
751
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900752static int flctl_chip_init_tail(struct mtd_info *mtd)
753{
754 struct sh_flctl *flctl = mtd_to_flctl(mtd);
755 struct nand_chip *chip = &flctl->chip;
756
757 if (mtd->writesize == 512) {
758 flctl->page_size = 0;
759 if (chip->chipsize > (32 << 20)) {
760 /* big than 32MB */
761 flctl->rw_ADRCNT = ADRCNT_4;
762 flctl->erase_ADRCNT = ADRCNT_3;
763 } else if (chip->chipsize > (2 << 16)) {
764 /* big than 128KB */
765 flctl->rw_ADRCNT = ADRCNT_3;
766 flctl->erase_ADRCNT = ADRCNT_2;
767 } else {
768 flctl->rw_ADRCNT = ADRCNT_2;
769 flctl->erase_ADRCNT = ADRCNT_1;
770 }
771 } else {
772 flctl->page_size = 1;
773 if (chip->chipsize > (128 << 20)) {
774 /* big than 128MB */
775 flctl->rw_ADRCNT = ADRCNT2_E;
776 flctl->erase_ADRCNT = ADRCNT_3;
777 } else if (chip->chipsize > (8 << 16)) {
778 /* big than 512KB */
779 flctl->rw_ADRCNT = ADRCNT_4;
780 flctl->erase_ADRCNT = ADRCNT_2;
781 } else {
782 flctl->rw_ADRCNT = ADRCNT_3;
783 flctl->erase_ADRCNT = ADRCNT_1;
784 }
785 }
786
787 if (flctl->hwecc) {
788 if (mtd->writesize == 512) {
789 chip->ecc.layout = &flctl_4secc_oob_16;
790 chip->badblock_pattern = &flctl_4secc_smallpage;
791 } else {
792 chip->ecc.layout = &flctl_4secc_oob_64;
793 chip->badblock_pattern = &flctl_4secc_largepage;
794 }
795
796 chip->ecc.size = 512;
797 chip->ecc.bytes = 10;
Mike Dunn6a918ba2012-03-11 14:21:11 -0700798 chip->ecc.strength = 4;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900799 chip->ecc.read_page = flctl_read_page_hwecc;
800 chip->ecc.write_page = flctl_write_page_hwecc;
801 chip->ecc.mode = NAND_ECC_HW;
802
803 /* 4 symbols ECC enabled */
Bastian Hechtaa32d1f2012-05-14 14:14:42 +0200804 flctl->flcmncr_base |= _4ECCEN;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900805 } else {
806 chip->ecc.mode = NAND_ECC_SOFT;
807 }
808
809 return 0;
810}
811
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +0200812static irqreturn_t flctl_handle_flste(int irq, void *dev_id)
813{
814 struct sh_flctl *flctl = dev_id;
815
816 dev_err(&flctl->pdev->dev, "flste irq: %x\n", readl(FLINTDMACR(flctl)));
817 writel(flctl->flintdmacr_base, FLINTDMACR(flctl));
818
819 return IRQ_HANDLED;
820}
821
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900822static int __devinit flctl_probe(struct platform_device *pdev)
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900823{
824 struct resource *res;
825 struct sh_flctl *flctl;
826 struct mtd_info *flctl_mtd;
827 struct nand_chip *nand;
828 struct sh_flctl_platform_data *pdata;
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900829 int ret = -ENXIO;
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +0200830 int irq;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900831
832 pdata = pdev->dev.platform_data;
833 if (pdata == NULL) {
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900834 dev_err(&pdev->dev, "no platform data defined\n");
835 return -EINVAL;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900836 }
837
838 flctl = kzalloc(sizeof(struct sh_flctl), GFP_KERNEL);
839 if (!flctl) {
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900840 dev_err(&pdev->dev, "failed to allocate driver data\n");
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900841 return -ENOMEM;
842 }
843
844 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
845 if (!res) {
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900846 dev_err(&pdev->dev, "failed to get I/O memory\n");
Bastian Hechtcfe78192012-03-18 15:13:20 +0100847 goto err_iomap;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900848 }
849
H Hartley Sweetencbd38a82009-12-14 16:59:27 -0500850 flctl->reg = ioremap(res->start, resource_size(res));
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900851 if (flctl->reg == NULL) {
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900852 dev_err(&pdev->dev, "failed to remap I/O memory\n");
Bastian Hechtcfe78192012-03-18 15:13:20 +0100853 goto err_iomap;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900854 }
855
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +0200856 irq = platform_get_irq(pdev, 0);
857 if (irq < 0) {
858 dev_err(&pdev->dev, "failed to get flste irq data\n");
859 goto err_flste;
860 }
861
862 ret = request_irq(irq, flctl_handle_flste, IRQF_SHARED, "flste", flctl);
863 if (ret) {
864 dev_err(&pdev->dev, "request interrupt failed.\n");
865 goto err_flste;
866 }
867
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900868 platform_set_drvdata(pdev, flctl);
869 flctl_mtd = &flctl->mtd;
870 nand = &flctl->chip;
871 flctl_mtd->priv = nand;
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900872 flctl->pdev = pdev;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900873 flctl->hwecc = pdata->has_hwecc;
Bastian Hecht3f2e9242012-03-01 10:48:40 +0100874 flctl->holden = pdata->use_holden;
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +0200875 flctl->flcmncr_base = pdata->flcmncr_val;
876 flctl->flintdmacr_base = flctl->hwecc ? (STERINTE | ECERB) : STERINTE;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900877
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900878 /* Set address of hardware control function */
879 /* 20 us command delay time */
880 nand->chip_delay = 20;
881
882 nand->read_byte = flctl_read_byte;
883 nand->write_buf = flctl_write_buf;
884 nand->read_buf = flctl_read_buf;
885 nand->verify_buf = flctl_verify_buf;
886 nand->select_chip = flctl_select_chip;
887 nand->cmdfunc = flctl_cmdfunc;
888
Magnus Damm010ab822010-01-27 09:17:21 +0000889 if (pdata->flcmncr_val & SEL_16BIT) {
890 nand->options |= NAND_BUSWIDTH_16;
891 nand->read_word = flctl_read_word;
892 }
893
Bastian Hechtcfe78192012-03-18 15:13:20 +0100894 pm_runtime_enable(&pdev->dev);
895 pm_runtime_resume(&pdev->dev);
896
David Woodhouse5e81e882010-02-26 18:32:56 +0000897 ret = nand_scan_ident(flctl_mtd, 1, NULL);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900898 if (ret)
Bastian Hechtcfe78192012-03-18 15:13:20 +0100899 goto err_chip;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900900
901 ret = flctl_chip_init_tail(flctl_mtd);
902 if (ret)
Bastian Hechtcfe78192012-03-18 15:13:20 +0100903 goto err_chip;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900904
905 ret = nand_scan_tail(flctl_mtd);
906 if (ret)
Bastian Hechtcfe78192012-03-18 15:13:20 +0100907 goto err_chip;
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900908
Jamie Ilesee0e87b2011-05-23 10:23:40 +0100909 mtd_device_register(flctl_mtd, pdata->parts, pdata->nr_parts);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900910
911 return 0;
912
Bastian Hechtcfe78192012-03-18 15:13:20 +0100913err_chip:
914 pm_runtime_disable(&pdev->dev);
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +0200915 free_irq(irq, flctl);
916err_flste:
Bastian Hechtcb547512012-05-14 14:14:40 +0200917 iounmap(flctl->reg);
Bastian Hechtcfe78192012-03-18 15:13:20 +0100918err_iomap:
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900919 kfree(flctl);
920 return ret;
921}
922
Magnus Dammb79c7ad2010-02-02 13:01:25 +0900923static int __devexit flctl_remove(struct platform_device *pdev)
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900924{
925 struct sh_flctl *flctl = platform_get_drvdata(pdev);
926
927 nand_release(&flctl->mtd);
Bastian Hechtcfe78192012-03-18 15:13:20 +0100928 pm_runtime_disable(&pdev->dev);
Bastian Hecht3c7ea4e2012-05-14 14:14:41 +0200929 free_irq(platform_get_irq(pdev, 0), flctl);
Bastian Hechtcb547512012-05-14 14:14:40 +0200930 iounmap(flctl->reg);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900931 kfree(flctl);
932
933 return 0;
934}
935
936static struct platform_driver flctl_driver = {
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900937 .remove = flctl_remove,
938 .driver = {
939 .name = "sh_flctl",
940 .owner = THIS_MODULE,
941 },
942};
943
944static int __init flctl_nand_init(void)
945{
David Woodhouse894572a2009-09-19 16:07:34 -0700946 return platform_driver_probe(&flctl_driver, flctl_probe);
Yoshihiro Shimoda35a34792008-10-20 17:17:44 +0900947}
948
949static void __exit flctl_nand_cleanup(void)
950{
951 platform_driver_unregister(&flctl_driver);
952}
953
954module_init(flctl_nand_init);
955module_exit(flctl_nand_cleanup);
956
957MODULE_LICENSE("GPL");
958MODULE_AUTHOR("Yoshihiro Shimoda");
959MODULE_DESCRIPTION("SuperH FLCTL driver");
960MODULE_ALIAS("platform:sh_flctl");