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, 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);
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;
488 mtd->owner = THIS_MODULE;
489 mtd->erase = doc_erase;
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;
505 /* Ident all the chips present. */
510 iounmap(this->virtadr);
512 this->nextdoc = docmilpluslist;
513 docmilpluslist = mtd;
514 mtd->size = this->totlen;
515 mtd->erasesize = this->erasesize;
520 EXPORT_SYMBOL_GPL(DoCMilPlus_init);
523 static int doc_dumpblk(struct mtd_info *mtd, loff_t from)
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];
535 /* Don't allow read past end of device */
536 if (from >= this->totlen)
539 DoC_CheckASIC(docptr);
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);
548 this->curfloor = mychip->floor;
549 this->curchip = mychip->chip;
551 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
552 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
554 /* Reset the chip, see Software Requirement 11.4 item 1. */
555 DoC_Command(docptr, NAND_CMD_RESET, 0);
556 DoC_WaitReady(docptr);
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);
564 /* disable the ECC engine */
565 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
567 ReadDOC(docptr, Mplus_ReadPipeInit);
568 ReadDOC(docptr, Mplus_ReadPipeInit);
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);
576 memset(&c[0], 0, sizeof(c));
577 printk("DUMP OFFSET=%x:\n", (int)from);
579 for (i = 0, bp = &buf[0]; (i < 1056); i++) {
582 printk(" %02x", *bp);
583 c[(i & 0xf)] = ((*bp >= 0x20) && (*bp <= 0x7f)) ? *bp : '.';
585 if (((i + 1) % 16) == 0)
590 /* Disable flash internally */
591 WriteDOC(0, docptr, Mplus_FlashSelect);
597 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
598 size_t *retlen, u_char *buf)
600 /* Just a special case of doc_read_ecc */
601 return doc_read_ecc(mtd, from, len, retlen, buf, NULL, NULL);
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)
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)];
616 /* Don't allow read past end of device */
617 if (from >= this->totlen)
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;
624 DoC_CheckASIC(docptr);
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);
633 this->curfloor = mychip->floor;
634 this->curchip = mychip->chip;
636 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
637 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
639 /* Reset the chip, see Software Requirement 11.4 item 1. */
640 DoC_Command(docptr, NAND_CMD_RESET, 0);
641 DoC_WaitReady(docptr);
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);
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);
654 /* disable the ECC engine */
655 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
658 /* Let the caller know we completed it */
662 ReadDOC(docptr, Mplus_ReadPipeInit);
663 ReadDOC(docptr, Mplus_ReadPipeInit);
666 /* Read the data via the internal pipeline through CDSN IO
667 register, see Pipelined Read Operations 11.3 */
668 MemReadDOC(docptr, buf, len);
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);
675 /* Flush the pipeline */
676 dummy = ReadDOC(docptr, Mplus_ECCConf);
677 dummy = ReadDOC(docptr, Mplus_ECCConf);
679 /* Check the ECC Status */
680 if (ReadDOC(docptr, Mplus_ECCConf) & 0x80) {
682 /* There was an ECC error */
684 printk("DiskOnChip ECC Error: Read at %lx\n", (long)from);
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);
691 nb_errors = doc_decode_ecc(buf, syndrome);
693 printk("ECC Errors corrected: %x\n", nb_errors);
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 */
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:"
704 syndrome[0], syndrome[1], syndrome[2],
705 syndrome[3], syndrome[4], syndrome[5]);
706 printk(" eccbuf= %02x:%02x:%02x:%02x:%02x:"
708 eccbuf[0], eccbuf[1], eccbuf[2],
709 eccbuf[3], eccbuf[4], eccbuf[5]);
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]);
721 /* disable the ECC engine */
722 WriteDOC(DOC_ECC_DIS, docptr , Mplus_ECCConf);
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);
731 /* Disable flash internally */
732 WriteDOC(0, docptr, Mplus_FlashSelect);
737 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
738 size_t *retlen, const u_char *buf)
741 return doc_write_ecc(mtd, to, len, retlen, buf, eccbuf, NULL);
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)
748 int i, before, ret = 0;
751 struct DiskOnChip *this = mtd->priv;
752 void __iomem * docptr = this->virtadr;
753 struct Nand *mychip = &this->chips[to >> (this->chipshift)];
755 /* Don't allow write past end of device */
756 if (to >= this->totlen)
759 /* Don't allow writes which aren't exactly one block (512 bytes) */
760 if ((to & 0x1ff) || (len != 0x200))
763 /* Determine position of OOB flags, before or after data */
764 before = (this->interleave && (to & 0x200));
766 DoC_CheckASIC(docptr);
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);
775 this->curfloor = mychip->floor;
776 this->curchip = mychip->chip;
778 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
779 WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
781 /* Reset the chip, see Software Requirement 11.4 item 1. */
782 DoC_Command(docptr, NAND_CMD_RESET, 0);
783 DoC_WaitReady(docptr);
785 /* Set device to appropriate plane of flash */
787 WriteDOC(DoC_GetDataOffset(mtd, &fto), docptr, Mplus_FlashCmd);
789 /* On interleaved devices the flags for 2nd half 512 are before data */
790 if (eccbuf && before)
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);
797 /* Disable the ECC engine */
798 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
802 /* Write the block status BLOCK_USED (0x5555) */
803 WriteDOC(0x55, docptr, Mil_CDSN_IO);
804 WriteDOC(0x55, docptr, Mil_CDSN_IO);
807 /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
808 WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, Mplus_ECCConf);
811 MemWriteDOC(docptr, (unsigned char *) buf, len);
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);
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);
822 /* disable the ECC engine */
823 WriteDOC(DOC_ECC_DIS, docptr, Mplus_ECCConf);
825 /* Write the ECC data to flash */
826 MemWriteDOC(docptr, eccbuf, 6);
829 /* Write the block status BLOCK_USED (0x5555) */
830 WriteDOC(0x55, docptr, Mil_CDSN_IO+6);
831 WriteDOC(0x55, docptr, Mil_CDSN_IO+7);
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]);
841 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
842 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
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);
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 ??) */
862 dummy = ReadDOC(docptr, Mplus_LastDataRead);
864 /* Disable flash internally */
865 WriteDOC(0, docptr, Mplus_FlashSelect);
867 /* Let the caller know we completed it */
873 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
874 size_t *retlen, u_char *buf)
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;
882 DoC_CheckASIC(docptr);
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);
891 this->curfloor = mychip->floor;
892 this->curchip = mychip->chip;
894 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
895 WriteDOC((DOC_FLASH_CE | DOC_FLASH_WP), docptr, Mplus_FlashSelect);
897 /* disable the ECC engine */
898 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
899 DoC_WaitReady(docptr);
901 /* Maximum of 16 bytes in the OOB region, so limit read to that */
907 for (i = 0; ((i < 3) && (want > 0)); i++) {
908 /* Figure out which region we are accessing... */
911 if (!this->interleave) {
912 DoC_Command(docptr, NAND_CMD_READOOB, 0);
914 } else if (base < 6) {
915 DoC_Command(docptr, DoC_GetECCOffset(mtd, &fofs), 0);
917 } else if (base < 8) {
918 DoC_Command(docptr, DoC_GetFlagsOffset(mtd, &fofs), 0);
921 DoC_Command(docptr, DoC_GetHdrOffset(mtd, &fofs), 0);
927 /* Issue read command */
928 DoC_Address(this, 3, fofs, 0, 0x00);
929 WriteDOC(0, docptr, Mplus_FlashControl);
930 DoC_WaitReady(docptr);
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);
943 /* Disable flash internally */
944 WriteDOC(0, docptr, Mplus_FlashSelect);
950 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs, size_t len,
951 size_t *retlen, const u_char *buf)
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;
961 DoC_CheckASIC(docptr);
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);
970 this->curfloor = mychip->floor;
971 this->curchip = mychip->chip;
973 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
974 WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
977 /* Maximum of 16 bytes in the OOB region, so limit write to that */
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);
988 /* Figure out which region we are accessing... */
991 if (!this->interleave) {
992 WriteDOC(NAND_CMD_READOOB, docptr, Mplus_FlashCmd);
994 } else if (base < 6) {
995 WriteDOC(DoC_GetECCOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
997 } else if (base < 8) {
998 WriteDOC(DoC_GetFlagsOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
1001 WriteDOC(DoC_GetHdrOffset(mtd, &fofs), docptr, Mplus_FlashCmd);
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);
1011 /* Disable the ECC engine */
1012 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
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);
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);
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",
1034 /* FIXME: implement Bad Block Replacement */
1038 dummy = ReadDOC(docptr, Mplus_LastDataRead);
1045 /* Disable flash internally */
1046 WriteDOC(0, docptr, Mplus_FlashSelect);
1052 int doc_erase(struct mtd_info *mtd, struct erase_info *instr)
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];
1061 DoC_CheckASIC(docptr);
1063 if (len != mtd->erasesize)
1064 printk(KERN_WARNING "MTD: Erase not right size (%x != %x)n",
1065 len, mtd->erasesize);
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);
1074 this->curfloor = mychip->floor;
1075 this->curchip = mychip->chip;
1077 instr->state = MTD_ERASE_PENDING;
1079 /* Millennium Plus bus cycle sequence as per figure 2, section 2.4 */
1080 WriteDOC(DOC_FLASH_CE, docptr, Mplus_FlashSelect);
1082 DoC_Command(docptr, NAND_CMD_RESET, 0x00);
1083 DoC_WaitReady(docptr);
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;
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;
1101 instr->state = MTD_ERASE_DONE;
1103 dummy = ReadDOC(docptr, Mplus_LastDataRead);
1105 /* Disable flash internally */
1106 WriteDOC(0, docptr, Mplus_FlashSelect);
1108 mtd_erase_callback(instr);
1113 /****************************************************************************
1117 ****************************************************************************/
1119 static void __exit cleanup_doc2001plus(void)
1121 struct mtd_info *mtd;
1122 struct DiskOnChip *this;
1124 while ((mtd=docmilpluslist)) {
1126 docmilpluslist = this->nextdoc;
1128 del_mtd_device(mtd);
1130 iounmap(this->virtadr);
1136 module_exit(cleanup_doc2001plus);
1138 MODULE_LICENSE("GPL");
1139 MODULE_AUTHOR("Greg Ungerer <gerg@snapgear.com> et al.");
1140 MODULE_DESCRIPTION("Driver for DiskOnChip Millennium Plus");