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