drivers/mtd/nand/nand_bbt.c

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