2 * Copyright (c) International Business Machines Corp., 2006
3 * Copyright (c) Nokia Corporation, 2006, 2007
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.
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.
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
19 * Author: Artem Bityutskiy (Битюцкий Артём)
23 * UBI input/output sub-system.
25 * 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.
29 * We are trying to have a paranoid mindset and not to trust to what we read
30 * 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.
33 * Some words about how the eraseblock headers are stored.
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
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.
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
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
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?
66 * A: because when writing a sub-page, MTD still writes a full 2K page but the
67 * 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.
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.
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.
82 * 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.
89 #include <linux/crc32.h>
90 #include <linux/err.h>
91 #include <linux/slab.h>
94 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
95 static int paranoid_check_not_bad(const struct ubi_device
*ubi
, int pnum
);
96 static int paranoid_check_peb_ec_hdr(const struct ubi_device
*ubi
, int pnum
);
97 static int paranoid_check_ec_hdr(const struct ubi_device
*ubi
, int pnum
,
98 const struct ubi_ec_hdr
*ec_hdr
);
99 static int paranoid_check_peb_vid_hdr(const struct ubi_device
*ubi
, int pnum
);
100 static int paranoid_check_vid_hdr(const struct ubi_device
*ubi
, int pnum
,
101 const struct ubi_vid_hdr
*vid_hdr
);
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
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
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
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);
126 * 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;
129 * o %-EIO if some I/O error occurred;
130 * o other negative error codes in case of other errors.
132 int ubi_io_read(const struct ubi_device
*ubi
, void *buf
, int pnum
, int offset
,
135 int err
, retries
= 0;
139 dbg_io("read %d bytes from PEB %d:%d", len
, pnum
, offset
);
141 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
142 ubi_assert(offset
>= 0 && offset
+ len
<= ubi
->peb_size
);
145 err
= paranoid_check_not_bad(ubi
, pnum
);
149 addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
151 err
= ubi
->mtd
->read(ubi
->mtd
, addr
, len
, &read
, buf
);
153 const char *errstr
= (err
== -EBADMSG
) ? " (ECC error)" : "";
155 if (err
== -EUCLEAN
) {
157 * -EUCLEAN is reported if there was a bit-flip which
158 * was corrected, so this is harmless.
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.
164 dbg_msg("fixable bit-flip detected at PEB %d", pnum
);
165 ubi_assert(len
== read
);
166 return UBI_IO_BITFLIPS
;
169 if (read
!= len
&& retries
++ < UBI_IO_RETRIES
) {
170 dbg_io("error %d%s while reading %d bytes from PEB %d:%d,"
171 " read only %zd bytes, retry",
172 err
, errstr
, len
, pnum
, offset
, read
);
177 ubi_err("error %d%s while reading %d bytes from PEB %d:%d, "
178 "read %zd bytes", err
, errstr
, len
, pnum
, offset
, read
);
179 ubi_dbg_dump_stack();
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.
186 if (read
!= len
&& err
== -EBADMSG
) {
191 ubi_assert(len
== read
);
193 if (ubi_dbg_is_bitflip()) {
194 dbg_gen("bit-flip (emulated)");
195 err
= UBI_IO_BITFLIPS
;
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
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
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.
219 int ubi_io_write(struct ubi_device
*ubi
, const void *buf
, int pnum
, int offset
,
226 dbg_io("write %d bytes to PEB %d:%d", len
, pnum
, offset
);
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);
234 ubi_err("read-only mode");
238 /* The below has to be compiled out if paranoid checks are disabled */
240 err
= paranoid_check_not_bad(ubi
, pnum
);
244 /* The area we are writing to has to contain all 0xFF bytes */
245 err
= ubi_dbg_check_all_ff(ubi
, pnum
, offset
, len
);
249 if (offset
>= ubi
->leb_start
) {
251 * We write to the data area of the physical eraseblock. Make
252 * sure it has valid EC and VID headers.
254 err
= paranoid_check_peb_ec_hdr(ubi
, pnum
);
257 err
= paranoid_check_peb_vid_hdr(ubi
, pnum
);
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();
269 addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
270 err
= ubi
->mtd
->write(ubi
->mtd
, addr
, len
, &written
, buf
);
272 ubi_err("error %d while writing %d bytes to PEB %d:%d, written "
273 "%zd bytes", err
, len
, pnum
, offset
, written
);
274 ubi_dbg_dump_stack();
275 ubi_dbg_dump_flash(ubi
, pnum
, offset
, len
);
277 ubi_assert(written
== len
);
280 err
= ubi_dbg_check_write(ubi
, buf
, pnum
, offset
, len
);
285 * Since we always write sequentially, the rest of the PEB has
286 * to contain only 0xFF bytes.
289 len
= ubi
->peb_size
- offset
;
291 err
= ubi_dbg_check_all_ff(ubi
, pnum
, offset
, len
);
298 * erase_callback - MTD erasure call-back.
299 * @ei: MTD erase information object.
301 * Note, even though MTD erase interface is asynchronous, all the current
302 * implementations are synchronous anyway.
304 static void erase_callback(struct erase_info
*ei
)
306 wake_up_interruptible((wait_queue_head_t
*)ei
->priv
);
310 * do_sync_erase - synchronously erase a physical eraseblock.
311 * @ubi: UBI device description object
312 * @pnum: the physical eraseblock number to erase
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.
318 static int do_sync_erase(struct ubi_device
*ubi
, int pnum
)
320 int err
, retries
= 0;
321 struct erase_info ei
;
322 wait_queue_head_t wq
;
324 dbg_io("erase PEB %d", pnum
);
327 init_waitqueue_head(&wq
);
328 memset(&ei
, 0, sizeof(struct erase_info
));
331 ei
.addr
= (loff_t
)pnum
* ubi
->peb_size
;
332 ei
.len
= ubi
->peb_size
;
333 ei
.callback
= erase_callback
;
334 ei
.priv
= (unsigned long)&wq
;
336 err
= ubi
->mtd
->erase(ubi
->mtd
, &ei
);
338 if (retries
++ < UBI_IO_RETRIES
) {
339 dbg_io("error %d while erasing PEB %d, retry",
344 ubi_err("cannot erase PEB %d, error %d", pnum
, err
);
345 ubi_dbg_dump_stack();
349 err
= wait_event_interruptible(wq
, ei
.state
== MTD_ERASE_DONE
||
350 ei
.state
== MTD_ERASE_FAILED
);
352 ubi_err("interrupted PEB %d erasure", pnum
);
356 if (ei
.state
== MTD_ERASE_FAILED
) {
357 if (retries
++ < UBI_IO_RETRIES
) {
358 dbg_io("error while erasing PEB %d, retry", pnum
);
362 ubi_err("cannot erase PEB %d", pnum
);
363 ubi_dbg_dump_stack();
367 err
= ubi_dbg_check_all_ff(ubi
, pnum
, 0, ubi
->peb_size
);
371 if (ubi_dbg_is_erase_failure() && !err
) {
372 dbg_err("cannot erase PEB %d (emulated)", pnum
);
379 /* Patterns to write to a physical eraseblock when torturing it */
380 static uint8_t patterns
[] = {0xa5, 0x5a, 0x0};
383 * torture_peb - test a supposedly bad physical eraseblock.
384 * @ubi: UBI device description object
385 * @pnum: the physical eraseblock number to test
387 * This function returns %-EIO if the physical eraseblock did not pass the
388 * test, a positive number of erase operations done if the test was
389 * successfully passed, and other negative error codes in case of other errors.
391 static int torture_peb(struct ubi_device
*ubi
, int pnum
)
393 int err
, i
, patt_count
;
395 ubi_msg("run torture test for PEB %d", pnum
);
396 patt_count
= ARRAY_SIZE(patterns
);
397 ubi_assert(patt_count
> 0);
399 mutex_lock(&ubi
->buf_mutex
);
400 for (i
= 0; i
< patt_count
; i
++) {
401 err
= do_sync_erase(ubi
, pnum
);
405 /* Make sure the PEB contains only 0xFF bytes */
406 err
= ubi_io_read(ubi
, ubi
->peb_buf1
, pnum
, 0, ubi
->peb_size
);
410 err
= ubi_check_pattern(ubi
->peb_buf1
, 0xFF, ubi
->peb_size
);
412 ubi_err("erased PEB %d, but a non-0xFF byte found",
418 /* Write a pattern and check it */
419 memset(ubi
->peb_buf1
, patterns
[i
], ubi
->peb_size
);
420 err
= ubi_io_write(ubi
, ubi
->peb_buf1
, pnum
, 0, ubi
->peb_size
);
424 memset(ubi
->peb_buf1
, ~patterns
[i
], ubi
->peb_size
);
425 err
= ubi_io_read(ubi
, ubi
->peb_buf1
, pnum
, 0, ubi
->peb_size
);
429 err
= ubi_check_pattern(ubi
->peb_buf1
, patterns
[i
],
432 ubi_err("pattern %x checking failed for PEB %d",
440 ubi_msg("PEB %d passed torture test, do not mark it a bad", pnum
);
443 mutex_unlock(&ubi
->buf_mutex
);
444 if (err
== UBI_IO_BITFLIPS
|| err
== -EBADMSG
) {
446 * If a bit-flip or data integrity error was detected, the test
447 * has not passed because it happened on a freshly erased
448 * physical eraseblock which means something is wrong with it.
450 ubi_err("read problems on freshly erased PEB %d, must be bad",
458 * nor_erase_prepare - prepare a NOR flash PEB for erasure.
459 * @ubi: UBI device description object
460 * @pnum: physical eraseblock number to prepare
462 * NOR flash, or at least some of them, have peculiar embedded PEB erasure
463 * algorithm: the PEB is first filled with zeroes, then it is erased. And
464 * filling with zeroes starts from the end of the PEB. This was observed with
465 * Spansion S29GL512N NOR flash.
467 * This means that in case of a power cut we may end up with intact data at the
468 * beginning of the PEB, and all zeroes at the end of PEB. In other words, the
469 * EC and VID headers are OK, but a large chunk of data at the end of PEB is
470 * zeroed. This makes UBI mistakenly treat this PEB as used and associate it
471 * with an LEB, which leads to subsequent failures (e.g., UBIFS fails).
473 * This function is called before erasing NOR PEBs and it zeroes out EC and VID
474 * magic numbers in order to invalidate them and prevent the failures. Returns
475 * zero in case of success and a negative error code in case of failure.
477 static int nor_erase_prepare(struct ubi_device
*ubi
, int pnum
)
483 struct ubi_vid_hdr vid_hdr
;
485 addr
= (loff_t
)pnum
* ubi
->peb_size
+ ubi
->vid_hdr_aloffset
;
486 err
= ubi
->mtd
->write(ubi
->mtd
, addr
, 4, &written
, (void *)&data
);
488 addr
-= ubi
->vid_hdr_aloffset
;
489 err
= ubi
->mtd
->write(ubi
->mtd
, addr
, 4, &written
,
496 * We failed to write to the media. This was observed with Spansion
497 * S29GL512N NOR flash. Most probably the eraseblock erasure was
498 * interrupted at a very inappropriate moment, so it became unwritable.
499 * In this case we probably anyway have garbage in this PEB.
501 err1
= ubi_io_read_vid_hdr(ubi
, pnum
, &vid_hdr
, 0);
502 if (err1
== UBI_IO_BAD_HDR_EBADMSG
|| err1
== UBI_IO_BAD_HDR
)
504 * The VID header is corrupted, so we can safely erase this
505 * PEB and not afraid that it will be treated as a valid PEB in
506 * case of an unclean reboot.
511 * The PEB contains a valid VID header, but we cannot invalidate it.
512 * Supposedly the flash media or the driver is screwed up, so return an
515 ubi_err("cannot invalidate PEB %d, write returned %d read returned %d",
517 ubi_dbg_dump_flash(ubi
, pnum
, 0, ubi
->peb_size
);
522 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
523 * @ubi: UBI device description object
524 * @pnum: physical eraseblock number to erase
525 * @torture: if this physical eraseblock has to be tortured
527 * This function synchronously erases physical eraseblock @pnum. If @torture
528 * flag is not zero, the physical eraseblock is checked by means of writing
529 * different patterns to it and reading them back. If the torturing is enabled,
530 * the physical eraseblock is erased more than once.
532 * This function returns the number of erasures made in case of success, %-EIO
533 * if the erasure failed or the torturing test failed, and other negative error
534 * codes in case of other errors. Note, %-EIO means that the physical
537 int ubi_io_sync_erase(struct ubi_device
*ubi
, int pnum
, int torture
)
541 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
543 err
= paranoid_check_not_bad(ubi
, pnum
);
548 ubi_err("read-only mode");
552 if (ubi
->nor_flash
) {
553 err
= nor_erase_prepare(ubi
, pnum
);
559 ret
= torture_peb(ubi
, pnum
);
564 err
= do_sync_erase(ubi
, pnum
);
572 * ubi_io_is_bad - check if a physical eraseblock is bad.
573 * @ubi: UBI device description object
574 * @pnum: the physical eraseblock number to check
576 * This function returns a positive number if the physical eraseblock is bad,
577 * zero if not, and a negative error code if an error occurred.
579 int ubi_io_is_bad(const struct ubi_device
*ubi
, int pnum
)
581 struct mtd_info
*mtd
= ubi
->mtd
;
583 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
585 if (ubi
->bad_allowed
) {
588 ret
= mtd
->block_isbad(mtd
, (loff_t
)pnum
* ubi
->peb_size
);
590 ubi_err("error %d while checking if PEB %d is bad",
593 dbg_io("PEB %d is bad", pnum
);
601 * ubi_io_mark_bad - mark a physical eraseblock as bad.
602 * @ubi: UBI device description object
603 * @pnum: the physical eraseblock number to mark
605 * This function returns zero in case of success and a negative error code in
608 int ubi_io_mark_bad(const struct ubi_device
*ubi
, int pnum
)
611 struct mtd_info
*mtd
= ubi
->mtd
;
613 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
616 ubi_err("read-only mode");
620 if (!ubi
->bad_allowed
)
623 err
= mtd
->block_markbad(mtd
, (loff_t
)pnum
* ubi
->peb_size
);
625 ubi_err("cannot mark PEB %d bad, error %d", pnum
, err
);
630 * validate_ec_hdr - validate an erase counter header.
631 * @ubi: UBI device description object
632 * @ec_hdr: the erase counter header to check
634 * This function returns zero if the erase counter header is OK, and %1 if
637 static int validate_ec_hdr(const struct ubi_device
*ubi
,
638 const struct ubi_ec_hdr
*ec_hdr
)
641 int vid_hdr_offset
, leb_start
;
643 ec
= be64_to_cpu(ec_hdr
->ec
);
644 vid_hdr_offset
= be32_to_cpu(ec_hdr
->vid_hdr_offset
);
645 leb_start
= be32_to_cpu(ec_hdr
->data_offset
);
647 if (ec_hdr
->version
!= UBI_VERSION
) {
648 ubi_err("node with incompatible UBI version found: "
649 "this UBI version is %d, image version is %d",
650 UBI_VERSION
, (int)ec_hdr
->version
);
654 if (vid_hdr_offset
!= ubi
->vid_hdr_offset
) {
655 ubi_err("bad VID header offset %d, expected %d",
656 vid_hdr_offset
, ubi
->vid_hdr_offset
);
660 if (leb_start
!= ubi
->leb_start
) {
661 ubi_err("bad data offset %d, expected %d",
662 leb_start
, ubi
->leb_start
);
666 if (ec
< 0 || ec
> UBI_MAX_ERASECOUNTER
) {
667 ubi_err("bad erase counter %lld", ec
);
674 ubi_err("bad EC header");
675 ubi_dbg_dump_ec_hdr(ec_hdr
);
676 ubi_dbg_dump_stack();
681 * ubi_io_read_ec_hdr - read and check an erase counter header.
682 * @ubi: UBI device description object
683 * @pnum: physical eraseblock to read from
684 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
686 * @verbose: be verbose if the header is corrupted or was not found
688 * This function reads erase counter header from physical eraseblock @pnum and
689 * stores it in @ec_hdr. This function also checks CRC checksum of the read
690 * erase counter header. The following codes may be returned:
692 * o %0 if the CRC checksum is correct and the header was successfully read;
693 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
694 * and corrected by the flash driver; this is harmless but may indicate that
695 * this eraseblock may become bad soon (but may be not);
696 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
697 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
698 * a data integrity error (uncorrectable ECC error in case of NAND);
699 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
700 * o a negative error code in case of failure.
702 int ubi_io_read_ec_hdr(struct ubi_device
*ubi
, int pnum
,
703 struct ubi_ec_hdr
*ec_hdr
, int verbose
)
706 uint32_t crc
, magic
, hdr_crc
;
708 dbg_io("read EC header from PEB %d", pnum
);
709 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
711 read_err
= ubi_io_read(ubi
, ec_hdr
, pnum
, 0, UBI_EC_HDR_SIZE
);
713 if (read_err
!= UBI_IO_BITFLIPS
&& read_err
!= -EBADMSG
)
717 * We read all the data, but either a correctable bit-flip
718 * occurred, or MTD reported a data integrity error
719 * (uncorrectable ECC error in case of NAND). The former is
720 * harmless, the later may mean that the read data is
721 * corrupted. But we have a CRC check-sum and we will detect
722 * this. If the EC header is still OK, we just report this as
723 * there was a bit-flip, to force scrubbing.
727 magic
= be32_to_cpu(ec_hdr
->magic
);
728 if (magic
!= UBI_EC_HDR_MAGIC
) {
729 if (read_err
== -EBADMSG
)
730 return UBI_IO_BAD_HDR_EBADMSG
;
733 * The magic field is wrong. Let's check if we have read all
734 * 0xFF. If yes, this physical eraseblock is assumed to be
737 if (ubi_check_pattern(ec_hdr
, 0xFF, UBI_EC_HDR_SIZE
)) {
738 /* The physical eraseblock is supposedly empty */
740 ubi_warn("no EC header found at PEB %d, "
741 "only 0xFF bytes", pnum
);
742 else if (UBI_IO_DEBUG
)
743 dbg_msg("no EC header found at PEB %d, "
744 "only 0xFF bytes", pnum
);
748 return UBI_IO_FF_BITFLIPS
;
752 * This is not a valid erase counter header, and these are not
753 * 0xFF bytes. Report that the header is corrupted.
756 ubi_warn("bad magic number at PEB %d: %08x instead of "
757 "%08x", pnum
, magic
, UBI_EC_HDR_MAGIC
);
758 ubi_dbg_dump_ec_hdr(ec_hdr
);
759 } else if (UBI_IO_DEBUG
)
760 dbg_msg("bad magic number at PEB %d: %08x instead of "
761 "%08x", pnum
, magic
, UBI_EC_HDR_MAGIC
);
762 return UBI_IO_BAD_HDR
;
765 crc
= crc32(UBI_CRC32_INIT
, ec_hdr
, UBI_EC_HDR_SIZE_CRC
);
766 hdr_crc
= be32_to_cpu(ec_hdr
->hdr_crc
);
768 if (hdr_crc
!= crc
) {
770 ubi_warn("bad EC header CRC at PEB %d, calculated "
771 "%#08x, read %#08x", pnum
, crc
, hdr_crc
);
772 ubi_dbg_dump_ec_hdr(ec_hdr
);
773 } else if (UBI_IO_DEBUG
)
774 dbg_msg("bad EC header CRC at PEB %d, calculated "
775 "%#08x, read %#08x", pnum
, crc
, hdr_crc
);
778 return UBI_IO_BAD_HDR
;
780 return UBI_IO_BAD_HDR_EBADMSG
;
783 /* And of course validate what has just been read from the media */
784 err
= validate_ec_hdr(ubi
, ec_hdr
);
786 ubi_err("validation failed for PEB %d", pnum
);
791 * If there was %-EBADMSG, but the header CRC is still OK, report about
792 * a bit-flip to force scrubbing on this PEB.
794 return read_err
? UBI_IO_BITFLIPS
: 0;
798 * ubi_io_write_ec_hdr - write an erase counter header.
799 * @ubi: UBI device description object
800 * @pnum: physical eraseblock to write to
801 * @ec_hdr: the erase counter header to write
803 * This function writes erase counter header described by @ec_hdr to physical
804 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
805 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
808 * This function returns zero in case of success and a negative error code in
809 * case of failure. If %-EIO is returned, the physical eraseblock most probably
812 int ubi_io_write_ec_hdr(struct ubi_device
*ubi
, int pnum
,
813 struct ubi_ec_hdr
*ec_hdr
)
818 dbg_io("write EC header to PEB %d", pnum
);
819 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
821 ec_hdr
->magic
= cpu_to_be32(UBI_EC_HDR_MAGIC
);
822 ec_hdr
->version
= UBI_VERSION
;
823 ec_hdr
->vid_hdr_offset
= cpu_to_be32(ubi
->vid_hdr_offset
);
824 ec_hdr
->data_offset
= cpu_to_be32(ubi
->leb_start
);
825 ec_hdr
->image_seq
= cpu_to_be32(ubi
->image_seq
);
826 crc
= crc32(UBI_CRC32_INIT
, ec_hdr
, UBI_EC_HDR_SIZE_CRC
);
827 ec_hdr
->hdr_crc
= cpu_to_be32(crc
);
829 err
= paranoid_check_ec_hdr(ubi
, pnum
, ec_hdr
);
833 err
= ubi_io_write(ubi
, ec_hdr
, pnum
, 0, ubi
->ec_hdr_alsize
);
838 * validate_vid_hdr - validate a volume identifier header.
839 * @ubi: UBI device description object
840 * @vid_hdr: the volume identifier header to check
842 * This function checks that data stored in the volume identifier header
843 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
845 static int validate_vid_hdr(const struct ubi_device
*ubi
,
846 const struct ubi_vid_hdr
*vid_hdr
)
848 int vol_type
= vid_hdr
->vol_type
;
849 int copy_flag
= vid_hdr
->copy_flag
;
850 int vol_id
= be32_to_cpu(vid_hdr
->vol_id
);
851 int lnum
= be32_to_cpu(vid_hdr
->lnum
);
852 int compat
= vid_hdr
->compat
;
853 int data_size
= be32_to_cpu(vid_hdr
->data_size
);
854 int used_ebs
= be32_to_cpu(vid_hdr
->used_ebs
);
855 int data_pad
= be32_to_cpu(vid_hdr
->data_pad
);
856 int data_crc
= be32_to_cpu(vid_hdr
->data_crc
);
857 int usable_leb_size
= ubi
->leb_size
- data_pad
;
859 if (copy_flag
!= 0 && copy_flag
!= 1) {
860 dbg_err("bad copy_flag");
864 if (vol_id
< 0 || lnum
< 0 || data_size
< 0 || used_ebs
< 0 ||
866 dbg_err("negative values");
870 if (vol_id
>= UBI_MAX_VOLUMES
&& vol_id
< UBI_INTERNAL_VOL_START
) {
871 dbg_err("bad vol_id");
875 if (vol_id
< UBI_INTERNAL_VOL_START
&& compat
!= 0) {
876 dbg_err("bad compat");
880 if (vol_id
>= UBI_INTERNAL_VOL_START
&& compat
!= UBI_COMPAT_DELETE
&&
881 compat
!= UBI_COMPAT_RO
&& compat
!= UBI_COMPAT_PRESERVE
&&
882 compat
!= UBI_COMPAT_REJECT
) {
883 dbg_err("bad compat");
887 if (vol_type
!= UBI_VID_DYNAMIC
&& vol_type
!= UBI_VID_STATIC
) {
888 dbg_err("bad vol_type");
892 if (data_pad
>= ubi
->leb_size
/ 2) {
893 dbg_err("bad data_pad");
897 if (vol_type
== UBI_VID_STATIC
) {
899 * Although from high-level point of view static volumes may
900 * contain zero bytes of data, but no VID headers can contain
901 * zero at these fields, because they empty volumes do not have
902 * mapped logical eraseblocks.
905 dbg_err("zero used_ebs");
908 if (data_size
== 0) {
909 dbg_err("zero data_size");
912 if (lnum
< used_ebs
- 1) {
913 if (data_size
!= usable_leb_size
) {
914 dbg_err("bad data_size");
917 } else if (lnum
== used_ebs
- 1) {
918 if (data_size
== 0) {
919 dbg_err("bad data_size at last LEB");
923 dbg_err("too high lnum");
927 if (copy_flag
== 0) {
929 dbg_err("non-zero data CRC");
932 if (data_size
!= 0) {
933 dbg_err("non-zero data_size");
937 if (data_size
== 0) {
938 dbg_err("zero data_size of copy");
943 dbg_err("bad used_ebs");
951 ubi_err("bad VID header");
952 ubi_dbg_dump_vid_hdr(vid_hdr
);
953 ubi_dbg_dump_stack();
958 * ubi_io_read_vid_hdr - read and check a volume identifier header.
959 * @ubi: UBI device description object
960 * @pnum: physical eraseblock number to read from
961 * @vid_hdr: &struct ubi_vid_hdr object where to store the read volume
963 * @verbose: be verbose if the header is corrupted or wasn't found
965 * This function reads the volume identifier header from physical eraseblock
966 * @pnum and stores it in @vid_hdr. It also checks CRC checksum of the read
967 * volume identifier header. The error codes are the same as in
968 * 'ubi_io_read_ec_hdr()'.
970 * Note, the implementation of this function is also very similar to
971 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
973 int ubi_io_read_vid_hdr(struct ubi_device
*ubi
, int pnum
,
974 struct ubi_vid_hdr
*vid_hdr
, int verbose
)
977 uint32_t crc
, magic
, hdr_crc
;
980 dbg_io("read VID header from PEB %d", pnum
);
981 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
983 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
984 read_err
= ubi_io_read(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
985 ubi
->vid_hdr_alsize
);
986 if (read_err
&& read_err
!= UBI_IO_BITFLIPS
&& read_err
!= -EBADMSG
)
989 magic
= be32_to_cpu(vid_hdr
->magic
);
990 if (magic
!= UBI_VID_HDR_MAGIC
) {
991 if (read_err
== -EBADMSG
)
992 return UBI_IO_BAD_HDR_EBADMSG
;
994 if (ubi_check_pattern(vid_hdr
, 0xFF, UBI_VID_HDR_SIZE
)) {
996 ubi_warn("no VID header found at PEB %d, "
997 "only 0xFF bytes", pnum
);
998 else if (UBI_IO_DEBUG
)
999 dbg_msg("no VID header found at PEB %d, "
1000 "only 0xFF bytes", pnum
);
1004 return UBI_IO_FF_BITFLIPS
;
1008 ubi_warn("bad magic number at PEB %d: %08x instead of "
1009 "%08x", pnum
, magic
, UBI_VID_HDR_MAGIC
);
1010 ubi_dbg_dump_vid_hdr(vid_hdr
);
1011 } else if (UBI_IO_DEBUG
)
1012 dbg_msg("bad magic number at PEB %d: %08x instead of "
1013 "%08x", pnum
, magic
, UBI_VID_HDR_MAGIC
);
1014 return UBI_IO_BAD_HDR
;
1017 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_VID_HDR_SIZE_CRC
);
1018 hdr_crc
= be32_to_cpu(vid_hdr
->hdr_crc
);
1020 if (hdr_crc
!= crc
) {
1022 ubi_warn("bad CRC at PEB %d, calculated %#08x, "
1023 "read %#08x", pnum
, crc
, hdr_crc
);
1024 ubi_dbg_dump_vid_hdr(vid_hdr
);
1025 } else if (UBI_IO_DEBUG
)
1026 dbg_msg("bad CRC at PEB %d, calculated %#08x, "
1027 "read %#08x", pnum
, crc
, hdr_crc
);
1029 return UBI_IO_BAD_HDR
;
1031 return UBI_IO_BAD_HDR_EBADMSG
;
1034 err
= validate_vid_hdr(ubi
, vid_hdr
);
1036 ubi_err("validation failed for PEB %d", pnum
);
1040 return read_err
? UBI_IO_BITFLIPS
: 0;
1044 * ubi_io_write_vid_hdr - write a volume identifier header.
1045 * @ubi: UBI device description object
1046 * @pnum: the physical eraseblock number to write to
1047 * @vid_hdr: the volume identifier header to write
1049 * This function writes the volume identifier header described by @vid_hdr to
1050 * physical eraseblock @pnum. This function automatically fills the
1051 * @vid_hdr->magic and the @vid_hdr->version fields, as well as calculates
1052 * header CRC checksum and stores it at vid_hdr->hdr_crc.
1054 * This function returns zero in case of success and a negative error code in
1055 * case of failure. If %-EIO is returned, the physical eraseblock probably went
1058 int ubi_io_write_vid_hdr(struct ubi_device
*ubi
, int pnum
,
1059 struct ubi_vid_hdr
*vid_hdr
)
1065 dbg_io("write VID header to PEB %d", pnum
);
1066 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
1068 err
= paranoid_check_peb_ec_hdr(ubi
, pnum
);
1072 vid_hdr
->magic
= cpu_to_be32(UBI_VID_HDR_MAGIC
);
1073 vid_hdr
->version
= UBI_VERSION
;
1074 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_VID_HDR_SIZE_CRC
);
1075 vid_hdr
->hdr_crc
= cpu_to_be32(crc
);
1077 err
= paranoid_check_vid_hdr(ubi
, pnum
, vid_hdr
);
1081 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
1082 err
= ubi_io_write(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
1083 ubi
->vid_hdr_alsize
);
1087 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1090 * paranoid_check_not_bad - ensure that a physical eraseblock is not bad.
1091 * @ubi: UBI device description object
1092 * @pnum: physical eraseblock number to check
1094 * This function returns zero if the physical eraseblock is good, %-EINVAL if
1095 * it is bad and a negative error code if an error occurred.
1097 static int paranoid_check_not_bad(const struct ubi_device
*ubi
, int pnum
)
1101 err
= ubi_io_is_bad(ubi
, pnum
);
1105 ubi_err("paranoid check failed for PEB %d", pnum
);
1106 ubi_dbg_dump_stack();
1107 return err
> 0 ? -EINVAL
: err
;
1111 * paranoid_check_ec_hdr - check if an erase counter header is all right.
1112 * @ubi: UBI device description object
1113 * @pnum: physical eraseblock number the erase counter header belongs to
1114 * @ec_hdr: the erase counter header to check
1116 * This function returns zero if the erase counter header contains valid
1117 * values, and %-EINVAL if not.
1119 static int paranoid_check_ec_hdr(const struct ubi_device
*ubi
, int pnum
,
1120 const struct ubi_ec_hdr
*ec_hdr
)
1125 magic
= be32_to_cpu(ec_hdr
->magic
);
1126 if (magic
!= UBI_EC_HDR_MAGIC
) {
1127 ubi_err("bad magic %#08x, must be %#08x",
1128 magic
, UBI_EC_HDR_MAGIC
);
1132 err
= validate_ec_hdr(ubi
, ec_hdr
);
1134 ubi_err("paranoid check failed for PEB %d", pnum
);
1141 ubi_dbg_dump_ec_hdr(ec_hdr
);
1142 ubi_dbg_dump_stack();
1147 * paranoid_check_peb_ec_hdr - check erase counter header.
1148 * @ubi: UBI device description object
1149 * @pnum: the physical eraseblock number to check
1151 * This function returns zero if the erase counter header is all right and and
1152 * a negative error code if not or if an error occurred.
1154 static int paranoid_check_peb_ec_hdr(const struct ubi_device
*ubi
, int pnum
)
1157 uint32_t crc
, hdr_crc
;
1158 struct ubi_ec_hdr
*ec_hdr
;
1160 ec_hdr
= kzalloc(ubi
->ec_hdr_alsize
, GFP_NOFS
);
1164 err
= ubi_io_read(ubi
, ec_hdr
, pnum
, 0, UBI_EC_HDR_SIZE
);
1165 if (err
&& err
!= UBI_IO_BITFLIPS
&& err
!= -EBADMSG
)
1168 crc
= crc32(UBI_CRC32_INIT
, ec_hdr
, UBI_EC_HDR_SIZE_CRC
);
1169 hdr_crc
= be32_to_cpu(ec_hdr
->hdr_crc
);
1170 if (hdr_crc
!= crc
) {
1171 ubi_err("bad CRC, calculated %#08x, read %#08x", crc
, hdr_crc
);
1172 ubi_err("paranoid check failed for PEB %d", pnum
);
1173 ubi_dbg_dump_ec_hdr(ec_hdr
);
1174 ubi_dbg_dump_stack();
1179 err
= paranoid_check_ec_hdr(ubi
, pnum
, ec_hdr
);
1187 * paranoid_check_vid_hdr - check that a volume identifier header is all right.
1188 * @ubi: UBI device description object
1189 * @pnum: physical eraseblock number the volume identifier header belongs to
1190 * @vid_hdr: the volume identifier header to check
1192 * This function returns zero if the volume identifier header is all right, and
1195 static int paranoid_check_vid_hdr(const struct ubi_device
*ubi
, int pnum
,
1196 const struct ubi_vid_hdr
*vid_hdr
)
1201 magic
= be32_to_cpu(vid_hdr
->magic
);
1202 if (magic
!= UBI_VID_HDR_MAGIC
) {
1203 ubi_err("bad VID header magic %#08x at PEB %d, must be %#08x",
1204 magic
, pnum
, UBI_VID_HDR_MAGIC
);
1208 err
= validate_vid_hdr(ubi
, vid_hdr
);
1210 ubi_err("paranoid check failed for PEB %d", pnum
);
1217 ubi_err("paranoid check failed for PEB %d", pnum
);
1218 ubi_dbg_dump_vid_hdr(vid_hdr
);
1219 ubi_dbg_dump_stack();
1225 * paranoid_check_peb_vid_hdr - check volume identifier header.
1226 * @ubi: UBI device description object
1227 * @pnum: the physical eraseblock number to check
1229 * This function returns zero if the volume identifier header is all right,
1230 * and a negative error code if not or if an error occurred.
1232 static int paranoid_check_peb_vid_hdr(const struct ubi_device
*ubi
, int pnum
)
1235 uint32_t crc
, hdr_crc
;
1236 struct ubi_vid_hdr
*vid_hdr
;
1239 vid_hdr
= ubi_zalloc_vid_hdr(ubi
, GFP_NOFS
);
1243 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
1244 err
= ubi_io_read(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
1245 ubi
->vid_hdr_alsize
);
1246 if (err
&& err
!= UBI_IO_BITFLIPS
&& err
!= -EBADMSG
)
1249 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_EC_HDR_SIZE_CRC
);
1250 hdr_crc
= be32_to_cpu(vid_hdr
->hdr_crc
);
1251 if (hdr_crc
!= crc
) {
1252 ubi_err("bad VID header CRC at PEB %d, calculated %#08x, "
1253 "read %#08x", pnum
, crc
, hdr_crc
);
1254 ubi_err("paranoid check failed for PEB %d", pnum
);
1255 ubi_dbg_dump_vid_hdr(vid_hdr
);
1256 ubi_dbg_dump_stack();
1261 err
= paranoid_check_vid_hdr(ubi
, pnum
, vid_hdr
);
1264 ubi_free_vid_hdr(ubi
, vid_hdr
);
1269 * ubi_dbg_check_write - make sure write succeeded.
1270 * @ubi: UBI device description object
1271 * @buf: buffer with data which were written
1272 * @pnum: physical eraseblock number the data were written to
1273 * @offset: offset within the physical eraseblock the data were written to
1274 * @len: how many bytes were written
1276 * This functions reads data which were recently written and compares it with
1277 * the original data buffer - the data have to match. Returns zero if the data
1278 * match and a negative error code if not or in case of failure.
1280 int ubi_dbg_check_write(struct ubi_device
*ubi
, const void *buf
, int pnum
,
1281 int offset
, int len
)
1285 mutex_lock(&ubi
->dbg_buf_mutex
);
1286 err
= ubi_io_read(ubi
, ubi
->dbg_peb_buf
, pnum
, offset
, len
);
1290 for (i
= 0; i
< len
; i
++) {
1291 uint8_t c
= ((uint8_t *)buf
)[i
];
1292 uint8_t c1
= ((uint8_t *)ubi
->dbg_peb_buf
)[i
];
1298 ubi_err("paranoid check failed for PEB %d:%d, len %d",
1300 ubi_msg("data differ at position %d", i
);
1301 dump_len
= max_t(int, 128, len
- i
);
1302 ubi_msg("hex dump of the original buffer from %d to %d",
1304 print_hex_dump(KERN_DEBUG
, "", DUMP_PREFIX_OFFSET
, 32, 1,
1305 buf
+ i
, dump_len
, 1);
1306 ubi_msg("hex dump of the read buffer from %d to %d",
1308 print_hex_dump(KERN_DEBUG
, "", DUMP_PREFIX_OFFSET
, 32, 1,
1309 ubi
->dbg_peb_buf
+ i
, dump_len
, 1);
1310 ubi_dbg_dump_stack();
1314 mutex_unlock(&ubi
->dbg_buf_mutex
);
1319 mutex_unlock(&ubi
->dbg_buf_mutex
);
1324 * ubi_dbg_check_all_ff - check that a region of flash is empty.
1325 * @ubi: UBI device description object
1326 * @pnum: the physical eraseblock number to check
1327 * @offset: the starting offset within the physical eraseblock to check
1328 * @len: the length of the region to check
1330 * This function returns zero if only 0xFF bytes are present at offset
1331 * @offset of the physical eraseblock @pnum, and a negative error code if not
1332 * or if an error occurred.
1334 int ubi_dbg_check_all_ff(struct ubi_device
*ubi
, int pnum
, int offset
, int len
)
1338 loff_t addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
1340 mutex_lock(&ubi
->dbg_buf_mutex
);
1341 err
= ubi
->mtd
->read(ubi
->mtd
, addr
, len
, &read
, ubi
->dbg_peb_buf
);
1342 if (err
&& err
!= -EUCLEAN
) {
1343 ubi_err("error %d while reading %d bytes from PEB %d:%d, "
1344 "read %zd bytes", err
, len
, pnum
, offset
, read
);
1348 err
= ubi_check_pattern(ubi
->dbg_peb_buf
, 0xFF, len
);
1350 ubi_err("flash region at PEB %d:%d, length %d does not "
1351 "contain all 0xFF bytes", pnum
, offset
, len
);
1354 mutex_unlock(&ubi
->dbg_buf_mutex
);
1359 ubi_err("paranoid check failed for PEB %d", pnum
);
1360 ubi_msg("hex dump of the %d-%d region", offset
, offset
+ len
);
1361 print_hex_dump(KERN_DEBUG
, "", DUMP_PREFIX_OFFSET
, 32, 1,
1362 ubi
->dbg_peb_buf
, len
, 1);
1365 ubi_dbg_dump_stack();
1366 mutex_unlock(&ubi
->dbg_buf_mutex
);
1370 #endif /* CONFIG_MTD_UBI_DEBUG_PARANOID */