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