drivers/mtd/nand/nand_bbt.c

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