Merge branch 'urgent' of git://amd64.org/linux/rric into perf/urgent
[sfrench/cifs-2.6.git] / drivers / mtd / devices / doc2000.c
1
2 /*
3  * Linux driver for Disk-On-Chip 2000 and Millennium
4  * (c) 1999 Machine Vision Holdings, Inc.
5  * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org>
6  */
7
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <asm/errno.h>
11 #include <asm/io.h>
12 #include <asm/uaccess.h>
13 #include <linux/delay.h>
14 #include <linux/slab.h>
15 #include <linux/sched.h>
16 #include <linux/init.h>
17 #include <linux/types.h>
18 #include <linux/bitops.h>
19 #include <linux/mutex.h>
20
21 #include <linux/mtd/mtd.h>
22 #include <linux/mtd/nand.h>
23 #include <linux/mtd/doc2000.h>
24
25 #define DOC_SUPPORT_2000
26 #define DOC_SUPPORT_2000TSOP
27 #define DOC_SUPPORT_MILLENNIUM
28
29 #ifdef DOC_SUPPORT_2000
30 #define DoC_is_2000(doc) (doc->ChipID == DOC_ChipID_Doc2k)
31 #else
32 #define DoC_is_2000(doc) (0)
33 #endif
34
35 #if defined(DOC_SUPPORT_2000TSOP) || defined(DOC_SUPPORT_MILLENNIUM)
36 #define DoC_is_Millennium(doc) (doc->ChipID == DOC_ChipID_DocMil)
37 #else
38 #define DoC_is_Millennium(doc) (0)
39 #endif
40
41 /* #define ECC_DEBUG */
42
43 /* I have no idea why some DoC chips can not use memcpy_from|to_io().
44  * This may be due to the different revisions of the ASIC controller built-in or
45  * simplily a QA/Bug issue. Who knows ?? If you have trouble, please uncomment
46  * this:
47  #undef USE_MEMCPY
48 */
49
50 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
51                     size_t *retlen, u_char *buf);
52 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
53                      size_t *retlen, const u_char *buf);
54 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs,
55                         struct mtd_oob_ops *ops);
56 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs,
57                          struct mtd_oob_ops *ops);
58 static int doc_write_oob_nolock(struct mtd_info *mtd, loff_t ofs, size_t len,
59                          size_t *retlen, const u_char *buf);
60 static int doc_erase (struct mtd_info *mtd, struct erase_info *instr);
61
62 static struct mtd_info *doc2klist = NULL;
63
64 /* Perform the required delay cycles by reading from the appropriate register */
65 static void DoC_Delay(struct DiskOnChip *doc, unsigned short cycles)
66 {
67         volatile char dummy;
68         int i;
69
70         for (i = 0; i < cycles; i++) {
71                 if (DoC_is_Millennium(doc))
72                         dummy = ReadDOC(doc->virtadr, NOP);
73                 else
74                         dummy = ReadDOC(doc->virtadr, DOCStatus);
75         }
76
77 }
78
79 /* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */
80 static int _DoC_WaitReady(struct DiskOnChip *doc)
81 {
82         void __iomem *docptr = doc->virtadr;
83         unsigned long timeo = jiffies + (HZ * 10);
84
85         pr_debug("_DoC_WaitReady called for out-of-line wait\n");
86
87         /* Out-of-line routine to wait for chip response */
88         while (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B)) {
89                 /* issue 2 read from NOP register after reading from CDSNControl register
90                 see Software Requirement 11.4 item 2. */
91                 DoC_Delay(doc, 2);
92
93                 if (time_after(jiffies, timeo)) {
94                         pr_debug("_DoC_WaitReady timed out.\n");
95                         return -EIO;
96                 }
97                 udelay(1);
98                 cond_resched();
99         }
100
101         return 0;
102 }
103
104 static inline int DoC_WaitReady(struct DiskOnChip *doc)
105 {
106         void __iomem *docptr = doc->virtadr;
107
108         /* This is inline, to optimise the common case, where it's ready instantly */
109         int ret = 0;
110
111         /* 4 read form NOP register should be issued in prior to the read from CDSNControl
112            see Software Requirement 11.4 item 2. */
113         DoC_Delay(doc, 4);
114
115         if (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B))
116                 /* Call the out-of-line routine to wait */
117                 ret = _DoC_WaitReady(doc);
118
119         /* issue 2 read from NOP register after reading from CDSNControl register
120            see Software Requirement 11.4 item 2. */
121         DoC_Delay(doc, 2);
122
123         return ret;
124 }
125
126 /* DoC_Command: Send a flash command to the flash chip through the CDSN Slow IO register to
127    bypass the internal pipeline. Each of 4 delay cycles (read from the NOP register) is
128    required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */
129
130 static int DoC_Command(struct DiskOnChip *doc, unsigned char command,
131                               unsigned char xtraflags)
132 {
133         void __iomem *docptr = doc->virtadr;
134
135         if (DoC_is_2000(doc))
136                 xtraflags |= CDSN_CTRL_FLASH_IO;
137
138         /* Assert the CLE (Command Latch Enable) line to the flash chip */
139         WriteDOC(xtraflags | CDSN_CTRL_CLE | CDSN_CTRL_CE, docptr, CDSNControl);
140         DoC_Delay(doc, 4);      /* Software requirement 11.4.3 for Millennium */
141
142         if (DoC_is_Millennium(doc))
143                 WriteDOC(command, docptr, CDSNSlowIO);
144
145         /* Send the command */
146         WriteDOC_(command, docptr, doc->ioreg);
147         if (DoC_is_Millennium(doc))
148                 WriteDOC(command, docptr, WritePipeTerm);
149
150         /* Lower the CLE line */
151         WriteDOC(xtraflags | CDSN_CTRL_CE, docptr, CDSNControl);
152         DoC_Delay(doc, 4);      /* Software requirement 11.4.3 for Millennium */
153
154         /* Wait for the chip to respond - Software requirement 11.4.1 (extended for any command) */
155         return DoC_WaitReady(doc);
156 }
157
158 /* DoC_Address: Set the current address for the flash chip through the CDSN Slow IO register to
159    bypass the internal pipeline. Each of 4 delay cycles (read from the NOP register) is
160    required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */
161
162 static int DoC_Address(struct DiskOnChip *doc, int numbytes, unsigned long ofs,
163                        unsigned char xtraflags1, unsigned char xtraflags2)
164 {
165         int i;
166         void __iomem *docptr = doc->virtadr;
167
168         if (DoC_is_2000(doc))
169                 xtraflags1 |= CDSN_CTRL_FLASH_IO;
170
171         /* Assert the ALE (Address Latch Enable) line to the flash chip */
172         WriteDOC(xtraflags1 | CDSN_CTRL_ALE | CDSN_CTRL_CE, docptr, CDSNControl);
173
174         DoC_Delay(doc, 4);      /* Software requirement 11.4.3 for Millennium */
175
176         /* Send the address */
177         /* Devices with 256-byte page are addressed as:
178            Column (bits 0-7), Page (bits 8-15, 16-23, 24-31)
179            * there is no device on the market with page256
180            and more than 24 bits.
181            Devices with 512-byte page are addressed as:
182            Column (bits 0-7), Page (bits 9-16, 17-24, 25-31)
183            * 25-31 is sent only if the chip support it.
184            * bit 8 changes the read command to be sent
185            (NAND_CMD_READ0 or NAND_CMD_READ1).
186          */
187
188         if (numbytes == ADDR_COLUMN || numbytes == ADDR_COLUMN_PAGE) {
189                 if (DoC_is_Millennium(doc))
190                         WriteDOC(ofs & 0xff, docptr, CDSNSlowIO);
191                 WriteDOC_(ofs & 0xff, docptr, doc->ioreg);
192         }
193
194         if (doc->page256) {
195                 ofs = ofs >> 8;
196         } else {
197                 ofs = ofs >> 9;
198         }
199
200         if (numbytes == ADDR_PAGE || numbytes == ADDR_COLUMN_PAGE) {
201                 for (i = 0; i < doc->pageadrlen; i++, ofs = ofs >> 8) {
202                         if (DoC_is_Millennium(doc))
203                                 WriteDOC(ofs & 0xff, docptr, CDSNSlowIO);
204                         WriteDOC_(ofs & 0xff, docptr, doc->ioreg);
205                 }
206         }
207
208         if (DoC_is_Millennium(doc))
209                 WriteDOC(ofs & 0xff, docptr, WritePipeTerm);
210
211         DoC_Delay(doc, 2);      /* Needed for some slow flash chips. mf. */
212
213         /* FIXME: The SlowIO's for millennium could be replaced by
214            a single WritePipeTerm here. mf. */
215
216         /* Lower the ALE line */
217         WriteDOC(xtraflags1 | xtraflags2 | CDSN_CTRL_CE, docptr,
218                  CDSNControl);
219
220         DoC_Delay(doc, 4);      /* Software requirement 11.4.3 for Millennium */
221
222         /* Wait for the chip to respond - Software requirement 11.4.1 */
223         return DoC_WaitReady(doc);
224 }
225
226 /* Read a buffer from DoC, taking care of Millennium odditys */
227 static void DoC_ReadBuf(struct DiskOnChip *doc, u_char * buf, int len)
228 {
229         volatile int dummy;
230         int modulus = 0xffff;
231         void __iomem *docptr = doc->virtadr;
232         int i;
233
234         if (len <= 0)
235                 return;
236
237         if (DoC_is_Millennium(doc)) {
238                 /* Read the data via the internal pipeline through CDSN IO register,
239                    see Pipelined Read Operations 11.3 */
240                 dummy = ReadDOC(docptr, ReadPipeInit);
241
242                 /* Millennium should use the LastDataRead register - Pipeline Reads */
243                 len--;
244
245                 /* This is needed for correctly ECC calculation */
246                 modulus = 0xff;
247         }
248
249         for (i = 0; i < len; i++)
250                 buf[i] = ReadDOC_(docptr, doc->ioreg + (i & modulus));
251
252         if (DoC_is_Millennium(doc)) {
253                 buf[i] = ReadDOC(docptr, LastDataRead);
254         }
255 }
256
257 /* Write a buffer to DoC, taking care of Millennium odditys */
258 static void DoC_WriteBuf(struct DiskOnChip *doc, const u_char * buf, int len)
259 {
260         void __iomem *docptr = doc->virtadr;
261         int i;
262
263         if (len <= 0)
264                 return;
265
266         for (i = 0; i < len; i++)
267                 WriteDOC_(buf[i], docptr, doc->ioreg + i);
268
269         if (DoC_is_Millennium(doc)) {
270                 WriteDOC(0x00, docptr, WritePipeTerm);
271         }
272 }
273
274
275 /* DoC_SelectChip: Select a given flash chip within the current floor */
276
277 static inline int DoC_SelectChip(struct DiskOnChip *doc, int chip)
278 {
279         void __iomem *docptr = doc->virtadr;
280
281         /* Software requirement 11.4.4 before writing DeviceSelect */
282         /* Deassert the CE line to eliminate glitches on the FCE# outputs */
283         WriteDOC(CDSN_CTRL_WP, docptr, CDSNControl);
284         DoC_Delay(doc, 4);      /* Software requirement 11.4.3 for Millennium */
285
286         /* Select the individual flash chip requested */
287         WriteDOC(chip, docptr, CDSNDeviceSelect);
288         DoC_Delay(doc, 4);
289
290         /* Reassert the CE line */
291         WriteDOC(CDSN_CTRL_CE | CDSN_CTRL_FLASH_IO | CDSN_CTRL_WP, docptr,
292                  CDSNControl);
293         DoC_Delay(doc, 4);      /* Software requirement 11.4.3 for Millennium */
294
295         /* Wait for it to be ready */
296         return DoC_WaitReady(doc);
297 }
298
299 /* DoC_SelectFloor: Select a given floor (bank of flash chips) */
300
301 static inline int DoC_SelectFloor(struct DiskOnChip *doc, int floor)
302 {
303         void __iomem *docptr = doc->virtadr;
304
305         /* Select the floor (bank) of chips required */
306         WriteDOC(floor, docptr, FloorSelect);
307
308         /* Wait for the chip to be ready */
309         return DoC_WaitReady(doc);
310 }
311
312 /* DoC_IdentChip: Identify a given NAND chip given {floor,chip} */
313
314 static int DoC_IdentChip(struct DiskOnChip *doc, int floor, int chip)
315 {
316         int mfr, id, i, j;
317         volatile char dummy;
318
319         /* Page in the required floor/chip */
320         DoC_SelectFloor(doc, floor);
321         DoC_SelectChip(doc, chip);
322
323         /* Reset the chip */
324         if (DoC_Command(doc, NAND_CMD_RESET, CDSN_CTRL_WP)) {
325                 pr_debug("DoC_Command (reset) for %d,%d returned true\n",
326                       floor, chip);
327                 return 0;
328         }
329
330
331         /* Read the NAND chip ID: 1. Send ReadID command */
332         if (DoC_Command(doc, NAND_CMD_READID, CDSN_CTRL_WP)) {
333                 pr_debug("DoC_Command (ReadID) for %d,%d returned true\n",
334                       floor, chip);
335                 return 0;
336         }
337
338         /* Read the NAND chip ID: 2. Send address byte zero */
339         DoC_Address(doc, ADDR_COLUMN, 0, CDSN_CTRL_WP, 0);
340
341         /* Read the manufacturer and device id codes from the device */
342
343         if (DoC_is_Millennium(doc)) {
344                 DoC_Delay(doc, 2);
345                 dummy = ReadDOC(doc->virtadr, ReadPipeInit);
346                 mfr = ReadDOC(doc->virtadr, LastDataRead);
347
348                 DoC_Delay(doc, 2);
349                 dummy = ReadDOC(doc->virtadr, ReadPipeInit);
350                 id = ReadDOC(doc->virtadr, LastDataRead);
351         } else {
352                 /* CDSN Slow IO register see Software Req 11.4 item 5. */
353                 dummy = ReadDOC(doc->virtadr, CDSNSlowIO);
354                 DoC_Delay(doc, 2);
355                 mfr = ReadDOC_(doc->virtadr, doc->ioreg);
356
357                 /* CDSN Slow IO register see Software Req 11.4 item 5. */
358                 dummy = ReadDOC(doc->virtadr, CDSNSlowIO);
359                 DoC_Delay(doc, 2);
360                 id = ReadDOC_(doc->virtadr, doc->ioreg);
361         }
362
363         /* No response - return failure */
364         if (mfr == 0xff || mfr == 0)
365                 return 0;
366
367         /* Check it's the same as the first chip we identified.
368          * M-Systems say that any given DiskOnChip device should only
369          * contain _one_ type of flash part, although that's not a
370          * hardware restriction. */
371         if (doc->mfr) {
372                 if (doc->mfr == mfr && doc->id == id)
373                         return 1;       /* This is the same as the first */
374                 else
375                         printk(KERN_WARNING
376                                "Flash chip at floor %d, chip %d is different:\n",
377                                floor, chip);
378         }
379
380         /* Print and store the manufacturer and ID codes. */
381         for (i = 0; nand_flash_ids[i].name != NULL; i++) {
382                 if (id == nand_flash_ids[i].id) {
383                         /* Try to identify manufacturer */
384                         for (j = 0; nand_manuf_ids[j].id != 0x0; j++) {
385                                 if (nand_manuf_ids[j].id == mfr)
386                                         break;
387                         }
388                         printk(KERN_INFO
389                                "Flash chip found: Manufacturer ID: %2.2X, "
390                                "Chip ID: %2.2X (%s:%s)\n", mfr, id,
391                                nand_manuf_ids[j].name, nand_flash_ids[i].name);
392                         if (!doc->mfr) {
393                                 doc->mfr = mfr;
394                                 doc->id = id;
395                                 doc->chipshift =
396                                         ffs((nand_flash_ids[i].chipsize << 20)) - 1;
397                                 doc->page256 = (nand_flash_ids[i].pagesize == 256) ? 1 : 0;
398                                 doc->pageadrlen = doc->chipshift > 25 ? 3 : 2;
399                                 doc->erasesize =
400                                     nand_flash_ids[i].erasesize;
401                                 return 1;
402                         }
403                         return 0;
404                 }
405         }
406
407
408         /* We haven't fully identified the chip. Print as much as we know. */
409         printk(KERN_WARNING "Unknown flash chip found: %2.2X %2.2X\n",
410                id, mfr);
411
412         printk(KERN_WARNING "Please report to dwmw2@infradead.org\n");
413         return 0;
414 }
415
416 /* DoC_ScanChips: Find all NAND chips present in a DiskOnChip, and identify them */
417
418 static void DoC_ScanChips(struct DiskOnChip *this, int maxchips)
419 {
420         int floor, chip;
421         int numchips[MAX_FLOORS];
422         int ret = 1;
423
424         this->numchips = 0;
425         this->mfr = 0;
426         this->id = 0;
427
428         /* For each floor, find the number of valid chips it contains */
429         for (floor = 0; floor < MAX_FLOORS; floor++) {
430                 ret = 1;
431                 numchips[floor] = 0;
432                 for (chip = 0; chip < maxchips && ret != 0; chip++) {
433
434                         ret = DoC_IdentChip(this, floor, chip);
435                         if (ret) {
436                                 numchips[floor]++;
437                                 this->numchips++;
438                         }
439                 }
440         }
441
442         /* If there are none at all that we recognise, bail */
443         if (!this->numchips) {
444                 printk(KERN_NOTICE "No flash chips recognised.\n");
445                 return;
446         }
447
448         /* Allocate an array to hold the information for each chip */
449         this->chips = kmalloc(sizeof(struct Nand) * this->numchips, GFP_KERNEL);
450         if (!this->chips) {
451                 printk(KERN_NOTICE "No memory for allocating chip info structures\n");
452                 return;
453         }
454
455         ret = 0;
456
457         /* Fill out the chip array with {floor, chipno} for each
458          * detected chip in the device. */
459         for (floor = 0; floor < MAX_FLOORS; floor++) {
460                 for (chip = 0; chip < numchips[floor]; chip++) {
461                         this->chips[ret].floor = floor;
462                         this->chips[ret].chip = chip;
463                         this->chips[ret].curadr = 0;
464                         this->chips[ret].curmode = 0x50;
465                         ret++;
466                 }
467         }
468
469         /* Calculate and print the total size of the device */
470         this->totlen = this->numchips * (1 << this->chipshift);
471
472         printk(KERN_INFO "%d flash chips found. Total DiskOnChip size: %ld MiB\n",
473                this->numchips, this->totlen >> 20);
474 }
475
476 static int DoC2k_is_alias(struct DiskOnChip *doc1, struct DiskOnChip *doc2)
477 {
478         int tmp1, tmp2, retval;
479         if (doc1->physadr == doc2->physadr)
480                 return 1;
481
482         /* Use the alias resolution register which was set aside for this
483          * purpose. If it's value is the same on both chips, they might
484          * be the same chip, and we write to one and check for a change in
485          * the other. It's unclear if this register is usuable in the
486          * DoC 2000 (it's in the Millennium docs), but it seems to work. */
487         tmp1 = ReadDOC(doc1->virtadr, AliasResolution);
488         tmp2 = ReadDOC(doc2->virtadr, AliasResolution);
489         if (tmp1 != tmp2)
490                 return 0;
491
492         WriteDOC((tmp1 + 1) % 0xff, doc1->virtadr, AliasResolution);
493         tmp2 = ReadDOC(doc2->virtadr, AliasResolution);
494         if (tmp2 == (tmp1 + 1) % 0xff)
495                 retval = 1;
496         else
497                 retval = 0;
498
499         /* Restore register contents.  May not be necessary, but do it just to
500          * be safe. */
501         WriteDOC(tmp1, doc1->virtadr, AliasResolution);
502
503         return retval;
504 }
505
506 /* This routine is found from the docprobe code by symbol_get(),
507  * which will bump the use count of this module. */
508 void DoC2k_init(struct mtd_info *mtd)
509 {
510         struct DiskOnChip *this = mtd->priv;
511         struct DiskOnChip *old = NULL;
512         int maxchips;
513
514         /* We must avoid being called twice for the same device. */
515
516         if (doc2klist)
517                 old = doc2klist->priv;
518
519         while (old) {
520                 if (DoC2k_is_alias(old, this)) {
521                         printk(KERN_NOTICE
522                                "Ignoring DiskOnChip 2000 at 0x%lX - already configured\n",
523                                this->physadr);
524                         iounmap(this->virtadr);
525                         kfree(mtd);
526                         return;
527                 }
528                 if (old->nextdoc)
529                         old = old->nextdoc->priv;
530                 else
531                         old = NULL;
532         }
533
534
535         switch (this->ChipID) {
536         case DOC_ChipID_Doc2kTSOP:
537                 mtd->name = "DiskOnChip 2000 TSOP";
538                 this->ioreg = DoC_Mil_CDSN_IO;
539                 /* Pretend it's a Millennium */
540                 this->ChipID = DOC_ChipID_DocMil;
541                 maxchips = MAX_CHIPS;
542                 break;
543         case DOC_ChipID_Doc2k:
544                 mtd->name = "DiskOnChip 2000";
545                 this->ioreg = DoC_2k_CDSN_IO;
546                 maxchips = MAX_CHIPS;
547                 break;
548         case DOC_ChipID_DocMil:
549                 mtd->name = "DiskOnChip Millennium";
550                 this->ioreg = DoC_Mil_CDSN_IO;
551                 maxchips = MAX_CHIPS_MIL;
552                 break;
553         default:
554                 printk("Unknown ChipID 0x%02x\n", this->ChipID);
555                 kfree(mtd);
556                 iounmap(this->virtadr);
557                 return;
558         }
559
560         printk(KERN_NOTICE "%s found at address 0x%lX\n", mtd->name,
561                this->physadr);
562
563         mtd->type = MTD_NANDFLASH;
564         mtd->flags = MTD_CAP_NANDFLASH;
565         mtd->size = 0;
566         mtd->erasesize = 0;
567         mtd->writesize = 512;
568         mtd->oobsize = 16;
569         mtd->owner = THIS_MODULE;
570         mtd->erase = doc_erase;
571         mtd->point = NULL;
572         mtd->unpoint = NULL;
573         mtd->read = doc_read;
574         mtd->write = doc_write;
575         mtd->read_oob = doc_read_oob;
576         mtd->write_oob = doc_write_oob;
577         mtd->sync = NULL;
578
579         this->totlen = 0;
580         this->numchips = 0;
581
582         this->curfloor = -1;
583         this->curchip = -1;
584         mutex_init(&this->lock);
585
586         /* Ident all the chips present. */
587         DoC_ScanChips(this, maxchips);
588
589         if (!this->totlen) {
590                 kfree(mtd);
591                 iounmap(this->virtadr);
592         } else {
593                 this->nextdoc = doc2klist;
594                 doc2klist = mtd;
595                 mtd->size = this->totlen;
596                 mtd->erasesize = this->erasesize;
597                 mtd_device_register(mtd, NULL, 0);
598                 return;
599         }
600 }
601 EXPORT_SYMBOL_GPL(DoC2k_init);
602
603 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
604                     size_t * retlen, u_char * buf)
605 {
606         struct DiskOnChip *this = mtd->priv;
607         void __iomem *docptr = this->virtadr;
608         struct Nand *mychip;
609         unsigned char syndrome[6], eccbuf[6];
610         volatile char dummy;
611         int i, len256 = 0, ret=0;
612         size_t left = len;
613
614         /* Don't allow read past end of device */
615         if (from >= this->totlen)
616                 return -EINVAL;
617
618         mutex_lock(&this->lock);
619
620         *retlen = 0;
621         while (left) {
622                 len = left;
623
624                 /* Don't allow a single read to cross a 512-byte block boundary */
625                 if (from + len > ((from | 0x1ff) + 1))
626                         len = ((from | 0x1ff) + 1) - from;
627
628                 /* The ECC will not be calculated correctly if less than 512 is read */
629                 if (len != 0x200)
630                         printk(KERN_WARNING
631                                "ECC needs a full sector read (adr: %lx size %lx)\n",
632                                (long) from, (long) len);
633
634                 /* printk("DoC_Read (adr: %lx size %lx)\n", (long) from, (long) len); */
635
636
637                 /* Find the chip which is to be used and select it */
638                 mychip = &this->chips[from >> (this->chipshift)];
639
640                 if (this->curfloor != mychip->floor) {
641                         DoC_SelectFloor(this, mychip->floor);
642                         DoC_SelectChip(this, mychip->chip);
643                 } else if (this->curchip != mychip->chip) {
644                         DoC_SelectChip(this, mychip->chip);
645                 }
646
647                 this->curfloor = mychip->floor;
648                 this->curchip = mychip->chip;
649
650                 DoC_Command(this,
651                             (!this->page256
652                              && (from & 0x100)) ? NAND_CMD_READ1 : NAND_CMD_READ0,
653                             CDSN_CTRL_WP);
654                 DoC_Address(this, ADDR_COLUMN_PAGE, from, CDSN_CTRL_WP,
655                             CDSN_CTRL_ECC_IO);
656
657                 /* Prime the ECC engine */
658                 WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
659                 WriteDOC(DOC_ECC_EN, docptr, ECCConf);
660
661                 /* treat crossing 256-byte sector for 2M x 8bits devices */
662                 if (this->page256 && from + len > (from | 0xff) + 1) {
663                         len256 = (from | 0xff) + 1 - from;
664                         DoC_ReadBuf(this, buf, len256);
665
666                         DoC_Command(this, NAND_CMD_READ0, CDSN_CTRL_WP);
667                         DoC_Address(this, ADDR_COLUMN_PAGE, from + len256,
668                                     CDSN_CTRL_WP, CDSN_CTRL_ECC_IO);
669                 }
670
671                 DoC_ReadBuf(this, &buf[len256], len - len256);
672
673                 /* Let the caller know we completed it */
674                 *retlen += len;
675
676                 /* Read the ECC data through the DiskOnChip ECC logic */
677                 /* Note: this will work even with 2M x 8bit devices as   */
678                 /*       they have 8 bytes of OOB per 256 page. mf.      */
679                 DoC_ReadBuf(this, eccbuf, 6);
680
681                 /* Flush the pipeline */
682                 if (DoC_is_Millennium(this)) {
683                         dummy = ReadDOC(docptr, ECCConf);
684                         dummy = ReadDOC(docptr, ECCConf);
685                         i = ReadDOC(docptr, ECCConf);
686                 } else {
687                         dummy = ReadDOC(docptr, 2k_ECCStatus);
688                         dummy = ReadDOC(docptr, 2k_ECCStatus);
689                         i = ReadDOC(docptr, 2k_ECCStatus);
690                 }
691
692                 /* Check the ECC Status */
693                 if (i & 0x80) {
694                         int nb_errors;
695                         /* There was an ECC error */
696 #ifdef ECC_DEBUG
697                         printk(KERN_ERR "DiskOnChip ECC Error: Read at %lx\n", (long)from);
698 #endif
699                         /* Read the ECC syndrome through the DiskOnChip ECC
700                            logic.  These syndrome will be all ZERO when there
701                            is no error */
702                         for (i = 0; i < 6; i++) {
703                                 syndrome[i] =
704                                         ReadDOC(docptr, ECCSyndrome0 + i);
705                         }
706                         nb_errors = doc_decode_ecc(buf, syndrome);
707
708 #ifdef ECC_DEBUG
709                         printk(KERN_ERR "Errors corrected: %x\n", nb_errors);
710 #endif
711                         if (nb_errors < 0) {
712                                 /* We return error, but have actually done the
713                                    read. Not that this can be told to
714                                    user-space, via sys_read(), but at least
715                                    MTD-aware stuff can know about it by
716                                    checking *retlen */
717                                 ret = -EIO;
718                         }
719                 }
720
721 #ifdef PSYCHO_DEBUG
722                 printk(KERN_DEBUG "ECC DATA at %lxB: %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
723                        (long)from, eccbuf[0], eccbuf[1], eccbuf[2],
724                        eccbuf[3], eccbuf[4], eccbuf[5]);
725 #endif
726
727                 /* disable the ECC engine */
728                 WriteDOC(DOC_ECC_DIS, docptr , ECCConf);
729
730                 /* according to 11.4.1, we need to wait for the busy line
731                  * drop if we read to the end of the page.  */
732                 if(0 == ((from + len) & 0x1ff))
733                 {
734                     DoC_WaitReady(this);
735                 }
736
737                 from += len;
738                 left -= len;
739                 buf += len;
740         }
741
742         mutex_unlock(&this->lock);
743
744         return ret;
745 }
746
747 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
748                      size_t * retlen, const u_char * buf)
749 {
750         struct DiskOnChip *this = mtd->priv;
751         int di; /* Yes, DI is a hangover from when I was disassembling the binary driver */
752         void __iomem *docptr = this->virtadr;
753         unsigned char eccbuf[6];
754         volatile char dummy;
755         int len256 = 0;
756         struct Nand *mychip;
757         size_t left = len;
758         int status;
759
760         /* Don't allow write past end of device */
761         if (to >= this->totlen)
762                 return -EINVAL;
763
764         mutex_lock(&this->lock);
765
766         *retlen = 0;
767         while (left) {
768                 len = left;
769
770                 /* Don't allow a single write to cross a 512-byte block boundary */
771                 if (to + len > ((to | 0x1ff) + 1))
772                         len = ((to | 0x1ff) + 1) - to;
773
774                 /* The ECC will not be calculated correctly if less than 512 is written */
775 /* DBB-
776                 if (len != 0x200 && eccbuf)
777                         printk(KERN_WARNING
778                                "ECC needs a full sector write (adr: %lx size %lx)\n",
779                                (long) to, (long) len);
780    -DBB */
781
782                 /* printk("DoC_Write (adr: %lx size %lx)\n", (long) to, (long) len); */
783
784                 /* Find the chip which is to be used and select it */
785                 mychip = &this->chips[to >> (this->chipshift)];
786
787                 if (this->curfloor != mychip->floor) {
788                         DoC_SelectFloor(this, mychip->floor);
789                         DoC_SelectChip(this, mychip->chip);
790                 } else if (this->curchip != mychip->chip) {
791                         DoC_SelectChip(this, mychip->chip);
792                 }
793
794                 this->curfloor = mychip->floor;
795                 this->curchip = mychip->chip;
796
797                 /* Set device to main plane of flash */
798                 DoC_Command(this, NAND_CMD_RESET, CDSN_CTRL_WP);
799                 DoC_Command(this,
800                             (!this->page256
801                              && (to & 0x100)) ? NAND_CMD_READ1 : NAND_CMD_READ0,
802                             CDSN_CTRL_WP);
803
804                 DoC_Command(this, NAND_CMD_SEQIN, 0);
805                 DoC_Address(this, ADDR_COLUMN_PAGE, to, 0, CDSN_CTRL_ECC_IO);
806
807                 /* Prime the ECC engine */
808                 WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
809                 WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, ECCConf);
810
811                 /* treat crossing 256-byte sector for 2M x 8bits devices */
812                 if (this->page256 && to + len > (to | 0xff) + 1) {
813                         len256 = (to | 0xff) + 1 - to;
814                         DoC_WriteBuf(this, buf, len256);
815
816                         DoC_Command(this, NAND_CMD_PAGEPROG, 0);
817
818                         DoC_Command(this, NAND_CMD_STATUS, CDSN_CTRL_WP);
819                         /* There's an implicit DoC_WaitReady() in DoC_Command */
820
821                         dummy = ReadDOC(docptr, CDSNSlowIO);
822                         DoC_Delay(this, 2);
823
824                         if (ReadDOC_(docptr, this->ioreg) & 1) {
825                                 printk(KERN_ERR "Error programming flash\n");
826                                 /* Error in programming */
827                                 *retlen = 0;
828                                 mutex_unlock(&this->lock);
829                                 return -EIO;
830                         }
831
832                         DoC_Command(this, NAND_CMD_SEQIN, 0);
833                         DoC_Address(this, ADDR_COLUMN_PAGE, to + len256, 0,
834                                     CDSN_CTRL_ECC_IO);
835                 }
836
837                 DoC_WriteBuf(this, &buf[len256], len - len256);
838
839                 WriteDOC(CDSN_CTRL_ECC_IO | CDSN_CTRL_CE, docptr, CDSNControl);
840
841                 if (DoC_is_Millennium(this)) {
842                         WriteDOC(0, docptr, NOP);
843                         WriteDOC(0, docptr, NOP);
844                         WriteDOC(0, docptr, NOP);
845                 } else {
846                         WriteDOC_(0, docptr, this->ioreg);
847                         WriteDOC_(0, docptr, this->ioreg);
848                         WriteDOC_(0, docptr, this->ioreg);
849                 }
850
851                 WriteDOC(CDSN_CTRL_ECC_IO | CDSN_CTRL_FLASH_IO | CDSN_CTRL_CE, docptr,
852                          CDSNControl);
853
854                 /* Read the ECC data through the DiskOnChip ECC logic */
855                 for (di = 0; di < 6; di++) {
856                         eccbuf[di] = ReadDOC(docptr, ECCSyndrome0 + di);
857                 }
858
859                 /* Reset the ECC engine */
860                 WriteDOC(DOC_ECC_DIS, docptr, ECCConf);
861
862 #ifdef PSYCHO_DEBUG
863                 printk
864                         ("OOB data at %lx is %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
865                          (long) to, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
866                          eccbuf[4], eccbuf[5]);
867 #endif
868                 DoC_Command(this, NAND_CMD_PAGEPROG, 0);
869
870                 DoC_Command(this, NAND_CMD_STATUS, CDSN_CTRL_WP);
871                 /* There's an implicit DoC_WaitReady() in DoC_Command */
872
873                 if (DoC_is_Millennium(this)) {
874                         ReadDOC(docptr, ReadPipeInit);
875                         status = ReadDOC(docptr, LastDataRead);
876                 } else {
877                         dummy = ReadDOC(docptr, CDSNSlowIO);
878                         DoC_Delay(this, 2);
879                         status = ReadDOC_(docptr, this->ioreg);
880                 }
881
882                 if (status & 1) {
883                         printk(KERN_ERR "Error programming flash\n");
884                         /* Error in programming */
885                         *retlen = 0;
886                         mutex_unlock(&this->lock);
887                         return -EIO;
888                 }
889
890                 /* Let the caller know we completed it */
891                 *retlen += len;
892
893                 {
894                         unsigned char x[8];
895                         size_t dummy;
896                         int ret;
897
898                         /* Write the ECC data to flash */
899                         for (di=0; di<6; di++)
900                                 x[di] = eccbuf[di];
901
902                         x[6]=0x55;
903                         x[7]=0x55;
904
905                         ret = doc_write_oob_nolock(mtd, to, 8, &dummy, x);
906                         if (ret) {
907                                 mutex_unlock(&this->lock);
908                                 return ret;
909                         }
910                 }
911
912                 to += len;
913                 left -= len;
914                 buf += len;
915         }
916
917         mutex_unlock(&this->lock);
918         return 0;
919 }
920
921 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs,
922                         struct mtd_oob_ops *ops)
923 {
924         struct DiskOnChip *this = mtd->priv;
925         int len256 = 0, ret;
926         struct Nand *mychip;
927         uint8_t *buf = ops->oobbuf;
928         size_t len = ops->len;
929
930         BUG_ON(ops->mode != MTD_OPS_PLACE_OOB);
931
932         ofs += ops->ooboffs;
933
934         mutex_lock(&this->lock);
935
936         mychip = &this->chips[ofs >> this->chipshift];
937
938         if (this->curfloor != mychip->floor) {
939                 DoC_SelectFloor(this, mychip->floor);
940                 DoC_SelectChip(this, mychip->chip);
941         } else if (this->curchip != mychip->chip) {
942                 DoC_SelectChip(this, mychip->chip);
943         }
944         this->curfloor = mychip->floor;
945         this->curchip = mychip->chip;
946
947         /* update address for 2M x 8bit devices. OOB starts on the second */
948         /* page to maintain compatibility with doc_read_ecc. */
949         if (this->page256) {
950                 if (!(ofs & 0x8))
951                         ofs += 0x100;
952                 else
953                         ofs -= 0x8;
954         }
955
956         DoC_Command(this, NAND_CMD_READOOB, CDSN_CTRL_WP);
957         DoC_Address(this, ADDR_COLUMN_PAGE, ofs, CDSN_CTRL_WP, 0);
958
959         /* treat crossing 8-byte OOB data for 2M x 8bit devices */
960         /* Note: datasheet says it should automaticaly wrap to the */
961         /*       next OOB block, but it didn't work here. mf.      */
962         if (this->page256 && ofs + len > (ofs | 0x7) + 1) {
963                 len256 = (ofs | 0x7) + 1 - ofs;
964                 DoC_ReadBuf(this, buf, len256);
965
966                 DoC_Command(this, NAND_CMD_READOOB, CDSN_CTRL_WP);
967                 DoC_Address(this, ADDR_COLUMN_PAGE, ofs & (~0x1ff),
968                             CDSN_CTRL_WP, 0);
969         }
970
971         DoC_ReadBuf(this, &buf[len256], len - len256);
972
973         ops->retlen = len;
974         /* Reading the full OOB data drops us off of the end of the page,
975          * causing the flash device to go into busy mode, so we need
976          * to wait until ready 11.4.1 and Toshiba TC58256FT docs */
977
978         ret = DoC_WaitReady(this);
979
980         mutex_unlock(&this->lock);
981         return ret;
982
983 }
984
985 static int doc_write_oob_nolock(struct mtd_info *mtd, loff_t ofs, size_t len,
986                                 size_t * retlen, const u_char * buf)
987 {
988         struct DiskOnChip *this = mtd->priv;
989         int len256 = 0;
990         void __iomem *docptr = this->virtadr;
991         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
992         volatile int dummy;
993         int status;
994
995         //      printk("doc_write_oob(%lx, %d): %2.2X %2.2X %2.2X %2.2X ... %2.2X %2.2X .. %2.2X %2.2X\n",(long)ofs, len,
996         //   buf[0], buf[1], buf[2], buf[3], buf[8], buf[9], buf[14],buf[15]);
997
998         /* Find the chip which is to be used and select it */
999         if (this->curfloor != mychip->floor) {
1000                 DoC_SelectFloor(this, mychip->floor);
1001                 DoC_SelectChip(this, mychip->chip);
1002         } else if (this->curchip != mychip->chip) {
1003                 DoC_SelectChip(this, mychip->chip);
1004         }
1005         this->curfloor = mychip->floor;
1006         this->curchip = mychip->chip;
1007
1008         /* disable the ECC engine */
1009         WriteDOC (DOC_ECC_RESET, docptr, ECCConf);
1010         WriteDOC (DOC_ECC_DIS, docptr, ECCConf);
1011
1012         /* Reset the chip, see Software Requirement 11.4 item 1. */
1013         DoC_Command(this, NAND_CMD_RESET, CDSN_CTRL_WP);
1014
1015         /* issue the Read2 command to set the pointer to the Spare Data Area. */
1016         DoC_Command(this, NAND_CMD_READOOB, CDSN_CTRL_WP);
1017
1018         /* update address for 2M x 8bit devices. OOB starts on the second */
1019         /* page to maintain compatibility with doc_read_ecc. */
1020         if (this->page256) {
1021                 if (!(ofs & 0x8))
1022                         ofs += 0x100;
1023                 else
1024                         ofs -= 0x8;
1025         }
1026
1027         /* issue the Serial Data In command to initial the Page Program process */
1028         DoC_Command(this, NAND_CMD_SEQIN, 0);
1029         DoC_Address(this, ADDR_COLUMN_PAGE, ofs, 0, 0);
1030
1031         /* treat crossing 8-byte OOB data for 2M x 8bit devices */
1032         /* Note: datasheet says it should automaticaly wrap to the */
1033         /*       next OOB block, but it didn't work here. mf.      */
1034         if (this->page256 && ofs + len > (ofs | 0x7) + 1) {
1035                 len256 = (ofs | 0x7) + 1 - ofs;
1036                 DoC_WriteBuf(this, buf, len256);
1037
1038                 DoC_Command(this, NAND_CMD_PAGEPROG, 0);
1039                 DoC_Command(this, NAND_CMD_STATUS, 0);
1040                 /* DoC_WaitReady() is implicit in DoC_Command */
1041
1042                 if (DoC_is_Millennium(this)) {
1043                         ReadDOC(docptr, ReadPipeInit);
1044                         status = ReadDOC(docptr, LastDataRead);
1045                 } else {
1046                         dummy = ReadDOC(docptr, CDSNSlowIO);
1047                         DoC_Delay(this, 2);
1048                         status = ReadDOC_(docptr, this->ioreg);
1049                 }
1050
1051                 if (status & 1) {
1052                         printk(KERN_ERR "Error programming oob data\n");
1053                         /* There was an error */
1054                         *retlen = 0;
1055                         return -EIO;
1056                 }
1057                 DoC_Command(this, NAND_CMD_SEQIN, 0);
1058                 DoC_Address(this, ADDR_COLUMN_PAGE, ofs & (~0x1ff), 0, 0);
1059         }
1060
1061         DoC_WriteBuf(this, &buf[len256], len - len256);
1062
1063         DoC_Command(this, NAND_CMD_PAGEPROG, 0);
1064         DoC_Command(this, NAND_CMD_STATUS, 0);
1065         /* DoC_WaitReady() is implicit in DoC_Command */
1066
1067         if (DoC_is_Millennium(this)) {
1068                 ReadDOC(docptr, ReadPipeInit);
1069                 status = ReadDOC(docptr, LastDataRead);
1070         } else {
1071                 dummy = ReadDOC(docptr, CDSNSlowIO);
1072                 DoC_Delay(this, 2);
1073                 status = ReadDOC_(docptr, this->ioreg);
1074         }
1075
1076         if (status & 1) {
1077                 printk(KERN_ERR "Error programming oob data\n");
1078                 /* There was an error */
1079                 *retlen = 0;
1080                 return -EIO;
1081         }
1082
1083         *retlen = len;
1084         return 0;
1085
1086 }
1087
1088 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs,
1089                          struct mtd_oob_ops *ops)
1090 {
1091         struct DiskOnChip *this = mtd->priv;
1092         int ret;
1093
1094         BUG_ON(ops->mode != MTD_OPS_PLACE_OOB);
1095
1096         mutex_lock(&this->lock);
1097         ret = doc_write_oob_nolock(mtd, ofs + ops->ooboffs, ops->len,
1098                                    &ops->retlen, ops->oobbuf);
1099
1100         mutex_unlock(&this->lock);
1101         return ret;
1102 }
1103
1104 static int doc_erase(struct mtd_info *mtd, struct erase_info *instr)
1105 {
1106         struct DiskOnChip *this = mtd->priv;
1107         __u32 ofs = instr->addr;
1108         __u32 len = instr->len;
1109         volatile int dummy;
1110         void __iomem *docptr = this->virtadr;
1111         struct Nand *mychip;
1112         int status;
1113
1114         mutex_lock(&this->lock);
1115
1116         if (ofs & (mtd->erasesize-1) || len & (mtd->erasesize-1)) {
1117                 mutex_unlock(&this->lock);
1118                 return -EINVAL;
1119         }
1120
1121         instr->state = MTD_ERASING;
1122
1123         /* FIXME: Do this in the background. Use timers or schedule_task() */
1124         while(len) {
1125                 mychip = &this->chips[ofs >> this->chipshift];
1126
1127                 if (this->curfloor != mychip->floor) {
1128                         DoC_SelectFloor(this, mychip->floor);
1129                         DoC_SelectChip(this, mychip->chip);
1130                 } else if (this->curchip != mychip->chip) {
1131                         DoC_SelectChip(this, mychip->chip);
1132                 }
1133                 this->curfloor = mychip->floor;
1134                 this->curchip = mychip->chip;
1135
1136                 DoC_Command(this, NAND_CMD_ERASE1, 0);
1137                 DoC_Address(this, ADDR_PAGE, ofs, 0, 0);
1138                 DoC_Command(this, NAND_CMD_ERASE2, 0);
1139
1140                 DoC_Command(this, NAND_CMD_STATUS, CDSN_CTRL_WP);
1141
1142                 if (DoC_is_Millennium(this)) {
1143                         ReadDOC(docptr, ReadPipeInit);
1144                         status = ReadDOC(docptr, LastDataRead);
1145                 } else {
1146                         dummy = ReadDOC(docptr, CDSNSlowIO);
1147                         DoC_Delay(this, 2);
1148                         status = ReadDOC_(docptr, this->ioreg);
1149                 }
1150
1151                 if (status & 1) {
1152                         printk(KERN_ERR "Error erasing at 0x%x\n", ofs);
1153                         /* There was an error */
1154                         instr->state = MTD_ERASE_FAILED;
1155                         goto callback;
1156                 }
1157                 ofs += mtd->erasesize;
1158                 len -= mtd->erasesize;
1159         }
1160         instr->state = MTD_ERASE_DONE;
1161
1162  callback:
1163         mtd_erase_callback(instr);
1164
1165         mutex_unlock(&this->lock);
1166         return 0;
1167 }
1168
1169
1170 /****************************************************************************
1171  *
1172  * Module stuff
1173  *
1174  ****************************************************************************/
1175
1176 static void __exit cleanup_doc2000(void)
1177 {
1178         struct mtd_info *mtd;
1179         struct DiskOnChip *this;
1180
1181         while ((mtd = doc2klist)) {
1182                 this = mtd->priv;
1183                 doc2klist = this->nextdoc;
1184
1185                 mtd_device_unregister(mtd);
1186
1187                 iounmap(this->virtadr);
1188                 kfree(this->chips);
1189                 kfree(mtd);
1190         }
1191 }
1192
1193 module_exit(cleanup_doc2000);
1194
1195 MODULE_LICENSE("GPL");
1196 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org> et al.");
1197 MODULE_DESCRIPTION("MTD driver for DiskOnChip 2000 and Millennium");
1198