drivers/mtd/nand/nand_bbt.c

   1 /*
   2  *  drivers/mtd/nand_bbt.c
   3  *
   4  *  Overview:
   5  *   Bad block table support for the NAND driver
   6  *
   7  *  Copyright (C) 2004 Thomas Gleixner (tglx@linutronix.de)
   8  *
   9  * $Id: nand_bbt.c,v 1.36 2005/11/07 11:14:30 gleixner Exp $
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * Description:
  16  *
  17  * When nand_scan_bbt is called, then it tries to find the bad block table
  18  * depending on the options in the bbt descriptor(s). If a bbt is found
  19  * then the contents are read and the memory based bbt is created. If a
  20  * mirrored bbt is selected then the mirror is searched too and the
  21  * versions are compared. If the mirror has a greater version number
  22  * than the mirror bbt is used to build the memory based bbt.
  23  * If the tables are not versioned, then we "or" the bad block information.
  24  * If one of the bbt's is out of date or does not exist it is (re)created.
  25  * If no bbt exists at all then the device is scanned for factory marked
  26  * good / bad blocks and the bad block tables are created.
  27  *
  28  * For manufacturer created bbts like the one found on M-SYS DOC devices
  29  * the bbt is searched and read but never created
  30  *
  31  * The autogenerated bad block table is located in the last good blocks
  32  * of the device. The table is mirrored, so it can be updated eventually.
  33  * The table is marked in the oob area with an ident pattern and a version
  34  * number which indicates which of both tables is more up to date.
  35  *
  36  * The table uses 2 bits per block
  37  * 11b: block is good
  38  * 00b: block is factory marked bad
  39  * 01b, 10b:    block is marked bad due to wear
  40  *
  41  * The memory bad block table uses the following scheme:
  42  * 00b:         block is good
  43  * 01b:         block is marked bad due to wear
  44  * 10b:         block is reserved (to protect the bbt area)
  45  * 11b:         block is factory marked bad
  46  *
  47  * Multichip devices like DOC store the bad block info per floor.
  48  *
  49  * Following assumptions are made:
  50  * - bbts start at a page boundary, if autolocated on a block boundary
  51  * - the space necessary for a bbt in FLASH does not exceed a block boundary
  52  *
  53  */
  54
  55 #include <common.h>
  56
  57 #if defined(CONFIG_CMD_NAND) && !defined(CFG_NAND_LEGACY)
  58
  59 #include <malloc.h>
  60 #include <linux/mtd/compat.h>
  61 #include <linux/mtd/mtd.h>
  62 #include <linux/mtd/nand.h>
  63
  64 #include <asm/errno.h>
  65
  66 /* XXX U-BOOT XXX */
  67 #if 0
  68 #include <linux/slab.h>
  69 #include <linux/types.h>
  70 #include <linux/mtd/mtd.h>
  71 #include <linux/mtd/nand.h>
  72 #include <linux/mtd/nand_ecc.h>
  73 #include <linux/mtd/compatmac.h>
  74 #include <linux/bitops.h>
  75 #include <linux/delay.h>
  76 #include <linux/vmalloc.h>
  77 #endif
  78
  79 /**
  80  * check_pattern - [GENERIC] check if a pattern is in the buffer
  81  * @buf:        the buffer to search
  82  * @len:        the length of buffer to search
  83  * @paglen:     the pagelength
  84  * @td:         search pattern descriptor
  85  *
  86  * Check for a pattern at the given place. Used to search bad block
  87  * tables and good / bad block identifiers.
  88  * If the SCAN_EMPTY option is set then check, if all bytes except the
  89  * pattern area contain 0xff
  90  *
  91 */
  92 static int check_pattern(uint8_t *buf, int len, int paglen, struct nand_bbt_descr *td)
  93 {
  94         int i, end = 0;
  95         uint8_t *p = buf;
  96
  97         end = paglen + td->offs;
  98         if (td->options & NAND_BBT_SCANEMPTY) {
  99                 for (i = 0; i < end; i++) {
 100                         if (p[i] != 0xff)
 101                                 return -1;
 102                 }
 103         }
 104         p += end;
 105
 106         /* Compare the pattern */
 107         for (i = 0; i < td->len; i++) {
 108                 if (p[i] != td->pattern[i])
 109                         return -1;
 110         }
 111
 112         if (td->options & NAND_BBT_SCANEMPTY) {
 113                 p += td->len;
 114                 end += td->len;
 115                 for (i = end; i < len; i++) {
 116                         if (*p++ != 0xff)
 117                                 return -1;
 118                 }
 119         }
 120         return 0;
 121 }
 122
 123 /**
 124  * check_short_pattern - [GENERIC] check if a pattern is in the buffer
 125  * @buf:        the buffer to search
 126  * @td:         search pattern descriptor
 127  *
 128  * Check for a pattern at the given place. Used to search bad block
 129  * tables and good / bad block identifiers. Same as check_pattern, but
 130  * no optional empty check
 131  *
 132 */
 133 static int check_short_pattern(uint8_t *buf, struct nand_bbt_descr *td)
 134 {
 135         int i;
 136         uint8_t *p = buf;
 137
 138         /* Compare the pattern */
 139         for (i = 0; i < td->len; i++) {
 140                 if (p[td->offs + i] != td->pattern[i])
 141                         return -1;
 142         }
 143         return 0;
 144 }
 145
 146 /**
 147  * read_bbt - [GENERIC] Read the bad block table starting from page
 148  * @mtd:        MTD device structure
 149  * @buf:        temporary buffer
 150  * @page:       the starting page
 151  * @num:        the number of bbt descriptors to read
 152  * @bits:       number of bits per block
 153  * @offs:       offset in the memory table
 154  * @reserved_block_code:        Pattern to identify reserved blocks
 155  *
 156  * Read the bad block table starting from page.
 157  *
 158  */
 159 static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num,
 160                     int bits, int offs, int reserved_block_code)
 161 {
 162         int res, i, j, act = 0;
 163         struct nand_chip *this = mtd->priv;
 164         size_t retlen, len, totlen;
 165         loff_t from;
 166         uint8_t msk = (uint8_t) ((1 << bits) - 1);
 167
 168         totlen = (num * bits) >> 3;
 169         from = ((loff_t) page) << this->page_shift;
 170
 171         while (totlen) {
 172                 len = min(totlen, (size_t) (1 << this->bbt_erase_shift));
 173                 res = mtd->read(mtd, from, len, &retlen, buf);
 174                 if (res < 0) {
 175                         if (retlen != len) {
 176                                 printk(KERN_INFO "nand_bbt: Error reading bad block table\n");
 177                                 return res;
 178                         }
 179                         printk(KERN_WARNING "nand_bbt: ECC error while reading bad block table\n");
 180                 }
 181
 182                 /* Analyse data */
 183                 for (i = 0; i < len; i++) {
 184                         uint8_t dat = buf[i];
 185                         for (j = 0; j < 8; j += bits, act += 2) {
 186                                 uint8_t tmp = (dat >> j) & msk;
 187                                 if (tmp == msk)
 188                                         continue;
 189                                 if (reserved_block_code && (tmp == reserved_block_code)) {
 190                                         printk(KERN_DEBUG "nand_read_bbt: Reserved block at 0x%08x\n",
 191                                                ((offs << 2) + (act >> 1)) << this->bbt_erase_shift);
 192                                         this->bbt[offs + (act >> 3)] |= 0x2 << (act & 0x06);
 193                                         mtd->ecc_stats.bbtblocks++;
 194                                         continue;
 195                                 }
 196                                 /* Leave it for now, if its matured we can move this
 197                                  * message to MTD_DEBUG_LEVEL0 */
 198                                 printk(KERN_DEBUG "nand_read_bbt: Bad block at 0x%08x\n",
 199                                        ((offs << 2) + (act >> 1)) << this->bbt_erase_shift);
 200                                 /* Factory marked bad or worn out ? */
 201                                 if (tmp == 0)
 202                                         this->bbt[offs + (act >> 3)] |= 0x3 << (act & 0x06);
 203                                 else
 204                                         this->bbt[offs + (act >> 3)] |= 0x1 << (act & 0x06);
 205                                 mtd->ecc_stats.badblocks++;
 206                         }
 207                 }
 208                 totlen -= len;
 209                 from += len;
 210         }
 211         return 0;
 212 }
 213
 214 /**
 215  * read_abs_bbt - [GENERIC] Read the bad block table starting at a given page
 216  * @mtd:        MTD device structure
 217  * @buf:        temporary buffer
 218  * @td:         descriptor for the bad block table
 219  * @chip:       read the table for a specific chip, -1 read all chips.
 220  *              Applies only if NAND_BBT_PERCHIP option is set
 221  *
 222  * Read the bad block table for all chips starting at a given page
 223  * We assume that the bbt bits are in consecutive order.
 224 */
 225 static int read_abs_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td, int chip)
 226 {
 227         struct nand_chip *this = mtd->priv;
 228         int res = 0, i;
 229         int bits;
 230
 231         bits = td->options & NAND_BBT_NRBITS_MSK;
 232         if (td->options & NAND_BBT_PERCHIP) {
 233                 int offs = 0;
 234                 for (i = 0; i < this->numchips; i++) {
 235                         if (chip == -1 || chip == i)
 236                                 res = read_bbt (mtd, buf, td->pages[i], this->chipsize >> this->bbt_erase_shift, bits, offs, td->reserved_block_code);
 237                         if (res)
 238                                 return res;
 239                         offs += this->chipsize >> (this->bbt_erase_shift + 2);
 240                 }
 241         } else {
 242                 res = read_bbt (mtd, buf, td->pages[0], mtd->size >> this->bbt_erase_shift, bits, 0, td->reserved_block_code);
 243                 if (res)
 244                         return res;
 245         }
 246         return 0;
 247 }
 248
 249 /*
 250  * Scan read raw data from flash
 251  */
 252 static int scan_read_raw(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
 253                          size_t len)
 254 {
 255         struct mtd_oob_ops ops;
 256
 257         ops.mode = MTD_OOB_RAW;
 258         ops.ooboffs = 0;
 259         ops.ooblen = mtd->oobsize;
 260         ops.oobbuf = buf;
 261         ops.datbuf = buf;
 262         ops.len = len;
 263
 264         return mtd->read_oob(mtd, offs, &ops);
 265 }
 266
 267 /*
 268  * Scan write data with oob to flash
 269  */
 270 static int scan_write_bbt(struct mtd_info *mtd, loff_t offs, size_t len,
 271                           uint8_t *buf, uint8_t *oob)
 272 {
 273         struct mtd_oob_ops ops;
 274
 275         ops.mode = MTD_OOB_PLACE;
 276         ops.ooboffs = 0;
 277         ops.ooblen = mtd->oobsize;
 278         ops.datbuf = buf;
 279         ops.oobbuf = oob;
 280         ops.len = len;
 281
 282         return mtd->write_oob(mtd, offs, &ops);
 283 }
 284
 285 /**
 286  * read_abs_bbts - [GENERIC] Read the bad block table(s) for all chips starting at a given page
 287  * @mtd:        MTD device structure
 288  * @buf:        temporary buffer
 289  * @td:         descriptor for the bad block table
 290  * @md:         descriptor for the bad block table mirror
 291  *
 292  * Read the bad block table(s) for all chips starting at a given page
 293  * We assume that the bbt bits are in consecutive order.
 294  *
 295 */
 296 static int read_abs_bbts(struct mtd_info *mtd, uint8_t *buf,
 297                          struct nand_bbt_descr *td, struct nand_bbt_descr *md)
 298 {
 299         struct nand_chip *this = mtd->priv;
 300
 301         /* Read the primary version, if available */
 302         if (td->options & NAND_BBT_VERSION) {
 303                 scan_read_raw(mtd, buf, td->pages[0] << this->page_shift,
 304                               mtd->writesize);
 305                 td->version[0] = buf[mtd->writesize + td->veroffs];
 306                 printk(KERN_DEBUG "Bad block table at page %d, version 0x%02X\n",
 307                        td->pages[0], td->version[0]);
 308         }
 309
 310         /* Read the mirror version, if available */
 311         if (md && (md->options & NAND_BBT_VERSION)) {
 312                 scan_read_raw(mtd, buf, md->pages[0] << this->page_shift,
 313                               mtd->writesize);
 314                 md->version[0] = buf[mtd->writesize + md->veroffs];
 315                 printk(KERN_DEBUG "Bad block table at page %d, version 0x%02X\n",
 316                        md->pages[0], md->version[0]);
 317         }
 318         return 1;
 319 }
 320
 321 /*
 322  * Scan a given block full
 323  */
 324 static int scan_block_full(struct mtd_info *mtd, struct nand_bbt_descr *bd,
 325                            loff_t offs, uint8_t *buf, size_t readlen,
 326                            int scanlen, int len)
 327 {
 328         int ret, j;
 329
 330         ret = scan_read_raw(mtd, buf, offs, readlen);
 331         if (ret)
 332                 return ret;
 333
 334         for (j = 0; j < len; j++, buf += scanlen) {
 335                 if (check_pattern(buf, scanlen, mtd->writesize, bd))
 336                         return 1;
 337         }
 338         return 0;
 339 }
 340
 341 /*
 342  * Scan a given block partially
 343  */
 344 static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd,
 345                            loff_t offs, uint8_t *buf, int len)
 346 {
 347         struct mtd_oob_ops ops;
 348         int j, ret;
 349
 350         ops.ooblen = mtd->oobsize;
 351         ops.oobbuf = buf;
 352         ops.ooboffs = 0;
 353         ops.datbuf = NULL;
 354         ops.mode = MTD_OOB_PLACE;
 355
 356         for (j = 0; j < len; j++) {
 357                 /*
 358                  * Read the full oob until read_oob is fixed to
 359                  * handle single byte reads for 16 bit
 360                  * buswidth
 361                  */
 362                 ret = mtd->read_oob(mtd, offs, &ops);
 363                 if (ret)
 364                         return ret;
 365
 366                 if (check_short_pattern(buf, bd))
 367                         return 1;
 368
 369                 offs += mtd->writesize;
 370         }
 371         return 0;
 372 }
 373
 374 /**
 375  * create_bbt - [GENERIC] Create a bad block table by scanning the device
 376  * @mtd:        MTD device structure
 377  * @buf:        temporary buffer
 378  * @bd:         descriptor for the good/bad block search pattern
 379  * @chip:       create the table for a specific chip, -1 read all chips.
 380  *              Applies only if NAND_BBT_PERCHIP option is set
 381  *
 382  * Create a bad block table by scanning the device
 383  * for the given good/bad block identify pattern
 384  */
 385 static int create_bbt(struct mtd_info *mtd, uint8_t *buf,
 386         struct nand_bbt_descr *bd, int chip)
 387 {
 388         struct nand_chip *this = mtd->priv;
 389         int i, numblocks, len, scanlen;
 390         int startblock;
 391         loff_t from;
 392         size_t readlen;
 393
 394         MTDDEBUG (MTD_DEBUG_LEVEL0, "Scanning device for bad blocks\n");
 395
 396         if (bd->options & NAND_BBT_SCANALLPAGES)
 397                 len = 1 << (this->bbt_erase_shift - this->page_shift);
 398         else {
 399                 if (bd->options & NAND_BBT_SCAN2NDPAGE)
 400                         len = 2;
 401                 else
 402                         len = 1;
 403         }
 404
 405         if (!(bd->options & NAND_BBT_SCANEMPTY)) {
 406                 /* We need only read few bytes from the OOB area */
 407                 scanlen = 0;
 408                 readlen = bd->len;
 409         } else {
 410                 /* Full page content should be read */
 411                 scanlen = mtd->writesize + mtd->oobsize;
 412                 readlen = len * mtd->writesize;
 413         }
 414
 415         if (chip == -1) {
 416                 /* Note that numblocks is 2 * (real numblocks) here, see i+=2
 417                  * below as it makes shifting and masking less painful */
 418                 numblocks = mtd->size >> (this->bbt_erase_shift - 1);
 419                 startblock = 0;
 420                 from = 0;
 421         } else {
 422                 if (chip >= this->numchips) {
 423                         printk(KERN_WARNING "create_bbt(): chipnr (%d) > available chips (%d)\n",
 424                                chip + 1, this->numchips);
 425                         return -EINVAL;
 426                 }
 427                 numblocks = this->chipsize >> (this->bbt_erase_shift - 1);
 428                 startblock = chip * numblocks;
 429                 numblocks += startblock;
 430                 from = startblock << (this->bbt_erase_shift - 1);
 431         }
 432
 433         for (i = startblock; i < numblocks;) {
 434                 int ret;
 435
 436                 if (bd->options & NAND_BBT_SCANALLPAGES)
 437                         ret = scan_block_full(mtd, bd, from, buf, readlen,
 438                                               scanlen, len);
 439                 else
 440                         ret = scan_block_fast(mtd, bd, from, buf, len);
 441
 442                 if (ret < 0)
 443                         return ret;
 444
 445                 if (ret) {
 446                         this->bbt[i >> 3] |= 0x03 << (i & 0x6);
 447                         MTDDEBUG (MTD_DEBUG_LEVEL0,
 448                                   "Bad eraseblock %d at 0x%08x\n",
 449                                   i >> 1, (unsigned int)from);
 450                         mtd->ecc_stats.badblocks++;
 451                 }
 452
 453                 i += 2;
 454                 from += (1 << this->bbt_erase_shift);
 455         }
 456         return 0;
 457 }
 458
 459 /**
 460  * search_bbt - [GENERIC] scan the device for a specific bad block table
 461  * @mtd:        MTD device structure
 462  * @buf:        temporary buffer
 463  * @td:         descriptor for the bad block table
 464  *
 465  * Read the bad block table by searching for a given ident pattern.
 466  * Search is preformed either from the beginning up or from the end of
 467  * the device downwards. The search starts always at the start of a
 468  * block.
 469  * If the option NAND_BBT_PERCHIP is given, each chip is searched
 470  * for a bbt, which contains the bad block information of this chip.
 471  * This is necessary to provide support for certain DOC devices.
 472  *
 473  * The bbt ident pattern resides in the oob area of the first page
 474  * in a block.
 475  */
 476 static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td)
 477 {
 478         struct nand_chip *this = mtd->priv;
 479         int i, chips;
 480         int bits, startblock, block, dir;
 481         int scanlen = mtd->writesize + mtd->oobsize;
 482         int bbtblocks;
 483         int blocktopage = this->bbt_erase_shift - this->page_shift;
 484
 485         /* Search direction top -> down ? */
 486         if (td->options & NAND_BBT_LASTBLOCK) {
 487                 startblock = (mtd->size >> this->bbt_erase_shift) - 1;
 488                 dir = -1;
 489         } else {
 490                 startblock = 0;
 491                 dir = 1;
 492         }
 493
 494         /* Do we have a bbt per chip ? */
 495         if (td->options & NAND_BBT_PERCHIP) {
 496                 chips = this->numchips;
 497                 bbtblocks = this->chipsize >> this->bbt_erase_shift;
 498                 startblock &= bbtblocks - 1;
 499         } else {
 500                 chips = 1;
 501                 bbtblocks = mtd->size >> this->bbt_erase_shift;
 502         }
 503
 504         /* Number of bits for each erase block in the bbt */
 505         bits = td->options & NAND_BBT_NRBITS_MSK;
 506
 507         for (i = 0; i < chips; i++) {
 508                 /* Reset version information */
 509                 td->version[i] = 0;
 510                 td->pages[i] = -1;
 511                 /* Scan the maximum number of blocks */
 512                 for (block = 0; block < td->maxblocks; block++) {
 513
 514                         int actblock = startblock + dir * block;
 515                         loff_t offs = actblock << this->bbt_erase_shift;
 516
 517                         /* Read first page */
 518                         scan_read_raw(mtd, buf, offs, mtd->writesize);
 519                         if (!check_pattern(buf, scanlen, mtd->writesize, td)) {
 520                                 td->pages[i] = actblock << blocktopage;
 521                                 if (td->options & NAND_BBT_VERSION) {
 522                                         td->version[i] = buf[mtd->writesize + td->veroffs];
 523                                 }
 524                                 break;
 525                         }
 526                 }
 527                 startblock += this->chipsize >> this->bbt_erase_shift;
 528         }
 529         /* Check, if we found a bbt for each requested chip */
 530         for (i = 0; i < chips; i++) {
 531                 if (td->pages[i] == -1)
 532                         printk(KERN_WARNING "Bad block table not found for chip %d\n", i);
 533                 else
 534                         printk(KERN_DEBUG "Bad block table found at page %d, version 0x%02X\n", td->pages[i],
 535                                td->version[i]);
 536         }
 537         return 0;
 538 }
 539
 540 /**
 541  * search_read_bbts - [GENERIC] scan the device for bad block table(s)
 542  * @mtd:        MTD device structure
 543  * @buf:        temporary buffer
 544  * @td:         descriptor for the bad block table
 545  * @md:         descriptor for the bad block table mirror
 546  *
 547  * Search and read the bad block table(s)
 548 */
 549 static int search_read_bbts(struct mtd_info *mtd, uint8_t * buf, struct nand_bbt_descr *td, struct nand_bbt_descr *md)
 550 {
 551         /* Search the primary table */
 552         search_bbt(mtd, buf, td);
 553
 554         /* Search the mirror table */
 555         if (md)
 556                 search_bbt(mtd, buf, md);
 557
 558         /* Force result check */
 559         return 1;
 560 }
 561
 562 /**
 563  * write_bbt - [GENERIC] (Re)write the bad block table
 564  *
 565  * @mtd:        MTD device structure
 566  * @buf:        temporary buffer
 567  * @td:         descriptor for the bad block table
 568  * @md:         descriptor for the bad block table mirror
 569  * @chipsel:    selector for a specific chip, -1 for all
 570  *
 571  * (Re)write the bad block table
 572  *
 573 */
 574 static int write_bbt(struct mtd_info *mtd, uint8_t *buf,
 575                      struct nand_bbt_descr *td, struct nand_bbt_descr *md,
 576                      int chipsel)
 577 {
 578         struct nand_chip *this = mtd->priv;
 579         struct erase_info einfo;
 580         int i, j, res, chip = 0;
 581         int bits, startblock, dir, page, offs, numblocks, sft, sftmsk;
 582         int nrchips, bbtoffs, pageoffs, ooboffs;
 583         uint8_t msk[4];
 584         uint8_t rcode = td->reserved_block_code;
 585         size_t retlen, len = 0;
 586         loff_t to;
 587         struct mtd_oob_ops ops;
 588
 589         ops.ooblen = mtd->oobsize;
 590         ops.ooboffs = 0;
 591         ops.datbuf = NULL;
 592         ops.mode = MTD_OOB_PLACE;
 593
 594         if (!rcode)
 595                 rcode = 0xff;
 596         /* Write bad block table per chip rather than per device ? */
 597         if (td->options & NAND_BBT_PERCHIP) {
 598                 numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
 599                 /* Full device write or specific chip ? */
 600                 if (chipsel == -1) {
 601                         nrchips = this->numchips;
 602                 } else {
 603                         nrchips = chipsel + 1;
 604                         chip = chipsel;
 605                 }
 606         } else {
 607                 numblocks = (int)(mtd->size >> this->bbt_erase_shift);
 608                 nrchips = 1;
 609         }
 610
 611         /* Loop through the chips */
 612         for (; chip < nrchips; chip++) {
 613
 614                 /* There was already a version of the table, reuse the page
 615                  * This applies for absolute placement too, as we have the
 616                  * page nr. in td->pages.
 617                  */
 618                 if (td->pages[chip] != -1) {
 619                         page = td->pages[chip];
 620                         goto write;
 621                 }
 622
 623                 /* Automatic placement of the bad block table */
 624                 /* Search direction top -> down ? */
 625                 if (td->options & NAND_BBT_LASTBLOCK) {
 626                         startblock = numblocks * (chip + 1) - 1;
 627                         dir = -1;
 628                 } else {
 629                         startblock = chip * numblocks;
 630                         dir = 1;
 631                 }
 632
 633                 for (i = 0; i < td->maxblocks; i++) {
 634                         int block = startblock + dir * i;
 635                         /* Check, if the block is bad */
 636                         switch ((this->bbt[block >> 2] >>
 637                                  (2 * (block & 0x03))) & 0x03) {
 638                         case 0x01:
 639                         case 0x03:
 640                                 continue;
 641                         }
 642                         page = block <<
 643                                 (this->bbt_erase_shift - this->page_shift);
 644                         /* Check, if the block is used by the mirror table */
 645                         if (!md || md->pages[chip] != page)
 646                                 goto write;
 647                 }
 648                 printk(KERN_ERR "No space left to write bad block table\n");
 649                 return -ENOSPC;
 650         write:
 651
 652                 /* Set up shift count and masks for the flash table */
 653                 bits = td->options & NAND_BBT_NRBITS_MSK;
 654                 msk[2] = ~rcode;
 655                 switch (bits) {
 656                 case 1: sft = 3; sftmsk = 0x07; msk[0] = 0x00; msk[1] = 0x01;
 657                         msk[3] = 0x01;
 658                         break;
 659                 case 2: sft = 2; sftmsk = 0x06; msk[0] = 0x00; msk[1] = 0x01;
 660                         msk[3] = 0x03;
 661                         break;
 662                 case 4: sft = 1; sftmsk = 0x04; msk[0] = 0x00; msk[1] = 0x0C;
 663                         msk[3] = 0x0f;
 664                         break;
 665                 case 8: sft = 0; sftmsk = 0x00; msk[0] = 0x00; msk[1] = 0x0F;
 666                         msk[3] = 0xff;
 667                         break;
 668                 default: return -EINVAL;
 669                 }
 670
 671                 bbtoffs = chip * (numblocks >> 2);
 672
 673                 to = ((loff_t) page) << this->page_shift;
 674
 675                 /* Must we save the block contents ? */
 676                 if (td->options & NAND_BBT_SAVECONTENT) {
 677                         /* Make it block aligned */
 678                         to &= ~((loff_t) ((1 << this->bbt_erase_shift) - 1));
 679                         len = 1 << this->bbt_erase_shift;
 680                         res = mtd->read(mtd, to, len, &retlen, buf);
 681                         if (res < 0) {
 682                                 if (retlen != len) {
 683                                         printk(KERN_INFO "nand_bbt: Error "
 684                                                "reading block for writing "
 685                                                "the bad block table\n");
 686                                         return res;
 687                                 }
 688                                 printk(KERN_WARNING "nand_bbt: ECC error "
 689                                        "while reading block for writing "
 690                                        "bad block table\n");
 691                         }
 692                         /* Read oob data */
 693                         ops.ooblen = (len >> this->page_shift) * mtd->oobsize;
 694                         ops.oobbuf = &buf[len];
 695                         res = mtd->read_oob(mtd, to + mtd->writesize, &ops);
 696                         if (res < 0 || ops.oobretlen != ops.ooblen)
 697                                 goto outerr;
 698
 699                         /* Calc the byte offset in the buffer */
 700                         pageoffs = page - (int)(to >> this->page_shift);
 701                         offs = pageoffs << this->page_shift;
 702                         /* Preset the bbt area with 0xff */
 703                         memset(&buf[offs], 0xff, (size_t) (numblocks >> sft));
 704                         ooboffs = len + (pageoffs * mtd->oobsize);
 705
 706                 } else {
 707                         /* Calc length */
 708                         len = (size_t) (numblocks >> sft);
 709                         /* Make it page aligned ! */
 710                         len = (len + (mtd->writesize - 1)) &
 711                                 ~(mtd->writesize - 1);
 712                         /* Preset the buffer with 0xff */
 713                         memset(buf, 0xff, len +
 714                                (len >> this->page_shift)* mtd->oobsize);
 715                         offs = 0;
 716                         ooboffs = len;
 717                         /* Pattern is located in oob area of first page */
 718                         memcpy(&buf[ooboffs + td->offs], td->pattern, td->len);
 719                 }
 720
 721                 if (td->options & NAND_BBT_VERSION)
 722                         buf[ooboffs + td->veroffs] = td->version[chip];
 723
 724                 /* walk through the memory table */
 725                 for (i = 0; i < numblocks;) {
 726                         uint8_t dat;
 727                         dat = this->bbt[bbtoffs + (i >> 2)];
 728                         for (j = 0; j < 4; j++, i++) {
 729                                 int sftcnt = (i << (3 - sft)) & sftmsk;
 730                                 /* Do not store the reserved bbt blocks ! */
 731                                 buf[offs + (i >> sft)] &=
 732                                         ~(msk[dat & 0x03] << sftcnt);
 733                                 dat >>= 2;
 734                         }
 735                 }
 736
 737                 memset(&einfo, 0, sizeof(einfo));
 738                 einfo.mtd = mtd;
 739                 einfo.addr = (unsigned long)to;
 740                 einfo.len = 1 << this->bbt_erase_shift;
 741                 res = nand_erase_nand(mtd, &einfo, 1);
 742                 if (res < 0)
 743                         goto outerr;
 744
 745                 res = scan_write_bbt(mtd, to, len, buf, &buf[len]);
 746                 if (res < 0)
 747                         goto outerr;
 748
 749                 printk(KERN_DEBUG "Bad block table written to 0x%08x, version "
 750                        "0x%02X\n", (unsigned int)to, td->version[chip]);
 751
 752                 /* Mark it as used */
 753                 td->pages[chip] = page;
 754         }
 755         return 0;
 756
 757  outerr:
 758         printk(KERN_WARNING
 759                "nand_bbt: Error while writing bad block table %d\n", res);
 760         return res;
 761 }
 762
 763 /**
 764  * nand_memory_bbt - [GENERIC] create a memory based bad block table
 765  * @mtd:        MTD device structure
 766  * @bd:         descriptor for the good/bad block search pattern
 767  *
 768  * The function creates a memory based bbt by scanning the device
 769  * for manufacturer / software marked good / bad blocks
 770 */
 771 static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
 772 {
 773         struct nand_chip *this = mtd->priv;
 774
 775         bd->options &= ~NAND_BBT_SCANEMPTY;
 776         return create_bbt(mtd, this->buffers->databuf, bd, -1);
 777 }
 778
 779 /**
 780  * check_create - [GENERIC] create and write bbt(s) if necessary
 781  * @mtd:        MTD device structure
 782  * @buf:        temporary buffer
 783  * @bd:         descriptor for the good/bad block search pattern
 784  *
 785  * The function checks the results of the previous call to read_bbt
 786  * and creates / updates the bbt(s) if necessary
 787  * Creation is necessary if no bbt was found for the chip/device
 788  * Update is necessary if one of the tables is missing or the
 789  * version nr. of one table is less than the other
 790 */
 791 static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)
 792 {
 793         int i, chips, writeops, chipsel, res;
 794         struct nand_chip *this = mtd->priv;
 795         struct nand_bbt_descr *td = this->bbt_td;
 796         struct nand_bbt_descr *md = this->bbt_md;
 797         struct nand_bbt_descr *rd, *rd2;
 798
 799         /* Do we have a bbt per chip ? */
 800         if (td->options & NAND_BBT_PERCHIP)
 801                 chips = this->numchips;
 802         else
 803                 chips = 1;
 804
 805         for (i = 0; i < chips; i++) {
 806                 writeops = 0;
 807                 rd = NULL;
 808                 rd2 = NULL;
 809                 /* Per chip or per device ? */
 810                 chipsel = (td->options & NAND_BBT_PERCHIP) ? i : -1;
 811                 /* Mirrored table avilable ? */
 812                 if (md) {
 813                         if (td->pages[i] == -1 && md->pages[i] == -1) {
 814                                 writeops = 0x03;
 815                                 goto create;
 816                         }
 817
 818                         if (td->pages[i] == -1) {
 819                                 rd = md;
 820                                 td->version[i] = md->version[i];
 821                                 writeops = 1;
 822                                 goto writecheck;
 823                         }
 824
 825                         if (md->pages[i] == -1) {
 826                                 rd = td;
 827                                 md->version[i] = td->version[i];
 828                                 writeops = 2;
 829                                 goto writecheck;
 830                         }
 831
 832                         if (td->version[i] == md->version[i]) {
 833                                 rd = td;
 834                                 if (!(td->options & NAND_BBT_VERSION))
 835                                         rd2 = md;
 836                                 goto writecheck;
 837                         }
 838
 839                         if (((int8_t) (td->version[i] - md->version[i])) > 0) {
 840                                 rd = td;
 841                                 md->version[i] = td->version[i];
 842                                 writeops = 2;
 843                         } else {
 844                                 rd = md;
 845                                 td->version[i] = md->version[i];
 846                                 writeops = 1;
 847                         }
 848
 849                         goto writecheck;
 850
 851                 } else {
 852                         if (td->pages[i] == -1) {
 853                                 writeops = 0x01;
 854                                 goto create;
 855                         }
 856                         rd = td;
 857                         goto writecheck;
 858                 }
 859         create:
 860                 /* Create the bad block table by scanning the device ? */
 861                 if (!(td->options & NAND_BBT_CREATE))
 862                         continue;
 863
 864                 /* Create the table in memory by scanning the chip(s) */
 865                 create_bbt(mtd, buf, bd, chipsel);
 866
 867                 td->version[i] = 1;
 868                 if (md)
 869                         md->version[i] = 1;
 870         writecheck:
 871                 /* read back first ? */
 872                 if (rd)
 873                         read_abs_bbt(mtd, buf, rd, chipsel);
 874                 /* If they weren't versioned, read both. */
 875                 if (rd2)
 876                         read_abs_bbt(mtd, buf, rd2, chipsel);
 877
 878                 /* Write the bad block table to the device ? */
 879                 if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
 880                         res = write_bbt(mtd, buf, td, md, chipsel);
 881                         if (res < 0)
 882                                 return res;
 883                 }
 884
 885                 /* Write the mirror bad block table to the device ? */
 886                 if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
 887                         res = write_bbt(mtd, buf, md, td, chipsel);
 888                         if (res < 0)
 889                                 return res;
 890                 }
 891         }
 892         return 0;
 893 }
 894
 895 /**
 896  * mark_bbt_regions - [GENERIC] mark the bad block table regions
 897  * @mtd:        MTD device structure
 898  * @td:         bad block table descriptor
 899  *
 900  * The bad block table regions are marked as "bad" to prevent
 901  * accidental erasures / writes. The regions are identified by
 902  * the mark 0x02.
 903 */
 904 static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
 905 {
 906         struct nand_chip *this = mtd->priv;
 907         int i, j, chips, block, nrblocks, update;
 908         uint8_t oldval, newval;
 909
 910         /* Do we have a bbt per chip ? */
 911         if (td->options & NAND_BBT_PERCHIP) {
 912                 chips = this->numchips;
 913                 nrblocks = (int)(this->chipsize >> this->bbt_erase_shift);
 914         } else {
 915                 chips = 1;
 916                 nrblocks = (int)(mtd->size >> this->bbt_erase_shift);
 917         }
 918
 919         for (i = 0; i < chips; i++) {
 920                 if ((td->options & NAND_BBT_ABSPAGE) ||
 921                     !(td->options & NAND_BBT_WRITE)) {
 922                         if (td->pages[i] == -1)
 923                                 continue;
 924                         block = td->pages[i] >> (this->bbt_erase_shift - this->page_shift);
 925                         block <<= 1;
 926                         oldval = this->bbt[(block >> 3)];
 927                         newval = oldval | (0x2 << (block & 0x06));
 928                         this->bbt[(block >> 3)] = newval;
 929                         if ((oldval != newval) && td->reserved_block_code)
 930                                 nand_update_bbt(mtd, block << (this->bbt_erase_shift - 1));
 931                         continue;
 932                 }
 933                 update = 0;
 934                 if (td->options & NAND_BBT_LASTBLOCK)
 935                         block = ((i + 1) * nrblocks) - td->maxblocks;
 936                 else
 937                         block = i * nrblocks;
 938                 block <<= 1;
 939                 for (j = 0; j < td->maxblocks; j++) {
 940                         oldval = this->bbt[(block >> 3)];
 941                         newval = oldval | (0x2 << (block & 0x06));
 942                         this->bbt[(block >> 3)] = newval;
 943                         if (oldval != newval)
 944                                 update = 1;
 945                         block += 2;
 946                 }
 947                 /* If we want reserved blocks to be recorded to flash, and some
 948                    new ones have been marked, then we need to update the stored
 949                    bbts.  This should only happen once. */
 950                 if (update && td->reserved_block_code)
 951                         nand_update_bbt(mtd, (block - 2) << (this->bbt_erase_shift - 1));
 952         }
 953 }
 954
 955 /**
 956  * nand_scan_bbt - [NAND Interface] scan, find, read and maybe create bad block table(s)
 957  * @mtd:        MTD device structure
 958  * @bd:         descriptor for the good/bad block search pattern
 959  *
 960  * The function checks, if a bad block table(s) is/are already
 961  * available. If not it scans the device for manufacturer
 962  * marked good / bad blocks and writes the bad block table(s) to
 963  * the selected place.
 964  *
 965  * The bad block table memory is allocated here. It must be freed
 966  * by calling the nand_free_bbt function.
 967  *
 968 */
 969 int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
 970 {
 971         struct nand_chip *this = mtd->priv;
 972         int len, res = 0;
 973         uint8_t *buf;
 974         struct nand_bbt_descr *td = this->bbt_td;
 975         struct nand_bbt_descr *md = this->bbt_md;
 976
 977         len = mtd->size >> (this->bbt_erase_shift + 2);
 978         /* Allocate memory (2bit per block) and clear the memory bad block table */
 979         this->bbt = kzalloc(len, GFP_KERNEL);
 980         if (!this->bbt) {
 981                 printk(KERN_ERR "nand_scan_bbt: Out of memory\n");
 982                 return -ENOMEM;
 983         }
 984
 985         /* If no primary table decriptor is given, scan the device
 986          * to build a memory based bad block table
 987          */
 988         if (!td) {
 989                 if ((res = nand_memory_bbt(mtd, bd))) {
 990                         printk(KERN_ERR "nand_bbt: Can't scan flash and build the RAM-based BBT\n");
 991                         kfree(this->bbt);
 992                         this->bbt = NULL;
 993                 }
 994                 return res;
 995         }
 996
 997         /* Allocate a temporary buffer for one eraseblock incl. oob */
 998         len = (1 << this->bbt_erase_shift);
 999         len += (len >> this->page_shift) * mtd->oobsize;
1000         buf = vmalloc(len);
1001         if (!buf) {
1002                 printk(KERN_ERR "nand_bbt: Out of memory\n");
1003                 kfree(this->bbt);
1004                 this->bbt = NULL;
1005                 return -ENOMEM;
1006         }
1007
1008         /* Is the bbt at a given page ? */
1009         if (td->options & NAND_BBT_ABSPAGE) {
1010                 res = read_abs_bbts(mtd, buf, td, md);
1011         } else {
1012                 /* Search the bad block table using a pattern in oob */
1013                 res = search_read_bbts(mtd, buf, td, md);
1014         }
1015
1016         if (res)
1017                 res = check_create(mtd, buf, bd);
1018
1019         /* Prevent the bbt regions from erasing / writing */
1020         mark_bbt_region(mtd, td);
1021         if (md)
1022                 mark_bbt_region(mtd, md);
1023
1024         vfree(buf);
1025         return res;
1026 }
1027
1028 /**
1029  * nand_update_bbt - [NAND Interface] update bad block table(s)
1030  * @mtd:        MTD device structure
1031  * @offs:       the offset of the newly marked block
1032  *
1033  * The function updates the bad block table(s)
1034 */
1035 int nand_update_bbt(struct mtd_info *mtd, loff_t offs)
1036 {
1037         struct nand_chip *this = mtd->priv;
1038         int len, res = 0, writeops = 0;
1039         int chip, chipsel;
1040         uint8_t *buf;
1041         struct nand_bbt_descr *td = this->bbt_td;
1042         struct nand_bbt_descr *md = this->bbt_md;
1043
1044         if (!this->bbt || !td)
1045                 return -EINVAL;
1046
1047         len = mtd->size >> (this->bbt_erase_shift + 2);
1048         /* Allocate a temporary buffer for one eraseblock incl. oob */
1049         len = (1 << this->bbt_erase_shift);
1050         len += (len >> this->page_shift) * mtd->oobsize;
1051         buf = kmalloc(len, GFP_KERNEL);
1052         if (!buf) {
1053                 printk(KERN_ERR "nand_update_bbt: Out of memory\n");
1054                 return -ENOMEM;
1055         }
1056
1057         writeops = md != NULL ? 0x03 : 0x01;
1058
1059         /* Do we have a bbt per chip ? */
1060         if (td->options & NAND_BBT_PERCHIP) {
1061                 chip = (int)(offs >> this->chip_shift);
1062                 chipsel = chip;
1063         } else {
1064                 chip = 0;
1065                 chipsel = -1;
1066         }
1067
1068         td->version[chip]++;
1069         if (md)
1070                 md->version[chip]++;
1071
1072         /* Write the bad block table to the device ? */
1073         if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
1074                 res = write_bbt(mtd, buf, td, md, chipsel);
1075                 if (res < 0)
1076                         goto out;
1077         }
1078         /* Write the mirror bad block table to the device ? */
1079         if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
1080                 res = write_bbt(mtd, buf, md, td, chipsel);
1081         }
1082
1083  out:
1084         kfree(buf);
1085         return res;
1086 }
1087
1088 /* Define some generic bad / good block scan pattern which are used
1089  * while scanning a device for factory marked good / bad blocks. */
1090 static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
1091
1092 static struct nand_bbt_descr smallpage_memorybased = {
1093         .options = NAND_BBT_SCAN2NDPAGE,
1094         .offs = 5,
1095         .len = 1,
1096         .pattern = scan_ff_pattern
1097 };
1098
1099 static struct nand_bbt_descr largepage_memorybased = {
1100         .options = 0,
1101         .offs = 0,
1102         .len = 2,
1103         .pattern = scan_ff_pattern
1104 };
1105
1106 static struct nand_bbt_descr smallpage_flashbased = {
1107         .options = NAND_BBT_SCAN2NDPAGE,
1108         .offs = 5,
1109         .len = 1,
1110         .pattern = scan_ff_pattern
1111 };
1112
1113 static struct nand_bbt_descr largepage_flashbased = {
1114         .options = NAND_BBT_SCAN2NDPAGE,
1115         .offs = 0,
1116         .len = 2,
1117         .pattern = scan_ff_pattern
1118 };
1119
1120 static uint8_t scan_agand_pattern[] = { 0x1C, 0x71, 0xC7, 0x1C, 0x71, 0xC7 };
1121
1122 static struct nand_bbt_descr agand_flashbased = {
1123         .options = NAND_BBT_SCANEMPTY | NAND_BBT_SCANALLPAGES,
1124         .offs = 0x20,
1125         .len = 6,
1126         .pattern = scan_agand_pattern
1127 };
1128
1129 /* Generic flash bbt decriptors
1130 */
1131 static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1132 static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1133
1134 static struct nand_bbt_descr bbt_main_descr = {
1135         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1136                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1137         .offs = 8,
1138         .len = 4,
1139         .veroffs = 12,
1140         .maxblocks = 4,
1141         .pattern = bbt_pattern
1142 };
1143
1144 static struct nand_bbt_descr bbt_mirror_descr = {
1145         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1146                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1147         .offs = 8,
1148         .len = 4,
1149         .veroffs = 12,
1150         .maxblocks = 4,
1151         .pattern = mirror_pattern
1152 };
1153
1154 /**
1155  * nand_default_bbt - [NAND Interface] Select a default bad block table for the device
1156  * @mtd:        MTD device structure
1157  *
1158  * This function selects the default bad block table
1159  * support for the device and calls the nand_scan_bbt function
1160  *
1161 */
1162 int nand_default_bbt(struct mtd_info *mtd)
1163 {
1164         struct nand_chip *this = mtd->priv;
1165
1166         /* Default for AG-AND. We must use a flash based
1167          * bad block table as the devices have factory marked
1168          * _good_ blocks. Erasing those blocks leads to loss
1169          * of the good / bad information, so we _must_ store
1170          * this information in a good / bad table during
1171          * startup
1172          */
1173         if (this->options & NAND_IS_AND) {
1174                 /* Use the default pattern descriptors */
1175                 if (!this->bbt_td) {
1176                         this->bbt_td = &bbt_main_descr;
1177                         this->bbt_md = &bbt_mirror_descr;
1178                 }
1179                 this->options |= NAND_USE_FLASH_BBT;
1180                 return nand_scan_bbt(mtd, &agand_flashbased);
1181         }
1182
1183         /* Is a flash based bad block table requested ? */
1184         if (this->options & NAND_USE_FLASH_BBT) {
1185                 /* Use the default pattern descriptors */
1186                 if (!this->bbt_td) {
1187                         this->bbt_td = &bbt_main_descr;
1188                         this->bbt_md = &bbt_mirror_descr;
1189                 }
1190                 if (!this->badblock_pattern) {
1191                         this->badblock_pattern = (mtd->writesize > 512) ? &largepage_flashbased : &smallpage_flashbased;
1192                 }
1193         } else {
1194                 this->bbt_td = NULL;
1195                 this->bbt_md = NULL;
1196                 if (!this->badblock_pattern) {
1197                         this->badblock_pattern = (mtd->writesize > 512) ?
1198                             &largepage_memorybased : &smallpage_memorybased;
1199                 }
1200         }
1201         return nand_scan_bbt(mtd, this->badblock_pattern);
1202 }
1203
1204 /**
1205  * nand_isbad_bbt - [NAND Interface] Check if a block is bad
1206  * @mtd:        MTD device structure
1207  * @offs:       offset in the device
1208  * @allowbbt:   allow access to bad block table region
1209  *
1210 */
1211 int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
1212 {
1213         struct nand_chip *this = mtd->priv;
1214         int block;
1215         uint8_t res;
1216
1217         /* Get block number * 2 */
1218         block = (int)(offs >> (this->bbt_erase_shift - 1));
1219         res = (this->bbt[block >> 3] >> (block & 0x06)) & 0x03;
1220
1221         MTDDEBUG (MTD_DEBUG_LEVEL2, "nand_isbad_bbt(): bbt info for offs 0x%08x: "
1222                   "(block %d) 0x%02x\n", (unsigned int)offs, res, block >> 1);
1223
1224         switch ((int)res) {
1225         case 0x00:
1226                 return 0;
1227         case 0x01:
1228                 return 1;
1229         case 0x02:
1230                 return allowbbt ? 0 : 1;
1231         }
1232         return 1;
1233 }
1234
1235 /* XXX U-BOOT XXX */
1236 #if 0
1237 EXPORT_SYMBOL(nand_scan_bbt);
1238 EXPORT_SYMBOL(nand_default_bbt);
1239 #endif
1240
1241 #endif