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