blob: 30d1319ff0657ce75b063023d9eee0c65d2f5873 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/mtd/nand_bbt.c
3 *
4 * Overview:
5 * Bad block table support for the NAND driver
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00006 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * Copyright (C) 2004 Thomas Gleixner (tglx@linutronix.de)
8 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000015 * When nand_scan_bbt is called, then it tries to find the bad block table
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020016 * depending on the options in the BBT descriptor(s). If no flash based BBT
Brian Norrisbb9ebd42011-05-31 16:31:23 -070017 * (NAND_BBT_USE_FLASH) is specified then the device is scanned for factory
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020018 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 * If the tables are not versioned, then we "or" the bad block information.
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020027 * 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
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000029 * good / bad blocks and the bad block tables are created.
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 *
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020031 * For manufacturer created BBTs like the one found on M-SYS DOC devices
32 * the BBT is searched and read but never created
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 *
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020034 * The auto generated bad block table is located in the last good blocks
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000035 * of the device. The table is mirrored, so it can be updated eventually.
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020036 * 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
Brian Norrisbb9ebd42011-05-31 16:31:23 -070039 * option NAND_BBT_NO_OOB should be used (along with NAND_BBT_USE_FLASH, of
Brian Norrisa40f7342011-05-31 16:31:22 -070040 * course): it moves the ident pattern and the version byte into the data area
41 * and the OOB area will remain untouched.
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 *
43 * The table uses 2 bits per block
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020044 * 11b: block is good
45 * 00b: block is factory marked bad
46 * 01b, 10b: block is marked bad due to wear
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 *
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
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000053 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * 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
David Woodhousee0c7d762006-05-13 18:07:53 +010058 * - the space necessary for a bbt in FLASH does not exceed a block boundary
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000059 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 */
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <linux/bitops.h>
68#include <linux/delay.h>
David Woodhousec3f8abf2006-05-13 04:03:42 +010069#include <linux/vmalloc.h>
Paul Gortmakerf3bcc012011-07-10 12:43:28 -040070#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020072static int check_pattern_no_oob(uint8_t *buf, struct nand_bbt_descr *td)
73{
74 int ret;
75
76 ret = memcmp(buf, td->pattern, td->len);
77 if (!ret)
78 return ret;
79 return -1;
80}
81
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000082/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 * check_pattern - [GENERIC] check if a pattern is in the buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -070084 * @buf: the buffer to search
85 * @len: the length of buffer to search
86 * @paglen: the pagelength
87 * @td: search pattern descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 *
Brian Norris8b6e50c2011-05-25 14:59:01 -070089 * Check for a pattern at the given place. Used to search bad block tables and
90 * good / bad block identifiers. If the SCAN_EMPTY option is set then check, if
91 * all bytes except the pattern area contain 0xff.
92 */
David Woodhousee0c7d762006-05-13 18:07:53 +010093static int check_pattern(uint8_t *buf, int len, int paglen, struct nand_bbt_descr *td)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094{
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +000095 int i, end = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 uint8_t *p = buf;
97
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020098 if (td->options & NAND_BBT_NO_OOB)
99 return check_pattern_no_oob(buf, td);
100
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100101 end = paglen + td->offs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 if (td->options & NAND_BBT_SCANEMPTY) {
103 for (i = 0; i < end; i++) {
104 if (p[i] != 0xff)
105 return -1;
106 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000107 }
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100108 p += end;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 /* Compare the pattern */
Brian Norris75b66d82011-09-07 13:13:41 -0700111 if (memcmp(p, td->pattern, td->len))
112 return -1;
Brian Norris58373ff2010-07-15 12:15:44 -0700113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 if (td->options & NAND_BBT_SCANEMPTY) {
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000115 p += td->len;
116 end += td->len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 for (i = end; i < len; i++) {
118 if (*p++ != 0xff)
119 return -1;
120 }
121 }
122 return 0;
123}
124
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000125/**
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100126 * check_short_pattern - [GENERIC] check if a pattern is in the buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700127 * @buf: the buffer to search
128 * @td: search pattern descriptor
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100129 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700130 * Check for a pattern at the given place. Used to search bad block tables and
131 * good / bad block identifiers. Same as check_pattern, but no optional empty
132 * check.
133 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100134static int check_short_pattern(uint8_t *buf, struct nand_bbt_descr *td)
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100135{
136 int i;
137 uint8_t *p = buf;
138
139 /* Compare the pattern */
140 for (i = 0; i < td->len; i++) {
Thomas Gleixner19870da2005-07-15 14:53:51 +0100141 if (p[td->offs + i] != td->pattern[i])
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100142 return -1;
143 }
144 return 0;
145}
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/**
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200148 * add_marker_len - compute the length of the marker in data area
Brian Norris8b6e50c2011-05-25 14:59:01 -0700149 * @td: BBT descriptor used for computation
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200150 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700151 * The length will be 0 if the marker is located in OOB area.
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200152 */
153static u32 add_marker_len(struct nand_bbt_descr *td)
154{
155 u32 len;
156
157 if (!(td->options & NAND_BBT_NO_OOB))
158 return 0;
159
160 len = td->len;
161 if (td->options & NAND_BBT_VERSION)
162 len++;
163 return len;
164}
165
166/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 * read_bbt - [GENERIC] Read the bad block table starting from page
Brian Norris8b6e50c2011-05-25 14:59:01 -0700168 * @mtd: MTD device structure
169 * @buf: temporary buffer
170 * @page: the starting page
171 * @num: the number of bbt descriptors to read
Brian Norris7854d3f2011-06-23 14:12:08 -0700172 * @td: the bbt describtion table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700173 * @offs: offset in the memory table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 *
175 * Read the bad block table starting from page.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100177static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num,
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200178 struct nand_bbt_descr *td, int offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
Brian Norris167a8d52011-09-20 18:35:08 -0700180 int res, ret = 0, i, j, act = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 struct nand_chip *this = mtd->priv;
182 size_t retlen, len, totlen;
183 loff_t from;
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200184 int bits = td->options & NAND_BBT_NRBITS_MSK;
Brian Norris596d7452011-09-07 13:13:33 -0700185 uint8_t msk = (uint8_t)((1 << bits) - 1);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200186 u32 marker_len;
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200187 int reserved_block_code = td->reserved_block_code;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 totlen = (num * bits) >> 3;
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200190 marker_len = add_marker_len(td);
Brian Norris596d7452011-09-07 13:13:33 -0700191 from = ((loff_t)page) << this->page_shift;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 while (totlen) {
Brian Norris596d7452011-09-07 13:13:33 -0700194 len = min(totlen, (size_t)(1 << this->bbt_erase_shift));
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200195 if (marker_len) {
196 /*
197 * In case the BBT marker is not in the OOB area it
198 * will be just in the first page.
199 */
200 len -= marker_len;
201 from += marker_len;
202 marker_len = 0;
203 }
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200204 res = mtd_read(mtd, from, len, &retlen, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 if (res < 0) {
Brian Norris167a8d52011-09-20 18:35:08 -0700206 if (mtd_is_eccerr(res)) {
207 pr_info("nand_bbt: ECC error in BBT at "
208 "0x%012llx\n", from & ~mtd->writesize);
209 return res;
210 } else if (mtd_is_bitflip(res)) {
211 pr_info("nand_bbt: corrected error in BBT at "
212 "0x%012llx\n", from & ~mtd->writesize);
213 ret = res;
214 } else {
215 pr_info("nand_bbt: error reading BBT\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 return res;
217 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000218 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220 /* Analyse data */
221 for (i = 0; i < len; i++) {
222 uint8_t dat = buf[i];
223 for (j = 0; j < 8; j += bits, act += 2) {
224 uint8_t tmp = (dat >> j) & msk;
225 if (tmp == msk)
226 continue;
David Woodhousee0c7d762006-05-13 18:07:53 +0100227 if (reserved_block_code && (tmp == reserved_block_code)) {
Brian Norrisd0370212011-07-19 10:06:08 -0700228 pr_info("nand_read_bbt: reserved block at 0x%012llx\n",
229 (loff_t)((offs << 2) + (act >> 1)) << this->bbt_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 this->bbt[offs + (act >> 3)] |= 0x2 << (act & 0x06);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200231 mtd->ecc_stats.bbtblocks++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 continue;
233 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700234 /*
235 * Leave it for now, if it's matured we can
Brian Norrisa0f50802011-07-19 10:06:06 -0700236 * move this message to pr_debug.
Brian Norris8b6e50c2011-05-25 14:59:01 -0700237 */
Brian Norrisd0370212011-07-19 10:06:08 -0700238 pr_info("nand_read_bbt: bad block at 0x%012llx\n",
239 (loff_t)((offs << 2) + (act >> 1)) << this->bbt_erase_shift);
Brian Norris8b6e50c2011-05-25 14:59:01 -0700240 /* Factory marked bad or worn out? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 if (tmp == 0)
242 this->bbt[offs + (act >> 3)] |= 0x3 << (act & 0x06);
243 else
244 this->bbt[offs + (act >> 3)] |= 0x1 << (act & 0x06);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200245 mtd->ecc_stats.badblocks++;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000246 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 }
248 totlen -= len;
249 from += len;
250 }
Brian Norris167a8d52011-09-20 18:35:08 -0700251 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252}
253
254/**
255 * read_abs_bbt - [GENERIC] Read the bad block table starting at a given page
Brian Norris8b6e50c2011-05-25 14:59:01 -0700256 * @mtd: MTD device structure
257 * @buf: temporary buffer
258 * @td: descriptor for the bad block table
Brian Norris596d7452011-09-07 13:13:33 -0700259 * @chip: read the table for a specific chip, -1 read all chips; applies only if
Brian Norris8b6e50c2011-05-25 14:59:01 -0700260 * NAND_BBT_PERCHIP option is set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700262 * Read the bad block table for all chips starting at a given page. We assume
263 * that the bbt bits are in consecutive order.
264 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100265static int read_abs_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td, int chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
267 struct nand_chip *this = mtd->priv;
268 int res = 0, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 if (td->options & NAND_BBT_PERCHIP) {
271 int offs = 0;
272 for (i = 0; i < this->numchips; i++) {
273 if (chip == -1 || chip == i)
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200274 res = read_bbt(mtd, buf, td->pages[i],
275 this->chipsize >> this->bbt_erase_shift,
276 td, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 if (res)
278 return res;
279 offs += this->chipsize >> (this->bbt_erase_shift + 2);
280 }
281 } else {
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200282 res = read_bbt(mtd, buf, td->pages[0],
283 mtd->size >> this->bbt_erase_shift, td, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 if (res)
285 return res;
286 }
287 return 0;
288}
289
Brian Norris8b6e50c2011-05-25 14:59:01 -0700290/* BBT marker is in the first page, no OOB */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200291static int scan_read_raw_data(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
292 struct nand_bbt_descr *td)
293{
294 size_t retlen;
295 size_t len;
296
297 len = td->len;
298 if (td->options & NAND_BBT_VERSION)
299 len++;
300
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200301 return mtd_read(mtd, offs, len, &retlen, buf);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200302}
303
Brian Norris8b6e50c2011-05-25 14:59:01 -0700304/* Scan read raw data from flash */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200305static int scan_read_raw_oob(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200306 size_t len)
307{
308 struct mtd_oob_ops ops;
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200309 int res;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200310
Brian Norris0612b9d2011-08-30 18:45:40 -0700311 ops.mode = MTD_OPS_RAW;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200312 ops.ooboffs = 0;
313 ops.ooblen = mtd->oobsize;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200314
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200315 while (len > 0) {
Brian Norris105513c2011-09-07 13:13:28 -0700316 ops.datbuf = buf;
317 ops.len = min(len, (size_t)mtd->writesize);
318 ops.oobbuf = buf + ops.len;
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200319
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200320 res = mtd_read_oob(mtd, offs, &ops);
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200321
Brian Norrisafa17de2011-09-07 13:13:29 -0700322 if (res)
Brian Norris105513c2011-09-07 13:13:28 -0700323 return res;
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200324
325 buf += mtd->oobsize + mtd->writesize;
326 len -= mtd->writesize;
Dmitry Maluka34a57042012-05-11 20:51:51 +0300327 offs += mtd->writesize;
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200328 }
329 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200330}
331
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200332static int scan_read_raw(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
333 size_t len, struct nand_bbt_descr *td)
334{
335 if (td->options & NAND_BBT_NO_OOB)
336 return scan_read_raw_data(mtd, buf, offs, td);
337 else
338 return scan_read_raw_oob(mtd, buf, offs, len);
339}
340
Brian Norris8b6e50c2011-05-25 14:59:01 -0700341/* Scan write data with oob to flash */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200342static int scan_write_bbt(struct mtd_info *mtd, loff_t offs, size_t len,
343 uint8_t *buf, uint8_t *oob)
344{
345 struct mtd_oob_ops ops;
346
Brian Norris0612b9d2011-08-30 18:45:40 -0700347 ops.mode = MTD_OPS_PLACE_OOB;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200348 ops.ooboffs = 0;
349 ops.ooblen = mtd->oobsize;
350 ops.datbuf = buf;
351 ops.oobbuf = oob;
352 ops.len = len;
353
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200354 return mtd_write_oob(mtd, offs, &ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200355}
356
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200357static u32 bbt_get_ver_offs(struct mtd_info *mtd, struct nand_bbt_descr *td)
358{
359 u32 ver_offs = td->veroffs;
360
361 if (!(td->options & NAND_BBT_NO_OOB))
362 ver_offs += mtd->writesize;
363 return ver_offs;
364}
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366/**
367 * read_abs_bbts - [GENERIC] Read the bad block table(s) for all chips starting at a given page
Brian Norris8b6e50c2011-05-25 14:59:01 -0700368 * @mtd: MTD device structure
369 * @buf: temporary buffer
370 * @td: descriptor for the bad block table
371 * @md: descriptor for the bad block table mirror
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700373 * Read the bad block table(s) for all chips starting at a given page. We
374 * assume that the bbt bits are in consecutive order.
375 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200376static int read_abs_bbts(struct mtd_info *mtd, uint8_t *buf,
377 struct nand_bbt_descr *td, struct nand_bbt_descr *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378{
379 struct nand_chip *this = mtd->priv;
380
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000381 /* Read the primary version, if available */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 if (td->options & NAND_BBT_VERSION) {
Adrian Hunter69423d92008-12-10 13:37:21 +0000383 scan_read_raw(mtd, buf, (loff_t)td->pages[0] << this->page_shift,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200384 mtd->writesize, td);
385 td->version[0] = buf[bbt_get_ver_offs(mtd, td)];
Brian Norris9a4d4d62011-07-19 10:06:07 -0700386 pr_info("Bad block table at page %d, version 0x%02X\n",
Brian Norrisd0370212011-07-19 10:06:08 -0700387 td->pages[0], td->version[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 }
389
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000390 /* Read the mirror version, if available */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 if (md && (md->options & NAND_BBT_VERSION)) {
Adrian Hunter69423d92008-12-10 13:37:21 +0000392 scan_read_raw(mtd, buf, (loff_t)md->pages[0] << this->page_shift,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200393 mtd->writesize, td);
394 md->version[0] = buf[bbt_get_ver_offs(mtd, md)];
Brian Norris9a4d4d62011-07-19 10:06:07 -0700395 pr_info("Bad block table at page %d, version 0x%02X\n",
Brian Norrisd0370212011-07-19 10:06:08 -0700396 md->pages[0], md->version[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 return 1;
399}
400
Brian Norris8b6e50c2011-05-25 14:59:01 -0700401/* Scan a given block full */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200402static int scan_block_full(struct mtd_info *mtd, struct nand_bbt_descr *bd,
403 loff_t offs, uint8_t *buf, size_t readlen,
404 int scanlen, int len)
405{
406 int ret, j;
407
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200408 ret = scan_read_raw_oob(mtd, buf, offs, readlen);
Brian Norrisafa17de2011-09-07 13:13:29 -0700409 /* Ignore ECC errors when checking for BBM */
Brian Norrisd57f40542011-09-20 18:34:25 -0700410 if (ret && !mtd_is_bitflip_or_eccerr(ret))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200411 return ret;
412
413 for (j = 0; j < len; j++, buf += scanlen) {
414 if (check_pattern(buf, scanlen, mtd->writesize, bd))
415 return 1;
416 }
417 return 0;
418}
419
Brian Norris8b6e50c2011-05-25 14:59:01 -0700420/* Scan a given block partially */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200421static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd,
422 loff_t offs, uint8_t *buf, int len)
423{
424 struct mtd_oob_ops ops;
425 int j, ret;
426
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200427 ops.ooblen = mtd->oobsize;
428 ops.oobbuf = buf;
429 ops.ooboffs = 0;
430 ops.datbuf = NULL;
Brian Norris0612b9d2011-08-30 18:45:40 -0700431 ops.mode = MTD_OPS_PLACE_OOB;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200432
433 for (j = 0; j < len; j++) {
434 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700435 * Read the full oob until read_oob is fixed to handle single
436 * byte reads for 16 bit buswidth.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200437 */
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200438 ret = mtd_read_oob(mtd, offs, &ops);
Brian Norris903cd062011-06-28 16:28:58 -0700439 /* Ignore ECC errors when checking for BBM */
Brian Norrisd57f40542011-09-20 18:34:25 -0700440 if (ret && !mtd_is_bitflip_or_eccerr(ret))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200441 return ret;
442
443 if (check_short_pattern(buf, bd))
444 return 1;
445
446 offs += mtd->writesize;
447 }
448 return 0;
449}
450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451/**
452 * create_bbt - [GENERIC] Create a bad block table by scanning the device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700453 * @mtd: MTD device structure
454 * @buf: temporary buffer
455 * @bd: descriptor for the good/bad block search pattern
456 * @chip: create the table for a specific chip, -1 read all chips; applies only
457 * if NAND_BBT_PERCHIP option is set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700459 * Create a bad block table by scanning the device for the given good/bad block
460 * identify pattern.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200462static int create_bbt(struct mtd_info *mtd, uint8_t *buf,
463 struct nand_bbt_descr *bd, int chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464{
465 struct nand_chip *this = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200466 int i, numblocks, len, scanlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 int startblock;
468 loff_t from;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200469 size_t readlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Brian Norris9a4d4d62011-07-19 10:06:07 -0700471 pr_info("Scanning device for bad blocks\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473 if (bd->options & NAND_BBT_SCANALLPAGES)
474 len = 1 << (this->bbt_erase_shift - this->page_shift);
Brian Norris58373ff2010-07-15 12:15:44 -0700475 else if (bd->options & NAND_BBT_SCAN2NDPAGE)
476 len = 2;
477 else
478 len = 1;
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000479
480 if (!(bd->options & NAND_BBT_SCANEMPTY)) {
481 /* We need only read few bytes from the OOB area */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200482 scanlen = 0;
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000483 readlen = bd->len;
484 } else {
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000485 /* Full page content should be read */
Joern Engel28318772006-05-22 23:18:05 +0200486 scanlen = mtd->writesize + mtd->oobsize;
487 readlen = len * mtd->writesize;
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000488 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 if (chip == -1) {
Brian Norris8b6e50c2011-05-25 14:59:01 -0700491 /*
492 * Note that numblocks is 2 * (real numblocks) here, see i+=2
493 * below as it makes shifting and masking less painful
494 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 numblocks = mtd->size >> (this->bbt_erase_shift - 1);
496 startblock = 0;
497 from = 0;
498 } else {
499 if (chip >= this->numchips) {
Brian Norris9a4d4d62011-07-19 10:06:07 -0700500 pr_warn("create_bbt(): chipnr (%d) > available chips (%d)\n",
David Woodhousee0c7d762006-05-13 18:07:53 +0100501 chip + 1, this->numchips);
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000502 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 }
504 numblocks = this->chipsize >> (this->bbt_erase_shift - 1);
505 startblock = chip * numblocks;
506 numblocks += startblock;
Adrian Hunter69423d92008-12-10 13:37:21 +0000507 from = (loff_t)startblock << (this->bbt_erase_shift - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000509
Brian Norris5fb15492011-05-31 16:31:21 -0700510 if (this->bbt_options & NAND_BBT_SCANLASTPAGE)
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -0700511 from += mtd->erasesize - (mtd->writesize * len);
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 for (i = startblock; i < numblocks;) {
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000514 int ret;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000515
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200516 BUG_ON(bd->options & NAND_BBT_NO_OOB);
517
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200518 if (bd->options & NAND_BBT_SCANALLPAGES)
519 ret = scan_block_full(mtd, bd, from, buf, readlen,
520 scanlen, len);
521 else
522 ret = scan_block_fast(mtd, bd, from, buf, len);
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000523
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200524 if (ret < 0)
525 return ret;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000526
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200527 if (ret) {
528 this->bbt[i >> 3] |= 0x03 << (i & 0x6);
Brian Norris9a4d4d62011-07-19 10:06:07 -0700529 pr_warn("Bad eraseblock %d at 0x%012llx\n",
Brian Norrisd0370212011-07-19 10:06:08 -0700530 i >> 1, (unsigned long long)from);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200531 mtd->ecc_stats.badblocks++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 i += 2;
535 from += (1 << this->bbt_erase_shift);
536 }
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000537 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538}
539
540/**
541 * search_bbt - [GENERIC] scan the device for a specific bad block table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700542 * @mtd: MTD device structure
543 * @buf: temporary buffer
544 * @td: descriptor for the bad block table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700546 * Read the bad block table by searching for a given ident pattern. Search is
547 * preformed either from the beginning up or from the end of the device
548 * downwards. The search starts always at the start of a block. If the option
549 * NAND_BBT_PERCHIP is given, each chip is searched for a bbt, which contains
550 * the bad block information of this chip. This is necessary to provide support
551 * for certain DOC devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700553 * The bbt ident pattern resides in the oob area of the first page in a block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100555static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
557 struct nand_chip *this = mtd->priv;
558 int i, chips;
559 int bits, startblock, block, dir;
Joern Engel28318772006-05-22 23:18:05 +0200560 int scanlen = mtd->writesize + mtd->oobsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 int bbtblocks;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200562 int blocktopage = this->bbt_erase_shift - this->page_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Brian Norris8b6e50c2011-05-25 14:59:01 -0700564 /* Search direction top -> down? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 if (td->options & NAND_BBT_LASTBLOCK) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100566 startblock = (mtd->size >> this->bbt_erase_shift) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 dir = -1;
568 } else {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000569 startblock = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 dir = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000571 }
572
Brian Norris8b6e50c2011-05-25 14:59:01 -0700573 /* Do we have a bbt per chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (td->options & NAND_BBT_PERCHIP) {
575 chips = this->numchips;
576 bbtblocks = this->chipsize >> this->bbt_erase_shift;
577 startblock &= bbtblocks - 1;
578 } else {
579 chips = 1;
580 bbtblocks = mtd->size >> this->bbt_erase_shift;
581 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 /* Number of bits for each erase block in the bbt */
584 bits = td->options & NAND_BBT_NRBITS_MSK;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 for (i = 0; i < chips; i++) {
587 /* Reset version information */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000588 td->version[i] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 td->pages[i] = -1;
590 /* Scan the maximum number of blocks */
591 for (block = 0; block < td->maxblocks; block++) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 int actblock = startblock + dir * block;
Adrian Hunter69423d92008-12-10 13:37:21 +0000594 loff_t offs = (loff_t)actblock << this->bbt_erase_shift;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 /* Read first page */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200597 scan_read_raw(mtd, buf, offs, mtd->writesize, td);
Joern Engel28318772006-05-22 23:18:05 +0200598 if (!check_pattern(buf, scanlen, mtd->writesize, td)) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200599 td->pages[i] = actblock << blocktopage;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 if (td->options & NAND_BBT_VERSION) {
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200601 offs = bbt_get_ver_offs(mtd, td);
602 td->version[i] = buf[offs];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 }
604 break;
605 }
606 }
607 startblock += this->chipsize >> this->bbt_erase_shift;
608 }
609 /* Check, if we found a bbt for each requested chip */
610 for (i = 0; i < chips; i++) {
611 if (td->pages[i] == -1)
Brian Norris9a4d4d62011-07-19 10:06:07 -0700612 pr_warn("Bad block table not found for chip %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 else
Brian Norrisd0370212011-07-19 10:06:08 -0700614 pr_info("Bad block table found at page %d, version "
615 "0x%02X\n", td->pages[i], td->version[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000617 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618}
619
620/**
621 * search_read_bbts - [GENERIC] scan the device for bad block table(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -0700622 * @mtd: MTD device structure
623 * @buf: temporary buffer
624 * @td: descriptor for the bad block table
625 * @md: descriptor for the bad block table mirror
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700627 * Search and read the bad block table(s).
628 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100629static int search_read_bbts(struct mtd_info *mtd, uint8_t * buf, struct nand_bbt_descr *td, struct nand_bbt_descr *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
631 /* Search the primary table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100632 search_bbt(mtd, buf, td);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 /* Search the mirror table */
635 if (md)
David Woodhousee0c7d762006-05-13 18:07:53 +0100636 search_bbt(mtd, buf, md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000638 /* Force result check */
639 return 1;
640}
641
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000642/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 * write_bbt - [GENERIC] (Re)write the bad block table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700644 * @mtd: MTD device structure
645 * @buf: temporary buffer
646 * @td: descriptor for the bad block table
647 * @md: descriptor for the bad block table mirror
648 * @chipsel: selector for a specific chip, -1 for all
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700650 * (Re)write the bad block table.
651 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100652static int write_bbt(struct mtd_info *mtd, uint8_t *buf,
Thomas Gleixner9223a452006-05-23 17:21:03 +0200653 struct nand_bbt_descr *td, struct nand_bbt_descr *md,
654 int chipsel)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
656 struct nand_chip *this = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 struct erase_info einfo;
658 int i, j, res, chip = 0;
659 int bits, startblock, dir, page, offs, numblocks, sft, sftmsk;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200660 int nrchips, bbtoffs, pageoffs, ooboffs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 uint8_t msk[4];
662 uint8_t rcode = td->reserved_block_code;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200663 size_t retlen, len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 loff_t to;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200665 struct mtd_oob_ops ops;
666
667 ops.ooblen = mtd->oobsize;
668 ops.ooboffs = 0;
669 ops.datbuf = NULL;
Brian Norris0612b9d2011-08-30 18:45:40 -0700670 ops.mode = MTD_OPS_PLACE_OOB;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672 if (!rcode)
673 rcode = 0xff;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700674 /* Write bad block table per chip rather than per device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 if (td->options & NAND_BBT_PERCHIP) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100676 numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
Brian Norris8b6e50c2011-05-25 14:59:01 -0700677 /* Full device write or specific chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 if (chipsel == -1) {
679 nrchips = this->numchips;
680 } else {
681 nrchips = chipsel + 1;
682 chip = chipsel;
683 }
684 } else {
David Woodhousee0c7d762006-05-13 18:07:53 +0100685 numblocks = (int)(mtd->size >> this->bbt_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 nrchips = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000687 }
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 /* Loop through the chips */
690 for (; chip < nrchips; chip++) {
Brian Norris8b6e50c2011-05-25 14:59:01 -0700691 /*
692 * There was already a version of the table, reuse the page
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000693 * This applies for absolute placement too, as we have the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 * page nr. in td->pages.
695 */
696 if (td->pages[chip] != -1) {
697 page = td->pages[chip];
698 goto write;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
Brian Norris8b6e50c2011-05-25 14:59:01 -0700701 /*
702 * Automatic placement of the bad block table. Search direction
703 * top -> down?
704 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 if (td->options & NAND_BBT_LASTBLOCK) {
706 startblock = numblocks * (chip + 1) - 1;
707 dir = -1;
708 } else {
709 startblock = chip * numblocks;
710 dir = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000711 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 for (i = 0; i < td->maxblocks; i++) {
714 int block = startblock + dir * i;
715 /* Check, if the block is bad */
Thomas Gleixner9223a452006-05-23 17:21:03 +0200716 switch ((this->bbt[block >> 2] >>
717 (2 * (block & 0x03))) & 0x03) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 case 0x01:
719 case 0x03:
720 continue;
721 }
Thomas Gleixner9223a452006-05-23 17:21:03 +0200722 page = block <<
723 (this->bbt_erase_shift - this->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 /* Check, if the block is used by the mirror table */
725 if (!md || md->pages[chip] != page)
726 goto write;
727 }
Brian Norris9a4d4d62011-07-19 10:06:07 -0700728 pr_err("No space left to write bad block table\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 return -ENOSPC;
David Woodhousee0c7d762006-05-13 18:07:53 +0100730 write:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
732 /* Set up shift count and masks for the flash table */
733 bits = td->options & NAND_BBT_NRBITS_MSK;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200734 msk[2] = ~rcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 switch (bits) {
Thomas Gleixner9223a452006-05-23 17:21:03 +0200736 case 1: sft = 3; sftmsk = 0x07; msk[0] = 0x00; msk[1] = 0x01;
737 msk[3] = 0x01;
738 break;
739 case 2: sft = 2; sftmsk = 0x06; msk[0] = 0x00; msk[1] = 0x01;
740 msk[3] = 0x03;
741 break;
742 case 4: sft = 1; sftmsk = 0x04; msk[0] = 0x00; msk[1] = 0x0C;
743 msk[3] = 0x0f;
744 break;
745 case 8: sft = 0; sftmsk = 0x00; msk[0] = 0x00; msk[1] = 0x0F;
746 msk[3] = 0xff;
747 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 default: return -EINVAL;
749 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 bbtoffs = chip * (numblocks >> 2);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000752
Brian Norris596d7452011-09-07 13:13:33 -0700753 to = ((loff_t)page) << this->page_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Brian Norris8b6e50c2011-05-25 14:59:01 -0700755 /* Must we save the block contents? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 if (td->options & NAND_BBT_SAVECONTENT) {
757 /* Make it block aligned */
Brian Norris596d7452011-09-07 13:13:33 -0700758 to &= ~((loff_t)((1 << this->bbt_erase_shift) - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 len = 1 << this->bbt_erase_shift;
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200760 res = mtd_read(mtd, to, len, &retlen, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 if (res < 0) {
762 if (retlen != len) {
Brian Norrisd0370212011-07-19 10:06:08 -0700763 pr_info("nand_bbt: error reading block "
764 "for writing the bad block table\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 return res;
766 }
Brian Norrisd0370212011-07-19 10:06:08 -0700767 pr_warn("nand_bbt: ECC error while reading "
768 "block for writing bad block table\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 }
Thomas Gleixner9223a452006-05-23 17:21:03 +0200770 /* Read oob data */
Vitaly Wool70145682006-11-03 18:20:38 +0300771 ops.ooblen = (len >> this->page_shift) * mtd->oobsize;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200772 ops.oobbuf = &buf[len];
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200773 res = mtd_read_oob(mtd, to + mtd->writesize, &ops);
Vitaly Wool70145682006-11-03 18:20:38 +0300774 if (res < 0 || ops.oobretlen != ops.ooblen)
Thomas Gleixner9223a452006-05-23 17:21:03 +0200775 goto outerr;
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 /* Calc the byte offset in the buffer */
778 pageoffs = page - (int)(to >> this->page_shift);
779 offs = pageoffs << this->page_shift;
780 /* Preset the bbt area with 0xff */
Brian Norris596d7452011-09-07 13:13:33 -0700781 memset(&buf[offs], 0xff, (size_t)(numblocks >> sft));
Thomas Gleixner9223a452006-05-23 17:21:03 +0200782 ooboffs = len + (pageoffs * mtd->oobsize);
783
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200784 } else if (td->options & NAND_BBT_NO_OOB) {
785 ooboffs = 0;
786 offs = td->len;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700787 /* The version byte */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200788 if (td->options & NAND_BBT_VERSION)
789 offs++;
790 /* Calc length */
Brian Norris596d7452011-09-07 13:13:33 -0700791 len = (size_t)(numblocks >> sft);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200792 len += offs;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700793 /* Make it page aligned! */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200794 len = ALIGN(len, mtd->writesize);
795 /* Preset the buffer with 0xff */
796 memset(buf, 0xff, len);
797 /* Pattern is located at the begin of first page */
798 memcpy(buf, td->pattern, td->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 } else {
800 /* Calc length */
Brian Norris596d7452011-09-07 13:13:33 -0700801 len = (size_t)(numblocks >> sft);
Brian Norris8b6e50c2011-05-25 14:59:01 -0700802 /* Make it page aligned! */
Sebastian Andrzej Siewiorcda32092010-09-29 19:43:50 +0200803 len = ALIGN(len, mtd->writesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 /* Preset the buffer with 0xff */
Thomas Gleixner9223a452006-05-23 17:21:03 +0200805 memset(buf, 0xff, len +
806 (len >> this->page_shift)* mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 offs = 0;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200808 ooboffs = len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 /* Pattern is located in oob area of first page */
Thomas Gleixner9223a452006-05-23 17:21:03 +0200810 memcpy(&buf[ooboffs + td->offs], td->pattern, td->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000812
Thomas Gleixner9223a452006-05-23 17:21:03 +0200813 if (td->options & NAND_BBT_VERSION)
814 buf[ooboffs + td->veroffs] = td->version[chip];
815
Brian Norris8b6e50c2011-05-25 14:59:01 -0700816 /* Walk through the memory table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100817 for (i = 0; i < numblocks;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 uint8_t dat;
819 dat = this->bbt[bbtoffs + (i >> 2)];
David Woodhousee0c7d762006-05-13 18:07:53 +0100820 for (j = 0; j < 4; j++, i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 int sftcnt = (i << (3 - sft)) & sftmsk;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700822 /* Do not store the reserved bbt blocks! */
Thomas Gleixner9223a452006-05-23 17:21:03 +0200823 buf[offs + (i >> sft)] &=
824 ~(msk[dat & 0x03] << sftcnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 dat >>= 2;
826 }
827 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000828
David Woodhousee0c7d762006-05-13 18:07:53 +0100829 memset(&einfo, 0, sizeof(einfo));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 einfo.mtd = mtd;
Adrian Hunter69423d92008-12-10 13:37:21 +0000831 einfo.addr = to;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 einfo.len = 1 << this->bbt_erase_shift;
David Woodhousee0c7d762006-05-13 18:07:53 +0100833 res = nand_erase_nand(mtd, &einfo, 1);
Thomas Gleixner9223a452006-05-23 17:21:03 +0200834 if (res < 0)
835 goto outerr;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000836
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200837 res = scan_write_bbt(mtd, to, len, buf,
838 td->options & NAND_BBT_NO_OOB ? NULL :
839 &buf[len]);
Thomas Gleixner9223a452006-05-23 17:21:03 +0200840 if (res < 0)
841 goto outerr;
842
Brian Norrisd0370212011-07-19 10:06:08 -0700843 pr_info("Bad block table written to 0x%012llx, version 0x%02X\n",
844 (unsigned long long)to, td->version[chip]);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000845
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 /* Mark it as used */
847 td->pages[chip] = page;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000848 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 return 0;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200850
851 outerr:
Brian Norrisd0370212011-07-19 10:06:08 -0700852 pr_warn("nand_bbt: error while writing bad block table %d\n", res);
Thomas Gleixner9223a452006-05-23 17:21:03 +0200853 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854}
855
856/**
857 * nand_memory_bbt - [GENERIC] create a memory based bad block table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700858 * @mtd: MTD device structure
859 * @bd: descriptor for the good/bad block search pattern
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700861 * The function creates a memory based bbt by scanning the device for
862 * manufacturer / software marked good / bad blocks.
863 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100864static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865{
866 struct nand_chip *this = mtd->priv;
867
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000868 bd->options &= ~NAND_BBT_SCANEMPTY;
David Woodhouse4bf63fc2006-09-25 17:08:04 +0100869 return create_bbt(mtd, this->buffers->databuf, bd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870}
871
872/**
David Woodhousee0c7d762006-05-13 18:07:53 +0100873 * check_create - [GENERIC] create and write bbt(s) if necessary
Brian Norris8b6e50c2011-05-25 14:59:01 -0700874 * @mtd: MTD device structure
875 * @buf: temporary buffer
876 * @bd: descriptor for the good/bad block search pattern
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700878 * The function checks the results of the previous call to read_bbt and creates
879 * / updates the bbt(s) if necessary. Creation is necessary if no bbt was found
880 * for the chip/device. Update is necessary if one of the tables is missing or
881 * the version nr. of one table is less than the other.
882 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100883static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
Brian Norris623978d2011-09-20 18:35:34 -0700885 int i, chips, writeops, create, chipsel, res, res2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 struct nand_chip *this = mtd->priv;
887 struct nand_bbt_descr *td = this->bbt_td;
888 struct nand_bbt_descr *md = this->bbt_md;
889 struct nand_bbt_descr *rd, *rd2;
890
Brian Norris8b6e50c2011-05-25 14:59:01 -0700891 /* Do we have a bbt per chip? */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000892 if (td->options & NAND_BBT_PERCHIP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 chips = this->numchips;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000894 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 chips = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000896
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 for (i = 0; i < chips; i++) {
898 writeops = 0;
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700899 create = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 rd = NULL;
901 rd2 = NULL;
Brian Norris623978d2011-09-20 18:35:34 -0700902 res = res2 = 0;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700903 /* Per chip or per device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 chipsel = (td->options & NAND_BBT_PERCHIP) ? i : -1;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700905 /* Mirrored table available? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 if (md) {
907 if (td->pages[i] == -1 && md->pages[i] == -1) {
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700908 create = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 writeops = 0x03;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700910 } else if (td->pages[i] == -1) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000911 rd = md;
Brian Norris596d7452011-09-07 13:13:33 -0700912 writeops = 0x01;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700913 } else if (md->pages[i] == -1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 rd = td;
Brian Norris596d7452011-09-07 13:13:33 -0700915 writeops = 0x02;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700916 } else if (td->version[i] == md->version[i]) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 rd = td;
918 if (!(td->options & NAND_BBT_VERSION))
919 rd2 = md;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700920 } else if (((int8_t)(td->version[i] - md->version[i])) > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 rd = td;
Brian Norris596d7452011-09-07 13:13:33 -0700922 writeops = 0x02;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 } else {
924 rd = md;
Brian Norris596d7452011-09-07 13:13:33 -0700925 writeops = 0x01;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 } else {
928 if (td->pages[i] == -1) {
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700929 create = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 writeops = 0x01;
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700931 } else {
932 rd = td;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000935
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700936 if (create) {
937 /* Create the bad block table by scanning the device? */
938 if (!(td->options & NAND_BBT_CREATE))
939 continue;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000940
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700941 /* Create the table in memory by scanning the chip(s) */
942 if (!(this->bbt_options & NAND_BBT_CREATE_EMPTY))
943 create_bbt(mtd, buf, bd, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700945 td->version[i] = 1;
946 if (md)
947 md->version[i] = 1;
948 }
949
Brian Norris8b6e50c2011-05-25 14:59:01 -0700950 /* Read back first? */
Brian Norris623978d2011-09-20 18:35:34 -0700951 if (rd) {
952 res = read_abs_bbt(mtd, buf, rd, chipsel);
953 if (mtd_is_eccerr(res)) {
954 /* Mark table as invalid */
955 rd->pages[i] = -1;
Brian Norrisdadc17a2011-09-20 18:35:57 -0700956 rd->version[i] = 0;
Brian Norris623978d2011-09-20 18:35:34 -0700957 i--;
958 continue;
959 }
960 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700961 /* If they weren't versioned, read both */
Brian Norris623978d2011-09-20 18:35:34 -0700962 if (rd2) {
963 res2 = read_abs_bbt(mtd, buf, rd2, chipsel);
964 if (mtd_is_eccerr(res2)) {
965 /* Mark table as invalid */
966 rd2->pages[i] = -1;
Brian Norrisdadc17a2011-09-20 18:35:57 -0700967 rd2->version[i] = 0;
Brian Norris623978d2011-09-20 18:35:34 -0700968 i--;
969 continue;
970 }
971 }
972
973 /* Scrub the flash table(s)? */
974 if (mtd_is_bitflip(res) || mtd_is_bitflip(res2))
975 writeops = 0x03;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Brian Norrisdadc17a2011-09-20 18:35:57 -0700977 /* Update version numbers before writing */
978 if (md) {
979 td->version[i] = max(td->version[i], md->version[i]);
980 md->version[i] = td->version[i];
981 }
982
Brian Norris8b6e50c2011-05-25 14:59:01 -0700983 /* Write the bad block table to the device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100985 res = write_bbt(mtd, buf, td, md, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 if (res < 0)
987 return res;
988 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000989
Brian Norris8b6e50c2011-05-25 14:59:01 -0700990 /* Write the mirror bad block table to the device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100992 res = write_bbt(mtd, buf, md, td, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 if (res < 0)
994 return res;
995 }
996 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000997 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998}
999
1000/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001001 * mark_bbt_regions - [GENERIC] mark the bad block table regions
Brian Norris8b6e50c2011-05-25 14:59:01 -07001002 * @mtd: MTD device structure
1003 * @td: bad block table descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001005 * The bad block table regions are marked as "bad" to prevent accidental
1006 * erasures / writes. The regions are identified by the mark 0x02.
1007 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001008static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009{
1010 struct nand_chip *this = mtd->priv;
1011 int i, j, chips, block, nrblocks, update;
1012 uint8_t oldval, newval;
1013
Brian Norris8b6e50c2011-05-25 14:59:01 -07001014 /* Do we have a bbt per chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 if (td->options & NAND_BBT_PERCHIP) {
1016 chips = this->numchips;
1017 nrblocks = (int)(this->chipsize >> this->bbt_erase_shift);
1018 } else {
1019 chips = 1;
1020 nrblocks = (int)(mtd->size >> this->bbt_erase_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001021 }
1022
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 for (i = 0; i < chips; i++) {
1024 if ((td->options & NAND_BBT_ABSPAGE) ||
1025 !(td->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001026 if (td->pages[i] == -1)
1027 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 block = td->pages[i] >> (this->bbt_erase_shift - this->page_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001029 block <<= 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 oldval = this->bbt[(block >> 3)];
1031 newval = oldval | (0x2 << (block & 0x06));
1032 this->bbt[(block >> 3)] = newval;
1033 if ((oldval != newval) && td->reserved_block_code)
Adrian Hunter69423d92008-12-10 13:37:21 +00001034 nand_update_bbt(mtd, (loff_t)block << (this->bbt_erase_shift - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 continue;
1036 }
1037 update = 0;
1038 if (td->options & NAND_BBT_LASTBLOCK)
1039 block = ((i + 1) * nrblocks) - td->maxblocks;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001040 else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 block = i * nrblocks;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001042 block <<= 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 for (j = 0; j < td->maxblocks; j++) {
1044 oldval = this->bbt[(block >> 3)];
1045 newval = oldval | (0x2 << (block & 0x06));
1046 this->bbt[(block >> 3)] = newval;
David Woodhousee0c7d762006-05-13 18:07:53 +01001047 if (oldval != newval)
1048 update = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 block += 2;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001050 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07001051 /*
1052 * If we want reserved blocks to be recorded to flash, and some
1053 * new ones have been marked, then we need to update the stored
1054 * bbts. This should only happen once.
1055 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 if (update && td->reserved_block_code)
Adrian Hunter69423d92008-12-10 13:37:21 +00001057 nand_update_bbt(mtd, (loff_t)(block - 2) << (this->bbt_erase_shift - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 }
1059}
1060
1061/**
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001062 * verify_bbt_descr - verify the bad block description
Brian Norris8b6e50c2011-05-25 14:59:01 -07001063 * @mtd: MTD device structure
1064 * @bd: the table to verify
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001065 *
1066 * This functions performs a few sanity checks on the bad block description
1067 * table.
1068 */
1069static void verify_bbt_descr(struct mtd_info *mtd, struct nand_bbt_descr *bd)
1070{
1071 struct nand_chip *this = mtd->priv;
Stanislav Fomichev7912a5e2011-02-07 23:48:25 +03001072 u32 pattern_len;
1073 u32 bits;
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001074 u32 table_size;
1075
1076 if (!bd)
1077 return;
Stanislav Fomichev7912a5e2011-02-07 23:48:25 +03001078
1079 pattern_len = bd->len;
1080 bits = bd->options & NAND_BBT_NRBITS_MSK;
1081
Brian Norrisa40f7342011-05-31 16:31:22 -07001082 BUG_ON((this->bbt_options & NAND_BBT_NO_OOB) &&
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001083 !(this->bbt_options & NAND_BBT_USE_FLASH));
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001084 BUG_ON(!bits);
1085
1086 if (bd->options & NAND_BBT_VERSION)
1087 pattern_len++;
1088
1089 if (bd->options & NAND_BBT_NO_OOB) {
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001090 BUG_ON(!(this->bbt_options & NAND_BBT_USE_FLASH));
Brian Norrisa40f7342011-05-31 16:31:22 -07001091 BUG_ON(!(this->bbt_options & NAND_BBT_NO_OOB));
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001092 BUG_ON(bd->offs);
1093 if (bd->options & NAND_BBT_VERSION)
1094 BUG_ON(bd->veroffs != bd->len);
1095 BUG_ON(bd->options & NAND_BBT_SAVECONTENT);
1096 }
1097
1098 if (bd->options & NAND_BBT_PERCHIP)
1099 table_size = this->chipsize >> this->bbt_erase_shift;
1100 else
1101 table_size = mtd->size >> this->bbt_erase_shift;
1102 table_size >>= 3;
1103 table_size *= bits;
1104 if (bd->options & NAND_BBT_NO_OOB)
1105 table_size += pattern_len;
1106 BUG_ON(table_size > (1 << this->bbt_erase_shift));
1107}
1108
1109/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 * nand_scan_bbt - [NAND Interface] scan, find, read and maybe create bad block table(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07001111 * @mtd: MTD device structure
1112 * @bd: descriptor for the good/bad block search pattern
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001114 * The function checks, if a bad block table(s) is/are already available. If
1115 * not it scans the device for manufacturer marked good / bad blocks and writes
1116 * the bad block table(s) to the selected place.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001118 * The bad block table memory is allocated here. It must be freed by calling
1119 * the nand_free_bbt function.
1120 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001121int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122{
1123 struct nand_chip *this = mtd->priv;
1124 int len, res = 0;
1125 uint8_t *buf;
1126 struct nand_bbt_descr *td = this->bbt_td;
1127 struct nand_bbt_descr *md = this->bbt_md;
1128
1129 len = mtd->size >> (this->bbt_erase_shift + 2);
Brian Norris8b6e50c2011-05-25 14:59:01 -07001130 /*
1131 * Allocate memory (2bit per block) and clear the memory bad block
1132 * table.
1133 */
Burman Yan95b93a02006-11-15 21:10:29 +02001134 this->bbt = kzalloc(len, GFP_KERNEL);
Brian Norris08700662011-06-07 16:01:54 -07001135 if (!this->bbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
Brian Norris8b6e50c2011-05-25 14:59:01 -07001138 /*
1139 * If no primary table decriptor is given, scan the device to build a
1140 * memory based bad block table.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 */
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +00001142 if (!td) {
1143 if ((res = nand_memory_bbt(mtd, bd))) {
Brian Norrisd0370212011-07-19 10:06:08 -07001144 pr_err("nand_bbt: can't scan flash and build the RAM-based BBT\n");
David Woodhousee0c7d762006-05-13 18:07:53 +01001145 kfree(this->bbt);
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +00001146 this->bbt = NULL;
1147 }
1148 return res;
1149 }
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001150 verify_bbt_descr(mtd, td);
1151 verify_bbt_descr(mtd, md);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
1153 /* Allocate a temporary buffer for one eraseblock incl. oob */
1154 len = (1 << this->bbt_erase_shift);
1155 len += (len >> this->page_shift) * mtd->oobsize;
David Woodhousec3f8abf2006-05-13 04:03:42 +01001156 buf = vmalloc(len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 if (!buf) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001158 kfree(this->bbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 this->bbt = NULL;
1160 return -ENOMEM;
1161 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001162
Brian Norris8b6e50c2011-05-25 14:59:01 -07001163 /* Is the bbt at a given page? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 if (td->options & NAND_BBT_ABSPAGE) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001165 res = read_abs_bbts(mtd, buf, td, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001166 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 /* Search the bad block table using a pattern in oob */
David Woodhousee0c7d762006-05-13 18:07:53 +01001168 res = search_read_bbts(mtd, buf, td, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001169 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001171 if (res)
David Woodhousee0c7d762006-05-13 18:07:53 +01001172 res = check_create(mtd, buf, bd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 /* Prevent the bbt regions from erasing / writing */
David Woodhousee0c7d762006-05-13 18:07:53 +01001175 mark_bbt_region(mtd, td);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 if (md)
David Woodhousee0c7d762006-05-13 18:07:53 +01001177 mark_bbt_region(mtd, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001178
David Woodhousee0c7d762006-05-13 18:07:53 +01001179 vfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 return res;
1181}
1182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001184 * nand_update_bbt - [NAND Interface] update bad block table(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07001185 * @mtd: MTD device structure
1186 * @offs: the offset of the newly marked block
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001188 * The function updates the bad block table(s).
1189 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001190int nand_update_bbt(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
1192 struct nand_chip *this = mtd->priv;
Brian Norris1196ac52011-09-07 13:13:32 -07001193 int len, res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 int chip, chipsel;
1195 uint8_t *buf;
1196 struct nand_bbt_descr *td = this->bbt_td;
1197 struct nand_bbt_descr *md = this->bbt_md;
1198
1199 if (!this->bbt || !td)
1200 return -EINVAL;
1201
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 /* Allocate a temporary buffer for one eraseblock incl. oob */
1203 len = (1 << this->bbt_erase_shift);
1204 len += (len >> this->page_shift) * mtd->oobsize;
David Woodhousee0c7d762006-05-13 18:07:53 +01001205 buf = kmalloc(len, GFP_KERNEL);
Brian Norris08700662011-06-07 16:01:54 -07001206 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 return -ENOMEM;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001208
Brian Norris8b6e50c2011-05-25 14:59:01 -07001209 /* Do we have a bbt per chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 if (td->options & NAND_BBT_PERCHIP) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001211 chip = (int)(offs >> this->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 chipsel = chip;
1213 } else {
1214 chip = 0;
1215 chipsel = -1;
1216 }
1217
1218 td->version[chip]++;
1219 if (md)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001220 md->version[chip]++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Brian Norris8b6e50c2011-05-25 14:59:01 -07001222 /* Write the bad block table to the device? */
Brian Norris1196ac52011-09-07 13:13:32 -07001223 if (td->options & NAND_BBT_WRITE) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001224 res = write_bbt(mtd, buf, td, md, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 if (res < 0)
1226 goto out;
1227 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07001228 /* Write the mirror bad block table to the device? */
Brian Norris1196ac52011-09-07 13:13:32 -07001229 if (md && (md->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001230 res = write_bbt(mtd, buf, md, td, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 }
1232
David Woodhousee0c7d762006-05-13 18:07:53 +01001233 out:
1234 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 return res;
1236}
1237
Brian Norris8b6e50c2011-05-25 14:59:01 -07001238/*
1239 * Define some generic bad / good block scan pattern which are used
1240 * while scanning a device for factory marked good / bad blocks.
1241 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244static uint8_t scan_agand_pattern[] = { 0x1C, 0x71, 0xC7, 0x1C, 0x71, 0xC7 };
1245
1246static struct nand_bbt_descr agand_flashbased = {
1247 .options = NAND_BBT_SCANEMPTY | NAND_BBT_SCANALLPAGES,
1248 .offs = 0x20,
1249 .len = 6,
1250 .pattern = scan_agand_pattern
1251};
1252
Brian Norris7854d3f2011-06-23 14:12:08 -07001253/* Generic flash bbt descriptors */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1255static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1256
1257static struct nand_bbt_descr bbt_main_descr = {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001258 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1260 .offs = 8,
1261 .len = 4,
1262 .veroffs = 12,
1263 .maxblocks = 4,
1264 .pattern = bbt_pattern
1265};
1266
1267static struct nand_bbt_descr bbt_mirror_descr = {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001268 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1270 .offs = 8,
1271 .len = 4,
1272 .veroffs = 12,
1273 .maxblocks = 4,
1274 .pattern = mirror_pattern
1275};
1276
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001277static struct nand_bbt_descr bbt_main_no_bbt_descr = {
1278 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1279 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1280 | NAND_BBT_NO_OOB,
1281 .len = 4,
1282 .veroffs = 4,
1283 .maxblocks = 4,
1284 .pattern = bbt_pattern
1285};
1286
1287static struct nand_bbt_descr bbt_mirror_no_bbt_descr = {
1288 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1289 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1290 | NAND_BBT_NO_OOB,
1291 .len = 4,
1292 .veroffs = 4,
1293 .maxblocks = 4,
1294 .pattern = mirror_pattern
1295};
1296
Brian Norris752ed6c2011-09-20 18:36:42 -07001297#define BADBLOCK_SCAN_MASK (~NAND_BBT_NO_OOB)
Brian Norris58373ff2010-07-15 12:15:44 -07001298/**
Brian Norris752ed6c2011-09-20 18:36:42 -07001299 * nand_create_badblock_pattern - [INTERN] Creates a BBT descriptor structure
Brian Norris8b6e50c2011-05-25 14:59:01 -07001300 * @this: NAND chip to create descriptor for
Brian Norris58373ff2010-07-15 12:15:44 -07001301 *
1302 * This function allocates and initializes a nand_bbt_descr for BBM detection
Brian Norris752ed6c2011-09-20 18:36:42 -07001303 * based on the properties of @this. The new descriptor is stored in
Brian Norris58373ff2010-07-15 12:15:44 -07001304 * this->badblock_pattern. Thus, this->badblock_pattern should be NULL when
1305 * passed to this function.
Brian Norris58373ff2010-07-15 12:15:44 -07001306 */
Brian Norris752ed6c2011-09-20 18:36:42 -07001307static int nand_create_badblock_pattern(struct nand_chip *this)
Brian Norris58373ff2010-07-15 12:15:44 -07001308{
1309 struct nand_bbt_descr *bd;
1310 if (this->badblock_pattern) {
Brian Norris752ed6c2011-09-20 18:36:42 -07001311 pr_warn("Bad block pattern already allocated; not replacing\n");
Brian Norris58373ff2010-07-15 12:15:44 -07001312 return -EINVAL;
1313 }
1314 bd = kzalloc(sizeof(*bd), GFP_KERNEL);
Brian Norris08700662011-06-07 16:01:54 -07001315 if (!bd)
Brian Norris58373ff2010-07-15 12:15:44 -07001316 return -ENOMEM;
Brian Norris752ed6c2011-09-20 18:36:42 -07001317 bd->options = this->bbt_options & BADBLOCK_SCAN_MASK;
Brian Norris58373ff2010-07-15 12:15:44 -07001318 bd->offs = this->badblockpos;
1319 bd->len = (this->options & NAND_BUSWIDTH_16) ? 2 : 1;
1320 bd->pattern = scan_ff_pattern;
1321 bd->options |= NAND_BBT_DYNAMICSTRUCT;
1322 this->badblock_pattern = bd;
1323 return 0;
1324}
1325
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001327 * nand_default_bbt - [NAND Interface] Select a default bad block table for the device
Brian Norris8b6e50c2011-05-25 14:59:01 -07001328 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001330 * This function selects the default bad block table support for the device and
1331 * calls the nand_scan_bbt function.
1332 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001333int nand_default_bbt(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334{
1335 struct nand_chip *this = mtd->priv;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001336
Brian Norris8b6e50c2011-05-25 14:59:01 -07001337 /*
1338 * Default for AG-AND. We must use a flash based bad block table as the
1339 * devices have factory marked _good_ blocks. Erasing those blocks
1340 * leads to loss of the good / bad information, so we _must_ store this
1341 * information in a good / bad table during startup.
David Woodhousee0c7d762006-05-13 18:07:53 +01001342 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 if (this->options & NAND_IS_AND) {
1344 /* Use the default pattern descriptors */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001345 if (!this->bbt_td) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 this->bbt_td = &bbt_main_descr;
1347 this->bbt_md = &bbt_mirror_descr;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001348 }
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001349 this->bbt_options |= NAND_BBT_USE_FLASH;
David Woodhousee0c7d762006-05-13 18:07:53 +01001350 return nand_scan_bbt(mtd, &agand_flashbased);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001352
Brian Norris8b6e50c2011-05-25 14:59:01 -07001353 /* Is a flash based bad block table requested? */
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001354 if (this->bbt_options & NAND_BBT_USE_FLASH) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001355 /* Use the default pattern descriptors */
1356 if (!this->bbt_td) {
Brian Norrisa40f7342011-05-31 16:31:22 -07001357 if (this->bbt_options & NAND_BBT_NO_OOB) {
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001358 this->bbt_td = &bbt_main_no_bbt_descr;
1359 this->bbt_md = &bbt_mirror_no_bbt_descr;
1360 } else {
1361 this->bbt_td = &bbt_main_descr;
1362 this->bbt_md = &bbt_mirror_descr;
1363 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 } else {
1366 this->bbt_td = NULL;
1367 this->bbt_md = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
Brian Norrisa2f812d2011-03-18 21:53:42 -07001369
1370 if (!this->badblock_pattern)
Brian Norris752ed6c2011-09-20 18:36:42 -07001371 nand_create_badblock_pattern(this);
Brian Norrisa2f812d2011-03-18 21:53:42 -07001372
David Woodhousee0c7d762006-05-13 18:07:53 +01001373 return nand_scan_bbt(mtd, this->badblock_pattern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374}
1375
1376/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001377 * nand_isbad_bbt - [NAND Interface] Check if a block is bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07001378 * @mtd: MTD device structure
1379 * @offs: offset in the device
1380 * @allowbbt: allow access to bad block table region
1381 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001382int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383{
1384 struct nand_chip *this = mtd->priv;
1385 int block;
David Woodhousee0c7d762006-05-13 18:07:53 +01001386 uint8_t res;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001387
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 /* Get block number * 2 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001389 block = (int)(offs >> (this->bbt_erase_shift - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 res = (this->bbt[block >> 3] >> (block & 0x06)) & 0x03;
1391
Brian Norris289c0522011-07-19 10:06:09 -07001392 pr_debug("nand_isbad_bbt(): bbt info for offs 0x%08x: "
1393 "(block %d) 0x%02x\n",
1394 (unsigned int)offs, block >> 1, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
1396 switch ((int)res) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001397 case 0x00:
1398 return 0;
1399 case 0x01:
1400 return 1;
1401 case 0x02:
1402 return allowbbt ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 }
1404 return 1;
1405}
1406
David Woodhousee0c7d762006-05-13 18:07:53 +01001407EXPORT_SYMBOL(nand_scan_bbt);
1408EXPORT_SYMBOL(nand_default_bbt);