[MTD] Introduce writesize
[linux-2.6.git] / drivers / mtd / devices / doc2001plus.c
1 /*
2  * Linux driver for Disk-On-Chip Millennium Plus
3  *
4  * (c) 2002-2003 Greg Ungerer <gerg@snapgear.com>
5  * (c) 2002-2003 SnapGear Inc
6  * (c) 1999 Machine Vision Holdings, Inc.
7  * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org>
8  *
9  * $Id: doc2001plus.c,v 1.14 2005/11/07 11:14:24 gleixner Exp $
10  *
11  * Released under GPL
12  */
13
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <asm/errno.h>
17 #include <asm/io.h>
18 #include <asm/uaccess.h>
19 #include <linux/miscdevice.h>
20 #include <linux/pci.h>
21 #include <linux/delay.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/init.h>
25 #include <linux/types.h>
26 #include <linux/bitops.h>
27
28 #include <linux/mtd/mtd.h>
29 #include <linux/mtd/nand.h>
30 #include <linux/mtd/doc2000.h>
31
32 /* #define ECC_DEBUG */
33
34 /* I have no idea why some DoC chips can not use memcop_form|to_io().
35  * This may be due to the different revisions of the ASIC controller built-in or
36  * simplily a QA/Bug issue. Who knows ?? If you have trouble, please uncomment
37  * this:*/
38 #undef USE_MEMCPY
39
40 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
41                 size_t *retlen, u_char *buf);
42 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
43                 size_t *retlen, const u_char *buf);
44 static int doc_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
45                 size_t *retlen, u_char *buf, u_char *eccbuf,
46                 struct nand_oobinfo *oobsel);
47 static int doc_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
48                 size_t *retlen, const u_char *buf, u_char *eccbuf,
49                 struct nand_oobinfo *oobsel);
50 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
51                 size_t *retlen, u_char *buf);
52 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
53                 size_t *retlen, const u_char *buf);
54 static int doc_erase (struct mtd_info *mtd, struct erase_info *instr);
55
56 static struct mtd_info *docmilpluslist = NULL;
57
58
59 /* Perform the required delay cycles by writing to the NOP register */
60 static void DoC_Delay(void __iomem * docptr, int cycles)
61 {
62         int i;
63
64         for (i = 0; (i < cycles); i++)
65                 WriteDOC(0, docptr, Mplus_NOP);
66 }
67
68 #define CDSN_CTRL_FR_B_MASK     (CDSN_CTRL_FR_B0 | CDSN_CTRL_FR_B1)
69
70 /* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */
71 static int _DoC_WaitReady(void __iomem * docptr)
72 {
73         unsigned int c = 0xffff;
74
75         DEBUG(MTD_DEBUG_LEVEL3,
76               "_DoC_WaitReady called for out-of-line wait\n");
77
78         /* Out-of-line routine to wait for chip response */
79         while (((ReadDOC(docptr, Mplus_FlashControl) & CDSN_CTRL_FR_B_MASK) != CDSN_CTRL_FR_B_MASK) && --c)
80                 ;
81
82         if (c == 0)
83                 DEBUG(MTD_DEBUG_LEVEL2, "_DoC_WaitReady timed out.\n");
84
85         return (c == 0);
86 }
87
88 static inline int DoC_WaitReady(void __iomem * docptr)
89 {
90         /* This is inline, to optimise the common case, where it's ready instantly */
91         int ret = 0;
92
93         /* read form NOP register should be issued prior to the read from CDSNControl
94            see Software Requirement 11.4 item 2. */
95         DoC_Delay(docptr, 4);
96
97         if ((ReadDOC(docptr, Mplus_FlashControl) & CDSN_CTRL_FR_B_MASK) != CDSN_CTRL_FR_B_MASK)
98                 /* Call the out-of-line routine to wait */
99                 ret = _DoC_WaitReady(docptr);
100
101         return ret;
102 }
103
104 /* For some reason the Millennium Plus seems to occassionally put itself
105  * into reset mode. For me this happens randomly, with no pattern that I
106  * can detect. M-systems suggest always check this on any block level
107  * operation and setting to normal mode if in reset mode.
108  */
109 static inline void DoC_CheckASIC(void __iomem * docptr)
110 {
111         /* Make sure the DoC is in normal mode */
112         if ((ReadDOC(docptr, Mplus_DOCControl) & DOC_MODE_NORMAL) == 0) {
113                 WriteDOC((DOC_MODE_NORMAL | DOC_MODE_MDWREN), docptr, Mplus_DOCControl);
114                 WriteDOC(~(DOC_MODE_NORMAL | DOC_MODE_MDWREN), docptr, Mplus_CtrlConfirm);
115         }
116 }
117
118 /* DoC_Command: Send a flash command to the flash chip through the Flash
119  * command register. Need 2 Write Pipeline Terminates to complete send.
120  */
121 static void DoC_Command(void __iomem * docptr, unsigned char command,
122                                unsigned char xtraflags)
123 {
124         WriteDOC(command, docptr, Mplus_FlashCmd);
125         WriteDOC(command, docptr, Mplus_WritePipeTerm);
126         WriteDOC(command, docptr, Mplus_WritePipeTerm);
127 }
128
129 /* DoC_Address: Set the current address for the flash chip through the Flash
130  * Address register. Need 2 Write Pipeline Terminates to complete send.
131  */
132 static inline void DoC_Address(struct DiskOnChip *doc, int numbytes,
133                                unsigned long ofs, unsigned char xtraflags1,
134                                unsigned char xtraflags2)
135 {
136         void __iomem * docptr = doc->virtadr;
137
138         /* Allow for possible Mill Plus internal flash interleaving */
139         ofs >>= doc->interleave;
140
141         switch (numbytes) {
142         case 1:
143                 /* Send single byte, bits 0-7. */
144                 WriteDOC(ofs & 0xff, docptr, Mplus_FlashAddress);
145                 break;
146         case 2:
147                 /* Send bits 9-16 followed by 17-23 */
148                 WriteDOC((ofs >> 9)  & 0xff, docptr, Mplus_FlashAddress);
149                 WriteDOC((ofs >> 17) & 0xff, docptr, Mplus_FlashAddress);
150                 break;
151         case 3:
152                 /* Send 0-7, 9-16, then 17-23 */
153                 WriteDOC(ofs & 0xff, docptr, Mplus_FlashAddress);
154                 WriteDOC((ofs >> 9)  & 0xff, docptr, Mplus_FlashAddress);
155                 WriteDOC((ofs >> 17) & 0xff, docptr, Mplus_FlashAddress);
156                 break;
157         default:
158                 return;
159         }
160
161         WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
162         WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
163 }
164
165 /* DoC_SelectChip: Select a given flash chip within the current floor */
166 static int DoC_SelectChip(void __iomem * docptr, int chip)
167 {
168         /* No choice for flash chip on Millennium Plus */
169         return 0;
170 }
171
172 /* DoC_SelectFloor: Select a given floor (bank of flash chips) */
173 static int DoC_SelectFloor(void __iomem * docptr, int floor)
174 {
175         WriteDOC((floor & 0x3), docptr, Mplus_DeviceSelect);
176         return 0;
177 }
178
179 /*
180  * Translate the given offset into the appropriate command and offset.
181  * This does the mapping using the 16bit interleave layout defined by
182  * M-Systems, and looks like this for a sector pair:
183  *  +-----------+-------+-------+-------+--------------+---------+-----------+
184  *  | 0 --- 511 |512-517|518-519|520-521| 522 --- 1033 |1034-1039|1040 - 1055|
185  *  +-----------+-------+-------+-------+--------------+---------+-----------+
186  *  | Data 0    | ECC 0 |Flags0 |Flags1 | Data 1       |ECC 1    | OOB 1 + 2 |
187  *  +-----------+-------+-------+-------+--------------+---------+-----------+
188  */
189 /* FIXME: This lives in INFTL not here. Other users of flash devices
190    may not want it */
191 static unsigned int DoC_GetDataOffset(struct mtd_info *mtd, loff_t *from)
192 {
193         struct DiskOnChip *this = mtd->priv;
194
195         if (this->interleave) {
196                 unsigned int ofs = *from & 0x3ff;
197                 unsigned int cmd;
198
199                 if (ofs < 512) {
200                         cmd = NAND_CMD_READ0;
201                         ofs &= 0x1ff;
202                 } else if (ofs < 1014) {
203                         cmd = NAND_CMD_READ1;
204                         ofs = (ofs & 0x1ff) + 10;
205                 } else {
206                         cmd = NAND_CMD_READOOB;
207                         ofs = ofs - 1014;
208                 }
209
210                 *from = (*from & ~0x3ff) | ofs;
211                 return cmd;
212         } else {
213                 /* No interleave */
214                 if ((*from) & 0x100)
215                         return NAND_CMD_READ1;
216                 return NAND_CMD_READ0;
217         }
218 }
219
220 static unsigned int DoC_GetECCOffset(struct mtd_info *mtd, loff_t *from)
221 {
222         unsigned int ofs, cmd;
223
224         if (*from & 0x200) {
225                 cmd = NAND_CMD_READOOB;
226                 ofs = 10 + (*from & 0xf);
227         } else {
228                 cmd = NAND_CMD_READ1;
229                 ofs = (*from & 0xf);
230         }
231
232         *from = (*from & ~0x3ff) | ofs;
233         return cmd;
234 }
235
236 static unsigned int DoC_GetFlagsOffset(struct mtd_info *mtd, loff_t *from)
237 {
238         unsigned int ofs, cmd;
239
240         cmd = NAND_CMD_READ1;
241         ofs = (*from & 0x200) ? 8 : 6;
242         *from = (*from & ~0x3ff) | ofs;
243         return cmd;
244 }
245
246 static unsigned int DoC_GetHdrOffset(struct mtd_info *mtd, loff_t *from)
247 {
248         unsigned int ofs, cmd;
249
250         cmd = NAND_CMD_READOOB;
251         ofs = (*from & 0x200) ? 24 : 16;
252         *from = (*from & ~0x3ff) | ofs;
253         return cmd;
254 }
255
256 static inline void MemReadDOC(void __iomem * docptr, unsigned char *buf, int len)
257 {
258 #ifndef USE_MEMCPY
259         int i;
260         for (i = 0; i < len; i++)
261                 buf[i] = ReadDOC(docptr, Mil_CDSN_IO + i);
262 #else
263         memcpy_fromio(buf, docptr + DoC_Mil_CDSN_IO, len);
264 #endif
265 }
266
267 static inline void MemWriteDOC(void __iomem * docptr, unsigned char *buf, int len)
268 {
269 #ifndef USE_MEMCPY
270         int i;
271         for (i = 0; i < len; i++)
272                 WriteDOC(buf[i], docptr, Mil_CDSN_IO + i);
273 #else
274         memcpy_toio(docptr + DoC_Mil_CDSN_IO, buf, len);
275 #endif
276 }
277
278 /* DoC_IdentChip: Identify a given NAND chip given {floor,chip} */
279 static int DoC_IdentChip(struct DiskOnChip *doc, int floor, int chip)
280 {
281         int mfr, id, i, j;
282         volatile char dummy;
283         void __iomem * docptr = doc->virtadr;
284
285         /* Page in the required floor/chip */
286         DoC_SelectFloor(docptr, floor);
287         DoC_SelectChip(docptr, chip);
288
289         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
290         WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
291
292         /* Reset the chip, see Software Requirement 11.4 item 1. */
293         DoC_Command(docptr, NAND_CMD_RESET, 0);
294         DoC_WaitReady(docptr);
295
296         /* Read the NAND chip ID: 1. Send ReadID command */
297         DoC_Command(docptr, NAND_CMD_READID, 0);
298
299         /* Read the NAND chip ID: 2. Send address byte zero */
300         DoC_Address(doc, 1, 0x00, 0, 0x00);
301
302         WriteDOC(0, docptr, Mplus_FlashControl);
303         DoC_WaitReady(docptr);
304
305         /* Read the manufacturer and device id codes of the flash device through
306            CDSN IO register see Software Requirement 11.4 item 5.*/
307         dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
308         dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
309
310         mfr = ReadDOC(docptr, Mil_CDSN_IO);
311         if (doc->interleave)
312                 dummy = ReadDOC(docptr, Mil_CDSN_IO); /* 2 way interleave */
313
314         id  = ReadDOC(docptr, Mil_CDSN_IO);
315         if (doc->interleave)
316                 dummy = ReadDOC(docptr, Mil_CDSN_IO); /* 2 way interleave */
317
318         dummy = ReadDOC(docptr, Mplus_LastDataRead);
319         dummy = ReadDOC(docptr, Mplus_LastDataRead);
320
321         /* Disable flash internally */
322         WriteDOC(0, docptr, Mplus_FlashSelect);
323
324         /* No response - return failure */
325         if (mfr == 0xff || mfr == 0)
326                 return 0;
327
328         for (i = 0; nand_flash_ids[i].name != NULL; i++) {
329                 if (id == nand_flash_ids[i].id) {
330                         /* Try to identify manufacturer */
331                         for (j = 0; nand_manuf_ids[j].id != 0x0; j++) {
332                                 if (nand_manuf_ids[j].id == mfr)
333                                         break;
334                         }
335                         printk(KERN_INFO "Flash chip found: Manufacturer ID: %2.2X, "
336                                "Chip ID: %2.2X (%s:%s)\n", mfr, id,
337                                nand_manuf_ids[j].name, nand_flash_ids[i].name);
338                         doc->mfr = mfr;
339                         doc->id = id;
340                         doc->chipshift = ffs((nand_flash_ids[i].chipsize << 20)) - 1;
341                         doc->erasesize = nand_flash_ids[i].erasesize << doc->interleave;
342                         break;
343                 }
344         }
345
346         if (nand_flash_ids[i].name == NULL)
347                 return 0;
348         return 1;
349 }
350
351 /* DoC_ScanChips: Find all NAND chips present in a DiskOnChip, and identify them */
352 static void DoC_ScanChips(struct DiskOnChip *this)
353 {
354         int floor, chip;
355         int numchips[MAX_FLOORS_MPLUS];
356         int ret;
357
358         this->numchips = 0;
359         this->mfr = 0;
360         this->id = 0;
361
362         /* Work out the intended interleave setting */
363         this->interleave = 0;
364         if (this->ChipID == DOC_ChipID_DocMilPlus32)
365                 this->interleave = 1;
366
367         /* Check the ASIC agrees */
368         if ( (this->interleave << 2) !=
369              (ReadDOC(this->virtadr, Mplus_Configuration) & 4)) {
370                 u_char conf = ReadDOC(this->virtadr, Mplus_Configuration);
371                 printk(KERN_NOTICE "Setting DiskOnChip Millennium Plus interleave to %s\n",
372                        this->interleave?"on (16-bit)":"off (8-bit)");
373                 conf ^= 4;
374                 WriteDOC(conf, this->virtadr, Mplus_Configuration);
375         }
376
377         /* For each floor, find the number of valid chips it contains */
378         for (floor = 0,ret = 1; floor < MAX_FLOORS_MPLUS; floor++) {
379                 numchips[floor] = 0;
380                 for (chip = 0; chip < MAX_CHIPS_MPLUS && ret != 0; chip++) {
381                         ret = DoC_IdentChip(this, floor, chip);
382                         if (ret) {
383                                 numchips[floor]++;
384                                 this->numchips++;
385                         }
386                 }
387         }
388         /* If there are none at all that we recognise, bail */
389         if (!this->numchips) {
390                 printk("No flash chips recognised.\n");
391                 return;
392         }
393
394         /* Allocate an array to hold the information for each chip */
395         this->chips = kmalloc(sizeof(struct Nand) * this->numchips, GFP_KERNEL);
396         if (!this->chips){
397                 printk("MTD: No memory for allocating chip info structures\n");
398                 return;
399         }
400
401         /* Fill out the chip array with {floor, chipno} for each
402          * detected chip in the device. */
403         for (floor = 0, ret = 0; floor < MAX_FLOORS_MPLUS; floor++) {
404                 for (chip = 0 ; chip < numchips[floor] ; chip++) {
405                         this->chips[ret].floor = floor;
406                         this->chips[ret].chip = chip;
407                         this->chips[ret].curadr = 0;
408                         this->chips[ret].curmode = 0x50;
409                         ret++;
410                 }
411         }
412
413         /* Calculate and print the total size of the device */
414         this->totlen = this->numchips * (1 << this->chipshift);
415         printk(KERN_INFO "%d flash chips found. Total DiskOnChip size: %ld MiB\n",
416                this->numchips ,this->totlen >> 20);
417 }
418
419 static int DoCMilPlus_is_alias(struct DiskOnChip *doc1, struct DiskOnChip *doc2)
420 {
421         int tmp1, tmp2, retval;
422
423         if (doc1->physadr == doc2->physadr)
424                 return 1;
425
426         /* Use the alias resolution register which was set aside for this
427          * purpose. If it's value is the same on both chips, they might
428          * be the same chip, and we write to one and check for a change in
429          * the other. It's unclear if this register is usuable in the
430          * DoC 2000 (it's in the Millennium docs), but it seems to work. */
431         tmp1 = ReadDOC(doc1->virtadr, Mplus_AliasResolution);
432         tmp2 = ReadDOC(doc2->virtadr, Mplus_AliasResolution);
433         if (tmp1 != tmp2)
434                 return 0;
435
436         WriteDOC((tmp1+1) % 0xff, doc1->virtadr, Mplus_AliasResolution);
437         tmp2 = ReadDOC(doc2->virtadr, Mplus_AliasResolution);
438         if (tmp2 == (tmp1+1) % 0xff)
439                 retval = 1;
440         else
441                 retval = 0;
442
443         /* Restore register contents.  May not be necessary, but do it just to
444          * be safe. */
445         WriteDOC(tmp1, doc1->virtadr, Mplus_AliasResolution);
446
447         return retval;
448 }
449
450 /* This routine is found from the docprobe code by symbol_get(),
451  * which will bump the use count of this module. */
452 void DoCMilPlus_init(struct mtd_info *mtd)
453 {
454         struct DiskOnChip *this = mtd->priv;
455         struct DiskOnChip *old = NULL;
456
457         /* We must avoid being called twice for the same device. */
458         if (docmilpluslist)
459                 old = docmilpluslist->priv;
460
461         while (old) {
462                 if (DoCMilPlus_is_alias(this, old)) {
463                         printk(KERN_NOTICE "Ignoring DiskOnChip Millennium "
464                                 "Plus at 0x%lX - already configured\n",
465                                 this->physadr);
466                         iounmap(this->virtadr);
467                         kfree(mtd);
468                         return;
469                 }
470                 if (old->nextdoc)
471                         old = old->nextdoc->priv;
472                 else
473                         old = NULL;
474         }
475
476         mtd->name = "DiskOnChip Millennium Plus";
477         printk(KERN_NOTICE "DiskOnChip Millennium Plus found at "
478                 "address 0x%lX\n", this->physadr);
479
480         mtd->type = MTD_NANDFLASH;
481         mtd->flags = MTD_CAP_NANDFLASH;
482         mtd->ecctype = MTD_ECC_RS_DiskOnChip;
483         mtd->size = 0;
484
485         mtd->erasesize = 0;
486         mtd->writesize = 512;
487         mtd->oobsize = 16;
488         mtd->owner = THIS_MODULE;
489         mtd->erase = doc_erase;
490         mtd->point = NULL;
491         mtd->unpoint = NULL;
492         mtd->read = doc_read;
493         mtd->write = doc_write;
494         mtd->read_ecc = doc_read_ecc;
495         mtd->write_ecc = doc_write_ecc;
496         mtd->read_oob = doc_read_oob;
497         mtd->write_oob = doc_write_oob;
498         mtd->sync = NULL;
499
500         this->totlen = 0;
501         this->numchips = 0;
502         this->curfloor = -1;
503         this->curchip = -1;
504
505         /* Ident all the chips present. */
506         DoC_ScanChips(this);
507
508         if (!this->totlen) {
509                 kfree(mtd);
510                 iounmap(this->virtadr);
511         } else {
512                 this->nextdoc = docmilpluslist;
513                 docmilpluslist = mtd;
514                 mtd->size  = this->totlen;
515                 mtd->erasesize = this->erasesize;
516                 add_mtd_device(mtd);
517                 return;
518         }
519 }
520 EXPORT_SYMBOL_GPL(DoCMilPlus_init);
521
522 #if 0
523 static int doc_dumpblk(struct mtd_info *mtd, loff_t from)
524 {
525         int i;
526         loff_t fofs;
527         struct DiskOnChip *this = mtd->priv;
528         void __iomem * docptr = this->virtadr;
529         struct Nand *mychip = &this->chips[from >> (this->chipshift)];
530         unsigned char *bp, buf[1056];
531         char c[32];
532
533         from &= ~0x3ff;
534
535         /* Don't allow read past end of device */
536         if (from >= this->totlen)
537                 return -EINVAL;
538
539         DoC_CheckASIC(docptr);
540
541         /* Find the chip which is to be used and select it */
542         if (this->curfloor != mychip->floor) {
543                 DoC_SelectFloor(docptr, mychip->floor);
544                 DoC_SelectChip(docptr, mychip->chip);
545         } else if (this->curchip != mychip->chip) {
546                 DoC_SelectChip(docptr, mychip->chip);
547         }
548         this->curfloor = mychip->floor;
549         this->curchip = mychip->chip;
550
551         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
552         WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
553
554         /* Reset the chip, see Software Requirement 11.4 item 1. */
555         DoC_Command(docptr, NAND_CMD_RESET, 0);
556         DoC_WaitReady(docptr);
557
558         fofs = from;
559         DoC_Command(docptr, DoC_GetDataOffset(mtd, &fofs), 0);
560         DoC_Address(this, 3, fofs, 0, 0x00);
561         WriteDOC(0, docptr, Mplus_FlashControl);
562         DoC_WaitReady(docptr);
563
564         /* disable the ECC engine */
565         WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
566
567         ReadDOC(docptr, Mplus_ReadPipeInit);
568         ReadDOC(docptr, Mplus_ReadPipeInit);
569
570         /* Read the data via the internal pipeline through CDSN IO
571            register, see Pipelined Read Operations 11.3 */
572         MemReadDOC(docptr, buf, 1054);
573         buf[1054] = ReadDOC(docptr, Mplus_LastDataRead);
574         buf[1055] = ReadDOC(docptr, Mplus_LastDataRead);
575
576         memset(&c[0], 0, sizeof(c));
577         printk("DUMP OFFSET=%x:\n", (int)from);
578
579         for (i = 0, bp = &buf[0]; (i < 1056); i++) {
580                 if ((i % 16) == 0)
581                         printk("%08x: ", i);
582                 printk(" %02x", *bp);
583                 c[(i & 0xf)] = ((*bp >= 0x20) && (*bp <= 0x7f)) ? *bp : '.';
584                 bp++;
585                 if (((i + 1) % 16) == 0)
586                         printk("    %s\n", c);
587         }
588         printk("\n");
589
590         /* Disable flash internally */
591         WriteDOC(0, docptr, Mplus_FlashSelect);
592
593         return 0;
594 }
595 #endif
596
597 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
598                     size_t *retlen, u_char *buf)
599 {
600         /* Just a special case of doc_read_ecc */
601         return doc_read_ecc(mtd, from, len, retlen, buf, NULL, NULL);
602 }
603
604 static int doc_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
605                         size_t *retlen, u_char *buf, u_char *eccbuf,
606                         struct nand_oobinfo *oobsel)
607 {
608         int ret, i;
609         volatile char dummy;
610         loff_t fofs;
611         unsigned char syndrome[6];
612         struct DiskOnChip *this = mtd->priv;
613         void __iomem * docptr = this->virtadr;
614         struct Nand *mychip = &this->chips[from >> (this->chipshift)];
615
616         /* Don't allow read past end of device */
617         if (from >= this->totlen)
618                 return -EINVAL;
619
620         /* Don't allow a single read to cross a 512-byte block boundary */
621         if (from + len > ((from | 0x1ff) + 1))
622                 len = ((from | 0x1ff) + 1) - from;
623
624         DoC_CheckASIC(docptr);
625
626         /* Find the chip which is to be used and select it */
627         if (this->curfloor != mychip->floor) {
628                 DoC_SelectFloor(docptr, mychip->floor);
629                 DoC_SelectChip(docptr, mychip->chip);
630         } else if (this->curchip != mychip->chip) {
631                 DoC_SelectChip(docptr, mychip->chip);
632         }
633         this->curfloor = mychip->floor;
634         this->curchip = mychip->chip;
635
636         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
637         WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
638
639         /* Reset the chip, see Software Requirement 11.4 item 1. */
640         DoC_Command(docptr, NAND_CMD_RESET, 0);
641         DoC_WaitReady(docptr);
642
643         fofs = from;
644         DoC_Command(docptr, DoC_GetDataOffset(mtd, &fofs), 0);
645         DoC_Address(this, 3, fofs, 0, 0x00);
646         WriteDOC(0, docptr, Mplus_FlashControl);
647         DoC_WaitReady(docptr);
648
649         if (eccbuf) {
650                 /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
651                 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
652                 WriteDOC(DOC_ECC_EN, docptr, Mplus_ECCConf);
653         } else {
654                 /* disable the ECC engine */
655                 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
656         }
657
658         /* Let the caller know we completed it */
659         *retlen = len;
660         ret = 0;
661
662         ReadDOC(docptr, Mplus_ReadPipeInit);
663         ReadDOC(docptr, Mplus_ReadPipeInit);
664
665         if (eccbuf) {
666                 /* Read the data via the internal pipeline through CDSN IO
667                    register, see Pipelined Read Operations 11.3 */
668                 MemReadDOC(docptr, buf, len);
669
670                 /* Read the ECC data following raw data */
671                 MemReadDOC(docptr, eccbuf, 4);
672                 eccbuf[4] = ReadDOC(docptr, Mplus_LastDataRead);
673                 eccbuf[5] = ReadDOC(docptr, Mplus_LastDataRead);
674
675                 /* Flush the pipeline */
676                 dummy = ReadDOC(docptr, Mplus_ECCConf);
677                 dummy = ReadDOC(docptr, Mplus_ECCConf);
678
679                 /* Check the ECC Status */
680                 if (ReadDOC(docptr, Mplus_ECCConf) & 0x80) {
681                         int nb_errors;
682                         /* There was an ECC error */
683 #ifdef ECC_DEBUG
684                         printk("DiskOnChip ECC Error: Read at %lx\n", (long)from);
685 #endif
686                         /* Read the ECC syndrom through the DiskOnChip ECC logic.
687                            These syndrome will be all ZERO when there is no error */
688                         for (i = 0; i < 6; i++)
689                                 syndrome[i] = ReadDOC(docptr, Mplus_ECCSyndrome0 + i);
690
691                         nb_errors = doc_decode_ecc(buf, syndrome);
692 #ifdef ECC_DEBUG
693                         printk("ECC Errors corrected: %x\n", nb_errors);
694 #endif
695                         if (nb_errors < 0) {
696                                 /* We return error, but have actually done the read. Not that
697                                    this can be told to user-space, via sys_read(), but at least
698                                    MTD-aware stuff can know about it by checking *retlen */
699 #ifdef ECC_DEBUG
700                         printk("%s(%d): Millennium Plus ECC error (from=0x%x:\n",
701                                 __FILE__, __LINE__, (int)from);
702                         printk("        syndrome= %02x:%02x:%02x:%02x:%02x:"
703                                 "%02x\n",
704                                 syndrome[0], syndrome[1], syndrome[2],
705                                 syndrome[3], syndrome[4], syndrome[5]);
706                         printk("          eccbuf= %02x:%02x:%02x:%02x:%02x:"
707                                 "%02x\n",
708                                 eccbuf[0], eccbuf[1], eccbuf[2],
709                                 eccbuf[3], eccbuf[4], eccbuf[5]);
710 #endif
711                                 ret = -EIO;
712                         }
713                 }
714
715 #ifdef PSYCHO_DEBUG
716                 printk("ECC DATA at %lx: %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
717                        (long)from, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
718                        eccbuf[4], eccbuf[5]);
719 #endif
720
721                 /* disable the ECC engine */
722                 WriteDOC(DOC_ECC_DIS, docptr , Mplus_ECCConf);
723         } else {
724                 /* Read the data via the internal pipeline through CDSN IO
725                    register, see Pipelined Read Operations 11.3 */
726                 MemReadDOC(docptr, buf, len-2);
727                 buf[len-2] = ReadDOC(docptr, Mplus_LastDataRead);
728                 buf[len-1] = ReadDOC(docptr, Mplus_LastDataRead);
729         }
730
731         /* Disable flash internally */
732         WriteDOC(0, docptr, Mplus_FlashSelect);
733
734         return ret;
735 }
736
737 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
738                      size_t *retlen, const u_char *buf)
739 {
740         char eccbuf[6];
741         return doc_write_ecc(mtd, to, len, retlen, buf, eccbuf, NULL);
742 }
743
744 static int doc_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
745                          size_t *retlen, const u_char *buf, u_char *eccbuf,
746                          struct nand_oobinfo *oobsel)
747 {
748         int i, before, ret = 0;
749         loff_t fto;
750         volatile char dummy;
751         struct DiskOnChip *this = mtd->priv;
752         void __iomem * docptr = this->virtadr;
753         struct Nand *mychip = &this->chips[to >> (this->chipshift)];
754
755         /* Don't allow write past end of device */
756         if (to >= this->totlen)
757                 return -EINVAL;
758
759         /* Don't allow writes which aren't exactly one block (512 bytes) */
760         if ((to & 0x1ff) || (len != 0x200))
761                 return -EINVAL;
762
763         /* Determine position of OOB flags, before or after data */
764         before = (this->interleave && (to & 0x200));
765
766         DoC_CheckASIC(docptr);
767
768         /* Find the chip which is to be used and select it */
769         if (this->curfloor != mychip->floor) {
770                 DoC_SelectFloor(docptr, mychip->floor);
771                 DoC_SelectChip(docptr, mychip->chip);
772         } else if (this->curchip != mychip->chip) {
773                 DoC_SelectChip(docptr, mychip->chip);
774         }
775         this->curfloor = mychip->floor;
776         this->curchip = mychip->chip;
777
778         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
779         WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
780
781         /* Reset the chip, see Software Requirement 11.4 item 1. */
782         DoC_Command(docptr, NAND_CMD_RESET, 0);
783         DoC_WaitReady(docptr);
784
785         /* Set device to appropriate plane of flash */
786         fto = to;
787         WriteDOC(DoC_GetDataOffset(mtd, &fto), docptr, Mplus_FlashCmd);
788
789         /* On interleaved devices the flags for 2nd half 512 are before data */
790         if (eccbuf && before)
791                 fto -= 2;
792
793         /* issue the Serial Data In command to initial the Page Program process */
794         DoC_Command(docptr, NAND_CMD_SEQIN, 0x00);
795         DoC_Address(this, 3, fto, 0x00, 0x00);
796
797         /* Disable the ECC engine */
798         WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
799
800         if (eccbuf) {
801                 if (before) {
802                         /* Write the block status BLOCK_USED (0x5555) */
803                         WriteDOC(0x55, docptr, Mil_CDSN_IO);
804                         WriteDOC(0x55, docptr, Mil_CDSN_IO);
805                 }
806
807                 /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
808                 WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, Mplus_ECCConf);
809         }
810
811         MemWriteDOC(docptr, (unsigned char *) buf, len);
812
813         if (eccbuf) {
814                 /* Write ECC data to flash, the ECC info is generated by
815                    the DiskOnChip ECC logic see Reed-Solomon EDC/ECC 11.1 */
816                 DoC_Delay(docptr, 3);
817
818                 /* Read the ECC data through the DiskOnChip ECC logic */
819                 for (i = 0; i < 6; i++)
820                         eccbuf[i] = ReadDOC(docptr, Mplus_ECCSyndrome0 + i);
821
822                 /* disable the ECC engine */
823                 WriteDOC(DOC_ECC_DIS, docptr, Mplus_ECCConf);
824
825                 /* Write the ECC data to flash */
826                 MemWriteDOC(docptr, eccbuf, 6);
827
828                 if (!before) {
829                         /* Write the block status BLOCK_USED (0x5555) */
830                         WriteDOC(0x55, docptr, Mil_CDSN_IO+6);
831                         WriteDOC(0x55, docptr, Mil_CDSN_IO+7);
832                 }
833
834 #ifdef PSYCHO_DEBUG
835                 printk("OOB data at %lx is %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
836                        (long) to, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
837                        eccbuf[4], eccbuf[5]);
838 #endif
839         }
840
841         WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
842         WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
843
844         /* Commit the Page Program command and wait for ready
845            see Software Requirement 11.4 item 1.*/
846         DoC_Command(docptr, NAND_CMD_PAGEPROG, 0x00);
847         DoC_WaitReady(docptr);
848
849         /* Read the status of the flash device through CDSN IO register
850            see Software Requirement 11.4 item 5.*/
851         DoC_Command(docptr, NAND_CMD_STATUS, 0);
852         dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
853         dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
854         DoC_Delay(docptr, 2);
855         if ((dummy = ReadDOC(docptr, Mplus_LastDataRead)) & 1) {
856                 printk("MTD: Error 0x%x programming at 0x%x\n", dummy, (int)to);
857                 /* Error in programming
858                    FIXME: implement Bad Block Replacement (in nftl.c ??) */
859                 *retlen = 0;
860                 ret = -EIO;
861         }
862         dummy = ReadDOC(docptr, Mplus_LastDataRead);
863
864         /* Disable flash internally */
865         WriteDOC(0, docptr, Mplus_FlashSelect);
866
867         /* Let the caller know we completed it */
868         *retlen = len;
869
870         return ret;
871 }
872
873 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
874                         size_t *retlen, u_char *buf)
875 {
876         loff_t fofs, base;
877         struct DiskOnChip *this = mtd->priv;
878         void __iomem * docptr = this->virtadr;
879         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
880         size_t i, size, got, want;
881
882         DoC_CheckASIC(docptr);
883
884         /* Find the chip which is to be used and select it */
885         if (this->curfloor != mychip->floor) {
886                 DoC_SelectFloor(docptr, mychip->floor);
887                 DoC_SelectChip(docptr, mychip->chip);
888         } else if (this->curchip != mychip->chip) {
889                 DoC_SelectChip(docptr, mychip->chip);
890         }
891         this->curfloor = mychip->floor;
892         this->curchip = mychip->chip;
893
894         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
895         WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
896
897         /* disable the ECC engine */
898         WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
899         DoC_WaitReady(docptr);
900
901         /* Maximum of 16 bytes in the OOB region, so limit read to that */
902         if (len > 16)
903                 len = 16;
904         got = 0;
905         want = len;
906
907         for (i = 0; ((i < 3) && (want > 0)); i++) {
908                 /* Figure out which region we are accessing... */
909                 fofs = ofs;
910                 base = ofs & 0xf;
911                 if (!this->interleave) {
912                         DoC_Command(docptr, NAND_CMD_READOOB, 0);
913                         size = 16 - base;
914                 } else if (base < 6) {
915                         DoC_Command(docptr, DoC_GetECCOffset(mtd, &fofs), 0);
916                         size = 6 - base;
917                 } else if (base < 8) {
918                         DoC_Command(docptr, DoC_GetFlagsOffset(mtd, &fofs), 0);
919                         size = 8 - base;
920                 } else {
921                         DoC_Command(docptr, DoC_GetHdrOffset(mtd, &fofs), 0);
922                         size = 16 - base;
923                 }
924                 if (size > want)
925                         size = want;
926
927                 /* Issue read command */
928                 DoC_Address(this, 3, fofs, 0, 0x00);
929                 WriteDOC(0, docptr, Mplus_FlashControl);
930                 DoC_WaitReady(docptr);
931
932                 ReadDOC(docptr, Mplus_ReadPipeInit);
933                 ReadDOC(docptr, Mplus_ReadPipeInit);
934                 MemReadDOC(docptr, &buf[got], size - 2);
935                 buf[got + size - 2] = ReadDOC(docptr, Mplus_LastDataRead);
936                 buf[got + size - 1] = ReadDOC(docptr, Mplus_LastDataRead);
937
938                 ofs += size;
939                 got += size;
940                 want -= size;
941         }
942
943         /* Disable flash internally */
944         WriteDOC(0, docptr, Mplus_FlashSelect);
945
946         *retlen = len;
947         return 0;
948 }
949
950 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
951                          size_t *retlen, const u_char *buf)
952 {
953         volatile char dummy;
954         loff_t fofs, base;
955         struct DiskOnChip *this = mtd->priv;
956         void __iomem * docptr = this->virtadr;
957         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
958         size_t i, size, got, want;
959         int ret = 0;
960
961         DoC_CheckASIC(docptr);
962
963         /* Find the chip which is to be used and select it */
964         if (this->curfloor != mychip->floor) {
965                 DoC_SelectFloor(docptr, mychip->floor);
966                 DoC_SelectChip(docptr, mychip->chip);
967         } else if (this->curchip != mychip->chip) {
968                 DoC_SelectChip(docptr, mychip->chip);
969         }
970         this->curfloor = mychip->floor;
971         this->curchip = mychip->chip;
972
973         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
974         WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
975
976
977         /* Maximum of 16 bytes in the OOB region, so limit write to that */
978         if (len > 16)
979                 len = 16;
980         got = 0;
981         want = len;
982
983         for (i = 0; ((i < 3) && (want > 0)); i++) {
984                 /* Reset the chip, see Software Requirement 11.4 item 1. */
985                 DoC_Command(docptr, NAND_CMD_RESET, 0);
986                 DoC_WaitReady(docptr);
987
988                 /* Figure out which region we are accessing... */
989                 fofs = ofs;
990                 base = ofs & 0x0f;
991                 if (!this->interleave) {
992                         WriteDOC(NAND_CMD_READOOB, docptr, Mplus_FlashCmd);
993                         size = 16 - base;
994                 } else if (base < 6) {
995                         WriteDOC(DoC_GetECCOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
996                         size = 6 - base;
997                 } else if (base < 8) {
998                         WriteDOC(DoC_GetFlagsOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
999                         size = 8 - base;
1000                 } else {
1001                         WriteDOC(DoC_GetHdrOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
1002                         size = 16 - base;
1003                 }
1004                 if (size > want)
1005                         size = want;
1006
1007                 /* Issue the Serial Data In command to initial the Page Program process */
1008                 DoC_Command(docptr, NAND_CMD_SEQIN, 0x00);
1009                 DoC_Address(this, 3, fofs, 0, 0x00);
1010
1011                 /* Disable the ECC engine */
1012                 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
1013
1014                 /* Write the data via the internal pipeline through CDSN IO
1015                    register, see Pipelined Write Operations 11.2 */
1016                 MemWriteDOC(docptr, (unsigned char *) &buf[got], size);
1017                 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
1018                 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
1019
1020                 /* Commit the Page Program command and wait for ready
1021                    see Software Requirement 11.4 item 1.*/
1022                 DoC_Command(docptr, NAND_CMD_PAGEPROG, 0x00);
1023                 DoC_WaitReady(docptr);
1024
1025                 /* Read the status of the flash device through CDSN IO register
1026                    see Software Requirement 11.4 item 5.*/
1027                 DoC_Command(docptr, NAND_CMD_STATUS, 0x00);
1028                 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1029                 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1030                 DoC_Delay(docptr, 2);
1031                 if ((dummy = ReadDOC(docptr, Mplus_LastDataRead)) & 1) {
1032                         printk("MTD: Error 0x%x programming oob at 0x%x\n",
1033                                 dummy, (int)ofs);
1034                         /* FIXME: implement Bad Block Replacement */
1035                         *retlen = 0;
1036                         ret = -EIO;
1037                 }
1038                 dummy = ReadDOC(docptr, Mplus_LastDataRead);
1039
1040                 ofs += size;
1041                 got += size;
1042                 want -= size;
1043         }
1044
1045         /* Disable flash internally */
1046         WriteDOC(0, docptr, Mplus_FlashSelect);
1047
1048         *retlen = len;
1049         return ret;
1050 }
1051
1052 int doc_erase(struct mtd_info *mtd, struct erase_info *instr)
1053 {
1054         volatile char dummy;
1055         struct DiskOnChip *this = mtd->priv;
1056         __u32 ofs = instr->addr;
1057         __u32 len = instr->len;
1058         void __iomem * docptr = this->virtadr;
1059         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
1060
1061         DoC_CheckASIC(docptr);
1062
1063         if (len != mtd->erasesize)
1064                 printk(KERN_WARNING "MTD: Erase not right size (%x != %x)n",
1065                        len, mtd->erasesize);
1066
1067         /* Find the chip which is to be used and select it */
1068         if (this->curfloor != mychip->floor) {
1069                 DoC_SelectFloor(docptr, mychip->floor);
1070                 DoC_SelectChip(docptr, mychip->chip);
1071         } else if (this->curchip != mychip->chip) {
1072                 DoC_SelectChip(docptr, mychip->chip);
1073         }
1074         this->curfloor = mychip->floor;
1075         this->curchip = mychip->chip;
1076
1077         instr->state = MTD_ERASE_PENDING;
1078
1079         /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
1080         WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
1081
1082         DoC_Command(docptr, NAND_CMD_RESET, 0x00);
1083         DoC_WaitReady(docptr);
1084
1085         DoC_Command(docptr, NAND_CMD_ERASE1, 0);
1086         DoC_Address(this, 2, ofs, 0, 0x00);
1087         DoC_Command(docptr, NAND_CMD_ERASE2, 0);
1088         DoC_WaitReady(docptr);
1089         instr->state = MTD_ERASING;
1090
1091         /* Read the status of the flash device through CDSN IO register
1092            see Software Requirement 11.4 item 5. */
1093         DoC_Command(docptr, NAND_CMD_STATUS, 0);
1094         dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1095         dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1096         if ((dummy = ReadDOC(docptr, Mplus_LastDataRead)) & 1) {
1097                 printk("MTD: Error 0x%x erasing at 0x%x\n", dummy, ofs);
1098                 /* FIXME: implement Bad Block Replacement (in nftl.c ??) */
1099                 instr->state = MTD_ERASE_FAILED;
1100         } else {
1101                 instr->state = MTD_ERASE_DONE;
1102         }
1103         dummy = ReadDOC(docptr, Mplus_LastDataRead);
1104
1105         /* Disable flash internally */
1106         WriteDOC(0, docptr, Mplus_FlashSelect);
1107
1108         mtd_erase_callback(instr);
1109
1110         return 0;
1111 }
1112
1113 /****************************************************************************
1114  *
1115  * Module stuff
1116  *
1117  ****************************************************************************/
1118
1119 static void __exit cleanup_doc2001plus(void)
1120 {
1121         struct mtd_info *mtd;
1122         struct DiskOnChip *this;
1123
1124         while ((mtd=docmilpluslist)) {
1125                 this = mtd->priv;
1126                 docmilpluslist = this->nextdoc;
1127
1128                 del_mtd_device(mtd);
1129
1130                 iounmap(this->virtadr);
1131                 kfree(this->chips);
1132                 kfree(mtd);
1133         }
1134 }
1135
1136 module_exit(cleanup_doc2001plus);
1137
1138 MODULE_LICENSE("GPL");
1139 MODULE_AUTHOR("Greg Ungerer <gerg@snapgear.com> et al.");
1140 MODULE_DESCRIPTION("Driver for DiskOnChip Millennium Plus");