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