2 * drivers/mtd/nand/diskonchip.c
4 * (C) 2003 Red Hat, Inc.
5 * (C) 2004 Dan Brown <dan_brown@ieee.org>
6 * (C) 2004 Kalev Lember <kalev@smartlink.ee>
8 * Author: David Woodhouse <dwmw2@infradead.org>
9 * Additional Diskonchip 2000 and Millennium support by Dan Brown <dan_brown@ieee.org>
10 * Diskonchip Millennium Plus support by Kalev Lember <kalev@smartlink.ee>
12 * Error correction code lifted from the old docecc code
13 * Author: Fabrice Bellard (fabrice.bellard@netgem.com)
14 * Copyright (C) 2000 Netgem S.A.
15 * converted to the generic Reed-Solomon library by Thomas Gleixner <tglx@linutronix.de>
17 * Interface to generic NAND code for M-Systems DiskOnChip devices
19 * $Id: diskonchip.c,v 1.55 2005/11/07 11:14:30 gleixner Exp $
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/sched.h>
25 #include <linux/delay.h>
26 #include <linux/rslib.h>
27 #include <linux/moduleparam.h>
30 #include <linux/mtd/mtd.h>
31 #include <linux/mtd/nand.h>
32 #include <linux/mtd/doc2000.h>
33 #include <linux/mtd/compatmac.h>
34 #include <linux/mtd/partitions.h>
35 #include <linux/mtd/inftl.h>
37 /* Where to look for the devices? */
38 #ifndef CONFIG_MTD_NAND_DISKONCHIP_PROBE_ADDRESS
39 #define CONFIG_MTD_NAND_DISKONCHIP_PROBE_ADDRESS 0
42 static unsigned long __initdata doc_locations[] = {
43 #if defined (__alpha__) || defined(__i386__) || defined(__x86_64__)
44 #ifdef CONFIG_MTD_NAND_DISKONCHIP_PROBE_HIGH
45 0xfffc8000, 0xfffca000, 0xfffcc000, 0xfffce000,
46 0xfffd0000, 0xfffd2000, 0xfffd4000, 0xfffd6000,
47 0xfffd8000, 0xfffda000, 0xfffdc000, 0xfffde000,
48 0xfffe0000, 0xfffe2000, 0xfffe4000, 0xfffe6000,
49 0xfffe8000, 0xfffea000, 0xfffec000, 0xfffee000,
50 #else /* CONFIG_MTD_DOCPROBE_HIGH */
51 0xc8000, 0xca000, 0xcc000, 0xce000,
52 0xd0000, 0xd2000, 0xd4000, 0xd6000,
53 0xd8000, 0xda000, 0xdc000, 0xde000,
54 0xe0000, 0xe2000, 0xe4000, 0xe6000,
55 0xe8000, 0xea000, 0xec000, 0xee000,
56 #endif /* CONFIG_MTD_DOCPROBE_HIGH */
57 #elif defined(__PPC__)
59 #elif defined(CONFIG_MOMENCO_OCELOT)
63 #warning Unknown architecture for DiskOnChip. No default probe locations defined
67 static struct mtd_info *doclist = NULL;
70 void __iomem *virtadr;
71 unsigned long physadr;
74 int chips_per_floor; /* The number of chips detected on each floor */
79 struct mtd_info *nextdoc;
82 /* This is the syndrome computed by the HW ecc generator upon reading an empty
83 page, one with all 0xff for data and stored ecc code. */
84 static u_char empty_read_syndrome[6] = { 0x26, 0xff, 0x6d, 0x47, 0x73, 0x7a };
86 /* This is the ecc value computed by the HW ecc generator upon writing an empty
87 page, one with all 0xff for data. */
88 static u_char empty_write_ecc[6] = { 0x4b, 0x00, 0xe2, 0x0e, 0x93, 0xf7 };
90 #define INFTL_BBT_RESERVED_BLOCKS 4
92 #define DoC_is_MillenniumPlus(doc) ((doc)->ChipID == DOC_ChipID_DocMilPlus16 || (doc)->ChipID == DOC_ChipID_DocMilPlus32)
93 #define DoC_is_Millennium(doc) ((doc)->ChipID == DOC_ChipID_DocMil)
94 #define DoC_is_2000(doc) ((doc)->ChipID == DOC_ChipID_Doc2k)
96 static void doc200x_hwcontrol(struct mtd_info *mtd, int cmd,
97 unsigned int bitmask);
98 static void doc200x_select_chip(struct mtd_info *mtd, int chip);
100 static int debug = 0;
101 module_param(debug, int, 0);
103 static int try_dword = 1;
104 module_param(try_dword, int, 0);
106 static int no_ecc_failures = 0;
107 module_param(no_ecc_failures, int, 0);
109 static int no_autopart = 0;
110 module_param(no_autopart, int, 0);
112 static int show_firmware_partition = 0;
113 module_param(show_firmware_partition, int, 0);
115 #ifdef CONFIG_MTD_NAND_DISKONCHIP_BBTWRITE
116 static int inftl_bbt_write = 1;
118 static int inftl_bbt_write = 0;
120 module_param(inftl_bbt_write, int, 0);
122 static unsigned long doc_config_location = CONFIG_MTD_NAND_DISKONCHIP_PROBE_ADDRESS;
123 module_param(doc_config_location, ulong, 0);
124 MODULE_PARM_DESC(doc_config_location, "Physical memory address at which to probe for DiskOnChip");
126 /* Sector size for HW ECC */
127 #define SECTOR_SIZE 512
128 /* The sector bytes are packed into NB_DATA 10 bit words */
129 #define NB_DATA (((SECTOR_SIZE + 1) * 8 + 6) / 10)
130 /* Number of roots */
132 /* First consective root */
134 /* Number of symbols */
137 /* the Reed Solomon control structure */
138 static struct rs_control *rs_decoder;
141 * The HW decoder in the DoC ASIC's provides us a error syndrome,
142 * which we must convert to a standard syndrom usable by the generic
143 * Reed-Solomon library code.
145 * Fabrice Bellard figured this out in the old docecc code. I added
146 * some comments, improved a minor bit and converted it to make use
147 * of the generic Reed-Solomon libary. tglx
149 static int doc_ecc_decode(struct rs_control *rs, uint8_t *data, uint8_t *ecc)
151 int i, j, nerr, errpos[8];
153 uint16_t ds[4], s[5], tmp, errval[8], syn[4];
155 /* Convert the ecc bytes into words */
156 ds[0] = ((ecc[4] & 0xff) >> 0) | ((ecc[5] & 0x03) << 8);
157 ds[1] = ((ecc[5] & 0xfc) >> 2) | ((ecc[2] & 0x0f) << 6);
158 ds[2] = ((ecc[2] & 0xf0) >> 4) | ((ecc[3] & 0x3f) << 4);
159 ds[3] = ((ecc[3] & 0xc0) >> 6) | ((ecc[0] & 0xff) << 2);
162 /* Initialize the syndrom buffer */
163 for (i = 0; i < NROOTS; i++)
167 * s[i] = ds[3]x^3 + ds[2]x^2 + ds[1]x^1 + ds[0]
168 * where x = alpha^(FCR + i)
170 for (j = 1; j < NROOTS; j++) {
173 tmp = rs->index_of[ds[j]];
174 for (i = 0; i < NROOTS; i++)
175 s[i] ^= rs->alpha_to[rs_modnn(rs, tmp + (FCR + i) * j)];
178 /* Calc s[i] = s[i] / alpha^(v + i) */
179 for (i = 0; i < NROOTS; i++) {
181 syn[i] = rs_modnn(rs, rs->index_of[s[i]] + (NN - FCR - i));
183 /* Call the decoder library */
184 nerr = decode_rs16(rs, NULL, NULL, 1019, syn, 0, errpos, 0, errval);
186 /* Incorrectable errors ? */
191 * Correct the errors. The bitpositions are a bit of magic,
192 * but they are given by the design of the de/encoder circuit
195 for (i = 0; i < nerr; i++) {
196 int index, bitpos, pos = 1015 - errpos[i];
198 if (pos >= NB_DATA && pos < 1019)
201 /* extract bit position (MSB first) */
202 pos = 10 * (NB_DATA - 1 - pos) - 6;
203 /* now correct the following 10 bits. At most two bytes
204 can be modified since pos is even */
205 index = (pos >> 3) ^ 1;
207 if ((index >= 0 && index < SECTOR_SIZE) || index == (SECTOR_SIZE + 1)) {
208 val = (uint8_t) (errval[i] >> (2 + bitpos));
210 if (index < SECTOR_SIZE)
213 index = ((pos >> 3) + 1) ^ 1;
214 bitpos = (bitpos + 10) & 7;
217 if ((index >= 0 && index < SECTOR_SIZE) || index == (SECTOR_SIZE + 1)) {
218 val = (uint8_t) (errval[i] << (8 - bitpos));
220 if (index < SECTOR_SIZE)
225 /* If the parity is wrong, no rescue possible */
226 return parity ? -1 : nerr;
229 static void DoC_Delay(struct doc_priv *doc, unsigned short cycles)
234 for (i = 0; i < cycles; i++) {
235 if (DoC_is_Millennium(doc))
236 dummy = ReadDOC(doc->virtadr, NOP);
237 else if (DoC_is_MillenniumPlus(doc))
238 dummy = ReadDOC(doc->virtadr, Mplus_NOP);
240 dummy = ReadDOC(doc->virtadr, DOCStatus);
245 #define CDSN_CTRL_FR_B_MASK (CDSN_CTRL_FR_B0 | CDSN_CTRL_FR_B1)
247 /* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */
248 static int _DoC_WaitReady(struct doc_priv *doc)
250 void __iomem *docptr = doc->virtadr;
251 unsigned long timeo = jiffies + (HZ * 10);
254 printk("_DoC_WaitReady...\n");
255 /* Out-of-line routine to wait for chip response */
256 if (DoC_is_MillenniumPlus(doc)) {
257 while ((ReadDOC(docptr, Mplus_FlashControl) & CDSN_CTRL_FR_B_MASK) != CDSN_CTRL_FR_B_MASK) {
258 if (time_after(jiffies, timeo)) {
259 printk("_DoC_WaitReady timed out.\n");
266 while (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B)) {
267 if (time_after(jiffies, timeo)) {
268 printk("_DoC_WaitReady timed out.\n");
279 static inline int DoC_WaitReady(struct doc_priv *doc)
281 void __iomem *docptr = doc->virtadr;
284 if (DoC_is_MillenniumPlus(doc)) {
287 if ((ReadDOC(docptr, Mplus_FlashControl) & CDSN_CTRL_FR_B_MASK) != CDSN_CTRL_FR_B_MASK)
288 /* Call the out-of-line routine to wait */
289 ret = _DoC_WaitReady(doc);
293 if (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B))
294 /* Call the out-of-line routine to wait */
295 ret = _DoC_WaitReady(doc);
300 printk("DoC_WaitReady OK\n");
304 static void doc2000_write_byte(struct mtd_info *mtd, u_char datum)
306 struct nand_chip *this = mtd->priv;
307 struct doc_priv *doc = this->priv;
308 void __iomem *docptr = doc->virtadr;
311 printk("write_byte %02x\n", datum);
312 WriteDOC(datum, docptr, CDSNSlowIO);
313 WriteDOC(datum, docptr, 2k_CDSN_IO);
316 static u_char doc2000_read_byte(struct mtd_info *mtd)
318 struct nand_chip *this = mtd->priv;
319 struct doc_priv *doc = this->priv;
320 void __iomem *docptr = doc->virtadr;
323 ReadDOC(docptr, CDSNSlowIO);
325 ret = ReadDOC(docptr, 2k_CDSN_IO);
327 printk("read_byte returns %02x\n", ret);
331 static void doc2000_writebuf(struct mtd_info *mtd, const u_char *buf, int len)
333 struct nand_chip *this = mtd->priv;
334 struct doc_priv *doc = this->priv;
335 void __iomem *docptr = doc->virtadr;
338 printk("writebuf of %d bytes: ", len);
339 for (i = 0; i < len; i++) {
340 WriteDOC_(buf[i], docptr, DoC_2k_CDSN_IO + i);
342 printk("%02x ", buf[i]);
348 static void doc2000_readbuf(struct mtd_info *mtd, u_char *buf, int len)
350 struct nand_chip *this = mtd->priv;
351 struct doc_priv *doc = this->priv;
352 void __iomem *docptr = doc->virtadr;
356 printk("readbuf of %d bytes: ", len);
358 for (i = 0; i < len; i++) {
359 buf[i] = ReadDOC(docptr, 2k_CDSN_IO + i);
363 static void doc2000_readbuf_dword(struct mtd_info *mtd, u_char *buf, int len)
365 struct nand_chip *this = mtd->priv;
366 struct doc_priv *doc = this->priv;
367 void __iomem *docptr = doc->virtadr;
371 printk("readbuf_dword of %d bytes: ", len);
373 if (unlikely((((unsigned long)buf) | len) & 3)) {
374 for (i = 0; i < len; i++) {
375 *(uint8_t *) (&buf[i]) = ReadDOC(docptr, 2k_CDSN_IO + i);
378 for (i = 0; i < len; i += 4) {
379 *(uint32_t *) (&buf[i]) = readl(docptr + DoC_2k_CDSN_IO + i);
384 static int doc2000_verifybuf(struct mtd_info *mtd, const u_char *buf, int len)
386 struct nand_chip *this = mtd->priv;
387 struct doc_priv *doc = this->priv;
388 void __iomem *docptr = doc->virtadr;
391 for (i = 0; i < len; i++)
392 if (buf[i] != ReadDOC(docptr, 2k_CDSN_IO))
397 static uint16_t __init doc200x_ident_chip(struct mtd_info *mtd, int nr)
399 struct nand_chip *this = mtd->priv;
400 struct doc_priv *doc = this->priv;
403 doc200x_select_chip(mtd, nr);
404 doc200x_hwcontrol(mtd, NAND_CMD_READID,
405 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
406 doc200x_hwcontrol(mtd, 0, NAND_CTRL_ALE | NAND_CTRL_CHANGE);
407 doc200x_hwcontrol(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
409 /* We cant' use dev_ready here, but at least we wait for the
410 * command to complete
414 ret = this->read_byte(mtd) << 8;
415 ret |= this->read_byte(mtd);
417 if (doc->ChipID == DOC_ChipID_Doc2k && try_dword && !nr) {
418 /* First chip probe. See if we get same results by 32-bit access */
423 void __iomem *docptr = doc->virtadr;
425 doc200x_hwcontrol(mtd, NAND_CMD_READID,
426 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
427 doc200x_hwcontrol(mtd, 0, NAND_CTRL_ALE | NAND_CTRL_CHANGE);
428 doc200x_hwcontrol(mtd, NAND_CMD_NONE,
429 NAND_NCE | NAND_CTRL_CHANGE);
433 ident.dword = readl(docptr + DoC_2k_CDSN_IO);
434 if (((ident.byte[0] << 8) | ident.byte[1]) == ret) {
435 printk(KERN_INFO "DiskOnChip 2000 responds to DWORD access\n");
436 this->read_buf = &doc2000_readbuf_dword;
443 static void __init doc2000_count_chips(struct mtd_info *mtd)
445 struct nand_chip *this = mtd->priv;
446 struct doc_priv *doc = this->priv;
450 /* Max 4 chips per floor on DiskOnChip 2000 */
451 doc->chips_per_floor = 4;
453 /* Find out what the first chip is */
454 mfrid = doc200x_ident_chip(mtd, 0);
456 /* Find how many chips in each floor. */
457 for (i = 1; i < 4; i++) {
458 if (doc200x_ident_chip(mtd, i) != mfrid)
461 doc->chips_per_floor = i;
462 printk(KERN_DEBUG "Detected %d chips per floor.\n", i);
465 static int doc200x_wait(struct mtd_info *mtd, struct nand_chip *this)
467 struct doc_priv *doc = this->priv;
472 this->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
474 status = (int)this->read_byte(mtd);
479 static void doc2001_write_byte(struct mtd_info *mtd, u_char datum)
481 struct nand_chip *this = mtd->priv;
482 struct doc_priv *doc = this->priv;
483 void __iomem *docptr = doc->virtadr;
485 WriteDOC(datum, docptr, CDSNSlowIO);
486 WriteDOC(datum, docptr, Mil_CDSN_IO);
487 WriteDOC(datum, docptr, WritePipeTerm);
490 static u_char doc2001_read_byte(struct mtd_info *mtd)
492 struct nand_chip *this = mtd->priv;
493 struct doc_priv *doc = this->priv;
494 void __iomem *docptr = doc->virtadr;
496 //ReadDOC(docptr, CDSNSlowIO);
497 /* 11.4.5 -- delay twice to allow extended length cycle */
499 ReadDOC(docptr, ReadPipeInit);
500 //return ReadDOC(docptr, Mil_CDSN_IO);
501 return ReadDOC(docptr, LastDataRead);
504 static void doc2001_writebuf(struct mtd_info *mtd, const u_char *buf, int len)
506 struct nand_chip *this = mtd->priv;
507 struct doc_priv *doc = this->priv;
508 void __iomem *docptr = doc->virtadr;
511 for (i = 0; i < len; i++)
512 WriteDOC_(buf[i], docptr, DoC_Mil_CDSN_IO + i);
513 /* Terminate write pipeline */
514 WriteDOC(0x00, docptr, WritePipeTerm);
517 static void doc2001_readbuf(struct mtd_info *mtd, u_char *buf, int len)
519 struct nand_chip *this = mtd->priv;
520 struct doc_priv *doc = this->priv;
521 void __iomem *docptr = doc->virtadr;
524 /* Start read pipeline */
525 ReadDOC(docptr, ReadPipeInit);
527 for (i = 0; i < len - 1; i++)
528 buf[i] = ReadDOC(docptr, Mil_CDSN_IO + (i & 0xff));
530 /* Terminate read pipeline */
531 buf[i] = ReadDOC(docptr, LastDataRead);
534 static int doc2001_verifybuf(struct mtd_info *mtd, const u_char *buf, int len)
536 struct nand_chip *this = mtd->priv;
537 struct doc_priv *doc = this->priv;
538 void __iomem *docptr = doc->virtadr;
541 /* Start read pipeline */
542 ReadDOC(docptr, ReadPipeInit);
544 for (i = 0; i < len - 1; i++)
545 if (buf[i] != ReadDOC(docptr, Mil_CDSN_IO)) {
546 ReadDOC(docptr, LastDataRead);
549 if (buf[i] != ReadDOC(docptr, LastDataRead))
554 static u_char doc2001plus_read_byte(struct mtd_info *mtd)
556 struct nand_chip *this = mtd->priv;
557 struct doc_priv *doc = this->priv;
558 void __iomem *docptr = doc->virtadr;
561 ReadDOC(docptr, Mplus_ReadPipeInit);
562 ReadDOC(docptr, Mplus_ReadPipeInit);
563 ret = ReadDOC(docptr, Mplus_LastDataRead);
565 printk("read_byte returns %02x\n", ret);
569 static void doc2001plus_writebuf(struct mtd_info *mtd, const u_char *buf, int len)
571 struct nand_chip *this = mtd->priv;
572 struct doc_priv *doc = this->priv;
573 void __iomem *docptr = doc->virtadr;
577 printk("writebuf of %d bytes: ", len);
578 for (i = 0; i < len; i++) {
579 WriteDOC_(buf[i], docptr, DoC_Mil_CDSN_IO + i);
581 printk("%02x ", buf[i]);
587 static void doc2001plus_readbuf(struct mtd_info *mtd, u_char *buf, int len)
589 struct nand_chip *this = mtd->priv;
590 struct doc_priv *doc = this->priv;
591 void __iomem *docptr = doc->virtadr;
595 printk("readbuf of %d bytes: ", len);
597 /* Start read pipeline */
598 ReadDOC(docptr, Mplus_ReadPipeInit);
599 ReadDOC(docptr, Mplus_ReadPipeInit);
601 for (i = 0; i < len - 2; i++) {
602 buf[i] = ReadDOC(docptr, Mil_CDSN_IO);
604 printk("%02x ", buf[i]);
607 /* Terminate read pipeline */
608 buf[len - 2] = ReadDOC(docptr, Mplus_LastDataRead);
610 printk("%02x ", buf[len - 2]);
611 buf[len - 1] = ReadDOC(docptr, Mplus_LastDataRead);
613 printk("%02x ", buf[len - 1]);
618 static int doc2001plus_verifybuf(struct mtd_info *mtd, const u_char *buf, int len)
620 struct nand_chip *this = mtd->priv;
621 struct doc_priv *doc = this->priv;
622 void __iomem *docptr = doc->virtadr;
626 printk("verifybuf of %d bytes: ", len);
628 /* Start read pipeline */
629 ReadDOC(docptr, Mplus_ReadPipeInit);
630 ReadDOC(docptr, Mplus_ReadPipeInit);
632 for (i = 0; i < len - 2; i++)
633 if (buf[i] != ReadDOC(docptr, Mil_CDSN_IO)) {
634 ReadDOC(docptr, Mplus_LastDataRead);
635 ReadDOC(docptr, Mplus_LastDataRead);
638 if (buf[len - 2] != ReadDOC(docptr, Mplus_LastDataRead))
640 if (buf[len - 1] != ReadDOC(docptr, Mplus_LastDataRead))
645 static void doc2001plus_select_chip(struct mtd_info *mtd, int chip)
647 struct nand_chip *this = mtd->priv;
648 struct doc_priv *doc = this->priv;
649 void __iomem *docptr = doc->virtadr;
653 printk("select chip (%d)\n", chip);
656 /* Disable flash internally */
657 WriteDOC(0, docptr, Mplus_FlashSelect);
661 floor = chip / doc->chips_per_floor;
662 chip -= (floor * doc->chips_per_floor);
664 /* Assert ChipEnable and deassert WriteProtect */
665 WriteDOC((DOC_FLASH_CE), docptr, Mplus_FlashSelect);
666 this->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
669 doc->curfloor = floor;
672 static void doc200x_select_chip(struct mtd_info *mtd, int chip)
674 struct nand_chip *this = mtd->priv;
675 struct doc_priv *doc = this->priv;
676 void __iomem *docptr = doc->virtadr;
680 printk("select chip (%d)\n", chip);
685 floor = chip / doc->chips_per_floor;
686 chip -= (floor * doc->chips_per_floor);
688 /* 11.4.4 -- deassert CE before changing chip */
689 doc200x_hwcontrol(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
691 WriteDOC(floor, docptr, FloorSelect);
692 WriteDOC(chip, docptr, CDSNDeviceSelect);
694 doc200x_hwcontrol(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
697 doc->curfloor = floor;
700 #define CDSN_CTRL_MSK (CDSN_CTRL_CE | CDSN_CTRL_CLE | CDSN_CTRL_ALE)
702 static void doc200x_hwcontrol(struct mtd_info *mtd, int cmd,
705 struct nand_chip *this = mtd->priv;
706 struct doc_priv *doc = this->priv;
707 void __iomem *docptr = doc->virtadr;
709 if (ctrl & NAND_CTRL_CHANGE) {
710 doc->CDSNControl &= ~CDSN_CTRL_MSK;
711 doc->CDSNControl |= ctrl & CDSN_CTRL_MSK;
713 printk("hwcontrol(%d): %02x\n", cmd, doc->CDSNControl);
714 WriteDOC(doc->CDSNControl, docptr, CDSNControl);
715 /* 11.4.3 -- 4 NOPs after CSDNControl write */
718 if (cmd != NAND_CMD_NONE) {
719 if (DoC_is_2000(doc))
720 doc2000_write_byte(mtd, cmd);
722 doc2001_write_byte(mtd, cmd);
726 static void doc2001plus_command(struct mtd_info *mtd, unsigned command, int column, int page_addr)
728 struct nand_chip *this = mtd->priv;
729 struct doc_priv *doc = this->priv;
730 void __iomem *docptr = doc->virtadr;
733 * Must terminate write pipeline before sending any commands
736 if (command == NAND_CMD_PAGEPROG) {
737 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
738 WriteDOC(0x00, docptr, Mplus_WritePipeTerm);
742 * Write out the command to the device.
744 if (command == NAND_CMD_SEQIN) {
747 if (column >= mtd->writesize) {
749 column -= mtd->writesize;
750 readcmd = NAND_CMD_READOOB;
751 } else if (column < 256) {
752 /* First 256 bytes --> READ0 */
753 readcmd = NAND_CMD_READ0;
756 readcmd = NAND_CMD_READ1;
758 WriteDOC(readcmd, docptr, Mplus_FlashCmd);
760 WriteDOC(command, docptr, Mplus_FlashCmd);
761 WriteDOC(0, docptr, Mplus_WritePipeTerm);
762 WriteDOC(0, docptr, Mplus_WritePipeTerm);
764 if (column != -1 || page_addr != -1) {
765 /* Serially input address */
767 /* Adjust columns for 16 bit buswidth */
768 if (this->options & NAND_BUSWIDTH_16)
770 WriteDOC(column, docptr, Mplus_FlashAddress);
772 if (page_addr != -1) {
773 WriteDOC((unsigned char)(page_addr & 0xff), docptr, Mplus_FlashAddress);
774 WriteDOC((unsigned char)((page_addr >> 8) & 0xff), docptr, Mplus_FlashAddress);
775 /* One more address cycle for higher density devices */
776 if (this->chipsize & 0x0c000000) {
777 WriteDOC((unsigned char)((page_addr >> 16) & 0x0f), docptr, Mplus_FlashAddress);
778 printk("high density\n");
781 WriteDOC(0, docptr, Mplus_WritePipeTerm);
782 WriteDOC(0, docptr, Mplus_WritePipeTerm);
784 if (command == NAND_CMD_READ0 || command == NAND_CMD_READ1 ||
785 command == NAND_CMD_READOOB || command == NAND_CMD_READID)
786 WriteDOC(0, docptr, Mplus_FlashControl);
790 * program and erase have their own busy handlers
791 * status and sequential in needs no delay
795 case NAND_CMD_PAGEPROG:
796 case NAND_CMD_ERASE1:
797 case NAND_CMD_ERASE2:
799 case NAND_CMD_STATUS:
805 udelay(this->chip_delay);
806 WriteDOC(NAND_CMD_STATUS, docptr, Mplus_FlashCmd);
807 WriteDOC(0, docptr, Mplus_WritePipeTerm);
808 WriteDOC(0, docptr, Mplus_WritePipeTerm);
809 while (!(this->read_byte(mtd) & 0x40)) ;
812 /* This applies to read commands */
815 * If we don't have access to the busy pin, we apply the given
818 if (!this->dev_ready) {
819 udelay(this->chip_delay);
824 /* Apply this short delay always to ensure that we do wait tWB in
825 * any case on any machine. */
827 /* wait until command is processed */
828 while (!this->dev_ready(mtd)) ;
831 static int doc200x_dev_ready(struct mtd_info *mtd)
833 struct nand_chip *this = mtd->priv;
834 struct doc_priv *doc = this->priv;
835 void __iomem *docptr = doc->virtadr;
837 if (DoC_is_MillenniumPlus(doc)) {
838 /* 11.4.2 -- must NOP four times before checking FR/B# */
840 if ((ReadDOC(docptr, Mplus_FlashControl) & CDSN_CTRL_FR_B_MASK) != CDSN_CTRL_FR_B_MASK) {
842 printk("not ready\n");
846 printk("was ready\n");
849 /* 11.4.2 -- must NOP four times before checking FR/B# */
851 if (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B)) {
853 printk("not ready\n");
856 /* 11.4.2 -- Must NOP twice if it's ready */
859 printk("was ready\n");
864 static int doc200x_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
866 /* This is our last resort if we couldn't find or create a BBT. Just
867 pretend all blocks are good. */
871 static void doc200x_enable_hwecc(struct mtd_info *mtd, int mode)
873 struct nand_chip *this = mtd->priv;
874 struct doc_priv *doc = this->priv;
875 void __iomem *docptr = doc->virtadr;
877 /* Prime the ECC engine */
880 WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
881 WriteDOC(DOC_ECC_EN, docptr, ECCConf);
884 WriteDOC(DOC_ECC_RESET, docptr, ECCConf);
885 WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, ECCConf);
890 static void doc2001plus_enable_hwecc(struct mtd_info *mtd, int mode)
892 struct nand_chip *this = mtd->priv;
893 struct doc_priv *doc = this->priv;
894 void __iomem *docptr = doc->virtadr;
896 /* Prime the ECC engine */
899 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
900 WriteDOC(DOC_ECC_EN, docptr, Mplus_ECCConf);
903 WriteDOC(DOC_ECC_RESET, docptr, Mplus_ECCConf);
904 WriteDOC(DOC_ECC_EN | DOC_ECC_RW, docptr, Mplus_ECCConf);
909 /* This code is only called on write */
910 static int doc200x_calculate_ecc(struct mtd_info *mtd, const u_char *dat, unsigned char *ecc_code)
912 struct nand_chip *this = mtd->priv;
913 struct doc_priv *doc = this->priv;
914 void __iomem *docptr = doc->virtadr;
918 /* flush the pipeline */
919 if (DoC_is_2000(doc)) {
920 WriteDOC(doc->CDSNControl & ~CDSN_CTRL_FLASH_IO, docptr, CDSNControl);
921 WriteDOC(0, docptr, 2k_CDSN_IO);
922 WriteDOC(0, docptr, 2k_CDSN_IO);
923 WriteDOC(0, docptr, 2k_CDSN_IO);
924 WriteDOC(doc->CDSNControl, docptr, CDSNControl);
925 } else if (DoC_is_MillenniumPlus(doc)) {
926 WriteDOC(0, docptr, Mplus_NOP);
927 WriteDOC(0, docptr, Mplus_NOP);
928 WriteDOC(0, docptr, Mplus_NOP);
930 WriteDOC(0, docptr, NOP);
931 WriteDOC(0, docptr, NOP);
932 WriteDOC(0, docptr, NOP);
935 for (i = 0; i < 6; i++) {
936 if (DoC_is_MillenniumPlus(doc))
937 ecc_code[i] = ReadDOC_(docptr, DoC_Mplus_ECCSyndrome0 + i);
939 ecc_code[i] = ReadDOC_(docptr, DoC_ECCSyndrome0 + i);
940 if (ecc_code[i] != empty_write_ecc[i])
943 if (DoC_is_MillenniumPlus(doc))
944 WriteDOC(DOC_ECC_DIS, docptr, Mplus_ECCConf);
946 WriteDOC(DOC_ECC_DIS, docptr, ECCConf);
948 /* If emptymatch=1, we might have an all-0xff data buffer. Check. */
950 /* Note: this somewhat expensive test should not be triggered
951 often. It could be optimized away by examining the data in
952 the writebuf routine, and remembering the result. */
953 for (i = 0; i < 512; i++) {
960 /* If emptymatch still =1, we do have an all-0xff data buffer.
961 Return all-0xff ecc value instead of the computed one, so
962 it'll look just like a freshly-erased page. */
964 memset(ecc_code, 0xff, 6);
969 static int doc200x_correct_data(struct mtd_info *mtd, u_char *dat,
970 u_char *read_ecc, u_char *isnull)
973 struct nand_chip *this = mtd->priv;
974 struct doc_priv *doc = this->priv;
975 void __iomem *docptr = doc->virtadr;
977 volatile u_char dummy;
980 /* flush the pipeline */
981 if (DoC_is_2000(doc)) {
982 dummy = ReadDOC(docptr, 2k_ECCStatus);
983 dummy = ReadDOC(docptr, 2k_ECCStatus);
984 dummy = ReadDOC(docptr, 2k_ECCStatus);
985 } else if (DoC_is_MillenniumPlus(doc)) {
986 dummy = ReadDOC(docptr, Mplus_ECCConf);
987 dummy = ReadDOC(docptr, Mplus_ECCConf);
988 dummy = ReadDOC(docptr, Mplus_ECCConf);
990 dummy = ReadDOC(docptr, ECCConf);
991 dummy = ReadDOC(docptr, ECCConf);
992 dummy = ReadDOC(docptr, ECCConf);
995 /* Error occured ? */
997 for (i = 0; i < 6; i++) {
998 if (DoC_is_MillenniumPlus(doc))
999 calc_ecc[i] = ReadDOC_(docptr, DoC_Mplus_ECCSyndrome0 + i);
1001 calc_ecc[i] = ReadDOC_(docptr, DoC_ECCSyndrome0 + i);
1002 if (calc_ecc[i] != empty_read_syndrome[i])
1005 /* If emptymatch=1, the read syndrome is consistent with an
1006 all-0xff data and stored ecc block. Check the stored ecc. */
1008 for (i = 0; i < 6; i++) {
1009 if (read_ecc[i] == 0xff)
1015 /* If emptymatch still =1, check the data block. */
1017 /* Note: this somewhat expensive test should not be triggered
1018 often. It could be optimized away by examining the data in
1019 the readbuf routine, and remembering the result. */
1020 for (i = 0; i < 512; i++) {
1027 /* If emptymatch still =1, this is almost certainly a freshly-
1028 erased block, in which case the ECC will not come out right.
1029 We'll suppress the error and tell the caller everything's
1030 OK. Because it is. */
1032 ret = doc_ecc_decode(rs_decoder, dat, calc_ecc);
1034 printk(KERN_ERR "doc200x_correct_data corrected %d errors\n", ret);
1036 if (DoC_is_MillenniumPlus(doc))
1037 WriteDOC(DOC_ECC_DIS, docptr, Mplus_ECCConf);
1039 WriteDOC(DOC_ECC_DIS, docptr, ECCConf);
1040 if (no_ecc_failures && (ret == -1)) {
1041 printk(KERN_ERR "suppressing ECC failure\n");
1047 //u_char mydatabuf[528];
1049 /* The strange out-of-order .oobfree list below is a (possibly unneeded)
1050 * attempt to retain compatibility. It used to read:
1051 * .oobfree = { {8, 8} }
1052 * Since that leaves two bytes unusable, it was changed. But the following
1053 * scheme might affect existing jffs2 installs by moving the cleanmarker:
1054 * .oobfree = { {6, 10} }
1055 * jffs2 seems to handle the above gracefully, but the current scheme seems
1056 * safer. The only problem with it is that any code that parses oobfree must
1057 * be able to handle out-of-order segments.
1059 static struct nand_ecclayout doc200x_oobinfo = {
1061 .eccpos = {0, 1, 2, 3, 4, 5},
1062 .oobfree = {{8, 8}, {6, 2}}
1065 /* Find the (I)NFTL Media Header, and optionally also the mirror media header.
1066 On sucessful return, buf will contain a copy of the media header for
1067 further processing. id is the string to scan for, and will presumably be
1068 either "ANAND" or "BNAND". If findmirror=1, also look for the mirror media
1069 header. The page #s of the found media headers are placed in mh0_page and
1070 mh1_page in the DOC private structure. */
1071 static int __init find_media_headers(struct mtd_info *mtd, u_char *buf, const char *id, int findmirror)
1073 struct nand_chip *this = mtd->priv;
1074 struct doc_priv *doc = this->priv;
1079 for (offs = 0; offs < mtd->size; offs += mtd->erasesize) {
1080 ret = mtd->read(mtd, offs, mtd->writesize, &retlen, buf);
1081 if (retlen != mtd->writesize)
1084 printk(KERN_WARNING "ECC error scanning DOC at 0x%x\n", offs);
1086 if (memcmp(buf, id, 6))
1088 printk(KERN_INFO "Found DiskOnChip %s Media Header at 0x%x\n", id, offs);
1089 if (doc->mh0_page == -1) {
1090 doc->mh0_page = offs >> this->page_shift;
1095 doc->mh1_page = offs >> this->page_shift;
1098 if (doc->mh0_page == -1) {
1099 printk(KERN_WARNING "DiskOnChip %s Media Header not found.\n", id);
1102 /* Only one mediaheader was found. We want buf to contain a
1103 mediaheader on return, so we'll have to re-read the one we found. */
1104 offs = doc->mh0_page << this->page_shift;
1105 ret = mtd->read(mtd, offs, mtd->writesize, &retlen, buf);
1106 if (retlen != mtd->writesize) {
1107 /* Insanity. Give up. */
1108 printk(KERN_ERR "Read DiskOnChip Media Header once, but can't reread it???\n");
1114 static inline int __init nftl_partscan(struct mtd_info *mtd, struct mtd_partition *parts)
1116 struct nand_chip *this = mtd->priv;
1117 struct doc_priv *doc = this->priv;
1120 struct NFTLMediaHeader *mh;
1121 const unsigned psize = 1 << this->page_shift;
1123 unsigned blocks, maxblocks;
1124 int offs, numheaders;
1126 buf = kmalloc(mtd->writesize, GFP_KERNEL);
1128 printk(KERN_ERR "DiskOnChip mediaheader kmalloc failed!\n");
1131 if (!(numheaders = find_media_headers(mtd, buf, "ANAND", 1)))
1133 mh = (struct NFTLMediaHeader *)buf;
1135 mh->NumEraseUnits = le16_to_cpu(mh->NumEraseUnits);
1136 mh->FirstPhysicalEUN = le16_to_cpu(mh->FirstPhysicalEUN);
1137 mh->FormattedSize = le32_to_cpu(mh->FormattedSize);
1139 printk(KERN_INFO " DataOrgID = %s\n"
1140 " NumEraseUnits = %d\n"
1141 " FirstPhysicalEUN = %d\n"
1142 " FormattedSize = %d\n"
1143 " UnitSizeFactor = %d\n",
1144 mh->DataOrgID, mh->NumEraseUnits,
1145 mh->FirstPhysicalEUN, mh->FormattedSize,
1146 mh->UnitSizeFactor);
1148 blocks = mtd->size >> this->phys_erase_shift;
1149 maxblocks = min(32768U, mtd->erasesize - psize);
1151 if (mh->UnitSizeFactor == 0x00) {
1152 /* Auto-determine UnitSizeFactor. The constraints are:
1153 - There can be at most 32768 virtual blocks.
1154 - There can be at most (virtual block size - page size)
1155 virtual blocks (because MediaHeader+BBT must fit in 1).
1157 mh->UnitSizeFactor = 0xff;
1158 while (blocks > maxblocks) {
1160 maxblocks = min(32768U, (maxblocks << 1) + psize);
1161 mh->UnitSizeFactor--;
1163 printk(KERN_WARNING "UnitSizeFactor=0x00 detected. Correct value is assumed to be 0x%02x.\n", mh->UnitSizeFactor);
1166 /* NOTE: The lines below modify internal variables of the NAND and MTD
1167 layers; variables with have already been configured by nand_scan.
1168 Unfortunately, we didn't know before this point what these values
1169 should be. Thus, this code is somewhat dependant on the exact
1170 implementation of the NAND layer. */
1171 if (mh->UnitSizeFactor != 0xff) {
1172 this->bbt_erase_shift += (0xff - mh->UnitSizeFactor);
1173 mtd->erasesize <<= (0xff - mh->UnitSizeFactor);
1174 printk(KERN_INFO "Setting virtual erase size to %d\n", mtd->erasesize);
1175 blocks = mtd->size >> this->bbt_erase_shift;
1176 maxblocks = min(32768U, mtd->erasesize - psize);
1179 if (blocks > maxblocks) {
1180 printk(KERN_ERR "UnitSizeFactor of 0x%02x is inconsistent with device size. Aborting.\n", mh->UnitSizeFactor);
1184 /* Skip past the media headers. */
1185 offs = max(doc->mh0_page, doc->mh1_page);
1186 offs <<= this->page_shift;
1187 offs += mtd->erasesize;
1189 if (show_firmware_partition == 1) {
1190 parts[0].name = " DiskOnChip Firmware / Media Header partition";
1191 parts[0].offset = 0;
1192 parts[0].size = offs;
1196 parts[numparts].name = " DiskOnChip BDTL partition";
1197 parts[numparts].offset = offs;
1198 parts[numparts].size = (mh->NumEraseUnits - numheaders) << this->bbt_erase_shift;
1200 offs += parts[numparts].size;
1203 if (offs < mtd->size) {
1204 parts[numparts].name = " DiskOnChip Remainder partition";
1205 parts[numparts].offset = offs;
1206 parts[numparts].size = mtd->size - offs;
1216 /* This is a stripped-down copy of the code in inftlmount.c */
1217 static inline int __init inftl_partscan(struct mtd_info *mtd, struct mtd_partition *parts)
1219 struct nand_chip *this = mtd->priv;
1220 struct doc_priv *doc = this->priv;
1223 struct INFTLMediaHeader *mh;
1224 struct INFTLPartition *ip;
1227 int vshift, lastvunit = 0;
1229 int end = mtd->size;
1231 if (inftl_bbt_write)
1232 end -= (INFTL_BBT_RESERVED_BLOCKS << this->phys_erase_shift);
1234 buf = kmalloc(mtd->writesize, GFP_KERNEL);
1236 printk(KERN_ERR "DiskOnChip mediaheader kmalloc failed!\n");
1240 if (!find_media_headers(mtd, buf, "BNAND", 0))
1242 doc->mh1_page = doc->mh0_page + (4096 >> this->page_shift);
1243 mh = (struct INFTLMediaHeader *)buf;
1245 mh->NoOfBootImageBlocks = le32_to_cpu(mh->NoOfBootImageBlocks);
1246 mh->NoOfBinaryPartitions = le32_to_cpu(mh->NoOfBinaryPartitions);
1247 mh->NoOfBDTLPartitions = le32_to_cpu(mh->NoOfBDTLPartitions);
1248 mh->BlockMultiplierBits = le32_to_cpu(mh->BlockMultiplierBits);
1249 mh->FormatFlags = le32_to_cpu(mh->FormatFlags);
1250 mh->PercentUsed = le32_to_cpu(mh->PercentUsed);
1252 printk(KERN_INFO " bootRecordID = %s\n"
1253 " NoOfBootImageBlocks = %d\n"
1254 " NoOfBinaryPartitions = %d\n"
1255 " NoOfBDTLPartitions = %d\n"
1256 " BlockMultiplerBits = %d\n"
1257 " FormatFlgs = %d\n"
1258 " OsakVersion = %d.%d.%d.%d\n"
1259 " PercentUsed = %d\n",
1260 mh->bootRecordID, mh->NoOfBootImageBlocks,
1261 mh->NoOfBinaryPartitions,
1262 mh->NoOfBDTLPartitions,
1263 mh->BlockMultiplierBits, mh->FormatFlags,
1264 ((unsigned char *) &mh->OsakVersion)[0] & 0xf,
1265 ((unsigned char *) &mh->OsakVersion)[1] & 0xf,
1266 ((unsigned char *) &mh->OsakVersion)[2] & 0xf,
1267 ((unsigned char *) &mh->OsakVersion)[3] & 0xf,
1270 vshift = this->phys_erase_shift + mh->BlockMultiplierBits;
1272 blocks = mtd->size >> vshift;
1273 if (blocks > 32768) {
1274 printk(KERN_ERR "BlockMultiplierBits=%d is inconsistent with device size. Aborting.\n", mh->BlockMultiplierBits);
1278 blocks = doc->chips_per_floor << (this->chip_shift - this->phys_erase_shift);
1279 if (inftl_bbt_write && (blocks > mtd->erasesize)) {
1280 printk(KERN_ERR "Writeable BBTs spanning more than one erase block are not yet supported. FIX ME!\n");
1284 /* Scan the partitions */
1285 for (i = 0; (i < 4); i++) {
1286 ip = &(mh->Partitions[i]);
1287 ip->virtualUnits = le32_to_cpu(ip->virtualUnits);
1288 ip->firstUnit = le32_to_cpu(ip->firstUnit);
1289 ip->lastUnit = le32_to_cpu(ip->lastUnit);
1290 ip->flags = le32_to_cpu(ip->flags);
1291 ip->spareUnits = le32_to_cpu(ip->spareUnits);
1292 ip->Reserved0 = le32_to_cpu(ip->Reserved0);
1294 printk(KERN_INFO " PARTITION[%d] ->\n"
1295 " virtualUnits = %d\n"
1299 " spareUnits = %d\n",
1300 i, ip->virtualUnits, ip->firstUnit,
1301 ip->lastUnit, ip->flags,
1304 if ((show_firmware_partition == 1) &&
1305 (i == 0) && (ip->firstUnit > 0)) {
1306 parts[0].name = " DiskOnChip IPL / Media Header partition";
1307 parts[0].offset = 0;
1308 parts[0].size = mtd->erasesize * ip->firstUnit;
1312 if (ip->flags & INFTL_BINARY)
1313 parts[numparts].name = " DiskOnChip BDK partition";
1315 parts[numparts].name = " DiskOnChip BDTL partition";
1316 parts[numparts].offset = ip->firstUnit << vshift;
1317 parts[numparts].size = (1 + ip->lastUnit - ip->firstUnit) << vshift;
1319 if (ip->lastUnit > lastvunit)
1320 lastvunit = ip->lastUnit;
1321 if (ip->flags & INFTL_LAST)
1325 if ((lastvunit << vshift) < end) {
1326 parts[numparts].name = " DiskOnChip Remainder partition";
1327 parts[numparts].offset = lastvunit << vshift;
1328 parts[numparts].size = end - parts[numparts].offset;
1337 static int __init nftl_scan_bbt(struct mtd_info *mtd)
1340 struct nand_chip *this = mtd->priv;
1341 struct doc_priv *doc = this->priv;
1342 struct mtd_partition parts[2];
1344 memset((char *)parts, 0, sizeof(parts));
1345 /* On NFTL, we have to find the media headers before we can read the
1346 BBTs, since they're stored in the media header eraseblocks. */
1347 numparts = nftl_partscan(mtd, parts);
1350 this->bbt_td->options = NAND_BBT_ABSPAGE | NAND_BBT_8BIT |
1351 NAND_BBT_SAVECONTENT | NAND_BBT_WRITE |
1353 this->bbt_td->veroffs = 7;
1354 this->bbt_td->pages[0] = doc->mh0_page + 1;
1355 if (doc->mh1_page != -1) {
1356 this->bbt_md->options = NAND_BBT_ABSPAGE | NAND_BBT_8BIT |
1357 NAND_BBT_SAVECONTENT | NAND_BBT_WRITE |
1359 this->bbt_md->veroffs = 7;
1360 this->bbt_md->pages[0] = doc->mh1_page + 1;
1362 this->bbt_md = NULL;
1365 /* It's safe to set bd=NULL below because NAND_BBT_CREATE is not set.
1366 At least as nand_bbt.c is currently written. */
1367 if ((ret = nand_scan_bbt(mtd, NULL)))
1369 add_mtd_device(mtd);
1370 #ifdef CONFIG_MTD_PARTITIONS
1372 add_mtd_partitions(mtd, parts, numparts);
1377 static int __init inftl_scan_bbt(struct mtd_info *mtd)
1380 struct nand_chip *this = mtd->priv;
1381 struct doc_priv *doc = this->priv;
1382 struct mtd_partition parts[5];
1384 if (this->numchips > doc->chips_per_floor) {
1385 printk(KERN_ERR "Multi-floor INFTL devices not yet supported.\n");
1389 if (DoC_is_MillenniumPlus(doc)) {
1390 this->bbt_td->options = NAND_BBT_2BIT | NAND_BBT_ABSPAGE;
1391 if (inftl_bbt_write)
1392 this->bbt_td->options |= NAND_BBT_WRITE;
1393 this->bbt_td->pages[0] = 2;
1394 this->bbt_md = NULL;
1396 this->bbt_td->options = NAND_BBT_LASTBLOCK | NAND_BBT_8BIT | NAND_BBT_VERSION;
1397 if (inftl_bbt_write)
1398 this->bbt_td->options |= NAND_BBT_WRITE;
1399 this->bbt_td->offs = 8;
1400 this->bbt_td->len = 8;
1401 this->bbt_td->veroffs = 7;
1402 this->bbt_td->maxblocks = INFTL_BBT_RESERVED_BLOCKS;
1403 this->bbt_td->reserved_block_code = 0x01;
1404 this->bbt_td->pattern = "MSYS_BBT";
1406 this->bbt_md->options = NAND_BBT_LASTBLOCK | NAND_BBT_8BIT | NAND_BBT_VERSION;
1407 if (inftl_bbt_write)
1408 this->bbt_md->options |= NAND_BBT_WRITE;
1409 this->bbt_md->offs = 8;
1410 this->bbt_md->len = 8;
1411 this->bbt_md->veroffs = 7;
1412 this->bbt_md->maxblocks = INFTL_BBT_RESERVED_BLOCKS;
1413 this->bbt_md->reserved_block_code = 0x01;
1414 this->bbt_md->pattern = "TBB_SYSM";
1417 /* It's safe to set bd=NULL below because NAND_BBT_CREATE is not set.
1418 At least as nand_bbt.c is currently written. */
1419 if ((ret = nand_scan_bbt(mtd, NULL)))
1421 memset((char *)parts, 0, sizeof(parts));
1422 numparts = inftl_partscan(mtd, parts);
1423 /* At least for now, require the INFTL Media Header. We could probably
1424 do without it for non-INFTL use, since all it gives us is
1425 autopartitioning, but I want to give it more thought. */
1428 add_mtd_device(mtd);
1429 #ifdef CONFIG_MTD_PARTITIONS
1431 add_mtd_partitions(mtd, parts, numparts);
1436 static inline int __init doc2000_init(struct mtd_info *mtd)
1438 struct nand_chip *this = mtd->priv;
1439 struct doc_priv *doc = this->priv;
1441 this->read_byte = doc2000_read_byte;
1442 this->write_buf = doc2000_writebuf;
1443 this->read_buf = doc2000_readbuf;
1444 this->verify_buf = doc2000_verifybuf;
1445 this->scan_bbt = nftl_scan_bbt;
1447 doc->CDSNControl = CDSN_CTRL_FLASH_IO | CDSN_CTRL_ECC_IO;
1448 doc2000_count_chips(mtd);
1449 mtd->name = "DiskOnChip 2000 (NFTL Model)";
1450 return (4 * doc->chips_per_floor);
1453 static inline int __init doc2001_init(struct mtd_info *mtd)
1455 struct nand_chip *this = mtd->priv;
1456 struct doc_priv *doc = this->priv;
1458 this->read_byte = doc2001_read_byte;
1459 this->write_buf = doc2001_writebuf;
1460 this->read_buf = doc2001_readbuf;
1461 this->verify_buf = doc2001_verifybuf;
1463 ReadDOC(doc->virtadr, ChipID);
1464 ReadDOC(doc->virtadr, ChipID);
1465 ReadDOC(doc->virtadr, ChipID);
1466 if (ReadDOC(doc->virtadr, ChipID) != DOC_ChipID_DocMil) {
1467 /* It's not a Millennium; it's one of the newer
1468 DiskOnChip 2000 units with a similar ASIC.
1469 Treat it like a Millennium, except that it
1470 can have multiple chips. */
1471 doc2000_count_chips(mtd);
1472 mtd->name = "DiskOnChip 2000 (INFTL Model)";
1473 this->scan_bbt = inftl_scan_bbt;
1474 return (4 * doc->chips_per_floor);
1476 /* Bog-standard Millennium */
1477 doc->chips_per_floor = 1;
1478 mtd->name = "DiskOnChip Millennium";
1479 this->scan_bbt = nftl_scan_bbt;
1484 static inline int __init doc2001plus_init(struct mtd_info *mtd)
1486 struct nand_chip *this = mtd->priv;
1487 struct doc_priv *doc = this->priv;
1489 this->read_byte = doc2001plus_read_byte;
1490 this->write_buf = doc2001plus_writebuf;
1491 this->read_buf = doc2001plus_readbuf;
1492 this->verify_buf = doc2001plus_verifybuf;
1493 this->scan_bbt = inftl_scan_bbt;
1494 this->cmd_ctrl = NULL;
1495 this->select_chip = doc2001plus_select_chip;
1496 this->cmdfunc = doc2001plus_command;
1497 this->ecc.hwctl = doc2001plus_enable_hwecc;
1499 doc->chips_per_floor = 1;
1500 mtd->name = "DiskOnChip Millennium Plus";
1505 static int __init doc_probe(unsigned long physadr)
1507 unsigned char ChipID;
1508 struct mtd_info *mtd;
1509 struct nand_chip *nand;
1510 struct doc_priv *doc;
1511 void __iomem *virtadr;
1512 unsigned char save_control;
1513 unsigned char tmp, tmpb, tmpc;
1514 int reg, len, numchips;
1517 virtadr = ioremap(physadr, DOC_IOREMAP_LEN);
1519 printk(KERN_ERR "Diskonchip ioremap failed: 0x%x bytes at 0x%lx\n", DOC_IOREMAP_LEN, physadr);
1523 /* It's not possible to cleanly detect the DiskOnChip - the
1524 * bootup procedure will put the device into reset mode, and
1525 * it's not possible to talk to it without actually writing
1526 * to the DOCControl register. So we store the current contents
1527 * of the DOCControl register's location, in case we later decide
1528 * that it's not a DiskOnChip, and want to put it back how we
1531 save_control = ReadDOC(virtadr, DOCControl);
1533 /* Reset the DiskOnChip ASIC */
1534 WriteDOC(DOC_MODE_CLR_ERR | DOC_MODE_MDWREN | DOC_MODE_RESET, virtadr, DOCControl);
1535 WriteDOC(DOC_MODE_CLR_ERR | DOC_MODE_MDWREN | DOC_MODE_RESET, virtadr, DOCControl);
1537 /* Enable the DiskOnChip ASIC */
1538 WriteDOC(DOC_MODE_CLR_ERR | DOC_MODE_MDWREN | DOC_MODE_NORMAL, virtadr, DOCControl);
1539 WriteDOC(DOC_MODE_CLR_ERR | DOC_MODE_MDWREN | DOC_MODE_NORMAL, virtadr, DOCControl);
1541 ChipID = ReadDOC(virtadr, ChipID);
1544 case DOC_ChipID_Doc2k:
1545 reg = DoC_2k_ECCStatus;
1547 case DOC_ChipID_DocMil:
1550 case DOC_ChipID_DocMilPlus16:
1551 case DOC_ChipID_DocMilPlus32:
1553 /* Possible Millennium Plus, need to do more checks */
1554 /* Possibly release from power down mode */
1555 for (tmp = 0; (tmp < 4); tmp++)
1556 ReadDOC(virtadr, Mplus_Power);
1558 /* Reset the Millennium Plus ASIC */
1559 tmp = DOC_MODE_RESET | DOC_MODE_MDWREN | DOC_MODE_RST_LAT | DOC_MODE_BDECT;
1560 WriteDOC(tmp, virtadr, Mplus_DOCControl);
1561 WriteDOC(~tmp, virtadr, Mplus_CtrlConfirm);
1564 /* Enable the Millennium Plus ASIC */
1565 tmp = DOC_MODE_NORMAL | DOC_MODE_MDWREN | DOC_MODE_RST_LAT | DOC_MODE_BDECT;
1566 WriteDOC(tmp, virtadr, Mplus_DOCControl);
1567 WriteDOC(~tmp, virtadr, Mplus_CtrlConfirm);
1570 ChipID = ReadDOC(virtadr, ChipID);
1573 case DOC_ChipID_DocMilPlus16:
1574 reg = DoC_Mplus_Toggle;
1576 case DOC_ChipID_DocMilPlus32:
1577 printk(KERN_ERR "DiskOnChip Millennium Plus 32MB is not supported, ignoring.\n");
1588 /* Check the TOGGLE bit in the ECC register */
1589 tmp = ReadDOC_(virtadr, reg) & DOC_TOGGLE_BIT;
1590 tmpb = ReadDOC_(virtadr, reg) & DOC_TOGGLE_BIT;
1591 tmpc = ReadDOC_(virtadr, reg) & DOC_TOGGLE_BIT;
1592 if ((tmp == tmpb) || (tmp != tmpc)) {
1593 printk(KERN_WARNING "Possible DiskOnChip at 0x%lx failed TOGGLE test, dropping.\n", physadr);
1598 for (mtd = doclist; mtd; mtd = doc->nextdoc) {
1599 unsigned char oldval;
1600 unsigned char newval;
1603 /* Use the alias resolution register to determine if this is
1604 in fact the same DOC aliased to a new address. If writes
1605 to one chip's alias resolution register change the value on
1606 the other chip, they're the same chip. */
1607 if (ChipID == DOC_ChipID_DocMilPlus16) {
1608 oldval = ReadDOC(doc->virtadr, Mplus_AliasResolution);
1609 newval = ReadDOC(virtadr, Mplus_AliasResolution);
1611 oldval = ReadDOC(doc->virtadr, AliasResolution);
1612 newval = ReadDOC(virtadr, AliasResolution);
1614 if (oldval != newval)
1616 if (ChipID == DOC_ChipID_DocMilPlus16) {
1617 WriteDOC(~newval, virtadr, Mplus_AliasResolution);
1618 oldval = ReadDOC(doc->virtadr, Mplus_AliasResolution);
1619 WriteDOC(newval, virtadr, Mplus_AliasResolution); // restore it
1621 WriteDOC(~newval, virtadr, AliasResolution);
1622 oldval = ReadDOC(doc->virtadr, AliasResolution);
1623 WriteDOC(newval, virtadr, AliasResolution); // restore it
1626 if (oldval == newval) {
1627 printk(KERN_DEBUG "Found alias of DOC at 0x%lx to 0x%lx\n", doc->physadr, physadr);
1632 printk(KERN_NOTICE "DiskOnChip found at 0x%lx\n", physadr);
1634 len = sizeof(struct mtd_info) +
1635 sizeof(struct nand_chip) + sizeof(struct doc_priv) + (2 * sizeof(struct nand_bbt_descr));
1636 mtd = kzalloc(len, GFP_KERNEL);
1638 printk(KERN_ERR "DiskOnChip kmalloc (%d bytes) failed!\n", len);
1643 nand = (struct nand_chip *) (mtd + 1);
1644 doc = (struct doc_priv *) (nand + 1);
1645 nand->bbt_td = (struct nand_bbt_descr *) (doc + 1);
1646 nand->bbt_md = nand->bbt_td + 1;
1649 mtd->owner = THIS_MODULE;
1652 nand->select_chip = doc200x_select_chip;
1653 nand->cmd_ctrl = doc200x_hwcontrol;
1654 nand->dev_ready = doc200x_dev_ready;
1655 nand->waitfunc = doc200x_wait;
1656 nand->block_bad = doc200x_block_bad;
1657 nand->ecc.hwctl = doc200x_enable_hwecc;
1658 nand->ecc.calculate = doc200x_calculate_ecc;
1659 nand->ecc.correct = doc200x_correct_data;
1661 nand->ecc.layout = &doc200x_oobinfo;
1662 nand->ecc.mode = NAND_ECC_HW_SYNDROME;
1663 nand->ecc.size = 512;
1664 nand->ecc.bytes = 6;
1665 nand->options = NAND_USE_FLASH_BBT;
1667 doc->physadr = physadr;
1668 doc->virtadr = virtadr;
1669 doc->ChipID = ChipID;
1674 doc->nextdoc = doclist;
1676 if (ChipID == DOC_ChipID_Doc2k)
1677 numchips = doc2000_init(mtd);
1678 else if (ChipID == DOC_ChipID_DocMilPlus16)
1679 numchips = doc2001plus_init(mtd);
1681 numchips = doc2001_init(mtd);
1683 if ((ret = nand_scan(mtd, numchips))) {
1684 /* DBB note: i believe nand_release is necessary here, as
1685 buffers may have been allocated in nand_base. Check with
1687 /* nand_release will call del_mtd_device, but we haven't yet
1688 added it. This is handled without incident by
1689 del_mtd_device, as far as I can tell. */
1700 /* Put back the contents of the DOCControl register, in case it's not
1701 actually a DiskOnChip. */
1702 WriteDOC(save_control, virtadr, DOCControl);
1708 static void release_nanddoc(void)
1710 struct mtd_info *mtd, *nextmtd;
1711 struct nand_chip *nand;
1712 struct doc_priv *doc;
1714 for (mtd = doclist; mtd; mtd = nextmtd) {
1718 nextmtd = doc->nextdoc;
1720 iounmap(doc->virtadr);
1725 static int __init init_nanddoc(void)
1729 /* We could create the decoder on demand, if memory is a concern.
1730 * This way we have it handy, if an error happens
1732 * Symbolsize is 10 (bits)
1733 * Primitve polynomial is x^10+x^3+1
1734 * first consecutive root is 510
1735 * primitve element to generate roots = 1
1736 * generator polinomial degree = 4
1738 rs_decoder = init_rs(10, 0x409, FCR, 1, NROOTS);
1740 printk(KERN_ERR "DiskOnChip: Could not create a RS decoder\n");
1744 if (doc_config_location) {
1745 printk(KERN_INFO "Using configured DiskOnChip probe address 0x%lx\n", doc_config_location);
1746 ret = doc_probe(doc_config_location);
1750 for (i = 0; (doc_locations[i] != 0xffffffff); i++) {
1751 doc_probe(doc_locations[i]);
1754 /* No banner message any more. Print a message if no DiskOnChip
1755 found, so the user knows we at least tried. */
1757 printk(KERN_INFO "No valid DiskOnChip devices found\n");
1763 free_rs(rs_decoder);
1767 static void __exit cleanup_nanddoc(void)
1769 /* Cleanup the nand/DoC resources */
1772 /* Free the reed solomon resources */
1774 free_rs(rs_decoder);
1778 module_init(init_nanddoc);
1779 module_exit(cleanup_nanddoc);
1781 MODULE_LICENSE("GPL");
1782 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1783 MODULE_DESCRIPTION("M-Systems DiskOnChip 2000, Millennium and Millennium Plus device driver\n");