blob: 3ff9d367a624698caa8a17eb9c194b96c04d7175 [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 *
Fabio Estevamd159c4e2012-07-28 19:29:25 -03007 * Copyright © 2004 Thomas Gleixner (tglx@linutronix.de)
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
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
Huang Shijie44ed0ff2012-07-03 16:44:15 +080025 * version number, then 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>
Richard Genoud61de9da2012-09-11 15:50:54 +020065#include <linux/mtd/bbm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#include <linux/mtd/nand.h>
67#include <linux/mtd/nand_ecc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#include <linux/bitops.h>
69#include <linux/delay.h>
David Woodhousec3f8abf2006-05-13 04:03:42 +010070#include <linux/vmalloc.h>
Paul Gortmakerf3bcc012011-07-10 12:43:28 -040071#include <linux/export.h>
Brian Norris491ed062012-06-22 16:35:44 -070072#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Brian Norris771c5682013-07-30 17:52:55 -070074#define BBT_BLOCK_GOOD 0x00
75#define BBT_BLOCK_WORN 0x01
76#define BBT_BLOCK_RESERVED 0x02
77#define BBT_BLOCK_FACTORY_BAD 0x03
78
79#define BBT_ENTRY_MASK 0x03
80#define BBT_ENTRY_SHIFT 2
81
82static inline uint8_t bbt_get_entry(struct nand_chip *chip, int block)
83{
84 uint8_t entry = chip->bbt[block >> BBT_ENTRY_SHIFT];
85 entry >>= (block & BBT_ENTRY_MASK) * 2;
86 return entry & BBT_ENTRY_MASK;
87}
88
89static inline void bbt_mark_entry(struct nand_chip *chip, int block,
90 uint8_t mark)
91{
92 uint8_t msk = (mark & BBT_ENTRY_MASK) << ((block & BBT_ENTRY_MASK) * 2);
93 chip->bbt[block >> BBT_ENTRY_SHIFT] |= msk;
94}
95
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +020096static int check_pattern_no_oob(uint8_t *buf, struct nand_bbt_descr *td)
97{
Brian Norris718894a2012-06-22 16:35:43 -070098 if (memcmp(buf, td->pattern, td->len))
99 return -1;
100 return 0;
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200101}
102
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000103/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * check_pattern - [GENERIC] check if a pattern is in the buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700105 * @buf: the buffer to search
106 * @len: the length of buffer to search
107 * @paglen: the pagelength
108 * @td: search pattern descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700110 * Check for a pattern at the given place. Used to search bad block tables and
111 * good / bad block identifiers. If the SCAN_EMPTY option is set then check, if
112 * all bytes except the pattern area contain 0xff.
113 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100114static int check_pattern(uint8_t *buf, int len, int paglen, struct nand_bbt_descr *td)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
Brian Norris491ed062012-06-22 16:35:44 -0700116 int end = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 uint8_t *p = buf;
118
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200119 if (td->options & NAND_BBT_NO_OOB)
120 return check_pattern_no_oob(buf, td);
121
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100122 end = paglen + td->offs;
Brian Norris491ed062012-06-22 16:35:44 -0700123 if (td->options & NAND_BBT_SCANEMPTY)
124 if (memchr_inv(p, 0xff, end))
125 return -1;
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100126 p += end;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 /* Compare the pattern */
Brian Norris75b66d82011-09-07 13:13:41 -0700129 if (memcmp(p, td->pattern, td->len))
130 return -1;
Brian Norris58373ff2010-07-15 12:15:44 -0700131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 if (td->options & NAND_BBT_SCANEMPTY) {
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000133 p += td->len;
134 end += td->len;
Brian Norris491ed062012-06-22 16:35:44 -0700135 if (memchr_inv(p, 0xff, len - end))
136 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 }
138 return 0;
139}
140
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000141/**
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100142 * check_short_pattern - [GENERIC] check if a pattern is in the buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700143 * @buf: the buffer to search
144 * @td: search pattern descriptor
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100145 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700146 * Check for a pattern at the given place. Used to search bad block tables and
147 * good / bad block identifiers. Same as check_pattern, but no optional empty
148 * check.
149 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100150static int check_short_pattern(uint8_t *buf, struct nand_bbt_descr *td)
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100151{
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100152 /* Compare the pattern */
Brian Norris491ed062012-06-22 16:35:44 -0700153 if (memcmp(buf + td->offs, td->pattern, td->len))
154 return -1;
Thomas Gleixnerc9e053652005-06-14 16:39:57 +0100155 return 0;
156}
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158/**
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200159 * add_marker_len - compute the length of the marker in data area
Brian Norris8b6e50c2011-05-25 14:59:01 -0700160 * @td: BBT descriptor used for computation
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200161 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700162 * The length will be 0 if the marker is located in OOB area.
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200163 */
164static u32 add_marker_len(struct nand_bbt_descr *td)
165{
166 u32 len;
167
168 if (!(td->options & NAND_BBT_NO_OOB))
169 return 0;
170
171 len = td->len;
172 if (td->options & NAND_BBT_VERSION)
173 len++;
174 return len;
175}
176
177/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * read_bbt - [GENERIC] Read the bad block table starting from page
Brian Norris8b6e50c2011-05-25 14:59:01 -0700179 * @mtd: MTD device structure
180 * @buf: temporary buffer
181 * @page: the starting page
182 * @num: the number of bbt descriptors to read
Brian Norris7854d3f2011-06-23 14:12:08 -0700183 * @td: the bbt describtion table
Brian Norrisb4d20d62013-07-30 17:52:56 -0700184 * @offs: block number offset in the table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 *
186 * Read the bad block table starting from page.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100188static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num,
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200189 struct nand_bbt_descr *td, int offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
Brian Norris167a8d52011-09-20 18:35:08 -0700191 int res, ret = 0, i, j, act = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 struct nand_chip *this = mtd->priv;
193 size_t retlen, len, totlen;
194 loff_t from;
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200195 int bits = td->options & NAND_BBT_NRBITS_MSK;
Brian Norris596d7452011-09-07 13:13:33 -0700196 uint8_t msk = (uint8_t)((1 << bits) - 1);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200197 u32 marker_len;
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200198 int reserved_block_code = td->reserved_block_code;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 totlen = (num * bits) >> 3;
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200201 marker_len = add_marker_len(td);
Brian Norris596d7452011-09-07 13:13:33 -0700202 from = ((loff_t)page) << this->page_shift;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 while (totlen) {
Brian Norris596d7452011-09-07 13:13:33 -0700205 len = min(totlen, (size_t)(1 << this->bbt_erase_shift));
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200206 if (marker_len) {
207 /*
208 * In case the BBT marker is not in the OOB area it
209 * will be just in the first page.
210 */
211 len -= marker_len;
212 from += marker_len;
213 marker_len = 0;
214 }
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200215 res = mtd_read(mtd, from, len, &retlen, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 if (res < 0) {
Brian Norris167a8d52011-09-20 18:35:08 -0700217 if (mtd_is_eccerr(res)) {
218 pr_info("nand_bbt: ECC error in BBT at "
219 "0x%012llx\n", from & ~mtd->writesize);
220 return res;
221 } else if (mtd_is_bitflip(res)) {
222 pr_info("nand_bbt: corrected error in BBT at "
223 "0x%012llx\n", from & ~mtd->writesize);
224 ret = res;
225 } else {
226 pr_info("nand_bbt: error reading BBT\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 return res;
228 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231 /* Analyse data */
232 for (i = 0; i < len; i++) {
233 uint8_t dat = buf[i];
Brian Norrisb4d20d62013-07-30 17:52:56 -0700234 for (j = 0; j < 8; j += bits, act++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 uint8_t tmp = (dat >> j) & msk;
236 if (tmp == msk)
237 continue;
David Woodhousee0c7d762006-05-13 18:07:53 +0100238 if (reserved_block_code && (tmp == reserved_block_code)) {
Brian Norrisd0370212011-07-19 10:06:08 -0700239 pr_info("nand_read_bbt: reserved block at 0x%012llx\n",
Brian Norrisb4d20d62013-07-30 17:52:56 -0700240 (loff_t)(offs + act) <<
241 this->bbt_erase_shift);
242 bbt_mark_entry(this, offs + act,
Brian Norris771c5682013-07-30 17:52:55 -0700243 BBT_BLOCK_RESERVED);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200244 mtd->ecc_stats.bbtblocks++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 continue;
246 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700247 /*
248 * Leave it for now, if it's matured we can
Brian Norrisa0f50802011-07-19 10:06:06 -0700249 * move this message to pr_debug.
Brian Norris8b6e50c2011-05-25 14:59:01 -0700250 */
Brian Norrisd0370212011-07-19 10:06:08 -0700251 pr_info("nand_read_bbt: bad block at 0x%012llx\n",
Brian Norrisb4d20d62013-07-30 17:52:56 -0700252 (loff_t)(offs + act) <<
253 this->bbt_erase_shift);
Brian Norris8b6e50c2011-05-25 14:59:01 -0700254 /* Factory marked bad or worn out? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 if (tmp == 0)
Brian Norrisb4d20d62013-07-30 17:52:56 -0700256 bbt_mark_entry(this, offs + act,
Brian Norris771c5682013-07-30 17:52:55 -0700257 BBT_BLOCK_FACTORY_BAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 else
Brian Norrisb4d20d62013-07-30 17:52:56 -0700259 bbt_mark_entry(this, offs + act,
Brian Norris771c5682013-07-30 17:52:55 -0700260 BBT_BLOCK_WORN);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200261 mtd->ecc_stats.badblocks++;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
264 totlen -= len;
265 from += len;
266 }
Brian Norris167a8d52011-09-20 18:35:08 -0700267 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
269
270/**
271 * read_abs_bbt - [GENERIC] Read the bad block table starting at a given page
Brian Norris8b6e50c2011-05-25 14:59:01 -0700272 * @mtd: MTD device structure
273 * @buf: temporary buffer
274 * @td: descriptor for the bad block table
Brian Norris596d7452011-09-07 13:13:33 -0700275 * @chip: read the table for a specific chip, -1 read all chips; applies only if
Brian Norris8b6e50c2011-05-25 14:59:01 -0700276 * NAND_BBT_PERCHIP option is set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700278 * Read the bad block table for all chips starting at a given page. We assume
279 * that the bbt bits are in consecutive order.
280 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100281static 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 -0700282{
283 struct nand_chip *this = mtd->priv;
284 int res = 0, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 if (td->options & NAND_BBT_PERCHIP) {
287 int offs = 0;
288 for (i = 0; i < this->numchips; i++) {
289 if (chip == -1 || chip == i)
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200290 res = read_bbt(mtd, buf, td->pages[i],
291 this->chipsize >> this->bbt_erase_shift,
292 td, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 if (res)
294 return res;
Brian Norrisb4d20d62013-07-30 17:52:56 -0700295 offs += this->chipsize >> this->bbt_erase_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 }
297 } else {
Sebastian Andrzej Siewiordf5b4e32010-09-29 19:43:51 +0200298 res = read_bbt(mtd, buf, td->pages[0],
299 mtd->size >> this->bbt_erase_shift, td, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 if (res)
301 return res;
302 }
303 return 0;
304}
305
Brian Norris8b6e50c2011-05-25 14:59:01 -0700306/* BBT marker is in the first page, no OOB */
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700307static int scan_read_data(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200308 struct nand_bbt_descr *td)
309{
310 size_t retlen;
311 size_t len;
312
313 len = td->len;
314 if (td->options & NAND_BBT_VERSION)
315 len++;
316
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200317 return mtd_read(mtd, offs, len, &retlen, buf);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200318}
319
Brian Norrisa7e68832012-06-22 16:35:45 -0700320/**
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700321 * scan_read_oob - [GENERIC] Scan data+OOB region to buffer
Brian Norrisa7e68832012-06-22 16:35:45 -0700322 * @mtd: MTD device structure
323 * @buf: temporary buffer
324 * @offs: offset at which to scan
325 * @len: length of data region to read
326 *
327 * Scan read data from data+OOB. May traverse multiple pages, interleaving
328 * page,OOB,page,OOB,... in buf. Completes transfer and returns the "strongest"
329 * ECC condition (error or bitflip). May quit on the first (non-ECC) error.
330 */
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700331static int scan_read_oob(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200332 size_t len)
333{
334 struct mtd_oob_ops ops;
Brian Norrisa7e68832012-06-22 16:35:45 -0700335 int res, ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200336
Brian Norrisa7e68832012-06-22 16:35:45 -0700337 ops.mode = MTD_OPS_PLACE_OOB;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200338 ops.ooboffs = 0;
339 ops.ooblen = mtd->oobsize;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200340
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200341 while (len > 0) {
Brian Norris105513c2011-09-07 13:13:28 -0700342 ops.datbuf = buf;
343 ops.len = min(len, (size_t)mtd->writesize);
344 ops.oobbuf = buf + ops.len;
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200345
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200346 res = mtd_read_oob(mtd, offs, &ops);
Brian Norrisa7e68832012-06-22 16:35:45 -0700347 if (res) {
348 if (!mtd_is_bitflip_or_eccerr(res))
349 return res;
350 else if (mtd_is_eccerr(res) || !ret)
351 ret = res;
352 }
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200353
354 buf += mtd->oobsize + mtd->writesize;
355 len -= mtd->writesize;
Dmitry Maluka34a57042012-05-11 20:51:51 +0300356 offs += mtd->writesize;
Maxim Levitskyb64d39d2010-02-22 20:39:37 +0200357 }
Brian Norrisa7e68832012-06-22 16:35:45 -0700358 return ret;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200359}
360
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700361static int scan_read(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200362 size_t len, struct nand_bbt_descr *td)
363{
364 if (td->options & NAND_BBT_NO_OOB)
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700365 return scan_read_data(mtd, buf, offs, td);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200366 else
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700367 return scan_read_oob(mtd, buf, offs, len);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200368}
369
Brian Norris8b6e50c2011-05-25 14:59:01 -0700370/* Scan write data with oob to flash */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200371static int scan_write_bbt(struct mtd_info *mtd, loff_t offs, size_t len,
372 uint8_t *buf, uint8_t *oob)
373{
374 struct mtd_oob_ops ops;
375
Brian Norris0612b9d2011-08-30 18:45:40 -0700376 ops.mode = MTD_OPS_PLACE_OOB;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200377 ops.ooboffs = 0;
378 ops.ooblen = mtd->oobsize;
379 ops.datbuf = buf;
380 ops.oobbuf = oob;
381 ops.len = len;
382
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200383 return mtd_write_oob(mtd, offs, &ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200384}
385
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200386static u32 bbt_get_ver_offs(struct mtd_info *mtd, struct nand_bbt_descr *td)
387{
388 u32 ver_offs = td->veroffs;
389
390 if (!(td->options & NAND_BBT_NO_OOB))
391 ver_offs += mtd->writesize;
392 return ver_offs;
393}
394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395/**
396 * 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 -0700397 * @mtd: MTD device structure
398 * @buf: temporary buffer
399 * @td: descriptor for the bad block table
400 * @md: descriptor for the bad block table mirror
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700402 * Read the bad block table(s) for all chips starting at a given page. We
403 * assume that the bbt bits are in consecutive order.
404 */
Brian Norris7b5a2d42012-06-22 16:35:41 -0700405static void read_abs_bbts(struct mtd_info *mtd, uint8_t *buf,
406 struct nand_bbt_descr *td, struct nand_bbt_descr *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
408 struct nand_chip *this = mtd->priv;
409
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000410 /* Read the primary version, if available */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 if (td->options & NAND_BBT_VERSION) {
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700412 scan_read(mtd, buf, (loff_t)td->pages[0] << this->page_shift,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200413 mtd->writesize, td);
414 td->version[0] = buf[bbt_get_ver_offs(mtd, td)];
Brian Norris9a4d4d62011-07-19 10:06:07 -0700415 pr_info("Bad block table at page %d, version 0x%02X\n",
Brian Norrisd0370212011-07-19 10:06:08 -0700416 td->pages[0], td->version[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 }
418
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000419 /* Read the mirror version, if available */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 if (md && (md->options & NAND_BBT_VERSION)) {
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700421 scan_read(mtd, buf, (loff_t)md->pages[0] << this->page_shift,
Shmulik Ladkani7bb9c752012-06-10 13:58:12 +0300422 mtd->writesize, md);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200423 md->version[0] = buf[bbt_get_ver_offs(mtd, md)];
Brian Norris9a4d4d62011-07-19 10:06:07 -0700424 pr_info("Bad block table at page %d, version 0x%02X\n",
Brian Norrisd0370212011-07-19 10:06:08 -0700425 md->pages[0], md->version[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427}
428
Brian Norris8b6e50c2011-05-25 14:59:01 -0700429/* Scan a given block full */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200430static int scan_block_full(struct mtd_info *mtd, struct nand_bbt_descr *bd,
431 loff_t offs, uint8_t *buf, size_t readlen,
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300432 int scanlen, int numpages)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200433{
434 int ret, j;
435
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700436 ret = scan_read_oob(mtd, buf, offs, readlen);
Brian Norrisafa17de2011-09-07 13:13:29 -0700437 /* Ignore ECC errors when checking for BBM */
Brian Norrisd57f40542011-09-20 18:34:25 -0700438 if (ret && !mtd_is_bitflip_or_eccerr(ret))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200439 return ret;
440
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300441 for (j = 0; j < numpages; j++, buf += scanlen) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200442 if (check_pattern(buf, scanlen, mtd->writesize, bd))
443 return 1;
444 }
445 return 0;
446}
447
Brian Norris8b6e50c2011-05-25 14:59:01 -0700448/* Scan a given block partially */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200449static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd,
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300450 loff_t offs, uint8_t *buf, int numpages)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200451{
452 struct mtd_oob_ops ops;
453 int j, ret;
454
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200455 ops.ooblen = mtd->oobsize;
456 ops.oobbuf = buf;
457 ops.ooboffs = 0;
458 ops.datbuf = NULL;
Brian Norris0612b9d2011-08-30 18:45:40 -0700459 ops.mode = MTD_OPS_PLACE_OOB;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200460
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300461 for (j = 0; j < numpages; j++) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200462 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700463 * Read the full oob until read_oob is fixed to handle single
464 * byte reads for 16 bit buswidth.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200465 */
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200466 ret = mtd_read_oob(mtd, offs, &ops);
Brian Norris903cd062011-06-28 16:28:58 -0700467 /* Ignore ECC errors when checking for BBM */
Brian Norrisd57f40542011-09-20 18:34:25 -0700468 if (ret && !mtd_is_bitflip_or_eccerr(ret))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200469 return ret;
470
471 if (check_short_pattern(buf, bd))
472 return 1;
473
474 offs += mtd->writesize;
475 }
476 return 0;
477}
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479/**
480 * create_bbt - [GENERIC] Create a bad block table by scanning the device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700481 * @mtd: MTD device structure
482 * @buf: temporary buffer
483 * @bd: descriptor for the good/bad block search pattern
484 * @chip: create the table for a specific chip, -1 read all chips; applies only
485 * if NAND_BBT_PERCHIP option is set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700487 * Create a bad block table by scanning the device for the given good/bad block
488 * identify pattern.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200490static int create_bbt(struct mtd_info *mtd, uint8_t *buf,
491 struct nand_bbt_descr *bd, int chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
493 struct nand_chip *this = mtd->priv;
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300494 int i, numblocks, numpages, scanlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 int startblock;
496 loff_t from;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200497 size_t readlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Brian Norris9a4d4d62011-07-19 10:06:07 -0700499 pr_info("Scanning device for bad blocks\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
501 if (bd->options & NAND_BBT_SCANALLPAGES)
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300502 numpages = 1 << (this->bbt_erase_shift - this->page_shift);
Brian Norris58373ff2010-07-15 12:15:44 -0700503 else if (bd->options & NAND_BBT_SCAN2NDPAGE)
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300504 numpages = 2;
Brian Norris58373ff2010-07-15 12:15:44 -0700505 else
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300506 numpages = 1;
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000507
508 if (!(bd->options & NAND_BBT_SCANEMPTY)) {
509 /* We need only read few bytes from the OOB area */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200510 scanlen = 0;
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000511 readlen = bd->len;
512 } else {
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000513 /* Full page content should be read */
Joern Engel28318772006-05-22 23:18:05 +0200514 scanlen = mtd->writesize + mtd->oobsize;
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300515 readlen = numpages * mtd->writesize;
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000516 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518 if (chip == -1) {
Brian Norrisb4d20d62013-07-30 17:52:56 -0700519 numblocks = mtd->size >> this->bbt_erase_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 startblock = 0;
521 from = 0;
522 } else {
523 if (chip >= this->numchips) {
Brian Norris9a4d4d62011-07-19 10:06:07 -0700524 pr_warn("create_bbt(): chipnr (%d) > available chips (%d)\n",
David Woodhousee0c7d762006-05-13 18:07:53 +0100525 chip + 1, this->numchips);
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000526 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 }
Brian Norrisb4d20d62013-07-30 17:52:56 -0700528 numblocks = this->chipsize >> this->bbt_erase_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 startblock = chip * numblocks;
530 numblocks += startblock;
Brian Norrisb4d20d62013-07-30 17:52:56 -0700531 from = (loff_t)startblock << this->bbt_erase_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000533
Brian Norris5fb15492011-05-31 16:31:21 -0700534 if (this->bbt_options & NAND_BBT_SCANLASTPAGE)
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300535 from += mtd->erasesize - (mtd->writesize * numpages);
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -0700536
Brian Norrisb4d20d62013-07-30 17:52:56 -0700537 for (i = startblock; i < numblocks; i++) {
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000538 int ret;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000539
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200540 BUG_ON(bd->options & NAND_BBT_NO_OOB);
541
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200542 if (bd->options & NAND_BBT_SCANALLPAGES)
543 ret = scan_block_full(mtd, bd, from, buf, readlen,
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300544 scanlen, numpages);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200545 else
Shmulik Ladkanieceb84b2012-08-20 16:29:15 +0300546 ret = scan_block_fast(mtd, bd, from, buf, numpages);
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000547
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200548 if (ret < 0)
549 return ret;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000550
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200551 if (ret) {
Brian Norrisb4d20d62013-07-30 17:52:56 -0700552 bbt_mark_entry(this, i, BBT_BLOCK_FACTORY_BAD);
Brian Norris9a4d4d62011-07-19 10:06:07 -0700553 pr_warn("Bad eraseblock %d at 0x%012llx\n",
Brian Norrisb4d20d62013-07-30 17:52:56 -0700554 i, (unsigned long long)from);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200555 mtd->ecc_stats.badblocks++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 from += (1 << this->bbt_erase_shift);
559 }
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +0000560 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
562
563/**
564 * search_bbt - [GENERIC] scan the device for a specific bad block table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700565 * @mtd: MTD device structure
566 * @buf: temporary buffer
567 * @td: descriptor for the bad block table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700569 * Read the bad block table by searching for a given ident pattern. Search is
570 * preformed either from the beginning up or from the end of the device
571 * downwards. The search starts always at the start of a block. If the option
572 * NAND_BBT_PERCHIP is given, each chip is searched for a bbt, which contains
573 * the bad block information of this chip. This is necessary to provide support
574 * for certain DOC devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700576 * The bbt ident pattern resides in the oob area of the first page in a block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100578static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
580 struct nand_chip *this = mtd->priv;
581 int i, chips;
582 int bits, startblock, block, dir;
Joern Engel28318772006-05-22 23:18:05 +0200583 int scanlen = mtd->writesize + mtd->oobsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 int bbtblocks;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200585 int blocktopage = this->bbt_erase_shift - this->page_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Brian Norris8b6e50c2011-05-25 14:59:01 -0700587 /* Search direction top -> down? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 if (td->options & NAND_BBT_LASTBLOCK) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100589 startblock = (mtd->size >> this->bbt_erase_shift) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 dir = -1;
591 } else {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000592 startblock = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 dir = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000594 }
595
Brian Norris8b6e50c2011-05-25 14:59:01 -0700596 /* Do we have a bbt per chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (td->options & NAND_BBT_PERCHIP) {
598 chips = this->numchips;
599 bbtblocks = this->chipsize >> this->bbt_erase_shift;
600 startblock &= bbtblocks - 1;
601 } else {
602 chips = 1;
603 bbtblocks = mtd->size >> this->bbt_erase_shift;
604 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 /* Number of bits for each erase block in the bbt */
607 bits = td->options & NAND_BBT_NRBITS_MSK;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 for (i = 0; i < chips; i++) {
610 /* Reset version information */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000611 td->version[i] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 td->pages[i] = -1;
613 /* Scan the maximum number of blocks */
614 for (block = 0; block < td->maxblocks; block++) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 int actblock = startblock + dir * block;
Adrian Hunter69423d92008-12-10 13:37:21 +0000617 loff_t offs = (loff_t)actblock << this->bbt_erase_shift;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 /* Read first page */
Brian Norrisaf69dcd2012-06-22 16:35:42 -0700620 scan_read(mtd, buf, offs, mtd->writesize, td);
Joern Engel28318772006-05-22 23:18:05 +0200621 if (!check_pattern(buf, scanlen, mtd->writesize, td)) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200622 td->pages[i] = actblock << blocktopage;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 if (td->options & NAND_BBT_VERSION) {
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200624 offs = bbt_get_ver_offs(mtd, td);
625 td->version[i] = buf[offs];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 }
627 break;
628 }
629 }
630 startblock += this->chipsize >> this->bbt_erase_shift;
631 }
632 /* Check, if we found a bbt for each requested chip */
633 for (i = 0; i < chips; i++) {
634 if (td->pages[i] == -1)
Brian Norris9a4d4d62011-07-19 10:06:07 -0700635 pr_warn("Bad block table not found for chip %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 else
Brian Norrisd0370212011-07-19 10:06:08 -0700637 pr_info("Bad block table found at page %d, version "
638 "0x%02X\n", td->pages[i], td->version[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000640 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641}
642
643/**
644 * search_read_bbts - [GENERIC] scan the device for bad block table(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -0700645 * @mtd: MTD device structure
646 * @buf: temporary buffer
647 * @td: descriptor for the bad block table
648 * @md: descriptor for the bad block table mirror
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700650 * Search and read the bad block table(s).
651 */
Brian Norris7b5a2d42012-06-22 16:35:41 -0700652static void search_read_bbts(struct mtd_info *mtd, uint8_t *buf,
653 struct nand_bbt_descr *td,
654 struct nand_bbt_descr *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
656 /* Search the primary table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100657 search_bbt(mtd, buf, td);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 /* Search the mirror table */
660 if (md)
David Woodhousee0c7d762006-05-13 18:07:53 +0100661 search_bbt(mtd, buf, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000662}
663
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000664/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 * write_bbt - [GENERIC] (Re)write the bad block table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700666 * @mtd: MTD device structure
667 * @buf: temporary buffer
668 * @td: descriptor for the bad block table
669 * @md: descriptor for the bad block table mirror
670 * @chipsel: selector for a specific chip, -1 for all
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700672 * (Re)write the bad block table.
673 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100674static int write_bbt(struct mtd_info *mtd, uint8_t *buf,
Thomas Gleixner9223a452006-05-23 17:21:03 +0200675 struct nand_bbt_descr *td, struct nand_bbt_descr *md,
676 int chipsel)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
678 struct nand_chip *this = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 struct erase_info einfo;
Brian Norrisb4d20d62013-07-30 17:52:56 -0700680 int i, res, chip = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 int bits, startblock, dir, page, offs, numblocks, sft, sftmsk;
Brian Norrisb4d20d62013-07-30 17:52:56 -0700682 int nrchips, pageoffs, ooboffs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 uint8_t msk[4];
684 uint8_t rcode = td->reserved_block_code;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200685 size_t retlen, len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 loff_t to;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200687 struct mtd_oob_ops ops;
688
689 ops.ooblen = mtd->oobsize;
690 ops.ooboffs = 0;
691 ops.datbuf = NULL;
Brian Norris0612b9d2011-08-30 18:45:40 -0700692 ops.mode = MTD_OPS_PLACE_OOB;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694 if (!rcode)
695 rcode = 0xff;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700696 /* Write bad block table per chip rather than per device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 if (td->options & NAND_BBT_PERCHIP) {
David Woodhousee0c7d762006-05-13 18:07:53 +0100698 numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
Brian Norris8b6e50c2011-05-25 14:59:01 -0700699 /* Full device write or specific chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 if (chipsel == -1) {
701 nrchips = this->numchips;
702 } else {
703 nrchips = chipsel + 1;
704 chip = chipsel;
705 }
706 } else {
David Woodhousee0c7d762006-05-13 18:07:53 +0100707 numblocks = (int)(mtd->size >> this->bbt_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 nrchips = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000709 }
710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 /* Loop through the chips */
712 for (; chip < nrchips; chip++) {
Brian Norris8b6e50c2011-05-25 14:59:01 -0700713 /*
714 * There was already a version of the table, reuse the page
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000715 * This applies for absolute placement too, as we have the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 * page nr. in td->pages.
717 */
718 if (td->pages[chip] != -1) {
719 page = td->pages[chip];
720 goto write;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000721 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Brian Norris8b6e50c2011-05-25 14:59:01 -0700723 /*
724 * Automatic placement of the bad block table. Search direction
725 * top -> down?
726 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 if (td->options & NAND_BBT_LASTBLOCK) {
728 startblock = numblocks * (chip + 1) - 1;
729 dir = -1;
730 } else {
731 startblock = chip * numblocks;
732 dir = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
735 for (i = 0; i < td->maxblocks; i++) {
736 int block = startblock + dir * i;
737 /* Check, if the block is bad */
Brian Norris771c5682013-07-30 17:52:55 -0700738 switch (bbt_get_entry(this, block)) {
739 case BBT_BLOCK_WORN:
740 case BBT_BLOCK_FACTORY_BAD:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 continue;
742 }
Thomas Gleixner9223a452006-05-23 17:21:03 +0200743 page = block <<
744 (this->bbt_erase_shift - this->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 /* Check, if the block is used by the mirror table */
746 if (!md || md->pages[chip] != page)
747 goto write;
748 }
Brian Norris9a4d4d62011-07-19 10:06:07 -0700749 pr_err("No space left to write bad block table\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 return -ENOSPC;
David Woodhousee0c7d762006-05-13 18:07:53 +0100751 write:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
753 /* Set up shift count and masks for the flash table */
754 bits = td->options & NAND_BBT_NRBITS_MSK;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200755 msk[2] = ~rcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 switch (bits) {
Thomas Gleixner9223a452006-05-23 17:21:03 +0200757 case 1: sft = 3; sftmsk = 0x07; msk[0] = 0x00; msk[1] = 0x01;
758 msk[3] = 0x01;
759 break;
760 case 2: sft = 2; sftmsk = 0x06; msk[0] = 0x00; msk[1] = 0x01;
761 msk[3] = 0x03;
762 break;
763 case 4: sft = 1; sftmsk = 0x04; msk[0] = 0x00; msk[1] = 0x0C;
764 msk[3] = 0x0f;
765 break;
766 case 8: sft = 0; sftmsk = 0x00; msk[0] = 0x00; msk[1] = 0x0F;
767 msk[3] = 0xff;
768 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 default: return -EINVAL;
770 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000771
Brian Norris596d7452011-09-07 13:13:33 -0700772 to = ((loff_t)page) << this->page_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Brian Norris8b6e50c2011-05-25 14:59:01 -0700774 /* Must we save the block contents? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 if (td->options & NAND_BBT_SAVECONTENT) {
776 /* Make it block aligned */
Brian Norris596d7452011-09-07 13:13:33 -0700777 to &= ~((loff_t)((1 << this->bbt_erase_shift) - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 len = 1 << this->bbt_erase_shift;
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200779 res = mtd_read(mtd, to, len, &retlen, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 if (res < 0) {
781 if (retlen != len) {
Brian Norrisd0370212011-07-19 10:06:08 -0700782 pr_info("nand_bbt: error reading block "
783 "for writing the bad block table\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 return res;
785 }
Brian Norrisd0370212011-07-19 10:06:08 -0700786 pr_warn("nand_bbt: ECC error while reading "
787 "block for writing bad block table\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 }
Thomas Gleixner9223a452006-05-23 17:21:03 +0200789 /* Read oob data */
Vitaly Wool70145682006-11-03 18:20:38 +0300790 ops.ooblen = (len >> this->page_shift) * mtd->oobsize;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200791 ops.oobbuf = &buf[len];
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200792 res = mtd_read_oob(mtd, to + mtd->writesize, &ops);
Vitaly Wool70145682006-11-03 18:20:38 +0300793 if (res < 0 || ops.oobretlen != ops.ooblen)
Thomas Gleixner9223a452006-05-23 17:21:03 +0200794 goto outerr;
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 /* Calc the byte offset in the buffer */
797 pageoffs = page - (int)(to >> this->page_shift);
798 offs = pageoffs << this->page_shift;
799 /* Preset the bbt area with 0xff */
Brian Norris596d7452011-09-07 13:13:33 -0700800 memset(&buf[offs], 0xff, (size_t)(numblocks >> sft));
Thomas Gleixner9223a452006-05-23 17:21:03 +0200801 ooboffs = len + (pageoffs * mtd->oobsize);
802
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200803 } else if (td->options & NAND_BBT_NO_OOB) {
804 ooboffs = 0;
805 offs = td->len;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700806 /* The version byte */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200807 if (td->options & NAND_BBT_VERSION)
808 offs++;
809 /* Calc length */
Brian Norris596d7452011-09-07 13:13:33 -0700810 len = (size_t)(numblocks >> sft);
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200811 len += offs;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700812 /* Make it page aligned! */
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200813 len = ALIGN(len, mtd->writesize);
814 /* Preset the buffer with 0xff */
815 memset(buf, 0xff, len);
816 /* Pattern is located at the begin of first page */
817 memcpy(buf, td->pattern, td->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 } else {
819 /* Calc length */
Brian Norris596d7452011-09-07 13:13:33 -0700820 len = (size_t)(numblocks >> sft);
Brian Norris8b6e50c2011-05-25 14:59:01 -0700821 /* Make it page aligned! */
Sebastian Andrzej Siewiorcda32092010-09-29 19:43:50 +0200822 len = ALIGN(len, mtd->writesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 /* Preset the buffer with 0xff */
Thomas Gleixner9223a452006-05-23 17:21:03 +0200824 memset(buf, 0xff, len +
825 (len >> this->page_shift)* mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 offs = 0;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200827 ooboffs = len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 /* Pattern is located in oob area of first page */
Thomas Gleixner9223a452006-05-23 17:21:03 +0200829 memcpy(&buf[ooboffs + td->offs], td->pattern, td->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000831
Thomas Gleixner9223a452006-05-23 17:21:03 +0200832 if (td->options & NAND_BBT_VERSION)
833 buf[ooboffs + td->veroffs] = td->version[chip];
834
Brian Norris8b6e50c2011-05-25 14:59:01 -0700835 /* Walk through the memory table */
Brian Norrisb4d20d62013-07-30 17:52:56 -0700836 for (i = 0; i < numblocks; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 uint8_t dat;
Brian Norrisb4d20d62013-07-30 17:52:56 -0700838 int sftcnt = (i << (3 - sft)) & sftmsk;
839 dat = bbt_get_entry(this, chip * numblocks + i);
840 /* Do not store the reserved bbt blocks! */
841 buf[offs + (i >> sft)] &= ~(msk[dat] << sftcnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000843
David Woodhousee0c7d762006-05-13 18:07:53 +0100844 memset(&einfo, 0, sizeof(einfo));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 einfo.mtd = mtd;
Adrian Hunter69423d92008-12-10 13:37:21 +0000846 einfo.addr = to;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 einfo.len = 1 << this->bbt_erase_shift;
David Woodhousee0c7d762006-05-13 18:07:53 +0100848 res = nand_erase_nand(mtd, &einfo, 1);
Thomas Gleixner9223a452006-05-23 17:21:03 +0200849 if (res < 0)
850 goto outerr;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000851
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +0200852 res = scan_write_bbt(mtd, to, len, buf,
853 td->options & NAND_BBT_NO_OOB ? NULL :
854 &buf[len]);
Thomas Gleixner9223a452006-05-23 17:21:03 +0200855 if (res < 0)
856 goto outerr;
857
Brian Norrisd0370212011-07-19 10:06:08 -0700858 pr_info("Bad block table written to 0x%012llx, version 0x%02X\n",
859 (unsigned long long)to, td->version[chip]);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 /* Mark it as used */
862 td->pages[chip] = page;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000863 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 return 0;
Thomas Gleixner9223a452006-05-23 17:21:03 +0200865
866 outerr:
Brian Norrisd0370212011-07-19 10:06:08 -0700867 pr_warn("nand_bbt: error while writing bad block table %d\n", res);
Thomas Gleixner9223a452006-05-23 17:21:03 +0200868 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869}
870
871/**
872 * nand_memory_bbt - [GENERIC] create a memory based bad block table
Brian Norris8b6e50c2011-05-25 14:59:01 -0700873 * @mtd: MTD device structure
874 * @bd: descriptor for the good/bad block search pattern
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700876 * The function creates a memory based bbt by scanning the device for
877 * manufacturer / software marked good / bad blocks.
878 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100879static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
881 struct nand_chip *this = mtd->priv;
882
Artem B. Bityuckiy171650a2005-02-16 17:09:39 +0000883 bd->options &= ~NAND_BBT_SCANEMPTY;
David Woodhouse4bf63fc2006-09-25 17:08:04 +0100884 return create_bbt(mtd, this->buffers->databuf, bd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
886
887/**
David Woodhousee0c7d762006-05-13 18:07:53 +0100888 * check_create - [GENERIC] create and write bbt(s) if necessary
Brian Norris8b6e50c2011-05-25 14:59:01 -0700889 * @mtd: MTD device structure
890 * @buf: temporary buffer
891 * @bd: descriptor for the good/bad block search pattern
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700893 * The function checks the results of the previous call to read_bbt and creates
894 * / updates the bbt(s) if necessary. Creation is necessary if no bbt was found
895 * for the chip/device. Update is necessary if one of the tables is missing or
896 * the version nr. of one table is less than the other.
897 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100898static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899{
Brian Norris623978d2011-09-20 18:35:34 -0700900 int i, chips, writeops, create, chipsel, res, res2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 struct nand_chip *this = mtd->priv;
902 struct nand_bbt_descr *td = this->bbt_td;
903 struct nand_bbt_descr *md = this->bbt_md;
904 struct nand_bbt_descr *rd, *rd2;
905
Brian Norris8b6e50c2011-05-25 14:59:01 -0700906 /* Do we have a bbt per chip? */
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000907 if (td->options & NAND_BBT_PERCHIP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 chips = this->numchips;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000909 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 chips = 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 for (i = 0; i < chips; i++) {
913 writeops = 0;
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700914 create = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 rd = NULL;
916 rd2 = NULL;
Brian Norris623978d2011-09-20 18:35:34 -0700917 res = res2 = 0;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700918 /* Per chip or per device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 chipsel = (td->options & NAND_BBT_PERCHIP) ? i : -1;
Brian Norris8b6e50c2011-05-25 14:59:01 -0700920 /* Mirrored table available? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 if (md) {
922 if (td->pages[i] == -1 && md->pages[i] == -1) {
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700923 create = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 writeops = 0x03;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700925 } else if (td->pages[i] == -1) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000926 rd = md;
Brian Norris596d7452011-09-07 13:13:33 -0700927 writeops = 0x01;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700928 } else if (md->pages[i] == -1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 rd = td;
Brian Norris596d7452011-09-07 13:13:33 -0700930 writeops = 0x02;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700931 } else if (td->version[i] == md->version[i]) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 rd = td;
933 if (!(td->options & NAND_BBT_VERSION))
934 rd2 = md;
Brian Norrisc5e8ef92011-09-07 13:13:34 -0700935 } else if (((int8_t)(td->version[i] - md->version[i])) > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 rd = td;
Brian Norris596d7452011-09-07 13:13:33 -0700937 writeops = 0x02;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 } else {
939 rd = md;
Brian Norris596d7452011-09-07 13:13:33 -0700940 writeops = 0x01;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 } else {
943 if (td->pages[i] == -1) {
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700944 create = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 writeops = 0x01;
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700946 } else {
947 rd = td;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000950
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700951 if (create) {
952 /* Create the bad block table by scanning the device? */
953 if (!(td->options & NAND_BBT_CREATE))
954 continue;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000955
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700956 /* Create the table in memory by scanning the chip(s) */
957 if (!(this->bbt_options & NAND_BBT_CREATE_EMPTY))
958 create_bbt(mtd, buf, bd, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Brian Norrisb61bf5b2011-09-07 13:13:35 -0700960 td->version[i] = 1;
961 if (md)
962 md->version[i] = 1;
963 }
964
Brian Norris8b6e50c2011-05-25 14:59:01 -0700965 /* Read back first? */
Brian Norris623978d2011-09-20 18:35:34 -0700966 if (rd) {
967 res = read_abs_bbt(mtd, buf, rd, chipsel);
968 if (mtd_is_eccerr(res)) {
969 /* Mark table as invalid */
970 rd->pages[i] = -1;
Brian Norrisdadc17a2011-09-20 18:35:57 -0700971 rd->version[i] = 0;
Brian Norris623978d2011-09-20 18:35:34 -0700972 i--;
973 continue;
974 }
975 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700976 /* If they weren't versioned, read both */
Brian Norris623978d2011-09-20 18:35:34 -0700977 if (rd2) {
978 res2 = read_abs_bbt(mtd, buf, rd2, chipsel);
979 if (mtd_is_eccerr(res2)) {
980 /* Mark table as invalid */
981 rd2->pages[i] = -1;
Brian Norrisdadc17a2011-09-20 18:35:57 -0700982 rd2->version[i] = 0;
Brian Norris623978d2011-09-20 18:35:34 -0700983 i--;
984 continue;
985 }
986 }
987
988 /* Scrub the flash table(s)? */
989 if (mtd_is_bitflip(res) || mtd_is_bitflip(res2))
990 writeops = 0x03;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Brian Norrisdadc17a2011-09-20 18:35:57 -0700992 /* Update version numbers before writing */
993 if (md) {
994 td->version[i] = max(td->version[i], md->version[i]);
995 md->version[i] = td->version[i];
996 }
997
Brian Norris8b6e50c2011-05-25 14:59:01 -0700998 /* Write the bad block table to the device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001000 res = write_bbt(mtd, buf, td, md, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 if (res < 0)
1002 return res;
1003 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001004
Brian Norris8b6e50c2011-05-25 14:59:01 -07001005 /* Write the mirror bad block table to the device? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001007 res = write_bbt(mtd, buf, md, td, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 if (res < 0)
1009 return res;
1010 }
1011 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001012 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013}
1014
1015/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001016 * mark_bbt_regions - [GENERIC] mark the bad block table regions
Brian Norris8b6e50c2011-05-25 14:59:01 -07001017 * @mtd: MTD device structure
1018 * @td: bad block table descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001020 * The bad block table regions are marked as "bad" to prevent accidental
1021 * erasures / writes. The regions are identified by the mark 0x02.
1022 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001023static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024{
1025 struct nand_chip *this = mtd->priv;
1026 int i, j, chips, block, nrblocks, update;
Brian Norris771c5682013-07-30 17:52:55 -07001027 uint8_t oldval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
Brian Norris8b6e50c2011-05-25 14:59:01 -07001029 /* Do we have a bbt per chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 if (td->options & NAND_BBT_PERCHIP) {
1031 chips = this->numchips;
1032 nrblocks = (int)(this->chipsize >> this->bbt_erase_shift);
1033 } else {
1034 chips = 1;
1035 nrblocks = (int)(mtd->size >> this->bbt_erase_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001036 }
1037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 for (i = 0; i < chips; i++) {
1039 if ((td->options & NAND_BBT_ABSPAGE) ||
1040 !(td->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001041 if (td->pages[i] == -1)
1042 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 block = td->pages[i] >> (this->bbt_erase_shift - this->page_shift);
Brian Norrisb4d20d62013-07-30 17:52:56 -07001044 oldval = bbt_get_entry(this, block);
1045 bbt_mark_entry(this, block, BBT_BLOCK_RESERVED);
Brian Norris771c5682013-07-30 17:52:55 -07001046 if ((oldval != BBT_BLOCK_RESERVED) &&
1047 td->reserved_block_code)
Brian Norrisb4d20d62013-07-30 17:52:56 -07001048 nand_update_bbt(mtd, (loff_t)block <<
1049 this->bbt_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 continue;
1051 }
1052 update = 0;
1053 if (td->options & NAND_BBT_LASTBLOCK)
1054 block = ((i + 1) * nrblocks) - td->maxblocks;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001055 else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 block = i * nrblocks;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 for (j = 0; j < td->maxblocks; j++) {
Brian Norrisb4d20d62013-07-30 17:52:56 -07001058 oldval = bbt_get_entry(this, block);
1059 bbt_mark_entry(this, block, BBT_BLOCK_RESERVED);
Brian Norris771c5682013-07-30 17:52:55 -07001060 if (oldval != BBT_BLOCK_RESERVED)
David Woodhousee0c7d762006-05-13 18:07:53 +01001061 update = 1;
Brian Norrisb4d20d62013-07-30 17:52:56 -07001062 block++;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001063 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07001064 /*
1065 * If we want reserved blocks to be recorded to flash, and some
1066 * new ones have been marked, then we need to update the stored
1067 * bbts. This should only happen once.
1068 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 if (update && td->reserved_block_code)
Brian Norrisb4d20d62013-07-30 17:52:56 -07001070 nand_update_bbt(mtd, (loff_t)(block - 1) <<
1071 this->bbt_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 }
1073}
1074
1075/**
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001076 * verify_bbt_descr - verify the bad block description
Brian Norris8b6e50c2011-05-25 14:59:01 -07001077 * @mtd: MTD device structure
1078 * @bd: the table to verify
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001079 *
1080 * This functions performs a few sanity checks on the bad block description
1081 * table.
1082 */
1083static void verify_bbt_descr(struct mtd_info *mtd, struct nand_bbt_descr *bd)
1084{
1085 struct nand_chip *this = mtd->priv;
Stanislav Fomichev7912a5e2011-02-07 23:48:25 +03001086 u32 pattern_len;
1087 u32 bits;
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001088 u32 table_size;
1089
1090 if (!bd)
1091 return;
Stanislav Fomichev7912a5e2011-02-07 23:48:25 +03001092
1093 pattern_len = bd->len;
1094 bits = bd->options & NAND_BBT_NRBITS_MSK;
1095
Brian Norrisa40f7342011-05-31 16:31:22 -07001096 BUG_ON((this->bbt_options & NAND_BBT_NO_OOB) &&
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001097 !(this->bbt_options & NAND_BBT_USE_FLASH));
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001098 BUG_ON(!bits);
1099
1100 if (bd->options & NAND_BBT_VERSION)
1101 pattern_len++;
1102
1103 if (bd->options & NAND_BBT_NO_OOB) {
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001104 BUG_ON(!(this->bbt_options & NAND_BBT_USE_FLASH));
Brian Norrisa40f7342011-05-31 16:31:22 -07001105 BUG_ON(!(this->bbt_options & NAND_BBT_NO_OOB));
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001106 BUG_ON(bd->offs);
1107 if (bd->options & NAND_BBT_VERSION)
1108 BUG_ON(bd->veroffs != bd->len);
1109 BUG_ON(bd->options & NAND_BBT_SAVECONTENT);
1110 }
1111
1112 if (bd->options & NAND_BBT_PERCHIP)
1113 table_size = this->chipsize >> this->bbt_erase_shift;
1114 else
1115 table_size = mtd->size >> this->bbt_erase_shift;
1116 table_size >>= 3;
1117 table_size *= bits;
1118 if (bd->options & NAND_BBT_NO_OOB)
1119 table_size += pattern_len;
1120 BUG_ON(table_size > (1 << this->bbt_erase_shift));
1121}
1122
1123/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 * nand_scan_bbt - [NAND Interface] scan, find, read and maybe create bad block table(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07001125 * @mtd: MTD device structure
1126 * @bd: descriptor for the good/bad block search pattern
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001128 * The function checks, if a bad block table(s) is/are already available. If
1129 * not it scans the device for manufacturer marked good / bad blocks and writes
1130 * the bad block table(s) to the selected place.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001132 * The bad block table memory is allocated here. It must be freed by calling
1133 * the nand_free_bbt function.
1134 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001135int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136{
1137 struct nand_chip *this = mtd->priv;
1138 int len, res = 0;
1139 uint8_t *buf;
1140 struct nand_bbt_descr *td = this->bbt_td;
1141 struct nand_bbt_descr *md = this->bbt_md;
1142
1143 len = mtd->size >> (this->bbt_erase_shift + 2);
Brian Norris8b6e50c2011-05-25 14:59:01 -07001144 /*
1145 * Allocate memory (2bit per block) and clear the memory bad block
1146 * table.
1147 */
Burman Yan95b93a02006-11-15 21:10:29 +02001148 this->bbt = kzalloc(len, GFP_KERNEL);
Brian Norris08700662011-06-07 16:01:54 -07001149 if (!this->bbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Brian Norris8b6e50c2011-05-25 14:59:01 -07001152 /*
1153 * If no primary table decriptor is given, scan the device to build a
1154 * memory based bad block table.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 */
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +00001156 if (!td) {
1157 if ((res = nand_memory_bbt(mtd, bd))) {
Brian Norrisd0370212011-07-19 10:06:08 -07001158 pr_err("nand_bbt: can't scan flash and build the RAM-based BBT\n");
David Woodhousee0c7d762006-05-13 18:07:53 +01001159 kfree(this->bbt);
Artem B. Bityuckiyeeada242005-02-11 10:14:15 +00001160 this->bbt = NULL;
1161 }
1162 return res;
1163 }
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001164 verify_bbt_descr(mtd, td);
1165 verify_bbt_descr(mtd, md);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
1167 /* Allocate a temporary buffer for one eraseblock incl. oob */
1168 len = (1 << this->bbt_erase_shift);
1169 len += (len >> this->page_shift) * mtd->oobsize;
David Woodhousec3f8abf2006-05-13 04:03:42 +01001170 buf = vmalloc(len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 if (!buf) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001172 kfree(this->bbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 this->bbt = NULL;
1174 return -ENOMEM;
1175 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001176
Brian Norris8b6e50c2011-05-25 14:59:01 -07001177 /* Is the bbt at a given page? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 if (td->options & NAND_BBT_ABSPAGE) {
Brian Norris7b5a2d42012-06-22 16:35:41 -07001179 read_abs_bbts(mtd, buf, td, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001180 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 /* Search the bad block table using a pattern in oob */
Brian Norris7b5a2d42012-06-22 16:35:41 -07001182 search_read_bbts(mtd, buf, td, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001183 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Brian Norris7b5a2d42012-06-22 16:35:41 -07001185 res = check_create(mtd, buf, bd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001186
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 /* Prevent the bbt regions from erasing / writing */
David Woodhousee0c7d762006-05-13 18:07:53 +01001188 mark_bbt_region(mtd, td);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 if (md)
David Woodhousee0c7d762006-05-13 18:07:53 +01001190 mark_bbt_region(mtd, md);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001191
David Woodhousee0c7d762006-05-13 18:07:53 +01001192 vfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 return res;
1194}
1195
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001197 * nand_update_bbt - [NAND Interface] update bad block table(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07001198 * @mtd: MTD device structure
1199 * @offs: the offset of the newly marked block
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001201 * The function updates the bad block table(s).
1202 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001203int nand_update_bbt(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204{
1205 struct nand_chip *this = mtd->priv;
Brian Norris1196ac52011-09-07 13:13:32 -07001206 int len, res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 int chip, chipsel;
1208 uint8_t *buf;
1209 struct nand_bbt_descr *td = this->bbt_td;
1210 struct nand_bbt_descr *md = this->bbt_md;
1211
1212 if (!this->bbt || !td)
1213 return -EINVAL;
1214
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 /* Allocate a temporary buffer for one eraseblock incl. oob */
1216 len = (1 << this->bbt_erase_shift);
1217 len += (len >> this->page_shift) * mtd->oobsize;
David Woodhousee0c7d762006-05-13 18:07:53 +01001218 buf = kmalloc(len, GFP_KERNEL);
Brian Norris08700662011-06-07 16:01:54 -07001219 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 return -ENOMEM;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001221
Brian Norris8b6e50c2011-05-25 14:59:01 -07001222 /* Do we have a bbt per chip? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 if (td->options & NAND_BBT_PERCHIP) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001224 chip = (int)(offs >> this->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 chipsel = chip;
1226 } else {
1227 chip = 0;
1228 chipsel = -1;
1229 }
1230
1231 td->version[chip]++;
1232 if (md)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001233 md->version[chip]++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Brian Norris8b6e50c2011-05-25 14:59:01 -07001235 /* Write the bad block table to the device? */
Brian Norris1196ac52011-09-07 13:13:32 -07001236 if (td->options & NAND_BBT_WRITE) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001237 res = write_bbt(mtd, buf, td, md, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 if (res < 0)
1239 goto out;
1240 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07001241 /* Write the mirror bad block table to the device? */
Brian Norris1196ac52011-09-07 13:13:32 -07001242 if (md && (md->options & NAND_BBT_WRITE)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001243 res = write_bbt(mtd, buf, md, td, chipsel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 }
1245
David Woodhousee0c7d762006-05-13 18:07:53 +01001246 out:
1247 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 return res;
1249}
1250
Brian Norris8b6e50c2011-05-25 14:59:01 -07001251/*
1252 * Define some generic bad / good block scan pattern which are used
1253 * while scanning a device for factory marked good / bad blocks.
1254 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
1256
Brian Norris7854d3f2011-06-23 14:12:08 -07001257/* Generic flash bbt descriptors */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1259static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1260
1261static struct nand_bbt_descr bbt_main_descr = {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001262 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1264 .offs = 8,
1265 .len = 4,
1266 .veroffs = 12,
Richard Genoud61de9da2012-09-11 15:50:54 +02001267 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 .pattern = bbt_pattern
1269};
1270
1271static struct nand_bbt_descr bbt_mirror_descr = {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001272 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1274 .offs = 8,
1275 .len = 4,
1276 .veroffs = 12,
Richard Genoud61de9da2012-09-11 15:50:54 +02001277 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 .pattern = mirror_pattern
1279};
1280
Brian Norris9fd6b372012-06-22 16:35:40 -07001281static struct nand_bbt_descr bbt_main_no_oob_descr = {
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001282 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1283 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1284 | NAND_BBT_NO_OOB,
1285 .len = 4,
1286 .veroffs = 4,
Richard Genoud61de9da2012-09-11 15:50:54 +02001287 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001288 .pattern = bbt_pattern
1289};
1290
Brian Norris9fd6b372012-06-22 16:35:40 -07001291static struct nand_bbt_descr bbt_mirror_no_oob_descr = {
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001292 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1293 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1294 | NAND_BBT_NO_OOB,
1295 .len = 4,
1296 .veroffs = 4,
Richard Genoud61de9da2012-09-11 15:50:54 +02001297 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001298 .pattern = mirror_pattern
1299};
1300
Brian Norris752ed6c2011-09-20 18:36:42 -07001301#define BADBLOCK_SCAN_MASK (~NAND_BBT_NO_OOB)
Brian Norris58373ff2010-07-15 12:15:44 -07001302/**
Brian Norris752ed6c2011-09-20 18:36:42 -07001303 * nand_create_badblock_pattern - [INTERN] Creates a BBT descriptor structure
Brian Norris8b6e50c2011-05-25 14:59:01 -07001304 * @this: NAND chip to create descriptor for
Brian Norris58373ff2010-07-15 12:15:44 -07001305 *
1306 * This function allocates and initializes a nand_bbt_descr for BBM detection
Brian Norris752ed6c2011-09-20 18:36:42 -07001307 * based on the properties of @this. The new descriptor is stored in
Brian Norris58373ff2010-07-15 12:15:44 -07001308 * this->badblock_pattern. Thus, this->badblock_pattern should be NULL when
1309 * passed to this function.
Brian Norris58373ff2010-07-15 12:15:44 -07001310 */
Brian Norris752ed6c2011-09-20 18:36:42 -07001311static int nand_create_badblock_pattern(struct nand_chip *this)
Brian Norris58373ff2010-07-15 12:15:44 -07001312{
1313 struct nand_bbt_descr *bd;
1314 if (this->badblock_pattern) {
Brian Norris752ed6c2011-09-20 18:36:42 -07001315 pr_warn("Bad block pattern already allocated; not replacing\n");
Brian Norris58373ff2010-07-15 12:15:44 -07001316 return -EINVAL;
1317 }
1318 bd = kzalloc(sizeof(*bd), GFP_KERNEL);
Brian Norris08700662011-06-07 16:01:54 -07001319 if (!bd)
Brian Norris58373ff2010-07-15 12:15:44 -07001320 return -ENOMEM;
Brian Norris752ed6c2011-09-20 18:36:42 -07001321 bd->options = this->bbt_options & BADBLOCK_SCAN_MASK;
Brian Norris58373ff2010-07-15 12:15:44 -07001322 bd->offs = this->badblockpos;
1323 bd->len = (this->options & NAND_BUSWIDTH_16) ? 2 : 1;
1324 bd->pattern = scan_ff_pattern;
1325 bd->options |= NAND_BBT_DYNAMICSTRUCT;
1326 this->badblock_pattern = bd;
1327 return 0;
1328}
1329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001331 * nand_default_bbt - [NAND Interface] Select a default bad block table for the device
Brian Norris8b6e50c2011-05-25 14:59:01 -07001332 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001334 * This function selects the default bad block table support for the device and
1335 * calls the nand_scan_bbt function.
1336 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001337int nand_default_bbt(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338{
1339 struct nand_chip *this = mtd->priv;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001340
Brian Norris8b6e50c2011-05-25 14:59:01 -07001341 /* Is a flash based bad block table requested? */
Brian Norrisbb9ebd42011-05-31 16:31:23 -07001342 if (this->bbt_options & NAND_BBT_USE_FLASH) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001343 /* Use the default pattern descriptors */
1344 if (!this->bbt_td) {
Brian Norrisa40f7342011-05-31 16:31:22 -07001345 if (this->bbt_options & NAND_BBT_NO_OOB) {
Brian Norris9fd6b372012-06-22 16:35:40 -07001346 this->bbt_td = &bbt_main_no_oob_descr;
1347 this->bbt_md = &bbt_mirror_no_oob_descr;
Sebastian Andrzej Siewior7cba7b12010-09-30 21:28:01 +02001348 } else {
1349 this->bbt_td = &bbt_main_descr;
1350 this->bbt_md = &bbt_mirror_descr;
1351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 } else {
1354 this->bbt_td = NULL;
1355 this->bbt_md = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 }
Brian Norrisa2f812d2011-03-18 21:53:42 -07001357
1358 if (!this->badblock_pattern)
Brian Norris752ed6c2011-09-20 18:36:42 -07001359 nand_create_badblock_pattern(this);
Brian Norrisa2f812d2011-03-18 21:53:42 -07001360
David Woodhousee0c7d762006-05-13 18:07:53 +01001361 return nand_scan_bbt(mtd, this->badblock_pattern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
1364/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001365 * nand_isbad_bbt - [NAND Interface] Check if a block is bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07001366 * @mtd: MTD device structure
1367 * @offs: offset in the device
1368 * @allowbbt: allow access to bad block table region
1369 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001370int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371{
1372 struct nand_chip *this = mtd->priv;
1373 int block;
David Woodhousee0c7d762006-05-13 18:07:53 +01001374 uint8_t res;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001375
Brian Norrisb4d20d62013-07-30 17:52:56 -07001376 block = (int)(offs >> this->bbt_erase_shift);
1377 res = bbt_get_entry(this, block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Brian Norris289c0522011-07-19 10:06:09 -07001379 pr_debug("nand_isbad_bbt(): bbt info for offs 0x%08x: "
1380 "(block %d) 0x%02x\n",
Brian Norrisb4d20d62013-07-30 17:52:56 -07001381 (unsigned int)offs, block, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
1383 switch ((int)res) {
Brian Norris771c5682013-07-30 17:52:55 -07001384 case BBT_BLOCK_GOOD:
David Woodhousee0c7d762006-05-13 18:07:53 +01001385 return 0;
Brian Norris771c5682013-07-30 17:52:55 -07001386 case BBT_BLOCK_WORN:
David Woodhousee0c7d762006-05-13 18:07:53 +01001387 return 1;
Brian Norris771c5682013-07-30 17:52:55 -07001388 case BBT_BLOCK_RESERVED:
David Woodhousee0c7d762006-05-13 18:07:53 +01001389 return allowbbt ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 }
1391 return 1;
1392}
1393
David Woodhousee0c7d762006-05-13 18:07:53 +01001394EXPORT_SYMBOL(nand_scan_bbt);
1395EXPORT_SYMBOL(nand_default_bbt);
Fabio Estevamd159c4e2012-07-28 19:29:25 -03001396EXPORT_SYMBOL_GPL(nand_update_bbt);