blob: 8a83962a940b6aa9f26f1ebe7fc9035f27c3facf [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 B. Bityutskiy801c1352006-06-27 12:22:22 +0400101
102/**
103 * ubi_io_read - read data from a physical eraseblock.
104 * @ubi: UBI device description object
105 * @buf: buffer where to store the read data
106 * @pnum: physical eraseblock number to read from
107 * @offset: offset within the physical eraseblock from where to read
108 * @len: how many bytes to read
109 *
110 * This function reads data from offset @offset of physical eraseblock @pnum
111 * and stores the read data in the @buf buffer. The following return codes are
112 * possible:
113 *
114 * o %0 if all the requested data were successfully read;
115 * o %UBI_IO_BITFLIPS if all the requested data were successfully read, but
116 * correctable bit-flips were detected; this is harmless but may indicate
117 * that this eraseblock may become bad soon (but do not have to);
Artem Bityutskiy63b6c1e2007-07-17 15:04:20 +0300118 * o %-EBADMSG if the MTD subsystem reported about data integrity problems, for
119 * example it can be an ECC error in case of NAND; this most probably means
120 * that the data is corrupted;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400121 * o %-EIO if some I/O error occurred;
122 * o other negative error codes in case of other errors.
123 */
124int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
125 int len)
126{
127 int err, retries = 0;
128 size_t read;
129 loff_t addr;
130
131 dbg_io("read %d bytes from PEB %d:%d", len, pnum, offset);
132
133 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
134 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
135 ubi_assert(len > 0);
136
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300137 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400138 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200139 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400140
Artem Bityutskiy276832d2010-11-13 15:08:29 +0200141 /*
142 * Deliberately corrupt the buffer to improve robustness. Indeed, if we
143 * do not do this, the following may happen:
144 * 1. The buffer contains data from previous operation, e.g., read from
145 * another PEB previously. The data looks like expected, e.g., if we
146 * just do not read anything and return - the caller would not
147 * notice this. E.g., if we are reading a VID header, the buffer may
148 * contain a valid VID header from another PEB.
149 * 2. The driver is buggy and returns us success or -EBADMSG or
150 * -EUCLEAN, but it does not actually put any data to the buffer.
151 *
152 * This may confuse UBI or upper layers - they may think the buffer
153 * contains valid data while in fact it is just old data. This is
154 * especially possible because UBI (and UBIFS) relies on CRC, and
155 * treats data as correct even in case of ECC errors if the CRC is
156 * correct.
157 *
158 * Try to prevent this situation by changing the first byte of the
159 * buffer.
160 */
161 *((uint8_t *)buf) ^= 0xFF;
162
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400163 addr = (loff_t)pnum * ubi->peb_size + offset;
164retry:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200165 err = mtd_read(ubi->mtd, addr, len, &read, buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400166 if (err) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700167 const char *errstr = mtd_is_eccerr(err) ? " (ECC error)" : "";
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300168
Brian Norrisd57f40542011-09-20 18:34:25 -0700169 if (mtd_is_bitflip(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400170 /*
171 * -EUCLEAN is reported if there was a bit-flip which
172 * was corrected, so this is harmless.
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300173 *
174 * We do not report about it here unless debugging is
175 * enabled. A corresponding message will be printed
176 * later, when it is has been scrubbed.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400177 */
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300178 dbg_msg("fixable bit-flip detected at PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400179 ubi_assert(len == read);
180 return UBI_IO_BITFLIPS;
181 }
182
Artem Bityutskiya87f29c2010-10-31 18:55:30 +0200183 if (retries++ < UBI_IO_RETRIES) {
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300184 ubi_warn("error %d%s while reading %d bytes from PEB "
185 "%d:%d, read only %zd bytes, retry",
186 err, errstr, len, pnum, offset, read);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400187 yield();
188 goto retry;
189 }
190
Artem Bityutskiyf5d5b1f2010-06-14 08:15:39 +0300191 ubi_err("error %d%s while reading %d bytes from PEB %d:%d, "
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300192 "read %zd bytes", err, errstr, len, pnum, offset, read);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300193 dump_stack();
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300194
195 /*
196 * The driver should never return -EBADMSG if it failed to read
197 * all the requested data. But some buggy drivers might do
198 * this, so we change it to -EIO.
199 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700200 if (read != len && mtd_is_eccerr(err)) {
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300201 ubi_assert(0);
202 err = -EIO;
203 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400204 } else {
205 ubi_assert(len == read);
206
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300207 if (ubi_dbg_is_bitflip(ubi)) {
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300208 dbg_gen("bit-flip (emulated)");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400209 err = UBI_IO_BITFLIPS;
210 }
211 }
212
213 return err;
214}
215
216/**
217 * ubi_io_write - write data to a physical eraseblock.
218 * @ubi: UBI device description object
219 * @buf: buffer with the data to write
220 * @pnum: physical eraseblock number to write to
221 * @offset: offset within the physical eraseblock where to write
222 * @len: how many bytes to write
223 *
224 * This function writes @len bytes of data from buffer @buf to offset @offset
225 * of physical eraseblock @pnum. If all the data were successfully written,
226 * zero is returned. If an error occurred, this function returns a negative
227 * error code. If %-EIO is returned, the physical eraseblock most probably went
228 * bad.
229 *
230 * Note, in case of an error, it is possible that something was still written
231 * to the flash media, but may be some garbage.
232 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300233int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
234 int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400235{
236 int err;
237 size_t written;
238 loff_t addr;
239
240 dbg_io("write %d bytes to PEB %d:%d", len, pnum, offset);
241
242 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
243 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
244 ubi_assert(offset % ubi->hdrs_min_io_size == 0);
245 ubi_assert(len > 0 && len % ubi->hdrs_min_io_size == 0);
246
247 if (ubi->ro_mode) {
248 ubi_err("read-only mode");
249 return -EROFS;
250 }
251
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300252 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400253 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200254 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400255
256 /* The area we are writing to has to contain all 0xFF bytes */
Artem Bityutskiy40a71a82009-06-28 19:16:55 +0300257 err = ubi_dbg_check_all_ff(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400258 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200259 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400260
261 if (offset >= ubi->leb_start) {
262 /*
263 * We write to the data area of the physical eraseblock. Make
264 * sure it has valid EC and VID headers.
265 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300266 err = self_check_peb_ec_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400267 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200268 return err;
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300269 err = self_check_peb_vid_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400270 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200271 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400272 }
273
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300274 if (ubi_dbg_is_write_failure(ubi)) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300275 ubi_err("cannot write %d bytes to PEB %d:%d "
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400276 "(emulated)", len, pnum, offset);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300277 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400278 return -EIO;
279 }
280
281 addr = (loff_t)pnum * ubi->peb_size + offset;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200282 err = mtd_write(ubi->mtd, addr, len, &written, buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400283 if (err) {
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300284 ubi_err("error %d while writing %d bytes to PEB %d:%d, written "
285 "%zd bytes", err, len, pnum, offset, written);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300286 dump_stack();
Artem Bityutskiyef7088e2012-04-24 07:10:33 +0300287 ubi_dump_flash(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400288 } else
289 ubi_assert(written == len);
290
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200291 if (!err) {
292 err = ubi_dbg_check_write(ubi, buf, pnum, offset, len);
293 if (err)
294 return err;
295
296 /*
297 * Since we always write sequentially, the rest of the PEB has
298 * to contain only 0xFF bytes.
299 */
300 offset += len;
301 len = ubi->peb_size - offset;
302 if (len)
303 err = ubi_dbg_check_all_ff(ubi, pnum, offset, len);
304 }
305
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400306 return err;
307}
308
309/**
310 * erase_callback - MTD erasure call-back.
311 * @ei: MTD erase information object.
312 *
313 * Note, even though MTD erase interface is asynchronous, all the current
314 * implementations are synchronous anyway.
315 */
316static void erase_callback(struct erase_info *ei)
317{
318 wake_up_interruptible((wait_queue_head_t *)ei->priv);
319}
320
321/**
322 * do_sync_erase - synchronously erase a physical eraseblock.
323 * @ubi: UBI device description object
324 * @pnum: the physical eraseblock number to erase
325 *
326 * This function synchronously erases physical eraseblock @pnum and returns
327 * zero in case of success and a negative error code in case of failure. If
328 * %-EIO is returned, the physical eraseblock most probably went bad.
329 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300330static int do_sync_erase(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400331{
332 int err, retries = 0;
333 struct erase_info ei;
334 wait_queue_head_t wq;
335
336 dbg_io("erase PEB %d", pnum);
Artem Bityutskiy3efe5092011-03-18 18:11:42 +0200337 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
338
339 if (ubi->ro_mode) {
340 ubi_err("read-only mode");
341 return -EROFS;
342 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400343
344retry:
345 init_waitqueue_head(&wq);
346 memset(&ei, 0, sizeof(struct erase_info));
347
348 ei.mtd = ubi->mtd;
Brijesh Singh2f176f72007-07-05 15:07:35 +0530349 ei.addr = (loff_t)pnum * ubi->peb_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400350 ei.len = ubi->peb_size;
351 ei.callback = erase_callback;
352 ei.priv = (unsigned long)&wq;
353
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200354 err = mtd_erase(ubi->mtd, &ei);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400355 if (err) {
356 if (retries++ < UBI_IO_RETRIES) {
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300357 ubi_warn("error %d while erasing PEB %d, retry",
358 err, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400359 yield();
360 goto retry;
361 }
362 ubi_err("cannot erase PEB %d, error %d", pnum, err);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300363 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400364 return err;
365 }
366
367 err = wait_event_interruptible(wq, ei.state == MTD_ERASE_DONE ||
368 ei.state == MTD_ERASE_FAILED);
369 if (err) {
370 ubi_err("interrupted PEB %d erasure", pnum);
371 return -EINTR;
372 }
373
374 if (ei.state == MTD_ERASE_FAILED) {
375 if (retries++ < UBI_IO_RETRIES) {
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300376 ubi_warn("error while erasing PEB %d, retry", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400377 yield();
378 goto retry;
379 }
380 ubi_err("cannot erase PEB %d", pnum);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300381 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400382 return -EIO;
383 }
384
Artem Bityutskiy40a71a82009-06-28 19:16:55 +0300385 err = ubi_dbg_check_all_ff(ubi, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400386 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200387 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400388
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300389 if (ubi_dbg_is_erase_failure(ubi)) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300390 ubi_err("cannot erase PEB %d (emulated)", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400391 return -EIO;
392 }
393
394 return 0;
395}
396
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400397/* Patterns to write to a physical eraseblock when torturing it */
398static uint8_t patterns[] = {0xa5, 0x5a, 0x0};
399
400/**
401 * torture_peb - test a supposedly bad physical eraseblock.
402 * @ubi: UBI device description object
403 * @pnum: the physical eraseblock number to test
404 *
405 * This function returns %-EIO if the physical eraseblock did not pass the
406 * test, a positive number of erase operations done if the test was
407 * successfully passed, and other negative error codes in case of other errors.
408 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300409static int torture_peb(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400410{
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400411 int err, i, patt_count;
412
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300413 ubi_msg("run torture test for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400414 patt_count = ARRAY_SIZE(patterns);
415 ubi_assert(patt_count > 0);
416
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300417 mutex_lock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400418 for (i = 0; i < patt_count; i++) {
419 err = do_sync_erase(ubi, pnum);
420 if (err)
421 goto out;
422
423 /* Make sure the PEB contains only 0xFF bytes */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200424 err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400425 if (err)
426 goto out;
427
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200428 err = ubi_check_pattern(ubi->peb_buf, 0xFF, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400429 if (err == 0) {
430 ubi_err("erased PEB %d, but a non-0xFF byte found",
431 pnum);
432 err = -EIO;
433 goto out;
434 }
435
436 /* Write a pattern and check it */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200437 memset(ubi->peb_buf, patterns[i], ubi->peb_size);
438 err = ubi_io_write(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400439 if (err)
440 goto out;
441
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200442 memset(ubi->peb_buf, ~patterns[i], ubi->peb_size);
443 err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400444 if (err)
445 goto out;
446
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200447 err = ubi_check_pattern(ubi->peb_buf, patterns[i],
Artem Bityutskiybb00e182010-07-31 09:37:34 +0300448 ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400449 if (err == 0) {
450 ubi_err("pattern %x checking failed for PEB %d",
451 patterns[i], pnum);
452 err = -EIO;
453 goto out;
454 }
455 }
456
457 err = patt_count;
Artem Bityutskiy14264142011-04-14 11:36:31 +0300458 ubi_msg("PEB %d passed torture test, do not mark it as bad", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400459
460out:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300461 mutex_unlock(&ubi->buf_mutex);
Brian Norrisd57f40542011-09-20 18:34:25 -0700462 if (err == UBI_IO_BITFLIPS || mtd_is_eccerr(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400463 /*
464 * If a bit-flip or data integrity error was detected, the test
465 * has not passed because it happened on a freshly erased
466 * physical eraseblock which means something is wrong with it.
467 */
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300468 ubi_err("read problems on freshly erased PEB %d, must be bad",
469 pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400470 err = -EIO;
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300471 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400472 return err;
473}
474
475/**
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300476 * nor_erase_prepare - prepare a NOR flash PEB for erasure.
477 * @ubi: UBI device description object
478 * @pnum: physical eraseblock number to prepare
479 *
480 * NOR flash, or at least some of them, have peculiar embedded PEB erasure
481 * algorithm: the PEB is first filled with zeroes, then it is erased. And
482 * filling with zeroes starts from the end of the PEB. This was observed with
483 * Spansion S29GL512N NOR flash.
484 *
485 * This means that in case of a power cut we may end up with intact data at the
486 * beginning of the PEB, and all zeroes at the end of PEB. In other words, the
487 * EC and VID headers are OK, but a large chunk of data at the end of PEB is
488 * zeroed. This makes UBI mistakenly treat this PEB as used and associate it
489 * with an LEB, which leads to subsequent failures (e.g., UBIFS fails).
490 *
491 * This function is called before erasing NOR PEBs and it zeroes out EC and VID
492 * magic numbers in order to invalidate them and prevent the failures. Returns
493 * zero in case of success and a negative error code in case of failure.
494 */
495static int nor_erase_prepare(struct ubi_device *ubi, int pnum)
496{
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300497 int err, err1;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300498 size_t written;
499 loff_t addr;
500 uint32_t data = 0;
Artem Bityutskiy2fff5702010-12-03 15:32:21 +0200501 /*
502 * Note, we cannot generally define VID header buffers on stack,
503 * because of the way we deal with these buffers (see the header
504 * comment in this file). But we know this is a NOR-specific piece of
505 * code, so we can do this. But yes, this is error-prone and we should
506 * (pre-)allocate VID header buffer instead.
507 */
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300508 struct ubi_vid_hdr vid_hdr;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300509
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200510 /*
511 * It is important to first invalidate the EC header, and then the VID
512 * header. Otherwise a power cut may lead to valid EC header and
513 * invalid VID header, in which case UBI will treat this PEB as
514 * corrupted and will try to preserve it, and print scary warnings (see
515 * the header comment in scan.c for more information).
516 */
517 addr = (loff_t)pnum * ubi->peb_size;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200518 err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300519 if (!err) {
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200520 addr += ubi->vid_hdr_aloffset;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200521 err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300522 if (!err)
523 return 0;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300524 }
525
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300526 /*
527 * We failed to write to the media. This was observed with Spansion
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200528 * S29GL512N NOR flash. Most probably the previously eraseblock erasure
529 * was interrupted at a very inappropriate moment, so it became
530 * unwritable. In this case we probably anyway have garbage in this
531 * PEB.
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300532 */
533 err1 = ubi_io_read_vid_hdr(ubi, pnum, &vid_hdr, 0);
Holger Brunckd4c63812011-01-25 13:04:11 +0200534 if (err1 == UBI_IO_BAD_HDR_EBADMSG || err1 == UBI_IO_BAD_HDR ||
535 err1 == UBI_IO_FF) {
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200536 struct ubi_ec_hdr ec_hdr;
537
538 err1 = ubi_io_read_ec_hdr(ubi, pnum, &ec_hdr, 0);
Holger Brunckd4c63812011-01-25 13:04:11 +0200539 if (err1 == UBI_IO_BAD_HDR_EBADMSG || err1 == UBI_IO_BAD_HDR ||
540 err1 == UBI_IO_FF)
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200541 /*
542 * Both VID and EC headers are corrupted, so we can
543 * safely erase this PEB and not afraid that it will be
544 * treated as a valid PEB in case of an unclean reboot.
545 */
546 return 0;
547 }
Artem Bityutskiy5b289b52009-07-19 14:09:46 +0300548
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300549 /*
550 * The PEB contains a valid VID header, but we cannot invalidate it.
551 * Supposedly the flash media or the driver is screwed up, so return an
552 * error.
553 */
554 ubi_err("cannot invalidate PEB %d, write returned %d read returned %d",
555 pnum, err, err1);
Artem Bityutskiyef7088e2012-04-24 07:10:33 +0300556 ubi_dump_flash(ubi, pnum, 0, ubi->peb_size);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300557 return -EIO;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300558}
559
560/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400561 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
562 * @ubi: UBI device description object
563 * @pnum: physical eraseblock number to erase
564 * @torture: if this physical eraseblock has to be tortured
565 *
566 * This function synchronously erases physical eraseblock @pnum. If @torture
567 * flag is not zero, the physical eraseblock is checked by means of writing
568 * different patterns to it and reading them back. If the torturing is enabled,
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200569 * the physical eraseblock is erased more than once.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400570 *
571 * This function returns the number of erasures made in case of success, %-EIO
572 * if the erasure failed or the torturing test failed, and other negative error
573 * codes in case of other errors. Note, %-EIO means that the physical
574 * eraseblock is bad.
575 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300576int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400577{
578 int err, ret = 0;
579
580 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
581
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300582 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400583 if (err != 0)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200584 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400585
586 if (ubi->ro_mode) {
587 ubi_err("read-only mode");
588 return -EROFS;
589 }
590
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300591 if (ubi->nor_flash) {
592 err = nor_erase_prepare(ubi, pnum);
593 if (err)
594 return err;
595 }
596
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400597 if (torture) {
598 ret = torture_peb(ubi, pnum);
599 if (ret < 0)
600 return ret;
601 }
602
603 err = do_sync_erase(ubi, pnum);
604 if (err)
605 return err;
606
607 return ret + 1;
608}
609
610/**
611 * ubi_io_is_bad - check if a physical eraseblock is bad.
612 * @ubi: UBI device description object
613 * @pnum: the physical eraseblock number to check
614 *
615 * This function returns a positive number if the physical eraseblock is bad,
616 * zero if not, and a negative error code if an error occurred.
617 */
618int ubi_io_is_bad(const struct ubi_device *ubi, int pnum)
619{
620 struct mtd_info *mtd = ubi->mtd;
621
622 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
623
624 if (ubi->bad_allowed) {
625 int ret;
626
Artem Bityutskiy7086c192011-12-23 19:35:30 +0200627 ret = mtd_block_isbad(mtd, (loff_t)pnum * ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400628 if (ret < 0)
629 ubi_err("error %d while checking if PEB %d is bad",
630 ret, pnum);
631 else if (ret)
632 dbg_io("PEB %d is bad", pnum);
633 return ret;
634 }
635
636 return 0;
637}
638
639/**
640 * ubi_io_mark_bad - mark a physical eraseblock as bad.
641 * @ubi: UBI device description object
642 * @pnum: the physical eraseblock number to mark
643 *
644 * This function returns zero in case of success and a negative error code in
645 * case of failure.
646 */
647int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum)
648{
649 int err;
650 struct mtd_info *mtd = ubi->mtd;
651
652 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
653
654 if (ubi->ro_mode) {
655 ubi_err("read-only mode");
656 return -EROFS;
657 }
658
659 if (!ubi->bad_allowed)
660 return 0;
661
Artem Bityutskiy5942ddb2011-12-23 19:37:38 +0200662 err = mtd_block_markbad(mtd, (loff_t)pnum * ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400663 if (err)
664 ubi_err("cannot mark PEB %d bad, error %d", pnum, err);
665 return err;
666}
667
668/**
669 * validate_ec_hdr - validate an erase counter header.
670 * @ubi: UBI device description object
671 * @ec_hdr: the erase counter header to check
672 *
673 * This function returns zero if the erase counter header is OK, and %1 if
674 * not.
675 */
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300676static int validate_ec_hdr(const struct ubi_device *ubi,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400677 const struct ubi_ec_hdr *ec_hdr)
678{
679 long long ec;
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300680 int vid_hdr_offset, leb_start;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400681
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300682 ec = be64_to_cpu(ec_hdr->ec);
683 vid_hdr_offset = be32_to_cpu(ec_hdr->vid_hdr_offset);
684 leb_start = be32_to_cpu(ec_hdr->data_offset);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400685
686 if (ec_hdr->version != UBI_VERSION) {
687 ubi_err("node with incompatible UBI version found: "
688 "this UBI version is %d, image version is %d",
689 UBI_VERSION, (int)ec_hdr->version);
690 goto bad;
691 }
692
693 if (vid_hdr_offset != ubi->vid_hdr_offset) {
694 ubi_err("bad VID header offset %d, expected %d",
695 vid_hdr_offset, ubi->vid_hdr_offset);
696 goto bad;
697 }
698
699 if (leb_start != ubi->leb_start) {
700 ubi_err("bad data offset %d, expected %d",
701 leb_start, ubi->leb_start);
702 goto bad;
703 }
704
705 if (ec < 0 || ec > UBI_MAX_ERASECOUNTER) {
706 ubi_err("bad erase counter %lld", ec);
707 goto bad;
708 }
709
710 return 0;
711
712bad:
713 ubi_err("bad EC header");
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300714 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300715 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400716 return 1;
717}
718
719/**
720 * ubi_io_read_ec_hdr - read and check an erase counter header.
721 * @ubi: UBI device description object
722 * @pnum: physical eraseblock to read from
723 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
724 * header
725 * @verbose: be verbose if the header is corrupted or was not found
726 *
727 * This function reads erase counter header from physical eraseblock @pnum and
728 * stores it in @ec_hdr. This function also checks CRC checksum of the read
729 * erase counter header. The following codes may be returned:
730 *
731 * o %0 if the CRC checksum is correct and the header was successfully read;
732 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
733 * and corrected by the flash driver; this is harmless but may indicate that
734 * this eraseblock may become bad soon (but may be not);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300735 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300736 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
737 * a data integrity error (uncorrectable ECC error in case of NAND);
Artem Bityutskiy74d82d22010-09-03 02:11:20 +0300738 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400739 * o a negative error code in case of failure.
740 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300741int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400742 struct ubi_ec_hdr *ec_hdr, int verbose)
743{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300744 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400745 uint32_t crc, magic, hdr_crc;
746
747 dbg_io("read EC header from PEB %d", pnum);
748 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
749
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300750 read_err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
751 if (read_err) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700752 if (read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300753 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400754
755 /*
756 * We read all the data, but either a correctable bit-flip
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300757 * occurred, or MTD reported a data integrity error
758 * (uncorrectable ECC error in case of NAND). The former is
759 * harmless, the later may mean that the read data is
760 * corrupted. But we have a CRC check-sum and we will detect
761 * this. If the EC header is still OK, we just report this as
762 * there was a bit-flip, to force scrubbing.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400763 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400764 }
765
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300766 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400767 if (magic != UBI_EC_HDR_MAGIC) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700768 if (mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300769 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300770
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400771 /*
772 * The magic field is wrong. Let's check if we have read all
773 * 0xFF. If yes, this physical eraseblock is assumed to be
774 * empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400775 */
Artem Bityutskiybb00e182010-07-31 09:37:34 +0300776 if (ubi_check_pattern(ec_hdr, 0xFF, UBI_EC_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400777 /* The physical eraseblock is supposedly empty */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400778 if (verbose)
779 ubi_warn("no EC header found at PEB %d, "
780 "only 0xFF bytes", pnum);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200781 dbg_bld("no EC header found at PEB %d, "
782 "only 0xFF bytes", pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300783 if (!read_err)
784 return UBI_IO_FF;
785 else
786 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400787 }
788
789 /*
790 * This is not a valid erase counter header, and these are not
791 * 0xFF bytes. Report that the header is corrupted.
792 */
793 if (verbose) {
794 ubi_warn("bad magic number at PEB %d: %08x instead of "
795 "%08x", pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300796 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200797 }
798 dbg_bld("bad magic number at PEB %d: %08x instead of "
799 "%08x", pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300800 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400801 }
802
803 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300804 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400805
806 if (hdr_crc != crc) {
807 if (verbose) {
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300808 ubi_warn("bad EC header CRC at PEB %d, calculated "
809 "%#08x, read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300810 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200811 }
812 dbg_bld("bad EC header CRC at PEB %d, calculated "
813 "%#08x, read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300814
815 if (!read_err)
816 return UBI_IO_BAD_HDR;
817 else
818 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400819 }
820
821 /* And of course validate what has just been read from the media */
822 err = validate_ec_hdr(ubi, ec_hdr);
823 if (err) {
824 ubi_err("validation failed for PEB %d", pnum);
825 return -EINVAL;
826 }
827
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300828 /*
829 * If there was %-EBADMSG, but the header CRC is still OK, report about
830 * a bit-flip to force scrubbing on this PEB.
831 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400832 return read_err ? UBI_IO_BITFLIPS : 0;
833}
834
835/**
836 * ubi_io_write_ec_hdr - write an erase counter header.
837 * @ubi: UBI device description object
838 * @pnum: physical eraseblock to write to
839 * @ec_hdr: the erase counter header to write
840 *
841 * This function writes erase counter header described by @ec_hdr to physical
842 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
843 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
844 * field.
845 *
846 * This function returns zero in case of success and a negative error code in
847 * case of failure. If %-EIO is returned, the physical eraseblock most probably
848 * went bad.
849 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300850int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400851 struct ubi_ec_hdr *ec_hdr)
852{
853 int err;
854 uint32_t crc;
855
856 dbg_io("write EC header to PEB %d", pnum);
857 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
858
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300859 ec_hdr->magic = cpu_to_be32(UBI_EC_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400860 ec_hdr->version = UBI_VERSION;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300861 ec_hdr->vid_hdr_offset = cpu_to_be32(ubi->vid_hdr_offset);
862 ec_hdr->data_offset = cpu_to_be32(ubi->leb_start);
Adrian Hunter0c6c7fa2009-06-26 14:58:01 +0300863 ec_hdr->image_seq = cpu_to_be32(ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400864 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300865 ec_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400866
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300867 err = self_check_ec_hdr(ubi, pnum, ec_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400868 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200869 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400870
871 err = ubi_io_write(ubi, ec_hdr, pnum, 0, ubi->ec_hdr_alsize);
872 return err;
873}
874
875/**
876 * validate_vid_hdr - validate a volume identifier header.
877 * @ubi: UBI device description object
878 * @vid_hdr: the volume identifier header to check
879 *
880 * This function checks that data stored in the volume identifier header
881 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
882 */
883static int validate_vid_hdr(const struct ubi_device *ubi,
884 const struct ubi_vid_hdr *vid_hdr)
885{
886 int vol_type = vid_hdr->vol_type;
887 int copy_flag = vid_hdr->copy_flag;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300888 int vol_id = be32_to_cpu(vid_hdr->vol_id);
889 int lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400890 int compat = vid_hdr->compat;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300891 int data_size = be32_to_cpu(vid_hdr->data_size);
892 int used_ebs = be32_to_cpu(vid_hdr->used_ebs);
893 int data_pad = be32_to_cpu(vid_hdr->data_pad);
894 int data_crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400895 int usable_leb_size = ubi->leb_size - data_pad;
896
897 if (copy_flag != 0 && copy_flag != 1) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300898 ubi_err("bad copy_flag");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400899 goto bad;
900 }
901
902 if (vol_id < 0 || lnum < 0 || data_size < 0 || used_ebs < 0 ||
903 data_pad < 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300904 ubi_err("negative values");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400905 goto bad;
906 }
907
908 if (vol_id >= UBI_MAX_VOLUMES && vol_id < UBI_INTERNAL_VOL_START) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300909 ubi_err("bad vol_id");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400910 goto bad;
911 }
912
913 if (vol_id < UBI_INTERNAL_VOL_START && compat != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300914 ubi_err("bad compat");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400915 goto bad;
916 }
917
918 if (vol_id >= UBI_INTERNAL_VOL_START && compat != UBI_COMPAT_DELETE &&
919 compat != UBI_COMPAT_RO && compat != UBI_COMPAT_PRESERVE &&
920 compat != UBI_COMPAT_REJECT) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300921 ubi_err("bad compat");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400922 goto bad;
923 }
924
925 if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300926 ubi_err("bad vol_type");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400927 goto bad;
928 }
929
930 if (data_pad >= ubi->leb_size / 2) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300931 ubi_err("bad data_pad");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400932 goto bad;
933 }
934
935 if (vol_type == UBI_VID_STATIC) {
936 /*
937 * Although from high-level point of view static volumes may
938 * contain zero bytes of data, but no VID headers can contain
939 * zero at these fields, because they empty volumes do not have
940 * mapped logical eraseblocks.
941 */
942 if (used_ebs == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300943 ubi_err("zero used_ebs");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400944 goto bad;
945 }
946 if (data_size == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300947 ubi_err("zero data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400948 goto bad;
949 }
950 if (lnum < used_ebs - 1) {
951 if (data_size != usable_leb_size) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300952 ubi_err("bad data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400953 goto bad;
954 }
955 } else if (lnum == used_ebs - 1) {
956 if (data_size == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300957 ubi_err("bad data_size at last LEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400958 goto bad;
959 }
960 } else {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300961 ubi_err("too high lnum");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400962 goto bad;
963 }
964 } else {
965 if (copy_flag == 0) {
966 if (data_crc != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300967 ubi_err("non-zero data CRC");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400968 goto bad;
969 }
970 if (data_size != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300971 ubi_err("non-zero data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400972 goto bad;
973 }
974 } else {
975 if (data_size == 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300976 ubi_err("zero data_size of copy");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400977 goto bad;
978 }
979 }
980 if (used_ebs != 0) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300981 ubi_err("bad used_ebs");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400982 goto bad;
983 }
984 }
985
986 return 0;
987
988bad:
989 ubi_err("bad VID header");
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300990 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300991 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400992 return 1;
993}
994
995/**
996 * ubi_io_read_vid_hdr - read and check a volume identifier header.
997 * @ubi: UBI device description object
998 * @pnum: physical eraseblock number to read from
999 * @vid_hdr: &struct ubi_vid_hdr object where to store the read volume
1000 * identifier header
1001 * @verbose: be verbose if the header is corrupted or wasn't found
1002 *
1003 * This function reads the volume identifier header from physical eraseblock
1004 * @pnum and stores it in @vid_hdr. It also checks CRC checksum of the read
Artem Bityutskiy74d82d22010-09-03 02:11:20 +03001005 * volume identifier header. The error codes are the same as in
1006 * 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001007 *
Artem Bityutskiy74d82d22010-09-03 02:11:20 +03001008 * Note, the implementation of this function is also very similar to
1009 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001010 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001011int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001012 struct ubi_vid_hdr *vid_hdr, int verbose)
1013{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001014 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001015 uint32_t crc, magic, hdr_crc;
1016 void *p;
1017
1018 dbg_io("read VID header from PEB %d", pnum);
1019 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1020
1021 p = (char *)vid_hdr - ubi->vid_hdr_shift;
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001022 read_err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001023 ubi->vid_hdr_alsize);
Brian Norrisd57f40542011-09-20 18:34:25 -07001024 if (read_err && read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001025 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001026
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001027 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001028 if (magic != UBI_VID_HDR_MAGIC) {
Brian Norrisd57f40542011-09-20 18:34:25 -07001029 if (mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001030 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +03001031
Artem Bityutskiybb00e182010-07-31 09:37:34 +03001032 if (ubi_check_pattern(vid_hdr, 0xFF, UBI_VID_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001033 if (verbose)
1034 ubi_warn("no VID header found at PEB %d, "
1035 "only 0xFF bytes", pnum);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001036 dbg_bld("no VID header found at PEB %d, "
1037 "only 0xFF bytes", pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001038 if (!read_err)
1039 return UBI_IO_FF;
1040 else
1041 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001042 }
1043
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001044 if (verbose) {
1045 ubi_warn("bad magic number at PEB %d: %08x instead of "
1046 "%08x", pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001047 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001048 }
1049 dbg_bld("bad magic number at PEB %d: %08x instead of "
1050 "%08x", pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001051 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001052 }
1053
1054 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001055 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001056
1057 if (hdr_crc != crc) {
1058 if (verbose) {
1059 ubi_warn("bad CRC at PEB %d, calculated %#08x, "
1060 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001061 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001062 }
1063 dbg_bld("bad CRC at PEB %d, calculated %#08x, "
1064 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001065 if (!read_err)
1066 return UBI_IO_BAD_HDR;
1067 else
1068 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001069 }
1070
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001071 err = validate_vid_hdr(ubi, vid_hdr);
1072 if (err) {
1073 ubi_err("validation failed for PEB %d", pnum);
1074 return -EINVAL;
1075 }
1076
1077 return read_err ? UBI_IO_BITFLIPS : 0;
1078}
1079
1080/**
1081 * ubi_io_write_vid_hdr - write a volume identifier header.
1082 * @ubi: UBI device description object
1083 * @pnum: the physical eraseblock number to write to
1084 * @vid_hdr: the volume identifier header to write
1085 *
1086 * This function writes the volume identifier header described by @vid_hdr to
1087 * physical eraseblock @pnum. This function automatically fills the
1088 * @vid_hdr->magic and the @vid_hdr->version fields, as well as calculates
1089 * header CRC checksum and stores it at vid_hdr->hdr_crc.
1090 *
1091 * This function returns zero in case of success and a negative error code in
1092 * case of failure. If %-EIO is returned, the physical eraseblock probably went
1093 * bad.
1094 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001095int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001096 struct ubi_vid_hdr *vid_hdr)
1097{
1098 int err;
1099 uint32_t crc;
1100 void *p;
1101
1102 dbg_io("write VID header to PEB %d", pnum);
1103 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1104
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001105 err = self_check_peb_ec_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001106 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001107 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001108
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001109 vid_hdr->magic = cpu_to_be32(UBI_VID_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001110 vid_hdr->version = UBI_VERSION;
1111 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001112 vid_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001113
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001114 err = self_check_vid_hdr(ubi, pnum, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001115 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001116 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001117
1118 p = (char *)vid_hdr - ubi->vid_hdr_shift;
1119 err = ubi_io_write(ubi, p, pnum, ubi->vid_hdr_aloffset,
1120 ubi->vid_hdr_alsize);
1121 return err;
1122}
1123
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001124/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001125 * self_check_not_bad - ensure that a physical eraseblock is not bad.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001126 * @ubi: UBI device description object
1127 * @pnum: physical eraseblock number to check
1128 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001129 * This function returns zero if the physical eraseblock is good, %-EINVAL if
1130 * it is bad and a negative error code if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001131 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001132static int self_check_not_bad(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001133{
1134 int err;
1135
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001136 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001137 return 0;
1138
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001139 err = ubi_io_is_bad(ubi, pnum);
1140 if (!err)
1141 return err;
1142
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001143 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001144 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001145 return err > 0 ? -EINVAL : err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001146}
1147
1148/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001149 * self_check_ec_hdr - check if an erase counter header is all right.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001150 * @ubi: UBI device description object
1151 * @pnum: physical eraseblock number the erase counter header belongs to
1152 * @ec_hdr: the erase counter header to check
1153 *
1154 * This function returns zero if the erase counter header contains valid
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001155 * values, and %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001156 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001157static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
1158 const struct ubi_ec_hdr *ec_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001159{
1160 int err;
1161 uint32_t magic;
1162
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001163 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001164 return 0;
1165
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001166 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001167 if (magic != UBI_EC_HDR_MAGIC) {
1168 ubi_err("bad magic %#08x, must be %#08x",
1169 magic, UBI_EC_HDR_MAGIC);
1170 goto fail;
1171 }
1172
1173 err = validate_ec_hdr(ubi, ec_hdr);
1174 if (err) {
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001175 ubi_err("self-check failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001176 goto fail;
1177 }
1178
1179 return 0;
1180
1181fail:
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001182 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001183 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001184 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001185}
1186
1187/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001188 * self_check_peb_ec_hdr - check erase counter header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001189 * @ubi: UBI device description object
1190 * @pnum: the physical eraseblock number to check
1191 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001192 * This function returns zero if the erase counter header is all right and and
1193 * a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001194 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001195static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001196{
1197 int err;
1198 uint32_t crc, hdr_crc;
1199 struct ubi_ec_hdr *ec_hdr;
1200
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001201 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001202 return 0;
1203
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001204 ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001205 if (!ec_hdr)
1206 return -ENOMEM;
1207
1208 err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
Brian Norrisd57f40542011-09-20 18:34:25 -07001209 if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001210 goto exit;
1211
1212 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001213 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001214 if (hdr_crc != crc) {
1215 ubi_err("bad CRC, calculated %#08x, read %#08x", crc, hdr_crc);
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001216 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001217 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001218 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001219 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001220 goto exit;
1221 }
1222
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001223 err = self_check_ec_hdr(ubi, pnum, ec_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001224
1225exit:
1226 kfree(ec_hdr);
1227 return err;
1228}
1229
1230/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001231 * self_check_vid_hdr - check that a volume identifier header is all right.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001232 * @ubi: UBI device description object
1233 * @pnum: physical eraseblock number the volume identifier header belongs to
1234 * @vid_hdr: the volume identifier header to check
1235 *
1236 * This function returns zero if the volume identifier header is all right, and
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001237 * %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001238 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001239static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
1240 const struct ubi_vid_hdr *vid_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001241{
1242 int err;
1243 uint32_t magic;
1244
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001245 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001246 return 0;
1247
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001248 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001249 if (magic != UBI_VID_HDR_MAGIC) {
1250 ubi_err("bad VID header magic %#08x at PEB %d, must be %#08x",
1251 magic, pnum, UBI_VID_HDR_MAGIC);
1252 goto fail;
1253 }
1254
1255 err = validate_vid_hdr(ubi, vid_hdr);
1256 if (err) {
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001257 ubi_err("self-check failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001258 goto fail;
1259 }
1260
1261 return err;
1262
1263fail:
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001264 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001265 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001266 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001267 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001268
1269}
1270
1271/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001272 * self_check_peb_vid_hdr - check volume identifier header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001273 * @ubi: UBI device description object
1274 * @pnum: the physical eraseblock number to check
1275 *
1276 * This function returns zero if the volume identifier header is all right,
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001277 * and a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001278 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001279static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001280{
1281 int err;
1282 uint32_t crc, hdr_crc;
1283 struct ubi_vid_hdr *vid_hdr;
1284 void *p;
1285
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001286 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001287 return 0;
1288
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001289 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001290 if (!vid_hdr)
1291 return -ENOMEM;
1292
1293 p = (char *)vid_hdr - ubi->vid_hdr_shift;
1294 err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
1295 ubi->vid_hdr_alsize);
Brian Norrisd57f40542011-09-20 18:34:25 -07001296 if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001297 goto exit;
1298
1299 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001300 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001301 if (hdr_crc != crc) {
1302 ubi_err("bad VID header CRC at PEB %d, calculated %#08x, "
1303 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001304 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001305 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001306 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001307 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001308 goto exit;
1309 }
1310
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001311 err = self_check_vid_hdr(ubi, pnum, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001312
1313exit:
1314 ubi_free_vid_hdr(ubi, vid_hdr);
1315 return err;
1316}
1317
1318/**
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001319 * ubi_dbg_check_write - make sure write succeeded.
1320 * @ubi: UBI device description object
1321 * @buf: buffer with data which were written
1322 * @pnum: physical eraseblock number the data were written to
1323 * @offset: offset within the physical eraseblock the data were written to
1324 * @len: how many bytes were written
1325 *
1326 * This functions reads data which were recently written and compares it with
1327 * the original data buffer - the data have to match. Returns zero if the data
1328 * match and a negative error code if not or in case of failure.
1329 */
1330int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum,
1331 int offset, int len)
1332{
1333 int err, i;
Artem Bityutskiy7950d022010-11-19 17:05:36 +02001334 size_t read;
Artem Bityutskiya7586742011-03-14 17:06:52 +02001335 void *buf1;
Artem Bityutskiy7950d022010-11-19 17:05:36 +02001336 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001337
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001338 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001339 return 0;
1340
Artem Bityutskiy3d46b312011-03-24 16:09:56 +02001341 buf1 = __vmalloc(len, GFP_NOFS, PAGE_KERNEL);
Artem Bityutskiya7586742011-03-14 17:06:52 +02001342 if (!buf1) {
1343 ubi_err("cannot allocate memory to check writes");
1344 return 0;
1345 }
1346
Artem Bityutskiy329ad392011-12-23 17:30:16 +02001347 err = mtd_read(ubi->mtd, addr, len, &read, buf1);
Brian Norrisd57f40542011-09-20 18:34:25 -07001348 if (err && !mtd_is_bitflip(err))
Artem Bityutskiya7586742011-03-14 17:06:52 +02001349 goto out_free;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001350
1351 for (i = 0; i < len; i++) {
1352 uint8_t c = ((uint8_t *)buf)[i];
Artem Bityutskiya7586742011-03-14 17:06:52 +02001353 uint8_t c1 = ((uint8_t *)buf1)[i];
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001354 int dump_len;
1355
1356 if (c == c1)
1357 continue;
1358
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001359 ubi_err("self-check failed for PEB %d:%d, len %d",
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001360 pnum, offset, len);
1361 ubi_msg("data differ at position %d", i);
1362 dump_len = max_t(int, 128, len - i);
1363 ubi_msg("hex dump of the original buffer from %d to %d",
1364 i, i + dump_len);
1365 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
1366 buf + i, dump_len, 1);
1367 ubi_msg("hex dump of the read buffer from %d to %d",
1368 i, i + dump_len);
1369 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
Artem Bityutskiya7586742011-03-14 17:06:52 +02001370 buf1 + i, dump_len, 1);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001371 dump_stack();
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001372 err = -EINVAL;
Artem Bityutskiya7586742011-03-14 17:06:52 +02001373 goto out_free;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001374 }
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001375
Artem Bityutskiya7586742011-03-14 17:06:52 +02001376 vfree(buf1);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001377 return 0;
1378
Artem Bityutskiya7586742011-03-14 17:06:52 +02001379out_free:
1380 vfree(buf1);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001381 return err;
1382}
1383
1384/**
Artem Bityutskiy40a71a82009-06-28 19:16:55 +03001385 * ubi_dbg_check_all_ff - check that a region of flash is empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001386 * @ubi: UBI device description object
1387 * @pnum: the physical eraseblock number to check
1388 * @offset: the starting offset within the physical eraseblock to check
1389 * @len: the length of the region to check
1390 *
1391 * This function returns zero if only 0xFF bytes are present at offset
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001392 * @offset of the physical eraseblock @pnum, and a negative error code if not
1393 * or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001394 */
Artem Bityutskiy40a71a82009-06-28 19:16:55 +03001395int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001396{
1397 size_t read;
1398 int err;
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001399 void *buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001400 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
1401
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001402 if (!ubi->dbg->chk_io)
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001403 return 0;
1404
Artem Bityutskiy3d46b312011-03-24 16:09:56 +02001405 buf = __vmalloc(len, GFP_NOFS, PAGE_KERNEL);
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001406 if (!buf) {
1407 ubi_err("cannot allocate memory to check for 0xFFs");
1408 return 0;
1409 }
1410
Artem Bityutskiy329ad392011-12-23 17:30:16 +02001411 err = mtd_read(ubi->mtd, addr, len, &read, buf);
Brian Norrisd57f40542011-09-20 18:34:25 -07001412 if (err && !mtd_is_bitflip(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001413 ubi_err("error %d while reading %d bytes from PEB %d:%d, "
1414 "read %zd bytes", err, len, pnum, offset, read);
1415 goto error;
1416 }
1417
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001418 err = ubi_check_pattern(buf, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001419 if (err == 0) {
1420 ubi_err("flash region at PEB %d:%d, length %d does not "
1421 "contain all 0xFF bytes", pnum, offset, len);
1422 goto fail;
1423 }
1424
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001425 vfree(buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001426 return 0;
1427
1428fail:
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001429 ubi_err("self-check failed for PEB %d", pnum);
Artem Bityutskiyc8566352008-07-16 17:40:22 +03001430 ubi_msg("hex dump of the %d-%d region", offset, offset + len);
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001431 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001432 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001433error:
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001434 dump_stack();
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001435 vfree(buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001436 return err;
1437}