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.ooblen = mtd->oobsize;
 337         ops.oobbuf = buf;
 338         ops.ooboffs = 0;
 339         ops.datbuf = NULL;
 340         ops.mode = MTD_OOB_PLACE;
 341
 342         for (j = 0; j < len; j++) {
 343                 /*
 344                  * Read the full oob until read_oob is fixed to
 345                  * handle single byte reads for 16 bit
 346                  * buswidth
 347                  */
 348                 ret = mtd->read_oob(mtd, offs, &ops);
 349                 if (ret)
 350                         return ret;
 351
 352                 if (check_short_pattern(buf, bd))
 353                         return 1;
 354
 355                 offs += mtd->writesize;
 356         }
 357         return 0;
 358 }
 359
 360 /**
 361  * create_bbt - [GENERIC] Create a bad block table by scanning the device
 362  * @mtd:        MTD device structure
 363  * @buf:        temporary buffer
 364  * @bd:         descriptor for the good/bad block search pattern
 365  * @chip:       create the table for a specific chip, -1 read all chips.
 366  *              Applies only if NAND_BBT_PERCHIP option is set
 367  *
 368  * Create a bad block table by scanning the device
 369  * for the given good/bad block identify pattern
 370  */
 371 static int create_bbt(struct mtd_info *mtd, uint8_t *buf,
 372         struct nand_bbt_descr *bd, int chip)
 373 {
 374         struct nand_chip *this = mtd->priv;
 375         int i, numblocks, len, scanlen;
 376         int startblock;
 377         loff_t from;
 378         size_t readlen;
 379
 380         printk(KERN_INFO "Scanning device for bad blocks\n");
 381
 382         if (bd->options & NAND_BBT_SCANALLPAGES)
 383                 len = 1 << (this->bbt_erase_shift - this->page_shift);
 384         else {
 385                 if (bd->options & NAND_BBT_SCAN2NDPAGE)
 386                         len = 2;
 387                 else
 388                         len = 1;
 389         }
 390
 391         if (!(bd->options & NAND_BBT_SCANEMPTY)) {
 392                 /* We need only read few bytes from the OOB area */
 393                 scanlen = 0;
 394                 readlen = bd->len;
 395         } else {
 396                 /* Full page content should be read */
 397                 scanlen = mtd->writesize + mtd->oobsize;
 398                 readlen = len * mtd->writesize;
 399         }
 400
 401         if (chip == -1) {
 402                 /* Note that numblocks is 2 * (real numblocks) here, see i+=2
 403                  * below as it makes shifting and masking less painful */
 404                 numblocks = mtd->size >> (this->bbt_erase_shift - 1);
 405                 startblock = 0;
 406                 from = 0;
 407         } else {
 408                 if (chip >= this->numchips) {
 409                         printk(KERN_WARNING "create_bbt(): chipnr (%d) > available chips (%d)\n",
 410                                chip + 1, this->numchips);
 411                         return -EINVAL;
 412                 }
 413                 numblocks = this->chipsize >> (this->bbt_erase_shift - 1);
 414                 startblock = chip * numblocks;
 415                 numblocks += startblock;
 416                 from = startblock << (this->bbt_erase_shift - 1);
 417         }
 418
 419         for (i = startblock; i < numblocks;) {
 420                 int ret;
 421
 422                 if (bd->options & NAND_BBT_SCANALLPAGES)
 423                         ret = scan_block_full(mtd, bd, from, buf, readlen,
 424                                               scanlen, len);
 425                 else
 426                         ret = scan_block_fast(mtd, bd, from, buf, len);
 427
 428                 if (ret < 0)
 429                         return ret;
 430
 431                 if (ret) {
 432                         this->bbt[i >> 3] |= 0x03 << (i & 0x6);
 433                         printk(KERN_WARNING "Bad eraseblock %d at 0x%08x\n",
 434                                i >> 1, (unsigned int)from);
 435                         mtd->ecc_stats.badblocks++;
 436                 }
 437
 438                 i += 2;
 439                 from += (1 << this->bbt_erase_shift);
 440         }
 441         return 0;
 442 }
 443
 444 /**
 445  * search_bbt - [GENERIC] scan the device for a specific bad block table
 446  * @mtd:        MTD device structure
 447  * @buf:        temporary buffer
 448  * @td:         descriptor for the bad block table
 449  *
 450  * Read the bad block table by searching for a given ident pattern.
 451  * Search is preformed either from the beginning up or from the end of
 452  * the device downwards. The search starts always at the start of a
 453  * block.
 454  * If the option NAND_BBT_PERCHIP is given, each chip is searched
 455  * for a bbt, which contains the bad block information of this chip.
 456  * This is necessary to provide support for certain DOC devices.
 457  *
 458  * The bbt ident pattern resides in the oob area of the first page
 459  * in a block.
 460  */
 461 static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td)
 462 {
 463         struct nand_chip *this = mtd->priv;
 464         int i, chips;
 465         int bits, startblock, block, dir;
 466         int scanlen = mtd->writesize + mtd->oobsize;
 467         int bbtblocks;
 468         int blocktopage = this->bbt_erase_shift - this->page_shift;
 469
 470         /* Search direction top -> down ? */
 471         if (td->options & NAND_BBT_LASTBLOCK) {
 472                 startblock = (mtd->size >> this->bbt_erase_shift) - 1;
 473                 dir = -1;
 474         } else {
 475                 startblock = 0;
 476                 dir = 1;
 477         }
 478
 479         /* Do we have a bbt per chip ? */
 480         if (td->options & NAND_BBT_PERCHIP) {
 481                 chips = this->numchips;
 482                 bbtblocks = this->chipsize >> this->bbt_erase_shift;
 483                 startblock &= bbtblocks - 1;
 484         } else {
 485                 chips = 1;
 486                 bbtblocks = mtd->size >> this->bbt_erase_shift;
 487         }
 488
 489         /* Number of bits for each erase block in the bbt */
 490         bits = td->options & NAND_BBT_NRBITS_MSK;
 491
 492         for (i = 0; i < chips; i++) {
 493                 /* Reset version information */
 494                 td->version[i] = 0;
 495                 td->pages[i] = -1;
 496                 /* Scan the maximum number of blocks */
 497                 for (block = 0; block < td->maxblocks; block++) {
 498
 499                         int actblock = startblock + dir * block;
 500                         loff_t offs = actblock << this->bbt_erase_shift;
 501
 502                         /* Read first page */
 503                         scan_read_raw(mtd, buf, offs, mtd->writesize);
 504                         if (!check_pattern(buf, scanlen, mtd->writesize, td)) {
 505                                 td->pages[i] = actblock << blocktopage;
 506                                 if (td->options & NAND_BBT_VERSION) {
 507                                         td->version[i] = buf[mtd->writesize + td->veroffs];
 508                                 }
 509                                 break;
 510                         }
 511                 }
 512                 startblock += this->chipsize >> this->bbt_erase_shift;
 513         }
 514         /* Check, if we found a bbt for each requested chip */
 515         for (i = 0; i < chips; i++) {
 516                 if (td->pages[i] == -1)
 517                         printk(KERN_WARNING "Bad block table not found for chip %d\n", i);
 518                 else
 519                         printk(KERN_DEBUG "Bad block table found at page %d, version 0x%02X\n", td->pages[i],
 520                                td->version[i]);
 521         }
 522         return 0;
 523 }
 524
 525 /**
 526  * search_read_bbts - [GENERIC] scan the device for bad block table(s)
 527  * @mtd:        MTD device structure
 528  * @buf:        temporary buffer
 529  * @td:         descriptor for the bad block table
 530  * @md:         descriptor for the bad block table mirror
 531  *
 532  * Search and read the bad block table(s)
 533 */
 534 static int search_read_bbts(struct mtd_info *mtd, uint8_t * buf, struct nand_bbt_descr *td, struct nand_bbt_descr *md)
 535 {
 536         /* Search the primary table */
 537         search_bbt(mtd, buf, td);
 538
 539         /* Search the mirror table */
 540         if (md)
 541                 search_bbt(mtd, buf, md);
 542
 543         /* Force result check */
 544         return 1;
 545 }
 546
 547 /**
 548  * write_bbt - [GENERIC] (Re)write the bad block table
 549  *
 550  * @mtd:        MTD device structure
 551  * @buf:        temporary buffer
 552  * @td:         descriptor for the bad block table
 553  * @md:         descriptor for the bad block table mirror
 554  * @chipsel:    selector for a specific chip, -1 for all
 555  *
 556  * (Re)write the bad block table
 557  *
 558 */
 559 static int write_bbt(struct mtd_info *mtd, uint8_t *buf,
 560                      struct nand_bbt_descr *td, struct nand_bbt_descr *md,
 561                      int chipsel)
 562 {
 563         struct nand_chip *this = mtd->priv;
 564         struct erase_info einfo;
 565         int i, j, res, chip = 0;
 566         int bits, startblock, dir, page, offs, numblocks, sft, sftmsk;
 567         int nrchips, bbtoffs, pageoffs, ooboffs;
 568         uint8_t msk[4];
 569         uint8_t rcode = td->reserved_block_code;
 570         size_t retlen, len = 0;
 571         loff_t to;
 572         struct mtd_oob_ops ops;
 573
 574         ops.ooblen = mtd->oobsize;
 575         ops.ooboffs = 0;
 576         ops.datbuf = NULL;
 577         ops.mode = MTD_OOB_PLACE;
 578
 579         if (!rcode)
 580                 rcode = 0xff;
 581         /* Write bad block table per chip rather than per device ? */
 582         if (td->options & NAND_BBT_PERCHIP) {
 583                 numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
 584                 /* Full device write or specific chip ? */
 585                 if (chipsel == -1) {
 586                         nrchips = this->numchips;
 587                 } else {
 588                         nrchips = chipsel + 1;
 589                         chip = chipsel;
 590                 }
 591         } else {
 592                 numblocks = (int)(mtd->size >> this->bbt_erase_shift);
 593                 nrchips = 1;
 594         }
 595
 596         /* Loop through the chips */
 597         for (; chip < nrchips; chip++) {
 598
 599                 /* There was already a version of the table, reuse the page
 600                  * This applies for absolute placement too, as we have the
 601                  * page nr. in td->pages.
 602                  */
 603                 if (td->pages[chip] != -1) {
 604                         page = td->pages[chip];
 605                         goto write;
 606                 }
 607
 608                 /* Automatic placement of the bad block table */
 609                 /* Search direction top -> down ? */
 610                 if (td->options & NAND_BBT_LASTBLOCK) {
 611                         startblock = numblocks * (chip + 1) - 1;
 612                         dir = -1;
 613                 } else {
 614                         startblock = chip * numblocks;
 615                         dir = 1;
 616                 }
 617
 618                 for (i = 0; i < td->maxblocks; i++) {
 619                         int block = startblock + dir * i;
 620                         /* Check, if the block is bad */
 621                         switch ((this->bbt[block >> 2] >>
 622                                  (2 * (block & 0x03))) & 0x03) {
 623                         case 0x01:
 624                         case 0x03:
 625                                 continue;
 626                         }
 627                         page = block <<
 628                                 (this->bbt_erase_shift - this->page_shift);
 629                         /* Check, if the block is used by the mirror table */
 630                         if (!md || md->pages[chip] != page)
 631                                 goto write;
 632                 }
 633                 printk(KERN_ERR "No space left to write bad block table\n");
 634                 return -ENOSPC;
 635         write:
 636
 637                 /* Set up shift count and masks for the flash table */
 638                 bits = td->options & NAND_BBT_NRBITS_MSK;
 639                 msk[2] = ~rcode;
 640                 switch (bits) {
 641                 case 1: sft = 3; sftmsk = 0x07; msk[0] = 0x00; msk[1] = 0x01;
 642                         msk[3] = 0x01;
 643                         break;
 644                 case 2: sft = 2; sftmsk = 0x06; msk[0] = 0x00; msk[1] = 0x01;
 645                         msk[3] = 0x03;
 646                         break;
 647                 case 4: sft = 1; sftmsk = 0x04; msk[0] = 0x00; msk[1] = 0x0C;
 648                         msk[3] = 0x0f;
 649                         break;
 650                 case 8: sft = 0; sftmsk = 0x00; msk[0] = 0x00; msk[1] = 0x0F;
 651                         msk[3] = 0xff;
 652                         break;
 653                 default: return -EINVAL;
 654                 }
 655
 656                 bbtoffs = chip * (numblocks >> 2);
 657
 658                 to = ((loff_t) page) << this->page_shift;
 659
 660                 /* Must we save the block contents ? */
 661                 if (td->options & NAND_BBT_SAVECONTENT) {
 662                         /* Make it block aligned */
 663                         to &= ~((loff_t) ((1 << this->bbt_erase_shift) - 1));
 664                         len = 1 << this->bbt_erase_shift;
 665                         res = mtd->read(mtd, to, len, &retlen, buf);
 666                         if (res < 0) {
 667                                 if (retlen != len) {
 668                                         printk(KERN_INFO "nand_bbt: Error "
 669                                                "reading block for writing "
 670                                                "the bad block table\n");
 671                                         return res;
 672                                 }
 673                                 printk(KERN_WARNING "nand_bbt: ECC error "
 674                                        "while reading block for writing "
 675                                        "bad block table\n");
 676                         }
 677                         /* Read oob data */
 678                         ops.ooblen = (len >> this->page_shift) * mtd->oobsize;
 679                         ops.oobbuf = &buf[len];
 680                         res = mtd->read_oob(mtd, to + mtd->writesize, &ops);
 681                         if (res < 0 || ops.oobretlen != ops.ooblen)
 682                                 goto outerr;
 683
 684                         /* Calc the byte offset in the buffer */
 685                         pageoffs = page - (int)(to >> this->page_shift);
 686                         offs = pageoffs << this->page_shift;
 687                         /* Preset the bbt area with 0xff */
 688                         memset(&buf[offs], 0xff, (size_t) (numblocks >> sft));
 689                         ooboffs = len + (pageoffs * mtd->oobsize);
 690
 691                 } else {
 692                         /* Calc length */
 693                         len = (size_t) (numblocks >> sft);
 694                         /* Make it page aligned ! */
 695                         len = (len + (mtd->writesize - 1)) &
 696                                 ~(mtd->writesize - 1);
 697                         /* Preset the buffer with 0xff */
 698                         memset(buf, 0xff, len +
 699                                (len >> this->page_shift)* mtd->oobsize);
 700                         offs = 0;
 701                         ooboffs = len;
 702                         /* Pattern is located in oob area of first page */
 703                         memcpy(&buf[ooboffs + td->offs], td->pattern, td->len);
 704                 }
 705
 706                 if (td->options & NAND_BBT_VERSION)
 707                         buf[ooboffs + td->veroffs] = td->version[chip];
 708
 709                 /* walk through the memory table */
 710                 for (i = 0; i < numblocks;) {
 711                         uint8_t dat;
 712                         dat = this->bbt[bbtoffs + (i >> 2)];
 713                         for (j = 0; j < 4; j++, i++) {
 714                                 int sftcnt = (i << (3 - sft)) & sftmsk;
 715                                 /* Do not store the reserved bbt blocks ! */
 716                                 buf[offs + (i >> sft)] &=
 717                                         ~(msk[dat & 0x03] << sftcnt);
 718                                 dat >>= 2;
 719                         }
 720                 }
 721
 722                 memset(&einfo, 0, sizeof(einfo));
 723                 einfo.mtd = mtd;
 724                 einfo.addr = (unsigned long)to;
 725                 einfo.len = 1 << this->bbt_erase_shift;
 726                 res = nand_erase_nand(mtd, &einfo, 1);
 727                 if (res < 0)
 728                         goto outerr;
 729
 730                 res = scan_write_bbt(mtd, to, len, buf, &buf[len]);
 731                 if (res < 0)
 732                         goto outerr;
 733
 734                 printk(KERN_DEBUG "Bad block table written to 0x%08x, version "
 735                        "0x%02X\n", (unsigned int)to, td->version[chip]);
 736
 737                 /* Mark it as used */
 738                 td->pages[chip] = page;
 739         }
 740         return 0;
 741
 742  outerr:
 743         printk(KERN_WARNING
 744                "nand_bbt: Error while writing bad block table %d\n", res);
 745         return res;
 746 }
 747
 748 /**
 749  * nand_memory_bbt - [GENERIC] create a memory based bad block table
 750  * @mtd:        MTD device structure
 751  * @bd:         descriptor for the good/bad block search pattern
 752  *
 753  * The function creates a memory based bbt by scanning the device
 754  * for manufacturer / software marked good / bad blocks
 755 */
 756 static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
 757 {
 758         struct nand_chip *this = mtd->priv;
 759
 760         bd->options &= ~NAND_BBT_SCANEMPTY;
 761         return create_bbt(mtd, this->buffers->databuf, bd, -1);
 762 }
 763
 764 /**
 765  * check_create - [GENERIC] create and write bbt(s) if necessary
 766  * @mtd:        MTD device structure
 767  * @buf:        temporary buffer
 768  * @bd:         descriptor for the good/bad block search pattern
 769  *
 770  * The function checks the results of the previous call to read_bbt
 771  * and creates / updates the bbt(s) if necessary
 772  * Creation is necessary if no bbt was found for the chip/device
 773  * Update is necessary if one of the tables is missing or the
 774  * version nr. of one table is less than the other
 775 */
 776 static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)
 777 {
 778         int i, chips, writeops, chipsel, res;
 779         struct nand_chip *this = mtd->priv;
 780         struct nand_bbt_descr *td = this->bbt_td;
 781         struct nand_bbt_descr *md = this->bbt_md;
 782         struct nand_bbt_descr *rd, *rd2;
 783
 784         /* Do we have a bbt per chip ? */
 785         if (td->options & NAND_BBT_PERCHIP)
 786                 chips = this->numchips;
 787         else
 788                 chips = 1;
 789
 790         for (i = 0; i < chips; i++) {
 791                 writeops = 0;
 792                 rd = NULL;
 793                 rd2 = NULL;
 794                 /* Per chip or per device ? */
 795                 chipsel = (td->options & NAND_BBT_PERCHIP) ? i : -1;
 796                 /* Mirrored table avilable ? */
 797                 if (md) {
 798                         if (td->pages[i] == -1 && md->pages[i] == -1) {
 799                                 writeops = 0x03;
 800                                 goto create;
 801                         }
 802
 803                         if (td->pages[i] == -1) {
 804                                 rd = md;
 805                                 td->version[i] = md->version[i];
 806                                 writeops = 1;
 807                                 goto writecheck;
 808                         }
 809
 810                         if (md->pages[i] == -1) {
 811                                 rd = td;
 812                                 md->version[i] = td->version[i];
 813                                 writeops = 2;
 814                                 goto writecheck;
 815                         }
 816
 817                         if (td->version[i] == md->version[i]) {
 818                                 rd = td;
 819                                 if (!(td->options & NAND_BBT_VERSION))
 820                                         rd2 = md;
 821                                 goto writecheck;
 822                         }
 823
 824                         if (((int8_t) (td->version[i] - md->version[i])) > 0) {
 825                                 rd = td;
 826                                 md->version[i] = td->version[i];
 827                                 writeops = 2;
 828                         } else {
 829                                 rd = md;
 830                                 td->version[i] = md->version[i];
 831                                 writeops = 1;
 832                         }
 833
 834                         goto writecheck;
 835
 836                 } else {
 837                         if (td->pages[i] == -1) {
 838                                 writeops = 0x01;
 839                                 goto create;
 840                         }
 841                         rd = td;
 842                         goto writecheck;
 843                 }
 844         create:
 845                 /* Create the bad block table by scanning the device ? */
 846                 if (!(td->options & NAND_BBT_CREATE))
 847                         continue;
 848
 849                 /* Create the table in memory by scanning the chip(s) */
 850                 create_bbt(mtd, buf, bd, chipsel);
 851
 852                 td->version[i] = 1;
 853                 if (md)
 854                         md->version[i] = 1;
 855         writecheck:
 856                 /* read back first ? */
 857                 if (rd)
 858                         read_abs_bbt(mtd, buf, rd, chipsel);
 859                 /* If they weren't versioned, read both. */
 860                 if (rd2)
 861                         read_abs_bbt(mtd, buf, rd2, chipsel);
 862
 863                 /* Write the bad block table to the device ? */
 864                 if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
 865                         res = write_bbt(mtd, buf, td, md, chipsel);
 866                         if (res < 0)
 867                                 return res;
 868                 }
 869
 870                 /* Write the mirror bad block table to the device ? */
 871                 if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
 872                         res = write_bbt(mtd, buf, md, td, chipsel);
 873                         if (res < 0)
 874                                 return res;
 875                 }
 876         }
 877         return 0;
 878 }
 879
 880 /**
 881  * mark_bbt_regions - [GENERIC] mark the bad block table regions
 882  * @mtd:        MTD device structure
 883  * @td:         bad block table descriptor
 884  *
 885  * The bad block table regions are marked as "bad" to prevent
 886  * accidental erasures / writes. The regions are identified by
 887  * the mark 0x02.
 888 */
 889 static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
 890 {
 891         struct nand_chip *this = mtd->priv;
 892         int i, j, chips, block, nrblocks, update;
 893         uint8_t oldval, newval;
 894
 895         /* Do we have a bbt per chip ? */
 896         if (td->options & NAND_BBT_PERCHIP) {
 897                 chips = this->numchips;
 898                 nrblocks = (int)(this->chipsize >> this->bbt_erase_shift);
 899         } else {
 900                 chips = 1;
 901                 nrblocks = (int)(mtd->size >> this->bbt_erase_shift);
 902         }
 903
 904         for (i = 0; i < chips; i++) {
 905                 if ((td->options & NAND_BBT_ABSPAGE) ||
 906                     !(td->options & NAND_BBT_WRITE)) {
 907                         if (td->pages[i] == -1)
 908                                 continue;
 909                         block = td->pages[i] >> (this->bbt_erase_shift - this->page_shift);
 910                         block <<= 1;
 911                         oldval = this->bbt[(block >> 3)];
 912                         newval = oldval | (0x2 << (block & 0x06));
 913                         this->bbt[(block >> 3)] = newval;
 914                         if ((oldval != newval) && td->reserved_block_code)
 915                                 nand_update_bbt(mtd, block << (this->bbt_erase_shift - 1));
 916                         continue;
 917                 }
 918                 update = 0;
 919                 if (td->options & NAND_BBT_LASTBLOCK)
 920                         block = ((i + 1) * nrblocks) - td->maxblocks;
 921                 else
 922                         block = i * nrblocks;
 923                 block <<= 1;
 924                 for (j = 0; j < td->maxblocks; j++) {
 925                         oldval = this->bbt[(block >> 3)];
 926                         newval = oldval | (0x2 << (block & 0x06));
 927                         this->bbt[(block >> 3)] = newval;
 928                         if (oldval != newval)
 929                                 update = 1;
 930                         block += 2;
 931                 }
 932                 /* If we want reserved blocks to be recorded to flash, and some
 933                    new ones have been marked, then we need to update the stored
 934                    bbts.  This should only happen once. */
 935                 if (update && td->reserved_block_code)
 936                         nand_update_bbt(mtd, (block - 2) << (this->bbt_erase_shift - 1));
 937         }
 938 }
 939
 940 /**
 941  * nand_scan_bbt - [NAND Interface] scan, find, read and maybe create bad block table(s)
 942  * @mtd:        MTD device structure
 943  * @bd:         descriptor for the good/bad block search pattern
 944  *
 945  * The function checks, if a bad block table(s) is/are already
 946  * available. If not it scans the device for manufacturer
 947  * marked good / bad blocks and writes the bad block table(s) to
 948  * the selected place.
 949  *
 950  * The bad block table memory is allocated here. It must be freed
 951  * by calling the nand_free_bbt function.
 952  *
 953 */
 954 int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
 955 {
 956         struct nand_chip *this = mtd->priv;
 957         int len, res = 0;
 958         uint8_t *buf;
 959         struct nand_bbt_descr *td = this->bbt_td;
 960         struct nand_bbt_descr *md = this->bbt_md;
 961
 962         len = mtd->size >> (this->bbt_erase_shift + 2);
 963         /* Allocate memory (2bit per block) and clear the memory bad block table */
 964         this->bbt = kzalloc(len, GFP_KERNEL);
 965         if (!this->bbt) {
 966                 printk(KERN_ERR "nand_scan_bbt: Out of memory\n");
 967                 return -ENOMEM;
 968         }
 969
 970         /* If no primary table decriptor is given, scan the device
 971          * to build a memory based bad block table
 972          */
 973         if (!td) {
 974                 if ((res = nand_memory_bbt(mtd, bd))) {
 975                         printk(KERN_ERR "nand_bbt: Can't scan flash and build the RAM-based BBT\n");
 976                         kfree(this->bbt);
 977                         this->bbt = NULL;
 978                 }
 979                 return res;
 980         }
 981
 982         /* Allocate a temporary buffer for one eraseblock incl. oob */
 983         len = (1 << this->bbt_erase_shift);
 984         len += (len >> this->page_shift) * mtd->oobsize;
 985         buf = vmalloc(len);
 986         if (!buf) {
 987                 printk(KERN_ERR "nand_bbt: Out of memory\n");
 988                 kfree(this->bbt);
 989                 this->bbt = NULL;
 990                 return -ENOMEM;
 991         }
 992
 993         /* Is the bbt at a given page ? */
 994         if (td->options & NAND_BBT_ABSPAGE) {
 995                 res = read_abs_bbts(mtd, buf, td, md);
 996         } else {
 997                 /* Search the bad block table using a pattern in oob */
 998                 res = search_read_bbts(mtd, buf, td, md);
 999         }
1000
1001         if (res)
1002                 res = check_create(mtd, buf, bd);
1003
1004         /* Prevent the bbt regions from erasing / writing */
1005         mark_bbt_region(mtd, td);
1006         if (md)
1007                 mark_bbt_region(mtd, md);
1008
1009         vfree(buf);
1010         return res;
1011 }
1012
1013 /**
1014  * nand_update_bbt - [NAND Interface] update bad block table(s)
1015  * @mtd:        MTD device structure
1016  * @offs:       the offset of the newly marked block
1017  *
1018  * The function updates the bad block table(s)
1019 */
1020 int nand_update_bbt(struct mtd_info *mtd, loff_t offs)
1021 {
1022         struct nand_chip *this = mtd->priv;
1023         int len, res = 0, writeops = 0;
1024         int chip, chipsel;
1025         uint8_t *buf;
1026         struct nand_bbt_descr *td = this->bbt_td;
1027         struct nand_bbt_descr *md = this->bbt_md;
1028
1029         if (!this->bbt || !td)
1030                 return -EINVAL;
1031
1032         len = mtd->size >> (this->bbt_erase_shift + 2);
1033         /* Allocate a temporary buffer for one eraseblock incl. oob */
1034         len = (1 << this->bbt_erase_shift);
1035         len += (len >> this->page_shift) * mtd->oobsize;
1036         buf = kmalloc(len, GFP_KERNEL);
1037         if (!buf) {
1038                 printk(KERN_ERR "nand_update_bbt: Out of memory\n");
1039                 return -ENOMEM;
1040         }
1041
1042         writeops = md != NULL ? 0x03 : 0x01;
1043
1044         /* Do we have a bbt per chip ? */
1045         if (td->options & NAND_BBT_PERCHIP) {
1046                 chip = (int)(offs >> this->chip_shift);
1047                 chipsel = chip;
1048         } else {
1049                 chip = 0;
1050                 chipsel = -1;
1051         }
1052
1053         td->version[chip]++;
1054         if (md)
1055                 md->version[chip]++;
1056
1057         /* Write the bad block table to the device ? */
1058         if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
1059                 res = write_bbt(mtd, buf, td, md, chipsel);
1060                 if (res < 0)
1061                         goto out;
1062         }
1063         /* Write the mirror bad block table to the device ? */
1064         if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
1065                 res = write_bbt(mtd, buf, md, td, chipsel);
1066         }
1067
1068  out:
1069         kfree(buf);
1070         return res;
1071 }
1072
1073 /* Define some generic bad / good block scan pattern which are used
1074  * while scanning a device for factory marked good / bad blocks. */
1075 static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
1076
1077 static struct nand_bbt_descr smallpage_memorybased = {
1078         .options = NAND_BBT_SCAN2NDPAGE,
1079         .offs = 5,
1080         .len = 1,
1081         .pattern = scan_ff_pattern
1082 };
1083
1084 static struct nand_bbt_descr largepage_memorybased = {
1085         .options = 0,
1086         .offs = 0,
1087         .len = 2,
1088         .pattern = scan_ff_pattern
1089 };
1090
1091 static struct nand_bbt_descr smallpage_flashbased = {
1092         .options = NAND_BBT_SCAN2NDPAGE,
1093         .offs = 5,
1094         .len = 1,
1095         .pattern = scan_ff_pattern
1096 };
1097
1098 static struct nand_bbt_descr largepage_flashbased = {
1099         .options = NAND_BBT_SCAN2NDPAGE,
1100         .offs = 0,
1101         .len = 2,
1102         .pattern = scan_ff_pattern
1103 };
1104
1105 static uint8_t scan_agand_pattern[] = { 0x1C, 0x71, 0xC7, 0x1C, 0x71, 0xC7 };
1106
1107 static struct nand_bbt_descr agand_flashbased = {
1108         .options = NAND_BBT_SCANEMPTY | NAND_BBT_SCANALLPAGES,
1109         .offs = 0x20,
1110         .len = 6,
1111         .pattern = scan_agand_pattern
1112 };
1113
1114 /* Generic flash bbt decriptors
1115 */
1116 static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1117 static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1118
1119 static struct nand_bbt_descr bbt_main_descr = {
1120         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1121                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1122         .offs = 8,
1123         .len = 4,
1124         .veroffs = 12,
1125         .maxblocks = 4,
1126         .pattern = bbt_pattern
1127 };
1128
1129 static struct nand_bbt_descr bbt_mirror_descr = {
1130         .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1131                 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1132         .offs = 8,
1133         .len = 4,
1134         .veroffs = 12,
1135         .maxblocks = 4,
1136         .pattern = mirror_pattern
1137 };
1138
1139 /**
1140  * nand_default_bbt - [NAND Interface] Select a default bad block table for the device
1141  * @mtd:        MTD device structure
1142  *
1143  * This function selects the default bad block table
1144  * support for the device and calls the nand_scan_bbt function
1145  *
1146 */
1147 int nand_default_bbt(struct mtd_info *mtd)
1148 {
1149         struct nand_chip *this = mtd->priv;
1150
1151         /* Default for AG-AND. We must use a flash based
1152          * bad block table as the devices have factory marked
1153          * _good_ blocks. Erasing those blocks leads to loss
1154          * of the good / bad information, so we _must_ store
1155          * this information in a good / bad table during
1156          * startup
1157          */
1158         if (this->options & NAND_IS_AND) {
1159                 /* Use the default pattern descriptors */
1160                 if (!this->bbt_td) {
1161                         this->bbt_td = &bbt_main_descr;
1162                         this->bbt_md = &bbt_mirror_descr;
1163                 }
1164                 this->options |= NAND_USE_FLASH_BBT;
1165                 return nand_scan_bbt(mtd, &agand_flashbased);
1166         }
1167
1168         /* Is a flash based bad block table requested ? */
1169         if (this->options & NAND_USE_FLASH_BBT) {
1170                 /* Use the default pattern descriptors */
1171                 if (!this->bbt_td) {
1172                         this->bbt_td = &bbt_main_descr;
1173                         this->bbt_md = &bbt_mirror_descr;
1174                 }
1175                 if (!this->badblock_pattern) {
1176                         this->badblock_pattern = (mtd->writesize > 512) ? &largepage_flashbased : &smallpage_flashbased;
1177                 }
1178         } else {
1179                 this->bbt_td = NULL;
1180                 this->bbt_md = NULL;
1181                 if (!this->badblock_pattern) {
1182                         this->badblock_pattern = (mtd->writesize > 512) ?
1183                             &largepage_memorybased : &smallpage_memorybased;
1184                 }
1185         }
1186         return nand_scan_bbt(mtd, this->badblock_pattern);
1187 }
1188
1189 /**
1190  * nand_isbad_bbt - [NAND Interface] Check if a block is bad
1191  * @mtd:        MTD device structure
1192  * @offs:       offset in the device
1193  * @allowbbt:   allow access to bad block table region
1194  *
1195 */
1196 int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
1197 {
1198         struct nand_chip *this = mtd->priv;
1199         int block;
1200         uint8_t res;
1201
1202         /* Get block number * 2 */
1203         block = (int)(offs >> (this->bbt_erase_shift - 1));
1204         res = (this->bbt[block >> 3] >> (block & 0x06)) & 0x03;
1205
1206         DEBUG(MTD_DEBUG_LEVEL2, "nand_isbad_bbt(): bbt info for offs 0x%08x: (block %d) 0x%02x\n",
1207               (unsigned int)offs, block >> 1, res);
1208
1209         switch ((int)res) {
1210         case 0x00:
1211                 return 0;
1212         case 0x01:
1213                 return 1;
1214         case 0x02:
1215                 return allowbbt ? 0 : 1;
1216         }
1217         return 1;
1218 }
1219
1220 EXPORT_SYMBOL(nand_scan_bbt);
1221 EXPORT_SYMBOL(nand_default_bbt);