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