drivers/mtd/devices/doc2001.c

   1
   2 /*
   3  * Linux driver for Disk-On-Chip Millennium
   4  * (c) 1999 Machine Vision Holdings, Inc.
   5  * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org>
   6  *
   7  * $Id: doc2001.c,v 1.49 2005/11/07 11:14:24 gleixner Exp $
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/module.h>
  12 #include <asm/errno.h>
  13 #include <asm/io.h>
  14 #include <asm/uaccess.h>
  15 #include <linux/miscdevice.h>
  16 #include <linux/pci.h>
  17 #include <linux/delay.h>
  18 #include <linux/slab.h>
  19 #include <linux/sched.h>
  20 #include <linux/init.h>
  21 #include <linux/types.h>
  22 #include <linux/bitops.h>
  23
  24 #include <linux/mtd/mtd.h>
  25 #include <linux/mtd/nand.h>
  26 #include <linux/mtd/doc2000.h>
  27
  28 /* #define ECC_DEBUG */
  29
  30 /* I have no idea why some DoC chips can not use memcop_form|to_io().
  31  * This may be due to the different revisions of the ASIC controller built-in or
  32  * simplily a QA/Bug issue. Who knows ?? If you have trouble, please uncomment
  33  * this:*/
  34 #undef USE_MEMCPY
  35
  36 static int doc_read(struct mtd_info *mtd, loff_t from, size_t len,
  37                     size_t *retlen, u_char *buf);
  38 static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,
  39                      size_t *retlen, const u_char *buf);
  40 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs,
  41                         struct mtd_oob_ops *ops);
  42 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs,
  43                          struct mtd_oob_ops *ops);
  44 static int doc_erase (struct mtd_info *mtd, struct erase_info *instr);
  45
  46 static struct mtd_info *docmillist = NULL;
  47
  48 /* Perform the required delay cycles by reading from the NOP register */
  49 static void DoC_Delay(void __iomem * docptr, unsigned short cycles)
  50 {
  51         volatile char dummy;
  52         int i;
  53
  54         for (i = 0; i < cycles; i++)
  55                 dummy = ReadDOC(docptr, NOP);
  56 }
  57
  58 /* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */
  59 static int _DoC_WaitReady(void __iomem * docptr)
  60 {
  61         unsigned short c = 0xffff;
  62
  63         DEBUG(MTD_DEBUG_LEVEL3,
  64               "_DoC_WaitReady called for out-of-line wait\n");
  65
  66         /* Out-of-line routine to wait for chip response */
  67         while (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B) && --c)
  68                 ;
  69
  70         if (c == 0)
  71                 DEBUG(MTD_DEBUG_LEVEL2, "_DoC_WaitReady timed out.\n");
  72
  73         return (c == 0);
  74 }
  75
  76 static inline int DoC_WaitReady(void __iomem * docptr)
  77 {
  78         /* This is inline, to optimise the common case, where it's ready instantly */
  79         int ret = 0;
  80
  81         /* 4 read form NOP register should be issued in prior to the read from CDSNControl
  82            see Software Requirement 11.4 item 2. */
  83         DoC_Delay(docptr, 4);
  84
  85         if (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B))
  86                 /* Call the out-of-line routine to wait */
  87                 ret = _DoC_WaitReady(docptr);
  88
  89         /* issue 2 read from NOP register after reading from CDSNControl register
  90            see Software Requirement 11.4 item 2. */
  91         DoC_Delay(docptr, 2);
  92
  93         return ret;
  94 }
  95
  96 /* DoC_Command: Send a flash command to the flash chip through the CDSN IO register
  97    with the internal pipeline. Each of 4 delay cycles (read from the NOP register) is
  98    required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */
  99
 100 static void DoC_Command(void __iomem * docptr, unsigned char command,
 101                                unsigned char xtraflags)
 102 {
 103         /* Assert the CLE (Command Latch Enable) line to the flash chip */
 104         WriteDOC(xtraflags | CDSN_CTRL_CLE | CDSN_CTRL_CE, docptr, CDSNControl);
 105         DoC_Delay(docptr, 4);
 106
 107         /* Send the command */
 108         WriteDOC(command, docptr, Mil_CDSN_IO);
 109         WriteDOC(0x00, docptr, WritePipeTerm);
 110
 111         /* Lower the CLE line */
 112         WriteDOC(xtraflags | CDSN_CTRL_CE, docptr, CDSNControl);
 113         DoC_Delay(docptr, 4);
 114 }
 115
 116 /* DoC_Address: Set the current address for the flash chip through the CDSN IO register
 117    with the internal pipeline. Each of 4 delay cycles (read from the NOP register) is
 118    required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */
 119
 120 static inline void DoC_Address(void __iomem * docptr, int numbytes, unsigned long ofs,
 121                                unsigned char xtraflags1, unsigned char xtraflags2)
 122 {
 123         /* Assert the ALE (Address Latch Enable) line to the flash chip */
 124         WriteDOC(xtraflags1 | CDSN_CTRL_ALE | CDSN_CTRL_CE, docptr, CDSNControl);
 125         DoC_Delay(docptr, 4);
 126
 127         /* Send the address */
 128         switch (numbytes)
 129             {
 130             case 1:
 131                     /* Send single byte, bits 0-7. */
 132                     WriteDOC(ofs & 0xff, docptr, Mil_CDSN_IO);
 133                     WriteDOC(0x00, docptr, WritePipeTerm);
 134                     break;
 135             case 2:
 136                     /* Send bits 9-16 followed by 17-23 */
 137                     WriteDOC((ofs >> 9)  & 0xff, docptr, Mil_CDSN_IO);
 138                     WriteDOC((ofs >> 17) & 0xff, docptr, Mil_CDSN_IO);
 139                     WriteDOC(0x00, docptr, WritePipeTerm);
 140                 break;
 141             case 3:
 142                     /* Send 0-7, 9-16, then 17-23 */
 143                     WriteDOC(ofs & 0xff, docptr, Mil_CDSN_IO);
 144                     WriteDOC((ofs >> 9)  & 0xff, docptr, Mil_CDSN_IO);
 145                     WriteDOC((ofs >> 17) & 0xff, docptr, Mil_CDSN_IO);
 146                     WriteDOC(0x00, docptr, WritePipeTerm);
 147                 break;
 148             default:
 149                 return;
 150             }
 151
 152         /* Lower the ALE line */
 153         WriteDOC(xtraflags1 | xtraflags2 | CDSN_CTRL_CE, docptr, CDSNControl);
 154         DoC_Delay(docptr, 4);
 155 }
 156
 157 /* DoC_SelectChip: Select a given flash chip within the current floor */
 158 static int DoC_SelectChip(void __iomem * docptr, int chip)
 159 {
 160         /* Select the individual flash chip requested */
 161         WriteDOC(chip, docptr, CDSNDeviceSelect);
 162         DoC_Delay(docptr, 4);
 163
 164         /* Wait for it to be ready */
 165         return DoC_WaitReady(docptr);
 166 }
 167
 168 /* DoC_SelectFloor: Select a given floor (bank of flash chips) */
 169 static int DoC_SelectFloor(void __iomem * docptr, int floor)
 170 {
 171         /* Select the floor (bank) of chips required */
 172         WriteDOC(floor, docptr, FloorSelect);
 173
 174         /* Wait for the chip to be ready */
 175         return DoC_WaitReady(docptr);
 176 }
 177
 178 /* DoC_IdentChip: Identify a given NAND chip given {floor,chip} */
 179 static int DoC_IdentChip(struct DiskOnChip *doc, int floor, int chip)
 180 {
 181         int mfr, id, i, j;
 182         volatile char dummy;
 183
 184         /* Page in the required floor/chip
 185            FIXME: is this supported by Millennium ?? */
 186         DoC_SelectFloor(doc->virtadr, floor);
 187         DoC_SelectChip(doc->virtadr, chip);
 188
 189         /* Reset the chip, see Software Requirement 11.4 item 1. */
 190         DoC_Command(doc->virtadr, NAND_CMD_RESET, CDSN_CTRL_WP);
 191         DoC_WaitReady(doc->virtadr);
 192
 193         /* Read the NAND chip ID: 1. Send ReadID command */
 194         DoC_Command(doc->virtadr, NAND_CMD_READID, CDSN_CTRL_WP);
 195
 196         /* Read the NAND chip ID: 2. Send address byte zero */
 197         DoC_Address(doc->virtadr, 1, 0x00, CDSN_CTRL_WP, 0x00);
 198
 199         /* Read the manufacturer and device id codes of the flash device through
 200            CDSN IO register see Software Requirement 11.4 item 5.*/
 201         dummy = ReadDOC(doc->virtadr, ReadPipeInit);
 202         DoC_Delay(doc->virtadr, 2);
 203         mfr = ReadDOC(doc->virtadr, Mil_CDSN_IO);
 204
 205         DoC_Delay(doc->virtadr, 2);
 206         id  = ReadDOC(doc->virtadr, Mil_CDSN_IO);
 207         dummy = ReadDOC(doc->virtadr, LastDataRead);
 208
 209         /* No response - return failure */
 210         if (mfr == 0xff || mfr == 0)
 211                 return 0;
 212
 213         /* FIXME: to deal with multi-flash on multi-Millennium case more carefully */
 214         for (i = 0; nand_flash_ids[i].name != NULL; i++) {
 215                 if ( id == nand_flash_ids[i].id) {
 216                         /* Try to identify manufacturer */
 217                         for (j = 0; nand_manuf_ids[j].id != 0x0; j++) {
 218                                 if (nand_manuf_ids[j].id == mfr)
 219                                         break;
 220                         }
 221                         printk(KERN_INFO "Flash chip found: Manufacturer ID: %2.2X, "
 222                                "Chip ID: %2.2X (%s:%s)\n",
 223                                mfr, id, nand_manuf_ids[j].name, nand_flash_ids[i].name);
 224                         doc->mfr = mfr;
 225                         doc->id = id;
 226                         doc->chipshift = ffs((nand_flash_ids[i].chipsize << 20)) - 1;
 227                         break;
 228                 }
 229         }
 230
 231         if (nand_flash_ids[i].name == NULL)
 232                 return 0;
 233         else
 234                 return 1;
 235 }
 236
 237 /* DoC_ScanChips: Find all NAND chips present in a DiskOnChip, and identify them */
 238 static void DoC_ScanChips(struct DiskOnChip *this)
 239 {
 240         int floor, chip;
 241         int numchips[MAX_FLOORS_MIL];
 242         int ret;
 243
 244         this->numchips = 0;
 245         this->mfr = 0;
 246         this->id = 0;
 247
 248         /* For each floor, find the number of valid chips it contains */
 249         for (floor = 0,ret = 1; floor < MAX_FLOORS_MIL; floor++) {
 250                 numchips[floor] = 0;
 251                 for (chip = 0; chip < MAX_CHIPS_MIL && ret != 0; chip++) {
 252                         ret = DoC_IdentChip(this, floor, chip);
 253                         if (ret) {
 254                                 numchips[floor]++;
 255                                 this->numchips++;
 256                         }
 257                 }
 258         }
 259         /* If there are none at all that we recognise, bail */
 260         if (!this->numchips) {
 261                 printk("No flash chips recognised.\n");
 262                 return;
 263         }
 264
 265         /* Allocate an array to hold the information for each chip */
 266         this->chips = kmalloc(sizeof(struct Nand) * this->numchips, GFP_KERNEL);
 267         if (!this->chips){
 268                 printk("No memory for allocating chip info structures\n");
 269                 return;
 270         }
 271
 272         /* Fill out the chip array with {floor, chipno} for each
 273          * detected chip in the device. */
 274         for (floor = 0, ret = 0; floor < MAX_FLOORS_MIL; floor++) {
 275                 for (chip = 0 ; chip < numchips[floor] ; chip++) {
 276                         this->chips[ret].floor = floor;
 277                         this->chips[ret].chip = chip;
 278                         this->chips[ret].curadr = 0;
 279                         this->chips[ret].curmode = 0x50;
 280                         ret++;
 281                 }
 282         }
 283
 284         /* Calculate and print the total size of the device */
 285         this->totlen = this->numchips * (1 << this->chipshift);
 286         printk(KERN_INFO "%d flash chips found. Total DiskOnChip size: %ld MiB\n",
 287                this->numchips ,this->totlen >> 20);
 288 }
 289
 290 static int DoCMil_is_alias(struct DiskOnChip *doc1, struct DiskOnChip *doc2)
 291 {
 292         int tmp1, tmp2, retval;
 293
 294         if (doc1->physadr == doc2->physadr)
 295                 return 1;
 296
 297         /* Use the alias resolution register which was set aside for this
 298          * purpose. If it's value is the same on both chips, they might
 299          * be the same chip, and we write to one and check for a change in
 300          * the other. It's unclear if this register is usuable in the
 301          * DoC 2000 (it's in the Millenium docs), but it seems to work. */
 302         tmp1 = ReadDOC(doc1->virtadr, AliasResolution);
 303         tmp2 = ReadDOC(doc2->virtadr, AliasResolution);
 304         if (tmp1 != tmp2)
 305                 return 0;
 306
 307         WriteDOC((tmp1+1) % 0xff, doc1->virtadr, AliasResolution);
 308         tmp2 = ReadDOC(doc2->virtadr, AliasResolution);
 309         if (tmp2 == (tmp1+1) % 0xff)
 310                 retval = 1;
 311         else
 312                 retval = 0;
 313
 314         /* Restore register contents.  May not be necessary, but do it just to
 315          * be safe. */
 316         WriteDOC(tmp1, doc1->virtadr, AliasResolution);
 317
 318         return retval;
 319 }
 320
 321 /* This routine is found from the docprobe code by symbol_get(),
 322  * which will bump the use count of this module. */
 323 void DoCMil_init(struct mtd_info *mtd)
 324 {
 325         struct DiskOnChip *this = mtd->priv;
 326         struct DiskOnChip *old = NULL;
 327
 328         /* We must avoid being called twice for the same device. */
 329         if (docmillist)
 330                 old = docmillist->priv;
 331
 332         while (old) {
 333                 if (DoCMil_is_alias(this, old)) {
 334                         printk(KERN_NOTICE "Ignoring DiskOnChip Millennium at "
 335                                "0x%lX - already configured\n", this->physadr);
 336                         iounmap(this->virtadr);
 337                         kfree(mtd);
 338                         return;
 339                 }
 340                 if (old->nextdoc)
 341                         old = old->nextdoc->priv;
 342                 else
 343                         old = NULL;
 344         }
 345
 346         mtd->name = "DiskOnChip Millennium";
 347         printk(KERN_NOTICE "DiskOnChip Millennium found at address 0x%lX\n",
 348                this->physadr);
 349
 350         mtd->type = MTD_NANDFLASH;
 351         mtd->flags = MTD_CAP_NANDFLASH;
 352         mtd->size = 0;
 353
 354         /* FIXME: erase size is not always 8KiB */
 355         mtd->erasesize = 0x2000;
 356
 357         mtd->writesize = 512;
 358         mtd->oobsize = 16;
 359         mtd->owner = THIS_MODULE;
 360         mtd->erase = doc_erase;
 361         mtd->point = NULL;
 362         mtd->unpoint = NULL;
 363         mtd->read = doc_read;
 364         mtd->write = doc_write;
 365         mtd->read_oob = doc_read_oob;
 366         mtd->write_oob = doc_write_oob;
 367         mtd->sync = NULL;
 368
 369         this->totlen = 0;
 370         this->numchips = 0;
 371         this->curfloor = -1;
 372         this->curchip = -1;
 373
 374         /* Ident all the chips present. */
 375         DoC_ScanChips(this);
 376
 377         if (!this->totlen) {
 378                 kfree(mtd);
 379                 iounmap(this->virtadr);
 380         } else {
 381                 this->nextdoc = docmillist;
 382                 docmillist = mtd;
 383                 mtd->size  = this->totlen;
 384                 add_mtd_device(mtd);
 385                 return;
 386         }
 387 }
 388 EXPORT_SYMBOL_GPL(DoCMil_init);
 389
 390 static int doc_read (struct mtd_info *mtd, loff_t from, size_t len,
 391                      size_t *retlen, u_char *buf)
 392 {
 393         int i, ret;
 394         volatile char dummy;
 395         unsigned char syndrome[6], eccbuf[6];
 396         struct DiskOnChip *this = mtd->priv;
 397         void __iomem *docptr = this->virtadr;
 398         struct Nand *mychip = &this->chips[from >> (this->chipshift)];
 399
 400         /* Don't allow read past end of device */
 401         if (from >= this->totlen)
 402                 return -EINVAL;
 403
 404         /* Don't allow a single read to cross a 512-byte block boundary */
 405         if (from + len > ((from | 0x1ff) + 1))
 406                 len = ((from | 0x1ff) + 1) - from;
 407
 408         /* Find the chip which is to be used and select it */
 409         if (this->curfloor != mychip->floor) {
 410                 DoC_SelectFloor(docptr, mychip->floor);
 411                 DoC_SelectChip(docptr, mychip->chip);
 412         } else if (this->curchip != mychip->chip) {
 413                 DoC_SelectChip(docptr, mychip->chip);
 414         }
 415         this->curfloor = mychip->floor;
 416         this->curchip = mychip->chip;
 417
 418         /* issue the Read0 or Read1 command depend on which half of the page
 419            we are accessing. Polling the Flash Ready bit after issue 3 bytes
 420            address in Sequence Read Mode, see Software Requirement 11.4 item 1.*/
 421         DoC_Command(docptr, (from >> 8) & 1, CDSN_CTRL_WP);
 422         DoC_Address(docptr, 3, from, CDSN_CTRL_WP, 0x00);
 423         DoC_WaitReady(docptr);
 424
 425         /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
 426         WriteDOC (DOC_ECC_RESET, docptr, ECCConf);
 427         WriteDOC (DOC_ECC_EN, docptr, ECCConf);
 428
 429         /* Read the data via the internal pipeline through CDSN IO register,
 430            see Pipelined Read Operations 11.3 */
 431         dummy = ReadDOC(docptr, ReadPipeInit);
 432 #ifndef USE_MEMCPY
 433         for (i = 0; i < len-1; i++) {
 434                 /* N.B. you have to increase the source address in this way or the
 435                    ECC logic will not work properly */
 436                 buf[i] = ReadDOC(docptr, Mil_CDSN_IO + (i & 0xff));
 437         }
 438 #else
 439         memcpy_fromio(buf, docptr + DoC_Mil_CDSN_IO, len - 1);
 440 #endif
 441         buf[len - 1] = ReadDOC(docptr, LastDataRead);
 442
 443         /* Let the caller know we completed it */
 444         *retlen = len;
 445         ret = 0;
 446
 447         /* Read the ECC data from Spare Data Area,
 448            see Reed-Solomon EDC/ECC 11.1 */
 449         dummy = ReadDOC(docptr, ReadPipeInit);
 450 #ifndef USE_MEMCPY
 451         for (i = 0; i < 5; i++) {
 452                 /* N.B. you have to increase the source address in this way or the
 453                    ECC logic will not work properly */
 454                 eccbuf[i] = ReadDOC(docptr, Mil_CDSN_IO + i);
 455         }
 456 #else
 457         memcpy_fromio(eccbuf, docptr + DoC_Mil_CDSN_IO, 5);
 458 #endif
 459         eccbuf[5] = ReadDOC(docptr, LastDataRead);
 460
 461         /* Flush the pipeline */
 462         dummy = ReadDOC(docptr, ECCConf);
 463         dummy = ReadDOC(docptr, ECCConf);
 464
 465         /* Check the ECC Status */
 466         if (ReadDOC(docptr, ECCConf) & 0x80) {
 467                 int nb_errors;
 468                 /* There was an ECC error */
 469 #ifdef ECC_DEBUG
 470                 printk("DiskOnChip ECC Error: Read at %lx\n", (long)from);
 471 #endif
 472                 /* Read the ECC syndrom through the DiskOnChip ECC logic.
 473                    These syndrome will be all ZERO when there is no error */
 474                 for (i = 0; i < 6; i++) {
 475                         syndrome[i] = ReadDOC(docptr, ECCSyndrome0 + i);
 476                 }
 477                 nb_errors = doc_decode_ecc(buf, syndrome);
 478 #ifdef ECC_DEBUG
 479                 printk("ECC Errors corrected: %x\n", nb_errors);
 480 #endif
 481                 if (nb_errors < 0) {
 482                         /* We return error, but have actually done the read. Not that
 483                            this can be told to user-space, via sys_read(), but at least
 484                            MTD-aware stuff can know about it by checking *retlen */
 485                         ret = -EIO;
 486                 }
 487         }
 488
 489 #ifdef PSYCHO_DEBUG
 490         printk("ECC DATA at %lx: %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
 491                (long)from, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
 492                eccbuf[4], eccbuf[5]);
 493 #endif
 494
 495         /* disable the ECC engine */
 496         WriteDOC(DOC_ECC_DIS, docptr , ECCConf);
 497
 498         return ret;
 499 }
 500
 501 static int doc_write (struct mtd_info *mtd, loff_t to, size_t len,
 502                       size_t *retlen, const u_char *buf)
 503 {
 504         int i,ret = 0;
 505         char eccbuf[6];
 506         volatile char dummy;
 507         struct DiskOnChip *this = mtd->priv;
 508         void __iomem *docptr = this->virtadr;
 509         struct Nand *mychip = &this->chips[to >> (this->chipshift)];
 510
 511         /* Don't allow write past end of device */
 512         if (to >= this->totlen)
 513                 return -EINVAL;
 514
 515 #if 0
 516         /* Don't allow a single write to cross a 512-byte block boundary */
 517         if (to + len > ( (to | 0x1ff) + 1))
 518                 len = ((to | 0x1ff) + 1) - to;
 519 #else
 520         /* Don't allow writes which aren't exactly one block */
 521         if (to & 0x1ff || len != 0x200)
 522                 return -EINVAL;
 523 #endif
 524
 525         /* Find the chip which is to be used and select it */
 526         if (this->curfloor != mychip->floor) {
 527                 DoC_SelectFloor(docptr, mychip->floor);
 528                 DoC_SelectChip(docptr, mychip->chip);
 529         } else if (this->curchip != mychip->chip) {
 530                 DoC_SelectChip(docptr, mychip->chip);
 531         }
 532         this->curfloor = mychip->floor;
 533         this->curchip = mychip->chip;
 534
 535         /* Reset the chip, see Software Requirement 11.4 item 1. */
 536         DoC_Command(docptr, NAND_CMD_RESET, 0x00);
 537         DoC_WaitReady(docptr);
 538         /* Set device to main plane of flash */
 539         DoC_Command(docptr, NAND_CMD_READ0, 0x00);
 540
 541         /* issue the Serial Data In command to initial the Page Program process */
 542         DoC_Command(docptr, NAND_CMD_SEQIN, 0x00);
 543         DoC_Address(docptr, 3, to, 0x00, 0x00);
 544         DoC_WaitReady(docptr);
 545
 546         /* init the ECC engine, see Reed-Solomon EDC/ECC 11.1 .*/
 547         WriteDOC (DOC_ECC_RESET, docptr, ECCConf);
 548         WriteDOC (DOC_ECC_EN | DOC_ECC_RW, docptr, ECCConf);
 549
 550         /* Write the data via the internal pipeline through CDSN IO register,
 551            see Pipelined Write Operations 11.2 */
 552 #ifndef USE_MEMCPY
 553         for (i = 0; i < len; i++) {
 554                 /* N.B. you have to increase the source address in this way or the
 555                    ECC logic will not work properly */
 556                 WriteDOC(buf[i], docptr, Mil_CDSN_IO + i);
 557         }
 558 #else
 559         memcpy_toio(docptr + DoC_Mil_CDSN_IO, buf, len);
 560 #endif
 561         WriteDOC(0x00, docptr, WritePipeTerm);
 562
 563         /* Write ECC data to flash, the ECC info is generated by the DiskOnChip ECC logic
 564            see Reed-Solomon EDC/ECC 11.1 */
 565         WriteDOC(0, docptr, NOP);
 566         WriteDOC(0, docptr, NOP);
 567         WriteDOC(0, docptr, NOP);
 568
 569         /* Read the ECC data through the DiskOnChip ECC logic */
 570         for (i = 0; i < 6; i++) {
 571                 eccbuf[i] = ReadDOC(docptr, ECCSyndrome0 + i);
 572         }
 573
 574         /* ignore the ECC engine */
 575         WriteDOC(DOC_ECC_DIS, docptr , ECCConf);
 576
 577 #ifndef USE_MEMCPY
 578         /* Write the ECC data to flash */
 579         for (i = 0; i < 6; i++) {
 580                 /* N.B. you have to increase the source address in this way or the
 581                    ECC logic will not work properly */
 582                 WriteDOC(eccbuf[i], docptr, Mil_CDSN_IO + i);
 583         }
 584 #else
 585         memcpy_toio(docptr + DoC_Mil_CDSN_IO, eccbuf, 6);
 586 #endif
 587
 588         /* write the block status BLOCK_USED (0x5555) at the end of ECC data
 589            FIXME: this is only a hack for programming the IPL area for LinuxBIOS
 590            and should be replace with proper codes in user space utilities */
 591         WriteDOC(0x55, docptr, Mil_CDSN_IO);
 592         WriteDOC(0x55, docptr, Mil_CDSN_IO + 1);
 593
 594         WriteDOC(0x00, docptr, WritePipeTerm);
 595
 596 #ifdef PSYCHO_DEBUG
 597         printk("OOB data at %lx is %2.2X %2.2X %2.2X %2.2X %2.2X %2.2X\n",
 598                (long) to, eccbuf[0], eccbuf[1], eccbuf[2], eccbuf[3],
 599                eccbuf[4], eccbuf[5]);
 600 #endif
 601
 602         /* Commit the Page Program command and wait for ready
 603            see Software Requirement 11.4 item 1.*/
 604         DoC_Command(docptr, NAND_CMD_PAGEPROG, 0x00);
 605         DoC_WaitReady(docptr);
 606
 607         /* Read the status of the flash device through CDSN IO register
 608            see Software Requirement 11.4 item 5.*/
 609         DoC_Command(docptr, NAND_CMD_STATUS, CDSN_CTRL_WP);
 610         dummy = ReadDOC(docptr, ReadPipeInit);
 611         DoC_Delay(docptr, 2);
 612         if (ReadDOC(docptr, Mil_CDSN_IO) & 1) {
 613                 printk("Error programming flash\n");
 614                 /* Error in programming
 615                    FIXME: implement Bad Block Replacement (in nftl.c ??) */
 616                 *retlen = 0;
 617                 ret = -EIO;
 618         }
 619         dummy = ReadDOC(docptr, LastDataRead);
 620
 621         /* Let the caller know we completed it */
 622         *retlen = len;
 623
 624         return ret;
 625 }
 626
 627 static int doc_read_oob(struct mtd_info *mtd, loff_t ofs,
 628                         struct mtd_oob_ops *ops)
 629 {
 630 #ifndef USE_MEMCPY
 631         int i;
 632 #endif
 633         volatile char dummy;
 634         struct DiskOnChip *this = mtd->priv;
 635         void __iomem *docptr = this->virtadr;
 636         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
 637         uint8_t *buf = ops->oobbuf;
 638         size_t len = ops->len;
 639
 640         BUG_ON(ops->mode != MTD_OOB_PLACE);
 641
 642         ofs += ops->ooboffs;
 643
 644         /* Find the chip which is to be used and select it */
 645         if (this->curfloor != mychip->floor) {
 646                 DoC_SelectFloor(docptr, mychip->floor);
 647                 DoC_SelectChip(docptr, mychip->chip);
 648         } else if (this->curchip != mychip->chip) {
 649                 DoC_SelectChip(docptr, mychip->chip);
 650         }
 651         this->curfloor = mychip->floor;
 652         this->curchip = mychip->chip;
 653
 654         /* disable the ECC engine */
 655         WriteDOC (DOC_ECC_RESET, docptr, ECCConf);
 656         WriteDOC (DOC_ECC_DIS, docptr, ECCConf);
 657
 658         /* issue the Read2 command to set the pointer to the Spare Data Area.
 659            Polling the Flash Ready bit after issue 3 bytes address in
 660            Sequence Read Mode, see Software Requirement 11.4 item 1.*/
 661         DoC_Command(docptr, NAND_CMD_READOOB, CDSN_CTRL_WP);
 662         DoC_Address(docptr, 3, ofs, CDSN_CTRL_WP, 0x00);
 663         DoC_WaitReady(docptr);
 664
 665         /* Read the data out via the internal pipeline through CDSN IO register,
 666            see Pipelined Read Operations 11.3 */
 667         dummy = ReadDOC(docptr, ReadPipeInit);
 668 #ifndef USE_MEMCPY
 669         for (i = 0; i < len-1; i++) {
 670                 /* N.B. you have to increase the source address in this way or the
 671                    ECC logic will not work properly */
 672                 buf[i] = ReadDOC(docptr, Mil_CDSN_IO + i);
 673         }
 674 #else
 675         memcpy_fromio(buf, docptr + DoC_Mil_CDSN_IO, len - 1);
 676 #endif
 677         buf[len - 1] = ReadDOC(docptr, LastDataRead);
 678
 679         ops->retlen = len;
 680
 681         return 0;
 682 }
 683
 684 static int doc_write_oob(struct mtd_info *mtd, loff_t ofs,
 685                          struct mtd_oob_ops *ops)
 686 {
 687 #ifndef USE_MEMCPY
 688         int i;
 689 #endif
 690         volatile char dummy;
 691         int ret = 0;
 692         struct DiskOnChip *this = mtd->priv;
 693         void __iomem *docptr = this->virtadr;
 694         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
 695         uint8_t *buf = ops->oobbuf;
 696         size_t len = ops->len;
 697
 698         BUG_ON(ops->mode != MTD_OOB_PLACE);
 699
 700         ofs += ops->ooboffs;
 701
 702         /* Find the chip which is to be used and select it */
 703         if (this->curfloor != mychip->floor) {
 704                 DoC_SelectFloor(docptr, mychip->floor);
 705                 DoC_SelectChip(docptr, mychip->chip);
 706         } else if (this->curchip != mychip->chip) {
 707                 DoC_SelectChip(docptr, mychip->chip);
 708         }
 709         this->curfloor = mychip->floor;
 710         this->curchip = mychip->chip;
 711
 712         /* disable the ECC engine */
 713         WriteDOC (DOC_ECC_RESET, docptr, ECCConf);
 714         WriteDOC (DOC_ECC_DIS, docptr, ECCConf);
 715
 716         /* Reset the chip, see Software Requirement 11.4 item 1. */
 717         DoC_Command(docptr, NAND_CMD_RESET, CDSN_CTRL_WP);
 718         DoC_WaitReady(docptr);
 719         /* issue the Read2 command to set the pointer to the Spare Data Area. */
 720         DoC_Command(docptr, NAND_CMD_READOOB, CDSN_CTRL_WP);
 721
 722         /* issue the Serial Data In command to initial the Page Program process */
 723         DoC_Command(docptr, NAND_CMD_SEQIN, 0x00);
 724         DoC_Address(docptr, 3, ofs, 0x00, 0x00);
 725
 726         /* Write the data via the internal pipeline through CDSN IO register,
 727            see Pipelined Write Operations 11.2 */
 728 #ifndef USE_MEMCPY
 729         for (i = 0; i < len; i++) {
 730                 /* N.B. you have to increase the source address in this way or the
 731                    ECC logic will not work properly */
 732                 WriteDOC(buf[i], docptr, Mil_CDSN_IO + i);
 733         }
 734 #else
 735         memcpy_toio(docptr + DoC_Mil_CDSN_IO, buf, len);
 736 #endif
 737         WriteDOC(0x00, docptr, WritePipeTerm);
 738
 739         /* Commit the Page Program command and wait for ready
 740            see Software Requirement 11.4 item 1.*/
 741         DoC_Command(docptr, NAND_CMD_PAGEPROG, 0x00);
 742         DoC_WaitReady(docptr);
 743
 744         /* Read the status of the flash device through CDSN IO register
 745            see Software Requirement 11.4 item 5.*/
 746         DoC_Command(docptr, NAND_CMD_STATUS, 0x00);
 747         dummy = ReadDOC(docptr, ReadPipeInit);
 748         DoC_Delay(docptr, 2);
 749         if (ReadDOC(docptr, Mil_CDSN_IO) & 1) {
 750                 printk("Error programming oob data\n");
 751                 /* FIXME: implement Bad Block Replacement (in nftl.c ??) */
 752                 ops->retlen = 0;
 753                 ret = -EIO;
 754         }
 755         dummy = ReadDOC(docptr, LastDataRead);
 756
 757         ops->retlen = len;
 758
 759         return ret;
 760 }
 761
 762 int doc_erase (struct mtd_info *mtd, struct erase_info *instr)
 763 {
 764         volatile char dummy;
 765         struct DiskOnChip *this = mtd->priv;
 766         __u32 ofs = instr->addr;
 767         __u32 len = instr->len;
 768         void __iomem *docptr = this->virtadr;
 769         struct Nand *mychip = &this->chips[ofs >> this->chipshift];
 770
 771         if (len != mtd->erasesize)
 772                 printk(KERN_WARNING "Erase not right size (%x != %x)n",
 773                        len, mtd->erasesize);
 774
 775         /* Find the chip which is to be used and select it */
 776         if (this->curfloor != mychip->floor) {
 777                 DoC_SelectFloor(docptr, mychip->floor);
 778                 DoC_SelectChip(docptr, mychip->chip);
 779         } else if (this->curchip != mychip->chip) {
 780                 DoC_SelectChip(docptr, mychip->chip);
 781         }
 782         this->curfloor = mychip->floor;
 783         this->curchip = mychip->chip;
 784
 785         instr->state = MTD_ERASE_PENDING;
 786
 787         /* issue the Erase Setup command */
 788         DoC_Command(docptr, NAND_CMD_ERASE1, 0x00);
 789         DoC_Address(docptr, 2, ofs, 0x00, 0x00);
 790
 791         /* Commit the Erase Start command and wait for ready
 792            see Software Requirement 11.4 item 1.*/
 793         DoC_Command(docptr, NAND_CMD_ERASE2, 0x00);
 794         DoC_WaitReady(docptr);
 795
 796         instr->state = MTD_ERASING;
 797
 798         /* Read the status of the flash device through CDSN IO register
 799            see Software Requirement 11.4 item 5.
 800            FIXME: it seems that we are not wait long enough, some blocks are not
 801            erased fully */
 802         DoC_Command(docptr, NAND_CMD_STATUS, CDSN_CTRL_WP);
 803         dummy = ReadDOC(docptr, ReadPipeInit);
 804         DoC_Delay(docptr, 2);
 805         if (ReadDOC(docptr, Mil_CDSN_IO) & 1) {
 806                 printk("Error Erasing at 0x%x\n", ofs);
 807                 /* There was an error
 808                    FIXME: implement Bad Block Replacement (in nftl.c ??) */
 809                 instr->state = MTD_ERASE_FAILED;
 810         } else
 811                 instr->state = MTD_ERASE_DONE;
 812         dummy = ReadDOC(docptr, LastDataRead);
 813
 814         mtd_erase_callback(instr);
 815
 816         return 0;
 817 }
 818
 819 /****************************************************************************
 820  *
 821  * Module stuff
 822  *
 823  ****************************************************************************/
 824
 825 static void __exit cleanup_doc2001(void)
 826 {
 827         struct mtd_info *mtd;
 828         struct DiskOnChip *this;
 829
 830         while ((mtd=docmillist)) {
 831                 this = mtd->priv;
 832                 docmillist = this->nextdoc;
 833
 834                 del_mtd_device(mtd);
 835
 836                 iounmap(this->virtadr);
 837                 kfree(this->chips);
 838                 kfree(mtd);
 839         }
 840 }
 841
 842 module_exit(cleanup_doc2001);
 843
 844 MODULE_LICENSE("GPL");
 845 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org> et al.");
 846 MODULE_DESCRIPTION("Alternative driver for DiskOnChip Millennium");