blob: ba785c5d53590f11b4323611c3b16cee29251821 [file] [log] [blame]
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001/*
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02002 * Overview:
3 * Bad block table support for the NAND driver
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02004 *
Sergey Lapin3a38a552013-01-14 03:46:50 +00005 * Copyright © 2004 Thomas Gleixner (tglx@linutronix.de)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02006 *
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02007 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 *
11 * Description:
12 *
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +020013 * When nand_scan_bbt is called, then it tries to find the bad block table
Christian Hitz24e6ea42011-10-12 09:32:04 +020014 * depending on the options in the BBT descriptor(s). If no flash based BBT
Sergey Lapin3a38a552013-01-14 03:46:50 +000015 * (NAND_BBT_USE_FLASH) is specified then the device is scanned for factory
Christian Hitz24e6ea42011-10-12 09:32:04 +020016 * marked good / bad blocks. This information is used to create a memory BBT.
17 * Once a new bad block is discovered then the "factory" information is updated
18 * on the device.
19 * If a flash based BBT is specified then the function first tries to find the
20 * BBT on flash. If a BBT is found then the contents are read and the memory
21 * based BBT is created. If a mirrored BBT is selected then the mirror is
22 * searched too and the versions are compared. If the mirror has a greater
Sergey Lapin3a38a552013-01-14 03:46:50 +000023 * version number, then the mirror BBT is used to build the memory based BBT.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020024 * If the tables are not versioned, then we "or" the bad block information.
Christian Hitz24e6ea42011-10-12 09:32:04 +020025 * If one of the BBTs is out of date or does not exist it is (re)created.
26 * If no BBT exists at all then the device is scanned for factory marked
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +020027 * good / bad blocks and the bad block tables are created.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020028 *
Christian Hitz24e6ea42011-10-12 09:32:04 +020029 * For manufacturer created BBTs like the one found on M-SYS DOC devices
30 * the BBT is searched and read but never created
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020031 *
Christian Hitz24e6ea42011-10-12 09:32:04 +020032 * The auto generated bad block table is located in the last good blocks
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +020033 * of the device. The table is mirrored, so it can be updated eventually.
Christian Hitz24e6ea42011-10-12 09:32:04 +020034 * The table is marked in the OOB area with an ident pattern and a version
35 * number which indicates which of both tables is more up to date. If the NAND
36 * controller needs the complete OOB area for the ECC information then the
Sergey Lapin3a38a552013-01-14 03:46:50 +000037 * option NAND_BBT_NO_OOB should be used (along with NAND_BBT_USE_FLASH, of
38 * course): it moves the ident pattern and the version byte into the data area
39 * and the OOB area will remain untouched.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020040 *
41 * The table uses 2 bits per block
Christian Hitz24e6ea42011-10-12 09:32:04 +020042 * 11b: block is good
43 * 00b: block is factory marked bad
Wolfgang Denka1be4762008-05-20 16:00:29 +020044 * 01b, 10b: block is marked bad due to wear
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020045 *
46 * The memory bad block table uses the following scheme:
47 * 00b: block is good
48 * 01b: block is marked bad due to wear
49 * 10b: block is reserved (to protect the bbt area)
50 * 11b: block is factory marked bad
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +020051 *
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020052 * Multichip devices like DOC store the bad block info per floor.
53 *
54 * Following assumptions are made:
55 * - bbts start at a page boundary, if autolocated on a block boundary
William Juul52c07962007-10-31 13:53:06 +010056 * - the space necessary for a bbt in FLASH does not exceed a block boundary
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +020057 *
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020058 */
59
Scott Wood831bbad2015-06-22 22:38:32 -050060#include <common.h>
61#include <malloc.h>
62#include <linux/compat.h>
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020063#include <linux/mtd/mtd.h>
Sergey Lapin3a38a552013-01-14 03:46:50 +000064#include <linux/mtd/bbm.h>
Masahiro Yamada2b7a8732017-11-30 13:45:24 +090065#include <linux/mtd/rawnand.h>
Christian Hitz24e6ea42011-10-12 09:32:04 +020066#include <linux/bitops.h>
Sergey Lapin3a38a552013-01-14 03:46:50 +000067#include <linux/string.h>
Heiko Schocherf5895d12014-06-24 10:10:04 +020068
69#define BBT_BLOCK_GOOD 0x00
70#define BBT_BLOCK_WORN 0x01
71#define BBT_BLOCK_RESERVED 0x02
72#define BBT_BLOCK_FACTORY_BAD 0x03
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020073
Heiko Schocherf5895d12014-06-24 10:10:04 +020074#define BBT_ENTRY_MASK 0x03
75#define BBT_ENTRY_SHIFT 2
76
77static int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
78
79static inline uint8_t bbt_get_entry(struct nand_chip *chip, int block)
80{
81 uint8_t entry = chip->bbt[block >> BBT_ENTRY_SHIFT];
82 entry >>= (block & BBT_ENTRY_MASK) * 2;
83 return entry & BBT_ENTRY_MASK;
84}
85
86static inline void bbt_mark_entry(struct nand_chip *chip, int block,
87 uint8_t mark)
88{
89 uint8_t msk = (mark & BBT_ENTRY_MASK) << ((block & BBT_ENTRY_MASK) * 2);
90 chip->bbt[block >> BBT_ENTRY_SHIFT] |= msk;
91}
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020092
Christian Hitz24e6ea42011-10-12 09:32:04 +020093static int check_pattern_no_oob(uint8_t *buf, struct nand_bbt_descr *td)
94{
Sergey Lapin3a38a552013-01-14 03:46:50 +000095 if (memcmp(buf, td->pattern, td->len))
96 return -1;
97 return 0;
Christian Hitz24e6ea42011-10-12 09:32:04 +020098}
99
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200100/**
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200101 * check_pattern - [GENERIC] check if a pattern is in the buffer
Sergey Lapin3a38a552013-01-14 03:46:50 +0000102 * @buf: the buffer to search
103 * @len: the length of buffer to search
104 * @paglen: the pagelength
105 * @td: search pattern descriptor
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200106 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000107 * Check for a pattern at the given place. Used to search bad block tables and
Heiko Schocherf5895d12014-06-24 10:10:04 +0200108 * good / bad block identifiers.
Sergey Lapin3a38a552013-01-14 03:46:50 +0000109 */
William Juul52c07962007-10-31 13:53:06 +0100110static int check_pattern(uint8_t *buf, int len, int paglen, struct nand_bbt_descr *td)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200111{
Christian Hitz24e6ea42011-10-12 09:32:04 +0200112 if (td->options & NAND_BBT_NO_OOB)
113 return check_pattern_no_oob(buf, td);
114
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200115 /* Compare the pattern */
Heiko Schocherf5895d12014-06-24 10:10:04 +0200116 if (memcmp(buf + paglen + td->offs, td->pattern, td->len))
Sergey Lapin3a38a552013-01-14 03:46:50 +0000117 return -1;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200118
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200119 return 0;
120}
121
122/**
William Juul52c07962007-10-31 13:53:06 +0100123 * check_short_pattern - [GENERIC] check if a pattern is in the buffer
Sergey Lapin3a38a552013-01-14 03:46:50 +0000124 * @buf: the buffer to search
125 * @td: search pattern descriptor
William Juul52c07962007-10-31 13:53:06 +0100126 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000127 * Check for a pattern at the given place. Used to search bad block tables and
128 * good / bad block identifiers. Same as check_pattern, but no optional empty
129 * check.
130 */
William Juul52c07962007-10-31 13:53:06 +0100131static int check_short_pattern(uint8_t *buf, struct nand_bbt_descr *td)
132{
William Juul52c07962007-10-31 13:53:06 +0100133 /* Compare the pattern */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000134 if (memcmp(buf + td->offs, td->pattern, td->len))
135 return -1;
William Juul52c07962007-10-31 13:53:06 +0100136 return 0;
137}
138
139/**
Christian Hitz24e6ea42011-10-12 09:32:04 +0200140 * add_marker_len - compute the length of the marker in data area
Sergey Lapin3a38a552013-01-14 03:46:50 +0000141 * @td: BBT descriptor used for computation
Christian Hitz24e6ea42011-10-12 09:32:04 +0200142 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000143 * The length will be 0 if the marker is located in OOB area.
Christian Hitz24e6ea42011-10-12 09:32:04 +0200144 */
145static u32 add_marker_len(struct nand_bbt_descr *td)
146{
147 u32 len;
148
149 if (!(td->options & NAND_BBT_NO_OOB))
150 return 0;
151
152 len = td->len;
153 if (td->options & NAND_BBT_VERSION)
154 len++;
155 return len;
156}
157
158/**
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200159 * read_bbt - [GENERIC] Read the bad block table starting from page
Sergey Lapin3a38a552013-01-14 03:46:50 +0000160 * @mtd: MTD device structure
161 * @buf: temporary buffer
162 * @page: the starting page
163 * @num: the number of bbt descriptors to read
164 * @td: the bbt describtion table
Heiko Schocherf5895d12014-06-24 10:10:04 +0200165 * @offs: block number offset in the table
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200166 *
167 * Read the bad block table starting from page.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200168 */
William Juul52c07962007-10-31 13:53:06 +0100169static int read_bbt(struct mtd_info *mtd, uint8_t *buf, int page, int num,
Christian Hitz24e6ea42011-10-12 09:32:04 +0200170 struct nand_bbt_descr *td, int offs)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200171{
Sergey Lapin3a38a552013-01-14 03:46:50 +0000172 int res, ret = 0, i, j, act = 0;
Scott Wood17fed142016-05-30 13:57:56 -0500173 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200174 size_t retlen, len, totlen;
175 loff_t from;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200176 int bits = td->options & NAND_BBT_NRBITS_MSK;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000177 uint8_t msk = (uint8_t)((1 << bits) - 1);
Christian Hitz24e6ea42011-10-12 09:32:04 +0200178 u32 marker_len;
179 int reserved_block_code = td->reserved_block_code;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200180
181 totlen = (num * bits) >> 3;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200182 marker_len = add_marker_len(td);
Sergey Lapin3a38a552013-01-14 03:46:50 +0000183 from = ((loff_t)page) << this->page_shift;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200184
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200185 while (totlen) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000186 len = min(totlen, (size_t)(1 << this->bbt_erase_shift));
Christian Hitz24e6ea42011-10-12 09:32:04 +0200187 if (marker_len) {
188 /*
189 * In case the BBT marker is not in the OOB area it
190 * will be just in the first page.
191 */
192 len -= marker_len;
193 from += marker_len;
194 marker_len = 0;
195 }
Sergey Lapin3a38a552013-01-14 03:46:50 +0000196 res = mtd_read(mtd, from, len, &retlen, buf);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200197 if (res < 0) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000198 if (mtd_is_eccerr(res)) {
Scott Wood3ea94ed2015-06-26 19:03:26 -0500199 pr_info("nand_bbt: ECC error in BBT at 0x%012llx\n",
200 from & ~mtd->writesize);
Sergey Lapin3a38a552013-01-14 03:46:50 +0000201 return res;
202 } else if (mtd_is_bitflip(res)) {
Scott Wood3ea94ed2015-06-26 19:03:26 -0500203 pr_info("nand_bbt: corrected error in BBT at 0x%012llx\n",
204 from & ~mtd->writesize);
Sergey Lapin3a38a552013-01-14 03:46:50 +0000205 ret = res;
206 } else {
207 pr_info("nand_bbt: error reading BBT\n");
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200208 return res;
209 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200210 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200211
212 /* Analyse data */
213 for (i = 0; i < len; i++) {
214 uint8_t dat = buf[i];
Heiko Schocherf5895d12014-06-24 10:10:04 +0200215 for (j = 0; j < 8; j += bits, act++) {
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200216 uint8_t tmp = (dat >> j) & msk;
217 if (tmp == msk)
218 continue;
William Juul52c07962007-10-31 13:53:06 +0100219 if (reserved_block_code && (tmp == reserved_block_code)) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000220 pr_info("nand_read_bbt: reserved block at 0x%012llx\n",
Heiko Schocherf5895d12014-06-24 10:10:04 +0200221 (loff_t)(offs + act) <<
222 this->bbt_erase_shift);
223 bbt_mark_entry(this, offs + act,
224 BBT_BLOCK_RESERVED);
William Juul52c07962007-10-31 13:53:06 +0100225 mtd->ecc_stats.bbtblocks++;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200226 continue;
227 }
Heiko Schocherf5895d12014-06-24 10:10:04 +0200228 /*
229 * Leave it for now, if it's matured we can
230 * move this message to pr_debug.
231 */
232 pr_info("nand_read_bbt: bad block at 0x%012llx\n",
233 (loff_t)(offs + act) <<
234 this->bbt_erase_shift);
Sergey Lapin3a38a552013-01-14 03:46:50 +0000235 /* Factory marked bad or worn out? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200236 if (tmp == 0)
Heiko Schocherf5895d12014-06-24 10:10:04 +0200237 bbt_mark_entry(this, offs + act,
238 BBT_BLOCK_FACTORY_BAD);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200239 else
Heiko Schocherf5895d12014-06-24 10:10:04 +0200240 bbt_mark_entry(this, offs + act,
241 BBT_BLOCK_WORN);
William Juul52c07962007-10-31 13:53:06 +0100242 mtd->ecc_stats.badblocks++;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200243 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200244 }
245 totlen -= len;
246 from += len;
247 }
Sergey Lapin3a38a552013-01-14 03:46:50 +0000248 return ret;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200249}
250
251/**
252 * read_abs_bbt - [GENERIC] Read the bad block table starting at a given page
Sergey Lapin3a38a552013-01-14 03:46:50 +0000253 * @mtd: MTD device structure
254 * @buf: temporary buffer
255 * @td: descriptor for the bad block table
256 * @chip: read the table for a specific chip, -1 read all chips; applies only if
257 * NAND_BBT_PERCHIP option is set
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200258 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000259 * Read the bad block table for all chips starting at a given page. We assume
260 * that the bbt bits are in consecutive order.
261 */
William Juul52c07962007-10-31 13:53:06 +0100262static int read_abs_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td, int chip)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200263{
Scott Wood17fed142016-05-30 13:57:56 -0500264 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200265 int res = 0, i;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200266
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200267 if (td->options & NAND_BBT_PERCHIP) {
268 int offs = 0;
269 for (i = 0; i < this->numchips; i++) {
270 if (chip == -1 || chip == i)
Christian Hitz24e6ea42011-10-12 09:32:04 +0200271 res = read_bbt(mtd, buf, td->pages[i],
272 this->chipsize >> this->bbt_erase_shift,
273 td, offs);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200274 if (res)
275 return res;
Heiko Schocherf5895d12014-06-24 10:10:04 +0200276 offs += this->chipsize >> this->bbt_erase_shift;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200277 }
278 } else {
Christian Hitz24e6ea42011-10-12 09:32:04 +0200279 res = read_bbt(mtd, buf, td->pages[0],
280 mtd->size >> this->bbt_erase_shift, td, 0);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200281 if (res)
282 return res;
283 }
284 return 0;
285}
286
Sergey Lapin3a38a552013-01-14 03:46:50 +0000287/* BBT marker is in the first page, no OOB */
288static int scan_read_data(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
Christian Hitz24e6ea42011-10-12 09:32:04 +0200289 struct nand_bbt_descr *td)
290{
291 size_t retlen;
292 size_t len;
293
294 len = td->len;
295 if (td->options & NAND_BBT_VERSION)
296 len++;
297
Sergey Lapin3a38a552013-01-14 03:46:50 +0000298 return mtd_read(mtd, offs, len, &retlen, buf);
Christian Hitz24e6ea42011-10-12 09:32:04 +0200299}
300
Sergey Lapin3a38a552013-01-14 03:46:50 +0000301/**
302 * scan_read_oob - [GENERIC] Scan data+OOB region to buffer
303 * @mtd: MTD device structure
304 * @buf: temporary buffer
305 * @offs: offset at which to scan
306 * @len: length of data region to read
307 *
308 * Scan read data from data+OOB. May traverse multiple pages, interleaving
309 * page,OOB,page,OOB,... in buf. Completes transfer and returns the "strongest"
310 * ECC condition (error or bitflip). May quit on the first (non-ECC) error.
William Juul52c07962007-10-31 13:53:06 +0100311 */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000312static int scan_read_oob(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
William Juul52c07962007-10-31 13:53:06 +0100313 size_t len)
314{
315 struct mtd_oob_ops ops;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000316 int res, ret = 0;
William Juul52c07962007-10-31 13:53:06 +0100317
Sergey Lapin3a38a552013-01-14 03:46:50 +0000318 ops.mode = MTD_OPS_PLACE_OOB;
William Juul52c07962007-10-31 13:53:06 +0100319 ops.ooboffs = 0;
320 ops.ooblen = mtd->oobsize;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200321
Christian Hitz24e6ea42011-10-12 09:32:04 +0200322 while (len > 0) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000323 ops.datbuf = buf;
324 ops.len = min(len, (size_t)mtd->writesize);
325 ops.oobbuf = buf + ops.len;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200326
Sergey Lapin3a38a552013-01-14 03:46:50 +0000327 res = mtd_read_oob(mtd, offs, &ops);
328 if (res) {
329 if (!mtd_is_bitflip_or_eccerr(res))
Christian Hitz24e6ea42011-10-12 09:32:04 +0200330 return res;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000331 else if (mtd_is_eccerr(res) || !ret)
332 ret = res;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200333 }
334
335 buf += mtd->oobsize + mtd->writesize;
336 len -= mtd->writesize;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000337 offs += mtd->writesize;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200338 }
Sergey Lapin3a38a552013-01-14 03:46:50 +0000339 return ret;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200340}
William Juul52c07962007-10-31 13:53:06 +0100341
Sergey Lapin3a38a552013-01-14 03:46:50 +0000342static int scan_read(struct mtd_info *mtd, uint8_t *buf, loff_t offs,
Christian Hitz24e6ea42011-10-12 09:32:04 +0200343 size_t len, struct nand_bbt_descr *td)
344{
345 if (td->options & NAND_BBT_NO_OOB)
Sergey Lapin3a38a552013-01-14 03:46:50 +0000346 return scan_read_data(mtd, buf, offs, td);
Christian Hitz24e6ea42011-10-12 09:32:04 +0200347 else
Sergey Lapin3a38a552013-01-14 03:46:50 +0000348 return scan_read_oob(mtd, buf, offs, len);
William Juul52c07962007-10-31 13:53:06 +0100349}
350
Sergey Lapin3a38a552013-01-14 03:46:50 +0000351/* Scan write data with oob to flash */
William Juul52c07962007-10-31 13:53:06 +0100352static int scan_write_bbt(struct mtd_info *mtd, loff_t offs, size_t len,
353 uint8_t *buf, uint8_t *oob)
354{
355 struct mtd_oob_ops ops;
356
Sergey Lapin3a38a552013-01-14 03:46:50 +0000357 ops.mode = MTD_OPS_PLACE_OOB;
William Juul52c07962007-10-31 13:53:06 +0100358 ops.ooboffs = 0;
359 ops.ooblen = mtd->oobsize;
360 ops.datbuf = buf;
361 ops.oobbuf = oob;
362 ops.len = len;
363
Sergey Lapin3a38a552013-01-14 03:46:50 +0000364 return mtd_write_oob(mtd, offs, &ops);
William Juul52c07962007-10-31 13:53:06 +0100365}
366
Christian Hitz24e6ea42011-10-12 09:32:04 +0200367static u32 bbt_get_ver_offs(struct mtd_info *mtd, struct nand_bbt_descr *td)
368{
369 u32 ver_offs = td->veroffs;
370
371 if (!(td->options & NAND_BBT_NO_OOB))
372 ver_offs += mtd->writesize;
373 return ver_offs;
374}
375
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200376/**
377 * read_abs_bbts - [GENERIC] Read the bad block table(s) for all chips starting at a given page
Sergey Lapin3a38a552013-01-14 03:46:50 +0000378 * @mtd: MTD device structure
379 * @buf: temporary buffer
380 * @td: descriptor for the bad block table
381 * @md: descriptor for the bad block table mirror
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200382 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000383 * Read the bad block table(s) for all chips starting at a given page. We
384 * assume that the bbt bits are in consecutive order.
385 */
386static void read_abs_bbts(struct mtd_info *mtd, uint8_t *buf,
387 struct nand_bbt_descr *td, struct nand_bbt_descr *md)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200388{
Scott Wood17fed142016-05-30 13:57:56 -0500389 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200390
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200391 /* Read the primary version, if available */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200392 if (td->options & NAND_BBT_VERSION) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000393 scan_read(mtd, buf, (loff_t)td->pages[0] << this->page_shift,
Christian Hitz24e6ea42011-10-12 09:32:04 +0200394 mtd->writesize, td);
395 td->version[0] = buf[bbt_get_ver_offs(mtd, td)];
Sergey Lapin3a38a552013-01-14 03:46:50 +0000396 pr_info("Bad block table at page %d, version 0x%02X\n",
397 td->pages[0], td->version[0]);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200398 }
399
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200400 /* Read the mirror version, if available */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200401 if (md && (md->options & NAND_BBT_VERSION)) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000402 scan_read(mtd, buf, (loff_t)md->pages[0] << this->page_shift,
403 mtd->writesize, md);
Christian Hitz24e6ea42011-10-12 09:32:04 +0200404 md->version[0] = buf[bbt_get_ver_offs(mtd, md)];
Sergey Lapin3a38a552013-01-14 03:46:50 +0000405 pr_info("Bad block table at page %d, version 0x%02X\n",
406 md->pages[0], md->version[0]);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200407 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200408}
409
Sergey Lapin3a38a552013-01-14 03:46:50 +0000410/* Scan a given block partially */
William Juul52c07962007-10-31 13:53:06 +0100411static int scan_block_fast(struct mtd_info *mtd, struct nand_bbt_descr *bd,
Sergey Lapin3a38a552013-01-14 03:46:50 +0000412 loff_t offs, uint8_t *buf, int numpages)
William Juul52c07962007-10-31 13:53:06 +0100413{
414 struct mtd_oob_ops ops;
415 int j, ret;
416
417 ops.ooblen = mtd->oobsize;
418 ops.oobbuf = buf;
419 ops.ooboffs = 0;
420 ops.datbuf = NULL;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000421 ops.mode = MTD_OPS_PLACE_OOB;
William Juul52c07962007-10-31 13:53:06 +0100422
Sergey Lapin3a38a552013-01-14 03:46:50 +0000423 for (j = 0; j < numpages; j++) {
William Juul52c07962007-10-31 13:53:06 +0100424 /*
Sergey Lapin3a38a552013-01-14 03:46:50 +0000425 * Read the full oob until read_oob is fixed to handle single
426 * byte reads for 16 bit buswidth.
William Juul52c07962007-10-31 13:53:06 +0100427 */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000428 ret = mtd_read_oob(mtd, offs, &ops);
429 /* Ignore ECC errors when checking for BBM */
430 if (ret && !mtd_is_bitflip_or_eccerr(ret))
William Juul52c07962007-10-31 13:53:06 +0100431 return ret;
432
433 if (check_short_pattern(buf, bd))
434 return 1;
435
436 offs += mtd->writesize;
437 }
438 return 0;
439}
440
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200441/**
442 * create_bbt - [GENERIC] Create a bad block table by scanning the device
Sergey Lapin3a38a552013-01-14 03:46:50 +0000443 * @mtd: MTD device structure
444 * @buf: temporary buffer
445 * @bd: descriptor for the good/bad block search pattern
446 * @chip: create the table for a specific chip, -1 read all chips; applies only
447 * if NAND_BBT_PERCHIP option is set
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200448 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000449 * Create a bad block table by scanning the device for the given good/bad block
450 * identify pattern.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200451 */
William Juul52c07962007-10-31 13:53:06 +0100452static int create_bbt(struct mtd_info *mtd, uint8_t *buf,
453 struct nand_bbt_descr *bd, int chip)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200454{
Scott Wood17fed142016-05-30 13:57:56 -0500455 struct nand_chip *this = mtd_to_nand(mtd);
Heiko Schocherf5895d12014-06-24 10:10:04 +0200456 int i, numblocks, numpages;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200457 int startblock;
458 loff_t from;
William Juul52c07962007-10-31 13:53:06 +0100459
Sergey Lapin3a38a552013-01-14 03:46:50 +0000460 pr_info("Scanning device for bad blocks\n");
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200461
Heiko Schocherf5895d12014-06-24 10:10:04 +0200462 if (bd->options & NAND_BBT_SCAN2NDPAGE)
Sergey Lapin3a38a552013-01-14 03:46:50 +0000463 numpages = 2;
Christian Hitz24e6ea42011-10-12 09:32:04 +0200464 else
Sergey Lapin3a38a552013-01-14 03:46:50 +0000465 numpages = 1;
William Juul52c07962007-10-31 13:53:06 +0100466
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200467 if (chip == -1) {
Heiko Schocherf5895d12014-06-24 10:10:04 +0200468 numblocks = mtd->size >> this->bbt_erase_shift;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200469 startblock = 0;
470 from = 0;
471 } else {
472 if (chip >= this->numchips) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000473 pr_warn("create_bbt(): chipnr (%d) > available chips (%d)\n",
William Juul52c07962007-10-31 13:53:06 +0100474 chip + 1, this->numchips);
475 return -EINVAL;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200476 }
Heiko Schocherf5895d12014-06-24 10:10:04 +0200477 numblocks = this->chipsize >> this->bbt_erase_shift;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200478 startblock = chip * numblocks;
479 numblocks += startblock;
Heiko Schocherf5895d12014-06-24 10:10:04 +0200480 from = (loff_t)startblock << this->bbt_erase_shift;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200481 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200482
Sergey Lapin3a38a552013-01-14 03:46:50 +0000483 if (this->bbt_options & NAND_BBT_SCANLASTPAGE)
484 from += mtd->erasesize - (mtd->writesize * numpages);
Christian Hitz24e6ea42011-10-12 09:32:04 +0200485
Heiko Schocherf5895d12014-06-24 10:10:04 +0200486 for (i = startblock; i < numblocks; i++) {
William Juul52c07962007-10-31 13:53:06 +0100487 int ret;
488
Christian Hitz24e6ea42011-10-12 09:32:04 +0200489 BUG_ON(bd->options & NAND_BBT_NO_OOB);
490
Heiko Schocherf5895d12014-06-24 10:10:04 +0200491 ret = scan_block_fast(mtd, bd, from, buf, numpages);
William Juul52c07962007-10-31 13:53:06 +0100492 if (ret < 0)
493 return ret;
494
495 if (ret) {
Heiko Schocherf5895d12014-06-24 10:10:04 +0200496 bbt_mark_entry(this, i, BBT_BLOCK_FACTORY_BAD);
Sergey Lapin3a38a552013-01-14 03:46:50 +0000497 pr_warn("Bad eraseblock %d at 0x%012llx\n",
Heiko Schocherf5895d12014-06-24 10:10:04 +0200498 i, (unsigned long long)from);
William Juul52c07962007-10-31 13:53:06 +0100499 mtd->ecc_stats.badblocks++;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200500 }
William Juul52c07962007-10-31 13:53:06 +0100501
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200502 from += (1 << this->bbt_erase_shift);
503 }
William Juul52c07962007-10-31 13:53:06 +0100504 return 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200505}
506
507/**
508 * search_bbt - [GENERIC] scan the device for a specific bad block table
Sergey Lapin3a38a552013-01-14 03:46:50 +0000509 * @mtd: MTD device structure
510 * @buf: temporary buffer
511 * @td: descriptor for the bad block table
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200512 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000513 * Read the bad block table by searching for a given ident pattern. Search is
514 * preformed either from the beginning up or from the end of the device
515 * downwards. The search starts always at the start of a block. If the option
516 * NAND_BBT_PERCHIP is given, each chip is searched for a bbt, which contains
517 * the bad block information of this chip. This is necessary to provide support
518 * for certain DOC devices.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200519 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000520 * The bbt ident pattern resides in the oob area of the first page in a block.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200521 */
William Juul52c07962007-10-31 13:53:06 +0100522static int search_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *td)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200523{
Scott Wood17fed142016-05-30 13:57:56 -0500524 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200525 int i, chips;
Marek Vasut15324ad2011-09-30 12:13:22 +0200526 int startblock, block, dir;
William Juul52c07962007-10-31 13:53:06 +0100527 int scanlen = mtd->writesize + mtd->oobsize;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200528 int bbtblocks;
William Juul52c07962007-10-31 13:53:06 +0100529 int blocktopage = this->bbt_erase_shift - this->page_shift;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200530
Sergey Lapin3a38a552013-01-14 03:46:50 +0000531 /* Search direction top -> down? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200532 if (td->options & NAND_BBT_LASTBLOCK) {
William Juul52c07962007-10-31 13:53:06 +0100533 startblock = (mtd->size >> this->bbt_erase_shift) - 1;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200534 dir = -1;
535 } else {
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200536 startblock = 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200537 dir = 1;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200538 }
539
Sergey Lapin3a38a552013-01-14 03:46:50 +0000540 /* Do we have a bbt per chip? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200541 if (td->options & NAND_BBT_PERCHIP) {
542 chips = this->numchips;
543 bbtblocks = this->chipsize >> this->bbt_erase_shift;
544 startblock &= bbtblocks - 1;
545 } else {
546 chips = 1;
547 bbtblocks = mtd->size >> this->bbt_erase_shift;
548 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200549
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200550 for (i = 0; i < chips; i++) {
551 /* Reset version information */
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200552 td->version[i] = 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200553 td->pages[i] = -1;
554 /* Scan the maximum number of blocks */
555 for (block = 0; block < td->maxblocks; block++) {
William Juul52c07962007-10-31 13:53:06 +0100556
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200557 int actblock = startblock + dir * block;
Sandeep Paulrajeab580c2009-10-30 13:51:23 -0400558 loff_t offs = (loff_t)actblock << this->bbt_erase_shift;
William Juul52c07962007-10-31 13:53:06 +0100559
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200560 /* Read first page */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000561 scan_read(mtd, buf, offs, mtd->writesize, td);
William Juul52c07962007-10-31 13:53:06 +0100562 if (!check_pattern(buf, scanlen, mtd->writesize, td)) {
563 td->pages[i] = actblock << blocktopage;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200564 if (td->options & NAND_BBT_VERSION) {
Christian Hitz24e6ea42011-10-12 09:32:04 +0200565 offs = bbt_get_ver_offs(mtd, td);
566 td->version[i] = buf[offs];
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200567 }
568 break;
569 }
570 }
571 startblock += this->chipsize >> this->bbt_erase_shift;
572 }
573 /* Check, if we found a bbt for each requested chip */
574 for (i = 0; i < chips; i++) {
575 if (td->pages[i] == -1)
Sergey Lapin3a38a552013-01-14 03:46:50 +0000576 pr_warn("Bad block table not found for chip %d\n", i);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200577 else
Scott Wood3ea94ed2015-06-26 19:03:26 -0500578 pr_info("Bad block table found at page %d, version 0x%02X\n",
579 td->pages[i], td->version[i]);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200580 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200581 return 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200582}
583
584/**
585 * search_read_bbts - [GENERIC] scan the device for bad block table(s)
Sergey Lapin3a38a552013-01-14 03:46:50 +0000586 * @mtd: MTD device structure
587 * @buf: temporary buffer
588 * @td: descriptor for the bad block table
589 * @md: descriptor for the bad block table mirror
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200590 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000591 * Search and read the bad block table(s).
592 */
593static void search_read_bbts(struct mtd_info *mtd, uint8_t *buf,
594 struct nand_bbt_descr *td,
595 struct nand_bbt_descr *md)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200596{
597 /* Search the primary table */
William Juul52c07962007-10-31 13:53:06 +0100598 search_bbt(mtd, buf, td);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200599
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200600 /* Search the mirror table */
601 if (md)
William Juul52c07962007-10-31 13:53:06 +0100602 search_bbt(mtd, buf, md);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200603}
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200604
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200605/**
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200606 * write_bbt - [GENERIC] (Re)write the bad block table
Sergey Lapin3a38a552013-01-14 03:46:50 +0000607 * @mtd: MTD device structure
608 * @buf: temporary buffer
609 * @td: descriptor for the bad block table
610 * @md: descriptor for the bad block table mirror
611 * @chipsel: selector for a specific chip, -1 for all
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200612 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000613 * (Re)write the bad block table.
614 */
William Juul52c07962007-10-31 13:53:06 +0100615static int write_bbt(struct mtd_info *mtd, uint8_t *buf,
616 struct nand_bbt_descr *td, struct nand_bbt_descr *md,
617 int chipsel)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200618{
Scott Wood17fed142016-05-30 13:57:56 -0500619 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200620 struct erase_info einfo;
Heiko Schocherf5895d12014-06-24 10:10:04 +0200621 int i, res, chip = 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200622 int bits, startblock, dir, page, offs, numblocks, sft, sftmsk;
Heiko Schocherf5895d12014-06-24 10:10:04 +0200623 int nrchips, pageoffs, ooboffs;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200624 uint8_t msk[4];
625 uint8_t rcode = td->reserved_block_code;
626 size_t retlen, len = 0;
627 loff_t to;
William Juul52c07962007-10-31 13:53:06 +0100628 struct mtd_oob_ops ops;
629
630 ops.ooblen = mtd->oobsize;
631 ops.ooboffs = 0;
632 ops.datbuf = NULL;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000633 ops.mode = MTD_OPS_PLACE_OOB;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200634
635 if (!rcode)
636 rcode = 0xff;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000637 /* Write bad block table per chip rather than per device? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200638 if (td->options & NAND_BBT_PERCHIP) {
William Juul52c07962007-10-31 13:53:06 +0100639 numblocks = (int)(this->chipsize >> this->bbt_erase_shift);
Sergey Lapin3a38a552013-01-14 03:46:50 +0000640 /* Full device write or specific chip? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200641 if (chipsel == -1) {
642 nrchips = this->numchips;
643 } else {
644 nrchips = chipsel + 1;
645 chip = chipsel;
646 }
647 } else {
William Juul52c07962007-10-31 13:53:06 +0100648 numblocks = (int)(mtd->size >> this->bbt_erase_shift);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200649 nrchips = 1;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200650 }
651
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200652 /* Loop through the chips */
653 for (; chip < nrchips; chip++) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000654 /*
655 * There was already a version of the table, reuse the page
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200656 * This applies for absolute placement too, as we have the
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200657 * page nr. in td->pages.
658 */
659 if (td->pages[chip] != -1) {
660 page = td->pages[chip];
661 goto write;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200662 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200663
Sergey Lapin3a38a552013-01-14 03:46:50 +0000664 /*
665 * Automatic placement of the bad block table. Search direction
666 * top -> down?
667 */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200668 if (td->options & NAND_BBT_LASTBLOCK) {
669 startblock = numblocks * (chip + 1) - 1;
670 dir = -1;
671 } else {
672 startblock = chip * numblocks;
673 dir = 1;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200674 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200675
676 for (i = 0; i < td->maxblocks; i++) {
677 int block = startblock + dir * i;
678 /* Check, if the block is bad */
Heiko Schocherf5895d12014-06-24 10:10:04 +0200679 switch (bbt_get_entry(this, block)) {
680 case BBT_BLOCK_WORN:
681 case BBT_BLOCK_FACTORY_BAD:
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200682 continue;
683 }
William Juul52c07962007-10-31 13:53:06 +0100684 page = block <<
685 (this->bbt_erase_shift - this->page_shift);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200686 /* Check, if the block is used by the mirror table */
687 if (!md || md->pages[chip] != page)
688 goto write;
689 }
Sergey Lapin3a38a552013-01-14 03:46:50 +0000690 pr_err("No space left to write bad block table\n");
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200691 return -ENOSPC;
William Juul52c07962007-10-31 13:53:06 +0100692 write:
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200693
694 /* Set up shift count and masks for the flash table */
695 bits = td->options & NAND_BBT_NRBITS_MSK;
William Juul52c07962007-10-31 13:53:06 +0100696 msk[2] = ~rcode;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200697 switch (bits) {
William Juul52c07962007-10-31 13:53:06 +0100698 case 1: sft = 3; sftmsk = 0x07; msk[0] = 0x00; msk[1] = 0x01;
699 msk[3] = 0x01;
700 break;
701 case 2: sft = 2; sftmsk = 0x06; msk[0] = 0x00; msk[1] = 0x01;
702 msk[3] = 0x03;
703 break;
704 case 4: sft = 1; sftmsk = 0x04; msk[0] = 0x00; msk[1] = 0x0C;
705 msk[3] = 0x0f;
706 break;
707 case 8: sft = 0; sftmsk = 0x00; msk[0] = 0x00; msk[1] = 0x0F;
708 msk[3] = 0xff;
709 break;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200710 default: return -EINVAL;
711 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200712
Sergey Lapin3a38a552013-01-14 03:46:50 +0000713 to = ((loff_t)page) << this->page_shift;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200714
Sergey Lapin3a38a552013-01-14 03:46:50 +0000715 /* Must we save the block contents? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200716 if (td->options & NAND_BBT_SAVECONTENT) {
717 /* Make it block aligned */
Scott Wood52ab7ce2016-05-30 13:57:58 -0500718 to &= ~(((loff_t)1 << this->bbt_erase_shift) - 1);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200719 len = 1 << this->bbt_erase_shift;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000720 res = mtd_read(mtd, to, len, &retlen, buf);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200721 if (res < 0) {
722 if (retlen != len) {
Scott Wood3ea94ed2015-06-26 19:03:26 -0500723 pr_info("nand_bbt: error reading block for writing the bad block table\n");
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200724 return res;
725 }
Scott Wood3ea94ed2015-06-26 19:03:26 -0500726 pr_warn("nand_bbt: ECC error while reading block for writing bad block table\n");
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200727 }
William Juul52c07962007-10-31 13:53:06 +0100728 /* Read oob data */
729 ops.ooblen = (len >> this->page_shift) * mtd->oobsize;
730 ops.oobbuf = &buf[len];
Sergey Lapin3a38a552013-01-14 03:46:50 +0000731 res = mtd_read_oob(mtd, to + mtd->writesize, &ops);
William Juul52c07962007-10-31 13:53:06 +0100732 if (res < 0 || ops.oobretlen != ops.ooblen)
733 goto outerr;
734
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200735 /* Calc the byte offset in the buffer */
736 pageoffs = page - (int)(to >> this->page_shift);
737 offs = pageoffs << this->page_shift;
738 /* Preset the bbt area with 0xff */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000739 memset(&buf[offs], 0xff, (size_t)(numblocks >> sft));
William Juul52c07962007-10-31 13:53:06 +0100740 ooboffs = len + (pageoffs * mtd->oobsize);
741
Christian Hitz24e6ea42011-10-12 09:32:04 +0200742 } else if (td->options & NAND_BBT_NO_OOB) {
743 ooboffs = 0;
744 offs = td->len;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000745 /* The version byte */
Christian Hitz24e6ea42011-10-12 09:32:04 +0200746 if (td->options & NAND_BBT_VERSION)
747 offs++;
748 /* Calc length */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000749 len = (size_t)(numblocks >> sft);
Christian Hitz24e6ea42011-10-12 09:32:04 +0200750 len += offs;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000751 /* Make it page aligned! */
Christian Hitz24e6ea42011-10-12 09:32:04 +0200752 len = ALIGN(len, mtd->writesize);
753 /* Preset the buffer with 0xff */
754 memset(buf, 0xff, len);
755 /* Pattern is located at the begin of first page */
756 memcpy(buf, td->pattern, td->len);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200757 } else {
758 /* Calc length */
Sergey Lapin3a38a552013-01-14 03:46:50 +0000759 len = (size_t)(numblocks >> sft);
760 /* Make it page aligned! */
Christian Hitz24e6ea42011-10-12 09:32:04 +0200761 len = ALIGN(len, mtd->writesize);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200762 /* Preset the buffer with 0xff */
William Juul52c07962007-10-31 13:53:06 +0100763 memset(buf, 0xff, len +
764 (len >> this->page_shift)* mtd->oobsize);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200765 offs = 0;
William Juul52c07962007-10-31 13:53:06 +0100766 ooboffs = len;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200767 /* Pattern is located in oob area of first page */
William Juul52c07962007-10-31 13:53:06 +0100768 memcpy(&buf[ooboffs + td->offs], td->pattern, td->len);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200769 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200770
William Juul52c07962007-10-31 13:53:06 +0100771 if (td->options & NAND_BBT_VERSION)
772 buf[ooboffs + td->veroffs] = td->version[chip];
773
Sergey Lapin3a38a552013-01-14 03:46:50 +0000774 /* Walk through the memory table */
Heiko Schocherf5895d12014-06-24 10:10:04 +0200775 for (i = 0; i < numblocks; i++) {
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200776 uint8_t dat;
Heiko Schocherf5895d12014-06-24 10:10:04 +0200777 int sftcnt = (i << (3 - sft)) & sftmsk;
778 dat = bbt_get_entry(this, chip * numblocks + i);
779 /* Do not store the reserved bbt blocks! */
780 buf[offs + (i >> sft)] &= ~(msk[dat] << sftcnt);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200781 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200782
William Juul52c07962007-10-31 13:53:06 +0100783 memset(&einfo, 0, sizeof(einfo));
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200784 einfo.mtd = mtd;
Sandeep Paulrajeab580c2009-10-30 13:51:23 -0400785 einfo.addr = to;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200786 einfo.len = 1 << this->bbt_erase_shift;
William Juul52c07962007-10-31 13:53:06 +0100787 res = nand_erase_nand(mtd, &einfo, 1);
788 if (res < 0)
789 goto outerr;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200790
Christian Hitz24e6ea42011-10-12 09:32:04 +0200791 res = scan_write_bbt(mtd, to, len, buf,
792 td->options & NAND_BBT_NO_OOB ? NULL :
793 &buf[len]);
William Juul52c07962007-10-31 13:53:06 +0100794 if (res < 0)
795 goto outerr;
796
Sergey Lapin3a38a552013-01-14 03:46:50 +0000797 pr_info("Bad block table written to 0x%012llx, version 0x%02X\n",
798 (unsigned long long)to, td->version[chip]);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200799
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200800 /* Mark it as used */
801 td->pages[chip] = page;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200802 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200803 return 0;
William Juul52c07962007-10-31 13:53:06 +0100804
805 outerr:
Sergey Lapin3a38a552013-01-14 03:46:50 +0000806 pr_warn("nand_bbt: error while writing bad block table %d\n", res);
William Juul52c07962007-10-31 13:53:06 +0100807 return res;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200808}
809
810/**
811 * nand_memory_bbt - [GENERIC] create a memory based bad block table
Sergey Lapin3a38a552013-01-14 03:46:50 +0000812 * @mtd: MTD device structure
813 * @bd: descriptor for the good/bad block search pattern
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200814 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000815 * The function creates a memory based bbt by scanning the device for
816 * manufacturer / software marked good / bad blocks.
817 */
William Juul52c07962007-10-31 13:53:06 +0100818static inline int nand_memory_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200819{
Scott Wood17fed142016-05-30 13:57:56 -0500820 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200821
William Juul52c07962007-10-31 13:53:06 +0100822 return create_bbt(mtd, this->buffers->databuf, bd, -1);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200823}
824
825/**
William Juul52c07962007-10-31 13:53:06 +0100826 * check_create - [GENERIC] create and write bbt(s) if necessary
Sergey Lapin3a38a552013-01-14 03:46:50 +0000827 * @mtd: MTD device structure
828 * @buf: temporary buffer
829 * @bd: descriptor for the good/bad block search pattern
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200830 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000831 * The function checks the results of the previous call to read_bbt and creates
832 * / updates the bbt(s) if necessary. Creation is necessary if no bbt was found
833 * for the chip/device. Update is necessary if one of the tables is missing or
834 * the version nr. of one table is less than the other.
835 */
William Juul52c07962007-10-31 13:53:06 +0100836static int check_create(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr *bd)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200837{
Sergey Lapin3a38a552013-01-14 03:46:50 +0000838 int i, chips, writeops, create, chipsel, res, res2;
Scott Wood17fed142016-05-30 13:57:56 -0500839 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200840 struct nand_bbt_descr *td = this->bbt_td;
841 struct nand_bbt_descr *md = this->bbt_md;
842 struct nand_bbt_descr *rd, *rd2;
843
Sergey Lapin3a38a552013-01-14 03:46:50 +0000844 /* Do we have a bbt per chip? */
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200845 if (td->options & NAND_BBT_PERCHIP)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200846 chips = this->numchips;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200847 else
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200848 chips = 1;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200849
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200850 for (i = 0; i < chips; i++) {
851 writeops = 0;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000852 create = 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200853 rd = NULL;
854 rd2 = NULL;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000855 res = res2 = 0;
856 /* Per chip or per device? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200857 chipsel = (td->options & NAND_BBT_PERCHIP) ? i : -1;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000858 /* Mirrored table available? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200859 if (md) {
860 if (td->pages[i] == -1 && md->pages[i] == -1) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000861 create = 1;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200862 writeops = 0x03;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000863 } else if (td->pages[i] == -1) {
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200864 rd = md;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000865 writeops = 0x01;
866 } else if (md->pages[i] == -1) {
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200867 rd = td;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000868 writeops = 0x02;
869 } else if (td->version[i] == md->version[i]) {
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200870 rd = td;
871 if (!(td->options & NAND_BBT_VERSION))
872 rd2 = md;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000873 } else if (((int8_t)(td->version[i] - md->version[i])) > 0) {
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200874 rd = td;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000875 writeops = 0x02;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200876 } else {
877 rd = md;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000878 writeops = 0x01;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200879 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200880 } else {
881 if (td->pages[i] == -1) {
Sergey Lapin3a38a552013-01-14 03:46:50 +0000882 create = 1;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200883 writeops = 0x01;
Sergey Lapin3a38a552013-01-14 03:46:50 +0000884 } else {
885 rd = td;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200886 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200887 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200888
Sergey Lapin3a38a552013-01-14 03:46:50 +0000889 if (create) {
890 /* Create the bad block table by scanning the device? */
891 if (!(td->options & NAND_BBT_CREATE))
892 continue;
893
894 /* Create the table in memory by scanning the chip(s) */
895 if (!(this->bbt_options & NAND_BBT_CREATE_EMPTY))
896 create_bbt(mtd, buf, bd, chipsel);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200897
Sergey Lapin3a38a552013-01-14 03:46:50 +0000898 td->version[i] = 1;
899 if (md)
900 md->version[i] = 1;
901 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200902
Sergey Lapin3a38a552013-01-14 03:46:50 +0000903 /* Read back first? */
904 if (rd) {
905 res = read_abs_bbt(mtd, buf, rd, chipsel);
906 if (mtd_is_eccerr(res)) {
907 /* Mark table as invalid */
908 rd->pages[i] = -1;
909 rd->version[i] = 0;
910 i--;
911 continue;
912 }
913 }
914 /* If they weren't versioned, read both */
915 if (rd2) {
916 res2 = read_abs_bbt(mtd, buf, rd2, chipsel);
917 if (mtd_is_eccerr(res2)) {
918 /* Mark table as invalid */
919 rd2->pages[i] = -1;
920 rd2->version[i] = 0;
921 i--;
922 continue;
923 }
924 }
925
926 /* Scrub the flash table(s)? */
927 if (mtd_is_bitflip(res) || mtd_is_bitflip(res2))
928 writeops = 0x03;
929
930 /* Update version numbers before writing */
931 if (md) {
932 td->version[i] = max(td->version[i], md->version[i]);
933 md->version[i] = td->version[i];
934 }
935
936 /* Write the bad block table to the device? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200937 if ((writeops & 0x01) && (td->options & NAND_BBT_WRITE)) {
William Juul52c07962007-10-31 13:53:06 +0100938 res = write_bbt(mtd, buf, td, md, chipsel);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200939 if (res < 0)
940 return res;
941 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200942
Sergey Lapin3a38a552013-01-14 03:46:50 +0000943 /* Write the mirror bad block table to the device? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200944 if ((writeops & 0x02) && md && (md->options & NAND_BBT_WRITE)) {
William Juul52c07962007-10-31 13:53:06 +0100945 res = write_bbt(mtd, buf, md, td, chipsel);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200946 if (res < 0)
947 return res;
948 }
949 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200950 return 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200951}
952
953/**
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200954 * mark_bbt_regions - [GENERIC] mark the bad block table regions
Sergey Lapin3a38a552013-01-14 03:46:50 +0000955 * @mtd: MTD device structure
956 * @td: bad block table descriptor
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200957 *
Sergey Lapin3a38a552013-01-14 03:46:50 +0000958 * The bad block table regions are marked as "bad" to prevent accidental
959 * erasures / writes. The regions are identified by the mark 0x02.
960 */
William Juul52c07962007-10-31 13:53:06 +0100961static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200962{
Scott Wood17fed142016-05-30 13:57:56 -0500963 struct nand_chip *this = mtd_to_nand(mtd);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200964 int i, j, chips, block, nrblocks, update;
Heiko Schocherf5895d12014-06-24 10:10:04 +0200965 uint8_t oldval;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200966
Sergey Lapin3a38a552013-01-14 03:46:50 +0000967 /* Do we have a bbt per chip? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200968 if (td->options & NAND_BBT_PERCHIP) {
969 chips = this->numchips;
970 nrblocks = (int)(this->chipsize >> this->bbt_erase_shift);
971 } else {
972 chips = 1;
973 nrblocks = (int)(mtd->size >> this->bbt_erase_shift);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200974 }
975
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200976 for (i = 0; i < chips; i++) {
977 if ((td->options & NAND_BBT_ABSPAGE) ||
978 !(td->options & NAND_BBT_WRITE)) {
William Juul52c07962007-10-31 13:53:06 +0100979 if (td->pages[i] == -1)
980 continue;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200981 block = td->pages[i] >> (this->bbt_erase_shift - this->page_shift);
Heiko Schocherf5895d12014-06-24 10:10:04 +0200982 oldval = bbt_get_entry(this, block);
983 bbt_mark_entry(this, block, BBT_BLOCK_RESERVED);
984 if ((oldval != BBT_BLOCK_RESERVED) &&
985 td->reserved_block_code)
986 nand_update_bbt(mtd, (loff_t)block <<
987 this->bbt_erase_shift);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200988 continue;
989 }
990 update = 0;
991 if (td->options & NAND_BBT_LASTBLOCK)
992 block = ((i + 1) * nrblocks) - td->maxblocks;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +0200993 else
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200994 block = i * nrblocks;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +0200995 for (j = 0; j < td->maxblocks; j++) {
Heiko Schocherf5895d12014-06-24 10:10:04 +0200996 oldval = bbt_get_entry(this, block);
997 bbt_mark_entry(this, block, BBT_BLOCK_RESERVED);
998 if (oldval != BBT_BLOCK_RESERVED)
William Juul52c07962007-10-31 13:53:06 +0100999 update = 1;
Heiko Schocherf5895d12014-06-24 10:10:04 +02001000 block++;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001001 }
Sergey Lapin3a38a552013-01-14 03:46:50 +00001002 /*
1003 * If we want reserved blocks to be recorded to flash, and some
1004 * new ones have been marked, then we need to update the stored
1005 * bbts. This should only happen once.
1006 */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001007 if (update && td->reserved_block_code)
Heiko Schocherf5895d12014-06-24 10:10:04 +02001008 nand_update_bbt(mtd, (loff_t)(block - 1) <<
1009 this->bbt_erase_shift);
Christian Hitz24e6ea42011-10-12 09:32:04 +02001010 }
1011}
1012
1013/**
1014 * verify_bbt_descr - verify the bad block description
Sergey Lapin3a38a552013-01-14 03:46:50 +00001015 * @mtd: MTD device structure
1016 * @bd: the table to verify
Christian Hitz24e6ea42011-10-12 09:32:04 +02001017 *
1018 * This functions performs a few sanity checks on the bad block description
1019 * table.
1020 */
1021static void verify_bbt_descr(struct mtd_info *mtd, struct nand_bbt_descr *bd)
1022{
Scott Wood17fed142016-05-30 13:57:56 -05001023 struct nand_chip *this = mtd_to_nand(mtd);
Christian Hitz24e6ea42011-10-12 09:32:04 +02001024 u32 pattern_len;
1025 u32 bits;
1026 u32 table_size;
1027
1028 if (!bd)
1029 return;
1030
1031 pattern_len = bd->len;
1032 bits = bd->options & NAND_BBT_NRBITS_MSK;
1033
Sergey Lapin3a38a552013-01-14 03:46:50 +00001034 BUG_ON((this->bbt_options & NAND_BBT_NO_OOB) &&
1035 !(this->bbt_options & NAND_BBT_USE_FLASH));
Christian Hitz24e6ea42011-10-12 09:32:04 +02001036 BUG_ON(!bits);
1037
1038 if (bd->options & NAND_BBT_VERSION)
1039 pattern_len++;
1040
1041 if (bd->options & NAND_BBT_NO_OOB) {
Sergey Lapin3a38a552013-01-14 03:46:50 +00001042 BUG_ON(!(this->bbt_options & NAND_BBT_USE_FLASH));
1043 BUG_ON(!(this->bbt_options & NAND_BBT_NO_OOB));
Christian Hitz24e6ea42011-10-12 09:32:04 +02001044 BUG_ON(bd->offs);
1045 if (bd->options & NAND_BBT_VERSION)
1046 BUG_ON(bd->veroffs != bd->len);
1047 BUG_ON(bd->options & NAND_BBT_SAVECONTENT);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001048 }
Christian Hitz24e6ea42011-10-12 09:32:04 +02001049
1050 if (bd->options & NAND_BBT_PERCHIP)
1051 table_size = this->chipsize >> this->bbt_erase_shift;
1052 else
1053 table_size = mtd->size >> this->bbt_erase_shift;
1054 table_size >>= 3;
1055 table_size *= bits;
1056 if (bd->options & NAND_BBT_NO_OOB)
1057 table_size += pattern_len;
1058 BUG_ON(table_size > (1 << this->bbt_erase_shift));
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001059}
1060
1061/**
1062 * nand_scan_bbt - [NAND Interface] scan, find, read and maybe create bad block table(s)
Sergey Lapin3a38a552013-01-14 03:46:50 +00001063 * @mtd: MTD device structure
1064 * @bd: descriptor for the good/bad block search pattern
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001065 *
Sergey Lapin3a38a552013-01-14 03:46:50 +00001066 * The function checks, if a bad block table(s) is/are already available. If
1067 * not it scans the device for manufacturer marked good / bad blocks and writes
1068 * the bad block table(s) to the selected place.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001069 *
Sergey Lapin3a38a552013-01-14 03:46:50 +00001070 * The bad block table memory is allocated here. It must be freed by calling
1071 * the nand_free_bbt function.
1072 */
Scott Wood52ab7ce2016-05-30 13:57:58 -05001073static int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001074{
Scott Wood17fed142016-05-30 13:57:56 -05001075 struct nand_chip *this = mtd_to_nand(mtd);
Scott Wood52ab7ce2016-05-30 13:57:58 -05001076 int len, res;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001077 uint8_t *buf;
1078 struct nand_bbt_descr *td = this->bbt_td;
1079 struct nand_bbt_descr *md = this->bbt_md;
1080
Scott Wood52ab7ce2016-05-30 13:57:58 -05001081 len = (mtd->size >> (this->bbt_erase_shift + 2)) ? : 1;
Sergey Lapin3a38a552013-01-14 03:46:50 +00001082 /*
1083 * Allocate memory (2bit per block) and clear the memory bad block
1084 * table.
1085 */
William Juul52c07962007-10-31 13:53:06 +01001086 this->bbt = kzalloc(len, GFP_KERNEL);
Sergey Lapin3a38a552013-01-14 03:46:50 +00001087 if (!this->bbt)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001088 return -ENOMEM;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001089
Sergey Lapin3a38a552013-01-14 03:46:50 +00001090 /*
1091 * If no primary table decriptor is given, scan the device to build a
1092 * memory based bad block table.
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001093 */
William Juul52c07962007-10-31 13:53:06 +01001094 if (!td) {
1095 if ((res = nand_memory_bbt(mtd, bd))) {
Sergey Lapin3a38a552013-01-14 03:46:50 +00001096 pr_err("nand_bbt: can't scan flash and build the RAM-based BBT\n");
Scott Wood52ab7ce2016-05-30 13:57:58 -05001097 goto err;
William Juul52c07962007-10-31 13:53:06 +01001098 }
Scott Wood52ab7ce2016-05-30 13:57:58 -05001099 return 0;
William Juul52c07962007-10-31 13:53:06 +01001100 }
Christian Hitz24e6ea42011-10-12 09:32:04 +02001101 verify_bbt_descr(mtd, td);
1102 verify_bbt_descr(mtd, md);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001103
1104 /* Allocate a temporary buffer for one eraseblock incl. oob */
1105 len = (1 << this->bbt_erase_shift);
1106 len += (len >> this->page_shift) * mtd->oobsize;
William Juul52c07962007-10-31 13:53:06 +01001107 buf = vmalloc(len);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001108 if (!buf) {
Scott Wood52ab7ce2016-05-30 13:57:58 -05001109 res = -ENOMEM;
1110 goto err;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001111 }
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001112
Sergey Lapin3a38a552013-01-14 03:46:50 +00001113 /* Is the bbt at a given page? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001114 if (td->options & NAND_BBT_ABSPAGE) {
Sergey Lapin3a38a552013-01-14 03:46:50 +00001115 read_abs_bbts(mtd, buf, td, md);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001116 } else {
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001117 /* Search the bad block table using a pattern in oob */
Sergey Lapin3a38a552013-01-14 03:46:50 +00001118 search_read_bbts(mtd, buf, td, md);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001119 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001120
Sergey Lapin3a38a552013-01-14 03:46:50 +00001121 res = check_create(mtd, buf, bd);
Scott Wood52ab7ce2016-05-30 13:57:58 -05001122 if (res)
1123 goto err;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001124
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001125 /* Prevent the bbt regions from erasing / writing */
William Juul52c07962007-10-31 13:53:06 +01001126 mark_bbt_region(mtd, td);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001127 if (md)
William Juul52c07962007-10-31 13:53:06 +01001128 mark_bbt_region(mtd, md);
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001129
William Juul52c07962007-10-31 13:53:06 +01001130 vfree(buf);
Scott Wood52ab7ce2016-05-30 13:57:58 -05001131 return 0;
1132
1133err:
1134 kfree(this->bbt);
1135 this->bbt = NULL;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001136 return res;
1137}
1138
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001139/**
Heiko Schocherf5895d12014-06-24 10:10:04 +02001140 * nand_update_bbt - update bad block table(s)
Sergey Lapin3a38a552013-01-14 03:46:50 +00001141 * @mtd: MTD device structure
1142 * @offs: the offset of the newly marked block
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001143 *
Sergey Lapin3a38a552013-01-14 03:46:50 +00001144 * The function updates the bad block table(s).
1145 */
Heiko Schocherf5895d12014-06-24 10:10:04 +02001146static int nand_update_bbt(struct mtd_info *mtd, loff_t offs)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001147{
Scott Wood17fed142016-05-30 13:57:56 -05001148 struct nand_chip *this = mtd_to_nand(mtd);
Sergey Lapin3a38a552013-01-14 03:46:50 +00001149 int len, res = 0;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001150 int chip, chipsel;
1151 uint8_t *buf;
1152 struct nand_bbt_descr *td = this->bbt_td;
1153 struct nand_bbt_descr *md = this->bbt_md;
1154
1155 if (!this->bbt || !td)
1156 return -EINVAL;
1157
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001158 /* Allocate a temporary buffer for one eraseblock incl. oob */
1159 len = (1 << this->bbt_erase_shift);
1160 len += (len >> this->page_shift) * mtd->oobsize;
William Juul52c07962007-10-31 13:53:06 +01001161 buf = kmalloc(len, GFP_KERNEL);
Sergey Lapin3a38a552013-01-14 03:46:50 +00001162 if (!buf)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001163 return -ENOMEM;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001164
Sergey Lapin3a38a552013-01-14 03:46:50 +00001165 /* Do we have a bbt per chip? */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001166 if (td->options & NAND_BBT_PERCHIP) {
William Juul52c07962007-10-31 13:53:06 +01001167 chip = (int)(offs >> this->chip_shift);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001168 chipsel = chip;
1169 } else {
1170 chip = 0;
1171 chipsel = -1;
1172 }
1173
1174 td->version[chip]++;
1175 if (md)
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001176 md->version[chip]++;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001177
Sergey Lapin3a38a552013-01-14 03:46:50 +00001178 /* Write the bad block table to the device? */
1179 if (td->options & NAND_BBT_WRITE) {
William Juul52c07962007-10-31 13:53:06 +01001180 res = write_bbt(mtd, buf, td, md, chipsel);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001181 if (res < 0)
1182 goto out;
1183 }
Sergey Lapin3a38a552013-01-14 03:46:50 +00001184 /* Write the mirror bad block table to the device? */
1185 if (md && (md->options & NAND_BBT_WRITE)) {
William Juul52c07962007-10-31 13:53:06 +01001186 res = write_bbt(mtd, buf, md, td, chipsel);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001187 }
1188
William Juul52c07962007-10-31 13:53:06 +01001189 out:
1190 kfree(buf);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001191 return res;
1192}
1193
Sergey Lapin3a38a552013-01-14 03:46:50 +00001194/*
1195 * Define some generic bad / good block scan pattern which are used
1196 * while scanning a device for factory marked good / bad blocks.
1197 */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001198static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
1199
Sergey Lapin3a38a552013-01-14 03:46:50 +00001200/* Generic flash bbt descriptors */
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001201static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1202static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1203
1204static struct nand_bbt_descr bbt_main_descr = {
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001205 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001206 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1207 .offs = 8,
1208 .len = 4,
1209 .veroffs = 12,
Sergey Lapin3a38a552013-01-14 03:46:50 +00001210 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001211 .pattern = bbt_pattern
1212};
1213
1214static struct nand_bbt_descr bbt_mirror_descr = {
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001215 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001216 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1217 .offs = 8,
1218 .len = 4,
1219 .veroffs = 12,
Sergey Lapin3a38a552013-01-14 03:46:50 +00001220 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001221 .pattern = mirror_pattern
1222};
1223
Sergey Lapin3a38a552013-01-14 03:46:50 +00001224static struct nand_bbt_descr bbt_main_no_oob_descr = {
Christian Hitz24e6ea42011-10-12 09:32:04 +02001225 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1226 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1227 | NAND_BBT_NO_OOB,
1228 .len = 4,
1229 .veroffs = 4,
Sergey Lapin3a38a552013-01-14 03:46:50 +00001230 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Christian Hitz24e6ea42011-10-12 09:32:04 +02001231 .pattern = bbt_pattern
1232};
1233
Sergey Lapin3a38a552013-01-14 03:46:50 +00001234static struct nand_bbt_descr bbt_mirror_no_oob_descr = {
Christian Hitz24e6ea42011-10-12 09:32:04 +02001235 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1236 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP
1237 | NAND_BBT_NO_OOB,
1238 .len = 4,
1239 .veroffs = 4,
Sergey Lapin3a38a552013-01-14 03:46:50 +00001240 .maxblocks = NAND_BBT_SCAN_MAXBLOCKS,
Christian Hitz24e6ea42011-10-12 09:32:04 +02001241 .pattern = mirror_pattern
1242};
1243
Sergey Lapin3a38a552013-01-14 03:46:50 +00001244#define BADBLOCK_SCAN_MASK (~NAND_BBT_NO_OOB)
Christian Hitz24e6ea42011-10-12 09:32:04 +02001245/**
Sergey Lapin3a38a552013-01-14 03:46:50 +00001246 * nand_create_badblock_pattern - [INTERN] Creates a BBT descriptor structure
1247 * @this: NAND chip to create descriptor for
Christian Hitz24e6ea42011-10-12 09:32:04 +02001248 *
1249 * This function allocates and initializes a nand_bbt_descr for BBM detection
Sergey Lapin3a38a552013-01-14 03:46:50 +00001250 * based on the properties of @this. The new descriptor is stored in
Christian Hitz24e6ea42011-10-12 09:32:04 +02001251 * this->badblock_pattern. Thus, this->badblock_pattern should be NULL when
1252 * passed to this function.
Christian Hitz24e6ea42011-10-12 09:32:04 +02001253 */
Sergey Lapin3a38a552013-01-14 03:46:50 +00001254static int nand_create_badblock_pattern(struct nand_chip *this)
Christian Hitz24e6ea42011-10-12 09:32:04 +02001255{
1256 struct nand_bbt_descr *bd;
1257 if (this->badblock_pattern) {
Sergey Lapin3a38a552013-01-14 03:46:50 +00001258 pr_warn("Bad block pattern already allocated; not replacing\n");
Christian Hitz24e6ea42011-10-12 09:32:04 +02001259 return -EINVAL;
1260 }
1261 bd = kzalloc(sizeof(*bd), GFP_KERNEL);
Sergey Lapin3a38a552013-01-14 03:46:50 +00001262 if (!bd)
Christian Hitz24e6ea42011-10-12 09:32:04 +02001263 return -ENOMEM;
Sergey Lapin3a38a552013-01-14 03:46:50 +00001264 bd->options = this->bbt_options & BADBLOCK_SCAN_MASK;
Christian Hitz24e6ea42011-10-12 09:32:04 +02001265 bd->offs = this->badblockpos;
1266 bd->len = (this->options & NAND_BUSWIDTH_16) ? 2 : 1;
1267 bd->pattern = scan_ff_pattern;
1268 bd->options |= NAND_BBT_DYNAMICSTRUCT;
1269 this->badblock_pattern = bd;
1270 return 0;
1271}
1272
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001273/**
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001274 * nand_default_bbt - [NAND Interface] Select a default bad block table for the device
Sergey Lapin3a38a552013-01-14 03:46:50 +00001275 * @mtd: MTD device structure
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001276 *
Sergey Lapin3a38a552013-01-14 03:46:50 +00001277 * This function selects the default bad block table support for the device and
1278 * calls the nand_scan_bbt function.
1279 */
William Juul52c07962007-10-31 13:53:06 +01001280int nand_default_bbt(struct mtd_info *mtd)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001281{
Scott Wood17fed142016-05-30 13:57:56 -05001282 struct nand_chip *this = mtd_to_nand(mtd);
Scott Wood3ea94ed2015-06-26 19:03:26 -05001283 int ret;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001284
Sergey Lapin3a38a552013-01-14 03:46:50 +00001285 /* Is a flash based bad block table requested? */
1286 if (this->bbt_options & NAND_BBT_USE_FLASH) {
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001287 /* Use the default pattern descriptors */
1288 if (!this->bbt_td) {
Sergey Lapin3a38a552013-01-14 03:46:50 +00001289 if (this->bbt_options & NAND_BBT_NO_OOB) {
1290 this->bbt_td = &bbt_main_no_oob_descr;
1291 this->bbt_md = &bbt_mirror_no_oob_descr;
Christian Hitz24e6ea42011-10-12 09:32:04 +02001292 } else {
1293 this->bbt_td = &bbt_main_descr;
1294 this->bbt_md = &bbt_mirror_descr;
1295 }
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001296 }
1297 } else {
1298 this->bbt_td = NULL;
1299 this->bbt_md = NULL;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001300 }
Christian Hitz24e6ea42011-10-12 09:32:04 +02001301
Scott Wood3ea94ed2015-06-26 19:03:26 -05001302 if (!this->badblock_pattern) {
1303 ret = nand_create_badblock_pattern(this);
1304 if (ret)
1305 return ret;
1306 }
Christian Hitz24e6ea42011-10-12 09:32:04 +02001307
William Juul52c07962007-10-31 13:53:06 +01001308 return nand_scan_bbt(mtd, this->badblock_pattern);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001309}
1310
1311/**
Ezequiel Garciafc9d57c2014-05-21 19:06:12 -03001312 * nand_isreserved_bbt - [NAND Interface] Check if a block is reserved
1313 * @mtd: MTD device structure
1314 * @offs: offset in the device
1315 */
1316int nand_isreserved_bbt(struct mtd_info *mtd, loff_t offs)
1317{
Scott Wood17fed142016-05-30 13:57:56 -05001318 struct nand_chip *this = mtd_to_nand(mtd);
Ezequiel Garciafc9d57c2014-05-21 19:06:12 -03001319 int block;
1320
1321 block = (int)(offs >> this->bbt_erase_shift);
1322 return bbt_get_entry(this, block) == BBT_BLOCK_RESERVED;
1323}
1324
1325/**
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001326 * nand_isbad_bbt - [NAND Interface] Check if a block is bad
Sergey Lapin3a38a552013-01-14 03:46:50 +00001327 * @mtd: MTD device structure
1328 * @offs: offset in the device
1329 * @allowbbt: allow access to bad block table region
1330 */
William Juul52c07962007-10-31 13:53:06 +01001331int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001332{
Scott Wood17fed142016-05-30 13:57:56 -05001333 struct nand_chip *this = mtd_to_nand(mtd);
Heiko Schocherf5895d12014-06-24 10:10:04 +02001334 int block, res;
Wolfgang Denk7b9bc3a2005-09-14 23:53:32 +02001335
Heiko Schocherf5895d12014-06-24 10:10:04 +02001336 block = (int)(offs >> this->bbt_erase_shift);
1337 res = bbt_get_entry(this, block);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001338
Scott Wood3ea94ed2015-06-26 19:03:26 -05001339 pr_debug("nand_isbad_bbt(): bbt info for offs 0x%08x: (block %d) 0x%02x\n",
1340 (unsigned int)offs, block, res);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001341
Heiko Schocherf5895d12014-06-24 10:10:04 +02001342 switch (res) {
1343 case BBT_BLOCK_GOOD:
William Juul52c07962007-10-31 13:53:06 +01001344 return 0;
Heiko Schocherf5895d12014-06-24 10:10:04 +02001345 case BBT_BLOCK_WORN:
William Juul52c07962007-10-31 13:53:06 +01001346 return 1;
Heiko Schocherf5895d12014-06-24 10:10:04 +02001347 case BBT_BLOCK_RESERVED:
William Juul52c07962007-10-31 13:53:06 +01001348 return allowbbt ? 0 : 1;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02001349 }
1350 return 1;
1351}
Heiko Schocherf5895d12014-06-24 10:10:04 +02001352
1353/**
1354 * nand_markbad_bbt - [NAND Interface] Mark a block bad in the BBT
1355 * @mtd: MTD device structure
1356 * @offs: offset of the bad block
1357 */
1358int nand_markbad_bbt(struct mtd_info *mtd, loff_t offs)
1359{
Scott Wood17fed142016-05-30 13:57:56 -05001360 struct nand_chip *this = mtd_to_nand(mtd);
Heiko Schocherf5895d12014-06-24 10:10:04 +02001361 int block, ret = 0;
1362
1363 block = (int)(offs >> this->bbt_erase_shift);
1364
1365 /* Mark bad block in memory */
1366 bbt_mark_entry(this, block, BBT_BLOCK_WORN);
1367
1368 /* Update flash-based bad block table */
1369 if (this->bbt_options & NAND_BBT_USE_FLASH)
1370 ret = nand_update_bbt(mtd, offs);
1371
1372 return ret;
1373}