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