drivers/mtd/nand/nand_bbt.c

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