blob: c37298577789243247b1d9ce1955b51356ea9589 [file] [log] [blame]
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001/*
2 * Copyright (c) International Business Machines Corp., 2006
3 * Copyright (c) Nokia Corporation, 2006, 2007
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
13 * the GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 *
19 * Author: Artem Bityutskiy (Битюцкий Артём)
20 */
21
22/*
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030023 * UBI input/output sub-system.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040024 *
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030025 * This sub-system provides a uniform way to work with all kinds of the
26 * underlying MTD devices. It also implements handy functions for reading and
27 * writing UBI headers.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040028 *
29 * We are trying to have a paranoid mindset and not to trust to what we read
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030030 * from the flash media in order to be more secure and robust. So this
31 * sub-system validates every single header it reads from the flash media.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040032 *
33 * Some words about how the eraseblock headers are stored.
34 *
35 * The erase counter header is always stored at offset zero. By default, the
36 * VID header is stored after the EC header at the closest aligned offset
37 * (i.e. aligned to the minimum I/O unit size). Data starts next to the VID
38 * header at the closest aligned offset. But this default layout may be
39 * changed. For example, for different reasons (e.g., optimization) UBI may be
40 * asked to put the VID header at further offset, and even at an unaligned
41 * offset. Of course, if the offset of the VID header is unaligned, UBI adds
42 * proper padding in front of it. Data offset may also be changed but it has to
43 * be aligned.
44 *
45 * About minimal I/O units. In general, UBI assumes flash device model where
46 * there is only one minimal I/O unit size. E.g., in case of NOR flash it is 1,
47 * in case of NAND flash it is a NAND page, etc. This is reported by MTD in the
48 * @ubi->mtd->writesize field. But as an exception, UBI admits of using another
49 * (smaller) minimal I/O unit size for EC and VID headers to make it possible
50 * to do different optimizations.
51 *
52 * This is extremely useful in case of NAND flashes which admit of several
53 * write operations to one NAND page. In this case UBI can fit EC and VID
54 * headers at one NAND page. Thus, UBI may use "sub-page" size as the minimal
55 * I/O unit for the headers (the @ubi->hdrs_min_io_size field). But it still
56 * reports NAND page size (@ubi->min_io_size) as a minimal I/O unit for the UBI
57 * users.
58 *
59 * Example: some Samsung NANDs with 2KiB pages allow 4x 512-byte writes, so
60 * although the minimal I/O unit is 2K, UBI uses 512 bytes for EC and VID
61 * headers.
62 *
63 * Q: why not just to treat sub-page as a minimal I/O unit of this flash
64 * device, e.g., make @ubi->min_io_size = 512 in the example above?
65 *
66 * A: because when writing a sub-page, MTD still writes a full 2K page but the
Shinya Kuribayashibe436f62010-05-06 19:22:09 +090067 * bytes which are not relevant to the sub-page are 0xFF. So, basically,
68 * writing 4x512 sub-pages is 4 times slower than writing one 2KiB NAND page.
69 * Thus, we prefer to use sub-pages only for EC and VID headers.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040070 *
71 * As it was noted above, the VID header may start at a non-aligned offset.
72 * For example, in case of a 2KiB page NAND flash with a 512 bytes sub-page,
73 * the VID header may reside at offset 1984 which is the last 64 bytes of the
74 * last sub-page (EC header is always at offset zero). This causes some
75 * difficulties when reading and writing VID headers.
76 *
77 * Suppose we have a 64-byte buffer and we read a VID header at it. We change
78 * the data and want to write this VID header out. As we can only write in
79 * 512-byte chunks, we have to allocate one more buffer and copy our VID header
80 * to offset 448 of this buffer.
81 *
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030082 * The I/O sub-system does the following trick in order to avoid this extra
83 * copy. It always allocates a @ubi->vid_hdr_alsize bytes buffer for the VID
84 * header and returns a pointer to offset @ubi->vid_hdr_shift of this buffer.
85 * When the VID header is being written out, it shifts the VID header pointer
86 * back and writes the whole sub-page.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040087 */
88
89#include <linux/crc32.h>
90#include <linux/err.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090091#include <linux/slab.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040092#include "ubi.h"
93
Artem Bityutskiy8056eb42012-05-16 18:24:09 +030094static int self_check_not_bad(const struct ubi_device *ubi, int pnum);
95static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum);
96static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
97 const struct ubi_ec_hdr *ec_hdr);
98static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum);
99static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
100 const struct ubi_vid_hdr *vid_hdr);
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300101static int self_check_write(struct ubi_device *ubi, const void *buf, int pnum,
102 int offset, int len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400103
104/**
105 * ubi_io_read - read data from a physical eraseblock.
106 * @ubi: UBI device description object
107 * @buf: buffer where to store the read data
108 * @pnum: physical eraseblock number to read from
109 * @offset: offset within the physical eraseblock from where to read
110 * @len: how many bytes to read
111 *
112 * This function reads data from offset @offset of physical eraseblock @pnum
113 * and stores the read data in the @buf buffer. The following return codes are
114 * possible:
115 *
116 * o %0 if all the requested data were successfully read;
117 * o %UBI_IO_BITFLIPS if all the requested data were successfully read, but
118 * correctable bit-flips were detected; this is harmless but may indicate
119 * that this eraseblock may become bad soon (but do not have to);
Artem Bityutskiy63b6c1e2007-07-17 15:04:20 +0300120 * o %-EBADMSG if the MTD subsystem reported about data integrity problems, for
121 * example it can be an ECC error in case of NAND; this most probably means
122 * that the data is corrupted;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400123 * o %-EIO if some I/O error occurred;
124 * o other negative error codes in case of other errors.
125 */
126int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
127 int len)
128{
129 int err, retries = 0;
130 size_t read;
131 loff_t addr;
132
133 dbg_io("read %d bytes from PEB %d:%d", len, pnum, offset);
134
135 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
136 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
137 ubi_assert(len > 0);
138
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300139 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400140 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200141 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400142
Artem Bityutskiy276832d2010-11-13 15:08:29 +0200143 /*
144 * Deliberately corrupt the buffer to improve robustness. Indeed, if we
145 * do not do this, the following may happen:
146 * 1. The buffer contains data from previous operation, e.g., read from
147 * another PEB previously. The data looks like expected, e.g., if we
148 * just do not read anything and return - the caller would not
149 * notice this. E.g., if we are reading a VID header, the buffer may
150 * contain a valid VID header from another PEB.
151 * 2. The driver is buggy and returns us success or -EBADMSG or
152 * -EUCLEAN, but it does not actually put any data to the buffer.
153 *
154 * This may confuse UBI or upper layers - they may think the buffer
155 * contains valid data while in fact it is just old data. This is
156 * especially possible because UBI (and UBIFS) relies on CRC, and
157 * treats data as correct even in case of ECC errors if the CRC is
158 * correct.
159 *
160 * Try to prevent this situation by changing the first byte of the
161 * buffer.
162 */
163 *((uint8_t *)buf) ^= 0xFF;
164
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400165 addr = (loff_t)pnum * ubi->peb_size + offset;
166retry:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200167 err = mtd_read(ubi->mtd, addr, len, &read, buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400168 if (err) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700169 const char *errstr = mtd_is_eccerr(err) ? " (ECC error)" : "";
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300170
Brian Norrisd57f40542011-09-20 18:34:25 -0700171 if (mtd_is_bitflip(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400172 /*
173 * -EUCLEAN is reported if there was a bit-flip which
174 * was corrected, so this is harmless.
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300175 *
176 * We do not report about it here unless debugging is
177 * enabled. A corresponding message will be printed
178 * later, when it is has been scrubbed.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400179 */
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300180 dbg_msg("fixable bit-flip detected at PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400181 ubi_assert(len == read);
182 return UBI_IO_BITFLIPS;
183 }
184
Artem Bityutskiya87f29c2010-10-31 18:55:30 +0200185 if (retries++ < UBI_IO_RETRIES) {
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300186 ubi_warn("error %d%s while reading %d bytes from PEB "
187 "%d:%d, read only %zd bytes, retry",
188 err, errstr, len, pnum, offset, read);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400189 yield();
190 goto retry;
191 }
192
Artem Bityutskiyf5d5b1f2010-06-14 08:15:39 +0300193 ubi_err("error %d%s while reading %d bytes from PEB %d:%d, "
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300194 "read %zd bytes", err, errstr, len, pnum, offset, read);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300195 dump_stack();
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300196
197 /*
198 * The driver should never return -EBADMSG if it failed to read
199 * all the requested data. But some buggy drivers might do
200 * this, so we change it to -EIO.
201 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700202 if (read != len && mtd_is_eccerr(err)) {
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300203 ubi_assert(0);
204 err = -EIO;
205 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400206 } else {
207 ubi_assert(len == read);
208
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300209 if (ubi_dbg_is_bitflip(ubi)) {
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300210 dbg_gen("bit-flip (emulated)");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400211 err = UBI_IO_BITFLIPS;
212 }
213 }
214
215 return err;
216}
217
218/**
219 * ubi_io_write - write data to a physical eraseblock.
220 * @ubi: UBI device description object
221 * @buf: buffer with the data to write
222 * @pnum: physical eraseblock number to write to
223 * @offset: offset within the physical eraseblock where to write
224 * @len: how many bytes to write
225 *
226 * This function writes @len bytes of data from buffer @buf to offset @offset
227 * of physical eraseblock @pnum. If all the data were successfully written,
228 * zero is returned. If an error occurred, this function returns a negative
229 * error code. If %-EIO is returned, the physical eraseblock most probably went
230 * bad.
231 *
232 * Note, in case of an error, it is possible that something was still written
233 * to the flash media, but may be some garbage.
234 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300235int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
236 int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400237{
238 int err;
239 size_t written;
240 loff_t addr;
241
242 dbg_io("write %d bytes to PEB %d:%d", len, pnum, offset);
243
244 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
245 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
246 ubi_assert(offset % ubi->hdrs_min_io_size == 0);
247 ubi_assert(len > 0 && len % ubi->hdrs_min_io_size == 0);
248
249 if (ubi->ro_mode) {
250 ubi_err("read-only mode");
251 return -EROFS;
252 }
253
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300254 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400255 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200256 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400257
258 /* The area we are writing to has to contain all 0xFF bytes */
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300259 err = ubi_self_check_all_ff(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400260 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200261 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400262
263 if (offset >= ubi->leb_start) {
264 /*
265 * We write to the data area of the physical eraseblock. Make
266 * sure it has valid EC and VID headers.
267 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300268 err = self_check_peb_ec_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400269 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200270 return err;
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300271 err = self_check_peb_vid_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400272 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200273 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400274 }
275
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300276 if (ubi_dbg_is_write_failure(ubi)) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300277 ubi_err("cannot write %d bytes to PEB %d:%d "
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400278 "(emulated)", len, pnum, offset);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300279 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400280 return -EIO;
281 }
282
283 addr = (loff_t)pnum * ubi->peb_size + offset;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200284 err = mtd_write(ubi->mtd, addr, len, &written, buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400285 if (err) {
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300286 ubi_err("error %d while writing %d bytes to PEB %d:%d, written "
287 "%zd bytes", err, len, pnum, offset, written);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300288 dump_stack();
Artem Bityutskiyef7088e2012-04-24 07:10:33 +0300289 ubi_dump_flash(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400290 } else
291 ubi_assert(written == len);
292
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200293 if (!err) {
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300294 err = self_check_write(ubi, buf, pnum, offset, len);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200295 if (err)
296 return err;
297
298 /*
299 * Since we always write sequentially, the rest of the PEB has
300 * to contain only 0xFF bytes.
301 */
302 offset += len;
303 len = ubi->peb_size - offset;
304 if (len)
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300305 err = ubi_self_check_all_ff(ubi, pnum, offset, len);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200306 }
307
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400308 return err;
309}
310
311/**
312 * erase_callback - MTD erasure call-back.
313 * @ei: MTD erase information object.
314 *
315 * Note, even though MTD erase interface is asynchronous, all the current
316 * implementations are synchronous anyway.
317 */
318static void erase_callback(struct erase_info *ei)
319{
320 wake_up_interruptible((wait_queue_head_t *)ei->priv);
321}
322
323/**
324 * do_sync_erase - synchronously erase a physical eraseblock.
325 * @ubi: UBI device description object
326 * @pnum: the physical eraseblock number to erase
327 *
328 * This function synchronously erases physical eraseblock @pnum and returns
329 * zero in case of success and a negative error code in case of failure. If
330 * %-EIO is returned, the physical eraseblock most probably went bad.
331 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300332static int do_sync_erase(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400333{
334 int err, retries = 0;
335 struct erase_info ei;
336 wait_queue_head_t wq;
337
338 dbg_io("erase PEB %d", pnum);
Artem Bityutskiy3efe5092011-03-18 18:11:42 +0200339 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
340
341 if (ubi->ro_mode) {
342 ubi_err("read-only mode");
343 return -EROFS;
344 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400345
346retry:
347 init_waitqueue_head(&wq);
348 memset(&ei, 0, sizeof(struct erase_info));
349
350 ei.mtd = ubi->mtd;
Brijesh Singh2f176f72007-07-05 15:07:35 +0530351 ei.addr = (loff_t)pnum * ubi->peb_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400352 ei.len = ubi->peb_size;
353 ei.callback = erase_callback;
354 ei.priv = (unsigned long)&wq;
355
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200356 err = mtd_erase(ubi->mtd, &ei);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400357 if (err) {
358 if (retries++ < UBI_IO_RETRIES) {
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300359 ubi_warn("error %d while erasing PEB %d, retry",
360 err, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400361 yield();
362 goto retry;
363 }
364 ubi_err("cannot erase PEB %d, error %d", pnum, err);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300365 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400366 return err;
367 }
368
369 err = wait_event_interruptible(wq, ei.state == MTD_ERASE_DONE ||
370 ei.state == MTD_ERASE_FAILED);
371 if (err) {
372 ubi_err("interrupted PEB %d erasure", pnum);
373 return -EINTR;
374 }
375
376 if (ei.state == MTD_ERASE_FAILED) {
377 if (retries++ < UBI_IO_RETRIES) {
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300378 ubi_warn("error while erasing PEB %d, retry", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400379 yield();
380 goto retry;
381 }
382 ubi_err("cannot erase PEB %d", pnum);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300383 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400384 return -EIO;
385 }
386
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300387 err = ubi_self_check_all_ff(ubi, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400388 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200389 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400390
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300391 if (ubi_dbg_is_erase_failure(ubi)) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300392 ubi_err("cannot erase PEB %d (emulated)", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400393 return -EIO;
394 }
395
396 return 0;
397}
398
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400399/* Patterns to write to a physical eraseblock when torturing it */
400static uint8_t patterns[] = {0xa5, 0x5a, 0x0};
401
402/**
403 * torture_peb - test a supposedly bad physical eraseblock.
404 * @ubi: UBI device description object
405 * @pnum: the physical eraseblock number to test
406 *
407 * This function returns %-EIO if the physical eraseblock did not pass the
408 * test, a positive number of erase operations done if the test was
409 * successfully passed, and other negative error codes in case of other errors.
410 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300411static int torture_peb(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400412{
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400413 int err, i, patt_count;
414
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300415 ubi_msg("run torture test for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400416 patt_count = ARRAY_SIZE(patterns);
417 ubi_assert(patt_count > 0);
418
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300419 mutex_lock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400420 for (i = 0; i < patt_count; i++) {
421 err = do_sync_erase(ubi, pnum);
422 if (err)
423 goto out;
424
425 /* Make sure the PEB contains only 0xFF bytes */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200426 err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400427 if (err)
428 goto out;
429
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200430 err = ubi_check_pattern(ubi->peb_buf, 0xFF, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400431 if (err == 0) {
432 ubi_err("erased PEB %d, but a non-0xFF byte found",
433 pnum);
434 err = -EIO;
435 goto out;
436 }
437
438 /* Write a pattern and check it */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200439 memset(ubi->peb_buf, patterns[i], ubi->peb_size);
440 err = ubi_io_write(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400441 if (err)
442 goto out;
443
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200444 memset(ubi->peb_buf, ~patterns[i], ubi->peb_size);
445 err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400446 if (err)
447 goto out;
448
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200449 err = ubi_check_pattern(ubi->peb_buf, patterns[i],
Artem Bityutskiybb00e182010-07-31 09:37:34 +0300450 ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400451 if (err == 0) {
452 ubi_err("pattern %x checking failed for PEB %d",
453 patterns[i], pnum);
454 err = -EIO;
455 goto out;
456 }
457 }
458
459 err = patt_count;
Artem Bityutskiy14264142011-04-14 11:36:31 +0300460 ubi_msg("PEB %d passed torture test, do not mark it as bad", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400461
462out:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300463 mutex_unlock(&ubi->buf_mutex);
Brian Norrisd57f40542011-09-20 18:34:25 -0700464 if (err == UBI_IO_BITFLIPS || mtd_is_eccerr(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400465 /*
466 * If a bit-flip or data integrity error was detected, the test
467 * has not passed because it happened on a freshly erased
468 * physical eraseblock which means something is wrong with it.
469 */
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300470 ubi_err("read problems on freshly erased PEB %d, must be bad",
471 pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400472 err = -EIO;
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300473 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400474 return err;
475}
476
477/**
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300478 * nor_erase_prepare - prepare a NOR flash PEB for erasure.
479 * @ubi: UBI device description object
480 * @pnum: physical eraseblock number to prepare
481 *
482 * NOR flash, or at least some of them, have peculiar embedded PEB erasure
483 * algorithm: the PEB is first filled with zeroes, then it is erased. And
484 * filling with zeroes starts from the end of the PEB. This was observed with
485 * Spansion S29GL512N NOR flash.
486 *
487 * This means that in case of a power cut we may end up with intact data at the
488 * beginning of the PEB, and all zeroes at the end of PEB. In other words, the
489 * EC and VID headers are OK, but a large chunk of data at the end of PEB is
490 * zeroed. This makes UBI mistakenly treat this PEB as used and associate it
491 * with an LEB, which leads to subsequent failures (e.g., UBIFS fails).
492 *
493 * This function is called before erasing NOR PEBs and it zeroes out EC and VID
494 * magic numbers in order to invalidate them and prevent the failures. Returns
495 * zero in case of success and a negative error code in case of failure.
496 */
497static int nor_erase_prepare(struct ubi_device *ubi, int pnum)
498{
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300499 int err, err1;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300500 size_t written;
501 loff_t addr;
502 uint32_t data = 0;
Artem Bityutskiy2fff5702010-12-03 15:32:21 +0200503 /*
504 * Note, we cannot generally define VID header buffers on stack,
505 * because of the way we deal with these buffers (see the header
506 * comment in this file). But we know this is a NOR-specific piece of
507 * code, so we can do this. But yes, this is error-prone and we should
508 * (pre-)allocate VID header buffer instead.
509 */
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300510 struct ubi_vid_hdr vid_hdr;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300511
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200512 /*
513 * It is important to first invalidate the EC header, and then the VID
514 * header. Otherwise a power cut may lead to valid EC header and
515 * invalid VID header, in which case UBI will treat this PEB as
516 * corrupted and will try to preserve it, and print scary warnings (see
517 * the header comment in scan.c for more information).
518 */
519 addr = (loff_t)pnum * ubi->peb_size;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200520 err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300521 if (!err) {
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200522 addr += ubi->vid_hdr_aloffset;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200523 err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300524 if (!err)
525 return 0;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300526 }
527
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300528 /*
529 * We failed to write to the media. This was observed with Spansion
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200530 * S29GL512N NOR flash. Most probably the previously eraseblock erasure
531 * was interrupted at a very inappropriate moment, so it became
532 * unwritable. In this case we probably anyway have garbage in this
533 * PEB.
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300534 */
535 err1 = ubi_io_read_vid_hdr(ubi, pnum, &vid_hdr, 0);
Holger Brunckd4c63812011-01-25 13:04:11 +0200536 if (err1 == UBI_IO_BAD_HDR_EBADMSG || err1 == UBI_IO_BAD_HDR ||
537 err1 == UBI_IO_FF) {
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200538 struct ubi_ec_hdr ec_hdr;
539
540 err1 = ubi_io_read_ec_hdr(ubi, pnum, &ec_hdr, 0);
Holger Brunckd4c63812011-01-25 13:04:11 +0200541 if (err1 == UBI_IO_BAD_HDR_EBADMSG || err1 == UBI_IO_BAD_HDR ||
542 err1 == UBI_IO_FF)
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200543 /*
544 * Both VID and EC headers are corrupted, so we can
545 * safely erase this PEB and not afraid that it will be
546 * treated as a valid PEB in case of an unclean reboot.
547 */
548 return 0;
549 }
Artem Bityutskiy5b289b52009-07-19 14:09:46 +0300550
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300551 /*
552 * The PEB contains a valid VID header, but we cannot invalidate it.
553 * Supposedly the flash media or the driver is screwed up, so return an
554 * error.
555 */
556 ubi_err("cannot invalidate PEB %d, write returned %d read returned %d",
557 pnum, err, err1);
Artem Bityutskiyef7088e2012-04-24 07:10:33 +0300558 ubi_dump_flash(ubi, pnum, 0, ubi->peb_size);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300559 return -EIO;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300560}
561
562/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400563 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
564 * @ubi: UBI device description object
565 * @pnum: physical eraseblock number to erase
566 * @torture: if this physical eraseblock has to be tortured
567 *
568 * This function synchronously erases physical eraseblock @pnum. If @torture
569 * flag is not zero, the physical eraseblock is checked by means of writing
570 * different patterns to it and reading them back. If the torturing is enabled,
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200571 * the physical eraseblock is erased more than once.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400572 *
573 * This function returns the number of erasures made in case of success, %-EIO
574 * if the erasure failed or the torturing test failed, and other negative error
575 * codes in case of other errors. Note, %-EIO means that the physical
576 * eraseblock is bad.
577 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300578int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400579{
580 int err, ret = 0;
581
582 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
583
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300584 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400585 if (err != 0)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200586 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400587
588 if (ubi->ro_mode) {
589 ubi_err("read-only mode");
590 return -EROFS;
591 }
592
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300593 if (ubi->nor_flash) {
594 err = nor_erase_prepare(ubi, pnum);
595 if (err)
596 return err;
597 }
598
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400599 if (torture) {
600 ret = torture_peb(ubi, pnum);
601 if (ret < 0)
602 return ret;
603 }
604
605 err = do_sync_erase(ubi, pnum);
606 if (err)
607 return err;
608
609 return ret + 1;
610}
611
612/**
613 * ubi_io_is_bad - check if a physical eraseblock is bad.
614 * @ubi: UBI device description object
615 * @pnum: the physical eraseblock number to check
616 *
617 * This function returns a positive number if the physical eraseblock is bad,
618 * zero if not, and a negative error code if an error occurred.
619 */
620int ubi_io_is_bad(const struct ubi_device *ubi, int pnum)
621{
622 struct mtd_info *mtd = ubi->mtd;
623
624 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
625
626 if (ubi->bad_allowed) {
627 int ret;
628
Artem Bityutskiy7086c192011-12-23 19:35:30 +0200629 ret = mtd_block_isbad(mtd, (loff_t)pnum * ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400630 if (ret < 0)
631 ubi_err("error %d while checking if PEB %d is bad",
632 ret, pnum);
633 else if (ret)
634 dbg_io("PEB %d is bad", pnum);
635 return ret;
636 }
637
638 return 0;
639}
640
641/**
642 * ubi_io_mark_bad - mark a physical eraseblock as bad.
643 * @ubi: UBI device description object
644 * @pnum: the physical eraseblock number to mark
645 *
646 * This function returns zero in case of success and a negative error code in
647 * case of failure.
648 */
649int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum)
650{
651 int err;
652 struct mtd_info *mtd = ubi->mtd;
653
654 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
655
656 if (ubi->ro_mode) {
657 ubi_err("read-only mode");
658 return -EROFS;
659 }
660
661 if (!ubi->bad_allowed)
662 return 0;
663
Artem Bityutskiy5942ddb2011-12-23 19:37:38 +0200664 err = mtd_block_markbad(mtd, (loff_t)pnum * ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400665 if (err)
666 ubi_err("cannot mark PEB %d bad, error %d", pnum, err);
667 return err;
668}
669
670/**
671 * validate_ec_hdr - validate an erase counter header.
672 * @ubi: UBI device description object
673 * @ec_hdr: the erase counter header to check
674 *
675 * This function returns zero if the erase counter header is OK, and %1 if
676 * not.
677 */
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300678static int validate_ec_hdr(const struct ubi_device *ubi,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400679 const struct ubi_ec_hdr *ec_hdr)
680{
681 long long ec;
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300682 int vid_hdr_offset, leb_start;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400683
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300684 ec = be64_to_cpu(ec_hdr->ec);
685 vid_hdr_offset = be32_to_cpu(ec_hdr->vid_hdr_offset);
686 leb_start = be32_to_cpu(ec_hdr->data_offset);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400687
688 if (ec_hdr->version != UBI_VERSION) {
689 ubi_err("node with incompatible UBI version found: "
690 "this UBI version is %d, image version is %d",
691 UBI_VERSION, (int)ec_hdr->version);
692 goto bad;
693 }
694
695 if (vid_hdr_offset != ubi->vid_hdr_offset) {
696 ubi_err("bad VID header offset %d, expected %d",
697 vid_hdr_offset, ubi->vid_hdr_offset);
698 goto bad;
699 }
700
701 if (leb_start != ubi->leb_start) {
702 ubi_err("bad data offset %d, expected %d",
703 leb_start, ubi->leb_start);
704 goto bad;
705 }
706
707 if (ec < 0 || ec > UBI_MAX_ERASECOUNTER) {
708 ubi_err("bad erase counter %lld", ec);
709 goto bad;
710 }
711
712 return 0;
713
714bad:
715 ubi_err("bad EC header");
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300716 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300717 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400718 return 1;
719}
720
721/**
722 * ubi_io_read_ec_hdr - read and check an erase counter header.
723 * @ubi: UBI device description object
724 * @pnum: physical eraseblock to read from
725 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
726 * header
727 * @verbose: be verbose if the header is corrupted or was not found
728 *
729 * This function reads erase counter header from physical eraseblock @pnum and
730 * stores it in @ec_hdr. This function also checks CRC checksum of the read
731 * erase counter header. The following codes may be returned:
732 *
733 * o %0 if the CRC checksum is correct and the header was successfully read;
734 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
735 * and corrected by the flash driver; this is harmless but may indicate that
736 * this eraseblock may become bad soon (but may be not);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300737 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300738 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
739 * a data integrity error (uncorrectable ECC error in case of NAND);
Artem Bityutskiy74d82d22010-09-03 02:11:20 +0300740 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400741 * o a negative error code in case of failure.
742 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300743int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400744 struct ubi_ec_hdr *ec_hdr, int verbose)
745{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300746 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400747 uint32_t crc, magic, hdr_crc;
748
749 dbg_io("read EC header from PEB %d", pnum);
750 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
751
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300752 read_err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
753 if (read_err) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700754 if (read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300755 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400756
757 /*
758 * We read all the data, but either a correctable bit-flip
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300759 * occurred, or MTD reported a data integrity error
760 * (uncorrectable ECC error in case of NAND). The former is
761 * harmless, the later may mean that the read data is
762 * corrupted. But we have a CRC check-sum and we will detect
763 * this. If the EC header is still OK, we just report this as
764 * there was a bit-flip, to force scrubbing.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400765 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400766 }
767
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300768 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400769 if (magic != UBI_EC_HDR_MAGIC) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700770 if (mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300771 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300772
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400773 /*
774 * The magic field is wrong. Let's check if we have read all
775 * 0xFF. If yes, this physical eraseblock is assumed to be
776 * empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400777 */
Artem Bityutskiybb00e182010-07-31 09:37:34 +0300778 if (ubi_check_pattern(ec_hdr, 0xFF, UBI_EC_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400779 /* The physical eraseblock is supposedly empty */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400780 if (verbose)
781 ubi_warn("no EC header found at PEB %d, "
782 "only 0xFF bytes", pnum);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200783 dbg_bld("no EC header found at PEB %d, "
784 "only 0xFF bytes", pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300785 if (!read_err)
786 return UBI_IO_FF;
787 else
788 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400789 }
790
791 /*
792 * This is not a valid erase counter header, and these are not
793 * 0xFF bytes. Report that the header is corrupted.
794 */
795 if (verbose) {
796 ubi_warn("bad magic number at PEB %d: %08x instead of "
797 "%08x", pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300798 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200799 }
800 dbg_bld("bad magic number at PEB %d: %08x instead of "
801 "%08x", pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300802 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400803 }
804
805 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300806 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400807
808 if (hdr_crc != crc) {
809 if (verbose) {
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300810 ubi_warn("bad EC header CRC at PEB %d, calculated "
811 "%#08x, read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300812 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200813 }
814 dbg_bld("bad EC header CRC at PEB %d, calculated "
815 "%#08x, read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300816
817 if (!read_err)
818 return UBI_IO_BAD_HDR;
819 else
820 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400821 }
822
823 /* And of course validate what has just been read from the media */
824 err = validate_ec_hdr(ubi, ec_hdr);
825 if (err) {
826 ubi_err("validation failed for PEB %d", pnum);
827 return -EINVAL;
828 }
829
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300830 /*
831 * If there was %-EBADMSG, but the header CRC is still OK, report about
832 * a bit-flip to force scrubbing on this PEB.
833 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400834 return read_err ? UBI_IO_BITFLIPS : 0;
835}
836
837/**
838 * ubi_io_write_ec_hdr - write an erase counter header.
839 * @ubi: UBI device description object
840 * @pnum: physical eraseblock to write to
841 * @ec_hdr: the erase counter header to write
842 *
843 * This function writes erase counter header described by @ec_hdr to physical
844 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
845 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
846 * field.
847 *
848 * This function returns zero in case of success and a negative error code in
849 * case of failure. If %-EIO is returned, the physical eraseblock most probably
850 * went bad.
851 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300852int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400853 struct ubi_ec_hdr *ec_hdr)
854{
855 int err;
856 uint32_t crc;
857
858 dbg_io("write EC header to PEB %d", pnum);
859 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
860
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300861 ec_hdr->magic = cpu_to_be32(UBI_EC_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400862 ec_hdr->version = UBI_VERSION;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300863 ec_hdr->vid_hdr_offset = cpu_to_be32(ubi->vid_hdr_offset);
864 ec_hdr->data_offset = cpu_to_be32(ubi->leb_start);
Adrian Hunter0c6c7fa2009-06-26 14:58:01 +0300865 ec_hdr->image_seq = cpu_to_be32(ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400866 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300867 ec_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400868
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300869 err = self_check_ec_hdr(ubi, pnum, ec_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400870 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200871 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400872
873 err = ubi_io_write(ubi, ec_hdr, pnum, 0, ubi->ec_hdr_alsize);
874 return err;
875}
876
877/**
878 * validate_vid_hdr - validate a volume identifier header.
879 * @ubi: UBI device description object
880 * @vid_hdr: the volume identifier header to check
881 *
882 * This function checks that data stored in the volume identifier header
883 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
884 */
885static int validate_vid_hdr(const struct ubi_device *ubi,
886 const struct ubi_vid_hdr *vid_hdr)
887{
888 int vol_type = vid_hdr->vol_type;
889 int copy_flag = vid_hdr->copy_flag;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300890 int vol_id = be32_to_cpu(vid_hdr->vol_id);
891 int lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400892 int compat = vid_hdr->compat;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300893 int data_size = be32_to_cpu(vid_hdr->data_size);
894 int used_ebs = be32_to_cpu(vid_hdr->used_ebs);
895 int data_pad = be32_to_cpu(vid_hdr->data_pad);
896 int data_crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400897 int usable_leb_size = ubi->leb_size - data_pad;
898
899 if (copy_flag != 0 && copy_flag != 1) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300900 ubi_err("bad copy_flag");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400901 goto bad;
902 }
903
904 if (vol_id < 0 || lnum < 0 || data_size < 0 || used_ebs < 0 ||
905 data_pad < 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300906 ubi_err("negative values");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400907 goto bad;
908 }
909
910 if (vol_id >= UBI_MAX_VOLUMES && vol_id < UBI_INTERNAL_VOL_START) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300911 ubi_err("bad vol_id");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400912 goto bad;
913 }
914
915 if (vol_id < UBI_INTERNAL_VOL_START && compat != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300916 ubi_err("bad compat");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400917 goto bad;
918 }
919
920 if (vol_id >= UBI_INTERNAL_VOL_START && compat != UBI_COMPAT_DELETE &&
921 compat != UBI_COMPAT_RO && compat != UBI_COMPAT_PRESERVE &&
922 compat != UBI_COMPAT_REJECT) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300923 ubi_err("bad compat");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400924 goto bad;
925 }
926
927 if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300928 ubi_err("bad vol_type");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400929 goto bad;
930 }
931
932 if (data_pad >= ubi->leb_size / 2) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300933 ubi_err("bad data_pad");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400934 goto bad;
935 }
936
937 if (vol_type == UBI_VID_STATIC) {
938 /*
939 * Although from high-level point of view static volumes may
940 * contain zero bytes of data, but no VID headers can contain
941 * zero at these fields, because they empty volumes do not have
942 * mapped logical eraseblocks.
943 */
944 if (used_ebs == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300945 ubi_err("zero used_ebs");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400946 goto bad;
947 }
948 if (data_size == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300949 ubi_err("zero data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400950 goto bad;
951 }
952 if (lnum < used_ebs - 1) {
953 if (data_size != usable_leb_size) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300954 ubi_err("bad data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400955 goto bad;
956 }
957 } else if (lnum == used_ebs - 1) {
958 if (data_size == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300959 ubi_err("bad data_size at last LEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400960 goto bad;
961 }
962 } else {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300963 ubi_err("too high lnum");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400964 goto bad;
965 }
966 } else {
967 if (copy_flag == 0) {
968 if (data_crc != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300969 ubi_err("non-zero data CRC");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400970 goto bad;
971 }
972 if (data_size != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300973 ubi_err("non-zero data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400974 goto bad;
975 }
976 } else {
977 if (data_size == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300978 ubi_err("zero data_size of copy");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400979 goto bad;
980 }
981 }
982 if (used_ebs != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300983 ubi_err("bad used_ebs");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400984 goto bad;
985 }
986 }
987
988 return 0;
989
990bad:
991 ubi_err("bad VID header");
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300992 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300993 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400994 return 1;
995}
996
997/**
998 * ubi_io_read_vid_hdr - read and check a volume identifier header.
999 * @ubi: UBI device description object
1000 * @pnum: physical eraseblock number to read from
1001 * @vid_hdr: &struct ubi_vid_hdr object where to store the read volume
1002 * identifier header
1003 * @verbose: be verbose if the header is corrupted or wasn't found
1004 *
1005 * This function reads the volume identifier header from physical eraseblock
1006 * @pnum and stores it in @vid_hdr. It also checks CRC checksum of the read
Artem Bityutskiy74d82d22010-09-03 02:11:20 +03001007 * volume identifier header. The error codes are the same as in
1008 * 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001009 *
Artem Bityutskiy74d82d22010-09-03 02:11:20 +03001010 * Note, the implementation of this function is also very similar to
1011 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001012 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001013int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001014 struct ubi_vid_hdr *vid_hdr, int verbose)
1015{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001016 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001017 uint32_t crc, magic, hdr_crc;
1018 void *p;
1019
1020 dbg_io("read VID header from PEB %d", pnum);
1021 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1022
1023 p = (char *)vid_hdr - ubi->vid_hdr_shift;
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001024 read_err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001025 ubi->vid_hdr_alsize);
Brian Norrisd57f40542011-09-20 18:34:25 -07001026 if (read_err && read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001027 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001028
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001029 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001030 if (magic != UBI_VID_HDR_MAGIC) {
Brian Norrisd57f40542011-09-20 18:34:25 -07001031 if (mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001032 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +03001033
Artem Bityutskiybb00e182010-07-31 09:37:34 +03001034 if (ubi_check_pattern(vid_hdr, 0xFF, UBI_VID_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001035 if (verbose)
1036 ubi_warn("no VID header found at PEB %d, "
1037 "only 0xFF bytes", pnum);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001038 dbg_bld("no VID header found at PEB %d, "
1039 "only 0xFF bytes", pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001040 if (!read_err)
1041 return UBI_IO_FF;
1042 else
1043 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001044 }
1045
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001046 if (verbose) {
1047 ubi_warn("bad magic number at PEB %d: %08x instead of "
1048 "%08x", pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001049 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001050 }
1051 dbg_bld("bad magic number at PEB %d: %08x instead of "
1052 "%08x", pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001053 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001054 }
1055
1056 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001057 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001058
1059 if (hdr_crc != crc) {
1060 if (verbose) {
1061 ubi_warn("bad CRC at PEB %d, calculated %#08x, "
1062 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001063 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001064 }
1065 dbg_bld("bad CRC at PEB %d, calculated %#08x, "
1066 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001067 if (!read_err)
1068 return UBI_IO_BAD_HDR;
1069 else
1070 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001071 }
1072
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 err = validate_vid_hdr(ubi, vid_hdr);
1074 if (err) {
1075 ubi_err("validation failed for PEB %d", pnum);
1076 return -EINVAL;
1077 }
1078
1079 return read_err ? UBI_IO_BITFLIPS : 0;
1080}
1081
1082/**
1083 * ubi_io_write_vid_hdr - write a volume identifier header.
1084 * @ubi: UBI device description object
1085 * @pnum: the physical eraseblock number to write to
1086 * @vid_hdr: the volume identifier header to write
1087 *
1088 * This function writes the volume identifier header described by @vid_hdr to
1089 * physical eraseblock @pnum. This function automatically fills the
1090 * @vid_hdr->magic and the @vid_hdr->version fields, as well as calculates
1091 * header CRC checksum and stores it at vid_hdr->hdr_crc.
1092 *
1093 * This function returns zero in case of success and a negative error code in
1094 * case of failure. If %-EIO is returned, the physical eraseblock probably went
1095 * bad.
1096 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001097int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001098 struct ubi_vid_hdr *vid_hdr)
1099{
1100 int err;
1101 uint32_t crc;
1102 void *p;
1103
1104 dbg_io("write VID header to PEB %d", pnum);
1105 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1106
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001107 err = self_check_peb_ec_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001108 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001109 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001110
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001111 vid_hdr->magic = cpu_to_be32(UBI_VID_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001112 vid_hdr->version = UBI_VERSION;
1113 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001114 vid_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001115
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001116 err = self_check_vid_hdr(ubi, pnum, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001117 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001118 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001119
1120 p = (char *)vid_hdr - ubi->vid_hdr_shift;
1121 err = ubi_io_write(ubi, p, pnum, ubi->vid_hdr_aloffset,
1122 ubi->vid_hdr_alsize);
1123 return err;
1124}
1125
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001126/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001127 * self_check_not_bad - ensure that a physical eraseblock is not bad.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001128 * @ubi: UBI device description object
1129 * @pnum: physical eraseblock number to check
1130 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001131 * This function returns zero if the physical eraseblock is good, %-EINVAL if
1132 * it is bad and a negative error code if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001133 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001134static int self_check_not_bad(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001135{
1136 int err;
1137
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001138 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001139 return 0;
1140
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001141 err = ubi_io_is_bad(ubi, pnum);
1142 if (!err)
1143 return err;
1144
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001145 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001146 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001147 return err > 0 ? -EINVAL : err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001148}
1149
1150/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001151 * self_check_ec_hdr - check if an erase counter header is all right.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001152 * @ubi: UBI device description object
1153 * @pnum: physical eraseblock number the erase counter header belongs to
1154 * @ec_hdr: the erase counter header to check
1155 *
1156 * This function returns zero if the erase counter header contains valid
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001157 * values, and %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001158 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001159static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
1160 const struct ubi_ec_hdr *ec_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001161{
1162 int err;
1163 uint32_t magic;
1164
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001165 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001166 return 0;
1167
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001168 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001169 if (magic != UBI_EC_HDR_MAGIC) {
1170 ubi_err("bad magic %#08x, must be %#08x",
1171 magic, UBI_EC_HDR_MAGIC);
1172 goto fail;
1173 }
1174
1175 err = validate_ec_hdr(ubi, ec_hdr);
1176 if (err) {
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001177 ubi_err("self-check failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001178 goto fail;
1179 }
1180
1181 return 0;
1182
1183fail:
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001184 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001185 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001186 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001187}
1188
1189/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001190 * self_check_peb_ec_hdr - check erase counter header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001191 * @ubi: UBI device description object
1192 * @pnum: the physical eraseblock number to check
1193 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001194 * This function returns zero if the erase counter header is all right and and
1195 * a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001196 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001197static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001198{
1199 int err;
1200 uint32_t crc, hdr_crc;
1201 struct ubi_ec_hdr *ec_hdr;
1202
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001203 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001204 return 0;
1205
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001206 ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001207 if (!ec_hdr)
1208 return -ENOMEM;
1209
1210 err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
Brian Norrisd57f40542011-09-20 18:34:25 -07001211 if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001212 goto exit;
1213
1214 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001215 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001216 if (hdr_crc != crc) {
1217 ubi_err("bad CRC, calculated %#08x, read %#08x", crc, hdr_crc);
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001218 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001219 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001220 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001221 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001222 goto exit;
1223 }
1224
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001225 err = self_check_ec_hdr(ubi, pnum, ec_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001226
1227exit:
1228 kfree(ec_hdr);
1229 return err;
1230}
1231
1232/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001233 * self_check_vid_hdr - check that a volume identifier header is all right.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001234 * @ubi: UBI device description object
1235 * @pnum: physical eraseblock number the volume identifier header belongs to
1236 * @vid_hdr: the volume identifier header to check
1237 *
1238 * This function returns zero if the volume identifier header is all right, and
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001239 * %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001240 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001241static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
1242 const struct ubi_vid_hdr *vid_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001243{
1244 int err;
1245 uint32_t magic;
1246
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001247 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001248 return 0;
1249
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001250 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001251 if (magic != UBI_VID_HDR_MAGIC) {
1252 ubi_err("bad VID header magic %#08x at PEB %d, must be %#08x",
1253 magic, pnum, UBI_VID_HDR_MAGIC);
1254 goto fail;
1255 }
1256
1257 err = validate_vid_hdr(ubi, vid_hdr);
1258 if (err) {
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001259 ubi_err("self-check failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001260 goto fail;
1261 }
1262
1263 return err;
1264
1265fail:
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001266 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001267 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001268 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001269 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001270
1271}
1272
1273/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001274 * self_check_peb_vid_hdr - check volume identifier header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001275 * @ubi: UBI device description object
1276 * @pnum: the physical eraseblock number to check
1277 *
1278 * This function returns zero if the volume identifier header is all right,
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001279 * and a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001280 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001281static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001282{
1283 int err;
1284 uint32_t crc, hdr_crc;
1285 struct ubi_vid_hdr *vid_hdr;
1286 void *p;
1287
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001288 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001289 return 0;
1290
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001291 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001292 if (!vid_hdr)
1293 return -ENOMEM;
1294
1295 p = (char *)vid_hdr - ubi->vid_hdr_shift;
1296 err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
1297 ubi->vid_hdr_alsize);
Brian Norrisd57f40542011-09-20 18:34:25 -07001298 if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001299 goto exit;
1300
1301 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001302 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001303 if (hdr_crc != crc) {
1304 ubi_err("bad VID header CRC at PEB %d, calculated %#08x, "
1305 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001306 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001307 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001308 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001309 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001310 goto exit;
1311 }
1312
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001313 err = self_check_vid_hdr(ubi, pnum, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001314
1315exit:
1316 ubi_free_vid_hdr(ubi, vid_hdr);
1317 return err;
1318}
1319
1320/**
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001321 * self_check_write - make sure write succeeded.
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001322 * @ubi: UBI device description object
1323 * @buf: buffer with data which were written
1324 * @pnum: physical eraseblock number the data were written to
1325 * @offset: offset within the physical eraseblock the data were written to
1326 * @len: how many bytes were written
1327 *
1328 * This functions reads data which were recently written and compares it with
1329 * the original data buffer - the data have to match. Returns zero if the data
1330 * match and a negative error code if not or in case of failure.
1331 */
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001332static int self_check_write(struct ubi_device *ubi, const void *buf, int pnum,
1333 int offset, int len)
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001334{
1335 int err, i;
Artem Bityutskiy7950d022010-11-19 17:05:36 +02001336 size_t read;
Artem Bityutskiya7586742011-03-14 17:06:52 +02001337 void *buf1;
Artem Bityutskiy7950d022010-11-19 17:05:36 +02001338 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001339
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001340 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001341 return 0;
1342
Artem Bityutskiy3d46b312011-03-24 16:09:56 +02001343 buf1 = __vmalloc(len, GFP_NOFS, PAGE_KERNEL);
Artem Bityutskiya7586742011-03-14 17:06:52 +02001344 if (!buf1) {
1345 ubi_err("cannot allocate memory to check writes");
1346 return 0;
1347 }
1348
Artem Bityutskiy329ad392011-12-23 17:30:16 +02001349 err = mtd_read(ubi->mtd, addr, len, &read, buf1);
Brian Norrisd57f40542011-09-20 18:34:25 -07001350 if (err && !mtd_is_bitflip(err))
Artem Bityutskiya7586742011-03-14 17:06:52 +02001351 goto out_free;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001352
1353 for (i = 0; i < len; i++) {
1354 uint8_t c = ((uint8_t *)buf)[i];
Artem Bityutskiya7586742011-03-14 17:06:52 +02001355 uint8_t c1 = ((uint8_t *)buf1)[i];
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001356 int dump_len;
1357
1358 if (c == c1)
1359 continue;
1360
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001361 ubi_err("self-check failed for PEB %d:%d, len %d",
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001362 pnum, offset, len);
1363 ubi_msg("data differ at position %d", i);
1364 dump_len = max_t(int, 128, len - i);
1365 ubi_msg("hex dump of the original buffer from %d to %d",
1366 i, i + dump_len);
1367 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
1368 buf + i, dump_len, 1);
1369 ubi_msg("hex dump of the read buffer from %d to %d",
1370 i, i + dump_len);
1371 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
Artem Bityutskiya7586742011-03-14 17:06:52 +02001372 buf1 + i, dump_len, 1);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001373 dump_stack();
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001374 err = -EINVAL;
Artem Bityutskiya7586742011-03-14 17:06:52 +02001375 goto out_free;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001376 }
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001377
Artem Bityutskiya7586742011-03-14 17:06:52 +02001378 vfree(buf1);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001379 return 0;
1380
Artem Bityutskiya7586742011-03-14 17:06:52 +02001381out_free:
1382 vfree(buf1);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001383 return err;
1384}
1385
1386/**
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001387 * ubi_self_check_all_ff - check that a region of flash is empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001388 * @ubi: UBI device description object
1389 * @pnum: the physical eraseblock number to check
1390 * @offset: the starting offset within the physical eraseblock to check
1391 * @len: the length of the region to check
1392 *
1393 * This function returns zero if only 0xFF bytes are present at offset
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001394 * @offset of the physical eraseblock @pnum, and a negative error code if not
1395 * or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001396 */
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001397int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001398{
1399 size_t read;
1400 int err;
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001401 void *buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001402 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
1403
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001404 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001405 return 0;
1406
Artem Bityutskiy3d46b312011-03-24 16:09:56 +02001407 buf = __vmalloc(len, GFP_NOFS, PAGE_KERNEL);
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001408 if (!buf) {
1409 ubi_err("cannot allocate memory to check for 0xFFs");
1410 return 0;
1411 }
1412
Artem Bityutskiy329ad392011-12-23 17:30:16 +02001413 err = mtd_read(ubi->mtd, addr, len, &read, buf);
Brian Norrisd57f40542011-09-20 18:34:25 -07001414 if (err && !mtd_is_bitflip(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001415 ubi_err("error %d while reading %d bytes from PEB %d:%d, "
1416 "read %zd bytes", err, len, pnum, offset, read);
1417 goto error;
1418 }
1419
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001420 err = ubi_check_pattern(buf, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001421 if (err == 0) {
1422 ubi_err("flash region at PEB %d:%d, length %d does not "
1423 "contain all 0xFF bytes", pnum, offset, len);
1424 goto fail;
1425 }
1426
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001427 vfree(buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001428 return 0;
1429
1430fail:
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001431 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiyc8566352008-07-16 17:40:22 +03001432 ubi_msg("hex dump of the %d-%d region", offset, offset + len);
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001433 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001434 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001435error:
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001436 dump_stack();
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001437 vfree(buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001438 return err;
1439}