blob: b6fb8f945c21919a28436ead4f4368fef672e907 [file] [log] [blame]
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001/*
2 * Copyright (c) International Business Machines Corp., 2006
3 * Copyright (c) Nokia Corporation, 2006, 2007
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
13 * the GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 *
19 * Author: Artem Bityutskiy (Битюцкий Артём)
20 */
21
22/*
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030023 * UBI input/output sub-system.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040024 *
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030025 * This sub-system provides a uniform way to work with all kinds of the
26 * underlying MTD devices. It also implements handy functions for reading and
27 * writing UBI headers.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040028 *
29 * We are trying to have a paranoid mindset and not to trust to what we read
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030030 * from the flash media in order to be more secure and robust. So this
31 * sub-system validates every single header it reads from the flash media.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040032 *
33 * Some words about how the eraseblock headers are stored.
34 *
35 * The erase counter header is always stored at offset zero. By default, the
36 * VID header is stored after the EC header at the closest aligned offset
37 * (i.e. aligned to the minimum I/O unit size). Data starts next to the VID
38 * header at the closest aligned offset. But this default layout may be
39 * changed. For example, for different reasons (e.g., optimization) UBI may be
40 * asked to put the VID header at further offset, and even at an unaligned
41 * offset. Of course, if the offset of the VID header is unaligned, UBI adds
42 * proper padding in front of it. Data offset may also be changed but it has to
43 * be aligned.
44 *
45 * About minimal I/O units. In general, UBI assumes flash device model where
46 * there is only one minimal I/O unit size. E.g., in case of NOR flash it is 1,
47 * in case of NAND flash it is a NAND page, etc. This is reported by MTD in the
48 * @ubi->mtd->writesize field. But as an exception, UBI admits of using another
49 * (smaller) minimal I/O unit size for EC and VID headers to make it possible
50 * to do different optimizations.
51 *
52 * This is extremely useful in case of NAND flashes which admit of several
53 * write operations to one NAND page. In this case UBI can fit EC and VID
54 * headers at one NAND page. Thus, UBI may use "sub-page" size as the minimal
55 * I/O unit for the headers (the @ubi->hdrs_min_io_size field). But it still
56 * reports NAND page size (@ubi->min_io_size) as a minimal I/O unit for the UBI
57 * users.
58 *
59 * Example: some Samsung NANDs with 2KiB pages allow 4x 512-byte writes, so
60 * although the minimal I/O unit is 2K, UBI uses 512 bytes for EC and VID
61 * headers.
62 *
63 * Q: why not just to treat sub-page as a minimal I/O unit of this flash
64 * device, e.g., make @ubi->min_io_size = 512 in the example above?
65 *
66 * A: because when writing a sub-page, MTD still writes a full 2K page but the
Shinya Kuribayashibe436f62010-05-06 19:22:09 +090067 * bytes which are not relevant to the sub-page are 0xFF. So, basically,
68 * writing 4x512 sub-pages is 4 times slower than writing one 2KiB NAND page.
69 * Thus, we prefer to use sub-pages only for EC and VID headers.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040070 *
71 * As it was noted above, the VID header may start at a non-aligned offset.
72 * For example, in case of a 2KiB page NAND flash with a 512 bytes sub-page,
73 * the VID header may reside at offset 1984 which is the last 64 bytes of the
74 * last sub-page (EC header is always at offset zero). This causes some
75 * difficulties when reading and writing VID headers.
76 *
77 * Suppose we have a 64-byte buffer and we read a VID header at it. We change
78 * the data and want to write this VID header out. As we can only write in
79 * 512-byte chunks, we have to allocate one more buffer and copy our VID header
80 * to offset 448 of this buffer.
81 *
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030082 * The I/O sub-system does the following trick in order to avoid this extra
83 * copy. It always allocates a @ubi->vid_hdr_alsize bytes buffer for the VID
84 * header and returns a pointer to offset @ubi->vid_hdr_shift of this buffer.
85 * When the VID header is being written out, it shifts the VID header pointer
86 * back and writes the whole sub-page.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040087 */
88
89#include <linux/crc32.h>
90#include <linux/err.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090091#include <linux/slab.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040092#include "ubi.h"
93
Artem Bityutskiy8056eb42012-05-16 18:24:09 +030094static int self_check_not_bad(const struct ubi_device *ubi, int pnum);
95static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum);
96static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
97 const struct ubi_ec_hdr *ec_hdr);
98static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum);
99static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
100 const struct ubi_vid_hdr *vid_hdr);
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300101static int self_check_write(struct ubi_device *ubi, const void *buf, int pnum,
102 int offset, int len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400103
104/**
105 * ubi_io_read - read data from a physical eraseblock.
106 * @ubi: UBI device description object
107 * @buf: buffer where to store the read data
108 * @pnum: physical eraseblock number to read from
109 * @offset: offset within the physical eraseblock from where to read
110 * @len: how many bytes to read
111 *
112 * This function reads data from offset @offset of physical eraseblock @pnum
113 * and stores the read data in the @buf buffer. The following return codes are
114 * possible:
115 *
116 * o %0 if all the requested data were successfully read;
117 * o %UBI_IO_BITFLIPS if all the requested data were successfully read, but
118 * correctable bit-flips were detected; this is harmless but may indicate
119 * that this eraseblock may become bad soon (but do not have to);
Artem Bityutskiy63b6c1e2007-07-17 15:04:20 +0300120 * o %-EBADMSG if the MTD subsystem reported about data integrity problems, for
121 * example it can be an ECC error in case of NAND; this most probably means
122 * that the data is corrupted;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400123 * o %-EIO if some I/O error occurred;
124 * o other negative error codes in case of other errors.
125 */
126int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
127 int len)
128{
129 int err, retries = 0;
130 size_t read;
131 loff_t addr;
132
133 dbg_io("read %d bytes from PEB %d:%d", len, pnum, offset);
134
135 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
136 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
137 ubi_assert(len > 0);
138
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300139 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400140 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200141 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400142
Artem Bityutskiy276832d2010-11-13 15:08:29 +0200143 /*
144 * Deliberately corrupt the buffer to improve robustness. Indeed, if we
145 * do not do this, the following may happen:
146 * 1. The buffer contains data from previous operation, e.g., read from
147 * another PEB previously. The data looks like expected, e.g., if we
148 * just do not read anything and return - the caller would not
149 * notice this. E.g., if we are reading a VID header, the buffer may
150 * contain a valid VID header from another PEB.
151 * 2. The driver is buggy and returns us success or -EBADMSG or
152 * -EUCLEAN, but it does not actually put any data to the buffer.
153 *
154 * This may confuse UBI or upper layers - they may think the buffer
155 * contains valid data while in fact it is just old data. This is
156 * especially possible because UBI (and UBIFS) relies on CRC, and
157 * treats data as correct even in case of ECC errors if the CRC is
158 * correct.
159 *
160 * Try to prevent this situation by changing the first byte of the
161 * buffer.
162 */
163 *((uint8_t *)buf) ^= 0xFF;
164
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400165 addr = (loff_t)pnum * ubi->peb_size + offset;
166retry:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200167 err = mtd_read(ubi->mtd, addr, len, &read, buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400168 if (err) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700169 const char *errstr = mtd_is_eccerr(err) ? " (ECC error)" : "";
Artem Bityutskiy1a49af22010-06-08 10:59:07 +0300170
Brian Norrisd57f40542011-09-20 18:34:25 -0700171 if (mtd_is_bitflip(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400172 /*
173 * -EUCLEAN is reported if there was a bit-flip which
174 * was corrected, so this is harmless.
Artem Bityutskiy8c1e6ee2008-07-18 12:20:23 +0300175 *
176 * We do not report about it here unless debugging is
177 * enabled. A corresponding message will be printed
178 * later, when it is has been scrubbed.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400179 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300180 ubi_msg(ubi, "fixable bit-flip detected at PEB %d",
181 pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400182 ubi_assert(len == read);
183 return UBI_IO_BITFLIPS;
184 }
185
Artem Bityutskiya87f29c2010-10-31 18:55:30 +0200186 if (retries++ < UBI_IO_RETRIES) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300187 ubi_warn(ubi, "error %d%s while reading %d bytes from PEB %d:%d, read only %zd bytes, retry",
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300188 err, errstr, len, pnum, offset, read);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400189 yield();
190 goto retry;
191 }
192
Tanya Brokhman326087032014-10-20 19:57:00 +0300193 ubi_err(ubi, "error %d%s while reading %d bytes from PEB %d:%d, read %zd bytes",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300194 err, errstr, len, pnum, offset, read);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300195 dump_stack();
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300196
197 /*
198 * The driver should never return -EBADMSG if it failed to read
199 * all the requested data. But some buggy drivers might do
200 * this, so we change it to -EIO.
201 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700202 if (read != len && mtd_is_eccerr(err)) {
Artem Bityutskiy2362a532007-10-18 20:09:41 +0300203 ubi_assert(0);
204 err = -EIO;
205 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400206 } else {
207 ubi_assert(len == read);
208
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300209 if (ubi_dbg_is_bitflip(ubi)) {
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300210 dbg_gen("bit-flip (emulated)");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400211 err = UBI_IO_BITFLIPS;
212 }
213 }
214
215 return err;
216}
217
218/**
219 * ubi_io_write - write data to a physical eraseblock.
220 * @ubi: UBI device description object
221 * @buf: buffer with the data to write
222 * @pnum: physical eraseblock number to write to
223 * @offset: offset within the physical eraseblock where to write
224 * @len: how many bytes to write
225 *
226 * This function writes @len bytes of data from buffer @buf to offset @offset
227 * of physical eraseblock @pnum. If all the data were successfully written,
228 * zero is returned. If an error occurred, this function returns a negative
229 * error code. If %-EIO is returned, the physical eraseblock most probably went
230 * bad.
231 *
232 * Note, in case of an error, it is possible that something was still written
233 * to the flash media, but may be some garbage.
234 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300235int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
236 int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400237{
238 int err;
239 size_t written;
240 loff_t addr;
241
242 dbg_io("write %d bytes to PEB %d:%d", len, pnum, offset);
243
244 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
245 ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
246 ubi_assert(offset % ubi->hdrs_min_io_size == 0);
247 ubi_assert(len > 0 && len % ubi->hdrs_min_io_size == 0);
248
249 if (ubi->ro_mode) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300250 ubi_err(ubi, "read-only mode");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400251 return -EROFS;
252 }
253
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300254 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400255 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200256 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400257
258 /* The area we are writing to has to contain all 0xFF bytes */
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300259 err = ubi_self_check_all_ff(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400260 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200261 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400262
263 if (offset >= ubi->leb_start) {
264 /*
265 * We write to the data area of the physical eraseblock. Make
266 * sure it has valid EC and VID headers.
267 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300268 err = self_check_peb_ec_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400269 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200270 return err;
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300271 err = self_check_peb_vid_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400272 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200273 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400274 }
275
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300276 if (ubi_dbg_is_write_failure(ubi)) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300277 ubi_err(ubi, "cannot write %d bytes to PEB %d:%d (emulated)",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300278 len, pnum, offset);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300279 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400280 return -EIO;
281 }
282
283 addr = (loff_t)pnum * ubi->peb_size + offset;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200284 err = mtd_write(ubi->mtd, addr, len, &written, buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400285 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300286 ubi_err(ubi, "error %d while writing %d bytes to PEB %d:%d, written %zd bytes",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300287 err, len, pnum, offset, written);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300288 dump_stack();
Artem Bityutskiyef7088e2012-04-24 07:10:33 +0300289 ubi_dump_flash(ubi, pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400290 } else
291 ubi_assert(written == len);
292
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200293 if (!err) {
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300294 err = self_check_write(ubi, buf, pnum, offset, len);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200295 if (err)
296 return err;
297
298 /*
299 * Since we always write sequentially, the rest of the PEB has
300 * to contain only 0xFF bytes.
301 */
302 offset += len;
303 len = ubi->peb_size - offset;
304 if (len)
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300305 err = ubi_self_check_all_ff(ubi, pnum, offset, len);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +0200306 }
307
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400308 return err;
309}
310
311/**
312 * erase_callback - MTD erasure call-back.
313 * @ei: MTD erase information object.
314 *
315 * Note, even though MTD erase interface is asynchronous, all the current
316 * implementations are synchronous anyway.
317 */
318static void erase_callback(struct erase_info *ei)
319{
320 wake_up_interruptible((wait_queue_head_t *)ei->priv);
321}
322
323/**
324 * do_sync_erase - synchronously erase a physical eraseblock.
325 * @ubi: UBI device description object
326 * @pnum: the physical eraseblock number to erase
327 *
328 * This function synchronously erases physical eraseblock @pnum and returns
329 * zero in case of success and a negative error code in case of failure. If
330 * %-EIO is returned, the physical eraseblock most probably went bad.
331 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300332static int do_sync_erase(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400333{
334 int err, retries = 0;
335 struct erase_info ei;
336 wait_queue_head_t wq;
337
338 dbg_io("erase PEB %d", pnum);
Artem Bityutskiy3efe5092011-03-18 18:11:42 +0200339 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
340
341 if (ubi->ro_mode) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300342 ubi_err(ubi, "read-only mode");
Artem Bityutskiy3efe5092011-03-18 18:11:42 +0200343 return -EROFS;
344 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400345
346retry:
347 init_waitqueue_head(&wq);
348 memset(&ei, 0, sizeof(struct erase_info));
349
350 ei.mtd = ubi->mtd;
Brijesh Singh2f176f72007-07-05 15:07:35 +0530351 ei.addr = (loff_t)pnum * ubi->peb_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400352 ei.len = ubi->peb_size;
353 ei.callback = erase_callback;
354 ei.priv = (unsigned long)&wq;
355
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200356 err = mtd_erase(ubi->mtd, &ei);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400357 if (err) {
358 if (retries++ < UBI_IO_RETRIES) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300359 ubi_warn(ubi, "error %d while erasing PEB %d, retry",
Artem Bityutskiyf01e2d12012-04-25 09:15:38 +0300360 err, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400361 yield();
362 goto retry;
363 }
Tanya Brokhman326087032014-10-20 19:57:00 +0300364 ubi_err(ubi, "cannot erase PEB %d, error %d", pnum, err);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300365 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400366 return err;
367 }
368
369 err = wait_event_interruptible(wq, ei.state == MTD_ERASE_DONE ||
370 ei.state == MTD_ERASE_FAILED);
371 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300372 ubi_err(ubi, "interrupted PEB %d erasure", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400373 return -EINTR;
374 }
375
376 if (ei.state == MTD_ERASE_FAILED) {
377 if (retries++ < UBI_IO_RETRIES) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300378 ubi_warn(ubi, "error while erasing PEB %d, retry",
379 pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400380 yield();
381 goto retry;
382 }
Tanya Brokhman326087032014-10-20 19:57:00 +0300383 ubi_err(ubi, "cannot erase PEB %d", pnum);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300384 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400385 return -EIO;
386 }
387
Artem Bityutskiy97d61042012-05-16 19:29:04 +0300388 err = ubi_self_check_all_ff(ubi, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400389 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200390 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400391
Artem Bityutskiy27a0f2a2011-05-18 16:03:23 +0300392 if (ubi_dbg_is_erase_failure(ubi)) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300393 ubi_err(ubi, "cannot erase PEB %d (emulated)", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400394 return -EIO;
395 }
396
397 return 0;
398}
399
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400400/* Patterns to write to a physical eraseblock when torturing it */
401static uint8_t patterns[] = {0xa5, 0x5a, 0x0};
402
403/**
404 * torture_peb - test a supposedly bad physical eraseblock.
405 * @ubi: UBI device description object
406 * @pnum: the physical eraseblock number to test
407 *
408 * This function returns %-EIO if the physical eraseblock did not pass the
409 * test, a positive number of erase operations done if the test was
410 * successfully passed, and other negative error codes in case of other errors.
411 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300412static int torture_peb(struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400413{
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400414 int err, i, patt_count;
415
Tanya Brokhman326087032014-10-20 19:57:00 +0300416 ubi_msg(ubi, "run torture test for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400417 patt_count = ARRAY_SIZE(patterns);
418 ubi_assert(patt_count > 0);
419
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300420 mutex_lock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400421 for (i = 0; i < patt_count; i++) {
422 err = do_sync_erase(ubi, pnum);
423 if (err)
424 goto out;
425
426 /* Make sure the PEB contains only 0xFF bytes */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200427 err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400428 if (err)
429 goto out;
430
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200431 err = ubi_check_pattern(ubi->peb_buf, 0xFF, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400432 if (err == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300433 ubi_err(ubi, "erased PEB %d, but a non-0xFF byte found",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400434 pnum);
435 err = -EIO;
436 goto out;
437 }
438
439 /* Write a pattern and check it */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200440 memset(ubi->peb_buf, patterns[i], ubi->peb_size);
441 err = ubi_io_write(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400442 if (err)
443 goto out;
444
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200445 memset(ubi->peb_buf, ~patterns[i], ubi->peb_size);
446 err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400447 if (err)
448 goto out;
449
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200450 err = ubi_check_pattern(ubi->peb_buf, patterns[i],
Artem Bityutskiybb00e182010-07-31 09:37:34 +0300451 ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400452 if (err == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300453 ubi_err(ubi, "pattern %x checking failed for PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400454 patterns[i], pnum);
455 err = -EIO;
456 goto out;
457 }
458 }
459
460 err = patt_count;
Tanya Brokhman326087032014-10-20 19:57:00 +0300461 ubi_msg(ubi, "PEB %d passed torture test, do not mark it as bad", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400462
463out:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300464 mutex_unlock(&ubi->buf_mutex);
Brian Norrisd57f40542011-09-20 18:34:25 -0700465 if (err == UBI_IO_BITFLIPS || mtd_is_eccerr(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400466 /*
467 * If a bit-flip or data integrity error was detected, the test
468 * has not passed because it happened on a freshly erased
469 * physical eraseblock which means something is wrong with it.
470 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300471 ubi_err(ubi, "read problems on freshly erased PEB %d, must be bad",
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300472 pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400473 err = -EIO;
Artem Bityutskiy8d2d4012007-07-22 22:32:51 +0300474 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400475 return err;
476}
477
478/**
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300479 * nor_erase_prepare - prepare a NOR flash PEB for erasure.
480 * @ubi: UBI device description object
481 * @pnum: physical eraseblock number to prepare
482 *
483 * NOR flash, or at least some of them, have peculiar embedded PEB erasure
484 * algorithm: the PEB is first filled with zeroes, then it is erased. And
485 * filling with zeroes starts from the end of the PEB. This was observed with
486 * Spansion S29GL512N NOR flash.
487 *
488 * This means that in case of a power cut we may end up with intact data at the
489 * beginning of the PEB, and all zeroes at the end of PEB. In other words, the
490 * EC and VID headers are OK, but a large chunk of data at the end of PEB is
491 * zeroed. This makes UBI mistakenly treat this PEB as used and associate it
492 * with an LEB, which leads to subsequent failures (e.g., UBIFS fails).
493 *
494 * This function is called before erasing NOR PEBs and it zeroes out EC and VID
495 * magic numbers in order to invalidate them and prevent the failures. Returns
496 * zero in case of success and a negative error code in case of failure.
497 */
498static int nor_erase_prepare(struct ubi_device *ubi, int pnum)
499{
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000500 int err;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300501 size_t written;
502 loff_t addr;
503 uint32_t data = 0;
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000504 struct ubi_ec_hdr ec_hdr;
Boris Brezillon3291b522016-09-16 16:59:26 +0200505 struct ubi_vid_io_buf vidb;
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000506
Artem Bityutskiy2fff5702010-12-03 15:32:21 +0200507 /*
508 * Note, we cannot generally define VID header buffers on stack,
509 * because of the way we deal with these buffers (see the header
510 * comment in this file). But we know this is a NOR-specific piece of
511 * code, so we can do this. But yes, this is error-prone and we should
512 * (pre-)allocate VID header buffer instead.
513 */
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300514 struct ubi_vid_hdr vid_hdr;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300515
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200516 /*
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000517 * If VID or EC is valid, we have to corrupt them before erasing.
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200518 * It is important to first invalidate the EC header, and then the VID
519 * header. Otherwise a power cut may lead to valid EC header and
520 * invalid VID header, in which case UBI will treat this PEB as
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300521 * corrupted and will try to preserve it, and print scary warnings.
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200522 */
523 addr = (loff_t)pnum * ubi->peb_size;
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000524 err = ubi_io_read_ec_hdr(ubi, pnum, &ec_hdr, 0);
525 if (err != UBI_IO_BAD_HDR_EBADMSG && err != UBI_IO_BAD_HDR &&
526 err != UBI_IO_FF){
527 err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
528 if(err)
529 goto error;
530 }
531
Boris Brezillon3291b522016-09-16 16:59:26 +0200532 ubi_init_vid_buf(ubi, &vidb, &vid_hdr);
533 ubi_assert(&vid_hdr == ubi_get_vid_hdr(&vidb));
534
535 err = ubi_io_read_vid_hdr(ubi, pnum, &vidb, 0);
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000536 if (err != UBI_IO_BAD_HDR_EBADMSG && err != UBI_IO_BAD_HDR &&
537 err != UBI_IO_FF){
Artem Bityutskiy7ac760c2010-12-02 06:34:01 +0200538 addr += ubi->vid_hdr_aloffset;
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200539 err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000540 if (err)
541 goto error;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300542 }
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000543 return 0;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300544
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000545error:
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300546 /*
Qi Wang 王起 (qiwang)2c7ca5c2014-01-01 13:06:11 +0000547 * The PEB contains a valid VID or EC header, but we cannot invalidate
548 * it. Supposedly the flash media or the driver is screwed up, so
549 * return an error.
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300550 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300551 ubi_err(ubi, "cannot invalidate PEB %d, write returned %d", pnum, err);
Artem Bityutskiyef7088e2012-04-24 07:10:33 +0300552 ubi_dump_flash(ubi, pnum, 0, ubi->peb_size);
Artem Bityutskiyde75c772009-07-24 16:18:04 +0300553 return -EIO;
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300554}
555
556/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400557 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
558 * @ubi: UBI device description object
559 * @pnum: physical eraseblock number to erase
560 * @torture: if this physical eraseblock has to be tortured
561 *
562 * This function synchronously erases physical eraseblock @pnum. If @torture
563 * flag is not zero, the physical eraseblock is checked by means of writing
564 * different patterns to it and reading them back. If the torturing is enabled,
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200565 * the physical eraseblock is erased more than once.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400566 *
567 * This function returns the number of erasures made in case of success, %-EIO
568 * if the erasure failed or the torturing test failed, and other negative error
569 * codes in case of other errors. Note, %-EIO means that the physical
570 * eraseblock is bad.
571 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300572int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400573{
574 int err, ret = 0;
575
576 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
577
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300578 err = self_check_not_bad(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400579 if (err != 0)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200580 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400581
582 if (ubi->ro_mode) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300583 ubi_err(ubi, "read-only mode");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400584 return -EROFS;
585 }
586
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300587 if (ubi->nor_flash) {
588 err = nor_erase_prepare(ubi, pnum);
589 if (err)
590 return err;
591 }
592
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400593 if (torture) {
594 ret = torture_peb(ubi, pnum);
595 if (ret < 0)
596 return ret;
597 }
598
599 err = do_sync_erase(ubi, pnum);
600 if (err)
601 return err;
602
603 return ret + 1;
604}
605
606/**
607 * ubi_io_is_bad - check if a physical eraseblock is bad.
608 * @ubi: UBI device description object
609 * @pnum: the physical eraseblock number to check
610 *
611 * This function returns a positive number if the physical eraseblock is bad,
612 * zero if not, and a negative error code if an error occurred.
613 */
614int ubi_io_is_bad(const struct ubi_device *ubi, int pnum)
615{
616 struct mtd_info *mtd = ubi->mtd;
617
618 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
619
620 if (ubi->bad_allowed) {
621 int ret;
622
Artem Bityutskiy7086c192011-12-23 19:35:30 +0200623 ret = mtd_block_isbad(mtd, (loff_t)pnum * ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400624 if (ret < 0)
Tanya Brokhman326087032014-10-20 19:57:00 +0300625 ubi_err(ubi, "error %d while checking if PEB %d is bad",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400626 ret, pnum);
627 else if (ret)
628 dbg_io("PEB %d is bad", pnum);
629 return ret;
630 }
631
632 return 0;
633}
634
635/**
636 * ubi_io_mark_bad - mark a physical eraseblock as bad.
637 * @ubi: UBI device description object
638 * @pnum: the physical eraseblock number to mark
639 *
640 * This function returns zero in case of success and a negative error code in
641 * case of failure.
642 */
643int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum)
644{
645 int err;
646 struct mtd_info *mtd = ubi->mtd;
647
648 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
649
650 if (ubi->ro_mode) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300651 ubi_err(ubi, "read-only mode");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400652 return -EROFS;
653 }
654
655 if (!ubi->bad_allowed)
656 return 0;
657
Artem Bityutskiy5942ddb2011-12-23 19:37:38 +0200658 err = mtd_block_markbad(mtd, (loff_t)pnum * ubi->peb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400659 if (err)
Tanya Brokhman326087032014-10-20 19:57:00 +0300660 ubi_err(ubi, "cannot mark PEB %d bad, error %d", pnum, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400661 return err;
662}
663
664/**
665 * validate_ec_hdr - validate an erase counter header.
666 * @ubi: UBI device description object
667 * @ec_hdr: the erase counter header to check
668 *
669 * This function returns zero if the erase counter header is OK, and %1 if
670 * not.
671 */
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300672static int validate_ec_hdr(const struct ubi_device *ubi,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400673 const struct ubi_ec_hdr *ec_hdr)
674{
675 long long ec;
Artem Bityutskiyfe96efc2009-06-30 16:11:59 +0300676 int vid_hdr_offset, leb_start;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400677
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300678 ec = be64_to_cpu(ec_hdr->ec);
679 vid_hdr_offset = be32_to_cpu(ec_hdr->vid_hdr_offset);
680 leb_start = be32_to_cpu(ec_hdr->data_offset);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400681
682 if (ec_hdr->version != UBI_VERSION) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300683 ubi_err(ubi, "node with incompatible UBI version found: this UBI version is %d, image version is %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400684 UBI_VERSION, (int)ec_hdr->version);
685 goto bad;
686 }
687
688 if (vid_hdr_offset != ubi->vid_hdr_offset) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300689 ubi_err(ubi, "bad VID header offset %d, expected %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400690 vid_hdr_offset, ubi->vid_hdr_offset);
691 goto bad;
692 }
693
694 if (leb_start != ubi->leb_start) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300695 ubi_err(ubi, "bad data offset %d, expected %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400696 leb_start, ubi->leb_start);
697 goto bad;
698 }
699
700 if (ec < 0 || ec > UBI_MAX_ERASECOUNTER) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300701 ubi_err(ubi, "bad erase counter %lld", ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400702 goto bad;
703 }
704
705 return 0;
706
707bad:
Tanya Brokhman326087032014-10-20 19:57:00 +0300708 ubi_err(ubi, "bad EC header");
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300709 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300710 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400711 return 1;
712}
713
714/**
715 * ubi_io_read_ec_hdr - read and check an erase counter header.
716 * @ubi: UBI device description object
717 * @pnum: physical eraseblock to read from
718 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
719 * header
720 * @verbose: be verbose if the header is corrupted or was not found
721 *
722 * This function reads erase counter header from physical eraseblock @pnum and
723 * stores it in @ec_hdr. This function also checks CRC checksum of the read
724 * erase counter header. The following codes may be returned:
725 *
726 * o %0 if the CRC checksum is correct and the header was successfully read;
727 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
728 * and corrected by the flash driver; this is harmless but may indicate that
729 * this eraseblock may become bad soon (but may be not);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300730 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300731 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
732 * a data integrity error (uncorrectable ECC error in case of NAND);
Artem Bityutskiy74d82d22010-09-03 02:11:20 +0300733 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400734 * o a negative error code in case of failure.
735 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300736int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400737 struct ubi_ec_hdr *ec_hdr, int verbose)
738{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300739 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400740 uint32_t crc, magic, hdr_crc;
741
742 dbg_io("read EC header from PEB %d", pnum);
743 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
744
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300745 read_err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
746 if (read_err) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700747 if (read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300748 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400749
750 /*
751 * We read all the data, but either a correctable bit-flip
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300752 * occurred, or MTD reported a data integrity error
753 * (uncorrectable ECC error in case of NAND). The former is
754 * harmless, the later may mean that the read data is
755 * corrupted. But we have a CRC check-sum and we will detect
756 * this. If the EC header is still OK, we just report this as
757 * there was a bit-flip, to force scrubbing.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400758 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400759 }
760
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300761 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400762 if (magic != UBI_EC_HDR_MAGIC) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700763 if (mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300764 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300765
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400766 /*
767 * The magic field is wrong. Let's check if we have read all
768 * 0xFF. If yes, this physical eraseblock is assumed to be
769 * empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400770 */
Artem Bityutskiybb00e182010-07-31 09:37:34 +0300771 if (ubi_check_pattern(ec_hdr, 0xFF, UBI_EC_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400772 /* The physical eraseblock is supposedly empty */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400773 if (verbose)
Tanya Brokhman326087032014-10-20 19:57:00 +0300774 ubi_warn(ubi, "no EC header found at PEB %d, only 0xFF bytes",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300775 pnum);
776 dbg_bld("no EC header found at PEB %d, only 0xFF bytes",
777 pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300778 if (!read_err)
779 return UBI_IO_FF;
780 else
781 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400782 }
783
784 /*
785 * This is not a valid erase counter header, and these are not
786 * 0xFF bytes. Report that the header is corrupted.
787 */
788 if (verbose) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300789 ubi_warn(ubi, "bad magic number at PEB %d: %08x instead of %08x",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300790 pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300791 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200792 }
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300793 dbg_bld("bad magic number at PEB %d: %08x instead of %08x",
794 pnum, magic, UBI_EC_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +0300795 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400796 }
797
798 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300799 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400800
801 if (hdr_crc != crc) {
802 if (verbose) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300803 ubi_warn(ubi, "bad EC header CRC at PEB %d, calculated %#08x, read %#08x",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300804 pnum, crc, hdr_crc);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300805 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +0200806 }
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300807 dbg_bld("bad EC header CRC at PEB %d, calculated %#08x, read %#08x",
808 pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +0300809
810 if (!read_err)
811 return UBI_IO_BAD_HDR;
812 else
813 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400814 }
815
816 /* And of course validate what has just been read from the media */
817 err = validate_ec_hdr(ubi, ec_hdr);
818 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300819 ubi_err(ubi, "validation failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400820 return -EINVAL;
821 }
822
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300823 /*
824 * If there was %-EBADMSG, but the header CRC is still OK, report about
825 * a bit-flip to force scrubbing on this PEB.
826 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400827 return read_err ? UBI_IO_BITFLIPS : 0;
828}
829
830/**
831 * ubi_io_write_ec_hdr - write an erase counter header.
832 * @ubi: UBI device description object
833 * @pnum: physical eraseblock to write to
834 * @ec_hdr: the erase counter header to write
835 *
836 * This function writes erase counter header described by @ec_hdr to physical
837 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
838 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
839 * field.
840 *
841 * This function returns zero in case of success and a negative error code in
842 * case of failure. If %-EIO is returned, the physical eraseblock most probably
843 * went bad.
844 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300845int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400846 struct ubi_ec_hdr *ec_hdr)
847{
848 int err;
849 uint32_t crc;
850
851 dbg_io("write EC header to PEB %d", pnum);
852 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
853
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300854 ec_hdr->magic = cpu_to_be32(UBI_EC_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400855 ec_hdr->version = UBI_VERSION;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300856 ec_hdr->vid_hdr_offset = cpu_to_be32(ubi->vid_hdr_offset);
857 ec_hdr->data_offset = cpu_to_be32(ubi->leb_start);
Adrian Hunter0c6c7fa2009-06-26 14:58:01 +0300858 ec_hdr->image_seq = cpu_to_be32(ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400859 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300860 ec_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400861
Artem Bityutskiy8056eb42012-05-16 18:24:09 +0300862 err = self_check_ec_hdr(ubi, pnum, ec_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400863 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +0200864 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400865
david.oberhollenzer@sigma-star.at50269062015-03-26 23:59:50 +0100866 if (ubi_dbg_power_cut(ubi, POWER_CUT_EC_WRITE))
867 return -EROFS;
868
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400869 err = ubi_io_write(ubi, ec_hdr, pnum, 0, ubi->ec_hdr_alsize);
870 return err;
871}
872
873/**
874 * validate_vid_hdr - validate a volume identifier header.
875 * @ubi: UBI device description object
876 * @vid_hdr: the volume identifier header to check
877 *
878 * This function checks that data stored in the volume identifier header
879 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
880 */
881static int validate_vid_hdr(const struct ubi_device *ubi,
882 const struct ubi_vid_hdr *vid_hdr)
883{
884 int vol_type = vid_hdr->vol_type;
885 int copy_flag = vid_hdr->copy_flag;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300886 int vol_id = be32_to_cpu(vid_hdr->vol_id);
887 int lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400888 int compat = vid_hdr->compat;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300889 int data_size = be32_to_cpu(vid_hdr->data_size);
890 int used_ebs = be32_to_cpu(vid_hdr->used_ebs);
891 int data_pad = be32_to_cpu(vid_hdr->data_pad);
892 int data_crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400893 int usable_leb_size = ubi->leb_size - data_pad;
894
895 if (copy_flag != 0 && copy_flag != 1) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300896 ubi_err(ubi, "bad copy_flag");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400897 goto bad;
898 }
899
900 if (vol_id < 0 || lnum < 0 || data_size < 0 || used_ebs < 0 ||
901 data_pad < 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300902 ubi_err(ubi, "negative values");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400903 goto bad;
904 }
905
906 if (vol_id >= UBI_MAX_VOLUMES && vol_id < UBI_INTERNAL_VOL_START) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300907 ubi_err(ubi, "bad vol_id");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400908 goto bad;
909 }
910
911 if (vol_id < UBI_INTERNAL_VOL_START && compat != 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300912 ubi_err(ubi, "bad compat");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400913 goto bad;
914 }
915
916 if (vol_id >= UBI_INTERNAL_VOL_START && compat != UBI_COMPAT_DELETE &&
917 compat != UBI_COMPAT_RO && compat != UBI_COMPAT_PRESERVE &&
918 compat != UBI_COMPAT_REJECT) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300919 ubi_err(ubi, "bad compat");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400920 goto bad;
921 }
922
923 if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300924 ubi_err(ubi, "bad vol_type");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400925 goto bad;
926 }
927
928 if (data_pad >= ubi->leb_size / 2) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300929 ubi_err(ubi, "bad data_pad");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400930 goto bad;
931 }
932
Richard Weinberger281fda22015-09-22 23:58:07 +0200933 if (data_size > ubi->leb_size) {
934 ubi_err(ubi, "bad data_size");
935 goto bad;
936 }
937
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400938 if (vol_type == UBI_VID_STATIC) {
939 /*
940 * Although from high-level point of view static volumes may
941 * contain zero bytes of data, but no VID headers can contain
942 * zero at these fields, because they empty volumes do not have
943 * mapped logical eraseblocks.
944 */
945 if (used_ebs == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300946 ubi_err(ubi, "zero used_ebs");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400947 goto bad;
948 }
949 if (data_size == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300950 ubi_err(ubi, "zero data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400951 goto bad;
952 }
953 if (lnum < used_ebs - 1) {
954 if (data_size != usable_leb_size) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300955 ubi_err(ubi, "bad data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400956 goto bad;
957 }
958 } else if (lnum == used_ebs - 1) {
959 if (data_size == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300960 ubi_err(ubi, "bad data_size at last LEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400961 goto bad;
962 }
963 } else {
Tanya Brokhman326087032014-10-20 19:57:00 +0300964 ubi_err(ubi, "too high lnum");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400965 goto bad;
966 }
967 } else {
968 if (copy_flag == 0) {
969 if (data_crc != 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300970 ubi_err(ubi, "non-zero data CRC");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400971 goto bad;
972 }
973 if (data_size != 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300974 ubi_err(ubi, "non-zero data_size");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400975 goto bad;
976 }
977 } else {
978 if (data_size == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300979 ubi_err(ubi, "zero data_size of copy");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400980 goto bad;
981 }
982 }
983 if (used_ebs != 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300984 ubi_err(ubi, "bad used_ebs");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400985 goto bad;
986 }
987 }
988
989 return 0;
990
991bad:
Tanya Brokhman326087032014-10-20 19:57:00 +0300992 ubi_err(ubi, "bad VID header");
Artem Bityutskiya904e3f2012-04-25 09:02:44 +0300993 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +0300994 dump_stack();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400995 return 1;
996}
997
998/**
999 * ubi_io_read_vid_hdr - read and check a volume identifier header.
1000 * @ubi: UBI device description object
1001 * @pnum: physical eraseblock number to read from
Boris Brezillon3291b522016-09-16 16:59:26 +02001002 * @vidb: the volume identifier buffer to store data in
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001003 * @verbose: be verbose if the header is corrupted or wasn't found
1004 *
1005 * This function reads the volume identifier header from physical eraseblock
Boris Brezillon3291b522016-09-16 16:59:26 +02001006 * @pnum and stores it in @vidb. It also checks CRC checksum of the read
Artem Bityutskiy74d82d22010-09-03 02:11:20 +03001007 * volume identifier header. The error codes are the same as in
1008 * 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001009 *
Artem Bityutskiy74d82d22010-09-03 02:11:20 +03001010 * Note, the implementation of this function is also very similar to
1011 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001012 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001013int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
Boris Brezillon3291b522016-09-16 16:59:26 +02001014 struct ubi_vid_io_buf *vidb, int verbose)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001015{
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001016 int err, read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001017 uint32_t crc, magic, hdr_crc;
Boris Brezillon3291b522016-09-16 16:59:26 +02001018 struct ubi_vid_hdr *vid_hdr = ubi_get_vid_hdr(vidb);
1019 void *p = vidb->buffer;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001020
1021 dbg_io("read VID header from PEB %d", pnum);
1022 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1023
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001024 read_err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
Sascha Hauer8a8e8d22016-06-28 13:51:07 +02001025 ubi->vid_hdr_shift + UBI_VID_HDR_SIZE);
Brian Norrisd57f40542011-09-20 18:34:25 -07001026 if (read_err && read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001027 return read_err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001028
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001029 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001030 if (magic != UBI_VID_HDR_MAGIC) {
Brian Norrisd57f40542011-09-20 18:34:25 -07001031 if (mtd_is_eccerr(read_err))
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001032 return UBI_IO_BAD_HDR_EBADMSG;
Artem Bityutskiyeb895802010-05-03 09:04:39 +03001033
Artem Bityutskiybb00e182010-07-31 09:37:34 +03001034 if (ubi_check_pattern(vid_hdr, 0xFF, UBI_VID_HDR_SIZE)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001035 if (verbose)
Tanya Brokhman326087032014-10-20 19:57:00 +03001036 ubi_warn(ubi, "no VID header found at PEB %d, only 0xFF bytes",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001037 pnum);
1038 dbg_bld("no VID header found at PEB %d, only 0xFF bytes",
1039 pnum);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001040 if (!read_err)
1041 return UBI_IO_FF;
1042 else
1043 return UBI_IO_FF_BITFLIPS;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001044 }
1045
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001046 if (verbose) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001047 ubi_warn(ubi, "bad magic number at PEB %d: %08x instead of %08x",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001048 pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001049 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001050 }
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001051 dbg_bld("bad magic number at PEB %d: %08x instead of %08x",
1052 pnum, magic, UBI_VID_HDR_MAGIC);
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001053 return UBI_IO_BAD_HDR;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001054 }
1055
1056 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001057 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001058
1059 if (hdr_crc != crc) {
1060 if (verbose) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001061 ubi_warn(ubi, "bad CRC at PEB %d, calculated %#08x, read %#08x",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001062 pnum, crc, hdr_crc);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001063 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy6f9fdf62011-03-11 13:08:51 +02001064 }
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001065 dbg_bld("bad CRC at PEB %d, calculated %#08x, read %#08x",
1066 pnum, crc, hdr_crc);
Artem Bityutskiy92e1a7d2010-09-03 14:22:17 +03001067 if (!read_err)
1068 return UBI_IO_BAD_HDR;
1069 else
1070 return UBI_IO_BAD_HDR_EBADMSG;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001071 }
1072
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 err = validate_vid_hdr(ubi, vid_hdr);
1074 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001075 ubi_err(ubi, "validation failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001076 return -EINVAL;
1077 }
1078
1079 return read_err ? UBI_IO_BITFLIPS : 0;
1080}
1081
1082/**
1083 * ubi_io_write_vid_hdr - write a volume identifier header.
1084 * @ubi: UBI device description object
1085 * @pnum: the physical eraseblock number to write to
Boris Brezillon3291b522016-09-16 16:59:26 +02001086 * @vidb: the volume identifier buffer to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001087 *
1088 * This function writes the volume identifier header described by @vid_hdr to
1089 * physical eraseblock @pnum. This function automatically fills the
Boris Brezillon3291b522016-09-16 16:59:26 +02001090 * @vidb->hdr->magic and the @vidb->hdr->version fields, as well as calculates
1091 * header CRC checksum and stores it at vidb->hdr->hdr_crc.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001092 *
1093 * This function returns zero in case of success and a negative error code in
1094 * case of failure. If %-EIO is returned, the physical eraseblock probably went
1095 * bad.
1096 */
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001097int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
Boris Brezillon3291b522016-09-16 16:59:26 +02001098 struct ubi_vid_io_buf *vidb)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001099{
Boris Brezillon3291b522016-09-16 16:59:26 +02001100 struct ubi_vid_hdr *vid_hdr = ubi_get_vid_hdr(vidb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001101 int err;
1102 uint32_t crc;
Boris Brezillon3291b522016-09-16 16:59:26 +02001103 void *p = vidb->buffer;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001104
1105 dbg_io("write VID header to PEB %d", pnum);
1106 ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
1107
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001108 err = self_check_peb_ec_hdr(ubi, pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001109 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001110 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001111
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001112 vid_hdr->magic = cpu_to_be32(UBI_VID_HDR_MAGIC);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001113 vid_hdr->version = UBI_VERSION;
1114 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001115 vid_hdr->hdr_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001116
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001117 err = self_check_vid_hdr(ubi, pnum, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001118 if (err)
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001119 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001120
david.oberhollenzer@sigma-star.at50269062015-03-26 23:59:50 +01001121 if (ubi_dbg_power_cut(ubi, POWER_CUT_VID_WRITE))
1122 return -EROFS;
1123
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001124 err = ubi_io_write(ubi, p, pnum, ubi->vid_hdr_aloffset,
1125 ubi->vid_hdr_alsize);
1126 return err;
1127}
1128
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001129/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001130 * self_check_not_bad - ensure that a physical eraseblock is not bad.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001131 * @ubi: UBI device description object
1132 * @pnum: physical eraseblock number to check
1133 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001134 * This function returns zero if the physical eraseblock is good, %-EINVAL if
1135 * it is bad and a negative error code if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001136 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001137static int self_check_not_bad(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001138{
1139 int err;
1140
Ezequiel Garcia64575572012-11-28 09:18:29 -03001141 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001142 return 0;
1143
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001144 err = ubi_io_is_bad(ubi, pnum);
1145 if (!err)
1146 return err;
1147
Tanya Brokhman326087032014-10-20 19:57:00 +03001148 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001149 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001150 return err > 0 ? -EINVAL : err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001151}
1152
1153/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001154 * self_check_ec_hdr - check if an erase counter header is all right.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001155 * @ubi: UBI device description object
1156 * @pnum: physical eraseblock number the erase counter header belongs to
1157 * @ec_hdr: the erase counter header to check
1158 *
1159 * This function returns zero if the erase counter header contains valid
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001160 * values, and %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001161 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001162static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
1163 const struct ubi_ec_hdr *ec_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001164{
1165 int err;
1166 uint32_t magic;
1167
Ezequiel Garcia64575572012-11-28 09:18:29 -03001168 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001169 return 0;
1170
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001171 magic = be32_to_cpu(ec_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001172 if (magic != UBI_EC_HDR_MAGIC) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001173 ubi_err(ubi, "bad magic %#08x, must be %#08x",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001174 magic, UBI_EC_HDR_MAGIC);
1175 goto fail;
1176 }
1177
1178 err = validate_ec_hdr(ubi, ec_hdr);
1179 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001180 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001181 goto fail;
1182 }
1183
1184 return 0;
1185
1186fail:
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001187 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001188 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001189 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001190}
1191
1192/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001193 * self_check_peb_ec_hdr - check erase counter header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001194 * @ubi: UBI device description object
1195 * @pnum: the physical eraseblock number to check
1196 *
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001197 * This function returns zero if the erase counter header is all right and and
1198 * a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001199 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001200static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001201{
1202 int err;
1203 uint32_t crc, hdr_crc;
1204 struct ubi_ec_hdr *ec_hdr;
1205
Ezequiel Garcia64575572012-11-28 09:18:29 -03001206 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001207 return 0;
1208
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001209 ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001210 if (!ec_hdr)
1211 return -ENOMEM;
1212
1213 err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
Brian Norrisd57f40542011-09-20 18:34:25 -07001214 if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001215 goto exit;
1216
1217 crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001218 hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001219 if (hdr_crc != crc) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001220 ubi_err(ubi, "bad CRC, calculated %#08x, read %#08x",
1221 crc, hdr_crc);
1222 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001223 ubi_dump_ec_hdr(ec_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001224 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001225 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001226 goto exit;
1227 }
1228
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001229 err = self_check_ec_hdr(ubi, pnum, ec_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001230
1231exit:
1232 kfree(ec_hdr);
1233 return err;
1234}
1235
1236/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001237 * self_check_vid_hdr - check that a volume identifier header is all right.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001238 * @ubi: UBI device description object
1239 * @pnum: physical eraseblock number the volume identifier header belongs to
1240 * @vid_hdr: the volume identifier header to check
1241 *
1242 * This function returns zero if the volume identifier header is all right, and
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001243 * %-EINVAL if not.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001244 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001245static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
1246 const struct ubi_vid_hdr *vid_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001247{
1248 int err;
1249 uint32_t magic;
1250
Ezequiel Garcia64575572012-11-28 09:18:29 -03001251 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001252 return 0;
1253
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001254 magic = be32_to_cpu(vid_hdr->magic);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001255 if (magic != UBI_VID_HDR_MAGIC) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001256 ubi_err(ubi, "bad VID header magic %#08x at PEB %d, must be %#08x",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001257 magic, pnum, UBI_VID_HDR_MAGIC);
1258 goto fail;
1259 }
1260
1261 err = validate_vid_hdr(ubi, vid_hdr);
1262 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001263 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001264 goto fail;
1265 }
1266
1267 return err;
1268
1269fail:
Tanya Brokhman326087032014-10-20 19:57:00 +03001270 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001271 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001272 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001273 return -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001274
1275}
1276
1277/**
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001278 * self_check_peb_vid_hdr - check volume identifier header.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001279 * @ubi: UBI device description object
1280 * @pnum: the physical eraseblock number to check
1281 *
1282 * This function returns zero if the volume identifier header is all right,
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001283 * and a negative error code if not or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001284 */
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001285static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001286{
1287 int err;
1288 uint32_t crc, hdr_crc;
Boris Brezillon3291b522016-09-16 16:59:26 +02001289 struct ubi_vid_io_buf *vidb;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001290 struct ubi_vid_hdr *vid_hdr;
1291 void *p;
1292
Ezequiel Garcia64575572012-11-28 09:18:29 -03001293 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001294 return 0;
1295
Boris Brezillon3291b522016-09-16 16:59:26 +02001296 vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
1297 if (!vidb)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001298 return -ENOMEM;
1299
Boris Brezillon3291b522016-09-16 16:59:26 +02001300 vid_hdr = ubi_get_vid_hdr(vidb);
1301 p = vidb->buffer;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001302 err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
1303 ubi->vid_hdr_alsize);
Brian Norrisd57f40542011-09-20 18:34:25 -07001304 if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001305 goto exit;
1306
Brian Norris2e69d492015-11-20 14:10:54 -08001307 crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001308 hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001309 if (hdr_crc != crc) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001310 ubi_err(ubi, "bad VID header CRC at PEB %d, calculated %#08x, read %#08x",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001311 pnum, crc, hdr_crc);
Tanya Brokhman326087032014-10-20 19:57:00 +03001312 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Artem Bityutskiya904e3f2012-04-25 09:02:44 +03001313 ubi_dump_vid_hdr(vid_hdr);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001314 dump_stack();
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001315 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001316 goto exit;
1317 }
1318
Artem Bityutskiy8056eb42012-05-16 18:24:09 +03001319 err = self_check_vid_hdr(ubi, pnum, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001320
1321exit:
Boris Brezillon3291b522016-09-16 16:59:26 +02001322 ubi_free_vid_buf(vidb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001323 return err;
1324}
1325
1326/**
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001327 * self_check_write - make sure write succeeded.
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001328 * @ubi: UBI device description object
1329 * @buf: buffer with data which were written
1330 * @pnum: physical eraseblock number the data were written to
1331 * @offset: offset within the physical eraseblock the data were written to
1332 * @len: how many bytes were written
1333 *
1334 * This functions reads data which were recently written and compares it with
1335 * the original data buffer - the data have to match. Returns zero if the data
1336 * match and a negative error code if not or in case of failure.
1337 */
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001338static int self_check_write(struct ubi_device *ubi, const void *buf, int pnum,
1339 int offset, int len)
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001340{
1341 int err, i;
Artem Bityutskiy7950d022010-11-19 17:05:36 +02001342 size_t read;
Artem Bityutskiya7586742011-03-14 17:06:52 +02001343 void *buf1;
Artem Bityutskiy7950d022010-11-19 17:05:36 +02001344 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001345
Ezequiel Garcia64575572012-11-28 09:18:29 -03001346 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001347 return 0;
1348
Artem Bityutskiy3d46b312011-03-24 16:09:56 +02001349 buf1 = __vmalloc(len, GFP_NOFS, PAGE_KERNEL);
Artem Bityutskiya7586742011-03-14 17:06:52 +02001350 if (!buf1) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001351 ubi_err(ubi, "cannot allocate memory to check writes");
Artem Bityutskiya7586742011-03-14 17:06:52 +02001352 return 0;
1353 }
1354
Artem Bityutskiy329ad392011-12-23 17:30:16 +02001355 err = mtd_read(ubi->mtd, addr, len, &read, buf1);
Brian Norrisd57f40542011-09-20 18:34:25 -07001356 if (err && !mtd_is_bitflip(err))
Artem Bityutskiya7586742011-03-14 17:06:52 +02001357 goto out_free;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001358
1359 for (i = 0; i < len; i++) {
1360 uint8_t c = ((uint8_t *)buf)[i];
Artem Bityutskiya7586742011-03-14 17:06:52 +02001361 uint8_t c1 = ((uint8_t *)buf1)[i];
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001362 int dump_len;
1363
1364 if (c == c1)
1365 continue;
1366
Tanya Brokhman326087032014-10-20 19:57:00 +03001367 ubi_err(ubi, "self-check failed for PEB %d:%d, len %d",
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001368 pnum, offset, len);
Tanya Brokhman326087032014-10-20 19:57:00 +03001369 ubi_msg(ubi, "data differ at position %d", i);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001370 dump_len = max_t(int, 128, len - i);
Tanya Brokhman326087032014-10-20 19:57:00 +03001371 ubi_msg(ubi, "hex dump of the original buffer from %d to %d",
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001372 i, i + dump_len);
1373 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
1374 buf + i, dump_len, 1);
Tanya Brokhman326087032014-10-20 19:57:00 +03001375 ubi_msg(ubi, "hex dump of the read buffer from %d to %d",
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001376 i, i + dump_len);
1377 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
Artem Bityutskiya7586742011-03-14 17:06:52 +02001378 buf1 + i, dump_len, 1);
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001379 dump_stack();
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001380 err = -EINVAL;
Artem Bityutskiya7586742011-03-14 17:06:52 +02001381 goto out_free;
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001382 }
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001383
Artem Bityutskiya7586742011-03-14 17:06:52 +02001384 vfree(buf1);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001385 return 0;
1386
Artem Bityutskiya7586742011-03-14 17:06:52 +02001387out_free:
1388 vfree(buf1);
Artem Bityutskiy6e9065d2010-01-25 17:09:30 +02001389 return err;
1390}
1391
1392/**
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001393 * ubi_self_check_all_ff - check that a region of flash is empty.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001394 * @ubi: UBI device description object
1395 * @pnum: the physical eraseblock number to check
1396 * @offset: the starting offset within the physical eraseblock to check
1397 * @len: the length of the region to check
1398 *
1399 * This function returns zero if only 0xFF bytes are present at offset
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001400 * @offset of the physical eraseblock @pnum, and a negative error code if not
1401 * or if an error occurred.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001402 */
Artem Bityutskiy97d61042012-05-16 19:29:04 +03001403int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001404{
1405 size_t read;
1406 int err;
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001407 void *buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001408 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
1409
Ezequiel Garcia64575572012-11-28 09:18:29 -03001410 if (!ubi_dbg_chk_io(ubi))
Artem Bityutskiy92d124f2011-03-14 18:17:40 +02001411 return 0;
1412
Artem Bityutskiy3d46b312011-03-24 16:09:56 +02001413 buf = __vmalloc(len, GFP_NOFS, PAGE_KERNEL);
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001414 if (!buf) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001415 ubi_err(ubi, "cannot allocate memory to check for 0xFFs");
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001416 return 0;
1417 }
1418
Artem Bityutskiy329ad392011-12-23 17:30:16 +02001419 err = mtd_read(ubi->mtd, addr, len, &read, buf);
Brian Norrisd57f40542011-09-20 18:34:25 -07001420 if (err && !mtd_is_bitflip(err)) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001421 ubi_err(ubi, "err %d while reading %d bytes from PEB %d:%d, read %zd bytes",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001422 err, len, pnum, offset, read);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001423 goto error;
1424 }
1425
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001426 err = ubi_check_pattern(buf, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001427 if (err == 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001428 ubi_err(ubi, "flash region at PEB %d:%d, length %d does not contain all 0xFF bytes",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001429 pnum, offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001430 goto fail;
1431 }
1432
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001433 vfree(buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001434 return 0;
1435
1436fail:
Tanya Brokhman326087032014-10-20 19:57:00 +03001437 ubi_err(ubi, "self-check failed for PEB %d", pnum);
Tanya Brokhman45fc5c82014-11-09 13:06:25 +02001438 ubi_msg(ubi, "hex dump of the %d-%d region", offset, offset + len);
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001439 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
Artem Bityutskiyadbf05e2010-01-20 10:28:58 +02001440 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001441error:
Artem Bityutskiy25886a32012-04-24 06:59:49 +03001442 dump_stack();
Artem Bityutskiy332873d2011-03-14 17:09:40 +02001443 vfree(buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001444 return err;
1445}