drivers/mtd/nand/raw/nand_bbt.c

   1 /*
   2  *  Overview:
   3  *   Bad block table support for the NAND driver
   4  *
   5  *  Copyright © 2004 Thomas Gleixner (tglx@linutronix.de)
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  *
  11  * Description:
  12  *
  13  * When nand_scan_bbt is called, then it tries to find the bad block table
  14  * depending on the options in the BBT descriptor(s). If no flash based BBT
  15  * (NAND_BBT_USE_FLASH) is specified then the device is scanned for factory
  16  * marked good / bad blocks. This information is used to create a memory BBT.
  17  * Once a new bad block is discovered then the "factory" information is updated
  18  * on the device.
  19  * If a flash based BBT is specified then the function first tries to find the
  20  * BBT on flash. If a BBT is found then the contents are read and the memory
  21  * based BBT is created. If a mirrored BBT is selected then the mirror is
  22  * searched too and the versions are compared. If the mirror has a greater
  23  * version number, then the mirror BBT is used to build the memory based BBT.
  24  * If the tables are not versioned, then we "or" the bad block information.
  25  * If one of the BBTs is out of date or does not exist it is (re)created.
  26  * If no BBT exists at all then the device is scanned for factory marked
  27  * good / bad blocks and the bad block tables are created.
  28  *
  29  * For manufacturer created BBTs like the one found on M-SYS DOC devices
  30  * the BBT is searched and read but never created
  31  *
  32  * The auto generated bad block table is located in the last good blocks
  33  * of the device. The table is mirrored, so it can be updated eventually.
  34  * The table is marked in the OOB area with an ident pattern and a version
  35  * number which indicates which of both tables is more up to date. If the NAND
  36  * controller needs the complete OOB area for the ECC information then the
  37  * option NAND_BBT_NO_OOB should be used (along with NAND_BBT_USE_FLASH, of
  38  * course): it moves the ident pattern and the version byte into the data area
  39  * and the OOB area will remain untouched.
  40  *
  41  * The table uses 2 bits per block
  42  * 11b:         block is good
  43  * 00b:         block is factory marked bad
  44  * 01b, 10b:    block is marked bad due to wear
  45  *
  46  * The memory bad block table uses the following scheme:
  47  * 00b:         block is good
  48  * 01b:         block is marked bad due to wear
  49  * 10b:         block is reserved (to protect the bbt area)
  50  * 11b:         block is factory marked bad
  51  *
  52  * Multichip devices like DOC store the bad block info per floor.
  53  *
  54  * Following assumptions are made:
  55  * - bbts start at a page boundary, if autolocated on a block boundary
  56  * - the space necessary for a bbt in FLASH does not exceed a block boundary
  57  *
  58  */
  59
  60 #include <linux/slab.h>
  61 #include <linux/types.h>
  62 #include <linux/mtd/mtd.h>
  63 #include <linux/mtd/bbm.h>
  64 #include <linux/bitops.h>
  65 #include <linux/delay.h>
  66 #include <linux/vmalloc.h>
  67 #include <linux/export.h>
  68 #include <linux/string.h>
  69
  70 #include "internals.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_to_nand(mtd);
 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 0x%012llx\n",
 203                                         from & ~mtd->writesize);
 204                                 return res;
 205                         } else if (mtd_is_bitflip(res)) {
 206                                 pr_info("nand_bbt: corrected error in BBT at 0x%012llx\n",
 207                                         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_to_nand(mtd);
 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_to_nand(mtd);
 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_to_nand(mtd);
 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_to_nand(mtd);
 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 0x%02X\n",
 582                                 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  * get_bbt_block - Get the first valid eraseblock suitable to store a BBT
 610  * @this: the NAND device
 611  * @td: the BBT description
 612  * @md: the mirror BBT descriptor
 613  * @chip: the CHIP selector
 614  *
 615  * This functions returns a positive block number pointing a valid eraseblock
 616  * suitable to store a BBT (i.e. in the range reserved for BBT), or -ENOSPC if
 617  * all blocks are already used of marked bad. If td->pages[chip] was already
 618  * pointing to a valid block we re-use it, otherwise we search for the next
 619  * valid one.
 620  */
 621 static int get_bbt_block(struct nand_chip *this, struct nand_bbt_descr *td,
 622                          struct nand_bbt_descr *md, int chip)
 623 {
 624         int startblock, dir, page, numblocks, i;
 625
 626         /*
 627          * There was already a version of the table, reuse the page. This
 628          * applies for absolute placement too, as we have the page number in
 629          * td->pages.
 630          */
 631         if (td->pages[chip] != -1)
 632                 return td->pages[chip] >>
 633                                 (this->bbt_erase_shift - this->page_shift);
 634
 635         numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
 636         if (!(td->options & NAND_BBT_PERCHIP))
 637                 numblocks *= this->numchips;
 638
 639         /*
 640          * Automatic placement of the bad block table. Search direction
 641          * top -> down?
 642          */
 643         if (td->options & NAND_BBT_LASTBLOCK) {
 644                 startblock = numblocks * (chip + 1) - 1;
 645                 dir = -1;
 646         } else {
 647                 startblock = chip * numblocks;
 648                 dir = 1;
 649         }
 650
 651         for (i = 0; i < td->maxblocks; i++) {
 652                 int block = startblock + dir * i;
 653
 654                 /* Check, if the block is bad */
 655                 switch (bbt_get_entry(this, block)) {
 656                 case BBT_BLOCK_WORN:
 657                 case BBT_BLOCK_FACTORY_BAD:
 658                         continue;
 659                 }
 660
 661                 page = block << (this->bbt_erase_shift - this->page_shift);
 662
 663                 /* Check, if the block is used by the mirror table */
 664                 if (!md || md->pages[chip] != page)
 665                         return block;
 666         }
 667
 668         return -ENOSPC;
 669 }
 670
 671 /**
 672  * mark_bbt_block_bad - Mark one of the block reserved for BBT bad
 673  * @this: the NAND device
 674  * @td: the BBT description
 675  * @chip: the CHIP selector
 676  * @block: the BBT block to mark
 677  *
 678  * Blocks reserved for BBT can become bad. This functions is an helper to mark
 679  * such blocks as bad. It takes care of updating the in-memory BBT, marking the
 680  * block as bad using a bad block marker and invalidating the associated
 681  * td->pages[] entry.
 682  */
 683 static void mark_bbt_block_bad(struct nand_chip *this,
 684                                struct nand_bbt_descr *td,
 685                                int chip, int block)
 686 {
 687         loff_t to;
 688         int res;
 689
 690         bbt_mark_entry(this, block, BBT_BLOCK_WORN);
 691
 692         to = (loff_t)block << this->bbt_erase_shift;
 693         res = nand_markbad_bbm(this, to);
 694         if (res)
 695                 pr_warn("nand_bbt: error %d while marking block %d bad\n",
 696                         res, block);
 697
 698         td->pages[chip] = -1;
 699 }
 700
 701 /**
 702  * write_bbt - [GENERIC] (Re)write the bad block table
 703  * @mtd: MTD device structure
 704  * @buf: temporary buffer
 705  * @td: descriptor for the bad block table
 706  * @md: descriptor for the bad block table mirror
 707  * @chipsel: selector for a specific chip, -1 for all
 708  *
 709  * (Re)write the bad block table.
 710  */
 711 static int write_bbt(struct mtd_info *mtd, uint8_t *buf,
 712                      struct nand_bbt_descr *td, struct nand_bbt_descr *md,
 713                      int chipsel)
 714 {
 715         struct nand_chip *this = mtd_to_nand(mtd);
 716         struct erase_info einfo;
 717         int i, res, chip = 0;
 718         int bits, page, offs, numblocks, sft, sftmsk;
 719         int nrchips, pageoffs, ooboffs;
 720         uint8_t msk[4];
 721         uint8_t rcode = td->reserved_block_code;
 722         size_t retlen, len = 0;
 723         loff_t to;
 724         struct mtd_oob_ops ops;
 725
 726         ops.ooblen = mtd->oobsize;
 727         ops.ooboffs = 0;
 728         ops.datbuf = NULL;
 729         ops.mode = MTD_OPS_PLACE_OOB;
 730
 731         if (!rcode)
 732                 rcode = 0xff;
 733         /* Write bad block table per chip rather than per device? */
 734         if (td->options & NAND_BBT_PERCHIP) {
 735                 numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
 736                 /* Full device write or specific chip? */
 737                 if (chipsel == -1) {
 738                         nrchips = this->numchips;
 739                 } else {
 740                         nrchips = chipsel + 1;
 741                         chip = chipsel;
 742                 }
 743         } else {
 744                 numblocks = (int)(mtd->size >> this->bbt_erase_shift);
 745                 nrchips = 1;
 746         }
 747
 748         /* Loop through the chips */
 749         while (chip < nrchips) {
 750                 int block;
 751
 752                 block = get_bbt_block(this, td, md, chip);
 753                 if (block < 0) {
 754                         pr_err("No space left to write bad block table\n");
 755                         res = block;
 756                         goto outerr;
 757                 }
 758
 759                 /*
 760                  * get_bbt_block() returns a block number, shift the value to
 761                  * get a page number.
 762                  */
 763                 page = block << (this->bbt_erase_shift - this->page_shift);
 764
 765                 /* Set up shift count and masks for the flash table */
 766                 bits = td->options & NAND_BBT_NRBITS_MSK;
 767                 msk[2] = ~rcode;
 768                 switch (bits) {
 769                 case 1: sft = 3; sftmsk = 0x07; msk[0] = 0x00; msk[1] = 0x01;
 770                         msk[3] = 0x01;
 771                         break;
 772                 case 2: sft = 2; sftmsk = 0x06; msk[0] = 0x00; msk[1] = 0x01;
 773                         msk[3] = 0x03;
 774                         break;
 775                 case 4: sft = 1; sftmsk = 0x04; msk[0] = 0x00; msk[1] = 0x0C;
 776                         msk[3] = 0x0f;
 777                         break;
 778                 case 8: sft = 0; sftmsk = 0x00; msk[0] = 0x00; msk[1] = 0x0F;
 779                         msk[3] = 0xff;
 780                         break;
 781                 default: return -EINVAL;
 782                 }
 783
 784                 to = ((loff_t)page) << this->page_shift;
 785
 786                 /* Must we save the block contents? */
 787                 if (td->options & NAND_BBT_SAVECONTENT) {
 788                         /* Make it block aligned */
 789                         to &= ~(((loff_t)1 << this->bbt_erase_shift) - 1);
 790                         len = 1 << this->bbt_erase_shift;
 791                         res = mtd_read(mtd, to, len, &retlen, buf);
 792                         if (res < 0) {
 793                                 if (retlen != len) {
 794                                         pr_info("nand_bbt: error reading block for writing the bad block table\n");
 795                                         return res;
 796                                 }
 797                                 pr_warn("nand_bbt: ECC error while reading block for writing bad block table\n");
 798                         }
 799                         /* Read oob data */
 800                         ops.ooblen = (len >> this->page_shift) * mtd->oobsize;
 801                         ops.oobbuf = &buf[len];
 802                         res = mtd_read_oob(mtd, to + mtd->writesize, &ops);
 803                         if (res < 0 || ops.oobretlen != ops.ooblen)
 804                                 goto outerr;
 805
 806                         /* Calc the byte offset in the buffer */
 807                         pageoffs = page - (int)(to >> this->page_shift);
 808                         offs = pageoffs << this->page_shift;
 809                         /* Preset the bbt area with 0xff */
 810                         memset(&buf[offs], 0xff, (size_t)(numblocks >> sft));
 811                         ooboffs = len + (pageoffs * mtd->oobsize);
 812
 813                 } else if (td->options & NAND_BBT_NO_OOB) {
 814                         ooboffs = 0;
 815                         offs = td->len;
 816                         /* The version byte */
 817                         if (td->options & NAND_BBT_VERSION)
 818                                 offs++;
 819                         /* Calc length */
 820                         len = (size_t)(numblocks >> sft);
 821                         len += offs;
 822                         /* Make it page aligned! */
 823                         len = ALIGN(len, mtd->writesize);
 824                         /* Preset the buffer with 0xff */
 825                         memset(buf, 0xff, len);
 826                         /* Pattern is located at the begin of first page */
 827                         memcpy(buf, td->pattern, td->len);
 828                 } else {
 829                         /* Calc length */
 830                         len = (size_t)(numblocks >> sft);
 831                         /* Make it page aligned! */
 832                         len = ALIGN(len, mtd->writesize);
 833                         /* Preset the buffer with 0xff */
 834                         memset(buf, 0xff, len +
 835                                (len >> this->page_shift)* mtd->oobsize);
 836                         offs = 0;
 837                         ooboffs = len;
 838                         /* Pattern is located in oob area of first page */
 839                         memcpy(&buf[ooboffs + td->offs], td->pattern, td->len);
 840                 }
 841
 842                 if (td->options & NAND_BBT_VERSION)
 843                         buf[ooboffs + td->veroffs] = td->version[chip];
 844
 845                 /* Walk through the memory table */
 846                 for (i = 0; i < numblocks; i++) {
 847                         uint8_t dat;
 848                         int sftcnt = (i << (3 - sft)) & sftmsk;
 849                         dat = bbt_get_entry(this, chip * numblocks + i);
 850                         /* Do not store the reserved bbt blocks! */
 851                         buf[offs + (i >> sft)] &= ~(msk[dat] << sftcnt);
 852                 }
 853
 854                 memset(&einfo, 0, sizeof(einfo));
 855                 einfo.addr = to;
 856                 einfo.len = 1 << this->bbt_erase_shift;
 857                 res = nand_erase_nand(this, &einfo, 1);
 858                 if (res < 0) {
 859                         pr_warn("nand_bbt: error while erasing BBT block %d\n",
 860                                 res);
 861                         mark_bbt_block_bad(this, td, chip, block);
 862                         continue;
 863                 }
 864
 865                 res = scan_write_bbt(mtd, to, len, buf,
 866                                 td->options & NAND_BBT_NO_OOB ? NULL :
 867                                 &buf[len]);
 868                 if (res < 0) {
 869                         pr_warn("nand_bbt: error while writing BBT block %d\n",
 870                                 res);
 871                         mark_bbt_block_bad(this, td, chip, block);
 872                         continue;
 873                 }
 874
 875                 pr_info("Bad block table written to 0x%012llx, version 0x%02X\n",
 876                          (unsigned long long)to, td->version[chip]);
 877
 878                 /* Mark it as used */
 879                 td->pages[chip++] = page;
 880         }
 881         return 0;
 882
 883  outerr:
 884         pr_warn("nand_bbt: error while writing bad block table %d\n", res);
 885         return res;
 886 }
 887
 888 /**
 889  * nand_memory_bbt - [GENERIC] create a memory based bad block table
 890  * @mtd: MTD device structure
 891  * @bd: descriptor for the good/bad block search pattern
 892  *
 893  * The function creates a memory based bbt by scanning the device for
 894  * manufacturer / software marked good / bad blocks.
 895  */
 896 static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
 897 {
 898         struct nand_chip *this = mtd_to_nand(mtd);
 899
 900         return create_bbt(mtd, this->data_buf, bd, -1);
 901 }
 902
 903 /**
 904  * check_create - [GENERIC] create and write bbt(s) if necessary
 905  * @mtd: MTD device structure
 906  * @buf: temporary buffer
 907  * @bd: descriptor for the good/bad block search pattern
 908  *
 909  * The function checks the results of the previous call to read_bbt and creates
 910  * / updates the bbt(s) if necessary. Creation is necessary if no bbt was found
 911  * for the chip/device. Update is necessary if one of the tables is missing or
 912  * the version nr. of one table is less than the other.
 913  */
 914 static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)
 915 {
 916         int i, chips, writeops, create, chipsel, res, res2;
 917         struct nand_chip *this = mtd_to_nand(mtd);
 918         struct nand_bbt_descr *td = this->bbt_td;
 919         struct nand_bbt_descr *md = this->bbt_md;
 920         struct nand_bbt_descr *rd, *rd2;
 921
 922         /* Do we have a bbt per chip? */
 923         if (td->options & NAND_BBT_PERCHIP)
 924                 chips = this->numchips;
 925         else
 926                 chips = 1;
 927
 928         for (i = 0; i < chips; i++) {
 929                 writeops = 0;
 930                 create = 0;
 931                 rd = NULL;
 932                 rd2 = NULL;
 933                 res = res2 = 0;
 934                 /* Per chip or per device? */
 935                 chipsel = (td->options & NAND_BBT_PERCHIP) ? i : -1;
 936                 /* Mirrored table available? */
 937                 if (md) {
 938                         if (td->pages[i] == -1 && md->pages[i] == -1) {
 939                                 create = 1;
 940                                 writeops = 0x03;
 941                         } else if (td->pages[i] == -1) {
 942                                 rd = md;
 943                                 writeops = 0x01;
 944                         } else if (md->pages[i] == -1) {
 945                                 rd = td;
 946                                 writeops = 0x02;
 947                         } else if (td->version[i] == md->version[i]) {
 948                                 rd = td;
 949                                 if (!(td->options & NAND_BBT_VERSION))
 950                                         rd2 = md;
 951                         } else if (((int8_t)(td->version[i] - md->version[i])) > 0) {
 952                                 rd = td;
 953                                 writeops = 0x02;
 954                         } else {
 955                                 rd = md;
 956                                 writeops = 0x01;
 957                         }
 958                 } else {
 959                         if (td->pages[i] == -1) {
 960                                 create = 1;
 961                                 writeops = 0x01;
 962                         } else {
 963                                 rd = td;
 964                         }
 965                 }
 966
 967                 if (create) {
 968                         /* Create the bad block table by scanning the device? */
 969                         if (!(td->options & NAND_BBT_CREATE))
 970                                 continue;
 971
 972                         /* Create the table in memory by scanning the chip(s) */
 973                         if (!(this->bbt_options & NAND_BBT_CREATE_EMPTY))
 974                                 create_bbt(mtd, buf, bd, chipsel);
 975
 976                         td->version[i] = 1;
 977                         if (md)
 978                                 md->version[i] = 1;
 979                 }
 980
 981                 /* Read back first? */
 982                 if (rd) {
 983                         res = read_abs_bbt(mtd, buf, rd, chipsel);
 984                         if (mtd_is_eccerr(res)) {
 985                                 /* Mark table as invalid */
 986                                 rd->pages[i] = -1;
 987                                 rd->version[i] = 0;
 988                                 i--;
 989                                 continue;
 990                         }
 991                 }
 992                 /* If they weren't versioned, read both */
 993                 if (rd2) {
 994                         res2 = read_abs_bbt(mtd, buf, rd2, chipsel);
 995                         if (mtd_is_eccerr(res2)) {
 996                                 /* Mark table as invalid */
 997                                 rd2->pages[i] = -1;
 998                                 rd2->version[i] = 0;
 999                                 i--;
1000                                 continue;
1001                         }
1002                 }
1003
1004                 /* Scrub the flash table(s)? */
1005                 if (mtd_is_bitflip(res) || mtd_is_bitflip(res2))
1006                         writeops = 0x03;
1007
1008                 /* Update version numbers before writing */
1009                 if (md) {
1010                         td->version[i] = max(td->version[i], md->version[i]);
1011                         md->version[i] = td->version[i];
1012                 }
1013
1014                 /* Write the bad block table to the device? */
1015                 if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
1016                         res = write_bbt(mtd, buf, td, md, chipsel);
1017                         if (res < 0)
1018                                 return res;
1019                 }
1020
1021                 /* Write the mirror bad block table to the device? */
1022                 if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
1023                         res = write_bbt(mtd, buf, md, td, chipsel);
1024                         if (res < 0)
1025                                 return res;
1026                 }
1027         }
1028         return 0;
1029 }
1030
1031 /**
1032  * mark_bbt_regions - [GENERIC] mark the bad block table regions
1033  * @mtd: MTD device structure
1034  * @td: bad block table descriptor
1035  *
1036  * The bad block table regions are marked as "bad" to prevent accidental
1037  * erasures / writes. The regions are identified by the mark 0x02.
1038  */
1039 static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
1040 {
1041         struct nand_chip *this = mtd_to_nand(mtd);
1042         int i, j, chips, block, nrblocks, update;
1043         uint8_t oldval;
1044
1045         /* Do we have a bbt per chip? */
1046         if (td->options & NAND_BBT_PERCHIP) {
1047                 chips = this->numchips;
1048                 nrblocks = (int)(this->chipsize >> this->bbt_erase_shift);
1049         } else {
1050                 chips = 1;
1051                 nrblocks = (int)(mtd->size >> this->bbt_erase_shift);
1052         }
1053
1054         for (i = 0; i < chips; i++) {
1055                 if ((td->options & NAND_BBT_ABSPAGE) ||
1056                     !(td->options & NAND_BBT_WRITE)) {
1057                         if (td->pages[i] == -1)
1058                                 continue;
1059                         block = td->pages[i] >> (this->bbt_erase_shift - this->page_shift);
1060                         oldval = bbt_get_entry(this, block);
1061                         bbt_mark_entry(this, block, BBT_BLOCK_RESERVED);
1062                         if ((oldval != BBT_BLOCK_RESERVED) &&
1063                                         td->reserved_block_code)
1064                                 nand_update_bbt(mtd, (loff_t)block <<
1065                                                 this->bbt_erase_shift);
1066                         continue;
1067                 }
1068                 update = 0;
1069                 if (td->options & NAND_BBT_LASTBLOCK)
1070                         block = ((i + 1) * nrblocks) - td->maxblocks;
1071                 else
1072                         block = i * nrblocks;
1073                 for (j = 0; j < td->maxblocks; j++) {
1074                         oldval = bbt_get_entry(this, block);
1075                         bbt_mark_entry(this, block, BBT_BLOCK_RESERVED);
1076                         if (oldval != BBT_BLOCK_RESERVED)
1077                                 update = 1;
1078                         block++;
1079                 }
1080                 /*
1081                  * If we want reserved blocks to be recorded to flash, and some
1082                  * new ones have been marked, then we need to update the stored
1083                  * bbts.  This should only happen once.
1084                  */
1085                 if (update && td->reserved_block_code)
1086                         nand_update_bbt(mtd, (loff_t)(block - 1) <<
1087                                         this->bbt_erase_shift);
1088         }
1089 }
1090
1091 /**
1092  * verify_bbt_descr - verify the bad block description
1093  * @mtd: MTD device structure
1094  * @bd: the table to verify
1095  *
1096  * This functions performs a few sanity checks on the bad block description
1097  * table.
1098  */
1099 static void verify_bbt_descr(struct mtd_info *mtd, struct nand_bbt_descr *bd)
1100 {
1101         struct nand_chip *this = mtd_to_nand(mtd);
1102         u32 pattern_len;
1103         u32 bits;
1104         u32 table_size;
1105
1106         if (!bd)
1107                 return;
1108
1109         pattern_len = bd->len;
1110         bits = bd->options & NAND_BBT_NRBITS_MSK;
1111
1112         BUG_ON((this->bbt_options & NAND_BBT_NO_OOB) &&
1113                         !(this->bbt_options & NAND_BBT_USE_FLASH));
1114         BUG_ON(!bits);
1115
1116         if (bd->options & NAND_BBT_VERSION)
1117                 pattern_len++;
1118
1119         if (bd->options & NAND_BBT_NO_OOB) {
1120                 BUG_ON(!(this->bbt_options & NAND_BBT_USE_FLASH));
1121                 BUG_ON(!(this->bbt_options & NAND_BBT_NO_OOB));
1122                 BUG_ON(bd->offs);
1123                 if (bd->options & NAND_BBT_VERSION)
1124                         BUG_ON(bd->veroffs != bd->len);
1125                 BUG_ON(bd->options & NAND_BBT_SAVECONTENT);
1126         }
1127
1128         if (bd->options & NAND_BBT_PERCHIP)
1129                 table_size = this->chipsize >> this->bbt_erase_shift;
1130         else
1131                 table_size = mtd->size >> this->bbt_erase_shift;
1132         table_size >>= 3;
1133         table_size *= bits;
1134         if (bd->options & NAND_BBT_NO_OOB)
1135                 table_size += pattern_len;
1136         BUG_ON(table_size > (1 << this->bbt_erase_shift));
1137 }
1138
1139 /**
1140  * nand_scan_bbt - [NAND Interface] scan, find, read and maybe create bad block table(s)
1141  * @mtd: MTD device structure
1142  * @bd: descriptor for the good/bad block search pattern
1143  *
1144  * The function checks, if a bad block table(s) is/are already available. If
1145  * not it scans the device for manufacturer marked good / bad blocks and writes
1146  * the bad block table(s) to the selected place.
1147  *
1148  * The bad block table memory is allocated here. It must be freed by calling
1149  * the nand_free_bbt function.
1150  */
1151 static int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
1152 {
1153         struct nand_chip *this = mtd_to_nand(mtd);
1154         int len, res;
1155         uint8_t *buf;
1156         struct nand_bbt_descr *td = this->bbt_td;
1157         struct nand_bbt_descr *md = this->bbt_md;
1158
1159         len = (mtd->size >> (this->bbt_erase_shift + 2)) ? : 1;
1160         /*
1161          * Allocate memory (2bit per block) and clear the memory bad block
1162          * table.
1163          */
1164         this->bbt = kzalloc(len, GFP_KERNEL);
1165         if (!this->bbt)
1166                 return -ENOMEM;
1167
1168         /*
1169          * If no primary table decriptor is given, scan the device to build a
1170          * memory based bad block table.
1171          */
1172         if (!td) {
1173                 if ((res = nand_memory_bbt(mtd, bd))) {
1174                         pr_err("nand_bbt: can't scan flash and build the RAM-based BBT\n");
1175                         goto err;
1176                 }
1177                 return 0;
1178         }
1179         verify_bbt_descr(mtd, td);
1180         verify_bbt_descr(mtd, md);
1181
1182         /* Allocate a temporary buffer for one eraseblock incl. oob */
1183         len = (1 << this->bbt_erase_shift);
1184         len += (len >> this->page_shift) * mtd->oobsize;
1185         buf = vmalloc(len);
1186         if (!buf) {
1187                 res = -ENOMEM;
1188                 goto err;
1189         }
1190
1191         /* Is the bbt at a given page? */
1192         if (td->options & NAND_BBT_ABSPAGE) {
1193                 read_abs_bbts(mtd, buf, td, md);
1194         } else {
1195                 /* Search the bad block table using a pattern in oob */
1196                 search_read_bbts(mtd, buf, td, md);
1197         }
1198
1199         res = check_create(mtd, buf, bd);
1200         if (res)
1201                 goto err;
1202
1203         /* Prevent the bbt regions from erasing / writing */
1204         mark_bbt_region(mtd, td);
1205         if (md)
1206                 mark_bbt_region(mtd, md);
1207
1208         vfree(buf);
1209         return 0;
1210
1211 err:
1212         kfree(this->bbt);
1213         this->bbt = NULL;
1214         return res;
1215 }
1216
1217 /**
1218  * nand_update_bbt - update bad block table(s)
1219  * @mtd: MTD device structure
1220  * @offs: the offset of the newly marked block
1221  *
1222  * The function updates the bad block table(s).
1223  */
1224 static int nand_update_bbt(struct mtd_info *mtd, loff_t offs)
1225 {
1226         struct nand_chip *this = mtd_to_nand(mtd);
1227         int len, res = 0;
1228         int chip, chipsel;
1229         uint8_t *buf;
1230         struct nand_bbt_descr *td = this->bbt_td;
1231         struct nand_bbt_descr *md = this->bbt_md;
1232
1233         if (!this->bbt || !td)
1234                 return -EINVAL;
1235
1236         /* Allocate a temporary buffer for one eraseblock incl. oob */
1237         len = (1 << this->bbt_erase_shift);
1238         len += (len >> this->page_shift) * mtd->oobsize;
1239         buf = kmalloc(len, GFP_KERNEL);
1240         if (!buf)
1241                 return -ENOMEM;
1242
1243         /* Do we have a bbt per chip? */
1244         if (td->options & NAND_BBT_PERCHIP) {
1245                 chip = (int)(offs >> this->chip_shift);
1246                 chipsel = chip;
1247         } else {
1248                 chip = 0;
1249                 chipsel = -1;
1250         }
1251
1252         td->version[chip]++;
1253         if (md)
1254                 md->version[chip]++;
1255
1256         /* Write the bad block table to the device? */
1257         if (td->options & NAND_BBT_WRITE) {
1258                 res = write_bbt(mtd, buf, td, md, chipsel);
1259                 if (res < 0)
1260                         goto out;
1261         }
1262         /* Write the mirror bad block table to the device? */
1263         if (md && (md->options & NAND_BBT_WRITE)) {
1264                 res = write_bbt(mtd, buf, md, td, chipsel);
1265         }
1266
1267  out:
1268         kfree(buf);
1269         return res;
1270 }
1271
1272 /*
1273  * Define some generic bad / good block scan pattern which are used
1274  * while scanning a device for factory marked good / bad blocks.
1275  */
1276 static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
1277
1278 /* Generic flash bbt descriptors */
1279 static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1280 static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1281
1282 static struct nand_bbt_descr bbt_main_descr = {
1283         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1284                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1285         .offs = 8,
1286         .len = 4,
1287         .veroffs = 12,
1288         .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
1289         .pattern = bbt_pattern
1290 };
1291
1292 static struct nand_bbt_descr bbt_mirror_descr = {
1293         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1294                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1295         .offs = 8,
1296         .len = 4,
1297         .veroffs = 12,
1298         .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
1299         .pattern = mirror_pattern
1300 };
1301
1302 static struct nand_bbt_descr bbt_main_no_oob_descr = {
1303         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1304                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1305                 | NAND_BBT_NO_OOB,
1306         .len = 4,
1307         .veroffs = 4,
1308         .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
1309         .pattern = bbt_pattern
1310 };
1311
1312 static struct nand_bbt_descr bbt_mirror_no_oob_descr = {
1313         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1314                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1315                 | NAND_BBT_NO_OOB,
1316         .len = 4,
1317         .veroffs = 4,
1318         .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
1319         .pattern = mirror_pattern
1320 };
1321
1322 #define BADBLOCK_SCAN_MASK (~NAND_BBT_NO_OOB)
1323 /**
1324  * nand_create_badblock_pattern - [INTERN] Creates a BBT descriptor structure
1325  * @this: NAND chip to create descriptor for
1326  *
1327  * This function allocates and initializes a nand_bbt_descr for BBM detection
1328  * based on the properties of @this. The new descriptor is stored in
1329  * this->badblock_pattern. Thus, this->badblock_pattern should be NULL when
1330  * passed to this function.
1331  */
1332 static int nand_create_badblock_pattern(struct nand_chip *this)
1333 {
1334         struct nand_bbt_descr *bd;
1335         if (this->badblock_pattern) {
1336                 pr_warn("Bad block pattern already allocated; not replacing\n");
1337                 return -EINVAL;
1338         }
1339         bd = kzalloc(sizeof(*bd), GFP_KERNEL);
1340         if (!bd)
1341                 return -ENOMEM;
1342         bd->options = this->bbt_options & BADBLOCK_SCAN_MASK;
1343         bd->offs = this->badblockpos;
1344         bd->len = (this->options & NAND_BUSWIDTH_16) ? 2 : 1;
1345         bd->pattern = scan_ff_pattern;
1346         bd->options |= NAND_BBT_DYNAMICSTRUCT;
1347         this->badblock_pattern = bd;
1348         return 0;
1349 }
1350
1351 /**
1352  * nand_create_bbt - [NAND Interface] Select a default bad block table for the device
1353  * @this: NAND chip object
1354  *
1355  * This function selects the default bad block table support for the device and
1356  * calls the nand_scan_bbt function.
1357  */
1358 int nand_create_bbt(struct nand_chip *this)
1359 {
1360         int ret;
1361
1362         /* Is a flash based bad block table requested? */
1363         if (this->bbt_options & NAND_BBT_USE_FLASH) {
1364                 /* Use the default pattern descriptors */
1365                 if (!this->bbt_td) {
1366                         if (this->bbt_options & NAND_BBT_NO_OOB) {
1367                                 this->bbt_td = &bbt_main_no_oob_descr;
1368                                 this->bbt_md = &bbt_mirror_no_oob_descr;
1369                         } else {
1370                                 this->bbt_td = &bbt_main_descr;
1371                                 this->bbt_md = &bbt_mirror_descr;
1372                         }
1373                 }
1374         } else {
1375                 this->bbt_td = NULL;
1376                 this->bbt_md = NULL;
1377         }
1378
1379         if (!this->badblock_pattern) {
1380                 ret = nand_create_badblock_pattern(this);
1381                 if (ret)
1382                         return ret;
1383         }
1384
1385         return nand_scan_bbt(nand_to_mtd(this), this->badblock_pattern);
1386 }
1387 EXPORT_SYMBOL(nand_create_bbt);
1388
1389 /**
1390  * nand_isreserved_bbt - [NAND Interface] Check if a block is reserved
1391  * @this: NAND chip object
1392  * @offs: offset in the device
1393  */
1394 int nand_isreserved_bbt(struct nand_chip *this, loff_t offs)
1395 {
1396         int block;
1397
1398         block = (int)(offs >> this->bbt_erase_shift);
1399         return bbt_get_entry(this, block) == BBT_BLOCK_RESERVED;
1400 }
1401
1402 /**
1403  * nand_isbad_bbt - [NAND Interface] Check if a block is bad
1404  * @this: NAND chip object
1405  * @offs: offset in the device
1406  * @allowbbt: allow access to bad block table region
1407  */
1408 int nand_isbad_bbt(struct nand_chip *this, loff_t offs, int allowbbt)
1409 {
1410         int block, res;
1411
1412         block = (int)(offs >> this->bbt_erase_shift);
1413         res = bbt_get_entry(this, block);
1414
1415         pr_debug("nand_isbad_bbt(): bbt info for offs 0x%08x: (block %d) 0x%02x\n",
1416                  (unsigned int)offs, block, res);
1417
1418         switch (res) {
1419         case BBT_BLOCK_GOOD:
1420                 return 0;
1421         case BBT_BLOCK_WORN:
1422                 return 1;
1423         case BBT_BLOCK_RESERVED:
1424                 return allowbbt ? 0 : 1;
1425         }
1426         return 1;
1427 }
1428
1429 /**
1430  * nand_markbad_bbt - [NAND Interface] Mark a block bad in the BBT
1431  * @this: NAND chip object
1432  * @offs: offset of the bad block
1433  */
1434 int nand_markbad_bbt(struct nand_chip *this, loff_t offs)
1435 {
1436         struct mtd_info *mtd = nand_to_mtd(this);
1437         int block, ret = 0;
1438
1439         block = (int)(offs >> this->bbt_erase_shift);
1440
1441         /* Mark bad block in memory */
1442         bbt_mark_entry(this, block, BBT_BLOCK_WORN);
1443
1444         /* Update flash-based bad block table */
1445         if (this->bbt_options & NAND_BBT_USE_FLASH)
1446                 ret = nand_update_bbt(mtd, offs);
1447
1448         return ret;
1449 }