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