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