blob: b76252465c877158bca493f00ecdeee8b9ae40a9 [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
94#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
95static int paranoid_check_not_bad(const struct ubi_device *ubi, int pnum);
96static int paranoid_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum);
97static int paranoid_check_ec_hdr(const struct ubi_device *ubi, int pnum,
98 const struct ubi_ec_hdr *ec_hdr);
99static int paranoid_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum);
100static int paranoid_check_vid_hdr(const struct ubi_device *ubi, int pnum,
101 const struct ubi_vid_hdr *vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400102#else
103#define paranoid_check_not_bad(ubi, pnum) 0
104#define paranoid_check_peb_ec_hdr(ubi, pnum) 0
105#define paranoid_check_ec_hdr(ubi, pnum, ec_hdr) 0
106#define paranoid_check_peb_vid_hdr(ubi, pnum) 0
107#define paranoid_check_vid_hdr(ubi, pnum, vid_hdr) 0
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400108#endif
109
110/**
111 * ubi_io_read - read data from a physical eraseblock.
112 * @ubi: UBI device description object
113 * @buf: buffer where to store the read data
114 * @pnum: physical eraseblock number to read from
115 * @offset: offset within the physical eraseblock from where to read
116 * @len: how many bytes to read
117 *
118 * This function reads data from offset @offset of physical eraseblock @pnum
119 * and stores the read data in the @buf buffer. The following return codes are
120 * possible:
121 *
122 * o %0 if all the requested data were successfully read;
123 * o %UBI_IO_BITFLIPS if all the requested data were successfully read, but
124 * correctable bit-flips were detected; this is harmless but may indicate
125 * that this eraseblock may become bad soon (but do not have to);
Artem Bityutskiy63b6c1e2007-07-17 15:04:20 +0300126 * o %-EBADMSG if the MTD subsystem reported about data integrity problems, for
127 * example it can be an ECC error in case of NAND; this most probably means
128 * that the data is corrupted;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400129 * o %-EIO if some I/O error occurred;
130 * o other negative error codes in case of other errors.
131 */
132int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
133 int len)
134{
135 int err, retries = 0;
136 size_t read;
137 loff_t addr;
138
139 dbg_io("read %d bytes from PEB %d:%d", len, pnum, offset);
140
141 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
142 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
143 ubi_assert(len > 0);
144
145 err = paranoid_check_not_bad(ubi, pnum);
146 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200147 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400148
149 addr = (loff_t)pnum * ubi->peb_size + offset;
150retry:
151 err = ubi->mtd->read(ubi->mtd, addr, len, &read, buf);
152 if (err) {
Artem Bityutskiyf5d5b1f2010-06-14 08:15:39 +0300153 const char *errstr = (err == -EBADMSG) ? " (ECC error)" : "";
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300154
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400155 if (err == -EUCLEAN) {
156 /*
157 * -EUCLEAN is reported if there was a bit-flip which
158 * was corrected, so this is harmless.
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300159 *
160 * We do not report about it here unless debugging is
161 * enabled. A corresponding message will be printed
162 * later, when it is has been scrubbed.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400163 */
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300164 dbg_msg("fixable bit-flip detected at PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400165 ubi_assert(len == read);
166 return UBI_IO_BITFLIPS;
167 }
168
169 if (read != len && retries++ < UBI_IO_RETRIES) {
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300170 dbg_io("error %d%s while reading %d bytes from PEB %d:%d,"
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300171 " read only %zd bytes, retry",
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300172 err, errstr, len, pnum, offset, read);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400173 yield();
174 goto retry;
175 }
176
Artem Bityutskiyf5d5b1f2010-06-14 08:15:39 +0300177 ubi_err("error %d%s while reading %d bytes from PEB %d:%d, "
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300178 "read %zd bytes", err, errstr, len, pnum, offset, read);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400179 ubi_dbg_dump_stack();
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300180
181 /*
182 * The driver should never return -EBADMSG if it failed to read
183 * all the requested data. But some buggy drivers might do
184 * this, so we change it to -EIO.
185 */
186 if (read != len && err == -EBADMSG) {
187 ubi_assert(0);
188 err = -EIO;
189 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400190 } else {
191 ubi_assert(len == read);
192
193 if (ubi_dbg_is_bitflip()) {
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300194 dbg_gen("bit-flip (emulated)");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400195 err = UBI_IO_BITFLIPS;
196 }
197 }
198
199 return err;
200}
201
202/**
203 * ubi_io_write - write data to a physical eraseblock.
204 * @ubi: UBI device description object
205 * @buf: buffer with the data to write
206 * @pnum: physical eraseblock number to write to
207 * @offset: offset within the physical eraseblock where to write
208 * @len: how many bytes to write
209 *
210 * This function writes @len bytes of data from buffer @buf to offset @offset
211 * of physical eraseblock @pnum. If all the data were successfully written,
212 * zero is returned. If an error occurred, this function returns a negative
213 * error code. If %-EIO is returned, the physical eraseblock most probably went
214 * bad.
215 *
216 * Note, in case of an error, it is possible that something was still written
217 * to the flash media, but may be some garbage.
218 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300219int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
220 int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400221{
222 int err;
223 size_t written;
224 loff_t addr;
225
226 dbg_io("write %d bytes to PEB %d:%d", len, pnum, offset);
227
228 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
229 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
230 ubi_assert(offset % ubi->hdrs_min_io_size == 0);
231 ubi_assert(len > 0 && len % ubi->hdrs_min_io_size == 0);
232
233 if (ubi->ro_mode) {
234 ubi_err("read-only mode");
235 return -EROFS;
236 }
237
238 /* The below has to be compiled out if paranoid checks are disabled */
239
240 err = paranoid_check_not_bad(ubi, pnum);
241 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200242 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400243
244 /* The area we are writing to has to contain all 0xFF bytes */
Artem Bityutskiy40a71a82009-06-28 19:16:55 +0300245 err = ubi_dbg_check_all_ff(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400246 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200247 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400248
249 if (offset >= ubi->leb_start) {
250 /*
251 * We write to the data area of the physical eraseblock. Make
252 * sure it has valid EC and VID headers.
253 */
254 err = paranoid_check_peb_ec_hdr(ubi, pnum);
255 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200256 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400257 err = paranoid_check_peb_vid_hdr(ubi, pnum);
258 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200259 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400260 }
261
262 if (ubi_dbg_is_write_failure()) {
263 dbg_err("cannot write %d bytes to PEB %d:%d "
264 "(emulated)", len, pnum, offset);
265 ubi_dbg_dump_stack();
266 return -EIO;
267 }
268
269 addr = (loff_t)pnum * ubi->peb_size + offset;
270 err = ubi->mtd->write(ubi->mtd, addr, len, &written, buf);
271 if (err) {
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300272 ubi_err("error %d while writing %d bytes to PEB %d:%d, written "
273 "%zd bytes", err, len, pnum, offset, written);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400274 ubi_dbg_dump_stack();
Artem Bityutskiy867996b2009-07-24 15:31:33 +0300275 ubi_dbg_dump_flash(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400276 } else
277 ubi_assert(written == len);
278
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200279 if (!err) {
280 err = ubi_dbg_check_write(ubi, buf, pnum, offset, len);
281 if (err)
282 return err;
283
284 /*
285 * Since we always write sequentially, the rest of the PEB has
286 * to contain only 0xFF bytes.
287 */
288 offset += len;
289 len = ubi->peb_size - offset;
290 if (len)
291 err = ubi_dbg_check_all_ff(ubi, pnum, offset, len);
292 }
293
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400294 return err;
295}
296
297/**
298 * erase_callback - MTD erasure call-back.
299 * @ei: MTD erase information object.
300 *
301 * Note, even though MTD erase interface is asynchronous, all the current
302 * implementations are synchronous anyway.
303 */
304static void erase_callback(struct erase_info *ei)
305{
306 wake_up_interruptible((wait_queue_head_t *)ei->priv);
307}
308
309/**
310 * do_sync_erase - synchronously erase a physical eraseblock.
311 * @ubi: UBI device description object
312 * @pnum: the physical eraseblock number to erase
313 *
314 * This function synchronously erases physical eraseblock @pnum and returns
315 * zero in case of success and a negative error code in case of failure. If
316 * %-EIO is returned, the physical eraseblock most probably went bad.
317 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300318static int do_sync_erase(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400319{
320 int err, retries = 0;
321 struct erase_info ei;
322 wait_queue_head_t wq;
323
324 dbg_io("erase PEB %d", pnum);
325
326retry:
327 init_waitqueue_head(&wq);
328 memset(&ei, 0, sizeof(struct erase_info));
329
330 ei.mtd = ubi->mtd;
Brijesh Singh2f176f72007-07-05 15:07:35 +0530331 ei.addr = (loff_t)pnum * ubi->peb_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400332 ei.len = ubi->peb_size;
333 ei.callback = erase_callback;
334 ei.priv = (unsigned long)&wq;
335
336 err = ubi->mtd->erase(ubi->mtd, &ei);
337 if (err) {
338 if (retries++ < UBI_IO_RETRIES) {
339 dbg_io("error %d while erasing PEB %d, retry",
340 err, pnum);
341 yield();
342 goto retry;
343 }
344 ubi_err("cannot erase PEB %d, error %d", pnum, err);
345 ubi_dbg_dump_stack();
346 return err;
347 }
348
349 err = wait_event_interruptible(wq, ei.state == MTD_ERASE_DONE ||
350 ei.state == MTD_ERASE_FAILED);
351 if (err) {
352 ubi_err("interrupted PEB %d erasure", pnum);
353 return -EINTR;
354 }
355
356 if (ei.state == MTD_ERASE_FAILED) {
357 if (retries++ < UBI_IO_RETRIES) {
358 dbg_io("error while erasing PEB %d, retry", pnum);
359 yield();
360 goto retry;
361 }
362 ubi_err("cannot erase PEB %d", pnum);
363 ubi_dbg_dump_stack();
364 return -EIO;
365 }
366
Artem Bityutskiy40a71a82009-06-28 19:16:55 +0300367 err = ubi_dbg_check_all_ff(ubi, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400368 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200369 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400370
371 if (ubi_dbg_is_erase_failure() && !err) {
372 dbg_err("cannot erase PEB %d (emulated)", pnum);
373 return -EIO;
374 }
375
376 return 0;
377}
378
379/**
380 * check_pattern - check if buffer contains only a certain byte pattern.
381 * @buf: buffer to check
382 * @patt: the pattern to check
383 * @size: buffer size in bytes
384 *
385 * This function returns %1 in there are only @patt bytes in @buf, and %0 if
386 * something else was also found.
387 */
388static int check_pattern(const void *buf, uint8_t patt, int size)
389{
390 int i;
391
392 for (i = 0; i < size; i++)
393 if (((const uint8_t *)buf)[i] != patt)
394 return 0;
395 return 1;
396}
397
398/* Patterns to write to a physical eraseblock when torturing it */
399static uint8_t patterns[] = {0xa5, 0x5a, 0x0};
400
401/**
402 * torture_peb - test a supposedly bad physical eraseblock.
403 * @ubi: UBI device description object
404 * @pnum: the physical eraseblock number to test
405 *
406 * This function returns %-EIO if the physical eraseblock did not pass the
407 * test, a positive number of erase operations done if the test was
408 * successfully passed, and other negative error codes in case of other errors.
409 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300410static int torture_peb(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400411{
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400412 int err, i, patt_count;
413
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300414 ubi_msg("run torture test for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400415 patt_count = ARRAY_SIZE(patterns);
416 ubi_assert(patt_count > 0);
417
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300418 mutex_lock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400419 for (i = 0; i < patt_count; i++) {
420 err = do_sync_erase(ubi, pnum);
421 if (err)
422 goto out;
423
424 /* Make sure the PEB contains only 0xFF bytes */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300425 err = ubi_io_read(ubi, ubi->peb_buf1, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400426 if (err)
427 goto out;
428
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300429 err = check_pattern(ubi->peb_buf1, 0xFF, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400430 if (err == 0) {
431 ubi_err("erased PEB %d, but a non-0xFF byte found",
432 pnum);
433 err = -EIO;
434 goto out;
435 }
436
437 /* Write a pattern and check it */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300438 memset(ubi->peb_buf1, patterns[i], ubi->peb_size);
439 err = ubi_io_write(ubi, ubi->peb_buf1, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400440 if (err)
441 goto out;
442
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300443 memset(ubi->peb_buf1, ~patterns[i], ubi->peb_size);
444 err = ubi_io_read(ubi, ubi->peb_buf1, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400445 if (err)
446 goto out;
447
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300448 err = check_pattern(ubi->peb_buf1, patterns[i], 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 Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300458 ubi_msg("PEB %d passed torture test, do not mark it a 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);
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300462 if (err == UBI_IO_BITFLIPS || err == -EBADMSG) {
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 Bityutskiyde75c772009-07-24 16:18:04 +0300501 struct ubi_vid_hdr vid_hdr;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300502
Artem Bityutskiy5b289b52009-07-19 14:09:46 +0300503 addr = (loff_t)pnum * ubi->peb_size + ubi->vid_hdr_aloffset;
Artem Bityutskiy83c20992009-07-08 10:15:41 +0300504 err = ubi->mtd->write(ubi->mtd, addr, 4, &written, (void *)&data);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300505 if (!err) {
506 addr -= ubi->vid_hdr_aloffset;
507 err = ubi->mtd->write(ubi->mtd, addr, 4, &written,
508 (void *)&data);
509 if (!err)
510 return 0;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300511 }
512
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300513 /*
514 * We failed to write to the media. This was observed with Spansion
515 * S29GL512N NOR flash. Most probably the eraseblock erasure was
516 * interrupted at a very inappropriate moment, so it became unwritable.
517 * In this case we probably anyway have garbage in this PEB.
518 */
519 err1 = ubi_io_read_vid_hdr(ubi, pnum, &vid_hdr, 0);
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300520 if (err1 == UBI_IO_BAD_HDR_EBADMSG || err1 == UBI_IO_BAD_HDR)
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300521 /*
522 * The VID header is corrupted, so we can safely erase this
523 * PEB and not afraid that it will be treated as a valid PEB in
524 * case of an unclean reboot.
525 */
526 return 0;
Artem Bityutskiy5b289b52009-07-19 14:09:46 +0300527
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300528 /*
529 * The PEB contains a valid VID header, but we cannot invalidate it.
530 * Supposedly the flash media or the driver is screwed up, so return an
531 * error.
532 */
533 ubi_err("cannot invalidate PEB %d, write returned %d read returned %d",
534 pnum, err, err1);
535 ubi_dbg_dump_flash(ubi, pnum, 0, ubi->peb_size);
536 return -EIO;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300537}
538
539/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400540 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
541 * @ubi: UBI device description object
542 * @pnum: physical eraseblock number to erase
543 * @torture: if this physical eraseblock has to be tortured
544 *
545 * This function synchronously erases physical eraseblock @pnum. If @torture
546 * flag is not zero, the physical eraseblock is checked by means of writing
547 * different patterns to it and reading them back. If the torturing is enabled,
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200548 * the physical eraseblock is erased more than once.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400549 *
550 * This function returns the number of erasures made in case of success, %-EIO
551 * if the erasure failed or the torturing test failed, and other negative error
552 * codes in case of other errors. Note, %-EIO means that the physical
553 * eraseblock is bad.
554 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300555int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400556{
557 int err, ret = 0;
558
559 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
560
561 err = paranoid_check_not_bad(ubi, pnum);
562 if (err != 0)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200563 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400564
565 if (ubi->ro_mode) {
566 ubi_err("read-only mode");
567 return -EROFS;
568 }
569
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300570 if (ubi->nor_flash) {
571 err = nor_erase_prepare(ubi, pnum);
572 if (err)
573 return err;
574 }
575
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400576 if (torture) {
577 ret = torture_peb(ubi, pnum);
578 if (ret < 0)
579 return ret;
580 }
581
582 err = do_sync_erase(ubi, pnum);
583 if (err)
584 return err;
585
586 return ret + 1;
587}
588
589/**
590 * ubi_io_is_bad - check if a physical eraseblock is bad.
591 * @ubi: UBI device description object
592 * @pnum: the physical eraseblock number to check
593 *
594 * This function returns a positive number if the physical eraseblock is bad,
595 * zero if not, and a negative error code if an error occurred.
596 */
597int ubi_io_is_bad(const struct ubi_device *ubi, int pnum)
598{
599 struct mtd_info *mtd = ubi->mtd;
600
601 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
602
603 if (ubi->bad_allowed) {
604 int ret;
605
606 ret = mtd->block_isbad(mtd, (loff_t)pnum * ubi->peb_size);
607 if (ret < 0)
608 ubi_err("error %d while checking if PEB %d is bad",
609 ret, pnum);
610 else if (ret)
611 dbg_io("PEB %d is bad", pnum);
612 return ret;
613 }
614
615 return 0;
616}
617
618/**
619 * ubi_io_mark_bad - mark a physical eraseblock as bad.
620 * @ubi: UBI device description object
621 * @pnum: the physical eraseblock number to mark
622 *
623 * This function returns zero in case of success and a negative error code in
624 * case of failure.
625 */
626int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum)
627{
628 int err;
629 struct mtd_info *mtd = ubi->mtd;
630
631 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
632
633 if (ubi->ro_mode) {
634 ubi_err("read-only mode");
635 return -EROFS;
636 }
637
638 if (!ubi->bad_allowed)
639 return 0;
640
641 err = mtd->block_markbad(mtd, (loff_t)pnum * ubi->peb_size);
642 if (err)
643 ubi_err("cannot mark PEB %d bad, error %d", pnum, err);
644 return err;
645}
646
647/**
648 * validate_ec_hdr - validate an erase counter header.
649 * @ubi: UBI device description object
650 * @ec_hdr: the erase counter header to check
651 *
652 * This function returns zero if the erase counter header is OK, and %1 if
653 * not.
654 */
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300655static int validate_ec_hdr(const struct ubi_device *ubi,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400656 const struct ubi_ec_hdr *ec_hdr)
657{
658 long long ec;
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300659 int vid_hdr_offset, leb_start;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400660
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300661 ec = be64_to_cpu(ec_hdr->ec);
662 vid_hdr_offset = be32_to_cpu(ec_hdr->vid_hdr_offset);
663 leb_start = be32_to_cpu(ec_hdr->data_offset);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400664
665 if (ec_hdr->version != UBI_VERSION) {
666 ubi_err("node with incompatible UBI version found: "
667 "this UBI version is %d, image version is %d",
668 UBI_VERSION, (int)ec_hdr->version);
669 goto bad;
670 }
671
672 if (vid_hdr_offset != ubi->vid_hdr_offset) {
673 ubi_err("bad VID header offset %d, expected %d",
674 vid_hdr_offset, ubi->vid_hdr_offset);
675 goto bad;
676 }
677
678 if (leb_start != ubi->leb_start) {
679 ubi_err("bad data offset %d, expected %d",
680 leb_start, ubi->leb_start);
681 goto bad;
682 }
683
684 if (ec < 0 || ec > UBI_MAX_ERASECOUNTER) {
685 ubi_err("bad erase counter %lld", ec);
686 goto bad;
687 }
688
689 return 0;
690
691bad:
692 ubi_err("bad EC header");
693 ubi_dbg_dump_ec_hdr(ec_hdr);
694 ubi_dbg_dump_stack();
695 return 1;
696}
697
698/**
699 * ubi_io_read_ec_hdr - read and check an erase counter header.
700 * @ubi: UBI device description object
701 * @pnum: physical eraseblock to read from
702 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
703 * header
704 * @verbose: be verbose if the header is corrupted or was not found
705 *
706 * This function reads erase counter header from physical eraseblock @pnum and
707 * stores it in @ec_hdr. This function also checks CRC checksum of the read
708 * erase counter header. The following codes may be returned:
709 *
710 * o %0 if the CRC checksum is correct and the header was successfully read;
711 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
712 * and corrected by the flash driver; this is harmless but may indicate that
713 * this eraseblock may become bad soon (but may be not);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300714 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300715 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
716 * a data integrity error (uncorrectable ECC error in case of NAND);
Artem Bityutskiy74d82d22010-09-03 02:11:20 +0300717 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400718 * o a negative error code in case of failure.
719 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300720int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400721 struct ubi_ec_hdr *ec_hdr, int verbose)
722{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300723 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400724 uint32_t crc, magic, hdr_crc;
725
726 dbg_io("read EC header from PEB %d", pnum);
727 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
728
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300729 read_err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
730 if (read_err) {
731 if (read_err != UBI_IO_BITFLIPS && read_err != -EBADMSG)
732 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400733
734 /*
735 * We read all the data, but either a correctable bit-flip
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300736 * occurred, or MTD reported a data integrity error
737 * (uncorrectable ECC error in case of NAND). The former is
738 * harmless, the later may mean that the read data is
739 * corrupted. But we have a CRC check-sum and we will detect
740 * this. If the EC header is still OK, we just report this as
741 * there was a bit-flip, to force scrubbing.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400742 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400743 }
744
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300745 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400746 if (magic != UBI_EC_HDR_MAGIC) {
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300747 if (read_err == -EBADMSG)
748 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300749
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400750 /*
751 * The magic field is wrong. Let's check if we have read all
752 * 0xFF. If yes, this physical eraseblock is assumed to be
753 * empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400754 */
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300755 if (check_pattern(ec_hdr, 0xFF, UBI_EC_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400756 /* The physical eraseblock is supposedly empty */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400757 if (verbose)
758 ubi_warn("no EC header found at PEB %d, "
759 "only 0xFF bytes", pnum);
Artem Bityutskiyed458192008-11-12 10:14:10 +0200760 else if (UBI_IO_DEBUG)
761 dbg_msg("no EC header found at PEB %d, "
762 "only 0xFF bytes", pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300763 if (!read_err)
764 return UBI_IO_FF;
765 else
766 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400767 }
768
769 /*
770 * This is not a valid erase counter header, and these are not
771 * 0xFF bytes. Report that the header is corrupted.
772 */
773 if (verbose) {
774 ubi_warn("bad magic number at PEB %d: %08x instead of "
775 "%08x", pnum, magic, UBI_EC_HDR_MAGIC);
776 ubi_dbg_dump_ec_hdr(ec_hdr);
Artem Bityutskiyed458192008-11-12 10:14:10 +0200777 } else if (UBI_IO_DEBUG)
778 dbg_msg("bad magic number at PEB %d: %08x instead of "
779 "%08x", pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300780 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400781 }
782
783 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300784 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400785
786 if (hdr_crc != crc) {
787 if (verbose) {
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300788 ubi_warn("bad EC header CRC at PEB %d, calculated "
789 "%#08x, read %#08x", pnum, crc, hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400790 ubi_dbg_dump_ec_hdr(ec_hdr);
Artem Bityutskiyed458192008-11-12 10:14:10 +0200791 } else if (UBI_IO_DEBUG)
792 dbg_msg("bad EC header CRC at PEB %d, calculated "
793 "%#08x, read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300794
795 if (!read_err)
796 return UBI_IO_BAD_HDR;
797 else
798 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400799 }
800
801 /* And of course validate what has just been read from the media */
802 err = validate_ec_hdr(ubi, ec_hdr);
803 if (err) {
804 ubi_err("validation failed for PEB %d", pnum);
805 return -EINVAL;
806 }
807
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300808 /*
809 * If there was %-EBADMSG, but the header CRC is still OK, report about
810 * a bit-flip to force scrubbing on this PEB.
811 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400812 return read_err ? UBI_IO_BITFLIPS : 0;
813}
814
815/**
816 * ubi_io_write_ec_hdr - write an erase counter header.
817 * @ubi: UBI device description object
818 * @pnum: physical eraseblock to write to
819 * @ec_hdr: the erase counter header to write
820 *
821 * This function writes erase counter header described by @ec_hdr to physical
822 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
823 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
824 * field.
825 *
826 * This function returns zero in case of success and a negative error code in
827 * case of failure. If %-EIO is returned, the physical eraseblock most probably
828 * went bad.
829 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300830int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400831 struct ubi_ec_hdr *ec_hdr)
832{
833 int err;
834 uint32_t crc;
835
836 dbg_io("write EC header to PEB %d", pnum);
837 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
838
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300839 ec_hdr->magic = cpu_to_be32(UBI_EC_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400840 ec_hdr->version = UBI_VERSION;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300841 ec_hdr->vid_hdr_offset = cpu_to_be32(ubi->vid_hdr_offset);
842 ec_hdr->data_offset = cpu_to_be32(ubi->leb_start);
Adrian Hunter0c6c7fa2009-06-26 14:58:01 +0300843 ec_hdr->image_seq = cpu_to_be32(ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400844 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300845 ec_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400846
847 err = paranoid_check_ec_hdr(ubi, pnum, ec_hdr);
848 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200849 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400850
851 err = ubi_io_write(ubi, ec_hdr, pnum, 0, ubi->ec_hdr_alsize);
852 return err;
853}
854
855/**
856 * validate_vid_hdr - validate a volume identifier header.
857 * @ubi: UBI device description object
858 * @vid_hdr: the volume identifier header to check
859 *
860 * This function checks that data stored in the volume identifier header
861 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
862 */
863static int validate_vid_hdr(const struct ubi_device *ubi,
864 const struct ubi_vid_hdr *vid_hdr)
865{
866 int vol_type = vid_hdr->vol_type;
867 int copy_flag = vid_hdr->copy_flag;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300868 int vol_id = be32_to_cpu(vid_hdr->vol_id);
869 int lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400870 int compat = vid_hdr->compat;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300871 int data_size = be32_to_cpu(vid_hdr->data_size);
872 int used_ebs = be32_to_cpu(vid_hdr->used_ebs);
873 int data_pad = be32_to_cpu(vid_hdr->data_pad);
874 int data_crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400875 int usable_leb_size = ubi->leb_size - data_pad;
876
877 if (copy_flag != 0 && copy_flag != 1) {
878 dbg_err("bad copy_flag");
879 goto bad;
880 }
881
882 if (vol_id < 0 || lnum < 0 || data_size < 0 || used_ebs < 0 ||
883 data_pad < 0) {
884 dbg_err("negative values");
885 goto bad;
886 }
887
888 if (vol_id >= UBI_MAX_VOLUMES && vol_id < UBI_INTERNAL_VOL_START) {
889 dbg_err("bad vol_id");
890 goto bad;
891 }
892
893 if (vol_id < UBI_INTERNAL_VOL_START && compat != 0) {
894 dbg_err("bad compat");
895 goto bad;
896 }
897
898 if (vol_id >= UBI_INTERNAL_VOL_START && compat != UBI_COMPAT_DELETE &&
899 compat != UBI_COMPAT_RO && compat != UBI_COMPAT_PRESERVE &&
900 compat != UBI_COMPAT_REJECT) {
901 dbg_err("bad compat");
902 goto bad;
903 }
904
905 if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
906 dbg_err("bad vol_type");
907 goto bad;
908 }
909
910 if (data_pad >= ubi->leb_size / 2) {
911 dbg_err("bad data_pad");
912 goto bad;
913 }
914
915 if (vol_type == UBI_VID_STATIC) {
916 /*
917 * Although from high-level point of view static volumes may
918 * contain zero bytes of data, but no VID headers can contain
919 * zero at these fields, because they empty volumes do not have
920 * mapped logical eraseblocks.
921 */
922 if (used_ebs == 0) {
923 dbg_err("zero used_ebs");
924 goto bad;
925 }
926 if (data_size == 0) {
927 dbg_err("zero data_size");
928 goto bad;
929 }
930 if (lnum < used_ebs - 1) {
931 if (data_size != usable_leb_size) {
932 dbg_err("bad data_size");
933 goto bad;
934 }
935 } else if (lnum == used_ebs - 1) {
936 if (data_size == 0) {
937 dbg_err("bad data_size at last LEB");
938 goto bad;
939 }
940 } else {
941 dbg_err("too high lnum");
942 goto bad;
943 }
944 } else {
945 if (copy_flag == 0) {
946 if (data_crc != 0) {
947 dbg_err("non-zero data CRC");
948 goto bad;
949 }
950 if (data_size != 0) {
951 dbg_err("non-zero data_size");
952 goto bad;
953 }
954 } else {
955 if (data_size == 0) {
956 dbg_err("zero data_size of copy");
957 goto bad;
958 }
959 }
960 if (used_ebs != 0) {
961 dbg_err("bad used_ebs");
962 goto bad;
963 }
964 }
965
966 return 0;
967
968bad:
969 ubi_err("bad VID header");
970 ubi_dbg_dump_vid_hdr(vid_hdr);
971 ubi_dbg_dump_stack();
972 return 1;
973}
974
975/**
976 * ubi_io_read_vid_hdr - read and check a volume identifier header.
977 * @ubi: UBI device description object
978 * @pnum: physical eraseblock number to read from
979 * @vid_hdr: &struct ubi_vid_hdr object where to store the read volume
980 * identifier header
981 * @verbose: be verbose if the header is corrupted or wasn't found
982 *
983 * This function reads the volume identifier header from physical eraseblock
984 * @pnum and stores it in @vid_hdr. It also checks CRC checksum of the read
Artem Bityutskiy74d82d22010-09-03 02:11:20 +0300985 * volume identifier header. The error codes are the same as in
986 * 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400987 *
Artem Bityutskiy74d82d22010-09-03 02:11:20 +0300988 * Note, the implementation of this function is also very similar to
989 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400990 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300991int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400992 struct ubi_vid_hdr *vid_hdr, int verbose)
993{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300994 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400995 uint32_t crc, magic, hdr_crc;
996 void *p;
997
998 dbg_io("read VID header from PEB %d", pnum);
999 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1000
1001 p = (char *)vid_hdr - ubi->vid_hdr_shift;
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001002 read_err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001003 ubi->vid_hdr_alsize);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001004 if (read_err && read_err != UBI_IO_BITFLIPS && read_err != -EBADMSG)
1005 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001006
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001007 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001008 if (magic != UBI_VID_HDR_MAGIC) {
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001009 if (read_err == -EBADMSG)
1010 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +03001011
Artem Bityutskiyeb895802010-05-03 09:04:39 +03001012 if (check_pattern(vid_hdr, 0xFF, UBI_VID_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001013 if (verbose)
1014 ubi_warn("no VID header found at PEB %d, "
1015 "only 0xFF bytes", pnum);
Artem Bityutskiyed458192008-11-12 10:14:10 +02001016 else if (UBI_IO_DEBUG)
1017 dbg_msg("no VID header found at PEB %d, "
1018 "only 0xFF bytes", pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001019 if (!read_err)
1020 return UBI_IO_FF;
1021 else
1022 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001023 }
1024
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001025 if (verbose) {
1026 ubi_warn("bad magic number at PEB %d: %08x instead of "
1027 "%08x", pnum, magic, UBI_VID_HDR_MAGIC);
1028 ubi_dbg_dump_vid_hdr(vid_hdr);
Artem Bityutskiyed458192008-11-12 10:14:10 +02001029 } else if (UBI_IO_DEBUG)
1030 dbg_msg("bad magic number at PEB %d: %08x instead of "
1031 "%08x", pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001032 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001033 }
1034
1035 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001036 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001037
1038 if (hdr_crc != crc) {
1039 if (verbose) {
1040 ubi_warn("bad CRC at PEB %d, calculated %#08x, "
1041 "read %#08x", pnum, crc, hdr_crc);
1042 ubi_dbg_dump_vid_hdr(vid_hdr);
Artem Bityutskiyed458192008-11-12 10:14:10 +02001043 } else if (UBI_IO_DEBUG)
1044 dbg_msg("bad CRC at PEB %d, calculated %#08x, "
1045 "read %#08x", pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001046 if (!read_err)
1047 return UBI_IO_BAD_HDR;
1048 else
1049 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001050 }
1051
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001052 err = validate_vid_hdr(ubi, vid_hdr);
1053 if (err) {
1054 ubi_err("validation failed for PEB %d", pnum);
1055 return -EINVAL;
1056 }
1057
1058 return read_err ? UBI_IO_BITFLIPS : 0;
1059}
1060
1061/**
1062 * ubi_io_write_vid_hdr - write a volume identifier header.
1063 * @ubi: UBI device description object
1064 * @pnum: the physical eraseblock number to write to
1065 * @vid_hdr: the volume identifier header to write
1066 *
1067 * This function writes the volume identifier header described by @vid_hdr to
1068 * physical eraseblock @pnum. This function automatically fills the
1069 * @vid_hdr->magic and the @vid_hdr->version fields, as well as calculates
1070 * header CRC checksum and stores it at vid_hdr->hdr_crc.
1071 *
1072 * This function returns zero in case of success and a negative error code in
1073 * case of failure. If %-EIO is returned, the physical eraseblock probably went
1074 * bad.
1075 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001076int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001077 struct ubi_vid_hdr *vid_hdr)
1078{
1079 int err;
1080 uint32_t crc;
1081 void *p;
1082
1083 dbg_io("write VID header to PEB %d", pnum);
1084 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1085
1086 err = paranoid_check_peb_ec_hdr(ubi, pnum);
1087 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001088 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001089
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001090 vid_hdr->magic = cpu_to_be32(UBI_VID_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001091 vid_hdr->version = UBI_VERSION;
1092 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001093 vid_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001094
1095 err = paranoid_check_vid_hdr(ubi, pnum, vid_hdr);
1096 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001097 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001098
1099 p = (char *)vid_hdr - ubi->vid_hdr_shift;
1100 err = ubi_io_write(ubi, p, pnum, ubi->vid_hdr_aloffset,
1101 ubi->vid_hdr_alsize);
1102 return err;
1103}
1104
1105#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1106
1107/**
1108 * paranoid_check_not_bad - ensure that a physical eraseblock is not bad.
1109 * @ubi: UBI device description object
1110 * @pnum: physical eraseblock number to check
1111 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001112 * This function returns zero if the physical eraseblock is good, %-EINVAL if
1113 * it is bad and a negative error code if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001114 */
1115static int paranoid_check_not_bad(const struct ubi_device *ubi, int pnum)
1116{
1117 int err;
1118
1119 err = ubi_io_is_bad(ubi, pnum);
1120 if (!err)
1121 return err;
1122
1123 ubi_err("paranoid check failed for PEB %d", pnum);
1124 ubi_dbg_dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001125 return err > 0 ? -EINVAL : err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001126}
1127
1128/**
1129 * paranoid_check_ec_hdr - check if an erase counter header is all right.
1130 * @ubi: UBI device description object
1131 * @pnum: physical eraseblock number the erase counter header belongs to
1132 * @ec_hdr: the erase counter header to check
1133 *
1134 * This function returns zero if the erase counter header contains valid
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001135 * values, and %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001136 */
1137static int paranoid_check_ec_hdr(const struct ubi_device *ubi, int pnum,
1138 const struct ubi_ec_hdr *ec_hdr)
1139{
1140 int err;
1141 uint32_t magic;
1142
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001143 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001144 if (magic != UBI_EC_HDR_MAGIC) {
1145 ubi_err("bad magic %#08x, must be %#08x",
1146 magic, UBI_EC_HDR_MAGIC);
1147 goto fail;
1148 }
1149
1150 err = validate_ec_hdr(ubi, ec_hdr);
1151 if (err) {
1152 ubi_err("paranoid check failed for PEB %d", pnum);
1153 goto fail;
1154 }
1155
1156 return 0;
1157
1158fail:
1159 ubi_dbg_dump_ec_hdr(ec_hdr);
1160 ubi_dbg_dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001161 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001162}
1163
1164/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001165 * paranoid_check_peb_ec_hdr - check erase counter header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001166 * @ubi: UBI device description object
1167 * @pnum: the physical eraseblock number to check
1168 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001169 * This function returns zero if the erase counter header is all right and and
1170 * a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001171 */
1172static int paranoid_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum)
1173{
1174 int err;
1175 uint32_t crc, hdr_crc;
1176 struct ubi_ec_hdr *ec_hdr;
1177
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001178 ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001179 if (!ec_hdr)
1180 return -ENOMEM;
1181
1182 err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
1183 if (err && err != UBI_IO_BITFLIPS && err != -EBADMSG)
1184 goto exit;
1185
1186 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001187 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001188 if (hdr_crc != crc) {
1189 ubi_err("bad CRC, calculated %#08x, read %#08x", crc, hdr_crc);
1190 ubi_err("paranoid check failed for PEB %d", pnum);
1191 ubi_dbg_dump_ec_hdr(ec_hdr);
1192 ubi_dbg_dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001193 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001194 goto exit;
1195 }
1196
1197 err = paranoid_check_ec_hdr(ubi, pnum, ec_hdr);
1198
1199exit:
1200 kfree(ec_hdr);
1201 return err;
1202}
1203
1204/**
1205 * paranoid_check_vid_hdr - check that a volume identifier header is all right.
1206 * @ubi: UBI device description object
1207 * @pnum: physical eraseblock number the volume identifier header belongs to
1208 * @vid_hdr: the volume identifier header to check
1209 *
1210 * This function returns zero if the volume identifier header is all right, and
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001211 * %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001212 */
1213static int paranoid_check_vid_hdr(const struct ubi_device *ubi, int pnum,
1214 const struct ubi_vid_hdr *vid_hdr)
1215{
1216 int err;
1217 uint32_t magic;
1218
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001219 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001220 if (magic != UBI_VID_HDR_MAGIC) {
1221 ubi_err("bad VID header magic %#08x at PEB %d, must be %#08x",
1222 magic, pnum, UBI_VID_HDR_MAGIC);
1223 goto fail;
1224 }
1225
1226 err = validate_vid_hdr(ubi, vid_hdr);
1227 if (err) {
1228 ubi_err("paranoid check failed for PEB %d", pnum);
1229 goto fail;
1230 }
1231
1232 return err;
1233
1234fail:
1235 ubi_err("paranoid check failed for PEB %d", pnum);
1236 ubi_dbg_dump_vid_hdr(vid_hdr);
1237 ubi_dbg_dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001238 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001239
1240}
1241
1242/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001243 * paranoid_check_peb_vid_hdr - check volume identifier header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001244 * @ubi: UBI device description object
1245 * @pnum: the physical eraseblock number to check
1246 *
1247 * This function returns zero if the volume identifier header is all right,
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001248 * and a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001249 */
1250static int paranoid_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum)
1251{
1252 int err;
1253 uint32_t crc, hdr_crc;
1254 struct ubi_vid_hdr *vid_hdr;
1255 void *p;
1256
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001257 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001258 if (!vid_hdr)
1259 return -ENOMEM;
1260
1261 p = (char *)vid_hdr - ubi->vid_hdr_shift;
1262 err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
1263 ubi->vid_hdr_alsize);
1264 if (err && err != UBI_IO_BITFLIPS && err != -EBADMSG)
1265 goto exit;
1266
1267 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001268 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001269 if (hdr_crc != crc) {
1270 ubi_err("bad VID header CRC at PEB %d, calculated %#08x, "
1271 "read %#08x", pnum, crc, hdr_crc);
1272 ubi_err("paranoid check failed for PEB %d", pnum);
1273 ubi_dbg_dump_vid_hdr(vid_hdr);
1274 ubi_dbg_dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001275 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001276 goto exit;
1277 }
1278
1279 err = paranoid_check_vid_hdr(ubi, pnum, vid_hdr);
1280
1281exit:
1282 ubi_free_vid_hdr(ubi, vid_hdr);
1283 return err;
1284}
1285
1286/**
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001287 * ubi_dbg_check_write - make sure write succeeded.
1288 * @ubi: UBI device description object
1289 * @buf: buffer with data which were written
1290 * @pnum: physical eraseblock number the data were written to
1291 * @offset: offset within the physical eraseblock the data were written to
1292 * @len: how many bytes were written
1293 *
1294 * This functions reads data which were recently written and compares it with
1295 * the original data buffer - the data have to match. Returns zero if the data
1296 * match and a negative error code if not or in case of failure.
1297 */
1298int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum,
1299 int offset, int len)
1300{
1301 int err, i;
1302
1303 mutex_lock(&ubi->dbg_buf_mutex);
1304 err = ubi_io_read(ubi, ubi->dbg_peb_buf, pnum, offset, len);
1305 if (err)
1306 goto out_unlock;
1307
1308 for (i = 0; i < len; i++) {
1309 uint8_t c = ((uint8_t *)buf)[i];
1310 uint8_t c1 = ((uint8_t *)ubi->dbg_peb_buf)[i];
1311 int dump_len;
1312
1313 if (c == c1)
1314 continue;
1315
1316 ubi_err("paranoid check failed for PEB %d:%d, len %d",
1317 pnum, offset, len);
1318 ubi_msg("data differ at position %d", i);
1319 dump_len = max_t(int, 128, len - i);
1320 ubi_msg("hex dump of the original buffer from %d to %d",
1321 i, i + dump_len);
1322 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
1323 buf + i, dump_len, 1);
1324 ubi_msg("hex dump of the read buffer from %d to %d",
1325 i, i + dump_len);
1326 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
1327 ubi->dbg_peb_buf + i, dump_len, 1);
1328 ubi_dbg_dump_stack();
1329 err = -EINVAL;
1330 goto out_unlock;
1331 }
1332 mutex_unlock(&ubi->dbg_buf_mutex);
1333
1334 return 0;
1335
1336out_unlock:
1337 mutex_unlock(&ubi->dbg_buf_mutex);
1338 return err;
1339}
1340
1341/**
Artem Bityutskiy40a71a82009-06-28 19:16:55 +03001342 * ubi_dbg_check_all_ff - check that a region of flash is empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001343 * @ubi: UBI device description object
1344 * @pnum: the physical eraseblock number to check
1345 * @offset: the starting offset within the physical eraseblock to check
1346 * @len: the length of the region to check
1347 *
1348 * This function returns zero if only 0xFF bytes are present at offset
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001349 * @offset of the physical eraseblock @pnum, and a negative error code if not
1350 * or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001351 */
Artem Bityutskiy40a71a82009-06-28 19:16:55 +03001352int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001353{
1354 size_t read;
1355 int err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001356 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
1357
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001358 mutex_lock(&ubi->dbg_buf_mutex);
1359 err = ubi->mtd->read(ubi->mtd, addr, len, &read, ubi->dbg_peb_buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001360 if (err && err != -EUCLEAN) {
1361 ubi_err("error %d while reading %d bytes from PEB %d:%d, "
1362 "read %zd bytes", err, len, pnum, offset, read);
1363 goto error;
1364 }
1365
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001366 err = check_pattern(ubi->dbg_peb_buf, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001367 if (err == 0) {
1368 ubi_err("flash region at PEB %d:%d, length %d does not "
1369 "contain all 0xFF bytes", pnum, offset, len);
1370 goto fail;
1371 }
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001372 mutex_unlock(&ubi->dbg_buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001373
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001374 return 0;
1375
1376fail:
1377 ubi_err("paranoid check failed for PEB %d", pnum);
Artem Bityutskiyc8566352008-07-16 17:40:22 +03001378 ubi_msg("hex dump of the %d-%d region", offset, offset + len);
Artem Bityutskiy69866462007-08-29 14:56:20 +03001379 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001380 ubi->dbg_peb_buf, len, 1);
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001381 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001382error:
1383 ubi_dbg_dump_stack();
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001384 mutex_unlock(&ubi->dbg_buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001385 return err;
1386}
1387
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001388#endif /* CONFIG_MTD_UBI_DEBUG_PARANOID */