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>
93 #ifdef CONFIG_PWR_LOSS_MTK_SPOH
94 #include <mach/power_loss_test.h>
97 static int self_check_not_bad(const struct ubi_device
*ubi
, int pnum
);
98 static int self_check_peb_ec_hdr(const struct ubi_device
*ubi
, int pnum
);
99 static int self_check_ec_hdr(const struct ubi_device
*ubi
, int pnum
,
100 const struct ubi_ec_hdr
*ec_hdr
);
101 static int self_check_peb_vid_hdr(const struct ubi_device
*ubi
, int pnum
);
102 static int self_check_vid_hdr(const struct ubi_device
*ubi
, int pnum
,
103 const struct ubi_vid_hdr
*vid_hdr
);
104 static int self_check_write(struct ubi_device
*ubi
, const void *buf
, int pnum
,
105 int offset
, int len
);
108 * ubi_io_read - read data from a physical eraseblock.
109 * @ubi: UBI device description object
110 * @buf: buffer where to store the read data
111 * @pnum: physical eraseblock number to read from
112 * @offset: offset within the physical eraseblock from where to read
113 * @len: how many bytes to read
115 * This function reads data from offset @offset of physical eraseblock @pnum
116 * and stores the read data in the @buf buffer. The following return codes are
119 * o %0 if all the requested data were successfully read;
120 * o %UBI_IO_BITFLIPS if all the requested data were successfully read, but
121 * correctable bit-flips were detected; this is harmless but may indicate
122 * that this eraseblock may become bad soon (but do not have to);
123 * o %-EBADMSG if the MTD subsystem reported about data integrity problems, for
124 * example it can be an ECC error in case of NAND; this most probably means
125 * that the data is corrupted;
126 * o %-EIO if some I/O error occurred;
127 * o other negative error codes in case of other errors.
129 int ubi_io_read(const struct ubi_device
*ubi
, void *buf
, int pnum
, int offset
,
132 int err
, retries
= 0;
136 dbg_io("read %d bytes from PEB %d:%d", len
, pnum
, offset
);
138 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
139 ubi_assert(offset
>= 0 && offset
+ len
<= ubi
->peb_size
);
142 err
= self_check_not_bad(ubi
, pnum
);
147 * Deliberately corrupt the buffer to improve robustness. Indeed, if we
148 * do not do this, the following may happen:
149 * 1. The buffer contains data from previous operation, e.g., read from
150 * another PEB previously. The data looks like expected, e.g., if we
151 * just do not read anything and return - the caller would not
152 * notice this. E.g., if we are reading a VID header, the buffer may
153 * contain a valid VID header from another PEB.
154 * 2. The driver is buggy and returns us success or -EBADMSG or
155 * -EUCLEAN, but it does not actually put any data to the buffer.
157 * This may confuse UBI or upper layers - they may think the buffer
158 * contains valid data while in fact it is just old data. This is
159 * especially possible because UBI (and UBIFS) relies on CRC, and
160 * treats data as correct even in case of ECC errors if the CRC is
163 * Try to prevent this situation by changing the first byte of the
166 *((uint8_t *)buf
) ^= 0xFF;
168 addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
170 err
= mtd_read(ubi
->mtd
, addr
, len
, &read
, buf
);
172 const char *errstr
= mtd_is_eccerr(err
) ? " (ECC error)" : "";
174 if (mtd_is_bitflip(err
)) {
176 * -EUCLEAN is reported if there was a bit-flip which
177 * was corrected, so this is harmless.
179 * We do not report about it here unless debugging is
180 * enabled. A corresponding message will be printed
181 * later, when it is has been scrubbed.
183 ubi_msg("fixable bit-flip detected at PEB %d", pnum
);
184 ubi_assert(len
== read
);
185 return UBI_IO_BITFLIPS
;
188 if (retries
++ < UBI_IO_RETRIES
) {
189 ubi_warn("error %d%s while reading %d bytes from PEB %d:%d, read only %zd bytes, retry",
190 err
, errstr
, len
, pnum
, offset
, read
);
195 ubi_err("error %d%s while reading %d bytes from PEB %d:%d, read %zd bytes",
196 err
, errstr
, len
, pnum
, offset
, read
);
200 * The driver should never return -EBADMSG if it failed to read
201 * all the requested data. But some buggy drivers might do
202 * this, so we change it to -EIO.
204 if (read
!= len
&& mtd_is_eccerr(err
)) {
209 ubi_assert(len
== read
);
211 if (ubi_dbg_is_bitflip(ubi
)) {
212 dbg_gen("bit-flip (emulated)");
213 err
= UBI_IO_BITFLIPS
;
221 * ubi_io_write - write data to a physical eraseblock.
222 * @ubi: UBI device description object
223 * @buf: buffer with the data to write
224 * @pnum: physical eraseblock number to write to
225 * @offset: offset within the physical eraseblock where to write
226 * @len: how many bytes to write
228 * This function writes @len bytes of data from buffer @buf to offset @offset
229 * of physical eraseblock @pnum. If all the data were successfully written,
230 * zero is returned. If an error occurred, this function returns a negative
231 * error code. If %-EIO is returned, the physical eraseblock most probably went
234 * Note, in case of an error, it is possible that something was still written
235 * to the flash media, but may be some garbage.
237 int ubi_io_write(struct ubi_device
*ubi
, const void *buf
, int pnum
, int offset
,
244 dbg_io("write %d bytes to PEB %d:%d", len
, pnum
, offset
);
246 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
247 ubi_assert(offset
>= 0 && offset
+ len
<= ubi
->peb_size
);
248 ubi_assert(offset
% ubi
->hdrs_min_io_size
== 0);
249 ubi_assert(len
> 0 && len
% ubi
->hdrs_min_io_size
== 0);
252 ubi_err("read-only mode");
256 err
= self_check_not_bad(ubi
, pnum
);
260 /* The area we are writing to has to contain all 0xFF bytes */
261 err
= ubi_self_check_all_ff(ubi
, pnum
, offset
, len
);
265 if (offset
>= ubi
->leb_start
) {
267 * We write to the data area of the physical eraseblock. Make
268 * sure it has valid EC and VID headers.
270 err
= self_check_peb_ec_hdr(ubi
, pnum
);
273 err
= self_check_peb_vid_hdr(ubi
, pnum
);
278 if (ubi_dbg_is_write_failure(ubi
)) {
279 ubi_err("cannot write %d bytes to PEB %d:%d (emulated)",
285 addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
286 err
= mtd_write(ubi
->mtd
, addr
, len
, &written
, buf
);
288 ubi_err("error %d while writing %d bytes to PEB %d:%d, written %zd bytes",
289 err
, len
, pnum
, offset
, written
);
291 ubi_dump_flash(ubi
, pnum
, offset
, len
);
293 ubi_assert(written
== len
);
296 err
= self_check_write(ubi
, buf
, pnum
, offset
, len
);
301 * Since we always write sequentially, the rest of the PEB has
302 * to contain only 0xFF bytes.
305 len
= ubi
->peb_size
- offset
;
307 err
= ubi_self_check_all_ff(ubi
, pnum
, offset
, len
);
314 * erase_callback - MTD erasure call-back.
315 * @ei: MTD erase information object.
317 * Note, even though MTD erase interface is asynchronous, all the current
318 * implementations are synchronous anyway.
320 static void erase_callback(struct erase_info
*ei
)
322 wake_up_interruptible((wait_queue_head_t
*)ei
->priv
);
326 * do_sync_erase - synchronously erase a physical eraseblock.
327 * @ubi: UBI device description object
328 * @pnum: the physical eraseblock number to erase
330 * This function synchronously erases physical eraseblock @pnum and returns
331 * zero in case of success and a negative error code in case of failure. If
332 * %-EIO is returned, the physical eraseblock most probably went bad.
334 static int do_sync_erase(struct ubi_device
*ubi
, int pnum
)
336 int err
, retries
= 0;
337 struct erase_info ei
;
338 wait_queue_head_t wq
;
340 dbg_io("erase PEB %d", pnum
);
341 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
344 ubi_err("read-only mode");
349 init_waitqueue_head(&wq
);
350 memset(&ei
, 0, sizeof(struct erase_info
));
353 ei
.addr
= (loff_t
)pnum
* ubi
->peb_size
;
354 ei
.len
= ubi
->peb_size
;
355 ei
.callback
= erase_callback
;
356 ei
.priv
= (unsigned long)&wq
;
358 err
= mtd_erase(ubi
->mtd
, &ei
);
359 atomic_inc(&ubi
->ec_count
); //MTK
361 if (retries
++ < UBI_IO_RETRIES
) {
362 ubi_warn("error %d while erasing PEB %d, retry",
367 ubi_err("cannot erase PEB %d, error %d", pnum
, err
);
372 err
= wait_event_interruptible(wq
, ei
.state
== MTD_ERASE_DONE
||
373 ei
.state
== MTD_ERASE_FAILED
);
375 ubi_err("interrupted PEB %d erasure", pnum
);
379 if (ei
.state
== MTD_ERASE_FAILED
) {
380 if (retries
++ < UBI_IO_RETRIES
) {
381 ubi_warn("error while erasing PEB %d, retry", pnum
);
385 ubi_err("cannot erase PEB %d", pnum
);
390 err
= ubi_self_check_all_ff(ubi
, pnum
, 0, ubi
->peb_size
);
394 if (ubi_dbg_is_erase_failure(ubi
)) {
395 ubi_err("cannot erase PEB %d (emulated)", pnum
);
402 /* Patterns to write to a physical eraseblock when torturing it */
403 static uint8_t patterns
[] = {0xa5, 0x5a, 0x0};
406 * torture_peb - test a supposedly bad physical eraseblock.
407 * @ubi: UBI device description object
408 * @pnum: the physical eraseblock number to test
410 * This function returns %-EIO if the physical eraseblock did not pass the
411 * test, a positive number of erase operations done if the test was
412 * successfully passed, and other negative error codes in case of other errors.
414 static int torture_peb(struct ubi_device
*ubi
, int pnum
)
416 int err
, i
, patt_count
;
418 ubi_msg("run torture test for PEB %d", pnum
);
419 patt_count
= ARRAY_SIZE(patterns
);
420 ubi_assert(patt_count
> 0);
422 mutex_lock(&ubi
->buf_mutex
);
423 for (i
= 0; i
< patt_count
; i
++) {
424 err
= do_sync_erase(ubi
, pnum
);
428 /* Make sure the PEB contains only 0xFF bytes */
429 err
= ubi_io_read(ubi
, ubi
->peb_buf
, pnum
, 0, ubi
->peb_size
);
433 err
= ubi_check_pattern(ubi
->peb_buf
, 0xFF, ubi
->peb_size
);
435 ubi_err("erased PEB %d, but a non-0xFF byte found",
441 /* Write a pattern and check it */
442 memset(ubi
->peb_buf
, patterns
[i
], ubi
->peb_size
);
443 err
= ubi_io_write(ubi
, ubi
->peb_buf
, pnum
, 0, ubi
->peb_size
);
447 memset(ubi
->peb_buf
, ~patterns
[i
], ubi
->peb_size
);
448 err
= ubi_io_read(ubi
, ubi
->peb_buf
, pnum
, 0, ubi
->peb_size
);
452 err
= ubi_check_pattern(ubi
->peb_buf
, patterns
[i
],
455 ubi_err("pattern %x checking failed for PEB %d",
463 ubi_msg("PEB %d passed torture test, do not mark it as bad", pnum
);
466 mutex_unlock(&ubi
->buf_mutex
);
467 if (err
== UBI_IO_BITFLIPS
|| mtd_is_eccerr(err
)) {
469 * If a bit-flip or data integrity error was detected, the test
470 * has not passed because it happened on a freshly erased
471 * physical eraseblock which means something is wrong with it.
473 ubi_err("read problems on freshly erased PEB %d, must be bad",
481 * nor_erase_prepare - prepare a NOR flash PEB for erasure.
482 * @ubi: UBI device description object
483 * @pnum: physical eraseblock number to prepare
485 * NOR flash, or at least some of them, have peculiar embedded PEB erasure
486 * algorithm: the PEB is first filled with zeroes, then it is erased. And
487 * filling with zeroes starts from the end of the PEB. This was observed with
488 * Spansion S29GL512N NOR flash.
490 * This means that in case of a power cut we may end up with intact data at the
491 * beginning of the PEB, and all zeroes at the end of PEB. In other words, the
492 * EC and VID headers are OK, but a large chunk of data at the end of PEB is
493 * zeroed. This makes UBI mistakenly treat this PEB as used and associate it
494 * with an LEB, which leads to subsequent failures (e.g., UBIFS fails).
496 * This function is called before erasing NOR PEBs and it zeroes out EC and VID
497 * magic numbers in order to invalidate them and prevent the failures. Returns
498 * zero in case of success and a negative error code in case of failure.
500 static int nor_erase_prepare(struct ubi_device
*ubi
, int pnum
)
507 * Note, we cannot generally define VID header buffers on stack,
508 * because of the way we deal with these buffers (see the header
509 * comment in this file). But we know this is a NOR-specific piece of
510 * code, so we can do this. But yes, this is error-prone and we should
511 * (pre-)allocate VID header buffer instead.
513 struct ubi_vid_hdr vid_hdr
;
516 * It is important to first invalidate the EC header, and then the VID
517 * header. Otherwise a power cut may lead to valid EC header and
518 * invalid VID header, in which case UBI will treat this PEB as
519 * corrupted and will try to preserve it, and print scary warnings.
521 addr
= (loff_t
)pnum
* ubi
->peb_size
;
522 err
= mtd_write(ubi
->mtd
, addr
, 4, &written
, (void *)&data
);
524 addr
+= ubi
->vid_hdr_aloffset
;
525 err
= mtd_write(ubi
->mtd
, addr
, 4, &written
, (void *)&data
);
531 * We failed to write to the media. This was observed with Spansion
532 * S29GL512N NOR flash. Most probably the previously eraseblock erasure
533 * was interrupted at a very inappropriate moment, so it became
534 * unwritable. In this case we probably anyway have garbage in this
537 err1
= ubi_io_read_vid_hdr(ubi
, pnum
, &vid_hdr
, 0);
538 if (err1
== UBI_IO_BAD_HDR_EBADMSG
|| err1
== UBI_IO_BAD_HDR
||
540 struct ubi_ec_hdr ec_hdr
;
542 err1
= ubi_io_read_ec_hdr(ubi
, pnum
, &ec_hdr
, 0);
543 if (err1
== UBI_IO_BAD_HDR_EBADMSG
|| err1
== UBI_IO_BAD_HDR
||
546 * Both VID and EC headers are corrupted, so we can
547 * safely erase this PEB and not afraid that it will be
548 * treated as a valid PEB in case of an unclean reboot.
554 * The PEB contains a valid VID header, but we cannot invalidate it.
555 * Supposedly the flash media or the driver is screwed up, so return an
558 ubi_err("cannot invalidate PEB %d, write returned %d read returned %d",
560 ubi_dump_flash(ubi
, pnum
, 0, ubi
->peb_size
);
565 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
566 * @ubi: UBI device description object
567 * @pnum: physical eraseblock number to erase
568 * @torture: if this physical eraseblock has to be tortured
570 * This function synchronously erases physical eraseblock @pnum. If @torture
571 * flag is not zero, the physical eraseblock is checked by means of writing
572 * different patterns to it and reading them back. If the torturing is enabled,
573 * the physical eraseblock is erased more than once.
575 * This function returns the number of erasures made in case of success, %-EIO
576 * if the erasure failed or the torturing test failed, and other negative error
577 * codes in case of other errors. Note, %-EIO means that the physical
580 int ubi_io_sync_erase(struct ubi_device
*ubi
, int pnum
, int torture
)
584 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
586 err
= self_check_not_bad(ubi
, pnum
);
591 ubi_err("read-only mode");
595 if (ubi
->nor_flash
) {
596 err
= nor_erase_prepare(ubi
, pnum
);
602 ret
= torture_peb(ubi
, pnum
);
607 err
= do_sync_erase(ubi
, pnum
);
615 * ubi_io_is_bad - check if a physical eraseblock is bad.
616 * @ubi: UBI device description object
617 * @pnum: the physical eraseblock number to check
619 * This function returns a positive number if the physical eraseblock is bad,
620 * zero if not, and a negative error code if an error occurred.
622 int ubi_io_is_bad(const struct ubi_device
*ubi
, int pnum
)
624 struct mtd_info
*mtd
= ubi
->mtd
;
626 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
628 if (ubi
->bad_allowed
) {
631 ret
= mtd_block_isbad(mtd
, (loff_t
)pnum
* ubi
->peb_size
);
633 ubi_err("error %d while checking if PEB %d is bad",
636 dbg_io("PEB %d is bad", pnum
);
644 * ubi_io_mark_bad - mark a physical eraseblock as bad.
645 * @ubi: UBI device description object
646 * @pnum: the physical eraseblock number to mark
648 * This function returns zero in case of success and a negative error code in
651 int ubi_io_mark_bad(const struct ubi_device
*ubi
, int pnum
)
654 struct mtd_info
*mtd
= ubi
->mtd
;
656 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
659 ubi_err("read-only mode");
663 if (!ubi
->bad_allowed
)
666 err
= mtd_block_markbad(mtd
, (loff_t
)pnum
* ubi
->peb_size
);
668 ubi_err("cannot mark PEB %d bad, error %d", pnum
, err
);
673 * validate_ec_hdr - validate an erase counter header.
674 * @ubi: UBI device description object
675 * @ec_hdr: the erase counter header to check
677 * This function returns zero if the erase counter header is OK, and %1 if
680 static int validate_ec_hdr(const struct ubi_device
*ubi
,
681 const struct ubi_ec_hdr
*ec_hdr
)
684 int vid_hdr_offset
, leb_start
;
686 ec
= be64_to_cpu(ec_hdr
->ec
);
687 vid_hdr_offset
= be32_to_cpu(ec_hdr
->vid_hdr_offset
);
688 leb_start
= be32_to_cpu(ec_hdr
->data_offset
);
690 if (ec_hdr
->version
!= UBI_VERSION
) {
691 ubi_err("node with incompatible UBI version found: this UBI version is %d, image version is %d",
692 UBI_VERSION
, (int)ec_hdr
->version
);
696 if (vid_hdr_offset
!= ubi
->vid_hdr_offset
) {
697 ubi_err("bad VID header offset %d, expected %d",
698 vid_hdr_offset
, ubi
->vid_hdr_offset
);
702 if (leb_start
!= ubi
->leb_start
) {
703 ubi_err("bad data offset %d, expected %d",
704 leb_start
, ubi
->leb_start
);
708 if (ec
< 0 || ec
> UBI_MAX_ERASECOUNTER
) {
709 ubi_err("bad erase counter %lld", ec
);
716 ubi_err("bad EC header");
717 ubi_dump_ec_hdr(ec_hdr
);
723 * ubi_io_read_ec_hdr - read and check an erase counter header.
724 * @ubi: UBI device description object
725 * @pnum: physical eraseblock to read from
726 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
728 * @verbose: be verbose if the header is corrupted or was not found
730 * This function reads erase counter header from physical eraseblock @pnum and
731 * stores it in @ec_hdr. This function also checks CRC checksum of the read
732 * erase counter header. The following codes may be returned:
734 * o %0 if the CRC checksum is correct and the header was successfully read;
735 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
736 * and corrected by the flash driver; this is harmless but may indicate that
737 * this eraseblock may become bad soon (but may be not);
738 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
739 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
740 * a data integrity error (uncorrectable ECC error in case of NAND);
741 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
742 * o a negative error code in case of failure.
744 int ubi_io_read_ec_hdr(struct ubi_device
*ubi
, int pnum
,
745 struct ubi_ec_hdr
*ec_hdr
, int verbose
)
748 uint32_t crc
, magic
, hdr_crc
;
750 dbg_io("read EC header from PEB %d", pnum
);
751 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
753 read_err
= ubi_io_read(ubi
, ec_hdr
, pnum
, 0, UBI_EC_HDR_SIZE
);
755 if (read_err
!= UBI_IO_BITFLIPS
&& !mtd_is_eccerr(read_err
))
759 * We read all the data, but either a correctable bit-flip
760 * occurred, or MTD reported a data integrity error
761 * (uncorrectable ECC error in case of NAND). The former is
762 * harmless, the later may mean that the read data is
763 * corrupted. But we have a CRC check-sum and we will detect
764 * this. If the EC header is still OK, we just report this as
765 * there was a bit-flip, to force scrubbing.
769 magic
= be32_to_cpu(ec_hdr
->magic
);
770 if (magic
!= UBI_EC_HDR_MAGIC
) {
771 if (mtd_is_eccerr(read_err
))
772 return UBI_IO_BAD_HDR_EBADMSG
;
775 * The magic field is wrong. Let's check if we have read all
776 * 0xFF. If yes, this physical eraseblock is assumed to be
779 if (ubi_check_pattern(ec_hdr
, 0xFF, UBI_EC_HDR_SIZE
)) {
780 /* The physical eraseblock is supposedly empty */
782 ubi_warn("no EC header found at PEB %d, only 0xFF bytes",
784 dbg_bld("no EC header found at PEB %d, only 0xFF bytes",
789 return UBI_IO_FF_BITFLIPS
;
793 * This is not a valid erase counter header, and these are not
794 * 0xFF bytes. Report that the header is corrupted.
797 ubi_warn("bad magic number at PEB %d: %08x instead of %08x",
798 pnum
, magic
, UBI_EC_HDR_MAGIC
);
799 ubi_dump_ec_hdr(ec_hdr
);
801 dbg_bld("bad magic number at PEB %d: %08x instead of %08x",
802 pnum
, magic
, UBI_EC_HDR_MAGIC
);
803 return UBI_IO_BAD_HDR
;
806 crc
= crc32(UBI_CRC32_INIT
, ec_hdr
, UBI_EC_HDR_SIZE_CRC
);
807 hdr_crc
= be32_to_cpu(ec_hdr
->hdr_crc
);
809 if (hdr_crc
!= crc
) {
811 ubi_warn("bad EC header CRC at PEB %d, calculated %#08x, read %#08x",
813 ubi_dump_ec_hdr(ec_hdr
);
815 dbg_bld("bad EC header CRC at PEB %d, calculated %#08x, read %#08x",
819 return UBI_IO_BAD_HDR
;
821 return UBI_IO_BAD_HDR_EBADMSG
;
824 /* And of course validate what has just been read from the media */
825 err
= validate_ec_hdr(ubi
, ec_hdr
);
827 ubi_err("validation failed for PEB %d", pnum
);
832 * If there was %-EBADMSG, but the header CRC is still OK, report about
833 * a bit-flip to force scrubbing on this PEB.
835 return read_err
? UBI_IO_BITFLIPS
: 0;
839 * ubi_io_write_ec_hdr - write an erase counter header.
840 * @ubi: UBI device description object
841 * @pnum: physical eraseblock to write to
842 * @ec_hdr: the erase counter header to write
844 * This function writes erase counter header described by @ec_hdr to physical
845 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
846 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
849 * This function returns zero in case of success and a negative error code in
850 * case of failure. If %-EIO is returned, the physical eraseblock most probably
853 int ubi_io_write_ec_hdr(struct ubi_device
*ubi
, int pnum
,
854 struct ubi_ec_hdr
*ec_hdr
)
859 dbg_io("write EC header to PEB %d", pnum
);
860 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
862 ec_hdr
->magic
= cpu_to_be32(UBI_EC_HDR_MAGIC
);
863 ec_hdr
->version
= UBI_VERSION
;
864 ec_hdr
->vid_hdr_offset
= cpu_to_be32(ubi
->vid_hdr_offset
);
865 ec_hdr
->data_offset
= cpu_to_be32(ubi
->leb_start
);
866 ec_hdr
->image_seq
= cpu_to_be32(ubi
->image_seq
);
867 crc
= crc32(UBI_CRC32_INIT
, ec_hdr
, UBI_EC_HDR_SIZE_CRC
);
868 ec_hdr
->hdr_crc
= cpu_to_be32(crc
);
870 err
= self_check_ec_hdr(ubi
, pnum
, ec_hdr
);
874 #ifdef CONFIG_PWR_LOSS_MTK_SPOH
875 PL_RESET_ON_CASE("NAND", "WRITE_EC_Header");
877 err
= ubi_io_write(ubi
, ec_hdr
, pnum
, 0, ubi
->ec_hdr_alsize
);
882 * validate_vid_hdr - validate a volume identifier header.
883 * @ubi: UBI device description object
884 * @vid_hdr: the volume identifier header to check
886 * This function checks that data stored in the volume identifier header
887 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
889 static int validate_vid_hdr(const struct ubi_device
*ubi
,
890 const struct ubi_vid_hdr
*vid_hdr
)
892 int vol_type
= vid_hdr
->vol_type
;
893 int copy_flag
= vid_hdr
->copy_flag
;
894 int vol_id
= be32_to_cpu(vid_hdr
->vol_id
);
895 int lnum
= be32_to_cpu(vid_hdr
->lnum
);
896 int compat
= vid_hdr
->compat
;
897 int data_size
= be32_to_cpu(vid_hdr
->data_size
);
898 int used_ebs
= be32_to_cpu(vid_hdr
->used_ebs
);
899 int data_pad
= be32_to_cpu(vid_hdr
->data_pad
);
900 int data_crc
= be32_to_cpu(vid_hdr
->data_crc
);
901 int usable_leb_size
= ubi
->leb_size
- data_pad
;
903 if (copy_flag
!= 0 && copy_flag
!= 1) {
904 ubi_err("bad copy_flag");
908 if (vol_id
< 0 || lnum
< 0 || data_size
< 0 || used_ebs
< 0 ||
910 ubi_err("negative values");
914 if (vol_id
>= UBI_MAX_VOLUMES
&& vol_id
< UBI_INTERNAL_VOL_START
) {
915 ubi_err("bad vol_id");
919 if (vol_id
< UBI_INTERNAL_VOL_START
&& compat
!= 0) {
920 ubi_err("bad compat");
924 if (vol_id
>= UBI_INTERNAL_VOL_START
&& compat
!= UBI_COMPAT_DELETE
&&
925 compat
!= UBI_COMPAT_RO
&& compat
!= UBI_COMPAT_PRESERVE
&&
926 compat
!= UBI_COMPAT_REJECT
) {
928 ubi_err("bad compat");
931 if (vol_id
!= UBI_BACKUP_VOLUME_ID
) {
932 ubi_err("bad compat");
938 if (vol_type
!= UBI_VID_DYNAMIC
&& vol_type
!= UBI_VID_STATIC
) {
939 ubi_err("bad vol_type");
943 if (data_pad
>= ubi
->leb_size
/ 2) {
944 ubi_err("bad data_pad");
948 if (data_size
> ubi
->leb_size
) {
949 ubi_err("bad data_size");
953 if (vol_type
== UBI_VID_STATIC
) {
955 * Although from high-level point of view static volumes may
956 * contain zero bytes of data, but no VID headers can contain
957 * zero at these fields, because they empty volumes do not have
958 * mapped logical eraseblocks.
961 ubi_err("zero used_ebs");
964 if (data_size
== 0) {
965 ubi_err("zero data_size");
968 if (lnum
< used_ebs
- 1) {
969 if (data_size
!= usable_leb_size
) {
970 ubi_err("bad data_size");
973 } else if (lnum
== used_ebs
- 1) {
974 if (data_size
== 0) {
975 ubi_err("bad data_size at last LEB");
979 ubi_err("too high lnum");
983 if (copy_flag
== 0) {
985 ubi_err("non-zero data CRC");
988 if (data_size
!= 0) {
989 ubi_err("non-zero data_size");
993 if (data_size
== 0) {
994 ubi_err("zero data_size of copy");
999 ubi_err("bad used_ebs");
1007 ubi_err("bad VID header");
1008 ubi_dump_vid_hdr(vid_hdr
);
1014 * ubi_io_read_vid_hdr - read and check a volume identifier header.
1015 * @ubi: UBI device description object
1016 * @pnum: physical eraseblock number to read from
1017 * @vid_hdr: &struct ubi_vid_hdr object where to store the read volume
1019 * @verbose: be verbose if the header is corrupted or wasn't found
1021 * This function reads the volume identifier header from physical eraseblock
1022 * @pnum and stores it in @vid_hdr. It also checks CRC checksum of the read
1023 * volume identifier header. The error codes are the same as in
1024 * 'ubi_io_read_ec_hdr()'.
1026 * Note, the implementation of this function is also very similar to
1027 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
1029 int ubi_io_read_vid_hdr(struct ubi_device
*ubi
, int pnum
,
1030 struct ubi_vid_hdr
*vid_hdr
, int verbose
)
1033 uint32_t crc
, magic
, hdr_crc
;
1036 dbg_io("read VID header from PEB %d", pnum
);
1037 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
1039 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
1040 read_err
= ubi_io_read(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
1041 ubi
->vid_hdr_alsize
);
1042 if (read_err
&& read_err
!= UBI_IO_BITFLIPS
&& !mtd_is_eccerr(read_err
))
1045 magic
= be32_to_cpu(vid_hdr
->magic
);
1046 if (magic
!= UBI_VID_HDR_MAGIC
) {
1047 if (mtd_is_eccerr(read_err
))
1048 return UBI_IO_BAD_HDR_EBADMSG
;
1050 if (ubi_check_pattern(vid_hdr
, 0xFF, UBI_VID_HDR_SIZE
)) {
1052 ubi_warn("no VID header found at PEB %d, only 0xFF bytes",
1054 dbg_bld("no VID header found at PEB %d, only 0xFF bytes",
1059 return UBI_IO_FF_BITFLIPS
;
1063 ubi_warn("bad magic number at PEB %d: %08x instead of %08x",
1064 pnum
, magic
, UBI_VID_HDR_MAGIC
);
1065 ubi_dump_vid_hdr(vid_hdr
);
1067 dbg_bld("bad magic number at PEB %d: %08x instead of %08x",
1068 pnum
, magic
, UBI_VID_HDR_MAGIC
);
1069 return UBI_IO_BAD_HDR
;
1072 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_VID_HDR_SIZE_CRC
);
1073 hdr_crc
= be32_to_cpu(vid_hdr
->hdr_crc
);
1075 if (hdr_crc
!= crc
) {
1077 ubi_warn("bad CRC at PEB %d, calculated %#08x, read %#08x",
1078 pnum
, crc
, hdr_crc
);
1079 ubi_dump_vid_hdr(vid_hdr
);
1081 dbg_bld("bad CRC at PEB %d, calculated %#08x, read %#08x",
1082 pnum
, crc
, hdr_crc
);
1084 return UBI_IO_BAD_HDR
;
1086 return UBI_IO_BAD_HDR_EBADMSG
;
1089 err
= validate_vid_hdr(ubi
, vid_hdr
);
1091 ubi_err("validation failed for PEB %d", pnum
);
1095 return read_err
? UBI_IO_BITFLIPS
: 0;
1099 * ubi_io_write_vid_hdr - write a volume identifier header.
1100 * @ubi: UBI device description object
1101 * @pnum: the physical eraseblock number to write to
1102 * @vid_hdr: the volume identifier header to write
1104 * This function writes the volume identifier header described by @vid_hdr to
1105 * physical eraseblock @pnum. This function automatically fills the
1106 * @vid_hdr->magic and the @vid_hdr->version fields, as well as calculates
1107 * header CRC checksum and stores it at vid_hdr->hdr_crc.
1109 * This function returns zero in case of success and a negative error code in
1110 * case of failure. If %-EIO is returned, the physical eraseblock probably went
1113 int ubi_io_write_vid_hdr(struct ubi_device
*ubi
, int pnum
,
1114 struct ubi_vid_hdr
*vid_hdr
)
1120 dbg_io("write VID header to PEB %d", pnum
);
1121 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
1123 err
= self_check_peb_ec_hdr(ubi
, pnum
);
1127 vid_hdr
->magic
= cpu_to_be32(UBI_VID_HDR_MAGIC
);
1128 vid_hdr
->version
= UBI_VERSION
;
1129 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_VID_HDR_SIZE_CRC
);
1130 vid_hdr
->hdr_crc
= cpu_to_be32(crc
);
1132 err
= self_check_vid_hdr(ubi
, pnum
, vid_hdr
);
1138 extern int blb_record_page1(struct ubi_device
*ubi
, int pnum
,
1139 struct ubi_vid_hdr
*vid_hdr
, int);
1140 int vol_id
= be32_to_cpu(vid_hdr
->vol_id
);
1141 if(vol_id
< UBI_INTERNAL_VOL_START
) {
1143 blb_record_page1(ubi
, pnum
, vid_hdr
, 0);
1148 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
1149 err
= ubi_io_write(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
1150 ubi
->vid_hdr_alsize
);
1155 int ubi_io_write_vid_hdr_blb(struct ubi_device
*ubi
, int pnum
,
1156 struct ubi_vid_hdr
*vid_hdr
)
1162 dbg_io("write VID header to PEB %d", pnum
);
1163 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
1165 err
= self_check_peb_ec_hdr(ubi
, pnum
);
1169 vid_hdr
->magic
= cpu_to_be32(UBI_VID_HDR_MAGIC
);
1170 vid_hdr
->version
= UBI_VERSION
;
1171 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_VID_HDR_SIZE_CRC
);
1172 vid_hdr
->hdr_crc
= cpu_to_be32(crc
);
1174 err
= self_check_vid_hdr(ubi
, pnum
, vid_hdr
);
1179 extern int blb_record_page1(struct ubi_device
*ubi
, int pnum
,
1180 struct ubi_vid_hdr
*vid_hdr
, int);
1181 int vol_id
= be32_to_cpu(vid_hdr
->vol_id
);
1182 if(vol_id
< UBI_INTERNAL_VOL_START
) {
1184 err
= blb_record_page1(ubi
, pnum
, vid_hdr
, 1);
1189 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
1190 err
= ubi_io_write(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
1191 ubi
->vid_hdr_alsize
);
1197 * self_check_not_bad - ensure that a physical eraseblock is not bad.
1198 * @ubi: UBI device description object
1199 * @pnum: physical eraseblock number to check
1201 * This function returns zero if the physical eraseblock is good, %-EINVAL if
1202 * it is bad and a negative error code if an error occurred.
1204 static int self_check_not_bad(const struct ubi_device
*ubi
, int pnum
)
1208 if (!ubi_dbg_chk_io(ubi
))
1211 err
= ubi_io_is_bad(ubi
, pnum
);
1215 ubi_err("self-check failed for PEB %d", pnum
);
1217 return err
> 0 ? -EINVAL
: err
;
1221 * self_check_ec_hdr - check if an erase counter header is all right.
1222 * @ubi: UBI device description object
1223 * @pnum: physical eraseblock number the erase counter header belongs to
1224 * @ec_hdr: the erase counter header to check
1226 * This function returns zero if the erase counter header contains valid
1227 * values, and %-EINVAL if not.
1229 static int self_check_ec_hdr(const struct ubi_device
*ubi
, int pnum
,
1230 const struct ubi_ec_hdr
*ec_hdr
)
1235 if (!ubi_dbg_chk_io(ubi
))
1238 magic
= be32_to_cpu(ec_hdr
->magic
);
1239 if (magic
!= UBI_EC_HDR_MAGIC
) {
1240 ubi_err("bad magic %#08x, must be %#08x",
1241 magic
, UBI_EC_HDR_MAGIC
);
1245 err
= validate_ec_hdr(ubi
, ec_hdr
);
1247 ubi_err("self-check failed for PEB %d", pnum
);
1254 ubi_dump_ec_hdr(ec_hdr
);
1260 * self_check_peb_ec_hdr - check erase counter header.
1261 * @ubi: UBI device description object
1262 * @pnum: the physical eraseblock number to check
1264 * This function returns zero if the erase counter header is all right and and
1265 * a negative error code if not or if an error occurred.
1267 static int self_check_peb_ec_hdr(const struct ubi_device
*ubi
, int pnum
)
1270 uint32_t crc
, hdr_crc
;
1271 struct ubi_ec_hdr
*ec_hdr
;
1273 if (!ubi_dbg_chk_io(ubi
))
1276 ec_hdr
= kzalloc(ubi
->ec_hdr_alsize
, GFP_NOFS
);
1280 err
= ubi_io_read(ubi
, ec_hdr
, pnum
, 0, UBI_EC_HDR_SIZE
);
1281 if (err
&& err
!= UBI_IO_BITFLIPS
&& !mtd_is_eccerr(err
))
1284 crc
= crc32(UBI_CRC32_INIT
, ec_hdr
, UBI_EC_HDR_SIZE_CRC
);
1285 hdr_crc
= be32_to_cpu(ec_hdr
->hdr_crc
);
1286 if (hdr_crc
!= crc
) {
1287 ubi_err("bad CRC, calculated %#08x, read %#08x", crc
, hdr_crc
);
1288 ubi_err("self-check failed for PEB %d", pnum
);
1289 ubi_dump_ec_hdr(ec_hdr
);
1295 err
= self_check_ec_hdr(ubi
, pnum
, ec_hdr
);
1303 * self_check_vid_hdr - check that a volume identifier header is all right.
1304 * @ubi: UBI device description object
1305 * @pnum: physical eraseblock number the volume identifier header belongs to
1306 * @vid_hdr: the volume identifier header to check
1308 * This function returns zero if the volume identifier header is all right, and
1311 static int self_check_vid_hdr(const struct ubi_device
*ubi
, int pnum
,
1312 const struct ubi_vid_hdr
*vid_hdr
)
1317 if (!ubi_dbg_chk_io(ubi
))
1320 magic
= be32_to_cpu(vid_hdr
->magic
);
1321 if (magic
!= UBI_VID_HDR_MAGIC
) {
1322 ubi_err("bad VID header magic %#08x at PEB %d, must be %#08x",
1323 magic
, pnum
, UBI_VID_HDR_MAGIC
);
1327 err
= validate_vid_hdr(ubi
, vid_hdr
);
1329 ubi_err("self-check failed for PEB %d", pnum
);
1336 ubi_err("self-check failed for PEB %d", pnum
);
1337 ubi_dump_vid_hdr(vid_hdr
);
1344 * self_check_peb_vid_hdr - check volume identifier header.
1345 * @ubi: UBI device description object
1346 * @pnum: the physical eraseblock number to check
1348 * This function returns zero if the volume identifier header is all right,
1349 * and a negative error code if not or if an error occurred.
1351 static int self_check_peb_vid_hdr(const struct ubi_device
*ubi
, int pnum
)
1354 uint32_t crc
, hdr_crc
;
1355 struct ubi_vid_hdr
*vid_hdr
;
1358 if (!ubi_dbg_chk_io(ubi
))
1361 vid_hdr
= ubi_zalloc_vid_hdr(ubi
, GFP_NOFS
);
1365 p
= (char *)vid_hdr
- ubi
->vid_hdr_shift
;
1366 err
= ubi_io_read(ubi
, p
, pnum
, ubi
->vid_hdr_aloffset
,
1367 ubi
->vid_hdr_alsize
);
1368 if (err
&& err
!= UBI_IO_BITFLIPS
&& !mtd_is_eccerr(err
))
1371 crc
= crc32(UBI_CRC32_INIT
, vid_hdr
, UBI_EC_HDR_SIZE_CRC
);
1372 hdr_crc
= be32_to_cpu(vid_hdr
->hdr_crc
);
1373 if (hdr_crc
!= crc
) {
1374 ubi_err("bad VID header CRC at PEB %d, calculated %#08x, read %#08x",
1375 pnum
, crc
, hdr_crc
);
1376 ubi_err("self-check failed for PEB %d", pnum
);
1377 ubi_dump_vid_hdr(vid_hdr
);
1383 err
= self_check_vid_hdr(ubi
, pnum
, vid_hdr
);
1386 ubi_free_vid_hdr(ubi
, vid_hdr
);
1391 * self_check_write - make sure write succeeded.
1392 * @ubi: UBI device description object
1393 * @buf: buffer with data which were written
1394 * @pnum: physical eraseblock number the data were written to
1395 * @offset: offset within the physical eraseblock the data were written to
1396 * @len: how many bytes were written
1398 * This functions reads data which were recently written and compares it with
1399 * the original data buffer - the data have to match. Returns zero if the data
1400 * match and a negative error code if not or in case of failure.
1402 static int self_check_write(struct ubi_device
*ubi
, const void *buf
, int pnum
,
1403 int offset
, int len
)
1408 loff_t addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
1410 if (!ubi_dbg_chk_io(ubi
))
1413 buf1
= kmalloc(len
, GFP_KERNEL
);
1415 ubi_err("cannot allocate memory to check writes");
1419 err
= mtd_read(ubi
->mtd
, addr
, len
, &read
, buf1
);
1420 if (err
&& !mtd_is_bitflip(err
))
1423 for (i
= 0; i
< len
; i
++) {
1424 uint8_t c
= ((uint8_t *)buf
)[i
];
1425 uint8_t c1
= ((uint8_t *)buf1
)[i
];
1431 ubi_err("self-check failed for PEB %d:%d, len %d",
1433 ubi_msg("data differ at position %d", i
);
1434 dump_len
= max_t(int, 128, len
- i
);
1435 ubi_msg("hex dump of the original buffer from %d to %d",
1437 print_hex_dump(KERN_DEBUG
, "", DUMP_PREFIX_OFFSET
, 32, 1,
1438 buf
+ i
, dump_len
, 1);
1439 ubi_msg("hex dump of the read buffer from %d to %d",
1441 print_hex_dump(KERN_DEBUG
, "", DUMP_PREFIX_OFFSET
, 32, 1,
1442 buf1
+ i
, dump_len
, 1);
1457 * ubi_self_check_all_ff - check that a region of flash is empty.
1458 * @ubi: UBI device description object
1459 * @pnum: the physical eraseblock number to check
1460 * @offset: the starting offset within the physical eraseblock to check
1461 * @len: the length of the region to check
1463 * This function returns zero if only 0xFF bytes are present at offset
1464 * @offset of the physical eraseblock @pnum, and a negative error code if not
1465 * or if an error occurred.
1467 int ubi_self_check_all_ff(struct ubi_device
*ubi
, int pnum
, int offset
, int len
)
1472 loff_t addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
1474 if (!ubi_dbg_chk_io(ubi
))
1477 buf
= kmalloc(len
, GFP_KERNEL
);
1479 ubi_err("cannot allocate memory to check for 0xFFs");
1483 err
= mtd_read(ubi
->mtd
, addr
, len
, &read
, buf
);
1484 if (err
&& !mtd_is_bitflip(err
)) {
1485 ubi_err("error %d while reading %d bytes from PEB %d:%d, read %zd bytes",
1486 err
, len
, pnum
, offset
, read
);
1490 err
= ubi_check_pattern(buf
, 0xFF, len
);
1492 ubi_err("flash region at PEB %d:%d, length %d does not contain all 0xFF bytes",
1501 ubi_err("self-check failed for PEB %d", pnum
);
1502 ubi_msg("hex dump of the %d-%d region", offset
, offset
+ len
);
1503 print_hex_dump(KERN_DEBUG
, "", DUMP_PREFIX_OFFSET
, 32, 1, buf
, len
, 1);
1512 /* Read one page with oob one time */
1513 int ubi_io_read_oob(const struct ubi_device
*ubi
, void *databuf
, void *oobbuf
,
1514 int pnum
, int offset
)
1518 struct mtd_oob_ops ops
;
1520 dbg_io("read from PEB %d:%d", pnum
, offset
);
1522 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
1523 ubi_assert(offset
>= 0 && offset
+ ubi
->mtd
->writesize
<= ubi
->peb_size
);
1525 addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
1527 ops
.mode
= MTD_OPS_AUTO_OOB
;
1528 ops
.ooblen
= ubi
->mtd
->oobavail
;
1529 ops
.oobbuf
= oobbuf
;
1531 ops
.len
= ubi
->mtd
->writesize
;
1532 ops
.datbuf
= databuf
;
1533 ops
.retlen
= ops
.oobretlen
= 0;
1535 err
= mtd_read_oob(ubi
->mtd
, addr
, &ops
);
1537 if (err
== -EUCLEAN
) {
1539 * -EUCLEAN is reported if there was a bit-flip which
1540 * was corrected, so this is harmless.
1542 * We do not report about it here unless debugging is
1543 * enabled. A corresponding message will be printed
1544 * later, when it is has been scrubbed.
1546 ubi_msg("fixable bit-flip detected at addr %lld", addr
);
1548 ubi_assert(ops
.oobretlen
== ops
.ooblen
);
1549 return UBI_IO_BITFLIPS
;
1551 if (ops
.retlen
!= ops
.len
&& err
== -EBADMSG
) {
1552 ubi_err("err(%d), retlen(%d), len(%d)", err
, ops
.retlen
, ops
.len
);
1556 ubi_msg("mtd_read_oob err %d\n", err
);
1562 /* Write one page with oob one time */
1563 int ubi_io_write_oob(const struct ubi_device
*ubi
, void *databuf
, void *oobbuf
,
1564 int pnum
, int offset
)
1568 struct mtd_oob_ops ops
;
1570 dbg_io("read from PEB %d:%d", pnum
, offset
);
1572 ubi_assert(pnum
>= 0 && pnum
< ubi
->peb_count
);
1573 ubi_assert(offset
>= 0 && offset
+ ubi
->mtd
->writesize
<= ubi
->peb_size
);
1575 addr
= (loff_t
)pnum
* ubi
->peb_size
+ offset
;
1577 ops
.mode
= MTD_OPS_AUTO_OOB
;
1578 ops
.ooblen
= ubi
->mtd
->oobavail
;
1579 ops
.oobbuf
= oobbuf
;
1581 ops
.len
= ubi
->mtd
->writesize
;
1582 ops
.datbuf
= databuf
;
1583 ops
.retlen
= ops
.oobretlen
= 0;
1585 err
= mtd_write_oob(ubi
->mtd
, addr
, &ops
);
1587 ubi_err("error %d while writing to addr %lld peb%d:0x%x, written ",
1588 err
, addr
, pnum
, offset
);
1591 ubi_assert(ops
.retlen
== ops
.len
);