2 * Linux driver for Disk-On-Chip Millennium Plus
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>
9 * $Id: doc2001plus.c,v 1.14 2005/11/07 11:14:24 gleixner Exp $
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <asm/errno.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>
28 #include <linux/mtd/mtd.h>
29 #include <linux/mtd/nand.h>
30 #include <linux/mtd/doc2000.h>
32 /* #define ECC_DEBUG */
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
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,
51 struct mtd_oob_ops *ops);
52 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs,
53 struct mtd_oob_ops *ops);
54 static int doc_erase (struct mtd_info *mtd, struct erase_info *instr);
56 static struct mtd_info *docmilpluslist = NULL;
59 /* Perform the required delay cycles by writing to the NOP register */
60 static void DoC_Delay(void __iomem * docptr, int cycles)
64 for (i = 0; (i < cycles); i++)
65 WriteDOC(0, docptr, Mplus_NOP);
68 #define CDSN_CTRL_FR_B_MASK (CDSN_CTRL_FR_B0 | CDSN_CTRL_FR_B1)
70 /* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */
71 static int _DoC_WaitReady(void __iomem * docptr)
73 unsigned int c = 0xffff;
75 DEBUG(MTD_DEBUG_LEVEL3,
76 "_DoC_WaitReady called for out-of-line wait\n");
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)
83 DEBUG(MTD_DEBUG_LEVEL2, "_DoC_WaitReady timed out.\n");
88 static inline int DoC_WaitReady(void __iomem * docptr)
90 /* This is inline, to optimise the common case, where it's ready instantly */
93 /* read form NOP register should be issued prior to the read from CDSNControl
94 see Software Requirement 11.4 item 2. */
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);
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.
109 static inline void DoC_CheckASIC(void __iomem * docptr)
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);
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.
121 static void DoC_Command(void __iomem * docptr, unsigned char command,
122 unsigned char xtraflags)
124 WriteDOC(command, docptr, Mplus_FlashCmd);
125 WriteDOC(command, docptr, Mplus_WritePipeTerm);
126 WriteDOC(command, docptr, Mplus_WritePipeTerm);
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.
132 static inline void DoC_Address(struct DiskOnChip *doc, int numbytes,
133 unsigned long ofs, unsigned char xtraflags1,
134 unsigned char xtraflags2)
136 void __iomem * docptr = doc->virtadr;
138 /* Allow for possible Mill Plus internal flash interleaving */
139 ofs >>= doc->interleave;
143 /* Send single byte, bits 0-7. */
144 WriteDOC(ofs & 0xff, docptr, Mplus_FlashAddress);
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);
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);
161 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
162 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
165 /* DoC_SelectChip: Select a given flash chip within the current floor */
166 static int DoC_SelectChip(void __iomem * docptr, int chip)
168 /* No choice for flash chip on Millennium Plus */
172 /* DoC_SelectFloor: Select a given floor (bank of flash chips) */
173 static int DoC_SelectFloor(void __iomem * docptr, int floor)
175 WriteDOC((floor & 0x3), docptr, Mplus_DeviceSelect);
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 * +-----------+-------+-------+-------+--------------+---------+-----------+
189 /* FIXME: This lives in INFTL not here. Other users of flash devices
191 static unsigned int DoC_GetDataOffset(struct mtd_info *mtd, loff_t *from)
193 struct DiskOnChip *this = mtd->priv;
195 if (this->interleave) {
196 unsigned int ofs = *from & 0x3ff;
200 cmd = NAND_CMD_READ0;
202 } else if (ofs < 1014) {
203 cmd = NAND_CMD_READ1;
204 ofs = (ofs & 0x1ff) + 10;
206 cmd = NAND_CMD_READOOB;
210 *from = (*from & ~0x3ff) | ofs;
215 return NAND_CMD_READ1;
216 return NAND_CMD_READ0;
220 static unsigned int DoC_GetECCOffset(struct mtd_info *mtd, loff_t *from)
222 unsigned int ofs, cmd;
225 cmd = NAND_CMD_READOOB;
226 ofs = 10 + (*from & 0xf);
228 cmd = NAND_CMD_READ1;
232 *from = (*from & ~0x3ff) | ofs;
236 static unsigned int DoC_GetFlagsOffset(struct mtd_info *mtd, loff_t *from)
238 unsigned int ofs, cmd;
240 cmd = NAND_CMD_READ1;
241 ofs = (*from & 0x200) ? 8 : 6;
242 *from = (*from & ~0x3ff) | ofs;
246 static unsigned int DoC_GetHdrOffset(struct mtd_info *mtd, loff_t *from)
248 unsigned int ofs, cmd;
250 cmd = NAND_CMD_READOOB;
251 ofs = (*from & 0x200) ? 24 : 16;
252 *from = (*from & ~0x3ff) | ofs;
256 static inline void MemReadDOC(void __iomem * docptr, unsigned char *buf, int len)
260 for (i = 0; i < len; i++)
261 buf[i] = ReadDOC(docptr, Mil_CDSN_IO + i);
263 memcpy_fromio(buf, docptr + DoC_Mil_CDSN_IO, len);
267 static inline void MemWriteDOC(void __iomem * docptr, unsigned char *buf, int len)
271 for (i = 0; i < len; i++)
272 WriteDOC(buf[i], docptr, Mil_CDSN_IO + i);
274 memcpy_toio(docptr + DoC_Mil_CDSN_IO, buf, len);
278 /* DoC_IdentChip: Identify a given NAND chip given {floor,chip} */
279 static int DoC_IdentChip(struct DiskOnChip *doc, int floor, int chip)
283 void __iomem * docptr = doc->virtadr;
285 /* Page in the required floor/chip */
286 DoC_SelectFloor(docptr, floor);
287 DoC_SelectChip(docptr, chip);
289 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
290 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
292 /* Reset the chip, see Software Requirement 11.4 item 1. */
293 DoC_Command(docptr, NAND_CMD_RESET, 0);
294 DoC_WaitReady(docptr);
296 /* Read the NAND chip ID: 1. Send ReadID command */
297 DoC_Command(docptr, NAND_CMD_READID, 0);
299 /* Read the NAND chip ID: 2. Send address byte zero */
300 DoC_Address(doc, 1, 0x00, 0, 0x00);
302 WriteDOC(0, docptr, Mplus_FlashControl);
303 DoC_WaitReady(docptr);
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);
310 mfr = ReadDOC(docptr, Mil_CDSN_IO);
312 dummy = ReadDOC(docptr, Mil_CDSN_IO); /* 2 way interleave */
314 id = ReadDOC(docptr, Mil_CDSN_IO);
316 dummy = ReadDOC(docptr, Mil_CDSN_IO); /* 2 way interleave */
318 dummy = ReadDOC(docptr, Mplus_LastDataRead);
319 dummy = ReadDOC(docptr, Mplus_LastDataRead);
321 /* Disable flash internally */
322 WriteDOC(0, docptr, Mplus_FlashSelect);
324 /* No response - return failure */
325 if (mfr == 0xff || mfr == 0)
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)
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);
340 doc->chipshift = ffs((nand_flash_ids[i].chipsize << 20)) - 1;
341 doc->erasesize = nand_flash_ids[i].erasesize << doc->interleave;
346 if (nand_flash_ids[i].name == NULL)
351 /* DoC_ScanChips: Find all NAND chips present in a DiskOnChip, and identify them */
352 static void DoC_ScanChips(struct DiskOnChip *this)
355 int numchips[MAX_FLOORS_MPLUS];
362 /* Work out the intended interleave setting */
363 this->interleave = 0;
364 if (this->ChipID == DOC_ChipID_DocMilPlus32)
365 this->interleave = 1;
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)");
374 WriteDOC(conf, this->virtadr, Mplus_Configuration);
377 /* For each floor, find the number of valid chips it contains */
378 for (floor = 0,ret = 1; floor < MAX_FLOORS_MPLUS; floor++) {
380 for (chip = 0; chip < MAX_CHIPS_MPLUS && ret != 0; chip++) {
381 ret = DoC_IdentChip(this, floor, chip);
388 /* If there are none at all that we recognise, bail */
389 if (!this->numchips) {
390 printk("No flash chips recognised.\n");
394 /* Allocate an array to hold the information for each chip */
395 this->chips = kmalloc(sizeof(struct Nand) * this->numchips, GFP_KERNEL);
397 printk("MTD: No memory for allocating chip info structures\n");
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;
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);
419 static int DoCMilPlus_is_alias(struct DiskOnChip *doc1, struct DiskOnChip *doc2)
421 int tmp1, tmp2, retval;
423 if (doc1->physadr == doc2->physadr)
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);
436 WriteDOC((tmp1+1) % 0xff, doc1->virtadr, Mplus_AliasResolution);
437 tmp2 = ReadDOC(doc2->virtadr, Mplus_AliasResolution);
438 if (tmp2 == (tmp1+1) % 0xff)
443 /* Restore register contents. May not be necessary, but do it just to
445 WriteDOC(tmp1, doc1->virtadr, Mplus_AliasResolution);
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)
454 struct DiskOnChip *this = mtd->priv;
455 struct DiskOnChip *old = NULL;
457 /* We must avoid being called twice for the same device. */
459 old = docmilpluslist->priv;
462 if (DoCMilPlus_is_alias(this, old)) {
463 printk(KERN_NOTICE "Ignoring DiskOnChip Millennium "
464 "Plus at 0x%lX - already configured\n",
466 iounmap(this->virtadr);
471 old = old->nextdoc->priv;
476 mtd->name = "DiskOnChip Millennium Plus";
477 printk(KERN_NOTICE "DiskOnChip Millennium Plus found at "
478 "address 0x%lX\n", this->physadr);
480 mtd->type = MTD_NANDFLASH;
481 mtd->flags = MTD_CAP_NANDFLASH;
482 mtd->ecctype = MTD_ECC_RS_DiskOnChip;
486 mtd->writesize = 512;
488 mtd->owner = THIS_MODULE;
489 mtd->erase = doc_erase;
492 mtd->read = doc_read;
493 mtd->write = doc_write;
494 mtd->read_oob = doc_read_oob;
495 mtd->write_oob = doc_write_oob;
503 /* Ident all the chips present. */
508 iounmap(this->virtadr);
510 this->nextdoc = docmilpluslist;
511 docmilpluslist = mtd;
512 mtd->size = this->totlen;
513 mtd->erasesize = this->erasesize;
518 EXPORT_SYMBOL_GPL(DoCMilPlus_init);
521 static int doc_dumpblk(struct mtd_info *mtd, loff_t from)
525 struct DiskOnChip *this = mtd->priv;
526 void __iomem * docptr = this->virtadr;
527 struct Nand *mychip = &this->chips[from >> (this->chipshift)];
528 unsigned char *bp, buf[1056];
533 /* Don't allow read past end of device */
534 if (from >= this->totlen)
537 DoC_CheckASIC(docptr);
539 /* Find the chip which is to be used and select it */
540 if (this->curfloor != mychip->floor) {
541 DoC_SelectFloor(docptr, mychip->floor);
542 DoC_SelectChip(docptr, mychip->chip);
543 } else if (this->curchip != mychip->chip) {
544 DoC_SelectChip(docptr, mychip->chip);
546 this->curfloor = mychip->floor;
547 this->curchip = mychip->chip;
549 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
550 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
552 /* Reset the chip, see Software Requirement 11.4 item 1. */
553 DoC_Command(docptr, NAND_CMD_RESET, 0);
554 DoC_WaitReady(docptr);
557 DoC_Command(docptr, DoC_GetDataOffset(mtd, &fofs), 0);
558 DoC_Address(this, 3, fofs, 0, 0x00);
559 WriteDOC(0, docptr, Mplus_FlashControl);
560 DoC_WaitReady(docptr);
562 /* disable the ECC engine */
563 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
565 ReadDOC(docptr, Mplus_ReadPipeInit);
566 ReadDOC(docptr, Mplus_ReadPipeInit);
568 /* Read the data via the internal pipeline through CDSN IO
569 register, see Pipelined Read Operations 11.3 */
570 MemReadDOC(docptr, buf, 1054);
571 buf[1054] = ReadDOC(docptr, Mplus_LastDataRead);
572 buf[1055] = ReadDOC(docptr, Mplus_LastDataRead);
574 memset(&c[0], 0, sizeof(c));
575 printk("DUMP OFFSET=%x:\n", (int)from);
577 for (i = 0, bp = &buf[0]; (i < 1056); i++) {
580 printk(" %02x", *bp);
581 c[(i & 0xf)] = ((*bp >= 0x20) && (*bp <= 0x7f)) ? *bp : '.';
583 if (((i + 1) % 16) == 0)
588 /* Disable flash internally */
589 WriteDOC(0, docptr, Mplus_FlashSelect);
595 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
596 size_t *retlen, u_char *buf)
598 /* Just a special case of doc_read_ecc */
599 return doc_read_ecc(mtd, from, len, retlen, buf, NULL, NULL);
602 static int doc_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
603 size_t *retlen, u_char *buf, u_char *eccbuf,
604 struct nand_oobinfo *oobsel)
609 unsigned char syndrome[6];
610 struct DiskOnChip *this = mtd->priv;
611 void __iomem * docptr = this->virtadr;
612 struct Nand *mychip = &this->chips[from >> (this->chipshift)];
614 /* Don't allow read past end of device */
615 if (from >= this->totlen)
618 /* Don't allow a single read to cross a 512-byte block boundary */
619 if (from + len > ((from | 0x1ff) + 1))
620 len = ((from | 0x1ff) + 1) - from;
622 DoC_CheckASIC(docptr);
624 /* Find the chip which is to be used and select it */
625 if (this->curfloor != mychip->floor) {
626 DoC_SelectFloor(docptr, mychip->floor);
627 DoC_SelectChip(docptr, mychip->chip);
628 } else if (this->curchip != mychip->chip) {
629 DoC_SelectChip(docptr, mychip->chip);
631 this->curfloor = mychip->floor;
632 this->curchip = mychip->chip;
634 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
635 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
637 /* Reset the chip, see Software Requirement 11.4 item 1. */
638 DoC_Command(docptr, NAND_CMD_RESET, 0);
639 DoC_WaitReady(docptr);
642 DoC_Command(docptr, DoC_GetDataOffset(mtd, &fofs), 0);
643 DoC_Address(this, 3, fofs, 0, 0x00);
644 WriteDOC(0, docptr, Mplus_FlashControl);
645 DoC_WaitReady(docptr);
648 /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
649 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
650 WriteDOC(DOC_ECC_EN, docptr, Mplus_ECCConf);
652 /* disable the ECC engine */
653 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
656 /* Let the caller know we completed it */
660 ReadDOC(docptr, Mplus_ReadPipeInit);
661 ReadDOC(docptr, Mplus_ReadPipeInit);
664 /* Read the data via the internal pipeline through CDSN IO
665 register, see Pipelined Read Operations 11.3 */
666 MemReadDOC(docptr, buf, len);
668 /* Read the ECC data following raw data */
669 MemReadDOC(docptr, eccbuf, 4);
670 eccbuf[4] = ReadDOC(docptr, Mplus_LastDataRead);
671 eccbuf[5] = ReadDOC(docptr, Mplus_LastDataRead);
673 /* Flush the pipeline */
674 dummy = ReadDOC(docptr, Mplus_ECCConf);
675 dummy = ReadDOC(docptr, Mplus_ECCConf);
677 /* Check the ECC Status */
678 if (ReadDOC(docptr, Mplus_ECCConf) & 0x80) {
680 /* There was an ECC error */
682 printk("DiskOnChip ECC Error: Read at %lx\n", (long)from);
684 /* Read the ECC syndrom through the DiskOnChip ECC logic.
685 These syndrome will be all ZERO when there is no error */
686 for (i = 0; i < 6; i++)
687 syndrome[i] = ReadDOC(docptr, Mplus_ECCSyndrome0 + i);
689 nb_errors = doc_decode_ecc(buf, syndrome);
691 printk("ECC Errors corrected: %x\n", nb_errors);
694 /* We return error, but have actually done the read. Not that
695 this can be told to user-space, via sys_read(), but at least
696 MTD-aware stuff can know about it by checking *retlen */
698 printk("%s(%d): Millennium Plus ECC error (from=0x%x:\n",
699 __FILE__, __LINE__, (int)from);
700 printk(" syndrome= %02x:%02x:%02x:%02x:%02x:"
702 syndrome[0], syndrome[1], syndrome[2],
703 syndrome[3], syndrome[4], syndrome[5]);
704 printk(" eccbuf= %02x:%02x:%02x:%02x:%02x:"
706 eccbuf[0], eccbuf[1], eccbuf[2],
707 eccbuf[3], eccbuf[4], eccbuf[5]);
714 printk("ECC DATA at %lx: %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
715 (long)from, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
716 eccbuf[4], eccbuf[5]);
719 /* disable the ECC engine */
720 WriteDOC(DOC_ECC_DIS, docptr , Mplus_ECCConf);
722 /* Read the data via the internal pipeline through CDSN IO
723 register, see Pipelined Read Operations 11.3 */
724 MemReadDOC(docptr, buf, len-2);
725 buf[len-2] = ReadDOC(docptr, Mplus_LastDataRead);
726 buf[len-1] = ReadDOC(docptr, Mplus_LastDataRead);
729 /* Disable flash internally */
730 WriteDOC(0, docptr, Mplus_FlashSelect);
735 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
736 size_t *retlen, const u_char *buf)
739 return doc_write_ecc(mtd, to, len, retlen, buf, eccbuf, NULL);
742 static int doc_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
743 size_t *retlen, const u_char *buf, u_char *eccbuf,
744 struct nand_oobinfo *oobsel)
746 int i, before, ret = 0;
749 struct DiskOnChip *this = mtd->priv;
750 void __iomem * docptr = this->virtadr;
751 struct Nand *mychip = &this->chips[to >> (this->chipshift)];
753 /* Don't allow write past end of device */
754 if (to >= this->totlen)
757 /* Don't allow writes which aren't exactly one block (512 bytes) */
758 if ((to & 0x1ff) || (len != 0x200))
761 /* Determine position of OOB flags, before or after data */
762 before = (this->interleave && (to & 0x200));
764 DoC_CheckASIC(docptr);
766 /* Find the chip which is to be used and select it */
767 if (this->curfloor != mychip->floor) {
768 DoC_SelectFloor(docptr, mychip->floor);
769 DoC_SelectChip(docptr, mychip->chip);
770 } else if (this->curchip != mychip->chip) {
771 DoC_SelectChip(docptr, mychip->chip);
773 this->curfloor = mychip->floor;
774 this->curchip = mychip->chip;
776 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
777 WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
779 /* Reset the chip, see Software Requirement 11.4 item 1. */
780 DoC_Command(docptr, NAND_CMD_RESET, 0);
781 DoC_WaitReady(docptr);
783 /* Set device to appropriate plane of flash */
785 WriteDOC(DoC_GetDataOffset(mtd, &fto), docptr, Mplus_FlashCmd);
787 /* On interleaved devices the flags for 2nd half 512 are before data */
788 if (eccbuf && before)
791 /* issue the Serial Data In command to initial the Page Program process */
792 DoC_Command(docptr, NAND_CMD_SEQIN, 0x00);
793 DoC_Address(this, 3, fto, 0x00, 0x00);
795 /* Disable the ECC engine */
796 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
800 /* Write the block status BLOCK_USED (0x5555) */
801 WriteDOC(0x55, docptr, Mil_CDSN_IO);
802 WriteDOC(0x55, docptr, Mil_CDSN_IO);
805 /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
806 WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, Mplus_ECCConf);
809 MemWriteDOC(docptr, (unsigned char *) buf, len);
812 /* Write ECC data to flash, the ECC info is generated by
813 the DiskOnChip ECC logic see Reed-Solomon EDC/ECC 11.1 */
814 DoC_Delay(docptr, 3);
816 /* Read the ECC data through the DiskOnChip ECC logic */
817 for (i = 0; i < 6; i++)
818 eccbuf[i] = ReadDOC(docptr, Mplus_ECCSyndrome0 + i);
820 /* disable the ECC engine */
821 WriteDOC(DOC_ECC_DIS, docptr, Mplus_ECCConf);
823 /* Write the ECC data to flash */
824 MemWriteDOC(docptr, eccbuf, 6);
827 /* Write the block status BLOCK_USED (0x5555) */
828 WriteDOC(0x55, docptr, Mil_CDSN_IO+6);
829 WriteDOC(0x55, docptr, Mil_CDSN_IO+7);
833 printk("OOB data at %lx is %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
834 (long) to, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
835 eccbuf[4], eccbuf[5]);
839 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
840 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
842 /* Commit the Page Program command and wait for ready
843 see Software Requirement 11.4 item 1.*/
844 DoC_Command(docptr, NAND_CMD_PAGEPROG, 0x00);
845 DoC_WaitReady(docptr);
847 /* Read the status of the flash device through CDSN IO register
848 see Software Requirement 11.4 item 5.*/
849 DoC_Command(docptr, NAND_CMD_STATUS, 0);
850 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
851 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
852 DoC_Delay(docptr, 2);
853 if ((dummy = ReadDOC(docptr, Mplus_LastDataRead)) & 1) {
854 printk("MTD: Error 0x%x programming at 0x%x\n", dummy, (int)to);
855 /* Error in programming
856 FIXME: implement Bad Block Replacement (in nftl.c ??) */
860 dummy = ReadDOC(docptr, Mplus_LastDataRead);
862 /* Disable flash internally */
863 WriteDOC(0, docptr, Mplus_FlashSelect);
865 /* Let the caller know we completed it */
871 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs,
872 struct mtd_oob_ops *ops)
875 struct DiskOnChip *this = mtd->priv;
876 void __iomem * docptr = this->virtadr;
877 struct Nand *mychip = &this->chips[ofs >> this->chipshift];
878 size_t i, size, got, want;
879 uint8_t *buf = ops->oobbuf;
880 size_t len = ops->len;
882 BUG_ON(ops->mode != MTD_OOB_PLACE);
886 DoC_CheckASIC(docptr);
888 /* Find the chip which is to be used and select it */
889 if (this->curfloor != mychip->floor) {
890 DoC_SelectFloor(docptr, mychip->floor);
891 DoC_SelectChip(docptr, mychip->chip);
892 } else if (this->curchip != mychip->chip) {
893 DoC_SelectChip(docptr, mychip->chip);
895 this->curfloor = mychip->floor;
896 this->curchip = mychip->chip;
898 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
899 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
901 /* disable the ECC engine */
902 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
903 DoC_WaitReady(docptr);
905 /* Maximum of 16 bytes in the OOB region, so limit read to that */
911 for (i = 0; ((i < 3) && (want > 0)); i++) {
912 /* Figure out which region we are accessing... */
915 if (!this->interleave) {
916 DoC_Command(docptr, NAND_CMD_READOOB, 0);
918 } else if (base < 6) {
919 DoC_Command(docptr, DoC_GetECCOffset(mtd, &fofs), 0);
921 } else if (base < 8) {
922 DoC_Command(docptr, DoC_GetFlagsOffset(mtd, &fofs), 0);
925 DoC_Command(docptr, DoC_GetHdrOffset(mtd, &fofs), 0);
931 /* Issue read command */
932 DoC_Address(this, 3, fofs, 0, 0x00);
933 WriteDOC(0, docptr, Mplus_FlashControl);
934 DoC_WaitReady(docptr);
936 ReadDOC(docptr, Mplus_ReadPipeInit);
937 ReadDOC(docptr, Mplus_ReadPipeInit);
938 MemReadDOC(docptr, &buf[got], size - 2);
939 buf[got + size - 2] = ReadDOC(docptr, Mplus_LastDataRead);
940 buf[got + size - 1] = ReadDOC(docptr, Mplus_LastDataRead);
947 /* Disable flash internally */
948 WriteDOC(0, docptr, Mplus_FlashSelect);
954 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs,
955 struct mtd_oob_ops *ops)
959 struct DiskOnChip *this = mtd->priv;
960 void __iomem * docptr = this->virtadr;
961 struct Nand *mychip = &this->chips[ofs >> this->chipshift];
962 size_t i, size, got, want;
964 uint8_t *buf = ops->oobbuf;
965 size_t len = ops->len;
967 BUG_ON(ops->mode != MTD_OOB_PLACE);
971 DoC_CheckASIC(docptr);
973 /* Find the chip which is to be used and select it */
974 if (this->curfloor != mychip->floor) {
975 DoC_SelectFloor(docptr, mychip->floor);
976 DoC_SelectChip(docptr, mychip->chip);
977 } else if (this->curchip != mychip->chip) {
978 DoC_SelectChip(docptr, mychip->chip);
980 this->curfloor = mychip->floor;
981 this->curchip = mychip->chip;
983 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
984 WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
987 /* Maximum of 16 bytes in the OOB region, so limit write to that */
993 for (i = 0; ((i < 3) && (want > 0)); i++) {
994 /* Reset the chip, see Software Requirement 11.4 item 1. */
995 DoC_Command(docptr, NAND_CMD_RESET, 0);
996 DoC_WaitReady(docptr);
998 /* Figure out which region we are accessing... */
1001 if (!this->interleave) {
1002 WriteDOC(NAND_CMD_READOOB, docptr, Mplus_FlashCmd);
1004 } else if (base < 6) {
1005 WriteDOC(DoC_GetECCOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
1007 } else if (base < 8) {
1008 WriteDOC(DoC_GetFlagsOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
1011 WriteDOC(DoC_GetHdrOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
1017 /* Issue the Serial Data In command to initial the Page Program process */
1018 DoC_Command(docptr, NAND_CMD_SEQIN, 0x00);
1019 DoC_Address(this, 3, fofs, 0, 0x00);
1021 /* Disable the ECC engine */
1022 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
1024 /* Write the data via the internal pipeline through CDSN IO
1025 register, see Pipelined Write Operations 11.2 */
1026 MemWriteDOC(docptr, (unsigned char *) &buf[got], size);
1027 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
1028 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
1030 /* Commit the Page Program command and wait for ready
1031 see Software Requirement 11.4 item 1.*/
1032 DoC_Command(docptr, NAND_CMD_PAGEPROG, 0x00);
1033 DoC_WaitReady(docptr);
1035 /* Read the status of the flash device through CDSN IO register
1036 see Software Requirement 11.4 item 5.*/
1037 DoC_Command(docptr, NAND_CMD_STATUS, 0x00);
1038 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1039 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1040 DoC_Delay(docptr, 2);
1041 if ((dummy = ReadDOC(docptr, Mplus_LastDataRead)) & 1) {
1042 printk("MTD: Error 0x%x programming oob at 0x%x\n",
1044 /* FIXME: implement Bad Block Replacement */
1048 dummy = ReadDOC(docptr, Mplus_LastDataRead);
1055 /* Disable flash internally */
1056 WriteDOC(0, docptr, Mplus_FlashSelect);
1062 int doc_erase(struct mtd_info *mtd, struct erase_info *instr)
1064 volatile char dummy;
1065 struct DiskOnChip *this = mtd->priv;
1066 __u32 ofs = instr->addr;
1067 __u32 len = instr->len;
1068 void __iomem * docptr = this->virtadr;
1069 struct Nand *mychip = &this->chips[ofs >> this->chipshift];
1071 DoC_CheckASIC(docptr);
1073 if (len != mtd->erasesize)
1074 printk(KERN_WARNING "MTD: Erase not right size (%x != %x)n",
1075 len, mtd->erasesize);
1077 /* Find the chip which is to be used and select it */
1078 if (this->curfloor != mychip->floor) {
1079 DoC_SelectFloor(docptr, mychip->floor);
1080 DoC_SelectChip(docptr, mychip->chip);
1081 } else if (this->curchip != mychip->chip) {
1082 DoC_SelectChip(docptr, mychip->chip);
1084 this->curfloor = mychip->floor;
1085 this->curchip = mychip->chip;
1087 instr->state = MTD_ERASE_PENDING;
1089 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
1090 WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
1092 DoC_Command(docptr, NAND_CMD_RESET, 0x00);
1093 DoC_WaitReady(docptr);
1095 DoC_Command(docptr, NAND_CMD_ERASE1, 0);
1096 DoC_Address(this, 2, ofs, 0, 0x00);
1097 DoC_Command(docptr, NAND_CMD_ERASE2, 0);
1098 DoC_WaitReady(docptr);
1099 instr->state = MTD_ERASING;
1101 /* Read the status of the flash device through CDSN IO register
1102 see Software Requirement 11.4 item 5. */
1103 DoC_Command(docptr, NAND_CMD_STATUS, 0);
1104 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1105 dummy = ReadDOC(docptr, Mplus_ReadPipeInit);
1106 if ((dummy = ReadDOC(docptr, Mplus_LastDataRead)) & 1) {
1107 printk("MTD: Error 0x%x erasing at 0x%x\n", dummy, ofs);
1108 /* FIXME: implement Bad Block Replacement (in nftl.c ??) */
1109 instr->state = MTD_ERASE_FAILED;
1111 instr->state = MTD_ERASE_DONE;
1113 dummy = ReadDOC(docptr, Mplus_LastDataRead);
1115 /* Disable flash internally */
1116 WriteDOC(0, docptr, Mplus_FlashSelect);
1118 mtd_erase_callback(instr);
1123 /****************************************************************************
1127 ****************************************************************************/
1129 static void __exit cleanup_doc2001plus(void)
1131 struct mtd_info *mtd;
1132 struct DiskOnChip *this;
1134 while ((mtd=docmilpluslist)) {
1136 docmilpluslist = this->nextdoc;
1138 del_mtd_device(mtd);
1140 iounmap(this->virtadr);
1146 module_exit(cleanup_doc2001plus);
1148 MODULE_LICENSE("GPL");
1149 MODULE_AUTHOR("Greg Ungerer <gerg@snapgear.com> et al.");
1150 MODULE_DESCRIPTION("Driver for DiskOnChip Millennium Plus");