drivers/mtd/nand/nand_bbt.c

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